Active Directory - Rename Object

Declaration

<AMRENAMEADOBJECT LDAPPATH="text" OBJECTNAME="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 - List Object Path | AD - Modify Group | AD - Modify User | AD - Move Object | AD - Set Object Property | AD - Create Group

Description

Renames the Active Directory object at the specified path to the provided name.

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

Can be used to rename a specific AD object such as a user account or printer.

Parameters

General Properties

Property

Type

Req'd

Default

Markup

Description

Path

Text

Yes

(Empty)

LDAPPATH=

"LDAP://OU=TestCases,

DC=netauto,DC=com"

The LDAP (Lightweight Directory Access Protocol) path of the Active Directory object to rename.

Click Select Object to launch a standard Windows Active Directory dialog box that allows you to select the object (i.e. user, computer, group or contact).

Click Select Container to select any container or organization unit.

New Name

Text

Yes

(Empty)

OBJECTNAME="Scott"

The new name of the active directory object.

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

 

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: Rename Active Directory object at "LDAP://servtest.com/OU=TestUsers,DC=servtest,DC=com" to "AutomateUsers".

<AMRENAMEADOBJECT LDAPPATH="LDAP://servtest.com/OU=TestUsers,DC=servtest,DC=com" OBJECTNAME="AutomateUsers" USERNAME="administrator" PASSWORD="password" />

↑ [Top of Page]