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 th e 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) T echnical T raining Department offers training on our most po pular 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
This manual provides information about the commands that are available with all of the NetVanta Series
units.
This manual provides information about the commands that are available with NetVanta 5000 Series units.
For a list of all of the commands available through the CLI, see 61950860L1-35L (All Products).
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 14 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.
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.
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.
LevelAccess by...PromptWith this level you can...
Basicbeginning an AOS session.
Enableentering
Basic command security level
as follows:
>enable
enable
while in the
>•display system information
•perform traceroute and ping
functions
•open a Telnet session
#•manage the startup and running
configurations
•use the debug commands
•enter any o f the configuration modes
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 pr ovided
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
•Obtain syntax help for a specific command by entering the co mmand, 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
form of commands (when available). For example, pressing
following prompt will place the cursor directly after the
#
:
<Ctrl + A>
at the
(config-eth 0/1)#ip address 192.33.55.6
<Ctrl + E>
Jump to the end of the displayed command line. For example, pressing
following prompt will place the cursor directly after the
6
:
<Ctrl + E>
at the
(config-eth 0/1)#ip address 192.33.55.6
<Ctrl + U>
Clears the current displayed command line. The following provides an example of the
<Ctrl + U>
(config-eth 0/1)#ip address 192.33.55.6
feature:
(Press
<Ctrl + U>
here)
(config-eth 0/1)#
auto finishYou need only enter enough letters to identify a command as unique. For example,
entering
configuration parameters for the specified T1 interface. Entering
int t1 1/1
at the Global configuration prompt provides you access to the
Command Reference GuidePerforming Common CLI Functions
Performing Common CLI Functions
The following table contains descriptions of common CLI commands.
CommandDescription
do
no
copy running-config startup-config
show running config
debug
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:
(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.
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 36
do
command used to view the Frame Relay
debug
command to troubleshoot problems you
Enable Mode Command
.
undebug all
To turn off any active debug commands, enter this
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 10
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 10
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 at the end of this
document. 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 16
Common Commands on page 26
Enable Mode Command Set on page 36
Global Configuration Mode Command Set on page 281
Line Interface Command Sets
Line (Console) Interface Config Command Set on page 470
Line (SSH) Interface Config Command Set on page 483
Line (Telnet) Interface Config Command Set on page 491
Physical Interface Command Sets
DSX-1 Interface Configuration Command Set on page 500
E1 Interface Configuration Command Set on page 510
Ethernet Interface Configuration Command Set on page 527
G.703 Interface Configuration Command set on page 592
HSSI Interface Configuration Command Set on page 599
T1 Interface Configuration Command Set on page 603
T3 Interface Configuration Command Set on page 620
Virtual Interface Command Sets
Demand Interface Configuration Command Set on page 631
Frame Relay Interface Config Command Set on page 692
Frame Relay Sub-Interface Config Command Set on page 714
HDLC Command Set on page 782
Loopback Interface Configuration Command Set on page 846
PPP Interface Configuration Command Set on page 883
Tunnel Configuration Command Set on page 967
VPN Parameter Command Sets
CA Profile Configuration Command Set on page 1028
Certificate Configuration Command Set on page 1039
Crypto Map IKE Command Set on page 1043
Crypto Map Manual Command Set on page 1052
IKE Client Command Set on page 1063
IKE Policy Attributes Command Set on page 1067
IKE Policy Command Set on page 1073
Routing Protocol Command Sets
AS Path List Command Set on page 1086
BGP Configuration Command Set on page 1089
BGP Neighbor Configuration Command Set on page 1095
Community List Command Set on page 1111
Router (OSPF) Configuration Command Set on page 1114
Router (PIM Sparse) Configuration Command Set on page 1129
Router (RIP) Configuration Command Set on page 1134
Security and Services Command Sets
DHCP Pool Command Set on page 1145
Quality of Service (QoS) Map Commands on page 1163
Radius Group Command Set on page 1169
Route Map Command Set on page 1171
TACACS+ Group Configuration Command Set on page 1191
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 34
All other commands for this command set are described in this section in alphabetical order.
enable on page 17
logout on page 18
ping <address> on page 19
show clock on page 21
show snmp on page 22
show version on page 23
telnet <address> on page 24
traceroute <address> on page 25
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 mo de. Refer to En able Mode Command Set on page 36
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
enable password [md5] <password> on page 335 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 Internet Protocol (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 th e Packet InterNet Groper
program to repeatedly bounce Inter ne t Con tr ol 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 Ho st 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 alphanumeric 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-tri p min /a vg /m ax = 19/2 0. 8/ 25 ms
Use the show clock command to display the sys t em time and date entered using the clock set command.
Refer to the section clock set <time> <day> <month> <year> on page 78 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 a nd
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"
Use the alias command to populate the ifAlias OID (Interface Table MIB of RFC2863) for all physical and
virtual interfaces when using Simple Network Management Protocol (SNMP) management stations.
Syntax Description
<“text”>Describes the interface (for SNMP) using an alphanumeric character string
enclosed in quotation marks (limited to 64 characters).
Default Values
No defaults required for this command.
Applicable Command Modes
Applies to all interface mode command sets.
Applicable Platforms
Applies to all AOS products.
Command History
Release 1.1Command was introduced.
Functional Notes
The ifAlias OID is a member of the ifXEntry object-type (defined in RFC2863) used to provide a
non-volatile, unique name for various interfaces. This name is preserved through power cycles. Enter a
string (using the alias command) which clearly identifies the interface.
Usage Examples
The following example defines a unique character string for the T1 interface:
Use the cross-connect command to create a cross-connect map from a created TDM group on an interface
to a virtual interface.
Changing cross-connect settings could potentially result in service interruption.
Syntax Description
<#>Identifies the cross-connect using a number descriptor or label for (useful in
systems that allow multiple cross-connects).
<from interface>Specifies the interface (physical or virt ual) on one end of the cross-connect. Ente r
cross-connect 1 ? for a list of valid interfaces.
<slot/port>Used when a physical interface is specified in the <from interface> subcommand
(For example: specifying the T1 port of a T1 module would be t1 1/1).
<tdm-group#>Specifies which configured TDM group to use for this cross-connect. This
subcommand only applies to T1 physical interfaces.
<to interface>Specifies the virtual interface on the other end of the cross-connect. Use the ? to
display a list of valid interfaces.
<slot/port>Used when a physical interface is specified in the <to interface> subcommand.
(For example, specifying the primary T1 port of a T1 module would be t1 1/1).
Default Values
By default, there are no configured cross-connects.
Applicable Platforms
Applies to all AOS products
Command History
Release 1.1Command was introduced.
Release 5.1Command was expanded to include the E1 interface.
Functional Notes
Cross-connects provide the mechanism for connecting a configured virtual (layer 2) endpoint with a
physical (layer 1) interface. Supported layer 2 protocols include Frame Relay and point-to-point protocol
(PPP).
The following example creates a Frame Relay endpoint and connects it to the T1 1/1 physical interface:
1. Create the Frame Relay virtual endpoint and set the signaling method:
(config)#
(config-fr 1)#
2. Create the sub-interface and configure the PVC parameters (including DLCI and IP address):
(config-fr 1)#
(config-fr 1.1)#
(config-fr 1.1)#
3. Create the TDM group of 12 DS0s (64K) on the T1 physical interface:
(THIS STEP IS ONLY VALID FOR T1 INTERFACES.)
(config)#
(config-t1 1/1)#
(config-t1 1/1)#
4. Connect the Frame Relay sub-interface with port T1 1/1:
(config)#
interface frame-relay 1
frame-relay lmi-type cisco
interface fr 1.1
frame-relay interface-dlci 17
ip address 168.125.33.252 255.255.255.252
interface t1 1/1
tdm-group 1 timeslots 1-12 speed 64
exit
cross-connect 1 t1 1/1 1 fr 1
Technology Review
Creating an endpoint that uses a layer 2 protocol (such as Frame Relay) is generally a four-step process:
Step 1:
Create the Frame Relay virtual endpoint (using the
method (using the
the applicable Frame Relay timers logging thresholds, encapsulation types, etc. Generally, most Frame Relay
virtual interface parameters should be left at their default state. For example, the following creates a Frame
Relay interface labeled
command). Also included in the Frame Relay virtual endpoint are all
interface frame-relay
ansi
.
command) and set the signaling
Command Reference GuideCommon Commands
Step 2:
Create the sub-interface and configure the PVC parameters. Using the sub-interface, apply access policies to
the interface, create bridging interfaces, configure dial-backup, assign an IP address, and set the PVC data-link
control identifier (DLCI). For example, the following creates a Frame Relay sub-interface labeled
DLCI to
frame-relay interface-dlci 30
ip address 193.44.69.253 255.255.255.252
Step 3: (VALID ONLY FOR T1 INTERFACES)
Specify the group of DS0s used for signaling on the T1 interface by creating a TDM group. Group any number of
contiguous DS0s together to create a data pipe for layer 2 signaling. Also use the
specify the per-DS0 signaling rate on the interface. For example, the following creates a TDM group labeled
tdm-group
command to
9
containing 20 DS0s (each DS0 having a data rate of 56 kbps).
(config)#
(config-t1 1/1)#
(config-t1 1/1)#
interface t1 1/1
tdm-group 9 timeslots 1-20 speed 56
exit
Step 4:
Make the association between the layer 2 endpoint and the physical interface using the
cross-connect
command. Supported layer 2 protocols include Frame Relay and point-to-point protocol (PPP). For example, the
following creates a cross-connect (labeled
(
fr 7
) and the TDM group configured on interface t1 1/1 (
(config)#
cross-connect 5 t1 1/1 9 fr 7
5
) to make an association between the Frame Relay virtual interface