Host System Configure Crypto Key

Host System Configure Crypto Key

Sets/changes the key to be used for coredump encryption and puts the host in safe state.

This function will make the host crypto safe and unlock all encrypted VMs on the host. When the encryption on the host is enabled for the first time after adding it to vCenter Server, this method will start sending asynchronously all the encryption keys for VMs on the host and cluster to unlock encrypted VMs. This API behaves differently on the ESXi host vs. the vCenter server. Before vSphere 7.0, it is not supported on host, and invoking directly on a host will throw NotSupported fault. Since vSphere 7.0, calling the API on host will make the host crypto safe, but the parameter should not be blank and should only be a key id from a trusted key provider.

Required privileges: Cryptographer.RegisterHost

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostSystem/{moId}/ConfigureCryptoKey

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

string

release

Required

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

Request Body

ConfigureCryptoKeyRequestType of type(s) application/json

Required

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

keyId

Optional

Data Object representing a cryptographic key.

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

On This Page

Request

Path Parameters

204 Response Body

Host System Operations

Host System Acquire Cim Services Ticket

Host System Configure Crypto Key

Host System Destroy Task

Host System Disconnect Host Task

Host System Enable Crypto

Host System Enter Lockdown Mode

Host System Enter Maintenance Mode Task

Host System Exit Lockdown Mode

Host System Exit Maintenance Mode Task

Host System Get Alarm Actions Enabled

Host System Get Answer File Validation Result

Host System Get Answer File Validation State

Host System Get Available Field

Host System Get Capability

Host System Get Compliance Check Result

Host System Get Compliance Check State

Host System Get Config

Host System Get Config Issue

Host System Get Config Manager

Host System Get Config Status

Host System Get Custom Value

Host System Get Datastore

Host System Get Datastore Browser

Host System Get Declared Alarm State

Host System Get Disabled Method

Host System Get Effective Role

Host System Get Hardware

Host System Get Licensable Resource

Host System Get Name

Host System Get Network

Host System Get Overall Status

Host System Get Parent

Host System Get Permission

Host System Get Precheck Remediation Result

Host System Get Recent Task

Host System Get Remediation Result

Host System Get Remediation State

Host System Get Runtime

Host System Get Summary

Host System Get System Resources

Host System Get Tag

Host System Get Triggered Alarm State

Host System Get Value

Host System Get Vm

Host System Power Down Host To Stand By Task

Host System Power Up Host From Stand By Task

Host System Prepare Crypto

Host System Query Host Connection Info

Host System Query Memory Overhead

Host System Query Memory Overhead Ex

Host System Query Product Locker Location

Host System Query Tpm Attestation Report

Host System Reboot Host Task

Host System Reconfigure Host For DAS Task

Host System Reconnect Host Task

Host System Reload

Host System Rename Task

Host System Retrieve Free Epc Memory

Host System Retrieve Hardware Uptime

Host System Set Custom Value

Host System Shutdown Host Task

Host System Update Flags

Host System Update Ipmi

Host System Update Product Locker Location Task

Host System Update System Resources

Host System Update System Swap Configuration