4.10.9 Export alarm definition file (JP1/PFM)
Function
This plug-in exports JP1/PFM alarm definitions.
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 exported. The following shows the kinds of information that can be exported and the property specifications. The information exported to the file specified by the JP1PFM.alarmDefinitionFileName property.
(1) To export the alarm definition file template, specify "true" for the JP1PFM.exportTemplate property.
(2) To export the JP1/PFM - Agent (or JP1/PFM - RM) definitions of the alarms (registered in JP1/PFM - Manager on the execution target server) that match the specified service key, specify the JP1PFM.serviceKey property.
(3) To export the definitions of all alarms included in the specified alarm table to an alarm definition file, specify the JP1PFM.serviceKey and JP1PFM.alarmTableName properties.
(4) To export the definition of a specific alarm in a specific alarm table to an alarm definition file, specify the JP1PFM.serviceKey, JP1PFM.alarmTableName, and JP1PFM.alarmName properties.
If you specify both the JP1PFM.exportTemplate and JP1PFM.serviceKey properties, the plug-in ignores the JP1PFM.exportTemplate property. If you specify neither of these properties, the plug-in terminates abnormally with return value 41.
Note that if the file specified by the JP1PFM.alarmDefinitionFileName property already exists, the existing file is overwritten.
Use situation
This plug-in can be used to update the alarm definitions in a system whose performance is monitored by JP1/PFM.
By using this plug-in with the following plug-ins, the JP1/PFM monitoring conditions can be changed automatically:
- jp1pfmImportAlarmDef
- osReplaceString
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 in the system:
JP1/Automatic Operation 11-00 or later
Prerequisite products on 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
OSs of prerequisite products on the execution target server:
(1) Windows Server 2008 R2 (Standard/Enterprise/Datacenter)
(2) Windows Server 2012 (Standard/Datacenter) or 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) or Red Hat Enterprise Linux Server 6 (64-bit x86/x64)
(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) Before you specify a JP1/PFM product service key as a property, make sure that the following JP1/Performance Management - Manager services are running:
- Name Server service
- Master Manager service
- View Server service
(2) The conditions for using the JP1/PFM jpctool alarm export command (for JP1/PFM - Manager 09-00 or later, the jpcalarm export 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
jp1pfmExportAlarmDef
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
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.alarmDefinitionFileName |
Alarm definition file name |
Specify the full path for the file that exports JP1/PFM alarm definition 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.exportTemplate. |
-- |
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.alarmName |
alarm name |
Specify the alarm name. Specify this property at the same time as JP1PFM.serviceKey and JP1PFM.alarmTableName. |
-- |
Input |
O |
|
JP1PFM.exportTemplate |
Whether it is necessary to output the template |
Specify true to output the template of the alarm definition file. This property cannot be specified at the same time as JP1PFM.serviceKey. |
-- |
Input |
O |
|
common.returnValue |
Return value for the plugin |
The return value of this plugin stored. |
-- |
Output |
O |