List Active Directory Object Paths Action

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"/>

See Also

List AD Object Paths-Setting Properties, If Active Directory Object Exists, Get AD Object Path Action,

 

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.

Practical Usage

See Description.

Parameters

General Tab

Get Active Directory Using

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

Specifies the manner in which to retrieve the Active Directory object's LDAP (Lightweight Directory Access Protocol) paths.

The available options are:

Parent Path

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

Specifies the LDAP path of the parent Active Directory object. Usually the top most container or rootdse path.

Click the Select Container button to select the parent container from the domain. When doing so, this launches a standard Windows Active Directory dialog box that allows for selection of the container.

NOTE: The Parent Path parameter is available only if Simple Filter or Custom Filter is selected from the Get Active Directory Using parameter.

Object

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

Specifies the type of object in which to retrieve its path from.

The available options are:

Filter

Text, Required
MARKUP: FILTER="R*"

Provides the filter string to search for specific Active Directory objects.

Custom Filter

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

Allows you to enter custom filter string.

NOTE: This parameter is available only if the Custom Filter option is selected from the Get Active Directory Using parameter.

Query statement (SQL or LDAP syntax)

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

Allows you to enter a SQL or LDAP ADO query string.

NOTE: This parameter is available only if the ADO Query (SQL or LDAP syntax) option is selected from the Get Active Directory Using parameter.

For more details regarding ADO Query, refer to http://technet.microsoft.com/en-us/library/aa996205.aspx.

Create and popluates dataset with Paths

Text, Required
MARKUP: RESULTDATASET="ADObjects"

Specifies the name of a dataset in which the result will be populated.

Credentials Tab

Username

Text, Optional
MARKUP: USERNAME="username"

Specifies the name 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.

<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" />