4.13.34 Acquiring process information
Function
This plug-in sets the information about the specified process to the output property on the Windows or Unix execution target server. If more than one process is specified, the processes are sorted in the order of process start time, beginning with the oldest, and each process is set for one output property.
Process information can be set for up to 20 output properties. If there are 21 or more processes to be output, true is set to the process overflow flag (the common.processOverflowFlag property). In other cases, false is set to the property.
Process information items to be set for each output property are as follows:
<process-name>,<process-ID>,<process-start-time>
The prerequisite server for this plug-in is as follows:
- Execution target server
This server is used as the target for executing this plug-in.
Scripts in this plug-in performs the following processing:
- Execution of the following commands:
- Windows
Get-Process -Name "process-name(common.processName-property)"
For details of Get-Process commandlet, visit the Microsoft library Web site.
- Unix
ps --sort start_time --format comm,pid,start_time -C "process-name(common.processName-property)"
For details on the ps command, run the man command of the OS to acquire the command information.
- Sets obtained process information in ascending order by process start time, one line (one process) at a time, to <process-information>[x] (the common.processInfo[x] property)*
*[x] is an integer from 1 to 20.
Use situation
This can be used to check process information when a failure occurs.
Prerequisites
For the latest support status of the following items, see the Release notes: Prerequisite product within the system, prerequisite products on the execution target server, and running OS for prerequisite products on the execution target server.
Prerequisite product within the system:
- JP1/Automatic Operation 11-00 or later
Prerequisite products on the execution target server:
None
Running OS on 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
(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)
Conditions of using the execution target server:
None
Cautions
(1) Do not use a character string containing a double quotation mark (") or a single quotation mark (') in a plug-in property.
(2) You cannot use a wild card for specification to the target file path (common.targetFilePath property).
(3) If the running OS on the execution target server is Windows, you cannot acquire process start time for a user that has higher authority. Processes for which time cannot be acquired are stored in the process information property later than the process information property that stores processes that acquired the time.
Version
02.00.01
Plug-in tags
Gather OS information,Windows,Linux
Plug-in name displayed in the task log
osGetProcessInfo
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 |
|---|---|---|---|---|---|
|
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.processName |
Process name |
Specify the name of the process for which you want to acquire information. |
-- |
Input |
R |
|
common.processInfo1 |
Process information 1 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo2 |
Process information 2 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo3 |
Process information 3 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo4 |
Process information 4 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo5 |
Process information 5 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo6 |
Process information 6 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo7 |
Process information 7 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo8 |
Process information 8 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo9 |
Process information 9 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo10 |
Process information 10 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo11 |
Process information 11 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo12 |
Process information 12 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo13 |
Process information 13 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo14 |
Process information 14 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo15 |
Process information 15 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo16 |
Process information 16 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo17 |
Process information 17 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo18 |
Process information 18 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo19 |
Process information 19 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processInfo20 |
Process information 20 |
Set the process information you acquired. |
-- |
Output |
O |
|
common.processOverflowFlag |
Flag for upper limit of a process |
If the number of obtained processes is 21 or more, true is set. If the number is less than 21, false is set. |
-- |
Output |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |