This API has a deprecated equivalent from v7.0U1.

Check Install

{
	"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"
		}
	}
}

DeploymentInstallVcsaEmbeddedSpec

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.

api_key

Response

Response 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"
}

DeploymentCheckStatus

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

DeploymentNotifications

result Optional

Result of the check. This field will be unset if result is not available at the current step of the task.

DeploymentSourceInfo

source_info Optional

Information collected from the source machine. This field is used only for upgrade and migrate.

Errors

Error

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.

Error

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.

Code Samples

PowerCLI Client SDK Example

Show example with all parameters

$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-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/install?action=check
x-vmw-doc-operation: check

Availability

Added in 7.0U2

Install Operations

get

Get Install

post

Cancel Install

post

Check Install

post

Start Install

Check Install

On This Page

Request

URL

Header Parameters

vmware-api-session-id example

Request Body

Authentication

api_key

Response

Response Body

Errors

Code Samples

PowerCLI Client SDK Example

PowerCLI Client SDK All Parameters Example

cURL Command

Vendor Extensions

Availability

On This Page

Install Operations

Was this page helpful?