altpass

Alters the password of a user object in the current production plan.

You must have altpass access to the user object.

Syntax

altpass
     [[folder/]workstation#]
     username
     [;"password"]

Arguments

[folder/]workstation
Specifies the workstation on which the user is defined. Use the upper case for this field even though you used the mixed case when specifying the workstation in the user definition. For more information refer to User definition. Do not specify this field if the user belongs to a Windows domain managed by active directory. The default is the workstation on which you are running conman.
username
Specifies the name of a user. Use the same user name specified in the HCL Workload Automation database and note that they are case-sensitive. For more information, see User definition.
password
Specifies the new password. It must be enclosed in double quotation marks. To indicate no password for the user, use two consecutive double quotation marks ("").

The maximum length for passwords is 30 bytes. However, 30 bytes does not always equal 30 characters, as some characters may require multiple bytes, depending on the chosen encoding.

The following characters are not supported by conman altpass, when changing the user password in the plan, and when using REST APIs v1:
  • \ – Backslash
  • / – Slash (or forward slash)
  • & – Ampersand
  • + – Plus
  • = – Equals
  • # – Hash (or number sign)
  • [ ] – Space
However, you can define passwords with special characters using one of the following methods:
Using REST API v2
This API version fully supports the use of special characters in password values.
Modifying the User Definition (Model):
You can directly modify the user password in the user definition in the model. Because the optman option enAddUser /au is set to YES by default, the modified password is immediately updated in the current plan. For more information about enAddUser /au, see enAddUser.

Comments

If you do not specify a password, conman prompts for a password and a confirmation. The password is not displayed as it is entered and should not be enclosed in quotes. Note that the change is made only in the current production plan, and is therefore temporary. To make a permanent change see User definition.

Examples

To change the password of user Jim on workstation mis5, stored in folder myfolder, to mynewpw, run the following command: 
altpass myfolder/MIS5#JIM;"mynewpw"
To change the password of user jim on workstation Mis5 to mynewpw without displaying the password, run the following command: 
altpass MIS5#JIM
password: xxxxxxxx
confirm: xxxxxxxx
To change the password of user Jim, defined in an active directory managed Windows domain named twsDom, to mynewpw, run the following command: 
altpass TWSDOM\JIM;"mynewpw"

See also

From the Dynamic Workload Console you can perform the same task as described in:

Changing user password in the plan.