4.10.2 Copy alarm table (JP1/PFM)
Function
This plug-in copies a JP1/PFM alarm table or alarm to create a new alarm table or alarm.
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 copy target.
(1) To create a new alarm table by copying an existing alarm table, specify the JP1PFM.serviceKey, JP1PFM.sourceAlarmTableName, and JP1PFM.destinationAlarmTableName properties.
(2) To create a new alarm by copying an alarm in an existing alarm table, specify the JP1PFM.serviceKey, JP1PFM.sourceAlarmTableName, JP1PFM.sourceAlarmName, and JP1PFM.destinationAlarmTableName properties.
You cannot copy an alarm from an alarm table to another alarm table.
Use situation
In a system whose performance is monitored by JP1/PFM - Manager, this plug-in allows you to create a new alarm table by copying an existing alarm table. The plug-in also allows you to create a new alarm by copying an existing alarm and add monitoring conditions to the new alarm.
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 copy command (for JP1/PFM - Manager 09-00 or later, the jpcalarm copy 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
jp1pfmCopyAlarm
Return code
0: Normal
12: Error (Mistake by user) Invalid property
13: Error (user error) Authentication disabled
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
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.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. |
-- |
Input |
R |
|
JP1PFM.sourceAlarmTableName |
Alarm table name of the copy source |
Specify the alarm table name of the copy source. |
-- |
Input |
R |
|
JP1PFM.sourceAlarmName |
Alarm name of the copy source |
Specify the alarm name of the copy source. |
-- |
Input |
O |
|
JP1PFM.destinationAlarmTableName |
Alarm table name or alarm name of the copy destination |
Specify the alarm table name or alarm name of the copy destination. |
-- |
Input |
R |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |