vcenter deployment install: get
Get the parameters used to configure the ongoing appliance installation. This operation was added in vSphere API 6.7.
Request:
HTTP request
GET https://{server}/rest/vcenter/deployment/install
No request parameters
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"auto_answer" : true,
"vcsa_embedded" : {
"ceip_enabled" : true,
"standalone" : {
"sso_admin_password" : "string",
"sso_domain_name" : "string"
},
"replicated" : {
"https_port" : 1,
"sso_admin_password" : "string",
"ssl_thumbprint" : "string",
"ssl_verify" : true,
"partner_hostname" : "string"
}
}
}
}
"value" : {
"auto_answer" : true,
"vcsa_embedded" : {
"ceip_enabled" : true,
"standalone" : {
"sso_admin_password" : "string",
"sso_domain_name" : "string"
},
"replicated" : {
"https_port" : 1,
"sso_admin_password" : "string",
"ssl_thumbprint" : "string",
"ssl_verify" : true,
"partner_hostname" : "string"
}
}
}
}
Response Type:
Name | Type | Description |
---|---|---|
bold = required | ||
value | install_spec | InstallSpec parameters being used to configure appliance install. |
value.vcsa_embedded | vcsa_embedded_spec | Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7. |
value.vcsa_embedded.standalone | standalone_spec | Spec used to configure a standalone embedded vCenter Server. This field describes how the standalone vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7. Optional. If unset, will default to None. |
value.vcsa_embedded.standalone.sso_admin_password | string | The SSO administrator account password. This attribute was added in vSphere API 6.7. |
value.vcsa_embedded.standalone.sso_domain_name | string | The SSO domain name to be used to configure this appliance. This attribute was added in vSphere API 6.7. Optional. If unset, vsphere.local will be used. |
value.vcsa_embedded.replicated | replicated_spec | Spec used to configure a replicated embedded vCenter Server. This field describes how the replicated vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7. Optional. If unset, will default to None. |
value.vcsa_embedded.replicated.partner_hostname | string | The IP address or DNS resolvable name of the partner PSC appliance. This attribute was added in vSphere API 6.7. |
value.vcsa_embedded.replicated.https_port | long | The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7. Optional. If unset, port 443 will be used. |
value.vcsa_embedded.replicated.sso_admin_password | string | The SSO administrator account password. This attribute was added in vSphere API 6.7. |
value.vcsa_embedded.replicated.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. |
value.vcsa_embedded.replicated.ssl_verify | boolean | SSL verification should be enabled or disabled. This attribute was added in vSphere API 6.7. Optional. If unset, ssl_verify true will be used. |
value.vcsa_embedded.ceip_enabled | boolean | Whether CEIP should be enabled or disabled. This attribute was added in vSphere API 6.7. |
value.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. |
Errors:
HTTP Status Code | Type | Description |
---|---|---|
401 | unauthenticated | if the caller is not authenticated. |
400 | not_allowed_in_current_state | if appliance is not in INSTALL_PROGRESS state. |