Active Directory - Get object path |
Declaration
AMACTIVEDIRECTORY ACTIVITY="get_object_path" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" LDAPPATH="text" OBJECTNAME="text" RESULTVARIABLE="text" />
Description
Populates a variable with the Lightweight Directory Access Protocol (LDAP) path of the specified Active Directory object (for example, user, computer, OU, etc.).
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 path of a specific Active Directory object. The path can be specified in subsequent Active Directory operations.
Parameters
Object
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Parent path | Text | Yes | (Empty) | LDAPPATH="LDAP:// DC=netauto,DC=com" |
The Lightweight Directory Access Protocol (LDAP) path of the parent Active Directory container. This is usually the top most container or rootDSE path; the root of the directory data tree on a directory server. Click the Select Container button to launch a standard Windows Active Directory dialog that allows for the selection an Active Directory container. |
Name | Text | Yes | (Empty) | OBJECTNAME="Scott" | The name of the Active Directory object in which to retrieve the path from. Wildcard characters (for example, * and ?) can be used to filter the name. For example, entering S* will filter all Active Directory object names starting with the letter S. |
Type | Text (Options) | Yes | User | ADOBJECT="GROUP" | The
Active Directory object type in which to retrieve the path from.
The available options are:
|
Populate variable with path | Text | Yes | (Empty) | RESULTVARIABLE="varname" | The name of an existing variable to be populated with the first object's LDAP path found in the Active Directory matching the name. |
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 the path of the USER Active Directory object with the name of "G*" and store it in variable "ObjectPath."
Copy
<AMACTIVEDIRECTORY ACTIVITY="get_object_path" AUTHTYPE="Secure" USERNAME="UserName" PASSWORD="AM5QHMF/fSuE3B114w2edNoBhfHPuS0ccAzdmCGna541Dc=aME" LDAPPATH="LDAP://OU=MyCompanyEmployees,DC=mycompany,DC=com" OBJECTNAME="G*" RESULTVARIABLE="ObjectPath" />