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 destination configuration XML specification

Use the EventDest, Server, and Destination elements in the EIF destination XML file to configure the destination servers for the EIF events sent by the monitoring agent.


Elements

The elements and their attributes are not case-sensitive. For example, you can enter EVENTDEST=, EventDest=, or eventdest=.

<EventDest>

EVENTDEST is the root element identifying this as an event destinations definition for the monitoring agent.

<Destination>

Start of an event destination definition. Specify the destination index. Optional attributes enable you to specify the destination type, a default server, the maximum cache file size, and the option to clear the cache file on restart.

  • id= Required. Destination index, from 0 to 999. Default: 0
  • type= Optional. Destination type: T=IBM Tivoli Enterprise Console; M=Netcool/OMNIbus. The maximum event size generated will be 4K and 32K for type=T and type=M, respectively. Default: T
  • default= Optional. The server entered here is designated as the default destination. Default: N
  • clear_cache= Optional. Use this attribute to specify whether the existing EIF cache file should be cleared when the destination is instantiated. clear_cache="Y" will cause the EIF event cache file to be cleared. On z/OS systems, the EIF event cache is always cleared because z/OS EIF supports only an in core event cache. Default: Y
  • max_cache_size= Optional. Specifies the maximum event cache physical file size in kilobytes. Default: 4096
  • stat= Optional. Specify whether the destination shall receive life cycle events. Default: N
  • master_reset= Optional. Specify whether a master reset event shall be sent during agent startup. Default: N

<Server>

Defines the event servers for the destination: one primary and up to seven secondary servers. Specify each event server hostname or IP address and the port. The first <server> definition is the primary listener. Any additional <server> definitions are backup servers.

  • location= Specifies the hostname or IP address of the event listener.
  • port= Optional. Specifies the listening port of the IBM Tivoli Enterprise Console event server or Netcool/OMNIbus Probe for Tivoli EIF. The default port number for the IBM Tivoli Enterprise Console event server is 5529. However, a setting of port=0 can be used for a IBM Tivoli Enterprise Console on Linux or operating systems such as UNIX and indicates that the event listener is using portmapper. The default port number for the EIF Probe is 9998. If no value is specified, the port number is defaulted to 0 in the server location definition.
  • SSL= Optional. Specify whether events will be sent encrypted over a Secure Socket Layer (SSL) connection or events will be sent unencrypted over a non-SSL connection. SSL connections are only supported for Netcool/OMNIbus event destinations (type="M"). If enabled for a IBM Tivoli Enterprise Console event destination (type="T"), a default non-SSL connection is used. Specify Y to enable, and N to disable. Default: N.

<StatEvent>

Optional. Use the StatEvent element to send the online or offline status of the agent to the event server. By default, heartbeat monitoring is disabled.

  • name= Specifies the name of the heartbeat event.
  • interval= Optional. The interval, expressed in minutes, at which the heartbeat event is sent. A zero interval means no heartbeats are to be sent. Default: 15.

Examples: Both stanzas name the heartbeat event, EE_HEARTBEAT. The first stanza specifies a 5-minute interval and the second stanza disables the heartbeat event. 

    <StatEvent name="EE_HEARTBEAT" interval="5"/>

    <StatEvent name="EE_HEARTBEAT" interval="0"/>

The destination server receives an EIF event with a class name of "ITM_Heartbeat" containing a slot called "interval" whose value is the heartbeat interval. SNMP events received contain an attribute "AlertGroup" whose value is "ITM_Heartbeat" and an attribute "HeartbeatInterval" whose value is the heartbeat interval. You can customize the provided heartbeat rules or write your own to handle the heartbeat events.

Note: Multiple EE_HEARTBEAT events are not supported. If multiple destinations are configured to receive EE_HEARTBEAT, the same EE_HEARTBEAT is sent to each destination.


Example

The following example is an event destination configuration file containing one event destination:

The following example is an event destination configuration file containing two event destinations:

Here, the second destination will not receive life cycle events because stat parameter is set to "N".

The following example is an event destination configuration file containing two event destinations defined to use SSL connections:

Here, the second destination illustrates that the same SSL value is not required when multiple server locations are defined where a SSL connection is used for the primary server and a non-SSL connection is used for the secondary server.

Tip: Sample EIF files are provided on the Tivoli Monitoring Agent installation media in the PrivateConfigSamples/EIF directory.


Parent topic:

EIF events

Related reference:

UTF-8 encoded XML files
EIF heartbeat event

+

Search Tips   |   Advanced Search