jpctool alarm inactive

Organization of this page

Format
Function
Hosts that can execute the command
Execution permission
Installation directory
Arguments
Note
Return values
Usage example 1
Usage example 2

Format

jpctool alarm inactive     -key service-key
                           -table alarm-table-name
                           -alarm alarm-name
                           [-wait number-of-seconds]

To Page Top

Function

The jpctool alarm inactive command disables an enabled alarm.

The command disables alarms individually. It cannot disable all alarms in an alarm table at once.

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

`-key` `service-key`

Specifies the service key of the PFM - Agent or PFM - RM for which an alarm definition is to be disabled. 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` `alarm-table-name`

Specifies the name of the alarm table in which the alarm to be disabled is defined.

For 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` `alarm-name`

Specifies the name of the alarm to be disabled.

The command terminates normally even if the specified alarm has already been disabled.

For alarm-name, 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).

To Page Top

Note

This command cannot be executed concurrently.
This command cannot be executed if any of the Name Server, Master Manager, and View Server services is stopped.
If arguments of a jpctool alarm command 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 settings of the shell and PFM - Manager match.
If PFM - Manager is installed on a logical host, execute the command on the executing node.
When performing multiple monitoring, you cannot execute this command from the secondary PFM - Manager host.
It might take several tens of seconds until this command takes effect on the agent after this command has terminated.

To Page Top

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 for which alarms are to be disabled 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`	A file or directory cannot be accessed.
`222`	A communication error occurred.
`223`	Communication processing resulted in a timeout.
`255`	An unexpected error occurred.

To Page Top

Usage example 1

This example disables the Disk Service Time alarm defined in the PFM UNIX Solution Alarms 8.00 monitoring template for PFM - Agent for Platform (UNIX).

jpctool alarm inactive -key UNIX -table "PFM UNIX Solution Alarms 8.00" -alarm "Disk Service Time"

To Page Top

Usage example 2

This example disables the alarm1 alarm that is defined in the alarmtable1 alarm table for PFM - Agent for Platform (UNIX):

jpctool alarm inactive -key UNIX -table alarmtable1 -alarm alarm1

To Page Top