2.5.16 Get list of JP1/PFM alarm information
Function
This service template acquires a listing of JP1/PFM - RM's alarm information defined in JP1/PFM - Manager.
This service template assumes the following server:
• PFM management server
This is the server on which JP1/PFM - Web Console is installed.
The service template performs the following task:
(1) The service template outputs to a specified file in text format a list of JP1/PFM - RM's alarm table names defined in JP1/PFM - Manager, together with the specified service keys of all alarm tables defined on the PFM management server. The output format of the file is the same as the format of the results output by JP1/PFM's jpctool alarm list command.
Prerequisites
For the latest support information about [Required product in the System]/[Prerequisite products in the system executing the service template]/[Prerequisite product OS running in the system executing the service template], see the release notes.
[Required product for the system]
JP1/Automatic Operation 12-00 or later
[Required products in the system executing the service template]
(1) Job Management Partner 1/PFM - Manager 10-00 or later, or
JP1/PFM - Manager 11-00 or later
[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) AIX V6
(9) AIX V7
[Usage conditions of prerequisite products in the system executing the service template]
(1) Job Management Partner 1/PFM - Manager must be running.
(2) The product name display function must be enabled in Job Management Partner 1/PFM.
(3) Job Management Partner 1/PFM's jpctool 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 management server. Therefore, do not execute the jpcconf command on the PFM management 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 UNIX 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
02.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 for the PFM management server. |
Y |
|
Alarm list acquisition information |
Specify the information you want to acquire about the alarm list. |
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.pfmHostName |
PFM management server host name |
Specifies the host name or IP address of the server where JP1/PFM - Manager is installed. IPv6 addresses are not supported. In the case of a cluster configuration, specify the physical host or logical host of the active server. |
Input |
Disabled |
R |
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 alarm information to the PFM management server. |
Input |
Disabled |
R |
Alarm list 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.serviceKey |
Service key |
Specifies the service key for acquiring the list of alarm information. |
Input |
Disabled |
R |
Alarm list acquisition information |
|
jp1pfm.reportOutputFileNameLocal |
Report output file name(local) |
Specifies the full path name of the file for acquiring the list of alarm information. |
Input |
Disabled |
R |
Alarm list 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.pfmHostName |
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.serviceKey |
This is a character string of 2 to 16 characters. < > | ; & " and ` are not allowed. |
|
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 |
listAlarmSettingJP1PFM |
Get list of alarm table names (JP1/PFM - RM) |
Acquires a list of alarm tables. |
Eliminate the cause of the error, and then re-execute the service. |
|
2 |
FileTransfer |
File-forwarding plug-in |
Transfer a list. |
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. |