Vcenter Deployment Migrate get

Vcenter Deployment Migrate get

This operation is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Get the MigrateSpec parameters used to configure the ongoing appliance migration.

This operation was added in vSphere API 7.0.0.0.

Request
URI
GET
https://{api_host}/api/vcenter/deployment/migrate
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

MigrateSpec parameters being used to configure appliance migration.

Returns Vcenter Deployment Migrate MigrateSpec of type(s) application/json
{
    "source_vc_windows": {
        "hostname": "string",
        "username": "string",
        "password": "string"
    },
    "existing_migration_assistant": {
        "https_port": 0,
        "ssl_thumbprint": "string",
        "ssl_certificate": "string"
    },
    "history": {
        "data_set": "string",
        "defer_import": false
    },
    "vcsa_embedded": {
        "ceip_enabled": false
    },
    "psc": {
        "ceip_enabled": false
    },
    "active_directory": {
        "domain": "string",
        "username": "string",
        "password": "string"
    },
    "auto_answer": false,
    "replicated_partner_hostname": "string",
    "export_directory": "string"
}
source_vc_windows
Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Information specific to the Windows vCenter Server.

This property was added in vSphere API 7.0.0.0.

existing_migration_assistant
Required

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Information specific to the Migration Assistant that is running on the Windows vCenter Server.

This property was added in vSphere API 7.0.0.0.

history
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

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.

This property was added in vSphere API 7.0.0.0.

If missing or null, only core database content will be migrated.

vcsa_embedded
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Information specific to an embedded vCenter Server.

This property was added in vSphere API 7.0.0.0.

Only required if the vCenter Server that is going to be migrated is an embedded vCenter Server.

psc
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Information specific to a Platform Services Controller.

This property was added in vSphere API 7.0.0.0.

Only required if the vCenter Server that is going to be migrated is a Platform Services Controller.

active_directory
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Information specific to the Active Directory server to which the source windows vCenter Server is joined.

This property was added in vSphere API 7.0.0.0.

If missing or null, existing appliance will not be joined to an Active Directory.

boolean
auto_answer
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Use the default option for any questions that may come up during appliance configuration.

This property was added in vSphere API 7.0.0.0.

If missing or null, will default to false.

string
replicated_partner_hostname
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

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 missing or null, when the migration finishes, the vCenter Server external Platform Services Controller are converged into the vCenter Server appliance.

This property was added in vSphere API 7.0.0.0.

string
export_directory
Optional

This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.

Use the option to provide export directory information during vCenter Server migration.

This property was added in vSphere API 7.0.0.0.

If missing or null, will default to root directory.


400

if appliance is not in MIGRATE_PROGRESS state.

Returns Vapi Std Errors NotAllowedInCurrentState of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotAllowedInCurrentState0
"Vapi Std Errors NotAllowedInCurrentState Object"

401

if the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/deployment/migrate