Using CiscoWorks on SNM

This chapter contains an overview of how CiscoWorks functions with SunNet Manager (SNM), one of the supported platforms for the CiscoWorks network management system.

The following topics are discussed:

Overview of SNM and CiscoWorks
Starting CiscoWorks
Learning about other CiscoWorks applications on SNM
Using security options
Database synchronization

Overview of SN M Versus CiscoWorks Features

CiscoWorks is integrated with the SunNet Manager (SNM) network management platform.

Note To understand the relationship between SNM and CiscoWorks, you should be familiar with SNM features such as the Create, Discover, and Change Type commands. For all SNM questions, refer to your SNM documentation.

During installation and configuration, CiscoWorks adds customized schema files with Cisco-specific device types, such as the Cisco AGS+, to the SNM schema files directory. CiscoWorks also adds its applications to the SNM Tools and Glyph menus.

Note Familiarize yourself with the standards and conventions used by OPENLOOK. To familiarize yourself with OPEN LOOK standards, read the appendix on the OPEN LOOK interface in the SunNet Manager 2.0 Reference Guide. CiscoWorks supports these standards for all its graphical-user-interface components, such as using the mouse, opening windows and menus, and manipulating windows and icons.

It is important that you understand the SNM environment and how you can use SNM in conjunction with CiscoWorks. To answer your SNM network management questions, refer to the SNM documentation.

SNM Processes That Affect CiscoWorks

Some processes in SNM affect how CiscoWorks runs, depending on their configuration in SNM. As you continue to work with SNM processes and CiscoWorks, consider the following conditions in which the two environments coexist:

In SNM, you can customize the operation of the SNM Console and other SNM tools (such as the Results Browser and Results Grapher), or you can accept the default configuration. For example, one option in customizing your configuration is to specify how device errors are indicated on the screen, either by visual or audible signals. To set this type of configuration, refer to your SunNet Manager 2.0 User's Guide.

: One important option you may want to consider is to customize your system to automatically receive information about device status. To set this option, you must open the Console Properties window and enable the SNM Automatic Management feature, as described in the SunNet Manager 2.0 Reference Guide.

In SNM, you can use the SNM Discover Program to automatically create your map (referred to by SNM as a run-time database). You also can manually add devices (referred to by Sun as components) to your map.

: Especially important is the SNM Change Type command on the SNM Glyph menu. The Change Type command enables you to change the device type. You might need to use this command if you used the SNM Discover tool, and SNM incorrectly classifies the element type of a device. You must classify device types accurately to their specific product names or product types because availability and correct operation of many CiscoWorks applications depends on the correct classification of the device type.

If you are interested in creating a true network map (which includes different hierarchical views, devices, connections, and buses), refer to the SunNet Manager 2.0 User's Guide for specific instructions.You also will use the SNM Create command or, the CiscoWorks Device Management or Sync w/Sybase Tools, to add new devices to your network map.
For a brief overview on how the SNM Discover tool is used, refer to Chapter 5, "Learning to use CiscoWorks." For a detailed description of the SNM Discover tool, refer to your SunNet Manager 2.0 Reference Guide.

Setting Environment Variables

To use SNM and CiscoWorks, you must set the following environment variables:

DISPLAY--Tells programs to which Xserver to connect.
MANPATH--Directory path for CiscoWorks manual pages.
NMSROOT--Directory path for CiscoWorks software. The default is /usr/nms.
PATH--Modify to include $NMSROOT/bin and $SNMHOME/bin.
SNMHOME--Directory path for SNM software. The default is /usr/snm.
SYBASE--Directory path for Sybase software. The default is $NMSROOT/sybase.

Normally, you should set these variables before installing CiscoWorks. For information on setting environment variables, refer to Chapter 4, "Validating CiscoWorks Installation."

Starting CiscoWorks

This section briefly discusses how to start the SNM Console in order to access CiscoWorks. For a more detailed description and options, refer to the SunNet Manager 2.0 User's Guide.

You can use several different commands to start the SNM Console. However, you must be running Open Windows.

Note Do not use the following commands until you install SNM in the default installation directory.

Step 1 To start the SNM Console initially (when there is no database present) or when you want to bring up the last map file, enter the following:

hostname% snm

If problems occur, your PATH environment variable might not include a path to SNM executables. You can enter a fully qualified path. In the following example, /usr/snm/bin is the path to the executables:

hostname% /usr/snm/bin/snm

Step 2 To load a database map file (in ASCII format) into the SNM Console, from the SNM File menu, select the Load command.

Caution Using the snm -i command, described next, will cause the existing SNM database to be lost if you have not saved it.

Step 3 To start the SNM Console enter one of the the following:

To start SNM without a database map file (which clears the run-time database), enter the following:

: % snm -i

To start SNM with a specified map file (map_name is an ASCII database file), enter the following:

: % snm <map_name>

For more information on starting the SNM Console or troubleshooting problems with startup, refer to the SunNet Manager 2.0 User's Guide.

Learning about Other CiscoWorks Applications on SNM

This section briefly outlines the steps you must complete in SNM before continuing with CiscoWorks tasks. For instructions on using specific CiscoWorks applications, refer to the CiscoWorks User Guide.

Follow these steps to learn about CiscoWorks tools that use the Sybase database:

Step 1 Start SNM (if not started already).

Refer to the section "Starting CiscoWorks" earlier in this chapter to learn how to start SNM.

Step 2 Access the Security Manager application to turn on authentication checking and provide users and groups access privileges to CiscoWorks applications.

For more information, refer to Chapter 6, "Setting Up Domains and Securing Applications" in the CiscoWorks User Guide.

Step 3 Set up your SNM run-time database using SNM Discover or manually create devices using the SNM Create command.

For SNM Discover information, refer to Chapter 5, "Learning to Use CiscoWorks" or to the SNM documentation.

Step 4 Use Sync w/Sybase to synchronize SNM database devices with the CiscoWorks Sybase database.

If you are adding individual devices, use the CiscoWorks Device Management application, the AutoInstall Manager, or the Glyph menu Sync w/Sybase application to add device data to the database. For information on the AutoInstall Manager, refer to Chapter 4, "Managing Cisco Device Configurations, in the CiscoWorks User Guide. For Sync w/Sybase and Device Management application information, refer to Chapter 5, "Device Management," in the CiscoWorks User Guide.

Note The Sync w/Sybase application synchronizes, or adds, devices that exist in the SNM database to the CiscoWorks database. The Sync w/SNM tool, located within Sync w/Sybase, allows you to add devices from the CiscoWorks database to the SNM database. Alternatively, you can add devices created in CiscoWorks by manually adding them using the Create command in SNM or the Initialize command in Device Management.

Step 5 Use the CiscoWorks applications and SNM tools to help you monitor and manage your network activity.

Table 6-1 lists some general network management tasks and associates the task with its responsible software application. Use this table to determine which documentation set (CiscoWorks or SNM) to use if you have questions or need information. The X indicates that this information is located in the SNM manual set for the tool or application.

CiscoWorks Versus SNM Task Descriptions

Task	SNM	CiscoWorks
Starting SNM Console	X
Using Discover	X
Traversing your network map (run-time database)	X
Creating or finding elements or element properties	X	Device Mgmt
Modifying or changing elements or element properties	X	Device Mgmt
Moving or connecting elements (devices)	X
Copying or deleting elements (devices)	X	Device Mgmt
Saving your network map (run-time database)	X
Using SNM applications (such as Results Browser and Results Grapher)	X
Configuring OPEN LOOK graphical interface standards (such as window manipulation and mouse settings)	X
Modifying a graph display	X
Printing graphs, windows, or text files	X
Changing the state of a glyph	X
Specifying an event (condition of notification)	X	Device Monitor
Checking the cause of an event	X	Log Manager
Changing how glyph state changes propagate	X
Viewing or changing the status of requests	X
Viewing error and traps	X	Log Manager
Managing SNMP devices	X	All CiscoWorks applications

CiscoWorks Use of SNM Tools

CiscoWorks uses two SNM tools: the Result Browser and Grapher. Following is a brief description of each tool and how it is used by CiscoWorks:

Result Browser--The SNM Results Browser retrieves, organizes, and views network management data. The Results Browser is used in several CiscoWorks applications, including Polling Summary.

: For example, the CiscoWorks Polling Summary application uses the Results Browser to display query reports on polled device groups. You can display report data or send this data to the SNM Grapher.

Grapher--The SNM Grapher presents real-time or logged network data in graphical format. The Grapher is used in the CiscoWorks Health Monitor and Real-Time Graphs applications to display data in graphical format. You can change the properties of your graph using SNM to reflect your customized colors; delta, absolute, or cumulative graphing formats; and so on.

For more detailed information on the Results Browser and Grapher, refer to your SNM documentation.

GUI and Menu Structure of CiscoWorks

CiscoWorks supports the OPEN LOOK graphical user interface (GUI) developed by Sun Microsystems. For information on using OPEN LOOK (including using your mouse, opening windows and menus, and manipulating windows and icons), refer to the SunNet Manager 2.0 Reference Guide.

Note If a window component is grayed out, the option or feature is either inactive or unavailable. For example, on the Health Monitor window, if a protocol button is gray, that protocol is not activated on the selected device.

When accessing the network management windows, keep the following in mind:

Management operations are usually associated with a selected device on the map. In the network map, you can select a device by clicking on it with the left mouse button or equivalent.
Depending upon the amount of information in the window and the location and the bandwidth to the device, you may have to wait a few seconds for the window to display on your screen.
You can quit an active window by clicking on the Exit button from the File menu. If several windows are displayed, you can close all popup windows. If all windows are primary windows, you must exit out of each window individually. A primary window is the first one displayed when you launch an application. For each application, the primary window represents the central hub from which you can enter or exit other related subwindows to act on the application in different ways.

Menu Structure of CiscoWorks Windows

Most primary windows contain the following common menu options:

File--Contains Print and Exit commands.
Security--Contains Change User, Change Domain, and Privileges commands.
Help--Displays help text and the version number for this application.

Some application windows contain other menu options. These options, along with full-menu descriptions of each application, are discussed in the CiscoWorks User Guide. Refer to the specific application for window descriptions.

File Menu

All primary windows contain a File menu. Figure 6-1 shows the opened File menu.

Figure 6-1: File Menu

Print Command

Each CiscoWorks primary window contains a Print command. There are two types of print options available in CiscoWorks applications. One option prints text displayed in a window using the lpr command. The other option prints a screen or window image using the SNM Snapshot utility. The CiscoWorks application you are in will determine the popup window that appears after you select the Print command.

When you use the Snapshot utility, you print the window on which the mouse pointer is resting. For example, when pointing to a menu bar (near the top of the window), Snapshot prints whatever is displayed on your monitor. When pointing to a browser, or text-displaying, window inside a window, Snapshot prints only the Browser window.

For more information on the Snapshot utility, refer to the SunNet Manager 2.0 User's Guide.

Table 6-2 lists CiscoWorks applications that use the Snapshot utility and those that use the lpr print command. In general, all windows that display text use the lpr command.

Print Command Options in CiscoWorks Applications

CiscoWorks Application	Snapshot Utility	lpr Command
AutoInstall Manager	X
Configuration Manager		X
Contacts		X
Device Inventory Manager	X
Device Management	X
Device Software Manager	X
Device Monitor	X
Device Polling	X
Environment Monitor	X
Domain Editor	X
Global Command Editor
Health Monitor	X
Log Manager	X	X
Configuration Snap-In Manager
Path Tool¹	X	X
Polling Summary	X
Process Manager	X
Real-Time Graphs	X
Scheduler	X
Security Manager	X
Show Commands		X
Software Library Manager	X
Sybase DWB	Not Applicable	Not Applicable
Sync w/Sybase		X

¹ The Print command used depends on which Path Tool window you are currently in: Tools menu or Glyph menu.

When you select Print on a window that accesses the lpr command, the Print Command window appears. (See Figure 6-2.)

Figure 6-2: Print Command Window

To print, enter the name of your printer, including any path designations, and click on the OK button. To close the window without printing, click on the Cancel button.

You can set up a default printer selection by setting an environmental variable PRINTER before you start SunNet Manager session. For example enter the following:

# setenv PRINTER <printername>

Note When you print a color image on a black and white printer, the colors are printed in various shades of gray.

Exit Command

To exit from a primary application window, from the File menu select Exit.

Exit closes the active window. If you exit from a primary window, the SNM Console displays. If you exit from a secondary window, the primary window displays. If multiple primary windows are opened, only the one from which Exit was invoked is closed; other windows remain open and active.

Security Menu

The Security menu appears in the windows of CiscoWorks applications that use authentication-checking, a feature that allows an administrator to grant different levels of access privileges to CiscoWorks applications. Depending on whether the application governs a process or database function, you can use the menu commands to access another domain, to log in as another user, or to learn what user privileges you have to a given CiscoWorks application.

Figure 6-3: Security Menu

Change Domain Command

The Change Domain command allows you to display another domain. A domain represents a logical group of devices. A device is any network entity that contains an SNMP agent. (Devices generally include routers, bridges, and communication servers.)

The Change Domain command is used by applications that work with devices listed in the Sybase database. Applications that support the Change Domain command include Device Monitor and Device Polling. Changing domains may alter your privileges to an application because privileges are granted according to your group/domain association. In most cases however, when you access another domain, you can expect reduced privileges to the applications that manage its devices.

Change User Command

The Change User command allows you to log in under another user name. Use this command when you need the privileges of another user in order to access applications that would otherwise be unavailable to you.

Privileges Command

The Privileges command allows you to display your current privileges for the specified CiscoWorks application. When you select the Privileges command, the User Privilege window appears, listing your application-specific privileges. (See Figure 6-4.)

Note An item in any CiscoWorks application that is grayed out represents an inactive or unavailable option or feature. If you need privileges beyond those defined by your User ID account, see your CiscoWorks administrator.

Figure 6-4: Us er Privilege Window

Help Menu

The Help menu provides options for viewing online help for the current application and its current version number. (See Figure 6-5.)

Figure 6-5: H elp Menu

Help on the Application

When you select On <application name>, a window similar to Figure 6-6 appears.

Figure 6-6: He lp Window

Enter characters in the search string field. Then use the Search Forward and Search Reverse buttons to find your search string in the displayed text.

Version Command

Use the Version command from the Help menu to display the current version of the active CiscoWorks application. (See Figure 6-7.)

Figure 6-7: Version Command

Using Command Buttons

The command buttons used in the Device Management application are described in this section. For more information on Device Management, refer Chapter 5, Device Management, in the CiscoWorks User Guide.

From the SNM Tools menu, select CW - Device Mgmt....

The Device Management window appears. (See Figure 6-8.)

Figure 6-8: Dev ice Management Window

The following command buttons appear along the bottom of the window:

New--New allows you to enter data on a new device and save it to the CiscoWorks database. New has a global save feature that saves relative data links, regardless of the position of the cursor in the window. This ensures that table-to-table relationships are implemented.

Click on the New button to open the Device Information Window. (See Figure 6-9.) When you click on the New button, you see panes for Device Details and Inventory Details and Administrative Details.

Note However, when you display information about a device that already exists, only the Device Details and Inventory Details panes are displayed. The Device Information Window still contains a pane for Administrative Details, but is displayed only when you select the Admin Details command from the Options menu.

Figure 6-9: De vice Information Window

Note Use care because adding data records to a related table may also result in the creation of a duplicate unwanted record in the primary or other window table. If this occurs, delete the duplicate record by selecting its name in the Device Management window and clicking on the Delete button.

When you finish entering data in the Device Information window, click on the OK button. The data is saved to the database and displayed in the Device Management window.

Modify--Click on the Modify button to open the Device Information window of the selected device. If you need help locating the device, use the Search menu and its Find command (from the Device Management window) to identify the exact device name.

With the Device Information window open, you can change the data in any field as your needs determine. If you like, you can copy and paste data directly among windows or the fields within windows. When you finish modifying data about a particular device, click on the Apply button to save the changes.

Note When you click on a device name in the Device Management window, the Interfaces and Contacts associated with that device appear in the remaining windows. Clicking on the Modify button always displays database fields belonging to the selected device name, even though a particular interface or contact name may also be selected.

Delete

Click on the Delete button to remove a specified Device Information record from the database. This command permanently erases a selected record.

Security Options

If you use the Security Manager application to protect specified applications, all users must enter a valid username and password to access the protected CiscoWorks applications. For a detailed description of which CiscoWorks applications you can protect, refer to Chapter 6, "Setting Up Domains and Securing Applications," in the CiscoWorks User Guide.

Each CiscoWorks application has varying levels of access privileges. Each user is granted inherent privileges to certain applications (such as the ability to display devices) based solely on the user's group-domain association of the user. The CiscoWorks administrator governing Security Manager can grant further levels of "application-specific" privileges (such as add or change database information) to selected groups.

Logging In and Out

With security enabled, if you previously used the Login function on the Tools menu to log into CiscoWorks, no user identification window appears. If you have not used the CiscoWorks Login function, each time you access any of the secured CiscoWorks applications, CiscoWorks prompts you for a username and password. This login controls access to the application.

If you used Security Manager to secure your CiscoWorks applications, you can use the Login and Logout function from the Tools menu. For more information on logging in and out, refer to Chapter 6, "Setting up Domains and Securing Applications," in the CiscoWorks User Guide.

Time Saver By using the Login function, you need to log in only once. If you do not use Login, CiscoWorks will require user identification information (username and password) each time you attempt to start a secured application.

Understanding Database Synchronization

Two distinct databases are used in your work with CiscoWorks. The first is the Sybase relational database that is used by CiscoWorks applications to contain information about network devices, polling data, configuration details, and other data needed by each application. The second is the SNM run-time database that is used by the SunNet Manager to store information about the network. By synchronizing the Sybase database of CiscoWorks with the SNM database of the network platform, you build a complete resource of information.

Use the Sync w/Sybase application to synchronize the database information. The Sync w/Sybase application appears in the Tools and Glyph menus. Run Sync w/Sybase from the Tools menu if you just initialized SNM, loaded your network map, and want to fully synchronize both databases. Run Sync w/Sybase from the Glyphs menu if you want to synchronize one or more specific devices. In both cases, the Sync w/Sybase window from which you can select other options displays. (See Figure 6-10.)

Figure 6-10: Sync w/Sybase

Depending on the number of database records and the information contained in each, database synchronization can be timely. To adjust for synchronization time and to meet special needs, select one of the following four commands from the Options menu of the Sync w/Sybase window:

Devices (Network-->Sybase)

: Copies the complete number and contents of database records from SNM to Sybase. These records might include information about the hardware platforms, community strings, and so forth. Allows you to choose the SNM device records that you want to add to Sybase. With the device name selected, click on the Sync button. To select contiguous items, hold down the Shift key and click additional device names or drag your mouse through a range of device names. To select discontiguous items, hold down the Control key and select individual device names.

Domains (Network-->Sybase)

: Updates device records for the selected domain in the Sybase database. With the domain name selected, click on the Sync button.

Quick Sync (SNM-->Sybase)

: Creates only entries in the Sybase table for devices listed in SNM--but excludes any specific information, such as inventory details or hardware platforms. Use this command if you need the databases to quickly recognize the devices contained in each. Later, if you decide that you want the complete device information available from SNM, you can copy it using another command from the Options menu of Sync w/Sybase, or the CiscoWorks Device Management application.

Sybase-->SNM

: Copies only the device records from Sybase that did not yet exist in SNM into the SNM database. This is the inverse process of Devices (Network-->Sybase). When you use Device Management or the AutoInstall Manager application to add a device directly to Sybase, it will not be recognized by SNM until you use the Sybase-->SNM command. Nor will the device name be recognized if you added it directly to Sybase but not yet added the glyph to SNM. If you delete a device from SNM, however, it remains as a record in Sybase until you manually delete it from Sybase. A network cloud appears in your network map that lists the device records that were added from this process.

Figure 6-11 illustrates the relationship between the SNM database and the CiscoWorks database. Although you can directly add device names to either database, you must run the Sync w/Sybase application to confirm that the information about a particular device is correct in both places.

Figure 6-11: Dat abase Creation for SNM and CiscoWorks

For more detailed information about the database and the Sync w/Sybase and Sync with SNM applications, refer to Chapter 5, "Device Management," in the CiscoWorks User Guide. For more information about the AutoInstall Manager application, refer to Chapter 4, "Managing Cisco Device Configurations."

Table of Contents