Any brand names and product names included in this manual are trademarks, registered trademarks,
service marks, or trade names of their respective holders.
To the Holder of this Manual
The contents of this manual are current as of the date of publication. ADTRAN reserves the right to change
the contents without prior notice.
In no event will ADTRAN be liable for any special, incidental, or consequential damages or for
commercial losses even if ADTRAN has been advised thereof as a result of issue of this publication.
Software Licensing Agreement
Each ADTRAN product contains a single license for ADTRAN supplied software. Pursuant to the
Licensing Agreement, you may: (a) use the software on the purchased ADTRAN device only and (b) keep
a copy of the software for backup purposes. This Agreement covers all software installed on the system as
well as any software available on the ADTRAN website. In addition, certain ADTRAN systems may
contain additional conditions for obtaining software upgrades.
Conventions
Notes provide additional useful information.
Cautions signify information that could prevent service interruption or damage to the
equipment.
Warnings provide information that could prevent endangerment to human life.
ADTRAN will repair and return this product within the warranty period if it does not meet its published
specifications or fails while in service. Warranty information can be found at www.adtran.com
. (Click on
Warranty and Repair Information under Support.)
Product Registration
Registering your product helps ensure complete customer satisfaction. Please take time to register your
products on line at www.adtran.com
. Click Service/Support and then on Product Registration under
Support.
Product Support Information
A return material authorization (RMA) is required prior to returning equipment to ADTRAN. For service,
RMA requests, training, or more information, use the contact information given below.
Repair and Return
If you determine that a repair is needed, please contact our Customer and Product Service (CaPS)
department to have an RMA number issued. CaPS should also be contacted to obtain information
regarding equipment currently in house or possible fees associated with repair.
CaPS Department(256) 963-8722
Identify the RMA number clearly on the package (below the address), and return to the following address:
ADTRAN Customer and Product Service
901 Explorer Blvd. (East Tower)
Huntsville, Alabama 35806
Your reseller should serve as the first point of contact for support. If additional pre-sales support is needed,
the ADTRAN Support website provides a variety of support services such as a searchable knowledge base,
latest product documentation, application briefs, case studies, and a link to submit a question to an
Applications Engineer. All of this, and more, is available at:
http://support.adtran.com
When needed, further pre-sales assistance is available by calling our Applications Engineering
Department.
Applications Engineering(800) 615-1176
Post-Sales Support
Your reseller should serve as the first point of contact for support. If additional support is needed, the
ADTRAN Support website provides a variety of support services such as a searchable knowledge base,
updated firmware releases, latest product documentation, service request ticket generation and
trouble-shooting tools. All of this, and more, is available at:
http://support.adtran.com
When needed, further post-sales assistance is available by calling our Technical Support Center. Please
have your unit serial number available when you call.
Technical Support(888) 4ADTRAN
International Technical Support 1-256-963-8716
Installation and Maintenance Support
The ADTRAN Custom Extended Services (ACES) program offers multiple types and levels of installation
and maintenance services which allow you to choose the kind of assistance you need. This support is
available at:
The Enterprise Network (EN) Technical Training Department offers training on our most popular products.
These courses include overviews on product features and functions while covering applications of
ADTRAN's product lines. ADTRAN provides a variety of training options, including customized training
and courses taught at our facilities or at your site. For more information about training, please contact your
Territory Manager or the Enterprise Training Coordinator.
Training Phone(800) 615-1176, ext. 7500
Training Fax(256) 963-6700
Training Emailtraining@adtran.com
Export Statement
An Export License is required if an ADTRAN product is sold to a Government Entity outside of the EU+8
(Austria, Australia, Belgium, Czech Republic, Denmark, Finland, France, Germany, Greece, Hungary,
Ireland, Italy, Japan, Luxembourg, Netherlands, New Zealand, Norway, Poland, Portugal, Spain, Sweden,
Switzerland and the United Kingdom). This requirement is per DOC/BIS ruling G030477 issued 6/6/03.
This product also requires that the Exporter of Record file a semi-annual report with the BXA detailing the
information per EAR 740.17(5)(e)(2).
DOC - Department of Commerce
BIS - Bureau of Industry and Security
BXA - Bureau of Export Administration
If you are new to the ADTRAN Operating System’s (AOS) Command Line Interface (CLI), take a few
moments to review the information provided in the section which follows (CLI Introduction).
If you are already familiar with the CLI and you need information on a specific command or group of
commands, proceed to Command Descriptions on page 13 of this guide.
CLI INTRODUCTION
This portion of the Command Reference Guide is designed to introduce you to the basic concepts and
strategies associated with using the AOS CLI.
Accessing the CLI from your PC
All products using the AOS are initially accessed by connecting a VT100 terminal (or terminal emulator)
CONSOLE port located on the rear panel of the unit using a standard DB-9 (male) to DB-9 (female)
to the
serial cable. Configure the VT100 terminal or terminal emulation software to the following settings:
•9600 baud
•8 data bits
•No parity
•1 stop bit
•No flow control
For more details on connecting to your unit, refer to the Quick Configuration Guides and
Quick Start Guides located on the ADTRAN OS Documentation CD provided with your
unit.
Understanding Command Security Levels
The ADTRAN CLI has two command security levels — Basic and Enable. Both levels support a specific
set of commands. For example, all interface configuration commands are accessible only through the
Enable security level. The following table contains a brief description of each level.
To prevent unauthorized users from accessing the configuration functions of your AOS
product, immediately install an Enable-level password. Refer to the Quick Configuration
Guides and Quick Start Guides located on the ADTRAN OS Documentation CD provided
with your unit for more information on configuring a password.
Understanding Configuration Modes
The ADTRAN CLI has four configuration modes to organize the configuration commands – Global, Line,
Router, and Interface. Each configuration mode supports a set of commands specific to the configurable
parameters for the mode. For example, all Frame Relay configuration commands are accessible only
through the interface configuration mode (for the virtual Frame Relay interface). The following table
contains a brief description of each level.
ModeAccess by...Sample Prompt With this mode you
can...
Globalentering
command security level prompt.
For example:
>enable
#config term
Linespecifying a line (console or Telnet)
while at the Global Configuration mode
prompt.
For example:
>enable
#config term
(config)#line console 0
Routerentering
while at the Global Configuration mode
prompt.
For example:
>enable
#config term
(config)#
•Obtain syntax help for a specific command by entering the command, a space, and
then a question mark (?). The ADTRAN CLI displays the range of values and a brief
description of the next parameter expected for that particular command. For
example:
(config-eth 0/1)#mtu ?
<64-1500> - MTU (bytes)
Jump to the beginning of the displayed command line. This shortcut is helpful when using
the
no
following prompt will place the cursor directly after the
(config-eth 0/1)#ip address 192.33.55.6
ip d?
form of commands (when available). For example, pressing
entering
configuration parameters for the specified T1 interface. Entering
work as well, but is not necessary.
feature:
int t1 1/1
(Press
at the Global configuration prompt provides you access to the
6
:
<Ctrl + U>
here)
interface t1 1/1
<Ctrl + E>
at the
would
Performing Common CLI Functions
The following table contains descriptions of common CLI commands.
CommandDescription
do
The do command provides a way to execute commands in
other command sets without taking the time to exit the
current and enter the desired one. The following example
shows the
interface configuration while currently in the T1 interface
command set:
do
command used to view the Frame Relay
(config)#interface t1 1/1
(config-t1 1/1)#do show interfaces fr 7
To undo an issued command or to disable a feature, enter
no
before the command.
For example:
no shutdown t1 1/1
When you are ready to save the changes made to the
configuration, enter this command. This copies your
changes to the unit’s nonvolatile random access memory
(NVRAM). Once the save is complete, the changes are
retained even if the unit is shut down or suffers a power
outage.
Displays the current configuration.
Command Reference GuidePerforming Common CLI Functions
CommandDescription
debug
undebug all
Use the
may be experiencing on your network. These commands
provide additional information to help you better interpret
possible problems. For information on specific debug
commands, refer to the section
Set on page 24
To turn off any active debug commands, enter this
command.
debug
command to troubleshoot problems you
Enable Mode Command
.
The overhead associated with the debug command takes up a large portion of your AOS
product’s resources and at times can halt other processes. It is best to only use the debug
command during times when the network resources are in low demand (non-peak hours,
weekends, etc.).
The following table lists and defines some of the more common error messages given in the CLI.
MessageHelpful Hints
%Ambiguous command
%Unrecognized Command
%Invalid or incomplete
command
%Invalid input detected at “^"
marker
The command may not be valid in the current command mode, or you may
not have entered enough correct characters for the command to be
?
recognized. Try using the
CLI Shortcuts on page 9
The command may not be valid in the current command mode, or you may
not have entered all of the pertinent information required to make the
command valid. Try using the
Using CLI Shortcuts on page 9
The error in command entry is located where the caret (^) mark appears.
Enter a question mark at the prompt. The system will display a list of
applicable commands or will give syntax information for the entry.
This portion of the guide provides a detailed listing of all available commands for the ADTRAN OS CLI
(organized by command set). Each command listing contains pertinent information including the default
value, a description of all sub-command parameters, functional notes for using the command, and a brief
technology review. To search for a particular command alphabetically, use the Index. To
search for information on a group of commands within a particular command set, use the linked references
given below:
Basic Mode Command Set on page 14
Enable Mode Command Set on page 24
Global Configuration Mode Command Set on page 257
DHCP Pool Command Set on page 448
HDLC Command Set on page 466
IKE Policy Attributes Command Set on page 554
IKE Client Command Set on page 519
Crypto Map IKE Command Set on page 523
Radius Group Command Set on page 532
CA Profile Configuration Command Set on page 534
Certificate Configuration Command Set on page 545
Ethernet Interface Configuration Command Set on page 549
T1 Interface Configuration Command Set on page 604
DSX-1 Interface Configuration Command Set on page 633
FXS Interface Configuration Command Set on page 618
FDL Interface Configuration Command Set on page 628
Frame Relay Interface Config Command Set on page 643
Frame Relay Sub-Interface Config Command Set on page 663
BGP Configuration Command Set on page 708
BGP Neighbor Configuration Command Set on page 714
Tunnel Configuration Command Set on page 730
PPP Interface Configuration Command Set on page 768
Loopback Interface Configuration Command Set on page 821
Line (Console) Interface Config Command Set on page 851
Line (Telnet) Interface Config Command Set on page 862
Router (RIP) Configuration Command Set on page 869
Router (OSPF) Configuration Command Set on page 878
Quality of Service (QoS) Map Commands on page 892
Voice User Command Set on page 898
AS Path List Command Set on page 928
Codec List Command Set on page 931
Community List Command Set on page 935
Voice Trunk Group Command Set on page 938
Voice Trunk SIP Command Set on page 943
Voice Trunk T1 Wink Command Set on page 952
Voice CoS Command Set on page 967
Voice Ring Group Command Set on page 994
To activate the Basic mode, simply log in to the unit. After connecting the unit to a VT100 terminal (or
terminal emulator) and activating a terminal session, the following prompt displays:
>
The following command is common to multiple command sets and is covered in a centralized section of
this guide. For more information, refer to the section listed below:
exit on page 1014
All other commands for this command set are described in this section in alphabetical order.
Use the enable command (at the Basic Command mode prompt) to enter the Enable Command mode. Use
the disable command to exit the Enable Command mode. Refer to Enable Mode Command Set on page 24
for more information.
Syntax Description
No subcommands.
Default Values
No default value necessary for this command.
Applicable Platforms
This command applies to the NetVanta 300, 1000, 1000R, 2000, 3000, 4000, and 5000 and
Total Access 900 Series units.
Command History
Release 1.1Command was introduced.
Functional Notes
The Enable Command mode provides access to operating and configuration parameters and should be
password protected to prevent unauthorized use. Use the enable password command (found in the
Global Configuration mode) to specify an Enable Command mode password. If the password is set,
access to the Enable Commands (and all other “privileged” commands) is only granted when the correct
password is entered. Refer to
crypto ca authenticate <name> on page 275 for more information.
Usage Examples
The following example enters the Enable Command mode and defines an Enable Command mode
password:
Use the ping command (at the Basic Command mode prompt) to verify IP network connectivity.
Syntax Description
<address>Specifies the IP address of the system to ping. Entering the ping command with
no specified address prompts the user with parameters for a more detailed ping
configuration. Refer to Functional Notes (below) for more information.
Default Values
No default value necessary for this command.
Applicable Platforms
This command applies to the NetVanta 300, 1000, 1000R, 2000, 3000, 4000, and 5000 and
Total Access 900 Series units.
Command History
Release 1.1Command was introduced.Command was introduced.
Functional Notes
The ping command helps diagnose basic IP network connectivity using the Packet InterNet Groper
program to repeatedly bounce Internet Control Message Protocol (ICMP) Echo_Request packets off a
system (using a specified IP address). The AOS allows executing a standard ping request to a specified IP
address or provides a set of prompts to configure a more specific ping configuration.
The following is a list of output messages from the ping command:
!Success
-Destination Host Unreachable
$Invalid Host Address
XTTL Expired in Transit
? Unknown Host
*Request Timed Out
The following is a list of available extended ping fields with descriptions:
Target IP addressSpecifies the IP address of the system to ping.
Repeat CountSpecifies the number of ping packets to send to the system
(valid range: 1 to 1,000,000).
Datagram SizeSpecifies the size (in bytes) of the ping packet (valid range: 1 to 1448).
Timeout in SecondsSpecifies the timeout period after which a ping is considered unsuccessful
(valid range: 1 to 5 seconds).
Extended CommandsSpecifies whether additional commands are desired for more ping
configuration parameters.
Source Address (or interface) Specifies the IP address to use as the source address in the ECHO_REQ
packets.
Data PatternSpecifies an alphanumerical string to use (the ASCII equivalent) as the data
pattern in the ECHO_REQ packets.
Sweep Range of SizesVaries the sizes of the ECHO_REQ packets transmitted.
Sweep Min SizeSpecifies the minimum size of the ECHO_REQ packet
(valid range: 0 to 1448).
Sweep Max SizeSpecifies the maximum size of the ECHO_REQ packet
(valid range: Sweep Min Size to 1448).
Sweep IntervalSpecifies the interval used to determine packet size when performing the
sweep (valid range: 1 to 1448).
Verbose OutputSpecifies an extended results output.
Usage Examples
The following is an example of a successful ping command:
>ping
Target IP address:192.168.0.30
Repeat count[1-1000000]:5
Datagram Size [1-1000000]:100
Timeout in seconds [1-5]:2
Extended Commands? [y or n]:n
Type CTRL+C to abort.
Legend: '!' = Success '?' = Unknown host '$' = Invalid host address
'*' = Request timed out '-' = Destination host unreachable
'x' = TTL expired in transit
Pinging 192.168.0.30 with 100 bytes of data:
!!!!!
Success rate is 100 percent (5/5) round-trip min/avg/max = 19/20.8/25 ms
Use the show clock command to display the system time and date entered using the clock set command.
Refer to the section clock set <time> <day> <month> <year> on page 60 for more information.
Syntax Description
No subcommands.
Default Values
No default value necessary for this command.
Applicable Platforms
This command applies to the NetVanta 300, 1000, 1000R, 2000, 3000, 4000, and 5000 and
Total Access 900 Series units.
Command History
Release 1.1Command was introduced.
Usage Examples
The following example displays the current time and data from the system clock:
Use the show snmp command to display the system Simple Network Management Protocol (SNMP)
parameters and current status of SNMP communications.
Syntax Description
No subcommands.
Default Values
No default value necessary for this command.
Applicable Platforms
This command applies to the NetVanta 300, 1000, 1000R, 2000, 3000, 4000, and 5000 and
Total Access 900 Series units.
Command History
Release 1.1Command was introduced.
Usage Examples
The following is an example output using the show snmp command for a system with SNMP disabled and
the default chassis and contact parameters:
>show snmp
Chassis: Chassis ID
Contact: Customer Service
0 Rx SNMP packets
0 Bad community names
0 Bad community uses
0 Bad versions
0 Silent drops
0 Proxy drops
0 ASN parse errors
Use the show version command to display the current AOS version information.
Syntax Description
No subcommands.
Default Values
No default value necessary for this command.
Applicable Platforms
This command applies to the NetVanta 300, 1000, 1000R, 2000, 3000, 4000, and 5000 and
Total Access 900 Series units.
Command History
Release 1.1Command was introduced.
Usage Examples
The following is a sample show version output:
>show version
AOS version 06.01.00
Checksum: 1F0D5243 built on Fri Nov 08 13:12:06 2002
Upgrade key: de76efcfeb4c8eeb6901188475dd0917
Boot ROM version 03.00.18
Checksum: 7A3D built on: Fri Nov 08 13:12:25 2002
Copyright (c) 1999-2002 ADTRAN Inc.
Serial number C14C6308
UNIT_2 uptime is 0 days 4 hours 59 minutes 43 seconds
System returned to ROM by Warm Start
Current system image file is "030018adv.biz"
Boot system image file is "030018adv.biz"
To activate the Enable mode, enter the enable command at the Basic mode prompt. (If an enable password
has been configured, a password prompt will display.) For example:
>enable
Password: XXXXXXX
#
The following command is common to multiple command sets and is covered in a centralized section of
this guide. For more information, refer to the section listed below:
exit on page 1014
All other commands for this command set are described in this section in alphabetical order.