4.15.1 Add OS user (UNIX)
Function
In UNIX environments, this plug-in performs the following operations:
- Adding OS users
- Adding users to groups
- Creating home directories
If the specified OS user already exists, skip this process. (Return value: 0)
This plugin assumes the following server:
• Execution target server
This is the server on which this module is executed. UNIX must have already been set up.
Use situation
You use this plugin to add a user for operations in UNIX.
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]
(1)JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
None.
[OS running in the execution target server]
(1) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
(2) Red Hat Enterprise Linux Server 7 (64-bit x86_64)
(3) Red Hat Enterprise Linux Server 8 (64-bit x86_64)
(4) CentOS 6 (64-bit x86_64)
(5) CentOS 7 (64-bit x86_64)
(6) CentOS 8 (64-bit x86_64)
(7) Oracle Linux 8 (64-bit x86_64)
(8) AIX V6
(9) AIX V7
[Usage conditions for required products in the execution target system]
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,Linux,AIX
Plug-in name displayed in the task log
osAddUser_Lin
Return code
0: Normal
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 |
|---|---|---|---|---|---|
|
Linux.accountComment |
Explanation comment for the OS user |
Specify a description of the user's account. |
-- |
Input |
O |
|
Linux.userHomeDir |
OS user's home directory |
Specify the full path of the OS user's home directory. |
-- |
Input |
O |
|
Linux.accountExpires |
OS user's expiration date |
Specify the OS user expiration date in YYYY-MM-DD format. |
-- |
Input |
O |
|
Linux.osGroupName |
OS user's group name |
Specify the name of the group to be assigned to the OS user. |
-- |
Input |
O |
|
Linux.osUserName |
OS user name |
Specify the name of the OS user to be created. |
-- |
Input |
R |
|
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.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |