This API has a deprecated equivalent from v7.0U1.
Start Upgrade
DescriptionStart the appliance installation.
Request
URLURL
https://{api_host}/api/vcenter/deployment/upgrade?action=start
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"
Request Body
Request Body
DeploymentUpgradeUpgradeSpec of mimetype application/json
Required
UpgradeSpec parameters to configure the appliance upgrade.
{
"source_appliance": {
"hostname": "string",
"root_password": "string",
"sso_admin_password": "string",
"sso_admin_username": "string"
},
"source_location": {
"hostname": "string",
"password": "string",
"username": "string"
}
}
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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if passed arguments are invalid. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED state.
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. if source credentials are not valid. if source container credentials are not valid.
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
$DeploymentUpgradeSourceApplianceSpec = Initialize-DeploymentUpgradeSourceApplianceSpec -Hostname "MyHostname" -SsoAdminUsername "MySsoAdminUsername" -SsoAdminPassword "MySsoAdminPassword" -RootPassword "MyRootPassword"
$DeploymentLocationSpec = Initialize-DeploymentLocationSpec -Hostname "MyHostname" -Username "MyUsername" -Password "MyPassword"
$DeploymentUpgradeUpgradeSpec = Initialize-DeploymentUpgradeUpgradeSpec -SourceAppliance $DeploymentUpgradeSourceApplianceSpec -SourceLocation $DeploymentLocationSpec
Invoke-StartDeploymentUpgrade -DeploymentUpgradeUpgradeSpec $DeploymentUpgradeUpgradeSpec
PowerCLI Client SDK All Parameters Example
$DeploymentUpgradeSourceApplianceSpec = Initialize-DeploymentUpgradeSourceApplianceSpec -Hostname "MyHostname" -HttpsPort 0 -SslThumbprint "MySslThumbprint" -SslVerify $false -SsoAdminUsername "MySsoAdminUsername" -SsoAdminPassword "MySsoAdminPassword" -RootPassword "MyRootPassword" -SshVerify $false -SshThumbprint "MySshThumbprint"
$DeploymentLocationSpec = Initialize-DeploymentLocationSpec -Hostname "MyHostname" -HttpsPort 0 -SslThumbprint "MySslThumbprint" -SslVerify $false -Username "MyUsername" -Password "MyPassword"
$DeploymentHistoryMigrationSpec = Initialize-DeploymentHistoryMigrationSpec -DataSet "EVENTS_TASKS" -DeferImport $false
$DeploymentUpgradeVcsaEmbeddedSpec = Initialize-DeploymentUpgradeVcsaEmbeddedSpec -CeipEnabled $false
$DeploymentUpgradePscSpec = Initialize-DeploymentUpgradePscSpec -CeipEnabled $false
$DeploymentUpgradeUpgradeSpec = Initialize-DeploymentUpgradeUpgradeSpec -SourceAppliance $DeploymentUpgradeSourceApplianceSpec -SourceLocation $DeploymentLocationSpec -History $DeploymentHistoryMigrationSpec -VcsaEmbedded $DeploymentUpgradeVcsaEmbeddedSpec -Psc $DeploymentUpgradePscSpec -AutoAnswer $false
Invoke-StartDeploymentUpgrade -DeploymentUpgradeUpgradeSpec $DeploymentUpgradeUpgradeSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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}}' https://{api_host}/api/vcenter/deployment/upgrade?action=start
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/upgrade?action=start
x-vmw-doc-operation: start
Availability
Added in 7.0U2
