Get KMS Providers
Return information about a provider. if you do not have all of the privileges described as follows: - Operation execution requires Cryptographer.ReadKeyServersInfo.
Request
URLURL
https://{api_host}/api/vcenter/crypto-manager/kms/providers/{provider}
Path Parameters
Path Parameters
string
provider
Required
Identifier of the provider. The parameter must be an identifier for the resource type: com.vmware.vcenter.crypto_manager.kms.provider.
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
CryptoManagerKmsProvidersInfo
of type application/json
Information of the provider.
{
"constraints": {
"tpm_required": false
},
"details": [
{
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
}
],
"health": "NONE",
"native_info": {
"key_id": "string"
},
"type": "NATIVE"
}
array of
StdLocalizableMessage
details
Required
Details regarding the health status of the provider. When the provider Providers.Health is not NONE or OK, this field will provide actionable descriptions of the issues.
health
Required
The Providers.Health enumerated type describes 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
type
Required
The Providers.Type enumerated type contains the types of providers.
NATIVE : Native provider
Possible values are: NATIVE
constraints
Optional
The constraints on the provider. If unset, there are no constraints on the provider.
native_info
Optional
Native provider information This field is optional and it is only relevant when the value of Providers.Info.type is NATIVE.
Errors
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/kms/providers/{provider}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: get
Availability
Added in 7.0.2.0
On This Page
KMS Providers Operations
post
patch
delete
post
