Start Upgrade
Released in v6.7Start the appliance installation.
Request
URLURL
https://{api_host}/rest/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
DeploymentUpgradeStartRequestBody of type application/json (required){
"spec": {
"source_appliance": {
"hostname": "string",
"root_password": "string",
"sso_admin_password": "string",
"sso_admin_username": "string"
},
"source_location": {
"hostname": "string",
"password": "string",
"username": "string"
}
}
}
spec
Required
UpgradeSpec parameters to configure the appliance upgrade.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"auto_answer":false,"history":{"data_set":"enum","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}/rest/vcenter/deployment/upgrade?action=start
Errors
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.
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED state.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
