4.16.6 Set group of OS user (Windows)(SYSTEM)
Function
Specifies a group to which an OS user belongs in a Windows environment. You can specify a group for a local user or a domain user.
When adding the group where the OS user belongs, if the OS user already belongs to the specified group, delete the OS user from the specified group, and then add the user to the group again.
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 that is specified.
For a local user: local
For a domain user: domain
Use situation
When you have added an OS user for operations, you use this plugin to specify a group to which the user is to belong.
You can also use this plugin to delete a user from a specified group. You can optimize the OS user addition task by using this plugin together with the following plugins:
• osAddUser_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.50.01
Plug-in tags
Configure OS,Windows
Plug-in name displayed in the task log
osChangeGroup_Win_System
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 |
|---|---|---|---|---|---|
|
common.osGroupName |
OS user's group name |
Specify the group name to be assigned to the OS user. |
-- |
Input |
R |
|
common.osUserName |
OS user name |
Specify the user name of the OS user whose group is to be set. |
-- |
Input |
R |
|
common.addOrDelete |
Operation type |
Specify ADD or DELETE to determine whether to add the user to the group or to delete the user from the group. |
-- |
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 |
|
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 |