This API has a deprecated equivalent from v7.0U1.
Get Upgrade
Get the UpgradeSpec parameters used to configure the ongoing appliance upgrade.
Request
URLURL
https://{api_host}/api/vcenter/deployment/upgrade
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
DeploymentUpgradeUpgradeSpec
of type application/json
UpgradeSpec parameters being used to configure appliance upgrade.
{
"auto_answer": false,
"history": {
"data_set": "EVENTS_TASKS",
"defer_import": false
},
"psc": {
"ceip_enabled": false
},
"source_appliance": {
"hostname": "string",
"https_port": 0,
"root_password": "string",
"ssh_thumbprint": "string",
"ssh_verify": false,
"ssl_thumbprint": "string",
"ssl_verify": false,
"sso_admin_password": "string",
"sso_admin_username": "string"
},
"source_location": {
"hostname": "string",
"https_port": 0,
"password": "string",
"ssl_thumbprint": "string",
"ssl_verify": false,
"username": "string"
},
"vcsa_embedded": {
"ceip_enabled": false
}
}
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 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. If unset, only core database content will be migrated.
psc
Optional
Information that are specific to this Platform Services Controller. If unset, ceip_enabled for psc upgrade will default to enabled.
vcsa_embedded
Optional
Information that are specific to this embedded vCenter Server. If unset, ceip_enabled for embedded vcenter server upgrade will default to enabled.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if appliance is not in UPGRADE_PROGRESS state.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetDeploymentUpgrade
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/deployment/upgrade
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/upgrade
x-vmw-doc-operation: get
Availability
Added in 7.0U2
