List Hosts KMS Providers
List the available providers on a host. if you do not have all of the privileges described as follows: - The resource HostSystem referenced by the parameter host requires Cryptographer.ReadKeyServersInfo.
Request
URLURL
https://{api_host}/api/vcenter/crypto-manager/hosts/{host}/kms/providers
Path Parameters
Path Parameters
string
host
Required
Host identifier. The parameter must be an identifier for the resource type: HostSystem.
Query Parameters
Query Parameters
array of
CryptoManagerHostsKmsProvidersHealth
health
Optional
Provider health status. If unset or empty, the result will not be filtered by provider health status.
array of
string
providers
Optional
Provider identifiers. If unset or empty, the result will not be filtered by provider identifier. When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.vcenter.crypto_manager.kms.provider. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.
array of
CryptoManagerHostsKmsProvidersType
types
Optional
Provider types. If unset or empty, the result will not be filtered by provider type.
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
array of
CryptoManagerHostsKmsProvidersSummary of type application/json
Summary of providers.
[
{
"health": "NONE",
"provider": "string",
"type": "NATIVE"
}
]
health
Required
The Providers.Health enumerated type contains the health status of a provider.
NONE : No health status is available.
OK : Operating normally.
WARNING : Operating normally, but there is an issue that requires attention.
ERROR : There is a critical issue that requires attention.
Possible values are: NONE , OK , WARNING , ERROR
string
provider
Required
Identifier of the provider When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.
type
Required
The Providers.Type enumerated type contains the types of providers.
NATIVE : Native provider
TRUST_AUTHORITY : Trust Authority provider
Possible values are: NATIVE , TRUST_AUTHORITY
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the host identifier is empty or the FilterSpec is invalid.
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/crypto-manager/hosts/{host}/kms/providers
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
Availability
Added in 7.0.2.0
