Start Install Deprecated
DescriptionStart the appliance installation.
Request
URLURL
https://{api_host}/rest/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
DeploymentInstallStartRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"vcsa_embedded": {
"ceip_enabled": false
}
}
}
spec
Required
InstallSpec parameters to configure the appliance install.
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
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"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}/rest/vcenter/deployment/install?action=start
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/vcenter/deployment/install?action=start
x-vmw-doc-operation: start
Availability
Added in 6.7
