Check Install
Run sanity checks using the InstallSpec parameters passed.
Request
URLURL
https://{api_host}/api/vcenter/deployment/install?action=check
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 run sanity check with.
{
"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.
Response
Response
Response BodyResponse Body
200 OK returns
DeploymentCheckInfo of type application/json
CheckInfo containing the check results.
{
"result": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "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": "TINY",
"deployment_type": "VCSA_EMBEDDED",
"dns_servers": [
"string"
],
"hostname": "string",
"sso_domain_name": "string",
"version": "string"
},
"status": "SUCCESS"
}
status
Required
The CheckStatus enumerated type defines the status of the checks.
SUCCESS : All checks have completed successfully.
FAILED : A fatal error was encountered when running the sanity checks.
Possible values are: SUCCESS , FAILED
result
Optional
Result of the check. This field will be unset if result is not available at the current step of the task.
source_info
Optional
Information collected from the source machine. This field is used only for upgrade and migrate.
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 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.
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-CheckDeploymentInstall -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-CheckDeploymentInstall -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=check
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: check
Availability
Added in 6.7
