Get Trust Authority Hosts KMS
Returns 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
Path Parameters
Path 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, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
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.
Errors
500
com.vmware.vapi.std.errors.error : if service’s TLS certificate chain is not valid. | com.vmware.vapi.std.errors.resource_inaccessible : if connection to host failed.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-hosts/{host}/kms
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.0.0
