Modify Active Directory Group Action

Declaration

<AMMODIFYADGROUP LDAP="text" ACTION="text [options]" GROUP="text"
User LDAP="text" NEWUSERNAME "text" NEWUSERPASSWORD "text" USERNAME="text" PASSWORD="text"/>

See Also

Modify AD Group-Setting Properties, Modify AD User Action, Create AD Group Action, Delete AD Object Action

Description

Allows an administrator to rename or delete an existing Active Directory group, as well as add or delete users from an Active Directory group.

Practical Usage

See Description.

Parameters

General Tab

Path

Text, Required
MARKUP: GROUP="LDAP://DC=networkautomation,DC=com"

Specifies the LDAP (Lightweight Directory Access Protocol) path of the Active Directory group to modify. Clicking Select Group launches a standard Windows Active Directory dialog box that allows for the selection of a group.

Action

Text [options], Optional - Default "Add User(s)"
MARKUP: ACTION="rename"

Specifies the action to perform on the Active Directory group. The available options are:

New name

Text, Required
MARKUP: NEWGROUPNAME="Dev"

Specifies the new name of the Active Directory group. Only available if the Rename option is selected in the Action drop-down.

User Tab

NOTE: This option is only available if the Add user(s) or Remove user(s) option is selected in the Action drop-down.

LDAP Path

Text, Required
MARKUP: <User LDAP="LDAP://networkautomation.com/CN=Guest,CN=Users,DC=networkautomation,DC=com" />

Specifies the LDAP path of Active Directory user(s) to add/remove. Add a user by clicking the Add User(s) button. You can also add them manually by typing user's CN (Command Name) and clicking on Add button.               

New user name

Text, Required
MARKUP: NEWUSERNAME="Ronney"

Specifies the name of the new Active Directory user to be created. Only available if the Rename option is selected from the Action drop-down.

New Password

Text, Required
MARKUP: NEWPASSWORD="password"

Specifies the password of the new Active Directory user to be created. Only available if the Rename option is selected from the Action drop-down.mmmmmmm

 

Credentials Tab

Username

Text, Optional
MARKUP: USERNAME="username"

Specifies the username of the Active Directory user

Password

Text, Optional
MARKUP: PASSWORD="password"

Specifies the password of the Active Directory user.

NOTE: Leave the Username and Password fields blank in order to use the logon user's credentials. If only accessing Active Directory information, then any Domain user is valid. However, a Domain Administrator is required in order to modify an Active Directory user or group. We recommend using the credentials of a Domain Administrator for all AutoMate Active Directory actions.

See the following link for more information about LDAP.

http://en.wikipedia.org/wiki/Lightweight_Directory_Access_Protocol

Root LDAP to search user's Common Name (CN)

Text, Optional
MARKUP: LDAPPATH="LDAP://servtest.com"

Specifies the Ldap path of the parent container. This will help to find the Unique LDAP path of user.

Notes

Custom Description

This action includes the Description tab for entering a custom step description.

More on setting custom step description

Standard Error Handling Options

This action also includes the standard Error Causes and On Error failure handling options/tabs.

More on Error Handling Options

Variables and Expressions

All text fields allow the use of expressions, which can be entered by surrounding the expression in percentage signs (example: %MYVARIABLE%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by pressing F2.

More on variables
More on expressions

More on the expression builder

Example

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

<AMMODIFYADGROUP GROUP="LDAP://networkautomation.com/CN=Guests,CN=Builtin,DC=networkautomation,DC=com" ACTION="RENAME" NEWGROUPNAME="GuestOne" />

<AMMODIFYADGROUP GROUP="LDAP://networkautomation.com/CN=Managers,CN=Users,DC=networkautomation,DC=com" ACTION="DELETE" />