User Guide for CiscoWorks Integration Utility 1.6
Chapter 3: Using Integration Utility

Table Of Contents

Using Integration Utility

Starting Integration Utility

Starting Integration Utility on UNIX

Starting Integration Utility on Windows

Starting Integration Utility on NMS

Downloading Data Bundle

Integrating CiscoWorks Applications to NMS

Updating NMS

Troubleshooting Integration Utility


Using Integration Utility


CiscoWorks Integration Utility downloads Network Management Integration Data Bundle (NMIDB) and integrates CiscoWorks applications, icons, MIBs, and traps with third-party Network Management Systems (NMS).

This chapter contains:

Starting Integration Utility

Downloading Data Bundle

Integrating CiscoWorks Applications to NMS

Updating NMS

Troubleshooting Integration Utility

Starting Integration Utility

You must start the Integration utility to:

Download and upgrade to a new NMIDB version available on Cisco.com.

Change your CiscoWorks application server location.

Register a new application.

Change the NMS with which you want to integrate your CiscoWorks applications.

Get a new vendor adapter script.

You must log in as root on UNIX or have administrator privileges on Windows to run the Integration Utility.

This section contains:

Starting Integration Utility on UNIX

Starting Integration Utility on Windows

Starting Integration Utility on NMS

Starting Integration Utility on UNIX

To start Integration Utility on UNIX:


Step 1 Open a connection to the system on which the Integration utility is installed using Telnet.

Step 2 Log in as root.

Step 3 Navigate to the root install directory/bin directory.

If you plan to start the utility without using any options, set your Display environment variable.

Step 4 Enter the following (including any options from Table 3-1) on the command line:

./nmic.sh

Table 3-1 Command Line Options 

Command Line Option
Description
-h or -help

Displays the command line options and usage.

-v

Displays Integration utility version and NMIDB version.

-q

Runs in quiet mode without showing the GUI screens. Uses the previously-installed NMIDB and runs the previously-configured adapter script.

-u

Removes the integration information from the Network Management System. The menu entries for Cisco applications are removed; the MIBs and icons are not deleted.

-q -cco

Gets the latest NMIDB from Cisco.com and runs the previously-configured adapter script.

-q -file

Installs the NMIDB. Enter the full directory path to the NMIDB file.

For example:

On Windows, enter:

-q -file C:\temp\nmidb.xxx

where xxx is the NMIDB version.

On UNIX, enter:

-q -file /tmp/nmidb.xxx

where xxx is the NMIDB version.


Starting Integration Utility on Windows

From a Windows platform, you can start the Integration Utility from either

Start menu

Or

Command line

To start the Integration Utility from the Start menu:


Step 1 Click Start on your Windows desktop.

Step 2 Select Programs > Change Integration Options.


To start the Integration Utility from the command line:


Step 1 Navigate to the root install directory\bin directory.

Step 2 Enter the following (including any options from Table 3-1) on the command line:

nmic.exe


Starting Integration Utility on NMS

If the Integration Utility is integrated with the NMS, select
Change Integration Options from the appropriate top-level menu.

Downloading Data Bundle

A Network Management Integration Data Bundle (NMIDB) contains all the information required to add Cisco devices to a Network Management System (NMS).

The bundle is updated frequently, and you must use the latest version to successfully use your NMS with CiscoWorks applications.

When you upgrade device support, a new NMIDB is often downloaded. If the Integration Utility detects a later version of the NMIDB, it prompts you to install it.

Alternatively, you can manually retrieve the latest NMIDB from a file on your local machine, from Cisco.com, or from another system.

If the Integration utility has already been integrated into your NMS, you can download the data bundle from the Update Cisco Device Support menu.

Select Update Cisco Device Support from the appropriate top-level menu (the location varies depending on where CiscoView applications have been installed on your system). The new NMIDB is automatically retrieved and integrated into the NMS.

You must log in as root on UNIX or have administrator privileges on Windows to run the Integration utility.

To download the data bundle:


Step 1 Start the Integration Utility.

The utility checks for a new (later version) NMIDB downloaded by the Software Center.

If it finds a later NMIDB, a dialog box appears, prompting you to update to the later version.

Click Yes if you want to install the new NMIDB.

Click No if you do not want to use the new NMIDB downloaded by the Software Center.

If you do not install the new NMIDB, you are prompted to install it each time you start the Integration utility until a later version is installed.

Step 2 If a new NMIDB was not detected or you clicked No in Step 1, select one of these options from Table 3-2.

Table 3-2 NMIDB Download Options 

Option
Purpose
Enter

File

Install the NMIDB from a file on your local machine.

Enter the full directory path and the NMIDB file name. For example:

On Windows, enter:

C:\temp\nmidb.xxx

where xxx is the NMIDB version.

On UNIX, enter:

/tmp/nmidb.xxx

where xxx is the NMIDB version.

Or

Click Browse to search for the NMIDB file.

Cisco.com

Install the NMIDB from Cisco.com.

Enter your Cisco.com username and password.

You must have Cisco.com login privileges.

If you do not have a user account and password on Cisco.com, contact your channel partner or enter a request on the web site (www.cisco.com).

FTP

Install the NMIDB from another system.

Enter the device login information:

System name

User name

User password

Full directory path and the NMIDB file name (for example, /tmp/nmidb.xxx).


Step 3 Click Get NMIDB.

The NMIDB is installed if it is a version later than the version of the NMIDB already installed on your system.

Step 4 Click Next.

If you made changes to any fields in this dialog box, you are prompted to confirm whether you want to get the NMIDB from the new location.

Click Yes to install the new NMIDB and proceed to the next dialog box.

The NMIDB is installed if it is a version later than the version of the NMIDB already installed on your system.

Click No to cancel your changes and proceed to the next dialog box.


Integrating CiscoWorks Applications to NMS

Use the Application Integration dialog box to select the applications you want to integrate into NMS. Integrating an application allows you to launch that application from an icon or menu in your NMS.

Before you register applications with the NMS, you must complete downloading the data bundle for this device.

If you do not download the data bundle, the Integration utility uses the already-installed NMIDB.

To integrate CiscoWorks applications to your NMS:


Step 1 Select an application tab.

There is one tab for each available application. If you are updating NMIDB for new device support only and do not need to make any application registration changes, skip the following steps and click Next.

To designate a default application that launches from the NMS, check the Set as default application to be launched from NMS check box.

Some Network Management System adapters do not support this option.

After integration takes place, double-click the device icon on the NMS map.

Step 2 Change the registration parameters as follows:

To register web-based applications, enter or select:

HTTP/HTTPS protocol.

CiscoWorks web server host name or IP address.

CiscoWorks web server port number.

Browser executable with the full path to launch the application.

To register another application, select another application tab.

Step 3 Click Next after completing the registration process for all applications.

If you made any application registration updates, a confirmation dialog box prompts you to save or cancel your changes.

Click Yes to save your changes and proceed to the Choose Adapters dialog box.

Click No to cancel your changes and proceed to the Choose Adapters dialog box.

Figure 3-1, displays HPOV after integration with CiscoView.

Figure 3-1 HPOV After Integration With CiscoView

1

CiscoWorks Application (CiscoView)

2

Cisco Alarms-appearing after integration

3

HPOV Panner

4

Cisco Icon



Updating NMS

You can update or change the Network Management System (NMS) with which you integrate your CiscoWorks applications.

For example, you can upgrade from HP Network Node Manager 6.4 to 7.0 or you can use another NMS.

To preserve the integration with CiscoWorks applications, you must acquire a new adapter script. Adapter scripts integrate icons, MIBs, and applications from the NMIDB into the NMS.

Before you run the adapter script to integrate your CiscoWorks applications, make sure the NMS for that script is available.

To update your NMS:


Step 1 Select an adapter script from the Available Adapters list.

You can select an adapter script from the list of NMS adapters provided with the Integration Utility or use an adapter script provided by the NMS vendor.

When you select a script from the Available Adapters list, a description of that script appears in the Adapter Description dialog box.

To add an adapter script to the list:

a. Click Add.

The Get New Adapter dialog box appears.

b. Select one of these options from Table 3-3:

Table 3-3 Options for Installing Adapter Script

Options
Purpose
Enter

File

Install the adapter script from a file on your local machine.

Enter the full directory path and the adapter script file name. For example:

On Windows, enter:

C:\temp\xxxadapter.jar

where xxx is the name of the NMS adapter.

On UNIX, enter:

/tmp/xxxadapter.jar

where xxx is the name of the NMS adapter.

Or

Click Browse to search for the adapter script jar file.

FTP

Install the adapter script from another system.

Enter the following device login information:

System name

User name

User password

Full directory path and the adapter script jar file name.

For example, /tmp/xxxadapter.jar.

where xxx is the name of the NMS adapter.


c. Navigate to the directory that contains the new adapter script and select the file.

d. Click OK.

The script is added to the Available Adapters list.

Step 2 Click Integrate to run the selected script.

The adapter script integrates the icons, MIBs, and applications into the NMS.


Troubleshooting Integration Utility

Use the suggestions in the Troubleshooting Suggestions Table 3-4 to resolve errors or other problems you encounter while using Integration Utility.

Table 3-4 Troubleshooting Suggestions 

Symptom
Probable Cause
Possible Solutions

Invoking NMIC displays error messages while extracting NMIDB.

After integration, when you run Change Integration Options, your system extracts NMIDB.

If there is not enough disk space to extract NMIDB, the extraction fails.

Free up some disk space and relaunch Change Integration Options.

On Windows, make sure you have at least 190 MB of free disk space.

For other file and operating systems, make sure you have at least 25 MB of free disk space.

Login screen appears every time CiscoView is started from the Network Management Platform.

For example, HP Network Node Manager using Internet Explorer (IE).

Since IE opens URLs in a separate process, the Login screen appears for each click on the Network Node Manager (NNM) icon.

Use Netscape Navigator to bring up CiscoView.

When you have already entered the passwords in a Netscape browser session, you do not enter the password when you invoke another window.

To change the browser path, you have to invoke Change integration options and point the browser location path to Netscape and integrate it.

Cannot display specific Cisco device icons with adapter 1.7 for HP Network Node Manager.

This happens when the NMIDB used for integration does not have the specific device icon information.

You can extract the latest NMIDB from Cisco.com using the Change Integration Utility GUI and perform the integration.

After Integration, traps are not properly integrated.

This happens when the appropriate NMS Adapter is not being used.

Download the latest adapter version from Cisco.com for the specific NMS.