REST API - get
  1. Operations
  2. hlm
  3. deployment
  4. install

hlm deployment install: get

Retrieve the install specs provided at the time to invoking install api. 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

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

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "sso_info" : {
        "hostname" : "string",
        "https_port" : 1
    },
    "vmc_info" : {
        "hostname" : "string",
        "https_port" : 1,
        "admin_username" : "string"
    }
}

Headers:

None

Type:

Name Type Description
bold = required
- install_info Spec parameters being used to install the HLM.
-.sso_info SSO_info 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_info.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_info.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.

If unset, port 443 will be used.
-.vmc_info VMC_info 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_info.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_info.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_info.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.

Errors:

HTTP Status Code Type Description
401 unauthenticated if the caller is not authenticated.
400 not_allowed_in_current_state if appliance is not in INSTALL_PROGRESS state.