4.10.5 Get list of alarm table names (JP1/PFM - RM)
Function
This plugin acquires a list of the alarm table names defined by JP1/PFM - Manager.
This plugin assumes that the following server is being used.
• PFM management server (Execution target server)
This is the target that executes This plugin. JP1/PFM - Manager must have been set up.
Use situation
In systems that monitor performance using JP1/PFM - Manager, this plugin can be used to check the alarm table names that are defined.
Prerequisites
For the latest support information about [Required products on the execution target server]/[Prerequisite product OS running on the execution target server], 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 on the execution target server]
(1)JP1/PFM - Manager
[Prerequisite product OS running on the execution target server]
(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 for required products on the execution target server]
(1)JP1/PFM - Manager is running.
Cautions
(1) Do not run multiple instances of this component on the same execution target server.
Execution privilege
Windows: Administrator permission
UNIX: root permission
Version
04.00.00
Plug-in tags
Gather JP1 information,PFM,Windows,Linux
Plug-in name displayed in the task log
jp1pfmShowAlarm
Return code
0: Normal
12: Error (user error) Invalid property
13: Error (user error) Authentication disabled
14: Error (user error) File access disabled
20: Error (user error) Other user error
21: Error (invalid environment) Command cannot be found (error detected in the plugin script)
22: Error (invalid environment) Insufficient memory or disk capacity
23: Error (invalid environment) Required environment is invalid
24: Error (invalid environment) Start status is invalid
25: Error (invalid environment) Communication error
26: Error (linked product error) Internal error
41: Error (error detected in plugin) Missing property (error detected in plugin script)
42: Error (error detected in plugin) Internal error (error detected in the plugin script)
Property list
The following table lists the properties:
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
---|---|---|---|---|---|
JP1PFM.reportOutputFileName |
Report Output File Name |
Specifies the name of the file to which the report is to be output. |
-- |
Input |
R |
JP1PFM.serviceKey |
JP1/PFM product's service key |
Specify the service key of JP1/PFM - RM. |
-- |
Input |
R |
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.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |