Migration Service (Plus)
Overview
ZStack Cloud provides the Migration Service, allowing you to migrate VM systems and data from other virtualization platforms to the current cloud. Currently, with the Migration Service, you can:
Migrate VM instances from the vCenter that you took over to the current cloud. The supported vCenter versions include 5.5, 6.0, 6.5, 6.7, and 7.0. Note that the version of the vCenter server must be consistent with that of the ESXi host.
Migrate VM instances from a KVM cloud platform to the current cloud.
If you took over vCenter 7.0, to ensure that the VM console can open properly, we recommend that you download the trusted root CA certificate when you log into vCenter.
The Migration Service is a separate feature module. To use this feature, you need to purchase both the Base License and the Plus License of the Migration Service. The Plus License cannot be used independently.
Advantages of the Migration Service are as follows:
- Allows you to perform one-click V2V migrations for VM instances in bulk.
- Allows you to add a conversion host and create a V2V job and lets the Cloud do the rest.
- Allows you to configure an independent migration network and a network QoS for a conversion host to control transmission bottlenecks and improve migration efficiencies.
- Allows you to customize configurations for destination VM instances when you create a V2V job.
- Monitors and manages the entire migration process in the visualized, well-designed UI.
Inventory
V2V Conversion Host Inventory
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The UUID. For more information, see Resource Property. | 3.0.1 | ||
| name | The name. For more information, see Resource Property. | 3.0.1 | ||
| description | The description. For more information, see Resource Property. | Yes | 3.0.1 | |
| hostUuid | The host UUID. | 3.0.1 | ||
| type | The volume type. | 3.0.1 | ||
| state | The state of the volume backup. | 3.0.1 | ||
| storagePath | The image storage path of the V2V migration. | 3.0.1 | ||
| groupBy | Groups rows into subgroups based on values of columns or expressions. This field is equivalent to the Group By clause in MySQL, such as groupBy=type. | Yes | 3.0.1 | |
| createDate | The creation date. For more information, see Resource Property. | 3.0.1 | ||
| lastOpDate | The last operation date. For more information, see Resource Property. | 3.0.1 | ||
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.1 |
Sample
{
"inventories": [
{
"createDate": "Sep 21, 2018 9:51:05 AM",
"description": "",
"hostUuid": "a039266264964f239196a15bec178a56",
"lastOpDate": "Sep 21, 2018 9:51:05 AM",
"name": "10.0.69.145",
"state": "Enabled",
"storagePath": "/tmp/cloud",
"type": "VMWARE",
"uuid": "d8281e94496947ff978e8157f04f6699"
}
],
"success": true
}
Operations
AddV2VConversionHost
Adds a V2V conversion host. For example,
AddV2VConversionHost name=test-V2V storagePath=/tmp/cloud hostUuid=a039266264964f239196a15bec178a56 type=VMWARE
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| name | The resource name. | 3.0.1 | ||
| type | The type of the V2V conversion host. |
|
3.0.1 | |
| hostUuid | The host UUID. | 3.0.1 | ||
| description | The detailed description of the resource. | Yes | 3.0.1 | |
| storagePath | The image storage path of the V2V migration. | 3.0.1 | ||
| resourceUuid | The resource UUID. | Yes | 3.0.1 | |
| tagUuids | The tag UUID list. | Yes | 3.4.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.1 | |
| timeout | Yes |
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}.
- Format of the networkcidr option:
ChangeV2VConversionHostState
Changes the state of a V2V conversion host. For example,
ChangeV2VConversionHostState uuid=c4e1a78bba0646a88d6f878eb247aa6a stateEvent=disable
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.0.1 | ||
| stateEvent | The state event. | Yes |
|
3.0.1 |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.1 | |
| timeout | Yes |
ConvertVmFromForeignHypervisor
Performs V2V migration. For example,
ConvertVmFromForeignHypervisor name=test-centos7.2 url=vmware://28ff91d347d14dc9896fb4a58ea8269b cpuNum=1 memorySize=1 primaryStorageUuid=f96ec2cbac524501b313c35cd279d317 l3NetworkUuids=0d05980697ec4b96b4ab6f69ab2b74c6 conversionHostUuid=8b1791d1f3634b43a74cda9c83027b6b
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| url | The source VM instance URL. | 3.0.1 | ||
| name | The resource name. | 3.0.1 | ||
| description | The detailed description of the resource. | Yes | 3.0.1 | |
| conversionHostUuid | The V2V conversion host UUID. | Yes
|
3.0.1 | |
| cpuNum | The CPU count. | 3.0.1 | ||
| memorySize | The memory size. | 3.0.1 | ||
| zoneUuid | The zone UUID. | Yes | 3.0.1 | |
| clusterUuid | The cluster UUID. | Yes | 3.0.1 | |
| hostUuid | The host UUID. | Yes | 3.0.1 | |
| primaryStorageUuid | The primary storage UUID. | 3.0.1 | ||
| l3NetworkUuids | The L3 network UUID list. | 3.0.1 | ||
| defaultL3NetworkUuid | The UUID of the default L3 network. | Yes | 3.0.1 | |
| platform | The platform. | Yes |
|
3.0.1 |
| type | The VM instance type. | Yes |
|
3.0.1 |
| strategy | The V2V migration strategy, which determines whether the target VM instance will be started immediately after migration. | Yes |
|
3.0.1 |
| longJobName | The migration job name. | Yes | 3.0.1 | |
| longJobDescription | The migration job description. | Yes | 3.0.1 | |
| resourceUuid | The resource UUID of the V2V migration job. | Yes | 3.0.1 | |
| convertStrategy | Yes | 3.6.0 | ||
| sshPrivKey | The private key that is used to verify SSH login. | Yes | 3.6.0 | |
| pauseVm | Whether to pause the VM instance before migration. | Yes | 3.6.0 | |
| volumeFilters | The volume filter information. | Yes | 3.6.0 | |
| tagUuids | The tag UUID list. | Yes | 3.6.0 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.1 | |
| timeout | Yes |
DeleteV2VConversionHost
Deletes a V2V conversion host. For example,
DeleteV2VConversionHost uuid=c4e1a78bba0646a88d6f878eb247aa6a
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.0.1 | ||
| deleteMode | The delete mode. | Yes | 3.0.1 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.1 | |
| timeout | Yes |
QueryV2VConversionHost
Queries a V2V conversion host. For example,
QueryV2VConversionHost Uuid=8b1791d1f3634b43a74cda9c83027b6b
Primitive Fields of Query
See V2V Conversion Host Inventory.
Nested and Expanded Fields of Query
| Field | Inventory | Description | Starting Version |
|---|---|---|---|
| host | Host Inventory | The host. | 3.0.1 |
UpdateV2VConversionHost
Updates a V2V conversion host. For example,
UpdateV2VConversionHost uuid=d8281e94496947ff978e8157f04f6699
Parameters
| Name | Description | Optional | Valid Value | Starting Version |
|---|---|---|---|---|
| uuid | The resource UUID. | 3.0.1 | ||
| name | The resource name. | Yes | 3.0.1 | |
| description | The detailed description of the resource. | Yes | 3.0.1 | |
| storagePath | The image storage path of the V2V migration. | Yes | 3.0.1 | |
| userTags | The user tags. For more information, see CreateUserTag. | Yes | 3.0.1 | |
| systemTags | The system tags. For more information, see CreateSystemTag. | Yes | 3.0.1 | |
| timeout | Yes |
Tags
You can create a user tag on a V2V conversion service by using resourceType=LongJobVO. For example,
CreateUserTag resourceType=LongJobVO tag=golden-ResourceStack resourceUuid=3539de80967e44af99cd62ff5d53da30You can create a user tag for a V2V conversion host by using resourceType=V2VConversionHostVO. For example,
CreateUserTag resourceType=V2VConversionHostVO tag=golden-ResourceStack resourceUuid=8b1791d1f3634b43a74cda9c83027b6b
System Tags
You can configure the downstream bandwidth and the upstream bandwidth of a V2V conversion host.
Before you create a SystemTag, make sure that the SystemTag does not exist by using QuerySystemTag to avoid the multiple occurrences of the same SystemTag on a same resource.
You can configure the downstream bandwidth of a V2V conversion host by using CreateSystemTag. Note that the downstream bandwidth will limit the download speed from the source vCenter primary storage to the V2V conversion host. For example,
CreateSystemTag resourceUuid=8b1791d1f3634b43a74cda9c83027b6b resourceType=V2VConversionHostVO tag=networkInboundBandwidth::10000You can configure the upstream bandwidth of a V2V conversion host by using CreateSystemTag. Note that the upstream bandwidth will limit the upload speed from the V2V conversion host to the target primary storage. For example,
CreateSystemTag resourceUuid=8b1791d1f3634b43a74cda9c83027b6b resourceType=V2VConversionHostVO tag=networkOutboundBandwidth::10000You can update bandwidth limits by using UpdateSystemTag. For example,
UpdateSystemTag resourceUuid=8b1791d1f3634b43a74cda9c83027b6b resourceType=V2VConversionHostVO tag=networkInboundBandwidth::20000You can read bandwidth limits by using QuerySystemTag. For example,
QuerySystemTag resourceUuid=8b1791d1f3634b43a74cda9c83027b6b resourceType=V2VConversionHostVO tag=networkInboundBandwidth::10000You can delete bandwidth limits by using DeleteTag. For example,
DeleteTag uuid=13500acdbac6434f8584686649ec6dc9
