KmipClusterInfo

KmipClusterInfo
KmipClusterInfo

Data Object representing a cluster of KMIP servers.

All servers in a cluster must provide the same keys.

AllOf
This class requires all of the following:
JSON Example
{
    "_typeName": "string",
    "clusterId": {
        "_typeName": "string",
        "id": "string"
    },
    "servers": [
        {
            "_typeName": "string",
            "name": "string",
            "address": "string",
            "port": 0,
            "proxyAddress": "string",
            "proxyPort": 0,
            "reconnect": 0,
            "protocol": "string",
            "nbio": 0,
            "timeout": 0,
            "userName": "string"
        }
    ],
    "useAsDefault": false,
    "managementType": "string",
    "useAsEntityDefault": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "hasBackup": false,
    "tpmRequired": false,
    "keyId": "string",
    "defaultKeyType": "string",
    "keyInfo": {
        "_typeName": "string"
    }
}
clusterId
Required

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.

servers
Optional

Servers in this cluster.

boolean
useAsDefault
Required

Use this cluster as default for system wide, when the optional CryptoKeyId.providerId is not set.

string
managementType
Optional

Key provider management type.

See KmipClusterInfoKmsManagementTypeEnum for valid values.

useAsEntityDefault
Optional

Use this cluster as default for the managed entities, when the optional CryptoKeyId.providerId is not set.

See CryptoManagerKmip.SetDefaultKmsCluster for supported managed entity type.

boolean
hasBackup
Optional

Since: vSphere API Release 7.0.2.0

boolean
tpmRequired
Optional

Since: vSphere API Release 7.0.2.0

string
keyId
Optional

Since: vSphere API Release 7.0.2.0

string
defaultKeyType
Optional

Key type which the key provider generates by default.

See KmipClusterInfoKeyTypeEnum for supported values.

Since: vSphere API Release 9.0.0.0

keyInfo
Optional

Key information.

Since: vSphere API Release 9.0.0.0