Configuring Tivoli Enterprise Console to send events to the event handler

If IBM Tivoli Monitoring V6.1 has been configured to send events to Tivoli Enterprise Console, then you must configure Tivoli Enterprise Console to forward events to the event handler.

Before you begin

To use Tivoli Enterprise Console to forward events to the event handler, the event synchronization support for Tivoli Monitoring must be installed (see Installing the IBM Tivoli Enterprise Console event synchronization in the Tivoli Monitoring Information Center for more details).

About this task

(You can also use these instructions if you are using Tivoli Monitoring V6.2 or later, but the recommended method is to define event destinations as described in Configuring IBM Tivoli Monitoring V6.2 or later to forward events.)

You configure the Tivoli Enterprise Console to forward events to the event handler by installing an event handler rule.

Procedure

To install the event handler resend rule into Tivoli Enterprise Console:

  1. Create a temporary directory on the computer where Tivoli Enterprise Console is installed.
  2. Extract the itcam4soa-tec-files.zip from the sa04.1_6.0.2.1.zip or sa04.1_6.0.2.1.tgz file that is available on the event handler SupportPac site.
  3. Extract the following files from the itcam4soa-tec-files.zip file to the temporary directory that you created in step 1:
    • install_itcam_rb.sh
    • tec_itcam.rls
    • tec_itcam.conf
    For UNIX or Linux systems, ensure that install_itcam_rb.sh is granted execute permission.
  4. Copy the kd4.baroc file from your ITCAM for SOA installation into the temporary directory that you created in step 1.
    • For ITCAM for SOA V6.1, the kd4.baroc file is located in the 6.1 directory of the itcam4soa-tec-files.zip file and in the /kd4/tec directory of the ITCAM for SOA installation media.
    • For ITCAM for SOA V6.1, fix pack 1, you must use the kd4.baroc file in the /kd4/tec directory of the ITCAM for SOA fix pack installation media.
    • For ITCAM for SOA V7.1, use the kd4.baroc file installed on your Hub Tivoli Enterprise Management Server:
      • Windows - ITM_Home\cms\TECLIB
      • UNIX or Linux - ITM_Home/tables/hostname/TECLIB
      Where ITM_Home is the installation directory of the Hub Tivoli Enterprise Management Server and hostname is the value supplied during the Tivoli Enterprise Monitoring Server configuration.
  5. Edit the parameters in the tec_itcam.conf file as described in the following table:
    Table 1. Parameters in the tec_itcam.conf file
    Parameter name Value Parameter description
    ServerLocation= Event Handler server address Hostname or IP address of the server where the event handler is installed
    ServerPort= Event Handler port number Port number that the event handler is listening on. By default, this is 1111. The port number must match the port number value specified when you configured the event handler.
    BufEvtPath= Event cache file location The file where events are cached if a connection with the event handler cannot be established. Cached events are forwarded when the connection is re-established. Modify this parameter only if the default value is not suitable.
  6. If you are installing multiple instances of the event handler to support the backup scenario, configure Tivoli Enterprise Console to forward events to a list of event handlers. To configure a list of event handlers, specify a list of hostnames or IP addresses for the ServerLocation parameter, and a list of port numbers for the ServerPort parameter. For example: 
    ServerLocation=soawin11.tivlab.raleigh.ibm.com,soawin12.tivlab.raleigh.ibm.com
ServerPort=1111,2222
    The order of the host names in the ServerLocation parameter list must correspond to the order of the port numbers in the ServerPort parameter list. In the example, port number 1111 is used when contacting the event handler on host soawin11.tivlab.raleigh.ibm.com, and port number 2222 is used when contacting the event handler on host soawin12.tivlab.raleigh.ibm.com. When you configure a list of event handlers, Tivoli Enterprise Console attempts to send ITCAM for SOA events to the first event handler in the list. If that event handler cannot be reached, Tivoli Enterprise Console attempts to forward events to the next event handler in the list. If a connection cannot be established to any of the event handlers, Tivoli Enterprise Console caches the events until it is able to contact one of the event handlers. For more information on configuring event caching in the tec_itcam.conf EIF configuration file, see reference topic in the Tivoli Monitoring Information Center.
  7. Edit the variables in the in install_itcam_rb.sh file as described in the following table:
    Table 2. Variables in the in install_itcam_rb.sh file
    Variable name Variable description
    DIR= Set this variable to the temporary directory that contains the install_rb.sh file. For example, DIR=C:/temp/itcamsoarules
    RuleBase= Set this variable to the rule base that was specified when the IBM Tivoli Monitoring event synchronization component was installed with Tivoli Enterprise Console.
    RuleBasePath= Set this variable to the rule base path that was specified when the IBM Tivoli Monitoring event synchronization component was installed with Tivoli Enterprise Console.
    You can use the wrb –lsrb Tivoli Enterprise Console command to list the rule bases. See http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecctref.doc/ecormst64.htm the Tivoli Enterprise Console Information Center.
  8. Open a command line window, and set up the Tivoli Management Framework environment by entering the following command:
    • Windows - enter the command:
      C:\WINDOWS\system32\drivers\etc\Tivoli\setup_env.cmd
    • UNIX and Linux - enter the command: 
      . /etc/Tivoli/setup_env.sh
  9. Change directory to the temporary directory that you created in step 1, and enter the following commands: 
    bash

./install_itcam_rb.sh
    If the ITCAM for SOA monitoring agent .baroc file (kd4.baroc) is already loaded in the Tivoli Enterprise Console rule base, the install_itcam_rb.sh script displays error messages. You can ignore these messages.
  10. Restart Tivoli Enterprise Console.
  11. If you are using ITCAM for SOA V6.1 or one of its fixpack releases, ensure the kd4.map file is copied to one of these directories on the system where the Hub Tivoli Enterprise Monitoring Server is installed:
    • Windows: ITM_Home\cms\TECLIB.
    • UNIX/Linux: ITM_Home/tables/host name/TECLIB.
    Where ITM_Home is the location where the Tivoli Enterprise Monitoring Server is installed (for example, the default locations, C:\IBM\ITM or /opt/IBM/ITM) and host name is the value supplied during the Tivoli Enterprise Monitoring Server configuration.
    • If you have installed ITCAM for SOA V6.1, the kd4.map file is available in the /kd4/tec directory on the ITCAM for SOA V6.1 installation media.
    • If you have installed an ITCAM for SOA V6.1 fix pack release, you must use the version of kd4.map from the /kd4/tec directory on the ITCAM for SOA V6.1 fix pack installation media to ensure that you have the latest updates.
    • If you are using ITCAM for SOA V7.1 or later, the kd4.map file is copied to the appropriate directory during product installation, and you need take no action.
  12. For V6.1, restart the Hub Tivoli Enterprise Monitoring Server:
    • Windows: use the Manage Tivoli Enterprise Monitoring Services application to restart the monitoring server.
    • UNIX/Linux: run these commands:
      ./itmcmd server stop tems_name

	./itmcmd server start tems_name
      where tems_name is the name of your monitoring server (for example, HUB_itmdev17).
    See the topics Starting Manage Tivoli Enterprise Monitoring Services on Linux or UNIX computers and Starting Manage Tivoli Enterprise Monitoring Services on Linux or UNIX computers in the Tivoli Monitoring Information Center for more details.

    For V6.2 and later, use the tacmd refreshTECinfo command to trigger the Event Forwarder to reprocess any updated event destinations, EIF configurations, and custom event mapping files (see the topic tacmd refreshTECinfo in the Tivoli Monitoring Information Center for more details).

Results

A re-send rule is installed that forwards all ITCAM for SOA events generated against the ITM_Services_Inventory_610 table to the event handler. All ITM_Services_Inventory_610 events, regardless of event severity, are sent to the event handler.
Parent topic: Configuring the Tivoli components

Deleting the event handler rules for Tivoli Enterprise Console

You can stop using the event handler resend rule by deleting the event handler rule.

Procedure

To delete event handler rules:

  1. Create a temporary directory on the computer where Tivoli Enterprise Console is installed.
  2. Extract the itcam4soa-tec-files.zip from the sa04.1_6.0.2.1.zip or sa04.1_6.0.2.1.tgz file that is available on the event handler SupportPac site.
  3. Extract the delete_itcam_rb.sh file from the itcam4soa-tec-files.zip file to the directory you created in step 1. If you want to modify the Event Handler rule files, you should also extract the install_itcam_rb.sh file.
  4. Save a copy of the event handler rule files for future use. Copy the following files to the directory you created in step 1:
    • RuleBasePath/TEC_CLASSES/kd4.baroc
    • RuleBasePath/TEC_RULES/tec_itcam.rls
    • RuleBasePath/TEC_RULES/tec_itcam.conf
    Where RuleBasePath is the rule base path directory you specified when the IBM Tivoli Monitoring event synchronization component was installed with Tivoli Enterprise Console. You can use the wrb –lsrb Tivoli Enterprise Console command to list the rule bases. See http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecctref.doc/ecormst64.htm the Tivoli Enterprise Console Information Center.
  5. Edit delete_itcam_rb.sh, and set the RuleBase variable to the rule base that was specified when the IBM Tivoli Monitoring event synchronization component was installed with Tivoli Enterprise Console.
  6. Open a command line window, and set up the Tivoli Management Framework environment by entering the following command:
    • Windows - enter the command:
      C:\WINDOWS\system32\drivers\etc\Tivoli\setup_env.cmd
    • UNIX and Linux - enter the command: 
      . /etc/Tivoli/setup_env.sh
  7. Change directory to the temporary directory that you created in step 1, and enter the following commands: 
    bash

./delete_itcam_rb.sh

Modifying the event handler rules for Tivoli Enterprise Console

You can modify event handler rules that you have previously specified.

Procedure

To modify event handler rules:

  1. Create a temporary directory on the computer where Tivoli Enterprise Console is installed.
  2. Save a copy of the event handler rule files. Copy the following files to the directory you created in step 1:
    • RuleBasePath/TEC_CLASSES/kd4.baroc
    • RuleBasePath/TEC_RULES/tec_itcam.rls
    • RuleBasePath/TEC_RULES/tec_itcam.conf
    Where RuleBasePath is the rule base path directory you specified when the IBM Tivoli Monitoring event synchronization component was installed with Tivoli Enterprise Console. You can use the wrb –lsrb Tivoli Enterprise Console command to list the rule bases. See http://publib.boulder.ibm.com/infocenter/tivihelp/v3r1/topic/com.ibm.itecctref.doc/ecormst64.htm the Tivoli Enterprise Console Information Center.
  3. Delete the existing rules by following the procedure described for Deleting the event handler rules for Tivoli Enterprise Console.
  4. Edit the parameters in the tec_itcam.conf file as described in the following table:
    Table 3. Parameters in the tec_itcam.conf file
    Parameter name Value Parameter description
    ServerLocation= Event Handler server address Hostname or IP address of the server where the event handler is installed
    ServerPort= Event Handler port number Port number that the event handler is listening on. By default, this is 1111. The port number must match the port number value specified when you configured the event handler.
    BufEvtPath= Event cache file location The file where events are cached if a connection with the event handler cannot be established. Cached events are forwarded when the connection is re-established. Modify this parameter only if the default value is not suitable.
    (You can specify a list of event handlers if required, see step 6 in Configuring Tivoli Enterprise Console to send events to the event handler.)
  5. Edit the install_itcam_rb.sh file and amend the variables described in the following table to the desired values
    Table 4. Variables in the in install_itcam_rb.sh file
    Variable name Variable description
    DIR= Set this variable to the temporary directory that contains the install_rb.sh file. For example, DIR=C:/temp/itcamsoarules
    RuleBase= Set this variable to the rule base that was specified when the IBM Tivoli Monitoring event synchronization component was installed with Tivoli Enterprise Console.
    RuleBasePath= Set this variable to the rule base path that was specified when the IBM Tivoli Monitoring event synchronization component was installed with Tivoli Enterprise Console.
  6. Open a command line window, and set up the Tivoli Management Framework environment by entering the following command:
    • Windows - enter the command:
      C:\WINDOWS\system32\drivers\etc\Tivoli\setup_env.cmd
    • UNIX and Linux - enter the command: 
      . /etc/Tivoli/setup_env.sh
  7. Change directory to the temporary directory that you created in step 1, and enter the following commands: 
    bash

./install_itcam_rb.sh
    If the ITCAM for SOA monitoring agent .baroc file (kd4.baroc) is already loaded in the Tivoli Enterprise Console rule base, the install_itcam_rb.sh script displays error messages. You can ignore these messages.
  8. Restart Tivoli Enterprise Console.