vcenter deployment upgrade: get
Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade. This operation was added in vSphere API 6.7.
Request:
HTTP request
GET https://{server}/rest/vcenter/deployment/upgrade
No request parameters
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"source_location" : {
"hostname" : "string",
"https_port" : 1,
"password" : "secret string",
"ssl_thumbprint" : "string",
"ssl_verify" : true,
"username" : "string"
},
"psc" : {
"ceip_enabled" : true
},
"source_appliance" : {
"hostname" : "string",
"https_port" : 1,
"sso_admin_password" : "secret string",
"ssh_verify" : true,
"ssl_thumbprint" : "string",
"ssl_verify" : true,
"root_password" : "secret string",
"ssh_thumbprint" : "string",
"sso_admin_username" : "string"
},
"replicated_partner_hostname" : "string",
"auto_answer" : true,
"vcsa_embedded" : {
"ceip_enabled" : true
},
"history" : {
"data_set" : "EVENTS_TASKS",
"defer_import" : true
},
"export_directory" : "string"
}
}
"value" : {
"source_location" : {
"hostname" : "string",
"https_port" : 1,
"password" : "secret string",
"ssl_thumbprint" : "string",
"ssl_verify" : true,
"username" : "string"
},
"psc" : {
"ceip_enabled" : true
},
"source_appliance" : {
"hostname" : "string",
"https_port" : 1,
"sso_admin_password" : "secret string",
"ssh_verify" : true,
"ssl_thumbprint" : "string",
"ssl_verify" : true,
"root_password" : "secret string",
"ssh_thumbprint" : "string",
"sso_admin_username" : "string"
},
"replicated_partner_hostname" : "string",
"auto_answer" : true,
"vcsa_embedded" : {
"ceip_enabled" : true
},
"history" : {
"data_set" : "EVENTS_TASKS",
"defer_import" : true
},
"export_directory" : "string"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | upgrade_spec | UpgradeSpec parameters being used to configure appliance upgrade. |
| value.source_appliance | source_appliance_spec | Source appliance spec. This attribute was added in vSphere API 6.7. |
| value.source_appliance.hostname | string | The IP address or DNS resolvable name of the source appliance. This attribute was added in vSphere API 6.7. |
| value.source_appliance.https_port | long | The HTTPS port of the source appliance. This attribute was added in vSphere API 6.7. Optional. If unset, port 443 will be used. |
| value.source_appliance.ssl_thumbprint | string | SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7. Optional. This field is only relevant if ssl_verify is unset or has the value true. |
| value.source_appliance.ssl_verify | boolean | SSL verification should be enabled or disabled for the source appliance validations. By default it is enabled and will use SSL certificate for verification. If thumbprint is provided, will use thumbprint for the verification. This attribute was added in vSphere API 6.7. Optional. If unset, ssl_verify true will be used. |
| value.source_appliance.sso_admin_username | string | The SSO administrator account on the source appliance. This attribute was added in vSphere API 6.7. |
| value.source_appliance.sso_admin_password | secret | The SSO administrator account password. This attribute was added in vSphere API 6.7. |
| value.source_appliance.root_password | secret | The password of the root user on the source appliance. This attribute was added in vSphere API 6.7. |
| value.source_appliance.ssh_verify | boolean | Appliance SSH verification should be enabled or disabled. By default it is disabled and will not use any verification. If thumbprint is provided, thumbprint verification will be performed. This attribute was added in vSphere API 6.7. Optional. If unset, ssh_verify true will be used. |
| value.source_appliance.ssh_thumbprint | string | MD5 thumbprint of the server SSH key will be used for verification. This attribute was added in vSphere API 6.7. Optional. This field is only relevant if ssh_verify is unset or has the value true. |
| value.source_location | location_spec | Source location spec. This attribute was added in vSphere API 6.7. |
| value.source_location.hostname | string | The IP address or DNS resolvable name of the container. This attribute was added in vSphere API 6.7. |
| value.source_location.https_port | long | The HTTPS port of the container. This attribute was added in vSphere API 6.7. Optional. If unset, port 443 will be used. |
| value.source_location.ssl_thumbprint | string | SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7. Optional. This field is only relevant if ssl_verify is unset or has the value true. |
| value.source_location.ssl_verify | boolean | SSL verification should be enabled or disabled. If ssl_verify is true and and ssl_thumbprint is unset, the CA certificate will be used for verification. If ssl_verify is true and ssl_thumbprint is set then the thumbprint will be used for verification. No verification will be performed if ssl_verify value is set to false. This attribute was added in vSphere API 6.7. Optional. If unset, ssl_verify true will be used. |
| value.source_location.username | string | The administrator account on the host. This attribute was added in vSphere API 6.7. |
| value.source_location.password | secret | The administrator account password. This attribute was added in vSphere API 6.7. |
| value.history | history_migration_spec | Determines how vCenter history will be migrated during the upgrade 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 that are specific to this embedded vCenter Server. This attribute was added in vSphere API 6.7. Optional. If unset, ceip_enabled for embedded vcenter server upgrade will default to enabled. |
| value.vcsa_embedded.ceip_enabled | boolean | Customer experience improvement program should be enabled or disabled for this embedded vCenter Server upgrade. This attribute was added in vSphere API 6.7. |
| value.psc | psc_spec | Information that are specific to this Platform Services Controller. This attribute was added in vSphere API 6.7. Optional. If unset, ceip_enabled for psc upgrade will default to enabled. |
| value.psc.ceip_enabled | boolean | Customer experience improvement program should be enabled or disabled for this Platform Services Controller upgrade. This attribute was added in vSphere API 6.7. |
| value.replicated_partner_hostname | string | 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 unset, when the upgrade 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 upgrade. 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 seat directory. |
| 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 6.7. Optional. If unset, will default to false. |
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 UPGRADE_PROGRESS state. |