Get Trust Authority Hosts KMS
Released in v7.0.0 DescriptionReturns the connection info about the Key Provider Service running on the specified host. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts. - The resource HostSystem referenced by the parameter host requires System.View.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms
Parameters
Parameters
string
host
Required
@{link com.vmware.vcenter.Host} id.
The parameter must be an identifier for the resource type: HostSystem.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
Example: b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
TrustedInfrastructureTrustAuthorityHostsKmsInfo
of type application/json
The Kms.Info instance which contains the information necessary to connect to the Key Provider Service.
{
"address": {
"hostname": "string",
"port": 0
},
"cluster": "string",
"group": "string",
"host": "string",
"trusted_CA": {
"cert_chain": [
"string"
]
}
}
string
cluster
Required
The opaque string identifier of the cluster in which the Key Provider Service is part of.
string
group
Required
The group ID determines which Attestation Service instances this Key Provider Service can communicate with.
string
host
Required
The trusted ESX on which the service runs. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms
Errors
404
com.vmware.vapi.std.errors.error : if service's TLS certificate chain is not valid. | com.vmware.vapi.std.errors.not_found : if host doesn't match to any Host. | com.vmware.vapi.std.errors.resource_inaccessible : if connection to host failed.
