NPToolkit FAQs

Internet users currently face a difficult problem: they are unable to complain effectively about application performance problems. Getting useable tools widely deployed can begin to help change this situation. These tools can make it easy for end-users to generate readable trouble reports that will be acted upon by the appropriate support staff. This eases the burden of system administrators (sys-admins) and network operations center (NOC) staff by providing more diagnostic tools and procedures that can help them quickly find the source of real problems.

The NPToolkit ISO image is derived from the standard Knoppix v5.0.1 Live-CD ISO image. Using the re-mastering instructions provided by Knoppix, the kernel was replaced with a Web100-enhanced version (currently Linux 2.6.20.10). Then, performance tools developed by Internet2 staff, Pittsburgh Supercomputer Center (PSC) researchers, and Stanford Linear Accelerator Center (SLAC) researchers were added to the image. Several non-essential applications (e.g., Open Office) were removed to make room for these performance tools. Finally, a new ISO image was created and posted to the Internet2 web site for distribution (http://e2epi.internet2.edu/network-performance-toolkit.html).

The NPToolkit ISO image contains two user-friendly tools (NDT and NPAD) that allow end-users to examine their local desktop/laptop computer’s network configuration and the local network infrastructure. Detailed reports are then available for use by the appropriate sys-admin or network operator. Both the NDT and NPAD servers start automatically and use Java based clients to communicate with the end-user’s system.

The NPToolkit contains three more advanced tools (BWCTL, OWAMP, and Reverse Traceroute/Ping Server) that make it easy to examine WAN paths. BWCTL and OWAMP servers inside the Internet2 network allow testing to, and through, this backbone network. Remote servers, located at other points in the network are also accessible. By default, the NPToolkit allows short tests from remote locations. Finally, the Reverse Traceroute server allows users to examine the Internet path from the NPToolkit server back to their campus.

1) What is this NPToolkit?

The Internet2 NPToolkit ISO image is a customized Knoppix Live-CD that is designed to make it easy to deploy end-to-end performance measurement tools. This image, once burned onto a CDROM disk, allows anyone to bring up a comprehensive set of measurement tools by simply booting an Intel-based PC. Using these tools, end-users, system administrators, and network operators can quickly and easily find and fix network problems that impact applications. End-users also can use the NDT and NPAD tools to examine their desktop/laptop computer’s configuration and local network connection to find/report problems.

2) How can I obtain a disk?

The current ISO image is available at http://e2epi.internet2.edu/network-performance-toolkit.html. Download the network-performance-toolkit.iso image and the accompanying CD-Label to your local host. Then, use your favorite tool to burn this image onto a CD-ROM. Once burned, place the CD into the CDROM/DVD tray and boot the system. When the boot cycle completes, you will have a running NPToolkit server ready to assist in finding network and host configuration problems. More details are available at on the NPToolkit web page.

You may also send email to Richard Carlson rcarlson@internet2.edu to request a pre-burned copy of the NPToolkit disk.

3) Do I want to customize the disk?

All of the performance tools operate correctly without any customization. Just drop the CD into the tray and power up the system. However, some of the tools, NDT and NPAD in particular, will provide more useful information if you customize them. Customization of these tools will allow these two tools to generate web pages that inform the end-users where they are testing to and will allow you to specify where trouble reports are sent. You can also customize the BWCTL and OWAMP tools to provide additional access to authenticated remote users. Finally, you can also set the system to use either the default DHCP address or configure a static IP address.

To change the customization options, boot the system and, at the end of the boot process, you are presented with a customization menu:

1. Select the drive(s) you want to use as a backup storage for your configurations. Both externally mounted USB and Flash Memory cards may be used, or the internal hard drive is also an option. Once you finish this option, the selected drive will contain the knoppix.sh file and the NPTools directory in the root directory of this drive.
2. Select the tool you wish to customize and follow the prompts. The customized files will be saved to in the NPTools directory on the backup storage device.

When the NPToolkit image is booted, the standard Knoppix startup script searches all drives for this knoppix.sh file, if found it executes the script, restoring the customized files. If the NPTookit server is already running, the “/usr/local/bin/customize.NPtools” command will bring up the customization menu.

4) How do I logon to the console?

The NPToolkit console is accessed by logging in as the user “knoppix”. By default, there is no password for this account and no remote access is allowed. You may enable a password by manually running the /usr/bin/passwd command. Remote access (e.g., ssh) should only be enabled after you set passwords for the “knoppix” and “root” userid’s.

5) How do I get an X-windows environment?

The NPToolkit was designed for hands-off operations, so it boots up into the command prompt mode. To bring the system up in X11 mode:

1. Use the Knoppix boot command “knoppix 5” at the boot prompt.
2. Modify the /etc/inittab file and change the initial default value from 3 to 5. (Be sure to save this file manually to the backup storage drive, and modify the knoppix.sh file to restore it during the boot process.
3. After the system has booted, log in as “knoppix” and run the “/usr/bin/startx” command.

6) How do I get access from a remote host?

By default, the NPToolkit does not allow remote access. To enable remote access:

1. Login using the “knoppix” userid and run the /usr/bin/passwd command
2. Run the /bin/su command to become root and run the /usr/bin/passwd command
3. Start the sshd process using the “/etc/init.d/ssh start” command

To preserve these changes over a boot:

1. Append the /usr/local/NPToolkit/contrib./remote.acces file to the knoppix.sh file on your backup storage drive.
2. Manually copy the files listed in the remote.access file to the /NPTools directory on the backup storage drive.

These files will be restored during the boot process and the ssh daemon will be started.

7) How do I run the NPAD system?

The NPAD (Network Path and Application Diagnosis) is a client/server program developed by the network research group at Pittsburgh Supercomputer Center (PSC). At boot time, the NPToolkit starts the NPAD server process and leaves it listening on TCP port 8200. To use this server, a user starts a Java-enabled web browser and points it at the NPToolkit server (http://your.nptoolkit.server:8200). The server automatically downloads a Java applet to the client. Then the user runs a test to begin the diagnostic process.

Once the test has been completed, the server displays a results page on the clients’ browser. The user may examine these results and follow the recommendations to resolve problems. If the user is unable to repair a reported problem, the results page URL can be emailed to the appropriate system administrator or NOC operator.

The server retains a complete record of the test results and the raw data used to derive these results. This allows post-processing of interesting results to determine what went wrong and to improve the reporting capabilities of the NPAD server.

See http://www.psc.edu/networking/projects/pathdiag/ for more details.

8) How do I use BWCTL?

BWCTL (Bandwidth Test Controller) is a client/server program developed to simplify Iperf testing between hosts. At boot time, the NPTookit starts a BWCTL server process and leaves it listening on TCP port 4823. This server may then be accessed by remote BWCTL clients or you can logon to this NPToolkit server and run tests to remote BWCTL servers. The BWCTL server allows TCP tests with a maximum duration of 30 seconds.

To run a test to a remote BWCTL server:

1. Logon to the NPToolkit server using the “knoppix” userid
2. Identify the remote server
3. Run the “bwctl -s remote-bwctl-server” command to stream data for 10 seconds from the your NPToolkit server to the remote BWCTL server. Results are displayed on our console or terminal window.

Visit the http://e2epi.internet2.edu/bwctl/ web page for more details and a complete set of man pages.

Visit the http://e2epi.internet2.edu/pipes/pmp/pmp-dir.html for a list of BWCTL servers know to Internet2. [For example to run a test to the BWCTL server located in the Internet2 Chicago PoP, replace the string ‘remote-bwctl-server’ with ‘nms-rthr2.chic.net.internet2.edu’.]

9) How do I run the NDT system?

The NDT (Network Diagnostic Tool) is a client/server program developed to simplify testing to desktop/laptop computers. At boot time, the NPToolkit starts a pair of NDT server processes and leaves them listening on TCP ports 7123 and 3001. To use this server, a client starts a Java-enabled web browser and points it at the NPToolkit server (http://your.nptoolkit.server:7123). The server automatically downloads a Java applet to the client. The end-user can run a test to begin the diagnostic process.

Once the test has been completed, the server displays a results page on the clients’ browser. The end-user may examine these results and follow the recommendations to resolve problems. If the end-user is unable to repair a reported problem, the user may click the “Report Problems” button to generate an email that will be addressed to the appropriate NPToolkit administrator.

The server retains a record of the test results to allow the post-processing of interesting results to determine what went wrong and to improve the reporting capabilities of the NDT server.

Visit the http://e2epi.internet2.edu/ndt/ web page for more details and a complete set of man pages.

10) How do I use the Traceroute/Ping server?

The Traceroute/Ping server is a client/server program that allows remote users to run the traceroute command from the NPToolkit server back to their client. At boot time, the NPToolkit starts a web server process and leaves it listening on TCP port 3765. To use this server, a client starts a Java-enabled web browser and points it at the NPToolkit server (http://your.nptoolkit.server:3765). The perl script based server performs the traceroute function and returns the results to the browser based client.

Visit the http://www.slac.stanford.edu/comp/net/ for more details.

11) What is NTP?

NTP (Network Time Protocol) is a program that synchronizes your computers clock to a global time source. An accurate clock is essential for running one-way ping tests (see below). The NTP daemon must connect to several, at least four (4), remote time servers to obtain accurately set the local clock. By default, the NPToolkit server synchronized to both Internet2 and public time sources.

12) How do I use OWAMP?

OWAMP (One-Way Ping) is a client server program that was developed to provide delay and jitter measurements between two Internet2 hosts. At boot time, the NPToolkit starts an OWAMP server process and leaves it listening on TCP port 861. This server may then be used by remote clients or you can logon to this NPToolkit server and run tests to remote OWAMP servers. By default, the OWAMP server sends a low-level data stream in each direction and measures the one-way delay and jitter between the two hosts. Separate measurements, one for each direction, are reported to the user at the end of the test.

To run a test to a remote OWAMP server:

1. Logon to the NPToolkit server using the “knoppix” userid.
2. Identify the remote server.
3. Run the “owping remote-owamp-server” command to make a pair of 10 second delay measurements (one in each direction) between remote OWAMP server and your NPToolkit server. Results are displayed on your console or terminal window.

Visit the http://e2epi.internet2.edu/owamp/ web page for more details and a complete set of man pages.

Visit the http://e2epi.internet2.edu/pipes/pmp/pmp-dir.html for a list of OWAMP servers know to Internet2. [For example, to run a test to the OWAMP server located in the Internet2 Chicago PoP, replace the string ‘remote-owamp-server’ with ‘nms-rlat.chic.net.internet2.edu’.]

13) What is Thrulay?

Thrulay is an advanced client/server Bandwidth measurement tool. It reports both the measured throughput and the path delay (hence the name Thrulay). In UDP mode, it can generate true Poisson streams with micro-second errors in sending times. By default, the Thrulay daemon is not started. Future versions of the NPToolkit may change this behavior.

Visit the http://e2epi.internet2.edu/thrulay/ web page for more details and a complete set of man pages.