This API has a deprecated equivalent from v7.0U1.
Start Install
DescriptionStart the appliance installation.
Request
URLURL
https://{api_host}/api/vcenter/deployment/install?action=start
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"
Request Body
Request Body
DeploymentInstallInstallSpec of mimetype application/json
Required
InstallSpec parameters to configure the appliance install.
{
"vcsa_embedded": {
"ceip_enabled": false
}
}
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.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if passed arguments are invalid. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED state.
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. if the partner PSC credentials are not valid when configuring PSC to replicate with partner PSC. if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
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
$DeploymentInstallVcsaEmbeddedSpec = Initialize-DeploymentInstallVcsaEmbeddedSpec -CeipEnabled $false
$DeploymentInstallInstallSpec = Initialize-DeploymentInstallInstallSpec -VcsaEmbedded $DeploymentInstallVcsaEmbeddedSpec
Invoke-StartDeploymentInstall -DeploymentInstallInstallSpec $DeploymentInstallInstallSpec
PowerCLI Client SDK All Parameters Example
$DeploymentStandaloneSpec = Initialize-DeploymentStandaloneSpec -SsoAdminPassword "MySsoAdminPassword" -SsoDomainName "MySsoDomainName"
$DeploymentReplicatedSpec = Initialize-DeploymentReplicatedSpec -PartnerHostname "MyPartnerHostname" -HttpsPort 0 -SsoAdminPassword "MySsoAdminPassword" -SslThumbprint "MySslThumbprint" -SslVerify $false
$DeploymentInstallVcsaEmbeddedSpec = Initialize-DeploymentInstallVcsaEmbeddedSpec -Standalone $DeploymentStandaloneSpec -Replicated $DeploymentReplicatedSpec -CeipEnabled $false
$DeploymentInstallInstallSpec = Initialize-DeploymentInstallInstallSpec -VcsaEmbedded $DeploymentInstallVcsaEmbeddedSpec -AutoAnswer $false
Invoke-StartDeploymentInstall -DeploymentInstallInstallSpec $DeploymentInstallInstallSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"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"}}}' https://{api_host}/api/vcenter/deployment/install?action=start
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/install?action=start
x-vmw-doc-operation: start
Availability
Added in 7.0U2
