vcenter deployment migrate: get
Get the MigrateSpec parameters used to configure the ongoing appliance migration. This operation was added in vSphere API 7.0.0.0.
Request:
HTTP request
GET https://{server}/rest/vcenter/deployment/migrate
No request parameters
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"psc" : {
"ceip_enabled" : true
},
"replicated_partner_hostname" : "string",
"existing_migration_assistant" : {
"https_port" : 1,
"ssl_thumbprint" : "string"
},
"auto_answer" : true,
"vcsa_embedded" : {
"ceip_enabled" : true
},
"history" : {
"data_set" : "EVENTS_TASKS",
"defer_import" : true
},
"source_vc_windows" : {
"hostname" : "string",
"password" : "secret string",
"username" : "string"
},
"active_directory" : {
"password" : "string",
"domain" : "string",
"username" : "string"
},
"export_directory" : "string"
}
}
"value" : {
"psc" : {
"ceip_enabled" : true
},
"replicated_partner_hostname" : "string",
"existing_migration_assistant" : {
"https_port" : 1,
"ssl_thumbprint" : "string"
},
"auto_answer" : true,
"vcsa_embedded" : {
"ceip_enabled" : true
},
"history" : {
"data_set" : "EVENTS_TASKS",
"defer_import" : true
},
"source_vc_windows" : {
"hostname" : "string",
"password" : "secret string",
"username" : "string"
},
"active_directory" : {
"password" : "string",
"domain" : "string",
"username" : "string"
},
"export_directory" : "string"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | migrate_spec | MigrateSpec parameters being used to configure appliance migration. |
| value.source_vc_windows | source_vc_windows | Information specific to the Windows vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_vc_windows.hostname | string | The IP address or DNS resolvable name of the source Windows machine. This attribute was added in vSphere API 7.0.0.0. |
| value.source_vc_windows.username | string | The SSO account with administrative privilege to perform the migration operation. This attribute was added in vSphere API 7.0.0.0. |
| value.source_vc_windows.password | secret | The SSO administrator account password. This attribute was added in vSphere API 7.0.0.0. |
| value.existing_migration_assistant | migration_assistant_spec | Information specific to the Migration Assistant that is running on the Windows vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.existing_migration_assistant.https_port | long | The HTTPS port being used by Migration Assistant. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, port 9123 will be used. |
| value.existing_migration_assistant.ssl_thumbprint | string | SHA1 thumbprint of the Migration Assistant SSL certificate that will be used for verification. This attribute was added in vSphere API 7.0.0.0. |
| value.history | history_migration_spec | Determines how vCenter history will be migrated during the migration process. vCenter history consists of:
|
| value.history.data_set | string | Defines what part of vCenter historical data will be migrated along with core data. This attribute was added in vSphere API 6.7. Defines the vCenter history migration option choices. This enumeration was added in vSphere API 6.7. Value is one of: EVENTS_TASKS: Only event data and task data will be migrated along with the core data. This constant was added in vSphere API 6.7. ALL: All history data will be migrated along with the core data. This constant was added in vSphere API 6.7. |
| value.history.defer_import | boolean | Defines how vCenter history will be migrated. If set to true, vCenter history will be migrated separately after successful upgrade(supported scenarios are upgrade from 6.0 or 6.5 to 6.7) or migration, otherwise it will be migrated along with core data during the upgrade or migration process. vCSA upgrade with deferred import is no longer supported for target version 7.0 and later. This attribute was added in vSphere API 6.7. Optional. If unset, vCenter historical data won't be deferred and will be migrated along with core data. |
| value.vcsa_embedded | vcsa_embedded_spec | Information specific to an embedded vCenter Server. This attribute was added in vSphere API 7.0.0.0. Optional. Only required if the vCenter Server that is going to be migrated is an embedded vCenter Server. |
| value.vcsa_embedded.ceip_enabled | boolean | Customer experience improvement program should be enabled or disabled for this embedded vCenter Server migration. This attribute was added in vSphere API 7.0.0.0. |
| value.psc | psc_spec | Information specific to a Platform Services Controller. This attribute was added in vSphere API 7.0.0.0. Optional. Only required if the vCenter Server that is going to be migrated is a Platform Services Controller. |
| value.psc.ceip_enabled | boolean | Customer experience improvement program should be enabled or disabled for this Platform Services Controller migration. This attribute was added in vSphere API 7.0.0.0. |
| value.active_directory | active_directory_spec | Information specific to the Active Directory server to which the source windows vCenter Server is joined. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, existing appliance will not be joined to an Active Directory. |
| value.active_directory.domain | string | The domain name of the Active Directory server to which the migrated vCenter Server appliance should be joined. This attribute was added in vSphere API 7.0.0.0. |
| value.active_directory.username | string | Active Directory user that has permission to join the Active Directory after the vCenter Server is migrated to appliance. This attribute was added in vSphere API 7.0.0.0. |
| value.active_directory.password | string | Active Directory user password that has permission to join the Active Directory after the vCenter Server is migrated to appliance. This attribute was added in vSphere API 7.0.0.0. |
| value.auto_answer | boolean | Use the default option for any questions that may come up during appliance configuration. This attribute was added in vSphere API 7.0.0.0. Optional. If unset, will default to false. |
| value.replicated_partner_hostname | string | 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. Optional. This field is optional because it was added in a newer version than its parent node. |
| value.export_directory | string | 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. Optional. If unset, will default to root directory. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 401 | unauthenticated | if the caller is not authenticated. |
| 400 | not_allowed_in_current_state | if appliance is not in MIGRATE_PROGRESS state. |