This service template obtains a list of Windows-based OS or Linux OS users.
The general steps for using this service template to get a list of users from a server are as follows:
- An OS user list is obtained and output in text format to a specified file. For Windows-based OS, the output format of the file is the same as the output result of the net user command.
- The file is transferred to the folder specified by the local server.
- The transferred source file on the Windows-based OS or Linux OS server is deleted.
Service Definition and Submit Service Properties
The following table lists the properties shown in the Service Definition and Submit Service Request windows for the Get List of Users from Server service template.
| Property Key | Property Name | Description | Required |
|---|---|---|---|
| OS.targetHost | Windows/Linux server host name | Specify the host name or IP address of a Windows-based OS or Linux OS server from which an OS user list is to be obtained. IPv6 addresses are not supported. | 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-based OS. | O |
| OS.listOutputFileNameRemote | Output file name (remote) | Specifies the full path name of the file on the Windows-based OS server or Linux OS server where the list of OS users is output. The remote file is deleted after the transfer. | R |
| OS.listOutputFileNameLocal | Output file name (local) | Specifies the local file name where the list of OS users is output. | R |
Note: Although some of the properties in the tables indicate that they can be omitted, they might be required when used in conjunction with some other property setting as indicated in the descriptions.
Server requirements
- Supported Windows-based OS or Linux OS servers
Usage guidelines
- If you are running this service in a Linux OS environment, do not use multibyte characters in properties.
- If you specify multibyte characters, and the OS of the server obtaining the list of OS users is a Windows-based OS, specify a value for the output file name (remote) property that is no longer than 256 bytes.
- If you specify multibyte characters, specify a value for the output file name (local) property that is no longer than 256 bytes.
- 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.
- 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.