Active Directory - Get object property

Declaration

<AMACTIVEDIRECTORY ACTIVITY="get_object_property" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" LDAPPATH="text" PROPERTYNAME="text" ADOBJECT="text (options)" RESULTVARIABLE="text" />

Description:

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

IMPORTANT: 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

Gets the property of a specific Active Directory object. The property can be specified in subsequent Active Directory operations.

Parameters

Object

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

Yes

(Empty)

PROPERTYNAME="CommonName"

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

Populate variable with property value

Text

Yes

(Empty)

RESULTVARIABLE="varname"

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

Credentials

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 integrity 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 in order to use the logon user's credentials.

 

Description

Error Causes

On Error

Example

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

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" />