jpctool alarm export

Format

jpctool alarm export    -f target-file-name
                       {-key service-key
                       [-table alarm-table-name[-alarm alarm-name]]
                       [-only]|
                        -template}
                       [-y|-n]
                       [-wait number-of-seconds]

To Page Top

Function

The jpctool alarm export command exports alarm definitions to the specified file.

Alarm definition information is exported in accordance with the syntax of the alarm definition file. For details about the syntax of the alarm definition file, see the chapter in the JP1/Performance Management User's Guide that describes operation monitoring by alarms.

The following table shows the range of alarm definition information that is exported depending on the combination of the -key, -table, and -alarm options that is specified:

Legend:

S: Specified

N: Not specified

By specifying the -template option, you can output the template file that contains all the labels that are defined in the alarm definition file.

To Page Top

Hosts that can execute the command

PFM - Manager

To Page Top

Execution permission

In Windows:

User with Administrators permissions

In UNIX:

User with root user permissions

To Page Top

Installation directory

In Windows:

installation-folder\tools\

In UNIX:

/opt/jp1pc/tools/

To Page Top

Arguments

To Page Top

Alarm definition file format

See the description of the alarm definition file format in the jpctool alarm import command.

To Page Top

Notes

• This command cannot be executed concurrently.

• You must start PFM - Manager (Name Server, Master Manager, and View Server services) before you can export existing alarm definition information with the -key, -table, or -alarm option specified. However, if you are outputting the template (-template option specified), it is not necessary for PFM - Manager to be running.

• PFM - Agent and PFM - RM monitoring templates might contain alarms for which conditions for abnormal values and warning values are different. In this case, when a monitoring template is exported, conditions with warning values are given priority for export.

  For example, if you export an alarm definition whose conditional expression for an abnormal value is BBB >= 90 and that for a warning value is BBB > 80, the warning value condition (>) is output to the alarm definition file as shown below:

  [[Alarm Condition Expressions]]
  Condition=BBB>90,80

  For details about settings for abnormal value and warning value conditions for monitoring templates, see the chapter describing monitoring templates in the PFM - Agent or PFM - RM manuals.

• You can export 251 or more alarm definitions at once. Note, however, that the maximum number of alarms that can be defined in one alarm definition file is 250. An export file containing 251 or more alarm definitions cannot be imported as an alarm definition file. To import these alarm definitions, you must divide the export file into multiple alarm definition files, each of which contains no more than 250 alarm definitions.

  For example, assume that you specify the -key option to export alarm tables AlarmTable1 (containing 200 alarm definitions) and AlarmTable2 (containing 100 alarm definitions) that are bound to PFM - Agent or PFM - RM. In this case, 300 alarm definitions will be exported to one file. However, because one alarm definition file can contain a maximum of 250 alarm definitions, the exported file cannot be used as an import file. To import these alarm definitions, you must prepare multiple alarm definition files, each of which contains no more than 250 alarm definitions.

• If the alarm definitions you export include double-byte characters, the LANG environment variable for the shell that is used to execute the command must be set to Japanese (Shift JIS, EUC, or UTF-8) or Simplified Chinese (GB18030 or UTF-8). In addition, the value of that LANG environment variable must be the same as the value of the LANG environment variable that is loaded when PFM - Manager starts. Before you execute this command, make sure that the LANG environment variable setting of the shell and PFM - Manager match.

• If the file name you specify includes double-byte characters, the LANG environment variable for the shell that is used to execute the command must be set to Japanese (Shift JIS, EUC, or UTF-8) or Simplified Chinese (GB18030 or UTF-8). Before you execute this command, check the setting of the LANG environment variable for the shell.

• If PFM - Manager is installed on a logical host, execute the command on the executing node.

• If you specify an alarm table that includes an alarm for which the notification of state changes for each instance has not been specified, Alarm is set for the Notify State label in the alarm definition file to be exported.

• Even if JP1 event issuance is correctly configured in the Command Definition area of the New Alarm > Action Definitions window or the Edit > Action Definitions window, N might be output for the JP1 event label that was exported by using this command (for example, when the value of the -r option is not enclosed in double quotation marks (")). However, JP1 event issuance is actually enabled as the alarm action. There is no problem even if you import the file in which N is output for the JP1 event label because JP1 event issuance is enabled as the alarm action.

• The character encoding of the alarm definition file and the value of the Alarm Definition File Code label in the alarm definition file are determined according to the value of the LANG environment variable for the shell that is used to execute the command. If the alarm definitions to be exported contain non-ASCII characters, check the value of the LANG environment variable in the shell before executing this command.

  The tables below show, for each OS, the character encoding and the value of the Alarm Definition File Code label for each value of the LANG environment variable.

  If the value of the LANG environment variable is not shown in the tables below, the command assumes that the LANG environment variable is set to C.

  Table 3‒45: Correspondence between the value of the LANG environment variable, the character encoding, and the value of the Alarm Definition File Code label (Windows)

  Language	Value of the LANG environment variable	Character encoding	Value of the Alarm Definition File Code label
  Japanese	--	Shift_JIS (SJIS)	Shift_JIS
  English	--	ASCII	C
  Chinese (Simplified)	--	GB18030	GB18030

  Legend:

  --: Not applicable.

  Table 3‒46: Correspondence between the value of the LANG environment variable, the character encoding, and the value of the Alarm Definition File Code label (Linux)

  Language	Value of the LANG environment variable	Character encoding	Value of the Alarm Definition File Code label
  Japanese	ja_JP.SJIS# ja_JP.sjis#	Shift_JIS (SJIS)	Shift_JIS
  	ja_JP.UTF-8 ja_JP.utf8	UTF-8	UTF-8
  English	C	ASCII	C
  Chinese (Simplified)	zh_CN.gb18030	GB18030	GB18030
  	zh_CN.UTF-8 zh.CN.utf8	UTF-8	UTF-8

  #: Available only in SUSE Linux.

To Page Top

Return values

To Page Top

Usage example 1

In this example, alarm table alarmtable1 is not a monitoring template, but is assumed to be defined for PFM - Agent for Platform (UNIX). Alarm table alarmtable1 is also assumed to have alarm alarm1 defined.

The following command exports all the alarm definitions defined for PFM - Agent for Platform (UNIX) to the alarmtable1.cfg file under the /tmp directory:

jpctool alarm export -f /tmp/alarmtable1.cfg -key UNIX

Alarm Definition File Version=0002
Alarm Definition File Code=C
 
[Alarm Data]
[[General]]
Product=U3.0
Alarm Table Name="PFM UNIX Solution Alarms 8.00"
Alarm Name="Disk Service Time"
Message Text="Average disk service time is %CVS secs"
Check Value Exist=N
   :
[Alarm Data]
[[General]]
Product=U4.0
Alarm Table Name=alarmtable1
Alarm Name=alarm1
Message Text=
Check Value Exist=N
   :

To Page Top

Usage example 2

This example exports the Disk Service Time alarm definition to the file alarm2.cfg in the /tmp directory of the alarms defined in the PFM UNIX Solution Alarms 8.00 monitoring template for PFM - Agent for Platform (UNIX).

jpctool alarm export -f /tmp/alarm2.cfg -key UNIX -table "PFM UNIX Solution Alarms 8.00" -alarm "Disk Service Time"

Alarm Definition File Version=0002
Alarm Definition File Code=C
 
[Alarm Data]
[[General]]
Product=U3.0
Alarm Table Name="PFM UNIX Solution Alarms 8.00"
Alarm Name="Disk Service Time"
Message Text="Average disk service time is %CVS secs"
Check Value Exist=N
   :

To Page Top

Usage example 3

This example outputs the alarm definition file template to the template3.cfg file under the /tmp directory:

jpctool alarm export -f /tmp/template3.cfg -template

Alarm Definition File Version=0002
Alarm Definition File Code=
 
[Alarm Data]
[[General]]
Product=
Alarm Table Name=
Alarm Name=
Message Text=
Check Value Exist=N
 
[[Advanced Setting]]
Active Alarm=Y
Regular Alarm=Y
Evaluate All Data=N
Notify State=Alarm
Monitoring Regularly=N
Monitoring Time=
Damping=N
Damping Count=
 
[[Check Value Exist]]
Record=
Field=
Value=
 
[[Alarm Condition Expressions]]
Condition=
 
[[Actions]]
Report=
E-mail=Abnormal,Warning,Normal
Command=Abnormal,Warning,Normal
SNMP=Abnormal,Warning,Normal
JP1 Event=N
 
[[Action Definition E-mail]]
E-mail Address=
Action Handler=
[[[Message Text]]]
Date: %SCT
Host: %HNS
 
Product: %PTS
Agent: %ANS
 
Alarm: %AIS (%ATS)
State: %SCS
 
Message: %MTS
[[Action Definition Command]]
Command Name=
Action Handler=
[[[Message Text]]]
 
[[Action Definition JP1 Event]]
Event ID=
Action Handler=
Message=%MTS
Switch Alarm Level=Y
Exec Logical Host=

To Page Top