REST API - reconfigure

vcenter system config deployment type: reconfigure

Reconfigure the type of the vCenter appliance. This operation was added in vSphere API 6.7.

Request:

HTTP request

POST https://{server}/rest/vcenter/system-config/deployment-type

Request Body Structure:

{
    "spec"{
        "remote_psc"{
            "https_port"1,
            "sso_admin_password""string",
            "psc_hostname""string",
            "ssl_thumbprint""string",
            "ssl_verify"true
        },
        "type""VCSA_EMBEDDED"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec reconfigure_spec ReconfigureSpec to set the appliance type.
spec.type string The type of the appliance. This attribute was added in vSphere API 6.7.

Defines the vCenter appliance types. This enumeration was added in vSphere API 6.7. Value is one of:
VCSA_EMBEDDED: vCenter Server Appliance with an embedded Platform Services Controller. This constant was added in vSphere API 6.7.
VCSA_EXTERNAL: vCenter Server Appliance with an external Platform Services Controller. This constant was added in vSphere API 6.7.
PSC_EXTERNAL: An external Platform Services Controller. This constant was added in vSphere API 6.7.

spec.remote_psc remote_psc_spec External PSC to register with when reconfiguring a VCSA_EMBEDDED appliance to a VCSA_EXTERNAL appliance. This attribute was added in vSphere API 6.7.

Optional. Only required when reconfiguring an VCSA_EMBEDDED node to a VCSA_EXTERNAL.

spec.remote_psc.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.remote_psc.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.remote_psc.sso_admin_password string The SSO administrator account password. This attribute was added in vSphere API 6.7.

spec.remote_psc.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.remote_psc.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.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
400 unsupported if the appliance is in CONFIGURED state and if not changing the type from VCSA_EMBEDDED to VCSA_EXTERNAL.
400 invalid_argument if passed arguments are invalid.
401 unauthenticated if the caller is not authenticated.
400 not_allowed_in_current_state if the appliance is not in INITIALIZED or CONFIGURED state.