Hitachi

JP1 Version 12 JP1/Performance Management Reference


jpctool alarm check

Organization of this page

Format

jpctool alarm check     -f alarm-definition-file-name
                       [-syntax]
                       [-wait number-of-seconds]

Function

The jpctool alarm check command performs validity checking, such as checking the created alarm definition file for syntax errors, checking the definition information (to determine whether or not specified records and fields are supported), and checking the setup status of the required PFM - Agent or PFM - RM. To check the definition information and the setup status of the PFM - Agent or PFM - RM, the Name Server, Master Manager, and View Server services must be running. To perform only syntax checking without checking the definition information or the PFM - Agent or PFM - RM setup status, specify the -syntax option. When the -syntax option is specified, the command can be executed even when the Name Server, Master Manager, and View Server services are stopped.

If there is an error in the syntax of the alarm definition file or in the definition information, the command displays an error message containing the row number in the file and the nature of the error. If there is more than one error, the command displays an error message for each error.

Hosts that can execute the command

PFM - Manager

Execution permission

In Windows:

User with Administrators permissions

In UNIX:

User with root user permissions

Installation directory

In Windows:
installation-folder\tools\
In UNIX:
/opt/jp1pc/tools/

Arguments

-f alarm-definition-file-name

Specifies the name of the alarm definition file to be checked. The file name can be expressed as a relative path or an absolute path.

The string you specify can have double-byte characters, single-byte alphanumeric characters, single-byte spaces, and the following single-byte symbols:

% - ( ) _ . @ [ ]

If the value contains a space, enclose the entire value in double quotation marks ("). If the value contains a defined symbol, specify an escape character if necessary.

-syntax

Specifies that the alarm definition file is to be checked only for syntax errors.

-wait number-of-seconds

Specifies the maximum wait period (in seconds) applied when a command that cannot be executed with this command is running. When the setting to suspend execution of alarm commands (Alarm Command Wait Mode) is enabled in the startup information file (jpccomm.ini), if you want to specify a wait period (in seconds) separately from the wait period specified in the jpccomm.ini file, specify a value in the range from 1 to 3,600 for this option.

If you omit the option, this command runs with the wait period (in seconds) specified in the jpccomm.ini file.

For details on the commands that cannot be executed with this command, see Commands that cannot be executed with alarm commands. For details on the jpccomm.ini file and Alarm Command Wait Mode, see Startup information file (jpccomm.ini).

Alarm definition file format

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

Notes

Return values

0

The command terminated normally.

1

An argument specification is invalid.

2

The user does not have execution permission for the command.

3

When the -syntax option is omitted, at least one of the Name Server, Master Manager, and View Server services is not running.

4

The startup stop command or another setup command was executed on the same machine.

5

The command was executed on a host that is not the PFM - Manager host.

6

There is an error in the contents of the alarm definition file.

11

The user canceled the processing.

100

The Performance Management environment is invalid.

200

A memory shortage occurred.

210

A disk space shortage occurred.

211

Alarm definition file cannot be accessed.

222

A communication error occurred.

223

Communication processing resulted in a timeout.

255

An unexpected error occurred.

Usage example 1

This example checks the syntax of the alarmtest1.cfg alarm definition file stored in the /tmp directory, and the validity of the definition information:

jpctool alarm check -f /tmp/alarmtest1.cfg

Usage example 2

This example checks only the syntax of the alarmtest2.cfg alarm definition file stored in the /tmp directory:

jpctool alarm check -f /tmp/alarmtest2.cfg -syntax