Scripting Object - VcHostActiveDirectoryAuthentication

Scripting-object corresponding to
HostActiveDirectoryAuthentication

Scripting Object Description

The {@link ActiveDirectoryAuthentication} managed object indicates domain membership status and provides methods for adding a host to and removing a host from a domain.

Attributes

Name Type Description
idString

@since Unknown
infoVcHostAuthenticationStoreInfo

@since vSphere API 4.1
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, disableSmartCardAuthentication, enableSmartCardAuthentication, importCertificateForCAM_Task, installSmartCardTrustAnchor, joinDomain_Task, joinDomainWithCAM_Task, leaveCurrentDomain_Task, listSmartCardTrustAnchors, removeSmartCardTrustAnchor, removeSmartCardTrustAnchorByFingerprint, replaceSmartCardTrustAnchors

removeSmartCardTrustAnchorByFingerprint

Remove a smart card trust anchor certificate from the system by fingerprint. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

leaveCurrentDomain_Task

Removes the host from the Active Directory domain to which it belongs. @since vSphere API 4.1

Parameters

NameTypeDescription
arg0Boolean


Return Value

Type Description
VcTask

listSmartCardTrustAnchors

Lists installed trust anchor certificates for smart card authentication. @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

joinDomainWithCAM_Task

Adds the host to an Active Directory domain through CAM service.

If the {@link AuthenticationStoreInfo}.{@link AuthenticationStoreInfo#enabled} property is True (accessed through the info property), the host has joined a domain. The vSphere API will throw the InvalidState fault if you try to add a host to a domain when the host has already joined a domain. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcTask

disableSmartCardAuthentication

Disables console authentication using a local smart card and reader. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None

enableSmartCardAuthentication

Enables console authentication using a local smart card and reader. To take effect this feature requires an active domain membership to a domain with users configured to authenticate using smart cards. @since vSphere API 6.0

Parameters

NameTypeDescription
None

Return Value

Type Description
None

importCertificateForCAM_Task

Import the CAM server's certificate to the local store of vmwauth.

The certificate should have already been uploaded to ESXi file system. @since vSphere API 5.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
VcTask

installSmartCardTrustAnchor

Install a trust anchor certificate for smart card authentication. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
None

removeSmartCardTrustAnchor

Remove a smart card trust anchor certificate from the system. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1String


Return Value

Type Description
None

joinDomain_Task

Adds the host to an Active Directory domain.

If the {@link AuthenticationStoreInfo}.{@link AuthenticationStoreInfo#enabled} property is True (accessed through the info property), the host has joined a domain. The vSphere API will throw the InvalidState fault if you try to add a host to a domain when the host has already joined a domain. @since vSphere API 4.1

Parameters

NameTypeDescription
arg0String

arg1String

arg2String


Return Value

Type Description
VcTask

replaceSmartCardTrustAnchors

Replace the trust anchor certificates for smart card authentication. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String []


Return Value

Type Description
None