4.10.7 Bind alarm (JP1/PFM - RM)
Function
This plug-in binds an alarm table to an agent managed by JP1/PFM.
The following shows the servers 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 alarm table specified by the JP1PFM.alarmTableName property is bound to the agents specified by the JP1PFM.serviceID property. Note, however, that if no alarm table name is specified by the JP1PFM.alarmTableName property, the following alarm table is bound:
For JP1/PFM - Manager v8: "PFM Windows Solution Alarms 8.00" (if the JP1/PFM - Manager host OS is Windows) or "PFM UNIX Solution Alarms 8.00" (if the JP1/PFM - Manager host OS is Linux)
For JP1/PFM - Manager v9 or later: "PFM RM Platform Template Alarms 09.00"
In an environment in which multiple alarm tables can be bound, the specified alarm table can be additionally bound to the specified agents. To do this, specify "true" for the JP1PFM.bindMultipleAlarmTable property of JP1/PFM - Manager on the PFM management server. In an environment in which multiple alarm tables cannot be bound, make sure that "false" is specified for the JP1PFM.bindMultipleAlarmTable property. If "false" is specified for this property, all alarm tables bound to the specified agents are unbound, and only the alarm table specified for this plug-in is bound.
Use situation
This plug-in can be used when thresholds are to be monitored by using a remote agent added in a system in which JP1/PFM - RM performs performance monitoring.
Prerequisites
See Release Notes for the latest support statuses of prerequisite products in the system, prerequisite products on the execution target server, and OSs of prerequisite products on the execution target server.
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 bind command (for JP1/PFM - Manager 09-00 or later, the jpcalarm bind 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
Configure JP1,PFM,Windows,Linux,AIX
Plug-in name displayed in the task log
jp1pfmBindAlarm
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)
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
41: Error (An error has been detected in the component) Property not entered (An error has been detected in the component script)
42: Error (error detected in module) Internal error (error detected in the module 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.serviceKey |
JP1/PFM product's service key |
Specify a service key of JP1/PFM - RM product to be bind alarm. |
-- |
Input |
R |
|
JP1PFM.serviceID |
JP1/PFM - RM agent's service ID |
Specify the service ID of the agent of JP1/PFM - RM to be bind alarm. |
-- |
Input |
R |
|
JP1PFM.alarmTableName |
Alarm table name |
Specify the name of the JP1/PFM alarm table to be bound. |
-- |
Input |
O |
|
JP1PFM.bindMultipleAlarmTable |
Whether it is necessary to add a binding to the alarm table |
Specify true to add a binding to the alarm table, or specify false to not add one. |
true |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |