L2 Network Operations

CreateL2VxlanNetworkPool

API Request

URLs

POST zstack/v1/l2-networks/vxlan-pool

Headers

Authorization: OAuth the-session-uuid

Body

{ "params": { "name": "Test-NetPool", "description": "Test", "zoneUuid": "ec6cc473d1c345528b92da754cd8fa00"   }, "systemTags": [], "userTags": []

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"name":"Test-NetPool","description":"Test","zoneUuid":"2de2048daac33068aecac1f5b40d1343"}}' \ http://localhost:8080/zstack/v1/l2-networks/vxlan-pool

Request Parameters

Name	Type	Location	Description	Starting Version
name	String	body (contained in the params structure)	The resource name.	0.6
description	String	body (contained in the params structure)	Optional. The detailed description of the resource.	0.6
zoneUuid	String	body (contained in the params structure)	The zone UUID.	0.6
physicalInterface	String	body (contained in the params structure)		0.6
type	String	body (contained in the params structure)	Optional. The type.	0.6
resourceUuid	String	body (contained in the params structure)	Optional. The resource UUID.	0.6
systemTags	List	body	Optional. The system tags.	0.6
userTags	List	body	Optional. The user tags.	0.6

API Response

Sample Response

{ "inventory": { "name": "Test-NetPool", "description": "Test", "zoneUuid": "3f35bd50dab14ababe3d85736b63aba7", "type": "L2VxlanNetwork"   } }

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	0.6
inventory	L2VxlanNetworkPoolInventory	See inventory.	0.6

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	0.6
description	String	The brief description of the error.	0.6
details	String	The details about the error.	0.6
elaboration	String	The reserved field. Default value: null.	0.6
opaque	LinkedHashMap	The reserved field. Default value: null.	0.6
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	0.6

#inventory

Name	Type	Description	Starting Version
attachedCidrs	Map		0.6
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
zoneUuid	String	The zone UUID.	0.6
physicalInterface	String		0.6
type	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
attachedClusterUuids	List		0.6
attachedVtepRefs	List	See attachedVtepRefs.	0.6
attachedVxlanNetworkRefs	List	See attachedVxlanNetworkRefs.	0.6
attachedVniRanges	List	See attachedVniRanges.	0.6

#attachedVtepRefs

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
hostUuid	String	The host UUID.	0.6
vtepIp	String		0.6
port	Integer		0.6
type	String		0.6
poolUuid	String		0.6

#attachedVxlanNetworkRefs

Name	Type	Description	Starting Version
vni	Integer		0.6
poolUuid	String		0.6
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
zoneUuid	String	The zone UUID.	0.6
physicalInterface	String		0.6
type	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
attachedClusterUuids	List		0.6

#attachedVniRanges

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
startVni	Integer		0.6
endVni	Integer		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
l2NetworkUuid	String	The L2 network UUID.	0.6

SDK Sample

Java SDK

CreateL2VxlanNetworkPoolAction action = new CreateL2VxlanNetworkPoolAction(); action.name = "Test-NetPool"; action.description = "Test"; action.zoneUuid = "b54ad1e316ea43028b7042018a376aa8"; action.sessionId = "d584d552f0a34d78866f5a7757d7adf0"; CreateL2VxlanNetworkPoolAction.Result res = action.call();

Python SDK

CreateL2VxlanNetworkPoolAction action = CreateL2VxlanNetworkPoolAction() action.name = "Test-NetPool" action.description = "Test" action.zoneUuid = "081d5f9914f44d8da30dda37448d0c99" action.sessionId = "2f51609112064da98d1720c28c72843c" CreateL2VxlanNetworkPoolAction.Result res = action.call()

QueryL2VxlanNetworkPool

API Request

URLs

GET zstack/v1/l2-networks/vxlan-pool GET zstack/v1/l2-networks/vxlan-pool/{uuid}

Headers

Authorization: OAuth the-session-uuid

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b2132aefec76492cb00aff0a2d97a202" \ -X GET http://localhost:8080/zstack/v1/l2-networks/vxlan-pool

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth 07c093f70f10467e826adc1743a022e6" \ -X GET http://localhost:8080/zstack/v1/l2-networks/vxlan-pool/0576843440c74069b541faa856f71d39

Queryable Fields

You can check all queryable fields and resource names that can be queried across tables by using zstack-cli, entering QueryL2VxlanNetworkPool, and pressing the Tab key.

API Response

Sample Response

{ "inventories": [     { "name": "Test-Net", "description": "Test", "zoneUuid": "6199e247f6bf4157a41e51ed7ff2f78c", "type": "L2VxlanNetworkPool"     }   ] }

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	0.6
inventories	List	See inventories.	0.6

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	0.6
description	String	The brief description of the error.	0.6
details	String	The details about the error.	0.6
elaboration	String	The reserved field. Default value: null.	0.6
opaque	LinkedHashMap	The reserved field. Default value: null.	0.6
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	0.6

#inventories

Name	Type	Description	Starting Version
attachedCidrs	Map		0.6
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
zoneUuid	String	The zone UUID.	0.6
physicalInterface	String		0.6
type	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
attachedClusterUuids	List		0.6
attachedVtepRefs	List	See attachedVtepRefs.	0.6
attachedVxlanNetworkRefs	List	See attachedVxlanNetworkRefs.	0.6
attachedVniRanges	List	See attachedVniRanges.	0.6

#attachedVtepRefs

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
hostUuid	String	The host UUID.	0.6
vtepIp	String		0.6
port	Integer		0.6
type	String		0.6
poolUuid	String		0.6

#attachedVxlanNetworkRefs

Name	Type	Description	Starting Version
vni	Integer		0.6
poolUuid	String		0.6
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
zoneUuid	String	The zone UUID.	0.6
physicalInterface	String		0.6
type	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
attachedClusterUuids	List		0.6

#attachedVniRanges

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
startVni	Integer		0.6
endVni	Integer		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
l2NetworkUuid	String	The L2 network UUID.	0.6

SDK Sample

Java SDK

QueryL2VxlanNetworkPoolAction action = new QueryL2VxlanNetworkPoolAction(); action.conditions = asList(); action.sessionId = "773c52887a0945c4b5dee525e71f5287"; QueryL2VxlanNetworkPoolAction.Result res = action.call();

Python SDK

QueryL2VxlanNetworkPoolAction action = QueryL2VxlanNetworkPoolAction() action.conditions = [] action.sessionId = "0fa3249e9dbd48f3951a93a772882f67" QueryL2VxlanNetworkPoolAction.Result res = action.call()

CreateL2VxlanNetwork

API Request

URLs

POST zstack/v1/l2-networks/vxlan

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "vni": 10.0,     "poolUuid": "517752a193074a92807df368892851cc",     "name": "Test-Net",     "description": "Test",     "zoneUuid": "1966127fc98444b1812fde2382e96cfe"   },   "systemTags": [],   "userTags": [] }

Note: In the preceding sample, both systemTags and userTags are optional. These two fields can be included in the body structure.

Curl Sample

curl -H "Content-Type: application/json;charset=UTF-8" \ -H "Authorization: OAuth b86c9016b4f24953a9edefb53ca0678c" \ -X POST -d '{"params":{"vni":10.0,"poolUuid":"c27a329718ed3585a27d227174ed1ace","name":"Test-Net","description":"Test","zoneUuid":"8dd66847fcf930178acc687cb4c1438c"}}' \ http://localhost:8080/zstack/v1/l2-networks/vxlan

Request Parameters

Name	Type	Location	Description	Starting Version
vni	Integer	body (contained in the params structure)	Optional. The VNI.	0.6
poolUuid	String	body (contained in the params structure)	The VXLAN pool UUID.	0.6
name	String	body (contained in the params structure)	The resource name.	0.6
description	String	body (contained in the params structure)	Optional. The detailed description of the resource.	0.6
zoneUuid	String	body (contained in the params structure)	The zone UUID.	0.6
physicalInterface	String	body (contained in the params structure)		0.6
type	String	body (contained in the params structure)	Optional. The type.	0.6
resourceUuid	String	body (contained in the params structure)	Optional. The resource UUID.	0.6
systemTags	List	body	Optional. The system tags.	0.6
userTags	List	body	Optional. The user tags.	0.6

API Response

Sample Response

{   "inventory": {     "vni": 10.0,     "poolUuid": "3f84a7f8be86430592a999375b0da922",     "name": "Test-Net",     "description": "Test",     "zoneUuid": "ef5d57db14a447cea80882a9d0b08dec",     "type": "L2VxlanNetwork"   } }

Name	Type	Description	Starting Version
error	ErrorCode	The error code. If not null, the operation fails, or vice versa. For more information, see error.	0.6
inventory	L2VxlanNetworkPoolInventory	See inventory.	0.6

#error

Name	Type	Description	Starting Version
code	String	The error code, which is a numbered or alphanumeric code that specifies an error. For example, SYS.1000, HOST.1001.	0.6
description	String	The brief description of the error.	0.6
details	String	The details about the error.	0.6
elaboration	String	The reserved field. Default value: null.	0.6
opaque	LinkedHashMap	The reserved field. Default value: null.	0.6
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	0.6

#inventory

Name	Type	Description	Starting Version
vni	Integer		0.6
poolUuid	String	The VXLAN pool UUID.	0.6
uuid	String	The resource UUID.	0.6
name	String	The resource name.	0.6
description	String	The detailed description of the resource.	0.6
zoneUuid	String	The zone UUID.	0.6
physicalInterface	String		0.6
type	String		0.6
createDate	Timestamp	The creation date.	0.6
lastOpDate	Timestamp	The last operation date.	0.6
attachedClusterUuids	List		0.6

SDK Sample

Java SDK

CreateL2VxlanNetworkAction action = new CreateL2VxlanNetworkAction(); action.vni = 10.0; action.poolUuid = "94522f4f06ad4741b6c129844f5d9cb9"; action.name = "Test-Net"; action.description = "Test"; action.zoneUuid = "cc13465255d24ede858b4b293ca538a2"; action.sessionId = "c4afaffac3ac4233a56f5d03387675dd"; CreateL2VxlanNetworkAction.Result res = action.call();

Python SDK

CreateL2VxlanNetworkAction action = CreateL2VxlanNetworkAction() action.vni = 10.0 action.poolUuid = "38302b5f00b24ae48fd55f22546e7543" action.name = "Test-Net" action.description = "Test" action.zoneUuid = "04f0b5941c8040918412a562269cccbc" action.sessionId = "53b39e7d9da047e98931dde2e94eae05" CreateL2VxlanNetworkAction.Result res = action.call()