Active Directory - Get Object Dataset

 

Declaration

<AMCREATEADPROPERTYDATASET LDAPPATH="text" USERNAME="text" PASSWORD="text" RESULTDATASET="text" />

See Also

AD Object to Dataset | Create AD Object | Create AD User | Delete AD Object | Get AD Group Members | Get AD Object Path | Get AD Object Property | List AD Object Paths | Modify AD Group | Modify AD User | Move AD Object | Rename AD Object | Set AD Object Property

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 containing the property value. A Loop Dataset action can be used in subsequent steps to loop through the properties.

IMPORTANT: In order to properly use AutoMate'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.

Practical Usage

Used to retrieve the properties of a specific Active Directory object.

Parameters

General Properties

Property

Type

Req'd

Default

Markup

Description

LDAP Path

Text

Yes

(Empty)

LDAPPATH=

LDAP://DC=netauto,DC=com"

The Lightweight Directory Access Protocol (LDAP) path of the Active Directory object to retrieve. The LDAP is an application protocol for querying and modifying data of directory services implemented in IP networks.

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

Yes

(Empty)

RESULTDATASET="theDataset"

The name of the dataset to be created which will be populated with the Active Directory object's Property Name and Property Value. More on the field names that this dataset creates can be found below under Additional Notes.

Credentials Properties

Property

Type

Req'd

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 AutoMate Active Directory actions.

Password

Text

No

(Empty)

PASSWORD="encrypted"

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.

Description Properties

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

Error Causes Properties

The Error Causes tab properties allows 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

On Error 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

Additional Notes

Datasets

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

Name

Type

Return Value

theDataset.PropertyName

Number

Returns the Active Directory Object's Property Name.

theDataset.PropertyValue

Number

Returns the Active Directory Object's Property Value.

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.

 

Description: Get properties of Active Directory object at ""LDAP://OU=MyCompany,DC=mycompany,DC=com"" and create and populate dataset "theDataset" with the properties.

 

<AMCREATEADPROPERTYDATASET LDAPPATH="&quot;LDAP://OU=MyCompany,DC=mycompany,DC=com&quot;" USERNAME="theUserName" PASSWORD="AM2PBmOg3vfcdsoGZuDe99x2z8ZjoN532bbKBnogx3fFdk=aME" RESULTDATASET="theDataset" />

 

↑ [Top of Page]