Efficient Networks and SpeedStream are registered trademarks, and the Efficient Networks logo is a trademark of Efficient
Networks, Inc. All other names may be trademarks, service marks or registered trademarks held by their respective companies.
This document is for information purposes only, Efficient Networks is not responsible for errors or omissions herein. Efficient
reserves the right to make changes to product specifications without notice.
Efficient Networks, Inc. – End User Software License and Warranty
INSTALLATION OF THE HARDWARE AND SOFTWARE PROVIDED BY EFFICIENT NETWORKS, INC. ("EFFICIENT") CONSTITUTES ACCEPTANCE BY YOU OF THE TERMS OF THE FOLLOWING SOFTWARE LICENSE AND LIMITED WARRENTY. IF YOU
DO NOT ACCEPT THESE TERMS, PLEASE RETURN THE HARDWARE AND SOFTWARE AND SOFTWARE IN ITS ORIGINAL
PACKAGING TO THE VENDOR FROM WHICH YOU PURCHASED IT FOR A FULL REFUND OF THE PURCHASE PRICE.
The following describes your license to use the software (the"Software") that has been provided with your EFFICIENT DSL customer premise
equipment ("Hardware") and the limited warranty that EFFICIENT provides on its Software and Hardware. EFFICIENT reserves any right not
expressly granted to the end user.
Software License
The Software is protected by copyright laws and international copyright treaties. The Software is licensed and not sold to you. The definition
od Software includes, but not limited to, system and operating software marketed by EFFICIENT, including firmware, embedded software, software provided on media, downloadable software, software for configuration or programmable logic elements, and all EFFICIENT maintenance
and diagnostic tools associated with the above mentioned software. Accordingly, while you own the media (such as CD ROM or floppy disk)
on which the software is recorded, EFFICIENT or its licensors retains ownership of the Software itself.
1. Grant of License
You may make backup copies of the system configuration as required. If the Hardware is being installed on a network, you may install the Software on the network server or other server-side devise on which the Hardware is being installed and onto the client-side devices.
2. Restrictions
• sublicense, assign, or distribute copies of the Software to others;
• decompile, reverse engineer, disassemble or otherwise reduce the Software or any part thereof to a human perceivable form;
• modify, adapt, translate or create derivative works based upon the Software or any part thereof; or
• rent, lease, loan or otherwise operate for profit the Software.
3. Transfer
the Software from any devices onto which you have installed it, and must ensure that the party to whom you transfer the Hardware receives this
License Agreement and Limited Warranty.
4. Upgrades Covered
may receive from EFFICIENT, whether delivered via tangible media (CD ROM or floppy disk), down loaded from EFFICIENT, or delivered
through customer support. Any such additional software shall be considered "Software" for all purposes under this License.
5. Export Law Assurances
firm that you will not export or re-export the Software to any countries that are subject to export restrictions.
6. No Other Rights Granted.
otherwise, is granted to any copyright, patent, trademark, trade secret, or other proprietary rights of EFFICIENT or its licensors.
7. Termination.
provisions. Upon termination, you must return the Software and all copies thereof.
Limited Warranty
The following limited warranties provided by EFFICIENT extend to the original end user of the Hardware/licensee of the Software and are not
assignable or transferable to any subsequent purchaser/licensee.
1. Hardware. EFFICIENT warrants that the Hardware will be free from defects in materials and workmanship and will perform substantially
in compliance with the user documentation relating to the Hardware for a period of one year from the date the original end user received the
Hardware.
2. Software
the Hardware and Software for a period of ninety days from the date the original end user received the Hardware and Software. The end user is
responsible for the selection of Hardware and Software used in the end user’s network. Given the wide range of third-party hardware and applications, EFFICIENT does not warrant the compatibility or uninterrupted or error free operation of our Software with the end user’s systems or
network.
3. Exclusive Remedy
sole option, either (a) a refund of the purchase price paid for the Hardware/Software or (b) repair or replacement of the Hardware/Software with
new or remanufactured products. Any replacement Hardware or Software will be warranted for the remainder of the original warranty period
or thirty days, which ever is longer.
4. Warranty ProceduresΑ. Prior to returning a product under this warranty, the end user must first call EFFICIENT at (888) 286-9375, or send an email to EFFI CIEN T
at support@efficient.com to obtain a return materials authorization (RMA) number. RMAs are issued between 8:00 a.m. and 5:00 p.m. Central
Time, excluding weekends and holidays. The end user must provide the serial number(s) of the products in order to obtain an RMA.
. You may install and use one (and only one) copy of the Software in conjunction with the EFFICIENT provided Hardware.
. The license granted is a limited license. You may NOT:
. You may transfer the Software only where you are also transferring the Hardware. In such cases, you must remove all copies of
. This License covers the Software originally provided to you with the Hardware , and any additional software that you
. You acknowledge that the Software may be subject to export control laws and regulations of the U.S.A. You con-
Other than the limited license expressly granted herein, no licens e, whethe r expre s s or implie d, by estoppel or
Without limiting EFFICIENT’s other rights, EFFICIENT may terminate this license if you fa il to c omply with any of these
. EFFICIENT warrants that the Software will perform substantially in compliance with the end user documentation provided with
. Your exclusive remedy and EFFICIENT’s exclusive obligation for breach of this limited warranty is, in EFFICIENT’s
. If a problem develops during the limited warranty period, the end user shall follow the procedur e outlined be low:
Efficient Networks
®
Page 4
Software License and Limited Warranty
B. After receiving an RMA, the end user shall ship the product or defective component, including power supplies and cable, where applicable,
freight or postage prepaid and insured, to EFFICIENT at 4849 Alpha Road, Dallas Texas 75244, U.S.A. Within five (5) days notice from EF-
FICIENT, the end user shall provide EFFICIENT with any missing items or, at EFFICIENT’s sole option, EFFICIENT will either (a) replace
missing items and charge the end user or (b) return the product to the end user freight collect. The end user shall include a return address, daytime
phone number and/or fax. The RMA number must be clearly marked on the outside of the package.
C. Returned Products will be tested upon receipt by EFFICIENT. Products that pass all functional tests will be returned to the end user.
D. EFFICIENT will return the repaired or replacement Product to the end user at the address provided by the end user at EFFICIENT Network’s
expense. For Products shipped within the United States of America, EFFICIENT will use reasonable efforts to ensure delivery within five (5)
business days from the date received by EFFICIENT. Expedited service is available at additional cost to the end user.
E. Upon request from EFFICIENT, the end user must prove the date of the original purchase of the product by a dated bill of sale or dated
itemized receipt.
5. Limitations
• The end user shall have no coverage or benefits under this limited warranty if the product has been subject to abnormal use, abnormal conditions, improper storage, exposure to moisture or dampness, unauthorized modifications, unauthorized repair, misuse, neglect, abuse, accident,
alteration, improper installation, or other acts which are not the fault of EFFICIENT, including acts of nature and damage caused by shipping.
• EFFICIENT will not honor, and will not consider the warranty voided, if: (1) the seal or serial number on the Product have been tampered
with or (2) there has been any attempted or actual repair or modification of the Product by anyone other than an EFFICIENT authorized service
provider.
• The limited warranty does not cover defects in appearance, cosmetic, decorative or structural items, including framing, and any non-operative
parts.
• EFFICIENT’s limit of liability under the limited warranty shall be the actual cash value of the product at the time the end user returns the
product for repair, determined by the price paid by the end user for the product less a reasonable amount for usage. EFFICIENT shall not be
liable for any other losses or damages.
• The end user will be billed for any parts or labor charges not covered by this limited warranty. The end user will be respo n sible for any expenses related to reinstallation of the product.
• THIS LIMITED WARRENTY IS THE ONLY WARRENTY EFFICIENT MAKES FOR THE PRODUCT AND SOFTWARE. TO THE
EXTENT ALLOWED BY LAW, NO OTHER WARRENTY APPLIES, WETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING
ANY WARRENTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
6. Out of Warranty Repair. Out of warranty repair is available for a fixed fee. Please contact EFFICIENT at the numbers provided above to
determine out of warranty repair rate. End users seeking out of warranty repair should contact EFFICIENT as described above to obtain an RMA
and to arrange for payment of the repair charge. All shipping char ges will be bille d to the end-us er .
.
General Provisions
The following general provisions apply to the foregoing Software License and Limited Warranty.
1. No Modification. The foregoing Limited Warranty is the end user’s sole and exclusive remedy and is in lieu of all other warranties, express
or implied. No oral or written information or advice given by EFFI C IEN T or tis dealers, distributors, employees or agents shall in any way
extend, modify or add to the foregoing Software License and Limite d Wa rr an ty. This Softwa r e Licen se an d Limi ted War ra nty c ons titutes the
entire agreement between EFFICIENT and the end user, and supersedes all prior and contemporaneous representation, agreements or understandings, oral or written. This Software License and Limited Warranty may not be changed or amended except by a written instrument executed
by a duly authorized officer of EFFICIENT.
EFFICIENT neither assumes nor authorizes any authorized service center or any other person or entity to assume for it any other obligation or
liability beyond that which is expressly provided for in this Limited Warranty including the provider or seller of any extended warranty or service
agreement.
The Limited Warranty period for EFFICIENT supplied attachments and accessories is specifically defined within their own warranty cards and
packaging.
2. EXCLUSION OF INCIDENTAL, CONSEQUENTIAL AND OTHER DAMAGES
IN NO EVENT SHALL EFFICIENT OR ITS LICENSORS BE LIABLE, WHETHER UNDER CONTRACT, WARRENTY, TORT OR ANY
OTHER THEORY OF LAW FOR ANY SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES WHATSOEVER, INCLUDING
BUT NOT LIMITED TO DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRPUTION, PERSONAL INJURY, LOSS OR IMPAIRMENT OF DATA OR BUSINESS INFORMATION, EVEN IF EFFICIENT HAS BEEN NOTIFIED OF THE POSSIBILITY OF SUCH
DAMAGES. EFFICIENTS’S OR IT’S LICENSOR’S LIABILITY TO YOU (IF ANY) FOR ACTUAL DIRECT DAMAGES FOR ANY
CAUSE WHATSOEVER, AND REGARDLESS OF THE FORM OF THE ACTION, WILL BE LIMITED TO, AND SHALL NOT EXCEED,
THE AMOUNT PAID FOR THE HARDWARE/SOFTWARE.
3. General
United States (excluding conflicts of laws rules), and shall insure to the benefit of EFFICIENT and its successor, assignees and legal representatives. If any provision of this Software License and Limited Warranty is held by a court of competent jurisdiction to be a invalid or unenforceable to any extent under applicable law, that provision will be enforced to the maximum extent permissible, and the remaining provisions of t hi s
Software License and Limited Warranty will remain in full force and effect. Any notices or other communications to be sent to EFFICIENT
must be mailed by certified mail to the following address:
Efficient Networks, Inc.
4849 Alpha Road
Dallas, TX 75244
U.S.A.
Attn: Customer Service
. This Software License and Limited Warranty will be covered by and construed in accordance with the laws of the State of Texas,
. TO THE FULL EXTENT PERMITTED BY LAW,
Efficient Networks
®
Page 5
Efficient Networks®Router family
Command Line Interface Guide
Revision History
RevisionEffective DateDescription Of Change
- 001 12 Feb 2002 Initial Release. Information provided to support software kernel
release 6.0.0.
Efficient Networks
®
Page 6
Efficient Networks® Router family
Command Line Interface Guide
Efficient Networks® Router family
Command Line Interface Guide
This manual contains information on the syntax and use of the Command Line
Interface for the Ef fici ent Networks fa mily of bu siness-cla ss DSL router s. This manual
is intended for small and home of fice users, remote off ice users, and other networ king
professionals who are installing and maintaining bridged and routed networks.
It assumes that you have read the User Reference Guide that came with the router
and have installed the router as described in that guide. If the configuration i s to
include advanced functionality, a Technical Reference Guide has also been supplied
that provides essential information on the appli cation, configur ation, and management
of these features.
Chapter 1: Introduction
CHAPTER 1
CHAPTER 1 INTRODUCTION
Configuration of network connections, bridging, routing, and security features are
essentially the same for all DSL routers, unless otherwise noted.
As described in the User Reference Guide, a graphical int erface is also available for
configuring the router . It provides many , but not all, of the capabilities of the Command
Line Interface. Look for the User Referen ce Guide in the box in which your router was
shipped or find it on the Technical Support web site (www.efficient.com).
How This Manual is Organized
This manual is organized in two parts:
•How to Access the Command Line. Describes how to access the router
command line from a PC so you can enter router commands.
•Command Reference. Provides a description and syntax for each command.
Efficient Networks
®
Page 1-1
Page 24
Chapter 1: IntroductionEfficient Networks® Router family
Command Line Interface Guide
Command Conventions
The Command Line Interface (CLI), unless noted otherwise, follows these
conventions:
•Command line length may be up to 120 characters long unless otherwise
noted. Input characteristics are footnoted throughout the manual.
•The Command Line Interface is not cas e-sensi tive except for pas swords and
router names, and key strings.
•All parameters are positional; i.e., each keyword/parameter must be entered
in the correct order, as shown in the command format in this manual.
The command formats shown in this manual follow these conventions:
•For each command, the input format is provided. Many command use
additional parameters that allow
•Parameters enclosed in < and > are placeholders representing specific
information that you supply or a li st of defi ned p aramet ers of which one mus t
be entered.
•Parameters (may include more than one) enclosed in the charact ers [ and ]
are optional.
Accessing the Command Line
To use the Command Line Interface, you must first access the router command line.
To do this, perform the following steps:
Step 1Connect a PC (or ASCII) terminal to a port of the router.
(The required cable and adapter are provided with the router. The connection
procedure is described in detail in the User Reference Guide that came with the
router.)
Step 2Restart the PC and power on the router.
Step 3Open a terminal window or start a terminal session on the PC.
Step 4The router displays the login prompt. Login with the username superuser.
Username:
Step 5
The router displays the password prompt, enter the login password (default
password is admin.
Password:
Page 1-2Efficient Networks
®
Page 25
Efficient Networks® Router family
Command Line Interface Guide
NOTE:
The password will be displayed as *****
Chapter 1: Introduction
Step 6
Step 7
Step 8
Step 9
A confirmation is returned; the command line interface is now available.
Logged in successfully!
If the default login password (admin) was used a message will be displayed.
**************************************************************
WARNING: You must change your password from the default value!
**************************************************************
Enter a new password at the prompt.
Enter New Password:
Re-enter the new password at the prompt.
Enter New Password Again:
The password change will be confirmed:
Password changed.
The command line is now available for use.
Terminal Sessions
The router supports both local access and remote access. In step 3 above, the
terminal session could be:
•Terminal Session under Windows (HyperTerminal) or Terminal Session for
Macintosh or UNIX (for local access)
•Telnet Session for Remote Access
Task Complete
Efficient Networks
®
Page 1-3
Page 26
Chapter 1: IntroductionEfficient Networks® Router family
Command Line Interface Guide
Terminal Session under Windows (HyperTerminal)
To open the HyperTerminal emulator available under the Windows operating system:
Step 1Click Start on the Windows taskbar, then select:
> Programs
> Accessories
> Communications
> Hyperterminal
> Hyper Terminal
The HyperTerminal window will appear in the background and you will be prompted
for configuration information.
Step 2In the Connection Description window, enter a name for the connection and select
OK.
Step 3In the Phone Number window, under Connect using, select Com 1 (or 2).
Page 1-4Efficient Networks
®
Page 27
Efficient Networks® Router family
Chapter 1: Introduction
Command Line Interface Guide
Step 4In the Com 1 (or 2) Properties page, enter the following port settings and select OK:
Bits per second:
Data bits:
Parity:
Stop bits:
Flow control:
a
To use a baud rate other than 9600, “Option 7: Set Console Baud Rate” on page 4-39 in the
Technical Reference Guide.
a
9600
8
None
1
Hardware
Task Complete
Efficient Networks
®
Page 1-5
Page 28
Chapter 1: IntroductionEfficient Networks® Router family
Command Line Interface Guide
Terminal Session for Macintosh or UNIX
To open a terminal window emulation in a Macintosh or UNIX environment, a VT100
terminal emulation program is required.
Step 1Start your VT100 terminal emulator.
Step 2Configure the emulator with the following settings:
Bits per second:
Data bits:
Parity:
Stop bits:
Flow control:
a
To use a baud rate other than 9600, “Option 7: Set Console Baud Rate” on page 4-39 in the
Technical Reference Guide.
a
9600
8
None
1
Hardware
Task Complete
Page 1-6Efficient Networks
®
Page 29
Efficient Networks® Router family
Command Line Interface Guide
Chapter 1: Introduction
Teln et Session for Remote Access
From the local area network you can use TELNET to login in using the Ethernet IP
address. (For more information, see Telnet Remote Access.)
NOTE:
Remote access to the router configuration can be disabled or restricted. For further
information, see “Controlling Remote Management” on page 5-15.
Step 1Make sure that your PC and router addresses are in the same subnetwork. For
example, the router address could be 192.168. 254.254 and the PC address could be
192.168.254.253.
Step 2Start a TELNET session.
a.If you are using a PC running Windows“ 95/98/NT“, select Start > Run. If on a
UNIX system, bring up a shell window.
b.In the Run dialog box (or shell) window, enter:
telnet 192.168.254.254
c.Click OK, or press <Enter>.
Step 3A TELNET window will be launched; a line identifying the router will be displayed,
Chapter 1: IntroductionEfficient Networks® Router family
Command Line Interface Guide
Command Line via the Web Management Interface
The Web Management interface provides a web gateway to the command line
interface allowing command line syntax the be entered through a browser-based
connection. For more information on connecting to the system via the Web
Management Interface, refer to the User Refer ence Guide.
Page 1-8Efficient Networks
®
Page 31
Efficient Networks® Router family
Command Line Interface Guide
The commands in this section are onli ne action an d st atus commands. They faci lit at e
the following functions:
•log into and log out of configuration update mode
•display the router’s configuration, the version and level numbe rs
•list running tasks, memory, and communication interfaces
•dial a remote router to test the ISDN line
Chapter 2: Status Commands
CHAPTER 2
CHAPTER 2 STATUS COMMANDS
•connect to a remote router to test the line
•list IP routes, IPX routes and SAPs, and root bridge
•save the new configuration image
•reboot the system
The status commands found in this section in clude:
Table 2-1: Status Command Listing
CommandFunction
? or help
Lists the top-level commands and k eywords and a
brief description of their function.
arp deleteDeletes the IP address of the ent ry i n the Ad dress
Resolution Protocol (ARP) table.
arp listLists ARP table entries.
biLists the root bridge, and indicat es whether the
mode is learning, listening, or forwarding.
bi listLists the contents of the bridge table.
callDials a remote router.
dateDisplays or changes the current date on the rout-
Efficient Networks
er’s clock.
®
Page 2-1
Page 32
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
Table 2-1: Status Command Listing (Cont.)
CommandFunction
eraseErases the entire router’s configuration or parts of
it from FLASH memory.
exitHas the same function as logout, but will discon-
nect the Telnet session.
ifsLists the communicatio n in terfac es installed in the
router and the status of the interfaces.
ipifsLists the system IP inter face(s).
iproutesLists the current entries in the IP routing table.
ipxroutesLists the current entries in the IPX routing table.
ipxsapsLists the current servi ces in t he IPX SAPs table.
logoutLogs user out (to Login prompt ->) to reinstate ad-
ministrative security.
memReports the amount of RAM memory installed in
the router and its current allocation.
mlp summaryLists the status of the protocols negotiated for an
active remote connection.
passwordChanges the current user password.
pingTransmits an echo message.
psList s all of the tasks (processes ) running in the sys-
tem and the status of the tasks.
rebootInitiates a reboot of the system.
saveSaves the entire router’s configurati on or parts of it
to FLASH memory.
sntp activeDisplays the active SNTP server.
sntp disableDisplays the active SNTP server.
sntp enableEnables SNTP requests.
sntp offsetSpecifies the SNTP offset from the Universal T ime
Coordinate (UTC).
sntp prefserverDisplays or changes the preferred SNTP server.
sntp requestRequests the time from an SNTP server.
Page 2-2Efficient Networks
®
Page 33
Efficient Networks® Router family
Command Line Interface Guide
Table 2-1: Status Command Listing (Cont.)
CommandFunction
sntp serverDisplays or changes the SNTP server list.
tcp statsDisplays the TCP statistic s and open connections.
timeDisplays or changes the current time on the rout-
tracerouteT rac es the route t aken by pac kets sent f rom the lo-
versDisplays the software version level, source, soft-
? or help
Chapter 2: Status Commands
er’s clock.
cal router to the specified IP address or domain
name.
ware options, and amount of elap sed t ime that the
router has been running.
Lists the top-level commands and keywords and a brief description of their function.
Input Format
? or help
Parameters
None
Response
A listing of the top-level commands and keywords with a description of their function.
Efficient Networks
®
Page 2-3
Page 34
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
arp delete
Deletes the IP address of the entry in the ARP table. For additional information, see
”ARP” on page 6-6.
Mgmt Class
Network (R/ W)
Input Format
arp delete <ipaddr> | all
Parameters
Example
Response
arp list
Mgmt Class
<ipaddr>
all
a
Dotted-decimal notation.
arp delete 128.1.2.0
Command prompt.
Lists Address Resolution Protocol (ARP) table entries in an IP routing environment .
ARP is a tool used to find the appropriate MAC addresses of devices based on the
destination IP addresses. For additional information, see ”ARP” on page 6-6.
Network (R)
a
IP address of IP entry to delete from ARP table.
Deletes all existing are table entries.
Input Format
arp list <ipaddr> <interfacename> <interfaceunit>
Page 2-4Efficient Networks
®
Page 35
Efficient Networks® Router family
Command Line Interface Guide
Parameters
Chapter 2: Status Commands
Example
Response
bi
<ipaddr>
<interfacename>
<interfaceunit>
a
Dotted-decimal notation.
b
HEX notation
c
Integer
a
IP address associated with a MAC address for a device on the local
interface
b
MAC address on the local network.
c
For an Ethernet interface, this can be a 1 or 0. For a DSL interface,
this is a VPN number.
arp list
-> arp list
IP AddrMac AddressInterface
192.84.210.14800:05:02:00:80:A8ETHERNET/0
Lists the root bridge, and indicat es whether the mode is learning, listening, or
forwarding. For additional information, see ”Bridging” on page 2-2.
Mgmt Class
Voice (R)
Input Format
bi
Parameters
None
Response
-> bi
GROUP 0Our ID=8000+00206f0249fc Root ID=8000+00206f0249fc
Port ETHERNET/000+00 FORWARDING
Efficient Networks
®
Page 2-5
Page 36
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
bi list
Lists the contents of the bridge table. Each MAC address in the table is listed with its
corresponding bridge port as learned by the bridge function. The line also shows the
number of seconds elapsed since the last packet was received by the MAC address
followed by flags. Possible flags include:
PPermanent (This entry is not aged out of the table.)
FLDFlood
USThis entry is for the target router.
AAccept
FWDForward
BCBroadcast
MCMulticast
Mgmt Class
Voice (R)
Input Format
bi list
Parameters
None
Response
-> bi list
BRIDGE GROUP 0:
00206F024C34:PUSSDA
0180C2000000:PAMC
FFFFFFFFFFFF:P FLDABC MC
02206F02E70D:ETHERNET/0325FWD
00C04F2E1AEB:ETHERNET/0143FWD
0060081BD761:ETHERNET/0 95FWD
Page 2-6Efficient Networks
®
Page 37
Efficient Networks® Router family
Command Line Interface Guide
call
Dials a remote router. This command can be used to test the ISDN link or L2TP
secession and the configuratio n settings for the remote router.
Mgmt Class
Voice (R/W)
Input Format
call <remotename>
Parameters
Chapter 2: Status Commands
<remotename>
a
ASCII string.
Response
Normal response:
Request Queued
If an unknown target <
unknown remotename <hq>
a
Name of the target router.
remotename> is entered, the following is displayed:
Efficient Networks
®
Page 2-7
Page 38
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
date
Displays or changes the current date on the router’s clock. To change the current
time, use the time command.
Automatic SNTP requests are gener ated if the sy stem need s to get t he time. You can
specify an SNTP server using the command sntp server () and a UTC offset with the
sntp offset command.
To see the current date and time on the router clock, enter date with no parameters:
Mgmt Class
All (R/W)
Input Format
date <mm/dd/yy>
Parameters
<mm>
<dd>
<yy>
a
Integer 1- 12
b
Integer 1- 31
c
Integer, indicating a year from 196 8 through 2034. Thus , 1/1/4 is Jan uary 1, 200 4, 1/1/33 is January
1, 2033, and 1/1/78 is January 1, 1978.
Response
Display when date is entered with no parameters.
-> date
BootTime:7/1/2001 at 15:42:42
Current time:7/1/2001 at 15:49:16
Display when date is entered with parameters.
-> date 7/1/1
Time set to UTC-420, 7/1/2001 at 15:59:29
Time adjusted for (-) 0 days 0 hours 10 minutes 13 seconds
a
b
c
Month
Day
Year
Page 2-8Efficient Networks
®
Page 39
Efficient Networks® Router family
Command Line Interface Guide
erase
Erases the entire router’s configuration or parts of it from FLASH memory.
CAUTION:
You will need to completely reconfigure any part of the configuration that you erase.
NOTE:
An erase command does not take effect until after a reboot without a save command.
Mgmt Class
Admin (R/W)
Input Format
Chapter 2: Status Commands
erase all | keys | dod | sys | eth | filter | ipsec | ike | atom
| sdsl | idsl | frame | dhcp | atm25 | l2tp | sntp
Parameters
***
all
atom
dhcp
dod
eth
filter
keys
sys
When entered with no parameters, same as erase all.
Erases the entire router configuration from FLASH memory, includ-
ing settings for the system, Ethernet LAN, DSL line, DHCP, and remote router database.
Erases the ATM configuration settings.
Erases the DHCP configuration settings from FLASH memory. To
clear all DHCP information without erasing FLASH memory, us e the
command dhcp clear all records (xxx).
Erases the current state of the remote router database.
Erases the configuration settings for the Ethernet LAN from FLASH
memory.
Erases the current bridging filtering database from FLASH memo-
ry.When you issue this command you must reboot (without a save).
Erases the software option keys from FLASH memory.
Erases the name, message, and authentication password system
settings from FLASH memory.
Example
# erase dod
Efficient Networks
®
Page 2-9
Page 40
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
Response
Command prompt.
NOTE:
There is a time lag between the response issued by the erase command and the time
that the data is actually deleted from FLASH memory. To commit the changes to
FLASH memory , issue a sync command after an erase command before powering of f
the router.
exit
Has the same function as logout, but will disconnect an active Telnet session.
Mgmt Class
All (R)
Input Format
Parameters
Response
ifs
Mgmt Class
Input Format
exit
None
Command prompt.
Lists the communication inte rfaces installed in the router and the status of the
interfaces.
Voice (R), Network (R)
ifs
Parameters
None
Page 2-10Efficient Networks
®
Page 41
Efficient Networks® Router family
Command Line Interface Guide
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
mlp summary
Lists the status of the protocols negotiated for an active remote connection. The
following are the most common protocols:
•MLP (Multilink Procedure)
•IPNCP (IP routing Network Protocol)
•CCP (Compression Control Protocol)
•BNCP (Bridging Network Protocol)
•IPXCP (IPX Network Protocol)
Mgmt Class
Network (R)
Input Format
mlp summary
Parameters
None
Response
Open - indicates that the protocol is in re ady state.
Stopped - means that the protocol is defined, but did not successfully negotiate with
the remote end.
No message (command prompt
->) indicates that the link is not active.
Page 2-16Efficient Networks
®
Page 47
Efficient Networks® Router family
Command Line Interface Guide
password
Changes the current user password.
Mgmt Class
All (R/W)
Input Format
password <old password> <new password>
Parameters
Chapter 2: Status Commands
<old password>
<new password>
a
ASCII string
Response
The follwoing example would change the password for user admin101 from 1675309
to lobster:
admin101@console-> password 1675309 lobster
Password changed for user "admin101"
a
User’s current password.
a
User’s new password.
Efficient Networks
®
Page 2-17
Page 48
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
ping
Transmits an echo message, available within the TCP/IP protocol suite. The echo
message is sent to a remote node and returned; the echo test s connectivity to the
remote node. It is particularl y useful for locating connection problems on a network.
The remote node can be specified by IP address or by domain name. If a domain
name is specified, the address of the domain is requested from the domain name
server (DNS).
A status message is issued for each echo message sent.
NOTE:
You cannot ping your own LAN address; you can ping your own WAN address.
To fit the echo message into one ATM cell in routin g mode, set the l engt h of us er dat a
down to 0 bytes (-s 0 or -l 0).
NOTE:
To terminate the ping before it ends, press control-c.
Number of packets sent.
Wait period between packets in seconds.
c
Packet data length in bytes.
d
Source IP address contained in t he echo message. Use th is option
to force packets into a tunnel or to force use of the mana gement address as the source address.
d
Remote node to which the echo message is sent. It can be specified
by its domain name or by its IP address.
e
Page 2-18Efficient Networks
®
Page 49
Efficient Networks® Router family
Command Line Interface Guide
Response
The following are application examples of the ping command and their typical
responses.
Example
The following command will ping the domain name www.yahoo.com.
-> ping www.yahoo.com
The command attempts a DNS (domain name server) lookup to find the address of
the domain. If the DNS server address is not known, it returns the following message:
ping: unknown host www.yahoo.com
If the DNS lookup is successful, the ping sends f ive pack ets , one second apar t, with a
packet length of 56 bytes.
ping: reply from 216.32.74.52: bytes=56 (data), icmp_seq=1, time=86 ms
ping: reply from 216.32.74.52: bytes=56 (data), icmp_seq=2, time=81 ms
ping: reply from 216.32.74.52: bytes=56 (data), icmp_seq=3, time=82 ms
ping: reply from 216.32.74.52: bytes=56 (data), icmp_seq=4, time=84 ms
ping: reply from 216.32.74.52: bytes=56 (data), icmp_seq=5, time=82 ms
ping: packets sent 5, packets received 5
Chapter 2: Status Commands
Example
The following command requests 2 echo messages sent 7 seconds ap art with a
packet length of 34 bytes. The messages are sent to IP address 192.168.254.2.
-> ping -c 2 -i 7 -s 34 192.168.254.2
-ping: reply from 192.168.254.2: bytes=34 (data), time<5 ms
ping: reply from 192.168.254.2: bytes=34 (data), time<5 ms
ping: packets sent 2, packets received 2
Example
The following command sends packets with the source IP address 192.168.254.254
to the IP address 192.4.210.122. Default values are used f or the other options.
-> ping -I 192.168.254.254 192.4.210.122
Example
The following command uses management address 192.168.1.2 as the source
address when pinging destination address 192.168.100.100.
-> ping -I 192.168.1.2 192.168.100.100
Efficient Networks
®
Page 2-19
Page 50
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
ps
Lists all of the tasks (processes) running in the system and the status of the tasks.
Efficient Networks® Router family
Command Line Interface Guide
reboot
This command causes a reboot of the system.
CAUTION:
A reboot erases any configuration changes that have not been saved. If necessary,
enter a save command before the reboot command.
Certain configuration settings require a reboot before the setting becomes effective,
including:
•A change from IP routing to bridging or the reverse.
•The addition of IKE filters
•IPX changes
•Certain changes to Stateful Firewall rules
Other configuration changes bec ome effective following either a reboot or a restart of
the Ethernet or remote interface. These change s include:
Chapter 2: Status Commands
•System settings
•Ethernet IP address
•TCP/IP routing
•Remote router default bridging destination
•TCP/IP route addresses
•SAPs and bridging
•Adding a new remote entry to the remote database.
A reboot also ensures that all file system updates are completed. There is a time lag
between the entry of a save command and the safe storage of the data in FLASH
memory. If the power goes off before the data is stored in memory, the data can be
lost. Always reboot before powering off the router. Or, use the sync command to
commit file changes to memory.
Mgmt Class
All (R/W)
Input Format
reboot <option>
Efficient Networks
®
Page 2-21
Page 52
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
Parameters
NOTE:
The word default cannot be abbreviated in the command.
Response
save
***
factory
default
User is prompted to verify the command.
The save command saves the entire router’s configuration or parts of it to FLASH
memory. The keyword in the command determines what is saved.
If no option is specified, the router is reboo ted using the existing configuration file.
This option deletes all files except AUTOEXEC.OLD if it exists. AUTOEXEC.OLD is renamed AUTOEXEC.BAT; it is re-executed by the
reboot. This option also resets the non-volat ile RAM; thus deleting the
IP address of the router and the TFTP server during the boot process
and also forcing the rout er to boot from FLASH i nstead of f rom the network.
This option deletes t he system configuration fi le and restores the rout er
to its original defaults (before any conf iguration was entered).
NOTE:
There is a time lag between the response issued by the save command and the time
when the data is actually stored in FLASH memory. Issue a sync command after a
save command before powering off the router. This commits the changes to FLASH
memory.
Mgmt Class
All (R/W)
Input Format
save
Parameters
None
Response
Command prompt.
Page 2-22Efficient Networks
®
Page 53
Efficient Networks® Router family
Command Line Interface Guide
sntp active
Displays the active SNTP server, that is, the server that last responded to an SNTP
request.
Mgmt Class
Admin (R/W)
Input Format
sntp active
Parameters
None
Response
-> sntp active
Active SNTP server is 1 (192.6.38.127)
Chapter 2: Status Commands
sntp disable
Disables SNTP requests.
Mgmt Class
Admin (R/W)
Input Format
sntp disable
Parameters
None
Response
-> sntp disable
Current offset from UTC is 0 minutes
Use <system sntp offset> to set time zone
Efficient Networks
®
Page 2-23
Page 54
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
sntp enable
Enables SNTP requests.
Mgmt Class
Admin (R/W)
Input Format
sntp enable
Parameters
None
Response
-> sntp enable
Current offset from UTC is 0 minutes
Use <system sntp offset> to set time zone
sntp offset
Specifies the SNTP offset from the Universal Time Coordinate (UTC). The offset is
specified in minutes. A positive offset is an offset to the east of the Greenwich
meridian; a negative offset is to the west of the Greenwich meridi an.
Mgmt Class
Admin (R/W)
Input Format
sntp offset <minutes>
Parameters
***
<minutes>
a
Integer 1 - 59
When no parameter is entered, current offset is displayed.
a
Number of minutes east or west of the Greenwich meridian. A positive number is east; a negative number is west.
Page 2-24Efficient Networks
®
Page 55
Efficient Networks® Router family
Command Line Interface Guide
Response
-> sntp offset
Current offset from UTC is 0 minutes
Use <system sntp offset> to set time zone
usage: sntp offset <Minutes from UTC>
(offset is negative for west, positive for east of Greenwich meridian)
-> sntp offset -360
sntp prefserver
Displays or changes the preferred SNTP server. (The preferred server is the server
that should be attempted first when a request is made.)
To specify a server preference, specify the number of the preferred server within the
SNTP server list. To see the SNTP server list, enter sntp server.
To see the active SNTP server (that is, the server that last responded to an SNTP
request), use the command sntp active.
Chapter 2: Status Commands
NOTE:
To make this change permanent, a save must be performed before a reboot.
Mgmt Class
Admin (R/W)
Input Format
sntp prefserver <number>
Parameters
***
<number>
a
Integer
Response
When entered with no <number> parameter:
-> sntp prefserver
The preferred SNTP server is 1 (192.6.38.127)
When no parameter is entered, current preferred server displayed.
a
Number of a server within the SNTP server list.
Efficient Networks
®
Page 2-25
Page 56
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
When entered with a <number> parameter:
-> sntp prefserver 3
Preferred SNTP server is set to 3 (192.6.38.127)
sntp request
Requests the time from an SNTP server. (SNTP is the Simple Network Time Protocol
defined by RFC 1769.)
NOTE:
A request is performed only if SNTP is enabled (see sntp enable).
Mgmt Class
Admin (R/W)
Input Format
sntp request
Parameters
None
Response
When entered while sntp function is currently disabled:
-> sntp request
SNTP is currently disabled
When entered and no sntp preferred server is defined:
-> sntp request
Time server IP address not set, use "sntp server w.x.y.z"
When entered and an sntp preferred server has been defined:
-> sntp request
Time set to UTC-480, 5/7/2001 at 17:29:25.245
Time adjusted for (-) 0 days 1 hours 0 minutes 0 seconds
Page 2-26Efficient Networks
®
Page 57
Efficient Networks® Router family
Command Line Interface Guide
sntp server
Displays or changes the SNTP server list.
•To see the current SNTP server list, specify sntp server with no parameter.
•To specify the default server list, specif y sntp server default.
•To add a server to the list, specify snt p ser ver wit h the ser ver IP address and
a new number for the entry.
•To change the address of a server, specify sntp server with the server IP
address and the existing entry number.
•To remove a server from the list, specify sntp server 0.0.0.0 and the number
of the server to be removed.
NOTE:
To make a change permanent, you must save the change before you reboot.
Chapter 2: Status Commands
Mgmt Class
Admin (R/W)
Input Format
sntp server <ipaddress> | default [<number>]
Parameters
<ipaddress>
default
<number>
a
Dotted-decimal notation
b
To remove a server, specify 0.0.0.0 as the IP address.
c
Integer
Response
When entered with the <default> parameter:
-> sntp server default
a
IP address of an SNTP server.
b
Requests the default server list.
c
Number of the server in the list. If that server number is already in the
list, the IP address is changed; oth erwise, a new entry is added to the
list. If you omit a number , the IP address of the acti ve server is changed.
Current server (1) IP addr: 192.5.41.40
Current server (2) IP addr: 192.6.38.127
Current server (3) IP addr: 209.81.9.7
Current server (4) IP addr: 129.7.1.66
Current server (5) IP addr: 192.168.254.2
Efficient Networks
®
Page 2-27
Page 58
Chapter 2: Status CommandsEfficient Networks® Router family
Efficient Networks® Router family
Command Line Interface Guide
time
Displays or changes the current time on the router’s clock. To change the current
date, use the command date.
Automatic SNTP requests are genera ted if the sy stem needs to get the ti me. You can
specify an SNTP server using the command sntp server and a UTC offset with the
command sntp offset.
Mgmt Class
All (R/W)
Input Format
time <hh:mm:ss>
Parameters
Chapter 2: Status Commands
***
<hh>
<mm>
<ss>
a
Integer, 1 - 23
b
Integer, 0 - 59
Response
When entered with no parameters:
-> time
BootTime: 5/18/2001 at 11:57:12
Current time: 5/18/2001 at 12:00:01
When entered with parameters:
-> time 1:01:01
Time set to UTC-420, 5/18/2001 at 1:01:01.074
Time adjusted for (-) 0 days 11 hours 49 minutes 34 seconds
When entered with no parameters, current time and date is
displayed.
a
b
b
Hour parameter.
Minute parameter.
Second parameter.
Efficient Networks
®
Page 2-29
Page 60
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
traceroute
Traces the route taken by packets sent from the local router to the specified IP
address or domain name. A packet is sent for each hop in the rout e. The output lists
the IP addresses of the hops that returned packets.
Unless the -n option is specifi ed, traceroute also at tempts t o look up the name of each
gateway in the route. If the DNS lookup is successful, the name is incl uded in the
output message.
NOTE:
To terminate the traceroute before it ends, press control-c.
Number of packets sent.
Wait period between packets in seconds.
Packet data length in bytes.
Packet data length in bytes. Same as -s.
d
Source IP address contained in t he echo message. Use th is option
to force packets into a tunnel or to force use of the mana gement address as the source address.
Eliminates the DNS lookup for each hop. Only the IP address of the
hop is listed in the output message.
Remote node to which the echo message is sent. It can be specified
by its domain name or by its IP address.
e
Response
The following are application examples of the tr aceroute command and their
responses.
Page 2-30Efficient Networks
®
Page 61
Efficient Networks® Router family
Command Line Interface Guide
Example
The following two commands trace the same route. The first specifies the domain
name; the second specifies the IP address.
-> traceroute www.yahoo.com
-> traceroute 204.71.200.68
Both commands send up to thirty packets with a wait period of one second and a
packet length of 56 bytes. The following is an example of the command output:
Chapter 2: Status CommandsEfficient Networks® Router family
Command Line Interface Guide
vers
Displays the software version level, source, software options, and amount of time
elapsed since router has been running.
All software options are listed.
•If the option has no prefix, the option was enabled when the router was
manufactured.
•If the option has a + prefix, the option was enabled using a key.
•If the option has a ~ prefix, the option is disabled in this router.
For more information, refer to the Technical Reference Guide and see ”Key Enabled
Features” on page 4-29.
Mgmt Class
All (R)
Input Format
vers
Parameters
None
Response
Typical response:
-> vers
Efficient 5950 G.SHDSL [ATM] Router (5950-001)
Efficient-5000 BOOT/POST V5.9.0 (25-Apr-00 16:19)
Software version v6.0.0 built Wed Jan 29 09:30:26 PDT 2002
Maximum users: unlimited
Options: SDSL, RFC1483, ipstack, ipcheck, ipfilter, WEB, ~HW-DES,
+ipsec, +3DES, ~l2tp, ~des, ~QoS, ~firewall, ~HWcrypt, ~radius,
+sshd, BRIDGE, IPX, DIAL-BACKUP, VRRP, ~IntModem
Up for 49 days 19 hours 57 minutes (started 12/20/2001 at 17:11)
Page 2-32Efficient Networks
®
Page 63
Efficient Networks® Router family
Command Line Interface Guide
The file system commands allow you to perform maintenance and recovery on the
device. These commands allow you to:
•Format the file system
•List the contents of the file system
•Copy, rename, and delete files
The router file system is DOS-compati ble, and the file system commands are similar
to the DOS commands of the same name.
Chapter 3: File System Commands
CHAPTER 3
CHAPTER 3 FILE SYSTEM COMMANDS
The file system commands found in this section include:
Table 3-1: File System Command Listing
CommandFunction
copy
deleteDeletes the specified fi le from the flash filesystem.
dirDisplays the directory of the file system. The size
Copies a file from the source to the destination.
of each file is liste d in by te s .
executeThis command loads batch files of configuration
commands into the router.
format diskErases and reformats the device file system.
msfsChecks and reports the structure of the file system.
renameRenames a file in the file system.
syncCommits the changes made to the file system to
FLASH memory.
Efficient Networks
®
Page 3-1
Page 64
Chapter 3: File System CommandsEfficient Networks® Router family
Command Line Interface Guide
copy
Copies a file from the source to the destination. This command allows you to update
the device software level or to write configuration files to a TFTP server
Issue a sync command after a copy command to commit the changes to FLASH
memory.
CAUTION:
No warning message is issued if copying over an existing file.
Mgmt Class
All (R/W)
Input Format
copy <srcfile> <dstfile>
Parameters
<srcfile>
<dstfile>
A local filename is in the format: name.ext.
A remotely accessed filename is specified as: tftp@serveraddr:filename.ext. The
TFTP server address is optional. If the TFTP server addr ess is not specified, the
address used is either the one from which the router booted or the one per mane ntly
configured in the boot system.
To force use of a specif ic sou rce address when copying a file from a TFTP server, use
this format: tftp@serveraddr-sourceaddr:filename.ext
Examples
The following command copies the file KERNELNW on TFTP server 128.1.210.66 to
the local file KERNEL.F2K.
-> copy tftp@128.1.210.66:kernelnw kernel.f2k
Copying...
421888 bytes copied
Filename of the source file to be copied.It can be either the name of a local
file or a file accessed remotely via a TFTP server.
Destination filename to which the file is copied.
The following command uses the source address 192.168.1.2 when copying the file
KERNELNW on TFTP server 192.168.100.100 to the local file KERNEL.F2K.
Efficient Networks® Router family
Command Line Interface Guide
Response
Refer to examples for typical responses.
delete
Deletes the specified file from the flash filesystem.
Mgmt Class
Admin (R/W), System (R/W)
Input Format
delete <filename>
Parameters
Chapter 3: File System Commands
<filename>
a
ASCII string
Response
A typical response is shown below.
-> delete kernel.f2k
kernel.f2k deleted
a
Name of the file to be deleted.
Efficient Networks
®
Page 3-3
Page 66
Chapter 3: File System CommandsEfficient Networks® Router family
Command Line Interface Guide
dir
Displays the directory of the file syst em. The size of each file is listed in bytes.
Mgmt Class
Admin (R/W), System (R/W)
Input Format
dir
Parameters
None
Response
A typical response is shown below.
-> dir
KEYFILE DAT 768
SYSTEM CNF 2816
ATOM DAT 44
DHCP DAT 1024
SDSL DAT 32
FILTER DAT 1284
KERNEL F2K 682018
ASIC AIC 15091
DSP DAT 24
Page 3-4Efficient Networks
®
Page 67
Efficient Networks® Router family
Command Line Interface Guide
execute
This command loads batch files of configuration commands into the router. This
allows for customization and simpler i nst allatio n of the devi ce. A scri pt fil e can cont ain
commands, comments (lines introduced by the # or ; characters), and blank lines.
There are two kinds of script files:
•A one-time script that is execute d on startup (only once).
•A group of commands that can be executed at any time from the Command
Line Interface with the
One-time scripts are useful to execut e the complete configuration process from a
default (unconfigured) st ate.
Mgmt Class
All (R/W)
Chapter 3: File System Commands
execute <filename> command.
Input Format
execute <filename>
Parameters
<filename>
a
ASCII string
Response
Command prompt.
a
Name of the file to be executed.
Efficient Networks
®
Page 3-5
Page 68
Chapter 3: File System CommandsEfficient Networks® Router family
Command Line Interface Guide
format disk
Erases and reformats the device file system. This command should only be used
when the file system is unusable. If the device does not execute the POST test and
software boot successful ly, and the result of the dir command indicates t he file system
is corrupted, you may wish to reformat the disk, reboot the device, and recopy the
system software.
Mgmt Class
System (R/W), Debug (R/W)
Input Format
format disk
Parameters
None
Response
The following is an example of the format disk command.
-> format disk
NEWFS: erasing disk..
NEWFS: fs is 381k and will have 762 sectors
NEWFS: 128 directory slots in 8 sectors
NEWFS: 747 fat entries in 3 sectors
NEWFS: writing boot block...done.
NEWFS: writing fat tables...done.
NEWFS: writing directory...done.
Filesystem formatted!
Page 3-6Efficient Networks
®
Page 69
Efficient Networks® Router family
Command Line Interface Guide
msfs
Checks the structure of the file system. This command perf o rms a function similar to
the DOS chkdsk command. The router analyzes the File Allocation Table (FAT) and
produces a file system status repor t.
CAUTION:
When you specify <fix>, make sure that no other operation is being performed on the
configuration files at the same time by another user .
Mgmt Class
System (R/W), Debug (R/W)
Input Format
msfs <fix>
Chapter 3: File System Commands
Parameters
<fix>
a
This option shou ld onl y be used w hen an ms fs co mman d resu lts in a rec omme ndatio n to ap ply t he
fix option.
Response
The following is an example of a typical response without the fix parameter.
Optional - If fix is specified, errors are corrected in the FAT.
SYSTEMCNF ... 2304 bytes .. ok.
ATM25DAT ... 20 bytes .. ok.
DHCPDAT ... 1536 bytes .. ok.
KERNELF2K ... 257014 bytes .. ok.
IDL_7AIC ... 14828bytes .. ok.
ASICAIC ... 14828 bytes .. ok.
FILTERDAT ... 1284 bytes .. ok.
1097 fat(s) used, 0 fat(s) unused, 0 fat(s) unref, 534 fat(s) free
561664 bytes used by files, 9728 bytes by tables, 273408 bytes free
a
Efficient Networks
®
Page 3-7
Page 70
Chapter 3: File System CommandsEfficient Networks® Router family
Command Line Interface Guide
rename
Renames a file in the file system.
Mgmt Class
All (R/W)
Input Format
rename <oldname> <newname>
Parameters
Response
sync
Mgmt Class
Input Format
<oldname>
<newname>
a
ASCII string
a
a
Existing name of the file.
New name of the file.
The following is an example rename command.
-> rename ether.dat oldeth.dat
‘ether.dat’ renamed to ‘oldeth.dat’
Commits the changes made to the file system to FLASH memory.
All (R/W)
sync
Parameters
None
Response
-> sync
Syncing file systems...done.
Page 3-8Efficient Networks
®
Page 71
Efficient Networks® Router family
Command Line Interface Guide
All commands in this section begin with the word system. The commands set basic
router configuration information, such as the following:
•name of the router
•optional system message
•authentication password
•security authentication protocol
Chapter 4: System Commands
CHAPTER 4
CHAPTER 4 SYSTEM COMMANDS
•management security
•system administration password
•IP address translation
•NAT configuration
•host mapping
•WAN-to-WAN forwarding
•filters
•Dial Backup configuration
•SNTP parameters
The system commands found in this section include:
Table 4-1: System Command Listing
CommandFunction
system ?
system addbootpserverAdds an address to the BootP server list.
Lists the supported keywords.
system addhostmappingRemaps a range of local-LAN IP addresses to a
Efficient Networks
range of public IP addresses on a s ystem-wide basis.
®
Page 4-1
Page 72
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
Table 4-1: System Command Listing (Cont.)
CommandFunction
system addhttpfilterEnables blocking all devices except those within
the defined IP address ran ge from using t he HTTP
protocol
system addiproutingtableDefines a new virtual routing table.
system addserverConfigures a local IP address as the selected serv-
er on the LAN (FTP, SMTP , etc.) for the global configuration.
system addsnmpfilterValidates SNMP clients by defining a range of IP
addresses that are allowed to access the router vi a
SNMP.
system addsyslogfilterLimits the Syslog server addr esses that may be re-
turned by DHCP.
system addsyslogserverAdds an address to the list of Syslog servers.
system addtelnetfilterValidates Telnet clients by defining a range of IP
addresses that are allowed to access the router vi a
Telnet.
system addudprelayCreate a UDP port range for packet forwarding.
system authenForces the target router authentication protocol
that is used for security negotiat ion with the remote
routers when the local side authentication is set.
system backup addAdds an IP address to the list of addresses to be
pinged for the Dial Backup option.
system backup deleteDeletes an IP address from the list of addresses to
be pinged for the Dial Backup option.
system backup disableDisables the Dial Backup option i n the rout er.
system backup enableEnables the Dial Backup option in the router.
system backup pingintervalChanges the ping interval for a group, that is, the
number of seconds between pings duri ng a test of
the addresses in the group.
system backup pingsamplesChanges the number of ping samples for a group,
that is, the number of pings performed for eac h address in the group.
system backup retryChanges the Dial Backup retry period.
system backup stabilityChanges the Dial Backup stability period.
Page 4-2Efficient Networks
®
Page 73
Efficient Networks® Router family
Command Line Interface Guide
Table 4-1: System Command Listing (Cont.)
CommandFunction
Chapter 4: System Commands
system backup successrate
Changes the minimum success ra te requir ed for a
group of pinged addresses.
system blocknetbiosdefaultSets the default value used when a remote router
entry is defined.
system communityEnables changing the SNMP community name
from its default value.
system default modemLists the default modem settings.
system delbootpserverRemoves an address from the BootP server list.
system delhostmappingUndoes an IP address/host translation (remap-
ping) range
system delhttpfilterDeletes an http address filter.
system deliproutingtableDeletes a range of addresses that reference a vir-
tual routing table or deletes the entire virtual routing table.
system delserverDeletes an server entry.
system delsnmpfilterDeletes the SNMP client range.
system delsyslogfilterRenames a file in the file system.
system delsyslogserverDeletes the Syslog address filter.
system delte lnetfilterDeletes the Telnet client range.
system deludprelayDeletes the UDP port range.
system historyDisplays the router’s most recent console log.
system httpportManages the system HTTP port access.
system listLists the system settings for the target router.
system logAllows logging of the device’s activity in a Telnet
session.
system modemChanges the selected modem setting.
system moveiproutingtableMoves a range of IP addresses to another virtual
routing table.
system msgSets or changes the message saved in the local
router you are configuring.
Efficient Networks
®
Page 4-3
Page 74
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
Table 4-1: System Command Listing (Cont.)
CommandFunction
system nameSets or changes the name of the local router being
configured.
system onewandialupCan force the router to have no more than one re-
mote connection active at a time.
system passwdSets the system authentication password for the
target router that is used when the router connects
to other routers or is challenged by them.
system riptimerSets the duration for RIP information to be ex-
changed with remote routers.
system securemode listDisplays the current secure mode configuration
values and the number of concurrent Telnet and
SSH sessions allowed.
system securemode setEnables and disables the secure mode function.
system securemode set cliSets the number of concurrent Telnet and SSH
sessions the system will allow.
system securemode set lanAllows discrete control of the secure mode fo r the
LAN interface.
system securemode set wanAllows discrete control of the secure mode for the
WAN interface.
system securitytimerAllows the user to change the 10-minute default
security tim e r to a n other value.
system selnat addpolicyAdds a Selective NAT policy.
system selnat delpolicyDeletes a Selective NAT policy.
system selnat listLists the current Selective NAT policies.
system snmpport
system sshportManages SSH port access.
system supporttraceProvides the abil ity to capture all configuration dat a
Manages SNMP port access.
to a file for troubleshooting.
system syslogportManages Syslog port access.
system telnetportManages the built-in Telnet server port access.
system wan2wanforwardingAllows management of WAN-to-WAN forwarding
of data from one WAN link to another.
Page 4-4Efficient Networks
®
Page 75
Efficient Networks® Router family
Command Line Interface Guide
system ?
Lists the supported keywords. To see the syntax for a command, enter the command
followed by a ?.
Mgmt Class
All (R)
Input Format
system ?
Parameters
None
Response
Chapter 4: System Commands
A listing of all the supported system commands and keywords with a bri ef desc ription
of their function.
system addbootpserver
Adds an address to the BootP server list. (The BootP server list is also the DHCP
relay list.)
While the BootP server list has at least one address, the router disables its own
DHCP server and, instead, forwards al l DHCP/BootP request s to all servers in the list.
It forwards every reply received from any of the servers in the list to the appropriate
LAN. To read about BootP service, see ”BootP Service” on page 4-15 of the Technical
Reference Guide.
Addresses can also be added to the list using the dhcp addrelay command. To
remove an address from the list, use the dhcp delrelay command.
To see the current BootP server address, enter the command dhcp addrelay or
system addbootpserver with no parameters. To remove a BootPserver address, use
the command dhcp delrelay or system delbootpserver.
Mgmt Class
Network (R/W)
Input Format
system addbootpserver <ipaddr>
Efficient Networks
®
Page 4-5
Page 76
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
Parameters
<ipaddr>
a
Dotted-decimal notation
Response
The following is an example of adding a server address then querying a response.
-> system addbootpserver 128.1.210.64
-> system addbootpserver
BOOTP/DHCP Server address: 128.1.210.64
a
IP address of the server.
Page 4-6Efficient Networks
®
Page 77
Efficient Networks® Router family
Command Line Interface Guide
system addhostmapping
Remaps a range of local-LAN IP addresses to a range of public IP addresses on a
system-wide basis. These local addresses are mapped one-to-one to the public
addresses.
NOTE:
The range of public IP addresses is defined by <first public addr> only. The
rest of the range is computed automatically (from
<first public addr> + number of addresses remapped - 1) inclusive.
Automatic SNTP requests are genera ted if the sy stem needs to get the ti me. You can
specify an SNTP server using the command sntp server and a UTC offset with the
command sntp offset.
Mgmt Class
Network (R/W)
Chapter 4: System Commands
<first public addr> to
Input Format
system addhostmapping <first private addr>
<second private addr> <first public addr>
Parameters
<first private addr>
<second private addr>
<first public addr>
a
Dotted-decimal notation
Response
Command prompt.
a
First IP address in the range of IP addresses to be
remapped.
a
Last address in the range of IP addresses to be
remapped.
a
Last address in the range of IP addresses to be
remapped.
Efficient Networks
®
Page 4-7
Page 78
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system addhttpfilter
Enables blocking all devices except those within the defined IP address range from
using the HTTP protocol (for example, to brows e the Web). This command can block
devices on the W AN from accessi ng the W eb browser. This validation feature is of f by
default.
NOTE:
This command does not require a reboot and is effecti ve immediately.
NOTE:
To list the range of allowed clients, use the command system list when you are logged
in with read and write permission (be sure to log in with password). To delete
addresses from the HTTP filter, use the system delhttpfilter command.
For more information, see ”Controlling Remote Management” on page 5-15 of the
Technical Reference Guide.
Mgmt Class
Security (R/W)
Input Format
system addhttpfilter <first ip addr> [<last ip addr>] | lan
Parameters
<first ipaddr>
<last ipaddr>
lan
a
Dotted-decimal notation
b
May be omitted if the range contains only one IP address.
Response
Command prompt.
a
First IP address in the range.
a
Last address in the range of IP addresses to be remapped.
Local Ethernet LAN.
b
Page 4-8Efficient Networks
®
Page 79
Efficient Networks® Router family
Command Line Interface Guide
system addiproutingtable
Defines a new virtual routing table. Once defined, you can add routes to the table
using the commands eth ip bindroute and remote bindipvirtualroute.
The command specifies the name of the new routing table and the range of IP
addresses that reference the table for their routing. When the router receives a
packet, the source address of the packet determines which routing table is used. For
example, if the range of addresses for the virtual routing table ROSA includes
address 192.168.25.25, then every packet with the source address 192.168.25.25 is
routed using virtual routing table ROSA.
If the source address of a packet is not wit hin the address ranges for any virtual
routing table, the default routing table is referenced to route the packet.
For more information, see ”Virtual Routing Tables” on page 6-2 of the Technical
Reference Guide.
If an IP routing table has been defined, you can see its range of addresses using the
system list command.
Chapter 4: System Commands
Mgmt Class
Network (R/W)
Input Format
system addiproutingtable <first ipaddr> [<last ipaddr>] <tablename>
Parameters
<first ipaddr>
<last ipaddr>
<tablename>
a
Dotted-decimal notation
b
May be omitted if the range contains only one IP address.
c
This parameter may be omitted if th e range conta ins only on e IP address. Th e specifie d address ran ge
may not overlap the address range defined for any other virtual routing table.
a
First IP address in the range.
a
Last IP address in the range of IP addresses to be remapped.
Name of the virtual routing table to which the addresses are as-
signed.
c
b
Efficient Networks
®
Page 4-9
Page 80
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
Response
Example
The following command defines a virtual routing table named ROSA (if it does not
already exist) and assigns it the IP address range 192.168. 1.5 through 192.168.1.12.
-> system addiproutingtable 192.168.1.5 192.168.1.12 ROSA
After routing tab le ROSA has been defined, th e following line appears in the out put for
the command
192.168.1.5 through 192.168.1.12 uses IP Routing Table <ROSA>
system list:
system addserver
This Network Address Translation (NAT) command is used to configure a loc a l IP
address as the selected server on the LAN (FTP, SMTP, etc.) for the global
configuration. To learn more, see ”Network Address Translation (NAT)” on page 4-17
of the Technical Reference Guide.
Multiple system addserver, remote addserver, and eth ip addserver commands can
designate different servers for different protocols, ports, and interfaces. When a
request is received, the r outer searches the server list for the appropriate ser ver. The
order of search for a server is discussed in ”Server Request Hierarchy” on page 4-22
of the Technical Reference Guide.
To delete a server designation, use the system delserver command.
Efficient Networks® Router family
Command Line Interface Guide
Parameters
Chapter 4: System Commands
<action>
<protocol>
<first port>
One of the following command actions:
<ipaddr>
discard
me
a
Selects the host with this IP address as server.
Discards the incoming server request.
Sends the incoming server requests to the local
router, regardless of the IP address.
Protocol used by the selected server.
<protocolid>
tcp
udp
all
b
Numerical protocol ID.
TCP only.
UDP only.
All protocols.
First or only port as seen by th e remote end. Port used by the select ed server.
<portid>
c
Numerical port value; a value of 0 matches any
port.
dns
ftp
h323
http
login
rsh
smtp
snmp
Domain Name Server (DNS) port.
File Transfer Protocol (FTP) port.
H.323 port.
Hypertext Transfer Protocol (HTTP) port .
rlogin port (513).
Remote shell port.
Simple Mail Transfer Protocol (SMTP) port.
Simple Network Management Protocol (SNMP)
port.
t120
telnet
tftp
all
T.120 port.
Telnet port.
Trivial File Transfer Protocol (TFTP) port.
All ports.
<last port>
<first private
port>
a
Dotted-decimal notation
b
Integer
c
Integer, 0 - 65,535
Efficient Networks
Optional last port in the range of port s as seen by the remote end for
the server on the LAN.
c
®
If specified, this is a port remapping of the incoming request s from the
remote end.
Page 4-11
Page 82
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system addsnmpfilter
Validates SNMP clients by defining a range of IP addresses that are allowed to
access the router via SNMP. This validation feature is off by default . This command is
functionally equivalent to the snmp addsnmpfilter command.
NOTE:
This command does not require a reboot and is effecti ve immediately.
NOTE:
To list the range of allowed clients, use the system list command. To delete addresses
from the SNMP filter, use the system delsnmpfilter or snmp delsnmpfilter command.
For more information, see ”Controlling Remote Management” on page 5-15 of the
Technical Reference Guide.
Mgmt Class
Security (R/W)
Input Format
system addsnmpfilter <first ip addr> [<last ip addr>] | lan
Parameters
<first ipaddr>
<last ipaddr>
lan
a
Dotted-decimal notation
b
May be omitted if the range contains only one IP address.
Response
Command prompt.
a
First IP address of the client range.
a
Last IP address of the client range.
Local Ethernet LAN.
b
Page 4-12Efficient Networks
®
Page 83
Efficient Networks® Router family
Command Line Interface Guide
system addsyslogfilter
Limits the Syslog server addresses that may be returned by DHCP. By default, this
validation feature is off.
The Syslog filter can com prise one or more ranges of IP addresses that DHCP may
return for Syslog servers. To delete addresses from the Syslog fi lter, use the system
delsyslogfilter command.
This command does not affe ct the Syslog s erver addr esses that you s pecify expl icitly.
For more information on the route r as a Syslog c lient, s ee ”Syslog Client” on page 7-1
of the Technical Reference Guide.
NOTE:
This command does not require a reboot and is effect ive immediately.
NOTE:
To list the range of allowed clients, use the system li st command.
Chapter 4: System Commands
Mgmt Class
Security (R/W)
Input Format
system addsyslogfilter <firstipaddr> [<last ipaddr>] | lan
Parameters
<first ipaddr>
<last ipaddr>
lan
a
Dotted-decimal notation
b
May be omitted if the range contains only one IP address.
Response
Command prompt.
a
First IP address of the valid server range.
a
Last IP address of the valid server range.
Local Ethernet LAN.
b
Efficient Networks
®
Page 4-13
Page 84
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system addsyslogserver
Adds an address to the list of Syslog servers. The router sends system event
messages to all Syslog servers in the list, unless the Syslog port has been disabled.
For more information about the router as a Syslog client, refer to ”Syslog Client” on
page 7-1 of the Technical Reference Guide.
To see the server addresses, use the system list command. To remove a Syslog
server address from the list, use the system delsyslogserver command.
NOTE:
The new server address becomes effectiv e after performing a save and a reboot.
Mgmt Class
System (R/W)
Input Format
system addsyslogserver <ipaddr>
Parameters
<ipaddr>
a
Dotted-decimal notation
Response
Command prompt.
a
IP address to be added to the Syslog server address list.
Page 4-14Efficient Networks
®
Page 85
Efficient Networks® Router family
Command Line Interface Guide
system addtelnetfilter
V alidates Telnet clients by defining a range of IP addresses that ar e allowed to access
the router via Telnet. The mode is off by default. For more information, refer to
”Controlling Remote Management” on page 5-15 of the Technical Reference Guide.
NOTE:
This command does not require a reboot and is effect ive immediately.
NOTE:
To list the range of all owed client s, u se the system l ist command. To delete addresses
from the Telnet filter, use the system deltelnetfilter command.
Mgmt Class
Security (R/W)
Chapter 4: System Commands
Input Format
system addtelnetfilter <first ip addr> [<last ip addr>] | lan
Parameters
<first ipaddr>
<last ipaddr>
lan
a
Dotted-decimal notation
b
May be omitted if the range contains only one IP address.
Response
Command prompt.
a
First IP address of the client range.
a
Last IP address of the client range.
Local Ethernet LAN.
b
Efficient Networks
®
Page 4-15
Page 86
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system addudprelay
Create a UDP port range for p acket forwa rding. You can specify a port ra nge from 0 to
65535; however, 137 to 139 are reserved for NetBIOS ports.
NOTE:
Overlap of UDP ports is not allowed.
Mgmt Class
Network (R/ W)
Input Format
system addudprelay <ipaddr> <first port>|all [<last port>]
Parameters
<ipaddr>
<first port>
all
<last port>
a
Dotted-decimal notation
b
Integer, see description above for port range.
Response
Command prompt.
a
IP address of the server to which the UDP packet will be forwarded.
b
First port in the UDP port range to be created.
Incorporates all the available UDP ports in the new range.
b
Last port in the UDP port range to be created.
Page 4-16Efficient Networks
®
Page 87
Efficient Networks® Router family
Command Line Interface Guide
system authen
Forces the target router authentication protocol that is used for security negotiation
with the remote routers when the local side aut hentication is set . You should not need
to issue this command as t he best s ecur ity pos sible is pro vid ed with t he none def ault.
To read about PAP/CHAP, see ”PAP/CHAP Security Authentication” on page 5-20 of
the Technical Reference Guide.
Mgmt Class
Security (R/W)
Input Format
system authen none | pap | chap
Parameters
Chapter 4: System Commands
***
none
pap
chap
Response
This following example illustrates setting the authentication level, then displaying the
current setting.
-> system authen chap
-> system authen
Authentication needed.................CHAP
When the command is entered with no p arameters, the cur rent authentication override is displayed.
The authentication protocol is negotiated, wit h the minimum best security level as defined for each remote router in the database.
Negotiation begins with PAP (instead of CHAP) for those entries that
have PAP in the remote database and only when t he c all i s init iated locally.
Overrides all the remote database entries with CHAP, that is, only
CHAP is performed.
Efficient Networks
®
Page 4-17
Page 88
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system backup add
Adds an IP address to the list of addresses to be pinged for the Dial Backup option.
The command can specify an explicit address, or it can request that the router
determine the gateway or DNS address and add that address to the list.
For additional information, see ”Dial Backup” on page 6-7 of the Technical Reference
Guide.
Mgmt Class
Network (R/ W)
Input Format
system backup add <ipaddr> | gw | dns [<group>]
Parameters
<ipaddr>
gw
dns
<group>
a
Dotted-decimal notation
b
integer, 0 - 65535 (0 )
Examples
The following command adds the address 192. 168.1.5 to gr oup 0 of t he addresses t o
be pinged.
-> system backup add 192.168.1.5
The following command adds the gateway address to group 1 of the addresses to be
pinged.
-> system backup add GW 1
Response
a
IP address to be added to the list.
Gateway address. The router determines the actual gateway address.
Domain Name Server address. The router determines the actual DNS
address.
b
Optional number of a group to which the address is assigned.
Command prompt.
Page 4-18Efficient Networks
®
Page 89
Efficient Networks® Router family
Command Line Interface Guide
system backup delete
Deletes an IP address fr om the list of addresses to be pinged for the Dial Backup
option. The command can:
•Specify an explicit address to be deleted.
•Request that the router delete the gateway or DNS address from the list.
•Delete all addresses in a group.
•Clear all addresses from the list.
To see the addresses in the current list, use th e sy stem list command. For more
information, refer to ”Dial Backup” on page 6-7 of the Technical Reference Guide.
Mgmt Class
Network (R/W)
Input Format
Chapter 4: System Commands
system backup delete <ipaddr> | gw | dns | all [<group> | all ]
Parameters
<ipaddr>
gw
dns
all <group>
all
a
Dotted-decimal notation
b
integer, 0 - 65535 (0)
Examples
The following command deletes the address 192.168.1.5 from group 0.
-> system backup delete 192.168.1.5
The following command deletes the gateway address from group 1.
a
IP address to be deleted from the list.
Gateway address. The router determines the actual gateway address.
Domain Name Server address. The router determines the actual DNS
address and deletes it.
b
Optional number of a group to which the specified address or all addresses are deleted.
Requests deletion of all addresses in all groups including group 0.
-> system backup delete GW 1
The following command deletes all addresses from group 2.
-> system backup delete all 2
Efficient Networks
®
Page 4-19
Page 90
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
The following command clears all addresses from the list.
-> system backup delete all all
Response
Command prompt.
system backup disable
Disables the Dial Backup option in the router.
NOTE:
Because Dial Backup uses the console port, you cannot access the command line via
the console port while Dial Backup is enabled. You must use the Web GUI i nterface or
a Telnet session to disable Dial Backup.
NOTE:
If you do not use the save command to save this change, Dial Backup is only
temporarily disabled and it is re-enabl ed at the next reboot . Temporarily disabling Dial
Backup stops Dial Backup, but it does not change the use of the console port . To
disable Dial Backup across reboots, see ”Disabling and Re-Enabling Dial Backup” on
page 6-15 of the Technical Reference Guide.
To re-enable the Dial Backup option, use the system backup enable command. For
more information about Dial Backup, refer to ”Dial Backup” on page 6-7 of the
Technical Reference Guide.
Mgmt Class
Network (R/ W)
Input Format
system backup disable
Parameters
None
Response
Command prompt.
Page 4-20Efficient Networks
®
Page 91
Efficient Networks® Router family
Command Line Interface Guide
system backup enable
Turns on the enable s wit ch for t he Dial Backup opt ion i n the rout er. To see the current
setting of the Dial Backup switch, use the system list command. To disable Dial
Backup, use the system backup disable command. For more inform ation, see ”Dial
Backup” on page 6-7 of the Technical Reference Guide.
NOTE:
Dial Backup cannot be enabled unless the remote containing its dialup parameters is
also enabled. (Check this using the remote list command).
Mgmt Class
Network (R/W)
Input Format
system backup enable
Chapter 4: System Commands
Parameters
None
Response
Command prompt.
Efficient Networks
®
Page 4-21
Page 92
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system backup pinginterval
Changes the ping interval for a group, that is, the number of seconds between pings
during a test of the addresses in the group.
To see the current ping intervals, use t he system list command. For more information
about the ping interval and Dial Backup, see ”Ping Interval, Number of Samples, and
Success Rate” on page 6-13 of the Technical Reference Guide.
NOTE:
If you change the ping interval to 0, the group of addresses is disab led.
Mgmt Class
Network (R/ W)
Input Format
system backup pinginterval <seconds> [<group>]
Parameters
<seconds>
<group>
a
Integer
b
integer, 0 - 65535 (0 )
Examples
The following command changes the ping interval to 10 seconds for group 0.
-> system backup pinginterval 10
The following command disables the pinging of addresses in group 1.
-> system backup pinginterval 0 1
Response
Command prompt.
a
Number of seconds in the ping interval for the gr oup.
b
Optional, number of a group.
Page 4-22Efficient Networks
®
Page 93
Efficient Networks® Router family
Command Line Interface Guide
system backup pingsamples
Changes the number of ping samples for a group, that is, the number of pings
performed for each address in the group.
To see the current ping sample values, use the system list command. For more
information about ping samples and Dial Backup, see ”Addresses to Ping” on page 6-
12 of the Technical Reference Guide.
NOTE:
If you change the ping samples value to 0, you disable pinging for that group of
addresses.
Mgmt Class
Network (R/W)
Input Format
Chapter 4: System Commands
system backup pingsamples <samples> [<group>]
Parameters
<samples>
<group>
a
Integer, (6)
b
integer, 0 - 65535 (0)
Examples
The following command changes the number of ping samples to 10 for addresses in
group 0.
-> system backup pingsamples 10
The following command disables the pinging of addresses in group 1.
-> system backup pingsamples 0 1
Response
Command prompt.
a
Number of times the addresses in the group are pinged.
b
Optional, number of a group.
Efficient Networks
®
Page 4-23
Page 94
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system backup retry
Changes the Dial Backup retry period. The retry period determines how often the
router attempts to restore the DSL link . For more information about the Dial Backup
retry period, see ”Setting DSL Link Conditions” on page 6-11 of the Technical
Reference Guide.
The default retry period is thirty minutes. The minimum retry period is two minutes. To
see the current retry value, use the system li st command.
NOTE:
When the Dial Backup retry timer expires , the modem i s d isconnected ev en i f ther e is
traffic on the modem.
Mgmt Class
Network (R/ W)
Input Format
system backup retry <minutes>
Parameters
<minutes>
a
Integer, 2 - 60 (20)
Examples
The following command changes the retry period to 60 minutes.
-> system backup retry 60
The following command changes the retry period to 2.
-> system backup retry 1
Response
Command prompt.
a
Number of minutes in the retry period.
Page 4-24Efficient Networks
®
Page 95
Efficient Networks® Router family
Command Line Interface Guide
system backup stability
Changes the Dial Backup st abil ity period. Th e st abi lity period guards against f requent
switching back and forth between the DSL link and the backup port. For more
information about the Dial Bac kup stability period, see ”Stability Period” on page 6-11
of the Technical Reference Guide.
To see the current stability value, use the system list command.
Mgmt Class
Network (R/W)
Input Format
system backup stability <minutes>
Parameters
Chapter 4: System Commands
<minutes>
a
Integer, 1 - 60 (3)
a
Number of minutes in the stability period.
Examples
The following command changes the stability period to 5 minutes.
-> system backup stability 5
Response
Command prompt.
system backup successrate
Changes the minimum success rate required for a group of pinged addresses . If the
success rate is less than the minimum, the DSL link is assumed to have failed and a
switchover to the backup is performed.
NOTE:
If you change the success rate to 0, you disable pinging for that group of addresses.
NOTE:
A minimum success rate of 100% is not recommended; this would require a reply
from every ping sent.
Efficient Networks
®
Page 4-25
Page 96
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
To see the current success rate values, use the system list command. For more
information about success rates and Dial Backup, see ”Ping Interval, Number of
Samples, and Success Rate” on page 6-13 of the Technical Reference Guide.
Mgmt Class
Network (R/ W)
Input Format
system backup successrate <percentage> [<group>]
Parameters
<percentage>
a
Minimum success rate required during a ping test of the addresses in
the group.
<minutes>
a
Integer, 0 - 99 (50)
b
Integer, 0 - 65535 (0)
b
Optional, number of a group.
Examples
The following command changes the success rate to 75% for addresses in group 0.
-> system backup successrate 75
The following command disables the pinging of addresses in group 1.
-> system backup successrate 0 1
Response
Command prompt.
system blocknetbiosdefault
The router can block all NetBIOS and NetBUI requests fr om being sent over the
WAN. This command sets the default value used when a remote router entry is
defined.
The command remote blocknetbios can change the NetBIOS setting for a specific
remote router. To see the current NetBIOS default, use the system list command.
Mgmt Class
Security (R/W)
Page 4-26Efficient Networks
®
Page 97
Efficient Networks® Router family
Command Line Interface Guide
Input Format
system blocknetbiosdefault yes | no
Parameters
Chapter 4: System Commands
yes
no
Sets the default to block all NetBIOS and NetBUI requests.
Sets the default to not block all NetBIOS and NetBUI requests.
Examples
The following command will block all NetBIOS and Net B UI requests
-> system blocknetbiosdefault yes
Response
Command prompt.
system community
Enhances SNMP security by allowing the user to change the SNMP community name
from its default value of “public” to a different value. Refer to ”SNMP” on page 7-2 of
the Technical Reference Guide for additional informat ion.
NOTE:
This command is functionally equivalen t to the snmp community command.
Mgmt Class
Security (R/W)
Input Format
system community [<snmp community name>]
Parameters
***
<snmp community name>
a
ASCII string, 40 characters maximum
Efficient Networks
When entered with no parameter the curr ent community
name is displayed.
a
SNMP community name to which device is added.
®
Page 4-27
Page 98
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
Response
The following response is given when the system com munity is changed to ’fred’:
-> system community fred
The community name fred will take effect at the next reboot
system default modem
Lists the default modem settings. The modem setti ngs are for the backup V.90
modem connected to the console port.
To change the modem settings, use the command system modem. For more
information on the Dial Backup option, refer to ”Dial Backup” on page 6-7 of the
Technical Reference Guide.
Mgmt Class
Network (R/ W)
Input Format
system defaultmodem
Parameters
None
Response
Command prompt.
system delbootpserver
Removes an address from the BootP server list. (The BootP server list is also the
DHCP relay list.)
Addresses can also be removed from the list using the command dhcp delrelay. To
add an address to the list, use the dhcp addrelay command.
Mgmt Class
Network (R/ W)
Input Format
system delbootpserver <ipaddr> | all
Page 4-28Efficient Networks
®
Page 99
Efficient Networks® Router family
Command Line Interface Guide
Parameters
Chapter 4: System Commands
<ipaddr>
a
IP address of the server to be deleted from the BootP server
list.
all
a
Dotted-decimal notation
Removes all addresses from the BootP server list.
Examples
The following command will remove only the address 128.1.210. 64 from the bootP
server list.
-> system delbootpserver 128.1.210.64
The following command will remove all addresses from the bootP server list.
-> system delbootpserver all
Response
Command prompt.
system delhostmapping
Undoes an IP address/host translation (rema pping) range that was previously
established with the command remote addhostmapping on a per-system-wide basis.
Mgmt Class
Network (R/W)
Input Format
system delhostmapping <first private addr> <second private
addr> <first public addr>
Parameters
<first private addr>
<second private addr>
<first public addr>
a
Dotted-decimal notation
b
The rest of the range is computed automatically.
Response
a
First IP address in the range of IP address.
a
Last IP address in the range of IP address.
a
Defines the range of public IP addresses.
b
Command prompt.
Efficient Networks
®
Page 4-29
Page 100
Chapter 4: System CommandsEfficient Networks® Router family
Command Line Interface Guide
system delhttpfilter
Deletes an http address filter created by the system addhttpfilter command. To see
the address range of the filter, use the system list command.
Mgmt Class
Security (R/W)
Input Format
system delhttpfilter <first ip addr> [<last ip addr>] | lan
Parameters
<first ipaddr>
<last ipaddr>
lan
a
Dotted-decimal notation
b
May be omitted if the range contains only one IP address.
a
a
Response
Command prompt.
system deliproutingtable
Deletes a range of addresses that reference a virtual routing table or deletes the
entire virtual routing tabl e. To list the virtual routing tabl es, use the iproutes command.
For more information, see ”Vir tual Routing Tables” on page 6-2 of the Technical
Reference Guide.
Mgmt Class
Network (R/ W)
First IP address of the range.
Last IP address of the range.
b
Local Ethernet LAN.
Input Format
system addiproutingtable <first ip addr> [<last ip addr>]
<tablename>
Page 4-30Efficient Networks
®
Loading...
+ hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.