ZStack ZSphere Documentation
All Version
All
ZStack ZSphere Documentation>ZSphere API Reference(v5.0.0)>Bare Metal Management>Bare Metal Network APIs
Get PDF

Create Bare Metal NIC Bonding (CreateBaremetalBonding)

API Request

URLs
POST zstack/v1/baremetal/network/bondings
Headers
Authorization: OAuth the-session-uuid
Body
{   "params": {     "chassisUuid": "8a3fddc82d1536ad8f695d25d84404f2",     "name": "bond0",     "mode": 1,     "slaves": "[\"d4:ae:52:6e:d1:0d\", \"d4:ae:52:6e:d1:0e\"]",     "opts": "miimon\u003d100"   },   "systemTags": [],   "userTags": [] }
Note: In the example above, systemTags and userTags fields can be omitted. They are listed to indicate that the body can contain these two fields.
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"chassisUuid":"8a3fddc82d1536ad8f695d25d84404f2","name":"bond0","mode":1,"slaves":"[\"d4:ae:52:6e:d1:0d\", \"d4:ae:52:6e:d1:0e\"]","opts":"miimon=100"}}' \ http://localhost:8080/zstack/v1/baremetal/network/bondings
Parameter List
Name Type Location Description Allowed Values Starting Version
chassisUuid String body (contained in params structure) Bare Metal Chassis UUID 3.4.0
name String body (contained in params structure) NIC Bonding Name 3.4.0
mode Integer body (contained in params structure) NIC Bonding Mode 3.4.0
slaves String body (contained in params structure) NIC Bonding Slaves MAC Address 3.4.0
opts (Optional) String body (contained in params structure) NIC Bonding Options 3.4.0
resourceUuid (Optional) String body (contained in params structure) Resource UUID 3.4.0
systemTags (Optional) List body System Tags 3.4.0
userTags (Optional) List body User Tags 3.4.0
tagUuids (Optional) List body (contained in params structure) Tag UUID List 3.4.0

API Response

Response Example
{   "inventory": {     "uuid": "badccdb49c6e4ad599696948457f5277",     "chassisUuid": "6442d12334e44aee96fc74c2fc8ea8f9",     "name": "bond0",     "mode": 1,     "slaves": "[\"d4:ae:52:6e:d1:0d\", \"d4:ae:52:6e:d1:0e\"]",     "opts": "miimon\u003d100",     "createDate": "Aug 15, 2025 5:32:54 AM",     "lastOpDate": "Aug 15, 2025 5:32:54 AM"   } }
Name Type Description Starting Version
success boolean 0.6
error ErrorCode Error code. If not null, the operation failed. When the operation succeeds, this field is null. See error for details. 3.4.0
inventory BaremetalBondingInventory See inventory for details. 3.4.0
#error
Name Type Description Starting Version
code String Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, defaults to null 0.6
opaque LinkedHashMap Reserved field, defaults to null 0.6
cause ErrorCode Root cause, the source error that caused the current error. If there is no original error, this field is null 0.6
#inventory
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 3.4.0
chassisUuid String Bare Metal Chassis UUID 3.4.0
name String NIC Bonding Name 3.4.0
mode Integer NIC Bonding Mode 3.4.0
slaves String Slave MAC Address, comma separated 3.4.0
opts String NIC Bonding Options 3.4.0
createDate Timestamp Create Time 3.4.0
lastOpDate Timestamp Last Modification Time 3.4.0

SDK Examples

Java SDK
CreateBaremetalBondingAction action = new CreateBaremetalBondingAction(); action.chassisUuid = "8a3fddc82d1536ad8f695d25d84404f2"; action.name = "bond0"; action.mode = 1; action.slaves = "["d4:ae:52:6e:d1:0d", "d4:ae:52:6e:d1:0e"]"; action.opts = "miimon=100"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; CreateBaremetalBondingAction.Result res = action.call();
Python SDK
action = CreateBaremetalBondingAction() action.chassisUuid = "8a3fddc82d1536ad8f695d25d84404f2" action.name = "bond0" action.mode = 1 action.slaves = "["d4:ae:52:6e:d1:0d", "d4:ae:52:6e:d1:0e"]" action.opts = "miimon=100" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

Query Bare Metal NIC Bonding (QueryBaremetalBonding)

API Request

URLs
GET zstack/v1/baremetal/network/bondings GET zstack/v1/baremetal/network/bondings/{uuid}
Headers
Authorization: OAuth the-session-uuid
Curl Example
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X GET http://localhost:8080/zstack/v1/baremetal/network/bondings?q=uuid=10d30b226f093a4c9ccd911575406e7b
curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X GET http://localhost:8080/zstack/v1/baremetal/network/bondings/e0ea2452b6be30a6a7fbfc01dd5e70f5

Queryable Fields

Run the CLI command tool, enter QueryBaremetalBonding and press Tab to view all queryable fields and resource names that can be queried across tables.

API Response

Response Example
{   "inventories": [     {       "uuid": "d2ab26c55a664a85ae2df0b8cee6ede7",       "chassisUuid": "6b0cde704099460b9a96a0c451186467",       "name": "bond0",       "mode": 1,       "slaves": "[\"d4:ae:52:6e:d1:0d\", \"d4:ae:52:6e:d1:0e\"]",       "opts": "miimon\u003d100",       "createDate": "Aug 15, 2025 5:36:54 AM",       "lastOpDate": "Aug 15, 2025 5:36:54 AM"     }   ] }
Name Type Description Starting Version
success boolean 0.6
error ErrorCode Error code. If not null, the operation failed. When the operation succeeds, this field is null. See error for details. 3.4.0
inventories List See inventories for details. 3.4.0
#error
Name Type Description Starting Version
code String Error code number, a globally unique identifier for the error, for example SYS.1000, HOST.1001 0.6
description String Brief description of the error 0.6
details String Detailed error information 0.6
elaboration String Reserved field, defaults to null 0.6
opaque LinkedHashMap Reserved field, defaults to null 0.6
cause ErrorCode Root cause, the source error that caused the current error. If there is no original error, this field is null 0.6
#inventories
Name Type Description Starting Version
uuid String Resource UUID, uniquely identifies the resource 3.4.0
chassisUuid String Bare Metal Chassis UUID 3.4.0
name String NIC Bonding Name 3.4.0
mode Integer NIC Bonding Mode 3.4.0
slaves String Slave MAC Address, comma separated 3.4.0
opts String NIC Bonding Options 3.4.0
createDate Timestamp Create Time 3.4.0
lastOpDate Timestamp Last Modification Time 3.4.0

SDK Examples

Java SDK
QueryBaremetalBondingAction action = new QueryBaremetalBondingAction(); action.conditions = asList("uuid=eb879ea0b5b93f12aefb1a8bb21cf135"); action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; QueryBaremetalBondingAction.Result res = action.call();
Python SDK
action = QueryBaremetalBondingAction() action.conditions = ["uuid=3c90a0f5fb763620ab38cc6184732ea3"] action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" res = action.call()

Archives

Download Document Archives

Download

Already filled the basic info?Click here.

Enter at least 2 characters.
Cannot be empty.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

An email with a verification code will be sent to you. Make sure the address you provided is valid and correct.

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Download

Not filled the basic info yet? Click here.

Invalid email address or mobile number.
同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
ZStack Training and Certification
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io
Request Trial
Enter at least 2 characters.
Invalid mobile number.
Enter at least 4 characters.
Invalid email address.
Wrong code. Try again. Send Code Resend Code (60s)

同意 不同意

I have read and concur with the Site Terms 、 Privacy Policy 、 Rules and Conventions on User Management of ZStack Cloud

Email Us

contact@zstack.io

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder. After receiving the email, click the URL to download the documentation.

The download link is sent to your email address.

If you don't see it, check your spam folder, subscription folder, or AD folder.
Or click on the URL below. (For Internet Explorer, right-click the URL and save it.)

Thank you for using ZStack products and services.

Submit successfully.

We'll connect soon.

Thank you for using ZStack products and services.