User Guide for CiscoWorks Common Services 3.1
Using Device Center

Table Of Contents

Using Device Center

Launching Device Center

Invoking Device Center

Using Device Center Functions

Enabling Debugging Tools

Using Management Station to Device Tool

Using Ping

Using Traceroute

Using SNMP Walk

Using SNMP Set

Using Packet Capture

Editing Device Credentials in Device Center

Editing Device Identity in Device Center

Displaying Reports

Performing Management Tasks


Using Device Center


The Device Center provides a device-centric view for CiscoWorks applications and a device-oriented navigation paradigm which provides you device-centric features and information from a single location.

Device Center provides a central point from where you can see a summary and reports for the selected device, invoke various tools on the selected device, and perform the tasks that can be performed on the selected device.

After launching device center, you can perform device-centric activities, such as changing device attributes, updating inventory, Telnet etc. depending on the applications that are installed on the Common Services Server. You can also launch Element Management tools, reports, and management tasks from the Device Center.

The features in the Device Center are from the CiscoWorks applications that are installed on the server. Since all information and reports for a single device is available from a single location, you can troubleshoot for a specific device using Device Center.

Device Center features and functions are available only from applications that reside on the same server on which Common Services is installed.

You cannot launch tools, reports, and perform management tasks that pertain to applications installed on a different server. You can use tools, view reports and perform management tasks according to your privileges.

The following sections of this chapter provide information on:

Launching Device Center

Invoking Device Center

Using Device Center Functions

Launching Device Center

You can launch Device Center using any of the following options:

Launch from the CiscoWorks home page.

Launch the Device Center main page from the CiscoWorks home page and select a device.

To launch device center from CiscoWorks home page, select Device Diagnostic Tools > Device Center.

Launch from CiscoWorks LMS Portal.

Launch the Device Center main page from the LMS Portal home page if you have installed the LMS Portal application on CiscoWorks Server.

Bookmark the Device Center URL and launch directly from the browser window.

Launch Device Center for a device from one of the application functions such as Reports.

For example, you can launch Device Center by clicking the Device name from RME Inventory Reports.

Launch From Third-Party applications by passing the device context as a parameter.

Invoking Device Center

You can invoke Device Center from CiscoWorks home page and perform device-centric activities, such as changing device attributes, updating inventory, and Telnet depending on the applications that are installed on the Common Services Server. You can also launch Element Management tools, reports, and management tasks from the Device Center.

To invoke Device Center:


Step 1 Go to the CiscoWorks home page and select Device Diagnostic Tools  > Device Center.

The Device Center page appears with the Device Selector in the left pane and Device Center overview information in the right pane.

Step 2 Enter the IP address or device name of the device and click Go.

Or

Select a device from the list-tree, in the Device Selector field. See Device Selector for more information.

The Device Summary, and Functions Available panes appear.

Step 3 Click any of the links under the Functions Available pane to launch the corresponding application function.

The links are launched in a separate window.

If you enter the device name or IP address of a device not managed by any of the applications installed on the Common Services server, the Functions Available pane displays only the default connectivity tools from Common Services.


Using Device Center Functions

You can use the following Device Center modules to select devices, get a summary on the devices, get reports, debug, and perform management tasks.

The Device Center screen is divided into different content areas. They are:

Device Selector

Summary

Functions Available

Device Selector

Device Selector displays the list of devices managed by applications that are installed on Common Services. Device Selector populates the devices for device selection in Device Center.

The devices shown in the Device Selector are those managed by applications that are installed in local server. If there are no managed devices, Device Center does not display Device Selector.

Device Selector displays devices in groups. This is the entry point for the Device Center page. You can select the device you want to troubleshoot using the Device Selector. After you select a device using Device Selector, you will get information on the applications that manage the device.


Note Refresh your browser to view the latest device list in the Device Selector.


Device Selector allows you to:

Change device selection to see related information for the selected device.

Troubleshoot or manage the device selected.

Select a device from the list-tree or by entering in the IP address or device name. When you select a device, the relevant Device summary and Functions Available panes appear.

Search for a set of devices in Device Center. You can perform a simple search or an advanced search of devices.

See Configuring Device Selector for more information on the improved Device Selector.

Summary

The Device Summary content in the Device Center displays a summary of the device. You can see the IP Address, Device Type, OS version, and Last Reload Date in the Device Summary content area.

The summary page displays information grouped on the basis of applications that provide the information.

Functions Available

The Management Functions dialog box in the Device Center Functions Available page helps you to get the list of Debugging Tools, the list of Reports, and the list of Management Tasks on a selected device.

You can launch the management functions (Tools, Tasks, Reports) by:

Selecting a device from device selector.

Entering a device IP address or device name in the text box and clicking the button.

Passing device context as parameters. Passing device context as parameter is meant for applications only.


Management Functions helps you perform the following tasks:

Enabling Debugging Tools

Displaying Reports

Performing Management Tasks


Note You must have the required privileges to use some of the functions.


Enabling Debugging Tools

The Tools pane in the Device Center page displays the list of debugging tools that are used with the device. This module helps you to debug device related problems.

Tools enable you to test device connectivity, and troubleshoot non-responsive devices. They are available for all devices.

This section contains the following:

Using Management Station to Device Tool

Using Ping

Using Traceroute

Using SNMP Walk

Using SNMP Set

Using Packet Capture

Editing Device Credentials in Device Center

Editing Device Identity in Device Center

Using Management Station to Device Tool

To troubleshoot problems with un-managed or non-responding devices, you can check the device connectivity by protocol. The Management Station to Device tool helps you diagnose Layer 4 (application) connectivity problems.

Layer 4 tests include the key services Essentials needs to manage network devices: debugging and measurement tools (UDP and TCP), the web server (HTTP), file transfer (TFTP), the terminal (Telnet), and read-write access (SNMP).


Note The Management Station to Device check will be done only for protocol connectivity. The credentials for the corresponding protocols will not be tested or verified.


If you enter a hostname is entered instead of an IP address, the program performs Name Lookup to find out the address. The test will fail if it cannot find an address.

You can test:

UDP (echo test, port 7)

Sends an echo request to UDP port 7.

TCP (echo test, port 7)

Sends an echo request to TCP port 7.

HTTP (availability test, port 80)

Sends an HTTP request to the HTTP port 80 of the destination device.

TFTP (availability test, port 69; device must be configured as a TFTP server)

Sends a TFTP request to the TFTP port (69) of the destination device.

Telnet (service test, port 23)

Checks whether Telnet is enabled on the device and if the destination device responds to a Telnet request. It does not verify whether the Telnet password in the database works.

Since Telnet runs on top of TCP, when Telnet succeeds, it means TCP is enabled on the device. If Telnet fails, there is no way to automatically determine if TCP is enabled or not. Perform a TCP test to check whether TCP is up or not.

SNMP (service test, port 161)

Sends an snmp get request to the destination device for an SNMP read test (SNMPR). It also sends an snmp set request to the device to test SNMP write (SNMPW). This protocol is supported for the versions of v1, v2c, and, v3.

SSH (service test, port 22)

Checks whether SSH is enabled on the device. If the destination device responds to SSH requests, this also tests whether CiscoWorks Server can make SSH requests to that device. It does not verify the password in the database.

If you launch Management Station To Device with Network Operator/Help Desk privilege, device credential fetching fails and the fields of read/write community strings of SNMP v1/v2c, read/write SNMPv3 credentials are set to default values. You have to manually enter SNMP v1/v2c/v3 credentials.

To test a device using ICMP Ping, select Device Diagnostic Tools > Device Center > Functions Available > Ping.

To invoke Management Station to Device tool:


Step 1 Select Device Diagnostic Tools > Device Center.

Step 2 Enter the name or IP address, fully qualified domain name, or hostname of the device you want to check in the Device Selector field and click Go.

Or

Select the device from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click Management Station to Device in the Functions Available pane.

The Management Station to Device dialog box appears.

Step 4 Select the connectivity applications you want to select.

All information you enter in the fields are case sensitive.

If you select SNMP v1/v2c, you should:

Select SNMP v1 or v2c.

Enter the Read Community string.

Enter the Write Community string.

Enter the Time out in seconds.

If you select SNMP v3, enter:

The Read User name.

The Read Auth PassPhrase.

The Read Auth Protocol. Select MD5 or SHA from the drop-down list.

The Write Username.

The Write Auth PassPhrase.

The Write Auth Protocol. Select MD5 or SHA from the drop-down list.

The Security Level (authNoPriv).

Timeout (in seconds, the default is 2 seconds).

If you select SSH as the connectivity application, you should:

Select either SSH ver1 or SSH ver2.

Enter the Timeout in seconds. The default is 2 seconds.

Step 5 Click OK.

The Interface Test Results popup displays the results. The Interface Details results screen shows the interfaces tested and the test results for each option.



Note The read/write username and password for SNMPv3 and the read/write community string for SNMP v1/v2c are case sensitive.


Using Ping

Use the Ping tool to test whether the device is reachable. A ping tests an ICMP echo message and its reply. Since ping is the simplest test for a device, use it first.

You can view the packets transmitted, and received, percentage of packet loss, and round-trip time in milliseconds. If ping fails, try using traceroute.

To use ping:


Step 1 Select Device Diagnostic Tools > Device Center.

Step 2 Enter the name or IP address, fully qualified domain name, or hostname of the device you want to check in the Device Selector field and click Go.

Or

Select the device from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click ping in the Functions Available pane,

The Ping window appears with the results of the ping.


Using Traceroute

Use the Traceroute tool to detect routing errors between the network management station and the target device.

Traceroute helps you understand why ping fails or why applications time out. It does this by diagnosing TCP/IP Layer 3 (transport) problems. You can view each hop (or gateway) on the route to your device and how long each hop took.

To use Traceroute:


Step 1 Select Device Diagnostic Tools > Device Center.

Step 2 Enter the name or IP address, fully qualified domain name, or hostname of the device you want to check in the Device Selector field and click Go.

Or

Select the device from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click Traceroute in the Functions Available pane.

The results of the trace appear in the Traceroute window.


Using SNMP Walk

SNMP Walk allows you to trace the MIB tree of a device starting from a given OID for troubleshooting, or gathering information about a certain device.

You should have System Administrator privileges to use this feature.

To use SNMP Walk:


Step 1 Go to the CiscoWorks home page and select Device Diagnostic Tools > Device Center.

The Device Center Window opens.

Step 2 Enter the name or IP address, fully qualified domain name, or hostname of the device you want to check in the Device Selector field and click Go.

Or

Select the device from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click SNMP Walk in the Functions Available pane.

The SNMP Walk dialog box appears.

Step 4 Enter the IP address or DNS name.

Step 5 Select the SNMP Version to be used.

For SNMP Version 1 and 2c (if it is a 64-bit counter, use SNMP v2):

Enter the Read community string.

For SNMP Version 3:

Enter the SNMPv3 Username.

Enter the SNMPv3 Auth Password.

Specify the SNMP v3 Auth Protocol. Select either the MD5 radio button or the SHA radio button.

Enter the SNMP Context Name. This is optional.

Step 6 Enter the starting OID (optional). If this field is left blank, the tool will start from 1.

Step 7 Enter the SNMP Timeout. The default is 10 seconds.

Step 8 Select the Output OIDs Numerically check box to print the output OIDs numerically. This is optional.

By default, the corresponding name of the OID is printed in the output window.

Step 9 Select the Output Indexes Numerically check box to show the output index numerically. This is optional.

Step 10 Select the Debug check box to enable the debugging option. This is optional.


Note All the fields are case-sensitive.


Step 11 Click OK to get the results.

The results will be based on the parameters you entered. When the walk is complete, you can save it as text. A full walk may take a long time.

The read/write username and password for SNMPv3 and the read/write community string for
SNMP v1/v2c are case sensitive. The SNMP walk dialog box displays the credentials (SNMP v1/v2c/v3) for the device from Device and Credential Repository (DCR), if these are available. Otherwise, the default values for the respective SNMP versions are displayed.

If you launch SNMP Walk feature with Network Operator/Help Desk privilege, device credential fetching fails and the fields of read/write community strings of SNMP v1/v2c, read/write SNMPv3 credentials are set to default values.

You have to manually enter SNMP v1/v2c/v3 credentials.


Using SNMP Set

You can use this option to set an SNMP object or multiple objects on a device for controlling the device. You should have System Administrator privileges to use this feature.

To use SNMP set:


Step 1 Go to the CiscoWorks home page and select Device Diagnostic Tools > Device Center.

The Device Center Window opens.

Step 2 Enter the name or IP address, fully qualified domain name, or hostname of the device you want to check in the Device Selector field and click Go.

Or

Select the device from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click SNMP Set from the Functions Available pane

The SNMP set dialog box appears.

Step 4 Enter the IP address or the DNS name.

Step 5 Select the SNMP Version.

For SNMP Version 1 and 2c (if it is a 64-bit counter, use SNMP v2):

Enter the Read/Write community string.

Enter the object ID that you are trying to set along with the instance ID or number.

Select the Object Type from the drop-down list. The available values are:

Integer

Unsigned Integer

TimeTicks

IP Address

Object ID

String

Hex String

Decimal String

Enter a new value. This depends on the Object Type you specify.

For SNMP Version 3 (NoAuthNoPriv and AuthNoPriv security levels):

Enter the SNMPv3 Username.

Enter the SNMPv3 Auth Password.

Specify the SNMP v3 Auth Protocol. Select either the MD5 radio button or the SHA radio button.

Enter the object ID that you are trying to set along with the instance ID or number.

Select the Object Type from the drop-down list. The available items are:

Integer

Unsigned Integer

TimeTicks

IP Address

Object ID

String

Hex String

Decimal String

Bits

Unsigned 64-bit Integer

Signed 64-bit Integer

Enter a new value. This depends on the Object Type you specify.

Enter the SNMPv3 Context Name. This is optional..

Step 6 Enter the SNMP Timeout. The default is 10 seconds.

Step 7 Select the debug check box to enable the debugging option.

Step 8 Click Next if you wish to add more SNMP objects on the device.

The SNMP Set dialog box appears.

Step 9 Fill in all required fields and click Next. Repeat this until you have added as many objects as you want.

Step 10 Click OK to get the results.

The results will be based on the parameters you entered. After you have completed setting the SNMP objects, you can save it as text and mail the output.

The read/write username and password for SNMPv3 and the read/write community string for SNMP v1/v2c are case sensitive. The SNMP Set dialog box displays the credentials (SNMP v1/v2c/v3) for the device from Device and Credential Repository, if these are available. Otherwise, the default values for the respective SNMP versions will be displayed.

If you launch SNMP Set feature with Network Operator/Help Desk privilege, device credential fetching fails and the fields of read/write community strings of SNMP v1/v2c, read/write SNMPv3 credentials are set to default values.

You have to manually enter SNMP v1/v2c/v3 credentials.


Using Packet Capture

The Packet Capture tool can be used to capture live data from the CiscoWorks machine to aid in troubleshooting. You should have System Administrator privileges to use this feature.


Note WinPcap must be installed to use this feature on Windows machines. The executable is available at: NMSROOT\objects\jet\bin\winpcap.exe, where NMSROOT is the CiscoWorks Installation Directory.


To capture the data from a machine:


Step 1 Go to the CiscoWorks home page and select Device Diagnostic Tools > Device Center.

The Device Center Window opens.

Step 2 Enter the name or IP address, fully qualified domain name, or hostname of the device you want to check in the Device Selector field and click Go.

Or

Select the device from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click Packet Capture in the Functions Available pane.

The Packet Capture dialog box appears.

A list of archived capture files is displayed. If no capture files are archived, then this dialog box displays that there are no records.

Step 4 Click Create in the Packet Capture dialog box.

The Packet Capture Inputs dialog box appears with the default values.

Step 5 Enter the following information:

Interface

If you have multiple interfaces on the machine, you must first select the interface that you want to use for the capture.

Address

This field accepts one or more addresses (separated by a single space). This value is used to locate the CiscoWorks machine in the network while capturing the packet.

Protocols and Ports or Applications (for data capture)

You can capture the data using either:

Protocols and Ports

By default, the packets are captured from the specified machine using the Protocol/Port Selection.

You may select this option if you know the number of the port.

Select the protocols, TCP, UDP, or ICMP, you want to include in the capture.

Select Any to include all three protocols (TCP, UDP, ICMP). By default, the TCP Protocol is selected.

You can enter the list of ports to capture data for TCP and UDP. The Port(s) field accepts one or more TCP or UDP ports separated by a single space. If you specify port without specifying the addresses in the Address field, the data is captured for that port for all the active devices.

Or

Applications

Click the Applications radio button and select from a preconfigured list of common CiscoWorks applications and standard applications, if you want to capture data using applications.

Cycle

You must specify when to stop the packet capture. You can terminate the capture after:

A certain period time.

The filter has captured a certain amount of data.

A certain number of packets have been captured.

By default, capture cycles stop after 60 seconds.

Step 6 Click OK.

The Packet Capture status popup appears with the current status of the capture. If you click OK with the default values (without setting any of the parameters) the screen will try to capture for the next 60 seconds.

After the capture is performed, the Packet Capture dialog box displays the new packet capture file along with the list of the archived capture files.

If you click Stop Capture in the popup, the capture stops. The packet capture information till then is added in the Packet Capture dialog box, among the archive files.

Step 7 Click on the new packet capture file link to get a sniffer output of packets received by the CiscoWorks Server.

The result can be opened in any sniffer application, such as Ethereal. These files are in binary libpcap format with a .jet extension. You can download these files directly through your web browser and e-mail them to the Cisco TAC for further analysis.


To delete an existing packet capture file:


Step 1 Go to the CiscoWorks home page and select Device Diagnostic Tools > Device Center.

The Device Center Window opens.

Step 2 Enter the name or IP address, fully qualified domain name, or hostname of the device you want to check in the Device Selector field and click Go.

Or

Select the device from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click Packet Capture in the Functions Available pane.

The Packet Capture dialog box appears with a list of archived capture files.

Step 4 Select the Packet Capture file you want to delete.

Step 5 Click Create in the Packet Capture dialog box.

The file is removed from the list of archived capture files.


Editing Device Credentials in Device Center

You can edit device credentials for the selected device, using this feature. You need to have System Administrator or Network Administrator privileges to use this feature.

To edit the credentials of a device:


Step 1 Go to the CiscoWorks home page and select Device Diagnostic Tools > Device Center.

The Device Center Window opens.

Step 2 Enter the name or IP address, fully qualified domain name or hostname of the device you want to look up, in the Device Selector field and click Go. You can also choose the device you want to look up from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click Edit Device Credentials from the Functions Available pane.

The Edit Device Credentials link launches the Edit Credentials dialog box.

Alternatively you can select Device and Credentials > Device Management from the Common Services application to open this dialog box. See Editing Device Credentials for details.

If the IP address or the device name you enter is not present in Device and Credential Repository (DCR), the Edit Device Credentials link will not be displayed.


Editing Device Credentials in Multi-Server Setup and Single Sign-On Setup

In a multi-server setup, the Edit Device Credentials link in the Slave server launches the Edit Credentials page in Master DCR server. The Edit Credentials page is not displayed when:

Master DCR server is not running.

An earlier version of the Common Services application is installed in Master DCR server.

When the Master and Slave servers are not configured in a Single Sign-On based setup, the Edit Device Credential link will direct you to the login page of DCR Master server. After you have entered your login credentials, the Edit Device Credentials page appears.

Editing Device Identity in Device Center

You can edit device information for the selected device, using this feature. You need to have System Administrator or Network Administrator privileges to use this feature.

To edit the device identity information:


Step 1 Go to the CiscoWorks home page and select Device Diagnostic Tools > Device Center.

The Device Center Window opens.

Step 2 Enter the name or IP address, fully qualified domain name or hostname of the device you want to look up, in the Device Selector field and click Go. You can also choose the device you want to look up from the list tree.

The Summary and Functions Available panes appear.

Step 3 Click Edit Device Identity from the Functions Available pane.

The Edit Device Identity link launches the Edit Device dialog box.

Alternatively you can select Device and Credentials > Device Management from the Common Services application to open this dialog box. See Editing Device Identity for details.

If the IP address or the device name you enter is not present in Device and Credential Repository (DCR), the Edit Device Identity link will not be displayed.


Editing Device Identity in Multi-Server Setup and Single Sign-On Setup

In a multi-server setup, the Edit Device Identity link in the Slave server launches the Edit Identity page in Master DCR server. The Edit Identity page is not displayed when:

Master DCR server is not running.

An earlier version of the Common Services application is installed in Master DCR server.

When the Master and Slave servers are not configured in a Single Sign-On based setup, the Edit Device Identity link will direct you to the login page of DCR Master server. After you have entered your login credentials, the Edit Device Identity page appears.

Displaying Reports

The Report pane in the Device Center page displays the list of the reports that can be launched for a device.

The reports displayed in the Report pane depends on the applications installed on the server.

Performing Management Tasks

The Tasks pane in the Device Center page displays the list of management tasks that can be performed on the Device.

The management tasks displayed in the Management Task pane vary depending upon the applications installed on the server.