2.10.5 Get List of Users from Server
Function
This service template acquires a list of Windows/UNIX OS users.
This service template assumes that the following servers are being used.
• Windows servers
• UNIX servers
The following tasks are performed.
(1) An OS user list is acquired and output in text format to a specified file. For Windows, the output format of the file is the same as the output result of the net user command.
(2) The file is transferred to the folder specified by the local server. The transfer source file on the Windows/UNIX server is deleted.
Prerequisites
For the latest support information about [Required product for the system]/[Required products for the service template execution system]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product in the System]
JP1/Automatic Operation 12-00 or later
[Required products for the service template execution system]
None.
[Prerequisite product OS running in the system executing the service template]
(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 prerequisite products in the system]
None.
[Usage conditions of prerequisite products in the system executing the service template]
None.
Cautions
(1)If you are executing this service in a UNIX environment, do not use multibyte characters in properties.
(2) If you specify multibyte characters, and the OS of the server acquiring the list of OS users is Windows, specify a value for the output file name (remote) property that is no longer than 256 bytes.
(3) If you specify multibyte characters, specify a value for the output file name (local) property that is no longer than 256 bytes.
(4) If the file names specified for remote and local already exist, the existing files are overwritten. The file on the remote side is also deleted. For this reason, make sure that file names are specified correctly.
(5) If there is no folder at the path specified as remote, the folder is created. The created folder is left undeleted. If it is not used periodically, delete it.
Version
02.00.00
Tags
Gather OS information,Linux,Windows,AIX
Property list
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
|---|---|---|---|---|---|
|
OS.targetHost |
Windows/UNIX server host name |
Specify the host name or IP address of a Windows or UNIX server from which an OS user list is to be obtained. IPv6 addresses are not supported. |
Input |
Disabled |
R |
|
OS.userType |
OS user type |
Specify "local" or "domain" as the OS user type. This property only takes effect when the agent server is running Windows. |
Input |
Disabled |
O |
|
OS.listOutputFileNameRemote |
Output file name (remote) |
Specifies the full path name of the file on the Windows server or UNIX server where the list of OS users is output. The remote file is deleted after the transfer. |
Input |
Disabled |
R |
|
OS.listOutputFileNameLocal |
Output file name (local) |
Specifies the local file name where the list of OS users is output. |
Input |
Disabled |
R |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
OS.targetHost |
This is a character string consisting of up to 255 alphanumeric characters, along with . and -. |
|
OS.userType |
Select one of the following values: local,domain |
|
OS.listOutputFileNameRemote |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, `, or a trailing \. |
|
OS.listOutputFileNameLocal |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \. |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
osShowUsers |
Get list of OS users |
Acquires a list of OS users from Windows or UNIX. |
Eliminate the cause of the error, and then re-execute the service. |
|
2 |
FileTransferPlugin |
File-forwarding plug-in |
Transfers lists of OS users. |
Eliminate the cause of the error, and then re-execute the service. |
|
3 |
osDeleteFile |
Delete file |
Deletes temporary files. |
Files remain in the target server. Delete them manually. |