Check Install
If vSphere APIs begin with /rest (vs /api), any maps are consumed/returned instead as arrays of objects, each containing a key and a value property field.
Run sanity checks using the InstallSpec parameters passed.
Request
URLURL
https://{api_host}/rest/vcenter/deployment/install?action=check
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
DeploymentInstallCheckRequestBody of type application/json (required){
"spec": {
"vcsa_embedded": {
"ceip_enabled": false
}
}
}
Response
Response
Response BodyResponse Body
200 OK returns
DeploymentInstallCheckResponseBody
of type application/json
CheckInfo containing the check results.
{
"value": {
"result": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "string",
"time": "string"
}
]
},
"source_info": {
"active_directory_domain": "string",
"data_migration_info": {
"all": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"all_with_deferred": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core_events_tasks": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core_events_tasks_with_deferred": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
}
},
"deployment_size": "enum",
"deployment_type": "enum",
"dns_servers": [
"string"
],
"hostname": "string",
"sso_domain_name": "string",
"version": "string"
},
"status": "enum"
}
}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=check
Errors
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.
if external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
if external PSC credentials are not valid when configuring a VCSA_EXTERNAL appliance.
409
com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED state.
