Crypto Manager Host KMS Crypto Manager Host Enable

Begin core dump encryption by specifying the encryption key and put the host in safe state Note: CryptoManagerHostPrepare must be called first

Required privileges: Cryptographer.RegisterHost

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/CryptoManagerHostKMS/{moId}/CryptoManagerHostEnable

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 CryptoManagerHostKMS/{moId}.

string

release

Required

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

Request Body

CryptoManagerHostEnableRequestType of type(s) application/json

Required

Show optional properties

{
    "initialKey": {
        "keyId": {
            "keyId": "string"
        },
        "algorithm": "string",
        "keyData": "string"
    }
}

{
    "initialKey": {
        "_typeName": "string",
        "keyId": {
            "_typeName": "string",
            "keyId": "string",
            "providerId": {
                "_typeName": "string",
                "id": "string"
            }
        },
        "algorithm": "string",
        "keyData": "string"
    }
}

CryptoKeyPlain

initialKey

Required

Data Object representing a plain text cryptographic key.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidState: if the host is in incapable state

AlreadyExists: if the host is in safe state and initialKey differs from the existing core dump encryption key

Returns VimFault of type(s) application/json

This response body class contains all of the following: MethodFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations

POST

Crypto Manager Host KMS Add Key