2.5.15 Get list of JP1/PFM monitoring targets
Function
This service template acquires a list of JP1/PFM - RM for Platform's monitored targets.
The service template checks JP1/PFM - RM for Platform's monitored targets.
This service template assumes the following server:
• PFM-RM server
Server on which JP1/PFM - RM for Platform is installed
The service template performs the following task:
(1) Outputs in text format to a specified file a list of the servers that are monitored in the instances by JP1/PFM - RM for Platform on the PFM - RM server. The output format of the file is the same as the format of the results output by JP1/PFM's jpcconf target list command.
Prerequisites
For the latest support information about [Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
In addition, the following OS and products use abbreviations. For the abbreviations of OS and products, see the "Preface".
[Required products in the system executing the service template]
(1)JP1/PFM - RM
[Prerequisite product OS running in the system executing the service template]
(1) Windows Server 2016 Standard/Datacenter
(2) Windows Server 2019 Standard/Datacenter
(3) Windows Server 2022 Standard/Datacenter
(4) Red Hat Enterprise Linux Server 7
(5) Red Hat Enterprise Linux Server 8
[Usage conditions of prerequisite products in the system executing the service template]
(1) The product name display function must be enabled in Job Management Partner 1/PFM.
(2) Job Management Partner 1/PFM's jpcconf command must be specified correctly, in accordance with its usage conditions.
Cautions
(1) Only one instance of this service can be executing on the same server at the same time.
(2) This service executes the jpcconf command on the PFM - RM server. Therefore, do not execute the jpcconf command on the PFM - RM server while the service is running.
Similarly, do not run this service while the jpcconf command is executing on the PFM - RM server.
(3) If you run this service in a Linux environment, do not use multi-byte characters in the properties.
(4) If a file name specified for the remote and local systems already exists, that file will be overwritten. Also, the file in the remote system will be deleted. Therefore, make sure that you specify the correct file names.
(5) If there is no folder on the specified path in the remote system, such a folder will be created. A folder that is created will remain and will not be deleted; for this reason, you should delete unneeded folders periodically.
Version
04.00.00
Tags
Gather JP1 information,PFM
Property list
The following shows the list of the property groups set in the property:
Property group |
Description |
Initial display |
---|---|---|
Monitored system environment information |
Specify the environment information of the PFM - RM server. |
Y |
Monitoring target acquisition information |
Specify the information you want to acquire about the monitored servers. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" 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 |
Property group |
---|---|---|---|---|---|---|
jp1pfm.pfmRMHostName |
JP1/PFM - RM host name |
Specify the host name or IP address of the server where JP1/PFM - RM for Platform is installed. IPv6 address is not supported. Specify the physical host name of primary server or the logical host name of JP1/PFM - RM for Platform. |
Input |
Disabled |
R |
Monitored system environment information |
jp1pfm.jp1pfmRMLHostName |
JP1/PFM - RM logical host name |
Specify the logical host name of JP1/PFM - RM (when using JP1/PFM - RM for Platform in a cluster configuration). |
Input |
Disabled |
O |
Monitored system environment information |
jp1pfm.reportOutputFileNameRemote |
Report output file name(remote) |
Specifies the full path name of the temporary file for outputting the list of monitored servers in JP1/PFM - RM for Platform to the PFM - RM server. |
Input |
Disabled |
R |
Monitoring target acquisition information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
---|---|---|---|---|---|---|
jp1pfm.instance |
Instance name of JP1/PFM - RM |
Specifies the JP1/PFM - RM for Platform instance name. |
Input |
Disabled |
R |
Monitoring target acquisition information |
jp1pfm.reportOutputFileNameLocal |
Report output file name(local) |
Specifies the full path name of the file for acquiring the list of monitored servers in JP1/PFM - RM for Platform. |
Input |
Disabled |
R |
Monitoring target acquisition information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
Property key |
Characters that can be input |
---|---|
jp1pfm.pfmRMHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
jp1pfm.jp1pfmRMLHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
jp1pfm.reportOutputFileNameRemote |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, `, or a trailing \ or /. |
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 |
---|---|
jp1pfm.instance |
A maximum of 32 characters can be entered. Characters that can be used include alphanumeric character. |
jp1pfm.reportOutputFileNameLocal |
A character string of no more than 256 characters can be entered. It cannot include <, >, |, ;, &, *, ?, ", %, or a trailing \ or /. |
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 |
listMonitoringTargetJP1PFM-RM |
Display monitoring targets (JP1/PFM - RM) |
Acquires a list of monitoring targets. |
Eliminate the cause of the error, and then re-execute the service. |
2 |
FileTransfer |
File-forwarding plug-in |
Transfer a list of monitoring targets. |
Eliminate the cause of the error, and then re-execute the service. |
3 |
osDeleteFile |
Delete file |
Deletes temporary files. |
Eliminate the cause of the error, and then re-execute the service. |