Host Certificate Manager Provision Server Private Key

Provisions a given SSL private key on the server for use with a subsequent SSL certificate installation.

The recommended way to update the server private key is via GenerateCertificateSigningRequest, which ensures that the key never leaves the host.

The current method is intended for use only in environments that have special requirements on how their private keys are generated.

Since: vSphere API Release 8.0.3.0

Required privileges: Certificate.Manage

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostCertificateManager/{moId}/ProvisionServerPrivateKey

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

string

release

Required

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

Request Body

ProvisionServerPrivateKeyRequestType of type(s) application/json

Required

{
    "key": "string"
}

string As password As password

key

Required

SSL private key in PEM format

Authentication

This operation uses the following authentication methods.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

HostConfigFault: if there's a problem with the input key.

Returns HostConfigFault of type(s) application/json

This response body class contains all of the following: VimFault

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

Availability

Added in vSphere API Release 8.0.3.0

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

204 Response Body

Errors

Virtual Infrastructure Operations