ADTRAN AOS Version R10.1.0 Operating manual

ADTRAN OPERATING SYSTEM (AOS)
Command Reference Guide
AOS Version R10.1.0
June 2012
60000CRG0-35E

Command Reference Guide
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 2
Trademarks
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.
Be advised that certain security risks are inherent in the use of any telecommunications or networking
equipment, including but not limited to, toll fraud, Denial of Service (DoS) attacks, loss or theft of data,
and the unauthorized or illegal use of said equipment. ADTRAN OFFERS NO WARRANTIES, EITHER
EXPRESSED OR IMPLIED, REGARDING THE PREVENTION, DETECTION, OR DETERRENCE
OF TOLL FRAUD, NETWORKING ATTACKS, OR UNAUTHORIZED, ILLEGAL, OR IMPROPER
USE OF ADTRAN EQUIPMENT OR SOFTWARE. THEREFORE, ADTRAN IS NOT LIABLE FOR
ANY LOSSES OR DAMAGES RESULTING FROM SUCH FRAUD, ATTACK, OR IMPROPER USE,
INCLUDING, BUT NOT LIMITED TO, HUMAN AND DATA PRIVACY, INTELLECTUAL
PROPERTY, MATERIAL ASSETS, FINANCIAL RESOURCES, LABOR AND LEGAL COSTS.
Ultimately, the responsibility for securing your telecommunication and networking equipment rests with
you, and you are encouraged to review documentation regarding available security measures, their
configuration and implementation, and to test such features as is necessary for your network.
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.
901 Explorer Boulevard
P.O. Box 140000
Huntsville, AL 35814-4000
Phone: [phone]
www.adtran.com
60000CRG0-35E
All Rights Reserved.
Printed in the U.S.A.

Command Reference Guide
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 3
Conventions
Service and Warranty
For information on the service and warranty of ADTRAN products, visit the ADTRAN website at
http://www.adtran.com/support.
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
Notes provide additional useful information.
Cautions signify information that could prevent service interruption.
Warnings provide information that could prevent damage to the equipment or
endangerment to human life.

Command Reference Guide
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 4
Table of Contents
Basic Mode Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Common Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65
Enable Mode Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83
Global Configuration Mode Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852
Line (Console) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1464
Line (SSH) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1481
Line (Telnet) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498
ADSL Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
BRI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1525
Cellular Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537
DDS Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556
DSX-1 Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1565
E1 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576
Ethernet Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1594
FDL Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741
FXO Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1748
FXS Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1759
G.703 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1778
HSSI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1785
MEF Ethernet Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790
Modem Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1859
PRI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1865
Serial Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1884
SHDSL Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1894
T1 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1913
T3 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1932
ATM Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1944
ATM Subinterface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1949
BVI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2042
Demand Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2086
EFM Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2166
Frame Relay Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2171
Frame Relay Subinterface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2193
HDLC Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2308
Loopback Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2389
Port Channel Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2438
PPP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2463
Tunnel Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2588
VLAN Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2690

Command Reference Guide
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 5
VLAN Database Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2695
VLAN Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2704
AP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2797
Radio Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2813
VAP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2837
AS Path List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2855
BGP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2858
BGP Neighbor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2878
BGP Address Family Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2895
BGP AF Neighbor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2916
Community List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2935
Network Monitor Probe Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2938
Network Monitor Probe Responder Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2966
Network Monitor Track Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2977
Router (OSPF) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2994
Router (PIM Sparse) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3015
Router (RIP) Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3020
Desktop Auditing Local Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3037
DHCPv4 Pool Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3044
DHCPv6 Pool Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3067
DHCPv6 Server Pool Host Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3087
Ethernet OAM CFM Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3091
Hardware ACL and Access Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3109
IPv4 Access Control List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3126
IPv4 Access Control Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3144
IPv6 Access Control List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3162
IPv6 Access Control Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3192
Mail Agent Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3201
MEF EVC Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3213
MEF EVC Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3217
MEF Policer Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3223
MGCP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3229
Packet Capture Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3259
Quality of Service Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3269
RADIUS Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3296
Route Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3300
Security Monitor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3333
SIP HMR Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3338
TACACS+ Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3361
Top Traffic Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3364
Voice Call Pickup Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3372

Command Reference Guide
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 6
Voice ISDN Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3375
Voice Operator Ring Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3384
Voice Paging Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3402
Voice Ring Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3407
Voice Trunk Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3430
Voice Analog Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3443
Voice ISDN Trunk Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3493
Voice SIP Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3532
Voice T1 Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3603
Voice Line Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3656
Voice Loopback Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3679
Voice User Account Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3697
Voice Auto Attendant Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3778
Voice Call Queuing Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3781
Voice Coverage Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3799
Voice CODEC List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3803
Voice CoS Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3807
FindMe-FollowMe Action Script Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3844
FindMe-FollowMe Contact Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3852
Voice Music on Hold Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3862
Proxy User Template Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3865
Voicemail CoS Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3876
VQM Reporter Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3885
CA Profile Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3899
Certificate Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3911
Crypto Map IKE Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3916
Crypto Map Manual Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3933
IKE Client Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3943
IKE Policy Attributes Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3948
IKE Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3955

Command Reference Guide Reference Guide Introduction
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 7
REFERENCE GUIDE INTRODUCTION
This manual provides information about connecting your product, using the ADTRAN Operating System’s
(AOS) command line interface (CLI), and executing the commands available with the NetVanta Series
units and Total Access 900 Series units.
If you are new to the AOS CLI or new to the world of routers, please take a few moments to review the
information provided in the sections which follow.
If you are already familiar with ADTRAN NetVanta and Total Access 900 units and looking for
information on a specific command or group of commands, please proceed to Command Descriptions on
page 23 of this guide.
AOS UNIT INTRODUCTION
External Parts
To connect and use your new AOS unit, first familiarize yourself with the external setup of the unit. Each
product has a serial port on the back of the unit. The port is marked CONSOLE and connects the unit
directly to your PC via a standard DB-9 serial cable.
Other features vary from unit to unit, but include power connections, physical interface connections (such
as dial backup (DBU) or wide area network (WAN)), and status LEDs along the front that indicate the
status of your unit. For a more detailed description of your particular product, please refer to the Hardware
Installation Guide available online at www.adtran.com.
Internal Parts
In order to fully understand product operation and receive the full benefit of the included guides, you
should be familiar with the unit’s internal parts, which can be divided into five main categories.
1. ROM - Read Only Memory
Read only memory (ROM) is a permanent form of memory stored in chips within the unit and houses
information used by the AOS unit on initial startup. Examples of information stored in ROM are the
Power-On Self Test, which initializes upon boot up and checks the unit’s functionality; the Bootstrap
Startup Program, which actually starts the unit; and the basic form of the AOS software.
2. Flash Memory
Flash Memory is memory located in a memory chip that is not only erasable, but also reprogrammable,
allowing for software upgrades without chip removal. The flash memory in your unit contains the full
AOS and can be used to house copies of the configuration files and application images that are used at
initial unit startup.

Command Reference Guide Internal Parts
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 8
3. RAM - Random Access Memory
RAM is the computer memory that functions as the working memory of your AOS unit. When the unit
is on, the RAM provides memory for caching, packet buffering, holding routing tables, and housing
the running operating system. When the unit is first powered on, RAM executes the application codes
from flash memory and the startup configurations from nonvolatile random access memory
(NVRAM), and when the unit is powered off or reset, RAM loses all data.
4. NVRAM - Nonvolatile Random Access Memory
NVRAM is the general name for any RAM that does not lose its information at power down (for
example, flash memory). In this case, NVRAM has a separate memory function than the flash memory
and is used to house the unit’s startup configurations.
5. Interfaces
Interface is the term used to describe how your unit is connected with its outside environment. There
are a variety of interface categories, as well as interface types. Interface categories include line
interfaces, physical interfaces, and virtual interfaces.
• Line interfaces describe the way you are communicating with your unit (for example, by console
or Telnet).
• Physical interfaces describe the way your unit is physically connected to other units or devices (for
example, via Ethernet, T3, serial, or asymmetric digital subscriber line (ADSL)).
• Virtual interfaces describe the way your unit receives information, whether by Frame Relay,
Point-to-Point Protocol (PPP), virtual local area network (VLAN), or asynchronous transfer mode
(ATM), to name a few.
The user can configure a unit’s interfaces through the interface command sets (refer to Configuration
Command Sets on page 14).

Command Reference Guide Introduction to Command Line Interface
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 9
INTRODUCTION TO COMMAND LINE INTERFACE
The CLI is the method used to communicate with your AOS unit. While it describes the method used to
communicate, such as by console or Telnet, it also refers to the way information is passed to the unit. As a
text-based user interface, the CLI prompts you to input commands line by line when you interface with the
AOS unit (hence the name command line interface).
Introduction to Commands
The most important part is understanding that your commands make the AOS unit function. The right
commands lead to a fully functioning unit, whereas improperly entered or forgotten commands keep the
unit from functioning. To properly use commands, you must understand what function you want the AOS
unit to complete and what syntax the unit understands as instructions. Each command has its own role
within the operating system, and it is the responsibility of the operator to become familiar with specific
commands and command sets.
How Commands Function
Commands are composed of two main parts. The most important part is the command itself, or the
command word. Most command words are short and straightforward (for example, do, exit, or
configure). Command words are entered immediately after the command prompt in the CLI.
The second part of a command is its argument. An argument is a specification that modifies the command.
In the command show flash, show is the command word and flash is the argument because it modifies the
command show. Commands can have any number of arguments, depending upon the action required of the
unit, and in some instances you have a choice of arguments to use.
AOS Command System
ADTRAN products, training tools, and manuals follow a specific system for entering and referencing
commands. Items that are typed in bold are the required commands and arguments for a certain action. In
the following documentation, you will see commands in bold after an example prompt. They look similar
to this:
>enable
#configure terminal
(config)#line telnet 4
(config-telnet4)#
In the example above, the characters >, #, (config)#, and (config-telnet4)# are the prompts after which
commands are entered. In this example, the words in bold (enable, configure terminal,and line telnet 4)
are the entire commands and constitute what should be typed after the prompt. It is important to pay
attention to the prompt you are given when communicating with your unit, as some commands only work
in certain modes, which are signified by the prompt. The different prompts and modes are discussed later
in this guide.
In some commands, you are given a choice of arguments. If this is the case, the manual or guide will place
a vertical bar (|) between your choices as seen in this example:

Command Reference Guide Types of Commands
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 10
#show flash | cflash
Again, remember the # is your prompt, the command word is show, and your choices of arguments are
flash and cflash.
Other commands require you to enter your own information. Information within a command line that
pertains to your personal unit is set off with the greater-than (<) and less-than symbols (>). The description
of the information required is contained within the greater-than and less-than symbols and is typed in
italics. For example:
#copy <file source location> <config-file> tftp
In this case, # is again your prompt, the command word is copy, the information needed from you is the
source location of the file you want to copy (the first set of < >) and the configuration file type (second set
of < >), and tftp represents the location in which to copy the file.
Types of Commands
There are three types of commands in the CLI. Each type of command signifies a different function.
Global Commands
Global commands make changes to the functioning of the entire unit. Global commands correspond to the
Global Configuration mode of the unit and require a password to access since they affect the entire system.
Major Commands
Major commands allow only parts of the product to be configured. Major commands correspond to the
Enable mode of the unit and also require a password since they affect functioning parts of the unit, even
though they do not affect the entire system.
Subcommands
Subcommands are the commands that do the actual work of configuring unit parts. Subcommands
typically follow major commands, and in essence tell the unit to follow through with the major command’s
direction.

Command Reference Guide Using the CLI
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 11
USING THE CLI
This portion of the Command Reference Guide introduces you to the basic concepts and strategies
associated with using the AOS CLI.
Connecting the Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Accessing the CLI from Your PC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
Understanding Command Modes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Understanding Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Using CLI Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20
Performing Common CLI Functions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
Understanding CLI Error Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
Connecting the Unit
For the initial use, the unit should be connected to a computer or a VT100 terminal. To connect the unit,
simply connect a DB-9 straight-through male-to-female serial cable to the CONSOLE port (on the back)
and to your PC or VT100 terminal.
Accessing the CLI from Your PC
All products using the AOS are initially accessed by connecting a VT100 terminal to the unit or using a
terminal emulation program with a PC. Most Windows®PCs come with a program called HyperTerminal,
which is located under Programs>Accessories>Communications. The latest versions of HyperTerminal
can also be downloaded from the Internet.
Emulation Settings
Once you have connected via VT100 terminal or have found the HyperTerminal program, set the program
settings as follows:
• 9600 baud
• 8 data bits
• No parity
• 1 stop bit
• No flow control
If you are using a HyperTerminal program, name your new connection and then set up the new connection
via the resulting dialogue box. The box allows you to determine the type of connection you are using.
Verify COM 1 and select OK.
Another dialogue box appears for entering the COM 1 properties. Enter the program settings in this box;
select APPLY and then OK. You should then be presented with a terminal window with which to interface
with your unit.

Command Reference Guide Understanding Command Modes
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 12
Unit Boot Up
After configuring your PC (or VT100 terminal), plug the unit into the wall and turn on the power. The unit
begins the boot up process, which includes the following:
• The Power-On Self Test runs. This test checks the unit hardware for normal operation. The hard-
ware includes the central processing unit (CPU), the memory, and the interfaces.
• The Bootstrap Startup Program (factory set in the ROM) runs.
• The Bootstrap Startup Program is read by the unit to discover the proper source for the operating
system image.
• The operating system image is loaded into RAM.
• The configuration file saved in NVRAM is loaded into RAM, where it is accessed by the unit and
then executed one line at a time.
If no configuration file is found in NVRAM (there will not be one found on initial setup), you are
presented with the following prompt on your terminal or HyperTerminal screen:
Session Now Available
Press RETURN to get started
After pressing return, a prompt appears for communication with your unit.
Understanding Command Modes
As you begin communication, you should understand the command modes. Just as there are different
levels of commands in the CLI, there are different modes for commands within AOS itself. Each command
mode enables the user to access more commands, and make more changes in the unit’s configuration.
The CLI has three command modes: Basic, Enable, and Global. The three command modes are organized
in a three-tiered hierarchy with Basic at the bottom, Enable in the middle, and Global at the top.
Basic Mode
Interaction with your unit begins at the Basic mode. The commands supported at this command tier are
limited, as is interaction with the unit itself. The Basic mode is to keep users without access to the higher
tiered commands from changing the preferred configurations of the unit. The following table describes the
Basic mode.
For more information on the Basic mode, please refer to Basic Mode Command Set on page 36.
Mode Access By... Mode Prompt Accessible Commands
Basic Beginning an AOS session > • Display system information
• Perform traceroute and ping
functions
• Open a Telnet session

Command Reference Guide Understanding Command Modes
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 13
Enable Mode
Enable mode is the mid-level tier in the command hierarchy, one step up from the Basic mode. ADTRAN
suggests that a password be required to access the Enable mode. Refer to the quick configuration guides
and quick start guides located online at https://supportforums.adtran.com for more information on
configuring a password.
From the Enable mode, you can access the configurations of your product, as well as handle how your unit
boots and runs, among other things. The following table describes the Enable mode.
For more information regarding the Enable command set, refer to the Enable Mode Command Set on page
83.
Global Mode
The Global mode is the highest level tier within AOS. The Global mode allows the user to make changes
regarding the entire product system. All of your system’s configurations are accessed through the Global
mode. From this level, you can access not only line configurations, router configurations, and interface
configurations, but also any other configurations or parameters on your system. The following table
describes the Global mode.
For more information on the Global mode, refer to Global Configuration Mode Command Set on page 852.
Mode Access By.... Mode Prompt Accessible Commands
Enable Entering enable while in the
Basic mode as follows:
>enable
# • Manage the startup and running
configurations
• Use the debug commands
• Enter any of the configuration modes
Mode Access By... Mode Prompt Accessible Commands
Global Entering config while at the
Enable mode as follows:
>enable
#
#config
(config)# • Set the system’s Enable-level
password(s)
• Configure the system global IP
parameters
• Configure the SNMP parameters
• Enter any of the configuration modes

Command Reference Guide Understanding Configurations
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 14
Understanding Configurations
Configurations are the means by which you set up your unit and system according to your personal
requirements and preferences. You must configure your unit to work within your network, based on your
hardware and communication systems.
All configurations are accessed through the Global Configuration mode. By typing in config at the Enable
mode prompt, you will be ready to specify the configuration you want to access.
For each configuration, enter the word or phrase that correlates with the system you are configuring. There
are different command sets for each type of configuration. These command sets are detailed in the
following section.
Configuration Command Sets
The configuration command sets are broken down into categories of similar functions. For example, all
commands dealing with configuring the line interface are grouped together, as are configuration
commands dealing with your hardware, commands dealing with your virtual network, and so on. The
following sections deal with each category of command sets. For a complete list of command sets and their
reference pages, refer to Command Descriptions on page 23.
Line Interface Command Sets
The line interface commands deal specifically with the way in which you communicate with your device.
The first time you connect with your unit, you must use the CONSOLE port in the rear of the unit, but
connections thereafter can be set up via the CONSOLE port, a terminal interface, or by Telnet. The line
interface command sets allow you to configure each method of connection to your preferences.
The following table gives an example of the line interface command set. For a more detailed description,
refer to Command Descriptions on page 23.
Command
Set
Accessed By... Sample Prompt With This Set You Can...
Line Interface Specifying a line (console,
Telnet, SSH) at the Global
Configuration mode prompt
as follows:
>enable
#config
(config)#line console 0
(config-con0)# • Configure the console or terminal
settings (data rate, login password,
etc.)
• Create Telnet logins and specify their
parameters (login password, etc.)

Command Reference Guide Configuration Command Sets
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 15
Physical Interface Command Sets
The physical interface commands of your unit deal with the medium over which your data is actually
transmitted and the physical hardware associated with your unit. Included in the physical interfaces are
Ethernet cables, serial interfaces, T1 cables, etc. These configurations must be set up to work with the type
of network you have.
The following table describes the physical interface command sets. For a more detailed description of the
physical interface command sets, please refer to Command Descriptions on page 23.
Virtual Interface Command Sets
The virtual interface is similar to the physical interface in function, except that it deals with your virtual
network. In essence, as your physical interfaces deal with your actual physical connections, virtual
interfaces deal with how your information is transmitted over those physical connections. Virtual
interfaces deal with your networking through protocols, such as ATM, Frame Relay, high level data link
control (HDLC), PPP, VLAN, etc. The virtual interface commands allow you to fully integrate your unit
into your existing networking setup.
The following table gives an example of the virtual interface command set. For more information on
virtual interfaces, refer to Command Descriptions on page 23.
Command
Set
Accessed By... Sample Prompt With This Set You Can...
Physical
Interface
Specifying an interface at
the Global Configuration
mode prompt as follows:
>enable
#config
(config)#interface adsl 0/1
(config-adsl0/1)# • Configure the parameters of your
physical connections
• Configure your physical network
Command
Set
Accessed By... Sample Prompt With This Set You Can...
Virtual
Interface
Specifying an interface at
the Global Configuration
mode prompt as follows:
>enable
#config
(config)#interface
frame-relay 1
(config-fr 1)# • Determine the parameters of
information flow
• Configure your unit’s methods for
communicating with other devices

Command Reference Guide Configuration Command Sets
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 16
Wireless Interface Command Sets
The wireless interface is similar to both the physical and virtual interfaces in function, except that it deals
with your wireless network. Wireless interfaces allow the configuration of wireless access points (APs),
access point radios, and virtual access points (VAPs).
The following table gives an example of the wireless interface command set. For more information on
wireless interfaces, refer to Command Descriptions on page 23.
Routing Command Sets
The routing command sets for the product serve two functions. Routing commands not only address the
manner in which your unit routes and disseminates information, but they also provide an additional level of
security for your network. Routing commands include parameters, such as AS path list, community list,
and network monitoring, and they determine whether your unit routes via Routing Information Protocol
(RIP), open shortest path first (OSPF), or protocol-independent multicast (PIM) sparse.
The following table gives an example of the routing command sets. For a complete list of routing
commands, refer to the Command Descriptions on page 23.
Command Set Accessed By... Sample Prompt With This Set You Can...
Wireless
Interface
Specifying a wireless
interface at the Global
Configuration mode prompt
as follows:
>enable
#config
(config)#interface dot11ap 1
(config-dot11ap
1)#
• Configure your unit’s wireless
parameters (radios, APs, and
VAPs)
• Configure how your wireless
network will integrate with your
wired network
Command Set Accessed By... Sample Prompt With This Set You Can...
Routing Specifying which routing
parameter you wish to set at
the Global Configuration mode
prompt as follows:
>enable
#config
(config)#router ospf
(config-ospf)# • Determine which devices are
compatible with your network
• Determine how your unit
routes traffic and information

Command Reference Guide Configuration Command Sets
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 17
Security and Services Command Sets
The security and services command sets provide methods for you to configure additional security for your
unit, as well as determine the types of services you want your unit to perform. Included in these command
sets are quality of service (QoS) maps, Dynamic Host Configuration Protocol (DHCP) pools, and route
map configurations.
The following table includes an example of the security and services commands. For a more detailed
listing of the command sets, refer to Command Descriptions on page 23.
Voice Group Command Sets
Voice group command sets deal with the configuration and organization of voice groups within your
network. The commands allow you to configure voice features as part of a collective group, and to define
how these groups behave.
The following table gives a small example of the voice group command sets. For a more detailed
description, refer to Command Descriptions on page 23.
Command
Set
Accessed By... Sample Prompt With This Set You Can...
Security and
Services
Specifying the service you
would like to perform at the
Global Configuration mode
prompt as follows:
>enable
#config
(config)#aaa group server
radius myServer
(config-sg-radius)# • Map the quality of a variety of
services
• Set the parameters for the DHCP
• Configure the unit’s route map
Command Set Accessed By... Sample Prompt With This Set You Can...
Voice Groups Specifying the voice group you
would like to configure at the
Global Configuration mode
prompt as follows:
>enable
#config
(config)#voice ring-group
1234
(config-1234)# • Set parameters for ring groups,
operator groups, trunk groups,
paging groups, and more
• Specify the behaviors and
permissions of voice groups,
as well as define the members
of the groups

Command Reference Guide Configuration Command Sets
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 18
Voice Trunks Command Sets
Voice trunks command sets deal with the configuration of voice trunks within your network. The
commands allow you to configure various trunks and specify how these trunks function.
The following table gives a small example of the voice trunks command sets. For a more detailed
description, refer to Command Descriptions on page 23.
Voice Accounts Command Sets
Voice accounts command sets deal with the configuration and organization of differing accounts within
your voice network. The commands allow you to configure such items as user permissions, voice line
behaviors, and voice loopback services.
The following table gives a small example of the voice accounts command sets. For a more detailed
description, refer to Command Descriptions on page 23.
Command Set Accessed By... Sample Prompt With This Set You Can...
Voice Trunks Specifying the voice trunk type
you would like to configure at
the Global Configuration mode
prompt as follows:
>enable
#config
(config)#voice trunk t01
(config-t01)# • Set parameters for analog
trunks, T1 trunks, Session
Initiation Protocol (SIP) trunks,
and more
• Specify the behaviors and
permissions of these trunks
Command Set Accessed By... Sample Prompt With This Set You Can...
Voice Accounts Specifying the voice account
you would like to configure at
the Global Configuration mode
prompt as follows:
>enable
#config
(config)#voice user 4444
(config-4444)# • Set parameters for user
accounts, line accounts, and
loopback accounts
• Specify the behaviors and
permissions of these accounts
within the voice network

Command Reference Guide Configuration Command Sets
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 19
Voice Services Command Sets
Voice services command sets deal with the configuration and implementation of various voice services
within your network. The commands allow you to configure voice features to improve network operation,
set voicemail parameters, and monitor your voice network.
The following table gives a small example of the voice services command sets. For a more detailed
description, refer to Command Descriptions on page 23.
Virtual Private Network (VPN) Parameter Command Sets
The virtual private network (VPN) parameter command sets deal with the encryption and security on your
private network. To allow you the utmost in security, the VPN parameter commands allow you to
configure how your unit will behave as it communicates with other devices. VPN command sets allow you
to configure Internet key exchange (IKE) parameters, crypto parameters, and certificate parameters.
The following table gives an example of the VPN parameter commands. For a more detailed listing of
commands, refer to Command Descriptions on page 23.
Command Set Accessed By... Sample Prompt With This Set You Can...
Voice Services Specifying the voice service
you would like to configure at
the Global Configuration mode
prompt as follows:
>enable
#config
(config)#voice autoattendant
Example 1212
(config-aa1212)# • Set parameters for class of
service (CoS) on the voice
network, configure voicemail
and auto attendant, use voice
quality monitoring reporters,
and more
• Specify the behaviors and
permissions of voice features
within the network
Command Set Accessed By... Sample Prompt With This Set You Can...
VPN Parameters Specifying which parameter you
wish to set at the Global
Configuration mode prompt as
follows:
>enable
#config
(config)#crypto ca certificate
chain MyProfile
(config-cert-
chain)#
• Determine how your unit
authenticates communication
• Set the parameters for keeping
your unit secure

Command Reference Guide Using CLI Shortcuts
60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 20
Using CLI Shortcuts
The AOS CLI provides several shortcuts to help you configure your AOS product more easily. See the
following table for descriptions.
Shortcut Description
Up arrow key To redisplay a previously entered command, use the up arrow key. Continuing to
press the up arrow key cycles through all commands entered, starting with the most
recent command.
<Tab> key Pressing the <Tab> key after entering a partial (but unique) command will complete
the command, display it on the command prompt line, and wait for further input.
?The AOS CLI contains help to guide you through the configuration process. Using the
question mark, do any of the following:
Display a list of all subcommands in the current mode. For example:
(config-t1 1/1)#coding ?
ami - Alternate Mark Inversion
b8zs - Bipolar Eight Zero Substitution
Display a list of available commands beginning with certain letter(s). For example:
(config)#ip d?
default-gateway dhcp-server domain-lookup domain-name domain-proxy
Obtain syntax help for a specific command by entering the command, a space, and
then a question mark (?). The AOS 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)
<Ctrl + A> 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 <Ctrl + A>
at the following prompt will place the cursor directly after 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 <Ctrl + E> at
the following prompt will place the cursor directly after the 6:
(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> feature:
(config-eth 0/1)#ip address 192.33.55.6 (Press <Ctrl + U> here)
(config-eth 0/1)#
auto finish You need only enter enough letters to identify a command as unique. For example,
entering int t1 1/1 at the Global Configuration mode prompt provides you access to
the configuration parameters for the specified T1 interface. Entering interface t1 1/1
would work as well, but is not necessary.