List KMS Services
Returns basic information about all registered Key Provider Service instances in this vCenter. if you do not have all of the privileges described as follows: - Operation execution requires TrustedAdmin.ReadTrustedHosts.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/kms/services?action=query
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"
Request Body
Request Body
TrustedInfrastructureKmsServicesFilterSpec of mimetype application/json
Optional
Return only services matching the specified filters. If {@term.unset} return all services.
{
"address": [
{
"hostname": "string",
"port": 0
}
],
"group": [
"string"
],
"services": [
"string"
],
"trust_authority_cluster": [
"string"
]
}
array of
TrustedInfrastructureNetworkAddress
address
Optional
A set of address by which to filter. If unset, the services will not be filtered by address.
array of
string
group
Optional
The group determines the Attestation Service instances this Key Provider Service can accept reports from. If unset, the Services will not be filtered by group.
array of
string
services
Optional
A set of IDs by which to filter the services. If unset, the services will not be filtered by ID. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.
array of
string
trust_authority_cluster
Optional
The cluster specifies the Trust Authority Cluster this Key Provider Service belongs to. If unset, the Services will not be filtered by trustAuthorityCluster.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
TrustedInfrastructureKmsServicesSummary
of type application/json
Basic information about all registered Key Provider Service instances in this vCenter.
[
{
"address": {
"hostname": "string",
"port": 0
},
"group": "string",
"service": "string",
"trust_authority_cluster": "string"
}
]
string
group
Required
The group determines the Attestation Service instances this Key Provider Service can accept reports from.
string
service
Required
The service’s unique identifier. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.trusted_infrastructure.kms.Service.
string
trust_authority_cluster
Required
The cluster specifies the Trust Authority Cluster this Key Provider service belongs to.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$TrustedInfrastructureNetworkAddress = Initialize-TrustedInfrastructureNetworkAddress -Hostname "MyHostname" -Port 0
$TrustedInfrastructureKmsServicesFilterSpec = Initialize-TrustedInfrastructureKmsServicesFilterSpec -Services "MyServices" -Address $TrustedInfrastructureNetworkAddress -Group "MyGroup" -TrustAuthorityCluster "MyTrustAuthorityCluster"
Invoke-QueryKmsServices -TrustedInfrastructureKmsServicesFilterSpec $TrustedInfrastructureKmsServicesFilterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"address":[{"hostname":"string","port":0}],"group":["string"],"services":["string"],"trust_authority_cluster":["string"]}' https://{api_host}/api/vcenter/trusted-infrastructure/kms/services?action=query
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.0.0
