jpctool alarm list

Organization of this page

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

Format

jpctool alarm list    {-key service-key
                      [-table alarm-table-name]| -id service-ID}
                      [-wait number-of-seconds]

To Page Top

Function

The jpctool alarm list command displays the definitions or the bind information of alarm tables and alarms.

The following table shows what is displayed depending on the combination of the -key and -table options that is specified.

Table 3‒84: Information that is displayed depending on the combination of options that is specified
Option specifications			Information that is displayed
-key	-table	-id	Information that is displayed
S	N	N	A list of the names of the alarm tables defined in the PFM - Agent or PFM - RM specified in the `-key` option is displayed. The names of the individual alarms are not displayed.
S	S	N	A list of the names of the alarms defined in the alarm table specified in the `-table` option is displayed with the information of whether each alarm is enabled or disabled, and with a list of the names of the agents to which the alarm table is bound.
N	N	S	A list of alarm tables to which the agent is bound.

Legend:

S: Specified

N: Not specified

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 whose alarm definition information is to be displayed. 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 whose alarm definition information is to be displayed.

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

Wildcard characters cannot be used.

`-id` `service-ID`

Specifies the service ID of the Agent Collector service, Remote Monitor Collector service, remote agent, or group agent. Wildcard characters (asterisks (*) and question marks (?)) cannot be used. For service-ID, specify a string of 1 to 258 bytes of characters. An error will occur if the specified service ID does not exist.

`-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 the alarm definitions you display 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.

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 alarm definitions are to be displayed has not been set up.
`6`	The specified alarm table was not found.
`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

Displayed information

The following table lists the information displayed when the jpctool alarm list command is executed.

Table 3‒85: Information displayed when the jpctool alarm list command is executed
No.	Displayed information	Whether or not displayed depending on option specifications			Description
No.	Displayed information	-key	-key, -table	-id	Description
1	Product ID	D	D	N	Product ID indicating the type of PFM - Agent or PFM - RM. For details about the product IDs of PFM - Agents or PFM - RM, see the list of identifiers provided in the appendix of the PFM - Agent or PFM - RM manuals.
2	DataModelVersion	N	D	N	Data model version.
3	Alarm Table Name	D	D	N	Alarm table name.
4	Alarm Name	N	D	N	Alarm name and whether the alarm is enabled or disabled: `active`: Alarm is enabled `inactive`: Alarm is disabled
5	The Bound Agent	N	D	N	Service ID of the agent to which the alarm table is bound.
6	Service ID	N	N	D	Service ID
7	Bound Alarm Table Name	N	N	D	Name of the bound alarm table.

Legend:

-key: Only the -key option is specified.

-key, -table: The -key and -table options are both specified.

D: Indicated information is displayed.

N: Indicated information is not displayed.

To Page Top

Usage example 1

This example assumes that alarm table alarmtable1 is not a monitoring template, but is to be defined for PFM - Agent for Platform (UNIX).

The following command displays a list of alarm tables defined in PFM - Agent for Platform (UNIX):

jpctool alarm list -key UNIX

Output result 1

Product ID:U
Alarm Table Name:
  alarmtable1
  PFM UNIX Solution Alarms 7.50
  PFM UNIX Solution Alarms 8.00

To Page Top

Usage example 2

This example assumes that the PFM UNIX Solution Alarms 8.00 monitoring template is bound to host hostA and host hostB for PFM - Agent for Platform (UNIX).

The following example displays a list of alarms and list of bound agents defined in the PFM UNIX Solution Alarms 8.00 monitoring template for PFM - Agent for Platform (UNIX).

jpctool alarm list -key UNIX -table "PFM UNIX Solution Alarms 8.00"

Output result 2

Product ID:U
DataModelVersion:6.0
Alarm Table Name:PFM UNIX Solution Alarms 8.00
Alarm Name:
  Disk Service Time   [active]
  I/O Wait Time       [active]
  Kernel CPU          [active]
  Pagescans           [active]
  Run Queue           [active]
  Swap Outs           [active]
  User CPU            [active]
 
The Bound Agent:
  UA1hostA
  UA1hostB

To Page Top

Usage example 3

This example assumes that the PFM UNIX Solution Alarms 6.70 monitoring template and user-defined alarm table alarmtable1 are bound to host hostA for PFM - Agent for Platform (UNIX).

The following example displays a list of alarms tables bound to hostA.

jpctool alarm list -id UA1hostA

Output result 3

Service ID:UA1hostA
Bound Alarm Table Name:
   alarmtable1
   PFM UNIX Solution Alarms 6.70

To Page Top