Check Upgrade
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Run sanity checks using the UpgradeSpec parameters passed.
Request
URLURL
https://{api_host}/rest/vcenter/deployment/upgrade?action=check
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains DeploymentUpgradeCheckRequestBody
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"
}
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | DeploymentUpgradeUpgradeSpec |
UpgradeSpec parameters to run sanity check on. |
Response
Response
Response BodyResponse Body
200 OK returns
DeploymentUpgradeCheckResponseBody
of type application/json
CheckInfo containing the check results.
{
"value": {
"result": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"source_info": {
"active_directory_domain": "string",
"data_migration_info": {
"all": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"all_with_deferred": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core_events_tasks": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core_events_tasks_with_deferred": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
}
},
"deployment_size": "enum",
"deployment_type": "enum",
"dns_servers": [
"string"
],
"hostname": "string",
"sso_domain_name": "string",
"version": "string"
},
"status": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | DeploymentCheckInfo |
CheckInfo containing the check results. |
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=check
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if passed arguments are invalid. |
| 401 | ErrorRest | 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 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED state. |
| default | ErrorRest | Not available |
