EIF event configuration

IBM Tivoli Monitoring > Version 6.3 Fix Pack 2 > Administrator's Guide > Agent-based services > EIF events
IBM Tivoli Monitoring, Version 6.3 Fix Pack 2

EIF event configuration

Configure a monitoring agent and a local EIF event configuration XML file to emit life cycle events or private situation events, or both, to one or more EIF receivers such as the IBM Tivoli Enterprise Console event server or Netcool/OMNIbus Probe for Tivoli EIF.
Restriction: EIF is not supported on iSeries to send events directly from the iSeries agents.
Usage note: In code examples below use the following substitutions:

<install_dir> is the directory where IBM Tivoli Monitoring is installed

<pc> is the agent 2 letter product code in lowercase

<PC> is the agent 2 letter product code in uppercase
EIF event configuration

The default setting of the IRA_EVENT_EXPORT_EIF environment variable is Y, which causes the EIF emitter to start during agent startup. The following files must be present and configured on the system where the monitoring agent is installed before EIF event forwarding can take place:

A private situation configuration file to define the situations that generate events when the comparison criteria evaluate to true. The private situations are started and stopped as part of the agent startup and shutdown procedure.

An event destination configuration file to define the event listeners for receiving the EIF emitted events.
Additionally, you can have an event mapping file to control the event data being sent to the EIF receiver.

Agent parameters

IRA_EVENT_EXPORT_EIF=Y parameter in the agent environment file is set to enable the EIF event export facility. Change the value to N to disable the facility.

IRA_EIF_DEST_CONFIG=<filename> parameter in the agent environment file is set to specify the location of the EIF destination configuration XML file. The default is <install_dir>/localconfig/<pc>/<pc>_eventdest.xml.

IRA_LOCALCONFIG_DIR parameter in the agent environment file can be set to specify a different directory path for the EIF destination or optional event mapping file, or both. The default is <install_dir>/localconfig/<pc>.

IRA_EIF_MSG_LOCALE=en_US parameter in the agent environment files is set to American English by default. For agents that support globalized message text for the message slot in the generated event using a predefined mapping file and language resource bundles, the default language locale can be specified.

Agent EIF event destination configuration XML specification

The EIF event destination XML file is used to specify the event destination server or servers and their configurations. The root element is <EventDest> and contains <Destination> and <Server> elements, as well as the optional <StatEvent> element to configure the EIF heartbeat interval: how often the agent sends a heartbeat event to the EIF receiver.

The event destination configuration file resides in the following default location:

<install_dir>\localconfig\<pc>\<pc>_eventdest.xml

<install_dir>/localconfig/<pc>/<pc>_eventdest.xml

RKANDATV, with member name <PC>EVDST

Agent EIF event mapping configuration XML specification

The optional EIF event mapping file configuration XML file can be used to customize the EIF events that are generated. If no event mapping file is provided, events are formatted by generic mapping. Event mapping files can be product provided or user defined. User defined event maps, if any, have precedence over product provided maps. The name and location of the predefined event mapping file, if any:

<install_dir>\TMAITM6\EIFLIB\k<pc>.map for 32-bit agents; <install_dir>\TMAITM6_x64\EIFLIB\k<pc>.map for 64-bit agents.

<install_dir>/<platform>/<pc>/tables/EIFLIB/k<pc>.map

RKANDATV, with member name K<PC>MAP.
If you create a user defined event mapping file, store it in the following location:

<install_dir>\localconfig\<pc>\<pc>_eventmap.map

<install_dir>/localconfig/<pc>/<pc>_eventmap.map

RKANDATV, with file name <PC>EVMAP
Sample event map configuration file:
<?xml version="1.0" encoding="UTF-8"?>
<itmEventMapping:agent>
   <event_mapping>                                                             
      <situation name="Flipper*" mapAllAttributes="Y">
         <class name="ITM_ABC"/>
            <slot slotName="msg">
               <literalString value="The time now is 
               $Local_Time.Timestamp.TIMESTAMP$ on $hostname$"/>
            </slot>
      </situation>
   </event_mapping>
</itmEventMapping:agent>
Heartbeat event of agent's online status sent to the EIF event receiver

The EventDest configuration XML file has an optional element for specifying a heartbeat interval. After each interval, the agent status is tested and the result then sent as online-offline status to the EIF receiver (or receivers) specified in the EventDest file.

Tivoli Enterprise Monitoring Agents installed before Version 6.2.2 Fix Pack 1

When a Tivoli Monitoring Version 6.2.2 Fix Pack 1 or later OS agent of has been installed, any Tivoli Enterprise Monitoring Agents installed on that computer are eligible to use the autonomous EIF event forwarding feature, even if they were installed prior to Version 6.2.2 Fix Pack 1. Be aware, however, that monitoring agents that were installed before Version 6.2.2 Fix Pack 1 need some files that were not included in the agent install bundle but that are part of the application support provided for a Tivoli Enterprise Monitoring Server installation: the baroc file, optional event mapping file, and resource bundle files. For these earlier version agents to use the EIF facility to forward events, the following steps must be taken:

Install the earlier version agent in a monitoring server environment to access the baroc and optional event mapping files. The agent predefined baroc and optional event mapping files can be found in the <install_dir>/CMS/TECLIB or <install_dir>/CNPS/teclib directory.

Copy the provided k<pc>.map event mapping file, if any, to the EIFLIB directory of the agent installation.

If the Tivoli Enterprise Console event server is used as an event receiver, copy the baroc file for each agent to the system where the event server is installed. Compile and load the baroc on the event server.

Agents running within the hub Tivoli Enterprise Monitoring Server Address Space on z/OS

On z/OS systems it is possible to configure agents to run within the same address space of the hub monitoring server. Because the EIF event forwarder function (OTEA) can also be enabled at the hub monitoring server, some precautions must be taken to avoid the cross interference between the Event Forwarder at the hub monitoring server and the EIF event export directly from the monitoring agent. One area that can have potential overlap is a custom event mapping file. Currently on the hub monitoring server, users can code their own event mapping (in addition to those that can be created using the Tivoli Enterprise Portal Situation editor and stored in a monitoring server table). The name of these map files must be in the form, Q<xx>MAP (where <xx> is any two alphanumeric characters), and reside in the RKANDATV dataset. In order to support user defined event mapping files for autonomous agents, which also reside in the RKANDATV data set, a different naming convention must be adopted. For user defined event mapping files for autonomous agents, the file naming convention is <pc>EVMAP (where <pc> is the 2 letter agent product code).
Parent topic:
EIF events

+
Search Tips | Advanced Search