List Trusted Clusters KMS Services Applied Config Task
Returns basic information about the health of all Key Provider Service configurations applied to the cluster with respect to the desired state.
Request
URLURL
https://{api_host}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config?action=query&vmw-task=true
Path Parameters
Path Parameters
string
cluster
Required
The ID of the cluster against which the operation will be executed. The parameter must be an identifier for the resource type: ClusterComputeResource.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
TrustedInfrastructureTrustedClustersKmsServicesAppliedConfigFilterSpec of mimetype application/json
Optional
The specification for the subset of results desired to be returned. If {@term.unset} all results are returned.
{
"address": [
{
"hostname": "string",
"port": 0
}
],
"health": "NONE"
}
array of
TrustedInfrastructureNetworkAddress
address
Optional
The network address of the Key Provider Service configured for use in the Trusted Cluster. If unset, no filtration will be performed by network address.
health
Optional
The ServicesAppliedConfig.Health enumerated type is an indicator for the consistency of the applied Key Provider Service configuration in a cluster with respect to the desired state.
NONE : The consistency of the applied configuration is unknown.
OK : The applied Key Provider Service configuration is consistent with the desired state.
ERROR : The applied Key Provider Service configuration has diverged from the desired state.
Possible values are: NONE , OK , ERROR
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted returns
string of type application/json
An identifier for the task created by this API invocation will be returned. If the non-async version of the operation returns a value, this id can be used with the CIS Get Task operation to fetch that value. The normal description of this operation’s return value will follow if one exists. The health status for each applied configuration in the given cluster.
PowerCLI Client SDK Example
$TrustedInfrastructureNetworkAddress = Initialize-TrustedInfrastructureNetworkAddress -Hostname "MyHostname" -Port 0
$TrustedInfrastructureTrustedClustersKmsServicesAppliedConfigFilterSpec = Initialize-TrustedInfrastructureTrustedClustersKmsServicesAppliedConfigFilterSpec -Health "NONE" -Address $TrustedInfrastructureNetworkAddress
Invoke-QueryClusterKmsServicesAppliedConfigAsync -Cluster "MyCluster" -TrustedInfrastructureTrustedClustersKmsServicesAppliedConfigFilterSpec $TrustedInfrastructureTrustedClustersKmsServicesAppliedConfigFilterSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"address":[{"hostname":"string","port":0}],"health":"NONE"}' https://{api_host}/api/vcenter/trusted-infrastructure/trusted-clusters/{cluster}/kms/services-applied-config?action=query&vmw-task=true
Errors
404
com.vmware.vapi.std.errors.not_found : if no cluster corresponding to the given ID is found within this vCenter.
500
com.vmware.vapi.std.errors.error : if there is a generic error. | com.vmware.vapi.std.errors.resource_busy : if there are ongoing mutating operations.
Availability
Added in 7.0.1.0
