Cluster Compute Resource Set Crypto Mode

Set the desired encryption mode and host key for the cluster.

The cryptoMode parameter can be used to set crypto mode policy for the cluster.

The desired host key of the cluster can also be specified optionally using the policy parameter.

Required privileges: Cryptographer.RegisterHost

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ClusterComputeResource/{moId}/SetCryptoMode

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

string

release

Required

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

Request Body

SetCryptoModeRequestType of type(s) application/json

Required

Show optional properties

{
    "cryptoMode": "string"
}

{
    "cryptoMode": "string",
    "policy": {
        "_typeName": "string",
        "keyId": {
            "_typeName": "string",
            "keyId": "string",
            "providerId": {
                "_typeName": "string",
                "id": "string"
            }
        },
        "providerId": {
            "_typeName": "string",
            "id": "string"
        }
    }
}

string

cryptoMode

Required

The encryption mode for the cluster. See ClusterCryptoConfigInfoCryptoModeEnum for supported values. An empty string is treated as a valid input and will be interpreted as onDemand.

ClusterComputeResourceCryptoModePolicy

policy

Optional

The encryption mode policy for a cluster.

Since: vSphere API Release 8.0.3.0

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidRequest: if the interface is not implemented.

InvalidArgument: if one of the parameters is invalid.

Returns RuntimeFault 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

Cluster Compute Resource Abandon Hci Workflow