Active Directory - Set object properties |
Declaration
<AMACTIVEDIRECTORY ACTIVITY="set_object_property" AUTHTYPE="text (options)" USERNAME="text" PASSWORD="text (encrypted)" LDAPPATH="text" ADOBJECT="text (options)" PROPERTYNAME="text (options)" PROPERTYVALUE="text" />
Description
Sets the specified property of the selected Active Directory object to the desired value.
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
Can be used to modify specific properties of an AD object. For example, when you rename Active Directory user accounts, you can rename properties such as Common Name (CN), Distinguished Name (DN) and Last Name (SN).
Parameters
Object
Property | Type | Required | Default | Markup | Description |
---|---|---|---|---|---|
Path | Text | Yes | (Empty) | LDAPPATH="LDAP://OU=TestCases, DC=helpsystems,DC=com" |
Specifies the LDAP (Lightweight Directory Access Protocol) path of the Active Directory object whose property to set. Click Select Object to launch a standard Windows dialog box that allows you to select the object (that is, user, computer, group, or contact). Click Select Container to select a specific container or organization unit. |
Property name | Text | Yes | (Empty) | PROPERTYNAME="mail" | The Active Directory object's property name. |
Property value | Text | Yes | (Empty) | PROPERTYVALUE="dli@netauto.com" | 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
Set Active Directory property "mail" of object "LDAP://mycompany.com/CN=Harry,OU=mycompanyUsers,DC=mycompanyDC=com" to "harry@mycompany.com."
Copy
<AMACTIVEDIRECTORY ACTIVITY="set_object_property" AUTHTYPE="Secure" USERNAME="Administrator" PASSWORD="AM5g9FetTR986huWPDHSwB6/u6G8jFsCHsfpA0TxO3xKyE=aME" LDAPPATH="LDAP://mycompany.com/CN=Harry,OU=mycompanyUsers,DC=mycompanyDC=com" ADOBJECT="user" PROPERTYNAME="mail" PROPERTYVALUE="harry@company.com" />