This API has a deprecated equivalent from v7.0U1.
Start Migrate
Start the appliance migration.
Request
URLURL
https://{api_host}/api/vcenter/deployment/migrate?action=start
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Request Body
Request Body
DeploymentMigrateMigrateSpec of mimetype application/json
Required
MigrateSpec parameters to configure the appliance migration. The Migrate.MigrateSpec structure contains the fields to migrate an existing vCenter Server for Windows to an appliance.
(The request body parameter is missing description)
{
"existing_migration_assistant": {
"ssl_thumbprint": "string"
},
"source_vc_windows": {
"hostname": "string",
"password": "string",
"username": "string"
}
}
source_vc_windows
Required
Information specific to the Windows vCenter Server.
existing_migration_assistant
Required
Information specific to the Migration Assistant that is running on the Windows vCenter Server.
active_directory
Optional
Information specific to the Active Directory server to which the source windows vCenter Server is joined. If unset, existing appliance will not be joined to an Active Directory.
string
export_directory
Optional
Use the option to provide export directory information during vCenter Server migration. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. If unset, will default to root directory.
history
Optional
Determines how vCenter history will be migrated during the migration process. vCenter history consists of: - Statistics - Events - Tasks By default only core data will be migrated. Use this spec to define which part of vCenter history data will be migrated and when. If unset, only core database content will be migrated.
psc
Optional
Information specific to a Platform Services Controller. Only required if the vCenter Server that is going to be migrated is a Platform Services Controller.
string
replicated_partner_hostname
Optional
Applicable only if the convergence is in progress and at least one of the nodes is already migrated. Set the replication partner for the currently migrated node and provide the value of any previously converged migrated node host name as either IP address or FQDN. If unset, when the migration finishes, the vCenter Server external Platform Services Controller are converged into the vCenter Server appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. This field is optional because it was added in a newer version than its parent node.
boolean
auto_answer
Optional
Use the default option for any questions that may come up during appliance configuration. If unset, will default to false.
vcsa_embedded
Optional
Information specific to an embedded vCenter Server. Only required if the vCenter Server that is going to be migrated is an embedded vCenter Server.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"active_directory":{"domain":"string","password":"string","username":"string"},"auto_answer":false,"existing_migration_assistant":{"https_port":0,"ssl_thumbprint":"string"},"export_directory":"string","history":{"data_set":"enum","defer_import":false},"psc":{"ceip_enabled":false},"replicated_partner_hostname":"string","source_vc_windows":{"hostname":"string","password":"string","username":"string"},"vcsa_embedded":{"ceip_enabled":false}}' https://{api_host}/api/vcenter/deployment/migrate?action=start
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if passed arguments are invalid. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED state.
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.
if migration assistant credentials are not valid.
Availability
Added in 7.0U2
