Attach L3 Network to VM

POST/zstack/v1/vm-instances/{vmInstanceUuid}/l3-networks/{l3NetworkUuid}

Request

cURL

curl --request POST \
  --url '/v1/vm-instances/{vmInstanceUuid}/l3-networks/{l3NetworkUuid}' \
  --header 'Content-Type: application/json' \
  --data '{}'

{
  "status": "ok",
  "method": "POST",
  "path": "/v1/vm-instances/{vmInstanceUuid}/l3-networks/{l3NetworkUuid}"
}

Dynamically add a network to a Running or Stopped Virtual Machine.

Headers

Authorization: OAuth the-session-uuid

Body

{
  "params": {
    "driverType": "e1000"
  },
  "systemTags": [],
  "userTags": []
}

Note: systemTags and userTags fields can be omitted in the above example. 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":{"driverType":"e1000"}}' \
http://localhost:8080/zstack/v1/vm-instances/f526e22f739838f4bcdfdd20f0ba8a73/l3-networks/00fab8159d1d3534802c588c2bd9a28b

Parameter List

Name	Type	Location	Description	Starting Version
vmInstanceUuid	String	url	Virtual Machine UUID	0.6
l3NetworkUuid	String	url	L3 Network UUID	0.6
staticIp (optional)	String	body (contained in params structure)	Specify the IP address to assign to the Virtual Machine	0.6
systemTags (optional)	List	body	System Tags	0.6
userTags (optional)	List	body	User Tags	0.6
driverType	String	body	NIC Driver Type	4.0.0
customMac (optional)	String	body (contained in params structure)	Custom NIC MAC Address	4.0.0
vmNicParams (optional)	String	body (contained in params structure)	NIC Information	4.0.0

API Response

Return Example

{
  "inventory": {
    "uuid": "e300c6dbbaa1326ebca205a7b2a0e7ea",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "c9b73cde21d23866802e8a5178f29f0d",
    "clusterUuid": "24a72428e400344b88f8c2faa4c292bd",
    "imageUuid": "5484ed82cdfc366c9657c695577bee37",
    "hostUuid": "5eb00f0897603309904b418c821b1acb",
    "lastHostUuid": "b2cfad47a7923346a735008c32ef0d0b",
    "instanceOfferingUuid": "bbea469feb78345591cc9ac6c0ce0c5c",
    "rootVolumeUuid": "fc8a81afd11136ac8a48cf458ac2945b",
    "platform": "Linux",
    "defaultL3NetworkUuid": "aa3e9117d9793eff81a614b0e18bade7",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 10:20:57 PM",
    "lastOpDate": "Nov 14, 2017 10:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "458704a1654637209667e69847ee3a97",
        "vmInstanceUuid": "e300c6dbbaa1326ebca205a7b2a0e7ea",
        "usedIpUuid": "b6edb8e1ccc533b98cb9cc1c14baf38b",
        "l3NetworkUuid": "aa3e9117d9793eff81a614b0e18bade7",
        "ip": "192.168.1.10",
        "mac": "00:0c:29:bd:99:fc",
        "hypervisorType": "KVM",
        "netmask": "255.255.255.0",
        "gateway": "192.168.1.1",
        "deviceId": 0,
        "state": "enable",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "fc8a81afd11136ac8a48cf458ac2945b",
        "name": "Root-Volume-For-VM-e300c6dbbaa1326ebca205a7b2a0e7ea",
        "primaryStorageUuid": "91dc7f8732243262933100a509ab808a",
        "vmInstanceUuid": "e300c6dbbaa1326ebca205a7b2a0e7ea",
        "diskOfferingUuid": "26483e8eca413d809f4f8c6afba75ae2",
        "rootImageUuid": "5484ed82cdfc366c9657c695577bee37",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-fc8a81afd11136ac8a48cf458ac2945b/fc8a81afd11136ac8a48cf458ac2945b.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 10:20:57 PM",
        "lastOpDate": "Nov 14, 2017 10:20:57 PM"
      }
    ]
  }
}

Name	Type	Description	Starting Version
success	boolean		0.6
error	ErrorCode	Error code. If not null, indicates operation failure. This field is null when the operation succeeds. See error	0.6
inventory	VmInstanceInventory	See inventory	0.6

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 triggered 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	0.6
name	String	Resource name	0.6
description	String	Resource description	0.6
zoneUuid	String	Data Center UUID	0.6
clusterUuid	String	Cluster UUID	0.6
imageUuid	String	Image UUID	0.6
hostUuid	String	Host UUID	0.6
lastHostUuid	String		0.6
instanceOfferingUuid	String	Instance Offering UUID	0.6
rootVolumeUuid	String	Root Volume UUID	0.6
platform	String		0.6
architecture	String		0.6
defaultL3NetworkUuid	String		0.6
type	String		0.6
hypervisorType	String		0.6
memorySize	Long		0.6
cpuNum	Integer		0.6
cpuSpeed	Long		0.6
allocatorStrategy	String		0.6
createDate	Timestamp	Creation Time	0.6
lastOpDate	Timestamp	Last Operation Date	0.6
state	String		0.6
guestOsType	String		4.1.2
vmNics	List	See vmNics	0.6
allVolumes	List	See allVolumes	0.6
vmCdRoms	List	See vmCdRoms	0.6

vmNics

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
vmInstanceUuid	String	Virtual Machine UUID	0.6
l3NetworkUuid	String	L3 Network UUID	0.6
ip	String		0.6
mac	String		0.6
hypervisorType	String		4.7.13
netmask	String		0.6
gateway	String		0.6
metaData	String		0.6
ipVersion	Integer	IP Protocol Number	3.1.0
driverType	String		4.7.13
internalName	String		4.7.13
deviceId	Integer		0.6
type	String		4.7.13
state	String	NIC Status	4.7.13
createDate	Timestamp	Creation Time	0.6
lastOpDate	Timestamp	Last Operation Date	0.6
usedIps	List	See usedIps	0.6

usedIps

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
ipRangeUuid	String	IP Range UUID	0.6
l3NetworkUuid	String	L3 Network UUID	0.6
ipVersion	Integer	IP Protocol Number	3.1.0
ip	String	IP Address	0.6
netmask	String	Netmask	0.6
gateway	String	Gateway Address	0.6
usedFor	String		0.6
ipInLong	long		0.6
vmNicUuid	String	VM NIC UUID	3.1.0
createDate	Timestamp	Creation Time	0.6
lastOpDate	Timestamp	Last Operation Date	0.6

allVolumes

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	0.6
name	String	Resource name	0.6
description	String	Resource description	0.6
primaryStorageUuid	String	Data Storage UUID	0.6
vmInstanceUuid	String	Virtual Machine UUID	0.6
diskOfferingUuid	String	Disk Offering UUID	0.6
rootImageUuid	String		0.6
installPath	String		0.6
type	String		0.6
format	String		0.6
size	Long		0.6
actualSize	Long		0.6
deviceId	Integer		0.6
state	String		0.6
status	String		0.6
createDate	Timestamp	Creation Time	0.6
lastOpDate	Timestamp	Last Operation Date	0.6
isShareable	Boolean		0.6
volumeQos	String		4.7.13
lastDetachDate	Timestamp		4.7.13
lastVmInstanceUuid	String		4.7.13

vmCdRoms

Name	Type	Description	Starting Version
uuid	String	Resource UUID, uniquely identifies the resource	4.7.13
vmInstanceUuid	String	Virtual Machine UUID	4.7.13
deviceId	Integer		4.7.13
isoUuid	String		4.7.13
isoInstallPath	String		4.7.13
name	String	Resource name	4.7.13
description	String	Resource description	4.7.13
createDate	Timestamp	Creation Time	4.7.13
lastOpDate	Timestamp	Last Operation Date	4.7.13

SDK Examples

Java SDK

AttachL3NetworkToVmAction action = new AttachL3NetworkToVmAction();
action.vmInstanceUuid = "f526e22f739838f4bcdfdd20f0ba8a73";
action.l3NetworkUuid = "00fab8159d1d3534802c588c2bd9a28b";
action.driverType = "e1000";
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
AttachL3NetworkToVmAction.Result res = action.call();

Python SDK

action = AttachL3NetworkToVmAction()
action.vmInstanceUuid = "f526e22f739838f4bcdfdd20f0ba8a73"
action.l3NetworkUuid = "00fab8159d1d3534802c588c2bd9a28b"
action.driverType = "e1000"
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()