Data Object - VsanKmsHealth(vim.host.VsanKmsHealth)

Property of: VsanEncryptionHealthSummary, VsanVcKmipServersHealth
Extends: DynamicData
See also: LocalizedMethodFault
Since: 6.6

Data Object Description

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.

Properties

Name	Type	Description
certExpireDate*	xsd:dateTime	The server certificate expiry date. It is only set on vCenter side.
certHealth*	xsd:string	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.
error*	LocalizedMethodFault	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".
health	xsd:string	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.
serverName	xsd:string	KMS server name.
trustHealth*	xsd:string	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.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanKmsHealth">
            <complexContent>
               <extension base="vsan:DynamicData">
                  <sequence>
                     <element name="serverName" type="xsd:string"/>
                     <element name="health" type="xsd:string"/>
                     <element name="error" type="vsan:LocalizedMethodFault" minOccurs="0"/>
                     <element name="trustHealth" type="xsd:string" minOccurs="0"/>
                     <element name="certHealth" type="xsd:string" minOccurs="0"/>
                     <element name="certExpireDate" type="xsd:dateTime" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSAN Management API

Data Object - VsanKmsHealth(vim.host.VsanKmsHealth)

Data Object Description