Host Certificate Manager Generate Certificate Signing Request

Host Certificate Manager Generate Certificate Signing Request

Requests the server to generate a certificate-signing request (CSR) for itself.

The CSR is then typically provided to a Certificate Authority to sign and issue the SSL certificate for the server. Use InstallServerCertificate to install this certificate.

Required privileges: Certificate.Manage

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostCertificateManager/{moId}/GenerateCertificateSigningRequest
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
GenerateCertificateSigningRequestRequestType of type(s) application/json
Required 
"GenerateCertificateSigningRequestRequestType Object"
boolean
useIpAddressAsCommonName
Required

if true, use host's management IP address as CN in the CSR; otherwise use host's FQDN.

object
spec
Optional

Represents certificate specification used for identifying a specific certificate supported by Host.

Since: vSphere API Release 8.0.1.0

Authentication
This operation uses the following authentication methods.
Responses
200

CSR in PEM format

Returns string of type(s) application/json
Operation doesn't return any data structure

500

HostConfigFault: if there's a problem generating the CSR.

Returns HostConfigFault of type(s) application/json 
"HostConfigFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/HostCertificateManager/{moId}/GenerateCertificateSigningRequest
On This Page
Virtual Infrastructure Operations
POST
Host Certificate Manager Generate Certificate Signing Request
POST
Host Certificate Manager Generate Certificate Signing Request By Dn
POST
Host Certificate Manager Install Server Certificate
POST
Host Certificate Manager List CA Certificate Revocation Lists
POST
Host Certificate Manager List CA Certificates
POST
Host Certificate Manager Notify Affected Services
POST
Host Certificate Manager Provision Server Private Key
POST
Host Certificate Manager Replace CA Certificates And CR Ls
POST
Host Certificate Manager Retrieve Certificate Info List
GET
Host Certificate Manager Get Certificate Info