Vcenter Deployment Upgrade check
This operation is deprecated as of vSphere API 9.0.0.0.
Run sanity checks using the UpgradeSpec parameters passed.
This operation was added in vSphere API 6.7.
UpgradeSpec parameters to run sanity check on.
Show optional properties
{
"source_appliance": {},
"source_location": {}
}{
"source_appliance": {
"hostname": "string",
"https_port": 0,
"ssl_thumbprint": "string",
"ssl_certificate": "string",
"ssl_verify": false,
"sso_admin_username": "string",
"sso_admin_password": "string",
"root_password": "string",
"ssh_verify": false,
"ssh_thumbprint": "string"
},
"source_location": {
"hostname": "string",
"https_port": 0,
"ssl_thumbprint": "string",
"ssl_certificate": "string",
"ssl_verify": false,
"username": "string",
"password": "string"
},
"history": {
"data_set": "string",
"defer_import": false
},
"vcsa_embedded": {
"ceip_enabled": false
},
"psc": {
"ceip_enabled": false
},
"replicated_partner_hostname": "string",
"export_directory": "string",
"auto_answer": false,
"skip_products_prechecks": false
}This property is deprecated as of vSphere API 9.0.0.0.
Source appliance spec.
This property was added in vSphere API 6.7.
This property is deprecated as of vSphere API 9.0.0.0.
Source location spec.
This property was added in vSphere API 6.7.
This property is deprecated as of vSphere API 9.0.0.0.
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.
This property was added in vSphere API 6.7.
If missing or null, only core database content will be migrated.
This property is deprecated as of vSphere API 9.0.0.0.
Information that are specific to this embedded vCenter Server.
This property was added in vSphere API 6.7.
If missing or null, ceip_enabled for embedded vcenter server upgrade will default to enabled.
This property is deprecated as of vSphere API 9.0.0.0.
Information that are specific to this Platform Services Controller.
This property was added in vSphere API 6.7.
If missing or null, ceip_enabled for psc upgrade will default to enabled.
This property is deprecated as of vSphere API 9.0.0.0.
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 missing or null, when the upgrade finishes, the vCenter Server external Platform Services Controller are converged into the vCenter Server appliance.
This property was added in vSphere API 8.0.3.0.
This property is optional because it was added in a newer version than its parent node.
This property is deprecated as of vSphere API 9.0.0.0.
Use the option to provide export directory information during vCenter Server upgrade.
This property was added in vSphere API 8.0.3.0.
If missing or null, will default to seat directory.
This property is deprecated as of vSphere API 9.0.0.0.
Use the default option for any questions that may come up during appliance configuration.
This property was added in vSphere API 6.7.
If missing or null, will default to false.
This property is deprecated as of vSphere API 9.0.0.0.
Use the option to skip products interoperability checks during upgrade prechecks.
This property was added in vSphere API 8.0.3.0.
If missing or null, will default to false.
CheckInfo containing the check results.
"Vcenter Deployment CheckInfo Object"Status of the check.
For more information see: Vcenter Deployment CheckStatus.
This property was added in vSphere API 6.7.
Result of the check.
This property was added in vSphere API 6.7.
This property will be missing or null if result is not available at the current step of the task.
Information collected from the source machine.
This property was added in vSphere API 7.0.0.0.
This property is used only for upgrade.
Vapi Std Errors InvalidArgument if passed arguments are invalid.
Vapi Std Errors NotAllowedInCurrentState if the appliance is not in INITIALIZED state.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the caller is not authenticated.
if source credentials are not valid.
if source container credentials are not valid.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"source_appliance":"{}","source_location":"{}"}' https://{api_host}/api/vcenter/deployment/upgrade?action=check