Cisco Broadband Troubleshooter Release 3.0 User Guide
Available Languages
Table Of Contents
Cisco Broadband Troubleshooter Release 3.0
Minimum Cisco Broadband Troubleshooter Server Requirements
Windows and Linux System Requirements
Minimum Cisco Broadband Troubleshooter Server Requirements for Windows
Minimum Cisco Broadband Troubleshooter Server Requirements for Linux
Supported Browser and Java Runtime Environment Combinations
Minimum Cisco Universal Broadband Router and Cisco IOS Requirements
Minimum uBR and Cisco IOS Requirements to Use Spectrum Management Features in CBT
Installing Cisco Broadband Troubleshooter
Installing and Starting CBT on Solaris
Installing and Starting CiscoView on Solaris
Installing and Starting CBT on Windows
Installing and Starting CBT on Linux
Configuring Cisco Broadband Troubleshooter
Configuring the CMTS to Use CBT's Spectrum Management Tools
Configuring the Java Runtime Environment
Installing JRE 1.3.1 in Microsoft Internet Explorer on the Windows Platform
Installing JRE 1.3.1 in Netscape Navigator on the Windows Platform
Installing JRE 1.4.1 in Netscape Navigator on the Solaris Platform
Installing JRE 1.4.1 in Netscape Navigator on the Linux Platform
(Optional) Configuring CiscoView
(Optional) Configuring ESRI RouteMap Files
Workflow of Administrator and RF Technician Tasks
Setting Up CBT with a Password, Users, and Data for Routers and Subscribers
About Adding Router Information
About 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
Retrieving Subscriber or Provisioning Data by Using an External Interface
About Retrieving Data with a Script
Script Parameters for MAC Address Information
Script Parameters for Subscriber Information
Script Parameters for Provisioning Information
Troubleshooting Script Problems
About Retrieving Data with an Application on an HTTP Server
HTTP Parameters for MAC Address Information
HTTP Parameters for Subscriber Information
HTTP Parameters for Provisioning Information
Retrieving Data with an HTTP Application
About Retrieving Data with LDAP
About Retrieving Data with BPR
About Retrieving Data with CNR
About Retrieving Subscriber Data from the Local Database
Retrieving Subscriber Data from the Local Database
About Retrieving Provisioning 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
Showing and Configuring the Flap List Analysis
Showing the Flap List Analysis
Scheduling the Flap List Analysis
Setting Parameters for the Flap List
Using the Spectrum Management Tools
Analyzing the Carrier-to-Noise Ratio
Working with Spectrum Management Clients
Troubleshooting Poller Problems
Error Message: Database Login Failed
Uninstalling Cisco Broadband Troubleshooter
Sample Code for Application Program Interfaces
Shell Script for Retrieving Subscriber or Provisioning Information
Directions for Modifying the Script
Directions for Troubleshooting the Script
Java Code for Retrieving Subscriber or Provisioning Information
Sample HTTP Application Requirements
Modifiable Components in the Sample HTTP Application
Directions for Building and Running the Sample HTTP Application
Directions for Troubleshooting the Sample HTTP Application
Obtaining Technical Assistance
Obtaining Additional Publications and Information
User Guide
Cisco Broadband Troubleshooter Release 3.0
1 Product Overview
Cisco Broadband Troubleshooter Release 3.0 (CBT 3.0) is a troubleshooting tool designed for the network administrator and radio frequency (RF) technician at a multiple system operator (MSO) site. An MSO provides a variety of cable services such as TV, data, or voice telephony. The network administrator and the RF technician use Cisco Broadband Troubleshooter to resolve RF problems in the MSO's cable plant.
Cisco Broadband Troubleshooter provides the following functionality:
•
Provides summary statistics for each upstream port attached to a cable modem termination system (CMTS)
•
–
–
–
–
•
•
–
–
–
•
–
–
–
–
–
–
•
–
–
–
•
This release supports Cisco Broadband Troubleshooter installed on a server that is running the Solaris, Windows, or Linux operating system.
2 System Requirements
This section lists the system requirements for:
•
–
–
•
Solaris System Requirements
You can install Cisco Broadband Troubleshooter on a server that is running the Solaris OS.
Minimum Cisco Broadband Troubleshooter Server Requirements
•
•
•
•
•
•
Minimum Client Requirements
•
•
•
•
Windows and Linux System Requirements
You can install Cisco Broadband Troubleshooter on a server that is running the Windows or Linux OS.
Minimum Cisco Broadband Troubleshooter Server Requirements for Windows
•
•
•
•
•
•
•
Minimum Client Requirements
•
•
•
•
•
or
Internet Explorer 5.5 or a later releaseMinimum Cisco Broadband Troubleshooter Server Requirements for Linux
•
•
•
•
•
•
Minimum Client Requirements
•
•
•
•
•
Supported Browser and Java Runtime Environment Combinations
The Sun Java Runtime Environment (JRE) is a plug-in that must be installed in the client browser. Table 1 shows a matrix of supported browser and JRE combinations for each operating system.
For more information on using JRE with your browser, see "Configuring the Java Runtime Environment" section.
Table 1
Supported Browser and JRE Combinations for Each Operating System
Minimum Cisco Universal Broadband Router and Cisco IOS Requirements
You can use Cisco Broadband Troubleshooter with the following universal broadband routers (uBRs):
•
•
•
On these routers, CBT 3.0 supports the following Cisco IOS releases:
•
•
•
Minimum uBR 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:
•
or
Cisco uBR10012 universal broadband router•
For more information, see "Configuring the CMTS to Use CBT's Spectrum Management Tools" section.
Enabling SNMP on Routers
You must enable SNMP on the routers by entering the following commands:
Router# config tRouter(config)# snmp-server community public RORouter(config)# snmp-server community private RW
Note
3 Installing Cisco Broadband Troubleshooter
The following procedures detail how to install Cisco Broadband Troubleshooter 3.0 on each supported platform. There are three different installation CD-ROMs; you must use the CD-ROM version for your operating system.
Installing and Starting CBT on Solaris
Step 1
Step 2
Step 3
•
•
mount CD-ROM device /cdrom
Note
Step 4
cd /cdrom/cdrom0/solaris/cbt./installThe CBT server is now running.
Step 5
umount /cdrom
Note
Step 6
ejectStep 7
cd /opt/CSCOcbt/bin./start_appor
To access CBT by using a browser, open the browser and enter:
http://CBT server IP address:9080/
Note
Step 8
Step 9
cd /opt/CSCOcbt/bin./stop_app
Figure 1 CBT Log In Window
Installing and Starting CiscoView on Solaris
Step 1
Step 2
Step 3
•
•
mount CD-ROM device /cdrom
Note
Step 4
cd /cdrom/cdrom0/solaris/cv./setup.shThe CBT server is now running.
Step 5
umount /cdrom
Note
Step 6
ejectInstalling and Starting CBT on Windows
Step 1
Step 2
Step 3
The CBT server is now running.
Step 4
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
Step 5
Step 6
Start > Programs > Cisco Broadband Troubleshooter > Stop Troubleshooter
Installing and Starting CBT on Linux
Step 1
Step 2
Step 3
/bin/mount /mnt/cdromStep 4
cd /mnt/cdrom/linuxStep 5
./installThe CBT server is now running.
Step 6
umount /mnt/cdrom ejectStep 7
cd /opt/CSCOcbt/bin./start_appor
To access CBT by using a browser, open the browser and enter:
http://CBT server IP address:9080/
Note
Step 8
Step 9
cd /opt/CSCOcbt/bin./stop_app
4 Configuring Cisco Broadband Troubleshooter
The following configuration requirements are prerequisites for using Cisco Broadband Troubleshooter 3.0:
•
•
•
•
Configuring the CMTS to Use CBT's Spectrum Management Tools
Cisco Broadband Troubleshooter 3.0 provides spectrum management functionality, which is generated by Digital Signal Processing (DSP) in the Cisco uBR-MC16S Spectrum Management Line Card on the CMTS. CBT's spectrum management tools require Cisco IOS Release 12.2(15)BC1. For more information, see "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 Broadband Troubleshooter.
For more information, refer to "Advanced Spectrum Management Configuration Tasks" at:
Configuring the Java Runtime Environment
The Sun JRE 1.31 is a plug-in that must be installed in the client browser. Cisco Broadband Troubleshooter detects if JRE 1.31 is installed in the browser. This section provides directions to install JRE 1.3.1 in the browsers supported by each platform.
Installing JRE 1.3.1 in Microsoft Internet Explorer on the Windows Platform
If JRE 1.3.1 is not installed in Internet Explorer on the Windows platform, the installation is automatic.
Installing JRE 1.3.1 in Netscape Navigator on the Windows Platform
If JRE 1.3.1 is not installed in Navigator on the Windows platform, you are directed to JREDownload.html.
To install JRE 1.3.1 in Netscape Navigator on the Windows platform:
Step 1
Note
Step 2
Start > Run > JRE1.3.1_07InstallationDirectory \j2re-1_3_1_07-windows-i586-i.exe
Step 3
Step 4
Installing JRE 1.4.1 in Netscape Navigator on the Solaris Platform
If JRE 1.4.1 is not installed in Navigator on the Solaris platform, you are directed to JREDownload.html.
To install JRE 1.4.1 on the Solaris platform:
Step 1
Note
Step 2
j2re-1_4_1_01-solaris.sparc.shStep 3
Netscape 4.7—Set the environment variable NPX_PLUGIN_PATH to point to the Java plug-in by entering:
setenv NPX_PLUGIN_PATH JRE1.4.1_01InstallationDirectory/plugin/sparc/ns4Netscape 7.0—Create a softlink to point to the Java plug-in by entering:
ln -s JRE1.4.1_01InstallationDirectory/plugin/sparc/ns610/libjavaplugin_oji.so Netscape7.0InstallationDirectory/plugins/libjavaplugin_oji.soStep 4
Step 5
Installing JRE 1.4.1 in Netscape Navigator on the Linux Platform
If JRE 1.4.1 is not installed in Navigator on the Linux platform, you are directed to JREDownload.html.
To install JRE 1.4.1 on the Linux platform:
Step 1
Note
Step 2
j2re-1_4_1_01-linux-i586.binStep 3
Netscape 4.7—Set the environment variable NPX_PLUGIN_PATH to point to the Java plug-in by entering:
setenv NPX_PLUGIN_PATH JRE1.4.1_07InstallationDirectory/plugin/i386/ns4Netscape 7.0—Create a softlink to point to the Java plug-in by entering:
ln -s JRE1.4.1_01InstallationDirectory/plugin/i386/ns610/libjavaplugin_oji.so Netscape7.0InstallationDirectory/plugins/libjavaplugin_oji.soStep 4
Step 5
(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:
•
•
For product information, refer to:
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.
To configure and launch CiscoView from CBT:
Step 1
Step 2
Step 3
Note
(Optional) Configuring ESRI RouteMap Files
ESRI RouteMAP is a third-party product that is an Internet-based site locator and mapping application. It enables network engineering professionals to view their entire network of cable modems down to the street level.
For product information, refer to:
http://www.esri.com/software/routemapims/index.html
If you have RouteMap installed, follow the directions in this section to install and start updated map-related files.
Note
To install and start map-related files from the map server PC:
Step 1
Start > Program > Esri > RouteMap... > Server Manager > Map Service
Step 2
Tools > Stop Server
The ESRI map server stops.
Step 3
Start > Programs > Accessories > Windows Explorer
Step 4
Note
Step 5
Step 6
Step 7
Step 8
Step 9
Start > Program > Esri > RouteMap... > Server Manager > Map Service
Step 10
Tools > Start Server
5 Reviewing the CBT Task Menu
After you log on to CBT, you see the following menu:
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:
•
•
•
•
•
•
•
The next sections describe the tasks within each menu.
User Guide
The User Guide menu contains one task:
•
Configuration
The Configuration menu contains the following tasks:
•
•
•
•
•
•
•
•
•
•
Diagnostics
The Diagnostics menu contains the following tasks:
•
•
Hotline Tools
The Hotline Tools menu contains the following tasks:
•
•
•
•
•
Spectrum Tools
The Spectrum Tools menu contains the following tasks:
•
•
•
•
–
–
•
Utilities
The Utilities menu contains the following tasks:
•
–
–
•
•
–
–
•
User Log Out
The User Log Out menu contains one task:
•
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:
•
•
–
–
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.
•
•
•
–
–
–
•
–
–
Note
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:
•
–
–
–
–
6 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 Admin Password
For security reasons, we recommend that you change the default password for the administrator.
To change the administrator password:
Step 1
http://CBT server IP address:9080/
Note
The Login dialog box appears, as shown in Figure 1.
Step 2
Step 3
About Adding Users
You add users in CBT by specifying the following information for a user:
•
•
•
Adding Users
To add users in CBT:
Step 1
Step 2
Figure 6 Manage Users Dialog Box
About Adding Router Information
You can add router information in CBT by using either of the following methods:
•
•
–
–
If you import an ASCII file, the file must contain 13 fields for each CMTS:
•
•
•
•
•
Each field must be separated by a comma (,). If you leave a field blank, use a comma as a placeholder for it.
Example 1 ASCII File Format for One CMTS
The following example shows the data for a CMTS in this format:
172.21.73.10,public,private,public,jdoe,nAda,nAda,nAda,yes,23,UserName,Password,yesAdding Router Information
To add information about the Cisco uBR7100 series, Cisco uBR7200 series, and Cisco uBR10012 series universal broadband router in CBT:
Step 1
Step 2
•
•
Step 3
Tip
Note
Figure 7 Import a List of CMTSs Dialog Box
About Adding Subscriber Information
To add subscriber information in CBT, you import an ASCII text file that contains the subscriber information. A sample file is in the following locations:
•
•
For each subscriber, the ASCII text file must contain 12 fields. The following fields are typical, although only the first one is required:
1.
2.
3.
4.
5.
6.
7.
8.
9.
10.
11.
12.
Each field, including blank ones, must be separated with | (the pipe symbol).
Example 2 ASCII File Format for One Subscriber
The following example shows the data for a subscriber in this format:
000216d5a0cf|ID987654|JohnDoe|4085551212|175 West Tasman|San Jose|CA|95134|USA|Gold|FiberNode_SanJose|PaidAdding Subscriber Information
To add subscriber information to CBT:
Step 1
Step 2
Step 3
Figure 8 Import Subscriber Data Dialog Box
7 Setting Parameters in .INI Files
This section describes the parameters you set in three .INI files in CBT:
•
•
•
Note
Parameters in the CONFIGS.INI File
In addition to specifying system-level parameters in the CONFIGS.INI file, you can also specify some of the parameters in the GUI.
Tip
This section describes parameters that you configure in the CONFIGS.INI file, which is in the following locations:
•
•
•
Note
Phone Number Format
The phoneLength parameter applies to Cisco Cable Diagnostic Manager only.
Modem Status Thresholds
When you view a status report for cable modem, color-coding indicates the modem's status:
•
•
The following parameters set the thresholds that determine the boundaries for color-coding and must be configured in the CONFIGS.INI file:
•
•
•
•
•
upstreamXmitPowerFloor—This parameter determines the minimum upstream transmit power for a cable modem to show a functioning status. This measurement is expressed in decibels millivolt (dBmV). The default setting is 34, as shown below:
upstreamXmitPowerFloor=34
upstreamXmitPowerCeiling—This parameter determines the maximum upstream transmit power for a cable modem to show a functioning status. This measurement is expressed in decibels millivolt (dBmV). The default setting is 52, as shown below:
upstreamXmitPowerCeiling=52
downstreamSnrFloor—This parameter determines the minimum signal-to-noise (SNR) for a cable modem to show a functioning status. SNR is a measure of transmission quality, which is expressed by the ratio of good data (signal) to interference (noise) that is heard on a line. This ratio is measured in decibels (dB). A higher ratio indicates a better transmission quality. For example, 30 dB is better than 24 dB. The default setting is 30, as shown below:
downstreamSnrFloor=30
downstreamReceivePowerFloor—This parameter determines the minimum downstream receive power for a cable modem to show a functioning status. This measurement is expressed in decibels millivolt (dBmV). The default setting is 15, as shown below:
downstreamReceivePowerFloor=15
downstreamReceivePowerCeiling—This parameter determines the maximum downstream receive power for a cable modem to show a functioning status. This measurement is expressed in decibels millivolt (dBmV). The default setting is 5, as shown below:
downstreamReceivePowerCeiling=5
Southbound Interface Settings
These parameters apply to Cisco Cable Diagnostic Manager only:
SouthBoundExtIntf
SouthBoundExtIntfTimeout
Modem State Settings
These parameters apply to Cisco Cable Diagnostic Manager only:
ModemStateMaxLife
ModemStateMaxHash
Query Timeout
The administrator specifies external interface parameters to access subscriber and provisioning information. Most of these parameters are in the Set External Interfaces dialog box. However, you must configure the following external interface parameters in the CONFIGS.INI file.
SubscriberExtIntfTimeout—This parameter determines the maximum wait time before CBT times out during a query for subscriber information. This measurement is expressed in milliseconds (msecs). The default setting is 5000, which is equal to 5 seconds, as shown below:
SubscriberExtIntfTimeout=5000
ProvisionExtIntfTimeout—This parameter determines the maximum wait time before CBT times out during a query for provisioning information. This measurement is expressed in milliseconds (msecs). The default setting is 5000, which is equal to 5 seconds, as shown below:
ProvisionExtIntfTimeout=5000
Parameters in the POLLER.INI File
When it starts, the Poller accesses the POLLER.INI file, which is in the following locations:
•
•
Note
The Poller accesses POLLER.INI to gather the following configurable parameters:
•
•
•
•
•
•
•
maximumDBConnection—This parameter determines the maximum number of CBT Sybase database connections the Poller uses to perform the polling operation. The valid range is 1 to 7. The default setting is 7, as shown below:
maximumDBConnection=7
SnmpTimeout—This parameter determines the number of seconds before the attempt to create the SNMP connection will reach a timeout or fail. The valid range is 1 to 3. The default setting is 2, as shown below:
SnmpTimeout=2
SnmpRetry—This parameter determines the number of times you want to try to create the SNMP connection. The valid range is 1 to 5. The default setting is 3, as shown below:
SnmpRetry=3
Debug—This parameter determines if debug messages are sent to the log file, which is in the following location:
/opt/CSCOcbt/logs/Poller.log
Valid values are true and false. The default setting is false, as shown below:
Debug=false
maximumAge—This parameter tells the Poller which outdated records to purge, based on the number of polling intervals that have occurred during which those records have not been updated. This measurement is expressed in polling intervals. A valid range is 1 to 7. The default setting is 2, as shown below:
maximumAge=2
PollerServerPort—This parameter sets the HTTP server port number where the Poll Manager listens to polling requests. The default setting is 8040:
PollerServerPort=8040
Note
Parameters in the SPECTRUM.INI File
The parameters you specify in the SPECTRUM.INI file affect the following spectrum management tools:
•
•
•
•
This section describes parameters that you configure in the SPECTRUM.INI file, which is in the following locations:
•
•
•
Note
The spectrum management tools access SPECTRUM.INI to gather the following configurable parameters:
•
•
•
•
•
•
•
•
CNRFloor—This parameter determines the lower threshold for the carrier-to-noise ratio that you see in the spectrum tools. CNR is a measure of transmission quality, which is expressed by the ratio of good data from the carrier to interference or noise that is heard on a line. A higher ratio indicates a better transmission quality. If the CNR is below this lower threshold, the value is highlighted in the color you specify in the CNRFloorColor parameter. This measurement is expressed in decibels (dB). Acceptable values range from -20 to 60 dB. If an unacceptable value is entered, the system default is used. The default setting is 20, as shown below:
CNRFloor=20
CNRCeiling—This parameter determines the upper threshold for the carrier-to-noise ratio that you see in the spectrum tools. CNR is a measure of transmission quality, which is expressed by the ratio of good data from the carrier to interference or noise that is heard on a line. A higher ratio indicates a better transmission quality. If the CNR is below this upper threshold, the value is highlighted in the color you specify in the CNRCeilingColor parameter. This measurement is expressed in decibels (dB). Acceptable values range from -20 to 60 dB. If an unacceptable value is entered, the system default is used. The default setting is 30, as shown below:
CNRCeiling=30
CNRFloorColor—This parameter determines the color that is used to highlight a carrier-to-noise ratio that is below the lower threshold, which you specify in the CNRFloor parameter. Accepted colors are red, yellow, blue, cyan, green, magenta, orange, and pink. If an unacceptable color is entered, the system default is used. The default setting is red, as shown below:
CNRFloorColor=Red
CNRCeilingColor—This parameter determines the color that is used to highlight a carrier-to-noise ratio that is below the upper threshold, which you specify in the CNRCeiling parameter. Accepted colors are red, yellow, blue, cyan, green, magenta, orange, and pink. If an unacceptable color is entered, the system default is used. The default setting is yellow, as shown below:
CNRCeilingColor=Yellow
SpecDataMaxRequests—This parameter determines the maximum number of active rows of ccsSpectrumRequestTable in the CMTS SNMP agent. This setting is necessary to avoid overloading the CMTS, and CBT checks to ensure that the number is not exceeded. If the number of active rows in the associated CMTS has reached the specified value, new spectrum requests cannot be launched. The default setting is 10, as shown below:
SpecDataMaxRequests=10
SpecDataQueryInterval—This parameter determines the time required after a spectrum data response and before the next spectrum data query. This measurement is expressed in milliseconds and should not be edited. The default setting is 5000, as shown below:
SpecDataQueryInterval=5000
SpecDataMaxCPU—This parameter determines the CPU utilization in the CMTS SNMP agent. This setting is necessary to avoid overloading the CMTS, and CBT checks to ensure that the percentage is not exceeded. If the CPU utilization in the associated CMTS has reached the specified value, new spectrum requests cannot be launched. This measurement is expressed in percentage. The default setting is 80, as shown below:
SpecDataMaxCPU=80
CableModemCacheAge—This parameter determines the cable modem caching time for the spectrum management tools. If the value is set to 0, the CBT server generates an SNMP request and bypasses the cache, which slows down performance if there are many modems associated with the selected CMTS. This measurement is expressed in seconds. If a negative number is entered, the system default is used. The default setting is 3600, as shown below:
CableModemCacheAge=3600
Note
8 Retrieving Subscriber or Provisioning Data by Using an External Interface
With CBT you can set up an external interface to retrieve subscriber or provisioning data:
•
•
You can use the following methods to set up an external interface:
•
•
•
•
•
•
Note
Figure 9 shows the dialog box where you specify the method. The remainder of this section describes how to set up an external interface with each method.
Figure 9 Set External Interfaces Dialog Box
About Retrieving Data with a Script
You can implement an external data retrieval application by using a scripting language. To see a sample script that you can modify according to your needs, see "Shell Script for Retrieving Subscriber or Provisioning Information" section.
Note
Script Parameters for MAC Address Information
The script must support the ability to search for a cable modem's MAC address by entering the customer's phone number or IP address. The input parameters for the script are:
•
•
For example, the following script invokes a search for the modem's MAC address by using the phone number 408-123-4567:
/opt/tools/subscriber-query.sh GET_MAC PHONE 4081234567The next script invokes a search for the modem's MAC address by using the IP address 172.2.3.1:
/opt/tools/provision-query.sh GET_MAC IP 172.2.3.1
Note
The output of the script must be in the following format:
OUT_DATA=MAC followed by one or more MAC addresses (non-dotted format) separated by ^
The following examples show the output for one and two MAC addresses:
OUT_DATA=MAC^001c64ff23ef^
OUT_DATA=MAC^001c64ff23ef^013e45ed1245^
Script Parameters for Subscriber Information
If you use a script to query subscriber information, it needs to support the ability to search for subscriber data, such as name and account number, by entering the MAC address of the subscriber's cable modem. The input parameters for the script are:
script-name GET_SUBSCRIBER MAC non-dotted-modem-mac-address
For example, the following script invokes a search for subscriber data by using the MAC address 001c.ab23.45fe in a non-dotted format:
/opt/tools/subscriber-query.sh GET_ SUBSCRIBER MAC 001cab2345feThe output of the script must be in the following format, separated by ^:
OUT_DATA=SUBSCRIBER^Field1=value1^Field2=value2^Field3=value3^Field4=value4^Field5=value5^
The following example shows the output for a subscriber's data:
OUT_DATA=SUBSCRIBER^Account Number=123456^Name=Doe_John^Address=123 Tasman, San Jose, CA 93443^Phone=4081234567^Class of Service=N/A^FiberNode=FIBER_1^Customer Since=1999^Account Status=Paid
Note
Script Parameters for Provisioning Information
If you use a script to query provisioning information, it needs to support the ability to search for provisioning data, such as CMTS and cable modem IP addresses, by entering the MAC address of a cable modem. The input parameters for the script are:
script-name GET_PROVISION MAC non-dotted-modem-mac-address
For example, the following script invokes a search for provisioning data by using the MAC address 001c.ab23.45fe:
/opt/tools/subscriber-query.sh GET_PROVISION MAC 001cab2345feThe output of the script must be in the following format:
OUT_DATA=PROVISION^cmts-ip-address^cm-ip-address^
The following example shows the output for provisioning data:
OUT_DATA=PROVISION^127.23.45.1^127.23.127.5^
Error Handling for Script
If an error occurs within the script or the embedded application called by the script, the script should return the output in the following format:
OUT_DATA=ERROR^error-message^
The following example shows output for an error:
OUT_DATA=ERROR^Unable to query the subscriber database.^
In the graphical user interface (GUI), CBT displays the error message to the user in a message box.
Retrieving Data with a Script
To retrieve subscriber or provisioning information by using a script:
Step 1
Step 2
•
•
Step 3
Troubleshooting Script Problems
See "Directions for Troubleshooting the Script" section.
About Retrieving Data with an Application on an HTTP Server
You can implement an external data retrieval application by using an application running on an HTTP server. CBT sends the request to the HTTP server by using the POST method. To see a sample application file that you can modify according to your needs, see "Java Code for Retrieving Subscriber or Provisioning Information" section.
HTTP Parameters for MAC Address Information
The application running on an HTTP server must support the ability to search for a cable modem's MAC address by entering the customer's phone number or IP address. CBT sends the following parameters to the appropriate server:
•
•
•
For example, the following parameters search for the modem's MAC address by using the phone number 408-123-4567:
REQUEST=GET_MACSEARCH_TYPE=PHONEIN_PARAM=4081234567The response from the server must be in the following format:
OUT_DATA=MAC followed by one or more MAC addresses separated by ^
The following examples show the output for one and two MAC addresses:
OUT_DATA=MAC^001c64ff23ef^
OUT_DATA=MAC^001c64ff23ef^013e45ed1245^
Note
HTTP Parameters for Subscriber Information
If you use an application running on an HTTP server to query subscriber information, it needs to support the ability to search for subscriber data, such as name and account number, by entering the MAC address of the subscriber's cable modem. CBT sends the following parameters to the server:
•
•
•
For example, the following parameters search for subscriber data by using the MAC address 001cab2345fe:
REQUEST=GET_SUBSCRIBERSEARCH_TYPE=MACIN_PARAM=001cab2345feThe output of the script must be in the following format, separated by ^:
OUT_DATA=SUBSCRIBER^Field1=value1^Field2=value2^Field3=value3^Field4=value4^Field5=value5^
The following example shows the output for a subscriber's data:
OUT_DATA=SUBSCRIBER^Account Number=123456^Name=Doe_John^Address=123 Tasman, San Jose, CA 93443^Phone=4081234567^Class of Service=N/A^FiberNode=FIBER_1^Customer Since=1999^Account Status=Paid
Note
HTTP Parameters for Provisioning Information
If you use an application running on an HTTP server to query provisioning information, it needs to support the ability to search for provisioning data, such as CMTS and cable modem IP addresses, by entering the MAC address of the cable modem. CBT sends the following parameters to the server:
•
•
•
For example, the following parameters search for provisioning data by using the MAC address 001cab2345fe:
REQUEST=GET_PROVISIONSEARCH_TYPE=MACIN_PARAM=001cab2345feThe response from the server must be in the following format:
OUT_DATA=PROVISION^cmts-ip-address^cm-ip-address^
The following example shows the output for provisioning data:
OUT_DATA=PROVISION^127.23.45.1^127.23.127.5^
Error Handling for HTTP
If an error occurs within the application running on an HTTP server, the script should return the output in the following format:
OUT_DATA=ERROR^error-message^
The following example shows output for an error:
OUT_DATA=ERROR^Unable to query the subscriber database.^
In the GUI, CBT displays the error message to the user in a message box.
Retrieving Data with an HTTP Application
To retrieve subscriber or provisioning information with an application on an HTTP server:
Step 1
Step 2
•
•
Step 3
Troubleshooting HTTP Problems
See "Directions for Troubleshooting the Sample HTTP Application" section.
About Retrieving Data with LDAP
You can use Lightweight Directory Access Protocol (LDAP) to retrieve external subscriber or provisioning information. LDAP is a nonproprietary, standards-based protocol. If you use the LDAP method, see your LDAP server administrator to obtain the information about the LDAP server that CBT requires.
CBT 3.0 supports LDAP Version 2.0, which was tested with Netscape LDAP Server Version 4.0 and iPlanet Version 5.1.
Retrieving Data with LDAP
To retrieve external subscriber or provisioning information by using LDAP:
Step 1
Step 2
•
•
Step 3
About Retrieving Data with BPR
You can retrieve provisioning information only by using BPR, which stands for Cisco Broadband Provisioning Registrar. BPR automates provisioning and configuration tasks. CBT supports BPR 2.0. For product information, refer to:
http://www.cisco.com/en/US/products/sw/netmgtsw/ps529/index.html
Note
Retrieving Data with BPR
To retrieve provisioning information by using BPR:
Step 1
Step 2
•
•
•
Step 3
About Retrieving Data with CNR
You can retrieve provisioning information only by using CNR, which stands for Cisco Network Registrar. CNR is an application that provides scalable Domain Name System (DNS), Trivial File Transfer Protocol (TFTP), and Dynamic Host Configuration Protocol (DHCP) services. For product information, refer to:
http://www.cisco.com/en/US/products/sw/netmgtsw/ps1982/index.html
If you use CNR, the following caveats apply to the setup:
•
•
•
•
Note
Retrieving Data with CNR
To retrieve provisioning information by using CNR:
Step 1
Step 2
•
•
•
•
Step 3
About Retrieving Subscriber Data from the Local Database
CBT can retrieve subscriber data from its own local Sybase database after the data has been added in CBT. After installation, Local Database is the default method for retrieving subscriber data.
Retrieving Subscriber Data from the Local Database
To retrieve subscriber information from the local database:
Step 1
Step 2
Step 3
Step 4
Figure 10 Import Subscriber Data Dialog Box
About Retrieving Provisioning Data from the Local Database
CBT can retrieve provisioning data from its own local Sybase database after the data has been added to it. After installation, Local Database is the default method for retrieving provisioning data. To store provisioning information in its local database, CBT polls CMTSs using SNMP. CBT provides two ways to do this:
•
•
Tip
About the Poller
When you install CBT, the default method for retrieving provisioning information is the local database. Because the Poller is part of the process for this method, it is on by default after installation. The default schedule for the Poller is to run at or about midnight and to repeat every 24 hours. You can change these settings according to your own needs.
To query CMTSs using the Poller, you specify two parameters:
•
•
The syntax to start the Poller on Linux or Solaris is:
/opt/CSCOcbt/bin/start_poller delta-start-time poll-interval
Example 3 Starting the Poller
The following example shows a polling session that starts 8 hours after you schedule it and repeats every 24 hours:
/opt/CSCOcbt/bin/start_poller 8 24Example 4 Stopping the Poller
The following example shows how to stop the Java poller application on Linux or Solaris:
/opt/CSCOcbt/bin/stop_poller
Note
At each polling interval, the Poller accesses the CBT routers list file and performs SNMP queries to each CMTS using its SNMP read-only community string. The CBT routers list file is in the following locations:
•
•
•
In addition to the on-demand polling that you schedule, CBT submits a polling request when it detects that a change has been made to the list of routers that CBT manages. For example, CBT submits a polling request when it detects that a new chassis has been added to a router.
Note
Retrieving Provisioning Data from the Local Database
To retrieve provisioning information from the local database:
Step 1
Step 2
Step 3
Scheduling the Poller
To schedule when and how often the Poller populates the local database with provisioning information that it gathers from CMTSs, you can use the GUI or type a command.
To use the GUI, from the Configuration menu, choose Poller. The Schedule CMTS Polling dialog box appears, as shown in Figure 11. In it, click Help for directions on how to schedule the Poller.
or
To use a command, type the following command and specify the parameters in hours, as explained in the previous section:
/opt/CSCOcbt/bin/start_poller delta-start-time poll-intervalFigure 11 Schedule CMTS Polling Dialog Box
9 Getting Summary Information and a Detailed Real-Time Status Report for a Modem
To get summary information on a cable modem, you can locate the modem by entering the MAC address. If you retrieve subscriber or provisioning data from the local database, you can also locate the modem by using any of the following advanced search criteria:
•
•
•
•
•
CBT's advanced search feature also allows you to use the asterisk (*) for wildcard searches. For example, if you enter 1234* for the account ID, you get a list of all cable modems for subscribers who have account numbers that begin with 1234.
Note
To get detailed information on a cable modem, you can get a Real-Time Modem Status Report, as shown in Figure 12. The information for a cable modem comes from three sources:
•
•
•
Within the status report, the following colors are used in certain fields to indicate performance:
•
•
For more information on setting thresholds, see "Modem Status Thresholds" section.
Figure 12 Real-Time Modem Status Report
Getting Summary Information on a Modem
To get summary information on a modem:
Step 1
Step 2
•
•
Step 3
Figure 13 Locate Broadband Modems Dialog Box
Figure 14 Locate a Broadband Modem Dialog Box
Getting a Detailed Real-Time Status Report for a Modem
To get a detailed status report for a cable modem:
Step 1
Step 2
Step 3
Figure 15 Real Time Status of a Broadband Modem Dialog Box
10 Reviewing the CMTS Dashboard
To get summary information on a CMTS, review the CMTS Dashboard. Figure 16 shows the CMTS Dashboard.
Figure 16 CMTS Dashboard Dialog Box
For the CMTS that you select, the CMTS Dashboard provides the following information:
•
•
•
•
•
•
•
•
•
•
For printing or collaborative troubleshooting, you can generate an HTML version of the information.
To access the CMTS Dashboard:
Step 1
Step 2
11 Showing and Configuring the Flap List Analysis
To analyze the results of data captured from one or more Cisco CMTSs, review the Flap List Analysis. The analysis shows the number of modems with the following problems:
•
•
•
•
Note
Figure 17 shows the Flap List Analysis dialog box, which you can sort according to your needs by clicking a column heading. For example, to sort the provisioning problems by MAC address, click the MAC Address column heading.
Figure 17 Flap List Analysis Dialog Box
From the Flap List Analysis dialog box, you can see a lower level of detail that contains the following information:
•
•
•
The detailed level of the Flap List Analysis dialog box is shown in Figure 18.
Figure 18 Flap List Analysis Details Dialog Box
Showing the Flap List Analysis
To show a flap list for one or more CMTSs:
Step 1
Step 2
Step 3
Note
Step 4
Scheduling the Flap List Analysis
To schedule a time to capture raw data from one or more Cisco CMTSs, use the Scheduler Configuration dialog box, which is shown in Figure 19.
Figure 19 Scheduler Configuration Dialog Box
To schedule a time to capture raw data from one or more Cisco CMTSs:
Step 1
Step 2
Step 3
Setting Parameters for the Flap List
The administrator can set parameters for the flap list in the Flap List Configuration dialog box shown in Figure 20.
Note
Figure 20 Flap List Configuration Dialog Box
For a CMTS, the administrator can specify the following criteria for a flap list:
•
•
•
•
•
To set parameters for the flap list:
Step 1
Step 2
Step 3
Purging the Flap List
When you want to delete a saved flap list file, use the Purge Flap List Data, which is shown in Figure 21. Before you purge a flap list file, you can generate an HTML version of it.
Figure 21 Purge Flap List Data File Dialog Box
To purge a flap list file:
Step 1
Step 2
Step 3
12 Using the Spectrum Management Tools
CBT 3.0 interfaces with the Cisco CMTS to provide return path spectrum analysis, which is provided in the following tasks:
•
•
•
•
•
–
–
Each task is covered separately in the following sections.
Using Trace Window
To monitor power and noise levels for a selected modem or upstream port, use the Trace Window. As shown in Figure 22, the Trace Window shows the output that you would see in a spectrum analyzer. This output displays in the plot line of the Trace Window.
Figure 22 Trace Window
About the Trace Window
In the Trace Window, you can:
•
–
–
•
–
–
•
–
–
–
•
–
–
•
–
–
–
–
•
–
–
•
•
•
Working with the Trace Window
Table 2 shows several ways to work with data in the Trace Window.
Table 2
Keyboard Actions for Working with the Trace Window
Starting the Trace Window
To use the Trace Window to monitor power and noise levels for a selected modem or upstream port:
Step 1
Step 2
Note
Tip
Step 3
Step 4
•
•
Step 5
Figure 23 Trace Window Criteria Dialog Box
Using the Spectrogram
To monitor power and noise levels, as you do in the Trace Window, while viewing the added dimension of time, use the Spectrogram. As shown in Figure 24, the Spectrogram shows the output that you would see in a spectrum analyzer.
Figure 24 Spectrogram
About the Spectrogram
In the Spectrogram, you see the following variables in one easy, 3-D view:
•
•
•
When you move your cursor over the spectrogram, the status bar at the bottom of the window displays the time, frequency, and power level for the current location. In the spectrogram, you can click Pause or Print at anytime.
Starting the Spectrogram
To use the Spectrogram to monitor power and noise levels for a selected modem or upstream port over time:
Step 1
Step 2
Note
Step 3
Step 4
Figure 25 Spectrogram Criteria Dialog Box
Analyzing the Carrier-to-Noise Ratio
To show the carrier-to-noise ratio for selected cable modems or upstream ports, use the CNR Analysis task. As shown in Figure 26, this information displays in the CNR Analysis dialog box, which lets you:
•
–
–
–
–
•
Figure 26 CNR Analysis Dialog Box
About the CNR Analysis
In the SPECTRUM.INI file, you:
•
•
In Figure 26, the CNRs for the selected modems fall into three categories:
•
•
•
For more information on the SPECTRUM.INI file, see "Parameters in the SPECTRUM.INI File" section.
Getting the CNR Analysis
To show the carrier-to-noise ratio for selected cable modems or upstream ports:
Step 1
Step 2
Note
Tip
Step 3
Step 4
Figure 27 CNR Analysis Criteria Dialog Box
Playing Back Data
You can play back a saved Trace Window or CNR Analysis. This allows you to capture and preserve troubleshooting information and use it later.
Playing Back a Trace Window
To play back a Trace Window:
Step 1
Step 2
Step 3
Note
Step 4
Figure 28 Trace Window Playback Criteria Dialog Box
Figure 29 Trace Window Playback List Dialog Box
Playing Back a CNR Analysis
To play back a CNR Analysis:
Step 1
Step 2
Note
Step 3
Figure 30 CNR Analysis Playback Criteria Dialog Box
Figure 31 CNR Analysis Playback Result Dialog Box
Working with Spectrum Management Clients
To see a list of clients that are currently using CBT's spectrum management tools, use the Clients task. The Clients feature is an effective tool that optimizes CBT's diagnostic capabilities by listing all in-process spectrum analyses in one place. By using the Clients task, technicians can troubleshoot collaboratively because multiple technicians can simultaneously:
•
•
When you choose the Clients task, the Spectrum Data Clients dialog box (Figure 32) appears.
Figure 32 Spectrum Data Clients Dialog Box
About the Clients Task
In the Spectrum Data Clients dialog box, each row represents a spectrum analysis in process on a client machine. For each spectrum analysis in the list, you can:
•
–
–
–
–
–
–
–
–
–
–
•
As you work in the Spectrum Data Clients dialog box, you can click Refresh to update the information or Generate HTML to capture the information in a format that can be distributed easily outside of Cisco Broadband Troubleshooter. For example, you could send it as an attachment in a trouble-ticket system or email application.
Using the Clients Task
To see a list of spectrum analyses in process on client machines:
Step 1
Tip
Step 2
13 Troubleshooting the Poller
This section provides directions to troubleshoot error messages for the following CBT components:
•
•
•
Troubleshooting Poller Problems
You can use the Poller, a separate Java application, to store provisioning information in CBT's local Sybase database. This database poller queries the CMTSs by using SNMP. If the Debug parameter in POLLER.INI is set to true, the Poller sends information to the Poller.log file in the following location:
•
•
Note
This section:
•
•
•
Error Message: No Router
Problem
The following output from Poller.log indicates that no router was found:
Thu Jun 27 15:47:35 EDT 2002: INFO: Start polling...Thu Jun 27 15:47:37 EDT 2002: INFO: No router found in routers list file: /opt/CSCOcbt/jakarta-tomcat-4.0.3/webapps/ROOT/WEB-INF/classes/config/myroutersThu Jun 27 15:47:37 EDT 2002: INFO: Finished polling... elapsed time: 2371 millisecondsThu Jun 27 15:47:37 EDT 2002: INFO: Poller exited.Cause
No router was found in the routers list file, myrouters, because of one of the following conditions:
•
•
Resolution
To add routers in CBT, see "Adding Router Information" section.
Error Message: Database Login Failed
Problem
The following output from Poller.log indicates that the login to the database failed:
Wed Jun 26 11:14:12 PDT 2002: INFO: Start polling...Wed Jun 26 11:14:13 PDT 2002: FATAL: SQL Exception in setupDB makeDBConnection: 1JZ00L: Login failed. Examine the SQLWarnings chained to this exception for the reason(s).Software aborted.Cause
The database login failure occurs because the database ran out of connections. That is, it tried to use more connections than it can support.
Resolution
If the database ran out of connections, restart CBT to clear all existing database connections and start the database.
Note
Error Message: SNMP Timeout
Problem
The following output from Poller.log indicates that an SNMP timeout has occurred:
Thu Jun 20 13:45:08 EDT 2002: INFO: Start polling...Thu Jun 20 13:45:18 EDT 2002: ERROR: Thread16 got SNMP exception on Router: 24.216.122.254. Exception: Snmp Timeout... Router 24.216.122.254 is unreachableCause
The SNMP timeout occurs when the network connection to the router, or the router itself, is so busy that it cannot satisfy the request within the specified time.
Resolution
If the SNMP timeout occurs too frequently, change the SNMP settings in the POLLER.INI file:
Step 1
•
•
Step 2
•
•
Step 3
Tip
14 Uninstalling Cisco Broadband Troubleshooter
This section provides instructions to uninstall Cisco Broadband Troubleshooter on each supported platform.
Uninstalling CBT on Solaris
Step 1
Step 2
Step 3
cd /cdrom/cdrom0/solaris/cbtStep 4
./uninstall
Uninstalling CBT on Windows
Step 1
Start > Settings > Control Panel > Add/Remove Programs
Step 2
Step 3
Uninstalling CBT on Linux
Step 1
Step 2
Step 3
/bin/mount /mnt/cdromStep 4
cd /mnt/cdrom/linuxStep 5
./uninstall
15 Sample Code for Application Program Interfaces
This section contains the README files for the following application program interfaces (APIs):
•
•
The sections that describe scripts and code provide the following information:
•
•
•
•
•
•
•
Shell Script for Retrieving Subscriber or Provisioning Information
You can use a sample script written for various databases to retrieve subscriber or provisioning information from an external source. These scripts, that you can modify according to your needs, are in the README file in the following locations:
•
–
–
•
–
–
This section provides a printed copy of that README file, formatted for this user guide.
Purpose of Shell Script
This file describes how to use scripts written against a Sybase database. The sybase directory contains sample scripts that you can modify to meet your needs. These scripts demonstrate how to:
•
•
•
Sample Script Requirements
The sample scripts:
•
•
After trying the sample scripts, you can tailor them for your database or any other external data source.
Script and File Descriptions
The following list describes the purpose of each script or file:
•
•
•
•
•
•
Directions for Modifying the Script
1.
2.
./insert_cmts3.
4.
5.
6.
7.
8.
Directions for Troubleshooting the Script
•
./get_provision GET_PROVISION MAC 000216d5a0cf
OUT_DATA=PROVISION^172.22.85.10^172.22.127.26^
./get_provision GET_MAC IP 172.22.127.26
OUT_DATA=MAC^000216d5a0cf^
./get_subscriber GET_SUBSCRIBER MAC 000216d5a0cf
OUT_DATA=SUBSCRIBER^AccId=ID000006^Name=Name000006^Phone=6172300006^Address=175 West Tasman^ClassOfService=Policy000006^FiberNode=User A000006^
./get_subscriber GET_MAC PHONE 5106663152
OUT_DATA=MAC^000164ffeb95^000164ffc3c7^
./get_subscriber GET_ADDRESS MAC 000164ffc3c7^000164ffeb95^
OUT_DATA=ADDRESS^000164ffc3c7=170 West Tasman Drive,95134^000164ffeb95=170 West Tasman Drive,95134^
•
•
•
–
–
•
–
@echo off–
For example:
echo OUT_DATA=PROVISION^^172.22.85.10^^172.22.127.26^^
Sample Script Code
The following sample code is extracted from the get_subscriber script:
#!/bin/kshargc=$#set -A argv $*integer i=0while let "i < $argc"; docase ${argv[$i]} in"GET_MAC") function=${argv[$i]};;esaclet "i = i + 1"done#retrieving MAC based on Customer phone numberif [ "$function" = "GET_MAC" ] ; thenstr="SELECT MACAddress FROM SUBSCRIBERINFO where CusPhone='$in_param';";echo $str >> "$tmpDir/script.$filenameExt"str="OUTPUT TO $tmpDir/test.$filenameExt FORMAT ASCII;"echo $str >> "$tmpDir/script.$filenameExt"tmpi=`dbisqlc -q -c $dbAccess read $tmpDir/script.$filenameExt`rm $tmpDir/script.$filenameExtMAC=`$commLib/cat $tmpDir/test.$filenameExt | $commLib/sed s/\'//g`echo $MAC > $tmpDir/test.$filenameExtMAC=`$commLib/cat $tmpDir/test.$filenameExt | $commLib/sed 's/ /^/g'`tmp="OUT_DATA=MAC^$MAC^";if [ $tmp = "OUT_DATA=MAC^^" ] ; thenecho "OUT_DATA=ERROR^No data found for $in_param^";exit;fiecho $tmprm $tmpDir/test.$filenameExtexit;fiJava Code for Retrieving Subscriber or Provisioning Information
You can use an application that is running on an HTTP server to retrieve subscriber or provisioning information from an external source.
A sample application that you can modify according to your needs is in the README file in the following locations:
•
–
–
•
–
–
This section provides a printed copy of that README file, formatted for this user guide.
Purpose of Java Code
This file describes how to use Data Manager, a sample HTTP application. The HTTP directory contains this sample application that you can modify to meet your needs. Data Manager demonstrates how to:
•
•
•
Sample HTTP Application Requirements
The sample HTTP application:
•
•
Module and File Descriptions
This section lists the modules and files used in Data Manager, the sample HTTP application. For a description, refer to a specific module or file. To modify Data Manager to suit your needs, refer to the next section, "Modifiable Components in the Data Manager Application."
•
–
–
–
–
–
–
–
–
–
–
–
–
–
–
•
–
–
–
–
–
–
•
–
–
–
Modifiable Components in the Sample HTTP Application
•
•
–
–
–
–
–
–
If create_tbls.sql is changed, the code for these functions must be changed accordingly.
•
Db-Vital.properties—Contains attributes of the provisioning database.If the provisioning and subscriber data tables reside in the same database, these two files must have identical information. In Data Manager, the provisioning and subscriber data is in two separate databases.
For both files, the following settings must be changed accordingly:
–
–
–
–
For more information, contact your local DBA.
•
start_dm—Starts the Data Manager HTTP application.The current variable settings in start_dm are:
debug_flag=1(Send debug messages to a log file.)port=8012(Change to the port of your choice.)logDir= /opt/CSCOcbt/jakarta-tomcat-4.0.3/logs(Specify the location where the log file should be created and changes should be written.)stop_dm—Stops the Data Manager HTTP application.
The following variable settings are in stop_dm:
ip=171.71.50.52(IP address where the HTTP application is running.)port=8012(Port in which the HTTP application is running. This should be the same port specified in the start_dm script.)For these three scripts (Makefile, start_dm, and stop_dm), the following properties must be updated according to the system environment:
–
–
–
For more information, check with your DBA.
Directions for Building and Running the Sample HTTP Application
1.
From the command line, type:
./make
./install
2.
From the command line, type:
/opt/CSCOcbt/bin/start_dm
3.
From the command line, type:
/opt/CSCOcbt/bin/stop_dm
4.
a.
b.
c.
http://your_machine_name:port_num/DataManager5.
http://your_machine_name:port_num/DataManager
Note
Directions for Troubleshooting the Sample HTTP Application
•
Make sure there is connectivity between the machine and the Oracle database. A quick way to test this is to invoke Oracle's sqlplus application. For example, assume that the following settings are in Db-Vital.properties:
–
–
–
From the command line, type:
sqlplus user1/mypasswd@CBT
If there is no response or an error occurs, check the tnsnames.ora setting with your local DBA.
•
Make sure that JAVA_HOME in the Makefile points to the correct JAVA compiler.
•
The sample HTTP application was written to use the Oracle OCI protocol for communicating with the database. Oracle OCI requires machine-dependent libraries, so make sure that the path to the libraries is set correctly in Makefile.
•
This error occurs when port_num is changed in start_dm and stop_dm. To correct it, restart the program /opt/CSCOcbt/bin/start_dm
•
It is possible that some of the Oracle environment did not get set up correctly. To check this, review oracle.csh, update it as required, and source it. Then, run start_dm again.
Sample Java Code
1.
HttpRequest = new HttpRequest()2.
StringBuffer sb = new StringBuffer();InputStream is = sock.getInputStream();DataInputStream fromBrowser = new DataInputStream(is);while (true) {msg = fromBrowser.readLine();if (msg.equals("")) break;sb.append(msg + nl); // put back the '\n\r' for newline}3.
DataInputStream fromBrowser = sock.getInputStream();StringBuffer sb = new StringBuffer();for (int x=0; x < len; x++) {// return int range 0-255, -1: end of streami = fromBrowser.read();if (i == -1) break;// however, char is 16 bits for unicode 2 bytes// now use 2 bytes to hold just one byte data.sb.append((char)i);//System.out.println (sb);}4.
//parse and save message into HashtableString req_command = decodeString(command);//System.out.println ("req_command=" + req_command);// Parse the data from the servletStringTokenizer rdata = new StringTokenizer(req_command, "&");if (rdata == null) return;//System.out.println ("data=" + data + ", rdata=" + rdata);while (rdata.hasMoreTokens()) {String cmd = rdata.nextToken();int index = cmd.indexOf("=");if (index == -1) return;String key = cmd.substring(0, index);String val = cmd.substring(index+1);hParams.put(key, val);}5.
//if POST message then process the message:if (req.getReqType().equals ("POST")) {req.fetchBody(sock_);hParams = req.getParams();resp = new PostResponse(req);String status = null;status = dm_.processCommand(req);...}//examine the request type and process the message accordingly:Hashtable hParams = req.getParams();String task = (String)hParams.get("REQUEST");int status = 1;if (task.equals(GET_PROV_INFO)) {String sStr = "";String sType = (String)hParams.get("SEARCH_TYPE");if (sType.equals("MAC")){String sTmp = (String)hParams.get("IN_PARAM");String sMac = sTmp.toLowerCase();Logger.debug("In Mac is " + sMac);sStr = DbQuery.getProvInfo(sMac);Logger.debug("Prov Info is " + sStr);}.....}// retrieve information from the database (DbQuery.java):public static String getProvInfo(String Mac) {String query = "";String subscriberId = "";String modemIp = "";String cmtsIp = "";Statement stmt = null;try {long start = (new java.util.Date()).getTime();start = (new java.util.Date()).getTime();stmt = vital_db_conn.createStatement();query = "select subscriberid, ipaddress,giaddr from device where deviceid = '" + Mac + "'";Logger.debug(query);boolean bFound = false;ResultSet rs = stmt.executeQuery(query);while (rs.next()) {bFound = true;subscriberId = rs.getString(1);modemIp = rs.getString(2);cmtsIp = rs.getString(3);rs.clearWarnings();}rs.close();rs = null;stmt.close();stmt = null;long end = (new java.util.Date()).getTime();Logger.debug("total msec to execute getProvInfo: " + (end - start));if (!bFound)return ("OUT_DATA=ERROR^" + Mac + " does not exist in the Provisioning Database.^");String sStr = "OUT_DATA=PROVISION^" + cmtsIp + "^" + modemIp + "^";return (sStr);}catch (SQLException se) {String sError = "OUT_DATA=ERROR^" + se.getMessage() + "^";if (stmt != null){try {stmt.close();}catch (Exception e){}stmt = null;}return sError;}}6.
//send header to CBTOutputStream os = null;try {os = sock.getOutputStream();}catch (IOException e) {Logger.error("DataManager.HttpResponse:sendHeader: error: " + e);e.printStackTrace(DataManager.getLogPW());e.printStackTrace();}StringBuffer sb = new StringBuffer();sb.append ("HTTP/1.0 200 OK" + nl);sb.append ("Content-type: text/html" + nl);byte[] b = (sb.toString()).getBytes();try {os.write(b);os.flush();}catch (IOException e) {Logger.error ("DataManager.HttpResponse:sendHeader: error write: " + e);e.printStackTrace(DataManager.getLogPW());e.printStackTrace();}Send result data off to CBTos.write(result_data);os.flush();16 Obtaining Documentation
Cisco provides several ways to obtain documentation, technical assistance, and other technical resources. These sections explain how to obtain technical information from Cisco Systems.
Cisco.com
You can access the most current Cisco documentation on the World Wide Web at this URL:
http://www.cisco.com/univercd/home/home.htm
You can access the Cisco website at this URL:
International Cisco websites can be accessed from this URL:
http://www.cisco.com/public/countries_languages.shtml
Documentation CD-ROM
Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package, which may have shipped with your product. The Documentation CD-ROM is updated regularly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual or quarterly subscription.
Registered Cisco.com users can order a single Documentation CD-ROM (product number DOC-CONDOCCD=) through the Cisco Ordering tool:
http://www.cisco.com/en/US/partner/ordering/ordering_place_order_ordering_tool_launch.html
All users can order annual or quarterly subscriptions through the online Subscription Store:
http://www.cisco.com/go/subscription
Ordering Documentation
You can find instructions for ordering documentation at this URL:
http://www.cisco.com/univercd/cc/td/doc/es_inpck/pdi.htm
You can order Cisco documentation in these ways:
•
http://www.cisco.com/en/US/partner/ordering/index.shtml
•
Documentation Feedback
You can submit comments electronically on Cisco.com. On the Cisco Documentation home page, click Feedback at the top of the page.
You can send your comments in e-mail to bug-doc@cisco.com.
You can submit comments by using the response card (if present) behind the front cover of your document or by writing to the following address:
Cisco Systems
Attn: Customer Document Ordering
170 West Tasman Drive
San Jose, CA 95134-9883We appreciate your comments.
17 Obtaining Technical Assistance
For all customers, partners, resellers, and distributors who hold valid Cisco service contracts, the Cisco Technical Assistance Center (TAC) provides 24-hour, award-winning technical support services, online and over the phone. Cisco.com features the Cisco TAC website as an online starting point for technical assistance.
Cisco TAC Website
The Cisco TAC website (http://www.cisco.com/tac) provides online documents and tools for troubleshooting and resolving technical issues with Cisco products and technologies. The Cisco TAC website is available 24 hours a day, 365 days a year.
Accessing all the tools on the Cisco TAC website requires a Cisco.com user ID and password. If you have a valid service contract but do not have a login ID or password, register at this URL:
http://tools.cisco.com/RPF/register/register.do
Opening a TAC Case
The online TAC Case Open Tool (http://www.cisco.com/tac/caseopen) is the fastest way to open P3 and P4 cases. (Your network is minimally impaired or you require product information). After you describe your situation, the TAC Case Open Tool automatically recommends resources for an immediate solution. If your issue is not resolved using these recommendations, your case will be assigned to a Cisco TAC engineer.
For P1 or P2 cases (your production network is down or severely degraded) or if you do not have Internet access, contact Cisco TAC by telephone. Cisco TAC engineers are assigned immediately to P1 and P2 cases to help keep your business operations running smoothly.
To open a case by telephone, use one of the following numbers:
Asia-Pacific: +61 2 8446 7411 (Australia: 1 800 805 227)
EMEA: +32 2 704 55 55
USA: 1 800 553-2447For a complete listing of Cisco TAC contacts, go to this URL:
http://www.cisco.com/warp/public/687/Directory/DirTAC.shtml
TAC Case Priority Definitions
To ensure that all cases are reported in a standard format, Cisco has established case priority definitions.
Priority 1 (P1)—Your network is "down" or there is a critical impact to your business operations. You and Cisco will commit all necessary resources around the clock to resolve the situation.
Priority 2 (P2)—Operation of an existing network is severely degraded, or significant aspects of your business operation are negatively affected by inadequate performance of Cisco products. You and Cisco will commit full-time resources during normal business hours to resolve the situation.
Priority 3 (P3)—Operational performance of your network is impaired, but most business operations remain functional. You and Cisco will commit resources during normal business hours to restore service to satisfactory levels.
Priority 4 (P4)—You require information or assistance with Cisco product capabilities, installation, or configuration. There is little or no effect on your business operations.
18 Obtaining Additional Publications and Information
Information about Cisco products, technologies, and network solutions is available from various online and printed sources.
•
http://www.cisco.com/en/US/products/products_catalog_links_launch.html
•
•
http://www.cisco.com/go/packet
•
http://www.cisco.com/go/iqmagazine
•
http://www.cisco.com/en/US/about/ac123/ac147/about_cisco_the_internet_protocol_journal.html
•
http://www.cisco.com/en/US/learning/index.html
Feedback