Intelligent Monitor

for

Tivoli NetView


Readme

 

 

 

 

 


Version Control

VERSION
DATE
DESCRIPTION
Version 2.1.1 December, 2003 - latest Updates to Installation procedures.
Version 2.1.1 March 24, 2003 Reversion readme with release number, changes for NLS support.
Version 1.2 January 30, 2003

Copyright Notice

Copyright IBM Corporation 2001, 2003. All rights reserved. May only be used pursuant to a Tivoli Systems Software License Agreement, an IBM Software License Agreement, or Addendum for Tivoli Products to IBM Customer or License Agreement. No part of this publication may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without prior written permission of IBM Corporation. IBM Corporation grants you limited permission to make hardcopy or other reproductions of any machine-readable documentation for your own use, provided that each such reproduction shall carry the IBM Corporation copyright notice. No other rights under copyright are granted without prior written permission of IBM Corporation. The document is not intended for production and is furnished "as is" without warranty of any kind. All warranties on this document are hereby disclaimed, including the warranties of merchantability and fitness for a particular purpose.

U.S. Government Users Restricted Rights-Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corporation.

Trademarks

IBM, the IBM logo, Tivoli, the Tivoli logo, AIX, Tivoli Business Systems Manager, NetView, Tivoli Certified, Tivoli Enterprise, Tivoli Enterprise Console, Tivoli Ready, and TME are trademarks or registered trademarks of International Business Machines Corporation or Tivoli Systems Inc. in the United States, other countries, or both.

InstallShield is a registered trademark of InstallShield Corporation.

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

Microsoft, Windows 2000, Windows NT, Windows98, SQL Server, Microsoft Internet Explorer and the Windows logo are trademarks of Microsoft Corporation in the United States, other countries, or both.

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

WinZip is a registered trademark of Nico Mak Computing, Inc.

Other company, product, and service names mentioned in this document may be trademarks or service marks of others.

Notices

References in this publication to Tivoli Systems or IBM products, programs, or services do not imply that they will be available in all countries in which Tivoli Systems or IBM operates. Any reference to these products, programs, or services is not intended to imply that only Tivoli Systems or IBM products, programs, or services can be used. Subject to valid intellectual property or other legally protectable right of Tivoli Systems or IBM, any functionally equivalent product, program, or service can be used instead of the referenced product, program, or service. The evaluation and verification of operation in conjunction with other products, except those expressly designated by Tivoli Systems or IBM, are the responsibility of the user. Tivoli Systems or IBM may have patents or pending patent applications covering subject matter in this document. The furnishing of this document does not give you any license to these patents. You can send license inquiries, in writing, to the IBM Director of Licensing, IBM Corporation, North Castle Drive, Armonk, New York 10504-1785, U.S.A.


Table Of Contents

  1. Front Matter
  2. Overview
  3. Installation
  4. Configuration
  5. Console Launch Capability
  6. Operating the Intelligent Monitor for NetView
  7. User Guide
  8. Appendix


Overview

The Intelligent Monitor for Tivoli NetView with Tivoli Business Systems Manager (TBSM) provides the capability of

This readme describes how to install, configure and use these capabilities.  It does not address the TBSM CommonListener installation or configuration on the TBSM server.   Please refer to the TBSM documentation for information regarding the CommonListener. 






Installation

Prerequisites

Intelligent Monitor for Tivoli NetView

Intelligent Monitor Installation

To install the latest version of the Intelligent Monitor for NetView, perform the following:

NetView for AIX and Solaris

  1. The following installation kits are available:

  2. These install packages contain the following files:
    • IMfNetView.tar
    • Install.ksh
    • Readme.htm (this readme)

  3. Stop NetView and all daemons
  4. Install the Intelligent Monitor for NetView by typing,
             ./Install.ksh
             
    In the case of an upgrade install, any configuration files that have been modified will be preserved with an extension of '.old' attached to the filename. Original files can also be found in /usr/OV/newconfig/tbsm. Use the 'diff' command on the old and new files before using your old version.

    Moreover, additional checks have been placed into the Install.ksh script to check for existing jar files and other binaries. The user should notice that the install script will create a jars-IMfNetView directory containing the jar files and binaries that were shipped with the distribution. If the install script finds files that require updating then they will be updated and the old ones in the jars directory will be backed up with a .old extension.

    Note: The exception to the above is the xerces.jar file. If a different version is found the user is informed that they may need to manually copy over the version that has been shipped after checking with their administrator. Since NetView ships its own copy of xerces.jar, it may be at a different level and this install process will NOT replace it. To copy over the new one do the following:

             cp /usr/OV/jars-IMfNetView/xerces.jar /usr/OV/jars
             

NetView for Windows

  1. The installation kit consists of the file,

        IMfNetView-win.zip
  2. Unzip this file in a temp directory to install the Intelligent Monitor for NetView,
    1. Exit all NetView applications
    2. Stop the NetView daemons
    3. Run the Setup.exe from the temporary directory
  3. The install program may ask you whether or not you want to replace certain files. Check with you administrator prior to accepting changed files, especially xercers.jar, it could affect your installation operations.


Configuration

Environment Variable Configuration

The following environmental variables or setting must be set for proper catalog support. If this has not be performed or done properly the user will see the following default message, in english only:

	FLCI000E: Error! Unable to retrieve message from catalog.
	          Ensure the NLSPATH, LC_MESSAGES and LANG environment
	          variables are set correctly.

General

As with most current operating systems, localized behavior is obtained by specifying the desired locale. For Tivoli Enterprise software, you set the LANG environment variable to the desired locale name as specified by POSIX, X/Open, or other open systems standards.

If you are in a Microsoft Windows®. environment, you can alternatively modify the language setting in the Regional Settings of the Control Panel.

If you specify the LANG environment variable and modify the regional settings, the LANG environment variable overrides this regional setting.

As specified by open systems standards, other environment variables will override LANG for some or all locale categories. These variables include the following:

	LC_CTYPE 
	LC_TIME 
	LC_NUMERIC 
	LC_MONETARY 
	LC_COLLATE 
	LC_MESSAGES 
	LC_ALL 

If any of the previous variables are set, you must remove their setting for the LANG variable to have full effect.

Note:
The NLSPATH variable is used to find the appropriate message catalog directory, as specified by open systems standards. For example, if the message catalogs are in /usr/OV/nls/IMfNetView directory, the NLSPATH variable should begin with the following:

	/usr/OV/nls/IMfNetView/%L/%N.cat

The %L directive is expanded to the message catalog directory that most closely matches the current user language selection, and %N.cat expands to the desired message catalog.

If a message catalog is not found for the desired language, the English C message catalogs are used. As with most current operating systems, localized behavior is obtained by specifying the desired locale. For Tivoli Enterprise software, you set the LANG environment variable to the desired locale name as specified by POSIX, X/Open, or other open systems standards.

NetView for AIX and Solaris

You need to export the following environment variables to complete the configuration of the Intelligent Monitor for Tivoli NetView.

Note: 'C' will be the default implemented in the base code installation, all others will be implemented in the Language Pack Installer.

NetView for Windows

You need to go to Start, Settings, Control Panel and double-click on System. Select the 'Advanced' tab, then select the 'Environment Variables' button, this will bring up the Environment Variables dialog. Define or add to the following environment variables for your installation.

Note: '%NV_DRIVE%' will be the default drive that Tivoli NetView was installed on.
Note: 'C' will be the default implemented in the base code installation, all others will be implemented in the Language Pack Installer.

In Western European languages, the translated output of Tivoli commands on Microsoft®. Windows operating systems is encoded using the Windows 1252 code page. To view this text correctly in a DOS command window, perform the following.

	chcp 1252

Set the font for that window to Lucida Console in the properties, font tab for that window.

Adapter Configuration

This section applies to all platforms.

Edit the file /usr/OV/conf/topxlistener.properties.

Replace localhost in these lines,

   transport.local.ip.address = localhost
   transport.request.address  = localhost.BASETEST.QM+BASETEST.Q
   transport.response.address = localhost.BASETEST.QM+BASETEST.Q

with the local IP hostname. For instance for kiwi.tivoli.com you would edit as,

   transport.local.ip.address = kiwi.tivoli.com
   transport.request.address  = kiwi.tivoli.com.BASETEST.QM+BASETEST.Q
   transport.response.address = kiwi.tivoli.com.BASETEST.QM+BASETEST.Q

Replace localhost in the following line,

    transport.server.ip.address  = localhost

with the IP hostname of the TBSM machine with the CommonListener, for example,

    transport.server.ip.address  = tbsm.tivoli.com

Edit /usr/OV/conf/nvid.conf

This file contains information about the NetView site.  This information will allow multiple NetView sites to contribute data to a central TBSM database.

NVID

This site identifier is reserved for future use by NetView.  It can be used as a label for the network management site. Limited to 15 chars, no spaces.

NetworkID

This site identifier is appended to all instid's of the TBSM objects to uniquely identify objects from each site.  Typically it is shorter than NVID and is intended to be used by cooperating applications communicating with TBSM.  Limited to the alphanumeric character set  (A-Z, a-z, 0-9, no spaces).

PrimaryURL

This is the IP hostname and port for the web server on this node, e.g. kiwi.tivoli.com:8080.  This is used when launching the NetView Web Console from the TBSM Java Console.

secondaryURL

This is an optional backup NetView machine that shares the same nvid.conf file.

description

Specifies descriptive text about this NetView site.

The nvid.conf file should be identical on both the primary and secondary Tivoli NetView server machines.

Edit the file /usr/OV/conf/topxtbsmagent.properties

This will affect the behavior of the tbsmadapter. The property listenerlog=true will cause an XML dump into /usr/OV/log/BaseClientLogging.log instead of passing it to the remote TBSM machine.  The normal operation is 'false' which will cause data to pass to the CommonListener .

Edit the file /usr/OV/conf/topxtrapgate.conf.

Comment out any events you do not want the adapter to send to TBSM.





Console Launch Capability

Console Launch on TBSM

1. On the TBSM database server on NT, find the following files in the \tivolimanager directory.  They are already installed under the applicable directory,

bin\nvlaunchconfig.sh

sql\netviewlaunch.upg

sql\LookupNetviewURLs.sqi

sql\_LookupNetviewURLs.sql

2.  Edit the file nvlaunchconfig.sh and replace the XXXXX’s  with the TBSM database server name, SQL Server username and password.

3. Find the stored procedure and menu items and install them by running the ApplyUpgrade script,

cd \tivolimanager\sql

sh ./ApplyUpgrade netviewlaunch.upg

Installation of NetView Web Console

Install the NetView Web Console as per Tivoli NetView Installation instructions.





Special instructions for Unix

Use the nvwc_aix_jre_1.3.tar file to install the NetView Web Console. This includes the JRE. This file is found on the NetView server in,

/usr/OV/www/wwwroot/download/nvwc_aix_jre_1.3.tar

Create the environment variable NVWC_HOME to define the directory you installed the NetView Console in. Under this will be the bin and lib directories.

Make sure the NVWC_HOME environment variable is always defined by placing it in the .profile or other such file.

Edit the file $NVWC_HOME/bin/nvlaunch.sh to set the path for the Java 1.3 runtime executable. Find the line near the top,

NVWC=$(dirname $0)/..

and add the following line underneath it,

export PATH=$NVWC/jre/bin:$PATH


Launch Patch for v7.1

This is a mandatory patch for the NetView Web Console running with the TBSM Console.  It consists of the file launch.jar which can be used on both AIX and Windows platforms.  It should be placed in,

Windows

%NVWC_HOME%\lib\launch.jar

Unix

$NVWC_HOME/lib/launch.jar

Post-Installation Check

Check that these components are running,

Perform a bulk upload, as described in the User Guide below.  Then check that

NetView IP data has been uploaded to TBSM

TBSM Console can view the IP data

NetView Web Console






Operating the Intelligent Monitor for NetView

  1. Start the daemons (this will also start the tbsmadapter daemon) and the NetView GUI.  The Intelligent Monitor for NetView contains TBSM's common listener adapter and two other programs, they are:
    1. the daemon tbsmadapter,
    2. ovw registered application tbsmtopo,
    3. ovw registered application tbsmtrap.

The last two start automatically with the NetView GUI.

ovstart

netview

  1. To initiate an upload of all the NetView objects to TBSM from the NetView menu, select,

     Tools->TBSM Adapter Manager: Bulk Upload
  2. Events generated by NetView that are configured in topxtrapgate.conf will be sent to TBSM via the CommonListener  automatically.

Intelligent Monitor for NetView Output

The adapter will send the IP objects and events to the CommonListener  in XML format.  There are several useful logging and tracing files,

/usr/OV/log/BaseClientTrace.log

tracing from the local adapter transport code (tbsmadapter)

/usr/OV/log/tbsma.log

logging from the local adapter code (tbsmadapter)

/usr/OV/log/tbsmatopo.log

logging from tbsmtopo process

/usr/OV/log/tbsmatrap.log

logging from tbsmtrap process

/usr/OV/log/BaseClientLogging.log

XML output when listenerlog=true in topxtbsmagent.properties

/usr/OV/log/tbsmatrace.log

creating the file /usr/OV/log/tbsmatrace.trigger will cause tbsmtopo to begin tracing to this file

Other documents describe the data model in detail. These are the IP objects created in TBSM.

These objects are visible in TBSM Java Console:

Other objects created in the TBSM database, but not visible via the Console for this release:






User Guide

Intelligent Monitor for Tivoli NetView

TBSM is initially populated with IP topology data from NetView.  This is achieved via a Bulk Upload initiated from a user command on the NetView server.  This data includes all the managed objects, subnets, and segments, plus information identifying which NetView server the objects came from.

Thereafter, each NetView server will maintain its own data in TBSM. This is referred to as 'Delta Upload'. When an object is added, deleted, or its attributes change, NetView will notify TBSM via the TBSM Adapter for NetView in the form of a TBSM event and update the object data, adding or deleting objects as necessary. 

For instance,

If the TBSM server is unavailable or down, then the data is transparently queued at the NetView site until communication is restored.  The data remains queued even if  the NetView server is subsequently recycled.

If the TBSM CommonListener service is not running, then the data is transparently queued at the TBSM server machine.

To Invoke a Bulk Upload

From the NetView Console (read-write map):

     Tools->TBSM Adapter Manager: Bulk Upload

    

From the command line (this is necessary if the NetView daemon (netviewd) is running):

Unix:

     /usr/OV/bin/tbsmbulkupload.ksh

Windows:

     \usr\ov\bin\tbsmbulkupload.bat

The user can invoke a Bulk Upload initially, and then on demand, to resynchronize with a subsequent bulk upload after any of the adapter processes have not been running.

Multiple NetView Management Sources

This section will help you understand how to set up multiple NetView feeds to achieve the desired result in TBSM.

What is supported:

 

The key elements for site and instrumentation identification that satisfy these requirements are,

NVID

NetworkID

InstrumentationID

TBSM table object.CL_AutoPlacement

Typically all the NetView sources will upload IP data for one TBSM Enterprise, but each individual NetView's objects will be differentiated by the networkID defined in the nvid.conf file.

Launching NetView Console from TBSM

From the TBSM Java Console, users can select a host machine managed by NetView and then right-click to select a launch menu item from the main Launch menu.  Each of the menu items will launch to a NetView Web Console running on the same machine.  Menus are context sensitive, so they will only contain active menu items appropriate for the selected object.

The following menu items are available,

Launch->NetView Web Console

Displays the NetView Submap Explorer showing the object in focus on a topology map.  This menu item will appear for all host type objects.

Launch->NetView Diagnostics

Displays the Diagnostics dialog for the object selected, allowing the operator to perform any of the diagnostic functions available from NetView. This menu item will appear for all host type objects.

Launch->NetView Object Properties

Displays the Object Properties dialog for the object in focus.  This menu item will appear for all host type objects.

Note that a separate NetView Web Console will be launched for each different NetView server.  So, if three NetView servers contribute to TBSM, there will be up to three separate NetView Web Consoles active.  The result of selecting the Launch menu items will be to either start a new NetView Web Console if none is yet connected to that server, or to change the context of the active NetView Web Console already connected to that server.  Context is defined as the function plus the object in focus.






Appendix

Behind the Scenes

The Intelligent Monitor for Tivoli NetView consists of three conceptual components.  At present these are three separate programs that reside on the NetView server and together form the Adapter.

tbsmadapter daemon

This daemon maintains a connection with the TBSM Common Listener.  The tbsmadapter daemon is a Java application responsible for packaging the data and sending it to the remote TBSM Common Listener. 

tbsmtopo OVW application

This application is invoked as part of the NetView native console (and the netviewd daemon).  In the case of multiple NetView native consoles running, only one instance will be connected to the tbsmadapter daemon.  This application is responsible for handling requests to extract the data from NetView's databases and package it as XML prior to delivering it to the tbsmadapter daemon. 

tbsmtrap OVW application

This application is also invoked as part of the NetView native console.  It will listen for all traps and generate TBSM event messages for the appropriate object. For topology change NetView traps it will generate TBSM event messages and, as appropriate, it will signal "tbsmtopo" to generate a delta discovery, or delete, of the NetView object to send to TBSM.  The set of events "tbsmtrap" listens for is controlled by the file topxtrapgate.conf.  Note that when netviewd is running, you can use the commandline utility, tbsmupbulkupload.bat (.ksh) to invoke a Bulk Upload.

The remote TBSM CommonListener is part of the TBSM product and is responsible for creating, deleting, and updating the TBSM objects from a variety of product sources.





Restrictions