Hitachi

JP1 Version 12 JP1/Base User's Guide


jevsend

Organization of this page

Function

The jevsend command registers a JP1 event in an event server.

Format

jevsend [-i event-ID]
        [-m message]
        [[-e extended-attribute-name=extended-attribute-value]...]
        [-d destination-event-server-name]
        [-s source-event-server-name]

Required execution permission

In Windows: None.

In UNIX: None.

Command directory

In Windows:

installation-folder\bin\

In UNIX:

/opt/jp1base/bin/

Arguments

-i event-ID

Specify the event ID of the JP1 event to be registered. The specifiable range is 0 to 1FFF, and 7FFF8000 to 7FFFFFFF. If you omit this option, the default is 0.

-m message

Specify the message text of the JP1 event to be registered. The length of the message text can be no more than 1,023 bytes.

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

Specify the extended attributes of the JP1 event to be registered. Specify the attributes in separate lines, in the form -e extended-attribute-name=extended-attribute-value. Do not insert a blank (such as a space or tab character) between the equals sign and extended attribute value. Extended attributes are a set of no more than 100 of the following items. The total length of all the attribute values must not exceed 10,000 bytes.

Extended attribute

Contents

Format

Extended attribute name

Name that expresses the attribute meaning.

Character string of no more than 32 bytes, consisting of alphanumeric characters, and underscores (first character an alphabetic character; all characters upper case)

Extended attribute value

Contents of the attribute

Character string (0 to 10,000 bytes)

JP1 events with SEVERITY specified as an extended attribute name are listed in the Event Console window of JP1/IM - View. For the SEVERITY extended attribute, specify one of the values listed in 17.1.2 Extended attributes. Be sure to write the first character in upper case.

-d destination-event-server-name

Specify an event server name if you want to send the JP1 event to a different event server than the server specified in the forwarding settings file (forward). Specify the event server name as a character string of no more than 255 bytes.

Notes
  • No error occurs if the specified event server is undefined, inactive, or unreachable due to a network failure.

  • A JP1 event forwarded with this option specified cannot be acquired from the event server of the local host.

  • When the event server of a remote host is specified in this option, the retry setting in the forward-limit parameter in the event server settings file (conf) does not apply to event forwarding.

  • Do not specify any event server names that are specified for -s (or ones that are assumed when the option is omitted). Specifying the same event server name for -s and this option causes unnecessary event forwarding, which increases the risk that JP1 events cannot be registered due to forwarding errors.

-s source-event-server-name

When the -d option is specified, this option sets the event server to be used for forwarding the event. When the -d option is omitted, this option sets the event server for registering the event. You can only specify an event server that runs on the local host. If you omit this option, the logical host name set in the environment variable JP1_HOSTNAME is assumed as the event server name. If the environment variable JP1_HOSTNAME is not set, the event server name is assumed to be the same as the local host name. Specify the event server name as a character string of no more than 255 bytes.

This option is primarily for use in a cluster system.

Notes

Return values

0

Normal end

1

Invalid argument

255

Other error

Example

Example 1

Register the JP1 event that has the event ID 111, and that outputs a message reading "BaseEvent_Sample."

jevsend -m BaseEvent_Sample -i 111
Example 2

Register the JP1 event that has the event ID 111, and that has extended attribute name EXTATTR and extended attribute value Extend Value.

jevsend -i 111 -e EXTATTR="Extend Value"
Example 3

Register the JP1 event that has the following extended attributes:

  • Extended attribute name EXTATTR and extended attribute value extattr

  • Extended attribute name INCLUDESPACE and extended attribute value include space

jevsend -e EXTATTR=extattr -e INCLUDESPACE="include space"
Example 4

Register the JP1 event that has the event ID 111, and that has the extended attribute name SEVERITY and extended attribute value Information.

jevsend -i 111 -e SEVERITY=Information