Crypto Manager Kmip Register Kmip Server

Required privileges: Cryptographer.ManageKeyServers

Request

URI

POST

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

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 9.1.0.0 APIs.

Request Body

RegisterKmipServerRequestType of type(s) application/json

Required

Show optional properties

{
    "server": {}
}

{
    "server": {
        "_typeName": "string",
        "clusterId": {
            "_typeName": "string",
            "id": "string"
        },
        "info": {
            "_typeName": "string",
            "name": "string",
            "address": "string",
            "port": 0,
            "proxyAddress": "string",
            "proxyPort": 0,
            "reconnect": 0,
            "protocol": "string",
            "nbio": 0,
            "timeout": 0,
            "userName": "string"
        },
        "password": "string",
        "defaultKeyType": "string",
        "keySpec": {
            "_typeName": "string"
        }
    }
}

server

Required

[in] KMIP server connection information. When register a new KMIP server to the key provider, the KmipServerSpec.defaultKeyType and KmipServerSpecWrappingKeyIdKeySpec must match existing servers.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"server":"{}"}' https://{api_host}/sdk/vim25/{release}/CryptoManagerKmip/{moId}/RegisterKmipServer

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Virtual Infrastructure Operations