Scripting Object - VcHostCertificateManager

Scripting-object corresponding to
HostCertificateManager
Attribute of
VcHostConfigManager

Scripting Object Description

CertificateManager provides an interface for managing the SSL certificates used by the server.

Attributes

Name Type Description
certificateInfoVcHostCertificateManagerCertificateInfo

@since vSphere API 6.0
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, generateCertificateSigningRequest, generateCertificateSigningRequestByDn, installServerCertificate, listCACertificateRevocationLists, listCACertificates, notifyAffectedServices, replaceCACertificatesAndCRLs

generateCertificateSigningRequest

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 {@link vim.host.CertificateManager#installServerCertificate} to install this certificate. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0Boolean


Return Value

Type Description
String

listCACertificateRevocationLists

Fetches the SSL CRLs of Certificate Authorities that are trusted. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
String []

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

replaceCACertificatesAndCRLs

Replaces the trusted Certificate Authority (CA) certificates and Certification Revocation List (CRL) used by the server with the provided values. These determine whether the server can verify the identity of an external entity. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []

arg1String []


Return Value

Type Description
None

installServerCertificate

Installs a given SSL certificate on the server. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

listCACertificates

Fetches the SSL certificates of Certificate Authorities that are trusted. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
String []

notifyAffectedServices

Instructs the host services affected by SSL credential changes to take into account said changes now. Please note, that depending on the assertiveness of the notification scheme employed by the host, old SSL connections might survive the transition and continue using old SSL credentials. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None

generateCertificateSigningRequestByDn

Requests the server to generate a certificate-signing request (CSR) for itself. Alternative version similar to {@link vim.host.CertificateManager#generateCertificateSigningRequest} but takes a Distinguished Name (DN) as a parameter. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
String