1. Operations
  2. vcenter
  3. deployment
  4. install

vcenter deployment install: start

Start the appliance installation. This operation was added in vSphere API 6.7

Request:

HTTP request

POST https://{server}/rest/vcenter/deployment/install?action=start

Request Body Structure:

{
    "spec": {
        "auto_answer": true,
        "psc": {
            "ceip_enabled": true,
            "replicated": {
                "https_port": 1,
                "partner_hostname": "string",
                "ssl_thumbprint": "string",
                "ssl_verify": true,
                "sso_admin_password": "string",
                "sso_site_name": "string"
            },
            "standalone": {
                "sso_admin_password": "string",
                "sso_domain_name": "string",
                "sso_site_name": "string"
            }
        },
        "vcsa_embedded": {
            "ceip_enabled": true,
            "replicated": {
                "https_port": 1,
                "partner_hostname": "string",
                "ssl_thumbprint": "string",
                "ssl_verify": true,
                "sso_admin_password": "string"
            },
            "standalone": {
                "sso_admin_password": "string",
                "sso_domain_name": "string"
            }
        },
        "vcsa_external": {
            "https_port": 1,
            "psc_hostname": "string",
            "ssl_thumbprint": "string",
            "ssl_verify": true,
            "sso_admin_password": "string"
        }
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec install_spec InstallSpec parameters to configure the appliance install.
spec.vcsa_embedded vcsa_embedded_spec Spec used to configure an embedded vCenter Server. This field describes how the embedded vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7

Optional. If unset, will not configure this appliance as Embedded vCenter Server. If unset, either vcsa_external or psc must be provided.
spec.vcsa_embedded.standalone standalone_spec Spec used to configure a standalone embedded vCenter Server. This field describes how the standalone vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7

Optional. If unset, will default to None.
spec.vcsa_embedded.standalone.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7
spec.vcsa_embedded.standalone.sso_domain_name string The SSO domain name to be used to configure this appliance. This attribute was added in vSphere API 6.7

Optional. If unset, vsphere.local will be used.
spec.vcsa_embedded.replicated replicated_spec Spec used to configure a replicated embedded vCenter Server. This field describes how the replicated vCenter Server appliance should be configured. This attribute was added in vSphere API 6.7

Optional. If unset, will default to None.
spec.vcsa_embedded.replicated.partner_hostname string The IP address or DNS resolvable name of the partner PSC appliance. This attribute was added in vSphere API 6.7
spec.vcsa_embedded.replicated.https_port long The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7

Optional. If unset, port 443 will be used.
spec.vcsa_embedded.replicated.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7
spec.vcsa_embedded.replicated.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7

Optional. This field is only relevant if ssl_verify is unset or has the value true.
spec.vcsa_embedded.replicated.ssl_verify boolean SSL verification should be enabled or disabled. This attribute was added in vSphere API 6.7

Optional. If unset, ssl_verify true will be used.
spec.vcsa_embedded.ceip_enabled boolean Whether CEIP should be enabled or disabled. This attribute was added in vSphere API 6.7
spec.psc psc_spec Spec used to configure a Platform Services Controller. This field describes how the Platform Services Controller appliance should be configured. This attribute was added in vSphere API 6.7

Optional. If unset, will not configure this appliance as Platform Services Controller. If unset, either vcsa_embedded or vcsa_external must be provided.
spec.psc.standalone standalone_psc_spec Spec used to configure a standalone Platform Services Controller. This field describes how the standalone PSC should be configured. This attribute was added in vSphere API 6.7

Optional. If unset, will default to None.
spec.psc.standalone.sso_site_name string The SSO site name used for this PSC. This attribute was added in vSphere API 6.7

Optional. If unset, default-first-site will be used.
spec.psc.standalone.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7
spec.psc.standalone.sso_domain_name string The SSO domain name to be used to configure this appliance. This attribute was added in vSphere API 6.7

Optional. If unset, vsphere.local will be used.
spec.psc.replicated replicated_psc_spec Spec used to configure a replicated Platform Services Controller. This field describes how the replicated PSC should be configured. This attribute was added in vSphere API 6.7

Optional. If unset, will default to None.
spec.psc.replicated.sso_site_name string The SSO sitename that will be used in PSC replication. This attribute was added in vSphere API 6.7

Optional. If unset, default-first-site will be used.
spec.psc.replicated.partner_hostname string The IP address or DNS resolvable name of the partner PSC appliance. This attribute was added in vSphere API 6.7
spec.psc.replicated.https_port long The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7

Optional. If unset, port 443 will be used.
spec.psc.replicated.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7
spec.psc.replicated.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate will be used for verification. This attribute was added in vSphere API 6.7

Optional. This field is only relevant if ssl_verify is unset or has the value true.
spec.psc.replicated.ssl_verify boolean SSL verification should be enabled or disabled. This attribute was added in vSphere API 6.7

Optional. If unset, ssl_verify true will be used.
spec.psc.ceip_enabled boolean Customer experience improvement program should be enabled or disabled. This attribute was added in vSphere API 6.7
spec.vcsa_external remote_psc_spec Spec used to configure a vCenter Server registered with an external PSC. This fields represent the remote external PSC that the configuring vCenter Server will be registering with. This attribute was added in vSphere API 6.7

Optional. If unset, will not configure this appliance as external vCenter Server. If unset, either vcsa_embedded or psc must be provided.
spec.vcsa_external.psc_hostname string The IP address or DNS resolvable name of the remote PSC to which this configuring vCenter Server will be registered to. This attribute was added in vSphere API 6.7
spec.vcsa_external.https_port long The HTTPS port of the external PSC appliance. This attribute was added in vSphere API 6.7

Optional. If unset, port 443 will be used.
spec.vcsa_external.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7
spec.vcsa_external.ssl_thumbprint string SHA1 thumbprint of the server SSL certificate will be used for verification when ssl_verify field is set to true. This attribute was added in vSphere API 6.7

Optional. This field is only relevant if ssl_verify is unset or has the value true.
spec.vcsa_external.ssl_verify boolean SSL verification should be enabled or disabled. If ssl_verify is true and and ssl_thumbprint is unset, the CA certificate will be used for verification. If ssl_verify is true and ssl_thumbprint is set then the thumbprint will be used for verification. No verification will be performed if ssl_verify value is set to false. This attribute was added in vSphere API 6.7

Optional. If unset, ssl_verify true will be used.
spec.auto_answer boolean Use the default option for any questions that may come up during appliance configuration. This attribute was added in vSphere API 6.7

Optional. If unset, will default to false.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
401 unauthenticated if the caller is not authenticated.
400 invalid_argument if passed arguments are invalid.
400 not_allowed_in_current_state if the appliance is not in INITIALIZED state.