Active Directory Object to Dataset Action

Declaration

<AMCREATEADPROPERTYDATASET LDAPPATH="text" RESULTDATASET="text [dataset name]"  USERNAME="text" PASSWORD="text"/>

See Also

AD Object to Dataset-Setting Properties, Loop Dataset Action, Create AD Object Action, Get AD Object Path Action, Get AD Object Property Action

Description

Creates a dataset that contains all the properties of the specified Active Directory object (i.e. user, group, computer, etc.). Each property of the object becomes a column of the dataset, with the first row value containing the property value.

Practical Usage

See Description.

Parameters

General Tab

LDAP Path

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

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

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.

Create and Populate Dataset

Text [dataset name], Required
MARKUP: RESULTDATASET="theDatasetName"

Specifies the name of the dataset to be created which will be populated with the Active Directory object's Property Name and Property Value.

A dataset is a multiple column, multiple row container object. This action creates and populates a dataset with the following fields (rows):

|--PropertyName: Contains the Active Directory Object's Property Name.

|--PropertyValue: Contains 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.

<AMCREATEADPROPERTYDATASET LDAPPATH="LDAP://OU=TestCases,DC=networkautomation,DC=com" USERNAME="username" PASSWORD="AM1IF7xpKmRbb4TsXHKwUmUVw==aME" RESULTDATASET="theDataset" />