Scripting Object - VcUserDirectory

Scripting-object corresponding to
UserDirectory
Attribute of
VcHostConfigManager, VcSdkConnection, VcServiceContent

Scripting Object Description

The {@link UserDirectory} managed object provides information about users and groups on a vSphere server and ESX hosts. The method {@link UserDirectory#retrieveUserGroups} returns a list of user account data. The method can perform a search operation based on specific criteria - user name, group name, sub-string or string matching, and, on Windows, domain. Use the results as input to the AuthorizationManager methods {@link vim.AuthorizationManager#setEntityPermissions} and {@link vim.AuthorizationManager#resetEntityPermissions}.

The content of the returned results depends on the server environment:

Attributes

Name Type Description
domainListString []

@since VI API 2.5
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, checkGroupMembership, createTrigger, retrieveUserGroups

_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

checkGroupMembership

Check whether a user is a member of a given list of groups. Given a logged-in user name and a list of groups, report whether the user is a member of any of the named groups.

If a group name cannot be found, it will be ignored and the result will be 'false' for that group. Therefore, as long as the referenced user is logged in, this method will always succeed in returning a result. @since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String []


Return Value

Type Description
Boolean []

retrieveUserGroups

Returns a list of {@link vim.UserSearchResult} objects describing the users and groups defined for the server.

You must hold the Authorization.ModifyPermissions privilege to invoke this method. If you hold the privilege on any ManagedEntity, you will have access to user and group information for the server.

@since VI API 2.5

Parameters

NameTypeDescription
arg0String

arg1String

arg2String

arg3String

arg4Boolean

arg5Boolean

arg6Boolean


Return Value

Type Description
VcUserSearchResult []