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 Automate variable with the value of the specified property of the requested Active Directory object at the provided path.
IMPORTANT: Automate's Active
Directory activities require a basic understanding of Active Directory
and related components (for example, 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 (for example, cn, CommonName, dn, distinguishedName, etc.). |
Populate variable with property value | Text | Yes | (Empty) | RESULTVARIABLE="varname" | An existing 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 |
|
Specifies
the types of authentication used. The available options are:
|
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. |
Example
NOTE:
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
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."
Copy
<AMACTIVEDIRECTORY ACTIVITY="get_object_property" AUTHTYPE="Secure" USERNAME="UserName" PASSWORD="AM5qMDoM6LvPsa0TjWgaROfxRRk4GnC7VmEJ0+8ggRRmEA=aME" LDAPPATH="LDAP://mycompanyname.com/CN=RobinHood,OU=Development,OU=My Company, Inc. Employees,DC=networkautomation,DC=com" PROPERTYNAME="givenName" ADOBJECT="contacts" RESULTVARIABLE="PropertyValue" />