AOS Command Reference Guide

User Manual: AOS Command Reference Guide

Open the PDF directly: View PDF .
Page Count: 3968 [warning: Documents this large are best viewed by clicking the View PDF Link!]

ADTRAN Operating System (AOS)
Table of Contents

ADTRAN OPERATING SYSTEM (AOS)

Command Reference Guide

AOS Version R10.1.0

June 2012

60000CRG0-35E

Command Reference Guide

Trademarks

Any brand names and product names included in this manual are trademarks, registered trademarks,

service marks, or trade names of their respective holders.

To the Holder of this Manual

The contents of this manual are current as of the date of publication. ADTRAN reserves the right to change

the contents without prior notice.

In no event will ADTRAN be liable for any special, incidental, or consequential damages or for

commercial losses even if ADTRAN has been advised thereof as a result of issue of this publication.

Be advised that certain security risks are inherent in the use of any telecommunications or networking

equipment, including but not limited to, toll fraud, Denial of Service (DoS) attacks, loss or theft of data,

and the unauthorized or illegal use of said equipment. ADTRAN OFFERS NO WARRANTIES, EITHER

EXPRESSED OR IMPLIED, REGARDING THE PREVENTION, DETECTION, OR DETERRENCE

OF TOLL FRAUD, NETWORKING ATTACKS, OR UNAUTHORIZED, ILLEGAL, OR IMPROPER

USE OF ADTRAN EQUIPMENT OR SOFTWARE. THEREFORE, ADTRAN IS NOT LIABLE FOR

ANY LOSSES OR DAMAGES RESULTING FROM SUCH FRAUD, ATTACK, OR IMPROPER USE,

INCLUDING, BUT NOT LIMITED TO, HUMAN AND DATA PRIVACY, INTELLECTUAL

PROPERTY, MATERIAL ASSETS, FINANCIAL RESOURCES, LABOR AND LEGAL COSTS.

Ultimately, the responsibility for securing your telecommunication and networking equipment rests with

you, and you are encouraged to review documentation regarding available security measures, their

configuration and implementation, and to test such features as is necessary for your network.

Software Licensing Agreement

Each ADTRAN product contains a single license for ADTRAN supplied software. Pursuant to the

Licensing Agreement, you may: (a) use the software on the purchased ADTRAN device only and (b) keep

a copy of the software for backup purposes. This Agreement covers all software installed on the system, as

well as any software available on the ADTRAN website. In addition, certain ADTRAN systems may

contain additional conditions for obtaining software upgrades.

901 Explorer Boulevard

P.O. Box 140000

Huntsville, AL 35814-4000

Phone: (256) 963-8000

www.adtran.com

60000CRG0-35E

Printed in the U.S.A.

Command Reference Guide

Conventions

Service and Warranty

For information on the service and warranty of ADTRAN products, visit the ADTRAN website at

http://www.adtran.com/support.

Export Statement

An Export License is required if an ADTRAN product is sold to a Government Entity outside of the EU+8

(Austria, Australia, Belgium, Czech Republic, Denmark, Finland, France, Germany, Greece, Hungary,

Ireland, Italy, Japan, Luxembourg, Netherlands, New Zealand, Norway, Poland, Portugal, Spain, Sweden,

Switzerland and the United Kingdom). This requirement is per DOC/BIS ruling G030477 issued 6/6/03.

This product also requires that the Exporter of Record file a semi-annual report with the BXA detailing the

information per EAR 740.17(5)(e)(2).

DOC - Department of Commerce

BIS - Bureau of Industry and Security

BXA - Bureau of Export Administration

Notes provide additional useful information.

Cautions signify information that could prevent service interruption.

Warnings provide information that could prevent damage to the equipment or

endangerment to human life.

Command Reference Guide

Table of Contents

Basic Mode Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Common Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Enable Mode Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83

Global Configuration Mode Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 852

Line (Console) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1464

Line (SSH) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1481

Line (Telnet) Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1498

ADSL Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1517

BRI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1525

Cellular Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1537

DDS Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1556

DSX-1 Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1565

E1 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1576

Ethernet Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1594

FDL Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1741

FXO Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1748

FXS Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1759

G.703 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1778

HSSI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1785

MEF Ethernet Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1790

Modem Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1859

PRI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1865

Serial Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1884

SHDSL Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1894

T1 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1913

T3 Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1932

ATM Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1944

ATM Subinterface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1949

BVI Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2042

Demand Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2086

EFM Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2166

Frame Relay Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2171

Frame Relay Subinterface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2193

HDLC Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2308

Loopback Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2389

Port Channel Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2438

PPP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2463

Tunnel Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2588

VLAN Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2690

Command Reference Guide

VLAN Database Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2695

VLAN Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2704

AP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2797

Radio Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2813

VAP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2837

AS Path List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2855

BGP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2858

BGP Neighbor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2878

BGP Address Family Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2895

BGP AF Neighbor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2916

Community List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2935

Network Monitor Probe Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2938

Network Monitor Probe Responder Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2966

Network Monitor Track Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2977

Router (OSPF) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2994

Router (PIM Sparse) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3015

Router (RIP) Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3020

Desktop Auditing Local Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3037

DHCPv4 Pool Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3044

DHCPv6 Pool Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3067

DHCPv6 Server Pool Host Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3087

Ethernet OAM CFM Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3091

Hardware ACL and Access Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3109

IPv4 Access Control List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3126

IPv4 Access Control Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3144

IPv6 Access Control List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3162

IPv6 Access Control Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3192

Mail Agent Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3201

MEF EVC Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3213

MEF EVC Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3217

MEF Policer Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3223

MGCP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3229

Packet Capture Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3259

Quality of Service Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3269

RADIUS Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3296

Route Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3300

Security Monitor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3333

SIP HMR Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3338

TACACS+ Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3361

Top Traffic Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3364

Voice Call Pickup Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3372

Command Reference Guide

Voice ISDN Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3375

Voice Operator Ring Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3384

Voice Paging Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3402

Voice Ring Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3407

Voice Trunk Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3430

Voice Analog Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3443

Voice ISDN Trunk Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3493

Voice SIP Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3532

Voice T1 Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3603

Voice Line Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3656

Voice Loopback Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3679

Voice User Account Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3697

Voice Auto Attendant Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3778

Voice Call Queuing Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3781

Voice Coverage Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3799

Voice CODEC List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3803

Voice CoS Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3807

FindMe-FollowMe Action Script Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3844

FindMe-FollowMe Contact Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3852

Voice Music on Hold Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3862

Proxy User Template Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3865

Voicemail CoS Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3876

VQM Reporter Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3885

CA Profile Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3899

Certificate Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3911

Crypto Map IKE Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3916

Crypto Map Manual Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3933

IKE Client Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3943

IKE Policy Attributes Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3948

IKE Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3955

Command Reference Guide Reference Guide Introduction

REFERENCE GUIDE INTRODUCTION

This manual provides information about connecting your product, using the ADTRAN Operating System’s

(AOS) command line interface (CLI), and executing the commands available with the NetVanta Series

units and Total Access 900 Series units.

If you are new to the AOS CLI or new to the world of routers, please take a few moments to review the

information provided in the sections which follow.

If you are already familiar with ADTRAN NetVanta and Total Access 900 units and looking for

information on a specific command or group of commands, please proceed to Command Descriptions on

page 23 of this guide.

AOS UNIT INTRODUCTION

External Parts

To connect and use your new AOS unit, first familiarize yourself with the external setup of the unit. Each

product has a serial port on the back of the unit. The port is marked CONSOLE and connects the unit

directly to your PC via a standard DB-9 serial cable.

Other features vary from unit to unit, but include power connections, physical interface connections (such

as dial backup (DBU) or wide area network (WAN)), and status LEDs along the front that indicate the

status of your unit. For a more detailed description of your particular product, please refer to the Hardware

Installation Guide available online at www.adtran.com.

Internal Parts

In order to fully understand product operation and receive the full benefit of the included guides, you

should be familiar with the unit’s internal parts, which can be divided into five main categories.

1. ROM - Read Only Memory

Read only memory (ROM) is a permanent form of memory stored in chips within the unit and houses

information used by the AOS unit on initial startup. Examples of information stored in ROM are the

Power-On Self Test, which initializes upon boot up and checks the unit’s functionality; the Bootstrap

Startup Program, which actually starts the unit; and the basic form of the AOS software.

2. Flash Memory

Flash Memory is memory located in a memory chip that is not only erasable, but also reprogrammable,

allowing for software upgrades without chip removal. The flash memory in your unit contains the full

AOS and can be used to house copies of the configuration files and application images that are used at

initial unit startup.

Command Reference Guide Internal Parts

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 hard-

ware includes the central processing unit (CPU), the memory, and the interfaces.

• The Bootstrap Startup Program (factory set in the ROM) runs.

• The Bootstrap Startup Program is read by the unit to discover the proper source for the operating

system image.

• The operating system image is loaded into RAM.

• The configuration file saved in NVRAM is loaded into RAM, where it is accessed by the unit and

then executed one line at a time.

If no configuration file is found in NVRAM (there will not be one found on initial setup), you are

presented with the following prompt on your terminal or HyperTerminal screen:

Session Now Available

Press RETURN to get started

After pressing return, a prompt appears for communication with your unit.

Understanding Command Modes

As you begin communication, you should understand the command modes. Just as there are different

levels of commands in the CLI, there are different modes for commands within AOS itself. Each command

mode enables the user to access more commands, and make more changes in the unit’s configuration.

The CLI has three command modes: Basic, Enable, and Global. The three command modes are organized

in a three-tiered hierarchy with Basic at the bottom, Enable in the middle, and Global at the top.

Basic Mode

Interaction with your unit begins at the Basic mode. The commands supported at this command tier are

limited, as is interaction with the unit itself. The Basic mode is to keep users without access to the higher

tiered commands from changing the preferred configurations of the unit. The following table describes the

Basic mode.

For more information on the Basic mode, please refer to Basic Mode Command Set on page 36.

Mode Access By... Mode Prompt Accessible Commands

Basic Beginning an AOS session > • Display system information

• Perform traceroute and ping

functions

• Open a Telnet session

Command Reference Guide Understanding Command Modes

Enable Mode

Enable mode is the mid-level tier in the command hierarchy, one step up from the Basic mode. ADTRAN

suggests that a password be required to access the Enable mode. Refer to the quick configuration guides

and quick start guides located online at https://supportforums.adtran.com for more information on

configuring a password.

From the Enable mode, you can access the configurations of your product, as well as handle how your unit

boots and runs, among other things. The following table describes the Enable mode.

For more information regarding the Enable command set, refer to the Enable Mode Command Set on page

83.

Global Mode

The Global mode is the highest level tier within AOS. The Global mode allows the user to make changes

regarding the entire product system. All of your system’s configurations are accessed through the Global

mode. From this level, you can access not only line configurations, router configurations, and interface

configurations, but also any other configurations or parameters on your system. The following table

describes the Global mode.

For more information on the Global mode, refer to Global Configuration Mode Command Set on page 852.

Mode Access By.... Mode Prompt Accessible Commands

Enable Entering enable while in the

Basic mode as follows:

>enable

# • Manage the startup and running

configurations

• Use the debug commands

• Enter any of the configuration modes

Mode Access By... Mode Prompt Accessible Commands

Global Entering config while at the

Enable mode as follows:

>enable

#config

(config)# • Set the system’s Enable-level

password(s)

• Configure the system global IP

parameters

• Configure the SNMP parameters

• Enter any of the configuration modes

Command Reference Guide Understanding Configurations

Understanding Configurations

Configurations are the means by which you set up your unit and system according to your personal

requirements and preferences. You must configure your unit to work within your network, based on your

hardware and communication systems.

All configurations are accessed through the Global Configuration mode. By typing in config at the Enable

mode prompt, you will be ready to specify the configuration you want to access.

For each configuration, enter the word or phrase that correlates with the system you are configuring. There

are different command sets for each type of configuration. These command sets are detailed in the

following section.

Configuration Command Sets

The configuration command sets are broken down into categories of similar functions. For example, all

commands dealing with configuring the line interface are grouped together, as are configuration

commands dealing with your hardware, commands dealing with your virtual network, and so on. The

following sections deal with each category of command sets. For a complete list of command sets and their

reference pages, refer to Command Descriptions on page 23.

Line Interface Command Sets

The line interface commands deal specifically with the way in which you communicate with your device.

The first time you connect with your unit, you must use the CONSOLE port in the rear of the unit, but

connections thereafter can be set up via the CONSOLE port, a terminal interface, or by Telnet. The line

interface command sets allow you to configure each method of connection to your preferences.

The following table gives an example of the line interface command set. For a more detailed description,

refer to Command Descriptions on page 23.

Command

Set

Accessed By... Sample Prompt With This Set You Can...

Line Interface Specifying a line (console,

Telnet, SSH) at the Global

Configuration mode prompt

as follows:

>enable

#config

(config)#line console 0

(config-con0)# • Configure the console or terminal

settings (data rate, login password,

etc.)

• Create Telnet logins and specify their

parameters (login password, etc.)

Command Reference Guide Configuration Command Sets

Physical Interface Command Sets

The physical interface commands of your unit deal with the medium over which your data is actually

transmitted and the physical hardware associated with your unit. Included in the physical interfaces are

Ethernet cables, serial interfaces, T1 cables, etc. These configurations must be set up to work with the type

of network you have.

The following table describes the physical interface command sets. For a more detailed description of the

physical interface command sets, please refer to Command Descriptions on page 23.

Virtual Interface Command Sets

The virtual interface is similar to the physical interface in function, except that it deals with your virtual

network. In essence, as your physical interfaces deal with your actual physical connections, virtual

interfaces deal with how your information is transmitted over those physical connections. Virtual

interfaces deal with your networking through protocols, such as ATM, Frame Relay, high level data link

control (HDLC), PPP, VLAN, etc. The virtual interface commands allow you to fully integrate your unit

into your existing networking setup.

The following table gives an example of the virtual interface command set. For more information on

virtual interfaces, refer to Command Descriptions on page 23.

Command

Set

Accessed By... Sample Prompt With This Set You Can...

Physical

Interface

Specifying an interface at

the Global Configuration

mode prompt as follows:

>enable

#config

(config)#interface adsl 0/1

(config-adsl0/1)# • Configure the parameters of your

physical connections

• Configure your physical network

Command

Set

Accessed By... Sample Prompt With This Set You Can...

Virtual

Interface

Specifying an interface at

the Global Configuration

mode prompt as follows:

>enable

#config

(config)#interface

frame-relay 1

(config-fr 1)# • Determine the parameters of

information flow

• Configure your unit’s methods for

communicating with other devices

Command Reference Guide Configuration Command Sets

Wireless Interface Command Sets

The wireless interface is similar to both the physical and virtual interfaces in function, except that it deals

with your wireless network. Wireless interfaces allow the configuration of wireless access points (APs),

access point radios, and virtual access points (VAPs).

The following table gives an example of the wireless interface command set. For more information on

wireless interfaces, refer to Command Descriptions on page 23.

Routing Command Sets

The routing command sets for the product serve two functions. Routing commands not only address the

manner in which your unit routes and disseminates information, but they also provide an additional level of

security for your network. Routing commands include parameters, such as AS path list, community list,

and network monitoring, and they determine whether your unit routes via Routing Information Protocol

(RIP), open shortest path first (OSPF), or protocol-independent multicast (PIM) sparse.

The following table gives an example of the routing command sets. For a complete list of routing

commands, refer to the Command Descriptions on page 23.

Command Set Accessed By... Sample Prompt With This Set You Can...

Wireless

Interface

Specifying a wireless

interface at the Global

Configuration mode prompt

as follows:

>enable

#config

(config)#interface dot11ap 1

(config-dot11ap

1)#

• Configure your unit’s wireless

parameters (radios, APs, and

VAPs)

• Configure how your wireless

network will integrate with your

wired network

Command Set Accessed By... Sample Prompt With This Set You Can...

Routing Specifying which routing

parameter you wish to set at

the Global Configuration mode

prompt as follows:

>enable

#config

(config)#router ospf

(config-ospf)# • Determine which devices are

compatible with your network

• Determine how your unit

routes traffic and information

Command Reference Guide Configuration Command Sets

Security and Services Command Sets

The security and services command sets provide methods for you to configure additional security for your

unit, as well as determine the types of services you want your unit to perform. Included in these command

sets are quality of service (QoS) maps, Dynamic Host Configuration Protocol (DHCP) pools, and route

map configurations.

The following table includes an example of the security and services commands. For a more detailed

listing of the command sets, refer to Command Descriptions on page 23.

Voice Group Command Sets

Voice group command sets deal with the configuration and organization of voice groups within your

network. The commands allow you to configure voice features as part of a collective group, and to define

how these groups behave.

The following table gives a small example of the voice group command sets. For a more detailed

description, refer to Command Descriptions on page 23.

Command

Set

Accessed By... Sample Prompt With This Set You Can...

Security and

Services

Specifying the service you

would like to perform at the

Global Configuration mode

prompt as follows:

>enable

#config

(config)#aaa group server

radius myServer

(config-sg-radius)# • Map the quality of a variety of

services

• Set the parameters for the DHCP

• Configure the unit’s route map

Command Set Accessed By... Sample Prompt With This Set You Can...

Voice Groups Specifying the voice group you

would like to configure at the

Global Configuration mode

prompt as follows:

>enable

#config

(config)#voice ring-group

1234

(config-1234)# • Set parameters for ring groups,

operator groups, trunk groups,

paging groups, and more

• Specify the behaviors and

permissions of voice groups,

as well as define the members

of the groups

Command Reference Guide Configuration Command Sets

Voice Trunks Command Sets

Voice trunks command sets deal with the configuration of voice trunks within your network. The

commands allow you to configure various trunks and specify how these trunks function.

The following table gives a small example of the voice trunks command sets. For a more detailed

description, refer to Command Descriptions on page 23.

Voice Accounts Command Sets

Voice accounts command sets deal with the configuration and organization of differing accounts within

your voice network. The commands allow you to configure such items as user permissions, voice line

behaviors, and voice loopback services.

The following table gives a small example of the voice accounts command sets. For a more detailed

description, refer to Command Descriptions on page 23.

Command Set Accessed By... Sample Prompt With This Set You Can...

Voice Trunks Specifying the voice trunk type

you would like to configure at

the Global Configuration mode

prompt as follows:

>enable

#config

(config)#voice trunk t01

(config-t01)# • Set parameters for analog

trunks, T1 trunks, Session

Initiation Protocol (SIP) trunks,

and more

• Specify the behaviors and

permissions of these trunks

Command Set Accessed By... Sample Prompt With This Set You Can...

Voice Accounts Specifying the voice account

you would like to configure at

the Global Configuration mode

prompt as follows:

>enable

#config

(config)#voice user 4444

(config-4444)# • Set parameters for user

accounts, line accounts, and

loopback accounts

• Specify the behaviors and

permissions of these accounts

within the voice network

Command Reference Guide Configuration Command Sets

Voice Services Command Sets

Voice services command sets deal with the configuration and implementation of various voice services

within your network. The commands allow you to configure voice features to improve network operation,

set voicemail parameters, and monitor your voice network.

The following table gives a small example of the voice services command sets. For a more detailed

description, refer to Command Descriptions on page 23.

Virtual Private Network (VPN) Parameter Command Sets

The virtual private network (VPN) parameter command sets deal with the encryption and security on your

private network. To allow you the utmost in security, the VPN parameter commands allow you to

configure how your unit will behave as it communicates with other devices. VPN command sets allow you

to configure Internet key exchange (IKE) parameters, crypto parameters, and certificate parameters.

The following table gives an example of the VPN parameter commands. For a more detailed listing of

commands, refer to Command Descriptions on page 23.

Command Set Accessed By... Sample Prompt With This Set You Can...

Voice Services Specifying the voice service

you would like to configure at

the Global Configuration mode

prompt as follows:

>enable

#config

(config)#voice autoattendant

Example 1212

(config-aa1212)# • Set parameters for class of

service (CoS) on the voice

network, configure voicemail

and auto attendant, use voice

quality monitoring reporters,

and more

• Specify the behaviors and

permissions of voice features

within the network

Command Set Accessed By... Sample Prompt With This Set You Can...

VPN Parameters Specifying which parameter you

wish to set at the Global

Configuration mode prompt as

follows:

>enable

#config

(config)#crypto ca certificate

chain MyProfile

(config-cert-

chain)#

• Determine how your unit

authenticates communication

• Set the parameters for keeping

your unit secure

Command Reference Guide Using CLI Shortcuts

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

startup-config

When you are ready to save the changes made to the configuration, enter this

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

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

%Unrecognized command

The command may not be valid in the current command mode, or you

may not have entered enough correct characters for the command to be

recognized. Try using the ? command to determine your error. Refer to

Using CLI Shortcuts on page 20 for more information.

%Invalid or incomplete

command

The command may not be valid in the current command mode, or you

may not have entered all of the pertinent information required to make

the command valid. Try using the ? command to determine your error.

Refer to Using CLI Shortcuts on page 20 for more information.

%Invalid input detected at

“^” marker

The error in command entry is located where the caret (^) mark appears.

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 information on a group of commands within a particular command set, use the linked

references given below:

Basic Mode Command Set on page 36

Common Commands on page 65

Enable Mode Command Set on page 83

Global Configuration Mode Command Set on page 852

Line Interface Command Sets

Line (Console) Interface Command Set on page 1464

Line (SSH) Interface Command Set on page 1481

Line (Telnet) Interface Command Set on page 1498

Physical Interface Command Sets

ADSL Interface Command Set on page 1517

BRI Interface Command Set on page 1525

Cellular Interface Command Set on page 1537

DDS Interface Command Set on page 1556

DSX-1 Interface Command Set on page 1565

E1 Interface Command Set on page 1576

Ethernet Interface Command Set on page 1594

FDL Interface Command Set on page 1741

FXO Interface Command Set on page 1748

FXS Interface Command Set on page 1759

G.703 Interface Command Set on page 1778

HSSI Interface Command Set on page 1785

MEF Ethernet Interface on page 1790

Modem Interface Command Set on page 1859

PRI Interface Command Set on page 1865

Serial Interface Command Set on page 1884

SHDSL Interface Command Set on page 1894

T1 Interface Command Set on page 1913

T3 Interface Command Set on page 1932

Command Reference Guide Command Descriptions

Virtual Interface Command Sets

ATM Interface Command Set on page 1944

ATM Subinterface Command Set on page 1949

BVI Interface Command Set on page 2042

Demand Interface Command Set on page 2086

EFM Group Command Set on page 2166

Frame Relay Interface Command Set on page 2171

Frame Relay Subinterface Command Set on page 2193

HDLC Interface Command Set on page 2308

Loopback Interface Command Set on page 2389

Port Channel Interface Command Set on page 2438

PPP Interface Command Set on page 2463

Tunnel Interface Command Set on page 2588

VLAN Command Set on page 2690

VLAN Database Command Set on page 2695

VLAN Interface Command Set on page 2704

Wireless Interface Command Sets

AP Interface Command Set on page 2797

Radio Interface Command Set on page 2813

VAP Interface Command Set on page 2837

Routing Command Sets

AS Path List Command Set on page 2855

BGP Command Set on page 2858

BGP Neighbor Command Set on page 2878

BGP Address Family Command Set on page 2895

BGP AF Neighbor Command Set on page 2916

Community List Command Set on page 2935

Network Monitor Probe Command Set on page 2938

Network Monitor Probe Responder Command Set on page 2966

Network Monitor Track Command Set on page 2977

Router (OSPF) Command Set on page 2994

Router (PIM Sparse) Command Set on page 3015

Router (RIP) Command Set on page 3020

Security and Services Command Sets

Desktop Auditing Local Policy Command Set on page 3037

DHCPv4 Pool Command Set on page 3044

Command Reference Guide Command Descriptions

DHCPv6 Pool Command Set on page 3067

DHCPv6 Server Pool Host Command Set on page 3087

Ethernet OAM CFM Command Set on page 3091

Hardware ACL and Access Map Command Set on page 3109

IPv4 Access Control List Command Set on page 3126

IPv4 Access Control Policy Command Set on page 3144

IPv6 Access Control List Command Set on page 3162

IPv6 Access Control Policy Command Set on page 3192

Mail Agent Command Set on page 3201

MEF EVC Command Set on page 3213

MEF EVC Map Command Set on page 3217

MEF Policer Policy Command Set on page 3223

MGCP Command Set on page 3229

Packet Capture Command Set on page 3259

Quality of Service Map Command Set on page 3269

RADIUS Group Command Set on page 3296

Route Map Command Set on page 3300

Security Monitor Command Set on page 3333

SIP HMR Command Set on page 3338

TACACS+ Group Command Set on page 3361

Top Traffic Command Set on page 3364

Voice Groups Command Sets

Voice Call Pickup Group Command Set on page 3372

Voice ISDN Group Command Set on page 3375

Voice Operator Ring Group Command Set on page 3384

Voice Paging Group Command Set on page 3402

Voice Ring Group Command Set on page 3407

Voice Trunk Group Command Set on page 3430

Voice Trunks Command Sets

Voice Analog Trunk Command Set on page 3443

Voice ISDN Trunk Command Set on page 3493

Voice SIP Trunk Command Set on page 3532

Voice T1 Trunk Command Set on page 3603

Command Reference Guide Command Descriptions

Voice Accounts Command Sets

Voice Line Account Command Set on page 3656

Voice Loopback Account Command Set on page 3679

Voice User Account Command Set on page 3697

Voice Services Command Sets

Voice Auto Attendant Command Set on page 3778

Voice Call Queuing Command Set on page 3781

Voice Coverage Command Set on page 3799

Voice CODEC List Command Set on page 3803

Voice CoS Command Set on page 3807

FindMe-FollowMe Action Script Command Set on page 3844

FindMe-FollowMe Contact Group Command Set on page 3852

Voice Music on Hold Command Set on page 3862

Proxy User Template Command Set on page 3865

Voicemail CoS Command Set on page 3876

VQM Reporter Command Set on page 3885

VPN Parameter Command Sets

CA Profile Command Set on page 3899

Certificate Command Set on page 3911

Crypto Map IKE Command Set on page 3916

Crypto Map Manual Command Set on page 3933

IKE Client Command Set on page 3943

IKE Policy Attributes Command Set on page 3948

IKE Policy Command Set on page 3955

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

(config-adsl 0/1)#

page 1517

BRI (config)#interface bri 1/2

(config-bri 1/2)#

page 1525

Cellular (config)#interface cellular 1/1

(config-cellular 1/1)#

page 1537

DDS (config)#interface dds 1/1

(config-dds 1/1)#

page 1556

DSX-1 (config)#interface t1 1/2

(config-t1 1/2)#

page 1565

E1 (config)#interface e1 1/1

(config-e1 1/1)#

page 1576

Ethernet (config)#interface ethernet 0/1

(config-eth 0/1)#

page 1594

Ethernet Subinterface (config)#interface ethernet 0/1.1

(config-eth 0/1.1)#

page 1594

Gigabit Ethernet (config)#interface gigabit-ethernet 0/3

(config-giga-eth 0/3)#

page 1594

Gigabit Switchport (config)#interface gigabit-switchport 0/3

(config-giga-swx 0/3)#

page 1594

Switchport (config)#interface switchport 0/1

(config-swx 0/1)#

page 1595

Range of Ethernet

Interfaces

(in this example, eth 0/1

through eth 0/8)

(config)#interface range ethernet 0/1, 0/8

(config-eth 0/1, 0/8)#

page 1595

FDL (config)#interface fdl 1/1

(config-fdl 1/1)#

page 1741

FXO (config)#interface fxo 0/1

(config-fxo 0/1)#

page 1748

FXS (config)#interface fxs 2/1

(config-fxs 2/1)#

page 1759

G.703 (config)#interface e1 1/2

(config-e1 1/2)#

page 1778

HSSI (config)#interface hssi 1/1

(config-hssi 1/1)#

page 1785

MEF Ethernet (config)#interface mef-ethernet 0/1.1

(config-mef-ethernet 0/1.1)#

page 1790

Command Reference Guide Virtual Interface Command Set Access Paths

Virtual Interface Command Set Access Paths

Modem (config)#interface modem 1/2

(config-modem 1/2)#

page 1859

PRI (config)#interface pri 2

(config-pri 2)#

page 1865

Serial (config)#interface serial 1/1

(config-ser 1/1)#

page 1884

SHDSL (config)#interface shdsl 1/1

(config-shdsl 1/1)#

page 1894

T1 (config)#interface t1 1/1

(config-t1 1/1)#

page 1913

T3 (config)#interface t3 1/1

(config-t3 1/1)#

page 1932

Command Set Sample Access Path For Full Command

List, See...

ATM (config)#interface atm 1

(config-atm 1)#

page 1944

ATM Subinterface (config)#interface atm 1.1

(config-atm 1.1)#

page 1949

BVI Interface (config)#bridge irb

(config)#interface bvi 1

(config-bvi 1)#

page 2042

Demand (config)#interface demand 1

(config-demand 1)#

page 2086

EFM Group (config)#interface efm-group 1

(config-efm-group-1)#

page 2166

Frame Relay (config)#interface frame-relay 1

(config-fr 1)#

page 2171

Frame Relay Subinterface (config)#interface frame-relay 1.16

(config-fr 1.16)#

page 2193

HDLC (config)#interface hdlc 1

(config-hdlc 1)#

page 2308

Loopback (config)#interface loopback 1

(config-loop 1)#

page 2389

Port Channel (config)#interface port-channel 1

(config-p-chan1)#

page 2438

PPP (config)#interface ppp 1

(config-ppp 1)#

page 2463

Tunnel (config)#interface tunnel 1 gre ip

(config-tunnel 1)#

page 2588

Command Set Sample Access Path For Full Command

List, See...

Command Reference Guide Wireless Interface Command Set Access Paths

Wireless Interface Command Set Access Paths

Routing Protocol Command Set Access Paths

VLAN Configuration (config)#vlan 1

(config-vlan 1)#

page 2690

VLAN Database (config)#vlan database

(vlan)#

page 2695

VLAN Interface (config)#interface vlan 1

(config-interface-vlan 1)#

page 2704

Command Set Sample Access Path For Full Command

List, See...

Access Point (config)#interface dot11ap 1

(config-dot11ap 1)#

page 2797

Radio (config)#interface dot11ap 1/1

(config-dot11ap 1/1-bg)#

page 2813

Virtual Access Point (config)#interface dot11ap 1/1.1

(config-dot11ap 1/1.1-bg)#

page 2837

Command Set Sample Access Path For Full Command

List, See...

AS Path List (config)#ip as-path-list MyList

(config-as-path-list)#

page 2855

BGP (config)#router bgp 1

(config-bgp)#

page 2858

BGP Neighbor (config-bgp)#neighbor 192.22.15.101

(config-bgp-neighbor)#

page 2878

BGP Address Family (config-bgp)#address-family ipv4

(config-bgp-ipv4)#

page 2895

BGP Address Family

Neighbor

(config-bgp-ipv4)#neighbor 192.22.15.101

(config-bgp-ipv4-neighbor)#

page 2916

Community List (config)#ip community-list listname

(config-comm-list)#

page 2935

Network Monitor Probe (config)#probe probe1 icmp-echo

(config-probe-probe1)#

page 2938

Network Monitor Probe

Responder

(config)#probe responder twamp

(config-responder-twamp)#

page 2966

Network Monitor Track (config)#track track1

(config-track-track1)#

page 2977

OSPF (config)#router ospf

(config-ospf)#

page 2994

Command Set Sample Access Path For Full Command

List, See...

Command Reference Guide Security and Services Command Set Access Paths

Security and Services Command Set Access Paths

PIM Sparse (config)#router pim-sparse

(config-pim-sparse)#

page 3015

RIP (config)#router rip

(config-rip)#

page 3020

Command Set Sample Access Path For Full Command

List, See...

Desktop Auditing Local

Policy

(config)#desktop-auditing local-policy

(desktop-audit-policy)#

page 3037

DHCP Pool (config)#ip dhcp pool MyPool

(config-dhcp)#

page 3044

DHCPv6 Pool (config)#ipv6 dhcp pool MyPool

(config-dhcpv6)#

page 3067

DHCPv6 Server Pool (config)#ipv6 dhcp pool MYPOOL

(config-dhcpv6)#host client-identifier F2A4C9

(config-dhcpv6-host)#

page 3087

Ethernet OAM CFM (config)#ethernet cfm domain domain1 level 6

(config-ecfm-domain)#

page 3091

Hardware ACL and

Access Map

(config)#ip hw-access-list extended Trusted

(config-ext-ip-hw-nacl)#

page 3109

IPv4 Access Control List (config)#ip access-list standard MATCHALL

(config-std-nacl)#

page 3126

IPv4 Access Control

Policy

(config)#ip policy-class PRIVATE

(config-policy-class)#

page 3144

IPv6 Access Control List (config)#ipv6 access-list standard

MATCHALLv6

(config-std-nacl)#

page 3162

IPv6 Access Control

Policy

(config)#ipv6 policy-class PRIVATEv6

(config-policy-class)#

page 3192

Mail Agent (config)#mail-client myagent

(config-mail-client-myagent)#

page 3201

MEF EVC (config)#mef evc 1

(config-evc-1)#

page 3213

MEF EVC Map (config)#mef evc-map 1

(config-evc-map-1)#

page 3217

MEF Policer (config)#mef evc 1

(config-policer-1)#

page 3223

MGCP Endpoint (config)#voice mgcp-endpoint 1

(config-mgcp-1)#

page 3229

Command Set Sample Access Path For Full Command

List, See...

Command Reference Guide Voice Groups Command Set Access Paths

Voice Groups Command Set Access Paths

Voice Trunks Command Set Access Paths

Packet Capture (config)#packet-capture 1CAPTURE standard

(config-packet-capture-1CAPTURE)#

page 3259

QoS Map (config)#qos map VOICEMAP 10

(config-qos-map)#

page 3269

RADIUS Group (config)#aaa group server radius myServers

(config-sg-radius)#

page 3296

Route Map (config)#route-map MyMap permit 100

(config-route-map)#

page 3300

Security Monitor (config)#ip security monitor

(config-secmon)#

page 3333

SIP HMR (config)#sip hmr policy POLICY1

(config-policy-POLICY1)#

page 3338

TACACS+ Group (config)#aaa group server tacacs+ TEST_

GROUP

(config-sg-tacacs+)#

page 3361

Top Traffic (config)#ip flow top-talkers

(config-top-talkers)#

page 3364

Command Set Sample Access Path For Full Command

List, See...

Voice Call Pickup Group (config)#voice pickup-group Sales

(config-Sales)#

page 3372

Voice ISDN Group (config)#isdn-group 1

(config-isdn-group 1)#

page 3375

Voice Operator Group (config)#voice operator-group

(config-operator-group)#

page 3384

Voice Paging Group (config)#voice paging-group 8956

(config-8956)#

page 3402

Voice Ring Group (config)#voice ring-group 1234

(config-1234)#

page 3407

Voice Trunk Group (config)#voice grouped-trunk TestGroup

(config-TestGroup)#

page 3430

Command Set Sample Access Path For Full Command

List, See...

Voice Analog Trunk DPT (config)#voice trunk t01 type analog

supervision dpt

(config-t01)#

page 3443

Command Set Sample Access Path For Full Command

List, See...

Command Reference Guide Voice Accounts Command Set Access Paths

Voice Accounts Command Set Access Paths

Voice Analog Trunk

Ground Start (GS)

(config)#voice trunk t01 type analog

supervision ground-start

(config-t01)#

page 3443

Voice Analog Trunk Loop

Start (LS)

(config)#voice trunk t01 type analog

supervision loop-start

(config-t01)#

page 3443

Voice ISDN Trunk (config)#voice trunk t01 type isdn

(config-t01)#

page 3493

Voice SIP Trunk (config)#voice trunk t01 type sip

(config-t01)#

page 3532

Voice T1 Trunk Feature

Group D

(config)#voice trunk t01 type t1-rbs

supervision fgd role user

(config-t01)#

page 3603

Voice Trunk T1 Ground

Start (GS)

(config)#voice trunk t01 type t1-rbs

supervision ground-start role user

(config-t01)#

page 3603

Voice T1 Trunk Immediate (config)#voice trunk t01 type t1-rbs

supervision immediate role [network | user]

(config-t01)#

page 3603

Voice T1 Trunk (config)#voice trunk t01

(config-t01)#

page 3603

Voice T1 Trunk Loop Start

(LS)

(config)#voice trunk t01 type t1-rbs

supervision loop-start role user

(config-t01)#

page 3603

Voice T1 Trunk Wink Role (config)#voice trunk t01 type t1-rbs

supervision wink role [network | user]

(config-t01)#

page 3603

Command Set Sample Access Path For Full Command

List, See...

Voice Line Account (config)#voice line sales

(config-sales)#

page 3656

Voice Loopback Account (config)#voice loopback 5555

(config-LB-5555)#

page 3679

Voice User Account (config)#voice user 4444

(config-4444)#

page 3697

Command Set Sample Access Path For Full Command

List, See...

Command Reference Guide Voice Services Command Set Access Paths

Voice Services Command Set Access Paths

VPN Parameter Command Set Access Paths

Command Set Sample Access Path For Full Command

List, See...

Voice Auto Attendant (config)#voice autoattendant Example 1212

(config-aa1212)#

page 3778

Voice Call Queuing (config)#voice queue 6407

(config-6407)#

page 3781

Voice Coverage List (config)#voice coverage Evening

(config-gch)#

page 3799

Voice CODEC List (config)#voice codec-list List1

(config-codec)#

page 3803

Voice CoS (config)#voice class-of-service set1

(config-cos-set1)#

page 3807

FindMe-FollowMe Action

Script

(config)#voice user 4444

(config-4444)#script Business

(config-4444-sc-Business)#

page 3844

FindMe-FollowMe Contact

Group

(config)#voice user 4444

(config-4444)#contact-group 1

(config-4444-cg-1)#

page 3852

Music on Hold (config)#voice music-on-hold player moh1

(config-moh1)#

page 3862

Proxy User Template (config)#ip sip proxy user-template Set1

(config-template-Set1)#

page 3865

Voicemail CoS (config)#voice mail class-of-service class1

(config-vm-class1)#

page 3876

Voice Quality Monitoring

Reporter

(config)#ip rtp quality-monitoring reporter

Reporter1

(config-rtp-reporter-Reporter1)#

page 3885

Command Set Sample Access Path For Full Command

List, See...

CA Profile (config)#crypto ca profile MyProfile

(ca-profile)#

page 3899

Certificate (config)#crypto ca certificate chain MyProfile

(config-cert-chain)#

page 3911

Crypto Map IKE (config)#crypto map Map-Name 10 ipsec-ike

(config-crypto-map)#

page 3916

Crypto Map Manual (config)#crypto map Map-Name 10

ipsec-manual

(config-crypto-map)#

page 3933

Command Reference Guide VPN Parameter Command Set Access Paths

IKE Client (config)#crypto ike client configuration pool

ConfigPool1

(config-ike-client-pool)#

page 3943

IKE Policy Attributes (config)#crypto ike policy 1

(config-ike)#attribute 10

(config-ike-attribute)#

page 3948

IKE Policy (config)#crypto ike policy 1

(config-ike)#

page 3955

Command Set Sample Access Path For Full Command

List, See...

Command Reference Guide

SYSTEM COMMAND SETS

This section includes the following command sets:

•Basic Mode Command Set on page 36

•Common Commands on page 65

•Enable Mode Command Set on page 83

•Global Configuration Mode Command Set on page 852

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 73

All other commands for this command set are described in this section in alphabetical order.

enable on page 37

logout on page 38

ping on page 39

ping ethernet on page 43

ping ipv6 on page 46

ping stack-member <number> on page 49

ping twamp on page 50

show clock on page 53

show snmp on page 54

show version on page 55

telnet <ip address> on page 56

traceroute on page 58

traceroute ethernet on page 60

traceroute ipv6 on page 63

Command Reference Guide Basic Mode Command Set

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 arp on page 415 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 942 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: ******

Command Reference Guide Basic Mode Command Set

logout

Use the logout command to terminate the current session and return to the login screen.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example shows the logout command being executed in the Basic mode:

>logout

Session now available

Press RETURN to get started.

Command Reference Guide Basic Mode Command Set

ping

Use the ping command (at the Enable mode prompt) to verify IPv4 network connectivity. For information

on how to verify IPv6 network connectivity, refer to ping ipv6 on page 46. Variations of this command

include:

ping

ping [ip] <ipv4 address | hostname>

ping [ip] <ipv4 address | hostname> <interface>

ping [ip] <ipv4 address | hostname> data <string>

ping [ip] <ipv4 address | hostname> repeat <number>

ping [ip] <ipv4 address | hostname> size <value>

ping [ip] <ipv4 address | hostname> source <ipv4 address>

ping [ip] <ipv4 address | hostname> timeout <value>

ping [ip] <ipv4 address | hostname> verbose

ping [ip] <ipv4 address | hostname> wait <interval>

ping [ip] vrf <name> <ipv4 address | hostname>

ping [ip] vrf <name> <ipv4 address | hostname> <interface>

ping [ip] vrf <name> <ipv4 address | hostname> data <string>

ping [ip] vrf <name> <ipv4 address | hostname> repeat <number>

ping [ip] vrf <name> <ipv4 address | hostname> size <value>

ping [ip] vrf <name> <ipv4 address | hostname> source <ipv4 address>

ping [ip] vrf <name> <ipv4 address | hostname> timeout <value>

ping [ip] vrf <name> <ipv4 address | hostname> verbose

ping [ip] vrf <name> <ipv4 address | hostname> wait <interval>

Syntax Description

ip Optional. Specifies an IPv4 ping.

<interface> Optional. Specifies the egress interface when pinging an IPv4 address.

Interfaces are specified in the <interface type> <slot/port | interface id>

format. For example, for an Ethernet interface, use eth 0/1. Type ping

<ipv4 address | hostname> ? to display a list of valid interfaces.

<ipv4 address | hostname> Optional. Specifies the IPv4 address or host name of the system to ping.

IPv4 addresses should be expressed in dotted decimal notation (for

example, 10.10.10.1).

Entering the ping command with no specified

Internet Protocol version 4 (IPv4) 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.

After specifying the target IPv4 address to ping, the other parameters can be entered in

any order. Use the ? after each specified subcommand for a valid list of arguments and

settings.

Command Reference Guide Basic Mode Command Set

repeat <number> Optional. Specifies the number of loopback messages to be sent. Range is

1 to 1024.

size <value> Optional. Specifies the datagram size (in bytes) of the ping packet. Valid

range is 1 to 1448 bytes.

source <ipv4 address> Optional. Specifies the IPv4 address to use as the source address in the

ECHO_REQ (or interface) packets. The source IPv4 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 IPv4 address exists.

wait <interval> Optional. Specifies a minimum time to wait between sending test packets.

Valid range is 100 to 60000 milliseconds.

Default Values

By default, the data pattern is set to abcd.

By default, the repeat is set to 5.

By default, the size value is set to 100 bytes.

By default, the timeout value is set to 2 seconds.

By default, the wait value is set to 100 milliseconds.

Command History

Release 1.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

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.

Release A4.01 Command was expanded to return the wait parameter.

Release 18.3 Command was expanded to include the optional ip and <interface>

parameters.

Functional Notes

The ping command can be issued from both the Basic and Enable modes.

The ping command helps diagnose basic IPv4 network connectivity using the Packet Internet Groper

program to repeatedly bounce Internet Control Message Protocol version 4 (ICMPv4) ECHO_REQ

packets off a system (using a specified IPv4 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.

Command Reference Guide Basic Mode Command Set

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

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:192.168.0.30

Repeat count [5]:5

Datagram Size [100]:100

Timeout in seconds [2]:2

Wait interval in milliseconds [100]:100

Extended Commands? [n]:n

Type CTRL+C to abort.

Legend: '!' = Success, '?' = Unknown host, '$' = Invalid host address

'*' = Request timed out, '-' = Destination host unreachable

Command Reference Guide Basic Mode Command Set

'x' = TTL expired in transit, 'e' = Unknown error

Sending 5, 100-byte ICMP Echos to 192.168.0.30, timeout is 2 seconds:

!!!!!

Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/2 ms

Command Reference Guide Basic Mode Command Set

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.

Variations of this command include:

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> mep <mep id>

ping ethernet <target-mac-address | target-mep-id> priority <priority>

ping ethernet <target-mac-address | target-mep-id> repeat <number>

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

ping ethernet <target-mac-address | target-mep-id> wait <interval>

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

transmitting MEP belongs.

After specifying the target for the loopback messages, the other parameters can be entered

in any order.

Command Reference Guide Basic Mode Command Set

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.

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.

repeat <number> Optional. Specifies the number of loopback messages to be sent.

Range is 1 to 1024.

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.

wait <interval> Optional. Specifies a minimum time to wait between sending

loopback messages. Valid range is 100 to 60000 milliseconds.

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

Release 17.4 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface and the wait and repeat parameters.

Command Reference Guide Basic Mode Command Set

Functional Notes

The ping ethernet command can be issued from both the Basic and Enable modes.

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.

For more information regarding Ethernet OAM CFM and its operation on AOS products, refer to the

Ethernet OAM CFM in AOS configuration guide available online at https://supportforums.adtran.com

(article number 3013).

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:

>ping ethernet 201 domain Domain1 association MA1

Type CTRL+C to abort.

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

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

Command Reference Guide Basic Mode Command Set

ping ipv6

Use the ping ipv6 command (at the Basic mode prompt) to verify IPv6 network connectivity. For

information on how to verify IPv4 network connectivity, refer to ping on page 39. Variations of this

command include:

ping ipv6 <ipv6 address>

ping ipv6 <ipv6 address> <interface>

ping ipv6 <ipv6 address> data <string>

ping ipv6 <ipv6 address> destination-option

ping ipv6 <ipv6 address> hop-by-hop-option

ping ipv6 <ipv6 address> repeat <number>

ping ipv6 <ipv6 address> size <value>

ping ipv6 <ipv6 address> source <ipv6 address>

ping ipv6 <ipv6 address> timeout <value>

ping ipv6 <ipv6 address> verbose

ping ipv6 <ipv6 address> wait <interval>

ping ipv6 vrf <name> <ipv6 address>

ping ipv6 vrf <name> <ipv6 address> <interface>

ping ipv6 vrf <name> <ipv6 address> data <string>

ping ipv6 vrf <name> <ipv6 address> destination-option

ping ipv6 vrf <name> <ipv6 address> hop-by-hop-option

ping ipv6 vrf <name> <ipv6 address> repeat <interval>

ping ipv6 vrf <name> <ipv6 address> size <value>

ping ipv6 vrf <name> <ipv6 address> source <ipv6 address>

ping ipv6 vrf <name> <ipv6 address> timeout <value>

ping ipv6 vrf <name> <ipv6 address> verbose

ping ipv6 vrf <name> <ipv6 address> wait <interval>

Syntax Description

<interface> Specifies the egress interface when pinging an IPv6 link-local address (any

address that has the prefix FE80::/64). Interfaces are specified in the

<interface type> <slot/port | interface id> format. For example, for an

Ethernet interface, use eth 0/1. Type ping ipv6 <ipv6 address> ? to display

a list of valid interfaces. This variable is mandatory when pinging a link-local

address. This variable is ignored when using a non-link-local address.

<ipv6 address> Specifies the IPv6 address of the system to ping. IPv6 addresses should be

expressed in colon hexadecimal format (X:X:X:X::X). For example,

2001:DB8:1::1.

Entering the ping ipv6 command using a link-local

destination address prompts the user for an egress interface.

After specifying the target IPv6 address to ping, the other parameters can be entered in

any order. Use the ? after each specified subcommand for a valid list of arguments and

settings.

Command Reference Guide Basic Mode Command Set

data <string> Optional. Specifies an alphanumerical string to use (the ASCII equivalent)

as the data pattern in the ICMPv6 ECHO_REQ packets.

destination-option Optional. Includes the destination option in the ICMPv6 ECHO_REQ

packets.

hop-by-hop-option Optional. Includes the hop-by-hop option in the ICMPv6 ECHO_REQ

packets. This typically causes intermediate routers to process switch the

packets, potentially detecting switching issues in these devices.

repeat <number> Optional. Specifies the number of loopback messages to be sent. Range is

1 to 1024.

size <value> Optional. Specifies the datagram size (in bytes) of the ping packet. Valid

range is 1 to 1448 bytes.

source <ipv6 address> Optional. Specifies the IPv6 address to use as the source address in the

ICMPv6 ECHO_REQ (or interface) packets. IPv6 addresses should be

expressed in colon hexadecimal format (X:X:X:X::X). For example,

2001:DB8:1::1.

Entering the ping ipv6 command using a link-local

destination address prompts the user for an egress interface. The source

IPv6 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 IPv6 address exists.

wait <interval> Optional. Specifies a minimum time to wait between sending test packets.

Valid range is 100 to 60000 milliseconds.

Default Values

By default, the data pattern is set to abcd.

By default, the repeat is set to 5.

By default, the size value is set to 100 bytes.

By default, the timeout value is set to 2 seconds.

By default, the wait value is set to 100 milliseconds.

Command History

Release 18.1 Command was introduced.

Functional Notes

The ping ipv6 command can be issued from both the Basic and Enable modes.

The ping ipv6 command helps diagnose basic IPv6 network connectivity using the Packet Internet Groper

program to repeatedly bounce Internet Control Message Protocol version 6 (ICMPv6) ECHO_REQ

packets off a system (using a specified IPv6 address). AOS allows executing a standard ping ipv6 request

to a specified IPv6 address, or provides keywords to configure a more specific ping ipv6 configuration.

Command Reference Guide Basic Mode Command Set

The following is a list of output messages from the ping ipv6 command:

! Success

- Destination Host Unreachable

$ Invalid Host Address

x TTL Expired in Transit

? Unknown Host

* Request Timed out

e Unknown Error

B Packet too Big

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 example pings 2001:DB8:1A0::3 with 200 byte ICMPv6 ECHO_REQ packets:

>ping ipv6 2001:DB8:1A0::3 size 200

Type CTRL+C to abort.

Legend: '!' = Success, '?' = Unknown host, '$' = Invalid host address

'*' = Request timed out, '-' = Destination host unreachable

'x' = TTL expired in transit, 'e' = Unknown error

'B' = Packet too big

Sending 5, 200-byte ICMP Echos to 2001:DB8:1A0::3, timeout is 2 seconds:

!!!!!

Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/2 ms

Command Reference Guide Basic Mode Command Set

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

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

Functional Notes

The ping stack-member command can be issued from both the Basic and Enable modes.

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 example pings a member of the stack:

>ping stack-member 3

Type CTRL+C to abort.

Legend: '!' = Success, '?' = Unknown host, '$' = Invalid host address

'*' = Request timed out, '-' = Destination host unreachable

'x' = TTL expired in transit

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

Command Reference Guide Basic Mode Command Set

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

this command include:

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 pattern ascii <pattern>

ping twamp <ip address | hostname> data pattern hex <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>

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

ascii <pattern> Pads the packet with a user-specified ascii pattern.

hex <pattern> Pads the packet with a user-specified hex pattern.

random Pads the packet with random numbers.

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.

Command Reference Guide Basic Mode Command Set

zero Pads the packet with all zeros.

dscp <value> Optional. Specifies the differentiated services code point (DSCP) value.

Valid range is 0 to 63.

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.

Release A4.01 Command was expanded to include the ascii and hex pattern parameters.

Functional Notes

The ping twamp command can be issued from both the Basic and Enable modes.

Usage Examples

The following example executes a TWAMP ping:

>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

Command Reference Guide Basic Mode Command Set

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 --MORE--

Command Reference Guide Basic Mode Command Set

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

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

Command Reference Guide Basic Mode Command Set

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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following is an example output using the show snmp command for a system with SNMP disabled and

the default chassis and contact parameters:

>show snmp

Chassis: Chassis ID

Contact: Customer Service

0 Rx SNMP packets

0 Bad community names

0 Bad community uses

0 Bad versions

0 Silent drops

0 Proxy drops

0 ASN parse errors

Command Reference Guide Basic Mode Command Set

show version

Use the show version command to display the current AOS version information.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following is sample output from the show version command:

>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

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”

Command Reference Guide Basic Mode Command Set

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

addresses should be expressed in dotted decimal notation (for example,

10.10.10.1). IPv6 addresses should be expressed in colon hexadecimal

format (X:X:X:X::X). For example, 2001:DB8:1::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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 14.1 Command was expanded to specify the port number.

Release 16.1 Command was expanded to include the vrf parameter.

Functional Notes

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 example opens a Telnet session with a remote system (10.200.4.15):

>telnet 10.200.4.15

User Access Login:

Password:

Command Reference Guide Basic Mode Command Set

The following example opens a Telnet session with a remote system (10.200.4.15) on port 8010:

>telnet 10.200.4.15 port 8010

User Access Login:

Password:

Command Reference Guide Basic Mode Command Set

traceroute

Use the traceroute command to display the Internet Protocol version 4 (IPv4) routes a packet takes to

reach the specified destination. Variations of this command include:

traceroute

traceroute [ip] <ipv4 address | hostname>

traceroute [ip] <ipv4 address | hostname> <interface>

traceroute [ip] <ipv4 address | hostname> source <ipv4 address>

traceroute [ip] <ipv4 address | hostname> <interface> source <ipv4 address>

traceroute [ip] vrf <name> <ipv4 address | hostname>

traceroute [ip] vrf <name> <ipv4 address | hostname> <interface>

traceroute [ip] vrf <name> <ipv4 address | hostname> source <ipv4 address>

traceroute [ip] vrf <name> <ipv4 address | hostname> <interface> source <ipv4 address>

Syntax Description

ip Optional. Specifies an IPv4 trace.

<interface> Optional. Specifies the egress interface to use for the trace. Interfaces are

specified in the <interface type> <slot/port | interface id> format. For

example, for an Ethernet interface, use eth 0/1. Type traceroute <ipv4

address | hostname> ? to display a list of valid interfaces.

<ipv4 address | hostname> Optional. Specifies the IPv4 address or host name of the remote system’s

route to trace.

source <ipv4 address> Optional. Specifies the IPv4 address of the interface to use as the source of

the trace. IPv4 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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

Release 18.3 Command was expanded to include the <interface> and ip parameters.

Functional Notes

The traceroute command can be issued from both the Basic and Enable modes.

Command Reference Guide Basic Mode Command Set

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 sample output from the traceroute command:

>traceroute 192.168.0.1

Type CTRL+C to abort.

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 Basic Mode Command Set

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.

Variations of this command include:

traceroute ethernet <target-mac-address | target-mep-id>

traceroute ethernet <target-mac-address | target-mep-id> domain <domain name> association

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>

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

transmitting MEP belongs.

domain none Optional. Specifies no maintenance domain.

association <association name> Optional. Specifies the maintenance association to which the

transmitting MEP belongs.

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

interface ? at the prompt.

After specifying the target for the linktrace messages, the other parameters can be entered

in any order.

Command Reference Guide Basic Mode Command Set

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

Release 17.4 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF) Metro

Ethernet interface and the Gigabit Switchport interface.

Functional Notes

The traceroute ethernet command can be issued from both the Basic and Enable modes.

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.

For more information regarding Ethernet OAM CFM and its operation on AOS products, refer to the

Ethernet OAM CFM in AOS configuration guide available online at https://supportforums.adtran.com

(article number 3013).

Command Reference Guide Basic Mode Command Set

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:

>traceroute ethernet 201 mep 1

Type CTRL+C to abort.

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

3 00:10:94:00:00:05 Forwarded InNoTLV RLY_MPDB

00:10:94:00:00:04 EgOK

2 00:10:94:00:00:04 Forwarded InNoTLV RLY_MPDB

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.

Command Reference Guide Basic Mode Command Set

traceroute ipv6

Use the traceroute ipv6 command to display the IPv6 nodes traversed to reach the specified destination.

Variations of this command include:

traceroute ipv6 <ipv6 address>

traceroute ipv6 <ipv6 address> <interface>

traceroute ipv6 <ipv6 address> <interface> source <ipv6 address>

traceroute ipv6 <ipv6 address> source <ipv6 address>

traceroute ipv6 vrf <name> <ipv6 address>

traceroute ipv6 vrf <name> <ipv6 address> <interface>

traceroute ipv6 vrf <name> <ipv6 address> <interface> source <ipv6 address>

traceroute ipv6 vrf <name> <ipv6 address> source <ipv6 address>

Syntax Description

<interface> Optional. Specifies the egress interface when tracing a route to an IPv6

link-local address (any address that has the prefix FE80::/64). Interfaces

are specified in the <interface type> <slot/port | interface id> format. For

example, for an Ethernet interface, use eth 0/1. Type traceroute ipv6 <ipv6

address> ? to display a list of valid interfaces. This variable is ignored when

using a non-link-local address.

<ipv6 address> Specifies the IPv6 address of the remote system’s route to trace. IPv6

addresses should be expressed in colon hexadecimal format (X:X:X:X::X).

For example, 2001:DB8:1::1.

Entering the traceroute ipv6 command using

a link-local destination address prompts the user for an egress interface.

source <ipv6 address> Optional. Specifies the IPv6 address to use as the source address in the

probing packets. The source IPv6 address must be a valid address local to

the router on the specified VPN routing and forwarding (VRF) instance.

vrf <name> Optional. Specifies the VRF where the IPv6 address exists.

Default Values

No default values are necessary for this command.

Command History

Release 18.1 Command was introduced.

Functional Notes

The traceroute ipv6 command can be issued from both the Basic and Enable modes.

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

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

Command Reference Guide Basic Mode Command Set

Usage Examples

The following is sample output from the traceroute ipv6 command:

>traceroute ipv6 2001:DB8:1A0::3

Tracing route to over a maximum of 30 hops

Type CTRL+C to abort.

Legend: '!' = Success, '?' = Unknown host, '$' = Invalid host address

'*' = Request timed out, '-' = Destination host unreachable

'x' = TTL expired in transit, 'e' = Unknown error

'B' = Packet too big

1 2ms 2ms 3ms 2001:DB8:0:F820::5

2 102ms 109ms 102ms 2001:DB8:1A0::3

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 66

cross-connect on page 67

description <text> on page 70

do on page 71

end on page 72

exit on page 73

interface on page 74

shutdown on page 82

Command Reference Guide Common Commands

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

No default values are necessary for this command.

Applicable Command Modes

Applies to all interface mode command sets.

Command History

Release 1.1 Command was introduced.

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)#interface t1 1/1

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

Command Reference Guide Common Commands

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

Variations of this command include:

cross-connect <number> <from interface> <to interface>

cross-connect <number> <from interface> <group number> <to interface>

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

Applicable Command Modes

Applies to all interface mode command sets.

Command History

Release 1.1 Command was introduced.

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.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF) Metro

Ethernet interface.

Changing cross-connect settings could potentially result in service interruption.

Command Reference Guide Common Commands

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)#interface t1 1/1

(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

Command Reference Guide Common Commands

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)#interface frame-relay 7

(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)#frame-relay interface-dlci 30

(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)#interface t1 1/1

(config-t1 1/1)#tdm-group 9 timeslots 1-20 speed 56

(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

https://supportforums.adtran.com.

Command Reference Guide Common Commands

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

No default values are necessary for this command.

Applicable Command Modes

Applies to all interface mode command sets.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example enters comment information using the description command:

(config)#interface t1 1/1

(config-t1 1/1)#description This is the Dallas office T1

Command Reference Guide Common Commands

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

No default values are necessary for this command.

Applicable Command Modes

Applies to all mode command sets.

Command History

Release 2.1 Command was introduced.

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)#interface t1 1/1

(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

Command Reference Guide Common Commands

end

Use the end command to exit the current configuration mode and enter the Enable Security mode.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Applicable Command Modes

Applies to all mode command sets except Basic mode.

Command History

Release 1.1 Command was introduced.

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

When exiting the Global Configuration mode, remember to perform a copy

running-config startup-config to save all configuration changes.

Command Reference Guide Common Commands

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.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Applicable Command Modes

Applies to all mode command sets.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example shows the exit command being executed in the Global Configuration mode:

(config)#exit

#- Enable Security mode command prompt

When exiting the Global Configuration mode, remember to perform a copy

running-config startup-config to save all configuration changes.

Command Reference Guide Common Commands

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, single-pair 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 980 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> [ap-type nv150 | radio-type [802.11a | 802.11bg]]

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 mef-ethernet <slot/port | slot/port.subinterface>

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>

Command Reference Guide Common Commands

interface t1 <slot/port>

interface t3 <slot/port>

interface tunnel <interface id> gre ip

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

ap-type nv150 Specifies the wireless access point (AP) type. Valid interface type

is nv150.

radio-type [802.11a | 802.11bg] Specifies the radio interface type. Valid interface types are

802.11a and 802.11bg.

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

dependent upon the hardware installed in the unit. Type interface

ethernet ? for information regarding valid ranges.

fdl <slot/port> Identifies facility data link (FDL) interfaces. Slot and port number

ranges are dependent upon the hardware installed in the unit.

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.

Command Reference Guide Common Commands

fxo <slot/port> Identifies foreign exchange office (FXO) interfaces. Slot and port

number ranges are dependent upon the hardware installed in the

unit. Type interface fxo ? for information regarding valid ranges.

fxs <slot/port> Identifies foreign exchange station (FXS) interfaces. Slot and port

number ranges are dependent upon the hardware installed in the

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

number ranges are dependent upon the hardware installed in the

unit. Type interface hssi ? for information regarding valid ranges.

loopback <interface id> Identifies and creates loopback interfaces. Valid range is 1 to

1024.

mef-ethernet <slot/port> Identifies Metro Ethernet Forum (MEF) Metro Ethernet interfaces.

Slot and port number ranges are dependent upon the hardware

installed in the unit.

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

ranges are dependent upon the hardware installed in the unit.

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 single-pair high-speed digital subscriber lline (SHDSL)

interfaces. Slot and port number ranges are dependent upon the

hardware installed in the unit. Type interface shdsl ? for

information regarding valid ranges.

switchport <slot/port> Identifies switchport interfaces. Slot and port number ranges are

dependent upon the hardware installed in the unit. Type interface

switchport ? for information regarding valid ranges.

t1 <slot/port> Identifies T1 interfaces. Slot and port number ranges are

dependent upon the hardware installed in the unit. Type interface

t1 ? for information regarding valid ranges.

Command Reference Guide Common Commands

t3 <slot/port> Identifies T3 interfaces. Slot and port number ranges are

dependent upon the hardware installed in the unit. Type interface

t3 ? for information regarding valid ranges.

tunnel <interface id> gre ip Identifies and creates Internet Protocol version 4 (IPv4) generic

routing encapsulation (GRE) tunnel interfaces. Valid range is 1 to

1024.

vlan <interface id> Identifies and creates virtual local area network (VLAN) interfaces.

Valid range is 1 to 4094.

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 1.1 Command was introduced.

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.

Release A4.01 Command was expanded to include the Metro Ethernet Forum

(MEF) Metro Ethernet interface.

Release 18.1 Command was expanded to include the ap-type and radio-type

parameters.

Release R10.1.0 The tunnel <interface id> command was changed to tunnel

<interface id> gre ip.

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.

Command Reference Guide Common Commands

Usage Examples

The following example uses the interface command to navigate from the T1 Interface Configuration mode

to a Frame Relay interface:

(config)#interface t1 1/1

(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)#interface adsl 1/1

(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)#interface bvi 1

(config-bvi 1)#

For a cellular interface:

(config)#interface cellular 1/1

(config-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 a dot11ap interface:

(config)#interface dot11ap 1

(config-dot11ap 1)#

Command Reference Guide Common Commands

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

(config-giga-eth 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)#

Command Reference Guide Common Commands

For an MEF Ethernet interface:

(config)#interface mef-ethernet 2/1

(config-mef-ethernet 2/1)#

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)#interface ppp 100

(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)#interface t1 1/1

(config-t1 1/1)#

For a T3 interface:

(config)#interface t3 1/1

(config-t3 1/1)#

Command Reference Guide Common Commands

For a tunnel interface:

(config)#interface tunnel 300 gre ip

(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

(config-dot11ap 1/1.1-bg)#

Command Reference Guide Common Commands

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.

Applicable Command Modes

Applies to all interface mode command sets.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example administratively disables the modem interface:

(config)#interface modem 1/2

(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

ip access-policy UNTRUSTED

crypto map SITE2SITE

no lldp send-and-receive

cross-connect 1 t1 1/1 1 ppp 1

Command Reference Guide Enable Mode Command Set

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

interface switchport 0/2

interface switchport 0/3

interface switchport 0/4

interface switchport 0/5

interface switchport 0/6

interface switchport 0/7

--MORE--

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 73

All other commands for this command set are described in this section in alphabetical order.

boot config on page 86

boot system on page 87

clear commands begin on page 89

clock auto-correct-dst on page 179

clock no-auto-correct-dst on page 180

clock set <time> <day> <month> <year> on page 181

clock timezone <value> on page 182

configure on page 185

copy on page 186

copy cflash on page 188

copy console on page 191

copy dynvoice-config on page 193

copy flash on page 196

copy http on page 200

copy https on page 202

copy ramdisk on page 204

copy running-config on page 207

copy startup-config on page 210

copy tftp on page 213

copy usbdrive0 on page 215

copy xmodem on page 217

debug commands begin on page 219

dir on page 380

Command Reference Guide Enable Mode Command Set

disable on page 382

eject usbdrive0 on page 383

erase on page 384

events on page 386

exception report generate on page 387

factory-default on page 388

logout on page 389

mount usbdrive0 on page 390

ping on page 391

ping ethernet on page 395

ping ipv6 on page 398

ping stack-member <number> on page 401

ping twamp on page 402

port-auth re-authenticate on page 405

ramdisk <size> on page 406

reload on page 407

reload dot11 interface dot11ap <ap interface> on page 408

run audit security on page 409

run checkdisk cflash on page 412

run checkdisk usbdrive0 on page 413

run-tcl <filename> track <name> on page 414

show commands begin on page 415

sip check-sync on page 832

telnet on page 833

telnet stack-member <unit id> on page 835

telnet vrf <name> stack-member <number> on page 836

terminal length <number> on page 837

traceroute on page 838

traceroute ethernet on page 840

traceroute ipv6 on page 843

undebug all on page 845

verify-file on page 846

vlan database on page 847

voice dsp capture on page 848

voice loopback-call on page 849

wall <message> on page 850

write on page 851

Command Reference Guide Enable Mode Command Set

boot config

Use the boot config command to modify system boot parameters by specifying the location and name of

primary and secondary configuration files. Use the no form of this command to use the default startup

configuration file. 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>

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

No default values are necessary for this command.

Command History

Release 18.2 Command was introduced

Usage Examples

The following example specifies the file myconfig.biz (located in flash memory) as the primary system

boot file:

>enable

(config)#boot config flash myconfig.biz

The following example specifies the file myconfig.biz (located in flash memory) as the primary system

boot file and the file mybackupconfig.biz (located in CompactFlash memory) as the backup configuration

file:

>enable

(config)#boot config flash myconfig.biz cflash mybackupconfig.biz

The cflash parameter is only valid for units with CompactFlash® capabilities.

Command Reference Guide Enable Mode Command Set

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

boot system flash <primary filename> verify

boot system flash <primary filename> <secondary filename>

boot system flash <primary filename> <secondary filename> 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

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

No default values are necessary for this command.

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.

Command Reference Guide Enable Mode Command Set

Command History

Release 18.2 Command was introduced.

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:

>enable

#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:

>enable

#boot system flash myimage.biz no-backup

The following example specifies myimage.biz (located in flash memory) as the primary image file and

mybackupimage.biz (also located in flash memory) as the backup image:

>enable

#boot system flash myimage.biz mybackupimage.biz

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

clear bgp

Use the clear bgp command to clear information for Internet Protocol version 4 (IPv4) or Internet Protocol

version 6 (IPv6) Border Gateway Protocol (BGP). You can clear BGP neighbors, BGP IPv4 and IPv6 route

information, and BGP connections on the default or nondefault VPN routing and forwarding (VRF)

instances. Variations of this command include:

clear bgp *

clear bgp <number>

clear bgp <ipv4 address>

clear bgp <ipv6 address>

clear bgp any-vrf [* | <number> | <ipv4 address>] [in | out | soft]

clear bgp any-vrf [* | <number> | <ipv6 address>] [in | out | soft]

clear bgp any-vrf ipv4 [* | <number> | <ipv4 address>] [in | out | soft]

clear bgp any-vrf ipv6 [* | <number> | <ipv6 address>] [in | out | soft]

clear bgp ipv4 [* | <number> | <ipv4 address>] [in | out | soft]

clear bgp ipv6 [* | <number> | <ipv6 address>] [in | out | soft]

clear bgp vrf <name> [* | <number> | <ipv4 address>] [in | out | soft]

clear bgp vrf <name> ipv4 [* | <number> | <ipv4 address>] [in | out | soft]

clear bgp vrf <name> ipv6 [* | <number> | <ipv6 address>] [in | out | soft]

Syntax Description

*Clears all BGP neighbors.

<number> Clears all BGP neighbors with the specified autonomous system (AS)

number. Range is 1 to 4294967295.

<ipv4 address> Clears the BGP neighbor with the specified IPv4 address. IPv4 addresses

should be expressed in dotted decimal notation (for example, 10.10.10.1).

<ipv6 address> Clears the BGP neighbor with the specified IPv6 address. IPv6 addresses

should be expressed in colon hexadecimal format (for example,

2001:DB8:1::1).

any-vrf Optional. Clears BGP connections for all VRF instances.

ipv4 Optional. Clears all BGP IPv4 route information.

ipv6 Optional. Clears all BGP IPv6 route information.

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.

vrf <name> Optional. Clears connections for a nondefault VRF instance.

Default Values

No default values are necessary for this command.

Command Reference Guide Enable Mode Command Set

Command History

Release 8.1 Command was introduced.

Release 18.1 Command was altered to support 4-byte AS number (previously AOS only

supported 2-byte numbers).

Release 18.3 Command syntax was changed to remove the ip keyword for ADTRAN

internetworking products. In addition, the any-vrf, vrf <name>, and ipv4

parameters were added.

Release R10.1.0 Command was expanded to include IPv6 BGP capability, and the ipv6 and

<ipv6 address> parameters were added. In addition, the command syntax

was changed to remove the ip keyword for ADTRAN voice products.

Functional Notes

The clear 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 bgp 101

Command Reference Guide Enable Mode Command Set

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

Optional. Specifies a single bridge group. Range is 1 to 255.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example clears all counters for bridge group 17:

>enable

#clear bridge 17

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 3.1 Command was introduced.

Usage Examples

The following example clears the maximum-used buffer statics:

>enable

#clear buffers max-used

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 9.1 Command was expanded to include the high level data link control (HDLC)

and tunnel interfaces.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface and the Gigabit Switchport interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet interface.

Usage Examples

The following example clears all counters associated with the Ethernet 0/1 interface:

>enable

#clear counters ethernet 0/1

Command Reference Guide Enable Mode Command Set

clear counters efm-group <group number>

Use the clear counters efm-group command to clear the counters of the specified Ethernet in the first mile

(EFM) group.

Syntax Description

<group number> Specifies the EFM group. Range is 1 to 1024.

Default Values

No default values are necessary for this command.

Command History

Release A4.01 Command was introduced.

Usage Examples

The following example clears the counters for the EFM group 1:

>enable

#clear counters efm-group 1

Command Reference Guide Enable Mode Command Set

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

Release 17.4 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet interface.

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 online at https://supportforums.adtran.com

(article number 3013).

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

clear counters hmr

Use the clear counters hmr command to clear any Session Initiation Protocol (SIP) header manipulation

rules (HMR) statistics. Variations of this command include:

clear counters hmr

clear counters hmr direction inbound

clear counters hmr direction outbound

clear counters hmr policy <name>

clear counters hmr user <extension>

clear counters hmr user global

clear counters hmr user proxy-server

clear counters hmr user proxy-user

Syntax Description

direction inbound Optional. Clears HMR statistics for inbound SIP traffic.

direction outbound Optional. Clears HMR statistics for outbound SIP traffic.

policy <name> Optional. Clears HMR statistics for a specific HMR policy.

user Optional. Clears HMR statistics for a specific user.

<extension> Optional. Clears HMR statistics for a specific user.

global Optional. Clears HMR statistics for SIP global traffic.

proxy-server Optional. Clears HMR statistics for SIP proxy server traffic.

proxy-user Optional. Clears HMR statistics for SIP proxy user traffic.

Default Values

No default values are necessary for this command.

Command History

Release R10.1.0 Command was introduced.

Usage Examples

The following example clears all HMR statistics:

>enable

#clear counters hmr

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 9.3 Command was introduced.

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.

Command Reference Guide Enable Mode Command Set

clear counters probe

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

Variations of this command include:

clear counters probe

clear counters probe <name>

Syntax Description

<name> Specifies a probe object to reset counter.

Default Values

No default values are necessary for this command.

Command History

Release 13.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

clear counters shdsl <slot/port> splice-detect

Use the clear counters shdsl splice-detect command to clear all bad splice detection test data for the

specified single-pair high-speed digital subscriber line (SHDSL) interface.

Syntax Description

<slot/port> Specifies the slot and port of the interface for which you want to clear the

test data.

Default Values

No default values are necessary for this command.

Command History

Release A4.05 Command was introduced.

Usage Examples

The following example clears all bad splice detection test data associated with the SHDSL 1/1 interface:

>enable

#clear counters shdsl 1/1 splice-detect

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 13.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 5.1 Command was introduced.

Usage Examples

The following example resets the counters on VLAN interface 7:

>enable

#clear counters vlan 7

Command Reference Guide Enable Mode Command Set

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 two-digit identifier

following T (for example, T01).

Default Values

No default values are necessary for this command.

Command History

Release 9.3 Command was introduced.

Usage Examples

The following example resets the counters for all configured voice trunks:

>enable

#clear counters voice-trunk all

Command Reference Guide Enable Mode Command Set

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 920

remote-id <remote id>

Optional. Removes all IKE SAs associated with the specified IKE remote ID.

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

No default values are necessary for this command.

Command History

Release 4.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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> Opti

onal. Removes all IPsec SAs associated with the specified IPsec remote

ID.

Default Values

No default values are necessary for this command.

Command History

Release 4.1 Command was introduced.

Release 15.1 Command was expanded to include the remote-id parameter.

Release 17.5 Command was expanded to include the peak parameter.

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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.

Variations of this command include:

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

No default values are necessary for this command.

Command History

Release 17.8 Command was introduced.

Usage Examples

The following example clears all collected NAP statistics for all clients:

>enable

#clear desktop-auditing

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

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.

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 6.1 Command was introduced.

Usage Examples

The following example clears the entire database of Internet key exchange (IKE) SAs (including the active

associations):

>enable

#clear dump-core

Command Reference Guide Enable Mode Command Set

clear ethernet cfm mep remote

Use the clear ethernet cfm mep 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

No default values are necessary for this command.

Command History

Release 17.4 Command was introduced.

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 online at https://supportforums.adtran.com

(article number 3013).

Usage Examples

The following example clears all CCM entries for all remote MEPs:

>enable

#clear ethernet cfm mep remote

Command Reference Guide Enable Mode Command Set

clear event-history

Use the clear event-history command to clear all messages logged to the local event-history.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example clears all local event-history messages:

>enable

#clear event-history

Messages cleared from the local event-history (using the clear event-history command) are

no longer accessible.

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example clears counter statistics on the GVRP interfaces:

>enable

#clear gvrp statistics all

Command Reference Guide Enable Mode Command Set

clear host

Use the clear host command to clear a host name when using the domain naming system (DNS) proxy.

Variations of this command include:

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

No default values are necessary for this command.

Command History

Release 10.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

Functional Notes

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 example clears all dynamic host names:

>enable

#clear host *

Command Reference Guide Enable Mode Command Set

clear ip access-list

Use the clear ip access-list command to clear all counters associated with all Internet Protocol version 4

(IPv4) access control lists (ACLs) or a specified IPv4 ACL. Variations of this command include:

clear ip access-list

clear ip access-list <ipv4 acl name>

Syntax Description

<ipv4 acl name> Optional. Specifies the name (label) of an IPv4 ACL to clear.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 17.9 Command was changed to require the ip keyword for ADTRAN

internetworking products only.

Release R10.1.0 Command was changed to require the ip keyword for ADTRAN voice

products.

Usage Examples

The following example clears all counters for the IPv4 ACL labeled MatchAll:

>enable

#clear ip access-list MatchAll

Command Reference Guide Enable Mode Command Set

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

Variations of this command include:

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Release 14.1 Command was expanded to include the counters parameter.

Release 16.1 Command was expanded to include the vrf parameter.

Functional Notes

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

Command Reference Guide Enable Mode Command Set

clear ip dhcp binding

Use the clear ip dhcp binding command to clear Dynamic Host Configuration Protocol version 4

(DHCPv4) server binding entries. Variations of this command include:

clear ip dhcp binding *

clear ip dhcp binding <ipv4 address>

clear ip dhcp binding vrf <name> *

clear ip dhcp binding vrf <name> <ipv4 address>

Syntax Description

*Clears all automatic DHCPv4 server binding entries.

vrf <name> Optional. Clears DHCPv4 server binding entries on the specified VPN

routing and forwarding (VRF) instance.

<ipv4 address> Clears a specific DHCPv4 server binding associated with an IPv4 address.

IPv4 addresses should be expressed in dotted decimal notation (for

example, 10.10.10.1).

Default Values

No default values are necessary for this command.

Command History

Release 16.1 Command was introduced.

Release 17.1 Command was expanded to include the vrf parameter.

Release 18.3 Command syntax was changed to remove the hyphen and the server

keyword for ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the hyphen and the server

keyword for ADTRAN voice products.

Usage Examples

The following example clears all DHCPv4 server bindings on the default VRF:

>enable

#clear ip dhcp binding *

The following example clears all DHCPv4 server bindings from the VRF RED:

>enable

#clear ip dhcp binding vrf RED *

Command Reference Guide Enable Mode Command Set

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

<interface> Specifies 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; 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

No default values are necessary for this command.

Command History

Release 13.1 Command was introduced.

Release 17.6 Command was expanded to include ipsec parameters.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet interface.

Usage Examples

The following example clears all RapidRoute entries for the Ethernet 0/1 interface:

>enable

#clear ip ffe ethernet 0/1

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 16.1 Command was introduced.

Usage Examples

The following example clears all ITM statistics associated with an observation point:

#clear ip flow stats

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 17.1 Command was introduced.

Usage Examples

The following example clears all Top Talker statistics:

#clear ip flow top-talkers

Command Reference Guide Enable Mode Command Set

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

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

No default values are necessary for this command.

Command History

Release 7.1 Command was introduced.

Release 9.1 Command was expanded to include the high-bit-rate digital subscriber line

(HDSL) and tunnel interfaces.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet interface.

Usage Examples

The following example clears all statistics from the IGMP tables for all nonstatic IGMP groups:

>enable

#clear ip igmp group

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example resets the OSPF process:

>enable

#clear ip ospf process

Command Reference Guide Enable Mode Command Set

clear ip policy-sessions

Use the clear ip policy-sessions command to clear Internet Protocol version 4 (IPv4) access control policy

(ACP) firewall sessions. You may clear all the IPv4 sessions or a specific session. Use the show ip

policy-sessions command to view a current IPv4 session listing. Variations of this command include:

clear ip policy-sessions

clear ip policy-sessions any-vrf

clear ip policy-sessions pending

clear ip policy-sessions <ipv4 acp name> [ahp | esp | gre | icmp | tcp | udp | <protocol>] <ipv4 source>

clear ip policy-sessions <ipv4 acp name> [ahp | esp | gre | icmp | tcp | udp | <protocol>] <ipv4 source>

<source port> <ipv4 destination> <destination port> [destination | source] <nat ipv4 address>

clear ip policy-sessions vrf <name>

clear ip policy-sessions vrf <name> <ipv4 acp name> [ahp | esp | gre | icmp | tcp | udp | <protocol>]

clear ip policy-sessions vrf <name> <ipv4 acp name> [ahp | esp | gre | icmp | tcp | udp | <protocol>]

<ipv4 source> <source port> <ipv4 destination> <destination port> [destination | source]

Syntax Description

any-vrf Optional. Clears the current ACP associations for all VPN routing and

forwarding (VRF) instances.

pending Optional. Clears pending ACP associations that are waiting on unknown

traffic.

<ipv4 acp name> Specifies the IPv4 ACP from which to clear the firewall sessions.

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.

<ipv4 source> Specifies the source IPv4 address. IPv4 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).

<ipv4 destination> Specifies the destination IPv4 address. IPv4 addresses should be

expressed in dotted decimal notation (for example, 10.10.10.1).

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

Command Reference Guide Enable Mode Command Set

<nat ipv4 address> 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 VRF instance to impact. Executing the above

mentioned commands without specifying a VRF will only affect the default

unnamed VRF.

Default Values

No default values are necessary for this command.

Command History

Release 2.1 Command was introduced.

Release 17.1 Command was expanded to include the vrf and any-vrf parameters.

Release R10.1.0 Command was expanded to include the pending parameter.

Functional Notes

The second half of this command, beginning with the source IPv4 address, may be copied and pasted

from a row in the show ip policy-sessions table for easier use.

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 example clears the Telnet association (TCP port 23) for an IPv4 policy class PCLASS1 with

source IPv4 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 IPv4 policy class sessions for the VRF instance named RED:

>enable

#clear ip policy-sessions vrf RED

Clearing pending ACP sessions may temporarily disrupt any applications that depend on

the presence of pending ACP sessions to allow the application traffic through the firewall.

Command Reference Guide Enable Mode Command Set

clear ip policy-stats

Use the clear ip policy-stats command to clear statistical counters for Internet Protocol version 4 (IPv4)

access control policies (ACPs). Variations of this command include:

clear ip policy-stats

clear ip policy-stats <ipv4 acp name>

clear ip policy-stats <ipv4 acp name> entry <number>

Syntax Description

Optional. Specifies the IPv4 ACP to clear. If no IPv4 ACP is specified, statistics

are cleared for all policies.

entry <number>

Optional.

Clears the statistics of a specific IPv4 ACP. Number range is 1 to

4294967295.

Default Values

No default values are necessary for this command.

Command History

Release 2.1 Command was introduced.

Usage Examples

The following example clears statistical counters for all IPv4 ACPs:

>enable

#clear ip policy-stats

The following example clears statistical counters for the IPv4 ACP MatchALL:

>enable

#clear ip policy-stats MatchALL

Command Reference Guide Enable Mode Command Set

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 588 for more information.

Syntax Description

<name> Clears the count statistics of the specified IP prefix list.

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example clears the hit count statistics for prefix list test:

>enable

#clear ip prefix-list test

Command Reference Guide Enable Mode Command Set

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

addresses should be expressed in dotted decimal notation (for example,

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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

Functional Notes

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 example removes all learned routes from the route table:

>enable

#clear ip route *

Command Reference Guide Enable Mode Command Set

The following example removes all learned routes from the route table on the VRF RED:

>enable

#clear ip route vrf RED *

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 17.5 Command was introduced.

Usage Examples

The following example clears all routes from the hardware forwarding table:

>enable

#clear ip route-cache express

Command Reference Guide Enable Mode Command Set

clear ip rtp quality-monitoring

Use the clear ip rtp quality-monitoring command to clear all voice quality monitoring (VQM) statistics

or only VQM statistics from the call history or a particular interface. 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 |

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 rtp quality-monitoring interface ? for a valid

list of interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 17.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Usage Examples

The following example clears all VQM statistics from the call history:

>enable

#clear ip rtp quality-monitoring call-history

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 17.6 Command was introduced.

Usage Examples

The following example clears only the statistics associated with VQM reporter Reporter1:

>enable

#clear ip rtp quality-monitoring reporter Reporter1

Command Reference Guide Enable Mode Command Set

clear ip security

Use the clear ip security command to clear all statistics associated with the security monitor. Variations of

this command include:

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

No default values are necessary for this command.

Command History

Release 17.5 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 12.1 Command was introduced.

Usage Examples

The following example clears all counters for URL filter requests and responses:

>enable

#clear ip urlfilter statistics

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 16.1 Command was introduced.

Usage Examples

The following example clears all statistics for top websites reporting:

>enable

#clear ip urlfilter top-websites

Command Reference Guide Enable Mode Command Set

clear ipv6 access-list

Use the clear ip access-list command to clear all counters associated with all Internet Protocol version 6

(IPv6) access control lists (ACLs) or a specified IPv6 ACL. Variations of this command include:

clear ipv6 access-list

clear ipv6 access-list <ipv6 acl name>

Syntax Description

<ipv6 acl name> Optional. Specifies the name (label) of an IPv6 ACL to clear.

Default Values

No default values are necessary for this command.

Command History

Release 18.1 Command was introduced.

Usage Examples

The following example clears all counters for the IPv6 ACL labeled MatchAll:

>enable

#clear ipv6 access-list MatchAll

Command Reference Guide Enable Mode Command Set

clear ipv6 cache

Use the clear ipv6 cache command to clear all the Internet Protocol version 6 (IPv6) route cache entries in

a given virtual private network (VPN) routing and forwarding (VRF) instance. Variations of this command

include:

clear ipv6 cache

clear ipv6 cache counters

clear ipv6 cache vrf <name>

clear ipv6 cache vrf <name> counters

Syntax Description

counters Optional. Specifies that only the use-count statistics are cleared for each

IPv6 route cache entry.

vrf <name> Optional. Specifies a nondefault VRF instance on which to clear all the IPv6

route cache entries. If no VRF instance is specified, all entries on the default

VRF instance are cleared.

Default Values

No default values are necessary for this command.

Command History

Release 18.3 Command was introduced.

Usage Examples

The following example clears all the IPv6 route cache entries on the default VRF instance:

>enable

#clear ipv6 cache

Command Reference Guide Enable Mode Command Set

clear ipv6 dhcp binding

Use the clear ipv6 dhcp binding command to remove one or all of the Dynamic Host Control Protocol for

Internet Protocol version 6 (DHCPv6) server binding entries. Variations of this command include:

clear ipv6 dhcp binding *

clear ipv6 dhcp binding <ipv6 address>

clear ipv6 dhcp binding client-identifier <client DUID>

clear ipv6 dhcp binding vrf <name> *

clear ipv6 dhcp binding vrf <name> <ipv6 address>

clear ipv6 dhcp binding vrf <name> client-identifier <client DUID>

Syntax Description

*Clears all DHCPv6 server IPv6 address bindings.

<ipv6 address> Clears DHCPv6 server bindings for a single IPv6 address. IPv6

addresses should be expressed in colon hexadecimal format

(X:X:X:X::X), for example, 2001:DB8:1::1.

client-identifier <client DUID> Clears the DHCPv6 server bindings for a single DHCPv6 client. The

client DHCP unique identifier (DUID) is expressed as a hexadecimal

value.

vrf <name> Optional. specifies a nondefault VPN routing and forwarding (VRF)

instance from which to remove the binding entries. If no VRF instance is

specified, the binding entries are cleared on the default VRF instance.

Default Values

No default values are necessary for this command.

Command History

Release R10.1.0 Command was introduced.

Usage Examples

The following example specifies that the DHCPv6 server bindings on the default VRF instance for all IPv6

addresses are cleared:

>enable

#clear ipv6 dhcp binding *

Command Reference Guide Enable Mode Command Set

clear ipv6 dhcp conflict

Use the clear ipv6 dhcp conflict command to remove one or all of the Dynamic Host Control Protocol for

Internet Protocol version 6 (DHCPv6) server addresses that conflict. Variations of this command include:

clear ipv6 dhcp conflict *

clear ipv6 dhcp conflict <ipv6 address>

clear ipv6 dhcp conflict vrf <name> *

clear ipv6 dhcp conflict vrf <name> <ipv6 address>

Syntax Description

*Specifies that all IPv6 address conflicts are cleared.

<ipv6 address> Specifies that the conflicts for a single IPv6 address are cleared. IPv6

addresses should be expressed in colon hexadecimal format (X:X:X:X::X),

for example, 2001:DB8:1::1.

vrf <name> Optional. Specifies a nondefault VPN routing and forwarding (VRF) instance

from which to remove the conflicting address entries. If no VRF instance is

specified, the conflicting entries are cleared on the default VRF instance.

Default Values

No default values are necessary for this command.

Command History

Release R10.1.0 Command was introduced.

Usage Examples

The following example clears the DHCPv6 server conflict addresses on the default VRF instance for all

IPv6 addresses:

>enable

#clear ipv6 dhcp conflict *

Command Reference Guide Enable Mode Command Set

clear ipv6 interfaces <interface> prefix

Use the clear ipv6 interfaces prefix command to clear Internet Protocol version 6 (IPv6) address prefix

information from a specified interface.

Syntax Description

<interface> Specifies the interface on which to clear IPv6 address prefix information.

Specify interfaces in the <interface> <slot/port | interface id> format. For

example, to specify a Point-to-Point Protocol (PPP) interface, enter ppp 1.

Enter clear ipv6 interfaces ? for a list of available interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 18.1 Command was introduced.

Release R10.1.0 Command was expanded to include the tunnel interface.

Usage Examples

The following example specifies that all IPv6 address prefix information is cleared for the ethernet 0/1

interface:

>enable

#clear ipv6 interfaces ethernet 0/1 prefix

Command Reference Guide Enable Mode Command Set

clear ipv6 neighbors

Use the clear ipv6 neighbors command to clear dynamic entries from the Internet Protocol version 6

(IPv6) neighbor cache. Variations of this command include:

clear ipv6 neighbors

clear ipv6 neighbors <ipv6 address>

clear ipv6 neighbors statistics

clear ipv6 neighbors <interface>

clear ipv6 neighbors <interface> <ipv6 address>

clear ipv6 neighbors <interface> statistics

clear ipv6 neighbors vrf <name>

clear ipv6 neighbors vrf <name> <ipv6 address>

clear ipv6 neighbors vrf <name> statistics

Syntax Description

<ipv6 address> Optional. Specifies that the neighbor cache entries for a specific IPv6

address are cleared. Specify IPv6 addresses in colon hexadecimal format

(X:X:X:X::X). For example, 2001:DB8:1::1. If no IPv6 address is specified,

all entries are cleared.

<interface> Optional. Specifies that the neighbor cache entries for a specific interface

are cleared. Specify interfaces in the <interface> <slot/port | interface id>

format. For example, to specify a Point-to-Point Protocol (PPP) interface,

enter ppp 1. If no interface is specified, all entries for all interfaces on the

VPN routing and forwarding (VRF) instance are cleared.

statistics Optional. Specifies that statistics for the neighbor cache and protocol

interaction are cleared.

vrf <name> Optional. Specifies that neighbor cache entries for a specific VRF instance

are cleared. If no VRF is specified, entries on the default unnamed VRF are

cleared.

Default Values

By default, if no options are specified, entering this command clears all neighbor cache entries on all

interfaces assigned to the default VRF.

Command History

Release 18.1 Command was introduced.

Usage Examples

The following example clears all entries in the neighbor cache for the default VRF:

>enable

#clear ipv6 neighbors

Command Reference Guide Enable Mode Command Set

clear ipv6 policy-sessions

Use the clear ipv6 policy-sessions command to clear Internet Protocol version 6 (IPv6) access control

policy (ACP) sessions from the firewall association database. Clearing a session typically terminates the

session’s communication, therefore this command should be used carefully, particularly if the session is

one used for access to the command line interface (CLI). You may clear all the IPv6 sessions or a specific

IPv6 session. Use the show ipv6 policy-sessions command to view a current IPv6 session listing.

Variations of this command include:

clear ipv6 policy-sessions

clear ipv6 policy-sessions <ipv6 acp name> [ahp | esp | gre | <protocol>] <ipv6 source> [<interface>]

clear ipv6 policy-sessions <ipv6 acp name> [tcp | udp] <ipv6 source> [<interface>] <source port>

clear ipv6 policy-sessions <ipv6 acp name> icmpv6 <ipv6 source> [<interface>] <id>

clear ipv6 policy-sessions any-vrf

clear ipv6 policy-sessions pending

clear ipv6 policy-sessions pending any-vrf

clear ipv6 policy-sessions pending <ipv6 acp name> [ahp | esp | gre | <protocol>] <ipv6 source>

[<interface>] <ipv6 destination>

clear ipv6 policy-sessions pending <ipv6 acp name> [tcp | udp] <ipv6 source> [<interface>] <source

port> <ipv6 destination> <destination port>

clear ipv6 policy-sessions pending <ipv6 acp name> icmpv6 <ipv6 source> [<interface>] <id>

clear ipv6 policy-sessions vrf <name>

clear ipv6 policy-sessions vrf <name> <ipv6 acp name> [ahp | esp | gre | <protocol>] <ipv6 source>

[<interface>] <ipv6 destination>

clear ipv6 policy-sessions vrf <name> <ipv6 acp name> [tcp | udp | <protocol>] <ipv6 source>

[<interface>] <source port> <ipv6 destination> <destination port>

clear ipv6 policy-sessions vrf <name> <ipv6 acp name> icmpv6 <ipv6 source> [<interface>] <id>

Syntax Description

any-vrf Optional. Specifies that all sessions in all VPN routing and forwarding (VRF)

instances are cleared.

pending Optional. Specifies that any associations waiting on unknown traffic are

cleared.

<ipv6 acp name> Optional. Specifies the IPv6 ACP from which to clear the firewall sessions.

ahp Specifies Authentication Header (AH) Protocol.

esp Specifies Encapsulating Security Payload (ESP) Protocol.

gre Specifies Generic Routing Encapsulation (GRE) Protocol.

icmpv6 Specifies Internet Control Message Protocol (ICMP) version 6 (ICMPv6).

tcp Specifies Transmission Control Protocol (TCP).

udp Specifies User Datagram Protocol (UDP).

Command Reference Guide Enable Mode Command Set

<protocol> Specifies a protocol. Valid range is 0 to 255.

<ipv6 source> Specifies the source IPv6 address. IPv6 addresses should be expressed in

colon hexadecimal notation (X:X:X:X::X). For example, 2001:DB8:1::1.

<source port> Specifies the source port for TCP and UDP sessions. Range is 0 to 65535.

<ipv6 destination> Specifies the destination IPv6 address. IPv6 addresses should be

expressed in colon hexadecimal notation (X:X:X:X::X). For example,

2001:DB8:1::1.

<destination port> Specifies the destination port for TCP and UDP sessions. Range is 0 to

65535.

<interface> Specifies the interface when a link-local IPv6 address is entered (addresses

beginning with FE80::). Interfaces must be entered when using a link-local

address. Specify interfaces in the <interface> <slot/port | interface id>

format. For example, to specify a Point-to-Point Protocol (PPP) interface,

enter ppp 1.

<id> Specifies the ICMPv6 ID. Valid range is 0 to 65535.

<type/code> Specifies the type and code of the ICMPv6 session to be cleared. Type and

code ranges are 0 to 255.

vrf <name> Optional. Specifies the VRF instance to impact. Executing the

abovementioned commands without specifying a VRF will only affect the

default unnamed VRF.

Default Values

No default values are necessary for this command.

Command History

Release 18.1 Command was introduced.

Release R10.1.0 Command was expanded to include the tunnel interface and the pending

parameter.

Functional Notes

The second half of this command, beginning with the source IPv6 address, can be copied and pasted from

a row in the show ipv6 policy-sessions table for easier use.

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.

Command Reference Guide Enable Mode Command Set

Usage Examples

The following example clears the Telnet association (TCP port 23) for IPv6 ACP pclass1 with source IPv6

address FE80::2AO:C8FF:FE61:3082 and destination IPv6 address 2003::2AO:C8FF:FE61:3084.

Because the source IPv6 address is a link-local address (FE80::), the appropriate interface (in this case

ethernet 0/1) must be entered after the source IPv6 address. Enter the command as follows:

>enable

#clear ipv6 policy-sessions pclass1 tcp FE80::2AO:C8FF:FE61:3082 ethernet 0/1

2003::2AO:C8FF:FE61:3084

The following example clears all IPv6 policy class sessions for the VRF instance named RED:

>enable

#clear ipv6 policy-sessions vrf RED

Command Reference Guide Enable Mode Command Set

clear ipv6 policy-stats

Use the clear ipv6 policy-stats command to clear statistical counters for IPv6 access control policies

(ACPs). Variations of this command include:

clear ipv6 policy-stats

clear ipv6 policy-stats <ipv6 acp name>

clear ipv6 policy-stats <ipv6 acp name> entry <number>

Syntax Description

Optional. Specifies the IPv6 ACP statistics to clear. If no IPv6 ACP is specified,

statistics are cleared for all IPv6 ACPs.

entry <number>

Optional.

Specifies only a specific entry within the IPv6 ACP is cleared.

Number range is 1 to 4294967295.

Default Values

No default values are necessary for this command.

Command History

Release 18.1 Command was introduced.

Usage Examples

The following example clears statistical counters for all IPv6 ACPs:

>enable

#clear ipv6 policy-stats

The following example clears statistical counters for the IPv6 ACP MatchALL:

>enable

#clear ipv6 policy-stats MatchALL

The following example clears statistical counters for the 6th entry in the IPv6 ACP MatchALL:

>enable

#clear ipv6 policy-stats MatchALL entry 6

Command Reference Guide Enable Mode Command Set

clear ipv6 prefix-list <name>

Use the clear ipv6 prefix-list command to clear statistics associated with the Internet Protocol version 6

(IPv6) prefix list.

Syntax Description

<name> Clears the hit count statistics of the specified IPv6 prefix list.

Default Values

No default values are necessary for this command.

Command History

Release R10.1.0 Command was introduced.

Usage Examples

The following example clears the hit count statistics for the IPv6 prefix list TEST1:

>enable

#clear ipv6 prefix-list TEST1

Command Reference Guide Enable Mode Command Set

clear ipv6 routers

Use the clear IPv6 routers command to clear the Internet Protocol version 6 (IPv6) list of routers learned

from router advertisement (RA) messages from locally reachable routers. Variations of this command

include:

clear ipv6 routers

clear ipv6 routers conflict

clear ipv6 routers <interface>

clear ipv6 routers <interface> conflict

clear ipv6 routers vrf <name>

clear ipv6 routers vrf <name> conflict

Syntax Description

conflict Optional. Specifies that learned routers with misconfigurations are cleared

from locally reachable routers.

<interface> Optional. Specifies an interface from which to clear the learned router list. If

no interface is specified, learned routers on all interfaces of the VPN routing

and forwarding (VRF) are cleared. Specify interfaces in the <interface>

<slot/port | interface id> format. For example, to specify a Point-to-Point

Protocol (PPP) interface, enter ppp 1. Enter clear ipv6 routers ? for a list

of available interfaces.

vrf <name> Optional. Specifies a VRF on which to clear learned routers. If no VRF is

specified, learned routers for all interfaces on the default VRF are cleared.

Default Values

By default, all learned routers from all interfaces on the default VRF are cleared when no options are

specified.

Command History

Release 18.1 Command was introduced.

Release R10.1.0 Command was expanded to include the tunnel interface.

Usage Examples

The following example specifies that learned routers are cleared from all interfaces on the default VRF:

>enable

#clear ipv6 routers

Command Reference Guide Enable Mode Command Set

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

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 lldp counters

interface ? for a complete list of applicable interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet and Gigabit

Switchport interfaces.

Usage Examples

The following example resets all LLDP counters:

>enable

#clear lldp counters interface

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

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

No default values are necessary for this command.

Command History

Release 5.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 12.1 Command was introduced.

Usage Examples

The following example removes the entries in the multicast ARL table for VLAN 200:

>enable

#clear mac address-table multicast vlan 200

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 17.2 Command was introduced.

Usage Examples

The following example clears pending email body text for mail agent myagent:

>enable

#clear mail-client body myagent

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 17.2 Command was introduced.

Usage Examples

The following example clears all counters for all configured mail agents:

>enable

#clear mail-client counters

Command Reference Guide Enable Mode Command Set

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

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

Default Values

No default values are necessary for this command.

Command History

Release 17.8 Command was introduced.

Usage Examples

The following example clears all collected DHCP statistics for all clients:

>enable

#clear network-forensics ip dhcp

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

clear ntp

Use the clear ntp command to restart the Network Time Protocol (NTP) daemon.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 17.2 Command was introduced.

Usage Examples

The following example restarts the NTP daemon:

>enable

#clear ntp

Command Reference Guide Enable Mode Command Set

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

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 port-security

sticky interface ? or clear port-security dynamic interface ? for a

complete list of applicable interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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 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 port-security violation-count interface ? for a complete list of

applicable interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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 |

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 pppoe ? for a complete list of valid interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 5.1 Command was introduced.

Usage Examples

The following example ends the current PPPoE client session for ppp 1:

>enable

#clear pppoe 1

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 17.2 Command was introduced.

Usage Examples

The following example removes the TWAMP responder counters:

>enable

#clear probe responder twamp counters

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 5.1 Command was introduced.

Usage Examples

The following example resets the CPU maximum usage statistics:

>enable

#clear processes cpu max

Command Reference Guide Enable Mode Command Set

clear processes queue

Use the clear processes queue command to clear the contents of the system processing queues.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 5.1 Command was introduced.

Usage Examples

The following example clears the contents of the system processing queues:

>enable

#clear processes queue

Command Reference Guide Enable Mode Command Set

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> default

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.

default Optional. Clears the default QoS map entry.

interface <interface> Optional. Clears QoS map statistics 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 qos map interface ? for a complete list of applicable interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 6.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A5.01 Command was expanded to include the default parameter and Ethernet

interface.

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:

Command Reference Guide Enable Mode Command Set

#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).

Command Reference Guide Enable Mode Command Set

clear relay

Use the clear relay command to reset the door contact relay.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example resets the door contact relay:

>enable

#clear relay

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example clears all route map counters:

>enable

#clear route-map counters

Command Reference Guide Enable Mode Command Set

clear sip location <username>

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

Variations of this command include:

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example deletes all dynamic location entries:

>enable

#clear sip location *

Command Reference Guide Enable Mode Command Set

clear sip resources

Use the clear sip resources command to clear the counters for Session Initiation Protocol (SIP) resources

currently in use. Refer to show sip on page 737 for information about using the show sip resources

command to display the current SIP resource information.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 17.9 Command was introduced for AOS data products.

Release A4.01 Command was included for AOS voice products.

Usage Examples

The following example clears SIP server resource counters:

>enable

#clear sip resources

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example clears SIP registration information for trunk 01:

>enable

#clear sip trunk-registration T01

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example clears all SIP server registration information:

>enable

#clear sip user-registration

Command Reference Guide Enable Mode Command Set

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

<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 spanning-tree

counters ? for a complete list of interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 6.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Usage Examples

The following example clears the spanning tree counters for Ethernet 0/10:

>enable

#clear spanning-tree counters interface eth 0/10

Command Reference Guide Enable Mode Command Set

clear spanning-tree detected-protocols

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

Variations of this command include:

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

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 spanning-tree

detected-protocols interface ? for a complete list of applicable interfaces.

Default Values

No default values are necessary for this command.

Command History

Release 5.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

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

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example clears all TACACS+ protocol statistics:

>enable

#clear tacacs+ statistics

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example detaches the console 1 user:

>enable

#clear user console 1

Command Reference Guide Enable Mode Command Set

clear voice logging smdr

Use the clear voice logging smdr command to clear the local station messaging detail record (SMDR) log.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release A5.01 Command was introduced.

Usage Examples

The following example clears the SMDR log:

>enable

#clear voice logging smdr

Command Reference Guide Enable Mode Command Set

clear voice queue <extension>

Use the clear voice queue command to reset statistics for all call queues or the specified call queue.

Syntax Description

<extension> Indicates the extension of the call queue.

Default Values

No default values are necessary for this command.

Command History

Release A4.01 Command was introduced.

Usage Examples

The following example resets the statistics on the call queue on extension 6407:

>enable

#clear voice queue 6407

Command Reference Guide Enable Mode Command Set

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

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

No default values are necessary for this command.

Command History

Release 16.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet interface.

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

Command Reference Guide Enable Mode Command Set

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

Release 6.1 Command was introduced.

Usage Examples

The following example allows for automatic DST correction:

>enable

#clock auto-correct-dst

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 6.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

disable this feature.

Syntax Description

<value> Clock time zone values are specified in the Functional Notes section for this

command.

Default Values

No default values are necessary for this command.

Command History

Release 6.1 Command was introduced.

Release 11.1 Command was expanded to include the clock timezone 0.

Command Reference Guide Enable Mode Command Set

Functional Notes

The following list shows sample cities and their time zone codes.

clock timezone +1-Amsterdam

clock timezone +1-Belgrade

clock timezone +1-Brussels

clock timezone +1-Sarajevo

clock timezone +1-West-Africa

clock timezone +10-Brisbane

clock timezone +10-Canberra

clock timezone +10-Guam

clock timezone +10-Hobart

clock timezone +10-Vladivostok

clock timezone +11

clock timezone +12-Auckland

clock timezone +12-Fiji

clock timezone +13

clock timezone +2-Athens

clock timezone +2-Bucharest

clock timezone +2-Cairo

clock timezone +2-Harare

clock timezone +2-Helsinki

clock timezone +2-Jerusalem

clock timezone +3-Baghdad

clock timezone +3-Kuwait

clock timezone +3-Moscow

clock timezone +3-Nairobi

clock timezone +3:30

clock timezone +4-Abu-Dhabi

clock timezone +4-Baku

clock timezone +4:30

clock timezone +5-Ekaterinburg

clock timezone +5-Islamabad

clock timezone +5:30

clock timezone +5:45

clock timezone +6-Almaty

clock timezone +6-Astana

clock timezone +6-Sri-Jay

clock timezone +6:30

clock timezone +7-Bangkok

clock timezone +7-Kranoyarsk

clock timezone +8-Bejing

clock timezone +8-Irkutsk

clock timezone +8-Kuala-Lumpur

clock timezone +8-Perth

clock timezone +8-Taipei

clock timezone +9-Osaka

clock timezone +9-Seoul

clock timezone +9-Yakutsk

clock timezone +9:30-Adelaide

clock timezone +9:30-Darwin

clock timezone -1-Azores

clock timezone -1-Cape-Verde

clock timezone -10

clock timezone -11

clock timezone -12

clock timezone -2

clock timezone -3-Brasilia

clock timezone -3-Buenos-Aires

clock timezone -3-Greenland

clock timezone -3:30

clock timezone -4-Atlantic-Time

clock timezone -4-Caracus

clock timezone -4-Santiago

clock timezone -5

clock timezone -5-Bogota

clock timezone -5-Eastern-Time

clock timezone -6-Central-America

clock timezone -6-Central-Time

clock timezone -6-Mexico-City

clock timezone -6-Saskatchewan

clock timezone -7-Arizona

clock timezone -7-Mountain-Time

clock timezone -8

clock timezone -9

clock timezone 0-Universal Coordinated Time

(UTC)

clock timezone GMT-Casablanca

clock timezone GMT-Dublin

Command Reference Guide Enable Mode Command Set

Usage Examples

The following example sets the time zone for Santiago, Chile.

>enable

#clock timezone -4-Santiago

Command Reference Guide Enable Mode Command Set

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 852 for more information. Variations

of this command include:

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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example enters the Global Configuration mode from the Enable mode:

>enable

#configure terminal

(config)#

Command Reference Guide Enable Mode Command Set

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 <source file> <new file>

copy <source file> boot

copy <source file> default-config

copy <source file> fpga

copy <source file> interface <interface>

copy <source file> startup-config

Syntax Description

<source file> 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.

fpga Updates the field-programmable gate array (FPGA) using a copy of the

specified file.

interface <interface> Updates the specified interface using a copy of the specified file. 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

copy <source file> interface ? to display a list of valid interfaces.

startup-config Replaces the startup configuration with the specified file copied from flash

memory.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 16.1 Command was expanded to include the default-config.

Release 17.2 Command was expanded to include the cellular interface.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Command Reference Guide Enable Mode Command Set

Release A4.05 Command was expanded to include the asymmetric digital subscriber line

(ADSL) interface.

Release A5.01 Command was expanded to include the fpga parameter.

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 <source file> 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!!!!!

Command Reference Guide Enable Mode Command Set

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 <source file> boot

copy cflash <source file> cflash <new file>

copy cflash <source file> http <url> port <port>

copy cflash <source file> https <url> port <port>

copy cflash <source file> flash

copy cflash <source file> flash <new file>

copy cflash <source file> interface <interface>

copy cflash <source file> 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.

<source file> Specifies the name of the file (located on the CompactFlash card) to copy.

boot Copies the specified source file and overwrites the boot read only memory

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

interface <interface> Updates the specified interface using a copy of the specified file. 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

copy cflash <source file> 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.

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Release 16.1 Command was expanded to include HTTP and HTTPS.

Release 17.2 Command was expanded to include the cellular interface.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A4.05 Command was expanded to include the asymmetric digital subscriber line

(ADSL) interface.

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

Command Reference Guide Enable Mode Command Set

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!

>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:

Received 231424 bytes.

Transfer complete

Command Reference Guide Enable Mode Command Set

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 cflash <filename>

copy console cflash <filename> force-overwrite

copy console flash <filename>

copy console flash <filename> force-overwrite

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash dirve

capability) include:

copy console usbdrive0 <filename>

copy console usbdrive0 <filename> force-overwrite

Syntax Description

<filename> Copies the console input and saves it to flash memory using the specified

file name.

cflash <filename> Copies the console input and saves it to CompactFlash 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.

usbdrive0 <filename> Copies the console input and saves it to USB flash drive memory using the

specified file name.

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Release 18.2 Command was expanded to include USB flash drive memory.

Release R10.1.0 Command was expanded to include the cflash keyword.

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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:

Address of remote host: Specifies the IP address of the TFTP server.

Source filename: Specifies the name of the file (located on the

CompactFlash card) 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 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.

Command Reference Guide Enable Mode Command Set

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

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

Percent Complete 100%

The following example replaces the active running configuration with a copy of the dynamic voice

configuration file:

>enable

#copy dynvoice-config running-config

Percent Complete 100%

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

Initiating TFTP transfer...

Sent 5221 bytes.

Transfer complete.

Command Reference Guide Enable Mode Command Set

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

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:

Sent 5221 bytes.

Transfer complete

Command Reference Guide Enable Mode Command Set

copy flash

Use the copy flash command to copy files located in flash memory to a specified destination.

Variations of this command (valid on all AOS units) include:

copy flash tftp

copy flash xmodem

copy flash <source file> http <url> port <port>

copy flash <source file> https <url> port <port>

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> 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 only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

copy flash <source file> usbdrive0

copy flash <source file> usbdrive0 <new file>

Variations of this command (valid only on AOS units WITH field-programmable gate arrays (FPGAs))

include:

copy flash <source file> fpga

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.

boot Copies the specified source file and overwrites the boot read only memory

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

Command Reference Guide Enable Mode Command Set

flash Copies the specified file and saves it to flash memory.

fpga Copies the specified file and saves it as the FPGA image.

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.

interface <interface> Updates the specified interface using a copy of the specified file. 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

copy flash <source file> 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

Protocol (TFTP) server.

After entering copy flash 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 (located in flash

memory) 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.)

usbdrive0 <new file> Copies the specified file and saves it to USB flash drive memory.

xmodem Copies any file located in flash memory (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 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

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 16.1 Command was expanded to include HTTP and HTTPS.

Command Reference Guide Enable Mode Command Set

Release 17.2 Command was expanded to include the cellular interface.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A4.05 Command was expanded to include the asymmetric digital subscriber line

(ADSL) interface.

Release 18.2 Command was expanded to include USB flash drive memory.

Release A5.01 Command was expanded to include the fpga 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.txt (located in flash memory) to the startup

configuration:

>enable

#copy flash new_startup_config.txt 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

Initiating TFTP transfer...

Sent 769060 bytes.

Transfer Complete!

The following example copies the file myfile.biz (located in flash memory) to USB flash drive memory

(naming the new file newfile.biz):

>enable

#copy flash myfile.biz usbdrive0 newfile.biz

Command Reference Guide Enable Mode Command Set

The following example copies the software file myfile.biz (located in flash memory) to the connected

terminal using XMODEM protocol:

>enable

#copy flash 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:

Sent 231424 bytes.

Transfer complete

Command Reference Guide Enable Mode Command Set

copy http

Use the copy http command to copy a file located on a network Hypertext Transfer Protocol (HTTP)

server to a specified destination.

Variations of this command (valid on all AOS units) include:

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>

Variations of this command (valid only on AOS units WITH CompactFlash® capability) include:

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>

Variations of this command (valid only on AOS units WITH CompactFlash AND voice capability)

include:

copy http <url> dynvoice-config

Variations of this command (valid only on AOS units WITH ramdisk enabled) include:

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>

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

copy http <url> usbdrive0 <destination file>

copy http <url> usbdrive0 <destination file> force-overwrite

copy http <url> usbdrive0 <destination file> force-overwrite port <port>

copy http <url> usbdrive0 <destination file> port <port>

Command Reference Guide Enable Mode Command Set

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.

force-overwrite Optional. Specifies a force override to copy the file.

http <url> Specifies the URL of the HTTP server.

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.

usbdrive0 Copies a file from the HTTP server to the USB flash drive memory.

Default Values

By default, the port value is 80.

Command History

Release 16.1 Command was introduced.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release 18.2 Command was expanded to include the USB flash drive memory.

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

Received 4562 bytes.

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

Received 45647 bytes.

Transfer Complete!

Command Reference Guide Enable Mode Command Set

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.

Variations of this command (valid on all AOS units) include:

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 http <url> running-config

copy http <url> running-config port <port>

copy http <url> startup-config

copy http <url> startup-config port <port>

Variations of this command (valid only on AOS units WITH CompactFlash® capability) include:

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>

Variations of this command (valid only on AOS units WITH CompactFlash AND voice capability)

include:

copy https <url> dynvoice-config

Variations of this command (valid only on AOS units WITH ramdisk enabled) include:

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>

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

copy https <url> usbdrive0 <destination file>

copy https <url> usbdrive0 <destination file> force-overwrite

copy https <url> usbdrive0 <destination file> force-overwrite port <port>

copy https <url> usbdrive0 <destination file> port <port>

Command Reference Guide Enable Mode Command Set

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.

force-overwrite Optional. Specifies a force override to copy the file.

https <url> Specifies the URL of the HTTP secure server.

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.

usbdrive0 Copies a file from the HTTP secure server to the USB flash drive memory.

Default Values

By default, the port value is 443.

Command History

Release 16.1 Command was introduced.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release 18.2 Command was expanded to include USB flash drive memory.

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

Received 4562 bytes.

Transfer Complete!

The following example copies the file myfile.biz from the HTTPS server (10.200.2.4) and saves it

CompactFlash memory (naming the copy newfile.biz):

#copy https https://10.200.2.4/myfile.biz cflash newfile.biz

Initiating HTTPS transfer...

Received 45647 bytes.

Transfer Complete!

Command Reference Guide Enable Mode Command Set

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

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

specified file name.

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:

Address of remote host: Specifies the IP address of the TFTP server.

Source filename: Specifies the name of the file (located on the

RAM disk) 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.)

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.

Command Reference Guide Enable Mode Command Set

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:

Source filename: Specifies the name of the file (located on the

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

No default values are necessary for this command.

Command History

Release 17.7 Command was introduced.

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

Address of remote host? 10.200.2.4

Source filename? myfile.biz

Destination filename? myfile.biz

Initiating TFTP transfer...

Sent 769060 bytes.

Transfer Complete!

Command Reference Guide Enable Mode Command Set

The following example copies the software file myfile.biz (located on the RAM disk) to the connected

terminal using XMODEM protocol:

>enable

#copy ramdisk 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:

Sent 231424 bytes.

Transfer complete

Command Reference Guide Enable Mode Command Set

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.

Variations of this command (valid on all AOS units) include:

copy running-config <filename>

copy running-config http <url>

copy running-config https <url>

copy running-config tftp

copy running-config xmodem

Variations of this command (valid only on AOS units WITH CompactFlash® capability) include:

copy running-config cflash <filename>

copy running-config cflash startup-config

copy running-config flash <filename>

copy running-config flash startup-config

Variations of this command (valid only on AOS units WITH CompactFlash AND voice capability)

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 WITH ramdisk enabled) include:

copy running-config ramdisk <filename>

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

copy running-config usbdrive0 <filename>

copy running-config usbdrive0 startup-config

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.

Command Reference Guide Enable Mode Command Set

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:

Address of remote host: Specifies the IP address of 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.)

usbdrive0 Copies current running configuration to the USB flash drive memory.

xmodem Copies the current running configuration (using the XMODEM protocol) to

the terminal connected to the console port. XMODEM capability is provided

in VT100 terminal emulation software, such as HyperTerminal.

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Release 16.1 Command was expanded to include HTTP and HTTPS.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release 18.2 Command was expanded to include USB flash drive memory.

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!

Command Reference Guide Enable Mode Command Set

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

Address of remote host? 10.200.2.4

Destination filename? config_01.txt

Initiating TFTP transfer...

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

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:

Sent 3704 bytes.

Transfer complete

Command Reference Guide Enable Mode Command Set

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 on all AOS units) include:

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

Variations of this command (valid only on AOS units WITH CompactFlash® capability) include:

copy startup-config cflash <filename>

copy startup-config flash <filename>

Variations of this command (valid only on AOS units WITH ramdisk enabled) include:

copy startup-config ramdisk <filename>

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

copy startup-config usbdrive0 <filename>

Syntax Description

cflash Copies the startup configuration and saves it to the CompactFlash card

using the specified file name.

flash Copies the startup configuration and saves it to flash memory using the

specified file name.

<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

Protocol (HTTP) server using the specified HTTP server uniform resource

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

specified file name.

running-config Merges the current running configuration with the startup configuration.

Command Reference Guide Enable Mode Command Set

tftp Copies the current startup configuration to a specified Trivial File Transfer

Protocol (TFTP) server.

After entering copy startup-config tftp, AOS prompts for the following

information:

Address of remote host: Specifies the IP address of 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.)

usbdrive0 Copies the startup configuration and saves it to the USB flash drive memory

using the specified file name.

xmodem Copies the current startup configuration (using the XMODEM protocol) to

the terminal connected to the console port. XMODEM capability is provided

in VT100 terminal emulation software, such as HyperTerminal.

Default Values

No default values are necessary for this command.

Command History

Release 8.1 Command was introduced.

Release 16.1 Command was expanded to include HTTP and HTTPS.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release 18.2 Command was expanded to include USB flash drive memory.

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

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

Percent Complete 100%

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.

Command Reference Guide Enable Mode Command Set

The following example copies the current startup configuration to a TFTP server and names the file

startup_01.txt:

>enable

#copy startup-config tftp

Address of remote host? 10.200.2.4

Destination filename? startup_01.txt

Initiating TFTP transfer...

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

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:

Sent 3704 bytes.

Transfer complete

Command Reference Guide Enable Mode Command Set

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.

Variations of this command (valid on all AOS units) include:

copy tftp flash

copy tftp running-config

copy tftp startup-config

Variations of this command (valid only on AOS units WITH CompactFlash® capability) include:

copy tftp cflash

Variations of this command (valid only on AOS units WITH CompactFlash AND voice capability)

include:

copy tftp dynvoice-config

Variations of this command (valid only on AOS units WITH ramdisk enabled) include:

copy tftp ramdisk

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

copy tftp usbdrive0

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:

Address of remote host: Specifies the IP address of the TFTP server.

Source filename: Specifies the name of the file to copy from the

TFTP server.

Destination filename: Specifies the file name to use when storing the

copied file. (Valid only for the copy tftp cflash,

copy tftp flash, copy tftp ramdisk commands.)

Command Reference Guide Enable Mode Command Set

usbdrive0 Copies a file from the TFTP server to the USB flash drive memory.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release 18.2 Command was expanded to include USB flash drive memory.

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

Address of remote host? 10.200.2.4

Source filename? newconfig.txt

Initiating TFTP transfer...

Received 4562 bytes.

Transfer Complete!

The following example copies the file myfile.biz from the TFTP server (10.200.2.4) and saves it

CompactFlash memory (naming the copy newfile.biz):

#copy tftp cflash

Address of remote host? 10.200.2.4

Source filename? myfile.biz

Destination filename? newfile.biz

Initiating TFTP transfer...

Received 45647 bytes.

Transfer Complete!

Command Reference Guide Enable Mode Command Set

copy usbdrive0

Use the copy usbdrive0 command to copy files located in Universal Serial Bus (USB) flash drive memory

to a specified destination.

Variations of this command include:

copy usbdrive0 <source file> boot

copy usbdrive0 <source file> flash

copy usbdrive0 <source file> flash <new file>

copy usbdrive0 <source file> http <url>

copy usbdrive0 <source file> http <url> port <port>

copy usbdrive0 <source file> https <url>

copy usbdrive0 <source file> https <url> port <port

copy usbdrive0 <source file> startup-config

copy usbdrive0 <source file> usbdrive0 <new file>

copy usbdrive0 tftp

copy usbdrive0 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.

boot Copies the specified source file and overwrites the boot read only memory

(ROM).

flash Copies the specified file and saves it to flash memory.

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.

iport <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 file with a copy of the specified file.

tftp Copies any file located in USB flash drive memory to a specified Trivial File

Transfer Protocol (TFTP) server.

After entering copy usbdrive0 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 (located in USB flash

drive memory) 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.)

Command Reference Guide Enable Mode Command Set

usbdrive0 <new file> Copies the specified file and saves it to USB flash drive memory.

xmodem Copies any file located in USB flash drive memory (using the XMODEM

protocol) to the PC connected to the console port. XMODEM capability is

provided in VT100 terminal emulation software, such as HyperTerminal.

After entering copy flash xmodem, AOS prompts for the following

information:

Source filename: Specifies the name of the file to copy from USB

flash drive memory using XMODEM.

Default Values

No default values are necessary for this command.

Command History

Release 18.2 Command was introduced.

Usage Examples

The following example creates a copy of the file myfile.biz (located in USB flash drive memory), names

the new file newfile.biz, and places the new file in flash memory:

>enable

#copy usbdrive0 myfile.biz flash newfile.biz

The following example copies the file myfile.biz (located in USB flash drive memory) to CompactFlash

memory (naming the new file newfile.biz):

>enable

#copy usbdrive0 myfile.biz cflash newfile.biz

The following example copies the file new_startup_config.txt (located in USB flash drive memory) to the

startup configuration:

>enable

#copy usbdrive0 new_startup_config.txt startup-config

Command Reference Guide Enable Mode Command Set

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.

Variations of this command (valid only on AOS units WITH CompactFlash® capability) include:

copy xmodem cflash

Variations of this command (valid only on AOS units WITH CompactFlash AND voice capability)

include:

copy xmodem dynvoice-config

Variations of this command (valid only on AOS units WITH ramdisk enabled) include:

copy xmodem ramdisk

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

copy xmodem usbdrive0

Variations of this command (valid on all AOS units) include:

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:

Destination filename: Specifies the file name to use when storing the

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:

Destination filename: Specifies the file name to use when storing the

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.

Command Reference Guide Enable Mode Command Set

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.

usbdrive0 Copies a file from the terminal connected to the console port and saves it to

the USB flash drive memory.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release 18.2 Command was expanded to include USB flash drive memory.

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

Begin the Xmodem transfer now...

Press CTRL+X twice to cancel

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:

Received 531424 bytes.

Transfer complete

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 5.1 Command was introduced.

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)'.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

<name> Specifies a configured ACL.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 6.1 Command was introduced.

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 IPv4 Access Control List Command Set on page 3126.

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)

2009.06.09 14:15:13 ACCESS_LIST.MatchAll permit host 192.168.0.1 log (3 matches)

2009.06.09 14:15:57 ACCESS_LIST.MatchAll permit host 192.168.0.1 log (1 matches)

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 9.3 Command was introduced.

Usage Examples

The following example activates debug messages associated with ARP transactions:

>enable

#debug arp

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example activates ATM event messages:

>enable

#debug atm events

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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>

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

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example activates ATM OAM debug messages for VCD 1:

>enable

#debug atm oam 1

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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>

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

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example activates debug ATM packet debug messages on ATM port 1:

>enable

#debug atm packet interface atm 1

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates debug messages associated with automatic configuration events:

>enable

#debug auto-config

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug auto-link

Use the debug auto-link command to display event messages for the auto-link feature configuration.

Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form of this

command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.3/A2 Command was introduced.

Usage Examples

The following example activates auto-link debug messages:

>enable

#debug auto-link

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug bgp

Use the debug bgp command to activate debug messages associated with Internet Protocol version 4

(IPv4) Border Gateway Protocol (BGP). Debug messages display general BGP events, such as sent and

received message summaries, route processing actions, and results. These 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 bgp

debug bgp events

debug bgp in

debug bgp out

debug bgp keepalives

debug bgp scan

debug bgp scan database

debug bgp scan route-table

debug bgp scan soft-reset

debug bgp updates

debug bgp updates quiet

Syntax Description

events Optional. Displays significant BGP events, such as a neighbor state

change.

in/out Optional. Displays the same information as debug bgp, but limits

messages to the specified direction (in or out).

keepalives Optional. Displays BGP keepalive packets.

scan Optional. Displays BGP background scan details.

database Optional. Limits output to BGP database scan details.

route-table Optional. Limits output to BGP route table scan details.

soft-reset Optional. Limits output to BGP soft reset scan details.

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

By default, all debug messages in AOS are disabled.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

Command History

Release 8.1 Command was introduced.

Release 18.3 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN internetworking products. In addition, the scan, database,

route-table, and soft-reset parameters were added.

Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN voice products.

Functional Notes

If no arguments are given, the debug 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 bgp out

07:42:39: BGP OUT 10.15.240.1[2]: Transmitting msg, type=UPDATE (2), len=142

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example activates bridge debug messages:

>enable

#debug bridge

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Use the no form of this command to disable the debug messages.

Syntax Description

<chat interface> Activates debug messages for the specified chat interface identified by the

slot/port.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates debug messages for the chat interface 0/1:

>enable

#debug chat-interfaces 0/1

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 16.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 4.1 Command was introduced.

Release 6.1 Debug pki command was introduced.

Usage Examples

The following example activates the IPsec debug messages:

>enable

#debug crypto ipsec

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates debug messages associated with data call errors and events:

>enable

#debug data-call

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates demand routing error and event messages:

>enable

#debug demand-routing

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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>

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

in dotted decimal notation (for example, 10.10.10.1).

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:

xx:xx:xx:xx:xx:xx (for example, 00:A0:C8:00:00:01).

Default Values

No default values are necessary for this command.

Command History

Release 17.8 Command was introduced.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

2009.08.31 14:30:31 DESKTOP_AUDITING.DHCP.giga-swx 0/5 from 00:E0:29:0E:D5:E3 to

00:E0:29:0E:D5:E5 NAP SoH: Firewall is 3rd-Party, AutoUpdates not downloading or installing

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 SoHR: OK

Command Reference Guide Enable Mode Command Set

debug dial-backup

Use the debug dial-backup command to activate debug messages associated with dial-backup 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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 1.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 2.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug dns-client

Use the debug 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)

screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 3.1 Command was introduced.

Release 18.3 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN voice products.

Functional Notes

The debug dns-client command activates debug messages to provide information on DNS client activity

in AOS. The IPv4 and IPv6 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 dns-client

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug dns-proxy

Use the debug 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)

screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 3.1 Command was introduced.

Release 18.3 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN voice products.

Functional Notes

The debug 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 dns-proxy

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug dns-table

Use the debug 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)

screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 15.1 Command was introduced.

Release 18.3 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN voice products.

Functional Notes

The debug 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 dns-table

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug dot11 all

Use the debug dot11 all command to enable all dot11 debugging for the wireless access controller (AC).

Debug messages are displayed (real time) on the terminal (or Telnet) screen. Use the no form of this

command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 15.1 Command was introduced.

Usage Examples

The following example activates all dot11 debug messages on the AC:

>enable

#debug dot11 all

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

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 dot11 client

debug dot11 client interface dot11ap <ap interface>

Syntax Description

interface dot11ap <ap interface> Optional. Activates debug messages for the specified AP interface.

Range is 1 to 8.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 15.1 Command was introduced.

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.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

These debug messages were captured as a wireless client associated and then

disassociated with the AP.

Command Reference Guide Enable Mode Command Set

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.

Variations of this command include:

debug dot11 packet-events

debug dot11 packet-events interface <interface>

Syntax Description

interface <interface> Optional. Activates debug messages 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

debug dot11 packet-events interface ? for a complete list of valid

interfaces.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 15.1 Command was introduced.

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)

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

this command include:

debug dot11 session

debug dot11 session interface <interface>

Syntax Description

interface <interface> Optional. Activates debug messages 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

debug dot11 session interface ? for a complete list of valid interfaces.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 15.1 Command was introduced.

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.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Syntax Description

verbose Optional. Activates detailed debug messages.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates dynamic DNS debug messages:

>enable

#debug dynamic-dns verbose

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug efm config

Use the debug efm config command to enable debug messaging for all Ethernet in the first mile (EFM)

components configured on the unit. Debug messages are displayed (real time) to the terminal (or Telnet)

screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release A4.05 Command was introduced.

Usage Examples

The following example enables debug messaging for all EFM components:

>enable

#debug efm config

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug efm oam

Use the debug efm oam command to enable debug messaging for all Ethernet in the first mile (EFM)

operations, administration, and management (OAM) and pre-provisioning components configured on the

unit. Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form of this

command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release A4.05 Command was introduced.

Usage Examples

The following example enables debug messaging for all EFM OAM components:

>enable

#debug efm oam

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.4 Command was introduced.

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 online at https://supportforums.adtran.com

(article number 3013).

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)

2008.09.22 11:00:09 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

2008.09.22 11:00:10 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=196)

2008.09.22 11:00:10 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

2008.09.22 11:00:11 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=197)

2008.09.22 11:00:11 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

2008.09.22 11:00:12 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=198)

2008.09.22 11:00:12 CFM.MD MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

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.

Command Reference Guide Enable Mode Command Set

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.

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.4 Command was introduced.

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 online at https://supportforums.adtran.com

(article number 3013).

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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>

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.4 Command was introduced.

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 online at https://supportforums.adtran.com

(article number 3013).

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

2008.09.22 11:02:50 CFM.CCR MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

2008.09.22 11:02:51 CFM.CCR MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

2008.09.22 11:02:52 CFM.CCR MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

2008.09.22 11:02:53 CFM.CCR MD:BenchTest|MA:BenchAssoc|MEP:1|CCR|Rx CCM from MEPID 2

Command Reference Guide Enable Mode Command Set

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>

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.4 Command was introduced.

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 online at https://supportforums.adtran.com

(article number 3013).

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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)

2008.09.22 11:01:44 CFM.CCM MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=291)

2008.09.22 11:01:45 CFM.CCM MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=292)

2008.09.22 11:01:46 CFM.CCM MD:BenchTest|MA:BenchAssoc|MEP:1|CCM|Sent CCM (ID=293)

Command Reference Guide Enable Mode Command Set

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>

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>

mep <mep id>

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.4 Command was introduced.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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 online at https://supportforums.adtran.com

(article number 3013).

Usage Examples

The following example enables Ethernet OAM CFM debug messages for all linktrace message request

paths:

>enable

#debug ethernet cfm linktrace request

Command Reference Guide Enable Mode Command Set

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

form of this command to disable the debug messages. Variations of this command include:

debug ethernet cfm loopback request

debug ethernet cfm loopback request domain <domain 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>

mep <mep id>

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.4 Command was introduced.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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 online at https://supportforums.adtran.com

(article number 3013).

Usage Examples

The following example enables Ethernet OAM CFM debug messages for all loopback message request

paths:

>enable

#debug ethernet cfm loopback request

Command Reference Guide Enable Mode Command Set

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)

screen. Use the no form of this command to disable the debug messages. Variations of this command

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>

mep <mep id>

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.4 Command was introduced.

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 online at https://supportforums.adtran.com

(article number 3013).

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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)

Command Reference Guide Enable Mode Command Set

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

form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 1.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Syntax Description

<interface> Optional. Activates debug messages 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

debug frame-relay multilink ? for a complete list of applicable interfaces.

states Optional. Activates the debug messages for Link Integrity Protocol (LIP).

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 9.1 Command was introduced.

Usage Examples

The following example activates debug messages associated with multilink operation for all Frame Relay

interfaces:

>enable

#debug frame-relay multilink

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

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

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)

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this

command include:

debug gvrp interface <interface> bpdus

debug gvrp interface <interface> vlans

Syntax Description

<interface> Activates debug messages 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 debug gvrp

interface ? for a complete list of applicable interfaces.

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

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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)

screen. Use the no form of this command to disable the debug messages. Variations of this command

include:

debug gvrp vlans

debug gvrp vlans <vlan id>

Syntax Description

<vlan id> Optional. Activates debug messages for GVRP-related VLAN changes for

the specified VLAN. Range is 1 to 4094.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

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

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug hmr

Use the debug hmr command to enable debug messaging for either Session Initiation Protocol (SIP)

header manipulation rules (HMR) processes or rules. Use the no form of this command to disable debug

messaging. Variations of this command include:

debug hmr

debug hmr configuration

debug hmr traffic

Syntax Description

configuration Optional. Specifies that whenever HMR configuration changes, debug

messages outlining HMR rule configuration events are generated.

traffic Optional. Specifies that whenever HMR policies are applied to traffic, debug

messages outlining HMR message processing events are generated.

Default Values

By default, debug messaging is disabled. When HMR debug messaging is enabled, if neither optional

keyword is specified when the command is entered, then HMR debug messages are generated on any

HMR rule changes that occur.

Command History

Release R10.1.0 Command was introduced.

Usage Examples

The following example enables debug messaging for HMR policies and their application to SIP traffic:

>enable

#debug sip stack messages

#debug hmr traffic

00:52:13.323 SIP.STACK MSG Rx: UDP src=10.17.142.1:5060 dst=10.17.142.252:5060

00:52:13.323 SIP. STACK MSG INVITE sip:2565550052@10.17.142.252 SIP /2.0

00:52:13.324 SIP. STACK MSG Via: SIP/2.0/UDP

10.17.142.1:5060;branch=z9hG4bk-2834-1-0

00:52:13.324 SIP. STACK MSG From: 2565550052

<sip:256555052@10.17.142.1:5060;tag=2384SIPpTag001>

00:52:13.325 SIP. STACK MSG To: 2565550051

<sip:2565550051@10.17.142.252:5060>

00:52:13.325 SIP. STACK MSG Call-ID: 1-2384@10.17.142.1

00:52:13.326 SIP.STACK MSG

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

CSeq: 1 INVITE

00:52:13.327 SIP.STACK MSG

Contact: 2565550052 <sip:2565550052@10.17.142.1:5060;transport=UDP>

00:52:13.327 SIP.STACK MSG

Max-forwards: 70

00:52:13.328 SIP.STACK MSG

Content-Type: application/sdp

00:52:13.328 SIP.STACK MSG

Content-Length: 132

00:52:13.329 SIP.STACK MSG

v=0

00:52:13.329 SIP.STACK MSG

o=user1 53655765 2353687637 IN IP4 10.17.142.1

00:52:13.330 SIP.STACK MSG

s=-

00:52:13.330 SIP.STACK MSG

c=IN IP4 10.17.142.1

00:52:13.331 SIP.STACK MSG

t=0 0

00:52:13.332 SIP.STACK MSG

m=audio 10000 RTP/AVP 0

00:52:13.332 SIP.STACK MSG

a-rtpmap:0 PCMU/8000

00:52:13.332 SIP.STACK MSG

00:52:13.337 SIP.HMR PROCESS

Processing SIP message with compiled policy myPolicy

00:52:13.337 SIP.HMR PROCESS

Rule matches message, applying action rules

00:52:13.338 SIP.HMR PROCESS

Modifying SIP message headers matching from

00:52:13.338 SIP.HMR PROCESS

Header From: changed to 2565550052 <sip:2565550052@10.17.142.1:5060>;tag=2384SIPpTag001

00:52:13.339 SIP.HMR PROCESS

Found 1 headers: Modified 1 headers using /(.*)(;tag.*)/

Command Reference Guide Enable Mode Command Set

debug http client

Use the debug 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

Telnet) screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 16.1 Command was introduced.

Release 18.3 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN voice products.

Usage Examples

The following example activates debug messages associated with HTTP client activity:

>enable

#debug http client

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug http server

Use the debug 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

Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this

command include:

debug http server

debug http server verbose

Syntax Description

verbose Optional. Activates detailed debug messages for HTTP operation.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 6.1 Command was introduced.

Release 15.1 Command was updated.

Release 18.3 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support

in ADTRAN voice products.

Usage Examples

The following example activates debug messages associated with HTTP server activity:

>enable

#debug http server

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

<name> Specifies the name of the hardware ACL.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.6 Command was introduced.

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

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)

2009.05.07 11:32:45 ACCESS_LIST.ADTN permit mac 00:a0:c8:00:00:00 00:00:00:ff:ff:ff any log

(106 matches)

2009.05.07 11:32:49 ACCESS_LIST.ADTN permit mac 00:a0:c8:00:00:00 00:00:00:ff:ff:ff any log

(90 matches)

Turning on a large amount of debug information can adversely affect the performance of

your unit.

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.

Command Reference Guide Enable Mode Command Set

debug interface <interface>

Use the debug interface command to activate debug messages associated with the specified 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.

Syntax Description

<interface> Activates debug messages 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 debug

interface ? for a complete list of applicable interfaces.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 3.1 Command was introduced.

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.

Release A4.05 Command was expanded to include the asymmetric digital subscriber line

(ADSL) interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet 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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 9.1 Command was introduced.

Usage Examples

The following example activates debug messages for ADSL events:

>enable

#debug interface adsl events

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

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

By default, all debug messages in AOS are disabled.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

Command History

Release 17.2 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

debug ip dhcp client

Use the debug ip dhcp client command to activate debug messages associated with Dynamic Host

Configuration Protocol version 4 (DHCPv4) client operation in AOS. 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 dhcp client

debug ip dhcp client <interface>

Syntax Description

<interface> Optional. Specifies an interface to which an IPv4 address can be assigned

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 2.1 Command was introduced.

Release 16.1 Command was expanded to include the interface parameter.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release 18.3 Command syntax was changed to remove the hyphen (from dhcp-client)

for ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the hyphen (from dhcp-client)

for ADTRAN voice products.

Functional Notes

The debug ip dhcp client command activates debug messages to provide information on DHCPv4 client

activity in AOS. The AOS DHCPv4 client capability allows interfaces to dynamically obtain an IPv4 address

from a network DHCPv4 server.

Usage Examples

The following example activates debug messages associated with DHCPv4 client activity:

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

>enable

#debug ip dhcp client

Command Reference Guide Enable Mode Command Set

debug ip dhcp relay

Use the debug ip dhcp relay command to activate debug messages associated with Dynamic Host

Configuration Protocol version 4 (DHCPv4) relay operation in AOS. 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 dhcp relay

debug ip dhcp relay vrf <name>

Syntax Description

vrf <name> Optional. Displays debug information for the specified VPN routing and

forwarding (VRF) instance.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 18.2 Command was introduced.

Release 18.3 Command syntax was changed to remove the hyphen (from dhcp-relay)

for ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the hyphen (from dhcp-relay)

for ADTRAN voice products.

Functional Notes

The debug ip dhcp relay command activates debug messages to provide information on DHCPv4 relay

activity in AOS. The AOS DHCPv4 relay capability allows AOS to relay DHCPv4 messages to a configured

destination on the network.

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 example activates debug messages associated with DHCPv4 server activity only on the

default VRF instance:

>enable

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

#debug ip dhcp relay

Command Reference Guide Enable Mode Command Set

debug ip dhcp server

Use the debug ip dhcp server command to activate debug messages associated with Dynamic Host

Configuration Protocol version 4 (DHCPv4) server operation in AOS. 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 dhcp server

debug ip dhcp server vrf <name>

Syntax Description

vrf <name> Optional. Displays debug information for the specified VPN routing and

forwarding (VRF) instance.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 2.1 Command was introduced.

Release 17.1 Command was expanded to include the vrf parameter.

Release 18.3 Command syntax was changed to remove the hyphen (from dhcp-server)

for ADTRAN internetworking products.

Release R10.1.0 Command syntax was changed to remove the hyphen (from dhcp-server)

for ADTRAN voice products.

Functional Notes

The debug ip dhcp server command activates debug messages to provide information on DHCPv4

server activity in AOS. The AOS DHCPv4 server capability allows AOS to dynamically assign IPv4

addresses to hosts on the network.

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 example activates debug messages associated with DHCPv4 server activity only on the

default VRF instance:

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

>enable

#debug ip dhcp server

Command Reference Guide Enable Mode Command Set

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

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

Release 16.1 Command was introduced.

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)

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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: ^Idle 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: ^Idle Time = 60, Active Time = 90

The following is sample output 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>

Command Reference Guide Enable Mode Command Set

debug ip firewall

Use the debug ip firewall command to activate debug messages associated with the AOS Internet Protocol

version 4 (IPv4) firewall 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 ip firewall

debug ip firewall vrf <name>

Syntax Description

vrf <name> Optional. Displays debug information for the specified VPN routing and

forwarding (VRF) instance.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 2.1 Command was introduced.

Release 17.1 Command was expanded to include the vrf parameter.

Release 17.9 Command was changed to require the ip keyword for ADTRAN

internetworking products only.

Release R10.1.0 Command was changed to require the ip keyword for ADTRAN voice

products.

Functional Notes

The debug ip firewall command activates debug messages to provide real-time information about the

IPv4 AOS stateful inspection firewall operation.

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 example activates the debug messages for the IPv4 AOS stateful inspection firewall:

>enable

#debug ip firewall

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

The following example activates the IPv4 firewall debug messages for the VRF instance gray and provides

sample output:

>enable

#debug ip 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

Command Reference Guide Enable Mode Command Set

debug ip firewall alg sip

Use the debug ip 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

terminal (or Telnet) screen. Use the no form of this command to disable the debug messages. Variations of

this command include:

debug ip firewall alg sip

debug ip firewall alg sip packets

debug ip firewall alg sip verbose

Syntax Description

packets Optional. Activates firewall application-level gateway (ALG) SIP packet

debug messages.

verbose Optional. Activates detailed debug messages.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 9.3 Command was introduced.

Release A1 Command was expanded to include the packets parameter.

Release 17.9 Command was changed to require the ip keyword for ADTRAN

internetworking products only.

Release R10.1.0 Command was changed to require the ip keyword for ADTRAN voice

products.

Usage Examples

The following example activates debug messages associated with SIP information with AOS firewall

operation:

>enable

#debug ip firewall alg sip

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 13.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ip icmp

Use the debug ip icmp command to show all Internet Control Message Protocol (ICMP) version 4

(ICMPv4) 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 no form of this command to disable the debug messages. Variations of

this command include:

debug ip icmp

debug ip icmp send

debug ip icmp recv

Syntax Description

send

Optional. Displays only ICMPv4 messages sent by the router.

recv

Optional. Displays only ICMPv4 messages received by the router.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 3.1 Command was introduced.

Usage Examples

The following example activates the debug ip icmp send and receive messages for ICMPv4 in 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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

(or Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this

command include:

debug ip igmp

debug ip igmp <ip address>

Syntax Description

<ip address> Optional. Specifies the

IP address of a multicast group.

IP addresses should

be expressed in dotted decimal notation (for example, 10.10.10.1).

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 7.1 Command was introduced.

Usage Examples

The following example enables IGMP debug messages for the specified multicast group:

>enable

#debug ip igmp 224.1.1.1

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this

command include:

debug ip igmp snooping

debug ip igmp snooping verbose

Syntax Description

verbose Optional. Enables detailed debug messages

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 12.1 Command was introduced.

Usage Examples

The following example enables IGMP snooping debug messages:

>enable

#debug ip igmp snooping

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ip mrouting

Use the debug ip mrouting command to activate debug messages associated with multicast table routing

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 10.1 Command was introduced.

Usage Examples

The following sample activates ip mrouting debug messages:

>enable

#debug ip mrouting

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 3.1 Command was introduced.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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

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>

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

By default, all debug messages in AOS are disabled.

Command History

Release 12.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

Functional Notes

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

IP: s= 192.168.7.2 (eth 0/2) d=192.168.8.101 (eth 0/1) g= 192.168.8.101, forward

IP: s= 192.168.8.101 (eth 0/1) d=192.168.7.2 (eth 0/2) g= 192.168.7.2, forward

IP: s= 192.168.7.2 (eth 0/2) d=192.168.8.101 (eth 0/1) g= 192.168.8.101, 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.

Command Reference Guide Enable Mode Command Set

The following is sample output for the debug ip packet 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.101 (eth 0/1.4) d=192.168.1.1 (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

IP: s=192.168.1.100 (eth 0/1.4) d=192.168.1.1 (Loopback), vrf=RED, rcvd

IP: s=192.168.1.1 (Loopback) d=192.168.1.100 (eth 0/1.4) g=192.168.1.100, 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.1.101 (eth 0/1.4) d=255.255.255.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

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

IP: s=192.168.1.101 (eth 0/1.4) d=192.168.1.1 (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:

if the vrf=<name> statement is not present, the packet was present on the default VRF.

vrf=<name> indicates the nondefault 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.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates all PIM sparse mode messages:

>enable

#debug ip pim-sparse

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Variations of this command include:

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>

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

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

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

14:25:29: PIMSM: Assert - MRoute (*, 239.192.19.136, eth 0/2) processed Received Join in NoInfo state

14:26:05: PIMSM: Assert - MRoute (*, 239.255.255.250, eth 0/2) processed Received Join in NoInfo state

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates PIM sparse mode hello messages:

>enable

#debug ip pim-sparse hello

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this

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>

Syntax Description

event Optional. Displays PIM sparse join and prune events.

state Optional. Displays PIM sparse join and prune 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

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

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:29: PIMSM: Processed JOIN(*, 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

14:28:05: PIMSM: Processed JOIN(*, 239.255.255.250) from 10.10.10.2

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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>

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 |

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 debug ip pim-sparse packets ? for a list of valid

interfaces.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release A5.01 Command was expanded to include the Gigabit Ethernet interface.

Usage Examples

The following example activates all PIM sparse packet messages (both inbound and outbound):

>enable

#debug ip pim-sparse packets

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Use the no form of this command to disable the debug messages. Variations of this command include:

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>

Syntax Description

event Optional. Displays PIM sparse register events.

state Optional. Displays PIM sparse register 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

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

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

18:14:53: PIMSM: RegisterStop(10.100.13.240, 239.192.19.136) sent to 10.10.10.1

18:16:17: PIMSM: RegisterStop(10.100.13.240, 239.192.19.136) sent to 10.10.10.1

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ip policy

Use the debug ip policy command to display policy-based routing 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. Variations of this command include the following:

debug ip policy

debug ip policy <acl name>

Syntax Description

<acl name> Optional. Displays debug information only for the specified access control

list (ACL).

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

the no form of this command to disable the debug messages. Variations of this command include:

debug ip rip

debug ip rip events

Syntax Description

events Optional.

Displays only RIP protocol events.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 1.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ip route-cache express

Use the debug ip route-cache express command to activate debug messages associated with Layer 3

switching.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.5 Command was introduced.

Usage Examples

The following is sample output for this command:

>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 added: IP=192.168.3.10, MAC=00:10:95:00:00:01, Vlan=3

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.7.10, MAC=00:10:97:00:00:01, Vlan=7

xRt: host entry added: IP=192.168.9.10, MAC=00:10:98:00:00:01, Vlan=9

xRt: host entry added: IP=192.168.11.10, MAC=00:10:99:00:00:01, Vlan=11

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 ARP events, with 605 remaining

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: Processed 10 ARP events, with 228 remaining

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

xRt: ARP entry for 192.168.3.10 was updated

xRt: ARP entry for 192.168.3.11 was updated

xRt: ARP entry for 192.168.3.12 was updated

xRt: ARP entry for 192.168.3.13 was updated

xRt: ARP entry for 192.168.3.14 was updated

Command Reference Guide Enable Mode Command Set

debug ip routing

Use the debug ip routing command to activate debug messages associated with Internet Protocol

version 4 (IPv4) 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>

Syntax Description

vrf <name> Optional. Displays debug information only for the specified VRF. If a VRF is

not specified, the default VRF is assumed.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 10.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

Functional Notes

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 example activates debug messages associated with IPv4 routing table events:

>enable

#debug ip routing

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

The following example activates the debug messages associated with IPv4 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: 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: Add 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.

Command Reference Guide Enable Mode Command Set

debug ip rtp media-anchoring

Use the debug ip rtp media-anchoring command to display media anchoring event debug messages (real

time) to the terminal (or Telnet) screen. Debug messages are generated for media anchoring functions,

such as the beginning and ending of anchoring sessions and the creation and destruction of associations.

Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release R10.1.0 Command was introduced.

Usage Examples

The following example activates RTP packets debug messages for media anchoring:

>enable

#debug ip rtp media-anchoring

2012.02.09 09:50:37 SIP.PROXY DB added proxy user 2565559001@10.2.160.161

09:50:43 MEDIA.ANCHORING ANCHORING Call ID map : Added new entry : call ID 2 : session

BroadWorks3959070INIP410.2.60.251 : version 1 : index 8

09:50:43 MEDIA.ANCHORING ANCHORING New anchor entry : call 2 : session

BroadWorks3959070INIP410.2.60.251 : IP 10.2.160.166 ports 10252 - 10253 : remote IP 10.2.60.251

ports 10000 - 10001.

09:50:43 MEDIA.ANCHORING ANCHORING Call ID map : Added new port : call ID 2 : session

BroadWorks3959070INIP410.2.60.251 : version 1 : index 10

09:50:43 MEDIA.ANCHORING ANCHORING New anchor entry : call 2 : session

BroadWorks3959070INIP410.2.60.251 : IP 10.2.160.166 ports 10254 - 10255 : remote IP 10.2.60.251

ports 10002 - 10003.

09:50:43 MEDIA.ANCHORING ANCHORING Call ID map : Added new session ID : call ID 2 : session

ICG76519620INIP410.2.160.161 : version 76519620 : index 12

09:50:43 MEDIA.ANCHORING ANCHORING New anchor entry : call 2 : session

ICG76519620INIP410.2.160.161 : IP 10.2.60.249 ports 10256 - 10257 : remote IP 10.2.160.161 ports

10000 - 10001.

09:50:43 MEDIA.ANCHORING ANCHORING Call ID map : Added new port : call ID 2 : session

ICG76519620INIP410.2.160.161 : version 76519620 : index 14

09:50:43 MEDIA.ANCHORING ANCHORING New anchor entry : call 2 : session

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

ICG76519620INIP410.2.160.161 : IP 10.2.60.249 ports 10258 - 10259 : remote IP 10.2.160.161 ports

10002 - 10003.

09:50:43 MEDIA.ANCHORING ANCHORING Connect : call 2 : sessions

BroadWorks3959070INIP410.2.60.251 - ICG76519620INIP410.2.160.161 : IP 10.2.160.166 ports

10252 - 10253 : IP 10.2.60.249 ports 10256 - 10257.

09:50:43 MEDIA.ANCHORING ANCHORING Connect : call 2 : sessions

BroadWorks3959070INIP410.2.60.251 - ICG76519620INIP410.2.160.161 : IP 10.2.160.166 ports

10254 - 10255 : IP 10.2.60.249 ports 10258 - 10259.

09:50:43 MEDIA.ANCHORING ANCHORING Connecting anchored entries 10.2.160.166:10252 and

10.2.60.249:10256 - Remote 10.2.60.251:10000 and 10.2.160.161:10000.

09:50:43 MEDIA.ANCHORING ANCHORING Connecting anchored entries 10.2.160.166:10253 and

10.2.60.249:10257 - Remote 10.2.60.251:10001 and 10.2.160.161:10001.

09:50:43 MEDIA.ANCHORING ANCHORING Connecting anchored entries 10.2.160.166:10254 and

10.2.60.249:10258 - Remote 10.2.60.251:10002 and 10.2.160.161:10002.

09:50:43 MEDIA.ANCHORING ANCHORING Connecting anchored entries 10.2.160.166:10255 and

10.2.60.249:10259 - Remote 10.2.60.251:10003 and 10.2.160.161:10003.

Command Reference Guide Enable Mode Command Set

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.1 Command was introduced.

Release A1 Command was included in the AOS voice products.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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)

screen. Use the no form of this command to disable the debug messages. Variations of this command

include:

debug ip rtp quality-monitoring reporter

debug ip rtp quality-monitoring reporter <name>

Syntax Description

<name> Optional. Specifies that debug messages are enabled only for the named

reporter.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.6 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.5 Command was introduced.

Functional Notes

The debug ip security monitor events include statistic collection associated with the timeline.

Usage Examples

The following is sample output for this command:

>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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ip tcp

Use the debug ip tcp command to activate debug messages associated with Transmission Control Protocol

(TCP) state changes, session allocation and deallocation, and packet information (for example, sequence

numbers, acknowledgement numbers, and packet length) in AOS. 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 tcp

debug ip tcp events

debug ip tcp md5

Syntax Description

events Optional. Displays only messages regarding TCP state changes and TCP

session allocation.

md5 Optional. Displays messages related to the TCP Message Digest 5 (MD5)

authentication process.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 4.1 Command was introduced.

Release 9.1 Command was expanded to include the md5 parameter.

Functional Notes

The debug events for this command are logged for packets that are sent or received from the router.

Forwarded TCP packets are not included in the output.

In the debug ip tcp events output, 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.

These debug events are logged for packets that are sent or received from the router.

Forwarded TCP packets are not included.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

Output for the debug ip tcp md5 command can include messages such as: MD5 authentication was

expected but not received, MD5 authentication was not expected but was received, MD5 authentication

failed, and MD5 authentication passed. Debug messages will only be generated for TCP ports that have

MD5 authentication enabled.

Usage Examples

The following is sample output for this command:

>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

Command Reference Guide Enable Mode Command Set

debug ip tftp

Use the debug ip tftp 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 the no

form of this command to disable the debug messages. Variations of this command include:

debug ip tftp client packets

debug ip tftp server events

debug ip tftp server packets

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

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 4.1 Command was introduced.

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

The following is sample output for this command:

>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

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Syntax Description

verbose Optional. Enables detailed debug messages.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 12.1 Command was introduced.

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/

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Debug messages are displayed (real time) to the terminal (or Telnet) screen. Use the no form of this

command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 16.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ipv6 dhcp

Use the debug ipv6 dhcp command to enable debug messages for Dynamic Host Control Protocol

version 6 (DHCPv6) operation in AOS. 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 ipv6 dhcp detail

debug ipv6 dhcp relay

debug ipv6 dhcp server

Syntax Description

detail Specifies that DHCPv6 packet content is displayed.

relay Specifies that DHCPv6 relay information is displayed.

server Specifies that DHCPv6 server information is displayed.

Default Values

No default values are necessary for this command.

Command History

Release 18.3 Command was introduced.

Usage Examples

The following example displays sample output for DHCPv6 relay debug information:

>enable

#debug ipv6 dhcp relay

2011.01.01 21:40:24 DHCPv6.RELAY Relaying SOLICIT from FE80::B098:1B0E:27CA:A8AB on eth 0/2

2011.01.01 21:40:24 DHCPv6.RELAY to FE80::2A0:C8FF:FE65:702 eth 0/1

2011.01.01 21:40:24 DHCPv6.RELAY Sending RELAY-FORWARD to FE80::2A0:C8FF:FE65:702 eth 0/1

2011.01.01 21:40:24 DHCPv6.RELAY Received RELAY-REPLY from FE80::2A0:C8FF:FE65:702 eth 0/1

2011.01.01 21:40:24 DHCPv6.RELAY Relaying RELAY-REPLY from FE80::2A0:C8FF:FE65:702 eth 0/1

2011.01.01 21:40:24 DHCPv6.RELAY to FE80::B098:1B0E:27CA:A8AB on eth 0/2

2011.01.01 21:40:24 DHCPv6.RELAY Sending REPLY to FE80::B098:1B0E:27CA:A8AB eth 0/2 on eth

0/2

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ipv6 firewall

Use the debug ipv6 firewall command to activate debug messages associated with AOS Internet Protocol

version 6 (IPv6) firewall 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 ipv6 firewall

debug ipv6 firewall vrf <name>

Syntax Description

vrf <name> Optional. Displays debug information for the specified VPN routing and

forwarding (VRF) instance. If no VRF is specified, information for the default

VRF is displayed.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 18.1 Command was introduced.

Functional Notes

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 example activates the debug messages for IPv6 firewall processing:

>enable

#debug ipv6 firewall

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

The following example activates the IPv6 firewall debug messages for the VRF instance gray and provides

sample output:

>enable

#debug ipv6 firewall vrf gray

2010.08.17 20:39:25 FIREWALL_V6.VRF gray id=firewall time=”2010-08-17 20:39:25”

fw=NV3430 pri=6 proto=icmpv6 src=2001:DB8:1:1::2 dst=2001:DB8:1:1::1 msg=”ICMPv6

type=128 code=0; Bytes processed over policy-session (bytes=256) from PRIVATEV6

policy-class on the interface eth 0/1.1”

2010.08.17 20:39:25 FIREWALL_V6.VRF gray Deleted policy-session due to clear all policy-sessions

command

Policy-session ID = 2; Count (total, policy-class) = 0, 0

Protocol = 58; Flags = 0x1; Timeout = 60

Initiating side: Policy-class = PRIVATEV6

From/To: eth 0/1.1 -> Loopback

Source: 2001.DB8:1:1::2

Destination: 2001:DB8:1:1::1

ICMPv6 Type/Code: 128/0; ID: 0

Responding side: Policy-class = self

From/To: Loopback -> eth 0/1.1

Source: 2001:DB8:1:1::2

Destination: 2001:DB8:1:1::2

ICMPv6 Type/Code: 129/0; ID: 0

Command Reference Guide Enable Mode Command Set

debug ipv6 firewall ndar

Use the debug ipv6 firewall ndar command to activate debug messages associated with AOS Internet

Protocol version 6 (IPv6) firewall Neighbor Discovery (ND) 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 ipv6 firewall ndar

debug ipv6 firewall vrf <name> ndar

Syntax Description

ndar Specifies that ND address resolution events are displayed.

vrf <name> Optional. Displays debug information for the specified VPN routing and

forwarding (VRF) instance. If no VRF is specified, information for the default

VRF is displayed.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 18.3 Command was introduced.

Functional Notes

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 example activates the debug messages for IPv6 firewall ND address resolution processing

on the default VRF instance:

>enable

#debug ipv6 firewall ndar

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ipv6 icmp

Use the debug ipv6 icmp command to show all Internet Control Message Protocol (ICMP) version 6

(ICMPv6) messages being sent or received by the local IPv6 stack. For IPv6, these messages do not

include ICMP packets being exchanged between other devices because those packets appear only as IPv6

packets (rather than ICMPv6 packets) to the local 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 no form of this command to disable the debug messages. Variations of this command include:

debug ipv6 icmp

debug ipv6 icmp send

debug ipv6 icmp recv

Syntax Description

send

Optional. Displays only ICMPv6 messages sent by the IPv6 stack.

recv

Optional. Displays only ICMPv6 messages received by the IPv6 stack.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 18.1 Command was introduced.

Usage Examples

The following example activates the debug ipv6 icmp send and receive messages for ICMPv6 in AOS:

>enable

#debug ipv6 icmp

ICMPv6 SEND: To [2001:DB8:8967::10] Type=128 Code=0 Length=108 Details:echo request

id=0036 seq=0001

ICMPv6 SEND: Source changed to [2001:DB8:8967:1::100] before transmit

ICMPv6 RECV: From [1001:DB8:8967::10] to [2001:DB8:8967:1::100] [eth 0/1]

Type=129 Code=0 Length=108 Details: echo reply

id=0036 seq=0001

--MORE--

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ipv6 nd

Use the debug ipv6 nd command to activate debug messages for Internet Protocol version 6 (IPv6)

Neighbor Discovery (ND) functions on the router. This command details the processing of ND messages

and all resulting state changes and errors. 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 ipv6 nd ar

debug ipv6 nd dad

debug ipv6 nd neighbor-state

debug ipv6 nd packet neighbor

debug ipv6 nd packet router

Syntax Description

ar Optional. Activates debug messaging for address resolution (AR) changes.

dad Optional. Activates debug messaging for duplicate address detection (DAD)

events.

neighbor-state Optional. Activates debug messaging for state changes in the neighbor

cache.

packet neighbor Optional. Activates debug messaging for ND packets.

packet router Optional. Activates debug messaging for router advertisement (RA)

packets.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 18.1 Command was introduced.

Usage Examples

The following example activates debug messaging for all ND DAD events:

>enable

#debug ipv6 nd dad

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug ipv6 routing

Use the debug ipv6 routing command to activate debug messages associated with Internet Protocol

version 6 (IPv6) 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 ipv6 routing

debug ipv6 routing vrf <name>

Syntax Description

vrf <name> Optional. Displays debug information only for the specified VRF. If a VRF is

not specified, the default unnamed VRF is assumed.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 18.1 Command was introduced.

Functional Notes

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 example activates debug messages associated with IPv6 routing table events:

>enable

#debug ipv6 routing

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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)

screen. Use the no form of this command to disable the debug messages. Variations of this command

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>

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

By default, all debug messages in AOS are disabled.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

Command History

Release 11.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

form of this command to disable the debug messages. Variations of this command include:

debug isdn group

debug isdn group <number>

Syntax Description

<number> Optional. Specifies the ISDN group. Valid range is 1 to 255.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates debug messages for all ISDN groups:

>enable

#debug isdn group

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates debug messages associated with the ISDN resource manager:

>enable

#debug isdn resource-manager

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates all debug messages associated with ISDN activity:

>enable

#debug isdn verbose

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Use the no form of this command to disable the debug messages. Variations of this command include:

debug lldp

debug lldp rx

debug lldp rx verbose

debug lldp tx

debug lldp tx verbose

debug lldp verbose

Syntax Description

rx Optional. Shows information about received packets.

tx Optional. Shows information about transmitted packets.

verbose Optional. Shows detailed debugging information.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example activates both transmit and receive messages associated with LLDP operation:

>enable

#debug lldp

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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>

Syntax Description

<agent name> Optional. Specifies debug messages are enabled only for the specified mail

agent.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.2 Command was introduced.

Usage Examples

The following example enables debug messaging for all configured mail agents:

>enable

#debug mail-client

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug mef config

Use the debug mef config command to enable debug messaging for all Metro Ethernet Forum (MEF)

components configured on the unit. 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 mef config

debug mef config detail

Syntax Description

detail Optional. Specifies that detailed debug information is displayed.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release A4.05 Command was introduced.

Usage Examples

The following example enables debug messages for all MEF component configurations:

>enable

#debug mef config

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

No default values are necessary for this command.

Command History

Release A2 Command was introduced.

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

R: L/hu(N)

Q: loop

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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>

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

dotted decimal notation (for example, 10.10.10.1).

mac <mac address> Optional. Activates debug messages 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).

Default Values

No default values are necessary for this command.

Command History

Release 17.8 Command was introduced.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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)

Command Reference Guide Enable Mode Command Set

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.

Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.2 Command was introduced.

Usage Examples

The following example activates debug messages associated with NTP:

>enable

#debug ntp

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug packet-capture

Use the debug packet-capture command to enable debug messaging for all packet-capture activities. Use

the no form of this command to disable packet-capture debug messaging.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release R10.1.0 Command was introduced.

Usage Examples

The following example enables debug messaging for all packet-capture activities:

>enable

#debug packet-capture

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

(or Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 17.6 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

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

num/sum/sum2 = 10 72 522 ms

Command Reference Guide Enable Mode Command Set

IPDV-abs

round-trip min/avg/max = 0 0 0 ms

num/sum/sum2 = 9 0 0 ms

out min/avg/max = 0 0 0 ms

num/sum/sum2 = 9 0 0 ms

in min/avg/max = 0 0 0 ms

num/sum/sum2 = 9 0 0 ms

IPDV-pos

round-trip min/avg/max = 0 0 0 ms

num/sum/sum2 = 4 0 0 ms

out min/avg/max = 0 0 0 ms

num/sum/sum2 = 2 0 0 ms

in min/avg/max = 0 0 0 ms

num/sum/sum2 = 7 0 0 ms

IPDV-neg

round-trip min/avg/max = 0 0 0 ms

num/sum/sum2 = 5 0 0 ms

out min/avg/max = 0 0 0 ms

num/sum/sum2 = 7 0 0 ms

in min/avg/max = 0 0 0 ms

num/sum/sum2 = 2 0 0 ms

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)

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages. Variations of this

command include the following:

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 9.1 Command was introduced.

Release 10.1 New options were introduced.

Release 13.1 New options were introduced.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example activates port security debug messages:

>enable

#debug port security

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

form of this command to disable the debug messages. Variations of this command include:

debug ppp authentication

debug ppp errors

debug ppp negotiation

debug ppp verbose

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

By default, all debug messages in AOS are disabled.

Command History

Release 1.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Telnet) screen. Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 6.1 Command was introduced.

Usage Examples

The following example activates debug messages associated with PPPoE activity:

>enable

#debug pppoe client

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

no form of this command to disable the debug messages. Variations of this command include:

debug probe

debug probe <name>

debug probe <name> twamp

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 16.1 Command was introduced.

Release 17.3 Command was expanded to include the TWAMP probe verbose output.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

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

(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 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>

Syntax Description

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

By default, all debug messages in AOS are disabled.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

Command History

Release 13.1 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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.

Use the no form of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 5.1 Command was introduced.

Functional Notes

The debug radius messages show the communication process with the remote RADIUS servers.

Usage Examples

The following is sample 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.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug restore

Use the debug restore command to restore the last saved debug filters to the unit.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 17.4 Command was introduced.

Functional Notes

This command is used to restore filters saved using the command debug save on page 356. To view the

saved filters without restoring them to the unit, use the show debugging saved-filters command (refer to

show debugging on page 463).

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 17.4 Command was introduced.

Functional Notes

This command is used to save debug filters across a unit reboot. Filters are restored using the command

debug restore on page 355. To view the saved filters without restoring them to the unit, use the show

debugging saved-filters command (refer to show debugging on page 463).

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 mail-client agent

debug probe test1

Done.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug schedule

Use the debug schedule command to activate debug messages associated with a schedule. Variations of

this command include:

debug schedule

debug schedule <name>

Syntax Description

<name> Optional. Displays only the debug information for a specific schedule.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 17.5 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug sip

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

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. Variations of this command include:

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>

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

By default, all debug messages in AOS are disabled.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

Command History

Release 9.3 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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

no form of this command to disable the debug messages. Variations of this command include:

debug sip proxy database

debug sip proxy dialogs

debug sip proxy register rate-adaption

debug sip proxy routing

debug sip proxy transactions

debug sip proxy verbose

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

By default, all debug messages in AOS are disabled.

Command History

Release 16.1 Command was introduced.

Release A5.02 Command was expanded to include the register rate-adaption parameter.

Usage Examples

The following example activates all debug messages associated with SIP proxy events:

>enable

#debug sip proxy verbose

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

form of this command to disable the debug messages. Variations of this command include:

debug sip stack debug

debug sip stack errors

debug sip stack exceptions

debug sip stack info

response | rx | to <user> | tx]

| response | rx | to <user> | tx]

debug sip stack verbose

debug sip stack warnings

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

Turning on a large amount of debug information can adversely affect the performance of

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

Command Reference Guide Enable Mode Command Set

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.

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

By default, all debug messages in AOS are disabled.

Command History

Release 9.3 Command was introduced.

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

Command Reference Guide Enable Mode Command Set

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.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 14.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

Syntax Description

client Displays SNTP client information.

server Displays SNTP server information.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 3.1 Command was introduced.

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 sample 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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

no form of this command to disable the debug messages. Variations of this command include:

debug spanning-tree bpdu all

debug spanning-tree bpdu receive

debug spanning-tree bpdu transmit

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

By default, all debug messages in AOS are disabled.

Command History

Release 5.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Refer to debug spanning-tree on page 366 for more information.

Command Reference Guide Enable Mode Command Set

debug spanning-tree

Use the debug spanning-tree command to enable the display of spanning-tree 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 spanning-tree config

debug spanning-tree events

debug spanning-tree general

debug spanning-tree topology

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

By default, all debug messages in AOS are disabled.

Command History

Release 5.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Refer to debug spanning-tree bpdu on page 365 for more information.

Command Reference Guide Enable Mode Command Set

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

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

By default, all debug messages in AOS are disabled.

Command History

Release 8.1 Command was introduced.

Usage Examples

The following example activates the possible debug stack messages:

>enable

#debug stack switch

#debug stack verbose

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

of this command to disable the debug messages.

Syntax Description

No subcommands.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 3.1 Command was introduced.

Usage Examples

The following example activates debug messages associated with system information:

>enable

#debug system

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

terminal (or Telnet) screen. Use the no form of this command to disable the debug messages. Variations of

this command include:

debug tacacs+

debug tacacs+ events

debug tacacs+ packets

Syntax Description

events Optional. Activates TACACS+ event debug messages.

packets Optional. Activates TACACS+ packet debug messages.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 11.1 Command was introduced.

Usage Examples

The following example activates debug messages associated with the TACACS+ protocol:

>enable

#debug tacacs+ packets

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

no form of this command to disable the debug messages. Variations of this command include:

debug tcl cli

debug tcl cli <filename>

debug tcl track <name>

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

By default, all debug messages in AOS are disabled.

Command History

Release 16.1 Command was introduced.

Usage Examples

The following example activates debug messages for the Tcl interpreter while running the file test1.tcl:

>enable

#debug tcl test1.tcl

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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

this command to disable the debug messages. Variations of this command include:

debug track

debug track <name>

Syntax Description

<name> Optional. Displays information about the specified track rather than all

configured tracks.

Default Values

By default, all debug messages in AOS are disabled.

Command History

Release 13.1 Command was introduced.

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

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

debug voice

Use the debug voice command to activate debug messages associated with voice functionality. 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 the following:

debug voice account-status

debug voice autoattendant

debug voice conference local

debug voice dsp

debug voice dsp fax

debug voice dsp fax detailed

debug voice dsp isu_cp_det

debug voice dsp isu_cp_det <number>

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 findme-followme

debug voice findme-followme <extension>

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 moh

debug voice moh app

debug voice moh player

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 queue

debug voice replication

debug voice ring-group

debug voice rtp channel

debug voice rtp conference local

debug voice rtp manager

debug voice rtp provider

debug voice rtp verbose

Command Reference Guide Enable Mode Command Set

debug voice services-interface

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

Syntax Description

account-status Activates station account status event debug messages.

autoattendant Activates auto attendant event debug messages.

dsp Activates digital signal processor (DSP) event debug messages.

fax Optional. Activates the t.38 fax debug feature.

detailed Optional. Provides additional t.38 fax information from the DSP.

isu_cp_det Optional. Activates call progress tone detection debug feature.

<number> Optional. Specifies the debugging level. Enter debug voice dsp

isu_cp_det ? for a description of debugging levels.

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.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

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 state machine events.

findme-followme Activates all FindMe-FollowMe event debug messages.

<extension> Optional. Activates FindMe-FollowMe event debug messages for a specific

extension.

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.

moh Activates all music on hold debug messages.

app Optional. Activates debug messages for the music on hold application.

player Optional. Activates debug messages for the music on hold player.

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.

queue Activates call queue debug messages.

replication Activates packet replicator event debug messages.

ring-group Activates ring-group event debug messages.

rtp Activates Realtime Transport Protocol (RTP) event debug messages.

channel Activates RTP channel event debug messages.

conference local Activates local conference session debug messages.

manager Activates RTP manager event debug messages.

provider Activates RTP provider event debug messages.

verbose Activates detailed RTP debug messages.

services-interface Activates debug messages for services interface events.

Command Reference Guide Enable Mode Command Set

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 trunk port event debug messages.

<slot:port:DS0> Optional. Activates trunk port 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

By default, all debug messages in AOS are disabled.

Command Reference Guide Enable Mode Command Set

Command History

Release 9.3 Command was introduced.

Release 10.1 Command was expanded to include more parameters.

Release 12.1 Command was expanded to include more parameters.

Release 13.1 Command was expanded to include more parameters.

Release 14.1 Command was expanded to include more parameters.

Release 15.1 Command was expanded to include more parameters.

Release A1 Command was expanded to include the loopback parameter.

Release A2 Command was expanded to include the conference local and dsp

parameters.

Release A2.04 Command was expanded to include the erltool, paging-group, and

replication parameters.

Release A4.01 Command was expanded to include the moh, findme-followme,

pickup-group, queue, and conference local parameters.

Release A4.05 Command was altered to exclude the color and pickup-group parameters.

The color parameter is covered by the debug color command on page 231

and the pickup-group parameter is covered using the debug voice

verbose command. Command was expanded to include the

services-interface and ring-group parameters.

Release A5.01 Command was expanded to include the fax, detailed, and isu_cp_det

parameters.

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

Command Reference Guide Enable Mode Command Set

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

Command Reference Guide Enable Mode Command Set

debug vrrp

Use the debug vrrp command to enable Virtual Router Redundancy Protocol (VRRP) 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 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

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 |

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 (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

specified interface.

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

By default, all debug messages in AOS are disabled.

Command History

Release 16.1 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Turning on a large amount of debug information can adversely affect the performance of

your unit.

Command Reference Guide Enable Mode Command Set

Release A5.01 Command was expanded to include the Gigabit Ethernet interface.

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

Command Reference Guide Enable Mode Command Set

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>

dir usbdrive0

dir usbdrive0 <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.

usbdrive0 Optional. Displays files located on the Universal Serial Bus (USB) flash

drive memory.

Default Values

No default values are necessary for this command.

Command History

Release 10.1 Command was introduced.

Release 12.1 Command was expanded to include CompactFlash.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release 18.2 Command was expanded to include USB flash drive memory.

Usage Examples

The following is sample output from the dir flash command:

>enable

#dir flash

Command Reference Guide Enable Mode Command Set

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

10007923 bytes used, 7429514 available, 17437437 total

Command Reference Guide Enable Mode Command Set

disable

Use the disable command to exit the Enable mode and enter the Basic mode.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example exits the Enable mode and enters the Basic Command mode:

#disable

Command Reference Guide Enable Mode Command Set

eject usbdrive0

Use the eject usbdrive0 command to safely eject a specified Universal Serial Bus (USB) device before

removing it from the AOS unit.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 18.2 Command was introduced.

Usage Examples

The following example ejects an attached USB flash drive device.

#eject usbdrive0

Command Reference Guide Enable Mode Command Set

erase

Use the erase command to erase the files from a specified location.

Variations of this command (valid on all AOS units) include:

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 file-system interface mef-ethernet <interface>

Variations of this command (valid only on AOS units WITH ramdisk enabled) include:

erase ramdisk <filename>

Variations of this command (valid only on AOS units WITH Universal Serial Bus (USB) flash drive

capability) include:

erase file-system usbdrive0

erase usbdrive0 <filename>

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, CompactFlash, or

USB flash drive memory.

flash Specifies the location of the file to erase as the system flash memory.

mef-ethernet <interface> Erases the file system on the specified MEF-Ethernet interface.

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 https://supportforums.adtran.com.

Command Reference Guide Enable Mode Command Set

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.

usbdrive0 Specifies the location of the file to erase as the USB flash drive memory.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

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.

Release 17.7 Command was expanded to include the ramdisk parameter.

Release A4.01 Command was expanded to include the Metro Ethernet Forum (MEF)

Ethernet interface.

Release 18.2 Command was expanded to include the USB flash drive memory.

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]

Command Reference Guide Enable Mode Command Set

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

By default, this command is enabled.

Command History

Release 3.1 Command was introduced.

Usage Examples

The following example enables event reporting:

>enable

#events

Command Reference Guide Enable Mode Command Set

exception report generate

Use the exception report generate command to immediately generate an exception report.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 10.1 Command was introduced.

Usage Examples

The following example immediately generates an exception report:

>enable

#exception report generate

Command Reference Guide Enable Mode Command Set

factory-default

Use the factory-default command to reset the unit to the factory default setting.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 5.1 Command was introduced.

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

Performing an AOS factory-default disrupts data traffic.

Command Reference Guide Enable Mode Command Set

logout

Use the logout command to terminate the current session and return to the login screen.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 1.1 Command was introduced.

Usage Examples

The following example shows the logout command being executed in Enable mode:

>enable

#logout

Session now available

Press RETURN to get started.

Command Reference Guide Enable Mode Command Set

mount usbdrive0

Use the mount usbdrive0 command to mount a Universal Serial Bus (USB) flash drive device.

Syntax Description

No subcommands.

Default Values

No default values are necessary for this command.

Command History

Release 18.2 Command was introduced.

Usage Examples

The following example mounts a USB flash drive device onto the AOS unit:

>enable

#mount usbdrive0

Command Reference Guide Enable Mode Command Set

ping

Use the ping command (at the Enable mode prompt) to verify IPv4 network connectivity. For information

on how to verify IPv6 network connectivity, refer to ping ipv6 on page 398. Variations of this command

include:

ping

ping [ip] <ipv4 address | hostname>

ping [ip] <ipv4 address | hostname> <interface>

ping [ip] <ipv4 address | hostname> data <string>

ping [ip] <ipv4 address | hostname> repeat <number>

ping [ip] <ipv4 address | hostname> size <value>

ping [ip] <ipv4 address | hostname> source <ipv4 address>

ping [ip] <ipv4 address | hostname> timeout <value>

ping [ip] <ipv4 address | hostname> verbose

ping [ip] <ipv4 address | hostname> wait <interval>

ping [ip] vrf <name> <ipv4 address | hostname>

ping [ip] vrf <name> <ipv4 address | hostname> <interface>

ping [ip] vrf <name> <ipv4 address | hostname> data <string>

ping [ip] vrf <name> <ipv4 address | hostname> repeat <number>

ping [ip] vrf <name> <ipv4 address | hostname> size <value>

ping [ip] vrf <name> <ipv4 address | hostname> source <ipv4 address>

ping [ip] vrf <name> <ipv4 address | hostname> timeout <value>

ping [ip] vrf <name> <ipv4 address | hostname> verbose

ping [ip] vrf <name> <ipv4 address | hostname> wait <interval>

Syntax Description

ip Optional. Specifies an IPv4 ping.

<interface> Optional. Specifies the egress interface when pinging an IPv4 address.

Interfaces are specified in the <interface type> <slot/port | interface id>

format. For example, for an Ethernet interface, use eth 0/1. Type ping

<ipv4 address | hostname> ? to display a list of valid interfaces.

<ipv4 address | hostname> Optional. Specifies the IPv4 address or host name of the system to ping.

IPv4 addresses should be expressed in dotted decimal notation (for

example, 10.10.10.1).

Entering the ping command with no specified

Internet Protocol version 4 (IPv4) 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.

After specifying the target IPv4 address to ping, the other parameters can be entered in

any order. Use the ? after each specified subcommand for a valid list of arguments and

settings.

Command Reference Guide Enable Mode Command Set

repeat <number> Optional. Specifies the number of loopback messages to be sent. Range is

1 to 1024.

size <value> Optional. Specifies the datagram size (in bytes) of the ping packet. Valid

range is 1 to 1448 bytes.

source <ipv4 address> Optional. Specifies the IPv4 address to use as the source address in the

ECHO_REQ (or interface) packets. The source IPv4 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 IPv4 address exists.

wait <interval> Optional. Specifies a minimum time to wait between sending test packets.

Valid range is 100 to 60000 milliseconds.

Default Values

By default, the data pattern is set to abcd.

By default, the repeat is set to 5.

By default, the size value is set to 100 bytes.

By default, the timeout value is set to 2 seconds.

By default, the wait value is set to 100 milliseconds.

Command History

Release 1.1 Command was introduced.

Release 16.1 Command was expanded to include the vrf parameter.

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.

Release A4.01 Command was expanded to return the wait parameter.

Release 18.3 Command was expanded to include the optional ip and <interface>

parameters.

Functional Notes

The ping command can be issued from both the Basic and Enable modes.

The ping command helps diagnose basic IPv4 network connectivity using the Packet Internet Groper

program to repeatedly bounce Internet Control Message Protocol version 4 (ICMPv4) ECHO_REQ

packets off a system (using a specified IPv4 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.

Command Reference Guide Enable Mode Command Set

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

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:

>enable

#ping

VRF Name [-default-]:

Target IP address:192.168.0.30

Repeat count [5]:5

Datagram Size [100]:100

Timeout in seconds [2]:2

Wait interval in milliseconds [100]:100

Extended Commands? [n]:n

Type CTRL+C to abort.

Legend: '!' = Success, '?' = Unknown host, '$' = Invalid host address

Command Reference Guide Enable Mode Command Set

'*' = Request timed out, '-' = Destination host unreachable

'x' = TTL expired in transit, 'e' = Unknown error

Sending 5, 100-byte ICMP Echos to 192.168.0.30, timeout is 2 seconds:

!!!!!

Success rate is 100 percent (5/5), round-trip min/avg/max = 1/1/2 ms

Command Reference Guide Enable Mode Command Set

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.

Variations of this command include:

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-id> interface <interface>

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> repeat <number>

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

ping ethernet <target-mac-address | target-mep-id> wait <interval>

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

transmitting MEP belongs.

After specifying the target for the loopback messages, the other parameters can be entered

in any order.

Command Reference Guide Enable Mode Command Set

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.

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.

repeat <number> Optional. Specifies the number of loopback messages to be sent.

Range is 1 to 1024.

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.

wait <interval> Optional. Specifies a minimum time to wait between sending

loopback messages. Valid range is 100 to 60000 milliseconds.

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

Release 17.4 Command was introduced.

Release A4.01 Command was expanded to include the Metro Ethernet Forum

(MEF) Ethernet interface and the wait and repeat parameters.

Command Reference Guide Enable Mode Command Set

Release A5.01 Command was expanded to include the Gigabit Ethernet