Vcenter Deployment Install get

Vcenter Deployment Install get

Get the parameters used to configure the ongoing appliance installation.

This operation was added in vSphere API 6.7.

Request
URI
GET
https://{api_host}/api/vcenter/deployment/install
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

InstallSpec parameters being used to configure appliance install.

Returns Vcenter Deployment Install InstallSpec of type(s) application/json 
{
    "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
}
vcsa_embedded
Required

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.

boolean
auto_answer
Optional

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.


400

if appliance is not in INSTALL_PROGRESS state.

Returns Vapi Std Errors NotAllowedInCurrentState of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotAllowedInCurrentState0 
"Vapi Std Errors NotAllowedInCurrentState Object"

401

if the caller is not authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0 
"Vapi Std Errors Unauthenticated Object"
string
challenge
Optional

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.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/deployment/install
On This Page
Vcenter Operations
GET
Vcenter Deployment Install get
POST
Vcenter Deployment Install check
POST
Vcenter Deployment Install start
POST
Vcenter Deployment Install cancel