4.10.4 Acquire alarm table information (JP1/PFM)
Function
This plug-in obtains a list of alarm tables defined in JP1/PFM - Manager and the bind information about those alarm tables.
The following describes the server that this plug-in requires:
- PFM management server (execution target server)
The server on which this plug-in is executed. JP1/PFM - Manager must be set up on this server.
The properties to be specified for this plug-in differ depending on the information to be obtained.
(1) To obtain a list of alarm tables defined for a specific JP1/PFM - Agent (or JP1/PFM - RM) host, specify the JP1PFM.serviceKey property only.
(2) To obtain the names of alarms in the specified alarm table, whether the alarm is enabled, and list of agents to which the alarm table is bound, specify the JP1PFM.serviceKey and JP1PFM.alarmTableName properties.
(3) To obtain a list of alarm tables that are bound to the specified agent, specify the JP1PFM.agentServiceID property only. Note that you can specify this property only if the version of JP1/PFM - Manager on the PFM management server is 08-50 or later. If you specify the property in other cases, this plug-in terminates abnormally with return value 12.
Use situation
This plug-in can be used to check the names of alarm tables defined in a system whose performance is monitored by JP1/PFM - Manager. This plug-in can also be used to check the alarm tables bound to a specific JP1/PFM - Agent (or JP1/PFM - RM) host.
Prerequisites
For the most recent information about the prerequisite products for the system, prerequisite products for the execution-target server, and the supported OSs for the prerequisite products for the execution-target server, see the Release Notes.
Prerequisite products for the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products for the execution-target server:
(1) Job Management Partner 1/Performance Management - Manager 09-00 or later, or
JP1/Performance Management - Manager 11-00 or later
Supported OSs for the prerequisite products for 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) AIX V6
(9) AIX V7
Conditions for using prerequisite products on the execution target server:
(1) The following JP1/Performance Management - Manager services must be running:
- Name Server service
- Master Manager service
- View Server service
(2) The conditions for using the JP1/PFM jpctool alarm list command (for JP1/PFM - Manager 09-00 or later, the jpcalarm list command) must be satisfied.
Cautions
(1) Do not simultaneously execute multiple instances of this plug-in on the same execution target server.
(2) If JP1/PFM - Manager on the execution target server is in a cluster configuration, execute the plug-in on the active node.
Version
02.00.00
Plug-in tags
Gather JP1 information,PFM,Windows,Linux,AIX
Plug-in name displayed in the task log
jp1pfmShowAlarmBindList
Return code
0: Normal
12: Error (Mistake by user) Invalid property
13: Error (user error) Authentication disabled
14: Error (Mistake by user) File inaccessible
20: Error (Mistake by user) No row matches the specified key value
21: Error (Environmental error) No command was found (An error was detected in the component script)
22: Error (invalid environment) Insufficient memory or disk capacity
23: Error (Invalid environment) The environment requirements are not met.
24: Error (invalid environment) Start status is invalid
25: Error (invalid environment) Communication error
26: Error (linked product error) Internal error
27: Error (Check with the task log about the error detail) Unidentified error
41: Error (An error has been detected in the component) Property not entered (An error has been detected in the component 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 |
|
JP1PFM.reportOutputFileName |
Report Output File Name |
Specify the full path for the file that outputs JP1/PFM alarm information. |
-- |
Input |
R |
|
JP1PFM.serviceKey |
JP1/PFM product's service key |
Specify the JP1/PFM - Agent (or JP1/PFM - RM) service key. If the functionality to display the product name is enabled, you can also specify the product name. This property cannot be specified at the same time as JP1PFM.agentServiceID. |
-- |
Input |
O |
|
JP1PFM.alarmTableName |
Alarm table name |
Specify the JP1/PFM alarm table name. Specify this property at the same time as JP1PFM.serviceKey. |
-- |
Input |
O |
|
JP1PFM.agentServiceID |
Agent service ID |
Specify the service ID of the JP1/PFM Agent Collector service, Remote Monitor Collector service, remote agent, or group agent. This service ID cannot be specified at the same time as JP1PFM.serviceKey and JP1PFM.alarmTableName. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |