REST API - replace_vmca_signed
  1. Operations
  2. vcenter
  3. certificate management
  4. vcenter
  5. tls

vcenter certificate management vcenter tls: replace vmca signed

Replace MACHINE SSL with VMCA signed one with the given Spec.The system will go for restart.

After this operation completes, the services using the certificate will be restarted for the new certificate to take effect.

. This operation was added in vSphere API 6.9.1.

Request:

HTTP request

POST https://{server}/rest/vcenter/certificate-management/vcenter/tls?action=replace-vmca-signed

Request Body Structure:

{
    "spec" : {
        "state_or_province" : "string",
        "country" : "string",
        "email_address" : "string",
        "organization" : "string",
        "locality" : "string",
        "subject_alt_name" : [
            "string",
            "string"
        ],
        "common_name" : "string",
        "key_size" : 1,
        "organization_unit" : "string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec replace_spec The information needed to generate VMCA signed Machine SSL.
spec.key_size long The size of the key to be used for public and private key generation. This attribute was added in vSphere API 6.7.2.

Optional. If unset the key size will be '2048'.
spec.common_name string The common name of the host for which certificate is generated. This attribute was added in vSphere API 6.7.2.

Optional. If unset will default to PNID of host.
spec.organization string Organization field in certificate subject. This attribute was added in vSphere API 6.7.2.
spec.organization_unit string Organization unit field in certificate subject. This attribute was added in vSphere API 6.7.2.
spec.locality string Locality field in certificate subject. This attribute was added in vSphere API 6.7.2.
spec.state_or_province string State field in certificate subject. This attribute was added in vSphere API 6.7.2.
spec.country string Country field in certificate subject. This attribute was added in vSphere API 6.7.2.
spec.email_address string Email field in Certificate extensions. This attribute was added in vSphere API 6.7.2.
spec.subject_alt_name string[] SubjectAltName is list of Dns Names and Ip addresses. This attribute was added in vSphere API 6.7.2.

Optional. If unset PNID of host will be used as IPAddress or Hostname for certificate generation .

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
400 invalid_argument If the Spec given is not complete or invalid
500 error If the system failed to replace the machine ssl certificate