This API has a deprecated equivalent from v7.0U1.
Get Install
Get the parameters used to configure the ongoing appliance installation.
Request
URLURL
https://{api_host}/api/vcenter/deployment/install
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
DeploymentInstallInstallSpec
of type application/json
InstallSpec parameters being used to configure appliance install.
{
"auto_answer": false,
"vcsa_embedded": {
"ceip_enabled": false,
"replicated": {
"https_port": 0,
"partner_hostname": "string",
"ssl_thumbprint": "string",
"ssl_verify": false,
"sso_admin_password": "string"
},
"standalone": {
"sso_admin_password": "string",
"sso_domain_name": "string"
}
}
}
vcsa_embedded
Required
Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured.
boolean
auto_answer
Optional
Use the default option for any questions that may come up during appliance configuration. If unset, will default to false.
Errors
400
com.vmware.vapi.std.errors.not_allowed_in_current_state : if appliance is not in INSTALL_PROGRESS state.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetDeploymentInstall
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/deployment/install
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/install
x-vmw-doc-operation: get
Availability
Added in 7.0U2
