Get Active Directory Object Path Action

Declaration

<AMGETADOBJECT LDAPPATH="text" ADOBJECT="text [options]" OBJECTNAME="text" RESULTVARIABLE="text" USERNAME="text" PASSWORD="text"/>

See Also

Get AD Object Path-Setting Properties, Get AD Group Members Action, Get AD Object Property Action

Description

Populates a variable with the LDAP (Lightweight Directory Access Protocol) path of the specified Active Directory object (i.e. user, computer, OU, etc.).

Practical Usage

See Description.

Parameters

General Tab

Parent Path

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

Specifies the LDAP (Lightweight Directory Access Protocol) path of the parent Active Directory container. This is usually the top most container or rootDSE path, the root of the directory data tree on a directory server.

Click the Select Container button to launch a standard Windows Active Directory dialog box that allows for the selection an Active Directory parent container in which to retrieve the Active Directory object path from.

Type

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

Specifies the Active Directory object type in which to retrieve the path from.

The available options are:

Name

Text, Required
MARKUP: OBJECTNAME="Scott"

Specifies the name of the Active Directory object in which to retrieve the path from. Wildcards such as * and ? can be used to filter the name. For example, entering S* will filter all Active Directory object names starting with the letter S.

Populate variable with path

Text [variable name], Required
MARKUP: RESULTVARIABLE="varname"

Specifies the Automate variable to be populated with the first object's LDAP path found in the Active Directory matching the name.

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.

<AMGETADOBJECT LDAPPATH="LDAP://OU=Network Automation Employees,DC=networkautomation,DC=com" ADOBJECT="USER" OBJECTNAME="Gi*" RESULTVARIABLE="ObjectPath" />