Adtran AOS Command Reference Guide 17.08

ADTRAN OPERATING SYSTEM (AOS)
Command Reference Guide

AOS Version 17.08
March 2010
60000CRGD-35G
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.
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: (256) 963-8000
www.adtran.com
60000CRGD-35G
All Rights Reserved.
Printed in the U.S.A.
60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 2

Conventions
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.
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

Table of Contents
Basic Mode Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Common Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Enable Mode Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Global Configuration Mode Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 714
Line (Console) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1207
Line (SSH) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1223
Line (Telnet) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1235
ADSL Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1249
BRI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1253
Cellular Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1263
DDS Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1275
DSX-1 Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1283
E1 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1293
Ethernet Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1309
FDL Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1422
FXO Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1428
FXS Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1439
G.703 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1452
HSSI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1459
Modem Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1463
PRI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1468
Serial Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1477
SHDSL Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1486
T1 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1500
T3 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517
ATM Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1528
ATM Subinterface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1532
BVI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1618
Demand Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1656
Frame Relay Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1730
Frame Relay Subinterface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1751
HDLC Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1834
Loopback Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1910
Port Channel Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1955
PPP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1979
Tunnel Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2072
VLAN Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2148
VLAN Database Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2153
VLAN Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2162

AP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223

Radio Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2239
VAP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2263
AS Path List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2281
BGP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2284
BGP Neighbor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2299
Community List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2316
Network Monitor Probe Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2319
Network Monitor Probe Responder Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2346
Network Monitor Track Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2356
Router (OSPF) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2371
Router (PIM Sparse) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2391
Router (RIP) Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2395
Access Control List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2411
Access Control Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2428
Desktop Auditing Local Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2446
DHCP Pool Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2453
Ethernet OAM CFM Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2473
Hardware ACL and Access Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2491
Mail Agent Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2508
MGCP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2519
Quality of Service Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2545
RADIUS Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2570
Route Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2573
TACACS+ Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2602
Top Traffic Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2604
Voice ISDN Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2611
Voice Operator Ring Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2620
Voice Paging Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2638
Voice Ring Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2643
Voice Trunk Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2666
Voice Analog Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2679
Voice ISDN Trunk Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2718
Voice SIP Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2752
Voice T1 Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2798
Voice Line Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2847
Voice Loopback Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2870
Voice User Account Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2887
Voice Auto Attendant Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2952
Voice CODEC List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2955
Voice CoS Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2959

Voicemail CoS Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2995

VQM Reporter Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3003
CA Profile Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3010
Certificate Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3021
Crypto Map IKE Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3025
Crypto Map Manual Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3042
IKE Client Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3053
IKE Policy Attributes Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3057
IKE Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3063

Command Reference Guide Reference Guide Introduction
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 on the AOS Documentation CD included in the shipment.
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
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
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
#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
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
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 hardware
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.
Mode Access By... Mode Prompt Accessible Commands

Basic Beginning an AOS session > • Display system information
• Perform traceroute and ping
functions
• Open a Telnet session
For more information on the Basic mode, please refer to Basic Mode Command Set on page 34.

Command Reference Guide Understanding Command Modes
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 on the AOS Documentation CD 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.
Mode Access By.... Mode Prompt Accessible Commands

Enable Entering enable while in the # • Manage the startup and running
Basic mode as follows: configurations
>enable • Use the debug commands
• Enter any of the configuration modes
For more information regarding the Enable command set, refer to the Enable Mode Command Set on page
62.
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.
Mode Access By... Mode Prompt Accessible Commands

Global Entering config while at the (config)# • Set the system’s Enable-level
Enable mode as follows: password(s)
>enable • Configure the system global IP
# parameters
#config • Configure the SNMP parameters
• Enter any of the configuration modes
For more information on the Global mode, refer to Global Configuration Mode Command Set on page 714.

Command Reference Guide Understanding Configurations
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 Accessed By... Sample Prompt With This Set You Can...
Set
Line Interface Specifying a line (console, (config-con0)# • Configure the console or terminal
Telnet, SSH) at the Global settings (data rate, login password,
Configuration mode prompt etc.)
as follows: • Create Telnet logins and specify their
>enable parameters (login password, etc.)
#config
(config)#line console 0

Command Reference Guide Configuration Command Sets
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.
Set
Physical Specifying an interface at (config-adsl0/1)# • Configure the parameters of your
Interface the Global Configuration physical connections
mode prompt as follows: • Configure your physical network
>enable
#config
(config)#interface adsl 0/1
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.
Set
Virtual Specifying an interface at (config-fr 1)# • Determine the parameters of
Interface the Global Configuration information flow
mode prompt as follows: • Configure your unit’s methods for
>enable communicating with other devices
#config
(config)#interface
frame-relay 1

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.
Command Set Accessed By... Sample Prompt With This Set You Can...
Wireless Specifying a wireless (config-dot11ap • Configure your unit’s wireless
Interface interface at the Global 1)# parameters (radios, APs, and
Configuration mode prompt VAPs)
as follows: • Configure how your wireless
>enable network will integrate with your
#config wired network
(config)#interface dot11ap 1
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.
Routing Specifying which routing (config-ospf)# • Determine which devices are
parameter you wish to set at compatible with your network
the Global Configuration mode • Determine how your unit
prompt as follows: routes traffic and information
>enable
#config
(config)#router ospf

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.
Set
Security and Specifying the service you (config-sg-radius)# • Map the quality of a variety of
Services would like to perform at the services
Global Configuration mode • Set the parameters for the DHCP
prompt as follows: • Configure the unit’s route map
>enable
#config
(config)#aaa group server
radius myServer
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.
Voice Groups Specifying the voice group you (config-1234)# • Set parameters for ring groups,
would like to configure at the operator groups, trunk groups,
Global Configuration mode paging groups, and more
prompt as follows: • Specify the behaviors and
>enable permissions of voice groups,
#config as well as define the members
(config)#voice ring-group of the groups
1234

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
Voice Trunks Specifying the voice trunk type (config-t01)# • Set parameters for analog
you would like to configure at trunks, T1 trunks, Session
the Global Configuration mode Initiation Protocol (SIP) trunks,
prompt as follows: and more
>enable • Specify the behaviors and
#config permissions of these trunks
(config)#voice trunk t01
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
Voice Accounts Specifying the voice account (config-4444)# • Set parameters for user
you would like to configure at accounts, line accounts, and
the Global Configuration mode loopback accounts
prompt as follows: • Specify the behaviors and
>enable permissions of these accounts
#config within the voice network
(config)#voice user 4444

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
Voice Services Specifying the voice service (config-aa1212)# • Set parameters for class of
you would like to configure at service (CoS) on the voice
the Global Configuration mode network, configure voicemail
prompt as follows: and auto attendant, use voice
>enable quality monitoring reporters,
#config and more
(config)#voice autoattendant • Specify the behaviors and
Example 1212 permissions of voice features
within the network
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.
VPN Parameters Specifying which parameter you (config-cert- • Determine how your unit
wish to set at the Global chain)# authenticates communication
Configuration mode prompt as • Set the parameters for keeping
follows: your unit secure
>enable
#config
(config)#crypto ca certificate
chain MyProfile

Command Reference Guide Using CLI Shortcuts
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.

Command Reference Guide Performing Common CLI Functions
Performing Common CLI Functions

The following table contains descriptions of common CLI commands.
Command Description
do The do command provides a way to execute commands in other command
sets without taking the time to exit the current command set. The following
example shows the do command used to view the Frame Relay interface
configuration while in the T1 interface command set:
(config)#interface t1 1/1
(config-t1 1/1)#do show interfaces fr 7
no shutdown To activate an interface, enter no shutdown followed by the interface.
For example:
no shutdown t1 1/1
no To undo an issued command or to disable a feature, enter no before the
command.
no debug voice
copy running-config When you are ready to save the changes made to the configuration, enter this
startup-config command. This copies your changes to the unit’s NVRAM. Once the save is
complete, the changes are retained even if the unit is shut down or suffers a
power outage.
show running config Displays the current configuration.
debug Use the debug command to troubleshoot problems you 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 debug section beginning on page 173.
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 use the debug
command only during times when the network resources are in low demand (nonpeak
hours, weekends, etc.).

Command Reference Guide Understanding CLI Error Messages
Understanding CLI Error Messages

The following table lists and defines some of the more common error messages given in the CLI.
Message Helpful Hints

%Ambiguous command The command may not be valid in the current command mode, or you
%Unrecognized command may not have entered enough correct characters for the command to be
recognized. Try using the ? command to determine your error. Refer to
Using CLI Shortcuts on page 20 for more information.
%Invalid or incomplete The command may not be valid in the current command mode, or you
command may not have entered all of the pertinent information required to make
the command valid. Try using the ? command to determine your error.
Refer to Using CLI Shortcuts on page 20 for more information.
%Invalid input detected at The error in command entry is located where the caret (^) mark appears.
“^” marker Enter a question mark at the prompt. The system displays a list of
applicable commands or gives syntax information for the entry.

Command Reference Guide Command Descriptions
COMMAND DESCRIPTIONS
This portion of the guide provides a detailed listing of all available commands for the AOS CLI (organized
by command set). Each command listing contains pertinent information, including the default value, a
description of all subcommand parameters, functional notes for using the command, and a brief technology
review. To search for a particular command alphabetically, refer to the Index on page 3076. 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 34

Common Commands on page 45
Enable Mode Command Set on page 62
Global Configuration Mode Command Set on page 714
Line Interface Command Sets
Line (Console) Interface Command Set on page 1207
Line (SSH) Interface Command Set on page 1223
Line (Telnet) Interface Command Set on page 1235
Physical Interface Command Sets
ADSL Interface Command Set on page 1249
BRI Interface Command Set on page 1253
Cellular Interface Command Set on page 1263
DDS Interface Command Set on page 1275
DSX-1 Interface Command Set on page 1283
E1 Interface Command Set on page 1293
Ethernet Interface Command Set on page 1309
FDL Interface Command Set on page 1422
FXO Interface Command Set on page 1428
FXS Interface Command Set on page 1439
G.703 Interface Command Set on page 1452
HSSI Interface Command Set on page 1459
Modem Interface Command Set on page 1463
PRI Interface Command Set on page 1468
Serial Interface Command Set on page 1477
SHDSL Interface Command Set on page 1486
T1 Interface Command Set on page 1500
T3 Interface Command Set on page 1517
Virtual Interface Command Sets
ATM Interface Command Set on page 1528
ATM Subinterface Command Set on page 1532
BVI Interface Command Set on page 1618
Demand Interface Command Set on page 1656

Frame Relay Interface Command Set on page 1730

Frame Relay Subinterface Command Set on page 1751
HDLC Interface Command Set on page 1834
Loopback Interface Command Set on page 1910
Port Channel Interface Command Set on page 1955
PPP Interface Command Set on page 1979
Tunnel Interface Command Set on page 2072
VLAN Command Set on page 2148
VLAN Database Command Set on page 2153
VLAN Interface Command Set on page 2162
Wireless Interface Command Sets
AP Interface Command Set on page 2223
Radio Interface Command Set on page 2239
VAP Interface Command Set on page 2263
Routing Command Sets
AS Path List Command Set on page 2281
BGP Command Set on page 2284
BGP Neighbor Command Set on page 2299
Community List Command Set on page 2316
Network Monitor Probe Command Set on page 2319
Network Monitor Probe Responder Command Set on page 2346
Network Monitor Track Command Set on page 2356
Router (OSPF) Command Set on page 2371
Router (PIM Sparse) Command Set on page 2391
Router (RIP) Command Set on page 2395
Security and Services Command Sets
Access Control List Command Set on page 2411
Access Control Policy Command Set on page 2428
Desktop Auditing Local Policy Command Set on page 2446
DHCP Pool Command Set on page 2453
Ethernet OAM CFM Command Set on page 2473
Hardware ACL and Access Map Command Set on page 2491
Mail Agent Command Set on page 2508
MGCP Command Set on page 2519
Quality of Service Map Command Set on page 2545
RADIUS Group Command Set on page 2570
Route Map Command Set on page 2573
TACACS+ Group Command Set on page 2602
Top Traffic Command Set on page 2604

Voice Groups Command Sets

Voice ISDN Group Command Set on page 2611
Voice Operator Ring Group Command Set on page 2620
Voice Paging Group Command Set on page 2638
Voice Ring Group Command Set on page 2643
Voice Trunk Group Command Set on page 2666
Voice Trunks Command Sets
Voice Analog Trunk Command Set on page 2679
Voice ISDN Trunk Command Set on page 2718
Voice SIP Trunk Command Set on page 2752
Voice T1 Trunk Command Set on page 2798
Voice Accounts Command Sets
Voice Line Account Command Set on page 2847
Voice Loopback Account Command Set on page 2870
Voice User Account Command Set on page 2887
Voice Services Command Sets
Voice Auto Attendant Command Set on page 2952
Voice CODEC List Command Set on page 2955
Voice CoS Command Set on page 2959
Voicemail CoS Command Set on page 2995
VQM Reporter Command Set on page 3003
VPN Parameter Command Sets
CA Profile Command Set on page 3010
Certificate Command Set on page 3021
Crypto Map IKE Command Set on page 3025
Crypto Map Manual Command Set on page 3042
IKE Client Command Set on page 3053
IKE Policy Attributes Command Set on page 3057
IKE Policy Command Set on page 3063

Command Reference Guide Command Set Access Path Quick Reference Guide
COMMAND SET ACCESS PATH QUICK REFERENCE GUIDE
Physical Interface Command Set Access Paths
Command Set Sample Access Path For Full Command

List, See...
ADSL (config)#interface adsl 0/1 page 1249
(config-adsl 0/1)#
BRI (config)#interface bri 1/2 page 1253
(config-bri 1/2)#
Cellular (config)#interface cellular 1/1 page 1263
(config-cellular 1/1)#
DDS (config)#interface dds 1/1 page 1275
(config-dds 1/1)#
DSX-1 (config)#interface t1 1/2 page 1283
(config-t1 1/2)#
E1 (config)#interface e1 1/1 page 1293
(config-e1 1/1)#
Ethernet (config)#interface ethernet 0/1 page 1309
(config-eth 0/1)#
Ethernet Subinterface (config)#interface ethernet 0/1.1 page 1309
(config-eth 0/1.1)#
Gigabit Ethernet (config)#interface gigabit-ethernet 0/3 page 1309
(config-giga-eth 0/3)#
Gigabit Switchport (config)#interface gigabit-switchport 0/3 page 1309
(config-giga-swx 0/3)#
Switchport (config)#interface switchport 0/1 page 1309
(config-swx 0/1)#
Range of Ethernet (config)#interface range ethernet 0/1, 0/8 page 1310
Interfaces (config-eth 0/1, 0/8)#
(in this example, eth 0/1
through eth 0/8)
FDL (config)#interface fdl 1/1 page 1422
(config-fdl 1/1)#
FXO (config)#interface fxo 0/1 page 1428
(config-fxo 0/1)#
FXS (config)#interface fxs 2/1 page 1439
(config-fxs 2/1)#
G.703 (config)#interface e1 1/2 page 1452
(config-e1 1/2)#
HSSI (config)#interface hssi 1/1 page 1459
(config-hssi 1/1)#
Modem (config)#interface modem 1/2 page 1463
(config-modem 1/2)#

Command Reference Guide Virtual Interface Command Set Access Paths

List, See...
PRI (config)#interface pri 2 page 1468
(config-pri 2)#
Serial (config)#interface serial 1/1 page 1477
(config-ser 1/1)#
SHDSL (config)#interface shdsl 1/1 page 1486
(config-shdsl 1/1)#
T1 (config)#interface t1 1/1 page 1500
(config-t1 1/1)#
T3 (config)#interface t3 1/1 page 1517
(config-t3 1/1)#
Virtual Interface Command Set Access Paths

List, See...
ATM (config)#interface atm 1 page 1528
(config-atm 1)#
ATM Subinterface (config)#interface atm 1.1 page 1532
(config-atm 1.1)#
BVI Interface (config)#bridge irb page 1618
(config)#interface bvi 1
(config-bvi 1)#
Demand (config)#interface demand 1 page 1656
(config-demand 1)#
Frame Relay (config)#interface frame-relay 1 page 1730
(config-fr 1)#
Frame Relay Subinterface (config)#interface frame-relay 1.16 page 1751
(config-fr 1.16)#
HDLC (config)#interface hdlc 1 page 1834
(config-hdlc 1)#
Loopback (config)#interface loopback 1 page 1910
(config-loop 1)#
Port Channel (config)#interface port-channel 1 page 1955
(config-p-chan1)#
PPP (config)#interface ppp 1 page 1979
(config-ppp 1)#
Tunnel (config)#interface tunnel 1 page 2072
(config-tunnel 1)#
VLAN Configuration (config)#vlan 1 page 2148
(config-vlan 1)#
VLAN Database (config)#vlan database page 2153
(vlan)#

Command Reference Guide Wireless Interface Command Set Access Paths

List, See...
VLAN Interface (config)#interface vlan 1 page 2162
(config-interface-vlan 1)#
Wireless Interface Command Set Access Paths

List, See...
Access Point (config)#interface dot11ap 1 page 2223
(config-dot11ap 1)#
Radio (config)#interface dot11ap 1/1 page 2239
(config-dot11ap 1/1-bg)#
Virtual Access Point (config)#interface dot11ap 1/1.1 page 2263
(config-dot11ap 1/1.1-bg)#
Routing Protocol Command Set Access Paths

List, See...
AS Path List (config)#ip as-path-list MyList page 2281
(config-as-path-list)#
BGP Configuration (config)#router bgp 1 page 2284
(config-bgp)#
BGP Neighbor (config-bgp)#router bgp-neighbor page 2299
192.22.73.101
(config-bgp-neighbor)#
Community List (config)#ip community-list listname page 2316
(config-comm-list)#
Network Monitor Probe (config)#probe probe1 icmp-echo page 2319
(config-probe-probe1)#
Network Monitor Probe (config)#probe responder twamp page 2346
Responder (config-responder-twamp)#
Network Monitor Track (config)#track track1 page 2356
(config-track-track1)#
OSPF (config)#router ospf page 2371
(config-ospf)#
PIM Sparse (config)#router pim-sparse page 2391
(config-pim-sparse)#
RIP (config)#router rip page 2395
(config-rip)#

Command Reference Guide Security and Services Command Set Access Paths
Security and Services Command Set Access Paths

List, See...
Access Control List (config)#ip access-list standard MATCHALL page 2411
(config-std-nacl)#
Access Control Policy (config)#ip policy-class PRIVATE page 2428
(config-policy-class)#
Desktop Auditing Local (config)#desktop-auditing local-policy page 2975
Policy (desktop-audit-policy)#
DHCP (config)#ip dhcp-server pool MyPool page 2453
(config-dhcp)#
Ethernet OAM CFM (config)#ethernet cfm domain domain1 level 6 page 2473
(config-ecfm-domain)#
Hardware ACL and (config)#ip hw-access-list extended Trusted page 2491
Access Map (config-ext-ip-hw-nacl)#
Mail Agent (config)#mail-client myagent page 2508
(config-mail-client-myagent)#
MGCP Endpoint (config)#voice mgcp-endpoint 1 page 2519
(config-mgcp-1)#
QoS Map (config)#qos map VOICEMAP 10 page 2545
(config-qos-map)#
RADIUS Group (config)#aaa group server radius myServers page 2570
(config-sg-radius)#
Route Map (config)#route-map MyMap permit 100 page 2573
(config-route-map)#
TACACS+ Group (config)#aaa group server tacacs+ TEST_ page 2602
GROUP
(config-sg-tacacs+)#
Top Traffic (config)#ip flow top-talkers page 2604
(config-top-talkers)#
Voice Groups Command Set Access Paths

List, See...
Voice ISDN Group (config)#isdn-group 1 page 2611
(config-isdn-group 1)#
Voice Operator Group (config)#voice operator-group page 2620
(config-operator-group)#
Voice Paging Group (config)#voice paging-group 8956 page 2638
(config-8956)#
Voice Ring Group (config)#voice ring-group 1234 page 2643
(config-1234)#

Command Reference Guide Voice Trunks Command Set Access Paths

List, See...
Voice Trunk Group (config)#voice grouped-trunk TestGroup page 2666
(config-TestGroup)#
Voice Trunks Command Set Access Paths

List, See...
Voice Analog Trunk DPT (config)#voice trunk t01 type analog page 2679
supervision dpt
(config-t01)#
Voice Analog Trunk (config)#voice trunk t01 type analog page 2679
Ground Start (GS) supervision ground-start
(config-t01)#
Voice Analog Trunk Loop (config)#voice trunk t01 type analog page 2679
Start (LS) supervision loop-start
(config-t01)#
Voice ISDN Trunk (config)#voice trunk t01 type isdn page 2718
(config-t01)#
Voice SIP Trunk (config)#voice trunk t01 type sip page 2752
(config-t01)#
Voice T1 Trunk Feature (config)#voice trunk t01 type t1-rbs page 2798
Group D supervision fgd role user
(config-t01)#
Voice Trunk T1 Ground (config)#voice trunk t01 type t1-rbs page 2798
Start (GS) supervision ground-start role user
(config-t01)#
Voice T1 Trunk Immediate (config)#voice trunk t01 type t1-rbs page 2798
supervision immediate role [network | user]
(config-t01)#
Voice T1 Trunk (config)#voice trunk t01 page 2798
(config-t01)#
Voice T1 Trunk Loop Start (config)#voice trunk t01 type t1-rbs page 2798
(LS) supervision loop-start role user
(config-t01)#
Voice T1 Trunk Wink Role (config)#voice trunk t01 type t1-rbs page 2798
supervision wink role [network | user]
(config-t01)#

Command Reference Guide Voice Accounts Command Set Access Paths
Voice Accounts Command Set Access Paths

List, See...
Voice Line Account (config)#voice line sales page 2847
(config-sales)#
Voice Loopback Account (config)#voice loopback 5555 page 2870
(config-LB-5555)#
Voice User Account (config)#voice user 4444 page 2887
(config-4444)#
Voice Services Command Set Access Paths

List, See...
Voice Auto Attendant (config)#voice autoattendant Example 1212 page 2952
(config-aa1212)#
Voice CODEC List (config)#voice codec-list List1 page 2955
(config-codec)#
Voice CoS (config)#voice class-of-service set1 page 2959
(config-cos-set1)#
Voicemail CoS (config)#voice mail class-of-service class1 page 2995
(config-vm-class1)#
Voice Quality Monitoring (config)#ip rtp quality-monitoring reporter page 3003
Reporter Reporter1
(config-rtp-reporter-Reporter1)#
VPN Parameter Command Set Access Paths

List, See...
CA Profile (config)#crypto ca profile MyProfile page 3010
(ca-profile)#
Certificate (config)#crypto ca certificate chain MyProfile page 3021
(config-cert-chain)#
Crypto Map IKE (config)#crypto map Map-Name 10 ipsec-ike page 3025
(config-crypto-map)#
Crypto Map Manual (config)#crypto map Map-Name 10 page 3042
ipsec-manual
IKE Client (config)#crypto ike client configuration pool page 3053
ConfigPool1
(config-ike-client-pool)#

Command Reference Guide VPN Parameter Command Set Access Paths

List, See...
IKE Policy Attributes (config)#crypto ike policy 1 page 3057
(config-ike)#attribute 10
(config-ike-attribute)#
IKE Policy (config)#crypto ike policy 1 page 3063
(config-ike)#

SYSTEM COMMAND SETS

This section includes the following command sets:
• Basic Mode Command Set on page 34

• Common Commands on page 45
• Enable Mode Command Set on page 62
• Global Configuration Mode Command Set on page 714

Command Reference Guide Basic Mode Command Set
BASIC MODE COMMAND SET
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 53
All other commands for this command set are described in this section in alphabetical order.
enable on page 35
logout on page 36
ping on page 37
show clock on page 39
show snmp on page 40
show version on page 41
telnet <ip address> on page 42
traceroute <ip address> on page 44

enable
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 show access-lists on page 342 for more
information.
Syntax Description
No subcommands.
Default Values
No default values are necessary for this command.
Command History
Release 1.1 Command 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 <password> on page 797 for more information.
Usage Examples
The following example enters the Enable Command mode and defines an Enable Command mode
password:
>enable
#configure terminal
(config)#enable password ADTRAN
At the next login, the following sequence must occur:
>enable
Password: ******
#

logout
Use the logout command to terminate the current session and return to the login screen.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example shows the logout command being executed in the Basic mode:
>logout
Session now available
Press RETURN to get started.

ping
Use the ping command (at the Basic Command mode prompt) to verify IP network connectivity.
Variations of this command include:
ping
ping <ip address | hostname>
ping <ip address | hostname> data <string>
ping <ip address | hostname> repeat <number>
ping <ip address | hostname> size <value>
ping <ip address | hostname> source <ip address>
ping <ip address | hostname> timeout <value>
ping <ip address | hostname> wait <value>
ping vrf <name> <ip address | hostname>
ping vrf <name> <ip address | hostname> data <string>
ping vrf <name> <ip address | hostname> repeat <number>
ping vrf <name> <ip address | hostname> size <value>
ping vrf <name> <ip address | hostname> source <ip address>
ping vrf <name> <ip address | hostname> timeout <value>
Syntax Description
<ip address | hostname> Optional. Specifies the IP address or host name of the system to ping. IP
addresses should be expressed in dotted decimal notation (for example,
10.10.10.1).
Entering the ping command with no specified IP address prompts the user
with parameters for a more detailed ping configuration. Refer to Functional
Notes (below) for more information.
data <string> Specifies an alphanumerical string to use (the ASCII equivalent) as the data
pattern in the ECHO_REQ packets.
repeat <number> Specifies the number of ping packets to send to the system. Valid range is
1 to 1000000.
size <value> Specifies the datagram size (in bytes) of the ping packet. Valid range is 1 to
1448 bytes.
source <ip address> Specifies the IP address to use as the source address in the ECHO_REQ
(or interface) packets. The source IP address must be a valid address local
to the router on the specified VPN routing and forwarding (VRF).
timeout <value> Specifies the timeout period after which the ping is considered
unsuccessful. Valid range is 1 to 5 seconds.
wait <value> Specifies the time to wait between sending test packets. Valid range is 100
to 60000 milliseconds.
vrf <name> Optional. Specifies the VRF where the IP address exists.
Default Values

Command History
Release 16.1 Command was expanded to include the vrf parameter.
Release 17.5 Command was expanded to include the wait keyword.
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). 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.
VRF on AOS products allows a single physical router to be partitioned into multiple virtual routers. Each
router instance has its own route table and interface assignments. Beginning with Release 16.1, all AOS
routers supporting multiple VRF instances (multi-VRF) have an unnamed default VRF instance regardless
of whether multi-VRF is configured. Therefore, executing the abovementioned commands without
specifying a VRF will only affect the default unnamed VRF.
Usage Examples
The following is an example of a successful ping command:
>ping
VRF Name [-default-]:
Target IP address:10.10.10.1
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

show clock
Use the show clock command to display the system time and date entered using the clock set command.
Refer to clock set <time> <day> <month> <year> on page 139 for more information.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example displays the current time and data from the system clock:
>show clock
23:35:07 UTC Tue Aug 20 2002

show snmp
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
Command History
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

show version
Use the show version command to display the current AOS version information.
Syntax Description
No subcommands.
Default Values
Command History
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”

telnet <ip address>

Use the telnet command to open a Telnet session (through AOS) to another system on the network.
Variations of this command include the following:
telnet <ip address | hostname>

telnet <ip address | hostname> port <tcp port>
telnet vrf <name> <ip address | hostname>
telnet vrf <name> <ip address | hostname> port <tcp port>
Syntax Description
<ip address | hostname> Specifies the IP address or host name of the remote system. IP addresses
should be expressed in dotted decimal notation (for example, 10.10.10.1).
port <tcp port> Optional. Specifies the Transmission Control Protocol (TCP) port number to
be used when connecting to a host through Telnet. Range is 1 to 65535.
vrf <name> Optional. Specifies the VPN routing and forwarding (VRF) where the IP
address or host name exists.
Default Values
Command History
Release 14.1 Command was expanded to specify the port number.
Functional Notes
Usage Examples
The following example opens a Telnet session with a remote system (10.200.4.15):
>enable
#telnet 10.200.4.15
User Access Login:
Password:

The following example opens a Telnet session with a remote system (10.200.4.15) on port 8010:
>enable
#telnet 10.200.4.15 port 8010
User Access Login:
Password:

traceroute <ip address>

Use the traceroute command to display the IP routes a packet takes to reach the specified destination.
traceroute
traceroute <ip address | hostname>
traceroute <ip address | hostname> source <ip address>
traceroute vrf <name> <ip address | hostname>
traceroute vrf <name> <ip address | hostname> source <ip address>
Syntax Description
<ip address | hostname> Optional. Specifies the IP address or host name of the remote system’s
route to trace.
source <ip address> Optional. Specifies the IP address of the interface to use as the source of
the trace. IP addresses should be expressed in dotted decimal notation (for
example, 10.10.10.1).
vrf <name> Optional. Specifies the VPN routing and forwarding (VRF) where the route
exists.
Default Values
Command History
Functional Notes
Usage Examples
The following is a sample traceroute output:
>enable
#traceroute 192.168.0.1
Tracing route to 192.168.0.1 over a maximum of 30 hops
1 22ms 20ms 20ms 192.168.0.65
2 23ms 20ms 20ms 192.168.0.1
#

Command Reference Guide Common Commands
COMMON COMMANDS
The following section contains descriptions of commands that are common across multiple command sets.
These commands are listed in alphabetical order.
alias “<text>” on page 46

cross-connect on page 47
description <text> on page 50
do on page 51
end on page 52
exit on page 53
interface on page 54
shutdown on page 61

alias “<text>”
Use the alias command to populate the ifAlias object identifier (OID) (Interface Table MIB of RFC 2863)
for all physical and virtual interfaces when using Simple Network Management Protocol (SNMP)
management stations. Use the no form of this command to remove an alias.
Syntax Description
“<text>” Describes the interface (for SNMP) using an alphanumeric character string
enclosed in quotation marks (limited to 64 characters).
Default Values
Applicable Command Modes

Applies to all interface mode command sets.
Command History
Functional Notes
The ifAlias OID is a member of the ifXEntry object-type (defined in RFC 2863) used to provide a
nonvolatile, 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:
(config-t1 1/1)#alias “CIRCUIT_ID_23-908-8887-401”
Technology Review
Please refer to RFC 2863 for more detailed information on the ifAlias display string.

cross-connect
Use the cross-connect command to create a cross-connection between a created time division multiplexing
(TDM) group on an interface to a virtual interface, or to create a cross-connection between a Point-to-Point
Protocol (PPP) interface and a Frame Relay interface for use with PPP over Frame Relay (PPPoFR).
cross-connect <number> <from interface> <to interface>

cross-connect <number> <from interface> <group number> <to interface>
Changing cross-connect settings could potentially result in service interruption.
Syntax Description
<number> Identifies the cross connection using a number descriptor or label (useful in
systems that allow multiple cross connections). Valid range is 1 to 1024.
<from interface> Specifies the interface (physical or virtual) on one end of the cross connection.
Specify an interface in the format <interface type [slot/port | slot/port.subinterface
id | interface id | interface id.subinterface id]>. For example, for a T1 interface, use
t1 0/1; for an Ethernet subinterface, use eth 0/1.1; and for an ATM subinterface,
use atm 1.1. Enter cross-connect 1 ? for a list of valid interfaces.
<group number> Optional. Specifies which configured TDM group to use for this cross connection.
This subcommand only applies to T1 physical interfaces.
<to interface> Specifies the virtual interface on the other end of the cross connection. Specify an
interface in the format <interface type [slot/port | slot/port.subinterface id |
interface id | interface id.subinterface id]>. For example, for a T1 interface, use
t1 0/1; for an Ethernet subinterface, use eth 0/1.1; for a PPP interface, use ppp 1;
and for an ATM subinterface, use atm 1.1. Use the ? to display a list of valid
interfaces.
Default Values
By default, there are no configured cross connections.

Command History
Release 5.1 Command was expanded to include the E1 interface.
Release 17.7 Command was expanded to include its use with the PPPoFR feature.

Functional Notes
Cross connections 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 PPP. This command
can be used both to connect the Frame Relay interface with a TDM group on a T1 circuit and to connect a
PPP interface to a Frame Relay interface for use with PPPoFR encapsulation. When using the
cross-connect command to connect a Frame Relay endpoint to a T1 interface, the command is issued
from the Frame Relay Interface Configuration mode or from the Global Configuration mode. When using
the cross-connect command to link a PPP interface to a Frame Relay interface in PPPoFR, the command
is issued from the PPP Interface Configuration mode.
Usage Examples
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)#interface frame-relay 1
(config-fr 1)#frame-relay lmi-type cisco
2. Create the subinterface and configure the PVC parameters (including DLCI and IP address):
(config-fr 1)#interface fr 1.1
(config-fr 1.1)#frame-relay interface-dlci 17
(config-fr 1.1)#ip address 168.125.33.252 255.255.255.252
3. Create the TDM group of 12 DS0s (64K) on the T1 physical interface:

(THIS STEP IS ONLY VALID FOR T1 INTERFACES.)
(config-t1 1/1)#tdm-group 1 timeslots 1-12 speed 64
(config-t1 1/1)#exit
4. Connect the Frame Relay subinterface with port T1 1/1:

(config)#cross-connect 1 t1 1/1 1 fr 1
The following example creates a PPP interface and connects it to the Frame Relay interface for use with
PPPoFR. The Frame Relay interface in this example is based on the interface configured in the previous
example.
1. Create the PPP interface and enter its configuration mode:

(config)#interface ppp 1
(config-ppp 1)#
2. Configure the PPP interface (including IP address and PPP authentication information):
(config-ppp 1)#ip address 65.162.109.202 255.255.255.252
(config-ppp 1)#ppp authentication chap
(config-ppp 1)#ppp chap hostname USERNAME
(config-ppp 1)#ppp chap password PASSWORD
(config-ppp 1)#no shutdown
3. Connect the PPP interface with the Frame Relay interface:

(config-ppp 1)#cross-connect 2 fr 1.1 ppp 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 interface frame-relay command) and set the signaling
method (using the frame-relay lmi-type command). Also included in the Frame Relay virtual endpoint are
all 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 7 and sets the signaling method to ansi.
(config-fr 7)#frame-relay lmi-type ansi
Step 2:
Create the subinterface and configure the permanent virtual circuit (PVC) parameters. Using the
subinterface, apply access policies to the interface, create bridging interfaces, configure dial-backup,
assign an IP address, and set the PVC data link connection identifier (DLCI). For example, the following
creates a Frame Relay subinterface labeled 22, sets the DLCI to 30, and assigns an IP address of
193.44.69.253 to the interface.
(config-fr 7)#interface fr 7.22

(config-fr 7.22)#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 tdm-group
command to specify the per-DS0 signaling rate on the interface. For example, the following creates a TDM
group labeled 9 containing 20 DS0s (each DS0 having a data rate of 56 kbps).
(config-t1 1/1)#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 5) to make an association between the Frame
Relay virtual interface (fr 7) and the TDM group configured on interface t1 1/1 (tdm-group 9).
(config)#cross-connect 5 t1 1/1 9 fr 7
The cross-connect command is also used by the PPP interface when using PPPoFR. PPPoFR can be
used with a single T1 circuit, when using Multilink PPP, or when using Multilink Frame Relay. Configuration
considerations vary according to the type of PPPoFR being used. For more information regarding
PPPoFR, refer to the PPPoFR Configuration Guide (article number 3114) available online at
http://kb.adtran.com.

description <text>
Use the description command to identify the specified interface (for example, circuit ID, contact
information, etc.). Use the no form of this command to remove a description.
Syntax Description
<text> Identifies the specified interface using up to 80 alphanumeric characters.
Default Values

Command History
Usage Examples
The following example enters comment information using the description command:
(config-t1 1/1)#description This is the Dallas office T1

do
Use the do command to execute any AOS command, regardless of the active configuration mode. It
provides a way to execute commands in other modes without taking the time to exit the current mode and
enter the desired one.
Syntax Description
No subcommands.
Default Values

Applies to all mode command sets.
Command History
Functional Notes
Use the do command to view configurations or interface states after configuration changes are made
without exiting to the Enable mode.
Usage Examples
The following example shows the do command used to view the Frame Relay interface configuration while
currently in the T1 Interface Configuration mode:
(config-t1 1/1)#do show interfaces fr 7
fr 7 is ACTIVE
Signaling type is ANSI signaling role is USER
Polling interval is 10 seconds full inquiry interval is 6 polling intervals
Output queue: 0/0 (highest/drops)
0 packets input 0 bytes
0 pkts discarded 0 error pkts 0 unknown protocol pkts
0 packets output 0 bytes
0 tx pkts discarded 0 tx error pkts

end
Use the end command to exit the current configuration mode and enter the Enable Security mode.
When exiting the Global Configuration mode, remember to perform a copy

running-config startup-config to save all configuration changes.
Syntax Description
No subcommands.
Default Values

Applies to all mode command sets except Basic mode.
Command History
Usage Examples
The following example shows the end command being executed in the T1 Interface Configuration mode:
(config-t1 1/1)#end
#
#- Enable Security mode command prompt

exit
Use the exit command to exit the current configuration mode and enter the previous one. For example,
using the exit command in an interface configuration mode will activate the Global Configuration mode.
When using the exit command in the Basic mode, the current session will be terminated.
When exiting the Global Configuration mode, remember to perform a copy

running-config startup-config to save all configuration changes.
Syntax Description
No subcommands.
Default Values

Applies to all mode command sets.
Command History
Usage Examples
The following example shows the exit command being executed in the Global Configuration mode:
(config)#exit
#
#- Enable Security mode command prompt

interface
Use the interface command to activate the interface command set for the specified physical or virtual
interface on an AOS unit. The following interfaces are considered physical interfaces and are available for
configuration based upon the hardware installed (ADSL, basic rate interface (BRI), digital data service
(DDS), digital signal level 1 cross connect (DSX-1), E1, Ethernet, facility data link (FDL), foreign
exchange office (FXO), foreign exchange station (FXS), G.703, high speed serial interface (HSSI),
modem, primary rate interface (PRI), serial, symmetric high-speed digital subscriber line (SHDSL), T1,
and T3). The following interfaces are considered virtual interfaces and are available for configuration
depending on the type of unit and the features enabled (ATM, BVI, demand, Frame Relay, HDLC,
loopback, port channel, PPP, tunnel, and VLAN).
This command can be issued from the Global Configuration mode prompt or from any configuration mode
to navigate to an interface configuration mode without issuing the exit command. The interface command
is also used to create virtual interfaces (this only applies to ATM, demand, Frame Relay, HDLC, loopback,
port channel, PPP, tunnel, and VLAN interfaces) prior to entering the configuration command set.
Type interface ? for a complete list of valid interface types on the unit. Refer to the command interface
range <interface type> <slot/port> - <slot/port> on page 813 for more information. Use the no form of
this command to delete a configured interface. Variations of this command include:
interface adsl <slot/port>

interface atm <port | port.sublink>
interface bri <slot/port>
interface bvi <interface id>
interface cellular <slot/port>
interface dds <slot/port>
interface demand <interface id>
interface dot11ap <ap | ap/radio | ap/radio.vap>
interface e1 <slot/port>
interface ethernet <slot/port>
interface fdl <slot/port>
interface frame-relay <port | port.sublink>
interface fxo <slot/port>
interface fxs <slot/port>
interface gigabit-ethernet <slot/port>
interface hdlc <interface id>
interface hssi <slot/port>
interface loopback <interface id>
interface modem <slot/port>
interface port-channel <interface id>
interface ppp <interface id>
interface pri <slot/port>
interface serial <slot/port>
interface shdsl <slot/port>
interface switchport <slot/port>
interface t1 <slot/port>

interface t3 <slot/port>
interface tunnel <interface id>
interface vlan <interface id>
Syntax Description
adsl <slot/port> Identifies asymmetric digital subscriber line (ADSL) interfaces.
Slot and port number ranges are dependent upon the hardware
installed in the unit. Type interface adsl ? for information
regarding valid ranges.
atm <port | port.sublink> Identifies and creates asynchronous transfer mode (ATM) virtual
interfaces or subinterfaces. Port number range is 1 to 1024.
Sublink number range is 1 to 65535.
bri <slot/port> Identifies basic rate interfaces (BRIs). Slot and port number
ranges are dependent upon the hardware installed in the unit.
Type interface bri ? for information regarding valid ranges.
bvi <interface id> Identifies bridged virtual interfaces (BVIs). This ID must
correspond to an existing bridge group. Valid range is 1 to 255.
cellular <slot/port> Identifies cellular interfaces. Slot numbers are either 0 or 1. Port
numbers begin at 1 with a range dependent on the unit.
dds <slot/port> Identifies digital data service (DDS) interfaces. Slot and port
number ranges are dependent upon the hardware installed in the
unit. Type interface dds ? for information regarding valid ranges.
demand <interface id> Identifies and creates demand routing interfaces. Valid range is
1 to 1024.
dot11ap <ap | ap/radio | ap/radio.vap> Identifies wireless access point (AP), radio, and/or virtual access
point (VAP) interfaces. The AP number range is 1 to 8. The radio
is either 1 or 2. The VAP number range is 1 to 8.
e1 <slot/port> Identifies E1 interfaces. Slot and port number ranges are
dependent upon the hardware installed in the unit. Type interface
e1 ? for information regarding valid ranges.
ethernet <slot/port> Identifies Ethernet interfaces. Slot and port number ranges are
ethernet ? for information regarding valid ranges.
fdl <slot/port> Identifies facility data link (FDL) interfaces. Slot and port number
Type interface fdl ? for information regarding valid ranges.
frame-relay <port | port.sublink> Identifies and creates Frame Relay interfaces. Port number range
is 1 to 1024. Sublink range is 1 to 1007.
fxo <slot/port> Identifies foreign exchange office (FXO) interfaces. Slot and port
unit. Type interface fxo ? for information regarding valid ranges.
fxs <slot/port> Identifies foreign exchange station (FXS) interfaces. Slot and port
unit. Type interface fxs ? for information regarding valid ranges.

gigabit-ethernet <slot/port> Identifies gigabit Ethernet interfaces. Slot and port number ranges
are dependent upon the hardware installed in the unit. Type
interface gigabit-ethernet ? for information regarding valid
ranges.
hdlc <interface id> Identifies and creates high level data link control (HDLC)
interfaces. Valid range is 1 to 1024.
hssi <slot/port> Identifies high speed serial interfaces (HSSIs). Slot and port
unit. Type interface hssi ? for information regarding valid ranges.
loopback <interface id> Identifies and creates loopback interfaces. Valid range is 1 to
1024.
modem <slot/port> Identifies analog modem interfaces. Slot and port number ranges
are dependent upon the hardware installed in the unit. Type
interface modem ? for information regarding valid ranges.
port-channel <interface id> Creates and configures link aggregation interfaces. Valid range is
1 to 6.
ppp <interface id> Identifies and creates Point-to-Point Protocol (PPP) interfaces.
Valid range is 1 to 1024.
pri <slot/port> Identifies primary rate interfaces (PRIs). Slot and port number
Type interface pri ? for information regarding valid ranges.
serial <slot/port> Identifies serial ports. Slot and port number ranges are dependent
upon the hardware installed in the unit. Type interface serial ? for
information regarding valid ranges.
shdsl <slot/port> Identifies symmetric high-speed digital subscriber lline (SHDSL)
interfaces. Slot and port number ranges are dependent upon the
hardware installed in the unit. Type interface shsdl ? for
information regarding valid ranges.
switchport <slot/port> Identifies switchport interfaces. Slot and port number ranges are
switchport ? for information regarding valid ranges.
t1 <slot/port> Identifies T1 interfaces. Slot and port number ranges are
t1 ? for information regarding valid ranges.
t3 <slot/port> Identifies T3 interfaces. Slot and port number ranges are
t3 ? for information regarding valid ranges.
tunnel <interface id> Identifies and creates generic routing encapsulation (GRE) tunnel
interfaces. Valid range is 1 to 1024.
vlan <interface id> Identifies and creates virtual local area network (VLAN) interfaces.

Default Values
By default, an interface is inactive. To activate the interface, enter the no shutdown command from within
the specific interface command set; for example, (config-ppp 7)#no shutdown. There are no default
values for these commands.
Command History
Release 3.1 Command was expanded to include the loopback interface.
Release 8.1 Command was expanded to include the asynchronous transfer
mode (ATM) interface.
Release 9.1 Command was expanded to include the high level data link control
(HDLC) interface.
Release 11.1 Command was expanded to include demand, foreign exchange
office (FXO), and primary rate interface (PRI) interfaces.
Release 15.1 Command was expanded to allow navigation from one interface to
another without exiting the current configuration mode. Also
expanded to include access point (AP), radio, virtual access point
(VAP), and bridged virtual interface (BVI) interfaces.
Release 17.2 Command was expanded to include cellular interface.
Functional Notes
When identifying a physical interface slot and port, keep the following in mind:
• Built-in nonremovable interfaces are identified by slot 0.

• Removable interfaces are identified by the physical labels on the slots.
• Interfaces are numbered per slot, from left to right, starting with 1.
Usage Examples
The following example uses the interface command to navigate from the T1 Interface Configuration mode
to a Frame Relay interface:
(config-t1 1/1)#interface fr 7
(config-fr 7)#

The following examples activate the interface configuration mode for the specified interface type:
For an ADSL interface:

(config-adsl 1/1)#
For an ATM subinterface:
(config)#interface atm 1.1

(config-atm 1.1)#
For a BRI interface:
(config)#interface bri 1/2

(config-bri 1/2)#
For a BVI interface:
(config)#bridge irb
(config-bvi 1)#
For a cellular interface:
(config)#interface cellular 1/1

For a DDS interface:
(config)#interface dds 1/1

(config-dds 1/1)#
For a demand interface:
(config)#interface demand 1
(config-demand 1)#
For an E1 interface:
(config)#interface e1 1
(config-e1 1)#
For an Ethernet interface:
(config)#interface ethernet 0/1

(config-eth 0/1)#
For an Ethernet subinterface:

(config)#interface eth 0/1.1
(config-eth 0/1.1)#

For an FDL interface:
(config)#interface fdl 1/1

(config-fdl 1/1)#
For a Frame Relay subinterface:
(config)#interface frame-relay 1.16

(config-fr 1.16)#
For an FXO interface:
(config)#interface fxo 0/1

(config-fxo 0/1)#
For an FXS interface:
(config)#interface fxs 2/1

(config-fxs 2/1)#
For a Gigabit Ethernet interface:
(config)#interface gigabit-ethernet 0/3

For an HDLC interface:
(config)#interface hdlc 1
(config-hdlc 1)#
For an HSSI interface:
(config)#interface hssi 1/1

(config-hssi 1/1)#
For a loopback interface:
(config)#interface loopback 8
(config-loop 8)#
For a modem interface:
(config)#interface modem 1/1

(config-modem 1/1)#
For a port channel interface:
(config)#interface port-channel 6
Creating Port Channel interface 6.
(config-p-chan6)#

For a PPP interface:

(config-ppp 100)#
For a PRI interface:
(config)#interface pri 2
(config-pri 2)#
For a serial interface:
(config)#interface serial 1/1

(config-serial 1/1)#
For an SHDSL interface:
(config)#interface shdsl 1/1

(config-shdsl 1/1)#
For a switchport interface:
(config)#interface switchport 0/2

(config-swx 0/2)#
For a T1 interface:
(config-t1 1/1)#
For a T3 interface:
(config-t3 1/1)#
For a tunnel interface:
(config)#interface tunnel 300

(config-tunnel 300)#
For a VLAN interface:
(config)#interface vlan 300

(config-vlan 300)#
For a wireless access point:
(config)#interface dot11ap 1/1.1


shutdown
Use the shutdown command to disable the interface (both physical and virtual) so that no data will be
passed through. Use the no form of this command to turn on the interface and allow it to pass data. By
default, all interfaces are disabled.
Syntax Description
No subcommands.
Default Values
By default, all interfaces are disabled.

Command History
Usage Examples
The following example administratively disables the modem interface:

(config-modem 1/2)#shutdown

Command Reference Guide Enable Mode Command Set
ENABLE MODE COMMAND SET
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
#
In AOS Release 17.1, output modifiers were introduced for all show commands. These modifiers help
specify the information displayed in the show command output. The modifiers are appended to the end of
the show command, preceded by the pipe character (|), and followed by the <text> to exclude, include, or
with which to begin the display. The following output modifiers are common for all show commands:
| begin <text> Produces output that begins with lines, including the specified text and
every line thereafter.
| exclude <text> Produces output that excludes any lines containing the specified text.
| include <text> Produces output that only displays lines with the specified text.
In the following example, the show command was modified to begin its display with the lines ip http
server and display all lines thereafter:
#show run | begin ip http server

no ip http server
no ip http secure-server
no ip snmp agent
no ip ftp server
ip ftp server default-filesystem flash
no ip scp server
no ip sntp server
!
In the following example, the exclude modifier was used with the show command to exclude lines of text
containing the words no shutdown:
#show run interface ppp 1 | exclude no shutdown

!
!
interface ppp 1
ip address 10.2.0.1 255.255.255.0
access-policy UNTRUSTED
crypto map SITE2SITE
no lldp send-and-receive
cross-connect 1 t1 1/1 1 ppp 1
!

In the following example, the include modifier was used with the show command to only display
information about interfaces:
#show run | include interface

interface switchport 0/1
--MORE--
this guide. For more information, refer to the section listed below:
exit on page 53
clear commands begin on page 65

clock auto-correct-dst on page 137
clock no-auto-correct-dst on page 138
clock set <time> <day> <month> <year> on page 139
clock timezone <value> on page 140
configure on page 143
copy on page 144
copy cflash on page 146
copy console on page 149
copy dynvoice-config on page 150
copy flash on page 153
copy http on page 156
copy https on page 158
copy ramdisk on page 160
copy running-config on page 163
copy startup-config on page 166
copy tftp on page 169
copy xmodem on page 171
debug commands begin on page 173
dir on page 317
disable on page 319
erase on page 320
events on page 322

exception report generate on page 323

factory-default on page 324
logout on page 325
ping on page 326
ping ethernet on page 329
ping stack-member <number> on page 332
ping twamp on page 333
ramdisk <size> on page 335
reload on page 336
reload dot11 interface dot11ap <ap interface> on page 337
run audit security on page 338
run-tcl <filename> track <name> on page 341
show commands begin on page 342
sip check-sync on page 697
telnet on page 698
telnet stack-member <unit id> on page 700
telnet vrf <name> stack-member <number> on page 701
terminal length <number> on page 702
traceroute on page 703
traceroute ethernet on page 704
undebug all on page 707
verify-file on page 708
vlan database on page 709
voice dsp capture on page 710
voice loopback-call on page 711
wall <message> on page 712
write on page 713

clear access-list <name>

Use the clear access-list command to clear all counters associated with all access control lists (ACLs) or a
specified ACL.
Syntax Description
<name> Optional. Specifies the name (label) of an ACL.
Default Values
Command History
Usage Examples
The following example clears all counters for the access control list labeled MatchAll:
>enable
#clear access-list MatchAll

clear arp-cache
Use the clear arp-cache command to remove all dynamic entries from the Address Resolution Protocol
(ARP) cache table. Variations of this command include:
clear arp-cache
clear arp-cache vrf <name>
Syntax Description
vrf <name> Optional. Clears the ARP cache entry for a specific VPN routing and
forwarding (VRF).
Default Values
Command History
Release A1 Command was expanded to include the vrf parameter.
Usage Examples
The following example removes all dynamic entries from the ARP cache:
>enable
#clear arp-cache

clear arp-entry <ip address>

Use the clear arp-entry command to remove a single entry from the Address Resolution Protocol (ARP)
cache. Variations of this command include:
clear arp-entry <ip address>

clear arp-entry <ip address> vrf <name>
Syntax Description
<ip address> Specifies a valid IP address to remove. IP addresses should be expressed
in dotted decimal notation (for example, 10.10.10.1).
vrf <name> Optional. Clears the ARP entry for a specific VPN routing and forwarding
(VRF).
Default Values
Command History
Release A1 Command was expanded to include the vrf parameter.
Usage Examples
The following example removes the entry for 10.10.10.1 from the ARP cache:
>enable
#clear arp-entry 10.10.10.1

clear bridge <number>

Use the clear bridge command to clear all counters associated with bridging (or for a specified bridge
group). Variations of this command include:
clear bridge
clear bridge <number>
Syntax Description
<number> Optional. Specifies a single bridge group. Range is 1 to 255.
Default Values
Command History
Usage Examples
The following example clears all counters for bridge group 17:
>enable
#clear bridge 17

clear buffers max-used

Use the clear buffers max-used command to clear the maximum-used statistics for buffers displayed in
the show memory heap command.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears the maximum-used buffer statics:
>enable
#clear buffers max-used

clear counters <interface>

Use the clear counters command to clear all interface counters (or the counters for a specified interface).
Syntax Description
<interface> Specifies an interface in the format <interface type [slot/port |
slot/port.subinterface id | interface id | interface id.subinterface id | ap |
ap/radio | ap/radio.vap]>. For example, for a T1 interface, use t1 0/1; for an
Ethernet subinterface, use eth 0/1.1; for a PPP interface, use ppp 1; for an
ATM subinterface, use atm 1.1; and for a wireless virtual access point, use
dot11ap 1/1.1. Type clear counters ? or show interface ? for a complete
list of interfaces.
Default Values
Command History
Release 9.1 Command was expanded to include the high level data link control (HDLC)
and tunnel interfaces.
Usage Examples
The following example clears all counters associated with the Ethernet 0/1 interface:
>enable
#clear counters ethernet 0/1

clear counters ethernet cfm

Use the clear counters ethernet cfm command to clear all statistics held by Ethernet operations,
administration, and maintenance (OAM) connectivity fault management (CFM) maintenance endpoints
(MEPs). Variations of this command include:
clear counters ethernet cfm

clear counters ethernet cfm domain <domain name> association <association name>
clear counters ethernet cfm domain none association <association name>
clear counters ethernet cfm interface <interface>
clear counters ethernet cfm level <level>
clear counters ethernet cfm mep-id <mep id>
Syntax Description
domain <domain name> Optional. Specifies that only statistics for MEPs in the named domain
are cleared.
domain none Optional. Specifies that no domain is named and all MEP statistics,
regardless of domain, are cleared.
association <association name> Optional. Specifies that only statistics for MEPs in the named
association are cleared.
interface <interface> Optional. Specifies that only statistics for MEPs configured on the
specified interface are cleared. Specify an interface in the format
<interface type [slot/port | slot/port.subinterface id | interface id |
interface id.subinterface id]>. For example, for an Ethernet
subinterface, use eth 0/1.1. For a list of appropriate interface, enter
interface ? at the prompt.
level <level> Optional. Specifies that only statistics for MEPs within the specified
maintenance domain level are cleared. Level range is 0 to 7.
mep-id <mep id> Optional. Specifies that only statistics for MEPs with the specified MEP
ID are cleared. MEP ID range is 1 to 8191.
Default Values
No default values necessary for this command.
Command History
Functional Notes
For more information regarding Ethernet OAM CFM and its operation on AOS products, refer to the
Ethernet OAM CFM in AOS configuration guide available on the AOS Documentation CD shipped with
your product or online at http://kb.adtran.com (article number 3013).

Usage Examples
The following example clears all statistics associated with Ethernet OAM CFM MEPs:
>enable
#clear counters ethernet cfm
The following example clears all statistics associated with MEPs on maintenance domain level 5:
>enable
#clear counters ethernet cfm level 5

clear counters media-gateway

Use the clear counters media-gateway command to reset cumulative totals for all Realtime Transport
Protocol (RTP) channels or for a specific RTP channel. Variations of this command include the following:
clear counters media-gateway

clear counters media-gateway channel <value>
clear counters media-gateway dtmf
Syntax Description
channel <value> Optional. Specifies the ID of a particular media-gateway channel to be reset
(for example, 0/1.1).
dtmf Optional. Specifies that dual tone multi-frequency (DTMF) counters are
reset.
Default Values
Command History
Release A2 Command was expanded to include the dtmf parameter.
Usage Examples
The following example resets the counters on media gateway channel 0/1.1:
>enable
#clear counters media-gateway channel 0/1.1
Counters on media-gateway channel reset by console.

clear counters probe

Use the clear counters probe command to reset counters on all probe objects or on a specific probe.
clear counters probe

clear counters probe <name>
Syntax Description
<name> Specifies a probe object to reset counter.
Default Values
Command History
Usage Examples
The following example resets the counters for all configured probes:
>enable
#clear counters probe
The following example resets the counters only for the probe named probe_A:
>enable
#clear counters probe probe_A

clear counters track

Use the clear counters track command to reset counters on all track objects or on a specifically named
track.
clear counters track

clear counters track <name>
Syntax Description
<name> Specifies a track object to reset counter.
Default Values
Command History
Usage Examples
The following example resets the counters for all configured tracks:
>enable
#clear counters track
The following example resets the counters only for the track named track_1:
>enable
#clear counters track track_1

clear counters vlan <vlan id>

Use the clear counters vlan command to reset counters on the specified virtual local area network
(VLAN) interface.
Syntax Description
<vlan id> Specifies a valid VLAN interface ID. Range is 1 to 4094.
Default Values
Command History
Usage Examples
The following example resets the counters on VLAN interface 7:
>enable
#clear counters vlan 7

clear counters voice-trunk

Use the clear counters voice-trunk command to reset counters on all voice trunks or on a specific voice
trunk. Variations of this command include:
clear counters voice-trunk all

clear counters voice-trunk <trunk id>
Syntax Description
all Clears all voice trunk counters.
<trunk id> Specifies clearing a specific voice trunk using the trunk's 2-digit identifier
following T (for example, T01).
Default Values
Command History
Usage Examples
The following example resets the counters for all configured voice trunks:
>enable
#clear counters voice-trunk all

clear crypto ike sa

Use the clear crypto ike sa command to clear existing Internet key exchange (IKE) security associations
(SAs). Use the policy and remote-id options to clear specific SAs without clearing them all. Variations of
this command include:
clear crypto ike sa

clear crypto ike sa peak
clear crypto ike sa policy <value>
clear crypto ike sa remote-id <remote id>
Syntax Description
peak Optional. Clears the peak IKE SA count reached.
policy <value> Optional. Removes all IKE SAs associated with the specified policy priority
value. This number is assigned using the command crypto ike on page 780.
remote-id <remote id> Optional. Removes all IKE SAs associated with the specified IKE remote ID. A
delete payload is sent to the peers prior to deletion of the SA. This
command is preferred to the clear crypto ike sa policy <value> command
when multiple unique SAs have been created on the same IKE policy, but
the user wants to delete only the SA to a unique peer.
Default Values
Command History
Release 12.1 Command was expanded to include the policy and remote-id parameters.
Release 17.5 Command was expanded to include the peak parameter.
Usage Examples
The following example clears the entire database of IKE SAs (including the active associations):
>enable
#clear crypto ike sa
The following example clears IKE SAs associated with policy 101:
>enable
#clear crypto ike sa policy 101
The following example clears an IKE SA associated with remote-id netvanta:
>enable
#clear crypto ike sa remote-id netvanta

clear crypto ipsec sa

Use the clear crypto ipsec sa command to clear existing Internet Protocol security (IPsec) security
associations (SAs), including active ones. Variations of this command include the following:
clear crypto ipsec sa

clear crypto ipsec sa entry <ip address> ah <SPI>
clear crypto ipsec sa entry <ip address> esp <SPI>
clear crypto ipsec sa map <name>
clear crypto ipsec sa peak
clear crypto ipsec sa peer <ip address>
clear crypto ipsec sa remote-id <remote-id>
Syntax Description
entry <ip address> Optional. Clears only the SAs related to the specified destination IP
address. IP addresses should be expressed in dotted decimal notation (for
example, 10.10.10.1).
ah <SPI> Optional. Clears only a portion of the SAs by specifying the Authentication
Header (AH) Protocol and a security parameter index (SPI). You can
determine the correct SPI value using the show crypto ipsec sa
command.
esp <SPI> Optional. Clears only a portion of the SAs by specifying the Encapsulating
Security Payload (ESP) Protocol and an SPI. You can determine the correct
SPI value using the show crypto ipsec sa command.
map <name> Optional. Clears only the SAs associated with the specified crypto map.
peak Optional. Clears the peak IPsec SA count reached.
peer <ip address> Optional. Clears only the SAs associated with the specified far-end IP
address. IP addresses should be expressed in dotted decimal notation (for
example, 10.10.10.1).
remote-id <remote-id> Optional. Removes all IPsec SAs associated with the specified IPsec remote
ID.
Default Values
Command History
Release 15.1 Command was expanded to include the remote-id parameter.
Release 17.5 Command was expanded to include the peak parameter.

Usage Examples
The following example clears all IPsec SAs:
>enable
#clear crypto ipsec sa
The following example clears the IPsec SA used for ESP traffic with the SPI of 300 to IP address
63.97.45.57:
>enable
#clear crypto ipsec sa entry 63.97.45.57 esp 300

clear desktop-auditing
Use the clear desktop-auditing command to remove the collected network access protection (NAP)
statistics for clients connected to the network. Statistics can be cleared for a single client or for all clients.
clear desktop-auditing
clear desktop-auditing host <hostname>
clear desktop-auditing interface gigabit-switchport <slot/port>
clear desktop-auditing ip <ip address>
clear desktop-auditing mac <mac address>
clear desktop-auditing vlan <vlan id>
Syntax Description
host <hostname> Optional. Clears the statistics for the client with the specified
host name.
interface gigabit-switchport <slot/port> Optional. Clears the statistics for the client using the specified
interface.
ip <ip address> Optional. Clears the statistics for the client with the specified
IP address. IP addresses should be expressed in dotted
decimal notation (for example, 10.10.10.1).
mac <mac address> Optional. Clears the statistics for the client with the specified
medium access control (MAC) address. MAC addresses
should be expressed in the following format: xx:xx:xx:xx:xx:xx
(for example, 00:A0:C8:00:00:01).
vlan <vlan id> Optional. Clears the statistics for the client with the specified
virtual local area network (VLAN) identification number.
VLAN IDs range from 1 to 4096.
Default Values
Command History
Usage Examples
The following example clears all collected NAP statistics for all clients:
>enable
#clear desktop-auditing

The following example clears all collected NAP statistics for the client with the MAC address
00:A0:C8:00:00:01:
>enable
#clear desktop-auditing mac 00:A0:C8:00:00:01

clear dot11 client <mac address>

Use the clear dot11 client command to disassociate with the client that has the specified medium access
control (MAC) address.
Syntax Description
<mac address> Specifies the MAC address of the client for which disassociation is desired.
MAC addresses should be expressed in the following format:
xx:xx:xx:xx:xx:xx (for example, 00:A0:C8:00:00:01).
Default Values
Command History
Release15.1 Command was introduced.
Usage Examples
The following example disassociates with a client with the MAC address 00:40:96:AB:38:5E:
>enable
#clear dot11 client 00:40:96:AB:38:5E
This Station has been removed.

clear dump-core
The clear dump-core command clears diagnostic information appended to the output of the show version
command. This information results from an unexpected unit reboot.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears the entire database of Internet key exchange (IKE) SAs (including the active
associations):
>enable
#clear dump-core

clear ethernet cfm mep remote

Use the clear ethernet cfm remote command to clear remote maintenance endpoint (MEP) entries from
the Ethernet operations, administration, and maintenance (OAM) connectivity fault management (CFM)
continuity check message (CCM) database. Variations of this command include:
clear ethernet cfm mep remote

clear ethernet cfm mep remote domain <domain name> association <association name>
clear ethernet cfm mep remote domain none association <association name>
clear ethernet cfm mep remote mep-id <mep id>
clear ethernet cfm mep remote remote-mep <mep id>
Syntax Description
domain <domain name> Optional. Specifies that only statistics for remote MEPs in the named
domain are cleared.
domain none Optional. Specifies that no domain is named and all remote MEP
statistics, regardless of domain, are cleared.
association <association name> Optional. Specifies that only statistics for remote MEPs in the named
association are cleared.
mep-id <mep id> Optional. Specifies that only statistics for local MEPs with the specified
MEP ID are cleared. MEP ID range is 1 to 8191.
remote mep-id <mep id> Optional. Specifies that only statistics for remote MEPs with the
specified MEP ID are cleared. MEP ID range is 1 to 8191.
Default Values
Command History
Functional Notes
Usage Examples
The following example clears all CCM entries for all remote MEPs:
>enable
#clear ethernet cfm mep remote

clear event-history
Use the clear event-history command to clear all messages logged to the local event-history.
Messages cleared from the local event-history (using the clear event-history command) are
no longer accessible.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all local event-history messages:
>enable
#clear event-history

clear gvrp statistics

Use the clear gvrp statistics command to clear counter statistics on GARP VLAN Registration Protocol
(GVRP) interfaces. Variations of this command include:
clear gvrp statistics all

clear gvrp statistics interface <interface>
Syntax Description
all Clears the information for all GVRP interfaces.
interface <interface> Clears the information for the specified interface. Specify an interface in the
format <interface type [slot/port | slot/port.subinterface id | interface id |
interface id.subinterface id | ap | ap/radio | ap/radio.vap]>. For example, for
a T1 interface, use t1 0/1; for an Ethernet subinterface, use eth 0/1.1; for a
PPP interface, use ppp 1; for an ATM subinterface, use atm 1.1; and for a
wireless virtual access point, use dot11ap 1/1.1. Type clear gvrp statistics
interface ? for a complete list of applicable interfaces.
Default Values
Command History
Usage Examples
The following example clears counter statistics on the GVRP interfaces:
>enable
#clear gvrp statistics all

clear host
Use the clear host command to clear a host name when using the domain naming system (DNS) proxy.
clear host *
clear host <hostname>
clear host vrf <name> <hostname>
Syntax Description
* Clears all hosts from the host table.
<hostname> Clears a specific host entry from the host-to-address table.
vrf <name> Optional. Clears the host table entry for a specific VPN routing and
forwarding (VRF).
Default Values
Command History
Functional Notes
Usage Examples
The following example clears all dynamic host names:
>enable
#clear host *

clear ip bgp
Use the clear ip bgp command to clear Border Gateway Protocol (BGP) neighbors as specified. Variations
of this command include:
clear ip bgp [* | <number> | <ip address>] in

clear ip bgp [* | <number> | <ip address>] out
clear ip bgp [* | <number> | <ip address>] soft
Syntax Description
* Clears all BGP neighbors.
<number> Clears all BGP neighbors with the specified autonomous system (AS)
number. Range is 1 to 65535.
<ip address> Clears the BGP neighbor with the specified IP address. IP addresses
in Causes a soft reset inbound with a neighbor, reprocessing routes
advertised by that neighbor.
out Causes a soft reset outbound with a neighbor, resending advertised routes
to that neighbor.
soft Causes a soft reset both inbound and outbound.
Default Values
Command History
Functional Notes
The clear ip bgp command must be issued to re-initialize the BGP process between the peers matching
the given arguments. Most neighbor changes, including changes to prefix-list filters, do not take effect until
the clear command is issued. A hard reset clears the Transmission Control Protocol (TCP) connection with
the specified peers, which results in clearing the table. This method of clearing is disruptive and causes
peer routers to record a route flap for each route.
The out version of this command provides a soft reset out to occur by causing all routes to be re-sent to
the specified peer(s). TCP connections are not torn down, so this method is less disruptive. Output
filters/policies are re-applied before sending the update.
The in version of this command provides a soft reset in to occur by allowing the router to receive an
updated table from a peer without tearing down the TCP connection. This method is less disruptive and
does not count as a route flap. Currently, all of the peer's routes are stored permanently, even if they are
filtered by a prefix list. The command causes the peer's routes to be reprocessed with any new
parameters.

Usage Examples
The following example causes a hard reset with peers with an AS number of 101:
>enable
#clear ip bgp 101

clear ip cache
Use the clear ip cache command to delete cache table entries. Add the counters parameter to reset the
counters on the cache table. The command can be limited to a specific VPN routing and forwarding (VRF).
clear ip cache
clear ip cache counters
clear ip cache vrf <name>
clear ip cache vrf <name> counters
Syntax Description
counters Optional. Resets counters in the cache table.
vrf <name> Optional. Clears all fast-cache entries for a specific VRF.
Default Values
Command History
Release 14.1 Command was expanded to include the counters parameter.
Functional Notes
Usage Examples
The following example removes all entries from the cache table:
>enable
#clear ip cache
The following example resets all fast-cache entries just for the VRF RED:
>enable
#clear ip cache vrf RED counters

clear ip dhcp-server binding

Use the clear ip dhcp-server binding command to clear Dynamic Host Configuration Protocol (DHCP)
server binding entries. Variations of this command include:
clear ip dhcp-server binding *

clear ip dhcp-server binding <ip address>
clear ip dhcp-server binding vrf <name> *
clear ip dhcp-server binding vrf <name> <ip address>
Syntax Description
* Clears all automatic DHCP server binding entries.
vrf <name> Optional. Clears DHCP server binding entries on the specified VPN routing
and forwarding (VRF) instance.
<ip address> Clears a specific DHCP server binding associated with an IP address.
IP addresses should be expressed in dotted decimal notation (for example,
10.10.10.1).
Default Values
Command History
Usage Examples
The following example clears all DHCP server bindings on the default VRF:
>enable
#clear ip dhcp-server binding *
The following example clears all DHCP server bindings from the VRF RED:
>enable
#clear ip dhcp-server binding vrf RED *

clear ip ffe
Use the clear ip ffe command to remove the RapidRoute Engine entries on all interfaces or on a specific
interface. Variations of this command include:
clear ip ffe <interface>

clear ip ffe ipsec
clear ip ffe ipsec <rapidroute interface ID>
Syntax Description
slot/port.subinterface id | interface id | interface id.subinterface id]>. For
example, for a T1 interface, use t1 0/1; for an Ethernet subinterface, use
eth 0/1.1; for a PPP interface, use ppp 1; for an ATM subinterface, use atm
1.1. Type clear ip ffe? for a complete list of valid interfaces.
ipsec Specifies that all RapidRoute entries to and from an Internet Protocol
security (IPsec) security association (SA) are cleared.
<rapidroute interface ID> Specifies that RapidRoute entries to and from an IPsec SA on a specified
RapidRoute interface are cleared. RapidRoute interface identifiers range
from 1 to 16777215.
Default Values
Command History
Release 17.6 Command was expanded to include ipsec parameters.
Usage Examples
The following example clears all RapidRoute entries for the Ethernet 0/1 interface:
>enable
#clear ip ffe ethernet 0/1

clear ip flow stats

Use the clear ip flow stats command to clear all statistics associated with an integrated traffic monitoring
(ITM) observation point.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all ITM statistics associated with an observation point:
#clear ip flow stats

clear ip flow top-talkers

Use the clear ip flow top-talkers command to clear all statistics associated with integrated traffic
monitoring (ITM) Top Talker listings.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all Top Talker statistics:
#clear ip flow top-talkers

clear ip igmp group

Use the clear ip igmp group command to clear entries from the Internet Group Management Protocol
(IGMP) tables. If no address or interface is specified, all nonstatic IGMP groups are cleared with this
command. Variations of this command include:
clear ip igmp group

clear ip igmp group <multicast address>
clear ip igmp group <interface>
Syntax Description
<multicast address> Optional. Clears the IGMP tables of a specific multicast group IP address. The
multicast group IP address range is 244.0.0.0 to 239.255.255.255 or
224.0.0.0 /4.
<interface> Optional. Clears the IGMP tables of all interfaces of the specified type or a
specific interface of a particular type. Specify an interface in the format
<interface type [slot/port | slot/port.subinterface id | interface id | interface
id.subinterface id | ap | ap/radio | ap/radio.vap]>. For example, for a T1
interface, use t1 0/1; for an Ethernet subinterface, use eth 0/1.1; for a PPP
interface, use ppp 1; for an ATM subinterface, use atm 1.1; and for a
wireless virtual access point, use dot11ap 1/1.1. Type clear ip igmp group
? for a list of valid interfaces.
Default Values
Command History
Release 9.1 Command was expanded to include the high-bit-rate digital subscriber line
(HDSL) and tunnel interfaces.
Usage Examples
The following example clears all statistics from the IGMP tables for all nonstatic IGMP groups:
>enable
#clear ip igmp group

clear ip ospf
Use the clear ip ospf command to reset open shortest path first (OSPF) information. Variations of this
command include:
clear ip ospf process

clear ip ospf redistribution
Syntax Description
process Restarts the OSPF process.
redistribution Refreshes routes redistributed over OSPF.
Default Values
Command History
Usage Examples
The following example resets the OSPF process:
>enable
#clear ip ospf process

clear ip policy-sessions
Use the clear ip policy-sessions command to clear policy class sessions. You may clear all the sessions or
a specific session. Use the show ip policy-sessions command to view a current session listing. The
following lists the complete syntax for the clear ip policy-sessions commands:
clear ip policy-sessions
clear ip policy-sessions <class name> [ahp | esp | gre | icmp | tcp | udp | <protocol>] <source ip>
<source port> <dest ip> <dest port>
clear ip policy-sessions <class name> [ahp | esp | gre | icmp | tcp | udp | <protocol>] <source ip>
<source port> <dest ip> <dest port> [destination | source] <nat ip> <nat port>
clear ip policy-sessions any-vrf
clear ip policy-sessions vrf <name>
clear ip policy-sessions vrf <name> <policy class name> [ahp | esp | gre | icmp | tcp | udp |
<protocol>] <source ip> <source port> <dest ip> <dest port>
clear ip policy-sessions vrf <name> <policy class name> [ahp | esp | gre | icmp | tcp | udp |
<protocol>] <source ip> <source port> <dest ip> <dest port> [destination | source] <nat ip>
<nat port>
Syntax Description
<class name> Alphanumeric descriptor for identifying the configured access policy
(access policy descriptors are not case sensitive).
ahp Specifies Authentication Header (AH) Protocol.
esp Specifies Encapsulating Security Payload (ESP) Protocol.
gre Specifies Generic Routing Encapsulation (GRE) Protocol.
icmp Specifies Internet Control Message Protocol (ICMP).
tcp Specifies Transmission Control Protocol (TCP).
udp Specifies User Datagram Protocol (UDP).
<protocol> Specifies a protocol. Valid range is 0 to 255.
<source ip> Specifies the source IP address. IP addresses should be expressed in
dotted decimal notation (for example, 10.10.10.1).
<source port> Specifies the source port (in hex format AH, ESP, and GRE; decimal for all
other protocols).
<dest ip> Specifies the destination IP address. IP addresses should be expressed in
<dest port> Specifies the destination port (in hex format for AH, ESP, and GRE; decimal
for all other protocols).
[destination | source] For network address translation (NAT) sessions, this specifies whether to
select a NAT source or NAT destination session.
<nat ip> For NAT sessions, this specifies the NAT IP address. IP addresses should
be expressed in dotted decimal notation (for example, 10.10.10.1).
<nat port> For NAT sessions, this specifies the NAT port (in hex format for AH, ESP,
and GRE; decimal for all other protocols).

vrf <name> Optional. Specifies the VPN routing and forwarding (VRF) instance to
impact. Executing the abovementioned commands without specifying a
VRF will only affect the default unnamed VRF.
Default Values
Command History
Functional Notes
The second half of this command, beginning with the source IP address, may be copied and pasted from a
row in the show ip policy-sessions table for easier use.
Usage Examples
The following example clears the Telnet association (TCP port 23) for policy class pclass1 with source IP
address 192.22.71.50 and destination 192.22.71.130:
>enable
#clear ip policy-sessions pclass1 tcp 192.22.71.50 23 192.22.71.130 23
The following example clears all policy class sessions for the VRF instance named RED:
>enable
#clear ip policy-sessions vrf RED

clear ip policy-stats
Use the clear ip policy-stats command to clear statistical counters for policy classes. Variations of this
command include:
clear ip policy-stats
clear ip policy-stats <name>
clear ip policy-stats <name> entry <number>
Syntax Description
<name> Optional. Specifies the policy class to clear. If no policy class is specified,
statistics are cleared for all policies.
entry <number> Optional. Clears the statistics of a specific policy class entry.
Default Values
Command History
Usage Examples
The following example clears statistical counters for all policy classes:
>enable
#clear ip policy-stats
The following example clears statistical counters for the policy class MatchALL:
>enable
#clear ip policy-stats MatchALL

clear ip prefix-list <name>

Use the clear ip prefix-list command to clear the IP prefix list hit count shown in the show ip prefix-list
detail command output. Refer to show ip prefix-list on page 506 for more information.
Syntax Description
<name> Clears the count statistics of the specified IP prefix list.
Default Values
Command History
Usage Examples
The following example clears the hit count statistics for prefix list test:
>enable
#clear ip prefix-list test

clear ip route
Use the clear ip route command to remove all learned routes from the IP route table. Static and connected
routes are not cleared by this command. The command can be limited to a specific VPN routing and
forwarding (VRF). Variations of this command include:
clear ip route *
clear ip route <ip address> <subnet mask>
clear ip route vrf <name> *
clear ip route vrf <name> <ip address> <subnet mask>
Syntax Description
* Deletes all destination routes.
<ip address> Specifies the IP address of the destination routes to be deleted. IP
10.10.10.1).
<subnet mask> Specifies the subnet mask that corresponds to a range of IP addresses
(network) or a specific host. Subnet masks can be expressed in dotted
decimal notation (for example, 255.255.255.0) or as a prefix length (for
example, /24).
vrf <name> Optional. Clears the IP route table for the specified VRF.
Default Values
Command History
Functional Notes
Usage Examples
The following example removes all learned routes from the route table:
>enable
#clear ip route *

The following example removes all learned routes from the route table on the VRF RED:
>enable
#clear ip route vrf RED *

clear ip route-cache express

Use the clear ip route-cache express command to remove all routes from the hardware forwarding table.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all routes from the hardware forwarding table:
>enable
#clear ip route-cache express

clear ip rtp quality-monitoring

Use the clear ip rtp quality-monitoring command to clear various voice quality monitoring (VQM)
statistics and metrics from the call history, active calls, and all interfaces. Variations of this command
include:
clear ip rtp quality-monitoring

clear ip rtp quality-monitoring call-history
clear ip rtp quality-monitoring interface <interface>
Syntax Description
call-history Optional. Removes call statistics from the call history only.
interface <interface> Optional. Clears all interface VQM statistics for the specified interface.
Specifies an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type clear ip rtp quality-monitoring interface ? for a valid
list of interfaces.
Default Values
Command History
Release A1 Command was included in the AOS voice products.
Usage Examples
The following example clears IP Realtime Transport Protocol (RTP) quality-monitoring metrics from the call
history:
>enable
#clear ip rtp quality-monitoring call-history

clear ip rtp quality-monitoring reporter

Use the clear ip rtp quality-monitoring reporter command to clear all statistics associated with all
configured voice quality monitoring (VQM) reporters. Variations of this command include:
clear ip rtp quality-monitoring reporter

clear ip rtp quality-monitoring reporter <name>
Syntax Description
<name> Optional. Clears statistics for only the specified VQM reporter.
Default Values
Command History
Usage Examples
The following example clears only the statistics associated with VQM reporter Reporter1:
>enable
#clear ip rtp quality-monitoring reporter Reporter1

clear ip security
Use the clear ip security command to clear all statistics associated with the security monitor. Variations of
clear ip security any-vrf threats

clear ip security monitor
clear ip security threats
clear ip security vrf <name> threats
Syntax Description
any-vrf threats Clears statistics on any available VRF on the device.
monitor Clears all statistics associated with the security monitor.
threats Clears the IP security threats list.
vrf <name> threats Clears statistics on the named VRF.
Default Values
Command History
Functional Notes
The clear ip security command is used to clear all statistics associated with the security monitor including
policy-stats and excluding timeline and virtual private network (VPN) statistics. The time of the clear is
saved.
Usage Examples
The following example clears threat statistics for the named VRF MyVRF:
>enable
#clear ip security vrf MyVRF threats

clear ip urlfilter statistics

Use the clear ip urlfilter statistics command to clear all statistics counters for uniform resource locator
(URL) filter requests and responses.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all counters for URL filter requests and responses:
>enable
#clear ip urlfilter statistics

clear ip urlfilter top-websites

Use the clear ip urlfilter top-websites command to clear all statistics for top websites reporting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all statistics for top websites reporting:
>enable
#clear ip urlfilter top-websites

clear lldp counters interface <interface>

Use the clear lldp counters interface command to reset all Link Layer Discovery Protocol (LLDP) packet
counters to zero on all interfaces.
Syntax Description
<interface> Clears the information for the specified interface. Specify an interface in the
wireless virtual access point, use dot11ap 1/1.1. Type clear lldp counters
Default Values
Command History
Usage Examples
The following example resets all LLDP counters:
>enable
#clear lldp counters interface

clear lldp neighbors

Use the clear lldp neighbors command to remove all neighbors from this unit’s database. As new Link
Layer Discovery Protocol (LLDP) frames are received, the database will contain information about
neighbors included in those frames.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This command generates output indicating the names of any neighbors deleted from the database and the
name of the interface on which the neighbor was learned.
Usage Examples
The following example clears LLDP neighbor Switch_1 from the Ethernet interface 0/7:
>enable
#clear lldp neighbors
LLDP: Deleted neighbor “Switch_1” on interface eth 0/7
#

clear mac address-table dynamic

Use the clear mac address-table dynamic command to remove dynamic medium access control (MAC)
addresses from the MAC address table. Variations of this command include:
clear mac address-table dynamic <interface>

clear mac address-table dynamic address <mac address>
Syntax Description
<interface> Removes the MAC address of the specified interface. Specify an interface
in the format <interface type [slot/port | slot/port.subinterface id | interface id
| interface id.subinterface id | ap | ap/radio | ap/radio.vap]>. For example, for
wireless virtual access point, use dot11ap 1/1.1. Type clear mac
address-table dynamic interface ? for a complete list of applicable
interfaces.
address <mac address> Removes a specific MAC address from the table. MAC addresses should
be expressed in the following format xx:xx:xx:xx:xx:xx (for example,
00:A0:C8:00:00:01).
Default Values
Command History
Usage Examples
The following example removes the dynamic address A0:B1:C2:D3:E4:A1 from the MAC address table:
>enable
#clear mac address-table dynamic address A0:B1:C2:D3:E4:A1
The following example removes all dynamic addresses from the MAC address table:
>enable
#clear mac address-table dynamic

clear mac address-table multicast

Use the clear mac address-table multicast command to clear all entries in the multicast address
resolution lookup (ARL) table or filter the entries based on certain criteria. Variations of this command
include:
clear mac address-table multicast

clear mac address-table multicast igmp-snooping
clear mac address-table multicast user
clear mac address-table multicast vlan <vlan id>
clear mac address-table multicast vlan <vlan id> igmp-snooping
clear mac address-table multicast vlan <vlan id> user
Syntax Description
igmp-snooping Optional. Clears entries in the multicast ARL table that were added
dynamically (via IGMP snooping).
user Optional. Clears entries in the multicast ARL table that were added statically
(by the user).
vlan <vlan id> Optional. Clears entries in the multicast ARL table based on virtual local
area network (VLAN).
Default Values
Command History
Usage Examples
The following example removes the entries in the multicast ARL table for VLAN 200:
>enable
#clear mac address-table multicast vlan 200

clear mail-client body <agent name>

Use the clear mail-client body command to clear the body text of the pending email message for a specific
mail agent.
Syntax Description
<agent name> Specifies which mail agent body text is cleared.
Default Values
Command History
Usage Examples
The following example clears pending email body text for mail agent myagent:
>enable
#clear mail-client body myagent

clear mail-client counters

Use the clear mail-client counters command to clear all statistical counters associated with all mail
agents. Variations of this command include:
clear mail-client counters

clear mail-client counters <agent name>
Syntax Description
<agent name> Optional. Specifies that only a specific mail agent’s counters are cleared.
Default Values
Command History
Usage Examples
The following example clears all counters for all configured mail agents:
>enable
#clear mail-client counters

clear network-forensics ip dhcp

Use the clear network-forensics ip dhcp command to remove the Dynamic Host Configuration Protocol
(DHCP) statistics for clients connected to the network. Statistics can be cleared for a single client or for all
clients. Variations of this command include:
clear network-forensics ip dhcp

clear network-forensics ip dhcp hostname <hostname>
clear network-forensics ip dhcp interface gigabit-switchport <slot/port>
clear network-forensics ip dhcp ip <ip address>
clear network-forensics ip dhcp mac <mac address>
clear network-forensics ip dhcp vlan <vlan id>
Syntax Description
hostname <hostname> Optional. Clears statistics for the client with the specified host
name.
interface gigabit-switchport <slot/port> Optional. Clears statistics for the client using the specified
interface.
ip <ip address> Optional. Clears the statistics for the client with the specified
IP address. IP addresses should be expressed in dotted
mac <mac address> Optional. Clears the statistics for the client with the specified
medium access control (MAC) address. MAC addresses
should be expressed in the following format: xx:xx:xx:xx:xx:xx
(for example, 00:A0:C8:00:00:01).
vlan <vlan id> Optional. Clears the statistics for the client with the specified
virtual local area network (VLAN) identification number.
VLAN IDs range from 1 to 4094.
Default Values
Command History
Usage Examples
The following example clears all collected DHCP statistics for all clients:
>enable
#clear network-forensics ip dhcp

The following example clears all collected DHCP statistics for the client with the MAC address
00:A0:C8:00:00:01:
>enable
#clear network-forensics ip dhcp mac 00:A0:C8:00:00:01

clear ntp
Use the clear ntp command to restart the Network Time Protocol (NTP) daemon.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example restarts the NTP daemon:
>enable
#clear ntp

clear port-security
Use the clear port-security command to clear the dynamic or sticky secure medium access control (MAC)
addresses associated with an interface. This can be done on a per-address or per-port basis. Variations of
this command include the following:
clear port-security dynamic address <mac address>

clear port-security dynamic interface <interface>
clear port-security sticky address <mac address>
clear port-security sticky interface <interface>
Syntax Description
dynamic Clears the dynamic MAC addresses.
sticky Clears the sticky secure MAC addresses.
address <mac address> Clears the information for the specified MAC address. MAC addresses
should be expressed in the following format xx:xx:xx:xx:xx:xx (for example,
00:A0:C8:00:00:01).
interface <interface> Clears the information for the specified interface. Specify an interface in the
wireless virtual access point, use dot11ap 1/1.1. Type clear port-security
sticky interface ? or clear port-security dynamic interface ? for a
complete list of applicable interfaces.
Default Values
Command History
Usage Examples
The following command clears all dynamic secure MAC addresses associated with the Ethernet interface
0/1:
>enable
#clear port-security dynamic interface eth 0/1

clear port-security violation-count <interface>

Use the clear port-security violation-count command to clear the violation count associated with a
particular interface.
Syntax Description
<interface> Clears the information for the specified Ethernet interface. Specify an
interface id | interface id.subinterface id | ap | ap/radio | ap/radio.vap]>. For
eth 0/1.1; for a PPP interface, use ppp 1; for an ATM subinterface, use
atm 1.1; and for a wireless virtual access point, use dot11ap 1/1.1. Type
clear port-security violation-count interface ? for a complete list of
applicable interfaces.
Default Values
Command History
Usage Examples
The following command clears the violation count associated with the Ethernet interface 0/1:
>enable
#clear port-security violation-count eth 0/1

clear pppoe <interface>

Use the clear pppoe command to terminate the current Point-to-Point Protocol over Ethernet (PPPoE)
client session and cause AOS to attempt to re-establish the session.
Syntax Description
<interface> Specifies the Point-to-Point Protocol (PPP) interface ID number to clear.
Specify an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type clear pppoe ? for a complete list of valid interfaces.
Default Values
Command History
Usage Examples
The following example ends the current PPPoE client session for ppp 1:
>enable
#clear pppoe 1

clear probe responder

Use the clear probe responder command to remove entries from the probe responders. Variations of this
command include:
clear probe responder counters

clear probe responder icmp-timestamp counters
clear probe responder twamp counters
clear probe responder udp-echo counters
Syntax Description
counters Clears the probe responder counters.
icmp-timestamp Clears the Internet Control Message Protocol (ICMP) timestamp probe
responder counters.
twamp Clears the Two-Way Active Measurement Protocol (TWAMP) probe
responder counters.
udp-echo Clears the User Datagram Protocol (UDP) echo probe responder counters.
Default Values
Command History
Usage Examples
The following example removes the TWAMP responder counters:
>enable
#clear probe responder twamp counters

clear processes cpu max

Use the clear processes cpu max command to clear the maximum CPU usage statistic, which is displayed
in the show process cpu command output.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example resets the CPU maximum usage statistics:
>enable
#clear processes cpu max

clear processes queue

Use the clear processes queue command to clear the contents of the system processing queues.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears the contents of the system processing queues:
>enable
#clear processes queue

clear qos map

Use the clear qos map command to clear the statistics for all defined quality of service (QoS) maps or for
maps meeting user-configured specifications. Variations of this command include the following:
clear qos map

clear qos map <name>
clear qos map <name> <number>
clear qos map interface <interface>
Syntax Description
<name> Optional. Clears the statistics of a defined QoS map.
<number> Optional. Clears the statistics for one of the map’s specified sequence
numbers.
interface <interface> Optional. Clears QoS map statistics for the specified interface. Specify an
atm 1.1; and for a wireless virtual access point, use dot11ap 1/1.1.Type
clear qos map interface ? for a complete list of applicable interfaces.
Default Values
Command History
Usage Examples
The following example clears statistics for all defined QoS maps:
#clear qos map
The following example clears statistics for all entries in the priority QoS map:
#clear qos map priority
The following example clears statistics in entry 10 of the priority QoS map:
#clear qos map priority 10

The following example clears QoS statistics for a specified interface:
#clear qos map interface frame-relay 1
The clear counters command clears ALL interface statistics (including QoS map interface
statistics).

clear relay
Use the clear relay command to reset the door contact relay.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example resets the door contact relay:
>enable
#clear relay

clear route-map counters

Use the clear route-map counters command to reset route map hit counters. Variations of this command
include:
clear route-map counters

clear route-map counters <name>
Syntax Description
<name> Optional. Clears the counters for the specified route map.
Default Values
Command History
Usage Examples
The following example clears all route map counters:
>enable
#clear route-map counters

clear sip location <username>

Use the clear sip location command to clear Session Initiation Protocol (SIP) location database statistics.
clear sip location *

clear sip location <username>
Syntax Description
* Clears all SIP location database statistics.
<username> Clears the statistics for the specified user name.
Default Values
Command History
Usage Examples
The following example deletes all dynamic location entries:
>enable
#clear sip location *

clear sip trunk-registration

Use the clear sip trunk-registration command to clear local Session Initiation Protocol (SIP) registration
information for one or more trunks. Variations of this command include:
clear sip trunk-registration

clear sip trunk-registration <Txx>
clear sip trunk-registration <Txx> <trunk id>
Syntax Description
<Txx> Optional. Specifies the trunk to clear using its two-digit identifier. For
example: T01.
<trunk id> Optional. Clears the registration information for the specified trunk.
Default Values
Command History
Usage Examples
The following example clears SIP registration information for trunk 01:
>enable
#clear sip trunk-registration T01

clear sip user-registration

Use the clear sip user-registration command to clear local Session Initiation Protocol (SIP) server
registration information.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all SIP server registration information:
>enable
#clear sip user-registration

clear spanning-tree counters

The clear spanning-tree counters command clears the following counts: bridge protocol data unit
(BPDU) transmit, BPDU receive, and number of transitions to forwarding state. Variations of this
command include:
clear spanning-tree counters

clear spanning-tree counters interface <interface>
Syntax Description
interface <interface> Optional. Specifies a single interface. Specify an interface in the format
wireless virtual access point, use dot11ap 1/1.1. Type clear spanning-tree
counters ? for a complete list of interfaces.
Default Values
Command History
Usage Examples
The following example clears the spanning tree counters for Ethernet 0/10:
>enable
#clear spanning-tree counters interface eth 0/10

clear spanning-tree detected-protocols

Use the clear spanning-tree detected-protocols command to restart the protocol migration process.
clear spanning-tree detected-protocols

clear spanning-tree detected-protocols interface <interface>
Syntax Description
interface <interface> Optional. Specifies a valid interface to clear. Specify an interface in the
wireless virtual access point, use dot11ap 1/1.1. Type clear spanning-tree
detected-protocols interface ? for a complete list of applicable interfaces.
Default Values
Command History
Functional Notes
The switch has the ability to operate using the rapid spanning-tree protocol or the legacy 802.1D version of
spanning-tree. When a bridge protocol data unit (BPDU) of the legacy version is detected on an interface,
the switch automatically regresses to using the 802.1D spanning-tree protocol for that interface. Issue the
clear spanning-tree detected-protocols command to return to rapid spanning-tree operation.
Usage Examples
The following example re-initiates the protocol migration process on Ethernet interface 0/3:
>enable
#clear spanning-tree detected-protocols interface ethernet 0/3
The following example re-initiates the protocol migration process on all interfaces:
>enable
#clear spanning-tree detected-protocols

clear tacacs+ statistics

Use the clear tacacs+ statistics command to delete all terminal access controller access-control system
plus (TACACS+) protocol statistics.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example clears all TACACS+ protocol statistics:
>enable
#clear tacacs+ statistics

clear user
Use the clear user command to detach a user from a given line. Variations of this command include:
clear user console <number>

clear user ssh <number>
clear user telnet <number>
Syntax Description
console <number> Detaches a specific console user. Valid range is 0 to 1.
ssh <number> Detaches a specific secure shell (SSH) user. Valid range is 0 to 4.
telnet <number> Detaches a specific Telnet user. Valid range is 0 to 5.
Default Values
Command History
Usage Examples
The following example detaches the console 1 user:
>enable
#clear user console 1

clear vrrp counters

Use the clear vrrp counters command to clear the Virtual Router Redundancy Protocol (VRRP) statistics.
The following are variations of this command:
clear vrrp counters

clear vrrp counters interface <interface>
clear vrrp counters interface <interface> group <number>
Syntax Description
interface <interface> Optional. Clears all VRRP statistics on the specified interface. Specify an
example, for an Ethernet subinterface, use eth 0/1.1; for a PPP interface,
use ppp 1; for an ATM subinterface, use atm 1.1; and for a wireless virtual
access point, use dot11ap 1/1.1. Type clear vrrp counters interface ? for
a complete list of valid interfaces.
group <number> Optional. Clears all VRRP statistics for the specified group on the specified
interface. Group numbers range from 1 to 255.
Default Values
Command History
Functional Notes
Although VRRP group virtual router IDs (VRIDs) can be numbered between 1 and 255, only two VRRP
routers per interface are supported.
Usage Examples
The following example clears all VRRP group statistics on all interfaces:
>enable
#clear vrrp counters

clock auto-correct-dst
The clock auto-correct-dst command allows the automatic one-hour correction for daylight savings time
(DST). Use the clock no-auto-correct-dst command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, this command is enabled.
Command History
Usage Examples
The following example allows for automatic DST correction:
>enable
#clock auto-correct-dst

clock no-auto-correct-dst
The clock no-auto-correct-dst command allows you to override the automatic one-hour correction for
daylight savings time (DST).
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Many time zones include an automatic one-hour correction for daylight savings time at the appropriate
time. You may override it at your location using this command.
Usage Examples
The following example overrides the one-hour offset for DST:
>enable
#clock no-auto-correct-dst

clock set <time> <day> <month> <year>

Use the clock set command to configure the system software clock. For the command to be valid, all fields
must be entered. Refer to the Usage Examples below for an example.
Syntax Description
<time> Sets the time (in 24-hour format) of the system software clock in the format
hours:minutes:seconds (HH:MM:SS).
<day> Sets the current day of the month. Valid range is 1 to 31.
<month> Sets the current month. Valid range is January to December. You need only
enter enough characters to make the entry unique. This entry is not case
sensitive.
<year> Sets the current year. Valid range is 2000 to 2100.
Default Values
Command History
Usage Examples
The following example sets the system software clock for 3:42 p.m., August 22, 2004:
>enable
#clock set 15:42:00 22 Au 2004

clock timezone <value>

The clock timezone command sets the unit’s internal clock to the timezone of your choice. This setting is
based on the difference in time (in hours) between Greenwich Mean Time (GMT) or Central Standard
Time (CST) and the timezone for which you are setting up the unit. Use the no form of this command to
disable this feature.
Syntax Description
<value> Clock timezone values are specified in the Functional Notes section for this
command.
Default Values
Command History
Release 11.1 Command was expanded to include the clock timezone 0.

Functional Notes
The following list shows sample cities and their timezone codes.
clock timezone +1-Amsterdam clock timezone +8-Bejing
clock timezone +1-Belgrade clock timezone +8-Irkutsk
clock timezone +1-Brussels clock timezone +8-Kuala-Lumpur
clock timezone +1-Sarajevo clock timezone +8-Perth
clock timezone +1-West-Africa clock timezone +8-Taipei
clock timezone +10-Brisbane clock timezone +9-Osaka
clock timezone +10-Canberra clock timezone +9-Seoul
clock timezone +10-Guam clock timezone +9-Yakutsk
clock timezone +10-Hobart clock timezone +9:30-Adelaide
clock timezone +10-Vladivostok clock timezone +9:30-Darwin
clock timezone +11 clock timezone -1-Azores
clock timezone +12-Auckland clock timezone -1-Cape-Verde
clock timezone +12-Fiji clock timezone -10
clock timezone +13 clock timezone -11
clock timezone +2-Athens clock timezone -12
clock timezone +2-Bucharest clock timezone -2
clock timezone +2-Cairo clock timezone -3-Brasilia
clock timezone +2-Harare clock timezone -3-Buenos-Aires
clock timezone +2-Helsinki clock timezone -3-Greenland
clock timezone +2-Jerusalem clock timezone -3:30
clock timezone +3-Baghdad clock timezone -4-Atlantic-Time
clock timezone +3-Kuwait clock timezone -4-Caracus
clock timezone +3-Moscow clock timezone -4-Santiago
clock timezone +3-Nairobi clock timezone -5
clock timezone +3:30 clock timezone -5-Bogota
clock timezone +4-Abu-Dhabi clock timezone -5-Eastern-Time
clock timezone +4-Baku clock timezone -6-Central-America
clock timezone +4:30 clock timezone -6-Central-Time
clock timezone +5-Ekaterinburg clock timezone -6-Mexico-City
clock timezone +5-Islamabad clock timezone -6-Saskatchewan
clock timezone +5:30 clock timezone -7-Arizona
clock timezone +5:45 clock timezone -7-Mountain-Time
clock timezone +6-Almaty clock timezone -8
clock timezone +6-Astana clock timezone -9
clock timezone +6-Sri-Jay clock timezone 0-Universal Coordinated Time
clock timezone +6:30 (UTC)
clock timezone +7-Bangkok clock timezone GMT-Casablanca
clock timezone +7-Kranoyarsk clock timezone GMT-Dublin

Usage Examples
The following example sets the timezone for Santiago, Chile.
>enable
#clock timezone -4-Santiago

configure
Use the configure command to enter the Global Configuration mode or to configure the system from
memory. Refer to Global Configuration Mode Command Set on page 714 for more information. Variations
configure memory
configure network
configure overwrite-network
configure terminal
Syntax Description
memory Configures the active system with the commands located in the default
configuration file stored in nonvolatile random access memory (NVRAM).
network Configures the system from a Trivial File Transfer Protocol (TFTP) network
host.
overwrite-network Overwrites NVRAM memory from a TFTP network host.
terminal Enters the Global Configuration mode.
Default Values
Command History
Usage Examples
The following example enters the Global Configuration mode from the Enable mode:
>enable
#configure terminal
(config)#

copy
Use the copy command to copy the specified file from the source (flash memory) to the specified
destination.
Variations of this command (valid only on AOS units WITHOUT CompactFlash®) include:
copy <sourcefile> <new file>

copy <sourcefile> boot
copy <sourcefile> default-config
copy <sourcefile> interface <interface>
copy <sourcefile> startup-config
Syntax Description
<sourcefile> Specifies the name of the file to copy.
<new file> Makes a copy of the specified source file and saves it in flash memory using
the specified new name.
boot Copies the specified source file and overwrites the boot read only memory
(ROM).
default-config Replaces the default configuration with the specified file copied from flash
memory.
interface <interface> Updates the specified interface using a copy of the specified file. Specify an
copy <sourcefile> interface ? to display a list of valid interfaces.
startup-config Replaces the startup configuration with the specified file copied from flash
memory.
Default Values
Command History
Release 16.1 Command was expanded to include the default-config.
Release 17.2 Command was expanded to include the cellular interface.
Functional Notes
Updates to the boot ROM are required periodically to enhance and expand the unit’s operation. The
bootcode can be updated from within the command line interface (CLI) using the copy <sourcefile> boot
command.

Usage Examples
The following example copies the file myfile.biz (located in flash memory) and overwrites the boot ROM:
>enable
#copy myfile.biz boot
Upgrading bootcode is a critical process that cannot be interrupted. If something were to happen and the
process was not able to be completed, it would render your unit inoperable. It is for this reason that during
a bootcode upgrade, all other system tasks will be halted. This means packets will not be routed, and all
console sessions will not respond during the upgrade process. Once the process finishes, the system will
function as it did before. This process will take approximately 20 seconds.
Do you want to proceed? [yes/no]y
WARNING!! A bootcode upgrade has been initiated. Your session will become
nonresponsive for the duration of the upgrade (approx. 20 seconds). A message
will be sent when the upgrade is completed.
Bootcode upgrade process done. Your session should function normally.
Success!!!!!

copy cflash
Use the copy cflash command to copy files located on the CompactFlash® card to the specified
destination.
Variations of this command (valid only on AOS units WITH CompactFlash) include:
copy cflash <sourcefile> boot

copy cflash <sourcefile> cflash <new file>
copy cflash <sourcefile> http <url> port <port>
copy cflash <sourcefile> https <url> port <port>
copy cflash <sourcefile> flash
copy cflash <sourcefile> flash <new file>
copy cflash <sourcefile> flash interface <interface>
copy cflash <sourcefile> startup-config
copy cflash tftp
copy cflash xmodem
Syntax Description
<new file> Specifies the name of the file (located on the CompactFlash card) to copy.
(ROM).
cflash <new file> Copies the specified source file and saves it to the CompactFlash card
using the specified new file name.
flash <new file> Copies the specified source file and saves it to flash memory using the
specified file name.
http <url> Copies the specified source file and transfers it to a Hypertext Transfer
Protocol (HTTP) server using the specified HTTP server uniform resource
locator (URL). Use HTTP PUT operation.
https <url> Copies the specified source file and transfers it to a secure socket
Hypertext Transfer Protocol Secure (HTTPS) server using the specified
HTTPS server URL. Use HTTPS PUT operation.
copy cflash <sourcefile> interface ? to display a list of valid interfaces.
port <port> Optional. Specifies the port used to transfer the specified file to an HTTP or
HTTPS server. Range is 0 to 65335.
startup-config Replaces the startup configuration with the specified file copied from the
CompactFlash card.
tftp Copies any file on the CompactFlash card to a specified Trivial File Transfer
Protocol (TFTP) server.

After entering copy cflash tftp, AOS prompts for the following information:
Address of remote host: Specifies the IP address of the TFTP server.
Source filename: Specifies the name of the file to copy to the TFTP
server.
Destination filename: Specifies the file name to use when storing the
copied file on the TFTP server. (The file will be
placed in the default directory established by the
TFTP server.)
xmodem Copies any file on the CompactFlash card (using the XMODEM protocol) to
the terminal connected to the console port. XMODEM capability is provided
in VT100 terminal emulation software, such as HyperTerminal™.
After entering copy cflash xmodem, AOS prompts for the following
information:
Source filename: Specifies the name of the file to copy from
CompactFlash to the connected terminal.
Default Values
Command History
Release 16.1 Command was expanded to include HTTP and HTTPS.
Usage Examples
The following example copies the source file myfile.biz (located on the CompactFlash card) to flash
memory (naming the new file newfile.biz):
>enable
#copy cflash myfile.biz flash newfile.biz
The following example creates a copy of the file myfile.biz (located on the CompactFlash card), names
the new file newfile.biz, and places the new file on the installed CompactFlash card:
>enable
#copy cflash myfile.biz cflash newfile.biz
The following example replaces the startup configuration file with the file newconfig.txt:
>enable
#copy cflash newconfig.txt startup-config

The following example copies the file myfile.biz (located on the CompactFlash card) to the specified TFTP
server:
>enable
#copy cflash tftp
Address of remote host?10.200.2.4
Source filename myfile.biz
Destination filename myfile.biz
Initiating TFTP transfer...
Received 45647 bytes.
Transfer Complete!
The following example copies the file myfile.biz (located on the CompactFlash card) to the connected
terminal using XMODEM protocol:
>enable
#copy cflash xmodem
Source filename myfile.biz
Begin the Xmodem transfer now...
Press CTRL+X twice to cancel
CCCCCC
AOS is now ready to transmit the file on the CONSOLE port (using the XMODEM protocol). The next step
in the process may differ depending on the type of terminal emulation software you are using. For
HyperTerminal, you will now select Transfer > Receive File and select the destination. Once the transfer
is complete, information similar to the following is displayed:

Transfer complete

copy console
Use the copy console command to copy the console’s input to a text file. To stop copying to the text file,
type <Ctrl+D>. The file will be saved in the AOS root directory.
Variations of this command (valid only on AOS units WITHOUT CompactFlash® capability) include:
copy console <filename>
Variations of this command (valid only on AOS units WITH CompactFlash capability) include:
copy console flash <filename>

copy console flash <filename> force-overwrite
Syntax Description
<filename> Copies the console input and saves it to flash memory using the specified
file name.
flash <filename> Copies the console input and saves it to flash memory using the specified
file name.
force-overwrite Optional. Specifies a force override to copy the file.
Default Values
Command History
Functional Notes
The copy console command works much like a line editor. Prior to pressing <Enter>, changes can be
made to the text on the line. Changes can be made using <Delete> and <Backspace> keys. The text can
be traversed using the arrow keys, <Ctrl+A> (to go to the beginning of a line), and <Ctrl+E> (to go to the
end of a line). To end copying to the text file, type <Ctrl+D>. The file will be saved in the AOS root
directory. Use the dir command to see a list of files in the root directory.
Usage Examples
The following example copies the console input into the file config.txt (located in the AOS root directory):
>enable
#copy console flash config.txt

copy dynvoice-config
Use the copy dynvoice-config command to copy the dynamic voice configuration file to the specified
destination.
Variations of this command (valid only on AOS units WITH CompactFlash® AND voice capability)
include:
copy dynvoice-config cflash <filename>

copy dynvoice-config flash <filename>
copy dynvoice-config http <url>
copy dynvoice-config running-config
copy dynvoice-config tftp
copy dynvoice-config xmodem
Syntax Description
cflash <filename> Copies the dynamic voice configuration file and saves it to the
CompactFlash card using the specified file name.
flash <filename> Copies the dynamic voice configuration file and saves it to flash memory
using the specified file name.
http <url> Copies the dynamic voice configuration file and transfers it to a Hypertext
Transfer Protocol (HTTP) server using the specified HTTP server uniform
resource locator (URL). Use HTTP PUT operation.
running-config Replaces the active running configuration with a copy of the dynamic voice
configuration file.
tftp Copies the dynamic voice configuration file and saves it to the specified
Trivial File Transfer Protocol (TFTP) server.
After entering copy dynvoice-config tftp, AOS prompts for the following
information:
Source filename: Specifies the name of the file (located on the
CompactFlash card) to copy to the TFTP server.
TFTP server.)
xmodem Copies the dynamic voice configuration file (using the XMODEM protocol)
and saves it to the terminal connected to the console port. XMODEM
capability is provided in VT100 terminal emulation software, such as
HyperTerminal™.
After entering copy dynvoice-config xmodem, AOS prompts for the
following information:
Source filename: Specifies the name of the file to copy from
CompactFlash to the connected terminal.

Default Values
Command History
Release 16.1 Command was expanded to include HTTP.
Usage Examples
The following example copies the dynamic voice configuration file and saves it to the CompactFlash card
using the name myvoice-config:
>enable
#copy dynvoice-config cflash myvoice-config
Percent Complete 100%
The following example copies the dynamic voice configuration file and saves it to flash memory using the
name myvoice-config:
>enable
#copy dynvoice-config flash myvoice-config
The following example replaces the active running configuration with a copy of the dynamic voice
configuration file:
>enable
#copy dynvoice-config running-config
The following example copies the dynamic voice configuration file and saves it to the TFTP server:
>enable
#copy dynvoice-config tftp
Address of remote host?10.200.2.4
Destination filename?myvoice-config
Sent 5221 bytes.
Transfer complete.

The following example copies the dynamic voice configuration file (using the XMODEM protocol) and
saves it to the terminal connected to the console port:
>enable
#copy dynvoice-config xmodem
CCCCCC
Sent 5221 bytes.

Transfer complete

copy flash
Use the copy flash command to copy files located in flash memory to a specified destination.
Variations of this command (valid only on AOS units WITH CompactFlash® capability) include:
copy flash <source file> boot

copy flash <source file> cflash
copy flash <source file> cflash <new file>
copy flash <source file> flash <new file>
copy flash <source file> http <url> port <port>
copy flash <source file> https <url> port <port>
copy flash <source file> interface <interface>
copy flash <source file> startup-config
Variations of this command (valid only on AOS units WITH CompactFlash AND voice capability)
include:
copy flash <source file> dynvoice-config
Variations of this command (valid only on AOS units with ramdisk enabled) include:
copy flash <source file> ramdisk

copy flash <source file> ramdisk <new file>
Variations of this command (valid on all AOS units) include:
copy flash tftp

copy flash xmodem
Syntax Description
<source file> Specifies the name of the file (located in flash memory) to copy.
<new file> Saves the file using the specified file name.
(ROM).
cflash Copies a file and saves it to the CompactFlash card.
dynvoice-config Replaces the dynamic voice configuration file with the specified file copied
from flash memory.
http <url> Copies the specified source file and transfers it to a HyperText Transfer
locator (URL). Use HTTP PUT operation.
https <url> Copies the specified source file and transfers it to a secure socket
HyperText Transfer Protocol Secure (HTTPS) server using the specified
HTTPS server URL. Use HTTPS PUT operation.
flash Copies the specified file and saves it to flash memory.

copy flash <sourcefile> interface ? to display a list of valid interfaces.
port <port> Optional. Specifies the port used to transfer the specified file to an HTTP or
HTTPS server. Range is 0 to 65335.
ramdisk Copies a file and saves it to the volatile RAM disk.
startup-config Replaces the startup configuration file with a copy of the specified file.
tftp Copies any file located in flash memory to a specified Trivial File Transfer
After entering copy flash tftp, AOS prompts for the following information:
Source filename: Specifies the name of the file (located in flash
memory) to copy to the TFTP server.
TFTP server.)
xmodem Copies any file located in flash memory (using the XMODEM protocol) to
After entering copy flash xmodem, AOS prompts for the following
information:
Source filename: Specifies the name of the file to copy from system
flash memory using XMODEM.
Default Values
Command History
Release 17.7 Command was expanded to include the ramdisk parameter.
Usage Examples
The following example creates a copy of the file myfile.biz (located in flash memory), names the new file
newfile.biz, and places the new file in flash memory:
>enable
#copy flash myfile.biz flash newfile.biz

The following example copies the file myfile.biz (located in flash memory) to CompactFlash memory
(naming the new file newfile.biz):
>enable
#copy flash myfile.biz cflash newfile.biz
The following example copies the file new_startup_config (located in flash memory) to the startup
configuration:
>enable
#copy flash new_startup_config startup-config
The following example copies the software file myfile.biz (located in flash memory) to a TFTP server:
>enable
#copy flash tftp
Address of remote host? 10.200.2.4
Source filename? myfile.biz
Destination filename? myfile.biz
Sent 769060 bytes.
Transfer Complete!
The following example copies the software file myfile.biz (located in flash memory) to the connected
>enable
#copy flash xmodem
CCCCCC
Sent 231424 bytes.

Transfer complete

copy http
Use the copy http command to copy a file located on a network HyperText Transfer Protocol (HTTP)
server to a specified destination.
copy http <url> cflash <destination file>

copy http <url> cflash <destination file> force-overwrite
copy http <url> cflash <destination file> force-overwrite port <port>
copy http <url> cflash <destination file> port <port>
copy http <url> cflash running-config
copy http <url> cflash running-config port <port>
include:
copy http <url> dynvoice-config
copy http <url> ramdisk <destination file>

copy http <url> ramdisk <destination file> force-overwrite
copy http <url> ramdisk <destination file> force-overwrite port <port>
copy http <url> ramdisk <destination file> port <port>
copy http <url> ramdisk running-config
copy http <url> ramdisk running-config port <port>
copy http <url> flash <destination file>

copy http <url> flash <destination file> force-overwrite
copy http <url> flash <destination file> force-overwrite port <port>
copy http <url> flash <destination file> port <port>
copy http <url> running-config
copy http <url> running-config port <port>
copy http <url> startup-config
copy http <url> startup-config port <port>
Syntax Description
cflash Copies a file from the HTTP server to the CompactFlash card.
<destination file> Specifies the new name of the file after it is copied.
dynvoice-config Specifies that the file copied from the HTTP server overwrite the dynamic
voice configuration file.
flash Copies a file from the HTTP server to the flash memory.

port <port> Optional. Specifies the port used to transfer the specified file from an HTTP
server. Range is 0 to 65335.
ramdisk Copies a file from the HTTP server to the volatile RAM disk.
running-config Replaces the active running configuration with the file copied from the
HTTP server.
startup-config Replaces the startup configuration with the file copied from the HTTP
server.
http <url> Specifies the URL of the HTTP server.
Default Values
By default, the port value is 80.
Command History
Usage Examples
The following example replaces the current running configuration file with newconfig.txt from the HTTP
server (10.200.2.4):
#copy http http://10.200.2.4/newconfig.txt running-config

Initiating HTTP transfer...
Transfer Complete!
#
The following example copies the file myfile.biz from the HTTP server (10.200.2.4) and saves it
CompactFlash memory (naming the copy newfile.biz):
#copy http http://10.200.2.4/SomeDirectory/AnotherDirectory/myfile.biz cflash newfile.biz

Initiating HTTP transfer...
Transfer Complete!
#

copy https
Use the copy https command to copy a file located on a secure socket HyperText Transfer Protocol Secure
(HTTPS) server to a specified destination using the HTTPS PUT operation.
copy https <url> cflash <destination file>

copy https <url> cflash <destination file> force-overwrite
copy https <url> cflash <destination file> force-overwrite port <port>
copy https <url> cflash <destination file> port <port>
copy https <url> cflash running-config
copy https <url> cflash running-config port <port>
include:
copy https <url> dynvoice-config
copy https <url> ramdisk <destination file>

copy https <url> ramdisk <destination file> force-overwrite
copy https <url> ramdisk <destination file> force-overwrite port <port>
copy https <url> ramdisk <destination file> port <port>
copy https <url> ramdisk running-config
copy https <url> ramdisk running-config port <port>
copy https <url> flash <destination file>

copy https <url> flash <destination file> force-overwrite
copy https <url> flash <destination file> force-overwrite port <port>
copy https <url> flash <destination file> port <port>
copy https <url> running-config
copy https <url> cflash running-config port <port>
copy https <url> flash running-config
copy https <url> flash running-config port <port>
copy https <url> startup-config
copy https <url> cflash startup-config port <port>
Syntax Description
cflash Copies a file from the HTTP secure server to the CompactFlash card.
<destination file> Specifies the new name of the file after it is copied.
dynvoice-config Specifies that the file copied from the HTTP secure server overwrite the
dynamic voice configuration file.
flash Copies a file from the HTTP secure server to the flash memory.


port <port> Optional. Specifies the port used to transfer the specified file from an HTTP
secure server. Range is 0 to 65335.
ramdisk Copies a file from the HTTP secure server to the volatile RAM disk.
running-config Replaces the active running configuration with the file copied from the
HTTP secure server.
startup-config Replaces the startup configuration with the file copied from the HTTP
secure server.
https <url> Specifies the URL of the HTTP secure server.
Default Values
By default, the port value is 443.
Command History
Usage Examples
The following example replaces the current running configuration file with newconfig.txt from the HTTPS
server (MyWebServer):
#copy https https://MyWebServer.com/newconfig.txt running-config

Initiating HTTPS transfer...
Transfer Complete!
#
The following example copies the file myfile.biz from the HTTPS server (10.200.2.4) and saves it
#copy https https://10.200.2.4/myfile.biz cflash newfile.biz

Initiating HTTPS transfer...
Transfer Complete!
#

copy ramdisk
Use the copy ramdisk command to copy files located in the volatile RAM disk memory to a specified
destination. Variations of this command include:
copy ramdisk <source file> flash

copy ramdisk <source file> flash <new file>
copy ramdisk <source file> overwrite primary
copy ramdisk <source file> overwrite primary verify
copy ramdisk <source file> overwrite secondary
copy ramdisk <source file> overwrite secondary verify
copy ramdisk tftp
copy ramdisk xmodem
Not all units are capable of using a RAM disk file system. Use the copy ? command to
display a list of valid commands at the enable prompt.
Syntax Description
<source file> Specifies the name of the file (located on the RAM disk) to copy.
flash Copies the specified file and saves it to the system flash memory using the
same file name.
flash <new file> Copies the specified file and saves it to the system flash memory using the
overwrite primary Replaces the primary boot image file with the file from RAM disk. The file to
be overwritten is deleted prior to copying the new file. In order for this
command to succeed, the RAM disk must be mounted, the specified file
must exist, and the specified file must verify with a valid signature for the
unit.
overwrite secondary Replaces the secondary boot image file with the file from RAM disk. The file
to be overwritten is deleted prior to copying the new file. In order for this
command to succeed, the RAM disk must be mounted, the specified file
must exist, and the specified file must verify with a valid signature for the
unit.
tftp Copies the specified file from the RAM disk to a specified Trivial File
Transfer Protocol (TFTP) server.
After entering the command, AOS prompts for the following information:
RAM disk) to copy to the TFTP server.
TFTP server.)

xmodem Copies the specified file from the RAM disk (using the XMODEM protocol)
to the terminal connected to the console port. XMODEM capability is
provided in VT100 terminal emulation software, such as HyperTerminal™.
After entering the command, AOS prompts for the following information:
RAM disk) to copy using XMODEM.
verify Optional. Specifies that a second verification of the new primary or
secondary boot system image is performed after it is copied.
Default Values
Command History
Usage Examples
The following example creates a copy of the file myfile.biz (located on the RAM disk), names the new file
newfile.biz, and places the new file in flash memory:
>enable
#copy ramdisk myfile.biz flash newfile.biz
The following example copies the software file myfile.biz (located on the RAM disk) to a TFTP server:
>enable
#copy ramdisk tftp
Destination filename? myfile.biz
Sent 769060 bytes.
Transfer Complete!
The following example copies the software file myfile.biz (located on the RAM disk) to the connected
>enable
#copy ramdisk xmodem
CCCCCC

Sent 231424 bytes.

Transfer complete

copy running-config
Use the copy running-config command to create a copy of the current running configuration and replace
the current startup configuration or save it to a specified location.
copy running-config cflash <filename>

copy running-config cflash startup-config
copy running-config flash <filename>
copy running-config flash startup-config
include:
copy running-config dynvoice-config

copy running-config dynvoice-config tftp
copy running-config dynvoice-config http <url>
copy running-config non-dynvoice-config http <url>
Variations of this command (valid only on AOS units ramdisk enabled) include:
copy running-config ramdisk <filename>
copy running-config <filename>

copy running-config http <url>
copy running-config https <url>
copy running-config tftp
copy running-config xmodem
Syntax Description
cflash Copies the current running configuration and saves it to the CompactFlash
card.
dynvoice-config Copies the current active voice running configuration and saves it to the
dynamic voice configuration file.
<filename> Specifies the filename to use when saving the configuration file.
flash Copies the current running configuration and saves it to flash memory.
http <url> Copies the current running configuration file or newly stored dynamic voice
configuration file, and transfers it to a HyperText Transfer Protocol (HTTP)
server using the specified HTTP server uniform resource locator (URL).
Uses the HTTP PUT operation.
https <url> Copies the current running configuration file and transfers it to a secure
socket HyperText Transfer Protocol Secure (HTTPS) server using the
specified HTTPS server URL. Uses the HTTPS PUT operation.

non-dynvoice-config Copies the current nondynamic portion of the voice running configuration
and saves it to the nondynamic voice configuration file.
ramdisk Copies current running configuration to the volatile RAM disk.
startup-config Replaces the startup configuration (located in either CompactFlash or
system flash) with a copy of the current running configuration.
tftp Copies the current running configuration or newly stored dynamic voice
configuration file to the specified Trivial File Transfer Protocol (TFTP)
server.
After entering copy running-config tftp or copy running-config
dynvoice-config tftp, AOS prompts for the following information:
TFTP server.)
xmodem Copies the current running configuration (using the XMODEM protocol) to
Default Values
Command History
Usage Examples
The following example copies the current running configuration to the startup configuration located in flash
memory:
>enable
#copy running-config flash startup-config
Building configuration...
Done. Success!
The following example copies the current running configuration to CompactFlash memory and names the
file config_01.txt:
>enable
#copy running-config cflash config_01.txt
Percent Compete 100%
#

The following example copies the current running configuration to a TFTP server and names the file
config_01.txt:
>enable
#copy running-config tftp
Destination filename? config_01.txt
Sent 3099 bytes.
Transfer Complete!
The following example copies the current running configuration to the connected terminal using XMODEM
protocol:
>enable
#copy running-config xmodem
CCCCCC
Sent 3704 bytes.

Transfer complete

copy startup-config
Use the copy startup-config command to create a copy of the current startup configuration file and replace
the current running configuration or save it to a specified memory location.
Variations of this command (valid only on AOS units with CompactFlash® capability) include:
copy startup-config cflash <filename>

copy startup-config flash <filename>
copy startup-config ramdisk <filename>
copy startup-config <filename>

copy startup-config http <url>
copy startup-config https <url>
copy startup-config running-config
copy startup-config tftp
copy startup-config xmodem
Syntax Description
cflash <filename> Copies the startup configuration and saves it to the CompactFlash card
using the specified file name.
flash <filename> Copies the startup configuration and saves it to flash memory using the
<filename> Specifies the filename to use when saving the startup configuration file.
http <url> Copies the startup configuration file and transfers it to a HyperText Transfer
locator (URL). Uses HTTP PUT operation.
https <url> Copies the startup configuration file and transfers it to a secure socket
HyperText Transfer Protocol Secure (HTTPS) server using the specified
HTTPS server URL. Uses HTTPS PUT operation.
ramdisk <filename> Copies current startup configuration to the volatile RAM disk using the
running-config Merges the current running configuration with the startup configuration.
tftp Copies the current startup configuration to a specified Trivial File Transfer
After entering copy startup-config tftp, AOS prompts for the following
information:

TFTP server.)
xmodem Copies the current startup configuration (using the XMODEM protocol) to
Default Values
Command History
Usage Examples
The following example copies the startup configuration file to the current running configuration:
>enable
#copy startup-config running-config
Opening and applying file...
Any changes made to the current running configuration of the AOS unit that have not been
saved to the startup configuration file (using the write command) will be lost when the
copy startup-config running-config command is entered.
The following example copies the startup configuration (located in flash memory) to CompactFlash and
names the file config_01.txt:
>enable
#copy startup-config cflash config_01.txt
#
The following example copies the current startup configuration to a TFTP server and names the file
startup_01.txt:
>enable
#copy startup-config tftp
Destination filename? startup_01.txt
Sent 3099 bytes.
Transfer Complete!

The following example copies the current startup configuration to the connected terminal using XMODEM
protocol:
>enable
#copy startup-config xmodem
CCCCCC
Sent 3704 bytes.

Transfer complete

copy tftp
Use the copy tftp command to copy a file located on a network Trivial File Transfer Protocol (TFTP)
server to a specified destination.
copy tftp cflash
include:
copy tftp dynvoice-config
copy tftp ramdisk
copy tftp flash

copy tftp running-config
copy tftp startup-config
Syntax Description
cflash Copies a file from the TFTP server to the CompactFlash card.
dynvoice-config Specifies that the file copied from the TFTP server overwrite the dynamic
voice configuration file.
flash Copies a file from the TFTP server to the flash memory.
ramdisk Copies a file from the TFTP server to the volatile RAM disk.
running-config Replaces the active running configuration with the file copied from the TFTP
server.
startup-config Replaces the startup configuration with the file copied from the TFTP
server.
After entering copy tftp and specifying the destination, AOS prompts for the
following information:
Source filename: Specifies the name of the file to copy from the
TFTP server.
copied file. (Valid only for the copy tftp cflash,
copy tftp flash, copy tftp ramdisk commands.)

Default Values
Command History
Usage Examples
The following example replaces the current running configuration file with newconfig.txt from the TFTP
server (10.200.2.4):
#copy tftp running-config

Source filename? newconfig.txt
Transfer Complete!
#
The following example copies the file myfile.biz from the TFTP server (10.200.2.4) and saves it
#copy tftp cflash

Destination filename? newfile.biz
Transfer Complete!
#

copy xmodem
Use the copy xmodem command to copy a file (using the XMODEM protocol) to a specified destination.
XMODEM capability is provided in VT100 terminal emulation software, such as HyperTerminal™.
copy xmodem cflash
include:
copy xmodem dynvoice-config
copy xmodem ramdisk
copy xmodem flash

copy xmodem running-config
copy xmodem startup-config
Syntax Description
cflash Copies a file from the terminal connected to the console port and saves it to
the CompactFlash card.
After entering copy xmodem cflash, AOS prompts for the following
information:
copied file to cflash memory.
dynvoice-config Specifies that the file copied from the terminal connected to the console port
overwrite the dynamic voice configuration file.
flash Copies a file from the terminal connected to the console port and saves it to
flash memory.
After entering copy xmodem flash, AOS prompts for the following
information:
copied file to flash memory.
ramdisk Copies a file from the terminal connected to the console port and saves it to
the volatile RAM disk.
running-config Replaces the active running configuration with a file copied from the
terminal connected to the console port.
startup-config Replaces the startup configuration with a file copied from the terminal
connected to the console port.

Default Values
Command History
Usage Examples
The following example copies a software file (myfile.biz) to flash memory and renames it newfile.biz:
#copy xmodem flash

Destination filename? newfile.biz
CCCCCC
AOS is now ready to accept the file on the CONSOLE port (using the XMODEM protocol). The next step in
the process may differ depending on the type of terminal emulation software you are using. For
HyperTerminal, you will now select Transfer > Send File and browse to the file you wish to copy
myfile.biz. Once the transfer is complete, information similar to the following is displayed:

Transfer complete

debug aaa
Use the debug aaa command to activate debug messages associated with authentication from the
authentication, authorization, and accounting (AAA) subsystem. Debug messages are displayed (real time)
on the terminal (or Telnet) screen. Use the no form of this command to disable the debug messages.
Turning on a large amount of debug information can adversely affect the performance of
your unit.
Syntax Description
No subcommands.
Default Values
By default, all debug messages in AOS are disabled.
Command History
Functional Notes
The debug aaa events include connection notices, login attempts, and session tracking.
Usage Examples
The following is sample output for this command:
>enable
#debug aaa
AAA: New Session on portal 'TELNET 0 (172.22.12.60:4867)'.
AAA: No list mapped to 'TELNET 0'. Using 'default'.
AAA: Attempting authentication (username/password).
AAA: RADIUS authentication failed.
AAA: Authentication failed.
AAA: Closing Session on portal 'TELNET 0 (172.22.12.60:4867)'.

debug access-list <name>

Use the debug access-list command to activate debug messages (for a specified list) associated with access
control list (ACL) operation. Debug messages are displayed (real time) on the terminal (or Telnet) screen.
Use the no form of this command to disable the debug messages.
your unit.
Syntax Description
<name> Specifies a configured ACL.
Default Values
Command History
Functional Notes
The debug access-list command provides debug messages to aid in troubleshooting ACL issues. These
debug messages are populated by traffic matches that occur when traffic is filtered through the ACL. The
ACL must have the logging feature enabled in order to populate the debug message. To enable ACL
match logging, refer to the Access Control List Command Set on page 2411.
Usage Examples
The following is sample output of debug messages for the ACL labeled MatchAll:
>enable
#debug access-list MatchAll
2009.06.09 14:15:03 ACCESS_LIST.MatchAll permit host 192.168.0.1 log (1 matches)

debug arp
Use the debug arp command to activate debug messages associated with IP Address Resolution Protocol
(ARP) transactions. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the
no form of this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with ARP transactions:
>enable
#debug arp

debug auto-link
Use the debug auto-link command to display auto-provisioning and synchronization (APS) packets.
Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form of this
command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Release 17.3/A2 Command was introduced.
Usage Examples
The following example activates APS debug messages:
>enable
#debug auto-link

debug atm events

Use the debug atm events command to display events on all asynchronous transfer mode (ATM) ports and
all virtual circuits. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no
form of this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates ATM event messages:
>enable
#debug atm events

debug atm oam

Use the debug atm oam command to display operations, administration, and maintenance (OAM) packets
for an asynchronous transfer mode (ATM) virtual circuit descriptor (VCD). Debug messages are displayed
(real time) to the terminal (or Telnet) screen. Use the no form of this command to disable the debug
messages. Variations of this command include the following:
debug atm oam

debug atm oam <vcd>
debug atm oam <vcd> loopback end-to-end
debug atm oam <vcd> loopback end-to-end <LLID>
debug atm oam <vcd> loopback segment
debug atm oam <vcd> loopback segment <LLID>
your unit.
Syntax Description
<vcd> Optional. Shows OAM packets for a specific VCD.
loopback Optional. Configures an OAM loopback.
end-to-end Optional. Configures an end-to-end OAM loopback.
segment Optional. Configures a segment loopback.
<LLID> Optional. Specifies 16 byte OAM loopback location ID (LLID).
Default Values
Command History
Usage Examples
The following example activates ATM OAM debug messages for VCD 1:
>enable
#debug atm oam 1

debug atm packet

Use the debug atm packet command to activate debug messages associated with packets on asynchronous
transfer mode (ATM) ports and virtual circuits. Debug messages are displayed (real time) to the terminal
(or Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this
command include the following:
debug atm packet

debug atm packet interface atm <port id>
debug atm packet interface atm <port id> vcd <number>
debug atm packet vc <VPI/VCI>
your unit.
Syntax Description
interface atm <port id> Optional. Activates packet debug messages for a specific ATM port and for
all virtual circuits.
vc <VPI/VCI> Optional. Activates packet debug messages for the specified virtual circuit
identified by the virtual path identifier and virtual channel identifier
(VPI/VCI).
vcd <number> Optional. Activates packet debug messages for the specified virtual circuit
descriptors (VCDs).
Default Values
Command History
Usage Examples
The following example activates debug ATM packet debug messages on ATM port 1:
>enable
#debug atm packet interface atm 1

debug auto-config
Use the debug auto-config command to activate debug messages associated automatic configuration
events. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no form of
this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with automatic configuration events:
>enable
#debug auto-config

debug bridge
Use the debug bridge command to display messages associated with bridge events. Debug messages are
displayed (real time) to the terminal (or Telnet) screen. Use the no form of this command to disable the
debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates bridge debug messages:
>enable
#debug bridge

debug chat-interfaces <chat interface>

Use the debug chat-interfaces command to activate debug messages associated with chat AT
command-driven interfaces. Debug messages are displayed (real time) on the terminal (or Telnet) screen.
your unit.
Syntax Description
<chat interface> Activates debug messages for the specified chat interface identified by the
slot/port.
Default Values
Command History
Usage Examples
The following example activates debug messages for the chat interface 0/1:
>enable
#debug chat-interfaces 0/1

debug color
Use the debug color command to activate color coding of debug messages. Debug messages are displayed
(real time) on the terminal (or Telnet) screen. Use the no form of this command to disable the color coding
of debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Color coding is based on the debug source and color choices are not configurable.
Usage Examples
The following example enables color coding of debug messages:
>enable
#debug color

debug crypto
Use the debug crypto command to activate debug messages associated with Internet key exchange (IKE)
and Internet Protocol security (IPsec) functions. Debug messages are displayed (real time) to the terminal
(or Telnet) screen. Use the no form of this command to disable the debug messages.Variations of this
command include:
debug crypto ike

debug crypto ike client authentication
debug crypto ike client configuration
debug crypto ike negotiation
debug crypto ipsec
debug crypto pki
your unit.
Syntax Description
ike Activates all IKE debug messages.
ike client authentication Optional. Displays IKE client authentication messages as they occur.
ike client configuration Optional. Displays mode-config exchanges as they take place over the IKE
SA. It is enabled independently from the debug ike negotiation
messaging.
ike negotiation Optional. Activates only IKE key management debug messages (e.g.,
handshaking).
ipsec Activates all IPsec debug messages.
pki Activates all public key infrastructure (PKI) debug messages.
Default Values
Command History
Release 6.1 Debug pki command was introduced.
Usage Examples
The following example activates the IPsec debug messages:
>enable
#debug crypto ipsec

debug data-call
Use the debug data-call command to activate debug messages associated with data call errors and events.
Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no form of this
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with data call errors and events:
>enable
#debug data-call

debug demand-routing
Use the debug demand-routing command to activate debug messages associated with demand routing
errors and events. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates demand routing error and event messages:
>enable
#debug demand-routing

debug desktop-auditing
Use the debug desktop-auditing command to enable debug messages for clients connected to the
network. The desktop auditing debug messages include the network access protection (NAP) messages
sent between clients and the server. Debug messages can be activated for all clients connected to the
network, or only for specific clients. Using the no form of this command disables debug messaging for
desktop auditing clients. Variations of this command include:
debug desktop-auditing
debug desktop-auditing hostname <hostname>
debug desktop-auditing interface gigabit-switchport <slot/port>
debug desktop-auditing ip <ip address>
debug desktop-auditing mac <mac address>
your unit.
Syntax Description
hostname <hostname> Optional. Activates debug messages only for the client with
the specified host name.
interface gigabit-switchport <slot/port> Optional. Activates debug messages only for the client using
the specified interface.
ip <ip address> Optional. Activates debug messages only for the client with
the specified IP address. IP addresses should be expressed
mac <mac address> Optional. Activates debug messages only for the client with
the specified medium access control (MAC) address. MAC
addresses should be expressed in the following format:
Default Values
Command History

Usage Examples
The following is sample output of the debug desktop-auditing command:
2009.08.31 14:30:30 DESKTOP_AUDITING.DHCP.giga-swx 0/5 from 00:E0:29:0E:D5:E3 NAP Capable

client
2009.08.31 14:30:31 DESKTOP_AUDITING.DHCP.giga-swx 0/24 from 00:E0:29:0E:D5:E5 to
00:E0:29:0E:D5:E3 NAP Capable Server
00:E0:29:0E:D5:E5 NAP SoH: Firewall is 3rd-Party, AutoUpdates not downloading or installing
00:E0:29:0E:D5:E3 NAP SoHR: OK

debug dial-backup
Use the debug dial-backup command to activate debug messages associated with dial-backup operation.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Release 2.1 Additional debug messages were implemented for dial-backup operation to
ADTRAN’s IQ and Express Series products.
Functional Notes
The debug dial-backup command activates debug messages to aid in the troubleshooting of dial-backup
links.
Usage Examples
The following example activates debug messages for dial-backup operation:
>enable
#debug dial-backup

debug dialup-interfaces
Use the debug dialup-interfaces command to generate debug messages used to aid in troubleshooting
problems with all dialup interfaces, such as the modem or the basic rate interface (BRI) cards. Debug
messages are displayed (real time) on the terminal (or Telnet) screen. Use the no form of this command to
disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
When enabled, these messages provide status information on incoming calls, dialing and answering
progress, etc. These messages also give information on why certain calls are dropped or rejected. It is
beneficial to use this command when troubleshooting dial backup (in addition to the debug dial-backup
command).
Usage Examples
The following example activates the debug messages for dialup interfaces:
>enable
#debug dialup-interfaces

debug dot11 all

Use the debug dot11 all command to enable all dot11 debugging for the wireless access controller (AC).
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates all dot11 debug messages on the AC:
>enable
#debug dot11 all

debug dot11 client

Use the debug dot11 client command to enable all dot11 client debugging for the wireless access
controller (AC). Debugging can also be limited to clients on a specific access point (AP) interface. Debug
disable the debug messages. Variations of this command include:
debug dot11 client

debug dot11 client interface dot11ap <ap interface>
your unit.
Syntax Description
interface dot11ap <ap interface>Optional. Activates debug messages for the specified AP interface.
Range is 1 to 8.
Default Values
Command History
Usage Examples
The following example activates debug messages for clients on AP interface 1:
>enable
#debug dot11 client interface dot11ap 1
2006.12.23 19:47:04 Dot11 Client: AP(1) Radio(1) VAP(1)Rx associate command from AP for
00:40:96:AB:3B:5E.
2006.12.23 19:48:40 Dot11 Client: AP(1) Radio(1) VAP(1)Rx disassociate command from AP for
00:40:96:AB:3B:5E.
These debug messages were captured as a wireless client associated and then
disassociated with the AP.

debug dot11 packet-events

Use the debug dot11 packet-events command to enable debugging for all 802.11 control protocol packet
events. Debugging can also be limited to a specified interface. Debug messages are displayed (real time)
on the terminal (or Telnet) screen. Use the no form of this command to disable the debug messages.
debug dot11 packet-events

debug dot11 packet-events interface <interface>
your unit.
Syntax Description
interface <interface> Optional. Activates debug messages for the specified interface. Specify an
debug dot11 packet-events interface ? for a complete list of valid
interfaces.
Default Values
Command History
Usage Examples
The following example activates packet-events debug messages on access point (AP) interface 1:
>enable
#debug dot11 packet-events interface dot11ap 1
#2006.12.23 18:54:25 Dot11 Packet Events: Rx Echo Req from MAC(00:A0:C8:1D:F8:57) AP(1)
2006.12.23 18:54:25 Dot11 Packet Events: Tx Echo Resp to MAC(00:A0:C8:1D:F8:57) AP(1)
2006.12.23 18:54:29 Dot11 Packet Events: Tx Query Req to MAC(00:A0:C8:1D:F8:57) AP(1)
2006.12.23 18:54:29 Dot11 Packet Events: Rx Query Resp from MAC(00:A0:C8:1D:F8:57) AP(1)
2006.12.23 18:54:36 Dot11 Packet Events: Rx Disc Resp from MAC(00:A0:C8:1D:F8:57) AP(1)

debug dot11 session

Use the debug dot11 session command to debug all dot11 sessions for the wireless access controller (AC).
Debugging may also be limited to a specified interface. Debug messages are displayed (real time) on the
terminal (or Telnet) screen. Use the no form of this command to disable the debug messages. Variations of
debug dot11 session

debug dot11 session interface <interface>
your unit.
Syntax Description
interface <interface> Optional. Activates debug messages for the specified interface. Specify an
debug dot11 session interface ? for a complete list of valid interfaces.
Default Values
Command History
Usage Examples
The following example activates all dot11 session debug messages:
>enable
#debug dot11 session
2006.12.23 19:56:22 DOT11.Session : AP 1: AP reboot.
2006.12.23 19:56:22 DOT11.Session : AP 1: Control session lost.
2006.12.23 19:56:22 DOT11.Session : AP 1: Control session established.

debug dynamic-dns
Use the debug dynamic-dns command to activate debug messages associated with dynamic domain
naming system (DNS). Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use
the no form of this command to disable the debug messages. Variations of this command include:
debug dynamic-dns
debug dynamic-dns verbose
your unit.
Syntax Description
verbose Optional. Activates detailed debug messages.
Default Values
Command History
Usage Examples
The following example activates dynamic DNS debug messages:
>enable
#debug dynamic-dns verbose

debug ethernet cfm

Use the debug ethernet cfm command to activate all debug messages associated with Ethernet operations,
administration, and maintenance (OAM) connectivity fault management (CFM). Debug messages are
displayed (real time) on the terminal (or Telnet) screen. Use the no form of this command to disable the
debug messages.
Use this command with caution as it causes a large amount of debug information. Large
amounts of debug information can adversely affect the performance of your unit. To avoid
an excess of debug information generation, select a debug command that does not activate
all CFM debug messages at once.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example activates system-wide Ethernet OAM CFM debug messages:
>enable
#debug ethernet cfm
2008.09.22 11:00:08 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2
2008.09.22 11:00:09 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=195)

debug ethernet cfm alarm

Use the debug ethernet cfm alarm command to activate debug messages associated with Ethernet
operations, administration, and maintenance (OAM) connectivity fault management (CFM) fault alarms.
command to disable the debug messages. Variations of this command include:
debug ethernet cfm alarm

debug ethernet cfm alarm domain <domain name>
debug ethernet cfm alarm domain <domain name> association <association name>
debug ethernet cfm alarm domain <domain name> association <association name> mep <mep id>
your unit.
Syntax Description
domain <domain name> Optional. Specifies that debug output is limited to alarm information for
maintenance endpoints (MEPs) of a specific domain.
association <association name> Optional. Specifies that debug output is limited to alarm information for
MEPs of a specific association.
mep <mep id> Optional. Specifies that debug output is limited to alarm information for
MEPs that match a specific MEP ID. MEP ID range is 1 to 8191.
Default Values
Command History
Functional Notes

Usage Examples
The following example enables all Ethernet OAM CFM alarm debug messages:
>enable
#debug ethernet cfm alarm
2008.09.22 11:06:20 CFM.FNG MD:BenchTest|MA:BenchAssoc|MEP:1|FNG|Set state: FNG_DEFECT
2008.09.22 11:06:22 CFM.FNG MD:BenchTest|MA:BenchAssoc|MEP:1|FNG|Set state:
FNG_REPORT_DEFECT
2008.09.22 11:06:22 CFM.FNG MD:BenchTest|MA:BenchAssoc|MEP:1|FNG|Set state:
FNG_DEFECT_REPORTED
2008.09.22 11:06:22 CFM.MD:BenchTest|MA:BenchAssoc|MEP:1| mep signaled new fault

debug ethernet cfm ccm rcv

Use the debug ethernet cfm ccm rcv command to activate debug messages associated with Ethernet
operations, administration, and maintenance (OAM) connectivity fault management (CFM) continuity
check message (CCM) receive paths. Debug messages are displayed (real time) on the terminal (or Telnet)
screen. Use the no form of this command to disable the debug messages. Variations of this command
include:
debug ethernet cfm ccm rcv

debug ethernet cfm ccm rcv domain <domain name>
debug ethernet cfm ccm rcv domain <domain name> association <association name>
debug ethernet cfm ccm rcv domain <domain name> association <association name> mep <mep id>
your unit.
Syntax Description
domain <domain name> Optional. Specifies that debug output is limited to CCM receive path
information for maintenance endpoints (MEPs) of a specific domain.
association <association name> Optional. Specifies that debug output is limited to CCM receive path
information for MEPs of a specific association.
mep <mep id> Optional. Specifies that debug output is limited to CCM receive path
information for MEPs that match a specific MEP ID. MEP ID range is 1
to 8191.
Default Values
Command History
Functional Notes

Usage Examples
The following example enables Ethernet OAM CFM debug messages for all CCM receive paths:
>enable
#debug ethernet cfm ccm rcv
2008.09.22 11:02:49 CFM.CCR MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

debug ethernet cfm ccm xmit

Use the debug ethernet cfm ccm xmit command to activate debug messages associated with Ethernet
operations, administration, and maintenance (OAM) connectivity fault management (CFM) continuity
check message (CCM) transmit paths. Debug messages are displayed (real time) on the terminal (or
Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this
command include:
debug ethernet cfm ccm xmit

debug ethernet cfm ccm xmit domain <domain name>
debug ethernet cfm ccm xmit domain <domain name> association <association name>
debug ethernet cfm ccm xmit domain <domain name> association <association name> mep <mep id>
your unit.
Syntax Description
domain <domain name> Optional. Specifies that debug output is limited to CCM transmit path
information for maintenance endpoints (MEPs) of a specific domain.
association <association name> Optional. Specifies that debug output is limited to CCM transmit path
information for MEPs of a specific association.
mep <mep id> Optional. Specifies that debug output is limited to CCM transmit path
information for MEPs that match a specific MEP ID. MEP ID range is 1
to 8191.
Default Values
Command History
Functional Notes

Usage Examples
The following example enables Ethernet OAM CFM debug messages for all CCM transmit paths:
>enable
#debug ethernet cfm ccm xmit
2008.09.22 11:01:43 CFM.CCM MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=290)

debug ethernet cfm linktrace

Use the debug ethernet cfm linktrace command to activate debug messages associated with Ethernet
operations, administration, and maintenance (OAM) connectivity fault management (CFM) linktrace
message paths. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no
form of this command to disable the debug messages. Variations of this command include:
debug ethernet cfm linktrace request

debug ethernet cfm linktrace request domain <domain name>
debug ethernet cfm linktrace request domain <domain name> association <association name>
debug ethernet cfm linktrace request domain <domain name> association <association name>
mep <mep id>
debug ethernet cfm linktrace response
debug ethernet cfm linktrace response domain <domain name>
debug ethernet cfm linktrace response domain <domain name> association <association name>
debug ethernet cfm linktrace response domain <domain name> association <association name>
mep <mep id>
your unit.
Syntax Description
request Specifies debug messages are enabled for linktrace message request
paths.
response Specifies debug messages are enabled for linktrace message response
paths.
domain <domain name> Optional. Specifies that debug output is limited to linktrace message
path information for maintenance endpoints (MEPs) of a specific
domain.
association <association name> Optional. Specifies that debug output is limited to linktrace message
path information for MEPs of a specific association.
mep <mep id> Optional. Specifies that debug output is limited to linktrace message
path information for MEPs that match a specific MEP ID. MEP ID range
is 1 to 8191.
Default Values
Command History

Functional Notes
Usage Examples
The following example enables Ethernet OAM CFM debug messages for all linktrace message request
paths:
>enable
#debug ethernet cfm linktrace request

debug ethernet cfm loopback

Use the debug ethernet cfm loopback command to activate debug messages associated with Ethernet
operations, administration, and maintenance (OAM) connectivity fault management (CFM) loopback
message paths. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no
debug ethernet cfm loopback request

debug ethernet cfm loopback request domain <domain name>
debug ethernet cfm loopback request domain <domain name> association <association name>
debug ethernet cfm loopback request domain <domain name> association <association name>
mep <mep id>
debug ethernet cfm loopback response
debug ethernet cfm loopback response domain <domain name>
debug ethernet cfm loopback response domain <domain name> association <association name>
debug ethernet cfm loopback response domain <domain name> association <association name>
mep <mep id>
your unit.
Syntax Description
request Specifies debug messages are enabled for loopback message request
paths.
response Specifies debug messages are enabled for loopback message
response paths.
domain <domain name> Optional. Specifies that debug output is limited to loopback message
path information for maintenance endpoints (MEPs) of a specific
domain.
association <association name> Optional. Specifies that debug output is limited to loopback message
path information for MEPs of a specific association.
mep <mep id> Optional. Specifies that debug output is limited to loopback message
path information for MEPs that match a specific MEP ID. MEP ID range
is 1 to 8191.
Default Values
Command History

Functional Notes
Usage Examples
The following example enables Ethernet OAM CFM debug messages for all loopback message request
paths:
>enable
#debug ethernet cfm loopback request

debug ethernet cfm remote-mep

Use the debug ethernet cfm remote-mep command to activate debug messages associated with Ethernet
operations, administration, and maintenance (OAM) connectivity fault management (CFM) remote
maintenance endpoints (MEPs). Debug messages are displayed (real time) on the terminal (or Telnet)
include:
debug ethernet cfm remote-mep

debug ethernet cfm remote-mep domain <domain name>
debug ethernet cfm remote-mep domain <domain name> association <association name>
debug ethernet cfm remote-mep domain <domain name> association <association name>
mep <mep id>
your unit.
Syntax Description
domain <domain name> Optional. Specifies that debug output is limited to information for remote
maintenance endpoints (MEPs) of a specific domain.
association <association name> Optional. Specifies that debug output is limited to information for remote
MEPs of a specific association.
mep <mep id> Optional. Specifies that debug output is limited to information for remote
MEPs that match a specific MEP ID. MEP ID range is 1 to 8191.
Default Values
Command History
Functional Notes

Usage Examples
The following example enables Ethernet OAM CFM debug messages for all remote MEPs:
>enable
#debug ethernet cfm remote-mep
2008.09.22 11:13:50 CFM.RMEP MD:BenchTest|MA:BenchAssoc|MEP:1|RMEP|Set CCMdefect: true
2008.09.22 11:13:53 CFM.MD:BenchTest|MA:BenchAssoc|MEP:1| mep signaled new fault alarm state (3)

debug firewall
Use the debug firewall command to activate debug messages associated with the AOS firewall operation.
command to disable the debug messages. Variations of this command include:
debug firewall
debug firewall vrf <name>
your unit.
Syntax Description
vrf <name> Optional. Displays debug information for the specified VPN routing and
forwarding (VRF).
Default Values
Command History
Functional Notes
The debug firewall command activates debug messages to provide real-time information about the AOS
stateful inspection firewall operation.
Usage Examples
The following example activates the debug messages for the AOS stateful inspection firewall:
>enable
#debug firewall

The following example activates the debug messages for the VRF instance gray and provides sample
output:
>enable
#debug firewall vrf gray
2000.05.11 19:29:04 FIREWALL_VRF.Gray SrcPort: 41801, DstPort: 80

2000.05.11 19:29:04 FIREWALL_VRF.Gray Selector2: Dir=Public, int=vlan 309, Protocol=6, VRF Black
cookie-> vlan 306
2000.05.11 19:29:04 FIREWALL_VRF.Gray SrcIp: 192.168.10.140, DstIp: 192.168.9.6
2000.05.11 19:29:04 FIREWALL_VRF.Gray SrcPort: 80, DstPort: 41801
2000.05.11 19:29:04 FIREWALL_VRF.Gray Deleting Association
2000.05.11 19:29:04 FIREWALL_VRF.Gray Assoc Index = 6242787, Count (total, policy-class) = 127,
126
2000.05.11 19:29:04 FIREWALL_VRF.Gray nat source -> 192.168.9.6, flags = 0x2000003F, 0x00000004,
timeout = 6

debug firewall alg sip

Use the debug firewall alg sip command to activate debug messages associated with Session Initiation
Protocol (SIP) information with AOS firewall operation. Debug messages are displayed (real time) on the
debug firewall alg sip

debug firewall alg sip packets
debug firewall alg sip verbose
your unit.
Syntax Description
packets Optional. Activates firewall application-level gateway (ALG) SIP packet
debug messages.
Default Values
Command History
Release A1 Command was expanded to include the packets parameter.
Usage Examples
The following example activates debug messages associated with SIP information with AOS firewall
operation:
>enable
#debug firewall alg sip

debug frame-relay lmi

Use the debug frame-relay lmi command to activate debug messages associated with the Frame Relay
operation for the local management interface (LMI), such as data link connection identifier (DLCI) status
signaling state, etc. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Release 17.6 Command was altered to remove events and llc2 options.
Functional Notes
The debug frame-relay lmi command activates debug messages to aid in the troubleshooting of Frame
Relay links.
Usage Examples
The following example activates debug messages associated with Frame Relay LMI operation:
>enable
#debug frame-relay lmi

debug frame-relay multilink

Use the debug frame-relay multilink command to activate debug messages associated with Frame Relay
multilink operation. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the
no form of this command to disable the debug messages. Variations of this command include:
debug frame-relay multilink

debug frame-relay multilink <interface>
debug frame-relay multilink states
your unit.
Syntax Description
<interface> Optional. Activates debug messages for the specified interface. Specify an
debug frame-relay multilink ? for a complete list of applicable interfaces.
states Optional. Activates the debug messages for Link Integrity Protocol (LIP).
Default Values
Command History
Usage Examples
The following example activates debug messages associated with multilink operation for all Frame Relay
interfaces:
>enable
#debug frame-relay multilink

debug gvrp bpdus

Use the debug gvrp bpdus command to display debug messages showing all GARP VLAN Registration
Protocol (GVRP) configuration messages sent and received on the switch. Debug messages are displayed
(real time) on the terminal (or Telnet) screen. Use the no form of this command to disable the debug
messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
With GVRP enabled on many ports, this command can produce a lot of output. To display these messages
for individual interfaces, refer to the command debug gvrp interface <interface> on page 215.
Usage Examples
The following example displays debug messages showing GVRP configuration messages sent and
received on Ethernet interface 0/24:
>enable
#debug gvrp bpdus
2000.07.31 23:15:51 GVRP BPDUS.eth 0/24: TX = (Len:2 LeaveAll) (Len:4 JoinIn Vlan:1) (End) ... SENT
2000.07.31 23:15:52 GVRP BPDUS.eth 0/24: RX = (Len:4 Empty Vlan:2) (Len:4 JoinIn Vlan:20) (end)
2000.07.31 23:15:52 GVRP BPDUS.eth 0/24: TX = (Len:4 JoinIn Vlan:1) (End) ... SENT
2000.07.31 23:15:52 GVRP BPDUS.eth 0/24: RX = (Len:4 JoinIn Vlan:20) (end)
2000.07.31 23:16:00 GVRP BPDUS.eth 0/24: RX = (Len:2 LeaveAll) (end)
#

debug gvrp interface <interface>

Use the debug gvrp interface command to display GARP VLAN Registration Protocol (GVRP) debug
messages related to a particular interface. Debug messages are displayed (real time) on the terminal (or
command include:
debug gvrp interface <interface> bpdus

debug gvrp interface <interface> vlans
your unit.
Syntax Description
<interface> Activates debug messages for the specified interface. Specify an interface
wireless virtual access point, use dot11ap 1/1.1. Type debug gvrp
bpdus Displays debug messages showing all GVRP configuration messages sent
and received on the interface.
vlans Displays debug messages showing all GVRP-related VLAN changes
occurring on the interface.
Default Values
Command History
Usage Examples
The following example displays debug messages showing GVRP configuration messages sent and
received on Ethernet interface 0/24:
>enable
#debug gvrp interface ethernet 0/24 bpdus
2000.07.31 23:15:51 GVRP BPDUS.eth 0/24: TX = (Len:2 LeaveAll) (Len:4 JoinIn Vlan:1) (End) ... SENT
2000.07.31 23:15:52 GVRP BPDUS.eth 0/24: RX = (Len:4 Empty Vlan:2) (Len:4 JoinIn Vlan:20) (end)
2000.07.31 23:15:52 GVRP BPDUS.eth 0/24: TX = (Len:4 JoinIn Vlan:1) (End) ... SENT
--MORE--

debug gvrp vlans

Use the debug gvrp vlans command to display debug messages showing all GARP VLAN Registration
Protocol (GVRP) VLAN changes. Debug messages are displayed (real time) on the terminal (or Telnet)
include:
debug gvrp vlans

debug gvrp vlans <vlan id>
your unit.
Syntax Description
<vlan id> Optional. Activates debug messages for GVRP-related VLAN changes for
the specified VLAN. Range is 1 to 4094.
Default Values
Command History
Functional Notes
With GVRP enabled on many ports, this command can produce a lot of output. To display these messages
for an individual interface, refer to the command debug gvrp interface <interface> on page 215.
Usage Examples
The following example displays debug messages showing GVRP-related VLAN changes for VLAN 1:
>enable
#debug gvrp vlans 1
#
2000.07.31 22:05:42 GVRP VLANS: Creating dynamic VLAN 20
2000.07.31 22:05:42 GVRP VLANS.eth 0/24: Dynamically adding port to VLAN 20
#
2000.07.31 22:05:56 INTERFACE_STATUS.eth 0/24 changed state to down
2000.07.31 22:06:08 GVRP VLANS.eth 0/24: Dynamically removing port from VLAN 20
2000.07.31 22:06:08 GVRP VLANS: Last port removed from VLAN 20, destroying VLAN

debug hw-access-list <name>

Use the debug hw-access-list command to activate debug messages that display traffic matches logged by
the named hardware access control list (ACL). Use the no form of this command to disable the debug
messages.
your unit.
Syntax Description
<name> Specifies the name of the hardware ACL.
Default Values
Command History
Functional Notes
The debug hw-access-list <name> command displays data gathered by a configured hardware ACL. The
specified hardware ACL must have logging enabled to populate the debug message. For more information
on hardware ACLs and event match logging, refer to the Hardware ACL and Access Map Command Set
on page 2491.
Only hardware ACL debug messages can be displayed using this command. If you enter a
software ACL name in this command, you will receive an error message.
Usage Examples
Enter the command as follows to enable debug messages for the hardware ACL ADTN:
>enable
#debug hw-access-list ADTN
2009.05.07 11:32:39 ACCESS_LIST.ADTN permit mac 00:a0:c8:00:00:00 00:00:00:ff:ff:ff any log (44864
matches)
matches)
matches)

debug interface <interface>

Use the debug interface command to activate debug messages associated with the specified interface.
your unit.
Syntax Description
<interface> Activates debug messages for the specified interface. Specify an interface
wireless virtual access point, use dot11ap 1/1.1. Type debug
Default Values
Command History
Release 6.1 Command was expanded to include the T1 and foreign exchange station
(FXS) interfaces.
Release 7.1 Command was expanded to include the foreign exchange office (FXO)
interface.
Release 9.1 Command was expanded to include the tunnel interface.
Functional Notes
The debug interface command activates debug messages to aid in the troubleshooting of physical
interfaces.
Usage Examples
The following example activates all possible debug messages associated with the Ethernet port:
>enable
#debug interface ethernet

debug interface adsl events

Use the debug interface adsl events command to activate debug messages associated with asymmetric
digital subscriber line (ADSL) events. Debug messages are displayed (real time) to the terminal (or Telnet)
screen. Use the no form of this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages for ADSL events:
>enable
#debug interface adsl events

debug interface cellular

Use the debug interface cellular command to activate debug messages associated with the cellular
interface. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form of
this command to disable the debug messages. Variations of this command include:
debug interface cellular

debug interface cellular <slot/port>
debug interface cellular <slot/port> data
debug interface cellular <slot/port> data-hdlc
debug interface cellular <slot/port> diag-hdlc
debug interface cellular <slot/port> diagnostic
debug interface cellular <slot/port> diagnostic rx
debug interface cellular <slot/port> diagnostic tx
debug interface cellular <slot/port> diagnostic both
debug interface cellular <slot/port> download
your unit.
Syntax Description
<slot/port> Optional. Activates debug messages for the specified cellular interface.
data Optional. Activates debug messages for the handshaking signals on the
data channel.
data-hdlc Optional. Activates debug messages for high level data link control (HDLC)
errors on the data channel.
diag-hdlc Optional. Activates debug messages for HDLC errors on the diagnostic
channel.
diagnostic Optional. Activates debug messages for all packets.
diagnostic rx Optional. Activates debug messages for packets moving from the cellular
interface to the network.
diagnostic tx Optional. Activates debug messages for packets moving from the network
to the cellular interface.
diagnostic both Optional. Activates debug messages for both transmitted and received
packets.
download Optional. Activates debug messages for application downloads.
Default Values

Command History
Release 17.4 Command was expanded to include the keyword both.
Usage Examples
The following example activates error and event debug messages associated with the cellular interface:
>enable
#debug interface cellular

debug ip bgp
Use the debug ip bgp command to activate debug messages associated with IP Border Gateway Protocol
(BGP). Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no form of
debug ip bgp
debug ip bgp events
debug ip bgp in
debug ip bgp out
debug ip bgp keepalives
debug ip bgp updates
debug ip bgp updates quiet
your unit.
Syntax Description
events Optional. Displays significant BGP events, such as a neighbor state
change.
in/out Optional. Displays the same information as debug ip bgp, but limits
messages to the specified direction (in or out).
keepalives Optional. Displays BGP keepalive packets.
updates Optional. Displays detailed information on BGP updates for all neighbors.
updates quiet Optional. Displays summary information about BGP neighbor updates.
(Note: updates quiet displays a one-line summary of what update displays
in 104 lines.)
Default Values
Command History
Functional Notes
If no arguments are given, the debug ip bgp command displays general BGP events, such as
sent/received message summaries, route processing actions, and results. Keepalive packets are not
debugged with this command.

Usage Examples
The following example enables debug messages on general outbound BGP messages and events:
>enable
#debug ip bgp out
#07:42:39: BGP OUT 10.15.240.1[2]: Transmitting msg, type=UPDATE (2), len=142

debug ip dhcp-client
Use the debug ip dhcp-client command to activate debug messages associated with Dynamic Host
Configuration Protocol (DHCP) client operation in AOS. Debug messages are displayed (real time) to the
debug ip dhcp-client
debug ip dhcp-client <interface>
your unit.
Syntax Description
<interface> Optional. Specifies an interface to which an IP address can be assigned in
the format <interface type [slot/port | slot/port.subinterface id | interface id |
an Ethernet subinterface, use eth 0/1.1; for a PPP interface, use ppp 1; for
an ATM subinterface, use atm 1.1; and for a wireless virtual access point,
use dot11ap 1/1.1. Type debug ip dhcp-client ? for a list of valid
interfaces.
Default Values
Command History
Release 16.1 Command was expanded to include the interface parameter.
Functional Notes
The debug ip dhcp-client command activates debug messages to provide information on DHCP client
activity in AOS. The AOS DHCP client capability allows interfaces to dynamically obtain an IP address
from a network DHCP server.
Usage Examples
The following example activates debug messages associated with DHCP client activity:
>enable
#debug ip dhcp-client

The following example gives sample output from debug ip dhcp-client activation on an Ethernet interface:
#debug ip dhcp-client
2007.06.25 13:39:04 DHCP.CLIENT eth 0/1.16 Processing Renew
2007.06.25 13:39:04 DHCP.CLIENT eth 0/1.16 Loading timer 1 with 1 seconds
2007.06.25 13:39:06 DHCP.CLIENT eth 0/1.16 Sending Discover Message: Xid = 42d05c
6d
2007.06.25 13:39:07 DHCP.CLIENT eth 0/1.16 Timer 2 Expired
2007.06.25 13:39:07 DHCP.CLIENT eth 0/1.16 Processing Offer Message: Xid = 42d05c
6d
2007.06.25 13:39:07 DHCP.CLIENT eth 0/1.16 Sending Request Message: Xid = 42d05c
6d
2007.06.25 13:39:07 DHCP.CLIENT eth 0/1.16 Processing Ack Message: Xid = 42d05c
6d

debug ip dhcp-server
Use the debug ip dhcp-server command to activate debug messages associated with Dynamic Host
Configuration Protocol (DHCP) server operation in AOS. Debug messages are displayed (real time) to the
debug ip dhcp-server
debug ip dhcp-server vrf <name>
your unit.
Syntax Description
vrf <name> Optional. Displays debug information for the specified VPN routing and
forwarding (VRF).
Default Values
Command History
Functional Notes
The debug ip dhcp-server command activates debug messages to provide information on DHCP server
activity in AOS. The AOS DHCP server capability allows AOS to dynamically assign IP addresses to hosts
on the network.
Usage Examples
The following example activates debug messages associated with DHCP server activity only on the default
VRF:
>enable
#debug ip dhcp-server

The following example activates debug messages associated with DHCP server activity on the VRF
instance RED:
>enable
#debug ip dhcp-server vrf RED
#
#2007.10.15 09:21:26 DHCP.SERVER Processing Discover Message (Xid = 230e4558) on
192.168.20.0/255.255.255.0 from 00:A0:C8:0D:E9:AD vrf=RED
2007.10.15 09:21:27 DHCP.SERVER Offering IP Address 192.168.20.2 to 00:A0:C8:0D:E9:AD vrf=RED
2007.10.15 09:21:27 DHCP.SERVER Server sent an Offer to the client vrf=RED
2007.10.15 09:21:27 DHCP.SERVER Processing Request Message (Xid = 230e4558) on
192.168.20.0/255.255.255.0 from 00:A0:C8:0D:E9:AD vrf=RED
2007.10.15 09:21:27 DHCP.SERVER Server sent an Ack to the client vrf=RED

debug ip dns-client
Use the debug ip dns-client command to activate debug messages associated with domain naming system
(DNS) client operation in AOS. Debug messages are displayed (real time) to the terminal (or Telnet)
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The debug ip dns-client command activates debug messages to provide information on DNS client
activity in AOS. The IP DNS capability allows for DNS-based host translation (name-to-address).
Usage Examples
The following example activates debug messages associated with DNS client activity:
>enable
#debug ip dns-client

debug ip dns-proxy
Use the debug ip dns-proxy command to activate debug messages associated with domain naming system
(DNS) proxy operation in AOS. Debug messages are displayed (real time) to the terminal (or Telnet)
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The debug ip dns-proxy command activates debug messages to provide information on DNS proxy
activity in AOS. The IP DNS capability allows for DNS-based host translation (name-to-address).
Usage Examples
The following example activates debug messages associated with DNS proxy activity:
>enable
#debug ip dns-proxy

debug ip dns-table
Use the debug ip dns-table command to activate debug messages associated with domain naming system
(DNS) table operation in AOS. Debug messages are displayed (real time) to the terminal (or Telnet)
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The debug ip dns-table command activates debug messages to provide information on DNS table activity
in AOS. The IP DNS capability allows for DNS-based host translation (name-to-address).
Usage Examples
The following example activates debug messages associated with DNS table activity:
>enable
#debug ip dns-table

debug ip flow
Use the debug ip flow command to display debug messages associated with integrated traffic monitoring
(ITM) operation. Use the no form of this command to disable the debug messages. Variations of this
command include:
debug ip flow cache entry

debug ip flow cache expiration
debug ip flow export
your unit.
Syntax Description
cache entry Specifies a debug message will be generated every time traffic flow data is
added to the flow cache.
cache expiration Specifies a debug message will be generated every time traffic flow data
expires from the flow cache.
export Specifies a debug message will be generated every time a message is sent
to an external data collector.
Default Values
By default, debug messages in AOS are disabled.
Command History
Usage Examples
The following example enables debug messages for the ip flow export command and gives sample
output:
#debug ip flow export

#show run
ip flow export destination 10.22.22.254 3000
ip flow export vrf BLUE destination 172.16.4.5 65774
*Dec 18 22:45:43: IPFLOW: Sent export pkt #32958 to 10.22.22.254:3000

*Dec 18 22:45:43: IPFLOW: Sent export pkt #32958 to 172.16.4.5:65774 (BLUE)

The following is sample output from the debug ip flow cache expiration command:
#debug ip flow cache expiration

#show run
interface shdsl 2/1
16:38:37: FLOW.CACHE: Expired 10.23.197.244:23 > 172.22.77.208: 1188 out eth 0/1 <T=0/P=6>
16:38:37: FLOW.CACHE: Îdle Time = 60, Active Time = 60
interface adsl 1/1
16:39:20: FLOW.CACHE: Expired 10.23.197.244.23 > 172.22.77.208:1189 out eth 0/1 <T=0/P=6>
16:39:20: FLOW.CACHE: Îdle Time = 60, Active Time = 90
The following is an output sample from the debug ip flow cache entry command:
#debug ip flow cache entry

#show run
16:52:20: FLOW.CACHE: Added 172.22.77.208: 1189 > 10.23.197.244: 23 in eth 0/1 <T=0/P=6>

debug ip ftp-server
Use the debug ip ftp-server command to activate debug messages associated with File Transfer Protocol
(FTP) server events in the AOS device. Debug messages are displayed (real time) to the terminal (or
Telnet) screen. Use the no form of this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The debug ip ftp-server command activates debug messages to provide information on FTP server
activity in AOS. The FTP server capability allows for fast file management and transport for local or remote
devices.
Usage Examples
The following example activates debug messages associated with FTP server activity:
>enable
#debug ip ftp-server

debug ip http client

Use the debug ip http client command to activate debug messages associated with Hypertext Transfer
Protocol (HTTP) client operation in AOS. Debug messages are displayed (real time) to the terminal (or
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with HTTP client activity:
>enable
#debug ip http client

debug ip http server

Use the debug ip http server command to activate debug messages associated with Hypertext Transfer
Protocol (HTTP) server operation in AOS. Debug messages are displayed (real time) to the terminal (or
command include:
debug ip http server

debug ip http server verbose
your unit.
Syntax Description
verbose Optional. Activates detailed debug messages for HTTP operation.
Default Values
Command History
Release 15.1 Command was updated.
Usage Examples
The following example activates debug messages associated with HTTP server activity:
>enable
#debug ip http server

debug ip icmp
Use the debug ip icmp command to show all Internet Control Message Protocol (ICMP) messages as they
come into the router or are originated by the router. If an optional keyword (send or recv) is not used, all
results are displayed. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the
debug ip icmp
debug ip icmp send
debug ip icmp recv
your unit.
Syntax Description
send Optional. Displays only ICMP messages sent by the router.
recv Optional. Displays only ICMP messages received by the router.
Default Values
Command History
Usage Examples
The following example activates the debug ip icmp send and receive messages for AOS:
>enable
#debug ip icmp
ICMP SEND: From (0.0.0.0) to (172.22.14.229) Type=8 Code=0 Length=72 Details:echo request
ICMP RECV: From (172.22.14.229) to (10.100.23.19) Type=0 Code=0 Length=72 Details:echo reply
ICMP SEND: From (0.0.0.0) to (172.22.14.229) Type=8 Code=0 Length=72 Details:echo request
ICMP RECV: From (172.22.14.229) to (10.100.23.19) Type=0 Code=0 Length=72 Details:echo reply
ICMP RECV: From (172.22.255.200) to (10.100.23.19) Type=11 Code=0 Length=36 Details:TTL equals 0
during transit
ICMP RECV: From (172.22.14.229) to (10.100.23.19) Type=3 Code=3 Length=36 Details:port
unreachable
ICMP RECV: From (172.22.14.229) to (10.100.23.19) Type=3 Code=3 Length=36 Details:port
unreachable

debug ip igmp
Use the debug ip igmp command to enable debug messages for Internet Group Management Protocol
(IGMP) transactions (including helper activity). Debug messages are displayed (real time) on the terminal
command include:
debug ip igmp
debug ip igmp <ip address>
your unit.
Syntax Description
<ip address> Optional. Specifies the IP address of a multicast group. IP addresses should
Default Values
Command History
Usage Examples
The following example enables IGMP debug messages for the specified multicast group:
>enable
#debug ip igmp 224.1.1.1

debug ip igmp snooping

Use the debug ip igmp snooping command to enable debug messages for Internet Group Management
Protocol (IGMP) snooping errors and events. Debug messages are displayed (real time) on the terminal (or
command include:
debug ip igmp snooping

debug ip igmp snooping verbose
your unit.
Syntax Description
verbose Optional. Enables detailed debug messages.
Default Values
Command History
Usage Examples
The following example enables IGMP snooping debug messages:
>enable
#debug ip igmp snooping

debug ip mrouting
Use the debug ip mrouting command to activate debug messages associated with multicast table routing
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following sample activates ip mrouting debug messages:
>enable
#debug ip mrouting

debug ip ospf
Use the debug ip ospf command to activate debug messages associated with open shortest path first
(OSPF) routing operations. Debug messages are displayed (real time) to the terminal (or Telnet) screen.
Use the no form of this command to disable the debug messages. Variations of this command include:
debug ip ospf
debug ip ospf adj
debug ip ospf database-timer
debug ip ospf events
debug ip ospf flood
debug ip ospf hello
debug ip ospf lsa-generation
debug ip ospf packet
debug ip ospf retransmission
debug ip ospf spf
debug ip ospf tree
your unit.
Syntax Description
adj Optional. Displays OSPF adjacency events.
database-timer Optional. Displays OSPF database timer.
events Optional. Displays OSPF events.
flood Optional. Displays OSPF flooding.
hello Optional. Displays OSPF hello events.
lsa-generation Optional. Displays OSPF link state advertisement (LSA) generation.
packet Optional. Displays OSPF packets.
retransmission Optional. Displays OSPF retransmission events.
spf Optional. Displays OSPF shortest path first (SPF) calculations.
tree Optional. Displays OSPF database tree.
Default Values
Command History

Usage Examples
The following is an example of debug ip ospf command results:
>enable
#debug ip ospf flood
OSPF: Update LSA: id=c0a8020d rtid=192.168.2.13 area=11.0.0.0 type=1
OSPF: Update LSA: id=0b003202 rtid=11.0.50.2 area=11.0.0.0 type=1
OSPF: Queue delayed ACK lasid=0b003202 lsartid=11.0.50.2 nbr=11.0.50.2
OSPF: Rx ACK lasid=c0a8020d lsartid=192.168.2.13 nbr=11.0.50.2
OSPF: Received LSA ACK LSA_ID=-64.-88.2.13 LSA_RT_ID=-64.-88.2.13
OSPF: Rx ACK lasid=00000000 lsartid=192.168.2.13 nbr=11.0.50.2
OSPF: Received LSA ACK LSA_ID=0.0.0.0 LSA_RT_ID=-64.-88.2.13
OSPF: Sending delayed ACK
OSPF: Update LSA: id=c0a8020d rtid=192.168.2.13 area=11.0.0.0 type=1
OSPF: Flooding out last interface
OSPF: Update LSA: id=0b003202 rtid=11.0.50.2 area=11.0.0.0 type=1

debug ip packet
Use the debug ip packet command to display debug messages for every IP packet forwarded through the
unit. Adding the VRF name to this command displays debug information only for the named VPN routing
and forwarding (VRF). Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use
the no form of this command to disable the debug messages. Variations of this command include the
following:
debug ip packet
debug ip packet detail
debug ip packet dump
debug ip packet <acl name>
debug ip packet <acl name> detail
debug ip packet <acl name> dump
debug ip packet any-vrf
debug ip packet any-vrf <acl name>
debug ip packet any-vrf <acl name> detail
debug ip packet any-vrf <acl name> dump
debug ip packet any-vrf detail
debug ip packet any-vrf dump
debug ip packet vrf <name>
debug ip packet vrf <name> <acl name>
debug ip packet vrf <name> <acl name> detail
debug ip packet vrf <name> <acl name> dump
debug ip packet vrf <name> detail
debug ip packet vrf <name> dump
your unit.
Syntax Description
detail Optional. Displays IP packet detailed information.
dump Optional. Displays IP packet detailed information, as well as a hex dump of
the packets payload.
Note: The console stream can be captured to a log file and used as an input
file for display with ETHEREAL/Wireshark by using text2pcap.exe, which is
a part of the ETHEREAL/Wireshark distribution.
Execute as follows: text2pcap -l 101 <input_file> <output_file>

Next, open the output file with ETHEREAL/Wireshark for display and
decode. The typical lower layer information in ETHEREAL/Wireshark may
not be present. This converted capture file is treated as a raw IP capture
and also has no timestamp data. Remember to take advantage of access
control lists (ACLs) to narrow down the amount of data being processed
with this facility. This is a CPU-intensive operation, and also disables any
fast flow/fast cache routing.
<acl name> Optional. Displays debug information for a specific ACL.
any-vrf Optional. Displays debug information for all VRFs, including the default.
vrf <name> Optional. Displays debug information for the specified VRF.
Default Values
Command History
Functional Notes
Usage Examples
The following is sample output for the debug ip packet command, which provides debug information for
the default VRF only:
>enable
#debug ip packet
IP: s= 192.168.8.101 (eth 0/1) d=192.168.7.2 (eth 0/2) g= 192.168.7.2, forward

Where:
s=192.168.8.101 (eth 0/1) indicates source address and interface of received packet.
d=192.168.7.2 (eth 0/2) indicates destination address and interface from which the packet is being sent.
g=192.168.7.2 indicates the address of the next-hop gateway.
forward indicates the router is forwarding this packet.

The following is sample output for the debug ip packet vrf <vrf name> command for the VRF named Red:
>enable
#debug ip packet vrf RED
IP: s=192.168.1.100 (eth 0/1.4) d=192.168.1.255 (Loopback), vrf=RED, rcvd

IP: s=192.168.1.1 (Loopback) d=192.168.1.101 (eth 0/1.4) g=192.168.1.101, vrf=RED, forward
Where:
rcvd indicates the router received this packet.
The following is sample output for the debug ip packet any-vrf command:
>enable
#debug ip packet any-vrf
IP: s=192.168.1.15 (eth 0/1.1) d=192.168.1.1 (Loopback), rcvd

IP: s=192.168.1.1 (Loopback) d=192.168.1.15 (eth 0/1.1) g=192.168.1.15, forward
IP: s=192.168.2.33 (eth 0/1.3) d=192.168.2.1 (Loopback), vrf=BLU, rcvd
IP: s=192.168.2.1 (Loopback) d=192.168.2.33 (eth 0/1.3) g=192.168.2.33, vrf=BLU, forward
Where:
if the vrf=<name> statement is not present, the packet was present on the default VRF.
vrf=<name> indicates the non-default VRF from which the packet was received.
forward indicates the router transmitted this packet.
g=x.x.x.x indicates the next-hop IP address to which the packet was forwarded.

debug ip pim-sparse
Use the debug ip pim-sparse command to display all protocol-independent multicast (PIM) sparse mode
information. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form
of this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates all PIM sparse mode messages:
>enable
#debug ip pim-sparse

debug ip pim-sparse assert

Use the debug ip pim-sparse assert command to display debug messages associated with
protocol-independent multicast (PIM) sparse assert transactions. Debug messages are displayed (real time)
to the terminal (or Telnet) screen. Use the no form of this command to disable the debug messages.
debug ip pim-sparse assert

debug ip pim-sparse assert event
debug ip pim-sparse assert event <multicast address>
debug ip pim-sparse assert state
debug ip pim-sparse assert state <multicast address>
your unit.
Syntax Description
event Optional. Displays PIM sparse assert events.
state Optional. Displays PIM sparse assert state changes.
<multicast address> Optional. Specifies multicast group IP address to filter. The multicast group
IP address range is 244.0.0.0 to 239.255.255.255 or 224.0.0.0 /4.
Default Values
Command History
Usage Examples
The following example activates all PIM sparse assert event messages:
>enable
#debug ip pim-sparse assert event
14:25:05: PIMSM: Assert - MRoute (*, 239.255.255.250, eth 0/2) processed Received Join in NoInfo state
14:25:29: PIMSM: Assert - MRoute (10.100.13.240, 239.192.19.136, eth 0/2) processed Received Join in
NoInfo state

debug ip pim-sparse hello

Use the debug ip pim-sparse hello command to display protocol-independent multicast (PIM) sparse
mode hello transactions. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use
the no form of this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates PIM sparse mode hello messages:
>enable
#debug ip pim-sparse hello

debug ip pim-sparse joinprune

Use the debug ip pim-sparse joinprune command to display protocol-independent multicast (PIM)
sparse mode join and prune transactions. Debug messages are displayed (real time) to the terminal (or
command include:
debug ip pim-sparse joinprune

debug ip pim-sparse joinprune event
debug ip pim-sparse joinprune event <multicast address>
debug ip pim-sparse joinprune state
debug ip pim-sparse joinprune state <multicast address>
your unit.
Syntax Description
event Optional. Displays PIM sparse join and prune events.
state Optional. Displays PIM sparse join and prune state changes.
Default Values
Command History
Usage Examples
The following example activates PIM sparse mode messages for all join and prune events and state
changes:
>enable
#debug ip pim-sparse joinprune
14:27:05: PIMSM: Processed JOIN(*, 239.255.255.250) from 10.10.10.2
14:27:29: PIMSM: Processed JOIN(10.100.13.240, 239.192.19.136) from 10.10.10.2
14:27:56: PIMSM: Sent JOIN(10.100.13.240, 239.192.19.136) to 10.100.13.240

debug ip pim-sparse packets

Use the debug ip pim-sparse packets command to display protocol-independent multicast (PIM) sparse
mode packet information. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use
the no form of this command to disable the debug messages.Variations of this command include:
debug ip pim-sparse packets

debug ip pim-sparse packets in
debug ip pim-sparse packets in <interface>
debug ip pim-sparse packets out
debug ip pim-sparse packets out <interface>
your unit.
Syntax Description
in Optional. Displays messages for inbound PIM sparse packets.
out Optional. Displays messages for outbound PIM sparse packets.
<interface> Optional. Specifies an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type debug ip pim-sparse packets ? for a list of valid
interfaces.
Default Values
Command History
Usage Examples
The following example activates all PIM sparse packet messages (both inbound and outbound):
>enable
#debug ip pim-sparse packets

debug ip pim-sparse register

Use the debug ip pim-sparse register command to display protocol-independent multicast (PIM) sparse
source registration messages. Debug messages are displayed (real time) to the terminal (or Telnet) screen.
debug ip pim-sparse register

debug ip pim-sparse register event
debug ip pim-sparse register event <multicast address>
debug ip pim-sparse register state
debug ip pim-sparse register state <multicast address>
your unit.
Syntax Description
event Optional. Displays PIM sparse register events.
state Optional. Displays PIM sparse register state changes.
Default Values
Command History
Usage Examples
The following example activates all PIM sparse registration changes:
>enable
#debug ip pim-sparse register
18:14:22: PIMSM: Registered new source (10.100.13.240, 239.192.19.136) from 10.10.10.1
18:14:22: PIMSM: RegisterStop(10.100.13.240, 239.192.19.136) sent to 10.10.10.1

debug ip policy
Use the debug ip policy command to display policy-based routing events. Debug messages are displayed
messages. Variations of this command include the following:
debug ip policy
debug ip policy <acl name>
your unit.
Syntax Description
<acl name> Optional. Displays debug information only for the specified access control
list (ACL).
Default Values
Command History
Release 16.1 Command was expanded to filter based on an ACL.
Usage Examples
The following example creates a standard ACL named PVT, which permits packets sourced from the
10.22.0.0/16 network and displays only these policy-based routing event messages:
>enable
#ip access-list standard PVT
#permit 10.22.0.0 0.0.255.255
#deny any
#debug ip policy PVT

debug ip rip
Use the debug ip rip command to activate debug messages associated with Routing Information Protocol
(RIP) operation in AOS. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use
debug ip rip
debug ip rip events
your unit.
Syntax Description
events Optional. Displays only RIP protocol events.
Default Values
Command History
Functional Notes
The debug ip rip command activates debug messages to provide information on RIP activity in AOS. RIP
allows hosts and routers on a network to exchange information about routes.
Usage Examples
The following example activates debug messages associated with RIP activity:
>enable
#debug ip rip

debug ip route-cache express

Use the debug ip route-cache express command to activate debug messages associated with Layer 3
switching.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
>enable
#debug ip route-cache express
xRt: Periodic ARP for 10.2.42.254
xRt: Processed 1 ARP events, with 0 remaining
xRt: host entry added: IP=192.168.1.10, MAC=00:10:94:00:00:01, Vlan=1

xRt: host entry not added (no ARL entry): IP=192.168.5.10, MAC=00:10:96:00:00:01, Vlan=5
xRt: host entry added: IP=192.168.13.10, MAC=00:10:9a:00:00:01, Vlan=13
xRt: host entry not added (no ARL entry): IP=192.168.15.10, MAC=00:10:9b:00:00:01, Vlan=15
xRt: host entry added: IP=192.168.17.10, MAC=00:10:9c:00:00:01, Vlan=17
xRt: host entry added: IP=192.168.19.10, MAC=00:10:9d:00:00:01, Vlan=19
xRt: Processed 10 L2 events, with 393 remaining
xRt: host entry added (ARL entry found): IP=192.168.1.20, MAC=00:10:94:00:00:0b, Vlan=1
xRt: host entry added (ARL entry found): IP=192.168.15.10, MAC=00:10:9b:00:00:01, Vlan=15
xRt: host entry added (ARL entry found): IP=192.168.3.18, MAC=00:10:95:00:00:09, Vlan=3
xRt: host entry added (ARL entry found): IP=192.168.3.41, MAC=00:10:95:00:00:20, Vlan=3
xRt: Processed 10 L2 events, with 217 remaining

xRt: ARP entry for 192.168.3.10 was updated


debug ip routing
Use the debug ip routing command to activate debug messages associated with routing table events.
Adding the VRF name to this command displays debug information for the named VPN routing and
forwarding (VRF). Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no
form of this command to disable the debug messages. Variations of this command include the following:
debug ip routing
debug ip routing vrf <name>
your unit.
Syntax Description
vrf <name> Optional. Displays debug information only for the specified VRF. If a VRF is
not specified, the unnamed default VRF is assumed.
Default Values
Command History
Functional Notes
Usage Examples
The following example activates debug messages associated with routing table events:
>enable
#debug ip routing

The following example activates the debug messages associated with routing table events on the
nondefault VRF named RED and provides sample output:
>enable
#debug ip routing vrf RED
ip route vrf RED 1.2.3.0 255.255.255.0 192.168.10.10

15:32:29: ROUTING: Add route for 1.2.3.0/24 nh=192.168.10.10 vrf=RED
15:32:29: ROUTING: Remove route for 1.2.3.0/24 nh=192.168.10.10 vrf=RED
15:32:29: ROUTING: Remove route for 1.2.3.0/24 nh=192.168.10.10 vrf=RED
Where:
nh=192.168.10.10 indicates the next-hop address.

vrf=RED indicates the nondefault VRF where the route is present.

debug ip rtp quality-monitoring

Use the debug ip rtp quality-monitoring command to display voice quality monitoring (VQM) event
debug messages (real time) to the terminal (or Telnet) screen. Use the no form of this command to disable
the debug messages. Variations of this command include the following:
debug ip rtp quality-monitoring

debug ip rtp quality-monitoring packets
debug ip rtp quality-monitoring packets rtcp
debug ip rtp quality-monitoring packets rtp
debug ip rtp quality-monitoring packets round-trip-delay
your unit.
Syntax Description
packets Optional. Displays VQM debug events of voice traffic packets.
packets rtcp Optional. Displays VQM debug messages for Realtime Transport Control
Protocol (RTCP) packet events.
packets rtp Optional. Displays VQM debug messages for Realtime Transport Protocol
(RTP) packet events.
packets round-trip-delay Optional. Displays VQM debug messages for round-trip delay mechanism
events.
Default Values
Command History
Usage Examples
The following example activates RTP packets debug messages for VQM:
>enable
#debug ip rtp quality-monitoring packets rtp
2007.10.23 17:35:06 VQM.PACKET RTCP Sender SSRC=1244609021
2007.10.23 17:35:06 VQM.PACKET RTCP NTP timestamp (MSW)=3402167683 (0xcac8f583)
2007.10.23 17:35:06 VQM.PACKET RTCP NTP timestamp (LSW)=1116355952 (0x428a3d70)
2007.10.23 17:35:06 VQM.PACKET RTCP RTP timestamp=3990799999
2007.10.23 17:35:06 VQM.PACKET RTCP SSRC=1919245558
2007.10.23 17:35:06 VQM.PACKET RTCP Last SR timestamp=4119950126 (0xf591732e)
2007.10.23 17:35:06 VQM.PACKET RTCP Delay since last SR timestamp=175671

2007.10.23 17:35:06 VQM.PACKET RTCP handle=0x6179810ebu

2007.10.23 17:35:09 VQM.PACKET RTCP Rx RTCP SR pkt from 10.22.41.91
2007.10.23 17:35:09 VQM.PACKET RTCP call-ID=30bbb408417e519a00be27ac15d5776b@1
0.22.41.52
2007.10.23 17:35:09 VQM.PACKET RTCP Sender SSRC=1919245558
2007.10.23 17:35:09 VQM.PACKET RTCP NTP timestamp (MSW)=3402167702 (0xcac8f596)
2007.10.23 17:35:09 VQM.PACKET RTCP NTP timestamp (LSW)=1932399624 (0x732e1408)
2007.10.23 17:35:09 VQM.PACKET RTCP RTP timestamp=2621875150
2007.10.23 17:35:09 VQM.PACKET RTCP SSRC=1244609021
2007.10.23 17:35:09 VQM.PACKET RTCP Last SR timestamp=4119020170 (0xf583428a)
2007.10.23 17:35:09 VQM.PACKET RTCP Delay since last SR timestamp=151436
2007.10.23 17:35:09 VQM.PACKET RTCP handle=0x6524010g all

debug ip rtp quality-monitoring reporter

Use the debug ip rtp quality-monitoring reporter to activate debug messages associated with voice
quality monitoring (VQM) reporters. Debug messages are displayed (real time) on the terminal (or Telnet)
include:
debug ip rtp quality-monitoring reporter

debug ip rtp quality-monitoring reporter <name>
your unit.
Syntax Description
<name> Optional. Specifies that debug messages are enabled only for the named
reporter.
Default Values
Command History
Usage Examples
The following is sample output of debug messages for VQM reporter Reporter1:
>enable
#debug ip rtp quality-monitoring reporter Reporter1
08:46:13 VQM.REPORTER Reporter1 1 Enqueuing VQM Report - 2575556352@10.1.3.9 to
6353@10.1.3.9, RTP=10.10.20.2:2234->10.17.138.1:3000
08:46:13 VQM.REPORTER Reporter1 1 Generating VQM Report
08:46:13 VQM.REPORTER Reporter1 1 Sending VQM Report
08:46:13 VQM.REPORTER Reporter1 1 Transaction 0x022ad5f0: state changed -> Client General
Request Sent

debug ip security monitor

Use the debug ip security monitor command to activate debug messages associated with the ip security
monitor. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no form of
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The debug ip security monitor events include statistic collection associated with the timeline.
Usage Examples
>enable
#debug ip security monitor
SECURITY_MONITOR.EVENTS Regular update: timeline interval scheduled to end at 23:00:16
SECURITY_MONITOR.EVENTS [ curr=269095, sched=272343 ]
SECURITY_MONITOR.EVENTS Regular update: timeline interval scheduled to end at 23:00:16
SECURITY_MONITOR.EVENTS [ curr=269154, sched=272343 ] no debug ip security monitor
#

debug ip tcp
Use the debug ip tcp command to activate debug messages associated with significant Transmission
Control Protocol (TCP) events, such as state changes, retransmissions, session aborts, etc., in AOS. Debug
messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form of this command to
debug ip tcp
debug ip tcp events
These debug events are logged for packets that are sent or received from the router.
Forwarded TCP packets are not included.
your unit.
Syntax Description
events Optional. Displays only TCP protocol events.
Default Values
Command History
Functional Notes
In the debug ip tcp events information, TCB stands for TCP task control block. The numbers which
sometimes appear next to TCB (e.g., TCB5 in the following example) represent the TCP session number.
This allows you to differentiate debug messages for multiple TCP sessions.

Usage Examples
>enable
#debug ip tcp events
2003.02.17 07:40:56 IP.TCP EVENTS TCP: Allocating block 5
2003.02.17 07:40:56 IP.TCP EVENTS TCB5: state change: FREE->SYNRCVD
2003.02.17 07:40:56 IP.TCP EVENTS TCB5: new connection from 172.22.75.246:3473 to
10.200.2.201:23
2003.02.17 07:40:56 IP.TCP EVENTS TCB5: state change: SYNRCVD->ESTABLISHED
[172.22.75.246:3473]
2003.02.17 07:41:06 IP.TCP EVENTS TCB5: Connection aborted -- error = RESET
2003.02.17 07:41:06 IP.TCP EVENTS TCB5: De-allocating tcb

debug ip tcp md5

Use the debug ip tcp md5 command to activate debug messages that detail the results of each incoming
Transmission Control Protocol (TCP) packet’s message digest 5 (MD5) authentication with an internal
route in AOS. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Debug messages will only be generated for TCP ports that have MD5 authentication enabled.
Usage Examples
The following example activates debug messages associated with incoming TCP packet’s MD5
authentication:
>enable
#debug ip tcp md5

debug ip tftp
Use the debug ip tftp packets command to activate debug messages associated with Trivial File Transfer
Protocol (TFTP) packets. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use
debug ip tftp client packets

debug ip tftp server events
debug ip tftp server packets
your unit.
Syntax Description
client packets Activates TFTP client packet debug messages.
server events Activates TFTP server event debug messages.
server packets Activates TFTP server packet debug messages.
Default Values
Command History
Release 14.1 Command changed from debug tftp to debug ip tftp.
Usage Examples
The following example activates debug messages associated with TFTP server packets:
>enable
#debug ip tftp server packets

debug ip udp
Use the debug ip udp command to activate debug messages associated with User Datagram Protocol
(UDP) send and receive events in AOS. Debug messages are displayed (real time) to the terminal (or
These debug events are logged for packets that are sent or received from the router.
Forwarded UDP packets are not included.
The overhead associated with this command takes up a large portion of your router’s
resources and at times can halt other router processes. It is best to only use the command
during times when the network resources are in low demand (nonpeak hours, weekends,
etc.).
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
In the debug ip udp information, the message no listener means that there is no service listening on this
UDP port (i.e., the data is discarded).
Usage Examples
>enable
#debug ip udp
2003.02.17 07:38:48 IP.UDP RX: src=10.200.3.236:138, dst=10.200.255.255:138, 229 bytes, no listener
2003.02.17 07:38:48 IP.UDP RX: src=10.200.2.7:138, dst=10.200.255.255:138, 227 bytes, no listener
2003.02.17 07:38:48 IP.UDP RX: src=10.200.201.240:138, dst=10.200.255.255:138, 215 bytes, no
listener

debug ip urlfilter
Use the debug ip urlfilter command to display a summary of debug information for all uniform resource
locator (URL) filters being used. Debug messages are displayed (real time) to the terminal (or Telnet)
screen. The verbose option gives more detailed information. Use the no form of this command to disable
the debug messages. Variations of this command include:
debug ip urlfilter
debug ip urlfilter verbose
your unit.
Syntax Description
verbose Optional. Enables detailed debug messages.
Default Values
Command History
Usage Examples
The following example shows the debug summary for all URL filters being used:
>enable
#debug ip urlfilter
2005.11.06 05:31:52 Connected to a Websense server

2005.11.06 05:33:26 Allowed http://www.adtran.com/

debug ip urlfilter top-websites

Use the debug ip urlfilter top-websites command to display the times at which the generated top websites
lists merge (as the 15-minute list is rolled into the hourly list, the hourly list into the daily list, and so on).
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example shows the debug summary for top websites reporting:
>enable
#debug ip urlfilter top-websites
P2007.05.08 09:55:00 Merging displayed 15 minute list into hour list
2007.05.08 09:55:00 Merging hour list into twenty-four hour list
2007.05.08 09:55:00 Validating timers; timerAdj=0, update=0, lastThen=462
2007.05.08 09:55:00 Scheduled next run in 900; timerAdj=0, nowUpTime=462,
last Period=306

debug isdn
Use the debug isdn command to activate debug messages associated with integrated services digital
network (ISDN) events in AOS. Debug messages are displayed (real time) to the terminal (or Telnet)
include the following:
debug isdn cc-ie

debug isdn cc-ie pri
debug isdn cc-ie pri <number>
debug isdn cc-messages
debug isdn cc-messages pri
debug isdn cc-messages pri <number>
debug isdn endpoint
debug isdn endpoint pri
debug isdn endpoint pri <number>
debug isdn interface
debug isdn interface pri
debug isdn interface pri <number>
debug isdn l2-formatted
debug isdn l2-formatted pri
debug isdn l2-formatted pri <number>
debug isdn l2-messages
debug isdn l2-messages pri
debug isdn l2-messages pri <number>
your unit.
Syntax Description
cc-ie Displays call control information elements.
cc-messages Displays call control messages.
endpoint Displays endpoint events.
interface Displays ISDN interface events.
l2-formatted Displays Layer 2 formatted messages.
l2-messages Displays Layer 2 messages.
pri Optional. Specifies the ISDN interface.
pri <number> Optional. Specifies a specific ISDN interface. Range is 1 to 255.
Default Values

Command History
Usage Examples
The following example activates all Layer 2 formatted messages:
>enable
#debug isdn l2-formatted
The following example activates Layer 2 formatted messages received on ISDN interface primary rate
interface (PRI) 1:
>enable
#debug isdn l2-formatted pri 1

debug isdn group

Use the debug isdn group command to activate integrated services digital network (ISDN) group errors
and messages. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no
debug isdn group

debug isdn group <number>
your unit.
Syntax Description
<number> Optional. Specifies the ISDN group. Valid range is 1 to 255.
Default Values
Command History
Usage Examples
The following example activates debug messages for all ISDN groups:
>enable
#debug isdn group

debug isdn resource-manager

Use the debug isdn resource-manager command to activate integrated services digital network (ISDN)
resource manager errors and messages. Debug messages are displayed (real time) to the terminal (or
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with the ISDN resource manager:
>enable
#debug isdn resource-manager

debug isdn verbose

Use the debug isdn verbose command to activate all debug messages associated with integrated services
digital network (ISDN) events in AOS. Debug messages are displayed (real time) to the terminal (or
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates all debug messages associated with ISDN activity:
>enable
#debug isdn verbose

debug lldp
Use the debug lldp command to display debug output for all Link Layer Discovery Protocol (LLDP)
receive and transmit packets. Debug messages are displayed (real time) on the terminal (or Telnet) screen.
debug lldp
debug lldp rx
debug lldp rx verbose
debug lldp tx
debug lldp tx verbose
debug lldp verbose
your unit.
Syntax Description
rx Optional. Shows information about received packets.
tx Optional. Shows information about transmitted packets.
verbose Optional. Shows detailed debugging information.
Default Values
Command History
Usage Examples
The following example activates both transmit and receive messages associated with LLDP operation:
>enable
#debug lldp

debug mail-client
Use the debug mail-client command to enable mail agent debug messages. Variations of this command
include:
debug mail-client
debug mail-client <agent name>
your unit.
Syntax Description
<agent name> Optional. Specifies debug messages are enabled only for the specified mail
agent.
Default Values
Command History
Usage Examples
The following example enables debug messaging for all configured mail agents:
>enable
#debug mail-client

debug mgcp stack

Use the debug mgcp stack command to display information about the Media Gateway Control Protocol
(MGCP) stack and MGCP messages. Variations of this command include:
debug mgcp stack

debug mgcp stack messages
debug mgcp stack messages summary
debug mgcp stack verbose
Syntax Description
messages Optional. Specifies that MGCP stack messages information is displayed.
messages summary Optional. Specifies that MGCP message summary information is displayed.
verbose Optional. Specifies that detailed MGCP stack information is displayed.
Default Values
Command History
Release A2 Command was introduced.
Usage Examples
The following is sample output from the debug mgcp stack messages summary command:
#debug mgcp stack messages summary

19:20:22 MGCP.STACK MSGSUM TX: -> 47.234.101.60:2727
19:20:22 MGCP.STACK MSGSUM TX: ntfy 88 aaln/1@65.162.109.238 MGCP 1.0
19:20:22 MGCP.STACK MSGSUM RX: <- 47.234.101.60:2727
19:20:22 MGCP.STACK MSGSUM RX: 200 88 OK
19:20:22 MGCP.STACK MSGSUM RX: <- 47.234.101.60:2727

19:20:22 MGCP.STACK MSGSUM RX: RQNT 30425 aaln/1@65.162.109.238 MGCP 1.0

debug mgcp verbose

Use the debug mgcp verbose command to display detailed information about Media Gateway Control
Protocol (MGCP) transmissions and receptions.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following is sample output from the debug mgcp verbose command:
#debug mgcp verbose

19:02:35 MGCP.STACK DEBUG adEndpointEvent(int=0:1, pkg=, evt=hd)
19:02:35 MGCP.STACK MSG TX: -> 47.234.101.60:2727
19:02:35 MGCP.STACK MSG TX: ntfy 58 aaln/1@65.162.109.238 MGCP 1.0
K: 57
X: 22410
O: l/hd
19:02:35 MGCP.STACK MSG RX: <- 47.234.101.60:2727

19:02:35 MGCP.STACK MSG RX: 200 58 OK
19:02:35 MGCP.STACK MSG RX: <- 47.234.101.60:2727

19:02:35 MGCP.STACK MSG RX: RQNT 30081 aaln/1@65.162.109.238 MGCP 1.0
X: 22414
S:
R: L/hu(N)
Q: loop

debug network-forensics ip dhcp

Use the debug network-forensics ip dhcp command to display Dynamic Host Configuration Protocol
(DHCP) information collected from messages sent between clients connected to the network and the
network server. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Debug
messages can be activated for all clients or for specific clients connected to the network. Use the no form
of this command to disable the debug messages. Variations of this command include:
debug network-forensics ip dhcp

debug network-forensics ip dhcp hostname <hostname>
debug network-forensics ip dhcp interface gigabit-switchport <slot/port>
debug network-forensics ip dhcp ip <ip address>
debug network-forensics ip dhcp mac <mac address>
your unit.
Syntax Description
hostname <hostname> Optional. Activates debug messages for the client with the
specified host name.
interface gigabit-switchport <slot/port> Optional. Activates debug messages for the client using the
specified interface.
ip <ip address> Optional. Activates debug messages for the client with the
specified IP address. IP addresses should be expressed in
mac <mac address> Optional. Activates debug messages for the client with the
specified medium access control (MAC) address. MAC
Default Values
Command History

Usage Examples
The following is sample output of the debug network-forensics ip dhcp command:
>enable
#debug network-forensics ip dhcp
2009.08.31 14:30:30 NETWORK_FORENSICS.IP.DHCP.giga-swx 0/5 Discover from 00:E0:29:0E:D5:E3
(xpsp3-host)
2009.08.31 14:30:31 NETWORK_FORENSICS.IP.DHCP.giga-swx 0/24 Offer from
00:E0:29:0E:D5:E5/10.23.220.254 to 00:E0:29:0E:D5:E3 of 10.23.220.1/255.255.255.0(xpsp3-host)
2009.08.31 14:30:31 NETWORK_FORENSICS.IP.DHCP.giga-swx 0/5 Request from 00:E0:29:0E:D5:E3
10.23.220.1/255.255.255.0 (xpsp3-host) to 00:E0:29:0E:D5:E5/10.23.220.254
2009.08.31 14:30:31 NETWORK_FORENSICS.IP.DHCP.giga-swx 0/24 Ack from
00:E0:29:0E:D5:E5/10.23.220.254 to 00:E0:29:0E:D5:E3 of 10.23.220.1/255.255.255.0 (xpsp3-host)

debug ntp
Use the debug ntp command to activate debug messages associated with the Network Time Protocol
(NTP) daemon information. Debug messages are displayed (real time) on the terminal (or Telnet) screen.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with NTP:
>enable
#debug ntp

debug ping twamp

Use the debug ping twamp command to activate debug messages associated with Two-Way Active
Measurement Protocol (TWAMP) ping activity. Debug messages are displayed (real time) on the terminal
command include:
debug ping twamp

debug ping twamp control
debug ping twamp control events
debug ping twamp control packets
debug ping twamp test
debug ping twamp test events
debug ping twamp test packets
your unit.
Syntax Description
control Optional. Activates TWAMP control debug messages.
events Optional. Displays TWAMP control events and messages.
packets Optional. Displays TWAMP control events and packets.
test Activates TWAMP Test debug messages.
events Optional. Displays TWAMP test events and messages.
packets Optional. Displays TWAMP test events and packets.
Default Values
Command History
Usage Examples
The following example enables debug messaging for TWAMP control events and messages:
>enable
#debug ping twamp control
Type CTRL+C to abort. Test will complete in approximately 7 seconds.
2009.06.03 11:18:51 IP.TWPING CTRL EVNT Attempting to connect

2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Init -> Opening (event=Open Connection)
2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Opening -> Setup (event=RX

Server-Greeting)
2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Setup -> Starting (event=TX
Setup-Response)
2009.06.03 11:18:51 IP.TWPING CTRL PKT Sending Setup-Response (len=140)
mode=1
keyId=00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
token=00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Starting -> Active (event=RX Server-Start)
2009.06.03 11:18:51 IP.TWPING CTRL PKT Received Server-Start (len=48)
accept=0 serverIV=3d97e36d000000000178343030386337 startTime=4a26a1ad.2be49403
2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Active -> Register-Session (event=TX
Request-Session)
2009.06.03 11:18:51 IP.TWPING CTRL PKT Sending Request-Session (len=112)
ipVer=4 confSender=0 confReceiver=0 numSchedSlots=0 numPkts=10
senderPort=1090 receiverPort=0 senderIp=10.22.135.18 receiverIp=10.22.130.44
sessId=00000000000000000000000000000000 padLen=0
startTime=0.0 timeout=2.0 dscp=0
2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Register-Session -> Active (event=RX
Accept-Session)
2009.06.03 11:18:51 IP.TWPING CTRL PKT Received Accept-Session (len=48)
accept=0 port=1063 sessId=0000000000000025cf198506ac7bb859
2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Active -> Start-Sessions (event=TX
Start-Sessions)
2009.06.03 11:18:51 IP.TWPING CTRL PKT Sending Start-Sessions (len=32)
2009.06.03 11:18:51 IP.TWPING CTRL EVNT State changed Start-Sessions -> Active (event=RX
Start-Ack)
2009.06.03 11:18:51 IP.TWPING CTRL PKT Received Start-Ack (len=32)
accept=0--- statistics from [10.22.135.18]:1090 to [10.22.130.44]:1063
SID: 00000003720725133617212318489
10 sent, 0 lost (0.000%)
Delay
round-trip min/avg/max = 0 0 0 ms
num/sum/sum2 = 10 9 9 ms
out min/avg/max = -6 -6 -6 ms
num/sum/sum2 = 10 -62 388 ms
in min/avg/max = 7 7 7 ms

IPDV-abs
out min/avg/max = 0 0 0 ms
IPDV-pos
IPDV-neg
clock error
local = sync, 0.488281 ms
remote = sync, 0.488281 ms
2009.06.03 11:18:53 IP.TWPING CTRL EVNT State changed Active -> Stop-Sessions (event=TX
Stop-Session)
2009.06.03 11:18:53 IP.TWPING CTRL PKT Sending Stop-Sessions (len=32)
accept=0 numSessions=0
2009.06.03 11:18:53 IP.TWPING CTRL EVNT State changed Stop-Sessions -> Active (event=Stopping
Tests)
2009.06.03 11:18:53 IP.TWPING CTRL EVNT Closing connection
2009.06.03 11:18:53 IP.TWPING CTRL EVNT State changed Active -> Closed (event=Close Connection)

debug port-auth
Use the debug port-auth command to generate debug messages used to aid in troubleshooting problems
during the port authentication process. Debug messages are displayed (real time) on the terminal (or
debug port-auth
debug port-auth auth-sm
debug port-auth bkend-sm
debug port-auth general
debug port-auth packet
debug port-auth packet [both | tx | rx]
debug port-auth reauth-sm
debug port-auth supp-sm
your unit.
Syntax Description
auth-sm Optional. Displays AuthPAE-state machine information.
bkend-sm Optional. Displays backend-state machine information.
general Optional. Displays configuration changes to the port authentication system.
packet both Optional. Displays packet exchange information in both receive and
transmit directions.
packet rx Optional. Displays packet exchange information in the receive-only
direction.
packet tx Optional. Displays packet exchange information in the transmit-only
direction.
reauth-sm Optional. Displays reauthentication-state machine information.
supp-sm Optional. Displays supplicant-state machine information.
Default Values
Command History
Release 10.1 New options were introduced.
Release 13.1 New options were introduced.

Usage Examples
The following example activates port authentication debug information on received packets:
>enable
#debug port-auth packet rx
Rcvd EAPOL Start for sess 1 on int eth 0/2

debug port security

Use the debug port security command to display messages associated with port security. Debug messages
are displayed (real time) to the terminal (or Telnet) screen. Use the no form of this command to disable the
debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates port security debug messages:
>enable
#debug port security

debug ppp
Use the debug ppp command to activate debug messages associated with Point-to-Point Protocol (PPP)
operation in AOS. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no
debug ppp authentication

debug ppp errors
debug ppp negotiation
debug ppp verbose
your unit.
Syntax Description
authentication Activates debug messages pertaining to PPP authentication
(Challenge-Handshake Authentication Protocol (CHAP), Password
Authentication Protocol (PAP), Extensible Authentication Protocol
(EAP), etc.).
errors Activates debug messages that indicate a PPP error was detected
(mismatch in negotiation authentication, etc.).
negotiation Activates debug messages associated with PPP negotiation.
verbose Activates detailed debug messages for PPP operation.
Default Values
Command History
Functional Notes
The debug ppp command activates debug messages to provide information on PPP activity in the system.
PPP debug messages can be used to aid in troubleshooting PPP links.
Usage Examples
The following example activates debug messages associated with PPP authentication activity:
>enable
#debug ppp authentication

debug pppoe client

Use the debug pppoe client command to activate debug messages associated with Point-to-Point Protocol
over Ethernet (PPPoE) operation in AOS. Debug messages are displayed (real time) to the terminal (or
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with PPPoE activity:
>enable
#debug pppoe client

debug probe
Use the debug probe command to activate debug messages associated with activities performed by the
named probe object. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the
debug probe
debug probe <name>
debug probe <name> twamp control
debug probe <name> twamp control events
debug probe <name> twamp control packets
debug probe <name> twamp test
debug probe <name> twamp test events
debug probe <name> twamp test packets
your unit.
Syntax Description
<name> Optional. Specifies the probe object or activates the probe database debug
event messages for the specified probe.
twamp Optional. Specifies Two-Way Active Measurement Protocol (TWAMP)
probe verbose output.
control Activates TWAMP control probe verbose messages.
events Optional. Activates TWAMP control probe events.
packets Optional. Activates decode TWAMP control packets messages.
test Activates TWAMP Test probe verbose output.
events Optional. Activates TWAMP Test probe events.
packets Optional. Activates decode TWAMP Test packets messages.
Default Values
Command History
Release 17.3 Command was expanded to include the TWAMP probe verbose output.

Usage Examples
The following example activates all debug messages associated with the probes:
>enable
#debug probe
The following example activates debug messages associated with the probe object named probe_A:
>enable
#debug probe probe_A

debug probe responder

Use the debug probe responder command to display probe responder event messages or activate debug
messages associated with activities performed by the named probe object. Debug messages are displayed
messages. Variations of this command include:
debug probe responder twamp

debug probe responder twamp control
debug probe responder twamp control event
debug probe responder twamp control event <address>
debug probe responder twamp control packet
debug probe responder twamp control packet <address>
debug probe responder twamp test
debug probe responder twamp test event
debug probe responder twamp test event <address>
debug probe responder twamp test packet
debug probe responder twamp test packet <address>
your unit.
Syntax Description
responder twamp Optional. Activates probe debug messages for all Two-Way Active
Measurement Protocol (TWAMP) responder verbose output.
control Optional. Activates probe debug messages for TWAMP control responder
verbose output.
event <address> Optional. Activates probe debug messages for TWAMP control responder
events. Specify the far-end IP address to activate remote events.
packet <address> Optional. Activates probe debug messages to decode TWAMP control
packets. Enter an IP address to decode TWAMP control packets from a
specific address.
test Optional. Activates probe debug messages for TWAMP test responder
verbose output.
event <address> Optional. Activates probe debug messages for TWAMP test responder
events. Enter a far-end IP address to display events from the specified
address.
packet <address> Optional. Activates probe debug messages to decode TWAMP test packets.
Enter an IP address to decode TWAMP test packets from a specific
address.
Default Values

Command History
Release 17.2 Command was expanded to include the TWAMP responder debug options.
Usage Examples
The following example activates debug messages associated with all probe objects:
>enable
#debug probe
The following example activates debug messages associated with the probe object named probe_A:
>enable
#debug probe probe_A
The following example activates probe responder debug messages:
>enable
#debug probe responder

debug radius
Use the debug radius command to enable debug messages from the remote authentication dial-in user
service (RADIUS) subsystem. Debug messages are displayed (real time) to the terminal (or Telnet) screen.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The debug radius messages show the communication process with the remote RADIUS servers.
Usage Examples
The following is an example output for the debug radius command:
>enable
#debug radius
RADIUS AUTHENTICATION: Sending packet to 172.22.48.1 (1645).
RADIUS AUTHENTICATION: Received response from 172.22.48.1.

debug restore
Use the debug restore command to restore the last saved debug filters to the unit.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This command is used to restore filters saved using the command debug save on page 294. To view the
saved filters without restoring them to the unit, use the show debugging saved-filters command (refer to
show debugging on page 375).
Usage Examples
The following example restores previously saved debug filters on the AOS unit:
>enable
#debug restore
Restoring saved debug filters...
Filters to restore:
debug mail-client agent
debug probe test1
Running restoration script...done

debug save
Use the debug save command to perform a persistent save of the debug filters enabled in the current
command line interface (CLI) session. The saved filters can be restored at a later time.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This command is used to save debug filters across a unit reboot. Filters are restored using the command
debug restore on page 293. To view the saved filters without restoring them to the unit, use the show
debugging saved-filters command (refer to show debugging on page 375).
Only one set of filters can be saved per instance of AOS. If a previous set of filters has been saved, issuing
the debug save command overwrites the previously saved filters with the current set of filters. If no filters
are currently active, issuing debug save has no effect so that the last saved files are not lost.
Usage Examples
The following example saves the debug filters from the current CLI session:
>enable
#debug save
Saving debug filters enabled in this session...
debug probe test1
Done.

debug schedule
Use the debug schedule command to activate debug messages associated with a schedule. Variations of
debug schedule
debug schedule <name>
your unit.
Syntax Description
<name> Optional. Displays only the debug information for a specific schedule.
Default Values
Command History
Usage Examples
The following example enables debug information for any configured schedules:
>enable
#debug schedule
01:00:15: NETMON.SCHEDULE MIDNIGHT: status changed to inactive

debug sip
Use the debug sip command to activate debug messages associated with Session Initiation Protocol (SIP)
debug sip cldu

debug sip location
debug sip manager
debug sip name-service
debug sip syntax
debug sip tdu
debug sip trunk-registration
debug sip trunk-registration <Txx>
debug sip trunk-registration <Txx> <trunk id>
debug sip user-registration
debug sip user-registration <extension>
your unit.
Syntax Description
cldu Activates SIP CLDU event debug messages.
location Activates SIP location database event debug messages.
manager Activates SIP stack manager event debug messages.
name-service Activates SIP name-service event debug messages.
syntax Activates SIP syntax event debug messages.
tdu Activates SIP transaction distribution unit (TDU) debug messages.
trunk-registration Activates all SIP trunk-registration event debug messages.
trunk-registration <Txx> Optional. Activates SIP trunk-registration event debug messages
for a specific trunk. For example: Txx (T01) where xx is the trunk’s
two-digit identifier.
trunk-registration <Txx> <trunk id> Optional. Activates SIP trunk-registration event debug messages
for a specific trunk. For example: Txx (T01) where xx is the trunk’s
two-digit identifier and <trunk id> is the specific name associated
with the trunk.
user-registration Activates all SIP user-registration event debug messages.
user-registration <extension> Optional. Activates SIP user-registration event debug messages for
a specific trunk.
Default Values

Command History
Release 11.1 Command was expanded to include the proxy event messages.
Release 15.1 Command was expanded to include the name-service messages.
Release 16.1 Command was expanded to include the TDU messages.
Release 17.3 Command was expanded to include the syntax messages.
Usage Examples
The following example activates all debug messages associated with SIP CLDU events:
>enable
#debug sip cldu

debug sip proxy

Use the debug sip proxy command to activate debug messages associated with Session Initiation Protocol
(SIP) proxy events. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the
debug sip proxy database

debug sip proxy dialogs
debug sip proxy routing
debug sip proxy transactions
debug sip proxy verbose
your unit.
Syntax Description
database Activates SIP proxy database debug event debug messages.
dialogs Activates SIP proxy DOM event debug messages.
routing Activates SIP proxy message-routing events.
transactions Activates SIP proxy event debug messages that shows the interaction
between the SIP proxy and the SIP stack.
verbose Activates all SIP proxy debug messages.
Default Values
Command History
Usage Examples
The following example activates all debug messages associated with SIP proxy events:
>enable
#debug sip proxy verbose

debug sip stack

Use the debug sip stack command to activate debug messages associated with Session Initiation Protocol
(SIP) stack events. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no
debug sip stack debug

debug sip stack errors
debug sip stack exceptions
debug sip stack info
debug sip stack messages [ack | all | bye | cancel | info | invite | message | notify | options | prack |
publish | refer | register | request | response | subscribe | update] [from <user> | request |
response | rx | to <user> | tx]
debug sip stack messages [from <user> | request | response | rx | to <user> | tx]
debug sip stack messages summary [ack | all | bye | cancel | info | invite | message | notify | options
| prack | publish | refer | register | request | response | subscribe | update] [from <user> |
request | response | rx | to <user> | tx]
debug sip stack verbose
debug sip stack warnings
your unit.
The majority of the debug sip stack messages variations are available in any order, at any
time within the subcommand. Use the ? at any level after each variation listed within the
brackets to view additional arguments and variations for the subcommand(s).
Syntax Description
debug Activates SIP stack debug event debug messages.
errors Activates SIP stack error event debug messages.
exceptions Activates SIP stack exception event debug messages.
info Activates SIP stack info event debug messages.
messages Specify which SIP debug messages to activate from the list below.
ack Activates SIP ACK debug messages.
all Activates all SIP debug messages.
bye Activates SIP ACK debug messages.
cancel Activates SIP CANCEL debug messages.
from <user> Activates SIP debug messages from the specified user.
info Activates SIP INFO debug messages.
invite Activates SIP INVITE debug messages.
message Activates SIP MESSAGES debug messages.

notify Activates SIP NOTIFY debug messages.

options Activates SIP OPTIONS debug messages.
prack Activates SIP PRACK debug messages.
publish Activates SIP PUBLISH debug messages.
refer Activates SIP REFER debug messages.
register Activates SIP REGISTER debug messages.
request Activates the specified SIP request debug messages.
response Activates the specified SIP response debug messages.
rx Activates received SIP debug messages to or from a specific user.
subscribe Activates SIP SUBSCRIBE debug messages.
summary Activates SIP debug messages and displays only a summary (first line) of
the available messages.
to <user> Activates SIP debug messages to the specified user.
tx Activates transmitted SIP debug messages to or from a specific user.
update Activates SIP UPDATE debug messages.
verbose Activates all SIP stack event debug messages.
warnings Activates SIP stack warning event debug messages.
Default Values
Command History
Release A1 Command was expanded in the AOS voice products.
Usage Examples
The following example activates all debug messages associated with SIP stack events:
>enable
#debug sip stack all

debug snmp packets

Use the debug snmp packets command to enable debug output from local Simple Network Management
Protocol (SNMP) traffic. Debug messages are displayed (real time) to the terminal (or Telnet) screen.
When SNMP packets ingress or egress the unit (local traffic only), the traffic is displayed in a partially
decoded form. Use the no form of this command to disable the debug messages.
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following is an example of debug output for snmp packets:
>enable
#debug snmp packets
#SNMP V1 RX: GET-NEXT Request PDU from 10.23.1.157:2922 (community=public)
request id=3, error status=0, error index=0
max repetitions=0, non repetitions=0
VarBinds:
OID=1.3.6.1.2.1.1.3
value=empty
#SNMP V1 TX: GET Response PDU to 10.23.1.157:2922 (community=public)

request id=3, error status=0, error index=0
max repetitions=1, non repetitions=0
VarBinds:
OID=1.3.6.1.2.1.1.3.0
value=410825

debug sntp
Use the debug sntp command to enable debug messages associated with the Simple Network Time
Protocol (SNTP). All SNTP packet exchanges and time decisions are displayed with these debugging
events enabled. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no
form of this command to disable the debug messages. Variations of this command include the following:
debug sntp client

debug sntp server
your unit.
Syntax Description
client Displays SNTP client information.
server Displays SNTP server information.
Default Values
Command History
Release 13.1 Command was expanded to include the client and server options.
Functional Notes
The debug sntp command activates debug messages to aid in troubleshooting SNTP issues.
Usage Examples
The following is an example output for the debug sntp client command:
>enable
#debug sntp client
#configure terminal
#sntp server ntp.adtran.com
2009.03.16 15:38:06 SNTP.CLIENT sent Version 1 SNTP time request to 172.22.48.13
2009.03.16 15:38:06 SNTP.CLIENT received SNTP reply packet from 172.22.48.13
2009.03.16 15:38:06 SNTP.CLIENT setting time to 03-16-2009 15:37:54 CDT
2009.03.16 15:37:54 SNTP.CLIENT waiting for 86400 seconds for the next poll interval

debug spanning-tree bpdu

Use the debug spanning-tree bpdu command to display bridge protocol data unit (BPDU) debug
messages. When enabled, a debug message is displayed for each BPDU packet that is transmitted or
received by the unit. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the
debug spanning-tree bpdu all

debug spanning-tree bpdu receive
debug spanning-tree bpdu transmit
your unit.
Refer to debug spanning-tree on page 304 for more information.
Syntax Description
all Displays debug messages for BPDU packets that are transmitted and
received by the unit.
receive Displays debug messages for BPDU packets received by the unit.
transmit Displays debug messages for BPDU packets transmitted by the unit.
Default Values
Command History
Usage Examples
The following example displays debug messages for BPDU packets that are transmitted and received by
the unit:
>enable
#debug spanning-tree bpdu all

debug spanning-tree
Use the debug spanning-tree command to enable the display of spanning-tree debug messages. Debug
debug spanning-tree config

debug spanning-tree events
debug spanning-tree general
debug spanning-tree topology
your unit.
Refer to debug spanning-tree bpdu on page 303 for more information.
Syntax Description
config Enables the display of spanning-tree debug messages when configuration
changes occur.
events Enables the display of debug messages when spanning-tree protocol
events occur.
general Enables the display of general spanning-tree debug messages.
topology Enables the display of debug messages when spanning-tree protocol
topology events occur.
Default Values
Command History
Release 12.1 Command was expanded to include topology.
Usage Examples
The following example enables the display of general spanning-tree debug messages:
>enable
#debug spanning-tree general

debug stack
Use the debug stack command to enable switch-stacking debug messages. Debug messages are displayed
(real time) on the terminal (or Telnet) screen. Use the no form of this command to disable the debug
messages.Variations of this command include:
debug stack
debug stack switch
debug stack verbose
your unit.
Syntax Description
switch Optional. Enables messages specific to the stack ports (stack switch
application program interface (API) information).
verbose Optional. Enables detailed messages specific to the stack protocol.
Default Values
Command History
Usage Examples
The following example activates the possible debug stack messages:
>enable
#debug stack switch
#debug stack verbose

debug system
Use the debug system command to enable debug messages associated with system events (i.e., login,
logouts, etc.). Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form
your unit.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with system information:
>enable
#debug system

debug tacacs+
Use the debug tacacs+ command to activate debug messages associated with terminal access controller
access-control system plus (TACACS+) protocol. Debug messages are displayed (real time) to the
debug tacacs+
debug tacacs+ events
debug tacacs+ packets
your unit.
Syntax Description
events Optional. Activates TACACS+ event debug messages.
packets Optional. Activates TACACS+ packet debug messages.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with the TACACS+ protocol:
>enable
#debug tacacs+ packets

debug tcl
Use the debug tcl command to activate debug messages associated with tool command language (Tcl)
interpreter operation. Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the
debug tcl cli

debug tcl cli <filename>
debug tcl track <name>
your unit.
Syntax Description
cli Displays debug messages for the Tcl interpreter to the command line
interface (CLI).
<filename> Optional. Displays debug messages only for the specified Tcl script file.
track <name> Displays debug messages for the specified track. The track parameter is
only available on platforms with Network Monitoring enabled.
Default Values
Command History
Usage Examples
The following example activates debug messages for the Tcl interpreter while running the file test1.tcl:
>enable
#debug tcl test1.tcl

debug track
Use the debug track command to activate debug messages associated with activities performed by track
objects. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form of
debug track
debug track <name>
your unit.
Syntax Description
<name> Optional. Displays information about the specified track rather than all
configured tracks.
Default Values
Command History
Usage Examples
The following example activates debug messages associated with all track objects:
>enable
#debug track
The following example activates debug messages associated with the track object named track_1:
>enable
#debug track track_1

debug voice
Use the debug voice command to activate debug messages associated with voice functionality. Debug
disable the debug messages. Variations of this command include the following:
debug voice account-status

debug voice autoattendant
debug voice color
debug voice conference local
debug voice dsp
debug voice dsp voip <slot/port> channel verbose
debug voice dsp voip <slot/port> channel <number> ecan
debug voice dsp voip <slot/port> channel <number> rfc2833
debug voice erltool
debug voice erltool info
debug voice erltool statemachine
debug voice lineaccount
debug voice lineaccount <line>
debug voice linemanager
debug voice linemanager <line>
debug voice loopback
debug voice mail
debug voice mail <subsource>
debug voice paging-group
debug voice paging-group <extension>
debug voice phonemanager
debug voice phonemanager <slot:port>
debug voice promptstudio
debug voice proxydial
debug voice replication
debug voice rtp channel
debug voice rtp manager
debug voice rtp provider
debug voice rtp verbose
debug voice smdr
debug voice smdr <number>
debug voice stationaccount
debug voice stationaccount <extension>
debug voice statusgroups
debug voice summary
debug voice switchboard
debug voice switchboard <subsource>
debug voice switchboard call
debug voice switchboard call <subsource>
debug voice switchboard ccm

debug voice toneservices

debug voice toneservices <notifies>
debug voice toneservices <interface>
debug voice toneservices <interface> <slot/port>
debug voice trunkaccount
debug voice trunkaccount <trunk id>
debug voice trunkaccount <trunk id> <appearance>
debug voice trunkmanager
debug voice trunkmanager <trunk id>
debug voice trunkport
debug voice trunkport <slot:port:DS0>
debug voice verbose
your unit.
Syntax Description
account-status Activates station account status event debug messages.
autoattendant Activates auto attendant event debug messages.
color Activates color-coded event debug messages.
conference local Activates local conference session debug messages.
dsp Activates digital signal processor (DSP) event debug messages.
voip <slot/port> channel Optional. Activates DSP on the specified interface and DSP channel.
<number> Optional. Activates DSP on the specified interface and DSP channel.
ecan Optional. Activates the echo canceller debug feature.
rfc2833 Optional. Activates the RFC 2833 debug feature.
verbose Optional. Activates detailed DSP event debug messages for the specified
interface and channel.
erltool Activates the echo return loss (ERL) debug messages to monitor the
progress of the testing.
info Optional. Activates information events related to the ERL tool testing
progress.
statemachine Optional. Activates ERL tool statemachine events.
lineaccount Activates all line account event debug messages.
<line> Optional. Activates a specific line account event debug messages.
linemanager Activates all line manager event debug messages.
<line> Optional. Activates a specific line manager event debug messages.
loopback Activates all voice loopback account event debug messages.
mail Activates all voicemail event debug messages.

<subsource> Optional. Activates voicemail event debug messages for a specific

subsource.
paging-group Activates all handset paging group event debug messages.
<extension> Optional. Activates handset paging group event debug messages for a
specific paging group extension.
phonemanager Activates all phone manager event debug messages.
<slot:port> Optional. Activates phone manager event debug messages for a specific
slot and port.
promptstudio Activates prompt-studio event debug messages.
proxydial Activates proxy dial event debug messages.
replication Activates packet replicator event debug messages.
rtp Activates Realtime Transport Protocol (RTP) event debug messages.
channel Activates RTP channel event debug messages.
manager Activates RTP manager event debug messages.
provider Activates RTP provider event debug messages.
verbose Activates detailed RTP debug messages.
smdr Activates all station message detail reporting (SMDR) event debug
messages.
<number> Optional. Activates SMDR event debug messages for a specific to or from
number.
stationaccount Activates all station account event debug messages.
<extension> Optional. Activates station account event debug messages for a specific
extension.
statusgroups Activates status group event debug messages.
summary Activates simple voice event debug messages.
switchboard Activates all switchboard event debug messages.
<subsource> Optional. Activates switchboard event debug messages for a specific
subsource.
call Activates switchboard call state machine event debug messages.
call <subsource> Optional. Activates switchboard call state machine event debug messages
for a specific subsource.
ccm Activates switchboard call connection manager event debug messages.

toneservices Activates all tone service events debug messages.

<notifies> Optional. Activates tone service events debug messages for the specified
interface type. For example, for a foreign exchange station (FXS) interface,
use fxs.
<interface> Optional. Activates tone service events debug messages for the specified
interface type.
<interface> <slot/port> Optional. Activates tone service events debug messages for the specified
slot and port of the interface type. For example, for an individual FXS port
use, fxs 0/1.
trunkaccount Activates all trunk account event debug messages.
<trunk id> Optional. Activates trunk account event debug messages for a specific
trunk.
<trunk id> <appearance> Optional. Specifies specific trunk appearance.
trunkmanager Activates all trunk manager event debug messages.
<trunk id> Optional. Activates trunk manager event debug messages for a specific
trunk.
trunkport Activates all trunkport event debug messages.
<slot:port:DS0> Optional. Activates trunkport event debug messages for a specific slot, port,
and digital signal 0 (DS0).
verbose Optional. Displays the entire running configuration to the terminal screen
(versus only the nondefault values).
Default Values
Command History
Release 10.1 Command was expanded to include more options.
Release A1 Command was expanded to include the loopback option.
Release A2 Command was expanded to include the conference local and dsp options.
Release A2.04 Command was expanded to include the erltool, paging-group, and
replication options.

Usage Examples
The following example activates all debug messages associated with voice functionality:
>enable
#debug voice summary
The following is sample output from the debug voice paging-group command for paging group 6299:
>enable
#debug voice paging-group 6299
16:08:50:737 HPG.6299 rcvd: deliver from SB
16:08:50:738 HPG.6299 Undo of previous operation not required (RTP NAT Entry for 10.10.20.2:2228 not
found)
16:08:50:739 HPG.6299 Checking for internal Media Gateway IP Address
16:08:50:739 HPG.6299 Given RTP Channel is null, checking for hairpinned RTP Channel
16:08:50:739 HPG.6299 Unable to find hairpinned RTP Channel
16:08:50:739 HPG.6299 RTP Channel is NULL, Media Gateway must not be involved in call
16:08:50:739 HPG.6299 Checking need for firewall traversal
16:08:50:740 HPG.6299 Testing firewall policies
16:08:50:740 HPG.6299 NAT not required, no need for firewall traversal here
16:08:50:740 HPG.6299 sent: deliverResponse to SB
16:08:50:740 HPG.6299 In - State change >> Idle -> Ringing
16:08:50:741 HPG.6299 Out.6002.Idle recvd: callMember
16:08:50:741 HPG.6299 sent: call to SB
16:08:50:741 HPG.6299 Out.6002 - State change >> Idle -> Calling
16:08:50:741 HPG.6299 Out.6004.Idle recvd: callMember
16:08:50:742 HPG.6299 sent: call to SB
16:08:50:742 HPG.6299 Out.6004 - State change >> Idle -> Calling
16:08:50:744 HPG.6299 Out.6002.Calling rcvd: callResponse from SB
16:08:50:748 HPG.6299 Out.6004.Calling rcvd: callResponse from SB
16:08:50:758 HPG.6299 Ignoring deliverResponse
16:08:50:759 HPG.6299 Ignoring deliverResponse
16:08:51:034 HPG.6299 Out.6004.Calling rcvd: connect from SB
16:08:51:035 HPG.6299 Undo of previous operation not required (RTP NAT Entry for 10.10.20.6:3004 not
found)
16:08:51:035 HPG.6299 Checking for internal Media Gateway IP Address
16:08:51:037 HPG.6299 Given RTP Channel is null, checking for hairpinned RTP Channel
16:08:51:037 HPG.6299 Unable to find hairpinned RTP Channel
16:08:51:037 HPG.6299 RTP Channel is NULL, Media Gateway must not be involved in call
16:08:51:037 HPG.6299 Checking need for firewall traversal
16:08:51:038 HPG.6299 Testing firewall policies
16:08:51:038 HPG.6299 NAT not required, no need for firewall traversal here
16:08:51:038 HPG.6299 sent: connectResponse to SB
16:08:51:038 HPG.6299 In.Ringing processConnectedMember
16:08:51:038 HPG.6299 Out.6004 - State change >> Calling -> Connected
--MORE--

debug vrrp
Use the debug vrrp command to enable Virtual Router Redundancy Protocol (VRRP) debug messages.
command to disable the debug messages. Variations of this command include the following:
debug vrrp
debug vrrp error
debug vrrp interface <interface> error
debug vrrp interface <interface> group <number> error
debug vrrp interface <interface> group <number> packet
debug vrrp interface <interface> packet
debug vrrp packet
your unit.
Syntax Description
error Optional. Displays debug messages for all VRRP errors in all groups on all
interfaces or on a specified interface.
interface <interface> Optional. Displays debug messages for all VRRP groups on the specified
interface. Specify an interface in the format <interface type [slot/port |
use ppp 1; for an ATM subinterface, use atm 1.1; and for a virtual local area
network (VLAN) interface, use vlan 1. Type debug vrrp interface ? for a
complete list of valid interfaces.
group <number> Optional. Specifies debug messages for a single VRRP group on a
specified interface are generated. Group numbers range from 1 to 255.
error Optional. Displays debug messages for VRRP errors for a single group on a
packet Optional. Displays debug messages for VRRP packets for a single group on
a specified interface.
packet Optional. Displays debug messages for all VRRP packets in all groups on
all interfaces or on a specified interface.
Default Values
Command History

Functional Notes
Although VRRP group virtual router IDs (VRIDs) can be numbered between 1 and 255, only two VRRP
routers per interface are supported.
Usage Examples
The following example gives sample output from the debug vrrp packet command:
>enable
#debug vrrp packet
2007.05.26 15:48:57 VRRP.PKT eth 0/1 grp 1 Sent Advertisement pri: 125, ipCnt:1
2007.05.26 15:48:57 VRRP.PKT eth 0/1 grp 2 Received Advertisement pri: 125 from 10.23.197.236

dir
Use the dir command to display a directory list of all files on the system or just those matching the
specified pattern, located in a specified location. Variations of this command include:
dir
dir <pattern>
dir cflash
dir cflash <pattern>
dir flash
dir flash <pattern>
dir ramdisk
dir ramdisk <pattern>
Syntax Description
<pattern> Optional. Displays all files that match the specified pattern. When a wildcard
(*) is specified, only files located in the specified location matching the listed
pattern are displayed. For example, *.biz displays all files with the .biz
extension.
When no wildcard is specified, the entire contents of flash memory is
displayed.
cflash Optional. Displays files located on the installed CompactFlash® card.
flash Optional. Displays files located on the system in flash memory.
ramdisk Optional. Displays files located on the volatile RAM disk.
Default Values
Command History
Release 12.1 Command was expanded to include CompactFlash.
Usage Examples
The following is sample output from the dir flash command:
>enable
#dir flash
3563529 NV2100A-10-05-00-E.biz
2438 startup-config
2484 startup-config.bak
3694712 bytes used, 3007368 available, 6702080 total

The following is sample output from the dir ramdisk command displaying the contents of the RAM disk,
space occupied by each file, the total ramdisk space allocated, available space, and used space:
>enable
#dir ramdisk
10005125 NV3130A-17-07-00-26-AE.biz

disable
Use the disable command to exit the Enable mode and enter the Basic mode.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example exits the Enable mode and enters the Basic Command mode:
#disable
>

erase
Use the erase command to erase the files from a specified location.
erase <filename>
erase startup-config
Variations of this command (valid only on AOS units WITH CompactFlash®) include:
erase cflash <filename>

erase flash <filename>
erase file-system cflash
Variations of this command (valid only on AOS units WITH voice capability) include:
erase dynvoice-config
erase file-system flash
erase ramdisk <filename>
Erasing the file system removes all files and directories located in the unit’s memory,
including firmware images. If the primary boot image is located on the erased file system,
the unit will be adversely affected after a reboot. The firmware has to be replaced using the
procedure explained in the Upgrading AOS Firmware configuration guide, article number
1630, available online at http://kb.adtran.com.
Syntax Description
<filename> Specifies the name of the file to erase. The asterisk (*) can be used as a
wildcard to specify a pattern for erasing multiple files. When a wildcard is
specified, only files matching the listed pattern are erased.
cflash Specifies the location of the file to erase as the installed CompactFlash
card.
dynvoice-config Erases the dynamic voice configuration file stored in the flash memory.
file-system Erases the system files stored in either the system flash or CompactFlash
memory.
flash Specifies the location of the file to erase as the system flash memory.
ramdisk Specifies the location of the file to erase as the volatile RAM disk.
startup-config Erases the startup configuration file stored in flash memory.
Default Values

Command History
Release 12.1 Command was expanded to include the dynvoice-config parameter.
Release 14.1 Command was expanded to include the file-system cflash parameter.
Release A2.04 Command was expanded to include the file-system flash parameter.
Usage Examples
The following example erases the startup configuration file stored in flash memory:
>enable
#erase startup-config
If a new startup configuration file is not specified before cycling the power on the unit, AOS will initialize
using a blank configuration.
The following example erases all files located on the installed CompactFlash card:
>enable
#erase file-system cflash
This will erase ALL files on compact flash. Proceed? [y/n]
The following example erases all files located in the system flash memory:
>enable
#erase file-system flash
WARNING! You are about to erase all files on the flash file system.
This includes all firmware images and configuration files. This cannot be undone.
This will erase ALL files on flash. Proceed? [y/n]

events
Use the events command to enable event reporting to the current command line interface (CLI) session.
Use the no form of this command to disable all event reporting to the current CLI session.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables event reporting:
>enable
#events

exception report generate

Use the exception report generate command to immediately generate an exception report.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example immediately generates an exception report:
>enable
#exception report generate

factory-default
Use the factory-default command to reset the unit to the factory default setting.
Performing an AOS factory-default disrupts data traffic.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
After you issue this command, the system responds by first warning you that restoring the factory default
settings will erase the current configurations. It then asks if you would like to proceed. Choose n to return
to the command prompt (no configuration changes are made). Choose y to erase the
startup-configuration, replace it with the factory-default configuration, and reboot the unit. After reboot, the
new configuration takes effect.
Usage Examples
The following example resets the unit to the factory default settings:
>enable
#factory-default
WARNING - Restoring the factory default settings will erase the current startup and running configurations
and will reboot the unit.
Restore factory default settings?[y/n]y
Startup configuration written.
Rebooting the system. Please wait...

logout
Use the logout command to terminate the current session and return to the login screen.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example shows the logout command being executed in Enable mode:
>enable
#logout
Session now available
Press RETURN to get started.

ping
Use the ping command (at the Enable mode prompt) to verify IP network connectivity. Variations of this
command include:
ping
ping <ip address | hostname>
ping <ip address | hostname> data <string>
ping <ip address | hostname> count <number>
ping <ip address | hostname> interval <interval>
ping <ip address | hostname> size <value>
ping <ip address | hostname> source <ip address>
ping <ip address | hostname> timeout <value>
ping vrf <name> <ip address | hostname>
ping vrf <name> <ip address | hostname> data <string>
ping vrf <name> <ip address | hostname> count <number>
ping vrf <name> <ip address | hostname> interval <interval>
ping vrf <name> <ip address | hostname> size <value>
ping vrf <name> <ip address | hostname> source <ip address>
ping vrf <name> <ip address | hostname> timeout <value>
ping vrf <name> <ip address | hostname> verbose
Syntax Description
10.10.10.1). Entering the ping command with no specified IP address
prompts the user with parameters for a more detailed ping configuration.
Refer to Functional Notes (below) for more information.
data <string> Optional. Specifies an alphanumerical string to use (the ASCII equivalent)
as the data pattern in the ECHO_REQ packets.
count <number> Optional. Specifies the number of ping packets to send to the system. Valid
range is 0 to 1000000. A repeat count of 0 indicates an infinite ping request,
which can only be stopped by pressing Ctrl + C.
interval <interval> Optional. Specifies a minimum time to wait between sending test packets.
Valid range is 100 to 60000 milliseconds.
size <value> Optional. Specifies the datagram size (in bytes) of the ping packet. Valid
range is 1 to 1448 bytes.
source <ip address> Optional. Specifies the IP address to use as the source address in the
ECHO_REQ (or interface) packets. The source IP address must be a valid
address local to the router on the specified VPN routing and forwarding
(VRF) instance.
timeout <value> Optional. Specifies the timeout period after which the ping is considered
unsuccessful. Valid range is 1 to 60 seconds.
verbose Optional. Enables detailed messaging.
vrf <name> Optional. Specifies the VRF where the ip address exists.

Default Values
Command History
Release 17.2 Command was expanded to include the verbose and wait parameters, also
changes were made to the repeat and timeout values.
Release 17.4 Command was expanded to include the count and interval parameters.
The repeat and wait parameters were removed.
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_REQ packets off a
system (using a specified IP address). 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
X TTL Expired in Transit
? Unknown Host
* Request Timed Out
The following is a list of available extended ping fields with descriptions:
Extended Commands Specifies whether additional commands are desired for more ping
configuration parameters. Answer yes (y) or no (n).
Source Address Specifies the IP address to use as the source address in the ECHO_REQ
(or interface) packets.
Data Pattern Specifies an alphanumerical string to use (the ASCII equivalent) as the data
pattern in the ECHO_REQ packets.
Sweep Range of Sizes Varies the sizes of the ECHO_REQ packets transmitted.
Sweep Min Size Specifies the minimum size of the ECHO_REQ packet. Valid range is 0 to
1488.
Sweep Max Size Specifies the maximum size of the ECHO_REQ packet. Valid range is the
sweep minimum size to 1448.
Sweep Interval Specifies the interval used to determine packet size when performing the
sweep. Valid range is 1 to 1448.
Verbose Output Specifies an extended results output.

Usage Examples
The following is an example of a successful ping command:
>enable
#ping
VRF Name [-default-]:
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
Legend: '!' = Success '?' = Unknown host '$' = Invalid host address
'*' = Request timed out '-' = Destination host unreachable
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

ping ethernet
Use the ping ethernet command to initiate a loopback message from one Ethernet operations,
administration, and maintenance (OAM) connectivity fault management (CFM) maintenance endpoint
(MEP) to another MEP. These loopback messages are used to test the accessibility of the destination MEP.
ping ethernet <target-mac-address | target-mep-id>

ping ethernet <target-mac-address | target-mep-id> count <number>
ping ethernet <target-mac-address | target-mep-id> data <pattern>
ping ethernet <target-mac-address | target-mep-id> domain <domain name> association <association
name>
ping ethernet <target-mac-address | target-mep-id> domain none association <association name>
ping ethernet <target-mac-address | target-mep-id> drop-eligible
ping ethernet <target-mac-address | target-mep-idl> interface <interface>
ping ethernet <target-mac-address | target-mep-id> interval <interval>
ping ethernet <target-mac-address | target-mep-id> mep <mep id>
ping ethernet <target-mac-address | target-mep-id> priority <priority>
ping ethernet <target-mac-address | target-mep-id> size <bytes>
ping ethernet <target-mac-address | target-mep-id> timeout <timeout>
ping ethernet <target-mac-address | target-mep-id> validate-data
ping ethernet <target-mac-address | target-mep-id> verbose
After specifying the target for the loopback messages, the other parameters can be entered
in any order.
Syntax Description
<target-mac-address | target-mep-id> Specifies the destination for the loopback message. Medium
access control (MAC) addresses are entered in the format
HH:HH:HH:HH:HH:HH. Target MEP IDs are the unique
numerical values identifying MEPs. MEP IDs range from 1 to
8191.
count <number> Optional. Specifies the number of loopback messages to send.
Range is 1 to 1000000.
data <pattern> Optional. Specifies the pattern to be carried in the data time
length value (TLV) of the loopback message. Pattern is up to four
hexadecimal digits. Pattern range is 0 to ffff.
domain <domain name> Optional. Specifies the maintenance domain to which the
transmitting MEP belongs.
domain none Optional. Specifies no maintenance domain.
association <association name> Optional. Specifies the maintenance association to which the
drop-eligible Optional. Specifies the drop eligible bit value in the virtual local
area network (VLAN) tag.

interface <interface> Optional. Specifies the interface on which the transmitting MEP is
configured. Specify an interface in the format <interface type
[slot/port | slot/port.subinterface id | interface id | interface
id.subinterface id]>. For example, for an Ethernet subinterface,
use eth 0/1.1. For a list of appropriate interfaces, enter interface
? at the prompt.
interval <interval> Optional. Specifies the interval between transmissions of
loopback messages. Range is 100 to 60000 milliseconds.
mep <mep id> Specifies the MEP ID of the transmitting MEP. MEP ID range is 1
to 8191.
priority <priority> Optional. Specifies the 802.1 priority bits that are sent in the
loopback message. Range is 0 to 7.
size <bytes> Optional. Specifies the size of the loopback message. Size
ranges from 1 to 60 bytes.
timeout <timeout> Optional. Specifies the time that the MEP will wait for a response
to the loopback message. Range is 0 to 60 seconds.
validate-data Optional. Specifies whether or not the transmitting MEP validates
the contents of the data TLV in the received loopback messages.
verbose Optional. Specifies that the results are in detailed, rather than
summary, format.
Default Values
By default, the count value is set to 5.
By default, the data pattern is set to abcd.
By default, the drop-eligible value is not set.
By default, the interval is set to 1000 milliseconds.
By default, the priority value is the priority specified in the MEP’s configuration.
By default, the size value is set to 2 bytes.
By default, the timeout value is set to 2 seconds.
By default, the validate-data parameter is disabled.
Command History

Functional Notes
If the MEP ID is used as the target, the remote MEP must exist in the MEP continuity check message
(CCM) database (meaning the remote MEP is transmitting valid CCMs) so that the MEP ID can be
translated to the MAC address before the loopback message is transmitted.
Both the domain <domain name> and association <association name> parameters are not required if the
source MEP ID of the MEP is specified and unique through the AOS device.
If the domain and association of the transmitting MEP are specified, and there is only one MEP in that
domain or association, or if there is only one MEP configured on the unit, the mep <mep-id> parameter is
not required.
This command will not appear in the command line interface (CLI) unless Ethernet OAM
CFM is enabled. To enable Ethernet OAM CFM, refer to the command ethernet cfm on
page 798.
Usage Examples
The following example initiates the Ethernet ping utility from an MEP in Domain1 association MA1 with a
destination to an MEP with an MEP ID of 201:
>enable
#ping ethernet 201 domain Domain1 association MA1
Legend: ‘!’ = Success, ‘*’ = Request timed out, ‘d’ = Data Mismatch
‘o’ = Out of order, ‘.’ = No reply, ‘e’ = Unknown error.
Sending 5, 100-byte LBRs to MEP 201 from MEP 1, timeout is 2 seconds:

!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 202/668/1011 ms

ping stack-member <number>

Use the ping stack-member command to ping a member of the stack. Variations of this command include:
ping stack-member <number>

ping stack-member <number> vrf <name>
Syntax Description
<number> Specified which member of the stack to ping.
vrf <name> Optional. Specifies the VPN routing and forwarding (VRF) where the
stack-member exists.
Default Values
Command History
Functional Notes
Usage Examples
The following example pings a member of the stack:
>enable
#ping stack-member 3
Legend: '!' = Success, '?' = Unknown host, '$' = Invalid host address
'*' = Request timed out, '-' = Destination host unreachable
Sending 5, 100-byte ICMP Echos to 169.254.0.3, timeout is 2 seconds:
!!!!!
Success rate is 100 percent (5/5), round-trip min/avg/max = 2/2.2/3 ms
#

ping twamp
Use the ping twamp command to execute a Two-Way Active Measurement Protocol (TWAMP) type ping
to measure the packet loss, delay, and interpacket delay variation (IPDV) and display the results of the test.
Use the subcommands in any combination, in any order, when specifying the destination site. Variations of
ping twamp
ping twamp <ip address | hostname>
ping twamp <ip address | hostname> control-port <port>
ping twamp <ip address | hostname> data pattern
ping twamp <ip address | hostname> data random
ping twamp <ip address | hostname> data zero
ping twamp <ip address | hostname> dscp <value>
ping twamp <ip address | hostname> interval <value>
ping twamp <ip address | hostname> port <port>
ping twamp <ip address | hostname> repeat <value>
ping twamp <ip address | hostname> size <value>
ping twamp <ip address | hostname> source <ip address>
ping twamp <ip address | hostname> source-port <port>
ping twamp <ip address | hostname> timeout <value>
ping twamp <ip address | hostname> verbose
ping twamp <ip address | hostname> wait <value>
The subcommands can be used in a string of any available combination. Use the ? after
each specified subcommand for a valid list of arguments and settings.
Syntax Description
10.10.10.1). Entering the ping twamp command with no specified IP
address prompts the user with parameters for a more detailed ping twamp
configuration.
control-port <port> Optional. Specifies the destination TWAMP control port. Port range is 1 to
65535.
data Optional. Specifies data used to pad packets. The following options are
available:
pattern Pads the packet with a user-specified pattern.
random Pads the packet with random numbers.
zero Pads the packet with all zeros.
dscp <value> Optional. Specifies the differentiated services code point (DSCP) value.

interval <value> Optional. Specifies the interval between consecutive ping TWAMPs (in
milliseconds). Valid range is 5 to 5000.
port <port> Optional. Specifies the destination port for the TWAMP test packets. Valid
range is 1 to 65535.
repeat <value> Optional. Specifies the number of ping TWAMP packets. Valid range is 1 to
1000.
size <value> Optional. Specifies the datagram size. Valid range is 0 to 1462.
source <ip address> Optional. Specifies the source IP address. IP addresses should be
expressed in dotted decimal notation (for example, 10.10.10.1).
source-port <port> Optional. Specifies the source port for the TWAMP test packets. Valid range
is 1 to 65535.
timeout <value> Optional. Specifies the timeout value in milliseconds. Valid range is 100 to
60000.
verbose Optional. Displays the detailed two-way ping verbose results for the
specified IP address or host name.
wait <value> Optional. Specifies the interval (in milliseconds) between consecutive
TWAMP test packets. Range is 5 to 5000.
Default Values
By default, the data is zero, the dscp is 0, the interval value is 20, the port value is 0, the repeat value is
100, the size is 0, and the timeout is 2000 milliseconds.
Command History
Release 17.4 Command was introduced to replace the twping command.
Release 17.6 Command was expanded to include control-port and wait keywords.
Usage Examples
The following example executes a TWAMP ping:
>enable
#ping twamp
2009.06.03 11:18:24 IP.TWPING CTRL EVNT Attempting to connect
2009.06.03 11:18:24 IP.TWPING CTRL EVNT State changed Init -> Opening (event=Open Connection)
2009.06.03 11:18:24 IP.TWPING CTRL EVNT State changed Opening -> Setup (event=RX
Server-Greeting)
2009.06.03 11:18:24 IP.TWPING CTRL EVNT State changed Setup -> Starting (event=TX
Setup-Response)
2009.06.03 11:18:24 IP.TWPING CTRL PKT Sending Setup-Response (len=140)
mode=1
keyId=00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 --MORE--

ramdisk <size>
Use the ramdisk command to create a volatile RAM disk file system and allocate memory in bytes to the
newly created RAM disk. Use the no form of this command to delete the RAM disk.
Not all units are capable of using a RAM disk file system. Use the ? command to display a
list of valid commands at the enable prompt.
Syntax Description
<size> Specifies the size of the RAM disk in bytes. Valid range is 65536 to the
maximum available heap size on the unit. Input for this value allows the use
of the following characters as multipliers: M, m, K, and k.
Default Values
Command History
Usage Examples
The following example creates a volatile RAM disk file system and allocates 128000 bytes of memory:
>enable
#ramdisk 128000
The following example creates a volatile RAM disk file system and uses the multiplier k to allocate 131072
bytes of memory (where 128k is 128 x 1024 = 131072):
>enable
#ramdisk 128k

reload
Use the reload command to perform a manual reload of AOS. Variations of this command include:
reload
reload cancel
reload in <delay>
Performing an AOS reload disrupts data traffic.
Syntax Description
cancel Optional. Deactivates a pending reload command.
in <delay> Optional. Specifies a delay period in minutes (mm) or hours and minutes
(hh:mm) that AOS will wait before reloading.
Default Values
Command History
Usage Examples
The following example reloads the AOS software in 3 hours and 27 minutes:
>enable
#reload in 03:27
The following example reloads the AOS software in 15 minutes:
>enable
#reload in 15
The following example terminates a pending reload command:
>enable
#reload cancel

reload dot11 interface dot11ap <ap interface>

Use the reload dot11 interface dot11ap command to perform a cold start of a wireless access point (AP)
that is currently controlled by the wireless access controller (AC) on which the command is executed.
reload dot11 interface dot11ap <ap interface>

reload dot11 interface dot11ap <ap interface> factory-default
Syntax Description
<ap interface> Specifies the AP interface number to reload. Range is 1 to 8.
factory-default Optional. Specifies reloading the unit with the factory default settings.
Default Values
Command History
Usage Examples
The following example performs a cold start for AP interface 1:
>enable
#reload dot11 interface dot11ap 1
AP 1 reloaded
Router#
2006.12.23 19:14:03 DOT11.Session : AP 1: AP reboot.
2006.12.23 19:14:03 DOT11.Session : AP 1: Control session lost.
2006.12.23 19:14:03 DOT11.Session : AP 1: Control session established.

run audit security

Use the run audit security command to run a security audit on the AOS device. Variations of this
command include:
run audit security

run audit security log
run audit security log cflash
Once the audit is in process, the session will be blocked until the audit is completed or until
Ctrl+C is issued.
Syntax Description
cflash Optional. Specifies saving the log file to CompactFlash® memory.
log Optional. Specifies saving the audit results to a file named
securityAudit_<timestamp>. The file name has the timestamp attached in
the format yyyymmddhhmmss. If cflash is not specified, the file is saved to
flash memory.
Default Values
Command History
Functional Notes
The security audit tool is used to identify possible security violations. The results of the audit can be viewed
by using the show audit security command (refer to show audit security on page 343), or by viewing the
log file using the commands show flash on page 412 or show cflash on page 360.
The show audit security command displays a summary of the security audit results including: the type of
defect, severity, and a brief description. The show audit security detail command lists the summary, as
well as details of the defect and recommends corrective action. It is up to the customer to determine if the
findings are a true risk in their system, and to make the necessary adjustments to their configuration. Some
items could be recorded as possible risks that are not actual risks based on the entire network
configuration.
If two people are logged in simultaneously (for example, one via Telnet and one via the console) and both
try to run the audit security tool, the user who begins the audit first will take precedence. An error message
will be displayed to the second user that an audit is in progress.

The following table lists the configuration items that are audited for security risks.
Violation Type Severity Description

Startup-Config High Indicates that the startup configuration file does not match the
running configuration file. This is determined by comparing the MD5
checksum of both files for a match.
Passwords/Keys High Identifies nonsecure passwords. If a password has MD5 encryption
enabled, the tool tests for common password sequences
such as qwerty, 1234, abc, xyz, etc. If MD5 is disabled, an alert is
issued if the password:
• Is less than 7 characters.
• Does not contain alphabetic and numeric characters.
• Matches common sequences such as qwerty, 1234, abc, xyz,
etc.
• Matches the default passwords.
• Matches another password in the system.
• Service password encryption is not enabled.
Firewall High Indicates the firewall is disabled.
Policy-Class High Identifies any of the following access control policy (ACP)
vulnerabilities:
• Stateful inspection is disabled.
• An undefined access control list (ACL) exists in the ACP.
• An interface with a private IP address (10.x.x.x, 172.16.x.x,
192.168.x.x) has an ACP assigned that does not have NAT
configured.
• An interface is enabled without an ACP assigned.
SNMP High Indicates the SNMP agent is enabled and configured to allow
SNMPv1 or SNMPv2. Both of these versions are considered
nonsecure. SNMPv3 group and SNMPv3 user are preferred.
Network Protocols High Identifies any of the following network protocols are enabled and
considered a security risk: HTTP, HTTPS SSLv2, FTP, TFTP, and
Telnet. SSH is suggested as a replacement for Telnet and HTTPS
SSLv3 instead of HTTPS SSLv2.
WIFI High Identifies any of the following wireless vulnerabilities:
• Security mode is set to anything but WPA2 (including none).
• Service set identifier (SSID) broadcast is enabled.
• A weak key.
Session Timeout High Identifies the console, HTTP, SSH, or Telnet session timeout is set
to a value greater than 15 minutes. Long session timeouts can
compromise the system. The recommended setting is 15 minutes or
less.
Time-Server High Indicates the time server (SNTP or NTP) is not configured or is
configured but not synchronized. It is important to have a valid
timestamp on all logs generated by the system.

Violation Type Severity Description

Logging Medium Indicates user activity is not being logged. User activity should be
logged either by enabling syslog or TACACs+ accounting. (The
syslog can be enabled by using the logging forwarding on
command.)
Domain Lookup Medium Indicates ip domain-lookup is enabled but a DNS server has not
been configured. This allows DNS requests to be broadcast.
Interfaces Medium Identifies the following interface vulnerabilities:
• The ip directed-broadcast is enabled which could make an
interface vulnerable to denial of service attacks.
• A static ACL assigned to an interface. A more secure option is to
enable the firewall and assign an ACP.
Enable Password Low Indicates the enable password is not set for MD5 encryption. MD5
encryption is more secure than standard password encryption.
Banner Low Indicates the default executive banner is still set. It is recommended
that a custom banner be displayed when a user attempts to login.
The banner warns of the legal consequences of unauthorized
access to the unit.
TCL Scripts Low Indicates TCL scripting is enabled. Scripts could cause damage to
configuration of the unit.
Usage Examples
The following example initiates the security audit and saves the results to a log file in flash memory:
>enable
#run audit security log
Audit Complete

run-tcl <filename> track <name>

Use the run-tcl track command to initiate a tool command language (Tcl) script based on the result of
monitoring the change of state of a track. Use the no form of this command to disable the track monitoring
for the given script. This command is only available on platforms with Network Monitoring enabled. For
more information on creating tracks, refer to track <name> on page 1124 and the Network Monitor Track
Command Set on page 2356. Variations of this command include:
run-tcl <filename> track <name> on-pass

run-tcl <filename> track <name> on-fail
Syntax Description
<filename> Specifies a Tcl script file.
<name> Specifies the name of the track to be monitored.
on-pass Specifies the file should be run when the track meets the passing condition.
on-fail Specifies the file should be run when the track meets the failure condition.
Default Values
Command History
Usage Examples
The following example activates a Tcl script to be run when the failure condition is met on track_a:
>enable
#run tcl test1.tcl track track_a on-fail

show access-lists
Use the show access-lists command to display all configured access control lists (ACLs) in the system (or
a specific list). Variations of this command include:
show access-lists
show access-lists <name>
The output of all show commands can be limited by appending the following modifiers to
the end of the command: | begin <text>, | exclude <text>, and | include <text>. The
include modifier limits output to lines that contain the specified text, the exclude modifier
excludes any lines with the specified text, and the begin modifier displays the first line of
output with the specified text and all lines thereafter.
For specific instructions and examples regarding these modifiers, refer to the introduction
of the Enable Mode Command Set on page 62.
Syntax Description
<name> Optional. Specifies a particular ACL to display.
Default Values
Command History
Release 17.1 Command was expanded to include the modifiers begin, exclude, and
include.
Functional Notes
The show access-lists command displays all configured ACLs in the system. All entries in the ACL are
displayed, and a counter indicating the number of packets matching the entry is listed.
Usage Examples
The following is a sample output from the show access-lists command:
>enable
#show access-lists
Standard access list MatchAll
permit host 10.3.50.6 (0 matches)
permit 10.200.5.0 wildcard bits 0.0.0.255 (0 matches)
extended access list UnTrusted
deny icmp 10.5.60.0 wildcard bits 0.0.0.255 any source-quench (0 matches)
deny tcp any (0 matches)

show audit security

Use the show audit security command to display the results of the security audit including: the type of
defect, severity, and a brief description. The security audit must be initiated first using the command run
audit security on page 338. Variations of this command include:
show audit security

show audit security detail
Syntax Description
detail Optional. Displays the details of the security audit and recommends
corrective action.
Default Values
Command History
Functional Notes
The security audit tool is used to identify possible security violations and is initiated by using the command
run audit security on page 338.
The show audit security detail command lists a summary of the results, as well as details of the defect
and recommends corrective action. It is up to the customer to determine if the findings are a true risk in
their system, and to make the necessary adjustments to their configuration. Some items could be recorded
as possible risks that are not actual risks based on the entire network configuration.
Usage Examples
The following is a sample show audit security output:
>enable
#show audit security
Using 2214 bytes
**SUMMARY**

-------------------------------------------------------------------------------------------------------------------
Severity Type Description
-------------------------------------------------------------------------------------------------------------------
LOW Enable Password MD5 encryption is not enabled
HIGH Network Protocol FTP server enabled
HIGH Network Protocol TFTP server enabled
HIGH Network Protocol HTTP server enabled
HIGH Network Protocol Telnet enabled
HIGH Policy-Class Private, undefined ACL
HIGH Policy-Class Private, stateless
HIGH Policy-Class Public, stateless
HIGH Policy-Class Public, NAT not enabled
HIGH Policy-Class Interfaces using default policy-class
HIGH Password Weak Passwords
HIGH Password Duplicate Passwords
HIGH Session Timeout Console timeout >= 15 minutes
HIGH Session Timeout Telnet 0 timeout >= 15 minutes
HIGH Session Timeout SSH 0 timeout >= 15 minutes
HIGH SNMP Using SNMPv1/v2, not secure
-------------------------------------------------------------------------------------------------------------------
The following is a sample show audit security detail output:
>enable
#show audit security detail
Using 4193 bytes
**DETAIL**
-------------------------------------------------------------------------------------------------------------------
-------------------------------------------------------------------------------------------------------------------
ENABLE PASSWORD:
-------------------------------------------------------------------------------------------------------------------
* The enable password is not set for MD5 encryption. MD5 encryption is more
secure than standard password encryption.
-------------------------------------------------------------------------------------------------------------------
NETWORK PROTOCOLS:
-------------------------------------------------------------------------------------------------------------------
* The following protocols are enabled and may be a security risk.
Disable if not needed. Use SSH instead of Telnet and HTTP SSLv3 instead of

HTTP SSLv2.
* FTP
* TFTP
* HTTP
* Telnet
-------------------------------------------------------------------------------------------------------------------
POLICY-CLASS:
-------------------------------------------------------------------------------------------------------------------
* Potential vulnerabilities were found with the following policies. Note: NAT
may not be required on all policies; however, broadcast of IP addresses from the
internal network to the Internet should be restricted. This tool did not take
into account how the polices are used. Depending upon the configuration of your
network, these policies may or may not make your network vulnerable.
***********************************************************************************************
Name Line Description
***********************************************************************************************
Private 2 Allows undefined ACL
Private 3 Allows stateless-inspection
Public 4 Allows stateless-inspection
Public N/A NAT not enabled for
Private interface, eth 0/1
* The following interfaces are enabled but do not have a policy-class

assigned. Not having a policy-class assigned will leave the interface open to
attack.
* vlan 1210
-------------------------------------------------------------------------------------------------------------------
PASSWORDS / KEYS:
-------------------------------------------------------------------------------------------------------------------
* Passwords should be at least 7 characters and have both alphabetic and
numeric characters. Some passwords are considered weak if they match default
passwords or contain common sequences. For example Qwerty123 is considered a
weak password even though it contains both numeric and alphabetic characters.
The following weak passwords were found:
* 1f1965f156e907907d3a8ed5172557a86736(encrypted)
* 2b2d9aa78c8dfb9fca1cf745d72e2e28cc99(encrypted)
* 373fbaa34722617409e24b9d9a707cb09fe3(encrypted)
* 1610d7b313a09983a2de5bb4f1a77997f346(encrypted)
* 24223699587eef35644778c8a901cca82a70(encrypted)
* 46400f529e54aeb56fa224fadb14c111f007(encrypted)

* Each user should have a unique password. The following passwords

are duplicated:
* 2b2d9aa78c8dfb9fca1cf745d72e2e28cc99(encrypted)
* 46400f529e54aeb56fa224fadb14c111f007(encrypted)
-------------------------------------------------------------------------------------------------------------------
SESSION TIMEOUT:
-------------------------------------------------------------------------------------------------------------------
* The following sessions have timeout values of 15 minutes or greater. Long
session timeouts may allow your system to be compromised. To increase
security, set the timeout value to less than 15 minutes.
* Console
* Telnet 0
* Telnet 1
* Telnet 2
* Telnet 3
* Telnet 4
* SSH 0
* SSH 1
* SSH 2
* SSH 3
-------------------------------------------------------------------------------------------------------------------
SNMP:
-------------------------------------------------------------------------------------------------------------------
* The SNMP agent is enabled and is configured to allow SNMPv1 and
SNMPv2 which are not secure. If SNMP is needed, remove the community
names and add SNMPv3 group and SNMPv3 user.
-------------------------------------------------------------------------------------------------------------------

show auto-link
Use the show auto-link command to display auto-provisioning and synchronization (APS) configuration
and current status.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following is sample output of the show auto-link command:
>enable
#show auto-link
Auto-link: Enabled
Use Http: Enabled
Server URL: 10.14.1.55/aps/DiscoveryProcessor?action=devinfo
Server SERVER: 10.14.1.55
Recontact Interval: 3600 seconds
Last Contact: Tue, June 17, 2008 10:32:01 AM
Next Contact: Tue, June 17, 2008 11:30:23 AM
Status: Discovered

show arp
Use the show arp command to display the Address Resolution Protocol (ARP) table. Variations of this
command include:
show arp
show arp realtime
show arp vrf <name>
show arp vrf <name> realtime
Using the realtime argument for this command can adversely affect the performance or
your unit.
Syntax Description
realtime Optional. Displays full-screen output in real time. Refer to the Functional
Notes below for more information.
vrf <name> Optional. Displays information only for the specified VPN routing and
forwarding (VRF). If a VRF is not specified, the default VRF is assumed.
Default Values
Command History
Release 10.1 The realtime display parameter was introduced.
include.

Functional Notes
Use the realtime argument for this command to display full-screen output in real time. Information is
continuously updated on the console until you either freeze the data (by pressing the F key) or exit
realtime mode (by pressing Ctrl-C). If there is not enough room on the screen for all available data, the
information will truncate at the bottom of the screen. In order to maximize the amount of data displayed,
increase the terminal length (using the terminal length command; refer to terminal length <number> on
page 702).
Usage Examples
The following is a sample output of the show arp command:
>enable
#show arp
ADDRESS TTL(min) MAC ADDRESS INTERFACE TYPE
10.22.18.3 19 00:E0:29:6C:BA:31 eth 0/1 Dynamic
192.168.20.2 16 00:A0:C8:0D:E9:AD eth 0/2 Dynamic
224.0.0.5 20 01:00:5E:00:00:05 eth 0/2 Permanent

show atm pvc

Use the show atm command to display information specific to the asynchronous transfer mode (ATM)
interface’s permanent virtual circuit (PVC). Variations of this command include the following:
show atm pvc

show atm pvc interfaces atm <interface>
Syntax Description
interfaces atm <interface> Optional. Displays the ATM PVC information for a specific PVC. Specify an
ATM interface (valid range is 1 to 1023) or a subinterface in the format
<interface id.subinterface id> (for example, 1.1). Using this command
without specifying an interface will display all information for all ATM PVCs.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show atm pvc interfaces command:
>enable
#show atm pvc interface atm 1.1
Name VPI VCI Encap Type SC Peak Kbps Avg/Min Kbps Burst Cells Status
atm 1.1 0 200 SNAP N/A 0 0 0 Active

show atm traffic interface atm <interface>

Use the show atm traffic command to display traffic information specific to the asynchronous transfer
mode (ATM) interface.
Syntax Description
<interface> Specifies an ATM port number. Specify an ATM interface (valid range is 1 to
1023) or a subinterface in the format <interface id.subinterface id> (for
example, 1.1).
Default Values
Command History
include.
Usage Examples
The following is sample output from the show atm traffic command from ATM interface 1:
>enable
#show atm traffic interface atm 1
atm 1 is UP, line protocol is UP
BW 896 Kbit/s
16 maximum active VCCs, 16 VCCs per VP, 1 current VCCs
Queueing strategy: Per VC Queueing
5 minute input rate 32 bits/sec, 0 packets/sec
5 minute output rate 0 bits/sec, 0 packets/sec
19 packets input, 1357 bytes
0 pkts discarded, 0 error pkts, 0 unknown protocol pkts
45 cells received, 0 OAM cells received
0 packets output, 0 bytes
0 tx pkts discarded, 0 tx error pkts 0 internal tx error pkts
0 cells sent, 0 OAM cells sent

The following is sample output from the show atm traffic command from ATM subinterface 1.1:
#show atm traffic interface atm 1.1

27 Input Packets
0 Output Packets
72 Cells received, 0 OAM cells received
F5 InEndLoopReq: 0 F5 InEndLoopResp: 0 F5 InAIS: 0 F5 InRDI: 0
0 Cells sent, 0 OAM cells sent
F5 OutEndLoopReq: 0 F5 OutEndLoopResp: 0 F5 OutAIS: 0 F5 OutRDI: 0
0 OAM Loopback Successes 0 OAM Loopback Failures

show auto-config
Use the show auto-config command to display auto-configuration status.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample output of the show auto-config command:
>enable
#show auto-config
Auto-Config is enabled, current status: Done.
TFTP Server is 10.20.20.1
Config filename is 1524STfile
Maximum retry count is 0 (repeat indefinitely), total retries is 0

show bridge
Use the show bridge command to display a list of all configured bridge groups (including individual
members of each group). Enter an interface or a bridge number to display the corresponding list. Variations
show bridge
show bridge <interface>
show bridge <number>
Syntax Description
<interface> Optional. Displays all bridge groups associated with the specific interface.
dot11ap 1/1.1. Type the show bridge ? command to display a list of
<number> Optional. Displays a specific bridge group.
Default Values
Command History
interface.
include.

Usage Examples
The following is a sample output from the show bridge command:
>enable
#show bridge
Total of 300 station blocks 295 free
Address Action Interface Age Rx Count Tx Count
00:04:51:57:4D:5A forward eth 0/1 0 7133392 7042770
00:04:5A:57:4F:2A forward eth 0/1 0 402365 311642
00:10:A4:B3:A2:72 forward eth 0/1 4 2 0
00:A0:C8:00:8F:98 forward eth 0/1 0 412367 231
00:E0:81:10:FF:CE forward fr 1.17 0 1502106 1486963

show buffers
Use the show buffers command to display the statistics for the buffer pools on the network server.
show buffers
show buffers realtime
Using the realtime argument for this command can adversely affect the performance of
your unit.
Syntax Description
Default Values
Command History
include.
Functional Notes
page 702).

Usage Examples
The following is a sample output from the show buffers command:
>enable
#show buffers
Buffer handles: 119 of 2000 used.
Pool Size Total Used Available Max. Used
0 1800 1894 119 1775 122
1 2048 64 0 64 0
2 4096 32 0 32 0
3 8192 4 0 4 0

show buffers users

Use the show buffers users command to display a list of the top users of packet buffers. Typically, this
command will only be used as a debug tool by ADTRAN personnel. Variations of this command include:
show buffers users

show buffers users realtime
your unit.
Syntax Description
Default Values
Command History
include.
Functional Notes
page 702).

Usage Examples
The following is a sample from the show buffers users command:
>enable
#show buffers users
Number of users: 7
Ran User Count
1 0x0052f4f8 59
2 0x0051a4fc 32
3 0x00528564 8
4 0x0053c1c8 7
5 fixedsize 5
6 0x001d8298 2
7 0x0010d970 1
8 0x00000000 0
9 0x00000000 0
10 0x00000000 0
11 0x00000000 0

show cflash
Use the show cflash command to display a list of all files currently stored in CompactFlash® memory or
details about a specific file stored in CompactFlash memory. Variations of this command include:
show cflash
show cflash <filename>
Syntax Description
<filename> Optional. Displays details for a specified file located in flash memory. Enter
a wildcard (such as *.biz) to display the details for all files matching the
entered pattern.
Default Values
Command History
include.
Usage Examples
The following is a sample show cflash output:
>enable
#show cflash
(dir) 0 SystemDefaultPrompts
(dir) 0 VoiceMail
9377163 NV7100A-12-00-23-E.biz
11110890 sip.ld
8767439 NV7100A-11-03-02-E.biz
8771176 NV7100A-11-03-02d-E.biz
8773148 NV7100A-11-03-03-E.biz

show channel-group
Use the show channel-group command to display detailed information regarding port aggregation of a
specified channel group (i.e., channel groups and their associated ports). Variations of this command
show channel-group port-channel load-balance

show channel-group summary
show channel-group <number> summary
Syntax Description
port-channel load-balance Displays the current load-balance scheme.
summary Summarizes the state of all channel groups or of a specific channel group (if
specified by the <number> argument).
<number> Optional. Specifies the channel group using the channel group ID (16).
Default Values
Command History
include.
Usage Examples
The following is a sample from the show channel-group command:
>enable
#show channel-group summary
Channel Group Port channel Associated Ports
-------------------- ----------------- -----------------------
1 1 eth 0/2 eth 0/3
2 2 eth 0/5 eth 0/6 eth 0/7

show clock
Use the show clock command to display the system time and date entered using the clock set command.
Refer to clock set <time> <day> <month> <year> on page 139 for more information. Variations of this
command include:
show clock
show clock detail
Syntax Description
detail Optional. Displays more detailed clock information, including the time source.
Default Values
Command History
include.
Usage Examples
The following example displays the current time and data from the system clock:
>show clock
23:35:07 UTC Tue Aug 20 2002

show configuration
Use the show configuration command to display a text printout of the startup configuration file stored in
nonvolatile random access memory (NVRAM).
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample output of the show configuration command:
>enable
#show configuration
!
!
no enable password
!
ip subnet-zero
ip classless
ip routing
!
event-history on
no logging forwarding
logging forwarding priority-level info
no logging email
!
ip policy-timeout tcp all-ports 600
ip policy-timeout udp all-ports 60
ip policy-timeout icmp 60

!
!
!
interface eth 0/1
speed auto
no ip address
shutdown
!
interface dds 1/1
shutdown
!
interface bri 1/2
shutdown
!
!
ip access-list standard Outbound
permit host 10.3.50.6
permit 10.200.5.0 0.0.0.255
!
!
ip access-list extended UnTrusted
deny icmp 10.5.60.0 0.0.0.255 any source-quench
deny tcp any any
!
no ip snmp agent
!
!
!
line con 0
no login
!
line telnet 0
login
line telnet 1
login
line telnet 2
login
line telnet 3
login
line telnet 4
login
!

show connections
Use the show connections command to display information (including time division multiplexing (TDM)
group assignments) for all active connections.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show connections command:
>enable
#show connections
Displaying all connections....
Conn ID From To
_____________________________________________________________
1 atm 1 adsl 1/1
2 ppp 1 t1 2/1, tdm-group 1
3 ppp 1 t1 2/2, tdm-group 1
4 ppp 3 e1 3/1, tdm-group 1

show crypto ca
Use the show crypto ca command to display information regarding certificates and profiles. Variations of
show crypto ca certificates

show crypto ca crls
show crypto ca profiles
Syntax Description
certificates Displays information on all certificates.
crls Displays a summary of all certificate revocation lists (CRLs) for each
certificate authority (CA).
profiles Displays information on all configured CA profiles.
Default Values
Command History
Release 5.1 Command was introduced (enhanced software version only).
include.

Usage Examples
The following is a sample from the show crypto ca certificates command:
>enable
#show crypto ca certificates
CA Certificate
Status: Available
Certificate Serial Number: 012d
Subject Name: /C=FI/O=SSH Communications Security/OU=Web test/CN=Test CA 1
Issuer: /C=FI/O=SSH Communications Security/OU=Web test/CN=Test CA 1
CRL Dist. Pt: /C=FI/O=SSH Communications Security/OU=Web test/CN=Test CA 1
Start date is Jan 9 16:25:15 2003 GMT
End date is Dec 31 23:59:59 2003 GMT
Key Usage:
Non-Repudiation
Key Encipherment
Data Encipherment
CRL Signature
Encipherment Only

show crypto ike

Use the show crypto ike command to display information regarding the Internet key exchange (IKE)
configuration. Variations of this command include the following:
show crypto ike client configuration pool

show crypto ike client configuration pool <name>
show crypto ike policy
show crypto ike policy <value>
show crypto ike remote-id <remote-id>
show crypto ike sa
show crypto ike sa brief
Syntax Description
client configuration pool Displays the list of all configured IKE client configuration pools.
<name> Optional. Displays detailed information regarding the specified IKE client
configuration pool.
policy Displays information on all IKE policies. Indicates if client configuration is
enabled for the IKE policies and displays the pool names.
<value> Optional. Displays detailed information on the specified IKE policy. This
number is assigned using the crypto ike policy command. Refer to crypto
ike on page 780 for more information.
remote-id <remote-id> Displays information on all IKE information regarding the remote-id. The
remote-id value is specified using the crypto ike remote-id command.
Refer to crypto ike remote-id on page 784 for more information.
sa Displays all Internet Protocol security (IPsec) security associations (SAs).
sa brief Optional. Displays a brief listing of IPsec SAs.
Default Values

Command History
Release 15.1 Command was expanded to include the brief parameter.
include.
Usage Examples
The following is a sample from the show crypto ike policy command:
>enable
#show crypto ike policy
Crypto IKE Policy 100
Main mode
Using System Local ID Address
Peers:
63.105.15.129
initiate main
respond anymode
Attributes:
10
Encryption: 3DES
Hash: SHA
Authentication: Pre-share
Group: 1
Lifetime: 900 seconds
The following is a sample from the show crypto ike sa brief command:
>enable
#show crypto ike sa brief
Using 3 SAs out of 2000
IKE Security Associations:
(NOTE: The Remote ID may be truncated)
Peer IP Address Lifetime Status IKE Policy Remote ID

10.22.19.4 19800 UP (SA_MATURE) 100 nv1224r
10.22.19.2 0 MM_SA_WAIT 101 UNKNOWN
10.22.19.6 86365 UP (SA_MATURE) 102 security2

show crypto ipsec

Use the show crypto ipsec command to display information regarding the Internet Protocol security
(IPsec) configuration. Variations of this command include the following:
show crypto ipsec sa

show crypto ipsec sa address <ip address>
show crypto ipsec sa brief
show crypto ipsec sa ffe-id <rapidroute interface ID>
show crypto ipsec sa map <name>
show crypto ipsec transform-set
show crypto ipsec transform-set <name>
Syntax Description
sa Displays all IPsec security associations (SAs).
sa address <ip address> Optional. Displays all IPsec SAs associated with the designated peer
IP address. IP addresses should be expressed in dotted decimal
notation (for example, 10.10.10.1).
sa brief Optional. Displays a brief listing of IPsec SAs.
sa ffe-id <rapidroute interface ID> Optional. Displays all IPsec SAs associated with a specific
RapidRoute interface. RapidRoute interfaces have a numerical
identifier that ranges between 1 and 16777215. These identifiers are
displayed in the various outputs of the show ip ffe commands
beginning with the command show ip ffe on page 465.
sa map <name> Optional. Displays all IPsec SAs associated with the specified crypto
map.
transform-set Displays all defined transform sets.
<name> Optional. Displays information for a specific transform set.
Default Values

Command History
Release 15.1 Command was expanded to include the brief parameter.
include.
Release 17.6 Command was expanded to include the ffe-id parameter.
Usage Examples
The following is sample output from the show crypto ipsec sa command:
>enable
#show crypto ipsec sa
Using 2 SAs out of 4000
Peak concurrent SAs: 2
IPsec Security Associations:
Peer IP Address: 3.3.3.1

Remote ID: 3.3.3.2
Crypto Map: VPN 10
Direction: Inbound
Encapsulation: ESP
SPI: 0xF38B37A1 (4085987233)
FFE ID: 1
RX Bytes: 281728
Selectors: Src:10.0.2.0/255.255.255.0 Port:ANY Proto:ALL IP
Dst:10.0.1.0/255.255.255.0 Port:ANY Proto:ALL IP
Hard Lifetime: 28570
Soft Lifetime: 0
Out-of-Sequence Errors: 0
Peer IP Address: 3.3.3.2

Remote ID: 3.3.3.2
Crypto Map: VPN 10
Direction: Outbound
Encapsulation: ESP
SPI: 0x923DBAB4 (2453519028)
FFE ID: 2
TX Bytes: 281728
Selectors: Src:10.0.1.0/255.255.255.0 Port:ANY Proto:ALL IP
Dst:10.0.2.0/255.255.255.0 Port:ANY Proto:ALL IP
Hard Lifetime: 28570
Soft Lifetime: 28540

The following is sample output from the show crypto ipsec sa brief command:
>enable
#show crypto ipsec sa brief
Using 4 SAs out 4000
IPsec Security Associations:
(NOTE: Crypto Map and Remote ID may be truncated)
Peer IP Address # Bytes Crypto Map Remote ID

10.22.19.34 RX 384 VPN 10 nv1224r
10.22.19.34 RX0 VPN 30 security2
10.22.19.4 TX 512 VPN 10 nv1224r
10.22.19.6 TX 128 VPN 30 security2

show crypto map

Use the show crypto map command to display information regarding crypto map settings. Variations of
show crypto map

show crypto map interface <interface>
show crypto map <name>
show crypto map <name> <number>
Syntax Description
interface <interface> Optional. Displays the crypto map settings for the specified interface.
dot11ap 1/1.1. Type show crypto map interface ? for a complete list of
valid interfaces.
<name> Optional. Specifies a specific crypto map name.
<number> Optional. Specifies a specific crypto map number.
Default Values
Command History
include.

Usage Examples
The following is a sample from the show crypto map command:
>enable
#show crypto map testMap
Crypto Map “testMap” 10 ipsec-ike
Extended IP access list NewList
Peers:
63.97.45.57
Transform sets:
esp-des
Security-association lifetimes:
0 kilobytes
86400 seconds
No PFS group configured
Interfaces using crypto map testMap:
eth 0/1

show debugging
Use the show debugging command to display a list of all activated debug message categories. Variations
show debugging
show debugging saved-filters
Syntax Description
saved-filters Optional. Displays the last debug filters saved using the command debug
save on page 294.
Default Values
Command History
include.
Release 17.4 Command was expanded to include the saved-filters keyword.
Usage Examples
The following is a sample output from the show debugging command:
>enable
#show debugging
debug access-list MatchAll
debug firewall
debug ip rip
debug frame-relay events
debug frame-relay llc2
debug frame-relay lmi

The following is a sample output from the show debugging saved-filters command:
>enable
#show debugging saved-filters
Saved filters:
debug probe test1

show demand
Use the show demand command to display information regarding demand routing parameters and
statistics. Variations of this command include the following:
show demand
show demand interface demand <interface>
show demand resource pool
show demand resource pool <name>
show demand sessions
Syntax Description
interface demand <interface> Optional. Displays information for a specific demand routing interface.
Valid range is 1 to 1024. Type show demand interface ? for a list of valid
interfaces.
resource pool Optional. Displays all resource pool information.
<name> Optional. Displays resource pool information for a specific resource pool
name.
sessions Optional. Displays active demand sessions.
Default Values
Command History
include.
Usage Examples
The following is example output from the show demand interface command:
>enable
#show demand int 1
Demand 1 is UP (connected)
Configuration:
Keep-alive is set (10 sec.)
Admin MTU = 1500

Mode: Either, 1 dial entries, idleTime = 120, fastIdle = 20

Resource pool demand
No authentication configured
IP address 10.100.0.2 255.255.255.0
Connect Sequence: Successes = 0, Failures = 0
Seq DialString Technology Successes Busys NoAnswers NoAuths InUse
5 5552222 ISDN 0 0 0 0
Current values:
Local IP address 10.100.0.2, Peer IP address 10.100.0.1
Seconds until disconnect: 63
Queueing method: weighted fair
Output queue: 0/1/428/64/0 (size/highest/max total/threshold/drops)
Conversations 0/1/256 (active/max active/max total)
Available Bandwidth 48 kilobits/sec
Bandwidth=64 Kbps
Link through bri 1/3, Uptime 0:01:10
IN: Octets 588, Frames 19, Errors 0
OUT: Octets 498, Frames 18, Errors 0
Last callerID 2565552222, last called num 5552222
The following is example output from the show demand interface demand command:
>enable
#show demand interface demand 1
demand 1
Idle timer (120 secs), Fast idle timer (20 secs)
Dialer state is data link layer up

Dial reason: answered
Interface bound to resource bri 1/3

Time until disconnect 105 secs
Current call connected 00:00:27
Connected to 2565552222
Number of active calls = 1

Interesting Traffic = list junk
Connect Sequence: Successes = 0, Failures = 0

Seq DialString Technology Successes Busys NoAnswers NoAuths InUse
5 5552222 ISDN0 0 0 0

The following is example output from the show demand resource pool command:
>enable
#show demand resource pool
Pool demand
Resources: bri 1/3, bri 2/3
Demand Interfaces: demand 1
The following is example output from the show demand sessions command:
>enable
#show demand sessions
Session 1
Interface demand 1
Local IP address = 10.100.0.2
Remote IP address = 10.100.0.1
Remote Username =
Dial reason: ip (s=, d=)
Link 1
Dialed number = 5552222
Resource interface = bri 1/3, Multilink not negotiated
Connect time: 0:0:13
Idle Timer: 119

show desktop-auditing dhcp

Use the show desktop-auditing dhcp command to display collected network access protection (NAP) and
Dynamic Host Configuration Protocol (DHCP) information for clients connected to the network. The
display of the collected information can be for all connected clients or for a specific client. Variations of
show desktop-auditing dhcp

show desktop-auditing dhcp antispyware 3rd-party
show desktop-auditing dhcp antispyware disabled
show desktop-auditing dhcp antispyware out-of-date
show desktop-auditing dhcp antispyware snoozed
show desktop-auditing dhcp antivirus 3rd-party
show desktop-auditing dhcp antivirus disabled
show desktop-auditing dhcp antivirus out-of-date
show desktop-auditing dhcp antivirus snoozed
show desktop-auditing dhcp auto-updates disabled
show desktop-auditing dhcp auto-updates not-checking
show desktop-auditing dhcp auto-updates not-downloading
show desktop-auditing dhcp auto-updates not-installing
show desktop-auditing dhcp brief
show desktop-auditing dhcp firewall 3rd-party
show desktop-auditing dhcp firewall disabled
show desktop-auditing dhcp firewall snoozed
show desktop-auditing dhcp hostname <hostname>
show desktop-auditing dhcp interface gigabit-switchport <slot/port>
show desktop-auditing dhcp ip <ip address>
show desktop-auditing dhcp local-violators
show desktop-auditing dhcp mac <mac address>
show desktop-auditing dhcp server-restricted
show desktop-auditing dhcp server-violators
Syntax Description
antispyware Optional. Displays NAP information only for clients with the
specified antispyware status.
3rd-party Displays NAP information only for clients with third-party
antispyware.

disabled Displays NAP information only for clients with disabled

antispyware.
out-of-date Displays NAP information only for clients with out-of-date
antispyware.
snoozed Displays NAP information only for clients with inactive
antispyware.
antivirus Optional. Displays NAP information only for clients with the
specified antivirus status.
antivirus software.
antivirus software.
out-of-date Displays NAP information only for clients with out-of-date
antivirus software.
snoozed Displays NAP information only for clients with inactive
antivirus software.
auto-updates Optional. Displays NAP information only for clients with the
specified auto-update status.
auto-updates.
not-checking Displays NAP information only for clients that are not
checking for auto-updates.
not-downloading Displays NAP information only for clients that are not
downloading auto-updates.
not-installing Displays NAP information only for clients that are not
installing auto-updates.
brief Optional. Displays information for all NAP clients in a table
format.
firewall Optional. Displays NAP information only for clients with the
specified firewall state.
firewall software.
firewall software.
snoozed Displays NAP information only for clients with inactive firewall
software is displayed.
hostname <hostname> Optional. Displays NAP information only for the client with the
interface gigabit-switchport <slot/port> Optional. Displays NAP information only for the client using
the specified interface.
ip <ip address> Optional. Displays NAP information only for the client at the

local-violators Optional. Displays NAP information only for clients that

violate the local policy.
mac <mac address> Optional. Displays NAP information only for the client at the
server-restricted Optional. Displays NAP information only for the clients
restricted by the server.
server-violators Optional. Displays NAP information only for the clients that
violate the server policy.
Default Values
Command History
Functional Notes
Output of the show desktop-auditing dhcp command can be limited by specific client or by specific
criteria (feature states), but not by both.
Local policies are defined by using the command desktop-auditing local-policy on page 793.
For more information about configuring local policies, refer to Desktop Auditing Local Policy Command Set
on page 2975.
For more information about configuring desktop auditing, refer to the Configuring Desktop Auditing in AOS
configuration guide available online at http://kb.adtran.com.
Usage Examples
The following is sample output from the show desktop-auditing dhcp command:
#show desktop-auditing dhcp

Client MAC/IP: 00:E0:29:0E:D5:E3 / 10.23.220.1 / xpsp3-host
Collected: DHCP
VLAN ID: 100
Source Port: gigabit-switchport 0/2
Date/Time Collected: 2009.08.25 10:33:42
Client NAP: Enabled
Server NAP: Enabled
Client OS Version: Windows XP
Client OS Service Pack: 3
Client Processor Architecture: x86 architecture
Client Firewall: Microsoft
Disabled but Up-To-Date
Client Antivirus: Symantec Antivirus Corporate Edition

Enabled & Up-To-Date

Client Antispyware: None Installed
Client Automatic Security Updates: Enabled, Download, but Don’t Install
Client Security Updates: From 10.10.10.3
Up-To-Date (2009.08.25 10:33:42)
Client Requires Remediation: False
Network Connectivity: Not restricted
The preceding output is for one client. This same information will be displayed for all
connected clients unless one of the filtering parameters is used in conjunction with the
show desktop-auditing dhcp command.
The following is sample output from the show desktop-auditing dhcp brief command. Because of the
brief keyword, the results are displayed in table format.
#show desktop-auditing dhcp brief

Columns: E = Enabled, U = Up-to-date, 3 = 3rd party (not MS), S = Snoozed
C = Check for Updates, D = Download Updates, I = Install Updates
! = Error (not installed, other)
Indicators: + = True, - = False, ? = Unknown State
! = Attention
Server
Response R = Client Requires Remediation, N = Client Network Restricted
Codes: . = No Server Response
Client FireWall AntiVir AntiSpy AutoUpd SecUpd Server

E3S! EU3S! EU3S! ECDI! Severity Response
---------------------------------------------------------------------------
------------------------------------------------------------
00:E0:29:0E:D5:E3 +-- +++- +++- ++-- Important
00:E0:29:0E:D5:E4 --- +-+- ----! ++++ Low RN

show dial-backup interfaces

Use the show dial-backup interfaces command to display all configured dial-backup interfaces and the
associated parameters for each.
Syntax Description
No subcommands.
Default Values
Command History
Release 5.1 Command was expanded to include the Point-to-Point Protocol (PPP) dial
backup.
include.
Usage Examples
The following example enters the Enable mode and uses the show command to display dial-backup
interface information:
>enable
#show dial-backup interfaces
Dial-backup interfaces...
fr 1.16 backup interface:
Backup state: idle
Backup protocol: PPP
Call mode: originate
Auto-backup: enabled
Auto-restore: enabled
Priority: 50
Backup delay: 10 seconds
Restore delay: 10 seconds
Connect timeout: 60 seconds
--MORE--

show dialin interfaces

Use the show dialin interfaces command to display information regarding remote console dialin.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show dialin interfaces command:
>enable
#show dialin interfaces
Dialin interfaces...
modem 1/3 dialin interface:
Connection Status: Connected
Caller ID info: name-John Smith number-5551212 time-14:23:10 2/17/2003

show dos counters

Use the show dos counters command to display denial of service (DoS) attack statistics.
Syntax Description
No subcommands.
Default Values
By default, DoS protection in AOS is disabled.
Command History
Usage Examples
The following example displays attack statistics for the AOS unit:
>enable
#show dos counters
DOS Fragment Error 0
DOS ICMP Error 0
DOS L3 Header Error 0
DOS L4 Header Error 1269620
DOS Source MAC equal Destination MAC 0
#

show dos-id
Use the show dos-id command to list all denial of service (DoS) attacks the DoS protection feature
provides protection against, along with their corresponding threat IDs.
Syntax Description
No subcommands.
Default Values
By default, DoS Protection in AOS is disabled.
Command History
Functional Notes
The IDs obtained with the show dos-id command are used in the dos-protection <id> command to add
or remove threat protection for specific threats.
Usage Examples
>enable
#show dos-id
DOS L4 Header Error
TCP pkts w/ control flags and seq# equal to 0 [1]
TCP pkts w/ SYN and FIN bits set [2]
TCP pkts w/ FIN,URG,PSH bits set with ACK bit & seq# equal to 0 [3]
TCP pkts w/ source port equal to destination port [4]
UDP pkts w/ source port equal to destination port [5]
TCP SYN pkts w/source port 0-1023 for the first fragment [6]
DOS L3 Header Error

Source IP equal to Destination IP [20]
DOS ICMP Error

Fragmented ICMP pkts [40]
ICMPV4 ping pkts w/payload greater than specified [41]
ICMPV6 ping pkts w/payload greater than specified [42]
DOS Fragment Error

TCP fragments w/ offset value set to 1 [60]
First TCP fragments w/ TCP header smaller than specified [61]
#

show dot11 access-point

Use the show dot11 access-point command to display information about wireless access points (APs) for
the wireless access controllers (ACs) in the network. Variations of this command include the following:
show dot11 access-point

show dot11 access-point detail
show dot11 access-point mac-address <mac address>
show dot11 access-point mac-address <mac address> detail
show dot11 access-point managed
show dot11 access-point managed detail
show dot11 access-point managed realtime
show dot11 access-point name <name>
show dot11 access-point name <name> detail
show dot11 access-point realtime
show dot11 access-point status available
show dot11 access-point status available detail
show dot11 access-point status download
show dot11 access-point status download detail
show dot11 access-point status init
show dot11 access-point status init detail
show dot11 access-point status no_session
show dot11 access-point status no_session detail
show dot11 access-point status ready
show dot11 access-point status ready detail
show dot11 access-point status recovery
show dot11 access-point status recovery detail
show dot11 access-point status running
show dot11 access-point status running detail
show dot11 access-point status session
show dot11 access-point status session detail
show dot11 access-point unmanaged
show dot11 access-point unmanaged detail
show dot11 access-point unmanaged realtime

your unit.
Syntax Description
mac-address <mac address> Optional. Displays a particular access point (AP) by medium access control
(MAC) address. MAC addresses should be expressed in the following
format xx:xx:xx:xx:xx:xx (for example, 00:A0:C8:00:00:01).
managed Optional. Displays a list of APs managed by this AC.
name <name> Optional. Displays a particular AP by name.
status Optional. Displays APs at a certain status. (Refer to the options below.)
available Optional. Displays APs at available session state.
download Optional. Displays APs at download state.
init Optional. Displays APs at init state.
no_session Optional. Displays APs at no session state.
ready Optional. Displays APs at ready state.
recovery Optional. Displays APs at recovery state.
running Optional. Displays APs at running state.
session Optional. Displays APs at session state.
unmanaged Optional. Displays a list of APs not managed by this AC.
detail Optional. Displays a detailed list of all discovered APs.
Default Values
Command History
Release 16.1 Command was expanded to include the available session state.
include.
Functional Notes
page 702).

Usage Examples
The following is sample output from the show dot11 access-point command:
>enable
#show dot11 access-point
Wireless Access Points:
Name MAC-Address AP Status Cfg’d Control Status

------------------------------------------------------------------------------ ------- -----------------------
ADTN1DF857 00:A0:C8:1D:F8:57 Session Y Ctl_by_This_AC

show dot11 clients

Use the show dot11 clients command to display stations associated with all wireless access points (APs).
show dot11 clients interface dot11ap <ap interface>

show dot11 clients mac-address <mac address>
Syntax Description
interface dot11ap Displays stations associated with APs by interface.
<ap interface> Specifies AP interface number. Range is 1 to 8.
mac-address Displays stations associated with APs by medium access control (MAC)
address.
<mac address> Specifies a valid client 48-bit MAC address. MAC addresses should be
expressed in the following format xx:xx:xx:xx:xx:xx (for example,
00:A0:C8:00:00:01).
Default Values
Command History
include.
Usage Examples
The following command initiates a request to display a list of clients for AP interface 1.
>enable
#show dot11 clients interface dot11ap 1
Wireless Access Point Clients:
Ap Station MAC-Address
------ -------------------
1 00:40:96:AB:3B:5E

The following command initiates a request to display a list of clients for MAC address 00:40:96:ab:3b:5e:
>enable
#show dot11 clients mac-address 00:40:96:ab:3b:5e
Wireless Access Point Clients:
Ap Radio Vap Station MAC-Address
------ ------ ------ ---------------------------
1 1 1 00:40:96:AB:3B:5E

show dot11 statistics interface dot11ap

Use the show dot11 statistics interface dot11ap command to display counters of an 802.11 radio and its
virtual access points (VAPs). Variations of this command include the following:
show dot11 statistics interface dot11ap <ap/radio>

show dot11 statistics interface dot11ap <ap/radio.vap>
Syntax Description
<ap> Specifies the wireless access point (AP). Range is 1 to 8.
</radio> Specifies the radio associated with the AP. Range is 1 to 2.
<.vap> Specifies the VAP associated with the radio. Range is 1 to 8.
The radio must be specified in the format <ap/radio>. For example, 2/1 indicates radio 1
on access point 2. The virtual access point must be specified in the format <ap/radio.vap>.
For example, 2/1.1 indicates virtual access point 1 on radio 1 on access point 2.
Default Values
Command History
include.

Usage Examples
The following is an example output for the radio 1 on AP interface 1 using the show dot11 statistics
interface dot11ap command:
>enable
#show dot11 statistics interface dot11ap 1/1
Authentication Count: 17
Deauthentication Count: 48
Association Count: 18
Disassociation Count: 12
Reassociation Count: 0
Wireless MSDU Rx Packets: 346
Wireless Data Rx Packets: 7221
Wireless Multicast Rx Packets: 308
Wireless Management Rx Packets: 675805
Wireless Control Rx Packets: 0
Wireless MSDU Tx Packets: 237259
Wireless Data Tx Packets: 236856
Wireless Multicast Tx Packets: 236812
Wireless Management Tx Packets: 599
Wireless Control Tx Packets: 0

show dynamic-dns
Use the show dynamic-dns command to show information related to the dynamic domain naming system
(DNS) configuration.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output from this command:
>enable
#show dynamic-dns
eth 0/1:
Hostname: host
Is Updated: no
Last Registered IP: 10.15.221.33
Last Update Time: 00:00:00 UTC Thu Jan 01 1970

show ethernet cfm association

Use the show ethernet cfm association command to display Ethernet operations, administration, and
maintenance (OAM) connectivity fault management (CFM) maintenance association (MA) configuration
and statistical information. Variations of this command include:
show ethernet cfm association

show ethernet cfm association <domain name>
show ethernet cfm association <domain name> <association name>
show ethernet cfm association <domain name> <association name> detail
show ethernet cfm association detail
show ethernet cfm association none <association name>
show ethernet cfm association none <association name> detail
Syntax Description
<domain name> Optional. Specifies that output is limited to associations in the specified
domain.
<association name> Optional. Specifies that output is limited to the specified association.
detail Optional. Specifies the output is displayed in detail, rather than summary,
format.
none Optional. Specifies that no domain name is used.
Default Values
Command History
Functional Notes

Usage Examples
The following is sample output from the show ethernet cfm association command:
>enable
#show ethernet cfm association
--------------------------------------------------------------------------------------------------------------------------------
Index Domain/Association CCM MEP-Cnt
Component VID Sender-ID
--------------------------------------------------------------------------------------------------------------------------------
1 Bogus/Test 1sec 0
1 BenchTest/BenchAssoc 1min 3
giga-eth 0/2 0 none
The following is sample output from the show ethernet cfm association detail command:
>enable
#show ethernet cfm association detail
Domain Name: Bogus
Assoc Name: Test
SNMP Index: 1
CCM Interval: 1sec
Components:
MEP Count: 0
Domain Name: BenchTest

Assoc Name: BenchAssoc
SNMP Index: 1
CCM Interval: 1min
Components:
giga-eth 0/2 (VLAN=0, ID=none)
MEP Count: 3
1 (remote)
2 (remote)
3 (local)

show ethernet cfm domain

Use the show ethernet cfm domain command to display Ethernet operations, administration, and
maintenance (OAM) connectivity fault management (CFM) maintenance domain (MD) configuration and
statistical information. Variations of this command include:
show ethernet cfm domain

show ethernet cfm domain <domain name>
show ethernet cfm domain <domain name> detail
show ethernet cfm domain detail
show ethernet cfm domain none
Syntax Description
<domain name> Optional. Specifies that output is limited to associations in the specified
domain.
detail Optional. Specifies the output is displayed in detail, rather than summary,
format.
none Optional. Specifies that no domain name is used.
Default Values
Command History
Functional Notes

Usage Examples
The following is sample output from the show ethernet cfm domain command:
>enable
#show ethernet cfm domain
----------------------------------------------------------------------------------------------------
Index Domain Lvl Assoc-Count
----------------------------------------------------------------------------------------------------
1 Bogus 5 1
2 BenchTest 5 1
The following is sample output from the show ethernet cfm domain detail command:
>enable
#show ethernet cfm domain detail
Domain Name: Bogus
SNMP Index: 1
Level: 5
Associations: 1
test
Domain Name: BenchTest

SNMP Index: 2
Level: 5
Associations: 1
BenchAssoc

show ethernet cfm mep local

Use the show ethernet cfm mep local command to display configuration and statistical information for all
Ethernet operations, administration, and maintenance (OAM) connectivity fault management (CFM)
maintenance endpoints (MEPs) configured on the system. Variations of this command include:
show ethernet cfm mep local

show ethernet cfm mep local detail
show ethernet cfm mep local domain <domain name> association <association name>
show ethernet cfm mep local fault
show ethernet cfm mep local interface <interface>
show ethernet cfm mep local mep-id <mep id>
show ethernet cfm mep local statistics
Syntax Description
detail Optional. Specifies the format is in detail, rather than summary, format.
domain <domain name> Optional. Specifies that output is limited to MEPs in the specified
domain.
association <association name> Optional. Specifies that output is limited to MEPs in the specified
association.
fault Optional. Specifies that output is limited to only MEP fault information.
interface <interface> Optional. Specifies that output is limited to the MEPs configured on the
specified interface. Specify an interface in the format <interface type
[slot/port | slot/port.subinterface id | interface id |
interface id. subinterface id]>. For example, for an Ethernet
mep-id <mep id> Optional. Specifies that output is limited to MEPs with the specified ID.
MEP ID range is 1 to 8191.
statistics Optional. Specifies that only MEP statistics are displayed.
Default Values
Command History

Functional Notes
Usage Examples
The following is sample output from the show ethernet cfm mep local detail command:
>enable
#show ethernet cfm mep local detail
MEPs configured on this device
MEP-ID: 3
Domain/Assoc: BenchTest/Test
Mac Address: 00:A0:C9:00:D8:B2 Interface: giga-eth 0/2 Vlan: 0
Level: 5 Direction: down Priority: 7
Admin State: up CCM State: yes
Fault Notification Settings

-----------------------------------------------
Highest Allowed Defect: MacStatus
AlarmTime: 2500 ms ResetTime: 10000 ms
SNMP Trap: Disabled
Current Fault State

-----------------------------------
Fault State: Defect Last Reported Fault: 08:41 PM, 09/16/2008
Current Highest Defect: None

Current Defects (Highest to Lowest defect priority):
Xcon CCM: -
Err'd CCM: -
Remote CCM: -
MAC Status: -
RDI: -

Message Statistics
-----------------------------------
CCMs Transmitted: 2787 CCMs Received Out of Sequence: 4
LBRs Transmitted: 0 Next LBM ID: 36
LBRs Received: 30 LBRs Received Out of Order: 0
LBRs with bad data: 0
Next LTM ID: 1 Unexpected LTRs: 0
The following is sample output from the show ethernet cfm mep local fault command:
>enable
#show ethernet cfm mep local fault
MEPs configured on this device
MEP-ID: 3
Domain/Assoc: BenchTest/Test
Mac Address: 00:A0:C9:00:D8:B2 Interface: giga-eth 0/2 Vlan: 0
Level: 5 Direction: down Priority: 7
Admin State: up CCM State: yes
Fault Notification Settings

------------------------------------------------
Highest Allowed Defect: MacStatus
AlarmTime: 2500 ms ResetTime: 10000 ms
SNMP Trap: Disabled
Current Fault State

-------------------------------------
Fault State: Defect Last Reported Fault: 08:41 PM, 09/16/2008
Current Highest Defect: None

Current Defects (Highest to Lowest defect priority):
Xcon CCM: -
Err'd CCM: -
Remote CCM: -
MAC Status: -
RDI:

show ethernet cfm mep remote

Use the show ethernet cfm mep remote command to display configuration and statistical information for
all remote Ethernet operations, administration, and maintenance (OAM) connectivity fault management
(CFM) maintenance endpoints (MEPs) stored on the system. Variations of this command include:
show ethernet cfm mep remote

show ethernet cfm mep remote domain <domain name> association <association name>
show ethernet cfm mep remote domain none association <association name>
show ethernet cfm mep remote interface <interface>
show ethernet cfm mep remote level <level>
show ethernet cfm mep remote local-mep <mep id>
show ethernet cfm mep remote remote-mep <mep id>
Syntax Description
domain <domain name> Optional. Specifies that output is limited to MEPs in the specified domain.
none Optional. Specifies no domain name is used.
interface <interface> Optional. Specifies that output is limited to the MEPs configured on the
[slot/port | slot/port.subinterface id | interface id |
interface id. subinterface id]>. For example, for an Ethernet subinterface,
use eth 0/1.1. For a list of appropriate interface, enter interface ? at the
prompt.
level <level> Optional. Specifies that output is limited to MEPs in the specified
maintenance level. Levels range from 0 to 7.
local-mep <mep id> Optional. Specifies that output is limited to the remote MEPs for all local
MEPs with the specified ID. MEP ID range is 1 to 8191.
remote-mep <mep id> Optional. Specifies that output is limited to the remote MEPs with the
specified ID. MEP ID range is 1 to 8191.
Default Values
By default, all remote MEPs for all local MEPs are displayed.
By default, MEPs in all levels are displayed.
By default, all remote MEPs are displayed.

Command History
Functional Notes
Usage Examples
The following is sample output from the show ethernet cfm mep remote command:
>enable
#show ethernet cfm mep remote
Local MEP 3
Domain/Assoc: BenchTest/BenchAssoc
Level: 5 VLAN: 0
Interface: giga-eth 0/2
Remote MEPs: (* = static)
ID State Age MAC RDI Port Iface

--------------------------------------------------------------------------------------------------------------
* 1 Ok 165936 00:A0:C8:1F:CE:B0 - No TLV Up
* 2 Ok 165936 00:A0:C8:00:62:F2 - No TLV Up

show ethernet cfm stack

Use the show ethernet cfm stack command to display statistics and information about the Ethernet
operations, administration, and maintenance (OAM) connectivity fault management (CFM) stack.
show ethernet cfm stack

show ethernet cfm stack interface <interface>
show ethernet cfm stack level <level>
show ethernet cfm stack vlan <vlan id>
show ethernet cfm stack vlan none
Syntax Description
interface <interface> Optional. Specifies that output is limited to the specified interface. Specify
an interface in the format <interface type [slot/port | slot/port.subinterface id
| interface id | interface id. subinterface id]>. For example, for an Ethernet
level <level> Optional. Specifies that output is limited a specified maintenance level.
Levels range from 0 to 7.
vlan <vlan id> Optional. Specifies that output is limited to a specific virtual local area
network (VLAN). VLAN ID range is 1 to 4095.
none Optional. Specifies that output is limited to all VLANs.
Default Values
By default, all interfaces are displayed.
By default, all maintenance levels are displayed.
By default, all VLANs are displayed.
Command History

Functional Notes
Usage Examples
The following is sample output from the show ethernet cfm stack command:
>enable
#show ethernet cfm stack
0------------1--------------2-------------3-------------4-------------5-------------6-----------7-------------8
123456789012345678901234567890123456789012345678901234567890
------------------------------------------------------------------------------------------------------------------------
Interface Vlan Lvl Domain/Assoc
MEPID MAC
------------------------------------------------------------------------------------------------------------------------
eth 0/1 0 7 Domain_1/MA_1
1 00:A0:C8:16:96:0D
eth 0/2 20 5 Domain1/Assoc2
2012 00:0a:c8:00:01:03

show event-history
Use the show event-history command to display all entries in the current local event-history log.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The event history provides useful information regarding the status of the system and individual port states.
Use the event history as a troubleshooting tool when identifying system issues. The following is a sample
event-history log.
>enable
#show event-history
Using 526 bytes
2002.07.12 15:34:01 T1.t1 1/1 Yellow
2002.07.12 15:34:01 INTERFACE_STATUS.t1 1/1 changed state to down.
2002.07.12 15:34:02 T1.t1 1/1 No Alarms
2002.07.12 15:34:02 INTERFACE_STATUS.t1 1/1 changed state to up.
2002.07.12 15:34:03 INTERFACE_STATUS.eth 0/1 changed state to up.
2002.07.12 15:34:10 OPERATING_SYSTEM Warm Start
2002.07.12 15:34:12 PPP.NEGOTIATION LCP up
2002.07.12 15:34:12 PPP.NEGOTIATION IPCP up

show fan-tach
Use the show fan-tach command to view the unit’s current fan speed.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example shows the current fan speed:
>enable
#show fan-tach
Fan Tach (in rpm) Current Min Max Avg
Processor 8160 8100 17804 8544
Chassis 1 3060 3060 31380 4237
Chassis 2 3120 3060 31560 4277

show file
Use the show file command to display a specified file to the terminal screen. Variations of this command
include:
show file <filename>

show file <filename> checksum
show file cflash <filename>
show file cflash <filename> checksum
show file flash <filename>
show file flash <filename> checksum
show file ramdisk <filename>
show file ramdisk <filename> checksum
To display files located in the flash memory on products with CompactFlash® capability,
the flash keyword must be specified whether or not a CompactFlash card is installed.
Not all units are capable of using a RAM disk file system or have a CompactFlash card
installed. Use the show file ? command to display a list of valid commands at the enable
prompt.
The contents of the file are displayed only if the file is less than 300 Kilobytes.
The checksum is displayed only if the file is less than 500 Kilobytes.

Syntax Description
<filename> Displays information on the specified file. Wildcard entries (such as *.biz)
are not valid for the show file command.
cflash Specifies a file located in CompactFlash memory.
checksum Optional. Displays the message digest 5 (MD5) checksum of the specified
file.
flash Specifies a file located in flash memory.
ramdisk Specifies a file located in volatile RAM disk.
Default Values
Command History
Release 12.1 Command was expanded to include the cflash parameter.
include.
Usage Examples
The following is a sample show file cflash output:
>enable
#show file cflash startup-config
Router#show file startup-config
Using 2558 bytes
!
!
hostname “Router”
enable password password
!
clock timezone -6-Central-Time
!
ip subnet-zero
ip classless
ip routing
!
no auto-config
!
event-history on
no logging email
logging email priority-level info

!
no service password-encryption
!
username “admin” password “password”
!
--MORE--
The show file ramdisk command issues the following error message if the file is greater than 300
kilobytes:
>enable
#show file ramdisk NV3130A-17-07-00-26-AE.biz
%Cannot show files larger than 300000 bytes.
The following is sample show file ramdisk <filename> checksum output:
>enable
#show file ramdisk default-config.txt checksum
AA02EC815B93B0E41C738A71C6AFCBC4

show flash
Use the show flash command to display a list of all files currently stored in flash memory. Variations of
show flash
show flash <filename>
Syntax Description
<filename> Optional. Displays details for a specified file located in flash memory. Enter
a wildcard (such as *.biz) to display the details for all files matching the
entered pattern.
Default Values
Command History
include.
Usage Examples
The following is a sample show flash output:
>enable
#show flash
Files:
245669 010100boot.biz
1141553 new.biz
821 startup-config
1638 startup-config.old
1175679 020016.biz
821 startup-config.bak
2572304 bytes used 4129776 available 6702080 total

show frame-relay
Use the show frame-relay command to display configuration and status parameters for configured virtual
Frame Relay interfaces. Variations of this command include the following:
show frame-relay lmi

show frame-relay pvc
show frame-relay pvc interface frame-relay <interface>
show frame-relay pvc interface frame-relay <interface> realtime
show frame-relay pvc realtime
your unit.
Syntax Description
lmi Displays local management interface (LMI) statistics for each virtual
Frame Relay interface.
pvc Displays permanent virtual circuit (PVC) configuration and statistics
for all virtual Frame Relay interfaces (or a specified interface).
interface frame-relay <interface> Optional. Displays Frame Relay PVC statistics for a specific Frame
Relay interface (for example, fr 1).
realtime Optional. Displays full-screen output in real time. Refer to the
Functional Notes below for more information.
Default Values
Command History
Release 10.1 Realtime parameter was introduced.
Release 17.1 Command was expanded to include the modifiers begin, exclude,
and include.

Functional Notes
page 702).
Usage Examples
The following are sample outputs from various show frame-relay commands:
>enable
#show frame-relay lmi
LMI statistics for interface FR 1 LMI TYPE = ANSI
Num Status Enq. Sent 79 Num Status Msgs Rcvd 71
Num Update Status Rcvd 12 Num Status Timeouts 5
>enable
#show frame-relay pvc
Frame Relay Virtual Circuit Statistics for interface FR 1
Active Inactive Deleted Static
local 2 0 0 2
DLCI = 16 DLCI USAGE = LOCAL PVC STATUS = ACTIVE INTERFACE = FR 1.16
MTU: 1500
input pkts: 355 output pkts: 529 in bytes: 23013
out bytes: 115399 dropped pkts: 13 in FECN pkts: 0
in BECN pkts: 0 in DE pkts: 0 out DE pkts: 0
pvc create time: 00:00:00:12 last time pvc status changed: 00:00:13:18
DLCI = 20 DLCI USAGE = LOCAL PVC STATUS = ACTIVE INTERFACE = FR 1.20
MTU: 1500
input pkts: 0 output pkts: 44 in bytes: 0
out bytes: 22384 dropped pkts: 11 in FECN pkts: 0
in BECN pkts: 0 in DE pkts: 0 out DE pkts: 0
pvc create time: 00:00:01:25 last time pvc status changed: 00:00:13:18

show frame-relay fragment

Use the show frame-relay fragment command to display detailed fragmentation statistics for Frame
Relay subinterfaces with FRF.12 fragmentation enabled. Variations of this command include:
show frame-relay fragment

show frame-relay fragment interface frame-relay <subinterface>
Syntax Description
interface frame-relay <subinterface> Optional. Displays detailed fragmentation statistics for the specified
Frame Relay subinterface. Subinterfaces are expressed in the
format interface id.subinterface id (for example, fr 1.16).
Default Values
Command History
Release 17.1 Command was expanded to include the modifiers begin,
exclude, and include.
Usage Examples
The following are sample outputs from various show frame-relay fragment commands:
>enable
#show frame-relay fragment
interface dlci frag_size rx_frag tx_frag dropped_frag
fr 1.1 17 100 46 48 0
fr 1.2 18 200 42 21 0

>enable
#show frame-relay fragment frame-relay 1.1
DLCI = 17 FRAGMENT SIZE = 100
rx frag. pkts 46 tx frag. pkts 48
rx frag. bytes 4598 tx frag. bytes 4724
rx non-frag. pkts 18 tx non-frag. pkts 28
rx non-frag. bytes 1228 tx non-frag. bytes 1960
rx assembled pkts 23 tx pre-fragment pkts 34
rx assembled bytes 5478 tx pre-fragment bytes 6324
dropped reassembling pkts 0 dropped fragmenting pkts 0
rx out-of-sequence fragments 0
rx unexpected beginning fragment 0

show frame-relay multilink

Use the show frame-relay multilink command to display information associated with the Frame Relay
multilink interface. Variations of this command include:
show frame-relay multilink

show frame-relay multilink detailed
show frame-relay multilink <interface>
show frame-relay multilink <interface> detailed
show frame-relay multilink interface frame-relay <subinterface>
Syntax Description
<interface> Optional. Specifies the display of information for a specific
interface. Enter the show frame-relay multilink ? command for
a complete list of interfaces.
detailed Optional. Displays more detailed information.
interface frame-relay <subinterface> Optional. Displays detailed fragmentation statistics for the
specified Frame Relay subinterface. Subinterfaces are expressed
in the format interface id.subinterface id (for example, fr 1.16).
Default Values
Command History
Release 17.1 Command was expanded to include the modifiers begin,
Usage Examples
The following is a sample output from this command:
>enable
#show frame-relay multilink
Bundle: frame-relay 1 is DOWN; class A bundle
Near-end BID: MFR1; Far-end BID: unknown

show garp timer

Use the show garp timer command to display the current configured Generic Attribute Registration
Protocol (GARP) application timer values.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays the current configured GARP application timer values:
>enable
#show garp timer
Timer Timer Value (milliseconds)
-------- --------------------------
Join 200
Leave 600
LeaveAll 10000

show gvrp configuration

Use the show gvrp configuration command to show a GARP VLAN Registration Protocol (GVRP)
configuration summary for the switch.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays a GVRP configuration summary for the switch:
>enable
#show gvrp configuration
Global GVRP Configuration:
GVRP Feature is currently enabled globally.
GVRP Timers (milliseconds)
Join 200
Leave 600
LeaveAll 20000
Port based GVRP Configuration:
GVRP enabled ports
----------------------------------------------------
eth 0/24

show gvrp members vlan <vlan id>

Use the show gvrp members command to display GARP VLAN Registration Protocol (GVRP) GARP
information propagation members.
Syntax Description
vlan <vlan id> Specifies which VLAN’s members are displayed.
Default Values
Command History
Usage Examples
The following example displays sample output from this command:
>enable
#show gvrp members vlan 200
VLAN 200: Total Members 1

show gvrp state vlan <vlan id> interface <interface>

Use the show gvrp state command to display the GARP VLAN Registration Protocol (GVRP) state.
Syntax Description
vlan <vlan id> Specifies the VLAN to display.
interface <interface> Specifies the interface to display. Specify an interface in the format
id.subinterface id]>. For example, for a T1 interface, use t1 0/1; for an
Ethernet subinterface, use eth 0/1.1; for a PPP interface, use ppp 1; and
for an ATM subinterface, use atm 1.1. Type interface ? for a complete list
of valid interfaces.
Default Values
Command History
Usage Examples
The following example displays the state of VLAN 200 on switchport interface 0/2:
>enable
#show gvrp state vlan 200 interface switchport 0/2
Port swx 0/2:
Registrar: Empty, Forbidden
Applicant: Very Anxious, Observer

show gvrp statistics

Use the show gvrp statistics command to show statistics related to GARP VLAN Registration Protocol
(GVRP). Variations of this command include:
show gvrp statistics

show gvrp statistics interface <interface>
Syntax Description
interface <interface> Optional. Shows the information for the specified interface. Specify an
show gvrp statistics interface ? for a complete list of applicable
interfaces.
Default Values
Command History
include.
Usage Examples
The following example displays statistics related to GVRP for Ethernet interface 0/24:
>enable
#show gvrp statistics interface ethernet 0/24
Name: eth 0/24
Join Empty Received: 0
Join In Received: 272
Empty Received: 30
Leave Empty Received: 0
--MORE--

show hosts
Use the show hosts command to display information, such as the domain name, name lookup service, a list
of name server hosts, and the cached list of host names and addresses on the network to which you can
connect. Variations of this command include:
show hosts
show hosts verbose
show hosts vrf <name>
show hosts vrf <name> verbose
Syntax Description
forwarding (VRF).
Default Values
Command History
include.
Functional Notes
The list below describes the fields contained in the host table:
• Flags: Indicate whether the entry is permanent (perm) or temporary (temp).

• Age: Indicates the age of the entry.
• Type: Shows the protocol type as addresses (A) or service (SRV).
• Priority: 1 or 2.
• Address: Displays the IP address for the entry.

Usage Examples
The following example is sample output from the show hosts command:
>enable
#show hosts
Name/address lookup uses domain naming system
DNS Proxy is enabled
Default domain is DOMAIN.NET
Name servers are 10.100.43.254
Host Flags Age Type Priority Address/Alias
net-srv3.adtran.com temp 172798 A - 172.22.48.13
srv-dhcp1.adtran.com temp 172798 A - 172.22.48.47
srv-dhcp2.adtran.com temp 172798 A - 172.22.48.48
www.adtran.com temp 172798 A - 172.23.100.11

show hw-access-list
Use the show hw-access-list command to display hardware access control list (ACL) configuration and
statistics. Variations of this command include:
show hw-access-list
show hw-access-list <name>
Syntax Description
<name> Optional. Specifies a particular hardware ACL to display.
Default Values
Command History
Functional Notes
The show hw-access-list command displays all configured hardware ACLs in the system. All entries in
the ACL are displayed, and a counter indicating the number of frames matching the entry is listed.
Usage Examples
The following is a sample output from the show hw-access-list <name> command, using the hardware
ACL NET135:
>enable
#show hw-access-list NET135
Extended IP hardware access list NET135
permit ip 10.22.135.0 0.0.0.255 any log (302 matches)
permit ip any 10.22.135.0 0.0.0.255 log (279 matches)

The following is sample output from the show hw-access-list command which displays information for all
configured hardware ACLs:
>enable
#show hw-access-list
Extended IP hardware access list NET135
permit ip 10.22.135.0 0.0.0.255 any log (131 matches)
permit ip any 10.22.135.0 0.0.0.255 log (110 matches)
Extended MAC hardware access list ADTN
permit mac 00:a0:c8:00:00:00 00:00:00:ff:ff:ff any log (44055 matches)
permit mac any 00:a0:c8:00:00:00 00:00:00:ff:ff:ff log (3011 matches)

show hw-access-map
Use the show hw-access-map command to display hardware access map configuration and statistics.
show hw-access-map
show hw-access-map <name>
Syntax Description
<name> Optional. Displays only the statistics for the named hardware access map.
Default Values
Command History
Usage Examples
The following is sample output from the show hw-access-map <name> command, using the access map
HW-FILTER:
>enable
#show hw-access-map HW-FILTER
Hardware Access Map HW-FILTER
Forward: mac ADTN and ip NET135
VLANs: 2-3

show hw-filter-resource
Use the show hw-filter-resource command to display the used and available hardware filter resources.
This information is valuable when making changes to configured hardware access control lists (ACLs) and
hardware access maps. For more information on hardware ACLs and access maps, refer to the Hardware
ACL and Access Map Command Set on page 2491.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Changing hardware ACL or hardware access map configuration or application causes new information to
be reinstalled on the hardware. It is possible to run out of hardware resources depending on how many
resources are needed to apply the desired change. If there are not enough hardware resources to install
the new criteria, an error message is displayed.
Usage Examples
The following is sample output from the show hw-filter-resource command:
>enable
#show hw-filter-resource
Total Rules: 512
Rules Used: 128

show interfaces
Use the show interfaces command to display configuration parameters and current statistics for all
switchport interfaces (or a specified switchport interface). These commands are valid only on switchports.
show interfaces description

show interfaces status
show interfaces <interface> switchport
show interfaces <interface> switchport vlans
show interfaces gigabit-switchport <slot/port>
Syntax Description
description Displays information, such as description, administrative status, line
protocol status, and description for all the interfaces.
gigabit-switchport <slot/port> Displays information, such as description, administrative status, line
protocol status, Layer 3 switching statistics, and description for a specific
Gigabit Ethernet switchport.
<interface> Optional. Specifies a switchport interface in the format <interface type
[slot/port | slot/port.subinterface id | interface id | interface id.subinterface
id]>. For example, for a T1 interface, use t1 0/1; for an Ethernet
subinterface, use eth 0/1.1; for a PPP interface, use ppp 1; and for an
ATM subinterface, use atm 1.1. Type show switchport ? for a complete
list of valid interfaces.
status Displays information, such as description, type, status, virtual local area
network (VLAN), speed, and duplex for all the Ethernet interfaces only.
switchport Displays information, such as description, administrative status, line
protocol status, and description for all the switchports.
vlans Optional. Displays the VLAN membership information for a specific
switchport or series of switchports.
Default Values

Command History
Release 6.1 Command was expanded to include the switchport parameter.
Release 10.1 Command was expanded to include the vlans parameter.
Release 11.1 Description and status parameters were introduced.
include.
Release 17.5 Command was expanded to include the gigabit-switchport parameter.
Usage Examples
The following is sample output from the show interfaces description command:
>enable
#show interfaces description
Interface Status Protocol Description
eth 0/1 Admin Up Line Up Desk 1
eth 0/8 Admin Up Line Down Desk 8
giga-eth 0/1 Admin Up Line Up Uplink Trunk
giga-eth 0/2 Admin Up Line Down Unused

The following is sample output from the show interfaces gigabit-switchport command:
>enable
#show interfaces gigabit-switchport 0/1
giga-swx 0/21 is UP, line protocol is UP
Hardware address is 00:A0:C8:00:24:4F
RJ-45 Shielded
100Mb/s, negotiated full-duplex, configured full-duplex
ARP type: ARPA; ARP timeout is 20 minutes
5 minute input rate 6232 bits/sec, 10 packets/sec
5 minute output rate 344 bits/sec, 0 packets/sec
3432 packets input, 237372 bytes
6 unicasts, 1 broadcasts, 3067 multicasts input
0 unknown protocol, 2781 discards
0 input errors, 0 crc errors
358 packets output, 28552 bytes
7 unicasts, 0 broadcasts, 351 multicasts output
0 output errors, 0 deferred, 0 discards
0 single, 0 multiple, 0 late collisions
0 excessive collisions
L3 Switch
25 packets input, 25 packets forwarded
0 header errors, 0 discards
The following is sample output from the show interfaces switchport command:
>enable
#show interfaces switchport
Name: eth 0/1
Switchport: enabled
Administrative mode: access
Negotiation of Trunking: access
Access mode VLAN: 1
Trunking Native mode VLAN: 1
Trunking VLAN Enabled: 1-4094
Name: eth 0/2
Switchport: enabled
Administrative mode: access
Access mode VLAN: 12.....

show interfaces <interface>

Use the show interfaces command to display configuration parameters and current statistics for all
interfaces (or a specified interface). Variations of this command include the following:
show interfaces <interface>

show interfaces <interface> performance-statistics
show interfaces <interface> performance-statistics <x-y>
show interfaces <interface> performance-statistics total-24-hour
show interfaces <interface> realtime
show interfaces <interface> verbose
show interfaces <interface> version
Not all subcommands apply to all interfaces. Type show interfaces <interface> ? for a list
of valid subcommands for the specified interface.
your unit.
Syntax Description
dot11ap 1/1.1. Type show interfaces ? for a complete list of valid
interfaces.
performance-statistics Optional. Displays all 96 stored intervals.
<x-y> Optional. Shows a specified interval (x) or range of intervals (x-y).
total-24-hour Optional. Displays the current 24-hour totals.
verbose Optional. Displays detailed configuration information on the terminal screen

version Optional. Displays current version information (e.g., model and list number,
software version, etc.) for the interface.
Default Values
Command History
Release 6.1 Command was updated to include the performance-statistics parameter.
Release 10.1 The realtime parameter and primary rate interface (PRI) were added.
Release 11.1 Description, status, and verbose options were introduced. The demand,
foreign exchange office (FXO), and serial interfaces were added.
include.
Functional Notes
page 702).
Usage Examples
The following are samples from various show interfaces commands:
>enable
#show interfaces t1 1/1
t1 1/1 is UP
T1 coding is B8ZS framing is ESF
Clock source is line FDL type is ANSI
Line build-out is 0dB
No remote loopbacks No network loopbacks
DS0 Status: 123456789012345678901234
NNNNNNNNNNNNNNNNNNNNNNNN
Line Status: -- No Alarms --
Current Performance Statistics:
0 Errored Seconds 0 Bursty Errored Seconds
0 Severely Errored Seconds 0 Severely Errored Frame Seconds
0 Unavailable Seconds 0 Path Code Violations
0 Line Code Violations 0 Controlled Slip Seconds
0 Line Errored Seconds 0 Degraded Minutes

#show interfaces modem 1/2

modem 1/2 is UP
Line status: on-hook
Caller ID will be used to route incoming calls
0 packets input 0 bytes 0 no buffer
0 runts 0 giants 0 throttles
0 input errors 0 CRC 0 frame
0 abort 0 ignored 0 overruns
0 packets output 0 bytes 0 underruns
0 input clock glitches 0 output clock glitches
0 carrier lost 0 cts lost
#show interfaces eth 0/1

Ip address is 10.200.1.50
Netmask is 255.255.0.0
MTU is 1500
Fastcaching is Enabled
RIP Authentication is Disabled
RIP Tx uses global version value
RIP Rx uses global version value
#show interfaces dds 1/1

dds 1/1 is UP line protocol is UP
Encapsulation FRAME-RELAY (fr 1)
Loop rate is set to 56000 actual rate is 56000
Clock source is line
Data scrambling is disabled
No Loopbacks
#show interfaces fr 1
TDM group 10 line protocol is UP
Encapsulation FRAME-RELAY (fr 1)

Line Status: -- No Alarms --

Current Performance Statistics:
0 Errored Seconds 0 Bursty Errored Seconds
0 Severely Errored Seconds 0 Severely Errored Frame Seconds
0 Unavailable Seconds 0 Path Code Violations
0 Line Code Violations 0 Controlled Slip Seconds
0 Line Errored Seconds 0 Degraded Minutes
#show interfaces fr 1.100

fr 1.100 is Active
Ip address is 63.97.45.57, mask is 255.255.255.248
Interface-dlci is 100
MTU is 1500 bytes, BW is 96000 Kbit (limited)
Average utilization is 53%
#show interfaces shdsl 1/1

shdsl 1/1 is UP, line protocol is DOWN
Encapsulation FRAME-RELAY IETF (fr 1)
Equipment type is cpe
Line rate is 2056kbps
No alarms.
SHDSL training complete. EOC is up.
No local loopbacks, No remote loopbacks
SNR margin is 18dB currently, 15dB minimum, 30dB maximum
Loop attenuation is 1dB currently, 1dB minimum, 1dB maximum
Current 15-minute performance statistics (115 seconds elapsed):
0 code violations, 0 loss of sync word seconds
0 errored seconds, 0 severely errored seconds
0 unavailable seconds
Packet Statistics:
0 packets input, 0 bytes, 0 no buffer
0 runts, 0 giants, 0 throttles
0 input errors, 0 CRC, 0 frame
0 abort, 0 ignored, 0 overruns
32 packets output, 0 bytes, 0 underruns
0 input clock glitches, 0 output clock glitches
If the user has configured a Bc and Be value on the virtual circuit, the bandwidth (BW)
displayed is the sum of those values (Bc + Be). If not, the value for BW is the speed of the
interface. The Average utilization displayed is the average utilization of the displayed
bandwidth. If the bandwidth number is the Bc + Be value, the (limited) text appears (as
shown above).

show interfaces adsl <slot/port>

Use the show interfaces adsl command to display information related to the asymmetric digital subscriber
line (ADSL) port. Variations of this command include:
show interfaces adsl <slot/port>

show interfaces adsl <slot/port> information
show interfaces adsl <slot/port> information atuc
show interfaces adsl <slot/port> information atur
show interfaces adsl <slot/port> information bit-allocation
show interfaces adsl <slot/port> performance-statistics
show interfaces adsl <slot/port> performance-statistics <x-y>
show interfaces adsl <slot/port> performance-statistics total-24-hour
show interfaces adsl <slot/port> performance-statistics total-previous-24-hour
show interfaces adsl <slot/port> version
Syntax Description
<slot/port> Specifies ADSL interface slot and port number.
information Optional. Displays all ADSL interface information.
atuc Optional. Displays only ADSL remote information.
atur Optional. Displays only ADSL local information.
bit-allocation Optional. Displays only ADSL DMT bit-allocation table.
performance-statistics Optional. Displays all 96 stored intervals.
<x-y> Optional. Displays only a specified interval (x) or range of intervals (x-y).
total-24-hour Optional. Displays only the current 24-hour totals.
total-previous-24-hour Optional. Displays only the previous 24-hour totals.
version Optional. Displays current version information (e.g., model and list number,
software version, etc.) for the interface.
Default Values

Command History
include.
Usage Examples
The following example shows sample output for this command:
>enable
#show interfaces adsl 1/1 information
adsl 1/1 line information
adsl 1/1 Local Line Information
Vendor Id: 00000000
Serial Number: 00000000
Firmware Version:
ADSL Capabilities G.DMT, G.LITE, ADSL2, ADSL2+
adsl 0/1 Remote Line Information
Vendor Id: 00000000
Firmware Version: 0
ADSL Capabilities G.DMT, G.LITE, ADSL2, ADSL2+

show interfaces cellular

Use the show interfaces cellular command to display configuration parameters and current statistics for a
cellular interface. Variations of this command include the following:
show interfaces cellular <slot/port>

show interfaces cellular <slot/port> hardware
show interfaces cellular <slot/port> profile
show interfaces cellular <slot/port> realtime
show interfaces cellular <slot/port> version
Syntax Description
hardware Optional. Specifies cellular hardware information is displayed.
profile Optional. Specifies cellular profile information is displayed.
realtime Optional. Specifies display output is shown in real time.
version Optional. Specifies cellular version information is displayed.
Default Values
Command History
Usage Examples
The following example displays cellular hardware information for cellular interface 1/1:
>enable
#show interfaces cellular 1/1 hardware
Electronic Serial Number (ESN) : 0x12345678
Preferred Roaming List (PRL) Version : 12345
Mobile Directory Number (MDN) : 0123456789
Mobile Station ID (MSID) : 0123456789
System ID (SID) : 1234
Network ID (NID) : 12

show interfaces dot11ap

Use the show interfaces dot11ap command to display information related to a wireless access point (AP),
radio, or virtual access point (VAP) interface. Variations of this command include:
show interfaces dot11ap [<ap> | <ap/radio> | <ap/radio.vap>]

show interfaces dot11ap <ap> control-protocol
show interfaces dot11ap [<ap/radio> | <ap/radio.vap>] dot11
Syntax Description
<ap> Specifies the AP. Range is 1 to 8.
</radio> Specifies the radio associated with the AP. Range is 1 to 2.
<.vap> Specifies the VAP associated with the radio. Range is 1 to 8.
control-protocol Optional. Displays properties of the control protocol for the AP.
dot11 Optional. Displays counters of an 802.11 radio’s VAPs.
The radio must be specified in the format <ap/radio> (for example, 2/1 indicates radio 1
on access point 2). The virtual access point must be specified in the format
<ap/radio.vap> (for example, 2/1.1 indicates virtual access point 1 on radio 1 on access
point 2).
Default Values
Command History
include.

Usage Examples
The following example shows sample output for the AP interface 1 using the show interfaces dot11ap
command:
>enable
#show interfaces dot11ap 1
Dot11 AP 1 line protocol is UP
Controller Status: Local AC in control
Ap Version: FW: 1.0 0.4, DRVR: 1.0 0.0, HW: 1.0 0.0
Ap S/N: LBADTN0625XC975
AP MAC address: 00:A0:C8:1D:F8:57
Radio1 - 802.11bg - Enabled, channel 0, address: 00:A0:C8:1D:F8:59
Radio2 - 802.11a - Disabled, channel 0, address: 00:A0:C8:1D:F8:58
Bootup Status: Normal
Ap Status: With Session
Controlling AC: 00:A0:C8:20:E7:D6
802.1Q Encapsulation - Disabled
Auto 100Mbps, Full Duplex
Ethernet Statistics:
Ethernet Rx Packets: 291476
Ethernet Rx Bytes: 20908434
Ethernet Tx Packets: 67346
Ethernet Tx Bytes: 10606783
The following example shows sample output for the AP interface 1 using the show interfaces dot11ap
<ap> control-protocol command:
>enable
#show interfaces dot11ap 1 control-protocol
AP State: Running with session
Control State: Controlled by this AC
Control Protocol Transmit Bytes: 4080386
Control Protocol Receive Bytes: 9435172
Control Protocol Transmit Packets: 52203
Control Protocol Receive Packets: 65931
Control Protocol Receive Keepalives: 14914
Control Protocol Receive Security Errors: 0
Control Protocol Dropped Packets: 0
Control Protocol Protocol Errors: 0
Control Protocol Protocol No Responses: 0

The following example shows sample output for the radio interface 1 on AP interface 1 using the show
interfaces dot11ap <ap/radio> dot11 command:
>enable
#show interfaces dot11ap 1/1 dot11
Authentication Count: 17
Deauthentication Count: 48
Association Count: 18
Disassociation Count: 12
Reassociation Count: 0
Wireless MSDU Rx Packets: 346
Wireless Data Rx Packets: 7221
Wireless Multicast Rx Packets: 308
Wireless Management Rx Packets: 667521
Wireless Control Rx Packets: 0
Wireless MSDU Tx Packets: 236613
Wireless Data Tx Packets: 236210
Wireless Multicast Tx Packets: 236166
Wireless Management Tx Packets: 599
Wireless Control Tx Packets: 0

show ip access-lists
Use the show ip access-lists command to display all configured IP access control lists (ACLs) in the
system. Variations of this command include:
show ip access-lists <name>
Syntax Description
<name> Optional. Specifies a particular ACL to display.
Default Values
Command History
include.
Functional Notes
The show ip access-lists command displays all configured IP access control lists in the system. All
entries in the ACL are displayed, and a counter indicating the number of packets matching the entry is
listed.
Usage Examples
The following is a sample output from the show ip access-lists command:
>enable
#show ip access-lists
Standard IP access list MatchAll
permit host 10.3.50.6 (0 matches)
permit 10.200.5.0 wildcard bits 0.0.0.255 (0 matches)
Extended IP access list UnTrusted
deny icmp 10.5.60.0 wildcard bits 0.0.0.255 any source-quench (0 matches)
deny tcp any any (0 matches)

show ip arp
Use the show ip arp command to display the Address Resolution Protocol (ARP) table. Variations of this
command include:
show ip arp
show ip arp realtime
show ip arp vrf <name>
show ip arp vrf <name> realtime
Using the realtime argument for this command can adversely affect the performance or
your unit.
Syntax Description
forwarding (VRF).
Default Values
Command History
include.

Functional Notes
page 702).
Usage Examples
The following is a sample output of the show ip arp command:
>enable
#show ip arp
ADDRESS TTL(min) MAC ADDRESS INTERFACE TYPE
10.22.18.3 19 00:E0:29:6C:BA:31 eth 0/1 Dynamic
192.168.20.2 16 00:A0:C8:0D:E9:AD eth 0/2 Dynamic
224.0.0.5 20 01:00:5E:00:00:05 eth 0/2 Permanent

show ip as-path-list
Use the show ip as-path-list command to display any AS path lists that have been configured in the router,
along with any permit and deny clauses in each list. Variations of this command include:
show ip as-path-list
show ip as-path-list <name>
Syntax Description
<name> Optional. Specifies that the command display only the list matching the
specified AS path list name. If not specified, all AS path lists are displayed.
Default Values
By default, this command displays all AS path lists.
Command History
include.
Usage Examples
In the following example, all AS path lists defined in the router are displayed.
>enable
#show ip as-path-list
ip as-path-list AsPathList1:
permit 100
permit 200
permit 300
deny 6500
permit 400
permit 500

In the following example, only the AS Path List with the name AsPathList2 is displayed.
>enable
#show ip as-path-list AsPathList2
permit 400
permit 500

show ip bgp
Use the show ip bgp command to display details about the specified route, including the advertising router
IP address, router ID, and the list of neighbors to which this route is being advertised. Variations of this
command include:
show ip bgp
show ip bgp <ip address>
show ip bgp <ip address> <subnet mask>
show ip bgp summary
Syntax Description
<ip address> Optional. Specifies a valid IP address. IP addresses should be expressed in
<subnet mask> Optional. Specifies the subnet mask that corresponds to a range of IP
addresses (network) or a specific host. Subnet masks can be expressed in
dotted decimal notation (for example, 255.255.255.0) or as a prefix length
(for example, /24).
summary Optional. Displays a summary of the Border Gateway Protocol (BGP) route
table.
Default Values
Command History
include.

Usage Examples
The following example shows detailed output of this command:
>enable
#show ip bgp 10.15.240.0/28
BGP routing table entry for 10.15.240.0/28
Paths: (1 available, best #1)
Advertised to peers:
1.1.5.10
100 1
10.15.43.17 from 10.15.43.17 (8.1.1.1)
Origin IGP, metric 2, valid, external, best
The following sample output of the show ip bgp summary command shows a summarized list of the
configured BGP neighbors, as well as their status and statistics.
>enable
#show ip bgp summary
BGP router identifier 192.168.3.1, local AS number 304
8 network entries, 5 paths, and 23 BGP path attribute entries
Neighbor V AS MsgRcvd MsgSent InQ OutQ Up/Down State/PfxRcd
10.22.131.1 4 302 95 104 0 0 01:30:06 9
10.22.131.9 4 302 97 105 0 0 01:30:07 21
10.22.132.9 4 303 200 179 0 0 02:43:09 21
10.22.134.1 4 304 166 178 0 0 02:43:15 3
10.22.134.10 4 304 174 179 0 0 02:43:24 7
10.22.134.26 4 304 172 174 0 0 02:41:43 10
10.22.134.34 4 304 164 174 0 0 02:41:40 4

show ip bgp community

Use the show ip bgp community command to display only those routes learned via Border Gateway
Protocol (BGP) that match the community numbers specified in the command. If no communities are
specified, all BGP routes are shown. Variations of this command include:
show ip bgp community

show ip bgp community <number>
show ip bgp community <number> exact
show ip bgp community internet
show ip bgp community internet exact
show ip bgp community local-as
show ip bgp community local-as exact
show ip bgp community no-advertise
show ip bgp community no-advertise exact
show ip bgp community no-export
show ip bgp community no-export exact
Syntax Description
<number> Optional. Displays routes that contain this value in their community
attribute. This is a numeric value that can be an integer from 1 to
4294967295 or string in the form aa:nn, where the value of aa is the
autonomous system (AS) number and the value of nn is the community
number. Multiple community-number parameters can be present in the
command.
exact Optional. Displays BGP routes with the community numbers specified and
only those specified.
internet Optional. Displays routes that contain this value in their community
attribute. This represents the well-known reserved community number for
the INTERNET community.
local-as Optional. Displays routes that contain this value in their community
attribute. This represents the well-known reserved community number for
NO_EXPORT_SUBCONFED. Routes containing this attribute should not
be advertised to external BGP peers.

no-advertise Optional. Displays routes containing this value in the community attribute.
This represents the well-known reserved community number for
NO_ADVERTISE. Routes containing this attribute should not be advertised
to any BGP peer.
no-export Optional. Displays routes containing this value in the community attribute.
This represents the well-known reserved community number for
NO_EXPORT. Routes containing this attribute should not be advertised to
BGP peers outside a confederation boundary.
Default Values
By default, this command displays all BGP routes.
Command History
include.
Usage Examples
In the following example, all BGP routes are displayed whose community numbers match those listed in
the show ip bgp community command.
>enable
#show ip bgp community local-as 10:405
BGP local router ID is 10.22.131.241, local AS is 302.
Status codes: * valid, > best, i - internal, o - local
Origin codes: i - IGP, e - EGP, ? - incomplete
Network Next Hop Metric LocPrf Path
10.22.152.20/30 10.22.131.10 304 302 300 1 3 4 i
10.22.152.24/29 10.22.131.10 304 302 300 1 3 4 5 i
10.22.152.36/30 10.22.131.10 304 302 300 1 3 4 i
10.22.152.52/30 10.22.131.10 304 302 300 1 3 4 i
11.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
12.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
13.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
14.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
Total RIB entries = 8
Information displayed includes: the ID of this router and its autonomous system (AS) number; the
destination Network address of the route learned; the Next-Hop address to that network; the Metric; the
Local Preference (LocPrf) value (set using the set local-preference command); and the AS Path to the
destination network.

The following is a sample output for the show ip bgp community command with an exact match
specified: BGP routes with the community numbers specified and only those specified are shown.
>enable
#show ip bgp community 1001 2001 3001 exact
Network NextHop Metric LocPrf Path
* 192.168.11.0/24 10.22.27.251 249 251 i
* 192.168.12.0/24 10.22.27.251 249 251 i
*> 192.168.32.0/24 10.22.27.249 249 i
*> 192.168.33.0/24 10.22.27.249 249 i

show ip bgp community-list

Use the show ip bgp community-list command to display Border Gateway Protocol (BGP) routes that are
permitted by the specified community list. Variations of this command include:
show ip bgp community-list <name>

show ip bgp community-list <name> exact
Syntax Description
<name> Specifies the name of the community list whose routes you wish to display.
exact Optional. Restricts the routes displayed to only those whose community lists
exactly match those specified in the named community list. If this parameter
is omitted, all routes matching any part of the specified community list will
be displayed.
Default Values
Command History
include.
Functional Notes
Information displayed includes the ID of this router and its autonomous system (AS) number, the
destination Network address of the route learned, the Next-Hop address to that network, the Metric, the
Local Preference (LocPrf) value (set using the set local-preference * command), and the AS Path to the
destination network.

Usage Examples
In the following example, all BGP routes are displayed whose community numbers match those defined in
the community list named CList1.
>enable
#show ip bgp community-list CList1
Network Next Hop Metric LocPrf Path
10.22.152.20/30 10.22.131.10 304 302 300 1 3 4 i
10.22.152.24/29 10.22.131.10 304 302 300 1 3 4 5 i
10.22.152.36/30 10.22.131.10 304 302 300 1 3 4 i
10.22.152.52/30 10.22.131.10 304 302 300 1 3 4 i
11.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
12.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
13.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
14.0.0.0/30 10.22.131.10 304 302 300 1 3 4 6 i
20.0.0.0/30 10.22.131.10 304 302 300 1 3 4 5 i
21.0.0.0/30 10.22.131.10 304 302 300 1 3 4 5 i

show ip bgp neighbors <ip address>

Use the show ip bgp neighbors command to display information for the specified Border Gateway
Protocol (BGP) neighbor. Variations of this command include the following:
show ip bgp neighbors

show ip bgp neighbors <ip address>
show ip bgp neighbors <ip address> advertised-routes
show ip bgp neighbors <ip address> received-routes
show ip bgp neighbors <ip address> routes
Syntax Description
<ip address> Optional. Displays information for the specified neighbor. IP addresses
If no IP address is entered, information for all neighbors is displayed.
advertised-routes Optional. Displays all routes being advertised to the specified neighbor.
Command output is the same as for show ip bgp except filtered to only the
BGP routes being advertised to the specified neighbor.
received-routes Optional. Displays all routes (accepted and rejected) advertised by the
specified neighbor. Routes may be rejected by inbound filters, such as
prefix list filters.
routes Optional. Displays all accepted received routes advertised by the specified
neighbor. Routes displayed have passed inbound filtering. This command
output is the same as show ip bgp except the output is filtered to those
learned from the specified neighbor.
Default Values
Command History
include.
Functional Notes
Entries that are not filtered by prefix lists are marked with an asterisk (*) to show they are valid. Entries that
are deemed the best path to advertised route are marked with a caret (>).

Usage Examples
The following are output variations of the show ip bgp neighbors command:
>enable
#show ip bgp neighbors
BGP neighbor is 10.15.43.17, remote AS 100, external link
Configured hold time is 180, keepalive interval is 60 seconds
Default minimum time between advertisement runs is 30 seconds
Connections established 6; dropped 5
Last reset: Interface went down
Connection ID: 15
BGP version 4, remote router ID 8.1.1.1
BGP state is Established, for 01:55:05
Negotiated hold time is 180, keepalive interval is 60 seconds
Message statistics:
InQ depth is 0, OutQ depth is 0
Local host: 10.15.43.18, Local port: 179
Sent Rcvd
Opens:1 1
Notifications: 0 0
Updates: 0 8
Keepalives: 116 116
Unknown: 0 0
Total: 117 125
Foreign host: 10.15.43.17, foreign port: 1048
Flags: passive open
#show ip bgp neighbors 10.15.43.34 advertised-routes

Status codes: * valid, > best, i - internal
Network NextHop Metric Path

*> 1.0.0.0/8 10.15.43.17 1 100 i
*> 2.0.0.0/9 10.15.43.17 1 100 i
#show ip bgp neighbors 10.15.43.17 received-routes


*> 1.0.0.0/8 10.15.43.17 1 100 i
*> 2.0.0.0/9 10.15.43.17 1 100 i

#show ip bgp neighbors 10.15.43.17 routes


*> 1.0.0.0/8 10.15.43.17 1 100 i
*> 2.0.0.0/9 10.15.43.17 1 100

show ip bgp regexp <expression>

Use the show ip bgp regexp command to display a summary of the Border Gateway Protocol (BGP) route
table that includes routes whose autonomous system (AS) path matches the specified expression.
Syntax Description
<expression> Displays routes whose AS path matches the regular expression specified.
Default Values
Command History
include.
Functional Notes
Entries that are not filtered by prefix lists are marked with an asterisk (*) to show they are valid. Entries that
are deemed the best path to advertised route are marked with a caret (>).
Usage Examples
The following sample output of the show ip bgp regexp _303_ command shows all of the entries in the
BGP database that contain “303” in the AS path.
>enable
#show ip bgp regexp _303_
Network NextHop Metric LocPrf Path
10.22.130.8/29 10.22.132.9 303 304 302 i
* i10.22.130.240/28 0.22.132.1 100 303 300 i
* 10.22.130.240/28 10.22.132.9 303 300 i
10.22.131.0/29 10.22.132.9 303 304 302 i
10.22.131.8/29 10.22.132.9 303 304 302 i
* i10.22.131.16/29 10.22.132.1 0 100 303 i

* 10.22.131.16/29 10.22.132.9 0 303 i

* i10.22.131.240/28 10.22.132.1 100 303 300 i
* 10.22.131.240/28 10.22.132.9 303 300 i
* 10.22.132.0/29 10.22.131.1 0 302 303 i
* 10.22.132.0/29 10.22.131.9 0 302 303 i
* i10.22.132.0/29 10.22.132.1 0 100 303 i
*> 10.22.132.0/29 10.22.132.9 0 303 i
* 10.22.132.8/29 10.22.131.1 0 302 303 i
* 10.22.132.8/29 10.22.131.9 0 302 303 i
* 10.22.132.8/29 10.22.132.9 0 303 i
* i10.22.132.240/28 10.22.132.1 0 100 303 i
*> 10.22.132.240/28 10.22.132.9 0 303 i
10.22.134.0/29 10.22.132.9 303 304 i
10.22.134.8/29 10.22.132.9 303 304 i
10.22.134.16/29 10.22.132.9 303 304 i
10.22.134.24/29 10.22.132.9 303 304 i
10.22.134.32/29 10.22.132.9 303 304 i
10.22.134.40/29 10.22.132.9 303 304 i
10.22.134.48/29 10.22.132.9 303 304 i
10.22.134.56/29 10.22.132.9 303 304 i
10.22.134.64/29 10.22.132.9 303 304 i
10.22.134.80/29 10.22.132.9 303 304 i
10.22.135.0/29 10.22.132.9 303 304 305 i
10.22.135.8/29 10.22.132.9 303 304 305 i

show ip cache
Use the show ip cache command to display the fast cache table. Variations of this command include the
following:
show ip cache
show ip cache vrf <name>
Syntax Description
vrf <name> Optional. Displays information for only the specified VPN routing and
forwarding (VRF).
Default Values
Command History
include.
Functional Notes

Usage Examples
The following example shows sample output from the show ip cache command for the default VRF
(router):
>enable
#show ip cache
DESTINATION INTERFACE NEXT HOP USE COUNT MAC ADDRESS
224.0.0.5 Loopback 127.0.0.1 0
10.22.18.3 eth 0/1 10.22.18.3 0 00:E0:29:6C:BA:31
10.22.18.6 Loopback 127.0.0.1 18
192.168.30.2 eth 0/2 192.168.20.2 0 00:A0:C8:0D:E9:AD
10.22.18.255 Loopback 127.0.0.1 2
255.255.255.255 Loopback 127.0.0.1 2
192.168.20.1 Loopback 127.0.0.1 25
IP routing cache 7 entries

show ip community-list
Use the show ip community-list command to display any or all defined community lists in the router
configuration. Variations of this command include:
show ip community-list
show ip community-list <name>
Syntax Description
<name> Optional. Specifies the name of the community list you wish to display. If this
parameter is omitted, all defined community lists will be displayed.
Default Values
Command History
include.
Usage Examples
The following example shows two community lists, one of which permits all routes containing community
number 10:67, and another which permits routes containing community number 10:68 and the Internet
community number, but denies routes containing community number 10:45.
>enable
#show ip community-list
ip community-list CommList1:
permit 10:67
ip community-list CommList2:
permit 10:68 internet
deny 10:45

show ip dhcp-client lease

Use the show ip dhcp-client lease command to display all Dynamic Host Client Protocol (DHCP) lease
information for interfaces that have dynamically assigned IP addresses. Variations of this command
include:
show ip dhcp-client lease

show ip dhcp-client lease <interface>
Syntax Description
<interface> Optional. Displays the information for the specified interface type. Specify an
show ip dhcp-client lease ? for a complete list of applicable interfaces.
Default Values
Command History
include.
Usage Examples
The following is a sample output from the show ip dhcp-client lease command:
>enable
#show ip dhcp-client lease
Interface: ethernet 0/1
Temp IP address: 10.100.23.64 Mask: 0.0.0.0
DHCP Lease server: 10.100.23.207 State: Bound (3)
Lease: 120 seconds
Temp default gateway address: 0.0.0.0
Client-ID: N/A

show ip dhcp-server binding

Use the show ip dhcp-server binding command to display the Dynamic Host Client Protocol (DHCP)
server client table with associated information. Variations of this command include:
show ip dhcp-server binding

show ip dhcp-server binding <ip address>
show ip dhcp-server binding vrf <name>
show ip dhcp-server binding vrf <name> <ip address>
Syntax Description
<ip address> Optional. Specifies the IP address of the specified client. IP addresses
forwarding (VRF). If a VRF is not specified, the default VRF is assumed.
Default Values
Command History
Release 17.1 Command was expanded to include the vrf parameter and the modifiers
begin, exclude, and include.
Functional Notes

Usage Examples
The following is a sample output from the show ip dhcp-server binding command:
>enable
#show ip dhcp-server binding
IP Address Client Id Lease Expiration Client Name
10.100.23.64 01:00:a0:c8:00:8f:b3 Aug 15 2002 11:02 AM Router
The following example shows sample output from the show ip dhcp-server binding Gray command:
>enable
#show ip dhcp-server binding vrf Gray
IP Address Client Id Lease Expiration Client Name
192.168.19.2 01:00:e0:29:91:1e:27 Oct 16 2007 10:58 AM Estclair4
192.168.19.3 01:00:e0:81:01:53:01 Oct 16 2007 12:42 PM sylvester
192.168.19.4 01:00:15:c5:6a:69:ec Oct 16 2007 1:35 PM Dell-Wifi06

show ip ffe
Use the show ip ffe command to display current RapidRoute Engine entries. Variations of this command
include:
show ip ffe
show ip ffe destination <ip address>
show ip ffe destination-port <port>
show ip ffe details
show ip ffe egress <interface>
show ip ffe egress ipsec <rapidroute interface ID>
show ip ffe icmp-type <type>
show ip ffe ingress <interface>
show ip ffe ingress ipsec <rapidroute interface ID>
show ip ffe protocol <protocol>
show ip ffe source <ip address>
show ip ffe source-port <port>
show ip ffe type <type>
Syntax Description
destination <ip address> Optional. Filters output by a destination IP address. IP
addresses should be expressed in dotted decimal notation (for
example, 10.10.10.1).
destination-port <port> Optional. Filters output by destination Transmission Control
Protocol (TCP) or User Datagram Protocol (UDP) port. Ports
range from 0 to 65535.
details Optional. Displays detailed information. Refer to the Functional
Notes for more information about using the details keyword.
egress <interface> Optional. Displays RapidRoute entries for an egress interface.
slot/port.subinterface id | interface id | interface id.subinterface
subinterface, use eth 0/1.1; for a PPP interface, use ppp 1; for
an ATM subinterface, use atm 1.1. Type show ip ffe egress ?
for a complete list of valid interfaces.

egress ipsec <rapidroute interface ID> Optional. Displays RapidRoute entries that come from an
Internet Protocol security (IPsec) security association (SA) on a
specified RapidRoute interface. RapidRoute interface
identifiers range from 1 to 16777215.
icmp-type <type> Optional. Displays RapidRoute entries using a specific Internet
Control Message Protocol (ICMP) type. There are three types
of ICMP to choose from:
echo Displays ICMP echo RapidRoute entries.
reply Displays ICMP reply RapidRoute entries.
0 to 255 Displays other ICMP types.
ingress <interface> Optional. Displays RapidRoute entries for an ingress interface.
subinterface, use eth 0/1.1; for a PPP interface, use ppp 1; for
an ATM subinterface, use atm 1.1. Type show ip ffe ingress ?
ingress ipsec <rapidroute interface ID> Optional. Displays RapidRoute entries that go to an IPsec SA
on a specified RapidRoute interface. RapidRoute interface
identifiers range from 1 to 16777215.
protocol <protocol> Optional. Displays RapidRoute entries that use a specified
protocol. Protocols can be specified by selecting one of the
following:
ah Displays Authentication Header (AH) Protocol
RapidRoute entries.
esp Displays Encapsulating Security Payload (ESP)
Protocol RapidRoute entries.
gre Displays Generic Route Encapsulation (GRE)
Protocol RapidRoute entries.
icmp Displays ICMP RapidRoute entries.
tcp Displays TCP RapidRoute entries.
udp Displays UDP RapidRoute entries.
0 to 255 Displays other protocol types.
source <ip address> Optional. Displays RapidRoute entries for a specified source IP
address. IP addresses should be expressed in decimal dotted
source-port <port> Optional. Displays RapidRoute entries for a specified TCP or
UDP source port. Ports range from 0 to 65535.
type <type> Optional. Displays RapidRoute entries of a specific type.
Specified types include one of the following:
ineligible Displays only ineligible RapidRoute entries.
rejected Displays only rejected RapidRoute entries.
valid Displays only valid RapidRoute entries.

Default Values
Command History
include.
Release 17.6 Command was expanded to include the ipsec and gre parameters.
Functional Notes
The show ip ffe command can be further filtered by adding any combination of the following parameters:
destination <ip address>

destination-port <port>
details
egress <interface>
egress ipsec <rapidroute interface ID>
icmp-type <type>
ingress <interface>
ingress ipsec <rapidroute interface ID>
protocol <protocol>
source <ip address>
source-port <port>
type <type>
For example, the destination <ip address> and source <ip address> parameters can be used in
conjunction with one another. In this case, the command would look like this:
#show ip ffe destination 10.10.10.3 source 10.10.10.1

These parameters can be combined in any order, and as many times as is necessary to get the desired
output.
The detail keyword must be the last keyword in the command. For example, show ip ffe
destination <ip address> egress <interface> source-port <port> details is acceptable,
but show ip ffe destination <ip address> details egress <interface> is not.

Usage Examples
The following is a sample output from the show ip ffe command:
>enable
#show ip ffe
Timeout TCP UDP ICMP AH ESP GRE Other
Age: 30m0s 30m0s 30m0s 30m0s 30m0s 30m0s 30m0s
Inactive: 15s 15s 15s 15s 15s 15s 15s
Type: * valid, ! ineligible, - rejected
Flags: F firewall, N NAT, T altered ToS, D don't fragment, I IPsec
--------------------------------
Ingress: eth 0/1
149 hits, 62553 misses, 0 drops
T Proto Source Destination Specific Age Used Drops Flags
! udp 10.200.2.7 10.200.205.255 3959 137 17s 10 0
! udp 10.200.201.170 10.200.255.255 138 138 16s 0 0
! udp 10.200.7.200 10.200.255.255 138 138 16s 0 0
! udp 10.200.201.198 10.200.255.255 138 138 4s 0 0
! udp 10.200.201.198 10.200.255.255 137 137 7s 2 0
! tcp 172.22.77.208 10.200.1.134 2668 23 6s 36 0
Number of entries: 6 of 6 (4096 maximum)
--------------------------------
Total number of entries: 6 of 6 (16384 maximum)
The following is sample output from the show ip ffe details command:
Timeout TCP UDP ICMP AH ESP GRE Other

Age: 30m0s 30m0s 30m0s 30m0s 30m0s 30m0s 30m0s
Inactive: 15s 15s 15s 15s 15s 15s 15s
Type: * valid, ! ineligible, - rejected
Flags: F firewall, N NAT, T altered ToS, D don't fragment, I IPsec
--------------------------------
Ingress: eth 0/1
* icmp 10.0.1.2 10.0.2.2 echo 13 13s 129 0 I
egress: Outbound ESP SA 2
--------------------------------
Ingress: Inbound ESP SA 1
* icmp 10.0.2.2 10.0.1.2 reply 13 13s 129 0 I
egress: eth 0/1 (10.0.1.2)

--------------------------------
Ingress: Outbound ESP SA 2
* esp 3.3.3.1 3.3.3.2 0x923dbab4 13s 129 0 I
egress: hdlc 1
--------------------------------
Total number of entries: 3 of 3 (16384 maximum)

show ip ffe summary

Use the show ip ffe summary command to display a summary of all the current RapidRoute Engine
entries.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample output from the show ip ffe summary command:
>enable
#show ip ffe summary
Ingress MaxEntries Entries Hits Misses Drops
eth 0/1 4096 1 0 56 0
global 16384 1 0 56 0

show ip flow
Use the show ip flow command to display information regarding the configuration of integrated traffic
monitoring (ITM) on your AOS product. Variations of this command include:
show ip flow cache

show ip flow export
show ip flow interface
Syntax Description
cache Displays a summary of the current state of the cache of nonexpired traffic
flows.
export Displays information on export packets sent to a destination.
interface Displays the ITM configuration of each interface on the router.
Default Values
Command History
include.
Usage Examples
The following example is sample output from the show ip flow export command:
#show ip flow export
Traffic Flow export is ENABLED

Version: 9
Export Destinations
10.22.16.132: 9991
vrf BLUE
source ppp 1
10.5.22.203: 30000
11 flows exported in 8 udp datagrams
0 flows failed to export

The following is sample output from the show ip flow cache command:
#show ip flow cache

IP Traffic Flow Cache
Size: 682/4096 entries
8206 total entries added
95545 aging polls, last aging poll occurred 3 seconds ago
The following is sample output from an AOS product with an Ethernet interface and a point-to-point
interface configured for ITM:
#show ip flow interface

eth 0/1
ip flow ingress
ppp 1
ip flow ingress
ip flow egress

show ip flow top-talkers

Use the show ip flow top-talkers command to view information pertinent to integrated traffic monitoring
(ITM) Top Talker configuration and to reveal possible configuration problems. Variations of this
command include:
show ip flow top-talkers

show ip flow top-talkers day
show ip flow top-talkers hour
show ip flow top-talkers day detail
show ip flow top-talkers hour detail
show ip flow top-talkers port
show ip flow top-talkers port detail
output with the specified text and all lines after.
Syntax Description
day Optional. Specifies the display of Top Talker data for the current 24-hour
period.
hour Optional. Specifies the display of Top Talker data for the current hour.
port Optional. Specifies the display of Top Talker monitored port traffic for the
current interval.
detail Optional. Specifies the display of information for previous and current
intervals.
Default Values
Command History

Usage Examples
The following is sample output from the show ip flow top-talkers command:
#show ip flow top-talkers
Current Interval Top Talkers:

1:00 PM to 1:15 PM
Top Traffic Sources: Top Traffic Destinations:

IP Address Packets IP Address Packets
10.100.43.254 1451 10.22.162.3 735
10.100.43.161 860 10.22.166.222 707
10.22.160.253 384 10.22.160.7 407
10.100.43.200 292 224.0.0.6 393
10.22.165.17 222 10.22.130.6 391
Top 5 talkers shown. 742 flows processed.

show ip igmp groups

Use the show ip igmp groups command to display the multicast groups that have been registered by
directly connected receivers using Internet Group Management Protocol (IGMP). If no multicast group IP
address is specified, all groups are shown with this command. Variations of this command include:
show ip igmp groups

show ip igmp groups <multicast address>
Syntax Description
<multicast address> Optional. Displays the IP address of a multicast group. The multicast group IP
address range is 244.0.0.0 to 239.255.255.255 or 224.0.0.0 /4.
Default Values
Command History
include.
Usage Examples
>enable
#show ip igmp groups
IGMP Connected Group Membership
Group Address Interface Uptime Expires Last Reported
172.0.1.50 Loopback100 00:42:57 00:02:50 172.23.23.1
172.1.1.1 Ethernet0/1 00:05:26 00:02:51 1.1.1.2
172.1.1.1 Loopback100 00:42:57 00:02:51 172.23.23.1

show ip igmp interface

Use the show ip igmp interface command to display multicast-related information per-interface. If no
interface is specified, this command shows information for all interfaces. Variations of this command
include:
show ip igmp interface

show ip igmp interface <interface>
Syntax Description
<interface> Optional. Displays information for a specific interface type. Specify an
atm 1.1; and for a wireless virtual access point, use dot11ap 1/1.1. Enter
the show ip igmp interface ? command for a complete list of interfaces.
Default Values
Command History
include.

Usage Examples
The following example is sample output from the show ip igmp interface command:
>enable
#show ip igmp interface
eth 0/1 is UP
Ip Address is 10.22.120.47, netmask is 255.255.255.0
IGMP is enabled on interface
Current IGMP version is 2
IGMP query interval is 60 seconds
IGMP querier timeout is 120 seconds
IGMP max query response time is 10 seconds
Last member query count is 2
Last member query response interval is 1000 ms
IGMP activity: 548 joins, 0 leaves
IGMP querying router is 0.0.0.0
IGMP helper address is disabled

show ip igmp snooping

Use the show ip igmp snooping command to display Internet Group Management Protocol (IGMP)
snooping information. Variations of this command include:
show ip igmp snooping

show ip igmp snooping mrouter
show ip igmp snooping mrouter vlan <vlan id>
show ip igmp snooping vlan
show ip igmp snooping vlan <vlan id>
Global IGMP snooping overrides the virtual local area network (VLAN) IGMP snooping.
If global snooping is disabled, you cannot enable VLAN IGMP snooping. If global
snooping is enabled, you can enable or disable VLAN IGMP snooping. Refer to ip igmp
snooping on page 876 for more information.
Syntax Description
mrouter Optional. Displays the ports associated with multicast routers.
vlan Optional. Displays whether IGMP snooping is enabled or disabled for all
VLANs.
vlan <vlan id> Optional. Displays whether IGMP snooping is enabled or disabled for a
particular VLAN.
Default Values
Command History
include.

Usage Examples
The following is sample output from the ip igmp snooping vlan command:
>enable
#show ip igmp snooping vlan 1
Vlan 1: IGMP snooping is enabled on this VLAN
The following is sample output from the ip igmp snooping mrouter vlan command:
>enable
#show ip igmp snooping mrouter vlan 200
VLAN Ports
-----------------+ ----------------------------------
200 Gi0/2(static)

show ip interfaces
Use the show ip interfaces command to display the status information for all IP interfaces (or a specific
interface). Variations of this command include:
show ip interfaces
show ip interfaces <interface>
show ip interfaces <interface> brief
To view secondary IP addresses, use the show running-config command.
Syntax Description
<interface> Optional. Displays status information for a specific interface. Specify an
show ip interfaces ? for a complete list of applicable interfaces. If no
interface is specified, status information for all interfaces is displayed.
brief Optional. Displays an abbreviated version of interface statistics for all IP
interfaces.
Default Values
Command History
Release 11.1 Demand interface was added.
include.

Usage Examples
The following is a sample output of the show ip interfaces command:
>enable
#show ip interfaces
eth 0/1 is UP, line protocol is UP
Ip address is 10.10.10.1
Netmask is 255.255.255.0
MTU is 1500
Fastcaching is Enabled
RIP Authentication is Disabled
RIP Tx uses global version value

show ip local policy

Use the show ip local policy command to display information about the route-map used for local
policy-based routing. Variations of this command include the following:
show ip local policy

show ip local policy vrf <name>
Syntax Description
vrf <name> Optional. Displays information for only the specified VPN routing and
forwarding (VRF).
Default Values
Command History
include.
Functional Notes

Usage Examples
The following is sample output (just for the default VRF) from this command:
>enable
#show ip local policy
Local policy routing is enabled, using route-map SAMPLE_RTEMAP
route-map SAMPLE_RTEMAP, permit, sequence 1
Match clauses:
ip address (access-lists): SAMPLE_ACL
Set clauses:
BGP Filtering matches: 0 routes
Policy routing matches: 0 packets 0 bytes
Redistribution Filtering matches: 0 routes

show ip mroute
Use the show ip mroute command to display IP multicasting routing table information. Variations of this
command include:
show ip mroute
show ip mroute all
show ip mroute <ip address>
show ip mroute <interface>
show ip mroute summary
Syntax Description
all Optional. Displays all multicast routes, including those not used to forward
multicast traffic.
<ip address> Optional. Displays IP address of a multicast group. IP addresses should be
<interface> Optional. Specify an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type show ip mroute ? for a complete list of interfaces.
summary Optional. Displays a single-line summary for each entry in the IP multicast
routing table.
Default Values
Command History
Release 11.1 The all parameter was added.
include.

Usage Examples
The following is sample output from the show ip mroute all command:
>enable
#show ip mroute all
IP Multicast Routing Table
Flags: S - Sparse, C - Connected, P - Pruned, J - Join SPT, T - SPT-bit Set,
F - Register, R - RP-bit Set
Timers: Uptime/Expires
(*, 225.1.0.1), 01:17:34/00:03:25, RP 192.168.0.254, Flags: SC
Forwarding Entry: Yes
Incoming interface: tunnel 2, RPF nbr 172.16.2.10
Outgoing interface list:
eth 0/1, Forward, 01:17:34/00:03:25

show ip ospf
Use the show ip ospf command to display general information regarding open shortest path first (OSPF)
processes.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample output from the show ip ospf command:
>enable
#show ip ospf
Summary of OSPF Process with ID: 192.2.72.101
Supports only single Type Of Service routes (TOS 0)
SPF delay timer: 5 seconds, Hold time between SPFs: 10 seconds
LSA interval: 240 seconds
Number of external LSAs: 0, Checksum Sum: 0x0
Number of areas: 0, normal: 0, stub: 0, NSSA: 0

show ip ospf database

Use the show ip ospf database command to display information from the open shortest path first (OSPF)
database regarding a specific router. There are several variations of this command which you can use to
obtain information about different OSPF link state advertisements. The variations are shown below:
show ip ospf <area id> database

show ip ospf <area id> database adv-router <ip address>
show ip ospf <area id> database database-summary
show ip ospf <area id> database network
show ip ospf <area id> database network <link-state id>
show ip ospf <area id> database network <link-state id> adv-router <ip address>
show ip ospf <area id> database network adv-router <ip address>
show ip ospf <area id> database router
show ip ospf <area id> database router <link-state id>
show ip ospf <area id> database router <link-state id> adv-router <ip address>
show ip ospf <area id> database router adv-router <ip address>
show ip ospf <area id> database summary
show ip ospf <area id> database summary <link-state id>
show ip ospf <area id> database summary <link-state id> adv-router <ip address>
show ip ospf <area id> database summary adv-router <ip address>
show ip ospf database
show ip ospf database adv-router <ip address>
show ip ospf database database-summary
show ip ospf database external
show ip ospf database external <link-state id>
show ip ospf database external <link-state id> adv-router <ip address>
show ip ospf database external adv-router <ip address>
show ip ospf database network
show ip ospf database network <link-state id>
show ip ospf database network <link-state id> adv-router <ip address>
show ip ospf database network adv-router <ip address>
show ip ospf database router
show ip ospf database router <link-state id>
show ip ospf database router <link-state id> adv-router <ip address>
show ip ospf database router adv-router <ip address>
show ip ospf database summary
show ip ospf database summary <link-state id>
show ip ospf database summary <link-state id> adv-router <ip address>
show ip ospf database summary adv-router <ip address>

Syntax Description
<area id> Optional. Specifies an OSPF area ID. Refer to network <ip address>
<wildcard mask> area <area id> on page 2381 for more information.
adv-router <ip address> Optional. Displays information about link state advertisements (LSAs) from
the specified advertising router IP address. IP addresses should be
database-summary Optional. Displays a simplified list of link state advertisements for the
specified area.
external Optional. Displays information about external link state advertisements from
the specified link-state ID.
network Optional. Displays information about network link state advertisements for
the specified area or from the specified link-state ID.
router Optional. Displays information about router link state advertisements for the
specified area or from the specified link-state ID.
summary Optional. Displays information about summary link state advertisements for
the specified area or from the specified link-state ID.
<link-state id> Optional. Displays information from a specific link state ID. The value defined
in this field is tied to the advertisement’s loop start (LS) type.
Default Values
Command History
include.

Functional Notes
The link state ID differs depending on whether the link state advertisement in question describes a network
or a router.
If describing a network, this ID is one of the following:

• The network’s IP address. This is true for type 3 summary link advertisements and in autonomous
system external link advertisements.
• An address obtained from the link state ID. If the network link advertisement’s link state ID is masked
with the network’s subnet mask, this will yield the network’s IP address.
If describing a router, this ID is always the router’s OSPF router ID.
Usage Examples
The following example shows the database link state summary for all areas:
>enable
#show ip ospf database

show ip ospf interface

Use the show ip ospf interface command to display open shortest path first (OSPF) information for a
specific interface. Variations of this command include:
show ip ospf interface

show ip ospf interface <interface>
Syntax Description
dot11ap 1/1.1. Type show ip ospf interface ? for a complete list of
Default Values
Command History
include.
Usage Examples
The following example shows OSPF information for the PPP 1 interface.
>enable
#show ip ospf interface ppp 1

show ip ospf neighbor

Use the show ip ospf neighbor command to display open shortest path first (OSPF) neighbor information
for a specific interface. Variations of this command include:

show ip ospf neighbor detail
show ip ospf neighbor <interface>
show ip ospf neighbor <interface> detail
show ip ospf neighbor <interface> <neighbor id>
show ip ospf neighbor <interface> <neighbor id> detail
show ip ospf neighbor <neighbor id>
show ip ospf neighbor <neighbor id> detail
Syntax Description
detail Optional. Displays detailed information on neighbors.
dot11ap 1/1.1. Type show ip ospf neighbor ? for a complete list of
<neighbor id> Optional. Specifies a specific neighbor’s router ID.
Default Values
Command History
include.

Usage Examples
The following example shows detailed information on the OSPF neighbors:
>enable
#show ip ospf neighbor

show ip ospf summary-address

Use the show ip ospf summary-address command to display a list of all summary address redistribution
information for the system.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays all summary address redistribution information for the system:
>enable
#show ip ospf summary-address

show ip pim-sparse
Use the show ip pim-sparse command to display protocol-independent multicast (PIM) configuration
information. Sparse mode or PIM-SM is a routing protocol used to establish and maintain the multicast
distribution tree. Routers can participate in the shared tree (RPT) rooted at the rendezvous point (RP)
router or the shortest path tree (SPT) rooted at a multicast source. PIM-SM also establishes both shared
trees and SPTs. Variations of this command include:
show ip pim-sparse
show ip pim-sparse interfaces <interface>
show ip pim-sparse neighbor
show ip pim-sparse rp-map
show ip pim-sparse rp-set
show ip pim-sparse state
show ip pim-sparse traffic
Syntax Description
interfaces <interface> Optional. Displays PIM-SM configuration and status information for a
specific interface. Specify an interface in the format <interface type [slot/port
| slot/port.subinterface id | interface id | interface id.subinterface id | ap |
dot11ap 1/1.1. Type show ip pim-sparse interface ? to display a list of
neighbor Optional. Displays neighbor adjacency information.
rp-map Optional. Displays active group-to-RP mappings.
rp-set Optional. Displays a list of statically configured RP candidates. The
multicast group IP address is 224.0.0.0 /4 when no access group was
applied to the rp-address command (refer to rp-address <ip address> on
page 2393). Otherwise, it is the name of the access group.
state Optional. Displays multicast route PIM state information.
traffic Optional. Displays active PIM-SM control traffic statistics.
Default Values

Command History
include.
Usage Examples
The following example shows sample output from the show ip pim-sparse command:
>enable
#show ip pim-sparse
Global PIM Sparse Mode Settings
Join/Prune interval: 60, SPT threshold: 1
The following example shows sample output from the show ip pim-sparse interfaces command:
>enable
#show ip pim-sparse interfaces
eth 0/1 is UP
PIM Sparse
DR: itself
Local Address: 192.168.1.254
Hello interval (sec): 30, Neighbor timeout (sec): 105
Propagation delay (ms): 500, Override interval (ms): 2500
tunnel 1 is UP
PIM Sparse
DR: 172.16.1.10
tunnel 2 is UP
PIM Sparse
DR: 172.16.2.10
The following example shows sample output from the show ip pim-sparse neighbor command:
>enable
#show ip pim-sparse neighbor
Port Neighbor Holdtime(sec) Age(sec) Uptime(sec)
------------------------------------------------------------------------------------------------------
tunnel 1 172.16.1.10 105 19 241908
tunnel 2 172.16.2.10 105 23 241913

The following example shows sample output from the show ip pim-sparse rp-map command:
>enable
#show ip pim-sparse rp-map
Number of group-to-RP mappings: 5
Group address RP address
---------------------------------------------------------
225.1.0.1 192.168.0.254
225.1.0.2 192.168.0.254
225.1.0.3 192.168.0.254
The following example shows sample output from the show ip pim-sparse rp-set command:
>enable
#show ip pim-sparse rp-set
Group address Static-RP-address
--------------------------------------------------------------
224.0.0.0/4 192.168.0.254
MCAST_ACL_1 192.168.1.254
MCAST_ACL_2 192.168.2.254
MCAST_ACL_3 192.168.3.254
The following example shows sample output from the show ip pim-sparse state command:
>enable
#show ip pim-sparse state
PIM-SM State Table
Flags: S - Sparse, C - Connected, P - Pruned, J - Join SPT, T - SPT-bit Set,
F - Register, R - RP-bit Set
Timers: Uptime/Expires
(*, 225.1.0.1), 02:42:03/00:03:04, RP 192.168.0.254, Flags: SC

Forwarding Entry: Yes
Incoming interface: tunnel 2, RPF nbr 172.16.2.10
Upstream Join/Prune State: Joined
Register State: No Info
RegStop Timer (sec): stopped
Join/Prune Timer (sec): 57
Override Timer (sec): stopped
Multicast Border Router: 0.0.0.0
Packets Forwarded: 2
Outgoing interface list:
eth 0/1, Forward, 02:42:03/00:03:03
Downstream Join/Prune State: Join
Assert Winner State: No Info
Assert Timer (sec): stopped
Assert Winner: 0.0.0.0

Assert Winner Metric: infinity

Local Membership: Yes
Forwarding State: Forwarding
Inherited output list:
eth 0/1
The following example shows sample output from the show ip pim-sparse traffic command:
>enable
#show ip pim-sparse traffic
Rx Tx Rx Tx
Port: eth 0/1
Hello: 7 8334 J/P: 0 0
Register: 0 0 RegStop: 0 0
Assert: 0 0
Port: tunnel 1
Hello: 8327 8333 J/P: 0 57
Assert: 0 0
Port: tunnel 2
Hello: 8323 8334 J/P: 0 11949
Assert: 0 0
Total
Hello: 16657 25001 J/P: 0 12006
Assert: 0 0

show ip policy
Use the show ip policy command to display the interfaces which have route maps configured. This
command is used for troubleshooting policy-based routing.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
>enable
#show ip policy
Interface Route-map
eth 0/1 ISP_A
eth 0/2 ISP_B

show ip policy-class
Use the show ip policy-class command to display the configured session limit and specific host IP
addresses of all current sessions. Refer to ip policy-class <name> on page 900 for information on
configuring access policies.Variations of this command include:
show ip policy-class
show ip policy-class <name>
show ip policy-class host-sessions
show ip policy-class <name> host-sessions
Syntax Description
host-sessions Optional. Displays specific host IP addresses of all current sessions.
<name> Optional. Displays policy class information for a specific policy class.
Default Values
Command History
Release 12.1 Command was expanded to include host-sessions.
include.

Usage Examples
The following is a sample output from the show ip policy-class command:
>enable
#show ip policy-class
Maximum policy-sessions: 17400

Policy-class “Private”:
136 current sessions (5800 max)
Entry 1 - allow list self self
Entry 2 - nat source list wizard-ics interface ppp 1 overload
Policy-class “Public”:
0 current sessions (5800 max)
The following is a sample output from the show ip policy-class host-sessions command:
>enable
#show ip policy-class host-sessions
100 policy-sessions allowed per source address.
Src IP Address Sessions

--------------- --------
192.168.1.100 1
192.168.1.101 35
192.168.1.121 100 (maximum allowed)
Policy-class “Public”:
No limit for policy-sessions allowed per host.
The following is a sample output from the show ip policy-class <name> host-sessions command for the
policy class named Private:
>enable
#show ip policy-class Private host-sessions
100 policy-sessions allowed per source address.
Src IP Address Sessions

--------------- --------
192.168.1.100 1
192.168.1.101 35
192.168.1.121 100 (maximum allowed)

show ip policy-sessions
Use the show ip policy-sessions command to display a list of current policy class associations. Refer to ip
policy-class <name> on page 900 for information on configuring access policies. Variations of this
command include:
show ip policy-sessions
show ip policy-sessions timeline
show ip policy-sessions <name>
show ip policy-sessions <name> include-deleted
show ip policy-sessions <name> timeline
show ip policy-sessions any-vrf
show ip policy-sessions any-vrf include-deleted
show ip policy-sessions any-vrf timeline
show ip policy-sessions include-deleted
show ip policy-sessions vrf <name>
show ip policy-sessions vrf <name> include-deleted
show ip policy-sessions vrf <name> timeline
Syntax Description
<name> Optional. Displays policy class associations for the specified policy class.
include-deleted Optional. Displays all policy sessions, including active associations (through
which the firewall is allowed to pass traffic), and associations flagged for
deletion (through which the firewall is forbidden to pass traffic). Associations
flagged for deletion will usually be freed within a few seconds of timeout or
deletion, depending on packet congestion; servicing of packets is given
priority. New traffic matching an association will create a new active
association, provided the traffic still matches a policy class allow or network
address translation (NAT) entry. (This parameter is only valid on the
NetVanta 3200.)
timeline Optional. Displays a timeline of policy session creations and peak numbers
of policy sessions per hour over the last 24 hours.
any-vrf Optional. Displays information for all VPN routing and forwardings (VRFs),
including the default.
vrf <name> Optional. Displays information only for the specified VRF. If a VRF is not
specified, the default unnamed VRF is assumed.

Default Values
Command History
Release 11.1 Command was expanded to include the all parameter.
Release 17.1 Command was expanded to include the parameters vrf and
include-deleted (NetVanta 3200 only), as well as the modifiers begin,
Release 17.5 Command was expanded to include the timeline parameter.
Functional Notes
Usage Examples
The following is sample output from the show ip policy-sessions command:
>enable
#show ip policy-sessions
Protocol (TTL) [in crypto map] -> [out crypto map] Dest VRF, Dest policy-class
Src IP Address Src Port Dest IP Address Dst Port NAT IP Address NAT Port
-------------------------------------------------------------------------------------------------------------------------------------------
Policy class “Public”:
tcp (13)
192.168.1.142 2621 192.168.19.2 1 10.10.10.1 3000
tcp (13)
192.168.1.142 2622 192.168.19.2 2 10.10.10.1 3001
tcp (13)
192.168.1.142 2623 192.168.19.2 3 10.10.10.1 3002
The following is sample output from the show ip policy-sessions include-deleted command:
>enable
#show ip policy-sessions include-deleted

Src Vrf (if not default), Src policy class:
-------------------------------------------------------------------------------------------------------------------------------------------
Policy class "Private":
Policy class “Private_Aqua”:
Policy class “Private_Black”:
Policy class “Private_Crimson”:
Policy class “Private_Green”:
Policy class “Private_Orange”:
Policy class “Private_Purple”:
Policy class “Private_Yellow”:
Policy class "Public":
Policy class "Public2":
Policy class "self":
udp (60) -> Public2
10.22.160.134 1027 10.22.160.254 53
Policy class "default":
The following is sample output from the show ip policy-sessions any-vrf include-deleted command:
>enable
#show ip policy-sessions any-vrf include-deleted
Src Vrf (if not default), Src policy class:

-------------------------------------------------------------------------------------------------------------------------------------------
Policy class "Private":
Policy class "Public":
Policy class "self":
Policy class "default":
VRF "Green", Policy class "Private":
tcp (418) -> Black, Public
192.168.121.2 35257 192.168.10.19 21 s 192.168.9.2 35257
192.168.121.2 35333 192.168.10.19 20 s 192.168.9.2 2759
192.168.121.2 65283 192.168.10.207 80 s 192.168.9.2 65283
192.168.121.2 1606 192.168.10.209 80 s 192.168.9.2 1606
192.168.121.2 3648 192.168.10.210 80 s 192.168.9.2 3648
192.168.121.3 52429 192.168.10.19 21 s 192.168.9.2 52429

VRF "Green", Policy class "Public":

VRF "Green", Policy class "self":
VRF "Green", Policy class "default":
VRF "Black", Policy class "Private":
VRF "Black", Policy class "Public":
VRF "Black", Policy class "self":
VRF "Black", Policy class "default":
The following is sample output from the show ip policy-sessions timeline command:
#show ip policy-sessions timeline

Period: Feb 08 12:00 - Feb 09 12:00 Current Time: 09 Feb 2009 12:54:46
Hour New Peak

--------- ---------- -------
12:00 13115 818
13:00 13810 769
14:00 13177 748
15:00 13373 753
16:00 14451 982
17:00 13555 831
18:00 13825 741
19:00 14130 827
20:00 13005 870
21:00 13640 803
22:00 13081 781
23:00 13893 799
00:00 13003 783
01:00 14077 937
02:00 13240 854
03:00 12448 803
04:00 12518 1018
05:00 12533 843
06:00 12818 752
07:00 16119 934
08:00 22813 996
09:00 20361 1041
10:00 28474 1221
11:00 20361 1454

show ip policy-stats
Use the show ip policy-stats command to display a list of current policy class statistics. Refer to ip
policy-class <name> on page 900 for information on configuring access policies. Variations of this
command include:
show ip policy-stats
show ip policy-stats <name>
Syntax Description
<name> Optional. Displays policy class statistics for a specific policy class.
Default Values
Command History
include.
Usage Examples
The following example displays a list of current policy class statistics:
>enable
#show ip policy-stats

show ip prefix-list
Use the show ip prefix-list command to display Border Gateway Protocol (BGP) prefix list information.
show ip prefix-list <name>

show ip prefix-list detail <name>
show ip prefix-list summary <name>
Syntax Description
<name> Shows information for a specific prefix list.
detail Optional. Shows a listing of the prefix list rules and their hit counts.
summary Optional. Shows information about the entire prefix list.
Default Values
Command History
include.
Functional Notes
If the show ip prefix-list command is issued with no arguments, a listing of the prefix-list rules, but no hit
count statistics, is displayed.
Usage Examples
The following example displays information about the prefix list test.
>enable
#show ip prefix-list test
ip prefix-list test: 4 entries
seq 5 permit 0.0.0.0/0 ge 8 le 8
seq 10 deny 0.0.0.0/0 ge 9 le 9
seq 15 permit 0.0.0.0/0 ge 10 le 10
seq 20 deny 0.0.0.0/0 ge 11

show ip protocols
Use the show ip protocols command to display IP routing protocol parameters and statistics.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample output from the show ip protocols command:
>enable
#show ip protocols
Sending updates every 30 seconds, next due in 8 seconds
Invalid after 180 seconds, hold down time is 120 seconds
Redistributing: rip
Default version control: send version 2, receive version 2
Interface Send Ver. Rec Ver.
eth 0/1 2 2
ppp 1 2 2
Routing for networks:
1.1.1.0/24

show ip route
Use the show ip route command to display the contents of the IP route table. Variations of this command
include:
show ip route
show ip route <ip address>
show ip route <ip address> <subnet mask>
show ip route <ip address> longer-prefixes
show ip route <ip address> <subnet mask> longer-prefixes
show ip route bgp
show ip route bgp verbose
show ip route connected
show ip route ospf
show ip route ospf verbose
show ip route rip
show ip route rip verbose
show ip route static
show ip route static verbose
show ip route summary
show ip route summary realtime
show ip route table
show ip route vrf <name>
show ip route vrf <name> <ip address>
show ip route vrf <name> <ip address> <subnet mask>
show ip route vrf <name> <ip address> longer-prefixes
show ip route vrf <name> <ip address> <subnet mask> longer-prefixes
show ip route vrf <name> bgp
show ip route vrf <name> connected
show ip route vrf <name> ospf
show ip route vrf <name> rip
show ip route vrf <name> static
show ip route vrf <name> summary
show ip route vrf <name> table

your unit.
Syntax Description
(for example, /24).
bgp Optional. Displays only the IP routes associated with Border Gateway
Protocol (BGP).
connected Optional. Displays only the IP routes for directly connected networks.
longer-prefixes Optional. Displays only the IP routes matching the specified network.
ospf Optional. Displays only the IP routes associated with open shortest path
first (OSPF).
rip Optional. Displays only the IP routes that were dynamically learned through
Routing Information Protocol (RIP).
static Optional. Displays only the IP routes that were statically entered.
summary Optional. Displays a summary of all IP route information.
summary realtime Optional. Displays full-screen output in real time. Refer to the Functional
table Optional. Displays a condensed version of the IP route table.
vrf <name> Optional. Displays only the IP routes for the specified VPN routing and
forwarding (VRF).
Default Values
Command History
Release 16.1 Expanded to include the vrf parameter.
include.
Release A1 Command was expanded to include the verbose parameter.
Release 17.2 Command was enhanced to show the best route to the given IP address
and the longer-prefixes parameter was added.

Functional Notes
page 702).
VRF on ADTRAN Operating System (AOS) products allows a single physical router to be partitioned into
multiple virtual routers. Each router instance has its own route table and interface assignments. Beginning
with Release 16.1, all AOS routers supporting multiple VRF instances (multi-VRF) have an unnamed
default VRF instance regardless of whether multi-VRF is configured. Therefore, executing the
abovementioned commands without specifying a VRF will only affect the default unnamed VRF.
Usage Examples
The following example shows how to display IP routes learned via BGP. The values in brackets after a
BGP route entry represent the entry's administrative distance and metric:
>enable
#show ip route bgp
Codes: C - connected, S - static, R - RIP, O - OSPF, B - BGP
IA - OSPF inter area, N1 - OSPF NSSA external type 1
N2 - OSPF NSSA external type 2, E1 - OSPF external type 1
E2 - OSPF external type 2
Gateway of last resort is 10.15.43.17 to network 0.0.0.0
B 1.0.0.0/8 [30/0] via 10.15.43.17, fr 1.17
B 2.0.0.0/9 [30/0] via 10.15.43.17, fr 1.17
B 2.128.0.0/10 [30/0] via 10.15.43.17, fr 1.17
B 2.192.0.0/11 [30/0] via 10.15.43.17, fr 1.17
B 2.224.0.0/12 [30/0] via 10.15.43.17, fr 1.17
B 2.240.0.0/13 [30/0] via 10.15.43.17, fr 1.17
The following example shows output for the show ip route vrf RED summary command.
>enable
#show ip route vrf RED summary
Route Source FIB Local-RIB
Connected 16 16
Static 16 16
Other 31 31
Total 63 63

The following example shows how to display IP routes learned in VRF RED. The values in brackets after a
route entry represent the entry's administrative distance and metric:
>enable
#show ip route vrf RED
IA - OSPF inter area, N1 - OSPF NSSA external type 1
N2 - OSPF NSSA external type 2, E1 - OSPF external type 1
E2 - OSPF external type 2
S 0.0.0.0/0 [1/0] via 192.168.1.1, eth 0/2.301
C 192.168.1.0/24 is directly connected, eth 0/2.301
C 192.168.50.0/30 is directly connected, fr 1.16
C 192.168.54.0/30 is directly connected, ppp 1
C 192.168.55.0/30 is directly connected, hdlc 1
S 192.168.101.0/24 [1/0] via 192.168.50.1, fr 1.16
S 192.168.102.0/24 [1/0] via 192.168.51.1, fr 2.16
S 192.168.106.0/24 [1/0] via 192.168.55.1, hdlc 1
S 192.168.107.0/24 [1/0] via 192.168.56.1, fr 11.16
S 192.168.109.0/24 [1/0] via 192.168.1.253, eth 0/2.301
The following example shows output for the show ip route command. The values in brackets after a route
entry represent the entry's administrative distance and metric:
>enable
#show ip route
E1 - OSPF external type 1, E2 - OSPF external type 2
IA - OSPF inter area
S 0.0.0.0/0 [1/0] via 10.22.18.254, eth 0/1

S 10.22.16.0/24 [1/0] via 10.22.18.254, eth 0/1
S 10.22.17.0/24 [1/0] via 10.22.18.254, eth 0/1
C 10.22.18.0/24 is directly connected, eth 0/1
C 192.168.25.0/31 is directly connected, loop 1
C 192.168.249.0/24 is directly connected, eth 0/2

The following example shows output for the show ip route <ip address> command. This data explains the
resulting route a packet will be sent through.
>enable
#show ip route 10.22.16.16
Routing entry for 10.22.16.0/24
Known via “static”
Distance 1, metric 0, candidate default path
Routing Next Hop(s):
10.22.18.254, via eth 0/1
Route metric is 0
The following example shows output for the show ip route <ip address> longer-prefixes command.
Using the longer-prefixes parameter displays only the matching routes.
>enable
#show ip route 10.22.16.0 longer-prefixes
E1 - OSPF external type 1, E2 - OSPF external type 2
IA - OSPF inter area

show ip route-cache express

Use the show ip route-cache express command to display the addresses currently being express cached in
hardware. Variations of this command include:
show ip route-cache express

show ip route-cache express count
Syntax Description
count Optional. Displays only the total number of entries stored in the route cache.
Default Values
Command History
Usage Examples
The following is sample output from the show ip route-cache express command:
>enable
#show ip route-cache express
DESTINATION MASK GATEWAY
----------------------------------------------------------------------------------------
199.0.50.2 255.255.255.255 10.100.43.251
199.0.45.2 255.255.255.255 10.100.43.251
198.110.47.2 255.255.255.255 10.100.43.251
198.50.42.2 255.255.255.255 10.100.43.251
198.0.46.2 255.255.255.255 10.100.43.251
198.0.41.2 255.255.255.255 10.100.43.251
The following is sample output from the show ip route-cache express count command:
>enable
#show ip route-cache express count
Total number of express routes: 26

show ip route-cache express host-table

Use the show ip route-cache express host-table command to display the hardware host entries currently
used to route packets to directly connected networks in Layer 3 switching. Variations of this command
include:
show ip route-cache express host-table

show ip route-cache express host-table count
Syntax Description
count Optional. Specifies the output is limited to the number of entries stored in
the Address Resolution Protocol (ARP) table.
Default Values
Command History
Usage Examples
The following is sample output from the show ip route-cache express host-table command:
>enable
#show ip route-cache express host-table
DESTINATION MAC ADDRESS INTERFACE
-------------------------------------------------------------------------------------------
10.23.131.254 00:A0:C8:00:7E:D3 vlan 1
20.1.1.2 00:DE:AD:00:55:55 vlan 20
21.1.1.2 00:A0:C8:00:78:A8 vlan 21
22.1.1.2 00:A0:C8:24:7E:6A vlan 22

show ip rtp quality-monitoring

Use the show ip rtp quality-monitoring command to display information gathered during voice quality
monitoring (VQM) of the inbound Realtime Transport Protocol (RTP) streams across the network.
show ip rtp quality-monitoring

show ip rtp quality-monitoring active-calls
show ip rtp quality-monitoring active-calls [[call-id <substring>] [from-uri <substring>] [sort-by
<metric>] [source-uri <substring>] [to-uri <substring>]] [degradation | detail]
show ip rtp quality-monitoring call-history
show ip rtp quality-monitoring call-history [[call-id <substring>] [from-uri <substring>] [sort-by
<metric>] [source-uri <substring>] [to-uri <substring>]] [degradation | detail]
show ip rtp quality-monitoring endpoints
show ip rtp quality-monitoring endpoints [sort-by <metric> | summary]
show ip rtp quality-monitoring interface <name>
show ip rtp quality-monitoring interface <name> [detail | summary]
The majority of the sorting features are available in any order, at any time within the
subcommand. Use the ? at any level after each variation listed within the brackets to view
additional arguments and variations for the subcommand(s).
Syntax Description
active-calls Optional. Displays per-call statistics for currently active calls. This command
will not display any statistics when VQM is disabled. (Refer to the options
below.)
call-history Optional. Displays per-call statistics for completed calls in the call history.
The call history is available even when VQM is disabled. (Refer to the
options below.)
call-id <substring> Optional. Displays call statistics based on the specified substring of the call
ID.
degradation Optional. Displays possible sources of voice quality degradation.
detail Optional. Displays all available VQM statistics.
from-uri <substring> Optional. Displays statistics based on specified substring of the call ID From
URI.

sort-by <metric> Optional. Specifies the metric to use when sorting VQM statistics. Calls with
poorer quality metrics will appear first. If no sort-by metric is chosen, calls
are sorted by start time with the most recent calls appearing first. Choose
from the following metrics:
jitter Sorts VQM information by jitter.
loss Sorts VQM information by lost packets.
out-of-order Sorts VQM information by packets received out of order.
mos-lq Sorts VQM information by listening quality (LQ) mean opinion score (MOS).
mos-pq Sorts VQM information by listening quality MOS normalized to the PESQ
(PQ) scale.
source-uri <substring> Optional. Displays statistics based on the specified substring of the
URI/extension from which this RTP is sourced.
to-uri <substring> Optional. Displays statistics based on the specified substring of the To URI.
endpoints Optional. Aggregates previous call statistics per endpoint (the source IP
address of the RTP stream). When sorted, endpoints with poorer quality
metrics will appear first. Issuing this command will display previously
collected endpoint statistics even with VQM disabled.
sort-by <metric> Optional. Specifies the metric to use when sorting endpoint statistics. Calls
with poorer quality metrics will appear first. (Refer to the sort-by <metric>
options above.) If no sort-by metric is chosen, calls are sorted by start time
with the most recent calls appearing first.
summary Optional. Displays a summary of RTP streams of interfaces. The RTP
streams are placed in Excellent, Good, Fair, and Poor categories.
interface <name> Optional. Displays statistics for the specified interface. Displays the
statistics for the specified interface <interface name>, or a metric by which
to sort when multiple interfaces are enabled. (Refer to the sort-by <metric>
options above.)
detail Optional. Displays all available statistics on the interface(s). When detail is
not appended, only commonly used statistics are presented. By default,
only commonly used statistics are shown. These statistics are aggregated
only from calls saved in the call history. This command is not valid when
VQM is disabled.
summary Optional. Displays a summary of statistics for the specified interface.
Choosing a specific interface to display using the interface name is optional.
Use the summary subcommand to view the general VQM statistics on the
interface(s) and on endpoint(s). These statistics are aggregated only from
calls saved in the call history. This command is not valid when VQM is
disabled.
Default Values

Command History
Functional Notes
Refer to the Voice Quality Monitoring configuration guide available on the AOS Documentation CD shipped
with your product or online at http://kb.adtran.com (article number 2262) for more information.
Usage Examples
The following is sample output from various versions of the show ip rtp quality-monitoring command
and subcommands:
>enable
#show ip rtp quality-monitoring
Voice Quality Monitoring is ENABLED
Simulated jitter buffer: adaptive 10/50/200 ms (min/nominal/max)
Quality Active Streams Call History All Streams MOS Range

------------- --------------------- ----------------- --------------- ----------------------
Excellent 0 29 29 4.400 - 4.000
Good 0 0 0 3.999 - 3.600
Fair 0 0 0 3.599 - 2.600
Poor 0 0 0 2.599 - 0.000
------------- --------------------- ------------ ---------------
Totals: 0 29 29
(Note: Statistics for All Streams are updated at call completion and do not include currently active streams.
Call history statistics are available for up to 2000 streams.)
History thresholds:
MOS (LQ/CQ/PQ): 4.40/4.40/4.40
Loss: 0 pkts
Out-of-order packets: 0 pkts
Jitter: 0 ms
--MORE--
#show ip rtp quality-monitoring call-history sort-by lq-mos degradation

Displaying 29 estimated stream statistics from 14 completed calls
RTP stream: 10.22.41.29:16420, eth 0/1 -> 10.22.41.97:16386, eth 0/2

RTP is sourced from 1041@10.1.4.5
To: 1041@10.1.4.5
From: 3046@10.1.4.5
Call-start (duration): 29 Oct 2007 09:19:16 (29 min, 57.480 s)

MOS LQ: 4.12

MOS PQ: 4.03
Loss: 263 pkts
Out-of-order: 0 pkts
Jitter: 0 ms
CODEC: G.711 u-law
Degradation:
Packet loss: 4.09%
Echo level: 1.89%
Simulated jitter buffer discard: 0.00%
Voice encode/decoder selection: 0.00%
Recency: 0.00%
Delay: 0.00%
Signal level: 0.00%
Noise level: 0.00%
Resyncs: 1050
Delay (current/min/max): 10/10/50 ms
RTP stream: 10.22.41.29:16402, eth 0/1 -> 10.22.41.97:16386, eth 0/2

RTP is sourced from 1041@10.1.4.5
To: 3046@bw2.pq.adtran.com
From: 1041@10.1.4.5
Call-start (duration): 29 Oct 2007 08:40:23 (29 min, 58.350 s)
MOS LQ: 4.12
MOS PQ: 4.03
Loss: 259 pkts
Out-of-order: 0 pkts
Jitter: 0 ms
CODEC: G.711 A-law
Degradation:
Packet loss: 4.04%
Echo level: 1.98%
Simulated jitter buffer discard: 0.00%
Voice encode/decoder selection: 0.00%
Recency: 0.00%
Delay: 0.00%
Signal level: 0.00%
Noise level: 0.00%
--MORE--
#show ip rtp quality-monitoring endpoints sort-by loss summary

Displaying 9 estimated endpoint statistics from 29 completed calls
RTP source: 10.22.41.29, eth 0/1
Quality Completed Calls MOS Range
-------------- ------------------------ --------------------
Excellent 12 4.440 - 4.000

Good 0 3.999 - 3.600

Fair 0 3.599 - 2.600
Poor 0 2.599 - 0.000
------------- ------------------------ ---------------------
Totals: 12 (of the last 2000 recorded calls)
RTP source: 10.22.41.21, eth 0/1

Quality Completed Calls MOS Range
-------------- ------------------------ --------------------
Excellent 1 4.440 - 4.000
Good 0 3.999 - 3.600
Fair 0 3.599 - 2.600
Poor 0 2.599 - 0.000
------------- ------------------------ ---------------------
Totals: 1 (of the last 2000 recorded calls)
--MORE--
#show ip rtp quality-monitoring interface

loop 10
Currently active calls: 0
Statistics for completed calls (0 calls):
MOS LQ (min/avg/max): none/none/none
MOS PQ (min/avg/max): none/none/none
Loss (min/avg/max): 0/0/0 pkts
Out-of-order (total): 0 pkts
Jitter (max): 0 ms
Delay (min/max): 0/0 ms
eth 0/1
Statistics for completed calls (15 calls):
MOS LQ (min/avg/max): 4.12/4.14/4.20
MOS PQ (min/avg/max): 4.03/4.08/4.45
Loss (min/avg/max): 0/2033/19194 pkts
Out-of-order (total): 0 pkts
Jitter (max): 0 ms
Delay (min/max): 10/200 ms
eth 0/2
--MORE--

show ip rtp quality-monitoring reporter

Use the show ip rtp quality-monitoring reporter command to display voice quality monitoring (VQM)
reporter statistics. Variations of this command include:
show ip rtp quality-monitoring reporter

show ip rtp quality-monitoring reporter realtime
show ip rtp quality-monitoring reporter <name>
show ip rtp quality-monitoring reporter <name> realtime
your unit.
Syntax Description
<name> Optional. Specifies that only the statistics for the named VQM reporter are
displayed.
realtime Optional. Specifies that output is displayed in real time.
Default Values
Command History
Functional Notes
Output of the show ip rtp quality-monitoring reporter command displays the reporter name
(Name), the queue volume or how many reports are waiting to send requests or receive
responses (Depth), how many successful responses have been received (Success), how many
failure responses have been received (Failed), how many requests have been transmitted
(Request), how many challenge responses have been received (Chalnge), how many requests
did not receive responses at all (Rollovr), and how many reports were discarded because the
retry limit was exceeded (Discard).

Usage Examples
The following is sample output from this command showing VQM reporter statistics for all configured VQM
reporters:
>enable
#show ip rtp quality-monitoring reporter
Name Depth Success Failed Request Chalnge Rollovr Discard
-----------------------------------------------------------------------------------------------------------------
Test 1 4 0 0 36 0 36 6
Test 2 4 0 0 36 0 36 6
Test 3 0 0 10 10 0 0 0
Test 4 0 0 10 10 0 0 0
Test 5 0 0 0 0 0 0 0

show ip security
Use the show ip security command to display a list of threats with descriptions, corresponding IDs, default
weights, and current weights. Variations of this command include:
show ip security any-vrf blocked-traffic timeline

show ip security any-vrf threats
show ip security any-vrf threats <id>
show ip security any-vrf threats <id> realtime
show ip security any-vrf threats realtime
show ip security any-vrf threats sort-by first-observed
show ip security any-vrf threats sort-by first-observed realtime
show ip security any-vrf threats sort-by hits
show ip security any-vrf threats sort-by hits realtime
show ip security any-vrf threats sort-by id
show ip security any-vrf threats sort-by id realtime
show ip security any-vrf threats sort-by last-observed
show ip security any-vrf threats sort-by last-observed realtime
show ip security any-vrf threats sort-by weight
show ip security any-vrf threats sort-by weight realtime
show ip security blocked-traffic timeline
show ip security threats
show ip security threats <id>
show ip security threats <id> realtime
show ip security threats realtime
show ip security threats sort-by first-observed
show ip security threats sort-by first-observed realtime
show ip security threats sort-by hits
show ip security threats sort-by hits realtime
show ip security threats sort-by id
show ip security threats sort-by id realtime
show ip security threats sort-by last-observed
show ip security threats sort-by last-observed realtime
show ip security threats sort-by weight
show ip security threats sort-by weight realtime
show ip security vrf <name> blocked-traffic timeline
show ip security vrf <name> threats
show ip security vrf <name> threats <id>
show ip security vrf <name> threats <id> realtime
show ip security vrf <name> threats realtime
show ip security vrf <name> threats sort-by first-observed
show ip security vrf <name> threats sort-by first-observed realtime
show ip security vrf <name> threats sort-by hits
show ip security vrf <name> threats sort-by hits realtime
show ip security vrf <name> threats sort-by id
show ip security vrf <name> threats sort-by id realtime

show ip security vrf <name> threats sort-by last-observed

show ip security vrf <name> threats sort-by last-observed realtime
show ip security vrf <name> threats sort-by weight
show ip security vrf <name> threats sort-by weight realtime
Syntax Description
any-vrf Optional. Displays every available VPN routing and forwarding (VRF) on the
device.
blocked-traffic timeline Optional. Displays an hour-by-hour count of blocked threats and policy
discards.
first-observed Optional. Sorts the threat list by the first-observed threat.
hits Optional. Sorts the threat list by number of hits.
id Optional. Sorts the threat list by threat ID.
<id> Optional. Displays a specific threat as identified by its threat ID.
last-observed Optional. Sorts the threat list by the last-observed threat.
<name> Optional. Displays a specified named VRF.
realtime Optional. Lists the threats as they occur in real time rather than historical
threat data.
sort-by <option> Optional. Defines the criteria, by <option>, by which the threat list will be
sorted. If sort-by is not indicated, the list will be sorted using the
descending order of hits. All options will be sorted in descending order with
the exception of threat IDs.
threats Optional. Displays all observed security threats.
weight Optional. Sorts the threat list by threat weight.
Default Values
There is no default value for the show ip security command.
Command History
Functional Notes
The show ip security command displays a list of threats with descriptions, corresponding IDs, default
weights, and current weights. For threats that have been observed the number of hits, the time it was first
observed, and the time it was most recently observed is displayed. Threat lists are sorted by hits unless
another option is chosen by the user. All sorting options are displayed in descending order except for
threat IDs. A single ID can be specified to display only that threat’s information. The unnamed default VRF
is implied unless a named VRF or any-vrf is specified. Historical data is displayed unless realtime is
specified. Threats that have been blocked on the default unnamed VRF or any-vrf can also be viewed
using blocked-traffic timeline.

Usage Examples
The following example displays a list of all threats on the default unnamed VRF sorted by threat weight:
>enable
#show ip security threats sort-by weight
The following example displays an hour-by-hour count of all blocked threats on the named VRF MyVRF:
>enable
#show ip security vrf MyVRF blocked-traffic timeline

show ip traffic
Use the show ip traffic command to display all IP traffic statistics. Variations of this command include:
show ip traffic
show ip traffic netstat
show ip traffic realtime
your unit.
Syntax Description
netstat Optional. Displays active Transmission Control Protocol (TCP) connections.
Default Values
Command History
include.
Release 17.5 Command was expanded to include the netstat keyword.
Functional Notes
page 702).

Usage Examples
The following example displays all IP traffic statistics:
>enable
#show ip traffic
IP statistics:
Routing discards: 0
Rcvd: 15873 total, 7617 delivered
0 header errors, 0 address errors
0 unknown protocol, 0 discards
0 checksum errors, 0 bad hop counts
Sent: 8281 generated, 4459 forwarded
0 no routes, 0 discards
Frags: 0 reassemble required, 0 reassembled, 0 couldn't reassemble
0 created, 0 fragmented, 0 couldn't fragment
UDP statistics:
Rcvd: 3822 total, 0 checksum errors, 0 no port
Sent: 3822 total
TCP statistics:
Retrans Timeout Algorithm: 0
Min retrans timeout (ms): 0
Max retrans timeout (ms): 0
Max TCP Connections: 0
0 active opens, 64 passive opens, 0 failed attempts
5 establish resets, 1 establish current
3795 segments received, 4459 segments sent, 26 segments retransmitted

show ip urlfilter
Use the show ip urlfilter command to display configured uniform resource locator (URL) filter and server
information.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show ip urlfilter command:
>enable
#show ip urlfilter
Configured for Websense URL filtering.

Filters
-------
Name: “filter1”
Ports: HTTP(80)
Interfaces that filter is applied to:
eth 0/2 inbound
Servers
-------
IP address: 10.100.23.116
Port: 15868
Timeout: 5
Excluded domains
----------------
Permit www.adtran.com
Other Settings

show ip urlfilter exclusive-domain

Use the show ip urlfilter exclusive-domain command to display all configured domains excluded (either
always allowed or always blocked) from uniform resource locator (URL) filtering.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show ip urlfilter exclusive-domain command:
>enable
#show ip urlfilter exclusive-domain
Excluded domains
----------------
Permit www.adtran.com

show ip urlfilter statistics

Use the show ip urlfilter statistics command to display statistics for uniform resource locator (URL) filter
requests and responses.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show ip urlfilter statistics command:
>enable
#show ip urlfilter statistics
Current outstanding requests to filter server: 0

Current response packets buffered from web server: 2
Max outstanding requests to filter server: 3
Max response packets buffered from web server: 5
Total requests sent to filter server: 400
Total responses received from filter server: 400
Total requests allowed: 398 Total requests blocked: 2

show ip urlfilter top-websites

Use the show ip urlfilter top-websites command to display configured uniform resource locator (URL)
filter and top websites reporting information. Variations of this command include the following:
show ip urlfilter top-websites

show ip urlfilter top-websites <number>
show ip urlfilter top-websites all
show ip urlfilter top-websites all <number>
show ip urlfilter top-websites daily
show ip urlfilter top-websites daily <number>
show ip urlfilter top-websites hourly
show ip urlfilter top-websites hourly <number>
Syntax Description
all Optional. Specifies that top websites statistics for all lists will be displayed.
daily Optional. Specifies that top websites statistics in daily increments will be
displayed.
hourly Optional. Specifies that top websites statistics in hourly increments will be
displayed.
<number> Optional. Specifies how many websites to show on the report. Range is 5 to
20 websites.
Default Values
By default, a 15-minute incremented list of the 10 top websites requests is shown.
Command History
include.
Functional Notes
The top websites statistic lists show the previous interval, not the current one. The output shows the period
for which the statistics were collected, as well as the current time so it can be determined when the next
update will occur.

Usage Examples
The following example displays the top 5 websites visited in the last 15 minutes:
#show ip urlfilter top-websites 5
Top Websites Visited
Period: Apr 26 08:55:00--Apr 26 09:10:00 Current Time: 09:15:34
Allow mode: enabled
The visits listed below are visits which were permitted. These statistics do not include websites explicitly
filtered using exclusive domains.
Domain Name Visits Last Visitor Visit Time

www.gmail.com 767 10.22.160.7 Apr 26 08:55:47
www.google.com 540 10.22.160.88 Apr 26 09:05:27
www.adtran.com 67 10.22.160.107 Apr 26 08:59:16
www.cisco.com 67 10.22.160.5 Apr 26 09:01:05
www.partypoker.com 15 10.22.160.45 Apr 26 09:04:43

show vrf
Use the show vrf command to display the configured VPN routing and forwardings (VRFs) and the
interfaces associated with each one (or a specific VRF). Variations of this command include:
show vrf
show vrf <name>
show vrf interfaces
show vrf interfaces <name>
To view secondary IP addresses, use the show running-config command.
Syntax Description
<name> Optional. Displays information for only the specified VRF.
interfaces Optional. Displays information about interfaces associated with all
configured VRFs.
Default Values
Command History
include.
Release 17.8 The keyword ip was removed from this command.
Functional Notes

Usage Examples
The following is a sample output for the show vrf command:
>enable
#show vrf
Name Default RD Interfaces
-Default- 0:0 eth 0/1
ppp 1
Engineering 100:1 vlan 11
vlan 12
Accounting 100:2 vlan 21
vlan 22
The following is a sample output for the show vrf interfaces command:
>enable
#show vrf interfaces
Interface IP Address VRF Protocol
eth 0/1 10.0.0.1 DOWN
ppp 1 10.0.1.1 UP
vlan 11 1.1.1.1 Engineering UP
vlan 12 1.1.2.1 Engineering UP
vlan 21 2.1.1.1 Accounting UP

show isdn-group <number>

Use the show isdn-group command to display integrated services digital network (ISDN) group
information.
Syntax Description
<number> Displays information for a specific ISDN group. Valid range is 1 to 255.
Default Values
Command History
include.
Usage Examples
The following example displays information for ISDN group 5:
>enable
#show isdn-group 5

show isdn-number-template
Use the show isdn-number-template command to display integrated services digital network (ISDN)
number templates. Variations of this command include:
show isdn-number-template
show isdn-number-template <value>
Syntax Description
<value> Optional. Displays information about a specific number template. Valid
range is 1 to 255.
Default Values
Command History
include.
Usage Examples
The following example displays information for ISDN number template 0:
>enable
#show isdn-number-template 0
Type ID Prefix Pattern
Subscriber 0 911
#

show isdn resource

Use the show isdn resource command to display integrated services digital network (ISDN) resource
information. Variations of this command include:
show isdn resource

show isdn resource realtime
your unit.
Syntax Description
Default Values
Command History
include.
Functional Notes
page 702).

Usage Examples
The following example displays ISDN resource information:
>enable
#show isdn resource
--------------------------------------------------------------------------------------------------------------------------------------------
Interface: Channel Trunk: Appearance Slot/Prt: Call
ChannelId State:GID Appearance State B-Channel State
--------------------------------------------------------------------------------------------------------------------------------------------
pri 1:0 Reserved:1 T01:2 TAS_Connect 1/1:21 OutgoingConnect
pri 1:1 Reserved:1 T01:0 TAS_Alerting 1/1:23 IncomingAlertingSent
pri 1:2 Available --- --- --- ---
pri 1:3 Available --- --- --- ---
pri 1:4 Available --- --- --- ---
pri 1:5 Available --- --- --- ---
pri 1:6 Available --- --- --- ---
pri 1:7 Available --- --- --- ---
pri 1:8 Available --- --- --- ---
pri 1:9 Available --- --- --- ---
pri 1:10 Available --- --- --- ---
pri 1:11 Available --- --- --- ---
pri 1:12 Available --- --- --- ---
pri 1:13 Available --- --- --- ---
pri 1:14 Available --- --- --- ---
pri 1:15 Available --- --- --- ---
pri 1:16 Available --- --- --- ---
pri 1:17 Available --- --- --- ---
pri 1:18 Available --- --- --- ---
pri 1:19 Available --- --- --- ---
pri 1:20 Available --- --- --- ---
pri 1:21 Available --- --- --- ---
pri 1:22 Available --- --- --- ---

show lldp
Use the show lldp command to display the Link Layer Discovery Protocol (LLDP) transmit interval and
transmitted time to live (TTL).
Syntax Description
No subcommands.
Default Values
Command History
include.
Functional Notes
The TTL is calculated by multiplying the transmit interval by the TTL multiplier. For more information, refer
to the command lldp on page 1009.
Usage Examples
The following example shows a sample LLDP timer configuration:
>enable
#show lldp
Global LLDP information:
Sending LLDP packets every 30 seconds
Sending TTL of 120 seconds

show lldp device <name>

Use the show lldp device command to display neighbor information about an adjacent device on the same
IEEE 802 local area network (LAN).
Syntax Description
<name> Specifies the system name of the neighbor to display.
Default Values
Command History
include.
Functional Notes
If there is more than one neighbor with the same system name, all neighbors with that system name will be
displayed.
Usage Examples
The following example shows specific information about a neighbor for the system name Router:
>enable
#show lldp device Router
Chassis ID: 00:A0:C8:02:DD:2A (MAC Address)
System Name: Router
Device Port: eth 0/1 (Locally Assigned)
Holdtime: 30
Platform: NetVanta 3305
Software: Version: 08.00.22.sw1.D, Date: Mon Nov 01 10:28:55 2004
Capabilities: Bridge, Router
Enabled Capabilities: Router
Local Port: eth 0/3
Management Addresses:
Address Type: IP version 4, Address: 10.23.10.10

show lldp interface

Use the show lldp interface command to display Link Layer Discovery Protocol (LLDP) configuration
and statistics for interfaces on this device. Variations of this command include:
show lldp interface

show lldp interface <interface>
Syntax Description
<interface> Optional. Displays the information for the specified interface. Specify an
show lldp interface ? for a complete list of applicable interfaces.
Default Values
Command History
include.
Usage Examples
The following example shows LLDP statistics for the Ethernet 0/1 interface:
>enable
#show lldp interface ethernet 0/1
eth 0/1 (TX/RX)
0 packets input
0 input errors
0 TLV errors, 0 TLVs Discarded
0 packets discarded
8799 packets output
0 neighbor ageouts

show lldp neighbors

Use the show lldp neighbors command to display information about neighbors of this device learned
about via Link Layer Discovery Protocol (LLDP). Variations of this command include:
show lldp neighbors

show lldp neighbors detail
show lldp neighbors <interface>
show lldp neighbors interface <interface> detail
show lldp neighbors med
show lldp neighbors realtime
your unit.
Syntax Description
detail Optional. Shows detailed neighbor information for all LLDP neighbors or
neighbors connected to the specified interface or interface type.
interface <interface> Optional. Displays a summary of all neighbors learned about through the
[slot/port | slot/port.subinterface id | interface id | interface id.subinterface id
| ap | ap/radio | ap/radio.vap]>. For example, for a T1 interface, use t1 0/1;
for an Ethernet subinterface, use eth 0/1.1; for a PPP interface, use ppp 1;
for an ATM subinterface, use atm 1.1; and for a wireless virtual access
point, use dot11ap 1/1.1. Type show lldp neighbors interface ? for a
med Optional. Displays neighbors that are capable of supporting LLDP-Media
Endpoint Discovery (LLDP-MED).
Default Values

Command History
include.
Release 17.2 Command was expanded to include the med parameter.
Functional Notes
page 702).
Usage Examples
The following example shows detailed information about a device’s neighbors:
>enable
#show lldp neighbors interface eth 0/3 detail
Chassis ID: 00:A0:C8:02:DD:2A (MAC Address)
System Name: Router
Device Port: eth 0/1 (Locally Assigned)
Holdtime: 38
Platform: NetVanta 3305
Software: Version: 08.00.22.sw1.D, Date: Mon Nov 01 10:28:55 2004
Capabilities: Bridge, Router
Enabled Capabilities: Router
Local Port: eth 0/3
Management Addresses:
Address Type: IP version 4, Address: 10.23.10.10
Interface Type: Interface Index, Interface Id: 2
The following example shows LLDP-MED capable neighbors connected to a device:
.>enable
#show lldp neighbors med
Capability Codes: R - Router, B - Bridge, H - Host, D - DOCSIS Device,
W - WLAN Access Point, r - Repeater, T - Telephone
System Name Port ID TTL Cap. Platform Local Int

---------------------------------- --------------------------- --------- ----------- ------------------ -----------------
URL 5000@10.22.41 08:00:0F:2C:AB 96 --B--T-- swx 0/2

show lldp neighbors statistics

Use the show lldp neighbors statistics command to display statistics about Link Layer Discovery
Protocol (LLDP) neighbor table actions.
Syntax Description
No subcommands.
Default Values
Command History
include.
Functional Notes
This command shows information about the changes in this device’s neighbor table. The information
displayed indicates the last time a neighbor was added to or removed from the table, as well as the number
of times neighbors were inserted into or deleted from the table.
System Last Change Time Shows the time at which the most recent change occurred in the neighbor
table.
Inserts Shows the number of times neighbors have been added to the table.
Deletes Shows how many times neighbors have been deleted from the table
because an interface was shut down.
Drops Shows how many times the insertion of a new neighbor into the table failed
because the table was full.
Age Outs Shows how many times neighbors have been removed from the table
because no new updates were received from that neighbor before its time
to live (TTL) timer expired.

Usage Examples
The following example shows sample output for this command:
>enable
#show lldp neighbors statistics
System Last Change Time Inserts Deletes Drops Age Outs
10-15-2004 14:24:56 55 3 1 1

show mac address-table

Use the show mac address-table command to display all static and dynamic entries in the medium access
control (MAC) address table for all virtual local area networks (VLANs) and physical interfaces.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show mac address-table command:
>enable
#show mac address-table
Mac Address Table
------------------------------------------
Vlan Mac Address Type Ports
1 aa:bb:ee:d1:c2:33 STATIC eth 0/18
1 00:00:00:00:00:00 STATIC CPU
2 00:90:2b:7d:30:00 DYNAMIC eth 0/1
2 00:a0:c8:00:8e:a6 DYNAMIC eth 0/1
2 00:a0:c8:00:8f:ba DYNAMIC eth 0/1
2 00:a0:c8:00:8f:73 DYNAMIC eth 0/1
2 00:a0:c8:00:00:00 DYNAMIC eth 0/1
2 00:a0:c8:01:ff:02 DYNAMIC eth 0/1
2 00:a0:c8:01:09:d3 DYNAMIC eth 0/1
2 00:a0:c8:01:13:34 DYNAMIC eth 0/1
2 00:a0:c8:01:14:4a DYNAMIC eth 0/1
2 00:a0:c8:03:95:4b DYNAMIC eth 0/1
2 00:a0:c8:05:00:89 DYNAMIC eth 0/1

show mac address-table address

Use the show mac address-table address command to display all medium access control (MAC)
addresses known by AOS. Variations of this command include the following:
show mac address-table address <mac address>

show mac address-table address <mac address> interface <interface>
show mac address-table address <mac address> interface <interface> vlan <vlan id>
show mac address-table address <mac address> vlan <vlan id>
Syntax Description
<mac address> Specifies a valid 48-bit MAC address. MAC addresses should be expressed
in the following format: xx:xx:xx:xx:xx:xx (for example, 00:A0:C8:00:00:01).
interface <interface> Optional. Shows information for a specific interface. Specify an interface in
wireless virtual access point, use dot11ap 1/1.1. Type show mac
address-table address interface ? for a list of valid interfaces.
vlan <vlan id> Optional. Specifies a valid virtual local area network (VLAN) interface ID.
Range is 1 to 4094.
Default Values
Command History
include.

Usage Examples
The following sample from the show mac address-table address command displays information
regarding a specific MAC address from the MAC address table:
>enable
#show mac address-table address 00:a0:c8:7d:30:00
Mac Address Table
------------------------------------------
-------- -------------------- --------- -----------
2 00:a0:c8:7d:30:00 DYNAMIC eth 0/1
The following sample from the show mac address-table address command displays information
regarding a specific MAC address and interface from the MAC address table:
>enable
#show mac address-table address 00:a0:c8:7d:30:00 ethernet 0/1
Mac Address Table
------------------------------------------
-------- -------------------- --------- -----------
2 00:a0:c8:7d:30:00 DYNAMIC eth 0/1
Total Mac Addresses for this criterion: 1
#

show mac address-table aging-time

Use the show mac address-table aging-time command to display information regarding the amount of
time dynamic entries remain in the medium access control (MAC) address table.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample from the show mac address-table aging-time command for a switch
configured with an address-table aging-time:
>enable
#show mac address-table aging-time
Aging Time
----------------
300 Seconds

show mac address-table count

Use the show mac address-table count command to display information regarding the number of medium
access control (MAC) addresses in use (both static and dynamic).
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample from the show mac address-table count command:
>enable
#show mac address-table count
Mac Table Entries:
--------------------------
Dynamic Address Count: 19
Static Address Count: 3
Total Mac Addresses: 23
Total Mac Address Space Available: 8169

show mac address-table dynamic

Use the show mac address-table dynamic command to display all dynamic medium access control
(MAC) addresses learned by AOS. Variations of this command include the following:
show mac address-table dynamic

show mac address-table dynamic address <mac address>
show mac address-table dynamic address <mac address> interface <interface>
show mac address-table dynamic address <mac address> interface <interface> vlan <vlan id>
show mac address-table dynamic address <mac address> vlan <vlan id>
show mac address-table dynamic interface <interface>
show mac address-table dynamic interface <interface> vlan <vlan id>
show mac address-table dynamic vlan <vlan id>
Syntax Description
address <mac address> Optional. Specifies a valid 48-bit MAC address. MAC addresses should be
00:A0:C8:00:00:01).
address-table dynamic interface ? for a list of valid interfaces.
vlan <vlan id> Optional. Specifies a valid virtual local area network (VLAN) interface ID.
Range is 1 to 4094.
Default Values
Command History
include.

Usage Examples
The following is a sample from the show mac address-table dynamic command:
>enable
#show mac address-table dynamic
Mac Address Table
----------------------------
------- -------------------- -------- --------
1 00:a0:c8:7d:30:00 DYNAMIC eth 0/1
1 00:a0:c8:05:89:09 DYNAMIC eth 0/2
1 00:a0:c8:07:d9:d2 DYNAMIC eth 0/5
1 00:a0:c8:07:d9:19 DYNAMIC eth 0/7
1 00:a0:c8:09:95:6b DYNAMIC eth 0/7
1 00:a0:c8:0a:2d:7c DYNAMIC eth 0/12
1 00:a0:c8:f6:e9:a6 DYNAMIC eth 0/24
1 00:a0:c8:01:0a:ef DYNAMIC eth 0/23
1 00:a0:c8:0c:74:80 DYNAMIC eth 0/20
1 00:a0:c8:15:5a:9f DYNAMIC eth 0/7
1 00:a0:c8:6c:71:49 DYNAMIC eth 0/2
1 00:a0:c8:77:78:c1 DYNAMIC eth 0/3
1 00:a0:c8:6b:53:7b DYNAMIC eth 0/4
1 00:a0:c8:72:e6:d6 DYNAMIC giga-eth 0/2
1 00:a0:c8:05:00:e6 DYNAMIC giga-eth 0/1

show mac address-table interface

Use the show mac address-table interface command to display information regarding medium access
control (MAC) address table entries specific to a certain interface. Variations of this command include:
show mac address-table interface <interface>

show mac address-table interface <interface> vlan <vlan id>
Syntax Description
<interface> Shows information for a specific interface type. Specify an interface in the
address-table interface ? for a list of valid interfaces.
vlan <vlan id> Optional. Shows address-table information related to a specific virtual local
area network (VLAN). Valid range is 1 to 4094.
Default Values
Command History
include.

Usage Examples
The following is an example of the show mac address-table interface eth 0/1 command displaying MAC
address-table entries specifically on Ethernet 0/1:
>enable
#show mac address-table interface ethernet 0/1
Mac Address Table
2 00:90:2b:7d:30:00 DYNAMIC eth 0/1
2 00:a0:c8:05:00:ac DYNAMIC eth 0/1
2 00:a0:c8:05:00:ad DYNAMIC eth 0/1
2 00:a0:c8:05:00:c2 DYNAMIC eth 0/1
2 00:a0:c8:05:01:6e DYNAMIC eth 0/1
2 00:a0:c8:09:95:6b DYNAMIC eth 0/1
2 00:a0:c8:0a:2d:7c DYNAMIC eth 0/1

show mac address-table multicast

Use the show mac address-table multicast command to display all multicast medium access control
(MAC) addresses known by AOS. Variations of this command include the following:
show mac address-table multicast

show mac address-table multicast count
show mac address-table multicast igmp-snooping
show mac address-table multicast igmp-snooping count
show mac address-table multicast user
show mac address-table multicast user count
show mac address-table multicast vlan <vlan id>
show mac address-table multicast vlan <vlan id> count
show mac address-table multicast vlan <vlan id> igmp-snooping
show mac address-table multicast vlan <vlan id> igmp-snooping count
show mac address-table multicast vlan <vlan id> user
show mac address-table multicast vlan <vlan id> user count
Syntax Description
count Optional. Displays the multicast address count.
igmp-snooping Optional. Displays MAC addresses learned via Internet Group Management
Protocol (IGMP) snooping.
user Optional. Displays static MAC addresses entered by the user.
vlan <vlan id> Optional. Displays address table information related to a specific virtual
local area network (VLAN). Valid range is 1 to 4094.
Default Values
Command History
include.

Usage Examples
The following is sample output from the show mac address-table multicast command:
>enable
#show mac address-table multicast
Multicast Mac Address Table
------------------------------------------
------ ------------------- -------- --------
1 01:00:5e:00:01:01 igmp swx 0/10
1 01:00:5e:7f:ff:fa igmp swx 0/24

show mac address-table static

Use the show mac address-table static command to display all static medium access control (MAC)
addresses known by AOS. Variations of this command include the following:
show mac address-table static

show mac address-table static address <mac address>
show mac address-table static address <mac address> interface <interface>
show mac address-table static address <mac address> interface <interface> vlan <vlan id>
show mac address-table static address <mac address> vlan <vlan id>
show mac address-table static interface <interface>
show mac address-table static interface <interface> vlan <vlan id>
show mac address-table static vlan <vlan id>
Syntax Description
address <mac address> Optional. Specifies a valid 48-bit MAC address. MAC addresses should be
00:A0:C8:00:00:01).
address-table static interface ? for a list of valid interfaces.
vlan <vlan id> Optional. Shows address-table information related to a specific virtual local
area network (VLAN). Valid range is 1 to 4094.
Default Values
Command History
include.

Usage Examples
The following is a sample from the show mac address-table static command:
>enable
#show mac address-table static
Mac Address Table
------ ------------------- -------- --------
1 00:a0:c8:00:88:40 STATIC CPU

show mail-client
Use the show mail-client command to display statistical summary information for mail agents. Variations
show mail-client
show mail-client <agent name>
Syntax Description
<agent name> Optional. Specifies only statistics for the named mail agent are displayed.
Default Values
Command History
Usage Examples
The following example displays statistical information for mail agent myagent:
>enable
#show mail-client myagent
Mail-client myagent is ENABLED
Capture output when track mail becomes PASS
Send message when track T becomes PASS
Send TO: joesmith@company.com
6 output captures triggered

18 commands captured
6 command errors
2 unrecognized commands
4 truncated commands
5 emails sent
Last email sent on 2/29/2008 at 16:20:10 PM

show mail-client body <agent name>

Use the show mail-client body command to display the current buffer content for the body of the email
message in queue for a specific mail agent.
Syntax Description
<agent name> Specifies the mail agent buffer to display.
Default Values
Command History
Usage Examples
The following example displays the email body buffer content for myagent mail agent:
>enable
#show mail-client body myagent

show media-gateway
Use the show media-gateway command to show cumulative totals for all Realtime Transport Protocol
(RTP) channels. Variations of this command include:
show media-gateway
show media-gateway channel
show media-gateway channel <slot/dsp.channel>
show media-gateway info
show media-gateway session
show media-gateway session <slot/dsp.channel>
show media-gateway summary
show media-gateway summary active
Syntax Description
<slot/dsp.channel> Optional. Specifies the ID of the media-gateway channel to be displayed.
channel Optional. Shows cumulative totals for individual RTP channels.
info Optional. Shows media-gateway information.
session Optional. Shows current RTP sessions.
summary Optional. Shows summary of last active and current RTP sessions.
active Optional. Shows summary of currently active RTP sessions.
Default Values
Command History
include.

Usage Examples
The following example shows sample output from the show media-gateway command:
>enable
#show media-gateway
Media-Gateway
1 slots, 1 DSPs, 24 channels
0 total sessions, 0 active sessions, 00:00:00 total session duration
0 total rx packets, 0 total rx bytes
0 total lost packets, 0 total unknown packets
0 total tx packets, 0 total tx bytes
0 highest max depth
0 total discards, 0 total overflows, 0 total underflows
0 total out-of-orders
Last clearing of counters: 9:46 PM Thu, Jan 1, 1970
#

show memory
Use the show memory command to display statistics regarding memory, including memory allocation and
buffer use statistics. Shows how memory is in use (broken down by memory size) and how much memory
is free. Variations of this command include:
show memory heap

show memory heap realtime
show memory uncached-heap
your unit.
Syntax Description
heap Shows how much memory is in use (broken down by memory block size)
and how much memory is free.
uncached-heap Shows how much memory has been set aside to be used without memory
caching, how much memory is being used, and how much memory is free.
Default Values
Command History
include.

Functional Notes
page 702).
Usage Examples
The following is sample output from the show memory heap command:
>enable
#show memory heap
Memory Heap:
HeapFree: 2935792
HeapSize: 8522736
Block Managers:
Mgr Size Used Free Max-Used
0 0 58 0 58
1 16 1263 10 1273
2 48 1225 2 1227
3 112 432 2 434
4 240 140 3 143
5 496 72 2 74
6 1008 76 1 26
7 2032 25 1 26
8 4080 2 1 3
9 8176 31 1 32
10 16368 8 0 8
11 32752 5 1 6
12 65520 3 0 30
13 131056 0 0 0

show mgcp-endpoint
Use the show mgcp-endpoint command to display configuration statistics for all configured Media
Gateway Control Protocol (MGCP) endpoints. Variations of this command include:
show mgcp-endpoint
show mgcp-endpoint verbose
Syntax Description
Default Values
Command History
Usage Examples
The following is sample output from the show mgcp-endpoint command:
#show mgcp-endpoint
Endpoint: 1
Name : aaln/1
FXS : 0/1
State : Connected
Endpoint: 2
Name : aaln/2
FXS : 0/2
State : Connected
Endpoint: 3
Name : aaln/3
FXS : 0/3
State : Connected
Endpoint: 4
Name : aaln/4
FXS : 0/4
State : Connected

show modules
The show modules command displays information on the current system setup. Variations of this
command include:
show modules
show modules verbose
Syntax Description
Default Values
Command History
include.
Usage Examples
The following example displays the modules installed in the unit.
>enable
#show modules
Slot Ports Type Serial # Part # H/W Rev
0 3 NetVanta 5305 *********** 1200990L1 A
1 1 T3 Module *********** 1200832L1 A
2 - Empty ----------- ----------- ----------
3 - Empty ----------- ----------- ----------
4 - Empty ----------- ----------- ----------
5 - Empty ----------- ----------- ----------
6 - Empty ----------- ----------- ----------
7 - Empty ----------- ----------- ----------

show monitor session

Use the show monitor session command to display information regarding a specified monitor session or to
display this information for all sessions. Variations of this command include:
show monitor session <number>

show monitor session all
Syntax Description
<number> Displays information for a single specific monitor session.
all Displays all sessions.
Default Values
Command History
include.
Usage Examples
The following is a sample from the show monitor session command:
>enable
#show monitor session 1
Monitor Session 1
-----------------
Source Ports:
RX Only: None
TX Only: None
Both: eth 0/2, eth 0/3
Destination Port: eth 0/6

show network-forensics ip dhcp

Use the show network-forensics ip dhcp command to display collected Dynamic Host Configuration
Protocol (DHCP) information for clients connected to the network. The display of the collected
information can be for all connected clients or for a specific client. Variations of this command include:
show network-forensics ip dhcp

show network-forensics ip dhcp hostname <hostname>
show network-forensics ip dhcp interface gigabit-switchport <slot/port>
show network-forensics ip dhcp ip <ip address>
show network-forensics ip dhcp mac <mac address>
Syntax Description
hostname <hostname> Optional. Displays DHCP information for the client with the
interface gigabit-switchport <slot/port> Optional. Displays DHCP information for the client using the
ip <ip address> Optional. Displays DHCP information for the client at the
mac <mac address> Optional. Displays DHCP information for the client at the
Default Values
Command History

Usage Examples
The following is sample output from the show network-forensics ip dhcp command:
#show network-forensics ip dhcp

Client MAC/IP/Host: 00:E0:29:0E:D5:E3 / 10.23.220.1 / xpsp3-host
VLAN ID: 100
Source Port: gigabit-switchport 0/2
Server Mac/IP: 00:E0:29:0E:D5:E5 / 10.23.220.254
Lease from Time Collected: 3 days from 25 Aug 2009 10:33:42
Client Vendor Class: unknown
The preceding output is for one client. This same information will be displayed for all
connected clients unless one of the filtering parameters is used in conjunction with the
show network-forensics ip dhcp command.

show ntp associations

Use the show ntp associations command to display the active Network Time Protocol (NTP) associations.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example executes show ntp associations:
>enable
#show ntp associations

show ntp status

Use the show ntp status command to display general information about the status on the Network Time
Protocol (NTP).
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example executes show ntp status:
>enable
#show ntp status

show output-chkdsk
Use the show output-chkdsk command to display output from the CFLASH checkdisk that occurs at boot
up. File allocation table (FAT) errors detected or repaired are shown from the last boot up using this
command. If checkdisk passed without incident, the command displays the output File is empty. This
command is only applicable to ADTRAN integrated communications products (ICPs).
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show output-chkdsk command where checkdisk passed:
>enable
#show output-chkdsk
File is empty.
The following example provides output from the show output-chkdsk command where errors were
detected and repaired. An explanation of the errors found follows the output:
>enable
#show output-chkdsk
## 'SystemDefaultPrompts' The '.' entry has a non-zero size (repaired).
## 'SystemDefaultPrompts' The '..' entry points to cluster 2 (should be root directory - repaired).
## Cluster 583 chains to 435, but 583 is already used in another chain.
## Terminated subsequent instance of cross-linked chain starting at 205 at cluster 394.
## 'VoiceMail' The '.' first entry was not found.
## 'VoiceMail' Found 2 checksum mismatches (repaired).
## 'VoiceMail/Messages' Found 3 trailing entries (repaired).
## 'VoiceMail' Found 2 duplicate entries (repaired).

The following errors are minor and can be ignored.
## '/SystemDefaultPrompts' The '.' entry has a non-zero size (repaired).

## 'SystemDefaultPrompts' The '..' entry points to cluster 2 (should be root directory - repaired).
The following errors are more serious, but have been repaired. They indicate that the FAT has been
corrupted. In some instances, major files may be lost (if they were corrupt or were contained within a
corrupt directory).
## Found 20 orphaned clusters (not free and not used - repaired).

## Cluster 583 chains to 435, but 583 is already used in another chain.
## Terminated subsequent instance of cross-linked chain starting at 205 at cluster 394.
The following error results in the removal of the entire directory:
## 'VoiceMail' The '.' first entry was not found.
The following errors are minor. They indicate that some corruption has occurred, specifically with the
naming units of the files involved. In most cases, these can be repaired without data loss.
## 'VoiceMail' Found 2 checksum mismatches (repaired).

## 'VoiceMail' Found 15 invalid names (repaired).
## 'VoiceMail/Messages' Found 3 trailing entries (repaired).
## 'VoiceMail' Found 2 duplicate entries (repaired).

show output-startup
Use the show output-startup command to display startup configuration output line by line. This output
can be copied into a text file and then used as a configuration editing tool.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show output-startup command:
>enable
#show output-startup
!
#!
#hostname "UNIT_2"
UNIT_2#no enable password
UNIT_2#!
UNIT_2#ip subnet-zero
UNIT_2#ip classless
UNIT_2#ip routing
UNIT_2#!
UNIT_2#event-history on
UNIT_2#no logging forwarding
UNIT_2#logging forwarding priority-level info
UNIT_2#no logging email
--MORE--

show port-auth
Use the show port-auth command to view port authentication information. Variations of this command
include:
show port-auth
show port-auth detailed
show port-auth detailed interface <interface>
show port-auth interface <interface>
show port-auth statistics
show port-auth statistics interface <interface>
show port-auth summary
show port-auth summary interface <interface>
show port-auth supplicant
show port-auth supplicant interface <interface>
show port-auth supplicant summary
Syntax Description
detailed Optional. Displays detailed port authentication information.
statistics Optional. Displays port authentication statistics.
summary Optional. Displays a summary of port authentication settings.
supplicant Optional. Displays port authentication supplicant information.
interface <interface> Optional. Displays port authentication information for the specified interface.
dot11ap 1/1.1. Type show port-auth interface ? for a list of valid
interfaces.
Default Values

Command History
include, and the supplicant keyword.
Usage Examples
The following example displays the port authentication information:
>enable
#show port-auth
Global Port-Authentication Parameters:
re-authentication enabled: False
reauth-period: 3600
quiet-period: 60
tx-period: 30
supp-timeout: 30
server-timeout: 30
reauth-max: 2
Port-Authentication Port Summary:
Interface Status Type Mode Authorized
---------------------------------------------------------------------------------------
eth 0/1 disabled port-based n/a n/a
Port Authentication Port Details:
Port-Authentication is disabled on eth 0/1
Port-Authentication is disabled on eth 0/2

show port-security
Use the show port-security command to display port security information. Variations of this command
include:
show port-security
show port-security address
show port-security interface <interface>
show port-security interface <interface> address
show port-security port-expiration
show port-security port-expiration detailed
Syntax Description
address Optional. Displays a list of secure medium access control (MAC) addresses
for all interfaces currently configured for port security.
interface <interface> Optional. Filters the output to include only information for the specified
dot11ap 1/1.1. Type show port-security interface ? for a complete list of
valid interfaces.
port-expiration Optional. Displays the ports currently participating in port expiration and the
amount of time left until the port is shut down.
detailed Optional. Displays information for all interfaces, even if not configured for
port expiration.
Default Values
Command History
include.

Usage Examples
The following displays all secure MAC addresses related to the Ethernet 0/1 interface:
>enable
#show port-security interface eth 0/1 address
VLAN Mac Address Type of Entry Interface Remaining Time
--------------------------------------------------------------------------------------------------------------
1 00:a0:c8:0a:c6:4a Dynamic-Secure eth 0/1 --
1 00:a0:c8:0a:c6:4b Dynamic-Secure eth 0/1 --
--------------------------------------------------------------------------------------------------------------
Dynamic Address Count: 2
Static Address Count: 0
Sticky Address Count: 0
Total Address Count: 2

show power inline

Use the show power inline command to display power information (in watts) for devices connected to
Power over Ethernet (PoE) interfaces. The command also displays the PoE interfaces that can be powered,
whether the interfaces are powered or not, and the IEEE class for the device(s) connected to the PoE
interfaces. Variations of this command include:
show power inline

show power inline <slot/port>
show power inline <slot/port> realtime
your unit.
Syntax Description
<slot/port> Optional. Specifies the slot/port of a PoE interface. If specified, the
command only displays information related to that interface.
Default Values
Command History
Release 11.1 The realtime display parameter was added.
include.

Functional Notes
page 702).
Usage Examples
The following example displays power information for all PoE interfaces:
>enable
#show power inline
Interface Admin Oper Power (watts) Class
eth 0/1 auto off n/a n/a
eth 0/2 auto off n/a n/a
--MORE--

show power-supply
The show power-supply command displays the power supply status.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays the power supply status:
>enable
#show power-supply
Power supply 1 is OK.
Power supply 2 is not present.

show pppoe
Use the show pppoe command to display all Point-to-Point Protocol over Ethernet (PPPoE) settings and
associated parameters.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example enters the Enable mode and uses the show command to display PPPoE
information:
>enable
#show pppoe
ppp 1
Outgoing Interface: eth 0/1
Outgoing Interface MAC Address: 00:A0:C8:00:85:20
Access-Concentrator Name Requested: FIRST VALID
Access-Concentrator Name Received: 13021109813703-LRVLGAOS90W_IFITL
Access-Concentrator MAC Address: 00:10:67:00:1D:B8
Session Id: 64508
Service Name Requested: ANY
Service Name Available:
PPPoE Client State: Bound (3)
Redial retries: unlimited
Redial delay: 10 seconds
Backup enabled all day on the following days:
Sunday Monday Tuesday Wednesday Thursday Friday Saturday

show probe
Use the show probe command to display probe configuration and statistics. Refer to Network Monitor
Probe Command Set on page 2319 for information on configuring probe objects. Variations of this
show probe
show probe <name>
show probe <name> realtime
show probe responder icmp-timestamp
show probe responder icmp-timestamp realtime
show probe responder twamp
show probe responder twamp realtime
show probe responder udp-echo
show probe responder udp-echo realtime
show probe <name> statistics
show probe <name> statistics history
show probe statistics
show probe statistics history
your unit.
Syntax Description
<name> Optional. Displays configuration and statistics for a specific probe.
responder Displays the specified probe responder statistics.
icmp-timestamp Optional. Displays the Internet Control Message Protocol (ICMP) timestamp
probe responder statistics.
twamp Optional. Displays the Two-Way Active Measurement Protocol (TWAMP)
probe responder statistics.
udp-echo Optional. Clears the User Datagram Protocol (UDP) echo probe responder
statistics.
statistics Optional. Displays measured probe statistics.
history Optional. Displays the history of all measured probe statistics.

Default Values
Command History
include.
Release 17.2 Command was expanded to include the probe responder options.
Functional Notes
A probe must be created first using the probe command. Issuing the shutdown command at the probe
configuration prompt will disable a probe, causing it to cease traffic generation. While a probe is shutdown,
it will not fail.
page 702).
Usage Examples
The following is sample output of the show probe probe_A command:
>enable
#show probe probe_A
Current State: PASS Admin. Status: DOWN
Type: ICMP Echo Period: 30 sec Timeout: 500 msec
Hostname: www.adtran.com
Tracked by: track_1
Tests Run: 121 Failed: 0
Time in current state: 25 days 2 hours, 34 minutes, 32 seconds
The following is sample output of the show probe responder twamp command:
>enable
#show probe responder twamp
0--------------1----------------2----------------3----------------4---------------5----------------6----------------7---------------8
12345678901234567890123456789012345678901234567890123456789012345678901234567890
TWAMP-Test: 360 rcvd, 360 sent
TWAMP-Control: 20 sessions opened, 18 sessions closed,
3 sessions rejected, 2 sessions active

The following is sample output of the show probe responder icmp-timestamp command:
>enable
#show probe responder icmp-timestamp
0--------------1----------------2----------------3----------------4---------------5----------------6----------------7---------------8
12345678901234567890123456789012345678901234567890123456789012345678901234567890
ICMP Timestamp: 125 rcvd, 125 sent
The following is sample output of a TWAMP type probe named Houston:
>enable
#show probe Houston
0--------------1----------------2----------------3----------------4---------------5----------------6----------------7---------------8
12345678901234567890123456789012345678901234567890123456789012345678901234567890
Probe Houston:
Current State: PASS Admin. Status: UP
Type: TWAMP Period: 60 Timeout: 1500
Source: 192.168.1.255:17001 Destination: 10.10.20.254:17000
Data Size: 14 Num-packets 100 DSCP: 0
Data pad: Zero
Send-schedule: 20 msec Type: periodic
Authentication Mode: open Key: not set
Tracked by: Nothing
Tests Run: 194 Failed: 1
Tolerance: not set
Time in current state: 1 days, 2 hours, 50 minutes, 7 seconds
Packet Loss fail pass
Round Trip 1000 1000

show processes
Use the show processes command to display process statistic information. Variations of this command
include:
show processes cpu

show processes cpu realtime
show processes history
show processes queue
show processes stack
your unit.
Syntax Description
cpu Displays information about processes that are currently active.
realtime Optional. Displays full-screen CPU output in real time. Refer to the
history Displays the process switch history.
queue Displays process queue utilization.
stack Displays the process stack usage.
Default Values
Command History
Release 10.1 New option was introduced.
include.
Release 17.5 Command was expanded to include the stack parameter.

Functional Notes
page 702).
Usage Examples
The following is sample output from the show processes cpu command:
>enable
#show processes cpu
processes cpu
System load: 7.07% Min: 0.00% Max 85.89%
Context switch load: 0.21%
Task Task Invoked Exec Time Runtime Load%
D Name PRI STAT (count) (μsec) (μsec) (1 sec)
0 Idle 0W 129689 1971 927923 92.79
1 FrontPanel 249 W 9658 165 3202 0.32
3 Stack Usage 11 W 485 305 325 0.03
4 Q Test 1 10 W 50 4 0 0.00
5 Q Test 2 11 W 50 6 0 0.00
--MORE--

show qos
Use the show qos command to display information regarding quality of service (QoS) and 802.1p class of
service (CoS) settings. Variations of this command include:
show qos cos-map

show qos dscp-cos
show qos interface <interface>
show qos queuing
Syntax Description
cos-map Displays the CoS priority-to-queue map. The map outlines which CoS
priority is associated with which queue.
dscp-cos Displays the differentiated services code point (DSCP) to CoS map
settings.
interface <interface> Displays the configured values for default CoS and trust settings on a
specific interface. Specify an interface in the format <interface type [slot/port
| slot/port.subinterface id | interface id | interface id.subinterface id | ap |
dot11ap 1/1.1. Type show qos interface ? for a complete list of valid
interfaces.
queuing Displays the type of queuing being used. If weighted round robin (WRR)
queuing is enabled, the command also displays the weight of each queue.
Default Values
Command History
Release 7.1 Command was expanded to include the dscp-cos parameter.
include.

Usage Examples
The following is sample output from the show qos cos-map command:
>enable
#show qos cos-map
CoS Priority: 0 1 2 3 4 5 6 7
Priority Queue: 1 1 2 2 3 3 4 4
The following is sample output from the show qos interface command for Ethernet 0/8 interface:
>enable
#show qos interface ethernet 0/8
Ethernet 0/8
trust state: trusted
default CoS: 0
The following is sample output from the show qos queuing command with WRR queuing enabled:
>enable
#show qos queuing
Queue-type: wrr
Expedite queue: disabled
wrr weights:
qid - weight
1 - 12
2 - 45
3 - 55
4 - 65

show qos map

The show qos map command outputs information about the quality of service (QoS) map. This
information differs based on how a particular map entry is defined. Variations of this command include the
following:
show qos map

show qos map <name>
show qos map <name> <number>
show qos map interface <interface>
Syntax Description
<name> Optional. Specifies the name of a defined QoS map.
<number> Optional. Specifies one of the map’s defined sequence numbers.
interface <interface> Optional. Displays the QoS map information for a specific interface. Specify
| interface id | interface id.subinterface id | ap | ap/radio | ap/radio.vap]>. For
show qos map interface ? command for a complete list of interfaces.
Default Values
Command History
interface.
include.

Usage Examples
The following example shows all QoS maps and all entries in those maps:
>enable
#show qos map
qos map priority
map entry 10
match IP packets with a precedence value of 6
priority bandwidth: 400 (kilobits/sec) burst: default
map entry 20
match ACL icmp
map entry 30
match RTP packets on even destination ports between 16000 and 17000
map entry 50
match ACL tcp
map entry 60
match IP packets with a dscp value of 2
set dscp value to 6
map entry 70
match NetBEUI frames being bridged by the router
qos map tcp_map
map entry 10
match ACL tcp
set precedence value to 5
map entry 20
The following example shows the QoS map named priority and all entries in that map:
>enable
#show qos map priority
qos map priority
map entry 10
map entry 20
match ACL icmp
map entry 30
match RTP packets on even destination ports between 16000 and 17000
map entry 50
match ACL tcp
map entry 60
match IP packets with a dscp value of 2

set dscp value to 6

map entry 70
match NetBEUI frames being bridged by the router
The following example shows only QoS map named priority with the sequence number 10:
>enable
#show qos map priority 10
qos map priority
map entry 10
The following examples show QoS map interface statistics associated with the applied map for the Frame
Relay 1 interface:
>enable
#show qos map interface frame-relay 1
fr 1
qos-policy out: priority
map entry 10
budget 145/10000 bytes (current/max)
priority bandwidth: 400 (kilobits/sec)
packets matched on interface: 27289
packets dropped: 0
map entry 20
match IP packets with a DSCP value of af41
class bandwidth: 40 (% of remaining)
conversation: 235
packets matched: 23457
packets dropped: 0

show queue <interface>

Use the show queue command to display conversation information associated with an interface queue.
This command shows summary and per-conversation information. The per-conversation details are only
displayed if the interface has sufficient traffic to be congested and packets are being held in the interface
queue. Variations of this command include:
show queue <interface>

show queue <interface> child
Syntax Description
<interface> Displays the queueing information for the specified interface. Specify an
the show queue ? command to display a list of valid interfaces.
child Optional. Displays the subqueue statistics.
Default Values
Command History
interface.
include.
Release 17.4 Command was expanded to include the child keyword.
Release 17.5 Command was expanded to include the asynchronous transfer mode
(ATM) and Frame Relay interfaces.

Usage Examples
The following is sample output from the show queue command:
>enable
#show queue ethernet 0/2
Queueing method: weighted fair
Output queue: 4/222/540/64/176 (size/highest/max total/threshold/drops)
Conversations 0/4/256 (active/max active/max total)
Available Bandwidth 15000 kilobits/sec
(depth/weight/matches/discards) 4/32768/32456/0
Conversation 178, linktype: ip, length: 936
source: 10.22.13.34, destination: 10.22.2.3, id: 0xddc6, ttl: 127,
TOS: 0 prot: 6 (tcp), source port 1086, destination port 20

show queuing
Use the show queuing command to display information associated with configured queuing methods.
show queuing
show queuing fair
Syntax Description
fair Optional. Displays only information on the weighted fair queuing
configuration.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show queuing command:
>enable
#show queuing
Interface Discard threshold Conversation subqueues
fr 1 64 256
fr 2 64 256
ppp 1 64 256

show radius statistics

Use the show radius statistics command to display various statistics from the remote authentication
dial-in user service (RADIUS) subsystem. These statistics include number of packets sent, number of
invalid responses, number of timeouts, average packet delay, and maximum packet delay. Statistics are
shown for both authentication and accounting packets.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is an example output using the show radius statistics command:
>enable
#show radius statistics
Auth. Acct.
Number of packets sent: 3 0
Number of invalid responses: 0 0
Number of timeouts: 0 0
Average delay: 2 ms 0 ms
Maximum delay: 3 ms 0 ms

show ramdisk
Use the show ramdisk command to display a list of all files currently stored in volatile RAM disk memory
or details about a specific file stored in RAM disk memory. Variations of this command include:
show ramdisk
show ramdisk <filename>
Not all units are capable of using a RAM disk file system. Use the show ? command to
display a list of valid commands at the enable prompt.
Syntax Description
<filename> Optional. Displays details for a specified file located in RAM disk file
system. Enter a wildcard (such as *.biz) to display the details for all files
matching the entered pattern.
Default Values
Command History
Release 17.7 Command was introduced for AOS units limited to only 16 Megabytes of
flash memory.
Usage Examples
The following is a sample show ramdisk output displaying the contents of the RAM disk, space occupied
by each file, the total RAM disk space allocated, available space, and used space:
>enable
#show ramdisk
10005125 NV3130A-17-07-00-26-AE.biz

show route-map
Use the show route-map command to display any route maps that have been configured in the router. This
command displays any match and set clauses associated with the route map, as well as the number of
incoming routes that have matched each route map. Route maps can be used for Border Gateway Protocol
(BGP) and PBR. Variations of this command include:
show route-map
show route-map <name>
Syntax Description
<name> Optional. Displays only the route map matching the specified name.
Default Values
By default, this command displays all defined route-maps.
Command History
include.
Usage Examples
In the example below, all route-maps in the router are displayed.
>enable
#show route-map
route-map RouteMap1, permit, sequence 10
Match clauses:
community (community-list filter): CommList1
Set clauses:
local-preference 250
Match clauses:
community (community-list filter): CommList2
Set clauses:

local-preference 350
Match clauses:
ip address (access-lists): Acl1
Set clauses:
metric 100
Match clauses:
Set clauses:
metric 200
Match clauses:
length 150 200
Set clauses:
ip next-hop: 10.10.11.254
Match clauses:
Set clauses:
ip next-hop: 10.10.11.14
In the example below, only RouteMap2 is displayed.
>enable
#show route-map RouteMap2
Match clauses:
Set clauses:
metric 100
--MORE--

show rtp resources

Use the show rtp resources command to display Realtime Transfer Protocol (RTP) resource information.
show rtp resources

show rtp resources debug
Syntax Description
debug Optional. Activates the RTP resources event debug messages.
Default Values
Command History
include.
Usage Examples
The following is sample output for the show rtp resources command:
>enable
#show rtp resources
DSP Channel Type Port Status
------------------------------------------------------------------------
0/1 1 RTP N/A Available
--MORE--

show running-config
Use the show running-config command to display all the nondefault parameters contained in the current
running configuration file. Specific portions of the running configuration may be displayed, based on the
command entered. Variations of this command include the following:
show running-config
show running-config access-lists
show running-config access-lists verbose
show running-config checksum
show running-config interface <interface>
show running-config interface <interface> verbose
show running-config ip-crypto
show running-config ip-crypto verbose
show running-config ip mgcp
show running-config ip mgcp verbose
show running-config ip nat pool
show running-config ip nat pool verbose
show running-config ip rtp
show running-config ip rtp verbose
show running-config ip sdp
show running-config ip sdp verbose
show running-config ip security monitor
show running-config ip security monitor verbose
show running-config ip sip
show running-config ip sip verbose
show running-config ip urlfilter
show running-config policy-class
show running-config policy-class verbose
show running-config probe
show running-config probe verbose
show running-config qos-map
show running-config qos-map verbose
show running-config quality-monitoring
show running-config quality-monitoring verbose
show running-config router bgp
show running-config router pim-sparse
show running-config router pim-sparse verbose
show running-config track
show running-config track verbose
show running-config verbose

Syntax Description
access-lists Optional. Displays the current running configuration for all configured IP
access control lists (ACLs).
checksum Optional. Displays the encrypted message digest 5 (MD5) version of the
running configuration.
interface <interface> Optional. Displays the current running configuration for a particular
dot11ap 1/1.1. Type show running-config interface ? for a complete list
ip-crypto Optional. Displays the current running configuration for all Internet Protocol
security (IPsec) virtual private network (VPN) settings.
ip mgcp Optional. Displays the current running configuration for all Media Gateway
Control Protocol (MGCP) parameters.
ip nat pool Optional. Displays the current running configuration for IP network address
translation (NAT) pool parameters.
ip rtp Optional. Displays the current running configuration for all IP Realtime
Transport Protocol (RTP) parameters.
ip sdp Optional. Displays the current running configuration for all Session
Description Protocol (SDP) parameters.
ip security monitor Optional. Displays the current running configuration for all IP security
monitor parameters.
ip sip Optional. Displays the current running configuration for all IP Session
Initiation Protocol (SIP) parameters.
ip urlfilter Optional. Displays the current running configuration for all IP uniform
resource locator (URL) filters.
policy-class Optional. Displays the current running configuration for all configured IP
policy classes.
probe Optional. Displays the current configuration for all running probes.
qos-map Optional. Displays the current running configuration for all configured
quality of service (QoS) maps.

quality-monitoring Optional. Displays the current running configuration for voice quality
monitoring (VQM).
router bgp Optional. Displays the current Border Gateway Protocol (BGP)
configuration.
router pim-sparse Optional. Displays the current global protocol-independent multicast-sparse
mode (PIM-SM) configuration.
track Optional. Displays the current running configuration for all tracks.
verbose Optional. Displays the entire running configuration to the terminal screen
Default Values
Command History
Release 11.1 Demand, foreign exchange office (FXO), and serial interfaces were added.
The ip-crypto and router pim-sparse keywords were added.
Release 13.1 Command was expanded to include the ip rtp, ip sdp, probe and track
subcommands+.
include, and the ip urlfilter and quality-monitoring keywords.
Release A1 Command was introduced in the AOS voice products.
Release A2 Command was expanded to include the mgcp parameter.
Release 17.4 Command was expanded to include the ip nat pool parameter.
Release 17.5 Command was expanded to include the security monitor parameter.
Usage Examples
The following is sample output from the show running-config command:
>enable
#show running-config
!
no enable password
!
ip subnet-zero
ip classless
ip routing
!
event-history on


no logging email
!
!ip policy-timeout tcp all-ports 600
!
interface eth 0/1
--MORE--

show running-config voice

Use the show running-config voice command to show running voice configurations. Variations of this
show running-config voice

show running-config voice ani
show running-config voice ani verbose
show running-config voice ani-list
show running-config voice ani-list verbose
show running-config voice ani-list <name>
show running-config voice ani-list <name> verbose
show running-config voice autoattendant
show running-config voice autoattendant verbose
show running-config voice class-of-service
show running-config voice class-of-service verbose
show running-config voice class-of-service <name>
show running-config voice class-of-service <name> verbose
show running-config voice directory
show running-config voice directory verbose
show running-config voice grouped-trunk
show running-config voice grouped-trunk verbose
show running-config voice grouped-trunk <name>
show running-config voice grouped-trunk <name> verbose
show running-config voice line
show running-config voice line verbose
show running-config voice line <number>
show running-config voice line <number> verbose
show running-config voice mail
show running-config voice mail verbose
show running-config voice match
show running-config voice match ani
show running-config voice match ani verbose
show running-config voice mgcp-endpoint
show running-config voice mgcp-endpoint verbose
show running-config voice mgcp-endpoint <index>
show running-config voice mgcp-endpoint <index> verbose
show running-config voice named-digit-timeouts
show running-config voice named-digit-timeouts verbose
show running-config voice named-digit-timeouts <name>
show running-config voice named-digit-timeouts <name> verbose
show running-config voice operator-group
show running-config voice operator-group verbose
show running-config voice paging-group
show running-config voice paging-group verbose
show running-config voice paging-group <extension>

show running-config voice paging-group <extension> verbose

show running-config voice ring-group
show running-config voice ring-group verbose
show running-config voice ring-group <name>
show running-config voice ring-group <name> verbose
show running-config voice speed-dial
show running-config voice speed-dial verbose
show running-config voice spre
show running-config voice spre verbose
show running-config voice spre-map
show running-config voice spre-map verbose
show running-config voice status-group
show running-config voice status-group verbose
show running-config voice status-group <name>
show running-config voice status-group <name> verbose
show running-config voice trunk
show running-config voice trunk verbose
show running-config voice trunk <Txx>
show running-config voice trunk <Txx> verbose
show running-config voice trunk-list
show running-config voice trunk-list verbose
show running-config voice trunk-list <name>
show running-config voice trunk-list <name> verbose
show running-config voice user
show running-config voice user verbose
show running-config voice user <number>
show running-config voice user <number> verbose
show running-config voice user <name>
show running-config voice user <name> verbose
show running-config voice user <name> <last name>
show running-config voice user <name> <last name> verbose
show running-config voice verbose
Syntax Description
ani Optional. Displays automatic number identification (ANI) substitution
configurations.
ani-list Optional. Displays all ANI list configurations.

ani-list <name> Optional. Deploys a specific ANI list configuration.

autoattendant Optional. Displays auto attendant configuration.
class-of-service Optional. Displays all voice class of service (CoS) configurations.
class-of-service <name> Optional. Displays voice CoS configurations for the specified rule set.
directory Optional. Displays voice directory configuration.
grouped-trunk Optional. Displays all voice trunk group configurations.
grouped-trunk <name> Optional. Displays voice trunk group configurations for the specified trunk.
line Optional. Displays the voice line configuration.
line <number> Optional. Displays the voice line configuration for a specified extension.
mail Optional. Displays voicemail configuration.
match Optional. Displays all substitution configurations.
match ani Optional. Displays ANI substitution configurations.
mgcp-endpoint Optional. Displays all Media Gateway Control Protocol (MGCP) endpoint
configurations.
mgcp-endpoint <index> Optional. Displays a specific MGCP endpoint configuration.
named-digit-timeouts Optional. Displays all named-digit-timeouts.
named-digit-timeouts <name> Optional. Displays configuration for the specified named-digit-timeout.
operator-group Optional. Displays operator group configuration.
paging-group Optional. Displays all handset paging group configurations.
paging-group <extension> Optional. Displays handset paging group configuration for the specified
paging group.
ring-group Optional. Displays all configured ring groups.
ring-group <name> Optional. Displays ring group configurations for the specified ring group.
speed-dial Optional. Displays all entries for speed-dial entries.
spre Optional. Displays entire special prefix (SPRE) related configuration,
including mode, overrides, local maps, and network template.
spre-map Optional. Displays only the SPRE mapping configuration.
status-group Optional. Displays all status group information.
status-group <name> Optional. Displays information on the specified status group.
trunk Optional. Displays all voice trunk configurations.
trunk <Txx> Optional. Displays voice trunk configurations for the specified trunk. Use
the trunk's 2-digit identifier following T (for example, T99).
trunk-list Optional. Displays all trunk list configurations.
trunk-list <name> Optional. Displays a specific trunk list configuration.
user Optional. Displays all configured voice users.
<number> Optional. Displays voice user configurations for the specified number.
<name> Optional. Displays voice user configurations for the specified name. Enter
the first or last name.
<last name> Optional. Displays voice user configurations for the specified name. Enter
the last name only.

verbose Optional. Displays detailed information on all or on the specified voice

running configurations.
Default Values
Command History
Release 11.1 Command was expanded.
include.
Release A2 Command was expanded to include the ani-list, match, mgcp-endpoint,
named-digit-timeouts, trunk-list, and user parameters.
Release A2.03 Command was expanded to include the spre and spre-map parameters.
Release A2.04 Command was expanded to include the paging-group parameter.
Usage Examples
The following example shows sample output from the show running-config voice command:
>enable
#show running-config voice
!
voice hold-reminder 15
voice flashhook mode interpreted
!
voice dial-plan 1 local 8000
!
voice class-of-service set1
billing-codes
!
voice class-of-service set2
!
voice class-of-service “set 1"
!
voice codec-list trunk
default
codec g711ulaw
codec g729

!
voice codec-list “list 1"
!
voice codec-list list1
!
voice trunk T99 type t1-rbs supervision wink role network
!
voice trunk T01 type sip
!
!
!
!
voice trunk T12 type sip
!
voice grouped-trunk TEST
no description
reject 900XXXXXXX
!
voice grouped-trunk TESTGROUP
no description

show schedule
Use the show schedule command to display information regarding the schedule configuration.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample from the show schedule command:
>enable
#show schedule
Schedule entry: DELAY-AFTER-BOOT (active)
Schedule entry: DELAY (inactive)
Technology Review
The scheduler provides a method for configuring a feature to operate during a specific time schedule and
to receive feedback when the feature should disable or enable. The goal of the scheduler is to eliminate
redundant code while providing an understandable, streamlined application program interface (API) for
rapid feature development with schedules. The show schedule command displays how many features are
scheduled and whether they are active or inactive.

show sfp-info interface gigabit-switchport <slot/port>

Use the show sfp-info interface gigabit-switchport command to display small form-factor pluggable
(SFP) transceiver module serial ID information for the specified interface. This command is valid only on
Gigabit Ethernet switchport interfaces.
Syntax Description
<slot/port> Specifies a Gigabit Ethernet switchport interface slot and port number.
Default Values
Command History
Functional Notes
Fields in the show command output reported as Unspecified are not applicable to the module type. Refer
to the Usage Examples for more information.
Usage Examples
The following is sample output from the show sfp-info interface gigabit-switchport <slot/port>
command:
>enable
#show sfp-info interface gigabit-switchport 0/25
SFP Manufacturer: FINISAR CORP.

Identifier: SFP Transceiver
Connector: LC
SONET Compliance Code: Unspecified
Gigabit Ethernet Compliance Code: 100BASE-SX
Fiber Channel Link Length: Intermediate Distance <I>
Fiber Channel Transmitter Technology: Shortwave laser w/o OFC <SN>
Fiber Channel Transmitter Media: Multi-Mode, 62.5m <M6>
Fiber Channel Speed: 200 MB/sec
Encoding: 8B10B

Nominal Bit Rate: 2100 Mb/s

Supported Single-Mode Link Length <Km units>: Unspecified
Supported Single-Mode Link Length <100m units>: Unspecified
Supported Multi-Mode <50micron> Link Length <10m units>: 30
Supported Multi-Mode <62.5micron> Link Length <10m units>: 15
Supported Link Length Copper: Unspecified
Vendor OUI: 00:90:65
Vendor Part Number: FTRJ8519P1BNL
Vendor Revision: A
Options: LOS, TX_DISABLE
Bitrate, Max: Unspecified
Bitrate, Min: Unspecified
Vendor Serial Number: PA41HCB
Datecode: Jul 31. 2005

show sip
Use the show sip command to display Session Initiation Protocol (SIP) statistical and registration
show sip resources

show sip statistics
show sip user-registration
Syntax Description
resources Displays SIP server resource information.
statistics Displays SIP server statistic information.
user-registration Displays local SIP server registration information.
Default Values
Command History
Release 11.1 Resources, statistics, and user-registration parameters were added.
Release 15.1 Name-service name-table parameter was added.
include.
Release 17.3 Command was altered to remove the name-service name-table
parameter, which was replaced with the show voip name-service
name-table command.
Usage Examples
The following example shows sample output from the show sip statistics command:
>enable
#show sip statistics
Invites transmitted: 36
Invites received: 26
Invite Retransmits transmitted: 11

Invite Retransmits received: 0

Non-Invites transmitted: 1869
Non-Invites received: 1911
Non-Invite Retransmits transmitted: 12

Non-Invite Retransmits received: 41
Responses transmitted: 1982

Responses received: 3535
Response Retransmits transmitted: 45

Response Retransmits received: 0
The following example shows sample output from the show sip user-registration command:
>enable
#show sip user-registration
EXT. TYPE IP ADDRESS PORT EXP

---------- ------------------ -------------- ------ -----
9001 SIP - Generic 1.1.1.2 5060 25
9002 SIP - Generic 10.10.10.2 5060 3419
Total phones registered: 2

show sip location

Use the show sip location command to display Session Initiation Protocol (SIP) statistical and registration
show sip location

show sip location dynamic
show sip location static
Syntax Description
dynamic Optional. Displays SIP location database dynamic entries.
static Optional. Displays SIP location database static entries.
Default Values
Command History
Release 12.1 Command output was updated.
include.
Usage Examples
The following example shows sample output from the show sip location static command:
>enable
#show sip location static
User IP Address Port Expires Source
-----------------------------------------------------------------------------
9001 1.1.1.2 5060 52 Registrar
9002 10.10.10.2 5060 3336 Registrar

show sip proxy

Use the show sip proxy command to display Session Initiation Protocol (SIP) proxy statistical and
registration information. Variations of this command include:
show sip proxy resources

show sip proxy resources realtime
show sip proxy user
show sip proxy user extended
show sip proxy user realtime
show sip proxy user verbose
your unit.
Syntax Description
resources Displays SIP proxy resource information.
user Displays SIP proxy user database information.
extended Optional. Displays the extended form of SIP proxy user database.
realtime Optional. Displays SIP proxy information in real time. Refer to the
Default Values
Command History
include.
Release 17.3 Command was expanded to include the extended modifier.
Release A2.03 Command was expanded to include the verbose modifier.

Functional Notes
page 702).
Usage Examples
The following example shows sample output from the show sip proxy resources command:
>enable
#show sip proxy resources
Type Name Allocated Currently in Use Max Used

-----------------------------------------------------------------------------------------------------------------------
Proxy proxyPoolElements 630 0 0

show sip trunk-registration

Use the show sip trunk-registration command to display Session Initiation Protocol (SIP) statistical and
registration information. Variations of this command include the following:
show sip trunk-registration

show sip trunk-registration realtime
show sip trunk-registration <Txx>
show sip trunk-registration <Txx> realtime
show sip trunk-registration <Txx> <name>
show sip trunk-registration <Txx> <name> realtime
your unit.
Syntax Description
<Txx> Optional. Specifies the trunk identity; where xx is the trunk’s two-digit
identifier (e.g., T01).
<name> Optional. Specifies the name associated with the trunk.
realtime Optional. Displays local SIP client registration information in real time. Refer
to the Functional Notes below for more information.
Default Values
Command History
include.

Functional Notes
page 702).
Usage Examples
The following example shows sample output from the show sip trunk-registration command:
>enable
#show sip trunk-registration
Ext Register Expire Grant Success Redirect Challenge Failed Timeout

---------------------------------------------------------------------------------------------------------------------------
4433 NO 0 0 0 0 0 0 #

show snmp
Use the show snmp command to display the system Simple Network Management Protocol (SNMP)
current configuration. Variations of this command include the following:
show snmp engineID

show snmp group
show snmp user
Syntax Description
engineID Displays the hex string that defines the current local engine ID settings.
group Displays the list of all groups entered.
user Displays the list of all users entered.
Default Values
Command History
Release 13.1 Command was expanded to include the engineID, group, and user
options.
include.
Usage Examples
The following is sample output using the show snmp command for a system with SNMP disabled, and the
default chassis and contact parameters:
>enable
#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
The following is sample output of the show snmp group command for a situation in which a group called
securityV3auth was defined (via the snmp-server group command) using version 3 and authentication,
and no access control list:
>enable
#show snmp group
Group: securityV3auth Security Model: v3
Read View: default Write View: <not specified>
Notify View: default

show sntp
Use the show sntp command to display the system Simple Network Time Protocol (SNTP) parameters and
current status of SNTP communications.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays the SNTP parameters and current status:
>enable
#show sntp

show spanning-tree
Use the show spanning-tree command to display the status of the spanning-tree protocol. Variations of
show spanning-tree
show spanning-tree <number>
show spanning-tree detail
show spanning-tree detail active
show spanning-tree realtime
show spanning-tree <number> realtime
show spanning-tree summary
Using the realtime argument for this command may adversely affect system performance
and should be used with discretion.
Syntax Description
<number> Optional. Displays spanning tree for a specific bridge group. This command is
only applicable to routers configured for bridging.
detail Optional. Displays detailed spanning tree information.
active Optional. Displays detailed information about all active interfaces.
realtime Optional. Displays full-screen spanning tree information in real time.
summary Optional. Displays a summary of all port states.
Default Values
Command History
Release 10.1 Command was expanded to include the realtime parameter.
include.
Release 17.5 Command was expanded to include the detail, active, and summary
keywords.

Functional Notes
page 702).
Usage Examples
The following is an example output using the show spanning-tree command:
>enable
#show spanning-tree
Spanning Tree enabled protocol ieee
Root ID Priority 32768
Address 00:a0:c8:00:88:41
We are the root of the spanning tree
Hello Time 2 sec Max Age 20 sec Forward Delay 15 sec
Bridge ID Priority 32768
Address 00:a0:c8:00:88:41
Aging Time 300
Interface Role Sts Cost Prio. Nbr. Type
eth 0/2 Desg FWD 19 128.2 P2p
giga-eth 0/1 Desg FWD 4 128.25 P2p
giga-eth 0/2 Desg FWD 4 128.26 P2p

show spanning-tree active

Use the show spanning-tree active command to display the spanning-tree status on active interfaces only.
show spanning-tree active

show spanning-tree active detail
Syntax Description
detail Optional. Displays the spanning-tree protocol status in detail.
Default Values
Command History
include.
Usage Examples
The following is an example output using the show spanning-tree active command:
>enable
#show spanning-tree active
Spanning Tree enabled protocol ieee
Root ID Priority 32768
Address 00:a0:c8:00:88:41
We are the root of the spanning tree
Bridge ID Priority 32768
Address 00:a0:c8:00:88:41
Aging Time 300
--MORE--

show spanning-tree blockedports

Use the show spanning-tree blockedports command to display ports that are currently in a blocked state.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is an example output using the show spanning-tree blockedports command:
>enable
#show spanning-tree blockedports
Blocked Interfaces List
------------------------------------
eth 0/3
giga-eth 0/2
p-chan 1
Number of blocked ports (segments) in the system: 3

show spanning-tree interface <interface>

Use the show spanning-tree interface command to display spanning-tree protocol information for a
particular interface. Variations of this command include:
show spanning-tree interface <interface>

show spanning-tree interface <interface> active
show spanning-tree interface <interface> active detail
show spanning-tree interface <interface> cost
show spanning-tree interface <interface> edgeport
show spanning-tree interface <interface> priority
show spanning-tree interface <interface> rootcost
show spanning-tree interface <interface> state
Syntax Description
dot11ap 1/1.1. Type show spanning-tree interface ? for a complete list of
valid interfaces.
active Optional. Displays information for an active interface.
active detail Optional. Displays detailed spanning-tree protocol information for an active
interface.
cost Optional. Displays only spanning-tree protocol path cost information.
edgeport Optional. Displays information for all interfaces configured as edgeports.
priority Optional. Displays only spanning-tree protocol priority information.
rootcost Optional. Displays only spanning-tree protocol root path cost information.
state Optional. Displays only spanning-tree protocol state information.
Default Values

Command History
include.
Usage Examples
The following is an example output using the show spanning-tree interface ethernet command:
>enable
#show spanning-tree interface ethernet 0/2
Interface Role Sts Cost Prio. Nbr. Type
------------------- ------------------- ------------------ ----------- ------------- ---------------
eth 0/2 Desg LIS 19 128.2 P2p

show spanning-tree pathcost method

Use the show spanning-tree pathcost method command to display the default pathcost method being
used.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output using the show spanning-tree pathcost method command. In this case,
32-bit values are being used when calculating path costs:
>enable
#show spanning-tree pathcost method
Spanning tree default pathcost method used is long

show spanning-tree root

Use the show spanning-tree root command to display information regarding the spanning-tree protocol
root. Variations of this command include:
show spanning-tree root

show spanning-tree root address
show spanning-tree root cost
show spanning-tree root detail
show spanning-tree root forward-time
show spanning-tree root hello-time
show spanning-tree root id
show spanning-tree root max-age
show spanning-tree root port
show spanning-tree root priority
show spanning-tree root priority system-id
Syntax Description
address Optional. Displays the address of the spanning-tree root.
cost Optional. Displays the path cost of the spanning-tree root.
detail Optional. Displays the spanning-tree root information in detail.
forward-time Optional. Displays the forward-time of the spanning-tree root.
hello-time Optional. Displays the hello-time of the spanning-tree root.
id Optional. Displays the ID of the spanning-tree root.
max-age Optional. Displays the maximum age of the spanning-tree root.
port Optional. Displays the port of the spanning-tree root.
priority Optional. Displays the priority of the spanning-tree root.
priority system-id Optional. Displays the priority and system-id of the spanning-tree root.
Default Values

Command History
include.
Usage Examples
The following is an example output using the show spanning-tree root command:
>enable
#show spanning-tree root
Root ID Root Cost Hello Time Max Age Fwd Dly Root Port
-------------------- -------------- ------------- ------------ -------------- ----------------
8191 00:a0:c8:b9:bb:82 108 2 20 15 eth 0/1

show stack
Use the show stack command to view the status of all the switches configured for stacking. Displays the
mode of the switch as either master or member. If the mode is master, this command also gives the status
of the stack members. Variations of this command include:
show stack
show stack candidates
show stack candidates realtime
show stack realtime
show stack topology
show stack topology realtime
your unit.
Syntax Description
candidates Optional. Displays all units that have registered with this stack master. This
option is only available on a switch configured as a stack master.
topology Optional. Displays the stack topology. This option is only available on a
switch configured as a stack master.
realtime Optional. Displays full-screen output in real time. Refer to Functional Notes
below for more information.
Default Values
Command History
include.

Functional Notes
The stack candidates are a list of units that could be added to the stack. They are not yet members.
page 702).
Usage Examples
The following example displays the configuration of the switch stack while in stack-master mode:
>enable
#show stack
Stack mode is MASTER
Management Vlan is 2386, firmware version is 08.00.18.D
Stack network is 169.254.0.0/24
Stack members...
Member Mac Address Mgmt IP Address Source Interface State
2 00:A0:C8:02:CF:C0 169.254.0.2 Stack port Up
3 00:A0:C8:00:8C:20 169.254.0.3 Stack port Up
#
Member Specifies the stack member's Unit ID.

Mac Address Specifies the stack member's medium access control (MAC) address.
Mgmt IP Address Specifies the stack member's IP address.
Source Interface Specifies the interface that the stack member was learned from.
State Specifies the stack member’s state: Up (member is up and functioning
properly); Down (member was at one time functioning, but contact has
been lost); Waiting (waiting for the unit to register; when registered, it will
be added to the stack); Denied (the unit could not be added to the stack
because the stack protocol versions were not compatible).
The following example displays the configuration of the switch stack while in stack-member mode:
>enable
#show stack
Stack mode is STACK-MEMBER
My Unit ID is 3, management Vlan is 2386
Stack management network is 169.254.0.0/24
Stack Master info:
Master is “Switch”, learned via giga-eth 0/1
IP address is 169.254.0.1, MAC address is 00:DE:AD:00:65:83
#

The following example displays all units that have registered with this stack-master:
>enable
#show stack candidates
Displaying all known Stack candidates...
MAC Address System Name Source Interface AOS Revision
00:A0:C8:00:8C:20 LabSwitch1 stack port 08.00.18
00:A0:C8:00:F5:6C LabSwitch2 stack port 08.00.19.D
00:A0:C8:02:CF:C0 LabSwitch3 stack port 08.00.20.D
#

show startup-config
Use the show startup-config command to display a text printout of the startup configuration file stored in
nonvolatile random access memory (NVRAM). Variations of this command include:
show startup-config
show startup-config checksum
Syntax Description
checksum Optional. Displays the message digest 5 (MD5) checksum of the unit’s
startup configuration.
Default Values
Command History
include.
Functional Notes
This command is used in conjunction with the show running-config checksum command to determine
whether the configuration has changed since the last time it was saved.
Usage Examples
The following is sample output of the show startup-config command:
>enable
#show startup-config
!
!
no enable password
!
ip subnet-zero
ip classless
ip routing
!

event-history on
no logging email
!
ip policy-timeout tcp all-ports 600
!
!
!
interface eth 0/1
speed auto
no ip address
shutdown
!
interface dds 1/1
shutdown
!
interface bri 1/2
shutdown
!
!
ip access-list standard MatchAll
permit host 10.3.50.6
permit 10.200.5.0 0.0.0.255
!
!
ip access-list extended UnTrusted
deny icmp 10.5.60.0 0.0.0.255 any source-quench
deny tcp any any
!
no ip snmp agent
!
!
!

show switchports
Use the show switchports command to display switchport information. Variations of this command
include:
show switchports
show switchports vlans
Syntax Description
vlans Optional. Displays the switchport vlan membership.
Default Values
Command History
Usage Examples
The following is sample output from the show switchports command:
>enable
#show switchports
Name: swx 0/1
Switchport: enabled
Administrative Mode: access
Access Mode VLAN (configured): 1
Trunking Native Mode VLAN: 1
Trunking VLAN GVRP Fixed: none
Port Expiration: disabled
Port Security: disabled
Protected: false

Name: swx 0/2

Switchport: enabled
Administrative Mode: access
Access Mode VLAN (configured): 1
Trunking Native Mode VLAN: 1
Trunking VLAN GVRP Fixed: none
Port Expiration: disabled
Port Security: disabled
Protected: false

show system
The show system command shows the system version, timing source, power source, and alarm relay
status.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output for the show system command:
>enable
#show system
ADTRAN, Inc. OS version 07.00.20
Checksum: 3B2FCC0F, built on Tue Jun 01 13:36:36 2004
Boot ROM version 07.00.20
Checksum: 604D, built on: Tue Jun 01 13:59:11 2004
Copyright (c) 1999-2004, ADTRAN, Inc.
Platform: Total Access 900
Serial number TechPub
Flash: 8388608 bytes DRAM: 33554431 bytes
ICP uptime is 0 days, 0 hours, 53 minutes, 50 seconds
System returned to ROM by External Hard Reset
Current system image file is “070020.biz”
Boot system image file is “070020.biz”
Power Source: AC
Primary System clock source config: t1 0/1
Secondary System clock source config: t1 0/1
Active System clock source: t1 0/1

show system mtu

Use the show system mtu command to display the current system maximum transmission unit (MTU)
setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following is sample output for the show system mtu command:
>enable
#show system mtu
MTU size is 9216 bytes

show tacacs+ statistics

Use the show tacacs+ statistics command to display terminal access controller access control system
(TACACS+) client statistics.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output for the show tacacs+ statistics command:
>enable
#show tacacs+ statistics
Authentication Authorization Accounting
Packets sent: 0 0 0
Invalid responses: 0 0 0
Timeouts: 0 0 0
Average delay: 0ms 0ms 0ms
Maximum delay: 0ms 0ms 0ms
Socket Opens: 0
Socket Closes: 0
Socket Aborts: 0
Socket Errors: 0
Socket Timeouts: 0
Socket Failed Connections: 0
Socket Packets Sent: 0
Socket Packets Received: 0

show tcp info

Use the show tcp info command to display Transmission Control Protocol (TCP) control block
information in AOS. This information is for troubleshooting and debug purposes only. For more detailed
information, you can optionally specify a particular TCP control block. When a particular TCP control
block is specified, the system provides additional information regarding crypto map settings that the show
tcp info command does not display. Variations of this command include:
show tcp info

show tcp info realtime
show tcp info <control block>
show tcp info <control block> realtime
your unit.
Syntax Description
<control block> Optional. Specifies a particular TCP control block for more detailed information.
Default Values
Command History
include.

Functional Notes
page 702).
Usage Examples
The following is a sample from the show tcp info command:
>enable
#show tcp info
TCP TCB Entries
ID STATE LSTATE OSTATE TYPE FLAGS RPORT LPORT SWIN SRT INTERFACE
0 FREE FREE FREE SRVR 0 0 0 0 0 NONE
1 LISTEN FREE FREE CONN 0 0 21 0 0 NONE
5 FREE FREE FREE SRVR 0 0 0 0 0 NONE
--MORE--

show tech
Use the show tech command to save technical information to a file named showtech.txt. Variations of this
command include:
show tech
show tech terminal
Syntax Description
terminal Optional. Displays the showtech.txt file output to the terminal screen in real
time.
Default Values
Command History
include.
Functional Notes
The show tech command runs a script that creates a showtech.txt file in flash memory that contains the
command output from the following show commands:
Not all listed show commands apply to all ADTRAN products.
show version
show modules
show flash
show cflash
show running-config verbose
show interfaces
show atm pvc

show dial-backup interfaces

show frame-relay lmi
show frame-relay pvc
show ip bgp neighbors
show ip bgp summary
show ip ospf summary-address
show ip mroute
show ip bridge
show spanning-tree
show ip interfaces
show connections
show arp
show ip traffic
show tcp info
show ip protocols
show ip route
show event-history
show output-startup
show processes cpu
show buffers
show buffers users
show memory heap
show debugging
Usage Examples
The following example creates a showtech.txt file and displays it to the terminal screen:
>enable
#show tech
Opening and applying file.....
Done.

show temperature
Use the show temperature command to display the unit temperature.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output from the show temperature command:
>enable
#show temperature
Temperature: 33 degrees C

show thresholds
Use the show thresholds command to display thresholds currently crossed for all DS1 interfaces.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is sample output of the show thresholds command.
>enable
#show thresholds
t1 1/1:
SEFS 15 min threshold exceeded
UAS 15 min threshold exceeded
SEFS 24 hr threshold exceeded
UAS 24 hr threshold exceeded
t1 1/2:
No thresholds exceeded

show toneservices resources

Use the show toneservices resources command to display digital signal processor (DSP) tone
information.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
>enable
#show toneservices resources
DSP Channel Type Port Status

-------------------------------------------------------------

show track
Use the show track command to display track object configuration and statistics. Refer to Network
Monitor Track Command Set on page 2356 for information on configuring track objects. Variations of this
show track
show track <name>
show track <name> realtime
your unit.
Syntax Description
<name> Optional. Displays information only for the track object specified.
Default Values
Command History
include.
Functional Notes
page 702).

Usage Examples
The following is sample output of the show track command:
>enable
#show track track_1
Current State: PASS
Dampening Interval: 30 seconds
Test Value: probe_A (PASS) AND probe_B (FAIL)
Track Changes: 3
Time in current state: 25 days 2 hours, 34 minutes, 32 seconds

show udp info

Use the show udp info command to display User Datagram Protocol (UDP) session information.
show udp info

show udp info realtime
show udp info <number>
show udp info <number> realtime
your unit.
Syntax Description
<number> Optional. Specifies ID of session to display. Valid range is 0 to 31.
Default Values
Command History
include.
Functional Notes
page 702).

Usage Examples
The following example shows sample output from the show udp info command:
>enable
#show udp info
UDP Session Entries
ID Local Port IP Address Socket
--- --------------- ----------------- -----------
2 520 0.0.0.0 1
3 0 0.0.0.0 4
4 161 0.0.0.0 5
5 8 127.0.0.1 7
6 10 0.0.0.0 11
7 6 127.0.0.1 16
8 4 127.0.0.1 17
9 14 127.0.0.1 18
10 12 127.0.0.1 19

show usb attached-devices

Use the show usb attached-devices command to display statistics for universal serial bus (USB) devices
attached to the USB wireless wide area network (WWAN) network interface module (NIM). The output
from this command includes the attached device identification, the product identification, the device class,
the device manufacturer and model, and the slot and port used by the device.
The NetVanta USB WWAN NIM supports cellular connections through a USB cellular
modem provided by the service provider. For more information about configuring the
NetVanta USB WWAN NIM or the cellular interface, refer to Cellular Interface Command
Set on page 1263 or the USB WWAN NIM and the Cellular Interface configuration guide
available online at http://kb.adtran.com.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following is sample output from the show usb attached-devices command:
>enable
#show usb attached-devices
USB Device attached
VendorID: 1410
ProductID: 6000
DeviceClass: 0x2 (Communications)
Manufacturer: Novatel Wireless Inc.
Product: Novatel Wireless CDMA
Slot/Port: 1/1
Number of Endpoints: 13

Endpoints: 1 INTERRUPT IN, 2 BULK IN, 2 BULK OUT, 4 BULK IN, 4 BULK OUT, 9 BULK IN, 9 BULK
OUT, 10 BULK IN, 10 BULK OUT, 5 BULK IN, 6 BULK OUT, 7 BULK IN, 8 BULK OUT
The following is sample output from the show usb attached-devices command if an unknown device is
attached to the 3G USB NIM:
>enable
USB Device attached
VendorID: 1457
ProductID: 1544
DeviceClass: 0x7 (Printer)
Manufacturer: Unknown
Product: Unknown
Serial Number: Unknown
Slot/Port: 1/1
Number of Endpoints: 0
Endpoints:
The following is sample output from the show usb attached-devices command if no USB device is
attached to the 3G USB NIM:
>enable
No USB Device attached

show users
Use the show users command to display the name (if any) and state of users authenticated by the system.
show users
show users realtime
your unit.
Syntax Description
Default Values
Command History
include.
Functional Notes
page 702).

Displayed information includes:
• Connection location (for remote connections, this includes Transmission Control Protocol (TCP)
information)
• User name of authenticated user
• Current state of the login (in process or logged in)
• Current enabled state
• Time the user has been idle on the connection
Usage Examples
The following is a sample of show users output:
>enable
#show users
- CONSOLE 0 'adtran' logged in and enabled
Idle for 00:00:00
- TELNET 0 (172.22.12.60:3998) 'password-only' logged in (not enabled)
Idle for 00:00:14
- FTP (172.22.12.60:3999) 'adtran' logged in (not enabled)
Idle for 00:00:03

show version
Use the show version command to display the current ADTRAN Operating System (AOS) version
information.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following is a sample show version output:
>enable
#show version
AOS version: 02.01.00

Checksum: 1505165C Built on: Fri Aug 23 10:23:13 2002
Upgrade key: 420987gacs9097gbdsado
BootROM version: 02.01.00
Checksum: DB85 Built on: Mon Aug 19 10:33:03 2002
Copyright 1999-2002 ADTRAN Inc.
Serial number b104
Router uptime is 0 days 3 hours 9 minutes 54 seconds

System returned to ROM by External Hard Reset
System image file is “020100.biz”

show vlan
Use the show vlan command to display current virtual local area network (VLAN) information. Variations
show vlan
show vlan brief
show vlan brief realtime
show vlan id <vlan id>
show vlan id <vlan id> realtime
show vlan name <name>
show vlan name <name> realtime
show vlan realtime
your unit.
Syntax Description
brief Optional. Shows an abbreviated version of the VLAN information (brief
description).
id <vlan id> Optional. Shows information regarding a specific VLAN, specified by a VLAN
interface ID (valid range: 1 to 4094).
name <name> Optional. Shows information regarding a specific VLAN, specified by a VLAN
interface name (up to 32 characters).
Default Values

Command History
Release 15.1 The realtime display parameter was added to show vlan id and show vlan
name.
include.
Functional Notes
page 702).
Usage Examples
The following is a sample show vlan output:
>enable
#show vlan
VLAN Name Status Ports
------------------ -------------------- -------------- -----------
-1 Default active eth 0/5, eth 0/6, eth 0/8, eth 0/13, eth 0/14, eth 0/15,
eth 0/16, eth 0/17, eth 0/18, eth 0/19, eth 0/20,
eth 0/21, eth 0/22, eth 0/23, eth 0/24, giga-eth 0/1,
giga-eth 0/2
2 accounting active eth 0/1, eth 0/2
3 VLAN0003 active eth 0/3, eth 0/4, eth 0/7, eth 0/9, eth 0/10, eth 0/11,
eth 0/12
VLAN Type MTU
------------------ --------------- --------------
-1 enet 1500
2 enet 1500
3

The following is an example of the show vlan name command that displays VLAN 2 (accounting
VLAN) information:
>enable
#show vlan name accounting
VLAN Name Status Ports
------------------- ---------------- ------------- ----------------
-2 accounting active eth 0/1, eth 0/2
VLAN Type MTU

------------------- ---------------- -------------
-2 enet 1500

show voice alias

Use the show voice alias command to display alias parameters. Aliases are used to mask identity settings,
such as names and extensions. Variations of this command include:
show voice alias

show voice alias global
show voice alias group
show voice alias system
show voice alias user
Syntax Description
global Optional. Displays global aliases.
group Optional. Displays group aliases.
system Optional. Displays system aliases.
user Optional. Displays user aliases.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show voice alias command:
>enable
#show voice alias
Alias Translation Type

----------------- --------------- ------------------
MyAlias 4433 Global
Total Displayed: 1

show voice available

Use the show voice available command to list foreign exchange station (FXS) ports that are not associated
with a user.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays FXS ports that are not associated with a user:
>enable
#show voice available
Interface
-------------
fxs 0/1
fxs 0/2

show voice conference

Use the show voice conference command to view current conference sessions. Variations of this
command include:
show voice conference local all

show voice conference local session <number>
Syntax Description
all Displays current status of all local conference sessions.
session <number> Displays current status of the specified local conference session.
Default Values
Command History
Usage Examples
The following example displays information about all local active conference sessions:
>enable
#show voice conference local all
ID Originator (FXS) Remote1 Remote2 RtpRsrc

---- ---------------------- -------------------- -------------------- -------------
1 2001 (0/1) T01 (2565551234) T02 (2568675309) 0/1.(1,2,3)
2 2004 (0/4) 2002 (FXS 0/2) 3001 (SIP) 0/2.(1,4,5)
The following example only displays information for local conference session 2:
>enable
#show voice conference local session 2
ID Originator (FXS) Remote1 Remote2 RtpRsrc

---- -------------------- -------------------- -------------------- ----------------
2 2004 (0/4) 2002 (FXS 0/2) 3001 (SIP) 0/2.(1,4,5)

show voice dial-plan

Use the show voice dial-plan command to view number display templates. Variations of this command
include:
show voice dial-plan

show voice dial-plan <number>
Syntax Description
<number> Optional. Displays information about a specific number display template.
Default Values
Command History
include.
Usage Examples
The following example displays information about number display template 1:
>enable
#show voice dial-plan 1
Type ID Pattern
------------------------------------------------------------------
Always Permitted 1 NXXNXXXXXX

show voice did

Use the show voice did command to display direct inward dialing (DID) information. Variations of this
command include:
show voice did

show voice did groups
show voice did other
show voice did users
Syntax Description
groups Optional. Displays all DID entries for ring groups.
other Optional. Displays all nonuser and nonring group DID entries.
users Optional. Displays all DID entries for users.
Default Values
Command History
include.
Usage Examples
The following example displays DID entries for ring groups:
>enable
#show voice did groups

show voice directory

Use the show voice directory command to display direct inward dialing (DID) information. Variations of
show voice directory

show voice directory <name>
Syntax Description
<name> Optional. Specifies the name on the directory to display. Only extensions
included in the specified directory will appear.
Default Values
Command History
include.
Usage Examples
The following example displays all extensions sorted by extension number:
>enable
#show voice directory
Directory Name: SYSTEM
User Name External Extension
------------------------------------------------------
John Smith 5006
Jane Doe 5005
Directory Name: Engineering

User Name External Extension
--------------------------------------------------------
John Doe Yes 5551212

show voice door-phone

Use the show voice door-phone command to display the door phone account settings. A door phone is
used to communicate with visitors prior to them entering an establishment.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show voice door-phone command:
>enable
#show voice door-phone
First Last Ext Interface Description

-------------------------------------------------------------------------------------
Front Door 4430 virtual Front Door of Building

show voice extensions

Use the show voice extensions command to display all of the current voice extensions and their status.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays all extensions and the status of the extension:
>enable
#show voice extension
AccountID Idle/Ring/Busy Available DND FWD

---------------------------------------------------------------------------------------
T01 Idle * - -
T06 Idle * - -
T02 Idle * - -
5200 Idle * - -
6000 Idle * - -
6001 Idle * - -
6002 Idle * - -
6003 Idle * - -
T03 Idle * - -
2 Idle * - -
1234 Idle * - -

show voice grouped-trunk

Use the show voice grouped-trunk command to display all voice trunk groups.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays all voice trunk groups:
>enable
#show voice grouped-trunk
Name Resource-Selection Description

---------------------------------------------------------------------------
SIP linear SIP trunk
DSX linear DSX trunk
DXS linear DXS trunk

show voice line

Use the show voice line command to display voice line stations. Variations of this command include:
show voice line

show voice line <station>
Syntax Description
<station> Optional. Displays a specific voice line station name or extension on the
system base on the valid voice line descriptors entered into the system.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show voice line command:
>enable
#show voice line
Line: 4444
Trunk: not configured
Registered Endpoints: 0
Call State: IDLE
Active Endpoints: N/A
DSP Resource: N/A
Line: Sales
Trunk: not configured
Registered Endpoints: 0
Call state: IDLE
--MORE--

show voice loopback calls

Use the show voice loopback calls command to display the status of the loopback call(s).
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example displays all voice loopback calls:
>enable
#show voice loopback calls
ID Extension Codec Status Number Duration
------------------------------------------------------------------------------------------------------------------------ (hour:min:sec)
1 1123 <ENDED (invalid number) -> 8837655 :01
2 1123 Calling -> 4001 :05
3 1123 <ENDED (no appearances) <- 4001 :01
4 1123 G729 Connected -> 4001 :07

show voice mail

Use the show voice mail command to display voice mail information for the system or a specific user.
show voice mail

show voice mail <number>
show voice mail notify-schedule <number>
Syntax Description
<number> Optional. Displays voice mail information for the specified user’s extension.
notify-schedule <number> Optional. Displays the voice mail notification schedule for the specified
user’s extension.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show voice mail command:
>enable
#show voice mail
New Num Total Time Total Time Greeting
AccountID VM COS Msg Msg Used Free Time
--------------------------------------------------------------------------------------------------------------------------------------------
1000 - - 00:00:00 00:00:00 00:00
2000 - - 00:00:00 00:00:00 00:00
2001 normal_voicemail 38 38 00:09:54 00:00:06 00:02


2016 executive_voi... 74 74 00:18:11 00:11:49 00:02
2017 executive_voi... 75 75 00:11:03 00:18:57 00:01
2020 executive_voi... 73 73 00:20:41 00:09:19 00:01
0 - - 00:00:00 00:00:00 00:00
The following is sample output for the show voice mail <number> command for extension 2017:
>enable
#show voice mail 2017
Voicemail information for account:?:5T

VM Class of Service: executive_voicemail
Standard Greeting: 00:09 Total Voicemail Usage: 00:11:04
Alternate Greeting: 00:10 Total Voicemail Free: 00:18:56
Recorded Name: 00:01
Message 1 of 75
Time/Date: 00:28:16 CST Sun Feb 07 2106
Calling Party: UNKNOWN (UNKNOWN)
Length: 00:00
Status: Old
The following is sample output for the show voice mail notify-schedule <number> command for
extension 2017:
>enable
#show voice mail notify-schedule 2017
Start End Email1 Email2

---------------------------------------------------------------------------------------------
Sun 12:00 am Mon 7:59 am ---- ----
Mon 8:00 am Thu 11:59 pm Yes ----
Fri 12:00 am Sat 11:59 pm ---- ----

show voice match

Use the show voice match command to display voice automatic number identification (ANI) substitution
parameters. Variations of this command include:
show voice match

show voice match ani <template>
Syntax Description
match Displays all substitution configurations.
ani <template> Optional. Displays a specific ANI substitution entry.
Default Values
Command History
Functional Notes
Examples and rules of use.
MATCH # SUBST #
1. 256-963-XXXX 9-963-XXXX
2. NXX-NXX-XXXX 9-1-NXX-NXX-XXXX
3. $ 9$
MATCH Number Rules -

1. All “,” characters are ignored.
2. All “[” and “]” brackets must match and contain numbers only [123].
3. If using a “$” wildcard, it is the only character allowed.
4. “X” matches [0-9], “N” matches [2-9].

Usage Examples
The following example displays voice substitution information:
>enable
#show voice match
ani - match: 2323

substitute: 5555

show voice named-digit-timeouts

Use the show voice named-digit-timeouts command to view configured named digit timeouts (NDTs)
and their values. The output for this command includes the default NDT value. Variations of this command
include:
show voice named-digit-timeouts

show voice named-digit-timeouts <name>
Syntax Description
<name> Optional. Displays information about a specific named digit timeout.
Default Values
Command History
Usage Examples
The following example displays all named digit timeouts and their timeout value:
>enable
#show voice named-digit-timeouts
Name Timeout Value (secs)
--------------------------------------------------------------------------------
default 4
long 10
longer 12
longest 16
short 6
shorter 5
shortest 2

show voice operator-group

Use the show voice operator-group command to display all operator groups.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays all operator groups:
>enable
#show voice operator-group
Operator-group: 0 Call distribution type: all
Number of calls allowed: 1
Number of rings before coverage: 4
Extension Firstname Lastname Logged In

-------------------------------------------------------------------------------------
2001 John Smith *
Order # of Rings Call Coverage Action

---------------------------------------------------------------------
1 0 Auto Attendant
2 2 None
3 2 None
4 2 None
5 2 None

show voice phone-files

Use the show voice phone-files command to display files required for Session Initiation Protocol (SIP)
phone configuration.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show voice phone-files command:
>enable
#show voice phone-files
03/02/2006 16:03 PM 216 0004f203f69c.cfg

03/02/2006 16:03 PM 687 5001-0004f203f69c.cfg
03/02/2006 16:03 PM 216 0004f203b0d6.cfg
03/14/2006 16:03 PM 306 polycom.cfg
7 File(s) 132516 bytes
0 Dir(s) 0 bytes

show voice quality-stats

Use the show voice quality-stats command to display voice quality statistical information. Variations of
show voice quality-stats

show voice quality-stats active
show voice quality-stats active realtime
show voice quality-stats <ID>
show voice quality-stats <ID> realtime
your unit.
Syntax Description
active Displays all quality statistics for active calls.
<ID> Specifies an identity number of a call to obtain detailed statistics.
Default Values
Command History
include.

Functional Notes
page 702).
Usage Examples
The following example displays voice quality statistics for all active calls:
>enable
#show voice quality-stats active
Start Lost Discard Delay

ID Time From To Duration Codec Pkts Pkts Avg Max
--------------------------------------------------------------------------------------------------------------------------------------------
4236 3:02 pm 5152222 5157744 6:55 G711 2 0 50 50

show voice ring-group

Use the show voice ring-group command to display all ring groups. Variations of this command include:
show voice ring-group

show voice ring-group <number>
Syntax Description
<number> Optional. Displays information about a specific ring group extension.
Default Values
Command History
include.
Usage Examples
The following example displays all ring groups:
>enable
#show voice ring-group
ring-group 1234 type: linear
description:
First Last Ext Logged In
------------------------------------------------------------------------
Order NumRings Action
------------------------------------------------------------------------
1 2 None
2 2 None
3 2 None
4 2 None
5 2 None

ring-group 2 type: linear

description:
First Last Ext Logged In
------------------------------------------------------------------------
Order NumRings Action
------------------------------------------------------------------------
1 2 None
2 2 None
3 2 None

show voice speed-dial

Use the show voice speed-dial command to display system speed dial information. Variations of this
command include:
show voice speed-dial

show voice speed-dial <number>
Syntax Description
<number> Optional. Displays information about a specific speed dial number. Valid
range is 1 to 99.
Default Values
Command History
include.
Usage Examples
The following example displays information on speed dial number 50:
>enable
#show voice speed-dial 50
speed-dial - ID: 50
Name: Main Office
Number: 4000

show voice spre

Use the show voice spre command to display all special prefix (SPRE) code mappings. Functions with no
SPRE code assigned are not displayed. Variations of this command include:
show voice spre local

show voice spre network
Syntax Description
local Displays all SPRE codes used locally.
network Displays all SPRE codes passed through to the network.
Default Values
Command History
include.
Usage Examples
The following example displays all local SPRE codes:
>enable
#show voice spre local
Current SPRE Handling Mode: Local
SPRE Code Description

-------------------------------------------------------------------------------------------------------------------
** Hands Free Auto-Answer
*20n System Mode 0=Deflt, 1=Night, 2=Wknd, 3=Lunch, 7=Override
*22xxxx Billing Code
*35 Call Forward Cancel
*36xxxx*pppp* Remote Call Forward Cancel
*39x Do Not Disturb Enable/Disable

*44 Permanent Hold

*46xxxx*pppp* Hotel Login
*47pppp* Hotel Logout
*55xxxx* Group Login
*56xxxx* Group Logout
*57pppp User Station Lock
*58pppp User Station Unlock
*63xxxx*pppp* MACA Login
*69 Call Return
*70[pw-old]*[pw-new]* Set Account Password
*78z Call Park Retrieve
*85xxxx Set Message Waiting
*88 Transfer
*90xxxx Class of Service Override (xxxx=Override Passcode)
*97x Auto-Answer Do Not Disturb

show voice status-group

Use the show voice status-group command to display information on all voice status groups or on a
specified group. Variations of this command include:
show voice status-group

show voice status-group <name>
Syntax Description
<name> Optional. Displays all users within the specified status group.
Default Values
Command History
include.
Usage Examples
The following example displays all voice status group extensions:
>enable
#show voice status-group
Status-group: Sales Team

Description:
Type Member ID Display Name Status
------------------------------------------------------------
user 2001 Martha Idle
user 3002 Dan Idle
user 3003 Betty Idle
user 3004 Chris Idle
user 4001 Jami Idle
Number of members: 5

show voice switchboard

Use the show voice switchboard command to display all voice switchboard extensions.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example displays all voice switchboard extensions:
>enable
#show voice switchboard
Ext
----
1234
2
5200
6000
6001
6002
6003

show voice system-mode

Use the show voice system-mode command to display the current system mode running on the unit.
Specifying a day will display any transitions configured for that day. Variations of this command include:
show voice system-mode

show voice system-mode sunday
show voice system-mode monday
show voice system-mode tuesday
show voice system-mode wednesday
show voice system-mode thursday
show voice system-mode friday
show voice system-mode saturday
Syntax Description
[sunday - saturday] Optional. Displays the specified system mode programmed in the unit.
Choose from Sunday through Saturday.
Default Values
No default values are valid for this command.
Command History
Usage Examples
The following example shows sample output from the show voice system-mode monday command:
>enable
#show voice system-mode monday
Current system-mode: default
System-mode transition - Day: monday
Mode @ time: lunch @ 12:00
Mode @ time: default @ 13:00
Mode @ time: night @ 17:00

The following example shows sample output from the show voice system-mode command:
>enable
#show voice system-mode
Current system-mode: weekend

show voice trunk

Use the show voice trunk command to display all voice trunks. Variations of this command include:
show voice trunk

show voice trunk <trunk id>
show voice trunk connects <trunk id>
Syntax Description
connects Optional. Displays all trunk voice interface connections.
<trunk id> Optional. Displays voice trunk information for a specific trunk ID. Use T01,
T02, and so on for the trunk ID.
Default Values
Command History
include.
Usage Examples
The following example displays all voice trunks:
>enable
#show voice trunk
Busy Busy Busy Non Busy Busy Non Busy
Trunk Resource Admin. Admin. Attempts Attempts Attempts Attempts
Name Selection Config. Status Today Today Total Total
--------------------------------------------------------------------------------------------------------------------------------------------
T01 linear Not Busy Not Busy 0 0 0 7
T06 linear Not Busy No Connects 0 0 0 0
T02 linear Not Busy Not Busy 0 0 0 27
T03 linear Not Busy No Connects 0 0 0 0

show voice users

Use the show voice users command to display all voice user stations. Variations of this command include:
show voice users

show voice users did
show voice users extension
show voice users last
Syntax Description
did Optional. Displays all users included in the directory.
extension Optional. Displays directory entries sorted by extensions.
last Optional. Displays directory entries sorted by last name.
Default Values
Command History
include.
Usage Examples
The following example displays all voice users:
>enable
#show voice users
First Last Ext Interface Description
--------------------------------------------------------------------------------------------
Janet Smith 5200 virtual
Bill Jones 6000 virtual
Sam Sampson 6001 virtual
Eve Smith 6002 virtual
Bob Wilson 6003 virtual

show voice users sip

Use the show voice users sip command to display a list of Session Initiation Protocol (SIP) users with
their associated ports.
Syntax Description
No subcommands.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show voice users sip command:
>enable
#show voice users sip
First Last Extension Interface MAC Address IP Address

-----------------------------------------------------------------------------------------------------------------------
Fronia Cobins 4430 Unregistered user - Unable to resolve port
Gorge Owens 4440 Unregistered user - Unable to resolve port
Heather Virginia 4450 Unregistered user - Unable to resolve port
Total number of configured SIP voice users: 3

show voip name-service cache

Use the show voip name-service cache command to view Voice over Internet Protocol (VoIP) name
service information stored in the cache.
Syntax Description
No subcommands.
Default Values
Command History
Release A2.04 Command was introduced.
Functional Notes
The information displayed in the show command output consists of two columns. The left column lists the
host name of an entry in the VoIP Name Service Name Table. This corresponds with the entries shown in
the output of the command show voip name-service name-table on page 693. The right column shows the
corresponding last resolved IP address(es) of the entry. An IP address of all zeros indicates the particular
host has not been resolved. In the event all domain naming system (DNS) servers are unreachable and a
particular host name cannot be refreshed, the DNS uses the cached address to resolve the particular host.
Usage Examples
The following example displays name service information stored in the cache:
>enable
#show voip name-service cache
Name Last Resolved Address

----------------------------------------------------------------------------------------------------
test2.pprice.voice.test.adtran.com 1.2.3.3
bogus3.pprice.voice.test.adtran.com 1.2.3.3
test.pprice.voice.test.adtran.com 0.0.0.0

show voip name-service name-table

Use the show voip name-service name-table command to view Voice over Internet Protocol (VoIP) name
service information in the name table.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The following information is displayed in the show command output:
• Name - Indicates the name of the service.

• Proto - Indicates the protocol.
• Tpt - Indicates the transport method used, either User Datagram Protocol (UDP) or Transmission
Control Protocol (TCP).
• LastSrc - Indicates the last software object that requested this domain naming system (DNS) entry be
cached. Valid options are trunk, route, manual, proxy, MGCP, or derived.
• Interval - Indicates when the entry will expire.
• Users - Indicates the number of software objects using this entry.
• Resolved - Indicates whether or not the DNS has been able to resolve this entry.
Usage Examples
The following example displays name service information in the name table:
>enable
#show voip name-service name-table

Name Proto Tpt LastSrc Interval Users Resolved

--------------------------------------------------------------------------------------------------------------------------------------------
pq.adtran.com SIP UDP trunk 0h 59m 47s 2 Yes
bw2.pq.adtran.com SIP UDP trunk 0h 59m 46s 2 Yes
Technology Review
VoIP name service maintains a list of service names relevant to VoIP transactions while also facilitating
access between VoIP-related queries to the external DNS server and the internal DNS client. Service
names are automatically entered and deleted from the internal service name table when configured or not
configured for VoIP-related subsystems. The VoIP name service begins polling external DNS servers for
recently added service names to preemptively resolve service names before they are deleted. Using the
show voip name-service name-table command will show the status of added service names.

show vrrp
Use the show vrrp command to display configuration and operating data for Virtual Router Redundancy
Protocol (VRRP) configurations. Variations of this command include:
show vrrp
show vrrp brief
show vrrp interface <interface>
show vrrp interface <interface> group <number>
show vrrp statistics
show vrrp statistics interface <interface>
show vrrp statistics interface <interface> group <number>
Syntax Description
brief Optional. Limits the amount of data shown.
group <number> Optional. Displays data or statistics for a specified VRRP group on the
specified interface. Group numbers range from 1 to 255.
interface <interface> Optional. Displays data or statistics for all VRRP groups or a specified
group on the specified interface. Specify an interface in the format
id.subinterface id]>. For example, for an Ethernet subinterface, use
atm 1.1; and for a virtual local area network (VLAN) interface, use vlan 1.
Type show vrrp interface ? for a complete list of valid interfaces.
statistics Optional. Displays statistics for all VRRP groups on all interfaces.
Default Values
Command History
include.

Functional Notes
Although VRRP group virtual router identifiers (VRIDs) can be numbered between 1 and 255, only two
VRRP routers per interface are supported.
Usage Examples
The following example gives sample output from the show vrrp statistics command:
eth 0/1
Group 1
Became Master: 3
Priority Zero Packets Sent: 1
Priority Zero Packets Received: 0
Advertisements Sent: 105134
Advertisements Received: 241
Advertisements Interval Errors: 0
Advertisements TTL Errors: 0
Advertisements Address List Errors: 0
Advertisements Packet Length Errors: 0
Group 2
Became Master: 1
Priority Zero Packets Sent: 0
Priority Zero Packets Received: 0
Advertisements Sent: 897
Advertisements Received: 1628
Advertisements Interval Errors: 0
Advertisements TTL Errors: 0
Advertisements Address List Errors: 0
Advertisements Packet Length Errors: 0

sip check-sync
Use the sip check-sync command to send a check-sync notification to all IP phones registered to the unit.
When an IP phone receives this check-sync notification, the phone will check for possible configuration
changes stored on the server. Variations of this command include the following:
sip check-sync
sip check-sync firmware-upgrade
sip check-sync <user name or ip address>
Syntax Description
firmware-upgrade Optional. Specifies a check-sync to be used when upgrading phone
firmware.
<user name or ip address> Optional. Specifies the phone to contact with configuration changes.
Default Values
Command History
Usage Examples
The following example notifies all IP phones to check for a change in configuration:
>enable
#sip check-sync

telnet

Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
>enable
#telnet 10.200.4.15
User Access Login:
Password:

>enable
#telnet 10.200.4.15 port 8010
User Access Login:
Password:

telnet stack-member <unit id>

Use the telnet stack-member command to Telnet to a stack member.
Syntax Description
<unit id> Specifies unit ID of the stack member to connect via a Telnet session.
Default Values
Command History
Functional Notes
This command is only available when in stack-master mode.
Usage Examples
The following example Telnets to a member of the stack:
>enable
#telnet stack-member 3
Trying Stack Member 3...Press Ctrl+C to abort

telnet vrf <name> stack-member <number>

Use the telnet vrf stack-member command to open a Telnet session (through AOS) with a member of the
stack.
Syntax Description
vrf <name> Specifies the VPN routing and forwarding (VRF) where the stack-member
exists.
stack-member <number> Specifies which member of the stack to which to Telnet.
Default Values
Command History
Functional Notes
Usage Examples
The following example opens a Telnet session with stack-member 3 of the VRF red:
>enable
#telnet vrf red stack-member 3
Trying Stack Member 3...Press Ctrl+C to abort

terminal length <number>

The terminal length command sets the number of rows (lines) for a terminal session. Use the no form of
this command to return to the default value. This command is only valid for the current session and returns
to the default (24 rows) when the session closes.
Syntax Description
<number> Specifies the number of rows for a terminal session. Range is 0 to 480 lines.
Setting the terminal length to 0 disables paging.
Default Values
The default setting for this command is 24 rows.
Command History
Usage Examples
The following example sets the number of rows for a terminal session to 30.
>enable
#terminal length 30

traceroute
Use the traceroute command to display the IP routes a packet takes to reach the specified destination.
traceroute
traceroute <ip address | hostname>
traceroute <ip address | hostname> source <ip address>
traceroute vrf <name> <ip address | hostname>
traceroute vrf <name> <ip address | hostname> source <ip address>
Syntax Description
<ip address | hostname> Optional. Specifies the IP address or host name of the remote system’s
route to trace.
source <ip address> Optional. Specifies the IP address of the interface to use as the source of
the trace. IP addresses should be expressed in dotted decimal notation (for
example, 10.10.10.1).
vrf <name> Optional. Specifies the VPN routing and forwarding (VRF) where the route
exists.
Default Values
Command History
Functional Notes
Usage Examples
The following is a sample traceroute output:
>enable
#traceroute 192.168.0.1
Tracing route to 192.168.0.1 over a maximum of 30 hops
1 22ms 20ms 20ms 192.168.0.65
2 23ms 20ms 20ms 192.168.0.1
#

traceroute ethernet
Use the traceroute ethernet command to initiate a linktrace message from one Ethernet operations,
administration, and maintenance (OAM) connectivity fault management (CFM) maintenance endpoint
(MEP) to another MEP. These linktrace messages are used to trace the packet route to a destination MEP.
traceroute ethernet <target-mac-address | target-mep-id>

traceroute ethernet <target-mac-address | target-mep-id> domain <domain name> association
<association name>
traceroute ethernet <target-mac-address | target-mep-id> domain none association <association
name>
traceroute ethernet <target-mac-address | target-mep-id> fdb-only
traceroute ethernet <target-mac-address | target-mep-id> interface <interface>
traceroute ethernet <target-mac-address | target-mep-id> mep <mep id>
traceroute ethernet <target-mac-address | target-mep-id> sorted
traceroute ethernet <target-mac-address | target-mep-id> timeout <timeout>
traceroute ethernet <target-mac-address | target-mep-id> ttl <value>
After specifying the target for the linktrace messages, the other parameters can be entered
in any order.
Syntax Description
<target-mac-address | target-mep-id> Specifies the destination for the linktrace message. Medium
access control (MAC) addresses are entered in the format
HH:HH:HH:HH:HH:HH. Target MEP IDs are the unique
numerical values identifying MEPs. MEP IDs range from 1 to
8191.
domain <domain name> Optional. Specifies the maintenance domain to which the
domain none Optional. Specifies no maintenance domain.
association <association name> Optional. Specifies the maintenance association to which the
fdb-only Optional. Specifies that the maintenance points on the route
only use their forwarding database, and not their continuity
check message (CCM) database when deciding if/how to
forward linktrace messages.
interface <interface> Optional. Specifies the interface on which the transmitting MEP
is configured. Specify an interface in the format <interface type
[slot/port | slot/port.subinterface id | interface id | interface
id.subinterface id]>. For example, for an Ethernet subinterface,
use eth 0/1.1. For a list of appropriate interfaces, enter

mep <mep id> Optional. Specifies the MEP ID of the transmitting MEP. MEP ID
range is 1 to 8191.
sorted Optional. Specifies the traceroute utility waits until all traceroute
results have been received and sorted by hop count before
displaying them.
timeout <timeout> Optional. Specifies the time that the MEP will wait for a
response to the linktrace message. Range is 0 to 60 seconds.
ttl <value> Optional. Specifies the time to live (TTL) field of the linktrace
message. Range is 0 to 255.
Default Values
By default, the timeout value is set to 5 seconds.
By default, the ttl value is set to 5 seconds.
Command History
Functional Notes
If the MEP ID is used as the target, the remote MEP must exist in the MEP CCM database (meaning the
remote MEP is transmitting valid CCMs) so that the MEP ID can be translated to the MAC address before
the linktrace message is transmitted.
Both the domain <domain name> and association <association name> parameters are not required if the
source MEP ID of the MEP is specified and unique through the AOS device.
If the domain and association of the transmitting MEP are specified, and there is only one MEP in that
domain or association, or if there is only one MEP configured on the unit, the mep <mep-id> parameter is
not required.

Usage Examples
The following example initiates the Ethernet traceroute utility from a MEP with the ID 1 to an MEP with an
MEP ID of 201:
>enable
#traceroute ethernet 201 mep 1
TTL 255. LTM Timeout is 5 seconds

Tracing route to MEPID 201 (00:10:94:00:00:06)
from MEPID 1
in Domain_1/MA_1
MD Level 7, vlan 0
Traceroute sent via interface eth 0/1
--------------------------------------------------------------------------------------------------------------------------------------------
Hops Mac Flags Ingress-Action Relay Action
PrevHop Egress-Action
--------------------------------------------------------------------------------------------------------------------------------------------
1 00:10:94:00:00:00 Forwarded InNoTLV RLY_MPDB
00:A0:C8:16:96:0D EgOK
00:10:94:00:00:04 EgOK
00:10:94:00:00:00 EgOK
4 00:10:94:00:00:06 (Eg) Terminal InNoTLV RLY_HIT
00:10:94:00:00:05
Destination reached
Remember that linktrace can be a tree-structure, and is not always linear. The “PrevHop”
for Hop 3 in the previous example tells you the MAC of Hop 2. This gives you a way to
trace the linktrace message when a tree-structure exists. Refer to Section J.5 of IEEE
802.1ag for more information.

undebug all
Use the undebug all command to disable all activated debug messages.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example disables all activated debug messages:
>enable
#undebug all

verify-file
Use the verify-file command to validate a boot image file located in a specified memory location
(CompactFlash®, system flash, or RAM disk). AOS initiates the validation process automatically before an
image can be set as the primary boot image. This command is used as a precautionary step before erasing
the primary boot image. Variations of this command include:
verify-file cflash <filename>

verify-file flash <filename>
verify-file ramdisk <filename>
Not all units are capable of using a RAM disk file system or have a CompactFlash card.
Use the verify-file ? command to display a list of valid commands at the enable prompt.
Syntax Description
<filename> Specifies the name of the file to validate.
cflash Indicates the specified file is located on the CompactFlash card.
flash Indicated the specified file is located in the system flash memory.
ramdisk Indicated the specified file is located in the volatile RAM disk.
Default Values
Command History
Usage Examples
The following example validates the NV3120A-17-05-01-00-E.biz file (located in the volatile RAM disk) as
a possible candidate for the boot system file:
>enable
#verify-file ramdisk NV3120A-17-05-01-00-E.biz
Valid file signature

vlan database
Use the vlan database command to enter the Virtual Local Area Network (VLAN) Database
Configuration mode. Refer to the section VLAN Database Command Set on page 2153 for more
information.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enters the VLAN Configuration mode:
>enable
#vlan database

voice dsp capture

Use the voice dsp capture command to initiate digital signal processor (DSP) captures. Use the no form of
this command to return to the default setting. Variations of this command include:
voice dsp capture start

voice dsp capture start <value>
voice dsp capture stop
voice dsp capture cancel
Syntax Description
start Starts the command line interface (CLI) wizard that prompts the user for the
necessary information to initiate a DSP capture.
<value> Optional. Specifies a DSP capture starting on a specific channel on DSP
0/1. The valid channel number range is 1 to 32.
stop Stops the current DSP capture and downloads the captured files to FLASH.
cancel Cancels the current DSP capture and discards the captured files.
Default Values
By default, the DSP capture is disabled.
Command History
Functional Notes
The voice DSP captures are used to help diagnose voice issues. The channel numbers for this command
correspond to those seen in the show and debug commands (for example, the first channel is 1, not 0).
Output is received on all console sessions notifying you of a running DSP capture or download. Closing
the CLI session on which the capture was started will cancel the current capture. This method of DSP
capture is valid on AOS Release 15.1 or later, replacing the en8 int voip 0/1 method.
Usage Examples
The following example starts a DSP capture:
#voice dsp capture start

DSP Slot [0]: 0
DSP Port [1]: 1
DSP Channel [1]:1
%Warning! Performance of this unit may be degraded during a DSP capture!
Continue and start DSP Capture? [y/n] y
DSP UTILITIES. Voice Capture A DSP capture is active on VoIP 0/1 on channel 1dsp capture

voice loopback-call
Use the voice loopback-call command to initiate and terminate voice loopback calls. Variations of this
command include:
voice loopback-call start from <number> to <number>

voice loopback-call stop account <number>
voice loopback-call stop all
voice loopback-call stop id <number>
Syntax Description
start from <number> Starts a loopback call from the specified extension number (loopback
account).
to <number> Specifies the extension number to call.
stop Stops active loopback calls.
account <number> Terminates the call(s) for the specific account.
all Terminates all loopback calls.
id <number> Terminates a specific loopback call based on the identity number of the call.
Default Values
By default, no loopback accounts are configured.
Command History
Usage Examples
The following example starts a voice loopback call:
>enable
#voice loopback-call start from 5555 to 6100

wall <message>
Use the wall command to send messages to all users currently logged into the AOS unit.
Syntax Description
<message> Sends a message to all users logged into the command line interface (CLI).
Default Values
Command History
Usage Examples
The following example sends the message “Reboot in 5 minutes if no objections” to the CLI screen of
everyone currently connected:
>enable
#wall Reboot in 5 minutes if no objections

write
Use the write command to save the running configuration to the unit’s nonvolatile random access memory
(NVRAM) or a Trivial File Transfer Protocol (TFTP) server. Also, use the write command to clear
NVRAM or to display the running configuration on the terminal screen. Entering the write command with
no other arguments copies your configuration changes to the unit’s NVRAM. Once the save is complete,
the changes are retained even if the unit is shut down or suffers a power outage. Variations of this
command include:
write
write dynvoice-config
write erase
write memory
write network
write terminal
Syntax Description
dynvoice-config Optional. Writes dynvoice configuration information to the unit’s NVRAM.
erase Optional. Erases the configuration files saved to the unit’s NVRAM.
memory Optional. Saves the current configuration to NVRAM.
network Optional. Saves the current configuration to the network TFTP server.
terminal Optional. Displays the current configuration on the terminal screen.
Default Values
Command History
Usage Examples
The following example saves the current configuration to the unit’s NVRAM:
>enable
#write memory

Command Reference Guide Global Configuration Mode Command Set
GLOBAL CONFIGURATION MODE COMMAND SET
To activate the Global Configuration mode, enter the configuration command at the Enable mode prompt.
For example:
>enable
#configure terminal
(config)#
The following commands are common to multiple command sets and are covered in a centralized section
of this guide. For more information, refer to the sections listed below:
do on page 51
end on page 52
exit on page 53
shutdown on page 61
aaa accounting commands begin on page 720

aaa authentication commands begin on page 728
aaa authorization commands begin on page 740
aaa group server on page 748
aaa local authentication attempts max-fail <number> on page 750
aaa on on page 751
aaa processes <value> on page 752
arp <ip address> <mac address> arpa on page 753
auto-config on page 754
auto-link on page 756
auto-link http on page 757
auto-link recontact-interval <value> on page 758
auto-link server <hostname | ip address> on page 759
boot config on page 761
boot system on page 762
boot voip on page 764
bridge irb on page 765
bridge <number> protocol ieee on page 767
clock on page 768
clock set <time> <day> <month> <year> on page 769

clock timezone <value> on page 770

crypto commands begin on page 773
data-call on page 790
desktop-auditing dhcp on page 792
desktop-auditing local-policy on page 793
desktop-auditing timeout <days> on page 794
dos-protection on page 795
dot11ap access-point-control on page 796
enable password <password> on page 797
ethernet cfm on page 798
ethernet cfm domain on page 799
ethernet cfm log-changes on page 801
event-history on on page 802
event-history priority on page 803
exception memory minimum <value> on page 805
exception report on page 806
ftp authentication <listname> on page 807
garp timer <value> on page 808
gvrp on page 809
hostname <name> on page 810
hw-access-map <name> on page 811
interface range <interface type> <slot/port> - <slot/port> on page 813
ip on page 814
ip access-list commands begin on page 815
ip as-path-list <name> on page 819
ip classless on page 820
ip community-list <name> on page 821
ip crypto on page 822
ip default-gateway <ip address> on page 824
ip dhcp-server commands begin on page 825
ip domain commands begin on page 831
ip ffe max-entries <value> on page 834
ip ffe timeout on page 835
ip firewall commands begin on page 837
ip flow commands begin on page 857
ip forward-protocol udp <value> on page 864
ip ftp commands begin on page 866
ip host on page 869
ip http on page 870

ip http source-interface <interface> on page 872

ip hw-access-list extended <name> on page 873
ip igmp commands begin on page 875
ip load-sharing on page 881
ip local policy route-map <name> on page 882
ip mcast-stub helper-address <ip address> on page 883
ip mgcp commands begin on page 884
ip multicast-routing on page 897
ip name-server on page 898
ip nat pool <name> on page 899
ip policy-class <name> on page 900
ip policy-class <name> max-host-sessions <number> on page 902
ip policy-class max-sessions <number> on page 903
ip policy-class <name> rpf-check on page 904
ip policy-timeout <protocol> <range> <port> <value> on page 905
ip prefix-list commands begin on page 908
ip radius source-interface <interface> on page 911
ip route on page 912
ip routing on page 917
ip rtp commands begin on page 919
ip scp server on page 937
ip sdp grammar hold on page 938
ip sip commands begin on page 939
ip snmp agent on page 986
ip sntp commands begin on page 987
ip subnet-zero on page 991
ip tacacs source-interface <interface> on page 992
ip tftp commands begin on page 993
ip urlfilter commands begin on page 995
ip vrf <name> route-distinguisher <number> on page 1002
isdn-group <number> on page 1003
isdn-number-template on page 1004
line on page 1007
lldp on page 1009
logging commands begin on page 1013
mac access-list standard <name> on page 1028
mac address-table commands begin on page 1029
mac hw-access-list extended <name> on page 1031
mail-client <agent name> on page 1033

modem countrycode <value> on page 1034

monitor session <number> on page 1037
network-forensics ip dhcp on page 1039
ntp commands begin on page 1040
portal-list <name> <portal1 portal2 portal3...> on page 1048
port-auth commands begin on page 1049
port-channel load-balance on page 1054
power-supply shutdown automatic on page 1055
probe on page 1056
qos commands begin on page 1059
radius-server on page 1065
radius-server host on page 1067
resource-utilization on page 1069
route-map on page 1070
router commands begin on page 1071
run tcl <filename> on page 1076
schedule <name> on page 1077
service password-encryption on page 1079
snmp ifmib alias long on page 1080
snmp-server commands begin on page 1081
sntp retry-timeout <value> on page 1100
sntp server on page 1101
sntp wait-time <value> on page 1102
spanning-tree commands begin on page 1103
stack on page 1112
statistics rate-interval <value> on page 1114
system mtu <size> on page 1115
tacacs-server on page 1116
tacacs-server host on page 1117
telnet on page 1119
thresholds on page 1121
timing-source on page 1123
track <name> on page 1124
username <username> password <password> on page 1125
username <username> portal-list <name> password <password> on page 1126
vlan <vlan id> on page 1127
voice commands begin on page 1128
vrf forwarding <name> on page 1205

aaa accounting commands <level>

Use the aaa accounting commands command to create and define a default or named accounting method
list for use with authentication, authorization, and accounting (AAA) accounting services. The accounting
commands method lists specify the types of information recorded when users access specified command
levels (privileged or unprivileged). Use the no form of this command to disable the accounting commands
method list. Variations of this command include:
aaa accounting commands <level> default none

aaa accounting commands <level> default stop-only group <name>
aaa accounting commands <level> default stop-only group tacacs+
aaa accounting commands <level> <listname> none
aaa accounting commands <level> <listname> stop-only group <name>
aaa accounting commands <level> <listname> stop-only group tacacs+
Syntax Description
<level> Specifies whether the method list applies to Level 1 (unprivileged) or
Level 15 (privileged) commands.
<listname> Creates and names the accounting commands method list to use rather
than the default list.
default Creates and defines the default accounting commands method list to use
rather than a named list.
none Specifies that no accounting methods are used.
stop-only Records accounting information only when the connection terminates.
group <name> Specifies using a subset of terminal access controller access-control
system (TACACS+) servers for keeping accounting records. Subsets are
named server groups previously created using the command aaa group
server on page 748. A server group must be configured to use this method.
group tacacs+ Specifies using all TACACS+ servers for keeping accounting records.
TACACS+ servers must be configured to use this method. Refer to the
Functional Notes for more information.
Default Values
By default, AAA accounting is disabled and no accounting command method lists are defined.
Command History
Functional Notes
AAA accounting is an AAA service that helps track the services and resources that network users are
accessing and using. Accounting works by sending records of user activity to a configured server that can
be used by network administrators to monitor network management, client billing, and auditing. In AOS,
AAA accounting can record the commands users are entering using the aaa accounting commands
command to create method lists that monitor specified command levels.

Before AAA accounting method lists can be configured or applied, AAA must be enabled. To enable AAA,
use the command aaa on on page 751.
Each AAA accounting method list relies on a combination of accounting methods. Each method must be
entered into the list in the order that they are to be performed. Although these methods can be entered in
any order, each can only be used once. The exception is the group <name> method that can be entered
multiple times to accommodate multiple configured server groups. When specifying methods for the AAA
accounting commands method list, it is important to remember that no additional parameters are available
when using the none option, and that group tacacs+ or group <name> methods are not available until
after specifying stop-only. Once you have specified stop-only as a method, you can specify group
tacacs+ and group <name> in any order or combination. If the unit fails to make a connection with the first
group listed, it will try the next group specified.
The two types of method lists created using the aaa accounting commands command are a default list
and a named list. A default list is one that is created and automatically applied to all line interfaces at the
global level. A named method list is one that does not perform any action until it is manually applied to an
interface. Named AAA accounting commands method lists are applied to line interfaces using the
accounting commands command from the appropriate line interface configuration mode (Line (Console)
Interface Command Set on page 1207, Line (Telnet) Interface Command Set on page 1235, or Line (SSH)
Interface Command Set on page 1223).
To use TACACS+ servers to record command accounting information (TACACS+ are the only servers
available for AOS AAA accounting; RADIUS servers are not supported), the TACACS+ servers must be
configured prior to creating the method list. You can configure all TACACS+ servers in the system using
the command tacacs-server on page 1116. You can configure individual TACACS+ servers using the
command tacacs-server host on page 1117. Once the TACACS+ servers have been configured, you can
use all TACACS+ servers for maintaining accounting records by using the group tacacs+ method. If you
only want to use some of the available TACACS+ servers for accounting, you can create a named server
group and add the TACACS+ servers to the group. Server groups are created using the command aaa
group server on page 748 and servers are added to the group as outlined in the TACACS+ Group
Command Set on page 2602.
For more information about AAA accounting, or AAA configuration in general, refer to the Configuring AAA
in AOS configuration guide available online at http://kb.adtran.com.
Usage Examples
The following example creates a list called myList and specifies that accounting records are generated for
all Level 1 commands when the connection terminates, and that these records are received by all
configured TACACS+ servers:
(config)#aaa accounting commands 1 myList stop-only group tacacs+

aaa accounting connection

Use the aaa accounting connection command to create and define a default or named accounting method
list for use with authentication, authorization, and accounting (AAA) accounting services. The accounting
connection method lists are used to specify the types of information recorded about outbound connections
made from the AOS unit. Use the no form of this command to disable the accounting connection method
list. Variations of this command include:
aaa accounting connection default none

aaa accounting connection default start-stop group <name>
aaa accounting connection default start-stop group tacacs+
aaa accounting connection default stop-only group <name>
aaa accounting connection default stop-only group tacacs+
aaa accounting connection <listname> none
aaa accounting connection <listname> start-stop group <name>
aaa accounting connection <listname> start-stop group tacacs+
aaa accounting connection <listname> stop-only group <name>
aaa accounting connection <listname> stop-only group tacacs+
Syntax Description
default Creates and defines the default accounting connection method list to use
rather than the named list.
<listname> Creates and names the accounting connection method list to create and
use rather than the default list.
start-stop Records accounting information when the connection begins and when the
connection terminates.
Default Values
By default, AAA accounting connection is disabled and no accounting connection method lists are defined.
Command History

Functional Notes
AAA accounting can record information about outbound connections made from the network access server
using the aaa accounting connection command to create method lists that monitor outbound
connections.
accounting connection method list, it is important to remember that no additional parameters are available
when using the none option, and that group tacacs+ or group <name> methods are not available until
after specifying start-stop or stop-only. Once you have specified start-stop or stop-only as a method,
you can specify group tacacs+ and group <name> in any order or combination. If the unit fails to make a
connection with the first group listed, it will try the next group specified.
The two types of method lists created using the aaa accounting connection command are a default list
interface. Named AAA accounting connection method lists are applied to line interfaces using the
accounting connection command from the appropriate line interface configuration mode (Line (Console)
To use TACACS+ servers to record connection accounting information (TACACS+ are the only servers
available for AOS AAA accounting; RADIUS servers are not supported), the TACACS+ servers must be
use all TACACS+ servers for maintaining accounting records by using the group tacacs+ method. If you
only want to use some of the available TACACS+ servers for accounting, you can create a named server
group and add the TACACS+ servers to the group. Server groups are created using the command aaa
group server on page 748 and servers are added to the group as outlined in the TACACS+ Group

Usage Examples
The following example creates a list called myList and sends the connection information to all TACACS+
servers when the connection terminates:
(config)#aaa accounting connection myList stop-only group tacacs+
The following example creates a list called myList and sends the connection information to the TACACS+
servers when the connection is made and when the connection terminates:
(config)#aaa accounting connection myList start-stop group tacacs+

aaa accounting exec

Use the aaa accounting exec command to create and define a default or named accounting method list for
use with authentication, authorization, and accounting (AAA) accounting services. AAA executive
accounting method lists are used to specify the types of information recorded about inbound connections
made by connecting to the line interfaces and creating a terminal session. Use the no form of this command
to disable the accounting exec method list. Variations of this command include:
aaa accounting exec default none

aaa accounting exec default start-stop group <name>
aaa accounting exec default start-stop group tacacs+
aaa accounting exec default stop-only group <name>
aaa accounting exec default stop-only group tacacs+
aaa accounting exec <listname> none
aaa accounting exec <listname> start-stop group <name>
aaa accounting exec <listname> start-stop group tacacs+
aaa accounting exec <listname> stop-only group <name>
aaa accounting exec <listname> stop-only group tacacs+
Syntax Description
default Creates and defines the default accounting exec method list to use rather
than the named list.
<listname> Creates and names the accounting exec method list to use rather than the
default list.
start-stop Records accounting information when the connection begins and when the
connection terminates.
Default Values
By default, AAA accounting exec is disabled and no accounting exec method lists are defined.
Command History

Functional Notes
AAA accounting can record information about inbound connections (made by connecting to the line
interfaces and creating a terminal session) using the aaa accounting exec command to create method
lists that monitor inbound connections.
accounting exec method list, it is important to remember that no additional parameters are available when
using the none option, and that group tacacs+ or group <name> methods are not available until after
specifying start-stop or stop-only. Once you have specified start-stop or stop-only as a method, you
can specify group tacacs+ and group <name> in any order or combination. If the unit fails to make a
The two types of method lists created using the aaa accounting exec command are a default list and a
named list. A default list is one that is created and automatically applied to all line interfaces at the global
level. A named method list is one that does not perform any action until it is manually applied to an
interface. Named AAA accounting exec method lists are applied to line interfaces using the accounting
exec command from the appropriate line interface configuration mode (Line (Console) Interface Command
Set on page 1207, Line (Telnet) Interface Command Set on page 1235, or Line (SSH) Interface Command
Set on page 1223).
To use TACACS+ servers to record exec accounting information (TACACS+ are the only servers available
for AOS AAA accounting; RADIUS servers are not supported), the TACACS+ servers must be configured
prior to creating the method list. You can configure all TACACS+ servers in the system using the command
tacacs-server on page 1116. You can configure individual TACACS+ servers using the command
tacacs-server host on page 1117. Once the TACACS+ servers have been configured, you can use all
TACACS+ servers for maintaining accounting records by using the group tacacs+ method. If you only
want to use some of the available TACACS+ servers for accounting, you can create a named server group
and add the TACACS+ servers to the group. Server groups are created using the command aaa group
server on page 748 and servers are added to the group as outlined in the TACACS+ Group Command Set
on page 2602.

Usage Examples
The following example creates a list called myList and sends the connection/login records to the
TACACS+ servers when the connection is terminated:
(config)#aaa accounting exec myList stop-only group tacacs+

aaa accounting suppress null-username

Use the aaa accounting suppress null-username command to specify that authentication, authorization,
and accounting (AAA) accounting records for users with a NULL user name are not sent to the AAA
accounting server.
Syntax Description
No subcommands.
Default Values
By default, records of all user accounts, including NULL user names, are sent to the server.
Command History
Functional Notes
Null users are those users whose user name string is NULL. Users might have this user name if they came
in on a line whose record type is none (typically, these are users that authenticated with a password-only
login or no login).
Usage Examples
The following example specifies that users with the user name NULL are not sent to the server:
(config)#aaa accounting suppress null-username

aaa accounting update

Use the aaa accounting update command to specify how often authentication, authorization, and
accounting (AAA) accounting records are sent to the accounting server(s). Use the no form of this
command to return to the default setting. Variations of this command include:
aaa accounting update newinfo

aaa accounting update periodic <value>
Syntax Description
newinfo Specifies that information is sent to the server only when there is new
recorded information.
periodic <value> Specifies the time interval (in minutes) between sending accounting records
to the server. Interval range is 1 to 2147483647.
Default Values
By default, accounting records are sent to the server every 5 minutes.
Command History
Usage Examples
The following example specifies that accounting records are sent to the accounting server every 60
minutes:
(config)#aaa accounting update periodic 60

aaa authentication banner <banner>

Use the aaa authentication banner command to specify the banner shown during authentication,
authorization, and accounting (AAA) login/authentication. Using the no form of this command returns the
banner to the default message.
Syntax Description
banner <banner> Sets the banner shown before user authentication is attempted. The banner
can be multiple lines. Enter a delimiter (such as #) to begin recording the
typed text message used for the banner. The message must end with the
same delimiter to indicate that the message is complete. The text delimiters
are not displayed to the screen during operation.
Default Values
By default, the authentication banner is User Access Verification.
Command History
Usage Examples
The following example changes the authentication banner to read User Login Authentication:
(config)#aaa authentication banner #
Enter TEXT message. End with the character '#'.
User Login Authentication:#
(config)#

aaa authentication enable default

Use the aaa authentication enable default command to create and define the default authentication,
authorization, and accounting (AAA) authentication method list used for access to the Enable (privileged)
mode. Use the no form of this command to disable the authentication method list. Variations of this
command include:
aaa authentication enable default enable

aaa authentication enable default group radius
aaa authentication enable default group tacacs+
aaa authentication enable default group <name>
aaa authentication enable default line
aaa authentication enable default none
Each method parameter after default specifies the authentication method to be attempted
in the order in which they are to be tried. Multiple methods can be specified for
authentication, but the authentication procedure is dependent upon the entry order of the
methods.
Syntax Description
none Specifies that no authentication methods are used. If this method is
entered, it should come at the end of the list of authentication methods in
the command entry. This method should only be used to prevent a lock-out
situation.
line Specifies using the line password (Telnet 0 through 4 or console 0 through
1) for authentication. The line password must be configured to use this
method (using the password <password> command from the appropriate
line interface configuration mode prompt).
enable Specifies using the Enable mode password for authentication. The Enable
mode password must be defined to use this method (using the command
enable password <password> on page 797).
group radius Specifies that all defined remote authentication dial-in user service
(RADIUS) servers are used for authentication. RADIUS servers must be
configured to use this method. Refer to the Functional Notes for more
information.
group tacacs+ Specifies that all defined terminal access controller access-control system
plus (TACACS+) servers are used for authentication. TACACS+ servers
must be configured to use this method. Refer to the Functional Notes for
more information.
group <name> Specifies using a subset of TACACS+ or RADIUS servers for
authentication. Subsets are named server groups previously created using
the command aaa group server on page 748. A server group must be
configured to use this method.

Default Values
If the Enable mode password is used as an authentication method and the authentication request is going
to a RADIUS server, the user name $enabl15$is sent by default. If the request is going to a TACACS+
server, the user name used for login authentication is sent by default.
If no default methods list is configured, the unit uses the Enable mode password for authentication. If no
password is configured, consoles are allowed access (this prevents a lock-out condition).
Command History
Release 11.1 The group tacacs+ command was added.
Functional Notes
AAA authentication is an AAA service that helps verify user logins, user access to the Enable mode, and
port usage. Authentication works by verifying user credentials with those stored on a server. In AOS, AAA
authentication can verify a user’s permission to access Enable mode by using the aaa authentication
enable default command to create the default method list that monitors user permissions.
Before AAA authentication method lists can be configured or applied, AAA must be enabled. To enable
AAA, use the command aaa on on page 751.
Each AAA authentication method list relies on a combination of authentication methods. Each method
must be entered into the list in the order that they are to be performed. Although these methods can be
entered in any order, each can only be used once. The exception is the group <name> method that can be
entered multiple times to accommodate multiple configured server groups. If the unit fails to make a
For security reasons, ADTRAN recommends that the local authentication method be used
instead of the none authentication method. Using the local authentication method
prevents unauthorized users from gaining access to the device during a period in which
the links to all authentication servers are down. The local user database contained within
the AOS device will always be available and serves as the last line of defense.
The type of method lists created using the aaa authentication enable default command is a default list. A
default list is one that is created and automatically applied to all line interfaces at the global level.
To use TACACS+ servers to perform Enable mode authentication, the TACACS+ servers must be
use all TACACS+ servers for authentication by using the group tacacs+ method. If you only want to use
some of the available TACACS+ servers for authentication, you can create a named server group and add
the TACACS+ servers to the group. Server groups are created using the command aaa group server on
page 748 and servers are added to the group as outlined in the TACACS+ Group Command Set on page
2602.

To use RADIUS servers to perform Enable mode authentication, the RADIUS servers must be configured
prior to creating the method list. You can configure all RADIUS servers in the system using the command
radius-server on page 1065. You can configure individual RADIUS servers using the command
radius-server host on page 1067. Once the RADIUS servers have been configured, you can use all
RADIUS servers for authentication by using the group radius method. If you only want to use some of the
available RADIUS servers for authentication, you can create a named server group and add the RADIUS
servers to the group. Server groups are created using the command aaa group server on page 748 and
servers are added to the group as outlined in the RADIUS Group Command Set on page 2570.
For more information about AAA authentication, or AAA configuration in general, refer to the Configuring
AAA in AOS configuration guide available online at http://kb.adtran.com.
Usage Examples
The following example specifies using the line password as the first method of authentication and using the
Enable mode password as the second:
(config)#aaa authentication enable default line enable

aaa authentication fail-message <message>

Use the aaa authentication fail-message command to specify the authentication, authorization, and
accounting (AAA) authentication fail message. This message is displayed if user authentication fails. Use
the no form of this command to return to the default message.
Syntax Description
<message> Specifies the message shown if user authentication fails. The message can
be multiple lines. Enter a delimiter (such as #) to begin recording the typed
text message displayed after a failed authentication attempt. The message
must end with the same delimiter to indicate that the message is complete.
The text delimiters are not displayed to the screen during operation.
Default Values
By default, the authentication fail message banner is set to Authentication failed.
Command History
Usage Examples
The following example changes the authentication fail message to Failed Authentication. Please try
again.:
(config)#aaa authentication fail-message #

Enter TEXT message. End with the character ‘#’.
Failed Authentication. Please try again.
(config)#

aaa authentication login

Use the aaa authentication login command to create and define a default or named method list for use
with authentication, authorization, and accounting (AAA) authentication services. The AAA
authentication login method list specifies the methods used to authenticate a user upon login. Use the no
form of this command to disable the authentication login method list. Variations of this command include:
aaa authentication login default enable

aaa authentication login default group radius
aaa authentication login default group tacacs+
aaa authentication login default group <name>
aaa authentication login default line
aaa authentication login default local
aaa authentication login default none
aaa authentication login <listname> enable
aaa authentication login <listname> group radius
aaa authentication login <listname> group tacacs+
aaa authentication login <listname> group <name>
aaa authentication login <listname> line
aaa authentication login <listname> local
aaa authentication login <listname> none
Each method parameter after default or <listname> specifies the authentication method
to be attempted in the order in which they are to be tried. Multiple methods can be
specified for authentication, but the authentication procedure is dependent upon the entry
order of the methods.
Syntax Description
default Creates and defines the default login authentication method list to use
<listname> Creates and names the login authentication method list to use rather than
the default list.
situation.
line Specifies using the line password (Telnet 0 through 4 or console 0 through
1) for authentication. The line password must be configured to use this
method (using the password <password> command from the appropriate
line interface configuration mode prompt).
enable Specifies using the Enable mode password for authentication. The Enable
mode password must be defined to use this method (using the command
enable password <password> on page 797).

local Specifies using the local user name for authentication. User names must be
in the local user name database to use this method. User names are set
using the command username <username> password <password> on page
1125.
information.
group tacacs+ Specifies that all defined terminal access controller access-control system
plus (TACACS+) servers are used for authentication. TACACS+ servers
more information.
group <name> Specifies using a subset of TACACS+ or RADIUS servers for
authentication. Subsets are named server groups previously created using
the command aaa group server on page 748. A server group must be
Default Values
By default, AAA authentication login method lists are not defined. Once a default list is defined, it is
automatically applied to all line interfaces unless a named list is created and applied manually.
Command History
Release 11.1 The group tacacs+ command was added.
Functional Notes
authentication can verify a user’s permission to access the unit by using the aaa authentication login
command to create a method list that monitors user access permissions.

The two types of method lists created using the aaa authentication login command are a default list and
a named list. A default list is one that is created and automatically applied to all line interfaces at the global
interface. Named AAA login authentication method lists are applied to line interfaces using the login
authentication <listname> command from the appropriate line interface configuration mode (Line
(Console) Interface Command Set on page 1207, Line (Telnet) Interface Command Set on page 1235, or
Line (SSH) Interface Command Set on page 1223).
To use TACACS+ servers to perform login authentication, the TACACS+ servers must be configured prior
to creating the method list. You can configure all TACACS+ servers in the system using the command
TACACS+ servers for authentication by using the group tacacs+ method. If you only want to use some of
the available TACACS+ servers for authentication, you can create a named server group and add the
TACACS+ servers to the group. Server groups are created using the command aaa group server on page
748 and servers are added to the group as outlined in the TACACS+ Group Command Set on page 2602.
To use RADIUS servers to perform login authentication, the RADIUS servers must be configured prior to
creating the method list. You can configure all RADIUS servers in the system using the command
Usage Examples
The following example creates a login authentication list called myList and specifies using the local
database as the first method, myGroup as the second method, and line password as the third method for
login authentication:
(config)#aaa authentication login myList local group myGroup line
The following command sets the default authentication list for logins to use the local database as the first
authentication method:
(config)#aaa authentication login default local

aaa authentication password-prompt <prompt>

Use the aaa authentication password-prompt command to specify the message shown when prompting a
user for their password during authentication, authorization, and accounting (AAA) authentication. The no
form of this command returns the prompt to the default prompt.
Syntax Description
<prompt> Specifies the prompt that displays when prompting users for their password.
Enter a single line of text enclosed in quotation marks.
Default Values
By default, the authentication password prompt is set to Password:.
Command History
Usage Examples
The following example specifies the authentication password prompt reads Please Enter Your
Password::
(config)#aaa authentication password-prompt “Please Enter Your Password:”

aaa authentication port-auth default

Use the aaa authentication port-auth default command to create and define the default method list for
use with authentication, authorization, and accounting (AAA) port authentication services. Use the no
form of this command to disable the authentication list. Variations of this command include:
aaa authentication port-auth default group radius

aaa authentication port-auth default group <name>
aaa authentication port-auth default local
aaa authentication port-auth default none
Each method parameter after default specifies the authentication method to be attempted
in the order in which they are to be tried. Multiple methods can be specified for
authentication, but the authentication procedure is dependent upon the entry order of the
methods.
Syntax Description
situation.
local Specifies using the local user name for port authentication. User names
must be in the local user name database to use this method. User names
are set using the command username <username> password <password>
on page 1125.
information.
group <name> Specifies using a subset of RADIUS servers for port authentication. Subsets
are named server groups previously created using the command aaa group
Default Values
By default, no port authentication method lists are defined.
Command History
Functional Notes
authentication can verify port usage by using the aaa authentication port-auth default command to
create the default method list that monitors port usage.

The type of method lists created using the aaa authentication port-auth default command is a default
list. A default list is one that is created and automatically applied to all line interfaces at the global level.
To use RADIUS servers to perform port authentication, the RADIUS servers must be configured prior to
creating the method list. You can configure all RADIUS servers in the system using the command
Usage Examples
The following example specifies that the local user database be used for port authentication:
(config)#aaa authentication port-auth default local

aaa authentication username-prompt <prompt>

Use the aaa authentication username-prompt command to specify the message shown when prompting
a user for their user name during authentication, authorization, and accounting (AAA) authentication. Use
the no form of this command to return to the default prompt.
Syntax Description
<prompt> Specifies the prompt that displays when prompting users for their user
name. Enter a single line of text enclosed in quotation marks.
Default Values
By default, the authentication user name prompt is set to Username:.
Command History
Usage Examples
The following example specifies the authentication user name prompt reads Please Enter Your User
Name::
(config)#aaa authentication username-prompt “Please Enter Your User Name:”

aaa authorization commands <level>

Use the aaa authorization commands command to create and define a default or named authorization
method list for use with authentication, authorization, and accounting (AAA) authorization services. AAA
command authorization method lists are used to allow or restrict the use of certain commands on a per-user
basis. Use the no form of this command to disable the authorization commands method list. Variations of
aaa authorization commands <level> default group tacacs+

aaa authorization commands <level> default group <name>
aaa authorization commands <level> default if-authenticated
aaa authorization commands <level> default none
aaa authorization commands <level> <listname> group tacacs+
aaa authorization commands <level> <listname> group <name>
aaa authorization commands <level> <listname> if-authenticated
aaa authorization commands <level> <listname> none
Each method parameter after default or <listname> specifies the authorization method to
be attempted in the order in which they are to be tried. Multiple methods can be specified
for authorization, but the authorization procedure is dependent upon the entry order of the
methods.
Syntax Description
<level> Specifies whether the method list applies to Level 1 (unprivileged) or Level
15 (privileged) commands.
<listname> Creates and names the authorization commands method list to use rather
than the default list.
default Creates and defines the default authorization commands method list to use
none Specifies that no authorization methods are used for command
authorization. If this method is entered, it should come at the end of the list
of authorization methods in the command entry. This method should only be
used to prevent a lock-out situation.
if-authenticated Specifies that authorization is successful if the user has already been
authenticated. AAA authentication must be configured to use this method.
Refer to the Functional Notes for more information.
group tacacs+ Specifies using all terminal access controller access-control system plus
(TACACS+) servers for authorizing command usage. TACACS+ servers
more information.
group <name> Specifies using a subset of TACACS+ servers for authorizing command
usage. Subsets are named server groups previously created using the
command aaa group server on page 748. A server group must be

Default Values
By default, no AAA authorization method lists are defined or applied.
Command History
Functional Notes
AAA authorization is an AAA service that helps limit the network services available to users. Authorization
works by retrieving information from the user’s profile (stored either on the local database or security
server) and uses that information to determine the areas of the network to which the user is allowed
access. In AOS, AAA authorization can limit the commands available to a specific user and specify
whether or not users can access privileged command line interface (CLI) sessions. Limiting available
commands on a per-user basis is achieved by using the aaa authorization commands command to
create a default or named method list that specifies which level of commands (Level 1 or Level 15) are
authorized.
The user command privilege level (1 or 15) must be defined in addition to specifying all of
the commands available on a per-user basis in the configuration of the TACACS+ server.
Commands of a particular level are not checked for authorization unless explicitly defined
in the configuration with a method list. For example, if a method list is defined for Level 1
commands but not Level 15, then a user is able to enter any Level 15 commands since no
authorization takes place due to the lack of a Level 15 commands method list. The same
user will only be allowed to enter the Level 1 commands configured for the user in the
Level 1 commands method list.
Before AAA authorization method lists can be configured or applied, AAA must be enabled. To enable
Each AAA authorization method list relies on a combination of authorization methods. Each method must
be entered into the list in the order that they are to be performed. Although these methods can be entered
in any order, each can only be used once. The exception is the group <name> method that can be entered
multiple times to accommodate multiple configured server groups. If the unit fails to make a connection
with the first group listed, it will try the next group specified.

The two types of method lists created using the aaa authorization commands command are a default list
interface. Named AAA command authorization method lists are applied to line interfaces using the
authorization commands <level> <listname> command from the appropriate line interface configuration
mode (Line (Console) Interface Command Set on page 1207, Line (Telnet) Interface Command Set on
page 1235, or Line (SSH) Interface Command Set on page 1223).
To use TACACS+ servers to perform command authorization, the TACACS+ servers must be configured
prior to creating the method list. You can configure all TACACS+ servers in the system using the command
TACACS+ servers for authorization by using the group tacacs+ method. If you only want to use some of
the available TACACS+ servers for authorization, you can create a named server group and add the
TACACS+ servers to the group. Server groups are created using the command aaa group server on page
748 and servers are added to the group as outlined in the TACACS+ Group Command Set on page 2602.
For more information about AAA authorization, or AAA configuration in general, refer to the Configuring
Usage Examples
The following example creates a command authorization method list called myList, which authorizes
unprivileged commands (this succeeds only if the user has been authenticated successfully):
(config)#aaa authorization commands 1 myList if-authenticated
The following command defines the default command authorization method list to authorize privileged
(level 15) commands against all defined TACACS+ servers:
(config)#aaa authorization commands 15 default group tacacs+
If command authorization is used in conjunction with a TACACS+ server, the same user
name that is used to access AOS must be configured on the server.

aaa authorization config-command

Use the aaa authorization config-command command to enable or disable authorization for
configuration mode commands in AOS authentication, authorization, and accounting (AAA) services. This
command is used to verify that command-level authorization is enabled before applying AAA command
authorization method lists to a specific line interface. Use the no form of this command to disable
authorization for configuration commands.
Syntax Description
No subcommands.
Default Values
By default, authorization for configuration commands is enabled.
Command History
Functional Notes
The aaa authorization config-command command is used to ensure that authorization for configuration
commands is enabled at the global level before applying any AAA authorization method lists to a line
interface (console, Telnet, or secure shell (SSH)). This feature must be enabled before AAA authorization
method lists can be applied to the interface.
Usage Examples
The following example enables authorization of configuration mode commands:
(config)#aaa authorization config-command

aaa authorization console

Use the aaa authorization console command to enable AOS authentication, authorization, and accounting
(AAA) on the console interface. This command is used to verify that the console interface will allow AAA
operation before an AAA authorization method list is applied to the console interface. Use the no form of
this command to disable AAA on the console interface.
Syntax Description
No subcommands.
Default Values
By default, authorization is disabled on a console line interface. This measure prevents accidental lockout
issues on directly connected lines.
Command History
Functional Notes
AAA authorization method lists cannot be applied to a console interface until the aaa authorization
console command has been issued.
Usage Examples
The following example enables AAA authorization use on console interfaces:
(config)#aaa authorization console

aaa authorization exec

Use the aaa authorization exec command to create and define a default or named authorization method
list for use with authentication, authorization, and accounting (AAA) authorization services. The
authorization exec method list sets the parameters for authorizing access to the Enable mode in the
command line interface (CLI). Use the no form of this command to disable the authorization method list.
aaa authorization exec default group <name>

aaa authorization exec default group tacacs+
aaa authorization exec default if-authenticated
aaa authorization exec default none
aaa authorization exec <listname> group <name>
aaa authorization exec <listname> group tacacs+
aaa authorization exec <listname> if-authenticated
aaa authorization exec <listname> none
Each method parameter after default or <listname> specifies the authorization method to
be attempted in the order in which they are to be tried. Multiple methods can be specified
for authorization, but the authorization procedure is dependent upon the entry order of the
methods.
Syntax Description
default Creates and defines the default authorization method list to use rather than
a named method list.
<listname> Creates and names the authorization method list to use rather than the
default list.
none Specifies that no authorization methods are used for executive
authorization. If this method is entered, it should come at the end of the list
of authorization methods in the command entry. This method should only be
used to prevent a lock-out situation.
if-authenticated Specifies that authorization is successful if the user has already been
authenticated. AAA authentication must be configured to use this method.
group tacacs+ Specifies using all terminal access controller access-control system plus
(TACACS+) servers for authorizing executive CLI privileges. TACACS+
servers must be configured to use this method. Refer to the Functional
Notes for more information.
group <name> Specifies using a subset of TACACS+ servers for authorizing executive CLI
privileges. Subsets are named server groups previously created using the
command aaa group server on page 748. A server group must be
Default Values
By default, AAA authorization for executive CLI privileges is disabled and no authorization method lists are
defined.

Command History
Functional Notes
AAA authorization is an AAA service that helps limit the network services available to users. Authorization
works by retrieving information from the user’s profile (stored either on the local database or security
server) and uses that information to determine the areas of the network to which the user is allowed
access. In AOS, AAA authorization can limit the commands available to a specific user and specify
whether or not users can access privileged CLI sessions. Limiting access to privileged CLI sessions is
achieved by using the aaa authorization exec command to create a default or named method list that
restricts access to Enable mode.
Before AAA authorization method lists can be configured or applied, AAA must be enabled. To enable
Each AAA authorization method list relies on a combination of authorization methods. Each method must
be entered into the list in the order that they are to be performed. Although these methods can be entered
in any order, each can only be used once. The exception is the group <name> method that can be entered
multiple times to accommodate multiple configured server groups. If the unit fails to make a connection
with the first group listed, it will try the next group specified.
The two types of method lists created using the aaa authorization exec command are a default list and a
named list. A default list is one that is created and automatically applied to all line interfaces at the global
interface. Named AAA exec authorization method lists are applied to line interfaces using the
authorization exec command from the appropriate line interface configuration mode (Line (Console)
To use TACACS+ servers to perform Enable mode authorization, the TACACS+ servers must be
use all TACACS+ servers for authorization by using the group tacacs+ method. If you only want to use
some of the available TACACS+ servers for authorization, you can create a named server group and add
the TACACS+ servers to the group. Server groups are created using the command aaa group server on
page 748 and servers are added to the group as outlined in the TACACS+ Group Command Set on page
2602.

Usage Examples
The following example creates an executive mode authorization method list (called myList) to authorize
user access to Enable mode in the CLI (this succeeds only if the user has been authenticated
successfully):
(config)#aaa authorization exec myList if-authenticated
The following example specifies to use the default executive mode authorization method list to authorize
access to Enable mode using all TACACS+ servers:
(config)#aaa authorization exec default group tacacs+
If a TACACS+ server is used in conjunction with an executive mode access authorization

method list, the user name used to access the AOS device must be configured as a Level 15
user on the TACACS+ server.

aaa group server

Use the aaa group server command to create a group of remote authentication dial-in user service
(RADIUS) servers or a group of terminal access controller access-control system plus (TACACS+)
servers. These server groups can be used as methods for authentication, authorization, and accounting
(AAA) services in AOS. Use the no form of this command to remove a configured server group.
aaa group server radius <group name>

aaa group server tacacs+ <group name>
Syntax Description
radius <group name> Creates and names a group of RADIUS servers.
tacacs+ <group name> Creates and names a group of TACACS+ servers.
Default Values
By default, no named server groups exist.
Command History
Release 11.1 Command was expanded to include TACACS+ server support.
Functional Notes
Server groups can be beneficial when used with AAA method lists because they provide a way to verify
AAA services without using all of the configured RADIUS or TACACS+ servers. These server groups are a
subset of all RADIUS or TACACS+ servers and can save server resources for other network needs.
Servers must be configured before they can be added to the server group for use with AAA. To configure
RADIUS servers on an individual basis, use the command radius-server host on page 1067. To configure
all RADIUS servers alike, use the command radius-server on page 1065. To configure TACACS+ servers
on an individual basis, use the command tacacs-server host on page 1117. To configure all TACACS+
servers alike, use the command tacacs-server on page 1116. It is important to remember when configuring
servers for the server group that individual server configurations override any global server configurations.
Once the servers are configured, the aaa server group command allows you to begin creating a server
group. When you enter the command from the Global Configuration mode prompt, you enter the Server
Group Configuration mode. At this point, you can begin to add servers to the group using the server
command as detailed in the RADIUS Group Command Set on page 2570 and in the TACACS+ Group
For more information on group server configurations and their use with AAA, refer to the Configuring AAA

Usage Examples
The following example creates the named list RADauthentication and enters the RADIUS Group
Configuration mode for RADIUS servers:
(config)#aaa group server radius RADauthentication

(config-sg-radius)#
The following example creates the named list TACaccount and enters the TACACS+ Group Configuration
mode for TACACS+ servers:
(config)#aaa group server tacacs+ TACaccount


aaa local authentication attempts max-fail <number>

Use the aaa local authentication attempts max-fail command to set the maximum number of failed
authentication attempts allowed before closing the terminal session when using AAA authentication. Use
the no form of this command to return to the default setting.
Syntax Description
<number> Specifies the maximum number of failed authentication attempts allowed
before closing the terminal session. Valid range is 1 to 25 attempts.
Default Values
By default, the session closes after 3 failed attempts.
Command History
Usage Examples
The following example configures the device to allow a maximum of 10 failed authentication attempts
before closing the session:
(config)#aaa local authentication attempts max-fail 10

aaa on
Use the aaa on command to activate authentication, authorization, and accounting (AAA) services. Use
the no form of this command to deactivate AAA.
Syntax Description
No subcommands.
Default Values
By default, AAA is not activated.
Command History
Functional Notes
By default, AAA is disabled. AAA must be enabled for additional AAA configuration commands to be
available. If AAA is enabled, AAA methods will override other security methods specified in the line
interface.
For more information about the use and configuration of AAA, refer to the Configuring AAA in AOS
Usage Examples
The following example activates AAA services:
(config)#aaa on

aaa processes <value>

Use the aaa processes command to set the number of threads available to the authentication, authorization,
and accounting (AAA) background processes. Use the no form of this command to return to the default
setting.
Syntax Description
<value> Specifies the number of threads available to the AAA subsystem. Range is
1 to 64 threads.
Default Values
By default, the number of threads is set to 1.
Command History
Functional Notes
Increasing the number of threads may speed up simultaneous authentication processes, but can do so at
the cost of system resources (for example, memory).
For more information about AAA, refer to the Configuring AAA in AOS configuration guide available online
at http://kb.adtran.com.
Usage Examples
The following example specifies five available threads for AAA background processes:
(config)#aaa processes 5

arp <ip address> <mac address> arpa

Use the arp arpa command to enter static entries into the Address Resolution Protocol (ARP) table for a
specific VPN routing and forwarding (VRF) instance. Use the no form of this command to remove a static
ARP entry. Variations of this command include:
arp <ip address> <mac address> arpa

arp <ip address> <mac address> vrf <name> arpa
Syntax Description
<ip address> Specifies a valid IP address. IP addresses should be expressed in dotted
<mac address> Specifies a valid 48-bit medium access control (MAC) address. MAC
addresses should be expressed in the following format xx:xx:xx:xx:xx:xx (for
example, 00:A0:C8:00:00:01).
vrf <name> Optional. Specifies the VRF where the ARP table exists.
Default Values
Command History
Functional Notes
Usage Examples
The following example enters the IP address and MAC address into the ARP table that is located in the
default VRF:
(config)#arp 10.10.10.1 00:A0:C8:00:00:01 arpa

auto-config
Use the auto-config command to enable the automatic self-configuration feature in AOS. For more
detailed information, refer to the Auto-Config configuration guide on the AOS Documentation CD. Use the
no form of this command to halt the automatic configuration process. Variations of this command include:
auto-config
auto-config filename <name>
auto-config restart
auto-config retry-count <number>
auto-config server [<hostname> | <ip address>]
Syntax Description
filename <name> Optional. Specifies the configuration file name to download.
restart Optional. Restarts automatic configuration parameters.
retry-count <number> Optional. Specifies the maximum number of retries. Range is
0 to 1000.
server [<hostname> | <ip address>] Optional. Specifies the IP address or host name of Trivial File
Transfer Protocol (TFTP) server from which to download. IP
example, 10.10.10.1).
Default Values
By default, automatic configuration is disabled.
Command History
Usage Examples
The following example enables automatic configuration:
(config)#auto-config
Disabling and re-enabling auto-config restarts the download process.
The following command specifies the name of the file to download:
(config)#auto-config filename myConfig

The following command restarts the automatic configuration process:
(config)#auto-config restart
The following command sets the number of retries when downloading a configuration file to 100:
(config)#auto-config retry-count 100
The following command specifies the TFTP server IP address from which to download the configuration
file:
(config)#auto-config server 192.33.5.99
The following command specifies the TFTP server host name from which to download the configuration
file:
(config)#auto-config server myHost

auto-link
Use the auto-link command to enable the auto-link feature. Auto-link allows a client device to connect to
an ADTRAN n-Command® managed service provider (MSP) network management appliance. Use the no
form of this command to disable Auto-Link.
Syntax Description
No subcommands.
Default Values
By default, auto-link is disabled.
Command History
Functional Notes
The n-Command client must first be configured and enabled before the n-Command MSP server can be
contacted. The n-Command MSP server is a network management appliance that enables auto-discovery
and provides a central management solution for configuration changes, firmware updates, and basic
monitoring. Without enabling auto-link, the client will not be detected by the server.
Usage Examples
The following example enables auto-link:
(config)#auto-link

auto-link http
Use the auto-link http command to specify the communication method between an AOS device and the
n-Command® managed service provider (MSP) server. Communication can be either via Hypertext
Transfer Protocol (HTTP) or Hypertext Transfer Protocol over Secure Socket Layer (HTTPS). Use the no
form of this command to return to the default setting. Variations of this command include:
auto-link http
auto-link https
Syntax Description
http Specifies that the client use the HTTP post method.
https Specifies that the client use the HTTPS post method.
Default Values
By default, auto-link uses HTTPS.
Command History
Usage Examples
The following example specifies that the client use HTTP to communicate with the server:
(config)#auto-link http

auto-link recontact-interval <value>

Use the auto-link recontact-interval command to specify the intervals between contact attempts between
the AOS client and the n-Command® managed service provider (MSP) server. Use the no form of this
command to return to the default value.
Syntax Description
<value> Specifies the time in seconds between contact attempts. Range is 20 to
604800 seconds. Setting this value to 0 seconds disables the recontact
feature.
Default Values
By default, the recontact interval is set to 3600 seconds.
Command History
Usage Examples
The following example sets the recontact interval to 7200 seconds:
(config)#auto-link recontact-interval 7200

auto-link server <hostname | ip address>

Use the auto-link server command to specify the contact information for the n-Command® managed
service provider (MSP) server used by the AOS client. Use the no form of this command to remove the
server from the client configuration.
Syntax Description
<hostname | ip address> Specifies the server host name or IP address. IP addresses should be
expressed in the decimal dotted notation (for example 10.10.10.1).
Default Values
By default, no server is configured.
Command History
Usage Examples
The following example specifies the AOS client will communicate with the n-Command MSP server at IP
address 10.10.10.10:
(config)#auto-link server 10.10.10.10

banner
Use the banner command to specify messages to be displayed in certain situations. Use the no form of this
command to delete a previously configured banner. Variations of this command include:
banner exec <delimiter> <message> <delimiter>

banner login <delimiter> <message> <delimiter>
banner motd <delimiter> <message> <delimiter>
Syntax Description
exec Creates a message to be displayed when any executive-level process takes
place.
login Creates a message to be displayed before the user name and password
login prompts.
motd Creates a message-of-the-day (MOTD) banner.
<delimiter> Specifies the banner text delimiter. Press Enter after the delimiter character
to begin input of banner text. After typing the banner message, enter the
same delimiter character to end the message.
<message> Specifies the text message you wish to display.
Default Values
By default, no banners are configured.
Command History
Functional Notes
Banners appear in the following order (if configured):
• MOTD banner appears at initial connection.

• Login banner follows the MOTD banner.
• Exec banner appears after successful login.
Usage Examples
The following example configures the system to display a message of the day:
(config)#banner motd *The system will be shut down today from 7PM to 11PM*

boot config
Use the boot config command to modify system boot parameters by specifying the location and name of
primary and secondary configuration files. Variations of this command include:
boot config cflash <primary filename>

boot config cflash <primary filename> cflash <secondary filename>
boot config cflash <primary filename> flash <secondary filename>
boot config flash <primary filename>
boot config flash <primary filename> cflash <secondary filename>
boot config flash <primary filename> flash <secondary filename>
The cflash parameter is only valid for units with CompactFlash® capabilities.
Syntax Description
cflash Specifies that the configuration file is located in CompactFlash memory.
flash Specifies that the configuration file is located in flash memory.
<primary filename> Specifies the name of the primary configuration file (file names are case
sensitive).
<secondary filename> Optional. Specifies the name of the backup configuration file.
Default Values
Command History
Usage Examples
The following example specifies the file myconfig (located in flash memory) as the primary system boot
file:
(config)#boot config flash myconfig
The following example specifies the file myconfig (located in flash memory) as the primary system boot
file and the file mybackupconfig (located in CompactFlash memory) as the backup configuration file:
(config)#boot config flash myconfig cflash mybackupconfig

boot system
Use the boot system command to specify the system image loaded at startup. Variations of this command
include:
boot system cflash <primary filename>

boot system cflash <primary filename> verify
boot system flash <primary filename>
boot system flash <primary filename> verify
boot system flash <primary filename> <secondary filename>
boot system flash <primary filename> <secondary filename> verify
boot system cflash <primary filename> cflash <secondary filename>
boot system cflash <primary filename> cflash <secondary filename> verify
boot system cflash <primary filename> flash <secondary filename>
boot system cflash <primary filename> flash <secondary filename> verify
boot system cflash <primary filename> no-backup
boot system cflash <primary filename> no-backup verify
boot system flash <primary filename> cflash <secondary filename>
boot system flash <primary filename> cflash <secondary filename> verify
boot system flash <primary filename> flash <secondary filename>
boot system flash <primary filename> flash <secondary filename> verify
boot system flash <primary filename> no-backup
boot system flash <primary filename> no-backup verify
The cflash parameter is only valid for units with CompactFlash® capabilities.
For units without CompactFlash capabilities, the secondary media type does not need to
be specified. Refer to the last example under Usage Examples.
Syntax Description
cflash Specifies the system image is located in CompactFlash memory.
flash Specifies the system image is located in flash memory.
no-backup Specifies that there is no backup image present.
<primary filename> Specifies the file name of the image (file names are case sensitive). Image
files should have a .biz extension.
<secondary filename> Specifies a name for the backup image.
verify Optional. Verifies the image checksum.
Default Values

Command History
Release 12.1 Command was expanded to include CompactFlash.
Functional Notes
Detailed instructions for upgrading AOS and loading files into flash memory are found on the AOS
Documentation CD.
Usage Examples
The following example specifies myimage.biz (located in CompactFlash memory) as the primary image
file with no backup image:
(config)#boot system cflash myimage.biz no-backup
The following example specifies myimage.biz (located in flash memory) as the primary image file with no
backup image:
(config)#boot system flash myimage.biz no-backup
The following example specifies myimage.biz (located in flash memory) as the primary image file and
myimage_backup.biz (also located in flash memory) as the backup image:
(config)#boot system flash myimage.biz myimage_backup.biz

boot voip
Use the boot voip command to specify the VoIP image file loaded at startup. Variations of this command
include:
boot voip default

boot voip flash <filename>
Syntax Description
default Uses default VoIP image.
flash <filename> Specifies the file name (located in flash memory) of the image (file names
are case sensitive). Image files should have a .biz extension.
Default Values
Command History
Functional Notes
Detailed instructions for upgrading AOS and loading files into flash memory are found on the AOS
Documentation CD shipped with your unit or online at http://kb.adtran.com.
Usage Examples
The following example specifies the file myimage.biz, stored in flash memory, as the VoIP startup image:
(config)#boot voip flash myimage.biz

bridge irb
Use the bridge irb command to enable integrated routing and bridging (IRB) and also allow the creation of
bridged virtual interfaces (BVIs). Use the no form of this command to disable the IRB.
Syntax Description
No subcommands.
Default Values
By default, IRB is disabled.
Command History
Functional Notes
The bridge irb must be enabled to create BVIs.
Once the command bridge irb is entered, the IP addresses for any interfaces connected to any bridge will
be removed. Also, the command ip address xx.xx.xx.xx.xx.xx.xx.xx will no longer be available on an
interface that is connected to the bridge.
The BVI must be removed before using the no bridge irb command.
For more information on BVI configuration, refer to the BVI Interface Command Set on page 1618.
Usage Examples
The following example enables IRB:
(config)#bridge irb
Technology Review
The IRB allows the routing of specified protocols between network interfaces and bridge groups. The
difference between IRB and concurrent routing and bridging (CRB) is that in IRB it is possible to route IP
between routed interfaces and BVIs, but with CRB the routed interfaces cannot communicate with bridged
interfaces. IRB’s primary goal is to bridge all protocols and route any IP traffic destined for the medium
access control (MAC) address of the BVI.
The IRB handles IP packets in the following manner: When an IP packet comes into the router and it is not
destined for the MAC address, it is bridged. If the IP packet is destined for the MAC address, it is sent to
the routing engine and routed as normal. The IRB allows for PCs in the bridge to get to routed networks
and routed networks to get to the bridge. The bridge group will isolate broadcasts from other routed
interfaces.
A BVI can only be created when IRB is enabled and a bridge group has been defined. The BVI number
corresponds directly to the bridge group.

When IRB is enabled and a BVI is configured, IP network configuration is removed for all bridged
interfaces. IP traffic destined for the BVI address is delivered to the local IP stack for routing (if routing is
enabled) or management. If no BVI is configured, the behavior is the same as if IRB is not enabled.
When IRB is not enabled, a BVI cannot be created. Bridged interfaces retain their IP configuration, and IP
traffic destined for those interfaces is delivered to the local IP stack.

bridge <number> protocol ieee

The bridge protocol ieee command configures a bridge group for the IEEE 802.1 Ethernet spanning-tree
protocol. Use the no form of this command (with the appropriate arguments) to delete this setting.
Syntax Description
<number> Specifies a bridge group number. Range is 1 to 255.
Default Values
By default, all configured bridge interfaces implement IEEE spanning-tree protocol.
Command History
Usage Examples
The following example deletes the bridge protocol setting for bridge group 17:
(config)#no bridge 17 protocol ieee

clock
The clock auto-correct-DST command allows the unit to automatically correct for daylight savings time
(DST). Use the clock no-auto-correct-DST command to disable this feature. Variations of this command
include:
clock auto-correct-DST
clock no-auto-correct-DST
Syntax Description
auto-correct-DST Configures the unit to automatically correct for DST.
no-auto-correct-DST Disables DST correction.
Default Values
By default, DST correction takes place automatically.
Command History
Release 11.1 Command was added to the Global command set.
Functional Notes
Depending on the clock timezone chosen (refer to clock timezone <value> on page 770 for more
information), one-hour DST correction may be enabled automatically. You may override this default using
this command.
Usage Examples
The following example allows for automatic DST correction:
(config)#clock auto-correct-DST
The following example overrides the one-hour offset for DST:
(config)#clock no-auto-correct-DST

clock set <time> <day> <month> <year>

Use the clock set command to configure the system software clock. For the command to be valid, all fields
must be entered. Refer to the Usage Examples below for an example.
Syntax Description
<time> Sets the time (in 24-hour format) of the system software clock in the format
hours:minutes:seconds (HH:MM:SS).
<day> Sets the current day of the month. Valid range is 1 to 31.
<month> Sets the current month. Valid range is January to December. You need
only enter enough characters to make the entry unique. This entry is not
case sensitive.
<year> Sets the current year. Valid range is 2000 to 2100.
Default Values
Command History
Release 11.1 Command was added to the Global command set.
Usage Examples
The following example sets the system software clock for 3:42 pm, August 22 2004:
(config)#clock set 15:42:00 22 Au 2004

clock timezone <value>

The clock timezone command sets the unit’s internal clock to the time zone of your choice. This setting is
based on the difference in time (in hours) between Greenwich Mean Time (GMT) or Central Standard
Time (CST) and the time zone for which you are setting up the unit. Use the no form of this command to
Syntax Description
<value> Time zone values are specified in the Functional Notes section for this
command.
Default Values
Command History
Depending on the clock timezone chosen, one-hour daylight savings time (DST) correction
may be enabled automatically. Refer to the command clock on page 768 for more
information.

Functional Notes
The following list shows sample cities and their timezone codes.
clock timezone +1-Amsterdam clock timezone +8-Bejing
clock timezone +1-Belgrade clock timezone +8-Irkutsk
clock timezone +1-Brussels clock timezone +8-Kuala-Lumpur
clock timezone +1-Sarajevo clock timezone +8-Perth
clock timezone +1-West-Africa clock timezone +8-Taipei
clock timezone +10-Brisbane clock timezone +9-Osaka
clock timezone +10-Canberra clock timezone +9-Seoul
clock timezone +10-Guam clock timezone +9-Yakutsk
clock timezone +10-Hobart clock timezone +9:30-Adelaide
clock timezone +10-Vladivostok clock timezone +9:30-Darwin
clock timezone +11 clock timezone -1-Azores
clock timezone +12-Auckland clock timezone -1-Cape-Verde
clock timezone +12-Fiji clock timezone -10
clock timezone +13 clock timezone -11
clock timezone +2-Athens clock timezone -12
clock timezone +2-Bucharest clock timezone -2
clock timezone +2-Cairo clock timezone -3-Brasilia
clock timezone +2-Harare clock timezone -3-Buenos-Aires
clock timezone +2-Helsinki clock timezone -3-Greenland
clock timezone +2-Jerusalem clock timezone -3:30
clock timezone +3-Baghdad clock timezone -4-Atlantic-Time
clock timezone +3-Kuwait clock timezone -4-Caracus
clock timezone +3-Moscow clock timezone -4-Santiago
clock timezone +3-Nairobi clock timezone -5
clock timezone +3:30 clock timezone -5-Bogota
clock timezone +4-Abu-Dhabi clock timezone -5-Eastern-Time
clock timezone +4-Baku clock timezone -6-Central-America
clock timezone +4:30 clock timezone -6-Central-Time
clock timezone +5-Ekaterinburg clock timezone -6-Mexico-City
clock timezone +5-Islamabad clock timezone -6-Saskatchewan
clock timezone +5:30 clock timezone -7-Arizona
clock timezone +5:45 clock timezone -7-Mountain-Time
clock timezone +6-Almaty clock timezone -8
clock timezone +6-Astana clock timezone -9
clock timezone +6-Sri-Jay clock timezone -0-Universal Coordinated Time
clock timezone +6:30 (UTC)
clock timezone +7-Bangkok clock timezone GMT-Casablanca
clock timezone +7-Kranoyarsk clock timezone GMT-Dublin

Usage Examples
The following example sets the timezone for Santiago, Chile.
>enable
(config)#clock timezone -4-Santiago

crypto ca authenticate <name>

Use the crypto ca authenticate command to initiate certificate authority (CA) authentication procedures.
Syntax Description
<name> Specifies a CA profile using an alphanumeric string up to 32 characters.
Default Values
Command History
Functional Notes
The type of authentication procedure is based on the enrollment command and its settings. Refer to
enrollment terminal on page 3014 and enrollment url <url> on page 3015 for more information. When
enrollment is set to terminal, the CA authentication process is done manually, as shown in the following
Usage Examples.
Usage Examples
The following example initiates the CA authentication process:
(config)#crypto ca authenticate testCAprofile
Enter the base 64 encoded CA certificate. End with two consecutive carriage returns or the word “quit” on
a line by itself:
-----BEGIN X509 CERTIFICATE-----

MIIDEDCCAs6gAwIBAgICAXIwCwYHKoZIzjgEAwUAMFoxCzAJBgNVBAYTAkZJMSQw
IgYDVQQKExtTU0ggQ29tbXVuaWNhdGlvbnMgU2VjdXJpdHkxETAPBgNVBAsTCFdl
YiB0ZXN0MRIwEAYDVQQDEwlUZXN0IENBIDQwHhcNMDMwMTA5MTYyNTE1WhcNMDMx
MjMxMjM1OTU5WjBaMQswCQYDVQQGEwJGSTEkMCIGA1UEChMbU1NIIENvbW11bmlj
YXRpb25zIFNlY3VyaXR5MREwDwYDVQQLEwhXZWIgdGVzdDESMBAGA1UEAxMJVGVz
dCBDQSA0MIIBtzCCASsGByqGSM44BAEwggEeAoGBAPTo+NdCWh87hOSnuZ7dUL07
twjZZwY3beLHnDsERhfN8XoOZZcffulKc/lqTrYiu7M5yPJsXQ3u8dbCb6RWFU0A
T5Nd7/4cNn/hCmhbeb6xqsNZUsOcTZJxvClq8thkNo+gXg5bw0fiElgxZ/lEbFWL
UzeO8KgM4izkq0CrGtaFAhUA2+ja4RgbbgTgJk+qTXAxicG/8JMCgYBZvcPMO2/Y
Zc2sXYyrBPtv6k2ZGGYqXAUZ98/txm37JwQGafygePJ/64oeisVeDcLf2FTjveex
W5saydjSK00jXjreRZcJFEDmfRhUtWR8K8tm8mEnB3eg9n09lkWibIjihHn7n5MF
tBBAdbRHyctsr3DyofnieTt3DY78MDsNbgOBhQACgYEA6EKDS2IxrdMsogHfVvob
PkDSv2FjOsP5Tomc/tf9jvvuf6+vj9XTw+uAg1BU9/TyjGzAtnRrCvOUkTYoVxRY
vdDOi3GR2RcyNVdGrhYXWY1I5XuB5+NWij8VUQOgfXsJgbEMvPemECeYwQ4ASdhD
vw0E8NI2AEkJXsCAvYfXWzujIzAhMAsGA1UdDwQEAwIBhjASBgNVHRMBAf8ECDAG
AQH/AgEyMAsGByqGSM44BAMFAAMvADAsAhRa0ao0FbRQeWCc2oC24OZ1YZi8egIU
IZhxKAclhXksZHvOj+yIld5x0ec=
-----END X509 CERTIFICATE-----

quit
Hash: 4e904504dc4e5b95e08129430e2a0b97ceef0ad1394f905b42df2dfb8f751be0244a711bb0
6eddaa2f07dd640c187f14c16fa0bed28e038b28b6741a880539d6ed06a68b7e324bfdde6f3d0b17
83d94e58fd4943f5988a7a0f27f6b6b932dc0410378247160752853858dbe7a1951245cfb14b109e
ffc430e177623720de56f4
* Do you accept this certificate? [y]y

crypto ca certificate chain <name>

Use the crypto ca certificate chain command to enter the Certificate Configuration for the specified
certificate authority (CA). Refer to Certificate Command Set on page 3021 for more information.
Syntax Description
<name> Specifies a CA profile using an alphanumeric string (up to 32 characters).
Default Values
Command History
Functional Notes
Typically used only in the running-config and startup-config to restore certificates.
Usage Examples
The following example enters the Certificate Configuration mode for the CA profile MyProfile:
(config)#crypto ca certificate chain MyProfile

crypto ca enroll <name>

Use the crypto ca enroll command to begin certificate authority (CA) enrollment procedures. Use the no
form of this command to disable this feature.
Syntax Description
<name> Specifies a CA profile using an alphanumeric string (up to 32 characters).
Default Values
Command History
Functional Notes
The type of enrollment procedure is based on the enrollment command and its settings. Refer to
enrollment terminal on page 3014 and enrollment url <url> on page 3015 for more information. This
command initiates a dialog that is used to fill in the parameters that make up an enrollment request to be
forwarded to a certificate authority. Note that some of the parameters (such as IP address) may be filled in
using the values supplied in the crypto ca profile (in which case, the enrollment dialog will not prompt for
those parameters). Once all required parameters are defined using the dialog, this command assembles
them into an enrollment request to be sent to a certificate authority (including the generation of public and
private keys). Refer to crypto ca profile <name> on page 779 for more information.
If enrollment is set to terminal, you may view the request on the terminal screen.
If enrollment is set to url, the request is sent automatically to the certificate authority using the uniform
resource locator (URL) specified by the enrollment url command.
Usage Examples
The following example shows a typical enrollment dialog:
(config)#crypto ca enroll MyProfile

**** Press CTRL+C to exit enrollment request dialog. ****
* Enter signature algorithm (RSA or DSS) [rsa]:rsa
* Enter the modulus length to use [512]:1024
* Enter the subject name as an X.500 (LDAP) DN:CN=Router,C=US,L=Huntsville,S=AL
--The subject name in the certificate will be CN=CN=Router,C=US,L=Huntsville,S=AL.
* Include an IP address in the subject name [n]:y
* Enter IP address or name of interface to use:10.200.1.45
* Include fully qualified domain name [n]:y
* Enter the fully qualified domain name to use:FullyQualifiedDomainName
* Include an email address [n]:y
* Enter the email address to use:myEmail@adtran.commyemail@email.com
Generating request (including keys)....

crypto ca import <name> certificate

Use the crypto ca import certificate command to import a certificate manually via the console terminal.
Syntax Description
<name> Specifies a certificate authority (CA) profile using an alphanumeric string
(up to 32 characters).
Default Values
Command History
Functional Notes
Puts command line interface (CLI) in mode where the certificate can be entered manually. Enter quit and a
carriage return (or simply enter two consecutive carriage returns) to exit this mode. Abort this mode by
pressing Ctrl-C. This command only applies if the enrollment command is set to terminal. Refer to
enrollment terminal on page 3014.
Usage Examples
The following example imports a certificate via the console terminal:
(config)#crypto ca import MyProfile certificate

Enter the PM-encoded certificate. End with two consecutive
carriage returns or the word “quit” on a line by itself:
-----BEGIN CERTIFICATE-----
MIIDWTCCAwOgAwIBAgIKFLCsOgAAAAAAtjANBgkqhkiG9w0BAQUFADBjMQswCQYD
VQQGEwJVUzEQMA4GA1UECBMHQUxBQkFNQTETMBEGA1UEBxMKSHVudHN2aWxsZTEa
MBgGA1UEChMRQWR0cmFuVGVjaFN1cHBvcnQxETAPBgNVBAMTCHRzcm91dGVyMB4X
DTAzMDYyNTE0MTM1NVoXDTAzMTIwNjE0NDkxM1owJDEPMA0GA1UEChMGYWR0cmFu
MREwDwYDVQQDEwhNeVJvdXRlcjBcMA0GCSqGSIb3DQEBAQUAA0sAMEgCQQClUKqs
fbTalej5m9gk2DMsbC9df3TilBz+7nRx3ZzGw75AQsqEMYeBY5aWi62W59jmxGSE
WX+E8EwBVbZ6JKk5AgMBAAGjggHWMIIB0jAXBgNVHREEEDAOhwQKCgoKggZNeUZx
ZG4wHQYDVR0OBBYEFJAvBRIjx1PROnkZ4v0D89yB1eErMIGcBgNVHSMEgZQwgZGA
FHGwIRAr11495MgrLNPiLzjvrb4JoWekZTBjMQswCQYDVQQGEwJVUzEQMA4GA1UE
CBMHQUxBQkFNQTETMBEGA1UEBxMKSHVudHN2aWxsZTEaMBgGA1UEChMRQWR0cmFu
VGVjaFN1cHBvcnQxETAPBgNVBAMTCHRzcm91dGVyghAZql7OwISgsUhfaSeGh0Ot
MGkGA1UdHwRiMGAwLaAroCmGJ2h0dHA6Ly90c3JvdXRlci9DZXJ0RW5yb2xsL3Rz
cm91dGVyLmNybDAvoC2gK4YpZmlsZTovL1xcdHNyb3V0ZXJcQ2VydEVucm9sbFx0
c3JvdXRlci5jcmwwgY0GCCsGAQUFBwEBBIGAMH4wPAYIKwYBBQUHMAKGMGh0dHA6
Ly90c3JvdXRlci9DZXJ0RW5yb2xsL3Rzcm91dGVyX3Rzcm91dGVyLmNydDA+Bggr
BgEFBQcwAoYyZmlsZTovL1xcdHNyb3V0ZXJcQ2VydEVucm9sbFx0c3JvdXRlcl90
-----END CERTIFICATE-----
Success!

crypto ca import <name> crl

Use the crypto ca import crl command to import a certificate revocation list (CRL) manually via the
console terminal.
Syntax Description
<name> Specifies a certificate authority (CA) profile using an alphanumeric string
(up to 32 characters).
Default Values
Command History
Functional Notes
Puts command line interface (CLI) in a mode where the CRL can be entered manually. Enter quit and a
carriage return (or simply enter two consecutive carriage returns) to exit this mode. This command only
applies if the enrollment command is set to terminal. Refer to enrollment terminal on page 3014.
Usage Examples
The following example allows you to manually paste in the CA’s CRL:
(config)#crypto ca import MyProfile crl

crypto ca profile <name>

Use the crypto ca profile command to define a certificate authority (CA) and to enter the CA Profile
Configuration. Use the no form of this command to disable this feature. Refer to CA Profile Command Set
on page 3010 for more information.
Syntax Description
<name> Creates a CA profile using an alphanumeric string (up to 32 characters).
Default Values
Command History
Functional Notes
Use this to specify the type of enrollment, as well as enrollment request parameters. Refer to the
Functional Notes of the command crypto ca enroll <name> on page 776 for more information.
Usage Examples
The following example creates the CA profile called MyProfile and enters the CA Profile Configuration for
that certificate authority:
(config)#crypto ca profile MyProfile

Configuring New CA Profile MyProfile.
(ca-profile)#

crypto ike
Use the crypto ike command to define the system-level local ID for Internet key exchange (IKE)
negotiations and to enter the IKE Client or IKE Policy command sets. Use the no form of this command to
disable these features. Variations of this command include the following:
crypto ike client configuration pool <name>

crypto ike local-id address
crypto ike policy <value>
Syntax Description
client configuration pool <name> Creates a local pool, assigns it the name of your choice and
enters the IKE Client command set. Clients that connect via an
IKE policy that specifies this pool name will be assigned values
from this pool. Refer to the section IKE Policy Command Set on
page 3063 for more information.
local-id address Sets the local ID during IKE negotiation to be the IP address of
the interface from which the traffic exits. This setting can be
overridden on a per-policy basis using the local-id command.
Refer to local-id on page 3070 for more information.
policy <value> Creates an IKE policy, assigns the sequence number value of
your choice, and enters the IKE Policy command set. Refer to
section IKE Policy Command Set on page 3063 for more
information.
Default Values
Command History
Usage Examples
The following example creates an IKE policy with a policy priority setting of 1 and enters the IKE Policy for
that policy:
(config)#crypto ike policy 1

Technology Review
The following example configures an AOS product for virtual private network (VPN) using IKE aggressive
mode with preshared keys (PSKs). The AOS product can be set to initiate IKE negotiation in main mode or
aggressive mode. The product can be set to respond to IKE negotiation in main mode, aggressive mode,
or any mode. In this example, the device is configured to initiate in aggressive mode and to respond to any
mode.
This example assumes that the AOS product has been configured with a wide area network (WAN) IP
address of 63.97.45.57 on interface ppp 1 and a local area network (LAN) IP address of 10.10.10.254 on
interface ethernet 0/1. The peer private IP Subnet is 10.10.20.0.
For more detailed information on VPN configuration, refer to the VPN configuration guide located on the
AOS Documentation CD provided with your product.
Step 1:
Enter the Global Configuration mode (i.e., config terminal mode).
>enable
#configure terminal
Step 2:
Enable VPN support using the ip crypto command. This command allows crypto maps to be applied to
interfaces, and enables the IKE server to listen for IKE negotiation sessions on User Datagram Protocol
(UDP) port 500.
(config)#ip crypto
Step 3:
Set the local ID. During IKE negotiation, local IDs are exchanged between the local device and the peer
device. In AOS, the default setting for all local IDs are configured by the crypto ike local-id command.
The default setting is for all local IDs to be the IPv4 address of the interface over which the IKE negotiation
is occurring. In the future, a unique system-wide host name or fully qualified domain name (FQDN) could
be used for all IKE negotiation.
(config)#crypto ike local-id address
Step 4:
Create IKE policy. In order to use IKE negotiation, an IKE policy must be created. Within the system, a list
of IKE policies is maintained. Each IKE policy is given a priority number in the system. That priority number
defines the position of that IKE policy within the system list. When IKE negotiation is needed, the system
searches through the list, starting with the policy with priority of 1, looking for a match to the peer IP
address.
An individual IKE policy can override the system local ID setting by having the local-id command specified
in the IKE policy definition. This command in the IKE policy is used to specify the type of local ID and the
local ID data. The type can be of IPv4 address, FQDN, or user-specified FQDN.

An IKE policy may specify one or more peer IP addresses that will be allowed to connect to this system. To
specify multiple unique peer IP addresses, the peer A.B.C.D command is used multiple times within a
single IKE policy. To specify that all possible peers can use a default IKE policy, the peer any command is
given instead of the peer A.B.C.D command inside of the IKE policy. The policy with the peer any
command specified will match to any peer IP address (and, therefore, should be given the highest
numerical priority number). This will make the policy the last one to be compared against during IKE
negotiation.

(config-ike)#no local-id
(config-ike)#peer 63.105.15.129
(config-ike)#initiate aggressive
(config-ike)#respond anymode
(config-ike-attribute)#encryption 3des
(config-ike-attribute)#hash sha
(config-ike-attribute)#authentication pre-share
(config-ike-attribute)#group 1
(config-ike-attribute)#lifetime 86400
Step 5:
Define the remote ID settings. The crypto ike remote-id command is used to define the remote ID for a
peer connecting to the system, specify the preshared key associated with the specific remote ID, and
(optionally) determine that the peer matching this remote ID should not use mode config (by using the
no-mode-config keyword). Refer to crypto ike remote-id on page 784 for more information.
(config)#crypto ike remote-id address 63.105.15.129 preshared-key mysecret123
Step 6:
Define the transform-set. A transform set defines the encryption and/or authentication algorithms to be
used to secure the data transmitted over the VPN tunnel. Multiple transform sets may be defined in a
system. Once a transform set is defined, many different crypto maps within the system can reference it. In
this example, a transform set named highly_secure has been created. This transform set defines
encapsulating security payload (ESP) with authentication implemented using 3DES encryption and SHA1
authentication.
(config)#crypto ipsec transform-set highly_secure esp-3des esp-sha-hmac

(cfg-crypto-trans)#mode tunnel
Step 7:
Define an IP access list. An extended access control list (ACL) is used to specify which traffic needs to be
sent securely over the VPN tunnel. The entries in the list are defined with respect to the local system. The
source IP address will be the source of the traffic to be encrypted. The destination IP address will be the
receiver of the data on the other side of the VPN tunnel.
(config)#ip access-list extended corporate_traffic

(config-ext-nacl)#permit ip 10.10.10.0 0.0.0.255 10.10.20.0 0.0.0.255 log deny ip any any

Step 8:
Create crypto map. A crypto map is used to define a set of encryption schemes to be used for a given
interface. A crypto map entry has a unique index within the crypto map set. The crypto map entry will
specify whether IKE is used to generate encryption keys or if manually specified keys will be used. The
crypto map entry will also specify who will be terminating the VPN tunnel, as well as which transform set or
sets will be used to encrypt and/or authenticate the traffic on that VPN tunnel. It also specifies the lifetime
of all created IPSec security associations (SAs).
(config)#crypto map corporate_vpn 1 ipsec-ike

(config-crypto-map)#match address corporate_traffic
(config-crypto-map)#set peer 63.105.15.129
(config-crypto-map)#set transform-set highly_secure
(config-crypto-map)#set security-association lifetime kilobytes 8000
(config-crypto-map)#set security-association lifetime seconds 28800
(config-crypto-map)#no set pfs
Step 9:
Configure a public interface. This process includes configuring the IP address for the interface and
applying the appropriate crypto map to the interface. Crypto maps are applied to the interface on which
encrypted traffic will be transmitted.
(config-ppp 1)#crypto map corporate_vpn
Step 10:
Configure a private interface. This process allows all traffic destined for the VPN tunnel to be routed to the
appropriate gateway.

(config-eth 0/1)#ip address 10.10.10.254 255.255.255.0
(config-eth 0/1)#no shutdown
(config-eth 0/1)#exit

crypto ike remote-id

Use the crypto ike remote-id command to specify the remote ID and to associate a preshared key with the
remote ID. Use the no form of this command to disable these features. Variations of this command include
the following:
crypto ike remote-id address <ip address>

crypto ike remote-id address <ip address> <option>
crypto ike remote-id any
crypto ike remote-id any <option>
crytpo ike remote-id asn1-dn <name>
crypto ike remote-id asn1-dn <name> <option>
crypto ike remote-id fqdn <name>
crypto ike remote-id fqdn <name> <option>
crypto ike remote-id user-fqdn <name>
crypto ike remote-id user-fqdn <name> <option>
The AOS virtual private network (VPN) feature must be enabled (using the ip crypto
command) for the VPN tunnel to be activated.
For VPN configuration example scripts, refer to the VPN configuration guide located on
the AOS Documentation CD provided with your unit.
Syntax Description
address <ip address> Specifies a valid remote IP address. IP addresses should be
expressed in dotted decimal notation (for example,
10.10.10.1).
any Allows any remote ID (type and value).
asn1-dn <name> Specifies an abstract syntax notation distinguished name as
the remote ID (enter this value in (Lightweight Directory
Access Protocol (LDAP) format).
fqdn <name> Specifies a fully qualified domain name (FQDN) (e.g.,
adtran.com) as the remote ID.
user-fqdn <name> Specifies a user FQDN or email address (e.g.,
user1@adtran.com) as the remote ID.
<option> Specifies an optional parameter corresponding to this remote
ID. Optional parameters include the following list:
<wildcard mask> Optional. Specifies the wildcard mask that corresponds to a
range of IP addresses (network) or a specific host. Wildcard
masks are expressed in dotted decimal notation (for
example, 0.0.0.255).

crypto map <name> <number> Optional. Specifies the crypto map name and sequence
number this remote ID corresponds to.
ike policy <value> Optional. Specifies the Internet key exchange (IKE) policy
sequence number value this remote ID corresponds to.
preshared-key <key> Optional. Associates a preshared key with this remote ID.
no-mode-config Optional. Specifies that the peer matching this remote ID
should not use mode config.
no-xauth Optional. Specifies that the peer matching this remote ID
should not use Xauth.
nat-t [v1 l v2] [allow l force I disable] Optional. Denotes whether peers matching this remote ID
should allow, disable, or force network address translation
(NAT) traversal versions 1 or 2.
Default Values
Command History
Release 5.1 Command was expanded to include the any, asn1-dn, and no-xauth
subcommands.
Release 7.1 Command was expanded to include the NAT traversal commands.
Functional Notes
The fqdn and user-fqdn <fqdn> line can include wildcard characters. The wildcard characters are “*” for a
0 or more character match and “?” for a single character match. Currently, the “?” cannot be set up using
the command line interface (CLI), but it can be transferred to the unit via the startup-config.
Example for user-fqdn:
john*@domain.com
will match:
johndoe@domain.com
johnjohn@adtran.comjohnjohn@myemail.com
john@adtran.comjohn@myemail.com
Example for fqdn:
*.domain.com
will match:
www.domain.com
ftp.domain.com
one.www.domain.com

The address remote ID can be in the form of a single host address or in the form of an IP address
wildcard.
Example for address type:
crypto ike remote id address 10.10.10.0 0.0.0.255
will match:
10.10.10.1
10.10.10.2
and all IP addresses in the form of 10.10.10.X (where X is 0 to 255)
The asn1-dn <name> line can include wildcard characters. The wildcard characters are “*” for a 0 or more
character match and “?” for a single character match. Currently, the “?” cannot be set up using the CLI, but
it can be transferred to the unit via the startup-config.
Example for typical asn1-dn format with no wildcards:
crypto ike remote-id asn1-dn “CN=MyRouter, C=US, S=ALCA, L=Huntsville, O=Adtran,

OU=TechSupport”
(matches only remote ID strings with all fields exactly the same)
Example for typical asn1-dn format with wildcards used to match a string within a field:
crypto ike remote-id asn1-dn “CN=*, C=*, S=*, L=*, O=*, OU=*”
(matches any asn1-dn remote ID string from a peer)
Example for typical asn1-dn format with wildcards used to match a portion of the remote ID:
crypto ike remote-id asn1-dn “CN=*, C=US, S=ALCA, L=Huntsville, O=Adtran, OU=*”
(matches any remote ID string with the same values for the C, S, L, and O fields, and any values in the CN
and OU fields)
Example for typical asn1-dn format with wildcards used to match a portion of a field:
crypto ike remote-id asn1-dn “CN=My*, C=US, S=ALCA, L=Huntsville, O=Adtran, OU=TechSupport”
(matches remote ID strings with all fields exactly the same, but with any CN field beginning with “My”)
Usage Examples
The following example assigns a remote ID of 63.97.45.57 and associates the preshared key mysecret
with the remote ID:
(config)#crypto ike remote-id address 63.97.45.57 preshared-key mysecret

crypto ipsec transform-set <name> <parameters>

Use the crypto ipsec transform-set command to define the transform configuration for securing data
(e.g., esp-3des, esp-sha-hmac, etc.). The transform set is then assigned to a crypto map using the map’s
set transform-set command. Refer to set transform-set on page 3041. Use the no form of this command to
For virtual private network (VPN) configuration example scripts, refer to the VPN
configuration guide located on the AOS Documentation CD provided with your unit.
Syntax Description
<name> Assigns a name to the transform set you are about to define.
<parameters> Assigns a combination of up to three security algorithms from the following
list:
• ah-md5-hmac, ah-sha-hmac
• esp-des, esp-3des, esp-aes-128-cbc, esp-aes-192-cbc,
esp-aes-256-cbc, esp-null
• esp-md5-hmac, esp-sha-hmac
Default Values
Command History
Functional Notes
Crypto map entries do not directly contain the transform configuration for securing data. Instead, the crypto
map is associated with transform sets that contain specific security algorithms.
If no transform set is configured for a crypto map, the entry is incomplete and will have no effect on the
system.
Usage Examples
The following example first creates a transform set (Set1) consisting of two security algorithms (up to three
may be defined), and then assigns the transform set to a crypto map (Map1):
(config)#crypto ipsec transform-set Set1 esp-3des esp-sha-hmac

(cfg-crypto-trans)#exit
(config)#crypto map Map1 1 ipsec-ike
(config-crypto-map)#set transform-set Set1

crypto map
Use the crypto map command to define crypto map names and numbers and to enter the associated mode
(either Crypto Map Internet key exchange (IKE) or Crypto Map Manual). Use the no form of this
command to disable this feature. Variations of this command include the following:
crypto map <name> <index> ipsec-ike

crypto map <name> <index> ipsec-manual
Syntax Description
<name> Names the crypto map. You can assign the same name to multiple crypto
maps, as long as the map index numbers are unique.
<index> Assigns a crypto map sequence number.
ipsec-ike Specifies the crypto map IKE (refer to Crypto Map IKE Command Set on
page 3025). This supports IPSec entries that will use IKE to negotiate keys.
ipsec-manual Specifies the crypto map manual (refer to Crypto Map Manual Command
Set on page 3042). This supports manually configured IPSec entries.
Default Values
Command History
Functional Notes
map is associated with transform sets that contain specific security algorithms (refer to crypto ipsec
transform-set <name> <parameters> on page 787).
Crypto map entries do not directly contain the selectors used to determine which data to secure. Instead,
the crypto map entry refers to an access control list (ACL). An ACL is assigned to the crypto map using the
match address command (refer to ike-policy <number> on page 3029).
If no transform set or access list is configured for a crypto map, the entry is incomplete and will have no
effect on the system.
When you apply a crypto map to an interface (using the crypto map command within the interface’s
mode), you are applying all crypto maps with the given map name. This allows you to apply multiple crypto
maps if you have created maps that share the same name, but have different map index numbers.

Usage Examples
The following example creates a new IPSec IKE crypto map called testMap with a map index of 10:
(config)#crypto map testMap 10 ipsec-ike

Technology Review
A crypto map entry is a single policy that describes how certain traffic is to be secured. There are two types
of crypto map entries: ipsec-manual and ipsec-ike. Each entry is given an index that is used to sort the
ordered list. When a nonsecured packet arrives on an interface, the crypto map set associated with that
interface is processed in order. If a crypto map entry matches the nonsecured traffic, the traffic is
discarded.
When a packet is to be transmitted on an interface, the crypto map set associated with that interface is
processed in order. The first crypto map entry that matches the packet will be used to secure the packet. If
a suitable security association (SA) exists, it is used for transmission. Otherwise, IKE is used to establish
an SA with the peer. If no SA exists, and the crypto map entry is “respond only,” the packet is discarded.
When a secured packet arrives on an interface, its security parameter index (SPI) is used to look up an SA.
If an SA does not exist, or if the packet fails any of the security checks (bad authentication, traffic does not
match SA selectors, etc.), it is discarded. If all checks pass, the packet is forwarded normally.

data-call
Use the data-call command to set the preauthentication defaults for inbound demand routing calls. Use the
no form of this command to return to the default setting. Variations of this command include:
data-call authentication protocol chap

data-call authentication protocol pap
data-call mtu <number>
data-call multilink
data-call sent authentication protocol chap
data-call sent authentication protocol pap
Syntax Description
authentication protocol Sets the authentication protocol expected for inbound calls. For more
detailed information on Challenge-Handshake Authentication Protocol
(CHAP) and Password Authentication Protocol (PAP), refer to the
Technology Review section of the command ppp authentication on
page 2054.
chap Configures CHAP authentication.
pap Configures PAP authentication.
mtu <number> Sets the maximum size for the transmit unit. Valid range is 64 to 1520.
Refer to the command mtu <size> on page 2051 for more detailed
syntax descriptions.
multilink Enables the negotiation of multilink maximum receive unit (MRU) size
for inbound calls.
sent authentication protocol Sets the authentication protocol sent for inbound calls. For more
detailed information on CHAP and PAP, refer to the Technology Review
section of the command ppp authentication on page 2054.
Default Values
By default, the authentication protocol is not configured, multilink is disabled, and the maximum
transmission unit (MTU) size is 1500.
Command History
Functional Notes
There are certain Point-to-Point Protocol (PPP) parameters that must be known before PPP can negotiate
an inbound call when using demand routing. To ensure PPP convergence, it is recommended (in most
cases) that demand routing interfaces use the same settings as those specified in the data-call
commands. The data-call mtu <number> command sets the MTU and controls the negotiated MRU size
during incoming calls for Link Control Protocol (LCP) negotiation. If the PPP parameters do not match the
authenticated user, the link is renegotiated.

Usage Examples
The following example sets the authentication protocol expected for incoming calls to CHAP. The router
will then authenticate the peer using CHAP:
(config)#data-call authentication protocol chap
The following example specifies an MTU of 1200 on the demand routing interface:
(config)#data-call mtu 1200

desktop-auditing dhcp
Use the desktop-auditing dhcp command to enable desktop auditing. Using the no form of this command
disables desktop auditing.
Syntax Description
No subcommands.
Default Values
By default, desktop auditing is disabled.
Command History
Functional Notes
Desktop auditing is an AOS feature that collects network access protection (NAP) information through
NAP messages sent in Dynamic Host Configuration Protocol (DHCP) messages between clients
connected to the network and the network server.
Desktop auditing is configured by enabling the feature (using the desktop-auditing dhcp command) and
by configuring filters to limit the output of the collected NAP information. Information is limited by specifying
local desktop auditing policies. The configuration of these policies is outlined in Desktop Auditing Local
Policy Command Set on page 2446. For more information about desktop auditing, refer to the Configuring
Desktop Auditing in AOS configuration guide available online at http://kb.adtran.com.
Usage Examples
The following example enables the desktop auditing feature:
(config)#desktop-auditing dhcp

desktop-auditing local-policy
Use the desktop-auditing local-policy command to create a local policy for determining when connected
network clients are violators of that policy. This command both creates the policy and enters the local
policy configuration mode. Use the no form of this command to remove the local policy.
Command Syntax
No subcommands.
Default Values
By default, no local policies are configured and all network access protection (NAP) information for all
clients is monitored.
Command History
Functional Notes
Desktop auditing is an AOS feature that collects NAP information through NAP messages sent in Dynamic
Host Configuration Protocol (DHCP) messages between clients connected to the network and the network
server.
Desktop auditing is configured by enabling the feature (using the command desktop-auditing dhcp on page
792) and by configuring filters to limit the output of the collected NAP information. Information is limited by
specifying local desktop auditing policies. The local policy determines when a network access protection
(NAP) client may be a violator by collecting NAP information for the connected clients and comparing them
to the configured policies. You can choose to monitor the client’s firewall state, antivirus state, antispyware
status, auto-update status, and security update status. Selecting these policies filters the collected client
information.
The configuration of these policies is outlined in Desktop Auditing Local Policy Command Set on page
2446. For more information about desktop auditing, refer to the Configuring Desktop Auditing in AOS
Usage Examples
The following example creates a desktop auditing local policy and enters the policy’s configuration mode:
(config)#desktop-auditing local-policy
(desktop-audit-policy)#

desktop-auditing timeout <days>

Use the desktop-auditing timeout command to specify the amount of time that the AOS unit keeps
network access protection (NAP) information collected through desktop auditing. Use the no form of this
command to return to the default timeout period.
Syntax Description
<days> Specifies the amount of time (in days) that desktop auditing stores collected
NAP information. Range is 0 to 49710.
Default Values
By default, desktop auditing is set to timeout in 0 days, meaning the collected NAP information is stored
indefinitely.
Command History
Functional Notes
Desktop auditing is an AOS feature that collects NAP information through NAP messages sent in Dynamic
Host Configuration Protocol (DHCP) messages between clients connected to the network and the network
server.
Desktop auditing is configured by enabling the feature (using the desktop-auditing dhcp command) and
by configuring filters to limit the output of the collected NAP information. Information is limited by specifying
local desktop auditing policies. The configuration of these policies is outlined in Desktop Auditing Local
Policy Command Set on page 2446. For more information about desktop auditing, refer to the Configuring
Desktop Auditing in AOS configuration guide available online at http://kb.adtran.com.
There is a storage limit of 2000 NAP entries on the AOS unit. When this limit is reached, new entries
overwrite the old entries.
Usage Examples
The following example specifies that NAP information collected by desktop auditing will expire in 7 days:
(config)#desktop-auditing timeout 7

dos-protection
Use the dos-protection command to enable and configure the denial of service (DoS) protection feature.
Use the no form of this command to disable the DoS protection feature. Variations of this command
include:
dos-protection all
dos-protection except <id>
dos-protection max-icmpv4-payload <bytes>
dos-protection max-icmpv6-payload <bytes>
dos-protection min-tcp-header <bytes>
Syntax Description
all Enables protection from all DoS attacks available in the feature.
except <ids> Enables protection from all available DoS attacks except those with the
listed threat ids.
max-icmpv4-payload <bytes> Sets the maximum ICMP payload size in bytes for IPv4 packets. Range
is 0 to 16 KB. Default is 512 bytes.
max-icmpv6-payload <bytes> Sets the maximum ICMP payload size in bytes for IPv6 packets. Range
is 0 to 16 KB. Default is 512 bytes.
min-tcp-header <bytes> Sets the minimum TCP header size in bytes. Range is 0 to 255 bytes.
Default is 20 bytes.
Default Values
By default, DoS protection in AOS is disabled.
Command History
Functional Notes
The show dos-id command is used to obtain the DoS threat IDs necessary to create exceptions using the
dos-protection except <id> version of this command.
Usage Examples
The following example configures the DoS protection feature to protect against all available threats except
threat ID 40:
(config)#dos-protection except 40

dot11ap access-point-control
Use the dot11ap access-point-control command to globally enable the access point controller logic on the
platform. Use the no form of this command to disable the access controller (AC) logic on the platform.
Syntax Description
No subcommands.
Default Values
By default, the AC logic is disabled.
Command History
Usage Examples
The following example enables the AC logic:
(config)#dot11ap access-point-control

enable password <password>

Use the enable password command to define a password (with optional encryption) for accessing the
Enable mode. Use the no enable password command to remove a configured password. Variations of this
command include:
enable password md5 <password>

enable password <password>
To prevent unauthorized users from accessing the configuration functions of your device,
immediately define an Enable-level password.
Syntax Description
md5 Optional. Specifies message digest 5 (MD5) as the encryption protocol to
use when displaying the Enable password during show commands. If the
md5 keyword is not used, encryption is not used when displaying the
Enable password during show commands.
<password> Specifies the Enable password using a string (up to 30 characters in
length).
Default Values
By default, there is no password configured for the Enable mode.
Command History
Usage Examples
To provide extra security, AOS can encrypt the Enable password when displaying the current configuration.
For example, the following is a show configuration printout (password portion) with an unencrypted
Enable password (ADTRAN):
!
enable password ADTRAN
!
Alternately, the following is a show configuration printout (password portion) with an Enable password of
ADTRAN using MD5 encryption:
!
enable password md5 encrypted 5aa5fbae7d01a90e79fb57705ce74676
!

ethernet cfm
Use the ethernet cfm command to enable Ethernet operations, administration, and maintenance (OAM)
connectivity fault management (CFM) on the AOS device. Use the no form of this command to disable
Ethernet OAM CFM.
Syntax Description
No subcommands.
Default Values
By default, Ethernet OAM CFM is disabled.
Command History
Functional Notes
For more information regarding specific Ethernet OAM CFM configuration commands, refer to the Ethernet
OAM CFM Command Set on page 2473.
Usage Examples
The following example enables Ethernet OAM CFM on an AOS device:
(config)#ethernet cfm

ethernet cfm domain

Use the ethernet cfm domain command to enable and create an Ethernet operations, administration, and
maintenance (OAM) connectivity fault management (CFM) maintenance domain (MD). Use the no form
of this command to remove the MD. Variations of this command include:
ethernet cfm domain <name> level <level>

ethernet cfm domain none level <level>
Syntax Description
domain <name> Specifies the MD’s name. The name can be up to 42 characters in length.
level <level> Specifies the MD’s maintenance level. Range is 0 to 7.
none Specifies that the MD’s name is not used to create the maintenance
association ID (MAID).
Default Values
By default, no MDs exist.
Command History
Functional Notes
This command not only creates and enables the MD, it also enters the MD Configuration mode. From the
MD Configuration mode, maintenance associations (MAs) and maintenance endpoints (MEPs) can be
configured. For more information on configuring MAs and MEPs, refer to the Ethernet OAM CFM
Command Set on page 2473. When the no form of this command is used, the MD is deleted, as well as
any MAs and MEPs defined with the domain.
The domain name serves two purposes. One is to provide a text label used in the device configuration to
identify a particular domain, the other is to construct an MAID. The MAID is included in CFM continuity
check messages (CCMs), and identifies the MA to which the transmitting MEP belongs. The MAID also
allows MEPs receiving CCMs to detect CFM error conditions.
Because each MEP supported on an AOS device port or interface must be at a different MD level, each
MEP on a particular port or interface will have to be configured on a separate MD.
For more information about Ethernet OAM CFM and its operation on AOS products, refer to the Ethernet
OAM CFM in AOS configuration guide available on the AOS Documentation CD shipped with your product
or online at http://kb.adtran.com (article number 3013).

Usage Examples
The following example creates, enables, and enters the configuration mode of a MD named Domain1,
created on level 6:
(config)#ethernet cfm domain Domain1 level 6


ethernet cfm log-changes

Use the ethernet cfm log-changes command to enable Ethernet operations, administration, and
maintenance (OAM) connectivity fault management (CFM) warning messages on the AOS device.
Warning messages are generated when remote maintenance endpoint (MEP) defects are detected. The no
form of this command causes the warning messages to appear as debug messages.
Syntax Description
No subcommands.
Default Values
By default, warning messages are disabled.
Command History
Functional Notes
Usage Examples
The following example enables Ethernet OAM CFM warning messages:
(config)#ethernet cfm log-changes

event-history on
Use the event-history on command to enable event logging for the AOS system. Event log messages will
not be recorded unless this command has been issued (regardless of the event-history priority
configured). The event log may be displayed using the show event-history command. Use the no form of
this command to disable the event log.
Syntax Description
No subcommands.
Default Values
By default, the AOS event logging capabilities are disabled.
Command History
Functional Notes
event history log.
#show event-history
Using 526 bytes
2002.07.12 15:34:01 T1.t1 1/1 Yellow
2002.07.12 15:34:02 T1.t1 1/1 No Alarms
Usage Examples
The following example enables the AOS event logging feature:
(config)#event-history on

event-history priority
Use the event-history priority command to set the threshold for events stored in the event history. All
events with the specified priority or higher will be kept for viewing in the local event log. The event log
may be displayed using the show event-history command. Use the no form of this command to keep
specified priorities from being logged. Variations of this command include:
event-history priority error

event-history priority fatal
event-history priority info
event-history priority notice
event-history priority warning
Syntax Description
error Logs events with error and fatal priorities.
fatal Logs only events with a fatal priority.
info Logs all events.
notice Logs events with notice, warning, error, and fatal priorities.
warning Logs events with warning, error, and fatal priorities.
Default Values
By default, no event messages are logged to the event history.
Command History
Functional Notes
event history log.
Router#show event-history
Using 526 bytes
2002.07.12 15:34:01 T1.t1 1/1 Yellow
2002.07.12 15:34:02 T1.t1 1/1 No Alarms

Usage Examples
The following example logs all events to the event history:
(config)#event-history priority info

exception memory minimum <value>

Use the exception memory minimum command to initiate a reboot when the specified minimum amount
of memory is no longer available. This ensures that adequate memory is available to store an exception
report. Use the no form of this command to disable rebooting when the minimum memory limitation is
violated.
Executing the exception memory minimum command may cause the unit to reboot.
ADTRAN recommends only using this command if advised by ADTRAN Technical Support.
Syntax Description
<value> Specifies the minimum amount of memory (in bytes) that must be free
before a reboot occurs.
Default Values
By default, exception memory minimum is disabled.
Command History
Usage Examples
The following example sets the exception memory minimum to 3 MB:
(config)#exception memory minimum 30000000

exception report
Use the exception report command to specify the name of the output file for the exception report. Use the
exception report
exception report file-name <filename>
Syntax Description
file-name <filename> Optional. Specifies a file name for the exception report other than the
default file name.
Default Values
By default, the exception report file name is exception report-yyyyMMddHHmmss. (The
yyyyMMddHHmmss will be automatically replaced with the actual year, month, day, hour, minutes, and
seconds.)
Command History
Usage Examples
The following example specifies example as the name of the output file for an exception report:
(config)#exception report file-name example

(config)#exit
Exception report generated.
#show flash
1744 startup-config
45676 example-20050708080537
#config t
(config)#no exception report file-name
(config)#exit
Appropriate commands must be issued to preserve configuration.
Exception report generated.
#show flash
1744 startup-config
45676 example-20050708080537
45900 exception-report-20050708080552

ftp authentication <listname>

Use the ftp authentication command to specify that an authentication, authorization, and accounting
(AAA) authentication method list is used by the AOS device’s internal File Transfer Protocol (FTP) server
for FTP authentication. AAA must be enabled to apply the method list to FTP authentication. Use the no
form of this command to remove the authentication method list from FTP authentication.
Syntax Description
<listname> Specifies the AAA authentication method list to apply to FTP authentication.
Default Values
By default, no AAA authentication method list is applied to FTP. If AAA is enabled (using the command aaa
on on page 751), but no list is assigned to FTP, FTP automatically uses the local user list for
authentication.
Command History
Functional Notes
AAA must be enabled for an authentication list to be applied to FTP authentication. For more information
on enabling AAA, refer to the command aaa on on page 751.
AAA authentication lists for use with FTP can be lists that control user login permissions or lists that control
user Enable mode access permissions. These lists are created using the following commands: aaa
authentication login on page 733 and aaa authentication enable default on page 729.
For more information on AAA configuration, refer to the configuration guide Configuring AAA in AOS
available online at http://kb.adtran.com.
Usage Examples
The following example attaches the authentication method list MyList to the FTP server:
(config)#ftp authentication MyList

garp timer <value>

Use the garp timer command to adjust the timers used in all Generic Attribute Registration Protocol
(GARP) applications (currently only GARP VLAN Registration Protocol (GVRP)) on the switch. Use the
garp timer join <value>

garp timer leave <value>
garp timer leaveall <value>
Syntax Description
join <value> Specifies the timer value (in milliseconds) between GARP application join
messages.
leave <value> Specifies the timer value (in milliseconds) between GARP application leave
messages (must be at least three times longer than the join timer).
leaveall <value> Specifies the timer value (in milliseconds) between GARP application leave
all messages (must be greater than the leave timer).
Default Values
By default, the join timer is 200 milliseconds, the leave timer is 600 milliseconds, and the leaveall timer is
10000 milliseconds.
Command History
Functional Notes
All devices communicating using GARP in the network need to have the same values for these timers.
Changing these values is not recommended.
Usage Examples
The following example specifies the time (in milliseconds) between GARP application leave all messages:
(config)#garp timer leaveall 20000

gvrp
Use the gvrp command to enable GARP VLAN Registration Protocol (GVRP) on the switch globally. Use
the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, GVRP is disabled.
Command History
Functional Notes
Disabling GVRP globally will disable GVRP on all interfaces.
Usage Examples
The following example enables GVRP on the switch globally:
(config)#gvrp

hostname <name>
Use the hostname command to create a name used to identify the unit. This alphanumeric string should be
used as a unique description for the unit. This string will be displayed in all prompts. Use the no form of
this command to remove a host name.
Syntax Description
<name> Identifies the unit using an alphanumeric string up to 32 characters.
Default Values
By default, the host name is router.
Command History
Usage Examples
The following example creates a host name for the AOS device of ATL_RTR to identify the system as the
Atlanta router:
(config)#hostname ATL_RTR

hw-access-map <name>
Use the hw-access-map command to create and name a hardware access map. This command also enters
the map’s configuration mode. Using the no form of this command deletes the hardware access map.
For a complete list of all hardware access map configuration commands, refer to the
Hardware ACL and Access Map Command Set on page 2491.
Syntax Description
<name> Specifies the name of the hardware access map.
Default Values
By default, all AOS security features are disabled, and there are no configured hardware access maps.
Command History
Functional Notes
This command only creates an empty hardware access map, it does not configure it. For additional
hardware access map configuration commands and configuration parameters, refer to the Hardware ACL
and Access Map Command Set on page 2491 or the Hardware ACLs in AOS configuration guide available
online at http://kb.adtran.com (article number 3088).
Usage Examples
The following example creates a hardware access map Map1 and enters the hardware access map
configuration mode:
(config)#hw-access-map Map1
(config-hw-access-map)#
Technology Review
Hardware access maps can only forward traffic. This action can be performed based on the criteria
outlined in a single IP hardware access control list (ACL), a single medium access control (MAC) hardware
ACL, or both. Like the hardware ACLs, the hardware access map will match traffic in top-down order.
If you configure the access map to reference a nonexistent IP or MAC hardware ACL, the ACL will be
created. Note that this newly created ACL will have permit any as the default entry because no other
entries are present.

Hardware access maps are not active until they are applied to a VLAN. For instructions on how to apply an
access map to a VLAN, refer to vlan <vlan id> on page 1127.
Changing hardware ACL or hardware access map configuration or application causes

new information to be reinstalled on the hardware. It is possible to run out of hardware
resources depending on how many resources are needed to apply the desired change. If
there are not enough hardware resources to install the new criteria in the hardware, an
error message is displayed. You can view the amount of hardware resources available
using the command show hw-filter-resource on page 428.

interface range <interface type> <slot/port> - <slot/port>

Use the interface range command to enter configuration mode for a range of interfaces.
Syntax Description
<interface type> Specifies the interface type (e.g., Ethernet, Gigabit Ethernet, etc.). Type
interface range ? for a complete list of valid interfaces.
<slot/port> Specifies the slot/port number of the first interface in the desired range of
interfaces to be configured, followed by a hyphen (-) or a comma (,).
<slot/port> Specifies the slot/port number of the last interface in the desired range of
interfaces to be configured.
Default Values
Command History
Release 11.1 Command was expanded to include the foreign exchange office (FXO)
range.
Release 14.1 Command was expanded to include the Gigabit Ethernet interfaces.
Functional Notes
All configuration changes made in this mode will apply to all interfaces in the range specified.
Usage Examples
The following example selects seven consecutive Ethernet ports for configuration:
(config)#interface range eth 0/3-0/12

(config-eth 0/3-12)#
The following example selects nonconsecutive Ethernet ports for configuration:
(config)#interface range eth 0/14, 0/16, 0/18

(config-eth 0/14, 0/16, 0/18)#

ip
Use the ip command to specify alternate Transmission Control Protocol (TCP) ports for secure shell (SSH)
and Telnet servers. Use the no form of this command to return to the default setting. Variations of this
command include:
ip ssh-server <port>
ip telnet-server <port>
Syntax Description
ssh-server <port> Configures the SSH server to listen on an alternate TCP port.
telnet-server <port> Configures the Telnet server to listen on an alternate TCP port.
Default Values
By default, the SSH server listens on TCP port 22 and Telnet listens on TCP port 23.
Command History
Functional Notes
SSH is a newer version of Telnet that allows you to run command line and graphical applications (as well
as, transfer files) over an encrypted connection.
Usage Examples
The following example configures the Telnet server to listen on TCP port 2323, instead of the default port
23:
(config)#ip telnet-server 2323
The following example configures the SSH server to listen on TCP port 2200, instead of the default port 22:
(config)#ip ssh-server 2200
To return to the default setting, use the no form of the command. For example:
(config)#no ip ssh-server 2200

ip access-list extended <name>

Use the ip access-list extended command to create an empty access control list (ACL) and enter the
Extended ACL Configuration mode. Use the no form of this command to delete an extended ACL and all
the entries contained in it.
For a complete list of all extended ACL configuration commands, refer to the Access
Control List Command Set on page 2411.
Syntax Description
<name> Specifies the name of the ACL.
Default Values
By default, all AOS security features are disabled, and there are no configured ACLs.
Command History
Functional Notes
This command only creates an empty extended ACL, it does not configure it. For additional extended ACL
configuration commands and configuration parameters, refer to the Access Control List Command Set on
page 2411.
Usage Examples
The following example creates an extended ACL AllowIKE and enters the Extended ACL Configuration
mode:
(config)#ip access-list extended AllowIKE

(config-ext-nacl)#
Technology Review
Access control lists (ACLs) are used as packet selectors by different AOS features (firewall, virtual private
network (VPN), quality of service (QoS)); by themselves they do nothing. ACLs are composed of an
ordered list of entries with an implicit deny all at the end of each list. An ACL entry contains two parts: an
action (permit or deny) and a packet pattern. A permit ACL is used to match packets (meeting the
specified pattern) to enter the router system. A deny ACL advances AOS to the next access policy entry.
AOS provides two types of ACLs: standard and extended. Standard ACLs match based on the source of
the packet. Extended ACLs match based on the source and destination of the packet.
ACLs are performed in order from the top of the list down. Generally, the most specific entries should be at
the top and the more general at the bottom.

VPN routing and forwarding (VRF) on AOS products allows a single physical router to be partitioned into
More information on ACL, ACP, and AOS firewall configuration is available in the IP Firewall configuration
guide, located online at http://kb.adtran.com (article number 1543).

ip access-list standard <name>

Use the ip access-list standard command to create an empty access control list (ACL) and enter the
Standard ACL Configuration mode. Use the no form of this command to delete an extended ACL and all
the entries contained in it.
For a complete list of all standard ACL configuration commands, refer to the Access
Syntax Description
<name> Specifies the name of the ACL.
Default Values
Command History
Functional Notes
This command only creates an empty standard ACL, it does not configure it. For additional standard ACL
configuration commands and configuration parameters, refer to the Access Control List Command Set on
page 2411.
Usage Examples
The following example creates a standard ACL AllowIKE and enters the Standard ACL Configuration
mode:
(config)#ip access-list standard AllowIKE

(config-std-nacl)#
Technology Review

VPN routing and forwarding (VRF) on AOS products allows a single physical router to be partitioned into
More information on ACL, ACP, and AOS firewall configuration is available in the IP Firewall configuration
guide, located online at http://kb.adtran.com (article number 1543).

ip as-path-list <name>
Use the ip as-path-list command to create IP autonomous system (AS) path lists for route map use. Use
the no form of this command to delete the AS path list.
Syntax Description
<name> Specifies the name of the AS path list. Refer to AS Path List Command Set
on page 2281 for more information on the available options.
Default Values
By default, no AS path lists are defined.
Command History
Functional Notes
AS path lists are a type of route filter that permits or denies Border Gateway Protocol (BGP) routes based
on the AS_PATH attribute. AS path lists define a list of AS specifications that, once created, may then be
referenced in a route map. Refer to the Usage Examples section below.
Usage Examples
The following example creates the AS path list list5 and enters the IP as-path-list command mode:
(config)#ip as-path-list list5


ip classless
Use the ip classless command to forward classless packets to the best supernet route available. A classless
packet is a packet addressed for delivery to a subnet of a network with no default network route.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
AOS products only function in classless mode. You cannot disable this feature.
Usage Examples
The following example enables the system to forward classless packets:
(config)#ip classless

ip community-list <name>
Use the ip community-list command to create a community list for Border Gateway Protocol (BGP) route
map use. Use the no form of this command to delete a community list.
Syntax Description
<name> Specifies the name of the community to use in the community list attribute
for BGP routes. Refer to Community List Command Set on page 2316 for
more information on the available options.
Default Values
By default, this command is disabled.
Command History
Usage Examples
The following example creates a community list MyList and enters the Community List Configuration
mode:
(config)#ip community-list MyList

ip crypto
Use the ip crypto command to enable AOS virtual private network (VPN) functionality and allow crypto
maps to be added to the interfaces. Use the no form of this command to disable the VPN functionality.
ip crypto
ip crypto fast-failover
Disabling the AOS security features (using the no ip crypto command) does not affect VPN
configuration settings (with the exception of the removal of all crypto maps from the
interfaces). All other configuration parameters will remain intact, and VPN functionality
will be disabled.
For VPN configuration example scripts, refer to the VPN configuration guide located on the
AOS Documentation CD provided with your unit.
Syntax Description
fast-failover Optional. This setting is used when the same crypto map is applied to two
different egress interfaces. It allows the quick deletion of Internet key
exchange (IKE) and IPSec SAs when the default route policy class
changes.
Default Values
By default, all AOS VPN functionality is disabled.
Command History
Release 11.2 Command was expanded to include the fast-failover feature.
Functional Notes
VPN-related settings will not go into effect until you enable VPN functionality using the ip crypto
command. AOS allows you to perform all VPN-related configuration prior to enabling ip crypto, with the
exception of assigning a crypto map to an interface. The no ip crypto command removes all crypto maps
from the interfaces. Enabling ip crypto enables the IKE server on User Datagram Protocol (UDP) Port
500. The no form of this command disables the IKE server on UDP Port 500.
Usage Examples
The following example enables VPN functionality:
(config)#ip crypto

ip crypto ffe
Use the ip crypto ffe command to enable the RapidRoute Engine for IP Security Protocol (IPSec) security
associations (SAs). Use the no form of this command to disable the RapidRoute functionality for IPSec
SAs. Variations of this command include:
ip crypto ffe
ip crypto ffe max-entries <entries>
Syntax Description
max-entries <entries> Optional. Specifies the maximum number of entries per inbound
(decrypting) IPSec SA. Valid range is from 1 to 8192.
Default Values
By default, RapidRoute is not enabled for IPSec SAs. The default number of max-entries is 4096.
Command History
Release 17.6 Command was introduced
Functional Notes
The RapidRoute Engine can be used to help reduce routing overhead, and thus reduce overall routing
times. Routing times are reduced by the creation of a flow table on the ingress interface. The maximum
number of entries that can be stored in the flow table at any one time can be specified by using the
max-entries parameter.
Usage Examples
The following example enables RapidRoute for IPSec SAs and sets the maximum number of entries in the
flow table to 50:
(config)#ip crypto ffe max entries 50

ip default-gateway <ip address>

Use the ip default-gateway command to specify a default gateway on a switch or on a router if (and only
if) IP routing is NOT enabled on the router. Use the ip route command to add a default route to the route
table when using IP routing functionality. Refer to ip route on page 912 for more information. Use the no
Syntax Description
<ip address> Specifies the default gateway IP address. IP addresses should be
Default Values
By default, there is no configured default gateway.
Command History
Usage Examples
The following example disables IP routing on a router and configures a default gateway for 10.10.10.1:
(config)#no ip routing
(config)#ip default-gateway 10.10.10.1
The following example specifies a default gateway for the management interface on a switch:
(config)#ip default-gateway 10.10.10.1

ip dhcp-server database local

Use the ip dhcp-server database local command to configure a Dynamic Host Configuration Protocol
(DHCP) database agent with local bindings. Use the no form of this command to disable this option.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the DHCP database agent with local bindings:
(config)#ip dhcp-server database local

ip dhcp-server excluded-address
Use the ip dhcp-server excluded-address command to specify IP addresses that cannot be assigned to
Dynamic Host Configuration Protocol (DHCP) clients. Use the no form of this command to remove a
configured IP address restriction. Variations of this command include:
ip dhcp-server excluded-address <start ip address>

ip dhcp-server excluded-address <start ip address> <end ip address>
ip dhcp-server excluded-address vrf <name> <start ip address>
ip dhcp-server excluded-address vrf <name> <start ip address> <end ip address>
Syntax Description
<start ip address> Specifies the lowest IP address in the range OR a single IP address to be
excluded.
<end ip address> Optional. Specifies the highest IP address in the range. This field is not
required when specifying a single IP address.
10.10.10.1).
vrf <name> Optional. Specifies the nondefault VPN routing and forwarding (VRF) to
which the IP addresses are associated. If a VRF is not specified, the default
VRF is assumed.
Default Values
By default, there are no excluded IP addresses.
Command History
Functional Notes
The AOS DHCP server (by default) allows all IP addresses for the DHCP pool to be assigned to requesting
clients. This command is used to ensure that the specified address or addresses are never assigned by
the DHCP server. When static-addressed hosts are present in the network, it is helpful to exclude the IP
addresses of the host from the DHCP server IP address pool. This will avoid IP address conflict.

Usage Examples
The following example excludes an IP address of 172.22.5.100 and the range of IP addresses
172.22.5.200 through 172.22.5.250:
(config)#ip dhcp-server excluded-address 172.22.5.100

(config)#ip dhcp-server excluded-address 172.22.5.200 172.22.5.250
The following example excludes an IP address of 172.22.5.100 and the range of IP addresses
172.22.5.200 through 172.22.5.250 for the vrf instance named RED:
(config)#ip dhcp-server excluded-address vrf RED 172.22.5.100

(config)#ip dhcp-server excluded-address vrf RED 172.22.5.200 172.22.5.250

ip dhcp-server ping packets <number>

Use the ip dhcp-server ping packets command to specify the number of ping packets the Dynamic Host
Configuration Protocol (DHCP) server will transmit before assigning an IP address to a requesting DHCP
client. Transmitting ping packets verifies that no other hosts on the network are currently configured with
the specified IP address. Use the no form of this command to prevent the DHCP server from using ping
packets as part of the IP address assignment process.
Syntax Description
<number> Specifies the number of DHCP ping packets sent on the network before
assigning the IP address to a requesting DHCP client.
Default Values
By default, the number of DHCP server ping packets is set at 2 packets.
Command History
Functional Notes
Before assigning an IP address to a requesting client, the AOS DHCP server transmits a ping packet on
the network to verify there are no other network hosts already configured with the specified address. If the
DHCP server receives no reply, the IP address is assigned to the requesting client and added to the DHCP
database as an assigned address. Configuring the ip dhcp-server ping packets command with a value of
0 prevents the DHCP server from using ping packets as part of the IP address assignment process.
Usage Examples
The following example configures the DHCP server to transmit 4 ping packets before assigning an
address:
(config)#ip dhcp-server ping packets 4

ip dhcp-server ping timeout <value>

Use the ip dhcp-server ping timeout command to specify the interval (in milliseconds) the Dynamic Host
Configuration Protocol (DHCP) server will wait for a response to a transmitted DHCP ping packet. The
DHCP server transmits ping packets before assigning an IP address to a requesting DHCP client.
Transmitting ping packets verifies that no other hosts on the network are currently configured with the
specified IP address. Use the no form of this command to return to the default timeout interval.
Syntax Description
<value> Specifies the number of milliseconds the DHCP server will wait for a
response to a transmitted DHCP ping packet. Valid range is 1 to
1000 milliseconds.
Default Values
By default, the ip dhcp-server ping timeout is set to 500 milliseconds.
Command History
Functional Notes
Before assigning an IP address to a requesting client, the AOS DHCP server transmits a ping packet on
the network to verify there are no other network hosts already configured with the specified address. If the
DHCP server receives no reply, the IP address is assigned to the requesting client and added to the DHCP
database as an assigned address.
Usage Examples
The following example configures the DHCP server to wait 900 milliseconds for a response to a
transmitted DHCP ping packet before considering the ping a failure:
(config)#ip dhcp-server ping timeout 900

ip dhcp-server pool <name>

Use the ip dhcp-server pool command to create a Dynamic Host Configuration Protocol (DHCP) address
pool and enter the DHCP pool. Use the no form of this command to remove a configured DHCP address
pool. Refer to the DHCP Pool Command Set on page 2453 for more information.
Syntax Description
<name> Identifies the configured DHCP server address pool using an alphanumeric
string (up to 32 characters in length).
Default Values
By default, there are no configured DHCP address pools.
Command History
Functional Notes
Use the ip dhcp-server pool to create multiple DHCP server address pools for various segments of the
network. Multiple address pools can be created to service different segments of the network with tailored
configurations.
Usage Examples
The following example creates a DHCP server address pool (labeled SALES) and enters the DHCP server
pool mode:
(config)#ip dhcp-server pool SALES

(config-dhcp)#

ip domain-lookup
Use the ip domain-lookup command to enable the IP domain naming system (DNS), allowing DNS-based
host translation (name-to-address). Use the no form of this command to disable DNS.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Use the ip domain-lookup command to enable the DNS client in the router. This will allow the user to
input Web addresses instead of IP addresses for applications such as ping, Telnet, and traceroute.
Usage Examples
The following example enables DNS:
(config)#ip domain-lookup

ip domain-name <domain name>

Use the ip domain-name command to define a default IP domain name to be used by AOS to resolve host
names. Use the no form of this command to disable this function. Variations of this command include:
ip domain-name <domain name>

ip domain-name vrf <name> <domain name>
Syntax Description
<domain name> Specifies the default IP domain name used to resolve unqualified host
names. Do not include the initial period that separates the unresolved name
from the default domain name.
vrf <name> Optional. Specifies a nondefault VPN routing and forwarding (VRF) for the
domain name.
Default Values
Command History
Functional Notes
Use the ip domain-name command to set a default name that will be used to complete any IP host name
that is invalid (i.e., any name that is not recognized by the name server). When this command is enabled,
any IP host name that is not initially recognized will have the ip domain-name appended to it and the
request will be re-sent.
Each VRF instance has its own domain name. Specifying a VRF name in the command applies the domain
name to the named VRF. Issuing the command without specifying a VRF applies the command to the
default unnamed VRF.
Usage Examples
The following example defines adtran as the default domain name:
(config)#ip domain-name adtran
The following example defines adtran as the default domain name for the VRF RED:
(config)#ip domain-name adtran vrf RED adtran

ip domain-proxy
Use the ip domain-proxy command to enable domain naming system (DNS) proxy for the default VPN
routing and forwarding (VRF) or for a specified VRF instance. This enables the router to act as a proxy for
other units on the network. Use the no form of this command to disable this feature. Variations of this
command include:
ip domain-proxy
ip domain-proxy vrf <name>
Syntax Description
vrf <name> Optional. Specifies a nondefault VRF on which to enable DNS proxy.
Default Values
Command History
Functional Notes
When this command is enabled, incoming DNS requests will be handled by the router. It will first search its
host table for the query, and if it is not found there, the request will be forwarded to the servers configured
with the ip name-server command.
Usage Examples
The following example enables DNS proxy on the default VRF (router):
(config)#ip domain-proxy

ip ffe max-entries <value>

Use the ip ffe max-entries command to set the global maximum number of RapidRoute Engine entries
allowed. Use the no form of this command to return to the default value.
Issuing this command will cause all RapidRoute entries in the unit to be cleared.
Syntax Description
<value> Specifies the total number of RapidRoute entries for all interfaces. Valid
Default Values
By default, the ip ffe max-entries is set to 16384.
Command History
Usage Examples
The following example sets the total maximum number of RapidRoute entries to 500:
(config)#ip ffe max-entries 500

ip ffe timeout
Use the ip ffe timeout command to set the time to live (TTL) for RapidRoute Engine entries based on their
IP protocol. Use the no form of this command to return to the default value. Variations of this command
include:
ip ffe timeout ah <max timeout>

ip ffe timeout ah <max timeout> <inactive timeout>
ip ffe timeout esp <max timeout>
ip ffe timeout esp <max timeout> <inactive timeout>
ip ffe timeout gre <max timeout>
ip ffe timeout gre <max timeout> <inactive timeout>
ip ffe timeout icmp <max timeout>
ip ffe timeout icmp <max timeout> <inactive timeout>
ip ffe timeout other <max timeout>
ip ffe timeout other <max timeout> <inactive timeout>
ip ffe timeout tcp <max timeout>
ip ffe timeout tcp <max timeout> <inactive timeout>
ip ffe timeout udp <max timeout>
ip ffe timeout udp <max timeout> <inactive timeout>
Syntax Description
ah Specifies timeout values in seconds for Authentication Header (AH)
Protocol.
esp Specifies timeout values in seconds for Encapsulating Security Payload
(ESP) Protocol.
gre Specified timeout values in seconds for Generic Route Encapsulation
(GRE) Protocol.
icmp Specifies timeout values in seconds for Internet Control Message Protocol
(ICMP).
other Specifies timeout values in seconds for all protocols not listed.
tcp Specifies timeout values in seconds for Transmission Control Protocol
(TCP).
udp Specifies timeout values in seconds for User Datagram Protocol (UDP).
<max timeout> Specifies maximum age timeout in seconds. This is the maximum amount
of time an entry will be kept in the RapidRoute table regardless of activity.
Valid range is 60 to 86400 seconds.
<inactive timeout> Optional. Specifies idle timeout in seconds. This is the amount of time an
entry will remain in the RapidRoute table with no additional activity. Valid
range is 10 to 86400 seconds.
Default Values
By default, the maximum age timeouts are set to 1800 seconds and the inactive timeouts are set to
15 seconds.

Command History
Release 17.6 Command was expanded to include the gre parameter.
Usage Examples
The following example sets the time to live for RapidRoute entries of TCP packets to 1000 seconds.
(config)#ip ffe timeout tcp 1000

ip firewall
Use the ip firewall command to enable AOS security features, including access control policies and lists,
network address translation (NAT), and the stateful inspection firewall. Use the no form of this command
to disable the security functionality.
Disabling the AOS security features (using the no ip firewall command) does not affect
security configuration. All configuration parameters will remain intact, but no security
data processing will be attempted.
For information regarding the use of open shortest path first (OSPF) with ip firewall
enabled, refer to the Functional Notes for router ospf on page 1072.
Regarding the use of Internet key exchange (IKE) negotiation for virtual private network
(VPN) with ip firewall enabled, there can be up to six channel groups with 2 to 8 interfaces
per group. Dynamic protocols are not yet supported (only static). A physical interface can
be a member of only one channel group.
Syntax Description
No subcommands.
Default Values
By default, all AOS security features are disabled.
Command History
Functional Notes
This command enables firewall processing for all interfaces with a configured policy class. Firewall
processing consists of the following functions:
Attack Protection: Detects and discards traffic that matches profiles of known networking exploits or
attacks.
Session Initiation Control: Allows only sessions that match traffic patterns permitted by access-control
policies to be initiated through the router.
Ongoing Session Monitoring and Processing: Each session that has been allowed through the router is
monitored for any irregularities that match patterns of known attacks or exploits. This traffic will be
dropped. Also, if NAT is configured, the firewall modifies all traffic associated with the session according to
the translation rules defined in NAT access policies. Finally, if sessions are inactive for a user-specified
amount of time, the session will be closed by the firewall.
Application-Specific Processing: Certain applications need special handling to work correctly in the
presence of a firewall. AOS uses application-level gateways (ALGs) for these applications.

AOS includes several security features to provide controlled access to your network. The following
features are available when security is enabled (using the ip firewall command):
1. Stateful Inspection Firewall
AOS (and your unit) act as an application-level gateway (ALG) and employ a stateful inspection firewall
that protects an organization's network from common cyber attacks, including Transmission Control
Protocol (TCP) syn-flooding, IP spoofing, Internet Control Message Protocol (ICMP) redirect, land attacks,
ping-of-death, and IP reassembly problems. In addition, further security is added with use of NAT and port
address translation (PAT) capability.
2. Access Policies
AOS access control policies (ACPs) are used to allow, discard, or manipulate (using NAT) data for each
physical interface. Each ACP consists of an action (allow, discard, nat) and a selector (access control list
(ACL)). In a sense, the ACPs answer the question, “What should I do?” while the ACLs answer the
question, “On which packets?”
When packets are received on an interface with an ACP applied, the ACP is used to determine whether
the data is processed or discarded. Both ACLs and ACPs are order dependent. When a packet is
evaluated, the matching engine begins with the first entry in the list and progresses through the entries
until it finds a match. The first entry that matches is executed. The ACP has an implicit discard at the end
of the list. Typically, the most specific entries should be at the top and the most general at the bottom.
3. Access Lists
Access control lists (ACLs) are used as packet selectors by ACPs. They must be assigned to an ACP in
order to be active. ACLs are composed of an ordered list of entries. Each entry contains two parts: an
action (permit or deny) and a packet pattern. A permit action is used to allow packets (meeting the
specified pattern) to enter the router system. A deny action is used to disregard packets (that do not match
the pattern) and proceed to the next entry on the ACP. The ACL has an implicit deny at the end of the list.
The AOS provides two types of ACLs: standard and extended. A standard ACL allows source IP address
packet patterns only. An extended ACL may specify patterns using most fields in the IP header and the
TCP or User Datagram Protocol (UDP) header.
Usage Examples
The following example enables the AOS security features:
(config)#ip firewall
Technology Review
Concepts: Access control using the AOS firewall has two fundamental parts: ACLs and ACPs. ACLs are
used as packet selectors by other AOS systems; by themselves they do nothing. ACPs consist of a
selector (ACL) and an action (allow, discard, nat). ACPs integrate both allow and discard policies with
NAT. ACPs have no effect until they are assigned to a network interface.
Both ACLs and ACPs are order dependent. When a packet is evaluated, the matching engine begins with
the first entry in the list and progresses through the entries until it finds a match. The first entry that
matches is executed.

Packet Flow:
Access Control Policies

Packet In Interface Association List Route Lookup Packet Out
(permit, deny, NAT)
If session hit,
or no ACP configured
Case 1: Packets from interfaces with a configured policy class to any other interface
ACPs are applied when packets are received on an interface. If an interface has not been assigned a
policy class, by default it will allow all received traffic to pass through. If an interface has been assigned a
policy class, but the firewall has not been enabled with the ip firewall command, traffic will flow normally
from this interface with no firewall processing.
Case 2: Packets that travel in and out a single interface with a configured policy class
These packets are processed through the ACPs as if they are destined for another interface (identical to
Case 1).
Case 3: Packets from interfaces without a configured policy class to interfaces with one policy
class
These packets are routed normally and are not processed by the firewall. The ip firewall command has no
effect on this traffic.
Case 4: Packets from interfaces without a configured policy class to other interfaces without a
configured policy class
This traffic is routed normally. The ip firewall command has no effect on this traffic.
Attack Protection:
When the ip firewall command is enabled, firewall attack protection is enabled. AOS blocks traffic
(matching patterns of known networking exploits) from traveling through the device. For some of these
attacks, the user may manually disable checking/blocking while other attack checks are always on anytime
the firewall is enabled.

The table (on the following pages) outlines the types of traffic discarded by the firewall attack protection
engine. Many attacks use similar invalid traffic patterns; therefore, attacks other than the examples listed
below may also be blocked by the firewall. To determine if a specific attack is blocked by the AOS firewall,
please contact ADTRAN technical support.
Invalid Traffic Pattern Manually AOS Firewall Response Common

Enabled? Attacks
Larger than allowed packets No Any packets that are longer than those Ping of Death
defined by standards will be dropped.
Fragmented IP packets that No The firewall intercepts all fragments for an SynDrop,
produce errors when IP packet and attempts to reassemble TearDrop,
attempting to reassemble them before forwarding to destination. If OpenTear,
any problems or errors are found during Nestea, Targa,
reassembly, the fragments are dropped. Newtear,
Bonk, Boink
Smurf Attack No The firewall will drop any ping responses Smurf Attack
that are not part of an active session.
IP Spoofing No The firewall will drop any packets with a IP Spoofing

source IP address that appears to be
spoofed. The IP route table is used to
determine if a path to the source address
is known (out of the interface from which
the packet was received). For example, if
a packet with a source IP address of
10.10.10.1 is received on interface fr 1.16
and no route to 10.10.10.1 (through
interface fr 1.16) exists in the route table,
the packet is dropped.
ICMP Control Message No The following types of ICMP packets are Twinge
Floods and Attacks allowed through the firewall: echo,
echo-reply, TTL expired, dest.
Unreachable, and quench. These ICMP
messages are only allowed if they appear
to be in response to a valid session. All
others are discarded.
Attacks that send TCP URG Yes Any TCP packets that have the URG flag Winnuke, TCP
packets set are discarded by the firewall. XMAS Scan
Falsified IP Header Attacks No The firewall verifies that the packet’s Jolt/Jolt2
actual length matches the length indicated
in the IP header. If it does not, the packet
is dropped.
Echo No All UDP echo packets are discarded by the Char Gen
firewall.

Invalid Traffic Pattern Manually AOS Firewall Response Common

Enabled? Attacks
Land Attack No Any packets with the same source and Land Attack
destination IP addresses are discarded.
Broadcast Source IP No Packets with a broadcast source IP

address are discarded.
Invalid TCP Initiation No TCP SYN packets that have ack, urg rst,
Requests or fin flags set are discarded.
Invalid TCP Segment Number No The sequence numbers for every active
TCP session are maintained in the firewall
session database. If the firewall received a
segment with an unexpected (or invalid)
sequence number, the packet is dropped.
IP Source Route Option No All IP packets containing the IP source

route option are dropped.
Application-Specific Processing
The following applications and protocols require special processing to operate concurrently with
NAT/firewall functionality. The AOS firewall includes ALGs for handling these applications and protocols:
AOL Instant Messenger (AIM®)

VPN ALGS: ESP and IKE
FTP
H.323: H.245 Q.931 ASN1 PER decoding and Encoding
ICQ®
IRC
Microsoft® Games
Net2Phone
PPTP
Quake®
Real-Time Streaming Protocol
SMTP
HTTP
CUseeme
SIP
L2TP
PcAnywhere™
SQL
Microsoft Gaming Zone
To determine if a specific application requires special processing, contact ADTRAN technical support at
www.adtran.com.

ip firewall alg
Use the ip firewall alg command to enable the application-level gateway (ALG) for a particular
application. Use the no form of this command to disable ALG for the application.
Variations of this command applicable for nonvoice capable ADTRAN products include the following:
ip firewall alg ftp

ip firewall alg h323
ip firewall alg h323 timeout <number>
ip firewall alg msn
ip firewall alg mszone
ip firewall alg pptp
ip firewall alg sip
Variations of this command applicable for voice capable ADTRAN products include the following:
ip firewall alg ftp

ip firewall alg h323
ip firewall alg h323 timeout <number>
ip firewall alg msn
ip firewall alg mszone
ip firewall alg pptp
The AOS firewall must be enabled (using the command ip firewall on page 837) for the
stateful inspection firewall to be activated.
Syntax Description
ftp Enables the File Transfer Protocol (FTP) ALG.
h323 Enables the H.323 ALG. H.323 is a protocol that sets standards for
multimedia communications over packet-switched networks, allowing
dissimilar communication devices to communicate with each other via a
standard communication protocol.
h323 timeout <number> Optional. Allows the configuration of the timeout for the policy-session that
controls the H.323 call, and specifies the length of time before the H.323
call is terminated after a timeout. Range is 1 to 4294967295 seconds.
msn Enables the Microsoft Service Network (MSN) ALG.
mszone Enables the MSZONE ALG.
pptp Enables the PPTP ALG.
sip Enables the Session Initiation Protocol (SIP) ALG. This ALG is only used in
ADTRAN router and switch products, not voice products.

Default Values
All AOS security features are disabled by default until the ip firewall command is issued at the Global
Configuration mode prompt. By default, the ALG for FTP, PPTP, and SIP are enabled. Conversely, the ALG
for MSN, MSZONE, and H.323 are disabled by default. There are no SIP ALGs present on voice capable
ADTRAN products. By default, the timeout value for H.323 is set for 8 hours.
Command History
Release 10.1 Command was expanded to include H.323.
Release 14.1 Command was expanded to include MSN.
Release 15.1 Command was expanded to include H.323 timeout feature.
Release 17.4 Command was expanded to include MSZONE.
Functional Notes
Enabling the ALG for a specific protocol gives the firewall additional information about that complex
protocol and causes the firewall to perform additional processing for packets of that protocol. When the
ALG is disabled, the firewall treats the complex protocol as any other simple protocol. The firewall needs
no special knowledge to work well with simple protocols.
Disabling the IP firewall ALG may cause the firewall to block some of the traffic for the
specified protocol.
Microsoft Service Network (MSN) ALG Information
In some instances where the firewall is enabled and traffic is source NATed through the unit, some features
of MSN's instant messenger program will not work (i.e., file sharing, direct connection, etc.). Enabling the
MSN ALG allows the firewall to inspect the MSN messaging protocol to allow some of these features to
work through network address translation (NAT). If the traffic is not NATed, then this ALG is not required
and should be disabled.
Session Initiation Protocol (SIP) ALG Information
By default, the AOS SIP ALG is enabled. This ALG allows the firewall to examine the ALL SIP packets it
identifies and maintain knowledge of SIP transmissions on the network based on the SIP header.
Usage Examples
The following example disables ALG for FTP:
(config)#no ip firewall alg ftp
The following example enables ALG for MSN:
(config)#ip firewall alg msn

Technology Review
SIP is one protocol in a suite of protocols that was designed to replace H.323 for IP telephony. SIP
operates in Layer 7 of the OSI model (application level) to create, modify, and terminate sessions between
nodes. SIP not only provides recommendations for IP telephony, but multimedia distribution and
conferences as well. SIP version 1.0 was defined in RFC 2453, and was refined to SIP version 2.0 in
RFC 3261.
SIP operations occur between SIP UAs and SIP servers. Types of SIP servers include proxy, redirect,
registrar, and presence. The part of a SIP UA that sends messages is known as the user agent client
(UAC). The part of a SIP UA that receives messages is known as a user agent server (UAS).
SIP was originally designed for use over User Datagram Protocol (UDP). SIP servers, by default, listen on
port 5060. Due to security concerns, SIP is now transitioning to Transmission Control Protocol (TCP) and
transport layer security (TLS). SIP servers using TLS-over-TCP listen on port 5061. SIP UAs listen on a
range of ports.
SIP uses the Session Description Protocol (SDP) to format the SIP message body in order to negotiate a
Realtime Transport Protocol (RTP)/Realtime Transport Control Protocol (RTCP) connection between two
or more UAs. The ports used for this will always be selected in a pair, with the even port used for RTP and
the odd port for RTCP. SIP, because it uses SDP and RTP, causes many problems for standard firewalls.
Neither SIP nor RTP are guaranteed to be symmetric, thus causing problems for stateful inspection
firewalls that rely on symmetric flows. SIP and SDP carry IP addresses and ports embedded in the packet,
and standard NAT implementations only modify the IP and TCP/UDP headers. A true SIP ALG is required
to modify the packets as needed for NAT, but also to open holes in the firewall as needed for traffic flow
based on the information carried in the SIP header.
Enabling the AOS SIP ALG (using the ip firewall alg sip command) configures the firewall to examine the
ALL SIP packets it identifies and maintain knowledge of SIP transmissions on the network. Since SIP
packet headers include port information for the call setup, the ALG must intelligently read the packets and
remember the information.

ip firewall attack-log threshold <value>

Use the ip firewall attack-log threshold command to specify the number of attack mounting attempts
AOS will identify before generating a log message. Use the no form of this command to return to the
default threshold.
Syntax Description
<value> Specifies the number of attack mounting attempts AOS will identify before
generating a log message. Valid range: 0 to 4294967295.
Default Values
By default, the ip firewall attack-log threshold is set at 100.
Command History
Usage Examples
The following example specifies a threshold of 25 attacks before generating a log message:
(config)#ip firewall attack-log threshold 25

ip firewall check reflexive-traffic

Use the ip firewall check reflexive-traffic command to enable the AOS stateful inspection firewall to
process traffic from a primary subnet to a secondary subnet on the same interface through the firewall. Use
Syntax Description
No subcommands.
Default Values
Configuration mode prompt. In addition, the reflexive traffic check is disabled until the ip firewall check
reflexive-traffic command is issued.
Command History
Functional Notes
This command allows the firewall to process traffic from a primary subnet to a secondary subnet on the
same interface through the firewall. If enabled, this traffic will be processed through the access policy on
that interface and any actions specified will be executed on the traffic.
Usage Examples
The following example enables the AOS reflexive traffic check:
(config)#ip firewall check reflexive-traffic

ip firewall check rst-seq

Use the ip firewall check rst-seq command to enable Transmission Control Protocol (TCP) reset sequence
number checking. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Configuration mode prompt. In addition, TCP reset sequence number checking is disabled until the ip
firewall check rst-seq command is issued.
Command History
Usage Examples
The following example enables TCP reset sequence number checking:
(config)#ip firewall check rst-seq

ip firewall check syn-flood

Use the ip firewall check syn-flood command to enable the AOS stateful inspection firewall to filter out
phony Transmission Control Protocol (TCP) service requests and allow only legitimate requests to pass
through. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
All AOS security features are inactive until the ip firewall command is issued at the Global Configuration
mode prompt. In addition, the SYN-flood check is enabled by default but remains inactive until the ip
firewall command is issued.
Command History
Functional Notes
SYN flooding is a well-known denial-of-service attack on TCP-based services. TCP requires a three-way
handshake before actual communications begin between two hosts. A server must allocate resources to
process new connection requests that are received. A potential intruder is capable of transmitting large
amounts of service requests (in a very short period of time), causing servers to allocate all resources to
process the phony incoming requests. Using the ip firewall check syn-flood command configures the
AOS stateful inspection firewall to filter out phony service requests and allow only legitimate requests to
pass through.
Usage Examples
The following example disables the AOS SYN-flood check:
(config)#no ip firewall check syn-flood

ip firewall check winnuke

Use the ip firewall check winnuke command to enable the AOS stateful inspection firewall to discard all
out-of-band (OOB) data (to protect against WinNuke attacks). Use the no form of this command to disable
this feature.
Syntax Description
No subcommands.
Default Values
All AOS security features are inactive until the ip firewall command is issued at the Global Configuration
mode prompt. In addition, WinNuke attack checking is disabled until the ip firewall check winnuke
command is issued.
Command History
Functional Notes
WinNuke attack is a well-known denial-of-service attack on hosts running Microsoft Windows® operating
systems. An intruder sends OOB data over an established connection to a Windows user. Windows cannot
properly handle the OOB data, and the host reacts unpredictably. Normal shut-down of the hosts will
generally return all functionality. Using the ip firewall check winnuke command configures the AOS
stateful inspection firewall to filter all OOB data to prevent network problems.
Usage Examples
The following example enables the firewall to filter all OOB data:
(config)#ip firewall check winnuke

ip firewall fast-nat-failover
Use the ip firewall fast-nat-failover command when destination-specific rules are configured.
Destination-specific rules are most often used in failover and IP load sharing configurations. Refer to the
command ip policy-class <name> on page 900 for more information. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
Configuration mode prompt. In addition, the fast network address translation (NAT) failover is disabled until
the ip firewall fast-nat-failover command is issued.
Command History
Usage Examples
The following example enables fast-nat-failover:
(config)#ip firewall fast-nat-failover

ip firewall fin-timeout <value>

Use the ip firewall fin-timeout command to specify the time period allowed for Transmission Control
Protocol (TCP) FIN. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the time period in seconds allowed for TCP FIN. Range is 0 to
4294967295 seconds.
Default Values
By default, ip firewall fin-timeout is set to 4 seconds.
Command History
Usage Examples
The following example sets the TCP FIN time period to 120 seconds:
(config)#ip firewall fin-timeout 120

ip firewall nat-preserve-source-port
Use the ip firewall nat-preserve-source-port command to enable the firewall to preserve the source port
of a Transmission Control Protocol (TCP) or User Datagram Protocol (UDP) session for traffic going
through source network address translation (NAT). By enabling this feature, the router will try to allocate
NAT ports that match the original source ports of the traffic. If the source port is already allocated for a
different traffic flow, it will choose the next available source port. Use the no form of this command to
disable this feature. Variations of this command include the following:
ip firewall nat-preserve-source-port
ip firewall nat-preserve-source-port record-source-address
Syntax Description
record-source-address Optional. Specifies that the original source port be preserved for multiple
TCP/UDP traffic flows with the same source address.
Default Values
By default, the nat-preserve-source-port feature is enabled.
Command History
Functional Notes
Specifying record-source-address consumes 250 k of memory per public NAT IP address. Be sure there
is adequate memory available before enabling this feature.
Usage Examples
The following example enables nat-preserve-source-port:
(config)#ip firewall nat-preserve-source-port

ip firewall policy-log threshold <value>

Use the ip firewall policy-log threshold command to specify the number of connections required by an
access control policy before AOS will generate a log message. Use the no form of this command to return
to the default threshold.
Syntax Description
<value> Specifies the number of access policy connections AOS will identify before
generating a log message. Valid range: 0 to 4294967295.
Default Values
By default, the ip firewall policy-log threshold is set to 100.
Command History
Usage Examples
The following example specifies a threshold of 15 connections before generating a log message:
(config)#ip firewall policy-log threshold 15

ip firewall rst-timeout <value>

Use the ip firewall rst-timeout command to specify the time period allowed for Transmission Control
Protocol (TCP) reset. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the time period in seconds allowed for TCP reset. Range is 0 to
4294967295 seconds.
Default Values
By default, ip firewall rst-timeout is set to 20 seconds.
Command History
Usage Examples
The following example sets the TCP reset time period to 120 seconds:
(config)#ip firewall rst-timeout 120

ip firewall stealth
Use the ip firewall stealth command to disable Transmission Control Protocol (TCP) reset for denied
firewall associations. The stealth setting allows the route to be invisible as a route hop to associated
devices. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Configuration mode prompt. In addition, the stealth option is disabled until the ip firewall stealth
command is issued.
Command History
Usage Examples
The following example enables the stealth option:
(config)#ip firewall stealth

ip firewall vrf <name>

Use the ip firewall vrf command to enable the firewall for a particular VPN routing and forwarding (VRF)
instance. The firewall can be enabled or disabled independently for each VRF. Firewall settings are applied
globally across all VRF instances and cannot be changed on an individual VRF basis. Refer to the
command ip firewall on page 837 for more information on configuring firewall settings. Use the no form
of this command to disable the firewall for the specified VRF.
Syntax Description
<name> Specifies the VRF instance.
Default Values
By default, the firewall is disabled.
Command History
Functional Notes
of whether multi-VRF is configured.
Usage Examples
The following example enables the firewall on the VRF named RED:
(config)#ip firewall vrf RED

ip flow cache sample one-out-of <number>

Use the ip flow cache sample one-out-of command to configure the integrated traffic monitoring (ITM)
cache sampling rate. The no form of this command disables sampling. Variations of this command include:
ip flow cache sample one-out-of <number> deterministic

ip flow cache sample one-out-of <number> random
Syntax Description
deterministic Specifies that traffic flow sampling be done at a fixed rate.
random Specifies that traffic flow sampling be done at a random rate.
<number> Specifies the number of traffic flow packets to be observed before another
packet is sampled. Range is 1 to 255 packets.
Default Values
By default, sampling is disabled and every packet is recorded.
Command History
Release 17.1 Command was expanded to include the deterministic keyword.
Functional Notes
Sampling provides a snapshot of traffic flow activity. It allows the cache to collect only one out of a
specified number of IP packets that the interface is receiving or sending. Often, network traffic arrives in
fixed patterns. This pattern can make statistics inaccurate if deterministic sampling is used. Therefore,
random sampling is recommended over deterministic sampling to ensure an accurate sampling of traffic
flow patterns. By reducing the amount of traffic flow data collected, sampling minimizes memory and CPU
usage.
For users of large routers (for example, the NetVanta 5305), a sampling rate of greater
than or equal to one out of every 100 packets is recommended.
Usage Examples
The following example configures ITM to sample one packet out of every 100 at a random sample rate:
(config)#ip flow cache sample one-out-of 100 random

ip flow cache timeout

Use the ip flow cache timeout command to configure the integrated traffic monitoring (ITM) cache for
entry expiration. The no form of this command resets the expiration time to the default setting. Variations
ip flow cache timeout active <minutes>

ip flow cache timeout inactive <seconds>
Syntax Description
active <minutes> Specifies the amount of time a single traffic flow that continues to have
packets detected at the observation point is stored before exportation.
Range is 1 to 60 minutes.
inactive <seconds> Specifies the amount of time that idle traffic flows (which no longer have
packets detected at the observation point) are stored before exportation.
Range is 10 to 600 seconds.
Default Values
By default, active flows are set to expire in 30 minutes, and inactive flows are set to expire in 15 seconds.
Command History
Functional Notes
Traffic flow entry expiration can occur in one of three ways: (1) the configured expiration time has passed;
(2) the Transmission Control Protocol (TCP) connection between the cache and the flow collector has
expired due to FINISH/RESET signaling; or (3) critical configuration changes have been made (for
example, changing the sampling rate). The default mode of expiration is based on a configured number of
minutes for the traffic flow entry to be stored in the cache.
Usage Examples
The following example configures an expiration time of 15 minutes for active traffic flow entries:
(config)#ip flow cache timeout active 15

ip flow export
Use the ip flow export command to configure traffic flow data exportation parameters for integrated
traffic monitoring (ITM). Use the no form of this command to disable the export functionality or to remove
an associated destination if multiple entries are specified. Variations of this command include:
ip flow export destination <ip address> <port>

ip flow export destination <ip address> <port> source <interface>
ip flow export vrf <name> destination <ip address> <port>
ip flow export vrf <name> destination <ip address> <port> source <interface>
Syntax Description
destination <ip address> <port> Specifies the IP address and User Datagram Protocol (UDP) port
through which the destination will receive data export packets.
source <interface> Specifies a source interface to send the data export packets. Specify an
interface in the format <interface type [slot/port | slot/port.subinterface id
| interface id | interface id.subinterface id]>. For example, for an
Ethernet subinterface, use eth 0/1.1; for a PPP interface, use ppp 1;
and for an ATM subinterface, use atm 1.1. Valid interfaces are those
that can have an IP address. Type source ? for a complete list of valid
interfaces.
vrf <name> Specifies the VPN routing and forwarding (VRF) location to be used in
data export.
Default Values
By default, ip flow export is disabled.
By default, if no source is specified, the router interface at the hop closest to the data collector will be
sourced.
Command History
Functional Notes
Up to two different destinations can be specified for traffic flow data export.
Using the source command specifies an interface from which to send the data export packets. If using a
VRF destination, the source must be on the same VRF as the destination or it will be ignored and the
routing table will determine the source interface. Most often, a source will only need to be specified for
security purposes. For example, if an access control list (ACL) is active on the external data collector, a
source interface may need to be specified.

Usage Examples
The following example configures the export destination to be the external data collector at the IP address
208.61.209.5 through the User Datagram Protocol (UDP) port 1010.
(config)#ip flow export destination 208.61.209.5 1010

ip flow export template

Use the ip flow export template command to configure template exportation rates for integrated traffic
monitoring (ITM). Use the no form of this command to return rate values to the default setting. Variations
ip flow export template refresh-rate <packets>

ip flow export template timeout-rate <minutes>
Syntax Description
refresh-rate <packets> Specifies the number of packets to be sent before the template information
is sent to an external collector. Range is 1 to 600 packets.
timeout-rate <minutes> Specifies the time in minutes that passes between instances of resending
the template information. Range is 1 to 3600 minutes.
Default Values
By default, template information is sent every 20 packets, and template information is re-sent every
30 minutes.
Command History
Usage Examples
The following example configures the template information to be sent every 50 packets:
(config)#ip flow export template refresh-rate 50
In the following example, traffic flow template information is configured to resend every 15 minutes:
(config)#ip flow export template timeout-rate 15
Technology Review
When exporting traffic flow data, there are multiple types of information sent to the external data flow
collector. There is data information about each traffic flow, system information about each traffic flow, and
the traffic flow record itself. The information about the traffic flow record is called a template. Templates are
used to describe the types and lengths of individual header fields within a traffic flow data record.
Templates also communicate to the external data collector what type of information to expect in the ITM
flow record.

The following tables describe the information contained in each template.
Table 1. Data Template Information
Source IP Address
Destination IP Address
Transport Protocol Type
Source Port
Destination Port
Type of Service (ToS) Bits
Packets in a Flow
Bytes in a Flow
Interface (Input or Output)
System Up Time of First Packet
System Up Time of Last Packet
Flow Direction
Table 2. Options (System) Template Information
Active-Flow Timeout
Inactive-Flow Timeout
Sampling Rate
Sampling Algorithm (Random)
Total Packets Exported to Collectors
Total Flows Exported to Collectors
Total Bytes Exported to Collectors
Templates are sent to the external data collector after a user-specified number of expired traffic flow
entries. They are also re-sent periodically at user-defined intervals. The templates must be re-sent
periodically because User Datagram Protocol (UDP) is often unreliable, and the collector may discard all
traffic flow data lacking valid template information.

ip flow top-talkers
Use the ip flow top-talkers command to enable Top Talker functionality for integrated traffic monitoring
(ITM) and enter Top Talker configuration mode. Use the no form of this command to disable the Top
Talkers functionality and remove all associated settings.
For Top Talkers functionality to be enabled, ITM must be enabled on an interface. Refer to
the ip flow egress | ingress command. Refer to ip flow on page 1341 for more information
on enabling ITM.
Syntax Description
No subcommands.
Default Values
By default, the Top Talkers feature is disabled.
Command History
Usage Examples
The following example enables top talkers:
(config)#ip flow top-talkers

Technology Review
Using the internal Top Talkers data collection feature of ITM, several of the most important flow cache
statistics can be viewed at a glance from within the router itself. The Top Talkers feature incorporates the
statistics of Top Talkers (top bandwidth users by source IP address), Top Listeners (top bandwidth users by
destination IP address), and Port Lists (amounts of traffic observed on specific ports) into easily viewed
output, accessed through either the command line interface (CLI) or Web-based graphical user interface
(GUI). These statistics are captured by the metering process at the traffic flow observation point, and
collected as traffic flow entries expire from the flow cache. These statistics allow the user to see the nature
of traffic being processed by the router without having to configure an external server to collect data.
The internal Top Talkers data collector can be enabled instead of or in conjunction with an external data
collector, or it can operate with no external data collector configured. Because Top Talkers collects and
processes expired flow cache entries in a separate function from their exportation, it can function
independently of an external collector. With both an external data collector and Top Talkers enabled,
expired flow cache entries are sent to both the external data collector and through the Top Talkers
collector. The separation of Top Talkers collection from external data collectors provides methods of
separate data collector configuration, therefore, allowing the enablement of only Top Talkers collection, Top
Talkers collection in addition to external data collection, or external data collection only. For more
information on the ITM Top Talkers feature, refer to the Integrated Traffic Monitoring configuration guide
available on the AOS Documentation CD shipped with your product or online at http://kb.adtran.com
(article number 2157).

ip forward-protocol udp <value>

Use the ip forward-protocol udp command to specify the protocols and ports AOS allows when
forwarding broadcast packets. Use the no form of this command to disable a specified protocol or port
from being forwarded.
The ip forward-protocol udp command can be used in conjunction with the ip

helper-address command, issued in a valid interface, to configure AOS to forward User
Datagram Protocol (UDP) broadcast packets.
Syntax Description
<value> Specifies the UDP traffic type (using source port).
The following is the list of UDP port numbers that may be identified using
the text name:
biff (Port 512) pim-auto-rp (Port 496)
bootps (Port 67) rip (Port 520)
discard (Port 9) snmp (Port 161)
dnsix (Port 195) snmptrap (Port 162)
domain (Port 53) sunrpc (Port 111)
echo (Port 7) syslog (Port 514)
isakmp (Port 500) tacacs (Port 49)
mobileip (Port 434) talk (Port 517)
nameserver (Port 42) tftp (Port 69)
netbios-dgm (Port 138) time (Port 37)
netbios-ns (Port 137) who (Port 513)
netbios-ss (Port 139) xdmcp (Port 177)
ntp (Port 123)
Alternately, the <value> may be specified using the following syntax:

<0-65535>. Specifies the port number used by UDP to pass information to
upper layers. All ports below 1024 are considered well-known ports and are
controlled by the Internet Assigned Numbers Authority (IANA). All ports
above 1024 are dynamically assigned ports that include registered ports for
vendor-specific applications.
Default Values
By default, AOS forwards broadcast packets for all protocols and ports.
Command History

Functional Notes
Use this command to configure AOS to forward UDP packets across the wide area network (WAN) link to
allow remote devices to connect to a UDP service on the other side of the WAN link.
Usage Examples
The following example forwards all domain naming system (DNS) broadcast traffic to the DNS server with
IP address 192.33.5.99:
(config)#ip forward-protocol udp domain

(config)#interface eth 0/1
(config-eth 0/1)#ip helper-address 192.33.5.99

ip ftp access-class <name> in

Use the ip ftp access-class in command to assign an access policy to all self-bound File Transfer Protocol
(FTP) sessions. Use the no form of this command to disable this feature.
Syntax Description
<name> Specifies the configured access control policy (ACP) to apply to inbound
FTP traffic.
Default Values
By default, all FTP access is allowed.
Command History
Usage Examples
The following example applies the configured ACP (labeled Inbound_FTP) to inbound FTP traffic:
(config)#ip ftp access-class Inbound_FTP in

ip ftp server
Use the ip ftp server command to enable the File Transfer Protocol (FTP) server and optionally specify
the default location for the FTP server to store and retrieve files. Use the no form of this command to
disable the FTP server. Variations of this command include:
ip ftp server
ip ftp server default-filesystem cflash
ip ftp server default-filesystem flash
ip ftp server default-filesystem ramdisk
Syntax Description
default-filesystem Specifies the default file system for the FTP server to use.
cflash Optional. Specifies the FTP server use the CompactFlash® card as the
default file system.
flash Optional. Specifies that the FTP server use the system flash as the default
file system.
ramdisk Optional. Specifies that the FTP server use the volatile RAM disk as the
default file system.
Default Values
By default, the ip ftp server default-filesystem is set to flash.
Command History
Usage Examples
The following example enables the FTP server:
(config)#ip ftp server
The following example specifies cflash file system as the default:
(config)#ip ftp server default-filesystem cflash

ip ftp source-interface <interface>

Use the ip ftp source-interface command to use the specified interface’s IP address as the source IP
address for File Transfer Protocol (FTP) traffic transmitted by the unit. Use the no form of this command if
you do not wish to override the normal source IP address.
Syntax Description
<interface> Specifies the interface to be used as the source IP address for FTP traffic.
dot11ap 1/1.1. Type ip ftp source-interface ? for a complete list of valid
interfaces.
Default Values
Command History
interface.
Release 15.1 Command was expanded to include the bridged virtual interface (BVI).
Release 17.1 Command was expanded to include the asynchronous transfer mode (ATM)
interface.
Functional Notes
This command allows you to override the sender field in the IP packet. If you have multiple interfaces in
your unit, changing the sender tells the receiver where to send replies. This functionality can also be used
to allow packets to get through firewalls that would normally block the flow.
Usage Examples
The following example configures the unit to use the loopback 1 interface as the source IP for FTP traffic:
(config)#ip ftp source-interface loopback 1

ip host
Use the ip host command to define an IP host name either for the default VPN routing and forwarding
(VRF) or for a specified VRF instance. This allows you to statically map host names and addresses in the
host cache. Use the no form of this command to remove defined maps. Variations of this command
include:
ip host <hostname> <ip address>

ip host vrf <name> <hostname> <ip address>
Syntax Description
<hostname> Defines the name of the host.
<ip address> Specifies IP address associated with this IP host. IP addresses should be
vrf <name> Optional. Specifies a nondefault VRF on which to define the IP host name.
Default Values
By default, the host table is empty.
Command History
Functional Notes
The host name may be any combination of numbers and letters as long as it is not a valid IP address or
does not exceed 256 characters.
Usage Examples
The following example defines two static mappings:
(config)#ip host mac 10.2.0.2

(config)#ip host dal 172.38.7.12

ip http
Use the ip http command to enable Web access to the AOS unit using Hypertext Transfer Protocol
(HTTP) or Hypertext Transfer Protocol Secure (HTTPS). Use the no form of this command to disable this
feature. Variations of this command include:
ip http access-class <name> in

ip http authentication <listname>
ip http language <language>
ip http secure-access-class <name> in
ip http secure-server
ip http secure-server allow-sslv2
ip http secure-server <TCP port>
ip http secure-server <TCP port> allow-sslv2
ip http server
ip http server <name>
ip http session-limit <number>
ip http session-timeout <value>
Syntax Description
access-class <name> Restricts access to the HTTP server using the specified access control list
(ACL).
authentication <listname> Assigns the specified authentication, authorization, and accounting (AAA)
list to use in authentication to the AOS device’s HTTP server. AAA must
be enabled to apply this list (using the command aaa on on page 751).
in Optional. Applies to all incoming connections.
language <language> Specifies the language of the Web-based graphical user interface (GUI).
Choose from [english | frenchcanadian | italian | latinamspanish |
simplifiedchinese].
secure-access-class <name> Restricts access to the HTTPS server using the specified secure ACL.
secure-server Enables the HTTP secure-server and defaults the server to use secure
sockets layer version 3.0 (SSLv3).
allow-sslv2 Optional. Allows the server to fall back to secure sockets layer version 2.0
(SSLv2) if unable to connect using SSLv3.
<TCP port> Optional. Specifies an alternate port for HTTPS.
server Optional. Enables the specified HTTP server connection.
<TCP port> Optional. Specifies an alternate port for HTTP.
session-limit <number> Sets the maximum number of sessions allowed. Valid range is 0 to 100
with 100 as the default.
session-timeout <value> Sets the session timeout value. Valid range is 10 to 86400 seconds. The
default is 600 seconds.
Default Values

Command History
Release 13.1 Command was expanded to include Italian.
Release 14.1 Command was expanded to include French Canadian, Latin American
Spanish, and Simplified Chinese languages.
Release 17.6 Command was expanded to include allow-sslv2.
Usage Examples
The following example enables Web access to the router:
(config)#ip http server

ip http source-interface <interface>

Use the ip http source-interface command to specify a source interface for Hypertext Transfer Protocol
(HTTP) traffic originated by the unit. The IP address of the specified interface will be used to source all
HTTP traffic. Use the no form of this command if you do not wish to override the default source IP
address.
This command pertains to the HTTP Client and not the HTTP server.
Syntax Description
<interface> Specifies the source interface for HTTP traffic. Specify an interface in the
wireless virtual access point, use dot11ap 1/1.1. Type ip http
source-interface ? for a complete list of valid interfaces.
Default Values
By default, no HTTP source interface is defined.
Command History
interface.
Functional Notes
Usage Examples
The following example configures the unit to use the loopback 1 interface as the source IP for HTTP
traffic:
(config)#ip http source-interface loopback 1

ip hw-access-list extended <name>

Use the ip hw-access-list extended command to create and name an IP hardware access control list
(ACL). This command also enters the ACL’s configuration mode. Using the no form of this command
deletes the IP hardware ACL.
For a complete list of all IP hardware ACL configuration commands, refer to the
Syntax Description
<name> Specifies the name of the IP hardware ACL.
Default Values
By default, all AOS security features are disabled, and there are no configured hardware ACLs.
Command History
Functional Notes
This command only creates an empty hardware ACL, it does not configure it. For additional IP hardware
ACL configuration commands and configuration parameters, refer to the Hardware ACL and Access Map
Command Set on page 2491 or the Hardware ACLs in AOS configuration guide available online at
http://kb.adtran.com (article number 3088).
Usage Examples
The following example creates an IP hardware ACL Trusted and enters the IP hardware ACL
configuration mode:
(config)#ip hw-access-list extended Trusted

Configuring New IP Hardware Extended ACL “Trusted”
(config-ext-ip-hw-nacl)#
Technology Review
Hardware ACLs are used as traffic selectors by the hardware access maps; by themselves they do
nothing. Hardware ACLs are composed of an ordered list of entries with an implicit deny any at the end of
each list. A hardware ACL with no entries includes an implicit permit any. An ACL entry contains two parts:
an action (permit or deny) and a frame pattern. A permit ACL matches frames (meeting the specified
pattern) and allows them to enter the router system. A deny ACL advances AOS to the next access list
entry.

ACL criteria are compared to the incoming frame in the order in which they were entered or from the top of
the list down. Generally, the most specific entries should be at the top and the more general at the bottom.


ip igmp join <ip address>

Use the ip igmp join command to instruct the router stack to join a specific group. The stack may join
multiple groups. Use the no form of this command to disable this feature.
Syntax Description
<ip address> Specifies the IP address of a multicast group. IP addresses should be
Default Values
Command History
Functional Notes
This command aids in debugging, allowing the router’s IP stack to connect to and respond on a multicast
group. The local stack operates as an Internet Control Message Protocol (IGMP) host on the attached
segment. In multicast stub applications, the global helper address takes care of forwarding IGMP
joins/responses on the upstream interface. The router may respond to ICMP echo requests for the joined
groups.
Usage Examples
The following example configures the unit to join with the specified multicast group:
(config)#ip igmp join 172.0.1.50

ip igmp snooping
Use the ip igmp snooping command to globally enable Internet Group Management Protocol (IGMP)
snooping. Use the no form of this command to disable global IGMP snooping.
Global IGMP snooping overrides the virtual local area network (VLAN) IGMP snooping.
If global snooping is disabled, you cannot enable VLAN IGMP snooping. If global
snooping is enabled, you can enable or disable VLAN IGMP snooping.
Syntax Description
No subcommands.
Default Values
By default, IGMP snooping is enabled.
Command History
Functional Notes
IGMP snooping is a method of preventing switches from flooding all ports with received multicast streams.
By monitoring the conversations between a host and a router, the switch can determine which multicast
streams will interest a host and load its own forwarding tables to take advantage of that knowledge. When
the host sends a leave message to the router, the switch removes the entries after a timeout period.
Usage Examples
The following example globally enables IGMP snooping:
(config)#ip igmp snooping

ip igmp snooping vlan <vlan id>

Use the ip igmp snooping vlan command to enable Internet Group Management Protocol (IGMP)
snooping on the specified virtual local area network (VLAN). Use the no form of this command to disable
VLAN IGMP snooping.
Global IGMP snooping overrides the VLAN IGMP snooping. If global snooping is
disabled, you cannot enable VLAN IGMP snooping. If global snooping is enabled, you can
enable or disable VLAN IGMP snooping. Refer to ip igmp snooping on page 876 for more
information.
Syntax Description
Default Values
By default, VLAN IGMP snooping is enabled.
Command History
Usage Examples
The following example enables IGMP snooping on VLAN 1:
(config)#ip igmp snooping vlan 1

ip igmp snooping vlan <vlan id> mrouter interface <interface>

Use the ip igmp snooping vlan mrouter interface command to add a static connection to a multicast
router. Use the no form of this command to remove a static connection to a multicast router.
Global Internet Group Management Protocol (IGMP) snooping overrides the virtual local
area network (VLAN) IGMP snooping. If global snooping is disabled, you cannot enable
VLAN IGMP snooping. If global snooping is enabled, you can enable or disable VLAN
IGMP snooping. Refer to ip igmp snooping on page 876 for more information.
Syntax Description
<interface> Specifies an interface to be added to the multicast router. Specify an
atm 1.1; and for a wireless virtual access point, use dot11ap 1/1.1. Type ip
igmp snooping vlan <vlan id> mrouter interface ? for a complete list of
Default Values
Command History
Usage Examples
The following example adds Ethernet interface 0/1 to the list of multicast router interfaces:
(config)#ip igmp snooping vlan 1 mrouter interface ethernet 0/1

ip igmp snooping vlan <vlan id> static <mac address>

interface <interface>
Use the ip igmp snooping vlan static interface command to statically configure a Layer 2 interface as a
member of a multicast group. Use the no form of this command to remove a Layer 2 interface from a
multicast group.
Global Internet Group Management Protocol (IGMP) snooping overrides the virtual local
area network (VLAN) IGMP snooping. If global snooping is disabled, you cannot enable
VLAN IGMP snooping. If global snooping is enabled, you can enable or disable VLAN
IGMP snooping. Refer to ip igmp snooping on page 876 for more information.
Syntax Description
<vlan id> Specifies the VLAN ID of the multicast group. Range is 1 to 4094.
<mac address> Specifies the group’s 48-bit medium access control (MAC) address. MAC
example, 00:A0:C8:00:00:01).
<interface> Specifies an interface identification for the member interface. Specify an
atm 1.1; and for a wireless virtual access point, use dot11ap 1/1.1. Type ip
igmp snooping vlan <vlan id> static <mac address> interface ? for a
Default Values
Command History

Functional Notes
There are two types of multicast addresses: MAC addresses and IP addresses. A multicast IP address is a
Class D address (224.0.0.0 to 239.255.255.255). These addresses are also referred to as group
destination addresses (GDAs). Each GDA has an associated multicast MAC address. A multicast MAC
address is formed by using the prefix 01-00-5e followed by the last 23 bits of the GDA. The <mac address>
specified in this command must be a multicast MAC address. The following table shows examples of
multicast MAC addresses.
Multicast Addresses
Multicast IP Address Multicast MAC Address

226.10.10.10 01-00-5e-0a-0a-0a
228.20.20.20 01-00-5e-14-14-14
230.30.30.30 01-00-5e-1e-1e-1e
This mapping of IP addresses is a many-to-one relationship. For example, 226.10.10.10 maps to the same
MAC address as 227.10.10.10. The entire Class D network is not available for multicast. The following
table shows the reserved addresses.
Reserved Multicast IP Addresses
224.0.0.1 All Multicast-capable hosts

224.0.0.2 All Multicast-capable routers
224.0.0.5 and 224.0.0.6 Reserved for OSPF
224.0.0.1 to 224.0.0.255 Generally reserved for various protocols
Usage Examples
The following example configures the Ethernet interface 0/1 as a member of the multicast group with
multicast MAC address 01:00:5E:01:01:01:
(config)#ip igmp snooping vlan 1 static 01:00:5E:01:01:01 interface ethernet 0/1

ip load-sharing
Use the ip load-sharing command to configure whether parallel routes in the route table are used to
load-share forwarded packets. If this command is disabled, the route table uses a single “best” route for a
given subnet. If this command is enabled, the route table can use multiple “best” routes and alternate
between them. Use the no form of this command to disable this feature. Variations of this command
include:
ip load-sharing per-destination
ip load-sharing per-packet
Syntax Description
per-destination Specifies that the route used for forwarding a packet be based on a hash of
the source and destination IP address in the packet.
per-packet Specifies that each forwarding route lookup rotates through all the parallel
“best” routes. (Parallel routes are defined as routes to the same subnet with
the same metrics that only differ by their next-hop address.)
Default Values
By default, ip load-sharing is disabled.
Command History
Usage Examples
The following example turns on load-sharing per destination:
(config)#ip load-sharing per-destination
The following example disables load-sharing:
(config)#no ip load-sharing

ip local policy route-map <name>

Use the ip local policy route-map command to specify a route map for local policy routing on the device.
This setting is applied to the local network interface. It can be further specified to a specific VPN routing
and forwarding (VRF) by adding the VRF name. Use the no form of this command to return to the default
route map. Variations of this command include:
ip local policy route-map <name>

ip local policy route-map <name> vrf <name>
Syntax Description
<name> Specify the name of the route map.
vrf <name> Optional. Specifies a nondefault VRF on which to define the local policy
route map.
Default Values
Command History
Functional Notes
Before a route map can be specified, it must first be defined using the route-map command. Refer to
route-map on page 1070 for more information.
There is only one local policy for each VRF instance.
Usage Examples
The following example specifies a route map entitled myMap for local policy routing:
(config)#ip local policy route-map myMap

ip mcast-stub helper-address <ip address>

Use the ip mcast-stub helper-address command to specify an IP address toward which Internet Group
Management Protocol (IGMP) host reports and leave messages are forwarded. This command is used in IP
multicast stub applications in conjunction with the ip mcast-stub downstream and ip mcast-stub
upstream commands. Use the no form of this command to return to the default setting.
Syntax Description
<ip address> Specifies the address to which the IGMP host reports and leave messages
are forwarded. IP addresses should be expressed in dotted decimal
Default Values
By default, no helper-address is configured.
Command History
Functional Notes
The helper address is configured globally and applies to all multicast-stub downstream interfaces. The
address specified may be the next upstream hop or any upstream address on the distribution tree for the
multicast source, up to and including the multicast source. The router selects, from the list of multicast-stub
upstream interfaces, the interface on the shortest path to the specified address. The router then proxies,
on the selected upstream interface (using an IGMP host function), any host joins/leaves received on the
downstream interface(s). The router retransmits these reports with addresses set as if the report originated
from the selected upstream interface.
For example, if the router receives multiple joins for a group, it will not send any extra joins out the
upstream interface. Also, if it receives a leave, it will not send a leave until it is certain that there are no
more subscribers on any downstream interface.
Usage Examples
The following example specifies 172.45.6.99 as the helper address:
(config)#ip mcast-stub helper-address 172.45.6.99

ip mgcp
Use the ip mgcp command to enable the Media Gateway Control Protocol (MGCP) stack. Use the no form
of this command to disable the MGCP stack.
Syntax Description
No subcommands.
Default Values
By default, the MGCP stack is disabled.
Command History
Usage Examples
The following example enables the MGCP stack:
(config)#ip mgcp

ip mgcp bracketed-ip
Use the ip mgcp bracketed-ip command to control whether bracketed IP addresses are used in specifying
Media Gateway Control Protocol (MGCP) endpoint names. Use the no form of this command to disable
the bracket requirement when entering MGCP endpoint IP addresses.
Syntax Description
No subcommands.
Default Values
By default, brackets are used when specifying MGCP endpoints.
Command History
Functional Notes
Some call agents require that brackets be used when an MGCP gateway uses an IP address as its local
domain name, and some call agents do not support the bracketed format. Bracketed IP addresses are
displayed as endpointname@[xx.xx.xx.xx], whereas nonbracketed endpoint IP addresses are displayed
as endpointname@xx.xx.xx.xx. Using this command allows the user to control whether IP addresses will
be bracketed or not, rather than entering all IP addresses as bracketed IP addresses.
Usage Examples
The following example disables bracketed IP address control:
(config)#no ip mgcp bracketed-ip

ip mgcp call-agent primary <hostname>

Use the ip mgcp call-agent primary command to specify the primary Media Gateway Control Protocol
(MGCP) call agent host name. Use the no form of this command to remove the specified primary call
agent.
Syntax Description
<hostname> Specifies the call agent host name. Host names can be entered as either a
fully qualified domain name (FQDN) or as an IP address in dotted decimal
notation (XX.XX.XX.XX).
Default Values
By default, no primary call agents are configured.
Command History
Functional Notes
The ip mgcp call-agent primary command identifies the call agent to the media gateway. Both primary
and secondary call agents can be established, but at minimum a primary call agent is required. If a
connection with the primary call agent fails, call agents will be tried in the order they are entered in the
configuration. For more information regarding call agents and MGCP configuration, refer to the MGCP in
AOS configuration guide available on the AOS Documentation CD shipped with your product or online at
The no form of this command will only take effect if there are no secondary call agents
configured. If secondary call agents are configured, the primary call agent can be modified
by issuing this command with the new host name information.
The primary call agent host name cannot be removed while any secondary call agents are
configured. For more information about secondary call agents, refer to the command ip
mgcp call-agent secondary <hostname> on page 887.
Usage Examples
The following example configures the primary MGCP call agent, myagent@company.com:
(config)#ip mgcp call-agent primary myagent@company.com

ip mgcp call-agent secondary <hostname>

Use the ip mgcp call-agent secondary command to specify the secondary Media Gateway Control
Protocol (MGCP) call agent host name. Use the no form of this command to remove the specified
secondary call agent.
Syntax Description
<hostname> Specifies the call agent host name. Host names can be entered as either a
fully qualified domain name (FQDN) or as an IP address in dotted decimal
notation (XX.XX.XX.XX).
Default Values
By default, no secondary call agents are configured.
Command History
Functional Notes
Multiple secondary call agent host names can be configured. If a connection with the primary call agent
fails, call agents are tried in the order they are entered in the configuration. New secondary call agents are
added at the end of the list.
If secondary call agents are configured, primary call agents cannot be removed. For more
information about primary call agents, refer to the command ip mgcp call-agent primary
<hostname> on page 886.
Usage Examples
The following example specifies the secondary MGCP call agent as mysecondagent@company.com:
(config)#ip mgcp call-agent secondary mysecondagent@company.com

ip mgcp local-domain-name
Use the ip mgcp local-domain-name command to specify the local Media Gateway Control Protocol
(MGCP) domain name. Use the no form of this command to remove the associated host name from the
AOS product. Variations of this command include:
ip mgcp local-domain-name <hostname>

ip mgcp local-domain-name media-gateway
Syntax Description
<hostname> Specifies the gateway host name in either a fully qualified domain name
(FQDN) format or as an IP address in dotted decimal notation
(XX.XX.XX.XX).
media-gateway Specifies that the local domain name is based on the media gateway setting
on the physical interface used for outbound traffic (for example, the
Point-to-Point Protocol (PPP) or the Ethernet interfaces).
Default Values
By default, a local domain name is not configured.
Command History
Usage Examples
The following example specifies that the local domain name for the media gateway is
mygateway@company.com:
(config)#ip mgcp local-domain-name mygateway@company.com

(config)#

ip mgcp max1 <value>

Use the ip mgcp max1 command to specify the number of Media Gateway Control Protocol (MGCP)
message retransmissions between the gateway and the call agent. Use the no form of this command to
return to the default value.
Syntax Description
<value> Specifies the number of message retransmissions that will occur between
the gateway and the call agent while the gateway waits for a response from
the call agent. Range is 1 to 254.
Default Values
By default, the max1 value is set to 5.
Command History
Functional Notes
If the gateway does not receive a response from the call agent, the gateway retransmits MGCP messages
max1 times before the gateway either queries the domain naming system (DNS) to detect a possible
change in call agent interfaces or directs transmissions to alternate call agent IP addresses.
For more information about MGCP configuration, refer to the MGCP in AOS configuration guide available
on the AOS Documentation CD shipped with your product or online at http://kb.adtran.com (article number
2347).
Usage Examples
The following example sets the number of message transmissions between the gateway and the call agent
to 20:
(config)#ip mgcp max1 20

ip mgcp max2 <value>

Use the ip mgcp max2 command to specify the number of Media Gateway Control Protocol (MGCP)
message retransmissions between the MGCP gateway and the call agent before the gateway disconnects.
Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the number of message retransmissions that will occur before the
gateway disconnects from the call agent. Range is 0 to 255.
Default Values
By default, MGCP retransmissions before gateway disconnection is set to 7.
Command History
Functional Notes
When the gateway has retransmitted MGCP messages max2 times, it indicates that the gateway has
already exceeded the max1 value (refer to the command ip mgcp max1 <value> on page 889) and it will
contact the domain naming system (DNS) to search for alternate call agent interfaces which to connect. If
the gateway does not find any available call agent interfaces for connection, the gateway will disconnect.
The max2 value must always be greater than the max1 value. If the max1 value is
specified to be greater than the max2 value, the max2 value is automatically defined as
max1 + 1.
For more information about MGCP configuration, refer to the MGCP in AOS configuration guide available
on the AOS Documentation CD shipped with your product or online at http://kb.adtran.com (article number
2347).
Usage Examples
The following example specifies that the MGCP gateway will retransmit MGCP messages 30 times before
disconnecting from the call agent:
(config)#ip mgcp max2 30

ip mgcp persistent-notify
Use the ip mgcp persistent-notify command to enable persistent event notification to the Media Gateway
Control Protocol (MGCP) call agent. Use the no form of this command to disable persistent notification.
ip mgcp persistent-notify hd
ip mgcp persistent-notify hu
ip mgcp persistent-notify hf
Multiple combinations of the hd, hu, and hf parameters can be entered.
Syntax Description
hd Specifies that notification of endpoint hang down is sent to the call agent.
hu Specifies that notification of endpoint hang up is sent to the call agent.
hf Specifies that notification of endpoint hook flash is sent to the call agent.
Default Values
By default, persistent notification is disabled.
Command History
Functional Notes
When persistent notification is disabled, the media gateway will not send event notifications of endpoint
hang down (hd), hang up (hu), or hook flash (hf). When the feature is enabled, the media gateway will
send notification of endpoint events even if it has not received a notification request from the call agent.
Some call agents require the use of persistent notification. For example, sometimes hd notification is
required for initial dial tone once the link has become active. Refer to the configuration materials provided
with your call agent for more information.
Usage Examples
The following example enables persistent notification of endpoint hang down:
(config)#ip mgcp persistent-notify hd

ip mgcp qos dscp <value>

Use the ip mgcp qos dscp command to specify the differentiated services code point (DSCP) value in the
Media Gateway Control Protocol (MGCP) packets transmitted by the MGCP gateway. This value can be
used by quality of service (QoS) mechanisms to give priority for this type of traffic. Use the no form of this
Syntax Description
<value> Specifies the DSCP value. Range is 0 to 63.
Default Values
By default, the DSCP value for MGCP packets is 46.
Command History
Usage Examples
The following example specifies the DSCP value for MGCP gateways as 10:
(config)#ip mgcp qos dscp 10

ip mgcp retransmit-delay
Use the ip mgcp retransmit-delay command to specify the constant time between retransmissions of
Media Gateway Control Protocol (MGCP) messages. Use the no form of this command to return to the
default setting. Variations of this command include:
ip mgcp retransmit-delay 100ms

ip mgcp retransmit-delay 1sec
Syntax Description
100ms Specifies 100 milliseconds between retransmissions.
1sec Specifies 1 second between retransmissions.
2sec Specifies 2 seconds between retransmissions.
4sec Specifies 4 seconds between retransmissions.
Default Values
By default, retransmissions occur with longer and longer delays between retransmissions. These delays
are based on RFC 3435, which uses a User Datagram Protocol (UDP) back-off algorithm for MGCP
retransmission delay.
Command History
Usage Examples
The following example specifies that retransmissions will occur at a constant rate of 1sec:
(config)#ip mgcp retransmit-delay 1sec

ip mgcp rfc2833-signaling
Use the ip mgcp rfc2833-signaling command to enable the transmission and reception of ABCD signal
bits via RFC 2833 packets. Use the no form of this command to disable ABCD signaling.
Syntax Description
No subcommands.
Default Values
By default, ABCD signaling is disabled.
Command History
Usage Examples
The following example enables ABCD signaling:
(config)#ip mgcp rfc2833-signaling

ip mgcp standard
Use the ip mgcp standard command to specify the Media Gateway Control Protocol (MGCP) standard
the gateway will use. Use the no form of this command to return to the default standard. Variations of this
command include:
ip mgcp standard rfc3435

ip mgcp standard ncs
Syntax Description
rfc3435 Specifies that the RFC 3435 MGCP standard is used.
ncs Specifies that the MGCP 0.1/NCS 1.0 standard is used.
Default Values
By default, MGCP gateways use the rfc3435 standard.
Command History
Usage Examples
The following example sets the MGCP standard to ncs:
(config)#ip mgcp standard ncs

ip mgcp udp <port>

Use the ip mgcp udp command to specify the local listening port for the Media Gateway Control Protocol
(MGCP) stack for User Datagram Protocol (UDP) information. Use the no form of this command to return
to the default port.
Syntax Description
<port> Specifies the port to listen for UDP information. Range is 0 to 65535.
Default Values
By default, the MGCP gateway listens for UDP on port 2427 as defined by RFC 3435.
Command History
Usage Examples
The following example specifies that the MGCP gateway will listen for UDP information on port 2727:
(config)#ip mgcp udp 2727

ip multicast-routing
Use the ip multicast-routing command to enable the multicast router process. The command does not
affect other multicast-related configurations. Use the no form of this command to disable this feature.
Disabling this command prevents multicast forwarding, but does not remove other multicast commands
and processes.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables multicast functionality:
(config)#ip multicast-routing

ip name-server
Use the ip name-server command to designate one or more name servers to use for name-to-address
resolution. This command can be applied to the default VPN routing and forwarding (VRF) or a specific
VRF instance. Use the no form of this command to remove any addresses previously specified. Variations
ip name-server <ip address1>

ip name-server <ip address1> <ip address2>
ip name-server <ip address1> <ip address2> <ip address3>
ip name-server <ip address1> <ip address2> <ip address3> <ip address4>
ip name-server <ip address1> <ip address2> <ip address3> <ip address4> <ip address5>
ip name-server <ip address1> <ip address2> <ip address3> <ip address4> <ip address5> <ip address6>
ip name-server vrf <name> <ip address1>
ip name-server vrf <name> <ip address1> <ip address2>
ip name-server vrf <name> <ip address1> <ip address2> <ip address3>
ip name-server vrf <name> <ip address1> <ip address2> <ip address3> <ip address4>
ip name-server vrf <name> <ip address1> <ip address2> <ip address3> <ip address4> <ip address5>
ip name-server vrf <name> <ip address1> <ip address2> <ip address3> <ip address4> <ip address5>
<ip address6>
Syntax Description
<ip address 1-6> Specifies up to six name-server addresses.
vrf <name> Optional. Specifies a nondefault VRF where the name-server exists.
Default Values
By default, no name servers are specified.
Command History
Functional Notes
Usage Examples
The following example specifies host 172.34.1.111 as the primary name server and host 172.34.1.2 as the
secondary server:
(config)#ip name-server 172.34.1.111 172.34.1.2

ip nat pool <name>

Use the ip nat pool command to create a new static 1:1 network address translation (NAT) pool and enter
its configuration command set. This command can also be used to enter the command set for an existing
pool. Use the no form of this command to remove a configured NAT pool. Refer to the command local
<start ip address> <end ip address> global <start ip address> <end ip address> on page 1011 for more
information about mapping addresses for static 1:1 NAT pools. Variations of this command include:
ip nat pool <name>

ip nat pool <name> static
Syntax Description
<name> Enters the configuration commands set for an existing NAT pool identified
by the <name> variable.
<name> static Creates NAT pool for 1:1 static NAT and enters its configuration command
set. For a given configuration, a local address statically maps to a global
address and vice versa.
Default Values
By default, there are no NAT pools configured.
Command History
Release 17.4 Command was introduced to allow static NAT pools only.
Functional Notes
Static 1:1 NAT allows connections initiated from a particular private IP address to always map to a
particular public IP address. For every private host that requires a 1:1 NAT mapping, there must be a
corresponding NAT address on the public side. In previous versions of AOS, this was accomplished by
using an exhaustive list of all address mappings. AOS version 17.4 and later provided support for using
NAT pools that lists ranges of local and global IP addresses to create the 1:1 mappings.
Usage Examples
The following example creates a static 1:1 NAT pool named POOL1 and enters the NAT pool configuration
command set:
(config)#ip nat pool POOL1 static
The following example enters the configuration command set for an existing NAT pool named POOL2:
(config)#ip nat pool POOL2

ip policy-class <name>
Use the ip policy-class command to create an access control policy (ACP) and enter the ACP command
set. Use the no form of this command to delete an ACP and all the entries it contains. Refer to the Access
Control Policy Command Set on page 2428.
Configured ACPs will only be active if the command ip firewall on page 837 has been
entered at the Global Configuration mode prompt to enable the AOS security features. All
configuration parameters are valid, but no security data processing will be attempted
unless the security features are enabled.
Before applying an ACP to an interface, verify your Telnet or secure shell (SSH)
connection will not be affected by the policy. If an ACP is applied to the interface you are
connecting through and it does not allow Telnet or SSH traffic, your connection will be
lost.
Syntax Description
<name> Identifies the configured ACP using an alphanumeric descriptor (maximum
of 50 characters). All ACP descriptors are case sensitive.
Default Values
By default, all AOS security features are disabled and there are no configured ACP entries.
Command History
Functional Notes
AOS ACPs are used to allow, discard, or manipulate (using network address translation (NAT)) data for
each physical interface. Each ACP consists of an action (allow, discard, nat) and a selector access
control list (ACL). When packets are received on an interface, the configured ACPs are applied to
determine whether the data will be processed or discarded.
An implicit discard exists at the end of every ACP. Specifying a discard list is unnecessary
in most applications and should be used with caution. A discard list can adversely affect
certain functions of a unit (virtual private network (VPN), routing protocols, etc.).
Specifying an empty ACL or a nonexistent ACL in an ACP will result in an implicit permit.
Usage Examples
The following example creates an ACP named PRIVATE:
(config)#ip policy-class PRIVATE


Technology Review
ACPs and ACLs regulate traffic through the routed network. Creating ACPs and ACLs to regulate traffic
through the routed network is a four-step process:
Step 1:
Enable the security features of AOS using the ip firewall command. Refer to the command ip firewall on
Step 2:
Create an ACP that uses a configured ACL by issuing the ip policy-class command. AOS ACPs are used
to allow, discard, or manipulate (using NAT) data for each physical interface. Each ACP consists of an
action (allow, discard, nat) and a selector (ACL). When packets are received on an interface, the
configured ACPs are applied to determine whether the data will be processed or discarded.
Step 3:
Create an ACL to permit or deny specified traffic by using either the ip access-list extended or ip
access-list standard command. Standard ACLs match based on the source IP address of the packet.
Extended ACLs match based on the source and destination of the packet. Refer to the command ip
access-list extended <name> on page 815 or the command ip access-list standard <name> on page 817
for more information. Sources can be expressed in one of four ways:
1. Using the keyword any to match any IP address.
2. Using host <ip address> to specify a single host address.
3. Using the <ip address> <wildcard> format to match all IP addresses in a range. Wildcard masks work
in reverse logic from subnet masks. When broken out into binary form, a 0 indicates which bits of the
IP address to consider, a 1 indicates which bits are disregarded. For example, specifying 255 in any
octet of the wildcard mask equates to a “don’t care” for that octet in the IP address. Additionally, a
30-bit mask would be represented with the wildcard string 0.0.0.3, a 28-bit mask with 0.0.0.15, a 24-bit
mask with 0.0.0.255, and so forth.
4. Using the keyword hostname to match based on a domain naming system (DNS) name. DNS servers
must be configured or host names must be locally defined for this function to work.
Step 4:
Apply the created ACP to an interface. To assign an ACP to an interface, enter the interface configuration
mode for the desired interface and enter access-policy <acp name>. The following example assigns ACP
UNTRUSTED to the Ethernet 0/1 interface:

(config-eth 0/1)#access-policy UNTRUSTED

ip policy-class <name> max-host-sessions <number>

Use the ip policy-class max-host-sessions command to create or alter settings for an access control policy
(ACP). For more details on ACP functionality in AOS, refer to the Access Control Policy Command Set on
page 2428. Use the no form of this command to return to the default value.
Syntax Description
<name> Identifies the configured ACP using an alphanumeric descriptor (maximum
of 50 characters). All ACP descriptors are case sensitive.
<number> Specifies the maximum number of allowed ACP sessions that can be
created from each unique source address. This command is used in
conjunction with a named ACP and only applies the limit to that particular
ACP.
The number must be within the appropriate range limits. The limits depend
on the type of AOS device being used. Setting this value to 0 restores the
default setting. By default, this feature is turned off (meaning no limits per
source address will be enforced).
Default Values
Command History
Usage Examples
The following example allows no more than 100 policy sessions to be sourced from a single host IP
address on the ACP named PRIVATE:
(config)#ip policy-class PRIVATE max-host-sessions 100

ip policy-class max-sessions <number>

Use the ip policy-class max-sessions command to create or alter settings for an access control policy
(ACP). For more details on ACP functionality in AOS, refer to the Access Control Policy Command Set on
page 2428. Use the no forms of this command to return to the default value. Variations of this command
ip policy-class max-sessions <number>

ip policy-class <name> max-sessions <number>
Syntax Description
<name> Optional. Identifies the configured ACP using an alphanumeric descriptor
(maximum of 50 characters). All ACP descriptors are case sensitive.
<number> Specifies the maximum number of allowed policy sessions. Identifying an
ACP name sets the session limit only for the named ACP. Using this
command without specifying an ACP name sets the limit for the total
number of allowed sessions for all ACPs on the device.
This number must be within the appropriate range limits. The limits depend
on the type of AOS device being used. Setting this value to 0 restores the
default setting. When setting the max-sessions for all policies, this default
is determined at boot time based on the amount of memory available. For a
named ACP, this default is one-third of the total number of allowed ACP
sessions.
Default Values
Command History
Usage Examples
The following example allows no more than 100 policy sessions on the ACP named PRIVATE:
(config)#ip policy-class PRIVATE max-sessions 100
The number of maximum sessions can be set with or without specifying an ACP.
The following example sets a total global limit of 55700 policy sessions allowed on all ACPs:
(config)#ip policy-class max-sessions 55700
The following example restores the default policy sessions limit on the ACP named PRIVATE:
(config)#no ip policy-class PRIVATE max-sessions

ip policy-class <name> rpf-check

Use the ip policy-class rpf-check command to verify that traffic has entered on the appropriate interface
using a route lookup. Reverse path forwarding (RPF) is essentially a spoofing check. For more details on
IP policy class functionality in AOS, refer to the Access Control Policy Command Set on page 2428. Use
Syntax Description
<name> Identifies the configured access control policy (ACP) using an alphanumeric
descriptor (maximum of 50 characters). All ACP descriptors are case
sensitive.
rpf-check Enables RPF check (spoofing).
Default Values
This command is enabled by default.
Command History
Functional Notes
The rpf-check feature should be disabled if your application allows traffic to arrive on an interface sourced
from networks contradicting the route table. This feature can be disabled on a per ACP basis by issuing the
command in conjunction with the ACP name you do not want to be checked.
Usage Examples
The following example turns off the rpf-check feature for the ACP named PRIVATE:
(config)#no ip policy-class PRIVATE rpf-check

ip policy-timeout <protocol> <range> <port> <value>

Use multiple ip policy-timeout command to customize timeout intervals for protocols (Transmission
Control Protocol (TCP), User Datagram Protocol (UDP), Internet Control Message Protocol (ICMP),
Authentication Header (AH) Protocol, generic routing encapsulation (GRE), encapsulating security
payload (ESP)) or specific services (by listing the particular port number). Use the no form of this
command to return to the default timeout values.
Syntax Description
<protocol> Specifies the data protocol, such as ICMP, TCP, UDP, AHP, GRE, or ESP.
<range> Optional. Customizes timeout intervals for a range of TCP or UDP ports.
<port> Specifies the service port to apply the timeout value to; valid only for
specifying TCP and UDP services (not allowed for ICMP).
The following is the list of TCP port numbers that may be identified using
the text name (in bold):
all-ports kshell (Port 544)
bgp (Port 179) login (Port 513)
chargen (Port 19) lpd (Port 515)
cmd (Port 514) nntp (Port 119)
daytime (Port 13) pim-auto-rp (Port 496)
discard (Port 9) pop2 (Port 109)
domain (Port 53) pop3 (Port 110)
echo (Port 7) smtp (Port 25)
exec (Port 512) ssh (Port 22)
finger (Port 79) sunrpc (Port 111)
ftp (Port 21) syslog (Port 514)
ftp-data (Port 20) tacacs (Port 49)
gopher (Port 70) talk (Port 517)
hostname (Port 101) telnet (Port 23)
https (Port 443) time (Port 37)
ident (Port 113) uucp (Port 540)
irc (Port 194) whois (Port 43)
klogin (Port 543) www (Port 80)
The following is the list of UDP port numbers that may be identified using
the text name (in bold):
all-ports ntp (Port 123)
biff (Port 512) pim-auto-rp (Port 496)
bootpc (Port 68) rip (Port 520)
bootps (Port 67) snmp (Port 161)
discard (Port 9) snmptrap (Port 162)
dnsix (Port 195) sunrpc (Port 111)
domain (Port 53) syslog (Port 514)
echo (Port 7) tacacs (Port 49)

isakmp (Port 500) talk (Port 517)

mobile-ip (Port 434) tftp (Port 69)
nameserver (Port 42) time (Port 37)
netbios-dgm (Port 138) who (Port 513)
netbios-ns (Port 137) xdmcp (Port 177)
netbios-ss (Port 139)
<value> Specifies the wait interval (in seconds) before an active session is closed.
Valid range is 0 to 4294967295 seconds.
Default Values
<value> The following default policy timeout intervals values apply:
tcp (600 seconds; 10 minutes)
udp (60 seconds; 1 minute)
icmp (60 seconds; 1 minute)
ahp (60 seconds; 1 minute)
gre (60 seconds; 1 minute)
esp (60 seconds; 1 minute)
Command History
Release 11.1 Added AHP, GRE, and ESP policies.
Usage Examples
The following example creates customized policy timeouts for the following:
Internet traffic (TCP Port 80) timeout 24 hours (86400 seconds)

Telnet (TCP Port 23) timeout 20 minutes (1200 seconds)
FTP (21) timeout 5 minutes (300 seconds)
All other TCP services timeout 8 minutes (480 seconds)
(config)#ip policy-timeout tcp www 86400

(config)#ip policy-timeout tcp telnet 1200
(config)#ip policy-timeout tcp ftp 300
(config)#ip policy-timeout tcp all_ports 480
The following example creates customized policy timeouts for UDP network basic input/output system
(NetBIOS) ports 137 to 139 of 200 seconds and UDP ports 6000 to 7000 of 300 seconds:
(config)#ip policy-timeout udp range netbios-ns netbios-ss 200

(config)#ip policy-timeout udp range 6000 7000 300
The following example creates a customized policy timeout of 1200 seconds for ESP:
(config)#ip policy-timeout esp 1200

The following example creates a customized policy timeout of 1200 seconds for GRE:
(config)#ip policy-timeout gre 1200
The following example creates a customized policy timeout of 1200 seconds for AHP:
(config)#ip policy-timeout ahp 1200

ip prefix-list <name> description “<text>”

Use the ip prefix-list description command to create and name prefix lists. Use the no form of this
command to remove a prefix list.
Syntax Description
<name> Specifies a particular prefix list.
“<text>” Assigns text (enclosed in quotation marks) used as a description for the
prefix list. Maximum length is 80 characters.
Default Values
Command History
Functional Notes
This command adds a string of up to 80 characters as a description for a prefix list. It also creates the
prefix list if a prefix list of that name does not already exist.
Usage Examples
The following example adds a description to the prefix-list test:
(config)#ip prefix-list test description “An example prefix list”

ip prefix-list <name> seq <number>

Use the ip prefix-list seq command to specify a prefix to be matched or a range of mask lengths. Use the
no form of this command to remove a prefix list. Variations of this command include:
ip prefix-list <name> seq <number> deny <network ip /length>

ip prefix-list <name> seq <number> deny <network ip /length> ge <value>
ip prefix-list <name> seq <number> deny <network ip /length> le <value>
ip prefix-list <name> seq <number> permit <network ip /length>
ip prefix-list <name> seq <number> permit <network ip /length> ge <value>
ip prefix-list <name> seq <number> permit <network ip /length> le <value>
Syntax Description
<name> Specifies a particular prefix list.
<number> Specifies the entry's unique sequence number that determines the
processing order. Lower numbered entries are processed first. Range is
1 to 4294967294.
permit <network ip /length> Permits access to entries matching the specified network IP address and
the corresponding network prefix length (for example, 10.10.10.1 /24).
deny <network ip /length> Denies access to entries matching the specified network IP address and the
corresponding network prefix length (for example, 10.10.10.1 /24).
le <value> Specifies the upper end of the range. Range is 0 to 32.
ge <value> Specifies the lower end of the range. Range is 0 to 32.
Default Values
If no ge or le parameters are specified, an exact match is assumed. If only ge is specified, the range is
assumed to be from ge-value to 32. If only le is specified, the range is assumed to be from len to le-value.
Command History
Functional Notes
This command specifies a prefix to be matched. Optionally, it may specify a range of mask lengths. The
following rule must be followed: len < ge-value < le-value. A prefix list with no entries allows all routes. A
route that does not match any entries in a prefix list is dropped. As soon as a route is permitted or denied,
there is no further processing of the rule in the prefix list. A route that is denied at the beginning entry of a
prefix list will not be allowed, even if it matches a permitting entry further down the list.

Usage Examples
The following example creates a prefix list entry in the prefix list test matching only the 10.0.0.0/8 network:
(config)#ip prefix-list test seq 5 deny 10.0.0.0/8
The following example creates a prefix list entry in the prefix list test matching any network of length 24 or
less:
(config)#ip prefix-list test seq 10 permit 0.0.0.0/0 le 24

ip radius source-interface <interface>

Use the ip radius source-interface command to specify the network attached storage (NAS) IP address
attribute passed with the remote authentication dial-in user service (RADIUS) authentication request
packet. Use the no form of this command to remove a defined source interface.
Syntax Description
<interface> Specifies the source interface. Specify an interface in the format <interface
type [slot/port | slot/port.subinterface id | interface id | interface
wireless virtual access point, use dot11ap 1/1.1. Type ip radius
source-interface ? for a complete list of interfaces.
Default Values
By default, no source interface is defined.
Command History
Release 15.1 Command was expanded to include the bridged virtual interface (BVI).
interface.
Functional Notes
If this value is not defined, the address of the source network interface is used.
Usage Examples
The following example configures the Ethernet 0/1 port to be the source interface:
(config)#ip radius source-interface ethernet 0/1
The following example configures the BVI 1 interface to be the source interface:
(config)#ip radius source-interface bvi 1

ip route
Use the ip route command to add a static route to the route table. Use the no form of this command to
remove a configured static route. Variations of this command include:
ip route <ip address> <subnet mask> <interface>

ip route <ip address> <subnet mask> <interface> <administrative distance>
ip route <ip address> <subnet mask> <interface> <administrative distance> tag <number>
ip route <ip address> <subnet mask> <interface> <administrative distance> track <name>
ip route <ip address> <subnet mask> <interface> <administrative distance> track <name> tag <number>
ip route <ip address> <subnet mask> <interface> tag <number>
ip route <ip address> <subnet mask> <ip address>
ip route <ip address> <subnet mask> <ip address> tag <number>
ip route <ip address> <subnet mask> <ip address> track <name>
ip route <ip address> <subnet mask> <ip address> tag <number> track <name>
ip route <ip address> <subnet mask> <ip address> <administrative distance>
ip route <ip address> <subnet mask> <ip address> <administrative distance> tag <number>
ip route <ip address> <subnet mask> <ip address> <administrative distance> track <name>
ip route <ip address> <subnet mask> <ip address> <administrative distance> track <name> tag
<number>
ip route <ip address> <subnet mask> null 0
ip route <ip address> <subnet mask> null 0 <administrative distance>
ip route <ip address> <subnet mask> null 0 <administrative distance> tag <number>
ip route <ip address> <subnet mask> null 0 <administrative distance> track <name>
ip route <ip address> <subnet mask> null 0 tag <number>
ip route <ip address> <subnet mask> null 0 track <name>
Syntax Description
<ip address> Specifies the network address to add to the route table. IP addresses
example, /24).
[<interface> | <ip address>] Specifies the far-end IP address or an egress interface in the unit. Use the
ip route <ip address> <subnet mask> ? command to display a complete list
of egress interfaces.
null 0 Optional. Routes traffic destined for the specified network to the null
interface. The router drops all packets destined for the null interface. Use
the null interface to allow the router to advertise a route, but not forward
traffic to the route.
<administrative distance> Optional. Specifies an administrative distance associated with a particular
router used to determine the best route when multiple routes to the same
destination exist. The smaller the administrative distance, the more
preferable the route. Range is 1 to 255.

track <name> Optional. Enables tracking on the indicated route. Once the named track
enters a fail state, the route specified by the command is disabled and traffic
will no longer be routed using that route. For more information on
configuring tracks, refer to track <name> on page 1124.
tag <number> Optional. Specifies a number to use as a tag for this route. Route tags are
used to label and filter routes when dynamically redistributing routes into a
routing protocol (such as Routing Information Protocol (RIP)/open shortest
path first (OSPF)/Border Gateway Protocol (BGP)). Range is 1 to 65535.
Default Values
By default, there are no configured routes in the route table, and the tag of 0 is applied to the route.
Command History
Release 9.1 Tunnel was added as a supported interface.
Release 11.1 Demand was added as a supported interface.
Release 13.1 Command was expanded to include the track feature.
Release 15.1 Command was expanded to include route tagging capability.
Usage Examples
The following example adds a static route to the 10.220.0.0/16 network through the next-hop router
192.22.45.254 and a default route to 175.44.2.10:
(config)#ip route 10.220.0.0 255.255.0.0 192.22.45.254

(config)#ip route 0.0.0.0 0.0.0.0 175.44.2.10

ip route-cache express
Use the ip route-cache express command to globally enable Layer 3 switching. Use the no form of this
command to disable Layer 3 switching.
Syntax Description
No subcommands.
Default Values
Layer 3 switching is disabled by default, except on the NetVanta 1544. Layer 3 switching is enabled by
default on the NetVanta 1544.
Functional Notes
Layer 3 switching cannot be disabled on the NetVanta 1544. For more information about Layer 3 switching,
refer to the Layer 3 Switching in AOS configuration guide available on the AOS Documentation CD
shipped with your product or online at http://kb.adtran.com (article number 3070).
Command History
Usage Examples
The following example globally enables Layer 3 switching:
(config)#ip route-cache express

ip route vrf
Use the ip route vrf command to create a static route in one of the nondefault VPN routing and forwarding
(VRF) instances. Use the no form of this command to remove the static route. Variations of this command
include:
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>]
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] <distance>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] <distance> tag <number>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] <distance> tag <number>
track <name>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] <distance> track <name>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] <distance> track <name>
tag <number>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] tag <number>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] tag <number>
track <name>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] track <name>
ip route vrf <name> <ip address> <subnet mask> [<interface> | <ip address>] track <name>
tag <number>
ip route vrf <name> <ip address> <subnet mask> null 0
ip route vrf <name> <ip address> <subnet mask> null 0 <distance>
ip route vrf <name> <ip address> <subnet mask> null 0 <distance> tag <number>
ip route vrf <name> <ip address> <subnet mask> null 0 <distance> track <name>
ip route vrf <name> <ip address> <subnet mask> null 0 tag <number>
ip route vrf <name> <ip address> <subnet mask> null 0 tag <number> track <name>
ip route vrf <name> <ip address> <subnet mask> null 0 track <name>
ip route vrf <name> <ip address> <subnet mask> null 0 track <name> tag <number>
Syntax Description
<name> Specifies the name of the VRF instance.
<ip address> Specifies the network address to add to the route table. IP addresses
example, /24). Valid prefix lengths are 0 to 32.
[<interface> | <ip address>] Specifies the far-end IP address or an egress interface in the unit. Use the
ip route <ip address> <subnet mask> ? command to display a complete list
of egress interfaces. IP addresses should be expressed in dotted decimal
null 0 Optional. Routes traffic destined for the specified network to the null
interface. The router drops all packets destined for the null interface. Use
the null interface to allow the router to advertise a route, but not forward
traffic to the route.

<distance> Optional. Specifies an administrative distance associated with a particular

router used to determine the best route when multiple routes to the same
destination exist. The smaller the administrative distance, the more
preferable the route. Range is 1 to 255.
track <name> Optional. Enables tracking on the indicated route. Once the named track
enters a fail state, the route specified by the command is disabled and traffic
will no longer be routed using that route. For more information on
configuring tracks, refer to track <name> on page 1124.
tag <number> Optional. Specifies a number to use as a tag for this route. Route tags are
used to label and filter routes when dynamically redistributing routes into a
routing protocol (such as Routing Information Protocol (RIP)/open shortest
path first (OSPF)/Border Gateway Protocol (BGP)). Range is 1 to 65535.
Default Values
Command History
Release 17.5 Command was expanded to include the loopback interface.
Functional Notes
The VRF must have already been created (using the ip vrf <name> route-distinguisher <number>
command) before static routes can be configured.
Usage Examples
The following example adds a static route to the routing and forwarding tables used for the VRF RED:
(config)#ip route vrf RED 10.220.0.0 255.255.0.0 192.22.45.254

(config)#ip route vrf RED 0.0.0.0 0.0.0.0 175.44.2.10

ip routing
Use the ip routing command to enable the AOS IP routing functionality. Use the no form of this command
to disable IP routing.
Syntax Description
No subcommands.
Default Values
By default, IP routing is enabled.
Command History
Usage Examples
The following example enables the AOS IP routing functionality:
(config)#ip routing

ip rtp dtmf-relay min-duration <value>

Use the ip rtp dtmf-relay min-duration command to configure dual tone multi-frequency (DTMF) relay
duration that the DTMF digits must receive in order to be relayed. Use the no form of this command to
return to the default setting.
Syntax Description
<value> Specifies timeout period (in multiples of 10 milliseconds) allowed for DTMF
relay duration. Range is 20 to 250 seconds.
Default Values
By default, the DTMF relay value is 60.
Command History
Usage Examples
The following example sets the DTMF relay duration to 50:
(config)#ip rtp dtmf-relay min-duration 50

ip rtp firewall-traversal
Use the ip rtp firewall-traversal command to enable dynamic firewall traversal capability for RTP-based
traffic, allowing deep packet inspection of Session Description Protocol (SDP) packets to occur so RTP
will correctly traverse network address translation (NAT) in the firewall. This will open the proper ports
dynamically for the RTP traffic. Use the no form of this command to return to the default setting.
ip rtp firewall-traversal
ip rtp firewall-traversal enforce-symmetric-ip
ip rtp firewall-traversal policy-timeout <value>
ip rtp firewall-traversal reuse-nat-ports
Syntax Description
enforce-symmetric-ip Optional. Specifies that the same IP address must be used for both transmit
and receive for the RTP stream.
policy-timeout <value> Optional. Specifies timeout period in seconds allowed for inactive RTP
sessions to remain in the firewall. Range is 1 to 4294967295 seconds.
reuse-nat-ports Optional. Specifies that NAT ports be reused during calls.
Default Values
By default, the RTP dynamic firewall traversal is disabled and the policy timeout period is 45 seconds.
Command History
Release 14.1 Command was updated to include the reuse-nat-ports option.
Release A2 Command was updated to include the enforce-symmetric-ip option.
Functional Notes
Session Initiation Protocol (SIP) uses the SDP to format the SIP message body in order to negotiate a
Realtime Transport Protocol (RTP)/Realtime Transport Control Protocol (RTCP) connection between two
or more user agents (UAs). The ports used for this will always be selected in a pair, with the even port used
for RTP and the odd port for RTCP.
The SIP application-level gateway (ALG) (enabled using the ip firewall alg sip) configures the firewall to
examine the ALL SIP packets it identifies and maintain knowledge of SIP transmissions on the network.
Since SIP packet headers include port information for the call setup, the ALG must intelligently read the
packets and remember the information.
For a full SIP implementation, dynamic firewall traversal for RTP traffic must also be enabled using the ip
rtp firewall-traversal command. This allows the firewall to open the proper ports for the RTP traffic
between UAs. For more details on SIP functionality in AOS, refer to the Functional Notes and Technology
Review sections of the command ip firewall alg on page 842.

Usage Examples
The following example enables dynamic firewall traversal, and sets the policy timeout period at 60
seconds:
(config)#ip rtp firewall-traversal policy-timeout 60

ip rtp nat-session timeout <value>

Use the ip rtp nat-session timeout command to configure the network address translation (NAT) session
timeout for the Realtime Transport Protocol (RTP) packets. Use the no form of this command to return to
the default setting.
Syntax Description
<value> Specifies the timeout period in seconds allowed for an inactive NAT
session. Range is 32 to 900 seconds.
Default Values
By default, the timeout period is 32 seconds.
Command History
Usage Examples
The following example sets the NAT session timeout period at 60 seconds:
(config)#ip rtp nat-session timeout 60

ip rtp qos dscp <value>

Use the ip rtp qos dscp command to configure the differentiated services code point (DSCP) value with
which to mark IP Realtime Transport Protocol (RTP) packets. This marking can then be used by the
quality of service (QoS) mechanisms to give priority for this type of traffic in the unit. Use the no form of
this command to disable this feature.
Syntax Description
<value> Specifies the DSCP value. Valid range is 0 to 63.
Default Values
Command History
Usage Examples
The following example sets the DSCP value to 63:
(config)#ip rtp qos dscp 63

ip rtp quality-monitoring
Use the ip rtp quality-monitoring command to globally enable voice quality monitoring (VQM) of the
Realtime Transport Protocol (RTP) voice stream packets. Use the no form of this command to return to the
ip rtp quality-monitoring
ip rtp quality-monitoring filter access-class <acl>
ip rtp quality-monitoring filter user <SIP header>
ip rtp quality-monitoring sampling one-out-of <value>
ip rtp quality-monitoring scoring-adjustment japan
ip rtp quality-monitoring sip
ip rtp quality-monitoring snmp trap
ip rtp quality-monitoring snmp trap priority-level error
ip rtp quality-monitoring snmp trap priority-level info
ip rtp quality-monitoring snmp trap priority-level notice
ip rtp quality-monitoring snmp trap priority-level warning
ip rtp quality-monitoring udp
Syntax Description
filter Optional. Specify the filter(s) to limit the RTP traffic monitored by VQM.
access-class <acl> Optional. Specify the access control list(s) (ACL(s)) to limit the RTP
streams that will be monitored. If no ACL is defined, all calls will be
monitored.
user <SIP header> Optional. Specify the calls to be monitored based on their To or From
header fields. Only the RTP streams that match the specified header(s)
will be monitored. If no user filters are defined, all calls will be monitored
(except when limited by ACL(s) or the sampling rate.
sampling one-out-of <value> Optional. Specifies the sampling rate. The subset can be a number in the
range of 1 to 100.
scoring-adjustment japan Optional. Sets the region for scoring adjustment for Japan. In Japan, the
mean opinion score (MOS) statistics are calculated differently than in
other regions. VQM must be disabled and then enabled again for this
setting to take effect.
sip Optional. Enables the Session Initiation Protocol (SIP) application-level
gateway (ALG), SIP proxy, or B2BUA (as available) to mark firewall holes
created for RTP streams for monitoring of voice quality on these streams.
Issuing this command will enable VQM without a scoring adjustment
region.
snmp trap priority-level Optional. Enables snmp traps when a warning or error occurs.
error Optional. Specifically enables an snmp trap when an error occurs.
info Optional. Specifically enables an snmp trap on all calls.
notice Optional. Specifically enables an snmp trap on a notice event or when a
warning or error occurs.

warning Optional. Specifically enables an snmp trap when a warning or error

occurs.
udp Optional. Enables User Datagram Protocol (UDP) packet inspection to
determine if VQM should monitor RTP traffic. Issuing this command will
enable VQM without a scoring adjustment region.
Default Values
By default, the RTP quality monitoring is disabled and there is no scoring adjustment locale set.
Command History
Release A1 Command was expanded to include the filters and AOS voice products.
Release 17.6 Command was expanded to include snmp trap, and the priority-level
parameters including error, warning, info, and notice.
Usage Examples
The following example enables RTP quality monitoring:
(config)#ip rtp quality-monitoring

ip rtp quality-monitoring history

Use the ip rtp quality-monitoring history command to specify the category and number of previously
completed call statistics to store. Use the no form of this command to return to the default setting.
ip rtp quality-monitoring history

ip rtp quality-monitoring history cq-mos <value>
ip rtp quality-monitoring history jitter <value>
ip rtp quality-monitoring history loss <value>
ip rtp quality-monitoring history lq-mos <value>
ip rtp quality-monitoring history max-streams <value>
ip rtp quality-monitoring history out-of-order <value>
ip rtp quality-monitoring history pq-mos <value>
Syntax Description
cq-mos <value> Specifies a threshold for the conversational quality (CQ) mean opinion
score (MOS), and stores statistics below this threshold. The range is 0 to
4.4.
jitter <value> Specifies a threshold for the jitter. Statistics above this threshold are stored
as jitter. The packet-to-packet delay variation is measured in milliseconds
(from nAvgPDV). The range is 0 to 30000.
loss <value> Specifies a threshold for loss (in packets). Statistics above this threshold is
stored as lost packets. The range is 0 to 30000.
lq-mos <value> Specifies a threshold for the listening quality (LQ) MOS, and stores statistics
below this threshold. The range is 0 to 4.4.
max-streams <value> Specifies a number of previously completed call statistics to store. This is a
count of Realtime Transport Protocol (RTP) streams; each call can contain
two RTP streams. The range is 0 to 2000.
out-of-order <value> Specifies a threshold for out-of-order packets to be logged. Statistics above
this threshold are stored. The range is 0 to 30000.
pq-mos <value> Specifies a threshold for LQ MOS normalized to the PESQ (PQ) scale, and
stores statistics below this threshold. The range is 0 to 4.4.
Default Values
By default, the maximum number of RTP streams allowed in the history is 100.
Command History

Functional Notes
As calls complete, settings configured using this command are examined to determine whether the call
should be stored in the call history. The maximum number of streams to store may be configured; newer
calls will replace the oldest calls when the call history is full. The MOS score, loss, out-of-order packets,
and jitter can also be examined when a call completes. By default, all calls are stored in the call-history.
However, if threshold values are changed from their defaults, only calls with poorer quality than these
nondefault thresholds will be stored.
Usage Examples
The following example enables RTP quality monitoring history to store a maximum of 250 RTP streams:
(config)#ip rtp quality-monitoring history max-streams 250

ip rtp quality-monitoring jitter-buffer

Use the ip rtp quality-monitoring jitter-buffer command to specify the jitter buffer type and
configuration for the jitter buffer emulator (JBE) that generates the observable jitter statistics in Realtime
Transport Protocol (RTP) quality monitoring. Use the no form of this command to return to the default
setting. Variations of this command include:
ip rtp quality-monitoring jitter-buffer

ip rtp quality-monitoring jitter-buffer adaptive min <delay> nominal <value> max <value>
ip rtp quality-monitoring jitter-buffer fixed nominal <value> jitter-buffer-size <value>
Syntax Description
adaptive min <delay> Specifies the minimum acceptable jitter buffer delay to be used by the JBE.
The range is 10 to 240 milliseconds.
nominal <value> Specifies the starting delay applied to packets of the emulated jitter buffer.
The range is 10 to 240 milliseconds.
max <value> Specifies the maximum delay that the adaptive jitter buffer will be allowed to
use. The range is 40 to 320 milliseconds.
fixed nominal <value> Specifies the actual fixed delay that would be applied to the packet in a
nonemulated jitter buffer. The range is 4 to 250 milliseconds. There is no
default setting.
jitter-buffer-size <value> Specifies the number of packets that the emulated jitter buffer can hold. The
range is 10 to 500 packets. There is no default setting.
Default Values
By default, the jitter buffer is set to adaptive min 10 nominal 50 max 200.
Command History
Usage Examples
The following example enables the JBE to hold up to 175 packets in fixed mode:
(config)#ip rtp quality-monitoring jitter-buffer fixed nominal 50 jitter-buffer-size 175

ip rtp quality-monitoring jitter-threshold

Use the ip rtp quality-monitoring jitter-threshold command to specify the jitter thresholds that will be
considered early or late packet arrivals. Changing the jitter threshold will not impact currently active calls,
only the calls placed after the configuration change has taken place. Use the no form of this command to
return to the default setting. Variations of this command include:
ip rtp quality-monitoring jitter-threshold early <value>

ip rtp quality-monitoring jitter-threshold late <value>
Syntax Description
early <value> Specifies the time by which packets are deemed to have arrived early. The
range is 0 to 1000 milliseconds.
late <value> Specifies the time by which packets are deemed to have arrived late. The
range is 0 to 1000 milliseconds.
Default Values
By default, jitter thresholds are set to early 10, and late 60.
Command History
Usage Examples
The following example specifies the late jitter threshold at 45 ms:
(config)#ip rtp quality-monitoring jitter-threshold late 45

ip rtp quality-monitoring reporter <name>

Use the ip rtp quality-monitoring reporter command to create and name a voice quality monitoring
(VQM) reporter. Use the no form of this command to delete the reporter.
Syntax Description
<name> Specifies the name of the VQM reporter.
Default Values
By default, no VQM reporter exists.
Command History
Functional Notes
The ip rtp quality-monitoring reporter command creates a VQM reporter and also enters the reporter’s
configuration mode. For more information on configuring VQM reporters, refer to the VQM Reporter
Usage Examples
The following example creates the VQM reporter Reporter1 and enters the reporter’s configuration mode:
(config)#ip rtp quality-monitoring reporter Reporter1

Configuring New Reporter “Reporter1”

ip rtp quality-monitoring round-trip-delay

Use the ip rtp quality-monitoring round-trip-delay command to specify type of round-trip testing. The
endpoints and local units must be synchronized (time and date) for the timestamp method to be accurate,
and any firewalls between the endpoints must be configured to allow Internet Control Message Protocol
(ICMP) traffic to pass. Use the no form of this command to return to the default setting. Variations of this
command include:
ip rtp quality-monitoring round-trip-delay icmp-ping <value>

ip rtp quality-monitoring round-trip-delay icmp-timestamp <value>
Syntax Description
icmp-ping <value> Specifies the use of ICMP echo requests for calculating round-trip delay.
icmp-timestamp <value> Specifies the use of ICMP timestamp echo requests with icmp-ping for
more accurate results.
Default Values
By default, the determination type is icmp-ping.
Command History
Usage Examples
The following example specifies timestamp requests as the determination type for round-trip delay:
(config)#ip rtp quality-monitoring round-trip-delay icmp-timestamp

ip rtp quality-monitoring threshold jitter

Use the ip rtp quality-monitoring threshold jitter command to specify threshold values for logging jitter
events during Realtime Transport Protocol (RTP) quality monitoring. Calls with lower quality than the
specified thresholds will be logged as the defined type (info, notice, warning, or error). Use the no form
of this command to return to the default setting. Variations of this command include:
ip rtp quality-monitoring threshold jitter error

ip rtp quality-monitoring threshold jitter error <value>
ip rtp quality-monitoring threshold jitter info
ip rtp quality-monitoring threshold jitter info <value>
ip rtp quality-monitoring threshold jitter notice
ip rtp quality-monitoring threshold jitter notice <value>
ip rtp quality-monitoring threshold jitter warning
ip rtp quality-monitoring threshold jitter warning <value>
Syntax Description
error <value> Specifies the threshold for jitter error messages to be logged. The range is
0 to 30000.
info <value> Specifies the threshold for jitter information messages to be logged. The
notice <value> Specifies the threshold for jitter notice messages to be logged. The range is
0 to 30000.
warning <value> Specifies the threshold for jitter warning messages to be logged. The range
is 0 to 30000.
Default Values
By default, the jitter logging thresholds are info 0, notice 250, warning 350, error 450.
Command History
Usage Examples
The following example enables RTP quality monitoring jitter warning messages to be logged if jitter occurs
above 200 ms:
(config)#ip rtp quality-monitoring threshold jitter warning 200

ip rtp quality-monitoring threshold loss

Use the ip rtp quality-monitoring threshold loss command to specify threshold values for logging lost
packet events during Realtime Transport Protocol (RTP) quality monitoring. Calls with lower quality than
the specified thresholds will be logged as the defined type (info, notice, warning, or error). Use the no
ip rtp quality-monitoring threshold loss error

ip rtp quality-monitoring threshold loss error <value>
ip rtp quality-monitoring threshold loss info
ip rtp quality-monitoring threshold loss info <value>
ip rtp quality-monitoring threshold loss notice
ip rtp quality-monitoring threshold loss notice <value>
ip rtp quality-monitoring threshold loss warning
ip rtp quality-monitoring threshold loss warning <value>
Syntax Description
error <value> Specifies the threshold for lost packets error messages to be logged. The
info <value> Specifies the threshold for lost packets information messages to be logged.
The range is 0 to 30000.
notice <value> Specifies the threshold for lost packets notice messages to be logged. The
warning <value> Specifies the threshold for lost packets warning messages to be logged.
The range is 0 to 30000.
Default Values
By default, the lost packets thresholds are info 0, notice 25, warning 50, error 100.
Command History
Usage Examples
The following example enables RTP quality monitoring lost packets info messages to be logged if loss
occur above 10 packets:
(config)#ip rtp quality-monitoring threshold loss info 10

ip rtp quality-monitoring threshold lq-mos

Use the ip rtp quality-monitoring threshold lq-mos command to specify threshold values for logging
listening quality (LQ) mean opinion score (MOS) events during Realtime Transport Protocol (RTP)
quality monitoring. Calls with lower quality than the specified thresholds will be logged as the defined
type (info, notice, warning, or error). Use the no form of this command to return to the default setting.
ip rtp quality-monitoring threshold lq-mos error

ip rtp quality-monitoring threshold lq-mos error <value>
ip rtp quality-monitoring threshold lq-mos info
ip rtp quality-monitoring threshold lq-mos info <value>
ip rtp quality-monitoring threshold lq-mos notice
ip rtp quality-monitoring threshold lq-mos notice <value>
ip rtp quality-monitoring threshold lq-mos warning
ip rtp quality-monitoring threshold lq-mos warning <value>
Syntax Description
error <value> Specifies the threshold for LQ MOS error messages to be logged. The
range is 0 to 4.4.
info <value> Specifies the threshold for LQ MOS information messages to be logged.
The range is 0 to 4.4.
notice <value> Specifies the threshold for LQ MOS notice messages to be logged. The
range is 0 to 4.4.
warning <value> Specifies the threshold for LQ MOS warning messages to be logged. The
range is 0 to 4.4.
Default Values
By default, the LQ MOS thresholds are info 4.40, notice 4.00, warning 3.60, error 2.60.
Command History
Usage Examples
The following example enables RTP quality monitoring LQ MOS info messages to be logged if MOS
statistics occur below 4.25:
(config)#ip rtp quality-monitoring threshold lq-mos info 4.25

ip rtp quality-monitoring threshold pq-mos

Use the ip rtp quality-monitoring threshold pq-mos command to specify threshold values for logging
listening quality (LQ) mean opinion score (MOS) normalized to the PESQ (PQ) scale events during
Realtime Transport Protocol (RTP) quality monitoring. Calls with lower quality than the specified
thresholds will be logged as the defined type (info, notice, warning, or error). Use the no form of this
ip rtp quality-monitoring threshold pq-mos error

ip rtp quality-monitoring threshold pq-mos error <value>
ip rtp quality-monitoring threshold pq-mos info
ip rtp quality-monitoring threshold pq-mos info <value>
ip rtp quality-monitoring threshold pq-mos notice
ip rtp quality-monitoring threshold pq-mos notice <value>
ip rtp quality-monitoring threshold pq-mos warning
ip rtp quality-monitoring threshold pq-mos warning <value>
Syntax Description
error <value> Specifies the threshold for listening quality PQ MOS error messages to be
logged. The range is 0 to 4.4.
info <value> Specifies the threshold for listening quality PQ MOS information messages
to be logged. The range is 0 to 4.4.
notice <value> Specifies the threshold for listening quality PQ MOS notice messages to be
logged. The range is 0 to 4.4.
warning <value> Specifies the threshold for listening quality PQ MOS warning messages to
be logged. The range is 0 to 4.4.
Default Values
By default, the PQ MOS thresholds are info 4.40, notice 4.00, warning 3.60, error 2.60.
Command History
Usage Examples
The following example enables RTP quality monitoring listening quality PQ MOS info messages to be
logged if the MOS occurs below 4.25:
(config)#ip rtp quality-monitoring threshold pq-mos info 4.25

ip rtp symmetric-filter
Use the ip rtp symmetric-filter command to enable filtering of received nonsymmetric Realtime
Transport Protocol (RTP) packets. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, the RTP symmetric filter is disabled.
Command History
Usage Examples
The following example enables ip rtp symmetric-filter:
(config)#ip rtp symmetric-filter

ip rtp udp <number>

Use the ip rtp udp command to configure a global starting User Datagram Protocol (UDP) port for
Realtime Transport Protocol (RTP). Use the no form of this command to remove a configured UDP port.
Syntax Description
<number> Specifies the value of the starting UDP port. Valid range is 1026 to 60000.
Default Values
The default value for this command is 10000.
Command History
Usage Examples
The following example configures 2000 as the starting value of the UDP port:
(config)#ip rtp udp 2000

ip scp server
Use the ip scp server command to enable the secure copy server functionality in AOS. Enabling the secure
copy server allows AOS to support the transfer of files using a secure connection. A secure connection
helps provide protection against outside forces gaining access to configuration files. An external secure
copy server is required to facilitate the transfers from the terminal. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
By default, the secure copy server is disabled.
Command History
Usage Examples
The following example enables the secure copy server function:
(config)#ip scp server

ip sdp grammar hold

Use the ip sdp grammar hold command to specify how to format hold messages in Session Description
Protocol (SDP) announcements. Use the no form of this command to return to the default value. Variations
of this command include the following:
ip sdp grammar hold rfc2543

ip sdp grammar hold rfc3264
Syntax Description
rfc2543 Specifies the use of RFC 2543 for formatting hold messages.
rfc3264 Specifies the use of RFC 3264 for formatting hold messages.
Default Values
By default, RFC 2543 is used for formatting hold messages.
Command History
Usage Examples
The following example specifies to use RFC 3264 to format hold messages:
(config)#ip sdp grammar hold rfc3264

ip sip
Use the ip sip command to enable the AOS Session Initiation Protocol (SIP) stack and to specify the
protocol and port used by the SIP stack. When the SIP stack is enabled, memory is allocated for SIP
functionality. Use the no form of this command to disable the SIP stack and free the memory allocated to
the stack. Variations of this command include:
ip sip
ip sip tcp
ip sip tcp <port>
ip sip udp
ip sip udp <port>
Syntax Description
tcp Optional. Specifies that the SIP stack operates using Transmission Control
Protocol (TCP).
udp Optional. Specifies that the SIP stack operates using User Datagram
Protocol (UDP).
<port> Optional. Specifies the TCP or UDP port used by the SIP stack. Range is 1
to 65535.
Default Values
By default, the SIP stack is enabled on AOS voice products and disabled on AOS data products. The SIP
stack operates using UDP on port 5060 if no protocol or port are specified. If a protocol is specified, but no
port is specified, the SIP stack uses port 5060.
Command History
Release 15.1 Command was expanded to include the tcp, udp, and <port> parameters.
Functional Notes
By default, the AOS SIP application layer gateway (ALG) is enabled. This ALG allows the firewall to
examine all SIP packets it identifies and to maintain information of SIP transmissions on the network based
on the SIP header. The SIP ALG requires the use of the SIP stack and the SIP proxy server in order to
properly route SIP calls and maintain the SIP information. For more details on the operation of SIP and the
SIP ALG, refer to the command ip firewall alg on page 842.
For proper SIP operation, the firewall must also be configured to allow for dynamic holes for the Realtime
Transfer Protocol (RTP) and the Realtime Transfer Control Protocol (RTCP) traffic associated with SIP
calls between user agents. This functionality must be manually enabled. For more details on enabling this
functionality, refer to the command ip rtp firewall-traversal on page 919.
The SIP stack is used for many AOS features, including Transparent Proxy and Voice Quality Monitoring
(VQM) Reporting. Refer to the configuration guides available online at http://kb.adtran.com for more
information about SIP operation with specific features.

Usage Examples
The following example enables the SIP stack and specifies that the stack operates using TCP:
(config)#ip sip tcp

ip sip access-class <name> in

Use the ip sip access-class in command to limit the traffic allowed to reach the Session Initiation Protocol
(SIP) stack by applying access control lists (ACLs) to incoming connections. Use the no form of this
command to disable this feature.
Syntax Description
<name> Specifies the name of a previously configured ACL to apply to incoming
traffic.
Default Values
By default, no ACL is configured or applied, and all traffic reaches the SIP stack.
Command History
Functional Notes
The ip sip access-class in command can be entered multiple times to apply multiple ACLs to incoming
traffic to the SIP stack.
For more information regarding ACL configuration, refer to the Access Control List Command Set on page
2411.
Usage Examples
The following example specifies an IP SIP ACL name of HSV:
(config)#ip sip access-class HSV in

ip sip authenticate
Use the ip sip authenticate command to enable the Session Initiation Protocol (SIP) server authentication.
Use the no form of this command to disable the feature.
Syntax Description
No subcommands.
Default Values
By default, the SIP server authentication is disabled.
Command History
Usage Examples
The following example enables the SIP server authentication:
(config)#ip sip authenticate

ip sip database local

Use the ip sip database local command to store the location database of Session Initiation Protocol (SIP)
user agents (UAs) across a power loss using memory on the local router. Use the no form of this command
to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example specifies storing the location database on the local router:
(config)#ip sip database local

ip sip default-call-routing
Use the ip sip default-call-routing command to specify the method used to route a call in the internal
transaction distribution unit (TDU) when the destination of a call is ambiguous. Use the no form of this
ip sip default-call-routing proxy

ip sip default-call-routing reject
ip sip default-call-routing switchboard
Syntax Description
proxy Specifies that the call is routed to a proxy server.
reject Specifies that the call is rejected.
switchboard Specifies that the call is routed to an internal switchboard.
Default Values
By default, the call routing method is proxy.
Command History
Functional Notes
The ip sip default-call-routing command is applicable to AOS voice products only. This command is not
available on AOS data products.
Usage Examples
The following example specifies that calls are routed to an internal switchboard:
(config)#ip sip default-call-routing switchboard

ip sip grammar alert-info url <url>

Use the ip sip grammar alert-info url command to specify the Alert-Info header host in outbound Session
Initiation Protocol (SIP) messages. Use the no form of this command to return to the default setting.
Syntax Description
<url> Specifies an Hypertext Transfer Protocol (HTTP) uniform resource locator (URL)
to be used in the Alert-Info header for IP phone tone.
Default Values
By default, the local loopback address is the host in the Alert-Info header (127.0.0.1).
Command History
Usage Examples
The following example sets the Alert-Info header to use a specific URL as shown in the sample header
below:
(config)#ip sip grammar alert-info url www.notused.com
Sample header:
Alert-Info:<http://www.notused.com>;info=alert-internal

ip sip grammar
Use the ip sip grammar command to populate privacy lists, indicating how caller ID is handled. Use the
ip sip grammar default-privacy critical

ip sip grammar default-privacy header
ip sip grammar default-privacy none
ip sip grammar default-privacy session
ip sip grammar default-privacy user
ip sip grammar restricted-privacy critical
ip sip grammar restricted-privacy header
ip sip grammar restricted-privacy none
ip sip grammar restricted-privacy session
ip sip grammar restricted-privacy user
Syntax Description
default-privacy Specifies entries into the default-privacy list for unrestricted caller ID calls.
restricted-privacy Specifies entries into the restricted-privacy list for restricted caller ID calls.
critical Adds critical to the Privacy header format. At least one other entry must be
added to the list when using this setting.
header Adds header to the Privacy header format.
none Adds none to the Privacy header format. No other entries can be added to
the list when using this setting.
session Adds session to the Privacy header format.
user Adds user to the Privacy header format.
Default Values
By default, both privacy lists are empty.
Command History
Usage Examples
The following example sets all calls to have session privacy:
(config)#ip sip grammar default-privacy session

ip sip grammar from

Use the ip sip grammar from command to configure the From header on Session Initiation Protocol (SIP)
messages. Use the no form of this command to return to the default setting. Variations of this command
include:
ip sip grammar from host domain

ip sip grammar from host local
ip sip grammar from host sip-server
ip sip grammar from user domestic
ip sip grammar from user domestic <Txx>
ip sip grammar from user international
ip sip grammar from user international <Txx>
Syntax Description
host Specifies the Host field formatting.
user Specifies the User field formatting.
domain Specifies the Domain for formatting the header.
local Specifies the Local IP for formatting the header.
sip-server Specifies the SIP server for formatting the header.
domestic Sends the number as specified by the calling party.
international Sends the number with E.164 formatting.
<Txx> Optional. Indicates a two-digit trunk identifier (i.e., T01).
Default Values
By default, the host for formatting messages is sip-server. Also, the default for the user format is
domestic.
Command History
Release 13.1 Command was expanded to include the domestic and international formats
for the From User header.
Functional Notes
Omitting the trunk option when issuing the ip sip grammar from user command specifies the User header
globally.
Usage Examples
The following example sets the From header format to use a local IP:
(config)#ip sip grammar from host local

The following example sets the From header format to use calling party format on trunk T02:
(config)#ip sip grammar from user domestic T02
Technology Review
This technology review provides information about the E.164 recommendation for International numbering
plans and telephone number formats.
A fully specified telephone number can have a maximum of 15 digits, including country code, area code,
and the subscriber’s number. These numbers usually consist of a + prefix. E.164 numbers exclude dialing
prefixes. The most familiar prefixes are international direct dialing (IDD) and national direct dialing (NDD).
In countries other than the USA, the IDD and NDD are represented by different numbers.
Additionally, E.123 describes the use of + to indicate a fully specified international number. The + is used in
SIP headers to provide consistency across national and international phone calls.
AOS products provide support for E.164 by being able to specify a country code and an IDD prefix.
National format telephone numbers are converted to international format by prefixing them with + and the
country code. On outbound international calls, + is substituted for the IDD. On incoming international calls,
the + is removed. If the country code matches the configured value, it too is removed.
Setting the From header to international will cause phone numbers to be formatted as
indicated by E.164. The country code must be configured, and the number must be of type
national for this feature to work successfully.

ip sip grammar p-asserted-identity host

Use the ip sip grammar p-asserted-identity host command to enable and format the private extensions to
Session Initiation Protocol (SIP) for asserted identity within trusted networks. Use the no form of this
ip sip grammar p-asserted-identity host domain

ip sip grammar p-asserted-identity host local
ip sip grammar p-asserted-identity host sip-server
Syntax Description
domain Specifies the domain host for formatting the header.
local Specifies the local IP as host for formatting the header.
sip-server Specifies the SIP server as host for formatting the header.
Default Values
By default, the host for formatting messages is sip-server.
Command History
Usage Examples
The following example sets the p-asserted-identity to use a local IP:
(config)#ip sip grammar p-asserted-identity host local

ip sip grammar proxy-require privacy

Use the ip sip grammar proxy-require privacy command to add a proxy-require header to Session
Initiation Protocol (SIP) message packets containing a privacy header. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
By default, this feature is disabled.
Command History
Usage Examples
The following example allows a proxy-require header to be added to packets containing a privacy header:
(config)#ip sip grammar proxy-require privacy

ip sip grammar request-uri

Use the ip sip grammar request-uri command to format the Request uniform resource identifier (URI)
for IP Session Initiation Protocol (SIP) messages. Use the no form of this command to return to the default
ip sip grammar request-uri host domain

ip sip grammar request-uri host sip-server
ip sip grammar request-uri host-resolve
Syntax Description
host domain Specifies the domain for formatting the header.
host sip-server Specifies the SIP server IP for formatting the header.
host-resolve Enables the local unit to resolve the domain before resolving the request
URI.
Default Values
By default, the host for formatting messages is the SIP server. Also by default, host-resolve is disabled.
Command History
Usage Examples
The following example enables IP SIP messages to resolve the request URI from the host domain:
(config)#ip sip grammar request-uri host domain
The following example enables IP SIP messages to resolve the request URI from the local unit:
(config)#ip sip grammar request-uri host-resolve

ip sip grammar require 100rel

Use the ip sip grammar require 100rel command to add 100rel to the Require header of a Session
Initiation Protocol (SIP) provisional response. Use the no form of this command to return to the default
setting.
Syntax Description
No subcommands.
Default Values
By default, ip sip grammar require 100rel is disabled.
Command History
Functional Notes
This command enables or disables the sending of reliable provisional responses to clients that support
100rel. Reliable provisional responses will always be sent to clients that require 100rel even with ip sip
grammar require 100rel disabled.
Usage Examples
The following example enables ip sip grammar require 100rel:
(config)#ip sip grammar require 100rel
Technology Review
There are two Require headers that may use the 100rel tag, one in the initial request, and one in the
provisional response.
The user agent client (UAC) is used to initiate SIP requests. When the UAC creates a new request, it can
require reliable provisional responses for that request by adding the option tag 100rel to the Require
header of that request.
The user agent server (UAS) contacts the user when SIP requests are received, and returns responses on
behalf of the user, using provisional responses for request progress information. Provisional responses
(100 to 199) are transmitted on a best-effort basis. By using reliable provisional responses, responses are
sent by the UAS until they are acknowledged as received. This is especially beneficial when sending
provisional responses over an unreliable transport, such as User Datagram Protocol (UDP).
The UAS must send any non-100 provisional responses reliably if the initial request contained a Require
header field with the option tag 100rel. If the UAS is unwilling to do so, it must reject the initial request with
a Bad Extension message and include an Unsupported header field containing the option tag 100rel. If the
client supports 100rel, the UAS has the option of sending provisional responses with or without the
Require 100rel tag as instructed by the ip sip grammar require 100rel command.

ip sip grammar supported 100rel

Use the ip sip grammar supported 100rel command to include 100rel in the supported header of the
Session Initiation Protocol (SIP) message. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, ip sip grammar supported 100rel is disabled.
Command History
Usage Examples
The following example enables ip sip grammar supported 100rel:
(config)#ip sip grammar supported 100rel

ip sip grammar to host

Use the ip sip grammar to host command to format the host format of the To header of a Session
Initiation Protocol (SIP) message. Use the no form of this command to return to the default setting.
ip sip grammar to host domain

ip sip grammar to host sip-server
Syntax Description
domain Specifies the domain for formatting the header.
sip-server Specifies the SIP server for formatting the header.
Default Values
By default, the host for formatting messages is the SIP server.
Command History
Usage Examples
The following example sets the To header format to use a domain host:
(config)#ip sip grammar to host domain

ip sip grammar user-agent

Use the ip sip grammar user-agent command to configure the user agent (UA) header format in Session
Initiation Protocol (SIP) messages. The UA header can be given the default value for the product, a
user-defined value, or no value at all, in which case the UA header is not sent in SIP messages. Use the no
form of this command to return to the default of the product. Variations of this command include the
following:
ip sip grammar user-agent <word>

ip sip grammar user-agent default
ip sip grammar user-agent none
Syntax Description
<word> Specifies a word as a user-defined value to replace the default UA value.
Maximum 128 letters.
default Returns the UA header field value to the default value.
none Disables the UA header field resulting in no UA header sent in SIP
messages.
Default Values
By default, the UA value is set to the default value of the product.
Command History
Usage Examples
The following example removes the UA header field from SIP messages:
(config)#ip sip grammar user-agent none

ip sip inbound-trunk-matching
Use the ip sip inbound-trunk-matching command to enable and configure inbound trunk matching. Use
the no form of this command to return to the default settings. Variations of this command include:
ip sip inbound-trunk-matching default-trunk <Txx>

ip sip inbound-trunk-matching require-registration
Syntax Description
default-trunk <Txx> Specifies a trunk to use when matching fails. The trunk is specified in the format
Txx (e.g., T01).
require-registration Indicates that the request URI user is required to be registered on a trunk.
Default Values
By default, there is no default trunk set and the require-registration option is disabled.
Command History
Usage Examples
The following example configures AOS to require registration for inbound trunk matching:
(config)#ip sip inbound-trunk-matching require-registration

ip sip location
Use the ip sip location command to manually add a Session Initiation Protocol (SIP) user agent (UA) to
the location database. Use the no form of this command to disable this feature. Variations of this command
include:
ip sip location <username> <ip address>

ip sip location <username> <ip address> <port>
ip sip location <username> <ip address> <port> tcp
ip sip location <username> <ip address> <port> tcp <number>
ip sip location <username> <ip address> <port> udp
ip sip location <username> <ip address> <port> udp <number>
Syntax Description
<username> Specifies the user name for the UA being added to the location database.
<ip address> Specifies the IP address for the UA being added to the location database.
10.10.10.1).
<port> Optional. Specifies the port of the UA to add to the database. If no port is
specified, default port is 5060.
tcp Optional. Specifies the use of Transmission Control Protocol (TCP) for
session communication.
udp Optional. Specifies the use of User Datagram Protocol (UDP) for session
communication.
<number> Optional. Specifies the time in seconds that a user is stored in the database.
Range from 0 to 36000. If no time is specified, default time is zero seconds.
Default Values
Command History
Release 15.1 Command was expanded to include a choice of transport protocols and
expiration time.
Usage Examples
The following example specifies an IP SIP location of 192.33.5.99 for a user named 2001:
(config)#ip sip location 2001 192.33.5.99

ip sip privacy
Use the ip sip privacy command to specify outbound calls to include privacy headers (when configured)
and inbound calls to be filtered on privacy settings. Use the no form of this command to return to the
default setting.
Syntax Description
No subcommands.
Default Values
By default, IP Session Initiation Protocol (SIP) privacy is disabled.
Command History
Usage Examples
The following example enables IP SIP privacy:
(config)#ip sip privacy

ip sip proxy
Use the ip sip proxy command to enable Stateful and Outbound modes of Session Initiation Protocol (SIP)
proxy operation at the global level. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Although the ip sip proxy command enables Stateful and Outbound modes of SIP proxy operation, it is
also necessary to use this command in conjunction with the ip sip proxy transparent command for
transparent proxy mode. For more information about transparent proxy, refer to the command ip sip proxy
transparent on page 976.
For more information about SIP proxy, refer to the NetVanta 7000 Series SIP Trunking configuration guide
available online at http://kb.adtran.com (article number 2508).
Usage Examples
The following example allows the SIP proxy server to operate in the Stateful and Outbound modes:
(config)#ip sip proxy

ip sip proxy allowed-servers <hostname | ip address>

Use the ip sip proxy allowed-servers command to specify a server to which devices behind the proxy are
allowed to send Session Initiation Protocol (SIP) traffic. Use the no form of this command to return to the
default setting.
Syntax Description
<hostname | ip address> Specifies the fully qualified domain name (FQDN) or IP address of the SIP
proxy server. IP addresses should be expressed in dotted decimal notation
(for example, 208.61.209.1).
Default Values
By default, SIP traffic to any server is allowed in Transparent and Outbound proxy modes. This means that
if no server is specified, traffic to any server is permitted, but if this command is entered, only traffic to the
configured servers is allowed.
Command History
Functional Notes
The ip sip proxy allowed-servers command can be entered multiple times to allow traffic to multiple
servers.
Usage Examples
The following example adds the server with an IP address of 10.200.1.9 as an allowed SIP proxy server:
(config)#ip sip proxy allowed-servers 10.200.1.9

ip sip proxy dial-string source

Use the ip sip proxy dial-string source command to specify the dial-string source for the Session
Initiation Protocol (SIP) proxy server. Use the no form of this command to return to the default setting.
ip sip proxy dial-string source request-uri

ip sip proxy dial-string source to
Syntax Description
request-uri Specifies the Request-URI user field as the dial-string source.
to Specifies the To header as the dial-string source.
Default Values
By default, the dial-string source is set to request-uri.
Command History
Usage Examples
The following example sets the To header as the dial-string source:
(config)#ip sip proxy dial-string source to

ip sip proxy domain <string>

Use the ip sip proxy domain command to specify a domain string for Session Initiation Protocol (SIP)
proxy messaging. Use the no form of this command to return to the default setting.
Syntax Description
<string> Specifies the domain string for SIP messaging.
Default Values
By default, ip sip proxy domain is not configured.
Command History
Usage Examples
The following example specifies Sample as the SIP proxy domain string:
(config)#ip sip proxy domain Sample

ip sip proxy emergency-call-routing

Use the ip sip proxy emergency-call-routing command to first specify the Session Initiation Protocol
(SIP) proxy method used to route a call during failover and to then specify the calls that are considered
emergency calls for SIP proxy emergency routing. Use the no form of this command to disable emergency
call routing and to remove the call routing templates. Variations of this command include:
ip sip proxy emergency-call-routing local

ip sip proxy emergency-call-routing proxy
ip sip proxy emergency call-routing accept <template>
ip sip proxy emergency-call-routing reject <template>
Syntax Description
local Specifies that all emergency calls are routed directly through the
switchboard.
proxy Specifies that all emergency calls are routed through the proxy before
sending them to the switchboard.
accept <template> Specifies that calls matching the template are accepted as emergency calls.
reject <template> Specifies that calls matching the template are rejected as emergency calls.
Default Values
By default, the SIP proxy is set to send all emergency calls directly through the switchboard (the local
parameter). By default, no emergency number templates or patterns are configured in the system;
therefore, no calls are classified as emergency calls.
Command History
Functional Notes
Before specifying which calls are defined as emergency calls, you should configure the method used for
routing emergency calls (using the ip sip proxy emergency-call-routing local or ip sip proxy
emergency-call-routing proxy commands). For the default emergency call routing method (local) to
function on AOS data products, a local SIP gateway must be configured using the command ip sip proxy
local-gateway <hostname | ip address> on page 972. On AOS voice products, the local SIP gateway is
enabled by default.
After the emergency call routing method has been specified, emergency calls must be defined for
emergency call routing to perform any action. Emergency call definitions are configured using the ip sip
proxy emergency-call routing accept <template> and ip sip proxy emergency-call-routing reject
<template> commands.

Valid characters for accept and reject templates are as follows:
0-9 = Match exact digit only.

M = Any digit 1 to 8.
X = Any single digit (0 to 9).
N = Any digit 2 to 9.
[123] = Any digit contained in the bracketed list.
Do not use dashes, commas, spaces, etc., inside the brackets. Commas are implied
between numbers in the brackets.
The special characters ( ), -, and + are always ignored in the template. The following are example template
entries using wildcards:
1) 555-81XX matches 555-8100 to 555-8199.

2) 555-812[012] matches 555-8120 to 555-8122.
3) NXX-XXXX matches 7 digit local.
4) 1-NXX-NXX-XXXX matches long distance calls in North America.
Usage Examples
The following example enables SIP proxy emergency call routing on an AOS voice product and specifies
the routing method as proxy:
(config)#ip sip proxy emergency-call-routing proxy
The following example specifies a local SIP gateway and enables SIP proxy emergency call routing on an
AOS data product:
(config)#ip sip proxy local-gateway 10.19.209.55

(config)#ip sip proxy emergency-call-routing local
The following example specifies that 911 calls are accepted as emergency calls on an AOS voice product:
(config)#ip sip proxy emergency-call-routing proxy

(config)#ip sip proxy emergency-call-routing accept 911
The following example specifies that 911 calls are accepted as emergency calls on an AOS data product:
(config)#ip sip proxy local-gateway 10.19.209.55

(config)#ip sip proxy emergency-call-routing local
(config)#ip sip proxy emergency-call-routing accept 911

ip sip proxy failover accept-registrations

Use the ip sip proxy failover accept-registrations command to configure the Session Initiation Protocol
(SIP) proxy server to accept new registrations when the system is in survivability (failover) mode. Use the
no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the server to accept registration during failover conditions:
(config)#ip sip proxy failover accept-registrations

ip sip proxy failover codec-group <name>

Use the ip sip proxy failover codec-group command to specify the Session Initiation Protocol (SIP)
proxy server’s coder-decoder (CODEC) when the system is in failover mode. Use the no form of this
command to return to the default setting.
Syntax Description
<name> Specifies the name of a previously created CODEC list to be used during
failover.
Default Values
By default, no CODEC list is configured or applied.
Command History
Functional Notes
The ip sip proxy failover codec-group command is available on AOS voice products only. This
command is not available on AOS data products. For more information regarding CODEC list
configuration, refer to the Voice CODEC List Command Set on page 2955.
For more information regarding SIP proxy configuration, refer to the Transparent Proxy configuration guide
available online at http://kb.adtran.com (article number 2183).
Usage Examples
The following example enables the CODEC list named List1 during failover:
(config)#ip sip proxy failover codec-group List1

ip sip proxy failover dial-string source

Use the ip sip proxy failover dial-string source command to specify the dial-string source for the Session
Initiation Protocol (SIP) proxy server when the system is in survivability (failover) mode. Use the no form
ip sip proxy failover dial-string source request-uri

ip sip proxy failover dial-string source to
Syntax Description
request-uri Specifies the Request-URI user field as the dial-string source.
to Specifies the To header as the dial-string source.
Default Values
By default, the dial-string source is request-uri.
Command History
Usage Examples
The following example specifies using the To header for the dial-string source:
(config)#ip sip proxy failover dial-string source to

ip sip proxy failover match-digits <value>

Use the ip sip proxy failover match-digits command to specify the number of least-significant digits of
the dial string to match in order to route a surviving call to proxy users during when in failover mode. Use
Syntax Description
<value> Specifies the number of digits within a template to match during failover.
The valid range is 1 to 255.
Default Values
By default, the number of match-digits is not specified.
Command History
Functional Notes
The ip sip proxy failover match-digits command can be entered multiple times.
Session Initiation Protocol (SIP) proxy failover occurs using an automatically created trunk contained in
AOS’s basic configuration. This trunk is a hidden SIP trunk with the same default settings as a regular SIP
trunk. For more information about configuring SIP proxy failover, refer to the Transparent Proxy
configuration guide available online at http://kb.adtran.com (article number 2183).
Usage Examples
The following example sets the ip sip proxy failover match-digits to 7:
(config)#ip sip proxy failover match-digits 7

ip sip proxy failover sip-keep-alive

Use the ip sip proxy failover sip-keep-alive command to configure the Session Initiation Protocol (SIP)
proxy server keep-alive method when the system is in survivability (failover) mode. Keep-alive messages
must be sent between the SIP device and the registrar to keep the connected channel open for
communication. Use the no form of this command to return to the default setting. Variations of this
ip sip proxy failover sip-keep-alive info

ip sip proxy failover sip-keep-alive info <value>
ip sip proxy failover sip-keep-alive options
ip sip proxy failover sip-keep-alive options <value>
Syntax Description
<value> Specifies the amount of time in seconds between keep-alive messages sent
during a call. The range is 30 to 3600 seconds.
info Specifies using the INFO keep-alive method on this trunk.
options Specifies using the OPTIONS keep-alive method on this trunk.
Default Values
By default, this command is not configured.
Command History
Usage Examples
The following example enables the INFO method to be used as the SIP keep-alive method with the timeout
between messages set to 3 minutes:
(config)#ip sip proxy failover sip-keep-alive info 180

ip sip proxy failover trust-domain

Use the ip sip proxy failover trust-domain command to enable the AOS unit to use P-Asserted Identity
Session Initiation Protocol (SIP) privacy when communicating with the softswitch when in failover mode.
Use the no form of this command to disable this feature. Variations of this command include:
ip sip proxy failover trust-domain

ip sip proxy failover trust-domain p-asserted-identity-required
Syntax Description
p-asserted-identity-required Specifies that P-Asserted-Identity is required for this domain.
Default Values
Command History
Functional Notes
The ip sip proxy failover trust-domain command allows the AOS unit to look at any P-Asserted-Identity
header the phones might send while the AOS device is in failover mode. The
p-asserted-identity-required parameter is only used with nonstandard softswitches and should not be
used in normal configurations.
Usage Examples
The following example specifies that P-Asserted-Identity is enabled:
(config)#ip sip proxy failover trust-domain

ip sip proxy grammar

Use the ip sip proxy grammar command to specify the Session Initiation Protocol (SIP) proxy grammar
options. Use the no form of this command to return to the default setting. Variations of this command
include:
ip sip proxy grammar expires param-conversion

ip sip proxy grammar non-invite domain-undo
ip sip proxy grammar from host domain
ip sip proxy grammar from host sip-server
ip sip proxy grammar request-uri host domain
ip sip proxy grammar request-uri host sip-server
ip sip proxy grammar to host domain
ip sip proxy grammar to host sip-server
Syntax Description
expires param-conversion Enables conversion of Expires parameters to Expires headers.
non-invite domain-undo Enables translation of domain address to proxy address for inbound stateful
requests.
from Configures grammar for the From header.
request-uri Configures grammar for the Request URI header.
to Configures grammar for the To header.
host Configures the host portion of the specified header.
domain Specifies using the configured domain string in the specified header.
sip-server Specifies using the resolved SIP server address in the specified header.
Default Values
By default, ip sip proxy grammar for all option headers is sip-server.
Command History
Release 17.3 Command was expanded to include the Expires header option.
Release A2 Command was expanded to include the Non-Invite header option.
Usage Examples
The following example configures the To header using the configured SIP proxy domain string:
(config)#ip sip proxy grammar to host domain

ip sip proxy local-gateway <hostname | ip address>

Use the ip sip proxy local-gateway command to configure the local Session Initiation Protocol (SIP)
gateway. Use the no form of this command to disable this feature. Variations of this command include:
ip sip proxy local-gateway <hostname | ip address>

ip sip proxy local-gateway <hostname | ip address> tcp
ip sip proxy local-gateway <hostname | ip address> tcp <port>
ip sip proxy local-gateway <hostname | ip address> udp
ip sip proxy local-gateway <hostname | ip address> udp <port>
Syntax Description
<hostname | ip address> Specifies the host name or IP address of the local SIP proxy gateway. IP
10.10.10.1).
tcp Optional. Configures the gateway to use Transmission Control Protocol
(TCP).
udp Optional. Configures the gateway to use User Datagram Protocol (UDP).
<port> Optional. Specifies the TCP or UDP port used by the gateway. Range is 1 to
65535.
Default Values
By default, the ip sip proxy local-gateway is not configured. When configured, the default protocol is udp
on port 5060. If a particular protocol is configured and no port is specified, the default port is set to 5060.
Command History
Functional Notes
The ip sip proxy local-gateway command enables the necessary local SIP gateway in AOS data
products. This gateway is necessary for routing emergency calls when using SIP proxy. On AOS voice
products, the local gateway is enabled by default.
Usage Examples
The following example sets the local gateway:
(config)#ip sip proxy local-gateway serviceprovider@network.com

ip sip proxy routing contact-comparison strict

Use the ip sip proxy routing contact-comparison strict command to configure the Session Initiation
Protocol (SIP) proxy server to make strict comparisons between Contact headers. Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example modifies the Contact comparison settings to make strict comparisons of Contact
headers during routing:
(config)#ip sip proxy routing contact-comparison strict

ip sip proxy sip-server primary

Use the ip sip proxy sip-server primary command to configure the primary Session Initiation Protocol
(SIP) server softswitch. Use the no form of this command to disable the softswitch. The softswitch cannot
be disabled unless all configured secondary softswitches are removed (refer to the command ip sip proxy
sip-server secondary on page 975). Variations of this command include:
ip sip proxy sip-server primary <hostname | ip address>

ip sip proxy sip-server primary <hostname | ip address> tcp
ip sip proxy sip-server primary <hostname | ip address> tcp <port>
ip sip proxy sip-server primary <hostname | ip address> udp
ip sip proxy sip-server primary <hostname | ip address> udp <port>
Syntax Description
<hostname | ip address> Specifies the fully qualified domain name (FQDN) or IP address of the
outbound SIP proxy server. IP addresses should be expressed in dotted
tcp Optional. Configures the softswitch to use Transmission Control Protocol
(TCP).
udp Optional. Configures the softswitch to use User Datagram Protocol (UDP).
<port> Optional. Specifies the TCP or UDP port used by the softswitch. Range is 1
to 65535.
Default Values
By default, no softswitches are configured. If a softswitch is configured, the default protocol is UDP on port
5060. If a particular protocol is configured and no port is specified, the default port is set to 5060.
Command History
Functional Notes
The guidelines for configuring the softswitch(es) depend on the mode of operation selected. Softswitch
configuration is always needed for Stateful mode. It is only needed for Outbound mode and Transparent
mode when the SIP Request does not contain any fields that can be resolved to the softswitch’s location.
If a host name is used to specify the outbound SIP proxy server, a domain naming system (DNS) server
must be configured on the AOS unit using the command ip name-server on page 898 or learned via a
dynamic IP interface.
Usage Examples
The following example sets the primary softswitch:
(config)#ip sip proxy sip-server primary 208.61.209.1

ip sip proxy sip-server secondary

Use the ip sip proxy sip-server secondary command to configure the secondary Session Initiation
Protocol (SIP) softswitch. This command can be entered multiple times to specify numerous secondary
softswitches. Use the no form of this command to disable this feature. Variations of this command include:
ip sip proxy sip-server secondary <hostname | ip address>

ip sip proxy sip-server secondary <hostname | ip address> tcp
ip sip proxy sip-server secondary <hostname | ip address> tcp <port>
ip sip proxy sip-server secondary <hostname | ip address> udp
ip sip proxy sip-server secondary <hostname | ip address> udp <port>
Syntax Description
<hostname | ip address> Specifies the fully qualified domain name (FQDN) or IP address of the
outbound SIP proxy server. IP addresses should be expressed in dotted
tcp Optional. Configures the softswitch to use Transmission Control Protocol
(TCP).
udp Optional. Configures the softswitch to use User Datagram Protocol (UDP).
<port> Optional. Specifies the TCP or UDP port used by the softswitch. Range is 1
to 65535.
Default Values
By default, no softswitches are configured. If a softswitch is configured, the default protocol is UDP on port
5060. If a particular protocol is configured and no port is specified, the default port is set to 5060.
Command History
Functional Notes
The guidelines for configuring the softswitch(es) depend on the mode of operation selected. Softswitch
configuration is always needed for Stateful mode. It is only needed for Outbound mode and Transparent
mode when the SIP Request does not contain any fields that can be resolved to the softswitch’s location.
When disabling softswitches, all secondary softswitches must be removed before the primary softswitch
can be removed.
If a host name is used to specify the outbound SIP proxy server, a domain naming system (DNS) server
must be configured on the AOS unit using the command ip name-server on page 898 or learned via a
dynamic IP interface.
Usage Examples
The following example sets the secondary softswitch:
(config)#ip sip proxy sip-server secondary 208.61.209.2

ip sip proxy transparent

Use the ip sip proxy transparent command to enable Session Initiation Protocol (SIP) proxy operation in
the Transparent mode. Use the no form of this command to disable this feature. Variations of this
command include:
ip sip proxy transparent

ip sip proxy transparent nat-simulate
Syntax Description
nat-simulate Optional. Specifies the network address translation (NAT) simulation.
Default Values
Command History
Release A1 Command was expanded to include the NAT simulation.
Functional Notes
For an AOS product to use SIP proxy in transparent mode, SIP proxy must be enabled. To enable SIP
proxy, enter the ip sip proxy command before entering the ip sip proxy transparent command.
For an AOS data product to use SIP proxy in transparent mode, the firewall SIP application layer gateway
(ALG) must be disabled. For more information on disabling the firewall SIP ALG, refer to the command ip
firewall alg on page 842.
For more information on the operation and configuration of SIP proxy in transparent mode, refer to the
Transparent Proxy configuration guide available online at http://kb.adtran.com (article number 2183).
Usage Examples
The following example enables SIP proxy to operate in transparent mode on an AOS voice product:

(config)#ip sip proxy transparent
The following example enables SIP proxy to operate in transparent mode on an AOS data product:
(config)#no ip firewall alg sip

(config)#ip sip proxy transparent

ip sip qos dscp <value>

Use the ip sip qos dscp command to configure the differentiated services code point (DSCP) value to mark
IP Session Initiation Protocol (SIP) packets with. This marking can then be used by the quality of service
(QoS) mechanisms to give priority for this type of traffic in the unit. Use the no form of this command to
Syntax Description
<value> Specifies the DSCP value. Valid range is 0 to 63.
Default Values
Command History
Usage Examples
The following example sets the DSCP value to 63:
(config)#ip sip qos dscp 63

ip sip registrar
Use the ip sip registrar command to configure the Session Initiation Protocol (SIP) registrar server used
for registering user agents (UAs) into the location database. For more details on SIP operation, refer to the
Technology Review section of the command ip firewall alg on page 842. Use the no form of the ip sip
registrar command to disable the registrar server. Variations of this command include:
ip sip registrar
ip sip registrar authenticate
ip sip registrar default-expires <value>
ip sip registrar max-expires <value>
ip sip registrar min-expires <value>
ip sip registrar realm <string>
Syntax Description
authenticate Specifies that authentication is required for each UA during registration.
default-expires <value> Specifies the default expiration period for the UA listing in the location
database. UAs requesting registration without specifying an expiration
period are given this default expiration period. Range is 0 to
2592000 seconds.
max-expires <value> Specifies the maximum expiration period for the UA listing in the location
database. All UAs registering with the SIP proxy server request an
expiration period for the listing in the database. UAs requesting an
expiration period between the max-expires and min-expires values are
honored. Range is 0 to 2592000 seconds.
min-expires <value> Specifies the minimum expiration period for the UA listing in the location
database. All UAs registering with the SIP proxy server request an
expiration period for the listing in the database. UAs requesting an
expiration period between the max-expires and min-expires values are
honored. Range is 0 to 2592000 seconds.
realm <string> Specifies a realm (using an ASCII character string) for the UA listing in the
location database.
Default Values
By default, the registrar server is disabled.
Command History

Usage Examples
The following example sets the default expiration to 5 seconds:
(config)#ip sip registrar default-expires 5
The following example sets the realm string:
(config)#ip sip registrar realm voice.adtran.com

ip sip timer
Use the ip sip timer command to configure the Session Initiation Protocol (SIP) internal T1 and T2 timers
(in milliseconds). Use the no form of this command to return to the default value. Variations of this
command include:
ip sip timer T1 <value>

ip sip timer T2 <value>
Syntax Description
T1 Specifies the T1 timer.
T2 Specifies the T2 timer.
<value> Specifies time in milliseconds. Range for T1 is 50 to 1000 milliseconds, and
for T2 is 1000 to 32000 milliseconds.
Default Values
By default, the T1 timer is set to 500 milliseconds, and the T2 timer is set to 4000 milliseconds.
Command History
Functional Notes
T1 is an estimate of network round trip time (RTT), and is used as the initial invite message retransmit
interval. Several SIP internal timers are derived from T1.
T2 is the maximum retransmit interval for non-invite requests and invite responses.
Usage Examples
The following example configures the T1 timer to 1000 milliseconds:
(config)#ip sip timer T1 1000

ip sip timer registration-failure-retry <value>

Use the ip sip timer registration-failure-retry command to configure the time (in seconds) that will
elapse before a Session Initiation Protocol (SIP) endpoint will retry registration with the SIP server after a
registration failure has occurred. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies time in seconds. Range is 10 to 604800 seconds.
Default Values
By default, the registration-failure-retry timer is set to 60 seconds.
Command History
Usage Examples
The following example allows a retry attempt to begin after 32 seconds:
(config)#ip sip timer registration-failure-retry 32

ip sip timer rollover <value>

Use the ip sip timer rollover command to specify the time period (in seconds) that the Session Initiation
Protocol (SIP) proxy is set to wait for a response to a request before attempting to find an alternate
destination. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the time period in seconds. Range is 1 to 32 seconds.
Default Values
By default, the rollover timer is set to 3 seconds.
Command History
Functional Notes
The ip sip timer rollover command sets the SIP timer B value for Invite transactions originating from a
SIP trunk. When originating a call, the SIP trunk attempts to send Invite messages to the primary SIP
server and waits for a response. If there is no response, the SIP trunk waits for 0.5 seconds before
attempting to send another Invite to the same SIP server. If no response, the SIP trunk waits for 1 second
before attempting to send another Invite, then waits 2 seconds, and so on. These increasing intervals are
shown in the diagram below.
Times are shown in seconds.
The rollover timer allows the user to control how long to wait before trying the next server. In the diagram
above, the red line indicates the rollover timer expiration. If there is no response after the timer expires, the
SIP trunk will attempt to send Invite messages to the highest priority backup SIP server obtained via DNS
service (SRV). The SIP trunk starts over at T=0 with the next server and doesn't send any more messages
to the timed out server. As long as the SIP trunk does not receive a response, it will continue this cycle until
it has attempted to contact all the SIP servers.

Usage Examples
The following example allows connection attempts to continue for up to 32 seconds before rolling over to
another destination:
(config)#ip sip timer rollover 32

ip sip transaction fast-terminate

Use the ip sip transaction fast-terminate command to configure fast termination of Session Initiation
Protocol (SIP) transactions. Use the no form of this command to disable fast termination.
Syntax Description
No subcommands.
Default Values
By default, fast termination of SIP transaction is disabled.
Command History
Usage Examples
The following example enables fast termination:
(config)#ip sip transaction fast-terminate

ip sip trunk-auth-name-source
Use the ip sip trunk-auth-name-source command to configure the authentication name source for the
Session Initiation Protocol (SIP) trunks. Use the no form of this command to return to the default setting.
ip sip trunk-auth-name-source account-id

ip sip trunk-auth-name-source message
Syntax Description
account-id Specifies using the corresponding account ID.
message Specifies using the To or From user when selecting the authentication name
and password.
Default Values
By default, the trunk authentication name source is message.
Command History
Usage Examples
The following example configures the trunk authentication name source to use the account ID:
(config)#ip sip trunk-auth-name-source account-id

ip snmp agent
Use the ip snmp agent command to enable the Simple Network Management Protocol (SNMP) agent. Use
Syntax Description
No subcommands.
Default Values
By default, the SNMP agent is disabled.
Command History
Functional Notes
Allows a MIB browser to access standard MIBs within the product. This also allows the product to send
traps to a trap management station.
Usage Examples
The following example enables the IP SNMP agent:
(config)#ip snmp agent

ip sntp server
Use the ip sntp server command to enable the Simple Network Time Protocol (SNTP) server. This allows
the unit to accept SNTP requests. Use the no form of this command to disable the server.
Syntax Description
No subcommands.
Default Values
By default, the SNTP server is disabled.
Command History
Usage Examples
The following example enables the SNTP server:
(config)#ip sntp server

ip sntp server send-unsynced

Use the ip sntp server send-unsynced command to enable sending the system clock time when requested,
even if the device is not synchronized with the Simple Network Time Protocol (SNTP) server. Use the no
form of this command to disable this setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the device to send the system clock time regardless of synchronized status
with the sntp server:
(config)#ip sntp server send-unsynced

ip sntp server source-interface <interface>

Use the ip sntp server source-interface command to specify a source interface for Simple Network Time
Protocol (SNTP) server traffic. The IP address of the specified interface will be used to source all SNTP
traffic. Use the no form of this command if you do not wish to override the default source IP address.
Syntax Description
<interface> Specifies the source interface for SNTP server traffic. Specify an interface in
wireless virtual access point, use dot11ap 1/1.1. Type ip sntp server
Default Values
By default, no SNTP server source interface is defined.
Command History
Release 16.1 Command was expanded to include the bridged virtual interface (BVI),
Frame Relay, high level data link control (HDLC), and Point-to-Point
Protocol (PPP) interfaces.
interface.
Functional Notes
Usage Examples
The following example configures the unit to use the loopback 1 interface as the source IP for SNTP
traffic:
(config)#ip sntp server source-interface loopback 1

ip sntp source-interface <interface>

Use the ip sntp source-interface command to specify a source interface for Simple Network Time
Protocol (SNTP) traffic originated by the unit. The IP address of the specified interface will be used to
source all SNTP traffic. Use the no form of this command if you do not wish to override the default source
IP address.
Syntax Description
<interface> Specifies the source interface for SNTP traffic. Specify an interface in the
wireless virtual access point, use dot11ap 1/1.1. Type ip sntp
Default Values
By default, no SNTP source interface is defined.
Command History
Release 16.1 Command was expanded to include the bridged virtual interface (BVI),
Frame Relay, high level data link control (HDLC), and Point-to-Point
Protocol (PPP) interfaces.
interface.
Functional Notes
Usage Examples
The following example configures the unit to use the loopback 1 interface as the source IP for SNTP
traffic:
(config)#ip sntp source-interface loopback 1

ip subnet-zero
The ip subnet-zero command is the default operation and cannot be disabled. This command signifies the
router’s ability to route to subnet-zero subnets.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example subnet-zero is enabled:
(config)#ip subnet-zero

ip tacacs source-interface <interface>

Use the ip tacacs source-interface command to specify a source interface for terminal access controller
access-control system plus (TACACS+) traffic originated by the unit. The IP address of the specified
interface will be used to source all TACACS+ traffic. Use the no form of this command if you do not wish
to override the default source IP address.
Syntax Description
<interface> Specifies the source interface for TACACS+ traffic. Specify an interface in
wireless virtual access point, use dot11ap 1/1.1. Type ip tacacs
Default Values
Command History
interface.
Functional Notes
Usage Examples
The following example configures the unit to use the loopback 1 interface as the source IP for TACACS+
traffic:
(config)#ip tacacs source-interface loopback 1

ip tftp server
Use the ip tftp server command to enable the Trivial File Transfer Protocol (TFTP) server. The
default-filesystem parameter specifies the default location for the TFTP server to retrieve and store files.
Use the no form of this command to disable the TFTP server. Variations of this command include:
ip tftp server
ip tftp server access-class <name> in
ip tftp server overwrite
ip tftp server default-filesystem cflash
ip tftp server default-filesystem flash
Syntax Description
access-class <name> in Controls access to the internal TFTP server using the specified access
control list (ACL).
overwrite Enables the TFTP server to overwrite existing files.
default-filesystem cflash Optional. Specifies that the TFTP server use CompactFlash® as the default
file system.
default-filesystem flash Optional. Specifies that the TFTP server use flash as the default file system.
Default Values
Command History
Release 13.1 Command was expanded to include the overwrite feature.
Release 17.3 Command was expanded to include the default-filesystem parameter.
Usage Examples
The following example enables the TFTP server:
(config)#ip tftp server
The following example allows self-bound TFTP incoming connections. In this example, classname is the
name of the access class:
(config)#ip tftp server access-class classname in
The following example specifies cflash file system as the default:
(config)#ip tftp server default-filesystem cflash

ip tftp source-interface <interface>

Use the ip tftp source-interface command to use the specified interface’s IP address as the source IP
address for Trivial File Transfer Protocol (TFTP) traffic transmitted by the unit. Use the no form of this
command if you do not wish to override the normal source IP address.
Syntax Description
<interface> Specifies the interface to be used as the source IP address for TFTP traffic.
dot11ap 1/1.1. Type ip tftp source-interface ? for a complete list of valid
interfaces.
Default Values
Command History
interface.
Functional Notes
Usage Examples
The following example configures the unit to use the loopback 1 interface as the source IP for TFTP
traffic:
(config)#ip tftp source-interface loopback 1

ip urlfilter <name> http

Use the ip urlfilter http command to create a uniform resource locator (URL) filter for Hypertext Transfer
Protocol (HTTP) (Transmission Control Protocol (TCP) port 80) traffic. Use the no form of this command
to delete the specified HTTP URL filter.
The URL filtering software runs on a server independent of the AOS product. For
additional information about the URL filtering technology, refer to the vendor’s website.
Syntax Description
<name> Specifies the URL filter name.
Default Values
By default, no URL filters are configured.
Command History
Functional Notes
The firewall must be enabled using the ip firewall command in order to use URL filters. The URL filter
must be applied to the appropriate interface by using the ip urlfilter <name> [in | out] command. Refer to
this command in the appropriate interface for more information.
Usage Examples
The following example creates the HTTP URL filter called MyFilter that can be applied to an interface for
content filtering:
(config)#ip urlfilter MyFilter http

ip urlfilter allowmode
Use the ip urlfilter allowmode command to allow all uniform resource locator (URL) requests in cases
when all URL filter servers are down. Use the no form of this command to block all URL requests when all
URL filter servers are down.
Syntax Description
No subcommands.
Default Values
By default, all URL requests will be blocked when all URL filter servers are down.
Command History
Usage Examples
The following example permits all URL requests even when URL filter servers are down:
(config)#ip urlfilter allowmode

ip urlfilter exclusive-domain
Use the ip urlfilter exclusive-domain command to instruct AOS to always allow or always block a
domain without first having to verify with the uniform resource locator (URL) filter server. Use the no
form of this command to remove an exclusive domain. Variations of this command include:
ip urlfilter exclusive-domain deny <name>

ip urlfilter exclusive-domain permit <name>
Syntax Description
deny <name> Specifies that the domain name be blocked without verifying with the URL
filter server.
permit <name> Specifies that the domain name be allowed without verifying with the URL
filter server.
Default Values
By default, no exclusive domains are configured.
Command History
Functional Notes
Domain matching is based on an exact match between the Hypertext Transfer Protocol (HTTP) header
and entries in the ip urlfilter exclusive-domain command. In order to exactly match requests destined for
a domain, entries should list all possible variations of the domain that would appear in the Host field of an
HTTP header. Refer to the Usage Examples section of this command for more detailed information.
Usage Examples
The following example will always allow access to www.adtran.com and adtran.com without first having
to verify the domain with the URL filter server:
(config)#ip urlfilter exclusive-domain permit www.adtran.com

(config)#ip urlfilter exclusive-domain permit adtran.com
The following example will always block access to www.localnews.com without first having to verify the
domain with the URL filter server:
(config)#ip urlfilter exclusive-domain deny www.localnews.com

ip urlfilter max-request <value>

Use the ip urlfilter max-request command to set the maximum number of outstanding uniform resource
locator (URL) lookup requests that can be sent to a URL filter server without a response. Use the no form
of this command to set the value back to its default setting.
Syntax Description
<value> The maximum number of outstanding URL lookup requests. Valid range
is 1 to 500 requests.
Default Values
By default, the number of outstanding requests is 500.
Command History
Functional Notes
After the maximum number of URL lookup requests is reached, the no ip urlfilter allowmode setting will
be used to allow or block all following requests until enough URL lookup responses have been received
from the URL filter server.
Usage Examples
The following example sets the maximum number of URL lookup requests to 250:
(config)#ip urlfilter max-request 250

ip urlfilter max-response <value>

Use the ip urlfilter max-response command to set the maximum number of responses allowed to buffer
before receiving an allow or block status from the uniform resource locator (URL) filter server. Use the no
form of this command to set the value back to its default setting.
Syntax Description
<value> Specifies the maximum number of responses allowed to buffer. Valid range
is 1 to 100 responses.
Default Values
By default, the value of buffered responses is 100.
Command History
Functional Notes
When a URL request comes through the unit and URL filtering is enabled, a lookup request is sent to the
URL filter server and the Hypertext Transfer Protocol (HTTP) request is forwarded to the HTTP server at
the same time. If the HTTP server responds before the URL filter server, the response must be buffered
until the URL filter server responds with allow or block. Once the maximum number of buffered HTTP
responses is reached, all following HTTP responses are dropped until some of the existing buffered
responses are released. Buffered responses are released when the URL filter server sends a response, or
when the firewall association times out.
Usage Examples
The following example sets the maximum number of buffered responses to 50:
(config)#ip urlfilter max-response 50

ip urlfilter server <ip address>

Use the ip urlfilter server command to identify a uniform resource locator (URL) filter server by IP
address and port number. Use the no form of this command to remove the server from use. Variations of
ip urlfilter server <ip address>

ip urlfilter server <ip address> port <number>
ip urlfilter server <ip address> timeout <value>
Syntax Description
<ip address> Specifies the server IP address. IP addresses should be expressed in
port <number> Specifies the server Transmission Control Protocol (TCP) port number that
will receive requests.
timeout <value> Specifies the number of seconds to wait for a response from the URL
filtering server before determining that it is out of service. Range is 1 to
300 seconds.
Default Values
By default, there are no URL filtering servers configured. When configuring a URL filtering server, the port
default is 15,868, and the timeout default is 5 seconds.
Command History
Usage Examples
The following example identifies a URL filtering server at IP address 10.1.1.1 that listens for URL filtering
requests on port 15,868 (default) and waits for a response for 10 seconds before determining that the
filtering server is down:
(config)#ip urlfilter server 10.1.1.1 timeout 10

ip urlfilter top-website
Use the ip urlfilter top-website command to enable reporting of the websites most frequently requested
on the system. Use the no form of this command to disable top websites reporting.
Enabling this feature may cause a performance degradation in Web browsing.
Syntax Description
No subcommands.
Default Values
By default, top websites reporting is disabled.
Command History
Usage Examples
The following example enables top websites reporting:
(config)#ip urlfilter top-website

ip vrf <name> route-distinguisher <number>

Use the ip vrf route-distinguisher command to create a nondefault VPN routing and forwarding (VRF)
instance and assign it a route distinguisher. Use the no ip vrf command to remove all VRF instances
configured on the system. Use the no ip vrf route-distinguisher command to destroy the VRF instance
and any commands configured on the VRF.
Syntax Description
<name> Specifies the name of the VRF instance. Valid range is up to 79
alphanumeric characters.
<number> Assigns a route-distinguisher to the VRF. This number can be represented
by either ASN:nn or IP-address:nn. ASN:nn consists of a 16-bit AS number
(ASN) and a 32-bit arbitrary number (nn). IP-address:nn consists of an IP
address and a 16-bit arbitrary number (nn). A route-distinguisher of all zeros
is reserved for the default VRF.
Default Values
Command History
Functional Notes
Once a nondefault VRF is created, it must be assigned to the appropriate interfaces. Use the vrf
forwarding <name> on page 1205 to assign interfaces to the VRF. By default, interfaces are assigned to
the default VRF. An interface can only be assigned to one VRF, but multiple interfaces can be assigned to
the same VRF.
Usage Examples
The following example creates the VRF Red and assigns the route distinguisher 2:2:
(config)#ip vrf RED route-distinguisher 2:2

isdn-group <number>
Use the isdn-group command to enter the ISDN Group Configuration mode command set. Use the no
form of this command to disable this feature. Refer to the section Voice ISDN Group Command Set on
page 2611 for more information on the commands available for each group.
Syntax Description
<number> Specifies the integrated services digital network (ISDN) group. Range is 1 to
255.
Default Values
Command History
Functional Notes
An ISDN group allows the user to specify the maximum and minimum number of B-channels that can be
used for a specific type of call. It is a logical group of B-channels from one or more ISDN interfaces. The
interfaces can be of different types (e.g., primary rate interface (PRI) and basic rate interface (BRI)). An
ISDN interface can be a member of multiple ISDN groups that makes it possible to share its B-channels
between different types of calls.
Usage Examples
The following example uses the isdn-group command to enter the ISDN Group Configuration mode for
ISDN group 1:
(config)#isdn-group 1

isdn-number-template
Use the isdn-number-template command to create an entry in the integrated services digital network
(ISDN) number type template that is used when encoding the called party and calling party information
elements for inbound and outbound ISDN calls. Use the no form of this command to delete the configured
entry. Variations of this command include the following:
isdn-number-template <template id> prefix <number> abbreviated <pattern>

isdn-number-template <template id> prefix <number> international <pattern>
isdn-number-template <template id> prefix <number> national <pattern>
isdn-number-template <template id> prefix <number> network-specific <pattern>
isdn-number-template <template id> prefix <number> subscriber <pattern>
isdn-number-template <template id> prefix <number> unknown <pattern>
Syntax Description
<template id> Specifies a numeric identifier for the template entry. Valid range is 1 to 255.
prefix <number> Specifies the expected prefix for the call type. Prefixes can be left blank
(using double quotation marks “ ”), or consist of unlimited length strings of
0s and 1s. For example, for international calls made from within the United
States, a prefix of 011 is expected.
abbreviated Specifies using Abbreviated (bits 110) in the Type of Number octet.
Abbreviated is used mainly in private ISDN network applications, and the
implementation is network dependent.
international Specifies using International (bits 001) in the Type of Number octet.
International is used for calls destined outside the national calling area.
International calls have the international direct dialing (IDD) prefix removed.
For example, consider an international call of 011-N$, where the IDD prefix
is 011 and the N$ represents the digits necessary for routing the call at the
destination. When the Called Party IE is created for this call, the prefix is
stripped and the N$ digits are placed in the Number Digits field.
national Specifies using National (bits 010) in the Type of Number octet. National is
used for calls destined for inside the national calling area (i.e., does not
cross into an international LATA). National calls have the direct dialing prefix
removed. For example, consider a national call with a direct dialing prefix of
1 and NXX-NXX-XXXX to represent the ten-digit number necessary for
routing the call. When the Called Party IE is created for this call, the prefix
(1) is stripped and the NXX-NXX-XXXX digits are placed in the Number
Digits field.

network-specific Specifies using Network-Specific (bits 011) in the Type of Number octet.
Network-Specific is used for calls that require special access to a private
network, which requires the use of a prefix that should be stripped once
access to the network has been gained. Network-Specific calls have the
dialing prefix removed. For example, a call to a private network with the 700
consists of 700-N$, where 700 is the dialing prefix and N$ represents the
digits necessary for routing the call at the destination. When the Called
Party IE is created for this call, the prefix is stripped and the N$ is placed in
the Number Digits field.
subscriber Specifies using Subscriber (bits 100) in the Type of Number octet.
Subscriber is used for local calls (not long-distance). Subscriber calls, by
default, have the area code removed. For example, a subscriber call to
916-555-1212 would have the prefix 916 stripped and 555-1212 in the
Number Digits field. For areas with mandatory ten-digit dialing, a blank
prefix should be entered to ensure that all ten digits are passed to the
Number Digits field.
unknown Specifies using Unknown (bits 000) in the Type of Number octet. Unknown
is used when the number type is not known. Unknown numbers are
assumed to have no prefix, and the entire dialed number is presented in the
Number Digits field.
<pattern> Specifies a pattern for this template.
Valid Characters:
0-9 Match exact digit only.
X Match any single digit 0 through 9.
N Match any single digit 2 through 9.
M Match any single digit 1 through 8.
[] Match any digit in the list. For example: [1,4,6] matches 1, 4, and 6
only. [1-3, 5] matches 1, 2, 3, and 5.
Default Values
The following default number template entry exists for domestic emergency calls (911):
isdn-number-template 0 prefix “ ” subscriber 911
Functional Notes
The following is an example number type template:
Prefix PatternType
“” NXX-XXXXSubscriber
“1” NXX-NXX-XXXXNational
“011” X$ International
“” N11 Subscriber (i.e., 411, 911, etc.)

Usage Examples
The following example creates a number template (labeled 1) and prefix (labeled 1) for national calls:
(config)#isdn-number-template 1 prefix 1 national Nxx-Nxx-xxxx

line
Use the line command to enter the line configuration for the specified console, Telnet, or secure shell
(SSH) session. Refer to the sections Line (Console) Interface Command Set on page 1207, Line (Telnet)
Interface Command Set on page 1235, and Line (SSH) Interface Command Set on page 1223 for
information on the subcommands. Variations of this command include:
line console <line number>

line ssh <line number>
line ssh <line number> <ending number>
line telnet <line number>
line telnet <line number> <ending number>
Syntax Description
console Enters the configuration mode for the DB-9 (female) CONSOLE port located on
the rear panel of the unit. Refer to the section Line (Console) Interface
Command Set on page 1207 for information on the subcommands found in
that command set.
telnet Enters the configuration mode for Telnet session(s), allowing you to configure
for remote access. Refer to the section Line (Telnet) Interface Command Set
on page 1235 for information on the subcommands found in that command
set.
ssh Enters the configuration mode for SSH. Refer to the section Line (SSH)
Interface Command Set on page 1223 for information on the subcommands
found in that command set.
<line number> Specifies the starting session to configure for remote access. Valid range for
console is 0. Valid range for Telnet and SSH is 0 to 4.
If configuring a single Telnet or SSH session, enter a single line number.
<ending number> Optional. Specifies the last Telnet or SSH session to configure for remote
access. Valid range is 0 to 4.
For example, to configure all available Telnet sessions, enter line telnet
0 4.
Default Values
By default, there are no configured Telnet or SSH sessions. By default, the AOS line console parameters
are configured as follows:
Data Rate: 9600

Data bits: 8
Stop bits: 1
Parity Bits: 0
No flow control
Command History

Release 11.1 Command was expanded to include the SSH.
Usage Examples
The following example begins the configuration for the CONSOLE port located on the rear of the unit:
(config-con0)#
The following example begins the configuration for all available Telnet sessions:
(config)#line telnet 0 4
(config-telnet0-4)#
The following example begins the configuration for all available SSH sessions:
(config)#line ssh 0 4
(config-ssh0-4)#

lldp
Use the lldp command to configure global settings that control the way Link Layer Discovery Protocol
(LLDP) functions. Use the no form of this command to return to the default setting. Variations of this
command include:
lldp med-fast-start-interval <value>

lldp minimum-transmit-interval <value>
lldp reinitialization-delay <value>
lldp transmit-interval <value>
lldp ttl-multiplier <value>
Syntax Description
med-fast-start-interval Specifies the fast start transmit interval (in seconds) that LLDP-Media
Endpoint Discovery (LLDP-MED) time length values (TLVs) are sent once
every second, allowing rapid automatic configuration of LLDP-MED capable
endpoints at startup. Range is 1 to 10 seconds. Default value is 4 seconds.
minimum-transmit-interval Defines the minimum amount of time between transmission of LLDP frames
in seconds. Range is 1 to 8192 seconds.
reinitialization-delay Defines the minimum amount of time to delay after LLDP is enabled on a
port before allowing transmission of additional LLDP frames on that port
in seconds. Range is 1 to 10 seconds.
transmit-interval Defines the delay between LLDP frame transmission attempts during
normal operation in seconds. Range is 5 to 32768 seconds.
ttl-multiplier Defines the time to live (TTL) multiplier to be applied to the transmit interval
to compute the time to live for data sent in an LLDP frame. Range is 2 to 10.
<value> Specifies the interval, delay, or multiplier.
Default Values
By default, med-fast-start-interval is 4 seconds; minimum-transmit-interval is 2 seconds;
reinitialization-delay is 2 seconds; transmit-interval is 30 seconds; and ttl-multiplier is 4.
Command History
Release 17.2 Command was expanded to include the med-fast-start-interval parameter.
Functional Notes
Once a device receives data from a neighboring device in an LLDP frame, it will retain that data for a
limited amount of time. This amount of time is called time to live, and it is part of the data in the LLDP
frame. The time to live transmitted in the LLDP frame is equal to the transmit interval multiplied by the TTL
multiplier.

Usage Examples
The following example sets the LLDP minimum transmit interval to 10 seconds:
(config)#lldp minimum-transmit-interval 10
The following example sets the LLDP reinitialization delay to 5 seconds:
(config)#lldp reinitialization-delay 5
The following example sets the LLDP transmit interval to 15 seconds:
(config)#lldp transmit-interval 15
The following example sets the LLDP transmit interval to 15 seconds and the TTL multiplier to 2 for all
LLDP frames transmitted from the unit. The resulting TTL is 30 seconds:
(config)#lldp transmit-interval 15
(config)#lldp ttl-multiplier 2

local <start ip address> <end ip address> global <start ip address>

<end ip address>
Use the local global command to define local and global network range of addresses for static 1:1 network
address translation (NAT) mapping. This command is entered from within the NAT pool’s configuration
command set by using the ip nat pool command. Refer to ip nat pool <name> on page 899 for more
information.
Syntax Description
<start ip address> Specifies the first IP address in the range.
<end ip address> Specifies the last IP address in the range.
10.10.10.1).
Default Values
Command History
Functional Notes
Static pools define a local network range of addresses whose size must be equal to the global range.
Source NAT will translate from the local range to the global range. Destination NAT will translate from the
global range to the local range. The addresses do not have to start at the same offset. If this command is
entered and the two ranges are not of the same size, an error message is displayed. The command will fail
and the pool will remain in its original state. If the pool was configured with an existing address range prior
to issuing the failed command, that range will remain unchanged. If no address range was present, the
pool will remain incomplete.
In some situations, an address needs to be excluded that falls within a range. For example, suppose you
are excluding 10.1.1.10 because it is the address used for many-to-one source NAT for other nonstatic
NAT hosts. This can be accomplished by creating multiple pools. This configuration requires multiple policy
class entries, but each can use the same access control list (ACL).
Usage Examples
The following example creates a static NAT pool named POOL1 and defines the local range from 10.1.1.1
to 10.1.1.12 and the global range as 192.168.1.1 to 192.168.1.12:

(config-natpool)#local 10.1.1.1 10.1.1.12 global 192.168.1.1 192.168.1.12

The following example creates two static NAT pools named POOL1 and POOL2. This example defines the
local range from 10.1.1.1 to 10.1.1.254 and the global range as 192.168.1.1 to 192.168.1.254 while
excluding the address 10.1.1.10:


logging console
Use the logging console command to enable AOS to log events to all consoles. Use the no form of this
command to disable console event logging.
Syntax Description
No subcommands.
Default Values
By default, logging console is disabled.
Command History
Usage Examples
The following example enables AOS to log events to all consoles:
(config)#logging console

logging email address-list <email address> ; <email address>

Use the logging email address-list command to specify one or more email addresses that will receive
notification when an event matching the criteria configured using the logging email priority-level
command is logged by AOS. Refer to logging email priority-level on page 1018 for more information. Use
the no form of this command to remove a listed address.
Syntax Description
<email address> Specifies the complete email address to use when sending logged
messages. (This field allows up to 256 characters.)
Enter as many email addresses as desired, placing a semi-colon (;)
between addresses.
Default Values
By default, there are no configured logging email addresses.
Command History
Usage Examples
The following example specifies three email addresses to use when sending logged messages:
(config)#logging email address-list

admin@adtranemail.com;ntwk@adtranemail.com;support@adtranemail.com

logging email exception-report address-list <email address> ;

<email address>
Use the logging email exception-report address-list command to specify one or more email addresses to
receive an exception report for use in troubleshooting. Use the no form of this command to remove a listed
address.
Syntax Description
<email address> Specifies the complete email address to use when sending exception
reports. (This field allows up to 256 characters.)
between addresses.
Default Values
By default, there are no configured logging email addresses.
Command History
Functional Notes
When AOS experiences an exception, it will generate a file with detailed information that ADTRAN’s
Technical Support can use to diagnose the problem. This command allows the unit to email the exception
report to a list of addresses upon rebooting after the exception. This command should be used in
conjunction with the other logging email commands. Refer to logging email address-list <email address> ;
<email address> on page 1014, logging email on on page 1017, logging email priority-level on page 1018,
logging email sender on page 1020, and logging email source-interface <interface> on page 1021 for more
information.
Usage Examples
The following example will enable exception report forwarding to john.doe@company.com using the
1.1.1.1 SMTP email server:
(config)#logging email on
(config)#logging email receiver-ip 1.1.1.1
(config)#logging email exception-report address-list john.doe@company.com

logging email ip urlfilter top-websites

Use the logging email ip urlfilter top-websites command to specify the parameters for receiving top
websites reports via email. Use the no form of this command to disable top websites reporting email
notification. Variations of this command include:
logging email ip urlfilter top-websites address-list <email addresses>

logging email ip urlfilter top-websites send-time <HH:MM:SS>
Syntax Description
address-list Specifies the configuration of a list of email addresses to receive top
websites reports.
send-time Specifies the configuration of when email reports for top websites will be
sent.
<email addresses> Specifies the complete email address to use when sending top websites
reports. (This field allows up to 256 characters.)
between addresses.
<HH:MM:SS> Specifies the hours, minutes, and seconds in a 24-hour format for sending
top websites reports by email.
Default Values
By default, there are no configured logging email addresses or times for top websites reporting.
Once an address list is specified and top websites email reports are enabled, the default send-time for the
reports is 12:00 a.m.
Command History
Usage Examples
The following example configures top websites reports to be emailed to sys.admin@adtran.com at
5:30 a.m.:
(config)#logging email ip urlfilter top-websites address-list sys.admin@adtran.com

(config)#logging email ip urlfilter top-websites send-time 05:30:00

logging email on
Use the logging email on command to enable the AOS email event notification feature. Use the logging
email address-list command to specify email address(es) that will receive notification when an event
matching the criteria configured using the logging email priority-level command is logged by AOS. Refer
to logging email priority-level on page 1018 for more information. Use the no form of this command to
disable the email notification feature.
Syntax Description
No subcommands.
Default Values
By default, email event notification is disabled.
Command History
Functional Notes
The domain name is appended to the sender name when sending event notifications. Refer to the
command ip domain-name <domain name> on page 832 for related information.
Usage Examples
The following example enables the AOS email event notification feature:
(config)#logging email on

logging email priority-level

Use the logging email priority-level command to set the threshold for events sent to the addresses
specified using the logging email address-list command. All events with the specified priority or higher
will be sent to all addresses in the list. The logging email on command must be enabled. Refer to logging
email address-list <email address> ; <email address> on page 1014 and logging email on on page 1017
for related information. Use the no form of this command to return to the default priority. Variations of this
command include:
logging email priority-level error

logging email priority-level fatal
logging email priority-level info
logging email priority-level notice
logging email priority-level warning
Syntax Description
Sets the minimum priority threshold for sending messages to email addresses specified using the logging
email address-list command. The following priorities are available (ranking from lowest to highest):

Default Values
By default, the logging email priority-level is set to warning.
Command History
Usage Examples
The following example sends all messages with warning level or greater to the email addresses listed
using the logging email address-list command:
(config)#logging email priority-level warning

logging email receiver-ip <ip address | hostname>

Use the logging email receiver-ip command to specify the IP address or host name of the email server to
use when sending email event notification. Use the no form of this command to remove a configured
address. Variations of this command include:
logging email receiver-ip <ip address | hostname>

logging email receiver-ip <ip address | hostname> port <number>
logging email receiver-ip <ip address | hostname> port <number> auth-username <username>
auth-password <password>
logging email receiver-ip <ip address | hostname> auth-username <username>
auth-password <password>
Syntax Description
<ip address | hostname> Specifies the IP address or host name of the email server to use when
sending logged messages. IP addresses should be expressed in dotted
auth-username <username> Optional. Specifies the user name to use if your email server requires
authentication.
auth-password <password> Optional. Specifies the password to use if your email server requires
authentication.
port <number> Optional. Specifies the port number of the remote email server. Range is 1
to 65535.
Default Values
By default, there are no configured email server addresses.
Command History
Release 15.1 Command was expanded to include the auth-username and
auth-password options.
Release 16.1 Command was expanded to include the port number specification option.
Usage Examples
The following example specifies an email server (with IP address 172.5.67.99) to use when sending
logged messages:
(config)#logging email receiver-ip 172.5.67.99

logging email sender

Use the logging email sender command to specify the sender in an outgoing email message. This name
will appear in the From field of the receiver’s inbox. Use the no form of this command to disable this
feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example sets a sender for outgoing messages:
(config)#logging email sender myUnit@myNetwork.com

logging email source-interface <interface>

Use the logging email source-interface command to use the specified interface’s IP address as the source
IP address for email messages transmitted by the unit. Use the no form of this command if you do not wish
to override the normal source IP address.
Syntax Description
<interface> Specifies the interface to be used as the source IP address for email
messages. Specify an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type logging email source-interface ? for a complete list
Default Values
Command History
interface.
Functional Notes
Usage Examples
The following example configures the unit to use the loopback 1 interface as the source IP for email
messages:
(config)#logging email source-interface loopback 1

logging facility <type>

Use the logging facility command to specify a syslog facility type for the syslog server. Error messages
meeting specified criteria are sent to the syslog server. For this service to be active, you must enable log
forwarding. Refer to logging forwarding on on page 1024 for related information. Facility types are
described under Functional Notes below. Use the no form of this command to return to the default setting.
Syntax Description
<type> Specifies the syslog facility type (refer to Functional Notes below). The
following is a list of all the valid facility types:
auth Authorization system
cron Cron facility
daemon System daemon
kern Kernel
local0 - local7 Reserved for locally defined messages
lpr Line printer system
mail Mail system
news USENET news
sys9 - sys14 System use
syslog System log
user User process
uucp UNIX-to-UNIX copy system
Default Values
The default value is local7.
Command History
Usage Examples
The following example configures the syslog facility to the cron facility type:
(config)#logging facility cron

logging forwarding auxiliary-receiver-ip <ip address>

Use the logging forwarding auxiliary-receiver-ip command to specify the IP address of a secondary
syslog server to use when logging events that match the criteria configured using the command logging
forwarding priority-level on page 1025. Use the no form of this command to remove the auxiliary server’s
configured address.
Syntax Description
<ip address> Specifies the IP address of a secondary syslog server to use when logging
messages. IP addresses should be expressed in dotted decimal notation
(for example, 10.10.10.1).
Default Values
By default, no secondary syslog servers are configured.
Command History
Functional Notes
Configuring a secondary syslog server allows the redundant transmission of messages to two different
servers. This server configuration is optional, and does not function as a failover address; therefore, the
primary server should always be configured using the command logging forwarding receiver-ip <ip
address> on page 1026. Syslog transmits to this auxiliary address independently of normal server
addresses.
Usage Examples
The following example specifies that messages are logged to both a primary syslog server (172.5.67.99)
and an auxiliary syslog server (172.5.69.100):
(config)#logging forwarding receiver-ip 172.5.67.99

(config)#logging forwarding auxiliary-receiver-ip 172.5.69.100

logging forwarding on
Use the logging forwarding on command to enable the AOS syslog event feature. Use the logging
forwarding priority-level command to specify the event matching the criteria used by AOS to determine
whether a message should be forwarded to the syslog server. Refer to logging forwarding priority-level on
page 1025 for related information. Use the no form of this command to disable the syslog event feature.
Syntax Description
No subcommands.
Default Values
By default, syslog event notification is disabled.
Command History
Usage Examples
The following example enables the AOS syslog event feature:
(config)#logging forwarding on

logging forwarding priority-level

Use the logging forwarding priority-level command to set the threshold for events sent to the configured
syslog server specified using the logging forwarding receiver-ip command. All events with the specified
priority or higher will be sent to all configured syslog servers. Refer to logging email priority-level on page
1018 for more information. Use the no form of this command to return to the default priority. Variations of
logging forwarding priority-level error

logging forwarding priority-level fatal
logging forwarding priority-level notice
logging forwarding priority-level smdr
logging forwarding priority-level warning
Syntax Description
Sets the minimum priority threshold for sending messages to the syslog server specified using the logging
forwarding receiver-ip command. The following priorities are available (ranking from lowest to highest):

smdr Logs events with smdr priorities.
Default Values
By default, the logging forwarding priority-level is set to warning.
Command History
Release 12.1 Command was expanded to include the smdr parameter.
Usage Examples
The following example sends all messages with warning level or greater to the syslog server listed using
the logging forwarding receiver-ip command:
(config)#logging forwarding priority-level warning

logging forwarding receiver-ip <ip address>

Use the logging forwarding receiver-ip command to specify the IP address of the syslog server to use
when logging events that match the criteria configured using the logging forwarding priority-level
command. Enter multiple logging forwarding receiver-ip commands to develop a list of syslog servers to
use. Refer to logging forwarding priority-level on page 1025 for related information. Use the no form of
this command to remove a configured address.
Syntax Description
<ip address> Specifies the IP address of the syslog server to use when logging
messages. IP addresses should be expressed in dotted decimal notation
(for example, 10.10.10.1).
Default Values
By default, there are no configured syslog server addresses.
Command History
Usage Examples
The following example specifies a syslog server (with address 172.5.67.99) to use when logging
messages:
(config)#logging forwarding receiver-ip 172.5.67.99

logging forwarding source-interface <interface>

Use the logging forwarding source-interface command to configure the specified interface’s IP address
as the source IP address for the syslog server to use when logging events. Use the no form of this command
if you do not wish to override the normal source IP address.
Syntax Description
<interface> Specifies the interface to be used as the source IP address for event log
traffic. Specify an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type logging forwarding source-interface? for a
Default Values
Command History
interface.
Functional Notes
Usage Examples
Configures the unit to use the loopback 1 interface as the source IP for event log traffic:
(config)#logging forwarding source-interface loopback 1

mac access-list standard <name>

Use the mac access-list standard command to create an empty medium access control (MAC) access
control list (ACL) and enter the Standard MAC Access List command set. Use the no form of this
command to delete a MAC ACL and all the entries contained in it. The mac access-list standard
command is currently for use only with wireless access points (APs). The following lists the complete
syntax for the mac access-list standard command:
(config)#mac access-list standard <name>

(config-std-mac-acl)#<action> <source>
Syntax Description
<name> Identifies the configured MAC ACL using an alphanumeric descriptor. All MAC
ACL descriptors are case sensitive.
<action> permit Permits entry to the access point for specified wireless station MACs.
<source> Specifies the source used for packet matching. Sources are expressed by
using host <mac address> to specify a single host address. MAC
addresses should be expressed in the following format: xx:xx:xx:xx:xx:xx
(for example, 00:A0:C8:00:00:01).
Default Values
By default, all AOS security features are disabled and there are no configured MAC ACLs.
Command History
Functional Notes
MAC ACLs are used as packet selectors by the wireless features; by themselves, the MAC ACLs do
nothing. A MAC ACL entry contains two parts: an action (permit) and a MAC address. A permit ACL is
used to match packets (meeting the specified pattern) to enter the AP. AOS provides only standard MAC
ACLs. Standard ACLs match based on the source of the packet.
Usage Examples
The following example creates a MAC ACL named Trusted to permit all packets entry to the AP with MAC
address 00:A0:C8:00:00:01.
(config)#mac access-list standard Trusted

(config-std-mac-acl)#permit 00:A0:C8:00:00:01
For more information about configuring MAC ACLs, refer to the MAC ACL quick configuration guide

mac address-table aging-time <value>

Use the mac address-table aging-time command to set the length of time dynamic medium access control
(MAC) addresses remain in the switch or bridge forwarding table. Use the no form of this command to
reset this length to the default setting.
Syntax Description
<value> Sets an aging time in seconds. Range is 10 to 1000000 seconds. Set to 0 to
disable the timeout.
Default Values
By default, the aging time is 300 seconds.
Command History
Usage Examples
The following example sets the aging time to 10 minutes:
(config)#mac address-table aging-time 600

mac address-table static <mac address>

Use the mac address-table static command to insert a static medium access control (MAC) address entry
into the MAC address table. Use the no form of this command to remove an entry from the table.
mac address-table static <mac address> bridge <bridge id> interface <interface>
mac address-table static <mac address> vlan <vlan id> interface <interface>
Syntax Description
in the following format xx:xx:xx:xx:xx:xx (for example, 00:A0:C8:00:00:01).
bridge <bridge id> Specifies a bridge interface ID. Valid range is 1 to 255.
vlan <vlan id> Specifies a virtual local area network (VLAN) interface ID.
interface <interface> Specifies an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type mac address-table static bridge interface ? or mac
address-table static <mac address> vlan <vlan id> interface ? for a
Default Values
By default, there are no static entries configured.
Command History
Release 10.1 Command was expanded to include the bridge interface.
Usage Examples
The following example adds a static MAC address to Point-to-Point Protocol (PPP) 1 on bridge 4:
(config)#mac address-table static 00:A0:C8:00:00:01 bridge 4 interface ppp 1
The following example adds a static MAC address to Ethernet 0/1 on VLAN 4:
(config)#mac address-table static 00:A0:C8:00:00:01 00:12:79:00:00:01 vlan 4 interface ethernet 0/1

mac hw-access-list extended <name>

Use the mac hw-access-list extended command to create and name a medium access control (MAC)
hardware access control list (ACL). This command also enters the ACL’s configuration mode. Using the
no form of this command deletes the MAC hardware ACL.
For a complete list of all MAC hardware ACL configuration commands, refer to the
Syntax Description
<name> Specifies the name of the MAC hardware ACL.
Default Values
Command History
Functional Notes
This command only creates an empty hardware ACL, it does not configure it. For additional MAC hardware
ACL configuration commands and configuration parameters, refer to the Hardware ACL and Access Map
Command Set on page 2491 or the Hardware ACLs in AOS configuration guide available online at
Usage Examples
The following example creates a MAC hardware ACL Trusted and enters the MAC hardware ACL
configuration mode:
(config)#mac hw-access-list extended Trusted

Configuring New MAC Hardware Extended ACL “Trusted”
(config-ext-mac-hw-nacl)#
Technology Review
Hardware ACLs are used as frame selectors by the hardware access maps; by themselves they do
pattern) and allows them to enter the router system. A deny ACL advances AOS to the next access list
entry.



mail-client <agent name>

Use the mail-client command to create a general-purpose mail agent and enter the Mail Agent
Configuration mode. Use the no form of this command to delete the mail agent. Refer to the Mail Agent
Command Set on page 2508 for more information.
Syntax Description
<agent name> Specifies the name of the created mail agent.
Default Values
By default, no mail agents exist.
Command History
Usage Examples
The following example creates a mail agent called myagent and enters the Mail Agent Configuration
mode:
(config)#mail-client myagent

modem countrycode <value>

Use the modem countrycode command to specify the modem configuration for the applicable country.
Syntax Description
<value> Specifies the modem configuration for the applicable country. Refer to
Functional Notes for countrycode values.
Default Values
By default, modem countrycode is set to USA/Canada.
Command History
Functional Notes
The following country codes are available for modem configuration:
Algeria - Algeria Modem configuration

Argentina - Argentina Modem configuration
Australia - Australia Modem configuration
Austria - Austria Modem configuration
Bahrain - Bahrain Modem configuration
Belgium - Belgium Modem configuration
Bolivia - Bolivia Modem configuration
Brazil - Brazil Modem configuration
Chile - Chile Modem configuration
China - China Modem configuration
Colombia - Colombia Modem configuration
Costa_Rica - Costa_Rica Modem configuration
Cyprus - Cyprus Modem configuration
Czechoslovakia - Czechoslovakia Modem configuration
Denmark - Denmark Modem configuration
Ecuador - Ecuador Modem configuration
Egypt - Egypt Modem configuration
Finland - Finland Modem configuration
France - France Modem configuration
Germany - Germany Modem configuration
Greece - Greece Modem configuration
Guatemala - Guatemala Modem configuration
Hong_Kong - Hong_Kong Modem configuration
Hungary - Hungary Modem configuration
India - India Modem configuration
Indonesia - Indonesia Modem configuration
Ireland - Ireland Modem configuration
Israel - Israel Modem configuration

Italy - Italy Modem configuration

Japan - Japan Modem configuration
Jordan - Jordan Modem configuration
Korea - Korea Modem configuration
Kuwait - Kuwait Modem configuration
Lebanon - Lebanon Modem configuration
Malaysia - Malaysia Modem configuration
Mexico - Mexico Modem configuration
Morocco - Morocco Modem configuration
Netherlands - Netherlands Modem configuration
New_Zealand - New_Zealand Modem configuration
Norway - Norway Modem configuration
Oman - Oman Modem configuration
Panama - Panama Modem configuration
Peru - Peru Modem configuration
Philippines - Philippines Modem configuration
Poland - Poland Modem configuration
Portugal - Portugal Modem configuration
Puerto_Rico - Puerto_Rico Modem configuration
Qatar - Qatar Modem configuration
Russia - Russia Modem configuration
Saudi_Arabia - Saudi_Arabia Modem configuration
Singapore - Singapore Modem configuration
Slovakia - Slovakia Modem configuration
Slovenia - Slovenia Modem configuration
South_Africa - South_Africa Modem configuration
Spain - Spain Modem configuration
Sweden - Sweden Modem configuration
Switzerland - Switzerland Modem configuration
Syria - Syria Modem configuration
Taiwan - Taiwan Modem configuration
Thailand - Thailand Modem configuration
Trinidad - Trinidad Modem configuration
Tunisia - Tunisia Modem configuration
Turkey - Turkey Modem configuration
UAE - UAE Modem configuration
UK - UK Modem configuration
USA/Canada - USA/Canada Modem configuration
Uruguay - Uruguay Modem configuration
Venezuela - Venezuela Modem configuration
Yemen - Yemen Modem configuration

Usage Examples
The following example specifies to use the USA/Canada modem configuration.
(config)#modem countrycode USA/Canada

monitor session <number>

Use the monitor session command to configure a port mirroring session. Use the no form of this command
to remove a port mirroring session or to remove a source or destination interface. Variations of this
command include:
monitor session <number> destination interface <interface> no-isolate

monitor session <number> destination interface <interface> no-tag
monitor session <number> destination interface <interface> no-isolate no-tag
monitor session <number> destination interface <interface> no-tag no-isolate
monitor session <number> source interface <interface>
monitor session <number> source interface <interface> both
monitor session <number> source interface <interface> rx
monitor session <number> source interface <interface> tx
Syntax Description
<number> Selects the monitor session number (only one is allowed).
destination Selects the destination interface.
source Selects the source interface(s). A range of interfaces is allowed.
interface <interface> Specifies an interface in the format <interface type [slot/port |
dot11ap 1/1.1. Type monitor session <number> [destination | source]
interface ? for a complete list of valid interfaces.
both Optional. Monitors both transmitted and received traffic.
rx Optional. Monitors received traffic only.
tx Optional. Monitors transmitted traffic only.
no-tag Removes the virtual local area network (VLAN) tag that is normally
appended to mirrored traffic.
no-isolate Allows native traffic to continue to pass on the port set as the mirroring
session destination.
Default Values
By default, traffic is monitored in both directions. Also by default, the destination port is isolated from
passing native traffic.
Command History
Release 13.1 Command was expanded to include the no-isolate parameter.

Usage Examples
The following example sets Ethernet 0/1 as the destination interface and adds Ethernet 0/2, Ethernet 0/3,
and Ethernet 0/5 as source ports:
(config)#monitor session 1 destination interface eth 0/1

(config)#monitor session 1 source interface eth 0/2-3, eth 0/5
The following example sets Gigabit-Switchport 0/1 as the destination interface and removes the VLAN tag:
(config)#monitor session 1 destination interface gigabit-switchport 0/1 no-tag
The following example sets Switchport 0/1 as the source interface and monitors both transmitted and
received traffic:
(config)#monitor session 1 source interface switchport 0/1 both
The following example sets Gigabit-Switchport 0/1, and Switchport 0/2 through Switchport 0/12 as source
interfaces and monitors only received traffic:
(config)#monitor session 1 source interface gigabit 0/1, eth 0/2-12 rx

network-forensics ip dhcp
Use the network-forensics ip dhcp command to enable passive monitoring of Dynamic Host
Configuration Protocol (DHCP) message exchanges between the server and the client. Using the no form
of this command disables network forensics.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Network forensics is an AOS feature that collects client information through DHCP messages sent
between clients connected to the network and the network server.
Once network forensics is enabled, the AOS unit begins collecting DHCP information. The collected data
can be viewed either by using the command show network-forensics ip dhcp on page 567 or debug
network-forensics ip dhcp on page 277 to view the information in realtime. For more information about
network forensics, refer to the Network Forensics in AOS troubleshooting guide available online at
Usage Examples
The following example enables the network forensics feature:
(config)#network-forensics ip dhcp

ntp master
Use the ntp master command to globally set the system as an authoritative Network Time Protocol (NTP)
server. Variations of this command include:
ntp master
ntp master <value>
Syntax Description
<value> Optional. Specify the stratum number. The valid range is 1 to 15. We
recommend not setting the stratum higher than 2.
Default Values
By default, the NTP server is not enabled.
Command History
Usage Examples
The following example enables the master NTP server:
(config)#ntp master

ntp max-associations <value>

Use the ntp max-associations command to set the maximum number of simultaneous Network Time
Protocol (NTP) associations allowed with other NTP clients or peers. Use the no form of this command to
Syntax Description
<value> Specify the maximum number of associations. The valid range is
1 to 4294967295.
Default Values
By default, the maximum associations is 100.
Command History
Usage Examples
The following example specifies the maximum associations of 250:
(config)#ntp max-associations 250

ntp peer <name>

Use the ntp peer command to specify a peer association with another Network Time Protocol (NTP)
system and configure its parameters. Any combination of peer associations can be simultaneously
configured. Use the no form of this command to return to the default setting. Variations of this command
include:
ntp peer <name>

ntp peer <name> maxpoll <value>
ntp peer <name> minpoll <value>
ntp peer <name> normal-sync
ntp peer <name> prefer
ntp peer <name> source <interface>
ntp peer <name> version
Syntax Description
<name> Specify the host name or IP address of the NTP server.
maxpoll <value> Optional. Specifies the maximum polling interval for NTP packets, in
seconds as a power of two. The allowable range is 4 to 17. For example,
setting the maxpoll to 10 would indicate a maximum polling interval of
1024 seconds. Refer to Functional Notes on page 1043 for more
information.
minpoll <value> Optional. Specifies the minimum polling interval for NTP packets, in
setting the minpoll to 6 would indicate a minimum polling interval of
64 seconds. Refer to Functional Notes on page 1043 for more information.
normal-sync Optional. Disables the rapid synchronization feature.
prefer Optional. Specifies the preference of using the specified server above all
other configured NTP servers.
source <interface> Optional. Specifies the source interface (physical or virtual) to use for the
peer. Specify an interface in the format <interface type [slot/port |
use ppp 1; and for an ATM subinterface, use atm 1.1. Enter ntp peer
<name> source ? for a list of valid interfaces.
version Specifies the version number for outgoing NTP packets.
Default Values
By default, the ntp peer is not set. Once enabled, the default version is 4, the default minpoll interval is 6
(64 seconds) and the default maxpoll interval is 10 (1024 seconds).

Command History
Release 17.6 Command was expanded to include maxpoll and minpoll parameters.
Functional Notes
The ntp peer command can be executed with any combination of the following parameters:
maxpoll <value>
minpoll <value>
normal-sync
prefer
source <interface>
version
For example, the normal-sync and source <interface> parameters can be used in conjunction with one
another. In this case, the command would look like this:
#ntp peer 10.10.10.1 normal-sync source ppp 1
These parameters can be combined in any order to get the desired configuration.
In order to determine the appropriate value to enter for maxpoll or minpoll, use the following formula:
2n where n = <value>. For example, to set the minimum polling interval to 64 seconds, you would enter 6
as the minpoll value. This corresponds to 26 in the formula, or 2x2x2x2x2x2, which equals 64 seconds.
Usage Examples
The following example defines 10.10.10.1 as the NTP peer server:
(config)#ntp peer 10.10.10.1
The following example creates a peer association with 10.10.10.1 and sets the maximum polling interval of
64 seconds:
(config)#ntp peer 10.10.10.1 maxpoll 6

ntp server <name>

Use the ntp server command to specify a server association with another Network Time Protocol (NTP)
system and configure its parameters. Any combination of server associations can be simultaneously
configured. Use the no form of this command to return to the default setting. Variations of this command
include:
ntp server <name>

ntp server <name> maxpoll <value>
ntp server <name> minpoll <value>
ntp server <name> prefer
ntp server <name> source <interface>
ntp server <name> version <number>
Syntax Description
<name> Specify the host name or IP address of the NTP server.
maxpoll <value> Optional. Specifies the maximum polling interval for NTP packets, in
setting the maxpoll to 10 would indicate a maximum polling interval of
1024 seconds. Refer to Functional Notes on page 1045 for more
information.
minpoll <value> Optional. Specifies the minimum polling interval for NTP packets, in
setting the minpoll to 6 would indicate a minimum polling interval of
64 seconds. Refer to Functional Notes on page 1045 for more information.
prefer Optional. Specifies the preference of using the specified server above all
other configured NTP servers.
source <interface> Optional. Specifies the source interface (physical or virtual) to use for the
server. Specify an interface in the format <interface type [slot/port |
use ppp 1; and for an ATM subinterface, use atm 1.1. Enter ntp server
<name> source ? for a list of valid interfaces.
version <number> Specifies the version number for outgoing NTP packets.
Default Values
By default, the ntp server is not set. Once enabled, the default version is 3, the default minpoll interval is
6 (64 seconds) and the default maxpoll interval is 10 (1024 seconds).
Command History
Release 17.6 Command was expanded to include maxpoll and minpoll parameters.

Functional Notes
The ntp server command can be executed with any combination of the following parameters:
maxpoll <value>
minpoll <value>
prefer
source <interface>
version
For example, the prefer and source <interface> parameters can be used in conjunction with one another.
In this case, the command would look like this:
#ntp server 10.10.10.1 prefer source ppp 1
These parameters can be combined in any order to get the desired configuration.
In order to determine the appropriate value to enter for maxpoll or minpoll, use the following formula:
2n where n = <value>. For example, to set the minimum polling interval to 64 seconds, you would enter 6
as the minpoll value. This corresponds to 26 in the formula, or 2x2x2x2x2x2, which equals 64 seconds.
Usage Examples
The following example defines 10.10.10.1 as the preferred NTP server:
(config)#ntp server 10.10.10.1 prefer
The following example associates the NTP server 10.10.10.1 and sets the minimum polling interval of 256
seconds:
(config)#ntp server 10.10.10.1 maxpoll 8

ntp source <interface>

Use the ntp source command to specify the source interface for the Network Time Protocol (NTP)
packets. Use the no form of this command to return to the default setting.
Syntax Description
<interface> Specifies the source interface (physical or virtual) to use for the server.
eth 0/1.1; for a PPP interface, use ppp 1; and for an ATM subinterface, use
atm 1.1. Enter ntp source ? for a list of valid interfaces.
Default Values
By default, the NTP source interface is not set.
Command History
Usage Examples
The following example defines NTP source interface as ppp 1:
(config)#ntp source ppp 1

ntp update-rtc
Use the ntp update-rtc command to specify periodically updating the clock in real time. Use the no form
of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, the Network Time Protocol (NTP) is disabled.
Command History
Usage Examples
The following example sets the clock to periodically update the timing:
(config)#ntp update-rtc

portal-list <name> <portal1 portal2 portal3...>

Use the portal-list command to create a portal list to associate with a local user name. Use the command
username <username> portal-list <name> password <password> on page 1126 to assign this portal list
to an previously configured user name. Use the no form of this command to remove the portal list.
Entering this command with the same name, but a different portal list will overwrite the
original portal list.
Syntax Description
<name> Specifies the name of the portal list (maximum of 80 characters).
<portal> Specifies the portals assigned to this portal list. The list can contain any
combination of the portals listed below:
console Allows the list holder to access the unit via the console.
ftp Allows the list holder to access the unit via File Transfer Protocol (FTP).
http-admin Allows the list holder to view the configuration and statistics via Hypertext
Transfer Protocol (HTTP).
ssh Allows the list holder to access the unit via secure shell (SSH).
telnet Allows the list holder to access the unit via Telnet.
Default Values
By default, no portal lists are defined.
Command History
Functional Notes
The same portal list can be assigned to multiple user names. Once the list is assigned to the user name,
that user name can only authenticate the portals in the list. If a list is not assigned to a user name, that user
name can be used with any portal that is set for local login.
Usage Examples
The following example assigns the console, telnet, and ssh portals the portal list engineers:
(config)#portal-list engineers console telnet ssh

port-auth default
Use the port-auth default command to set all global port-authentication settings to their default states.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example sets all global port-authentication settings to their default states:
(config)#port-auth default

port-auth max-req <number>

Use the port-auth max-req command to specify the maximum number of identity requests the
authenticator will transmit before restarting the authentication process. Use the no form of this command
to return to the default setting.
Syntax Description
<number> Specifies the maximum number of authentication requests.
Default Values
By default, the maximum number of authentication requests is set at 2.
Command History
Usage Examples
The following example sets the maximum number of authentication requests at 4:
(config)#port-auth max-req 4

port-auth re-authentication
Use the port-auth re-authentication command to enable re-authentication. Use the no form of this
Syntax Description
No subcommands.
Default Values
By default, re-authentication is disabled.
Command History
Usage Examples
The following example enables re-authentication:
(config)#port-auth re-authentication

port-auth supplicant
Use the port-auth supplicant command to enable the port-authentication supplicant mode feature and to
enter the Port-Authentication Supplicant Configuration mode. Use the no form of this command to remove
the supplicant mode parameters. Variations of this command include:
port-auth supplicant
port-auth supplicant username <username> password <password>
Syntax Description
supplicant Specifies that port authentication is in supplicant mode.
username <username> Specifies the user name used for supplicant authentication.
password <password> Specifies the password used for supplicant authentication.
Default Values
By default, port authentication and port authentication supplicant mode is disabled.
Command History
Functional Notes
The supplicant user name and password can be stored in the port and set in the session if it exists. This
allows for the user name and password to be set before the supplicant functionality is enabled.
Usage Examples
The following example sets the user name of admin and the password of password for supplicant mode
authentication on the eth 0/1 interface:

(config-eth-0/1)#port-auth supplicant username admin password password

port-auth timeout
Use the port-auth timeout command to configure various port authentication timers. Use the no form of
port-auth timeout quiet-period <value>

port-auth timeout re-authperiod <value>
port-auth timeout tx-period <value>
Syntax Description
quiet-period <value> Specifies the amount of time the system will wait before attempting another
authentication once a failure has occurred. Range is 1 to 65535 seconds.
re-authperiod <value> Specifies the amount of time between scheduled re-authentication
attempts. Range is 1 to 4294967295 seconds.
tx-period <value> Specifies the amount of time the authenticator will wait between identity
requests. Range is 1 to 65535 seconds.
Default Values
By default, quiet-period is set to 60 seconds, re-authperiod is set to 3600 seconds (1 hour), and
tx-period is set to 30 seconds.
Command History
Usage Examples
The following example sets the quiet-period to 10 seconds:
(config)#port-auth timeout quiet-period 10

port-channel load-balance
Use the port-channel load-balance command to configure port aggregation load distribution. Use the no
form of this command to reset distribution to its default setting. Variations of this command include:
port-channel load-balance dst-mac

port-channel load-balance src-mac
Syntax Description
dst-mac Specifies the destination medium access control (MAC) address.
src-mac Specifies the source MAC address.
Default Values
By default, load balance is set to src-mac.
Command History
Functional Notes
During port aggregation, the port channel interface must determine on which physical port to transmit
packets. With the source-address configuration, the source MAC address of the received packets is used
to determine this allocation. Packets coming from a specific host always use the same physical port.
Likewise, when the destination address configuration is used, packets are forwarded based on the MAC
address of the destination. Packets destined for a specific host always use the same physical port.
Usage Examples
The following example sets the load distribution to use the destination MAC address:
(config)#port-channel load-balance dst-mac

power-supply shutdown automatic

Use the power-supply shutdown automatic command to enable the power supplies to automatically shut
down when the unit temperature exceeds the maximum operating temperature. Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the power supplies to shut down automatically if the temperature gets too
high:
(config)#power-supply shutdown automatic

probe
Use the probe command to create a probe as part of network monitoring. This command is also used to
enter into the Network Monitoring Probe command set once a probe is created. A probe can be one of five
types: http-request, icmp-echo, icmp-timestamp, tcp-connect, or twamp. Each probe type has a set of
commands used for configuration. These additional commands are covered in Network Monitor Probe
Command Set on page 2319. Use the no form of this command to delete the probe. Variations of this
command include:
probe <name> http-request

probe <name> icmp-echo
probe <name> icmp-timestamp
probe <name> tcp-connect
probe <name> twamp
Issue the no shutdown command to activate the probe once it is configured.
The probe is not operational until tolerance is defined. Refer to Network Monitor Probe
Syntax Description
<name> Specifies the name of the probe being created, or indicates the probe
affected by the commands that follow.
http-request Specifies the probe type being created as an HyperText Transfer Protocol
(HTTP) request.
icmp-echo Specifies the probe type being created as an Internet Control Message
Protocol (ICMP) echo.
icmp-timestamp Specifies the probe type being created as an ICMP timestamp.
tcp-connect Specifies the probe type being created as a Transmission Control Protocol
(TCP) connect.
twamp Specifies the probe type being created as a Two-Way Active Measurement
Protocol (TWAMP).
Default Values
By default, there are no probes configured.

Command History
Release 17.2 Command was expanded to include the ICMP timestamp and TWAMP
probe types.
Usage Examples
The following example creates an ICMP echo probe called probe1:
>enable
#configure terminal
(config)#probe probe1 icmp-echo
Technology Review
Probes are standalone objects that help determine the status of a route based on the success or failure of
probe traffic across the path. The probes can be configured to trigger at particular intervals. There are
three types of probes supported by AOS: icmp-echo, tcp-connect, and http-request. Commands
common to all the probe types are identified in the following section, as well as isolated commands that
only apply to the specific probe types.
Additional configuration commands are available for associating tracks with each probe. These are
explained in the Network Monitor Track Command Set on page 2356.

probe responder
Use the probe responder command to enable a probe responder to respond to specific probe packets.
Additional commands for each responder type are covered in Network Monitor Probe Responder
Command Set on page 2346. Use the no form of this command to stop the probe responder from
responding to the specific probe packets. Variations of this command include:
probe responder icmp-timestamp

probe responder twamp
probe responder udp-echo
Issue the no shutdown command to activate the probe responder once it is configured.
Syntax Description
icmp-timestamp Specifies the probe responder type as Internet Control Message Protocol
(ICMP) timestamp.
twamp Specifies the probe responder type as Two-Way Active Measurement
Protocol (TWAMP).
udp-echo Specifies the probe responder type as a User Datagram Protocol (UDP)
echo.
Default Values
By default, there are no probe responders enabled.
Command History
Usage Examples
The following example enables the UDP echo probe responder:
>enable
#configure terminal
(config)#probe responder udp-echo

qos cos-map <cos queue id> <cos value>

Use the qos cos-map command to associate class of service (CoS) values with each queue. Use the no
form of this command to return to the default setting.
Syntax Description
<cos queue id> Specifies the queue number that you are assigning CoS value(s).
<cos value> Associates listed CoS values with a particular priority queue. Multiple CoS
values can be applied to a specified queue. Valid range is 0 to 7.
Default Values
By default, CoS 0 and 1 are mapped to queue 1; CoS 2 and 3 are mapped to queue 2; CoS 4 and 5 are
mapped to queue 3; CoS 6 and 7 are mapped to queue 4.
Command History
Usage Examples
The following example maps CoS values 4 and 5 to queue 1:
(config)#qos cos-map 1 4 5

qos dscp-cos
Use the qos dscp-cos command to set the differentiated services code point (DSCP) to class of service
(CoS) map and enable the mapping process. Use the no form of this command to disable mapping.
qos dscp-cos <dscp value> to <cos value>

qos dscp-cos default
Syntax Description
<dscp value> Specifies DSCP values (separating multiple values with a space). Valid
range is 0 to 63.
<cos value> Specifies CoS values (separating multiple values with a space). Valid range
is 0 to 7.
default Sets the map to the following default values:
DSCP 0 | 8 | 16 | 24 | 32 | 40 | 48 | 56
CoS 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7
Default Values
Command History
Functional Notes
When one of the specified DSCP values is detected in an incoming packet, the CoS priority is altered
based on the corresponding map value. By configuring the list, the mapping functionality is enabled.
Usage Examples
The following example enables the mapping of DSCP values 24 and 48 to CoS values 1 and 2:
(config)#qos dscp-cos 24 48 to 1 2
The following example disables DSCP-to-CoS mapping:
(config)#no qos dscp-cos

qos map <name> <number>

Use the qos map command to create a quality of service (QoS) map and activate the QoS Map Command
Set (which allows you to edit a QoS map). For details on specific commands, refer to the Quality of Service
Map Command Set on page 2545. Use the no form of this command to delete a map entry. Variations of
qos map <name> <number>

qos map <name> <number> match-all
qos map <name> <number> match-any
Syntax Description
<name> Specifies the QoS map name.
<number> Assigns a sequence number to differentiate this QoS map and provide a
match order. Valid range is 0 to 65535.
match-all Optional. Indicates the traffic must match all conditions before the set action
is issued.
match-any Optional. Indicates the traffic can match any of the conditions to be
processed, which is the default behavior.
Default Values
By default, there are no QoS maps defined. Once created, the default behavior is to match any of the
conditions set for the QoS map.
Command History
Release 17.2 Command was expanded to include the match-all and match-any
parameters.
Functional Notes
AOS uses QoS maps to classify packets into groups for matching. A QoS map contains multiple class
entries, each of which has packet match cases, and a set of actions for the particular group (actions are
defined by bandwidth, priority, set, and shape commands). Multiple map entries for the same QoS map
are differentiated by a sequence number. The sequence number is used to assign the order in which the
conditions are matched.
Once created, a QoS map must be applied to an interface (using the qos-policy out command) in order to
actively process traffic. Refer to qos-policy on page 1382 for more information on assigning the map to an
interface. Any traffic for the interface that is not sent to the priority queue is sent using the default queuing
method for the interface (such as weighted fair queuing (WFQ)).

Usage Examples
The following example demonstrates basic settings for a QoS map and assigns a map to the Frame Relay
interface:
>enable
#config terminal
(config)#qos map VOICEMAP 10
(config-qos-map)#match precedence 5
(config-qos-map)#priority 512
(config-qos-map)#exit
(config)#interface fr 1
(config-fr 1)#qos-policy out VOICEMAP

qos queue-type strict-priority

Use the qos queue-type strict-priority command to enable queuing based strictly on the priority of each
queue. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, the queue type is weighted round robin (WRR).
Command History
Usage Examples
The following example enables strict-priority queuing:
(config)#qos queue-type strict-priority

qos queue-type wrr

Use the qos queue-type wrr command to set weights for up to four queues. Use the no form of this
command to set all queues to be weighted round robin (WRR). Variations of this command include:
qos queue-type wrr <weight1> <weight2> <weight3> expedite

qos queue-type wrr <weight1> <weight2> <weight3> <weight4>
Syntax Description
<weight1-4> Sets the weight of each queue (up to four). All queue weights must be
greater than zero, except for the weight for the last queue (queue 4). The
range for queues 1 to 3 is 1 to 255. The range for queue 4 is 0 to 255.
expedite The queue 4 entry can be replaced by the expedite command. If set to
expedite, then it becomes a high-priority queue. All outbound traffic is
transmitted on an expedite queue prior to any other traffic in other queues.
Default Values
By default, all four weights are set to 25.
Command History
Functional Notes
The actual weight is a calculated value based on the sum of all entered weights. It is the ratio of the
individual weight over the sum of all weights.
For example:
If the user enters 10, 20, 30, and 40 as the weight values, the first queue will have a ratio of 1/10. This is
derived from the formula 10/(10+20+30+40). Therefore, this queue will transmit 1 packet out of every 10
opportunities.
Usage Examples
The following example configures weights for all four queues:
(config)#qos queue-type wrr 10 20 30 40

radius-server
Use the radius-server command to configure several remote authentication dial-in user service (RADIUS)
parameters for all RADIUS servers on the network. Most of these global settings can be overridden on a
per-server basis (using the command radius-server host on page 1067). Use the no form of this command
to return to the default setting. Variations of this command include the following:
radius-server challenge-noecho
radius-server deadtime <value>
radius-server enable-username <name>
radius-server key <key>
radius-server retry <number>
radius-server timeout <value>
Syntax Description
challenge-noecho Specifies that when users enter text in response to challenge questions the
entered text does not appear on the screen.
deadtime <value> Specifies the time to wait (in minutes) before attempting to reconnect to a
RADIUS server that has timed out. Range is 0 to 1440 minutes. Changing
this parameter changes the time to wait for all configured RADIUS servers.
enable-username <name> Specifies a user name to be used for authentication to enter the Enable
mode. This user name is the name sent for AAA Enable mode access
requests. Changing this parameter changes the user name for all
configured RADIUS servers.
key <key> Specifies the encryption key shared by all RADIUS servers. This is a global
setting; however, it can be overridden on a per-server basis.
retry <number> Specifies the number of connection attempts to a RADIUS server. Attempt
range is 0 to 10. This is a global setting; however, it can be overridden on a
per-server basis.
timeout <value> Specifies the amount of time (in seconds) that RADIUS servers have to
respond to a request. Time range is 1 to 1000 seconds. This is a global
setting; however, it can be overridden on a per-server basis.
Default Values
challenge-noecho Echo is disabled and users do not see on-screen what they enter.
deadtime 0 minutes
enable-username $enab15$
key No default
retry 0 attempts
timeout 5 seconds

Command History
Release 7.1 Added the enable-username selection.
Functional Notes
It is recommended that you use a user name that is a unique name for your network and one that only the
network administrators know. If the default user name is used, it is possible for unauthorized users to gain
access to the network.
By default, there is a 0 minute wait time before attempting to reconnect to a timed out server. Leaving the
wait time at 0 minutes means that the server will never be declared dead. The time period value is 0 to
1440 minutes, although you should enter a value of at least 1 minute or greater.
Usage Examples
The following example shows a typical configuration of these parameters:
(config)#radius-server deadtime 10
(config)#radius-server enable-username fantastico
(config)#radius-server key mysecretkey
(config)#radius-server retry 4
(config)#radius-server timeout 2

radius-server host
Use the radius-server host command to specify the parameters for a remote authentication dial-in user
service (RADIUS) server. Use the no form of this command to return to the default setting. Variations of
radius-server host <hostname | ip address>

radius-server host <hostname | ip address> acct-port <port>
radius-server host <hostname | ip address> auth-port <port>
radius-server host <hostname | ip address> key <key>
radius-server host <hostname | ip address> retransmit <number>
radius-server host <hostname | ip address> timeout <value>
Each parameter after <hostname | ip address> specifies the characteristics of the

individual RADIUS server. Parameters can be entered in a single command line, in any
order, but each may only be used once.
Syntax Description
<hostname | ip address> Specifies the server to configure. IP addresses should be expressed in
dotted decimal notation (for example, 10.10.10.1). If a host name is used, a
domain naming system (DNS) server should be learned by the AOS device
using Dynamic Host Configuration Protocol (DHCP), Point-to-Point Protocol
(PPP), or specified in the Global Configuration mode with the command ip
name-server on page 898.
acct-port <port> Specifies the User Datagram Protocol (UDP) port used by the AAA
accounting server. Port range is 0 to 65535. This command is reserved for
future use as currently AOS does not allow RADIUS servers for use with
AAA accounting.
auth-port <port> Specifies the UDP port used by the AAA authentication server. The port
key <key> Specifies the encryption key used by the RADIUS server. This command
overrides the global RADIUS key setting (set with the command
radius-server on page 1065). This command must be entered last in the
command line because everything after the key parameter is read as the
new key.
retransmit <number> Specifies the number of connection attempts made to the server. Attempt
range is 1 to 100.
timeout <value> Specifies the time to wait (in seconds) for this server to reply to requests.
Default Values
By default, acct-port is set to 1813 and auth-port is set to 1812. By default, the key, retransmit and
timeout values are the values set by the command radius-server on page 1065.

Command History
Functional Notes
At a minimum, the address (IP or host name) of the server must be given. The other parameters can be
entered in any order (except the key parameter) and, if the parameters are not specified, they will take
default values or fall back on the global RADIUS server’s default settings (set using the command
radius-server on page 1065).
Usage Examples
The following example specifies that the RADIUS server at IP address 10.10.10.2 uses the global key
setting (left unspecified), a timeout value of 10 seconds, the default authorization port (left unspecified),
and a retransmit number of 5:
(config)#radius-server host 10.10.10.2 retransmit 5 timeout 10

resource-utilization
Use the resource-utilization command to set a threshold limit for CPU or heap utilization notifications.
When the utilization threshold is surpassed, a resource trap is sent. Use the no form of this command to
remove the threshold setting. Variations of this command include:
resource-utilization cpu threshold <percentage> time-interval <value>

resource-utilization heap threshold <percentage>
Syntax Description
cpu Sets the threshold for CPU utilization notification.
heap Sets the threshold for heap utilization notification.
threshold <percentage> Specifies the threshold limit as a percentage of resource utilization.
Valid range is 1 to 100 percent.
time-interval <value> Specifies the time interval for the actual utilization to exceed the threshold
before a notification is sent. Valid range is 1 to 86400 seconds.
Default Values
By default, there are no thresholds configured.
Command History
Functional Notes
Simple Network Management Protocol (SNMP) resource traps must be enabled before exceeded
threshold notifications are sent. Refer to snmp-server enable traps on page 1084.
Usage Examples
The following example configures the CPU resource notification to be sent when the CPU usage maintains
at least 75 percent utilization for 40 seconds:
(config)#resource-utilization cpu threshold 75 time-interval 40

route-map
Use the route-map command to create a route map and enter the Route Map Configuration command set.
A route map is a type of filter that matches various attributes and then performs actions on the way the
route is redistributed. Use the no form of this command to delete a route map. Variations of this command
include:
route-map <name> <number>

route-map <name> deny <number>
route-map <name> permit <number>
Syntax Description
<name> Specifies a name for the route map.
deny Specifies not to redistribute routes matching the route map attributes.
permit Redistributes routes matching the route map attributes.
<number> Specifies a sequence number of this route entry. Range is 1 to 4294967295.
Default Values
By default, no route maps are defined.
Command History
Functional Notes
Route maps can be assigned to a neighbor using the route-map command in the BGP Neighbor
command set. Refer to route-map <name> on page 2312 for more information.
Usage Examples
The following example creates the route map, specifies that routes matching its criteria will be denied, and
assigns a sequence number of 100:
(config)#route-map MyMap deny 100

(config-route-map)#
You can then define the attributes of the route map from the Route Map Configuration command set. Enter
a ? at the (config-route-map)# prompt to explore the available options.

router bgp
Use the router bgp command to enter the BGP Configuration mode. Refer to the BGP Command Set on
page 2284 for more information. Use the no form of this command to disable Border Gateway Border
(BGP) routing.
Syntax Description
No subcommands.
Default Values
By default, BGP is disabled.
Command History
Usage Examples
The following example uses the router bgp command to enter the BGP Configuration mode:
(config)#router bgp
(config-bgp)#
Technology Review
The following AOS BGP-related guidelines may help guide decisions made during basic BGP
implementation.
Ignore route if next hop is unreachable.
Prefer route with largest weight (only used in the local router, set by applying route maps to set this value
on desired inbound updates).
Prefer route with largest local preference.
Prefer route injected by this router via network command.
Prefer route with shortest AS_PATH.
Prefer route with lowest origin type. Routes originally injected by the network command or aggregation
(IGP) have a lower origin type than those originally injected by redistribution into BGP.
Prefer routes with lowest MED value.
Before the route is installed into the route table (forwarding table), a check is made of other sources that
may have information about the same subnet (static routes, IGP, etc.). The route with the lowest
administrative distance is installed.

router ospf
Use the router ospf command to activate open shortest path first (OSPF) in the router and to enter the
OSPF Configuration mode. Refer to the Router (OSPF) Command Set on page 2371 for more information.
Use the no form of this command to disable OSPF routing.
Syntax Description
No subcommands.
Default Values
By default, OSPF is disabled.
Command History
Functional Notes
AOS can be configured to use OSPF with the firewall enabled (using the ip firewall command). To do this,
configure the OSPF networks as usual, specifying which networks the system will listen for and broadcast
OSPF packets to. Refer to ip firewall on page 837 for more information.
To apply stateful inspection to packets coming into the system, create a policy class that describes the type
of action desired and then associate that policy class to the particular interface (refer to ip policy-class
<name> on page 900). The firewall is intelligent and will only allow OSPF packets that were received on an
OSPF configured interface. No modification to the policy class is required to allow OSPF packets into the
system.
Usage Examples
The following example uses the router ospf command to enter the OSPF Configuration mode:

router pim-sparse
Use the router pim-sparse command to globally enable protocol-independent multicast (PIM) on the unit
and to enter the PIM Sparse Configuration mode. Use the no form of this command to disable PIM Sparse
routing. Refer to the Router (PIM Sparse) Command Set on page 2391 for more information on the
subcommands for PIM Sparse Configuration mode.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Additional commands for PIM are found in the related interface configuration modes. Refer to the
ip pim-sparse commands in sections such as Ethernet Interface Command Set on page 1309, Frame
Relay Subinterface Command Set on page 1751, HDLC Interface Command Set on page 1834, Loopback
Interface Command Set on page 1910, PPP Interface Command Set on page 1979, Tunnel Interface
Command Set on page 2072, and VLAN Interface Command Set on page 2162 for more information.
Usage Examples
The following example uses the router pim-sparse command to enter the PIM Sparse Configuration
mode:
(config)#router pim-sparse

router rip
Use the router rip command to enter the RIP Configuration mode. Use the no form of this command to
disable Routing Information Protocol (RIP) routing. Refer to the Router (RIP) Command Set on page 2395
for more information.
Syntax Description
No subcommands.
Default Values
By default, RIP is disabled.
Command History
Usage Examples
The following example uses the router rip command to enter the RIP Configuration mode:
(config)#router rip
(config-rip)#
Technology Review
The RIP protocol is based on the Bellham-Ford (distance-vector) algorithm. This algorithm provides that a
network will converge to the correct set of shortest routes in a finite amount of time, provided that:
Gateways continuously update their estimates of routes.
Updates are not overly delayed and are made on a regular basis.
The radius of the network is not excessive.
No further topology changes take place.
RIP is described in RFC 1058 (Version 1) and updated in RFCs 1721, 1722, and 1723 for Version 2.
Version 2 includes components that ease compatibility in networks operating with RIP V1.
All advertisements occur on regular intervals (every 30 seconds). Normally, a route that is not updated for
180 seconds is considered dead. If no other update occurs in the next 60 seconds for a new and better
route, the route is flushed after 240 seconds. Consider a connected route (one on a local interface). If the
interface fails, an update is immediately triggered for that route only (advertised with a metric of 16).
Now consider a route that was learned and does not receive an update for 180 seconds. The route is
marked for deletion, and even if it was learned on an interface, a poisoned (metric equals 16) route should
be sent by itself immediately and during the next two update cycles with the remaining normal split horizon
update routes. Following actual deletion, the poison reverse update ceases. If an update for a learned
route is not received for 180 seconds, the route is marked for deletion. At that point, a 120-second garbage
collection (GC) timer is started. During the GC timer period, expiration updates are sent with the metric for
the timed-out route set to 16.

If an attached interface goes down, the associated route is immediately (within the same random
five-second interval) triggered. The next regular update excludes the failed interface. This is the so-called
first hand knowledge rule. If a gateway has first hand knowledge of a route failure (connected interfaces) or
reestablishment, the same action is taken. A triggered update occurs, advertising the route as failed
(metric equals 16) or up (normal metric) followed by the normal scheduled update.
The assumption here is that if a gateway missed the triggered update, it will eventually learn from another
gateway in the standard convergence process. This conserves bandwidth.
RIP-Related Definitions:
Route A description of the path and its cost to a network.

Gateway A device that implements all or part of RIP (a router).
Hop A metric that provides the integer distance (number of intervening
gateways) to a destination network gateway.
Advertisement A broadcast or multicast packet to port 520 that indicates the route for a
given destination network.
Update An advertisement sent on a regular 30-second interval, including all routes
exclusive of those learned on an interface.

run tcl <filename>

Use the run tcl command to initiate a tool command language (Tcl) script.
Syntax Description
<filename> Specifies the name of the Tcl script file to run.
Default Values
Command History
Usage Examples
The following example initiates the test1.tcl Tcl script file:
#run tcl test1.tcl
Script execution complete

schedule <name>
Use the schedule command to create a general-purpose schedule. Use the no form of this command to
delete a schedule. Variations of this command include:
schedule <name>
Additional subcommands are available once you have entered the Schedule Configuration mode:
absolute start <schedule> end <schedule>

periodic <day> [<time> to <time>]
periodic <day> <time> to <day> <time>
periodic <day> [<time> for <duration>]
periodic <day> <time> for <duration>
periodic <time> for <duration> <day>
periodic daily <time> to <time>
periodic daily <time> for <duration>
periodic weekday <time> to <time>
periodic weekday <time> for <duration>
periodic weekend <time> to <time>
periodic weekend <time> for <duration>
relative start-after <delay>
Syntax Description
<name> Specifies the name of the schedule.
absolute start end Indicates the schedule’s start and end time and date values.
<schedule> Specifies the start and end schedules. Schedules are expressed in the
format <time> <day> <month> <year> (for example, 08:15 2 February
2007).
<time> Time is expressed in the 24-hour format hours:minutes (hh:mm) (for
example, 08:15).
<day> The day of the month is expressed with a number. Range is 1 to 31.
<month> The name of the month can be spelled out or abbreviated.
<year> The year is expressed in the format yyyy (for example, 2007).
periodic Specifies the weekly behavior of the schedule by configuring start/end days,
times, and duration.
to Specifies the schedule’s start/end day and time.
for <duration> Specifies the schedule’s duration. Duration is expressed in the 24-hour
format hours:minutes (hh:mm).
daily Optional. Specifies recurring period to be every day of the week.
weekday Optional. Specifies recurring period to be Monday through Friday.
weekend Optional. Specifies recurring period to be Saturday and Sunday.
<time> Time is expressed in the 24-hour format hours:minutes (hh:mm) (for
example, 08:15).

<day> The day of the week can be spelled out or abbreviated.

relative start-after <delay> Specifies the time delay before the schedule becomes active. Valid range is
1 to 65535 seconds.
Default Values
By default, no schedules exist.
Functional Notes
Periodic schedules can be expressed in the format <day> <time> to <day> <time> (for example, periodic
monday 08:15 to wednesday 17:15), or up to 7 days can be entered (for example, periodic tuesday
wednesday thursday 08:15 to 17:15).
Command History
Release 16.1 Command was expanded to include the for parameter.
Usage Examples
The following example creates a schedule Closed and enters the Schedule Configuration mode:
(config)#schedule Closed
(config-schedule-Closed)#
The following example sets the start time in the schedule named Closed to 8:15 a.m. on February 2, 2007,
and sets the end time to 10:15 a.m. on April 2, 2007:
(config-schedule-Closed)#absolute start 08:15 2 february 2007 end 10:15 2 april 2007
The following example sets the recurring start and end day and time in the schedule named Closed to
Saturday from 8:15 a.m. to 5:15 p.m.:
(config-schedule-Closed)#periodic saturday 08:15 to 17:15
The following example sets the execution delay for the schedule named Closed to 30 seconds:
(config-schedule-Closed)#relative start-after 30
The following example sets the duration for the schedule named Closed to 30 minutes at 1:00 p.m. every
day of the week:
(config-schedule-Closed)#periodic daily 13:00 for 00:30

service password-encryption
Use the service password-encryption command to turn on global password protection. Use the no form
If you need to go back to a previous revision of the code (e.g., AOS Revision 10), this
command must be disabled first. Once the service is disabled, all necessary passwords
must be re-entered so that they are in the clear text form. If this is not done properly, you
will not be able to log back in to the unit after you revert to a previous revision that does
not support password encryption.
Syntax Description
No subcommands.
Default Values
By default, global password protection is disabled.
Command History
Functional Notes
When enabled, all currently configured passwords are encrypted. Also, any new passwords are encrypted
after they are entered. Password encryption is applied to all passwords, including passwords for user
name, Enable mode, Telnet/console, Point-to-Point Protocol (PPP), Border Gateway Protocol (BGP), and
authentication keys. When passwords are encrypted, unauthorized persons cannot view them in
configuration files since the encrypted form of the password is displayed in the running-config. While this
provides some level of security, the encryption method used with password encryption is not a strong form
of encryption so you should take additional network security measures.
You cannot recover a lost encrypted password. You must erase the startup-config and set a
new password.
Usage Examples
The following example enables password encryption for all passwords on the unit:
(config)#service password-encryption

snmp ifmib alias long

Use the snmp ifmib alias long command to configure the Simple Network Management Protocol (SNMP)
IF.MIB alias settings to allow an alias string to be up to 255 characters long. Use the no form of this
command to return to the default SNMP IF.MIB setting.
Syntax Description
No subcommands.
Default Values
By default, the maximum length of the SNMP IF.MIB alias is 64 characters.
Command History
Usage Examples
The following example enables a longer SNMP IF.MIB alias length:
(config)#snmp ifmib alias long

snmp-server chassis-id <string>

Use the snmp-server chassis-id command to specify an identifier for the Simple Network Management
Protocol (SNMP) server. Use the no form of this command to return to the default value.
Syntax Description
<string> Identifies the product using an alphanumeric string (up to 32 characters in
length).
Default Values
By default, the snmp-server chassis-id is set to Chassis ID.
Command History
Usage Examples
The following example configures a chassis ID of A432692:
(config)#snmp-server chassis-id A432692

snmp-server community
Use the snmp-server community command to specify a community string to control access to the Simple
Network Management Protocol (SNMP) information. Use the no form of this command to remove a
specified community. Variations of this command include:
snmp-server community <community>

snmp-server community <community> <listname>
snmp-server community <community> ro
snmp-server community <community> ro <listname>
snmp-server community <community> rw
snmp-server community <community> rw <listname>
snmp-server community <community> view <viewname>
snmp-server community <community> view <viewname> <listname>
snmp-server community <community> view <viewname> ro
snmp-server community <community> view <viewname> ro <listname>
snmp-server community <community> view <viewname> rw
snmp-server community <community> view <viewname> rw <listname>
Syntax Description
<community> Specifies the community string (a password to grant SNMP access).
<listname> Optional. Specifies an access control list (ACL) name used to limit access.
Refer to ip access-list extended <name> on page 815 and ip access-list
standard <name> on page 817 for more information on creating ACLs.
ro Optional. Grants read-only access, allowing retrieval of MIB objects.
rw Optional. Grants read-write access, allowing retrieval and modification of
MIB objects.
view <viewname> Optional. Specifies a previously defined view. Views defined objects
available to the community. For information on creating a new view, refer to
snmp-server view <name> <value> on page 1099.
Default Values
By default, there are no configured SNMP communities.
Command History
Release 9.1 Command was expanded to include the view parameter.
Usage Examples
The following example specifies a community named MyCommunity, specifies a previously defined view
named blockinterfaces, and assigns read-write access:
(config)#snmp-server community MyCommunity view blockinterfaces rw

snmp-server contact
Use the snmp-server contact command to specify Simple Network Management Protocol (SNMP) server
contact information. Use the no form of this command to remove a configured contact. Variations of this
command include:
snmp-server contact email <address>

snmp-server contact pager <number>
snmp-server contact phone <number>
snmp-server contact “<string>”
Syntax Description
email <address> Specifies email address for the SNMP server contact.
pager <number> Specifies pager number for the SNMP server contact.
phone <number> Specifies phone number for the SNMP server contact.
“<string>” Populates the sysContact string using an alphanumeric string enclosed in
quotation marks (up to 32 characters in length).
Default Values
Command History
Usage Examples
The following example specifies 6536999 for the pager number:
(config)#snmp-server contact pager 6536999

snmp-server enable traps

Use the snmp-server enable traps command to enable all Simple Network Management Protocol
(SNMP) traps available on your system. Use the no form of this command to disable SNMP traps.
snmp-server enable traps

snmp-server enable traps frame relay
snmp-server enable traps resource
snmp-server enable traps snmp
snmp-server enable traps voice
Syntax Description
frame relay Optional. Enables the Frame Relay notification traps.
resource Optional. Enables the resource utilization notification traps.
snmp Optional. Enables the SNMP notification traps.
The following traps are supported:
coldStart
warmStart
linkUp
linkDown
authenticationFailure
voice Optional. Enables voice notification traps.
Default Values
By default, there are no traps enabled.
Command History
Release 17.3 Command was expanded to include the Frame Relay.
Release 17.6 Command was expanded to include voice traps.
Release A2.04 Command was expanded to include resource traps.
Functional Notes
Resource utilization traps are configured by using the command resource-utilization on page 1069.
Usage Examples
The following example enables SNMP traps:
(config)#snmp-server enable traps snmp

snmp-server engineID local <hex string>

Use the snmp-server engineID local command to change the default and manually set the Simple
Network Management Protocol (SNMP) version 3 (v3) engine ID for the local machine. Use the no form
of this command to return to the default engine ID.
Syntax Description
<hex string> Defines the engine ID for the system. Engine IDs are the 12-octet
hexadecimal representation (24 characters using 0 through 9 and/or
a through f) defining a system on the management domain. Refer to the
Technology Review for more detailed information on engine ID octet
assignments.
SNMP v3 requires unique engine IDs for all systems in the management domain. Use the
default engine ID when possible to ensure the uniqueness of the numbers. Problems can
occur on a management network that contains duplicate engine IDs.
Default Values
By default, the local SNMP-server engine ID is 8000029803xxxxxxxxxxxx (where the string of Xs
represents the system medium access control (MAC) address).
Command History
Usage Examples
The following example changes the default engine ID for the local system to 80 00 02 98 00 00 00 00 00 00
01 (where 80 00 02 98 represents the Internet Assigned Numbers Authority (IANA) ID for ADTRAN and
00 00 00 00 00 00 01 arbitrarily represents the first system on the management domain):
(config)#snmp-server engineID local 8000029800000000000001
Technology Review
The SNMP v3 engine ID is a unique identifier for a system on a management domain. The default engine
ID contains 11 octets (in hexadecimal notation) that represent certain information about the system. The
default engine ID format is as follows:
Octets 1 to 4 Octet 5 Octets 6 to 11

03
IANA ID for the Identifies that octets 6 System MAC address
product manufacturer through 11 contain a
MAC address

The first 4 octets of the default engine ID for ADTRAN products is 80000298. Octets 1 through 4 represent
the SNMP private enterprise number (assigned by the IANA) for the product manufacturer. The leading bit
of octet 1 (the most significant bit) will always be a 1 for a default engine ID (making the leading character
in the hex string an 8). ADTRAN products use the IANA ID of 664 (which is 02 98 in hexadecimal notation).
Octet 5 is set to 03 to indicate that the engine ID uses a MAC address as the unique identifier. The last six
octets of the default engine ID for ADTRAN routers contain the MAC address for the Ethernet 0/1 interface
(for example, 00127905257c).
The snmp-server engineID local command overrides the default engine ID and replaces it with the first
24 characters of the user-entered string. Because the string is in hexadecimal notation, only numbers 0
through 9 and characters a through f are valid. If fewer than 24 characters are entered in the string, pad the
end of the entered string with zeros (least significant bits) until the 24-character string is complete. For
example, a user input of 8000029805 results in an engine ID of 800002980500000000000000.

snmp-server engineID remote <ip address> <string>

Use the snmp-server engineID remote command to identify a remote Simple Network Management
Protocol (SNMP) entity’s engine ID. The remote engine ID is necessary before SNMP version 3 (v3)
inform notifications can be acknowledged. For further information, refer to the command snmp-server user
on page 1096. Use the no form of this command to remove the remote SNMP entity’s engine ID.
Syntax Description
<ip address> Specifies the IP address for the remote SNMP device. IP addresses should
<string> Specifies the engine ID for the remote SNMP device.
Default Values
By default, there are no remote engine IDs identified.
Command History
Usage Examples
The following example identifies a remote SNMP device with an IP address of 10.10.12.2 and an engine ID
of 80000298000000A0C8000001:
(config)#snmp-server engineID remote 10.10.12.2 80000298000000A0C8000001

snmp-server group
Use the snmp-server group command to specify a new Simple Network Management Protocol (SNMP)
group to control access to SNMP information. Use the no form of this command to remove a specified
group. Variations of this command include:
snmp-server group <groupname> v1 [read <name> | write <name> | notify <name> |

access <listname>]
snmp-server group <groupname> v2c [read <name> | write <name> | notify <name> |
access <listname>]
snmp-server group <groupname> v3 [auth | auth read <name> | auth write <name> | auth notify
<name> | auth access <listname>]
snmp-server group <groupname> v3 [noauth | noauth read <name> | noauth write <name> | noauth
notify <name> | noauth access <listname>]
snmp-server group <groupname> v3 [priv | priv read <name> | priv write <name> | priv notify
<name> | priv access <listname>]
Syntax Description
<groupname> Specifies the name of the SNMP group (32 characters maximum).
v1 Uses SNMP version 1 security model.
v2c Uses SNMP version 2c security model.
v3 Uses SNMP version 3 user-based security model (USM).
auth In version 3, indicates that authentication is used.
noauth In version 3, indicates that no authentication is used.
priv In version 3, indicates that privacy authentication is used.
read <name> Specifies a read-view entry (32 characters maximum).
write <name> Specifies a write-view entry (32 characters maximum).
notify <name> Specifies a notify-view entry (32 characters maximum).
access <listname> Specifies an access control list (ACL) entry.
Default Values
If no views are specified, the system automatically assigns default read- and notify-views that have no
restrictions.
Command History
Usage Examples
The following example defines a group called securityV3auth using version 3 security model,
authentication, and no ACL to verify:
(config)#snmp-server group securityV3auth v3 auth

snmp-server host
Use the snmp-server host command to configure the host to receive Simple Network Management
Protocol (SNMP) notifications. Use the no form of this command to remove a specified host. Variations of
snmp-server host <ip address> informs version 1 <community>

snmp-server host <ip address> informs version 1 <community> snmp
snmp-server host <ip address> informs version 2c <community>
snmp-server host <ip address> informs version 2c <community> snmp
snmp-server host <ip address> informs version 3 auth <community>
snmp-server host <ip address> informs version 3 auth <community> snmp
snmp-server host <ip address> informs version 3 noauth <community>
snmp-server host <ip address> informs version 3 noauth <community> snmp
snmp-server host <ip address> informs version 3 priv <community>
snmp-server host <ip address> informs version 3 priv <community> snmp
snmp-server host <ip address> traps <community>
snmp-server host <ip address> traps <community> frame-relay
snmp-server host <ip address> traps version 1 <community>
snmp-server host <ip address> traps version 1 <community> snmp
snmp-server host <ip address> traps version 2c <community>
snmp-server host <ip address> traps version 2c <community> snmp
snmp-server host <ip address> traps version 3 auth <community>
snmp-server host <ip address> traps version 3 auth <community> snmp
snmp-server host <ip address> traps version 3 noauth <community>
snmp-server host <ip address> traps version 3 noauth <community> snmp
snmp-server host <ip address> traps version 3 priv <community>
snmp-server host <ip address> traps version 3 priv <community> snmp
Syntax Description
<community> Specifies the community string (used as a password) (16 characters
maximum) for authorized agents to obtain access to SNMP information.
<ip address> Specifies the IP address of the SNMP host that receives the SNMP
information. IP addresses should be expressed in dotted decimal notation
(for example, 10.10.10.1).
frame-relay Optional. Enables SNMP Frame Relay traps for the specified host.
informs Enables informs to this host.
The following traps are supported:
coldStart
warmStart
linkUp
linkDown
authenticationFailure
snmp Optional. Enables a subset of traps specified in RFC 1157.

traps Enables traps to this host. If the version is not specified, version 1 is used.
version 1 Uses SNMP version 1 security model.
version 2c Uses SNMP version 2c security model.
version 3 Uses SNMP version 3 user-based security model (USM).
auth In version 3, indicates that authentication is used.
noauth In version 3, indicates that no authentication is used.
priv In version 3, indicates that privacy authentication is used.
Default Values
Command History
Release 13.1 Command was expanded to include the informs options.
Release 17.6 Command was expanded to include the frame-relay parameter.
Usage Examples
The following example sends all SNMP traps to the host at address 190.3.44.69 and community string
MyCommunity using SNMP version 2c:
(config)#snmp-server host 190.3.44.69 traps version 2c MyCommunity snmp

snmp-server inform
Use the snmp-server inform command to set the number of retry attempts for a response and set the
amount of time to wait for a response before allowing a new request. Use the no form of this command to
return to the default setting. Variations of this command include the following:
snmp-server inform retries <number>

snmp-server inform timeout <value>
Syntax Description
retries <number> Specifies number of retries for a response. The range is from 1 to 100.
timeout <value> Specifies time (in seconds) to wait for a response. The range is from 1 to
1000 seconds.
Default Values
By default, the retry count is set to 3 and the timeout is set to 5 seconds.
Command History
Usage Examples
The following example sets the retry count to 10:
(config)#snmp-server inform retries 10

snmp-server location “<string>”

Use the snmp-server location command to specify the Simple Network Management Protocol (SNMP)
system location string. Use the no form of this command to return to the default value.
Syntax Description
“<string>” Populates the system location string using an alphanumeric string enclosed
in quotation marks (up to 32 characters in length).
Default Values
By default, the snmp-server location is set to ADTRAN.
Command History
Usage Examples
The following example specifies a location of 5th Floor Network Room:
(config)#snmp-server location “5th Floor Network Room”

snmp-server management-url <url>

Use the snmp-server management-url command to specify the uniform resource locator (URL) for the
device’s management software. Use the no form of this command to remove the management URL.
Syntax Description
<url> Specifies the URL for the management software.
Default Values
By default, no URL is defined.
Command History
Usage Examples
The following example specifies the URL http://www.mywatch.com as the device’s management
software:
(config)#snmp-server management-url http://www.mywatch.com

snmp-server management-url-label <label>

Use the snmp-server management-url-label command to specify a label for the uniform resource locator
(URL) of the device’s management software. Use the no form of this command to remove the label.
Syntax Description
<label> Specifies a label for the URL of the management software (maximum length
255 characters).
Default Values
Command History
Usage Examples
The following example specifies the label watch for the management software:
(config)#snmp-server management-url-label watch

snmp-server source-interface <interface>

Use the snmp-server source-interface command to specify a source interface for Simple Network
Management Protocol (SNMP) traffic (including traps and get/set requests) originated by the unit. The IP
address of the specified interface will be used to source all SNMP traffic. Use the no form of this command
to remove the specified interface.
Syntax Description
<interface> Specifies the interface that should originate SNMP traffic. Specify an
use ppp 1; for an ATM subinterface, use atm 1.1; and for a wireless virtual
access point, use dot11ap 1/1.1. Type snmp-server source-interface ?
Default Values
By default, there is no source-interface defined.
Command History
interface.
Usage Examples
The following example specifies that the ethernet 0/1 should be the source for all SNMP traps and get/set
requests:
(config)#snmp-server source-interface ethernet 0/1

snmp-server user
Use the snmp-server user command to configure Simple Network Management Protocol (SNMP) users to
control access to SNMP information. Use the no form of this command to remove a user from the specified
SNMP group. Variations of this command include:
snmp-server user <username> <groupname> v1

snmp-server user <username> <groupname> v1 access <listname>
snmp-server user <username> <groupname> v2c
snmp-server user <username> <groupname> v2c access <listname>
snmp-server user <username> <groupname> v3
snmp-server user <username> <groupname> v3 access <listname>
snmp-server user <username> <groupname> v3 auth md5 <auth password>
snmp-server user <username> <groupname> v3 auth md5 <auth password> access <listname>
snmp-server user <username> <groupname> v3 auth md5 <auth password> priv des <priv password>
snmp-server user <username> <groupname> v3 auth md5 <auth password> priv des <priv password>
access <listname>
snmp-server user <username> <groupname> v3 auth sha <auth password>
snmp-server user <username> <groupname> v3 auth sha <auth password> access <listname>
snmp-server user <username> <groupname> v3 auth sha <auth password> priv des <priv password>
snmp-server user <username> <groupname> v3 auth sha <auth password> priv des <priv password>
access <listname>
snmp-server user <username> <groupname> remote <host> v3
snmp-server user <username> <groupname> remote <host> v3 access <listname>
snmp-server user <username> <groupname> remote <host> v3 auth md5 <auth password>
access <listname>
priv des <priv password>
priv des <priv password> access <listname>
snmp-server user <username> <groupname> remote <host> v3 auth sha <auth password>
priv des <priv password>
access <listname>
priv des <priv password> access <listname>
If service password-encryption is enabled, the running configuration changes to include

the keyword encrypted before each password entry, which is masked. Refer to service
password-encryption on page 1079.

Syntax Description
access <listname> Specifies an access control list (ACL) entry.
<groupname> Specifies the name of the group the user belongs to.
<username> Specifies the name of the user.
v1 Uses SNMP version 1 security model.
v2c Uses SNMP version 2c security model.
v3 Uses SNMP version 3 (user-based security model).
Options if version 3 is used:
auth Indicates that authentication is used.
des Use the CBC-DES privacy authentication algorithm.
md5 Uses the HMAC-MD5-96 authentication level.
priv Indicates that privacy authentication is used.
remote <host> Optional. Identifies the host name or IP address of a remote SNMP entity to
which the user belongs. The remote host is necessary for
acknowledgement of SNMP version 3 notifications.
sha Uses the HMAC-SHA-96 authentication level.
<auth password> A password string used to build the key for the authentication level.
<priv password> A password string used for data encryption between the host and agent.
encrypted Indicates service password encryption is enabled. Precedes the encrypted

password. (Refer to the note on the previous page.)
It is necessary to configure the SNMP engine ID before configuration of the remote users
for a particular agent can be completed. Refer to the command snmp-server engineID
remote <ip address> <string> on page 1087 for instructions in setting the engine ID with
the remote option.
Default Values
Command History
Release 14.1 Command was expanded to include the remote <host> parameter.
Usage Examples
The following example enters a new user named BobbyW and assigns the user to a group called
securityV3auth using version 3 security model and authentication method message digest 5 (MD5) with a
password of passWORD6243 and no ACL to verify:
(config)#snmp-server user BobbyW securityV3auth v3 auth md5 passWORD6243

Technology Review
SNMP server users are configured and attached to a specified group with an SNMP version. The SNMP
version defines the security model of the group, with SNMP version 1 (SNMP v1) being the least secure
and SNMP version 3 (SNMP v3) the most secure. Groups also define the read, write, notify, and view
access for each user that resides in the group.
Trap notifications in SNMP v1 and SNMP version 2 (SNMP v2) are sent once and do not require an
acknowledgement upon receipt. With SNMP v3, a new form of notification type was introduced, called an
inform. Unlike a trap sent with SNMP v1/v2, an inform requires a response be sent to the originating entity.
If the originator of the inform notification does not receive the response before a specified timeout, the
originator can resend until an acknowledgement response is received or a specified retry is reached.
Sending informs require that the originator of the inform know the user, engine ID, security parameters,
and belong to a group that grants access to the information.
SNMP v3 uses services such as authentication, privacy, and access control to provide a higher level of
security not present with v1 or v2. Of these new services, identifying an SNMP server user on a remote
entity is necessary to receive and originate notifications, and also to generate and respond to commands.
Remote users are specified with an IP address or port number for the remote SNMP entity where the user
resides. Configuration of the SNMP remote engine ID is necessary before SNMP v3 inform notifications
can be acknowledged. This is accomplished through use of the snmp-server engineID remote command.
The remote entity’s SNMP engine ID is used for password authentication and privacy digests. The
configuration acknowledgments of informs will fail if the remote engine ID is not configured first. A
management device must know about the user, the engine ID of the device, and security parameters such
as authentication, passwords, and security level in order for the command to be processed by the
receiving agent.

snmp-server view <name> <value>

Use the snmp-server view command to create or modify a Simple Network Management Protocol
(SNMP) view entry. Use the no form of this command to remove an entry. Variations of this command
include:
snmp-server view <name> <value> excluded

snmp-server view <name> <value> included
Syntax Description
<name> Specifies a label for the view record being created. The name is a record
reference.
<value> Specifies the object identifier (OID) to include or exclude from the view. To
identify the subtree, specify a string using numbers, such as 1.4.2.6.8.
Replace a single subidentifier with the asterisk (*) to specify a subtree
family.
excluded Specifies a view to be excluded.
included Specifies a view to be included.
Default Values
Command History
Usage Examples
The snmp-server view command can include or exclude a group of OIDs. The following example shows
how to create a view (named blockInterfaces) to exclude the OID subtree family 1.3.3.1.2.1.2:
(config)#snmp-server view blockInterfaces 1.3.3.1.2.1.2.* excluded
The following example shows how to create a view (named block) to include a specific OID:
(config)#snmp-server view block 1.3.3.1.2.1.2. included

sntp retry-timeout <value>

Use the sntp retry-timeout command to set the amount of time to wait for a response before allowing a
new request. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies time (in seconds) to wait for a response before retrying. The range
is from 3 to 4294967294 seconds.
Default Values
By default, the retry timeout is set to 5 seconds.
Command History
Usage Examples
The following example sets the Simple Network Time Protocol (SNTP) retry timeout to 10 seconds:
(config)#sntp retry-timeout 10

sntp server
Use the sntp server command to set the host name of the Simple Network Time Protocol (SNTP) server,
as well as the version of SNTP to use. SNTP is an abbreviated version of the Network Time Protocol
(NTP). SNTP is used to set the time of the AOS product over a network. The SNTP server usually serves
the time to many devices within a network. Use the no form of this command to return to the default
sntp server [<hostname> | <ip address>]

sntp server [<hostname> | <ip address>] version <number>
Syntax Description
<hostname> Specifies the host name of the SNTP server.
<ip address> Specifies the IP address of the SNTP server. IP addresses should be
version <number> Optional. Specifies which NTP version is used. Valid range is 1 to 3.
Default Values
By default, NTP version is set to 1.
Command History
Usage Examples
The following example sets the SNTP server to time.nist.gov using SNTP version 1 (the default version):
(config)#sntp server time.nist.gov
The following example sets the SNTP server as time.nist.gov. All requests for time use version 2 of the
SNTP:
(config)#sntp server time.nist.gov version 2

sntp wait-time <value>

Use the sntp wait-time command to set the time between updates from the time server. Use the no form of
this command to return to the default setting.
Syntax Description
<value> Specifies time (in seconds) between updates. Range is 10 to 4294967294
seconds.
Default Values
By default, the wait time is set to 86400 seconds (1 day).
Command History
Usage Examples
The following example sets the Simple Network Time Protocol (SNTP) wait time to two days:
(config)#sntp wait-time 172800

spanning-tree edgeport bpdufilter default

Use the spanning-tree edgeport bpdufilter default command to enable the bridge protocol data unit
(BPDU) filter on all ports by default. Use the no form of this command to disable the setting.
Syntax Description
No subcommands.
Default Values
By default, spanning-tree edgeport bpdufilter default is disabled.
Command History
Functional Notes
The BPDU filter blocks any BPDUs from being transmitted and received on an interface. This can be
overridden on an individual port.
Usage Examples
The following example enables the bpdufilter on all ports by default:
(config)#spanning-tree edgeport bpdufilter default
To disable the BPDU filter on a specific interface, issue the appropriate commands for the given interface
using the following commands as an example:

(config-eth 0/1)#spanning-tree edgeport bpdufilter disable

spanning-tree edgeport bpduguard default

Use the spanning-tree edgeport bpduguard default command to enable the bridge protocol data unit
(BPDU) guard on all ports by default. Use the no form of this command to disable the setting.
Syntax Description
No subcommands.
Default Values
Disabled by default.
Command History
Functional Notes
The bpduguard blocks any BPDUs from being received on an interface. This can be overridden on an
individual port.
Usage Examples
The following example enables the BPDU guard on all ports by default.
(config)#spanning-tree edgeport bpduguard default
To disable the BPDU guard on a specific interface, issue the appropriate commands for the given interface
using the following commands as an example:

(config-eth 0/1)#spanning-tree edgeport bpduguard disable

spanning-tree edgeport default

Use the spanning-tree edgeport default command to configure all ports to be edgeports by default. Use
the no form of this command to disable the setting.
Syntax Description
No subcommands.
Default Values
Disabled by default.
Command History
Usage Examples
The following example configures all interfaces running spanning tree to be edgeports by default:
(config)#spanning-tree edgeport default
An individual interface can be configured to not be considered an edgeport. For example:

(config-eth 0/1)#spanning-tree edgeport disable
or

(config-eth 0/1)#no spanning-tree edgeport

spanning-tree forward-time <value>

Use the spanning-tree forward-time command to specify the delay interval (in seconds) when forwarding
spanning-tree packets. Use the no form of this command to return to the default interval.
Syntax Description
<value> Specifies the forwarding delay interval in seconds. Range is 4 to
30 seconds.
Default Values
By default, the forwarding delay is set to 15 seconds.
Command History
Usage Examples
The following example sets the forwarding time to 18 seconds:
(config)#spanning-tree forward-time 18

spanning-tree hello-time <value>

Use the spanning-tree hello-time command to specify the delay interval (in seconds) between hello
bridge protocol data units (BPDUs). To return to the default interval, use the no form of this command.
Syntax Description
<value> Specifies the delay interval (in seconds) between hello BPDUs. Range is
0 to 1000000 seconds.
Default Values
By default, the delay is set to 2 seconds.
Command History
Usage Examples
The following example configures a spanning-tree hello-time interval of 10000 seconds:
(config)#spanning-tree hello-time 10000

spanning-tree max-age <value>

Use the spanning-tree max-age command to specify the interval (in seconds) the spanning tree will wait
to receive bridge protocol data units (BPDUs) from the root bridge before assuming the network has
changed (thus re-evaluating the spanning-tree topology). Use the no form of this command to return to the
default interval.
Syntax Description
<value> Specifies the wait interval (in seconds) between received BPDUs (from the
root bridge). Range is 6 to 40 seconds.
Default Values
By default, the wait interval is set at 20 seconds.
Command History
Usage Examples
The following example configures a wait interval of 35 seconds:
(config)#spanning-tree max-age 35

spanning-tree mode
Use the spanning-tree mode command to choose a spanning tree mode of operation. Use the no form of
spanning-tree mode rstp

spanning-tree mode stp
Syntax Description
rstp Enables Rapid Spanning Tree Protocol (RSTP).
stp Enables spanning-tree protocol.
Default Values
By default, spanning-tree mode is set to rstp.
Command History
Usage Examples
The following example sets the spanning-tree mode to rstp:
(config)#spanning-tree mode rstp

spanning-tree pathcost method

Use the spanning-tree pathcost method command to select a short or long pathcost method used by the
spanning-tree protocol. Use the no form of this command to return to the default setting. Variations of this
command include:
spanning-tree pathcost method long

spanning-tree pathcost method short
Syntax Description
long Specifies a long pathcost method.
short Specifies a short pathcost method.
Default Values
By default, spanning-tree pathcost is set to short.
Command History
Usage Examples
The following example specifies that the spanning-tree protocol use a long pathcost method:
(config)#spanning-tree pathcost method long

spanning-tree priority <value>

Use the spanning-tree priority command to set the priority for spanning-tree interfaces. The lower the
priority value, the higher the likelihood the configured spanning-tree interface will be the root for the
bridge group. To return to the default bridge priority value, use the no form of this command.
Syntax Description
<value> Sets a priority value for the bridge interface. Configuring this value to a low
number increases the interface’s chance of being the root. Therefore, the
maximum priority level would be 0. Range is 0 to 65535.
Default Values
By default, the priority level is set to 32768.
Command History
Usage Examples
The following example sets spanning-tree priority to the maximum level:
(config)#spanning-tree priority 0

stack
Use the stack command to configure switch-stacking options. Use the no form of this command to disable
this feature. Variations of this command include:
stack master
stack master <vlan id>
stack master <vlan id> <ip address> <subnet mask>
stack member <mac address>
stack member <mac address> <unit id>
stack vlan <vlan id>
Syntax Description
master Specifies that the unit will be the master of the stack.
<vlan id> Specifies the virtual local area network (VLAN) ID the stack will use for
communication.
<ip address> Configures the network mask of the private IP network. IP addresses
(network). Subnet masks can be expressed in dotted decimal notation (for
example, 255.255.255.0) or as a prefix length (for example, /24).
member Adds a switch to the stack.
<mac address> Specifies a valid 48-bit medium access control (MAC) address of the unit
being added. MAC addresses should be expressed in the following format
<unit id> Specifies the unit ID of the switch being added.
vlan <vlan id> Specifies the VLAN ID of the stack of which you are a member.
Default Values
By default, stack VLAN is 2386, and the stack IP network is 169.254.0.0 /24.
Command History
Usage Examples
The following example configures the unit to be the stack master and use the default stack VLAN and IP
network.
(config)#stack master 2000
The following example configures the unit to be the stack master and use VLAN 2000 as the management
VLAN and 192.168.1.0 /24 as the management network.
(config)#stack master 2000 192.168.1.0 /24

The following example adds the switch with the CPU MAC address 00:A0:C8:00:8C:20 to the stack; also
assigns the number 2 as the new stack member's unit ID.
(config)#stack member 00:A0:C8:00:8C:20 2
The following example specifies that this unit is in the stack using VLAN 2000 as its management VLAN;
also specifies that this unit is in stack member mode (not a stack-master).
(config)#stack vlan 2000

statistics rate-interval <value>

Use the statistics rate-interval command to specify the interval (in seconds) to receive interface statistics.
Use the no form of this command to return to the default interval.
Syntax Description
<value> Specifies the wait interval. Range is 30 to 600 seconds (in 30 second
increments).
Default Values
By default, the wait interval is set at 300 seconds.
Command History
Usage Examples
The following example configures a wait interval of 90 seconds:
(config)#statistics rate-interval 90

system mtu <size>

Use the system mtu command to set the maximum transmission unit (MTU) size for all ports on the AOS
device and allow Ethernet frames larger than 1518 bytes (known as jumbo frames) to pass. Use the no
form of this command to return to the default.
Syntax Description
<size> Indicates the transmission size in bytes. The valid range is 1518 to the
maximum byte size allowed for the unit being configured.
The MTU size specified does not include an 802.1Q virtual local area network (VLAN) tag.
For example, if the MTU size is set to allow 1518 bytes, an 802.1Q tagged packet of 1522
bytes would still be accepted.
Default Values
By default, the MTU size is 1518.
Changing the default value (1518) in a switch already installed in a network could cause
traffic disruption.
Command History
Usage Examples
The following example sets the maximum transmission unit size for all ports on the device to 9216 bytes:
(config)#system mtu 9216

tacacs-server
Use the tacacs-server command to configure several terminal access controller access-control system plus
(TACACS+) parameters for all TACACS+ servers on the network. Most of these global settings can be
overridden on a per-server basis (using the command tacacs-server host on page 1117). Use the no form of
this command to return to the default setting. Variations of this command include the following:
tacacs-server key <key>

tacacs-server packet maxsize <value>
tacacs-server timeout <value>
Syntax Description
key <key> Specifies the encryption key used by all TACACS+ servers. This is a
global setting; however, it can be overridden on a per-server basis.
packet maxsize <value> Specifies the maximum packet size that can be sent to any TACACS+
server. Packet maxsize range is 10240 to 65535 kilobytes.
timeout <value> Specifies the time (in seconds) that the AOS unit will wait for the
server’s reply before declaring an error. The time range is 1 to 1000
seconds. This is a global setting; however, it can be overridden on a
per-server basis.
Default Values
By default, there is no key specified for TACACS+ servers, the packet maxsize is set to 10240 kb, and the
TACACS+ server timeout is set to 5 seconds.
Command History
Usage Examples
The following example sets a timeout limit of 60 seconds for all TACACS+ servers:
(config)#tacacs-server timeout 60

tacacs-server host
Use the tacacs-server host command to specify the parameters for a terminal access controller
access-control system plus (TACACS+) server. Use the no form of this command to return to the default
setting. Variations of this command include the following:
tacacs-server host <hostname> | <ip address>

tacacs-server host <hostname> | <ip address> key <key>
tacacs-server host <hostname> | <ip address> port <port>
tacacs-server host <hostname> | <ip address> timeout <value>
Each parameter after <hostname | ip address> specifies the characteristics of the

individual TACACS+ server. Parameters can be entered in a single command line, in any
order, but each may only be used once.
Syntax Description
<hostname> | <ip address> Specifies the server to configure. IP addresses should be expressed
in dotted decimal notation (for example, 10.10.10.1). If a host name is
used, a domain naming system (DNS) server should be learned by
the AOS device using Dynamic Host Configuration Protocol (DHCP),
Point-to-Point Protocol (PPP), or specified in the Global Configuration
mode with the command ip name-server on page 898.
key <key> Specifies the encryption key used by the TACACS+ server. This
command overrides the global TACACS+ key setting (set with the
command tacacs-server on page 1116). This command must be
entered last in the command line because everything after the key
parameter is read as the new key.
port <port> Specifies the Transmission Control Protocol (TCP) port used by the
TACACS+ server. Range is 1 to 65535.
timeout <value> Specifies the time to wait (in seconds) for the server to reply to
requests. Range is 1 to 1000 seconds.
Default Values
By default, the TACACS+ server uses TCP port 49. By default, the key and timeout values are the values
set by the command tacacs-server on page 1116.
Command History
Functional Notes
At a minimum, the address (IP or host name) of the server must be given. The other parameters can be
entered in any order (except the key parameter) and, if the parameters are not specified, they will take
default values or fall back on the global TACACS+ server’s default settings (set using the command
tacacs-server on page 1116).

Usage Examples
The following example specifies that the TACACS+ server at IP address 10.10.10.4 uses the global key
setting (left unspecified), a timeout value of 10 seconds, and the default TCP port (left unspecified):
(config)#tacacs-server host 10.10.10.4 timeout 10

telnet

Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
>enable
#telnet 10.200.4.15
User Access Login:
Password:

>enable
#telnet 10.200.4.15 port 8010
User Access Login:
Password:

thresholds
Use the thresholds command to specify DS1 performance counter thresholds. Use the no form of this
thresholds BES [15Min | 24Hr] <number>

thresholds CSS [15Min | 24Hr] <number>
thresholds DM [15Min | 24Hr] <number>
thresholds ES [15Min | 24Hr] <number>
thresholds LCV [15Min | 24Hr] <number>
thresholds LES [15Min | 24Hr] <number>
thresholds PCV [15Min | 24Hr] <number>
thresholds SEFS [15Min | 24Hr] <number>
thresholds SES [15Min | 24Hr] <number>
thresholds UAS [15Min | 24Hr] <number>
Threshold settings are applied to ALL DS1s.
Syntax Description
BES Specifies the bursty errored seconds threshold.
CSS Specifies the controlled slip seconds threshold.
DM Specifies the degraded minutes threshold.
ES Specifies the errored seconds threshold.
LCV Specifies the line code violations threshold.
LES Specifies the line errored seconds threshold.
PCV Specifies the path coding violations threshold.
SEFS Specifies the severely errored framing seconds threshold.
SES Specifies the severely errored seconds threshold.
UAS Specifies the unavailable seconds threshold.
15Min Specifies that the threshold you are setting is for the counter’s 15-minute
statistics.
24Hr Specifies that the threshold you are setting is for the counter’s 24-hour
statistics.
<number> Specifies the maximum occurrences allowed for this error type. Once a
threshold is exceeded, an event is sent to the console specifying the
appropriate counter. Additionally, if Simple Network Management Protocol
(SNMP) traps are enabled, the unit will send a trap with the same
information as the console event.

Default Values
The default values for this command are as follows:
thresholds BES 15Min 10

thresholds BES 24Hr 100
thresholds CSS 15Min 1
thresholds CSS 24Hr 4
thresholds DM 15Min 1
thresholds DM 24Hr 4
thresholds ES 15Min 65
thresholds ES 24Hr 648
thresholds LCV 15Min 13340
thresholds LCV 24Hr 133400
thresholds LES 15Min 65
thresholds LES 24Hr 648
thresholds PCV 15Min 72
thresholds PCV 24Hr 691
thresholds SEFS 15Min 2
thresholds SEFS 24Hr 17
thresholds SES 15Min 10
thresholds SES 24Hr 100
thresholds UAS 15Min 10
thresholds UAS 24Hr 10
Command History
Usage Examples
The following example sets the threshold for the 15-minute and 24-hour bursty errored seconds counter to
25 and 200, respectively:
(config)#thresholds BES 15Min 25

(config)#thresholds BES 24Hr 200

timing-source
Use the timing-source command to configure the timing source used for reference timing. Use the no
form of this command to return to the default setting. Variations of this command include the following:
timing-source internal
timing-source internal secondary
timing-source t1 <interface id>
timing-source t1 <interface id> secondary
Syntax Description
internal Configures the unit to provide timing using the internal 1.544 MHz clock
generator.
t1 <interface id> Configures the unit to recover clocking from the specified T1 or DSX-1
interface.
secondary Optional. Signifies that the clock source specified in the command is to be
the secondary clock source.
Default Values
By default, the primary clock source is set to internal.
Command History
Functional Notes
If both the primary and secondary clock sources fail, the unit automatically switches to internal timing.
Usage Examples
The following example configures the unit to use an internal timing source:
(config)#timing-source internal
The following examples set the t1 0/1 interface as the primary timing source and the t1 0/2 interface as the
secondary timing source:
(config)#timing-source t1 0/1
(config)#timing-source t1 0/2 secondary

track <name>
Use the track command to create a track as part of network monitoring. This command is also used to
enter into the Network Monitoring Track command set once a track is created. These additional commands
are covered in Network Monitor Track Command Set on page 2356. Use the no form of this command to
delete the track.
Syntax Description
<name> Specifies the name of the track being created.
Default Values
By default, there are no tracks configured.
Command History
Functional Notes
Track objects can be associated with probes to monitor their states. Upon a change in the probe state, the
probe sends an event to any track registered with the probe. In response, the track performs the action
indicated.
Track objects are associated with probes by using the commands test if on page 2360 and test list on page
2364.
Usage Examples
The following example creates an track called track_a:
>enable
#configure terminal
(config)#track track_a
(config-track-track_a)#
Technology Review
Tracks are objects created to monitor other objects for a change in their state. The tracks can be
configured to perform a specific action based upon the second object state detected. Association between
a track and another object (for example, a probe, schedule, or interface) occurs through referencing the
second object in the track’s configuration. Once the track is registered with the second object, whenever a
change occurs with that object’s state, an event is sent to the track.
Additional configuration commands are available for creating probes. These are explained in the Network
Monitor Probe Command Set on page 2319.

username <username> password <password>

Use the username password command to configure the user name and password to use for all protocols
requiring a user name-based authentication system, including File Transfer Protocol (FTP) server
authentication, line (login local-user list), and Hypertext Transfer Protocol (HTTP) access. Use the no
form of this command to remove a user name and password.
Syntax Description
<username> Specifies a user name using an alphanumerical string up to 30 characters in
length (the user name is case sensitive).
<password> Specifies a password using an alphanumerical string up to 30 characters in
length (the password is case sensitive).
Default Values
By default, there is no established user name and password.
Command History
Functional Notes
All users defined using the username/password command are valid for access to the unit using the login
local-userlist command.
Usage Examples
The following example creates a user name of ADTRAN with password ADTRAN:
(config)#username ADTRAN password ADTRAN

username <username> portal-list <name> password <password>

Use the username portal-list password command to associate a portal list with a user name. Use the
command portal-list <name> <portal1 portal2 portal3...> on page 1048 to define the portal list. Use the
no form of this command to remove the portal list.
Syntax Description
<name> Specifies the name of the portal list assigned to this user.
<password> Specifies the use of a password using an alphanumerical string up to
30 characters in length (the password is case sensitive).
Default Values
By default, no portal lists are assigned to user names.
Command History
Release A1 Command was expanded to include the password parameter.
Usage Examples
The following example associates the portal list engineers with the user name ADTRAN and the
password word:
(config)#username ADTRAN portal-list engineers password word

vlan <vlan id>

Use the vlan command to enter the Virtual Local Area Network (VLAN) Configuration mode. Use the no
form of this command to remove a VLAN ID. Refer to the VLAN Command Set on page 2148 for more
information.
Syntax Description
<vlan id> Specifies a valid VLAN ID. Range is 1 to 4094.
Default Values
Command History
Usage Examples
The following example enters the VLAN Configuration mode for VLAN 1:
(config)#vlan 1
(config-vlan 1)#

voice alias <name> equals <number>

Use the voice alias equals command to configure the name and number for the call routing alias. This
feature allows a single call destination to be reached by an alternate name and number. Use the no form of
Syntax Description
<name> Specifies the alias name to describe the call destination.
<number> Assigns the alias number to mask the original number.
Default Values
Command History
Usage Examples
The following example activates the Lobby voice alias at extension 4100:
(config)#voice alias Lobby equals 4100

voice ani-list <name>

Use the voice ani-list command to create a list of automatic number identification (ANI) information and
enter the ANI list configuration mode. Use the no form of this command to remove the ANI list.
Additional subcommands are available once you have entered the ANI list configuration mode:
ani <template>
Syntax Description
<name> Specifies the name of the ANI list.
ani <template> Specifies the ANI digits of the calling party to add to the ANI list. Digits
include a combination of wildcards and numerical digits. Refer to the
Functional Notes of this command for more information on using wildcards.
Default Values
By default, no ANI lists are configured.
Command History
Functional Notes
ANI lists are used to permit or deny specific calling parties from accessing trunk groups to which the ANI
list is applied.
The available wildcards for this command are:

Do not use dashes, commas, spaces, etc., inside the brackets. Commas are implied between
numbers in the brackets.
The special characters ( ), -, + are always ignored.
Examples: 1) 555-81xx matches 555-8100 to 555-8199.

2) 555-812[012] matches 555-8120 to 555-8122.
3) Nxx-xxxx matches 7 digit local.
4) 1-Nxx-Nxx-xxxx matches long distance calls in North America.

Usage Examples
The following example creates an ANI list called TEST1 and specifies which numbers are included in the
ANI list:
(config)#voice ani-list TEST1

(config-ani-list-TEST1)#ani 555-81xx

voice autoattendant
Use the voice autoattendant command to configure the auto attendant options for the system. Use the no
form of the commands to disable the setting. For more voice auto attendant options, refer to voice
call-appearance-mode on page 1132. Variations of this command include the following:
voice autoattendant <name>

voice autoattendant <name> extension <number>
voice autoattendant alias <name>
voice autoattendant did <number>
voice autoattendant extension <number>
Syntax Description
<name> Specifies a name for this auto attendant.
alias <name> Specifies an alias name to use as an alternate when accessing the auto
attendant.
did <number> Configures the direct inward dialing (DID) number to assign to the auto
attendant.
extension <number> Specifies the extension for auto attendant system login access.
Default Values
Command History
Usage Examples
The following example configures the aOperator as an alias for the auto attendant:
(config)#voice autoattendant alias aOperator

voice call-appearance-mode
Use the voice call-appearance-mode command to configure the unit to allow single or multiple call
appearances to user account phones. Use the no form of this command to return to the default setting.
voice call-appearance-mode multiple

voice call-appearance-mode single
Syntax Description
multiple Allows multiple call appearances. For analog phones, this will be limited to
two; for Session Initiation Protocol (SIP) phones, the number allowed
depends on the model of the phone.
single Allows only a single call appearance.
Default Values
By default, this is set to single.
Command History
Functional Notes
Each incoming call is classified as a call appearance. For example, call waiting supports two call
appearances simultaneously. Without call waiting, only one call appearance is supported at a time.
Usage Examples
The following example sets the unit to allow multiple call appearances:
(config)#voice call-appearance-mode multiple

voice callerid-type <method>

Use the voice callerid-type command to specify the caller ID method for the system. Select the caller ID
type that is required by your telecommunications provider. Use the no form of this command to disable the
setting.
Syntax Description
<method> Specifies the type of caller ID to use with the system. The available options
are:
• Australia_FSK
• Belgium_FSK
• Canada_Stentor
• Denmark_DTMF
• Finland_DTMF
• Italy_FSK
• Netherlands_DTMF
• Norway_FSK
• Sweden_DTMF
• UK_BT
• UK_CCA
• US_Bellcore
Default Values
By default, the caller ID type is set to US_Bellcore.
Command History
Release A2 Command was expanded to include Australia.
Usage Examples
The following example specifies using the Italian method for the caller ID type:
(config)#voice callerid-type Italy_FSK

voice cause-code-map
Use the voice cause-code-map command to configure the cause code and Session Initiation Protocol (SIP)
message numbers for the primary rate interface (PRI). Cause codes and SIP message numbers are
associated with a particular connection failure, and notifies the system when problems occur. Use the no
voice cause-code-map from-pri <value> <value>

voice cause-code-map to-pri <value> <value>
Syntax Description
from-pri <value> <value> Enter the cause code number to map to the SIP message. The valid range
is 1 to 127. Next, enter the SIP message number to be used. The valid
to-pri <value> <value> Enter the SIP message number to map to the PRI cause code map. The
valid range is 400 to 606. The second <value> is the PRI cause code
number. The valid range is 1 to 127.
Default Values
Command History
Usage Examples
The following example sets the cause code number to 28 to associate with SIP messages:
(config)#voice cause-code-map from-pri 28

voice class-of-service <set name>

Use the voice class-of-service command to create a voice class of service (CoS) rule set and to enter the
Voice Class of Service command set. These additional commands are covered in Voice CoS Command Set
on page 2959. Use the no form of this command to delete a configured CoS rule set.
Syntax Description
<set name> Specifies the name of the CoS rule set.
Default Values
Command History
Usage Examples
The following example creates a new CoS rule set called set1:
(config)#voice class-of-service set1

Configuring New Level “set1”.
(config-cos-set1)#

voice codec-country <name>

Use the voice codec-country command to assign a country setting for the plain old telephone service
(POTS) (analog) coder-decoders (CODECs). Use the no form of this command to delete a configured
country setting.
Syntax Description
<name> Specifies the CODEC country name. The available options are Australia,
Belgium, Canada, France, Germany, Ireland, Italy, Luxembourg,
Puerto_Rico, Spain, Switzerland, United_Kingdom, and United_States.
Default Values
By default, the CODEC country setting is United_States.
Command History
Release A2 Command was expanded to include Australia.
Release A2.04 Command was expanded to include Belgium, France, Germany, Ireland,
Italy, Luxembourg, Spain, Switzerland, and United_Kingdom.
Usage Examples
The following example assigns Canada as the CODEC country:
(config)#voice codec-country Canada

voice codec-list <name>

Use the voice codec-list command to create a named coder-decoder (CODEC) list for call negotiation and
to enter the CODEC list configuration mode. Use the no form of this command to delete a configured
CODEC list.
Syntax Description
<name> Specifies the CODEC list name.
Default Values
By default, there are no configured voice CODEC lists.
Command History
Functional Notes
CODEC lists are list of CODECs arranged in preferred order with the first listed CODEC being the most
preferred for call negotiation. Using the voice codec-list command enters the configuration mode for the
CODEC list, where you can enter the types of CODECs to be used, and their order of preference. CODEC
lists are then applied to interfaces, voice trunks, or voice accounts to be used for call negotiation. For more
information on configuring and applying CODEC lists, refer to Voice CODEC List Command Set on page
2955.
Usage Examples
The following example creates a new CODEC list named List1:
(config)#voice codec-list List1

Configuring New Codec List “List1”.
(config-codec)#

voice codec-priority
Use the voice codec-priority command to specify which coder-decoder (CODEC) list is set as the priority.
Use the no form of this command to disable the setting. Variations of this command include:
voice codec-priority trunk

voice codec-priority user
voice codec-priority offer-sdp
Syntax Description
trunk Specifies using the trunk’s CODEC list as the priority CODEC list.
user Specifies using the user’s CODEC list as the priority CODEC list.
offer-sdp Specifies using Session Description Protocol (SDP) offer/answer
exchanges to set CODEC priority.
Default Values
Command History
Release A2 Command was expanded to include the offer-sdp parameter.
Functional Notes
The voice codec-priority command specifies the CODEC selection method at the unit’s global level.
Selections are made from preconfigured CODEC lists. For more information about configuring and
applying CODEC lists, refer to the Voice CODEC List Command Set on page 2955.
Usage Examples
The following example specifies using the trunk’s CODEC list as the priority CODEC list:
(config)#voice codec-priority trunk

voice codec-subcountry <value>

Use the voice codec-subcountry command to assign the subcountry value for plain old telephone service
(POTS) (analog) coder-decoders (CODECs). Use the no form of this command to return to the default
value.
Syntax Description
<value> Specifies the CODEC subcountry setting. The range is 0 to 65535.
Default Values
By default, the CODEC subcountry is set to 0.
Command History
Usage Examples
The following example assigns the subcountry code:
(config)#voice codec-subcountry 6606

Warning: You must save the config and reboot the system for this setting to take effect.
(config)#

voice compand-type
Use the voice compand-type command to set the companding type to match your telecommunications
provider. Use the no form of this command to return to the default setting. Variations of this command
include:
voice compand-type a-law

voice compand-type u-law
Syntax Description
a-law Specifies the a-law compand type. This compand type is mainly used in
European telephone networks for the conversion between analog and
digital signals in pulse-code modulation (PCM) applications, and is similar
to the North American mu-law standard.
u-law Specifies the u-law compand type.This compand type is also known as
mu-law, and is the PCM quasi-logarithmic curve. It is the 64 kbps standard
North America voice amplitude sample used for encoding and decoding.
Default Values
By default, the companding type is set to u-law.
Command History
Usage Examples
The following example configures the companding type to a-law:
(config)#voice compand-type a-law

voice conference local

Use the voice conference local command to configure the local conference feature. The voice
conferencing-mode command must be first set to local before these commands will take effect. Refer to
voice conferencing-mode on page 1143. Use the no form of this command to return to the default setting.
voice conference local max-sessions <number>

voice conference local originator flashhook drop
voice conference local originator flashhook ignore
voice conference local originator flashhook split
voice conference local originator onhook persist
voice conference local originator onhook terminate
voice conference local party-disconnect continue
voice conference local party-disconnect transfer
Syntax Description
max-sessions <number> Specifies the maximum number of simultaneous 3-way conference
sessions. If set to 0, the maximum number of sessions is defined by the
capability of the hardware platform.
originator Specifies the behavior of actions performed by the conference originator
once the conference has been established.
flashhook drop Indicates that when a flashhook is issued, the last party added to the 3-way
conference will be dropped and the call will continue between the two
remaining parties.
flashhook ignore Indicates that when a flashhook is issued, it will be ignored. The 3-way
conference will continue without interruption.
flashhook split Indicates that when a flashhook is issued, the 3-way conference will be split
into two calls, one between the originator and the first party and one
between the originator and the second party. When a flashhook is issued
after the split, it will toggle the originator between the two calls.
onhook persist Indicates that when the originator goes on-hook, the two parties in the
conference are connected together.
onhook terminate Indicates that when the originator goes on-hook, the remaining parties are
disconnected.
party-disconnect Specifies the conference behavior after a member disconnects.
continue Indicates the conference is maintained with the remaining parties.
transfer Indicates the conference is dropped and a direct connection between the
remaining parties is re-established.
Default Values
By default, the max-sessions is set to 3, originator onhook is set to persist, originator flashhook is set
to drop, and party-disconnect is set to continue.

Command History
Functional Notes
The voice conference local settings are only valid when the voice conferencing-mode is set to local.
Refer to voice conferencing-mode on page 1143 for more information.
Usage Examples
The following example sets the unit to a maximum of 5 local conference sessions:
(config)#voice conference local max-sessions 5
The following example sets the behavior of the conference session to ignore a flash-hook issued by the
conference originator:
(config)#voice conference local originator flashhook ignore

voice conferencing-mode
Use the voice conferencing-mode command to determine if voice conferencing bridging will be handled
within the unit or from a far-end conferencing server. Use the no form of this command to return to the
voice conferencing-mode local

voice conferencing-mode network
Syntax Description
local Specifies voice conferencing will be handled within the unit.
network Specifies voice conferencing will be handled by a far-end conferencing
server.
Default Values
By default, the voice conferencing mode is set to network.
Command History
Functional Notes
The voice conferencing mode is only valid when the flashhook mode is set to interpreted. Refer to the
command voice flashhook mode on page 1156 for more information.
Usage Examples
The following example sets the conferencing mode to handle conference bridging within the local unit:
(config)#voice conferencing-mode local

voice country-code <number>

Use the voice country-code command to enter the country code for this location. The country code is used
to determine if an incoming call is international. If a call originates from the Session Initiation Protocol
(SIP) wide area network (WAN) and it matches the voice country-code number, the call is not
international and the country code is stripped before passing the call to the customer premises equipment
(CPE). Use the no form of this command to delete the country code.
Syntax Description
<number> Specifies the country code of this location (three digit maximum).
Default Values
Command History
Usage Examples
The following example specifies a voice country-code of 203:
(config)#voice country-code 203

voice coverage <name>

Use the voice coverage command to create and modify a global call coverage list to be used to control call
routing when a user’s phone is not answered. Use the no form of this command to remove a call coverage
list.
Syntax Description
<name> Specifies a name for the call coverage list.
Default Values
Command History
Usage Examples
The following example specifies that the call coverage list named absent be used for global call coverage:
(config)#voice coverage absent

voice current-mode
Use the voice current-mode command to activate a particular system mode on the unit. Variations of this
command include:
voice current-mode custom1

voice current-mode default
voice current-mode lunch
voice current-mode night
voice current-mode override
voice current-mode weekend
Syntax Description
[custom1-custom3] Specifies the custom system mode to use.
default Specifies using the default system mode.
lunch Specifies using the lunch time system mode.
night Specifies using the night time system mode.
override Specifies using the override system mode.
weekend Specifies using the weekend system mode.
Default Values
By default, the system mode is set to default.
Command History
Functional Notes
This command is used to put the unit into a specific system mode. The unit remains in the activated system
mode until it is changed manually or a schedule change occurs triggering a transition to another system
mode. Schedules are configured using the command voice system-mode on page 1194.
If the system is in override, the unit will ignore any schedule that exists. The unit will stay in override until
manually changed. This command is saved into the dynvoice-config file to preserve the state of the unit in
case of power failure.
Usage Examples
The following example sets the current system mode to lunch:
(config)#voice current-mode lunch

voice dial-plan
Use the voice dial-plan command to add a global number complete pattern. Use the no form of this
command to delete configured dial plans. Variations of this command include:
voice dial-plan <pattern id> 900-number <pattern>

voice dial-plan <pattern id> 900-number <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> always-permitted <pattern>
voice dial-plan <pattern id> always-permitted <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> extensions <pattern>
voice dial-plan <pattern id> extensions <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> internal-operator <pattern>
voice dial-plan <pattern id> internal-operator <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> international <pattern>
voice dial-plan <pattern id> international <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> local <pattern>
voice dial-plan <pattern id> local <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> long-distance <pattern>
voice dial-plan <pattern id> long-distance <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> operator-assisted <pattern>
voice dial-plan <pattern id> operator-assisted <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> specify-carrier <pattern>
voice dial-plan <pattern id> specify-carrier <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> toll-free <pattern>
voice dial-plan <pattern id> toll-free <pattern> [<ndt name> | default | none]
voice dial-plan <pattern id> [user1 | user2 | user3] <pattern>
voice dial-plan <pattern id> [user1 | user2 | user3] <pattern> [<ndt name> | default | none]
Syntax Description
<pattern id> Specifies dial pattern identification. Valid range is 1 to 255.
900-number Adds a pattern to the 900 number group.
always-permitted Adds a pattern to the always permitted group.
extensions Adds a pattern to the internal group.
internal-operator Adds a pattern to the internal operator group.
international Adds a pattern to the international group.
local Adds a pattern to the local group.
long-distance Adds a pattern to the long distance group.
operator-assisted Adds a pattern to the operator assisted group.
specify-carrier Adds a pattern to the specify carrier group.
toll-free Adds a pattern to the toll free group.
user1 Adds a pattern to the user 1 group.

<pattern> Specifies a dialing pattern. You can enter a complete phone number, or
wildcards can be used to define the dialing pattern. Refer to Functional
Notes of this command for more information on using wildcards.
<ndt name> Optional. Specifies the named-digit-timeout to associate with this dial plan
entry. The named-digit-timeout is assigned a timeout value with the voice
timeouts named-digit-timeout command (refer to voice timeouts on page
1195).
default Optional. Sets the named-digit-timeout to the default value. The default
value is set with the voice timeouts interdigit command (refer to voice
timeouts on page 1195).
none Optional. Indicates that no named-digit-timeout is associated with this dial
plan entry.
Default Values
By default, no dial plans are configured.
Command History
Release A2 Command was expanded to include the named-digit-timeouts.
Functional Notes


2) 555-812[012] matches 555-8120 to 555-8122.

Usage Examples
The following example adds the pattern 8000 to the local group:
(config)#voice dial-plan 1 local 8000
The following example adds the pattern NXX-XXXX to the local group and associates it with the short1
named-digit-timeout:
(config)#voice dial-plan 2 local NXX-XXXX short1

voice did <number> extension <extension>

Use the voice did extension command to add a direct inward dialing (DID) number. Use the no form of
this command to delete a configured translation.
Syntax Description
<number> Specifies the direct inward dial lookup number.
<extension> Specifies the target account of the DID translation.
Default Values
Command History
Usage Examples
The following example directs DID number 5558123 to extension 8123:
(config)#voice did 5558123 extension 8123

voice directory <name>

Use the voice directory command to create or modify a voice directory and enter the Voice Directory
Configuration mode. Use the no form of this command to delete a configured voice directory. Variations
voice directory <name>
The following additional subcommands are available once you have entered the Voice Directory
Configuration mode:
directory-include <number> first-name <name>

directory-include <number> first-name <name> last-name <name>
Syntax Description
<name> Specifies the name of the directory to create or modify.
directory-include <number> Specifies the extension of the user to be added to the dial-by-name
directory. Adding users to the directory allows them to call parties using a
name stored in the system. Use the no form of this command to remove a
user from the directory.
first-name <name> Specifies the user’s first name.
last-name <name> Optional. Specifies the user’s last name.
Default Values
By default, no voice directories are configured.
Command History
Functional Notes
Adding a voice directory is useful when taking advantage of the dial-by-name feature. By default, a system
directory is always available. All voice users are automatically added as members of the system directory.
Usage Examples
The following example creates a new voice directory with name Engineering:
(config)#voice directory Engineering
The following example adds Jan Doe to the Engineering dial-by-name directory:
(config)#voice directory Engineering

(config-dir)#directory-include 5555 first-name Jan last-name Doe

voice disconnect-mode
Use the voice disconnect-mode command to control the disconnect mode of the unit. Use the no form of
voice disconnect-mode dialtone

voice disconnect-mode fast-busy
Syntax Description
dialtone Specifies issuing dial tone after disconnect on the unit.
fast-busy Specifies issuing fast-busy tone after disconnect on the unit.
Default Values
By default, this command is set to dialtone.
Command History
Usage Examples
The following example configures the unit to disconnect issuing a fast-busy tone:
(config)#voice disconnect-mode fast-busy

voice fax-tone
Use the voice fax-tone command to choose which tones initiate modem passthrough mode or T.38 mode.
Use the no form of this command to inhibit a specified tone from initiating T.38 or modem passthrough
call handling. Variations of this command include:
voice fax-tone default

voice fax-tone modem-passthrough default
voice fax-tone modem-passthrough t30-cng
voice fax-tone modem-passthrough v21-preamble
voice fax-tone modem-passthrough v25-ans
voice fax-tone modem-passthrough v25-ans-pr
voice fax-tone modem-passthrough v8-ansam
voice fax-tone modem-passthrough v8-ansam-pr
voice fax-tone t38 default
voice fax-tone t38 t30-cng
voice fax-tone t38 v21-preamble
voice fax-tone t38 v25-ans
voice fax-tone t38 v25-ans-pr
voice fax-tone t38 v8-ansam
voice fax-tone t38 v8-ansam-pr
Syntax Description
default Restores the default tones for initiating modem passthrough mode or T.38
mode, depending on where it is used in the command syntax. For example,
issuing voice fax-tone default restores defaults for both modes, while
issuing voice fax-tone t38 default only restores defaults for T.38 mode.
modem-passthrough Specifies modem passthrough mode.
t38 Specifies T.38 mode.
t30-cng Specifies the T.30 calling tones.
v21-preamble Specifies the V.21 preamble flag tones.
v25-ans Specifies the V.25 answer tones.
v25-ans-pr Specifies the V.25 answer tones with phase reversals.
v8-ansam Specifies the V.8 answer tones with amplitude modulation.
v8-ansam-pr Specifies the V.8 answer tones with amplitude modulation and phase
reversals.
Default Values
By default, all tones are enabled for both tone lists, allowing all tones to initiate either modem passthrough
or T.38 mode.
Command History

Functional Notes
When a fax tone is enabled, the tone is eligible to initiate either modem-passthrough or T.38 handling,
depending on the command entered. T.38 fax tone commands take priority over modem passthrough fax
tone commands. For example, in the default configuration with all commands enabled, any detected tone
on a call would cause a re-INVITE to T.38, as long as T.38 is enabled on the user (or primary rate interface
(PRI/CAS trunk). If T.38 is not enabled, the call would be re-INVITED to G.711 in modem passthrough
mode.
Usage Examples
The following example disables t30-cng fax tone for modem passthrough mode:
(config)#no voice fax-tone modem-passthrough t30-cng

voice feature-mode
Use the voice feature-mode command to configure control of the voice features. Use the no form of this
voice feature-mode local

voice feature-mode network
Syntax Description
local Allows voice features to be handled by the local unit.
network Allows voice features to be handled by the network.
Default Values
By default, the voice feature mode is set to network.
Command History
Usage Examples
The following example sets the control of the voice features to the local unit:
(config)#voice feature-mode local

voice flashhook mode

Use the voice flashhook mode command to determine if flashhook events will be interpreted locally or
will be forwarded to the far end. Use the no form of this command to return to the default setting.
voice flashhook mode interpreted

voice flashhook mode transparent
Syntax Description
interpreted Allows the local unit to interpret flashhook events.
transparent Specifies flashhook events to be transparent to the provider.
Default Values
By default, the voice flashhook mode is set to interpreted.
Command History
Usage Examples
The following example sets the flashhook mode to allow the local unit to interpret flashhook events:
(config)#voice flashhook mode interpreted

voice flashhook threshold <min time> <max time>

Use the voice flashhook threshold command to configure the minimum and maximum time the switch
hook must be held to be interpreted as a flash. Use the no form of this command to return to the default
setting.
Syntax Description
<min time> Specifies minimum flashhook time in milliseconds. Valid range is from
300 to 1000 milliseconds.
<max time> Specifies maximum flashhook time in milliseconds. Valid range is from
Default Values
By default, the flashhook threshold times are 300 milliseconds (minimum) and 1000 milliseconds
(maximum).
Command History
Usage Examples
The following example configures the flashhook thresholds at a minimum of 400 to a maximum of 900:
(config)#voice flashhook threshold 400 900

voice forward-mode
Use the voice forward-mode command to control the forwarding mode of the unit. Use the no form of this
voice forward-mode local

voice forward-mode network
Syntax Description
local Allows forwards to be handled locally by the unit.
network Allows forwards to be handled by the network.
Default Values
By default, this command is set to network.
Command History
Usage Examples
The following example configures the unit to handle forwards locally:
(config)#voice forward-mode local

voice grouped-trunk <trunk id>

Use the voice grouped-trunk command to create a grouped trunk and to enter the Grouped Trunk
command set. Refer to Voice Trunk Group Command Set on page 2666 for details. Use the no form of this
command to delete a configured grouped trunk.
Syntax Description
<trunk id> Specifies the name of the trunk group.
Default Values
By default, there are no configured grouped trunks.
Command History
Usage Examples
The following example creates the trunk group trunk3:
(config)#voice grouped-trunk trunk3

(config-TRUNK3)#

voice hold-reminder
Use the voice hold-reminder command to specify how long a call can be on hold before the hold reminder
rings the phone again. Use the no form of this command to return to the default setting. Variations of this
command include:
voice hold-reminder <value>

voice hold-reminder <value> <interval>
Syntax Description
<value> Specifies how long a call can be on hold before the hold reminder rings the
phone again. Range is 5 to 30 seconds.
<interval> Optional. Specifies the interval at which all subsequent reminder rings will
occur. Range is 10 to 120 seconds.
Default Values
The defaults for this command are a 10-second hold time before the first reminder ring with 30-second
intervals between subsequent rings.
Command History
Usage Examples
The following example sets the first reminder ring to occur after the call has been on hold for 20 seconds
(with subsequent reminder rings occurring every 15 seconds until the call is picked up):
(config)#voice hold-reminder 20 15

voice international-prefix
Use the voice international-prefix command to configure the international prefix for this unit. Use the no
form of this command to delete a configured prefix. Variations of this command include:
voice international-prefix <prefix>

voice international-prefix abbreviated
Syntax Description
abbreviated Specifies the international prefix be replaced with a plus symbol (+) in the
Session Initiation Protocol (SIP) header.
<prefix> Specifies the up to four digits for the prefix.
Default Values
By default, there is no configured international prefix.
Command History
Usage Examples
The following example configures 011 as the international prefix:
(config)#voice international-prefix 011

voice line <name>

Use the voice line command to create (or modify) a voice line and enter voice line’s configuration mode.
Use the no form of this command to delete a configured voice line.
Syntax Description
<name> Specifies the name or description of the voice line.
Default Values
By default, there are no configured voice lines.
Command History
Usage Examples
The following example creates the voice line Public, and enters its voice line configuration mode:
(config)#voice line Public

Configuring New Line “Public”.
(config-Public)#

voice loopback <number>

Use the voice loopback command to configure the auto attendant options for the system. Use the no form
of the commands to disable the setting. For more voice loopback account options, refer to Voice Loopback
Account Command Set on page 2870.
Syntax Description
<number> Specifies the extension for the loopback account.
Default Values
Command History
Usage Examples
The following example creates a loopback with extension (account) number 5555:
(config)#voice loopback 5555

voice mail
Use the voice mail command to configure voicemail options for the unit. Use the no form of this command
to disable the setting. Refer to voice mail check on page 1165 for additional arguments. Variations of this
voice mail alias <name>

voice mail asterisk
voice mail class-of-service <name>
voice mail did <number>
voice mail extension <extension>
voice mail internal
voice mail leave-extension <extension>
voice mail max-login-attempts <number>
Syntax Description
alias <name> Specifies an alias name to use as an alternate when accessing
voicemail.
asterisk Enables voicemail on an external Asterisk server.
class-of-service <name> Configures the voicemail class of services.
did <number> Configures the direct inward dialing (DID) number to assign to
voicemail.
internal Enables internal voicemail on the CompactFlash®.
extension <extension> Specifies the extension users will dial to retrieve their voicemail.
leave-extension <extension> Specifies the extension users will dial to leave a voicemail without
ringing an extension. If a user forwards their phone to this extension,
their calls will automatically forward to their voice mailbox.
max-login-attempts <number> Specifies the maximum number login attempts to voicemail accounts.
Range is 0 to 9 attempts.
Default Values
Command History
Usage Examples
The following example specifies extension 7500 for voicemail retrieval:
(config)#voice mail extension 7500

voice mail check

Use the voice mail check command to configure user parameters for the voicemail check extension. Use
the no form of this command to disable the setting. Variations of this command include the following:
voice mail check alias <name>

voice mail check sip-identity <station> <Txx>
voice mail check sip-identity <station> <Txx> register
voice mail check sip-identity <station> <Txx> register auth-name <username> password <password>
Syntax Description
alias <name> Specifies an alias name to use as an alternate when accessing the
check extension.
sip-identity <station> <Txx> Specifies the station to be used for Session Initiation Protocol (SIP)
trunk (e.g., station extension). Also, specifies the SIP trunk through
which to register the server. The trunk is specified in the format Txx
(e.g., T01).
register Registers the user to the server.
auth-name <username> Sets the user name that will be required as authentication for
registration to the SIP server.
password <password> Sets the password that will be required as authentication for
Default Values
Command History
Usage Examples
The following example configures the voice mail check sip-identity to use extension 6000 as its identity
on trunk T04:
(config)#voice mail check sip-identity 6000 T04

voice mail leave

Use the voice mail leave command to configure user parameters for the voicemail leave extension. Use the
no form of this command to disable the setting. Variations of this command include the following:
voice mail leave alias <name>

voice mail leave sip-identity <station> <Txx>
voice mail leave sip-identity <station> <Txx> register
voice mail leave sip-identity <station> <Txx> register auth-name <username> password <password>
Syntax Description
alias <name> Specifies an alias name to use as an alternate when accessing the
check extension.
sip-identity <station> <Txx> Specifies the station to be used for Session Initiation Protocol (SIP)
trunk (e.g., station extension). Also, specifies the SIP trunk through
which to register the server. The trunk is specified in the format Txx
(e.g., T01).
auth-name <username> Sets the user name that will be required as authentication for
Default Values
Command History
Usage Examples
The following example configures the voice mail leave sip-identity to use extension 8000 as its identity
on trunk T06:
(config)#voice mail leave sip-identity 8000 T06

voice mail sip-identity

Use the voice mail sip-identity command to configure Session Initiation Protocol (SIP) voicemail options
for the unit. Use the no form of this command to disable the setting. Variations of this command include
the following:
voice mail sip-identity <sip ID> <sip trunk>

voice mail sip-identity <sip ID> <sip trunk> register
voice mail sip-identity <sip ID> <sip trunk> register auth-name <username> password <password>
Syntax Description
<sip ID> <sip trunk> Specifies a number to be used as the SIP ID (e.g., station
extension) and the SIP trunk through which you will register to the
server.
auth-name <username> Sets the user name that will be required as AUTHENTICATION for
Default Values
Command History
Usage Examples
The following example specifies trunk T02 and extension 5800 for voice mail sip-identity:
(config)#voice mail sip-identity 5800 T02

voice match ani <template> substitute <template>

Use the voice match ani substitute command to configure automatic number identification (ANI)
substitution for inbound voice trunks. Use the no form of this command to remove the substitution.
Syntax Description
ani <template> Specifies the ANI information to be substituted. This information is entered
using wildcards and numerical digits. Refer to the Functional Notes of this
command for available wildcards and proper data entry.
substitute <template> Specifies the ANI information that is substituted for the original ANI
information. This information is entered using wildcards and numerical
digits. Refer to the Functional Notes of this command for available wildcards
and proper data entry.
Default Values
By default, no ANI substitution is configured.
Command History
Functional Notes
The convention for ANI templates is very similar to dial plan entries. The available wildcards for this
command are:

2) 555-812[012] matches 555-8120 to 555-8122.

Additional wildcards ($ and 0 to 9) can also be used. The command line interface (CLI) also contains
helpful information regarding the construction of the template and can be viewed by entering the match ani
command followed by a question mark. For example, entering the command as follows results in the
template input specifications:
(config)#match ani ?
MATCH # SUBST #
1) NXX-XXXX 256-NXX-XXXX (Format a call for 10 digit dialing)
2) 1-NXX-XXX-XXXX NXX-XXX-XXXX (Format LD call for 10 digit dialing)
3) 1-NXX-NXX-XXXX 10-10-220-NXX-NXX-XXXX (Insert a LD call PIC code)
4) 411 256-555-1212 (Redirect 411 information calls)
5) $ 10$ (Prepend a number)
6) XXXX$ $ (Strip leading digits)
SUBSTITUTE Number Rules -

1) All "," characters are ignored.
2) All "[" and "]" brackets must match, no nesting, no wildcards.
3) All "[" and "]" brackets may hold digits, commas [1239], [1,2,3,9].
4) All "[" and "]" brackets may contain a range [1-39], [1-3,9].
5) If using a "$" wildcard, it must be at the end of the number.
6) "X" matches [0-9], "N" matches [2-9].
Usage Examples
The following example specifies that the ANI information from numbers 555-8111 to 555-8115 on all
inbound trunks will be substituted by 555-8110:
(config)#voice match ani 555-811[125] substitute 555-8110

voice mgcp-endpoint <index>

Use the voice mgcp-endpoint command to create a Media Gateway Control Protocol (MGCP) endpoint,
assign it an index, and enter the endpoint configuration mode. Use the no form of this command to destroy
the specified endpoint.
Syntax Description
<index> Specifies the numerical value of the endpoint as part of the endpoint’s
default naming structure. Range is 1 to 255.
Default Values
By default, no endpoints are configured.
Command History
Functional Notes
By default, when endpoints are created and given an index number, they are named in the following
format: aaln/x, where x is the index number. For example, an endpoint with an index of 4 will by default
have the name aaln/4.
Assigning an index is essential for creating an endpoint; however, endpoints can be renamed using the
name endpoint command. Refer to name <text> on page 2529 for more information.
Usage Examples
The following example creates an endpoint with an index of 1, and enters the endpoint’s configuration
mode:
(config)#voice mgcp-endpoint 1
(config-mgcp-1)#

voice modem-passthrough-mode auto-disable-call-wait

Use the voice modem-passthrough-mode auto-disable-call-wait command to disable call waiting on fax
and modem calls. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, automatic disabling of call waiting for fax/modem calls is disabled.
Command History
Usage Examples
The following example disables call waiting on a fax call:
(config)#voice modem-passthrough-mode auto-disable-call-wait

voice num-rings <value>

Use the voice num-rings command to globally specify the number of times a station will ring before
beginning the coverage path that attempts to deliver a call to an available party. This setting can be
overridden on a per-user basis using the num-rings command in the Voice User command set. Refer to
Voice User Account Command Set on page 2887 for more information. Use the no form of this command
Syntax Description
<value> Specifies the number of times a station can ring with no answer. Range is
0 to 9. Setting to 0 allows unlimited rings.
Default Values
The default for this command is 0 (unlimited rings).
Command History
Usage Examples
The following example sets a limit on the number of times a station can ring:
(config)#voice num-rings 8

voice operator-group
Use the voice operator-group command to access the Voice Operator Group command mode. Refer to
Voice Operator Ring Group Command Set on page 2620 for more information. Use the no form of this
command to disable the setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enters the Operator Group configuration mode:
(config)#voice operator-group
Configuring Operator Group.

voice overhead-paging connected-timeout <value>

Use the voice overhead-paging connected-timeout command to specify the timeout interval before an
overhead paging call is terminated. Use the no form of this command to return to the default setting.
This setting does not affect calls placed into handset paging groups. It only affects calls to
the overhead paging port on the back of the AOS unit.
Syntax Description
<value> Specifies the timeout value in seconds. Set to 0 to disable the timeout.
Default Values
The default setting is 120 seconds.
Command History
Usage Examples
The following example configures a connected timeout of 30 seconds for overhead paging:
(config)#voice overhead-paging connected-timeout 30

voice overhead-paging extension <number>

Use the voice overhead-paging extension command to specify the extension used for overhead paging.
Use the no form of this command to disable the setting.
Syntax Description
<number> Specifies the extension to use for overhead paging.
Default Values
Command History
Usage Examples
The following example configures extension 3000 to be used for overhead paging:
(config)#voice overhead-paging extension 3000

voice paging-group <extension>

Use the voice paging-group command to create a new handset paging group and enter the paging group’s
configuration. Use the no form of this command to remove the paging group.
Syntax Description
<extension> Specifies the numeric extension for the paging group.
Default Values
By default, no paging groups exist.
Command History
Functional Notes
The voice paging-group command enters the configuration for a handset paging group. For more
information about handset paging, refer to the Handset Paging for the NetVanta 7000 Series quick
For more information about the commands used to configure handset paging, refer to the Voice Paging
Group Command Set on page 2638.
Usage Examples
The following example creates a paging group using extension 8956 and enters the group’s configuration
mode:
(config)#voice paging-group 8956

Configuring new paging group “8956”.
(config-8956)#

voice park-return <value>

Use the voice park-return command to configure the time until a parked call returns. Use the no form of
this command to return to the default setting.
Syntax Description
<value> Specifies time in seconds until a call returns from park if not retrieved. Valid
Default Values
By default, the voice park-return time is set to 60 seconds.
Command History
Usage Examples
The following example sets the time a call returns from park to 30 seconds:
(config)#voice park-return 30

voice prompt-language <language>

Use the voice prompt-language command to specify the language to use for voice prompts (such as
audios and voicemail menus) on the system. Use the no form of this command to disable the current
language setting.
Syntax Description
<language> Specifies the language to use for voice prompts. The available choices are
Dutch, English, FrenchCanadian, Italian, LatinAmSpanish (Latin
American Spanish), and UKEnglish (United Kingdom English).
Default Values
The default value for this command is English.
Command History
Usage Examples
The following example specifies the voice prompt language as Italian:
(config)#voice prompt-language Italian

voice ring-group <number>

Use the voice ring-group command to create or modify ring group parameters. These additional
commands are covered in Voice Ring Group Command Set on page 2643. Use the no form of this
command to delete a configured ring group.
Syntax Description
<number> Specifies the ring group's four-digit extension.
Default Values
By default, no ring groups are configured.
Command History
Usage Examples
The following example creates a new ring group with extension 5678:
(config)#voice ring-group 5678

Configuring New Group “5678”.
(config-5678)#

voice service-mode
Use the voice service-mode command to add a service mode transition. Variations of this command
include:
voice service-mode day <day> <time>

voice service-mode lunch <day> <time>
voice service-mode night <day> <time>
voice service-mode weekend <day> <time>
Syntax Description
day Specifies a transition to day mode.
lunch Specifies a transition to lunch mode.
night Specifies a transition to night mode.
weekend Specifies a transition to weekend mode.
<day> Specifies the day of week the transition occurs.
<time> Specifies the time for transition to occur (24-hour format - hours:minutes
(HH:MM)).
Default Values
By default, the voice service-mode is set to day.
Command History
Usage Examples
The following example sets the voice service mode to day with a transition day of Monday and a transition
time of 8:00 AM:
(config)#voice service-mode day monday 08:00

voice speed-dial <unique id> <number> <name>

Use the voice speed-dial command to create a list of IDs to be used as shortcuts to contact frequently
called numbers. Use the no form of this command to return to the default setting.
Syntax Description
<unique id> The speed-dial number that will be used to contact the <number> specified.
<number> Phone number associated with the speed-dial entry (digits only).
<name> Description of this speed-dial entry.
Default Values
Command History
Usage Examples
The following example sets a speed-dial number of 8 for extension 9654:
(config)#voice speed-dial 8 9654 3rdFloorLab

voice spre <pattern id> <pattern>

Use the voice spre command to add a global special prefix (SPRE) complete pattern. This command
allows users to enter a custom SPRE code. Use the no form of this command to delete a configured SPRE
pattern.
Syntax Description
<pattern id> Specifies the SPRE pattern ID. Valid range is 1 to 255.
<pattern> Specifies the SPRE pattern. Refer to Functional Notes below for more
information.
Default Values
Command History
Functional Notes
This command allows users to enter a SPRE code pattern. Patterns begin with * or #. If the pattern is
followed by an &, then the dial plan number-complete templates are used to determine when the unit has
enough digits to dial the number (for example, 67&). However, if a dial plan does not exist for a particular
code that is needed, then a SPRE code may be entered followed by an independent dial plan
number-complete template (for example, *67NXX-XXXX). The available wildcards for this command are:


2) 555-812[012] matches 555-8120 to 555-8122.
Usage Examples
The following sets the complete pattern for SPRE 1:
(config)#voice spre 1 *67NXX-XXXX

voice spre-mode
Use the voice spre-mode command to control whether special prefix (SPRE) codes will be interpreted by
the unit locally or forwarded to the network for interpretation. The override parameter indicates that the
specified SPRE code is to be overridden. Use the no form of this command to return to the default setting.
voice spre-mode local

voice spre-mode network
voice spre-mode override *<nx>
Syntax Description
local Specifies that SPRE codes are interpreted locally by the unit.
network Specifies the forwarding of SPRE codes to the network for handling.
override *<nx> Indicates the configured SPRE processing mode is overridden for the
specified SPRE code. Valid range for n is 2 to 9. Valid range for x is 0 to 9.
Default Values
By default, this command is set to forward SPRE codes to the network and no overrides are configured.
Command History
Release A2.03 Command was expanded to include the override option.
Functional Note
SPRE codes are used to map a sequence of digits to a particular functionality. For example, in a typical
network, *67 is used to block caller ID. When the AOS unit is configured to operate in network mode, the
digits are collected and sent to the network for appropriate handling. Using the override parameter allows
the unit to be configured so that certain SPRE codes are collected locally and the corresponding function is
initiated.
Usage Examples
The following example configures the unit to interpret SPRE codes:
(config)#voice spre-mode local
The following example configures the unit, which is configured to use the network mode, to instead
interpret the SPRE code *67 locally:
(config)#voice spre-mode network

(config)#voice spre-mode override *67

voice spre-map
Use the voice spre-map command to change the default mapping of special prefix (SPRE) codes on the
AOS voice product. Functions and SPRE codes can be disabled by using the none keyword. Use the no
voice spre-map all none

voice spre-map auto-answer-dnd *<nx>
voice spre-map auto-answer-dnd none
voice spre-map billing-code *<nx>
voice spre-map billing-code none
voice spre-map block-callid-delivery *<nx>
voice spre-map block-callid-delivery none
voice spre-map call-forward-cancel *<nx>
voice spre-map call-forward-cancel none
voice spre-map call-forward-extension *<nx>
voice spre-map call-forward-extension none
voice spre-map call-forward-remote *<nx>
voice spre-map call-forward-remote none
voice spre-map call-park-retrieve *<nx>
voice spre-map call-park-retrieve none
voice spre-map call-park-zone *<nx>
voice spre-map call-park-zone none
voice spre-map call-return *<nx>
voice spre-map call-return none
voice spre-map call-user-speed-dial *<nx>
voice spre-map call-user-speed-dial none
voice spre-map camp-on *<nx>
voice spre-map camp-on none
voice spre-map cancel-camp-on *<nx>
voice spre-map cancel-camp-on none
voice spre-map clear-message-waiting *<nx>
voice spre-map clear-message-waiting none
voice spre-map conference *<nx>
voice spre-map conference none
voice spre-map cos-override *<nx>
voice spre-map cos-override none
voice spre-map disable-call-waiting *<nx>
voice spre-map disable-call-waiting none
voice spre-map dnd-enable-disable *<nx>
voice spre-map dnd-enable-disable none
voice spre-map door-phone *<nx>
voice spre-map door-phone none
voice spre-map door-unlock *<nx>
voice spre-map door-unlock none
voice spre-map fwd-notificatn-cancel *<nx>

voice spre-map fwd-notificatn-cancel none

voice spre-map group-login *<nx>
voice spre-map group-login none
voice spre-map group-logout *<nx>
voice spre-map group-logout none
voice spre-map hotel-login *<nx>
voice spre-map hotel-login none
voice spre-map hotel-logout *<nx>
voice spre-map hotel-logout none
voice spre-map maca-login *<nx>
voice spre-map maca-login none
voice spre-map maca-logout *<nx>
voice spre-map maca-logout none
voice spre-map page-intercom *<nx>
voice spre-map page-intercom none
voice spre-map page-overhead *<nx>
voice spre-map page-overhead none
voice spre-map permanent-hold *<nx>
voice spre-map permanent-hold none
voice spre-map program-speed-dial *<nx>
voice spre-map program-speed-dial none
voice spre-map redial *<nx>
voice spre-map redial none
voice spre-map remote-call-fwd-cancel *<nx>
voice spre-map remote-call-fwd-cancel none
voice spre-map set-account-password *<nx>
voice spre-map set-account-password none
voice spre-map set-message-waiting *<nx>
voice spre-map set-message-waiting none
voice spre-map system-mode *<nx>
voice spre-map system-mode none
voice spre-map system-speed-dial *<nx>
voice spre-map system-speed-dial none
voice spre-map transfer *<nx>
voice spre-map transfer none
voice spre-map user-station-lock *<nx>
voice spre-map user-station-lock none
voice spre-map user-station-unlock *<nx>
voice spre-map user-station-unlock none
Not all SPRE codes are supported by all AOS products. Type voice spre-map ? to view a
list of supported SPRE codes.

Syntax Description
all Makes the SPRE code assignment for all functions.
none Removes the SPRE code for the specified function.
*<nx> Specifies the SPRE code to assign to this function.
Valid range for n is 2 to 9. Valid range for x is 0 to 9.
auto-answer-dnd Specifies the automatic answer do-not-disturb (DND) function.
billing-code Specifies the billing code function.
block-callid-delivery Specifies the block caller-ID delivery function.
call-forward-cancel Specifies the call forward cancel function.
call-forward-extension Specifies the call forward + extension function.
call-forward-remote Specifies the call forward remote function.
call-park-retrieve Specifies the call park retrieve function.
call-park-zone Specifies the call park + zone function.
call-return Specifies the call return function.
call-user-speed-dial Specifies the call user speed dial function.
camp-on Specifies the camp-on function.
cancel-camp-on Specifies the cancel camp-on function.
clear-message-waiting Specifies the clear message waiting function.
conference Specifies the 3-way conferencing function.
cos-override Specifies the class of service (CoS) override function.
disable-call-waiting Specifies the disable call waiting on a per-call basis function.
dnd-enable-disable Specifies the DND enable/disable function.
door-phone Specifies the door phone function.
door-unlock Specifies the door unlock function.
fwd-notificatn-cancel Specifies the forward notification cancel function.
group-login Specifies the group login function.
group-logout Specifies the group logout function.
hotel-login Specifies the hotel login function.
hotel-logout Specifies the hotel logout function.
maca-login Specifies the multiple access with collision avoidance (MACA) login
function.
maca-logout Specifies the MACA logout function.
page-intercom Specifies the page intercom function.
page-overhead Specifies the overhead paging function.
permanent-hold Specifies the permanent hold function.
program-speed-dial Specifies the program user speed dial function.
redial Specifies the call last dialed number function.
remote-call-fwd-cancel Specifies the remote call forward cancel function.
set-account-password Specifies the set account password function.

set-message-waiting Specifies the set message waiting function.

system-mode Specifies the system mode function.
system-speed-dial Specifies the system speed dial function.
transfer Specifies the transfer function.
user-station-lock Specifies the user station lock function.
user-station-unlock Specifies the user station unlock function.
Default Values
Default mappings between functions and SPRE codes are as indicated in the following table:
SPRE SPRE
Code Function Code Function
*21 Billing Code *32 Forward Notification Cancel
*67 Block Caller-ID Delivery *55 Group Login
*97 Auto-Answer Do-Not-Disturb *56 Group Logout
*35 Call Forward Cancel *46 Hotel Login
*33 Call Forward + Extension *47 Hotel Logout
*34 Call Forward Remote *63 MACA Login
*78 Call Park Retrieve *64 MACA Logout
*77 Call Park + Zone *31 Page Intercom
*69 Call Return *30 Page Overhead
*62 Call User Speed Dial *44 Permanent Hold
*66 Camp-on *61 Program User Speed Dial
*65 Cancel Camp-on *72 Redial
*86 Clear Message Waiting *36 Remote Call Forward Cancel
*22 Conference 3-way *79 Set Account Password
*90 Class of Service Override *85 Set Message Waiting
*70 Disable Call Waiting Per Call Basis *20 System Mode
*39 Do Not Disturb Enable/Disable *25 System Speed Dial
*37 Door Phone *88 Transfer
*38 Door Unlock *57 User Station Lock
*58 User Station Unlock

Command History
Functional Notes
SPRE codes are used to map a sequence of digits to a particular functionality.For example, in a typical
network, *67 is used to block caller ID. The codes and their functions are listed in the Default Values.
Functions and SPRE codes can be disabled by using the none keyword.
Usage Examples
The following example sets the SPRE code for call return to *79:
(config)#voice spre-map call-return *79

voice status-group expires

Use the voice status-group expires command to add a status group subscription time for status group
clients. Any subscription time requests that fall between the minimum and maximum values will be
instructed to use the default value instead. Variations of this command include:
voice status-group default-expires <value>

voice status-group max-expires <value>
voice status-group min-expires <value>
Syntax Description
default-expires <value> Specifies a default subscription time. The valid range is 120 to
86400 seconds.
max-expires <value> Specifies a maximum subscription time. The valid range is 120 to
86400 seconds.
min-expires <value> Specifies a minimum subscription time. The valid range is 120 to
86400 seconds.
Default Values
By default, the voice status group default-expires value is set to 120 seconds, max-expires value is set to
3600, and the min-expires is set to 86400.
Command History
Usage Examples
The following example sets the voice status group maximum subscription time to 2 hours:
(config)#voice status-group max-expires 7200

voice status-group
Use the voice status-group command to create or modify a voice status group and enter the Voice Status
Group Configuration mode. Use the no form of this command to delete a voice status group. Variations of
voice status-group <name>
The following additional subcommands are available once you have entered the Voice Status Group
Configuration mode:
park-zone <value>
user <number>
user <number> display-name <name>
user <number> dial-string <string>
user <number> display-name <name> dial-string <string>
Syntax Description
<name> Specifies the name of the voice status group to create, modify, or delete.
park-zone <value> Specifies a new park zone number to add to this voice status group. The
valid range is 0 to 9.
user <number> Specifies the extension of a user to add to this voice status group.
display-name <name> Optional. Specifies an override name to appear as the user’s name when
displayed on the device (BLF). If the name includes spaces, it must be
surrounded by quotation marks as shown in the Usage Examples.
dial-string <string> Optional. Specifies a specific number to dial. Valid entries can include a
combination of characters * and 0 through 9.
Default Values
By default, there are no voice status groups configured.
Unless the user explicitly enters a display-name or dial-string, these values will default to the user’s
extension number. The dial-string and display-name cannot be added or changed after a user is added
to a status group. The user must first be removed from the status group with the no user <number>
command, then re-added as a member with the appropriate display-name and/or dial-string. Refer to the
Usage Examples section for further details.
Command History
Release A2 Command was expanded to include the dial string entries.
Usage Examples
The following example creates a new voice status group with the name Engineering:
(config)#voice status-group Engineering

The following example adds park zone 4 to the Engineering status group directory:

(config-status-Engineering)#park-zone 4
The following example adds user 5555 to the Engineering status group directory, displaying the default
name 5555 with the default dial string of 5555:

(config-status-Engineering)#user 5555
The following example adds user 5555 to the Engineering status group directory, displaying the name
Test Lab with the default dial string of 5555:

(config-status-Engineering)#user 5555 display-name “Test Lab”
The following example adds user 5555 to the Engineering status group directory, displaying the default
name 5555 with a handsfree dial string of **5555:

(config-status-Engineering)#user 5555 dial-string **5555
The following example adds user 5555 to the Engineering status group directory, displaying the name
Test Lab with a handsfree dial string of **5555:

(config-status-Engineering)#user 5555 display-name “Test Lab” dial-string **5555

voice system-country <number>

Use the voice system-country command to specify the system country. The system country sets the
default parameters for other items, such as Web-based graphical user interface (GUI) language, voice
prompt language (if applicable), plain old telephone service (POTS) codec country, subcountry ID,
companding, and caller ID type. Values for these parameters may be viewed using on show system on page
638. Use the no form of this command to return to the default setting.
Syntax Description
<number> Specifies the country code. Valid entries are:
0 = Belgium
1 = Denmark
2 = Finland
3 = Italy
4 = Netherlands
5 = Norway
6 = Sweden
7 = United Kingdom
8 = United States
9 = Canada
10 = Puerto Rico
11 = China
12 = Europe
13 = Australia
14 = France
15 = Germany
16 = Ireland
17 = Luxembourg
18 = Spain
19 = Switzerland
20-65535 = Reserved for future use.
Default Values
The default system country code is 8, United States.
Command History

Usage Examples
The following example sets the system country code to 9, Canada:
(config)#voice system-country 9

voice system-mode
Use the voice system-mode command to configure the system mode schedules. When triggered by the
system-clock, AOS units transition into a system mode based on the schedule. Use the no form of this
command to disable the setting. Variations of this command include the following:
voice system-mode custom1 <day> <time>

voice system-mode default <day> <time>
voice system-mode lunch <day> <time>
voice system-mode night <day> <time>
voice system-mode weekend <day> <time>
Syntax Description
<day> Specifies the day of the week. Choose from Sunday through Saturday.
<time> Specifies the time of the day in a 24-hour format hours:minutes (HH:MM).
custom1 - custom3 Indicates the custom mode (1 through 3) to configure.
default Indicates the default-time system mode to configure.
lunch Indicates the lunch-time system mode to configure.
night Indicates the night-time system mode to configure.
weekend Indicates the weekend system mode to configure.
Default Values
By default, no system mode commands are configured, the unit will operate in the default mode.
Command History
Usage Examples
The following example configures a typical 5-day business week:
(config)#voice system-mode default Monday 8:00

(config)#voice system-mode night Monday 17:00
(config)#voice system-mode default Tuesday 8:00
(config)#voice system-mode night Tuesday 17:00
(config)#voice system-mode default Wednesday 8:00
(config)#voice system-mode night Wednesday 17:00
(config)#voice system-mode default Thursday 8:00
(config)#voice system-mode night Thursday 17:00
(config)#voice system-mode default Friday 8:00
(config)#voice system-mode weekend Friday 17:00

voice timeouts
Use the voice timeouts command to configure the time limits for phases. Use the no form of this command
to return to the default setting or remove the named digit timeout (NDT) and its value.
When removing an NDT and its value, if the NDT is assigned to a dial plan entry, then the
deletion is not allowed. The dial plan must be removed first and added back into the system
without the NDT association.
voice timeouts alerting <value>

voice timeouts connected <value>
voice timeouts interdigit <value>
voice timeouts named-digit-timeout <ndt name>
voice timeouts named-digit-timeout <ndt name> <value>
Syntax Description
alerting <value> Specifies the maximum time a call is allowed to remain in the alerting state.
The shorter of this timeout or the configured maximum number of rings will
determine how long a call is allowed to ring. The valid range is 0 (unlimited)
to 60 minutes.
connected <value> Specifies the maximum time a call is allowed to remain in the connected
state. The valid range is 0 (unlimited) to 1000 hours.
interdigit <value> Specifies the maximum time allowed between dialed digits. The valid range
is 1 to 16 seconds.
named-digit-timeout Creates a timeout with a name and a value to associate with a dial plan
template.
<ndt name> Specifies the name of the named-digit-timeout to be created.
<ndt name> <value> Optional. Indicates the timeout value in seconds to allow after the last digit
is dialed before routing the call. The valid range is 1 to 16 seconds.
Default Values
By default, the alerting timeout is 5 minutes, the connected timeout is 12 hours, and the interdigit
timeout is 4 seconds. If no value is indicated for the NDT, 0 seconds is applied.
Command History
Release A2 Command was expanded to include the named-digit-timeouts.

Functional Notes
The named-digit-timeout feature allows for multiple interdigit timeouts within the system. It provides a
means for associating a specific amount of time to wait after a template match is made before routing a
call. This added functionality allows short numbers and long numbers to coexist in the same system
(i.e., seven- and ten-digit patterns) without specifying additional characters (such as 1 or 9). This
enhancement was added in AOS release A2.
Usage Examples
The following example sets the alerting timeout to 30 seconds:
(config)#voice timeouts alerting 30
The following example creates a named-digit-timeout named short1 and sets the timeout value to
2 seconds:
(config)#voice timeouts named-digit-timeout short1 2

voice transfer
Use the voice transfer command to set the unattended transfer for the system only. Use the no form of this
voice transfer blind

voice transfer unattended
Syntax Description
blind Converts unattended transfer attempts to RFC 3891-compliant blind
transfers.
unattended Unattended transfer attempts are not modified.
Default Values
The default setting is unattended.
Command History
Usage Examples
The following example configures the voice transfer type to blind:
(config)#voice transfer blind

voice transfer-mode
Use the voice transfer-mode command to specify whether transferred calls will be controlled by the unit
locally, or if the network will control them. Use the no form of this command to return to the default
voice transfer-mode local

voice transfer-mode network
Syntax Description
local Specifies that call transferring is controlled locally by the unit.
network Specifies that call transferring is controlled by the network.
Default Values
By default, the network controls call transfers.
Command History
Usage Examples
The following example configures the unit to handle call transfers:
(config)#voice transfer-mode local

voice transfer-on-hangup
Use the voice transfer-on-hangup command to enable this feature. When transferring a call, hanging up
initiates the transfer to the destination party. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, this feature is enabled.
Command History
Usage Examples
The following example enables this feature:
(config)#voice transfer-on-hangup

voice trunk-list <name>

Use the voice trunk-list command to create a permit/deny trunk list and to enter the trunk list
configuration mode. Use the no form of this command to remove the trunk list.
Additional subcommands are available once you have entered the trunk list configuration mode:
trunk <Txx>
Syntax Description
<name> Specifies the name of the trunk list.
trunk <Txx> Specifies the trunk to add to the trunk list. Trunks are specified by their
2-digit identifier. For example, T01.
Default Values
By default, no trunk lists are configured.
Command History
Functional Notes
The trunk lists are permit/deny lists that operate in the same manner as automatic number identification
(ANI) lists, and are used to specify trunks that will be permitted or denied access on specified voice trunk
groups.
There is no limit on the number of trunks that can be added to the trunk list, and there is no limit on the
number of trunk lists that can be applied to a voice trunk group. The trunk lists are applied to the trunk
group in the order they are listed.
Although there is no limit on the number of trunks allowed in a trunk list, or the number of
trunk lists applied to voice trunk groups, it is important to remember that the more lists
that are applied to a trunk group, the more the runtime performance of call routing will be
affected.
Usage Examples
The following example creates a trunk list called TEST2 and specifies the trunks to be included in the list:
(config)#voice trunk-list TEST2

(config-trunk-list-TEST2)#trunk T01
(config-trunk-list-TEST2)#trunk T03

voice trunk <trunk id> type

Use the voice trunk type command to define a new trunk for use with a Session Initiation Protocol (SIP)
or integrated services digital network (ISDN) interface. Executing this command activates the Voice Trunk
Configuration mode for the individual trunk. Refer to Voice ISDN Trunk Command Set on page 2718 for
information on the commands in that mode. Other trunk types are explained in voice trunk <trunk id> type
analog supervision on page 1202. Use the no form of this command to delete a configured voice trunk.
voice trunk <trunk id> type isdn

voice trunk <trunk id> type sip
Refer to the SIP Trunk configuration guide and the Total Access 900 Series ISDN PRI
quick configuration guide for more information on voice trunks. These documents are
located on the AOS Documentation CD provided with your unit.
Syntax Description
<trunk id> Specifies the trunk's two-digit identifier in the format Txx (for example, T12).
isdn Configures the trunk for use with ISDN service.
sip Configures this trunk for use with SIP.
Default Values
Command History
Release 11.1 Command was expanded to include the analog and ISDN support.
Usage Examples
The following example creates the new trunk T12 for use with SIP and enters the Voice Trunk
Configuration mode:
(config)#voice trunk t12 type sip

(config-T12)#

voice trunk <trunk id> type analog supervision

Use the voice trunk type analog supervision command to define a new trunk for an analog interface.
Executing this command activates the Voice Trunk Analog Configuration mode for the individual trunk.
Use the no form of this command to delete a configured voice trunk. Refer to Voice Analog Trunk
Command Set on page 2679 for information on the commands in that mode. Variations of this command
voice trunk <trunk id> type analog supervision dpt

voice trunk <trunk id> type analog supervision ground-start
voice trunk <trunk id> type analog supervision loop-start
Syntax Description
<trunk id> Specifies the trunk’s two-digit identifier in the format Txx (for example, T01).
dpt Specifies dial pulse terminate (DPT) with an assumed user role.
ground-start Specifies ground start (GS) with an assumed user role.
loop-start Specifies loop start (LS) with an assumed user role.
Default Values
Command History
Usage Examples
The following example creates the new trunk T15 for use with an analog interface and enters the Voice
Trunk Analog DPT Configuration mode:
(config)#voice trunk t15 type analog supervision dpt

(config-T15)#

voice trunk <trunk id> type t1-rbs supervision

Use the voice trunk type t1-rbs supervision command to define a new trunk for a T1 interface. Executing
this command activates the Voice Trunk T1 Configuration mode for the individual trunk. Use the no form
of this command to delete a configured voice trunk. Refer to Voice T1 Trunk Command Set on page 2798
for information on the commands in that mode. Other trunk types are explained in voice trunk <trunk id>
type on page 1201. Variations of this command include the following:
voice trunk <trunk id>

voice trunk <trunk id> type t1-rbs supervision fgd role user
voice trunk <trunk id> type t1-rbs supervision ground-start role user
voice trunk <trunk id> type t1-rbs supervision immediate role network
voice trunk <trunk id> type t1-rbs supervision immediate role user
voice trunk <trunk id> type t1-rbs supervision loop-start role user
voice trunk <trunk id> type t1-rbs supervision tie-fgd
voice trunk <trunk id> type t1-rbs supervision wink role network
voice trunk <trunk id> type t1-rbs supervision wink role user
Syntax Description
<trunk id> Specifies the trunk's two-digit identifier in the format Txx (for example, T01).
fgd Specifies feature group D (FGD) with an assumed user role.
ground-start Specifies ground start (GS) with an assumed user role.
immediate Specifies E&M immediate with an assumed network or user role.
loop-start Specifies loop start (LS) with an assumed user role.
tie-fgd Specifies tie trunk with FGD.
wink Specifies wink with an assumed network or user role.
role network Specifies the network role for this trunk.
role user Specifies the user role for this trunk.
Default Values
Command History
Usage Examples
The following example creates the new trunk T15 for use with a T1 interface and enters the Voice Trunk T1
Wink Configuration mode:
(config)#voice trunk t15 type t1-rbs supervision wink role network

(config-T15)#

voice user <extension>

Use the voice user command to create a new user extension and to enter the Voice User command set. Use
the no form of this command to delete a configured extension or modify an existing extension’s
parameters. Refer to Voice User Account Command Set on page 2887 for details.
Syntax Description
<extension> Specifies user’s extension.
Default Values
By default, there are no configured voice users.
Command History
Usage Examples
The following example creates a new user with extension 9876:

Configuring New User “9876”.
(config-9876)#

vrf forwarding <name>

Use the vrf forwarding command to assign an interface to a specific VPN routing and forwarding (VRF)
instance. Use the no form of this command to remove the interface from the named VRF instance and
assign it to the unnamed default VRF.
Keep in mind that changing an interface’s VRF association will clear all IP-related
settings on that interface.
Syntax Description
<name> Specifies the name of the VRF to which to assign the interface.
Default Values
By default, interfaces are associated with the default VRF that is unnumbered.
Command History
Functional Notes
VRF instances must be created first before an interface can be assigned. An interface can only be
assigned to one VRF, but multiple interfaces can be assigned to the same VRF.
An interface will only forward IP traffic that matches its associated VRF.
Usage Examples
The following example assigns the frame-relay 1.16 interface to the VRF instance named RED:

(config-fr 1.16)#vrf forwarding RED

LINE INTERFACE COMMAND SETS

• Line (Console) Interface Command Set on page 1207

• Line (SSH) Interface Command Set on page 1223
• Line (Telnet) Interface Command Set on page 1235

Command Reference Guide Line (Console) Interface Command Set
LINE (CONSOLE) INTERFACE COMMAND SET
To activate the Line (Console) Interface Configuration mode, enter the line console 0 command at the
Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-con 0)#
do on page 51
end on page 52
exit on page 53
accounting commands begin on page 1208

authorization commands begin on page 1211
databits <value> on page 1213
flowcontrol on page 1214
line-timeout <value> on page 1215
login on page 1216
login authentication <listname> on page 1217
login local-userlist on page 1218
parity on page 1219
password <password> on page 1220
speed <rate> on page 1221
stopbits <value> on page 1222

accounting commands <level> <listname>

Use the accounting commands command to assign authentication, authorization, and accounting (AAA)
command accounting method lists to line interfaces. You must first turn AAA on for this command to
become available (using the command aaa on on page 751). Use the no form of this command to remove
the AAA command accounting method list from the interface. Variations of this command include:
accounting commands <level> default

Syntax Description
<level> Specifies whether the list applies to Level 1 (unprivileged) or Level 15
(privileged) commands.
default Applies the default AAA command accounting method list to the interface.
<listname> Applies the specified AAA command accounting method list to the interface.
Default Values
By default, no AAA command accounting method list is applied to the line interface.
Command History
Functional Notes
AAA command accounting method lists are used to specify the types of information recorded when users
access specified command levels. For more information about configuring command accounting lists, refer
to the command aaa accounting connection on page 720.
For more information about configuring AAA on your network, refer to the configuration guide Configuring
AAA in AOS available online at http://kb.adtran.com.
Usage Examples
The following example specifies that AAA command accounting list Accounting1 is applied to all Level 15
commands on all console lines:
(config-con 0)#accounting commands 15 Accounting1

accounting connection <listname>

Use the accounting connection command to assign authentication, authorization, and accounting (AAA)
connection accounting method lists to line interfaces. You must first turn AAA on for this command to
the AAA connection accounting method list from the interface. Variations of this command include:
accounting connection default

Syntax Description
default Applies the default AAA connection accounting method list to the interface.
<listname> Applies the specified AAA connection accounting method list to the
interface.
Default Values
Command History
Functional Notes
AAA connection accounting method lists are used to specify the types of information recorded about
outbound connections made from the AOS unit. For more information about configuring connection
accounting lists, refer to the command aaa accounting connection on page 720.
Usage Examples
The following example specifies that AAA connection accounting list AcctConn1 is applied to all console
lines:
(config-con 0)#accounting connection AcctConn1

accounting exec <listname>

Use the accounting exec command to assign authentication, authorization, and accounting (AAA)
executive accounting method lists to line interfaces. You must first turn AAA on for this command to
the AAA executive accounting method list from the interface. Variations of this command include:
accounting exec default

Syntax Description
interface.
Default Values
Command History
Functional Notes
AAA executive accounting method lists are used to specify the types of information recorded about
inbound connections made by connecting to the line interfaces and creating a terminal session. For more
information about configuring executive accounting lists, refer to the command aaa accounting exec on
page 723.
Usage Examples
The following example specifies that AAA executive accounting list Inboundacct1 is applied to the
console line:
(config-con 0)#accounting exec Inboundacct1

authorization commands <level> <listname>

Use the authorization commands command to assign authentication, authorization, and accounting
(AAA) command authorization method lists to line interfaces. You must first turn AAA on for this
command to become available (using the command aaa on on page 751). Use the no form of this
command to remove the AAA command authorization method list from the interface. Variations of this
command include:
authorization commands <level> default

Syntax Description
default Applies the default AAA command authorization method list to the interface.
<listname> Applies the specified AAA command authorization method list to the
interface.
Default Values
By default, no AAA command authorization method list is applied to the line interface.
Command History
Functional Notes
AAA command authorization method lists are used to allow or restrict the use of certain commands on a
per-user basis. For more information about configuring command authorization lists, refer to the command
aaa authorization commands <level> on page 740.
Usage Examples
The following example specifies that AAA command authorization list Authorization1 is applied to the
Level 15 commands on all console line:
(config-con 0)#authorization commands 15 Authorization1

authorization exec <listname>

Use the authorization exec command to assign authentication, authorization, and accounting (AAA)
Enable mode authorization method lists to line interfaces. You must first turn AAA on for this command to
the AAA Enable mode authorization method list from the interface. Variations of this command include:
authorization exec default

Syntax Description
default Applies the default AAA Enable mode authorization method list to the
interface.
<listname> Applies the specified AAA Enable mode authorization method list to the
interface.
Default Values
By default, no AAA Enable mode authorization method list is applied to the line interface.
Command History
Functional Notes
AAA Enable mode authorization method lists are used to allow or restrict user access to the privileged
command line interface (CLI) mode (Enable mode). For more information about configuring Enable mode
authorization lists, refer to the command aaa authorization exec on page 745.
Usage Examples
The following example specifies that AAA Enable mode authorization list ExecList1 is applied to the
console line:
(config-con 0)#authorization exec ExecList1

databits <value>
Use the databits command to set the number of databits per character for a terminal session. This value
must match the configuration of your VT100 terminal or terminal emulator software. Use the no form of
this command to return to the default value.
Syntax Description
<value> Specifies the data bits per character. Select from 7 or 8 databits per
character.
Default Values
By default, the databits are set to 8.
Command History
Usage Examples
The following example configures 7 databits per character for the console terminal session:
(config-con 0)#databits 7

flowcontrol
Use the flowcontrol command to set flow control for the line console. Use the no form of this command to
flowcontrol none
flowcontrol software in
Syntax Description
none Specifies no flow control.
software in Configures AOS to derive flow control from the attached device.
Default Values
By default, flow control is set to none.
Command History
Usage Examples
The following example configures no flow control for the line console:
(config-con 0)#flowcontrol none

line-timeout <value>
Use the line-timeout command to specify the number of minutes a line session may remain inactive before
AOS terminates the session. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the number of minutes a line session may remain inactive before
AOS terminates the session. Range is 0 to 35791 minutes.
Entering a line-timeout value of 0 disables the feature.
Default Values
By default, the line-timeout is set to 15 minutes (Console and Telnet).
Command History
Usage Examples
The following example specifies a timeout of 2 minutes:
(config-con 0)#line-timeout 2

login
Use the login command to enable security login on the line session. Additionally, it is necessary to
configure the password using the command password <password> on page 1220. Use the no form of this
command to disable the login feature.
Syntax Description
No subcommands.
Default Values
By default, secure login is disabled.
Command History
Usage Examples
The following example enables the security login feature and specifies a password (mypassword) on the
available console session:
(config-console 0)#login
(config-con 0)#password mypassword

login authentication <listname>

Use the login authentication command to apply the named authentication, authorization, and accounting
(AAA) login method list to the line interface for authenticating users connecting to the interface. Use the
no form of this command to remove the authentication method list from the interface.
Syntax Description
<listname> Specifies the AAA login authentication method list to use for authentication.
Default Values
By default, no AAA login authentication method list is specified. If AAA is enabled (using the command aaa
on on page 751), but no login authentication method list is specified, the default login authentication
method list is used. If the default list is used, but the default list has not been configured, console interfaces
will automatically grant access (to prevent a lockout situation).
Command History
Functional Notes
AAA login authentication method lists are used to verify user logins on the line interface. For more
information about configuring login authentication method lists, refer to the command aaa authentication
login on page 733.
Usage Examples
The following example specifies that the AAA login authentication method list AuthList1 is applied to the
console line:
(config-con 0)#login authentication AuthList1

login local-userlist
Use the login local-userlist command to enable security login for the terminal session. It is required to
configure user names and passwords using the username/password command from the Global
Configuration mode (refer to username <username> password <password> on page 1125). Use the no
form of this command to disable the login local-userlist feature.
All user properties assigned using the username/password command are valid when using
the login local-userlist command.
Syntax Description
No subcommands.
Default Values
By default, there is no login password set to access the unit.
Command History
Usage Examples
The following example displays creating a local userlist and enabling the security login feature on the
CONSOLE port:
(config)#username my_user password my_password

(config-con 0)#login local-userlist
When connecting to the unit, the following prompts are displayed:
User Access Login

Username: ADTRAN
Password:
Router#

parity
Use the parity command to specify the type of parity used as error correction. This value must match the
configuration of your VT100 terminal or terminal emulator software. Use the no form of this command to
return to the default value. Variations of this command include:
parity even
parity mark
parity none
parity odd
parity space
Syntax Description
even Sets the parity bit to 0 if the number of 1 bits in the data sequence is odd, or
set to 1 if the number of 1 bits is even.
mark Always sets the parity bit to 1.
none No parity bit used.
odd Sets the parity bit to 1 if the number of 1 bits in the data sequence is even,
or set to 1 if the number is odd.
space Always sets the parity bit to 0.
Default Values
By default, the parity option is set to none.
Command History
Functional Notes
Parity is the process used to detect whether characters have been altered during the data transmission
process. Parity bits are appended to data frames to ensure that parity (whether it be odd or even) is
maintained.
Usage Examples
The following example specifies mark parity for the console terminal session:
(config-con 0)#parity mark

password <password>
Use the password command to configure the password (with optional encryption) required on the line
session when security login is enabled (using the command login on page 1216). Use the no form of this
command to remove a configured password. Variations of this command include:
password <password>
password md5 <password>
Syntax Description
<password> Specifies the password for the line session using an alphanumeric
character string (up to 16 characters).
md5 Specifies message digest 5 (MD5) as the encryption protocol to use when
displaying the enable password during show commands. If the MD5
keyword is not used, encryption is not used when displaying the enable
password during show commands.
Default Values
By default, there is no login password set for access to the unit.
Command History
Release 6.1 Encryption was added.
Usage Examples
The following example enables the security login feature and specifies a password on the CONSOLE port:
(config-con 0)#login
(config-con 0)#password mypassword
To provide extra security, AOS can encrypt the enable password when displaying the current configuration.
enable password (ADTRAN):
!
!
Alternately, the following is a show configuration printout (password portion) with an enable password of
ADTRAN using md5 encryption:
!
!

speed <rate>
Use the speed command to specify the data rate for the CONSOLE port. This setting must match your
VT100 terminal emulator or emulator software. Use the no form of this command to restore the default
value.
Syntax Description
<rate> Specifies rate of data transfer on the interface (2400; 4800; 9600; 19200;
38400; 57600; or 115200 bps).
Default Values
By default, the speed is set to 9600 bps.
Command History
Usage Examples
The following example configures the CONSOLE port for 19200 bps:
(config-con 0)#speed 19200

stopbits <value>
Use the stopbits command to set the number of stopbits per character for a terminal session. This value
must match the configuration of your VT100 terminal or terminal emulator software. The default is
1 stopbit per character. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the stopbits per character. Select from 1 or 2 stopbits per
character.
Default Values
By default, the stopbits are set to 1.
Command History
Usage Examples
The following example configures 2 stopbits per character for the console terminal session:
(config-con 0)#stopbits 2

Command Reference Guide Line (SSH) Interface Command Set
LINE (SSH) INTERFACE COMMAND SET
To activate the Line Secure Shell (SSH) Interface Configuration mode, enter the line ssh command
specifying a SSH session(s) at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-ssh0-4)#
You can select a single line by entering the line ssh command followed by the line number (0-4). For
example:
>enable
#configure terminal
(config)#line ssh 2
(config-ssh2)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61
access-class <name> in on page 1224

login on page 1232

access-class <name> in
Use the access-class in command to restrict secure shell (SSH) access using a configured access control
list (ACL). Received packets passed by the ACL will be allowed. Use the ACL configuration to deny hosts
or entire networks or to permit specified IP addresses. Use the no form of this command to disable this
feature. Refer to ip access-list standard <name> on page 817 and ip access-list extended <name> on page
815 for more information about configuring ACLs. Variations of this command include:
access-class <name> in any-vrf
Syntax Description
<name> Identifies the configured ACL using an alphanumeric descriptor (all ACL
descriptors are case sensitive).
any-vrf Optional. Allows incoming connections from any VPN routing and
forwarding (VRF) instance based on the parameters set in the access class
list. Without this keyword, the ACL only applies to the default VRF and all
Telnet/SSH connections on nondefault VRFs will be ignored.
Default Values
By default, there are no configured ACLs associated with SSH sessions.
Command History
Functional Notes
When using the access-class in command to associate an ACL with an SSH session, remember to
duplicate the access-class in command for all configured SSH sessions 0 through 4. SSH access to the
unit using a specific SSH session is not possible. Users will be assigned the first available SSH session.

Usage Examples
The following example associates the ACL Trusted (to allow SSH sessions from the 192.22.56.0 /24
network) with all SSH sessions (0 through 4) on all VRF instances:
Create the ACL:
(config)#ip access-list standard Trusted

(config)#permit 192.22.56.0 0.0.0.255
Enter the line (SSH):
Associate the ACL with the SSH session:
(config-ssh0-4)#access-class Trusted in any-vrf



Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
commands on all secure shell (SSH) lines:
(config-ssh0-4)#accounting commands 15 Accounting1



Syntax Description
interface.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies that AAA connection accounting list AcctConn1 is applied to all secure
shell (SSH) lines:
(config-ssh0-4)#accounting connection AcctConn1



Syntax Description
interface.
Default Values
Command History
Functional Notes
page 723.
Usage Examples
The following example specifies that AAA executive accounting list Inboundacct1 is applied to all secure
shell (SSH) lines:
(config-ssh0-4)#accounting exec Inboundacct1


command include:

Syntax Description
interface.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies that AAA command authorization list Authorization1 is applied to all
Level 15 commands on all secure shell (SSH) lines:
(config-ssh0-4)#authorization commands 15 Authorization1



Syntax Description
interface.
interface.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies that AAA Enable mode authorization list ExecList1 is applied to all secure
shell (SSH) lines:
(config-ssh0-4)#authorization exec ExecList1

Syntax Description
AOS terminates the session. Valid range: 0 to 35791.
Default Values
By default, the line-timeout is set to 15 minutes.
Command History
Usage Examples
The following example specifies a timeout of 2 minutes for all secure shell (SSH) sessions:
(config-ssh0-4)#line-timeout 2

login
Use the login command to enable security login on the line session requiring the password configured
using the password command. Use the no form of this command to disable the login feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the security login feature and specifies a password (mypassword) on all
the available secure shell (SSH) sessions (0 through 4):
(config-ssh0-4)#login
(config-ssh0-4)#password mypassword


Syntax Description
Default Values
method list is used. If the default list is used, but the default list has not been configured, secure shell
(SSH) interfaces use the local user database for authentication.
Command History
Functional Notes
login on page 733.
Usage Examples
The following example specifies that the AAA login authentication method list AuthList1 is applied to all
SSH lines:
(config-ssh0-4)#login authentication AuthList1

Use the login local-userlist command to check the local list of user names and passwords configured using
the username/password Global Configuration command (refer to username <username> password
<password> on page 1125).
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example creates a local userlist and enables the security login feature:

(config)#line ssh 0
(config-ssh0)#login local-userlist
User Access Login

Username: my_user
Password:
#

Command Reference Guide Line (Telnet) Interface Command Set
LINE (TELNET) INTERFACE COMMAND SET
To activate the Line (Telnet) Interface Configuration mode, enter the line telnet command specifying a
Telnet session(s) at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-telnet0-4)#
You can select a single line by entering the line telnet command followed by the line number (0-4). For
example:
>enable
#configure terminal
(config-telnet2)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61

login on page 1244

Use the access-class in command to restrict secure shell (SSH) access using a configured access control
list (ACL). Received packets passed by the ACL will be allowed. Use the ACL configuration to deny hosts
or entire networks or to permit specified IP addresses. Use the no form of this command to disable this
feature. Refer to ip access-list standard <name> on page 817 and ip access-list extended <name> on page
815 for more information about configuring ACLs. Variations of this command include:
access-class <name> in any-vrf
Syntax Description
<name> Identifies the configured ACL using an alphanumeric descriptor (all ACL
any-vrf Optional. Allows incoming connections from any VPN routing and
forwarding (VRF) instance based on the parameters set in the access class
list. Without this keyword, the ACL only applies to the default VRF and all
Telnet/SSH connections on nondefault VRFs will be ignored.
Default Values
By default, there are no configured ACLs associated with SSH sessions.
Command History
Functional Notes
When using the access-class in command to associate an ACL with an SSH session, remember to
duplicate the access-class in command for all configured SSH sessions 0 through 4. SSH access to the
unit using a specific SSH session is not possible. Users will be assigned the first available SSH session.

Usage Examples
The following example associates the ACL Trusted (to allow Telnet sessions from the 192.22.56.0 /24
network) with all Telnet sessions (0 through 4) on all VRF instances:
Create the ACL:

(config)#permit 192.22.56.0 0.0.0.255
Enter the line (Telnet):
Associate the ACL with the Telnet session:
(config-telnet0-4)#access-class Trusted in any-vrf



Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
commands on all Telnet lines:
(config-telnet0-4)#accounting commands 15 Accounting1



Syntax Description
interface.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies that AAA connection accounting list AcctConn1 is applied to all Telnet
lines:
(config-telnet0-4)#accounting connection AcctConn1



Syntax Description
interface.
Default Values
Command History
Functional Notes
page 723.
Usage Examples
The following example specifies that AAA executive accounting list Inboundacct1 is applied to all Telnet
lines:
(config-telnet0-4)#accounting exec Inboundacct1


command include:

Syntax Description
interface.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies that AAA command authorization list Authorization1 is applied to all
Level 15 commands on all Telnet lines:
(config-telnet0-4)#authorization commands 15 Authorization1



Syntax Description
interface.
interface.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies that AAA Enable mode authorization list ExecList1 is applied to all Telnet
lines:
(config-telnet0-4)#authorization exec ExecList1

Syntax Description
AOS terminates the session. Range is 0 to 35791 minutes.
Default Values
By default, the line-timeout is set to 15 minutes (Console and Telnet).
Command History
Usage Examples
The following example specifies a timeout of 2 minutes:
(config-telnet0)#line-timeout 2

login
Use the login command to enable security login on the line session requiring the password configured
using the password command. Use the no form of this command to disable the login feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the security login feature and specifies a password on all the available
Telnet sessions (0 through 4):
(config-telnet0-4)#login
(config-telnet0-4)#password mypassword


Syntax Description
Default Values
method list is used. If the default list is used, but the default list has not been configured, Telnet interfaces
use the local user database for authentication.
Command History
Functional Notes
login on page 733.
Usage Examples
The following example specifies that the AAA login authentication method list AuthList1 is applied to all
Telnet lines:
(config-telnet0-4)#login authentication AuthList1

Use the login local-userlist command to enable security login for the terminal session requiring the user
names and passwords configured using the username/password Global Configuration command. Use the
no form of this command to disable the login local-userlist feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example displays creating a local userlist and enabling the security login feature:

(config-telnet0)#login local-userlist
User Access Login

Username: my_user
Password:
Router#

password <password>
Use the password command to configure the password (with optional encryption) required on the line
session when security login is enabled (using the login command). Use the no form of this command to
remove a configured password. Variations of this command include:
password <password>
password md5 <password>
Syntax Description
<password> Specifies the password for the line session using an alphanumeric
character string (up to 16 characters).
md5 Optional. Specifies message digest 5 (MD5) as the encryption protocol to use
when displaying the enable password during show commands. If the MD5
keyword is not used, encryption is not used when displaying the enable
password during show commands.
Default Values
Command History
Usage Examples
The following example enables the security login feature and specifies a password for the Telnet session 0:
(config-telnet0)#login
(config-telnet0)#password mypassword
To provide extra security, AOS can encrypt the enable password when displaying the current configuration.
enable password (ADTRAN):
!
!
Alternately, the following is a show configuration printout (password portion) with an enable password of
ADTRAN using md5 encryption:
!
!

PHYSICAL INTERFACE COMMAND SETS

• ADSL Interface Command Set on page 1249

• BRI Interface Command Set on page 1253
• Cellular Interface Command Set on page 1263
• DDS Interface Command Set on page 1275
• DSX-1 Interface Command Set on page 1283
• E1 Interface Command Set on page 1293
• Ethernet Interface Command Set on page 1309
• FDL Interface Command Set on page 1422
• FXO Interface Command Set on page 1428
• FXS Interface Command Set on page 1439
• G.703 Interface Command Set on page 1452
• HSSI Interface Command Set on page 1459
• Modem Interface Command Set on page 1463
• PRI Interface Command Set on page 1468
• Serial Interface Command Set on page 1477
• SHDSL Interface Command Set on page 1486
• T1 Interface Command Set on page 1500
• T3 Interface Command Set on page 1517

Command Reference Guide ADSL Interface Command Set
ADSL INTERFACE COMMAND SET
To activate the ADSL Interface Configuration mode, enter the interface adsl command at the Global
Configuration mode prompt. For example:
>enable
#configure terminal
(config-adsl 0/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
retrain on page 1250

snr-margin on page 1251
training-mode on page 1252

retrain
Use the retrain command to force the modem to retrain.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example forces a modem retrain:

(config-adsl 0/1)#retrain

snr-margin
Use the snr-margin command to enable monitoring and set the minimum signal-to-noise ratio (SNR)
during training and showtime. Use the no form of this command to disable monitoring. Variations of this
command include:
snr-margin <margin>
snr-margin showtime monitor
snr-margin training monitor
Syntax Description
<margin> Sets the minimum SNR margin value in dB. The range is from 1 to 15 dB.
showtime monitor Enables margin monitoring to retrain the asymmetric digital subscriber line
(ADSL) interface if the specified minimum margin is violated during
showtime.
training monitor Enables margin monitoring to retrain the ADSL interface if the specified
minimum margin is violated during training.
Default Values
By default, SNR margin monitoring is disabled.
Command History
Usage Examples
The following example enables SNR margin monitoring during showtime with a minimum level of 7 dB:

(config-adsl 0/1)#snr-margin showtime monitor 7

training-mode
Use the training-mode command to configure the asymmetric digital subscriber line (ADSL) training
mode. Use the no form of this command to disable a specific training mode. Variations of this command
include:
training-mode ADSL2
training-mode ADSL2+
training-mode ADSL2+ANNEX-M
training-mode G.DMT
training-mode G.LITE
training-mode Multi-Mode
training-mode READSL2
training-mode T1.413
Syntax Description
ADSL2 Specifies International Telecommunication Union (ITU) G.992.3 mode.
ADSL2+ Specifies ITU G.992.5 mode.
ADSL2+ANNEX-M Specifies ITU G.992.5 Annex M mode.
G.DMT Specifies ANSI full-rate mode.
G.LITE Specifies ANSI splitterless mode.
Multi-Mode Specifies auto detect mode. When set to multi-mode, the ADSL interface
attempts to train to the DSLAM using each of the supported training modes
until a match is found.
READSL2 Specifies ITU G.992.3 Annex L mode.
T1.413 Specifies ANSI T1.413 mode.
Default Values
By default, the training mode is set to Multi-Mode.
Command History
Release 13.1 Command was expanded to include the ITU G.992.5 Annex M mode.
Functional Notes
Some of the listed training modes (G.LITE, T1.413, ADSL2, ADSL2+, READSL2) are currently supported
for ADSL over plain old telephone service (POTS) (Annex A) and are not valid for ADSL over integrated
services digital network (ISDN) (Annex B) modules.
Usage Examples
The following example sets the training mode to T1.413:

(config-adsl 0/1)#training-mode T1.413

Command Reference Guide BRI Interface Command Set
BRI INTERFACE COMMAND SET
To activate the BRI Interface Configuration mode, enter the interface bri command at the Global
>enable
#configure terminal
(config-bri 1/2)#
The BRI number in the example above is shown as bri 1/2. This number is based on the
interface’s location (slot/port) and could vary depending on the unit’s configuration. Use
the do show interfaces command to determine the appropriate interface number.

do on page 51
end on page 52
exit on page 53
shutdown on page 61
caller-id-override on page 1254

isdn ldn on page 1255
isdn spid on page 1256
isdn switch-type on page 1258
loopback local on page 1259
loopback network on page 1260
maintenance on page 1261
resource pool-member <name> on page 1262

caller-id-override
Use the caller-id-override command to configure the unit to replace caller ID information with a
user-specified number. Use the no form of this command to disable any caller ID overrides. Variations of
caller-id-override always <number>

caller-id-override if-no-cid <number>
Syntax Description
always <number> Always forces replacement of the incoming caller ID number with the
number given.
if-no-cid <number> Replaces the incoming caller ID number with the number given only if there
is no caller ID information available for the incoming call.
Default Values
Command History
Functional Notes
This command forces a replacement of the incoming caller ID number with the number given. The received
caller ID, if any, is discarded, and the given override number is used to connect the incoming call to a
circuit of the same number.
Usage Examples
The following example configures the unit to always provide the given number as the caller ID number:

(config-bri 1/2)#caller-id-override always 5551000

isdn ldn
Use the isdn ldn command to specify the local directory numbers (LDNs) for the basic rate interface
(BRI). This information should be supplied by your service provider. Use the no form of this command to
remove a configured LDN. Variations of this command include:
isdn ldn1 <ldn number>

isdn ldn2 <ldn number>
The BRI module requires all incoming calls to be directed to the LDN associated with the
service profile identifier (SPID ) programmed using the isdn spid1 command. All calls to
the LDN associated with SPID 2 will be rejected (unless part of a bonding call).
Syntax Description
ldn1 Specifies the LDN associated with the SPID entered as spid1.
ldn2 Specifies the LDN associated with the SPID entered as spid2.
<ldn number> Specifies the LDN assigned to the circuit by the service provider. The LDN
is the number used by remote callers to dial into the integrated services
digital network (ISDN) circuit.
Default Values
By default, there are no configured LDNs.
Command History
Functional Notes
Inbound calls are not accepted on interfaces without programmed LDNs. LDNs can also be entered using
the isdn spid command. The isdn spid and isdn ldn commands overwrite the existing programmed LDN;
therefore, the latest LDN programmed takes precedence.
Usage Examples
The following example defines an LDN of 555-1111:

(config-bri 1/2)#isdn ldn1 5551111

isdn spid
Use the isdn spid command to specify the service profile identifiers (SPIDs) and the local directory
numbers (LDNs) for the basic rate interface (BRI). This information should be supplied by your service
provider. Use the no form of this command to remove a configured SPID. Variations of this command
include:
isdn spid1 <spid number> <ldn number>

isdn spid2 <spid number> <ldn number>
The BRI module requires all incoming calls to be directed to the LDN associated with the
SPID programmed using the isdn spid1 command. All calls to the LDN associated with
SPID 2 will be rejected (unless part of a bonding call).
Syntax Description
spid1 Specifies the primary SPID.
spid2 Specifies the secondary SPID.
<spid number> Specifies the 8- to 14-digit number identifying your BRI line in the central
office switch. A SPID is generally created using the area code and phone
number associated with the line and a four-digit suffix. For example, the
following SPIDs may be provided on a BRI line with phone numbers
555-1111 and 555-1112:
SPID 1: 701 555 1111 0101
SPID 2: 701 555 1112 0101
<ldn number> Optional. Specifies the LDN assigned to the circuit by the service provider.
An LDN programmed using the isdn spid1 command is automatically
associated with SPID 1. An LDN programmed using the isdn spid2
command is automatically associated with SPID 2. The LDN is the number
used by remote callers to dial into the integrated services digital network
(ISDN) circuit. Inbound calls are not accepted on interfaces without
programmed LDNs. LDNs can also be entered using the isdn ldn
command. The isdn spid and isdn ldn commands overwrite the existing
programmed LDN; therefore, the latest LDN programmed takes
precedence.
Default Values
By default, there are no configured SPIDs or LDNs.
Command History

Functional Notes
AOS does not support “SPID-less” 5ESS signaling. SPIDs are required for all configured BRI endpoints
using 5ESS signaling.
For European applications, a SPID is not necessary. Use the isdn ldn command to configure the LDN for
European applications.
Usage Examples
The following example defines a SPID of 704 555 1111 0101 with an LDN of 555 1111:

(config-bri 1/2)#isdn spid1 70455511110101 5551111

isdn switch-type
Use the isdn switch-type command to specify the integrated services digital network (ISDN) signaling
type configured on the basic rate interface (BRI). The type of ISDN signaling implemented on the BRI
does not always match the manufacturer of the central office switch. Use the no form of this command to
isdn switch-type basic-5ess

isdn switch-type basic-dms
isdn switch-type basic-net3
isdn switch-type basic-ni
Syntax Description
basic-5ess Specifies Lucent/AT&T 5ESS signaling.
basic-dms Specifies Nortel DMS-100 custom signaling.The basic-dms signaling type
is not compatible with proprietary SL-1 DMS signaling.
basic-net3 Specifies Net3 Euro-ISDN signaling.
basic-ni Specifies National ISDN-1 signaling.
Default Values
By default, the ISDN signaling is set to National ISDN-1 (basic-ni).
Command History
Functional Notes
The isdn switch-type command specifies the type of ISDN signaling implemented on the BRI, not the
manufacturer of the central office switch. It is quite possible to have a Lucent Central Office switch
providing National ISDN signaling on the BRI.
Usage Examples
The following example configures a BRI for a circuit with Lucent 5ESS (custom) signaling:

(config-bri 1/2)#isdn switch-type basic-5ess

loopback local
Use the loopback local command to enable a local loopback of the interface (towards the router). Use the
no form of this command to disable the loopback. Variations of this command include:
loopback local all

loopback local b1
loopback local b2
loopback local both
Syntax Description
all Loops the entire interface back towards the router (including the
D-channel). With an active loopback active all, the established D-channel
between the integrated services digital network (ISDN) module and the
central office switch drops.
b1 Loops the data on B1 back towards the router. A B1 loopback does not
disrupt D-channel signaling.
b2 Loops the data on B2 back towards the router. A B2 loopback does not
both Loops the data on B1 and B2 back towards the router, but does not disrupt
D-channel signaling.
Default Values
Command History
Usage Examples
The following example enables a B2 loopback of the basic rate interface (BRI) 1/2 interface:

(config-bri 1/2)#loopback local b2

loopback network
Use the loopback network command to enable a loopback of the interface (towards the network). Use the
no form of this command to disable the loopback. Variations of this command include:
loopback network b1
loopback network b2
loopback network both
Syntax Description
b1 Loops the data on B1 back towards the network. A B1 loopback does not
b2 Loops the data on B2 back towards the network. A B2 loopback does not
both Loops the data on B1 and B2 back towards the network, but does not
Default Values
Command History
Usage Examples
The following example enables a B2 loopback of the basic rate interface (BRI) 1/2 interface:

(config-bri 1/2)#loopback network b2

maintenance
Use the maintenance command to force a reset of the interface (initiating the SABME/UA process) or to
reset the D-channel (by sending a RESTART message). Variations of this command include:
maintenance reset
maintenance restart-d
The maintenance command disrupts data flow on the integrated services digital network
(ISDN) interface. All active calls will drop when the reset or restart process begins.
Syntax Description
reset Forces a complete reset of the interface by initiating the SABME/UA
process.
restart-d Resets the D-channel by sending a Q.931 RESTART message to the
central office switch.
Default Values
Command History
Usage Examples
The following example resets the basic rate interface (BRI) 1/2 interface:

(config-bri 1/2)#maintenance reset

resource pool-member <name>

Use the resource pool-member command to assign the interface to a resource pool, making it a demand
routing resource. Use the no form of this command to return to the default value. Variations of this
command include:

resource pool-member <name> <priority>
Syntax Description
<name> Specifies the name of the resource pool to which this interface is assigned.
<priority> Optional. Specifies the priority value of using this interface versus other
interfaces contained in the specified resource pool using a number 1 to 255.
Lower numbers indicate higher priority. Interfaces with the same priority are
selected in alphabetical order by interface name.
Default Values
By default, the interface is not assigned to any resource pool.
Command History
Usage Examples
The following example configures a basic rate interface (BRI) as a member of resource pool MyPool:

(config-bri 1/2)#resource pool-member MyPool

Command Reference Guide Cellular Interface Command Set
CELLULAR INTERFACE COMMAND SET
To create a cellular interface and activate the Cellular Interface Configuration mode, enter the interface
cellular command at the Global Configuration mode prompt. For example:
>enable
#configure terminal

exit on page 53
shutdown on page 61
All other commands for this command set are described in this section in alphabetical order:
cdma activate oma-dm on page 1264

cdma activate otasp on page 1265
custom-profile ha-shared-secret on page 1266
custom-profile home-address <ip address> on page 1267
custom-profile primary-ha-address <ip address> on page 1268
custom-profile secondary-ha-address <ip address> on page 1269
custom-profile username <username> on page 1270
reset on page 1271
retry-throttling on page 1273
retry-throttling on page 1273

cdma activate oma-dm

Use the cdma activate oma-dm command to activate the cellular interface for connection to the Sprint
wireless network.
Syntax Description
No subcommands.
Default Values
By default, the cellular interface is deactivated.
Command History
Usage Examples
The following example activates cellular interface 1/1:

(config-cellular-1/1)#cdma activate oma-dm

cdma activate otasp

Use the cdma activate otasp command to activate the cellular interface for connection to the Verizon
wireless network.
Syntax Description
No subcommands.
Default Values
By default, the cellular interface is disabled.
Command History
Usage Examples
The following example activates cellular interface 1/1:

(config-cellular 1/1)#cdma activate otasp

custom-profile ha-shared-secret
Use the custom-profile ha-shared-secret command to specify the home agent shared secret for the
cellular custom profile. Use the no form of this command to remove the shared secret from the custom
profile configuration. Variations of this command include:
custom-profile ha-shared-secret ascii <shared secret>

custom-profile ha-shared-secret hexadecimal <shared secret>
Syntax Description
ascii <shared secret> Specifies a plain text secret. Secret can be up to 16 characters in length.
hexadecimal <shared secret> Specifies a hexadecimal secret. Secret can be up to 32 characters in
length.
Default Values
By default, no custom profile is configured.
Command History
Functional Notes
Cellular custom profile settings are useful for services that require manual activation or for services that
allow remote access to private networks over the 3G network. For more information about custom profile
settings, refer to the 3G CDMA NIM and the Cellular Interface configuration guide available on the AOS
Documentation CD shipped with your product or online at http://kb.adtran.com (article number 2331).
Usage Examples
The following example creates a plain text home agent shared secret (sharedsecret) for the custom
profile:

(config-cellular 1/1)#custom-profile ha-shared-secret ascii sharedsecret

custom-profile home-address <ip address>

Use the custom-profile home-address command to specify the home address for the cellular custom
profile. Use the no form of this command to remove the home address from the custom profile settings.
Syntax Description
<ip address> Specifies the IP address of the home address. Enter IP addresses in dotted
decimal notation (XX.XX.XX.XX).
Default Values
Command History
Functional Notes
Usage Examples
The following example creates the home address for the custom profile:

(config-cellular 1/1)#custom-profile home-address 192.168.1.1

custom-profile primary-ha-address <ip address>

Use the custom-profile primary-ha-address command to specify the primary home agent IP address for
the cellular custom profile. Use the no form of this command to remove the primary home agent IP address
from the custom profile settings.
Syntax Description
<ip address> Specifies the IP address of the primary home agent. Enter IP addresses in
dotted decimal notation (XX.XX.XX.XX).
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies the primary home agent IP address for the custom profile:

(config-cellular 1/1)#custom-profile primary-ha-address 192.168.1.5

custom-profile secondary-ha-address <ip address>

Use the custom-profile secondary-ha-address command to specify the secondary home agent IP address
for the cellular custom profile. Use the no form of this command to remove the secondary home agent IP
address from the custom profile settings.
Syntax Description
<ip address> Specifies the IP address of the secondary home agent. Enter IP addresses
in dotted decimal notation (XX.XX.XX.XX).
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies the secondary home agent IP address for the custom profile:

(config-cellular 1/1)#custom-profile secondary-ha-address 192.168.1.6

custom-profile username <username>

Use the custom-profile username command to specify the username and password for the cellular custom
profile. Use the no form of this command to remove the username and password from the custom profile
settings. Variations of this command include:
custom-profile username <username>

custom-profile username <username> password ascii <password>
custom-profile username <username> password hexadecimal <password>
Syntax Description
username <username> Specifies the user name for the custom profile. The user
name is equivalent to network address identifier (NAI) user
identification. User names can be up to 72 characters in
length.
password ascii <password> Specifies the plain text password. Passwords are equivalent
to authentication, authorization, and accounting (AAA)
shared secrets. Passwords can be up to 16 characters in
length.
password hexadecimal <password> Specifies the hexadecimal password. Passwords are
equivalent to AAA shared secrets. Passwords can be up to
32 characters in length.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies the user name and plain text password for the custom profile:

(config-cellular 1/1)#custom-profile username USERNAME password ascii PASSWORD

reset
Use the reset command to reboot the cellular network interface module (NIM).
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example reboots the NIM associated with cellular interface 1/1:

(config-cellular 1/1)#reset


Use the resource pool-member command to configure the cellular interface as a resource pool member
for the demand interface to draw upon when connecting to the cellular network. Use the no form of this
command to remove the interface from the resource pool. Variations of this command include:

resource pool-member <name> <priority>
Syntax Description
<name> Specifies the resource pool to which the cellular interface is assigned.
<priority> Optional. Specifies the priority this interface is given over other interfaces in
the same pool. Range is 1 to 255.
Default Values
By default, the cellular interface is not associated with any resource pools.
Command History
Functional Notes
Lower priority values indicate a higher priority. Interfaces within the same resource pool with the same
priority are selected as resources in alphabetical order by interface name.
Usage Examples
The following example configures interface cellular 1/1 as a member of the cellular resource pool:

(config-cellular 1/1)#resource pool-member cellular

retry-throttling
Use the retry-throttling command to enable retry throttling. Use the no form of this command to disable
retry throttling.
Syntax Description
No subcommands.
Default Values
In the Verizon cellular network, the retry throttle is enabled and cannot be disabled.
In the Sprint cellular network, the retry throttle is disabled by default but can be enabled by using this
command.
Command History
Functional Notes
When the retry throttle is enabled, it will disable the cellular interface for 15 minutes if a data call fails.
Usage Examples
The following example enables retry throttling:

(config-cellular 1/1)#retry-throttling

snmp trap link-status

Use the snmp trap link-status command to control the Simple Network Management Protocol (SNMP)
variable ifLinkUpDownTrapEnable (RFC 2863) to enable (or disable) the interface to send SNMP traps
when there is an interface status change. Use the no form of this command to disable this trap.
Syntax Description
No subcommands.
Default Values
By default, the ifLinkUpDownTrapEnable object identifier (OID) is enabled for all interfaces except virtual
Frame Relay interfaces.
Command History
Release 5.1 Command was expanded to include the Ethernet subinterfaces and Gigabit
Ethernet interfaces.
Release 6.1 Command was expanded to include the E1, port channel, T3, and virtual
local area network (VLAN) interfaces.
Release 7.1 Command was expanded to the high speed serial interface (HSSI).
Release 8.1 Command was expanded to the asynchronous transfer mode (ATM)
interface.
Release 9.1 Command was expanded to the high level data link control (HDLC)
interface.
Release 11.1 Command was expanded to the demand interface.
Release 16.1 Command was expanded to the tunnel interface.
Release 17.2 Command was expanded to the cellular interface.
Functional Notes
The snmp trap link-status command is used to control the RFC 2863 ifLinkUpDownTrapEnable OID (OID
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on interface cellular 1/1:

(config-cellular 1/1)#no snmp trap link-status

Command Reference Guide DDS Interface Command Set
DDS INTERFACE COMMAND SET
To activate the DDS Interface Configuration mode, enter the interface dds command at the Global
>enable
#configure terminal
(config-dds 1/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
clock rate on page 1276

clock source on page 1277
data-coding scrambled on page 1278
loopback on page 1279
remote-loopback on page 1280
snmp trap on page 1281
snmp trap link-status on page 1282

clock rate
Use the clock rate command to configure the data rate used as the operating speed for the interface. This
rate should match the rate required by the digital data service (DDS) service provider. Use the no form of
this command to return to the default value. Variations of this command include:
clock rate auto

clock rate bps56k
clock rate bps64k
Syntax Description
auto Automatically detects the clock rate and sets to match.
bps56k Sets the clock rate to 56 kbps.
bps64k Sets the clock rate to 64 kbps.
Default Values
By default, the rate is set to auto.
Command History
Functional Notes
When operating at 64 kbps (clear channel operation), the data terminal equipment (DTE) data sequences
may mimic network loop maintenance functions and erroneously cause other network elements to activate
loopbacks. Use the data-coding scrambled command to prevent such occurrences. Refer to data-coding
scrambled on page 1278 for related information.
Usage Examples
The following example configures the clock rate for 56 kbps operation:

(config-dds 1/1)#clock rate bps56k

clock source
Use the clock source command to configure the source timing used for the interface. The clock specified
using the clock source command is also the system master clock. Use the no form of this command to
clock source internal

clock source line
Syntax Description
internal Configures the unit to provide clocking using the internal oscillator.
line Configures the unit to recover clocking from the digital data service (DDS)
circuit.
Default Values
By default, the clock source is set to line.
Command History
Functional Notes
When operating on a DDS network, the clock source should be line. On a point-to-point private network,
one unit must be line and the other internal.
Usage Examples
The following example configures the unit to recover clocking from the circuit:

(config-dds 1/1)#clock source line

data-coding scrambled
Use the data-coding scrambled command to enable the digital data service (DDS) OS scrambler to
combine user data with pattern data to ensure user data does not mirror standard DDS loop codes. The
scrambler may only be used on 64 kbps circuits without Frame Relay signaling (clear channel). Use the no
Syntax Description
No subcommands.
Default Values
By default, the scrambler is disabled.
Command History
Functional Notes
When operating at 64 kbps (clear channel operation), there is a possibility the data terminal equipment
(DTE) data sequences may mimic network loop maintenance functions and erroneously cause other
network elements to activate loopbacks. Use the data-coding scrambled command to prevent such
occurrences. Do not use this command if using Frame Relay or if using Point-to-Point Protocol (PPP) to
another device other than an AOS product also running scrambled.
Usage Examples
The following example enables the DDS OS scrambler:

(config-dds 1/1)#data-coding scrambled

loopback
Use the loopback command to initiate a specified loopback on the interface. Use the no form of this
command to deactivate the loop. Variations of this command include:
loopback dte
loopback line
loopback remote
Syntax Description
dte Initiates a loop to connect the transmit and receive path through the unit.
line Initiates a loop of the digital data service (DDS) circuit toward the network
by connecting the transmit path to the receive path.
remote Transmits a DDS loop code over the circuit to the remote unit. In response,
the remote unit should initiate a line loopback.
Default Values
Command History
Usage Examples
The following example activates a line loopback on the DDS interface:

(config-dds 1/1)#loopback line

remote-loopback
Use the remote-loopback command to configure the interface to respond to loopbacks initiated by a
remote unit (or the service provider). Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, all interfaces respond to remote loopbacks.
Command History
Usage Examples
The following example enables remote loopbacks on the digital data service (DDS) interface:

(config-dds 1/1)#remote-loopback

snmp trap
Use the snmp trap command to enable all supported Simple Network Management Protocol (SNMP)
traps on the interface. Use the no form of this command to disable this trap.
Syntax Description
No subcommands.
Default Values
By default, all interfaces (except virtual Frame Relay interfaces and subinterfaces) have SNMP traps
enabled.
Command History
Release 6.1 Command was expanded to include the port channel and virtual local area
network (VLAN) interfaces.
interface.
Usage Examples
The following example enables SNMP capability on the digital data service (DDS) interface:

(config-dds 1/1)#snmp trap


Syntax Description
No subcommands.
Default Values
By default, the ifLinkUpDownTrapEnable object identifier (OID) is enabled for all supported interfaces
except virtual Frame Relay interfaces.
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the digital data service (DDS) interface:

(config-dds 1/1)#no snmp trap link-status

Command Reference Guide DSX-1 Interface Command Set
DSX-1 INTERFACE COMMAND SET
To activate the DSX-1 Interface Configuration mode, enter the interface t1 command (and specify the
DSX-1 port) at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-t1 1/2)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
coding on page 1284

framing on page 1285
line-length <value> on page 1286
loopback remote line inband on page 1288
signaling-mode on page 1290
test-pattern on page 1292

coding
Use the coding command to configure the line coding for a DSX-1 physical interface. This setting must
match the line coding supplied on the circuit by the PBX. Use the no form of this command to return to the
coding ami
coding b8zs
Syntax Description
ami Configures the line coding for alternate mark inversion (AMI).
b8zs Configures the line coding for bipolar eight zero substitution (B8ZS).
Default Values
By default, all DSX-1 interfaces are configured with b8zs line coding.
Command History
Functional Notes
The line coding configured in the unit must match the line coding of the DSX-1 circuit. A mismatch will
result in line errors (e.g., bipolar violations (BPVs)).
Usage Examples
The following example configures the DSX-1 interface for ami line coding:
(config-t1 1/2)#coding ami

framing
Use the framing command to configure the framing format for the DSX-1 interface. This parameter
should match the framing format set on the external device. Use the no form of this command to return to
the default value. Variations of this command include:
framing d4
framing esf
Syntax Description
d4 Specifies D4 superframe (SF) format.
esf Specifies extended superframe (ESF) format.
Default Values
By default, the framing format is set to esf.
Command History
Functional Notes
A frame is comprised of a single byte from each of the T1’s timeslots; there are 24 timeslots on a single T1
circuit. Framing bits are used to separate the frames and indicate the order of information arriving at the
receiving equipment. D4 and ESF are two methods of collecting and organizing frames over the circuit.
Usage Examples
The following example configures the DSX-1 interface for d4 framing:
(config-t1 1/2)#framing d4

line-length <value>
Use the line-length command to set the line build out (LBO) (in feet or dB) for the DSX-1 interface. Use
the no form of this command to return to the default value.
Syntax Description
<value> Configures the LBO for the DSX-1 interface. Valid options include: -7.5 dB
or 0 to 655 feet. Use the -7.5 dB option for maximum attenuation.
Default Values
By default, the LBO is set to 0 feet.
Command History
Functional Notes
The line-length value represents the physical distance between DSX equipment (measured in cable
length). Based on this setting, the AOS device increases signal strength to compensate for the distance
the signal must travel. Valid distance ranges are listed below:
• 0 to 133 feet
• 134 to 265 feet
• 266 to 399 feet
• 400 to 533 feet
• 534 to 655 feet
Usage Examples
The following example configures the DSX-1 interface line-length for 300 feet:
(config-t1 1/2)#line-length 300

loopback network
Use the loopback network command to initiate a loopback on the interface toward the network. Use the
no form of this command to deactivate the loopback. Variations of this command include:
loopback network line

loopback network payload
Syntax Description
line Initiates a metallic loopback of the physical DSX-1 network interface.
payload Initiates a loopback of the T1 framer (CSU portion) of the DSX-1 network
interface.
Default Values
Command History
Functional Notes
The following diagram depicts the difference between a line and payload loopback.
T1 Network Interface
NI CSU
DS1
Payload Loopback
Line Loopback
Usage Examples
The following example initiates a payload loopback of the DSX-1 interface:
(config-t1 1/2)#loopback network payload

loopback remote line inband

Use the loopback remote line inband command to send a loopback code to the remote unit to initiate a
line loopback. Use the no form of this command to send a loopdown code to the remote unit to deactivate
the loopback.
Syntax Description
inband Uses the inband channel to initiate a full 1.544 Mbps physical (metallic)
loopback of the signal received by the remote unit from the network.
Default Values
Command History
Functional Notes
A remote loopback can only be issued if a cross connect does not exist on the interface and if the signaling
mode is set to none. The following diagram depicts the difference between a line and payload loopback.
NI CSU
DS1
Line Loopback
Usage Examples
The following example initiates a remote line loopback using the inband channel:
(config-t1 1/2)#loopback remote line inband

remote-loopback
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables remote loopbacks on the DSX-1 interface:
(config-t1 1/2)#remote-loopback

signaling-mode
Use the signaling-mode command to configure the signaling type (robbed-bit for voice or clear channel
for data) for the level zero digital signals (DS0s) mapped to the DSX-1 port. Use the no form of this
signaling-mode message-oriented
signaling-mode none
signaling-mode robbed-bit
Syntax Description
message-oriented Specifies clear channel signaling on Channel 24 only. Use this signaling
type with QSIG installations.
none Specifies clear channel signaling on all 24 DS0s. Use this signaling type
with data-only or primary rate interface (PRI) DSX-1 installations.
robbed-bit Specifies robbed bit signaling on all DS0s. Use this signaling type for
voice-only DSX-1 applications.
Default Values
By default, the signaling mode is set to robbed-bit.
Command History
Usage Examples
The following example configures the DSX-1 port for PRI compatibility:
(config-t1 1/2)#signaling-mode none


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the DSX-1 interface:
(config-t1 1/2)#no snmp trap link-status

test-pattern
Use the test-pattern command to activate the built-in pattern generator and begin sending the specified
test pattern. This pattern generation can be used to verify a data path when used in conjunction with an
active loopback. Use the no form of this command to cease pattern generation. Variations of this command
include:
test-pattern ones
test-pattern zeros
Syntax Description
ones Generates a test pattern of continuous ones.
zeros Generates a test pattern of continuous zeros.
Default Values
Command History
Usage Examples
The following example activates the pattern generator for a stream of continuous ones:
(config-t1 1/2)#test-pattern ones

Command Reference Guide E1 Interface Command Set
E1 INTERFACE COMMAND SET
To activate the E1 Interface Configuration mode, enter the interface e1 command (and specify the E1
port) at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#interface e1 1/1
(config-e1 1/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61

coding on page 1295
framing crc4 on page 1296
loop-alarm-detect on page 1297
loopback remote v54 on page 1299
sa4tx-bit <value> on page 1301
snmp trap line-status on page 1302
snmp trap threshold-reached on page 1304
system-timing on page 1305
tdm-group <number> on page 1306
ts16 on page 1308

clock source
Use the clock source command to configure the source timing used for the interface. Use the no form of

clock source line
clock source system
clock source through
Syntax Description
line Configures the unit to recover clocking from the E1 circuit.
system Configures the unit to provide clocking from the chassis selection.
through Configures the unit to recover clocking from the circuit connected to the
G.703 interface.
Default Values
By default, the unit is configured to recover clocking from the primary circuit.
Command History
Release A2 Command was expanded to include the system parameter.
Functional Notes
When operating on a circuit that is providing timing, setting the clock source to line can avoid errors, such
as clock slip seconds (CSS).
Usage Examples
The following example configures the unit to recover clocking from the primary circuit:
(config-e1 1/1)#clock source line

coding
Use the coding command to configure the line coding for the E1 physical interface. This setting must
match the line coding supplied on the circuit by the service provider. Use the no form of this command to
coding ami
coding hdb3
Syntax Description
hdb3 Configures the line coding for high-density bipolar 3 (HDB3).
Default Values
By default, all E1 interfaces are configured with hdb3 line coding.
Command History
Functional Notes
The line coding configured in the unit must match the line coding of the E1 circuit. A mismatch will result in
line errors (e.g., bipolar violations (BPVs)).
Usage Examples
The following example configures the E1 interface for ami line coding:
(config-e1 1/1)#coding ami

framing crc4
Use the framing crc4 command to configure the framing format for the E1 interface. This parameter
should match the framing format provided by the service provider or external device. Use the no form of
Syntax Description
crc4 Enables CRC4 bits to be transmitted in the outgoing data stream. Also, the
received signal is checked for CRC4 errors.
Default Values
By default, CRC4 is disabled.
Command History
Functional Notes
The framing value must match the configuration of the E1 circuit. A mismatch will result in a loss of frame
alarm.
Usage Examples
The following example configures the E1 interface for CRC4 framing:
(config-e1 1/1)#framing crc4

loop-alarm-detect
The loop-alarm-detect command enables detection of a loop alarm on the E1 interface. Use the no form
of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This command enables the detection of a loopback alarm. This alarm works in conjunction with the
sa4tx-bit command setting. The loopback condition is detected by comparing the transmitted sa4tx-bit
value to the received Sa4 bit value. If the bits match, a loopback is assumed. This detection method only
works with a network in which the far end is transmitting the opposite value for Sa4.
Usage Examples
The following example enables detection of a loop alarm on the E1 interface:
(config-e1 1/1)#loop-alarm-detect

loopback network

Syntax Description
line Initiates a metallic loopback of the physical E1 network interface.
payload Initiates a loopback of the E1 framer (CSU) portion of the E1 network
interface.
Default Values
Command History
Functional Notes
The following diagram depicts a line loopback.
E1 Network Interface
NI CSU
NTWK E1
Line Loopback
Usage Examples
The following example initiates a line loopback of the E1 interface:
(config-e1 1/1)#loopback network line

loopback remote v54

The loopback remote v54 command initiates an E1 remote loopback test (with a V.54 loopback pattern).
Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This command causes a V.54 inband loop code to be sent in the payload towards the far end.
Usage Examples
The following example sends a V.54 inband loop code to the far end:
(config-e1 1/1)#loopback remote v54

remote-loopback
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This controls the acceptance of any remote loopback requests. When enabled, remote loopbacks are
detected and cause a loopback to be applied. When disabled, remote loopbacks are ignored.
Usage Examples
The following example enables remote loopbacks on the E1 interface:
(config-e1 1/1)#remote-loopback

sa4tx-bit <value>
The sa4tx-bit command selects the Tx value of Sa4 in this E1 interface. Use the no form of this command
to return to the default value.
Syntax Description
<value> Specifies a 0 or a 1 for the transmit value of the SA4 bit on the E1.
Default Values
Command History
Functional Notes
This command assigns a value to the Tx spare bit in position 4. The odd-numbered frames of TS0 are not
used for frame alignment. Bits in position 4 through 8 are called spare bits. Values of 0 or 1 are accepted.
TS0 odd frame
Bit position 1 23 4 5 6 7 8
Bit use 0 1 RAI = 1S S S S S
Usage Examples
The following example sets the Tx value of Sa4 to 0:
(config-e1 1/1)#sa4tx-bit 0

snmp trap line-status

Use the snmp trap line-status command to control the Simple Network Management Protocol (SNMP)
variable dsx1LineStatusChangeTrapEnable (RFC 2495) to enable (or disable) the interface to send SNMP
traps when there is an interface status change. Use the no form of this command to disable this trap.
Syntax Description
No subcommands.
Default Values
By default, the dsx1LineStatusChangeTrapEnable object identifier (OID) is set to enabled for all interfaces
Command History
Functional Notes
The snmp trap line-status command is used to control the RFC 2495 dsx1LineStatusChangeTrapEnable
OID (OID number 1.3.6.1.2.1.10.18.6.1.17.0).
Usage Examples
The following example disables the line-status trap on the T1 interface:
(config-t1 1/1)#no snmp trap line-status


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the E1 interface:
(config-e1 1/1)#no snmp trap link-status

snmp trap threshold-reached

Use the snmp trap threshold-reached command to control the Simple Network Management Protocol
(SNMP) variable adGenAOSDs1ThresholdReached (adGenAOSDs1-Ext MIB) to enable the interface to
send SNMP traps when a DS1 performance counter threshold is reached. Use the no form of this command
to disable this trap.
Syntax Description
No subcommands.
Default Values
By default, the adGenAOSDs1ThresholdReached object identifier (OID) is enabled for all interfaces.
Command History
Usage Examples
The following example disables SNMP threshold reached trap on the E1 interface:
(config-e1 1/1)#no snmp trap threshold-reached

system-timing
Use the system-timing command to configure the system timing to use the E1 interface as the system
clock source. Use the no form of this command to return to the default value. Variations of this command
include:
system-timing primary
system-timing secondary
Syntax Description
primary Configures the unit to use the E1 interface as the source of the primary
system clock.
secondary Configures the unit to use the E1 interface as the source of the secondary
system clock.
Default Values
By default, the unit is configured to recover clocking from the primary circuit.
Command History
Usage Examples
The following example configures the unit to use the E1 interface as the primary system timing source:
(config-e1 1/1)#system-timing primary

tdm-group <number>
Use the tdm-group command to create a group of contiguous channels on this interface to be used during
the cross-connect process. Use the no form of this command to remove configured time division
multiplexing (TDM) groups. Refer to cross-connect on page 47 for related information. Variations of this
command include:
tdm-group <number> timeslots <value>

tdm-group <number> timeslots <value> speed [56 | 64]
Changing tdm-group settings could result in service interruption.
Syntax Description
<number> Identifies the created TDM group. Valid range is 1 to 255.
timeslots <value> Specifies the channels to be used in the TDM group. Valid range is 1 to 31.
The timeslot value can be entered as a single number representing one of
the 31 E1 channel timeslots or as a contiguous group of channels. (For
example, 1-10 specifies the first 10 channels of the E1.)
speed [56 | 64] Optional. Specifies the individual channel rate on the E1 interface to be
56 or 64 kbps. The default speed is 64 kbps. 56 kbps operation is not
available on all E1 interfaces. Refer to the quick start guide provided with
your E1 module to determine whether 56 kbps is valid.
Default Values
By default, there are no configured TDM groups.
Command History
Usage Examples
The following example creates a TDM group (labeled 5) of 10 channels at 64 kbps each:
(config-e1 1/1)#tdm-group 5 timeslots 1-10 speed 64

test-pattern
include:
test-pattern clear
test-pattern errors
test-pattern insert
test-pattern ones
test-pattern p215
test-pattern p220
test-pattern p511
test-pattern qrss
test-pattern zeros
Syntax Description
clear Clears the test pattern error count.
errors Displays the test pattern error count.
insert Inserts an error into the currently active test pattern.
ones Generates test pattern of continuous ones.
p215 Generates a pseudorandom test pattern sequence based on a 15-bit shift
register.
register.
p511 Generates a test pattern of repeating ones and zeros.
qrss Generates a test pattern of random ones and zeros.
zeros Generates test pattern of continuous zeros.
Default Values
Command History
Usage Examples
(config-e1 1/1)#test-pattern ones

ts16
Use the ts16 command to enable timeslot 16 multiframe to be checked on the receive signal. Use the no
form of this command to disable timeslot 16.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
If timeslot 16 is used on the incoming E1, do not map timeslot 16 using the tdm-group command. By
default, all timeslots not physically mapped using the tdm-group command are passed through to the
G.703 interface. Leaving timeslot 16 unmapped makes it available for multiframe signaling by the
connected E1 device.
Usage Examples
The following example enables timeslot 16 multiframing:
(config-e1 1/1)#ts16

Command Reference Guide Ethernet Interface Command Set
ETHERNET INTERFACE COMMAND SET
There are four types of Ethernet interfaces associated with AOS:
• Basic Ethernet interfaces (e.g., eth 0/1)

• Gigabit Ethernet interfaces (e.g., giga-eth 0/3)
• Ethernet subinterfaces associated with a virtual local area network (VLAN) (e.g., eth 0/1.1)
• Switchport interfaces which are only available on specific platforms (e.g., swx 0/1)
• Gigabit Switchport interfaces which are only available on specific platforms (e.g., giga-swx 0/1)
Not all platforms have Ethernet subinterfaces, Gigabit Ethernet, switchport, or gigabit
switchport interfaces available. To see if your unit has this capability, type show interfaces
at the enable prompt.
To activate the basic Ethernet Interface Configuration mode, enter the interface ethernet command at the
>enable
#configure terminal
(config-eth 0/1)#
To activate the Gigabit Ethernet Interface Configuration mode, enter the interface gigabit-ethernet
command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#interface gigabit-ethernet 0/3
To activate the Ethernet Subinterface Configuration mode, enter the interface ethernet command at the
>enable
#configure terminal
(config)#interface ethernet 0/1.1
(config-eth 0/1.1)#
To activate the Gigabit Switchport Interface Configuration mode, enter the interface gigabit-switchport
>enable
#configure terminal
(config)#interface gigabit-switchport 0/3
(config-giga-swx 0/3)#

To activate the Switchport Interface Configuration mode, enter the interface switchport command at the
>enable
#configure terminal
(config-swx 0/1)#
To activate the Ethernet Configuration mode for a range of Ethernet interfaces, enter the interface range
>enable
#configure terminal
(config)#interface range ethernet 0/1, 0/8
(config-eth 0/1, 0/8)#
Not all Ethernet commands apply to all Ethernet types. Use the ? command to display a list
of valid commands. For example:
>enable
Password:xxxxx
#config term
(config-eth 0/1)#?
access-policy - Assign access control policy for this interface
alias - A text name assigned by an SNMP NMS
arp - Set ARP commands
bandwidth - Set bandwidth informational parameter
bridge-group - Assign the current interface to a bridge group
etc.

do on page 51
end on page 52
exit on page 53
shutdown on page 61

access-policy <name> on page 1313

arp arpa on page 1314
awcp on page 1315
bandwidth <value> on page 1316
bridge-group <number> on page 1317
bridge-group <number> vlan-transparent on page 1318
channel-group <number> mode on on page 1319
crypto map <name> on page 1320
dynamic-dns on page 1322
encapsulation 802.1q on page 1324
ethernet-cfm down on page 1325
ethernet-cfm mep on page 1326
full-duplex on page 1327
half-duplex on page 1328
ip commands begin on page 1329
lldp receive on page 1368
lldp send on page 1369
mac-address <mac address> on page 1371
max-reserved-bandwidth <value> on page 1372
media-gateway ip on page 1373
mtu <size> on page 1374
port-auth auth-mode on page 1377
port-auth control-direction on page 1378
port-auth multiple-hosts on page 1379
port-auth port-control on page 1380
power inline on page 1381
qos-policy on page 1382
qos on page 1384
rtp quality-monitoring on page 1385
speed on page 1395
storm-control on page 1396
storm-control action shutdown on page 1398
switchport commands begin on page 1399
traffic-shape rate <value> on page 1416

vlan-id <vlan id> on page 1417

vrrp <number> on page 1419

access-policy <name>
Use the access-policy command to assign a specified access control policy (ACP) to an interface. ACPs
are applied to traffic entering an interface. Use the no form of this command to remove an ACP
association. For more information on using ACPs, refer to ip policy-class <name> on page 900.
Configured ACPs will only be active if the ip firewall command has been entered at the
Global Configuration mode prompt to enable the AOS security features. All configuration
parameters are valid, but no security data processing will be attempted unless the security
features are enabled.
Syntax Description
<name> Identifies the configured ACP by alphanumeric descriptor (all ACP
Default Values
By default, there are no configured ACPs associated with an interface.
Command History
Release 5.1 Command was expanded to include the Ethernet subinterfaces.
Release 6.1 Command was expanded to include the virtual local area network (VLAN)
interfaces.
Release 15.1 Command was expanded to include the bridged virtual interfaces (BVIs).
Functional Notes
To assign an ACP to an interface, enter the interface configuration mode for the desired interface and enter
access-policy <name>.
Usage Examples
The following example associates the ACP PRIVATE (to allow inbound traffic to the Web server) to the
Ethernet 0/1 interface:
Enable the AOS security features:

Associate the access policy with the Ethernet 0/1 interface:

(config-eth 0/1)#access-policy PRIVATE

arp arpa
Use the arp arpa command to set ARPA as the standard Address Resolution Protocol (ARP) on this
interface. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
The default for this command is arpa.
Command History
Usage Examples
The following example enables standard ARP for the Ethernet interface:

(config-eth 0/1)#arp arpa

awcp
Use the awcp command to enable ADTRAN Wireless Control Protocol (AWCP) on this interface. The
AWCP is an ADTRAN proprietary protocol used by an access controller (AC) to communicate with an
access point (AP). Use the no form of this command to disable AWCP for this interface.
Syntax Description
No subcommands.
Default Values
By default, AWCP is enabled on the interface.
Command History
Functional Notes
When the global-level command dot11ap access-point-controller (refer to dot11ap access-point-control
on page 796 for more information) is enabled, the AWCP function can be disabled on a specific interface
by using the no form of this command from the desired interface. When the global-level command
dot11ap access-point-controller is disabled, it overrides the awcp command setting for the interface.
Usage Examples
The following example disables AWCP on Ethernet interface 0/1:

(config-eth 0/1)#no awcp

bandwidth <value>
Use the bandwidth command to provide the bandwidth value of an interface to the higher level protocols.
This value is used in cost calculations. Use the no form of this command to restore the default value.
Syntax Description
<value> Specifies bandwidth in kbps. Range is 1 to 4294967295 kbps.
Default Values
To view default value, use the show interfaces command.
Command History
Functional Notes
The bandwidth command is an informational value that is communicated to the higher level protocols to
be used in cost calculations. This is a routing parameter only and does not affect the physical interface.
Usage Examples
The following example sets bandwidth of the Ethernet 0/1 interface to 10 Mbps:

(config-eth 0/1)#bandwidth 10000

bridge-group <number>
Use the bridge-group command to assign an interface to the specified bridge group. Use the no form of
this command to remove the interface from the bridge group.
Syntax Description
<number> Specifies the bridge group (by number) to which to assign this interface.
Range is 1 to 255.
Default Values
By default, there are no configured bridge groups.
Command History
Functional Notes
A bridged network can provide excellent traffic management to reduce collisions and limit the amount of
bandwidth wasted with unnecessary transmissions when routing is not necessary. Any two interfaces can
be bridged (e.g., Ethernet to T1 bridge, Ethernet to Frame Relay subinterface).
Usage Examples
The following example assigns the Ethernet interface to bridge-group 17:

(config-eth 0/1)#bridge-group 17

bridge-group <number> vlan-transparent

Use the bridge-group vlan-transparent command to prevent an interface from removing the virtual local
area network (VLAN) tag. Use the no form of this command to allow the interface to remove the VLAN
tag from the packet.
The bridge-group vlan-transparent command is not a global command. The command

must be applied on all interfaces of the bridge group.
Syntax Description
<number> Specifies the bridge group number. Valid range is 1 to 255.
Default Values
By default, VLAN tags are removed from the data.
Command History
interface and Frame Relay subinterface.
Usage Examples
The following example removes the VLAN tags from the packets on the Ethernet interface 0/1:

(config-eth 0/1)#bridge-group 1 vlan-transparent

channel-group <number> mode on

Use the channel-group mode on command to statically add the interface to a channel group. To remove
an interface from a channel group, use the no form of this command.
Syntax Description
<number> Specifies the channel-group number. Range is 1 to 6.
Default Values
By default, the interface is not part of a channel group.
Command History
Functional Notes
There can be up to six channel groups with 2 to 8 interfaces per group. Dynamic protocols are not yet
supported (only static). A physical interface can be a member of only one channel group.
Usage Examples
The following example adds the Ethernet 0/1 interface to channel group 1:

(config-eth 0/1)#channel-group 1 mode on
(config-eth 0/1)#

crypto map <name>

Use the crypto map command to associate crypto maps with the interface. Use the no form of this
command to remove a crypto map from an interface.
When you apply a map to an interface, you are applying all crypto maps with the given
map name. This allows you to apply multiple crypto maps if you have created maps that
share the same name, but have different map index numbers.
configuration guide available on the AOS Documentation CD shipped with your product.
Syntax Description
<name> Specifies the crypto map name that you wish to assign to the interface.
Default Values
By default, no crypto maps are assigned to an interface.
Command History
Functional Notes
When configuring a system to use both the stateful inspection firewall and Internet key exchange (IKE)
negotiation for VPN, keep the following notes in mind.
When defining the policy class and associated access control lists (ACLs) that describe the behavior of the
firewall, do not forget to include the traffic coming into the system over a VPN tunnel terminated by the
system. The firewall should be set up with respect to the unencrypted traffic that is destined to be sent or
received over the VPN tunnel. The following diagram represents typical AOS data-flow logic.

Interfaces (Ethernet, Frame Relay, PPP, local)
Static Filter Static Filter

(in) (out)
IPSec IPSec
Decrypt/Discard Encrypt
NAT/ACP/
Firewall
Router
As shown in the diagram above, data coming into the product is first processed by the static filter
associated with the interface on which the data is received. This access group is a true static filter and is
available for use regardless of whether the firewall is enabled or disabled. Next (if the data is encrypted), it
is sent to the IPSec engine for decryption. The decrypted data is then processed by the stateful inspection
firewall. Therefore, given a terminating VPN tunnel, only unencrypted data is processed by the firewall.
The ACLs for a crypto map on an interface work in reverse logic to the ACLs for a policy class on an
interface. When specifying the ACLs for a crypto map, the source information is the private local side,
unencrypted source of the data. The destination information will be the far-end, unencrypted destination of
the data. However, ACLs for a policy class work in reverse. The source information for the ACL in a policy
class is the far end. The destination information is the local side.
Usage Examples
The following example applies all crypto maps with the name MyMap to the Ethernet interface:

(config-eth 0/1)#crypto map MyMap

dynamic-dns
Use the dynamic-dns command to configure Dynamic DNS service provided by Dynamic Network
Services, Inc. (www.dyndns.org). Use the no form of this command to disable this feature. Variations of
dynamic-dns custom <hostname> <minutes>

dynamic-dns dyndns <hostname> <username> <password>
dynamic-dns dyndns-custom <hostname> <username> <password>
dynamic-dns dyndns-static <hostname> <username> <password>
Syntax Description
<hostname> Specifies the host name for the server that updates the dynamic domain
naming system (DNS).
<minutes> Specifies the intervals in minutes to update the server with information
(updates also occur when the interface’s IP address changes regardless of
the update intervals).
<username> Specifies the user name.
<password> Specifies the password.
Refer to Functional Notes below for additional argument descriptions.
Default Values
Command History
Functional Notes
custom - Constanttime.com’s Custom Dynamic DNSSM service allows you complete access and
management control over your domain name regardless of where you purchased/registered it. This allows
you to manage IP address mappings (A records), domain aliases (CNAME records), and mail servers (mail
exchange (MX) records).
dyndns - The Dynamic DNSSM offered by Dynamic Network Services, Inc. (DynDNS.org) allows you to
alias a dynamic IP address to a static host name in various domains. This allows your unit to be more
easily accessed from various locations on the Internet. This service is provided for up to five host names.
dyndns-custom - DynDNS.org's Custom DNSSM service provides a full DNS solution, giving you
complete control over an entire domain name. A Web-based interface provides two levels of control over
your domain, catering to average or advanced users. Five globally redundant DNS servers ensure that
your domain will always resolve.

A choice of two interfaces is available. The basic interface is designed for most users. It comes
preconfigured for most common configurations and allows for easy creation of most common record types.
The advanced interface is designed for system administrators with a solid DNS background, and provides
layout and functionality similar to a BIND zone file allowing for the creation of nearly any record type.
Custom DNSSM can be used with both static and dynamic IPs, and has the same automatic update
capability through Custom DNS-aware clients as Dynamic DNS.
dyndns-static - The Static DNS service is similar to DynDNS.org’s Dynamic DNSSM service in that it
allows a host name, such as yourname.dyndns.org, to point to your IP address. Unlike a Dynamic DNS
host, a Static DNS host does not expire after 35 days without updates, but updates take longer to
propagate through the DNS system. This service is provided for up to five host names.
If your IP address does not change often or at all, but you still want an easy name to remember it by
(without having to purchase your own domain name), Static DNS service is ideal for you.
If you would like to use your own domain name (such as yourname.com), you need Custom DNS service
that also provides full dynamic and static IP address support.
Usage Examples
The following example sets the Dynamic DNS to dyndns-custom with host name host, user’s name user,
and password pass:

(config-eth 0/1)#dynamic-dns dyndns-custom host user pass

encapsulation 802.1q
Use the encapsulation 802.1q command to put the interface into 802.1q virtual local area network
(VLAN) mode.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example puts Ethernet interface 0/1 in 802.1q mode and configures a subinterface for VLAN
usage:

(config-eth 0/1)#encapsulation 802.1q
(config-eth 0/1)#interface ethernet 0/1.1
(config-eth 0/1.1)#vlan-id 3

ethernet-cfm down
Use the ethernet-cfm down command to enable Ethernet operations, administration, and maintenance
(OAM) connectivity fault management (CFM) on the Ethernet interface. Use the no form of this command
to disable Ethernet OAM CFM on this interface.
Syntax Description
No subcommands.
Default Values
By default, Ethernet OAM CFM is disabled.
Command History
Functional Notes
For more information regarding specific Ethernet OAM CFM configuration commands on the Ethernet
interface, refer to the Ethernet OAM CFM Command Set on page 2473.
Usage Examples
The following example enables Ethernet OAM CFM on Ethernet interface 0/1:

(config-eth 0/1)#ethernet-cfm down

ethernet-cfm mep
Use the ethernet-cfm mep command to create an Ethernet operations, administration, and maintenance
(OAM) connectivity fault management (CFM) maintenance endpoint (MEP) on the Ethernet interface. Use
the no form of this command to remove the MEP from the interface. Variations of this command include:
ethernet-cfm mep <name> <name> <mep id> down

ethernet-cfm mep none <name> <mep id> down
Syntax Description
<name> Specifies the MEP’s maintenance domain.
<name> Specifies the MEP’s maintenance association.
<mep id> Specifies the unique numerical ID for this MEP. Range is 1 to 8191.
none Optional. Specifies no domain name is used.
down Specifies the direction of the MEP.
Default Values
By default, no MEPs exist on the interface.
Command History
Functional Notes
For more information about specific MEP configuration commands, refer to the Ethernet OAM CFM
Usage Examples
The following example creates an MEP, with the MEP ID 100, on Ethernet interface eth 0/1. The MEP is
associated with maintenance domain Domain1 and association association1:

(config-eth 0/1)#ethernet-cfm mep Domain1 association1 100 down
(config-eth 0/1-mep)

full-duplex
Use the full-duplex command to configure the Ethernet interface for full-duplex operation. This allows the
interface to send and receive simultaneously. Use the no form of this command to return to the default
half-duplex operation.
Syntax Description
No subcommands.
Default Values
By default, all Ethernet interfaces are configured for half-duplex operation.
Command History
Functional Notes
Full-duplex Ethernet is a variety of Ethernet technology currently being standardized by the IEEE. Because
there is no official standard, vendors are free to implement their independent versions of full-duplex
operation. Therefore, it is not safe to assume that one vendor’s equipment will work with another.
Devices at each end of a full-duplex link have the ability to send and receive data simultaneously over the
link. Theoretically, this simultaneous action can provide twice the bandwidth of normal (half-duplex)
Ethernet. To deploy full-duplex Ethernet, each end of the link must only connect to a single device (a
workstation or a switched hub port). With only two devices on a full-duplex link, there is no need to use the
medium access control mechanism (to share the signal channel with multiple stations) and listen for other
transmissions or collisions before sending data.
Some Ethernet equipment (though rare) is unable to negotiate duplex if speed is manually
determined. To avoid incompatibilities, manually set the duplex if the speed is manually set.
Refer to speed on page 1395 for more information.
The 10Base-T, 100Base-TX, and 100Base-FX signaling systems support full-duplex operation (because
they have transmit and receive signal paths that can be simultaneously active).
Usage Examples
The following example configures the Ethernet interface for full-duplex operation:

(config-eth 0/1)#full-duplex

half-duplex
Use the half-duplex command to configure the Ethernet interface for half-duplex operation. This setting
allows the Ethernet interface to either send or receive at any given moment, but not simultaneously. Use
the no form of this command to disable half-duplex operation.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Half-duplex Ethernet is the traditional form of Ethernet that employs the carrier sense multiple
access/collision detect (CSMA/CD) protocol to allow two or more hosts to share a common transmission
medium while providing mechanisms to avoid collisions. A host on a half-duplex link must “listen” on the
link and only transmit when there is an idle period. Packets transmitted on the link are broadcast (so it will
be “heard” by all hosts on the network). In the event of a collision (two hosts transmitting at once), a
message is sent to inform all hosts of the collision and a backoff algorithm is implemented. The backoff
algorithm requires the station to remain silent for a random period of time before attempting another
transmission. This sequence is repeated until a successful data transmission occurs.
Some Ethernet equipment (though rare) is unable to negotiate duplex if speed is

manually determined. To avoid incompatibilities, manually set the duplex if the speed
is manually set. Refer to speed on page 1395 for more information.
Usage Examples
The following example configures the Ethernet interface for half-duplex operation:

(config-eth 0/1)#half-duplex

ip access-group <name>
Use the ip access-group command to create an access control list (ACL) to be used for packets transmitted
on or received from the specified interface. Use the no form of this command to disable this type of
control. Variations of this command include:
ip access-group <name> in
ip access-group <name> out
Syntax Description
<name> Assigns ACL name.
in Enables access control on packets received on the specified interface.
out Enables access control on packets transmitted on the specified interface.
Default Values
By default, these commands are disabled.
Command History
Functional Notes
When this command is enabled, the IP destination address of each packet must be validated before being
passed through. If the packet is not acceptable per these settings, it is dropped.
Usage Examples
The following example configures the router to only allow Telnet traffic (as defined in the user-configured
TelnetOnly ACL) into the Ethernet interface:
(config)#ip access-list extended TelnetOnly

(config-ext-nacl)#permit tcp any any eq telnet
(config-ext-nacl)#interface ethernet 0/1
(config-eth 0/1)#ip access-group TelnetOnly in

ip address dhcp
Use the ip address dhcp command to use Dynamic Host Configuration Protocol (DHCP) to obtain an
address on the interface. Use the no form of this command to remove a configured IP address (using
DHCP) and disable DHCP operation on the interface. Variables that may be used with this command to
further define the DHCP configuration include:
ip address dhcp client-id [<interface> | <identifier>] [hostname <“string”>] [track <name>]

[<administrative distance>]
ip address dhcp hostname “<string>” [no-default-route | no-domain-name | no-nameservers]
[track <name>] [<administrative distance>]
ip address dhcp [no-default-route | no-domain-name | no-nameservers] [track <name>]
ip address dhcp track <name> [<administrative distance>]
Syntax Description
<administrative distance> Optional. Specifies the administrative distance to use when adding the
DHCP gateway into the route table. It is used to determine the best route
when multiple routes to the same destination exist. The smaller the
administrative distance, the more reliable the route. Range is 1 to 255.
client-id Optional. Specifies the client identifier used when obtaining an IP address
from a DHCP server.
<interface> Specifies an interface, thus defining the client identifier as the hexadecimal
medium access control (MAC) address of the specified interface (including
a hexadecimal number added to the front of the MAC address to identify the
media type).
For example, specifying the client-id ethernet 0/1 (where the Ethernet
interface has a MAC address of d217.0491.1150) defines the client
identifier as 01:d2:17:04:91:11:50 (where 01 defines the media type as
Ethernet). Refer to hardware-address on page 2460 for a detailed listing of
media types.
<identifier> Specifies a custom client-identifier using a text string (that is converted to a
hexadecimal equivalent) or 7 to 28 hexadecimal numbers (with colon
delimiters).
For example, a custom client identifier of 0f:ff:ff:ff:ff:51:04:99:a1 may be
entered using the <identifier> option.
hostname “<string>” Optional. Specifies a text string (to override the global router name) to use
as the name in the DHCP option 12 field. The string is enclosed in quotation
marks and can consist of up to 35 characters.
no-default-route Optional. Specifies that no default route is obtained via DHCP.
no-domain-name Optional. Specifies that no domain name is obtained via DHCP.
no-nameservers Optional. Specifies that no domain naming system (DNS) servers are
obtained via DHCP.

track <name> Optional. Attaches a network monitoring track to the DHCP client. The
DHCP gateway route for this client will only reside in the route table while
the track is in the pass state. For more information on configuring track
objects, refer to track <name> on page 1124.
Default Values
<administrative distance> By default, the administrative distance value is 1.
client-id Optional. By default, the client identifier is populated using the following
formula:
TYPE: INTERFACE SPECIFIC INFO : MAC ADDRESS
Where TYPE specifies the media type in the form of one hexadecimal byte
(refer to hardware-address on page 2460 for a detailed listing of media
types), and the MAC ADDRESS is the medium access control (MAC)
address assigned to the first Ethernet interface in the unit in the form of six
hexadecimal bytes. (For units with a single Ethernet interface, the MAC
ADDRESS assigned to Ethernet 0/1 is used in this field.)
INTERFACE SPECIFIC INFO is only used for Frame Relay interfaces and
can be determined using the following:
FR_PORT#: Q.922 ADDRESS
Where the FR_PORT# specifies the label assigned to the virtual Frame
Relay interface using four hexadecimal bytes. For example, a virtual Frame
Relay interface labeled 1 would have a FR_PORT# of 00:00:00:01.
The Q.922 ADDRESS field is populated using the following:
8 7 6 5 4 3 2 1
DLCI (high order) C/R EA
DLCI (lower) FECN BECN DE EA
Where the FECN, BECN, C/R, DE, and high order extended address (EA)
bits are assumed to be 0 and the lower order EA bit is set to 1.
The following list provides a few example DLCIs and associated Q.922
address:
DLCI (decimal) / Q.922 address (hex)
16 / 0x0401
50 / 0x0C21
60 / 0x0CC1
70 / 0x1061
80 / 0x1401
hostname “<string>” By default, the host name is the name configured using the Global
Configuration hostname command.

Command History
subinterface.
Release 13.1 Command was expanded to include the track and administrative distance.
Functional Notes
DHCP allows interfaces to acquire a dynamically assigned IP address from a configured DHCP server on
the network. Many Internet service providers (ISPs) require the use of DHCP when connecting to their
services. Using DHCP reduces the number of dedicated IP addresses the ISP must obtain. Consult your
ISP to determine the proper values for the client-id and hostname fields.
Usage Examples
The following example enables DHCP operation on the Ethernet interface 0/1:

(config-eth 0/1)#ip address dhcp
The following example enables DHCP operation on the Ethernet interface 0/1 utilizing host name adtran
and does not allow obtaining a default route, domain name, or name servers. It also sets the administrative
distance as 5:

(config-eth 0/1)#ip address dhcp hostname “adtran” no-default-route no-domain-name
no-nameservers 5

ip address <ip address> <subnet mask>

Use the ip address command to define an IP address on the specified interface (only one primary address
is allowed). Use the optional secondary keyword to define a secondary IP address. Use the no form of this
command to remove a configured IP address. Variations of this command include:

ip address <ip address> <subnet mask> secondary
Syntax Description
example, /24).
secondary Optional. Configures a secondary IP address for the specified interface.
Default Values
By default, there are no assigned IP addresses.
Command History
Functional Notes
Use secondary IP addresses to allow dual subnets on a single interface (when you need more IP
addresses than the primary subnet can provide). When using secondary IP addresses, avoid routing loops
by verifying that all devices on the network segment are configured with secondary IP addresses on the
secondary subnet.
Usage Examples
The following example configures a secondary IP address of 192.22.72.101 /30:

(config-eth 0/1)#ip address 192.22.72.101 /30 secondary

ip address range <start ip address> <end ip address> <subnet mask>

secondary
Use the ip address range secondary command to specify a range of secondary IP addresses on the
specified interface. Use the no form of this command to remove the range of configured IP addresses.
Syntax Description
10.10.10.1).
example, /24).
Default Values
By default, no IP address range is defined.
Command History
Functional Notes
secondary subnet.
Usage Examples
The following example configures a range of secondary IP address from 192.22.72.1 to 192.22.72.10 on
subnet 255.255.255.252:

(config-eth 0/1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

ip dhcp release
Use the ip dhcp release command to transmit a message to the DHCP server requesting termination of the
IP address lease on that interface.
If you are currently connected to the unit using a Telnet session through the Ethernet
interface, using the ip dhcp release command will terminate your Telnet session and render
your Telnet capability inoperable until a new IP address is assigned by the DHCP server.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Dynamic Host Configuration Protocol (DHCP) allows interfaces to acquire a dynamically assigned IP
address from a configured DHCP server on the network. Many Internet service providers (ISPs) require the
use of DHCP when connecting to their services. Using DHCP reduces the number of dedicated IP
addresses the ISP must obtain.
Usage Examples
The following example releases the IP address assigned (by DHCP) on the Ethernet interface 0/1:

(config-eth 0/1)#ip dhcp release

ip dhcp renew
Use the ip dhcp renew command to transmit a message to the DHCP server requesting renewal of the IP
address lease on that interface.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Dynamic Host Configuration Protocol (DHCP) allows interfaces to acquire a dynamically assigned IP
address from a configured DHCP server on the network. Many Internet service providers (ISPs) require the
use of DHCP when connecting to their services. Using DHCP reduces the number of dedicated IP
addresses the ISP must obtain.
Usage Examples
The following example renews the IP address assigned (by DHCP) on the Ethernet interface 0/1:

(config-eth 0/1)#ip dhcp renew

ip directed-broadcast
Use the ip directed-broadcast command to allow reception/forwarding of directed broadcasts. Use the no
form of this command to disable this feature. Variations of this command include:
ip directed-broadcast <name>
Syntax Description
<name> Specifies IP access control list (ACL) name.
Default Values
Command History
Functional Notes
A directed broadcast is a packet intended for all nodes on a nonlocal network. For example, the broadcast
address 255.255.255.255 reaches all nodes on a network; the directed broadcast address 128.1.255.255
is intended for all nodes whose network address is 128.1.0.0. A router not directly attached to 128.1.0.0
simply forwards the directed broadcast packet to the next hop. A router on network 128.1.0.0 that has ip
directed-broadcast enabled, accepts and forwards the packet to all nodes whose network address is
128.1.0.0. Routers connecting subnets of 128.1.0.0 also accept and forward the packet to the nodes on
their respective subnets. When a directed broadcast packet reaches a router that is directly connected to
its destination subnet, that packet is distributed as a broadcast on the destination subnet. The packet is
then sent as a link-layer broadcast.
The ip directed-broadcast command controls the distribution of directed broadcasts when they reach
their target subnets. Only the final transmission of the directed broadcast on its ultimate destination subnet
is affected. It does not affect the transit unicast routing of IP directed broadcasts.
If ip directed-broadcast is enabled for this interface, incoming IP packets whose addresses identify them
as directed broadcasts intended for the subnet to which this interface is attached will be forwarded as
broadcasts on that subnet. Forwarding of the packets can be limited by specifying an ACL with this
command. In this case, only directed broadcasts that are permitted by the specified ACL will be forwarded,
and all other directed broadcasts directed to this interface subnet will be dropped.
Disabling the ip directed-broadcast command will cause directed broadcasts destined for the subnet to
which this interface is attached to be dropped.
This option is a requirement for routers as described in RFC 1812, section 4.2.2.11. Furthermore, it is
disabled by default (RFC 2644), with the intended goal of reducing the efficacy of certain types of denial of
service (DoS) attacks.

Usage Examples
The following example enables forwarding of directed broadcasts on the interface ethernet 0/1:

(config-eth 0/1)#ip directed-broadcast

ip ffe
Use the ip ffe command to enable the RapidRoute Engine on this interface with the default number of
entries. Use the no form of this command to disable this feature. Variations of this command include:
ip ffe
Issuing this command will cause all RapidRoute entries on this interface to be cleared.
Syntax Description
max-entries <value> Optional. Specifies the maximum number of entries stored in the flow table.
Valid range is from 1 to 8192.
Default Values
By default, the RapidRoute Engine is disabled. The default number of max-entries is 4096.
Command History
Functional Notes
RapidRoute can be used to help reduce routing overhead, and thus reduce overall routing times. Routing
times are reduced by the creation of a flow table on the ingress interface. The maximum number of entries
that can be stored in the flow table at any one time may be specified by using the max-entries parameters.
Usage Examples
The following example enables RapidRoute and sets the maximum number of entries in the flow table to
50:

(config-eth 0/1)#ip ffe max-entries 50

Technology Review
The RapidRoute system goal is to increase IP packet throughput by moving as much of the packet
processing into the engine as possible. Packets are classified into flows based upon the IP protocol
(Transmission Control Protocol (TCP), User Datagram Protocol (UDP), Internet Control Message Protocol
(ICMP), etc.), the source and destination IP addresses, IP type of service (ToS), and the protocol-specific
information, such as the source and destination port numbers. Flows are defined as the unidirectional
representation of a conversation between two IP hosts. Each ingress interface keeps its own flow table, a
collection of flow entries.
The first packet in a flow that is forwarded through the unit will build a flow entry. When a flow entry is
looked up but no entry is found, a RapidRouteBuilder object is allocated and attached to the packet. As the
packet passes through the various processing layers, each subsystem will add processing to the
RapidRouteBuilder. When packet is about to be forwarded out of the egress interface, the
RapidRouteBuilder will be finalized. That is, the flow entry being built will be checked for completeness and
committed to the flow table on the ingress interface. Subsequent flow matches can then bypass the normal
processing layers.

ip flow
Use the ip flow command to enable integrated traffic monitoring (ITM) for all traffic received or
forwarded on an interface. Use the no form of this command to disable traffic monitoring. Variations of
ip flow egress
ip flow egress <name>
ip flow ingress
ip flow ingress <name>
Syntax Description
egress Specifies that all outgoing traffic be monitored.
ingress Specifies that all incoming traffic be monitored.
<name> Optional. Specifies the name of an access control list (ACL) to use for
filtering traffic.
Default Values
By default, no traffic monitoring is enabled.
Command History
Usage Examples
The following example enables traffic monitoring on an Ethernet interface to monitor incoming traffic
through an ACL called myacl:

(config-eth 0/1)#ip flow ingress myacl

ip helper-address <ip address>

Use the ip helper-address command to configure AOS to forward User Datagram Protocol (UDP)
broadcast packets received on the interface. Use the no form of this command to disable forwarding
packets.
The ip helper-address command must be used in conjunction with the ip forward-protocol

command to configure AOS to forward UDP broadcast packets.
Syntax Description
<ip address> Specifies the destination IP address for the forwarded UDP packets. IP
10.10.10.1).
Default Values
By default, broadcast UDP packets are not forwarded.
Command History
Functional Notes
When used in conjunction with the ip forward-protocol command, the ip helper-address feature allows
you to customize which broadcast packets are forwarded.
To implement the helper address feature, assign helper address(es) (specifying the device that needs to
receive the broadcast traffic) to the interface closest to the host that transmits the broadcast packets.
When broadcast packets (of the specified type forwarded using the ip forward-protocol command) are
received on the interface, they will be forwarded to the device that needs the information.
Only packets meeting the following criteria are considered eligible by the ip helper-address feature:
1. The packet IP protocol is UDP.
2. Any UDP port specified using the ip forward-protocol command.
3. The medium access control (MAC) address of the frame is an all-ones broadcast address (ffff.ffff.ffff).
4. The destination IP address is broadcast defined by all ones (255.255.255.255) or a subnet broadcast
(for example, 192.33.4.251 for the 192.33.4.248 /30 subnet).

Usage Examples
IP address 192.33.5.99:

(config-eth 0/1)#ip helper-address 192.33.5.99

ip igmp
Use the ip igmp command to configure multicasting related functions for the interface. Variations of this
command include:
ip igmp immediate-leave
ip igmp last-member-query-interval <milliseconds>
ip igmp querier-timeout <seconds>
ip igmp query-interval <seconds>
ip igmp query-max-response-time <seconds>
ip igmp static-group <address>
ip igmp version [1 | 2]
Syntax Description
immediate-leave Specifies that if only one host (or Internet Group Management Protocol
(IGMP) snooping switch) is connected to the interface, when a leave is
received, multicast of that group is immediately terminated as opposed
to sending a group query and timing out the group if no device responds.
Works in conjunction with ip igmp last-member-query-interval.
Applies to all groups when configured. Use the no form of this command
to disable the immediate-leave feature.
last-member-query-interval Controls the timeout (in milliseconds) used to detect whether any group
<milliseconds> receivers remain on an interface after a receiver leaves a group. If a
receiver sends a leave-group message (IGMP Version 2), the router
sends a group-specific query on that interface. After twice the time
specified by this command plus as much as one second longer, if no
receiver responds, the router removes that interface from the group and
stops sending that group's multicast packets to the interface. Range is
100 to 65535 ms. Use the no form of this command to return to the
default setting.
querier-timeout <seconds> Specifies the interval (in seconds) that the router waits after the current
querier’s last query before it takes over as querier (IGMP V2). Range is
60 to 300 seconds. Use the no form of this command to return to the
default setting.
query-interval <seconds> Specifies the interval (in seconds) at which IGMP queries are sent on an
interface. Host query messages are addressed to the all-hosts multicast
group with an IP time to live (TTL) of 1. The router uses queries to detect
whether multicast group members are on the interface and to select an
IGMP designated router (DR) for the attached segment (if more than one
multicast router exists). Only the DR for the segment sends queries. For
IGMP V2, the DR is the router with the lowest IP address on the
segment. Range is 0 to 65535 seconds. Use the no form of this
query-max-response-time Specifies the maximum response time (in seconds) advertised by this
<seconds> interface in queries when using IGMP V2. Hosts are allowed a random
time within this period to respond, reducing response bursts. Use the no

Syntax Description
static-group <address> Configures the router's interface to be a statically connected member of
the specified group. Packets received on the correct reverse path
forwarding (RPF) interface are forwarded to this interface regardless of
whether any receivers have joined the specified group using IGMP. Use
the no form of this command to remove a configured static group.
version [1 | 2] Sets the interface’s IGMP version. Use the no form of this command to
Default Values
The defaults for this command are:
last-member-query-interval 1000 milliseconds
querier-timeout 2x the query-interval value
query-interval 60 seconds
query-max-response-time 10 seconds
version Version 1
There are no default values for immediate-leave and static-group.
Command History
Usage Examples
The following example sets the query message interval on the interface to 200 milliseconds:

(config-eth 0/1)#ip igmp last-member-query-interval 200

ip mcast-stub downstream
Use the ip mcast-stub downstream command to enable multicast forwarding and Internet Group
Management Protocol (IGMP) (router mode) on an interface, and to place it in multicast stub downstream
mode. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This command is used in IP multicast stub applications in conjunction with the ip mcast-stub
helper-address and ip mcast-stub upstream commands. Downstream interfaces connect to segments
with multicast hosts. Multiple interfaces may be configured in downstream mode; however, interfaces
connecting to the multicast network (upstream) should not be configured in downstream mode. Interfaces
configured as downstream should have the lowest IP address of all IGMP-capable routers on the
connected segment in order to be selected as the designated router (DR) and ensure proper forwarding.
Refer to ip mcast-stub helper-address <ip address> on page 883 and ip mcast-stub upstream on page
1349 for more information.
Usage Examples
The following example enables multicast forwarding and IGMP on the interface:

(config-eth 0/1)#ip mcast-stub downstream

ip mcast-stub fixed
Use the ip mcast-stub fixed command to allow forwarding of multicast traffic on a selected interface after
enabling multicast routing. Use the no form of this command to disable this mode.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Multicast routing must be enabled prior to setting ip mcast-stub fixed on the selected interface. Also, use
the ip igmp static-group <ip address> command to receive multicast traffic without host-initiated Internet
Group Management Protocol (IGMP) activity on the selected interface. Otherwise, all host-initiated IGMP
transactions will enter multicast routes on the router’s interface involved with IGMP activities.
Usage Examples
The following example enables multicast traffic forwarding and IGMP on the interface:

(config-eth 0/1)#ip mcast-stub fixed

ip mcast-stub helper-enable
Use the ip mcast-stub helper-enable command to assign the ip mcast-stub helper-address as the
Internet Group Management Protocol (IGMP) proxy. Use the no form of this command to disable this
feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
helper-address, ip mcast-stub upstream, and ip mcast-stub downstream commands. When enabled,
the interface becomes a helper forwarding interface. The IGMP host function is dynamically enabled and
the interface becomes the active upstream interface, enabling the unit to perform as an IGMP proxy. Refer
to ip mcast-stub helper-address <ip address> on page 883, ip mcast-stub downstream on page 1346, and
ip mcast-stub upstream on page 1349 for more information.
Usage Examples
The following example sets the helper address as the IGMP proxy:

(config-eth 0/1)#ip mcast-stub helper-enable

ip mcast-stub upstream
Use the ip mcast-stub upstream command to enable multicast forwarding on an interface and place it in
multicast stub upstream mode. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
helper-address and ip mcast-stub downstream commands. When enabled, the interface becomes a
candidate to be a helper forwarding interface. If chosen as the best path toward the helper address by the
router's unicast route table, the Internet Group Management Protocol (IGMP) host function is dynamically
enabled and the interface becomes the active upstream interface, enabling the router to perform as an
IGMP proxy. Though multiple interfaces may be candidates, no more than one interface will actively serve
as the helper forwarding interface. Refer to ip mcast-stub helper-address <ip address> on page 883 and ip
mcast-stub downstream on page 1346 for more information.
Usage Examples
The following example enables multicast forwarding on the interface:

(config-eth 0/1)#ip mcast-stub upstream

ip ospf
Use the ip ospf command to customize open shortest path first (OSPF) settings (if needed). Use the no
ip ospf authentication-key <password>

ip ospf cost <value>
ip ospf dead-interval <seconds>
ip ospf hello-interval <seconds>
ip ospf message-digest-key [1 | 2] md5 <key>
ip ospf priority <value>
ip ospf retransmit-interval <seconds>
ip ospf transmit-delay <seconds>
Syntax Description
authentication-key <password> Assigns a simple-text authentication password to be used by
other routers using the OSPF simple password authentication.
cost <value> Specifies the OSPF cost of sending a packet on the interface.
This value overrides any computed cost value. Range is
1 to 65535.
dead-interval <seconds> Sets the maximum interval (in seconds) allowed between hello
packets. If the maximum is exceeded, neighboring devices will
determine that the device is down. Range is 0 to 32767
seconds.
hello-interval <seconds> Specifies the interval (in seconds) between hello packets sent
on the interface. Range is 0 to 32767 seconds.
message-digest-key [1 | 2] md5 <key> Configures OSPF message digest 5 (MD5) authentication
(16 byte maximum) keys.
priority <value> Sets the OSPF priority. The value set in this field helps
determine the designated router (DR) for this network. Range is
0 to 255.
retransmit-interval <seconds> Specifies the interval (in seconds) between link state
advertisements (LSAs). Range is 0 to 32767 seconds.
transmit-delay <seconds> Sets the estimated time (in seconds) required to send a link
state advertisement (LSA) on the interface. Range is 0 to
32767 seconds.
Default Values
The defaults for this command are:
dead-interval <seconds> 40 seconds
hello-interval <seconds> 10 seconds: Ethernet, Frame Relay, and Point-to-Point
Protocol (PPP)
priority <value 1
retransmit-interval <seconds> 5 seconds
transmit-delay <seconds> 1 second

Command History
Release 5.1 Command was expanded to include the Ethernet
subinterfaces.
Usage Examples
The following example specifies an ospf priority of 120 on the Ethernet interface:

(config-eth 0/1)#ip ospf priority 120

ip ospf authentication
Use the ip ospf authentication command to authenticate an interface that is performing open shortest path
first (OSPF) authentication. Use the no form of this command to return to the default setting. Variations of
ip ospf authentication message-digest
ip ospf authentication null
Syntax Description
message-digest Optional. Selects message-digest authentication type.
null Optional. Specifies that no authentication is used.
Default Values
By default, this is set to null (meaning no authentication is used).
Command History
Usage Examples
The following example specifies that no authentication will be used on the Ethernet interface:

(config-eth 0/1)#ip ospf authentication null

ip ospf network
Use the ip ospf network command to specify the type of network on this interface. Use the no form of this
ip ospf network broadcast

ip ospf network point-to-point
Syntax Description
broadcast Sets the network type for broadcast.
point-to-point Sets the network type for point-to-point.
Default Values
By default, Ethernet defaults to broadcast. Point-to-Point Protocol (PPP) and Frame Relay default to
point-to-point.
Command History
Functional Notes
A point-to-point network will not elect designated routers.
Usage Examples
The following example designates a broadcast network type:

(config-eth 0/1)#ip ospf network broadcast

ip pim sparse-mode
Use the ip pim sparse-mode command to enable protocol-independent multicast (PIM) sparse mode for
this interface. Use the no form of this command to disable PIM sparse mode.
Syntax Description
No subcommands.
Default Values
By default, PIM sparse mode for this interface is disabled.
Command History
Functional Notes
PIM sparse mode is a multicast routing protocol that makes use of the unicast forwarding table. It builds
unidirectional shared trees rooted at a rendezvous point (RP) for a multicast group or a shortest path tree
rooted at a specific source for a multicast group.
Usage Examples
The following example enables PIM sparse mode on the interface:

(config-eth 0/1)#ip pim sparse-mode

ip pim-sparse dr-priority <value>

Use the ip pim-sparse dr-priority command to specify the priority for the designated router (DR). This
command modifies the router’s priority in the DR election process. Use the no form of this command to
Syntax Description
<value> Specifies the priority of this interface (to be used when determining the DR).
Default Values
By default, the priority of all protocol-independent multicast (PIM) interfaces is 1.
Command History
Functional Notes
Interfaces advertise their configured priority values in the hello messages transmitted on the interface.
Routers use the priority values to determine the appropriate DR. The router on the network segment with
the highest priority is selected as the DR. If a hello message is received on the interface from a router on
the network segment and it does not contain a priority, the entire network segment defaults to DR selection
based on IP addresses instead of priority. In this instance, the DR is selected as the router on the network
segment that has the highest IP address. AOS will always include a priority in all transmitted hello
messages. If no priority is specifically designated by the user, the priority is set as the default of 1.
Usage Examples
The following example specifies a priority of 100 on the Ethernet 0/1 interface:

(config-eth 0/1)#ip pim-sparse dr-priority 100

ip pim-sparse hello-timer <value>

Use the ip pim-sparse hello-timer command to specify protocol-independent multicast (PIM) sparse hello
timer period. This is the time interval at which periodic hellos are sent out on all interfaces of a
PIM-capable router. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the interval (in seconds) at which periodic hellos are sent out of
the interface. Valid range is 10 to 3600 seconds.
Default Values
By default, the hellos are transmitted on PIM interfaces every 60 seconds.
Command History
Functional Notes
Hello messages are used to inform neighbors of a router’s presence. Hello messages normally generate a
small amount of traffic on an interface. Setting the hello-timer to a small interval increases the number of
hellos sent (thus increasing the amount of traffic). Set the hello-timer to a reasonable value, taking into
consideration the bandwidth available on the interface.
Usage Examples
The following example specifies hellos be sent on the Ethernet 0/1 interface every 3600 seconds:

(config-eth 0/1)#ip pim-sparse hello-timer 3600

ip pim-sparse nbr-timeout <value>

Use the ip pim-sparse nbr-timeout command to specify protocol-independent multicast (PIM) sparse
neighbor timeout. This is the time interval after which a PIM-capable router will consider a neighbor not
present. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the time interval in seconds after which a neighbor is considered
not present. Valid range is 30 to 10800 seconds.
Default Values
By default, the nbr-timeout is set to 105 seconds.
Command History
Usage Examples
The following example sets the nbr-timeout to 300 seconds:

(config-eth 0/1)#ip pim-sparse nbr-timeout 300

ip pim-sparse override-interval <value>

Use the ip pim-sparse override-interval command to specify the protocol-independent multicast (PIM)
sparse join/prune override interval. This delay interval is the period after a join/prune that another router on
the local area network (LAN) may override a join/prune. Use the no form of this command to return to the
default value.
Syntax Description
<value> Specifies the delay time in milliseconds. Valid range is 0 to
65535 milliseconds.
Default Values
By default, the override interval is set to 2500 milliseconds.
Command History
Usage Examples
The following example sets the override interval to 3000 milliseconds:

(config-eth 0/1)#ip pim-sparse override-interval 3000

ip pim-sparse propagation-delay <value>

Use the ip pim-sparse propagation-delay command to specify the expected propagation delay for
join/prune messages. Set the propagation delay (in milliseconds) to estimate the amount of delay found in
the local link. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the expected propagation delay in the local link in milliseconds.
Default Values
By default, the propagation delay is set to 500 milliseconds.
Command History
Usage Examples
The following example sets the propagation delay to 300 milliseconds:

(config-eth 0/1)#ip pim-sparse propagation-delay 300

ip policy route-map <name>

Use the ip policy route-map command to assign a policy route-map to this interface. Use the no form of
this command to remove the route-map policy.
Syntax Description
<name> Specifies the name of the policy route map to assign to this interface.
Default Values
By default, no policy route map is assigned to this interface.
Command History
Usage Examples
The following example assigns the policy route map policy1 to the interface:

(config-eth 0/1)#ip policy route-map policy1

ip proxy-arp
Use the ip proxy-arp command to enable proxy Address Resolution Protocol (ARP) on the interface. Use
Syntax Description
No subcommands.
Default Values
By default, proxy ARP is enabled.
Command History
Functional Notes
In general, the principle of proxy ARP allows a router to insert its IP address in the source IP address field
of a packet (if the packet is from a host on one of its subnetworks). This allows hosts to reach devices on
other subnetworks without implementing routing or specifying a default gateway.
If proxy ARP is enabled, AOS will respond to all ARP requests with its specified medium access control
(MAC) address and forward packets accordingly.
Enabling proxy ARP on an interface may introduce unnecessary ARP traffic on the network.
Usage Examples
The following example enables proxy ARP on the Ethernet interface:

(config-eth 0/1)#ip proxy-arp

ip rip receive version

Use the ip rip receive version command to configure the Routing Information Protocol (RIP) version the
unit accepts in all RIP packets received on the interface. Variations of this command include:
ip rip receive version 1

Syntax Description
1 Accepts only RIP version 1 packets received on the interface.
Default Values
By default, all interfaces implement RIP version 1 (the default value for the version command).
Command History
Functional Notes
Use the ip rip receive version command to specify a RIP version that overrides the version (in the
Router RIP) configuration. Refer to version on page 2409 for more information.
AOS only accepts one version (either 1 or 2) on a given interface.
Usage Examples
The following example configures the Ethernet interface to accept only RIP version 2 packets:

(config-eth 0/1)#ip rip receive version 2

ip rip send version

Use the ip rip send version command to configure the Routing Information Protocol (RIP) version the
unit sends in all RIP packets transmitted on the interface. Variations of this command include:
ip rip send version 1

Syntax Description
1 Transmits only RIP version 1 packets on the interface.
Default Values
By default, all interfaces transmit RIP version 1 (the default value for the version command).
Command History
Functional Notes
Use the ip rip send version command to specify a RIP version that overrides the version (in the Router
RIP) configuration. Refer to version on page 2409 for more information.
AOS only transmits one version (either 1 or 2) on a given interface.
Usage Examples
The following example configures the Ethernet interface to transmit only RIP version 2 packets:

(config-eth 0/1)#ip rip send version 2

ip rip summary-address <ip address> <subnet mask>

Use the ip rip summary-address command to manually summarize the routes Routing Information
Protocol (RIP) will advertise and send out a specified interface. Use the no form of this command to
disable this mode.
Syntax Description
<ip address> Specifies the summarized network IP address. IP addresses should be
<subnet mask> Specifies the subnet mask that corresponds to the range of IP addresses
Default Values
By default, no manual summarization is applied by RIP.
Command History
Functional Notes
Unlike the automatic summarization on classful network boundaries, only specific network advertisements
are made by RIP using the ip rip summary-address command. This command is only effective if RIP
version 2 is configured.
Usage Examples
The following example enables manual summarization on the specified IP address:

(config-eth 0/1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Use the ip route-cache command to enable fast-cache switching on the interface. Use the no form of this
command to disable fast-cache switching and return to process switching mode.
Using network address translation (NAT) or the AOS firewall capabilities on an interface
requires process switching mode (using the no ip route-cache command).
Syntax Description
No subcommands.
Default Values
By default, fast-cache switching is enabled on all Ethernet and virtual Frame Relay subinterfaces. IP route
cache is enabled for all virtual Point-to-Point Protocol (PPP) interfaces.
Command History
Functional Notes
Fast switching allows an IP interface to provide optimum performance when processing IP traffic.
Usage Examples
The following example enables fast switching on the Ethernet interface:

(config-eth 0/1)#ip route-cache

ip unnumbered <interface>
Use the ip unnumbered command to use the IP address assigned to the specified interface for all IP
processing on the active interface. Use the no form of this command to remove the unnumbered
configuration.
Syntax Description
<interface> Specifies the interface that contains the IP address to use as the source
address for all packets transmitted on this interface. Specify an interface in
wireless virtual access point, use dot11ap 1/1.1. Type ip unnumbered ?
for a list of valid interfaces.
Default Values
By default, all interfaces are configured to use a specified IP address (using the ip address command).
Command History
interfaces.
Release 11.1 Command was expanded to include the demand interfaces.
Functional Notes
If ip unnumbered is enabled on an interface, all IP traffic from the interface will use a source IP address
taken from the specified interface. For example, specifying ip unnumbered ppp 1 while in the Ethernet
Interface Configuration mode configures the Ethernet interface to use the IP address assigned to the
Point-to-Point Protocol (PPP) interface for all IP processing. In addition, AOS uses the specified interface
information when sending route updates over the unnumbered interface.
Usage Examples
The following example configures the Ethernet interface 0/1 to use the IP address assigned to the PPP
interface (ppp 1):

(config-eth 0/1)#ip unnumbered ppp 1

ip urlfilter <name>
Use the ip urlfilter command to apply a universal resource locator (URL) filter to the interface for all
inbound or outbound traffic. Use the no form of this command to remove the URL filter from an interface.
ip urlfilter <name> in
ip urlfilter <name> out
Syntax Description
<name> Specifies the URL filter name to use on the interface.
in Applies the filter to the inbound traffic.
out Applies the filter to the outbound traffic.
Default Values
By default, there are no URL filters applied to any interfaces.
Command History
interfaces.
Functional Notes
must be created by using the ip urlfilter <filtername> http command before applying it to the interface.
Refer to ip urlfilter <name> http on page 995 for more information on using this command.
Usage Examples
The following example performs URL filtering on all traffic entering through the Ethernet interface and
matches the URL filter named MyFilter:

(config-eth 0/1)#ip urlfilter MyFilter in

lldp receive
Use the lldp receive command to allow Link Layer Discovery Protocol (LLDP) packets to be received on
this interface. Use the no form of this command to prevent LLDP packets from being received on the
interface.
Syntax Description
No subcommands.
Default Values
By default, all interfaces are configured to send and receive LLDP packets.
Command History
Usage Examples
The following example configures Ethernet interface 0/1 to receive LLDP packets:

(config-eth 0/1)#lldp receive

lldp send
Use the lldp send command to configure this interface to transmit Link Layer Discovery Protocol (LLDP)
packets or to control the types of information contained in the LLDP packets transmitted by this interface.
Use the no form of this command to prevent certain information from being transmitted by the interface.
lldp send 802.3-info mac-phy-config

lldp send management-address
lldp send med-info network-policy
lldp send port-description
lldp send system-capabilities
lldp send system-description
lldp send system-name
lldp send-and-receive
Syntax Description
802.3-info mac-phy-config Enables transmission of the capability and settings of the duplex and speed
on this interface.
management-address Enables transmission of management address information on this interface.
med-info network-policy Enables transmission of LLDP-Media Endpoint Discovery (LLDP-MED)
network policy information on the interface.
port-description Enables transmission of port description information on this interface.
system-capabilities Enables transmission of this device’s system capabilities on this interface.
system-description Enables transmission of this device’s system description on this interface.
system-name Enables transmission of this device’s system name on this interface.
and-receive Configures this interface to both transmit and receive LLDP packets. This is
the default setting.
Default Values
By default, all interfaces that support LLDP except routed Ethernet are configured to transmit and receive
LLDP packets. LLDP is disabled by default on routed Ethernet interfaces.
The 802.3 MAC/PHY status configuration and LLDP-MED network policy time length
values (TLVs) are only supported on switchport interfaces and NetVanta 1524ST Gigabit
Command History
Release 17.2 Command was expanded to include the 802.3 and LLDP-MED information.

Functional Notes
Individual LLDP information can be enabled or disabled using the various forms of the lldp send
command. For example, use the lldp send-and-receive command to enable transmit and receive of all
LLDP information. Then use the no lldp send port-description command to prevent LLDP from
transmitting port description information.
Usage Examples
The following example configures Ethernet interface 0/1 to transmit LLDP packets containing all enabled
information types:

(config-eth 0/1)#lldp send
The following example configures Ethernet interface 0/1 to transmit and receive LLDP packets containing
all enabled information types:

(config-eth 0/1)#lldp send-and-receive

mac-address <mac address>

Use the mac-address command to specify the medium access control (MAC) address of the unit. Only the
last three values of the MAC address can be modified. The first three values contain the ADTRAN
reserved number (00:0A:C8) by default. Use the no form of this command to return to the default MAC
address programmed by ADTRAN.
Syntax Description
Default Values
A unique default MAC address is programmed in each unit shipped by ADTRAN.
Command History
Release 5.1 Command was expanded to include the Gigabit Ethernet interfaces.
Usage Examples
The following example configures a MAC address of 00:0A:C8:5F:00:D2:

(config-eth 0/1)#mac-address 00:0A:C8:5F:00:D2

max-reserved-bandwidth <value>
Use the max-reserved-bandwidth command to specify the percentage of interface bandwidth reserved for
use in user-defined (priority or class-based) queues. The remainder of the interface bandwidth is reserved
for system-critical traffic and is not available to user-defined queues. Use the no form of this command to
restore the default value.
Reserving a portion of the interface bandwidth for system-critical traffic is necessary for
proper operation. Specifying the entire interface bandwidth for use in user-defined queues
can cause undesirable operation.
Syntax Description
<value> Specifies the maximum percentage of bandwidth to reserve for quality of
service (QoS). This setting is configured as a percentage of the total
interface speed. Range is 1 to 100 percent.
Default Values
By default, max-reserved-bandwidth is set to 75 percent, which reserves 25 percent of the interface
bandwidth for system-critical traffic.
Command History
Usage Examples
The following example specifies 85 percent of the bandwidth on the Ethernet interface 0/1 be available for
use in user-defined queues:

(config-eth 0/1)#max-reserved-bandwidth 85

media-gateway ip
Use the media-gateway ip command to associate an IP address source to use for Realtime Transport
Protocol (RTP) traffic. When configuring Voice over Internet Protocol (VoIP), RTP traffic must have an
IP address associated with it. However, some interfaces allow dynamic configuration of IP addresses,
causing this value to change periodically. Use the no form of this command to disable this function.
media-gateway ip loopback <interface id>

media-gateway ip primary
media-gateway ip secondary <ip address>
Syntax Description
loopback <interface id> Specifies an IP address statically defined to a loopback interface for RTP
traffic. This is helpful when using a single IP address across multiple wide
area network (WAN) interfaces for RTP traffic. The valid range for loopback
interface identifiers is 1 to 1024. The interface ID is used to uniquely identify
a loopback interface. The entered value cannot be in use by another
loopback interface.
primary Specifies using this interface’s configured primary IP address for RTP
traffic. Applies to static, Dynamic Host Configuration Protocol (DHCP), or
negotiated addresses.
secondary <ip address> Specifies using this interface’s statically defined secondary IP address for
RTP traffic. IP addresses should be expressed in dotted decimal notation
(for example, 10.10.10.1).
Default Values
By default, media-gateway ip is disabled.
Command History
Release 17.3 Command was updated with the loopback interface identification option.
Usage Examples
The following example configures the unit to use the primary IP address for RTP traffic:

(config-eth 0/1)#media-gateway ip primary

mtu <size>
Use the mtu command to configure the maximum transmission unit (MTU) size for the active interface.
Syntax Description
<size> Configures the window size for transmitted packets. The valid ranges for the
various interfaces are listed below:
ATM subinterfaces 64 to 1520
BVIs 64 to 2100
Demand interfaces 64 to 1520
Ethernet interfaces 64 to 1500
FDL interfaces 64 to 256
Frame Relay subinterfaces 64 to 1520
HDLC interfaces (NetVanta 5305) 64 to 4600
HDLC interfaces (all other NetVanta products) 64 to 2100
Loopback interfaces 64 to 1500
PPP interfaces (NetVanta 5305) 64 to 4600
PPP interfaces (all other NetVanta products) 64 to 2100
Tunnel interfaces 64 to 18190
Default Values
<size> The default values for the various interfaces are listed below:
ATM subinterfaces 1500
BVIs 1500
Demand interfaces 1500
Ethernet interfaces 1500
FDL interfaces 256
Frame Relay subinterfaces 1500
HDLC interfaces 1500
Loopback interfaces 1500
PPP interfaces 1500
Tunnel interfaces 1476
Command History
Functional Notes
Open shortest path first (OSPF) will not become adjacent on links where the MTU sizes do not match. If
router A and router B are exchanging hello packets but their MTU sizes do not match, they will never reach
adjacency. This is by design and required by the RFC.

Usage Examples
The following example specifies an MTU of 1200 on the Ethernet interface:

(config-eth 0/1)#mtu 1200

no shutdown track <name>

Use the no shutdown track command to restore the Gigabit switchport interface when the specified track
passes. For more information about tracks, refer to track <name> on page 1124 and the Network Monitor
Track Command Set on page 2356.
Syntax Description
<name> Specifies the name of the track to associate with the activation of the
interface.
Default Values
Command History
Usage Examples
The following example enables the interface based on the specified track:
(config)#interface gigabit-switchport 0/1

(config-giga-swx 0/1)#no shutdown track work-hours

port-auth auth-mode
Use the port-auth auth-mode command to configure the authentication mode. Use the no form of this
port-auth auth-mode mac-based

port-auth auth-mode port-based
Syntax Description
mac-based Specifies a medium access control (MAC)-based authentication mode.
Each host must authenticate separately.
port-based Specifies a port-based authentication mode. Only a single host can
participate in the authentication process.
Default Values
By default, the authentication mode is port based.
Command History
Usage Examples
The following example configures the unit for MAC-based authentication mode:

(config-eth 0/1)#port-auth auth-mode mac-based

port-auth control-direction
Use the port-auth control-direction command to configure the direction in which traffic is blocked. This
command is only applicable when authentication is port based. Use the no form of this command to return
to the default setting. Variations of this command include:
port-auth control-direction both

port-auth control-direction in
Syntax Description
both Blocks traffic in both directions when the port becomes unauthorized.
in Blocks only incoming traffic when the port becomes unauthorized.
Default Values
By default, traffic is blocked in both directions.
Command History
Usage Examples
The following example causes traffic to be blocked in both directions when the port becomes unauthorized:

(config-eth 0/1)#port-auth control-direction both

port-auth multiple-hosts
Use the port-auth multiple-hosts command to allow multiple hosts to access an authorized port without
going through the authentication process. This command is only applicable when authentication is port
based. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables multiple hosts to access an authorized port:

(config-eth 0/1)#port-auth multiple-hosts

port-auth port-control
Use the port-auth port-control command to configure the port-authorization state. Use the no form of
port-auth port-control auto

port-auth port-control force-authorized
port-auth port-control force-unauthorized
Syntax Description
auto Enables the port-authentication process.
force-authorized Forces the port into an authorized state.
force-unauthorized Forces the port into an unauthorized state.
Default Values
By default, all ports are forced to an authorized state.
Command History
Usage Examples
The following example forces Ethernet port 0/1 into an unauthorized state:

(config-eth 0/1)#port-auth port-control force-unauthorized

power inline
Use the power inline command to detect attached powered devices (PDs) and deliver 48 VDC, compliant
with the IEEE 802.3af Power over Ethernet (PoE) standard, to the PD via existing CAT 5 cabling. To
disable power detection and supply, use the power inline never command. Variations of this command
include:
power inline auto

power inline legacy
power inline never
Syntax Description
auto Enables power detection and supply to PDs.
legacy Enables power detection and supply of legacy non-IEEE 802.3af-compliant
PDs.
never Disables power detection and supply to PDs.
Default Values
By default, PWR switches discover and provide power to IEEE-compliant PDs.
Command History
Usage Examples
The following example configures the Ethernet interface to detect and supply power to PDs:

(config-eth 0/3)#power inline auto

qos-policy
Use the qos-policy command to apply a previously configured quality of service (QoS) map to incoming
or outgoing packets on an interface. Use the no form of this command to remove the map from the
qos-policy in <name>
qos-policy out <name>
Syntax Description
<name> Specifies the name of a previously created QoS map (refer to qos map
<name> <number> on page 1061 for more information).
in Assigns a QoS map to this interface's input.
out Assigns a QoS map to this interface's output.
Default Values
Command History
Release 15.1 Command was expanded to include the in parameter.
Functional Notes
When a QoS policy is applied to an interface, it may be disabled if the interface bandwidth is not adequate
to support the requested bandwidth on the map set. Once the bandwidth problem is resolved, the map will
work again. The bandwidth will be rechecked on any of the following changes:
1. A priority or class-based entry is added to, deleted from, or changed in a QoS map set.
2. The interface bandwidth is changed by the bandwidth command on the interface.
3. A QoS policy is applied to an interface.
4. A cross connect is created that includes an interface with a QoS policy.
5. The interface queuing method is changed to fair queue to use weighted fair queuing.
6. The interface operational status changes.
7. The interface bandwidth changes for other reasons (e.g., when asymmetric digital subscriber line
(ADSL) finishes training).
In order to prevent the map from being disabled in cases of temporary inadequate bandwidth (e.g., a single
link goes down in a dual T1 multilink configuration where the map requests more than one T1's worth of
bandwidth), the QoS map uses the maximum theoretical bandwidth on an interface, not the actual
bandwidth at that time. This actually helps QoS keep higher priority class-based traffic working better than
best-effort traffic when the bandwidth drops.

Usage Examples
The following example applies the QoS map VOICEMAP to the Ethernet interface:

(config-eth 0/1)#qos-policy out VOICEMAP

qos
Use the qos (quality of service) command to set the interface to the trusted state and to set the default cost
of service (CoS) value. To return to defaults, use the no form of this command. Variations of this
command include:
qos default-cos <value>

qos trust cos
Syntax Description
default-cos <value> Sets the default CoS value for untrusted ports and all untagged packets.
Range is 0 through 7.
trust cos Sets the interface to the trusted state.
Default Values
By default, the interface is untrusted with a default CoS of 0.
Command History
Functional Notes
Set the interface to trust cos if received 802.1P. CoS values are considered valid (i.e., no need to
reclassify) and do not need to be tagged with the default value. When set to untrusted, the default-cos
value for the interface is used.
Usage Examples
The following example sets Ethernet interface 0/1 as a trusted interface and assigns untagged packets a
CoS value of 1:

(config-eth 0/1)#qos trust cos
(config-eth 0/1)#qos default-cos 1

rtp quality-monitoring
Use the rtp quality-monitoring command to enable voice quality monitoring (VQM) of the Realtime
Transport Protocol (RTP) voice stream packets on this interface. If the global command (ip rtp
quality-monitoring) is disabled when this command is issued, the system will return the following
warning: “Applied but not used, you must globally enable ip rtp quality-monitoring to use VQM.” Use
Syntax Description
No subcommands.
Default Values
By default, VQM is enabled on all wide area network (WAN) and local area network (LAN) interfaces.
Command History
Usage Examples
The following example enables RTP quality monitoring on the Ethernet 0/2 interface:

(config-eth 0/2)#rtp quality-monitoring

snmp trap
traps on the interface. Us the no form of this command to disable this trap.
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP capability on the Ethernet interface:

(config-eth 0/1)#snmp trap


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the interface:

(config-eth 0/1)#no snmp trap link-status

spanning-tree bpdufilter
Use the spanning-tree bpdufilter command to enable or disable the bridge protocol data unit (BPDU)
filter on a specific interface. This setting overrides the related global setting (refer to spanning-tree
edgeport bpdufilter default on page 1103). Use the no form of this command to return to the default
spanning-tree bpdufilter disable

spanning-tree bpdufilter enable
Syntax Description
disable Disables BPDU filter for this interface.
enable Enables BPDU filter for this interface.
Default Values
By default, this setting is disabled.
Command History
Functional Notes
The bpdufilter blocks any BPDUs from being transmitted and received on an interface.
Usage Examples
The following example enables the BPDU filter on the Ethernet interface 0/3:

(config-eth 0/3)#spanning-tree bpdufilter enable
The BPDU filter can be disabled on the Ethernet interface 0/3 by issuing the following commands:

(config-eth 0/3)#spanning-tree bpdufilter disable

spanning-tree bpduguard
Use the spanning-tree bpduguard command to enable or disable the bridge protocol data unit (BPDU)
guard on a specific interface. This setting overrides the related global setting (refer to spanning-tree
forward-time <value> on page 1106). Use the no form of this command to return to the default setting.
spanning-tree bpduguard disable

spanning-tree bpduguard enable
Syntax Description
disable Disables BPDU guard for this interface.
enable Enables BPDU guard for this interface.
Default Values
Command History
Functional Notes
The bpduguard blocks any BPDUs from being received on an interface.
Usage Examples
The following example enables the BPDU guard on the interface Ethernet interface 0/3:

(config-eth 0/3)#spanning-tree bpduguard enable
The BPDU guard can be disabled on the Ethernet interface 0/3 by issuing the following commands:

(config-eth 0/3)#spanning-tree bpduguard disable

spanning-tree cost <value>

Use the spanning-tree cost command to assign a cost to the interface. The cost value is used when
computing the spanning-tree root path. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies a cost value of 1 to 200000000.
Default Values
By default, the cost value is set to 1000 Mbps.
Command History
Usage Examples
The following example sets the interface to a path cost of 1200:

(config-eth 0/3)#spanning-tree cost 1200

spanning-tree edgeport
Use the spanning-tree edgeport command to configure the interface to be an edgeport. This command
overrides the related global setting (refer to spanning-tree edgeport default on page 1105). Use the no
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Enabling this command configures the interface to go to a forwarding state when the link becomes active.
When not enabled, an interface must go through the listening and learning states before going to the
forwarding state.
Usage Examples
The following example configures the interface to be an edgeport:

(config-eth 0/1)#spanning-tree edgeport

(config-eth 0/1)#no spanning-tree edgeport

spanning-tree link-type
Use the spanning-tree link-type command to configure the spanning tree protocol link type for each
interface. Use the no form of this command to return to the default setting. Variations of this command
include:
spanning-tree link-type auto

spanning-tree link-type point-to-point
spanning-tree link-type shared
Syntax Description
auto Determines link type by the port’s duplex settings.
point-to-point Manually sets link type to point-to-point regardless of duplex settings.
shared Manually sets link type to shared regardless of duplex settings.
Default Values
By default, the interface is set to auto.
Command History
Functional Notes
This command overrides the default link type setting determined by the duplex of the individual port. By
default, a port configured for half-duplex is set to shared link type, and a port configured for full-duplex is
set to point-to-point link type. Setting the link type manually overrides the default and forces the port to
use the specified link type. Use the link-type auto command to restore the convention of determining link
type based on duplex settings.
Usage Examples
The following example forces the link type to point-to-point, even if the port is configured to be
half-duplex:

(config-eth 0/3)#spanning-tree link-type point-to-point
Technology Review
Rapid transitions are possible in Rapid Spanning Tree Protocol (RSTP) by taking advantage of
point-to-point links (a port is connected to exactly one other bridge) and edge-port connections (a port is
not connected to any additional bridges). Setting the link type to auto allows the spanning tree to
automatically configure the link type based on the duplex of the link. Setting the link type to point-to-point
allows a half-duplex link to act as if it were a point-to-point link.

spanning-tree pathcost method

Use the spanning-tree pathcost method command to select a short or long method used by the
spanning-tree protocol. Variations of this command include:
spanning-tree pathcost method long

spanning-tree pathcost method short
Syntax Description
long Specifies 32-bit values when calculating pathcosts.
short Specifies 16-bit values when calculating pathcosts.
Default Values
By default, spanning-tree pathcost method is set to short.
Command History
Usage Examples
The following example specifies that the spanning tree protocol use a long pathcost method:

(config-eth 0/3)#spanning-tree pathcost method long

spanning-tree port-priority <value>

Use the spanning-tree port-priority command to select the priority level of this interface. To return to the
default setting, use the no form of this command.
Syntax Description
<value> Specifies a priority-level value from 0 to 240 (this value must be in
increments of 16).
Default Values
By default, this set to 128.
Command History
Functional Notes
The only time that this priority level is used is when two interfaces with a path to the root have equal cost.
At that point, the level set in this command will determine which port the spanning tree will use. Set the
priority value lower to increase the chance the interface will be used.
Usage Examples
The following example sets the interface to a priority of 100:

(config-eth 0/3)#spanning-tree port-priority 100

speed
Use the speed command to configure the speed of an Ethernet interface. Use the no form of this command
to return to the default value. Variations of this command include:
speed 10
speed 100
speed 1000
speed 1000 nonegotiate
speed 2500
speed auto
Syntax Description
10 Specifies 10 Mbps Ethernet.
100 Specifies 100 Mbps Ethernet.
1000 Specifies 1 Gbps Ethernet. This only applies to Gigabit Ethernet interfaces.
2500 Specifies 2.5 Gbps Ethernet. This only applies to Gigabit Ethernet
interfaces.
nonegotiate Optional. Specifies that auto-negotiation is disabled on Gigabit Ethernet
interfaces that use a fiber medium.
auto Automatically detects 10 or 100 Mbps Ethernet and negotiates the duplex
setting.
Some Ethernet equipment (though rare) is unable to negotiate duplex if speed is manually
determined. To avoid incompatibilities, manually set the duplex if the speed is manually
set. Refer to ethernet-cfm mep on page 1326 and half-duplex on page 1328.
Default Values
By default, speed is set to auto.
Command History
Release 17.5 Command was expanded to include the 2500 Mbps parameter.
Usage Examples
The following example configures the Ethernet port for 100 Mbps operation:

(config-eth 0/1)#speed 100

storm-control
Use the storm-control command to configure limits on the rates of broadcast, multicast, and unicast traffic
on a port. Use the no form of this command to disable this feature. Variations of this command include:
storm-control broadcast level <rising level>

storm-control broadcast level <rising level> <falling level>
storm-control multicast level <rising level>
storm-control multicast level <rising level> <falling level>
storm-control unicast level <rising level>
storm-control unicast level <rising level> <falling level>
Syntax Description
broadcast level Sets levels for broadcast traffic.
multicast level Sets levels for multicast traffic.
unicast level Sets levels for unicast traffic.
<rising level> Specifies a rising level, which determines the percentage of total bandwidth
the port accepts before it begins blocking packets. Range is 1 to
100 percent.
<falling level> Optional. Specifies a falling level, which determines when the storm is
considered over, causing AOS to no longer block packets. This level must be
less than the rising level. Range is 1 to 100 percent.
Default Values
By default, storm-control is disabled.
Command History
Functional Notes
This setting configures the rising and falling suppression values. When the selected rising level (which is a
percentage of total bandwidth) is reached, the port begins blocking packets of the specified type (i.e.,
broadcast, multicast, or unicast). AOS uses the rising level as its falling level if no falling level is specified.
Usage Examples
The following example sets the rising suppression level to 85 percent for multicast packets:

(config-eth 0/1)#storm-control multicast level 85

The following example sets the rising suppression level to 80 percent for broadcast packets, with a falling
level of 50 percent:

(config-eth 0/1)#storm-control broadcast level 80 50

storm-control action shutdown

Use the storm-control action shutdown command to shut down the interface when a storm occurs. Use
Syntax Description
No subcommands.
Default Values
By default, this command is disabled; the interface will only filter traffic.
Command History
Functional Notes
Enabling this option shuts down the interface if a multicast, unicast, or broadcast storm occurs.
Usage Examples
The following example shuts down Ethernet interface 0/1 if a storm is detected:

(config-eth 0/1)#storm-control action shutdown

switchport access vlan <vlan id>

Use the switchport access vlan command to set the port to be a member of the virtual local area network
(VLAN) when in access mode. To reset the port to be a member of the default VLAN, use the no form of
this command.
Syntax Description
Default Values
By default, this is set to VLAN 1 (the default VLAN).
Command History
Functional Notes
If the port is in the trunk mode, this command will not alter the switchport mode to access. Instead it will
save the value to be applied when the port does switch to access mode. Refer to switchport mode on page
Usage Examples
The following example sets the switchport mode to static access and makes the Ethernet interface 0/1 port
a member of VLAN 2:

(config-eth 0/1)#switchport mode access
(config-eth 0/1)#switchport access vlan 2

switchport gvrp
Use the switchport gvrp command to enable or disable GARP VLAN Registration Protocol (GVRP) on
an interface. Use the no form of this command to return to the default value.
Syntax Description
No subcommands.
Default Values
By default, GVRP is disabled on all ports.
Command History
Functional Notes
Enabling GVRP on any interface enables GVRP globally.
Usage Examples
The following example enables GVRP on Ethernet interface 0/24:

(config-eth 0/24)#switchport gvrp

switchport mode
Use the switchport mode command to configure the virtual local area network (VLAN) membership
mode. To reset membership mode to the default value, use the no form of this command. The stack
selection does not apply to the NetVanta 300 Series units. Variations of this command include:
switchport mode access

switchport mode stack
switchport mode trunk
Syntax Description
access Sets port to be a single (nontrunked) port that transmits and receives no
tagged packets.
stack Sets the port to allow it to communicate with a switch stack. (Does not apply
to the NetVanta 300 Series units.)
trunk Sets port to transmit and receive packets on all VLANs included within its
VLAN allowed list.
Default Values
By default, switchport mode is set to access.
Command History
Functional Notes
Configuring the interface for stack mode (using the switchport mode stack command) enables the switch
to communicate with other switches that it is stacking capable.
• Ιf the switch is configured as the stack master (using the (config)#stack master command), it will
begin advertising itself as a stack master.
• Ιf the switch is configured as the stack member (using the (config)#stack member command), it will
begin advertising other stack masters that it knows about.
Stack mode also allows the port to transmit and receive packets on all VLANs that are included in the
VLAN allowed list.
Usage Examples
The following example sets the port to be a trunk port:

(config-eth 0/1)#switchport mode trunk

switchport port-security
Use the switchport port-security command to enable port security functionality on the interface. Use the
no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
This command is disabled by default.
Command History
Functional Notes
You cannot enable port security on a port that is already configured as the following:
• Monitor session destination

• Member of a port channel interface
• Dynamic or trunk port (i.e., the port must be configured as static access)
Usage Examples
The following example enables port security on the Ethernet interface 0/1 interface:

(config-eth 0/1)#switchport port-security

switchport port-security aging

Use the switchport port-security aging command to enable and configure secure medium access control
(MAC) address aging on a particular interface. Use the no form of this command to disable this feature.
switchport port-security aging static

switchport port-security aging time <value>
switchport port-security aging type absolute
Syntax Description
static Configures the interface to age static, as well as dynamic entries in the
secure MAC address table.
time <value> Enables port security aging for dynamic entries in the secure MAC address
table by configuring a time (in minutes). Disable aging by setting the time
to 0.
type absolute Configures the address to be removed after the specified time regardless of
activity.
Default Values
By default, dynamic and static aging are disabled.
Command History
Usage Examples
The following example sets the aging time of secure MAC addresses to 10 minutes:

(config-eth 0/1)#switchport port-security aging time 10

switchport port-security expire

Use the switchport port-security expire command to disable an interface after a specified amount of
time. Use the no form of this command to return to the default setting. Variations of this command include:
switchport port-security expire time <value>

switchport port-security expire type absolute
Syntax Description
time <value> Enables port expiration by configuring a time (in minutes). Disable by
setting time to 0.
type absolute Configures the interface to shut down after the specified time regardless of
activity.
Default Values
By default, this command is disabled and set to type absolute.
Command History
Usage Examples
The following example disables Ethernet interface 0/1 after 10 minutes:

(config-eth 0/1)#switchport port-security expire time 10

switchport port-security mac-address

Use the switchport port-security mac-address command to add a static secure medium access control
(MAC) address or sticky secure MAC address associated with the interface and to enable sticky address
learning. Use the no form of this command to remove a MAC address associated with this port. Variations
of this command include the following:
switchport port-security mac-address <mac address>

switchport port-security mac-address sticky
switchport port-security mac-address sticky-volatile
switchport port-security mac-address sticky <mac address>
Syntax Description
sticky Optional. Enables sticky address learning if no MAC address is specified.
The learned addresses persist across a reboot.
sticky-volatile Optional. Enables sticky address learning for the immediate session only.
The learned addresses do not appear in the configuration and do not persist
across a reboot.
<mac address> Optional. Adds a MAC address associated with this interface. MAC
addresses should be expressed in the following format xx:xx:xx:xx:xx:xx
(for example, 00:A0:C8:00:00:01).
Default Values
By default, sticky learning is disabled and there are no configured MAC addresses.
Command History
Release 17.4 Command was expanded to include the sticky-volatile parameter.
Usage Examples
The following example adds a single static address and enables sticky address learning on interface
Ethernet interface 0/1:

(config-eth 0/1)#switchport port-security mac-address 00:A0:C8:02:D0:30
(config-eth 0/1)#switchport port-security mac-address sticky

switchport port-security maximum <value>

Use the switchport port-security maximum command to configure the maximum number of secure
medium access control (MAC) addresses associated with the interface. Use the no form of this command
Syntax Description
<value> Specifies the maximum number of secure MAC addresses to be associated
with the interface. Range is 1 to 132.
Default Values
Command History
Usage Examples
The following example sets the maximum supported MAC addresses for Ethernet interface 0/1 to 2:

(config-eth 0/1)#switchport port-security maximum 2

switchport port-security violation

Use the switchport port-security violation command to configure the action to be taken once a security
violation is encountered. Use the no form of this command to return to the default setting. Variations of
switchport port-security violation protect

switchport port-security violation restrict
switchport port-security violation shutdown
Syntax Description
protect Determines that the unit will not learn any new secure addresses (nor allow
these new sources to pass traffic) until the number of currently active
secure addresses drops below the maximum setting.
restrict Determines that the security violation counter increments and an Simple
Network Management Protocol (SNMP) trap is sent once a violation is
detected. The new address is not learned and data from that address is not
allowed to pass.
shutdown Determines that the interface is disabled once a violation is detected. A no
shutdown command is required to re-enable the interface.
Default Values
The default for this command is shutdown.
Command History
Usage Examples
The following example configures the interface to react to security violations by not learning the addresses
and not accepting data from the violation source:

(config-eth 0/1)#switchport port-security violation restrict

switchport protected
Use the switchport protected command to prevent the port from transmitting traffic to all other protected
ports. A protected port can only send traffic to unprotected ports. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
This command is disabled by default.
Command History
Usage Examples
In the example below, all three of the ports are on virtual local area network (VLAN) 3, and Ethernet 0/1
and Ethernet 0/2 are designated as protected ports. Ethernet 0/3 is unprotected. Ethernet 0/1 and Ethernet
0/2 will be allowed to send traffic to Ethernet 0/3, but traffic traveling between Ethernet 0/1 and Ethernet
0/2 will be blocked.

(config-eth 0/1)#switchport protected

(config-eth 0/2)#switchport protected


switchport trunk allowed vlan

Use the switchport trunk allowed vlan command to allow certain virtual local area networks (VLANs) to
transmit and receive traffic on this port when the interface is in trunking mode. To return to defaults, use
the no form of this command. Variations of this command include:
switchport trunk allowed vlan <list>

switchport trunk allowed vlan add <list>
switchport trunk allowed vlan all
switchport trunk allowed vlan except <list>
switchport trunk allowed vlan none
switchport trunk allowed vlan remove <list>
Syntax Description
<list> Specifies a list of valid VLAN interface IDs. Refer to Functional Notes below.
add Adds the specified VLAN IDs to the VLAN trunking allowed list.
all Adds all configured VLAN IDs to the VLAN trunking allowed list.
except Adds all configured VLAN IDs to the VLAN trunking allowed list except
those specified in the <vlan id list>.
none Adds no VLAN IDs to the VLAN trunking allowed list.
remove Removes VLAN IDs from the VLAN trunking allowed list.
Default Values
By default, all valid VLANs are allowed.
Command History
Functional Notes
A VLAN list is a set of VLAN IDs delimited by commas. A valid VLAN ID value must be from 1 through
4094. A range of IDs may be expressed as a single element by using a hyphen between endpoints. For
example, the VLAN ID range 1,2,3,4,6,7,8,9,500 may be more easily expressed as 1-4,6-9,500. No spaces
are allowed in a valid ID range.
Usage Examples
The following example adds VLANs to the previously existing list of VLANs allowed to transmit and receive
on this port:

(config-eth 0/1)#switchport trunk allowed vlan add 1-4,6-9,500

switchport trunk fixed vlan

Use the switchport trunk fixed vlan command to change the configured list of virtual local area networks
(VLANs) that remain fixed in use only when GARP VLAN Registration Protocol (GVRP) is enabled on
the interface. Of these VLANs, VLANs statically created will be available for use on the interface. Use the
no form of this command to disable this feature. Variations of this command include:
switchport trunk fixed vlan add <list>

switchport trunk fixed vlan all
switchport trunk fixed vlan except <list>
switchport trunk fixed vlan none
switchport trunk fixed vlan remove <list>
Syntax Description
<list> Specifies a list of valid VLAN interface IDs. Refer to Functional Notes below.
add Adds VLANs to the VLAN GVRP trunking fixed list.
all Adds all VLANs to the VLAN GVRP trunking fixed list.
except Adds all VLAN IDs to the VLAN trunking fixed list except those in the
command line VLAN ID list.
none Removes all VLANs from the VLAN GVRP trunking fixed list.
remove Removes VLAN from the VLAN trunking fixed list.
Default Values
By default, no VLANs are in the VLAN GVRP trunking fixed list (switchport trunk fixed vlan none).
A VLAN list is a set of VLAN IDs delimited by commas. A valid VLAN ID value must be from 1 through
4094. A range of IDs may be expressed as a single element by using a hyphen between endpoints. For
example, the VLAN ID range 1,2,3,4,6,7,8,9,500 may be more easily expressed as 1-4,6-9,500. No spaces
are allowed in a valid ID range.
Command History
Functional Notes
This command has no effect on VLAN membership configuration unless GVRP is enabled on the interface.
Usage Examples
The following example changes the configured list of fixed VLANs by adding VLAN 50 to the list.
(config-eth 0/20)#switchport trunk fixed vlan add 1-15,25-30,40

(config-eth 0/20)#switchport trunk fixed vlan add 50

The following example changes the configured list of fixed VLANs by removing VLANs 10 to 100 from the
list:
(config-eth 0/20)#switchport trunk fixed vlan remove 10-100
The following example changes the configured list of fixed VLANs to include only VLANs 1 to 1000:
(config-eth 0/20)#switchport trunk fixed vlan 1-1000
The following example changes the configured list of fixed VLANs to include no VLANs (except those
VLANs that are native):
(config-eth 0/20)#switchport trunk fixed vlan none

switchport trunk native vlan <vlan id>

Use the switchport trunk native vlan command to set the virtual local area network (VLAN) native to the
interface when the interface is in trunking mode. To return to defaults, use the no form of this command.
Syntax Description
Default Values
By default, this is set to VLAN 1.
Command History
Functional Notes
Configure which VLAN the interface uses as its native VLAN during trunking. Packets from this VLAN
leaving the interface will not be tagged with the VLAN number. Any untagged packets received by the
interface are considered a part of the native VLAN ID.
Usage Examples
The following example sets the native VLAN on Ethernet interface 0/1 to VLAN 2:

(config-eth 0/1)#switchport trunk native vlan 2

switchport vlan
Use the switchport vlan command to create a Link Layer Discovery Protocol-Media Endpoint Discovery
(LLDP-MED) network policy that specifies a virtual local area network (VLAN) for voice, guest-voice,
softphone, or voice-signalling applications. Use the optional cos and dscp keywords to define class of
service (CoS) and differentiated services code point (DSCP) values associated with the application. Use
the no form of this command to remove an existing network policy. Variations of this command include:
switchport guest-voice vlan <vlan id>

switchport guest-voice vlan <vlan id> [cos <value> | dscp <value> | cos <value> dscp <value>]
switchport softphone vlan <vlan id>
switchport softphone vlan <vlan id> [cos <value> | dscp <value> | cos <value> dscp <value>]
switchport voice vlan <vlan id>
switchport voice vlan <vlan id> [cos <value> | dscp <value> | cos <value> dscp <value>]
switchport voice-signalling vlan <vlan id>
switchport voice-signalling vlan <vlan id> [cos <value> | dscp <value> | cos <value> dscp <value>]
Syntax Description
guest-voice Specifies a guest voice application, which is used to define a policy for
guest users with a limited feature set voice service.
softphone Specifies a softphone application, which is used to define a policy for
softphone applications that operate on devices, such as PCs or laptop
computers.
voice Specifies a voice application, which is used to define a policy for dedicated
IP phone handsets and other similar devices supporting interactive voice
services.
voice-signalling Specifies a voice signaling application, which is used to define a policy for
the command and control signaling that supports voice and guest voice
applications.
<vlan id> Specifies the voice VLAN ID. Range is 1 to 4094.
cos <value> Optional. Specifies the CoS value assigned to the application. Range is
0 to 7.
dscp <value> Optional. Specifies the DSCP value assigned to the application. Range is
0 to 63.
Default Values
By default, no LLDP-MED network policies are configured.
If an application and VLAN are specified without the optional CoS or DSCP parameters, then default CoS
and DSCP values are assigned.
Default CoS values are: voice (5); voice-signalling (3); guest-voice (0); softphone (0).
Default DSCP values are: voice (46); voice-signalling (26); guest-voice (0); softphone (0).

Command History
Release 16.1 The command switchport voice vlan <vlan id> was introduced.
Release 17.2 Command was expanded to include the additional applications:
guest-voice, softphone, and voice-signalling. The optional cos and
dscp parameters were added.
Functional Notes
The switchport command allows a configured interface to function as an access point (AP) for a VLAN
while adding the specified VLAN to the port’s allowed VLAN list. This command automatically sets the port
to spanning tree edgeport mode, but this mode is not automatically reset when the voice, guest voice,
softphone, or signaling VLAN is removed.
If the VLAN specified in this command does not yet exist, it will be created in ADTRAN
Operating System (AOS) when the command is issued.
A network policy is typically configured on switchport interfaces in AOS devices that support LLDP-MED.
An exception is the NetVanta 1524ST, where network policies are configured on Gigabit Ethernet
interfaces.
At least one network policy should be configured on a switchport interface that is connected to an
LLDP-MED capable endpoint. Depending on the type and use of Voice over Internet Protocol (VoIP)
equipment attached to the switchport interface, multiple network policies may need to be configured on the
same interface.
Some endpoints prefer to use untagged VLANs for their application. To achieve this in AOS, configure the
application to be on the same VLAN of which the port is a member. By default, this is VLAN 1.
For more information about allowed VLAN lists, refer to switchport trunk allowed vlan on
page 1409. For more information about spanning-tree edgeport mode, refer to
spanning-tree edgeport on page 1391. For more information about switchport mode, refer
to switchport mode on page 1401.
Usage Examples
The following example establishes a voice network policy that uses VLAN 200.

(config-swx 0/1)#switchport voice vlan 200
Since CoS and DSCP values are not specified in the above network policy, the default
values for voice applications will be used: CoS (5); DSCP (46).

The following example establishes a voice network policy that uses VLAN 200 with CoS priority set to 4
and DSCP priority set to 36.

(config-swx 0/1)#switchport voice vlan 200 cos 4 dscp 36

traffic-shape rate <value>

Use the traffic-shape rate command to specify and enforce an output bandwidth for Ethernet and virtual
local area network (VLAN) interfaces. Variations of this command include:

traffic-shape rate <value> <burst>
Syntax Description
<value> Specifies the rate (in bits per second) at which the interface should be shaped.
<burst> Optional. Specifies the allowed burst in bytes. By default, the burst is
specified as the rate divided by 5 and represents the number of bytes that
would flow within 200 ms.
Default Values
By default, traffic-shaping rate is disabled.
Command History
Functional Notes
Traffic shaping can be used to limit an Ethernet segment to a particular rate or to specify use of quality of
service (QoS) on Ethernet or VLAN interfaces.
Usage Examples
The following example sets the outbound rate of Ethernet interface 0/1 to 128 kbps and applies a QoS
policy that gives all Realtime Transport Protocol (RTP) traffic priority over all other traffic:
(config)#qos map voip 1

(config-qos-map)#match ip rtp 10000 10500 all
(config-qos-map)#priority unlimited
(config-qos-map)#interface ethernet 0/1
(config-eth 0/1)#traffic-shape rate 128000
(config-eth 0/1)#qos-policy out voip

vlan-id <vlan id>

Use the vlan-id command to set a virtual local area network (VLAN) ID for the Ethernet interface. Use the
no form of this command to remove an entry. Variations of this command include:
vlan-id <vlan id>

vlan-id <vlan id> native
Syntax Description
<vlan id> Specifies a valid VLAN interface ID number. Range is 1 to 4095.
native Optional. Specifies that data for that VLAN ID goes out untagged. If native is
not specified, data for that VLAN ID goes out tagged.
Default Values
By default, no VLAN ID is set.
Command History
Usage Examples
The following example configures a native VLAN of 5 for the Ethernet interface 0/1:

(config-eth 0/1)#vlan-id 5 native


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


vrrp <number>
Use the vrrp command to configure Virtual Router Redundancy Protocol (VRRP) routers within a router
group. Use the no form of this command to remove the VRRP router’s configurations. Variations of this
command include:
vrrp <number> description <text>

vrrp <number> ip <address>
vrrp <number> ip <address> secondary
vrrp <number> preempt
vrrp <number> preempt delay minimum <time>
vrrp <number> priority <level>
vrrp <number> shutdown
vrrp <number> startup-delay <delay>
vrrp <number> timers advertise <interval>
vrrp <number> timers learn
vrrp <number> track <name>
vrrp <number> track <name> decrement <value>
Syntax Description
<number> Specifies the VRRP router group’s virtual router ID (VRID) number. Range
is 1 to 255.
description <text> Specifies the textual description of the VRRP router within the group.
ip <address> Specifies the IP address to be used by the VRRP router. IP addresses
secondary Optional. Specifies the entry of an additional VRRP router supported IP
address.
preempt Allows a VRRP router to preempt the current master router if its priority level
is higher than the current master’s.
delay minimum <time> Optional. Specifies a delay (in seconds) before the specified router will
attempt to preempt the current master router. Range is 0 to 255 seconds.
priority <level> Specifies the configured priority level of the VRRP router. Level range is 1 to
254.
shutdown Disables the VRRP router.
startup-delay <delay> Specifies a time delay (in seconds) before a VRRP router becomes active.
timers Specifies the configuration of the VRRP timers.
advertise <interval> Specifies the time (in seconds) between advertisements sent by the master
router. Range is 1 to 255 seconds.
learn Specifies that the backup VRRP router learns the advertisement interval of
the master router.
track <name> Specifies a change in priority level of the VRRP router based upon the
specified track.

decrement <value> Optional. Specifies the numerical amount to decrement the VRRP’s priority
level if the track transitions to a FAIL state. Decrement value range is 1 to
254.
Default Values
By default, VRRP is enabled.
By default, a VRRP router will preempt with no additional delay.
The default configured priority for a VRRP router that is either a backup router or not the IP address owner
is 100. The default actual priority of a VRRP router that is the IP address owner is 255.
By default, startup-delay is enabled with a default value of 35 seconds.
By default, the advertisement interval is 1 second.
By default, the default decrement value is 10.
Command History
Functional Notes
A VRRP router may be part of more than one virtual router group. Although VRRP group VRIDs can be
numbered between 1 and 255, only two VRRP routers per interface are supported.
It is recommended that the timers advertise setting is kept at the default value. If it is necessary to change
this setting, ensure that all VRRP routers are configured with the new value, as all VRRP routers in the
virtual group must have the same advertisement interval value. It is also recommended that if the timers
learn function is enabled on one router in a virtual router group, then the timers learn function should be
enabled on all routers in the group.
When the virtual router’s specified IP address is independent of the IP addresses assigned to real
interfaces on the VRRP routers, there is no IP address owner. This addressing method is preferred if
object tracking will be used to monitor the network connection. The IP address used for the virtual router
must be on the same subnet as either the primary or secondary IP addresses assigned to the VRRP
router’s real interface.
A track must be created before the vrrp track command can be issued. Refer to the Network Monitor
Track Command Set on page 2356 for more information on creating tracks. If a VRRP router owns the
virtual router IP address, then the VRRP router’s priority level cannot be decremented as a result of the
track command. If object tracking will be used, it is important that no VRRP router own the virtual router IP
address.
Usage Examples
The following example describes a VRRP router within virtual router group 1 as the Default Master
Router:

(config-eth 0/1)#vrrp 1 description Default Master Router

The following example specifies an IP address of 10.0.0.1 for a VRRP router within virtual router group 1:

(config-eth 0/1)#vrrp 1 ip 10.0.0.1
The following example specifies that the VRRP router within virtual router group 1 preempts the current
master router after a 30 second delay:

(config-eth 0/1)#vrrp 1 preempt delay minimum 30
The following example specifies the configured priority for the VRRP router within virtual router group 1 is
254:

(config-eth 0/1)#vrrp 1 priority 254
The following example disables the VRRP router within virtual router group 1:

(config-eth 0/1)#vrrp 1 shutdown
The following example configures a VRRP router on group 1 to delay 45 seconds before becoming active:

(config-eth 0/1)#vrrp 1 startup-delay 45

Command Reference Guide FDL Interface Command Set
FDL INTERFACE COMMAND SET
FDL Interface Configuration mode is used for establishing a Telnet session over the FDL (facility data
link). To activate, enter the interface fdl command and specify the associated slot/port number (of the T1
interface used) at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-fdl 1/1)#
do on page 51
end on page 52
exit on page 53
ip address <ip address> <subnet mask> on page 1423

ip learn-address on page 1424
peer default ip address <ip address> on page 1427


Use the ip address command to define an IP address on the specified interface. Use the no form of this
command to remove a configured IP address.
Syntax Description
example, /24).
Default Values
Command History
Release 7.1 Command was introduced for the facility data link (FDL) interface.
Usage Examples
The following example configures an IP address of 192.22.72.101 /30:

(config-fdl 1/1)#ip address 192.22.72.101 /30

ip learn-address
Use the ip learn-address command to automatically learn the IP address of the remote unit. Use the no
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the facility data link (FDL) to automatically learn the remote unit’s IP
address:

(config-fdl 1/1)#ip learn-address

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Release 7.1 Command was expanded to support facility data link (FDL).
Functional Notes

Usage Examples
The following example specifies an MTU of 128 on the facility data link (FDL) interface:

(config-fdl 1/1)#mtu 128

peer default ip address <ip address>

Use the peer default ip address command to specify the default IP address of the remote end of this
interface. Use the no form of this command to remove a default IP address.
Syntax Description
<ip address> Specifies the default IP address for the remote end. IP addresses should be
Default Values
By default, there is no assigned peer default IP address.
Command History
Release 7.1 Command was expanded to include the facility data link (FDL).
Functional Notes
This command is useful if the peer’s FDL interface is on a different subnet than the local unit’s FDL
interface IP address. This is common if the FDL interface is unnumbered to another interface’s IP address.
Usage Examples
The following example sets the default peer IP address to 192.22.71.50:

(config-fdl 1/1)#peer default ip address 192.22.71.50

Command Reference Guide FXO Interface Command Set
FXO INTERFACE COMMAND SET
To activate the Foreign Exchange Office (FXO) Interface Configuration mode, enter the interface fxo
command and specify the FXO port at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-fxo 0/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
impedance on page 1429

rx-gain <value> on page 1431
test erl on page 1432
test loop on page 1434
test ring-ground on page 1435
test tip-ground on page 1436
test tone on page 1437
tx-gain <value> on page 1438

impedance
Use the impedance command to configure the access controller (AC) impedance of the 2-wire interface.
Use the no form of this command to return to the default value. Variations of this command include:
impedance [600c | 900r]

impedance [900c | 600r]
impedance [z1| z2 | z3 | z4 | z5 | z6 | z7]
Syntax Description
600c Specifies an impedance of 600 Ω + 2.16 μF.
600r Specifies an impedance of 600 Ω real.
z1 Specifies an impedance of Rs 220 Ω, Rp 820 Ω, Cp 115 μF.
z3 Specifies an impedance of Rs 270 Ω, Rp 750 Ω, Cp 150 μF, Zin 600r.
z5 Specifies an impedance of Rs 350 Ω, Rp 1000 Ω, Cp 210 μF, Zin 600r.
z7 Specifies an impedance of Rp 800 Ω, Rs 100 Ω, Cs 50 μF.
Default Values
By default, the impedance is set to 600c.
Command History
Release A1 Command was expanded to include the settings z1 through z7.
Usage Examples
The following example sets the impedance to 600 Ω + 2.16 μF:

(config-fxo 0/1)#impedance 600c

loopback
Use the loopback command to activate a loopback on the foreign exchange office (FXO) module. Use the
loopback analog
loopback digital
Syntax Description
analog Initiates a loopback toward the T1 network side of the connection after
passing through analog filters in the voice CODEC.
digital Initiates the same loopback before passing through analog filters in the
voice coder-decoder (CODEC).
Default Values
Command History
Usage Examples
The following example activates a loopback toward the T1 network side of the connection after passing
through analog filters in the voice CODEC:

(config-fxo 0/1)#loopback analog

rx-gain <value>
Use the rx-gain command to define the receive gain characteristics on the foreign exchange office (FXO)
interface. Receive gain determines the amplification of the received signal before transmitting it out the
FXO interface. Use the no form of this command to return to the default value.
Syntax Description
<value> Defines the receive gain characteristics for the interface in 0.1 decibel
increments. Range is -6.0 to 10.0 dB.
Default Values
By default, this command is set to 0 dB.
Command History
Functional Notes
When increasing this value, the signal being received on this port sounds louder. When decreasing this
value, the signal being received on this port sounds softer.
Usage Examples
The following example defines the receive gain as -5.4 dB:

(config-fxo 0/1)#rx-gain -5.4

test erl
Use the test erl command to automatically determine the correct impedance value for analog lines
connected to the foreign exchange office (FXO) port. This is helpful when troubleshooting problems with
FXO equipment and assists in adjusting the correct audio levels. Use the no form of the test erl all and test
erl current command to disable these features. Variations of this command include:
test erl all

test erl all auto-set
test erl clear-results
test erl current
test erl display-results
This feature is available only on units with digital signal processor (DSP) hardware
version Freescale MSC7119, and AOS version A2.02 or above. To determine the DSP
hardware version, issue the show version command and look for the DSP hardware
version.
Syntax Description
all Specifies running the test repeatedly, testing all available impedance
settings for the interface.
auto-set Optional. Sets automatically the best measured impedance for the
interface.
clear-results Clears the results from the echo return loss (erl) test.
current Specifies running the test once, using the current impedance setting.
display-results Displays a snapshot of the current test status.
Default Values
Command History
Functional Notes
Before using this feature, an analog line from the service provider must be connected to the FXO interface
and the line must be idle (no call in progress). The FXO interface must be connected to a voice trunk in
order to make the tool available for use.
During the test, the tool sets the FXO transmit gain and receive gain levels to 0 dB to make the proper
measurements. These settings are returned to the configured values when the test is complete. The
rx-gain value adjusts the level being transmitted from the FXO to the line. The tx-gain value adjusts the
level being transmitted from the FXO to the dsp.

Common low ERL values are between 5 and 8 dB. Acceptable ERL values begin around 12 dB. The
higher the ERL value, the more gain adjustment can be made without introducing echo. The commonly
recommended configuration is a receive gain of 0 dB and a ttransmit gain of +6 dB.
The following is an error that could result by attempting to measure ERL when a measurement sequence is
already active:
% could not run erl test
During test execution, a warning is issued when a test sequence terminates abnormally. Reasons for early
termination include:
• Was not able to seize the line

• Line disconnected during test
• DSP timeout (i.e., when the DSP hardware version does not support this feature)
• Test runs for more than 20 seconds per impedance value (for example, 80 seconds with a 4 impedance
setting)
Usage Examples
The following example tests the FXO interface 0/1 to automatically find the best measured impedance
settings:

(config-fxo 0/1)#test erl all auto-set
The following example displays the ERL test status (the output is shown after the command):

(config-fxo 0/1)#test erl display-results
Port Impedance Status Measured ERL

--------------------------------------------------------------------------------------------------------
fxo 0/1 600 c 10 dB
fxo 0/1 900 r 8 dB
fxo 0/1 900 c 9 dB
fxo 0/1 z1 13 dB
fxo 0/1 z2 11 dB
fxo 0/1 z3 14 dB
fxo 0/1 z4 12 dB
fxo 0/1 z5 test calling

test loop
Use the test loop command to manually control the foreign exchange office (FXO) interface’s hook
switch. This is helpful when troubleshooting problems with the FXO equipment. Use the no form of this
command to disable this feature. Variations of this command include:
test loop closed

test loop open
Syntax Description
closed Closes the hook switch, allowing DC current to flow through the interface.
open Opens the hook switch, preventing DC current from flowing through the
interface.
Default Values
Command History
Usage Examples
The following example opens the interface’s hook switch:

(config-fxo 0/1)#test loop open

test ring-ground
Use the test ring-ground command to force the ring conductor to ground potential and provides battery on
tip for detection of tip ground. This is helpful when troubleshooting problems with ground start (GS)
circuits. Use the no form of this command to return to the default value.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example forces a ring-ground test of the foreign exchange office (FXO) interface:

(config-fxo 0/1)#test ring-ground

test tip-ground
Use the test tip-ground command to detect the removal of the ring ground and check for the loop
condition on an active foreign exchange office (FXO) interface. This is helpful when troubleshooting
problems with ground start (GS) circuits. Use the no form of this command to return to the default value.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example forces a tip-ground test of the FXO interface:

(config-fxo 0/1)#test tip-ground

test tone
Use the test tone command to activate the 1 kHz test tone. Use the no form of this command to deactivate
the test tone. Variations of this command include:
test tone far

test tone near
Syntax Description
far Sends the test tone out the T1 network interface to the remote end.
near Sends the test tone toward the foreign exchange office (FXO) interface.
Default Values
Command History
Usage Examples
The following example sends the test tone toward the FXO interface:

(config-fxo 0/1)#test tone near

tx-gain <value>
Use the tx-gain command to define the transmit gain characteristics on the foreign exchange office (FXO)
interface. Transmit gain determines the amplification of the transmitted signal before transmitting from the
FXO interface toward the network. Use the no form of this command to return to the default value.
Syntax Description
<value> Defines the transmit gain characteristics in 0.1 decibel increments. Range is
-6.0 to 10.0 dB.
Default Values
By default, transmit gain is set to 0 dB.
Command History
Functional Notes
When increasing this value, the signal being transmitted to the far end sounds louder. When decreasing
this value, the signal being transmitted to the far end sounds softer.
Usage Examples
The following example defines the transmit gain as -5.4 dB on the FXO interface:

(config-fxo 0/1)#tx-gain -5.4

Command Reference Guide FXS Interface Command Set
FXS INTERFACE COMMAND SET
To activate the Foreign Exchange Station (FXS) Interface Configuration mode, enter the interface fxs
command and specify the FXS port at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-fxs 2/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
caller-id on page 1440

impedance on page 1441
ring-voltage <value> on page 1443
rx-gain <value> on page 1444
signal on page 1445
test commands begin on page 1446
tx-gain <value> on page 1451

caller-id
Use the caller-id command to configure caller identification (ID). Use the no form of this command to
cancel the setting. Variations of this command include:
caller-id delay <value>

caller-id format mdmf
caller-id format sdmf
Syntax Description
delay <value> Specifies the delay between ring-off and caller ID frequency-shift keying
(FSK). Valid range is 500 to 2000 ms. Common values are 500, 750, and
1000.
format Specifies the format for caller ID as mdmf or sdmf.
mdmf Indicates the caller ID format as multiple data message format (mdmf).
sdmf Indicates the caller ID format as single data message format (sdmf).
Default Values
By default, caller ID is disabled.
Command History
Usage Examples
The following example configures the caller ID delay to 500 ms:

(config-fxs 2/1)#caller-id delay 500

impedance
Use the impedance command to configure the access controller (AC) impedance of the 2-wire interface.
impedance 600c
impedance 600r
impedance 900b
impedance 900c
impedance 900r
impedance z1
Syntax Description
900b Use only when directed by ADTRAN and only with part number 1203602L1.
z1 Specifies an impedance of Rs 220 μ, Rp 820 μ, Cp 115 μF.
Default Values
The default value for this command is 600r.
Command History
Release A1 Command was expanded to include the 900b impedance setting.
Release A2 Command was expanded to include the z1 impedance setting.
Usage Examples
The following example sets the impedance to 600 Ω + 2.16 μF:

(config-fxs 2/1)#impedance 600c

loopback
Use the loopback command to activate a loopback toward the T1 network side on the foreign exchange
station (FXS) module. Use the no form of this command to deactivate the loopback. Variations of this
command include:
loopback analog
loopback digital
Syntax Description
analog Initiates a loopback toward the T1 network side of the connection after
passing through analog filters in the voice coder-decoder (CODEC).
digital Initiates the same loopback before passing through analog filters in the
voice CODEC.
Default Values
Command History
Usage Examples
The following example activates a loopback toward the T1 network side of the connection after passing
through analog filters in the voice CODEC:

(config-fxs 2/1)#loopback analog

ring-voltage <value>
The ring-voltage command sets the ring voltage for the foreign exchange station (FXS) interface.
Increasing the ring voltage, sends a stronger ring signal to the phones connected to this interface. Use the
no form of this command to return to the default value.
Syntax Description
<value> Specifies a ring voltage. Select from 50, 60 or 70 Vrms.
Default Values
By default, ring voltage is set to 50 Vrms.
Command History
Usage Examples
The following example sets the ring voltage to 60 Vrms:

(config-fxs 2/1)#ring-voltage 60

rx-gain <value>
Use the rx-gain command to define the receive gain characteristics on the foreign exchange station (FXS)
interface. Receive gain determines the amplification of the received signal before transmitting out the FXS
interface. Use the no form of this command to return to the default value.
Syntax Description
<value> Defines the receive gain characteristics for the interface in 0.1 decibel
Default Values
By default, this command is set to -3.0 dB.
Command History
Functional Notes
When increasing this value, the signal being received on this port sounds louder. When decreasing this
value, the signal being received on this port sounds softer.
Usage Examples
The following example defines the receive gain as -6.4 dB:

(config-fxs 2/1)#rx-gain -6.4

signal
The signal command configures the signaling mode for the foreign exchange station (FXS) interface. Use
the no form of this command to return to the default value. Variations of this command include:
signal ground-start
signal loop-start
Syntax Description
ground-start Applies resistance to the tip conductor of the circuit to indicate an off-hook
condition.
loop-start Bridges the tip and ring to indicate an off-hook (seizing the line) condition.
Default Values
By default, this command is set to loop-start.
Command History
Functional Notes
This signaling mode must match the configuration of the network.
Usage Examples
The following example sets the signaling mode to loop-start:

(config-fxs 2/1)#signal loop-start

test battery
Use the test battery command to provide battery on the 2-wire foreign exchange station (FXS) interface.
This is helpful when troubleshooting wiring problems with the FXS equipment. Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example provides battery on the 2-wire FXS interface:

(config-fxs 2/1)#test battery

test reverse-battery
Use the test reverse-battery command to provide reverse battery polarity on the foreign exchange station
(FXS) interface. This is helpful when troubleshooting wiring problems with the FXS equipment. Use the
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example provides reverse battery polarity on the FXS interface:

(config-fxs 2/1)#test reverse-battery

test ringing
Use the test ringing command to activate ringing voltage on the 2-wire foreign exchange station (FXS)
interface (using a 2-seconds-on/4-seconds-off cadence). The no form of this command removes the ringing
voltage from the interface.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates ringing voltage on the 2-wire FXS interface:

(config-fxs 2/1)#test ringing

test tip-open
Use the test tip-open command to provide battery on ring and a high impedance on tip. This is helpful
when troubleshooting problems with ground start (GS) interfaces. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example provides battery on ring and a high impedance on tip on the foreign exchange
station (FXS) interface:

(config-fxs 2/1)#test tip-open

test tone
Use the test tone command to activate the 1 kHz test tone. Use the no form of this command to deactivate
the test tone. Variations of this command include:
test tone near

test tone far
Syntax Description
near Sends the test tone toward the foreign exchange station (FXS) interface.
far Sends the test tone out the T1 network interface to the remote end.
Default Values
Command History
Usage Examples
The following example sends the test tone toward the FXS interface:

(config-fxs 2/1)#test tone near

tx-gain <value>
Use the tx-gain command to define the transmit gain characteristics (configured in 0.1 dB increments) on
the foreign exchange station (FXS) interface. Transmit gain determines the amplification of the received
signal before transmitting from the FXS interface toward the network. Use the no form of this command to
Syntax Description
<value> Defines the transmit gain characteristics for the interface in 0.1 decibel
Default Values
By default, this command is set to -6.0 dB.
Command History
Functional Notes
When increasing this value, the signal being transmitted to the far end will sound louder. When decreasing
this value, the signal being transmitted to the far end sounds softer.
Usage Examples
The following example defines the transmit gain as -6.4 dB on the FXS interface:

(config-fxs 2/1)#tx-gain -6.4

Command Reference Guide G.703 Interface Command Set
G.703 INTERFACE COMMAND SET
To activate the G.703 Interface Configuration mode, enter the interface e1 command (and specify the
G.703 port) at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-e1 1/2)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
coding on page 1453

framing crc4 on page 1454
ts16 on page 1458

coding
Use the coding command to configure the line coding for the G.703 physical interface. This setting must
match the line coding supplied on the circuit by the private branch exchange (PBX). Use the no form of
coding ami
coding hdb3
Syntax Description
hdb3 Configures the line coding for high-density bipolar 3 (HDB3).
Default Values
By default, all E1 interfaces are configured with HDB3 line coding.
Command History
Functional Notes
The line coding configured in the unit must match the line coding of the E1 circuit. A mismatch will result in
Usage Examples
The following example configures the G.703 interface for AMI line coding:
(config-e1 1/2)#coding ami

framing crc4
Use the framing crc4 command to configure the framing format for the G.703 interface. This parameter
should match the framing format set on the external device. Use the no form of this command to return to
the default value.
Syntax Description
crc4 Enables CRC4 bits to be transmitted in the outgoing data stream. Also, the
received signal is checked for CRC4 errors.
Default Values
By default, CRC4 is enabled.
Command History
Functional Notes
The framing value must match the configuration of the E1 circuit. A mismatch will result in a loss of frame
alarm.
Usage Examples
The following example configures the G.703 interface for CRC4 framing:
(config-e1 1/2)#framing crc4

loopback network

Syntax Description
line Initiates a metallic loopback of the physical E1 network interface.
payload Initiates a loopback of the E1 framer (CSU portion) of the E1 network
interface.
Default Values
Command History
Functional Notes
The following diagram depicts a line loopback.
E1 Network Interface
NI CSU
NTWK E1
Line Loopback
Usage Examples
The following example initiates a line loopback of the G.703 interface:
(config-e1 1/2)#loopback network line


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the G.703 interface:
(config-e1 1/2)#no snmp trap link-status

test-pattern
include:
test-pattern ones
test-pattern zeros
Syntax Description
Default Values
Command History
Release 6.1 Command was expanded to include the E1 and G.703 interfaces.
Usage Examples
(config-e1 1/2)#test-pattern ones

ts16
Use the ts16 command to enable timeslot 16 multiframe to be checked on the receive signal. Use the no
form of this command to disable timeslot 16.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables timeslot 16 multiframing:
(config-e1 1/2)#ts16

Command Reference Guide HSSI Interface Command Set
HSSI INTERFACE COMMAND SET
To activate the High Speed Serial Interface (HSSI) Interface Configuration mode, enter the interface hssi
>enable
#configure terminal
(config-hssi 1/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
external-loopback-request on page 1460


external-loopback-request
Use the external-loopback-request command to enable LC (loopback circuit C) input to control
loopbacks toward the network. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the unit to accept external loopback requests:

(config-hssi 1/1)#external-loopback-request

loopback
Use the loopback command to initiate or remove a loopback. Use the no loopback command to disable all
loopbacks. Variations of this command include:
loopback dce
loopback dte
loopback line
loopback remote
loopback none
Syntax Description
dce Initiates a loopback on the data communication equipment (DCE).
dte Initiates a loopback on the data terminal equipment (DTE).
line Initiates a local line loopback.
remote Initiates a remote line loopback.
none Removes an active loopback.
Default Values
By default, no loopbacks are active.
Command History
Usage Examples
The following example initiates a local line loopback on the high speed serial interface (HSSI):

(config-hssi 1/1)#loopback line


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the interface:

(config-hssi 1/1)#no snmp trap link-status

Command Reference Guide Modem Interface Command Set
MODEM INTERFACE COMMAND SET
To activate the Modem Interface Configuration mode, enter the interface modem command at the Global
>enable
#configure terminal
(config-modem 1/2)#
The modem interface number in the example above is shown as modem 1/2. This number is
based on the interface’s location (slot/port) and could vary depending on the unit’s
configuration. Use the do show interfaces command to determine the appropriate
interface number.

do on page 51
end on page 52
exit on page 53
shutdown on page 61

dialin on page 1465
init-string <string> on page 1466
resource pool-member on page 1467

caller-id-override
Use the caller-id-override command to configure the unit to replace caller ID information with a
user-specified number. Use the no form of this command to disable any caller ID overrides. Variations of
caller-id-override always <number>

caller-id-override if-no-cid <number>
Syntax Description
always <number> Always forces replacement of the incoming caller ID number with the
number given.
if-no-cid <number> Replaces the incoming caller ID number with the number given only if there
is no caller ID information available for the incoming call.
Default Values
Command History
Functional Notes
This command forces a replacement of the incoming caller ID number with the number given. The received
caller ID, if any, is discarded, and the given override number is used to connect the incoming call to a
circuit of the same number.
Usage Examples
The following example configures the unit to always provide the given number as the caller ID number:

(config-modem 1/2)#caller-id-override always 5555555

dialin
Use the dialin command to enable the modem for remote console dial in, disabling the use of the modem
for dial backup. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, dialin is disabled.
Command History
Usage Examples
The following example enables remote console dial in:

(config-modem 1/2)#dialin

init-string <string>
Use the init-string command to specify an initialization string for the modem using standard AT
commands. Use the no form of this command to return to the default initialization string.
Syntax Description
<string> Specifies an initialization string using standard AT commands. This string
must start with AT and cannot contain spaces.
Default Values
<string> ate0q0v1x4\n0
at All initialization strings must begin with AT.
e0 Disables command echo.
q0 Response messages on.
v1 Formats result codes in long word form.
x4 Specifies extended response set, dial tone, and busy signal
detection for result codes following modem operations.
\n0 Selects standard buffered connection only.
Command History
Usage Examples
The following example configures the modem to perform a hang-up at each initialization (to verify that the
line is free) and maintains the default initialization:

(config-modem 1/2)#init-string ate0q0v1x4\n0

resource pool-member
Use the resource pool-member command to assign the interface to a resource pool, making it a demand
routing resource. Use the no form of this command to return to the default value. Variations of this
command include:

resource pool-member <name> <cost>
Syntax Description
<name> Specifies the name of the resource pool to which this interface is assigned.
<cost> Optional. Specifies the cost of using this resource interface within the
specified pool. In the event of a tie, a resource with a lower cost will be
selected first. Interfaces with the same cost will be selected in alphabetical
order by interface name.
Default Values
By default, the interface is not assigned to any resource pool.
Command History
Usage Examples
The following example configures a basic rate interface (BRI) as a member of resource pool MyPool:

(config-modem 1/2)#resource pool-member MyPool

Command Reference Guide PRI Interface Command Set
PRI INTERFACE COMMAND SET
To activate the PRI Interface Configuration mode, enter the interface pri command at the Global
>enable
#configure terminal
(config-pri 2)#

do on page 51
exit on page 53
shutdown on page 61
calling-party on page 1469

calling-party name-facility-timeout <value> on page 1470
connect e1<slot/port> tdm-group <number> on page 1471
connect t1 <slot/port> tdm-group <number> on page 1472
digits-transferred <value> on page 1473
isdn name-delivery on page 1474
isdn switch-type on page 1475
role on page 1476

calling-party
Use the calling-party command to configure and control the primary rate interface (PRI) outgoing caller
ID information. Use the no form of this command to disable this feature. Variations of this command
include:
calling-party name <name>

calling-party number <number>
calling-party override always
calling-party override if-no-CID
calling-party presentation allowed
calling-party presentation not-available
calling-party presentation restricted
Syntax Description
name <name> Configure the calling party name for the PRI.
number <number> Configure the calling party number for the PRI.
override always Enables the calling party to be replaced with the override number.
override if-no-CID Enables the calling party to be replaced if caller ID no number is received.
presentation allowed Enables the presentation of caller ID to always be allowed.
presentation not-available Sets the calling party number to not available.
presentation restricted Restricts the delivery on the caller ID information.
Default Values
By default, the command is disabled.
Command History
Usage Examples
The following example configures calling party outgoing information:
(config-pri 2)#calling-party override always
(config-pri 2)#calling-party presentation 555-8000
(config-pri 2)#calling-party name Company, Inc.

calling-party name-facility-timeout <value>

Use the calling-party name-facility-timeout command to set the name facility timeout. This value
determines the number of seconds to wait for the calling-party name delivery after the initial SETUP
message is received. Once the name delivery is received or the timeout has passed, the corresponding
INVITE is sent using the Session Initiation Protocol (SIP) trunk. Set the value to 0 to eliminate the delay.
Use the no form of this command to return to the default setting.
Syntax Description
<value> Sets the number of seconds to wait for the calling-party name delivery. Valid
range is 0 to 5.
Default Values
By default, the timeout is 2 seconds.
Command History
Usage Examples
The following example sets the calling-party name-facility-timeout to 5 seconds:
(config-pri 2)#calling-party name-facility-timeout 5

connect e1<slot/port> tdm-group <number>

Use the connect e1 tdm-group command to configure the time division multiplexing (TDM) group
connection used for the primary rate integrated services digital network (ISDN) primary rate interface
(PRI) interface. Use the no form of this command to return to the default value.
Syntax Description
<slot/port> Specifies the E1 interface identifier.
<number> Specifies the TDM group number. Valid range is 1 to 255.
Default Values
Command History
Usage Examples
The following example configures the unit to connect tdm-group 1 of the E1 to the PRI interface 2:
(config-pri 2)#connect e1 0/1 tdm-group 1

connect t1 <slot/port> tdm-group <number>

Use the connect t1 tdm-group command to configure the time division multiplexing (TDM) group
connection used for the primary rate interface (PRI). Use the no form of this command to return to the
default value.
Syntax Description
<slot/port> Configure the T1 interface identifier.
<number> Configure the TDM group number. Valid range is 1 to 255.
Default Values
Command History
Usage Examples
The following example configures the unit to connect tdm-group 1 of the T1 to the PRI:
(config-pri 2)#connect t1 1/1 tdm-group 1

digits-transferred <value>
Use the digits-transferred command to define how many of the received digits should be sent to the
internal switchboard from an incoming call on a trunk. The number of digits transferred are the least digits
received. Direct inward dialing (DID) should be used if a Telco provider is providing digits to the unit on
inbound calls or if the unit needs to provide DID information to a piece of customer premises equipment
(CPE). Use the no form of this command to disable this feature. Variations of this command include:
digits-transferred <value>
digits-transferred <value> no-prefix
digits-transferred <value> prefix <number>
Syntax Description
<value> Specifies the number of digits to be transferred. The valid number of digits
are 0, 3, 4, 7 or all.
no-prefix Optional. Specifies transferring the DID digits without appending a prefix.
prefix <number> Optional. Specifies a sequence of digits to be appended to the digits that will
be transmitted. For example, if seven digits will be transferred via DID, then
prefix the seven digits with 256. Thus, 555-8000 would be prefixed with 256,
and 256-555-8000 would not.
Default Values
Command History
Usage Examples
The following example transfers the digits 555-8000 and adds the prefix 256:
(config-pri 2)#digits-transferred 5558000 prefix 256

isdn name-delivery
Use the isdn name-delivery command to control the delivery of the name associated with the primary rate
interface (PRI). This command can be used to block the caller ID name on the PRI. Use the no form of this
isdn name-delivery display

isdn name-delivery proceeding
isdn name-delivery setup
Syntax Description
display Delivers the calling party’s name in the setup message.
proceeding Delivers the calling party’s name in the proceeding message.
setup Delivers the calling party’s name in the setup message.
Default Values
By default, isdn name-delivery is disabled.
Command History
Usage Examples
The following example configures the calling party information to be delivered in the setup message:
(config-pri 2)#isdn name-delivery setup

isdn switch-type
Use the isdn switch-type command to configure the switch type assigned on the primary rate integrated
services digital network (ISDN) primary rate interface (PRI) circuit. Telephone companies use various
types of ISDN switches and this setting must match the switch type used by your provider. Use the no form
isdn switch-type 4ess

isdn switch-type 5ess
isdn switch-type dms100
isdn switch-type etsi
isdn switch-type etsi legacy
isdn switch-type ni2
Syntax Description
4ess Sets the ISDN switch type to ATT 4ESS.
5ess Sets the ISDN switch type to Lucent 5ESS.
dms100 Sets the ISDN switch type to Northern ISDN II.
etsi Sets the ISDN switch type to European Telecommunications Standards
Institute (ETSI) (ETS 300 403).
etsi legacy Sets the ISDN switch type to legacy ETSI (ETS 300 102).
ni2 Sets the ISDN switch type to National ISDN II.
Default Values
By default, the command is set to ni2.
Command History
Release A2 Command was expanded to include the ETSI switch types.
Usage Examples
The following example configures the PRI switch type National ISDN II:
(config-pri 2)#isdn switch-type ni2

role
Use the role command to configure the interface protocol to use on the primary rate interface (PRI). This
setting controls the functional mode of the interface. Use the no form of this command to return to the
role network
role network b-channel-restarts disable
role network b-channel-restarts enable
role user
Syntax Description
network Sets the port to operate in network termination (NT) mode.
b-channel-restarts disable Optional. Disables B-channel restarts.
b-channel-restarts enable Optional. Enables B-channel restarts.
user Sets the port to operate in terminal equipment (TE) mode.
Default Values
By default, the role is set to network b-channel-restarts disable.
Command History
Usage Examples
The following example configures the interface protocol as user on the PRI:
(config-pri 2)#role user

Command Reference Guide Serial Interface Command Set
SERIAL INTERFACE COMMAND SET
To activate the Serial Interface Configuration mode, enter the interface serial command at the Global
>enable
#configure terminal
(config-ser 1/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
et-clock-source on page 1478

ignore dcd on page 1479
invert etclock on page 1480
invert rxclock on page 1481
invert txclock on page 1482
serial-mode on page 1483

et-clock-source
Use the et-clock-source command to configure the clock source used when creating the external transmit
reference clock (et-clock). Use the no form of this command to return to the default value. Variations of
et-clock-source rxclock
et-clock-source txclock
Syntax Description
rxclock Uses the clock recovered from the receive signal to generate et-clock.
txclock Uses the clock recovered from the transmit signal to generate et-clock.
Default Values
By default, the clock recovered from the transmit signal is used to generate the et-clock.
Command History
Functional Notes
The external transmit clock (et-clock) is an interface timing signal (provided by the data terminal equipment
(DTE) device) used to synchronize the transfer of transmit data.
Usage Examples
The following example configures the serial interface to recover the clock signal from the received signal
and use it to generate et-clock:

(config-ser 1/1)#et-clock-source rxclock

ignore dcd
Use the ignore dcd command to specify the behavior of the serial interface when the data carrier detect
(DCD) signal is lost. Use the no form of this command to return to the default value.
Syntax Description
No subcommands.
Default Values
By default, the serial interface does not ignore a change in status of the DCD signal.
Command History
Functional Notes
When configured to follow DCD (default condition), the serial interface will not attempt to establish a
connection when DCD is not present. When configured to ignore DCD, the serial interface will continue to
attempt to establish a connection even when DCD is not present.
Usage Examples
The following example configures the serial interface to ignore a loss of the DCD signal:

(config-ser 1/1)#ignore dcd

invert etclock
Use the invert etclock command to configure the serial interface to invert the external transmit reference
clock (et-clock) in the data stream before transmitting. Use the no form of this command to return to the
default value.
Syntax Description
No subcommands.
Default Values
By default, the serial interface does not invert et-clock.
Command History
Functional Notes
If the serial interface cable is long, causing a phase shift in the data, the et-clock can be inverted using the
invert etclock command. This switches the phase of the clock, which compensates for a long cable.
Usage Examples
The following example configures the serial interface to invert et-clock:

(config-ser 1/1)#invert etclock

invert rxclock
Use the invert rxclock command to configure the serial interface to expect an inverted receive clock
(found in the received data stream). Use the no form of this command to return to the default value.
Syntax Description
No subcommands.
Default Values
By default, the serial interface does not expect an inverted receive clock (rxclock).
Command History
Functional Notes
If the serial interface cable is long, causing a phase shift in the data, the transmit clock can be inverted
using the invert txclock command (refer to invert txclock on page 1482). This switches the phase of the
clock, which compensates for a long cable. If the transmit clock of the connected device is inverted, use
the invert rxclock command to configure the receiving interface appropriately.
Usage Examples
The following example configures the serial interface to invert receive clock:

(config-ser 1/1)#invert rxclock

invert txclock
Use the invert txclock command to configure the serial interface to invert the transmit clock (found in the
transmitted data stream) before sending the signal. Use the no form of this command to return to the
default value.
Syntax Description
No subcommands.
Default Values
By default, the serial interface does not invert transmit clock (txclock).
Command History
Functional Notes
If the serial interface cable is long, causing a phase shift in the data, the transmit clock can be inverted
(using the invert txclock command). This switches the phase of the clock, which compensates for a long
cable. If the transmit clock of the connected device is inverted, use the invert rxclock command to
configure the receiving interface appropriately.
Usage Examples
The following example configures the serial interface to invert the transmit clock:

(config-ser 1/1)#invert txclock

serial-mode
Use the serial-mode command to specify the electrical mode for the interface. Use the no form of this
command to return to the default value. Variations of this command include:
serial-mode eia530
serial-mode v35
serial-mode x21
Syntax Description
eia530 Configures the interface for use with the EIA 530 adapter cable
(P/N 1200883L1).
v35 Configures the interface for use with the V.35 adapter cable
(P/N 1200873L1).
x21 Configures the interface for use with the X.21 adapter cable
(P/N 1200874L1).
Default Values
By default, the serial interface is configured for a V.35 adapter cable.
Command History
Functional Notes
The pinouts for each of the available interfaces can be found in the Hardware configuration guide located
on the AOS Documentation CD (provided in shipment).
Usage Examples
The following example configures the serial interface to work with the X.21 adapter cable:

(config-ser 1/1)#serial-mode x21

snmp trap
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP on the serial interface:

(config-ser 1/1)#snmp trap


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the serial interface:

(config-ser 1/1)#no snmp trap link-status

Command Reference Guide SHDSL Interface Command Set
SHDSL INTERFACE COMMAND SET
To activate the Single-Pair High-Speed Digital Subscriber Line (SHDSL) Interface Configuration mode,
enter the interface shdsl command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-shdsl 1/1)#
Not all SHDSL commands apply to all SHDSL interfaces. Type interface shdsl <slot/port>
to display a list of valid commands.

do on page 51
end on page 52
exit on page 53
shutdown on page 61
alarm-threshold on page 1487

annex on page 1488
boot alternate-image on page 1489
equipment-type on page 1490
ignore-error-duration <time> on page 1491
inband-detection on page 1492
inband-protocol on page 1493
line-mode on page 1494
linerate <value> on page 1495
loopback remote inband on page 1497
outage-retrain on page 1498

alarm-threshold
Use the alarm-threshold command to set thresholds for specific alarm conditions. Use the no form of this
command to disable threshold settings. Variations of this command include:
alarm-threshold loop-attenuation <value>

alarm-threshold snr-margin <value>
Syntax Description
loop-attenuation <value> Specifies a loop-attenuation threshold value from 1 to 127 dB. If signal
energy loss on the loop exceeds the configured value, the router issues an
alarm.
snr-margin <value> Specifies a value for signal-to-noise ratio (SNR) margin from 1 to 15 dB. If
the difference in amplitude between the baseband signal and the noise
exceeds the configured value, the router issues an alarm.
Default Values
Command History
Usage Examples
The following example sets the loop attenuation threshold at 45 dB:

(config-shdsl 1/1)#alarm-threshold loop-attenuation 45

annex
Use the annex command to select the single-pair high-speed digital subscriber line (SHDSL) operating
mode supported on this interface. Use the no form of this command to return to the default setting.
annex a
annex a-or-b
annex b
Syntax Description
a Specifies Annex A (North America operating parameters).
a-or-b Specifies Annex A or B. This feature allows for the detection and then
selection of the annex type during training.
b Specifies Annex B (Europe operating parameters).
Default Values
By default, the SHDSL operating mode is set to a-or-b.
Command History
Usage Examples
The following example sets the operating mode to annex a:

(config-shdsl 1/1)#annex a

boot alternate-image
Use the boot alternate-image command to execute new code after a firmware upgrade.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The current single-pair high-speed digital subscriber line (SHDSL) network interface module (NIM) card
(P/N 1200867L1) supports two code images commonly referred to as the active image and the inactive
image. When a firmware upgrade is performed on the card (through the copy <filename> interface shdsl
x/y Enable mode command), the new firmware is placed in the inactive image space. This new code will
not be executed until the boot alternate-image command is issued. When the user does this, the NIM will
reboot (taking the current line down) with the new code. At this point, the old code becomes the inactive
image and the new recently updated code becomes the active image.
Usage Examples
The following example causes the firmware upgrade to take effect:

(config-shdsl 1/1)#boot alternate-image

equipment-type
Use the equipment-type command to determine the operating mode for the single-pair high-speed digital
subscriber line (SHDSL) interface. Use the no form of this command to return to the default setting.
equipment-type co
equipment-type cpe
Syntax Description
co Use this option only in a campus environment when operating two SHDSL
network interface modules (NIMs) back-to-back. In this setup, configure the
master NIM to CO and the slave NIM to customer premises equipment
(CPE).
cpe Use this option when interfacing directly with your service provider or when
acting as the slave NIM in a campus environment.
Default Values
The default for this command is cpe.
Command History
Usage Examples
The following example changes the operating mode of the SHDSL interface to CO:

(config-shdsl 1/1)#equipment-type co

ignore-error-duration <time>
Use the ignore-error-duration command to specify the amount of time that errors are ignored during line
training. Use the no form of this command to return to the default setting.
Syntax Description
<time> Specifies time in seconds. Valid range is 15 to 30 seconds.
Default Values
By default, ignore-error-duration is set to 15 seconds.
Command History
Usage Examples
The following example sets the amount of time errors are ignored during line training to 25 seconds:

(config-shdsl 1/1)#ignore-error-duration 25

inband-detection
Use the inband-detection command to enable inband loopback pattern detection on the single-pair
high-speed digital subscriber line (SHDSL) interface. Use the no form of this command to disable this
feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example disables inband loopback pattern detection:

(config-shdsl 1/1)#no inband-detection

inband-protocol
Use the inband-protocol command to designate the inband loopback pattern to send/detect on the
single-pair high-speed digital subscriber line (SHDSL) interface. Use the no form of this command to
inband-protocol pn127
inband-protocol v54
Syntax Description
pn127 Selects PN127 as the inband loopback pattern to send/detect.
v54 Selects V.54 as the inband loopback pattern to send/detect.
Default Values
By default, the inband loopback pattern is set to v54.
Command History
Functional Notes
Inband loopbacks are specific patterns that are sent in place of user data to trigger a loopback. Both
PN127 and V.54 are industry standard loopback patterns used to allow remote loopbacks.
Usage Examples
The following example sets the inband loopback pattern for pn127:

(config-shdsl 1/1)#inband-protocol pn127

line-mode
Use the line-mode command to select the controller line mode. Use the no form of this command to return
line-mode 2-wire
line-mode 4-wire
Syntax Description
2-wire Specifies two-wire mode.
4-wire Specifies four-wire mode for extended operation.
Default Values
By default, the digital subscriber line (DSL) operating mode is set to 2-wire.
Command History
Usage Examples
The following example sets the line mode to 4-wire:

(config-shdsl 1/1)#line-mode 4-wire

linerate <value>
Use the linerate command to define the line rate for the single-pair high-speed digital subscriber line
(SHDSL) interface (the value includes 8 kbps of framing overhead). This command is functional only in
CO operating mode (refer to equipment-type on page 1490). The first two selections listed in the command
line interface (CLI) (72 and 136 kbps) are not supported by the SHDSL network interface module (NIM)
(P/N 1200867L1). Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the line rate in kbps. Range is 200 to 2312 kbps in 64k
increments.
Default Values
By default, the line rate is set to 2056 kbps.
Command History
Usage Examples
The following example changes the line rate of the SHDSL interface to 264 kbps:

(config-shdsl 1/1)#linerate 264

loopback
Use the loopback command to initiate a loopback test on the single-pair high-speed digital subscriber line
(SHDSL) interface. Use the no form of this command to deactivate the loopback. Variations of this
command include:
loopback analog
loopback digital
loopback network
loopback remote
Syntax Description
analog Loops the circuit at the analog hybrid.
digital Loops the circuit at the framer.
network Loops data back towards the network.
remote Transmits a network loopback request. This command is functional only in
CO operating mode (refer to equipment-type on page 1490).
Default Values
Command History
Release 15.1 Command was expanded to include the analog and digital loopbacks.
Usage Examples
The following example initiates a loopback test on the SHDSL interface that will loop the data back toward
the network:

(config-shdsl 1/1)#loopback network

loopback remote inband

Use the loopback remote inband command to inject the selected inband loop-up pattern into the data
stream to cause a loopback at the far end. Use the no form of this command to inject a loop-down pattern
into the data stream to cause an existing inband loopback at the far end to cease.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example injects a loop-down pattern into the data stream, causing existing loopbacks at the
far end to stop:

(config-shdsl 1/1)#no loopback remote inband

outage-retrain
Use the outage-retrain command to cause the single-pair high-speed digital subscriber line (SHDSL)
interface to force the SHDSL retrain sequence (which takes the line down temporarily) if the interface
detects more than ten consecutive errored seconds. A retrain is forced in hopes that the newly retrained line
will achieve better performance than the previous training state. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example forces a retrain sequence on the SHDSL interface:

(config-shdsl 1/1)#outage-retrain

test-pattern
Use the test-pattern command to activate the built-in pattern generator and begin sending the selected test
pattern toward the network. This pattern generation can be used to verify a data path when used in
conjunction with an active loopback. Use the no form of this command to cease pattern generation.
test-pattern clear
test-pattern errors
test-pattern insert
test-pattern p215
Syntax Description
register.
Default Values
Command History
Usage Examples
The following example sends a p215 test pattern:

(config-shdsl 1/1)#test-pattern p215

Command Reference Guide T1 Interface Command Set
T1 INTERFACE COMMAND SET
To activate the T1 Interface Configuration mode, enter the interface t1 command at the Global
>enable
#configure terminal
(config-t1 1/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61

coding on page 1502
fdl on page 1503
lbo on page 1505
loopback commands begin on page 1506
remote-alarm rai on page 1509
snmp trap line-status on page 1511
snmp trap threshold-reached on page 1513
tdm-group <number> on page 1515

clock source
Use the clock source command to configure the source timing used for the interface. Use the no form of

clock source line
clock source system
clock source through
clock source through t1 <interface id>
Syntax Description
line Configures the unit to recover clocking from the T1 circuit.
system Configures the unit to provide clocking using the system clock.
through Configures the unit to recover clocking from the circuit connected to the
DSX-1 interface.
through t1 <interface id> Configures the unit to recover clocking from the alternate interface. Only
valid on T1 systems with multiple T1 interfaces and a single clock source.
Default Values
By default, the clock source is set to line.
Command History
Release 13.1 Command was expanded to include the system as a clocking source.
Functional Notes
When operating on a circuit that is providing timing, setting the clock source to line can avoid errors, such
as clock slip seconds (CSS).
Usage Examples
The following example configures the unit to recover clocking from the primary circuit:
(config-t1 1/1)#clock source line

coding
Use the coding command to configure the line coding for a T1 physical interface. This setting must match
the line coding supplied on the circuit by the service provider. Use the no form of this command to return
coding ami
coding b8zs
Syntax Description
b8zs Configures the line coding for bipolar eight zero substitution (B8ZS).
Default Values
By default, all T1 interfaces are configured with b8zs line coding.
Command History
Functional Notes
The line coding configured in the unit must match the line coding of the T1 circuit. A mismatch will result in
Usage Examples
The following example configures the T1 interface for ami line coding:
(config-t1 1/1)#coding ami

fdl
Use the fdl command to configure the format for the facility data link (FDL) channel on the T1 circuit.
FDL channels are only available on point-to-point circuits. Use the no form of this command to return to
fdl ansi
fdl att
fdl none
Syntax Description
ansi Configures the FDL for ANSI T1.403 standard.
att Configures the FDL for AT&T TR 54016 standard.
none Disables FDL on this circuit.
Default Values
By default, the FDL is configured for ansi.
Command History
Functional Notes
T1 circuits using extended superframe (ESF) framing format (specified using the framing command)
reserve 12 bits as a data link communication channel, referred to as the FDL, between the equipment on
either end of the circuit. The FDL allows the transmission of trouble flags, such as the Yellow Alarm signal.
Refer to framing on page 1504 for related information.
Usage Examples
The following example disables the FDL channel for the T1 circuit:
(config-t1 1/1)#fdl none

framing
Use the framing command to configure the framing format for the T1 interface. This parameter should
match the framing format supplied by your network provider. Use the no form of this command to return
to the default value. Variations of this command include:
framing d4
framing esf
Syntax Description
d4 Specifies D4 superframe (SF) format.
esf Specifies extended superframe (ESF) format.
Default Values
By default, the framing format is set to esf.
Command History
Functional Notes
A frame is comprised of a single byte from each of the T1’s timeslots; there are 24 timeslots on a single T1
circuit. Framing bits are used to separate the frames and indicate the order of information arriving at the
receiving equipment. D4 and ESF are two methods of collecting and organizing frames over the circuit.
Usage Examples
The following example configures the T1 interface for D4 framing:
(config-t1 1/1)#framing d4

lbo
Use the lbo command to configure the line build out (LBO) for the T1 interface. Use the no form of this
lbo short <value>

lbo long <value>
Syntax Description
long <value> Configures the LBO (in dB) for T1 interfaces with cable lengths greater than
655 feet. Choose from -22.5, -15, -7.5, and 0 dB.
short <value> Configures the LBO (in feet) for T1 interfaces with cable lengths less than
655 feet. Range is 0 to 655 feet.
Default Values
By default, the build out is set to 0 dB.
Command History
Functional Notes
LBO is artificial attenuation of a T1 output signal to simulate a degraded signal. This is useful to avoid
overdriving a receiver’s circuits. The shorter the distance between T1 equipment (measured in cable
length), the greater the attenuation value. For example, two units in close proximity should be configured
for the maximum attenuation (-22.5 dB).
Usage Examples
The following example configures the T1 interface LBO for -22.5 dB:
(config-t1 1/1)#lbo -22.5

loopback network

Syntax Description
line Initiates a metallic loopback of the physical T1 network interface.
payload Initiates a loopback of the T1 framer (CSU portion) of the T1 network
interface.
Default Values
Command History
Functional Notes
NI CSU
DS1
Payload Loopback
Line Loopback
Usage Examples
The following example initiates a payload loopback of the T1 interface:

loopback remote line

Use the loopback remote line command to send a loopback code to the remote unit to initiate a line
loopback. Use the no form of this command to send a loopdown code to the remote unit to deactivate the
loopback. Variations of this command include:
loopback remote line fdl

loopback remote line inband
Syntax Description
fdl Uses the facility data link (FDL) to initiate a full 1.544 Mbps physical
(metallic) loopback of the signal received by the remote unit from the
network.
inband Uses the inband channel to initiate a full 1.544 Mbps physical (metallic)
loopback of the signal received by the remote unit from the network.
Default Values
Command History
Functional Notes
NI CSU
DS1
Payload Loopback
Line Loopback
Usage Examples
The following example initiates a remote line loopback using the FDL:
(config-t1 1/1)#loopback remote line fdl

loopback remote payload

Use the loopback remote payload command to send a loopback code to the remote unit to initiate a
payload loopback. A payload loopback is a 1.536 Mbps loopback of the payload data received from the
network maintaining bit-sequence integrity for the information bits by synchronizing (regenerating) the
timing. Use the no form of this command to send a loopdown code to the remote unit to deactivate the
loopback.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
NI CSU
DS1
Payload Loopback
Line Loopback
Usage Examples
The following example initiates a remote payload loopback:
(config-t1 1/1)#loopback remote payload

remote-alarm rai
The remote-alarm rai command selects the alarm signaling type to be sent when a loss of frame is
detected on the T1 receive signal. Use the no form of this command to disable all transmitted alarms.
Syntax Description
rai Specifies sending a remote alarm indication (RAI) in response to a loss of
frame. Also, prevents a received RAI from causing a change in interface
operational status.
Default Values
The default for this command is rai.
Command History
Release 7.1 Command was expanded to include the T1 interface.
Usage Examples
The following example enables transmission of RAI in response to a loss of frame:
(config-t1 1/1)#remote-alarm rai

remote-loopback
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables remote loopbacks on the T1 interface:

snmp trap line-status

Use the snmp trap line-status command to control the Simple Network Management Protocol (SNMP)
variable dsx1LineStatusChangeTrapEnable (RFC 2495) to enable (or disable) the interface to send SNMP
traps when there is an interface status change. Use the no form of this command to disable this trap.
Syntax Description
No subcommands.
Default Values
By default, the dsx1LineStatusChangeTrapEnable object identifier (OID) is set to enabled for all interfaces
Command History
Functional Notes
The snmp trap line-status command is used to control the RFC 2495 dsx1LineStatusChangeTrapEnable
OID (OID number 1.3.6.1.2.1.10.18.6.1.17.0).
Usage Examples
The following example disables the line-status trap on the T1 interface:
(config-t1 1/1)#no snmp trap line-status


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the T1 interface:

snmp trap threshold-reached

Use the snmp trap threshold-reached command to control the Simple Network Management Protocol
(SNMP) variable adGenAOSDs1ThresholdReached (adGenAOSDs1-Ext MIB) to enable the interface to
send SNMP traps when a DS1 performance counter threshold is reached. Use the no form of this command
to disable this trap.
Syntax Description
No subcommands.
Default Values
By default, the adGenAOSDs1ThresholdReached object identifier (OID) is enabled for all interfaces.
Command History
Usage Examples
The following example disables SNMP threshold reached trap on the T1 interface:
(config-t1 1/1)#no snmp trap threshold-reached

system-timing
Use the system-timing command to configure the Rx clock as the primary or secondary timing source for
the system. Use the no form of this command to disable this feature.Variations of this command include:
system-timing primary
system-timing secondary
Syntax Description
primary Specifies the Rx clock as the primary timing source.
secondary Specifies the Rx clock as the secondary timing source.
Default Values
Command History
Usage Examples
The following example configures the T1 interface to provide its Rx clock as the primary timing source for
the system:
(config-t1 1/1)#system timing primary

tdm-group <number>
Use the tdm-group command to create a group of contiguous level zero digital signals (DS0s) on this
interface to be used during the cross-connect process. Refer to cross-connect on page 47 for related
information. Use the no form of this command to remove configured time division multiplexing (TDM)
groups. Variations of this command include:
tdm-group <number> timeslots <value>

tdm-group <number> timeslots <value> speed [56 | 64]
Changing tdm-group settings could result in service interruption.
Syntax Description
<number> Identifies the created TDM group. Valid range is 1 to 255.
timeslots <value> Specifies the channels to be used in the TDM group. Valid range is 1 to 31.
The timeslot value can be entered as a single number representing one of
the 31 E1 channel timeslots or as a contiguous group of channels. (For
example, 1-10 specifies the first 10 channels of the E1.)
speed [56 | 64] Optional. Specifies the individual DS0 rate on the T1 interface to be
64 kbps. Only the T1 + DSX-1 network interface module (NIM) supports the
56 kbps DS0 rate. The default speed is 64 kbps.
Default Values
By default, there are no configured TDM groups.
Command History
Usage Examples
The following example creates a TDM group (labeled 5) of 10 DS0s at 64 kbps each:

test-pattern
include:
test-pattern clear
test-pattern errors
test-pattern insert
test-pattern ones
test-pattern p215
test-pattern p220
test-pattern p511
test-pattern qrss
test-pattern zeros
Syntax Description
errors Displays the test pattern errored seconds.
register.
register.
p511 Generates a test pattern of repeating ones and zeros.
qrss Generates a test pattern of random ones and zeros.
Default Values
Command History
Usage Examples
(config-t1 1/1)#test-pattern ones

T3 INTERFACE COMMAND SET
To activate the T3 Interface Configuration mode, enter the interface t3 command at the Global
>enable
#configure terminal
(config-t3 1/1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61

coding b3zs on page 1519
line-length on page 1521
loopback remote on page 1523

clock source
Use the clock source command to configure the source timing used for the interface. The clock specified
using the clock source command is also the system master clock. Use the no form of this command to
clock source local

clock source loop
Syntax Description
local Configures the unit to provide clocking using the internal oscillator.
loop Configures the unit to recover clocking from the T3 circuit.
Default Values
By default, all T3 interfaces are configured with loop as the clock source.
Command History
Usage Examples
The following example configures the unit to recover clocking from the circuit:
(config-t3 1/1)#clock source loop

coding b3zs
Use the coding b3zs command to configure the line coding for a T3 physical interface. This setting must
match the line coding supplied on the circuit by the service provider.
Syntax Description
b3zs Configures the line coding for bipolar three zero substitution (B3ZS).
Default Values
By default, all T3 interfaces are configured with b3zs line coding.
Command History
Functional Notes
The line coding configured in the unit must match the line coding of the T3 circuit. A mismatch will result in
Usage Examples
The following example configures the T1 interface for b3zs line coding:
(config-t3 1/1)#coding b3zs

framing
Use the framing command to configure the network framing format for a T3 physical interface. Use the no
form of this command to return to the default value. Variations of this command include:
framing cbit
framing m13
Syntax Description
cbit Configures the interface for C-bit parity framing.
m13 Configures the interface for M13 framing.
Default Values
By default, all T3 interfaces are configured for cbit parity framing.
Command History
Functional Notes
M13 is an asynchronous framing format that uses all 21 DS3 M-Frame C-bits for bit stuffing indicators.
End-to-end path parity and datalink capabilities are not provided by the standard M13 format. C-bit parity
framing differs from M13 by allowing monitoring of the data path (end-to-end) and supporting out-of-band
(OOB) data links.
Usage Examples
The following example configures the T3 interface for m13 framing:
(config-t3 1/1)#framing m13

line-length
Use the line-length command to configure the line length for a T3 physical interface. Use the no form of
line-length long
line-length short
Syntax Description
long Configures the line length for a distance of 225 to 450 feet of cable.
short Configures the line length for a distance of 0 to 225 feet of cable.
Default Values
By default, all T3 interfaces are configured for a short line length.
Command History
Usage Examples
The following example configures the T3 interface for long line length:
(config-t3 1/1)#line-length long

loopback network
Use the loopback network command to initiate a local T3 loopback on the interface toward the network.
Use the no form of this command to deactivate the loopback. Variations of this command include:

Syntax Description
line Initiates a loopback of the physical T3 network interface; that is, data
received on the T3 is transmitted back out on the T3.
payload Initiates a loopback of the T3 framer (TSU portion) of the T3 network
interface.
Default Values
Command History
Usage Examples
The following example initiates a payload loopback of the T3 interface:

loopback remote
Use the loopback remote command to initiate a loopback test on the T3 interface that sends a remote
loopback code out the T3 circuit to loop up the far end. This command only applies when C-bit framing is
used on the circuit. Use the no form of this command to deactivate the loopback. Variations of this
command include:
loopback remote line

loopback remote payload
Syntax Description
line Initiates a line loopback.
payload Initiates a payload loopback.
Default Values
Command History
Usage Examples
This example initiates a remote loopback on the T3 interface:
(config-t3 1/1)#loopback remote

remote-loopback
Use the remote-loopback command to configure the T3 interface to be looped from the far end (remote
device, Telco, etc.). Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
This example enables remote loopbacks on the T3 interface:


Syntax Description
No subcommands.
Default Values
Command History
interface.
Release 9.1 Command was expanded to the high link data link control (HDLC) interface.
Usage Examples
The following example disables the link-status trap on the T3 interface:

test-pattern
Use the test-pattern command to activate the built-in pattern generator and begin sending the selected test
pattern toward the network. This pattern generation can verify a data path when used in conjunction with
an active loopback. Use the no form of this command to cease pattern generation. Variations of this
command include:
test-pattern clear
test-pattern errors
test-pattern insert
test-pattern ones
test-pattern p215
test-pattern p223
test-pattern zeros
Syntax Description
register.
register.
Default Values
Command History
Usage Examples
The following example enables a p215 test pattern:
(config-t3 1/1)#test-pattern p215

VIRTUAL INTERFACE COMMAND SETS

• ATM Interface Command Set on page 1528

• ATM Subinterface Command Set on page 1532
• BVI Interface Command Set on page 1618
• Demand Interface Command Set on page 1656
• Frame Relay Interface Command Set on page 1730
• Frame Relay Subinterface Command Set on page 1751
• HDLC Interface Command Set on page 1834
• Loopback Interface Command Set on page 1910
• Port Channel Interface Command Set on page 1955
• PPP Interface Command Set on page 1979
• Tunnel Interface Command Set on page 2072
• VLAN Command Set on page 2148
• VLAN Database Command Set on page 2153
• VLAN Interface Command Set on page 2162

Command Reference Guide ATM Interface Command Set
ATM INTERFACE COMMAND SET
To create a virtual asynchronous transfer mode (ATM) interface and/or activate the ATM Interface
Configuration mode, enter the interface atm command at the Global Configuration mode prompt. For
example:
>enable
#configure terminal
(config)#interface atm 1
(config-atm 1)#
By default, ATM interfaces are created as point-to-point links. This default setting cannot be altered. The
following command creates the exact same interface as that mentioned above:
>enable
#configure terminal
(config)#interface atm 1 point-to-point
(config-atm 1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61


Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the asynchronous transfer mode (ATM)
interface:
(config-atm 1)#rtp quality-monitoring

snmp trap
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP on the ATM interface:
(config-atm 1)#snmp trap


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the ATM interface:
(config-atm 1)#no snmp trap link-status

Command Reference Guide ATM Subinterface Command Set
ATM SUBINTERFACE COMMAND SET
To create a virtual asynchronous transfer mode (ATM) subinterface and/or activate the ATM Subinterface
Configuration mode, enter the interface atm command (and specify a subinterface) at the Global
>enable
#configure terminal
(config-atm 1.1)#
By default, ATM subinterfaces are created as point-to-point links. This default setting cannot be altered.
The following command creates the exact same interface as that mentioned above:
>enable
#configure terminal
(config)#interface atm 1.1 point-to-point
(config-atm 1.1)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61

atm routed-bridged ip on page 1535
bridge-group <value> on page 1537
cos on page 1538
dial-backup commands begin on page 1542
encapsulation on page 1561
fair-queue on page 1562
hold-queue <value> out on page 1563


oam retry on page 1606
oam-pvc managed on page 1607
pvc <VPI/VCI> on page 1608
commands begin on page 1617

Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
asynchronous transfer mode (ATM) interface 1.1:

Associate the access policy with the ATM interface 1.1:

(config-atm 1.1)#access-policy PRIVATE

atm routed-bridged ip
Use the atm routed-bridged ip command to enable IP routed bridge encapsulation (RBE) on an interface.
Use the no form of this command to disable RBE operation.
Syntax Description
No subcommands.
Default Values
By default, RBE is disabled.
Command History
Usage Examples
The following example enables RBE:

(config-atm 1.1)#atm routed-bridged ip

bandwidth <value>
Syntax Description
Default Values
To view the default values, use the show interfaces command.
Command History
Release 8.1 Asynchronous transfer mode (ATM) subinterface was added.
Functional Notes
Usage Examples
The following example sets bandwidth of the ATM subinterface to 10 Mbps:

(config-atm 1.1)#bandwidth 10000

bridge-group <value>
Syntax Description
<value> Specifies the bridge group (by number) to which to assign this interface.
Range is 1 to 255.
Default Values
Command History
Functional Notes
be bridged (Ethernet to T1, Ethernet to Frame Relay subinterface).
Usage Examples
The following example assigns the ATM subinterface labeled 1.1 to bridge group 1:

(config-atm 1.1)#bridge-group 1

cos
Use the cos command to define class of service (CoS) settings on an asynchronous transfer mode (ATM)
subinterface. Use the no form of this command to remove the parameters. Variations of this command
include:
cos ubr
cos vbr-nrt <pcr> <scr> <mbs>
cos vbr-rt <pcr> <scr> <mbs>
Syntax Description
ubr Indicates unspecified bit rate (UBR) for the CoS.
vbr-nrt Specifies the variable bit rate (VBR) nonreal time (NRT) peak cell rate
(PCR), sustained cell rate (SCR), and maximum burst size (MBS).
vbr-rt Specifies the variable bit rate real time (RT) peak cell rate, sustained cell
rate, and maximum burst size.
<pcr> Indicates the peak cell rate or maximum number of cells per second the
connection can transfer into the network. Valid range is 32 to 50000 kbps.
<scr> Indicates the sustained cell rate or average number of cells per second that
the connection can transfer into the network. Valid range is 32 to
50000 kbps.
<mbs> Indicates the maximum burst size of cells allowed on the connection. Valid
Default Values
The default setting for this feature is cos ubr.
Command History
Usage Examples
The following example defines variable bit rate real time on the ATM subinterface 1.2:

(config-atm 1.2)#no shutdown
(config-atm 1.2)#pvc 1/101
(config-atm 1.2)#ip address 10.23.107.35 255.255.255.240
(config-atm 1.2)#COS VBR-rt 2304 1024 3

The following example defines unspecified bit rate on the ATM subinterface 1.3:

(config-atm 1.3)#no shutdown
(config-atm 1.3)#ip address 10.23.107.51 255.255.255.240
(config-atm 1.3)#COS UBR

crypto map <name>

Syntax Description
Default Values
Command History
Functional Notes


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the ATM subinterface:

(config-atm 1.1)#crypto map MyMap

dial-backup auto-backup
Use the dial-backup auto-backup command to configure the subinterface to automatically attempt a dial
backup upon failure. Use the no form of this command to disable this feature. For more detailed
information on dial-backup functionality, refer to the Functional Notes and Technology Review sections of
the command dial-backup call-mode on page 1545.
Syntax Description
No subcommands.
Default Values
By default, all backup endpoints will automatically attempt dial backup upon a failure.
Command History
Usage Examples
The following example enables automatic dial backup on the endpoint:

(config-atm 1.1)#dial-backup auto-backup

dial-backup auto-restore
Use the dial-backup auto-restore command to configure the subinterface to automatically discontinue
dial backup when all network conditions are operational. Use the no form of this command to disable the
auto-restore feature. For more detailed information on dial-backup functionality, refer to the Functional
Notes and Technology Review sections of the command dial-backup call-mode on page 1545.
Syntax Description
No subcommands.
Default Values
By default, all backup endpoints will automatically restore the primary connection when the failure
condition clears.
Command History
Usage Examples
The following example configures AOS to automatically restore the primary connection when the failure
condition clears:

(config-atm 1.1)#dial-backup auto-restore

dial-backup backup-delay <value>

Use the dial-backup backup-delay command to configure the amount of time the router will wait after the
failure condition is recognized before attempting to backup the link. Use the no form of this command to
return to the default value. For more detailed information on dial-backup functionality, refer to the
Functional Notes and Technology Review sections of the command dial-backup call-mode on page 1545.
Syntax Description
<value> Specifies the delay period (in seconds) a failure must be active before AOS
will enter backup operation on the interface. Valid range is 10 to
86400 seconds.
Default Values
By default, the dial-backup backup-delay period is set to 10 seconds.
Command History
Usage Examples
The following example configures AOS to wait 60 seconds (on an endpoint with an active alarm condition)
before attempting dial-backup operation:

(config-atm 1.1)#dial-backup backup-delay 60

dial-backup call-mode
Use the dial-backup call-mode command to specify whether the configured backup interface answers or
originates (or a combination of both) backup calls. Use the no form of this command to return to the
default value. Variations of this command include:
dial-backup call-mode answer

dial-backup call-mode answer-always
dial-backup call-mode originate
dial-backup call-mode originate-answer
dial-backup call-mode originate-answer-always
Syntax Description
answer Answers and backs up primary link on failure.
answer-always Answers and backs up regardless of primary link state.
originate Originates backup call on primary link failure.
originate-answer Originates or answers call on primary link failure.
originate-answer-always Originates on failure; answers and backs up always.
Default Values
By default, the dial-backup call-mode is set to originate-answer.
Command History
Functional Notes
The majority of the configuration for AOS dial-backup implementation is configured via the dial-backup
Point-to-Point Protocol (PPP) interface configuration commands. However, the numbers dialed are
configured in the primary interface. Full sample configurations follow:
Sample configuration for remote router (dialing out)
hostname “Remote3200”
enable password adtran
!
interface eth 0/1
ip address 192.168.1.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1

coding b8zs
framing esf
clock source line
tdm-group 1 timeslots 1-24
no shutdown
!
interface fr 1 point-to-point
frame-relay lmi-type ansi
no shutdown
cross-connect 1 t1 1/1 1 fr 1
!
interface fr 1.16 point-to-point
frame-relay interface-dlci 16
ip address 10.1.1.2 255.255.255.252
dial-backup number 5551111 analog ppp1
no shutdown
!
interface ppp 1
ip address 172.22.56.1 255.255.255.252
ppp authentication chap
username remoter outer password remoteness
ppp chap hostname local router
ppp chap password adtran
no shutdown
!
ip route 192.168.2.0 255.255.255.0 172.22.56.2 255.255.255.252
!
line telnet 0 4
password password
Sample configuration for central router (dialing in)
hostname “Central3200”
!
interface eth 0/1
ip address 192.168.100.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1
coding b8zs
framing esf
clock source line


no shutdown
!
no shutdown
!
ip address 10.1.1.1 255.255.255.252
dial-backup number 555-8888 analog ppp 1
!
interface ppp 1
ip address 172.22.56.2 255.255.255.252
username local router password adtran
ppp chap hostname remote router
ppp chap password remoteness
no shutdown
!
ip route 192.168.1.0 255.255.255.0 172.22.56.1 255.255.255.252
line telnet 0 4
password password
Usage Examples
The following example configures AOS to generate backup calls for this endpoint using an analog modem
interface (to phone number 555 1111), but never answer calls and specifies ppp 2 as the backup interface:

(config-atm 1.1)#dial-backup call-mode originate
(config-atm 1.1)#dial-backup number 555 1111 analog ppp 2

Technology Review
This technology review provides information regarding specific dial-backup router behavior (i.e., when the
router will perform dial backup, where in the configuration AOS accesses specific routing information, etc.):
Dialing Out
1. AOS determines to place an outbound call when either the Layer 1 or Layer 2 has a failure.
2. When placing outbound calls, AOS matches the number dialed to a PPP interface. This is accomplished
with an addition to the dial-backup number command (refer to dial-backup number on page 1552).
3. When placing the call, AOS uses the configuration of the related PPP interface for authentication and IP
negotiation.
4. If the call fails to connect on the first number dialed, AOS places a call to the second number (if a
second number is configured). The second number to be dialed references a separate PPP interface.
Dialing In
1. AOS receives an inbound call on a physical interface.
2. Caller ID is used to match the dial-backup number command to the configured PPP interface.
3. If a match is found, the call connects and AOS pulls down the primary connection if it is not already in a
down state.
4. If no match is found from caller ID, the call is terminated.

dial-backup connect-timeout <value>

Use the dial-backup connect-timeout command to specify the number of seconds to wait for a connection
after a call is attempted before trying to call again or dialing a different number. It is recommended this
number be greater than 60. Use the no form of this command to return to the default setting. For more
detailed information on dial-backup functionality, refer to the Functional Notes and Technology Review
sections of the command dial-backup call-mode on page 1545.
Syntax Description
<value> Specifies the amount of time (in seconds) that the router will wait for a
connection before attempting another call. Valid range is 10 to 300 seconds.
Default Values
By default, the dial-backup connect-timeout period is set to 60 seconds.
Command History
Usage Examples
The following example configures AOS to wait 120 seconds before retrying a failed dial-backup call:

(config-atm 1.1)#dial-backup connect-timeout 120

dial-backup force
Use the dial-backup force command to manually override the automatic dial-backup feature. This can be
used to force a link into backup to allow maintenance to be performed on the primary link without
disrupting data. Use the no form of this command to return to the normal dial-backup operation state. For
more detailed information on dial-backup functionality, refer to the Functional Notes and Technology
Review sections of the command dial-backup call-mode on page 1545. Variations of this command
include:
dial-backup force backup

dial-backup force primary
Syntax Description
backup Forces backup regardless of primary link state.
primary Forces primary link regardless of its state.
Default Values
Command History
Usage Examples
The following example configures AOS to force this endpoint into dial backup:

(config-atm 1.1)#dial-backup force backup

dial-backup maximum-retry <value>

Use the dial-backup maximum-retry command to select the number of calls the router will make when
attempting to backup a link. Use the no form of this command to return to the default state. For more
Syntax Description
<value> Selects the number of call retry attempts that will be made after a link
failure. Valid range is 0 to 15 attempts.
Setting this value to 0 will allow unlimited retries during the time the network
is failed.
Default Values
By default, the dial-backup maximum-retry period is set to 0 attempts.
Command History
Usage Examples
The following example configures AOS to retry a dial-backup call 4 times before considering backup
operation not available:

(config-atm 1.1)#dial-backup maximum-retry 4

dial-backup number
Use the dial-backup number command to configure the phone number and the call type the router will
dial upon network failure. Multiple entries can be made for an interface to allow alternate sites to be dialed.
Use the no form of this command to disable this feature. For more detailed information on dial-backup
functionality, refer to the Functional Notes and Technology Review sections of the command dial-backup
call-mode on page 1545. Variations of this command include:
dial-backup number <number> analog ppp <interface>

dial-backup number <number> digital-56k <isdn min chan> <isdn max chan> ppp <interface>
Syntax Description
<number> Specifies the phone numbers to call when the backup is initiated.
analog Indicates the number connects to an analog modem.
digital-56k Indicates the number belongs to a digital 56 kbps per DS0 connection.
<isdn min chan> Specifies the minimum number of DS0s required for a digital 56 or 64 kbps
connection. Range is 1 to 24 DS0s.
<isdn max chan> Specifies the maximum number of DS0s desired for a digital 56 or 64 kbps
ppp <interface> Specifies the Point-to-Point Protocol (PPP) interface to use as the backup for
this interface (for example, ppp 1).
Default Values
By default, there are no configured dial-backup numbers.
Command History
Release 17.2 Command was expanded to include the cellular connections.
Release 17.3 Cellular connections were removed from this command.
Usage Examples
The following example configures AOS to dial 704-555-1212 (digital 64 kbps connection) to initiate
dial-backup operation for this endpoint using the configured ppp 1 backup interface:

(config-atm 1.1)#dial-backup number 7045551212 digital-64k 1 1 ppp 1

dial-backup priority <value>

Use the dial-backup priority command to select the backup priority for this interface. This allows the user
to establish the highest priority backup link and ensure that link will override backups attempted by lower
priority links. Use the no form of this command to return to the default value. For more detailed
Syntax Description
<value> Sets the relative priority to this link. Valid range is 0 to 100. A value of 100
designates the highest priority.
Default Values
By default, the dial-backup priority is set to 50.
Command History
Usage Examples
The following example assigns the highest priority to this endpoint:

(config-atm 1.1)#dial-backup priority 100

dial-backup randomize-timers
Use the dial-backup randomize-timers command to randomize the call timers to minimize potential
contention for resources. Use the no form of this command to return to the default value. For more detailed
Syntax Description
No subcommands.
Default Values
By default, AOS does not randomize the dial-backup call timers.
Command History
Usage Examples
The following example configures AOS to randomize the dial-backup timers associated with this endpoint:

(config-atm 1.1)#dial-backup randomize-timers

dial-backup redial-delay <value>

Use the dial-backup redial-delay command to configure the delay after an unsuccessful call until the call
will be re-tried. Use the no form of this command to return to the default setting. For more detailed
Syntax Description
<value> Specifies the delay (in seconds) between attempting to redial a failed
backup attempt. Valid range is 10 to 3600 seconds.
Default Values
By default, the dial-backup redial-delay period is set to 10 seconds.
Command History
Usage Examples
The following example configures a redial delay of 25 seconds on this endpoint:

(config-atm 1.1)#dial-backup redial-delay 25

dial-backup restore-delay <value>

Use the dial-backup restore-delay command to configure the amount of time the router will wait after the
network is restored before disconnecting the backup link and reverting to the primary. This setting is used
to prevent disconnecting the backup link if the primary link is bouncing in and out of alarm. Use the no
form of this command to return to the default setting. For more detailed information on dial-backup
call-mode on page 1545.
Syntax Description
<value> Specifies the number of seconds AOS will wait (after a primary link is
restored) before disconnecting dial-backup operation. Range is 10 to
86400 seconds.
Default Values
By default, the dial-backup restore-delay period is set to 10 seconds.
Command History
Usage Examples
The following example configures AOS to wait 30 seconds before disconnecting dial-backup operation and
restoring the primary connection for this endpoint:

(config-atm 1.1)#dial-backup restore-delay 30

dial-backup schedule
Use the dial-backup schedule command to set the time of day that backup will be enabled. Use this
command if backup is desired only during normal business hours and on specific days of the week. Use the
no form of this command to disable dial backup (as specified). For more detailed information on
dial-backup functionality, refer to the Functional Notes and Technology Review sections of the command
dial-backup call-mode on page 1545. Variations of this command include:
dial-backup schedule day <name>

dial-backup schedule enable-time <value>
dial-backup schedule disable-time <value>
Syntax Description
day <name> Sets the days to allow backup. Valid range is Monday through Sunday.
enable-time <value> Sets the time of day to enable backup. Time is entered in a 24-hour format
(00:00).
disable-time <value> Sets the time of day to disable backup. Time is entered in a 24-hour format
(00:00).
Default Values
By default, dial backup is enabled for all days and times if the dial-backup auto-backup command has
been issued and the dial-backup schedule has not been entered.
Command History
Usage Examples
The following example enables dial backup Monday through Friday 8:00 a.m. to 7:00 p.m.:

(config-atm 1.1)#dial-backup schedule enable-time 08:00
(config-atm 1.1)#dial-backup schedule disable-time 19:00
(config-atm 1.1)#no dial-backup schedule day Saturday
(config-atm 1.1)#no dial-backup schedule day Sunday

dial-backup shutdown
Use the dial-backup shutdown command to deactivate all dial-backup functionality in the unit.
Dial-backup configuration parameters are kept intact, but the unit will not initiate (or respond) to
dial-backup sequences in the event of a network outage. Use the no form of this command to reactivate the
dial-backup interface. For more detailed information on dial-backup functionality, refer to the Functional
Syntax Description
No subcommands.
Default Values
By default, all AOS interfaces are disabled.
Command History
Usage Examples
The following example deactivates the configured dial-backup interface:

(config-atm 1.1)#dial-backup shutdown

dynamic-dns

Syntax Description
<username> Specifies the user name.
<password> Specifies the password.
Default Values
Command History
Functional Notes

Usage Examples
The following example sets the Dynamic DNS to dyndns-custom with host name host, user name user,
and password pass:

(config-atm 1.1)#dynamic-dns dyndns-custom host user pass

encapsulation
Use the encapsulation command to configure the encapsulation type for the ATM Adaptation Layer
(AAL) of the Asynchronous Transfer Mode (ATM) Protocol Reference Model. Use the no form of this
encapsulation aal5mux ip
encapsulation aal5mux ppp
encapsulation aal5snap
Syntax Description
aal5mux ip Specifies encapsulation type for multiplexed virtual circuits using the IP
protocol.
aal5mux ppp Specifies encapsulation type for multiplexed virtual circuits using the
Point-to-Point Protocol (PPP).
aal5snap Specifies encapsulation type that supports LLC/SNAP protocols.
Default Values
By default, the encapsulation type is aal5snap.
Command History
Functional Notes
For PPP and Point-to-Point Protocol over Ethernet (PPoE), the encapsulation type can be aal5snap or
aal5mux ppp. For IP with no bridging, the encapsulation type can be aal5snap or aal5mux ip. For IP with
bridging, the encapsulation type can only be aal5snap. For bridging, the encapsulation type can only be
aal5snap.
Usage Examples
The following example sets the encapsulation type to aal5snap:

(config-atm 1.1)#encapsulation aal5snap

fair-queue
Use the fair-queue command to enable weighted fair queuing (WFQ) on an interface. Use the no form of
this command to disable WFQ and enable first in, first out (FIFO) queueing for an interface. Variations of
fair-queue
fair-queue <value>
WFQ must be enabled on an interface to use priority queuing. By default, WFQ is enabled
for all interfaces with maximum bandwidth speeds equivalent to T1/E1 and below.
Syntax Description
<value> Optional. Value that specifies the maximum number of packets that can be
present in each conversation subqueue. Packets received for a
conversation after this limit is reached are discarded. Range is 16 to
512 packets.
Default Values
By default, fair-queue is enabled with a threshold of 64 packets.
Command History
Usage Examples
The following example enables WFQ on the interface with a threshold set at 100 packets:

(config-atm 1.1)#fair-queue 100

hold-queue <value> out

Use the hold-queue out command to change the overall size of an interface's wide area network (WAN)
output queue. Use the no form of this command to return to the default setting.
Syntax Description
<value> The total number of packets the output queue can contain before packets
are dropped. Range is 16 to 1000 packets.
Default Values
The default queue size for weighted fair queuing (WFQ) is 400. The default queue size for Point-to-Point
Protocol (PPP) first in, first out (FIFO) and Frame Relay round-robin is 200.
Command History
Usage Examples
The following example sets the overall output queue size to 700:

(config-atm 1.1)#hold-queue 700 out

Syntax Description
<name> Specifies the assigned IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the router to only allow Telnet traffic into the ATM subinterface:

(config-ext-nacl)#interface atm 1.1
(config-atm 1.1)#ip access-group TelnetOnly in

ip address dhcp

Syntax Description
from a DHCP server.
media type).
media types.
delimiters).
obtained via DHCP.

Default Values
formula:
8 7 6 5 4 3 2 1
address:
16 / 0x0401
50 / 0x0C21
60 / 0x0CC1
70 / 0x1061
80 / 0x1401

Command History
subinterface.
Functional Notes
Usage Examples
The following example enables DHCP operation on the ATM subinterface 1.1:

(config-atm 1.1)#ip address dhcp
The following example enables DHCP operation on the ATM subinterface 1.1 utilizing host name adtran
and does not allow obtaining a default route, domain name, or name servers. It also sets the administrative
distance as 5:

(config-atm 1.1)#ip address dhcp hostname “adtran” no-default-route no-domain-name
no-nameservers 5


Use the ip address command to define an IP address on the specified interface. Use the optional
secondary keyword to define a secondary IP address. Use the no form of this command to remove a
configured IP address. Variations of this command include:

Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
The following example configures a secondary IP address of 192.22.72.101 255.255.255.252:

(config-atm 1.1)#ip address 192.22.72.101 255.255.255.252 secondary


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:

(config-atm 1.1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

ip dhcp
Use the ip dhcp command to release or renew the Dynamic Host Configuration Protocol (DHCP) IP
address. This command is only applicable when using DHCP for IP address assignment. Variations of this
command include:
ip dhcp release
ip dhcp renew
Syntax Description
release Releases DHCP IP address.
renew Renews DHCP IP address.
Default Values
Command History
Usage Examples
The following example releases the IP DHCP address for the ATM subinterface 1.1:

(config-atm 1.1)#ip dhcp release

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface atm 1.1:

(config-atm 1.1)#ip directed-broadcast

ip ffe
ip ffe
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
50:

(config-atm 1.1)#ip ffe max-entries 50

Technology Review
processing layers.

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on an atm subinterface to monitor incoming traffic

(config-atm 1.1)#ip flow ingress myacl


packets.
The ip helper command must be used in conjunction with the ip forward-protocol

command to configure AOS to forward UDP broadcast packets. Refer to ip
forward-protocol udp <value> on page 864 for more information.
Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes
To implement the helper address feature, assign an address(es) (specifying the device that needs to

Usage Examples
IP address 192.33.5.99:

(config-atm 1.1)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
querier’s last query before it takes over as querier (IGMP Version 2).
Range is 60 to 300 seconds. Use the no form of this command to return
to the default setting.
IGMP Version 2, the DR is the router with the lowest IP address on the
<seconds> interface in queries when using IGMP Version 2. Hosts are allowed a
random time within this period to respond, reducing response bursts.

Syntax Description
Default Values
ip igmp immediate-leave No default
ip igmp last-member-query-interval 1000 milliseconds
ip igmp querier-timeout 2x the query-interval value
ip igmp query-interval 60 seconds
ip igmp query-max-response-time 10 seconds
ip igmp static-group No default
ip igmp version Version 1
Command History
Usage Examples

(config-atm 1.1)#ip igmp last-member-query-interval 200

Management Protocol (IGMP) (router mode) on an interface and place it in multicast stub downstream
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples

(config-atm 1.1)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
the ip igmp static-group <address> command to receive multicast traffic without host-initiated Internet
Usage Examples
(config)#interface atm1.1
(config-atm 1.1)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
the interface becomes the active upstream interface, enabling the router to perform as an IGMP proxy.
Refer to ip mcast-stub helper-address <ip address> on page 883, ip mcast-stub downstream on page
1580, and ip mcast-stub upstream on page 1583 for more information.
Usage Examples

(config-atm 1.1)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples

(config-atm 1.1)#ip mcast-stub upstream

ip ospf

Syntax Description
1 to 65535.
determine that the device is down. Range is 0 to
32767 seconds.
0 to 255.
32767 seconds.
Default Values
Protocol (PPP)

Command History
Usage Examples
The following example sets the maximum number of seconds allowed between hello packets to 25000:

(config-atm 1.1)#ip ospf dead-interval 25000


Syntax Description
message-digest Optional. Specifies message-digest authentication type.
null Optional. Specifies that no authentication be used.
Default Values
Command History
Usage Examples
The following example specifies that no authentication will be used on the ATM subinterface 1.1:

(config-atm 1.1)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
point-to-point.
Command History
Functional Notes
Usage Examples

(config-atm 1.1)#ip ospf network broadcast

ip pim sparse-mode
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
unidirectional shared trees rooted at a rendezvous point (RP) for a multicast group or a shortest-path tree
Usage Examples

(config-atm 1.1)#ip pim sparse-mode


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a priority of 100 on the asynchronous transfer mode (ATM) subinterface
1.1:

(config-atm 1.1)#ip pim-sparse dr-priority 100


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies hellos be sent on the asynchronous transfer mode (ATM) subinterface 1.1
every 3600 seconds:

(config-atm 1.1)#ip pim-sparse hello-timer 3600


Syntax Description
Default Values
Command History
Usage Examples

(config-atm 1.1)#ip pim-sparse nbr-timeout 300


default value.
Syntax Description
65535 milliseconds.
Default Values
Command History
Usage Examples

(config-atm 1.1)#ip pim-sparse override-interval 3000


Syntax Description
Default Values
Command History
Usage Examples

(config-atm 1.1)#ip pim-sparse propagation-delay 300


Use the ip policy route-map command to assign a policy route map to this interface. Use the no form of
Syntax Description
Default Values
Command History
Usage Examples
The following example assigns the policy route map policy1 to the asynchronous transfer mode (ATM)
subinterface 1.1:

(config-atm 1.1)#ip policy route-map policy1

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
If proxy ARP is enabled, AOS will respond to all proxy ARP requests with its specified medium access
control (MAC) address and forward packets accordingly.
Usage Examples
The following example enables proxy ARP on the ATM subinterface 1.1:

(config-atm 1.1)#ip proxy-arp


unit accepts in all RIP packets received on the interface. Use the no form of this command to restore the

Syntax Description
1 Accepts only received RIP version 1 packets on the interface.
Default Values
Command History
Functional Notes
Use the ip rip receive version to specify a RIP version that will override the version (in the Router RIP)
configuration.
Usage Examples
The following example configures the ATM subinterface 1.1 to accept only RIP version 2 packets:

(config-atm 1.1)#ip rip receive version 2

ip rip send version

unit sends in all RIP packets transmitted on the interface. Use the no form of this command to restore the

Syntax Description
Default Values
Command History
Functional Notes
Use the ip rip send version to specify a RIP version that will override the version (in the Router RIP)
configuration.
Usage Examples
The following example configures the ATM subinterface 1.1 to transmit only RIP version 2 packets:

(config-atm 1.1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples

(config-atm 1.1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables fast switching on the ATM subinterface 1.1:

(config-atm 1.1)#ip route-cache

configuration.
Syntax Description
Default Values
By default, all interfaces are configured to use a specified IP address (using the command ip address <ip
address> <subnet mask> on page 1568).
Command History
Functional Notes
taken from the specified interface. For example, specifying ip unnumbered eth 0/1 while in the Frame
Relay Subinterface Configuration mode configures the Frame Relay subinterface to use the IP address
assigned to the Ethernet interface for all IP processing. In addition, AOS uses the specified interface
Usage Examples
The following example configures the ATM subinterface 1.1 to use the IP address assigned to the Ethernet
interface (eth 0/1):

(config-atm 1.1)#ip unnumbered eth 0/1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
must be created by using the ip urlfilter <name> http command before applying it to the interface. Refer
to ip urlfilter <name> http on page 995 for more information on using this command.
Usage Examples
The following example performs URL filtering on all traffic entering through the asynchronous transfer
mode (ATM) subinterface 1.1 and matches the URL filter named MyFilter:

(config-atm 1.1)#ip urlfilter MyFilter in

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies 85 percent bandwidth on the asynchronous transfer mode (ATM)
subinterface to be available for use in user-defined queues:

(config-atm 1.1)#max-reserved-bandwidth 85

media-gateway ip

Syntax Description
loopback interface.
(for example, 10.10.10.1).
Default Values
Command History
Usage Examples

(config-atm 1.1)#media-gateway ip primary

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes
router A and router B are exchanging hello packets, but their MTU sizes do not match, they will never
reach adjacency. This is by design and required by the RFC.

Usage Examples
The following example specifies an MTU of 1200 on the ATM subinterface 1.1:

(config-atm 1.1)#mtu 1200

oam retry
Use the oam retry command to configure parameters related to operations, administration, and
maintenance (OAM) management for an asynchronous transfer mode (ATM) interface. Use the no form of
this command to disable OAM management parameters. Variations of this command include:
oam retry
oam retry <up value>
oam retry <up value> <down value>
oam retry <up value> <down value> <value>
Syntax Description
<up value> Optional. Specifies the number of consecutive end-to-end F5 OAM
loopback cell responses that must be received in order to change a
permanent virtual circuit (PVC) connection state to up. Range is 1 to 255.
<down value> Optional. Specifies the number of consecutive end-to-end F5 OAM
loopback cell responses that are not received in order to change a PVC
state to down. Range is 1 to 255.
<value> Optional. Specifies the frequency (in seconds) that end-to-end F5 OAM
loopback cells are transmitted when a change in the up/down state of a
PVC is being verified. Range is 1 to 600 seconds.
Default Values
By default, the up-count is set to 3, the down-count is set to 5, and the retry frequency is 1.
Command History
Usage Examples
The following example configures the OAM parameters with an up-count of 2, down-count of 2, and retry
frequency of 10:

(config-atm 1.1)#oam retry 2 2 10

oam-pvc managed
Use the oam-pvc managed command to enable end-to-end F5 operations, administration, and
maintenance (OAM) loopback cell generation and OAM management for an asynchronous transfer mode
(ATM) interface. Use the no form of this command to disable generation of OAM loopback cells.
oam-pvc managed
oam-pvc managed <value>
Syntax Description
<value> Optional. Specifies the time delay between transmitting OAM loopback
cells. Range is 0 to 600 seconds.
Default Values
By default, the frequency is 1 second.
Command History
Usage Examples
The following example enables OAM loopback cell generation with a frequency of 5 seconds:

(config-atm 1.1)#oam-pvc managed 5

pvc <VPI/VCI>
Use the pvc command to select the asynchronous transfer mode (ATM) virtual link for this subinterface.
Use the no form of this command to remove the link.
Syntax Description
<VPI/VCI> Specifies the ATM network virtual path identifier (VPI) for this permanent
virtual circuit (PVC). The VPI value range is 0 to 255, and the virtual
channel identifier (VCI) value range is 32 to 65535.
Default Values
Command History
Usage Examples
The following example sets the VPI to 8 and the VCI to 35:


qos-policy
Syntax Description
Default Values
Command History
Functional Notes
5. The interface queuing method is changed to fair-queue to use weighted fair queuing (WFQ).

Usage Examples
The following example applies the QoS map VOICEMAP to the ATM subinterface 1.1:

(config-atm 1.1)#qos-policy out VOICEMAP

Use the spanning-tree bpdufilter command to block bridge protocol data units (BPDUs) from being
transmitted and received on this interface. To return to the default value, use the no form of this command.

Syntax Description
disable Disables the BPDU filter.
enable Enables the BPDU filter.
Default Values
By default, this command is set to disable.
Command History
Functional Notes
The purpose of this command is to remove a port from participation in the spanning tree. This might be
beneficial while debugging a network setup. It normally should not be used in a live network.
Usage Examples
The following example enables the BPDU filter on the interface:

(config-atm 1.1)#spanning-tree bpdufilter enable

Use the spanning-tree bpduguard command to block bridge protocol data units (BPDUs) from being
received on this interface. To return to the default value, use the no form of this command. Variations of

Syntax Description
disable Disables the BPDU block.
enable Enables the BPDU block.
Default Values
Command History
Usage Examples
The following example enables the bpduguard on the interface:

(config-atm 1.1)#spanning-tree bpduguard enable

Use the spanning-tree edgeport command to set this interface to be an edgeport. This command overrides
the global setting (refer to spanning-tree edgeport default on page 1105). Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples

(config-atm 1.1)#spanning-tree edgeport

(config-atm 1.1)#spanning-tree edgeport disable
or

(config-atm 1.1)#no spanning-tree edgeport

Use the spanning-tree link-type command to configure the spanning-tree protocol link type for an
interface. To return to the default value, use the no form of this command. Variations of this command
include:

Syntax Description
point-to-point Sets link type manually to point-to-point regardless of duplex settings.
shared Sets link type manually to shared regardless of duplex settings.
Default Values
By default, a port is set to auto.
Command History
Functional Notes
This command overrides the default link-type setting determined by the duplex of the individual port. By
use the specified link type. Using the link-type auto command, restores the convention of determining link
Usage Examples
The following example forces the link type to point-to-point, even if the port is configured to be half-duplex:
(config)#bridge 1 protocol ieee

(config-atm 1.1)#spanning-tree link-type point-to-point
Technology Review

spanning-tree path-cost <value>

Use the spanning-tree path-cost command to assign a cost to a bridge group that is used when computing
the spanning-tree root path. To return to the default path-cost value, use the no form of this command.
Syntax Description
<value> Assigns a number to the bridge interface to be used as the path cost in
spanning calculations. Valid range is 0 to 65535.
Default Values
By default, the path-cost value is set to 19.
Command History
Functional Notes
The specified value is inversely proportional to the likelihood the bridge interface will be chosen as the root
path. Set the path-cost value lower to increase the chance the interface will be the root. To obtain the most
accurate spanning-tree calculations, develop a system for determining path costs for links and apply it to
all bridged interfaces.
Usage Examples
The following example assigns a path cost of 100 for bridge group 17 on an ATM subinterface:

(config-atm 1.1)#spanning-tree path-cost 100
Technology Review
Spanning-tree protocol provides a way to prevent loopback or parallel paths in bridged networks. Using the
priority values and path costs assigned to each bridging interface, the spanning-tree protocol determines
the root path and identifies whether to block or allow other paths.


Use the spanning-tree port-priority command to select the priority level of a port associated with a
bridge. To return to the default bridge-group priority value, use the no form of this command.
Syntax Description
<value> Assigns a priority value for the bridge group; the lower the value, the higher
the priority. Valid range is 0 to 255.
Default Values
By default, the bridge-group priority value is set to 128.
Command History
Functional Notes
At that point, the level set in this command will determine which port the bridge will use. Set the priority
value lower to increase the chance the interface will be used.
Usage Examples
The following example sets the maximum priority on the ATM subinterface labeled 1.1 in bridge
group 17:

(config-atm 1.1)#spanning-tree port-priority 0


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide BVI Interface Command Set
BVI INTERFACE COMMAND SET
To activate the Bridged Virtual Interface Configuration mode, first enable integrated routing and bridging
(IRB) via the bridge irb command (refer to bridge irb on page 765) at the Global Configuration mode
prompt. For example:
>enable
#configure terminal
(config)#bridge irb
Next, enter the interface bvi command and a specific interface number that corresponds to an existing
bridge group at the Global Configuration mode prompt. For example:
(config)#bridge irb
(config-bvi 1)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61

qos-policy out <name> on page 1652

Syntax Description
Default Values
By default, there are no configured access policies associated with an interface.
Command History
interfaces.
Usage Examples
The following example associates the ACP PRIVATE (to allow inbound traffic to the Web server) to BVI 1:

Associate the access policy with BVI 1:
(config-bvi 1)#access-policy PRIVATE

bandwidth <value>
Syntax Description
Default Values
To view default values, use the show interfaces command.
Command History
Functional Notes
Usage Examples
The following example sets bandwidth of BVI 1 to 10 Mbps:
(config-bvi 1)#bandwidth 10000

crypto map <name>

Syntax Description
Default Values
Command History
Functional Notes


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to BVI 1:
(config-bvi 1)#crypto map MyMap

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
and password pass:
(config-bvi 1)#dynamic-dns dyndns-custom host user pass

Syntax Description
<name> Specifies the IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the router to only allow Telnet traffic into BVI 1:
(config-bvi 1)#ip access-group TelnetOnly in

ip address dhcp

Syntax Description
from a DHCP server.
media type).
media types.
delimiters).
obtained via DHCP.

Default Values
formula:
Command History
subinterface.
Functional Notes
Usage Examples
The following example enables DHCP operation on virtual BVI 1:
(config-bvi 1)#ip address dhcp

The following example enables DHCP operation on virtual BVI 1 utilizing host name adtran and does not
allow obtaining a default route, domain name, or name servers. It also sets the administrative distance as
5:
(config-bvi 1)#ip address dhcp hostname “adtran” no-default-route no-domain-name
no-nameservers 5



Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
(config-bvi 1)#ip address 192.22.72.101 255.255.255.252 secondary


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:
(config-bvi 1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on BVI 1:
(config-bvi 1)#ip directed-broadcast

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on a bridged virtual interface (BVI) to monitor incoming
traffic through an ACL called myacl:
(config-bvi 1)#ip flow ingress myacl


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes
To implement the helper address feature, assign a helper-address(es) (specifying the device that needs to

Usage Examples
The following example forwards all DNS broadcast traffic to the DNS server with IP address 192.33.5.99:
(config-bvi 1)#ip helper-address 192.33.5.99

ip ospf

Syntax Description
1 to 65535.
65535 seconds.
0 to 255.
65535 seconds.
Default Values
hello-interval <seconds> 10 seconds: Ethernet, bridged virtual interface (BVI), Tunnel,
and Point-to-Point Protocol (PPP)

Command History
Release 15.1 Command was expanded to include the BVIs.
Usage Examples
(config-bvi 1)#ip ospf dead-interval 25000

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies that no authentication will be used on BVI 1:
(config-bvi 1)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
By default, Ethernet defaults to broadcast. Point-to-Point Protocol (PPP) and bridged virtual interface
(BVI) default to point-to-point.
Command History
Functional Notes
Usage Examples
(config-bvi 1)#ip ospf network broadcast


Syntax Description
Default Values
Command History
Usage Examples
(config-bvi 1)#ip policy route-map policy1

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables proxy ARP on BVI 1:
(config-bvi 1)#ip proxy-arp



Syntax Description
Default Values
Command History
Functional Notes
Use the ip rip receive version command to specify a RIP version that will override the version (in the
Router RIP) configuration.
Usage Examples
The following example configures a BVI to accept only RIP version 2 packets:
(config-bvi 1)#ip rip receive version 2

ip rip send version


Syntax Description
Default Values
Command History
Functional Notes
configuration.
Usage Examples
The following example configures a BVI to transmit only RIP version 2 packets:
(config-bvi 1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
(config-bvi 1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
By default, fast-cache switching is enabled on all Ethernet and virtual bridged virtual interfaces (BVIs). IP
route cache is enabled for all virtual Point-to-Point Protocol (PPP) interfaces.
Command History
Functional Notes
Usage Examples
The following example enables fast-cache switching on a BVI:
(config-bvi 1)#ip route-cache

configuration.
Syntax Description
interface id.subinterface id]>. For example, for a T1 interface, use t1 0/1; for
an Ethernet subinterface, use eth 0/1.1; for a PPP interface, use ppp 1; and
for an ATM subinterface, use atm 1.1. Type ip unnumbered ? for a list of
valid interfaces.
Default Values
Command History
Functional Notes
taken from the specified interface. For example, specifying ip unnumbered eth 0/1 while in the BVI
Configuration mode configures the BVI to use the IP address assigned to the Ethernet interface for all IP
processing. In addition, AOS uses the specified interface information when sending route updates over the
unnumbered interface.
Usage Examples
The following example configures BVI 1 to use the IP address assigned to the Ethernet interface (eth 0/1):
(config-bvi 1)#ip unnumbered eth 0/1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through BVI 1 and matches the URL
filter named MyFilter:
(config-bvi 1)#ip urlfilter MyFilter in


Use the mac-address command to specify the medium access control (MAC) address of the virtual local
area network (VLAN) interface. Only the last three values of the MAC address can be modified. The first
three values contain the ADTRAN reserved number (00:0A:C8) by default. Use the no form of this
command to return to the default MAC address programmed by ADTRAN.
Syntax Description
Default Values
Command History
Usage Examples
The following example configures a MAC address of 00:0A:C8:5F:00:D2 for BVI 1:
(config-bvi 1)#mac-address 00:0A:C8:5F:00:D2

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies 85 percent of the bandwidth on BVI 1 be available for use in user-defined
queues:
(config-bvi 1)#max-reserved-bandwidth 85

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes

Usage Examples
The following example specifies an MTU of 1200 on BVI 1:
(config-bvi 1)#mtu 1200


Use the qos-policy out command to apply a previously configured quality of service (QoS) map to
outgoing packets on an interface. Use the no form of this command to remove the map from the interface.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example applies the QoS map VOICEMAP to BVI 1:
(config-bvi 1)#qos-policy out VOICEMAP

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the bridged virtual interface (BVI) 1:
(config-bvi 1)#rtp quality-monitoring


Use the traffic-shape rate command to specify and enforce an output bandwidth for the bridged virtual
interface (BVI). Use the no form of this command to disable this feature. Variations of this command
include:

Syntax Description
Default Values
By default, traffic-shape rate is disabled.
Command History
Functional Notes
Traffic shaping can be used to limit the virtual local area network (VLAN) interface to a particular rate or to
specify use of quality of service (QoS).
Usage Examples
The following example sets the outbound rate of bvi 1 to 128 kbps and applies a QoS policy that gives all
Realtime Transport Protocol (RTP) traffic priority over all other traffic:

(config-qos-map)#interface bvi 1
(config-bvi 1)#traffic-shape rate 128000
(config-bvi 1)#qos-policy out voip


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide Demand Interface Command Set
DEMAND INTERFACE COMMAND SET
To create a virtual demand interface and/or activate the Demand Interface Configuration mode, enter the
interface demand command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-demand 1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61

called-number <number> on page 1660
caller-number <number> on page 1661
connect-mode on page 1662
connect-order on page 1663
connect-sequence on page 1664
connect-sequence attempts <value> on page 1666
connect-sequence interface-recovery on page 1667
demand-hold-queue <number> timeout <value> on page 1670
fast-idle <value> on page 1674
idle-timeout <value> on page 1676
keepalive <value> on page 1704


match-interesting on page 1708
ppp commands begin on page 1713
resource pool <name> on page 1725

Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
demand interface 1:

Associate the access policy with the demand interface 1:
(config-demand 1)#access-policy PRIVATE

bandwidth <value>
Syntax Description
<value> Specifies the bandwidth value in kbps.
Default Values
To view default values, use the show interfaces command.
Command History
Release 11.1 Command was expanded to include the demand interface.
Functional Notes
Usage Examples
The following example sets the bandwidth of the demand interface to 10 Mbps:
(config-demand 1)#bandwidth 10000

called-number <number>
Use the called-number command to link calls to specific interfaces based on their dialed number
identification service (DNIS) numbers. Multiple called numbers may be specified for an interface. Use the
no form of this command to restore the default value.
Syntax Description
<number> Identifies the called number to be linked to an interface. The DNIS number
is limited to 20 digits.
Default Values
By default, no called numbers are defined.
Command History
Usage Examples
The following example links calls with a DNIS number of 2565558409 to the demand interface 1:
(config-demand 1)#called-number 2565558409

caller-number <number>
Use the caller-number command to link calls to specific interfaces based on its caller ID (CLID) number.
Multiple caller ID numbers may be specified, allowing the interface to accept calls from different remote
resources. Use the no form of this command to restore the default value.
Syntax Description
<number> Identifies the caller’s number to be linked to an interface. The CLID number
is limited to 20 digits.
Default Values
By default, no caller numbers are defined.
Command History
Usage Examples
The following example links calls with a CLID number of 2565559911 to the demand interface 1:
(config-demand 1)#caller-number 2565559911

connect-mode
Use the connect-mode command to configure the interface to only answer calls, only originate calls, or to
both answer and originate calls. Use the no form of this command to restore the default value. Variations
connect-mode answer
connect-mode either
connect-mode originate
Syntax Description
answer Specifies the interface may be used to answer calls, but not originate calls.
either Specifies the interface may be used to answer and originate calls.
originate Specifies the interface may be used to originate calls, but not answer calls.
Default Values
By default, the connect mode is set to both answer and originate calls.
Command History
Usage Examples
The following example configures demand interface 1 to only answer calls:
(config-demand 1)#connect-mode answer

connect-order
Use the connect-order command to specify the starting point in the connection sequence for each
sequence activation. The connection sequence is a circular list. Use the no form of this command to restore
connect-order last-successful
connect-order round-robin
connect-order sequential
Syntax Description
last-successful Specifies the connect sequence be processed beginning with the last
successful entry or the first entry if there are no previous connections.
round-robin Specifies the connect sequence be processed beginning with the entry that
follows the last successful entry or the first entry if there are no previous
connections.
sequential Specifies the connect sequence be processed from the beginning of the list.
Default Values
By default, connect sequences are processed sequentially.
Command History
Usage Examples
The following example configures the connection sequence to begin with the last successful entry:
(config-demand 1)#connect-order last-successful

connect-sequence
Use the connect-sequence command to provide instructions to the interface on how to use the resource
pool and telephone numbers to connect to demand destinations. Use the no form of this command to
restore the default value.Variations of this command include the following:
connect-sequence <value> dial-string <string> forced-analog

connect-sequence <value> dial-string <string> forced-analog busyout-threshold <value>
connect-sequence <value> dial-string <string> forced-cellular
connect-sequence <value> dial-string <string> forced-cellular busyout-threshold <value>
connect-sequence <value> dial-string <string> forced-isdn-56k
connect-sequence <value> dial-string <string> forced-isdn-56k busyout-threshold <value>
connect-sequence <value> dial-string <string> forced-isdn-64k
connect-sequence <value> dial-string <string> forced-isdn-64k busyout-threshold <value>
connect-sequence <value> dial-string <string> isdn-56k
connect-sequence <value> dial-string <string> isdn-56k busyout-threshold <value>
connect-sequence <value> dial-string <string> isdn-64k
connect-sequence <value> dial-string <string> isdn-64k busyout-threshold <value>
Syntax Description
<value> Specifies the sequence number for this connection specification entry.
dial-string <string> Specifies the telephone number to dial when using this connection. The dial
string is limited to 20 digits.
forced-analog Specifies that only analog resources may be used.
forced-cellular Specifies that only cellular resources may be used.
forced-isdn-56k Specifies that only integrated services digital network (ISDN) resources may
be used. Call is placed using ISDN 56k.
forced-isdn-64k Specifies that only ISDN resources may be used. Call is placed using ISDN
64k.
isdn-56k Specifies any dial resource may be used if ISDN 56k call type is used.
isdn-64k Specifies any dial resource may be used if ISDN 64k call type is used.
busyout-threshold <value> Optional. Specifies the maximum number of connect sequence cycles
during an activation attempt that must fail before it is skipped until the next
activation attempt.
Default Values
By default, any dial resource may be used.
By default, the dial string for cellular connections is #777.
Command History

Usage Examples
The following example instructs demand interface 1 to place the call using ISDN 64k:
(config-demand 1)#connect-sequence 65 dial-string 2565559911 forced-isdn-64k
The following example instructs demand interface 1 to place the call using a cellular connection:
(config-demand 1)#connect-sequence 1 dial-string #777 forced-cellular

connect-sequence attempts <value>

Use the connect-sequence attempts command to limit the number of times the connect sequence will
cycle when its entries are unable to establish a connection. When the maximum number of attempts are
exhausted, the interface will go into recovery mode. Refer to connect-sequence interface-recovery on page
1667 for more information. Use the no form of this command to restore the default value.
Syntax Description
<value> Specifies the number of times the connect sequence will cycle through its
entries if it is unable to make a connection. Range is 0 to 65535.
Default Values
By default, the connect-sequence attempts are unlimited.
Command History
Usage Examples
The following example instructs demand interface 1 to attempt its connection sequence 500 times:
(config-demand 1)#connect-sequence attempts 500

connect-sequence interface-recovery
Use the connect-sequence interface-recovery command to allow the interface to go down in the event
that the connect-sequence attempts value is exhausted. Refer to connect-sequence attempts <value> on
page 1666 for more information. Use the no form of this command to restore the default value. Variations
connect-sequence interface-recovery
connect-sequence interface-recovery retry-interval <value>
connect-sequence interface-recovery retry-interval <value> max-retries <number>
Syntax Description
retry-interval <value> Optional. Specifies the number of seconds the interface will wait between
connect sequence cycles during recovery attempts.
max-retries <number> Optional. Specifies the maximum number of times the connect sequence
will cycle in an attempt to bring the interface back up. When in interface
recovery mode, this value overrides the connect-sequence attempts
value.
Default Values
By default, the connect-sequence interface-recovery retry-interval is set to 120 seconds and
max-retries are unlimited.
Command History
Usage Examples
The following example configures demand interface 1 to wait 60 seconds between retry attempts with a
maximum number of 500 retries:
(config-demand 1)#connect-sequence interface-recovery retry-interval 60 max-retries 500

crypto map <name>

Syntax Description
<name> Assigns a crypto map name to the interface.
Default Values
Command History
Functional Notes


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the demand interface:
(config-demand 1)#crypto map MyMap

demand-hold-queue <number> timeout <value>

Use the demand-hold-queue timeout command to set the number and length of time interesting packets
will be held while a connection is being made. Use the no form of this command to restore the default
value.
Syntax Description
<number> Specifies the number of packets that may be stored in the hold queue.
Range is 0 to 100.
<value> Specifies the number of seconds a packet may remain in the hold queue.
Default Values
By default, the hold queue is disabled.
Command History
Usage Examples
The following example configures demand interface 1 to hold 50 packets in the queue for up to
120 seconds:
(config-demand 1)#demand-hold-queue 50 timeout 120

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
and password pass:
(config-demand 1)#dynamic-dns dyndns-custom host user pass

fair-queue
fair-queue
fair-queue <threshold>
Syntax Description
<threshold> Optional. Specifies the maximum number of packets that can be present in
each conversation subqueue. Packets received for a conversation after this
limit is reached are discarded. Range: 16 to 512 packets.
Default Values
By default, WFQ is enabled with a threshold of 64 packets.
Command History
Usage Examples
(config-demand 1)#fair-queue 100

fast-idle <value>
Use the fast-idle command to set the amount of time the demand interface connection will remain active in
the absence of interesting traffic when there is contention for the demand resources being used by this
interface. Use the no form of this command to restore the default value.
Syntax Description
<value> Specifies the number of seconds the interface will remain up in the absence
of interesting traffic. Range is 1 to 2147483 seconds.
Default Values
By default, fast-idle is set to 120 seconds.
Command History
Usage Examples
The following example sets fast idle to 1073752 seconds:
(config-demand 1)#fast-idle 1073752


Syntax Description
<value> Specifies the total number of packets the output queue can contain before
packets are dropped. Range is 16 to 1000 packets.
Default Values
Command History
Usage Examples
(config-demand 1)#hold-queue 700 out

idle-timeout <value>
Use the idle-timeout command to set the amount of time the interface link/bundle will remain up in the
absence of interesting traffic. Interesting traffic and direction logic are set using the match-interesting
commands. Refer to match-interesting on page 1708 for more information. Use the no form of this
command to restore the default value.
Syntax Description
<value> Specifies the number of seconds the interface will remain up in the absence
of interesting traffic. Range is 1 to 2147483 seconds.
Default Values
By default, idle-timeout is set to 120 seconds.
Command History
Usage Examples
The following example configures demand interface 1 to time out after 360 seconds:
(config-demand 1)#idle-timeout 360

Syntax Description
<name> Indicates the assigned IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the router to only allow Telnet traffic into the demand interface:

(config-ext-nacl)#interface demand 1
(config-demand 1)#ip access-group TelnetOnly in

ip address negotiated
Use the ip address negotiated command to allow the interface to negotiate (i.e., be assigned) an IP
address from the far-end Point-to-Point Protocol (PPP) connection. Use the no form of this command to
disable the negotiation for an IP address. Variations of this command include:
ip address negotiated no-default
Syntax Description
no-default Optional. Prevents the insertion of a default route. Some systems already
have a default route configured and need a static route to the PPP interface
to function correctly.
Default Values
By default, the interface is assigned an address with the ip address <ip address> <subnet mask>
command.
Command History
Usage Examples
The following example enables the demand interface to negotiate an IP address from the far-end
connection:
(config-demand 1)#ip address negotiated
The following example enables the demand interface to negotiate an IP address from the far-end
connection without inserting a default route:
(config-demand 1)#ip address negotiated no-default


Use the ip address command to define an IP address on the specified interface. Use the optional keyword
secondary to define a secondary IP address. Use the no form of this command to remove a configured IP

Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
(config-demand 1)#ip address 192.22.72.101 255.255.255.252 secondary


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:
(config-demand 1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface demand 1:
(config-demand 1)#ip directed-broadcast

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on a demand interface to monitor incoming traffic
(config-demand 1)#ip flow ingress myacl


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes
To implement the helper address feature, assign a helper address(es) (specifying the device that needs to

Usage Examples
IP address 192.33.5.99:

(config-demand 1)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
default setting.

Syntax Description (Continued)

Default Values
Command History
Usage Examples
(config-demand 1)#ip igmp last-member-query-interval 200

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-demand 1)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
the command ip igmp on page 1686 to receive multicast traffic without host-initiated Internet Group
Management Protocol (IGMP) activity on the selected interface. Otherwise, all host-initiated IGMP
Usage Examples
(config-demand 1)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-demand 1)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
router's unicast route table, the IGMP host function is dynamically enabled and the interface becomes the
active upstream interface, enabling the router to perform as an IGMP proxy. Though multiple interfaces
may be candidates, no more than one interface will actively serve as the helper forwarding interface. Refer
to ip mcast-stub helper-address <ip address> on page 883 and ip mcast-stub downstream on page 1688
Usage Examples
(config-demand 1)#ip mcast-stub upstream

ip ospf

Syntax Description
1 to 65535.
seconds.
0 to 255.
transmit-delay <seconds> Sets the estimated time (in seconds) required to send an LSA
Default Values
Protocol (PPP)

Command History
Usage Examples
(config-demand 1)#ip ospf dead-interval 25000

Syntax Description
Default Values
By default, ip ospf authentication is set to null (meaning no authentication is used).
Command History
Usage Examples
The following example specifies that no authentication will be used on the demand interface:
(config-demand 1)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
point-to-point.
Command History
Functional Notes
Usage Examples
(config-demand 1)#ip ospf network broadcast


Use the ip policy route-map command to associate a route map with a network interface source. Use the
Syntax Description
<name> Specifies the route map to associate with this interface.
Default Values
By default, policy-based routing is disabled for all interfaces.
Command History
Usage Examples
The following example associates the route map named MyMap with demand interface 1:
(config-demand 1)#ip policy route-map MyMap

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables proxy ARP on the virtual demand interface:
(config-demand 1)#ip proxy-arp



Syntax Description
Default Values
Command History
Functional Notes
Use the ip rip receive version to specify a RIP version that overrides the version (in the Router RIP)
configuration.
Usage Examples
The following example configures the virtual demand interface to accept only RIP version 2 packets:
(config-demand 1)#ip rip receive version 2

ip rip send version


Syntax Description
Default Values
Command History
Functional Notes
Use the ip rip send version to specify a RIP version that overrides the version (in the Router RIP)
configuration.
Usage Examples
The following example configures the virtual demand interface to transmit only RIP version 2 packets:
(config-demand 1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
(config-demand 1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
cache is enabled for all virtual demand interfaces.
Command History
Functional Notes
Fast-cache switching allows an IP interface to provide optimum performance when processing IP traffic.
Usage Examples
The following example enables fast-cache switching on the virtual demand interface:
(config-demand 1)#ip route-cache

configuration.
Syntax Description
Default Values
Command History
Functional Notes
taken from the specified interface. For example, specifying ip unnumbered eth 0/1 while in the Demand
Interface Configuration mode configures the demand interface to use the IP address assigned to the
Ethernet interface for all IP processing. In addition, AOS uses the specified interface information when
sending route updates over the unnumbered interface. Static routes may either use the interface name
(ppp 1) or the far-end address (if it will be discovered).
Usage Examples
The following example configures the demand interface (labeled demand 1) to use the IP address
assigned to the Ethernet interface (eth 0/1):
(config-demand 1)#ip unnumbered eth 0/1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through the demand interface (labeled
demand 1) and matches the URL filter named MyFilter:
(config-demand 1)#ip urlfilter MyFilter in

keepalive <value>
Use the keepalive command to enable the transmission of keepalive packets on the interface and specify
the time interval in seconds between transmitted packets. Use the no form of this command to return to the
default setting.
Syntax Description
<value> Defines the time interval (in seconds) between transmitted keepalive
packets. Range is 0 to 32767 seconds.
Default Values
By default, the time interval between transmitted keepalive packets is 10 seconds.
Command History
Functional Notes
If three keepalive packets are sent to an interface with no response, the interface is considered down. To
detect interface failures quickly, specify a smaller keepalive time.
Usage Examples
The following example specifies a keepalive time of 5 seconds on the virtual demand interface:
(config-demand 1)#keepalive 5

lldp receive
this interface. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the demand interface to receive LLDP packets:
(config-demand 1)#lldp receive

lldp send
lldp send
Syntax Description
and-receive Configures this interface to both transmit and receive LLDP packets.
Default Values
By default, all interfaces are configured to transmit and receive LLDP packets of all types.
Command History
Functional Notes
Usage Examples
The following example configures the demand interface to transmit LLDP packets containing all enabled
information types:
(config-demand 1)#lldp send

The following example configures the demand interface to transmit and receive LLDP packets containing
all information types:
(config-demand 1)#lldp send-and-receive

match-interesting
Use the match-interesting command to allow an access control list (ACL) to specify which traffic
attempting to cross this interface will be considered interesting. Use the no form of this command to
restore the default value. Variations of this command include:
match-interesting list <name>

match-interesting list <name> in
match-interesting list <name> out
match-interesting reverse list <name>
match-interesting reverse list <name> in
match-interesting reverse list <name> out
Syntax Description
list <name> Specifies using an ACL with normal (source, destination) ACL matching
logic.
reverse list <name> Specifies using an ACL with reverse (destination, source) ACL matching
logic.
in Optional. Specifies that only incoming traffic is interesting.
out Optional. Specifies that only outgoing traffic is interesting.
Default Values
By default, no interesting traffic is defined.
Command History
Usage Examples
The following example instructs demand interface 1 to use the access control list MyACL when checking
for interesting traffic:
(config-demand 1)#match-interesting list MyACL in

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies 85 percent of the bandwidth on the demand interface 1 be available for
use in user-defined queues:
(config-demand 1)#max-reserved-bandwidth 85

mtu <size>
Syntax Description
BVIs 64 to 2100
HDLC interfaces (all other NetVanta products)64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes

Usage Examples
The following example specifies an MTU of 1200 on the virtual demand interface:
(config-demand 1)#mtu 1200


interface. Use the no form of this command to remove a configured default IP address.
Syntax Description
Default Values
Command History
Functional Notes
This command is useful if the peer does not send the IP address option during Point-to-Point Protocol
(PPP) negotiations.
Usage Examples
(config-demand 1)#peer default ip address 192.22.71.50

ppp authentication
Use the ppp authentication command to specify the authentication protocol on the Point-to-Point
Protocol (PPP) virtual interface that the peer should use to authenticate itself. Use the no form of this
command to remove configured PPP authentication. Variations of this command include:

ppp authentication pap
Syntax Description
chap Configures Challenge-Handshake Authentication Protocol (CHAP)
authentication on the interface.
pap Configures Password Authentication Protocol (PAP) authentication on the
interface.
Default Values
By default, PPP endpoints have no authentication configured.
Command History
Technology Review
CHAP and PAP are two authentication methods that enjoy widespread support. Both methods are included
in AOS and are easily configured.
The authentication method set up on the local router can be different from that on the peer.
Also, just because one router requires authentication from its peer does not mean it also
has to authenticate itself to the peer.
Defining PAP
The PAP is used to verify that the PPP peer is a permitted device by checking a user name and password
configured on the peer. The user name and password are both sent unencrypted across the connecting
private circuit.
PAP requires a two-way message passing. First, the router that is required to be authenticated (for
example, the peer) sends an authentication request with its user name and password to the router
requiring authentication (for example, the local router). The local router then looks up the user name and
password in the user name database within the PPP interface and, if they match, sends an authentication
acknowledge back to the peer.

The PPP user name and password database is separate and distinct from the global user
name password database. For PAP and CHAP, use the database under the PPP interface
configuration.
Several example scenarios are given below for clarity.
Configuring PAP Example 1: Only the local router requires the peer to authenticate itself.
On the local router (host name Local):
Local(config-demand 1)#ppp authentication pap

Local(config-demand 1)#username farend password same
On the peer (host name Peer):
Peer(config-demand 1)#ppp pap sent-username farend password same
The first line of the configuration sets the authentication mode as PAP. This means the peer is required to
authenticate itself to the local router via PAP. The second line is the user name and password expected to
be sent from the peer. On the peer, the ppp pap sent-username command is used to specify the
appropriate matching user name and password.
Configuring PAP Example 2: Both routers require the peer to authenticate itself.
Local(config-demand 1)#ppp authentication pap

Local(config-demand 1)#username farend password far
Local(config-demand 1)#ppp pap sent-username nearend password near
Peer(config-demand 1)#ppp authentication pap

Peer(config-demand 1)#username nearend password near
Peer(config-demand 1)#ppp pap sent-username farend password far
Now both routers send the authentication request, verify that the user name and password sent match
what is expected in the database, and send an authentication acknowledge.
Defining CHAP
The CHAP is a three-way authentication protocol composed of a challenge response and success or
failure. The message digest 5 (MD5) protocol is used to protect user names and passwords in the
response.

First, the local router (requiring its peer to be authenticated) sends a challenge containing only its own
unencrypted user name to the peer. The peer then looks up the user name in the user name database
within the PPP interface and, if found, takes the corresponding password and its own host name and
sends a response back to the local router. This data is encrypted. The local router verifies that the user
name and password are in its own user name database within the PPP interface and, if so, sends a
success back to the peer.
configuration.
Configuring CHAP Example 1: Only the local router requires the peer to authenticate itself.
Local(config-demand 1)#ppp authentication chap

Local(config-demand 1)#username Peer password same
Peer(config-demand 1)#ppp chap password same
The first line of this configuration sets the authentication mode to CHAP. This means the peer is required to
authenticate itself to the local router via CHAP. The second line is the user name and password expected
to be sent from the peer. The peer uses its hostname and ppp chap password commands to send the
proper authentication information.
Both ends must have identical passwords.
Configuring CHAP Example 2: Using the ppp chap hostname command as an alternate solution.

Local(config-demand 1)#username farend password same
Peer(config-demand 1)#ppp chap hostname farend

Peer(config-demand 1)#ppp chap password same

Notice the local router is expecting user name farend even though the peer router's host name is Peer.
Therefore, the peer router can use the ppp chap hostname command to send the correct name in the
challenge.
Configuring CHAP Example 3: Both routers require each other to authenticate themselves using
the same shared password.

Local(config-demand 1)#username Peer password same
Peer(config-demand 1)#ppp authentication chap

Peer(config-demand 1)#username Local password same
This is basically identical to Example 1 except that both routers will now challenge each other and
respond.
two separate shared passwords.

Local(config-demand 1)#username Peer password far
Local(config-demand 1)#ppp chap password near

Peer(config-demand 1)#username Local password near
Peer(config-demand 1)#ppp chap password far

This is basically identical to Example 3, except that there are two separate shared passwords.
Notice this example has both ends using different sets of passwords.

Local(config-demand 1)#username farend password far
Local(config-demand 1)#ppp chap hostname nearend
Local(config-demand 1)#ppp chap password near

Peer(config-demand 1)#username nearend password near
Peer(config-demand 1)#ppp chap hostname farend
Peer(config-demand 1)#ppp chap password far
Therefore, the peer router can use the ppp chap hostname command to send the correct name on the
challenge.

ppp bcp tagged-frame

Use the ppp bcp tagged-frame command to allow negotiation of IEEE 802.1Q-tagged packets over
Bridging Control Protocol (BCP). Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the interface to negotiate tagged frames over bcp:
(config-demand 1)#ppp bcp tagged-frame

ppp chap hostname <name>

Use the ppp chap hostname command to configure an alternate host name for Challenge-Handshake
Authentication Protocol (CHAP) Point-to-Point Protocol (PPP) authentication. Use the no form of this
command to remove a configured host name. For more information on Password Authentication Protocol
(PAP) and CHAP functionality, refer to the Technology Review section for the command ppp
authentication on page 1713.
Syntax Description
<name> Specifies a host name using an alphanumeric string up to 80 characters in
length.
Default Values
By default, there are no configured PPP CHAP host names.
Command History
Usage Examples
The following example specifies a PPP CHAP host name of my_host:
(config-demand 1)#ppp chap hostname my_host

ppp chap password <password>

Use the ppp chap password command to configure an alternate password when the peer requires
Challenge-Handshake Authentication Protocol (CHAP) Point-to-Point Protocol (PPP) authentication. Use
the no form of this command to remove a configured password. For more information on Password
Authentication Protocol (PAP) and CHAP functionality, refer to the Technology Review section for the
command ppp authentication on page 1713.
Syntax Description
<password> Specifies a password using an alphanumeric string up to 80 characters in
length.
Default Values
By default, there is no defined PPP CHAP password.
Command History
Usage Examples
The following example specifies a PPP CHAP password of my_password:
(config-demand 1)#ppp chap password my_password

ppp multilink
Use the ppp multilink command to enable Multilink Point-to-Point Protocol (MLPPP) operation on an
existing Point-to-Point Protocol (PPP) interface. Use the no form of this command to disable this feature.
ppp multilink
ppp multilink fragmentation
ppp multilink interleave
ppp multilink maximum <number>
Syntax Description
fragmentation Enables multilink fragmentation operation.
interleave Enables multilink interleave operation.
maximum <number> Specifies the maximum number of links allowed in a PPP multilink bundle.
Default Values
By default, MLPPP is disabled.
Command History
Release 7.2 Fragmentation and interleave operation were added.
Functional Notes
When enabled, this interface is capable of the following:
• Combining multiple physical links into one logical link.

• Receiving upper layer protocol data units (PDUs), fragmenting and transmitting over the physical links.
• Receiving fragments over the physical links and reassembling them into PDUs.
The fragmentation and interleave options can be used to enhance the multilink operation. Fragmentation is
used to reduce serialization delays of large packets. The fragmentation process evenly divides the data
among all links in the bundle with a minimum packet size of 96 bytes. The interleave operation is used with
streaming protocols to reduce delay by giving priority to packets identified as being high priority. Delivery in
order is guaranteed with multilink fragmentation, but is not guaranteed with multilink interleave operation.
The multilink bundle will remain active with a minimum of one physical link. Physical links may be
dynamically added or removed from the multilink bundle with minor interruption to traffic flow.

Usage Examples
The following example enables MLPPP:
(config-demand 1)#ppp multilink

ppp pap sent-username <username> password <password>

Use the ppp pap sent-username password command to configure a user name and password when the
peer requires Password Authentication Protocol (PAP) Point-to-Point Protocol (PPP) authentication. Use
the no form of this command to remove a configured password. For more information on PAP and
Challenge-Handshake Authentication Protocol (CHAP) functionality, refer to the Technology Review
section for the command ppp authentication on page 1713.
Syntax Description
<username> Specifies a user name by alphanumeric string up to 80 characters in length
(the user name is case sensitive).
<password> Specifies a password by alphanumeric string up to 80 characters in length
(the password is case sensitive).
Default Values
By default, there is no defined ppp pap sent-username and password.
Command History
Usage Examples
The following example specifies a PPP PAP sent-user name of local and a password of my_password:
(config-demand 1)#ppp pap sent-username local password my_password

qos-policy
Syntax Description
Default Values
Command History
Usage Examples
The following example applies the QoS map VOICEMAP to the demand 1 interface:
(config-demand 1)#qos-policy out VOICEMAP

resource pool <name>

Use the resource pool command to associate a resource pool with the demand interface. No more than one
resource pool may be associated with an interface. Refer to resource pool-member <name> on page 1262
for more information. Use the no form of this command to restore the default value.
Syntax Description
<name> Specifies the resource pool that this interface will use to originate/answer
demand connections.
Default Values
By default, no resource pool is associated with this interface.
Command History
Usage Examples
The following example associates the resource pool named Pool1 with demand interface 1:
(config-demand 1)#resource pool Pool1

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the virtual demand interface:
(config-demand 1)#rtp quality-monitoring


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the virtual demand interface:
(config-demand 1)#no snmp trap link-status


Use the username password command to configure the user name and password of the peer to use for
demand authentication. Use the no form of this command to remove a configured user name and password.
Syntax Description
<username> Specifies a user name by alphanumerical string up to 30 characters in
<password> Specifies a password by alphanumerical string up to 30 characters in length
Default Values
Command History
Functional Notes
Password Authentication Protocol (PAP) uses this entry to check received information from the peer.
Challenge-Handshake Authentication Protocol (CHAP) uses this entry to check the received peer host
name and a common password.
Usage Examples
The following example creates a user name of ADTRAN with password ADTRAN for the demand link
labeled 5:
(config-demand 5)#username ADTRAN password ADTRAN


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide Frame Relay Interface Command Set
FRAME RELAY INTERFACE COMMAND SET
To create a virtual Frame Relay interface and activate the Frame Relay Interface Configuration mode,
enter the interface frame-relay command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-fr 1)#
By default, Frame Relay interfaces are created as point-to-point links. This default setting cannot be
altered. The following command creates the exact same interface as that mentioned above:
>enable
#configure terminal
(config)#interface frame-relay 1 point-to-point
(config-fr 1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61

encapsulation frame-relay ietf on page 1732
frame-relay commands begin on page 1734

bandwidth <value>
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example sets bandwidth of the Frame Relay interface to 10 Mbps:
(config-fr 1)#bandwidth 10000

encapsulation frame-relay ietf

Use the encapsulation frame-relay ietf command to configure the encapsulation on a virtual Frame Relay
interface as IETF (RFC 1490). Currently, this is the only encapsulation setting. Settings for this option
must match the far-end router’s settings in order for the Frame Relay interface to become active.
Syntax Description
No subcommands.
Default Values
By default, all Frame Relay interfaces use IETF encapsulation.
Command History
Usage Examples
The following example configures the endpoint for IETF encapsulation:
(config-fr 1)#encapsulation frame-relay ietf

fair-queue
fair-queue
fair-queue <value>
Syntax Description
<value> Optional. Specifies the maximum number of packets that can be present in
limit is reached are discarded. Range is 16 to 512 packets.
Default Values
Command History
Usage Examples
(config-fr 1)#fair-queue 100

frame-relay intf-type
Use the frame-relay intf-type command to define the Frame Relay signaling role needed for the endpoint.
frame-relay intf-type dce

frame-relay intf-type dte
frame-relay intf-type nni
Syntax Description
dce Specifies data communication equipment (DCE) or network-signaling role.
Use this interface type when you need the unit to emulate the frame switch.
dte Specifies data terminal equipment (DTE) or user-signaling role. Use this
interface type when connecting to a Frame Relay switch (or piece of
equipment emulating a frame switch).
nni Configures the interface to support both network and user signaling (DTE or
DCE) when necessary.
Default Values
By default, frame-relay intf-type is set to dte.
Command History
Usage Examples
The following example configures the Frame Relay endpoint for DCE signaling:
(config-fr 1)#frame-relay intf-type dce

frame-relay lmi-n391dte <value>

Use the frame-relay lmi-n391dte command to set the N391 full status polling counter for the data
terminal equipment (DTE) endpoint. Typical applications should leave the default value for this timer. Use
Syntax Description
<value> Sets the poll counter value. Valid range is 1 to 255.
Default Values
By default, the polling counter for the DTE endpoint is set to six polls.
Command History
Functional Notes
The N391 counter determines how many link integrity polls occur in between full status polls. The number
of link integrity polls between full status polls is n - 1, where n represents the full status poll. n can be set to
any number between 1 and 255, but the default is used for most applications.
Usage Examples
The following example sets the N391 counter for three polls:
(config-fr 1)#frame-relay lmi-n391dte 3

frame-relay lmi-n392dce <value>

Use the frame-relay lmi-n392dce command to set the N392 error threshold for the data communication
equipment (DCE) endpoint. Typical applications should leave the default value for this setting. Use the no
form of this command to return to the default value.
Syntax Description
<value> Sets the error threshold value. Valid range is 1 to 10 errors.
Default Values
By default, the error threshold for the DCE endpoint is set to three errors.
Command History
Functional Notes
If the error threshold is met, the signaling state status is changed to down, indicating a service-affecting
condition. This condition is cleared once N393 consecutive error-free events are received. N392 defines
the number of errors required in a given event window, while N393 defines the number of polling events in
each window.
For example:
If N392 = 3 and N393 = 4, then if three errors occur within any four events, the interface is determined
inactive.
Usage Examples
The following example sets the N392 threshold for 5 seconds:
(config-fr 1)#frame-relay lmi-n392dce 5


Use the frame-relay lmi-n392dte command to set the N392 error threshold for the data terminal
equipment (DTE) endpoint. Typical applications should leave the default value for this setting. Use the no
Syntax Description
<value> Sets the error threshold value. Valid range is 1 to 10 errors.
Default Values
By default, the error threshold for the DTE endpoint is set to three errors.
Command History
Functional Notes
If the error threshold is met, the signaling state status is changed to down, indicating a service-affecting
condition. This condition is cleared once N393 consecutive error-free events are received. N392 defines
the number of errors required in a given event window, while N393 defines the number of polling events in
each window.
For example:
If N392 = 3 and N393 = 4, then if three errors occur within any four events, the interface is determined
inactive.
Usage Examples
The following example sets the N392 threshold for five errors:

frame-relay lmi-n393dce <value>

Use the frame-relay lmi-n393dce command to set the N393 local management interface (LMI) monitored
event counter for the data communication equipment (DCE) endpoint. Typical applications should leave
the default value for this counter. Use the no form of this command to return to the default value.
Syntax Description
<value> Sets the event counter value. Valid range is 1 to 10 events.
Default Values
By default, the LMI monitored event counter for the DCE endpoint is set to four events.
Command History
Usage Examples
The following example sets the N393 threshold for five events:
(config-fr 1)#frame-relay lmi-n393dce 5


Use the frame-relay lmi-n393dte command to set the N393 local management interface (LMI) monitored
event counter for the data terminal equipment (DTE) endpoint. Typical applications should leave the
default value for this counter. Use the no form of this command to return to the default value.
Syntax Description
<value> Sets the event counter value. Valid range is 1 to 10 events.
Default Values
By default, the LMI monitored event counter for the DTE endpoint is set to four events.
Command History
Usage Examples
The following example sets the N393 threshold for five events:

frame-relay lmi-t391dte <value>

Use the frame-relay lmi-t391dte command to set the T391 signal polling timer for the data terminal
equipment (DTE) endpoint. Typical applications should leave the default value for this timer. Use the no
Syntax Description
<value> Sets the signal polling timer value in seconds. Valid range is 5 to
30 seconds.
Default Values
By default, the signal polling timer for the DTE endpoint is set to 10 seconds.
Command History
Functional Notes
The T391 timer sets the time (in seconds) between polls to the Frame Relay network.
Usage Examples
The following example sets the T391 timer for 15 seconds:
(config-fr 1)#frame-relay lmi-t391dte 15

frame-relay lmi-t392dce <value>

Use the frame-relay lmi-t392dce command to set the T392 polling verification timer for the data
communication equipment (DCE) endpoint. Typical applications should leave the default value for this
timer. Use the no form of this command to return to the default value.
Syntax Description
<value> Sets the polling verification timer value in seconds. Valid range is 5 to
30 seconds.
Default Values
By default, the polling verification timer for the DCE endpoint is set to 10 seconds.
Command History
Functional Notes
The T392 sets the timeout (in seconds) between polling intervals. This parameter needs to be a few
seconds longer than the T391 setting of the attached Frame Relay device.
Usage Examples
The following example sets the T392 timer for 15 seconds:
(config-fr 1)#frame-relay lmi-t392dce 15

frame-relay lmi-type
Use the frame-relay lmi-type command to define the Frame Relay signaling (local management interface
(LMI)) type. Use the no form of this command to return to the default value. Variations of this command
include:

frame-relay lmi-type auto
frame-relay lmi-type cisco
frame-relay lmi-type none
frame-relay lmi-type q933a
Syntax Description
ansi Specifies Annex D signaling method.
auto Automatically determines signaling type by messages received on the
frame circuit.
cisco Specifies Group of 4 signaling method.
none Turns off signaling on the endpoint. This is used for dial-backup connections
to ADTRAN IQ and Express Series products.
q933a Specifies Annex A signaling method.
Default Values
By default, the Frame Relay signaling type is set to ansi.
Command History
Release 2.1 Added signaling type none to provide support for dial-backup to ADTRAN
IQ and Express Series products.
Usage Examples
The following example sets the signaling method for the endpoint to cisco:
(config-fr 1)#frame-relay lmi-type cisco

frame-relay multilink
Use the frame-relay multilink command to enable the Frame Relay multilink interface. When the no
form of this command is issued, all configuration options associated with this command and cross connects
made to this interface are removed. Variations of this command include:
frame-relay multilink
frame-relay multilink ack <value>
frame-relay multilink bandwidth-class [A | B]
frame-relay multilink bandwidth-class C <threshold>
frame-relay multilink bid <string>
frame-relay multilink hello <value>
frame-relay multilink retry <number>
Syntax Description
ack <value> Optional. Specifies a wait for acknowledgement time (in seconds) for every
bundle link in the bundle. Range is 1 to 180 seconds.
bandwidth-class Optional. Specifies the class of operation, placing a minimum limit on the
acceptable amount of bandwidth required for a bundle to be up.
[A | B] Optional. Specifies the class of operation.
Class A A single active link is sufficient for the bundle to be up.
Class B All defined bundle links must be active for the bundle to be up.
C <threshold> Optional. Specifies the minimum number of active bundle links required for
a Class C bundle to be in the up state. This option will not be available
unless Class C is specified. Range is 1 to 65535 links.
bid <string> Optional. Specifies a bundle ID (up to 48 characters) for the multilink
bundle. All hello messages sent on links belonging to the multilink bundle
contain the bundle ID. By default, AOS creates a generic bundle ID for each
configured multilink bundle using the following: MFR <interface number>
where the interface number corresponds to the interface number of the
Frame Relay interface. For example, if multilink is enabled on Frame Relay
interface 1, by default the bundle ID is MFR1. Changing the bundle ID
causes the multilink connection to go down for renegotiation.
hello <value> Optional. Specifies the time (in seconds) between hello messages for every
bundle link in the bundle. Range is 1 to 180 seconds.
retry <number> Optional. Specifies the number of times a bundle link will retransmit a
message while waiting for acknowledgement. Range is 1 to 5 times.
Default Values
The default ack value is 4 seconds. The default hello value is 10 seconds. The default <class> value is A.
The default retry value is 2.
Command History

Functional Notes
This command is different from ppp multilink. In ppp multilink, if multiple cross connects are configured
for the Point-to-Point Protocol (PPP) interface without multilink PPP being enabled, the first link to bring up
Link Control Protocol (LCP) will be the only link actually cross connected. In Frame Relay multilink, since
there is no protocol corresponding to LCP, all cross connects will be removed and the user will be free to
re-issue any cross connect.
Usage Examples
The following example enables the Frame Relay multilink interface and sets the time between hello
messages to 45 seconds:
(config-fr 1)#frame-relay multilink hello 45
The following example specifies Class B operation:
(config-fr 1)#frame-relay multilink bandwidth-class B
The following example specifies Class C operation with a threshold of 5:
(config-fr 1)#frame-relay multilink bandwidth-class C 5


Syntax Description
Default Values
Protocol (PPP) first in, first out (FIFO) and Frame Relay round robin is 200.
Command History
Usage Examples
(config-fr 1)#hold-queue 700 out

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies 85 percent of the bandwidth on the Frame Relay 1 interface to be
available for use in user-defined queues:
(config-fr 1)#max-reserved-bandwidth 85

qos-policy
Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example applies the QoS map VOICEMAP to the Frame Relay interface:

snmp trap
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP on the virtual Frame Relay interface:
(config-fr 1)#snmp trap


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the Frame Relay interface:
(config-fr 1)#no snmp trap link-status

Command Reference Guide Frame Relay Subinterface Command Set
FRAME RELAY SUBINTERFACE COMMAND SET
To create a virtual Frame Relay subinterface and activate the Frame Relay Subinterface Configuration
mode, enter the interface frame-relay command (and specify a subinterface) at the Global Configuration
mode prompt. For example:
>enable
#configure terminalF
(config-fr 1.16)#
By default, Frame Relay subinterfaces are created as point-to-point links. This default setting cannot be
altered. The following command creates the exact same interface as that mentioned above:
>enable
#configure terminal
(config)#interface frame-relay 1.16 point-to-point
(config-fr 1.16)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61

frame-relay commands begin on page 1778



Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
Frame Relay subinterface 1.16:

Associate the access policy with the Frame Relay subinterface 1.16:

(config-fr 1.16)#access-policy PRIVATE

bandwidth <value>
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example sets bandwidth of the Frame Relay interface to 10 Mbps:

(config-fr 1.16)#bandwidth 10000

Use the bridge-group command to assign an interface to the specified bridge group. This command is
supported on all Ethernet interfaces, Point-to-Point Protocol (PPP) virtual interfaces, and Frame Relay
virtual subinterfaces. Use the no form of this command to remove the interface from the bridge group.
Syntax Description
<number> Specifies the bridge group number. Range is 1 to 255.
Default Values
Command History
Functional Notes
be bridged (Ethernet to T1 bridge, Ethernet to Frame Relay subinterface).
Usage Examples
The following example assigns the Frame Relay subinterface labeled 1.16 to bridge group 1:

(config-fr 1.16)#bridge-group 1



Syntax Description
Default Values
Command History
Usage Examples
The following example removes the VLAN tags from the packets on the Frame Relay subinterface labeled
1.16:

(config-fr 1.16)#bridge-group 1 vlan-transparent

crypto map <name>

For virutal private network (VPN) configuration example scripts, refer to the VPN
Syntax Description
Default Values
Command History
Functional Notes


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the Frame Relay interface:

(config-fr 1.16)#crypto map MyMap

Use the dial-backup auto-backup command to configure the interface to automatically attempt a dial
dial-backup call-mode on page 1762.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples

(config-fr 1.16)#dial-backup auto-backup

Use the dial-backup auto-restore command to configure the interface to automatically discontinue
dial-backup when all network conditions are operational. Use the no form of this command to disable the
Notes and Technology Review sections of dial-backup call-mode on page 1762.
Syntax Description
No subcommands.
Default Values
condition clears.
Command History
Usage Examples
condition clears:

(config-fr 1.16)#dial-backup auto-restore


Functional Notes and Technology Review sections of dial-backup call-mode on page 1762.
Syntax Description
will enter backup operation on the interface. Range is 10 to 86400 seconds.
Default Values
Command History
Usage Examples

(config-fr 1.16)#dial-backup backup-delay 60


Syntax Description
Default Values
Command History
Functional Notes
Point-to-Point Protocol (PPP) interface configuration commands. However, the numbers dialed are
configured in the primary interface. Full sample configurations follow:
!
interface eth 0/1
ip address 192.168.1.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1
coding b8zs
framing esf

clock source line

no shutdown
!
no shutdown
!
ip address 10.1.1.2 255.255.255.252
no shutdown
!
interface ppp 1
ip address 172.22.56.1 255.255.255.252
username remoterouter password remotepass
ppp chap hostname localrouter
no shutdown
!
ip route 192.168.2.0 255.255.255.0 172.22.56.2 255.255.255.252
!
line telnet 0 4
password password
!
interface eth 0/1
ip address 192.168.100.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1
coding b8zs
framing esf
clock source line
no shutdown

!
no shutdown
!
ip address 10.1.1.1 255.255.255.252
!
interface ppp 1
ip address 172.22.56.2 255.255.255.252
username localrouter password adtran
ppp chap hostname remoterouter
ppp chap password remotepass
no shutdown
!
ip route 192.168.1.0 255.255.255.0 172.22.56.1 255.255.255.252
line telnet 0 4
password password
Usage Examples

(config-fr 1.16)#dial-backup call-mode originate
(config-fr 1.16)#dial-backup number 555 1111 analog ppp 1

Technology Review
Dialing Out
with an addition to the dial-backup number command (refer to dial-backup number <number> on page
1769).
negotiation.
Dialing In
down state.


sections of dial-backup call-mode on page 1762.
Syntax Description
<value> Selects the amount of time (in seconds) that the router will wait for a
Default Values
Command History
Usage Examples

(config-fr 1.16)#dial-backup connect-timeout 120

dial-backup force
Review sections of dial-backup call-mode on page 1762. Variations of this command include:

Syntax Description
backup Force backup regardless of primary link state.
primary Force primary link regardless of its state.
Default Values
Command History
Usage Examples
The following example configures AOS to force this interface into dial backup:

(config-fr 1.16)#dial-backup force backup


Syntax Description
<value> Selects the number of call retries that will be made after a link failure. Valid
range is 0 to 15 attempts.
is failed.
Default Values
By default, dial-backup maximum-retry is set to 0 attempts.
Command History
Usage Examples
The following example configures AOS to retry a dial-backup call four times before considering backup

(config-fr 1.16)#dial-backup maximum-retry 4

dial-backup number <number>

Use the no form of this command to disable this feature. For more detailed information on dial-backup

Syntax Description
Default Values
Command History
Usage Examples

(config-fr 1.16)#dial-backup number 7045551212 digital-64k 1 1 ppp 1


Use the dial-backup priority command to select the backup priority for this interface. This command
allows the user to establish the highest priority backup link and ensure that link will override backups
attempted by lower priority links. Use the no form of this command to return to the default value. For more
Syntax Description
<value> Sets the relative priority of this link. Valid range is 0 to 100. A value of 100
Default Values
By default, dial-backup priority is set to 50.
Command History
Usage Examples

(config-fr 1.16)#dial-backup priority 100

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples

(config-fr 1.16)#dial-backup randomize-timers


Syntax Description
<value> Specifies the delay in seconds between attempting to redial a failed backup
attempt. Range is 10 to 3600 seconds.
Default Values
By default, dial-backup redial-delay is set to 10 seconds.
Command History
Usage Examples

(config-fr 1.16)#dial-backup redial-delay 25


functionality, refer to the Functional Notes and Technology Review sections of dial-backup call-mode on
page 1762.
Syntax Description
86400 seconds.
Default Values
By default, dial-backup restore-delay is set to 10 seconds.
Command History
Usage Examples

(config-fr 1.16)#dial-backup restore-delay 30

dial-backup functionality, refer to the Functional Notes and Technology Review sections of dial-backup

Syntax Description
(00:00).
(00:00).
Default Values
Command History
Usage Examples

(config-fr 1.16)#dial-backup schedule enable-time 08:00
(config-fr 1.16)#dial-backup schedule disable-time 19:00
(config-fr 1.16)#no dial-backup schedule day Saturday
(config-fr 1.16)#no dial-backup schedule day Sunday

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples

(config-fr 1.16)#dial-backup shutdown

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
and password pass:

(config-fr 1.16)#dynamic-dns dyndns-custom host user pass

frame-relay bc <value>
Use the frame-relay bc command to set the bc (committed burst) value for a Frame Relay sublink. The
value is in bits. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the committed burst value (in bits) for the sublink.
Default Values
By default, the committed burst value is set to 0 (no limit).
Command History
Functional Notes
The time interval is always one second, so this can also be considered bits per second. Shaping is
performed on a sliding one-second window to make maximum use of configured bandwidth. Note that
when both bc and be are nonzero, shaping is performed on the virtual circuit. The circuit is limited to the
sum of bc and be , and it is recommended that the sum always be greater than 8000.
Usage Examples
The following example configures the Frame Relay sublink with a committed burst value of 128,000 bits:

(config-fr 1.16)#frame-relay bc 128000

frame-relay be <value>
Use the frame-relay be command to set the be (excessive burst) value for a Frame Relay sublink. The
value is in bits. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the excessive burst value (in bits) for the sublink.
Default Values
By default, the excessive burst value is set to 0 (no limit).
Command History
Functional Notes
The time interval is always one second, so this can also be considered bits per second. Shaping is
performed on a sliding one-second window to make maximum use of configured bandwidth. Note that
when both bc and be are nonzero, shaping is performed on the virtual circuit. The circuit is limited to the
sum of bc and be, and it is recommended that the sum always be greater than 8000.
Usage Examples
The following example configures the Frame Relay sublink with an excessive burst value of 64,000 bits:

(config-fr 1.16)#frame-relay be 64000

frame-relay fragment <value>

Use the frame-relay fragment command to set the FRF.12 fragmentation threshold. Use the no form of
this command to erase the configured threshold.
Syntax Description
<value> Specifies the fragmentation threshold. Valid fragmentation thresholds are
greater than or equal to 64 and less than or equal to 1600.
Default Values
Command History
Functional Notes
For Frame Relay fragmentation to take effect, rate-limiting must be enabled by setting the committed burst
rate and excessive burst rate. Refer to frame-relay bc <value> on page 1778 and frame-relay be <value>
Usage Examples
The following example enables FRF.12 fragmentation on a sublink:

(config-fr 1.16)#frame-relay bc 64000
(config-fr 1.16)#frame-relay be 16
(config-fr 1.16)#frame-relay fragment 100
The following example disables FRF.12 fragmentation on a sublink:

(config-fr 1.16)#no frame-relay fragment

frame-relay interface-dlci <value>

Use the frame-relay interface-dlci command to configure the data link connection identifier (DLCI) for
the Frame Relay subinterface. This setting should match the DLCI supplied by your Frame Relay service
provider. Use the no form of this command to remove the configured DLCI.
Syntax Description
<value> Specifies numeric value of the DLCI supplied by your provider.
Default Values
By default, the DLCI is populated with the subinterface identifier. For example, if configuring the virtual
Frame Relay subinterface labeled fr 1.20, the default DLCI is 20.
Command History
Usage Examples
The following example configures a DLCI of 72 for this Frame Relay endpoint:


Syntax Description
<name> Specifies the IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the router to only allow Telnet traffic into the Frame Relay subinterface:

(config-ext-nacl)#int frame-relay 1.16
(config-fr 1.16)#ip access-group TelnetOnly in

ip address dhcp

Syntax Description
from a DHCP server.
media type).
media types.
delimiters).
obtained via DHCP.

Default Values
formula:
8 7 6 5 4 3 2 1
address:
16 / 0x0401
50 / 0x0C21
60 / 0x0CC1
70 / 0x1061
80 / 0x1401

Command History
subinterface.
Functional Notes
Usage Examples
The following example enables DHCP operation on the virtual Frame Relay interface (labeled 1.16):

(config-fr 1.16)#ip address dhcp
The following example enables DHCP operation on the virtual Frame Relay interface (labeled 1.16)
utilizing host name adtran and does not allow obtaining a default route, domain name, or name servers. It
also sets the administrative distance as 5:

(config-fr 1.16)#ip address dhcp hostname “adtran” no-default-route no-domain-name
no-nameservers 5



Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples

(config-fr 1.16)#ip address 192.22.72.101 255.255.255.252 secondary


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:

(config-fr 1.16)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

ip dhcp
command include:
ip dhcp release
ip dhcp renew
Syntax Description
Default Values
Command History
Usage Examples
The following example releases the IP DHCP address for the virtual interface:

(config-fr 1.16)#ip dhcp release

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface frame-relay 1.16:

(config-fr 1.16)#ip directed-broadcast

ip ffe
ip ffe
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
50:

(config-fr 1.16)#ip ffe max-entries 50

Technology Review
processing layers.

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on a Frame Relay interface to monitor incoming traffic

(config-fr 1.16)#ip flow ingress myacl


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes

Usage Examples

(config-fr 1.16)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
default setting.

Syntax Description
Default Values
Command History
Usage Examples

(config-fr 1.16)#ip igmp last-member-query-interval 200

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Refer to ip mcast-stub helper-address <ip address> on page 883 for more information.
Usage Examples

(config-fr 1.16)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
the ip igmp static-group <address> command (refer to ip igmp on page 1796) to receive multicast traffic
without host-initiated Internet Group Management Protocol (IGMP) activity on the selected interface.
Otherwise, all host-initiated IGMP transactions will enter multicast routes on the router’s interface involved
with IGMP activities.
Usage Examples

(config-fr 1.16)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
Release 10.1 Command was expanded to include the Frame Relay subinterfaces.
Functional Notes
Usage Examples

(config-fr 1.16)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples

(config-fr 1.16)#ip mcast-stub upstream

ip ospf

Syntax Description
1 to 65535.
32767 seconds.
0 to 255.
32767 seconds.
Default Values
hello-interval <seconds> 10 seconds: Ethernet, Frame Relay, Tunnel, and Point-to-Point
Protocol (PPP)

Command History
Usage Examples

(config-fr 1.16)#ip ospf dead-interval 25000

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies that no authentication will be used on the Frame Relay interface:

(config-fr 1.16)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
point-to-point.
Command History
Functional Notes
Usage Examples

(config-fr 1.16)#ip ospf network broadcast

ip pim sparse-mode
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples

(config-fr 1.16)#ip pim sparse-mode


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a priority of 100 on the Frame Relay subinterface:

(config-fr 1.16)#ip pim-sparse dr-priority 100


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies hellos be sent on the Frame Relay subinterface every 3600 seconds:

(config-fr 1.16)#ip pim-sparse hello-timer 3600


Syntax Description
Default Values
Command History
Usage Examples

(config-fr 1.16)#ip pim-sparse nbr-timeout 300


default value.
Syntax Description
65535 milliseconds.
Default Values
Command History
Usage Examples

(config-fr 1.16)#ip pim-sparse override-interval 3000


Syntax Description
Default Values
Command History
Usage Examples
The following example sets the propagation delay to 300 milliseconds on the Frame Relay subinterface:

(config-fr 1.16)#ip pim-sparse propagation-delay 300


Syntax Description
Default Values
Command History
Usage Examples

(config-fr 1.16)#ip policy route-map policy1

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables proxy ARP on the Frame Relay subinterface:

(config-fr 1.16)#ip proxy-arp



Syntax Description
Default Values
Command History
Functional Notes
Use the ip rip receive version command to specify a RIP version that will override the version (in the
Router RIP) configuration.
Usage Examples
The following example configures a Frame Relay subinterface to accept only RIP version 2 packets:

(config-fr 1.16)#ip rip receive version 2

ip rip send version


Syntax Description
Default Values
Command History
Functional Notes
configuration.
Usage Examples
The following example configures a Frame Relay subinterface to transmit only RIP version 2 packets:

(config-fr 1.16)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples

(config-fr 1.16)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables fast-cache switching on a Frame Relay subinterface:

(config-fr 1.16)#ip route-cache

configuration.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the Frame Relay interface (labeled frame-relay 1.16) to use the IP
address assigned to the Ethernet interface (eth 0/1):

(config-fr 1.16)#ip unnumbered eth 0/1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through a Frame Relay subinterface
and matches the URL filter named MyFilter:

(config-fr 1.16)#ip urlfilter MyFilter in

lldp receive
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the Frame Relay subinterface to receive LLDP packets:

(config-fr 1.16)#lldp receive

lldp send
lldp send
Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example configures the Frame Relay subinterface to transmit LLDP packets containing all
enabled information types:

(config-fr 1.16)#lldp send
The following example configures the Frame Relay subinterface to transmit and receive LLDP packets
containing all information types:

(config-fr 1.16)#lldp send-and-receive

media-gateway ip

Syntax Description
loopback interface.
(for example, 10.10.10.1).
Default Values
Command History
Release 17.3 Command was updated with the loopback interface indentification option.
Usage Examples

(config-fr 1.16)#media-gateway ip primary

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes

Usage Examples
The following example specifies an MTU of 1200 on the Frame Relay interface:

(config-fr 1.16)#mtu 1200

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the Frame Relay interface:

(config-fr 1.16)#rtp quality-monitoring

Use the spanning-tree bpdufilter command to block bridge protocol data units (BPDUs) from being
transmitted and received on this interface. To return to the default value, use the no form of this command.

Syntax Description
disable Disables the BPDU filter.
enable Enables the BPDU filter.
Default Values
Command History
Functional Notes
The purpose of this command is to remove a port from participation in the spanning tree. This might be
beneficial while debugging a network setup. It normally should not be used in a live network.
Usage Examples
The following example enables the BPDU filter on the interface:

(config-fr 1.16)#spanning-tree bpdufilter enable

Use the spanning-tree bpduguard command to block bridge protocol data units (BPDUs) from being
received on this interface. To return to the default value, use the no form of this command. Variations of

Syntax Description
disable Disables the BPDU block.
enable Enables the BPDU block.
Default Values
Command History
Usage Examples
The following example enables the BPDU guard on the interface:

(config-fr 1.16)#spanning-tree bpduguard enable

Use the spanning-tree edgeport command to set this interface to be an edgeport. This command overrides
the global setting (refer to spanning-tree edgeport default on page 1105). Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples

(config-fr 1.16)#spanning-tree edgeport

(config-fr 1.16)#spanning-tree edgeport disable
or

(config-fr 1.16)#no spanning-tree edgeport

Use the spanning-tree link-type command to configure the spanning-tree protocol link type for an
interface. To return to the default value, use the no form of this command. Variations of this command
include:

Syntax Description
Default Values
By default, a port is set to auto.
Command History
Functional Notes
This command overrides the default link-type setting determined by the duplex of the individual port. By
use the specified link type. Using the link-type auto command, restores the convention of determining link
Usage Examples
The following example forces the link type to point-to-point, even if the port is configured to be half-duplex:
(config)#bridge 1 protocol ieee

(config-fr 1.16)#spanning-tree link-type point-to-point
Technology Review

spanning-tree path-cost <value>

Use the spanning-tree path-cost command to assign a cost to a bridge group that is used when computing
the spanning-tree root path. To return to the default path-cost value, use the no form of this command.
Syntax Description
<value> Assigns a path-cost value for spanning calculations to the bridge interface.
Default Values
By default, the path-cost value is set at 19.
Command History
Functional Notes
The specified value is inversely proportional to the likelihood the bridge interface will be chosen as the root
path. Set the path-cost value lower to increase the chance the interface will be the root. To obtain the most
accurate spanning-tree calculations, develop a system for determining path costs for links and apply it to
all bridged interfaces.
Usage Examples
The following example assigns a path cost of 100 on a Frame Relay subinterface:

(config-fr 1.16)#spanning-tree path-cost 100
Technology Review
Spanning-tree protocol provides a way to prevent loopback or parallel paths in bridged networks. Using the
priority values and path costs assigned to each bridging interface, the spanning-tree protocol determines
the root path and identifies whether to block or allow other paths.


Use the spanning-tree port-priority command to select the priority level of a port associated with a
bridge. To return to the default bridge-group priority value, use the no form of this command.
Syntax Description
<value> Priority value for the bridge group; the lower the value, the higher the
priority. Valid range is 0 to 255.
Default Values
By default, the bridge-group priority value is set at 28.
Command History
Functional Notes
At that point, the level set in this command will determine which port the bridge will use. Set the priority
value lower to increase the chance the interface will be used.
Usage Examples
The following example sets the maximum priority on the Frame Relay subinterface labeled 1.16:

(config-fr 1.16)#spanning-tree port-priority 0


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide HDLC Interface Command Set
HDLC INTERFACE COMMAND SET
To create a virtual high level data link control (HDLC) interface and/or activate the HDLC Interface
Configuration mode, enter the interface hdlc command at the Global Configuration mode prompt. For
example:
>enable
#configure terminal
(config-hdlc 1)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61

alias link “<text>” on page 1837
bridge-group <value> on page 1839



Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
high level data link control (HDLC) interface 1:

Associate the access policy with the HDLC interface 1:
(config-hdlc 1)#access-policy PRIVATE

alias link “<text>”

Each configured high level data link control (HDLC) interface (when referenced using Signaling Network
Management Protocol (SNMP)) contains a link (physical port) and a bundle (group of links). RFC 1471
(for Link Connection Protocol) provides an interface table to manage lists of bundles and associated links.
The alias link command provides the management station an identifying description for each link (HDLC
physical).
Syntax Description
“<text>” Describes the interface (for SNMP) using an alphanumeric character string
enclosed in quotation marks.
Default Values
By default, the HDLC identification string appears as empty quotation marks (“ ”).
Command History
Functional Notes
The alias link string should be used to uniquely identify an HDLC link. Enter a string that clearly identifies
the link.
Usage Examples
The following example defines a unique character string for the virtual HDLC interface (1):
(config-hdlc 1)#alias link “HDLC_link_1”
Technology Review
Please refer to RFC 1990 for a more detailed discussion on HDLC links and bundles.

bandwidth <value>
Syntax Description
<value> Specifies the bandwidth in kbps. Range is 1 to 4294967295 kbps.
Default Values
To view the default values, use the command show interfaces on page 429.
Command History
Functional Notes
Usage Examples
The following example sets bandwidth of the high level data link control (HDLC) interface to 10 Mbps:
(config-hdlc 1)#bandwidth 10000

bridge-group <value>
Syntax Description
<value> Specifies the bridge group (by number) to which to assign this interface.
Range is 1 to 255.
Default Values
Command History
Functional Notes
be bridged (Ethernet to T1 bridge, Ethernet to Frame Relay subinterface, etc.).
Usage Examples
The following example assigns the high level data link control (HDLC) interface labeled 1 to bridge group 1:
(config-hdlc 1)#bridge-group 1



Syntax Description
Default Values
Command History
Usage Examples
The following example removes the VLAN tags from the packets on the HDLC 1 interface:
(config-hdlc 1)#bridge-group 1 vlan-transparent

crypto map <name>

Syntax Description
<name> Enter the crypto map name that you wish to assign to the interface.
Default Values
Command History
Functional Notes
negotiation for a VPN, keep the following notes in mind.


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the high level data link control
(HDLC) 1 interface:
(config-hdlc 1)#crypto map MyMap

Syntax Description
No subcommands.
Default Values
Command History
Release 5.1 Command was expanded to include the Point-to-Point Protocol (PPP)
interface.
Usage Examples
(config-hdlc 1)#dial-backup auto-backup

Use the dial-backup auto-restore command to configure the interface to automatically discontinue dial
backup when all network conditions are operational. Use the no form of this command to disable the
Syntax Description
No subcommands.
Default Values
condition clears.
Command History
interface.
Usage Examples
condition clears:
(config-hdlc 1)#dial-backup auto-restore


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup backup-delay 60


Syntax Description
Default Values
Command History
interface.
Functional Notes
PPP interface configuration commands. However, the numbers dialed are configured in the primary
interface. Full sample configurations follow:
!
interface eth 0/1
ip address 192.168.1.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1

coding b8zs
framing esf
clock source line
no shutdown
!
no shutdown
!
ip address 10.1.1.2 255.255.255.252
no shutdown
!
interface ppp 1
ip address 172.22.56.1 255.255.255.252
no shutdown
!
ip route 192.168.2.0 255.255.255.0 172.22.56.2 255.255.255.252
!
line telnet 0 4
password password
!
interface eth 0/1
ip address 192.168.100.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1
coding b8zs
framing esf
clock source line


no shutdown
!
no shutdown
!
ip address 10.1.1.1 255.255.255.252
!
interface ppp 1
ip address 172.22.56.2 255.255.255.252
no shutdown
!
ip route 192.168.1.0 255.255.255.0 172.22.56.1 255.255.255.252
line telnet 0 4
password password
Usage Examples
(config-hdlc 1)#dial-backup call-mode originate
(config-hdlc 1)#dial-backup number 555 1111 analog ppp 1

Technology Review
Dialing Out
1853).
negotiation.
Dialing In
down state.


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup connect-timeout 120

dial-backup force
include:

Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup force backup


Syntax Description
is failed.
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup maximum-retry 4


Use the no form of this command to remove a configured dial-backup number. For more detailed
the command dial-backup call-mode on page 1846. Variations of this command include:

Syntax Description
ppp <interface> Specifies the Point-to-Point Protocol (PPP) interface to use as the backup
for this interface (for example, ppp 1).
Default Values
Command History
Release 5.1 Command was expanded to include the PPP interface.
Usage Examples
(config-hdlc 1)#dial-backup number 7045551212 digital-64k 1 1 ppp 1


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup priority 100

Syntax Description
No subcommands.
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup randomize-timers


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup redial-delay 25


Syntax Description
86400 seconds.
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup restore-delay 30


Syntax Description
(00:00).
(00:00).
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup schedule enable-time 08:00
(config-hdlc 1)#dial-backup schedule disable-time 19:00
(config-hdlc 1)#no dial-backup schedule day Saturday
(config-hdlc 1)#no dial-backup schedule day Sunday

Syntax Description
No subcommands.
Default Values
Command History
interface.
Usage Examples
(config-hdlc 1)#dial-backup shutdown

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
and password pass:
(config-hdlc 1)#dynamic-dns dyndns-custom host user pass

fair-queue
fair-queue
fair-queue <value>
Syntax Description
<value> Optional. Value that specifies the maximum number of packets that can be
present in each conversation subqueue. Packets received for a
conversation after this limit is reached are discarded. Range is 16 to
512 packets.
Default Values
By default, fair queue is enabled with a threshold of 64 packets.
Command History
Usage Examples
(config-hdlc 1)#fair-queue 100


Syntax Description
<value> The total number of packets the output queue can contain before packets
are dropped. Range is 16 to 1000 packets.
Default Values
Command History
Usage Examples
(config-hdlc 1)#hold-queue 700 out

Syntax Description
<name> Assigned IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the unit to only allow Telnet traffic (as defined in the user-configured
TelnetOnly IP ACL) into the high level data link control (HDLC) interface:

(config-ext-nacl)#int hdlc 1
(config-hdlc 1)#ip access-group TelnetOnly in


Use the ip address command to define an IP address on the specified interface. Use the no form of this
command to remove a configured IP address. Variations of this command include:

Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
The following example configures a secondary IP address of 192.22.72.101 /30:
(config-hdlc 1)#ip address 192.22.72.101 255.255.255.252 secondary


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:
(config-hdlc 1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface hdlc 1:
(config-hdlc 1)#ip directed-broadcast

ip ffe
ip ffe
Syntax Description
Default Values
Command History
Release 17.6 Command was expanded to include the tunnel and high level data link
control (HDLC) interface.
Functional Notes
Usage Examples
50:
(config-hdlc 1)#ip ffe max-entries 50

Technology Review
processing layers.

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on an high level data link control (HDLC) interface to
monitor incoming traffic through an ACL called myacl:
(config-hdlc 1)#ip flow ingress myacl


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes

Usage Examples
IP address 192.33.5.99:

(config-hdlc 1)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
default setting.

Syntax Description
Default Values
Command History
Usage Examples
(config-hdlc 1)#ip igmp last-member-query-interval 200

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables multicast forwarding and IGMP on the high level data link control (HDLC)
interface:
(config-hdlc 1)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-hdlc 1)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
Release 10.1 Command was expanded to include high level data link control (HDLC)
interfaces.
Functional Notes
Usage Examples
(config-hdlc 1)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables multicast forwarding on the high level data link control (HDLC) interface:
(config-hdlc 1)#ip mcast-stub upstream

ip ospf

Syntax Description
1 to 65535.
32767 seconds.
0 to 255.
32767 seconds.
Default Values
Protocol (PPP)

Command History
Usage Examples
(config-hdlc 1)#ip ospf dead-interval 25000

Syntax Description
message-digest Optional. Select message-digest authentication type.
Default Values
Command History
Usage Examples
The following example specifies that no authentication will be used on the high level data link control
(HDLC) interface:
(config-hdlc 1)#ip ospf authentication null

ip ospf network

Syntax Description
broadcast Set the network type for broadcast.
point-to-point Set the network type for point-to-point.
Default Values
By default, Ethernet defaults to broadcast. All other interfaces default to point-to-point.
Command History
Functional Notes
Usage Examples
(config-hdlc 1)#ip ospf network broadcast

ip pim sparse-mode
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables PIM sparse mode on the high level data link control (HDLC) 1 interface:
(config-hdlc 1)#ip pim sparse-mode


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a priority of 100 on the high level data link control (HDLC) 1 interface:
(config-hdlc 1)#ip pim-sparse dr-priority 5


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies hellos be sent on the high level data link control (HDLC) 1 interface every
3600 seconds:
(config-hdlc 1)#ip pim-sparse hello-timer 3600


Syntax Description
Default Values
Command History
Usage Examples
(config-hdlc 1)#ip pim-sparse nbr-timeout 300


default value.
Syntax Description
65535 milliseconds.
Default Values
Command History
Usage Examples
(config-hdlc 1)#ip pim-sparse override-interval 3000


Syntax Description
Default Values
Command History
Usage Examples
The following example sets the expected propagation delay to 300 milliseconds on the high level data link
control (HDLC) 1 interface:
(config-hdlc 1)#ip pim-sparse propagation-delay 300


Syntax Description
Default Values
Command History
Usage Examples
The following example assigns the policy route map policy1 to the high level data link control (HDLC) 1
interface:
(config-hdlc 1)#ip policy route-map policy1

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables proxy ARP on the high level data link control (HDLC) interface:
(config-hdlc 1)#ip proxy-arp



Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the high level data link control (HDLC) interface to accept only RIP
version 2 packets:
(config-hdlc 1)#ip rip receive version 2

ip rip send version


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the high level data link control (HDLC) interface to transmit only RIP
version 2 packets:
(config-hdlc 1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
(config-hdlc 1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
By default, fast caching is enabled on all interfaces.
Command History
Functional Notes
Usage Examples
The following example enables fast switching on the high level data link control (HDLC) interface:
(config-hdlc 1)#ip route-cache

configuration.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the high level data link control (HDLC) interface to use the IP address
assigned to the Ethernet interface 0/1:
(config-hdlc 1)#ip unnumbered eth 0/1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through the high level data link control
(HDLC) interface and matches the URL filter named MyFilter:
(config-hdlc 1)#ip urlfilter MyFilter in

keepalive <value>
default setting.
Syntax Description
packets. Valid range is 0 to 32767 seconds.
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a keepalive time of 5 seconds on the high level data link control (HDLC)
interface:
(config-hdlc 1)#keepalive 5

lldp receive
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the high level data link control (HDLC) interface to receive LLDP
packets:
(config-hdlc 1)#lldp receive

lldp send
lldp send
Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example configures the high level data link control (HDLC) interface to transmit LLDP
packets containing all enabled information types:
(config-hdlc 1)#lldp send
The following example configures the HDLC to transmit and receive LLDP packets containing all
information types:
(config-hdlc 1)#lldp send-and-receive

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies 85 percent of the bandwidth on the high level data link control (HDLC) 1
be available for use in user-defined queues:
(config-hdlc 1)#max-reserved-bandwidth 85

media-gateway ip

Syntax Description
loopback interface.
(for example, 10.10.10.1).
Default Values
Command History
Usage Examples
(config-hdlc 1)#media-gateway ip primary

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes

Usage Examples
The following example specifies an MTU of 1200 on the high level data link control (HDLC) interface:
(config-hdlc 1)#mtu 1200

qos-policy
Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example applies the QoS map VOICEMAP to the high level data link control (HDLC)
interface:
(config-hdlc 1)#qos-policy out VOICEMAP

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the high level data link control (HDLC) interface:
(config-hdlc 1)#rtp quality-monitoring


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Usage Examples
The following example disables the link-status trap on the HDLC interface:
(config-hdlc 1)#no snmp trap link-status


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide Loopback Interface Command Set
LOOPBACK INTERFACE COMMAND SET
To create a virtual loopback interface and/or activate the Loopback Interface Configuration mode, enter
the interface loopback command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-loop 1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61


Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
loopback interface 1:

Associate the access policy with the loopback interface 1:
(config-loop 1)#access-policy PRIVATE

bandwidth <value>
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example sets bandwidth of the loopback interface to 10 Mbps:
(config-loop 1)#bandwidth 10000

crypto map <name>

Syntax Description
Default Values
Command History
Functional Notes
negotiation for VPN, keep the following information in mind:


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the loopback interface:
(config-loop 1)#crypto map MyMap

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
and password pass:
(config-loop 1)#dynamic-dns dyndns-custom host user pass

Syntax Description
<name> Specifies IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the router to allow only Telnet traffic into the loopback interface:

(config-ext-nacl)#interface loopback 1
(config-loop 1)#ip access-group TelnetOnly in



Syntax Description
example, /24).
Default Values
Command History
Release 2.1 Added ip address dhcp for Dynamic Host Configuration Protocol (DHCP)
client support.
Functional Notes
secondary subnet.
Usage Examples
(config-loop 1)#ip address 192.22.72.101 255.255.255.252 secondary


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:
(config-loop 1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface loopback 1:
(config-loop 1)#ip directed-broadcast

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on a loopback interface to monitor incoming traffic
(config-loop 1)#ip flow ingress myacl


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes

Usage Examples

(config-loop 1)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
default setting.

Syntax Description
Default Values
Command History
Usage Examples
(config-loop 1)#ip igmp last-member-query-interval 200

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-loop 1)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-loop 1)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
Release 10.1 Command was expanded to include the loopback interfaces.
Functional Notes
Usage Examples
(config-loop 1)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-loop 1)#ip mcast-stub upstream

ip ospf

Syntax Description
1 to 65535.
seconds.
0 to 255.
32767 seconds.
Default Values
Protocol (PPP)

Command History
Usage Examples
(config-loop 1)#ip ospf dead-interval 25000


Syntax Description
message-digest Optional. Specifies the message-digest authentication type.
null Optional. Specifies for no authentication to be used.
Default Values
Command History
Usage Examples
The following example specifies that no authentication will be used on the loopback interface:
(config-loop 1)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
point-to-point.
Command History
Functional Notes
Usage Examples
(config-loop 1)#ip ospf network broadcast

ip pim sparse-mode
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-loop 1)#ip pim sparse-mode


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a priority of 100 on the loopback 1 interface:
(config-loop 1)#ip pim-sparse dr-priority 100


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies hellos be sent on the loopback 1 interface every 3600 seconds:
(config-loop 1)#ip pim-sparse hello-timer 3600


Syntax Description
Default Values
By default, the PIM sparse neighbor timeout is set to 105 seconds.
Command History
Usage Examples
(config-loop 1)#ip pim-sparse nbr-timeout 300


default value.
Syntax Description
65535 milliseconds.
Default Values
Command History
Usage Examples
(config-loop 1)#ip pim-sparse override-interval 3000


Syntax Description
Default Values
Command History
Usage Examples
(config-loop 1)#ip pim-sparse propagation-delay 300


Syntax Description
Default Values
Command History
Usage Examples
(config-loop 1)#ip policy route-map policy1

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
If proxy-arp is enabled, AOS will respond to all proxy-arp requests with its specified medium access control
(MAC) address and forward packets accordingly.
Enabling proxy-arp on an interface may introduce unnecessary ARP traffic on the network.
Usage Examples
The following example enables proxy ARP on the loopback interface:
(config-loop 1)#ip proxy-arp


unit accepts in all RIP packets received on the interface. Use the no form of this command to return to the

Syntax Description
Default Values
Command History
Functional Notes
configuration.
Usage Examples
The following example configures the loopback interface to accept only RIP version 2 packets:
(config-loop 1)#ip rip receive version 2

ip rip send version

unit sends in all RIP packets transmitted on the interface. Use the no form of this command to return to the

Syntax Description
Default Values
Command History
Functional Notes
configuration.
Usage Examples
The following example configures the loopback interface to transmit only RIP version 2 packets:
(config-loop 1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
(config-loop 1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
By default, fast-cache switching is enabled on all Ethernet and virtual Frame Relay subinterfaces. IP
route-cache is enabled for all virtual Point-to-Point Protocol (PPP) interfaces.
Command History
Functional Notes
Usage Examples
The following example enables fast switching on the loopback interface:
(config-loop 1)#ip route-cache

configuration.
Syntax Description
dot11ap 1/1.1. Type ip unnumbered ? for a complete list of valid
interfaces.
Default Values
Command History
Functional Notes
taken from the specified interface. For example, specifying ip unnumbered ppp 1 while in the Ethernet
Interface Configuration mode configures the Ethernet interface to use the IP address assigned to the
Point-to-Point Protocol (PPP) interface for all IP processing. In addition, AOS uses the specified interface
Usage Examples
The following example configures the loopback interface (labeled loop 1) to use the IP address assigned
to the PPP interface (ppp 1):
(config-loop 1)#ip unnumbered ppp 1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through the loopback interface (labeled
loop 1) and matches the URL filter named MyFilter:
(config-loop 1)#ip urlfilter MyFilter in

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes

Usage Examples
The following example specifies an MTU of 1200 on the loopback interface:
(config-loop 1)#mtu 1200

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the loopback interface:
(config-loop 1)#rtp quality-monitoring

snmp trap
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP capability on the loopback interface:
(config-loop 1)#snmp trap


Syntax Description
No subcommands.
Default Values
Command History
Release 7.1 Command was expanded to the high speed serial interface (HSSI)
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the loopback interface:
(config-loop 1)#no snmp trap link-status


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide Port Channel Interface Command Set
PORT CHANNEL INTERFACE COMMAND SET
To create a virtual link aggregation interface and/or activate the Port Channel Interface Configuration
mode, enter the interface port-channel command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-p-chan1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61

qos on page 1960
spanning tree commands begin on page 1963
storm-control action shutdown on page 1969
storm-control on page 1970
switchport commands begin on page 1972

arp arpa
Syntax Description
No subcommands.
Default Values
The default for this command is arpa.
Command History
Usage Examples
The following example enables standard ARP for the port channel interface:
(config-p-chan1)#arp arpa

lldp receive
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the port channel interface to receive LLDP packets:
(config-p-chan1)#lldp receive

lldp send

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example configures the port channel interface to transmit LLDP packets containing all
enabled information types:
(config-p-chan1)#lldp send
The following example configures the port channel interface to transmit and receive LLDP packets
containing all information types:
(config-p-chan1)#lldp send-and-receive

qos
Use the qos command to set the interface to the trusted state and to set the default class of service (CoS)
value. Use the no form of this command to return to the default setting. Variations of this command
include:
qos default-cos <value>

qos trust cos
Syntax Description
default-cos <value> Sets the default CoS value for untrusted ports and all untagged packets.
Range is 0 to 7.
trust cos Sets the interface to the trusted state.
Default Values
By default, the interface is untrusted with a default CoS of 0.
Command History
Functional Notes
Set the interface to trust cos if received 802.1P. CoS values are considered valid (i.e., no need to
reclassify) and do not need to be tagged with the default value. When set to untrusted, the default-cos
value for the interface is used.
Usage Examples
The following example sets port channel 1 as a trusted interface and assigns untagged packets a CoS
value of 1:
(config-p-chan1)#qos trust cos
(config-p-chan1)#qos default-cos 1

snmp trap
traps on the interface. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP capability on the port channel interface:
(config-p-chan1)#snmp trap


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the port channel interface:
(config-p-chan1)#no snmp trap link-status

Use the spanning-tree bpdufilter command to enable or disable the bridge protocol data unit (BPDU)
filter on a specific interface. This setting overrides the related global setting (refer to spanning-tree
edgeport default on page 1105). Use the no form of this command to return to the default setting.

Syntax Description
disable Disables BPDU filter for this interface.
enable Enables BPDU filter for this interface.
Default Values
Command History
Functional Notes
The bpdufilter blocks any BPDUs from being transmitted and received on an interface.
Usage Examples
The following example enables the BPDU filter on the port channel interface:
(config-p-chan3)#spanning-tree bpdufilter enable
The BPDU filter can be disabled on port channel 3 by issuing the following commands:
(config-p-chan3)#spanning-tree bpdufilter disable

Use the spanning-tree bpduguard command to enable or disable the bridge protocol data unit (BPDU)
guard on a specific interface. This setting overrides the related global setting (refer to spanning-tree
edgeport default on page 1105). Use the no form of this command to return to the default setting.

Syntax Description
disable Disables BPDU guard for this interface.
enable Enables BPDU guard for this interface.
Default Values
Command History
Functional Notes
The bpduguard blocks any BPDUs from being received on an interface.
Usage Examples
The following example enables the BPDU guard on the port channel interface:
(config-p-chan3)#spanning-tree bpduguard enable
The BPDU guard can be disabled on port channel 3 by issuing the following commands:
(config-p-chan3)#spanning-tree bpduguard disable

spanning-tree cost <value>

Use the spanning-tree cost command to assign a cost to the interface. The cost value is used when
computing the spanning-tree root path. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies a cost value of 1 to 200000000.
Default Values
By default, the cost value is set to 1000/(link speed in Mbps).
Command History
Usage Examples
The following example sets the interface to a path cost of 1200:
(config-p-chan3)#spanning-tree cost 1200

Use the spanning-tree edgeport command to configure the interface to be an edgeport. This command
overrides the global setting (refer to spanning-tree edgeport default on page 1105). Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Enabling this command configures the interface to go to a forwarding state when the link goes up.
Usage Examples
(config-p-chan1)#spanning-tree edgeport
(config-p-chan1)#spanning-tree edgeport disable
or
(config-p-chan1)#no spanning-tree edgeport

Use the spanning-tree link-type command to configure the spanning tree protocol link type for each
include:

Syntax Description
Default Values
By default, the interface is set to auto.
Command History
Functional Notes
This command overrides the default link type setting determined by the duplex of the individual port. By
use the specified link type. Use the link-type auto command to restore the convention of determining link
Usage Examples
The following example forces the link type to point-to-point, even if the port is configured to be
half-duplex:
(config-p-chan1)#spanning-tree link-type point-to-point
Technology Review
not connected to any additional bridges). Setting the link type to point-to-point allows a half-duplex link to
act as if it were a point-to-point link.


Use the spanning-tree port-priority command to select the priority level of this interface. To return to the
default setting, use the no form of this command.
Syntax Description
<value> Specifies a priority-level value from 0 to 240 (this value must be in
increments of 16).
Default Values
By default, the spanning-tree port-priority is set to 128.
Command History
Functional Notes
At that point, the level set in this command will determine which port the spanning tree will use. Set the
priority value lower to increase the chance the interface will be used.
Usage Examples
The following example sets the interface to a priority of 96:
(config-p-chan4)#spanning-tree port-priority 96

storm-control action shutdown

Use the storm-control action shutdown command to specify that the unit should shutdown when a
broadcast, multicast, or unicast storm occurs. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, this command is disabled; the interface will only filter traffic.
Command History
Functional Notes
Enabling this option shuts down the interface if a multicast, unicast, or broadcast storm occurs.
Usage Examples
The following example shuts down the port channel interface if a storm is detected:
(config-p-chan1)#storm-control action shutdown

storm-control
Use the storm-control command to configure limits on the rates of broadcast, multicast, and unicast traffic
on a port. Use the no form of this command to disable this feature. Variations of this command include:
storm-control broadcast level <rising level>

storm-control broadcast level <rising level> <falling level>
storm-control multicast level <rising level>
storm-control multicast level <rising level> <falling level>
storm-control unicast level <rising level>
storm-control unicast level <rising level> <falling level>
Syntax Description
broadcast level Sets levels for broadcast traffic.
multicast level Sets levels for multicast traffic.
unicast level Sets levels for unicast traffic.
<rising level> Specifies a rising level which determines the percentage of total bandwidth
the port accepts before it begins blocking packets. Range is 1 to 100
percent.
<falling level> Optional. Specifies a falling level which determines when the storm is
considered over, causing AOS to no longer block packets. This level must
be less than the rising level. Range is 1 to 100 percent.
Default Values
By default, storm-control is disabled.
Command History
Functional Notes
This setting configures the rising and falling suppression values. When the selected rising level (which is a
percentage of total bandwidth) is reached, the port begins blocking packets of the specified type (i.e.,
broadcast, multicast, or unicast). AOS uses the rising level as its falling level if no falling level is specified.

Usage Examples
The following example sets the rising suppression level to 85 percent for multicast packets:
(config-p-chan1)#storm-control multicast level 85
The following example sets the rising suppression level to 80 percent for broadcast packets, with a falling
level of 50 percent:
(config-p-chan1)#storm-control broadcast level 80 50

switchport access vlan <vlan id>

Use the switchport access vlan command to set the port to be a member of the virtual local area network
(VLAN) when in access mode. To reset the port to be a member of the default VLAN, use the no form of
this command.
Syntax Description
Default Values
By default, this is set to VLAN 1 (the default VLAN).
Command History
Functional Notes
If the port is in the trunk mode, this command will not alter the switchport mode to access. Instead, it will
save the value to be applied when the port does switch to access mode. Refer to switchport mode on page
Usage Examples
The following example sets the switchport mode to static access, and makes the port channel 1 a member
of VLAN 2:
(config-p-chan1)#switchport mode access
(config-p-chan1)#switchport access vlan 2

switchport gvrp
Use the switchport gvrp command to enable GARP VLAN Registration Protocol (GVRP) on an interface.
Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, GVRP is disabled on all ports.
Command History
Functional Notes
Enabling GVRP on any interface enables GVRP globally.
Usage Examples
The following example enables GVRP on port channel 3:
(config-p-chan3)#switchport gvrp

switchport mode
Use the switchport mode command to configure the virtual local area network (VLAN) membership
mode. To reset membership mode to the default value, use the no form of this command. Variations of this
command include:
switchport mode access

switchport mode trunk
Syntax Description
access Sets port to be a single (nontrunked) port that transmits and receives no
tagged packets.
trunk Sets port to transmit and receive packets on all VLANs included within its
VLAN allowed list.
Default Values
By default, this is set to access.
Command History
Usage Examples
The following example sets the port to be a trunk port:
(config-p-chan1)#switchport mode trunk

switchport trunk allowed vlan

Use the switchport trunk allowed vlan command to allow certain virtual local area networks (VLANs) to
transmit and receive traffic on this port when the interface is in trunking mode. To return to the default
setting, use the no form of this command. Variations of this command include:
switchport trunk allowed vlan <list>

switchport trunk allowed vlan add <list>
switchport trunk allowed vlan all
switchport trunk allowed vlan except <list>
switchport trunk allowed vlan remove <list>
Syntax Description
add Adds the specified VLAN IDs to the VLAN trunking allowed list.
all Adds all configured VLAN IDs to the VLAN trunking allowed list.
except Adds all configured VLAN IDs to the VLAN trunking allowed list except
those specified in the VLAN ID list.
remove Removes VLAN IDs from the VLAN trunking allowed list.
<list> Specifies a list of valid VLAN interface IDs. Refer to Functional Notes below
for additional syntax considerations.
Default Values
By default, all valid VLANs are allowed.
Command History
Functional Notes
A VLAN list is a set of VLAN IDs. A valid VLAN ID value must be from 1 to 4094 (inclusive). Each VLAN ID
in a list is delimited by commas, yet a range of IDs may be expressed as a single element by using a
hyphen between endpoints. For example, the VLAN ID range 1,2,3,4,6,7,8,9,500 may be more easily
expressed as 1-4,6-9,500. No spaces are allowed in a valid ID range.
Usage Examples
The following example adds VLANs to the previously existing list of VLANs allowed to transmit and receive
on this port:
(config-p-chan1)#switchport trunk allowed vlan add 1-4,6-9,500

switchport trunk fixed vlan

Use the switchport trunk fixed vlan command to change the configured list of virtual local area networks
(VLANs) that remain fixed in use only when GARP VLAN Registration Protocol (GVRP) is enabled on
the interface. Of these VLANs, VLANs statically or dynamically created will be available for use on the
include:
switchport trunk fixed vlan <list>

switchport trunk fixed vlan add <list>
switchport trunk fixed vlan all
switchport trunk fixed vlan except <list>
switchport trunk fixed vlan none
switchport trunk fixed vlan remove <list>
Syntax Description
add Adds VLANs to the VLAN GVRP trunking fixed list.
all Adds all VLANs to the VLAN GVRP trunking fixed list.
except Adds all VLAN IDs to the VLAN trunking fixed list except those in the
command line VLAN ID list.
none Removes all VLANs from the VLAN GVRP trunking fixed list.
remove Removes VLAN from the VLAN trunking fixed list.
<list> Specifies a list of valid VLAN interface IDs. Refer to Functional Notes below
for additional syntax considerations.
Default Values
By default, no VLANs are in the VLAN GVRP trunking fixed list (switchport trunk fixed vlan none).
Command History
Functional Notes
This command has no effect on VLAN membership configuration unless GVRP is enabled on the interface.
Refer to gvrp on page 809 for information on enabling GVRP.
A VLAN list is a set of VLAN IDs. A valid VLAN ID value must be from 1 to 4094 (inclusive). Each VLAN ID
in a list is delimited by commas, yet a range of IDs may be expressed as a single element by using a
hyphen between endpoints. For example, the VLAN ID range 1,2,3,4,6,7,8,9,500 may be more easily
expressed as 1-4,6-9,500. No spaces are allowed in a valid ID range.

Usage Examples
The following example changes the configured list of fixed VLANs by adding VLAN 50 to the list:
(config-p-chan1)#switchport trunk fixed vlan add 1-15,25-30,40

(config-p-chan1)#
(config-p-chan1)#switchport trunk fixed vlan add 50
(config-p-chan1)#

switchport trunk native vlan <vlan id>

Use the switchport trunk native vlan command to set the virtual local area network (VLAN) native to the
interface when the interface is in trunking mode. To return to defaults, use the no form of this command.
Syntax Description
Default Values
By default, switchport trunk native vlan is set to VLAN 1.
Command History
Functional Notes
Configure which VLAN the interface uses as its native VLAN during trunking. Packets from this VLAN
leaving the interface will not be tagged with the VLAN number. Any untagged packets received by the
interface are considered a part of the native VLAN ID.
Usage Examples
The following example sets the native VLAN on port channel 1 to VLAN 2:
(config-p-chan1)#switchport trunk native vlan 2

Command Reference Guide PPP Interface Command Set
PPP INTERFACE COMMAND SET
To create a virtual Point-to-Point Protocol (PPP) interface and/or activate the PPP Interface Configuration
mode, enter the interface ppp command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-ppp 1)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61

acfc accept-compressed on page 1982
alias link “<text>” on page 1983
bridge-group commands begin on page 1985
ppp commands begin on page 2054

pppoe ac-name <name> on page 2064

pppoe service-name <name> on page 2065

Use the access-policy command to assign a specified access policy to an interface. Access policies are
applied to traffic entering an interface. Use the no form of this command to remove an access policy
association. For more information on using access policies, refer to ip policy-class <name> on page 900.
Configured access policies will only be active if the ip firewall command has been entered
at the Global Configuration mode prompt to enable the AOS security features. All
configuration parameters are valid, but no security data processing will be attempted
unless the security features are enabled.
Syntax Description
<name> Identifies the configured access policy by alphanumeric descriptor (all
access policy descriptors are case sensitive).
Default Values
By default, there are no configured access policies associated with an interface.
Command History
interfaces.
Functional Notes
To assign an access policy to an interface, enter the interface configuration mode for the desired interface
and enter access-policy <name>.
Usage Examples
The following example associates the access policy Private (to allow inbound traffic to the Web server) to
the Point-to-Point Protocol (PPP) interface 1:

Associate the access policy with the PPP interface 1:
(config-ppp 1)#access-policy Private

acfc accept-compressed
Use the acfc accept-compressed command to enable accepting header compressed frames even if
compression is not negotiated. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables accepting compressed frames:
(config-ppp 1)#acfc accept-compressed

alias link “<text>”

Use the alias link command to provide the management station with an identifying description for each
link (Point-to-Point Protocol (PPP) physical). Each configured PPP interface (when referenced using
Simple Network Management Protocol (SNMP)) contains a link (physical port) and a bundle (group of
links). RFC 1471 (for Link Connection Protocol) provides an interface table to manage lists of bundles and
associated links. Use the no form of this command to return to the default setting.
Syntax Description
“<text>” Describes the interface (for SNMP) by alphanumeric character string (must
be encased in quotation marks).
Default Values
By default, the PPP identification string appears as empty quotation marks (“ ”).
Command History
Functional Notes
The alias link string should be used to uniquely identify a PPP link. Enter a string that clearly identifies the
link.
Usage Examples
The following example defines a unique character string for the virtual PPP interface (1):
(config-ppp 1)#alias link “PPP_link_1”
Technology Review
Please refer to RFC 1990 for a more detailed discussion on PPP links and bundles.

bandwidth <value>
Syntax Description
<value> Specifies the bandwidth value in kbps. Range is 1 to 4294967295 kbps.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets bandwidth of the Point-to-Point Protocol (PPP) interface to 10 Mbps:
(config-ppp 1)#bandwidth 10000

Use the bridge-group command to assign an interface to the specified bridge group. This command is
supported on all Ethernet interfaces, Point-to-Point Protocol (PPP) virtual interfaces, and Frame Relay
virtual subinterfaces. Use the no form of this command to remove an interface.
Syntax Description
<number> Specifies the bridge group (by number) to which to assign this interface.
Range is 1 to 255.
Default Values
Command History
Functional Notes
be bridged (Ethernet to T1 bridge, Ethernet to Frame Relay subinterface, etc.).
Usage Examples
The following example assigns the PPP interface to bridge-group 1:
(config-ppp 1)#bridge-group 1



Syntax Description
Default Values
Command History
Usage Examples
The following example prevents the removal of VLAN tags from the packets on the Point-to-Point Protocol
(PPP) interface labeled 1:
(config-ppp 1)#bridge-group 1 vlan-transparent

crypto map <name>

Syntax Description
Default Values
Command History
Functional Notes


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the Point-to-Point Protocol (PPP)
interface:
(config-ppp 1)#crypto map MyMap

Syntax Description
No subcommands.
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup auto-backup

Syntax Description
No subcommands.
Default Values
condition clears.
Command History
interface.
Usage Examples
condition clears:
(config-ppp 1)#dial-backup auto-restore


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup backup-delay 60


Syntax Description
Default Values
Command History
interface.
Functional Notes
!
interface eth 0/1
ip address 192.168.1.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1

coding b8zs
framing esf
clock source line
no shutdown
!
no shutdown
!
ip address 10.1.1.2 255.255.255.252
no shutdown
!
interface ppp 1
ip address 172.22.56.1 255.255.255.252
username remoter outer password remotepass
no shutdown
!
ip route 192.168.2.0 255.255.255.0 172.22.56.2 255.255.255.252
!
line telnet 0 4
password password
!
interface eth 0/1
ip address 192.168.100.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1
coding b8zs
framing esf
clock source line


no shutdown
!
no shutdown
!
ip address 10.1.1.1 255.255.255.252
!
interface ppp 1
ip address 172.22.56.2 255.255.255.252
no shutdown
!
ip route 192.168.1.0 255.255.255.0 172.22.56.1 255.255.255.252
line telnet 0 4
password password
Usage Examples
(config-ppp 1)#dial-backup call-mode originate
(config-ppp 1)#dial-backup number 555 1111 analog ppp 2

Technology Review
Dialing Out
1999).
negotiation.
Dialing In
down state.


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup connect-timeout 120

dial-backup force
include:

Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup force backup


Syntax Description
<value> Selects the number of call retries that will be made after a link failure. Valid
range is 0 to 15 attempts.
is failed.
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup maximum-retry 4


Use the no form of this command to return to the default setting. For more detailed information on

Syntax Description
Default Values
Command History
Usage Examples
dial-backup operation for this endpoint using interface ppp 3 backup interface:
(config-ppp 1)#dial-backup number 7045551212 digital-64k 1 1 ppp 3


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup priority 100

Syntax Description
No subcommands.
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup randomize-timers


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup redial-delay 25


Syntax Description
86400 seconds.
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup restore-delay 30


Syntax Description
disable-time <value> Sets the time of day to disable backup. Time is entered in a 24-hour
format (00:00).
enable-time <value> Sets the time of day to enable backup. Time is entered in a 24-hour
format (00:00).
Default Values
Command History
interface.
Usage Examples
(config-ppp 1)#dial-backup schedule enable-time 08:00
(config-ppp 1)#dial-backup schedule disable-time 19:00
(config-ppp 1)#no dial-backup schedule day Saturday
(config-ppp 1)#no dial-backup schedule day Sunday

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
and password pass:
(config-ppp 1)#dynamic-dns dyndns-custom host user pass

fair-queue
fair-queue
fair-queue <threshold>
Syntax Description
<threshold> Optional. Specifies the maximum number of packets that can be present in
limit is reached are discarded. Range is 16 to 512 packets.
Default Values
Command History
Usage Examples
(config-ppp 1)#fair-queue 100


Syntax Description
Default Values
Command History
Usage Examples
(config-ppp 1)#hold-queue 700 out

Syntax Description
<name> Indicates the assigned IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the router to only allow Telnet traffic into the Point-to-Point Protocol (PPP)
interface:

(config-ext-nacl)#interface ppp 1
(config-ppp 1)#ip access-group TelnetOnly in

ip address dhcp
DHCP) and disable DHCP operation on the interface. Variations of this command include:
ip address dhcp
ip address dhcp <administrative distance>
ip address dhcp track <name>
ip address dhcp track <name> <administrative distance>
Syntax Description
Default Values
By default, the administrative distance value is 1.
Command History
interface.
Usage Examples
The following example enables DHCP operation on the PPP interface 1:
(config-ppp 1)#ip address dhcp
The following example enables DHCP operation on the PPP interface 1 and sets the administrative
distance as 5:
(config-ppp 1)#ip address dhcp 5

Use the ip address negotiated command to allow the interface to negotiate (i.e., be assigned) an IP
address from the far-end Point-to-Point Protocol (PPP) connection. Use the no form of this command to
disable the negotiation for an IP address. Variations of this command include:
ip address negotiated <administrative distance>
ip address negotiated <ip address>
ip address negotiated <ip address> no-default
ip address negotiated track <name>
ip address negotiated track <name> <administrative distance>
Syntax Description
<administrative distance> Optional. Specifies the administrative distance to use when adding the PPP
route to the route table. It is used to determine the best route when multiple
routes to the same destination exist. The smaller the administrative
distance, the more reliable the route. Range is 1 to 255.
no-default Optional. Prevents the insertion of a default route. Some systems already
have a default route configured and need a static route to the PPP interface
to function correctly.
track <name> Optional. Attaches a network monitoring track to the PPP interface. The
negotiated default route for this client will only reside in the route table while
Default Values
By default, the interface is not assigned an address.
Also by default, the administrative distance value is 1.
Command History

Usage Examples
The following example enables the PPP interface to negotiate an IP address from the far-end connection:
(config-ppp 1)#ip address negotiated
The following example enables the PPP interface to negotiate an IP address from the far-end connection
without inserting a default route:
(config-ppp 1)#ip address negotiated no-default


Use the ip address command to define an IP address on the specified interface. Use the optional keyword
secondary to define a secondary IP address. Use the no form of this command to remove a configured IP

Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
(config-ppp 1)#ip address 192.22.72.101 255.255.255.252 secondary


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:
(config-ppp 1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface ppp 1:
(config-ppp 1)#ip directed-broadcast

ip ffe
ip ffe
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
50:
(config-ppp 1)#ip ffe max-entries 50

Technology Review
processing layers.

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on a Point-to-Point Protocol (PPP) interface to monitor
incoming traffic through an ACL called myacl:
(config-ppp 1)#ip flow ingress myacl


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes
Usage Examples
IP address 192.33.5.99:

(config-ppp 1)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
default setting.

Syntax Description
Default Values
Command History
Usage Examples
(config-ppp 1)#ip igmp last-member-query-interval 200

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-ppp 1)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-ppp 1)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
(config-ppp 1)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Internet Group Management Protocol (IGMP) proxy. Though multiple interfaces may be candidates, no
more than one interface will actively serve as the helper forwarding interface. Refer to ip mcast-stub
helper-address <ip address> on page 883 and ip mcast-stub downstream on page 2023 for more
information.
Usage Examples
(config-ppp 1)#ip mcast-stub upstream

ip ospf

Syntax Description
1 to 65535.
seconds.
0 to 255.
32767 seconds.
Default Values
Protocol (PPP)

Command History
Usage Examples
(config-ppp 1)#ip ospf dead-interval 25000

Syntax Description
Default Values
By default, ip ospf authentication is set to null (meaning no authentication is used).
Command History
Usage Examples
The following example specifies that no authentication will be used on the Point-to-Point Protocol (PPP)
interface:
(config-ppp 1)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
point-to-point.
Command History
Functional Notes
Usage Examples
(config-ppp 1)#ip ospf network broadcast

ip pim sparse-mode
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-ppp 1)#ip pim sparse-mode


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a priority of 100 on the Point-to-Point Protocol (PPP) 1 interface:
(config-ppp 1)#ip pim-sparse dr-priority 100


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies hellos be sent on the Point-to-Point Protocol (PPP) 1 interface every 3600
seconds:
(config-ppp 1)#ip pim-sparse hello-timer 3600


Syntax Description
Default Values
Command History
Usage Examples
(config-ppp 1)#ip pim-sparse nbr-timeout 300


default value.
Syntax Description
65535 milliseconds.
Default Values
Command History
Usage Examples
(config-ppp 1)#ip pim-sparse override-interval 3000


Syntax Description
Default Values
Command History
Usage Examples
(config-ppp 1)#ip pim-sparse propagation-delay 300


Syntax Description
Default Values
Command History
Usage Examples
(config-ppp 1)#ip policy route-map policy1

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables proxy ARP on the virtual Point-to-Point Protocol (PPP) interface:
(config-ppp 1)#ip proxy-arp



Syntax Description
Default Values
Command History
Functional Notes
configuration.
Usage Examples
The following example configures the virtual Point-to-Point Protocol (PPP) interface to accept only RIP
version 2 packets:
(config-ppp 1)#ip rip receive version 2

ip rip send version


Syntax Description
Default Values
Command History
Functional Notes
configuration.
Usage Examples
The following example configures the virtual Point-to-Point Protocol (PPP) interface to transmit only RIP
version 2 packets:
(config-ppp 1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
(config-ppp 1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Fast-cache switching allows an IP interface to provide optimum performance when processing IP traffic.
Usage Examples
The following example enables fast-cache switching on the virtual PPP interface:
(config-ppp 1)#ip route-cache

configuration.
Syntax Description
Default Values
Command History
Functional Notes
taken from the specified interface. For example, specifying ip unnumbered eth 0/1 while in the
Point-to-Point Protocol (PPP) Interface Configuration mode configures the PPP interface to use the IP
address assigned to the Ethernet interface for all IP processing. In addition, AOS uses the specified
interface information when sending route updates over the unnumbered interface. Static routes may either
use the interface name (ppp 1) or the far-end address (if it will be discovered).
Usage Examples
The following example configures the PPP interface (labeled ppp 1) to use the IP address assigned to the
Ethernet interface (eth 0/1):
(config-ppp 1)#ip unnumbered eth 0/1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through the Point-to-Point Protocol
(PPP) interface (labeled ppp 1) and matches the URL filter named MyFilter:
(config-ppp 1)#ip urlfilter MyFilter in

keepalive <value>
default setting.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a keepalive time of 5 seconds on the virtual Point-to-Point Protocol (PPP)
interface:
(config-ppp 1)#keepalive 5

lldp receive
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the Point-to-Point Protocol (PPP) interface to receive LLDP packets:
(config-ppp 1)#lldp receive

lldp send

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example configures the Point-to-Point Protocol (PPP) interface to transmit LLDP packets
containing all enabled information types:
(config-ppp 1)#lldp send
The following example configures the PPP interface to transmit and receive LLDP packets containing all
information types:
(config-ppp 1)#lldp send-and-receive

Syntax Description
interface speed. Range: 1 to 100 percent.
Default Values
Command History
Usage Examples
The following example specifies 85 percent of the bandwidth on the Point-to-Point Protocol (PPP) 1 be
available for use in user-defined queues:
(config-ppp 1)#max-reserved-bandwidth 85

media-gateway ip

Syntax Description
loopback interface.
(for example, 10.10.10.1).
Default Values
Command History
Release 17.3 Command was updated with the loopback interface indentification option.
Usage Examples
(config-ppp 1)#media-gateway ip primary

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes

Usage Examples
The following example specifies an MTU of 1200 on the virtual Point-to-Point Protocol (PPP) interface:
(config-ppp 1)#mtu 1200


interface. Use the no form of this command to remove an assigned IP address.
Syntax Description
Default Values
Command History
Functional Notes
This command is useful if the peer does not send the IP address option during Point-to-Point Protocol
(PPP) negotiations.
Usage Examples
(config-ppp 1)#peer default ip address 192.22.71.50

ppp authentication
Use the ppp authentication command to specify the authentication protocol on the Point-to-Point
Protocol (PPP) virtual interface that the peer should use to authenticate itself. Use the no form of this

ppp authentication pap
Syntax Description
chap Configures Challenge-Handshake Authentication Protocol (CHAP) on the
interface.
pap Configures Password Authentication Protocol (PAP) on the interface.
Default Values
By default, PPP endpoints have no authentication configured.
Command History
Technology Review
CHAP and PAP are two authentication methods that enjoy widespread support. Both methods are included
in AOS and are easily configured.
The authentication method set up on the local router can be different from that on the peer.
Also, just because one router requires authentication from its peer does not mean it also
has to authenticate itself to the peer.
Defining PAP
PAP is used to verify that the PPP peer is a permitted device by checking a user name and password
configured on the peer. The user name and password are both sent unencrypted across the connecting
private circuit.
PAP requires two-way message passing. First, the router that is required to be authenticated (for example,
the peer) sends an authentication request with its user name and password to the router requiring
authentication (for example, the local router). The local router then looks up the user name and password
in the user name database within the PPP interface, and if they match sends an authentication
acknowledge back to the peer.
configuration.

Configuring PAP Example 1: Only the local router requires the peer to authenticate itself.
Local(config-ppp 1)#ppp authentication pap

Local(config-ppp 1)#username farend password far
Peer(config-ppp 1)#ppp pap sent-username farend password far
The first line of the configuration sets the authentication mode as PAP. This means the peer is required to
authenticate itself to the local router via PAP. The second line is the user name and password expected to
be sent from the peer. On the peer, the ppp pap sent-username command is used to specify the
appropriate matching user name and password.
Configuring PAP Example 2: Both routers require the peer to authenticate itself.
Local(config-ppp 1)#ppp authentication pap

Local(config-ppp 1)#ppp pap sent-username nearend password near
Peer(config-ppp 1)#ppp authentication pap

Peer(config-ppp 1)#username nearend password near
Peer(config-ppp 1)#ppp pap sent-username farend password far
Now both routers send the authentication request, verify that the user name and password sent match
what is expected in the database, and send an authentication acknowledge.
Defining CHAP
CHAP is a three-way authentication protocol composed of a challenge response and success or failure.
The message digest 5 (MD5) protocol is used to protect user names and passwords in the response.
First, the local router (requiring its peer to be authenticated) sends a challenge containing the unencrypted
user name of the peer and a random number. The user name of the peer is found in the user name
database within the PPP interface of the local router. The peer then looks up the user name in the user
name database within the PPP interface, and if found takes the corresponding password and its own host
name and sends a response back to the local router. This data is encrypted. The local router verifies that
the user name and password are in its own user name database within the PPP interface, and if so sends
a success back to the peer.
configuration.

Configuring CHAP Example 1: Only the local router requires the peer to authenticate itself.
Local(config-ppp 1)#ppp authentication chap

Local(config-ppp 1)#username Peer password same
Peer(config-ppp 1)#ppp chap password same
The first line of this configuration sets the authentication mode to CHAP. This means the peer is required to
authenticate itself to the local router via CHAP. The second line is the user name and password expected
to be sent from the peer. The peer uses its hostname and ppp chap password commands to send the
proper authentication information.

Local(config-ppp 1)#username farend password same
Peer(config-ppp 1)#ppp chap hostname farend

Peer(config-ppp 1)#ppp chap password same
Therefore, the peer router can use the ppp chap hostname command to send the correct name in the
challenge.
the same shared password.

Local(config-ppp 1)#username Peer password same

Peer(config-ppp 1)#ppp authentication chap

Peer(config-ppp 1)#username Local password same
This is basically identical to Example 1 except that both routers will now challenge each other and
respond.
two separate shared passwords.

Local(config-ppp 1)#username Peer password far
Local(config-ppp 1)#ppp chap password near

Peer(config-ppp 1)#username Local password near
Peer(config-ppp 1)#ppp chap password far
This is basically identical to Example 3, except that there are two separate shared passwords.

Local(config-ppp 1)#ppp chap hostname nearend
Local(config-ppp 1)#ppp chap password near

Peer(config-ppp 1)#username nearend password near
Peer(config-ppp 1)#ppp chap hostname farend
Peer(config-ppp 1)#ppp chap password far

Therefore, the peer router can use the ppp chap hostname command to send the correct name on the
challenge.

ppp bcp tagged-frame

Use the ppp bcp tagged-frame command to allow negotiation of IEEE 802.1Q-tagged packets over
Bridging Control Protocol (BCP). Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures Point-to-Point Protocol (PPP) interface 1 to negotiate tagged frames
over BCP:
(config-ppp 1)#ppp bcp tagged-frame

ppp chap hostname <name>

Use the ppp chap hostname command to configure an alternate host name for Challenge-Handshake
Authentication Protocol (CHAP) Point-to-Point Protocol (PPP) authentication. Use the no form of this
command to remove a configured host name. For more information on Password Authentication Protocol
(PAP) and CHAP functionality, refer to the Technology Review section for the command ppp
authentication on page 2054.
Syntax Description
<name> Specifies a host name using an alphanumeric string up to 80 characters in
length.
Default Values
By default, there are no configured PPP CHAP host names.
Command History
Usage Examples
The following example specifies a PPP CHAP host name of my_host:
(config-ppp 1)#ppp chap hostname my_host

ppp chap password <password>

Use the ppp chap password command to configure an alternate password when the peer requires
Challenge-Handshake Authentication Protocol (CHAP) Point-to-Point Protocol (PPP) authentication. Use
the no form of this command to remove a configured password. For more information on Password
Authentication Protocol (PAP) and CHAP functionality, refer to the Technology Review section for the
command ppp authentication on page 2054.
Syntax Description
<password> Specifies a password using an alphanumeric string up to 80 characters in
length.
Default Values
By default, there is no defined PPP CHAP password.
Command History
Usage Examples
The following example specifies a PPP CHAP password of my_password:
(config-ppp 1)#ppp chap password my_password

ppp multilink
Use the ppp multilink command to enable Multilink Point-to-Point Protocol (MLPPP) operation on an
existing Point-to-Point Protocol (PPP) interface. Use the no form of this command to disable this feature.
ppp multilink fragmentation

ppp multilink interleave
ppp multilink maximum <number>
Syntax Description
fragmentation Enables multilink fragmentation operation.
interleave Enables multilink interleave operation.
maximum <number> Specifies the maximum number of links allowed in a PPP multilink bundle.
Default Values
By default, MLPPP is disabled.
Command History
Release 7.2 Fragmentation and interleave operation were added.
Functional Notes
When enabled, this interface is capable of the following:
• Combining multiple physical links into one logical link.

• Receiving upper layer protocol data units (PDUs), fragmenting and transmitting over the physical links.
• Receiving fragments over the physical links and reassembling them into PDUs.
The fragmentation and interleave options can be used to enhance the multilink operation. Fragmentation is
used to reduce serialization delays of large packets. The fragmentation process evenly divides the data
among all links in the bundle with a minimum packet size of 96 bytes. The interleave operation is used with
streaming protocols to reduce delay by giving priority to packets identified as high priority. In order delivery
is guaranteed with multilink fragmentation, but is not guaranteed with multilink interleave operation.
The multilink bundle will remain active with a minimum of one physical link. Physical links may be
dynamically added or removed from the multilink bundle with minor interruption to traffic flow.
Usage Examples
The following example enables MLPPP:
(config-ppp 1)#ppp multilink

ppp pap sent-username <username> password <password>

Use the ppp pap sent-username password command to configure a user name and password when the
peer requires Password Authentication Protocol (PAP) Point-to-Point Protocol (PPP) authentication. Use
the no form of this command to remove a configured password. For more information on PAP and
Challenge-Handshake Authentication Protocol (CHAP) functionality, refer to the Technology Review
section for the command ppp authentication on page 2054.
Syntax Description
<username> Specifies a user name by alphanumeric string up to 80 characters in length
(the user name is case sensitive).
<password> Specifies a password by alphanumeric string up to 80 characters in length
Default Values
By default, there is no defined ppp pap sent-username and password.
Command History
Usage Examples
The following example specifies a PPP PAP sent user name of local and a password of my_password:
(config-ppp 1)#ppp pap sent-username local password my_password

pppoe ac-name <name>

Use the pppoe ac-name command to identify the access controller (AC) with which AOS expects to
establish a Point-to-Point Protocol over Ethernet (PPPoE) session. Use the no form of this command to
Syntax Description
<name> Specifies an AC by text string (up to 255 characters) corresponding to the
AC-Name Tag under RFC 2516. If this field is not specified, any AC is
acceptable. The AC value may be a combination of trademark, model, and
serial ID information (or simply the medium access control (MAC) address
of the unit).
Default Values
By default, no AC is specified.
Command History
Usage Examples
The following example identifies the AC with which AOS expects to establish a PPPoE session:
(config-ppp 1)#pppoe ac-name Access_Controller_Name

pppoe service-name <name>

Use the pppoe service-name command to use this tag value to filter Point-to-Point Protocol over Ethernet
(PPPoE) session offers from PPPoE servers. Use the no form of this command to return to the default
setting.
Syntax Description
<name> Specifies a service name by text string (up to 255 characters)
corresponding to the Service-Name Tags under RFC 2516. This string
indicates an Internet service provider (ISP) name (or a class of service
(CoS) or quality of service (QoS)). If this field is not specified, any service is
acceptable.
Default Values
By default, no names are specified.
Command History
Usage Examples
The following example defines a service type that is not to be accepted by AOS:
(config-ppp 1)#pppoe service-name Service_Name

qos-policy
Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example applies the QoS map VOICEMAP to the Point-to-Point Protocol (PPP) 1 interface:
(config-ppp 1)#qos-policy out VOICEMAP

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the virtual Point-to-Point Protocol (PPP)
interface:
(config-ppp 1)#rtp quality-monitoring


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the virtual Point-to-Point Protocol (PPP) interface:
(config-ppp 1)#no snmp trap link-status


Use the username password command to configure the user name and password of the peer to use for
Point-to-Point Protocol (PPP) authentication. Use the no form of this command to remove a configured
user name and password.
Syntax Description
<username> Specifies a user name by alphanumerical string up to 30 characters in
<password> Specifies a password by alphanumerical string up to 30 characters in length
Default Values
Command History
Functional Notes
Password Authentication Protocol (PAP) uses this entry to check received information from the peer.
Challenge-Handshake Authentication Protocol (CHAP) uses this entry to check the received peer host
name and a common password.
Usage Examples
The following example creates a user name of ADTRAN with password ADTRAN for the PPP link
labeled 5:
(config-ppp 5)#username ADTRAN password ADTRAN


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide Tunnel Interface Command Set
TUNNEL INTERFACE COMMAND SET
To create a generic routing encapsulation (GRE) tunnel interface and/or activate the Tunnel Configuration
mode, enter the interface tunnel command at the Global Configuration mode prompt. For example:
>enable
(config-tunnel 1)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61

keepalive on page 2130
tunnel checksum on page 2139
tunnel destination <ip address> on page 2140
tunnel key <value> on page 2141
tunnel mode gre on page 2142
tunnel sequence-datagrams on page 2143

tunnel source on page 2144

tunnel vrf <name> on page 2146

Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
tunnel 1 interface:

Associate the access policy with the tunnel 1 interface:
(config-tunnel 1)#access-policy PRIVATE

bandwidth <value>
Syntax Description
Default Values
Command History
interfaces.
Release 9.1 Command was expanded to include the tunnel interfaces.
Functional Notes
Usage Examples
The following example sets bandwidth of the tunnel 1 interface to 10 Mbps:
(config-tunnel 1)#bandwidth 10000

crypto map <name>

Syntax Description
Default Values
Command History
Functional Notes


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the tunnel interface:
(config-tunnel 1)#crypto map MyMap

Syntax Description
No subcommands.
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup auto-backup

Syntax Description
No subcommands.
Default Values
condition clears.
Command History
interface.
Usage Examples
condition clears:
(config-tunnel 1)#dial-backup auto-restore


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup backup-delay 60


Syntax Description
Default Values
Command History
interface.
Functional Notes
!
interface eth 0/1
ip address 192.168.1.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1

coding b8zs
framing esf
clock source line
no shutdown
!
no shutdown
!
ip address 10.1.1.2 255.255.255.252
no shutdown
!
interface ppp 1
ip address 172.22.56.1 255.255.255.252
no shutdown
!
ip route 192.168.2.0 255.255.255.0 172.22.56.2 255.255.255.252
!
line telnet 0 4
password password
!
interface eth 0/1
ip address 192.168.100.254 255.255.255.0
no shutdown
!
interface modem 1/3
no shutdown
!
interface t1 1/1
coding b8zs
framing esf
clock source line


no shutdown
!
no shutdown
!
ip address 10.1.1.1 255.255.255.252
!
interface ppp 1
ip address 172.22.56.2 255.255.255.252
no shutdown
!
ip route 192.168.1.0 255.255.255.0 172.22.56.1 255.255.255.252
line telnet 0 4
password password
Usage Examples
(config-tunnel 1)#dial-backup call-mode originate
(config-tunnel 1)#dial-backup number 555 1111 analog ppp 2

Technology Review
Dialing Out
with an addition to the dial-backup number command (refer to dial-backup number on page 2088).
negotiation.
Dialing In
down state.


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup connect-timeout 120

dial-backup force
Review sections of dial-backup call-mode on page 2081. Variations of this command include:

Syntax Description
backup Force backup regardless of primary link state.
primary Force primary link regardless of its state.
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup force backup


Syntax Description
is failed.
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup maximum-retry 4

dial-backup number
Use the no form of this command to return to the default setting. For more detailed information on

Syntax Description
connection. Range is 1 to 24.
connection. Range is 1 to 24.
this interface.
Default Values
Command History
Usage Examples
dial-backup operation on this endpoint using interface ppp 1 backup interface:
(config-tunnel 1)#dial-backup number 7045551212 digital-64k 1 1 ppp 1


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup priority 100

Syntax Description
No subcommands.
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup randomize-timers


Syntax Description
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup redial-delay 25


Syntax Description
86400 seconds.
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup restore-delay 30


Syntax Description
(00:00).
(00:00).
Default Values
Command History
interface.
Usage Examples
(config-tunnel 1)#dial-backup schedule enable-time 08:00
(config-tunnel 1)#dial-backup schedule disable-time 19:00
(config-tunnel 1)#no dial-backup schedule day Saturday
(config-tunnel 1)#no dial-backup schedule day Sunday

dial-backup interface. For more detailed information on Point-to-Point Protocol (PPP) dial-backup
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
(config-tunnel 1)#dial-backup shutdown

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
and password pass:
(config-tunnel 1)#dynamic-dns dyndns-custom host user pass

Syntax Description
<name> Assigns an IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the unit to only allow Telnet traffic (as defined in the user-configured
TelnetOnly IP ACL) into the tunnel interface:

(config-ext-nacl)#interface tunnel 1
(config-tunnel 1)#ip access-group TelnetOnly in



Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
The following example configures an IP address of 192.22.72.101 255.255.255.252:
(config-tunnel 1)#ip address 192.22.72.101 255.255.255.252


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:
(config-tunnel 1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface tunnel 1:
(config-tunnel 1)#ip directed-broadcast

ip ffe
ip ffe
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
50:
(config-tunnel 1)#ip ffe max-entries 50

Technology Review
processing layers.

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on a tunnel interface to monitor incoming traffic through
an ACL called myacl:
(config-tunnel 1)#ip flow ingress myacl


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes

Usage Examples

(config-tunnel 1)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
default setting.

Syntax Description
Default Values
Command History
Release 9.1 Tunnel subinterface was added.
Usage Examples
(config-tunnel 1)#ip igmp last-member-query-interval 200

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-tunnel 1)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
the command ip igmp static-group <address> (refer to ip igmp on page 2107) to receive multicast traffic
Usage Examples
(config-tunnel 1)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-tunnel 1)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-tunnel 1)#ip mcast-stub upstream

ip ospf

Syntax Description
1 to 65535.
32767 seconds.
0 to 255.
32767 seconds.
Default Values
Protocol (PPP)

Command History
Usage Examples
(config-tunnel 1)#ip ospf dead-interval 25000

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies that no authentication will be used on the tunnel interface:
(config-tunnel 1)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
By default, Ethernet defaults to broadcast. Point-to-Point Protocol (PPP), Frame Relay, and tunnel default
to point-to-point.
Command History
Functional Notes
Usage Examples
(config-tunnel 1)#ip ospf network broadcast

ip pim sparse-mode
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-tunnel 1)#ip pim sparse-mode


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a priority of 100 on the tunnel 1 interface:
(config-tunnel 1)#ip pim-sparse dr-priority 100


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies hellos be sent on the tunnel 1 interface every 3600 seconds:
(config-tunnel 1)#ip pim-sparse hello-timer 3600


Syntax Description
Default Values
Command History
Usage Examples
The following example sets the neighbor timeout to 300 seconds:
(config-tunnel 1)#ip pim-sparse nbr-timeout 300


default value.
Syntax Description
65535 milliseconds.
Default Values
Command History
Usage Examples
(config-tunnel 1)#ip pim-sparse override-interval 3000


Syntax Description
Default Values
Command History
Usage Examples
(config-tunnel 1)#ip pim-sparse propagation-delay 300


Syntax Description
Default Values
Command History
Usage Examples
(config-tunnel 1)#ip policy route-map policy1

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables proxy ARP on the tunnel interface:
(config-tunnel 1)#ip proxy-arp



Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the tunnel interface to accept only RIP version 2 packets:
(config-tunnel 1)#ip rip receive version 2

ip rip send version


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the tunnel interface to transmit only RIP version 2 packets:
(config-tunnel 1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
(config-tunnel 1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables fast switching on the tunnel interface:
(config-tunnel 1)#ip route-cache

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through the tunnel interface and
(config-tunnel 1)#ip urlfilter MyFilter in

keepalive
Use the keepalive command to periodically send keepalive packets to verify the integrity of the tunnel
from end to end. Use the no form of this command to disable keepalives. Variations of this command
include:
keepalive
keepalive <value>
keepalive <value> <number>
Syntax Description
<number> Defines the number of times to retry after failed keepalives before
determining that the tunnel endpoint is down. Valid range is 1 to 255 times.
Default Values
By default, keepalives are disabled. When enabled, the keepalive period defaults to 10 seconds and the
retry count defaults to 3 times.
Command History
Functional Notes
Keepalives do not have to be configured on both ends of the tunnel in order to work. A tunnel is not aware
of incoming keepalive packets.
Usage Examples
The following example enables keepalive with a period of 30 seconds and a retry count of 5 times:
(config-tunnel 1)#keepalive 30 5

lldp receive
this interface. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the tunnel interface to receive LLDP packets:
(config-tunnel 1)#lldp receive

lldp send
lldp send
Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example configures the tunnel interface to transmit LLDP packets containing all enabled
information types:
(config-tunnel 1)#lldp send
The following example configures the tunnel interface to transmit and receive LLDP packets containing all
information types:
(config-tunnel 1)#lldp send-and-receive

media-gateway ip

Syntax Description
loopback interface.
(for example, 10.10.10.1).
Default Values
Command History
Usage Examples
(config-tunnel 1)#media-gateway ip primary

mtu <size>
Syntax Description
BVIs 64 to 2100
Default Values
BVIs 1500
FDL interfaces 256
PPP interfaces 1500
Command History
Functional Notes

Usage Examples
The following example specifies an MTU of 1200 on the tunnel interface:
(config-tunnel 1)#mtu 1200

snmp trap
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP on the tunnel interface:
(config-tunnel 1)#snmp trap


Syntax Description
No subcommands.
Default Values
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the tunnel interface:
(config-tunnel 1)#no snmp trap link-status

tunnel checksum
Use the tunnel checksum command to verify the checksum of incoming generic routing encapsulation
(GRE) packets and to include a checksum on outgoing packets. Use the no form of this command to
disable checksum.
Syntax Description
No subcommands.
Default Values
By default, tunnel checksum is disabled.
Command History
Functional Notes
Both ends of the tunnel must have tunnel checksum enabled in order for a meaningful configuration.
When both endpoints have tunnel checksum enabled, a packet with an incorrect checksum will be
dropped. If the endpoints differ in their checksum configuration, all packets will still flow without any
checksum verification.
Usage Examples
The following example enables checksum on the tunnel 1 interface:
(config-tunnel 1)#tunnel checksum
Technology Review
When enabled, the tunnel checksum will be calculated for each outgoing GRE packet with the result
stored in the GRE header. The checksum present bit will also be set in the header.

tunnel destination <ip address>

Use the tunnel destination command to specify the IP address to use as the destination address for all
packets transmitted on this interface. Use the no form of this command to clear the tunnel destination
address.
Syntax Description
<ip address> Specifies the IP address to use as the destination address for all packets
transmitted on this interface. IP addresses should be expressed in dotted
Default Values
By default, no tunnel destinations are defined.
Command History
Functional Notes
Until a tunnel interface has a destination IP address defined, it is not operational.
The tunnel destination IP address will be the value put into the destination field of the outer IP header after
generic routing encapsulation (GRE) of the original packet. A route must be defined for the destination
address. Be certain there are no recursive routes by ensuring that a tunnel’s destination address will be
routed out a physical interface. There is a possibility of creating a routing loop when tunnel interface traffic
gets routed back to the same tunnel interface or to another tunnel interface, which in turn, does not have a
route out of a physical interface. In either case, the tunnel will go down for a period of one minute, after
which it will come back up to determine if the recursive routes have been resolved. This allows time for
routing protocols to converge on a valid route. If a static route has caused the recursive routing loop, the
tunnel status may oscillate until the route is changed.
Usage Examples
The following example sets the tunnel destination IP address to 192.22.73.101:
(config-tunnel 1)#tunnel destination 192.22.73.101

tunnel key <value>

Use the tunnel key command to specify a value shared by both endpoints of the tunnel that will provide
minimal security and delineate between tunnels with the same source and destination addresses. Use the no
form of this command to disable the key.
Syntax Description
<value> Defines the key value for this tunnel. Valid range is 1 to 4294967294.
Default Values
By default, a key is not configured.
Command History
Functional Notes
When enabled, the key will be stored in the generic routing encapsulation (GRE) header and the key
present bit will be set. If tunnel keys are used, a matching key value must be defined on both endpoints of
the tunnel or packets will be discarded.
Usage Examples
The following example sets the key on a tunnel interface to a value of 1234:
(config-tunnel 1)#tunnel key 1234

tunnel mode gre

Use the tunnel mode gre command to encapsulate traffic destined for the tunnel interface in a generic
routing encapsulation (GRE) header. Use the no form of this command to set the tunnel to its default
mode.
Syntax Description
No subcommands.
Default Values
By default, the tunnel interface will be configured for GRE mode.
Command History
Functional Notes
GRE is currently the only allowed mode for tunnel interface operation.
Usage Examples
The following example configures the tunnel interface for GRE mode:
(config-tunnel 1)#tunnel mode gre

tunnel sequence-datagrams
Use the tunnel sequence-datagrams command to enable sequence number checking on incoming generic
routing encapsulation (GRE) packets, to drop packets arriving out of order, and to include a sequence
number in outgoing packets. Use the no form of this command to disable sequence number checking.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Both ends of the tunnel must have sequence numbering enabled. When both endpoints have sequence
numbering enabled, a packet arriving with a sequence number less than the current expected value will be
dropped. If the endpoints differ in their sequence numbering configuration, all packets will still flow without
any sequence number verification. Be careful enabling sequence number verification on a tunnel. The
tunnel can easily become out of sequence due to network conditions outside of the tunnel endpoints. It
may be difficult to establish a successful traffic flow after an out of sequence condition occurs.
Usage Examples
The following example enables sequence number processing on the tunnel interface:
(config-tunnel 1)#tunnel sequence-datagrams
Technology Review
When enabled, the next valid sequence number will be placed in the GRE header of each outgoing packet,
and the sequence number present bit will be set.

tunnel source
Use the tunnel source command to specify the IP address or name of a physical interface to use as the
source address for all packets transmitted on this interface. Use the no form of this command to clear the
tunnel source address. Variations of this command include:
tunnel source <ip address>

tunnel source <ip address> <interface>
Syntax Description
<ip address> Specifies the IP address in dotted decimal notation to use as the source
address for all packets transmitted on this interface. IP addresses should be
wireless virtual access point, use dot11ap 1/1.1. Type tunnel source ? for
a complete list of valid interfaces.
Default Values
By default, a tunnel source is not defined.
Command History
Functional Notes
Until a tunnel interface has a source IP address defined and the physical interface used as the source is
operational, the tunnel is not operational.
The tunnel source IP address will be the value put into the source field of the outer IP header after generic
routing encapsulation (GRE) of the original packet.

Usage Examples
The following example sets the tunnel source IP address to 192.22.73.101:
(config-tunnel 1)#tunnel source 192.22.73.101
The following example sets the tunnel source IP address to the address of the Ethernet interface
labeled 0/1:
(config-tunnel 1)#tunnel source eth 0/1

tunnel vrf <name>

Use the tunnel vrf command to specify the VPN routing and forwarding (VRF) to use in order to reach the
tunnel source and the tunnel destination. Use the no form of this command to use the default VRF.
VRF on an AOS product allows a single physical router to be partitioned into multiple
virtual routers. Each router instance has its own route table and interface assignments.
Beginning with Release 16.1, all AOS routers supporting multiple VRF instances
(multi-VRF) have an unnamed default VRF instance regardless of whether multi-VRF is
configured. Therefore, executing the abovementioned commands without specifying a VRF
will affect the default unnamed VRF.
Syntax Description
<name> Optional. Specifies the name of the VRF.
Default Values
By default, the default VRF is used.
Command History
Usage Examples
The following example sets the VRF instance to use to reach the tunnel source as VRF RED:
(config-tunnel 1)#tunnel vrf RED
(config-tunnel 1)#tunnel source 10.10.10.254
(config-tunnel 1)#tunnel destination 10.10.10.1


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


Command Reference Guide VLAN Command Set
VLAN COMMAND SET
To activate the Virtual Local Area Network (VLAN) Configuration mode, enter the vlan command at the
>enable
#configure terminal
(config)#vlan 1
(config-vlan 1)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61
ip flow on page 2149

media ethernet on page 2150
name <name> on page 2151
state on page 2152

ip flow
ip flow egress
ip flow ingress
Syntax Description
filtering traffic.
Default Values
Command History
Usage Examples
The following example enables traffic monitoring on a virtual local arean network (VLAN) interface to
monitor incoming traffic through an ACL called myacl:
(config-vlan 2)#ip flow ingress myacl

media ethernet
Use the media ethernet command to set the virtual local area network (VLAN) media type to Ethernet.
The only media type currently supported is Ethernet. Use the no form of this command to reset to the
default setting.
Syntax Description
No subcommands.
Default Values
By default, media is set to Ethernet.
Command History
Usage Examples
The following example sets the media type to Ethernet for VLAN 2:
(config)#vlan 2
(config-vlan 2)#media ethernet

name <name>
Use the name command to assign a name to the virtual local area network (VLAN). Use the no form of
this command to remove a name given to a VLAN.
Syntax Description
<name> Assigns a name to the VLAN using 1 to 32 characters.
Default Values
By default, the name is set to VLANxxxx, where xxxx represents four numeric digits (including leading
zeroes) equal to the VLAN ID number.
Command History
Functional Notes
The name is limited to 32 characters and must be unique throughout.
Usage Examples
The following example sets the name of VLAN 2 to Accounting:
(config)#vlan 2
(config-vlan 2)#name Accounting

state
Use the state command to change the state of the virtual local area network (VLAN). Variations of this
command include:
state active
state suspend
Syntax Description
active Changes the VLAN state to active.
suspend Changes the VLAN state to suspended.
Default Values
The default setting is active (once the VLAN has been created).
Command History
Usage Examples
The following example sets the VLAN state to suspended:
(config)#vlan 2
(config-vlan 2)#state suspend

Command Reference Guide VLAN Database Command Set
VLAN DATABASE COMMAND SET
To activate the Virtual Local Area Network (VLAN) Database Configuration mode, enter the vlan
database command at the Enable security mode prompt. For example:
>enable
#configure terminal
(config)#vlan database
(vlan)#
do on page 51
end on page 52
exit on page 53
abort on page 2154

apply on page 2155
reset on page 2156
show on page 2157
vlan <vlan id> on page 2158
vlan <vlan id> media ethernet on page 2159
vlan <vlan id> name <name> on page 2160
vlan <vlan id> state on page 2161

abort
Use the abort command to exit the virtual local area network (VLAN) database without saving any
changes made.
Syntax Description
No subcommands.
Default Values
No default values are necessary for this setting.
Command History
Functional Notes
The abort command discards all configuration changes made since you entered the VLAN Database
Configuration mode (or since the last time you issued the apply command). The system then exits out of
this mode, returning to the enable (#) command prompt. Refer to the command apply on page 2155 for
more information.
Usage Examples
The following example exits the VLAN database without saving the changes made:
(vlan)#abort
Discarding all changes and exiting.
#

apply
Use the apply command to apply changes without exiting the virtual local area network (VLAN) database.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Applies changes to the VLAN database configuration in the running configuration.
Usage Examples
The following example applies changes made, remaining in the VLAN database:
(vlan)#apply
Changes applied.
(vlan)#

reset
Use the reset command to discard all changes made and revert to the previous configuration. The prompt
remains in the virtual local area network (VLAN) database.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The reset command discards all changes to the VLAN configuration. The configuration remains the same
as it was prior to entering the VLAN Database Configuration mode (or since the last time you issued the
apply command). The VLAN database reverts to the same state it had upon entry. Refer to the command
apply on page 2155 for more information.
Usage Examples
The following example resets the unit to the previous configuration (i.e., the last configuration saved using
the apply or the exit command):
(vlan)#reset
VLAN configuration has been reset.
(vlan)#

show
Use the show command to display different aspects of the virtual local area network (VLAN)
configuration. Variations of this command include:
show changes
show changes <vlan id>
show current
show current <vlan id>
show proposed
show proposed <vlan id>
Syntax Description
<vlan id> Specifies a VLAN ID to display only information for a specific VLAN. Valid
VLAN interface ID range is from 1 to 4094.
changes Displays the proposed changes to the VLAN configuration.
current Displays the current VLAN configuration.
proposed Displays the proposed VLAN database. The proposed version is not part of
the running configuration until it is applied (using the apply command or the
exit command).
Default Values
Command History
Usage Examples
The following example shows the proposed VLAN database configuration that will take effect if an apply or
exit command is issued:
(vlan)#show proposed

vlan <vlan id>

Use the vlan command to create a virtual local area network (VLAN) within the VLAN database. Use the
no form of this command to delete a previously created VLAN from the database.
Syntax Description
Default Values
Command History
Usage Examples
The following example creates VLAN 2 only within the VLAN database. This VLAN is not added to the
running configuration until an exit or apply command is issued:
(vlan)#vlan 2
VLAN 2 created.
Name = VLAN0002
(vlan)#
The following example removes VLAN 2 from the VLAN database. This VLAN is not removed from the
running configuration until an exit or apply command is issued:
(vlan)#no vlan 2

vlan <vlan id> media ethernet

Use the vlan media ethernet command to set the virtual local area network (VLAN) media type to
Ethernet. Use the no form of this command to reset to the default setting.
Syntax Description
<vlan id> Specifies a valid VLAN interface ID. Valid range is 1 to 4094.
Default Values
By default, vlan media is set to Ethernet.
Command History
Usage Examples
The following example sets the media type of VLAN 2 to Ethernet:
(vlan)#vlan 2 media ethernet

vlan <vlan id> name <name>

Use the vlan name command to assign a name to the virtual local area network (VLAN). Use the no form
of this command to remove an assigned name.
Syntax Description
<vlan id> Specifies a valid VLAN interface ID. Valid range is 1 to 4094.
<name> Assigns a name to the VLAN using 1 to 32 characters.
Default Values
By default, the assigned name is VLANxxxx; where xxxx represents four numeric digits (including leading
zeroes) equal to the VLAN ID number.
Command History
Functional Notes
The name is limited to 32 characters and must be unique throughout the network.
Usage Examples
The following example sets the name of VLAN 2 to Accounting:
(vlan)#vlan 2 name Accounting

vlan <vlan id> state

Use the vlan state command to change the state of the virtual local area network (VLAN). Use the no form
vlan <vlan id> state active

vlan <vlan id> state suspend
Syntax Description
<vlan id> Specifies a valid VLAN interface ID. Valid VLAN ID range is 1 to 4094.
active Changes the VLAN state to active.
suspend Changes the VLAN state to suspended.
Default Values
The default setting is active (once the VLAN has been created).
Command History
Usage Examples
The following example sets the VLAN state to suspended:
(vlan)#vlan 2 state suspend

Command Reference Guide VLAN Interface Command Set
VLAN INTERFACE COMMAND SET
To create a virtual local area network (VLAN) interface and/or activate the VLAN Interface Configuration
mode, enter the interface vlan command at the Global Configuration mode prompt. For example:
>enable
(config-interface-vlan 1)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61

awcp on page 2165
vrrp <number> on page 2219

Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
VLAN interface 1:

Associate the access policy with the VLAN interface 1:
(config-interface-vlan 1)#access-policy PRIVATE

arp arpa
Syntax Description
No subcommands.
Default Values
By default, the ARP is set to ARPA.
Command History
Release 6.1 Command was extended to include the NetVanta 2000 Series units.
Usage Examples
The following example enables standard ARP for the virtual local area network (VLAN) interface:
(config-interface-vlan 1)#arp arpa

awcp
Use the awcp command to enable ADTRAN Wireless Control Protocol (AWCP) on this interface. The
AWCP is an ADTRAN proprietary protocol used by an access controller (AC) to communicate with an
access point (AP). Use the no form of this command to disable AWCP for this interface.
Syntax Description
No subcommands.
Default Values
By default, AWCP is enabled on the interface.
Command History
Functional Notes
When the global-level command dot11ap access-point-controller (refer to dot11ap access-point-control
on page 796 for more information) is enabled, the AWCP function can be disabled on a specific interface
by using the no form of this command from the desired interface. When the global-level command
dot11ap access-point-controller is disabled, it overrides the awcp command setting for the interface.
Usage Examples
The following example disables AWCP on virtual local area network (VLAN) 1:
(config-interface-vlan 1)#no awcp

bandwidth <value>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example sets bandwidth of the VLAN 1 interface to 10 Mbps:
(config-interface-vlan 1)#bandwidth 10000

Syntax Description
<number> Specifies a bridge group number. Range is 1 to 255.
Default Values
Command History
Functional Notes
be bridged (e.g., Ethernet to T1 bridge, Ethernet to Frame Relay subinterface).
Usage Examples
The following example assigns the virtual local area network (VLAN) interface to bridge group 17:
(config-interface-vlan 1)#bridge-group 17

crypto map <name>

Syntax Description
Default Values
Command History
Functional Notes


(in) (out)
IPSec IPSec
NAT/ACP/
Firewall
Router
Usage Examples
The following example applies all crypto maps with the name MyMap to the virtual local area network
(VLAN) interface:
(config-interface-vlan 1)#crypto map MyMap

dynamic-dns

Syntax Description
Default Values
Command History
Functional Notes
dyndns - The Dynamic DNSSM offered by Dynamic Network Services Inc., (DynDNS.org) allows you to

Usage Examples
and password pass:
(config-interface-vlan 1)#dynamic-dns dyndns-custom host user pass

Syntax Description
<name> Assigns an IP ACL name.
Default Values
Command History
Functional Notes
Usage Examples
The following example sets up the router to only allow Telnet traffic (as defined in the user-configured
TelnetOnly IP access control list) into the virtual local area network (VLAN) interface:

(config-ext-nacl)#interface vlan 1
(config-interface-vlan 1)#ip access-group TelnetOnly in



Syntax Description
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
The following example configures an IP address of 192.22.72.101 255.255.255.252:
(config-interface-vlan 1)#ip address 192.22.72.101 255.255.255.252


secondary
Syntax Description
10.10.10.1).
example, /24).
Default Values
Command History
Functional Notes
secondary subnet.
Usage Examples
subnet 255.255.255.252:
(config-interface-vlan 1)#ip address range 192.22.72.1 192.22.72.10 255.255.255.252 secondary

ip address dhcp
ip address dhcp client-id [<interface> | <identifier>] [hostname “<string>” ] [track <name>]

Syntax Description
from a DHCP server.
media type).
media types.
<identifier> Specifies a custom client identifier using a text string (that is converted to a
delimiters).
obtained via DHCP.

Default Values
formula:
8 7 6 5 4 3 2 1
address:
16 / 0x0401
50 / 0x0C21
60 / 0x0CC1
70 / 0x1061
80 / 0x1401

Command History
subinterface.
Release 13.1 Command was expanded to include the administrative distance.
Release 17.5 Command was expanded to include the track parameter.
Functional Notes
Usage Examples
The following example enables DHCP operation on the virtual local area network (VLAN) interface 2:
(config-intf-vlan 2)#ip address dhcp
The following example enables DHCP operation on the VLAN interface 2 utilizing host name adtran and
does not allow obtaining a default route, domain name, or name servers. It also sets the administrative
distance as 5:
(config-intf-vlan 2)#ip address dhcp hostname “adtran” no-default-route no-domain-name
no-nameservers 5

ip dhcp
command include:
ip dhcp release
ip dhcp renew
Syntax Description
Default Values
Command History
Usage Examples
The following example releases the IP DHCP address for the virtual local area network (VLAN) interface:
(config-interface-vlan 1)#ip dhcp release

Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example enables forwarding of directed broadcasts on the interface vlan 1:
(config-interface-vlan 1)#ip directed-broadcast

ip ffe
ip ffe
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
50:
(config-vlan 1)#ip ffe max-entries 50

Technology Review
processing layers.


packets.

Syntax Description
10.10.10.1).
Default Values
Command History
Functional Notes
Usage Examples

(config-interface-vlan 1)#ip helper-address 192.33.5.99

ip igmp
command include:
Syntax Description
default setting.
default setting.

Syntax Description
Default Values
Command History
Usage Examples
(config-interface-vlan 1)#ip igmp last-member-query-interval 200

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-interface-vlan 1)#ip mcast-stub downstream

ip mcast-stub fixed
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-interface-vlan 1)#ip mcast-stub fixed

feature.
Syntax Description
No subcommands.
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
(config-interface-vlan 1)#ip mcast-stub helper-enable

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-interface-vlan 1)#ip mcast-stub upstream

ip mtu <value>
Use the ip mtu command to set the maximum transmission unit (MTU) size (in bytes) for the virtual local
area network (VLAN) interface. To reset to the default setting, use the no form of this command.
Syntax Description
<value> Specifies the MTU size in bytes. Range is 68 to 1000000 bytes.
Default Values
By default, this is set to 1500 bytes.
Command History
Usage Examples
The following example configures the IP MTU for 2000 bytes:
(config-interface-vlan 1)#ip mtu 2000

ip ospf

Syntax Description
1 to 65535.
seconds.
0 to 255.
32767 seconds.
Default Values
Protocol (PPP)

Command History
Usage Examples
(config-interface-vlan 1)#ip ospf dead-interval 25000

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies that no authentication will be used on the virtual local area network
(VLAN) interface:
(config-interface-vlan 1)#ip ospf authentication null

ip ospf network

Syntax Description
Default Values
point-to-point.
Command History
Functional Notes
Usage Examples
(config-interface-vlan 1)#ip ospf network broadcast

ip pim sparse-mode
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
(config-interface-vlan 1)#ip pim sparse-mode


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies a priority of 100 on the virtual local area network (VLAN) 1 interface:
(config-interface-vlan 1)#ip pim-sparse dr-priority 100


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example specifies hellos be sent on the virtual local area network (VLAN) 1 interface every
3600 seconds:
(config-interface-vlan 1)#ip pim-sparse hello-timer 3600


Syntax Description
Default Values
Command History
Usage Examples
(config-interface-vlan 1)#ip pim-sparse nbr-timeout 300


default value.
Syntax Description
65535 milliseconds.
Default Values
Command History
Usage Examples
(config-interface-vlan 1)#ip pim-sparse override-interval 3000


Syntax Description
Default Values
Command History
Usage Examples
(config-interface-vlan 1)#ip pim-sparse propagation-delay 300

ip proxy-arp
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables proxy ARP on the virtual local area network (VLAN) interface:
(config-interface-vlan 1)#ip proxy-arp



Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the virtual local area network (VLAN) interface to accept only RIP
version 2 packets:
(config-interface-vlan 1)#ip rip receive version 2

ip rip send version


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the virtual local area network (VLAN) interface to transmit only RIP
version 2 packets:
(config-interface-vlan 1)#ip rip send version 2


disable this mode.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
(config-interface-vlan 1)#ip rip summary-address 10.10.123.0 255.255.255.0

ip route-cache
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Usage Examples
The following example enables fast switching on the virtual local area network (VLAN) interface:
(config-interface-vlan 1)#ip route-cache

ip route-cache express
Use the ip route-cache express command to enable Layer 3 switching on the virtual local area network
(VLAN) interface. Use the no form of this command to disable Layer 3 switching on the interface.
Syntax Description
No subcommands.
Default Values
Layer 3 switching is disabled by default, except on the NetVanta 1544. Layer 3 switching is enabled by
default on the NetVanta 1544.
Functional Notes
Layer 3 switching cannot be disabled on the NetVanta 1544.
Enabling or disabling Layer 3 switching on the VLAN interfaces overrides the global Layer 3 switching
configuration.
For more information about Layer 3 switching, refer to the Layer 3 Switching in AOS configuration guide
Command History
Usage Examples
The following example enables Layer 3 switching on VLAN 200:

(config-intf-vlan 200)#ip route-cache express

configuration.
Syntax Description
Default Values
Command History
Functional Notes
Usage Examples
The following example configures the virtual local area network (VLAN) interface (labeled vlan 1) to use
the IP address assigned to the Ethernet interface (eth 0/1):
(config-interface-vlan 1)#ip unnumbered eth 0/1

ip urlfilter <name>
Syntax Description
Default Values
Command History
interfaces.
Functional Notes
Usage Examples
The following example performs URL filtering on all traffic entering through the VLAN interface and
(config-interface-vlan 1)#ip urlfilter MyFilter in


Use the mac-address command to specify the medium access control (MAC) address of the virtual local
area network (VLAN) interface. Only the last three values of the MAC address can be modified. The first
three values contain the ADTRAN reserved number (00:0A:C8) by default. Use the no form of this
command to return to the default MAC address programmed by ADTRAN.
Syntax Description
Default Values
Command History
Usage Examples
The following example configures a MAC address of 00:0A:C8:5F:00:D2:
(config-interface-vlan 1)#mac-address 00:0A:C8:5F:00:D2

Syntax Description
Default Values
Command History
Usage Examples
The following example specifies 85 percent of the bandwidth on the virtual local area network (VLAN) 1
interface be available for use in user-defined queues:
(config-interface-vlan 1)#max-reserved-bandwidth 85

media-gateway ip

Syntax Description
loopback interface.
(for example, 10.10.10.1).
Default Values
Command History
Usage Examples
(config-interface-vlan 1)#media-gateway ip primary

qos-policy
Syntax Description
Default Values
Command History
Functional Notes

Usage Examples
The following example applies the QoS map VOICEMAP to the virtual local area network (VLAN) interface:
(config-interface-vlan 1)#qos-policy out VOICEMAP

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on the virtual local area network (VLAN) interface:
(config-interface-vlan 1)#rtp quality-monitoring

snmp trap
Syntax Description
No subcommands.
Default Values
enabled.
Command History
interface.
Usage Examples
The following example enables SNMP capability on the VLAN interface:
(config-interface-vlan 1)#snmp trap


Syntax Description
No subcommands.
Default Values
By default, the ifLinkUpDownTrapEnable object identifier (OID) is set to enabled for all interfaces except
virtual Frame Relay interfaces.
Command History
interface.
interface.
Functional Notes
number 1.3.6.1.2.1.31.1.1.1.14.0).
Usage Examples
The following example disables the link-status trap on the VLAN interface:
(config-interface-vlan 1)#no snmp trap link-status


Use the traffic-shape rate command to specify and enforce an output bandwidth for the virtual local area
network (VLAN) interface. Use the no form of this command to disable this feature. Variations of this
command include:

Syntax Description
Default Values
By default, traffic-shape rate is disabled.
Command History
Functional Notes
Traffic shaping can be used to limit the VLAN interface to a particular rate or to specify use of quality of
service (QoS).
Usage Examples
The following example sets the outbound rate of vlan 1 to 128 kbps and applies a QoS policy that gives all
Realtime Transport Protocol (RTP) traffic priority over all other traffic:

(config-qos-map)#interface vlan 1
(config-interface-vlan 1)#traffic-shape rate 128000
(config-interface-vlan 1)#qos-policy out voip


Syntax Description
Default Values
Command History
Functional Notes
Usage Examples


vrrp <number>
Use the vrrp command to configure Virtual Router Redundancy Protocol (VRRP) routers within a router
group. Use the no form of this command to remove the VRRP router’s configurations. Variations of this
command include:
vrrp <number> description <text>

vrrp <number> ip <address>
vrrp <number> ip <address> secondary
vrrp <number> preempt
vrrp <number> preempt delay minimum <time>
vrrp <number> priority <level>
vrrp <number> shutdown
vrrp <number> startup-delay <delay>
vrrp <number> timers advertise <interval>
vrrp <number> timers learn
vrrp <number> track <name>
vrrp <number> track <name> decrement <value>
Syntax Description
<number> Specifies the VRRP router group’s virtual router ID (VRID) number. Range
is 1 to 255.
description <text> Specifies the textual description of the VRRP router within the group.
ip <address> Specifies the IP address to be used by the VRRP router. IP addresses
secondary Optional. Specifies the entry of an additional VRRP router supported IP
address.
preempt Allows a VRRP router to preempt the current master router if its priority level
is higher than the current master’s.
delay minimum <time> Optional. Specifies a delay (in seconds) before the specified router will
attempt to preempt the current master router. Range is 0 to 255 seconds.
priority <level> Specifies the configured priority level of the VRRP router. Level range is 1 to
254.
shutdown Disables the VRRP router.
startup-delay <delay> Specifies a time delay (in seconds) before a VRRP router becomes active.
timers Specifies the configuration of the VRRP timers.
advertise <interval> Specifies the time (in seconds) between advertisements sent by the master
router. Range is 1 to 255 seconds.
learn Specifies that the backup VRRP router learns the advertisement interval of
the master router.
track <name> Specifies a change in priority level of the VRRP router based upon the
specified track.

decrement <value> Optional. Specifies the numerical amount to decrement the VRRP’s priority
level if the track transitions to a FAIL state. Decrement value range is 1 to
254.
Default Values
By default, VRRP is enabled.
By default, a VRRP router will preempt with no additional delay.
The default configured priority for a VRRP router that is either a backup router or not the IP address owner
is 100. The default actual priority of a VRRP router that is the IP address owner is 255.
By default, startup-delay is enabled with a default value of 35 seconds.
By default, the advertisement interval is 1 second.
By default, the default decrement value is 10.
Command History
Functional Notes
A VRRP router may be part of more than one virtual router group. Although VRRP group VRIDs can be
numbered between 1 and 255, only two VRRP routers per interface are supported.
It is recommended that the timers advertise setting is kept at the default value. If it is necessary to change
this setting, ensure that all VRRP routers are configured with the new value, as all VRRP routers in the
virtual group must have the same advertisement interval value. It is also recommended that if the timers
learn function is enabled on one router in a virtual router group, then the timers learn function should be
enabled on all routers in the group.
When the virtual router’s specified IP address is independent of the IP addresses assigned to real
interfaces on the VRRP routers, there is no IP address owner. This addressing method is preferred if
object tracking will be used to monitor the network connection. The IP address used for the virtual router
must be on the same subnet as either the primary or secondary IP addresses assigned to the VRRP
router’s real interface.
A track must be created before the vrrp track command can be issued. Refer to the Network Monitor
Track Command Set on page 2356 for more information on creating tracks. If a VRRP router owns the
virtual router IP address, then the VRRP router’s priority level cannot be decremented as a result of the
track command. If object tracking will be used, it is important that no VRRP router own the virtual router IP
address.
Usage Examples
The following example describes a VRRP router within virtual router group 1 as the Default Master
Router:
(config-interface-vlan 1)#vrrp 1 description Default Master Router

The following example specifies an IP address of 10.0.0.1 for a VRRP router within virtual router group 1:
(config-interface-vlan 1)#vrrp 1 ip 10.0.0.1
The following example specifies that the VRRP router within virtual router group 1 preempts the current
master router after a 30 second delay:
(config-interface-vlan 1)#vrrp 1 preempt delay minimum 30
The following example specifies the configured priority for the VRRP router within virtual router group 1 is
254:
(config-interface-vlan 1)#vrrp 1 priority 254
The following example disables the VRRP router within virtual router group 1:
(config-interface-vlan 1)#vrrp 1 shutdown
The following example configures a VRRP router on group 1 to delay 45 seconds before becoming active:
(config-interface-vlan 1)#vrrp 1 startup-delay 45

WIRELESS INTERFACE COMMAND SETS

• AP Interface Command Set on page 2223

• Radio Interface Command Set on page 2239
• VAP Interface Command Set on page 2263

Command Reference Guide AP Interface Command Set
AP INTERFACE COMMAND SET
The Access Point Interface Configuration command set is used to configure wireless access points (APs)
connecting to an AOS platform running the ADTRAN Wireless Control Protocol (AWCP). The AP is
either a physical standalone unit (such as the NetVanta 150) or integrated within an AOS platform via a
module, also known as an embedded access point module (EAPM).
Enter the interface dot11ap command at the Global Configuration mode prompt to activate the AP
Interface Configuration mode. For example:
>enable
#configure terminal
(config-dot11ap 1)#
Additional steps must be performed before the AP is ready for connectivity. The radio-level
settings are configured using the Radio Interface Command Set on page 2239. The virtual
access point (VAP) settings are configured using the VAP Interface Command Set on page
2263.
do on page 51
exit on page 53
access-point controller-standby on page 2224
access-point mac-address <mac address> on page 2225
association access-list <name> on page 2226
country-region on page 2227
encapsulation 802.1q on page 2229
ethernet-speed on page 2231
event-history on page 2232
full-duplex on page 2233
half-duplex on page 2234
ip address <ip address> <subnet mask> on page 2235
ip default-gateway <ip address> on page 2236
location <name> on page 2237
name <name> on page 2238

access-point controller-standby
Use the access-point controller-standby command to release wireless access controller (AC) control of
the wireless access point (AP). This command will cause the AC to stop responding to echo requests from
the AP, thus releasing control of the AP. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, controller-standby mode is disabled.
Command History
Usage Examples
The following example enables controller-standby mode for this AP interface:
(config-dot11ap 1)#access-point controller-standby

access-point mac-address <mac address>

Use the access-point mac-address command to specify the medium access control (MAC) address of the
physical wireless access point (AP) Ethernet interface. Use the no form of this command to delete the
MAC address of the AP.
Syntax Description
Default Values
Command History
Functional Notes
This command binds the wireless access controller (AC) to the AP. Without specifying the MAC address,
the AC cannot control the AP.
Usage Examples
The following example configures an AP MAC address of 00:0A:C8:5F:00:D2:
(config-dot11ap 1)#access-point mac-address 00:0A:C8:5F:00:D2

association access-list <name>

Use the association access-list command to specify a medium access control (MAC) address filter. This
filter will only allow access to specific wireless clients. A MAC access control list (ACL) must be created
before it can be associated with this wireless access point (AP). Refer to mac access-list standard <name>
on page 1028 for more information. Use the no form of this command to remove an associated MAC ACL
from this AP.
Syntax Description
<name> Specifies the name of the previously created MAC ACL.
Default Values
By default, no MAC ACLs are associated with an AP.
Command History
Usage Examples
The following example configures the AP to use the MAC ACL named allowlist as a filter for allowing
access:
(config-dot11ap 1)#association access-list allowlist

country-region
Use the country-region command to specify the country region or domain where the wireless access point
(AP) is being used so that the radio can modify its settings to conform to that country’s regulations. Use the
no form of this command to return to the default value. Variations of this command include:
country-region Asia
country-region Australia
country-region Canada
country-region Denmark
country-region Europe
country-region Finland
country-region France
country-region Germany
country-region Ireland
country-region Italy
country-region Japan
country-region Mexico
country-region Netherlands
country-region New_Zealand
country-region Norway
country-region Puerto_Rico
country-region South_America
country-region Spain
country-region Sweden
country-region Switzerland
country-region UK
country-region USA
Syntax Description
Asia Specifies Asia configuration.
Australia Specifies Australia configuration.
Canada Specifies Canada configuration.
Denmark Specifies Denmark configuration.
Europe Specifies Europe configuration.
Finland Specifies Finland configuration.
France Specifies France configuration.
Germany Specifies Germany configuration.
Ireland Specifies Ireland configuration.
Italy Specifies Italy configuration.
Japan Specifies Japan configuration.
Mexico Specifies Mexico configuration.
Netherlands Specifies Netherlands configuration.
New_Zealand Specifies New Zealand configuration.

Norway Specifies Norway configuration.

Puerto_Rico Specifies Puerto Rico configuration.
South_America Specifies South America configuration.
Spain Specifies Spain configuration.
Sweden Specifies Sweden configuration.
Switzerland Specifies Switzerland configuration.
UK Specifies UK configuration.
USA Specifies USA configuration.
Default Values
By default, the country-region is set to USA.
Command History
Usage Examples
The following example sets the country of operation to Norway:
(config-dot11ap 1)#country-region Norway

Use the encapsulation 802.1q command to set the wireless access point (AP) for virtual local area
network (VLAN) encapsulation 802.1q mode. This will apply VLAN tags to the user traffic. Use the no
form of this command to disable VLAN encapsulation. Variations of this command include:
encapsulation 802.1q awcp-vlan <vlan id> native
encapsulation 802.1q awcp-vlan <vlan id> native priority <level>
Syntax Description
awcp-vlan <vlan id> Optional. Specifies an existing VLAN to be used for ADTRAN Wireless
Control Protocol (AWCP) connection. Valid range is 1 to 4096. For more
information on creating a VLAN, refer to VLAN Interface Command Set on
page 2162.
native Enables native mode for the specified VLAN. Packets from this VLAN
leaving the interface will not be tagged with the VLAN number. Any
untagged packets received by the interface are considered a part of the
native VLAN ID. Only one VLAN may be set to native. To change where the
native VLAN resides, the current native must be disabled using the no form
of this command before a new one is set.
priority <level> Optional. Specifies the 802.1q priority level for AWCP packets generated by
this AP when VLAN tags are applied. Valid range is 1 to 7, with 1 being the
highest priority.
Default Values
By default, encapsulation 802.1q is disabled on the AP.
Command History
Release 15.1 Command was expanded to include the access point (AP) interface.
Functional Notes
Settings (including encapsulation, VLAN, and native VLAN) for the AP's Ethernet interface must be
coordinated with the physical interface to which the AP is connected.
Since all functions on an AP use the same Ethernet interface, there should be only one VLAN ID set to
native on the entire AP. It is possible that a VLAN can be used on a virtual access point (VAP) and for the
AWCP protocol on the AP’s Ethernet, but this is not typical. Typically, the control protocol will use the
native VLAN and the VAP’s data will all be tagged on the Ethernet.
This means that one VLAN on one radio's VAP may be set to native or the control protocol (AWCP) VLAN
may be set to native, but not both unless they both use the same VLAN ID. Typically, the control protocol
will use the native VLAN.

If the control protocol and a VAP share the same VLAN ID, control protocol packets will be intercepted by
the AP while noncontrol protocol packets will be forwarded to the VAP.
If the AP is to be in trunk mode and the AWCP VLAN is not the native VLAN for the trunk, care must be
exercised in transitioning the AP and switchport from access port (nontrunk) mode. The AP should be
configured first, then the switchport set to match. When transitioning the AP, set its AWCP VLAN first, then
enable trunking mode (encapsulation 802.1q). If the AWCP VLAN is the native VLAN on the AP and
switch, AWCP communication will not be lost no matter what combination of trunk mode settings is
applied.
Usage Examples
The following example enables encapsulation 802.1q on this AP and makes VLAN 1 the native VLAN:
(config-dot11ap 1)#encapsulation 802.1q awcp-vlan 1 native

ethernet-speed
Use the ethernet-speed command to configure the speed of the wireless access point’s (AP) Ethernet
interface. Use the no form of this command to return to the default value. Variations of this command
include:
ethernet-speed 10
ethernet-speed 100
ethernet-speed auto
This command is not available for the embedded access point module (EAPM). For the
EAPM, the Ethernet speed is fixed at 100 Mbps.
Syntax Description
10 Configures the AP's Ethernet speed for 10 Mbps.
100 Configures the AP's Ethernet speed for 100 Mbps.
auto Configures the AP's Ethernet speed for auto negotiation.
Default Values
By default, the ethernet-speed is set to auto.
Command History
Usage Examples
The following example sets the AP’s Ethernet speed to 10 Mbps:
(config-dot11ap 1)#ethernet-speed 10

event-history
Use the event-history command to configure the wireless access point (AP) to transmit log messages to
the wireless access controller (AC) via the control protocol. The AC will then integrate these messages into
the AC’s event subsystem for local display, history, or syslog forwarding. Use the no form of this
command to terminate log messages. Variations of this command include:
event-history on
event-history priority <level>
Syntax Description
on Enables the AP to send log messages to the AC.
priority <level> Sets the minimum priority level of messages sent to the AC. This setting is
provided on a per-AP basis so that the user can control the level of logging
traffic that will occur on their network. The levels are: 1 (Alert), 2 (Critical),
3 (Error), 4 (Warning), 5 (Notice), 6 (Informational).
Default Values
By default, event history transmission is disabled and the priority level is 3. This means that messages with
levels 1 through 3 will be sent, and messages with level 4 through 6 will not be sent.
Command History
Usage Examples
The following example changes the minimum priority level of the log messages sent to the AC to 6. This
will send all log messages to the AC:
(config-dot11ap 1)#event-history priority 6

full-duplex
Use the full-duplex command to configure the wireless access point (AP) Ethernet interface for
full-duplex operation. This allows the interface to send and receive simultaneously. Use the no form of this
command to return to the default half-duplex operation.
This command is not available for the embedded access point module (EAPM). The EAPM
is fixed at full-duplex operation.
Syntax Description
No subcommands.
Default Values
By default, all AP Ethernet interfaces are configured for half-duplex operation.
Command History
Release 15.1 Command was introduced for the AP interface.
Functional Notes
Full-duplex Ethernet is a variety of Ethernet technology currently being standardized by the IEEE. Because
there is no official standard, vendors are free to implement their independent versions of full-duplex
operation. Therefore, it is not safe to assume that one vendor’s equipment will work with another.
Devices at each end of a full-duplex link have the ability to send and receive data simultaneously over the
link. Theoretically, this simultaneous action can provide twice the bandwidth of normal (half-duplex)
Ethernet. To deploy full-duplex Ethernet, each end of the link must only connect to a single device. With
only two devices on a full-duplex link, there is no need to use the medium access control mechanism (to
share the signal channel with multiple stations) and listen for other transmissions or collisions before
sending data.
Usage Examples
The following example configures the AP’s Ethernet interface for full-duplex operation:
(config-dot11ap 1)#full-duplex

half-duplex
Use the half-duplex command to configure the wireless access point’s (AP) Ethernet interface for
half-duplex operation. This setting allows the Ethernet interface to either send or receive at any given
moment, but not simultaneously. Use the no form of this command to disable half-duplex operation.
This command is not available for the embedded access point module (EAPM).
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
Half-duplex Ethernet is the traditional form of Ethernet that employs the carrier sense multiple
access/collision detect (CSMA/CD) protocol to allow two or more hosts to share a common transmission
medium while providing mechanisms to avoid collisions. A host on a half-duplex link must listen on the link,
and only transmit when there is an idle period. Packets transmitted on the link are broadcast (so it will be
heard by all hosts on the network). In the event of a collision (two hosts transmitting at once), a message is
sent to inform all hosts of the collision and a backoff algorithm is implemented. The backoff algorithm
requires the station to remain silent for a random period of time before attempting another transmission.
This sequence is repeated until a successful data transmission occurs.
Usage Examples
The following example configures the AP Ethernet interface for half-duplex operation:
(config-dot11ap 1)#half-duplex


Use the ip address command to define an IP address for the access point (AP) Ethernet interface. Use the
no form of this command to remove a configured IP address.
Syntax Description
Default Values
Command History
Functional Notes
The IP address and subnet mask are only needed on the AP interface if the user wants to use remote
authentication dial-in user service (RADIUS) authentication with the wireless clients. A default gateway
may also need to be specified.
Usage Examples
The following example configures an IP address of 192.22.72.101 and a subnet mask of 255.255.255.252:
(config-dot11ap 1)#ip address 192.22.72.101 255.255.255.252

ip default-gateway <ip address>

Use the ip default-gateway command to assign a default gateway to the wireless access point (AP). This
allows the AP to communicate with IP devices on other IP subnets. Use the no form of this command to
remove the default gateway.
Syntax Description
<ip address> Specifies the default gateway IP address. IP addresses should be
Default Values
By default, there is no configured default gateway.
Command History
Usage Examples
The following example assigns the AP a default gateway for 10.10.10.1:
(config-dot11ap 1)#ip default-gateway 10.10.10.1

location <name>
Use the location command to specify the location of the wireless access point (AP). Use the no form of
this command to remove the specified location.
Syntax Description
<name> Specifies the name of the location of the AP. The location name may be up
to 32 characters.
Default Values
Command History
Usage Examples
The following example assigns the name floor5 as the location of AP 1:
(config-dot11ap 1)#location floor5

name <name>
Use the name command to specify a name for this wireless access point (AP). Use the no form of this
command to remove the assigned name.
Syntax Description
<name> Specifies the name of the AP. The name may be up to 32 characters in
length.
Default Values
By default, the name of the AP will be ADTN plus the last three bytes of the AP medium access control
(MAC) address (all uppercase).
Command History
Usage Examples
The following example assigns the name accounting1 to AP 1:
(config-dot11ap 1)#name accounting1

Command Reference Guide Radio Interface Command Set
RADIO INTERFACE COMMAND SET
A radio interface is a virtual interface that can be programmed into an AOS platform running the
ADTRAN Wireless Control Protocol (AWCP). This interface is used to configure radio-level commands
for an 802.11 wireless access point (AP). The AP is either a physical standalone unit (such as the
NetVanta 150) or integrated within the AOS platform via a module, also known as an embedded access
point module (EAPM).
The associated AP interface must be configured before access to the Radio Interface Configuration mode is
possible. For more information on configuring the AP, refer to AP Interface Command Set on page 2223.
Upon creation, each radio will have one default virtual access point (VAP) configured. More detailed
information on configuring the VAP interface is provided in VAP Interface Command Set on page 2263.
There are only two radio types: 802.11a and 802.11bg. Radio 802.11bg defaults to interface dot11ap
<ap/1> and radio 802.11a defaults to interface dot11ap <ap/2>. The only changes that can be made to
the radio types is to specify the radio mode of the 802.11bg radio as type b, g, or bg using the command
radio-mode on page 2253.
The parent (AP) interface must be created before access to the Radio Interface
Configuration mode is possible. Execute the interface dot11ap <ap> command to create
an AP interface.
To activate Radio Interface Configuration mode for an 802.11b or g radio, enter the commands at the
Global Configuration mode prompt as shown below:
>enable
#configure terminal
(config)#interface dot11ap 1/1
(config-dot11ap 1/1-bg)#
To activate Radio Interface Configuration mode for an 802.11a radio, enter the commands at the Global
Configuration mode prompt as shown below:
>enable
#configure terminal
(config)#interface dot11ap 1/2
(config-dot11ap 1/2-a)#
By default, interface dot11ap <ap/1> is radio type 802.11bg and interface dot11ap
<ap/2> is radio type 802.11a.

Not all radio interface commands apply to both radio types.Use the ? command to display
a list of valid commands.
do on page 51
exit on page 53
shutdown on page 61
antenna on page 2241

beacon period <time> on page 2242
channel <number> on page 2243
fragment-threshold <length> on page 2245
inactivity-timeout max <value> on page 2246
power local on page 2247
preamble-short on page 2248
protection-mode on page 2249
qos-mode wmm on page 2251
radio-mode on page 2253
rts threshold <length> on page 2256
short-slot-time on page 2257
speed on page 2258
speed default basic-set on page 2259
station-role access-point on page 2260
vap-isolation on page 2261
world-mode dot11d on page 2262

antenna
Use the antenna command to select the desired antenna mode. Use the no form of this command to return
to the default value. Variations of this command include the following:
antenna 1
antenna 2
antenna diversity
Syntax Description
1 Sets the antenna mode to transmit or receive on antenna 1.
2 Sets the antenna mode to transmit or receive on antenna 2.
diversity Sets the mode to transmit or receive on antenna with best signal.
Default Values
By default, the antenna is set to diversity.
Command History
Functional Notes
Diversity antennas are two separate antennas that are attached to a single wireless radio. These antennas
are designed to reduce the effects of multi-path radio distortion. Each antenna samples the radio signal
around the access point (AP). The antenna receiving the best signal is chosen to transmit and receive
information. Only one diversity antenna is in use at any given time.
Usage Examples
The following example sets the antenna mode to transmit or receive on antenna 1 on an 802.11bg wireless
radio:
(config)#interface dot11ap 1/1 radio-type 802.11bg

(config-dot11ap 1/1-bg)#antenna 1

beacon period <time>

Use the beacon period command to set the time between beacons. Use the no form of this command to
Syntax Description
<time> Specifies the number of 802.11 time units (TUs) between beacons. One TU
is 1024 microseconds. Range is 20 to 1000 TU.
Default Values
By default, the beacon period is 100 TU.
Command History
Functional Notes
A beacon is a type of management frame used in 802.11 wireless networks. Beacon frames carry
important information, such as the basic service set, parameter sets, and capability. The beacon frame is
sent to the broadcast medium access control (MAC) address, which means that all clients must be able to
receive and process beacons.
Beacon frames are associated with some overhead, which decreases the throughput of the wireless
network. The higher the beacon period, the fewer number of beacons sent, thus reducing overhead and
increasing throughput on the network. However, fewer beacons can cause a delay in the association
process because stations scanning for available access points (APs) may miss the beacons.
Usage Examples
The following example sets the beacon period to 500 TU on an 802.11 bg wireless radio:

(config-dot11ap 1/1-bg)#beacon period 500

channel <number>
Use the channel command to manually select a channel for the wireless radio or to scan for the best
channel available. Use the no form of this command to return to the default value. Variations of this
channel <number>
channel least-congested
Syntax Description
<number> Specifies the Institute of Electrical and Electronics Engineers, Inc. (IEEE)
channel number. The range of channels is dependent on the radio type and
country setting (refer to the table in Functional Notes for a complete list of
supported channels by country).
least-congested Sets the radio to scan for the best channel available.
Default Values
By default, the radio scans for the least-congested channel available.
Command History
Functional Notes
The following table lists the supported channels by country.
802.11a (5 GHz) 802.11bg (2.4 GHz)

Country
Wireless Radios Channels Wireless Radios Channels
Asia 149, 153, 157, 161 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
Australia 36, 40, 44, 48, 52, 56, 60, 64, 149, 153, 157, 161, 165 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
Canada 36, 40, 44, 48, 52, 56, 60, 64, 149, 153, 157, 161, 165 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Denmark 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
Europe 34, 38, 42, 46 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Finland 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
France 34, 38, 42, 46 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Germany 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Ireland 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Italy 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
Japan 34, 38, 42, 46 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
Mexico 36, 40, 44, 48, 149, 153, 157, 161, 165 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Netherlands 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
New Zealand 36, 40, 44, 48, 52, 56, 60, 64, 149, 153, 157, 161, 165 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13

36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Norway 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
Puerto Rico 36, 40, 44, 48, 149, 153, 157, 161, 165 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
South America 802.11a not supported 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Spain 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
Sweden 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
Switzerland 34, 38, 42, 46 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
36, 40, 44, 48, 52, 56, 60, 64, 100, 104, 108, 112, 116, 120, 124, 128,
United Kingdom 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13
132, 136, 140
United States 36, 40, 44, 48, 149, 153, 157, 161, 165 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11
Usage Examples
Type channel ? to display a list of valid channels from which to choose. The list of
channels displayed is based on the selected radio type (refer to the command radio-mode
on page 2253) and country setting (refer to the command country-region on page 2227).
The following example manually sets an 802.11bg wireless radio to channel 6 in the United States:

(config-dot11ap 1/1-bg)#channel 6
The following example manually sets an 802.11a wireless radio to channel 149 in the United States:
(config)#interface dot11ap 1/2 radio-type 802.11a

(config-dot11ap 1/1-a)#channel 149

fragment-threshold <length>
Use the fragment-threshold command to set the packet length threshold. Packets larger than the value set
in this command will be fragmented when transmitted on the wireless link. Use the no form of this
Syntax Description
<length> Specifies the maximum packet length allowed before fragmentation will
occur. Range is 256 to 2346 bytes.
Default Values
By default, the fragment threshold is set at 2346 bytes.
Command History
Functional Notes
Fragment threshold can be set to a lower number to prevent retransmission of large packets, but the
overhead is increased. If the threshold is large, the overhead is relatively small but large packets will be
retransmitted, lowering efficiency.
Usage Examples
The following example sets the fragment threshold at 572 bytes on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#fragment-threshold 572

inactivity-timeout max <value>

Use the inactivity-timeout max command to set the maximum length of inactivity allowed between an
access point (AP) and its clients. If no response is seen from the client within the timeout, the client will be
disassociated. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the maximum length of time a connection between an AP and
access controller (AC) is allowed to remain inactive. Range is 1 to
99 minutes.
Default Values
By default, the maximum inactivity timeout is 5 minutes.
Command History
Usage Examples
The following example sets the maximum inactivity timeout to 2 minutes on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#inactivity-timeout max 2

power local
Use the power local command to select the radio's transmit power level. The range of the power level is
relative to the country region currently specified for the radio. Use the no form of this command to return
to the default value. Variations of this command include:
power local maximum

power local half
power local quarter
power local eighth
power local minimum
Syntax Description
maximum Sets the power local level to the maximum output power setting.
half Sets the power local level to one-half of the maximum output power setting.
quarter Sets the power local level to one-fourth of the maximum output power
setting.
eighth Sets the power local level to one-eighth of the maximum output power
setting.
minimum Sets the power local level to the minimum output power setting.
Default Values
By default, the power local setting is maximum.
Command History
Functional Notes
Radio cell size and interference between cells can be reduced by lowering the radio's transmit power level.
Usage Examples
The following example sets the radio's transmit power to one-half maximum power on an 802.11bg
wireless radio:

(config-dot11ap 1/1-bg)#power local half

preamble-short
Use the preamble-short command to enable short preamble mode on an 802.11bg radio. The preamble is
information at the beginning of a packet that is used by the access point (AP), as well as its clients. Use the
Syntax Description
No subcommands.
Default Values
By default, short preamble mode is enabled.
Command History
Functional Notes
When short preamble mode is enabled, clients may request short or long preambles according to need.
Disabling short preamble mode means that clients must request long preambles only.
Short preamble mode is not supported on the 5 GHz 802.11a radio.
Usage Examples
The following example enables short preamble mode on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#preamble-short

protection-mode
Use the protection-mode command to configure the protection mode, type, and rate for an 802.11bg radio.
Use the no form of this command to return to the default value. Variations of this command include the
following:
protection-mode always
protection-mode always type cts-only
protection-mode always type cts-only rate 1
protection-mode always type cts-only rate 5.5
protection-mode always type rts-cts
protection-mode always type rts-cts rate 1
protection-mode always type rts-cts rate 5.5
protection-mode auto
protection-mode auto type cts-only
protection-mode auto type cts-only rate 1
protection-mode auto type cts-only rate 5.5
protection-mode auto type rts-cts
protection-mode auto type rts-cts rate 1
protection-mode auto type rts-cts rate 5.5
This command is only available on the 802.11bg radio interface.
Syntax Description
always Protection mode is always on regardless of the presence of 802.11b clients.
auto Protection mode is automatically activated when an 802.11b client
associates with an 802.11g access point (AP).
type
cts-only Specifies clear to send-only (CTS-only) protection mode.
rts-cts Specifies request to send-clear to send (RTS-CTS) protection mode.
rate
1 Sets the packet rate to 1 Mbps.

5.5 Sets the packet rate to 5.5 Mbps.

Default Values
By default, protection-mode is set to auto, type is set to cts-only, and the rate is set to 11.
Command History
Functional Notes
Protection mode is used when 802.11b and 802.11g radios exist together on the same wireless local area
network (WLAN) network. 802.11g devices are required to be backwards-compatible with legacy 802.11b
devices. Both radios operate in the 2.4 GHz frequency range; however, each uses a different transmission
type. 802.11b radios use direct sequence spread spectrum (DSSS) for transmitting data, and 802.11g
radios use orthogonal frequency division multiplexing (OFDM) for transmitting data. Contention for media
access on 802.11 networks is managed via carrier sense multiple access with collision avoidance
(CSMA/CA), but the use of two different transmission types prevents 802.11b devices from hearing
transmission attempts on the shared radio frequency (RF) medium. Protection mode addresses this
problem and allows for coexistence of 802.11b and 802.11g devices on a network.
There are two protection mode types: CTS-only, also known as CTS-to-self, and RTS-CTS. Both types are
used when an 802.11g AP associates with an 802.11b client. Compared to a network that contains solely
802.11g clients, use of a protection mode reduces throughput. Compared to each other, CTS-only mode
requires slightly less protocol overhead than RTS-CTS mode. Protection frames must be transmitted at
802.11b rates (1 Mbps, 2 Mbps, 5.5 Mbps, or 11 Mbps) to ensure these frames are received and
processed by all clients on the network.
During CTS-only mode, clients that have a frame for transmission on the RF medium will first transmit a
CTS frame. The destination address specified in this CTS frame is the transmitting client's own medium
access control (MAC) address. All clients connected to the RF medium are required to listen to CTS
frames. A CTS frame is interpreted as a do not send command by all clients except by the one whose MAC
address is specified in the destination field.
When RTS-CTS is employed, clients must request access to the RF medium by sending an RTS to the
AP. The client refrains from accessing the medium and transmitting data until it receives a CTS from the
AP. A CTS command is interpreted as a do not send command when it is received by a client that did not
initiate the RTS. RTS-CTS requires more protocol overhead than CTS-only.
Usage Examples
The following example enables protection mode to automatically activate upon association of an 802.11b
client with an 802.11g AP. RTS-CTS is specified, but the rate is not. This means that the default rate of
11 Mbps will be used.

(config-dot11ap 1/1-bg)#protection-mode auto type rts-cts

qos-mode wmm
Use the qos-mode wmm command to enable WiFi multimedia (WMM) quality of service (QoS) mode.
Use the no form of this command to disable WMM mode. Variations of this command include the
following:
qos-mode wmm
qos-mode wmm no-ack
Syntax Description
no-ack Optional. Specifies the no acknowledgements be sent.
Default Values
By default, WMM QoS mode is disabled.
Command History
Functional Notes
AOS supports WMM, which adds QoS functionality to the wireless network. QoS helps control the
allocation of bandwidth on the wireless local area network (WLAN). The benefits of QoS may not be
noticed if the traffic load on the wireless network is light. However, QoS benefits will become more
apparent as the traffic load on the WLAN increases.
WMM in AOS is based on the enhanced distributed channel access (EDCA) method. This method ensures
that higher priority traffic has a better chance of being transmitted on the WLAN than lower priority traffic.
There are four priority classes defined in WMM to manage traffic from different applications: voice, video,
best-effort, and background. According to algorithms defined in EDCA, a client with traffic in a higher
priority class, such as voice, will typically back off of the radio frequency (RF) medium for a shorter period
of time than a client with traffic in a lower priority class, such as email. In addition, each priority class is
assigned a transmit opportunity (TXOP), which is a set amount of time during which a client can send as
many frames as possible. Higher priority classes are given a longer TXOP interval than lower priority
classes.
WMM must be enabled on both the access points (APs) and the clients running applications that require
QoS. These applications must be able to support WMM for the QoS functionality to be used. In addition,
the applications must be capable of assigning the appropriate priority class to their generated streams of
traffic.
When acknowledgements are enabled, transmission is more reliable because an acknowledge frame is
returned for every frame received. However, acknowledgement frames increase the amount of traffic on
the WLAN, which results in decreased performance. Disabling acknowledgements means that
transmission will not be as reliable, but performance will be better. For example, having no
acknowledgements would be useful for voice traffic because the speed of transmission is most important
and packet loss to a certain degree is tolerable.

Usage Examples
The following example enables WMM QoS mode without acknowledgements on an 802.11bg wireless
radio:

(config-dot11ap 1/1-bg)#qos-mode wmm no-ack

radio-mode
Use the radio-mode command to set a specific radio type. Use the no form of this command to return to
the default value. Variations of this command include the following:
radio-mode a
radio-mode b
radio-mode bg
radio-mode g
Syntax Description
a Specifies radio type a.
b Specifies radio type b.
bg Specifies radio type g in backwards-compatible mode to radio type b.
g Specifies radio type g.
Default Values
By default, the 802.11bg radio is set to radio-mode bg and the 802.11a radio is set to radio-mode a.
Command History
Functional Notes
ADTRAN currently supports three of the IEEE 802.11 wireless local area network (WLAN) standards:
802.11a, 802.11b, and 802.11g. Each access point (AP) contains two integrated radios: one that supports
802.11a and one that supports 802.11b and/or 802.11g.
802.11b is a legacy protocol operating at 2.4 GHz with a maximum throughput of 11 Mbps. This throughput
value is derived from the use of direct sequence spread spectrum (DSSS) technology for transmission.
The North American channel set contains 11 channels, each 22 MHz wide. Out of these 11 channels, there
are only three nonoverlapping or noninterfering channels. The use of three discreet access points (APs) in
the same area, each set to one of the three nonoverlapping channels, will result in an aggregate bandwidth
of 33 Mbps. The theoretical maximum distance for 802.11b is 100 meters. However, the actual distance is
approximately 60 meters in a typical office environment.
802.11g operates at 2.4 GHz with a maximum throughput of 54 Mbps. The obvious benefit to using
802.11g over 802.11b is faster data transmission. The higher maximum throughput is achieved by using
orthogonal frequency division multiplexing (OFDM) in addition to DSSS for transmission. 802.11g is
backwards-compatible to 802.11b, helping to ease migration from an existing 802.11b network to an
802.11g network. However, the maximum throughput for an 802.11g network is reduced when operating in
backwards-compatibility mode with 802.11b. The North American channel set for 802.11g contains
11 channels, each 22 MHz wide. Out of these 11 channels, there are only three nonoverlapping or
noninterfering channels. The use of three discreet APs in the same area, each set to one of the three
nonoverlapping channels, will result in an aggregate bandwidth of 162 Mbps. The theoretical maximum
distance for 802.11g is 100 meters. However, the actual distance is approximately 75 meters in a typical
office environment.

802.11a operates at 5.8 GHz with a maximum throughput of 54 Mbps. OFDM is used for transmission. The
North American channel set for 802.11 is derived from the lower channels, UNII-1 and UNII-2, in the
5.8 GHz frequency range. There are eight nonoverlapping or noninterfering channels, each 33 MHz wide.
The use of eight discreet APs in the same area, each set to one of the eight nonoverlapping channels, will
result in an aggregate bandwidth of 432 Mbps. The theoretical maximum distance for 802.11a is
50 meters. However, the actual distance is approximately 25 meters in a typical office environment.
802.11a is not compatible with 802.11b or g.
The data rate associated with any of the radios will continue to drop as a user moves
farther away from the AP. The highest data rates will be achieved in areas closest to the
AP.
Usage Examples
The following example sets the radio mode to radio type g only on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#radio-mode g

Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables RTP quality monitoring on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#rtp quality-monitoring

rts threshold <length>

Use the rts threshold command to set the threshold for use of request to send (RTS) frames. RTS is used
to gain access to the radio frequency (RF) medium when long frames need to be transmitted. The RTS
threshold defines the minimum long frame length that will require RTS/clear to send (CTS) prior to
transmission. Any frame that matches or is longer than the length specified in the rts threshold command
must be preceded by a RTS/CTS on the RF medium. Use the no form of this command to return to the
default value.
Syntax Description
<length> Specifies the length of the RTS threshold in bytes. Range is 256 to
2346 bytes.
Default Values
By default, the RTS threshold is 2346 bytes.
Command History
Functional Notes
Generally, it is best to set the RTS threshold as high as possible. However, the threshold may need to be
set lower if network throughput is sluggish or there are high numbers of frame retransmissions.
Usage Examples
The following example sets the RTS threshold to 1024 bytes on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#rts threshold 1024

short-slot-time
Use the short-slot-time command to enable short slot time (9 microseconds) for an 802.11bg radio. Use
the no form of this command to return to the long slot time (20 microseconds).
This command is only available on the 802.11bg radio interface.
Syntax Description
No subcommands.
Default Values
By default, short-slot-time is enabled.
Short slot time is used only when the wireless network contains strictly 2.4 GHz, 802.11g
devices and all of those devices support short slot time. If not all 802.11g devices support
short slot time or the wireless network contains both 802.11b and g radios and/or clients,
the radio automatically reverts to standard slot time.
Command History
Functional Notes
Slot time is the amount of time a wireless device waits after a collision before retransmitting a packet. The
standard slot time of 20 microseconds is used in 2.4 GHz, 802.11b and 802.11bg networks. If a wireless
network is strictly 802.11g and all devices are capable of supporting the feature, short slot time
(9 microseconds) can be enabled. Short slot time increases throughput by decreasing the backoff time
calculated by the transmitting device when a collision occurs.
Usage Examples
The following example specifies use of long slot time for 802.11g exclusive networks on an 802.11bg
wireless radio:

(config-dot11ap 1/1-bg)#no short-slot-time

speed
Use the speed command to set the active rate for the radio. Frames cannot be transmitted at a speed that is
higher than the specified active rates. Use the no form of this command to return to the default value.
speed best
speed <speed>
Syntax Description
best Sets the transmit speed of the radio to the best available.
<speed> Sets the transmit speed of the radio. Available speeds vary based on the
setting in the radio-mode command.
For 802.11a radios, choose from 6, 9, 12, 18, 24, 36, 48, or 54 Mbps.
For 802.11b radios, choose from 1, 2, 5.5, or 11 Mbps.
For 802.11bg radios, choose 1, 2, 5.5, 6, 9, 11, 12, 18, 24, 36, 48, or
54 Mbps.
For 802.11g radios, choose 6, 9, 12, 18, 24, 36, 48, or 54 Mbps.
The speed setting best is recommended.
Default Values
By default, the active rate is set to best.
Command History
Usage Examples
The following example sets the active rate to best on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#speed best

speed default basic-set

Use the speed default basic-set command to configure the basic rate set for the radio. A client connecting
to the radio must be able to support these rates. Use the no form of this command to return to the default
basic rate set for the radio type. Variations of this command include the following:
speed default basic-set 802.11

speed default basic-set 802.11b
speed default basic-set 802.11g
speed default basic-set ofdm
Syntax Description
802.11 Speed for 802.11 (1, 2 Mbps).
802.11b Speed for 802.11b (1, 2, 5.5, 11 Mbps).
802.11g Speed for 802.11bg (protection mode) (1, 2, 5.5, 6, 11, 12, 24 Mbps).
ofdm Speed for orthogonal frequency division multiplexing (OFDM) (6, 12,
24 Mbps).
The OFDM basic rate set on an 802.11bg radio should be specified for a network that only
contains 802.11g access points (APs) and clients. This setting maximizes throughput for
802.11g networks, but will not allow 802.11b clients to associate with the access point
(AP).
Default Values
By default, the 802.11bg radio is set to 802.11b and the 802.11a radio is set to ofdm.
Command History
Usage Examples
The following example sets the basic rate set for 802.11bg (protection mode that supports 802.11b and g
clients) on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#speed default basic-set 802.11g

station-role access-point
Use the station-role access-point command to set the radio operation mode to access point (AP). Use the
Syntax Description
No subcommands.
Default Values
By default, the station role is set to access-point.
Command History
Usage Examples
The following example sets the station role to access-point on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#station-role access-point

vap-isolation
Use the vap-isolation command to enable virtual access point (VAP) isolation, which prevents clients
from one VAP on a radio from directly accessing clients in another VAP on the same radio. Use the no
Syntax Description
No subcommands.
Default Values
By default, VAP isolation is disabled.
Command History
Usage Examples
The following example enables VAP isolation an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#vap-isolation

world-mode dot11d
Use the world-mode dot11d command to enable 802.11d mode. This mode allows country codes to be
transmitted in beacons sent from the access point (AP). Use the no form of this command to disable
802.11d mode.
Syntax Description
No subcommands.
Default Values
By default, 802.11d mode is disabled.
Command History
Usage Examples
The following example enables 802.11d mode on an 802.11bg wireless radio:

(config-dot11ap 1/1-bg)#world-mode dot11d

Command Reference Guide VAP Interface Command Set
VAP INTERFACE COMMAND SET
The Virtual Access Point (VAP) Interface Configuration command set is used to configure service set
identifiers (SSIDs) security and other parameters for each VAP.
A VAP is a logical entity that can exist within a physical wireless access point (AP). VAPs are virtual
interfaces represented on wireless networks through the use of a wireless access controller (AC) running
the ADTRAN Wireless Control Protocol (AWCP) and an AP. Each physical AP can support up to eight
VAPs for each of the two radio bands for a total of 16 VAPs. VAPs are distinguished by an SSID and can
be mapped to a virtual local area network (VLAN). VLAN information can be shared across switches with
Ethernet trunks. A common configuration has two VAPs, one associated to a corporate VLAN, and one
associated to a guest VLAN.
The associated AP and radio interfaces must be configured before attempting to configure the VAP. For
more information on configuring the AP and radios, refer to AP Interface Command Set on page 2223 and
Radio Interface Command Set on page 2239. Each radio will have one default VAP configured. The VAP
name is based on the interface to which the AP and radio are mapped using the following syntax, interface
dot11ap <ap/radio.vap>.
To add a VAP or to enter its interface configuration mode, enter the interface dot11ap <ap/radio.vap>
command identifying the appropriate AP and radio interface, followed by the VAP interface number. This
command can be entered from the Global Configuration mode prompt or from any other interface
configuration mode prompt. In the following example, VAP 1 is created for AP 1 with an 802.11bg radio.
For example:
>enable
#configure terminal
do on page 51
exit on page 53
shutdown on page 61
accounting on page 2265

client-separation on page 2267
radius-server host on page 2268

security mode on page 2269

security wep-key on page 2272
security wep-key generate on page 2274
security wep-key-length on page 2275
security wep-key seed <passphrase> on page 2276
security wpa group-key on page 2277
ssid on page 2278
vlan-id <vlan id> on page 2279

accounting
Use the accounting command to enable remote authentication dial-in user service (RADIUS) accounting
for associations with this virtual access point (VAP) and specify update intervals. Use the no form of this
command to disable accounting for this VAP. Variations of this command include:
accounting enabled
accounting update
accounting update newinfo
accounting update periodic
accounting update periodic <value>
Syntax Description
enabled Enables RADIUS accounting on this VAP.
update Defines the RADIUS accounting update setting. Executing the accounting
update command without specifying any further parameters will send
updates when new information occurs. This is the same as executing the
accounting update newinfo command.
newinfo Specifies sending RADIUS accounting records as they occur.
periodic Specifies collecting accounting records and sending them periodically. The
default value is 5.
<value> Optional. Specifies the number of minutes between periodic accounting
updates. Valid range is 1 to 99.
Default Values
By default, RADIUS accounting is disabled.
Functional Notes
The RADIUS server host, access point (AP) IP address, and IP gateway must be configured on the access
point for this feature to work. Refer to radius-server host on page 2268, ip address <ip address> <subnet
mask> on page 2235, and ip default-gateway <ip address> on page 2236 for more information on
configuring these parameters.
Command History

Usage Examples
The following example enables RADIUS accounting for associations with this VAP:

(config-dot11ap 1/1.1-bg)#accounting enabled
The following example enables sending RADIUS accounting updates as they occur for this VAP:

(config-dot11ap 1/1.1-bg)#accounting update newinfo

client-separation
Use the client-separation command to prevent wireless clients within this virtual access point (VAP) from
communicating directly with each other. Use the no form of this command to disable this feature, allowing
clients to communicate with one another. It is recommended to enable this command.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example prevents wireless clients on this VAP interface from communicating directly with
each other:

(config-dot11ap 1/1.1-bg)#client-separation

radius-server host
Use the radius-server host command to specify the parameters for a remote authentication dial-in user
service (RADIUS) server to be used when sending RADIUS messages from the virtual access point
(VAP). At a minimum, the IP address of the server must be given. The other parameters are also allowed
and (if not specified) will use default values or fall back on the global RADIUS server’s default settings.
Use the no form of this command to remove the RADIUS server properties. This prevents the VAP from
using authentication, authorization, and accounting (AAA) methods. Variations of this command include:
radius-server host <ip address> acct-port <port> auth-port <port> key <key>
radius-server host <ip address> acct-port <port> key <key>
radius-server host <ip address> auth-port <port> acct-port <port> key <key>
radius-server host <ip address> auth-port <port> key <key>
radius-server host <ip address> key <key>
Syntax Description
<ip address> Specifies a valid IP address for the RADIUS server. IP address should be
acct-port Specifies the remote port to send accounting requests to.
auth-port Specifies a remote port to send authentication requests to.
<port> Specifies a User Datagram Protocol (UDP) port number to be used when
sending authentication or accounting information to the RADIUS server.
key <key> Defines the shared key used between the RADIUS server and the access
point. The key must appear last on the input line since it reads the rest of
the line beyond the key keyword. The maximum length is 64 bytes.
Default Values
By default, a RADIUS server is not defined. The default setting for acct-port is 1813 and for auth-port is
1812. By default, no key is configured.
Command History
Release 15.1 Command was expanded to include the VAP interface.
Usage Examples
The following example defines the RADIUS server parameters with an IP address of 10.10.10.1, sets the
accounting port to 1646, and configures the shared key as abc123:

(config-dot11ap 1/1.1-bg)#radius-server host 10.10.10.1 acct-port 1646 key abc123

security mode
Use the security mode command to configure the security mode settings for this virtual access point
(VAP). Use the no form of this command to return to the default setting. Depending on the mode chosen
between wired equivalency privacy (WEP) and wi-fi protected access (WPA), further command options
are available.
WEP security mode is not as secure as WPA and is not recommended.
security mode none

security mode wep open-key
security mode wep open-key eap
security mode wep open-key eap md5-static-key
security mode wep open-key eap md5-static-key-optional
security mode wep shared-key
security mode wpa aes-ccmp eap
security mode wpa aes-ccmp psk <key>
security mode wpa aes-ccmp tkip eap
security mode wpa aes-ccmp tkip psk <key>
security mode wpa tkip aes-ccmp eap
security mode wpa tkip aes-ccmp psk <key>
security mode wpa tkip eap
security mode wpa tkip psk <key>
In order to connect to the access point (AP), a client must support the same security mode
as configured on this VAP.
Syntax Description
none Specifies that no security be used on this VAP. There is no authentication
required to connect to this VAP and no encryption is provided on the
wireless connection.
wep Configures the VAO for WEP security mode.
open-key Specifies that the WEP security mode use open authentication with static
WEP keys. The client and the VAP must be configured with the same static
key. A static WEP key is configured on the VAP by using the command
security wep-key on page 2272.
shared-key Specifies that the WEP security mode use shared authentication with
encrypted static keys. The client and the VAP must be configured with the
same static key. A static WEP key is configured on the VAP by using the
command security wep-key on page 2272.

eap Specifies that the WPA security mode use the Extensible Authentication
Protocol (EAP) as a universal authentication framework in the wireless
network. A client must support WEP with 802.1x. Authentication is
performed between the client and a remote authentication dial-in user
service (RADIUS) server.
eap md5-static-key Defines the WEP security mode for this VAP. A client must support WEP
with 802.1x. Authentication is performed between the client and a RADIUS
server. It indicates that all clients are using EAP-type message digest 5
(MD5). This EAP type does not perform key generation and requires
appropriate static WEP keys be configured on this VAP (refer to security
wep-key on page 2272). The user can specify security WEP keys 2 through
4, the first WEP key is obtained from the RADIUS server.
eap md5-static-key-optional Defines the WEP security mode for this VAP. A client must support WEP
with 802.1x. Authentication is performed between the client and a RADIUS
server. It indicates that some clients are using EAP-type MD5 while other
clients are using more advanced EAP types (transport layer security (TLS),
Protected Extensible Authentication Protocol (PEAP), etc.). Unlike the
advanced EAP types, EAP-type MD5 does not perform key generation and
requires appropriate static WEP keys be configured on this VAP (refer to
security wep-key on page 2272). The user can specify security WEP keys 2
through 4, the first WEP key is obtained from the RADIUS server.
wpa Configures this VAP for WPA security mode.
aes-ccmp Specifies using the WPA2 algorithms. This security setting can be used
alone or in combination with Temporal Key Integrity Protocol (TKIP).
tkip Specifies that the WPA security mode use TKIP as its keying structure. This
protocol specifies the algorithms used for rotating keys. TKIP can be used
alone or in combination with aes-ccmp.
psk Specifies that the WPA security mode use preshared keys (PSKs) for key
management. PSK may be used in combination with tkip and/or aes-ccmp.
This method does not require a RADIUS authentication server. The PSK
must be known on all VAP clients.
<key> Defines the PSK for security. The key must consist of 8 to 63 ASCII or 16 to
126 hexadecimal characters. Clients supporting WPA PSK are allowed to
connect to this VAP.
Default Values
By default, no security mode is defined.
Command History

Usage Examples
The following example shows a typical configuration of these parameters:

(config-dot11ap 1/1.1-bg)#security mode wpa tkip psk myPresharedKey

security wep-key
Use the security wep-key command to define the wired equivalency privacy (WEP) keys for use in wep
shared-key and wep open-key security modes (refer to the command security mode on page 2269). Up to
four keys can be programmed. Set these keys before selecting the WEP security mode. Use the no form of
this command to disable the specified key. Variations of this command include:
security wep-key <index> <key>

security wep-key <index> <key> transmit-key
Specifying security mode wep open-key eap does not require any WEP keys to be defined
on the virtual access point (VAP).
Syntax Description
<index> Indicates the WEP key index value. The value and order of WEP-static keys
must match on the access point (AP) and all connecting clients. Valid
entries are 1 to 4 for wep shared-key and wep open-key. For eap
md5-static-key and eap md5-static-key-optional modes, the user can
specify security wep-key 2 through security wep-key 4, the first WEP key
is obtained from the remote authentication dial-in user service (RADIUS)
server.
<key> Specifies the WEP key in hexadecimal characters. The key size is
determined using the command security mode on page 2269 for wep
shared-key or wep open-key security. The key length must follow the
setting of the security wep-key-length on page 2275.
transmit-key Enables the specified key to encrypt all wireless traffic sent by this VAP.
Only one WEP key index can be the current transmit key. The first index
entered under a VAP becomes the transmit key by default. The most recent
index specified with the transmit-key keyword becomes the current
transmit key. The default is the first WEP key index entered for the VAP.
Default Values
By default, no keys are defined.
Command History

Functional Notes
The client and the AP must be configured with the same static key.
The corresponding number of hexadecimal or ASCII characters required is:
AP WEP Key Size Hexadecimal CharactersASCII Characters
40 10 5
104 26 13
128 32 16
The addition of 24-bit initialization vector (IV) makes the 40 bits become 64 bits, 104 bits
become 128, and 128 bits become 152 on the client.
Usage Examples
The following example creates a static WEP key at index 2 with a hexadecimal value of 343f49546a:

(config-dot11ap 1/1.1-bg)# security wep-key 2 343f49546a

security wep-key generate

Use the security wep-key generate command to generate wired equivalency privacy (WEP) keys for
shared-key and wep open-key security modes (refer to the command security mode on page 2269). Up to
four keys can be generated from the passphrase entered using the command security wep-key seed
<passphrase> on page 2276.
Syntax Description
No subcommands.
Default Values
By default, no keys are defined or generated.
Command History
Functional Notes
The generation of WEP keys occurs through the use of a standard message digest 5 (MD5) key generator.
The generator creates secure WEP keys by assigning random values for each element (letters or
numbers) in the passphrase entered using the command security wep-key seed <passphrase> on page
2276.
Usage Examples
The following example enables WEP key generation on 802.11bg wireless radio virtual access point (VAP)
1 based on the passphrase adtran6808:
(config)#interface dot11ap 1/1.1 radio-type 802.11bg

(config-dot11ap 1/1.1-bg)#security wep-key-seed adtran6808
(config-dot11ap 1/1.1-bg)#security wep-key generate

security wep-key-length
Use the security wep-key-length command to specify the length of the wired equivalency privacy (WEP)
key to be programmed with the security wep-key command. Use the no form of this command to return to
the default setting. Variations of this command include:
security wep-key-length 104

The addition of 24-bit initialization vector (IV) makes the 40 bits become 64 bits, 104 bits
become 128, and 128 bits become 152 on the client.
Syntax Description
wep-key-length Specifies the WEP key length. Valid entries are 40, 104, and 128.
Default Values
By default, no keys are defined.
Command History
Functional Notes
There are four keys to program. At least one WEP key must be defined. The corresponding number of
hexadecimal characters required is determined by:
key size on client, key size on AP = number of keys multiplied by the hexadecimal characters in the key
Examples:
64, 40 = 4 x 10
128, 104 = 4 x 26
152, 128 = 4 x 32
Usage Examples
The following example sets the WEP key length to 104:

(config-dot11ap 1/1.1-bg)#security wep-key-length 104

security wep-key seed <passphrase>

Use the security wep-key seed command to set a passphrase for the generation of wired equivalency
privacy (WEP) keys for use in wep shared-key and wep open-key security modes (refer to the command
security mode on page 2269). Use the no form of this command to clear the passphrase.
Syntax Description
<passphrase> A phrase of 1 to 32 characters used as the basis for WEP key generation.
Default Values
By default, no passphrase is set.
Command History
Functional Notes
The generation of WEP keys occurs through the use of a standard message digest 5 (MD5) key generator.
The generator creates secure WEP keys by assigning random values for each element (letters or
numbers) in the passphrase. Refer to the command security wep-key generate on page 2274 for more
information.
Usage Examples
The following example creates a passphrase of adtran6808 to use in WEP key generation on 802.11bg
wireless radio on virtual access point (VAP) 1:
(config)#interface dot11ap 1/1.1 radio-type 802.11bg

(config-dot11ap 1/1.1-bg)#security wep-key seed adtran6808

security wpa group-key

Use the security wpa group-key command to enable group key (broadcast key) rotation for the specified
virtual access point (VAP). Use the no form of this command to disable group key rotation. Variations of
security wpa group-key

security wpa group-key change <minutes>
security wpa group-key change <minutes> membership-termination
Syntax Description
change <minutes> Enables a periodic change of the group key. Specify the number of minutes
between group key changes. Valid range is 10 to 600 minutes, with the
default being 30 minutes.
membership-termination Optional. Specifies a change of the group key at the termination of any
membership association.
Default Values
By default, group key rotation is disabled.
Command History
Usage Examples
The following example enables wired WPA group key rotation on the VAP:

(config-dot11ap 1/1.1-bg)#security wpa group-key
The following example enables a 15-minute change of the group key and also enables the group key to
change any time a membership is terminated:

(config-dot11ap 1/1.1-bg)#security wpa group-key change 15 membership-termination

ssid
Use the ssid command to assign the service set identifier (SSID) for this virtual access point (VAP) and
indicate whether to broadcast the SSID over the network. The SSID is a unique identifier consisting of up
to 32 characters (letters or numbers). Use the no form of this command to return to the default setting.
ssid broadcast-mode <text>

ssid non broadcast-mode <text>
Syntax Description
broadcast-mode Enables broadcasting the SSID in beacons transmitted for this VAP.
non broadcast-mode Blocks broadcasting the SSID for this VAP. This setting is used in closed
wireless networks. Devices connecting to the access point (AP) in
nonbroadcast mode require the wireless device to enter the SSID.
<text> Specifies an SSID for the VAP. The SSID can consist of up to 32 characters
using text or letters and can also include spaces.
Default Values
By default, the SSID is set as wireless vap-index radio-index.
Command History
Usage Examples
The following example configures the SSID of VAP interface 1 as WLAN1 and blocks broadcasting this
SSID:

(config-dot11ap 1/1.1-bg)#ssid non broadcast-mode WLAN1

vlan-id <vlan id>

Use the vlan-id command to associate a virtual local area network (VLAN) with the virtual access point
(VAP) interface. Encapsulation 802.1q must be enabled on the access point (AP) before wireless traffic is
routed with the VLAN ID attached. To enable encapsulation, refer to the command encapsulation 802.1q
on page 2229. Use the no form of this command to remove an entry.
Syntax Description
<vlan id> Specifies a VLAN interface ID number. Range is 1 to 4095.
Default Values
By default, the VLAN ID is the same number as the VAP interface number.
Functional Notes
Once encapsulation 802.1q is enabled on the AP, all wireless traffic received on the VAP’s service set
identifier (SSID) is mapped to the VLAN (specified by the VLAN ID) when sent out the AP's Ethernet
interface. All wireless traffic received on this VLAN ID at the AP's Ethernet interface is mapped to this
VAP's SSID for wireless transmission.
Command History
Release 15.1 Command was expanded to include the VAP interface.
Usage Examples
The following example configures the vlan-id to 4 for VAP interface 1:

(config-dot11ap 1/1.1-bg)#vlan-id 4

ROUTING PROTOCOL COMMAND SETS

• AS Path List Command Set on page 2281

• BGP Command Set on page 2284
• BGP Neighbor Command Set on page 2299
• Community List Command Set on page 2316
• Network Monitor Probe Command Set on page 2319
• Network Monitor Probe Responder Command Set on page 2346
• Network Monitor Track Command Set on page 2356
• Router (OSPF) Command Set on page 2371
• Router (PIM Sparse) Command Set on page 2391
• Router (RIP) Command Set on page 2395

Command Reference Guide AS Path List Command Set
AS PATH LIST COMMAND SET
To activate the Autonomous System (AS) Path List Configuration mode, enter the ip as-path-list
>enable
#configure terminal
(config)#ip as-path-list MyList
do on page 51
deny <value> on page 2282

permit <value> on page 2283

deny <value>
Use the deny command to add an entry to the community list that denies Border Gateway Protocol (BGP)
routes containing the specified community number in the community attribute. Use the no form of this
command to remove the statement from the community list.
Syntax Description
<value> Denies routes that contain this value in their community attribute. This is a
numeric value that can be an integer from 1 to 4294967295 or string in the
form aa:nn, where aa is the autonomous system (AS) number and nn is the
community number. Multiple community number parameters can be present
in the command.
Default Values
Command History
Usage Examples
The following example creates a community list named MyList to deny BGP routes that match the AS path
attributes 30:22:

(config-as-path-list)#deny 30:22

permit <value>
Use the permit command to add an entry to the community list that allows only Border Gateway Protocol
(BGP) routes containing the specified community number in the community attribute. Use the no form of
this command to remove the statement from the community list.
Syntax Description
<value> Permits routes that contain this value in their community attribute. This is a
in the command.
Default Values
Command History
Usage Examples
The following example creates a community list named MyList to permit BGP routes that match the AS
path attributes 30:22:

(config-as-path-list)#permit 30:22

Command Reference Guide BGP Command Set
BGP COMMAND SET
To activate the Border Gateway Protocol (BGP) Configuration mode, enter the router bgp command at
the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#router bgp 1
(config-bgp)#
do on page 51
end on page 52
bgp on page 2285

bgp default local-preference <value> on page 2286
bgp fast-external-failover on page 2287
bgp log-neighbor-changes on page 2288
bgp router-id <ip address> on page 2289
distance bgp <external> <internal> <local> on page 2290
hold-timer <value> on page 2291
maximum-paths <value> on page 2292
neighbor <ip address> on page 2293
network <ip address> mask <subnet mask> on page 2294
redistribute connected on page 2295
redistribute ospf on page 2296
redistribute rip on page 2297
redistribute static on page 2298

bgp
Use the bgp command to instruct AOS on how to handle multi-exit discriminators (MEDs) for all routes
from the same autonomous system (AS). Use the no form of this command to disable this feature.
bgp always-compare-med
bgp compare-med
bgp deterministic-med
bgp ignore-med
Syntax Description
always-compare-med Configures AOS to always compare MEDs for all paths for a route,
regardless of the AS through which the paths pass.
compare-med Configures AOS to compare MEDs for all received routes.
deterministic-med Configures AOS to compare the MEDs for all routes received from different
neighbors within the same AS.
ignore-med Configures AOS to disregard MEDs for all received routes.
Default Values
By default, AOS compares the MED attributes for routes from the same AS.
Command History
Usage Examples
The following example enables this option:
(config-bgp)#bgp compare-med

bgp default local-preference <value>

Use the bgp default local-preference command to change the local preference for all Border Gateway
Protocol (BGP) routes. The local preference is an attribute (LOCAL_PREF) that indicates a degree of
preference for a route relative to other routes in the local autonomous system (AS). BGP4 neighbors can
send the local preference value as an attribute of a route in an UPDATE message. Local preference only
applies to routes within the local AS. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the local preference value. Valid range is 0 to 4294967295.
Default Values
By default, the local preference is set to 100.
Command History
Usage Examples
The following example changes the default local preference to 200:
(config-bgp)#bgp default local-preference 200

bgp fast-external-failover
Use the bgp fast-external-failover command to enable the fast-external-failover feature. Use the no form
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
When enabled, if the link interface over which the router is communicating with a Border Gateway Protocol
(BGP) peer goes down, the BGP session with that peer is immediately cleared. When failover is disabled
and the link goes down, the session is maintained until the BGP hold timer expires.
Usage Examples
The following example enables this option:
(config-bgp)#bgp fast-external-failover

bgp log-neighbor-changes
Use the bgp log-neighbor-changes command to control the logging of neighbor state changes. Use the no
Syntax Description
No subcommands.
Default Values
By default, neighbor changes are not logged.
Command History
Functional Notes
This command controls logging of Border Gateway Protocol (BGP) neighbor state changes (up/down) and
resets. This information is useful for troubleshooting and determining network stability.
Usage Examples
The following example enables logging of BGP neighbor state changes:
(config-bgp)#bgp log-neighbor-changes

bgp router-id <ip address>

Use the bgp router-id command to specify the IP address that the router should use as its Border Gateway
Protocol (BGP) router ID. Use the no form of this command to return to the default setting.
Syntax Description
<ip address> Designates the IP address this router should use as its BGP router ID. IP
10.10.10.1).
Default Values
By default, no router ID is configured. The default action is detailed in Functional Notes below.
Command History
Functional Notes
This command allows an IP address to be specified for use as the BGP router ID. If no IP address is
configured at BGP startup, it uses the highest IP address configured on a loopback interface. If no
loopback interfaces are configured, it uses the highest IP address configured on any interface that is
active. If the specified router ID is changed, existing sessions with BGP neighbors are reset.
Usage Examples
The following example configures IP address 10.0.0.1 as the BGP router ID:
(config-bgp)#bgp router-id 10.0.0.1

distance bgp <external> <internal> <local>

Use the distance bgp command to set the administrative distance for Border Gateway Protocol (BGP)
routes. Use the no form of this command to return to the default setting.
Syntax Description
<external> Sets the administrative distance for BGP routes learned via External Border
Gateway Protocol (eBGP) sessions. A value of 255 means the route is not
installed. Range is 1 to 254.
<internal> Sets the administrative distance for BGP routes learned via Internal Border
Gateway Protocol (iBGP) sessions. A value of 255 means the route is not
<local> Sets the administrative distance for BGP routes learned via the network
command and redistribution. A value of 255 means the route is not
Default Values
By default, external is set to 20, internal to 200, and local to 200. Normally, these default settings should
not be changed.
Command History
Functional Notes
This command sets the administrative distance for BGP routes. The administrative distance is a local
variable that allows a router to choose the best route when there are multiple paths to the same network.
Routes with smaller administrative distances are favored.
Usage Examples
The following example gives external BGP routes an administrative distance of 30, internal BGP routes an
administrative distance of 200, and local routes an administrative distance of 240:
(config-bgp)#distance bgp 30 200 240

hold-timer <value>
Use the hold-timer command to set the default hold time for all neighbors in the Border Gateway Protocol
(BGP) process.
Syntax Description
<value> Specifies a time interval (in seconds) within which a keepalive must be
received from a peer before it is declared dead peer. Range is 0 to
65535 seconds.
Default Values
By default, the hold time is 180 seconds.
Command History
Functional Notes
Using the hold-timer command in BGP configuration mode sets the default hold time for all neighbors in
that BGP process. Using the hold-timer command in BGP neighbor configuration mode sets the hold time
for only that neighbor. The peers will negotiate and use the lowest configured setting. The keepalive
interval will be set to one-third of the negotiated hold time.
Usage Examples
The following example sets a hold time of 120 seconds for a specific neighbor, with an understood
keepalive interval of 40 seconds:
(config-bgp)#hold-timer 120

maximum-paths <value>
Use the maximum-paths command to specify the number of parallel routes (shared paths) External
Border Gateway Protocol (eBGP) neighbors can inject into the route table. When IP load sharing is
enabled, traffic is balanced to a specific destination across up to six equal paths. Use the no form of this
Syntax Description
<value> Specifies the number of parallel routes eBGP neighbors can inject into the
route table. Valid range is 1 to 6.
Default Values
By default, a single path can exist in the route table.
Command History
Usage Examples
The following example configures AOS to allow 4 parallel paths in the route table:
(config-bgp)#maximum-paths 4

neighbor <ip address>

Use the neighbor command to create a Border Gateway Protocol (BGP) neighbor, specify an IP address,
and activate the BGP neighbor configuration commands. Refer to BGP Neighbor Command Set on page
2299 for more information on neighbor-specific configuration parameters. Use the no form of this
command to remove the configured neighbor.s
Syntax Description
<ip address> Specifies the IP address for the neighbor. IP addresses should be
Default Values
By default, there are no configured BGP neighbors.
Command History
Usage Examples
The following example configures a BGP neighbor with an IP address of 10.10.10.1:
(config-bgp)#neighbor 10.10.10.1

network <ip address> mask <subnet mask>

Use the network mask command to add a network to the Border Gateway Protocol (BGP) network table.
Use the no form of this command to remove the configured network.
Syntax Description
<ip address> Specifies the network address for the neighbor that AOS will advertise over
BGP. IP addresses should be expressed in dotted decimal notation (for
example, 10.10.10.1).
example, /24).
Default Values
By default, there are no configured BGP networks.
Command History
Usage Examples
The following example adds the 10.10.10.1 network with a subnet mask of 255.255.255.0:
(config-bgp)#network 10.10.10.1 mask 255.255.255.0

redistribute connected
Use the redistribute connected command to pass routes from one network to another, regardless of the
routing protocol implemented on the routing domain. Using the connected keyword allows the
propagation of routes connected to other interfaces using the Border Gateway Protocol (BGP) routing
protocol. Use the no form of this command to disable the propagation of the specified route type.
redistribute connected metric <value>
redistribute connected route-map <name>
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed
connected routes in BGP.
route-map <name> Optional. Specifies the route map filter to use for advertising redistributed
connected routes in BGP.
Default Values
Command History
Functional Notes
BGP does not blindly broadcast out of all interfaces. Instead, the network statement tells which networks to
include in BGP updates. The redistribute connected command simply covers all connected networks.
Usage Examples
The following example passes the connected routes found in the route table to other networks running the
BGP routing protocol:
(config-bgp)#redistribute connected

redistribute ospf
Use the redistribute ospf command to advertise routes from one protocol to another, regardless of the
routing protocol implemented on the routing domain. Using the ospf keyword allows the propagation of
open shortest path first (OSPF) routes into Border Gateway Protocol (BGP). Use the no form of this
command to disable the propagation of the specified route type. Variations of this command include:
redistribute ospf
redistribute ospf metric <value>
redistribute ospf route-map <name>
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed OSPF
routes in BGP.
OSPF routes in BGP.
Default Values
Command History
Functional Notes
Redistributing OSPF routes imports those routes into BGP without specifying those subnets with a network
statement. The OSPF routes imported this way are not covered by a network command.
If redistribute ospf is enabled and no metric value is specified, the value defaults to 0.
Usage Examples
The following example imports OSPF routes into BGP:
(config-bgp)#redistribute ospf

redistribute rip
Use the redistribute rip command to advertise routes from one protocol to another, regardless of the
routing protocol implemented on the routing domain. Using the rip keyword allows the propagation of
Routing Information Protocol (RIP) routes into Border Gateway Protocol (BGP). Use the no form of this
redistribute rip
redistribute rip metric <value>
redistribute rip route-map <name>
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed RIP
routes in BGP.
RIP routes in BGP.
Default Values
Command History
Functional Notes
Redistributing RIP routes imports those routes into BGP. The RIP routes imported this way are not covered
by a network command.
If redistribute rip is enabled and no metric value is specified, the value defaults to 0.
Usage Examples
The following example imports RIP routes into BGP:
(config-bgp)#redistribute rip

redistribute static
Use the redistribute static command to pass routes from one network to another, regardless of the routing
protocol implemented on the routing domain. Using the static keyword allows the propagation of static
routes into the Border Gateway Protocol (BGP) routing protocol. Use the no form of this command to
disable the propagation of the specified route type. Variations of this command include:
redistribute static
redistribute static metric <value>
redistribute static route-map <name>
The gateway network for the static route must participate in BGP by using the network
command for the gateway network.
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed static
routes in BGP.
static routes in BGP.
Default Values
Command History
Functional Notes
Redistributing static routes allows other network devices to learn about routes without requiring manual
input to each device on the network.
Usage Examples
The following example passes the static routes found in the route table to other networks running the BGP
routing protocol:
(config-bgp)#redistribute static

Command Reference Guide BGP Neighbor Command Set
BGP NEIGHBOR COMMAND SET
To activate the Border Gateway Protocol (BGP) Neighbor Configuration mode, enter the router
bgp-neighbor command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-bgp)#router bgp-neighbor 192.22.73.101
do on page 51
end on page 52
exit on page 53
shutdown on page 61
advertisement-interval <value> on page 2300

as-path-list <name> on page 2301
distribute-list <name> on page 2302
ebgp-multihop <value> on page 2303
hold-timer <value> on page 2304
local-as <value> on page 2305
next-hop-self on page 2307
no default-originate on page 2308
prefix-list <name> on page 2310
remote-as <value> on page 2311
route-map <name> on page 2312
send-community standard on page 2313
soft-reconfiguration inbound on page 2314
update-source <interface> on page 2315

advertisement-interval <value>
Use the advertisement-interval command to configure AOS to specify how long the Border Gateway
Protocol (BGP) process waits before sending updates to the neighbor. Use the no form of this command to
Syntax Description
<value> Specifies the advertisement interval in seconds. Range is 0 to 600 seconds.
Default Values
By default, the advertisement interval is 30 seconds for external neighbors and 5 seconds for internal
neighbors.
Command History
Functional Notes
This command sets the minimum interval between sending updates to the specified neighbor.
Usage Examples
The following example configures the BGP process to wait at least 100 seconds before sending updates to
the neighbor:
(config-bgp-neighbor)#advertisement-interval 100

as-path-list <name>
Use the as-path-list command to assign a predefined autonomous system (AS) path list to a Border
Gateway Protocol (BGP) neighbor. This list is then used to filter inbound and/or outbound BGP route
updates. Use the no form of this command to discontinue use of the list. Variations of this command
include:
as-path-list <name> in
as-path-list <name> out
Syntax Description
<name> Assigns an AS path list to this BGP neighbor.
in Specifies the filtering of all inbound BGP route updates.
out Specifies the filtering of all outbound BGP route updates.
Default Values
By default, no AS path lists are specified for filtering.
Command History
Functional Notes
Before they can be assigned to a neighbor, AS path lists must first be defined using the ip as-path-list
command.
Usage Examples
The following example uses the no15 AS path list to filter all inbound BGP route updates:
(config-bgp-neighbor)#as-path-list no15 in

distribute-list <name>
Use the distribute-list command to add route filtering functionality by assigning inbound and outbound
access control lists (ACLs) on either a per-interface or global basis. Only one inbound/outbound pair of
ACLs can be configured for a particular interface. Use the no form of this command to disable the filtering.
distribute-list <name> in
distribute-list <name> out
Syntax Description
<name> Specifies an ACL name. This is a standard IP ACL against which the
contents of the incoming/outgoing routing updates are matched.
in Applies route filtering to inbound data.
out Applies route filtering to outbound data.
Default Values
By default, distribute-list filtering is disabled.
Command History
Usage Examples
The following example will filter out all network advertisements received via Ethernet interface 0/1 with the
exception of the 10.10.10.0 network:
(config-rip)#distribute-list list_1 in eth 0/1
(config-rip)#exit
(config)#ip access-list standard list_1
(config-std-nacl)#permit 10.10.10.0 0.0.0.255

ebgp-multihop <value>
Use the ebgp-multihop command to configure the maximum hop count of Border Gateway Protocol
(BGP) messages to a neighbor. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the maximum hop count of BGP messages to a neighbor.
Range is 1 to 254 hops.
Default Values
By default, External Border Gateway Protocol (eBGP) multihop is set to 1.
Command History
Functional Notes
This command allows an eBGP neighbor to be on a network that is not directly connected. Normally, eBGP
peers are directly connected. In certain applications, a non-BGP device, such as a firewall or router, may
reside between eBGP peers. In this case, the eBGP multihop command is required to allow updates to
have a time to live (TTL) greater than 1 and to allow received BGP updates to be added to the BGP table
when the next-hop address is not directly connected.
Usage Examples
The following example allows a BGP message to travel 10 hops to a neighbor:
(config-bgp-neighbor)#ebgp-multihop 10

hold-timer <value>
Use the hold-timer command to set the default hold time for all neighbors in the Border Gateway Protocol
(BGP) process. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies a time interval (in seconds) within which a keepalive must be
received from a peer before it is declared dead peer. Range is 0 to
65535 seconds.
Default Values
By default, the hold time is 180 seconds.
Command History
Functional Notes
Using the hold-timer command in BGP configuration mode sets the default hold time for all neighbors in
that BGP process. Using the hold-timer command in BGP neighbor configuration mode sets the hold time
for only that neighbor. The peers will negotiate and use the lowest configured setting. The keepalive
interval will be set to one-third of the negotiated hold time.
Usage Examples
The following example sets a hold time of 120 seconds for a specific neighbor, with an understood
keepalive interval of 40 seconds:
(config-bgp-neighbor)#hold-timer 120

local-as <value>
Use the local-as command to specify an autonomous system (AS) number for the unit to use when
communicating with this Border Gateway Protocol (BGP) neighbor. Use the no form of this command to
Syntax Description
<value> Specifies the AS number to use when communicating with this neighbor.
Must be different than the AS number for this router and the peer router.
Only valid for External Border Gateway Protocol (eBGP) connections.
Default Values
By default, no local AS number is defined. The router’s BGP AS number is used.
Command History
Functional Notes
This command substitutes a different AS number to be used for communicating with this BGP neighbor
(other than the one the router is actually a member of). This can be used to satisfy network designs
requiring a customer to appear as one AS number when communicating with one Internet service provider
(ISP) and another when communicating with another ISP.
Usage Examples
The following example configures this BGP neighbor’s AS number to be 300:
(config-bgp-neighbor)#local-as 300
Technology Review
This router appears (to the peer router) to be in the AS specified with the local-as command. Therefore, all
routes learned from the peer have this number prepended to the AS path. In network advertisements from
routers using the local-as command, the router’s true AS number (the number specified using the router
bgp as-number command) is prepended to the AS path attribute, and the local AS (the number specified
in the neighbor local-as command) is prepended to the AS path attribute. This makes it appear that the
path to the network is first through the local AS, and then through the true AS. To further illustrate, consider
the following example network.

In this network:
• Router A is in AS 100.
• Router B is in AS 300.
• Router A is an eBGP peer with Router B.
• Router A’s connection to Router B specifies a local-as of 200.
• Router B is configured to connect to Router A in AS 200.
Therefore:
• To Router B, all aspects of Router A appear as AS 200.

• Networks advertised from Router A to Router B will have the AS path 200 100 prepended to the AS path
attribute.
• Router A will add AS 200 to the AS path of networks learned from Router B.

next-hop-self
Use the next-hop-self command to force the next-hop attribute to be changed to this unit’s address when
advertising networks that would not have the next hop changed under normal rules. Normal next-hop rules
are described in the Functional Notes section below. Use the no form of this command to cause normal
next-hop rules to apply.
Syntax Description
No subcommands.
Default Values
By default, this command is disabled and normal next-hop rules apply.
Command History
Functional Notes
In External Border Gateway Protocol (eBGP), routes are normally advertised with a next hop set to the IP
address that the receiving peer has configured in its neighbor statement for this router. In the eBGP case
where the receiving router is in the same subnet as the current next hop, the current next hop is not
changed.
For broadcast multiaccess networks (Ethernet), this provides more efficient routing. For nonbroadcast
multiaccess (NBMA) networks, such as Frame Relay with a partial mesh using point-to-multipoint circuits,
this rule can cause significant problems. Since the partial mesh is on the same subnet, Border Gateway
Protocol (BGP) applies the rule of not changing the next-hop address, rendering invalid routes in certain
topologies. This is one case where this command is necessary to solve a problem.
Usage Examples
The following example enables next-hop-self:
(config-bgp-neighbor)#next-hop-self

no default-originate
Use the no default-originate command to prevent the unit from sending the default route to a Border
Gateway Protocol (BGP) neighbor. This command must be issued on a per-neighbor basis.
Syntax Description
No subcommands.
Default Values
By default, the default route is not sent to the BGP neighbor.
Command History
Usage Examples
The following example prevents the unit from sending the default route to a BGP neighbor:
(config-bgp-neighbor)#no default-originate

password <password>
Use the password command to enable message digest 5 (MD5) password authentication on Transmission
Control Protocol (TCP). Use the no form of this command to disable authentication.
Syntax Description
<password> Specifies the password string to be used for authentication. The password
is case sensitive and must not exceed 80 characters.
Default Values
By default, authentication is disabled.
Command History
Functional Notes
Authentication must be configured on both peers using the same password. Every Border Gateway
Protocol (BGP) TCP segment sent is authenticated. Configuring authentication causes an existing session
to be torn down and re-established using the currently specified authentication.
Usage Examples
The following example enables authentication for this BGP neighbor and sets a password of user1:
(config-bgp-neighbor)#password user1

prefix-list <name>
Use the prefix-list command to assign a predefined prefix list to a Border Gateway Protocol (BGP)
neighbor. The list is then used to filter BGP route updates received and/or sent from/by the specified peer.
Use the no form of this command to discontinue use of the prefix list. Variations of this command include:
prefix-list <name> in
prefix-list <name> out
Syntax Description
<name> Assigns the specified prefix list to this BGP neighbor.
in Specifies that all inbound BGP route updates received from the specified
peer be filtered.
out Specifies that all outbound BGP route updates being sent to the specified
peer be filtered.
Default Values
By default, no prefix lists are specified for filtering.
Command History
Functional Notes
Before they can be assigned to a BGP neighbor, prefix lists must first be defined using the ip prefix-list
command. Refer to ip prefix-list <name> description “<text>” on page 908 for more information.
Usage Examples
The following example uses the MyList prefix list to filter all BGP updates received from the specified peer:
(config-bgp-neighbor)#prefix-list MyList in

remote-as <value>
Use the remote-as command to specify the Border Gateway Protocol (BGP) autonomous system (AS) to
which the neighbor belongs, adding an entry to the BGP neighbor table. Use the no form of this command
Syntax Description
<value> Specifies the AS number. This number must be different from the AS
number of the local router (which is defined using the router bgp
command). Range is 1 to 65535. Refer to router bgp on page 1071 for more
information.
Default Values
By default, no BGP neighbors are defined.
Command History
Usage Examples
The following example configures a remote AS number of 200 for this neighbor:
(config-bgp-neighbor)#remote-as 200

route-map <name>
Use the route-map command to assign a route map to this Border Gateway Protocol (BGP) neighbor. The
route map is then used to filter or modify inbound and/or outbound BGP route updates. Use the no form of
route-map <name> in
route-map <name> out
Syntax Description
<name> Assigns the specified route map to this BGP neighbor.
in Specifies the filtering/modification of all inbound BGP route updates.
out Specifies the filtering/modification of all outbound BGP route updates.
Default Values
By default, no route map is assigned.
Command History
Functional Notes
Before a route map can be assigned to a BGP neighbor, it must first be defined using the route-map
command. Refer to route-map on page 1070 for more information.
Usage Examples
The following example assigns a route map to this neighbor for outbound filtering:
(config-bgp-neighbor)#route-map MapName out

send-community standard
Use the send-community standard command to insert a standard Border Gateway Protocol (BGP)
community attribute to all outgoing route updates for this neighbor. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example inserts a standard BGP community attribute to all outgoing route updates for the
specified neighbor:
(config-bgp-neighbor)#send-community standard

soft-reconfiguration inbound
Use the soft-reconfiguration inbound command to enable this unit to store Border Gateway Protocol
(BGP) updates for the specified neighbor. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
BGP updates are stored prior to filtering, thus allowing the clear ip bgp soft command to be used in the
absence of route refresh (RFC 2918) capability. This command affects all neighbors. Refer to clear ip bgp
Usage Examples
The following example enables the unit to store BGP updates for the specified neighbor:
(config-bgp-neighbor)#soft-reconfiguration inbound

update-source <interface>
Use the update-source command to specify which virtual interface’s IP address will be used as the source
IP address for the Border Gateway Protocol (BGP) Transmission Control Protocol (TCP) connection
(when connecting to this peer). Use the no form of this command to return to the default setting.
Syntax Description
<interface> Specifies the virtual interface to be used as the source IP address. Specify
| interface id | interface id.subinterface id | ap | ap/radio | ap/radio.vap]>. For
update-source ? for a complete list of valid interfaces.
Default Values
By default, the outbound interface's IP address is used for BGP updates.
Command History
and high level data link control (HDLC) interfaces.
Functional Notes
This is most often configured as a loopback interface that is reachable by the peer router. The peer will
specify this address in its neighbor commands for this router.
Usage Examples
The following example configures the loopback 1 interface as the source IP:
(config-bgp-neighbor)#update-source loopback 1

Command Reference Guide Community List Command Set
COMMUNITY LIST COMMAND SET
To activate the Community List Configuration mode, enter the ip community-list command at the Global
>enable
#configure terminal
(config)#ip community-list listname
(config-comm-list)#
do on page 51
deny on page 2317

permit on page 2318

deny
Use the deny command to add an entry to the community list that denies Border Gateway Protocol (BGP)
routes containing the specified community number in the community attribute. Use the no form of this
command to remove the statement from the community list. Variations of this command include:
deny <value>
deny internet
deny local-as
deny no-advertise
deny no-export
Syntax Description
<value> Denies routes that contain this value in their community attribute. This is a
in the command.
internet Denies routes that contain the reserved community number for the Internet
community.
local-as Denies routes that contain the reserved community number for
no-advertise Denies routes that contain the reserved community number for
to any BGP peer.
no-export Denies routes that contain the reserved community number for
Default Values
Command History
Usage Examples
The following example creates a community list named MyList to deny BGP routes that have the Internet
community number in their community attribute:
(config)#ip community-list MyList

(config-comm-list)#deny no-export

permit
Use the permit command to add an entry to the community list that allows only Border Gateway Protocol
(BGP) routes containing the specified community number in the community attribute. Use the no form of
this command to remove the statement from the community list. Variations of this command include:
permit <value>
permit internet
permit local-as
permit no-advertise
permit no-export
Syntax Description
<value> Permits routes that contain this value in their community attribute. This is a
in the command.
internet Permits routes that contain the reserved community number for the Internet
community.
local-as Permits routes that contain the reserved community number for
no-advertise Permits routes that contain the reserved community number for
to any BGP peer.
no-export Permits routes that contain the reserved community number for
Default Values
Command History
Usage Examples
The following example permits BGP routes that match the AS path attributes:
(config)#ip as-path-list listname

(config-comm-list)#permit 30:22

Command Reference Guide Network Monitor Probe Command Set
NETWORK MONITOR PROBE COMMAND SET
This section explains the commands available for Network Monitoring Probes. Probes are software agents
that send test traffic across a network path. Tracks are standalone objects that can help determine the status
of a route based on the success or failure of a probe. The probes can be configured to trigger at particular
intervals. There are five types of probes supported by ADTRAN Operating System (AOS): Internet
Control Message Protocol (ICMP) echo, Transmission Control Protocol (TCP) connect, Hypertext
Transfer Protocol (HTTP) request, Two-Way Active Measurement Protocol (TWAMP), and ICMP
timestamp. Commands common to all the probe types are identified in the following section, as well as
isolated commands that only apply to the specific probe types.
Additional configuration commands are available for associating tracks with each probe. These are
explained in the Network Monitor Track Command Set on page 2356.
To activate the Network Monitor Probe Configuration mode, enter the probe command at the Global
Configuration mode prompt followed by the probe name. Specify the probe type of icmp-echo,
tcp-connect, http-request, icmp-timestamp, and twamp. For example:
>enable
#configure terminal
do on page 51
exit on page 53
The following commands are applicable to ICMP echo probe types and can be executed after this
command:
(config)#probe <probe name> icmp-echo
data <pattern> on page 2326

destination on page 2327
period <value> on page 2333
shutdown on page 2336
size <payload length> on page 2337
source-address <ip address> on page 2338
timeout <value> on page 2342
tolerance on page 2343

The following commands are applicable to TCP connect probe types and can be executed after this
command:
(config)#probe <probe name> tcp-connect

source-port <port> on page 2339
The following commands are applicable to HTTP request probe types and can be executed after this
command:
(config)#probe <probe name> http-request
absolute-path <name> on page 2322

expect regex <expression> on page 2329
expect status <minimum> <maximum> on page 2330
raw-string on page 2334
type on page 2345
The following commands are applicable to ICMP timestamp probe types and can be executed after this
command:
(config)#probe <probe name> icmp-timestamp
data on page 2325

dscp <value> on page 2328
history-depth <value> on page 2331
num-packets <value> on page 2332
send-schedule periodic <value> on page 2335


threshold on page 2340
The following commands are applicable to TWAMP probe types and can be executed after this command:
(config)#probe <probe name> twamp
auth-mode open on page 2323

control on page 2324
data on page 2325
dscp <value> on page 2328
history-depth <value> on page 2331
num-packets <value> on page 2332
send-schedule periodic <value> on page 2335
threshold on page 2340

absolute-path <name>
Use the absolute-path command to specify the server’s root path. Use the no form of this command to
Syntax Description
<name> Specifies a path name.
Default Values
By default, the path name is the forward slash symbol ( / ).
Command History
Functional Notes
This command can only be executed while in the probe <name> http-request command set.
Usage Examples
The following example sets the absolute path to /home/index.html:
(config)#probe probe1 http-request

(config-probe-probe1)#absolute-path/home/index.html

auth-mode open
Use the auth-mode open command to specify the authentication mode the probe must use for
communication. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, the authentication mode is open.
Command History
Functional Notes
This command can only be executed while in the probe <name> twamp command set.
Usage Examples
The following example sets the authentication mode to open:
(config)#probe probe1 twamp

(config-probe-probe1)#auth-mode open

control
Use the control command to specify source and destination ports. Use the no form of this command to
control dest-port owamp-control

control dest-port twamp-control
control dest-port <port>
control source-port <port>
Syntax Description
dest-port Specifies the type of destination control port.
owamp-control Specifies the destination One-Way Active Measurement Protocol (OWAMP)
control port (861).
twamp-control Specifies the destination Two-Way Active Measurement Protocol (TWAMP)
default control port (862).
<port> Specifies a destination TWAMP control port other than the default port 862.
The valid range is 1 to 65535.
source-port <port> Specifies the TWAMP source control port. The valid range is 0 to 65535.
Default Values
By default, the source port is 0, which means that the source port will be dynamically selected by the
probe. The default destination port is the TWAMP control port, port 862.
Command History
Release 17.6 Command was expanded to include the twamp-control parameter and
default destination port was set to port 862.
Functional Notes
This command can only be executed while in the probe <name> twamp command set.
Usage Examples
The following example specifies a destination control port for the probe1 probe:

(config-probe-probe1)#control dest-port owamp-control

data
Use the data command to specify the data for padding a measurement packet. Payload data specifies the
data used to pad a measurement packet. Payload data can consist of all zeros pattern, a random pattern, or a
user-defined pattern. If the payload size is greater than the length of the pattern, the pattern will be
repeated. Use the no form of this command to return to the default setting. Variations of this command
include:
data pattern ascii <string>

data pattern hex <string>
data random
data zero
Syntax Description
pattern ascii <string> Specifies an ASCII data pattern.
pattern hex <string> Specifies a hexadecimal data pattern.
random Specifies using a pattern of random numbers.
zero Specifies using a pattern of zeros.
Default Values
By default, the data pattern is set to zero.
Command History
Release 17.2 Command was introduced to function with Two-Way Active Measurement
Protocol (TWAMP) and Internet Control Message Protocol (ICMP)
timestamp probes only.
Functional Notes
This command can only be executed while in the probe <name> twamp and
probe <name> icmp-timestamp command set.
Usage Examples
The following example specifies a data pattern as random:

(config-probe-probe2)#data random

data <pattern>
Use the data command to specify a hexadecimal pattern to repeat in the Internet Control Message Protocol
(ICMP) packet data section. Use the no form of this command to return to the default setting.
Syntax Description
<pattern> Specifies a hexadecimal data pattern.
Default Values
By default, the data pattern is a standard ping packet pattern of data values starting with 0x00,
incrementing by one for the length of the packet. Refer to ping on page 37 for more information on ping
packet data patterns.
Command History
Usage Examples
The following example specifies a data pattern of 0FF0 for probe1:

(config-probe-probe1)#data 0FF0

destination
Use the destination command to specify the destination host name and port for the probe object. Use the
no form of this command to remove the setting. Variations of this command include:
destination <hostname>
destination <hostname> port <number>
destination <ip address>
destination <ip address> port <number>
The probe is not operational until a destination is defined.
Syntax Description
<hostname> Specifies the IP host by name.
port <number> Optional. Specifies port number. This feature is not used with icmp-echo
probes. The valid range is 1 to 65535.
Default Values
By default, there is no setting for this command.
Command History
Usage Examples
The following example specifies www.adtran.com as the host and port 21 File Transfer Protocol (FTP) as
the destination for probe1:

(config-probe-probe1)#destination www.adtran.com port 21

dscp <value>
Use the dscp command to specify the differentiated services code point (DSCP) value placed in the test
packets. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the DSCP value. The range is 0 to 63.
Default Values
By default, the DSCP value is 0.
Command History
Release 17.2 Command was added to the Two-Way Active Measurement Protocol
(TWAMP) and Internet Control Message Protocol (ICMP) timestamp
probes.
Usage Examples
The following example specifies DSCP value to be placed in the probe:
(config)#probe probe2 icmp-timestamp

(config-probe-probe2)#dscp 15

expect regex <expression>

Use the expect regex command to configure the probe to expect a regular expression inside the contents of
the Hypertext Transfer Protocol (HTTP) response message. If the regular expression does not match
anything, the probe fails. Use the no form of this command to return to the default setting.
Syntax Description
<expression> Specifies the expression to display.
Default Values
By default, no regular expression is defined.
Command History
Functional Notes
Usage Examples
The following example only allows the probe1 test to pass if the word success is found in the HTTP server
response message:

(config-probe-probe1)#expect regex success

expect status <minimum> <maximum>

Use the expect status command to configure the probe to expect a specific status code in response to an
Hypertext Transfer Protocol (HTTP) request message. If a different status code is returned, the probe fails.
Use the no form of this command to return to the default setting. Variations of this command include:
expect status <minimum>

expect status <minimum> <maximum>
Syntax Description
<minimum> Specifies a minimum number value for the status code. Valid range is
0 to 999.
<maximum> Optional. Specifies a maximum number to create a range of status codes.
Default Values
By default, there is no setting for this command.
Command History
Functional Notes
Specifying only a minimum value indicates only one value can match the status code. Entering a maximum
value indicates a range of possible matches.
Usage Examples
The following example configures probe1 to expect a status code of 200 (the status of a successful HTTP
request):

(config-probe-probe1)#expect status 200

history-depth <value>
Use the history-depth command to specify the number of probe operation results allowed to be stored in
the unit’s memory. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the number of probe operation results to keep in the history
memory. The range is 1 to 120.
Default Values
By default, the history-depth value is set to 1.
Command History
Functional Notes
This command can only be executed while in the probe <name> icmp-timestamp or
probe <name> twamp command set.
Usage Examples
The following example specifies the number of probe results that can be stored in the unit:
(config)#probe probe2 icmp-timestamp

(config-probe-probe2)#history-depth 30

num-packets <value>
Use the num-packets command to specify the number of packets to send and receive during a single probe
operation. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the number of packets. Valid range is 1 to 1000 packets.
Default Values
By default, the num-packets is set to 10.
Command History
Usage Examples
The following example specifies sending 10 packets during the probe test:

(config-probe-probe3)#num-packets 10

period <value>
Use the period command to specify the time between probe test attempts. Use the no form of this
Syntax Description
<value> Specifies the time (in seconds) between probe test attempts. Valid range is
1 to 65535 seconds.
Default Values
By default, the period between probe tests is 60 seconds.
Command History
Usage Examples
The following example specifies probe1 to initiate probe tests every 90 seconds:

(config-probe-probe1)#period 90

raw-string
Use the raw-string command to enter text to appear in the data portion of a Hypertext Transfer Protocol
(HTTP) request. Refer to ping on page 326 for more details on the output text. Use the no form of this
Syntax Description
No subcommands.
Default Values
There is no default value for this command.
Command History
Functional Notes
This command can only be executed while in the probe <name> http-request command set. The type
should be set to RAW. Refer to tolerance on page 2343 for more information.
The following system variables can be used in the text:
$SYSTEM_NAME = The host name of the system.

$SYSTEM_SERIAL_NUMBER = The serial number of the system.
$SYSTEM_DESCRIPTION = The product name and part number of the system.
$SYSTEM_SOFTWARE_VERSION = The firmware version of the system.
Usage Examples
The following example configures a RAW HTTP request that attempts to access update.php on the Web
server. This command could be useful if the server administrator creates a PHP script that logs network
connectivity information. Additional information (the router name and its uptime) placed after update.php
is sent to the HTTP server.

(config-probe-probe1)#raw-string
GET/update.php?hostname=$SYSTEM_NAME&uptime=$SYSTEM_UPTIME HTTP/1.0
\r\n
\r\n
exit

send-schedule periodic <value>

Use the send-schedule periodic command to specify the amount of time (in milliseconds) between
sending individual test packets during the probe. Use the no form of this command to return to the default
setting.
Syntax Description
<value> Specifies the time interval between the individual packets. The valid range
is 5 to 5000 milliseconds.
Default Values
By default, the time interval is 20 milliseconds.
Command History
Usage Examples
The following example specifies a 45 millisecond time interval between the packets during probe1 test:

(config-probe-probe1)#send-schedule periodic 45

shutdown
Use the shutdown command to disable a probe and cause it to cease generating traffic. While a probe is
shut down, it will return a fail value to a track. Use the no form of this command to enable a probe to
generate traffic.
Syntax Description
No subcommands.
Default Values
By default, probes are shut down when created.
Command History
Functional Notes
A probe must be created first using the probe command. Refer to probe on page 1056 for more
information. Issuing the shutdown command at the probe configuration prompt will disable a probe,
causing it to cease generating traffic.
Usage Examples
The following example disables probe1:

(config-probe-probe1)#shutdown

size <payload length>

Use the size command to specify the length of the probe's test packet payload. Use the no form of this
Syntax Description
<payload length> Specifies size of test packet's payload. Valid range is 0 to 1462 bytes.
Default Values
By default, the payload length is 0 bytes.
Command History
Release 17.2 Command was updated with a new default, range, and description.
Usage Examples
The following example sets the length of the Internet Control Message Protocol (ICMP) echo packet’s
padding field for probe1 to 25 bytes:

(config-probe-probe1)#size 25

source-address <ip address>

Use the source-address command to associate an IP address source for probe traffic. Use the no form of
this command to remove the source IP address.
Syntax Description
Default Values
By default, the IP address of the outbound interface is used.
Command History
Functional Notes
A valid local IP address must be entered for proper functionality.
Usage Examples
The following example configures the source IP address on probe1:

(config-probe-probe1)#source-address 10.10.10.1

source-port <port>
Use the source-port command to specify a port source to use for probe traffic. Use the no form of this
Syntax Description
<port> Specifies the port number. Valid range is 0 to 65535.
Default Values
By default, the port is set to 0 which means that the probe will dynamically select the port number.
Command History
Usage Examples
The following example configures the source port on probe1 as 5000:

(config-probe-probe1)#source-port 5000

threshold
Use the threshold command to specify the criteria for a probe to be declared as passing or failing for the
delay, ipdv-abs, and packet-loss values measured by the probe. Any combination of direction and type of
threshold can be simultaneously configured and performed during the probe. Use the no form of this
command to return to the default setting. Variations of this command include the following:
threshold delay [in | out | round-trip] [avg | max | min] <fail value> <pass value>
threshold ipdv-abs [in | out | round-trip] [avg | max | min] <fail value> <pass value>
threshold packet-loss round-trip [avg | max | min] <fail value> <pass value>
Syntax Description
delay Specifies the thresholds for changing the state of the probe between pass
and fail based on the measured delay. The fail and pass value range is
-2147483648 to 2147483647 milliseconds.
ipdv-abs Specifies the thresholds for changing the state of the probe between pass
and fail based on measured interpacket delay variation (IPDV). The fail and
pass value range is 0 to 4294967295 milliseconds.
in Specifies inbound delay or IPDV.
avg Specifies the inbound average delay or IPDV.
max Specifies the inbound maximum delay or IPDV.
min Specifies the inbound minimum delay or IPDV.
out Specifies outbound delay or IPDV.
avg Specifies the outbound average delay or IPDV.
max Specifies the outbound maximum delay or IPDV.
min Specifies the outbound minimum delay or IPDV.
round-trip Specifies round trip delay or IPDV.
packet-loss Specifies the thresholds for changing the state of the probe between pass
and fail based on measured packet loss. The fail and pass value range is
1 to 1000 packets.
round-trip Specifies round trip packet loss.
avg Specifies the average round trip packet loss.
max Specifies the maximum round trip packet loss.
min Specifies the minimum round trip packet loss.
<fail value> Specifies the probe’s failing value. Refer to the specific threshold type
above for the valid range.
<pass value> Specifies the probe’s passing value. Refer to the specific threshold type
above for the valid range.
Default Values
By default, the delay pass and fail value is 2147483647 milliseconds, the ipdv-abs pass and fail value is
4294967295 milliseconds, and the packet-loss pass and fail value is 1000. This disables each of these
thresholds by default.

Command History
Usage Examples
The following example configures the probe to fail if it loses 100 packets and change to pass if packet loss
is below 75:

(config-probe-probe1)#threshold packet-loss in max 100 75

timeout <value>
Use the timeout command to specify the amount of time to wait for a test result before determining a
failure. Use the no form of this command to remove the timeout setting.
Syntax Description
<value> Specifies the timeout value in milliseconds. This value must be less than the
probe period value (refer to dscp <value> on page 2328). Valid range is
Default Values
By default, the timeout is 2000 milliseconds, and 10000 milliseconds (10 seconds) for Transmission
Control Protocol (TCP) connect probes and 10000 milliseconds (10 seconds) for Hypertext Transfer
Protocol (HTTP) request probes.
Command History
Usage Examples
The following example configures AOS to wait 90 milliseconds before determining a failure on probe1:

(config-probe-probe1)#timeout 90

tolerance
Use the tolerance command to configure the tolerance limit for test failures before returning a fail status
from the probe. Limits can be specified for consecutive failures or by rate of failure. Tolerance levels can
also be different based upon whether the probe is transitioning to the pass or fail state. Use the no form of
this command to remove tolerance levels from probes. Variations of this command include:
tolerance consecutive fail <number>

tolerance consecutive pass <number>
tolerance consecutive fail <number> pass <number>
tolerance rate fail <number> of <set size>
tolerance rate pass <number> of <set size>
tolerance rate fail <number> pass <number> of <set size>
The probe is not operational until tolerance is defined.
Syntax Description
consecutive Specifies that the probe state transitions occur only after a consecutive
number of test results conflict with the current state.
rate Specifies that the probe state transitions occur after a certain ratio of test
results conflict with the current state.
fail <number> Specifies the number of failures that must occur before transitioning the
probe to the FAIL state. Valid ranges are 1 to 255 consecutive failures and
1 to 254 failures per set.
pass <number> Specifies the number of passes before transitioning the probe to the PASS
state. Valid ranges are 1 to 255 consecutive passes and 1 to 254 passes
per set.
of <set size> Specifies test set size for rate configuration. Valid range is 1 to 255.
Default Values
By default, there are no configured tolerance levels. Therefore, a probe that does not have a defined
tolerance will never fail.
When probes are set in consecutive mode, any state not explicitly configured has its tolerance value set
to 1.
In rate mode, any state not explicitly configured has its tolerance value set to 1+s-t, where ‘s’ is the set size
and ‘t’ is the value of the other state.

Command History
Release 15.1 Command revised to include pass and fail values.
Release 17.2 Command was added to the Two-Way Active Measurement Protocol
(TWAMP) and Internet Control Message Protocol (ICMP) timestamp
probes.
Functional Notes
This command has been modified from its original form. All tolerance configurations before Revision 15.1
are deprecated, but will be supported for existing units that are upgraded.
Usage Examples
The following example configures probe1 to allow 10 consecutive failures before changing the probe
status to FAIL, and requires 5 consecutive passes to change its status to PASS when in the FAIL state:

(config-probe-probe1)#tolerance consecutive fail 10 pass 5
In the following example, the probe is configured for rate tolerance. To move to the FAIL state, 5 of the last
10 tests must fail. Once in this state, 8 of the last 10 tests must pass in order to transition the probe back to
PASS:

(config-probe-probe1)#tolerance rate fail 5 pass 8 of 10

type
Use the type command to specify a Hypertext Transfer Protocol (HTTP) request type. Use the no form of
type get
type head
type raw
Syntax Description
get Specifies the probe to use HTTP get request.
head Specifies the probe to use HTTP head request.
raw Specifies the probe to use HTTP raw request.
Default Values
By default, the probe’s HTTP request is set to get.
Command History
Functional Notes
Usage Examples
The following example configures probe1 to use HTTP request raw:

(config-probe-probe1)#type raw

Command Reference Guide Network Monitor Probe Responder Command Set
NETWORK MONITOR PROBE RESPONDER COMMAND SET
This section explains the commands available for Network Monitoring Probe Responders. A probe
responder is the general term used for a variety of server applications that respond to the network monitor
probe types. The Two-Way Active Measurement Protocol (TWAMP) probe responder encompasses the
responder side of the TWAMP-Control protocol by responding to TWAMP-Control messages and acting as
a remote endpoint for test packets. The Internet Control Message Protocol (ICMP) timestamp probe
responder responds to ICMP timestamp request packets so that it can act as a remote endpoint for ICMP
timestamp probes. Commands common to all the probe responder types are identified in the following
section, as well as isolated commands that only apply to the specific probe responder types.
To activate the Network Monitor Probe Responder Configuration mode, enter the probe responder
command at the Global Configuration mode prompt followed by the probe type. Specify the probe
responder type of icmp-timestamp, twamp, and udp-echo. For example:
>enable
#configure terminal
(config)#probe responder twamp
(config-responder-twamp)#
do on page 51
cross-connect on page 47 (applicable to the ICMP timestamp and UDP echo responders only)
exit on page 53
The following commands are applicable to ICMP timestamp probe responder types and can be executed
after this command:
(config)#probe responder icmp-timestamp


The following commands are applicable to TWAMP probe responder types and can be executed after this
command:

control source-port on page 2349
control timeout <value> on page 2350
max-sessions <value> on page 2351
port <value> on page 2352
source-interface <interface> on page 2354
test timeout <value> on page 2355
The following commands are applicable to User Datagram Protocol (UDP) echo probe responder types and
can be executed after this command:

port <value> on page 2352
source-interface <interface> on page 2354

Use the access-class in command to specify an access control list (ACL) to filter access to the responder.
Use the no form of this command to remove the ACL from the responder.
Syntax Description
<name> Specifies a name of the ACL.
Default Values
By default, no ACL is configured.
Command History
Usage Examples
The following example sets an ACL for the Two-Way Active Measurement Protocol (TWAMP) responder:

(config-responder-twamp)#access-class Anet in

control source-port
Use the control source-port command to specify the Two-Way Active Measurement Protocol (TWAMP)
source control port. Use the no form of this command to return to the default setting. Variations of this
command include:
control source-port owamp-control

control source-port twamp-control
control source-port <port>
Syntax Description
owamp-control Specifies One-Way Active Measurement Protocol (OWAMP) control port
(861) as the source port.
twamp-control Specifies the default TWAMP control port (862) as the source port.
<port> Specifies a source TWAMP control port other than the default port 862. The
valid range is 1 to 65535.
Default Values
By default, the source port is the TWAMP control port, port 862.
Command History
Release 17.6 Command was expanded to include the twamp-control parameter and the
default source port was set to port 862.
Usage Examples
The following example specifies the OWAMP control port as the source control port for the TWAMP
responder:

(config-responder-twamp)#control source-port owamp-control

control timeout <value>

Use the control timeout command to set the Two-Way Active Measurement Protocol (TWAMP) control
session timeout value. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the timeout interval in seconds. Range is 1 to 65535.
Default Values
By default, the control timeout value is set to 900.
Command History
Usage Examples
In the following example, the TWAMP control session is set to timeout after 7200 seconds:

(config-responder-twamp)#control timeout 7200

max-sessions <value>
Use the max-sessions command to specify the number of simultaneous Two-Way Active Measurement
Protocol (TWAMP) control sessions the responder can handle. Use the no form of this command to return
to the default setting.
Syntax Description
<value> Specifies the maximum number of simultaneous TWAMP-control sessions.
Default Values
By default, the maximum sessions is 10.
Command History
Usage Examples
The following example specifies the max-sessions value of 5:

(config-responder-twamp)#max-sessions 5

port <value>
Use the port command to specify the User Datagram Protocol (UDP) port to listen for and respond to UDP
echo packets. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the port number. Valid range is 1 to 65535.
Default Values
By default, the UDP port value is 6.
Command History
Usage Examples
The following example specifies port 5055 as the UDP port for the UDP echo responder:

(config-responder-udp)#port 5055

shutdown
Use the shutdown command to disable a responder and cause it to cease operation. While a responder is
shut down, it will not respond to probe packets. Use the no form of this command to enable a responder to
respond to probe traffic.
Syntax Description
No subcommands.
Default Values
By default, probe responders are shut down when created.
Command History
Usage Examples
The following example enables responder twamp:

(config-responder-twamp)#no shutdown

source-interface <interface>
Use the source-interface command to specify an interface with the primary IP address used as the source
address for responder traffic that originated from the unit. Use the no form of this command to return to the
default setting.
Syntax Description
<interface> Specify an interface in the format <interface type [slot/port |
dot11ap 1/1.1.
Default Values
By default, the source interface is not configured.
Command History
Usage Examples
The following example configures the source interface as vlan1:

(config-responder-twamp)#source-interface vlan1

test timeout <value>

Use the test timeout command to set the timeout value associated with the Two-Way Active Management
Protocol (TWAMP) probe responder test session. Use the no form of this command to return to the default
value.
Syntax Description
<value> Specifies the timeout interval in seconds. Range is 1 to 65535.
Default Values
By default, the test session timeout is set to 900 seconds.
Command History
Usage Examples
The following example sets the TWAMP probe responder’s timeout interval to 7200 seconds:

(config-responder-twamp)#test timeout 7200

Command Reference Guide Network Monitor Track Command Set
NETWORK MONITOR TRACK COMMAND SET
This section explains the commands available for Network Monitoring Tracks. Tracks are objects created
to monitor network probes for a change in their state. The tracks can be configured to perform a specific
action based upon the probe state detected. Association between a track and a probe occurs through
referencing the probe in the track’s configuration. Once the track is registered with the probe, whenever a
change occurs with the probe’s state, an event is sent to the track.
Additional configuration commands are available for creating probes. These are explained in the Network
Monitor Probe Command Set on page 2319.
To activate the Network Monitor Track Configuration mode, enter the track command at the Global
Configuration mode prompt followed by the name of the track. For example:
>enable
#configure terminal
(config)#track track1
(config-track-track1)#
this guide. For more information, refer to the sections listed below:
exit on page 53
All other commands for this command set are described in this section in alphabetical order:
dampening-interval on page 2357

log-changes on page 2358
test if on page 2360
test list on page 2364
test list weighted on page 2367
time-schedule <name> on page 2370

dampening-interval
Use the dampening-interval command to specify an amount of time to wait before allowing a new probe
status change to trigger a new action. Use the no form of this command to return to the default setting.
dampening-interval <value>
dampening-interval fail<value>
dampening-interval pass <value>
Syntax Description
<value> Specifies the time interval value in seconds. Valid range is 1 to 4294967295
seconds. If neither the fail or pass subcommand is specified, the value will
be used for both conditions.
fail <value> Specifies the delay in seconds following pass-to-fail transitions before a
new action can be triggered.
pass <value> Specifies the delay in seconds following fail-to-pass transitions before a
new action can be triggered.
Default Values
By default, the interval is set to 1 seconds.
Command History
Release 14.1 Command was expanded to include the fail and pass criteria.
Usage Examples
The following example sets the dampening interval to 90 seconds for a fail-to-pass transition:
(config-track-track1)#dampening-interval pass 90

log-changes
Use the log-changes command to enable logging of status changes. When enabled, probe state transitions
are displayed (real time) on the terminal (or Telnet) screen. Unlike track debug commands, the
log-changes command appears in the running configuration and can be saved to persist through a unit
restart. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the logging of status changes:
(config-track-track1)#log-changes

shutdown
Use the shutdown command to disable a track. While a track is shut down, it is forced to fail. Use the no
form of this command to enable a track.
Syntax Description
No subcommands.
Default Values
By default, tracks are active when created.
Command History
Functional Notes
A track must be created first using the track command in the Global Configuration mode. Refer to the
command track <name> on page 1124 for more information. Issuing the shutdown command at the track
configuration prompt will force the track to fail.
Usage Examples
The following example enables track1:
(config-track-track1)#no shutdown

test if
Use the test if command to specify a single object (schedule, probe, or interface) to be tested. Use the no
form of this command to remove the track test. Variations of this command include:
test if interface <interface> ip-routing

test if interface <interface> line-protocol
test if probe <name>
test if schedule <name>
test if not interface <interface> ip-routing
test if not interface <interface> line-protocol
test if not probe <name>
test if not schedule <name>
Syntax Description
interface <interface> Specifies an interface as the object to be tested. Specify an interface in the
interface id.subinterface id]>. For example, for an Ethernet subinterface,
use eth 0/1.1; for a PPP interface, use ppp 1; for an ATM subinterface, use
atm 1.1; and for a virtual local area network interface, use vlan 1. Type test
if interface ? for a complete list of valid interfaces.
ip-routing Specifies the interface’s ability to perform IP routing will be tested.
line-protocol Specifies the line-protocol state of an interface will be tested.
not Optional. Negates the test results when specifying a single object
(schedule, probe, or interface) to be tested.
probe <name> Specifies the name of the probe.
schedule <name> Specifies the name of the schedule.
Network monitoring probes and their associated names are created using the command
probe on page 1056. Schedules and their associated names are created using the command
schedule <name> on page 1077. More information refer to the command interface on
page 54.
Default Values
By default, a track is not associated with any probes or interfaces.
Functional Notes
The test if command specifies a conditional test where the track state (pass or fail) is dependent upon the
state of the object (probe, schedule, or interface) being tested. For example, the track will PASS if the
schedule or probe is in an ACTIVE or PASS state. Conversely, the track will FAIL if the schedule or probe
is in an INACTIVE or FAIL state.

The test if not command specifies a conditional test where the track state (pass or fail) is dependent upon
the state of the object (probe, schedule, or interface) being tested. The not keyword indicates that the track
state will negate the result of the object test. For example, the track will FAIL if the schedule or probe is in
an ACTIVE or PASS state. Conversely, the track will PASS if the schedule or probe is in an INACTIVE or
FAIL state.
An interface is IP routing if its line-protocol state is up and if it has a valid, nonzero IP address. This means
that interfaces using Dynamic Host Configuration Protocol (DHCP) or negotiated Point-to-Point Protocol
(PPP) will not pass until their primary IP address is dynamically configured.
Command History
Usage Examples
The following example demonstrates the use of the test if probe command to specify a single object to
test:
(config)#track PINGTEST
(config-track-PINGTEST)#test if probe PINGREMOTE
The following example demonstrates the logic of the test if not command used with schedule tracking:
(config)#track DELAY
(config-track-DELAY)#test if not schedule DELAY-AFTER-BOOT
The inverse logic of this command means that track DELAY will pass only if the schedule
DELAY-AFTER-BOOT is inactive.
The explanation that follows uses a real-world example to provide insight into the example above:
A customer has a primary Ethernet wide area network (WAN) interface, as well as a dial-on-demand
interface enabled on an AOS unit. The demand interface is intended as a backup for the primary Ethernet
interface. During router initialization and bootup, the Ethernet interface negotiates an IP address and
default route from a DHCP server. Due to this negotiation process, the active state of the Ethernet interface
lags behind that of the demand interface. As a result, the Ethernet interface appears down and the
demand interface dials out to back up the connection. The customer would like to prevent the demand
interface from dialing out before the Ethernet connection has had a chance to obtain its DHCP settings and
become active. It is determined that 180 seconds is a sufficient amount of time to allow for the Ethernet
interface to become active.
The following bullets describe the setup via command line interface (CLI) to accomplish the customer's
goals:
• A schedule called DELAY-AFTER-BOOT is created and specified to become active 180 seconds after
the AOS unit has booted up.

• A track named DELAY is created.
• Track DELAY is associated with the schedule DELAY-AFTER-BOOT via the following command:
(config-track-DELAY)#test if not schedule DELAY-AFTER-BOOT
The inverse logic of this command means that track DELAY will pass only if the schedule
DELAY-AFTER-BOOT is inactive. Therefore, this track will pass only during the first 180 seconds
following bootup of the AOS unit.
• A default route to null interface 0 is created and associated with track DELAY. This default route will
only be inserted into the routing table when track DELAY is in the pass state. The administrative
distance for the default route to null interface 0 is 10 and is set to be lower than the administrative
distance for the demand interface default route (200).
Output from the show run command summarizes the CLI configuration:
#show run
(some output omitted)…
.
schedule DELAY-AFTER-BOOT
!! Schedule is Inactive for first 180 seconds, then Active thereafter
relative start-after 180
!
track DELAY
log-changes
test if not schedule DELAY-AFTER-BOOT
no shutdown
!
!!! Below is a default route to null 0 with an admin distance of
!!! 10 that is tracked by DELAY and a default route to demand 1
!!! with admin distance of 200
ip route 0.0.0.0 0.0.0.0 null 0 10 track DELAY
ip route 0.0.0.0 0.0.0.0 demand 1 200
Since track DELAY is in a pass state during the first 180 seconds after the AOS unit has booted up, the
default route to null interface 0 will be in effect and all traffic using the default route in the route table will be
routed to null interface 0. The demand interface will not be activated during the first 180 seconds because
the default route to null interface 0 has a lower administrative distance than the demand interface default
route.
As soon as a default route has been assigned to the primary Ethernet WAN interface, the route will appear
in the routing table with an administrative distance of 1 (which is lower than the administrative distance of
10 for the null interface). Due to the lower administrative distance, all traffic using the default route in the
route table will switch to the default route associated with the primary Ethernet interface.

180 seconds after bootup, the schedule DELAY-AFTER-BOOT becomes active. Subsequently, track
DELAY fails. The default route to null interface 0 is removed from the routing table and will not be placed in
the route table again as long as the AOS unit is up. The two default routes that remain are the current
default route to the primary WAN Ethernet interface (administrative distance is 1) and the backup default
route to the demand interface (administrative distance is 200).
The following example uses the test if interface command to specify testing the IP routing capability of an
Ethernet interface:
(config-track-track1)#test if interface ethernet 0/1 ip-routing
To view the results of the test, use the do show track track1 command:
(config-track-track1)#do show track track1

Current State: FAIL (Admin: UP)
Testing:
interface eth 0/1 ip-routing (FAIL)
Track State Changes: 1
Tracking:

test list
Use the test list command to enter the Boolean Track Test List command set, which is used to specify
multiple objects (schedule, probe, or interface) to be tested. Use the no form of this command to remove
the test list. Variations of this command include:
test list and

test list or
The following additional subcommands are available once you have entered the Boolean Track Test List
Configuration mode:
if interface <interface> ip-routing

if interface <interface> line-protocol
if probe <name>
if schedule <name>
if not interface <interface> ip-routing
if not interface <interface> line-protocol
if not probe <name>
if not schedule <name>
When using any command under the Boolean AND/OR track test list, it is important to
remember how the logic will affect every object in the track test list.
Syntax Description
and Specifies the relationship between all objects placed in this list. The
logical AND relationship means that all objects in this list must be in
the PASS state for the track test list to pass, or at least one object in
a FAIL state for the track test list to fail.
or Specifies the relationship between all objects placed in this list. The
logical OR relationship means that only one of the objects in this list
must be in the PASS state for the track test list to pass, and all
objects in a FAIL state for the track test list to fail.
if [probe | schedule | interface] Specifies a single conditional test to be added to the test track list.
if not [probe | schedule | interface] Specifies a single conditional test to be added to the test track list.
The not keyword indicates that the individual track state will negate
the result of the object test.
<interface> Specifies the interface to be added to the test track list. Specify an
interface in the format <interface type [slot/port |
slot/port.subinterface id | interface id | interface id.subinterface id]>.
For example, for an Ethernet subinterface, use eth 0/1.1; for a PPP
interface, use ppp 1; for an ATM subinterface, use atm 1.1; and for
a virtual local area network interface, use vlan 1. Type if interface
? for a complete list of valid interfaces.


<name> Specifies the name of the probe or schedule.
page 54.
Default Values
By default, a track list does not exist.
Command History
Functional Notes
There is no limit to how many probes, schedules, or interfaces can be tested within a single test list.
However, only one type (AND, OR, or weighted) of test list can exist on a track at any given time.
Usage Examples
The following example demonstrates use of the test list and command to create a Boolean track test list
where ALL tests must PASS in order for the track to PASS. The test list for track LB contains two probe
tests, LB and LB2.
(config)#track LB
(config-track-track LB)#test list and
(config-track-track LB test)#if probe LB
(config-track-track LB test)#if probe LB2
(config-track-track LB test)#exit
(config-track-track LB)#no shutdown
The show track LB command is executed to see whether track LB is in a PASS state:
#show track LB
Current State: PASS (Admin: UP)
Testing:
probe LB (PASS)
AND probe LB2 (PASS)

Tracking:
Currently, track LB is in a PASS state. Due to the AND Boolean logic for this test list, track LB is in a PASS
state because the test probe statements within the test list (probe LB and LB2) are also BOTH in a PASS
state.
Now, probe LB has been forced to fail for demonstration purposes in this example. Output from the show
track LB command shows track LB in a FAIL state.
(config-loop 1)#do show track LB

Testing:
probe LB (FAIL)
AND probe LB2 (PASS)
Tracking:
Probe LB is now in a FAIL state. As a result, track LB is also in a FAIL state.
If the test list in this example had specified the OR Boolean logic (using the test list or
command), then track LB would have passed even though one of the test probes was in the
FAIL state.

test list weighted

Use the test list weighted command to enter the Weighted Track Test List Configuration mode, which is
used to specify multiple objects (schedules, probes, or interfaces) to be tested. Objects listed in a weighted
track test are assigned a specific weight value. The total weight of all the objects in the list is compared to
a user-specified threshold to determine whether the track passes or fails. Use the no form of this command
to remove the test list.
The following additional subcommands are available once you have entered the Weighted Track Test List
Configuration mode:
if interface <interface> ip-routing weight <value>

if interface <interface> line-protocol weight <value>
if probe <name> weight <value>
if schedule <name> weight <value>
if not interface <interface> ip-routing weight <value>
if not interface <interface> line-protocol weight <value>
if not probe <name> weight <value>
if not schedule <name> weight <value>
threshold <number>
threshold pass <number> fail <number>
Syntax Description
if [probe | schedule | interface] Specifies a single conditional test to be added to the test track list.
if not [probe | schedule | interface] Specifies a single conditional test to be added to the test track list.
The not keyword indicates that the individual track state will
negate the result of the object test.
<interface> Specifies the interface to be added to the test track list. Specify an
interface in the format <interface type [slot/port |
id]>. For example, for an Ethernet subinterface, use eth 0/1.1; for
a PPP interface, use ppp 1; for an ATM subinterface, use atm 1.1;
and for a virtual local area network interface, use vlan 1. Type if
interface ? for a complete list of valid interfaces.
<name> Specifies the name of the probe or schedule.
weight <value> Specifies the weight value to use if this test is successful. Range is
1 to 65535.
threshold <number> Specifies a baseline weight for state transitions. Range is 1 to
4294967295.
pass <number> Optional. Specifies the number which, if reached or exceeded, will
change the state of the track test list to pass. Range is 1 to
4294967295.

fail <number> Optional. Specifies the number that will change the state of the
track test list to fail. Range is 1 to 4294967295.
page 54.
Default Values
By default, a track list does not exist.
Command History
Functional Notes
There is no limit to how many probes, schedules, or interfaces can be tested within a single test list.
However, only one type (AND, OR, or weighted) of test list can exist on a track at any given time.
Usage Examples
The following example demonstrates use of the test list weighted command. The list contains three probe
tests and each test has been assigned a different weight value (10, 20, and 30). When a probe test
passes, its weight is added to the sum of the weights from other successful tests contained within the
Weighted Track Test List. The pass threshold in this example is set to 35. The sum of all the weights must
meet or exceed the value of 35 before the Weighted Track Test List will transition to a PASS state. The fail
threshold in this example is set to 25. Therefore, if the sum of all the weights falls below the value of 25, the
Weighted Track Test List will transition to a FAIL state.
(config)#track LB-test
(config-track-LB-test)#test list weighted
(config-track-LB-test-test)#if probe LB weight 10
(config-track-LB-test-test)#if probe LB2 weight 20
(config-track-LB-test-test)#if probe LB3 weight 30
(config-track-LB-test-test)#threshold pass 35 fail 25
(config-track-LB-test-test)#exit
(config-track-LB-test)#no shutdown

The show track LB-test command is executed to see whether track LB-test is in a PASS state:
#show track LB-test

Current State: PASS (Admin: UP)
Testing:
+10 if probe LB (PASS)
+20 if probe LB2 (PASS)
Total = 60 currently, < 25 changes state to FAIL
Tracking:
Currently, all probe test commands are in the PASS state. Therefore, the sum of the assigned weights
equals 60. The value of 60 exceeds the specified pass threshold of 35. As a result, the current state of the
track is PASS.
Probe LB and probe LB3 have been forced to fail for demonstration purposes in this example. Output from
the show track LB-test command shows track LB-test to be in a FAIL state.
(config-loop 1)#do show track LB-test

Testing:
+10 if probe LB (FAIL)
+30 if probe LB3 (FAIL)
Total = 20 currently, >= 35 changes state to PASS
Tracking:
Only probe LB2 is in the PASS state. Therefore, the sum of the assigned weights equals 20. The value of
20 falls below the FAIL threshold of 25. As a result, the current state of the track is now FAIL.

time-schedule <name>
Use the time-schedule command to specify the time period a track has an effect. While the specified
schedule is active, the track follows the state of its associated probe. Use the no form of this command to
remove the time schedule from this track. Refer to the command schedule <name> on page 1077 for more
information on creating and modifying a schedule. Variations of this command include:
time-schedule <name> pass

time-schedule <name> fail
Syntax Description
<name> Specifies the name of the time schedule to apply.
pass Specifies that the track status is PASS when the schedule is inactive.
fail Specifies that the track status is FAIL when the schedule is inactive.
Default Values
By default, no time schedule is assigned to the track. Therefore, the track always follows the state of its
associated probe.
Command History
Release 15.1 Command was expanded to allow specification of the track state when the
schedule is inactive.
Usage Examples
The following example specifies that schedule1 will be used to determine when track1 follows the state of
its probe:
(config-track-track1)#time-schedule schedule1 pass

Command Reference Guide Router (OSPF) Command Set
ROUTER (OSPF) COMMAND SET
To activate the Router (Open Shortest Path First (OSPF)) Configuration mode, enter the router ospf
>enable
#configure terminal
(config-ospf)#
do on page 51
end on page 52
exit on page 53
area <area id> default-cost <value> on page 2372

area <area id> range <ip address> <subnet mask> on page 2373
area <area id> stub on page 2374
auto-cost reference-bandwidth <value> on page 2375
default-information-originate on page 2376
default-metric <value> on page 2377
distance <number> on page 2378
maximum-paths <value> on page 2380
network <ip address> <wildcard mask> area <area id> on page 2381
redistribute bgp on page 2382
redistribute rip on page 2384
summary-address <ip address> <subnet mask> on page 2388
timers lsa-group-pacing <value> on page 2389
timers spf <delay> <hold> on page 2390

area <area id> default-cost <value>

Use the area default-cost command to assign a cost of the default summary route sent into a stub area or
not-so-stubby-area (NSSA). Use the no form of this command to delete the assigned cost.
Syntax Description
<area id> Specifies the identifier for this area. Specifies as an integer (range is 0 to
4294967295) or an IP address. IP addresses should be expressed in dotted
<value> Specifies the default summary route cost. Range is 0 to 166777214.
Default Values
By default, the summary route cost is set to 0. There is no default for the area ID.
Command History
Usage Examples
The following example defines a default cost of 85 to a specific area:
(config-ospf)#area 192.22.72.0 default-cost 85

area <area id> range <ip address> <subnet mask>

Use the area range command to configure area route summarizations and to determine whether an address
range is advertised to the networks. Use the no form of this command to disable this feature. Variations of
area <area id> range <ip address> <subnet mask> advertise

area <area id> range <ip address> <subnet mask> not-advertise
Syntax Description
<ip address> Specifies the IP address of the advertised summary route. IP addresses
example, /24).
advertise Specifies that the address range will be advertised to other networks.
not-advertise Specifies that the address range will not be advertised to other networks.
Default Values
By default, open shortest path first (OSPF) is not enabled.
Command History
Usage Examples
The following example defines an address range for a specific area that allows the unit to advertise this
range to other networks:
(config-ospf)#area 11.0.0.0 range 11.0.0.0 255.0.0.0 advertise

area <area id> stub

Use the area stub command to configure an area as a stub area. Use the no form of this command to
disable stub-designation for areas defined as stubs using this command. Variations of this command
include:
area <area id> stub

area <area id> stub no-summary
Syntax Description
no-summary Optional. Designates the area as a total stub area. No summary link
advertisements will be sent by the area border router (ABR) into the stub
area.
Default Values
By default, open shortest path first (OSPF) is not enabled.
Command History
Technology Review
It is important to coordinate configuration of all routers and access servers in the stub area. The area stub
command must be configured for each of those pieces of equipment. Use the area router configuration
command with the area default-cost command to specify the cost of a default internal router sent into a
stub area by an ABR. Refer to area <area id> default-cost <value> on page 2372 for related information.
Usage Examples
The following example configures area 2 as a stub area:
(config-ospf)#area 2 stub

auto-cost reference-bandwidth <value>

Use the auto-cost reference-bandwidth command to assign a different interface cost to an interface. It
may be necessary to assign a higher number to high-bandwidth links. This value is used in open shortest
path first (OSPF) metric calculations. Use the no form of this command to return to the default setting.
Syntax Description
<value> Sets the default reference bandwidth rate in Mbps. Range is 1 to
4294967 Mbps.
Default Values
By default, the rate is set to 100.
Command History
Usage Examples
The following example sets the auto cost reference bandwidth to 1000 Mbps:
(config-ospf)#auto-cost reference-bandwidth 1000

default-information-originate
Use the default-information-originate command to cause an autonomous system boundary router
(ASBR) to generate a default route. It must have its own default route before it generates one unless the
always keyword is used. Use the no form of this command to return to the default setting. Variations of
default-information-originate
default-information-originate always
default-information-originate always metric <value>
default-information-originate always metric <value> metric-type <type>
default-information-originate always metric-type <type>
default-information-originate metric <value>
default-information-originate metric <value> metric-type <type>
default-information-originate metric-type <type>
Syntax Description
always Optional. Specifies to always advertise default route.
metric <value> Optional. Configures the metric value. Range is 0 to 16777214.
metric-type <type> Optional. Configures the metric type. Select from type 1 or 2.
Default Values
By default, the metric value is set to 10 and the metric type is set to 2.
Command History
Usage Examples
The following example configures a router to always advertise default routes and assigns the default router
a metric value of 10000 and a metric type of 2:
(config-ospf)#default-information-originate always metric 10000 metric-type 2

default-metric <value>
Use the default-metric command to set a metric value for redistributed routes. Use the no form of this
Syntax Description
<value> Sets the default metric value. Range is 0 to 4294967295.
Default Values
By default, default-metric value is set at 20.
Command History
Functional Notes
The metric value defined using the redistribute command overrides the default-metric command’s metric
setting. Refer to redistribute ospf on page 2405 for related information.
Usage Examples
The following example shows a router using both Routing Information Protocol (RIP) and open shortest
path first (OSPF) routing protocols. The example advertises RIP-derived routes using the OSPF protocol
and assigns the RIP-derived routes an OSPF metric of 10.
(config-ospf)#default-metric 10
(config-ospf)#redistribute rip

distance <number>
Use the distance command to overwrite the open shortest path first (OSPF) route administrative distance.
This can be the same for all OSPF routes or different based on the route type. Use the no form of this
command to set the OSPF administrative distance to the default value. Variations of this command
include:
distance <number>
distance ospf intra-area <number>
distance ospf inter-area <number>
distance ospf external <number>
Syntax Description
<number> Specifies the administrative distance to use when adding OSPF routes into
the route table. Range is 0 to 255.
ospf intra-area Specifies using a unique administrative distance for route paths between a
source and destination in the same routing area.
ospf inter-area Specifies using a unique administrative distance for route paths between a
source and destination in different areas.
ospf external Specifies using a unique administrative distance for route paths between
different autonomous systems (ASs).
Default Values
By default, 110 is the administrative distance for OSPF routes.
Command History
Usage Examples
The following example configures external OSPF routes to use an administrative distance of 20 while other
OSPF routes continue to use the default value of 110:
(config-ospf)#distance ospf external 20
Technology Review
An AS is a set of routers under common administration control that usually use a common routing strategy.
Each AS is composed of routing areas, which are groups of adjoining networks and attached hosts.
Intra-area routing occurs when the source and destination hosts are in the same area; inter-area routing
occurs when the source and destination hosts are in different areas; and external routing occurs when
communication is between different ASs.

Administrative distance is a feature that routers employ in order to select the most reliable path when there
are two or more routes to the same destination from two different routing protocols. Administrative distance
defines the reliability of a routing protocol by assigning a value (the smaller the value, the more trustworthy
the protocol) that is then used by the router to organize routing protocols according to reliability.

maximum-paths <value>
Use the maximum-paths command to specify the number of parallel routes (shared paths) open shortest
path first (OSPF) can inject into the route table. When IP load sharing is enabled, traffic is balanced to a
specific destination across up to six equal paths. Use the no form of this command to return to the default
value.
Syntax Description
<value> Specifies the number of routes OSPF can insert into the route table. Valid
range is 1 to 6.
Default Values
By default, the maximum-paths value is 4.
Command History
Usage Examples
The following example sets the maximum number of multipath routes OSPF can insert in the route table
to 5.
(config-ospf)#maximum-paths 5

network <ip address> <wildcard mask> area <area id>

Use the network area command to enable routing on an IP stack and to define area IDs for the interfaces
on which open shortest path first (OSPF) will run. Use the no form of this command to disable OSPF
routing for interfaces defined using this command.
Syntax Description
<wildcard mask> Specifies the wildcard mask that corresponds to a range of IP addresses
(network). Wildcard masks are expressed in dotted decimal notation (for
example, 0.0.0.255).
Default Values
Command History
Functional Notes
In order for OSPF to operate on an interface, the primary address for the interface must be included in the
network area command. Assigning an interface to an OSPF area is done using the network area
command. There is no limit to the number of network area commands used on a router. If the address
ranges defined for different areas overlap, the first area in the network area command list is used and all
other overlapping portions are disregarded. Try to avoid overlapping to avoid complications.
Usage Examples
In the following example, the OSPF routing process is enabled and two OSPF areas are defined:
(config-ospf)#network 192.22.72.101 0.0.0.255 area 0
(config-ospf)#network 10.0.0.0 0.255.255.255 area 10.0.0.0

redistribute bgp
Use the redistribute bgp command to advertise routes from one protocol to another. Using the bgp
keyword allows the advertisement of Border Gateway Protocol (BGP) routes into the open shortest path
first (OSPF) routing protocol. This will advertise BGP routes on OSPF-enabled interfaces. It does not
enable OSPF on all interfaces. Use the no form of this command to disable the propagation of the specified
route type. Variations of this command include:
redistribute bgp
redistribute bgp metric <value>
redistribute bgp metric-type <type>
redistribute bgp route-map <name>
redistribute bgp subnets
Syntax Description
metric <value> Optional. Specifies an OSPF metric value to be assigned to routes learned
via BGP.
metric-type <type> Optional. Specifies a type 1 or type 2 external route as the external link
type. If not specified, the default is 2.
route-map <name> Optional. Specifies the route map access-list filter to use for advertising
redistributed BGP routes in OSPF.
subnets Optional. Specifies subnet redistribution when redistributing routes into
OSPF.
Default Values
Command History
Functional Notes
Redistributing BGP routes imports those routes into OSPF without the interfaces in question actually
participating in OSPF. The BGP routes imported this way are not covered by a network command and do
not send/receive OSPF traffic. This allows OSPF to learn and distribute routes to networks that do not
participate in OSPF.
Usage Examples
The following example imports BGP routes into OSPF:
(config-ospf)#redistribute bgp

Use the redistribute connected command to advertise routes from one protocol to another. Using the
connected keyword allows the advertisement of connected routes into the open shortest path first (OSPF)
routing protocol. This will advertise all connected routes on OSPF-enabled interfaces. It does not enable
OSPF on all interfaces. Use the no form of this command to disable the propagation of the specified route
type. Variations of this command include:
redistribute connected metric-type <type>
redistribute connected subnets
Syntax Description
metric <value> Optional. Specifies an OSPF metric value to be assigned to connected
routes (if no other value is specified).
static routes in OSPF.
OSPF.
Default Values
Command History
Release 10.1 Subcommands were added.
Release 14.1 Command was expanded to include the route map filtering.
Functional Notes
Redistributing connected routes imports those routes into OSPF without the interfaces in question actually
participating in OSPF. The connected routes imported this way are not covered by a network command
and do not send/receive OSPF traffic.
Usage Examples
The following example imports connected routes into OSPF:
(config-ospf)#redistribute connected

redistribute rip
Use the redistribute rip command to advertise routes from one protocol to another, regardless of the
routing protocol implemented on the routing domain. Using the rip keyword allows the propagation of
Routing Information Protocol (RIP) routes into open shortest path first (OSPF). It does not enable OSPF
on all interfaces. Use the no form of this command to disable the propagation of the specified route type.
redistribute rip
redistribute rip metric <value>
redistribute rip metric-type <type>
redistribute rip route-map <name>
redistribute rip subnets
Syntax Description
rip Specifies advertising RIP routes using OSPF.
metric <value> Optional. Specifies a metric value to be carried from one OSPF process to
the next (if no other value is specified).
OSPF.
Default Values
Command History
Functional Notes
Redistributing RIP routes imports routes learned via RIP into OSPF. RIP routes imported this way are not
covered by a network command.

Usage Examples
The following example imports RIP routes into OSPF:
(config-ospf)#redistribute rip

redistribute static
Use the redistribute static command to advertise routes from one protocol to another, regardless of the
routing protocol implemented on the routing domain. Using the static keyword allows the advertisement
of static routes into the open shortest path first (OSPF) routing protocol. This will advertise all static routes
on OSPF-enabled interfaces. It does not enable OSPF on all interfaces. Use the no form of this command
to disable the propagation of the specified route type. Variations of this command include:
redistribute static
redistribute static metric-type <type>
redistribute static subnets
Syntax Description
static Specifies advertising static routes using OSPF.
metric <value> Optional. Specifies a metric value to be carried from one OSPF process to
the next (if no other value is specified).
OSPF.
Default Values
Command History
Functional Notes
Redistributing static routes imports static routes into OSPF. Static routes imported this way are not covered
by a network command. This allows OSPF to advertise routes that are configured as static routes without
the identified network participating in OSPF.

Usage Examples
The following example imports static routes into OSPF:
(config-ospf)#redistribute static

summary-address <ip address> <subnet mask>

Use the summary-address command to control address summarization of routes that are redistributed into
open shortest path first (OSPF) from other sources (for example, Routing Information Protocol
(RIP)-to-OSPF, static-to-OSPF, etc.). Variations of this command include:
summary-address <ip address> <subnet mask>

summary-address <ip address> <subnet mask> not-advertise
Syntax Description
example, /24).
not-advertise Optional. Causes suppression of routes that match the specified IP address
and subnet mask.
Default Values
Command History
Usage Examples
The following example suppresses advertisement of the routes that match the specified IP address and
subnet mask:
(config-ospf)#summary-address 11.0.0.0 255.0.0.0 not-advertise

timers lsa-group-pacing <value>

Use the timers lsa-group-pacing command to change the link state advertisement (LSA) refresh interval.
Syntax Description
<value> Sets the LSA refresh interval in seconds. Range is 10 to 1800 seconds.
Default Values
By default, this value is set at 240 seconds.
Command History
Usage Examples
The following example sets the refresh interval for six minutes:
(config-ospf)#timers lsa-group-pacing 360

timers spf <delay> <hold>

Use the timers spf command to configure the shortest path first (SPF) calculation and hold intervals. Use
Syntax Description
<delay> Specifies the time in seconds between open shortest path first’s (OSPF’s)
receipt of topology changes and the beginning of SPF calculations.
<hold> Specifies the time in seconds between consecutive SPF calculations.
Default Values
By default, the SPF delay is 5 seconds and the hold interval is set to 10 seconds.
Command History
Usage Examples
The following example defines a delay of 10 seconds and a hold time of 30 seconds:
(config-ospf)#timers spf 10 30

Command Reference Guide Router (PIM Sparse) Command Set
ROUTER (PIM SPARSE) COMMAND SET
To activate the Router (Protocol-Independent Multicast (PIM) Sparse) Configuration mode, enter the
router pim-sparse command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
do on page 51
end on page 52
exit on page 53
join-prune-msg-interval <value> on page 2392

rp-address <ip address> on page 2393
spt-threshold on page 2394

join-prune-msg-interval <value>
Use the join-prune-msg-interval command to set a timing rate for protocol-independent multicast (PIM)
sparse join/prune messages. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the PIM sparse join/prune message interval. Valid range:
10 to 65534 seconds.
Default Values
By default, the message interval is set to 60 seconds.
Command History
Usage Examples
The following example sets the interval for 50 seconds:
(config-pim-sparse)#join-prune-msg-interval 50

rp-address <ip address>

Use the rp-address command to specify a static IP address for the rendezvous point (RP) router. The
access-group keyword is used to limit the multicast group addresses to which the RP applies. Use the no
form of this command to remove a static IP address for the RP router. Variations of this command include:
rp-address <ip address>

rp-address <ip address> access-group <name>
Syntax Description
<ip address> Specifies the IP address for the RP. IP addresses should be expressed in
access-group <name> Optional. Specifies the particular access group to which the RP applies.
Default Values
Command History
Functional Notes
The access-group keyword is used to limit the multicast group addresses to which the RP applies. If more
than one RP is configured for a given multicast group address, then a hash algorithm determines the
appropriate hierarchy (as shown below). The results of the hash algorithm can be seen with the show ip
pim-sparse rp-map command.
The hash algorithm is defined in RFC 2117 section 3.7 as follows:
For each RP address C(i) in the RP-Set, whose Group-prefix covers G, compute a value:
Value(G,M,C(i))=(1103515245 * ((1103515245 * (G&M)+12345) XOR C(i)) + 12345) mod 2^31
where M is a hash-mask included in Bootstrap messages.This hash-mask allows a small number of

consecutive groups (e.g., 4) to always hash to the same RP. For instance, hierarchically encoded data can
be sent on consecutive group addresses to get the same delay and fate-sharing characteristics.
The candidate with the highest resulting value is then chosen as the RP for that group, and its identity and
hash value are stored with the entry created.
Ties between C-RPs having the same hash value are broken in advantage of the highest address.
Usage Examples
The following example specifies an IP address of 172.22.5.100 for the RP:
(config-pim-sparse)#rp-address 172.22.5.100

spt-threshold
Use the spt-threshold command to change the protocol-independent multicast (PIM) sparse shortest path
tree (SPT) threshold, which specifies the number of packets the router sends using the rendezvous point
(RP) before switching to the SPT. Use the no form of this command to return to the default setting.
spt-threshold <value>
spt-threshold infinity
Syntax Description
<value> Optional. Specifies the number of packets the routing switch sends using
the RP before switching to the SPT. Valid range is 1 to
4294967295 packets.
infinity Optional. Causes all sources to use the shared RP tree.
Default Values
By default, the SPT threshold is set to 1 packet.
Command History
Usage Examples
The following example sets the SPT threshold at five packets:
(config-pim-sparse)#spt-threshold 5

Command Reference Guide Router (RIP) Command Set
ROUTER (RIP) COMMAND SET
To activate the Router (Routing Information Protocol (RIP)) Configuration mode, enter the router rip
>enable
#configure terminal
(config)#router rip
(config-rip)#
do on page 51
end on page 52
exit on page 53
auto-summary on page 2396

default-metric <value> on page 2397
distance <number> on page 2398
distribute-list <name> on page 2399
network <ip address> <subnet mask> on page 2401
passive-interface <interface> on page 2402
redistribute bgp on page 2403
redistribute ospf on page 2405
timeout-timer <value> on page 2407
update-timer <value> on page 2408
version on page 2409

auto-summary
Use the auto-summary command to have Routing Information Protocol (RIP) version 2 summarize
subnets to the classful boundaries. Use the no form of this command to disable this summarization.
Syntax Description
No subcommands.
Default Values
By default, auto-summary is disabled.
Command History
Functional Notes
Use this command if you are subdividing a classful network into many subnets and these subnets are to be
advertised over a slow link (64k or less) to a router that can only reach the classful network via the router
you are configuring.
Usage Examples
The following example configures the router to not automatically summarize network numbers:
(config)#router rip
(config-rip)#no auto-summary

default-metric <value>
Use the default-metric command to set the default metric value for the Routing Information Protocol
(RIP). Use the no form of this command to return to the default setting.
Syntax Description
<value> Sets the default metric value in Mbps. Range is 1 to 4294967295 Mbps.
Default Values
By default, this value is set at 0.
Command History
Functional Notes
The metric value defined using the redistribute command overrides the default-metric command’s metric
setting. Refer to redistribute ospf on page 2405 for related information.
Usage Examples
The following example shows a router using both RIP and open shortest path first (OSPF) routing
protocols. The example advertises OSPF-derived routes using RIP and assigns the OSPF-derived routes
a RIP metric of 10.
(config)#router rip
(config-rip)#default-metric 10
(config-rip)#redistribute ospf

distance <number>
Use the distance command to set the administrative distance for Routing Information Protocol (RIP)
routes that are added to the route table. Use the no form of this command to set the RIP administrative
distance to the default value.
Syntax Description
<number> Specifies the new administrative distance. Range is 0 to 255.
Default Values
By default, the administrative distance for RIP routes is set to 120.
Command History
Usage Examples
The following configuration sets the administrative distance to 109, which gives RIP routes a lower
administrative distance than open shortest path first (OSPF) routes:
(config)#router rip
(config-rip)#distance 109
Technical Review

distribute-list <name>
Use the distribute-list command to add route filtering functionality by assigning inbound and outbound
access control lists (ACLs) on either a per-interface or global basis. Only one inbound/outbound pair of
ACLs can be configured for a particular interface. Use the no form of this command to disable the filtering.
distribute-list <name> in
distribute-list <name> in <interface>
distribute-list <name> out
distribute-list <name> out <info source>
Syntax Description
<name> Specifies an ACL name. This is a standard IP ACL against which the
contents of the incoming/outgoing routing updates are matched.
in Applies route filtering to inbound data.
in <interface> Optional. Specifies the interface in which to apply the ACL. Specify an
distribute-list list1 in ? for a complete list of applicable interfaces.
out Applies route filtering to outbound data.
out <info source> Optional. Specifies the source of the routing information. The source can be
an interface or a routing process (connected, ospf, rip, or static). Type
distribute list <name> out ? for a list of available options.
Default Values
By default, distribute-list filtering is disabled.
Command History

Usage Examples
The following example filters out all network advertisements received via Ethernet interface 0/1 with the
exception of the 10.10.10.0 network:
(config)#router rip
(config-rip)#version 2
(config-rip)#network 192.168.1.0 255.255.255.0
(config-rip)#distribute-list list_1 in eth 0/1
(config-rip)#exit
(config)#ip access-list standard list_1

network <ip address> <subnet mask>

Use the network command to enable Routing Information Protocol (RIP) on the specified network. Use
the no form of this command to remove a network from the list.
Syntax Description
<ip address> Specifies the IP address of the network on which RIP will be enabled. IP
10.10.10.1).
Default Values
By default, RIP is not enabled.
Command History
Functional Notes
AOS will only allow processing (sending and receiving) RIP messages on interfaces with IP addresses that
are contained in the networks listed using this command. All RIP messages received on interfaces not
listed using this command will be discarded. To allow for receiving and participating in RIP, but not for
transmitting, use the passive-interface command (refer to passive-interface <interface> on page 2402).
Usage Examples
The following example enables RIP on the 102.22.72.252 /30, 192.45.2.0 /24, and 10.200.0.0 /16
networks:
(config)#router rip

passive-interface <interface>
Use the passive-interface command to disable the transmission of routing updates on the specified
interface. Use the no form of this command to enable the transmission of routing updates on an interface.
Syntax Description
dot11ap 1/1.1. Type passive-interface ? for a complete list of valid
interfaces.
Default Values
By default, Routing Information Protocol (RIP) is not enabled.
Command History
Functional Notes
All routing updates received on that interface will still be processed (and advertised to other interfaces), but
no updates will be transmitted to the network connected to the specified interface. Multiple
passive-interface commands may be used to create a customized list of interfaces.
Usage Examples
The following example disables routing updates on the Frame Relay link (labeled 1.17) and the
Point-to-Point Protocol (PPP) link (labeled 1):
(config)#router rip
(config-rip)#passive-interface frame-relay 1.17
(config-rip)#passive-interface ppp 1

redistribute bgp
Use the redistribute bgp command to advertise routes from one protocol to another, regardless of the
routing protocol implemented on the routing domain. Using the bgp keyword allows the propagation of
Border Gateway Protocol (BGP) routes into Routing Information Protocol (RIP). Use the no form of this
redistribute bgp
redistribute bgp metric <value>
redistribute bgp route-map <name>
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed BGP
routes in RIP.
BGP routes in RIP.
Default Values
Command History
Functional Notes
Redistributing BGP routes imports those routes into RIP without the interfaces in question actually
participating in RIP. The BGP routes imported this way are not covered by a network command and are
learned via BGP. This allows RIP to distribute routes for networks that are not participating in this RIP
network.
If redistribute bgp is enabled and no metric value is specified, the value defaults to 0. The metric value
defined using the redistribute bgp metric command overrides the default-metric command’s metric
setting. Refer to default-metric <value> on page 2397 for more information.
Usage Examples
The following example imports BGP routes into RIP:
(config)#router rip
(config-rip)#redistribute bgp

Use the redistribute connected command to pass routes from one network to another, regardless of the
routing protocol implemented on the routing domain. Using the connected keyword allows the
propagation of routes connected to other interfaces using the Routing Information Protocol (RIP). Use the
no form of this command to disable the propagation of the specified route type. Variations of this
command include:
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed routes
in RIP.
routes in RIP.
Default Values
Command History
Functional Notes
Redistributing connected routes imports those routes into RIP without the interfaces in question actually
participating in RIP. The connected routes imported this way are not covered by a network command and
do not send/receive RIP traffic.
Usage Examples
The following example passes the connected routes found in the route table to other networks running the
RIP routing protocol:
(config)#router rip
(config-rip)#redistribute connected

redistribute ospf
Use the redistribute ospf command to advertise routes from one protocol to another, regardless of the
routing protocol implemented on the routing domain. Using the ospf keyword allows the propagation of
open shortest path first (OSPF) routes into Routing Information Protocol (RIP). Use the no form of this
redistribute ospf
redistribute ospf metric <value>
redistribute ospf route-map <name>
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed OSPF
routes in RIP.
OSPF routes in RIP.
Default Values
Command History
Functional Notes
Redistributing OSPF routes imports those routes into RIP without the interfaces in question actually
participating in RIP. The OSPF routes imported this way are not covered by a network command and do
not send/receive RIP traffic. This allows RIP to distribute routes for networks that are not participating in
this RIP network.
If redistribute ospf is enabled and no metric value is specified, the value defaults to 0. The metric value
defined using the redistribute ospf metric command overrides the default-metric command’s metric
setting. Refer to default-metric <value> on page 2397 for more information.
Usage Examples
The following example imports OSPF routes into RIP:
(config)#router rip
(config-rip)#redistribute ospf

redistribute static
Use the redistribute static command to pass routes from one network to another, regardless of the routing
protocol implemented on the routing domain. Using the static keyword allows the propagation of static
routes to other interfaces using the Routing Information Protocol (RIP). Use the no form of this command
to disable the propagation of the specified route type. Variations of this command include:
redistribute static
The gateway network for the static route must participate in RIP by using the network
command for the gateway network.
Syntax Description
metric <value> Optional. Specifies the hop count to use for advertising redistributed static
routes in RIP.
static routes in RIP.
Default Values
Command History
Functional Notes
Redistributing static routes allows other network devices to learn about routes without requiring manual
input to each device on the network.
Usage Examples
The following example passes the static routes found in the route table to other networks running the RIP
routing protocol:
(config)#router rip
(config-rip)#redistribute static

timeout-timer <value>
Use the timeout-timer command to set the timeout timer value for a route when it is learned via Routing
Information Protocol (RIP). Each time a RIP update for that route is received, the timeout timer is reset to
this value. If no updates for that route are received in the specified number of seconds and the timeout
timer expires, the route is considered invalid, and it will be removed from the route table. Use the no form
Syntax Description
<value> Sets the timeout timer value. Valid range is 5 to 4294967295 seconds.
Default Values
Command History
Functional Notes
Note that the timeout timer value cannot be set to a value less than the update-timer value. It is
recommended that this timer be set to a value that is three times the value of the update-timer (refer to
update-timer <value> on page 2408).
Usage Examples
The following example configures the router to mark routes invalid if no RIP updates for those routes are
received within 120 seconds:
(config)#router rip
(config-rip)#timeout-timer 120

update-timer <value>
Use the update-timer command to set the value of the Routing Information Protocol (RIP) update interval
timer. The RIP update interval is the number of seconds that must elapse between RIP update packet
transmissions. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the number of seconds allowed to elapse between RIP update
packet transmissions. Valid range is 5 to 4294967295 seconds.
Default Values
Command History
Functional Notes
Note that the timeout-timer value cannot be set to a value less than the update-timer value. It is
recommended that the timeout-timer be set to a value that is three times the value of the update-timer.
(Refer to timeout-timer <value> on page 2407 for more information.)
Usage Examples
The following example sets the rate at which RIP update messages are transmitted from the router to
20 seconds.
(config)#router rip
(config-rip)#update-timer 20

version
Use the version command to specify (globally) the Routing Information Protocol (RIP) version used on all
IP interfaces. This global configuration is overridden using the configuration commands ip rip send
version and ip rip receive version. Use the no form of this command to return to the default value.
version 1
version 2
Syntax Description
1 Specifies RIP version 1 be used globally.
2 Specifies RIP version 2 be used globally.
Default Values
By default, RIP is not enabled.
Command History
Usage Examples
The following example specifies RIP version 2 as the global RIP version:
(config)#router rip
(config-rip)#version 2

SECURITY AND SERVICES

COMMAND SETS
• Access Control List Command Set on page 2411

• Access Control Policy Command Set on page 2428
• Desktop Auditing Local Policy Command Set on page 2975
• DHCP Pool Command Set on page 2453
• Ethernet OAM CFM Command Set on page 2473
• Hardware ACL and Access Map Command Set on page 2491
• Mail Agent Command Set on page 2508
• MGCP Command Set on page 2519
• Quality of Service Map Command Set on page 2545
• RADIUS Group Command Set on page 2570
• Route Map Command Set on page 2573
• TACACS+ Group Command Set on page 2602
• Top Traffic Command Set on page 2604

Command Reference Guide Access Control List Command Set
ACCESS CONTROL LIST COMMAND SET
An access control list (ACL) is an ordered list of entries used as packet selectors by an access control
policy (ACP) in the ADTRAN Operating System (AOS) command line interface (CLI). ACLs and ACPs
work together to regulate traffic through the routed network.
There are two types of ACLs within AOS: standard and extended. A standard ACL allows source IP
address packet patterns only. An extended ACL may specify patterns using most fields in the IP header
and the Transmission Control Protocol (TCP) or User Datagram Protocol (UDP) header. This
configuration command set details the configuration of both a standard and an extended ACL.
To create a standard ACL and activate the Standard ACL Configuration mode, enter the ip access-list
standard <name> command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#ip access-list standard MATCHALL
(config-std-nacl)#
To create an extended ACL and activate the Extended ACL Configuration Mode, enter the ip access-list
extended <name> command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#ip access-list extended MATCHALL
(config-ext-nacl)#
An ACL will remain inactive until it is assigned to an active ACP. For more information on
configuring and activating ACPs, refer to the Access Control Policy Command Set on page
2428.
Technology Review
ACPs and ACLs regulate traffic through the routed network. When designing your traffic flow configuration,
it is important to keep the following in mind:
• An ACL serves as a packet selector, defining exactly which packets should take the given action.
• An ACP defines the action to take on the packets selected by the ACL.
• An ACL is inactive until it is assigned to an active ACP.
• An ACP is inactive until it is assigned to an interface.

Access Control Policies (ACPs)
ACPs are used to allow, discard, or manipulate (using network address translation (NAT)) data for each
physical interface. Each ACP consists of an action (allow, discard, nat) and a selector (ACL). In a sense,
the ACPs answer the question, “What should I do?” while the ACLs answer the question, “On which
packets?”
Access Control Lists (ACLs)
ACLs are used as packet selectors by ACPs. They must be assigned to an ACP in order to be active.
ACLs are composed of an ordered list of entries. Each entry contains two parts: an action (permit or deny)
and a packet pattern. A permit action is used to allow packets (meeting the specified pattern) to enter the
router system. A deny action is used to disregard packets (that do not match the pattern) and proceed to
the next entry on the ACP. The ACL has an implicit deny at the end of the list.
Transmission Control Protocol (TCP) or User Datagram Protocol (UDP) header.
Creating and Assigning ACLs and ACPs
Creating ACPs and ACLs to regulate traffic through the routed network is a four-step process:
Step 1:
Step 2:
Step 3:
3. Using the <ip address> <wildcard> format to match all IP addresses in a range. Wildcard masks
work in reverse logic from subnet masks. When broken out into binary form, a 0 indicates

which bits of the IP address to consider, a 1 indicates which bits are disregarded. For example,
specifying 255 in any octet of the wildcard mask equates to a “don’t care” for that octet in the
IP address. Additionally, a 30-bit mask would be represented with the wildcard string 0.0.0.3, a
28-bit mask with 0.0.0.15, a 24-bit mask with 0.0.0.255, and so forth.
4. Using the keyword hostname to match based on a domain naming system (DNS) name. DNS
servers must be configured or host names must be locally defined for this function to work.
Step 4:

For more information about configuring ACLs, ACPs, and the AOS Firewall, refer to the
IP Firewall configuration guide (article number 1543) available at http://kb.adtran.com.
do on page 51
exit on page 53
The following are commands used to configure an extended ACL. Extended ACL configuration includes
specifying an ACL action, a protocol, a packet source, a source port, a packet destination, and a destination
port. These commands are described in this section in alphabetical order.
deny <protocol> <source> <source port> <destination> <destination port> on page 2414
permit <protocol> <source> <source port> <destination> <destination port> on page 2418
remark <remark> on page 2422
The following are commands for configuring a standard ACL. Standard ACL configuration includes
specifying an ACL action and a packet source. These commands are described in this section in
alphabetical order.
deny <source> on page 2423

permit <source> on page 2425
remark <remark> on page 2427

deny <protocol> <source> <source port> <destination> <destination port>

Use the deny command to configure the extended access control list (ACL) to deny specified packets entry
into the routing system. Use the no form of this command to remove the deny parameter from the ACL.

deny <protocol> <source> <source port> <destination> <destination port> log
deny <protocol> <source> <source port> <destination> <destination port> track <name>
Syntax Description
<protocol> Specifies the data protocol ip, icmp, tcp, udp, ahp, esp, gre, or a specific
protocol. Range is 0 to 255.
<source> Specifies the source used for packet matching. Sources can be expressed
in one of five ways:
2. Using host <ip address> to specify a single host address. IP addresses
should be expressed in dotted decimal notation (for example,
10.10.10.1).
3. Using the <ip address> <wildcard mask> format to match all IP
addresses in a range. The wildcard mask corresponds to a range of IP
addresses (network) or a specific host. Wildcard masks are expressed
4. Using the keyword hostname to match based on a domain naming
system (DNS) name. The unit must be configured with DNS servers for
this function to work.
5. Using vrf <name> associates a nondefault VPN routing and forwarding
(VRF) with the DNS host name specified in the source or destination.
The VRF is required if the router’s DNS server is on a nondefault VRF.
This parameter can only be used with the hostname source.
<source port> Optional. The source port is used only when <protocol> is tcp or udp. The
following keywords and port numbers/names are supported for the
<source port> field:
any Matches any destination port.
eq <port number/name> Matches only packets equal to specified port
number.
gt <port number/name> Matches only packets with a port number
greater than the specified port number.
lt <port number/name> Matches only packets with a port number less
than the specified port number.
neq <port number/name> Matches only packets that are not equal to the
specified port number.
range <port number/name> Matches only packets that contain a port
number in the specified range.

<port number> Specifies the port number used by

Transmission Control Protocol (TCP) or User
Datagram Protocol (UDP) to pass information
to upper layers using the following syntax:
<0-65535>. All ports below 1024 are
considered well-known ports, and are
controlled by the Internet Assigned Numbers
Authority (IANA). All ports above 1024 are
dynamically assigned ports that include
registered ports for vendor-specific
applications.
<port name> The following UDP port numbers can be
specified using the associated names:
biff (Port 512) ntp (Port 123)
bootpc (Port 68) pim-auto-rp (Port 496)
mobile-ip (Port 434) talk (Port 517)
netbios-dgm (Port 138)time (Port 37)
The following TCP port numbers can be
bgp (Port 179) lpd (Port 515)
chargen (Port 19) nntp (Port 119)
cmd (Port 514) pim-auto-rp (Port 496)
daytime (Port 13) pop2 (Port 109)
domain (Port 53) smtp (Port 25)
echo (Port 7) sunrpc (Port 111)
exec (Port 512) syslog (Port 514)
finger (Port 79) tacacs (Port 49)
ftp (Port 21) talk (Port 517)
gopher (Port 70) tftp (Port 69)
ident (Port 113) time (Port 37)

irc (Port 194) uucp (Port 540)

klogin (Port 543) whois (Port 43)
kshell (Port 544) www (Port 80)
login (Port 513)
<destination> Specifies the destination used for packet matching. Destinations can be
expressed in one of five ways:
10.10.10.1).
4. Using the keyword hostname to match based on a DNS name. The unit
must be configured with DNS servers for this function to work.
5. Using vrf <name> associates a nondefault VRF with the DNS host
name specified in the source or destination. The VRF is required if the
router’s DNS server is on a nondefault VRF. This parameter can only be
used with the hostname source.
<destination port> Optional. Specifies the destination port. Only valid when <protocol> is tcp
or udp. The same keywords and port numbers/names used for the
<source port> field are valid for the <destination port> field. Refer to
previously listed <source port> for more details.
log Optional. Enables logging of any packets that match the ACL entry.
track <name> Optional. Makes the ACL entry dependent upon a track.
Default Values
Command History
Release 16.1 Command was expanded to include the log, track, and vrf parameters.
Functional Notes

Usage Examples
The following example creates an ACL DenyIKE to deny all Internet key exchange (IKE) (UDP Port 500)
packets from the 190.72.22.0 /24 network:
(config)#ip access-list extended DenyIKE

(config-ext-nacl)#deny udp 190.72.22.0 0.0.0.255 eq 500 any eq 500
The following example creates an entry in the Untrusted ACL to deny ip packets from host name
www.adtran.com using the nondefault VRF RED to resolve the DNS host name with any destination:
(config)#ip access-list extended Untrusted

(config-ext-nacl)#deny ip hostname www.adtran.com vrf RED any

permit <protocol> <source> <source port> <destination> <destination port>

Use the permit command to configure the extended access control list (ACL) to permit specified packets
entry into the routing system. Use the no form of this command to remove the permit permission from the
ACL. Variations of this command include:

permit <protocol> <source> <source port> <destination> <destination port> log
permit <protocol> <source> <source port> <destination> <destination port> track <name>
Syntax Description
<protocol> Specifies the data protocol ip, icmp, tcp, udp, ahp, esp, gre, or a specific
protocol. Range is 0 to 255.
in one of five ways:
10.10.10.1).
4. Using the keyword hostname to match based on a domain naming
system (DNS) name. The unit must be configured with DNS servers for
this function to work.
5. Using vrf <name> associates a nondefault VPN routing and forwarding
(VRF) with the DNS host name specified in the source or destination.
The VRF is required if the router’s DNS server is on a nondefault VRF.
This parameter can only be used with the hostname source.
any Matches any destination port.
eq <port number/name> Matches only packets equal to specified port
number.
gt <port number/name> Matches only packets with a port number
greater than the specified port number.
lt <port number/name> Matches only packets with a port number less
than the specified port number.
neq <port number/name> Matches only packets that are not equal to the
specified port number.
range <port number/name>Matches only packets that contain a port
number in the specified range.

<port number> Specifies the port number used by

Transmission Control Protocol (TCP) or User
Datagram Protocol (UDP) to pass information
to upper layers using the following syntax:
<0-65535>. All ports below 1024 are
considered well-known ports, and are
controlled by the Internet Assigned Numbers
Authority (IANA). All ports above 1024 are
dynamically assigned ports that include
registered ports for vendor-specific
applications.
<port name> The following UDP port numbers can be
biff (Port 512) ntp (Port 123)
bootpc (Port 68) pim-auto-rp (Port 496)
mobile-ip (Port 434) talk (Port 517)
netbios-dgm (Port 138)time (Port 37)
The following TCP port numbers can be
bgp (Port 179) lpd (Port 515)
chargen (Port 19) nntp (Port 119)
cmd (Port 514) pim-auto-rp (Port 496)
daytime (Port 13) pop2 (Port 109)
domain (Port 53) smtp (Port 25)
echo (Port 7) sunrpc (Port 111)
exec (Port 512) syslog (Port 514)
finger (Port 79) tacacs (Port 49)
ftp (Port 21) talk (Port 517)
gopher (Port 70) tftp (Port 69)
ident (Port 113) time (Port 37)

irc (Port 194) uucp (Port 540)

klogin (Port 543) whois (Port 43)
kshell (Port 544) www (Port 80)
login (Port 513)
expressed in one of five ways:
10.10.10.1).
4. Using the keyword hostname to match based on a DNS name. The unit
must be configured with DNS servers for this function to work.
5. Using vrf <name> associates a nondefault VRF with the DNS host
name specified in the source or destination. The VRF is required if the
router’s DNS server is on a nondefault VRF. This parameter can only be
used with the hostname source.
<destination port> Optional. Specifies the destination port. Only valid when <protocol> is tcp
or udp. The same keywords and port numbers/names used for the
<source port> field are valid for the <destination port> field. Refer to
previously listed <source port> for more details.
Default Values
Command History
Functional Notes

Usage Examples
The following example creates an ACL AllowIKE to allow all Internet key exchange (IKE) (UDP Port 500)
packets from the 190.72.22.0 /24 network:
(config)#ip access-list extended AllowIKE

(config-ext-nacl)#permit udp 190.72.22.0 0.0.0.255 eq 500 any eq 500
The following example creates an entry in the MatchAll ACL to permit ip packets from host name
www.adtran.com using the nondefault VRF RED to resolve the DNS host name with any destination:
(config)#ip access-list extended MatchAll

(config-ext-nacl)#permit ip hostname www.adtran.com vrf RED any

remark <remark>
Use the remark command to associate a descriptive tag with an extended access control list (ACL). Use
the no form of this command to remove the descriptive tag.
Syntax Description
<remark> Specifies a descriptive tag for the ACL. Tags can be up to 80 alphanumeric
characters enclosed in quotation marks. For example, “This list blocks all
outbound Web traffic.”
Default Values
Command History
Usage Examples
The following example specifies a description for extended ACL matchall:
(config)#ip access-list extended matchall

(config-ext-nacl)#remark “allows all ip traffic from remote location”

deny <source>
Use the deny command to configure the standard access control list (ACL) to deny specified packets entry
into the routing system. Use the no form of this command to remove the deny parameter from the ACL.
deny <source>
deny <source> log
deny <source> track <name>
Syntax Description
<source> Specifies the source used for packet matching. Sources can be expressed in one of
five ways:
2. Using host <ip address> to specify a single host address. IP addresses should be
3. Using the <ip address> <wildcard mask> format to match all IP addresses in a
range. The wildcard mask corresponds to a range of IP addresses (network) or a
specific host. Wildcard masks are expressed in dotted decimal notation (for
example, 0.0.0.255).
4. Using the keyword hostname to match based on a domain naming system (DNS)
name. The unit must be configured with DNS servers for this function to work.
5. Using vrf <name> associates a nondefault VPN routing and forwarding (VRF)
with the DNS host name for the source. The VRF is required if the router’s DNS
server is on a nondefault VRF. This parameter can only be used with the
hostname source.
Default Values
Command History
Functional Notes

Usage Examples
The following example creates an ACL UnTrusted to deny all packets from the 190.72.22.248 /30
network:
(config)#ip access-list standard UnTrusted

(config-std-nacl)#deny 190.72.22.248 0.0.0.3

permit <source>
Use the permit command to configure the standard access control list (ACL) to permit specified packets
entry into the routing system. Use the no form of this command to remove the permit permission from the
permit <source>
permit <source> log
permit <source> track <name>
Syntax Description
<source> Specifies the source used for packet matching. Sources can be expressed in one of
five ways:
2. Using host <ip address> to specify a single host address. IP addresses should be
3. Using the <ip address> <wildcard mask> format to match all IP addresses in a
range. The wildcard mask corresponds to a range of IP addresses (network) or a
specific host. Wildcard masks are expressed in dotted decimal notation (for
example, 0.0.0.255).
4. Using the keyword hostname to match based on a domain naming system (DNS)
name. The unit must be configured with DNS servers for this function to work.
5. Using vrf <name> associates a nondefault VPN routing and forwarding (VRF)
with the DNS host name for the source. The VRF is required if the router’s DNS
server is on a nondefault VRF. This parameter can only be used with the
hostname source.
Default Values
Command History
Functional Notes

Usage Examples
The following example creates an ACL Trusted to permit all packets from the 190.72.22.248 /30 network:


remark <remark>
Use the remark command to associate a descriptive tag with a standard access control list (ACL). Use the
no form of this command to remove the descriptive tag.
Syntax Description
<remark> Specifies a descriptive tag for the ACL. Tags can be up to 80 alphanumeric
characters enclosed in quotation marks. For example, “This list blocks all
outbound Web traffic.”
Default Values
Command History
Usage Examples
The following example specifies a description for standard ACL matchall:
(config)#ip access-list extended matchall

(config-std-nacl)#remark “allows all ip traffic from remote location”

Command Reference Guide Access Control Policy Command Set
ACCESS CONTROL POLICY COMMAND SET
An access control policy (ACP) defines a policy class containing access control lists (ACLs) in the
ADTRAN Operating System (AOS) command line interface (CLI). The ACP is a named policy with
multiple action entries.
To create an ACP and activate the Access Control Policy Configuration mode, enter the ip policy-class
<name> command at the Global Configuration mode prompt. For example:
>enable
#config terminal
Before applying an ACP to an interface, verify your Telnet or secure shell (SSH)
connection will not be affected by the policy. If an ACP is applied to the interface you are
connecting through and it does not allow Telnet or SSH traffic, your connection will be
lost.
Technology Review
ACPs and ACLs regulate traffic through the routed network. When designing your traffic flow configuration,
it is important to keep the following in mind:
• An access control list (ACL) serves as a packet selector, defining exactly which packets should take the
given action.
• An ACP defines the action to take on the packets selected by the ACL.
• An ACL is inactive until it is assigned to an active ACP.
• An ACP is inactive until it is assigned to an interface.
Access Control Policies (ACPs)
ACPs are used to allow, discard, or manipulate (using network address translation (NAT)) data for each
physical interface. Each ACP consists of an action (allow, discard, nat) and a selector (ACL). In a sense,
the ACPs answer the question, “What should I do?” while the ACLs answer the question, “On which
packets?”

Access Control Lists (ACLs)
ACLs are used as packet selectors by ACPs. They must be assigned to an ACP in order to be active.
ACLs are composed of an ordered list of entries. Each entry contains two parts: an action (permit or deny)
and a packet pattern. A permit action is used to allow packets (meeting the specified pattern) to enter the
router system. A deny action is used to disregard packets (that do not match the pattern) and proceed to
the next entry on the ACP. The ACL has an implicit deny at the end of the list.
Transmission Control Protocol (TCP) or User Datagram Protocol (UDP) header.
Creating and Assigning ACLs and ACPs
Creating ACPs and ACLs to regulate traffic through the routed network is a four-step process:
Step 1:
Step 2:
Step 3:
3. Using the <ip address> <wildcard> format to match all IP addresses in a range. Wildcard masks
work in reverse logic from subnet masks. When broken out into binary form, a 0 indicates
which bits of the IP address to consider, a 1 indicates which bits are disregarded. For example,
specifying 255 in any octet of the wildcard mask equates to a “don’t care” for that octet in the

IP address. Additionally, a 30-bit mask would be represented with the wildcard string 0.0.0.3, a
28-bit mask with 0.0.0.15, a 24-bit mask with 0.0.0.255, and so forth.
4. Using the keyword hostname to match based on a domain naming system (DNS) name. DNS
servers must be configured or host names must be locally defined for this function to work.
Step 4:

do on page 51
exit on page 53
allow list on page 2431

allow reverse list on page 2433
discard list on page 2435
nat destination list on page 2437
nat destination list <acl name> pool <pool name> on page 2439
nat source list on page 2441
nat source list <acl name> pool <pool name> on page 2444

allow list
Use the allow list command to specify an access control list (ACL) to determine which packets are allowed
to enter the interface to which the access control policy (ACP) is assigned, and create a firewall association
in the firewall. All associations created by the allow list command are subject to the built-in firewall timers
(refer to ip policy-timeout <protocol> <range> <port> <value> on page 905). Variations of this
command include:
allow list <acl name>

allow list <acl name> policy <acp name>
allow list <acl name> policy <acp name> stateless
allow list <acl name> self
allow list <acl name> self stateless
allow list <acl name> stateless
Syntax Description
<acl name> Specifies the ACL against which to check traffic before allowing packets to
enter the interface. All packets not matched by the ACL will be processed
by the next ACP entry or implicitly discarded if no further ACP entries exist.
policy <acp name> Optional. Specifies the destination ACP against which to match traffic. The
firewall attempts to match the specified ACP with the ACP that is applied to
the packet's egress interface as determined by the routing table or
policy-based routing configuration. If there is a match, the firewall will
process the packet. If there is no match, the firewall will process the packet
based on the next ACP entry or implicitly discard it if no further ACP entries
exist.
self Optional. Allows packets to pass that are permitted by the ACL and
destined for any local interface on the unit. These packets are terminated by
the unit and are not routed or forwarded to other destinations. Using the
self keyword is helpful when opening up remote administrative access to
the unit (Telnet, secure shell (SSH), Internet Control Message Protocol
(ICMP), Web-based graphical user interface (GUI)).
stateless Optional. Enables bypassing of stateful firewall processing and
application-level gateways (ALGs). Use for trusted traffic or traffic that the
firewall is incorrectly blocking as a perceived attack. Stateless processing is
helpful when passing traffic over virtual private network (VPN) tunnels.
Traffic sent over VPN tunnels is purposely selected and encrypted; there is
no need for additional inspection of the traffic by the firewall. VPN
configurations created using the VPN Wizard in the GUI use stateless
processing by default.
Default Values

Command History
Usage Examples
The following example configures the ACP name UNTRUSTED to allow any traffic that matches the ACL
named INWEB to enter the router system:
(config)#ip policy-class UNTRUSTED

(config-policy-class)#allow list INWEB

allow reverse list

Use the allow reverse list command to specify an access control list (ACL) to determine which packets are
allowed to enter the interface to which the access control policy (ACP) is assigned, and create a firewall
association in the firewall. The allow reverse list command is identical in function to the allow list
command with the exception of the reverse keyword. The reverse keyword instructs the firewall to use the
source information as the destination information and vice versa when attempting matches against the
specified ACL. This command is most useful when the ACP is applied to an interface terminating a virtual
private network (VPN) tunnel. The allow reverse list allows the reuse of the ACL defined as the VPN
selector. Variations of this command include:
allow reverse list <acl name>

allow reverse list <acl name> policy <acp name>
allow reverse list <acl name> policy <acp name> stateless
allow reverse list <acl name> self
allow reverse list <acl name> self stateless
allow reverse list <acl name> stateless
Syntax Description
process the packet. If there is no match, the firewall will process the packet
exist.
self Optional. Allows packets to pass that are permitted by the ACL and
destined for any local interface on the unit. These packets are terminated by
the unit and are not routed or forwarded to other destinations. Using the
self keyword is helpful when opening up remote administrative access to
the unit (Telnet, secure shell (SSH), Internet Control Message Protocol
(ICMP), Web-based graphical user interface (GUI)).
stateless Optional. Enables bypassing of stateful firewall processing and
application-level gateways (ALGs). Use for trusted traffic or traffic that the
firewall is incorrectly blocking as a perceived attack. Stateless processing is
helpful when passing traffic over VPN tunnels. Traffic sent over VPN tunnels
is purposely selected and encrypted; there is no need for additional
inspection of the traffic by the firewall. VPN configurations created using the
VPN Wizard in the GUI use stateless processing by default.
Default Values

Command History
Usage Examples
The following example configures the ACP named UNTRUSTED to allow any traffic that matches the ACL
named INWEB (with source and destination information reversed) to enter the router system:

(config-policy-class)#allow reverse list INWEB

discard list
Use the discard list command to specify an access control list (ACL) to determine which packets are
discarded after entering the interface to which the access control policy (ACP) is assigned. Packets
matched by the ACL will be discarded, and no further ACP entries will be inspected. All packets not
matched by the ACL will be processed by the next ACP entry or implicitly discarded if no further ACP
entries exist. Variations of this command include:
discard list <acl name>

discard list <acl name> policy <acp name>
discard list <acl name> self
Syntax Description
<acl name> Specifies the ACL against which to check traffic before discarding the
packet. All packets not matched by the ACL will be processed by the next
ACP entry or implicitly discarded if no further ACP entries exist.
discard the packet. If there is no match, the firewall will process the packet
exist.
self Optional. Discards packets that are matched by the ACL and destined for
any local interface on the unit. These packets, had they been allowed,
would be terminated by the unit and not routed or forwarded to other
destinations. Using the self keyword is helpful when forbidding certain
access to the unit.
Default Values
Command History
Functional Notes
each physical interface. Each ACP consists of an action (allow, discard, nat) and a selector (ACL). When
packets are received on an interface, the configured ACPs are applied to determine whether the data will
be processed or discarded.

Usage Examples
The following example configures the ACP named UNTRUSTED to discard any traffic that matches the
ACL named INWEB:

(config-policy-class)#discard list INWEB

nat destination list

Use the nat destination list command to translate the destination IP address to a specified IP address, and
creates a firewall association in the firewall. The translation is applied only to those packets permitted by
the specified access control list (ACL) and entering the interface to which the access control policy (ACP)
is assigned. All firewall associations are subject to the built-in firewall timers (refer to ip policy-timeout
<protocol> <range> <port> <value> on page 905). Variations of this command include:
nat destination list <acl name> address <ip address> no-alg

nat destination list <acl name> address <ip address> port <port number>
nat destination list <acl name> address <ip address> port <port number> no-alg
nat destination list <acl name> address <ip address> vrf <vrf name>
nat destination list <acl name> address <ip address> vrf <vrf name> no-alg
nat destination list <acl name> address <ip address> vrf <vrf name> port <port number>
nat destination list <acl name> address <ip address> vrf <vrf name> port <port number> no-alg
Syntax Description
address <ip address> Specifies the address of the private IP host to which the translated packets
are destined. IP addresses should be expressed in dotted decimal notation
(for example, 10.10.10.1).
no-alg Optional. Allows packets matching the ACP entry to traverse the firewall
without being processed by the application-level gateways (ALGs). This
parameter, along with the appropriate ACL, prevents specific destinations
from being processed by the ALGs.
port <port number> Optional. Translates the original destination port to a user-specified port.
vrf <vrf name> Optional. Specifies the VPN routing and forwarding (VRF) instance
corresponding to the specified post-NAT destination address.
Default Values
Command History
Release 16.1 Command was expanded to include the no-alg parameter.

Functional Notes
each physical interface. Each ACP consists of an action (allow, discard, nat) and a selector (ACL). When
packets are received on an interface, the configured ACPs are applied to determine whether the data will
be processed or discarded.
certain functions of a unit (VPN, routing protocols, etc.). Specifying an empty ACL or a
nonexistent ACL in an ACP will result in an implicit permit.
The optional vrf <vrf name> parameter specifies the VRF instance. The VRF does not have to be the
same VRF from which the packet originated. VRF on an AOS product allows a single physical router to be
partitioned into multiple virtual routers. Each router instance has its own route table and interface
assignments. Beginning with Release 16.1, all AOS routers supporting multiple VRF instances (multi-VRF)
have an unnamed default VRF instance regardless of whether multi-VRF is configured. Therefore,
executing the abovementioned commands without specifying a VRF indicates that the specified address
corresponds to the default unnamed VRF.
Usage Examples
The following example enables NAT for traffic that matches the ACL INWEB and changes the destination
address to 192.168.0.253:

(config-policy-class)#nat destination list INWEB address 192.168.0.253

nat destination list <acl name> pool <pool name>

Use the nat destination list pool command to translate the destination IP address to an address within the
specified pool of addresses, translating a global to local address association. The translation is applied only
to those packets permitted by the specified access control list (ACL), and entering the interface to which
the access control policy (ACP) is assigned, and to those packets whose destination IP address falls within
the global range of the network address translation (NAT) pool. All firewall associations are subject to the
built-in firewall timers (refer to ip policy-timeout <protocol> <range> <port> <value> on page 905).
nat destination list <acl name> pool <pool name>

nat destination list <acl name> pool <pool name> no-alg
Syntax Description
pool <pool name> Specifies the NAT pool to use for address mapping. If the destination IP
address does not fall within the global range of the specified pool, the
packet will be processed by the next ACP entry or implicitly discarded if no
further ACP entries exist.
parameter, along with the appropriate ACL, prevents specific destinations
from being processed by the ALGs.
Default Values
Command History
Functional Notes
AOS ACPs are used to allow, discard, or manipulate (using NAT) data for each physical interface. Each
ACP consists of an action (allow, discard, nat) and a selector (ACL). When packets are received on an
interface, the configured ACPs are applied to determine whether the data will be processed or discarded.

Usage Examples
The following example enables NAT for traffic that matches the ACL OUTSIDE and uses the NAT pool
POOL1 to map addresses:
(config)#ip policy-class PUBLIC

(config-policy-class)#nat destination list OUTSIDE pool POOL1

nat source list

Use the nat source list command to translate the source IP address to a specified IP address (or to the
primary IP address of the specified interface) and create an association in the firewall. The translation is
applied only to those packets permitted by the specified access control list (ACL), and entering the
interface to which the access control policy (ACP) is assigned. This function is commonly referred to as a
“many-to-one NAT”. All firewall associations are subject to the built-in firewall timers (refer to ip
policy-timeout <protocol> <range> <port> <value> on page 905). Variations of this command include:
nat source list <acl name> address <ip address> overload

nat source list <acl name> address <ip address> overload no-alg
nat source list <acl name> address <ip address> overload no-alg policy <acp name>
nat source list <acl name> address <ip address> overload policy <acp name>
nat source list <acl name> address <ip address> vrf <vrf name> overload
nat source list <acl name> address <ip address> vrf <vrf name> overload no-alg
nat source list <acl name> address <ip address> vrf <vrf name> overload no-alg policy <acp name>
nat source list <acl name> address <ip address> vrf <vrf name> overload policy <acp name>
nat source list <acl name> interface <interface> overload
nat source list <acl name> interface <interface> overload no-alg
nat source list <acl name> interface <interface> overload no-alg policy <acp name>
nat source list <acl name> interface <interface> overload policy <acp name>
Syntax Description
address <ip address> Specifies the IP address from which the translated packets will be sourced.
10.10.10.1).
interface <interface> Specifies the interface from which the translated packets will be sourced.
The primary IP address of an interface is used as the source IP address for
translated packets. Specify an interface in the format <interface type
[slot/port | slot/port.subinterface id | interface id | interface id.subinterface
id]>. For example, for an Ethernet subinterface, use eth 0/1.1; for a PPP
interface, use ppp 1; and for an ATM subinterface, use atm 1.1. Type nat
source list <acl name> interface ? for a list of valid interfaces.
policy <acp name> Optional. Specifies the ACP against which to match traffic. The firewall
attempts to match the specified ACP with the ACP that is applied to the
packet's egress interface as determined by the routing table or policy-based
routing configuration. If there is a match, the firewall will process the packet.
If there is no match, the firewall will process the packet based on the next
ACP entry or implicitly discard it if no further ACP entries exist.
vrf <vrf name> Optional. Specifies the VPN routing and forwarding (VRF) instance
corresponding to the specified post-NAT source address.

overload Allows multiple source IP addresses to be replaced with the single IP

address specified or the primary IP address of the specified interface. This
conceals private IP addresses from outside the local network. The
overload command is not optional and must be used when using the nat
source list command with a single address or interface. To perform static
1:1 NAT, use a network address translation (NAT) pool instead (refer to nat
source list <acl name> pool <pool name> on page 2444).
parameter, along with the appropriate ACL, prevents specific sources from
being processed by the ALGs. For example, this option can be used to
prevent specific hosts from being uniform resource locator (URL) filtered by
configuring an ACP entry with the no-alg parameter that matches specific
hosts followed by another ACP entry that matches remaining hosts. The
no-alg parameter can be placed before or after the policy <acp name>
parameter.
Default Values
Command History
Release 16.1 Command was expanded to include the no-alg parameter.
Functional Notes
certain functions of a unit (VPN, routing protocols, etc.). Specifying an empty ACL or a
nonexistent ACL in an ACP will result in an implicit permit.
The optional vrf <vrf name> parameter specifies the VRF instance corresponding to the specified address.
(If an interface is specified, the VRF of that interface is used.) The VRF does not have to be the same VRF
from which the packet originated. VRF on an AOS product allows a single physical router to be partitioned
into multiple virtual routers. Each router VRF instance has its own route table and interface assignments.
Beginning with Release 16.1, all AOS routers supporting multiple VRF instances (multi-VRF) have an
unnamed default VRF instance regardless of whether multi-VRF is configured. Therefore, executing the
abovementioned commands without specifying a VRF indicates that the specified address corresponds to
the default unnamed VRF.

Usage Examples
The following configuration enables NAT for traffic that matches the ACL MATCHALL and changes the
source address to 63.12.1.2:

(config-policy-class)#nat source list MATCHALL address 63.12.1.2 overload

nat source list <acl name> pool <pool name>

Use the nat source list pool command to translate the source IP address to an IP address within the
specified pool of addresses, translating a local private address to global public address. The translation is
applied only to those packets permitted by the specified access control list (ACL), and entering the
interface to which the access control policy (ACP) is assigned and whose source IP address falls within the
local range of addresses in the specified pool. All firewall associations are subject to the built-in firewall
timers (refer to ip policy-timeout <protocol> <range> <port> <value> on page 905). Variations of this
command include:
nat source list <acl name> pool <pool name>

nat source list <acl name> pool <pool name> no-alg
nat source list <acl name> pool <pool name> no-alg policy <acp name>
nat source list <acl name> pool <pool name> policy <acp name>
nat source list <acl name> pool <pool name> policy <acp name> no-alg
Syntax Description
pool <pool name> Specifies the network address translation (NAT) pool to use for address
mapping. If the source IP address does not fall within the local range of the
specified pool, the packet will be processed by the next ACP entry or
implicitly discarded if no further ACP entries exist.
policy <acp name> Optional. Specifies the ACP against which to match traffic. The firewall
attempts to match the specified ACP with the ACP that is applied to the
packet's egress interface as determined by the routing table or policy-based
routing configuration. If there is a match, the firewall will process the packet.
If there is no match, the firewall will process the packet based on the next
ACP entry or implicitly discard it if no further ACP entries exist.
parameter, along with the appropriate ACL, prevents specific sources from
being processed by the ALGs. For example, this option can be used to
prevent specific hosts from being uniform resource locator (URL) filtered by
configuring an ACP entry with the no-alg parameter that matches specific
hosts followed by another ACP entry that matches remaining hosts. The
no-alg parameter can be placed before or after the policy <acp name>
parameter.
Default Values
Command History

Functional Notes
Usage Examples
The following example configures the ACP PRIVATE using an undefined ACL that matches all traffic,
specifies the NAT pool POOL1, and specifies that the traffic matching this entry should be destined for the
PUBLIC policy class:

(config-policy-class)#nat source list MATCHALL pool POOL1 policy PUBLIC

Command Reference Guide Desktop Auditing Local Policy Command Set
DESKTOP AUDITING LOCAL POLICY COMMAND SET
Desktop auditing is an AOS feature that uses Dynamic Host Configuration Protocol (DHCP) in
conjunction with the Microsoft® Network Access Protection (NAP) Protocol to monitor the health of client
computers connected to a NetVanta network. The two protocols work together to ensure that systems
connected to the network are using appropriate corporate policies, such as appropriate firewall settings,
antivirus settings, and other client health information. This information is exchanged between clients and
servers in statement of health (SoH) and statement of health response (SoHR) messages.
Desktop auditing is configured on AOS products by enabling the feature and by optionally configuring
filters to limit the output of the collected NAP information. These optional filters allow you to see who the
policy violators are. When desktop auditing is enabled, the AOS product collects DHCP information, such
as the medium access control (MAC) and IP addresses, virtual local area network (VLAN) ID, host name,
and source port, as well as the MAC and IP addresses of the server and the date and time of the last DHCP
information update. The NAP information collected by desktop auditing includes the client’s OS version
and service pack, processor architecture, firewall name and state, antivirus name and state, antispyware
name and state, automatic update configuration, security update information, and the NAP state (enabled
or disabled) of both the server and the client.
Desktop auditing local policies determine when a NAP client may be a violator by collecting NAP
information for the connected clients and comparing them to the configured policies. It is possible to
monitor clients’ firewall states, antivirus states, antispyware states, auto-update states, and security update
statuses using these policies. If no desktop auditing policies are configured, then, by default, desktop
auditing monitors all NAP information for each client.
For more information about configuring desktop auditing, refer to the Configuring Desktop Auditing in
AOS configuration guide available online at http://kb.adtran.com.
Desktop auditing should be enabled on the AOS device before configuring the desktop auditing local
policy. Desktop auditing is enabled using the command desktop-auditing dhcp on page 792. To create a
desktop auditing local policy and enter the policy’s configuration mode, enter the desktop-auditing
local-policy command from the Global Configuration mode prompt. For example:
>enable
#configure terminal
(desktop-audit-policy)#
of this guide. For more information, refer to the section listed below:
do on page 51
exit on page 53

The following commands are used to configure the desktop auditing local policy. These commands are
described in this section in alphabetical order:
anti-spyware current on page 2448

anti-virus current on page 2449
auto-update current on page 2450
firewall enable on page 2451
security-update current on page 2452

anti-spyware current
Use the anti-spyware current command to define the local desktop auditing policy to monitor clients’
antispyware status. If the antispyware is inactive, disabled, or not up-to-date, the client is a violator and its
statistics will be collected. Using the no form of this command removes antispyware monitoring from the
policy.
Syntax Description
No subcommands.
Default Values
By default, desktop monitoring local policies monitor all NAP information for each client.
Command History
Usage Examples
The following example specifies that the local policy will monitor clients’ antispyware status:
(desktop-audit-policy)#anti-spyware current

anti-virus current
Use the anti-virus current command to define the local desktop auditing policy to monitor clients’
antivirus status. If the antivirus is inactive, disabled, or not up-to-date, the client is a violator and its
statistics will be collected. Using the no form of this command removes antivirus monitoring from the
policy.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example specifies that the local policy will monitor clients’ antivirus status:
(desktop-audit-policy)#anti-virus current

auto-update current
Use the auto-update current command to define the local desktop auditing policy to monitor clients’
auto-update status. If the auto-updates are not configured to check for updates, download them, and install
them automatically, then the client is a violator and its statistics will be collected. Using the no form of this
command removes auto-update monitoring from the policy.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example specifies that the local policy will monitor clients’ auto-update status:
(desktop-audit-policy)#auto-update current

firewall enable
Use the firewall enable command to define the local desktop auditing policy to monitor clients’ firewall
states. If the firewall is disabled or inactive, the client is a violator and its statistics will be collected. Using
the no form of this command removes firewall monitoring from the policy.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example specifies that the local policy will monitor clients’ firewall states:
(desktop-audit-policy)#firewall enable

security-update current
Use the security-update current command to define the local desktop auditing policy to monitor clients’
security update status. If security updates are not current, the client is a violator and its statistics will be
collected. Using the no form of this command removes security update monitoring from the policy.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example specifies that the local policy will monitor clients’ security update status:
(desktop-audit-policy)#security-update current

Command Reference Guide DHCP Pool Command Set
DHCP POOL COMMAND SET
To activate the Dynamic Host Configuration Protocol (DHCP) Pool mode, enter the ip dhcp-server pool
>enable
#configure terminal
(config)#ip dhcp-server pool MyPool
(config-dhcp)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61
bootfile <name> on page 2454

client-identifier <identifier> on page 2455
client-name <name> on page 2456
default-router on page 2457
dns-server on page 2458
domain-name <name> on page 2459
hardware-address on page 2460
host <ip address> on page 2462
lease <days> on page 2463
nap on page 2464
netbios-name-server on page 2465
netbios-node-type on page 2466
network on page 2467
ntp-server <ip address> on page 2468
option on page 2469
tftp-server <name> on page 2470
timezone-offset <value> on page 2471
vrf <name> on page 2472

bootfile <name>
Use the bootfile command to specify a fully qualified directory-path name to a file located on a Trivial File
Transfer Protocol (TFTP) server on the network. Some network devices use the file (the path sent to the
Dynamic Host Configuration Protocol (DHCP) client in the DHCPOFFER message) for initial
configuration. Use the no form of this command to remove a configured boot file.
Syntax Description
<name> Specifies a fully qualified directory-path name to the file located on the
network. If the file is located in the root directory of the TFTP server, enter
the file name only.
Default Values
By default, there is no specified boot file.
Command History
Functional Notes
RFC 2131 provides specifications for DHCP servers to supply clients with information that allows the
clients to exchange packets with other hosts on the network. DHCP clients that do not store the correct
boot software on an internal flash drive can receive a boot file from a TFTP server. The AOS DHCP server
can provide these devices with the address of the network TFTP server and the configuration file name.
For example, some IP phones use this functionality to download the feature and key activation file. Use the
command tftp-server <name> on page 2470 to specify the IP address of the network TFTP server.
RFC 2131 includes provisions to allow DHCP servers to utilize the 128 octets designated for the boot file
directory-path for expanding the DHCP options field. RFC 1533 outlines the available DHCP variables for
the options field. This process must be negotiated between client and server during the DHCPDISCOVER
process and should only take place if the client specifies a small maxDHCPmessage size in the
DHCPDISCOVER message.
Usage Examples
The following example specifies the location of a TFTP server on the local area network (LAN) at 10.10.0.4
and a boot file of myconfig.cfg (located in the TFTP server root directory) for the DHCP pool IP_Phones:
(config)#ip dhcp-server pool IP_Phones

(config-dhcp)#tftp sever 10.10.0.4
(config-dhcp)#bootfile myconfig.cfg

client-identifier <identifier>
Use the client-identifier command to specify a unique identifier (in dotted hexadecimal notation) for a
Dynamic Host Configuration Protocol (DHCP) client. Use the no form of this command to remove a
configured client identifier.
Syntax Description
<identifier> Specifies a client identifier using 7 to 28 hexadecimal characters with colon
delimiters. Refer to the Functional Notes below for more information.
Default Values
Command History
Functional Notes
DHCP clients use client identifiers in place of hardware addresses. To create the client identifier, begin with
the two-digit numerical code representing the media type and append the client’s medium access control
(MAC) address. For example, a Microsoft client with an Ethernet (01) MAC address d2:17:04:91:11:50
uses a client identifier of 01:d2:17:04:91:11:50.
Usage Examples
The following example specifies the client identifier for a Microsoft client with an Ethernet MAC address of
d217.0491.1150:
(config)#ip dhcp-server pool Microsoft_Clients

(config-dhcp)#client-identifier 01:d2:17:04:91:11:50

client-name <name>
Use the client-name command to specify the name of a Dynamic Host Configuration Protocol (DHCP)
client. Use the no form of this command to remove the configured client name.
Syntax Description
<name> Identifies the DHCP client (example is client1) using an alphanumeric
string (up to 32 characters in length).
The specified client name should not contain the domain name.
Default Values
By default, there are no specified client names.
Command History
Usage Examples
The following example specifies a client name of myclient:

(config-dhcp)#client-name myclient

default-router
Use the default-router command to specify the default primary and secondary routers to use for the
Dynamic Host Configuration Protocol (DHCP) client. Use the no form of this command to remove the
configured router. Variations of this command include:
default-router <ip address>

default-router <ip address> <secondary>
Syntax Description
<ip address> Specifies the IP address of the preferred router on the client’s subnet.
<secondary> Optional. Specifies the IP address of the second preferred router on the
client’s subnet.
10.10.10.1).
Default Values
By default, there are no specified default routers.
Command History
Functional Notes
When specifying a router to use as the primary/secondary preferred router, verify that the listed router is on
the same subnet as the DHCP client. AOS allows a designation for two routers, listed in order of
precedence.
Usage Examples
The following example configures a default router with address 192.22.4.253 and a secondary router with
address 192.22.4.254:

(config-dhcp)#default-router 192.22.4.253 192.22.4.254

dns-server
Use the dns-server command to specify the default domain naming system (DNS) servers (up to four
servers) to use for the Dynamic Host Configuration Protocol (DHCP) client. Use the no form of this
command to remove the configured DNS server. Variations of this command include:
dns-server <ip address>

dns-server <ip address> <second>
dns-server <ip address> <second> <third>
dns-server <ip address> <second> <third> <fourth>
Syntax Description
<ip address> Specifies the IP address of the preferred DNS server on the network.
<second> Optional. Specifies the IP address of the second preferred DNS server on
the network.
<third> Optional. Specifies the IP address of the third preferred DNS server on the
network.
<fourth> Optional. Specifies the IP address of the fourth preferred DNS server on the
network.
10.10.10.1).
Default Values
By default, there are no specified default DNS servers.
Command History
Release 4.1 Command was expanded to include the Internet key exchange (IKE) client
configuration pool.
Release 17.3 Command was expanded to include a third and fourth DNS server listing.
Usage Examples
The following example specifies a default DNS server with address 192.72.3.254 and a secondary DNS
server with address 192.100.4.253:

(config-dhcp)#dns-server 192.72.3.254 192.100.4.253

domain-name <name>
Use the domain-name command to specify the domain name for the Dynamic Host Configuration
Protocol (DHCP) client. Use the no form of this command to remove the configured domain name.
Syntax Description
<name> Identifies the DHCP client (e.g., adtran.com) using an alphanumeric string
(up to 32 characters in length).
Default Values
By default, there are no specified domain names.
Command History
Usage Examples
The following example specifies a domain name of adtran.com:

(config-dhcp)#domain-name adtran.com

hardware-address
Use the hardware-address command to specify the name of a Dynamic Host Configuration Protocol
(DHCP) client. Use the no form of this command to remove the configured client name. Variations of this
command include:
hardware-address <mac address>

hardware-address <mac address> <type>
hardware-address <mac address> ethernet
hardware-address <mac address> ieee802
Syntax Description
<mac address> Specifies a valid 48-bit medium access control (MAC) address. MAC
example, 00:A0:C8:00:00:01).
<type> Optional. Specifies one of the hardware types listed in RFC 1700. Valid
range is 1 to 21.
The valid hardware types are as follows:
1 10 Mb Ethernet
2 Experimental 3 Mb Ethernet
3 Amateur Radio AX.25
4 Proteon ProNET Token Ring
5 Chaos
6 IEEE 802 Networks
7 ARCNET
8 Hyperchannel
9 Lanstar
10 Autonet Short Address
11 LocalTalk
12 LocalNet (IBM PCNet or SYTEK LocalNet)
13 Ultra link
14 SMDS
15 Frame Relay
16 Asynchronous Transfer Mode (ATM)
17 High Level Data Link Control (HDLC)
18 Fibre Channel
19 Asynchronous Transfer Mode
20 Serial Line
21 Asynchronous Transfer Mode
ethernet Optional. Specifies standard Ethernet networks.
ieee802 Optional. Specifies IEEE 802 standard networks.

Default Values
By default, the hardware address type is set to 10 Mbps Ethernet (1).
Command History
Usage Examples
The following example specifies an Ethernet client with a MAC address of ae:11:54:60:99:10:

(config-dhcp)#hardware-address ae:11:54:60:99:10 ethernet

host <ip address>

Use the host command to specify the IP address and subnet mask for a manual binding to a Dynamic Host
Configuration Protocol (DHCP) client. Use the no form of this command to remove the configured client
host <ip address>

host <ip address> <subnet mask>
Syntax Description
<ip address> Specifies the IP address for a manual binding to a DHCP client. IP
10.10.10.1).
(for example, /24).
If the subnet mask is left unspecified, the DHCP server examines its
address pools to obtain an appropriate mask. If no valid mask is found in
the address pools, the DHCP server uses the Class A, B, or C natural
mask.
Default Values
By default, there are no specified host addresses.
Command History
Usage Examples
The following examples show two different ways to specify a client with IP address 12.200.5.99 and a
21-bit subnet mask:

(config-dhcp)#host 12.200.5.99 255.255.248.0
or

(config-dhcp)#host 12.200.5.99 /21

lease <days>
Use the lease command to specify the duration of the lease for an IP address assigned to a Dynamic Host
Configuration Protocol (DHCP) client. Use the no form of this command to return to the default lease
value. Variations of this command include:
lease <days>
lease <days> <hours>
lease <days> <hours> <minutes>
Syntax Description
<days> Specifies the duration of the IP address lease in days.
<hours> Optional. Specifies the number of hours in a lease. You may only enter a
value in the hours field if the days field is specified.
<minutes> Optional. Specifies the number of minutes in a lease. You may only enter a
value in the minutes field if the days and hours fields are specified.
Default Values
By default, an IP address lease is one day.
Command History
Usage Examples
The following example specifies a lease of 2 days:

(config-dhcp)#lease 2
The following example specifies a lease of 1 hour:

(config-dhcp)#lease 0 1
The following example specifies a lease of 30 minutes:

(config-dhcp)#lease 0 0 30

nap
Use the nap command to enable network access protection (NAP) advertisements for the Dynamic Host
Configuration Protocol (DHCP) server pools of AOS units that are operating as DHCP servers. Use the no
form of this command to disable NAP advertisements on the server pool.
Syntax Descriptions
No subcommands.
Default Values
By default, NAP advertisements are disabled on DHCP server pools.
Command History
Functional Notes
This command is used if your AOS unit is functioning as a DHCP server and you want DHCP server pools
to advertise that they are NAP compatible because you are using desktop auditing. Desktop auditing is an
AOS feature that collects NAP information through NAP messages sent in DHCP messages between
clients connected to the network and the network server.
Desktop auditing is configured by enabling the feature (using the command desktop-auditing dhcp on page
792) and by configuring filters to limit the output of the collected NAP information. Information is limited by
specifying local desktop auditing policies. The configuration of these policies is outlined in Desktop
Auditing Local Policy Command Set on page 2975. For more information about desktop auditing, refer to
the Configuring Desktop Auditing in AOS configuration guide available online at http://kb.adtran.com.
Usage Examples
The following example enables NAP advertisements on the DHCP server pool MyPool:

(config-dhcp)#nap

netbios-name-server
Use the netbios-name-server command to specify the primary and secondary network basic input/output
system (NetBIOS) Windows Internet Naming Service (WINS) name servers available for use by the
Dynamic Host Configuration Protocol (DHCP) clients. Use the no form of this command to remove a
configured NetBIOS name server. Variations of this command include:
netbios-name-server <ip address>

netbios-name-server <ip address> <secondary>
Syntax Description
<ip address> Specifies the IP address of the preferred NetBIOS WINS name server on
the network.
<secondary> Optional. Specifies the IP address of the second preferred NetBIOS WINS
name server on the network.
10.10.10.1).
Default Values
By default, there are no configured NetBIOS WINS name servers.
Command History
Usage Examples
The following example specifies a primary NetBIOS WINS name server with an IP address of 172.45.6.99
and a secondary with an IP address of 172.45.8.15:

(config-dhcp)#netbios-name-server 172.45.6.99 172.45.8.15

netbios-node-type
Use the netbios-node-type command to specify the type of network basic input/output system (NetBIOS)
node used with Dynamic Host Configuration Protocol (DHCP) clients. Use the no form of this command
to remove a configured NetBIOS node type. Variations of this command include:
netbios-node-type <value>
netbios-node-type b-node
netbios-node-type h-node
netbios-node-type m-node
netbios-node-type p-node
Syntax Description
<value> Specifies the NetBIOS node type using the numerical value. Refer to the
node types below for the corresponding numerical values.
b-node Specifies the broadcast node. Numeric value is 1.
h-node Specifies the hybrid node (recommended). Numeric value is 8.
m-node Specifies the mixed node. Numeric value is 4.
p-node Specifies the peer-to-peer node. Numeric value is 2.
Default Values
By default, the netbios-node-type is set to h-node (hybrid node, numeric value 8).
Command History
Usage Examples
The following example specifies a client’s NetBIOS node type as h-node:

(config-dhcp)#netbios-node-type h-node
Alternately, the following also specifies the client’s NetBIOS node type as h-node:
(config-dhcp)#netbios-node-type 8

network
Use the network command to specify the subnet number and mask for an AOS Dynamic Host
Configuration Protocol (DHCP) server address pool. Use the no form of this command to remove a
configured subnet. Variations of this command include:
network <ip address>

network <ip address> <subnet mask>
Syntax Description
<ip address> Specifies the IP address of the DHCP address pool. IP addresses should be
(for example, /24). If the subnet mask is left unspecified, the DHCP server
uses the Class A, B, or C natural mask.
Default Values
By default, there are no configured DHCP address pools.
Command History
Usage Examples
The following examples show two different ways to configure an address pool subnet of 192.34.0.0 with a
16-bit subnet mask:

(config-dhcp)#network 192.34.0.0 255.255.0.0
or

(config-dhcp)#network 192.34.0.0 /16

ntp-server <ip address>

Use the ntp-server command to specify the name of the Network Time Protocol (NTP) server published to
the client. Use the no form of this command to remove a defined NTP server.
Syntax Description
<ip address> Specifies the IP address of the NTP server. IP addresses should be
Default Values
By default, no NTP server is defined.
Command History
Usage Examples
The following example specifies the IP address of the NTP server:

(config-dhcp)#ntp-server 192.168.1.1

option
Use the option command to describe a generic Dynamic Host Configuration Protocol (DHCP) option to be
published to the client. The user may specify any number of generic options to be published to the client.
option <option value> ascii <value>

option <option value> hex <value>
option <option value> ip <value>
Syntax Description
<option value> Specifies the value of the generic DHCP option published to the client.
Range is 0 to 255.
ascii Specifies the DHCP option information in ASCII format.
hex Specifies the DHCP option information in hexadecimal format.
ip Specifies the DHCP option information in IP format.
<value> Specifies the ASCII, hexadecimal, or IP value. The value for ascii is simple
text. The value for hex is an 8-digit hexadecimal number (32 bit). The value
for ip is an IP address. IP addresses should be expressed in dotted decimal
Default Values
Command History
Usage Examples
The following example publishes DHCP options to the client:

(config-dhcp)#option 100 ascii ascii_value
(config-dhcp)#option 101 hex AB458E80
(config-dhcp)#option 102 ip 192.168.1.1

tftp-server <name>
Use the tftp-server command to specify the IP address or domain naming system (DNS) name of the
Trivial File Transfer Protocol (TFTP) server published to the client. Use the no form of this command to
remove a defined TFTP server.
Syntax Description
<name> Specifies the DNS name or dotted decimal notation IP address of the
server.
Default Values
By default, no TFTP server is defined.
Command History
Usage Examples
The following example specifies the IP address of the TFTP server:

(config-dhcp)#tftp-server 192.168.1.1
The following example specifies the DNS name of the TFTP server:

(config-dhcp)#tftp-server MyServer.adtran.com

timezone-offset <value>
Use the timezone-offset command to specify the timezone adjustment (in hours) published to the client.
Use the no form of this command to remove a timezone offset.
Syntax Description
<value> Specifies the timezone adjustment (in hours) published to the client. Use an
integer from -12 to 12 hours.
Default Values
Command History
Usage Examples
The following example sets the timezone adjustment for the client to -3 hours. For example, if the server
time is configured for Eastern time and the client is configured for Pacific time, you can set the client
timezone adjustment to -3 hours:

(config-dhcp)#timezone-offset -3

vrf <name>
Use the vrf command to associate a Dynamic Host Configuration Protocol (DHCP) address pool with a
specific VPN routing and forwarding (VRF) instance. An address pool can only be assigned to one VRF,
but a VRF can have multiple address pools providing addresses for it. Use the no form of this command to
remove the association with the named VRF instance and assign the address pool to the default (unnamed)
VRF.
Keep in mind that associating a DHCP address pool with a nondefault VRF will clear all
previously configured settings for the address pool.
Syntax Description
<name> Specifies the name of the VRF to associate with the DHCP address pool.
Default Values
By default, DHCP address pools are associated with the default unnamed VRF.
Command History
Functional Notes
VRF instances must be created first before a DHCP address pool can be assigned. An address pool can
only be assigned to one VRF, but multiple address pools can be assigned to the same VRF.
Usage Examples
The following example creates a DHCP address pool named PRIVATE and assigns it to the VRF instance
named RED:
(config)#ip dhcp-server pool PRIVATE

(config-dhcp)#vrf RED
WARNING!!! All settings for this pool have been removed
(config-dhcp)#network 10.22.199.0 255.255.255.0

Command Reference Guide Ethernet OAM CFM Command Set
ETHERNET OAM CFM COMMAND SET
Ethernet operations, administration, and maintenance (OAM) connectivity fault management (CFM) is a
type of service management for wide area network (WAN) Ethernet networks over an entire Ethernet
service instance. Ethernet OAM CFM provides maintenance and monitoring within multiple network
domains and different domain levels, and is specifically concerned with detecting faults over the service
instance. Using a system of messages and notifications within the service domain, CFM can discover
Ethernet service instance connection paths, locate and verify faults in the connection, isolate any
discovered faults, give notification of discovered faults, and assist in fault recovery.
CFM operates between maintenance domains (MDs), MD levels, maintenance intermediate points (MIPs),
and maintenance endpoints (MEPs). MDs are administrator domains of switches and routers, created for
the purpose of managing a WAN network. Each MD is nested in a hierarchy, and these hierarchies create
MD levels. Each level is specific to the MD, as each level is made up of a different MD along the service
instance. These levels are created by the beginning and termination of MDs using MIPs and MEPs. MIPs
are maintenance points within the MD, and MEPs are maintenance points that terminate the domain.
Ethernet OAM CFM in AOS deals specifically with MEPs in the AOS product. MEPs terminate Layer 2
traffic and are typically routers that convert Layer 2 traffic into a Layer 3 interface. CFM detects service
connectivity problems by sending continuity check messages (CCMs) between MEPs, by sending path
trace messages (Ethernet traceroute) between MEPs, and by sending loopback messages (Ethernet ping)
between MEPs.
The Ethernet OAM CFM command set describes the commands needed for configuring MDs,
maintenance associations (MAs), and MEPs. To enable Ethernet OAM CFM functionality, enter the
command ethernet cfm on page 798 from the Global Configuration mode prompt as follows:
>enable
#configure terminal
(config)#ethernet cfm
(config)#
Once Ethernet OAM CFM is enabled, you must create a maintenance domain using the ethernet cfm
domain <name> level <level> command (refer to ethernet cfm domain on page 799). This command is
entered from the Global Configuration mode prompt, and enters the maintenance domain configuration.
Enter the command as follows:
>enable
#configure terminal
(config)#ethernet cfm domain domain1 level 6

After entering the MD Configuration mode, you can access the MA Configuration mode, the MEP
Configuration mode, and the Interface Configuration mode. The following command set describes
commands common to all CFM Configuration modes, as well as those specific to maintenance association
(MA), MEP, or Interface configurations. For more information regarding Ethernet OAM CFM and its
operation on AOS products, refer to the Ethernet OAM CFM in AOS configuration guide available on the
AOS Documentation CD shipped with your product or online at http://kb.adtran.com (article number
3013).
exit on page 53
The following commands are MD configuration commands:
association <name> on page 2475

remote-mep hold-time <minutes> on page 2476
The association <name> command, as described in the MD configuration command section, creates an
MA and enters the MA Configuration mode. The following commands are MA configuration commands:
ccm interval on page 2477

component <component> vlan on page 2478
mep-validation on page 2480
remote-mep <mep id> on page 2482
The component command, as described in the MA configuration command section, creates a component
and enters the Component Configuration mode. The following commands are component configuration
commands:
mp-sender-id on page 2483

Ethernet OAM CFM can also be configured at the interface level. CFM must be enabled and an MEP must
be created at the interface level using the commands ethernet-cfm down on page 1325 and ethernet-cfm
mep on page 1326 from the Ethernet or Ethernet subinterfaces. Once CFM is enabled and the MEP is
created at the interface level, the MEP can be configured using the following commands:
alarm-priority-level on page 2484

alarm timers <alarm time> <reset time> on page 2486
ccm-enabled on page 2487
mep-enabled on page 2488
priority <value> on page 2489
snmp-trap fault alarm on page 2490

association <name>
Use the association command to create, enable, and enter the configuration of an Ethernet operations,
administration, and maintenance (OAM) connectivity fault management (CFM) maintenance association
(MA). Use the no form of this command to remove the association and its association maintenance
endpoints (MEPs).
Syntax Description
<name> Specifies the name of the MA. Names can be up to 42 characters in length.
Default Values
By default, no MAs exist.
Command History
Functional Notes
Usage Examples
The following example enables and creates MA association1 from the Maintenance Domain (MD)
Configuration mode, and enters the MA Configuration mode:

(config-ecfm-domain)#association association1
(config-ecfm-assoc)#

remote-mep hold-time <minutes>

Use the remote-mep hold-time command to specify the length of time an associated maintenance
endpoint (MEP) remains in the maintenance domain’s (MD’s) remote MEP database after the MEP has
entered a failed state. Use the no form of this command to return to the default value.
Syntax Description
<minutes> Specifies the length of time the associated MEP remains in the MD’s MEP
database after the MEP has failed. Range is 1 to 65535 minutes.
Default Values
By default, MEPs remain in the MD’s MEP database for 100 minutes.
Command History
Functional Notes
Each MEP that is created is associated with a particular MD. The MDs maintain an MEP database of
remote MEPs, listing all configured and associated remote MEPs within the system. When a remote MEP
fails, it can be removed from this database after a specified amount of time. When the remote MEP entry is
purged, any errors logged relating to the remote MEP are also purged.
For more information regarding Ethernet operations, administration, and maintenance (OAM) connectivity
fault management (CFM) and its operation on AOS products, refer to the Ethernet OAM CFM in AOS
configuration guide available on the AOS Documentation CD shipped with your product or online at
Usage Examples
The following example specifies that remote MEP entries are purged from the MD’s remote MEP database
after 60 minutes:

(config-ecfm-domain)#remote-mep hold-time 60

ccm interval
Use the ccm interval command to specify how frequently maintenance endpoints (MEPs) of this
association send continuity check messages (CCMs). Use the no form of this command to return to the
ccm interval 100ms

ccm interval 1s
ccm interval 10s
ccm interval 1m
ccm interval 10m
Syntax Description
100ms Specifies the interval as 100 milliseconds.
1s Specifies the interval as 1 second.
10s Specifies the interval as 10 seconds.
1m Specifies the interval as 1 minute.
10m Specifies the interval as 10 minutes.
Default Values
By default, the continuity check message (CCM) interval is set to 1 second.
Command History
Functional Notes
Usage Examples
The following example sets the CCM interval to 1 minute:
(config-ecfm-assoc)#ccm interval 1m

component <component> vlan

Use the component vlan command to create a set of virtual local area networks (VLANs) as a fixed group
on a particular component and assign these VLANs to be protected by the maintenance association (MA)
on this component. The command also enters the Component Configuration mode. The no form of this
command removes the component definition from the association. Variations of this command include:
component <component> vlan none

component <component> vlan <vlan id>
Syntax Description
<component> Specifies the component to be added to the MA. Components are specified
in the form <component type [slot/port]>. For example, for an Ethernet
component, use eth 0/1. To discover available components, enter
component ? at the prompt.
vlan none Specifies that this MA component is not attached to a virtual local area
network (VLAN).
vlan <vlan id> Specifies to which VLAN this MA component is attached. VLAN IDs range
from 1 to 4094.
Default Values
By default, no component is defined.
Command History
Functional Notes
At least one component must be added to each MA. The components and VLANs are associated so that
the VLANs are protected by the MA to which the component belongs. The first VLAN ID listed is the
primary VLAN ID for the entry being created.
A component must be configured on a VLAN before you can configure its associated
maintenance endpoint (MEP).

Usage Examples
The following example configures an Ethernet component that is associated with vlan 5, and enters the
Component Configuration mode:
(config-ecfm-assoc)#component ethernet 0/1 vlan 5
(config-ecfm-ma-comp)#

mep-validation
Use the mep-validation command to specify whether or not maintenance endpoints (MEPs) use a
comparison between their continuity check message (CCM) database (received CCMs) and their list of
configured remote MEPs (that should be sending CCMs) to generate an alarm when a mismatch is
discovered. The no form of this command disables MEP validation. Variations of this command include:
mep-validation
mep-validation start-delay <delay>
Syntax Description
start-delay <delay> Optional. Specifies a delay (in seconds) that the MEP will wait before
enforcing MEP validation. Delay range is 1 to 65535 seconds.
Default Values
By default, MEP validation is enabled with a delay of 30 seconds.
Command History
Functional Notes
The MEP validation is used to compare an MEP’s list of received CCMs with a list of MEPs that should be
sending CCMs. When MEP validation is enabled, an alarm is sent when a mismatch is discovered. By
default, each MEP validates their MEP list, and all CCMs received must correspond to preconfigured
remote MEPs in the maintenance association (MA).
Disabling validation (using the no form of the command), or changing the start delay, can be useful when
creating a domain association or when troubleshooting. Disabling validation in these circumstances
prevents unnecessary alarms and warnings. For example, if you wish to allow the unit to dynamically learn
its remote MEPs rather than manually entering them, disabling validation allows you to do that without
generating unnecessary alarms.
Usage Examples
The following example disables MEP validation:
(config-ecfm-assoc)#no mep-validation

The following example changes the delay interval to 1000 seconds:
(config-ecfm-assoc)#mep-validation start-delay 1000

remote-mep <mep id>

Use the remote-mep command to create a list of remote maintenance endpoints (MEPs) for this
association. Use the no form of this command to remove the MEP from the list.
Syntax Description
<mep id> Specifies the unique ID given to the MEP. MEP ID range is 1 to 8191.
Default Values
By default, no remote MEPs are listed.
Command History
Functional Notes
Using the remote-mep command populates the maintenance association’s (MA’s) remote MEP list.
Remote MEPs are MEPs not on this device, but communicate with other MEPs in the same MA. Local
MEPs, or those on the same device, are automatically listed.
Each MEP ID is stored and can be compared to the MEP’s continuity check message (CCM) database
learned by listening to CCMs from other MEPs in the network. This allows each MEP to determine if it is
receiving CCMs from expected MEPs, as well as detect any unexpected MEPs in the network.
You will need to repeat this command as many times as necessary to populate the MA’s
remote MEP list with all of the remote MEPs in your network.
Usage Examples
The following example adds the remote MEP with the MEP ID of 1000 to this association’s remote MEP
list:
(config-ecfm-assoc)#remote-mep 1000

mp-sender-id
Use the mp-sender-id command to enable each maintenance endpoint (MEP) in this association to send
sender ID type length values (TLVs) in transmitted packets. Use the no form of this command to revert the
sender ID setting to that of the parent association. Variations of this command include:
mp-sender-id chassis-id
mp-sender-id chassis-id management-address
mp-sender-id management-address
mp-sender-id management-address chassis-id
mp-sender-id none
Syntax Description
chassis-id Specifies that the chassis IDs are transmitted.
management-address Specifies that management addresses are transmitted.
none Specifies that no sender ID is transmitted.
Default Values
By default, the MEP’s sender ID setting is the same as that of the parent association.
Command History
Functional Notes
TLVs are included in continuity check messages (CCMs) and used in Ethernet operations, administration,
and maintenance (OAM) connectivity fault management (CFM) fault detection.
It is important to note how the chassis ID and management address are created for the system. The
chassis ID is created either from Simple Network Management Protocol (SNMP), using the command
snmp-server chassis-id <string> on page 1081, or if SNMP is not configured, using the system medium
access control (MAC) address. The management address is created either from SNMP through the
primary IP of the source interface shown in the command snmp-server source-interface <interface> on
page 1095, or if SNMP is not configured, using the primary IP of the MEP’s interface.
Usage Examples
The following example specifies that MEPs in this association include their chassis ID in the sender ID
TLVs:
(config-ecfm-ma-comp)#mp-sender-id chassis-id
(config-ecfm-ma-comp)#

alarm-priority-level
Use the alarm-priority-level command to configure the lowest level priority condition that generates an
alarm on this maintenance endpoint (MEP). Use the no form of this command to return to the default
priority condition. Variations of this command include:
alarm-priority-level errorccm
alarm-priority-level macstatus
alarm-priority-level none
alarm-priority-level rdi-ccm
alarm-priority-level remoteccm
alarm-priority-level xconccm
Syntax Description
errorccm Specifies that priority conditions of 4 or higher generate alarms.
macstatus Specifies that priority conditions of 2 or higher generate alarms.
none Specifies that no priority conditions generate alarms.
rdi-ccm Specifies that priority conditions of 1 or higher generate alarms.
remoteccm Specifies that priority conditions of 3 or higher generate alarms.
xconccm Specifies that priority conditions of 5 or higher generate alarms.
Default Values
By default, priority conditions of 1 or higher generate alarms.
Command History
Functional Notes
Alarm notifications are sent either by using the AOS event priority system or through Simple Network
Management Protocol (SNMP) notification. The alarms are sent as priority 1 (error), and cleared alarms
are sent as priority 3 (notice). SNMP notification of alarms are sent to the fault alarm address configured
on the MEP reporting the fault. No SNMP notification is sent when an alarm clears. You can specify using
SNMP notification for alarms by using the command snmp-trap fault alarm on page 2490.

The following table describes the five Ethernet OAM CFM defect conditions, as well as the root cause, the
priority, and the importance of each.
Defect Description Cause(s) Priority Importance

DefXconCCM Indicates an MEP that The CCM received is from 5 Highest
could be from another MA an MEP that does not
is sending CCMs to an have a MAID that matches
MEP in this MA. the local MEP’s MAID, or
that the transmitting MEP
has an MD level lower
than the local MEP’s.
DefErrorCCM Indicates erroneous The transmitting MEP’s ID 4

CCMs are being received is not in the MA’s
from some MEP in the configured list of remote
local MEP’s MA. MEPs, the MEP ID is not
the same as the receiving
MEP’s ID, or the CCM
interval does not match
the configured value.
DefRemoteCCM Indicates the local MEP is An MEP in this MEP’s 3

not receiving CCMs from configured list has not
an MEP in its configured sent a CCM in three CCM
list. intervals.
DefMACStatus Indicates the last CCM Either all remote MEPs 2

received by this MEP from are reporting Port Status
another MEP indicated TLV errors, or at least one
the other MEP’s remote MEP is reporting
associated MAC is an Interface Status TLV
reporting an error status error.
via the Port or Interface
Status TLV.
DefRDICCM Indicates the last CCM At least one MEP is 1 Lowest

received by this MEP from reporting RDI.
some remote MEP
contained the remote
defect indication (RDI) bit.
Usage Examples
The following example specifies that events of a priority 3 or higher generate alarms:

(config-eth 0/1-mep)#alarm-priority-level remoteccm
(config-eth 0/1-mep)#

alarm timers <alarm time> <reset time>

Use the alarm timers command to specify the amount of time a defect condition must occur in the
maintenance endpoint (MEP) before it triggers an alarm and how long a defect condition must be absent
before a new alarm can be triggered. Use the no form of this command to set the timers to their default
value.
Syntax Description
<alarm time> Specifies the time that a defect condition must be present before it is eligible
to be reported as an alarm. Range is 2500 to 10000 milliseconds.
<reset time> Specifies the time that defects must be absent before alarms are reset such
that a new alarm can be triggered. Range is 2500 to 10000 milliseconds.
Default Values
By default, the alarm time is 2500 ms and the reset time is 10000 ms.
Command History
Functional Notes
Timer values are stored in 1/1000 of a second. Therefore, entering the command as follows:
alarm timers 2514 10239
stores the timer values as 2510 and 10230.
Defect conditions are the problems detected by Ethernet operations, administration, and maintenance
(OAM) connectivity fault management (CFM). These conditions are detailed in the Functional Notes
section of the alarm-priority-level command. For more information on defect conditions and Ethernet
OAM CFM in general, refer to the Ethernet OAM CFM in AOS configuration guide available on the AOS
Usage Examples
The following example specifies that the alarm time is 3000 ms and the reset time is 6000 ms for this
MEP’s alarm timers:

(config-eth 0/1-mep)#alarm timers 3000 6000

ccm-enabled
Use the ccm-enabled command to enable maintenance endpoint (MEP) continuity check message (CCM)
transmissions. Use the no form of this command to disable CCM transmissions on the MEP.
Syntax Description
No subcommands.
Default Values
By default, CCM transmissions are disabled.
Command History
Functional Notes
Even when CCM transmissions are disabled, the MEP can still process received CCMs.
Usage Examples
The following example enables CCM transmissions on the MEP:

(config-eth 0/1-mep)#ccm-enabled

mep-enabled
Use the mep-enabled command to enable the maintenance endpoint (MEP) and all the MEPs in its
association. Use the no form of this command to halt all associated MEP functionality for this MEP.
Syntax Description
No subcommands.
Default Values
By default, all MEPs are disabled.
Command History
Functional Notes
When an MEP is disabled, no frames are sent or received by the MEP, but all other configuration
properties are retained.
fault management (CFM), refer to the Ethernet OAM CFM in AOS configuration guide available on the
AOS Documentation CD shipped with your product or online at http://kb.adtran.com (article number 3013).
Usage Examples
The following example enables an MEP:

(config-eth 0/1-mep)#mep-enabled

priority <value>
Use the priority command to specify the 802.1p priority given to Ethernet operations, administration, and
maintenance (OAM) connectivity fault management (CFM) frames and linktrace messages transmitted by
the maintenance endpoint (MEP). Use the no form of this command to return the priority to the default
value.
Syntax Description
<value> Specifies the priority. Range is 0 to 7.
Default Values
By default, the priority value is 7.
Command History
Functional Notes
Priority only applies to CFM frames if the MEP’s interface supports virtual local area network (VLAN) tags
and the message will be sent with a tag.
For more information regarding Ethernet OAM CFM, refer to the Ethernet OAM CFM in AOS configuration
guide available on the AOS Documentation CD shipped with your product or online at http://kb.adtran.com
Usage Examples
The following example specifies a priority of 3 for CFM frames and linktrace messages transmitted by this
MEP:

(config-eth 0/1-mep)#priority 3

snmp-trap fault alarm

Use the snmp-trap fault alarm command to configure and send Simple Network Management Protocol
(SNMP) traps for fault alarms generated from a maintenance endpoint (MEP). Use the no form of this
command to disable SNMP fault alarm notification.
Syntax Description
No subcommands.
Default Values
By default, SNMP fault alarm notification is disabled.
Command History
Functional Notes
SNMP notification is an alternate method to configuring and receiving Ethernet operations, administration,
and maintenance (OAM) connectivity fault management (CFM) alarm notifications through the AOS event
priority system. SNMP notifications of alarms are sent to the fault alarm address configured on the MEP
reporting the fault. No SNMP notification is sent when an alarm clears.
For more information regarding Ethernet OAM CFM, refer to the Ethernet OAM CFM in AOS configuration
guide available on the AOS Documentation CD shipped with your product or online at http://kb.adtran.com
Usage Examples
The following example enables SNMP notification for alarm notifications from this MEP:

(config-eth 0/1-mep)#snmp-trap fault alarm

Command Reference Guide Hardware ACL and Access Map Command Set
HARDWARE ACL AND ACCESS MAP COMMAND SET
Hardware access control lists (ACLs) are access lists that function by comparing incoming frames to
specific criteria at the hardware level. These hardware ACLs function in the same way typical IP ACLs do
at the software level. The difference is that hardware ACLs filter incoming traffic through the switch chip
at wire speeds, rather than through software packet filtering processes.
It is beneficial to understand the basic functioning of ACLs in AOS before working with hardware ACLs.
All ACLs, whether hardware or software, by themselves do not perform any action. Rather, they are lists of
criteria to which all incoming frames are compared. These lists provide the methods for many of the
configurable filtering and security features of AOS to logically inspect each frame, compare it to the
criteria in the ACL, and behave accordingly.
ACLs list criteria for incoming frames that begin with either the keyword permit or deny. Permit
indicates that frames matching the specific criteria are selected and handled according to the configuration
of the AOS feature using the ACL. Deny indicates that frames matching the specific criteria are not
selected and are handled accordingly. Each ACL’s criteria are compared to the frame in the order in which
it was entered. This means that the order of criteria for permitting or denying frames is one to one with the
order in which the criteria were entered into the ACL’s configuration. As frames come into the unit, they
are compared to the ACL criteria from top-to-bottom. If a frame does not match the criteria specified by
the first entry, then it is compared to the criteria in the next entry. When the frame is found to match an
entry’s specified criteria, then the frame is either categorized as permit or deny and the comparison of the
ACL entries abruptly stops. At this point, the feature using the ACL takes the appropriate action.
There are many uses for ACLs, and many ways to configure ACLs. If you would like more information
about ACL basic configuration and uses in AOS, refer to the configuration guide Hardware ACLs in AOS
available online at http://kb.adtran.com (article number 3088). Specific commands for configuring ACLs
are also included in this guide in the section Access Control List Command Set on page 2411.
Hardware ACLs and Hardware Access Maps

Hardware ACLs can filter frames based either on IP information or on medium access control (MAC)
address information. IP hardware ACLs support filtering traffic on source and destination IP addresses,
Transmission Control Protocol (TCP) and User Datagram Protocol (UDP), and TCP or UDP port numbers.
MAC hardware ACLs filter traffic based on source and destination MAC addresses. All hardware ACLs
filter only the incoming traffic, comparing the traffic to the list of criteria cited in the ACL.
As with all ACLs, the hardware ACL by itself performs no action. In order for the hardware ACL to
function, a hardware access map must be created and applied to a virtual local area network (VLAN)
interface. Access maps are the feature that uses the ACL and performs the action on the incoming traffic.
Each access map can either forward or discard incoming frames acting on a single IP hardware ACL, a
single MAC hardware ACL, or both. When both an IP and MAC hardware ACL are used by the access
map, the two ACLs are linked by and logic. And logic indicates to the access map that both ACLs must
conclude that the frame be forwarded for the access map to forward it. As with all other ACLs, the
information entered into the hardware ACLs is order dependent. The order in which criteria is listed in the
ACL configuration is the order in which the frames will be compared to the criteria.

Command Reference Guide Hardware ACLs and Hardware Access Maps
Once the access map has been created and associated with a hardware ACL, it must be applied to a virtual
local area network (VLAN) for the ACL to be fully functional. Access maps can be applied to a single
VLAN or a range of VLANs, however, only one access map can be applied to a VLAN at a time.
To create an IP hardware ACL and enter the ACL’s configuration, enter the command ip hw-access-list
extended <name> on page 873 from the Global Configuration mode prompt. For example:
>enable
#configure terminal
Configuring New IP Hardware Extended ACL “Trusted”
(config-ext-ip-hw-nacl)#
To create a MAC hardware ACL and enter the ACL’s configuration, enter the command mac
hw-access-list extended <name> on page 1031 from the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#mac hw-access-list extended Untrusted
Configuring New MAC Hardware Extended ACL “Untrusted”
(config-ext-mac-hw-nacl)#
To create a hardware access map and enter the map’s configuration, enter the command hw-access-map
<name> on page 811 from the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-hw-access-map)#
Technology Review
Hardware access maps and ACLs regulate traffic through the routed network. When designing your traffic
flow configuration, it is important to keep the following in mind:
• A hardware ACL serves as a traffic selector, defining exactly which frames should take the given action.
• A hardware access map defines the action to take on the frames selected by the ACL.
• A hardware ACL is inactive until it is assigned to an active hardware access map.
• A hardware access map is inactive until it is assigned to a VLAN interface.
For more information on both hardware ACLs and hardware access maps, refer to the
Hardware ACLs in AOS configuration guide available on the AOS Documentation CD
shipped with your product or online at http://kb.adtran.com (article number 3088).

The following are commands used to configure an IP hardware ACL. IP hardware ACL configuration
includes creating a remark for the ACL, specifying an ACL action, a protocol, a packet source, a source
port, a packet destination, and a destination port. These commands are described in this section in
alphabetical order:
deny <protocol> <source> <source port> <destination> <destination port> on page 2494
permit <protocol> <source> <source port> <destination> <destination port> on page 2496
remark <text> on page 2498
The following are commands used to configure a MAC hardware ACL. MAC hardware ACL
configuration includes creating a remark for the ACL, specifying the ACL action, a source MAC address,
and a destination MAC address. These commands are described in this section in alphabetical order:
deny mac <source> <destination> on page 2499

permit mac <source> <destination> on page 2501
remark <text> on page 2498
The following are commands used to configure a hardware access map. Access map configuration includes
specifying which hardware ACL(s) the map will use and the relationship between those ACLs, and
applying the access map to a VLAN or VLANs. These commands are described in this section in
alphabetical order:
forward ip <acl name> on page 2503

forward mac <acl name> on page 2505
vlans <vlan id> on page 2507


Use the deny command to configure the IP hardware access control list (ACL) to deny specified packets to
enter the system. Use the no form of this command to remove the deny parameter from the ACL.

deny <protocol> <source> <source port> <destination> <destination port> log
Syntax Description
<protocol> Specifies the data protocol as ip, tcp, or udp.
in one of three ways:
10.10.10.1).
eq <port> Matches only packets equal to the specified
port number. Range is 0 to 65535.
range <min> <max> Matches only packets that contain a port
number in the specified range. Range is 0 to
65535.
expressed in one of three ways:
10.10.10.1).
<destination port> Optional. The destination port is used only when <protocol> is tcp or udp.
The following keywords and port numbers are supported for the
<destination port> field:


65535.
log Optional. Enables logging of any packets that match the hardware ACL
entry. These are the logs that appear in the command debug hw-access-list
<name> on page 217.
Default Values
Command History
Functional Notes
pattern) and allows them to enter the network. A deny ACL advances AOS to the next ACL entry.

Usage Examples
The following example creates an IP hardware ACL Untrusted to deny packets from any source destined
for IP address 192.168.20.0:
(config)#ip hw-access-list extended Untrusted

(config-ext-ip-hw-nacl)#deny ip any host 192.168.20.0
The following example creates an entry in the Untrusted IP hardware ACL that denies any UDP packets
from being forwarded to the UDP ports that range between 1080 and 1150:
(config)#ip hw-access-list extended Untrusted

(config-ext-nacl)#deny udp any any range 1080 1150


Use the permit command to configure the IP hardware access control list (ACL) to permit specified
packets to enter the system. Use the no form of this command to remove the permit parameter from the

permit <protocol> <source> <source port> <destination> <destination port> log
Syntax Description
<protocol> Specifies the data protocol as ip, tcp, or udp.
in one of three ways:
10.10.10.1).
65535.
10.10.10.1).
<destination port> Optional. The destination port is used only when <protocol> is tcp or udp.
The following keywords and port numbers are supported for the
<destination port> field:


65535.
log Optional. Enables logging of any packets that match the hardware ACL
<name> on page 217.
Default Values
Command History
Functional Notes
pattern) and allows them to enter the network. A deny ACL advances AOS to the next ACL entry.

Usage Examples
The following example creates an IP hardware ACL Trusted to permit packets from any source destined
for IP address 192.168.20.0:

(config-ext-ip-hw-nacl)#permit ip any host 192.168.20.0
The following example creates an entry in the Trusted IP hardware ACL that permits any UDP packets to
be forwarded to the UDP ports that range between 1080 and 1150:

(config-ext-nacl)#permit udp any any range 1080 1150

remark <text>
Use the remark command to associate a descriptive tag with a hardware access control list (ACL). Use the
no form of this command to remove the descriptive tag.
Syntax Description
<text> Specifies a descriptive tag for the ACL. Tags can be up to 80 alphanumeric
characters. For example, This list blocks all outbound Web traffic.
Default Values
Command History
Usage Examples
The following example specifies a description for IP hardware ACL Matchall:
(config)#ip hw-access-list extended Matchall

(config-ext-ip-hw-nacl)#remark allows all ip traffic from remote location
The following example specifies a description for medium access control (MAC) hardware ACL Matchall:
(config)#mac hw-access-list extended Matchall

(config-ext-mac-hw-nacl)#remark allows all ip traffic from remote location

deny mac <source> <destination>

Use the deny mac command to configure the medium access control (MAC) hardware access control list
(ACL) to deny specified frames to enter the system. Use the no form of this command to remove the deny
parameters from the ACL. Variations of this command include:
deny mac <source> <destination>

deny mac <source> <destination> log
Syntax Description
<source> Specifies the source used for frame matching. Sources can be expressed in
one of three ways:
1. Using the keyword any to match any MAC address.
2. Using address <mac address> to specify a single host address. IP
example, 08:00:69:02:06:CB).
3. Using the <mac address> <wildcard mask> format to match all IP
<destination> Specifies the destination used for frame matching. Destinations can be
example, 08:00:69:02:06:CB).
log Optional. Enables logging of any frames that match the hardware ACL
<name> on page 217.
Default Values
Command History

Functional Notes
pattern) and allows them to enter the network. A deny ACL advances AOS to the next access list entry.

Usage Examples
The following example specifies that the MAC hardware ACL Untrusted deny traffic from MAC address
08:00:69:02:01:FC with a destination of MAC address 08:00:69:02:06:CB. Traffic that matches this
description will be logged.
(config)#mac hw-access-list extended Untrusted

(config-ext-mac-hw-nacl)#deny address 08:00:69:02:01:FC address 08:00:69:02:06:CB log

permit mac <source> <destination>

Use the permit mac command to configure the medium access control (MAC) hardware access control list
(ACL) to permit specified frames to enter the system. Use the no form of this command to remove the
permit parameters from the ACL. Variations of this command include:
permit mac <source> <destination>

permit mac <source> <destination> log
Syntax Description
<source> Specifies the source used for frame matching. Sources can be expressed in
one of three ways:
example, 08:00:69:02:06:CB).
<destination> Specifies the destination used for frame matching. Destinations can be
example, 08:00:69:02:06:CB).
log Optional. Enables logging of any frames that match the hardware ACL
<name> on page 217.
Default Values
Command History

Functional Notes
pattern) and allows them to enter the network. A deny ACL advances AOS to the next access list entry.

Usage Examples
The following example specifies that the MAC hardware ACL Trusted permit traffic from any MAC address
destined for MAC address 08:00:69:02:06:CB. Traffic that matches this description will be logged.
(config)#mac hw-access-list extended Trusted

(config-ext-mac-hw-nacl)#permit any address 08:00:69:02:06:CB log

forward ip <acl name>

Use the forward ip command to specify which IP hardware access control list (ACL) the hardware access
map will use to determine which frames to forward. Use the no form of this command removes this action
from the access map. Variations of this command include:
forward ip <acl name>

forward ip <acl name> and mac <acl name>
Syntax Description
<acl name> Specifies the hardware ACL the access map will use when determining
which traffic to forward.
mac <acl name> Specifies the medium access control (MAC) hardware ACL that the access
map will use in conjunction with the IP hardware ACL to determine which
traffic to forward.
and Specifies that the relationship between the IP and MAC ACLs is such that
the access map will forward traffic only if both ACLs indicate that it should
be forwarded.
Default Values
Command History
Functional Notes
outlined in a single IP hardware ACL, a single MAC hardware ACL, or both. Like the hardware ACLs, the
hardware access map will match traffic in top-down order. Use the forward ip command if the first criteria
for the access map is to match traffic based on IP information.
Specifying and indicates to the access map that both ACLs must conclude the frame should be forwarded
for the access map to forward it.
Hardware access maps are not active until they are applied to a virtual local area network (VLAN). For
instructions on how to apply an access map to a VLAN, refer to vlans <vlan id> on page 2507.


Usage Examples
In the following example, the access map Map1 is configured to operate on both an IP hardware ACL
(Trusted) and a MAC hardware ACL (Untrusted), specifying that both must agree that a frame should be
forwarded before the access list will forward it.
(config-hw-access-map)#forward ip Trusted and mac Untrusted

forward mac <acl name>

Use the forward mac command to specify which medium access control (MAC) hardware access control
list (ACL) the hardware access map will use to determine which frames to forward. Use the no form of this
command removes this action from the access map. Variations of this command include:
forward mac <acl name>

forward mac <acl name> and ip <acl name>
Syntax Description
<acl name> Specifies the hardware ACL the access map will use when determining
which traffic to forward.
ip <acl name> Specifies the IP hardware ACL that the access map will use in conjunction
with the MAC hardware ACL to determine which traffic to forward.
and Specifies that the relationship between the MAC and IP ACLs is such that
the access map will forward traffic only if both ACLs indicate that it should
be forwarded.
Default Values
Command History
Functional Notes
outlined in a single IP hardware ACL, a single MAC hardware ACL, or both. Like the hardware ACLs, the
hardware access map will match traffic in top-down order. Use the forward mac command if the first
criteria for the access map is to match traffic based on MAC addresses.
Specifying and indicates to the access map that both ACLs must conclude the frame should be forwarded
for the access map to forward it.
Hardware access maps are not active until they are applied to a virtual local area network (VLAN). For
instructions on how to apply an access map to a VLAN, refer to vlans <vlan id> on page 2507.


Usage Examples
In the following example, the access map Map1 is configured to operate on both a MAC hardware ACL
(Trusted) and an IP hardware ACL (Untrusted), specifying that both must agree that a frame should be
forwarded before the access list will forward it.
(config-hw-access-map)#forward mac Trusted and ip Untrusted

vlans <vlan id>

Use the vlans command to apply a hardware access map to a virtual local area network (VLAN) interface.
Access maps can be applied to a single VLAN, a list of VLANs, or a range of VLANs. Use the no form of
this command to remove the access map from the specified VLAN(s).
Syntax Description
<vlan id> Specifies the VLAN(s) to which the access map is applied. Enter the single
VLAN ID for the map to apply to a single VLAN. Enter multiple VLAN IDs
separated by commas to apply the map to a list of VLANs (for example:
1,2,7,9). Enter multiple VLANs separated by dashes or commas to apply
the map to a range of VLANs (for example: 1-5,7-9).
Default Values
By default, access maps are not applied to any VLAN interfaces.
Command History
Functional Notes
Once an access map has been created and associated with a hardware access control list (ACL), it must
be applied to a VLAN for the ACL or access map to be fully functional. Access maps can be applied to a
single VLAN or a range of VLANs, however, only one access map can be applied to a VLAN at a time. If
you attempt to apply a second access map to a VLAN, an error is displayed.

Usage Examples
The following example specifies that the access map Map1, which uses IP hardware ACL Trusted and
MAC hardware ACL Untrusted, is applied to VLANs 1,2, and 15-30.
(config-hw-access-map)#forward ip Trusted and mac Untrusted
(config-hw-access-map)#vlans 1,2,15-30

Command Reference Guide Mail Agent Command Set
MAIL AGENT COMMAND SET
The mail agent feature of ADTRAN Operating System (AOS) provides a method of adding email
notification to any AOS feature. The mail agent is configured through the command line interface (CLI)
and operates with any AOS feature that has configuration or show commands. The mail agent captures
output from specified commands and emails them to a specified address in the body of an email message.
Email messages are created when a specified event occurs, and are mailed on a specified schedule.
Multiple mail agents can be configured and used at one time. For more information about the creation of
mail agents and their capabilities, refer to the Generic Mail Agent quick configuration guide available on
the AOS Documentation CD shipped with your product or online at http://kb.adtran.com (article number
2341).
To activate the Mail Agent Configuration mode, enter the mail-client command at the Global
>enable
#configure terminal
do on page 51
exit on page 53
shutdown on page 61
address on page 2509

body size <bytes> on page 2510
capture commands on page 2511
capture header on page 2512
capture trigger on page 2513
send test on page 2515
send trigger on page 2516
server <dns-name/ip address> on page 2517
subject <text> on page 2518

address
Use the address command to specify the CC, From, and To fields in the email messages. Use the no form
of this command to remove the specified information from the email header. Variations of this command
include:
address cc <email address(es)>

address from <email address(es)>
address to <email address>
Syntax Description
cc <email address(es)> Specifies the CC field in the email message. Multiple email addresses are
separated by semicolons.
from <email address(es)> Specifies the From field in the email message. Multiple email addresses are
separated by semicolons.
to <email address> Specifies the To field in the email message.
Default Values
By default, the CC value is empty. The To default value is set using the command logging email
address-list <email address> ; <email address> on page 1014 and the From default value is set using the
command logging email sender on page 1020.
Command History
Functional Notes
The address to command uses a default value from the command logging email address-list <email
address> ; <email address> on page 1014. If the logging email address-list command has been
configured, and the mail agent notification will go to the same email, using the address to command is not
necessary.
Usage Examples
The following example configures the CC, From, and To fields in the email notification sent by mail agent
myagent:
(config-mail-client-myagent)#address to manager@company.net
(config-mail-client-myagent)#address cc fellowemployee@company.net; assistntmngr@company.net
(config-mail-client-myagent)#address from goodemployee@company.net

body size <bytes>

Use the body size command to set the maximum buffer size for the body text of the email message. Use
Syntax Description
<bytes> Specifies the maximum number of bytes the buffer holds. Range is 1 to
65535 bytes.
Default Values
By default, the buffer size is set to 4048 bytes.
Command History
Functional Notes
All output generated after the buffer size has been reached will be ignored.
Usage Examples
The following example sets the body text buffer size to 6000 bytes for mail agent myagent:
(config-mail-client-myagent)#body size 6000

capture commands
Use the capture commands command to specify the command output to capture and include in the body
of the email. Use the no form of this command to remove the specified commands.
Syntax Description
No subcommands.
Default Values
By default, no commands are specified.
Command History
Functional Notes
The capture commands command specifies the command output to be captured by the mail agent. Show
and tcl commands can be captured. When the capture commands command is entered, each command
to be captured is specified with the do keyword followed by the command. The terminal configuration
mode is enabled by default for the capture commands command, making it necessary to use the keyword
do. List all commands to be sent in a single notification, followed by the exit keyword.
Usage Examples
The following example specifies that the mail agent myagent will capture the output from the show ip
route and show clock commands:
(config-mail-client-myagent)#capture commands
Enter the commands you wish to run, one line at a time.
Entries are run from the terminal configuration prompt.
For example, you must enter ‘do show run’ or ‘int eth 0/1’.
When finished, type ‘exit’ on a new line to end.
#do show ip route
#do show clock
#exit

capture header
Use the capture header command to specify that header information (ASCII demarcation and a
timestamp) is included when command output is captured. Use the no form of this command to remove the
header information from captured command output.
Syntax Description
No subcommands.
Default Values
By default, header information is included in captured command output.
Command History
Usage Examples
The following example removes header information from the captured command output for mail agent
myagent:
(config-mail-client-myagent)#no capture header

capture trigger
Use the capture trigger command to configure the trigger that causes the mail agent to capture the
command output. Use the no form of this command to remove the trigger. Variations of this command
include:
capture trigger
capture trigger track <name> fail
capture trigger track <name> pass
Syntax Description
track <name> fail Optional. Specifies the command output is captured when the named track
changes from a pass state to a fail state.
track <name> pass Optional. Specifies the command output is captured when the named track
changes from a fail state to a pass state.
Default Values
By default, no tracks are configured and no trigger is defined.
Command History
Functional Notes
If no trigger is specified, the mail agent will immediately run the specified commands and capture their
output. If a track is specified as the capture trigger, the command output will be captured every time the
track switches to the specified state. The track used should be a preconfigured track with an associated
schedule. The track will change states when its associated schedule becomes active or inactive. For more
information on schedules, refer to schedule <name> on page 1077. For more information on tracks, refer
to the Network Monitor Track Command Set on page 2356 of this guide. For more information on the
functions of tracks and schedules as part of the mail agent feature, refer to the Generic Mail Agent quick
The command send trigger on page 2516 can be used without the capture trigger command. If only the
send trigger command is used, the send trigger command will function as the capture trigger command
and immediately capture the command output and send an email of the captured output. If both commands
are used, the command output is captured at the time the capture trigger occurs, and then an email is sent
at the time the send trigger occurs.

Usage Examples
The following example specifies that when the track mail changes to a pass state, the mail agent
myagent will capture command output:
(config-mail-client-myagent)#capture trigger track mail pass

send test
Use the send test command to have the mail agent send a test email message to the email address(es)
specified by the address to command (refer to address on page 2509) or the logging email address-list
command (refer to logging email address-list <email address> ; <email address> on page 1014).
Syntax Description
No subcommands.
Default Values
By default, the test email is sent using your Simple Mail Transfer Protocol (SMTP) settings even if the mail
client is currently shut down.
Command History
Functional Notes
The command appends “This is a test message” onto the current message buffer and sends an email to
the configured addresses. This command is used to test that the agent is sending emails to the proper
addresses.
Usage Examples
The following example instructs mail agent myagent to send a test email to the previously configured
email addresses:
(config-mail-client-myagent)#send test

send trigger
Use the send trigger command to configure when an email with command output is sent to the email
address(es) specified by the address to command (refer to address on page 2509) or the logging email
address-list command (refer to logging email address-list <email address> ; <email address> on page
1014). Use the no form of this command to remove the configuration. Variations of this command include:
send trigger
send trigger track <name> fail
send trigger track <name> pass
Syntax Description
track <name> fail Optional. Specifies the email message is sent when the named track
changes from a pass state to a fail state.
track <name> pass Optional. Specifies the email message is sent when the named track
changes from a fail state to a pass state.
Default Values
By default, no email is sent.
Command History
Functional Notes
If no trigger is specified, the mail agent will immediately send the email. If a track is specified as the send
trigger, the email will be sent every time the track switches to the specified state. The track used should be
a preconfigured track with an associated schedule. The track will change states when its associated
schedule becomes active or inactive. For more information on schedules, refer to the command schedule
<name> on page 1077. For more information on tracks, refer to the Network Monitor Track Command Set
on page 2356 of this guide. For more information on the functions of tracks and schedules as part of the
mail agent feature, refer to the Generic Mail Agent quick configuration guide available on the AOS
The send trigger command can be used without the capture trigger command (refer to capture trigger on
page 2513). If only the send trigger command is used, the send trigger command will function as the
capture trigger command and immediately capture the command output and send an email of the
captured output. If both commands are used, the command output is captured at the time the capture
trigger occurs, and then an email is sent at the time the send trigger occurs.
Usage Examples
The following example specifies when the track named sendmail changes to a fail state, mail agent
myagent will send an email with captured command output:
(config-mail-client-myagent)#send trigger track sendmail fail

server <dns-name/ip address>

Use the server command to specify the Simple Mail Transfer Protocol (SMTP) server for sending mail
agent notifications. Use the no form of this command to return the server setup to the default value.
Syntax Description
<dns-name> Specifies the domain naming system (DNS) name of the SMTP server.
<ip address> Specifies the IP address of the SMTP server. IP addresses are expressed in
Default Values
By default, the SMTP server is set to the value defined by the command logging email receiver-ip <ip
address | hostname> on page 1019.
Command History
Usage Examples
The following example specifies that mail agent myagent use the SMTP server at IP address 172.5.67.99
to send email messages:
(config-mail-client-myagent)#server 172.5.67.99

subject <text>
Use the subject command to specify the Subject field in the mail agent email message. Use the no form of
this command to clear the Subject field.
Syntax Description
<text> Specifies the text of the Subject field.
Default Values
By default, this field is empty.
Command History
Usage Examples
The following example specifies a Subject of report1 for the email message sent my mail agent myagent:
(config-mail-client-myagent)#subject report1

Command Reference Guide MGCP Command Set
MGCP COMMAND SET
Media Gateway Control Protocol (MGCP) is a protocol that works hand-in-hand with H.323 and Session
Initiation Protocol (SIP) in Voice over Internet Protocol (VoIP) services. MGCP works between a call
agent or media gateway controller, usually a software switch, and a media gateway with internal endpoints.
The call agents create and manage media sessions with endpoints of physical or virtual data sources
through the media gateway. The media gateway is the network device that converts voice signals carried
by telephone lines into data packets carried over the Internet or other packet networks. In this network
structure, AOS products function as a media gateway.
To enable MGCP functionality, enter the ip mgcp command from the Global Configuration mode prompt
as follows:
>enable
#configure terminal
(config)#ip mgcp
(config)#
MGCP gateways communicate with internal MGCP endpoints. MGCP endpoints are dedicated foreign
exchange station (FXS) ports configured to use MGCP to communicate with a call agent. The endpoints
are configured with a few specialized MGCP commands and a large number of commands that are similar
to those used for voice user configuration.
To create an MGCP endpoint and access its configuration, enter the voice mgcp-endpoint <index>
command from the Global Configuration mode prompt as follows:
>enable
#configure terminal
(config-mgcp-1)#
The following configuration command set describes commands associated with configuring MGCP
endpoints. For more information about MGCP gateway and endpoint configuration, refer to the MGCP in
AOS configuration guide available on the AOS Documentation CD shipped with your product or online at
exit on page 53

The following commands are MGCP endpoint configuration commands listed in alphabetical order:
alc on page 2521

block-caller-id on page 2522
codec-group <name> on page 2523
connect fxs <slot/port> on page 2524
echo-cancellation on page 2526
fwd-disconnect delay on page 2527
modem-passthrough on page 2528
name <text> on page 2529
nls on page 2530
plc on page 2531
rtp delay-mode on page 2532
rtp dtmf-relay on page 2533
rtp frame-packetization <value> on page 2534
rtp packet-delay on page 2535
rtp qos dscp <value> on page 2536
t38 on page 2537
t38 error-correction on page 2538
t38 fallback-mode g711 on page 2539
t38 max-buffer <value> on page 2540
t38 max-datagram <value> on page 2541
t38 max-rate on page 2542
t38 redundancy on page 2543
vad on page 2544

alc
Use the alc command to enable automatic level control (ALC). ALC reduces Realtime Transport Protocol
(RTP) received signals that are out of specification to the predefined levels. It is not necessary to enable
ALC on those networks that guarantee signal levels to be within specification. Use the no form of this
alc
alc level -16
alc level -17
alc level -18
alc level -19
alc level -20
alc level -21
alc level -22
Syntax Description
level -16 Optional. Specifies the ALC attenuation level is -16 dBm0.
Default Values
By default, ALC is disabled.
Command History
Release 15.1 Command was added to the Voice Line Interface.
Release A2 Command was added to the Media Gateway Control Protocol (MGCP)
endpoint configuration.
Release A2.04 Command was expanded to include the level parameters.
Usage Examples
The following example activates the ALC for MGCP endpoint 1:
(config-mgcp-1)#alc

block-caller-id
Use the block-caller-id command to block caller ID information included in Media Gateway Control
Protocol (MGCP) signaling on the endpoint. Use the no form of this command to allow caller ID
information to appear.
Syntax Description
No subcommands.
Default Values
By default, caller ID information is allowed.
Command History
Release A2 Command was added to the MGCP endpoint configuration.
Usage Examples
The following example enables caller ID information blocking on MGCP endpoint 1:
(config-mgcp-1)#block-caller-id

codec-group <name>
Use the codec-group command to specify the coder-decoder (CODEC) list to be used by this account. Use
the no form of this command to remove the CODEC list from the account.
Syntax Description
<name> Specifies the CODEC list to be used for this account.
Default Values
By default, no CODEC lists are assigned.
Command History
Release 11.1 Command was expanded to include the integrated services digital network
(ISDN) trunk.
Release 15.1 Command was added to the Voice Line Configuration command set.
Release A1 Command was included in the Voice Loopback Account Configuration
command set.
Configuration command set.
Functional Notes
The codec-group command applies a previously configured CODEC list to an interface, voice trunk, or
voice account. These lists are lists of CODECs used by the interface, trunk, or account in call negotiation,
and are arranged in preferred order with the first listed CODEC being the most preferred.
CODEC lists are created using the codec command from the Voice CODEC List Configuration mode
prompt. For more information about creating CODEC lists, refer to the Voice CODEC List Command Set
on page 2955.
Usage Examples
The following example applies the CODEC list List1 to the MGCP endpoint 1:
(config-mgcp-1)#codec-group List1

connect fxs <slot/port>

Use the connect fxs command to connect a Media Gateway Control Protocol (MGCP) endpoint to a
physical foreign exchange station (FXS) port. Use the no form of this command to disconnect from the
physical FXS port and reconnect to the virtual port.
Syntax Description
<slot/port> Specifies the slot and port to which the MGCP endpoint will connect. Slots
and ports are entered as follows: 0/1.
Default Values
By default, the endpoint is connected to a virtual port.
Command History
Functional Notes
This command fails if the specified FXS port is already in use on another MGCP endpoint or by a
configured voice user.
Usage Examples
The following example connects MGCP endpoint 1 to the physical FXS port 0/1:
(config-mgcp-1)#connect fxs 0/1

description <text>
Use the description command to give a textual description to a Media Gateway Control Protocol (MGCP)
endpoint. Use the no form of this command to remove the endpoint’s description.
Syntax Description
<text> Specifies the textual description of the endpoint.
Default Values
By default, no description is given to an endpoint.
Command History
Usage Examples
The following example gives the description of farendpoint to MGCP endpoint 1:
(config)#voice mgcp-endpoint1
(config-mgcp-1)#description farendpoint

echo-cancellation
Use the echo-cancellation command to improve voice quality for packetized-based voice calls, such as
Voice over Internet Protocol (VoIP) or Media Gateway Control Protocol (MGCP). Use the no form of this
Syntax Description
No subcommands.
Default Values
By default, echo-cancellation is enabled.
Command History
Usage Examples
The following example activates echo-cancellation for MGCP endpoint 1:
(config-mgcp-1)#echo-cancellation

fwd-disconnect delay
Use the fwd-disconnect delay command to modify the forward disconnect delay time (in milliseconds) for
the Media Gateway Control Protocol (MGCP) endpoint. Use the no form of this command to return the
delay period to the default value. Variations of this command include:
fwd-disconnect delay 250

fwd-disconnect delay follow-switch
Syntax Description
250 Specifies a 250 ms delay time.
follow-switch Specifies a delay time follows the switch.
Default Values
By default, the forward disconnect delay is set to follow the switch.
Command History
Functional Notes
Although the MGCP endpoint forward disconnect delay is set to follow the switch by default, this delay time
varies depending on the endpoint’s RFC 2833 signaling specification. If the RFC 2833 signaling is
enabled, then the follow-switch parameter indicates that the Class 5 switch determines the length of the
delay time. If RFC 2833 signaling is disabled, then using follow-switch indicates that the battery is
removed for the default time of 900 ms.
Usage Examples
The following example specifies the forward disconnect delay for MGCP endpoint 1 is 1000 ms:
(config-mgcp-1)#fwd-disconnect delay 1000

modem-passthrough
Use the modem-passthrough command to switch to passthrough mode on fax or modem tone detection.
This command allows modem and fax calls to maintain a connection without altering the signals with the
voice improvement settings, such as echo cancellation and voice activity detection (VAD). Use the no form
Syntax Description
No subcommands.
Default Values
By default, modem-passthrough is enabled.
Command History
Usage Examples
The following example disables modem-passthrough on MGCP endpoint 1:
(config-mgcp-1)#no modem-passthrough

name <text>
Use the name command to specify a textual name that the Media Gateway Control Protocol (MGCP) call
agent will use to refer to a specific endpoint. Use the no form of this command to return to the default
naming convention.
Syntax Description
<text> Specifies the textual name of the MGCP endpoint.
Default Values
By default, when endpoints are created and given an index number, they are named in the following
format: aaln/x, where x is the index number. For example, an endpoint with an index of 4 will by default
have the name aaln/4.
Command History
Usage Examples
The following example renames endpoint 1 as endpoint243:
(config-mgcp-1)#name endpoint243

nls
Use the nls command to enable the non-linear suppression (NLS) option for the Media Gateway Control
Protocol (MGCP) endpoint. This option sets the echo canceller to reduce acoustic echo. Use the no form of
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables NLS for MGCP endpoint 1:
(config-mgcp-1)#nls

plc
Use the plc command to enable packet loss concealment (PLC). PLC is used to prevent choppy
connections by concealing a packet loss by replacing the lost packet with another voice packet in the data
stream. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, PLC is enabled.
Command History
Usage Examples
The following example disables PLC for the MGCP endpoint 1:
(config-mgcp-1)#no plc

rtp delay-mode
Use the rtp delay-mode command to configure the Realtime Transport Protocol (RTP) jitter buffer packet
delay mode settings. RTP is used to prevent static on voice connections by enhancing the quality of the
packet delivery. Use the no form of this command to return to the default setting. Variations of this
command include:
rtp delay-mode adaptive

rtp delay-mode fixed
Syntax Description
adaptive Configures the RTP jitter buffer packet delay to adjust during a call based
on network conditions.
fixed Configures the RTP jitter buffer packet delay to remain constant.
Default Values
By default, the RTP delay mode is set to adaptive. This allows for minimal latency by adjusting the
average packet delay based on the conditions of the network.
Command History
Usage Examples
The following example configures RTP delay mode as fixed on MGCP endpoint 1:
(config-mgcp-1)#rtp delay-mode fixed

rtp dtmf-relay
Use the rtp dtmf-relay command to configure the method by which Realtime Transport Protocol (RTP)
dual tone multi-frequency (DTMF) events are relayed. The dial digits can be sent inband or out-of-band
(OOB) of the voice stream. Use the no form of this command to return to the default value. Variations of
rtp dtmf-relay inband

rtp dtmf-relay nte <value>
Syntax Description
inband Specifies that RTP DTMF events be relayed inband in the RTP stream.
nte <value> Specifies that RTP DTMF events be relayed OOB using named telephone
events (NTEs). Enter an NTE value between 96 and 127.
Default Values
By default, the rtp dtmf-relay is set for NTE 101.
Command History
Usage Examples
The following example configures RTP DTMF relay events for inband:
(config-mgcp-1)#rtp dtmf-relay inband

rtp frame-packetization <value>

Use the rtp frame-packetization command to configure the Realtime Transport Protocol (RTP) frame
packetization time in milliseconds for individual Media Gateway Control Protocol (MGCP) endpoints.
Syntax Description
<value> Configures the RTP frame packetization time value in milliseconds. Select
from 10, 20, or 30 milliseconds.
Default Values
By default, the rtp frame-packetization time is set to 20 milliseconds on all MGCP endpoints.
Command History
Usage Examples
The following example sets the frame packetization time for MGCP endpoint 1 to 10 milliseconds:
(config-mgcp-1)#rtp frame-packetization 10

rtp packet-delay
Use the rtp packet-delay command to configure the maximum Realtime Transport Protocol (RTP) packet
delays. This command is used to set the allowable limits of latency on the network. Use the no form of this
rtp packet-delay fax <value>

rtp packet-delay maximum <value>
rtp packet-delay nominal <value>
Syntax Description
fax <value> Sets the fax delay time value in increments of 10 milliseconds. Range is
maximum <value> Sets the maximum delay time value in increments of 10 milliseconds.
Range is 40 to 320 milliseconds.
nominal <value> Sets the nominal delay time value in increments of 10 milliseconds. Range
Default Values
By default, the RTP packet delay for fax is 50, maximum is 100, and for nominal is 50.
Command History
Usage Examples
The following example configures the RTP maximum delay time on MGCP endpoint 1 to 200 milliseconds:
(config-mgcp-1)#rtp packet-delay maximum 200

rtp qos dscp <value>

Use the rtp qos dscp command to configure the maximum Realtime Transport Protocol (RTP) quality of
service (QoS) parameters for differentiated services code point (DSCP). Use the no form of this command
Syntax Description
<value> Configures the RTP QoS parameter for DSCP. Enter a value between
10 and 63.
Default Values
By default, the RTP QoS parameter for DSCP on Media Gateway Control Protocol (MGCP) endpoints is
46.
Command History
Usage Examples
The following example configures the RTP QoS DSCP for MGCP endpoint 1 to 60:
(config-mgcp-1)#rtp qos dscp 60

t38
Use the t38 command to enable T.38 fax operation on the Media Gateway Control Protocol (MGCP)
endpoint. Use the no form of this command to disable this feature.
The modem-passthrough command must be enabled for T.38 operation to work. Refer to
modem-passthrough on page 2528 for more information.
Syntax Description
No subcommands.
Default Values
By default, T.38 is disabled.
Command History
Usage Examples
The following example enables T.38 on MGCP endpoint 1:
(config-mgcp-1)#t38
Technology Review
T.38 is an International Telecommunication Union (ITU) specification that allows Group-3 Fax (T.30) data to
be transported over the Internet. It is similar to dual tone multi-frequency (DTMF) relay (RFC 2833) in that
the digital signal processor (DSP) decodes tones and demodulated fax data and converts them into
packets. A similar device on the other end takes the packets/tones and remodulates them so that an
analog fax machine on the other end can receive the fax. AOS’s previous support (revisions 12 through 15)
for fax/modem signals was simply detecting a tone and forcing the coder-decoder (CODEC) into G.711 and
disabling/enabling echo cancellers based on the tones detected. When packet loss becomes high, sending
faxes over G.711 becomes problematic, due to dropped messages and timeouts/retrains.
T.38 can be used in conjunction with various call-control schemes, such as H.323, Session Initiation
Protocol (SIP), and MGCP. AOS only supports SIP as the call-control method. This is typically referred to
T.38/Annex-D. Annex-D describes the Session Initiation Protocol/Session Description Protocol (SIP/SDP)
call establishment procedures.

t38 error-correction
Use the t38 error-correction command to specify the type of fax error correction. Use the no form of this
t38 error-correction fec

t38 error-correction redundancy
Syntax Description
fec Specifies forward error correction (FEC) as the fax error correction. FEC is
a system of error control where the sender adds redundant data to its
messages, allowing the receiver to detect and correct errors (within certain
bounds) without the need to request additional data from the sender.
redundancy Specifies redundancy as the fax error correction. Redundancy error
correction replicates the payload a user-specified number of times to
determine if errors are present. The number of redundant packets is set
using the command t38 redundancy on page 2543.
Default Values
By default, t38 error-correction is set to fec for Media Gateway Control Protocol (MGCP) endpoints.
Command History
Usage Examples
The following example sets the t38 error-correction to redundancy on MGCP endpoint 1:
(config-mgcp-1)#t38 error-correction redundancy

t38 fallback-mode g711

Use the t38 fallback-mode command to specify the transmission mode used when T.38 fax relay cannot
be successfully negotiated at the time of the fax transfer. Use the no form of this command to disable this
feature.
Syntax Description
g711 Specifies that fax operation revert back to analog mode (G.711).
Default Values
By default, t38 fallback-mode is disabled.
Command History
Usage Examples
The following example enables the t38 fallback-mode on MGCP endpoint 1:
(config-mgcp-1)#t38 fallback-mode g711

t38 max-buffer <value>

Use the t38 max-buffer command to set the maximum buffer size for T.38 fax operation on Media
Gateway Control Protocol (MGCP) endpoints. Use the no form of this command to return to the default
value.
Syntax Description
<value> Specifies the value of the max-buffer attribute in the Session Description
Protocol (SDP) offer when the T.38 session is initiated. Range is 0 to
400 bytes.
Default Values
By default, the maximum buffer size is set to 200.
Command History
Usage Examples
The following example sets the t38 max-buffer to 100 on MGCP endpoint 1:
(config-mgcp-1)#t38 max-buffer 100

t38 max-datagram <value>

Use the t38 max-datagram command to set the maximum datagram value in the Media Gateway Control
Protocol (MGCP) endpoint. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the value of the max-datagram attribute in the Session Description
300 bytes.
Default Values
By default, the maximum datagram value is set to 75.
Command History
Usage Examples
The following example sets the t38 max-datagram to 100 on MGCP endpoint 1:
(config-mgcp-1)#t38 max-datagram 100

t38 max-rate
Use the t38 max-rate command to specify the fax maximum rate for Media Gateway Control Protocol
(MGCP) endpoints. The actual transmission rate may be lower than specified rate if the receiving end
cannot support the maximum rate. Use the no form of this command to return to the default value.
t38 max-rate 14400

t38 max-rate 12000
t38 max-rate 2400
t38 max-rate 4800
t38 max-rate 7200
t38 max-rate 9600
Syntax Description
14400 Specifies 14400 baud/bits as fax maximum rate.
Default Values
By default, the maximum fax rate is set to 14400.
Command History
Usage Examples
The following example sets the t38 max-rate to 4800 on MGCP endpoint 1:
(config-mgcp-1)#t38 max-rate 4800

t38 redundancy
Use the t38 redundancy command to set the number of redundant packets sent when the t38
error-correction redundancy feature is enabled on Media Gateway Control Protocol (MGCP) endpoints.
t38 redundancy high-speed <value>

t38 redundancy low-speed <value>
Syntax Description
high-speed <value> Specifies the number of redundant T.38 fax packets to be sent for data
messages (high-speed fax machine image data). Range is 0 (no
redundancy) to 4 packets.
low-speed <value> Specifies the number of redundant T.38 fax packets to be sent for the
signaling messages (low-speed fax machine protocol). Range is 0 (no
Default Values
By default, high-speed and low-speed redundancy values are set to 0 (no redundancy).
Command History
Usage Examples
The following example enables t38 error-correction redundancy and sets the number of redundant data
messages to high-speed 3 on MGCP endpoint 1:
(config-mgcp-1)#t38 error-correction redundancy
(config-mgcp-1)#t38 redundancy high-speed 3

vad
Use the vad command to enable voice activity detection (VAD) on Media Gateway Control Protocol
(MGCP) endpoints. VAD blocks out noise categorized as silence during a voice connection. The silent
voice packets are not transmitted, allowing bandwidth usage to be reduced. Although VAD saves
bandwidth, the quality of the voice call may be compromised. Use the no form of this command to disable
this feature.
Syntax Description
No subcommands.
Default Values
By default, VAD is enabled for all MGCP endpoints.
Command History
Usage Examples
The following example disables VAD on MGCP endpoint 1:
(config-mgcp-1)#no vad

Command Reference Guide Quality of Service Map Command Set
QUALITY OF SERVICE MAP COMMAND SET
A quality of service (QoS) policy is defined using a QoS map in the ADTRAN Operating System (AOS)
command line interface (CLI). The QoS map is a named list with sequenced entries. An entry contains a
single match reference and one or more actions. To activate the QoS command set (which allows you to
create and/or edit a map), enter a valid version of the qos map command at the Global Configuration mode
prompt. Multiple map entries for the same QoS map are differentiated by a sequence number. The
sequence number is used to assign match order.
Once created, a QoS map must be applied to an interface (using the qos-policy command from the desired
interface command set) in order to actively process traffic. Any traffic for the interface that does not
explicitly match a map entry is sent using the default queuing method for the interface (such as weighted
fair queuing (WFQ)). For example:
>enable
#config terminal
(config-qos-map)#exit
(config)#interface fr 1
do on page 51
end on page 52
exit on page 53
bandwidth on page 2546

match on page 2549
match dscp on page 2553
match precedence <value> on page 2557
priority on page 2559
qos-policy <map name> on page 2562
set cos <value> on page 2564
set dscp on page 2565
set precedence <value> on page 2567
shape average on page 2568

bandwidth
Use the bandwidth command to specify bandwidth allocation for individual traffic classes for class-based
weighted fair queuing (CBWFQ) configurations. Use the no form of this command to remove a configured
bandwidth allocation. Variations of this command include:
bandwidth <rate>
bandwidth <rate> Kbps
bandwidth <rate> Mbps
bandwidth percent <value>
bandwidth remaining percent <value>
Syntax Description
<rate> Allocates the minimum bandwidth for a traffic class, specifying the minimum
as an absolute bandwidth in kilobits per second (kbps). Range is 8 to
2000000 kbps.
Kbps Optional. Indicates the rate specified is in kbps.
Mbps Optional. Indicates the rate specified is in megabits per second (Mbps).
percent <value> Allocates a minimum bandwidth for a traffic class, specifying the minimum
as a percentage of the total interface bandwidth. Refer to Functional Notes
below for more details.
remaining percent <value> Allocates a minimum bandwidth for a traffic class, specifying the minimum
as a percentage of the total interface bandwidth not allocated to priority
classes in the quality of service (QoS) map. Refer to Functional Notes
below for more details.
Default Values
By default, there is no bandwidth allocation configured for a QoS map entry. The bandwidth rate is
assumed to be provided in Kbps unless Mbps is specified.
Command History
Release 17.5 Command was expanded to allow specifying the rate in kbps and Mbps.
Functional Notes
When configuring bandwidth allocations for CBWFQ, there are a few rules that must be obeyed.
1. The units of the bandwidth (Kbps, Mbps, percent, or remaining percent) must be consistent for
all class-based entries (using the bandwidth command) in a QoS map set.
2. The total bandwidth between all priority entries (priority command) and class-based entries
(bandwidth command) in a QoS map set should not be configured beyond the specified
max-reserved-bandwidth (default 75 percent) on the interface to which the QoS policy is
applied (using the qos-policy command), or the map will be disabled. In a QoS map, even

though limits are defined regarding consumption of bandwidth by traffic, traffic can burst up to
the maximum interface rate when the output queue is not in a congested state. Qos maps are
constantly classifying traffic when they are active on an interface, but some of their actions
depend on the state of the output queue. When congestion is present, policies defined with the
bandwidth command will be limited to the minimum value specified, with excess traffic being
queued. During a congested state, policies defined with the priority command will be limited to
the maximum value specified, with excess traffic being dropped. Policies defined with the
shape or set commands are always enforced regardless of congestion.
When the configured QoS map is applied to a physical interface, AOS displays bandwidth infor-
mation for the map and the physical interface. For example, if the Frame Relay interface (fr 1)
has been connected to the E1 interface (e1 1/1) using the cross-connect command, applying
the QoS map (MyMapA) to the Frame Relay interface (fr 1) produces the following status mes-
sage:
2005.08.09 07:28:22 QOS.INTERFACE QOS policy “MyMapA” requires 1288 kbps of bandwidth and
1488 kbps is now available for interface fr 1 -> the QOS policy for this port has been forced ACTIVE.
This status message displays the total of the bandwidths specified in the QoS map (1288 kbps) and
the available interface bandwidth using the total line rate configured on the interface (1488 kbps).
3. Up to five class-based entries (bandwidth commands) can be configured in a particular QoS

map set.
4. Within a QoS map entry, CBWFQ bandwidth and low latency priority actions are mutually
exclusive. However, bandwidth and priority actions may be applied to different entries in the
same QoS map.
Determining Bandwidth Entries
When possible, use the bandwidth <value> command to specify an absolute amount of
bandwidth (in kbps) for the traffic class.
When determining the percent <value> entry, use the following formula:
Bandwidth
x 100
[(max-reserved-bandwidth)(Line Rate)]
where
Bandwidth Specifies the minimum amount of bandwidth needed for the traffic (in kbps).
max-reserved-bandwidth Specifies the percentage of the total line rate available for use by QoS.
Line Rate Specifies the total data rate configured on the interface (for example,
8 DS0s (64 kbps per DS0) on a T1 equals a line rate of 512 kbps).
For example, to specify 80 kbps of data on an interface with a total of 512 kbps of available bandwidth, and
reserving 5 percent of the bandwidth for routing and L2 protocol traffic (max-reserved-bandwidth = 95)
enter the following command:
(config-qos-map 1)#bandwidth percent 15

When determining the remaining percent <value> entry, use the following formula:
Bandwidth
x 100
[(max-reserved-bandwidth)(Line Rate)] - Priority Traffic
where
Priority Traffic Specifies the amount of bandwidth reserved using the priority command.
For example, to specify 80 kbps of data on an interface with a total of 512 kbps of available bandwidth,
256 kbps reserved (using the priority command), and reserving 15 percent of the bandwidth for routing
and L2 protocol traffic (max-reserved-bandwidth = 85) enter the following command:
(config-qos-map 1)#bandwidth remaining percent 45
Usage Examples
The following example creates a QoS map with four traffic classes (based on IP packet precedence
values) and allocates bandwidth to each class:
(config)#qos map MyMap 1

(config-qos-map)#bandwidth percent 25




match
Use the match command to specify which traffic should be processed by this quality of service (QoS) map
entry. Use the no form of this command to discontinue matching. Variations of this command include:
match any
match fr-dlci <number>
match ip rtp <port>
match ip rtp <begin port range> <end port range>
match ip rtp <begin port range> <end port range> all
match list <name>
match protocol bridge
match protocol bridge netbeui
match vlan <id>
Syntax Description
any Match all packets within a QoS map entry that were not
matched in previous map entries. Since map entries are
processed in the order of their sequence numbers, the
match any command can be used to process all packets not
previously matched by a map entry if it is specified as the last
QoS map entry.
fr-dlci <number> Match all packets by the specified Frame Relay data link
connection identifier (DLCI). Indicate the valid DLCI number
from 16 to 1007.
ip rtp <port> Matches Realtime Transport Protocol (RTP) packets with the
specified User Datagram Protocol (UDP) destination port.
ip rtp <begin port range> <end port range> Matches RTP packets with even UDP destination port
numbers in the specified range.
all Optional. Specifies matching all UDP port numbers in
the specified range (even and odd). Valid only for ip
rtp matches.
list <name> Specifies the name of the access control list (ACL) you want
to use to match packets for this QoS map. Refer to ip
access-list extended <name> on page 815 for more
information on creating ACLs.
protocol bridge Matches frames being bridged by the router.
protocol bridge netbeui Matches only network basic input/output system (NetBIOS)
extended user interface (NetBEUI) frames being bridged by
the router.
vlan <id> Match packets associated with a particular virtual local area
network (VLAN). Indicate the VLAN ID number from
1 to 4095.

Default Values
Command History
Release 17.2 Command was expanded to include the any and vlan <id> options.
Release 17.5 Command was expanded to include the fr-dlci <number> parameter.
Functional Notes
QoS policies are configured in the ADTRAN Operating System (AOS) command line interface (CLI) to
dictate the priority for servicing specified traffic types on a particular interface. QoS policies contain at least
one match reference (using the match command) and one or more action items (using the priority,
bandwidth, shape average, or set commands).
The match command specifies the criteria used when determining whether incoming traffic is a candidate
for the QoS policy action. Multiple match statements can exist within the same QoS policy, allowing a
single QoS policy to service various types of traffic. You can require all of the multiple conditions be met
(AND logic) by including the match-all parameter when creating the QoS policy. Alternatively, you can
choose to include traffic meeting any of the conditions (OR logic) by using the match-any parameter when
creating the QoS policy. Both of these conditions are explained in qos map <name> <number> on page
1061.
Each listed match statement is handled independently by the processor. Entering too many
match statements in a QoS policy can burden the processor.
For example, consider a network that contains Class A and Class B traffic that each require 25 percent of
the total allocated interface bandwidth, the following configuration would be appropriate:

(config-qos-map)#match list Class_A

(config-qos-map)#match list Class_B

In this example, the combination of both classes will not exceed 25 percent of the total allocated interface
bandwidth. Class A and Class B will share the 25 percent allocation between them. Since there are two
match statements in this QoS map entry, traffic can match either ACL Class_A or Class_B to be
processed. By default, this example assumes the match-any logic is being applied since it is not
specifically configured:

(config-qos-map)#match list Class_A
(config-qos-map)#match list Class_B
To remove a configured match statement, enter the entire match statement with a preceding no. For
example, to remove the match statements from the above configured QoS map:

(config-qos-map)#no match list Class_A
and

(config-qos-map)#no match list Class_B
Usage Examples
The following example configures QoS for a network with the following needs:
Reserve 15 percent of the line rate for routing traffic and L2 protocol traffic (max-reserved-bandwidth =
85)
Line Rate = 512 kbps

Guaranteed 256 kbps for Voice
Guaranteed 96 kbps for Class 1
To configure this QoS policy, enter the following QoS map and interface commands:
1. Allocate low latency queuing (LLQ) priority voice traffic.

(config-qos-map)#match list VOICE
2. Allocate the class-based weighted fair queuing (CBWFQ) data traffic bandwidth for Classes 1 and 2.

(config-qos-map)#match list CLASS_1
(config-qos-map)#bandwidth 96


3. Specify the reserved bandwidth on the appropriate interface and apply the map.
(config-fr 1)#qos-policy out MyMap

match dscp
Use the match dscp command to specify which traffic should be processed by this quality of service (QoS)
map based on the differentiated services code point (DSCP) value in the IP header of the packet. Up to
eight DSCP values or identifiers, separated by a space, may be specified in a match dscp command.
Traffic matching any one of the DSCP values qualifies as a match for the given map entry. Use the no form
of this command to discontinue matching. Variations of this command include:
match dscp <value>

match dscp <value> afxx
match dscp <value> csx
match dscp afxx
match dscp csx
match dscp default
match dscp ef
Syntax Description
<value> Specifies the DSCP numeric value. Valid range is 0 to 63.
afxx Specifies the assured forwarding (AF) class and subclass. Select from:
11 (001010), 12 (001100), 13 (001110), 21 (010010), 22 (010100),
23 (010110), 31 (011010), 32 (011100), 33 (011110), 41 (100010),
42 (100100), or 43 (100110). Up to 8 DSCP values or identifiers may be
specified.
csx Specifies the class selector (CS) value. Valid range is 1 to 7. Up to 8 DSCP
values or identifiers may be specified.
default Specifies the default IP DSCP value (000000).
ef Specifies marking for expedited forwarding (EF).
Default Values
Command History
Usage Examples
The following example instructs the QoS map named MyMap to match the IP header with a DSCP AF
Class 1, Subclass 2 (af12):

(config-qos-map)#match ip dscp af12

Technology Review
The DSCP model was created in RFC 2474 and 2475 to build on the original type of service (ToS) field by
creating a 6-bit sequence (combining the precedence value with the delay, throughput, and reliability bits).
This 6-bit sequence increased the number of available values from 8 to 64. The DiffServ model introduced
a new concept to QoS in the IP network environment: per-hop behaviors (PHBs). The PHB premise is that
equipment using the DiffServ model have an agreed upon set of rules (PHB types) for handling certain
network traffic. Though the RFC explicitly defines what each PHB should be capable of, it does not restrict
vendor-specific implementation of the PHBs. Each vendor is free to decide how their network product
implements the various defined PHBs.
According to RFC 2474, the differentiated services (DS) field contains the following bits:
0 1 2 3 4 5 6 7
Differentiated Services Code Point Unused*
*The previously unused bits in the DS field are now used for congestion control and are not discussed in this document.
Equipment following the DiffServ model (DSCP-compliant nodes) must use the entire 6-bit DSCP value to
determine the appropriate PHB. The PHBs are defined as the following:
• Default PHB
• Class selector PHB
• Assured forwarding PHB (RFC 2597)
• Expedited forwarding PHB (RFC 2598)
Default PHB
All DSCP-compliant nodes must provide a default PHB to offer best-effort forwarding service. For default
PHBs, the DSCP value is 0. Any packet that does not contain a standardized DSCP should be mapped to
the default PHB and handled accordingly.
Class Selector PHB
In the class selector PHB, the first three bits in the DSCP value are used for backwards compatibility to
systems implementing IP precedence. In this scenario, all but the first three bits of the DS field are set to 0.
This compatibility requires DSCP-compliant nodes to provide the same data services as are provided by
nodes implementing IP precedence. The following table is a comparison of IP precedence values to their
corresponding DSCP values.
IP Precedence DSCP Value (bits)

Value (bits)
0 (000) 0 (000000)
1 (001) 8 (001000)
2 (010) 16 (010000)

3 (011) 24 (011000)
4 (100) 32 (100000)
5 (101) 40 (101000)
6 (110) 48 (110000)
7 (111) 56 (111000)
Assured Forwarding PHB
The flexibility of DiffServ allows for more developed subclasses of service within each main class using the
last three bits of the DSCP. As defined in RFC 2597, the assured forwarding PHB creates four main
classes of service:
Class DSCP Bits

AF1 001XX0
AF2 010XX0
AF3 011XX0
AF4 100XX0
X indicates a do not care value.
The first three bits of the DSCP specify the class and the last bit is always 0. Each class is separated into
subclasses using the two remaining bits in the DSCP (bits 3 and 4). The subclasses are divided based on
the likelihood that packets in the class are dropped in the event of network congestion. The higher the
value for bits 3 and 4, the greater the likelihood that the packets will be dropped.
Bit 3 Bit 4 Drop Precedence

0 1 Low
1 0 Medium
1 1 High

The following table lists the assured forwarding PHB subclasses and their corresponding DSCP bits and
values.
Class Subclass DSCP Bits DSCP Value

AF1 1 001010 10
2 001100 12
3 001110 14
AF2 1 010010 18
2 010100 20
3 010110 22
AF3 1 011010 26
2 011100 28
3 011110 30
AF4 1 100010 34
2 100100 36
3 100110 38
Expedited Forwarding PHB
RFC 2598 created a new DiffServ PHB intended to provide the best service possible on an IP network.
Packets using the expedited forwarding PHB markings should provide service to reduce latency, jitter, and
dropped packets, and be guaranteed bandwidth during the entire end-to-end transmission journey through
the network. The DSCP value for the expedited forwarding PHB is 46 (DSCP bits are 101110).

match precedence <value>

Use the match precedence command to configure the quality of service (QoS) match maps based on the
precedence value in the IP header of the packet. Use the no form of this command to discontinue matching.
Syntax Description
<value> Specifies matching the IP precedence (in numeric value). Valid range is
0 to 7 in ascending order of importance.
Default Values
Command History
Usage Examples
The following example instructs the QoS map named MyMap to match the IP precedence value of 5:

Technology Review
RFC 791 created a single octet (labeled type of service (ToS)) to help with the difficulty of trying to provide
QoS handling in IP networks.
According to RFC 791, the ToS field contains the following bits:
0 1 2 3 4 5 6 7
Precedence Unused
Delay Reliability
Throughput

The 3-bit IP precedence values (0 through 7) are specified as:
111 Network Control Packets

110 Internetwork Control Packets
101 Critical Traffic
100 Flash Override
011 Flash
010 Immediate Servicing
001 Priority Traffic
000 Routine Data
The IP precedence values provide network routers with information about what kind of traffic is contained
in the IP packet. Based on the IP precedence values, some networks (when supported) can offer special
handling to certain packets. In addition, providing IP precedence values to critical traffic (such as route
information) ensures that critical packets will always be delivered regardless of network congestion. This
traffic is often critical to network and internetwork operation. In general, the higher the IP precedence
value, the more important the traffic and the better handling it should receive in the network. It is important
to remember that not all equipment in the public IP network will be configured to recognize and handle IP
precedence values. While it is a good idea to set the values for critical traffic, it does not guarantee special
handling.
In addition to the precedence values, RFC 791 specifies bits for delay, throughput, and reliability to help
balance the needs of particular traffic types when traveling on the IP network infrastructure. When these
bits are set to 0, they are handled with normal operation. When set to 1, each bit specifies premium
handling for that parameter. For example, a 1 in the delay position indicates that the traffic is delay
sensitive and care should be taken to minimize delay. A 1 in the throughput position indicates that the
traffic has higher bandwidth requirements that should be met. A 1 in the reliability position indicates that
the traffic is sensitive to delivery issues and care should be taken to ensure proper delivery with all packets
of this type. These extra bits are rarely used because they are quite difficult to balance the cost and
benefits of each parameter (especially when more than one bit is set to 1).

priority
Use the priority command to specify a high-priority queue, prioritizing this traffic above all others. If no
traffic is present in any other queue, priority traffic is allowed to burst up to the interface rate; otherwise,
priority traffic above the specified bandwidth is dropped. Use the no form of this command to disable this
priority <rate>
priority <rate> <burst size>
priority <rate> <burst size> Bytes
priority <rate> <burst size> KB
priority <rate> <burst size> MB
priority <rate> Kbps
priority <rate> Kbps <burst size>
priority <rate> Kbps <burst size> Bytes
priority <rate> Kbps <burst size> KB
priority <rate> Kbps <burst size> MB
priority <rate> Mbps
priority <rate> Mbps <burst size>
priority <rate> Mbps <burst size> Bytes
priority <rate> Mbps <burst size> KB
priority <rate> Mbps <burst size> MB
priority percent <value>
priority percent <value> <burst size>
priority unlimited
The priority command cannot be specified in conjunction with the shape average
command in a quality of service (QoS) entry.
Syntax Description
<rate> Specifies the bandwidth rate, prioritizing this traffic above all other user
traffic. Range is 8 to 1000000 kilobits per second (kbps).
<burst size> Optional. Specifies the maximum burst size (MBS) (in bytes) for traffic in
this priority queue. This parameter should be left unconfigured for optimal
performance. Range for bandwidth burst is 32 to 1000000 bytes. Range for
percentage burst is 32 to 2000000 bytes.
Kbps Optional. Indicates the rate specified is in kbps.
Bytes Optional. Indicates the burst size specified is in bytes.
KB Optional. Indicates the burst size specified is in kilobytes (kB).
MB Optional. Indicates the burst size specified is in megabytes (MB).

percent <value> Allocates a maximum bandwidth for a traffic class, specifying the maximum
as a percentage of the total interface bandwidth. This command is
especially useful for protecting bandwidth allocation in multilink
applications. Refer to Functional Notes for more details.
unlimited Optional. Specifies no limits on the priority queue bandwidth. Use of this
feature could potentially use all of the available bandwidth on the interface,
even when the max-reserved-bandwidth command is not set to 100
percent.
Use the priority unlimited command with caution as it could prevent vital Layer 2 traffic
from being processed. A network outage could occur when excessive priority traffic is
present and consumes all of the available bandwidth on the interface.
Default Values
No default values are necessary for this command. The priority rate is assumed to be provided in Kbps
unless Mbps is specified. The burst size is assumed to be provided in bytes unless KB or MB is specified.
Command History
Release 17.5 Command was expanded to allow specifying the rate in kbps and Mbps.
Specifying the burst size in bytes, MB, and kB was also added.
Functional Notes
Priority queues are intended for constant bit rate (CBR) traffic, such as voice (due to the rate limiting).
Non-CBR traffic typically does not respond well to packet dropping when it is rate limited, so the transfer
rate can be much less efficient. Important data traffic should typically use the class-based queue
bandwidth command (refer to bandwidth on page 2546) instead.
The sum of the bandwidths reserved by priority and bandwidth commands for all entries of a QoS map
cannot exceed the available bandwidth on the interface (calculated by the total interface bandwidth minus
the max-reserved-bandwidth rate specified for the interfaces to which the QoS map is applied). Priority
bandwidth is guaranteed bandwidth (in kbps).
Weighted-fair-queuing (WFQ) must be enabled on an interface to use priority queuing. By

default, WFQ is enabled for all interfaces with maximum bandwidth speeds equivalent to
T1/E1 and below.
Determining Bandwidth Entries
When possible, use the priority <rate> command to specify an absolute amount of
bandwidth (in kbps) for the priority queue.

When determining the priority percent <value> entry, use the following formula:
Bandwidth
x 100
[(max-reserved-bandwidth)(Line Rate)]
where
For example, to specify 80 kbps of data on an interface with a total of 512 kbps of available bandwidth,
enter the following command:
(config-qos-map 1)#priority percent 16
Usage Examples
The following example configures QoS for a network with the following needs:
Reserve 15 percent of the line rate for routing traffic and L2 protocol traffic (max-reserved-bandwidth =
85).
Line Rate = 512 kbps

Guaranteed 256 kbps for Voice
To configure this QoS policy, enter the following QoS map and interface commands:
1. Allocate low latency queuing (LLQ) priority voice traffic.

(config-qos-map)#match list VOICE
2. Allocate the class-based weighted fair queuing (CBWFQ) data traffic bandwidth for Classes 1 and 2.


3. Specify the reserved bandwidth on the appropriate interface and apply the map.
(config-fr 1)#qos-policy out MyMap

qos-policy <map name>

Use the qos-policy command within a parent map to divide a quality of service (QoS) policy map into
more specific subclasses. Use the no form of this command to remove the subclass and policy mapping
attributes of the parent map.
Use of the qos-policy command to configure child maps within a parent map is only
supported on maps applied to Ethernet interfaces.
Syntax Description
<map name> Specifies the QoS map name.
Default Values
Command History
Functional Notes
The qos-policy command has two functions in the ADTRAN Operating System (AOS) command line
interface (CLI). In the application described here, it is used to further subdivide a class into more specific
subclasses. From the interface configuration command set, it is used to apply a QoS map to the interface.
Refer to qos-policy on page 1382 in the Ethernet Interface Command Set for more information on using
the qos-policy command in the interface configuration command set.
When subdividing a QoS policy map, the most specific (or child map) QoS map should be created first and
then the map is referenced using the qos-policy command within the QoS map entry of the base map that
is being subdivided. The base (or parent map) is applied to the interface using the qos-policy out
command (refer to qos-policy on page 1382).
Only two levels of maps are allowed, meaning child maps (or subclasses) cannot have additional child
maps beneath them. A child map cannot reference another child map. If the child map referenced by this
command is deleted, then the qos-policy command is also deleted from the parent map.
Usage Examples
For example, the following configuration uses the ShapeEVCs QoS map to constrain each VLAN’s traffic
to specific rates. The virtual local area network (VLAN) 2 traffic that is put into the shaping queue is broken
up into class-based queuing (CBQ) or low latency queuing (LLQ) subclasses using the classQueues QoS
map. Traffic not matching a QoS map entry is treated as best effort, and is dynamically assigned to a best
effort weighted fair queuing (WFQ).
(config)#qos map classQueues 10

(config-qos-map)#match dscp ef

(config-qos-map)#qos map classQueues 20

(config-qos-map)#match dscp af31 af32 af33
(config-qos-map)#bandwidth 500 ! class based rate in Kbps
(config-qos-map)#qos map ShapeEVCs 10

(config-qos-map)#match vlan 2
(config-qos-map)#shape average 1000000 ! vlan2Rate in bps
(config-qos-map)#qos-policy classQueues
(config-qos-map)#qos map ShapeEVCs 20

(config-qos-map)#match vlan 3
(config-qos-map)#shape average 2000000 ! vlan3Rate
(config-qos-map)#interface eth 0/1

(config-eth 0/1)#encapsulation 802.1q
(config-eth 0/1)#qos-policy out ShapeEVCs
(config-eth 0/1)#interface eth 0/1.2

(config-eth 0/1.2)#interface eth 0/1.3

set cos <value>

Use the set cos command to modify the Layer 2 class of service (CoS) value (on matching packets) to the
specified value. Use the no form of this command to discontinue the action from the quality of service
(QoS) policy map.
Syntax Description
<value> Specifies the CoS numeric value. Valid range is 0 to 7.
Default Values
Command History
Functional Notes
QoS policies are configured in the ADTRAN Operating System (AOS) command line interface (CLI) to
dictate the priority for servicing specified traffic types on a particular interface. QoS policies contain at least
one match reference (using the match command) and one or more action items (using the priority,
bandwidth, shape, or set commands).
The set cos command can be used to change the Ethernet 802.1p priority field for traffic serviced by the
QoS policy. Every 802.1q tagged Ethernet frame contains a 3-bit CoS field used for marking data types
requiring special handling when traveling through the network.
Usage Examples
The following example sets the CoS value, for all matching traffic within the specified QoS map entry, to 1:

(config-qos-map)#set cos 1
The following example removes all CoS value change requests from the QoS map entry:

(config-qos-map)#no set cos

set dscp
Use the set dscp command to modify the differentiated services code point (DSCP) field (on matching
packets) to the specified value. For more details on determining the DSCP field, refer to the Technology
Review section of the command match dscp on page 2553. Use the no form of this command to remove a
specified DSCP value. Variations of this command include:
set dscp <value>

set dscp afxx
set dscp csx
set dscp default
set dscp ef
Syntax Description
afxx Specifies the assured forwarding (AF) class and subclass. Select from:
11 (001010), 12 (001100), 13 (001110), 21 (010010), 22 (010100),
23 (010110), 31 (011010), 32 (011100), 33 (011110), 41 (100010),
42 (100100), or 43 (100110).
csx Specifies the class selector (CS) value. Valid range is 1 to 7.
Default Values
Command History
Functional Notes
Quality of service (QoS) policies are configured in the ADTRAN Operating System (AOS) command line
interface (CLI) to dictate the priority for servicing specified traffic types on a particular interface. QoS
policies contain at least one match reference (using the match command) and one or more action items
(using the priority, bandwidth, shape, or set commands).
The set dscp command can be used to change the differentiated services (DS) field for incoming traffic
serviced by the quality of service (QoS) policy. Every IPv4 header contains an 8-bit type of service (ToS)
field used for marking data types requiring special handling when traveling through the network. Originally
this ToS field was used for IP precedence markings (using only the first three bits of the 8-bit field), and
was later revised in RFC 2474 to create the 6-bit DS field (reserving the last two bits of the field for future
use). The DS field can be manipulated to indicate higher or lower traffic priority using decimal values
between 0 and 63.

Usage Examples
This command sets the DSCP value, for all matching traffic within the specified QoS map entry, to 46:

(config-qos-map)#set dscp 46

set precedence <value>

Use the set precedence command to modify the IP precedence value (on matching packets) in the IP
header to the specified value. For more details on IP precedence, refer to the Technology Review section of
the command match precedence <value> on page 2557. Use the no form of this command to discontinue
the action from the quality of service (QoS) policy map.
Syntax Description
<value> Specifies the IP precedence numeric value. Valid range is 0 to 7 in
ascending order of importance.
Default Values
Command History
Usage Examples
The following example sets the precedence value, for all matching traffic within the specified QoS map
entry, to 1:

(config-qos-map)#set precedence 1
The following example removes all precedence value change requests from the QoS map entry:

(config-qos-map)#no set precedence

shape average
Use the shape average command to shape the traffic in this class to an average rate. Use the no form of
this command to disable this feature. Variations of this command include:
shape average <rate> [count-eth-overhead]
shape average <rate> bps

shape average <rate> bps burst <size>
shape average <rate> bps burst <size> Bytes [count-eth-overhead]
shape average <rate> bps burst <size> KB [count-eth-overhead]
shape average <rate> bps burst <size> MB [count-eth-overhead]
shape average <rate> bps burst <size> [count-eth-overhead]
shape average <rate> bps [count-eth-overhead]
shape average <rate> Kbps

shape average <rate> Kbps burst <size>
shape average <rate> Kbps burst <size> Bytes [count-eth-overhead]
shape average <rate> Kbps burst <size> KB [count-eth-overhead]
shape average <rate> Kbps burst <size> MB [count-eth-overhead]
shape average <rate> Kbps burst <size> [count-eth-overhead]
shape average <rate> Kbps [count-eth-overhead]
shape average <rate> Mbps

shape average <rate> Mbps burst <size>
shape average <rate> Mbps burst <size> Bytes [count-eth-overhead]
shape average <rate> Mbps burst <size> KB [count-eth-overhead]
shape average <rate> Mbps burst <size> MB [count-eth-overhead]
shape average <rate> Mbps burst <size> [count-eth-overhead]
shape average <rate> Mbps [count-eth-overhead]
shape average <rate> burst <size> [count-eth-overhead]

shape average <rate> burst <size> Bytes [count-eth-overhead]
shape average <rate> burst <size> KB [count-eth-overhead]
shape average <rate> burst <size> MB [count-eth-overhead]
The shape average command cannot be specified in conjunction with the priority
command in a quality of service (QoS) entry.

Syntax Description
<rate> Specifies an average bandwidth. Range is 8192 to 1000000000 bits per
second (bps).
burst <size> Optional. Specifies the maximum burst size (MBS) (in bytes) for traffic in
this QoS map entry. This parameter should be left unconfigured for optimal
performance. Range is 1600 to 6250000 bytes.
count-eth-overhead Optional. Indicates to include the Ethernet header overhead bytes when
determining packet size.
bps Optional. Indicates the rate specified is in bps.
Kbps Optional. Indicates the rate specified is in kilobits per second (kbps).
Bytes Optional. Indicates the burst size specified is in bytes.
KB Optional. Indicates the burst size specified is in kilobytes (kB).
MB Optional. Indicates the burst size specified is in megabytes (MB).
Default Values
The default shape average rate is specified in bps. The default burst size is specified in bytes.
Command History
Release 17.5 Command was expanded to allow specifying shape average rate in bps,
kbps, and Mbps. Specifying the burst size in bytes, MB, and kB was also
added.
Functional Notes
Traffic shaping allows the traffic to be smoothed in order to maintain a uniform rate to take full advantage of
the provided bandwidth. Short bursts of traffic above the configured rate are allowed when there is
sufficient budget. Traffic outside of the current budget is put into a shaping queue and transmitted once the
budget is available.
Usage Examples
The following example shapes the traffic in this QoS class to an average rate of 2000000 bps:

(config-qos-map)#shape average 2000000

Command Reference Guide RADIUS Group Command Set
RADIUS GROUP COMMAND SET
The remote authentication dial-in user service (RADIUS) Group Command Set details how to create a
RADIUS server group and how to add servers to this group. Configured groups of RADIUS servers can be
created to be used as methods for authentication, authorization, and accounting (AAA) services in AOS.
These subsets are used when defining method lists for AAA actions and can keep you from having to
specify that all configured RADIUS servers are used for AAA.
To work with RADIUS server groups, AAA must be enabled. Refer to the command aaa on on page 751
for more information. Any RADIUS servers you want to add to the RADIUS server group must already be
configured before attempting to add them to the server group. For more information about configuring
RADIUS servers, refer to the commands radius-server on page 1065 and radius-server host on page 1067.
RADIUS server groups are first defined in the Global Configuration mode using the aaa group server
command. Entering this command allows you to create a group of RADIUS servers, and then enters the
RADIUS Group Configuration mode in order to add servers to the group. For more information about
creating a server group, refer to the command aaa group server on page 748.
For more information about configuring RADIUS server groups for use with AAA, refer to the
configuration guide Configuring AAA in AOS available online at http://kb.adtran.com.
To activate the RADIUS Group Configuration mode, enter the aaa group server radius <name>
>enable
#configure terminal
(config)#aaa group server radius RADAuthgroup
(config-sg-radius)#
do on page 51
end on page 52
exit on page 53
shutdown on page 61
server <hostname | ip address> on page 2571

server <hostname | ip address>

Use the server command to add a predefined remote authentication dial-in user service (RADIUS) server
to the RADIUS server group for use with authentication, authorization, and accounting (AAA). Use the no
form of this command to remove the server from the group. Variations of this command include:

server <hostname | ip address> acct-port <number>
server <hostname | ip address> auth-port <number>
Syntax Description
<hostname | ip address> Specifies the server to add to the group. IP addresses should be expressed
in dotted decimal notation (for example, 10.10.10.1). If a host name is used,
a domain naming system (DNS) server should be learned by the AOS
device using Dynamic Host Configuration Protocol (DHCP), Point-to-Point
Protocol (PPP), or specified in the Global Configuration mode with the
command ip name-server on page 898.
acct-port <number> Optional. Specifies the User Datagram Protocol (UDP) port for AAA
accounting services with the RADIUS server being added to the RADIUS
server group. Port range is 0 to 65535. This command is reserved for future
use as currently AOS does not allow RADIUS servers for use with
accounting.
auth-port <number> Optional. Specifies the UDP port for AAA authentication services with the
RADIUS server being added to the RADIUS server group. Port range is 0 to
65535.
Default Values
By default, the accounting port is set to 1813 and the authentication port is set to 1812.
Command History
Functional Notes
Empty RADIUS server groups are not saved. When the last server is removed from a group, AOS
automatically deletes the group.
If you choose to change the default authentication port for the RADIUS server, you can then create
multiple host entries for the same server. Server groups can have multiple host entries for the same server
as long as each entry has a unique identifier (an IP address and a UDP port). If you configure two host
entries on the same RADIUS server and are using both host entries for the same service (for example,
using both entries for authentication), then the second entry functions as a failover. RADIUS host entries
are tried in the order they are configured, so the failover entry is the second configured entry.
For more information about server groups, refer to the command aaa group server on page 748.

Usage Examples
The following example specifies that the RADIUS servers at IP address 192.168.1.2 and 192.168.1.3 are
added to the server group RADAuthgroup:
(config)#aaa group server radius RADAuthgroup

(config-sg-radius)#server 192.168.1.2
(config-sg-radius)#server 192.168.1.3
(config-sg-radius)#exit
(config)#

Command Reference Guide Route Map Command Set
ROUTE MAP COMMAND SET
To activate the Route Map Configuration mode, enter the route-map command at the Global
>enable
#configure terminal
(config)#route-map MyMap permit 100
(config-route-map)#
do on page 51
exit on page 53
match as-path <name> on page 2575

match community <name> on page 2576
match ip address <name> on page 2577
match ip address prefix-list <name> on page 2578
match ip dscp on page 2579
match ip precedence on page 2583
match length <minimum> <maximum> on page 2585
match metric <value> on page 2586
match tag <number> on page 2587
set as-path prepend on page 2588
set comm-list <name> delete on page 2589
set community on page 2590
set default interface on page 2592
set interface <interface> on page 2593
set ip default next-hop <interface> on page 2594
set ip df on page 2595
set ip dscp on page 2596
set ip next-hop <ip address> on page 2597
set ip precedence on page 2598

set local-preference <value> on page 2599

set metric <value> on page 2600
set metric-type on page 2601

match as-path <name>

Use the match as-path command to configure the route map to route traffic based on the autonomous
system (AS) path list name. Use the no form of this command to discontinue matching.
Syntax Description
<name> Specifies the name of the AS path list you want to match.
Default Values
Command History
Usage Examples
The following example instructs the route map named MyMap to match the AS path list named TestPath:

(config-route-map)#match as-path TestPath

match community <name>

Use the match community command to configure the route map to route traffic based on a specified
community. Use the no form of this command to discontinue matching. Variations of this command
include:
match community <name>

match community <name> exact-match
Syntax Description
<name> Specifies the name of the community you want to match.
exact-match Optional. Specifies that the route map must match the community name
exactly.
Default Values
Command History
Usage Examples
The following example instructs the route map named MyMap to match the community named
MyCommunity:

(config-route-map)#match community MyCommunity

match ip address <name>

Use the match ip address command to configure the route map to route traffic based on the access control
list (ACL) name defined with the ip access-list command. Refer to ip access-list extended <name> on
page 815 for more information. Use the no form of this command to discontinue matching.
Syntax Description
<name> Specifies the name of the ACL to match.
Default Values
Command History
Usage Examples
The following example instructs the route map named MyMap to match the IP address ACL named
MyList:

(config-route-map)#match ip address MyList

match ip address prefix-list <name>

Use the match ip address prefix-list command to configure the route map to route traffic based on a
prefix list route filter. The name of the prefix list is defined with the ip prefix-list command. Refer to ip
prefix-list <name> description “<text>” on page 908 for more information. Use the no form of this
command to discontinue matching.
Syntax Description
<name> Specifies matching the IP address based on the prefix list name.
Default Values
Command History
Usage Examples
The following example instructs the route map named MyMap to match the IP address prefix list named
MyList:

(config-route-map)#match ip address prefix-list MyList

match ip dscp
Use the match ip dscp command to configure the route map to route traffic based on the differentiated
services code point (DSCP) value in the IP header of the packet. Use the no form of this command to
discontinue matching. Variations of this command include:
match ip dscp <value>

match ip dscp afxx
match ip dscp csx
match ip dscp default
match ip dscp ef
Syntax Description
afxx Specifies the assured forwarding (AF) class and subclass. Select from: 11
(001010), 12 (001100), 13 (001110), 21 (010010), 22 (010100),
23 (010110), 31 (011010), 32 (011100), 33 (011110), 41 (100010),
42 (100100), or 43 (100110).
Default Values
Command History
Functional Notes
The differentiated services (DiffServ or DS) model was created in RFC 2474 and RFC 2475 to build on the
original type of service (ToS) field by creating a six-bit sequence (combining the precedence value with the
delay, throughput, and reliability bits). This six-bit sequence increased the number of available values from
8 to 64. The DiffServ model introduced a new concept to quality of service (QoS) in the IP network
environment: per-hop behaviors (PHBs). The PHB premise is that equipment using the DiffServ model
have an agreed upon set of rules (PHB types) for handling certain network traffic. Though the RFC
explicitly defines what each PHB should be capable of, it does not restrict vendor-specific implementation
of the PHBs. Each vendor is free to decide how their network product implements the various defined
PHBs.

According to RFC 2474, the DS field contains the following bits:
0 1 2 3 4 5 6 7
Differentiated Services Code Point Unused*
* The previously unused bits in the DS field are now used for congestion control and are not discussed in this document.
Equipment following the DiffServ model (DS-compliant nodes) must use the entire six-bit DSCP value to
determine the appropriate PHB. The PHBs are defined as the following:
• Default PHB
• Class selector PHB
• Assured forwarding PHB (RFC 2597)
• Expedited forwarding PHB (RFC 2598)
Default PHB
All DS-compliant nodes must provide a default PHB to offer best-effort forwarding service. For default
PHBs, the DSCP value is 0. Any packet that does not contain a standardized DSCP should be mapped to
the Default PHB and handled accordingly.
Class Selector PHB
In the class selector PHB, the first three bits in the DSCP value are used for backwards compatibility to
systems implementing IP precedence. In this scenario, all but the first three bits of the DS field are set to 0.
This compatibility requires DS-compliant nodes to provide the same data services as are provided by
nodes implementing IP precedence. The following table is a comparison of IP precedence values to their
corresponding DSCP values.
IP Precedence
Value (bits) DSCP Value (bits)
0 (000) 0 (000000)
1 (001) 8 (001000)
2 (010) 16 (010000)
3 (011) 24 (011000)
4 (100) 32 (100000)
5 (101) 40 (101000)
6 (110) 48 (110000)
7 (111) 56 (111000)

Assured Forwarding PHB
The flexibility of DiffServ allows for more developed subclasses of service within each main class using the
last three bits of the DSCP. As defined in RFC 2597, the assured forwarding PHB creates four main
classes of service:
Class DSCP Bits

AF1 001XX0
AF2 010XX0
AF3 011XX0
AF4 100XX0
X indicates a do not care value.
The first three bits of the DSCP specify the class and the last bit is always zero. Each class is separated
into subclasses using the two remaining bits in the DSCP (bits 3 and 4). The subclasses are divided based
on the likelihood that packets in the class are dropped in the event of network congestion. The higher the
value for bits 3 and 4, the greater the likelihood that the packets will be dropped.
Drop
Bit 3 Bit 4 Precedence
0 1 Low
1 0 Medium
1 1 High
The following table lists the assured forwarding PHB subclasses and their corresponding DSCP bits and
values.
Class Subclass DSCP Bits DSCP Value

AF1 1 001010 10
2 001100 12
3 001110 14
AF2 1 010010 18
2 010100 20
3 010110 22
AF3 1 011010 26
2 011100 28
3 011110 30
AF4 1 100010 34
2 100100 36
3 100110 38

Expedited Forwarding PHB
RFC 2598 created a new DiffServ PHB intended to provide the best service possible on an IP network.
Packets using the expedited forwarding PHB markings should provide service to reduce latency, jitter, and
dropped packets, and be guaranteed bandwidth during the entire end-to-end transmission journey through
the network. The DSCP value for the expedited forwarding PHB is 46 (DSCP bits are 101110).
Usage Examples
The following example instructs the route map named MyMap to match the IP header with a DSCP AF

(config-route-map)#match ip dscp af12

match ip precedence
Use the match ip precedence command to configure the route map to route traffic based on the
precedence value in the IP header of the packet. Use the no form of this command to discontinue matching.
match ip precedence <value>

match ip precedence critical
match ip precedence flash
match ip precedence flash-override
match ip precedence immediate
match ip precedence internet
match ip precedence network
match ip precedence priority
match ip precedence routine
Syntax Description
routine Specifies matching the IP precedence routine. (Numeric value of 0.)
priority Specifies matching the IP precedence priority. (Numeric value of 1.)
immediate Specifies matching the IP precedence immediate. (Numeric value of 2.)
flash Specifies matching the IP precedence flash. (Numeric value of 3.)
flash-override Specifies matching the IP precedence flash-override. (Numeric value of 4.)
critical Specifies matching the IP precedence critical. (Numeric value of 5.)
internet Specifies matching the IP precedence internet. (Numeric value of 6.) This
level is reserved for internal network use.
network Specifies matching the IP precedence network. (Numeric value of 7.) This
Default Values
Command History
Functional Notes
RFC 791 created a single octet (labeled type of service (ToS)) to help with the difficulty of trying to provide
quality of service (QoS) handling in IP networks.

According to RFC 791, the ToS field contains the following bits:
0 1 2 3 4 5 6 7
Precedence Unused
Delay Reliability
Throughput
The three-bit IP precedence values (0 through 7) are specified as:
111 Network Control Packets

110 Internetwork Control Packets
101 Critical Traffic
100 Flash Override
011 Flash
010 Immediate Servicing
001 Priority Traffic
000 Routine Data
The IP precedence values provide network routers with information about the kind of traffic contained in
the IP packet. Based on the IP precedence values, some networks (when supported) can offer special
handling to certain packets. In addition, providing IP precedence values to critical traffic (such as route
information) ensures that critical packets will always be delivered regardless of network congestion. This
traffic is often critical to network and internetwork operation. In general, the higher the IP precedence
value, the more important the traffic and the better handling it should receive in the network. It is important
to remember that not all equipment in the public IP network will be configured to recognize and handle IP
precedence values. While it is a good idea to set the values for critical traffic, it does not guarantee special
handling.
In addition to the IP precedence values, RFC 791 specifies bits for delay, throughput, and reliability to help
balance the needs of particular traffic types when traveling on the IP network infrastructure. When these
bits are set to 0, they are handled with normal operation. When set to 1, each bit specifies premium
handling for that parameter. For example, a 1 in the delay position indicates that the traffic is delay
sensitive and care should be taken to minimize delay. A 1 in the throughput position indicates that the
traffic has higher bandwidth requirements that should be met. A 1 in the reliability position indicates that
the traffic is sensitive to delivery issues and care should be taken to ensure proper delivery with all packets
of this type. These extra bits are rarely used because it is quite difficult to balance the cost and benefits of
each parameter (especially when more than one bit is set to 1).
Usage Examples
The following example instructs the route map named MyMap to match the IP precedence value of
critical:

(config-route-map)#match ip precedence critical

match length <minimum> <maximum>

Use the match length command to configure the route map to route traffic based on the packet length. Use
the no form of this command to discontinue matching.
Syntax Description
<minimum> Specifies the minimum packet length you want to match.
<maximum> Specifies the maximum packet length you want to match.
Default Values
Command History
Usage Examples
The following example instructs the route map named MyMap to match packets with a minimum length of
1 and a maximum length of 200:

(config-route-map)#match length 1 200

match metric <value>

Use the match metric command to configure the route map to route traffic based on a specified metric
value. Use the no form of this command to discontinue matching.
Syntax Description
<value> Specifies the metric value you want to match. Valid range is 1 to
4294967295.
Default Values
Command History
Usage Examples
The following example instructs the route map named MyMap to match the metric value 100:

(config-route-map)#match metric 100

match tag <number>

Use the match tag command to configure the route map to filter traffic based on a route’s tag value. Use
the no form of this command to discontinue matching.
match tag <number>

match tag <number> <number>
Syntax Description
<number> Specifies the desired route tag value to match. If more than one value is
specified, the match command will pass if any value matches. Valid range is
1 to 65535.
Default Values
Command History
Functional Notes
More than one value may be specified as a tag to be matched.
Usage Examples
The following example instructs the route map named MyMap to match a route tag of 100 or 200:

(config-route-map)#match tag 100 200
Technical Review
The command ip route on page 912 is related to the match tag command in that it includes an optional
parameter to set the route tag value for local static routes.
Virtual private network (VPN) reverse-route injection (RRI) routes can also have a tag applied.

set as-path prepend

Use the set as-path prepend command to prepend a number to the autonomous system (AS) path to
influence the best-path selection process by making the AS path appear further away. Use the no form of
this command to disable this feature. Variations of this command include:
set as-path prepend <number>

set as-path prepend last-as <number>
Syntax Description
<number> Specifies a number to be prepended to the AS path value as an
autonomous number. Valid range is 1 to 65535.
last-as <number> Specifies a number to be prepended to the last AS path number. Valid range
is 1 to 10.
Default Values
Command History
Usage Examples
The following example prepends the number 2 to the last AS path number:

(config-route-map)#set as-path prepend last-as 2

set comm-list <name> delete

Use the set comm-list delete command to specify a list of communities to delete. Use the no form of this
Syntax Description
<name> Specifies the name of the list of communities to delete.
Default Values
Command History
Usage Examples
The following example deletes the community list named listname:

(config-route-map)#set comm-list listname delete

set community
Use the set community command to modify the community attribute for all paths serviced by the route
map. Use the no form of this command to disable this feature. Variations of this command include:
set community <value>

set community <value> add
set community <value> internet
set community <value> local-as
set community <value> no-advertise
set community <value> no-export
set community none
Syntax Description
<value> Sets the community attribute to the specified community number for routes
serviced by this route map. This is a numeric value that can be an integer
from 1 to 4294967295 or string in the form aa:nn, where the value of aa is
the autonomous system (AS) number and the value of nn is the community
number. Multiple community-number parameters can be present in the
command.
add Appends the listed community number to the end of the community attribute
for routes serviced by this route map.
internet Sets the community attribute to the INTERNET community number for
routes serviced by this route map.
local-as Sets the community attribute to the NO_EXPORT_SUBCONFED
community number for routes serviced by this route map. Routes containing
this attribute should not be advertised to external Border Gateway Protocol
(BGP) peers.
no-advertise Sets the community attribute to the NO_ADVERTISE community number
for routes serviced by this route map. Routes containing this attribute
should not be advertised to any BGP peer.
no-export Sets the community attribute to the NO_EXPORT community number for
routes serviced by this route map. Routes containing this attribute should
not be advertised to BGP peers outside a confederation boundary.
none Removes all communities from BGP routes serviced by this route map.
Default Values
Command History

Usage Examples
The following example sets the community number for BGP routes to the Internet community:

(config-route-map)#set community internet

set default interface

Use the set default interface command to specify a default interface to redirect traffic to the specified
interface if there is no specific routing information for the traffic. If more than one interface is specified,
the router uses the first available interface from the list. Use the no form of this command to remove the
default interface. Variations of this command include:
set default interface <interface>

set default interface null 0
Syntax Description
<interface> Specifies the default interface. Specify an interface in the format <interface
wireless virtual access point, use dot11ap 1/1.1.
Type set default interface ? for a list of valid interface types.
null 0 Redirects traffic to the specified interface regardless of available routing
information.
Default Values
Command History
Usage Examples
The following example sets the default interface as ppp 1 interface:

(config-route-map)#set default interface ppp 1

set interface <interface>

Use the set interface command to specify an output interface for the packet. Multiple interfaces can be
specified. The router forwards the packet along the first usable interface. Use the no form of this command
to cancel output from the specified interface.
Syntax Description
<interface> Sets output interface type for the packet. Specify an interface in the format
wireless virtual access point, use dot11ap 1/1.1. Type set interface ? for a
list of valid interfaces.
Default Values
Command History
Usage Examples
The following example sets the output interface as Point-to-Point Protocol (PPP) 1:

(config-route-map)#set interface ppp 1

set ip default next-hop <interface>

Use the set ip default next-hop command to set the next-hop IP address to the specified interface’s
address for all routes serviced by the route map that do not have explicit routing information available. Use
the no form of this command to remove the configured default next hop.
Syntax Description
<interface> Specifies the default interface. Specify an interface in the format <interface
wireless virtual access point, use dot11ap 1/1.1. Type set default
next-hop ? for a list of valid interface types.
Default Values
Command History
Usage Examples
The following example sets the default next-hop interface to the ppp 1 interface:

(config-route-map)#set ip default next-hop ppp 1

set ip df
Use the set ip df command to identify the packet as don’t fragment (DF). Use the no form of this command
to remove this designation.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example designates the packet as DF:

(config-route-map)#set ip df

set ip dscp
Use the set ip dscp command to configure the route map to set the differentiated services code point
(DSCP) value in the IP header of the packet for traffic serviced by this route map. For more details on
DSCP values, refer to the command match ip dscp on page 2579. Use the no form of this command to
remove the specified DSCP value. Variations of this command include:
set ip dscp <value>

set ip dscp afxx
set ip dscp csx
set ip dscp default
set ip dscp ef
Syntax Description
afxx Specifies the assured forwarding (AF) class and subclass. Select from: 11
(001010), 12 (001100), 13 (001110), 21 (010010), 22 (010100),
23 (010110), 31 (011010), 32 (011100), 33 (011110), 41 (100010),
42 (100100), or 43 (100110).
Default Values
Command History
Usage Examples
The following example instructs the route map named MyMap to set the IP header with a DSCP AF

(config-route-map)#set ip dscp af12

set ip next-hop <ip address>

Use the set ip next-hop command to set the next-hop IP address to the specified address for all routes
serviced by the route map. Use the no form of this command to remove the configured next-hop address.
Syntax Description
decimal notation (for example, 10.10.10.1). More than one address can be
entered, and the router uses the first available route from the list.
Default Values
Command History
Usage Examples
The following example sets the ip next-hop interface to 10.10.11.254 in the header of the route map named
MyMap:

(config-route-map)#set ip next-hop 10.10.11.254

set ip precedence
Use the set ip precedence command to configure the route map to set the precedence value in the IP
header of the packet for traffic serviced by the route map. For more details on IP precedence values, refer
to the command match ip precedence on page 2583. Use the no form of this command to remove the
specified IP precedence value. Variations of this command include:
set ip precedence <value>

set ip precedence critical
set ip precedence flash
set ip precedence flash-override
set ip precedence immediate
set ip precedence internet
set ip precedence network
set ip precedence priority
set ip precedence routine
Syntax Description
routine Specifies matching the IP precedence routine. (Numeric value of 0.)
priority Specifies matching the IP precedence priority. (Numeric value of 1.)
immediate Specifies matching the IP precedence immediate. (Numeric value of 2.)
flash Specifies matching the IP precedence flash. (Numeric value of 3.)
flash-override Specifies matching the IP precedence flash-override. (Numeric value of 4.)
critical Specifies matching the IP precedence critical. (Numeric value of 5.)
internet Specifies matching the IP precedence internet. (Numeric value of 6.) This
network Specifies matching the IP precedence network. (Numeric value of 7.) This
Default Values
Command History
Usage Examples
The following example sets an IP precedence value of critical in the IP header of the route map named
MyMap:

(config-route-map)#set ip precedence critical

set local-preference <value>

Use the set local-preference command to restrict traffic to a local autonomous system (AS). Use the no
form of this command to cancel the local preference.
Syntax Description
<value> Sets the local preference value. Valid range is 0 to 4294967295.
Default Values
Command History
Usage Examples
The following example sets the local preference for MyMap to a value of 100:

(config-route-map)#set local-preference 100

set metric <value>

Use the set metric command to specify a metric value for the route map. Use the no form of this command
to cancel the metric value.
Syntax Description
<value> Sets the metric value. Valid range is 0 to 4294967295.
Default Values
Command History
Usage Examples
The following example sets the metric value for MyMap to 100:

(config-route-map)#set metric 100

set metric-type
Use the set metric-type command to set the open shortest path first (OSPF) metric type for the route map.
set metric-type type-1

set metric-type type-2
Syntax Description
type-1 Specifies intra-area metric.
type-2 Specifies inter-area metric.
Default Values
By default, the metric type is set to type 1.
Command History
Usage Examples
The following example sets the metric-type value for MyMap to type 2:

(config-route-map)#set metric-type type-2

Command Reference Guide TACACS+ Group Command Set
TACACS+ GROUP COMMAND SET
The terminal access controller access control system plus (TACACS+) Group Command Set details how to
create a TACACS+ server group and how to add servers to this group. Configured groups of TACACS+
servers can be created to be used as methods for authentication, authorization, and accounting (AAA)
services in AOS. These subsets are used when defining method lists for AAA actions and can keep you
from having to specify that all configured TACACS+ servers are used for AAA.
To work with TACACS+ server groups, AAA must be enabled. Refer to the command aaa on on page 751
for more information. Any TACACS+ servers you want to add to the TACACS+ server group must
already be configured before attempting to add them to the server group. For more information about
configuring TACACS+ servers, refer to the commands tacacs-server on page 1116 and tacacs-server host
on page 1117.
TACACS+ server groups are first defined in the Global Configuration mode using the aaa group server
command. Entering this command allows you to create a group of TACACS+ servers, and then enters the
TACACS+ Group Configuration mode in order to add servers to the group. For more information about
creating a server group, refer to the command aaa group server on page 748.
For more information about configuring TACACS+ server groups for use with AAA, refer to the
configuration guide Configuring AAA in AOS available online at http://kb.adtran.com.
To activate the TACACS+ Group Configuration mode, enter the aaa group server tacacs+ <name>
>enable
#configure terminal
(config)#aaa group server tacacs+ TACAuthgroup
do on page 51
end on page 52
exit on page 53
shutdown on page 61
server <hostname | ip address> on page 2603

Command Reference Guide TACACS+ Group Command Set

Use the server command to add a predefined terminal access controller access control system plus
(TACACS+) server to the TACACS+ server group for use with authentication, authorization, and
accounting (AAA). Use the no form of this command to remove the server from the group.
Syntax Description
<hostname | ip address> Specifies the server to add to the group. IP addresses should be expressed
in dotted decimal notation (for example, 10.10.10.1). If a host name is used,
a domain naming system (DNS) server should be learned by the AOS
device using Dynamic Host Configuration Protocol (DHCP), Point-to-Point
Protocol (PPP), or specified in the Global Configuration mode with the
command ip name-server on page 898.
Default Values
By default, no TACACS+ server groups are configured.
Command History
Functional Notes
Empty TACACS+ server groups are saved. When the last server is removed from a group, AOS
automatically maintains the group.
For more information about server groups, refer to the command aaa group server on page 748.
Usage Examples
The following example specifies that the TACACS+ servers at IP address 192.168.1.4 and 192.168.1.5 are
added to the server group TACAuthgroup:
(config)#aaa group server tacacs+ TACAuthgroup

(config-sg-tacacs+)#server 192.168.1.4
(config-sg-tacacs+)#server 192.168.1.5
(config-sg-tacacs+)#exit
(config)#

Command Reference Guide Top Traffic Command Set
TOP TRAFFIC COMMAND SET
To activate the Top Traffic Configuration mode, enter the ip flow top-talkers command at the Global
>enable
#configure terminal
do on page 51
exit on page 53
interval on page 2605

match list <name> on page 2606
monitor port <number> <description> on page 2607
sort-by on page 2608
top <number> on page 2609

interval
Use the interval command to specify the minimum interval for which Top Talkers data is collected. Use
the no form of this command to reset the interval to the default value. Variations of this command include:
interval 5
interval 10
interval 15
If the interval is changed after Top Talkers has been enabled, all accumulated data will be
lost.
Syntax Description
5 Collects Top Talkers data at 5-minute intervals.
Default Values
By default, the interval for Top Talkers data collection is set to 5-minute intervals.
Command History
Functional Notes
When viewing Top Talkers data, the current interval displayed is the interval set with this command. As the
specified interval for data accumulation ends, the data is compiled into hourly, 24 hourly, and daily
readouts.
Usage Examples
The following example sets the interval for Top Talkers data collection to 10-minute intervals:

(config-top-talkers)#interval 10

match list <name>

Use the match list command to specify an access control list (ACL) be used to filter the data that can be
used in Top Talkers listings. Use the no form of this command to specify no ACL is used and all traffic is
considered.
Syntax Description
<name> Specifies the name of the ACL to be used to filter Top Talkers data
collection.
Default Values
By default, no ACL is assigned and all traffic is considered.
Command History
Usage Examples
The following example applies the ACL named engineering to filter Top Talkers data collection:

(config-top-talkers)#match list engineering

monitor port <number> <description>

Use the monitor port command to add a custom port to the port monitoring list in the Top Talkers feature.
Use the no form of this command to remove the port from the monitoring list.
Syntax Description
<number> Specifies the port number to be monitored.
<description> Optional. Specifies the application name associated with the port.
Default Values
By default, port monitoring is enabled and monitors well-known Transmission Control Protocol (TCP) and
User Datagram Protocol (UDP) ports when Top Talkers is enabled. Up to 32 custom ports can be added to
the port monitoring list.
Command History
Usage Examples
The following example adds port 3724, the World of Warcraft gaming port, to Top Talkers’ port monitoring
list:

(config-top-talkers)#monitor port 3724 World of Warcraft Gaming

sort-by
Use the sort-by command to specify the type of data for the Top Talkers collection. Use the no form of
this command to return the sorting procedure to the default setting. Variations of this command include the
following:
sort-by packets
sort-by bytes
If the statistic to be gathered is changed once Top Talkers is configured, all existing data
will be lost.
Syntax Description
packets Specifies packet statistics are monitored for Top Talkers collection.
bytes Specifies byte statistics are monitored for Top Talkers collection.
Default Values
By default, Top Talkers will collect byte statistics.
Command History
Functional Notes
Data used in the Top Talkers collection can be collected by monitoring the number of packets sent or
received or the number of bytes sent or received in a specified amount of time. Collection by byte count
and packet count are mutually exclusive and must be configured by the user. Yet each can be helpful
depending on specific network needs. Using packet counts to monitor hosts can make it easier to identify
the source of problems in cases where a host is infected by a virus, or attacking the network with a port
scan. Using byte counts can display overall bandwidth consumption on a host-by-host basis.
Usage Examples
The following example specifies packet statistics for collection:

(config-top-talkers)#sort-by packets

top <number>
Use the top command to specify the number of listings included in the Top Talkers report. Use the no form
of this command to return to the default value.
If the number of listings is changed after Top Talkers has been enabled, all accumulated
data will be lost.
Syntax Description
<number> Specifies the number of listings shown in the Top Talkers report. Range is
1 to 20.
Default Values
By default, Top Talkers will display 5 listings in a report.
Command History
Usage Examples
The following example specifies that 10 listings will be included in the Top Talkers report:

(config-top-talkers)#top 10

VOICE GROUPS COMMAND SETS

• Voice ISDN Group Command Set on page 2611

• Voice Operator Ring Group Command Set on page 2620
• Voice Paging Group Command Set on page 2638
• Voice Ring Group Command Set on page 2643
• Voice Trunk Group Command Set on page 2666

Command Reference Guide Voice ISDN Group Command Set
VOICE ISDN GROUP COMMAND SET
Integrated services digital network (ISDN) groups are groups of ISDN trunks. Trunk groups combine one
or more trunk accounts and assign outbound call characteristics to the grouped trunks. Individual trunk
groups can be created for each trunk account. The trunk group is assigned outbound call capabilities (local
calls, long distance calls, etc.). Additionally, a cost is assigned to each attribute in the outbound call
template. For more information about configuring trunk groups in general, refer to the NetVanta 7000
Series Trunk Accounts configuration guide (article number 1541) available online at http://kb.adtran.com.
In order to create a new ISDN group, you must first create the necessary ISDN trunks for your network.
For more information on creating ISDN trunks, refer to the Voice ISDN Trunk Command Set on page 2718.
There is also information on creating ISDN trunks in the Total Access 900 Series ISDN PRI Interface quick
configuration guide (article number 1538) available online at http://kb.adtran.com.
Once you have configured the necessary ISDN trunks, the ISDN trunk group is created by adding the trunk
accounts to the ISDN group and defining the outbound call templates and costs. The commands for these
procedures are covered in this command set.
To create an ISDN group and enter the ISDN Group Configuration mode, enter the isdn-group command
at the Global Configuration mode prompt. For example:
>enable
#configure terminal
do on page 51
exit on page 53
accept-number <number> on page 2612

call-type voice on page 2613
connect pri on page 2614
incoming-accept-number <number> on page 2615
max-channels <value> on page 2617
min-channels <value> on page 2618

accept-number <number>
Use the accept-number command to specify the incoming number to be accepted by this integrated
services digital network (ISDN) group. This number will be accepted and passed from the network to the
end users.
Syntax Description
<number> Specifies the incoming number to be accepted by this ISDN group.
Default Values
Command History
Usage Examples
The following example specifies that ISDN group 1 will accept calls from 256-555-1234:
(config-isdn-group 1)#accept-number 2565551234

call-type voice
Use the call-type voice command to specify the type of communication allocated for this group. Use the
Syntax Description
No subcommands.
Default Values
By default, the call type is set to voice.
Command History
Usage Examples
The following example sets the call type for integrated services digital network (ISDN) group 1 to voice:
(config-isdn-group 1)#call-type voice

connect pri
Use the connect pri command to associate a specific interface with the integrated services digital network
(ISDN) group. Use the no form of this command to disconnect the specified interface from the ISDN
group.
Syntax Description
pri Connects a primary rate interface (PRI) interface to the ISDN group. Type
connect ? for a list of valid interfaces.
Default Values
Command History
Usage Examples
The following example associates the pri 1 interface with ISDN group 1:
(config-isdn-group 1)#connect pri 1

incoming-accept-number <number>
Use the incoming-accept-number command to configure the incoming number to be accepted by this
group from the public switched telephone network (PSTN). Use the no form of this command to remove a
configured accept number.
Syntax Description
<number> Specifies the phone number(s) accepted for this integrated services digital
network (ISDN) group. The accept number entered should match the digits
that populate the called party information element received on the ISDN
interface for the call. Refer to the Functional Notes for more information on
entering the number.
Default Values
By default, there are no configured incoming accept numbers. The ISDN group will not be able to accept
calls without a configured incoming accept number.
Command History
Functional Notes
Special characters (parentheses, commas, and dashes) can be entered in the incoming accept number for
readability, but they are ignored by the system. Incoming accept numbers are entered as a single number,
or as a range of numbers using the available wildcard characters. The following wildcards can be used to
define numbers:
X Any single digit 0 through 9

N Any single digit 2 through 9
[1,2,3] Specifies single digit in this group
$ Any number; effectively functions as a don’t care
The following list provides some examples for proper wildcard usage:
Incoming Accept Number(s) Entry

555-1111 and 555-1112 555-111[1,2]
All numbers from the 916 area code916$
Numbers between 555-1000 and 555-2000555-[1,2]XXX
Wildcard characters are especially useful in situations where ISDN hunt groups are deployed and the
ISDN interfaces are all assigned to the same ISDN group in the router. ISDN hunt groups bundle multiple
ISDN interfaces (with unique local directory numbers (LDNs)) together into a single group at the central
office. When a call to any of the LDNs assigned to the ISDN interfaces in the hunt group is received at the
central office, the switch sends the call to the first available ISDN interface. The ISDN group must be able
to accept calls to multiple LDNs. Wildcard characters can simplify a configuration by allowing a single entry
to match several numbers.

Usage Examples
The following example configures the group to accept calls for 256-555-1000 through 256-555-2000:
(config-isdn-group 1)#incoming-accept-number 256-555-[1,2]XXX

max-channels <value>
Use the max-channels command to specify the maximum number of channels allocated for the integrated
services digital network (ISDN) group. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the maximum number of channels allocated for the ISDN group.
Valid range is from 1 to 255 channels.
Default Values
By default, the maximum number of channels is set to 0. When max-channels is set to 0, the group does
not limit the number of usable channels and can use all available channels. Use the no max-channels
Command History
Usage Examples
The following example sets the maximum number of channels for ISDN group 1 to 50:
(config-isdn-group 1)#max-channels 50

min-channels <value>
Use the min-channels command to specify the minimum number of channels allocated for the integrated
services digital network (ISDN) group. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the minimum number of channels allocated for the ISDN group.
Valid range is from 1 to 255 channels.
Default Values
By default, the minimum number of channels is set to 0. When min-channels is set to 0, no channels are
reserved for this group. This group can use available channels, but does not have any channels
specifically reserved. Use the no min-channels command to return to the default value.
Command History
Usage Examples
The following example sets the minimum number of channels for ISDN group 1 to 10:
(config-isdn-group 1)#min-channels 10


Use the resource pool-member command to assign the group to a resource pool, making it a demand
routing resource. Use the no form of this command to return to the default value.
Syntax Description
<name> Specifies the name of the resource pool to which this group is assigned.
Default Values
By default, the group is not assigned to any resource pool.
Command History
Usage Examples
The following example configures the integrated services digital network (ISDN) group 1 as a member of
resource pool MyPool:
(config-isdn-group 1)#resource pool-member MyPool

Command Reference Guide Voice Operator Ring Group Command Set
VOICE OPERATOR RING GROUP COMMAND SET
Voice operator ring groups are a subset of voice ring groups. Voice ring groups are groups of user accounts
that can be called in a coordinated way with a single extension, and voice operator ring groups are one of
these groups. Ring group members can log in when they want to receive calls from the group, and log out
when they do not want to receive group calls.
Operator ring groups ring all members of the group simultaneously, and contain a single voice mailbox for
the entire group. Operator ring groups can be configured to ring members by using a linear hunt method, in
which calls are distributed to members in the order in which they were added to the group; by using
uniform call distribution (UCD) method, in which calls are distributed to group members in the order in
which they were added to the group in a uniform, round-robin fashion; and by using an all ring method, in
which all members of the group are called and the first extension to pick up receives the call. Operator ring
groups can also be configured to display operator calling-party identification.
Operator ring groups are always tied to extension zero, and calls from the operator ring group have a
special ring cadence called a priority ring. A priority ring has two short rings, a long ring, and then silence.
All other settings for the operator ring group are similar to those of normal ring groups.
For more information on voice operator ring groups and voice ring groups in general, refer to the NetVanta
7000 Series Ring Groups and Operator Groups quick configuration guide (article number 1539) available
online at http://kb.adtran.com, or to the Voice Ring Group Command Set on page 2643.
To activate the Voice Operator Ring Group Configuration mode, enter the voice operator-group
>enable
#configure terminal

do on page 51
exit on page 53
coverage on page 2622

did <number> on page 2624
email <address> on page 2625
email-secondary <address> on page 2626

login-member <number> on page 2627

match ani <template> substitute <template> on page 2628
max-inbound <value> on page 2630
member <number> on page 2631
num-rings <value> on page 2632
prefix on page 2633
sip-identity on page 2634
type on page 2635
voicemail on page 2636

coverage
Use the coverage command to configure call coverage parameters for members of this group. The call
coverage setting determines how a call is handled if the party dialed does not answer after a specified
number of rings. Use the no form of this command to remove an individual coverage parameter. Variations
coverage aa
coverage aa <number>
coverage internal <number>
coverage internal <number> num-rings <value>
coverage override aa
coverage override aa <number>
coverage override internal <number>
coverage override internal <number> num-rings <value>
coverage override vm
coverage override vm <number>
coverage vm
coverage vm <number>
coverage <system mode> aa
coverage <system mode> aa <number>
coverage <system mode> internal <number>
coverage <system mode> internal <number> num-rings <value>
coverage <system mode> vm
coverage <system mode> vm <number>
Syntax Description
<system mode> Optional. Specifies the system mode to use for call coverage. Choose from
custom1, custom2, custom3, lunch, night, or weekend. Refer to the
Functional Notes of this command for more information on configuring
system modes.
aa Forwards the call to the default auto attendant.
aa <number> Forwards the call to a specific extension programmed for the auto
attendant. If no extension is specified, the phone is forwarded to the default
auto attendant.
internal <number> Forwards the call to the specified internal number.
num-rings <value> Optional. Specifies the number of rings for the call before performing the
next action. Valid range is 1 to 9.
override Ignores the programmed system mode schedule.
vm Forwards the call to voicemail.
vm <number> Optional. Forwards the call to the specified mailbox number.
Default Values
By default, no call coverage is specified.

Command History
Release 11.1 Command was updated to include the voicemail and number of rings
options.
Release 12.1 Command was updated to include the auto attendant options.
Release A1 Command was updated to include the system mode feature options.
Functional Notes
System mode call coverage provides more diverse functionality for call handling. In previous versions of
AOS (revision 15.1 or earlier), up to five coverage modes were allowed. Calls were processed in the order
in which the coverage options were entered into the system.
With the addition of the system mode options, up to five coverage options per system mode are allowed.
The system modes can be modified using the command voice system-mode on page 1194.
Usage Examples
The following example specifies that the call be forwarded to the internal extension 8500 after 3 rings.
(config-operator-group)#coverage internal 8500 num-rings 3

did <number>
Use the did command to configure direct inward dialing (DID) for this group. DID is used if a service
provider is providing digits to the unit on inbound calls or if the unit needs to provide DID information to a
piece of customer premises equipment (CPE). Use the no form of this command to disable this feature.
Syntax Description
<number> Defines the DID number assigned to the operator group.
Default Values
Command History
Usage Examples
The following example assigns DID 44 to the operator ring group:
(config-operator-group)#did 44

email <address>
Use the email command to enter the email address for this operator group. Use the no form of this
Syntax Description
<address> Specifies an email address for this group.
Default Values
Command History
Usage Examples
The following example creates an email contact for this group:
(config-operator-group)#email admin@helpdesk.com

email-secondary <address>
Use the email-secondary command to enter a secondary email address for this operator group. Use the no
Syntax Description
<address> Specifies a contact email address for this group.
Default Values
Command History
Usage Examples
The following example creates a secondary email contact for this group:
(config-operator-group)#email-secondary lead@helpdesk.com

login-member <number>
Use the login-member command to log an existing member of the operator group into the system. The
member command must first be used to create a new group member. Use the no form of this command to
disable this feature. Refer to member <number> on page 2631 for more information.
Syntax Description
<number> Specifies the extension number of the user who is logging in.
Default Values
Command History
Functional Notes
This command allows a user to log in and out of an operator group, letting the system know when a user is
available to accept calls.
Usage Examples
The following example logs in the user at extension 4422:
(config-operator-group)#login-member 4422

match ani <template> substitute <template>

Use the match ani substitute command to configure automatic number identification (ANI) substitution
for outbound voice trunks. Use the no form of this command to remove the substitution. Variations of this
command include:

match ani <template> substitute <template> name <name>
Syntax Description
name <name> Optional. Specifies the name associated with the ANI information. This
option is only available on trunks that support ANI name information
(integrated services digital network (ISDN) trunks, Session Initiation
Protocol (SIP) trunks, T1 loop start (LS) network trunks, and T1 ground start
(GS) network trunks).
Default Values
Command History
Functional Notes
The convention for ANI templates is very similar to dial plan entries. Wildcards available for this command
are:



2) 555-812[012] matches 555-8120 to 555-8122.
3) Nxx-xxxx matches 7 digits local.
helpful information regarding the construction of the template and can be viewed by entering the match
ani command followed by a question mark. For example, entering the command as follows results in the
MATCH # SUBST #

Usage Examples
The following example specifies that the ANI information from numbers 555-8111 to 555-8115 will be
substituted by 555-8110 for outbound calls:
(config-operator-group)#match ani 555-811[125] substitute 555-8110

max-inbound <value>
Use the max-inbound command to define the maximum number of calls that can be inbound at the same
time. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the maximum number of calls that can be inbound at the same
time. Range is 1 to 10 calls.
Default Values
By default, the maximum number of inbound calls is set to 1.
Command History
Usage Examples
The following example sets the maximum number of inbound calls to 3:
(config-operator-group)#max-inbound 3

member <number>
Use the member command to create a new member of the operator group. Use the no form of this
command to remove a user’s extension from an operator group.
Syntax Description
<number> Specifies the extension number of the user to be added as an operator
group member.
Default Values
Command History
Functional Notes
A user can log in and out of the operator group using the login-member and no login-member
commands. Refer to login-member <number> on page 2627 for more information.
Usage Examples
The following example adds the user at extension 4422 to the operator ring group:
(config-operator-group)#member 4422

num-rings <value>
Use the num-rings command to specify the number of rings for call pickup before the system redirects the
call. Each system mode call coverage action can be configured with a different number of rings based on
preference. Use the no form of this command to return to the default setting. Variations of this command
include:
num-rings <value>
num-rings <system mode> <value>
num-rings override <value>
Syntax Description
<system mode> Optional. Specifies the system mode to configure for call coverage. Choose
from custom1, custom2, custom3, lunch, night, or weekend. Refer to
the Functional Notes of this command for more information on configuring
system modes.
<value> Specifies the number of rings before the next action. Specify 1 through 9
rings.
Default Values
By default, the maximum number of rings allowed at each extension is 2.
Command History
Functional Notes
Usage Examples
The following example sets the maximum number of rings for the operator ring group to 6:
(config-operator-group)#num-rings 6

prefix
Use the prefix command to turn on the caller ID prefix for this ring group, causing GRP: to display in
front of the caller ID information. Use the no form of this command to turn the prefix off. Variations of
prefix
prefix <prefix>
Syntax Description
<prefix> Optional. Specifies an alphanumeric outbound calling name prefix.
Maximum length is 40 characters.
Default Values
By default, no prefixes are enabled.
Command History
Release A2.04 Command was expanded to include the optional <prefix> parameter.
Usage Examples
The following example turns on the caller ID prefix for the operator ring group:
(config-operator-group)#prefix

sip-identity
Use the sip-identity command to configure the Session Initiation Protocol (SIP) registration options for
the user. Use the no form of this command to disable the setting. Variations of this command include the
following:
sip-identity <station> <Txx>

sip-identity <station> <Txx> register
sip-identity <station> <Txx> register auth-name <username> password <password>
Syntax Description
<station> Specifies the station to be used for SIP trunk (e.g., station extension).
<Txx> Specifies the SIP trunk through which to register the server. The trunk is
specified in the format Txx (e.g., T01).
auth-name <username> Optional. Sets the user name that will be required as authentication for
password <password> Optional. Sets the password that will be required as authentication for
Default Values
Command History
Release 13.1 Command functionality was introduced to this section.
Usage Examples
The following example specifies trunk T02 and extension 4400 for SIP identity:
(config-operator-group)#sip-identity 4400 t02

type
Use the type command to configure the group type for the operator group. Variations of this command
include:
type all
type executive
type linear
type ucd
Syntax Description
all Configures the group as an all-inclusive operator group. When an operator
group call comes in, all phones ring simultaneously.
executive Configures an executive operator group. Refer to email <address> on page
linear Configures the group as a linear hunt operator group. Member phones ring
one at a time until the call is picked up. When the next call comes in, the call
cycle begins again by ringing the first operator group member. Refer to
member <number> on page 2631 for more information.
ucd Configures the group as a uniform call distribution (UCD) operator group.
Member phones ring one at a time until the call is picked up. When the next
call comes in, the system remembers which member extension it last dialed
and then continues the call cycle by ringing the next member in the operator
group.
Default Values
Command History
Usage Examples
The following example configures all phones in the operator ring group to ring each time a call comes in:
(config-operator-group)#type all

voicemail
Use the voicemail command to configure the voicemail options for the user. Use the no form of this
command to disable the settings. Variations of this command include the following:
voicemail attachment-level <dB>

voicemail attachment-level disabled
voicemail auth-mode full
voicemail auth-mode password
voicemail auto-play
voicemail cos <name>
voicemail delete-msg-on-email
voicemail envelope-play
voicemail greeting alternate
voicemail greeting default
voicemail greeting standard
voicemail new-user
voicemail notify email attach-message pcm
voicemail notify email attach-message pcm max-size <size>
voicemail notify email text-only
voicemail oper-assist <number>
voicemail password <password>
Syntax Description
attachment-level <dB> Specifies the number of decibels for voicemail attachment files. Valid entries
are -30, -25, -20, -15, or -10 dB.
attachment-level disabled Disables the automatic gain control (AGC) for voicemail attachments.
auth-mode full Specifies that the extension and password are required to access voicemail.
auth-mode password Specifies that the password is required to access voicemail. Only the
password is required if set to password authentication mode.
auto-play Specifies automatic playback of messages when entering the mailbox.
cos <name> Configures the voicemail class of service (CoS) type by entering the name
of the selected CoS.
delete-msg-on-email Enables deletion of stored voicemail on email attachments.
envelope-play Automatically plays message envelopes during message playback.
greeting alternate Specifies the alternate recorded voicemail greeting to be used.
greeting default Specifies the default voicemail greeting to be used.
greeting standard Specifies the user’s standard recorded voicemail greeting to be used.
new-user Executes the new-user wizard for voicemail configuration.
notify email Specifies sending an email notification when a new voicemail is received.
attach-message Sends the voicemail as a WAV file attachment to the specified email. The
email client must be configured for email options to work.

pcm Indicates message sent as email attachment will be in pulse-code

modulation (PCM) format.
max-size <size> Optional. Indicates truncating email attachments at the specified maximum
size in kilobits (kb). Minimum size entry is 10 kb.
text-only Sends only a text message to the specified email address.
oper-assist <number> Directs all operator calls to the specified phone number.
password <password> Creates the password/personal identification number (PIN) that will be
required to access voicemail.
Default Values
Command History
Release A2 Command was expanded to include the notify email parameters.
Release A2.04 Command was expanded to include attachment-level parameters.
Usage Examples
The following example sets the voicemail CoS to class1:
(config-operator-group)#voicemail cos class1

Command Reference Guide Voice Paging Group Command Set
VOICE PAGING GROUP COMMAND SET
The voice paging group configures handset paging parameters. Handset paging is a feature that provides
paging to select groups of users through their IP phone handset. Handset paging works through a one-way
audio transmission received as a call on individual IP phones, rather than on an overhead speaker using a
private branch exchange (PBX) as overhead paging does. A handset page is initiated by a member of the
paging group and sent to other members of the group. Voice paging groups are defined and organized
using the commands in this section. For more information on using handset paging, refer to the Handset
Paging for the NetVanta 7000 Series quick configuration guide (article number 3102) available online at
To activate the Voice Paging Group Configuration mode, enter the voice paging-group <extension>
command from the Global Configuration mode prompt. For example:

Configuring new paging group “8956”.
(config-8956)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
codec on page 2639

include-paging-port on page 2640
member <extension> on page 2641
page-timeout <seconds> on page 2642

codec
Use the codec command to specify the coder-decoder (CODEC) that is used for the audio of the paging
group. Use the no form of this command to return to the default. Variations of this command include:
codec g711alaw
codec g711ulaw
codec g722
codec g729
Syntax Description
g711alaw Specifies the audio of the paging group is set to G.711 A-Law 64 kilobits per
second (Kbps).
g711ulaw Specifies the audio of the paging group is set to G.711 mu-Law 64 Kbps.
g722 Specifies the audio of the paging group is set to G.722 8 Kbps.
g729 Specifies the audio of the paging group is set to G.729 8 Kbps.
Default Values
By default, the CODEC for the paging group is set to G.729.
Command History
Release A2.04 Command was introduced in the Voice Paging Group.
Functional Notes
The default CODEC used by paging groups is G.729, and is recommended for bandwidth optimization.
Other CODECs can be used when a page initiator or recipient does not support G.729.
This codec command is not to be confused with the codec command used when creating CODEC lists
(refer to Voice CODEC List Command Set on page 2955 or codec on page 2956). This command does not
create a list of CODECs, nor can it be entered multiple times. This codec command, used when
configuring the voice paging group, specifies a single CODEC to be used by the paging group. If another
CODEC is entered from the Voice Paging Group Configuration mode prompt, it will override any previous
CODEC entries.
Usage Examples
The following example specifies the paging group using extension 8956 will use CODEC G.722 for audio:

(config-8956)#codec g722

include-paging-port
Use the include-paging-port command to enable overhead paging for the paging group. Use the no form
of this command to disable overhead paging for the paging group.
Syntax Description
No subcommands.
Default Values
By default, overhead paging is not enabled in paging groups.
Command History
Functional Notes
Enabling the paging port for a handset paging group allows the page to transmit through IP phone
handsets and an overhead paging system. This option will only function if an overhead paging system is
available.
Usage Examples
The following example enables overhead paging for the paging group using extension 8956:

(config-8956)#include-paging-port

member <extension>
Use the member command to add a new member to the paging group. Use the no form of this command to
remove a member from the paging group.
Syntax Description
<extension> Specifies the four-digit extension of the user to add to the paging group.
Default Values
By default, no members are included in a paging group.
Command History
Usage Examples
The following example adds a user at extension 4567 to the paging group using extension 8956:

(config-8956)#member 4567

page-timeout <seconds>
Use the page-timeout command to specify the amount of time page group users have to connect to the
page before the call is started. Use the no form of this command to return to the default value.
Syntax Description
<seconds> Specifies the time (in seconds) that users have to connect to a page before
information is transmitted. Range is 1 to 10 seconds.
Default Values
By default, the page timeout is set to 2 seconds.
Command History
Functional Notes
If no connection is made before the timeout period expires, the paging call is terminated.
Usage Examples
The following example sets the page timeout to 5 seconds for the paging group using extension 8956:

(config-8956)#page-timeout 5

Command Reference Guide Voice Ring Group Command Set
VOICE RING GROUP COMMAND SET
Voice ring groups define groups of user accounts that can be called in a coordinated way with a single
extension. Ring group members can log in when they want to receive calls from the group, and log out
when they do not want to receive group calls.
There are five ring group types to select from when creating a new ring group. The first of these types is a
linear hunt group. In this type of group, calls are distributed to members in the order in which they were
added to the ring group. The second type is the all ring group. In this type of group, all members of the
group are called, and the first extension to answer receives the call. The third type is the uniform call
distribution (UCD) group. In this group type, calls are distributed to members in the order in which they
were added to the group, but in a uniform, round-robin fashion. The fourth type is an executive ring group.
In this group type, calls are made to both the executive’s and assistant’s extensions, but the calls use the
executive’s call coverage. The last type is the operator ring group. This group type is detailed in the Voice
Operator Ring Group Command Set on page 2620.
Ring group’s extensions must be unique and cannot begin with a 0 or a 9. When configuring a new ring
group, the extension defaults to one greater than the highest number ring group extension currently
configured, or 8001 if no ring groups are configured. For more information about specific ring group
configuration, refer to the NetVanta 7000 Series Ring Groups and Operator Groups quick configuration
guide (article number 1539) available online at http://kb.adtran.com.
To activate the Voice Ring Group Configuration mode, enter the voice ring-group command at the Global
>enable
#configure terminal
(config)#voice ring-group xxxx*
(config-xxxx)#
*where xxxx = the ring group’s four-digit extension.

do on page 51
exit on page 53

assistant-extension <number> on page 2645

cos on page 2646
executive-extension <number> on page 2652
login-member <number> on page 2653
member <number> on page 2657
num-rings on page 2658
prefix on page 2659
type on page 2661

assistant-extension <number>
Use the assistant-extension command to tie an assistant’s extension to an executive’s extension.
This command only applies to a ring group of type executive. Refer to type on page 2661
Syntax Description
<number> Specifies the number of the assistant’s extension.
Default Values
Command History
Functional Notes
This command is used in conjunction with the executive-extension command (refer to
executive-extension <number> on page 2652). When the executive’s extension is dialed, both the
assistant’s and the executive’s phones will ring. If neither phone is answered (or both are busy or set to
do-not-disturb (DND)), the call is forwarded through the executive’s call coverage list.
Usage Examples
The following example creates the executive ring group 1234 and causes both the executive (extension
1234) and the assistant (extension 4444) phones to ring when the executive extension is dialed:

(config-1234)#type executive
(config-1234)#executive-extension 1234
(config-1234)#assistant-extension 4444

cos
Use the cos command to set class of service (CoS) mode for the ring group. The CoS can be set to change
for the members of the ring group based on the current system mode by including the system mode
parameter. The CoS defines the types of phone service that will be available to the user during the time
period. Use the no form of this command to disable this feature. Variations of this command include:
cos <name>
cos <system mode> <name>
cos no-access
cos <system mode> no-access
cos override <name>
cos override no-access
Syntax Description
<name> Specifies the predefined CoS.
<system mode> Optional. Specifies the system mode to configure. Choose from custom1,
custom2, custom3, lunch, night, or weekend. Refer to the Functional
Notes of this command for more information on configuring system modes.
no-access Blocks users from placing calls when applied to the CoS.
Default Values
By default, CoS is set to no-access.
Command History
Release A1 Command was expanded to include the system mode options.
Functional Notes
Additional functionality for this feature is provided by assigning a CoS to a specific system mode. When the
system mode changes at a trigger point, the ring group’s CoS changes.
For example, a CoS applied to the ring group when the system mode is specified as night can be used to
prevent outbound calls during evening hours. System modes are defined from the Global Configuration
mode using the command voice system-mode on page 1194.
Usage Examples
The following example assigns the CoS Assistant to the ring group 1234:

(config-1234)#cos Assistant

coverage
Use the coverage command to configure call coverage parameters for members of this group. The call
coverage setting determines how a call is handled if the party dialed does not answer after a specified
number of rings. Use the no form of this command to remove an individual coverage parameter. Variations
coverage aa
coverage operator
coverage operator num-rings <value>
coverage override aa
coverage override aa <number>
coverage override external <number>
coverage override operator
coverage override operator num-rings <value>
coverage vm
coverage <system mode> external <number>
coverage <system mode> operator
coverage <system mode> operator num-rings <value>
Syntax Description
system modes.
auto attendant.
external <number> Forwards the call to the specified external number. If no number is entered,
the default auto answer is used.


operator Forwards the call to the operator.
vm <number> Optional. Forwards the phone to the specified mailbox number.
Default Values
Command History
options.
Release 12.1 Command was updated to include the auto attendant and operator options.
Functional Notes
Usage Examples
The following example specifies that calls to the ring group 1234 be forwarded to the internal extension
8500 when in the night system mode.

(config-1234)#coverage night internal 8500

did <number>
Use the did command to configure direct inward dialing (DID) for this group. DID is used if a service
provider is providing digits to the unit on inbound calls or if the unit needs to provide DID information to a
piece of customer premises equipment (CPE). Use the no form of this command to disable this feature.
Syntax Description
<number> Defines the DID number assigned to the ring group.
Default Values
Command History
Usage Examples
The following example assigns DID 44 to the ring group 1234:

(config-1234)#did 44

email <address>
Use the email command to enter the email address for this user’s group. Use the no form of this command
to disable this feature.
Syntax Description
<address> Specifies an email address for this group.
Default Values
Command History
Usage Examples
The following example creates an email contact for this group:

(config-1234)#email admin@helpdesk.com

Use the email-secondary command to enter a secondary email address for this user’s group. Use the no
Syntax Description
<address> Specifies a contact email address for this group.
Default Values
Command History
Usage Examples
The following example creates a secondary email contact for this group:

(config-1234)#email-secondary lead@helpdesk.com

executive-extension <number>
Use the executive-extension command to tie an executive’s extension to an assistant’s extension.
This command only applies to type executive ring group(s). Refer to type on page 2661 for
more information.
Syntax Description
<number> Specifies the number of the executive’s extension.
Default Values
Command History
Functional Notes
This command is used in conjunction with the assistant-extension command (refer to assistant-extension
<number> on page 2645). When the executive’s extension is dialed, both the assistant’s and the
executive’s phones will ring. If neither phone is answered (or both are busy or set to do-not-disturb (DND)),
the call is forwarded through the executive’s call coverage list.
Usage Examples
The following example creates the executive ring group 1234 and causes both the executive (extension
1234) and the assistant (extension 4444) phones to ring when the executive extension is dialed:

(config-1234)#type executive
(config-1234)#executive-extension 1234
(config-1234)#assistant-extension 4444

login-member <number>
Use the login-member command to log an existing member of the ring group into the system. You must
first use the member command to create a new group member. Use the no form of this command to disable
this feature. Refer to member <number> on page 2657 for more information.
Syntax Description
<number> Specifies the extension number of the user who is logging in.
Default Values
Command History
Functional Notes
This command allows a user to log in and out of a ring group, letting the system know when a user is
available to accept calls.
Usage Examples
The following example logs in the user at extension 4422:

(config-1234)#login-member 4422


command include:

Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples
substituted by 555-8110 for outbound calls for voice ring group 1234:

(config-1234)#match ani 555-811[125] substitute 555-8110

max-inbound <value>
Use the max-inbound command to define the maximum number of calls that can be inbound at the same
time. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies the maximum number of calls that can be inbound at the same
time. Range is 1 to 10 calls.
Default Values
By default, the maximum number of inbound calls is set to 1.
Command History
Usage Examples
The following example sets the maximum number of inbound calls on ring group 1234 to 3:

(config-1234)#max-inbound 3

member <number>
Use the member command to create a new member of the ring group. Use the no form of this command to
remove a user’s extension from a ring group.
Syntax Description
<number> Specifies the extension number of the user you want to add as a ring group
member.
Default Values
Command History
Functional Notes
A user can log in and out of the ring group using the login-member and no login-member commands.
Refer to login-member <number> on page 2653 for more information.
Usage Examples
The following example adds the user at extension 4422 to the ring group 1234:

(config-1234)#member 4422

num-rings
include:
num-rings <value>
Syntax Description
system modes.
rings. Entering 0 specifies an unlimited number of rings.
Default Values
By default, the num-rings is set to 4.
Command History
Usage Examples
The following example sets the number of rings for this ring group to 6:

(config-1234)#num-rings 6

prefix
Use the prefix command to turn on the caller ID prefix for this ring group, causing GRP: to display in
front of the caller ID information. Use the no form of this command to turn the prefix off. Variations of
prefix
prefix <prefix>
Syntax Description
<prefix> Optional. Specifies an alphanumeric outbound calling name prefix.
Maximum length is 40 characters.
Default Values
By default, no prefixes are enabled.
Command History
Release A2.04 Command was expanded to include the optional <prefix> parameter.
Usage Examples
The following example turns on the caller ID prefix for ring group 1234:

(config-1234)#prefix

sip-identity
the user. Use the no form of this command to disable the settings. Variations of this command include the
following:

Syntax Description
Default Values
Command History
Usage Examples

(config-1234)#sip-identity 4400 T02

type
Use the type command to configure the group type for the ring group. Variations of this command include:
type all
type executive
type linear
type ucd
Syntax Description
all Configures the group as an all-inclusive ring group. When a ring group call
comes in, all phones ring simultaneously.
executive Configures an executive ring group. Refer to executive-extension
<number> on page 2652 for more information.
linear Configures the group as a linear hunt ring group. Member phones ring one
at a time until the call is picked up. When the next call comes in, the call
cycle begins again by ringing the first ring group member. Refer to member
<number> on page 2657 for more information.
ucd Configures the group as a uniform call distribution (UCD) ring group.
Member phones ring one at a time until the call is picked up. When the next
call comes in, the system remembers which member extension it last dialed
and then continues the call cycle by ringing the next member in the ring
group.
Default Values
Command History
Usage Examples
The following example configures the ring group 1234 to ring all phones in the ring group each time a call
comes in:

(config-1234)#type all

voicemail

voicemail auto-play
voicemail new-user
Syntax Description
are -30, -25, -20, -15, or -10 dB.


Default Values
Command History
Usage Examples
The following example sets the voicemail CoS for this user to class1:

(config-1234)#voicemail cos class1


Use the voice match ani substitute command to configure automatic number identification (ANI)
substitution for inbound voice trunks. Use the no form of this command to remove the substitution.
Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #
6) XXXX$ $ (Strip leading digits )

5) If using a "$" wildcard, it mus t be at the end of the number.
6) "X" matc hes [0-9], "N" matches [2-9].
Usage Examples
The following example specifies that the ANI information from numbers 555-8111 to 555-8115 on all
inbound trunks will be substituted by 555-8110:

(config)#voice match ani 555-811[125] substitute 555-8110

Command Reference Guide Voice Trunk Group Command Set
VOICE TRUNK GROUP COMMAND SET
Voice trunks are digital or analog subscriber lines delivered by service providers that allow communication
devices to connect to the outside world. Voice trunk groups combine one or more trunk accounts and
assign outbound call characteristics to the group. Individual trunk groups can be created for each trunk
account. The trunk group is assigned outbound call capabilities (local calls, long distance calls, etc.).
Additionally, a cost is assigned to each attribute in the outbound call template.
To create a trunk group, you must first configure individual trunk accounts. For more information on
creating voice trunk accounts, refer to the following sections of this document:
• Voice Analog Trunk Command Set on page 2679

• Voice SIP Trunk Command Set on page 2752
• Voice T1 Trunk Command Set on page 2798
For more information about configuring trunk groups, refer to the NetVanta 7000 Series Trunk Accounts
Integrated services digital network (ISDN) trunk groups are created using the command
isdn-group <number> on page 1003. For more information regarding the creation of
ISDN trunk groups, refer to the Voice ISDN Group Command Set on page 2611.
To enter the Voice Trunk Group Configuration mode, enter the voice grouped-trunk command at the
>enable
#configure terminal
(config)#voice grouped-trunk TestGroup
(config-TestGroup)#
do on page 51
exit on page 53

accept <pattern> on page 2668

deny on page 2670
permit on page 2673
reject <pattern> on page 2674
resource-selection on page 2676
trunk <Txx> on page 2677

accept <pattern>
Use the accept command to specify numbers that users can dial on the trunk. This command controls the
type of outbound calls users can place on the system. Use the no form of this command to remove a
configured dial pattern and return to the default setting. Variations of this command include:
accept <pattern>
accept <pattern> cost <value>
Syntax Description
<pattern> Specifies the patterns users can dial on the trunk. You can enter a complete
phone number or wildcards can be used to help define accepted numbers.
Refer to Functional Notes below for more information on using wildcards.
cost <value> Specifies the cost value for the trunk. This option is used if a call is accepted
by several trunks. The call will be routed to the trunk with the lowest cost
value. The valid range is 0 to 499.
Default Values
By default, the cost value is zero.
Command History
Functional Notes

Examples:1) 555-81xx matches 555-8100 to 555-8199.

2) 555-812[012] matches 555-8120 to 555-8122.
3) 1-800$ matches any 1-800 calls.

Usage Examples
The following example allows users on the trunk TestGroup to dial any local number:

(config-TestGroup)#accept Nxxxxxx

deny
Use the deny command to add a proxy, automatic number identification (ANI) list, or trunk list to a voice
trunk group’s deny policy. Use the no form of this command to remove the proxy, ANI list, or trunk list
from the deny policy. Variations of this command include:
deny list <name>

deny proxy
Syntax Description
list <name> Specifies that either a trunk list or ANI list is added to the trunk group’s deny
policy.
proxy Specifies that the proxy is added to the trunk group’s deny policy.
Default Values
By default, no list or proxy is part of the trunk group’s deny policy.
Command History
Functional Notes
The trunk and ANI lists are created as part of the Source and ANI Based Routing (SABR) feature on AOS
voice products. For more information about SABR, refer to the SABR in AOS configuration guide available
on the AOS Documentation CD shipped with your product or online at http://kb.adtran.com (article
number 2510). For more information about creating ANI or trunk lists, refer to voice ani-list <name> on
page 1129 or voice trunk-list <name> on page 1200.
Although there is no limit on the number of lists applied to voice trunk groups, it is
important to remember that the more lists that are applied to a trunk group, the more the
runtime performance of call routing will be affected.
Usage Examples
The following example applies the TEST2 list to the deny policy of trunk group TestGroup:

(config-TestGroup)#deny list TEST2


command include:

Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples
substituted by 555-8110 for outbound calls for trunk group TestGroup:

(config-TestGroup)#match ani 555-811[125] substitute 555-8110

permit
Use the permit command to add a proxy, automatic number identification (ANI) list, or trunk list to a
voice trunk group’s permit policy. Use the no form of this command to remove the proxy, ANI list, or
trunk list from the permit policy. Variations of this command include:
permit list <name>

permit proxy
Syntax Description
list <name> Specifies that either a trunk list or ANI list is added to the trunk group’s
permit policy.
proxy Specifies that the proxy is added to the trunk group’s permit policy.
Default Values
By default, no list or proxy is part of the trunk group’s permit policy.
Command History
Functional Notes
The trunk and ANI lists are created as part of the Source and ANI Based Routing (SABR) feature on AOS
voice products. For more information about SABR, refer to the SABR in AOS configuration guide available
on the AOS Documentation CD shipped with your product or online at http://kb.adtran.com (article
number 2510). For more information about creating ANI or trunk lists, refer to voice ani-list <name> on
page 1129 or voice trunk-list <name> on page 1200.
Although there is no limit on the number of lists applied to voice trunk groups, it is
important to remember that the more lists that are applied to a trunk group, the more the
runtime performance of call routing will be affected.
Usage Examples
The following example applies the TEST1 list to the permit policy of trunk group TestGroup:

(config-TestGroup)#permit list TEST1

reject <pattern>
Use the reject command to specify numbers users cannot dial on the trunk. This feature allows
administrators to restrict callers from unwanted outbound calls, such as international calls and 900
numbers. Use the no form of this command to disable this feature.
Syntax Description
<pattern> Specifies the patterns that users cannot dial on the trunk. You can enter a
complete phone number or wildcards can be used to help define rejected
numbers. Refer to Functional Notes below for more information on using
wildcards. For example, you can enter 900$ to prevent users from dialing all
900 numbers.
Default Values
Command History
Functional Notes

Examples:1) 555-81xx matches 555-8100 to 555-8199.

2) 555-812[012] matches 555-8120 to 555-8122.

Usage Examples
The following example blocks calls to any 900 number on the trunk TestGroup:

(config-TestGroup)#reject 900$

resource-selection
Use the resource-selection command to determine how the switchboard uses outbound call resources
contained within a time division multiplexing (TDM) based trunk group. Use the no form of this command
to disable this feature. Variations of this command include:
resource-selection circular
resource-selection circular ascending
resource-selection circular descending
resource-selection linear
resource-selection linear ascending
resource-selection linear descending
Syntax Description
circular Performs call load balancing among available DS0s/B-channels in this
trunk. Subsequent calls will be delivered to the next available
DS0/B-channel in a round-robin fashion.
linear Specifies that a call being delivered to this trunk will be accepted out the first
available DS0/B-channel available at the time the call is received.
ascending Optional. Distributes calls in an order from the lowest to the highest channel
(DS0 1, 2, 3 through 24).
descending Optional. Distributes calls in an order from the highest to the lowest channel
(DS0 24, 23, 22 through 1).
Default Values
By default, resource selection is set to linear.
Command History
Release 13.1 Command was expanded to include the ascending and descending
subcommands.
Usage Examples
The following example specifies circular resource selection on the trunk TestGroup:

(config-TestGroup)#resource-selection circular

trunk <Txx>
Use the trunk command to add an existing trunk to the trunk group so outbound calls may be placed out
that particular trunk as well. Use the no form of this command to remove a configured trunk group.
Syntax Description
<Txx> Specifies an ID number for the trunk. The trunk ID is in the format Txx
where xx is the trunk ID number. Enter a trunk ID between 1 and 99. For
example, trunk T02.
Default Values
Command History
Usage Examples
The following example adds trunk T02 to the trunk group TestGroup:

(config-TestGroup)#trunk t02

VOICE TRUNKS COMMAND SETS

• Voice Analog Trunk Command Set on page 2679

• Voice ISDN Trunk Command Set on page 2718
• Voice SIP Trunk Command Set on page 2752
• Voice T1 Trunk Command Set on page 2798

Command Reference Guide Voice Analog Trunk Command Set
VOICE ANALOG TRUNK COMMAND SET
Voice analog trunks are analog subscriber lines delivered by service providers that allow communication
devices to connect to the outside world. To configure analog trunks, you must first configure the foreign
exchange office (FXO) physical interface. By default, FXO interfaces are enabled, but their status must be
verified before creating an analog trunk. For more information on configuring and verifying FXO
interfaces, refer to the FXO Interface Command Set on page 1428.
Once the FXO interface is configured, a trunk account must be created for the analog trunk to make and
receive calls. When creating trunk accounts, you must assign an FXO port to the trunk, and make sure the
analog FXO settings (trunk number, supervision, etc.) match the parameters set by your service provider.
There are three main types of analog trunks supported by AOS. The first type is a dial pulse terminate
(DPT) analog trunk, the second type is a loop start (LS) analog trunk, and the third is a ground start (GS)
analog trunk. Configuration commands for all three analog trunk types are included in this section. For
more information about configuring analog trunks, refer to the NetVanta 7000 Series Trunk Accounts
configuration guide (article number 1541) available online at http://kb.adtran.com.
To enter the Voice Analog Trunk DPT Configuration mode, enter the following command at the Global
>enable
#configure terminal
(config)#voice trunk t01 type analog supervision dpt
(config-t01)#
To enter the Voice Analog Trunk LS Configuration mode, enter the following command at the Global
>enable
#configure terminal
(config)#voice trunk t01 type analog supervision loop-start
(config-t01)#
To enter the Voice Analog Trunk GS Configuration mode, enter the following command at the Global
>enable
#configure terminal
(config)#voice trunk t01 type analog supervision ground-start
(config-t01)#
Not all Voice Analog Trunk commands apply to all analog trunk types. Use the ? command
to display a list of valid commands.

do on page 51
exit on page 53
alc on page 2682

blind-dial on page 2683
busy all on page 2684
busy fxo <slot/port> on page 2685
busy range fxo <range> on page 2686
connect fxo <slot/port> on page 2690
connect range fxo <range> on page 2691
did digits-transferred <value> on page 2692
early-cut-through on page 2693
match dnis <template> substitute <template> on page 2697
plc on page 2700
prefer trunk-routing on page 2701
reject-external on page 2702
trunk-number <number> on page 2709
t38 on page 2710


vad on page 2717

alc
alc
alc level -16
alc level -17
alc level -18
alc level -19
alc level -20
alc level -21
alc level -22
Syntax Description
Default Values
Command History
Usage Examples
The following example activates ALC on trunk T01:

(config-t01)#alc

blind-dial
Use the blind-dial command to allow calls to be placed without the presence of dial tone. Use the no form
of this command to disable blind dialing.
Syntax Description
No subcommands.
Default Values
By default, blind-dial is disabled.
Command History
Usage Examples
The following example enables blind dialing:

(config-t01)#blind-dial

busy all
Use the busy all command to set all level zero digital signals (DS0s) to busy so that no calls are allowed
inbound or outbound. If any calls are active at the time this command is issued, the calls will stay active
until either party terminates the call. Once terminated, the DS0s are busied out. Use the no form of this
busy all
busy all now
Syntax Description
now Optional. Immediately terminates calls that are active at the time the
command is issued (for example, in the middle of a conversation).
Default Values
Command History
Release 11.1 Command was expanded to include the analog voice trunk.
Usage Examples
The following example sets all DS0s on trunk T01 to busy and terminates calls that are active at the time
the command is issued:

(config-t01)#busy all now

busy fxo <slot/port>

Use the busy fxo command to set a DS0 to busy so that no calls are allowed inbound or outbound. If a call
is active at the time this command is issued, the call will stay active until either party terminates the call.
Once terminated, the DS0 is set to busy. Use the no form of this command to disable this feature.
busy fxo <slot/port>

busy fxo <slot/port> now
Syntax Description
<slot/port> Specifies the slot/port for the foreign exchange office (FXO).
now Optional. Immediately terminates active call at the time the command is
issued (for example, in the middle of a conversation).
Default Values
Command History
Usage Examples
The following example sets FXO 0/1 to busy and terminates an active call when the command is issued:

(config-t01)#busy fxo 0/1 now

busy range fxo <range>

Use the busy range fxo command to set a particular set of level zero digital signals (DS0s) to busy so that
no calls are allowed inbound or outbound. If any calls are active at the time this command is issued, the
calls will stay active until either party terminates the call. Once terminated, the DS0s are set to busy. Use
the no form of this command to return to the default setting. Variations of this command include:
busy range fxo <range>

busy range fxo <range> now
Syntax Description
<range> Specifies a range of ports in the format <slot/begin port range-end port
range> (for example, 0/1-4).
now Optional. Terminates calls that are active at the time the command is issued
(for example, in the middle of a conversation).
Default Values
Command History
Usage Examples
The following example sets DS0s to busy and terminates calls assigned to port range fxo 0/1 through
fxo 0/4 when the command is issued:

(config-t01)#busy range fxo 0/1-4 now

caller-id
Use the caller-id command to interpret and pass caller identification (ID) on this trunk. This information
usually displays the name, number, time, and date of the calling party. Use the no form of this command to
cancel the setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables caller ID:

(config-t01)#caller-id

caller-id-override
Use the caller-id-override command to replace the calling party information for this trunk with a specific
number. This command is used to conceal user’s name and number or to display a different name and
number for internal or external caller ID. Use the no form of this command to cancel the setting. Variations
caller-id-override emergency-outbound <number>

caller-id-override number-inbound <number>
caller-id-override number-inbound <number> if-no-cpn
caller-id-override number-inbound <number> <trunk id>
Syntax Description
<number> Specifies the number to display on caller ID.
<trunk id> Specifies the trunk ID (Txx) for outbound calls.
emergency-outbound Specifies the calling party number on outbound emergency calls.
number-inbound Specifies the calling party number on inbound calls.
if-no-cpn Specifies overriding caller ID only if calling party is not available.
Default Values
Command History
Release 16.1 Command was expanded to include the if-no-cpn subcommand.
Usage Examples
The following example sets the caller ID override number on the trunk where the command is issued:

(config-t01)#caller-id-override number 555-8000

codec-group <name>
Syntax Description
Default Values
Command History
(ISDN) trunk.
command set.
Functional Notes
on page 2955.
Usage Examples
The following example applies the CODEC list List1 to the trunk:

(config-t01)#codec-group List1

connect fxo <slot/port>

Use the connect fxo command to specify the physical interface this trunk will use for voice calls. Use the
no form of this command to remove this association.
Syntax Description
<slot/port> Specifies the slot/port for the foreign exchange office (FXO) trunk.
Default Values
By default, no physical interface is assigned.
Command History
Usage Examples
The following example specifies this trunk to use port fxo 0/1:

(config-t01)#connect fxo 0/1

connect range fxo <range>

Use the connect range fxo command to specify the range of physical interfaces for this trunk group usage.
Syntax Description
<range> Specifies a range of ports in the format <slot/begin port range-end port
range> (for example, 0/1-4).
Default Values
Command History
Usage Examples
The following example specifies that this analog loop start (LS) trunk will use the contiguous port range
fxo 0/1 through fxo 0/4:

(config-t01)#connect range fxo 0/1-4

did digits-transferred <value>

Use the did digits-transferred command to define how many of the received digits should be sent to the
internal switchboard from an incoming call on a user role trunk. The number of digits transferred are the
least significant digits received. Direct inward dialing (DID) should be used if a Telco provider is
providing digits to the unit on inbound calls or if the unit needs to provide DID information to a piece of
customer premises equipment (CPE). Use the no form of this command to disable this feature. Variations

did digits-transferred <value> prefix <number>
Syntax Description
<value> Specifies the number of digits to be transferred. Range is 1 to 16 digits.
prefix <number> Optional. Specifies a sequence of digits to be prepended to the digits that
will be transmitted. For example, if seven digits will be transferred via DID,
then prefix the seven digits with 256. Thus, 555-8000 would be prefixed
with 256, transmitting out the string of digits 256-555-8000.
Default Values
Command History
Functional Notes
User Role Example:
555-1000 is an incoming call on the trunk. With did digits-transferred <value> set to 4, the number 1000
will be sent to the switchboard. On a network role trunk, the did digits-transferred command allows you to
define how many of the digits from the Accept criteria should be sent externally from a call that was routed
by the switchboard. The number of digits transferred are the least significant digits received.
Network Role Example:
555-1000 is accepted on the universal time (UT) interface. With did digits-transferred <value> set to 4,
the number of 1000 will be sent to the device connected to the UT interface. This command cannot be
specified if and when trunk-number is being used. Conversely, if DID is used, trunk-number will not be
allowed.
Usage Examples

(config-t01)#did digits-transferred 5558000 prefix 256

early-cut-through
Use the early-cut-through command to provide the caller with inband ringback and other call progress
signals. This command should not be issued if the connected equipment does not provide inband ringback
and other call progress signals. This option is only valid for voice trunks in the network role. Use the no
Syntax Description
No subcommands.
Default Values
By default, early-cut-through is disabled.
Command History
Usage Examples
The following example activates early-cut-through:

(config-t01)#early-cut-through

echo-cancellation
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates echo-cancellation:

(config-t01)#echo-cancellation


command include:

Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples
substituted by 555-8110 for outbound calls on the trunk T03:

(config-t03)#match ani 555-811[125] substitute 555-8110

match dnis <template> substitute <template>

Use the match dnis substitute command to configure dialed number identification service (DNIS)
substitution for outbound voice trunks. Use the no form of this command to remove the substitution.

match dnis <template> substitute <template> name <name>
Syntax Description
dnis <template> Specifies the DNIS information to be substituted. This information is entered
substitute <template> Specifies the DNIS information that is substituted for the original DNIS
name <name> Optional. Specifies the name associated with the DNIS information. This
option is only available on trunks that support DNIS name information
Default Values
By default, no DNIS substitution is configured.
Command History
Functional Notes
The convention for DNIS templates is very similar to dial plan entries. Wildcards available for this
command are:


2) 555-812[012] matches 555-8120 to 555-8122.
dnis command followed by a question mark. For example, entering the command as follows results in the
(config)#match dnis ?
MATCH # SUBST #

Usage Examples
The following example specifies that the DNIS information for dialed numbers on trunk T03 that match
1-334-NXX-XXXX are substituted with 1-800-557-4500:

(config-t03)#match dnis 1-334-NXX-XXXX substitute 1-800-557-4500

modem-passthrough
of this command to disable this feature. Variations of this command include:
modem-passthrough
modem-passthrough detection-time <value>
Syntax Description
detection-time <value> Optional. Specifies the fax and/or modem detection time length value in
seconds. Range is 0 to 8 seconds.
Default Values
Command History
Usage Examples
The following example disables modem-passthrough:

(config-t01)#no modem-passthrough

plc
Syntax Description
No subcommands.
Default Values
By default, PLC is enabled on this interface.
Command History
Usage Examples
The following example disables PLC on trunk T01:

(config-t01)#no plc

prefer trunk-routing
Use the prefer trunk-routing command to add a trunk to a list of trunks that are considered first for call
routing, regardless of system routing mode or locally configured extensions. Use the no form of this
command to remove the trunk from the list.
Syntax Description
No subcommands.
Default Values
By default, prefer trunk-routing is disabled.
Command History
Functional Notes
Trunk routing can be specified as a preference for specific trunks, allowing the trunk to be considered first
for routing rather than relying on the internal or external nature of the call to dictate whether the trunk or
voice station is the first choice routing path. The prefer trunk-routing command, executed from a specific
trunk’s configuration mode, adds the trunk to a list of trunks that are considered first for routing.
By default, no trunk routing preference is set, so that each trunk operates as dictated by normal call routing
modes. Adding the trunk routing preference only affects how inbound calls from the specific trunk are
handled.
Usage Examples
The following example specifies that trunk routing is preferred on the trunk T01:

(config-t01)#prefer trunk-routing

reject-external
Use the reject-external command to prevent inbound calls on the trunk from being routed back out of the
same trunk. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, reject-external is enabled on this interface.
Command History
Functional Notes
In general, trunks are assigned to the user role, which means they terminate lines from a Telco provider. If
this is the case, reject-external should be enabled so that inbound calls on the trunk cannot be routed
back out of the same trunk. If the configuration is poor, inbound long distance calls could be routed back
out the same trunk, causing the owner of the unit to be charged for long distance calls without his
knowledge. For network-role trunks and Session Initiation Protocol (SIP) based trunks, this command
should be disabled to allow calls to be properly routed in the unit.
Usage Examples
The following example disables reject-external:

(config-t01)#no reject-external

resource-selection
Syntax Description
(DS0 1, 2, 3 through 24).
(DS0 24, 23, 22 through 1).
Default Values
Command History
subcommands.
Usage Examples
The following example specifies circular resource selection:

(config-t01)#resource-selection circular

rtp delay-mode
command include:

Syntax Description
Default Values
Command History
Usage Examples
The following example configures RTP delay mode as fixed:

(config-t01)#rtp delay-mode fixed

rtp dtmf-relay

Syntax Description
event (NTE). Enter an NTE value between 96 and 127.
Default Values
Command History
Usage Examples

(config-t01)#rtp dtmf-relay inband


packetization time in milliseconds for individual trunks and users. Use the no form of this command to
Syntax Description
Default Values
By default, the rtp frame-packetization time is set to 20 milliseconds on all trunks and users.
Command History
Usage Examples
The following example sets the frame packetization time for trunk T01 to 10 milliseconds:

(config-t01)#rtp frame-packetization 10

rtp packet-delay

Syntax Description
fax <value> Sets the fax delay time value. Range is 0 to 500 milliseconds.
Default Values
By default, the RTP packet delay for fax is 300, maximum is 100, and nominal is 50.
Command History
Usage Examples
The following example configures the RTP fax delay time on trunk T01 to 200 milliseconds:

(config-t01)#rtp packet-delay fax 200


Syntax Description
10 and 63.
Default Values
By setting the rtp qos dscp value on an individual trunk or user, you will override the global rtp qos dscp
setting for RTP packets.
Command History
Functional Notes
setting for RTP packets. QoS is set using a DSCP value. Valid DSCP values are 10 to 63, and a higher
DSCP value has a higher priority. The default DSCP value for RTP is 46. Remember that if you are using a
public IP connection, such as the Internet, for Voice over Internet Protocol (VoIP), end-to-end QoS may not
be guaranteed. The default DSCP value for Session Initiation Protocol (SIP) is 26. To configure QoS for
the RTP traffic that carries the voice conversation, use the command ip rtp qos dscp followed by the
desired DSCP value.
Usage Examples
The following example configures the RTP QoS DSCP for trunk T02 to 60:

(config-t02)#rtp qos dscp 60

trunk-number <number>
Use the trunk-number command to define the call routing when direct inward dialing (DID) is disabled.
This feature directs incoming calls to the specified number when DID is not present. This command also
allows users to activate different system modes of operation that redirect incoming calls to a different
number depending on the specified mode. Use the no form of this command to disable this feature.
trunk-number no-number
trunk-number <system mode> <number>
trunk-number <system mode> no-number
trunk-number override <number>
trunk-number override no-number
Syntax Description
<number> Specifies the number used for call routing when DID is disabled.
custom2, custom3, lunch, night, or weekend. Refer to the command
voice system-mode on page 1194 for more information on system modes.
no-number Specifies no inbound calls are allowed on this trunk.
Default Values
Command History
Release 15.1 Command was added to the feature group D (FGD) trunk options.
Release A1 Command was expanded to include the new subcommands.
Usage Examples
The following example defines call routing on trunk T03:
(config)#voice trunk t03 type t1-rbs supervision fgd role user

(config-t03)#trunk-number 4000

t38
Use the t38 command to enable T.38 fax operation. Use the no form of this command to disable this
feature.
The command modem-passthrough on page 2699 must be enabled for T.38 operation to
work.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables T.38 on trunk T03:

(config-t03)#t38
Technology Review
Protocol (SIP), and Media Gateway Control Protocol (MGCP). AOS only supports SIP as the call-control
method. This is typically referred to T.38/Annex-D. Annex-D describes the Session Initiation
Protocol/Session Description Protocol (SIP/SDP) call establishment procedures.


Syntax Description
Default Values
By default, t38 error-correction is set to redundancy.
Command History
Usage Examples
The following example sets the t38 error-correction to fec on trunk T03:

(config-t03)#t38 error-correction fec


feature.
Syntax Description
Default Values
Command History
Usage Examples
The following example enables the t38 fallback-mode on trunk T03:

(config-t03)#t38 fallback-mode g711


Use the t38 max-buffer command to set the maximum buffer size for T.38 fax operation. Use the no form
Syntax Description
400 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-buffer to 100 on trunk T03:

(config-t03)#t38 max-buffer 100


Use the t38 max-datagram command to set the maximum datagram value in this unit. Use the no form of
Syntax Description
<value> Specifies the value of the max-datagram attribute in the Session
Description Protocol (SDP) offer when the T.38 session is initiated. Range is
0 to 300 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-datagram to 100 on trunk T03:

(config-t03)#t38 max-datagram 100

t38 max-rate
Use the t38 max-rate command to specify the fax maximum rate. The actual transmission rate may be
lower than specified rate if the receiving end cannot support the maximum rate. Use the no form of this
t38 max-rate 14400

t38 max-rate 12000
t38 max-rate 2400
t38 max-rate 4800
t38 max-rate 7200
t38 max-rate 9600
Syntax Description
Default Values
Command History
Usage Examples
The following example sets the t38 max-rate to 4800 on trunk T03:

(config-t03)#t38 max-rate 4800

t38 redundancy
error-correction redundancy feature is enabled. Use the no form of this command to return to the default

Syntax Description
Default Values
Command History
Usage Examples
messages to 3 on trunk T03:

(config-t03)#t38 error-correction redundancy
(config-t03)#t38 redundancy high-speed 3

vad
Use the vad command to enable voice activity detection (VAD). VAD blocks out noise categorized as
silence during a voice connection. The silent voice packets are not transmitted, allowing bandwidth usage
to be reduced. Although VAD saves bandwidth, the quality of the voice call may be compromised. Use the
Syntax Description
No subcommands.
Default Values
By default, VAD is enabled for all T1 robbed bit signaling (RBS) trunks and users.
Command History
Usage Examples
The following example disables VAD on trunk T01:

(config-t01)#no vad

Command Reference Guide Voice ISDN Trunk Command Set
VOICE ISDN TRUNK COMMAND SET
The integrated services digital network (ISDN) primary rate interface (PRI) is a circuit composed of
23 bearer (B) channels and 1 data (D) channel. ISDN PRI is an international standard for digital
communications, allowing a full range of enhanced services supporting voice and data. The 23 B channels
are used to transmit voice or data over an all-digital public switched telephone network (PSTN). The
D channel is used to transmit out-of-band (OOB) signaling for the B channels and controls dialing numbers
and features such as call waiting.
Voice ISDN trunks are digital subscriber lines delivered by service providers that connect communication
devices through the PRI interface to the outside world. In order to configure ISDN trunks, you must
configure a trunk account to make and receive calls. To do this, you create a trunk account (using the
command voice trunk <trunk id> type on page 1201) and assign the PRI interface (using the command
cross-connect on page 47). When you configure the trunk account, make sure the PRI settings (trunk
number, caller ID, etc.) match the parameters set by your service provider. For more information about the
creation and use of ISDN trunks, refer to the Total Access 900 Series ISDN PRI Interface quick
configuration guide (article number 1538) or the NetVanta 7000 Series Trunk Accounts configuration
guide (article number 1541) available online at http://kb.adtran.com.
To create an ISDN trunk account and enter the Voice ISDN Trunk Configuration mode, enter voice trunk
<trunk id> type isdn at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#voice trunk t01 type isdn
(config-t01)#
exit on page 53
alc on page 2720

connect isdn-group <number> on page 2723
match dnis <template> replace ani <number> on page 2727


plc on page 2732
rtp rx-gain <value> on page 2741
rtp tx-gain <value> on page 2742
t38 on page 2744
vad on page 2751

alc
alc
alc level -16
alc level -17
alc level -18
alc level -19
alc level -20
alc level -21
alc level -22
Syntax Description
Default Values
Command History
Usage Examples
The following example activates the ALC for the trunk:

(config-t01)#alc

caller-id-override

Syntax Description
<trunk id> Specifies the trunk ID (Txx) for outbound calls.
if-no-cpn Specifies overriding caller ID only if calling party is not available.
Default Values
Command History
Usage Examples


codec-group <name>
Syntax Description
Default Values
Command History
(ISDN) trunk.
command set.
Functional Notes
on page 2955.
Usage Examples


connect isdn-group <number>

Use the connect isdn-group command to associate a trunk with an integrated services digital network
(ISDN) group. The ISDN group number uniquely identifies an ISDN trunk group. Use the no form of this
command to remove this association.
Syntax Description
<number> Specifies the ISDN group number. Range is 1 to 255.
Default Values
By default, no group is defined.
Command History
Release 11.1 Command was expanded to include the ISDN trunk.
Usage Examples
The following example specifies that this trunk will use the ISDN group 1:

(config-t01)#connect isdn-group 1

echo-cancellation
Voice over IP (VoIP) or Media Gateway Control Protocol (MGCP). Enabling this command may
significantly improve the voice quality in calls across the telephone network. Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
(ISDN) trunk.
Usage Examples



command include:

Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples


match dnis <template> replace ani <number>

Use the match dnis replace ani command to replace dialed number identification service (DNIS)
information with automatic number identification (ANI) information on outbound voice trunks. Use the no
form of this command to remove the replacement. Variations of this command include:

match dnis <template> replace ani <number> name <name>
Syntax Description
dnis <template> Specifies the DNIS information to be replaced. This information is entered
replace ani <number> Specifies the ANI information that replaces the original DNIS information.
This information is entered using numerical digits. Enter the number without
punctuation.
Default Values
By default, no DNIS replacement is configured.
Command History
Functional Notes
command are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples
1-256-524-8600 are replaced with 882-6467:

(config-t03)#match dnis 1-256-524-8600 replace ani 8826467



Syntax Description
Default Values
Command History
Functional Notes
command are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples


modem-passthrough
modem-passthrough
Syntax Description
Default Values
Command History
Usage Examples
The following example enables modem-passthrough:

(config-t01)#modem-passthrough

plc
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables PLC on trunk T01:

(config-t01)#plc

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
handled.
Usage Examples


reject-external
Use the reject-external command to blocked outbound (external) call attempts. Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables packet loss concealment (PLC) on trunk T01:

(config-t01)#reject-external

resource-selection
Syntax Description
(DS0 1, 2, 3 through 24).
(DS0 24, 23, 22 through 1).
Default Values
Command History
subcommands.
Usage Examples


rtp delay-mode
command include:

Syntax Description
adaptive Configures RTP jitter buffer packet delay to adjust during a call based on
network conditions.
Default Values
By default, this command is set to adaptive.
Command History
Usage Examples


rtp dtmf-relay
dual tone multi-frequency (DTMF) events are relayed, either inband in the RTP stream or out-of-band
(OOB) using named telephone events (NTEs). RTP DTMF relay is used to prevent the tone (dialed digits)
from being corrupted. Use the no form of this command to return to the default value. Variations of this
command include:

Syntax Description
inband Configures RTP DTMF relay events for inband.
nte <value> Configures RTP DTMF relay events for NTE. Enter a value between
96 and 127.
Default Values
Command History
(ISDN) trunk.
Usage Examples
The following example configures RTP DTMF relay events for NTE with an event value of 101:

(config-t01)#rtp dtmf-relay nte 101


Syntax Description
<value> Configures the RTP frame packetization time in milliseconds. Select from
10, 20, or 30 milliseconds.
Default Values
Command History
(ISDN) trunk.
Usage Examples


rtp packet-delay

Syntax Description
fax <value> Sets the fax delay time in milliseconds. Range is 0 to 500 milliseconds.
maximum <value> Sets the maximum delay time in increments of 10 milliseconds. Range is
nominal <value> Sets the nominal delay time in increments of 10 milliseconds. Range is
Default Values
Command History
Usage Examples



service (QoS) parameters for differentiated services code point (DSCP).
Syntax Description
<value> Configures the RTP QoS parameter for DSCP. Enter a value between 10
and 63.
Default Values
By default, no RTP QoS DSCP is configured for this interface.
Command History
(ISDN) trunk.
Functional Notes
desired DSCP value.
Usage Examples
setting for RTP packets. The following example sets the DSCP value for RTP packets that trunk T02
generates to 60.


rtp rx-gain <value>

Use the rtp rx-gain command to specify the Realtime Protocol (RTP) receive (RX) gain or attentuation.
RTP is used to prevent static on voice connections by enhancing the quality of the packet delivery. Using
the no form of this command returns the RTP RX gain or attenuation to the default value.
Syntax Description
<value> Specifies the RTP RX gain or attenuation in the RTP-to-time division
multiplexing (TDM) direction. Range is 6 to -14. Negative values specify
attenuation. Positive values specify gain in decibels (dB).
Default Values
By default, RTP RX gain is set to 0 dB.
Command History
Usage Examples
The following example specifies the RTP RX gain for integrated services digital network (ISDN) trunk T01
is 4 dB:

(config-t01)#rtp rx-gain 4

rtp tx-gain <value>

Use the rtp tx-gain command to specify the Realtime Protocol (RTP) transmit (TX) gain or attentuation.
the no form of this command returns the RTP TX gain or attenuation to the default value.
Syntax Description
<value> Specifies the RTP TX gain or attenuation in the time division multiplex
(TDM)-to-RTP direction. Range is 6 to -14. Gain is specified in dB. Negative
values specify attenuation. Positive values specify gain in decibels (dB).
Default Values
Command History
Usage Examples
The following example specifies the RTP TX gain for integrated services digital network (ISDN) trunk T01
is 4 dB:

(config-t01)#rtp tx-gain 4

trunk-number <system mode> <number>
trunk-number <system mode> no-number
Syntax Description
custom2, custom3, lunch, night, or weekend. Refer to the command
voice system-mode on page 1194 for more information on system modes.
Default Values
Command History
Release A1 Command was expanded to include the new subcommands.
Usage Examples


t38
feature.
work.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables T.38:

(config-t02)#t38
Technology Review


Syntax Description
using the command t38 redundancy on page 2750).
Default Values
Command History
Usage Examples
The following example sets the t38 error-correction to fec:



feature.
Syntax Description
Default Values
Command History
Usage Examples
The following example enables the t38 fallback-mode on trunk T02:



Syntax Description
400 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-buffer to 100:



Syntax Description
0 to 300 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-datagram to 100:


t38 max-rate
t38 max-rate 14400

t38 max-rate 12000
t38 max-rate 2400
t38 max-rate 4800
t38 max-rate 7200
t38 max-rate 9600
Syntax Description
Default Values
Command History
Usage Examples
The following example sets the t38 max-rate to 4800:


t38 redundancy

Syntax Description
Default Values
Command History
Usage Examples
messages to 3:


vad
Syntax Description
No subcommands.
Default Values
By default, VAD is enabled for all T1 robbed-bit signaling RBS trunks and users.
Command History
(ISDN) trunk.
Usage Examples
The following example enables voice activation detection on trunk T01:

(config-t01)#vad

Command Reference Guide Voice SIP Trunk Command Set
VOICE SIP TRUNK COMMAND SET
Session Initiation Protocol (SIP) trunking is a packet-based voice service that routes calls over an IP
network to an IP-compatible private branch exchange (PBX) or voice switch using SIP signaling to place
and receive calls. The typical SIP trunk service provider offers extensive cost savings, compared to
conventional trunk services. The IP connection to the provider carries all traffic, such as local, long
distance, and toll free calls, video, email, Internet, data, and other media over a single circuit. Calls into
public switched telephone networks (PSTNs) are also handled by the SIP service provider by passing the
calls off to a media gateway that connects to the PSTN for users not using Voice over Internet Protocol
(VoIP) service.
SIP trunks are configured over data connections. Thus, they can be configured over an Ethernet connection
or a T1 connection.
To create a SIP trunk and enter the Voice SIP Trunk Configuration mode, enter the voice trunk type sip
>enable
#configure terminal
(config-t01)#
do on page 51
exit on page 53
alc on page 2754

alert-info on page 2755
authentication username <username> password <password> on page 2756
check-supported replaces on page 2759
conferencing-uri <value> on page 2761
dial-string source on page 2762
diversion-supported on page 2763
domain <name> on page 2764

grammar alert-info url <url> on page 2765

grammar from on page 2766
grammar p-asserted-identity host on page 2768
grammar proxy-require privacy on page 2769
grammar request-uri on page 2770
grammar require 100rel on page 2771
grammar supported 100rel on page 2772
grammar to host on page 2773
max-number-calls <value> on page 2780
outbound-proxy primary <value> on page 2781
outbound-proxy secondary <value> on page 2782
register on page 2784
registrar expire-time <value> on page 2786
registrar max-concurrent-reg <value> on page 2787
registrar primary <value> on page 2788
registrar require-expires on page 2789
registrar secondary <value> on page 2790
registrar threshold on page 2791
sip-keep-alive on page 2793
sip-server primary <value> on page 2794
sip-server rollover on page 2795
sip-server secondary <value> on page 2796
trust-domain on page 2797

alc
alc
alc level -16
alc level -17
alc level -18
alc level -19
alc level -20
alc level -21
alc level -22
Syntax Description
Default Values
Command History
Usage Examples
The following example activates the ALC on trunk T01:

(config-t01)#alc

alert-info
Use the alert-info command to allow the alert information attribute on incoming and/or outgoing auto
answer alert information. Use the no form of this command to cancel the setting. Variations of this
command include:
alert-info incoming auto-answer

alert-info outgoing auto-answer
Syntax Description
incoming auto-answer Specifies processing incoming ALERT-INFO attribute.
outgoing auto-answer Specifies allowing the outgoing ALERT-INFO auto-answer attribute.
Default Values
By default, both incoming and outgoing auto answer alert information is allowed on the NetVanta 7000
Series in the ALERT-INFO messages. However, both are disabled by default in the IP business gateways
(IPBGs) (Total Access 900 Series and NetVanta 1335). The IPBGs will ignore incoming auto answer in the
ALERT-INFO messages, and will not send the information on outgoing trunks.
Command History
Usage Examples
The following example blocks outgoing alert-info auto-answer attribute on trunk T01:

(config-t01)#alert-info outgoing auto-answer

authentication username <username> password <password>

Use the authentication username password command to enable authentication security between the
Session Initiation Protocol (SIP) server and the unit. Each port that registers with the SIP server will use
the defined username and password. Use the no form of this command to return to the default setting.
Syntax Description
username <username> Specifies a string to be sent as the user name in authentication.
password <password> Specifies a string to be sent as the password in authentication.
Default Values
By default, authentication is not enabled.
Command History
Functional Notes
If all users on the trunk use the same user name/password, enter the user name and password for
authentication under the trunk. Otherwise, enter authentication information for each user individually in the
Voice User command set that overrides the setting of this command. Refer to Voice User Account
Usage Examples
The following example configures a user name of iaduser and password of totalaccess at the trunk level:

(config-t01)#authentication username iaduser password totalaccess

busy all
busy all
busy all now
Syntax Description
command is issued.
Default Values
Command History
Release 15.1 Command was added to the Voice Trunk Session Initiation Protocol (SIP)
command set.
Usage Examples


caller-id-override
number. This command is used to conceal user’s name and number or to display a different number for
internal or external caller ID. Use the no form of this command to cancel the setting. Variations of this
command include:

Syntax Description
<trunk id> Optional. Specifies the trunk ID (Txx) for outbound calls.
if-no-cpn Optional. Specifies caller ID override only if calling party number is not
available in the automatic number identification (ANI).
Default Values
Command History
(ISDN) trunk.
Release 15.1 Command was expanded to include the voice T1 trunks.
Usage Examples


check-supported replaces
Use the check-supported replaces command to check all support extensions on outbound messages and
only send replaces when supported by the far-end device. Otherwise, replaces are automatically sent
regardless of the far-end capabilities. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples

(config-t01)#check-supported replaces

codec-group <name>
Syntax Description
Default Values
Command History
(ISDN) trunk.
command set.
Functional Notes
on page 2955.
Usage Examples
The following example applies the CODEC list List1 to trunk T01:


conferencing-uri <value>
Use the conferencing-uri command to configure a conference application server uniform resource
identifier (URI) that controls and uniquely identifies a conference. Use the no form of this command to
Syntax Description
<value> Specifies the extension or complete URI of the conference application
server.
Default Values
By default, conferencing-uri is not configured.
Command History
Usage Examples
The following example sets the conferencing-uri to 0606:

(config-t01)#conferencing-uri 0606

dial-string source
Use the dial-string source command to set the Session Initiation Protocol (SIP) dialing string field of your
choice. Use the no form of this command to remove the specified setting. Variations of this command
dial-string source request-uri

dial-string source to
Syntax Description
request-uri Specifies the Request URI user field as the dialing string source.
to Specifies the To header field as the dialing string source.
Default Values
Command History
Usage Examples
The following example enables the To header user field as the dial-string for this trunk:

(config-t01)#dial-string source to

diversion-supported
Use the diversion-supported command to apply a Session Initiation Protocol (SIP) Diversion header to
redirected calls on the trunk. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, this feature is disabled on the NetVanta 7000 Series products. By default, this feature is
enabled on the Total Access 900(e) Series products and NetVanta 6000 Series products.
Command History
Functional Notes
This feature retains the originating number when a call is processed through an auto attendant, transferred
from a user extension, or is forwarded by a user phone to an external number. For these calls, the number
included in the From field of the SIP messages are subject to the automatic number identification (ANI)
substitution and a SIP Diversion header is added with the original caller ID number. Calls from internal
extensions are subject to the ANI substitution configured on the trunk without the addition of a SIP
Diversion header.
Usage Examples
The following example enables diversion-supported:

(config-t01)#diversion-supported

domain <name>
Use the domain command to configure the assigned domain name for host messages. The domain is an
unique identifier for the Session Initiation Protocol (SIP) users on the trunk. Use the no form of this
Syntax Description
<name> Specifies the domain name for the SIP trunk commands.
Default Values
By default, no domain is configured.
Command History
Usage Examples
The following example sets the domain name as home.com:

(config-t01)#domain home.com

grammar alert-info url <url>

Use the grammar alert-info url command to specify the Alert-Info header construction for Session
Initiation Protocol (SIP) trunk messages. Use the no form of this command to return to the default setting.
Syntax Description
<url> Specifies the Alert-Info Hypertext Transfer Protocol (HTTP) universal
resource locator (URL) header format.
Default Values
By default, the local loopback address is the host in the Alert-Info header (127.0.0.1).
Command History
Usage Examples
The following example sets the Alert-Info header to use a specific URL as shown in the sample header
below:

(config-t01)#grammar alert-info url www.notused.com
Sample header:
Alert-Info:<http://www.notused.com>;info=alert-internal

grammar from
Use the grammar from command to configure the From header on Session Initiation Protocol (SIP)
messages. Use the no form of this command to return to the default setting. Variations of this command
include:
grammar from host domain

grammar from host local
grammar from host sip-server
grammar from user domestic
grammar from user domestic <Txx>
grammar from user international
grammar from user international <Txx>
Syntax Description
host Specifies the Host field formatting for the From header.
domain Specifies the trunk domain setting for formatting the From header.
local Specifies the local IP for formatting the From header.
sip-server Specifies the SIP server settings for formatting the From header.
user Specifies the User field formatting for the From header.
domestic Specifies domestic formatting for the From user header.
international Specifies international formatting for the From user header.
<Txx> Optional. Indicates a two-digit trunk identifier (i.e., T01).
Default Values
By default, the host for formatting messages is sip-server. Also, the default for the user format is
domestic.
Command History
Functional Notes
Omitting the trunk identifier when issuing the grammar from user command specifies the User header
globally.
Usage Examples
The following example sets the From header format to use a local IP:

(config-t01)#grammar from host local

The following example sets the From header format to use calling party format on trunk T02:

(config-t01)#grammar from user domestic T02
Technology Review
This technology review provides information about the E.164 recommendation for international numbering
plans and telephone number formats.
A fully specified telephone number can have a maximum of 15 digits, including country code, area code,
and the subscriber’s number. These numbers usually consist of a + prefix. E.164 numbers exclude dialing
prefixes. The most familiar prefixes are international direct dialing (IDD) and national direct dialing (NDD).
In countries other than the United States, the IDD and NDD are represented by different numbers.
Additionally, E.123 describes the use of + to indicate a fully specified international number. The + is used in
SIP headers to provide consistency across national and international phone calls.
AOS products provide support for E.164 by being able to specify a country code and an IDD prefix.
Nationally formatted telephone numbers are converted to international format by prefixing them with + and
the country code. On outbound international calls, + is substituted for the IDD. On incoming international
calls, the + is removed. If the country code matches the configured value, it too is removed.
Setting the From header to international will cause phone numbers to be formatted as
indicated by E.164. The country code must be configured, and the number must be of type
national for this feature to work successfully.

grammar p-asserted-identity host

Use the grammar p-asserted-identity host command to configure the P-Asserted Identity header host
format for the Session Initiation Protocol (SIP) trunk. Use the no form of this command to return to the
grammar p-asserted-identity host domain

grammar p-asserted-identity host local
grammar p-asserted-identity host sip-server
Syntax Description
domain Specifies the domain host for formatting the header.
local Specifies the local IP as host for formatting the header.
sip-server Specifies the SIP server as host for formatting the header.
Default Values
By default, the host for formatting messages is sip-server.
Command History
Usage Examples
The following example sets the p-asserted-identity header host format to use a local IP for constructing the
header:

(config-t01)#grammar p-asserted-identity host local

grammar proxy-require privacy

Use the grammar proxy-require privacy command to add privacy to Proxy-Require header format for
Session Initiation Protocol (SIP) trunk. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example allows a Proxy-Require header to be added to packets containing a privacy header:

(config-t01)#grammar proxy-require privacy

grammar request-uri
Use the grammar request-uri command to format the Request uniform resource identifier (URI) for
Session Initiation Protocol (SIP) trunk messages. Use the no form of this command to return to the default
grammar request-uri host domain

grammar request-uri host sip-server
grammar request-uri host-resolve
Syntax Description
host domain Specifies the trunk domain setting for formatting the Request-URI header.
host sip-server Specifies the trunk SIP server setting for formatting the Request-URI
header.
host-resolve Enables the local unit to resolve the domain before constructing the
Request-URI header.
Default Values
By default, the host for formatting messages is the SIP server. Also by default, host-resolve is disabled.
Command History
Usage Examples
The following example enables SIP trunk messages to resolve the Request-URI from the host domain:

(config-t01)#grammar request-uri host domain
The following example enables SIP trunk messages to resolve the Request-URI from the local unit:

(config-t01)#grammar request-uri host-resolve

grammar require 100rel

Use the grammar require 100rel command to add 100rel to the Require header format. Use the no form
Syntax Description
No subcommands.
Default Values
By default, grammar require 100rel is disabled.
Command History
Functional Notes
This command enables or disables the sending of reliable provisional responses to clients that support
100rel. Reliable provisional responses will always be sent to clients that require 100rel even with grammar
require 100rel disabled.
Usage Examples
The following example enables grammar require 100rel:

(config-t01)#grammar require 100rel
Technology Review
There are two Require headers that may use the 100rel tag, one in the initial request, and one in the
provisional response.
The user agent client (UAC) is used to initiate Session Initiation Protocol (SIP) requests. When the UAC
creates a new request, it can require reliable provisional responses for that request by adding the option
tag 100rel to the Require header of that request.
The user agent server (UAS) contacts the user when SIP requests are received, and returns responses on
behalf of the user, using provisional responses for request progress information. Provisional responses
(100 to 199) are transmitted on a best-effort basis. By using reliable provisional responses, responses are
sent by the UAS until they are acknowledged as received. This is especially beneficial when sending
provisional responses over an unreliable transport, such as User Datagram Protocol (UDP).
The UAS must send any non-100rel provisional responses reliably if the initial request contained a Require
header field with the option tag 100rel. If the UAS is unwilling to do so, it must reject the initial request with
a Bad Extension message and include an Unsupported header field containing the option tag 100rel. If the
client supports 100rel, the UAS has the option of sending provisional responses with or without the
Require 100rel tag as instructed by the grammar require 100rel command.

grammar supported 100rel

Use the grammar supported 100rel command to include 100rel in the supported header of the Session
Initiation Protocol (SIP) trunk message. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, grammar supported 100rel is disabled.
Command History
Usage Examples
The following example enables grammar supported 100rel:

(config-t01)#grammar supported 100rel

grammar to host
Use the grammar to host command to configure the To header host format of Session Initiation Protocol
(SIP) trunk messages. Use the no form of this command to return to the default setting. Variations of this
command include:
grammar to host domain

grammar to host sip-server
Syntax Description
domain Specifies using the trunk domain setting to format the To header.
sip-server Specifies using the trunk SIP server settings to format the To header.
Default Values
By default, the host for formatting messages is the SIP server.
Command History
Usage Examples
The following example configures the To header format construction to use the trunk domain:

(config-t01)#grammar to host domain


command include:

Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples




Syntax Description
punctuation.
Default Values
Command History
Functional Notes
command are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples




Syntax Description
Default Values
Command History
Functional Notes
command are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples


max-number-calls <value>
Use the max-number-calls command to configure the maximum number of calls allowed on this trunk.
This command is useful in controlling the call usage of the trunk. Use the no form of this command to
Syntax Description
<value> Specifies the maximum number of calls allowed on this trunk. Range is 1 to
64 calls.
Default Values
By default, no maximum number of calls is specified.
Command History
Usage Examples
The following example sets the maximum number of calls allowed to 25:

(config-t01)#max-number-calls 25

outbound-proxy primary <value>

Use the outbound-proxy primary command to define the primary name/address of the Session Initiation
Protocol (SIP) proxy server to which the trunk will send all SIP messages. Use the no form of this
outbound-proxy primary <value>

outbound-proxy primary <value> tcp
outbound-proxy primary <value> tcp <number>
outbound-proxy primary <value> udp
outbound-proxy primary <value> udp <number>
Syntax Description
<value> Specifies the fully qualified domain name (FQDN) or IP address of the
outbound proxy server.
<number> Optional. Specifies the port number. Range is 0 to 65535.
tcp Optional. Sets the Transmission Control Protocol (TCP) port of the
udp Optional. Sets the User Datagram Protocol (UDP) port of the outbound
proxy server.
Default Values
By default, the IP address is set to 0.0.0.0 and the UDP port is set to 5060.
Command History
Functional Notes
The configured value must resolve to a valid IP address.
Usage Examples
The following example sets the outbound proxy server to sip-proxy.adtran.com with a UDP port of 2222:

(config-t01)#outbound-proxy primary sip-proxy.adtran.com udp 2222

outbound-proxy secondary <value>

Use the outbound-proxy secondary command to define the secondary name/address of the Session
Initiation Protocol (SIP) proxy server to which the trunk will send all SIP messages. Use the no form of
outbound-proxy secondary <value>

outbound-proxy secondary <value> tcp
outbound-proxy secondary <value> tcp <number>
outbound-proxy secondary <value> udp
outbound-proxy secondary <value> udp <number>
Syntax Description
<value> Specifies the fully qualified domain name (FQDN) or IP address of the
proxy server.
Default Values
Command History
Functional Notes
The configured value must resolve to a valid IP address.
Usage Examples
The following example sets the outbound proxy server to sip-proxy.adtran.com with a UDP port of 2244:

(config-t01)#outbound-proxy secondary sip-proxy.adtran.com udp 2244

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
handled.
Usage Examples


register
Use the register command to define the Session Initiation Protocol (SIP) name for registration of the
authorization name(s) and password(s). Use the no form of this command to remove a registration.
register <name>
register <name> auth-name <username> password <word>
register range <begin> <end>
register range <begin> <end> auth-name <username> password <word>
register range <begin> <end> auth-name range <begin> <end> password range <begin> <end>
register range <begin> <end> auth-name range <begin> <end> password <word>
When using the range option, there must be the same number of elements in each related
range. In other words, each SIP user in a range must have one authentication name and/or
one password.
Syntax Description
<name> Specifies the name of the SIP trunk to register.
range <begin> <end> Specifies the beginning and ending of the range to register SIP users,
authentication names, and/or passwords.
auth-name <username> Optional. Specifies the user name for authentication.
password <word> Optional. Specifies the password for authentication.
Default Values
By default, no registration range is programmed.
Command History
Functional Notes
Using the range option reduces the time required to program individual user registration and
authentication settings. The range configuration option allows multiple users to be configured in one step
for example:
register range 2565553000 2565553100 auth-name range Adtran3000 Adtran3100 password range
adtn3000 adtn3100
In this example, 100 users in the range (256) 555-3000 to (256) 555-3100 are registered with
authentication names ranging from Adtran3000 to Adtran3100 and passwords ranging from adtn3000 to
adtn3100.

The user may enter an authentication name range, password range, or both. An error will be returned if the
provided authentication name and/or password range values are not large enough for the SIP identity
range provided (i.e., in the example, if the user had entered Adtran3000 Adtran3099 for the authentication
name range, an error would have been returned because the specified SIP identity range is 100 users (not
99)).
Usage Examples
The following example registers trunk T01 under the name of MainOffice:

(config-t01)#register MainOffice
The following example sets the authorization name and password range for a group of SIP users:

(config-t01)#register range 2565554000 2565554100 auth-name range Adtran4000 Adtran4100
password range adtn8000 adtn8100

registrar expire-time <value>

Use the registrar expire-time command to define the Session Initiation Protocol (SIP) expiration time for
registration. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies expiration time (in seconds) for a registration.
Default Values
By default, no registration expiration time is programmed.
Command History
Usage Examples
The following example enables registration expiration time for the SIP trunk:

(config-t01)#registrar expire-time

registrar max-concurrent-reg <value>

Use the registrar max-concurrent-reg command to control the maximum number of simultaneous
registrations that are allowed. This value can be adjusted to help eliminate congestion caused by too many
concurrent registrations. Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the maximum number of concurrent registrations. Valid range
is 1 to 32 registrations.
Default Values
By default, the maximum number of concurrent registrations is set to 32.
Command History
Usage Examples
The following example sets the maximum number on concurrent registrations to 12:

(config-t01)#registrar max-concurrent-reg 12

registrar primary <value>

Use the registrar primary command to define the primary Session Initiation Protocol (SIP) registrar fully
qualified domain name (FQDN) or IP address that is based on the domain naming system (DNS) suffix.
Use the no form of this command to return to the default setting. Variations of this command include:
registrar primary <value>

registrar primary <value> tcp
registrar primary <value> tcp <number>
registrar primary <value> udp
registrar primary <value> udp <number>
A secondary SIP registrar can be set using the command registrar secondary <value> on
page 2790.
Syntax Description
<value> Specifies the FQDN or IP address of the registrar server. IP addresses
proxy server.
Default Values
Command History
Functional Notes
This command specifies which trunk will send SIP register messages. The configured value must resolve
to a valid IP address.
Usage Examples
The following example sets the registrar server to as1.adtran.com with a UDP port of 9060:

(config-t01)#registrar primary as1.adtran.com udp 9060

registrar require-expires
Use the registrar require-expires command to define the Session Initiation Protocol (SIP) expiration time
for registration. A successful response to a register contains an expires header or the response is considered
a failure. When disabled, a successful response does not require an expires header to be considered
successful. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specifies expiration time (in seconds) for a response to a registration
request.
Default Values
By default, the registration expiration time is enabled.
Command History
Usage Examples
The following example disables registration expiration time for the SIP trunk:

(config-t01)#no registrar require-expires

registrar secondary <value>

Use the registrar secondary command to define the secondary Session Initiation Protocol (SIP) registrar
fully qualified domain name (FQDN) or IP address that is based on the domain naming system (DNS)
suffix. Use the no form of this command to return to the default setting. Variations of this command
include:
registrar secondary <value>

registrar secondary <value> tcp
registrar secondary <value> tcp <number>
registrar secondary <value> udp
registrar secondary <value> udp <number>
Syntax Description
<value> Specifies the FQDN or IP address of the registrar server. IP addresses
proxy server.
Default Values
Command History
Functional Notes
This command specifies which trunk will send SIP register messages. The configured value must resolve
to a valid IP address.
Usage Examples
The following example sets the registrar server to as1.adtran.com with a UDP port of 9060:

(config-t01)#registrar secondary as1.adtran.com udp 9060

registrar threshold
Use the registrar threshold command to configure when the Session Initiation Protocol (SIP) trunk
registration will be renewed. Use the no form of this command to return to the default value. Variations of
registrar threshold absolute <value>

registrar threshold percentage <percent>
Syntax Description
absolute <value> Configures an absolute threshold time. This is the time in seconds between
registrations. Valid range is 30 to 604800 seconds (1 week).
percentage <percent> Configures the threshold time as a percentage of the returned valid
registration time. Valid range is 1 to 90 percent.
Default Values
By default, the registrar threshold is set at absolute 300 seconds.
Command History
Usage Examples
The following example sets the registrar threshold time at 50 percent of the returned valid registration time:

(config-t01)#registrar threshold percentage 50

reject-external
same trunk. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
out of the same trunk, causing the owner of the unit to be charged for long distance calls without his
knowledge. For network-role trunks and SIP-based trunks, this command should be disabled to allow calls
to be properly routed in the unit.
Usage Examples
The following example activates reject-external:

(config-t01)#reject-external

sip-keep-alive
Use the sip-keep-alive command to configure the type of keep-alive method for this Session Initiation
Protocol (SIP) trunk. Keep-alive messages must be sent between SIP device and the registrar to keep the
connected channel open for communication. Use the no form of this command to return to the default
sip-keep-alive info
sip-keep-alive info <value>
sip-keep-alive options
sip-keep-alive options <value>
Syntax Description
info Specifies the INFO method to be used for the keep-alives on the trunk.
options Specifies the OPTIONS method to be used for the keep-alives on the trunk.
<value> Optional. Specifies the amount of time in seconds between the type of SIP
keep-alive messages being sent during a call. Range is 30 to
3600 seconds.
Default Values
Command History
Release A2.04 Command was added to the Voice Line and Voice User command sets.
Usage Examples
The following example sets the keep-alive method to info:

(config-t01)#sip-keep-alive info

sip-server primary <value>

Use the sip-server primary command to define the primary name/address of the Session Initiation
Protocol (SIP) server to which the trunk will send call-related SIP messages. Use the no form of this
sip-server primary <value>

sip-server primary <value> udp
sip-server primary <value> udp <number>
sip-server primary <value> tcp
sip-server primary <value> tcp <number>
Syntax Description
<value> Specifies the fully qualified domain name (FQDN) or IP address of the SIP
(for example, 10.10.10.1).
proxy server.
Default Values
Command History
Usage Examples
The following example sets the SIP proxy server to as1.adtran.com with a UDP port of 9060:

(config-t01)#sip-server primary as1.adtran.com udp 9060

sip-server rollover
Use the sip-server rollover command to configure the rollover behavior of the Session Initiation Protocol
(SIP) server. Use the no form of this command to return to the default setting. Variations of this command
include:
sip-server rollover service-unavailable-or-timeout

sip-server rollover timeout-only
Syntax Description
service-unavailable-or-timeout Specifies the rollover to the next SIP server to occur after receiving a
503 Service Unavailable message or no response.
timeout-only Specifies the rollover to the next SIP server to occur only after no
response is received.
Default Values
By default, the sip-server rollover is set to timeout-only.
Command History
Usage Examples
The following example sets the SIP server rollover to timeout-only:

(config-t01)#sip-server rollover timeout-only

sip-server secondary <value>

Use the sip-server secondary command to define the secondary name/address of the Session Initiation
Protocol (SIP) server to which the trunk will send call-related SIP messages. Use the no form of this
sip-server secondary <value>

sip-server secondary <value> udp
sip-server secondary <value> udp <number>
sip-server secondary <value> tcp
sip-server secondary <value> tcp <number>
Syntax Description
<value> Specifies the fully qualified domain name (FQDN) or IP address of the SIP
(for example, 10.10.10.1).
proxy server.
Default Values
Command History
Usage Examples
The following example sets the SIP proxy server to as1.adtran.com with a UDP port of 9070:

(config-t01)#sip-server secondary as1.adtran.com udp 9070

trust-domain
Use the trust-domain command to add security measures for users’ identity and privacy by connecting the
trunk to a trusted domain. Using the trusted domain adds another level of privacy from participating
service providers. The system supports RFC 3323 and RFC 3325. Use the no form of this command to
trust-domain
trust-domain p-asserted-identity-required
Syntax Description
p-asserted-identity-required Requires the use of P-Asserted-Identity SIP privacy for this trusted
domain.
Default Values
By default, the trust-domain is disabled.
Command History
Usage Examples
The following example enables the trust-domain:

(config-t01)#trust-domain

Command Reference Guide Voice T1 Trunk Command Set
VOICE T1 TRUNK COMMAND SET
Voice T1 trunks are trunks that use T1 circuits and robbed-bit signaling (RBS) to connect communication
devices to the outside world. The T1 RBS trunk can terminate a line from the service provider, or be a
termination point acting as the network to a private branch exchange (PBX) or key system requiring a T1
circuit. The term T1 circuit is commonly used to identify a multiplexed 24-channel, 1.544 Mbps digital
data circuit, providing communications between two facilities or from a local service provider. T1 refers to
the transport of a DS1-formatted signal onto a copper, fiber, or wireless medium for deploying voice, data,
or video conferencing services. T1 connections provide up to 24 DSO channels of 64kbps, and use the
RBS scheme to pass call signaling status information.
RBS is the process where the least significant bit in the sixth and twelfth frame (of a superframe (SF) T1)
and the sixteenth and twentieth frame (of an extended superframe (ESF) T1) is robbed for voice A, B, C,
and D signaling bits. These signaling bits indicate on-hook or off-hook conditions, as well as other
signaling states.
Before configuring a T1 voice trunk, the T1 interface must be configured. For more information on
configuring the T1 interface, refer to the T1 Interface Command Set on page 1500. Once the T1 interface is
configured, you must create a T1 trunk account in order to make and receive calls. When creating the T1
trunk account, it is important to make sure the T1 RBS settings (supervision, type, etc.) match the
parameters set by your service providers.
There are six main types of T1 trunks supported by AOS. The first is a T1 trunk without RBS, the second
is a T1 RBS trunk using feature group D (FGD), the third is a T1 RBS trunk using ground start (GS), the
fourth is a T1 RBS trunk using loop start (LS), the fifth is a T1 RBS trunk using wink, and the sixth is a T1
RBS trunk using immediate supervision.
To create a T1 trunk account without RBS and enter the Trunk Account Configuration mode, enter the
following command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#voice trunk t01
(config-t01)#
To create a T1 RBS trunk account using FGD and enter the Trunk Account Configuration mode, enter the
>enable
#configure terminal
(config-t01)#

To create a T1 RBS trunk account using GS and enter the Trunk Account Configuration mode, enter the
>enable
#configure terminal
(config)#voice trunk t01 type t1-rbs supervision ground-start role user
(config-t01)#
To create a T1 RBS trunk using LS and enter the Trunk Account Configuration mode, enter the following
>enable
#configure terminal
(config)#voice trunk t01 type t1-rbs supervision loop-start role user
(config-t01)#
To create a T1 RBS trunk account using wink and enter the Trunk Account Configuration mode, enter the
>enable
#configure terminal
(config)#voice trunk t01 type t1-rbs supervision wink role [network | user]
(config-t01)#
To create a T1 RBS trunk using immediate supervision and enter the Trunk Account Configuration mode,
enter the following command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#voice trunk t01 type t1-rbs supervision immediate role [network | user]
(config-t01)#
Not all T1 Trunk commands apply to all T1 trunk types. Use the ? command to display a
list of valid commands.
do on page 51
exit on page 53

alc on page 2802

blind-dial on page 2803
busy t1 <slot/port> tdm-group <number> on page 2805
connect t1 <slot/port> tdm-group <number> on page 2809
dialtone on page 2810
did digits-transferred on page 2811
dnis-digits <value> prefix <number> on page 2812
early-cut-through on page 2813
nls on page 2822
plc on page 2823
rtp rx-gain <value> on page 2832
rtp tx-gain <value> on page 2833
treat-inbound-as-internal on page 2834
t38 on page 2837


tx-ani on page 2844
vad on page 2845

alc
alc
alc level -16
alc level -17
alc level -18
alc level -19
alc level -20
alc level -21
alc level -22
Syntax Description
Default Values
Command History
Usage Examples
The following example activates the ALC on trunk T01:

(config-t01)#alc

blind-dial
Use the blind-dial command to allow calls to be placed without the presence of dial tone. Use the no form
of this command to disable blind dialing.
Syntax Description
No subcommands.
Default Values
By default, blind-dial is disabled.
Command History
Usage Examples
The following example enables blind dialing:

(config-t01)#blind-dial

busy all
busy all
busy all now
Syntax Description
command is issued.
Default Values
Command History
Usage Examples


busy t1 <slot/port> tdm-group <number>

Use the busy t1 tdm-group command to set a particular set of level zero digital signals (DS0s) (defined in
a time division multiplexing (TDM) group) to busy so that no calls are allowed inbound or outbound the
interface. If any calls are active at the time this command is issued, the calls will stay active until either
party terminates the call. Once terminated, the DS0s are set to busy. Use the no form of this command to
disable this feature. Variations of this command include:
busy t1 <slot/port> tdm-group <number>

busy t1 <slot/port> tdm-group <number> now
Syntax Description
<slot/port> Specifies the slot/port for the T1.
<number> Specifies the TDM group ID number.
now Optional. Terminates calls that are active at the time the command is issued
(for example, in the middle of a conversation).
Default Values
Command History
Usage Examples
The following example sets DS0s in TDM group 2 to busy and terminates calls that are active when the
command is issued:

(config-t01)#busy t1 0/1 tdm-group 2 now

caller-id
Use the caller-id number command to interpret and pass caller identification (ID) on this trunk. This
information usually displays the name, number, time, and date of the calling party. Use the no form of this
command to cancel the setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables caller ID:

(config-t01)#caller-id

caller-id-override

Syntax Description
<trunk id> Optional. Specifies the trunk ID (Txx) for outbound calls.
if-no-cpn Optional. Specifies caller ID override only if calling party number is not
available in the automatic number identification (ANI).
Default Values
Command History
(ISDN) trunk.
Release 15.1 Command was expanded to include the voice T1 trunks.
Usage Examples

(config-t01)#caller-id-override number-inbound 555-8000

codec-group <name>
Syntax Description
Default Values
Command History
(ISDN) trunk.
command set.
Functional Notes
on page 2955.
Usage Examples


connect t1 <slot/port> tdm-group <number>

Use the connect t1 tdm-group command to specify the physical interfaces this trunk group will use for
voice connections. Refer to tdm-group <number> on page 1515 for more information on creating time
division multiplexing (TDM) groups. Use the no form of this command to remove this association.
Syntax Description
<slot/port> Specifies the slot/port for the T1.
<number> Specifies the TDM group ID number.
Default Values
By default, no physical interface is assigned.
Command History
Usage Examples
The following example specifies that this trunk will use the level zero digital signals (DS0s) in TDM group 3
(on T1 interface 0/1):

(config-t01)#connect t1 0/1 tdm-group 3

dialtone
Use the dialtone command to enable dial tone generation. Use the no form of this command to disable this
feature.
Syntax Description
No subcommands.
Default Values
By default, the dial tone is enabled.
Command History
Usage Examples
The following example disables dial tone on trunk T01:

(config-t01)#no dialtone

did digits-transferred
Use the did digits-transferred command to define how many of the received digits should be sent to the
internal switchboard from an incoming call on a user role trunk. The number of digits transferred are the
least significant digits received. Direct inward dialing (DID) should be used if a Telco provider is
providing digits to the unit on inbound calls or if the unit needs to provide DID information to a piece of
customer premises equipment (CPE). Use the no form of this command to disable this feature. Variations

did digits-transferred <value> prefix <number>
Syntax Description
<value> Specifies the number of digits to be transferred. Range is 1 to 16 digits.
prefix <number> Optional. Specifies a sequence of digits to be prepended to the digits that
will be transmitted. For example, if seven digits will be transferred via DID,
then prefix the seven digits with 256. Thus, 555-8000 would be prefixed
with 256, transmitting out the string of digits 256-555-8000.
Default Values
Command History
Functional Notes
User Role Example:
555-1000 is an incoming call on the trunk. With did digits-transferred <value> set to 4, the number 1000
will be sent to the switchboard. On a network role trunk, the did digits-transferred command allows you to
define how many of the digits from the Accept criteria should be sent externally from a call that was routed
by the switchboard. The number of digits transferred are the least significant digits received.
Network Role Example:
555-1000 is accepted on the universal time (UT) interface. With did digits-transferred <value> set to 4,
the number of 1000 will be sent to the device connected to the UT interface. This command cannot be
specified if and when trunk-number is being used. Conversely, if DID is used, trunk-number will not be
allowed.
Usage Examples

(config-t01)#did digits-transferred 5558000 prefix 256

dnis-digits <value> prefix <number>

Use the dnis-digits prefix command to program the number of digits to be transferred inbound on the
specific trunk. Use the no form of this command to cancel the setting.
Syntax Description
<value> Specifies the number of digits to be transferred.
<number> Specifies the number prefix to prepend to the transferred digits.
Default Values
Command History
Usage Examples
The following example sets the number of transferred dialed number identification service (DNIS) digits to
4 on trunk T01 and sets the prefix 555:

(config-t01)#dnis-digits 4 prefix 555

early-cut-through
Use the early-cut-through command to provide the caller with inband ringback and other call progress
signals. This command should not be issued if the connected equipment does not provide inband ringback
and other call progress signals. This option is only valid for voice trunks in the network role. Use the no
Syntax Description
No subcommands.
Default Values
By default, early-cut-through is disabled.
Command History
Usage Examples
The following example activates early-cut-through:

(config-t01)#early-cut-through

echo-cancellation
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples



command include:

Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples




Syntax Description
punctuation.
Default Values
Command History
Functional Notes
command are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples




Syntax Description
using wildcards and numerical digits.Refer to the Functional Notes of this
Default Values
Command History
Functional Notes
command are:


Example: 1) 555-81xx matches 555-8100 to 555-8199.
2) 555-812[012] matches 555-8120 to 555-8122.
4)1-Nxx-Nxx-xxxx matches long distance calls in North America.
MATCH # SUBST #

Usage Examples


modem-passthrough
modem-passthrough
Syntax Description
Default Values
Command History
Usage Examples

(config-t01)#no modem-passthrough

nls
Use the nls command to enable the non-linear suppression (NLS) option for the user. This option sets the
echo canceller to reduce acoustic echo. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Release 15.1 Command was added to the Voice Trunk T1 command set.
Usage Examples
The following example enables NLS on trunk T01:

(config-t01)#nls

plc
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example disables PLC on trunk T01:

(config-t01)#no plc

Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
handled.
Usage Examples


reject-external
same trunk. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, reject-external is enabled on this interface.
Command History
Functional Notes
out of the same trunk, causing the owner of the unit to be charged for long distance calls without his
knowledge. For network-role trunks and Session Initiation Protocol (SIP) based trunks, this command
should be disabled to allow calls to be properly routed in the unit.
Usage Examples
The following example disables reject-external:

(config-t01)#no reject-external

resource-selection
Syntax Description
(DS0 1, 2, 3 through 24).
(DS0 24, 23, 22 through 1).
Default Values
Command History
subcommands.
Usage Examples


rtp delay-mode
command include:

Syntax Description
Default Values
By default, the RTP delay mode is set to adaptive.
Command History
Usage Examples


rtp dtmf-relay

Syntax Description
event (NTE). Enter an NTE value between 96 and 127.
Default Values
Command History
Usage Examples

(config-t01)#rtp dtmf-relay inband


Syntax Description
Default Values
Command History
Usage Examples


rtp packet-delay

Syntax Description
fax <value> Sets the fax delay time value. Range is 0 to 500 milliseconds.
Default Values
Command History
Usage Examples



Syntax Description
10 and 63.
Default Values
Command History
Functional Notes
desired DSCP value.
Usage Examples
The following example configures the RTP QoS DSCP for trunk T01 to 60:


rtp rx-gain <value>

Use the rtp rx-gain command to specify the Realtime Protocol (RTP) receive (RX) gain or attentuation.
the no form of this command returns the RTP RX gain or attenuation to the default value.
Syntax Description
<value> Specifies the RTP RX gain or attenuation in the RTP-to-time division
multiplexing (TDM) direction. Range is -14 to 6. Negative values specify
attenuation. Positive values specify gain in decibels (dB).
Default Values
Command History
Usage Examples
The following example specifies the RTP RX gain for trunk T01 is 4 dB:

(config-t01)#rtp rx-gain 4

rtp tx-gain <value>

Use the rtp tx-gain command to specify the Realtime Protocol (RTP) transmit (TX) gain or attentuation.
the no form of this command returns the RTP TX gain or attenuation to the default value.
Syntax Description
<value> Specifies the RTP TX gain or attenuation in the time division multiplexing
(TDM)-to-RTP direction. Range is -14 to 6. Gain is specified in dB. Negative
values specify attenuation. Positive values specify gain in decibels (dB).
Default Values
Command History
Usage Examples
The following example specifies the RTP TX gain for trunk T01 is 4 dB:

(config-t01)#rtp tx-gain 4

treat-inbound-as-internal
Use the treat-inbound-as-internal command to make incoming trunk calls appear as internal calls. Use
the no form of this command to cancel the setting.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example configures the unit to treat inbound calls on trunk T03 as internal calls:

(config-t03)#treat-inbound-as-internal

trunk-number custom1 <number>
trunk-number custom1 no-number
trunk-number lunch <number>
trunk-number lunch no-number
trunk-number night <number>
trunk-number night no-number
trunk-number weekend <number>
trunk-number weekend no-number
Syntax Description
custom1 - custom3 Specifies the custom mode to use.
lunch Specifies the lunch-time mode.
night Specifies the night-time mode.
override Specifies the override mode.
weekend Specifies the weekend mode.
Default Values
Command History
Release 16.1 Command was expanded to include the new subcommands.

Usage Examples


t38
feature.
The modem-passthrough command must be enabled for T.38 operation to work. Refer to
modem-passthrough on page 2821.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables T.38 for trunk T03:

(config-t03)#t38
Technology Review


Syntax Description
Default Values
Command History
Usage Examples
The following example sets the t38 error-correction to fec for user trunk T03:



feature.
Syntax Description
Default Values
Command History
Usage Examples
The following example enables the t38 fallback-mode for trunk T01:



Syntax Description
<value> Specifies the value for the max-buffer attribute in the Session Description
400 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-buffer to 100 for trunk T01:



Syntax Description
0 to 300 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-datagram to 100 for trunk T01:


t38 max-rate
t38 max-rate 14400

t38 max-rate 12000
t38 max-rate 2400
t38 max-rate 4800
t38 max-rate 7200
t38 max-rate 9600
Syntax Description
Default Values
Command History
Usage Examples
The following example sets the t38 max-rate to 4800 for trunk T01:


t38 redundancy

Syntax Description
Default Values
Command History
Usage Examples
messages to 3 for trunk T01:


tx-ani
Use the tx-ani command to transmit automatic number identification (ANI) (calling-party number) and
dialed number identification service (DNIS) (called-party number) for outbound feature group D (FGD)
calls. This command is only valid on a trunk configured for FGD supervision. Use the no form of this
command to cancel the setting.
Syntax Description
No subcommands.
Default Values
Command History
Release 15.1 Command was added to the FGD command set.
Usage Examples
The following example configures the system to transmit ANI/DNIS information on the outbound FGD
trunk:

(config-t03)#tx-ani

vad
Syntax Description
No subcommands.
Default Values
By default, VAD is enabled for all T1 robbed-bit signaling (RBS) trunks and users.
Command History
Usage Examples
The following example disables VAD on trunk T01:

(config-t01)#no vad

VOICE ACCOUNTS COMMAND SETS

• Voice Line Account Command Set on page 2847

• Voice Loopback Account Command Set on page 2870
• Voice User Account Command Set on page 2887

Command Reference Guide Voice Line Account Command Set
VOICE LINE ACCOUNT COMMAND SET
The voice line account commands help you to configure the lines used by voice users. These commands
allow you to configure call coverages, call permissions, system activities, and to monitor the quality of the
voice connections. Voice line account configurations work hand-in-hand with other voice features, such as
system modes, shared line accounts (SLAs), and shared call appearances (SCAs). For more information on
system modes, refer to the NetVanta 7000 Series System Modes quick configuration guide available online
at http://kb.adtran.com (article number 2313). For more information on SLAs, refer to the Shared Line
Accounts over Analog Trunks configuration guide (article number 2132), and for more information on
SCAs, refer to the NetVanta 7000 Series Shared Call Appearances quick configuration guide (article
number 3101), both available online at http://kb.adtran.com.
To create a voice line account and enter the Voice Line Account Configuration mode, enter the voice line
>enable
#configure terminal
(config)#voice line sales
(config-sales)#

do on page 51
exit on page 53
accept <pattern> on page 2849

alc on page 2850
nls on page 2855
plc on page 2858
reject <pattern> on page 2859


seize-timeout <seconds> on page 2866
trunk <Txx> on page 2868
vad on page 2869

accept <pattern>
Use the accept command to specify numbers that users can dial. This command controls the type of
outbound calls users can place. Use the no form of this command to remove a configured dial pattern and
Syntax Description
<pattern> Specifies the patterns users can dial. You can enter a complete phone
number or wildcards can be used to help define accepted numbers. Refer to
Functional Notes below for more information on using wildcards.
Default Values
By default, the cost value is zero.
Command History
Functional Notes


2) 555-812[012] matches 555-8120 to 555-8122.
Usage Examples
The following example allows users on the line sales to dial any local number:

(config-sales)#accept Nxxxxxx

alc
Use the alc command to enable auto level control (ALC). ALC reduces Realtime Transport Protocol (RTP)
received signals that are out of specification to the predefined levels. It is not necessary to enable ALC on
those networks that guarantee signal levels to be within specification. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates the ALC for line sales:

(config-sales)#alc

codec-group <name>
Syntax Description
Default Values
Command History
(ISDN) trunk.
command set.
Functional Notes
on page 2955.
Usage Examples
The following example applies the CODEC list List1 to the voice line sales:

(config-sales)#codec-group List1

coverage
Use the coverage command to configure call coverage parameters for the line. The call coverage setting
determines how a call is handled if the party dialed does not answer after a specified number of rings. Use
the no form of this command to remove an individual coverage parameter. Variations of this command
include:
coverage aa
coverage operator
coverage override <value>
coverage vm
Syntax Description
system modes.
auto attendant.
override <value> Ignores the programmed system mode schedule.
vm <number> Optional. Forwards the call to the specified mailbox number.

Default Values
Command History
options.
Release 12.1 Command was updated to include the auto attendant, global, and operator
options.
Functional Notes
Usage Examples
The following example specifies that the line be forwarded after 3 rings to the internal extension 8500 when
in the night system mode:

(config-sales)#coverage night internal 8500 num-rings 3

echo-cancellation
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates echo-cancellation for voice line sales:

(config-sales)#echo-cancellation

nls
Use the nls command to enable the non-linear suppression (NLS) option for the line. This option sets the
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables NLS for voice line sales:

(config-sales)#nls

num-rings <value>
include:
num-rings <value>
Syntax Description
system modes.
<value> Specifies the number of rings before the next action. The valid range is
1 to 9.
Default Values
By default, num-rings is set to 4.
Command History
Functional Notes
Usage Examples
The following example sets the number of rings for voice line sales to 6:

(config-sales)#num-rings 6

password <password>
Use the password command to create a password or personal identification number (PIN) to protect voice
settings and messages. Use the no form of this command to remove a password.
The password configured must be used when configuring the IP phone using the IP Phone
Configs Web-based graphical user interface (GUI) menu.
Syntax Description
<password> Specifies a 4-digit password or PIN.
Default Values
Command History
Usage Examples
The following example sets the password for voice line sales to 4321:

(config-sales)#password 4321

plc
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example disables PLC for the voice line sales:

(config-sales)#no plc

reject <pattern>
Use the reject command to specify numbers users cannot dial on the line. This feature allows
administrators to restrict callers from unwanted outbound calls, such as international calls and 900
numbers. Use the no form of this command to disable this feature.
Syntax Description
<pattern> Specifies the patterns that users cannot dial on the line. You can enter a
complete phone number or wildcards can be used to help define rejected
numbers. Refer to Functional Notes below for more information on using
wildcards. For example, you can enter 900$ to prevent users from dialing all
900 numbers.
Default Values
Command History
Functional Notes


2) 555-812[012] matches 555-8120 to 555-8122.

Usage Examples
The following example blocks calls to any 900 number on the line sales:

(config-sales)#reject 1900$

rtp delay-mode
command include:

Syntax Description
Default Values
Command History
Usage Examples

(config-sales)#rtp delay-mode fixed

rtp dtmf-relay

Syntax Description
events (NTEs). Enter an NTE value between 96 and 127.
Default Values
Command History
Usage Examples

(config-sales)#rtp dtmf-relay inband


Syntax Description
Default Values
Command History
Usage Examples
The following example sets the frame packetization time for voice line sales to 10 milliseconds:

(config-sales)#rtp frame-packetization 10

rtp packet-delay

Syntax Description
Default Values
By default, the RTP packet delay for maximum is 100, and for nominal is 50.
Command History
Usage Examples
The following example configures the RTP maximum delay time on voice line sales to 200 milliseconds:

(config-sales)#rtp packet-delay maximum 200


Syntax Description
10 and 63.
Default Values
setting for RTP packets.
Command History
Functional Notes
desired DSCP value.
Usage Examples
The following example configures the RTP QoS DSCP for voice line sales to 60:

(config-sales)#rtp qos dscp 60

seize-timeout <seconds>
Use the seize-timeout command to specify the maximum time the trunk will be seized before placing a
call. Use the no form of this command to return to the default timeout interval.
Syntax Description
<seconds> Specifies maximum number of seconds the trunk will be seized before
placing a call. Valid range is 5 to 120 seconds.
Default Values
By default, the seize-timeout period is set to 30 seconds.
Command History
Usage Examples
The following example sets the seize-timeout period to 20 seconds:

(config-sales)#seize-timeout 20

sip-keep-alive
sip-keep-alive info
Syntax Description
3600 seconds.
Default Values
Command History
Usage Examples

(config-sales)#sip-keep-alive info

trunk <Txx>
Use the trunk command to specify the trunk the voice line will use. Use the no form of this command to
remove a configured trunk group.
Syntax Description
<Txx> Specifies an ID number for the trunk. The trunk ID is in the format Txx,
where xx is the trunk ID number. Enter a trunk ID between 1 and 99. For
example, trunk T02.
Default Values
Command History
Usage Examples
The following example adds trunk T02 to the voice line sales:

(config-sales)#trunk t02

vad
Syntax Description
No subcommands.
Default Values
By default, VAD is enabled for all T1 robbed-bit signaling (RBS) trunks and users.
Command History
Usage Examples
The following example disables VAD on voice line sales:

(config-sales)#no vad

Command Reference Guide Voice Loopback Account Command Set
VOICE LOOPBACK ACCOUNT COMMAND SET
A loopback account is an internal account that creates a Realtime Transport Protocol (RTP) loopback.
Loopback calls allow you to actively troubleshoot voice issues. Loopback calls can be originated from the
command line interface (CLI), or the configured loopback extension can automatically answer an
incoming call. During the loopback call, you hear a mirror copy of the transmitted audio path. The
loopback call gives you the ability to verify two-way audio, test latency, and judge call quality. Unlike
normal calls between two endpoints, statistics are not recorded on loopback calls. Since the audio in the
call is simply a retransmission of the RTP stream, the call is not handled by digital signal processor (DSP)
so information on packet loss, delay, and jitter are not available on loopback calls.
In order to place loopback calls, you will need to configure a loopback extension. This is a special type of
user account that the AOS unit will use to place and/or receive the actual loopback call. A loopback
extension has the same basic configurable options that affect call quality as a normal user account.
Loopback accounts also require the same configuration that any other user account would need in order to
properly interact with the Session Initiation Protocol (SIP) server, SIP identity, external caller ID override,
etc. A dial plan must also be configured for the loopback account. The dial plan is needed for the unit to
accept and route the call. The commands in this section are used for creating and configuring a loopback
account. For additional information about configuring loopback accounts, refer to the Using the AOS
Loopback Account common application guide (article number 2363) available online at
To create a loopback account and enter the Voice Loopback Account Configuration mode, enter the voice
loopback command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config-LB-5555)#

do on page 51
exit on page 53

alc on page 2872

appearances <value> on page 2873
nls on page 2877
plc on page 2879

alc
Use the alc command to enable auto level control (ALC). ALC reduces Realtime Transport Protocol (RTP)
received signals that are out of specification to the predefined levels. It is not necessary to enable ALC on
those networks that guarantee signal levels to be within specification. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
Command History
command set.
Usage Examples
The following example activates ALC for loopback 5555:

(config-LB-5555)#alc

appearances <value>
Use the appearances command to specify the number of simultaneous loopback calls allowed on the
system. The maximum number of calls allowed is five. Use the no form of this command to reset the
number of call appearances allowed on this account.
Syntax Description
<value> Configures the number of calls. Range is 1 to 5.
Default Values
By default, the call appearances is set to 1.
Command History
Usage Examples
The following example specifies that 3 simultaneous loopback calls be allowed on the system:

(config-LB-5555)#appearances 3

caller-id
Use the caller-id command to specify a name or number to display as the caller ID information. Use the no
form of this command to return to the default value. Variations of this command include:
caller-id name <name>

caller-id number <number>
Syntax Description
name <name> Specifies the name of the loopback account.
number <number> Specifies the number of the loopback account.
Default Values
By default, the caller ID will display the extension number used when creating the loopback account. If no
name or alternate number is specified, the loopback extension number will be displayed.
Command History
Usage Examples
The following example sets the caller ID information for the loopback account:

(config-LB-5555)#caller-id name VQMTesting
(config-LB-5555)#caller-id number 372-5555

codec-group <name>
Syntax Description
Default Values
Command History
(ISDN) trunk.
command set.
Functional Notes
on page 2955.
Usage Examples
The following example applies the CODEC list List1 to loopback account 5555:

(config-LB-5555)#codec-group List1

echo-cancellation
Syntax Description
No subcommands.
Default Values
Command History
command set.
Usage Examples
The following example activates echo-cancellation for loopback 5555:

(config-LB-5555)#echo-cancellation

nls
Syntax Description
No subcommands.
Default Values
Command History
command set.
Usage Examples
The following example enables NLS for loopback 5555:

(config-LB-5555)#nls

num-rings <value>
Use the num-rings command to specify the number of rings before the loopback account answers (when
called). Use the no form of this command to return to the default value.
Syntax Description
<value> Specifies the number of rings before answering. Specify 0 through 9 rings.
Entering 0 specifies answering the call immediately.
Default Values
By default, num-rings is set to 0.
Command History
command set.
Usage Examples
The following example sets the number of rings for loopback 5555 to 3:

(config-LB-5555)#num-rings 3

plc
connections by replacing a lost packet with another voice packet in the data stream. Use the no form of this
Syntax Description
No subcommands.
Default Values
Command History
command set.
Usage Examples
The following example disables PLC for loopback 5555:

(config-LB-5555)#no plc

rtp delay-mode
command include:

Syntax Description
Default Values
Command History
command set.
Usage Examples
The following example configures the RTP delay mode as fixed:

(config-LB-5555)#rtp delay-mode fixed

rtp dtmf-relay

Syntax Description
nte <value> Specifies that RTP DTMF event value be relayed OOB using named
telephone events (NTEs). Enter a named telephone event (NTE) value
between 96 and 127.
Default Values
By default, the rtp dtmf-relay is set for nte 101.
Command History
command set.
Usage Examples

(config-LB-5555)#rtp dtmf-relay inband


Syntax Description
Default Values
Command History
command set.
Usage Examples
The following example sets the frame packetization time for loopback account 5555 to 10 milliseconds:

(config-LB-5555)#rtp frame-packetization 10

rtp packet-delay

Syntax Description
fax <value> Sets the fax delay time value in milliseconds. Range is 0 to
500 milliseconds.
nominal <value> Sets the nominal delay time value in increments of 10 milliseconds. Range is
Default Values
By default, the RTP packet delays are fax 300, maximum 100, and nominal 50.
Command History
command set.
Usage Examples
The following example configures the RTP fax delay time for loopback 5555 to 200 milliseconds:

(config-LB-5555)#rtp packet-delay fax 200


Use the rtp qos dscp command to configure the Realtime Transport Protocol (RTP) differentiated services
code point (DSCP) value. Use the no form of this command to return to the default value.
Syntax Description
<value> Configures the RTP value for DSCP. The DSCP values are 0 to 63.
Default Values
Command History
command set.
Usage Examples
The following example sets the RTP quality of service (QoS) DSCP value to 14:

(config-LB-5555)#rtp qos dscp 14

shutdown
Use the shutdown command to disable the loopback account and prevent future calls into the account. Use
the no form of this command to reactivate the loopback account.
Syntax Description
No subcommands.
Default Values
By default, no loopback accounts are configured.
Command History
command set.
Usage Examples
The following example disables the loopback account 5555:

(config-LB-5555)#shutdown

sip-identity
the user. Use the no form of this command to disable the setting. Variations of this command include the
following:

Syntax Description
Default Values
Command History
command set.
Usage Examples
The following example specifies trunk T02 and extension 4400 for SIP identity on the loopback account:

(config-LB-5555)#sip-identity 4400 T02

Command Reference Guide Voice User Account Command Set
VOICE USER ACCOUNT COMMAND SET
Voice user accounts are used to define phone users that are registered to an AOS voice product. There are
three different types of user accounts: Session Initiation Protocol (SIP), analog, and virtual. SIP user
accounts are associated with a SIP user agent. Analog user accounts are user accounts that are associated
with a physical foreign exchange station (FXS) interface. Virtual user accounts are not associated with a
physical port. These user types can be used for special applications such as forwarding calls.
The commands in this section describe how to configure voice features for user accounts. For more
information about configuring voice users, refer to the NetVanta 7100 User Account technical note (article
number 1896) available online at http://kb.adtran.com.
To create a user account and enter the Voice User Account Configuration mode, enter the voice user
>enable
#configure terminal
(config-4444)#

do on page 51
exit on page 53
alc on page 2890

call-waiting on page 2893
connect on page 2895
cos on page 2896
directory-include on page 2901
dnd on page 2902
dnis-digits <value> on page 2903

door-phone on page 2906

first-name <name> on page 2910
forward <number> on page 2911
forward-disconnect on page 2912
fwd-courtesy on page 2913
hotel on page 2914
hotline <number> on page 2915
last-name <name> on page 2916
message-waiting on page 2919
nls on page 2921
notify email on page 2922
num-rings on page 2923
plc on page 2926
rtp frame-packetization mode on page 2930
show voice mail on page 2933
sip-authentication password <password> on page 2935
special-ring-cadences on page 2938
speed-dial <number> on page 2939
station-lock on page 2940
t38 on page 2941

vad on page 2948


alc
alc
alc level -16
alc level -17
alc level -18
alc level -19
alc level -20
alc level -21
alc level -22
Syntax Description
Default Values
Command History
Usage Examples
The following example activates the ALC for voice user 4444:

(config-4444)#alc

block-caller-id
Use the block-caller-id command to block all inbound caller ID delivery to this user. This command
prevents the selected user from receiving caller ID information. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates the block-caller-id command for user 4444:

(config-4444)#block-caller-id

caller-id-override
Use the caller-id-override command to manipulate caller ID information for the user. This command is
used to conceal user’s name and number or to display a different name and number for internal or external
caller ID. Use the no form of this command to disable this feature. Variations of this command include:
caller-id-override external-number <number>

caller-id-override internal-name empty
caller-id-override internal-name <name>
caller-id-override internal-number empty
caller-id-override internal-number <number>
Syntax Description
external-number <number> Replaces the caller ID number on external calls with the specified number.
internal-name Replaces the caller ID name on internal calls.
<name> Inserts this name for caller ID for internal calls.
internal-number Replaces caller ID number on internal calls.
<number> Inserts this number for caller ID for internal calls.
empty Makes the caller ID name or number on internal calls display as blank.
Default Values
Command History
Usage Examples
The following example activates the caller-id-override command for external numbers for user 4444:

(config-4444)#caller-id-override external-number 256-555-8000
This example activates the caller-id-override command for names with internal calls and makes the
display appear blank:

(config-4444)#caller-id-override internal-number empty

call-waiting
Use the call-waiting command to enable call waiting for a user. The selected user will be allowed to
receive caller ID information. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates the call-waiting command for user 4444:

(config-4444)#call-waiting

codec-group <name>
Syntax Description
Default Values
Command History
(ISDN) trunk.
command set.
Functional Notes
on page 2955.
Usage Examples
The following example applies the CODEC list List1 to user 4444:

(config-4444)#codec-group List1

connect
Use the connect command to associate physical ports with the user. This command assigns a specific
station or port type to the user. Use the no form of this command to remove associations. Variations of this
command include:
connect fxs <slot/port>

connect sip
Syntax Description
fxs <slot/port> Specifies that a foreign exchange station (FXS) port is associated with the
user.
sip Specifies that this is a Session Initiation Protocol (SIP) user.
Default Values
By default, users are not associated with physical ports.
Command History
Usage Examples
The following example associates the physical FXS slot 1/port 1 interface with the user 4444:

(config-4444)#connect fxs 1/1
The following example associates a SIP port with the user 4444.

(config-4444)#connect sip

cos
Use the cos command to set class of service (CoS) mode for the user. The CoS can be set to change for the
user based on the current system mode by including the system mode parameter. The CoS defines the types
of phone service that will be available to the user during the time period. Use the no form of this command
cos <name>
cos <system mode> <name>
cos no-access
cos <system mode> no-access
cos override <name>
cos override no-access
Syntax Description
<name> Specifies the predefined CoS.
custom2, custom3, lunch, night, or weekend. Refer to the Functional
Notes of this command for more information on configuring system modes.
no-access Blocks users from placing calls when the CoS is applied.
Default Values
By default, the CoS is set to no-access.
Command History
Release A1 Command was expanded to include the system mode options.
Functional Notes
Additional functionality for this feature is provided by assigning a CoS to a specific system mode. When the
system mode changes at a trigger point, the user’s CoS changes.
For example, a CoS applied to the user when the system mode is specified as night can be used to
prevent outbound calls during evening hours. System modes are defined from the Global Configuration
mode using the command voice system-mode on page 1194.
Usage Examples
The following example specifies the CoS Assistant for the user 4444.

(config-4444)#cos Assistant

The following example configures the user’s CoS to change to general when the system mode changes to
night.

(config-4444)#cos night general

coverage
Use the coverage command to configure call coverage parameters for the user. The call coverage setting
determines how a call is handled if the party dialed does not answer after a specified number of rings. Use
the no form of this command to remove an individual coverage parameter. Variations of this command
include:
coverage aa
coverage global <name>
coverage operator
coverage override external <number>
coverage override global <name>
coverage override operator
coverage override operator num-rings <value>
coverage vm
coverage <system mode> global <name>
Syntax Description
system modes.
auto attendant.

global <name> Uses the specified global call coverage list.

vm <number> Optional. Forwards the phone to the specified mailbox number.
Default Values
By default, no system mode call coverage is specified.
Command History
options.
Release 12.1 Command was updated to include the auto attendant, global, and operator
options.
Functional Notes
Usage Examples
The following example specifies that the user's phone be forwarded to the internal extension 8500 when in
the night system mode after 3 rings.

(config-4444)#coverage night internal 8500 num-rings 3

did <number>
Use the did command to configure direct inward dialing (DID) parameters for the extension. DID is used if
a service provider is providing digits to the unit on inbound calls or if the unit needs to provide DID
information to a piece of customer premises equipment (CPE). Use the no form of this command to disable
this feature.
Syntax Description
<number> Specifies the DID number for the user.
Default Values
Command History
Usage Examples
The following example assigns a did number of 555-4560 to user 4444:

(config-4444)#did 5554560

directory-include
Use the directory-include command to add this user in a dial-by-name (DBN) directory. Adding users to
the directory allows the users to call parties by the voice user’s name stored in the system. Use the no form
directory-include
directory-include first-name <name>
directory-include first-name <name> last-name <name>
directory-include <directory name>
directory-include <directory name> first-name <name>
directory-include <directory name> first-name <name> last-name <name>
Syntax Description
first-name <name> Optional. Specifies the directory entry of the user’s first name to be included
in the directory.
last-name <name> Optional. Specifies the directory entry of the user’s last name to be included
in the directory.
<directory name> Optional. Specifies the name of a directory.
Default Values
Command History
Functional Notes
Using this command automatically retrieves the values stored in the first-name and last-name for the
DBN directory. If a user also uses an alias, you may add extra entries into the DBN directory by specifying
the first and last names within the directory-include command.
By default, a system directory is always available. All voice users are automatically added as members of
the system directory.
Usage Examples
The following example adds the user 4444 to a DBN directory:

(config-4444)#directory-include

dnd
Use the dnd command to enable the do-not-disturb (DND) option for the user. This setting prevents the
phone extension assigned to the user from ringing. Use the no form of this command to disable this
feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables DND for user 4444:

(config-4444)#dnd

dnis-digits <value>
Use the dnis-digits command to enable the dialed number identification service (DNIS) delay feature and
to specify the number of DNIS dual tone multi-frequency (DTMF) digits that are outpulsed to the terminal
when a call is routed to an automatic call distributor (ACD), such as a fax server, that is connected to a
foreign exchange station (FXS) port. For more information on how this feature works, refer to the
Functional Notes and Technology Review sections below. Use the no form of this command to disable the
DNIS delay feature. Variations of this command include:
dnis-digits <value>
dnis-digits <value> digit-delay <value>
dnis-digits <value> digit-delay <value> cut-through-delay <value>
Syntax Description
dnis-digits <value> Specifies the number of DNIS digits that are to be outpulsed. Range is 1 to
16 digits.
digit-delay <value> Optional. Specifies the delay (in milliseconds) between the terminal going
off-hook and the first DNIS digit outpulse. The delay is specified in 100 ms
increments and the range is 100 to 1000 ms.
cut-through-delay <value> Optional. Specifies the delay (in milliseconds) between the outpulsing of the
final DNIS digit and the start of two-way voice traffic. The delay is specified
in 100 ms increments and the range is 100 to 2000 ms.
Default Values
By default, this feature is disabled and zero DNIS digits are outpulsed. When the shortest version of the
command is used (dnis-digits <value>), the digit delay is set to 200 ms and the cut-through-delay is set to
500 ms by default.
Command History
Functional Notes
The DNIS delay feature is used when an FXS port is connected to an ACD, such as a fax server. When the
switchboard routes a call to the port and the terminal answers, the trailing digits of the called number are
outpulsed to allow the terminal to finish routing the call. The dnis-digits command allows you to configure
how many digits are outpulsed. For more information on how the feature operates, refer to the Technology
Review section of this command.
This feature is available only when the voice user type is specified as FXS.

Usage Examples
The following example specifies that the voice user’s terminal outpulse 4 DNIS digits and use the delay
default values (200 ms for digit-delay and 500 ms for cut-through-delay):

(config-4444)#dnis-digits 4
Technology Review
The following diagram demonstrates the actions taken by the FXS port and the DNIS delay feature:
FXS status
Idle Alerting Off-hook
DNIS delay
status Idle Outpulse DNIS
Delay 1 Delay 2 Connect
(digit-delay) (cut-through-delay)
The diagram shows that the DNIS feature is idle while the FXS port is alerting and waiting for the terminal
to go off-hook. After the terminal is off-hook, the DNIS feature enters the Delay 1 state, specified by the
digit-delay parameter of this command. Entering this state allows sufficient time for any transients audible
on the two-way wire to die away, and for the terminal to attach a digit register. After Delay 1 times out,
DNIS DTMF digits are outpulsed to the terminal. The feature then enters the Delay 2 state, specified by the
cut-through-delay parameter of this command. Entering this state allows for the connected terminal to
finish routing the call. Once the feature enters the Connect state, a two-way voice band connection is
established. Using the dnis-digits command allows you to specify the number of DNIS digits outpulsed
and the duration of both delay periods in this process.
This feature is intended for use with a fax server, where multiple inbound fax numbers are all routed to a
single analog port. To use this feature effectively, follow these steps:
1. Create a voice user account using the command voice user <extension> on page 1204. The extension
number assigned can be arbitrary, or it can be one of the desired inbound fax lines.
2. Connect an analog port using the command connect on page 2895.
3. Assign an alias for each inbound fax line to be steered into the fax server using the command alias
“<text>” on page 46.
4. Set the number of DNIS digits using the dnis-digits command. These digits must be set in conjunction
with the fax server configuration.

The configuration of the DNIS digits feature appears as follows:

(config-4444)#connect fxs 0/1
(config-4444)#description “fax-server”
(config-4444)#alias 2565552081
(config-4444)#alias 2565552082
(config-4444)#alias 2568882093
(config-4444)#alias 2568882094
(config-4444)#dnis-digits 7
(config-4444)#exit

door-phone
Use the door-phone command to enable the door phone mode for this extension. Use the no form of this
command to disable the door phone mode for this extension.
Syntax Description
No subcommands.
Default Values
By default, the door phone mode is disabled.
Command History
Usage Examples
The following example makes extension 4444 the door phone extension.

(config-4444)#door-phone

echo-cancellation
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example activates echo-cancellation for user 4444:

(config-4444)#echo-cancellation

email <address>
Use the email command to configure the primary email notification address for this extension. Use the no
form of this command to remove a configured email address.
Syntax Description
<address> Specifies the primary email notification address for this extension.
Default Values
Command History
Usage Examples
The following example configures the primary email notification address for this extension as
first.last@company.com.

(config-4444)#email first.last@company.com

Use the email-secondary command to configure the secondary email notification address for this
extension. The secondary email address will be used based on the email notification schedule. Use the no
form of this command to remove a configured secondary email address.
Syntax Description
<address> Specifies the secondary email notification address for this extension.
Default Values
Command History
Usage Examples
The following example configures the secondary email notification address for this extension as
first.last@company.com.

(config-4444)#email-secondary first.last@company.com

first-name <name>
Use the first-name command to specify the user’s first name. The name will represent the user’s first
name in the system. Use the no form of this command to remove a first name.
Syntax Description
<name> Specifies the user’s first name.
Default Values
Command History
Usage Examples
The following example specifies the first name of user 4444:

(config-4444)#first-name John

forward <number>
Use the forward command to redirect all calls to this extension to a specified number. Forwarding calls
allows the user to receive incoming calls at a different number. Use the no form of this command to disable
this feature.
Syntax Description
<number> Forwards all calls to the specified number. Do not include dashes or
hyphens in the number.
Default Values
Command History
Usage Examples
The following example forwards all calls to user 4444 to the number 256-555-8000:

(config-4444)#forward 2565558000

forward-disconnect
Use the forward-disconnect command to specify the method of manipulating the polarity to signal a
disconnect of the line. Use the no form of this command to disable this feature. Variations of this
command include:
forward-disconnect battery remove

forward-disconnect battery reverse
forward-disconnect delay <value>
Syntax Description
battery remove Specifies that the battery will be removed upon disconnect.
battery reverse Specifies that the battery will be reversed upon disconnect.
delay <value> Sets a forward disconnect delay time value in milliseconds. Specify 250,
500, 750, 1000, or 2000 milliseconds.
Default Values
Command History
Usage Examples
The following example removes the battery upon disconnect for user 4444. This command is used most
often with a fax machine that needs to be alerted that a call has ended:

(config-4444)#forward-disconnect battery remove

fwd-courtesy
Use the fwd-courtesy command to enable the courtesy ring feature when a call is forwarded to notify the
user that an incoming call has been re-routed. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example sends a courtesy ring when a call is forwarded:

(config-4444)#fwd-courtesy

hotel
Use the hotel command to allow extension reassignment to an alternate phone. Use the no form of this
command to deny extension reassignment.
Syntax Description
No subcommands.
Default Values
By default, the hotel feature is disabled.
Command History
Usage Examples
The following example enables the user to assign extension 4444 to an alternate phone:

(config-4444)#hotel

hotline <number>
Use the hotline command to configure the user’s phone as a hotline phone. When the user picks up the
phone, it will automatically ring the extension assigned. Use the no form of this command to disable this
feature.
Syntax Description
<number> Specifies the hotline number to dial when the phone is off-hook.
Default Values
Command History
Usage Examples
The following example sets up user 4444 as a hotline and specifies that the number 256-555-8000 will be
dialed when user 4444’s phone is off-hook:

(config-4444)#hotline 2565558000

last-name <name>
Use the last-name command to specify the user’s last name. The stored name will appear in the caller ID
information and directory for the user. Use the no form of this command to remove a last name.
Syntax Description
<name> Specifies the user’s last name.
Default Values
Command History
Usage Examples
The following example specifies the last name of user 4444:

(config-4444)#last-name Smith


command include:

Syntax Description
Default Values
Command History
Functional Notes
are:


2) 555-812[012] matches 555-8120 to 555-8122.
MATCH # SUBST #

Usage Examples
substituted by 555-8110 for outbound calls for user 4444:

(config-4444)#match ani 555-811[125] substitute 555-8110

message-waiting
Use the message-waiting command to configure message-waiting notification methods. Use this
command to select the phone alert used to notify users of new voicemail. Use the no form of this command
message-waiting both
message-waiting dialtone-only
message-waiting lamp-only
Syntax Description
both Sets message-waiting notification for both dial tone and lamp.
dialtone-only Sets message-waiting notification for dial tone only.
lamp-only Sets message-waiting notification for lamp-only.
Default Values
Command History
Usage Examples
The following example sets message-waiting notification for user 4444 for both dial tone and lamp:

(config-4444)#message-waiting both

modem-passthrough
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples

(config-4444)#no modem-passthrough

nls
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables NLS for user 4444:

(config-4444)#nls

notify email
Use the notify email command to indicate either the primary or secondary email address for voicemail
notification during the voicemail notification schedule. The primary and secondary email addresses must
be configured using the commands email <address> on page 2908 and email-secondary <address> on
page 2909. Use the no form of this command to disable this feature. Variations of this command include
the following:
notify email primary

notify email secondary
Syntax Description
primary Specifies that email notifications for this schedule will be sent to the primary
email address.
secondary Specifies that email notifications for this schedule will be sent to the
secondary email address.
Default Values
Command History
Usage Examples
The following example configures the unit to send email notification for this schedule to the secondary
email address.

(config-4444)#voicemail notify schedule monday 06:00 am
Configuring New Schedule “monday 06:00 am”.
(config-4444-mon-06:00am)#notify email secondary

num-rings
include:
num-rings <value>
Syntax Description
system modes.
rings. Entering 0 specifies an unlimited number of rings.
Default Values
By default, the num-rings is set to 4.
Command History
Functional Notes
Usage Examples
The following example allows the extension 4444 to ring 6 times before redirecting the call:

(config-4444)#num-rings 6

The following example sets the number of rings to 1 before redirecting the call when the system mode is
set to weekend:

(config-4444)#num-rings weekend 1

password <password>
Use the password command to create a password or personal identification number (PIN) to protect voice
settings and messages. Use the no form of this command to remove a password.
Syntax Description
<password> Specifies a 4-digit password or PIN.
Default Values
Command History
Usage Examples
The following example sets the password for user 4444 to 4321:

(config-4444)#password 4321

plc
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example disables PLC for user 4444:

(config-4444)#no plc

rtp delay-mode
command include:

Syntax Description
adaptive Configures RTP jitter buffer packet delay to adjust during a call based on
network conditions.
Default Values
Command History
Usage Examples

(config-4444)#rtp delay-mode fixed

rtp dtmf-relay

Syntax Description
nte <value> Specifies that RTP DTMF event value be relayed OOB using named
telephone event (NTE). Enter an NTE value between 96 and 127.
Default Values
Command History
Usage Examples

(config-4444)#rtp dtmf-relay inband


Syntax Description
Default Values
Command History
Usage Examples
The following example sets the frame packetization time for user 4444 to 10 milliseconds:

(config-4444)#rtp frame-packetization 10

rtp frame-packetization mode

Use the rtp frame-packetization mode command to specify the method for determining the Realtime
Transport Protocol (RTP) frame packetization period on received calls. Use the no form of this command
to return to the default value. Variations of this command include:
rtp frame-packetization mode fixed

rtp frame-packetization mode negotiated
Syntax Description
fixed Specifies that received calls always use the configured packetization period.
This period is set using the command rtp frame-packetization <value> on
page 2929.
negotiated Specifies that the trunks and users use the packetization period specified in
the Session Description Protocol (SDP) offer.
Default Values
By default, the rtp frame-packetization mode is set to negotiated.
Command History
Usage Examples
The following example sets the method for determining the frame packetization mode for user 4444 to
fixed:

(config-4444)#rtp frame-packetization mode fixed

rtp packet-delay

Syntax Description
fax <value> Sets the fax delay time value in milliseconds. Range is 0 to
500 milliseconds.
nominal <value> Sets the nominal delay time value in increments of 10 milliseconds. Range is
Default Values
Command History
Usage Examples
The following example configures the RTP fax delay time for user 4444 to 200 milliseconds:

(config-4444)#rtp packet-delay fax 200


Syntax Description
10 and 63.
Default Values
Command History
Functional Notes
desired DSCP value.
Usage Examples
The following example configures the RTP QoS DSCP for user 4444 to 60:

(config-4444)#rtp qos dscp 60

show voice mail

Use the show voice mail command to display a user’s voicemail information. This command can also be
executed from the Enable mode prompt using the syntax explained in show voice mail on page 671.
show voice mail

show voice mail notify-schedule
Syntax Description
notify-schedule Displays the voicemail notification schedule.
Default Values
Command History
include.
Usage Examples
The following example shows sample output from the show voice mail command for extension 4444:

(config-4444)#show voice mail
Voicemail information for account: 4444
VM Class of Service: normal_voicemail
Standard Greeting (min): 01:00 Total Voicemail Usage (min): 05:00
Alternate Greeting (min): 01:00 Total Voicemail Free (min): 10:00
Recorded Name (min): 00:10

The following is sample output for the show voice mail notify-schedule command for extension 4444:

(config-4444)#voicemail notify schedule monday 06:00 am
Configuring New Schedule "monday 06:00 am".
(config-4444-mon-06:00am)#show voice mail notify-schedule
Start End Email 1 Email 2

--------------------------------------------------------------------------------------------
Sun 12:00am Sun 11:59pm --- ---
Mon 12:00am Mon 5:59am --- ---
Mon 6:00am at 11:59pm --- ---

sip-authentication password <password>

Use the sip-authentication password command to configure the Session Initiation Protocol (SIP)
authentication password for this user. Use the no form of this command to remove the authentication
password.
Syntax Description
<password> Specifies a string to be sent as the password in authentication.
Default Values
By default, no SIP authentication password is configured.
Command History
Usage Examples
The following example specifies that user 4444 will use the password Password for authentication:

(config-4444)#sip-authentication password Password

sip-identity
the user. Use the no form of this command to disable the settings. Variations of this command include the
following:

Syntax Description
Default Values
Command History
Usage Examples

(config-4444)#sip-identity 4400 T02

sip-keep-alive
sip-keep-alive info
Syntax Description
3600 seconds.
Default Values
Command History
Usage Examples

(config-4444)#sip-keep-alive info

special-ring-cadences
Use the special-ring-cadences command to enable special ring cadences for this user. This command
allows the user to be alerted with a distinctive ring. Use the no form of this command to disable this
feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables special ring cadences for user 4444:

(config-4444)#special-ring-cadences

speed-dial <number>
Use the speed-dial command to assign a number (1 through 20) to the user. The speed dial number allows
the user to call each other by simply dialing 1- or 2-digit numbers. Use the no form of this command to
Syntax Description
<number> Specifies the speed dial number for the user. Select from numbers 1
through 20.
Default Values
Command History
Usage Examples
The following example assigns a speed-dial number to user 4444:

(config-4444)#speed-dial 2

station-lock
Use the station-lock command to lock the (station) against inbound or outbound calls. Locking a station
will restrict phone privileges. Use the no form of this command to disable this feature. Variations of this
command include:
station-lock admin
station-lock admin inbound
station-lock admin inbound-outbound
station-lock user
station-lock user inbound
station-lock user inbound-outbound
Syntax Description
admin Allows the administrator to block calls.
user Allows the user to block calls.
inbound Blocks inbound calls.
inbound-outbound Blocks both inbound and outbound calls.
Default Values
Command History
Usage Examples
The following example configures an administrator inbound and outbound station lock:

(config-4444)#station-lock admin inbound-outbound

t38
feature.
work.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables T.38 for user 4444:

(config-4444)#t38
Technology Review


Syntax Description
Default Values
Command History
Usage Examples
The following example sets the t38 error-correction to fec for user 4444:

(config-4444)#t38 error-correction fec


feature.
Syntax Description
Default Values
Command History
Usage Examples
The following example enables the t38 fallback-mode for voice user 4444:

(config-4444)#t38 fallback-mode g711


Syntax Description
400 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-buffer to 100 for user 4444:

(config-4444)#t38 max-buffer 100


Syntax Description
0 to 300 bytes.
Default Values
Command History
Usage Examples
The following example sets the t38 max-datagram to 100 for user 4444:

(config-4444)#t38 max-datagram 100

t38 max-rate
t38 max-rate 14400

t38 max-rate 12000
t38 max-rate 2400
t38 max-rate 4800
t38 max-rate 7200
t38 max-rate 9600
Syntax Description
Default Values
Command History
Usage Examples
The following example sets the t38 max-rate to 4800 for user 4444:

(config-4444)#t38 max-rate 4800

t38 redundancy

Syntax Description
Default Values
Command History
Usage Examples
messages to 3 for user 4444:

(config-4444)#t38 error-correction redundancy
(config-4444)#t38 redundancy high-speed 3

vad
Syntax Description
No subcommands.
Default Values
By default, VAD is enabled for all voice trunks and users.
Command History
Usage Examples
The following example disables VAD for user 4444:

(config-4444)#no vad

voicemail

voicemail auto-play
voicemail new-user
Syntax Description
are -30, -25, -20, -15, or -10 dB.


Default Values
Command History
Usage Examples
The following example sets the voicemail CoS for this user to class1:

(config-4444)#voicemail cos class1

VOICE SERVICES COMMAND SETS

• Voice Auto Attendant Command Set on page 2952

• Voice CODEC List Command Set on page 2955
• Voice CoS Command Set on page 2959
• Voicemail CoS Command Set on page 2995
• VQM Reporter Command Set on page 3003

Command Reference Guide Voice Auto Attendant Command Set
VOICE AUTO ATTENDANT COMMAND SET
Auto attendant is a voice feature that allows callers to be automatically transferred to an extension without
any operator action. The commands in this section allow you to configure an auto attendant and to specify
which files the auto attendant will use, as well as to configure Session Initiation Protocol (SIP) parameters
so the auto attendant can be used in conjunction with system modes. For more information on configuring
the voice auto attendant, refer to the Configuring the Auto Attendant common application guide (article
number 1822) available online at http://kb.adtran.com.
To create an auto attendant and enter the Voice Auto Attendant Configuration mode, enter the voice
autoattendant <name> <extension> command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#voice autoattendant Example 1212
(config-aa1212)#

do on page 51
end on page 52
exit on page 53
shutdown on page 61
entry-filename <name> on page 2953


entry-filename <name>
Use the entry-filename command to enter the extensible markup language (XML) file to use for this auto
attendant. Use the no form of this command to disable the setting.
Syntax Description
<name> Specifies the name of the XML file name to use for this auto attendant.
Default Values
Command History
Usage Examples
The following example shows the entry-filename command being executed to select the XML file to use
for this auto attendant:

(config-aa1212)#entry-filename Operaa

sip-identity
Use the sip-identity command to configure Session Initiation Protocol (SIP) registration options for the
user. Use the no form of this command to disable the setting. Variations of this command include the
following:

Syntax Description
auth-name <username> Sets the user name that will be required as authentication for registration to
the SIP server.
password <password> Sets the password that will be required as authentication for registration to
the SIP server.
Default Values
Command History
Usage Examples
The following example configures the auto attendant to use extension 5000 as its identity on trunk T02:

(config-aa1212)#sip-identity 5000 T02

Command Reference Guide Voice CODEC List Command Set
VOICE CODEC LIST COMMAND SET
Voice coder-decoder (CODEC) lists are lists of CODECs arranged in preferred order with the first listed
CODEC being the most preferred for call negotiation.
The primary reason to create and assign voice CODEC lists is to save time. CODEC lists are created,
listing CODECs in the order of preference, and then lists are applied to interfaces using the codec-group
command (refer to the specific interface configuration command set for more information). Configuring a
CODEC list allows the list to be applied to multiple interfaces, such as Media Gateway Control Protocol
(MGCP) interfaces, voice trunks, voice accounts, and voice users without having to define the order of
CODECs individually. The order of preference is used primarily to conserve bandwidth on wide area
network (WAN)-based interfaces.
For example, when a user makes an outbound call from a foreign exchange station (FXS) port to a Session
Initiation Protocol (SIP) trunk, the trunk will look at its CODEC list and query the user making the call as
to which CODEC is to be used according to its CODEC list. It will query with the first CODEC (for
example, G.729). If this CODEC is listed in the CODEC list that is applied to the user (no matter the
CODEC preference on the user interface), then G.729 is agreed upon and the call will be converted and
sent out the trunk. This is the most bandwidth conservative CODEC in this case.
To activate the Voice CODEC List Configuration mode, enter the voice codec-list trunk command at the
>enable
#configure terminal
(config-codec)#
do on page 51
exit on page 53
codec on page 2956

default on page 2958

codec
Use the codec command to specify the order of preference for coder-decoders (CODECs) used by the
CODEC list. Use the no form of this command to remove a CODEC from the CODEC list. Variations of
codec g711alaw
codec g711ulaw
codec g722
codec g729
Syntax Description
g711alaw Assigns the G.711 A-Law CODEC (64000 bps) as the preferred CODEC for
negotiation.
g711ulaw Assigns the G.711 Mu-Law CODEC (64000 bps) as the preferred CODEC
for negotiation.
g722 Assigns the G.722 CODEC as the preferred CODEC for negotiation.
g729 Assigns the G.729 CODEC (8000 bps) as the preferred CODEC for
negotiation.
Default Values
By default, no CODEC lists are created.
Command History
Release 15.1 Command was expanded to include the g711alaw parameter.
Release A2.04 Command was expanded to include the g722 parameter.
Functional Notes
You can enter as many CODECs in the list as necessary by repeating the codec command while in the
Voice CODEC List Configuration mode (refer to the Usage Examples section of this command).
Order is important when creating a CODEC list. The interface attempts to use the first CODEC in the list to
negotiate a call. If the first CODEC negotiation is unsuccessful, the interface uses the second CODEC in
the list and so on. If this process is unsuccessful, the call will fail.
CODEC lists do not take any action until they are applied to an interface. For information on applying
CODEC lists, refer to the codec-group <name> command in the command section of the interface to
which you want to apply the list.

Usage Examples
The following example creates a CODEC list, List1, and specifies that the interface to which this list is
applied will use g729 first, g711ulaw second, and g722 third as it negotiates the call:

(config-codec)#codec g729
(config-codec)#codec g711ulaw
(config-codec)#codec g722

default
Use the default command to set the coder-decoder (CODEC) list as the default list for call negotiation on
the interface to which it is applied. Use the no form of this command to remove the CODEC list as the
default.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example specifies the CODEC list List1 is used as the default list for call negotiation on the
interfaces to which the list is applied:

(config-codec)#default

Command Reference Guide Voice CoS Command Set
VOICE COS COMMAND SET
Class of service (CoS) defines the permissions available to a system user for making voice calls, and it is
necessary to configure CoS before calls can be made (other than to the operator and 911). Voice CoS
permissions include the types of calls and actions a user can perform. There are three default classes of
voice CoS: normal users, executive users, and public phones, but you can also create your own class. A
maximum of 10 voice CoS types can be defined. The commands in this section help you to define voice
CoS classes so they can be applied to voice users. Voice CoS classes created with these commands are
applied to users using the cos command, detailed in the Voice User Account Command Set on page 2887.
For more information on configuring voice CoS, refer to the NetVanta 7000 Series Classes of Service
quick configuration guide (article number 2197) available online at http://kb.adtran.com.
To create a voice CoS and enter the Voice CoS Configuration mode, enter the voice class-of-service
>enable
#configure terminal
Configuring Existing Level “set1”.
(config-cos-set1)#
do on page 51
exit on page 53
aa-initiate-permit <template> on page 2961

billing-codes on page 2962
call-privilege on page 2964
camp-on on page 2966
conference on page 2967
default-level on page 2968
deny-template <template> on page 2969
disable-callwaiting on page 2970
dnd on page 2971
door-phone on page 2972
external-fwd on page 2973
forward on page 2974

hold on page 2975

hotel on page 2976
logout-group on page 2977
message-waiting on page 2978
overhead-paging on page 2979
override-passcode <passcode> on page 2980
park on page 2981
permit template <number> on page 2982
program-user-speed on page 2983
redial on page 2984
remote-fwd on page 2985
rename <name> on page 2986
retrieve-park on page 2987
return-last-call on page 2988
station-lock on page 2989
system-mode on page 2990
system-speed on page 2991
transfer on page 2992
unlock-door on page 2993
user-speed on page 2994

aa-initiate-permit <template>
Use the aa-initiate-permit command to enable the handsfree auto answer feature. Handsfree voice
communication (similar to using a speakerphone or intercom) will be available for the programmed
number template. When using aa-initiate-permit, the receiving party’s phone automatically answers the
phone. Use the no form of this command to disable this feature.
Syntax Description
<template> Allows users with the specified number template to initiate auto answer
calls.
Default Values
By default, aa-initiate-permit is disabled.
Command History
Functional Notes
In order to place an auto answer call, you must dial ** prior to the number. Users can also program ** as a
soft key to dial ** separately before dialing the number to call. Users must dial *971 to block auto answer
calls and *970 to reactivate the feature.
Usage Examples
The following example enables the handsfree auto answer for users with the extension range of 4200 to
4299:

(config-cos-set1)#aa-initiate-permit 42xx

billing-codes
Use the billing-codes command to enable a billing account code collection. If enabled, users must enter a
billing code prior to dialing a number. This feature is useful for controlling access to the long distance
privileges. Use the no form of this command to disable account code collection.
Syntax Description
No subcommands.
Default Values
By default, billing codes are disabled.
Command History
Usage Examples
The following example enables account code collection in rule set set1:

(config-cos-set1)#billing-codes

block-caller-id
Use the block-caller-id command to conceal caller ID information for outbound calls. Use the no form of
this command to allow caller ID for outbound calls.
Syntax Description
No subcommands.
Default Values
By default, the block-caller-id feature is disabled.
Command History
Usage Examples
The following example blocks caller ID for outbound calls in rule set set1:

(config-cos-set1)#block-caller-id

call-privilege
Use the call-privilege command to assign general call privileges for outbound access. This determines
what type of calls a user is permitted to make as a member of this class of service (CoS). Use the no form
of this command to remove general call privileges for outbound access. Variations of this command
include:
call-privilege 900-number
call-privilege all
call-privilege extensions
call-privilege international
call-privilege local
call-privilege long-distance
call-privilege operator-assisted
call-privilege specify-carrier
call-privilege toll-free
call-privilege [user1 | user2 | user3]
Syntax Description
900-number Permits 900 calls in the form 1-900-NXX-XXXX and 976-XXXX.
all Permits all calls.
extensions Permits internal calls.
international Permits international calls in the form 011-number.
local Permits local calls in the form NXX-XXXX.
long-distance Permits long distance calls in the form 1-NXX-NXX-XXXX.
operator-assisted Permits operator-assisted calls.
specify-carrier Permits calls that specify carrier.
toll-free Permits toll free calls.
user1 Permits calls that match the first user-defined template.
user2 Permits calls that match the second user-defined template.
user3 Permits calls that match the third user-defined template.
Valid characters include:
0-9 - Any single digit.
X - Any single digit 0 through 9.
N - Any single digit 2 through 9.
Default Values
By default, no call privileges are enabled.
Command History

Usage Examples
The following example permits long distance calls in rule set set1:

(config-cos-set1)#call-privilege long-distance

camp-on
Use the camp-on command to allow automatic retry of a busy extension. This feature enables a user to
reach the busy party as soon as the line is available. Use the no form of this command to disable automatic
retry.
Syntax Description
No subcommands.
Default Values
By default, the camp-on feature is disabled.
Command History
Usage Examples
The following example enables automatic retry of a busy extension in rule set set1:

(config-cos-set1)#camp-on

conference
Use the conference command to allow the initiation of three-way conference calls. This feature allows
multiple parties to communicate at the same time on the same line. Use the no form of this command to
Syntax Description
No subcommands.
Default Values
By default, the three-way conference call feature is disabled.
Command History
Usage Examples
The following example allows the initiation of three-way conference calls in rule set set1:

(config-cos-set1)#conference

default-level
Use the default-level command to set this class of service (CoS) level as the default. When enabled, new
users that are added to the system are assigned this CoS by default. To change the default from this CoS
level, use the no form of this command.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example sets the rule set set1 as the default CoS level:

(config-cos-set1)#default-level

deny-template <template>
Use the deny-template command to configure a number template that specifies the types of calls that users
in this class of service (CoS) are not allowed to make. Use the no form of this command to remove a deny
template.
Syntax Description
<template> Specifies a number template. All calls matching this pattern will be denied.
Valid characters include:
0-9 - Any single digit.
X - Any single digit 0 through 9.
N - Any single digit 2 through 9.
M - Any single digit 2 through 8.
[ ] - Any single digit of those within the brackets.
-(), - Punctuation characters that are ignored.
For example: 555-81XX matches 555-8100 through 555-8199 and
555-812[0,1,2] matches 555-8120 through 555-8122.
Default Values
Command History
Usage Examples
The following example denies users in rule set set1 the ability to make any call beginning with 555:

(config-cos-set1)#deny-template 555-xxxx

disable-callwaiting
Use the disable-callwaiting command to allow users to control the call waiting feature. Disabling call
waiting will block the alert of an incoming call while the user is on the phone. Use the no form of this
command to enable call waiting.
Syntax Description
No subcommands.
Default Values
By default, call waiting is enabled.
Command History
Usage Examples
The following example allows users in rule set set1 to disable call waiting:

(config-cos-set1)#disable-callwaiting

dnd
Use the dnd command to enable do-not-disturb (DND). Do-not-disturb makes the line appear busy to
incoming calls. Use the no form of this command to return to the default setting.
Syntax Description
No subcommands.
Default Values
By default, the do-not-disturb feature is disabled.
Command History
Usage Examples
The following example enables the do-not-disturb feature in rule set set1:

(config-cos-set1)#dnd

door-phone
Use the door-phone command to allow the user to call the door phone using a special prefix (SPRE) code.
Use the no form of this command to deny door phone access.
Syntax Description
No subcommands.
Default Values
By default, door phone access is denied.
Command History
Usage Examples
The following example allows door phone access in voice class of service (CoS) rule set named set1:

(config-cos-set1)#door-phone

external-fwd
Use the external-fwd command to allow forwarding of calls to an external number. When enabled, the
users can forward their phones to lines outside the system, such as their home numbers. Use the no form of
this command to disable external call forwarding.
Syntax Description
No subcommands.
Default Values
By default, forwarding calls to an external number is disabled.
Command History
Usage Examples
The following example allows users in rule set set1 to forward calls to an external number:

(config-cos-set1)#external-fwd

forward
Use the forward command to allow users to forward calls to another extension. Forwarding calls allows
the user to receive incoming calls at a different number. Use the no form of this command to end call
forwarding.
Syntax Description
No subcommands.
Default Values
By default, internal call forwarding is disabled.
Command History
Usage Examples
The following example allows users in rule set set1 to forward calls:

(config-cos-set1)#forward

hold
Use the hold command to allow users to place calls on standby. Use the no form of this command to
disable the call hold option.
Syntax Description
No subcommands.
Default Values
By default, the call hold option is disabled.
Command History
Usage Examples
The following example enables users in rule set set1 to place a call on hold:

(config-cos-set1)#hold

hotel
Use the hotel command to allow extension reassignment to an alternate phone. Use the no form of this
command to disable extension reassignment.
Syntax Description
No subcommands.
Default Values
By default, the hotel feature is disabled.
Command History
Usage Examples
The following example enables users in rule set set1 to reassign an extension to an alternate phone:

(config-cos-set1)#hotel

logout-group
Use the logout-group command to allow a user to issue a special prefix (SPRE) command to log out of a
user group. Use the no form of this command to deny the ability to log out of a user group.
Syntax Description
No subcommands.
Default Values
By default, the ability to log out of a user group is denied.
Command History
Usage Examples
The following example allows the user in rule set set1 to log out of a user group:

(config-cos-set1)#logout-group

message-waiting
Use the message-waiting command to allow message waiting indicator control. This allows users to
change the manner in which message notification takes place. Use the no form of this command to disable
message waiting indicator control.
Syntax Description
No subcommands.
Default Values
By default, control of the message waiting indicator is disabled.
Command History
Usage Examples
The following example allows users in rule set set1 to manage message waiting indicators:

(config-cos-set1)#message-waiting

overhead-paging
Use the overhead-paging command to allow the user to connect to overhead paging using a special prefix
(SPRE) code. Use the no form of this command to deny the ability to connect to overhead paging.
Syntax Description
No subcommands.
Default Values
By default, the ability to connect to overhead paging is denied.
Command History
Usage Examples
The following example allows the user in rule set set1 to connect to overhead paging:

(config-cos-set1)#overhead-paging

override-passcode <passcode>
Use the override-passcode command to assign an override passcode. This four-digit code is used in
conjunction with the class of service (CoS) override feature and enables a user to override an extension’s
configured CoS with the new CoS as defined by the passcode. Use the no form of this command to remove
an override passcode.
Syntax Description
<passcode> Specifies a four-digit numerical passcode.
Default Values
Command History
Usage Examples
The following example sets the override passcode to 1234 in rule set set1:

(config-cos-set1)#override-passcode 1234

park
Use the park command to allow users to park calls on the system. Use the no form of this command to
disable the call parking feature.
Syntax Description
No subcommands.
Default Values
By default, the parking feature is enabled.
Command History
Usage Examples
The following example allows users to park calls in rule set set1:

(config-cos-set1)#park

permit template <number>

Use the permit template command to configure call privilege additions that are permitted access only.
This specifically allows an otherwise restricted number to be dialed. Use the no form of this command to
remove the template.
Syntax Description
<number> Specifies the number that may be dialed. The number is in the form
NXX-XXXX, where N is 2 to 9 and X is 0 to 9.
Default Values
Command History
Usage Examples
The following example allows the number 325-1234 to be dialed in rule set set1:

(config-cos-set1)#permit template 325-1234

program-user-speed
Use the program-user-speed command to allow users to access speed dial functionality through the
system. Use the no form of this command to disable the speed dialing feature.
Syntax Description
No subcommands.
Default Values
By default, the speed dial feature is disabled.
Command History
Usage Examples
The following example enables the speed dial feature for users in rule set set1:

(config-cos-set1)#program-user-speed

redial
Use the redial command to grant users access to the redial functionality, which redials the last outgoing
number. Use the no form of this command to disable last number redial.
Syntax Description
No subcommands.
Default Values
By default, the last number redial feature is disabled.
Command History
Usage Examples
The following example enables the last number redial feature in rule set set1:

(config-cos-set1)#redial

remote-fwd
Use the remote-fwd command to allow a user to control call forwarding from a remote location. Use the
no form of this command to disable remote forwarding.
Syntax Description
No subcommands.
Default Values
By default, remote forwarding feature is disabled.
Command History
Usage Examples
The following example allows users in rule set set1 to enable call forwarding from a remote location:

(config-cos-set1)#remote-fwd

rename <name>
Use the rename command to assign a new name to the class of service (CoS) rule set.
Syntax Description
<name> Specifies the new name of the CoS rule set.
Default Values
Command History
Usage Examples
The following example changed the name of rule set set1 to accounting:

(config-cos-set1)#rename accounting
(config-cos-accounting)#

retrieve-park
Use the retrieve-park command to allow the retrieval of parked calls. Use the no form of this command to
disable the retrieve parked calls feature.
Syntax Description
No subcommands.
Default Values
By default, the retrieve parked calls feature is disabled.
Command History
Usage Examples
The following example enables retrieval of parked calls in rule set set1:

(config-cos-set1)#retrieve-park

return-last-call
Use the return-last-call command to allow users to return the last call received. Use the no form of this
command to disable the return last call received feature.
Syntax Description
No subcommands.
Default Values
By default, the return-last-call feature is disabled.
Command History
Usage Examples
The following example allows users in rule set set1 to return the last call received:

(config-cos-set1)#return-last-call

station-lock
Use the station-lock command to allow users to lock an extension, preventing it from making outbound
calls. Use the no form of this command to revoke user’s ability to disable outbound calling capabilities.
Syntax Description
No subcommands.
Default Values
By default, the station-lock feature is disabled. Users are not allowed to block their extension’s capability
to place outbound calls.
Command History
Usage Examples
The following example enables the station-lock feature in rule set set1:

(config-cos-set1)#station-lock

system-mode
Use the system-mode command to enable the system mode feature for this class of service (CoS). Once
enabled, users to whom this CoS is applied can activate different system modes on the unit via the
command line interface (CLI), special prefix (SPRE) codes, auto attendant, or the Web-based graphical
user interface (GUI). Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
Command History
Usage Examples
The following example enables the system mode feature for users with the applied CoS set1:

(config-cos-set1)#system-mode

system-speed
Use the system-speed command to enable system speed dial usage for the system. Use the no form of this
command to disable the system speed setting.
Syntax Description
No subcommands.
Default Values
By default, system-speed is enabled.
Command History
Usage Examples
The following example enables configuration of the system speed in rule set set1:

(config-cos-set1)#system-speed

transfer
Use the transfer command to allow users to perform call transfers. Use the no form of this command to
disable call transfers.
Syntax Description
No subcommands.
Default Values
By default, the call transfer feature is disabled.
Command History
Usage Examples
The following example allows users in rule set set1 to perform call transfers:

(config-cos-set1)#transfer

unlock-door
Use the unlock-door command to enable the user to use a special prefix (SPRE) code to control the door
contact. Use the no form of this command to disable door contact operation.
Syntax Description
No subcommands.
Default Values
By default, door contact operation is disabled.
Command History
Usage Examples
The following example enables door contact operation in rule set set1:

(config-cos-set1)#unlock-door

user-speed
Use the user-speed command to allow users to program speed dial numbers. Use the no form of this
command to deny this privilege.
Syntax Description
No subcommands.
Default Values
By default, user speed dial programming is not allowed.
Command History
Usage Examples
The following example allows users in rule set set1 to program speed dial numbers:

(config-cos-set1)#user-speed

Command Reference Guide Voicemail CoS Command Set
VOICEMAIL COS COMMAND SET
Class of service (CoS) defines the permissions available to a system user, and in this case defines
permissions as they relate to user voicemail. By default, users are not assigned a voicemail CoS. When a
user’s account does not have an assigned voicemail CoS, the user will not have access to a voice mailbox.
The commands in this section help you to create a CoS specifically for voice mailboxes. The classes
created with these commands are then applied to users using the command voicemail on page 2949. For
more information about configuring voicemail CoS and voicemail in general, refer to the NetVanta 7000
Series Voicemail quick configuration guide (article number 2198) available online at http://kb.adtran.com.
To create a voicemail CoS and enter the Voicemail CoS Configuration mode, enter the voice mail
class-of-service command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#voice mail class-of-service class1
Configuring Existing Level “class1”.
(config-vm-class1)#
do on page 51
exit on page 53
expire-time <days> on page 2996

greeting-length-max <time> on page 2997
greeting-quota <time> on page 2998
message-length-max <time> on page 2999
message-quota <time> on page 3000
prompt-delete on page 3001
rename <name> on page 3002

expire-time <days>
Use the expire-time command to set the number of days before a voicemail message expires. Use the no
Syntax Description
<days> Specifies the number of days until a message expires. Valid range is 5 to
60 days. A value of 0 means messages will never expire.
Default Values
By default, the number of days is set to 0, which means messages will never expire.
Command History
Usage Examples
The following example configures the voicemail class of service (CoS) class1 to delete voicemail
messages after 14 days:

Configuring Existing Level "class1".
(config-vm-class1)#expire-time 14

greeting-length-max <time>
Use the greeting-length-max command to set the maximum length (in seconds) for a voicemail greeting.
Syntax Description
<time> Specifies the length in seconds for a voicemail greeting. Valid range is 20 to
120 seconds.
Default Values
By default, the maximum voicemail greeting time is set to 60 seconds.
Command History
Usage Examples
The following example configures the maximum length for a voicemail greeting in rule set class1 to
60 seconds:

(config-vm-class1)#greeting-length-max 60

greeting-quota <time>
Use the greeting-quota command to set the maximum storage time (in minutes) of all greeting messages.
Syntax Description
<time> Specifies the maximum storage time (in minutes) for the storage of all
greeting messages. Valid range is 1 to 9 minutes.
Default Values
By default, the maximum storage time for all greeting messages is 3 minutes.
Command History
Usage Examples
The following example configures the maximum storage time for all greeting messages in rule set class1
to 5 minutes:

(config-vm-class1)#greeting-quota 5

message-length-max <time>
Use the message-length-max command to set the maximum length (in seconds) for a voicemail message.
Syntax Description
<time> Specifies the maximum length (in seconds) for a voicemail message. Valid
Default Values
By default, the maximum length for a voicemail message is 120 seconds.
Command History
Usage Examples
The following example sets the maximum length a voicemail message in rule set class1 to 300 seconds:

(config-vm-class1)#message-length-max 300

message-quota <time>
Use the message-quota command to set the maximum storage time (in minutes) of all voicemail
messages. Use the no form of this command to return to the default value.
Syntax Description
<time> Specifies the maximum storage time (in minutes) of all voicemail messages.
Valid range is 1 to 180 minutes.
Default Values
By default, the maximum storage time of all voicemail messages is 10 minutes.
Command History
Usage Examples
The following example sets the maximum storage time of all voicemail messages in rule set class1 to
120 minutes:

(config-vm-class1)#message-quota 120

prompt-delete
Use the prompt-delete command to configure the unit to prompt the user before deleting messages. Use
the no form of this command to disable the prompt before deleting messages.
Syntax Description
No subcommands.
Default Values
By default, the prompt before deleting messages is disabled.
Command History
Usage Examples
The following example configures the unit to prompt the user before deleting voicemail messages:

(config-vm-class1)#prompt-delete

rename <name>
Use the rename command to rename the voicemail class of service (CoS) rule set. Use the no form of this
command to return to the previous name.
Syntax Description
<name> Specifies the new name of the CoS rule set.
Default Values
Command History
Usage Examples
The following example assigns a new name (class2) to the current CoS rule set class1:

(config-vm-class1)#rename class2

Command Reference Guide VQM Reporter Command Set
VQM REPORTER COMMAND SET
Voice quality monitoring (VQM) allows real time passive Voice over IP (VoIP) quality measurements to
be taken on all Realtime Transport Protocol (RTP) voice streams transmitted through an AOS device. The
VQM reporter is a feature supported by AOS devices that allows the gathered VQM statistics to be
aggregated by third-party collectors, such as the n-Command® managed service provider (MSP) server.
Allowing aggregation by the n-Command MSP server provides more flexibility in monitoring voice
networks.
VQM should be enabled and configured on the AOS device before configuring the VQM reporter. For
information on configuring VQM, refer to the Voice Quality Monitoring configuration guide available on
the CD shipped with your product or online at http://kb.adtran.com (article number 2262). VQM
commands are also detailed in the Global Configuration Mode Command Set on page 714 beginning with
the command ip rtp quality-monitoring on page 923.
To create a VQM reporter and enter the reporter’s configuration mode, enter the ip rtp
quality-monitoring reporter <name> command from the Global Configuration mode prompt. For
example:
>enable
#configure terminal
of this guide. For more information, refer to the section listed below:
do on page 51
exit on page 53
shutdown on page 61
The following are commands used to configure the VQM reporter. These commands are described in this
section in alphabetical order:
collector on page 3004

max-queue-depth <value> on page 3006
max-retries <value> on page 3007
sip grammar on page 3008

collector
Use the collector command to specify the IP address or host name of the server that will be receiving
information from the voice quality monitoring (VQM) reporter. Use the no form of this command to
remove the server from the reporter’s configuration. Variations of this command include:
collector primary <hostname | ip address>

collector primary <hostname | ip address> tcp
collector primary <hostname | ip address> tcp <port>
collector primary <hostname | ip address> udp
collector primary <hostname | ip address> udp <port>
collector secondary <hostname | ip address>
collector secondary <hostname | ip address> tcp
collector secondary <hostname | ip address> tcp <port>
collector secondary <hostname | ip address> udp
collector secondary <hostname | ip address> udp <port>
Syntax Description
primary Specifies that the server is the primary contact server for the VQM reporter.
secondary Specifies that the server is the secondary contact server for the VQM
reporter.
<hostname | ip address> Specifies the host name or IP address of the server. IP addresses should be
expressed in the decimal dotted notation (for example, 10.10.10.1).
tcp Optional. Specifies that the reporter and server communicate using
Transmission Control Protocol (TCP).
udp Optional. Specifies that the reporter and server communicate using User
Datagram Protocol (UDP).
<port> Optional. Specifies the TCP or UDP port used for communication between
the reporter and the server. Range is 0 to 65535.
Default Values
By default, no server is configured.
Command History

Usage Examples
The following example specifies that the VQM reporter uses the server with the IP address of 172.5.67.99
as its primary server:

(config-rtp-reporter-Reporter1)#collector primary 172.5.67.99

max-queue-depth <value>
Use the max-queue-depth command to specify the number of reports held in queue that are waiting to
send requests or receive responses. Use the no form of this command to return the queue depth to the
default value.
Syntax Description
<value> Specifies the number of reports held in queue. Range is 0 to 2000.
Default Values
By default, the reporter is configured to hold 512 reports in queue.
Command History
Usage Examples
The following example sets the reporter to hold 700 reports in its queue:

(config-rtp-reporter-Reporter1)#max-queue-depth 700

max-retries <value>
Use the max-retries command to specify the number of times the reporter will attempt to contact the
server. Use the no form of this command to return the number of attempts to the default value.
Syntax Description
<value> Specifies the number of connection attempts. Range is 0 to 5.
Default Values
By default, the voice quality monitoring (VQM) reporter is set to attempt to connect to the server 3 times.
Command History
Functional Notes
After the reporter has attempted the maximum number of times to contact the server, the reports sent to
the server are discarded. You can see how many reports have been discarded by using the command
debug ip rtp quality-monitoring reporter on page 259.
Usage Examples
The following example sets the number of connection attempts to 4:

(config-rtp-reporter-Reporter1)#max-retries 4

sip grammar
Use the sip grammar command to specify the user that the voice quality monitoring (VQM) reporter
report is coming from and to which user it is going. Use the no form of this command to return the user
values to the default. Variations of this command include:
sip grammar from-user <username>

sip grammar to-user <username>
Syntax Description
from-user <username> Specifies the user from which the report originates.
to-user <username> Specifies the user to which the report is destined.
Default Values
By default, the from-user is set to the unit’s serial number.
By default, the to-user is set to the specified server.
Command History
Usage Examples
The following example specifies that the VQM reporter report originates from user 300:

(config-rtp-reporter-Reporter1)#sip grammar from-user 300

VPN PARAMETER COMMAND SETS

• CA Profile Command Set on page 3010

• Certificate Command Set on page 3021
• Crypto Map IKE Command Set on page 3025
• Crypto Map Manual Command Set on page 3042
• IKE Client Command Set on page 3053
• IKE Policy Attributes Command Set on page 3057
• IKE Policy Command Set on page 3063

Command Reference Guide CA Profile Command Set
CA PROFILE COMMAND SET
To activate the Certificate Authority (CA) Profile Configuration mode, enter the crypto ca profile
>enable
#configure terminal
Configuring New CA Profile MyProfile
(ca-profile)#
do on page 51
end on page 52
exit on page 53
crl optional on page 3011

email address <address> on page 3012
enrollment retry on page 3013
enrollment terminal on page 3014
enrollment url <url> on page 3015
fqdn <name> on page 3016
ip-address <address> on page 3017
serial-number on page 3019
subject-name <name> on page 3020

crl optional
Use the crl optional command to make certificate revocation list (CRL) verification optional.
Syntax Description
No subcommands.
Default Values
By default, CRL optional is enabled.
Command History
Functional Notes
If enabled, AOS is able to accept certificates even if no CRL is loaded into the configuration. Currently, this
is the only mode supported by AOS for CRL negotiations.
Usage Examples
The following example sets CRL verification as optional:

(ca-profile)#crl optional

email address <address>

Use the email address command to specify that an email address should be included in the certificate
request. Use the no form of this command to remove an email address.
Syntax Description
<address> Specifies the complete email address to use when sending certificate
requests. This field allows up to 51 characters.
Default Values
Command History
Functional Notes
Configuring this setting simplifies the crypto ca enroll dialog, allowing you to enter the email address only
once rather than every time you go through the enrollment process. Refer to crypto ca enroll <name> on
page 776.
Usage Examples
The following example specifies joesmith@company.com as the email address to be sent in certificate
requests:

(ca-profile)#email address joesmith@company.com

enrollment retry
Use the enrollment retry command to determine how AOS handles certificate requests. Use the no form
enrollment retry count <number>

enrollment retry period <value>
Syntax Description
count <number> Specifies the number of times AOS re-sends a certificate request when it
does not receive a response from the previous request. Range is 1 to 100.
period <value> Specifies the time period between certificate request retries. The default is
1 minute between retries. Range is 1 to 60 minutes.
Default Values
By default, period is set to 5 minutes, and count is set to 12 retries.
Command History
Usage Examples
The following example configures AOS to send certificate requests every 2 minutes, stopping after
50 retries (if no response is received):

(ca-profile)#enrollment retry count 50
(ca-profile)#enrollment retry period 2

enrollment terminal
Use the enrollment terminal command to specify manual (i.e., cut-and-paste) certificate enrollment. Use
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
This mode is overridden if the enrollment url command specifies the certificate authority (CA) to which
automatic certificate requests are to be sent via Simple Certificate Exchange Protocol (SCEP). Issuing an
enrollment terminal command after using the enrollment url command deletes the uniform resource
locator (URL) and forces the unit to use manual enrollment. Refer to enrollment url <url> on page 3015 for
more information.
Usage Examples
The following example configures AOS to accept manual certificate enrollment input:

(ca-profile)#enrollment terminal

enrollment url <url>

Use the enrollment url command to specify the uniform resource locator (URL) of the certificate
authority (CA) to which AOS should send certificate requests. Use the no form of this command to remove
a URL.
Syntax Description
<url> Specifies the certificate authority’s URL (for example,
http://10.10.10.1:400/abcdefg/pkiclient.exe).
Default Values
Command History
Functional Notes
When entering the URL, http:// is required followed by the IP address or domain naming system (DNS) of
the CA. If the port number is something other than 80, include it after the IP address or DNS name
separated with a colon (:).
The CA may have other necessary information to include in the common gateway interface (CGI) path
before ending with the actual CGI program. An example template to follow is
http://hostname:port/path/to/program.exe.
Use the default program pkiclient.exe without specifying it, end the URL with a slash (/). Otherwise, you
must enter the program name to use. For example, http://10.10.10.1:400/abcdefg/ will assume
pkiclient.exe as the program (but not including the terminating slash is a configuration error).
Specifying this command will override the enrollment terminal setting as described previously (refer to
enrollment terminal on page 3014).
Usage Examples
The following example specifies http://CAserver/certsrv/mscep/mscep.dll as the URL to which AOS will
send certificate requests:

(ca-profile)#enrollment url http://CAserver/certsrv/mscep/mscep.dll

fqdn <name>
Use the fqdn command to specify a fully qualified domain name (FQDN) to be included in the certificate
requests. Use the no form of this command to remove an FQDN.
Syntax Description
<name> Specifies the FQDN (e.g., company.com) to be included in requests.
Default Values
Command History
Functional Notes
Configuring this setting simplifies the crypto ca enroll dialog, allowing you to enter the FQDN only once
rather than every time you go through the enrollment process. Refer to crypto ca enroll <name> on page
776.
Usage Examples
The following example specifies company.com as the FQDN to be sent in certificate requests:

(ca-profile)#fqdn company.com

ip-address <address>
Use the ip-address command to specify an IP address to be included in the certificate requests. Use the no
form of this command to remove a defined IP address.
Syntax Description
<address> Specifies a valid IP address. IP addresses should be expressed in dotted
Default Values
Command History
Functional Notes
Configuring this setting simplifies the crypto ca enroll dialog, allowing you to enter the IP address only
page 776.
Usage Examples
The following example specifies 66.203.52.193 as the IP address to be sent in certificate requests:

(ca-profile)#ip-address 66.203.52.193

password <password>
Use the password command to specify the challenge password for Simple Certificate Exchange Protocol
(SCEP). Use the no form of this command to allow certificate authority (CA) requests to be sent
automatically (using SCEP) without requiring a password.
Syntax Description
<password> Specifies the SCEP password (up to 80 characters).
Default Values
By default, no password is required.
Command History
Functional Notes
There are two places for configuring a SCEP password:
• At the (ca-profile)# prompt.

• If it is not configured at the (ca-profile)# prompt, you are prompted to enter one when going through the
certificate enrollment process.
The password is sent to the CA from which you are requesting a certificate. The CA may then ask for the
password later before a certificate can be revoked. Refer to crypto ca enroll <name> on page 776.
Usage Examples
The following example sets the SCEP challenge password to adtran:

(ca-profile)#password adtran

serial-number
Use the serial-number command to specify that a serial number will be included in the certificate request.
Use the no form of this command to prevent a serial number from being included in the certificate request.
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
By default, this command is set to no serial-number, which means that the serial number is not included
in the certificate requests.
Usage Examples
The following example configures AOS to include a serial number in the certificate request:

(ca-profile)#serial-number

subject-name <name>
Use the subject-name command to specify the subject name used in the certificate request. Use the no
form of this command to remove a configured subject name.
Syntax Description
<name> Specifies a subject name string using up to 256 characters entered in X.500
Lightweight Directory Access Protocol (LDAP) format.
Default Values
By default, there is no subject name configured.
Command History
Functional Notes
Configuring this setting simplifies the crypto ca enroll dialog, allowing you to enter the subject name only
page 776.
Usage Examples
The following example assigns a subject name of Adtran-cert to certificate requests:

(ca-profile)#subject-name Adtran-cert

Command Reference Guide Certificate Command Set
CERTIFICATE COMMAND SET
To activate the Certificate Configuration mode, enter the crypto ca certificate chain command at the
>enable
#configure terminal
(config-cert-chain)#
do on page 51
end on page 52
exit on page 53
certificate <serial number> on page 3022

certificate ca <serial number> on page 3023
crl on page 3024

certificate <serial number>

Use the certificate command to restore a certificate. Use the no form of this command to remove a specific
certificate from the certificate chain.
Syntax Description
<serial number> Specifies the certificate’s serial number (up to 51 characters). This value
can be found for existing certificates by using the show run command.
Default Values
Command History
Functional Notes
The user typically does not enter this command. It is primarily used to restore certificates from the startup
configuration when the product is powered up.
Usage Examples
The following example removes the certificate with the serial number
73f0bfe5ed8391a54d1214390a36cee7:

(config-cert-chain)#no certificate 73f0bfe5ed8391a54d1214390a36cee7

certificate ca <serial number>

Use the certificate ca command to restore a certificate authority (CA) certificate. Use the no form of this
command to remove a specific certificate from the certificate chain for a CA.
Syntax Description
<serial number> Specifies the certificate’s serial number (up to 51 characters). This value
can be found for existing certificates by using the show run command.
Default Values
Command History
Functional Notes
The user typically does not enter this command. It is primarily used to restore certificates from the startup
Usage Examples
The following example removes the CA certificate with the serial number 0712:

(config-cert-chain)#no certificate ca 0712

crl
Use the crl command to restore a certificate revocation list (CRL). Use the no form of this command to
remove the CRL for the specific certificate authority (CA).
Syntax Description
No subcommands.
Default Values
Command History
Functional Notes
The user typically does not enter this command. It is primarily used to restore CRLs from the startup
Usage Examples
The following example removes the CRL for the current CA:

(config-cert-chain)#no crl

Command Reference Guide Crypto Map IKE Command Set
CRYPTO MAP IKE COMMAND SET
To activate the Crypto Map Internet Key Exchange (IKE) mode, enter a valid version of the crypto map
ipsec-ike command at the Global Configuration mode prompt. For example:
>enable
#configure terminal
(config)#crypto map MyMap 100 ipsec-ike
do on page 51
end on page 52
exit on page 53
antireplay on page 3026

commit-bit on page 3027
ike-policy <number> on page 3029
match address <name> on page 3030
match track <name> on page 3032
reverse-route on page 3034
set peer on page 3036
set pfs on page 3038
set security-association idle-time <value> on page 3039
set security-association lifetime on page 3040
set transform-set on page 3041
For virtual private network (VPN) configuration example scripts, refer to the Virtual
Private Network configuration guide available on the AOS Documentation CD provided
with your unit, or online at http://kb.adtran.com (article number 1616).

antireplay
Use the antireplay command to enable anti-replay sequence number checking for all security associations
(SAs) created on this crypto map. Use the no form of this command to disable this feature. Variations of
antireplay
antireplay <value>
Syntax Description
<value> Optional. Specifies the anti-replay window size in bytes. Select from 64,128,
256, 512, or 1024 bytes.
Default Values
By default, the window size is set to 64 bytes.
Command History
Usage Examples
The following example enables anti-replay sequence checking on crypto map VPN 100:

(config-crypto-map)#antireplay

commit-bit
Use the commit-bit command to set the commit-bit in the Internet Security Association and Key
Management Protocol (ISAKMP) header when sending the second message of quick mode on an IPSec
tunnel negotiation. Use the no form of this command to disable this feature.
Syntax Description
No subcommands.
Default Values
By default, the commit-bit will be used.
Command History
Functional Notes
As an extra security measure, the commit-bit can be set by the responder of a quick mode negotiation to
force the initiator to wait for the fourth message of quick mode before bringing up its IPSec security
associations (SAs). By default, this feature is enabled on all AOS products with virtual private network
(VPN) capabilities. Some vendors, however, may have incorrect implementations of the commit-bit that do
not interoperate well with AOS products. In that case, the commit-bit should be disabled on all crypto maps
that have a peer that does not support the commit-bit.
Usage Examples
The following example disables the use of commit-bit:

(config-crypto-map)#no commit-bit
The following example displays a configuration with the commit-bit disabled:
ip crypto
!
crypto ike-policy 100
initiate main
respond main
local-id address 10.10.10.1
peer 192.168.1.1
attribute 2
encryption aes-256-cbc
authentication pre-share
lifetime 3600
!

crypto ike remote-id address 10.10.10.1 preshared-key adtran ike-policy 100 crypto map VPN 10
no-mode-config no-xauth
!
crypto ipsec transform-set esp-aes-256-cbc-esp-sha-hmac esp-aes-256-cbc esp-sha-hmac mode tunnel
!
crypto map VPN 10 ipsec-ike
description VPN to Main Site
match address VPN-10-vpn-selectors
set peer 192.168.1.1
set transform-set esp-aes-256-cbc-esp-sha-hmac
set security-association lifetime seconds 3600
no commit-bit
ike-policy 100

ike-policy <number>
Use the ike-policy command to ensure that only a specified Internet key exchange (IKE) policy is used to
establish the IPSec tunnel. This prevents any mobile virtual private network (VPN) policies from using
IPSec policies that are configured for static VPN peer policies. Use the no form of this command to
remove a configured policy.
Syntax Description
<number> Specifies the policy number of the policy to assign to this crypto map.
Default Values
Command History
Usage Examples
The following example sets the IKE policy 100 for crypto map MyMap:

(config-crypto-map)#ike-policy 100

match address <name>

Use the match address command to assign an IP access control list (ACL) to a crypto map definition. The
ACL designates the IP packets to be encrypted by this crypto map. Use the no form of this command to
delete an IP ACL. Refer to ip access-list extended <name> on page 815 for more information on creating
ACLs.
Syntax Description
<name> Specifies the name of the ACL you wish to assign to this crypto map.
Default Values
By default, no IP ACLs are defined.
Command History
Functional Notes
the crypto map entry refers to an ACL. An ACL is assigned to the crypto map using the match address
command. If no ACL is configured for a crypto map, then the entry is incomplete and will have no effect on
the system.
The entries of the ACL used in a crypto map should be created with respect to traffic sent by the ADTRAN
product. The source information must be the local ADTRAN product and the destination must be the peer.
Only extended ACLs can be used in crypto maps.
Usage Examples
The following example shows setting up an ACL (called NewList) and then assigning the new list to a
crypto map (called NewMap):
(config)#ip access-list extended NewList
Configuring New Extended ACL “NewList”

(config-ext-nacl)#exit
(config)#crypto map NewMap 10 ipsec-ike
(config-crypto-map)#match address NewList

Technology Review
of crypto map entries: ipsec-manual and ipsec-ike. Each entry is given an index, which is used to sort the
ordered list.
When a nonsecured packet arrives on an interface, the crypto map set associated with that interface is
processed in order. If a crypto map entry matches the nonsecured traffic, the traffic is discarded.
a suitable security association (SA) exists, that is used for transmission. Otherwise, Internet key exchange
(IKE) is used to establish an SA with the peer. If no SA exists, and the crypto map entry is respond only, the
packet is discarded.

match track <name>

Use the match track command to assign a network monitoring track to enable or disable the indicated
crypto map policy. Use the no form of this command to remove this capability. Refer to track <name> on
page 1124 and Network Monitor Track Command Set on page 2356 for more information on creating and
using tracks.
Syntax Description
<name> Specifies the name of the network monitoring track to assign to this crypto
map.
Default Values
By default, there are no network monitoring tracks assigned.
Command History
Functional Notes
To increase availability of a network with two virtual private network (VPN) gateways, a track can be
assigned to a primary crypto map policy. This track will ensure connectivity to the primary VPN gateway. If
the track detects connectivity problems on this gateway, the primary crypto map policy is disabled. Network
traffic is then allowed to flow over the backup VPN gateway using the backup crypto map policy (which
would have a similar match address access control list (ACL) as the primary crypto map policy). Once the
track detects connectivity with the primary VPN gateway again, it will re-enable the primary crypto map
policy.
Network monitoring tracks must be created first with the track command executed from the Global
Configuration mode command prompt. Once created, further configuration is accomplished through the
commands available in the Network Monitor Track Command Set on page 2356.
Usage Examples
The following example shows the preliminary steps necessary before assigning a track to a crypto map
policy, as well as configuring the track to disable the primary VPN gateway if connectivity issues are
detected.
Define a probe named primaryping to ping the primary VPN gateway (10.22.156.251):
(config)#probe primaryping icmp-echo
(config-probe-primaryping)#destination 10.22.156.251
(config-probe-primaryping)#period 10
(config-probe-primaryping)#tolerance consecutive fail 3
(config-probe-primaryping)#no shutdown

Create a track named track1 to test the probe defined above:

(config-track-track1)#test probe primaryping
(config-track-track1)#no shutdown
(config-track-track1)#exit
Configure the crypto map (NewMap) to create a VPN tunnel to the primary VPN gateway (10.22.156.251):
(config-crypto-map)#description Primary VPN policy
(config-crypto-map)#match track track1
(config-crypto-map)#match address VPN-selectors
Configure the crypto map (NewMap) to create a VPN tunnel to the backup VPN gateway (10.22.156.240):
(config-crypto-map)#description Backup VPN policy
(config-crypto-map)#match address VPN-selectors

reverse-route
Use the reverse-route command to enable virtual private network (VPN) reverse route injection for a
particular crypto map. Use the no form of this command to disable reverse route injection. Variations of
reverse-route
reverse-route <number>
reverse-route <number> tag <value>
reverse-route tag <value>
Syntax Description
<number> Specifies the administrative distance for the static route. Range is 1 to 255.
tag <value> Optional. Specifies that a tag will be added to the static route in the route
table. Range from 1 to 65535.
Default Values
By default, reverse routing is disabled.
Command History
Functional Notes
Reverse route injection automatically inserts a static route to a peer’s remote network into the route table
of a VPN gateway.
The tags used in reverse route injection allow the routes to be individuated from other static routes.
Usage Examples
The following example enables reverse route injection for crypto map MyMap with an administrative
distance of 20 and a tag value of 10:
(config)#crypto map MyMap 100 ispec-ike

(config-crypto-map)#reverse-route 20 tag 10

Technology Review
The reverse route injection allows a crypto IPSec policy to inject static routes to a remote network into its
own route table, leaving it to the configuration of routing protocols to propagate the routes within the
network. Reverse route injection serves as a method of updating routing tables when using a backup VPN
server. In case one VPN is taken down or is unreachable, the VPN peer’s route is removed out of the VPN
gateway’s route table and other route tables within the network.

set peer
Use the set peer command to set the IP address or host name of the peer device. Use the no form of this
command to remove a peer device. Variations of this command include:
set peer hostname <hostname>

set peer <ip address>
Syntax Description
hostname <hostname> Specifies the host name of the peer device expressed in the format
<host.example.com> (for example, vpn.somecompany.com).
<ip address> Specifies the IP address of the peer device. If this is not configured, it
implies responder only to any peer. IP addresses should be expressed in
Default Values
Command History
Release 16.1 Command was expanded to include the host name parameters.
Functional Notes
If no peer IP address or host name is configured, the entry will only be used to respond to IPSec requests;
it cannot initiate the requests (since it doesn't know which IP address to which to send the packet). When a
peer IP address is configured, the crypto map entry can be used to both initiate and respond to security
associations (SAs). The peer address or host name is not checked when a tunnel is initiated from a remote
unit; this address only serves as the virtual private network (VPN) peer to which to initiate a tunnel.
The peer IP address is the public IP address of the device that will terminate the IPSec tunnel. If the peer
IP address is not static, or the peer’s address cannot be attained through the domain naming system
(DNS) host name, the ADTRAN product cannot initiate the VPN tunnel. There are many Dynamic DNS
services that can serve DNS for hosts that are dynamically addressed. By setting no peer IP address, the
ADTRAN product can respond to an IPSec tunnel request.
Only one peer IP address or host name can be set.
When using DNS host names for peer IP addresses, the crypto map is not able to initiate a tunnel until the
DNS host name resolves. This DNS host name is checked every 10 minutes.

Usage Examples
The following example sets the peer IP address of 10.100.23.64:

The following example sets the peer host name to vpn.examplehost.com:

(config-crypto-map)#set peer hostname vpn.examplehost.com

set pfs
Use the set pfs command to choose the type of perfect forward secrecy (PFS), if any, that will be required
during the IPsec negotiation of security associations (SAs) for this crypto map. Use the no form of this
set pfs group1

set pfs group2
set pfs group5
set pfs group1 legacy-peer
Syntax Description
group1 Requires IPSec to use Diffie-Hellman Group 1 (768-bit modulus) exchange
during IPSec security association (SA) key generation.
group2 Requires IPSec to use Diffie-Hellman Group 2 (1024-bit modulus)
exchange during IPSec SA key generation.
group5 Requires IPSec to use Diffie-Hellman Group 5 (1536-bit modulus)
legacy-peer Optional. Specifies using the Diffie-Hellman secret generation for legacy
peers (running AOS versions prior to A1.08 for voice products or 17.6.1 for
data products).
Default Values
By default, no PFS will be used during IPsec SA key generation.
Command History
Release 15.1 Command was expanded to include the group5 parameter.
Release 17.6.1/A2.04 Command was expanded to include legacy-peer option.
Functional Notes
If left at the default setting, no PFS will be used during IPSec SA key generation. If PFS is specified, then
the specified Diffie-Hellman Group exchange will be used for the initial and all subsequent key generation,
thus providing no data linkage between prior keys and future keys.
Usage Examples
The following example specifies use of the Diffie-Hellman Group 1 exchange during IPSec SA key
generation:

(config-crypto-map)#set pfs group1

set security-association idle-time <value>

Use the set security-association idle-time command to set the receive idle timeout in seconds. This is the
maximum amount of time for which the current virtual private network (VPN) peer can be idle. Once the
timeout has occurred, the VPN tunnel will be brought down. Use the no form of this command to disable
the timeout feature.
Syntax Description
<value> Specifies the idle timeout in seconds. Valid range is 1 to 4294967294.
Default Values
By default, the idle timeout is not defined.
Command History
Usage Examples
The following example sets the receive idle timeout to 60 seconds:

(config-crypto-map)#set security-association idle-time 60

set security-association lifetime

Use the set security-association lifetime command to define the lifetime (in kilobytes and/or seconds) of
the IPSec security associations (SAs) created by this crypto map. Use the no form of this command to
set security-association lifetime kilobytes <value>

set security-association lifetime seconds <value>
Syntax Description
kilobytes <value> Specifies the SA lifetime limit in kilobytes.
seconds <value> Specifies the SA lifetime limit in seconds.
Default Values
By default, the security-association lifetime is set to 28800 seconds, and there is no default for the
kilobytes’ lifetime.
Command History
Functional Notes
Values can be entered for this command in both kilobytes and seconds. Whichever limit is reached first will
end the SA.
Usage Examples
The following example sets the SA lifetime to 300 kilobytes and 2 hours (7200 seconds):

(config-crypto-map)#set security-association lifetime kilobytes 300
(config-crypto-map)#set security-association lifetime seconds 7200

set transform-set
Use the set transform-set command to assign up to six transform sets to a crypto map. Use the no form of
this command to return to the default setting. Refer to crypto ipsec transform-set <name> <parameters>
on page 787 for information on defining transform sets. Variations of this command include:
set transform-set <name>

set transform-set <name> <name>
set transform-set <name> <name> <name>
set transform-set <name> <name> <name> <name>
set transform-set <name> <name> <name> <name> <name>
set transform-set <name> <name> <name> <name> <name> <name>
Syntax Description
<name> Assigns up to six transform sets to this crypto map by listing the set names,
separated by a space.
Default Values
By default, there is no transform set assigned to the crypto map.
Command History
Functional Notes
If no transform set is configured for a crypto map, then the entry is incomplete and will have no effect on
the system.
Usage Examples
may be defined), and then assigns the transform set to a crypto map (MyMap):


Command Reference Guide Crypto Map Manual Command Set
CRYPTO MAP MANUAL COMMAND SET
To activate the Crypto Map Manual mode, enter a valid version of the crypto map ipsec-manual
>enable
#configure terminal
(config)#crypto map Map-Name 10 ipsec-manual

do on page 51
end on page 52
exit on page 53
antireplay on page 3043

ike-policy <number> on page 3044
match address <name> on page 3045
set peer <ip address> on page 3047
set session-key on page 3048
set transform-set <name> on page 3052

antireplay
Use the antireplay command to enable anti-replay sequence number checking for all security associations
(SAs) created on this crypto map. Use the no form of this command to disable this feature. Variations of
antireplay
antireplay <value>
Syntax Description
<value> Optional. Specifies the anti-replay window size in bytes. Select from 64,
128, 256, 512, or 1024 bytes.
Default Values
By default, the window size is set to 64 bytes.
Command History
Usage Examples
The following example enables anti-replay sequence checking on crypto map VPN 100:
(config)#crypto map VPN 100 ipsec-manual

(config-crypto-map)#antireplay

ike-policy <number>
Use the ike-policy command to ensure that only a specified Internet key exchange (IKE) policy is used to
establish the IPSec tunnel. This prevents any mobile virtual private network (VPN) policies from using
IPSec policies that are configured for static VPN peer policies. Use the no form of this command to
remove a configured IKE policy.
Syntax Description
<number> Specifies the policy number of the policy to assign to this crypto map.
Default Values
Command History
Usage Examples
The following example shows a typical crypto map configuration:

(config)#crypto map VPN 10 ipsec-manual
(config-crypto-map)#description “Remote Office”
(config-crypto-map)#match address VPN-10-vpn-selectors
(config-crypto-map)#set transform-set esp-3des-esp-md5-hmac
(config-crypto-map)#ike-policy 100

match address <name>

Use the match address command to assign an IP access control list (ACL) to a crypto map definition. The
ACL designates the IP packets to be encrypted by this crypto map. Use the no form of this command to
remove a defined IP ACL. Refer to ip access-list extended <name> on page 815 for more information on
creating ACLs.
Syntax Description
<name> Specifies the name of the ACL you wish to assign to this crypto map.
Default Values
By default, no IP ACLs are defined.
Command History
Functional Notes
the crypto map entry refers to an ACL. An ACL is assigned to the crypto map using the match address
command. If no ACL is configured for a crypto map, then the entry is incomplete and will have no effect on
the system.
The entries of the ACL used in a crypto map should be created with respect to traffic sent by the ADTRAN
product. The source information must be the local ADTRAN product, and the destination must be the peer.
Only extended ACLs can be used in crypto maps.
Usage Examples
The following example shows setting up an ACL (called NewList) and then assigning the new list to a
crypto map (called NewMap):
(config)#ip access-list extended NewList
Configuring New Extended ACL "NewList"
(config-ext-nacl)#exit
(config)#crypto map NewMap 10 ipsec-manual
(config-crypto-map)#match address NewList

Technology Review
of crypto map entries: ipsec-manual and ipsec-ike. Each entry is given an index, which is used to sort the
ordered list.
When a nonsecured packet arrives on an interface, the crypto map set associated with that interface is
processed in order. If a crypto map entry matches the nonsecured traffic, the traffic is discarded.
a suitable security association (SA) exists, that is used for transmission. Otherwise, Internet key exchange
(IKE) is used to establish an SA with the peer. If no SA exists, and the crypto map entry is respond only, the
packet is discarded.

set peer <ip address>

Use the set peer command to set the IP address of the peer device. Use the no form of this command to
remove a peer device.
Syntax Description
<ip address> Specifies the IP address of the peer device. IP addresses should be
Default Values
Command History
Functional Notes
If no peer IP address is configured, the manual crypto map is not valid and not complete. A peer IP
address is required for manual crypto maps. To change the peer IP address, the no set peer command
must be issued first; then the new peer IP address can be configured.
Usage Examples
The following example sets the peer IP address of 10.100.23.64:

set session-key
Use the set session-key command to define the encryption and authentication keys for this crypto map.
Use the no form of this command to remove defined encryption and authentication keys. Variations of this
set session-key inbound ah <SPI> <key>

set session-key inbound esp <SPI> authenticator <key>
set session-key inbound esp <SPI> cipher <key>
set session-key inbound esp <SPI> cipher <key> authenticator <key>
set session-key outbound ah <SPI> <key>
set session-key outbound esp <SPI> authenticator <key>
set session-key outbound esp <SPI> cipher <key>
set session-key outbound esp <SPI> cipher <key> authenticator <key>
Syntax Description
inbound Defines encryption keys for inbound traffic.
outbound Defines encryption keys for outbound traffic.
ah <SPI> Specifies Authentication Header (AH) Protocol and security parameter
index (SPI).
esp <SPI> Specifies Encapsulating Security Payload (ESP) Protocol and SPI.
cipher <key> Specifies encryption/decryption key.
authenticator <key> Specifies authentication key.
Default Values
Command History
Functional Notes
The inbound local SPI must equal the outbound remote SPI. The outbound local SPI must equal the
inbound remote SPI. The key values are the hexadecimal representations of the keys. They are not true
ASCII strings. Therefore, a key of 3031323334353637 represents 01234567.

Refer to the following list for key length requirements.
Algorithm: Minimum key length required:

DES 64 bits in length; 8 hexadecimal bytes
3DES 192 bits in length; 24 hexadecimal bytes
AES-128-CBC 128 bits in length; 16 hexadecimal bytes
MD5 128 bits in length; 16 hexadecimal bytes
SHA1 160 bits in length; 20 hexadecimal bytes
Usage Examples
The following example configures an AOS product for virtual private network (VPN) using IPSec manual
keys. This example assumes that the AOS product has been configured with a wide area network (WAN)
IP address of 63.97.45.57 on interface ppp 1 and a local area network (LAN) IP address of 10.10.10.254
on interface ethernet 0/1. The peer private IP subnet is 10.10.20.0.
For more detailed information on VPN configuration, refer to the VPN configuration guide located on the
AOS Documentation CD provided with your unit.
Step 1:
Enter the Global Configuration mode (i.e., config terminal mode).
>enable
#configure terminal
Step 2:
Enable VPN support using the ip crypto command. This command allows crypto maps to be applied to
interfaces, and enables the Internet key exchange (IKE) server to listen for IKE negotiation sessions on
User Datagram Protocol (UDP) port 500.
(config)#ip crypto
Step 3:
Define the transform set. A transform set defines the encryption and/or authentication algorithms to be
used to secure the data transmitted over the VPN tunnel. Multiple transform sets may be defined in a
system. Once a transform set is defined, many different crypto maps within the system can reference it. In
this example, a transform set named highly_secure has been created. This transform set defines ESP
with authentication implemented using 3DES encryption and SHA1 authentication.
(config)#crypto ipsec transform-set highly_secure esp-3des esp-sha-hmac

(cfg-crypto-trans)#mode tunnel

Step 4:
Define an IP access control list (ACL). An extended ACL is used to specify which traffic needs to be sent
securely over the VPN tunnel. The entries in the list are defined with respect to the local system. The
source IP address will be the source of the traffic to be encrypted. The destination IP address will be the
receiver of the data on the other side of the VPN tunnel.
(config)#ip access-list extended corporate_traffic

(config-ext-nacl)#permit ip 10.10.10.0 0.0.0.255 10.10.20.0 0.0.0.255 log
deny ip any any
Step 5:
Create crypto map and define manual keys. A crypto map is used to define a set of encryption schemes to
be used for a given interface. A crypto map entry has a unique index within the crypto map set. The crypto
map entry will specify whether IKE is used to generate encryption keys, or if manually specified keys will
be used. The crypto map entry will also specify who will be terminating the VPN tunnel, as well as which
transform set or sets will be used to encrypt and/or authenticate the traffic on that VPN tunnel. It also
specifies the lifetime of all created IPSec security associations (SAs).
The keys for the algorithms defined in the transform set associated with the crypto map will be defined by
using the set session-key command. A separate key is needed for both inbound and outbound traffic. The
key format consists of a string of hexadecimal values without the leading 0x for each character. For
example, a cipher key of this is my cipher key would be entered as:
74686973206973206D7920636970686572206B6579.
A unique SPI is needed for both inbound and outbound traffic. The local system's inbound SPI and keys
will be the peer's outbound SPI and keys. The local system's outbound SPI and keys will be the peer's
inbound SPI and keys. In this example, the following keys and SPIs are used:
Inbound cipher SPI: 300 Inbound cipher key: "2te$#g89jnr(j!@4rvnfhg5e"
Outbound cipher SPI: 400 Outbound cipher key: "8564hgjelrign*&(gnb#1$d3"
Inbound authenticator key:"r5%ûghembkdhj34$x.<"
Outbound authenticator key:"io78*7gner#4(mgnsd!3"
(config)#crypto map corporate_vpn 1 ipsec-ike

(config-crypto-map)#match address corporate_traffic
(config-crypto-map)#set transform-set highly_secure
(config-crypto-map)#set session-key inbound esp 300 cipher
32746524236738396A6E72286A21403472766E6668673565 authenticator
7235255E756768656D626B64686A333424782E3C
(config-crypto-map)#set session-key outbound esp 400 cipher
3835363468676A656C7269676E2A2628676E622331246433 authenticator
696F37382A37676E65722334286D676E73642133

Step 6:
Configure public interface. This process includes configuring the IP address for the interface and applying
the appropriate crypto map to the interface. Crypto maps are applied to the interface on which encrypted
traffic will be transmitted.
(config-ppp 1)#crypto map corporate_vpn
Step 7:
Configure private interface to allow all traffic destined for the VPN tunnel to be routed to the appropriate
gateway.

(config-eth 0/1)#ip address 10.10.10.254 255.255.255.0
(config-eth 0/1)#no shutdown

set transform-set <name>

Use the set transform-set command to assign a transform set to a crypto map. Use the no form of this
command to remove assigned transform sets. Refer to crypto ipsec transform-set <name> <parameters>
on page 787 for information on defining transform sets.
Syntax Description
<name> Assigns a transform set to this crypto map by entering the set name.
Default Values
By default, no transform set is assigned to the crypto map.
Command History
Functional Notes
If no transform set is configured for a crypto map, then the entry is incomplete and will have no effect on
the system. For manual key crypto maps, only one transform set can be specified.
Usage Examples
may be defined), and then assigns the transform set to a crypto map (Map1):

(config)#crypto map Map1 1 ipsec-manual


Command Reference Guide IKE Client Command Set
IKE CLIENT COMMAND SET
To activate the Internet Key Exchange (IKE) Client mode, enter the crypto ike client command at the
>enable
#configure terminal
(config)#crypto ike client configuration pool ConfigPool1
(config-ike-client-pool)#
do on page 51
end on page 52
exit on page 53
dns-server on page 3054

ip-range <start ip address> <end ip address> on page 3055
netbios-name-server <ip address> <secondary> on page 3056

dns-server
Use the dns-server command to specify the default primary and secondary domain naming system (DNS)
servers to use for the Dynamic Host Configuration Protocol (DHCP) client. Use the no form of this
command to remove the configured DNS server. Variations of this command include:
dns-server <ip address>

dns-server <ip address> <secondary>
Syntax Description
<ip address> Specifies the IP address of the preferred DNS server on the network.
<secondary> Optional. Specifies the IP address of the second preferred DNS server on
the network.
10.10.10.1).
Default Values
By default, there are no specified default DNS servers.
Command History
Release 4.1 Command was expanded to include the Internet key exchange (IKE) client
configuration pool.
Usage Examples
The following example specifies a default DNS server with address 192.72.3.254 and a secondary DNS
server with address 192.100.4.253:

(config-ike-client-pool)#dns-server 192.72.3.254 192.100.4.253

ip-range <start ip address> <end ip address>

Use the ip-range command to specify the range of addresses from which the router draws when assigning
an IP address to a client. Use the no form of this command to remove defined IP ranges.
Syntax Description
<start ip address> Specifies the first IP address in the range for this pool.
<end ip address> Specifies the last IP address in the range for this pool.
10.10.10.1).
Default Values
Command History
Usage Examples
The following example defines an IP address range for this configuration pool:

(config-ike-client-pool)#ip-range 172.1.1.1 172.1.1.25


Use the netbios-name-server command to specify the network basic input/output system (NetBIOS)
Windows Internet Naming Service (WINS) name servers to assign to a client. Use the no form of this
command to remove assigned name servers. Variations of this command include:
netbios-name-server <ip address>

Syntax Description
<ip address> Specifies the primary WINS server IP address to assign.
<secondary> Optional. Specifies the secondary WINS server IP address to assign.
Default Values
By default, no WINS server address is defined.
Command History
Usage Examples
The following example defines two WINS server addresses for this configuration pool:

(config-ike-client-pool)#netbios-name-server 172.1.17.1 172.1.17.25

Command Reference Guide IKE Policy Attributes Command Set
IKE POLICY ATTRIBUTES COMMAND SET
To activate the Internet Key Exchange (IKE) Policy Attributes mode, enter the attribute command at the
IKE Policy prompt. For example:
>enable
#configure terminal
do on page 51
end on page 52
exit on page 53
authentication on page 3058

encryption on page 3059
group on page 3060
hash on page 3061
lifetime <value> on page 3062

authentication
Use the authentication command to configure this Internet key exchange (IKE) policy’s use of preshared
secrets and signed certificates during IKE negotiation. Use the no form of this command to disable this
authentication dss-sig
authentication pre-share
authentication rsa-sig
Syntax Description
dss-sig Specifies to use DSS-signed certificates during IKE negotiation to validate
the peer.
pre-share Specifies the use of preshared secrets during IKE negotiation to validate the
peer.
rsa-sig Specifies to use RSA-signed certificates during IKE negotiation to validate
the peer.
Default Values
By default, authentication is set to pre-share.
Command History
Release 5.1 Command was expanded to include the signed certificates.
Functional Notes
Both sides must share the same preshared secret in order for the negotiation to be successful.
Usage Examples
The following example enables preshared secrets for this IKE policy:
(config-ike-attribute)#authentication pre-share

encryption
Use the encryption command to specify which encryption algorithm this Internet key exchange (IKE)
policy will use to transmit data over the IKE-generated security association (SA). Use the no form of this
encryption des
encryption 3des
Syntax Description
aes-128-cbc Specifies the AES-128-CBC encryption algorithm.
des Specifies the DES encryption algorithm.
3des Specifies the 3DES encryption algorithm.
Default Values
By default, encryption is set to DES.
Command History
Usage Examples
The following example selects 3DES as the encryption algorithm for this IKE policy:
(config-ike-attribute)#encryption 3des

group
Use the group command to specify the Diffie-Hellman Group (1, 2, or 5) to be used by this Internet key
exchange (IKE) policy to generate the keys (which are then used to create the IPSec security association
(SA)). Use the no form of this command to return to the default setting. Variations of this command
include:
group 1
group 2
group 5
Syntax Description
1 Requires the IKE policy to use Diffie-Hellman Group 1 (768-bit modulus)
Default Values
By default, group is set to 1.
Command History
Release 15.1 Command was expanded to include the group 5 parameter.
Functional Notes
The local IKE policy and the peer IKE policy must have matching group settings in order for negotiation to
be successful.
Usage Examples
The following example sets this IKE policy to use Diffie-Hellman Group 2:
(config-ike-attribute)#group 2

hash
Use the hash command to specify the hash algorithm to be used to authenticate the data transmitted over
the Internet key exchange (IKE) security association (SA). Use the no form of this command to return to
the default setting. Variations of this command include:
hash md5
hash sha
Syntax Description
md5 Choose the message digest 5 (MD5) hash algorithm.
sha Choose the SHA hash algorithm.
Default Values
By default, hash is set to sha.
Command History
Usage Examples
The following example specifies md5 as the hash algorithm:
(config-ike-attribute)#hash md5

lifetime <value>
Use the lifetime command to specify how long an Internet key exchange (IKE) security association (SA) is
valid before expiring. Use the no form of this command to return to the default setting.
Syntax Description
<value> Specify how many seconds an IKE SA will last before expiring. The valid
range is 60 to 1209600.
Default Values
By default, lifetime is set to 28800 seconds.
Command History
Usage Examples
The following example sets a lifetime of two hours:
(config-ike-attribute)#lifetime 7200

Command Reference Guide IKE Policy Command Set
IKE POLICY COMMAND SET
To activate the Internet Key Exchange (IKE) Policy mode, enter the crypto ike policy command at the
>enable
#configure terminal
(config-ike)#
do on page 51
end on page 52
exit on page 53
attribute <number> on page 3064

client authentication host on page 3065
client authentication host xauth-type on page 3066
client authentication server list <listname> on page 3067
client configuration pool <name> on page 3068
initiate on page 3069
local-id on page 3070
nat-traversal on page 3072
peer on page 3073
respond on page 3075

attribute <number>
Use the attribute command to define attributes for the associated Internet key exchange (IKE) policy.
Multiple attributes can be created for a single IKE policy. Once you enter this command, you are in the
IKE Policy Attribute mode. Refer to IKE Policy Attributes Command Set on page 3057 for more
information. Use the no form of this command to remove a defined attribute.
Syntax Description
<number> Assigns a number (range: 1 to 65535) to the attribute policy. The number is
the attribute's priority number and specifies the order in which the resulting
virtual private network (VPN) proposals get sent to the far end.
This command takes you to the (config-ike-attribute)# prompt. From here,
you can configure the settings for the attribute as outlined in the section IKE
Policy Attributes Command Set on page 3057.
Default Values
By default, no attribute is defined.
Command History
Functional Notes
Multiple attributes on an IKE policy are ordered by number (with the lowest number representing the
highest priority).
Usage Examples
The following example defines a policy attribute (10) and takes you into the IKE policy attributes:


client authentication host

Use the client authentication host command to enable the unit to act as an Xauth host when this Internet
key exchange (IKE) policy is negotiated with a peer. Use the no form of this command to disable this
feature. Variations of this command include the following:
client authentication host username <username>

client authentication host username <username> password <password>
client authentication host username <username> password <password> passphrase <phrase>
Syntax Description
password <password> Specifies the value sent via Xauth as the password.
username <username> Specifies the value sent via Xauth as the user name.
passphrase <phrase> Optional. Specifies the value sent via Xauth as the passphrase. This is only
used with authentication type one time password (OTP).
Default Values
By default, if this command is not present in the IKE policy, the unit does not act as an Xauth host.
Command History
Functional Notes
The specified credentials are programmed into the unit, and there is no prompt for entering values real
time. Therefore, schemes requiring real-time input or additional responses (e.g., SecureID) are not
supported. The client authentication host and the client authentication server commands are mutually
exclusive. Refer to client authentication server list <listname> on page 3067 for more information.
Usage Examples
The following example specifies the login credentials to be sent:

(config-ike)#client authentication host username jsmith password password1 passphrase phrase

client authentication host xauth-type

Use the client authentication host xauth-type command to allow the user to specify the Xauth
authentication type if a type other than generic is desired. Use the no form of this command to return to the
client authentication host xauth-type generic

client authentication host xauth-type otp
client authentication host xauth-type radius
Syntax Description
generic Specifies generic authentication type.
otp Specifies one time password (OTP) authentication type.
radius Specifies remote authentication dial-in user service (RADIUS)
authentication type.
Default Values
By default, authentication is set to generic.
Command History
Functional Notes
This command is used along with the client authentication host username. Refer to client configuration
pool <name> on page 3068 for more information. When acting as an Xauth host, this command allows the
user to specify the Xauth authentication type if a type other than generic is desired.
Usage Examples
The following example sets the Xauth type to radius:

(config-ike)#client authentication host xauth-type radius

client authentication server list <listname>

Use the client authentication server list command to specify an authentication, authorization, and
accounting (AAA) authentication method list to be used in the Internet key exchange (IKE) policy. AAA
must be enabled to use this command (refer to the command aaa on on page 751). Use the no form of this
command to remove the authentication list from the policy. Variations of this command include:
client authentication server list default

client authentication server list <listname>
Syntax Description
default Specifies the default AAA authentication method list is applied in the IKE
policy.
<listname> Specifies the named AAA authentication method list is applied in the IKE
policy.
Default Values
By default, no AAA authentication method list is applied to the IKE policy and extended authentication is
not performed.
Command History
Functional Notes
When this IKE policy is negotiated and the peer has indicated Xauth via the IKE authentication method
and/or the Xauth vendor ID, this command allows the unit to perform as an Xauth server (edge device).
The specified AAA authentication method list is used to identify the location of the user authentication
database.
The AAA authentication method list used by the IKE policy is most often the AAA login authentication
method list. For more information about configuring these lists, refer to the command aaa authentication
login on page 733.
For more information about configuring AAA in your network, refer to the configuration guide Configuring
Usage Examples
The following example specifies that the AAA authentication method list AuthList1 is used in the IKE
policy for extended authentication:

(config-ike)#client authentication server list AuthList1

client configuration pool <name>

Use the client configuration pool command to configure AOS to perform as mode-config server (edge
device) when an Internet key exchange (IKE) policy is negotiated. Use the no form of this command to
client configuration pool <name>

client configuration pool <name> initiate
client configuration pool <name> initiate respond
client configuration pool <name> respond
client configuration pool <name> respond initiate
Syntax Description
<name> Specifies the pool from which to obtain parameters to assign to the client.
initiate Enables set/ack (push) mode.
respond Enables request/response mode.
Default Values
By default, if this command is not present in the IKE policy, the ADTRAN device allocates mode-config IP
addresses, domain naming system (DNS) server addresses, and network basic input/output system
(NetBIOS) name server addresses, and mode-config is not performed.
Command History
Functional Notes
This command ties an existing client configuration pool to an IKE policy.
By using the initiate and respond commands, you can configure the IKE policy to initiate and respond,
initiate only, or respond only. It is an error if you have both initiate and respond disabled.
Usage Examples
The following example ties the ConfigPool1 configuration pool to this IKE policy:

(config-ike)#client configuration pool ConfigPool1

initiate
Use the initiate command to allow the Internet key exchange (IKE) policy to initiate negotiation (in main
mode or aggressive mode) with peers. Use the no form of this command to allow the policy to respond
only. Variations of this command include:
initiate aggressive
initiate main
Syntax Description
aggressive Specifies to initiate using aggressive mode. Aggressive mode can be used
when one end of the virtual private network (VPN) tunnel has a dynamically
assigned address. The side with the dynamic address must be the initiator
of the traffic and tunnel. The side with the static address must be the
responder.
main Specifies to initiate using main mode. Main mode requires that each end of
the VPN tunnel has a static wide area network (WAN) IP address. Main
mode is more secure than aggressive mode because more of the main
mode negotiations are encrypted.
Default Values
By default, the main initiation mode is enabled.
Command History
Functional Notes
Usage Examples
The following example enables the AOS device to initiate IKE negotiation in main mode:

(config-ike)#initiate main

local-id
Use the local-id command to set the local ID for the Internet key exchange (IKE) policy. This setting
overrides the system local ID setting (set in the Global Configuration mode using the crypto ike local-id
address command). Use the no form of this command to remove a local ID. Variations of this command
include:
local-id address <ip address>

local-id asn1-dn <name>
local-id fqdn <name>
local-id user-fqdn <name>
Syntax Description
address <ip address> Specifies a remote IP address. IP addresses should be expressed in dotted
asn1-dn <name> Specifies an abstract syntax notation distinguished name as the remote ID
(enter this value in Lightweight Directory Access Protocol (LDAP) format).
fqdn <name> Specifies a fully qualified domain name (FQDN) (e.g., adtran.com) as the
remote ID.
user-fqdn <name> Specifies a user FQDN or email address (e.g., user1@adtran.com) as the
remote ID.
Default Values
By default, the local ID is not defined.
Command History
Functional Notes
The local ID for a particular IKE policy can be set in two ways. The first (default) method is done in the
Global Configuration mode:
(config)#crypto ike local-id address
This command, which by default is executed on startup, makes the local ID of an IKE policy equal to the
IPv4 address of the interface on which an IKE negotiation is occurring. This is particularly useful for
products that could have multiple public interfaces.
The second method is to use the IKE policy command:

(config-ike)#local-id [address | asn1-dn | fqdn | user-fqdn] <ip address or name>

This policy-specific command allows you to manually set the local ID for an IKE policy on a per-policy
basis. You can use both methods simultaneously in the product. Several IKE policies can be created, some
of which use the default system setting of the IPv4 address of the public interface. Others can be set to
override this system setting and manually configure a local ID specific to those policies. When a new IKE
policy is created, they default to no local-id. This allows the system local ID setting to be applied to the
policy.
Usage Examples
The following example sets the local ID of this IKE policy to the IPv4 address 63.97.45.57:

(config-ike)#local-id address 63.97.45.57

nat-traversal
Use the nat-traversal command to allow, force, or disable network address translation (NAT) traversal
versions 1 and 2 on a specific Internet key exchange (IKE) policy. Use the no form of this command to
disable this feature. Variations of this command include:
nat-traversal v1 allow
nat-traversal v1 disable
nat-traversal v1 force
nat-traversal v2 allow
nat-traversal v2 disable
nat-traversal v2 force
Syntax Description
v1 Specifies NAT traversal version 1.
v2 Specifies NAT traversal version 2.
allow Sets the IKE policy to allow the specified NAT traversal version.
disable Sets the IKE policy to disable the specified NAT traversal version.
force Sets the IKE policy to force the specified NAT traversal version.
Default Values
The default values for this command are nat-traversal v1 allow and nat-traversal v2 allow.
Command History
Usage Examples
The following example disables version 2 on IKE policy 1:

(config-ike)#nat-traversal v2 disable

peer
Use the peer command to enter the IP address of the peer device. Repeat this command for multiple peers.
Use the any keyword if you want to set up a policy that will initiate or respond to any peer. Use the no
form of this command to remove a peer device. Variations of this command include:
peer <ip address>

peer any
Syntax Description
<ip address> Specifies a peer IP address. IP addresses should be expressed in dotted
any Allows any peer to connect to this Internet key exchange (IKE) policy.
Default Values
Command History
Functional Notes
An IKE policy is incomplete unless one of the peer commands is specified. Only one IKE policy can be
configured with peer any.
Usage Examples
The following example sets multiple peers on an IKE policy for an initiate-and-respond policy using
preshared secret, DES, message digest 5(MD5), and Diffie-Hellman Group 1:

The following example sets up a policy allowing any peer to initiate using preshared secret, DES, MD5,
and Diffie-Hellman Group 1.

(config-ike)#peer any

Technology Review
IKE policies must have a peer address associated with them to allow certain peers to negotiate with the
ADTRAN product. This is a problem when you have roaming users (those who obtain their IP address
using Dynamic Host Configuration Protocol (DHCP) or some other dynamic means). To allow for roaming
users, the IKE policy can be set up with peer any to allow any peer to negotiate with the ADTRAN product.
There can only be one peer any policy in the running configuration.

respond
Use the respond command to allow the Internet key exchange (IKE) policy to respond to negotiations by a
peer. Use the no form of this command to allow the policy to only initiate negotiations. Variations of this
command include:
respond aggressive
respond anymode
respond main
Syntax Description
aggressive Specifies to respond only to aggressive mode.
anymode Specifies to respond to any mode.
main Specifies to respond only to main mode.
Default Values
By default, respond to any mode is enabled.
Command History
Functional Notes
Usage Examples
The following example configures the router to initiate and respond to IKE negotiations:


Command Reference GuideIndex
INDEX alias 46
alias link 1837, 1983
A annex 1488
aaa accounting 720, 723, 726, 727
antenna 2241
aaa accounting commands 718 antireplay 3026, 3043
aaa accounting connection 720
anti-spyware current 2448
aaa accounting exec 723 anti-virus current 2449
aaa accounting suppress null-username 726 AP Interface command set 2223
aaa accounting update 727 apply 2155
aaa authentication 729 area default-cost 2372
aaa authentication banner 728 area range 2373
aaa authentication enable default 729 area stub 2374
aaa authentication fail-message 732 arp 753
aaa authentication login 733 arp arpa 1314, 1956, 2164
aaa authentication password-prompt 736 AS Path List command set 2281
aaa authentication port-auth default 737
as-path-list 2301
aaa authentication username-prompt 739
assistant-extension 2645
aaa authorization 740
association access-list 2226
aaa authorization commands 740
ATM Interface command set 1528
aaa authorization config-command 743
atm routed-bridged ip 1535
aaa authorization console 744
ATM Subinterface command set 1532
aaa authorization exec 745
attribute 3057, 3064
aaa group server 748, 2570
authentication 3058
aaa local authentication attempts max-fail 750
authentication username 2756
aaa on 751
authentication username password 2756
aaa processes 752
auth-mode open 2323
aa-initiate-permit 2961
authorization commands 1211, 1229, 1241
abort 2154
authorization exec 1212, 1230, 1242
absolute-path 2322 auto-config 754
accept 2668, 2849
auto-cost reference-bandwidth 2375
accept-number 2612
auto-link 753, 756
Access Control List command set 2411
auto-link http 757
Access Control Policy command set 2428
auto-link recontact-interval 758
access-class in 1224, 1236, 2348
auto-link server 759
access-point controller-standby 2224
auto-summary 2396
access-point mac-address 2225
auto-update current 2450
access-policy 1313, 1534, 1619, 1658, 1753, 1836, 1911,
awcp 1315, 2165
1981, 2074, 2163
accounting commands 1208, 1226, 1238
B
accounting connection 1209, 1209, 1227, 1227, 1239, bandwidth 1316, 1536, 1620, 1659, 1731, 1754, 1838,
1912, 1984, 2075, 2166, 2546
1239
accounting exec 1210, 1228, 1240 banner 760
acfc accept-compressed 1982 Basic Mode command set 34
ACLs 2412 beacon period 2242
ACPs 2412 bgp always-compare-med 2285
address 2509 BGP command set 2284
administrative distance 1565 bgp compare-med 2285
ADSL Interface command set 1249 bgp default local-preference 2286
advertisement-interval 2300 bgp deterministic-med 2285
alarm-threshold 1487 bgp fast-external-failover 2287
alc 2521, 2682, 2720, 2754, 2802, 2850, 2872, 2890 bgp ignore-med 2285
alert-info 2754, 2755 bgp log-neighbor-changes 2288

BGP Neighbor command set 2299 clear counters ethernet cfm 71

bgp router-id 2289 clear counters media-gateway 73
billing-codes 2962 clear counters probe 74
blind-dial 2683, 2803 clear counters track 75
block-caller-id 2522, 2891, 2963 clear counters vlan 76
body size 2510 clear counters voice-trunk 77
boot alternate-image 1489 clear crypto ike sa 78
boot config 761 clear crypto ipsec sa 79
boot system 762 clear desktop-auditing 81
boot voip 764 clear dot11 client 83
bootfile 2454 clear dump-core 84
BRI Interface command set 1253 clear ethernet cfm mep remote 85
bridge irb 765 clear event-history 86
bridge protocol ieee 767 clear gvrp statistics 87
bridge-group 1317, 1537, 1755, 1839, 1985, 2167 clear host 88
bridge-group vlan-transparent 1318, 1756, 1840, 1986 clear ip bgp 89
busy all 2684, 2757, 2804 clear ip cache 91
busy fxo 2685 clear ip cache counters 91
busy range fxo 2686 clear ip dhcp-server binding 92
busy t1 tdm-group 2805 clear ip ffe 93, 2404
BVI Interface command set 1618 clear ip flow stats 94
C clear ip flow top-talkers 95
CA Profile command set 3010 clear ip igmp group 96
called-number 1660 clear ip ospf 97
caller-id 1440, 2687, 2806 clear ip policy-sessions 98
caller-id override 1254 clear ip policy-stats 100
caller-id-override 1464, 2688, 2721, 2758, 2807, 2892 clear ip prefix-list 101
caller-number 1661 clear ip route 102
calling-party 1469 clear ip route-cache express 104
calling-party name-facility-timeout 1470 clear ip rtp quality-monitoring 105
call-privilege 2964 clear ip rtp quality-monitoring reporter 106
call-type voice 2613 clear ip security 107
call-waiting 2893 clear ip urlfilter statistics 108
camp-on 2966 clear ip urlfilter top-websites 109
capture commands 2511 clear lldp counters interface 110
capture header 2512 clear lldp neighbors 111
capture trigger 2513 clear mac address-table dynamic 112
cdma activate oma-dm 1264 clear mac address-table multicast 113
cdma activate otasp 1265 clear mail-client body 114
Cellular Interface command set 1263 clear mail-client counters 115
certificate 3022 clear network-forensics ip dhcp 116
certificate ca 3023 clear ntp 118
Certificate command set 3021 clear port-security 119
channel-group mode on 1319 violation-count 120
check-supported replaces 2759 clear pppoe 121
clear access-list 65 clear probe responder 122
clear arp-cache 66 clear processes cpu max 123
clear arp-entry 67 clear processes queue 124
clear bridge 68 clear qos map 125
clear buffers max-used 69 clear relay 127
clear counters 70 clear route-map counters 128

clear sip location 129 connect range fxo 2691

clear sip trunk-registration 130 connect sip 2895
clear sip user-registration 131 connect t1 1472
clear spanning-tree counters 132 connect t1 tdm-group 2809
clear spanning-tree detected-protocols 133 connected 2383
clear tacacs+ statistics 134 connection 720
clear user 135 connect-mode 1662
clear vrrp counters 136 connect-order 1663
CLI connect-sequence 1664
accessing with PC 11 attempts 1666
error messages 22 interface-recovery 1667
introduction 7 console port
shortcuts 20 configuring 11
client authentication host 3065 control 2324, 2420
xauth-type 3066 control souce-port 2349
client authentication server list 3067 control timeout 2350
client configuration pool 3068 copy 144
client-identifier 2455 copy cflash 146
client-name 2456 copy console 149
clock auto-correct-dst 137, 768 copy dynvoice-config 150
clock no-auto-correct-dst 138, 768 copy flash 153
clock rate 1276 copy http 156
clock set 139, 769 copy https 158
clock source 1277, 1294, 1501, 1518 copy ramdisk 160
clock timezone 140, 770 copy running-config 163
codec 2639, 2956 copy startup-config 166
codec-group 2523, 2689, 2722, 2808, 2851, 2875, 2894 copy tftp 169
coding 1284, 1295, 1453, 1502 copy xmodem 171
coding b3zs 1519 cos 1538, 2896
command descriptions 23 count-eth-overhead 2568
command level path 20 country-region 2227
Command Line Interface coverage 2622, 2647, 2852, 2898
accessing with PC 11 crl 3024
error messages 22 crl optional 3011
introduction 7 cross-connect 47
shortcuts 20 crypto ca authenticate 773
Command Set Access Path Quick Reference Guide 26 crypto ca certificate chain 775, 3021
commit-bit 3027 crypto ca enroll 776
common CLI functions 21 crypto ca import certificate 777
Common command set 45 crypto ca import crl 778
Community List command set 2316 crypto ca profile 779, 3010
conference 2967 crypto ike 780
conferencing-uri 2761 crypto ike client 3053
configuration 714 crypto ike policy 3063
Configuration Command Sets 14 crypto ike remote-id 784
configure 143 crypto ipsec transform-set 787
connect e1 1471 crypto map 788, 1320, 1540, 1621, 1668, 1757, 1841,
connect fxo 2690 1913, 1987, 2076, 2168
connect fxs 2524, 2895 Crypto Map IKE command set 3025
connect isdn-group 2723 crypto map ipsec-ike 3025
connect pri 2614 crypto map ipsec-manual 3042

Crypto Map Manual command set 3042 debug hw-access-list 217

custom-profile ha-shared-secret 1266 debug interface 218
custom-profile home-address 1267 debug interface adsl events 219
custom-profile primary-ha-address 1268 debug interface cellular 220
custom-profile secondary-ha-address 1269 debug ip bgp 222
custom-profile username 1270 debug ip dhcp-client 224
D debug ip dhcp-server 226
dampening-interval 2357 debug ip dns-client 228
data 2325, 2326 debug ip dns-proxy 229, 230
databits 1213 debug ip flow 231
data-call 790 debug ip ftp-server 233
data-coding scrambled 1278 debug ip http 235
DDS Interface command set 1275 debug ip http client 234
debug 21 debug ip icmp 236
debug aaa 173 debug ip igmp 237
debug access-list 174 debug ip igmp snooping 238
debug arp 175 debug ip mrouting 239
debug atm events 177 debug ip ospf 240
debug atm oam 178 debug ip packet 242
debug atm packet 179 debug ip pim-sparse 245
debug auto-config 180 debug ip pim-sparse assert 246
debug auto-link 176 debug ip pim-sparse hello 247
debug bridge 181 debug ip pim-sparse joinprune 248
debug chat-interfaces 182 debug ip pim-sparse packets 249
debug color 183 debug ip pim-sparse register 250
debug crypto 184 debug ip policy 251
debug data-call 185 debug ip rip 252
debug demand-routing 186 debug ip route-cache express 253
debug desktop-auditing 187 debug ip routing 255
debug dial-backup 189 debug ip rpt quality-monitoring reporter 259
debug dialup-interfaces 190 debug ip security monitor 260
debug dot11 all 191 debug ip tcp 261
debug dot11 client 192 debug ip tcp md5 263
debug dot11 packet-events 193 debug ip tftp 264
debug dot11 packets-ignored 194 debug ip udp 265
debug dot11 session 194 debug ip urlfilter 266, 267
debug dynamic-dns 195 debug ip urlfilter top-websites 267
debug ethernet cfm 196 debug isdn 268
debug ethernet cfm alarm 197 debug isdn group 270
debug ethernet cfm ccm rcv 199 debug isdn resource-manager 271
debug ethernet cfm ccm xmit 201 debug isdn verbose 272
debug ethernet cfm linktrace 203 debug lldp 273
debug ethernet cfm loopback 205 debug mail-clientl 274
debug ethernet cfm remote-mep 207 debug mgcp stack 275
debug firewall 209 debug mgcp verbose 276
debug firewall alg sip 211 debug network-forensics ip dhcp 277
debug frame-relay 212 debug ntp 279
debug frame-relay multilink 213 debug ping twamp 280
debug gvrp bpdus 214 debug port security 285
debug gvrp interface 215 debug port-auth 283
debug gvrp vlans 216 debug ppp 286

debug pppoe client 287 dial-backup number 1552, 1769, 1853, 1999, 2088
debug probe 288 dial-backup priority 1553, 1770, 1854, 2000, 2089
debug probe responder 290 dial-backup randomize-timers 1554, 1771, 1855, 2001,
debug probe responder twamp 290 2090
debug radius 292 dial-backup redial-delay 1555, 1772, 1856, 2002, 2091
debug restore 293 dial-backup restore-delay 1556, 1773, 1857, 2003, 2092
debug save 294 dial-backup schedule 1557, 1774, 1858, 2004, 2093
debug schedule 295 dial-backup shutdown 1558, 1775, 1859, 2094
debug sip 296 dialin 1465
debug sip proxy 298 dial-string source 2762
debug sip stack 299 dialtone 2810
debug snmp packets 301 did 2624, 2649, 2900
debug sntp 302 did digits-transferred 2692, 2811
debug spanning-tree 304 digits-transferred 1473
debug spanning-tree bpdu 303 dir 317
debug stack 305 directory-include 2901
debug system 306 disable 319
debug tacacs+ 307 enable mode 319
debug tcl 308 disable, basic mode 35
debug track 309 disable-callwaiting 2970
debug voice 310 distance bgp 2290
debug vrrp 315 distribute-list 2302, 2399
default codec 2958 diversion-supported 2763
default-information-originate 2376 dnd 2902, 2971
default-level 2968 dnis-digits 2903
default-metric 2377, 2397 dnis-digits prefix 2812
default-privacy | restricted-privacy 946 dns-server 2458, 3054
default-router 2457 do 51
demand interface 1656 domain 2764
Demand Interface command set 1656 domain-name 2459
demand-hold-queue 1670 door-phone 2906, 2972
demand-hold-queue timeout 1670 dos-protection 795
deny 2282, 2317, 2414, 2423, 2670 dot11ap access-point-control 796
deny-template 2969 dscp 2328
description 50, 2525 DSX-1 Interface command set 1283
Desktop Auditing Local Policy Command Set 2446 dynamic-dns 1322, 1559, 1623, 1671, 1776, 1860, 1915,
desktop-auditing dhcp 792 2005, 2095, 2170
desktop-auditing local-policy 793 E
desktop-auditing timeout 794 E1 Interface command set 1293
destination early-cut-through 2693, 2813
probe 2327 ebgp-multihop 2303
DHCP Pool command set 2453 echo-cancellation 2526, 2694, 2724, 2814, 2854, 2876,
DHCP vrf 2472 2907
dial-backup auto-backup 1542, 1759, 1843, 1989, 2078 email 2625, 2650, 2908
dial-backup auto-restore 1543, 1760, 1844, 1990, 2079 email address 3012
dial-backup backup-delay 1544, 1761, 1845, 1991, 2080 email-secondary 2626, 2651, 2909
dial-backup call-mode 1545, 1762, 1846, 1992, 2081 enable 35
dial-backup connect-timeout 1549, 1766, 1850, 1996, basic mode 35
2085 enable mode 62
dial-backup force 1550, 1767, 1851, 1997, 2086 Enable Mode command set 62
dial-backup maximum-retry 1551, 1768, 1852, 1998, 2087 enable password 797

encapsulation 1561 Frame Relay Subinterface command set 1751

encapsulation 802.1q 1324, 2229 frame-relay bc 1778
encapsulation frame-relay ietf 1732 frame-relay be 1779
encryption 3059 frame-relay fragment 1780
end 52 frame-relay interface-dlci 1781
enrollment retry 3013 frame-relay intf-type 1734
enrollment terminal 3014 frame-relay lmi-n391dte 1735
enrollment url 3015 frame-relay lmi-n392dce 1736
entry-filename 2953 frame-relay lmi-n392dte 1737
equipment-type 1490 frame-relay lmi-n393dce 1738
erase 320 frame-relay lmi-n393dte 1739
et-clock-source 1478 frame-relay lmi-t391dte 1740
ethernet cfm 798 frame-relay lmi-t392dce 1741
ethernet cfm domain 799 frame-relay lmi-type 1742
ethernet cfm log-changes 801 frame-relay multilink 1743
Ethernet Interface command set 1309 framing 1285, 1296, 1454, 1504, 1520
Ethernet OAM CFM command set 2473 framing crc4 1296, 1454
Ethernet Subinterface command set 1309 ftp authentication 807
ethernet-cfm down 1325 full-duplex 1327, 2233
ethernet-cfm mep 1326 fwd-courtesy 2913
ethernet-speed 2231 fwd-disconnect delay 2527
event-history 2232 FXO Interface command set 1428
on 802 FXS Interface command set 1439
event-history priority 803 G
events 322 G.703 Interface command set 1452
exception memory minimum 805 garp timer 808
exception report 806 Gigabit Ethernet Interface command set 1309
exception report generate 323 Global Configuration Mode command set 714
exec 723 grammar alert-info url 2765
executive-extension 2652 grammar from 2766
exit 53 grammar p-asserted-identity host 2768
expect regex 2329 grammar proxy-require privacy 2769
expect status 2330 grammar request-uri 2770
expire-time 2996 grammar require 100rel 2771
extended ACL 2411 grammar supported 100rel 2772
external-fwd 2973 grammar to host 2773
external-loopback-request 1460 greeting-length max 2997
F greeting-quota 2998
factory-default 324 group 3060
fair-queue 1562, 1673, 1733, 1862, 2007 gvrp 809
fast-idle 1674 H
fdl 1503 half-duplex 1328, 2234
FDL Interface command set 1422 Handset Paging Configuration 2638
firewall enable 2451 Hardware ACL and Access Map command set 2491
first-name 2910 hardware-address 2460
flowcontrol 1214 hash 3061
forward 2911, 2974 HDLC Interface command set 1834
forward-disconnect 2912 history-depth 2331
fqdn 3016 hold 2975
fragment-threshold 2245 hold-queue 1563, 1675, 1863
Frame Relay Interface command set 1730 out 1745, 2008

hold-timer 2291, 2304 interface t1 1283, 1500

host 2462 interface t3 1517
hostname 810 interface tunnel 2072
hotel 2914, 2976 interface vlan 2162, 2263
hotline 2915 interval 2605
HSSI Interface command set 1459 invert etclock 1480
hw-access-map 811 invert rxclock 1481
I invert txclock 1482
idle-timeout 1676 ip access-group 1329, 1564, 1625, 1677, 1782, 1864, 1917,
ignore dcd 1479 2009, 2097, 2172
ignore-error-duration 1491 ip access-list extended 815
IKE Client command set 3053 ip access-list standard 817
IKE Policy Attributes command set 3057 ip address 1333, 1423, 1568, 1629, 1786, 1865, 1918,
IKE Policy command set 3063 2013, 2098, 2173, 2235
ike-policy 3029, 3044 ip address dhcp 1330, 1565, 1626, 1783, 2010, 2175
impedance 1429, 1441 ip address negotiated 1678, 2011
inactivity-timeout max 2243, 2246 ip address secondary 1333, 1629, 1679, 1786, 1865, 1918,
inband-detection 1492 2013
inband-protocol 1493 ip as-path-list 819, 2281
incoming-accept-number 2615 ip classless 820
initiate 3069 ip community-list 821, 2316
init-string 1466 ip crypto 822, 823
interface 54 ip crypto ffe 823
interface adsl 1249 ip default-gateway 824, 2236
interface ap 2223 ip dhcp 1570, 1788, 2178
interface atm 1528 ip dhcp release 1335
interface atm sub 1532 ip dhcp renew 1336
interface bri 1253 ip dhcp-server database local 825
interface bvi 1618 ip dhcp-server excluded-address 826
interface dds 1275 ip dhcp-server ping packets 828
interface e1 1293 ip dhcp-server ping timeout 829
interface ethernet 1309 ip dhcp-server pool 830, 2453
interface ethernet sub 1309 ip directed-broadcast 1337, 1571, 1631, 1681, 1789, 1867,
interface fdl 1422 1920, 2015, 2100, 2179
interface frame relay sub 1751 ip domain-lookup 831
interface frame-relay 1730 ip domain-name 832
interface fxo 1428 ip domain-proxy 833
interface fxs 1439 ip ffe 1339, 1573, 1791, 1869, 2017, 2102, 2181
interface G.703 1452 ip ffe max-entries 834
interface gigabit-ethernet 1309 ip ffe timeout 835
interface hdlc 1834 ip firewall 837
interface hssi 1459 ip firewall alg 842
interface loopback 1910 ip firewall attack-log threshold 845
interface modem 1463 ip firewall check reflexive-traffic 846
interface port-channel 1955 ip firewall check rst-seq 847
interface ppp 1979, 2356 ip firewall check syn-flood 848
interface pri 1468 ip firewall check winnuke 849
interface radio 2239 ip firewall fast-nat-failover 850
interface range 813, 1309 ip firewall fin-timeout 851
interface serial 1477 ip firewall nat-preserve-source-port 852
interface shdsl 1486 ip firewall policy-log threshold 853

ip firewall rst-timeout 854 ip mtu 2190

ip firewall stealth 855 ip multicast routing 897
ip firewall vrf 856 ip name-server 898
ip flow 1341, 1575, 1633, 1683, 1793, 1871, 1922, 2019, ip ospf 1350, 1584, 1636, 1692, 1802, 1879, 1931, 2027,
2104, 2149 2113, 2191
ip flow cache sample 857 ip ospf authentication 1352, 1586, 1638, 1694, 1804, 1881,
ip flow cache timeout 858 1933, 2029, 2115, 2193
ip flow export 859 ip ospf network 1353, 1587, 1639, 1695, 1805, 1882, 1934,
ip flow export template 861 2030, 2116, 2194
ip flow top-talkers 863 ip pim sparse-mode 1354, 1588, 1806, 1883, 1935, 2031,
ip forward-protocol udp 864 2117, 2195
ip ftp access-class 866 ip pim-sparse dr-priority 1355, 1589, 1807, 1884, 1936,
ip ftp source-interface 868 2032, 2118, 2196
ip helper-address 1342, 1576, 1634, 1684, 1794, 1872, ip pim-sparse hello-timer 1356, 1590, 1808, 1885, 1937,
1923, 2020, 2105, 2183 2033, 2119, 2197
ip host 869 ip pim-sparse nbr-timeout 1357, 1591, 1809, 1886, 1938,
ip http 870 2034, 2120, 2198
ip http source-interface 872 ip pim-sparse override-interval 1358, 1592, 1810, 1887,
ip hw-access-list extended 873 1939, 2035, 2121, 2199
ip igmp 1344, 1578, 1686, 1796, 1873, 1925, 2021, 2107, ip pim-sparse propagation-delay 1359, 1593, 1811, 1888,
2184 1940, 2036, 2122, 2200
snooping vlan 877 ip policy route-map 1360, 1594, 1640, 1696, 1812, 1889,
ip igmp join 875 1941, 2037, 2123
ip igmp snooping 876 ip policy-class 900
vlan mrouter interface 878 max-host-sessions 902
vlan static interface 879 max-sessions 903
ip learn-address 1424 rpf-check 904
ip load-sharing 881 ip policy-timeout 905
ip local policy route-map 882 ip prefix-list description 908
ip mcast-stub downstream 1346, 1580, 1688, 1798, 1875, ip prefix-list seq 909
1927, 2023, 2109, 2186 ip proxy-arp 1361, 1595, 1641, 1697, 1813, 1890, 1942,
ip mcast-stub fixed 1347, 1581, 1689, 1799, 1876, 1928, 2038, 2124, 2201
2024, 2110, 2187 ip radius source-interface 911
ip mcast-stub helper-address 883 ip rip receive version 1362, 1596, 1642, 1698, 1814, 1891,
ip mcast-stub helper-enable 1348, 1582, 1690, 1800, 1943, 2039, 2125, 2202, 2409
1877, 1929, 2025, 2111, 2188 ip rip send version 1363, 1597, 1643, 1699, 1815, 1892,
ip mcast-stub upstream 1349, 1583, 1691, 1801, 1878, 1944, 2040, 2126, 2203, 2409
1930, 2026, 2112, 2189 ip rip summary-address 1364, 1598, 1644, 1700, 1816,
ip mgcp 884 1893, 1945, 2041, 2127, 2204
ip mgcp bracketed-ip 885 ip route 912
ip mgcp call-agent primary 886 ip route vrf 915
ip mgcp call-agent secondary 887 ip route-cache 1365, 1599, 1645, 1701, 1817, 1894, 1946,
ip mgcp local-domain-name 888 2042, 2128, 2205
ip mgcp max1 889 ip route-cache express 914, 2206
ip mgcp max2 890 ip routing 917
ip mgcp persistent-notify 891 ip rtp dtmf-relay min-duration 918
ip mgcp qos dscp 892 ip rtp firewall-traversal 919
ip mgcp retransmit-delay 893 ip rtp nat-session timeout 921
ip mgcp rfc2833-signaling 894 ip rtp qos dscp 922
ip mgcp standard 895 ip rtp quality-monitoring 923
ip mgcp udp 896 ip rtp quality-monitoring history 925

ip rtp quality-monitoring jitter-buffer 927 ip sip timer rollover 982

ip rtp quality-monitoring jitter-threshold 928 ip sip transaction fast-terminate 984
ip rtp quality-monitoring reporter 929 ip sip trunk-auth-name-source 985
ip rtp quality-monitoring round-trip-delay 930 ip sip udp 939
ip rtp quality-monitoring threshold jitter 931 ip snmp agent 986
ip rtp quality-monitoring threshold loss 932 ip sntp server 987
ip rtp quality-monitoring threshold lq-mos 933 send-unsynced 988
ip rtp quality-monitoring threshold pq-mos 934 ip sntp server source-interface 989
ip rtp symmetric-filter 935 ip sntp source-interface 990
ip rtp udp 936 ip ssh-server 814
ip scp server 937 ip subnet-zero 991
ip sdp grammar hold 938 ip tacacs source-interface 992
ip sip 939 ip telnet-server 814
ip sip access-class in 941 ip tftp server 867, 993
ip sip authenticate 942 ip tftp server default-filesystem 867
ip sip database local 943 ip tftp source-interface 994
ip sip default-call-routing 944 ip unnumbered 1366, 1600, 1646, 1702, 1818, 1895, 1947,
ip sip grammar 946 2043, 2207
alert-info url 945 ip urlfilter 1367, 1601, 1647, 1703, 1819, 1896, 1948,
from 947 2044, 2129, 2208
p-asserted-identity host 949 ip urlfilter allowmode 996
proxy-require privacy 950 ip urlfilter exclusive-domain 997
request-uri 951 ip urlfilter http 995
supported 100rel 953, 967 ip urlfilter max-request 998
to host 954 ip urlfilter max-response 999
ip sip inbound-trunk-matching 956 ip urlfilter server 1000
ip sip location 957 ip vrf route-distinguisher 1002
ip sip privacy 958 ip-address 3017
ip sip proxy 959 ip-range 3055
ip sip proxy allowed-servers 960 ISDN Group command set 2611
ip sip proxy dial-string source 961 isdn ldn 1255
ip sip proxy domain 962 isdn name-delivery 1474
ip sip proxy emergency-call-routing 963 isdn spid 1256
ip sip proxy failover accept-registrations 965 isdn switch-type 1258, 1475
ip sip proxy failover codec-group 966 isdn-group 1003, 2611
ip sip proxy failover dial-string source 967 isdn-number-template 1004
ip sip proxy failover match-digits 968 J
ip sip proxy failover sip-keep-alive 969 join-prune-msg-interval 2392
ip sip proxy failover trust-domain 970 K
ip sip proxy grammar 918, 971 keepalive 1704, 1897, 2045, 2130
ip sip proxy local-gateway 972
L
ip sip proxy routing contact-comparison strict 973
last-name 2916
ip sip proxy sip-server primary 974
lbo 1505
ip sip proxy sip-server secondary 975
lease 2463
ip sip proxy transparent 976
lifetime 3062
ip sip proxy transparent nat-simulate 976
Line (Console) Interface command set 1207
ip sip qos dscp 977
Line (SSH) Interface command set 1223
ip sip registrar 978
Line (Telnet) Interface command set 1235
ip sip tcp 939
line console 1007, 1207
ip sip timer 980
line ssh 1007, 1223
ip sip timer registration-failure-retry 981
line telnet 1007, 1235

line-length 1286, 1521 Mail Agent command set 2508

line-mode 1494 mail-client 1033
linerate 1495 maintenance 1261
line-timeout 1215, 1231, 1243 match 260, 2549
lldp 1009 match address 3030, 3045
lldp receive 1368, 1705, 1820, 1898, 1957, 2046, 2131 match ani 2725, 2774, 2815
lldp send 1369, 1706, 1821, 1899, 1958, 2047, 2132 match ani substitute 2628, 2654, 2695, 2917
local-as 2305 match as-path 2575
local-id 3070 match community 2576
location 2237 match dnis replace ani 2727, 2776, 2817
log 2416, 2420, 2423, 2425, 2495, 2497 match dnis substitute 2697, 2729, 2778, 2819
log-changes 2358 match dscp 2553
logging console 1013 match ip address 2577
logging email match ip address prefix-list 2578
address-list 1014 match ip dscp 2579
exception-report address-list 1015 match ip precedence 2583
ip urlfilter top-websites 1016 match length 2585
on 1017 match list 2606
priority-level 1018 match metric 2586
receiver-ip 1019 match precedence 2557
source-interface 1021 match track 3032
logging facility 1022 match-interesting 1676, 1708
logging forwarding auxiliary-receiver-ip 1023 max-channels 2617
logging forwarding on 1024 maximum-paths 2292, 2380
logging forwarding priority-level 1025 max-inbound 2630, 2656
logging forwarding receiver-ip 1026 max-number-calls 2780
logging forwarding source-interface 1027 max-reserved-bandwidth 1372, 1602, 1649, 1709, 1746,
login 1216, 1232, 1244 1901, 2049, 2210
login authentication 1217, 1233, 1245 max-sessions 2351
login local-userlist 1218, 1234, 1246 media ethernet 2150
login-member 2627, 2653 media-gateway ip 1373, 1603, 1823, 1902, 2050, 2134,
logout 36, 325 2211
logout-group 2977 member 2631, 2657
loop-alarm-detect 1297 message-length max 2999
loopback 1279, 1430, 1442, 1461, 1496 message-quota 3000
Loopback Interface command set 1910 message-waiting 2919, 2978
loopback local 1259 MGCP command set 2519
loopback network 1260, 1287, 1298, 1455, 1506, 1522 min-channels 2618
loopback remote 1523 modem countrycode 1034
loopback remote inband 1497 Modem Interface command set 1463
loopback remote line 1507 modem-passthrough 2528, 2699, 2821, 2920
loopback remote line inband 1288 monitor port 2607
loopback remote payload 1508 monitor session 1037
loopback remote v54 1299 MTU 1115
M mtu 1374, 1425, 1604, 1650, 1710, 1824, 1903, 1949, 2051,
mac access-list standard 1028 2135
mac address-table aging-time 1029 N
mac address-table static bridge interface 1030 name 2151, 2238, 2529
mac address-table static vlan interface 1030 nap 2464
mac hw-access-list extended 1031 nat-traversal 3072
mac-address 1371, 1648, 2209 neighbor 2293

netbios-name-server 2465, 3056 port-auth port-control 1380

netbios-node-type 2466 port-auth re-authentication 1051
network 2294, 2401, 2467 port-auth supplicant 1052
network area 2381 port-auth timeout 1053
Network Monitor Probe command set 2319, 2346 Port-Channel Interface command set 1955
Network Monitor Track command set 2356 port-channel load-balance 1054
network-forensics ip dhcp 1039 power inline 1381
next-hop-self 2307 power local 2247
nls 2530, 2822, 2855, 2877, 2921 power-supply shutdown automatic 1055
no default-originate 2308 ppoe ac-name 2064
no ip vrf 1002 ppp authentication 1713, 2054
no shutdown track 1376 ppp bcp tagged-frame 1718, 2059
ntp master 1040 ppp chap hostname 1719, 2060
ntp max-associations 1041 ppp chap password 1720, 2061
ntp peer 1044 ppp chap sent-username/password 1723, 2063
ntp update-rtc 1047 PPP Interface command set 1979
ntp-server 2468 ppp multilink 1721, 2062
num-packets 2332 pppoe service-name 2065
num-rings 2632, 2658, 2856, 2878, 2923 preamble 2248
O preamble-short 2248
oam retry 1606 prefer trunk-routing 2701, 2733, 2824
oam-pvc managed 1607 prefix 2633, 2659
option 2469 prefix-list 2310, 2578
outage-retrain 1498 PRI Interface command set 1468
outbound-proxy primary 2781 priority 2559
outbound-proxy secondary 2782 probe 1056, 2319, 2346
overhead-paging 2979 destination 2327
override-passcode 2980 program-user-speed 2983
P prompt-delete 3001
parity 1219 protection-mode 2249
park 2981 pvc 1608
passive-interface 2402 Q
password 1220, 1247, 2309, 2857, 2925, 3018 qos 1384, 1960
peer 3073 qos cos-map 1059
peer default ip address 1427, 1712, 2053 qos dscp-cos 1060
period 2333 qos map 1061, 2428, 2545
permit 2283, 2318, 2418, 2425, 2673 QoS Map command set 2428, 2545
permit template 2982 qos queue-type strict-priority 1063
ping 37, 326 qos queue-type wrr 1064
ping ethernet 329 qos-mode wmm 2251
ping stack-member 332 qos-policy 1382, 1609, 1724, 1747, 2066, 2212, 2562
ping twamp 333 qos-policy out 1652
plc 2531, 2700, 2732, 2823, 2858, 2879, 2926 R
port 2352 radio interface 2239
Port Channel Interface command set 1955 Radio Interface command set 2239
portal-list 1048 radio-mode 2253
port-auth auth-mode 1377 Radius Group command set 2570
port-auth control-direction 1378 radius-server 1065
port-auth default 1049 radius-server host 1067
port-auth max-req 1050 ramdisk 335
port-auth multiple-hosts 1379 raw string 2334

redial 2984 rtp packet-delay 2535, 2707, 2739, 2830, 2864, 2883, 2931
redistribute bgp 2382, 2403 rtp qos dscp 2536, 2708, 2740, 2831, 2865, 2932
redistribute connected 2295, 2383, 2404 rtp quality-monitoring 1385, 1529, 1653, 1726, 1826,
redistribute ospf 2296, 2405 1907, 2068, 2214, 2255
redistribute rip 2297, 2384 rtp rx-gain 2741, 2832
redistribute static 2298, 2386, 2406 rtp tx-gain 2742, 2833
register 2784 rts threshold 2256
registrar max-concurrent-reg 2787 run tcl 1076
registrar primary 2788 run-tcl track 341
registrar require-expires 2789 rx-gain 1431, 1444
registrar secondary 2790 S
registrar threshold 2791 sa4tx-bit 1301
reject 2674, 2859 schedule 1077
reject-external 2702, 2734, 2792, 2825 security wep-key generate 2274
reload 336 security wep-key seed 2276
reload dot11 interface dot11ap 337 security-update current 2452
remark 2422, 2427, 2498 seize-timeout 2866
remote-alarm rai 1509 send test 2515
remote-as 2311 send trigger 2516
remote-fwd 2985 send-community standard 2313
remote-loopback 1280, 1289, 1300, 1510, 1524 send-schedule periodic 2335
rename 2986, 3002 Serial Interface command set 1477
reset 1271, 2156 serial-mode 1483
resource pool 1725 serial-number 3019
resource pool-member 1262, 1272, 1467, 2619 server 2517, 2571, 2603
resource-selection 2676, 2703, 2735, 2826 service password-encryption 1079
resource-utilization 1069 set as-path prepend 2588
respond 3075 set comm-list delete 2589
retrain 1250 set community 2590
retrieve-park 2987 set cos 2564
retry-throttling 1273 set default interface 2592
return-last-call 2988 set dscp 2565
ring-voltage 1443 set interface 2593
role 1476 set ip default next-hop 2594
Route Map command set 2573 set ip df 2595
route-distinguisher 1002 set ip dscp 2596
route-map 1070, 2312 set ip next-hop 2597
Router (OSPF) command set 2371 set ip precedence 2598
Router (PIM Sparse) command set 2391 set local-preference 2599
Router (RIP) command set 2395 set metric 2600
router bgp 1071, 2284 set metric-type 2601
router bgp-neighbor 2299 set peer 3036, 3047
router ospf 1072, 2371 set pfs 3038
router pim-sparse 1073 set precedence 2567
router rip 1074, 2395 set security-association idle-time 3039
rp-address 2393 set security-association lifetime 3040
rtp delay-mode 2532, 2704, 2736, 2827, 2861, 2880, 2927 set session-key 3048
rtp dtmf-relay 2533, 2705, 2737, 2828, 2862, 2881, 2928 set transform-set 3041, 3052
rtp frame-packetization 2534, 2706, 2738, 2829, 2863, sfp-info 610
2882, 2929 shape average 78, 2568
rtp frame-packetization mode 2930 SHDSL Interface command set 1486

shortcuts 20 show hw-access-map 427

short-slot-time 2257 show hw-filter-resource 428
show 2157 show interfaces 429, 432
show access-lists 342 show interfaces adsl 436
show arp 348 show interfaces cellular 438
show atm pvc 350 show interfaces dot11ap 439
show atm traffic 351 show ip access-lists 442
show auto-config 353 show ip arp 443
show auto-link 347 show ip as-path-list 445
show bridge 354 show ip bgp 447
show buffers 356 show ip bgp community 449
show buffers users 358 show ip bgp community-list 452
show cflash 360 show ip bgp neighbors 454
show channel-group 361 show ip bgp regexp 457
show clock 39, 362 show ip cache 459
show configuration 363 show ip community-list 461
show connections 365 show ip dhcp-client lease 462
show crypto ca 366 show ip dhcp-server binding 463
show crypto ike 368 show ip ffe 465, 2404
show crypto ipsec 370 show ip ffe summary 470
show crypto map 373 show ip flow 471
show debugging 375 show ip flow top-talkers 473
show demand 377 show ip igmp groups 475
show desktop-auditing dhcp 380 show ip igmp interface 476
show dial-backup interfaces 384 show ip igmp snooping 478
show dialin interfaces 385 show ip interfaces 480
show dos counters 386 show ip local policy 482
show dos-id 387 show ip mroute 484
show dot11 access-point 388 show ip ospf 486
show dot11 clients 391 show ip ospf database 487
show dot11 statistics interface dot11ap 393 show ip ospf interface 490
show dynamic-dns 395 show ip ospf neighbor 491
show ethernet cfm association 396 show ip ospf summary-address 493
show ethernet cfm domain 398 show ip pim-sparse 494
show ethernet cfm mep local 400 show ip policy 498
show ethernet cfm mep remote 403 show ip policy-class 499
show ethernet cfm stack 405 show ip policy-sessions 501
show event-history 407 show ip policy-stats 505
show fan-tach 408 show ip prefix-list 506
show file 409 show ip protocols 507
show flash 412 show ip route 508
show frame-relay 413 show ip route-cache express 513
show frame-relay fragment 415 show ip route-cache express host-table 514
show frame-relay multilink 417 show ip rtp quality-monitoring 515
show garp timer 418 show ip rtp quality-monitoring reporter 520
show gvrp configuration 419 show ip security 522
show gvrp members vlan 420 show ip traffic 525
show gvrp state 421 show ip urlfilter 527
show gvrp statistics 422 show ip urlfilter exclusive-domain 528
show hosts 423 show ip urlfilter statistics 529
show hw-access-list 425 show ip urlfilter top-websites 530

show isdn resource 536 status 622

show isdn-group 534 show spanning-tree active 624
show isdn-number-template 535 show spanning-tree blockedports 625
show lldp 538 show spanning-tree interface 626
show lldp device 539 show spanning-tree pathcost method 628
show lldp neighbors 541 show spanning-tree root 629
show lldp neighbors statistics 543 show stack 631
show mac address-table 545 show startup-config 634
show mac address-table address 546 show switchports 636
show mac address-table aging-time 548 show system 638
show mac address-table count 549 show tacacs+ statistics 640
show mac address-table dynamic 550 show tcp info 641
show mac address-table interface 552 show tech 643
show mac address-table multicast 554 show temperature 645
show mac address-table static 556 show thresholds 646
show mail-client 558 show toneservices resources 647
show mail-client body 559 show track 648
show media-gateway 560 show udp info 650
show memory 562 show usb attached-devices 652
show mgcp-endpoint 564 show users 654
show modules 565 show version 41, 656
show monitor session 566 show vlan 657
show network-forensics ip dhcp 567 show voice alias 660
show ntp associations 569 show voice available 661
show output-chkdsk 571 show voice conference 662
show output-startup 573 show voice dial-plan 663
show port-auth 574 show voice did 664
show port-security 576 show voice directory 665
show power inline 578 show voice door-phone 666
show power-supply 580 show voice extensions 667
show pppoe 581 show voice grouped-trunk 668
show probe statistics 582 show voice line 669
show processes 585 show voice loopback calls 670
show qos 587 show voice mail 671
show qos map 589 notify-schedule 2933
show queue 592 show voice match 673
show queuing 594 show voice named-digit-timeouts 675
show radius statistics 595 show voice operator-group 676
show route-map 597 show voice phone-files 677
show rtp resources 599 show voice quality-stats 678
show running-config 600 show voice ring-group 680
show running-config voice 604 show voice speed-dial 682
show schedule 609 show voice spre 683
show sfp-info 610 show voice status-group 685
show sip 612 show voice switchboard 686
show sip location 614 show voice system-mode 687
show sip proxy 615 show voice trunk 689
show sip trunk-registration 617 show voice users 690
show snmp 40, 619 sip 691
show sntp 621 show voip name-service cache 692
show spanning-tree show voip name-service name-table 693

show vrf 532 spanning-tree edgeport default 1105

show vrrp 695 spanning-tree forward-time 1106
shutdown 61, 2336, 2353, 2359 spanning-tree hello-time 1107
signal 1445 spanning-tree link-type 1392, 1614, 1830, 1967
signaling-mode 1290 spanning-tree max-age 1108
sip check-sync 697 spanning-tree mode 1109
sip-authentication password 2935 spanning-tree path-cost 1615, 1831
sip-identity 2634, 2660, 2936, 2954 spanning-tree pathcost method 1110, 1393
sip-keep-alive 2793, 2867, 2937 spanning-tree port-priority 1394, 1616, 1832, 1968
sip-server primary 2794 spanning-tree priority 1111
sip-server rollover 2795 special-ring-cadences 2938
sip-server secondary 2796 speed 1221, 1395, 2258
size 2337 speed default basic-set 2259
snmp ifmib alias long 1080 speed-dial 2939
snmp trap 1281, 1386, 1484, 1530, 1749, 1952, 1961, 2137, spt-threshold 2394
2215 stack master 1112
snmp trap line-status 1302, 1511 stack member 1112
snmp trap link-status 1274, 1282, 1291, 1303, 1387, 1456, stack vlan 1112
1462, 1485, 1512, 1525, 1531, 1727, 1750, 1908, 1953, standard ACL 2411
1962, 2069, 2138, 2216 state 2152
snmp trap threshold-reached 1304, 1513 station-lock 2940, 2989
snmp-server chassis-id 1081 station-role 2260
snmp-server community 1082 station-role access-point 2260
snmp-server contact 1083 stopbits 1222
snmp-server enable traps 1084 storm-control 1396, 1970
snmp-server engineID local 1085 storm-control action 1398
snmp-server engineID remote 1087 storm-control action shutdown 1398, 1969
snmp-server group 1088 subject 2518
snmp-server host 1089 subject-name 3020
snmp-server inform 1091 summary-address 2388
snmp-server location 1092 suppress null-username 726
snmp-server management-url 1093 switchport access vlan 1399, 1972
snmp-server management-url-label 1094 switchport gvrp 1400, 1973
snmp-server source-interface 1095 switchport mode 1401, 1974
snmp-server user 1096 switchport port-security 1402
snmp-server view 1099 aging 1403
snr-margin 1251 expire 1404
sntp retry-timeout 1100 mac-address 1405
sntp server version 1101 maximum 1406
sntp wait-time 1102 violation 1407
soft-reconfiguration inbound 2314 switchport protected 1408
sort-by 2608 switchport trunk allowed vlan 1409, 1975
source-address 2338 switchport trunk fixed vlan 1410, 1976
source-interface 2354 switchport trunk native vlan 1412, 1978
source-port 2339 switchport vlan 1413
spanning-tree bpdufilter 1388, 1611, 1827, 1963 system MTU 1115
spanning-tree bpduguard 1389, 1612, 1828, 1964 system timing 1514
spanning-tree cost 1390, 1965 system-mode 2990
spanning-tree edgeport 1391, 1613, 1829, 1966 system-speed 2991
spanning-tree edgeport bpdufilter default 1103 system-timing 1305
spanning-tree edgeport bpduguard default 1104

T transfer 2992
T1 Interface command set 1500 treat-inbound-as-internal 2834
T3 Interface command set 1517 trunk 2677, 2868
t38 2537, 2710, 2744, 2837, 2941 trunk-number 2709, 2743, 2835
t38 error-correction 2538, 2711, 2745, 2838, 2942 trust-domain 2796, 2797
t38 fallback-mode 2539, 2712, 2746, 2839, 2943 ts16 1308, 1458
t38 max-buffer 2540, 2713, 2747, 2840, 2944 tunnel checksum 2139
t38 max-datagram 2541, 2714, 2748, 2841, 2945 tunnel destination 2140
t38 max-rate 2542, 2715, 2749, 2842, 2946 Tunnel Interface command set 2072
t38 redundancy 2543, 2716, 2750, 2843, 2947 tunnel key 2141
tacacs 992 tunnel mode gre 2142
TACACS+ Group command set 2602 tunnel sequence-datagrams 2143
tacacs-server 1116 tunnel source 2144
tacacs-server host 1117 tunnel vrf 2146
tdm-group 1306, 1515 tx-ani 2844
telnet 42, 698, 1119 tx-gain 1438, 1451
telnet stack-member 700 type 2345, 2635, 2661
telnet vrf stack-member 701 U
terminal length 702 undebug all 707
test battery 1446 unlock-door 2993
test erl 1432 update 727
test if 2360 update-source 2315
test list 2364 update-timer 2408
test list weighted 2367 username password 1125, 1728, 2070
test loop 1434 username portal-list 1126
test reverse-battery 1447 user-speed 2994
test ring-ground 1435 V
test ringing 1448 vad 2544, 2717, 2751, 2845, 2869, 2948
test timeout 2355 VAP Interface command set 2263
test tip-ground 1436 vap-isolation 2261
test tip-open 1449 verify-file 708
test tone 1437, 1450 version 2409
test-pattern 1292, 1307, 1457, 1499, 1516, 1526 vlan 1127
tftp-server 2470 media ethernet 2159
threshold 2340 name 2160
thresholds 1121 state 2161
timeout 2342 vlan id 2158
timeout-timer 2407 VLAN command set 2148
timers lsa-group-pacing 2389 vlan database 709
timers spf 2390 VLAN Database command set 2153
time-schedule 2370 VLAN Interface command set 2162
timezone-offset 2471 vlan-id 1417
timing-source 1123 voice alias equals 1128
tolerance 2343 Voice Analog Trunk DPT command set 2679
top 2609 Voice Analog Trunk GS command set 2679
Top Traffic command set 2604 Voice Analog Trunk LS command set 2679
traceroute 44, 703 voice ani-list 1129
traceroute ethernet 704 Voice Auto Attendant command set 2952
track 1124, 2356, 2416, 2420, 2423, 2425 voice autoattendant 1131
traffic-shape rate 1416, 1654, 2217 voice call-appearance-mode 1132
training-mode 1252 voice callerid-type 1133

voice cause-code-map 1134 Voice Quality Monitoring Reporter command set 3003
voice class-of-service 1135, 2959, 2995 Voice Ring Group command set 2643
Voice CODEC List command set 2955 voice ring-group 1179, 2643
voice codec-country 1136 voice service-mode 1180
voice codec-list 1137 Voice SIP Trunk command set 2752
voice codec-list trunk 2955 voice speed-dial 1181
voice codec-priority 1138 voice spre 1182
voice codec-subcountry 1139 voice spre-map 1184
voice compand-type 1140 voice spre-mode 1183
voice conferencing-mode 1143 voice status-group 1190
Voice CoS command set 2959 voice status-group expires 1189
voice country-code 1144 voice system-country 1192
voice coverage 1145 voice system-mode 1194
voice current-mode 1146 Voice T1 Trunk
voice dial-plan 1147 FGD Interface command set 2798
voice did extension 1150 GS User Interface command set 2798
voice directory 1151 Immediate command set 2798
voice disconnect-mode 1152 Interface command set 2798
voice dsp capture 710 LS User Interface command set 2798
voice fax-tone 1153 TIE Trunk FGD command set 2798
voice feature-mode 1155 Wink command set 2798
voice flashhook mode 1156 voice timeouts 1195
voice flashhook threshold 1157 voice transfer 1197
voice forward-mode 1158 voice transfer-mode 1198
voice grouped-trunk 1159, 2666 voice transfer-on-hangup 1199
Voice Groups Command Sets 2610 Voice Trunk Analog command set 2679
voice hold-reminder 1160 Voice Trunk Group command set 2666
voice international-prefix 1161 voice trunk type isdn 1201, 2718
Voice ISDN Trunk command set 2718 voice trunk type sip 1201, 2752
voice line account 2847 voice trunk type t1-rbs supervision 1203
Voice Line Account command set 2847 voice trunk-list 1200
voice loopback 1163 voice user 1204, 2870, 2887
Voice Loopback Account Command Set 2870 Voice User command set 2887
voice mail 1164 voiceline 1162
voice mail check 1165 voicemail 2636, 2662, 2949
Voice Mail CoS command set 2995 Voicemail CoS command set 2995
voice mail leave 1166 VRF 2472
voice mail sip-identity 1167 vrf
voice match ani 1168, 2664 ip firewall 856
voice mgcp-endpoint 1170 ip local policy route-map 882
voice modem-passthrough-mode auto-disable-call-wait ip name-server 898
1171 ip route vrf 915
voice num-rings 1172 ip vrf route-distinguisher 1002
Voice Operator Group command set 2620 ping 37, 326
voice operator-group 1173, 2620 show ip local policy 482
voice overhead-pagin connected-timeout 1174 telnet 42, 1119
voice overhead-paging extension 1175 traceroute 44
Voice Paging Group Command Set 2638 tunnel 2146
voice paging-group 1176 vrf forwarding 1205, 1418, 1617, 1655, 1729, 1833,
voice park-return 1177 1909, 1954, 2071, 2147, 2218
voice prompt-language 1178

vrf forwarding 1205, 1418, 1617, 1655, 1729, 1833, 1909, W

1954, 2071, 2147, 2218 wall 712
vrrp commands 1419, 2219 warranty 3
VT100 configuration 11 world-mode dot11d 2262
write 713

Adtran AOS Command Reference Guide 17.08

Загружено:

Сведения о документе

Исходное описание:

Авторское право

Доступные форматы

Поделиться этим документом

Поделиться или встроить документ

Параметры публикации

Этот документ был вам полезен?

Это неприемлемый материал?

Авторское право:

Доступные форматы

Adtran AOS Command Reference Guide 17.08

Загружено:

Авторское право:

Доступные форматы

ADTRAN OPERATING SYSTEM (AOS)

Command Reference Guide

To the Holder of this Manual

Software Licensing Agreement

901 Explorer Boulevard

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 2

Notes provide additional useful information.

Cautions signify information that could prevent service interruption.

Warnings provide information that could prevent damage to the equipment or

Service and Warranty

DOC - Department of Commerce

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 3

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 4

AP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2223

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 5

Voicemail CoS Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2995

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 6

REFERENCE GUIDE INTRODUCTION

AOS UNIT INTRODUCTION

1. ROM - Read Only Memory

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 7

3. RAM - Random Access Memory

4. NVRAM - Nonvolatile Random Access Memory

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 8

INTRODUCTION TO COMMAND LINE INTERFACE

How Commands Function

AOS Command System

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 9

#show flash | cflash

#copy <file source location> <config-file> tftp

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 10

USING THE CLI

Connecting the Unit . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Connecting the Unit

Accessing the CLI from Your PC

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 11

Session Now Available

Understanding Command Modes

Mode Access By... Mode Prompt Accessible Commands

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 12

Mode Access By.... Mode Prompt Accessible Commands

Mode Access By... Mode Prompt Accessible Commands

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 13

Configuration Command Sets

Line Interface Command Sets

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 14

Physical Interface Command Sets

Virtual Interface Command Sets

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 15

Wireless Interface Command Sets

Routing Command Sets

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 16

Security and Services Command Sets

Voice Group Command Sets

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 17

Voice Trunks Command Sets

Voice Accounts Command Sets

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 18

Voice Services Command Sets

Virtual Private Network (VPN) Parameter Command Sets

60000CRGD-35G Copyright © 2010 ADTRAN, Inc. 19

Using CLI Shortcuts

(config-eth 0/1)#ip address 192.33.55.6