Hitachi

JP1 Version 12 JP1/Performance Management Reference


jpctool alarm copy

Organization of this page

Format

jpctool alarm copy  -key service-key
                    -table source-alarm-table-name
                   [-alarm copy-source-alarm-name]
                    -name copy-destination-alarm-table-name-or-
                          copy-destination-alarm-name
                    [-wait number-of-seconds]

Function

The jpctool alarm copy command copies an alarm table or an alarm.

The following table shows what is copied (alarm table or alarm) depending on the combination of the -table and -alarm options that is specified:

Table 3‒42: Copy target (alarm table or alarm) depending on the combination of options that is specified

Option specifications

Information that is copied

-table

-alarm

S

N

The entire alarm table specified in the -table option is copied. If the alarm table contains multiple alarms, all its alarms are copied.

S

S

The alarm specified in the -alarm option in the alarm table specified in the -table option is copied.

Legend:

S: Specified

N: Not specified

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

-key service-key

Specifies the service key of the PFM - Agent or PFM - RM whose alarm table or alarm is to be copied. A product name can also be specified when the product name display functionality is enabled. You can specify only the service key of PFM - Agent or PFM - RM here. For details about the service key of the PFM - Agent or PFM - RM, see the naming rules described in the appendix of the JP1/Performance Management Planning and Configuration Guide.

-table source-alarm-table-name

Specifies the name of the source alarm table.

For source-alarm-table-name, specify a string of 1 to 64 bytes, consisting of 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.

Wildcard characters cannot be used.

-alarm source-alarm-name

Specifies the name of the source alarm.

For source-alarm-name, specify a string of 1 to 20 bytes long, consisting of 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.

Wildcard characters cannot be used.

Note that this option cannot be specified if the -table option was used to specify a monitoring template (alarm table with a name starting with PFM).

-name target-alarm-table-name-or-target-alarm-name

Specifies a name for the copy of the alarm table or alarm.

This cannot be the name of an existing alarm table or alarm.

If you specified only the -table option, specify a name for the copy of the alarm table. In this case, specify a string of 1 to 64 bytes long, consisting of 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.

An alarm table name beginning with PFM cannot be specified.

Wildcard characters cannot be used.

If you specified both the -table and -alarm options, specify a name for the copy of the alarm. In this case, specify a string of 1 to 20 bytes, consisting of 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.

Wildcard characters cannot be used.

-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).

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

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. Alternatively, the agent to which alarms are to be copied has not been set up.

Or else, an attempt was made to execute the command from the secondary PFM - Manager host when multiple monitoring is performed.

6

The specified alarm table or alarm is missing.

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

The specified target alarm table cannot be edited.

222

A communication error occurred.

223

Communication processing resulted in a timeout.

255

An unexpected error occurred.

Usage example 1

This example copies the PFM UNIX Solution Alarms 8.00 monitoring template from PFM - Agent for Platform (UNIX) to the alarm table named alarmtable1.

jpctool alarm copy -key UNIX -table "PFM UNIX Solution Alarms 8.00" -name alarmtable1

Usage example 2

This example copies the alarm1 alarm in the alarmtable1 alarm table for PFM - Agent for Platform (UNIX) and names the copy alarm2:

jpctool alarm copy -key UNIX -table alarmtable1 -alarm alarm1 -name alarm2