5600 Series User's Guide for the
Command Line Interface
--------------------------------------------------------------------------------
How to Use This Guide
This Guide describes the command line interface for the Efficient Networks 5600 Series Ethernet DSL routers. This includes the 5660 and 5621 products. Because the two routers use different DMT chipsets, there are some commands and functionality available on the 5660 but not the 5621 router, and vice versa. The procedures described in this guide will note any functionality that is specific to a particular model of the router.
This Guide provides information on:
How to access the command console through a TELNET session or by logging on using a terminal connected to the router using a serial cable
Configuration procedures that describe what commands should be used to configure the various features provided on the router and the bridge
This Guide is composed of two separate documents: Accessing the Command Console and the Configuration Procedures.
To print one of these documents, click on the link in this paragraph to bring up the desired page and on your web browser, then select File > Print.
You can search for specific commands or other related information in this Guide using your web browser. Simply click in the document and select Control-F or select Edit > Find in Frame or Find (on this page). Enter the word or phrase you are searching for and select the Find Next button.
--------------------------------------------------------------------------------
How to Access the Command Console
Along with an HTML interface, the 5600 series router/bridge also provides a command-line interface that is accessible using one of the following methods:
TELNET access over Ethernet
Local terminal connected to the serial port
This page describes how to connect to the command console. For more information on a specific command, refer to the on-line help available from in the command-line interface.
--------------------------------------------------------------------------------
TELNET Access
In order to access this User's Guide, you must have already established an Ethernet connection to the 5600 unit. If you want to learn more about it, refer to the "5600 Series Installation Guide" for details on how to connect to a 5600 series unit over Ethernet.
From the local area network you can use TELNET to log in using the Ethernet IP address. Or, if the bridge/router is configured as a router, it can be accessed from the WAN using the DSL/WAN IP address. Initially out of the box, the bridge/router has no WAN IP address so only the Ethernet address can be used for remote access on initial startup.
To log on to the bridge/router via TELNET:
If using Windows on a PC, select Start > Programs > Command Prompt. If on a UNIX system, bring up a shell window.
(On a PC, when the MS-DOS window appears, enter
telnet 10.0.0.1 or telnet ENI-Router
This will bring up a Telnet window which will display the command prompt for the bridge/router's command line interface.
Refer to Using the Command Line Interface for details on the user interface.
--------------------------------------------------------------------------------
Local Terminal Access
A terminal can be connected directly to the RS232 serial port. This requires the use of a terminal emulation software package such as Procomm or Microsoft Hyperterminal. Any standard terminal that supports baud rates of 9600 or greater can be connected to the bridge/router's serial port. By default, the bridge/router is configured to communicate at a baud rate of 38400.
Logging on via the Serial Port
When you first connect to the bridge/router through the serial port, the bridge/router will be in "auto-baud" mode where it is waiting for keyboard input to set the baud rate. In the auto-baud mode, the bridge/router starts at 9600 baud and looks for the [Enter] key being pressed. If the data received is not an [Enter], the baud rate increases up to the default rate of 38400.
To log on to the bridge/router via HyperTerminal:
Select Start > Programs > Accessories > HyperTerminal.
Enter a Connection name and click OK.
Select COM1 and click OK.
Enter the following parameters:
Bits per second 38400
Data bits 8
Parity None
Stop bits 1
Flow control None
Click OK.
When the HyperTerminal window appears, you must press the [Enter] key several times to get the Command-> prompt. The [Enter] key may have to be pressed up to 5 times to get the prompt.
--------------------------------------------------------------------------------
Using the Command Line Interface
The command-line interface is a convenient way to quickly access the 5600 series router/bridge and perform simple configuration procedures. The command-line interface is accessible via the serial port using a terminal emulation package. The command-line is also accessible remotely if you have a computer that can reach the router/bridge using the LAN IP address (Ethernet IP address) or the WAN IP address.
Command Prompt/Error Prompt
The following are the keyboard conventions used during a command session. Normally, the command line prompt is:
Command->
However, if there has been a "soft" error during power-on self test (POST), the prompt will display as:
post_error->
If you see this prompt, you can connect to the bridge/router via serial port and reboot the bridge/router. When the bridge/router reboots, the POST error messages will be displayed to the serial console. Contact the vendor to report the problem.
Command Line Interface Conventions
The following are the keyboard conventions used during a command session.
At the Command-> prompt:
help
Displays the conventions described below.
?
Displays the top-level command set.
<cmd> ?
Displays help for the command <cmd>. For example, to see all "set" commands, type set ?.
ESC- or ESC+
Scrolls through the last commands executed. Type ENTER to execute the command displayed.
CTRL-U
Erases the entire line.
[Backspace]
Backs up one character
[Control-C]
Aborts the current command-line entry.
[ESC]
Can be used to put the command line into the vi-style line editing mode.
Some commands have required and optional parameters. If you type the command name and press [Enter], you will be prompted for each parameter. When being prompted for a command argument:
+ or - Scrolls through the keywords. This control only works for arguments that are keywords.