Table Of Contents
Product Overview
System Requirements
Windows Systems
UNIX Server Systems with Solaris
UNIX Server Systems with Linux
PC Server Systems for Windows
UNIX Client Machine with Solaris
UNIX Client Machine with Linux
PC Client Machine with Windows
Enhanced Support for Operating Systems and Web Server Applications
Minimum Cisco Universal Broadband Router and Cisco IOS Requirements
Installing, Downloading, and Upgrading CBT 3.3
Using TCP Ports for CBT 3.3 Upgrade and Operation
Installing and Starting CiscoView on Solaris
Installing and Starting CBT on Windows
Installing and Starting CBT on Linux
Requirements for Installing Daylight Savings Time (DST) Operating System Patches
Configuring Cisco Broadband Troubleshooter
Configuring the Cisco CMTS to Use the CBT Spectrum Management Tools
Configuring the Java Runtime Environment
(Optional) Configuring CiscoView
(Optional) Using Subscriber Traffic Management with CBT 3.3
Reviewing the CBT Task Menu
User Guide
Configuration
Diagnostics
Hotline Tools
Spectrum Tools
Utilities
User Log Out
User Types in CBT
Workflow of Administrator and RF Technician Tasks
Setting Up CBT with a Password, Users, and Data for Routers and Subscribers
Changing the Administrator Password
Disabling or Enabling Password Text Display
Adding Users
Adding Router Information
Adding Subscriber Information
Setting Parameters in .INI Files
Parameters in the CONFIGS.INI File
Parameters in the POLLER.INI File
Parameters in the SPECTRUM.INI File
Parameters in the GUNSLINGER.INI File
Retrieving Subscriber or Provisioning Data by Using an External Interface
Retrieving Data with a Script
Retrieving Data with an Application on an HTTP Server
Retrieving Data with LDAP
Retrieving Data with BPR
Retrieving Data with CNR
Retrieving Subscriber Data from the Local Database
Retrieving Provisioning Data from the Local Database
Getting Summary Information and a Detailed Real-Time Status Report for a Modem
Getting Summary Information on a Modem
Getting a Detailed Real-Time Status Report for a Modem
Reviewing the CMTS Dashboard
Showing and Configuring the Flap List Analysis
Showing the Flap List Analysis
Scheduling the Flap List Analysis
Setting Parameters for the Flap List
Purging the Flap List
Using the Spectrum Management Tools
Using the Trace Window
Viewing Trace Windows
Sorting Support in the CBT 3.3 Graphical User Interface
Using Auto-Select in the Trace Window
Using the Spectrogram
Analyzing the Carrier-to-Noise Ratio
Playing Back Data
Playing Back a CNR Analysis
Working with Spectrum Management Clients
Enabling Instantaneous CPU Assessment for Spectrum Polling
Administrative Tasks for CBT 3.3
Mapping Hostnames from Applet to Servlet
Configuring Administrative Parameters for Spectrum Analysis
Troubleshooting Tips for CBT 3.3
Troubleshooting Continuous Sweep Spectrum Operation in CBT 3.3
Changing Server Ports in XML Script
Saving System Message Logs for Troubleshooting
Verifying Installation Status on the CBT 3.3 Server
Verifying the CBT 3.3 License
Troubleshooting the Poller
Troubleshooting Poller Problems
Uninstalling Cisco Broadband Troubleshooter
Uninstalling CBT on Solaris
Uninstalling CBT on Windows
Uninstalling CBT on Linux
Sample Code for Application Program Interfaces
Shell Script for Retrieving Subscriber or Provisioning Information
Java Code for Retrieving Subscriber or Provisioning Information
Product Overview
Multiple service operators (MSOs) and cable companies provide subscribers with a variety of cable services such as TV, video on demand, data, and voice telephony. Cisco Broadband Troubleshooter Release 3.3 (CBT 3.3) is a troubleshooting tool designed for network administrators and radio frequency (RF) technicians at a multiple service operator site. The network administrator and the RF technician use Cisco Broadband Troubleshooter Release 3.3 (CBT 3.3) to monitor and resolve RF problems in the MSO cable plant.
CBT 3.3 introduces several enhancements that make it more powerful than any prior release. This document describes configuration and operation procedures for CBT 3.3, with updates to cover newly supported operating systems, feature functions, MIB interoperability, and graphical user interface (GUI) enhancements.
Refer to the Release Notes for Cisco Broadband Troubleshooter Release 3.3 for itemized information and features introduced in CBT 3.3.
CBT 3.3 provides the following general functionality:
•
Provides summary statistics for each upstream port attached to a cable modem termination system (CMTS).
•Analyzes data captured from a Cisco CMTS and sorts problem modems into the following categories:
–Provisioning problems
–Reverse path noise problems
–Reverse path attenuation problems
–Packet corruption problems, showing the cyclic redundancy check (CRC) error value
•Shows the number of flapping modems and provides summary statistics on each one.
•Provides the following spectrum management tools so you can analyze data without using a spectrum analyzer:
–Trace Window
–Spectrogram
–Carrier-to-noise ratio (CNR) analysis
•Locates a subscriber's cable modem with wildcard searches for any of the following identifiers:
–MAC address
–Phone number
–Account ID
–Name
–Street address
–Zip code
•Shows detailed information for a cable modem in a real-time status report, with information from the following sources:
–The Cisco CMTS
–The cable modem itself
–The MSO subscriber database
•Provides several, flexible external interface options to integrate provisioning and subscriber information.
•Introduces support for Wideband SIP and SPA support on the Cisco uBR10012 router. For additional information about DOCSIS 3.0 Downstream Channel Bonding for Wideband on the Cisco CMTS, see the "Related Documentation" section of the Preface.
Note CBT 3.3 does not differentiate visually between normal cable modems and cable modems in DOCSIS 3.0 downstream channel bonding in the Trace Window, or additional dialog boxes and spectrum information displays, but fully supports both types of cable modems.
This release supports Cisco Broadband Troubleshooter installed on a server that is running the Solaris, Linux, or Windows operating systems.
System Requirements
This section lists the system requirements for:
•Each supported operating system (OS):
–Server
–Client
•The number of Cisco CMTS headend systems to be supported with CBT 3.3
•Cisco uBR7100 series, Cisco uBR7200 series, and Cisco uBR10012 series universal broadband routers
CBT 3.3 generally supports these OS platforms:
•Sun Fire V440 (for 500CMTS support) with Solaris 10
•Sun Fire V240, V210 and V100 with Solaris 10
•Windows Box (Windows 2K or XP)
•Windows XP Workstation with Linux Enterprise Edition
This section provides additional system-level information in these topics:
• Windows Systems
• UNIX Server Systems with Solaris
• UNIX Server Systems with Linux
• PC Server Systems for Windows
• UNIX Client Machine with Solaris
• UNIX Client Machine with Linux
• PC Client Machine with Windows
• Enhanced Support for Operating Systems and Web Server Applications
• Minimum Cisco Universal Broadband Router and Cisco IOS Requirements
Windows Systems
Windows systems supported include Windows 2000, Windows XP, and Windows XP Workstation with Linux Enterprise Edition.
UNIX Server Systems with Solaris
The following environment supports 10 Cisco CMTS headend systems:
•UNIX Server Sun Fire Systems with Solaris 10
•Sun Fire V100 server: small
•UltraSPARC-IIi processor: one at 550 MHz
•Memory: 256 MB (one 256-MB DIMM)
•7200 RPM IDE disk drive: one at 80 GB
The following environment supports 50 or 100 Cisco CMTS headend systems:
•Sun Fire V210 server: Medium
•UltraSPARC IIIi Cu processor: two at 1.34 GHz
•Layer 2 cache per processor: 1 MB
•Memory: 2 GB (four 512-MB DIMMS)
•10000 RPM Ultra 3 SCSI LVD disk drive: two at 73 GB
The following environment supports 500 Cisco CMTS headend systems:
•Sun Fire V440 server: Small
•UltraSPARC IIIi Processor: two at 1.593 GHz
•Internal cache per processor: 1 MB
•Memory: 4 GB (eight 12-MB DIMMS)
•10000 RPM Ultra320 SCSI disk drive: four at 73 GB
UNIX Server Systems with Linux
The following environment supports 10, 50, or 100 Cisco CMTS headend systems:
•Linux Red Hat Enterprise Edition workstation
•Pentium 4, 3.2 gigahertz (GHz) processor or higher
•2-GB DRAM
•20-GB disk space
PC Server Systems for Windows
The following environment supports 10, 50, or 100 Cisco CMTS headend systems:
•Windows 2000, or Windows XP workstation
•Pentium 4, 3.2 gigahertz (GHz) processor or higher
•2-GB RAM
•20-GB disk space
UNIX Client Machine with Solaris
The following client system supports CBT 3.3 on Solaris:
•Sun Fire V100 server: Small
•UltraSPARC-IIi processor: one at 550 MHz
•Memory: 256 MB (one 256-MB DIMM)
UNIX Client Machine with Linux
The following client system supports CBT 3.3 with Linux:
•Pentium 4, 3.2 gigahertz (GHz) processor or higher
•1-GB RAM
•Red Hat 10 or 9
PC Client Machine with Windows
The following client system supports CBT 3.3 with Windows:
•Windows 2000, or Windows XP workstation
•1-GB RAM
•Pentium 4, at 3.2 GHz or higher
Enhanced Support for Operating Systems and Web Server Applications
CBT 3.3 offers enhanced support for the following operating systems and web server software environments:
•DST patch
•Java Runtime Environment (JRE)
•Linux operating system
•Solaris operating system
•Tomcat Application Server
•Windows operating system
DST Patch for Operating Systems
CBT 3.3 introduces the operating system patch associated with recent Daylight Savings Time (DST) requirements.
Java Runtime Environment in CBT 3.3
CBT 3.2 supported Java Runtime Environment (JRE) through JRE version 1.4.1. CBT 3.3 now comes with Java J2SE Runtime Environment 5.0 embedded in it.
We also recommend upgrading to JRE 5.0 on the client side to benefit from the latest enhancements, caveat resolutions, and security features, specifically for the Solaris platform.
Linux Operating System
CBT 3.3 introduces support for Red Hat Enterprise Linux products and the Red Hat desktop operating system. We recommend upgrading from prior Linux versions, such as Linux Red Hat 7, 8, and 9, as these prior versions have reached the end of their support lifetimes.
Solaris Operating System
CBT 3.3 introduces support for the Solaris operating system through Solaris 10. The prior CBT 3.2 supported Solaris through Solaris 8. Cisco recommends upgrade to Solaris 10 for use with CBT 3.3 to gain support for high-performance server machines that require Solaris 10, and related CBT 3.3 enhancements.
Tomcat Application Server
CBT 3.3 introduces upgraded support for the Tomcat Application Server. In CBT 3.2, support was limited to jakarta-tomcat-4.1. CBT 3.3 extends support to include apache-tomcat-5.5.15. The latest Tomcat version introduces scalability and reliability enhancements supported in CBT 3.3, performance optimizations, and reduced garbage collection.
CBT 3.3 includes the latest Tomcat application upgrade, and it is not necessary to download this application server separate from CBT 3.3 installation.
Windows Operating System
CBT 3.3 supports the latest Windows Operating Systems from Microsoft, such as Windows 2000 or Windows XP. No additional Windows upgrades are required for CBT 3.3.
Minimum Cisco Universal Broadband Router and Cisco IOS Requirements
You can use Cisco Broadband Troubleshooter with the following universal broadband routers (uBRs):
•Cisco uBR7100 series universal broadband router
•Cisco uBR7200 series universal broadband router
•Cisco uBR10012 universal broadband router
On these routers, CBT 3.3 supports the following Cisco IOS releases:
•Cisco IOS Release 12.3(9a)BC, Cisco IOS Release 12.3(17a)BC, Cisco IOS Release 12.3(21)BC, and later releases of the 12.3BC
Minimum Cisco Universal Broadband Router and Cisco IOS Requirements to Use Spectrum Management Features in CBT
To use the spectrum management features that Cisco Broadband Troubleshooter provides, you must have the following:
•Cisco uBR7200 series universal broadband router or Cisco uBR10012 universal broadband router
•Cisco IOS Release 12.3(9a)BC
For more information, see "Configuring the Cisco CMTS to Use the CBT Spectrum Management Tools" section.
Enabling SNMP on Routers
You must enable SNMP on the routers by entering the following commands:
Router# configure terminal
Router(config)# snmp-server community public RO
Router(config)# snmp-server community private RW
Note CBT retrieves the Cisco IOS release number, router name, and router type by using SNMP.
Using SNMP MIBs in Cisco CBT 3.3
Cisco Broadband Troubleshooter Release 3.3 (CBT3.3) uses the following SNMP MIBs with Cisco IOS Release 12.3(21)BC and later releases:
•RFC1213-MIB
•IANAifType-MIB
•IF-MIB
•SNMPv2-MIB
•SNMPv2-TC
•CISCO-SMI
•OLD-CISCO-CHASSIS-MIB
•CISCO-PRODUCTS-MIB
–DOCS-IF-MIB
–DOCS-IF-EXT-MIB
–CISCO-CABLE-SPECTRUM-MIB
–CISCO-DOCS-EXT-MIB
•CISCO-PING-MIB
•INET-ADDRESS-MIB
•SNMP-FRAMEWORK-MIB
–DOCS-CABLE-DEVICE-MIB
–CISCO-PROCESS-MIB
–DOCS-QOS-MIB
–ENTITY-MIB
–CISCO-CABLE-QOS-MONITOR-MIB
–CISCO-DOCS-REMOTE-QUERY-MIB
When extracting the downloaded CBT 3.3 file, these MIBs are placed by default in the following path:
<CBT Install Directory>/httpServer/webapps/ROOT/WEB-INF/mibs
Note Not all the tables contained in these MIBs are used with CBT 3.3.
Generally, all read and create objects in the ccsSpectrumRequestTable and ccsSNRRequestTable can be set with spectrum management tools in CBT 3.3. These objects require a WRITE community string:
•ccsSpectrumRequestTable
–ccsSpectrumRequestIfIndex
–ccsSpectrumRequestMacAddr
–ccsSpectrumRequestLowFreq
–ccsSpectrumRequestUpperFreq
–ccsSpectrumRequestResolution
–ccsSpectrumRequestOperation
–ccsSpectrumRequestStatus
•ccsSNRRequestTable
–ccsSNRRequestMacAddr
–ccsSNRRequestOperation
–ccsSNRRequestStatus
For additional MIBs information for the Cisco CMTS, refer to the following resources on Cisco.com:
•Cisco CMTS Universal Broadband Router MIB Specifications Guide
http://www.cisco.com/univercd/cc/td/doc/product/cable/cmtsmib/
•SNMP Object Navigator
http://www.cisco.com/pcgi-bin/Support/Mibbrowser/unity.pl
Installing, Downloading, and Upgrading CBT 3.3
Use the following steps to download and to install CBT 3.3 on a system with the Linux, Solaris, or Windows operating systems. This section contains the following topics:
• Using TCP Ports for CBT 3.3 Upgrade and Operation
• Installing and Starting CiscoView on Solaris
• Installing and Starting CBT on Windows
• Installing and Starting CBT on Linux
• Requirements for Installing Daylight Savings Time (DST) Operating System Patches
Using TCP Ports for CBT 3.3 Upgrade and Operation
Note Cisco implements a default TCP port of 8105 on the licensing server for CBT 3.3 in XML script. This prevents port conflict with other applications. If you require a TCP port other than the default of 8105, then set the TCP port after installation of CBT 3.3, but prior to licensing. Refer to Step 5 below.
We recommend ports other than 8005, 8080, 9080, 9443, or 9082.
The following are the default ports used by CBT 3.3:
•Port 8105: Java Virtual Machine (JVM) server port
•Port 9080: Non-SSL HTTP port
•Port 9443: SSL HTTP port
•Port 9082: Apache JServ Protocol (AJP) 1.3 Connector
•Port 2640: For Sybase database connectivity
•Port 8020: For Poller operation
CBT 3.3 uses the following port ranges for spectrum operations. Spectrum events such as Trace Window, Spectrogram, CNR Trending, and the Generic Query use a specified range of port numbers for operation.
•For both Trace Window events and the Spectrogram events, the port numbers range from 2100 to 2500.
•For the Spectrum tools, such as CNR Trending, port numbers range from 3100 to 3500.
•For the Diagnostic tools, such as Generic Query, the port numbers range from 5100 to 5500.
•The usage of these spectrum port numbers should be in increments of 1, meaning the first trace Window launched obtains port number 2100, and the next Trace Window obtains port 2101. The next Spectrogram window would be port 2102, and continuing upward to port 2500.
CBT 3.3 Download and Upgrade
Step 1 Download CBT 3.3 software for the desired platform from Cisco.com to your local directory <CBT3.3_DOWNLOAD_DIR>.
•Cisco.com locations:
http://www.cisco.com/cgi-bin/tablebuild.pl/cbt
•Platform files and release notes:
–There is a single file for the Solaris platform—CBT33-Solaris.tar.gz
–There is a single file for the Linux platform—CBT33-Linux.tar.gz
–Platform files for the Windows platform—CBT33-Win.exe
–CBT 3.3 Release Notes—CBT33ReleaseNotes.pdf
Step 2 Extract the software. For Solaris and Linux, use the commands below. For Windows 2000 and Windows XP, skip to Step 3.
•Solaris:
a. cd <CBT3.3_DOWNLOAD_DIR>
b. gunzip CBT33-Solaris.tar.gz
c. tar xvf CBT33-Solaris.tar
•Linux:
a. cd <CBT3.3_DOWNLOAD_DIR>
b. gunzip CBT33-Linux.tar.gz
c. tar xvf CBT33-Linux.tar
Uninstalling Prior CBT Releases
Step 3 If there is a previous CBT installation (CBT 2.x, CBT 3.0, or CBT 3.2), uninstall it using the following procedures; otherwise, skip to Step 4.
•Solaris: cd <CBT3.x_DOWNLOAD_DIR> ./uninstall
•Linux: cd <CBT3.x_DOWNLOAD_DIR> ./uninstall
•Windows:
–In Windows Explorer, double-click CBT3x-Win.exe in <CBT3.x_DOWNLOAD_DIR>.
–Remove the existing CBT installation.
Step 4 Install CBT 3.3.
•Solaris: cd <CBT3.3_DOWNLOAD_DIR> ./install
•Linux: cd <CBT3.3_DOWNLOAD_DIR> ./install
•Windows:
–From Windows Explorer, double-click CBT33-Win.exe in <CBT3.3_DOWNLOAD_DIR>.
–Select the default answers to the installation questions.
Note A demonstration version of CBT 3.3 is now running (a license is not included in the Cisco.com download). To make the software fully functional, obtain a license for CBT 3.3 from Cisco Systems. See Step 5.
Step 5 Purchased copies of CBT no longer include a software CD, but include a license certificate with a PAK key. This PAK key generates the necessary license file from the following websites, and the software is downloaded from Cisco Connection Online.
•Use this site if you are a registered user of Cisco Connection Online:
www.cisco.com/go/license
•Use this site if you are not a registered user of Cisco Connection Online:
www.cisco.com/go/license/public
Note Save the license file with the name "License" from the Cisco Server location and follow the instructions in Step 6 to copy it to the appropriate directory for use by CBT 3.3.
Demonstration copies are available either by way of the Internet, or as an ordered accessory for a universal broadband router product.
The copies supplied with a universal broadband router product include a demo license certificate with a PAK key.
The copy available from the Internet uses a registration page where the PAK key is e-mailed to you.
Step 6 Use the following commands or click sequences to copy the license to the license directory and restart CBT 3.3.
•Solaris:
1. cp License /opt/CSCOcbt/httpServer/webapps/ROOT/WEB-INF/classes/lic
2. /opt/CSCOcbt/bin/stop_app
3. /opt/CSCOcbt/bin/start_app
•Linux:
1. cp License /opt/CSCOcbt/httpServer/webapps/ROOT/WEB-INF/classes/lic
2. /opt/CSCOcbt/bin/stop_app
3. /opt/CSCOcbt/bin/start_app
•Windows:
1. copy License <CBT3.3_INSTALLATION_DIR>\httpServer\webapps\ROOT\WEB-INF\classes\lic>
2. Click Start > Programs > Cisco Broadband Troubleshooter > Stop Troubleshooter
3. Click Start > Programs > Cisco Broadband Troubleshooter > Start Troubleshooter
Note Once the CBT 3.3 license is installed and active, additional changes to the license are not supported. License changes disable an otherwise valid license.
Figure 1 CBT Log In Window
Installing and Starting CiscoView on Solaris
Note The Solaris installation package for CBT 3.3 includes the CiscoView installation package.
Step 1 Obtain the software as per the instructions in the "CBT 3.3 Download and Upgrade" section.
Step 2 Log in as root.
Step 3 (Optional) If you are not running Solaris Volume Manager as root, you must mount manually the CD:
•If a mount point does not exist, create one by making a new /cdrom directory.
•Enter the following command, where CD-ROM device is the name of your CD-ROM:
mount CD-ROM device /cdrom
Note If you are running Solaris Volume Manager, the CD-ROM automatically mounts on the /cdrom/cdrom0 directory.
Step 4 To change to the CiscoView Solaris directory and install CiscoView, enter:
cd /cdrom/cdrom0/solaris/cv
The CBT server is now running.
Step 5 (Optional) If you are not running Solaris Volume Manager, make sure that no other application is using /cdrom as the current directory so that you can unmount the CD by entering:
Note If you are running Solaris Volume Manager, the CD-ROM automatically unmounts.
Step 6 To eject the CD, enter:
Installing and Starting CBT on Windows
DETAILED STEPS
Step 1 Obtain the software as per the instructions in the "CBT 3.3 Download and Upgrade" section.
Step 2 From Windows Explorer, double-click CBT33-Win.exe.
Step 3 Select the default answers to the installation questions.
The CBT server is now running.
Step 4 To start CBT by using the menus, choose:
Start > Programs > Cisco Broadband Troubleshooter > Start Troubleshooter
or
To access CBT by using a browser, open the browser and enter:
http://CBT server IP address:9080/
Note In the URL, CBT server IP address is the server on which you installed CBT.
Step 5 In the Log In window (see Figure 1), enter your username and password.
Step 6 (Optional) To stop CBT manually, choose:
Start > Programs > Cisco Broadband Troubleshooter > Stop Troubleshooter
Installing and Starting CBT on Linux
Step 1 Obtain the software as per the instructions in the "CBT 3.3 Download and Upgrade" section.
Step 2 Log in as root.
Step 3 Change to the download CBT Linux directory, as established in Step 1.
Step 4 To start the installation program, enter:
The CBT server is now running.
Step 5 To start CBT by using a command line, enter:
or
To access CBT by using a browser, open the browser and enter:
http://CBT server IP address:9080/
Note In the URL, CBT server IP address is the server on which you installed CBT.
Step 6 In the Log In window (see Figure 1), enter your username and password.
Step 7 (Optional) To stop CBT manually, enter:
Requirements for Installing Daylight Savings Time (DST) Operating System Patches
CBT 3.3 requires that the latest operating system patches be installed for all platforms supported by CBT 3.3. Refer to the "Enhanced Support for Operating Systems and Web Server Applications" section for additional information about supported platforms.
JRE OS-Level Requirements
CBT 3.3 supports the latest Java Runtime Environment (JRE 5.0) platform. However, the network administrator must ensure that all OS-level patches are installed to avoid system problems with CBT 3.3. This section describes patch requirements according to platform.
•Microsoft Windows operating systems:
–See DST information at <Preparing for Daylight Saving Time changes in 2007> available at http://www.microsoft.com/windows/timezone/dst2007.mspx
•Linux operating systems:
–For Red Hat Enterprise Linux 3 (RHEL3), see information at http://rhn.redhat.com/errata/RHEA-2005-655.html
–For Red Hat Enterprise Linux 4 (RHEL4), see information at http://rhn.redhat.com/errata/RHEA-2005-656.html
•Sun Solaris operating systems:
–See DST patch information for Sun Solaris 8, 9, and 10 at the following location:
http://sunsolve.sun.com/search/document.do?assetkey=1-26-102178-1
Configuring Cisco Broadband Troubleshooter
The following configuration procedures are required for using Cisco Broadband Troubleshooter Release 3.3:
• Configuring the Cisco CMTS to Use the CBT Spectrum Management Tools
• Configuring the Java Runtime Environment
The following configuration procedures are optional for CBT 3.3:
• (Optional) Configuring CiscoView
• (Optional) Using Subscriber Traffic Management with CBT 3.3
Configuring the Cisco CMTS to Use the CBT Spectrum Management Tools
Cisco Broadband Troubleshooter Release 3.3 provides spectrum management functionality, which is generated by Digital Signal Processing (DSP) in the Cisco uBR-MC16S Spectrum Management Line Card on the CMTS. The CBT spectrum management tools require Cisco IOS Release 12.2(15)BC1. For more information, see the "Minimum Cisco Universal Broadband Router and Cisco IOS Requirements" section.
Before using the spectrum management features in Cisco Broadband Troubleshooter, you must complete spectrum management configuration tasks on the CMTS. These configurations are outside the scope of Cisco Broadband Troubleshooter.
For more information, refer to the following document on Cisco.com:
•Spectrum Management and Advanced Spectrum Management for the Cisco CMTS
http://www.cisco.com/en/US/products/hw/cable/ps2217/products_feature_guide_chapter09186a008019b586.html
Configuring the Java Runtime Environment
This section describes Java Runtime Environment (JRE) requirements and procedures through JRE 5.0, but includes procedures for earlier JRE platforms.
JRE 5 OS-Level Requirements
CBT 3.3 supports the latest JRE 5.0 platform. However, the network administrator must ensure that all OS-level patches are installed to avoid system problems with CBT 3.3. This section describes patch requirements according to platform. Refer also to the "JRE OS-Level Requirements" section.
The Sun JRE 5.0 is a plug-in that must be installed in the client browser. Cisco Broadband Troubleshooter detects if JRE 5.0 is installed in the browser. This section provides directions to install JRE 5.0 in the browsers supported by each platform.
Installing JRE 5.0 in Microsoft Internet Explorer on the Windows Platform
If JRE 5.0 is not installed in Internet Explorer on the Windows platform, the installation is automatic.
Installing JRE 5.0 in Netscape Navigator on the Windows Platform
If JRE 5.0 is not installed in Navigator on the Windows platform, refer to the following location:
http://java.sun.com/javase/downloads/index_jdk5.jsp
Perform the following steps to install JRE 5.0 in Netscape Navigator on the Windows platform:
Step 1 From https://sdlc3d.sun.com, save jre-1_5_0_06-windows-i586-p.exe to a local directory.
Note In these steps, JRE5.0_07InstallationDirectory represents the local directory you choose.
Step 2 To install JRE 5.0, choose:
Start > Run > JRE5.0_07InstallationDirectory \jre-1_5_0_06-windows-i586-p.exe
Step 3 Close Navigator.
Step 4 Reopen Navigator.
Installing JRE 5.0 in Netscape Navigator on the Solaris Platform
If JRE 5.0 is not installed in Navigator on the Windows platform, refer to the following location:
http://java.sun.com/javase/downloads/index_jdk5.jsp
Perform the following steps to install JRE 5.0 on the Solaris platform:
Step 1 From https://sdlc3b.sun.com/, save jre-1_5_0_08-solaris-sparc.sh to a local directory.
Note In these steps, JRE5.0InstallationDirectory represents the local directory you choose and Netscape7.0InstallationDirectory represents directory where Netscape 7.0 is installed.
Step 2 To install JRE 5.0, enter:
jre-1_5_0_08-solaris-sparc.sh
Step 3 Point to the Java plug-in by typing the command for the version of Netscape you are using:
•Netscape 4.7—Set the environment variable NPX_PLUGIN_PATH to point to the Java plug-in by entering:
setenv NPX_PLUGIN_PATH JRE5.0InstallationDirectory/plugin/sparc/ns4
•Netscape 7.0—Create a softlink to point to the Java plug-in by entering:
ln -s JRE5.0InstallationDirectory/plugin/sparc/ns610/libjavaplugin_oji.so Netscape7.0InstallationDirectory/plugins/libjavaplugin_oji.so
Step 4 Close Navigator.
Step 5 Reopen Navigator.
Installing JRE 5.0 in Netscape Navigator on the Linux Platform
If JRE 5.0 is not installed in Navigator on the Windows platform, refer to the following location:
http://java.sun.com/javase/downloads/index_jdk5.jsp
Perform the following steps to install JRE 5.0 in Netscape Navigator on the Linux platform:
Step 1 From https://sdlc3b.sun.com/, save jre-1_5_0_08-linux-i586.bin to a local directory.
Note In these steps, JRE5.0_07InstallationDirectory represents the local directory you choose and Netscape7.0InstallationDirectory represents directory where Netscape 7.0 is installed.
Step 2 To install JRE 5.0, enter:
jre-1_5_0_08-linux-i586.bin
Step 3 Point to the Java plug-in by typing the command for the version of Netscape you are using:
•Netscape 4.7—Set the environment variable NPX_PLUGIN_PATH to point to the Java plug-in by entering:
setenv NPX_PLUGIN_PATH JRE5.0InstallationDirectory/plugin/i386/ns4
•Netscape 7.0—Create a softlink to point to the Java plug-in by entering:
ln -s JRE5.0_InstallationDirectory/plugin/i386/ns610/libjavaplugin_oji.so
Netscape7.0InstallationDirectory/plugins/libjavaplugin_oji.so
Step 4 Close Navigator.
Step 5 Reopen Navigator.
(Optional) Configuring CiscoView
CiscoView is a web-based device management application that provides dynamic status, monitoring, and configuration information for a range of Cisco internetworking products. CiscoView displays a physical view of a device chassis, with color-coding of modules and ports for at-a-glance status, and has two levels of capabilities:
•Monitoring capabilities—Displays performance and other statistics
•Configuration capabilities—Allows comprehensive changes to devices, if you have security privileges
For product information, refer to the following document on Cisco.com:
http://www.cisco.com/en/US/products/sw/cscowork/ps4565/index.html
You can launch CiscoView 5.x from CBT to monitor a device and get real-time information on it.
Perform the following steps to configure and launch CiscoView from CBT:
Step 1 To identify the CiscoView server so that CBT can launch the application, from the Configuration menu, choose CiscoView Server.
Step 2 To identify the device that you want to monitor with CiscoView, from the Utilities menu, choose CiscoView.
Step 3 For a complete description of each field in the CiscoView dialog boxes, click Help.
Note The Solaris installation package for CBT 3.3 includes the CiscoView installation package.
(Optional) Using Subscriber Traffic Management with CBT 3.3
To use the Subscriber Traffic Management (STM) feature of CBT 3.3, the cable qos enforce-rule command on the Cisco CMTS must be used with a QoS profile that is not created by the cable modem. Any in-use QoS profile, such as one created by a cable modem, can be turned into a management profile.
Note STM is newly supported on the MC16U, MC16X, MC28U, MC28X, and MC5X20S/U/H line cards with CBT 3.3. STM data is now enabled with CBT 3.3.
Perform the following steps to create a management profile:
| |
Command
|
Purpose
|
Step 1
|
Router# show cable modem registered
|
Finds the registered profiles on the Cisco CMTS. Finds a current registered profile that has the features you need.
|
Step 2
|
Router# configure terminal
|
Enters global configuration mode.
|
Step 3
|
Router (config)# cable qos profile n
|
Enters the QoS profile number of the registered profile that has the features you need.
|
Step 4
|
Router (config)# exit
|
Exits global configuration mode.
|
Reviewing the CBT Task Menu
This section describes the following components of the CBT Task Menu:
• CBT Task Menu
• User Guide
• Configuration
• Diagnostics
• Hotline Tools
• Spectrum Tools
• Utilities
• User Log Out
• User Types in CBT
• Workflow of Administrator and RF Technician Tasks
After you log on to CBT, the CBT 3.3 Task menu appears. See Figure 2:
Figure 2 CBT Task Menu
Above the menu, your user type is displayed. For more information on user types, see "User Types in CBT" section.
All tasks in CBT are divided into the following menus:
•User Guide
•Configuration
•Diagnostics
•Hotline Tools
•Spectrum Tools
•Utilities
•User Log Out
The following sections describe the tasks within each menu.
User Guide
The User Guide menu contains one task:
•User Guide—Links to the Cisco Broadband Troubleshooter Release 3.3 User Guide.
Configuration
The Configuration menu contains the following tasks:
•User List—To specify who can access the application and with what level of access permissions
•CMTS List—To specify the routers you want to manage, by entering the information manually
•CMTS Group—To organize CMTSs into groups, so that you can manage several CMTSs as one unit
•Flap List Scheduler—To schedule a time to capture data from one or more CMTSs
•Flap List Parameters—To specify configuration parameters for the flap list
•CiscoView Server—To identify the CiscoView server so that you can launch CiscoView from CBT
•Message Log—To filter which error and informational messages are logged by the server
•System—To modify system-level parameters that are saved to the CONFIGS.INI file
•External Interface—To specify how and where to access subscriber and provisioning information
•Poller—To schedule how often the Poller gets provisioning information from CMTSs
Diagnostics
The Diagnostics menu contains the following tasks:
•Flap List Analysis—To analyze the results of data captured for the selected CMTSs
•Cable Monitor Tool—To get summary information for Cisco cable modems
Hotline Tools
The Hotline Tools menu contains the following tasks:
•Locate Modem—To get summary information on one or more cable modems
•Modem Status—To generate a real-time status report for a cable modem
•CMTS Dashboard—To get detailed information on one or more CMTSs
•Ping Test—To see if a device has connectivity
•CiscoView—To identify the device that you want to monitor with CiscoView
Spectrum Tools
The Spectrum Tools menu contains the following tasks:
•Trace Window—To monitor the power and noise levels for a selected cable modem or upstream port
•Spectrogram—To monitor the power and noise levels over time for a selected cable modem or upstream port
•CNR Analysis—To retrieve carrier-to-noise ratio for selected modems or upstream ports
•Data Playback
–Trace Window—To play back a saved Trace Window
–CNR Analysis—To play back a saved CNR Analysis
•Clients—To get a list of each spectrum analysis in process on a client machine
•STM Tools—To access tools relating to Subscriber Traffic Management
Utilities
The Utilities menu contains the following tasks:
•Import
–CMTS List—To import an ASCII text file of subscriber data, such as name and phone number
–Subscriber Data—To import an ASCII text file of all the managed Cisco CMTSs, so that you do not have to enter each Cisco CMTS manually
•Map Calculation—To convert customer addresses into X/Y coordinates if you are using the optional third-party application, ESRI RouteMAP
•Purge Saved Data
–Flap List—To remove a saved Flap List Analysis from the database
–Spectrum Data—To remove a saved Trace Window or CNR Analysis from the database
•Message Log—To view error and information messages logged by the server, by using filters to show the level of detail you want
User Log Out
The User Log Out menu contains one task:
•User Log Out—To log out of Cisco Broadband Troubleshooter
User Types in CBT
The number of tasks you see in the CBT menu varies according to the type of user you are. There are two user types in CBT, each with access to different tasks:
•ADMIN—The administrator has access to all tasks in each menu.
•RFTECH—The RF technician has access to a subset of tasks in the following menus:
–Configuration menu—Can access the Flap List Scheduler task only. Figure 3 shows the Configuration menu for each user type.
–Utilities menu—Can access the Purge Saved Data and Message Log tasks only. Figure 4 shows the Utilities menu for each user type.
In each other menu, the RFTECH user has access to all tasks.
Figure 3 Configuration Menus for ADMIN and RFTECH Users
Figure 4 Utilities Menus for ADMIN and RFTECH Users
Workflow of Administrator and RF Technician Tasks
Figure 5 Administrator and RF Technician Tasks in CBT
Figure 5 illustrates a high-level workflow of tasks that each type of user, the administrator and the RF technician, performs in CBT.
Administrator Tasks
The first four tasks shown in Figure 5 are ones that only an administrator can perform.
•Install CBT—The administrator installs CBT on one of the supported platforms: Linux, Solaris, or Windows.
•Change administrator's password—The administrator changes the default ADMIN password to ensure proper security.
•Set up CBT—The administrator performs the following setup tasks to configure CBT according to the site's needs:
–Add users, routers, and subscriber information
–Configure parameters in .INI files: CONFIGS.INI, GUNSLINGER.INI, POLLER.INI, and SPECTRUM.INI
–Set message log options to see errors logged by the server
•Set up an external interface (optional)—If CBT will not retrieve subscriber or provisioning data from its local database, which is the system default, the administrator sets up an external interface to retrieve the data by using one of the following methods:
–Subscriber information—Can be accessed by script, HTTP, or Lightweight Directory Access Protocol (LDAP)
–Provisioning information—Can be accessed by script, HTTP, LDAP, Cisco Broadband Provisioning Registrar (BPR), or Cisco Network Registrar (CNR)
Note BPR and CNR have recently been renamed. BPR is now called Cisco Broadband Access Center for Cable (BACC). CNR is now called Cisco CNS Network Registrar (CNS-NR). You can see the new names on Cisco.com and in future releases. The CBT 3.3 GUI and documentation use the latest names and acronyms.
The remainder of this guide explains these tasks in greater detail.
RF Tech Tasks
The last task shown in Figure 5 is one that the RF technician performs:
•Use CBT to diagnose RF Problems—The RF technician can diagnose a frequency problem in the cable plant by using any or all of the CBT troubleshooting capabilities:
–CMTS Dashboard—To view summary information on a CMTS and the cable modems attached to it
–Flap List Analysis—To analyze data from a CMTS and categorize problems into four groups: provisioning, reverse path noise, reverse path attenuation, and packet corruption
–Spectrum management tools—To view performance data for an upstream port or cable modem
–Cable modem tools—To ping, monitor, or query a cable modem to assess its status
Setting Up CBT with a Password, Users, and Data for Routers and Subscribers
This section describes the following important setup tasks that only a CBT administrator can perform:
• Changing the Administrator Password
• Disabling or Enabling Password Text Display
• Adding Users
• Adding Router Information
• Adding Subscriber Information
Changing the Administrator Password
For security reasons, we recommend that you change the default password for the administrator. Perform the following steps to change the administrator password:
Step 1 Open the browser and enter the URL for your CBT server:
http://CBT server IP address:9080/
Note In the URL, CBT server IP address is the server on which you installed CBT.
The Login dialog box appears, as shown in Figure 1.
Step 2 Log in as admin with the default password changeme.
Step 3 To change the password, from the Configuration menu, choose the administrator from the User List, and proceed through dialogs that prompt you for the new password.
Disabling or Enabling Password Text Display
CBT 3.3 enables you to display password text, or to disable password text display according to your needs. By default, this parameter is set to YES. If you set the corresponding parameter to NO , CBT does not display password text when the contents of the Password field is displayed.
Perform the following steps to disable or to enable password text display for one or more User Names. Restart of CBT 3.3 is required as the final step of configuring this change.
Step 1 Open the GUNSLINGER.INI file available in the CBT server machine.
•For Solaris and Linux, the GUNSLINGER.INI file is under the directory /opt/CSCOcbt/httpServer/webapps/ROOT or <CBT_Install_Directory>/httpServer/webapps/ROOT.
•For Windows, the GUNSLINGER.INI file is under the directory C:\Program Files\Cisco Systems\Cisco Broadband Troubleshooter\httpServer\webapps\ROOT\ or <CBT_Install_Directory>\httpServer\webapps\ROOT\.
Step 2 Change the value of the ShowPasswordWhileEditing parameter to YES or NO as per your need.
•For YES, CBT 3.3 displays the password text when the password field is highlighted.
•For NO , CBT 3.3 does not display the password text when the password field is highlighted.
Step 3 Save the GUNSLINGER.INI file with your changes.
Step 4 Restart CBT 3.3.
Adding Users
You add users in CBT by specifying the following information for a user:
•User Name—Specifies the name the user enters in the Login dialog box.
•Password—Specifies the password the user enters in the Login dialog box.
•User Type—Determines the level of privileges the user has. The two choices are ADMIN and RFTECH.
Perform the following steps to add users in CBT:
Step 1 Log in as admin. See Figure 6.
Step 2 From the Configuration menu, choose User List. The Manage Users dialog box appears.
Step 3 Select Add User, and proceed through dialog boxes that prompt you for the new user information. (See Figure 7.)
Figure 6 CBT Log In Window
Figure 7 Manage Users Dialog Box
Adding Router Information
You can add router information in CBT by using either of the following methods in the CMTS List option of the Configuration menu:
•Enter information for a router by manually filling in fields for each router.
•Import an ASCII file that contains a list of managed Cisco CMTSs. A sample file is in the following locations:
–Linux and Solaris—/opt/CSCOCBT/samples/showmap/cmts.txt
