Scripting Object - VcHostAuthenticationManager

Scripting-object corresponding to
HostAuthenticationManager
Attribute of
VcHostConfigManager

Scripting Object Description

The {@link AuthenticationManager} managed object provides access to Active Directory configuration information for an ESX host. It also provides access to methods for adding a host to or removing a host from an Active Directory domain.

The vSphere API supports Microsoft Active Directory management of authentication for ESX hosts. To integrate an ESX host into an Active Directory environment, you use an Active Directory account that has the authority to add a computer to a domain. The ESX Server locates the Active Directory domain controller. When you add a host to a domain, you only need to specify the domain and the account user name and password.

There are two approaches that you can use to add an ESX host to or remove a host from an Active Directory domain.

To take advantage of ESX host membership in an Active Directory domain, grant permissions on the ESX host to Active Directory users and groups who should have direct access to management of the ESX host. Use the {@link vim.UserDirectory}.{@link vim.UserDirectory#retrieveUserGroups} method to obtain information about Active Directory users and groups. After retrieving the Active Directory data, you can use the {@link vim.AuthorizationManager}.{@link vim.AuthorizationManager#setEntityPermissions} method to set the {@link vim.AuthorizationManager.Permission#principal} property to the appropriate user or group.

By default, the ESX host assigns the Administrator role to the "ESX Admins" group. If the group does not exist when the host joins the domain, the host will not assign the role. In this case, you must create the "ESX Admins" group in the Active Directory. The host will periodically check the domain controller for the group and will assign the role when the group exists.

Attributes

Name Type Description
idString

@since Unknown
infoVcHostAuthenticationManagerInfo

@since vSphere API 4.1
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
supportedStoreVcHostAuthenticationStore []

@since vSphere API 4.1
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

_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