Get Active Directory Object Property Action

Declaration

<AMGETADPROPERTY LDAPPATH="text" PROPERTYNAME="text" RESULTVARIABLE="text" USERNAME="text" PASSWORD="text"/>

See Also

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

Description

Retrieves and populates an AutoMate variable with the value of the specified property of the requested Active Directory object at the provided path.

Practical Usage

See Description.

Parameters

General Tab

Path

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

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

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

Click the Select Container button to select the parent container from the domain in which to select an Active Directory object from.

Property name

Text, Required
MARKUP: PROPERTYNAME="CommonName"

Specifies the property name of the Active Directory object in which to retrieve its value from (i.e. cn, CommonName, dn, distinguishedName, etc.).

Populate variable with property value

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

Specifies the Automate variable to be populated with the active directory object's property value.

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 about LDAP.

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.

<AMGETADPROPERTY LDAPPATH="LDAP://networkautomation.com/CN=Ronak Patel,OU=Development,OU=Network Automation Employees,DC=networkautomation,DC=com" PROPERTYNAME="givenName" RESULTVARIABLE="PropertyValue" />