creating eif events with tivoli directory integrator for tivoli netcool-omnibus and tivoli...

Upload: bupbechanh

Post on 05-Apr-2018

228 views

Category:

Documents


2 download

TRANSCRIPT

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    1/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    2/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    3/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    4/28

    4 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    management systems and applications, Tivoli Netcool/OMNIbus minimizes deployment timeand enables employees to use their existing network management skills.

    Tivoli Netcool/OMNIbus tracks alert information in a high-performance, in-memory databaseand presents information of interest to specific users through individually configurable filtersand views. Tivoli Netcool/OMNIbus automation functions can perform intelligent processingon managed alerts.

    This section describes how Tivoli Netcool/OMNIbus components work together to collect andmanage network alert information. Figure 2 shows an overview of the Tivoli Netcool/OMNIbuscomponent architecture.

    Figure 2 Tivoli Netcool/OMNIbus component architecture

    The components of Tivoli Netcool/OMNIbus are:

    The ObjectServer

    The ObjectServer is the in-memory database server at the core of TivoliNetcool/OMNIbus. Alert information is forwarded to the ObjectServer from externalprograms, such as probes, monitors, and gateways, stored and managed in database

    tables, and displayed in the event list. Probes

    Probes connect to an event source, detect and acquire event data, and forward the data tothe ObjectServer as alerts. Probes use the logic specified in a rules file to manipulate theevent elements before converting them into the fields of an alert in the ObjectServeralerts.status table. Each probe is uniquely designed to acquire event data from a specificsource. Probes can acquire data from any stable data source, including devices,databases, and log files.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    5/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console5

    Gateways

    Tivoli Netcool/OMNIbus gateways enable you to exchange alerts between ObjectServersand complementary third-party applications, such as databases and helpdesk orCustomer Relationship Management (CRM) systems. You can use gateways to replicatealerts or to maintain a backup ObjectServer. Application gateways enable you to integratedifferent business functions. For example, you can configure a gateway to send alert

    information to a helpdesk system. You can also use a gateway to archive alerts to adatabase.

    After a gateway is correctly installed and configured, the transfer of alerts is transparent tothe operators.

    Desktop tools

    The desktop is an integrated suite of graphical tools used to view and manage aler ts, andto configure how alert information is presented. Desktop tools are available on bothUNIX and Windows platforms. Alert information is delivered in a format that allowsusers to quickly determine the availability of services on a network. When an alert causehas been identified, desktop tools enable users to resolve problems quickly.

    The event list

    The event list displays a filtered view of color-coded alerts in a scrolling list. You can setup multiple event list clients, each with different priorities and filters. You can also use theevent list to reprioritize alerts and to assign or reassign problems to other users. When analert has been assigned to a user, the user can acknowledge it, or deacknowledge it sothat it can be picked up by another user.

    Administration tools

    Tivoli Netcool/OMNIbus includes tools that enable administrators to configure andmanage the system. For detailed information about administration tools, see the IBM Tivoli Netcool/OMNIbus TM v7.1 Administration Guide , which is available at the IBM TivoliNetcool/OMNIbus documentation Web site:

    http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?toc=/com.ibm.netcool_OMNIbus.doc/toc.xml

    Also, refer to the IBM Tivoli Netcool/OMNIbus TM v7.1 User Guide for more information abouteach of its components.

    Introduction to Tivoli Enterprise Console

    The IBM Tivoli Enterprise Console (TEC) product is a rule-based event managementapplication that integrates system, network, database, and application management to helpensure the optimal availability of an organizations IT services.

    The Tivoli Enterprise Console product:

    Provides a centralized, global view of your computing enterpriseCollects, processes, and automatically responds to common management events, suchas a database server that is not responding, a lost network connection, or a successfullycompleted batch processing job

    Acts as a central collection point for alarms and events from a variety of sources, includingthose from other Tivoli software applications, Tivoli partner applications, customapplications, network management platforms, and relational database systems.

    http://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?toc=/com.ibm.netcool_OMNIbus.doc/toc.xmlhttp://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?toc=/com.ibm.netcool_OMNIbus.doc/toc.xmlhttp://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?toc=/com.ibm.netcool_OMNIbus.doc/toc.xml
  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    6/28

    6 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    The Tivoli Enterprise Console product helps you effectively process the high volume ofevents in an IT environment by:

    Prioritizing events by their level of importance

    Filtering redundant or low-priority events

    Correlating events with other events from different sources

    Determining who must view and process specific eventsInitiating automatic corrective actions, when appropriate, such as escalation, notification,and the opening of trouble tickets

    Identifying hosts and automatically grouping events from the hosts that are inmaintenance mode in a predefined event group

    Figure 3 shows an overview of the Tivoli Enterprise Console component architecture.

    Figure 3 Tivoli Enterprise Console component architecture

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    7/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console7

    The Tivoli Enterprise Console architecture consists of the following components:

    Event server

    The event server is a central server that handles all events in the distributed system.

    User interface (UI) server

    The user interface (UI) server provides conflict management for event console updates.

    Event console

    The Tivoli Enterprise Console product provides two versions of the event console: a Javaversion and a Web version. Both versions provide a graphical user interface (GUI) thatallows the IT staff to view and respond to dispatched events.

    Adapter Configuration Facility (ACF)

    The Adapter Configuration Facility is a profile-based application that is used to configureand distribute Tivoli Management Environment (TME) adapters using a graphical userinterface (GUI).

    Event adapters

    An event adapter monitors events on a managed resource, such as a database, formatsthe information, and forwards it to the event server. The following adapters are availablewith the product: AS/400 Alert Adapter, AS/400 Message Adapter, NetWare Adapter,Openview Adapter, UNIX syslog Adapter, Windows Eventlog Adapter, and SimpleNetwork Management Protocol (SNMP) Adapter.

    Event Integration Facility (EIF)

    The EIF facility provides a mechanism to selectively forward events to Tivoli EnterpriseConsole servers.

    NetView server

    The Tivoli NetView server is a network management program that uses SNMP todiscover, monitor, and configure TCP/IP networks.

    NetView Web console The Tivoli NetView Web console is a Java-based graphical user interface (GUI) thatallows operators to view the network topology and provides diagnostic and informationaltools to aid in troubleshooting network problems.

    NetView native console

    The Tivoli NetView native console is an X/Motif-based (UNIX) or Windows-basedgraphical user interface (GUI) that allows administrators to configure the NetView server.It also provides the same operator functionality as the Tivoli NetView Web console. Thiscomponent is installed automatically when the Tivoli NetView server is installed.

    Refer to the IBM Tivoli Enterprise Console Users Guide Version 3.9 , SC32-1235, for moreinformation about each of its components.

    Introduction to the Event Integration Facility

    The IBM Tivoli Event Integration Facility (EIF) is an event distribution and integration point forthe event console. With the Tivoli Event Integration Facility toolkit, you can build eventadapters and integrate them into the IBM Tivoli Enterprise Console environment.

    IBM Tivoli Enterprise Console adapters are the integration link. Adapters collect events,perform local filtering, translate relevant events to the proper format for the event console,and forward these events to the event server. A variety of adapters for systems, Tivoli

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    8/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    9/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console9

    Figure 4 Tivoli Directory Integrator and Netcool/OMNIbus integration architecture

    This integration enables Tivoli Directory Integrator to send events to the ObjectServer of theNetcool/OMNIbus system. The ObjectServer from Netcool/OMNIbus acts as the central placeto receive events from various Probes and Monitors.

    As described in Introduction to IBM Tivoli Netcool/OMNIbus on page 3 , the Probes connectto an event source, detect and acquire event data, and forward the data to the ObjectServeras alerts. Each probe is uniquely designed to acquire event data from a specific source. TivoliDirectory Integrator utilizes the Tivoli Netcool EIF Probe for sending events to theObjectServer. The Tivoli Directory Integrator events are EIF-formatted events that can berecognized by the Tivoli EIF Probe and are forwarded to the ObjectServer of theNetcool/OMNIbus system.

    The following sections describe the Tivoli Netcool/OMNIbus EIF Probe and the TivoliDirectory Integrator EIF EventSender, which are key components of this integration.

    Tivoli Netcool EIF Probe

    A range of Tivoli products generate Event Integration Facility (EIF) messages. TheNetcool/OMNIbus Probe for Tivoli EIF can receive EIF events sent from any of these Tivolidevices and forward them to the ObjectServer.

    This probe has been used in various integration scenarios between Tivoli availability productsand Netcool/OMNIbus.

    Tivoli Directory Integrator EIF EventSender component

    The EIF EventSender component acts as the integration point from Tivoli Directory Integratorto communicate with the Tivoli EIF Probe. This component provides connectivity to the Tivoli

    TDI

    EIF EventSender

    NetcoolEventSender

    EIFAgent

    Event Integration Facility(EIF) SDK

    EIF events

    Tivoli EIFProbe

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    10/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    11/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    12/28

    12 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    Setting up the Tivoli Netcool/OMNIbus environmentLet us take a look at the prerequisites and the configuration steps.

    Prerequisites Ensure that the Tivoli Netcool/OMNIbus server and Tivoli EIF Probe are installed and runningproperly.

    Configuration steps Use these steps to configure Netcool/OMNIbus for the environment:

    1. Replace the file tivoli_eif.rules of the Tivoli EIF Probe with the tivoli_eif.rules file that weprovide with this Redpaper.

    2. Restart the Tivoli Netcool/OMNIbus server and Tivoli EIF Probe.

    3. Ensure that the Tivoli EIF Probe is listening for EIF events on a specific port mentionedwith the tivoli_eif.rules file. The default value is 9999.

    These are the details required on the Netcool/OMNIbus side.

    Setting up the Tivoli Directory Integrator environmentLet us take a look at the prerequisites and the configuration steps.

    Prerequisites Install Tivoli Directory Integrator 6.1.1.

    Configuration steps The steps are:

    1. Copy the EIF SDK jar files, such as log.jar and evd.jar, inside the < TDI-install >/jarsdirectory. These files can be obtained from Tivoli Enterprise Console support.

    2. Copy the EIFEventSender.jar (packaged with this Redpaper) inside the < TDI-install >/jarsdirectory.

    3. Copy the eif.conf file (packaged with this Redpaper) onto the system where TivoliDirectory Integrator is installed.

    4. Set the following properties in the eif.conf file:

    ServerLocation: Host name or IP address of the machine on which the Tivoli EIFProbe is listening for events.

    ServerPort: Port on which the Tivoli EIF Probe is listening for events (default9999).

    After you complete these prerequisites and follow these steps, you can use the TivoliDirectory Integrator EIF EventSender component inside Tivoli Directory Integrator solutionsto send events to the Tivoli Netcool/OMNIbus server.

    Next, we document the EIF EventSender component.

    Using EIF EventSender component

    After you configure the prerequisites properly, Tivoli Directory Integrator solution developerscan use the APIs exposed by the EIF EventSender component to initialize connections withthe Tivoli EIF Probe and send Tivoli Directory Integrator events to it.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    13/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    14/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    15/28

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    16/28

    16 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    Capturing Tivoli Directory Integrator Events with Tivoli Enterprise ConsoleEvent Console

    This section illustrates the usage of Tivoli Directory Integrator integration with the TivoliEnterprise Console system. The events sent by Tivoli Directory Integrator are displayed onthe Tivoli Enterprise Console Event Console.

    The Event Console provides a GUI that operators can use to view and respond to events. TheTivoli Enterprise Console product provides two versions of the Event Console: a Java-basedversion and a Web-based version. These sections display Tivoli Directory Integrator eventswith the Java version of the event console. The events are displayed by color to reflect theirseverity, such as red = Critical and green = Harmless.

    The Tivoli Directory Integrator events can be broadly categorized as:

    Tivoli Directory Integrator Server Events

    Events, such as Tivoli Directory Integrator server started, stopped, or failed, can be sent tothe Tivoli Enterprise Console event server. This is useful for monitoring Tivoli DirectoryIntegrator as an application with the Tivoli Enterprise Console system, similar to any other

    Tivoli application, for example, IBM Tivoli Monitoring (ITM).The screen capture in Figure 10 shows the Tivoli Enterprise Console Event Consoledisplaying Tivoli Directory Integrator Server events.

    Figure 10 Tivoli Enterprise Console displaying Tivoli Directory Integrator Server events

    Tivoli Directory Integrator Solution Events

    Tivoli Directory Integrator acts as a platform for developing and deploying integrationsolutions. These solutions actually cause changes in the underlying data repositories.Execution status of such solutions (Tivoli Directory Integrator applications) can beformatted as EIF events and sent to the Tivoli Enterprise Console system. Tivoli DirectoryIntegrator Solution Events describe the status of execution, such as how many entriesmigrated to the target repository, the specific entries deleted from a data source, thestatus of a Tivoli Directory Integrator AssemblyLine, and so on.

    The screen capture in Figure 11 on page 16 shows the Tivoli Enterprise Console EventConsole displaying Tivoli Directory Integrator Server and Solution Events.

    Figure 11 Tivoli Enterprise Console displaying Tivoli Directory Integrator Server and Solution Events

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    17/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console17

    Tivoli Directory Integrator Data Source Events

    Tivoli Directory Integrator provides a rich set of connectivity with various data sources,such as directory servers, databases, mail servers, FTP servers, messaging queues, filesystems, and so on.

    Tivoli Directory Integrator also provides capabilities to detect data changes from thesedata sources by means of the Delta feature and Changelog Connectors.

    These features of Tivoli Directory Integrator can be utilized to monitor data changes withback-end data sources. The information retrieved from the Delta feature and ChangelogConnectors can be formatted into an EIF event for the Tivoli Enterprise Console eventserver.

    For example, use Tivoli Directory Integrator to detect an entry modification in a back-endLDAP server and send this information as an EIF event to the Tivoli Enterprise Consolesystem.

    The screen capture in Figure 12 shows these events with the Tivoli Enterprise ConsoleEvent Console.

    Figure 12 Tivoli Enterprise Console displaying Tivoli Directory Integrator Data Source Events

    Installation and configuration

    This section describes the installation and configuration steps required for this integration.

    Refer to Additional files on page 24 for the various files used in this section that arepackaged within the additional files for this Redpaper.

    Setting up the Tivoli Enterprise Console environmentLet us take a look at the prerequisites and the configuration steps.

    Prerequisites Ensure that Tivoli Enterprise Console 3.9 and its required prerequisites are installed andrunning properly.

    Configuration steps To configure the Tivoli Enterprise Console environment:

    1. Define Tivoli Directory Integrator as a source of events.

    For Tivoli Enterprise Console to recognize Tivoli Directory Integrator as a source ofevents, you are required to define a Tivoli Directory Integrator source string with it. TivoliDirectory Integrator sends events to Tivoli Enterprise Console with a source string ofTDI. The following sample steps illustrate how to define a TDI source string with TivoliEnterprise Console:

    a. Issue the following command from a Windows command prompt to set up the Windowssystem environment for Tivoli commands:

    %SystemRoot%\system32\drivers\etc\Tivoli\setup_env

    (On UNIX, this is . /etc/Tivoli/setup_env.sh for Bourne shell environments.)

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    18/28

    18 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    b. Execute the following command:

    wcrtsrc TDI

    2. Import the BAROC file.

    The file tdi_events.baroc defines the Tivoli Directory Integrator event classes that need tobe deployed within the Tivoli Enterprise Console system. You can read more information

    about importing a BAROC file in IBM Tivoli Enterprise Console Command and Task Reference Version 3.9 , SC32-1232.

    These are the sample steps for importing tdi_events.baroc:

    a. Issue the following command from a Windows command prompt to set up the Windowssystem environment for Tivoli commands:

    %SystemRoot%\system32\drivers\etc\Tivoli\setup_env

    (On UNIX, this is . /etc/Tivoli/setup_env.sh for Bourne shell environments.)

    b. The following commands import the Tivoli Directory Integrator event classspecifications into the Tivoli Enterprise Console event server:

    wrb -crtrb -path C:/TDI_Rules TDI_Rules

    wrb -imprbclass "C:/tdi_events.baroc" TDI_Ruleswrb -comprules TDI_Ruleswrb -loadrb TDI_Rules

    c. Restart the Tivoli Enterprise Console server by using the following commands:

    wstopesvr

    Wait approximately 10 seconds.

    wstartesvr

    3. Import the Tivoli Directory Integrator rule set.

    The file tdi.rls defines rules for handling Tivoli Directory Integrator events. The file needsto be deployed within the Tivoli Enterprise Console system. You can read moreinformation regarding importing a rule set file in IBM Tivoli Enterprise Console Command and Task Reference Version 3.9 , SC32-1232.

    The sample steps for importing the tdi.rls file are:

    a. Issue the following command from a Windows command prompt to set up the Windowssystem environment for Tivoli commands:

    %SystemRoot%\system32\drivers\etc\Tivoli\setup_env

    b. The following commands import the Tivoli Directory Integrator rule set specificationsinto the Tivoli Enterprise Console event server:

    wrb -imprbrule tdi.rls TDI_Rules wrb -imptgtrule tdi EventServer TDI_Ruleswrb -comprules TDI_Ruleswrb -loadrb -use TDI_Rules

    4. Ensure that the Tivoli Enterprise Console server is running properly with the updates thatyou have just made by sending test events and verifying that the behavior of the rules isas expected.

    These are the things required at the Tivoli Enterprise Console to recognize Tivoli DirectoryIntegrator events properly.

    Setting up the Tivoli Directory Integrator environmentLet us take a look at the prerequisites and the configuration steps.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    19/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console19

    Prerequisites Install Tivoli Directory Integrator 6.1.1.

    Configuration steps The steps are:

    1. Copy the EIF SDK jar files, such as log.jar and evd.jar, inside the < TDI-install >/jarsdirectory. You can obtain these files from Tivoli Enterprise Console support. Get the latestEIF SDK files at patch 0054 at the time of writing this Redpaper, because this patch fixesbugs in the Java implementation.

    2. Copy the EIFEventSender.jar (which ships within the additional files for this Redpaper)into the < TDI-install >/jars directory.

    3. Copy the eif.conf file (which ships within the additional files for this Redpaper) onto thesystem where Tivoli Directory Integrator is installed.

    4. Set the following properties in the eif.conf file:

    ServerLocation: Host name or IP address of the machine on which Tivoli EnterpriseConsole server is listening for events.

    ServerPort: Port on which Tivoli Enterprise Console server is listening forevents (the default is 5529).

    5. Depending on the environment, change your firewall configuration so that the TivoliDirectory Integrator server can reach the Tivoli Enterprise Console server on port5529/tcp.

    After you implement these prerequisites and complete these steps, you can use the TivoliDirectory Integrator EIF EventSender component inside Tivoli Directory Integrator solutionsto send events to the Tivoli Enterprise Console event server. We document the EIFEventSender component in the next section.

    Using EIF EventSender component

    After you configure the prerequisites properly, Tivoli Directory Integrator solution developerscan use the APIs exposed by the EIF EventSender component for initializing connectionswith the Tivoli Enterprise Console event server and sending Tivoli Directory Integrator eventsto it.

    These APIs needs to be specified inside your Tivoli Directory Integrator Solution (Hooks,script components, and so on).

    For example, the screen capture in Figure 13 on page 20 shows how to send an event TDIServer started from the AssemblyLines Begin Prolog Hook.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    20/28

    20 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    Figure 13 Using the EIF EventSender in Tivoli Directory Integrator

    Refer to the APIs exposed by the Netcool EventSender and the Tivoli Enterprise ConsoleEventSender components on page 21 for more details about API usage of the EIFEventSender component.

    The EIF EventSender component

    The Tivoli Directory Integrator EIF EventSender component allows Tivoli Directory Integratorto communicate with the Netcool Tivoli EIF Probe and the Tivoli Enterprise Console using EIFAPIs. In the following section, we describe the implementation details and how you can bestutilize the EIF EventSender component within a Tivoli Directory Integrator environment.

    Implementation Details

    The block diagram in Figure 14 on page 21 describes the component design in detail.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    21/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console21

    Figure 14 Tivoli Directory Integrator EIF EventSender component

    The EIF EventSender component is divided into two subcomponents, such as the NetcoolEventSender and the Tivoli Enterprise Console EventSender, to send events to therespective event receivers. Both subcomponents receive the event messages, convert it tothe appropriate event formats, and pass it to the EIF Agent component. The EIF Agentcomponent further forwards these events to the event receivers, such as the Tivoli EIF Probeor Tivoli Enterprise Console event server. The EIF Agent component uses the eif.conf file

    (which ships within the additional files for this Redpaper) to initialize the EIF connectionproperties.

    The EIF EventSender component exposes certain APIs so that solution developers canutilize them for sending EIF events to Netcool/OMNIbus or the Tivoli Enterprise Consolesystem.

    In the following section, we describe the various APIs exposed by the EIF Event Sendercomponent.

    APIs exposed by the Netcool EventSender and the Tivoli Enterprise ConsoleEventSender components

    The component Netcool EventSender (com.ibm.di.EIFEventSender.NetcoolEventSender)and TEC EventSender (com.ibm.di.EIFEventSender.TECEventSender) expose the sameset of APIs and format the events appropriately before sending them to the respective eventreceiver. The following APIs are exposed by both components:

    boolean init(String eif_conf_file_path)

    This API is used for initializing the connection with the Event Receiver. Specify the eif.conffile path as a parameter to it. On successful initialization, this API returns true.

    For example, var bConnect = objNetcool.init("c:/eif.conf"");

    TDI

    EIF EventSender

    NetcoolEventSender

    TECEventSender

    EIFAgent

    Event Integration Facility(EIF) SDK

    AssemblyLines

    Files

    LDAP

    Web Services

    XML, CSV

    LDIF, DMSL

    Script, Java

    HTTP, TCP

    GLA, RAC

    CCMDB, CEI

    SAP, SiebelPeoplesoft

    Domino

    JDBC

    JMS / MQ

    POP, IMAP

    EIF Event

    NetcoolsTivoli EIF

    Probe

    TECServer

    Data/Eventsources

    TDI Eventdetails

    EIF Event

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    22/28

    22 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    int sendEvent_ServerStarted(String msg)

    This API is used to send a Tivoli Directory Integrator server start event. Specify themessage string as a parameter to it. On success, this API returns a positive integer value.

    For example, sendEvent_ServerStarted("TDI Server started successfully")

    int sendEvent_ServerStopped(String msg)

    This API is used to send a Tivoli Directory Integrator server stop event. Specify themessage string as a parameter to it. On success, this API returns a positive integer value.

    For example, sendEvent_ServerStarted("TDI Server stopped successfully")

    int sendEvent_ALStarted(String msg)

    This API is used to send a Tivoli Directory Integrator AssemblyLine start event. Specifythe message string as a parameter to it. On success, this API returns a positive integervalue.

    For example, sendEvent_ALStarted("AssemblyLine AL1 started successfully")

    int sendEvent_ALStopped(String msg)

    This API is used to send a Tivoli Directory Integrator AssemblyLine stop event. Specify the

    message string as a parameter to it. On success, this API returns a positive integer value.For example, sendEvent_ALStopped("AssemblyLine AL1 stopped successfully")

    int sendEvent_ALStatus(String msg)

    This API is used to send a Tivoli Directory Integrator AssemblyLine status event. Specifythe message string as a parameter to it. On success, this API returns a positive integervalue.

    For example, sendEvent_ALStatus("AssemblyLine AL1 status is- Get:1, Add:1")

    int sendEvent(String eventString, String eventSource, String eventClassName)

    This API is used to send a custom Tivoli Directory Integrator event. This provides theflexibility to send customized events for advanced users. On success, this API returns a

    positive integer value.Specify the message, Event source, and Event class as parameters to it.

    For example, sendEvent("TDI's Server API layer is down", "TDI ", "TDI_Event")

    int sendEvent_DataSource(String msg)This API is used to send a DataSource update event from Tivoli Directory Integrator.Specify the message string as a parameter to it. On success, this API returns a positiveinteger value.

    For example, sendEvent_DataSource("Entry cn=user1,o=ibm,c=us added into TDSrunning on testmachine.com")

    boolean terminate()

    This API is used to terminate connection with the Event Receiver. On successfultermination, this API returns true.

    Requirement: When using this API to send events to the Tivoli Enterprise Console, thestring used for eventSource must have a matching source definition on the TivoliEnterprise Console machine. You must not send arbitrary strings unless they aredefined using the TEC command wcrtsrc . The Tivoli Enterprise Console might refuseto parse events with an unknown source attribute. We recommend that you always usethe source string TDI.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    23/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console23

    API usage

    This section illustrates how Tivoli Directory Integrator solution developers can utilize APIsexposed by the Netcool EventSender and the Tivoli Enterprise Console EventSendercomponents to send events from Tivoli Directory Integrator to the respective event servers.

    Using the Netcool EventSender componentExample 1 is a sample Tivoli Directory Integrator script that describes how to use the APIsshown in APIs exposed by the Netcool EventSender and the Tivoli Enterprise ConsoleEventSender components on page 21 to send Tivoli Directory Integrator server andAssemblyLine events to Netcool Tivoli EIF Probe. You can write this script any place withinthe Tivoli Directory Integrator solution.

    Example 1 Using the Netcool Event Sender component

    //Initializing connection with Tivoli EIF Probe for sending eventvar objNetcool= new Packages.com.ibm.di.EIFEventSender.NetcoolEventSender();var b = objNetcool.init("C:/Dinesh/NetCool/TEC/EIFSDK/samples/eif.conf");//Successful initialization returns true

    main.logmsg("=== Initialize: " +b);//Send event as TDI Server startedvar rc= objNetcool.sendEvent_ServerStarted("TDI Server started successfully");//Successful event posting returns positive integer valuemain.logmsg("=== Server Started: " +rc);system.sleep(5);

    //Send event as TDI AssemblyLine AL3 startedrc= objNetcool.sendEvent_ALStarted("AL3 started");main.logmsg("=== AL Started: " +rc);system.sleep(5);

    //Send event as TDI AssemblyLine AL3 stoppedrc= objNetcool.sendEvent_ALStopped("AL3 stopped");main.logmsg("=== AL Stopped: " +rc);system.sleep(5);

    //Send event as TDI Server stoppedrc= objNetcool.sendEvent_ServerStopped("TDI Server stopped");main.logmsg("=== Server stopped: " +rc);

    //Terminate connection with Tivoli EIF Probeb= objNetcool.terminate();main.logmsg("=== Terminated: " +b);

    Using the Tivoli Enterprise Console EventSender componentExample 2 on page 24 is a sample Tivoli Directory Integrator script that describes how to usethe APIs shown in APIs exposed by the Netcool EventSender and the Tivoli EnterpriseConsole EventSender components on page 21 to send Tivoli Directory Integrator Server andAssemblyLine events to the Tivoli Enterprise Console event server. You can include this scriptinside any place within the Tivoli Directory Integrator solution.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    24/28

    24 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    Example 2 Using the Tivoli Enterprise Console EventSender component

    //Initializing connection with TEC event server for sending eventvar objTEC= new Packages.com.ibm.di.EIFEventSender. TECEventSender();var b = objTEC.init("C:/Dinesh/NetCool/TEC/EIFSDK/samples/eif.conf");//Successful initialization returns truemain.logmsg("=== Initialize: " +b);

    //Send event as TDI Server startedvar rc= objTEC.sendEvent_ServerStarted("TDI Server started successfully");//Successful event posting returns positive integer valuemain.logmsg("=== Server Started: " +rc);system.sleep(5);

    //Send event as TDI AssemblyLine AL3 startedrc= objTEC.sendEvent_ALStarted("AL3 started");main.logmsg("=== AL Started: " +rc);system.sleep(5);

    //Send event as TDI AssemblyLine AL3 stoppedrc= objTEC.sendEvent_ALStopped("AL3 stopped");main.logmsg("=== AL Stopped: " +rc);system.sleep(5);

    //Send event as TDI Server stoppedrc= objTEC.sendEvent_ServerStopped("TDI Server stopped");main.logmsg("=== Server stopped: " +rc);

    //Terminate connection with TEC event serverb= objTEC.terminate();main.logmsg("=== Terminated: " +b);

    Additional files

    The additional files for this Redpaper are distributed in the following .zip file:

    TDIs_Integration_with_Netcool-OMNIbus_and_TEC.zip.

    This .zip file consists of several files that you must deploy on the Tivoli Directory Integrator,Tivoli Netcool/OMNIbus, and Tivoli Enterprise Console systems. This section documentsdetails about the files that are required for this integration.

    Tivoli Directory Integrator filesThe directory TDI_files inside the package consists of all of the files that you must deploywith Tivoli Directory Integrator and the optional Tivoli Directory Integrator examples.

    Tivoli Directory Integrator setup filesThe directory TDI_setup_files contains all the necessary Tivoli Directory Integrator relatedfiles required for Tivoli Directory Integrator integration with Netcool/OMNIbus and TivoliEnterprise Console. Details about each files deployment are documented in its respective

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    25/28

    Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console25

    section ( Tivoli Directory Integrator and Tivoli Netcool/OMNIbus on page 8 and TivoliDirectory Integrator and Tivoli Enterprise Console on page 13 ).

    Tivoli Directory Integrator ExamplesThe directory TDI_examples contains Tivoli Directory Integrator configuration files thatillustrate how to use the Tivoli Directory Integrator EIF EventSender component to send

    various types of events to the Netcool/OMNIbus and Tivoli Enterprise Console systems. Youcan execute these configuration files from Tivoli Directory Integrator Config Editor ( ibmditk )or from the command-line utility ( ibmdisrv ).

    Each example consists of two AssemblyLines: one AssemblyLine for sending events toNetcool/OMNIbus and another AssemblyLine for sending events to Tivoli Enterprise Console.

    Example1 demonstrates how to send Tivoli Directory Integrator Server Events. Example2demonstrates how to send Tivoli Directory Integrator Server and Application (AssemblyLineexecution details) Events. Example3 illustrates how to send Data Source Events using the IBMDirectory Server Changelog Connector.

    Tivoli Netcool/OMNIbus filesThe directory Netcool_files contains all of the files that you need to deploy with Tivoli EIFProbe for this integration. We document the details about the deployment of these files inSetting up the Tivoli Netcool/OMNIbus environment on page 12 .

    Tivoli Enterprise Console files

    The directory TEC_files contains all of the files that you need to deploy with Tivoli EnterpriseConsole for this integration. We document the details about the deployment of these files inSetting up the Tivoli Enterprise Console environment on page 17 .

    References

    You can obtain Tivoli online documentation at these Web sites:

    Tivoli Directory Integrator 6.1.1 Information Center

    http://publib.boulder.ibm.com/infocenter/tivihelp/v2r1/topic/com.ibm.IBMDI.doc_6.1.1/welcome.htm

    Tivoli Enterprise Console 3.9 Information Center

    http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itec.doc_3.9/welcome_nd.html

    Netcool/OMNIbus 7.1 Information Centerhttp://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/welcome.htm

    Event Integration Facility Reference Guide

    http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecefiref.doc/ecoemst.htm

    http://publib.boulder.ibm.com/infocenter/tivihelp/v2r1/topic/com.ibm.IBMDI.doc_6.1.1/welcome.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v2r1/topic/com.ibm.IBMDI.doc_6.1.1/welcome.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itec.doc_3.9/welcome_nd.htmlhttp://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itec.doc_3.9/welcome_nd.htmlhttp://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/welcome.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/welcome.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecefiref.doc/ecoemst.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecefiref.doc/ecoemst.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecefiref.doc/ecoemst.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecefiref.doc/ecoemst.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v8r1/index.jsp?topic=/com.ibm.netcool_OMNIbus.doc/welcome.htmhttp://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itec.doc_3.9/welcome_nd.htmlhttp://publib.boulder.ibm.com/infocenter/tivihelp/v2r1/topic/com.ibm.IBMDI.doc_6.1.1/welcome.htm
  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    26/28

    26 Creating EIF Events with Tivoli Directory Integrator for Tivoli Netcool/OMNIbus and Tivoli Enterprise Console

    The team that wrote this IBM Redpaper

    This paper was produced by specialists from around the world working at the InternationalTechnical Support Organization, Austin Center.

    Axel Buecker is a Certified Consulting Software IT Specialist at the

    International Technical Support Organization, Austin Center. He writesextensively and teaches IBM classes worldwide on areas of SoftwareSecurity Architecture and Network Computing Technologies. He holds adegree in computer science from the University of Bremen, Germany. He hasmore than 20 years of experience in a variety of areas related to Workstation

    and Systems Management, Network Computing, and e-business Solutions. Before joining theITSO in March 2000, Axel worked for IBM in Germany as a Senior IT Specialist in SoftwareSecurity Architecture.

    Dinesh Jain is a Staff Software Engineer from IBM India Software Lab,Pune. He has been part of the Tivoli Directory Integrator team for the pastfour years. In his role, Dinesh is responsible for improving performance of theproduct. Dinesh enjoys exploring the depth of Tivoli Directory Integrator fordeveloping integration solutions and supporting the global Tivoli DirectoryIntegrator community. At the time of writing this paper, he had filed one

    patent and published several developerWorks articles. Dinesh holds a Masters degree ofComputer Science from the University of Pune, India.

    Thanks to the following people for their contributions to this project:

    Johan Varno,IBM Norway

    Dave Bachmann,IBM US

    Thomas Seeling,IBM Germany

    Sanil Nambiar,IBM India

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    27/28

    Copyright International Business Machines Corporation 2007. All rights reserved.Note to U.S. Government Users Restricted Rights -- Use, duplication or disclosure restricted byGSA ADP Schedule Contract with IBM Corp. 27

    Notices

    This information was developed for products and services offered in the U.S.A.

    IBM may not offer the products, services, or features discussed in this document in other countries. Consultyour local IBM representative for information on the products and services currently available in your area. Anyreference to an IBM product, program, or service is not intended to state or imply that only that IBM product,program, or service may be used. Any functionally equivalent product, program, or service that does notinfringe any IBM intellectual property right may be used instead. However, it is the user's responsibility toevaluate and verify the operation of any non-IBM product, program, or service.

    IBM may have patents or pending patent applications covering subject matter described in this document. Thefurnishing of this document does not give you any license to these patents. You can send license inquiries, inwriting, to:IBM Director of Licensing, IBM Corporation, North Castle Drive, Armonk, NY 10504-1785 U.S.A.

    The following paragraph does not apply to the United Kingdom or any other country where suchprovisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATIONPROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS ORIMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF NON-INFRINGEMENT,MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some states do not allow disclaimer ofexpress or implied warranties in certain transactions, therefore, this statement may not apply to you.

    This information could include technical inaccuracies or typographical errors. Changes are periodically madeto the information herein; these changes will be incorporated in new editions of the publication. IBM may makeimprovements and/or changes in the product(s) and/or the program(s) described in this publication at any timewithout notice.

    Any references in this information to non-IBM Web sites are provided for convenience only and do not in anymanner serve as an endorsement of those Web sites. The materials at those Web sites are not part of thematerials for this IBM product and use of those Web sites is at your own risk.

    IBM may use or distribute any of the information you supply in any way it believes appropriate without incurringany obligation to you.

    Information concerning non-IBM products was obtained from the suppliers of those products, their publishedannouncements or other publicly available sources. IBM has not tested those products and cannot confirm theaccuracy of performance, compatibility or any other claims related to non-IBM products. Questions on thecapabilities of non-IBM products should be addressed to the suppliers of those products.

    This information contains examples of data and reports used in daily business operations. To illustrate themas completely as possible, the examples include the names of individuals, companies, brands, and products.All of these names are fictitious and any similarity to the names and addresses used by an actual businessenterprise is entirely coincidental.

    COPYRIGHT LICENSE:

    This information contains sample application programs in source language, which illustrate programmingtechniques on various operating platforms. You may copy, modify, and distribute these sample programs in

    any form without payment to IBM, for the purposes of developing, using, marketing or distributing applicationprograms conforming to the application programming interface for the operating platform for which the sampleprograms are written. These examples have not been thoroughly tested under all conditions. IBM, therefore,cannot guarantee or imply reliability, serviceability, or function of these programs.

  • 7/31/2019 Creating EIF Events With Tivoli Directory Integrator for Tivoli Netcool-OMNIbus and Tivoli Enterprise Console Redp4352

    28/28

    Redpaper

    This document REDP-4352-00 was created or updated on October 11, 2007.

    Send us your comments in one of the following ways:Use the online Contact us review IBM Redbooks form found at:ibm.com /redbooksSend your comments in an e-mail to:[email protected] your comments to:IBM Corporation, International Technical Support OrganizationDept. HYTD Mail Station P0992455 South RoadPoughkeepsie, NY 12601-5400 U.S.A.

    Trademarks

    The following terms are trademarks of the International Business Machines Corporation in the United States,other countries, or both:

    Redbooks (logo) AIX AS/400 IBM

    Netcool NetView Tivoli EnterpriseTivoli Enterprise Console

    Tivoli TME

    The following terms are trademarks of other companies:

    Java, Solaris, and all Java-based trademarks are trademarks of Sun Microsystems, Inc. in the United States,other countries, or both.

    Windows, and the Windows logo are trademarks of Microsoft Corporation in the United States, othercountries, or both.

    UNIX is a registered trademark of The Open Group in the United States and other countries.

    Other company, product, or service names may be trademarks or service marks of others.

    http://www.redbooks.ibm.com/http://www.ibm.com/redbooks/http://www.redbooks.ibm.com/contacts.htmlhttp://www.redbooks.ibm.com/contacts.htmlhttp://www.ibm.com/redbooks/http://www.ibm.com/redbooks/http://www.redbooks.ibm.com/