IBM Tivoli Netcool/OMNIbus, Version 7.4

Configuring support for TADDM events in your integrated environment

You can configure Tivoli Netcool/OMNIbus, the Probe for Tivoli EIF, and TADDM so that TADDM events can be monitored in the Tivoli Netcool/OMNIbus event list or the Active Event List (AEL).

Before you begin
Additional configuration for TADDM V7.1.2
Configuration steps for supporting TADDM events

Before you begin

At a minimum, this configuration requires the following products and versions:
  • Tivoli Netcool/OMNIbus V7.3.1
  • TADDM: Use one of the following versions:
    • V7.1.2 with the TADDM OMP Change Event Module
    • TADDM V7.2 or later
    The TADDM OMP Change Event Module is available as a separate download for TADDM V7.1.2, but is integrated into TADDM V7.2 or later. For more information, see the TADDM documentation.
Ensure that you installed and configured Tivoli Netcool/OMNIbus and TADDM, so that they are in an operational state as follows:
  • The designated ObjectServer hosts to which you want TADDM events to be forwarded are set up.
  • The nco_confpack feature is installed on each ObjectServer host.
  • The Web GUI server is installed and configured on a host computer. By default, the Web GUI server contains the Web GUI Administration Application Program Interface (WAAPI) client, from which you load the customizations that support TADDM events.
  • Client workstations are set up with access to the Tivoli Netcool/OMNIbus desktop tools or the Web GUI.

    On all computers that run the desktop event list, ensure that a Java™ Runtime Environment (JRE) is installed. Also ensure that the directory location of the Java Web Start utility (javaws) is included in the PATH environment variable. The menu tools that launch the TADDM Java console require this utility to be in the PATH environment in which the event list is launched. The javaws utility is typically found in the /bin directory of the Java Runtime Environment.

  • TADDM is set up. For information about installing and configuring TADDM, see the TADDM Knowledge Center at http://www.ibm.com/support/knowledgecenter/SSPLFC/welcome, open the Application Dependency Discovery Manager node in the navigation pane on the left, and locate the information for your required version.
  • Optional: Single-sign is configured between the Web GUI server and the TADDM server. If single sign-on is configured, AEL users can navigate to TADDM without having to log in to TADDM separately.

In addition, a Probe for Tivoli EIF must be installed in your Tivoli Netcool/OMNIbus environment, as described in the README.txt and description.txt files in the probe download package. Edit the probe properties file to include details of the ObjectServer to which you want to forward TADDM events. The probe includes a customized rules file for processing TADDM events. For more information, see Configuration steps for supporting TADDM events.

Additional configuration for TADDM V7.1.2

If you are using TADDM V7.1.2, you must configure TADDM with the TADDM OMP Change Event Module.

Before you begin

Ensure that you have an IBM® ID and password, so that you can access the OMP Change Event Module download.

About this task

The TADDM event module is an add-on that allows notifications to be sent to external event-handling systems when TADDM discovers configuration changes in your environment.

Procedure

To set up the required configuration:

  1. Download the TADDM OMP Change Event Module at: http://www-01.ibm.com/software/brandcatalog/portal/opal/details?catalog.label=1TW10CC1Q.
  2. Extract the files from the download package to a temporary location, and navigate to the doc subdirectory.
  3. Open the index.html file to obtain the instructions for setting up the integration with Tivoli Netcool/OMNIbus.
    Tip: The relevant instructions are contained in the section titled Sending change events to ITM, TEC, and OMNIBus. If you click any of the links, you will notice that the text is stored in the change_events.html file, which is also within the doc subdirectory. You can read through the text first to familiarize yourself with the contents, but only the text in the Configuring TADDM section is relevant.
  4. From the change_events.html file, follow all the instructions in the Configuring TADDM section to add the event module files to your TADDM server, and to configure the server.
  5. Update the $MODULE_PATH/taddmomp/properties/EventConfig.xml file as follows:
    1. In the Event Listeners section, use the <listener> element to specify details of resources to be tracked for changes.
    2. In the Event Recipients section, use the <recipient> element to specify details about the system to which event data should be forwarded and the configuration to be applied The <recipient name=> value in this section must be identical to the <alert recipient=> value in the Event Listeners section; for example, omnibus.
    3. Delete the <address> and <port> elements. Typically, these elements can be used to specify the connection details for the Probe for Tivoli EIF host computer, but they are redundant in this case.
    4. Use the <config> element to specify the path to the configuration file that was extracted into $MODULE_PATH/taddmomp/properties/omnibus.eif.properties. You must use this file to specify the connection details for the Probe for Tivoli EIF and other EIF configuration parameters.
  6. Update the default $MODULE_PATH/taddmomp/properties/omnibus.eif.properties file, which is referenced in the EventConfig.xml file as follows:
    1. Specify the fully qualified name of the Probe for Tivoli EIF host computer as the value of the ServerLocation property.
    2. Specify the port on which the probe listens as the value of the ServerPort property.
    3. Specify appropriate directory locations for the buffer, trace file, and log file.
    4. Complete the remainder of the file as shown in the following example. In this example, some of the default comments are modified.
      ...
      # The event class 
      TADDMEventClass=TADDM
      
      # EIF Slot definitions for the event
      
      # Supported substitutions for event data in TADDM EIF Adapter. These can be
      # used to compose the value of the event slots. The TEC slot name must be preceded
      # with TADDMEvent_Slot_ 
      #
      # The values slots correspond to the fields that are processed in the
      # tivoli_eif_taddm.rules file.
      #
      TADDMEvent_Slot_object_name=$TADDM_OBJECT_NAME
      TADDMEvent_Slot_change_type=$TADDM_CHANGE_TYPE
      TADDMEvent_Slot_change_time=$TADDM_CHANGE_TIME
      TADDMEvent_Slot_class_name=$TADDM_CLASS_NAME
      TADDMEvent_Slot_attribute_name=$TADDM_ATTRIBUTE_NAME
      TADDMEvent_Slot_old_value=$TADDM_OLD_VALUE
      TADDMEvent_Slot_new_value=$TADDM_NEW_VALUE
      TADDMEvent_Slot_host=$TADDM_HOST
      TADDMEvent_Slot_port=$TADDM_PORT
      TADDMEvent_Slot_guid=$TADDM_GUID
      
      # source must be defined to identify the TADDM events in the probe
      TADDMEvent_Slot_source=TADDM

Configuration steps for supporting TADDM events

About this task

To enable TADDM events to be monitored in Tivoli Netcool/OMNIbus:

Procedure

  1. From the Tivoli Netcool/OMNIbus ObjectServer host, go to the $NCHOME/omnibus/extensions/taddm directory.
  2. Copy the sample tivoli_eif_taddm.rules file to the following directory on the computer where the Probe for Tivoli EIF is installed, or to another preferred location.

    $NCHOME/omnibus/probes/arch

  3. Optional: Edit the tivoli_eif_taddm.rules file to set an expiry period for the TADDM events in the ObjectServer. These events are otherwise retained in the ObjectServer because there are no resolution events for the TADDM events.
    1. Remove the default read-only permissions from the tivoli_eif_taddm.rules file.
    2. Locate the following commented-out line at the end of the rules file.
      # @ExpireTime = 7 * 24 * 60 * 60
    3. Uncomment this line and then specify an expiry period in seconds for the TADDM events. The example configuration sets the expiry period to one week (that is, 60 seconds * 60 minutes * 24 hours * 7 days).
    4. Save and close the file.
  4. Edit the main tivoli_eif.rules file for the Probe for Tivoli EIF.
    1. Locate the switch($source) section of the file.
    2. Uncomment the line that contains an include statement for the tivoli_eif_taddm.rules file. Include the directory path to this file, if necessary.
      include "tivoli_eif_taddm.rules"
    3. Comment out the following line, or leave it uncommented, depending on whether you set up your system to receive events from Tivoli Enterprise Console®.
      include "tivoli_eif_default.rules"
      If the line is uncommented, you must update the ObjectServer database schema by applying the tec_db_update.sql import file, which is included with the probe. For more information, see the publication for the Probe for Tivoli EIF. You can access this publication as follows from this information center:
      1. Expand the IBM Tivoli Netcool/OMNIbus node in the navigation pane on the left.
      2. Expand the Tivoli Netcool/OMNIbus probes and TSMs node.
      3. Go to the IBM node.
  5. Edit the $NCHOME/omnibus/probes/arch/tivoli_eif.props file to update the value of the Inactivity property. By default, the probe terminates if the port on which it is listening is inactive for 10 minutes. Event generation might be sporadic depending on the TADDM discovery schedules, so configure the probe to run continuously when listening for TADDM events. To configure this setting, set the Inactivity property to 0 (zero).
  6. Run (or restart) the probe.
  7. Add the TADDM configuration to the ObjectServer to which the events are sent, and to which the event lists connect. This configuration includes the reserved class, and the menu and tools for TADDM events.
    1. From the ObjectServer host, change to the $NCHOME/omnibus/bin directory.
    2. Enter the following command:

      nco_confpack -import -server server_name -user user_name -password password -package $NCHOME/omnibus/extensions/taddm/taddm_menutools_native_gui.jar -nowarn

      In this command, server_name is the ObjectServer name, and user_name and password are your login credentials.

      When the import is complete, a TADDM submenu is available within the Alerts menu in the event list.

  8. To add the TADDM filter to your event lists, copy the $NCHOME/omnibus/extensions/taddm/taddm.elf file to a preferred location. The filter is added with the name TADDM, and can be selected in all the event lists in that event list configuration.
  9. To load the taddm.elf filter into an existing event list configuration:
    1. From the Event List monitor box window, click Windows > Configuration to open the Event List Configuration window.
    2. While viewing the filters that are part of this event list configuration, click Load (on UNIX or Linux), or click Open (on Windows).
    3. From the resulting window, navigate to the location where you saved the taddm.elf filter file, select the file, and then click OK.
    4. Save the event list configuration.
  10. To add the menu, tools, and a filter for TADDM events to the Web GUI server, see Enabling support for TADDM events in the Web GUI.
  11. On all UNIX and Linux computers that run the desktop event list, ensure that the OMNIBROWSER environment variable is set. You can set the OMNIBROWSER environment variable to specify the location and file name of the default Web browser as follows: The OMNIBROWSER setting is required for launching from a TADDM event in the event list to the TADDM Web client.
    • For a csh user, add the following line to the $HOME/.login file:
      setenv OMNIBROWSER browser_executable_path
    • For a or a ksh or sh user, add the following line to the $HOME/.profile file:
      OMNIBROWSER=browser_executable_path;export OMNIBROWSER
  12. From TADDM, configure a discovery schedule for the configuration items to be tracked.

    For more information about setting up a discovery in TADDM, see the TADDM Knowledge Center at http://www.ibm.com/support/knowledgecenter/SSPLFC/welcome.

    When the discovery process finishes, details of detected changes are forwarded to the Probe for Tivoli EIF. The probe maps the data to ObjectServer fields and inserts the data into the ObjectServer as events.

What to do next

You can now be monitor TADDM events in the event list and AEL.