Vcenter Deployment Upgrade get

Vcenter Deployment Upgrade get

This operation is deprecated as of vSphere API 9.0.0.0.

Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.

This operation was added in vSphere API 6.7.

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

UpgradeSpec parameters being used to configure appliance upgrade.

Returns Vcenter Deployment Upgrade UpgradeSpec of type(s) application/json
{
    "source_appliance": {
        "hostname": "string",
        "https_port": 0,
        "ssl_thumbprint": "string",
        "ssl_certificate": "string",
        "ssl_verify": false,
        "sso_admin_username": "string",
        "sso_admin_password": "string",
        "root_password": "string",
        "ssh_verify": false,
        "ssh_thumbprint": "string"
    },
    "source_location": {
        "hostname": "string",
        "https_port": 0,
        "ssl_thumbprint": "string",
        "ssl_certificate": "string",
        "ssl_verify": false,
        "username": "string",
        "password": "string"
    },
    "history": {
        "data_set": "string",
        "defer_import": false
    },
    "vcsa_embedded": {
        "ceip_enabled": false
    },
    "psc": {
        "ceip_enabled": false
    },
    "replicated_partner_hostname": "string",
    "export_directory": "string",
    "auto_answer": false,
    "skip_products_prechecks": false
}
source_appliance
Required

This property is deprecated as of vSphere API 9.0.0.0.

Source appliance spec.

This property was added in vSphere API 6.7.

source_location
Required

This property is deprecated as of vSphere API 9.0.0.0.

Source location spec.

This property was added in vSphere API 6.7.

history
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Determines how vCenter history will be migrated during the upgrade 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 6.7.

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

vcsa_embedded
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Information that are specific to this embedded vCenter Server.

This property was added in vSphere API 6.7.

If missing or null, ceip_enabled for embedded vcenter server upgrade will default to enabled.

psc
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Information that are specific to this Platform Services Controller.

This property was added in vSphere API 6.7.

If missing or null, ceip_enabled for psc upgrade will default to enabled.

string
replicated_partner_hostname
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Applicable only if the convergence is in progress and at least one of the nodes is already upgraded. Set the replication partner for the currently upgraded node and provide the value of any previously converged upgraded node host name as either IP address or FQDN. If missing or null, when the upgrade finishes, the vCenter Server external Platform Services Controller are converged into the vCenter Server appliance.

This property was added in vSphere API 8.0.3.0.

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

string
export_directory
Optional

This property is deprecated as of vSphere API 9.0.0.0.

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

This property was added in vSphere API 8.0.3.0.

If missing or null, will default to seat directory.

boolean
auto_answer
Optional

This property is deprecated as of 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 6.7.

If missing or null, will default to false.

boolean
skip_products_prechecks
Optional

This property is deprecated as of vSphere API 9.0.0.0.

Use the option to skip products interoperability checks during upgrade prechecks.

This property was added in vSphere API 8.0.3.0.

If missing or null, will default to false.


400

if appliance is not in UPGRADE_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/upgrade