jpcimevt

Organization of this page

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

Format

jpcimevt   [-i event-ID]
           [-m message]
           [-s alarm-status]
           [[-e extended-attribute-name=extended-attribute-value]...]
           [-r event-server-name]

To Page Top

Function

The jpcimevt command registers a JP1 event in the event server and sends the registered event to JP1/IM.

This command can be used when issuing a JP1 event as an alarm action. For details about how to issue a JP1 event as an alarm action, see the chapter describing alarm definitions and manipulation in the JP1/Performance Management User's Guide.

To Page Top

Hosts that can execute the command

PFM - Manager
PFM - Agent
PFM - RM

To Page Top

Execution permission

In Windows:: None
In UNIX:: None

To Page Top

Installation directory

In Windows:

installation-folder\tools\

In UNIX:

/opt/jp1pc/tools/

To Page Top

Arguments

`-i` `event-ID`

Specifies the event ID of the JP1 event to be registered, as a hexadecimal number in the range from 0 to 1fff or 7fff8000 to 7fffffff. If you omit this argument, 0 is assumed.

`-m` `message`

Specifies a message text for the JP1 event that is to be registered. For message, specify a string of 1 to 1023 bytes. Note that if you issue a JP1 event with the Action Handler service whose version is 09-00 or earlier, the length of the message text must be from 0 through 128 bytes.

If the message contains spaces, enclose the entire message in double quotation marks ("). If this argument is omitted, no message text is recorded. In the New Alarm > Action Definitions window or the Edit > Action Definitions window, if you specify %MTS for Command Definition, you can send the message text set in the alarm to JP1/IM.

`-s` `alarm-status`

Specifies an alarm status. This alarm status is converted to a JP1 event level. To convert the value of the -s option to a JP1 event, specify %SCS for Command Definition in the New Alarm > Action Definitions window or the Edit > Action Definitions window. The following table shows the values that can be specified in the -s option and the values after conversion:

Specifiable value	Description	JP1 event level
`"OK"`	Alarm status is normal (green)	`"Information"`
`"WARNING"`	Alarm status is warning (yellow)	`"Warning"`
`"EXCEPTION"`	Alarm status is abnormal (red)	`"Error"`

If you specify both the -s and -e options to define the event level, the -s option takes precedence. If you omit both the -s and -e options, nothing is set for the JP1 event level.

`-e` `extended-attribute-name`=`extended-attribute-value`

Specifies an extended attribute to be registered in the JP1 event. You can specify multiple sets of -e extended-attribute-name=extended-attribute-value. If a specified extended attribute name or extended attribute value contains a space, enclose the entire name or value in double quotation marks ("). There must be no spaces immediately before or after the equal sign (=).

The operation cannot be guaranteed if the same extended attribute is specified more than once.

`-r` `event-server-name`

Specifies the name of the event server in which the JP1 event is to be registered. For event-server-name, specify a string from 1 to 255 bytes.

Only an event server that is running at the local host can be specified. You specify this option when you are using JP1/Base in a cluster system.

If this option is omitted, the same event server name as the local host is assumed.

To Page Top

Notes

JP1/Base must be installed on the host that issues the JP1 event as an alarm action.
To issue JP1 events, you must first start the JP1/Base event server.
If the length of the message text exceeds 1,023 bytes, the message text will be truncated so that the length does not exceed 1,023 bytes. If truncation occurs, a KAVE05418-W message is output. Note that in the Action Handler service whose version is 09-00 or earlier, if the message text is longer than 128 bytes, an error occurs and no JP1 event is issued. At this time, a KAVE05223-E message is output.

To Page Top

Return values

0	The command terminated normally.
1	An argument specification is invalid.
200	A memory shortage occurred.
211	The file cannot be accessed.
250	An attempt to send a JP1 event failed.
255	An unexpected error occurred.

To Page Top

Usage example

This example registers an event whose event ID is 111, alarm status is OK, extended attribute name is EXTATTR, and extended attribute value is Extend Value:

jpcimevt -i 111 -s OK -e EXTATTR="Extend Value"

To Page Top