Vcenter Hvc Links create
Creates a new hybrid link between the local and foreign PSC. Usage beyond VMware Cloud on AWS is not supported.
This operation was added in vSphere API 8.0.1.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
HLM.Manage.
Specification for the new link to be created.
Show optional properties
{
"psc_hostname": "string",
"domain_name": "string",
"username": "string",
"password": "string"
}{
"psc_hostname": "string",
"port": "string",
"domain_name": "string",
"username": "string",
"password": "string",
"ssl_thumbprint": "string",
"ssl_certificate": "string",
"admin_groups": [
"string"
]
}The PSC hostname for the domain to be linked.
This property was added in vSphere API 8.0.1.0.
The HTTPS port of the PSC to be linked.
This property was added in vSphere API 8.0.1.0.
If missing or null 443 will be used as default.
The domain to which the PSC belongs.
This property was added in vSphere API 8.0.1.0.
The administrator username of the PSC.
This property was added in vSphere API 8.0.1.0.
The administrator password of the PSC.
This property was added in vSphere API 8.0.1.0.
This property is deprecated as of vSphere API 9.0.0.0. this property is deprecated please use sslCertificate instead.
The ssl thumbprint of the server.
This property was added in vSphere API 8.0.1.0.
if missing or null no thumbprint is passed.
The full SSL certificate of the target node encoded as PEM string.
This property was added in vSphere API 9.0.0.0.
if missing or null no certificate is passed.
List of groups to be added to enable administrator access to.
This property was added in vSphere API 8.0.1.0.
if missing or null administrator access will not be set.
The identifier of the newly linked domain.
The response will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
Vapi Std Errors AlreadyExists If the link already exists.
Vapi Std Errors InvalidArgument If the values of any of the properties of the spec parameter are not valid.
Vapi Std Errors Unsupported If the PSC or the VC version is not supported.
Vapi Std Errors UnverifiedPeer
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
If the user is not authorized.
"Vapi Std Errors Unauthorized Object"if the system reports an error while responding to the request.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"domain_name:"string","password:"string","psc_hostname:"string","username:"string"}' https://{api_host}/api/hvc/links