general | April 07, 2026

Rename Computer operation - Documentation for BMC Atrium Orchestrator Content 20.14.01

The Rename Computer operation renames a physical computer.

The following table describes the elements for the <items> XML element and adapter request for the Rename Computer operation:

Elements for the <items> XML element and adapter request for the Rename Computer operation

Element

Definition

Required

<target>

Specifies the target for the request

If this element is not present, the adapter uses the default target specifies in its configuration.

No

<host>

Specifies the host name or IP address of the remote computer

To specify a dynamic target, you must use this element.

No

<user-name>

Specifies the user name for remote host authentication

To specify a dynamic target, you must use this element.

No

<password>

Specifies the password that corresponds to the user name

To specify a dynamic target, you must use this element.

No

<commands>

Indicates the beginning of the <commands> element, which contains the individual <command> elements

Yes

<command>

Indicates the beginning of a <command> element, which contains the elements that specify the operation to execute and its parameters

Yes

<active-directory-command>

Specifies the command to be executed

Default value: Rename computer

Yes

<object class>

Specifies the type of object on which to perform the operation

Default value: Computer

Yes

<object-name>

Specifies the name of the computer

Yes

<parameters>

Contains the element list for the operation

No

<new-name>

Specifies the new name of the computer

Yes

<domain>

Specifies the domain to which the computer account belongs to.

No

<domain-user-name>

Specifies the user account that connects with the specified domain

If you omit this element, the operation uses the current user account.

No

<domain-password>

Specifies the password of the user account that is specified in domain-user-name

No

<object-user-name>

Specifies the user account

If you omit this element, the operation uses the current user account.

No

<object-password>

Specifies the password associated with the user account

No

<reboot>

Shuts down and automatically restarts after the rename is completed.

The Delay value is the number of seconds before automatic shutdown occurs. The default Delay value is 20 seconds.

No

The following figure shows a sample adapter request for the Rename Computer operation:

Adapter request for the Rename Computer operation

<active-directory-request> <target> <host>vm-w23-rds19</host> <user-name>administrator</user-name> <password>bmcAdm1n</password> </target> <commands> <command> <active-directory-command>Rename Computer</active-directory-command> <object-class>Computer</object-class> <object-name>VM-W23-RDS59</object-name> <parameters> <new-name>VM-INSTANCE-59</new-name> <domain>vm-w23-rds19.local</domain> <domain-user-name>administrator</domain-user-name> <domain-password>bmcAdm1n</domain-password> <object-user-name>administrator</object-user-name> <object-password>bmcAdm1n</object-password> <reboot /> </parameters> </command> </commands> </active-directory-request>

The following figure shows a sample adapter response for the Rename Computer operation:

Sample adapter response for the Rename Computer operation

<active-directory-response> <metadata> <status>success</status> </metadata> <target-output host="vm-w23-rds19"> <metadata> <os-id>Windows 2003</os-id> <os-version>5.2 Build 3790 Service Pack 2</os-version> <status>success</status> </metadata> <commands-output> <command-output> <metadata> <command>netdom renamecomputer "VM-W23-RDS59" /force
/newname:VM-INSTANCE-59 /ud:vm-w23-rds19.local\administrator /pd:bmcAdm1n
/uo:administrator /po:bmcAdm1n /reboot</command> <line-count>6</line-count> <execution-milliseconds>7667</execution-milliseconds> <exit-code>0</exit-code> <status>success</status> </metadata> <output> <line index="1">Attempting to connect to remote host...</line> <line index="2">Initialising rctrlx server component...</line> <line index="3">Executing remote application: cmd
/c netdom renamecomputer "VM-W23-RDS59" /force /newname:VM-INSTANCE-59
/ud:vm-w23-rds19.local\administrator /pd:bmcAdm1n
/uo:administrator /po:bmcAdm1n /reboot</line> <line index="4">Remote application process ID: 8616</line> <line index="5">The command completed successfully.</line> <line index="6">Remote application exited with code: 0</line> </output> </command-output> </commands-output> </target-output>
</active-directory-response>