Migration Service (Plus)

ZStack Cloud 4.8.10>ZStack Cloud API Reference>Platform O&M>Migration Service (Plus)

The V2V Migration Service is a separate feature module. To use this feature, you need to purchase both the Base License and the Plus License of V2V Migration Service. The Plus License cannot be used independently.

Migration Service Operations

AddV2VConversionHost

API Request

URLs

POST zstack/v1/v2v-conversion-hosts

Headers

Authorization: OAuth the-session-uuid

Body

{   "params": {     "name": "V2V-Converter-01",     "description": "to convert vm from foreign hypervisor",     "type": "VMWARE",     "hostUuid": "fc2971a1a5943bdda6733feecfb26861",     "storagePath": "/path/to/large/directory/"   },   "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":"V2V-Converter-01","description":"to convert vm from foreign hypervisor","type":"VMWARE","hostUuid":"fc2971a1a5943bdda6733feecfb26861","storagePath":"/path/to/large/directory/"}}' http://localhost:8080/zstack/v1/v2v-conversion-hosts

Request Parameters

Name	Type	Location	Description	Optional Value	Starting Version
name	String	body (contained in the params structure)	The resource name.		3.0.1
description	String	body (contained in the params structure)	Optional. The detailed description of the resource.		3.0.1
type	String	body (contained in the params structure)	The type of the V2V conversion host.	VMWARE	3.0.1
hostUuid	String	body (contained in the params structure)	The host UUID.		3.0.1
storagePath	String	body (contained in the params structure)	The image storage path of the V2V migration.		3.0.1
resourceUuid	String	body (contained in the params structure)	Optional. The resource UUID.		3.0.1
tagUuids	List	body (contained in the params structure)	Optional. The tag UUID list.		3.4.0
systemTags	List	body	Optional. The system tags.		3.0.1
userTags	List	body	Optional. The user tags.		3.0.1

Note:

When you add a V2V conversion host in ZStack Cloud, you can specify the CIDR for the V2V migration network by adding the networkcidr option to SystemTags. The SystemTag is passed by using the networkcidr parameter.
- Format of the networkcidr option: conversion::network::cidr::{netcidr}
- Example: conversion::network::cidr::{10.0.0.1/24}.

API Response

Sample Response

{   "inventory": {     "uuid": "c6ac169863173a9bb5742974d731a242",     "name": "V2V-Converter-01",     "description": "to convert vm from foreign hypervisor",     "type": "VMWARE",     "hostUuid": "dcffe404cd0336a5817bfba0e56117ac",     "storagePath": "/path/to/large/directory/",     "state": "Enabled"   } }

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

#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.	3.0.1
description	String	The brief description of the error.	3.0.1
details	String	The details about the error.	3.0.1
elaboration	String	The reserved field. Default value: null.	3.0.1
opaque	LinkedHashMap	The reserved field. Default value: null.	3.0.1
cause	ErrorCode	The root error, which is the associated root cause of the current error. If no root error exists, this parameter is null.	3.0.1

#inventory

Name	Type	Description	Starting Version
uuid	String	The resource UUID.	3.0.1
name	String	The resource name.	3.0.1
description	String	The detailed description of the resource.	3.0.1
type	String	The type.	3.0.1
hostUuid	String	The host UUID.	3.0.1
storagePath	String	The image storage path of the V2V migration.	3.0.1
state	String	The state.	3.0.1
createDate	Timestamp	The creation date.	3.0.1
lastOpDate	Timestamp	The last operation date.	3.0.1

SDK Sample

Java SDK

AddV2VConversionHostAction action = new AddV2VConversionHostAction(); action.name = "V2V-Converter-01"; action.description = "to convert vm from foreign hypervisor"; action.type = "VMWARE"; action.hostUuid = "fc2971a1a5943bdda6733feecfb26861"; action.storagePath = "/path/to/large/directory/"; action.sessionId = "b86c9016b4f24953a9edefb53ca0678c"; AddV2VConversionHostAction.Result res = action.call();

Python SDK

AddV2VConversionHostAction action = AddV2VConversionHostAction() action.name = "V2V-Converter-01" action.description = "to convert vm from foreign hypervisor" action.type = "VMWARE" action.hostUuid = "fc2971a1a5943bdda6733feecfb26861" action.storagePath = "/path/to/large/directory/" action.sessionId = "b86c9016b4f24953a9edefb53ca0678c" AddV2VConversionHostAction.Result res = action.call()

ChangeV2VConversionHostState