REST API - start

hlm deployment install: start

Start HLM Installation on the Cloud Services Gateway Appliance. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/hlm/deployment/install

?action=start

{
    "sso_spec" : {
        "hostname" : "string",
        "https_port" : 1,
        "sso_admin_password" : "string",
        "ssl_thumbprint" : "string",
        "ssl_verify" : true
    },
    "vmc_spec" : {
        "hostname" : "string",
        "https_port" : 1,
        "admin_username" : "string",
        "ssl_thumbprint" : "string",
        "ssl_verify" : true,
        "admin_password" : "string"
    }
}

Body Parameters:

Name	Type	Description
bold = required
-	install_spec	Spec parameters to configure Cloud Services Gateway appliance with HLM.
-.sso_spec	SSO_spec	Spec used to configure a Cloud Services Gateway with the repliacted vcenter server. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.sso_spec.hostname	string	The IP address or DNS resolvable name of the on vcenter server appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.sso_spec.https_port	long	The HTTPS port of the vcenter server appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, port 443 will be used.
-.sso_spec.sso_admin_password	string	The SSO administrator account password. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.sso_spec.ssl_thumbprint	string	SHA1 thumbprint of the server SSL certificate will be used for verification. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. This field is only relevant if `ssl_verify` is unset or has the value true.
-.sso_spec.ssl_verify	boolean	Whether the SSL verification is enabled or disabled. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, ssl_verify true will be used.
-.vmc_spec	VMC_spec	VMC Spec used to fetch the VMC VC version to install the HLM of the version. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vmc_spec.hostname	string	The IP address or DNS resolvable name of the on vcenter server appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vmc_spec.https_port	long	The HTTPS port of the vcenter server appliance. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, port 443 will be used.
-.vmc_spec.admin_username	string	The VMC VC administrator user name. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vmc_spec.admin_password	string	The VMC VC administrator account password. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.vmc_spec.ssl_thumbprint	string	SHA1 thumbprint of the server SSL certificate will be used for verification. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. This field is only relevant if `ssl_verify` is unset or has the value true.
-.vmc_spec.ssl_verify	boolean	SSL verification should be enabled or disabled. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, ssl_verify true will be used.

Response:

HTTP Status Code: 200

Headers:

None

Type:

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.
400	unverified_peer	if SSL verifications fails for Cloud VC or on prem SSO