vSAN Management API


Data Object - VsanVcKmipServersHealth(vim.cluster.VsanVcKmipServersHealth)

Property of
VsanClusterEncryptionHealthSummary
Extends
DynamicData
See also
LocalizedMethodFault, VsanKmsHealth
Since
6.6

Data Object Description

This class defines KMIP servers connection status on vCenter side. It has detailed KMS connection status, client/servers certificate status and expiration date.

Properties

Name Type Description
clientCertExpireDate*xsd:dateTime

The client certificate expiry date.
clientCertHealth*xsd:string

The client certificate status. If the certificate is expired, the health is "red". If the certificate expires in 30 days, the health is "yellow". Otherwise the certificate health is "green".
cmkHealth*xsd:string

The health status of Customer Master Key (CMK) from AWS KMS. This is only set when using AWS KMS for vSAN encryption.

Since VMC M5
error*LocalizedMethodFault

If error is set, it means there are issues when trying to retrieve Key Management Servers status. The error message will describe the possible issues, such as "Retrieve KMIP servers status timed out".
health*xsd:string

The overall KMIP servers health.
hostKeyExpireDate*xsd:dateTime

Host key expiration date.

Since 8.0.0.3
hostKeyExpireHealth*xsd:string

Host Key expiration state. 'red' means that the host key has expired or is going to expire in very close days(10 days by default), and 'yellow' means that the host key will expire in certain days(30 days by default), and 'green' means that there is still a long time(more than 30 days by default) before the host key expires or the host key will not expire.

Since 8.0.0.3
isAwsKms*xsd:boolean

Whether vSAN encryption is using AWS KMS.

Since VMC M5
kekExpireDate*xsd:dateTime

Key encryption key expiration date.

Since 8.0.0.3
kekExpireHealth*xsd:string

KEK expiration state. 'red' means that the KEK has expired or is going to expire in very close days(10 days by default), and 'yellow' means that the KEK will expire in certain days(30 days by default), and 'green' means that there is still a long time(more than 30 days by default) before the KEK expires or the KEK will not expire.

Since 8.0.0.3
kmsHealth*VsanKmsHealth[]

A list of the KMIP servers health result.
kmsProviderId*xsd:string

The Id of the KMS cluster to use for vSAN Encryption.
Properties inherited from DynamicData
None
*Need not be set
Show WSDL type definition