Get AD Group Members Action

Declaration

<AMGETGROUPMEMBERS GROUP="text" RESULTDATASET="text" USERNAME="text" PASSWORD="text"/>

See Also

Create AD Group-Setting Properties, Get AD Object Path Action, Get AD Object Property Action, Loop Dataset Action

Description

Retrieves all members of a specific Active Directory Group and populates a dataset with the results.

Practical Usage

Allows an administrator to retrieve and view all members of a particular Active Directory Group. Along with a Loop Dataset action, subsequent Active Directory actions can be performed to rename, modify or delete one or more members.

Parameters

General Tab

LDAP Path

Text, Required
MARKUP: GROUP="LDAP://DC=networkautomation,DC=com"

Specifies the LDAP (Lightweight Directory Access Protocol) path of the Active Directory object to retrieve.

Click the Select Group button to launch a standard Windows Active Directory dialog box that allows for the selection an Active Directory group.

Populate dataset with group members

Specifies the name of the dataset in which to populate the members of the chosen Active Directory group.

A dataset is a multiple column, multiple row container object. This action creates and populates a dataset with the following fields (rows):

|--MemberName: Contain's the Active Directory group member's username.

|--LDAPPath: Contain's the Active Directory group member's LDAP path.

 

Credentials Tab

Username

Text, Optional
MARKUP: USERNAME="username"

Specifies the username of the Active Directory user.

Password

Text, Optional
MARKUP: PASSWORD="password"

Specifies the password of the Active Directory user.

NOTE: Leave the Username and Password fields blank in order to use the logon user's credentials. If only accessing Active Directory information, then any Domain user is valid. However, a Domain Administrator is required in order to modify an Active Directory user or group. We recommend using the credentials of a Domain Administrator for all AutoMate Active Directory actions.

See the following link for more information.

http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol

 

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

NOTE: The code below can be copied and pasted directly into the Steps pane of the Task Builder.

<AMGETGROUPMEMBERS GROUP="LDAP://OU=TestCases,DC=networkautomation,DC=com" RESULTDATASET="theDataset" USERNAME="username" PASSWORD="password"/>