vcenter deployment upgrade: check
Run sanity checks using the UpgradeSpec parameters passed. This operation was added in vSphere API 6.7.
Request:
HTTP request
POST https://{server}/rest/vcenter/deployment/upgrade?action=check
Request Body Structure:
{
"spec" : {
"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"
}
}
"spec" : {
"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"
}
}
Request Body Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| spec | upgrade_spec | UpgradeSpec parameters to run sanity check on. |
| spec.source_appliance | source_appliance_spec | Source appliance spec. This attribute was added in vSphere API 6.7. |
| spec.source_appliance.hostname | string | The IP address or DNS resolvable name of the source appliance. This attribute was added in vSphere API 6.7. |
| spec.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. |
| spec.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. |
| spec.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. |
| spec.source_appliance.sso_admin_username | string | The SSO administrator account on the source appliance. This attribute was added in vSphere API 6.7. |
| spec.source_appliance.sso_admin_password | secret | The SSO administrator account password. This attribute was added in vSphere API 6.7. |
| spec.source_appliance.root_password | secret | The password of the root user on the source appliance. This attribute was added in vSphere API 6.7. |
| spec.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. |
| spec.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. |
| spec.source_location | location_spec | Source location spec. This attribute was added in vSphere API 6.7. |
| spec.source_location.hostname | string | The IP address or DNS resolvable name of the container. This attribute was added in vSphere API 6.7. |
| spec.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. |
| spec.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. |
| spec.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. |
| spec.source_location.username | string | The administrator account on the host. This attribute was added in vSphere API 6.7. |
| spec.source_location.password | secret | The administrator account password. This attribute was added in vSphere API 6.7. |
| spec.history | history_migration_spec | Determines how vCenter history will be migrated during the upgrade process. vCenter history consists of:
|
| spec.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. |
| spec.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. |
| spec.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. |
| spec.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. |
| spec.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. |
| spec.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. |
| spec.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. |
| spec.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. |
| spec.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. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"result" : {
"warnings" : [
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"errors" : [
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"info" : [
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
]
},
"source_info" : {
"replicated_partners" : [
"string",
"string"
],
"deployment_type" : "VCSA_EMBEDDED",
"hostname" : "string",
"sso_domain_name" : "string",
"active_directory_domain" : "string",
"disk_info" : [
{
"size" : 1.5,
"mount_point" : "string",
"used" : 1.5,
"free" : 1.5
},
{
"size" : 1.5,
"mount_point" : "string",
"used" : 1.5,
"free" : 1.5
}
],
"data_migration_info" : {
"all" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"core" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"core_events_tasks" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"core_events_tasks_with_deferred" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"all_with_deferred" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
}
},
"version" : "string",
"deployment_size" : "TINY",
"dns_servers" : [
"string",
"string"
]
},
"status" : "SUCCESS"
}
}
"value" : {
"result" : {
"warnings" : [
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"errors" : [
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"info" : [
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"id" : "string",
"time" : "2015-01-01T22:13:05.651Z",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"resolution" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
]
},
"source_info" : {
"replicated_partners" : [
"string",
"string"
],
"deployment_type" : "VCSA_EMBEDDED",
"hostname" : "string",
"sso_domain_name" : "string",
"active_directory_domain" : "string",
"disk_info" : [
{
"size" : 1.5,
"mount_point" : "string",
"used" : 1.5,
"free" : 1.5
},
{
"size" : 1.5,
"mount_point" : "string",
"used" : 1.5,
"free" : 1.5
}
],
"data_migration_info" : {
"all" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"core" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"core_events_tasks" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"core_events_tasks_with_deferred" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
},
"all_with_deferred" : {
"estimated_import_time" : 1,
"required_free_disk_space_on_source" : 1.5,
"estimated_export_time" : 1
}
},
"version" : "string",
"deployment_size" : "TINY",
"dns_servers" : [
"string",
"string"
]
},
"status" : "SUCCESS"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | check_info | CheckInfo containing the check results. |
| value.status | string | Status of the check. This attribute was added in vSphere API 6.7. Defines the status of the checks. This enumeration was added in vSphere API 6.7. Value is one of: SUCCESS: All checks have completed successfully. This constant was added in vSphere API 6.7. FAILED: A fatal error was encountered when running the sanity checks. This constant was added in vSphere API 6.7. |
| value.result | notifications | Result of the check. This attribute was added in vSphere API 6.7. Optional. This field will be unset if result is not available at the current step of the task. |
| value.result.info | notification[] | Info notification messages reported. This attribute was added in vSphere API 6.7. Optional. Only set if an info was reported by the task. |
| value.result.info[].id | string | The notification id. This attribute was added in vSphere API 6.7. |
| value.result.info[].time | date_time | The time the notification was raised/found. This attribute was added in vSphere API 6.7. Optional. Only set if the time information is available. |
| value.result.info[].message | localizable_message | The notification message. This attribute was added in vSphere API 6.7. |
| value.result.info[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| value.result.info[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| value.result.info[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
| value.result.warnings | notification[] | Warning notification messages reported. This attribute was added in vSphere API 6.7. Optional. Only set if an warning was reported by the task. |
| value.result.errors | notification[] | Error notification messages reported. This attribute was added in vSphere API 6.7. Optional. Only set if an error was reported by the task. |
| value.source_info | source_info | Information collected from the source machine. This attribute was added in vSphere API 7.0.0.0. Optional. This field is used only for upgrade and migrate. |
| value.source_info.hostname | string | The IP address or DNS resolvable name of the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.version | string | Source vCenter Server version. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.deployment_type | string | Deployment type of the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. Defines the vCenter appliance types. This enumeration was added in vSphere API 6.7. Value is one of: VCSA_EMBEDDED: vCenter Server Appliance with an embedded Platform Services Controller. This constant was added in vSphere API 6.7. VCSA_EXTERNAL: vCenter Server Appliance with an external Platform Services Controller. This constant was added in vSphere API 6.7. PSC_EXTERNAL: An external Platform Services Controller. This constant was added in vSphere API 6.7. |
| value.source_info.deployment_size | string | Deployment size of the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. Defines the vCenter Server Appliance sizes. This enumeration was added in vSphere API 7.0.0.0. Value is one of: TINY: Appliance size of 'tiny'. This constant was added in vSphere API 7.0.0.0. SMALL: Appliance size of 'small'. This constant was added in vSphere API 7.0.0.0. MEDIUM: Appliance size of 'medium'. This constant was added in vSphere API 7.0.0.0. LARGE: Appliance size of 'large'. This constant was added in vSphere API 7.0.0.0. XLARGE: Appliance size of 'extra large'. This constant was added in vSphere API 7.0.0.0. |
| value.source_info.sso_domain_name | string | The SSO domain name of the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.active_directory_domain | string | The domain name of the Active Directory server to which the source vCenter Server is joined. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.dns_servers | string[] | IP addresses of the DNS servers of the Active Directory server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info | data_migration_info | Contains all the available migrate options, estimated export and import time and the space required to migrate the data. This attribute was added in vSphere API 7.0.0.0. Optional. This field will be available if estimate data is available for the appliance. |
| value.source_info.data_migration_info.core | data_migration_estimate | Migrate only core data and configuration from vCenter Server. Events, tasks, and stats will not be migrated. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core.estimated_export_time | long | The time estimated to export data from the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core.estimated_import_time | long | The time estimated to import data to the upgraded vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core.required_free_disk_space_on_source | double | The extra free space required on source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core_events_tasks | data_migration_estimate | Migrate core, events, and tasks from vCenter Server. Stats will not be migrated. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core_events_tasks.estimated_export_time | long | The time estimated to export data from the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core_events_tasks.estimated_import_time | long | The time estimated to import data to the upgraded vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core_events_tasks.required_free_disk_space_on_source | double | The extra free space required on source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.all | data_migration_estimate | Migrate all data from vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.all.estimated_export_time | long | The time estimated to export data from the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.all.estimated_import_time | long | The time estimated to import data to the upgraded vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.all.required_free_disk_space_on_source | double | The extra free space required on source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core_events_tasks_with_deferred | data_migration_estimate | Migrate core, events, and tasks from vCenter Server. Events and tasks will be migrated after the upgrade. Stats will not be migrated. This attribute was added in vSphere API 7.0.0.0. Optional. This field will be available only if the source database is using an external database. |
| value.source_info.data_migration_info.core_events_tasks_with_deferred.estimated_export_time | long | The time estimated to export data from the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core_events_tasks_with_deferred.estimated_import_time | long | The time estimated to import data to the upgraded vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.core_events_tasks_with_deferred.required_free_disk_space_on_source | double | The extra free space required on source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.all_with_deferred | data_migration_estimate | Migrate all data from vCenter Server. Events, tasks, and stats will be migrated after the upgrade. This attribute was added in vSphere API 7.0.0.0. Optional. This field will be available only if the source database is using an external database. |
| value.source_info.data_migration_info.all_with_deferred.estimated_export_time | long | The time estimated to export data from the source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.all_with_deferred.estimated_import_time | long | The time estimated to import data to the upgraded vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.data_migration_info.all_with_deferred.required_free_disk_space_on_source | double | The extra free space required on source vCenter Server. This attribute was added in vSphere API 7.0.0.0. |
| value.source_info.disk_info | disk_info[] | Contains information about the list of available disks. 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 disk info was not fetched for the vCenter Server filesystem. |
| value.source_info.replicated_partners | string[] | Contains information about the list of replicated partner nodes. 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 replicated partners information is not available for the current vCenter Server. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 401 | unauthenticated | if the caller is not authenticated. |
| 400 | invalid_argument | if passed arguments are invalid. |
| 400 | not_allowed_in_current_state | if the appliance is not in INITIALIZED state. |