Retrieves and populates a variable with the value of the specified property of the requested Active Directory object at the provided path. Gets the property of a specific Active Directory object. The property can be specified in subsequent Active Directory operations.
Declaration
<AMGETADPROPERTY LDAPPATH="text" PROPERTYNAME="text" RESULTVARIABLE="text" USERNAME="text" PASSWORD="text"/>
Example
Description: Get Active Directory object property "givenName" and populate variable "PropertyValue" with its value. The object's path is "LDAP://mycompanyname.com/CN=Robin Hood,OU=Development,OU=My Company, Inc. Employees,DC=networkautomation,DC=com".
<AMGETADPROPERTY LDAPPATH="LDAP://mycompanyname.com/CN=Robin Hood,OU=Development,OU=My Company, Inc. Employees,DC=networkautomation,DC=com" USERNAME="username" PASSWORD="AM2PBmJg27fZts7GZqDct982ygZ6IMd3xXZaME" PROPERTYNAME="givenName" RESULTVARIABLE="PropertyValue" />
See Also
AD Object to Dataset, Create AD Group, Create AD Object, Create AD User, Delete AD Object, Get AD Group Members, Get AD Object Path, If AD Object Exists, List AD Object Paths, Modify AD Group, Modify AD User, Move AD Object, Rename AD Object, Set AD Object Property
|
|
In order to properly use AWE's Active Directory actions, you should have a basic understanding of Active Directory and related components (e.g., domain controllers, trust relationships, forests, OUs, LDAPs, etc.) Also, to ensure that these actions function appropriately, the target system must be part of a domain. |
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Path |
Text |
Yes |
(Empty) |
LDAPPATH= "LDAP://DC=netauto,DC=com" |
Specifies the LDAP (Lightweight Directory Access Protocol) path of the Active Directory object to retrieve the property from. Click Select Object to launch a standard Windows Active Directory dialog box that allows for the selection an Active Directory object. Click Select Container to select the parent container from the domain in which to select an Active Directory object from. |
|
Property Name |
Text |
Yes |
(Empty) |
PROPERTYNAME="CommonName" |
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 |
Yes |
(Empty) |
RESULTVARIABLE="varname" |
The AWE variable to be populated with the active directory object's property value. |
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Username |
Text |
No |
(Empty) |
USERNAME="username" |
The username 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 Active Directory actions. |
|
Password |
Text |
No |
(Empty) |
PASSWORD="password" |
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 Active Directory actions. |
The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.
More on setting custom step description
The Error Causes tab properties allow you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.
More on Error Causes properties
The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.
More about On Error properties
All text fields allow the use of expressions such as variables, functions or extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, % Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the percent sign (%) or by pressing F2.
