This API has a deprecated equivalent from v7.0U1.
Start Migrate
DescriptionStart 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
DeploymentMigrateMigrateSpec of mimetype application/json
Required
MigrateSpec parameters to configure the appliance migration.
{
"existing_migration_assistant": {
"ssl_thumbprint": "string"
},
"source_vc_windows": {
"hostname": "string",
"password": "string",
"username": "string"
}
}
existing_migration_assistant
Required
Information specific to the Migration Assistant that is running on the Windows vCenter Server.
source_vc_windows
Required
Information specific to 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.
boolean
auto_answer
Optional
Use the default option for any questions that may come up during appliance configuration. If unset, will default to false.
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.
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.
Authentication
This operation uses the following authentication methods.
Code Samples
Code Samples
PowerCLI Client SDK Example
$DeploymentMigrateSourceVcWindows = Initialize-DeploymentMigrateSourceVcWindows -Hostname "MyHostname" -Username "MyUsername" -Password "MyPassword"
$DeploymentMigrateMigrationAssistantSpec = Initialize-DeploymentMigrateMigrationAssistantSpec -SslThumbprint "MySslThumbprint"
$DeploymentMigrateMigrateSpec = Initialize-DeploymentMigrateMigrateSpec -SourceVcWindows $DeploymentMigrateSourceVcWindows -ExistingMigrationAssistant $DeploymentMigrateMigrationAssistantSpec
Invoke-StartDeploymentMigrate -DeploymentMigrateMigrateSpec $DeploymentMigrateMigrateSpec
PowerCLI Client SDK All Parameters Example
$DeploymentMigrateSourceVcWindows = Initialize-DeploymentMigrateSourceVcWindows -Hostname "MyHostname" -Username "MyUsername" -Password "MyPassword"
$DeploymentMigrateMigrationAssistantSpec = Initialize-DeploymentMigrateMigrationAssistantSpec -HttpsPort 0 -SslThumbprint "MySslThumbprint"
$DeploymentHistoryMigrationSpec = Initialize-DeploymentHistoryMigrationSpec -DataSet "EVENTS_TASKS" -DeferImport $false
$DeploymentMigrateVcsaEmbeddedSpec = Initialize-DeploymentMigrateVcsaEmbeddedSpec -CeipEnabled $false
$DeploymentMigratePscSpec = Initialize-DeploymentMigratePscSpec -CeipEnabled $false
$DeploymentMigrateActiveDirectorySpec = Initialize-DeploymentMigrateActiveDirectorySpec -Domain "MyDomain" -Username "MyUsername" -Password "MyPassword"
$DeploymentMigrateMigrateSpec = Initialize-DeploymentMigrateMigrateSpec -SourceVcWindows $DeploymentMigrateSourceVcWindows -ExistingMigrationAssistant $DeploymentMigrateMigrationAssistantSpec -History $DeploymentHistoryMigrationSpec -VcsaEmbedded $DeploymentMigrateVcsaEmbeddedSpec -Psc $DeploymentMigratePscSpec -ActiveDirectory $DeploymentMigrateActiveDirectorySpec -AutoAnswer $false
Invoke-StartDeploymentMigrate -DeploymentMigrateMigrateSpec $DeploymentMigrateMigrateSpec
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"},"history":{"data_set":"EVENTS_TASKS","defer_import":false},"psc":{"ceip_enabled":false},"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.
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/migrate?action=start
x-vmw-doc-operation: start
Availability
Added in 7.0U2
