Vcenter TrustedInfrastructure TrustAuthorityHosts Kms list
This operation is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.
Returns a list of the hosts running a Key Provider Service matching the specified Vcenter TrustedInfrastructure TrustAuthorityHosts Kms FilterSpec.
This operation was added in vSphere API 7.0.0.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
TrustedAdmin.ReadTrustedHosts. - The resource
HostSystemreferenced by the property Vcenter TrustedInfrastructure TrustAuthorityHosts Kms FilterSpec.hosts requiresSystem.View. - The resource
ClusterComputeResourcereferenced by the property Vcenter TrustedInfrastructure TrustAuthorityHosts Kms FilterSpec.clusters requiresSystem.View.
The type of the returned summary - brief, normal, or full.
For more information see: Vcenter TrustedInfrastructure TrustAuthorityHosts Kms SummaryType.
If missing or null a normal projection will be used.
Return details about Key Provider Services matching the filter.
If missing or null return all registered Key Provider Services.
{
"hosts": [
"string"
],
"clusters": [
"string"
],
"address": [
{
"hostname": "string",
"port": 0
}
],
"groups": [
"string"
]
}This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.
A set of host IDs by which to filter the services.
This property was added in vSphere API 7.0.0.0.
If missing or null, the services will not be filtered by the hosts on which they run.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.
This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.
A set of cluster IDs by which to filter the services.
This property was added in vSphere API 7.0.0.0.
If missing or null, the services will not be filtered by the clusters on which they run.
When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.
This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.
The service's address.
This property was added in vSphere API 7.0.0.0.
If missing or null, the services will not be filtered by address.
This property is deprecated as of vSphere API 8.0.3.0 and removed in vSphere API 9.0.0.0.
The group determines reports issued by which Attestation Service instances this Key Provider Service can accept.
This property was added in vSphere API 7.0.0.0.
If missing or null, the services will not be filtered by groupId.
List of Vcenter TrustedInfrastructure TrustAuthorityHosts Kms Summary of Key Provider Services.
[
"Vcenter TrustedInfrastructure TrustAuthorityHosts Kms Summary Object"
]if the response data will exceed the message limit.
"Vapi Std Errors InvalidArgument Object"if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if there is a generic error.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/vcenter/trusted-infrastructure/trust-authority-hosts/kms?action=query