======================================================================
                  Halcyon Monitoring Solutions
                      www.HalcyonInc.com

            Neuron Integration for IBM Tivoli Netcool
                         Version 1.1.3

                         README.config
======================================================================


Overview
======================================================================
This README.config file describes how to configure the Neuron
Integration for IBM Tivoli Netcool.

This file consists of the following sections:
   - Integration Configuration: Directory Structure
   - Integration Configuration: Action Configuration 
   - Integration Configuration: Netcool Configuration 
   - SNMP MIB Files


Integration Configuration: Directory Structure
======================================================================
All necessary configuration, log, and data files can be found in the
[LOCALDIR] folder (where [LOCALDIR] is typically /var/opt/HMF).

The contents of this folder are as follows:
  [LOCALDIR]/
    + conf              - configuration files
    + logs              - log files

where the default location of LOCALDIR is /var/opt/HMF.


Integration Configuration: Action Configuration 
======================================================================
In order to use the Neuron Integration for IBM Tivoli Netcool, a 
Netcool action must be defined within a Neuron Portal Rule that will 
tell the IBM Tivoli Netcool Integration of events to forward to
Netcool.

The Halcyon Neuron Event Manager should be used to setup an IBM Tivoli
Netcool action within a rule.  When the given rule matches an incoming 
event, the Netcool action will be triggered and the event will be
forwarded to the IBM Tivoli Netcool server specified with the action.


Integration Configuration: Netcool Configuration 
======================================================================
The following instructions apply to IBM Tivoli Netcool/OMNIbus 7.2. 
integration with other versions of Netcool OMNIbus may vary.

1. From the Halcyon Neuron Core server host, copy the following rule file:

       [BASEDIR]/conf/module/NetcoolAdapter.rules

   to a filesystem on the Netcool server or a shared filesystem accessible 
   to the Netcool server. This file contains a set of rules which handle 
   the enterprise specified snmp traps with generic trap-type = 6.
   [BASEDIR] can be determined by running the following command:
       # echo "`pkgparam HALhmfcon BASEDIR`/HMF"

2. Append the contents of the file "NetcoolAdapter.rules" to the end of 
   the Netcool MTTrapd Probe configuration file:

       ${OMNIHOME}/probes/solaris2/mttrapd.rules

   using the following command:

       # cat NetcoolAdapter.rules >> ${OMNIHOME}/probes/solaris2/mttrapd.rules

   where ${OMNIHOME} refers to the base installation directory of the 
   Netcool/OMNIbus software package.

   It is strongly recommended that a new Alert Class be created in all
   Netcool ObjectServers expected to receive events from Halcyon Neuron
   Core. This allows greater flexibility and ease in identifying and
   managing Halcyon Neuron Core events in a Netcool environment.
   Remember that the class id of alerts originating from Halcyon Neuron
   Core must be updated accordingly in the mttrapd.rules to match the id
   of the newly created Omnibus class.

3. If you have not started the Netcool ObjectServer, run the following 
   command as root to launch it:

       # ${OMNIHOME}/bin/nco_objserv -name <server_name>

   where <server_name> is the name of the Netcool ObjectServer.

4. Check if the Netcool MTTrap Probe process is running with the following 
   command:

       # ps -ef | grep nco_p_mttrapd

5. If the Netcool MTTrapd Probe process nco_p_mttrapd is already running, 
   send a HUP signal to force the MTTrapd Probe to read the updated 
   "mttrapd.rules" file using the following command:

       # kill -HUP <nco_p_mttrapd pid>

   Otherwise, you need to start the MTTrapd Probe by using the following 
   command as root:

       # ${OMNIHOME}/probes/nco_p_mttrapd -server <ObjectServer host>

   where <ObjectServer host> is the host name of the ObjectServer that 
   will receive Netcool alerts from this probe.

   The MTTrapd Probe is ready to receive and interpret SNMP traps sent 
   from Halcyon Neuron Core. The detailed event information can be viewed 
   on the Event List console.

6. Launch the Netcool Event List console with the following command:

       # ${OMNIHOME}/bin/nco_event -server <ObjectServer>

   Press the "View" button on the desired Event List filter to review the 
   detailed contents of the events.


SNMP MIB Files
======================================================================
Halcyon provides MIB files describing the format of the SNMP traps
being sent to IBM Tivoli Netcool.  IBM Tivoli Netcool can use these
files to map the OIDs which are inside the SNMP trap to object names
from the MIB file.

The Halcyon MIB files can be found at the following locations:

    [LOCALDIR]/conf/module/GenericAdapter_v1.mib
    [LOCALDIR]/conf/module/GenericAdapter_v2.mib

A description of these MIBs can be found at:

    [LOCALDIR]/conf/module/GenericAdapter.txt


---//---