Data Object - KmipClusterInfo(vim.encryption.KmipClusterInfo)

Property of: CryptoManagerKmip
Parameter to: RetrieveKmipServersStatus_Task
Returned by: ListKmipServers, ListKmsClusters
Extends: DynamicData
See also: KeyProviderId, KmipServerInfo, ManagedEntity
Since: vSphere API Release 6.5

Data Object Description

Data Object representing a cluster of KMIP servers. All servers in a cluster must provide the same keys.

Properties

Name	Type	Description
clusterId	KeyProviderId	Globally unique ID for the servers providing the same keys. All KMIP servers with the same clusterId are in a cluster and all must provide the same keys for redundancy.
hasBackup*	xsd:boolean	*Since* vSphere API Release 7.0.2.0
keyId*	xsd:string	*Since* vSphere API Release 7.0.2.0
managementType*	xsd:string	Key provider management type. See KmsManagementType for valid values. *Since* vSphere API Release 7.0
servers*	KmipServerInfo[]	Servers in this cluster.
tpmRequired*	xsd:boolean	*Since* vSphere API Release 7.0.2.0
useAsDefault	xsd:boolean	Use this cluster as default for system wide, when the optional CryptoKeyId.providerId is not set.
useAsEntityDefault*	ManagedObjectReference[] to a ManagedEntity[]	Use this cluster as default for the managed entities, when the optional CryptoKeyId.providerId is not set. See SetDefaultKmsCluster for supported managed entity type. *Since* vSphere API Release 7.0
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition

         <complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="KmipClusterInfo">
            <complexContent>
               <extension base="vim25:DynamicData">
                  <sequence>
                     <element name="clusterId" type="vim25:KeyProviderId"/>
                     <element name="servers" type="vim25:KmipServerInfo" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="useAsDefault" type="xsd:boolean"/>
                     <element name="managementType" type="xsd:string" minOccurs="0"/>
                     <element name="useAsEntityDefault" type="vim25:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/>
                     <element name="hasBackup" type="xsd:boolean" minOccurs="0"/>
                     <element name="tpmRequired" type="xsd:boolean" minOccurs="0"/>
                     <element name="keyId" type="xsd:string" minOccurs="0"/>
                  </sequence>
               </extension>
            </complexContent>
         </complexType>

vSphere Web Services API

Data Object - KmipClusterInfo(vim.encryption.KmipClusterInfo)

Data Object Description