Vcenter Deployment Install check
Run sanity checks using the InstallSpec parameters passed.
This operation was added in vSphere API 6.7.
InstallSpec parameters to run sanity check with.
Show optional properties
{
"vcsa_embedded": {}
}{
"vcsa_embedded": {
"standalone": {
"sso_admin_password": "string",
"sso_domain_name": "string"
},
"replicated": {
"partner_hostname": "string",
"https_port": 0,
"sso_admin_password": "string",
"ssl_thumbprint": "string",
"ssl_certificate": "string",
"ssl_verify": false
},
"ceip_enabled": false
},
"auto_answer": false
}Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured.
This property was added in vSphere API 6.7.
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.
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 external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
"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 '{"vcsa_embedded":"{}"}' https://{api_host}/api/vcenter/deployment/install?action=check