MigrateVm

Migrate Virtual Machine

API Request

URLs

PUT zstack/v1/vm-instances/{vmInstanceUuid}/actions

Headers

Authorization: OAuth the-session-uuid

Body

{
  "migrateVm": {
    "hostUuid": "7571fb72e52b3fcab1a6992e7eef4cce",
    "migrateFromDestination": false,
    "allowUnknown": false,
    "downTime": 300,
    "enableMigrationTls": false
  },
  "systemTags": [],
  "userTags": []
}

Note: In the preceding example, the systemTags and userTags fields can be omitted. They are shown 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 PUT -d '{"migrateVm":{"hostUuid":"7571fb72e52b3fcab1a6992e7eef4cce","migrateFromDestination":false,"allowUnknown":false,"downTime":300,"enableMigrationTls":false}}' http://localhost:8080/zstack/v1/vm-instances/c53c9b6235703b8ab96c1cc35859242d/actions

Parameter List

Name	Type	Location	Description	Allowed Values	Starting Version
vmInstanceUuid	String	url	Virtual Machine UUID		0.6
hostUuid (Optional)	String	body (included in the `migrateVm` structure)	Host UUID		0.6
migrateFromDestination (Optional)	Boolean	body (included in the `migrateVm` structure)	Initiate the migration command from the destination physical machine		2.3
allowUnknown (Optional)	boolean	body (included in the `migrateVm` structure)	Allow virtual machines in the Unknown state		3.6.0
strategy (Optional)	String	body (included in the `migrateVm` structure)	Optional. The strategy.	auto-converge	3.6.0
systemTags (Optional)	List	body	Optional. The system tags.		0.6
userTags (Optional)	List	body	User tags		0.6
downTime (Optional)	Integer	body (included in the `migrateVm` structure)	Physical machine downtime for live migration		3.16.21
enableMigrationTls (Optional)	Boolean	body (included in the `migrateVm` structure)	Encrypt the migration process		5.1.0

API Response

Response Example

{
  "inventory": {
    "uuid": "1124f021672c3de9848fa567b632a6bb",
    "name": "Test-VM",
    "description": "web server VM",
    "zoneUuid": "fdfd5d0dfdc936e284792eabf72c52db",
    "clusterUuid": "f42a18b125ba3d61bae560bccec84741",
    "imageUuid": "5e6155ea150b31bc8f7789acf9f42b12",
    "hostUuid": "d51ee2645a3130ffb294a0c28a121c5c",
    "lastHostUuid": "9d32be2f483b3995bff142d072fb410a",
    "instanceOfferingUuid": "07d4a48c8cd5365992c6916b07f770ef",
    "rootVolumeUuid": "4172134623e6332fbb9092cd105bde77",
    "platform": "Linux",
    "defaultL3NetworkUuid": "4f49dce686663b81b7d8acbe75a879ac",
    "type": "UserVm",
    "hypervisorType": "KVM",
    "memorySize": 8589934592,
    "cpuNum": 1,
    "allocatorStrategy": "LastHostPreferredAllocatorStrategy",
    "createDate": "Nov 14, 2017 2:20:57 PM",
    "lastOpDate": "Nov 14, 2017 2:20:57 PM",
    "state": "Running",
    "vmNics": [
      {
        "uuid": "f5231a1c912e3a6592f1816b5812b660",
        "vmInstanceUuid": "1124f021672c3de9848fa567b632a6bb",
        "usedIpUuid": "c9f0e849407f3f5d86376560e00f31ae",
        "l3NetworkUuid": "4f49dce686663b81b7d8acbe75a879ac",
        "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,
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ],
    "allVolumes": [
      {
        "uuid": "4172134623e6332fbb9092cd105bde77",
        "name": "Root-Volume-For-VM-1124f021672c3de9848fa567b632a6bb",
        "primaryStorageUuid": "fe9f085199453903b09c5de54b6d194e",
        "vmInstanceUuid": "1124f021672c3de9848fa567b632a6bb",
        "diskOfferingUuid": "66805a23b6e3362d9527f3f4dcfe4402",
        "rootImageUuid": "5e6155ea150b31bc8f7789acf9f42b12",
        "installPath": "/zstack_ps/rootVolumes/acct-36c27e8ff05c4780bf6d2fa65700f22e/vol-4172134623e6332fbb9092cd105bde77/4172134623e6332fbb9092cd105bde77.qcow2",
        "type": "Root",
        "format": "qcow2",
        "size": 107374182400,
        "actualSize": 21474836480,
        "deviceId": 0,
        "state": "Enabled",
        "status": "Ready",
        "createDate": "Nov 14, 2017 2:20:57 PM",
        "lastOpDate": "Nov 14, 2017 2:20:57 PM"
      }
    ]
  }
}

Name	Type	Description	Starting Version
success	boolean	Whether the operation succeeded.	0.6
error	ErrorCode	Error code. If this field is not null, the operation failed. This field is null when the operation succeeds. For details, see error	0.6
inventory	VmInstanceInventory	For details, see inventory	0.6

#error

Name	Type	Description	Starting Version
code	String	Error code, which globally and uniquely identifies the error, for example, SYS.1000 or HOST.1001	0.6
description	String	Summary description of the error	0.6
details	String	Details of the error	0.6
elaboration	String	Reserved field. The default value is null	0.6
opaque	LinkedHashMap	Reserved field. The default value is null	0.6
cause	ErrorCode	Root error that caused the current error. This field is null if there is no source error	0.6

#inventory

Name	Type	Description	Starting Version
uuid	String	Resource UUID, which uniquely identifies the resource	0.6
name	String	Resource name	0.6
description	String	Detailed 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	Last Host UUID	0.6
instanceOfferingUuid	String	Instance Offering UUID	0.6
rootVolumeUuid	String	Root disk UUID	0.6
platform	String	Virtual Machine platform type, Windows / Linux / Other	0.6
architecture	String	Virtual Machine architecture, x86_64 / aarch64 / Other	0.6
defaultL3NetworkUuid	String	Default Distributed Port Group UUID	0.6
type	String	Virtual Machine type, User virtual machine or platform special purpose virtual machine	0.6
hypervisorType	String	Virtual Machine hypervisor type, typically KVM	0.6
memorySize	Long	Memory size	0.6
cpuNum	Integer	CPU number	0.6
cpuSpeed	Long	CPU speed	0.6
allocatorStrategy	String	Virtual Machine allocation strategy	0.6
createDate	Timestamp	Creation time	0.6
lastOpDate	Timestamp	Last modification time	0.6
state	String	Virtual Machine enabled state	0.6
guestOsType	String	Virtual Machine host operating system type	3.11.2
vmNics	List	For details, see vmNics	0.6
allVolumes	List	For details, see allVolumes	0.6
vmCdRoms	List	For details, see vmCdRoms	0.6

#vmNics

Name	Type	Description	Starting Version
uuid	String	Resource UUID, which uniquely identifies the resource	3.17.13
vmInstanceUuid	String	Virtual Machine UUID	3.17.13
l3NetworkUuid	String	Distributed Port Group UUID	3.17.13
ip	String	The IP address.	3.17.13
mac	String	The MAC address.	3.17.13
hypervisorType	String	The hypervisor type.	3.17.13
netmask	String	The netmask.	3.17.13
gateway	String	The gateway IP address.	3.17.13
metaData	String	The metadata.	3.17.13
ipVersion	Integer	The IP version.	3.17.13
driverType	String	The driver type.	3.17.13
internalName	String	The internal name.	3.17.13
deviceId	Integer	The device ID.	3.17.13
type	String	The resource type.	3.17.13
state	String	NIC Status	3.17.13
createDate	Timestamp	Creation time	3.17.13
lastOpDate	Timestamp	Last modification time	3.17.13
usedIps	List	For details, see usedIps	3.17.13

#usedIps

Name	Type	Description	Starting Version
uuid	String	Resource UUID, which uniquely identifies the resource	4.10.0
ipRangeUuid	String	IP Range UUID	4.10.0
l3NetworkUuid	String	Distributed Port Group UUID	4.10.0
ipVersion	Integer	IP protocol number	4.10.0
ip	String	IP address	4.10.0
netmask	String	Subnet mask	4.10.0
gateway	String	Gateway address	4.10.0
usedFor	String	Allocation reason	4.10.0
ipInLong	long	Long stored IP address, only valid for ipv4	4.10.0
vmNicUuid	String	Virtual Machine NIC UUID	4.10.0
createDate	Timestamp	Creation time	4.10.0
lastOpDate	Timestamp	Last modification time	4.10.0

#allVolumes

Name	Type	Description	Starting Version
uuid	String	Resource UUID, which uniquely identifies the resource	3.17.13
name	String	Resource name	3.17.13
description	String	Detailed resource description	3.17.13
primaryStorageUuid	String	Data Storage UUID	3.17.13
vmInstanceUuid	String	Virtual Machine UUID	3.17.13
diskOfferingUuid	String	Disk Offering UUID	3.17.13
rootImageUuid	String	The root image UUID.	3.17.13
installPath	String	The installation path.	3.17.13
type	String	The resource type.	3.17.13
format	String	The format.	3.17.13
size	Long	The size.	3.17.13
actualSize	Long	The actual size.	3.17.13
deviceId	Integer	The device ID.	3.17.13
state	String	The resource state.	3.17.13
status	String	The resource status.	3.17.13
createDate	Timestamp	Creation time	3.17.13
lastOpDate	Timestamp	Last modification time	3.17.13
isShareable	Boolean	Whether the resource is shareable.	3.17.13
volumeQos	String	The volume QoS.	3.17.13
lastDetachDate	Timestamp	The last detach date.	3.17.13
lastVmInstanceUuid	String	The last VM instance UUID.	3.17.13
encrypted	Boolean	Whether the resource is encrypted.	5.1.0

#vmCdRoms

Name	Type	Description	Starting Version
uuid	String	Resource UUID, which uniquely identifies the resource	3.17.13
vmInstanceUuid	String	Virtual Machine UUID	3.17.13
deviceId	Integer	The device ID.	3.17.13
isoUuid	String	The ISO UUID.	3.17.13
isoInstallPath	String	The ISO install path.	3.17.13
name	String	Resource name	3.17.13
description	String	Detailed resource description	3.17.13
createDate	Timestamp	Creation time	3.17.13
lastOpDate	Timestamp	Last modification time	3.17.13

SDK Examples

Java SDK

MigrateVmAction action = new MigrateVmAction();
action.vmInstanceUuid = "c53c9b6235703b8ab96c1cc35859242d";
action.hostUuid = "7571fb72e52b3fcab1a6992e7eef4cce";
action.migrateFromDestination = false;
action.allowUnknown = false;
action.downTime = 300;
action.enableMigrationTls = false;
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c";
MigrateVmAction.Result res = action.call();

Python SDK

action = MigrateVmAction()
action.vmInstanceUuid = "c53c9b6235703b8ab96c1cc35859242d"
action.hostUuid = "7571fb72e52b3fcab1a6992e7eef4cce"
action.migrateFromDestination = false
action.allowUnknown = false
action.downTime = 300
action.enableMigrationTls = false
action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"
res = action.call()

PreviousQueryDirectory NextQueryShareableVolumeVmInstanceRef