VsanKmsHealth

VsanKmsHealth
VsanKmsHealth

The class for the vSAN KMS (Key Management Server) information and health check result.

The health check result indicates whether the KMS can be successfully connected.

This structure may be used only with operations rendered under /vsan.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "serverName": "string",
    "health": "string",
    "error": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "trustHealth": "string",
    "certHealth": "string",
    "certExpireDate": "string"
}
string
serverName
Required

KMS server name.

string
health
Required

The KMS connection status.

All of possible values are "green" and "red". If the ESXi host can connect to the KMS and get key from it, the status is "green". Otherwise it is "red" that indicates the ESXi host cannot connect to the KMS.

error
Optional

If error is set, it means there are issues when connecting to the Key Management Server.

The error message will describe the connection issues, such as "User authentication failed to Key Management Server" or "Connection timeout to Key Management Server".

string
trustHealth
Optional

This field indicates whether vCenter could establish trusted connection to KMS.

If vCenter and KMS could trust each other, the health is "green". Otherwise it is "red". It is only set on vCenter side.

string
certHealth
Optional

The server certificate status.

If the certificate is expired, the health is "red". If the certificate will expire within threshold days, the health is "yellow". Otherwise the certificate health is "green". It is only set on vCenter side.

string As date-time As date-time
certExpireDate
Optional

The server certificate expiry date.

It is only set on vCenter side.

Property Of