4.16.7 Add OS user (Windows)
Function
Adds an OS user in a Windows environment. You can create a local user or a domain user.
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 plugin is executed. Windows must have already been set up.
Set one of the following values in the Windows.userType property to indicate the type of user to be created:
For a local user: local
For a domain user: domain
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 "Add OS user (Windows)(SYSTEM)" plug-in that executes with the system account.
Use situation
You use this plugin to add a user for operations to Windows. You can optimize the user addition task by using this plugin together with the following plugins:
• osChangeGroup_Win
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
[Usage conditions for the target server]
None.
Version
02.00.00
Plug-in tags
Configure OS,Windows
Plug-in name displayed in the task log
osAddUser_Win
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 |
|---|---|---|---|---|---|
|
common.osUserName |
OS user name |
Specify the name of the OS user to be created. |
-- |
Input |
R |
|
common.osUserPassword |
OS user password |
Specify the password of the OS user to be created. |
-- |
Input |
R |
|
common.osUserPasswordReEnter |
Enter the new OS user password again |
Specify the password for the OS user again. |
-- |
Input |
R |
|
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 |
|
Windows.accountActive |
Whether to enable the OS user |
Specify whether to enable the OS user's account. To enable the OS user's account, specify "true". To disable the OS user's account, specify "false". If "false" is specified, the OS user cannot access the server. |
-- |
Input |
O |
|
Windows.accountComment |
Comment for the OS user |
Specify a description of the OS user's account. |
-- |
Input |
O |
|
Windows.countryCode |
OS country code |
Specify the OS country code that will be used for Help and other messages. The value of 0 specifies the default country code. |
-- |
Input |
O |
|
Windows.accountExpires |
OS user expiration date |
Specify the OS user's expiration date in DD/MM/YY format. If you do not want to set an expiration date, specify "never". |
-- |
Input |
O |
|
Windows.userFullName |
OS user's full name |
Specify the full name of the user to be set as the OS user. Note that the name you specify here is not the OS user name. |
-- |
Input |
O |
|
Windows.userHomeFolder |
OS user's home folder |
Specify the full path of the OS user's home folder. Make sure that you specify an existing path. |
-- |
Input |
O |
|
Windows.passwordChange |
Whether to enable password change |
Specify whether to permit the OS user to change his or her password. Specifying "true" permits it, and specifying "false" does not. |
-- |
Input |
O |
|
Windows.passwordRequest |
Whether the OS user password is required |
Specify whether to require the OS user to set a password. Specifying "true" requires it, and specifying "false" does not. |
-- |
Input |
O |
|
Windows.userProfilePath |
OS user's logon profile |
Specify the full path of the OS user's logon profile. |
-- |
Input |
O |
|
Windows.userScriptPath |
OS user's logon script |
Specify the full path of the OS user's logon script. |
-- |
Input |
O |
|
Windows.userLogonTimes |
Period that the OS user can log on |
Specify the time periods during which the OS user can log on. |
-- |
Input |
O |
|
Windows.userComment |
User comment for the OS user |
Specify a User comment of the OS user's account. |
-- |
Input |
O |
|
Windows.workstations |
Server allowing the OS user to log on to the network |
Specify a maximum of eight host names for the servers from which the OS user can log on to the network. If this specification is omitted, the OS user can log on from any server. |
-- |
Input |
O |
|
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 |