REST API - link
  1. Operations
  2. vcenter
  3. hlm
  4. remote worker

vcenter hlm remote worker: link

Does operations for link as hvc solution user on the remote or target node. Currently, it creates a new trust for domain per the given spec. Note: This is only a pass through API which will call VCTrusts.create after validating privileges required to create trusts as part of creating Linked vCenters. 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}/rest/vcenter/hlm/remote/link

Request Body Structure:

{
    "input_spec" : {
        "trust_specs" : [
            {
                "domain" : "string",
                "label" : "string",
                "signing_cert_chains" : [
                    {
                        "cert_chain" : [
                            "string",
                            "string"
                        ]
                    },
                    {
                        "cert_chain" : [
                            "string",
                            "string"
                        ]
                    }
                ],
                "upn_suffixes" : [
                    "string",
                    "string"
                ],
                "type" : "string",
                "group_map" : [
                    {
                        "value" : [
                            "string",
                            "string"
                        ],
                        "key" : "string"
                    }
                ]
            },
            {
                "domain" : "string",
                "label" : "string",
                "signing_cert_chains" : [
                    {
                        "cert_chain" : [
                            "string",
                            "string"
                        ]
                    },
                    {
                        "cert_chain" : [
                            "string",
                            "string"
                        ]
                    }
                ],
                "upn_suffixes" : [
                    "string",
                    "string"
                ],
                "type" : "string",
                "group_map" : [
                    {
                        "value" : [
                            "string",
                            "string"
                        ],
                        "key" : "string"
                    }
                ]
            }
        ]
    }
}

Request Body Parameters:

Name Type Description
bold = required
input_spec link_input_spec
input_spec.trust_specs trust_create_spec[] 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.

input_spec.trust_specs[].domain string Domain identifier. 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.
input_spec.trust_specs[].label string Label of the trust. A non-unique, user-readable label. 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.
input_spec.trust_specs[].type string Type of trust. Hint for the UI to use to be able to distinguish this VC from others. 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. Type will only be added if provided.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
403 unauthorized if user does not have permissions to create trust to establish Link.
400 invalid_argument if groupMap key is not in UPN format, if group value is not found or if at least one upn suffix is not given.
500 error