This document describes Cisco MPLS Tunnel Builder Pro. Tunnel Builder Pro includes a Backup Route Generator (BRG), which provides Fast ReRoute backup tunnels to protect for single element failures in a network. Tunnel Builder Pro is an enhancement to the Cisco MPLS Tunnel Builder application and incorporates many of its features.
Use these release notes in conjunction with the Cisco MPLS Tunnel Builder Pro Installation and User Guide.
This document contains the following sections:
This section describes the following:
Tunnel Builder Pro can be used on any hardware platform that supports MPLS Traffic Engineering (TE).
The Tunnel Builder Pro application supports devices running Cisco IOS Release 12.0(22)S or later with MPLS TE enabled.
The Tunnel Builder Pro server can run on Solaris, Version 2.8.
The Tunnel Builder Pro client can run on Microsoft Windows 2000 and Microsoft Windows NT.
|Note A higher version of the operating system is not necessarily supported.|
The installation of Tunnel Builder Pro requires that you have at least 90 MB of free disk space.
Disk space requirements for the operation of Tunnel Builder Pro depend on the network size.
The following are required on the system where the BRG server is to be installed:
To ensure that BRG performs as expected, the target installation workstation(s) must have the directory $JAVA_HOME/bin in the user's path.
Tunnel Builder Pro 2.0 is a standalone network management application. It is not certified for operation with other network management applications running on the same workstation. In addition, TunnelBuilder Pro 2.0 does not provide direct notification of MPLS configuration changes to other network management applications such as Cisco VPN Solution Center or Cisco element management systems.
Tunnel Builder Pro requires one of the following web browsers and the Java Plug-in specified below:
Windows 2000 and Windows NTIf you are using Netscape Version 4.7, you need to install the Java Plug-in Version 1.3.1 before running Tunnel Builder Pro.
To install Cisco MPLS Tunnel Builder Pro, you must enter two authorized license keys. These license keys are specified on your Right to Use document included in your product. The keys authorizes the following:
The application prompts you for these two license keys during setup.
If you exceed the limit of the license, you are notified by a message, like the following:
Number of TE routers (xxx) in the 126.96.36.199 network exceeds the number allowed by your Tunnel Builder license (yyy). Please contact your administrator.
You can choose to upgrade the maximum number of TE-enabled routers supported for any single seed router in Tunnel Builder Pro. You will need a new Right to Use document and a new authorized license key for each level through which you upgrade.
Right to Use documents and authorized license keys are available for the following levels:
|Note Before you download theTunnel Builder Pro kit, make sure you have your licence keys (Tunnel Builder and BRG) and Right to Use document from your Cisco representative or product manager.|
|Note If you are interested in an evaluation kit, make sure that you have a license key from your Cisco representative or product manager before you download the files.|
To download the Tunnel Builder Pro images and readme file, perform the following steps.
Step 1 For the Cisco MPLS Tunnel Builder Pro product kit, enter the following URL:
For an evaluation kit, enter the following URL:
If you are a Cisco registered customer, you can get an evaluation kit by entering this URL:
Step 2 Select a file. On the next screen, read the Software License agreement and download the file.
For the Tunnel Builder Pro product or evaluation kit download the following files, one at a time, where the x represents the version build number:
|Note The evaluation kit names start with tb-2.0.x.y- where x = 1 and y = .024.|
Now you ready to copy your files to the web server doc directory.
To install and start the Tunnel Builder Pro application on Solaris systems, perform the following steps:
|Note Default values are in brackets.|
Step 1 Copy the tb-*-kit-sol.tar and tb-*-setup-sol.sh files to a directory under your web server doc directory in which you plan to install the application. For example, /scratch/suitespot/docs/TunnelBuilderPro.
Step 2 Make sure that you can execute the tb-*-setup-sol.sh script:
chmod 755 tb-*-setup-sol.sh
Step 3 Log in as root.
$ su root password: password
Step 4 Run the ./tb-*setup-sol.sh file.
The setup file, tb-*-setup-sol.sh, runs a script that asks you where you want to locate the Tunnel Builder Pro files. Enter the full path of your web server doc directory.
Where (in what directory) would you like the Tunnel Builder Pro client and server to be installed? /scratch/suitespot/docs/TunnelBuilderPro
You will have several configuration options.
Please enter the license key (or hit return if evaluation option). Please enter (eval) for evaluation version of BRG, (perm) for permanent version of BRG, or (none) for Non-BRG version.
If you entered eval or perm, one of the following requests appears:
Please enter the license key for evaluation version. Please enter the license key for permanent version. What port would you like to use for the Tunnel Builder Pro client and server communication? 
If you entered eval or perm, the following question appears:
What RMI port would you like to use for the BRG Server?  Would you like to receive SNMP trap notification of links and tunnels changing status? [no]
If you entered yes, the following two questions appear. If you entered no, they do not appear.
What port would you like to use for receiving UDP datagrams? 
|Note If port 162 conflicts with other network management applications, then enter another port number. Port 162 is the standard port for UDP communication.|
What SNMP community string would you like to use? [public] Would you like to run the Tunnel Builder Pro server in debug mode? [no] Would you like to enable logging of Tunnel Builder Pro commands and logging of commands sent to the router? [no]
Step 5 When the installation script is complete, you are asked if you want to run the server automatically.
To start the server manually, execute a startTopoServer command from your web server doc directory.
cd /scratch/suitespot/docs/TunnelBuilderPro/serverkit web-server-doc-dir% ./startTopoServer
Step 6 To access the Tunnel Builder Pro application, use your web browser to find and select the ServerControl.html file. For example:
To access the Tunnel Builder Pro from your laptop, use your web browser to find and select the ServerControlLaptop.html file. For example:
|Note If you have not previously downloaded and installed the Java Plug-in Version 1.3.1, you may be prompted to do so at this point.|
The Tunnel Builder Pro application is displayed in your browser window.
You need to reinstall the Cisco MPLS Tunnel Builder software to do any of the following upgrades:
To shut down Tunnel Builder Pro, locate the Tunnel Builder Server process on the machine and kill the process ID.
To locate the process IDs for the Tunnel Builder server, enter the following command:
ps -ef | grep serverkit
Once the process ID is found, enter this command:
kill -9 process-id
You can use the following arguments in the BRG install.sh script that is found in the installation-directory/serverkit/installed/bin directory:
When invoked without options, install.sh assumes the "r" argument; that is, it stops the server, clears the log file, and then restarts the server.
The instructions for manually shutting down and restarting the server follow.
In its default state, the install script cleans the contents of any existing log directory.
The directory log contains the configuration of the RMI Daemon that is persistent from one start of the daemon to another. If the port is changed, remove the log directory.
To stop the RMI Daemon and the BRG server without starting a new installation, do the following from the serverkit/installed subdirectory of the installation directory:
./bin/install.sh -k ABCD
The Tunnel Builder Pro installation process automatically starts the BRG server if you have the appropriate license. Restarting the BRG server is usually unnecessary, but after an incident such as a machine reboot you need to restart it.
To start the RMI Daemon and the BRG server run the script install.sh as follows:
$ su root password: password $ cd installation-directory/serverkit/installed $ ./bin/install.sh -p data/system.properties -Djava.security.policy=data/server.policy ABCD
where installation-directory is the directory in which Tunnel Builder Pro was installed and ABCD is the RMI port chosen at installation time. It must match the RMI port specified in the serverkit/TBconfig.txt file.
Cisco MPLS Tunnel Builder Pro includes the following features:
Caveats describe unexpected behavior in Cisco MPLS Tunnel Builder Pro software releases. Severity 1 caveats are the most serious; severity 2 caveats are less serious. Severity 3 caveats are moderate caveats, and only selected severity 3 caveats are included in caveats documentation.
This section describes possible unexpected behavior by Cisco MPLS Tunnel Builder Pro. This section describes only severity 1, severity 2, and selected severity 3 caveats. This release contains no severity 1, or severity 2 caveats.
The documentation for Tunnel Builder Pro contains both online help and a user manual, the Cisco MPLS Tunnel Builder Pro Installation and User Guide.
These sections explain how to obtain documentation from Cisco Systems.
You can access the most current Cisco documentation on the World Wide Web at this URL:
Translated documentation is available at this URL:
Cisco documentation and additional literature are available in a Cisco Documentation CD-ROM package. The Documentation CD-ROM is updated monthly and may be more current than printed documentation. The CD-ROM package is available as a single unit or through an annual subscription.
You can order Cisco documentation in these ways:
You can submit comments electronically on Cisco.com. In the Cisco Documentation home page, click the Fax or Email option in the "Leave Feedback" section at the bottom of the page.
You can e-mail your comments to firstname.lastname@example.org.
You can submit your comments by mail by using the response card behind the front cover of your document or by writing to the following address:
Attn: Document Resource Connection
170 West Tasman Drive
San Jose, CA 95134-9883
We appreciate your comments.
Cisco provides Cisco.com as a starting point for all technical assistance. Customers and partners can obtain online documentation, troubleshooting tips, and sample configurations from online tools by using the Cisco Technical Assistance Center (TAC) Web Site. Cisco.com registered users have complete access to the technical support resources on the Cisco TAC Web Site.
Cisco.com is the foundation of a suite of interactive, networked services that provides immediate, open access to Cisco information, networking solutions, services, programs, and resources at any time, from anywhere in the world.
Cisco.com is a highly integrated Internet application and a powerful, easy-to-use tool that provides a broad range of features and services to help you with these tasks:
If you want to obtain customized information and service, you can self-register on Cisco.com. To access Cisco.com, go to this URL:
The Cisco Technical Assistance Center (TAC) is available to all customers who need technical assistance with a Cisco product, technology, or solution. Two levels of support are available: the Cisco TAC Web Site and the Cisco TAC Escalation Center.
Cisco TAC inquiries are categorized according to the urgency of the issue:
The Cisco TAC resource that you choose is based on the priority of the problem and the conditions of service contracts, when applicable.
You can use the Cisco TAC Web Site to resolve P3 and P4 issues yourself, saving both cost and time. The site provides around-the-clock access to online tools, knowledge bases, and software. To access the Cisco TAC Web Site, go to this URL:
All customers, partners, and resellers who have a valid Cisco service contract have complete access to the technical support resources on the Cisco TAC Web Site. The Cisco TAC Web Site requires a Cisco.com login ID and password. If you have a valid service contract but do not have a login ID or password, go to this URL to register:
If you are a Cisco.com registered user, and you cannot resolve your technical issues by using the Cisco TAC Web Site, you can open a case online by using the TAC Case Open tool at this URL:
If you have Internet access, we recommend that you open P3 and P4 cases through the Cisco TAC Web Site.
The Cisco TAC Escalation Center addresses priority level 1 or priority level 2 issues. These classifications are assigned when severe network degradation significantly impacts business operations. When you contact the TAC Escalation Center with a P1 or P2 problem, a Cisco TAC engineer automatically opens a case.
To obtain a directory of toll-free Cisco TAC telephone numbers for your country, go to this URL:
Before calling, please check with your network operations center to determine the level of Cisco support services to which your company is entitled: for example, SMARTnet, SMARTnet Onsite, or Network Supported Accounts (NSA). When you call the center, please have available your service agreement number and your product serial number.
Copyright © 2002, Cisco Systems, Inc.
All rights reserved.
Posted: Thu Oct 3 13:26:03 PDT 2002
All contents are Copyright © 1992--2002 Cisco Systems, Inc. All rights reserved.
Important Notices and Privacy Statement.