vcenter vcha: credentials spec
The
credentials_spec structure contains information to connect to the vCenter server managing the VCHA nodes. This structure was added in vSphere API 6.7.1.Representation:
{
"active_location" : {
"hostname" : "string",
"password" : "secret string",
"port" : 1,
"ssl_thumbprint" : "string",
"username" : "string"
}
}
"active_location" : {
"hostname" : "string",
"password" : "secret string",
"port" : 1,
"ssl_thumbprint" : "string",
"username" : "string"
}
}
Attributes:
| Name | Type | Description |
|---|---|---|
| Required | ||
| active_location | connection_spec | Connection information for the management vCenter Server of the Active Node in a VCHA Cluster. This attribute was added in vSphere API 6.7.1. |
| active_location.hostname | string | IP Address or DNS of the vCenter. This attribute was added in vSphere API 6.7.1. |
| Optional | ||
| active_location.port | long | Port number. This attribute was added in vSphere API 6.7.1. Optional. If unset, port 443 will be used. |
| active_location.ssl_thumbprint | string | SHA1 hash of the server SSL certificate. This attribute was added in vSphere API 6.7.1. Optional. If unset, empty ssl thumbprint is assumed. |
| active_location.username | string | Username to access the server. This attribute was added in vSphere API 6.7.1. Optional. This field is currently required. If unset, an error is returned. In the future, if this field is unset, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail. |
| active_location.password | secret | Password for the specified user. This attribute was added in vSphere API 6.7.1. Optional. This field is currently required. If unset, an empty password is assumed. In the future, if this field is unset, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail. |