Active Directory - List object path

Declaration

<AMACTIVEDIRECTORY ACTIVITY="list_object_path" 
AUTHTYPE="text (options)" 
USERNAME="text" 
PASSWORD="text (encrypted)" 
LDAPPATH="text" 
ADOBJECT="text (options)" 
FILTER="text" 
RESULTDATASET="text" />

Description: Retrieves a list of the paths for all Active Directory objects (e.g., computers, users, groups, etc.) at and below the specified path and populates a dataset with resulting values. Results can be filtered by object type and/or a filter string.

Active Directory activities require a basic understanding of Active Directory and related components (e.g., Domain Controllers, Trust Relationships, Forests, LDAPs, etc.). Also, to ensure that these activities function appropriately, the target system must be part of a domain.

Practical Usage

Can be used along with other Active Directory activities to create a report with essential information on Active Directory infrastructure and objects. Reports can be created for management, distribution and/or auditing purposes.

Object Parameters

Property

Type

Required

Default

Markup

Description

Get Active Directory using

Text (options)

No

Simple Filter

ACTION="CUSTOMFILTER"

The manner in which to retrieve the Active Directory object's LDAP (Lightweight Directory Access Protocol) paths. The available options are:

  • Simple Filter (Default): Selects the Active Directory objects using simple filter.

  • Custom Filter: Selects the Active Directory objects using more advance custom filter.

  • ADO Query (SQL or LDAP syntax): Selects the Active Directory objects using more advanced SQL or LDAP query.

Parent path

Text

Yes

(Empty)

LDAPPATH=

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

The LDAP path of the parent Active Directory object. Usually the top most container or rootdse path.

Click the Select Container button to select the parent container from the domain. When doing so, this launches a standard Windows Active Directory dialog box that allows for selection of the container.

Note: The Parent Path parameter is available only if Simple Filter or Custom Filter is selected from the Get Active Directory Using parameter.

Object

Text (options)

No

User

ADOBJECT="GROUP

The type of object in which to retrieve its path from. The available options are:

  • User (default) - List User object path.

  • Computer - List Computer object path.

  • Group - List Group object path.

  • OrganizationUnit - List Organizational Unit object path.

  • Printer - List Printer object path.

Filter

Text

Yes

(Empty)

FILTER="R*"

Provides the filter string to search for specific Active Directory objects.

Custom filter

Text

Yes

(Empty)

CUSTOMFILTER=

"(&amp; (objectCategory=user)(name=*))"

Allows entry of a custom filter string. This parameter is available only if the Get Active Directory using parameter is set to Custom Filter.  

Query statement (SQL or LDAP syntax)

Text

Yes

(Empty)

QUERY="SELECT ADsPath

FROM 'LDAP://networkautomation.com'

WHERE objectCategory='organizationalUnit'"

Allows entry of a SQL or LDAP ADO query string. This parameter is available only if the Get Active Directory Using parameter is set to ADO Query (SQL or LDAP syntax). For more details regarding ADO Query, refer to: http://technet.microsoft.com/en-us/library/aa996205.aspx.

Create and populate dataset with paths

Text

Yes

(Empty)

RESULTDATASET="ADObjects"

The name of a dataset in which to create and populate with the results. For more details, see Datasets below.

Credentials Parameters

Property

Type

Required

Default

Markup

Description

Authentication type

Text (options)

No

Default

AUTHTYPE="Encryption"

Specifies the types of authentication used. The available options are:

  • Default - Use default authentication type.

  • None - Equates to zero, which means to use basic authentication (simple bind) in the LDAP provider.

  • Secure - Requests secure authentication. When this flag is set, the WinNT provider uses NTLM to authenticate the client.

  • Encryption - Attaches a cryptographic signature to the message that both identifies the sender and ensures that the message has not been modified in transit.

  • SecureSocketLayer - Attaches a cryptographic signature to the message that both identifies the sender and ensures that the message has not been modified in transit.

  • ReadonlyServer - For a WinNT provider, ADSI tries to connect to a domain controller. For Active Directory Domain Services, this flag indicates that a writable server is not required for a serverless binding.

  • Anonymous - No authentication is performed.

  • FastBind - Specifies that ADSI will not attempt to query the Active Directory Domain Services objectClass property. Therefore, only the base interfaces that are supported by all ADSI objects will be exposed. Other interfaces that the object supports will not be available.

  • Signing - Verifies data i ntegrity to ensure that the data received is the same as the data sent. The Secure flag must also be set to use signing.

  • Sealing - Encrypts data using Kerberos. The Secure flag must also be set to use sealing.

  • Delegation - Enables Active Directory Services Interface (ADSI) to delegate the user's security context, which is necessary for moving objects across domains.

  • ServerBind - If your ADsPath includes a server name, specify this flag when using the LDAP provider. Do not use this flag for paths that include a domain name or for serverless paths. Specifying a server name without also specifying this flag results in unnecessary network traffic.

Username

Text

No

(Empty)

USERNAME="username"

The username context that this activity will execute under. Leave the Username and Password parameters blank in order to use the logon user's credentials.

NOTE:  A Domain User has permission to access Active Directory information. However, only a Domain Administrator has permission to perform Active Directory modifications.

Password

Text

No

(Empty)

PASSWORD="password"

The password associated to the Username context that this activity will execute under. Leave the Username and Password parameters blank to use the logon user's credentials.

Description tab - A custom description can be provided on the Description tab to convey additional information or share special notes about a task step.

Error Causes tab - Specify how this step should behave upon the occurrence of an error. (Refer to Task Builder > Error Causes Tab for details.)

On Error tab - Specify what AWE should do if this step encounters an error as defined on the Error Causes tab. (Refer to Task Builder > On Error Tab for details.)

Datasets

A dataset is a multiple column, multiple row container object. This action creates and populates a dataset with the following fields (assuming the dataset name entered was theDataset):

Name

Type

Return Value

theDataset.ClassName

Text

The class name.

theDataset.Guid

Text

The GUID of the Directory Entry.

theDataset.Name

Text

The name of the object as named with the underlying directory service.

theDataset.NativeGuid

Text

The GUID of the Directory Entry, as returned from the provider.

theDataset.Path

Text

The path for this directory entry.

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: List all Active Directory object paths and populate dataset "ADObjects" with the results.

<AMGETADOBJECTSLIST GETADOBJECTSUSING="CUSTOMFILTER" 
LDAPPATH="LDAP://servername.com" 
CUSTOMFILTER="(&amp; (objectCategory=user) (name=*) )" 
RESULTDATASET="ADObjects" 
USERNAME="administrator" 
PASSWORD="AM2PBmJg27fZts7GYeDb99x20wZ6IMd3xXbaME" />