4.13.11 Change password for OS user
Function
Changes the password for an OS user in a Windows or UNIX environment.
In a Windows environment, you can change the password for a local user or a domain user.
When executing this plug-in in a UNIX environment, please use it in "Add operational user", "Change operational user" or "Batch change of operation users" service template. It does not support using other service templates.
This plugin assumes the following server:
• Execution target server
This is the server on which this plugin is executed. Windows or UNIX must have already been set up.
In a Windows environment, set one of the following values in the Windows.userType property to indicate the type of user whose password is to be changed:
For a local user: local
For a domain user: domain
When the execution target server is Windows, the built-in Administrator is required to execute this plug-in. If the built-in Administrator does not exist or is invalid on the execution target server, execute "Change password for OS user(SYSTEM)" plug-in that executes with the system account.
Use situation
You use this plugin to change the password for a user for operations.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[OS running in the execution target server], see the release notes.
[Required product in the System]
JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
None.
[OS running in the execution target server]
(1) Windows Server 2008 R2 Standard/Enterprise/Datacenter
(2) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(3) Windows Server 2016 Standard/Datacenter
(4) Windows Server 2019 Standard/Datacenter
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(6) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(7) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(8) CentOS 6 (64-bit x86_64)
(9) CentOS 7 (64-bit x86_64)
(10) CentOS 8 (64-bit x86_64)
(11) Oracle Linux 8 (64-bit x86_64)
(12) AIX V6
(13) AIX V7
[Usage conditions for the target server]
None.
Cautions
(1) When you run this plugin in a UNIX environment, do not use multi-byte characters in the properties.
Version
02.00.00
Plug-in tags
Configure OS,Windows,Linux,AIX
Plug-in name displayed in the task log
osChangePassword
Return code
0: Normal
12: Error (user error) Invalid property
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
27: Error (check task logs for the nature of error)
41: Error (error detected in plugin) Missing property (error detected in plugin script)
Property list
The following table lists the properties:
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
plugin.destinationHost |
Host name of the execution target server |
Specify the host name or IP address of the server on which this plugin will be executed. IPv6 addresses are not supported. |
-- |
Input |
R |
common.osUserName |
OS user name |
Specify the user name of the OS user whose password is to be changed. |
-- |
Input |
O |
common.osUserPassword |
OS user password |
Specify the new password for the OS user. |
-- |
Input |
O |
common.osUserPasswordReEnter |
Enter the new OS user password again |
Re-enter the new password for the OS user. |
-- |
Input |
O |
Windows.userType |
OS user's type |
Specify "local" or "domain" as the OS user type. If "domain" is specified, any operations will be performed for the primary domain controller for the domain of the target server. This property takes effect in only Windows. |
local |
Input |
O |
common.addOrChange |
Command execution type |
When executing this plug-in in a UNIX environment, specify "a" if the service to be executed is "Add operational user", and "c" for "Change operational user". |
-- |
Input |
O |
common.tmpFileID |
Temporary file ID |
When executing this plug-in in a UNIX environment, specify the ID used to identify temporary files. |
-- |
Input |
O |
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |