Description

Retrieves a list of the paths of all the Active Directory objects (e.g. computers, users, groups, etc.) at and below the specified path. These paths are then placed into the specified dataset. Results can be filtered by object type and/or a filter string.

Declaration

<AMGETADOBJECTSLIST GETADOBJECTSUSING="text [options]" LDAPPATH="text" ADOBJECT="text" OBJECT "text [options]" FILTER="text" CUSTOM FILTER="text" QUERY="text" RESULTDATASET="text" USERNAME="text" PASSWORD="text"/>

Example

<AMGETADOBJECTSLIST GETADOBJECTSUSING="CUSTOMFILTER" LDAPPATH="LDAP://servtest.com" CUSTOMFILTER="(&amp; (objectCategory=user) (name=*) )" RESULTDATASET="ADObjects" USERNAME="administrator" PASSWORD="password" />

<AMGETADOBJECTSLIST GETADOBJECTSUSING="ADOQUERY" QUERY="SELECT ADsPath FROM 'LDAP://networkautomation.com' WHERE objectCategory='organizationalUnit'" RESULTDATASET="ADObjects" />

<AMGETADOBJECTSLIST GETADOBJECTSUSING="ADOQUERY" QUERY="SELECT ADsPath FROM 'LDAP://servtest.com' WHERE objectCategory='user'" RESULTDATASET="ADObjects" USERNAME="ronak@servtest.com" PASSWORD="password" />

<AMGETADOBJECTSLIST GETADOBJECTSUSING="ADOQUERY" QUERY="&lt;LDAP://servtest.com&gt;; (objectCategory=user); ADsPath;subtree" RESULTDATASET="ADObjects" USERNAME="ronak@servtest.com" PASSWORD="password" />

General Tab Parameters

Get Active Directory Using: Specify the way you want to get the active directory object LDAP paths. The available options are:

• SIMPLEFILTER - selects the active directory objects using simple filter.

• CUSTOMFILTER - selects the active directory objects using more advance custom filter.

• ADOQUERY -     selects the active directory objects using more advance sql or LDAP query.

Note: Only Available for Simple filter and custom filter.

Text [options], Optional - Default "Simplefilter"
MARKUP: ACTION="CUSTOMFILTER"

Parent Path: Allows you to enter the LDAP path of the parent active directory object. Usually the top most container or rootdse path.

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

• Click Select Container to select the parent container from the domain. You can also select objects like user, computer, group, contacts by clicking on select objects. Note: only available for simple filter.

Object: Specify the type of object you are looking for. The available options are:

• User

• Computer

• Group

• OrganizationUnit

• Printer

Text [options], Optional - Default "User"
MARKUP: ADOBJECT="GROUP

Filter: Provides the filter string to search for specific active directory objects. Note: only available for custom filter.

Text, Required
MARKUP: FILTER="R*"

Custom Filter: Allows you to enter custom filter string. Note: only available for ADO query.

Text, Required
MARKUP : CUSTOMFILTER="(&amp; (objectCategory=user) (name=*) )"

Query statement (SQL or LDAP syntax): Allows you to enter a SQL or LDAP ADO query string.

Text, Required
MARKUP: QUERY="SELECT ADsPath FROM 'LDAP://networkautomation.com' WHERE objectCategory='organizationalUnit'"

Note: For information about LDAP queries, refer to: http://technet.microsoft.com/en-us/library/aa996205.aspx

Create and popluates dataset with Paths: Provides the dataset in which the result will be populated.

Text, Required
MARKUP: RESULTDATASET="ADObjects"

Credentials Tab Parameters

Username: Allows you to enter the name of the active directory user.

Text, Optional
MARKUP: USERNAME="username"

Password: Allows you to enter the password of the active directory user.

Text, Optional
MARKUP: PASSWORD="password"

Note: Leave these fields blank if you want to use current user's credentials. If you are trying to access the active directory information, then any Domain user is valid but in order to modify the user or group you need Domain Administrator. We recommend you use domain administrator for all the active directory actions.

Note: If you are using Query to get list of active directory objects, a username is required to connect to domain. Provide username in this format: username@domain. Refer to the following link for more information about LDAP: http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol

See Also

If Active Directory Object Exists