Active Directory - Modify User

Declaration

<AMMODIFYADUSER LDAPPATH="text" ACTION="text" NEWUSERNAME "text" NEWUSERPASSWORD "text" USERNAME="text" PASSWORD="text"/>

See Also

AD - Create Object | AD - Create User | AD - Delete Object | AD - Get Group Members | AD - Get Object Dataset | AD - Get Object Path | AD - Get Object Property | AD - List Object Path | AD - Modify Group | AD - Rename Object | AD - Set Object Property | AD - Create Group

Description

Enables, disables, deletes or renames an existing Active Directory user.  This action can also be used to change or reset the password of an Active Directory user.

IMPORTANT: In order to properly use AutoMate's Active Directory actions, you should have a basic understanding of Active Directory and related components (e.g. domain controllers, trust relationships, forests, OUs, LDAPs, etc.) Also, to ensure that these actions function appropriately, the target system must be part of a domain.

Practical Usage

May be used in combination with other Active Directory actions to locate user accounts and disable, delete, enable or rename them as well as reset their passwords in seconds.

Parameters

General Properties

Property

Type

Req'd

Default

Markup

Description

Path

Text

Yes

(Empty)

LDAPPATH="LDAP://netauto.com/CN=Tac Shore,OU=Sales,OU=Network Automation Employees,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.

Type

Text (Options)

Yes

Enable

ACTION="rename"

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

  • Enable (Default) - Enables the Active Directory user.

  • Disable - Disables the Active Directory user.

  • Delete - Deletes  the Active Directory user.

  • Rename - Renames the Active Directory user.

  • Reset Password - Resets the Active Directory user's password.

New User Name

Text

No

(Empty)

NEWUSERNAME="Dallas"

Specifies the new name of the Active Directory user.

Only available if the Rename option is selected in the Action drop-down.

Credentials Properties

Property

Type

Req'd

Default

Markup

Description

Username

Text

No

(Empty)

USERNAME="username"

Specifies the username 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.

Password

 

Text

 

No

 

(Empty)

 

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

Root LDAP to search user Common Name (CN)

Text

No

(Empty)

LDAP=

"LDAP://DC=netauto,DC=com"

The root LDAP path to search for the Active Directory user(s) CN (Common Name).

 

Description Properties

The Description tab allows you to customize the text description of any step as it appears in the Task Builder's Steps Pane.

More on setting custom step description

Error Causes Properties

The Error Causes tab properties allows you to instruct a task step to react only to specific errors or ignore certain errors that should cause it to fail.

More on Error Causes properties

On Error Properties

The On Error tab properties lets you determine what the task should do if a particular step encounters an error as defined in the Error Causes properties.

More about On Error properties

Additional Notes

Expressions, Variables and Functions

All text fields allow the use of expressions such as variables, functions or AutoMate extended functions, which can be entered by surrounding the expression in percentage signs (example: %FileDateTime(myVar)% or %myVar%, %Left('Text',2)%). To help construct these expressions, you can open Expression Builder from these fields by clicking the Insert Expression (%) button or by pressing F2.

More on expressions

More on variables

More on function

More on extended functions
More on expression builder

Example

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

 

Description: Change the Active Directory user's password at "LDAP://mycompany.com/CN=Guests,CN=Builtin,DC=mycompany,DC=com".

<AMMODIFYADUSER LDAPPATH="LDAP://mycompany.com/CN=Guests,CN=Builtin,DC=mycompany,DC=com" ACTION="RESETPWD" NEWPASSWORD="one" />

↑ [Top of Page]