4.10.2 Delete OS user
Function
Deletes an OS user in a Windows or Linux environment.
This plugin assumes the following server:
• Execution target server
This is the server on which this plugin is executed. Windows or Linux described in the prerequisites must have already been set up.
In Windows, you can delete a local user or a domain user, as set in the type of user to be deleted.
Set one of the following values in the Windows.userType property to indicate the type of user to be deleted:
For a local user: local
For a domain user: domain
In Linux, you can also delete the home directory of the OS user that is to be deleted.
Specify the following value in the Linux.homeDirectoryDelete property:
To delete the OS user's home directory: yes
To not delete the OS user's home directory: no
Use situation
You use this plugin to delete an OS user for operations.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target system]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
Job Management Partner 1/Automatic Operation 10-00 or later
[Required products on the execution target system]
None.
[Prerequisite product OS running in the execution target server]
(1) Windows Server 2003, Standard Edition/Enterprise Edition (x86/x64) SP1or later, Windows Server 2003 R2, Standard Edition/Enterprise Edition (x86/x64)
(2) Windows Server 2008 Standard/Enterprise (x86/x64), Windows Server 2008 R2 Standard/Enterprise/Datacenter
(3) Windows Server 2012 Standard/Datacenter, Windows Server 2012 R2 Standard/Datacenter
(4) Red Hat Enterprise Linux 5 Advanced Platform (x86), Red Hat Enterprise Linux 5 (x86), Red Hat Enterprise Linux 5 Advanced Platform (AMD/Intel 64), Red Hat Enterprise Linux 5 (AMD/Intel 64)
(5) Red Hat Enterprise Linux Server 6 (32-bit x86), Red Hat Enterprise Linux Server 6 (64-bit x86_64)
[Usage conditions for the target server]
None.
Cautions
(1) If the execution target server's OS is Linux and you have specified deletion of the user's home directory, first back up the data stored in the home directory, if necessary.
(2) When you run this service in a Linux environment, do not use multi-byte characters in the properties.
Version
01.00.04
Category
OperatingSystem/Common/Basic
Plug-in name displayed in the task log
osDeleteUser
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.osUserName |
OS user name |
Specify the user name of the OS user to be deleted. |
-- |
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 |
|
Linux.homeDirectoryDelete |
Whether to delete user's home directory |
Specify whether to delete the user's home directory. Specifying "yes" deletes it, and specifying "no" does not. This property takes effect in only Linux. |
no |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |