Esx.Settings.Internal.Notifications.Certificate.TLSCertChange

The Esx.Settings.Internal.Notifications.Certificate.TLSCertChange schema describes the payload of the notifications issued when a change occurs in the vCenter server TLS certificate configuration.

This schema was added in vSphere API 8.0.2.0.

Note: this schema is restricted for VMware internal use only.

JSON Example

{
    "subscription": "string",
    "cert_chain": [
        "string"
    ],
    "certificate_store": "string"
}

string

subscription

Required

The subscription ID.

This property was added in vSphere API 8.0.2.0.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vcenter.certificate_management.vcenter.subscriptions. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vcenter.certificate_management.vcenter.subscriptions.

array of string

cert_chain

Optional

The certChain contains the new vCenter server TLS certificate chain in base64 format.

This property was added in vSphere API 8.0.2.0.

If missing or null the notification is triggered due to changes to the TRUSTED ROOTS and the subscriber will load the TRUSTED ROOTS from the default vCenter server keystore.

string

certificate_store

Required

The type of certificate change that serves as the reason for triggering the notification. The certificate change type corresponds to a certificate store where the change occurred.

Possible values:

TRUSTED_ROOTS_CHANGE: Indicates TRUSTED ROOTS change.
TLS_CERT_CHANGE: Indicates TLS certificate change.

For more information see: Esx.Settings.Internal.Notifications.Certificate.CertChangeType.

This property was added in vSphere API 8.0.2.0.