4.10.6 Unbind alarm (JP1/PFM - RM)
Function
Unbinds an alarm table from an agent managed by JP1/PFM.
This plugin assumes the following server:
• PFM management server (Execution target server)
This is the server on which this plugin is executed. JP1/PFM - Manager must have already been set up.
The plugin unbinds the alarm table specified in the JP1PFM.alarmTableName property from the agent specified in JP1PFM.serviceID. If no alarm table name is specified in JP1PFM.alarmTableName, the plugin unbinds the following alarm table:
For JP1/PFM - Manager V8: PFM Windows Solution Alarms 8.00 (when the JP1/PFM - Manager host is Windows) or PFM UNIX Solution Alarms 8.00 (when the JP1/PFM - Manager host is UNIX)
For JP1/PFM - Manager V9 or later: PFM RM Platform Template Alarms 09.00
Use situation
You use this plugin to stop monitoring thresholds by a remote agent in a system using JP1/PFM - RM for performance monitoring.
Prerequisites
For the latest support information about [Required product in the System]/[Required products on the execution target server]/[Prerequisite product OS running in the execution target server], see the release notes.
[Required product in the System]
(1)JP1/Automatic Operation 11-00 or later
[Required products on the execution target server]
(1)Job Management Partner 1/Performance Management - Manager 10-00 or later, or
JP1/Performance Management - Manager 11-00 or later
[Prerequisite product OS running in 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
[Usage conditions for required products on the execution target server]
(1) The following services of JP1/PFM - Manage are running:
• Name server service
• Master manager service
• View server service
Cautions
(1) Do not execute multiple instances of this plugin concurrently on the same execution target server.
(2) If the execution target server's JP1/PFM - Manager has a cluster configuration, execute this plugin on the executing node.
Version
02.00.00
Plug-in tags
Configure JP1,PFM,Windows,Linux,AIX
Plug-in name displayed in the task log
jp1pfmReleaseAlarm
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)
Property list
The following table lists the properties:
|
Property key |
Property name |
Description |
Default value |
I/O type |
Required |
|---|---|---|---|---|---|
|
JP1PFM.serviceKey |
JP1/PFM product's service key |
Specify the JP1/PFM - RM service key to unbind from the alarm. |
-- |
Input |
R |
|
JP1PFM.serviceID |
JP1/PFM - RM agent's service ID |
Specify the service ID of the JP1/PFM agent to unbind from the alarm. |
-- |
Input |
R |
|
JP1PFM.alarmTableName |
Alarm table name |
Specify the name of the JP1/PFM alarm table to unbind. |
-- |
Input |
O |
|
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 |