REST API - create

vcenter hvc links: create

Creates a new hybrid link between the local and foreign PSC. Warning: This operation is available as technical preview. It may be changed in a future release.

Request:

HTTP request

POST https://{server}/rest/hvc/links

Request Body Structure:

JSON

{
    "spec": {
        "admin_groups": [
            "string",
            "string"
        ],
        "domain_name": "string",
        "password": "secret string",
        "port": "string",
        "psc_hostname": "string",
        "ssl_thumbprint": "string",
        "username": "string"
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
spec	create_spec	Specification for the new link to be created.
spec.psc_hostname	string	The PSC hostname for the domain to be linked. Warning: This attribute is available as technical preview. It may be changed in a future release.
spec.port	string	The HTTPS port of the PSC to be linked. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. If unset 443 will be used as default.
spec.domain_name	string	The domain to which the PSC belongs. Warning: This attribute is available as technical preview. It may be changed in a future release.
spec.username	string	The administrator username of the PSC. Warning: This attribute is available as technical preview. It may be changed in a future release.
spec.password	secret	The administrator password of the PSC. Warning: This attribute is available as technical preview. It may be changed in a future release.
spec.ssl_thumbprint	string	The ssl thumbprint of the server. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. if unset no thumbprint is passed.
spec.admin_groups	string[]	List of groups to be added to enable administrator access to. Warning: This attribute is available as technical preview. It may be changed in a future release. Optional. if unset administrator access will not be set.

Response:

HTTP Status Code: 200

Representation:

JSON

{
"value": "obj-103"
}

Response Type:

Name	Type	Description
bold = required
value	string	The identifier of the newly linked domain.

Errors:

HTTP Status Code	Type	Description
400	already_exists	If the link already exists.
400	invalid_argument	If the spec is not valid.
400	unsupported	If the PSC or the VC version is not supported.
403	unauthorized	If the user is not authorized.
400	invalid_request	If the SSL certificate of the foreign PSC cannot be validated by comparing with the thumbprint provided in vcenter.hvc.links.create_spec.ssl_thumbprint or if vcenter.hvc.links.create_spec.ssl_thumbprint is unset. The value of the {@link InvalidRequest#data) field will be a structure that contains all the fields defined in vcenter.hvc.links.certificate_info.
500	error	if the system reports an error while responding to the request.