Crypto Manager Kmip Get Default Kms Cluster

Get the default KMS cluster of the specified managed entity.

Required privileges: Cryptographer.ManageKeyServers

Request

URI

POST

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

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

GetDefaultKmsClusterRequestType of type(s) application/json

Required

{
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "defaultsToParent": false
}

MoRefManagedEntity

entity

Optional

Reference to an instance of the ManagedEntity managed object.

boolean

defaultsToParent

Optional

[in] (Optional, default = false) If set to true, then get the default kms cluster follow the entity hierarchy. That means if the entity has no default kms cluster, then try to get from its parent.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The default kms cluster of the entity, if any.

Returns KeyProviderId of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "id": "string"
}

string

Required

Globally unique ID for the crypto key provider.

Servers with the same ID must provide the same keys. Cannot be empty.

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Virtual Infrastructure Operations