2.4.7 Replicating a JP1/PFM alarm definition
Function
This service template copies and changes an alarm definition in a system that uses JP1/PFM to monitor servers, and then binds the new alarm definition to the specified agents.
When you add or change the conditions for determining the servers to be monitored by JP1/PFM - RM for Platform, you can create and bind a new alarm table by modifying a ready-made alarm table boilerplate.
The following describes the servers that this service template requires:
- PFM management server
A server on which JP1/PFM - Manager is installed.
- Monitored servers
Servers to be set as the monitoring targets of JP1/PFM.
The following provides a processing overview:
(1) On the PFM management server, a new alarm table is created by copying an existing alarm table.
(2) The alarms in the alarm table created in (1) are copied to create new alarms.
(3) An alarm definition file is exported.
(4) The exported alarm definition file is edited according to the service template.
(5) The edited alarm definition file is imported.
(6) The copy-source alarms are deleted (the alarms to be deleted can be selected).
(7) The alarm table is bound to monitored server agents.
(8) The definition information and bind information about the alarm table and alarms are output to a file (hereinafter, this file is called an "alarm information file").
(9) The edited alarm definition file and the alarm information file are forwarded from the PFM management server to the JP1/AO server.
(10) The alarm definition file and the alarm information file are deleted from the PFM management server.
In an environment in which multiple alarm tables can be bound, the alarm table changed or imported by this service 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 changed or imported by this service is bound.
Notes on specifying the common.targetStr property:
- Regular expressions are not supported.
- If the OS of the PFM management server is Windows, to specify the following symbols, prefix a backslash (\) to them as an escape character: \ [ ] * . @
To specify a character string that includes spaces or any of the following symbols, prefix a grave accent mark (`) to the string as an escape character: # , ` < >
To specify (, ), or $, prefix both a backslash and grave accent mark (\`) to them as escape characters.
- If the OS of the PFM management server is UNIX, to use a backslash (\) as an ordinary character, specify \\ instead of \. Also, to use the following symbols, prefix a backslash (\) to them as an escape character: [ ] / . * $
- Never enter a double quotation mark ("), regardless of whether the OS is Windows or UNIX. To specify a double quotation mark ("), enter \0x22.
Notes on specifying the common.destinationStr property:
- If the OS of the PFM management server is Windows, you can use the meta characters `t (tab) and `r`n (line break). To specify a character string that includes a space or any of the following symbols, prefix a grave accent mark (`) to the string as an escape character: ` # , @ ( ) < > $
- If the OS of the PFM management server is UNIX, you can use the meta characters \t (tab) and \n (line break). To use a backslash (\) as an ordinary character, specify \\ instead of \. Also, to include a slash (/) or dollar sign ($) in a character string, prefix a backslash (\) to the string as an escape character.
- Never enter a double quotation mark (") regardless of whether the OS is Windows or UNIX. To specify a double quotation mark ("), enter \0x22.
Prerequisites
For the most recent information about the prerequisite products for the system, prerequisite products for the system executing the service templates, and the supported OSs for the prerequisite products for the system executing the service templates, see the Release Notes.
Prerequisite products for the system:
JP1/Automatic Operation 12-00 or later
Prerequisite products for the system executing the service templates:
(1)Job Management Partner 1/Performance Management - Manager 09-10-11 or later, or
(2)Job Management Partner 1/Performance Management - Manager 10-00 or later, or
(3)JP1/Performance Management - Manager 11-00 or later
(4)Job Management Partner 1/Performance Management - Remote Monitor for Platform 08-10 or later, or
(5)Job Management Partner 1/Performance Management - Remote Monitor for Platform 10-10 or later, or
(6)JP1/Performance Management - Remote Monitor for Platform 11-00 or later
Supported OSs for the prerequisite products for the system executing the service templates:
(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_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 the prerequisite products in the service-template execution system:
(1) The following JP1/PFM - Manager services must be running:
- Name Server service
- Master Manager service
- View Server service
(2) The alarm table and alarms to be copied must have been registered in the JP1/PFM system.
(3) The conditions for using the following subcommands of the JP1/PFM jpctool alarm command must be satisfied:
- jpctool alarm bind
- jpctool alarm copy
- jpctool alarm delete
- jpctool alarm export
- jpctool alarm import
- jpctool alarm list
Cautions
(1) If this service is executed simultaneously with a service that links to that service or another JP1/PFM service, the task might terminate abnormally.
(2) If JP1/PFM - Manager on the execution target server is in a cluster configuration, execute the service on the active node.
(3) If the encryption attribute is set for any of the folders in the specified remote or local file path, transmission of the specified file fails and the task terminates abnormally. For details, see the notes on the File-Forwarding plug-in.
(4) If the OS of the PFM management server is UNIX, make sure that no multi-byte characters are used in the specified remote file path.
(5) If a file that has the specified remote or local file name already exists, that file is overwritten. At this time, the remote file is deleted. Therefore, carefully confirm that the specified file name is correct.
(6) If the specified remote path includes non-existent folders, these folders are created. These created folders are not deleted. Delete these folders if you do not use them regularly.
(7) If the OS of the PFM management server is UNIX, commands are executed with the default locale of the connecting user defined at the agentless connection destination. For the default locale of the connecting user, be sure to set a locale supported by JP1/PFM. For details, see "Locale set for operation target devices during plug-in execution" and "Character set used for communication by JP1/AO during plug-in execution" in the JP1/AO manual and JP1/PFM manual.
Version
03.01.00
Tags
Configure JP1,PFM
Property list
The following shows the list of the property groups set in the property:
|
Property group |
Description |
Initial display |
|---|---|---|
|
Monitoring system information |
Specify the information about the PFM management server and monitored server. |
Y |
|
Alarm editing information |
Specify the information about alarm editing. |
Y |
|
Output file information |
Specify the information about output files. |
Y |
The following shows the list of the properties to be displayed in the "Service Definition" window:
- (Legend)
-
R: The property must be specified.
O: The property can be omitted. However, the property might be mandatory depending on what is specified for other properties. See the Description of each property.
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1pfm.pfmHostName |
PFM management server host name |
Specify the host name or IP address of the server on which JP1/PFM - Manager is installed. If you specify an IP address, do not specify an IPv6 address. In a cluster configuration, specify the physical host or logical host for the active server. |
Input |
Disabled |
R |
Monitoring system information |
|
jp1pfm.serviceKey |
Service key |
Specify the service key of JP1/PFM - RM for Platform. If the product name display function is enabled, you can also specify the product name. |
Input |
Disabled |
R |
Monitoring system information |
The following shows the list of the properties to be displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Property name |
Description |
I/O type |
Shared |
Required |
Property group |
|---|---|---|---|---|---|---|
|
jp1pfm.agentServiceId |
Agent service ID |
Specify the service ID of the JP1/PFM - RM remote agent or group agent with which the alarm is to be bound. |
Input |
Disabled |
R |
Monitoring system information |
|
jp1pfm.sourceAlarmTableName |
Copy-source alarm table name |
Specify the copy-source alarm table name. |
Input |
Disabled |
R |
Alarm editing information |
|
jp1pfm.destinationAlarmTableName |
Copy-destination alarm table name |
Specify the name of the copy-destination alarm table. |
Input |
Disabled |
R |
Alarm editing information |
|
jp1pfm.sourceAlarmName |
Copy-source alarm name |
Specify the copy-source alarm name. |
Input |
Disabled |
R |
Alarm editing information |
|
jp1pfm.destinationAlarmName |
Copy-destination alarm name |
Specify the name of the copy-destination alarm. |
Input |
Disabled |
R |
Alarm editing information |
|
common.targetStr |
Change-from string in the alarm definition file |
Specify the string to be changed in the file. |
Input |
Disabled |
R |
Alarm editing information |
|
common.destinationStr |
Change-to string in the alarm definition file |
Specify the string with which the "change-from string" is to be replaced. |
Input |
Disabled |
R |
Alarm editing information |
|
jp1pfm.deleteSourceAlarm |
Whether to delete the copy-source alarm |
If you want to delete the copy-source alarm, specify "true". If you do not want to delete the copy-source alarm, specify "false". |
Input |
Disabled |
R |
Alarm editing information |
|
jp1pfm.bindMultipleAlarmTable |
Whether additional alarm tables need to be bound |
To bind a replicated alarm table additionally when the function that binds multiple alarm tables is enabled, specify "true". |
Input |
Disabled |
R |
Alarm editing information |
|
jp1pfm.alarmDefinitionFilePathRemote |
Alarm definition file path (remote) |
Specify a full path for the export-destination folder (on the PFM management server side) for the alarm definition file. |
Input |
Disabled |
R |
Output file information |
|
jp1pfm.alarmDefinitionFilePathLocal |
Alarm definition file path (local) |
Specify a full path for the folder (on the JP1/AO side) for storing the edited alarm definition file. |
Input |
Disabled |
R |
Output file information |
|
jp1pfm.alarmInfoFilePathRemote |
Alarm information file path (remote) |
Specify a full path for the export-destination folder (on the PFM management server side) for the alarm information file. |
Input |
Disabled |
R |
Output file information |
|
jp1pfm.alarmInfoFilePathLocal |
Alarm information file path (local) |
Specify a full path for the folder (on the JP1/AO side) for storing the alarm information file. |
Input |
Disabled |
R |
Output file information |
The following shows the restrictions on inputs to the properties displayed in the "Service Definition" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1pfm.pfmHostName |
A maximum of 255 characters can be entered. Characters that can be used include alphanumeric characters, as well as . and -. |
|
jp1pfm.serviceKey |
This is a character string of 2 to 16 characters. < > | ; & " and ` are not allowed. |
The following shows the restrictions on inputs to the property displayed on the "Service Definition" window and the "Submit Service" window:
|
Property key |
Characters that can be input |
|---|---|
|
jp1pfm.agentServiceId |
A string that has 258 or fewer single-byte alphanumeric characters, including the following symbols: - . @ [ ] |
|
jp1pfm.sourceAlarmTableName |
A string that has 64 or fewer characters. The following symbols cannot be used: \ ! " # $ & ' * + : ; , < > = ? ^ ~ ` { } | |
|
jp1pfm.destinationAlarmTableName |
A string that has 64 or fewer characters. The following symbols cannot be used: \ ! " # $ & ' * + : ; , < > = ? ^ ~ ` { } | |
|
jp1pfm.sourceAlarmName |
A string that has 64 or fewer characters. The following symbols cannot be used: \ ! " # $ & ' * + : ; , < > = ? ^ ~ ` { } | |
|
jp1pfm.destinationAlarmName |
A string that has 64 or fewer characters. The following symbols cannot be used: \ ! " # $ & ' * + : ; , < > = ? ^ ~ ` { } | |
|
common.targetStr |
A string that has 1,024 or fewer characters, does not end with a backslash (\), and does not include the following symbols: | ; & ' " ? { } ~ ! + ^ |
|
common.destinationStr |
A string that has 1,024 or fewer characters, does not end with a backslash (\), and does not include the following symbols: | ; & ' " ? { } ~ ! + ^ |
|
jp1pfm.deleteSourceAlarm |
Select one of the following values: true,false |
|
jp1pfm.bindMultipleAlarmTable |
Select one of the following values: true,false |
|
jp1pfm.alarmDefinitionFilePathRemote |
A string that has 256 or fewer characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % ` |
|
jp1pfm.alarmDefinitionFilePathLocal |
A string that has 256 or fewer characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % ` |
|
jp1pfm.alarmInfoFilePathRemote |
A string that has 256 or fewer characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % ` |
|
jp1pfm.alarmInfoFilePathLocal |
A string that has 256 or fewer characters, does not end with a backslash (\), and does not include the following symbols: < > | ; & * ? " % ` |
Flow specification details
The following table shows the detailed specification of the flow:
|
Hierarchy |
Display name |
Plug-in |
||
|---|---|---|---|---|
|
Plug-in name |
Description |
Error recovery method |
||
|
1 |
copyAlarmTable |
Copy alarm table (JP1/PFM) |
Copies an existing alarm table to create a new alarm table. |
After removing the cause of the error, run the service again. |
|
2 |
copyAlarm |
Copy alarm table (JP1/PFM) |
Copies an alarm to create a new alarm. |
After removing the cause of the error, delete the created alarm tables, and then run the service again. |
|
3 |
exportAlarmDefinition |
Export alarm definition file (JP1/PFM) |
Exports an alarm definition file. |
After removing the cause of the error, delete the created alarm tables, and then run the service again. |
|
4 |
editAlarmDefinitionFile |
Replace character strings |
Replaces character strings. |
After removing the cause of the error, delete the created alarm tables, and then run the service again. |
|
5 |
importAlarmDefinitionFile |
Import alarm definition file (JP1/PFM) |
Imports an alarm definition file. |
After removing the cause of the error, delete the created alarm tables, and then run the service again. |
|
6 |
deleteAlarm |
Flow Plug-in |
Deletes an alarm. |
-- |
|
6-1 |
Judge Value Plug-in |
Judges whether the copy-source alarm needs to be deleted. |
After removing the cause of the error, delete the created alarm tables, and then run the service again. |
|
|
6-2 |
Delete alarm table (JP1/PFM) |
Deletes the copy-source alarm. |
After removing the cause of the error, delete the created alarm tables, and then run the service again. |
|
|
7 |
bindAlarmTable |
Bind alarm (JP1/PFM - RM) |
Binds an alarm table to a monitored server. |
After removing the cause of the error, delete the created alarm tables, and then run the service again. |
|
8 |
acquireAlarmInfo |
Obtain alarm table information (JP1/PFM) |
Obtains an alarm information file. |
Obtain the alarm definition file and alarm information file as necessary. |
|
9 |
fileTransfer |
Flow Plug-in |
Forwards the alarm definition file and alarm information file to the JP1/AO server. |
-- |
|
9-1 |
File-Forwarding Plug-in |
Forwards the alarm definition file to the JP1/AO server. |
Obtain the output alarm definition file and alarm information file as necessary. |
|
|
9-2 |
File-Forwarding Plug-in |
Forwards the alarm information file to the JP1/AO server. |
Obtain the output alarm information file as necessary. |
|
|
10 |
deleteFile |
Flow Plug-in |
Deletes the alarm definition file and alarm information file from the PFM management server. |
-- |
|
10-1 |
Delete file |
Deletes the alarm definition file from the PFM management server. |
Delete the alarm definition file and alarm information file from the PFM management server. |
|
|
10-2 |
Delete file |
Deletes the alarm information file from the PFM management server. |
Delete the alarm information file from the PFM management server. |
|