Crypto Manager Kmip List Kms Clusters

List the KMS clusters information.

Required privileges: Cryptographer.ManageKeyServers

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/CryptoManagerKmip/{moId}/ListKmsClusters

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case CryptoManagerKmip/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

ListKmsClustersRequestType of type(s) application/json

Required

{
    "includeKmsServers": false,
    "managementTypeFilter": 0,
    "statusFilter": 0
}

boolean

includeKmsServers

Optional

[in] Whether to list KMS servers information in the cluster. By default will not include the KMS servers information.

integer As int32 As int32

managementTypeFilter

Optional

[in] The KMS cluster management type filter. Bit map values: 0x01 - Return VC managed Key Providers registered in the CryptoManager. 0x02 - Return Trusted Key Providers registered in the CryptoManager. 0x04 - Return Trusted Key Providers which are not registered with the CryptoManager. 0x08 - Return Native Key Providers. others - reserved, will be ignored If omitted or -1, then all kinds of Key Providers will be returned.

integer As int32 As int32

statusFilter

Optional

[in] The Key Provider status filter. Bit map values: 0x01 - Return active Key Providers. 0x02 - Return inactive Key Providers. others - reserved, will be ignored If omitted or -1, then all status of Key Providers will be returned.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

List of Key Providers.

Returns Array of KmipClusterInfo of type(s) application/json

[
    {
        "_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"
    }
]

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations