EVENT_EXT Configuration Syntax

SUBSYS EVENT_EXT

COLLECTOR ( <$collector-process>[, <filter-file>, ...])
MAX-EVENTS (<num>)
EMS-BACK (<minutes>)
TOKEN (<name>, <id>, <type>)
EVENT (<Group-Name>, <Symbolic-Name>, [<SSID>], [<Event#>], [<Where>], [<TextOffset>], [<UserField1>], [<UserField2>], [<UserField3>], [<UserField4>], [<UserField5>], [PassThru-Flag], [Frequency], [Interval], [Key])

Syntax Elements

COLLECTOR ( <$collector-process>[, <filter-file>, ...])

A COLLECTOR statement is used to define each instance of an EMS collector/consumer-distributor combination and its associated filter parameters. These details are passed to the EMSDIST consumer distributor started by the IREMSEXT process.

<$collector-process>

Specifies the EMS collector to monitor.

<filter-file>

If specified, the filter-file parameter defines the name of a filter or set of filters that are to be passed to the EMSDIST consumer distributor associated with the target EMS collector process. The types of filters that can be passed are those supported by EMSDIST:

1) filter object file compiled by EMF - file code 845

2) Burst Detection and Suppression text file(s) - BDS, file code 101

3) Filter table text file(s) - file code 101

If this parameter is omitted, then the consumer EMSDIST distributor started by STEMS will not have any event filtration (i.e. all events it processes will be passed to IREMSEXT).

MAX-EVENTS (<num>)

<num>

Maximum number of events that IREMSEXT will keep in memory for online users. Default = 32,000.

EMS-BACK (<minutes>)

The EMS-BACK statement specifies the number of minutes that the EMS collector will look back in the EMS logs (listed in COLLECTOR keywords) for EMS event information. Although the EMS event review process is optimized to reduce performance requirements, setting a large number of minutes in the EMS-BACK statement can impact system performance if the EMS log contains too many events. Default = 0 (no look back)

TOKEN (<name>, <id>, <type>)

 <name>

Name of token, max length 32 characters.

<id>

Numeric value of the token name used by EMS function calls.

<type>

'S' - String, 'N' - Numeric or 'U' - User Id. Required to determine how to treat the value returned by the token. All tokens in ZEMSC have been made available to the collector and do not need to be defined.

All user-defined tokens are scanned first during event matching, token ids can belong to more than one token name.


EVENT (<Group-Name>, <Symbolic-Name>, [<SSID>], [<Event#>], [<Where>], [<TextOffset>], [<UserField1>], [<UserField2>], [<UserField3>], [<UserField4>], [<UserField5>], [PassThru-Flag], [Frequency], [Interval], [Key])

The EVENT statement is used to specify which EMS events the IREMSEXT collector will process. If an EMS event does not match the above criteria it will be ignored/dropped. EMS events will be processed against the order of which EVENT definitions occur.

If any parameter is omitted from this statement, the corresponding comma separators (,) must be included.

<Group-Name>

Group name assigned to events that match the criteria. Non-unique, used to group like events. Max 32 bytes.

<Symbolic-Name>

Symbolic name assigned to events that match the criteria. Must be unique. Max 64 bytes.

<SSID>

HPE NonStop SubSystem Identifier to match against. Supports * as a wildcard, e.g. Prognosis.*.*.

This parameter is optional, the default is: *.*.*

 <Event#>

EMS event number to match the event against. Optional, if not defined means match on any event number.

<Where>

Where Clause used to match against any EMS tokens,

Example: '@ZEMS_TKN_TEXT CONTAINS "PROGNOSIS"

String tokens can also have a number range specified so that only a certain portion of the token is evaluated. Syntax is [n1:n2], placed immediately following the token name with no spaces allowed; n1 = From, n2 = To.

<TextOffset>

Returns the EMS text field starting from this character position.

This parameter is optional, if not defined text will be returned from the beginning.

 <UserField>

Five 'user fields' have been provided so that the return text from these fields can be defined using combinations of EMS Tokens and free form text,

Example: TEXT = @ZEMS_TKN_TEXT[n1:n2]; USER-ID = @ZEMS_TKN_USERID;....

String tokens can also have a number range specified so that only a certain portion of the token is returned. Syntax is [n1:n2] placed immediately following the token name with no spaces allowed; n1 = From n2, = To.

User Fields 1 and 2 are 64 bytes.

User Fields 3, 4 and 5 are 254 bytes.

<PassThru-Flag>

Y' or 'N'. If an EMS event matches the above criteria, either process the event (Y) or ignore the event (N).

Default = Y.

The following optional parameters are used for event counting/aggregation/suppression. Only EMS events that match an EVENT entry will have a NonStopEventEMSExtended (EVENTEXT) record generated. If the EMS event does not match or a matching EVENT entry has the <PassThru-Flag> field set to 'N' the EMS event will be dropped.

<Frequency>

The number of times the event must occur before a Record is generated.

<Interval>

Time in seconds that the events must occur before a Record is generated. This is a sliding time window.

<Key>

The <Key> parameter can be made up of one or more fields from the NonStopEventEMSExtended (EVENTEXT) record. Any combination of fields can be specified by using either the Long or Short field name.

This parameter is optional, the default is: SymbolicName (SYMNAME)

Syntax: <field-name>+<field-name>+...

Example: EVENTNUM+TEXT+FLD1

Valid fields are:


Long-Name

SymbolicName

EventNumber

SSIDOwner

SSIDName

SSIDNumber

SSIDVersion

ProcessDescriptor

EventText

Field1

Field2

Field3

Field4

Field5

Short-Name

SYMNAME (+)

EVENTNUM

SSIDOWN

SSIDNAME

SSIDNUMB

SSIDVER

PROCDESC

TEXT

FLD1

FLD2

FLD3

FLD4

FLD5


(+) Default key when key option is not specified as part of Frequency and Interval.



Provide feedback on this article