AOS Command Reference Guide
User Manual: AOS Command Reference Guide
Open the PDF directly: View PDF 
.
Page Count: 3968
| Download | |
| Open PDF In Browser | View PDF |
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 All Rights Reserved. Printed in the U.S.A. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 2 Command Reference Guide Conventions Notes provide additional useful information. Cautions signify information that could prevent service interruption. Warnings provide information that could prevent damage to the equipment or endangerment to human life. Service and Warranty For information on the service and warranty of ADTRAN products, visit the ADTRAN website at http://www.adtran.com/support. Export Statement An Export License is required if an ADTRAN product is sold to a Government Entity outside of the EU+8 (Austria, Australia, Belgium, Czech Republic, Denmark, Finland, France, Germany, Greece, Hungary, Ireland, Italy, Japan, Luxembourg, Netherlands, New Zealand, Norway, Poland, Portugal, Spain, Sweden, Switzerland and the United Kingdom). This requirement is per DOC/BIS ruling G030477 issued 6/6/03. This product also requires that the Exporter of Record file a semi-annual report with the BXA detailing the information per EAR 740.17(5)(e)(2). DOC - Department of Commerce BIS - Bureau of Industry and Security BXA - Bureau of Export Administration 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 3 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 4 Command Reference Guide VLAN Database Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VLAN Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Radio Interface Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VAP Interface Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . AS Path List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BGP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BGP Neighbor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BGP Address Family Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . BGP AF Neighbor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Community List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network Monitor Probe Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network Monitor Probe Responder Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Network Monitor Track Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Router (OSPF) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Router (PIM Sparse) Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Router (RIP) Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Desktop Auditing Local Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DHCPv4 Pool Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DHCPv6 Pool Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . DHCPv6 Server Pool Host Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ethernet OAM CFM Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Hardware ACL and Access Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IPv4 Access Control List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IPv4 Access Control Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IPv6 Access Control List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IPv6 Access Control Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Mail Agent Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MEF EVC Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MEF EVC Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MEF Policer Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . MGCP Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Packet Capture Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Quality of Service Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . RADIUS Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Route Map Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Security Monitor Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SIP HMR Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . TACACS+ Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Top Traffic Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Call Pickup Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 2695 2704 2797 2813 2837 2855 2858 2878 2895 2916 2935 2938 2966 2977 2994 3015 3020 3037 3044 3067 3087 3091 3109 3126 3144 3162 3192 3201 3213 3217 3223 3229 3259 3269 3296 3300 3333 3338 3361 3364 3372 5 Command Reference Guide Voice ISDN Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Operator Ring Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Paging Group Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Ring Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Trunk Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Analog Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice ISDN Trunk Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice SIP Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice T1 Trunk Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Line Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Loopback Account Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice User Account Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Auto Attendant Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Call Queuing Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Coverage Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice CODEC List Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice CoS Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FindMe-FollowMe Action Script Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . FindMe-FollowMe Contact Group Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voice Music on Hold Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Proxy User Template Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Voicemail CoS Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . VQM Reporter Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CA Profile Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Certificate Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Crypto Map IKE Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Crypto Map Manual Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IKE Client Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IKE Policy Attributes Command Set. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . IKE Policy Command Set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 3375 3384 3402 3407 3430 3443 3493 3532 3603 3656 3679 3697 3778 3781 3799 3803 3807 3844 3852 3862 3865 3876 3885 3899 3911 3916 3933 3943 3948 3955 6 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 7 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). 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 8 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: 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 9 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: #copytftp 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 10 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 11 Command Reference Guide Understanding Command Modes Unit Boot Up After configuring your PC (or VT100 terminal), plug the unit into the wall and turn on the power. The unit begins the boot up process, which includes the following: • The Power-On Self Test runs. This test checks the unit hardware for normal operation. The hardware includes the central processing unit (CPU), the memory, and the interfaces. • The Bootstrap Startup Program (factory set in the ROM) runs. • The Bootstrap Startup Program is read by the unit to discover the proper source for the operating system image. • The operating system image is loaded into RAM. • The configuration file saved in NVRAM is loaded into RAM, where it is accessed by the unit and then executed one line at a time. If no configuration file is found in NVRAM (there will not be one found on initial setup), you are presented with the following prompt on your terminal or HyperTerminal screen: Session Now Available Press RETURN to get started After pressing return, a prompt appears for communication with your unit. Understanding Command Modes As you begin communication, you should understand the command modes. Just as there are different levels of commands in the CLI, there are different modes for commands within AOS itself. Each command mode enables the user to access more commands, and make more changes in the unit’s configuration. The CLI has three command modes: Basic, Enable, and Global. The three command modes are organized in a three-tiered hierarchy with Basic at the bottom, Enable in the middle, and Global at the top. Basic Mode Interaction with your unit begins at the Basic mode. The commands supported at this command tier are limited, as is interaction with the unit itself. The Basic mode is to keep users without access to the higher tiered commands from changing the preferred configurations of the unit. The following table describes the Basic mode. Mode Access By... Mode Prompt Basic Beginning an AOS session > Accessible Commands • • • Display system information Perform traceroute and ping functions Open a Telnet session For more information on the Basic mode, please refer to Basic Mode Command Set on page 36. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 12 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. Mode Access By.... Mode Prompt Enable Entering enable while in the # Basic mode as follows: >enable Accessible Commands • • • Manage the startup and running configurations Use the debug commands Enter any of the configuration modes For more information regarding the Enable command set, refer to the Enable Mode Command Set on page 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. Mode Access By... Mode Prompt Global Entering config while at the (config)# Enable mode as follows: >enable # #config Accessible Commands • • • • Set the system’s Enable-level password(s) Configure the system global IP parameters Configure the SNMP parameters Enter any of the configuration modes For more information on the Global mode, refer to Global Configuration Mode Command Set on page 852. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 13 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, (config-con0)# Telnet, SSH) at the Global Configuration mode prompt as follows: >enable #config (config)#line console 0 60000CRG0-35E • • Copyright © 2012 ADTRAN, Inc. Configure the console or terminal settings (data rate, login password, etc.) Create Telnet logins and specify their parameters (login password, etc.) 14 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. Command Set Accessed By... Sample Prompt With This Set You Can... Physical Interface Specifying an interface at (config-adsl0/1)# the Global Configuration mode prompt as follows: >enable #config (config)#interface adsl 0/1 • • Configure the parameters of your physical connections Configure your physical network 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... Virtual Interface Specifying an interface at the Global Configuration mode prompt as follows: >enable #config (config)#interface frame-relay 1 (config-fr 1)# 60000CRG0-35E • • Copyright © 2012 ADTRAN, Inc. Determine the parameters of information flow Configure your unit’s methods for communicating with other devices 15 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. Command Set Accessed By... Wireless Interface Sample Prompt With This Set You Can... Specifying a wireless (config-dot11ap interface at the Global 1)# Configuration mode prompt as follows: >enable #config (config)#interface dot11ap 1 • Configure your unit’s wireless parameters (radios, APs, and VAPs) Configure how your wireless network will integrate with your wired network • 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... Routing 60000CRG0-35E Sample Prompt With This Set You Can... Specifying which routing (config-ospf)# parameter you wish to set at the Global Configuration mode prompt as follows: >enable #config (config)#router ospf Copyright © 2012 ADTRAN, Inc. • • Determine which devices are compatible with your network Determine how your unit routes traffic and information 16 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. Command Set Accessed By... Sample Prompt With This Set You Can... Security and Services Specifying the service you (config-sg-radius)# • would like to perform at the Global Configuration mode • prompt as follows: • >enable #config (config)#aaa group server radius myServer Map the quality of a variety of services Set the parameters for the DHCP Configure the unit’s route map 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... Voice Groups 60000CRG0-35E Sample Prompt With This Set You Can... Specifying the voice group you (config-1234)# would like to configure at the Global Configuration mode prompt as follows: >enable #config (config)#voice ring-group 1234 Copyright © 2012 ADTRAN, Inc. • • 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 17 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. Command Set Accessed By... Voice Trunks Sample Prompt With This Set You Can... Specifying the voice trunk type (config-t01)# you would like to configure at the Global Configuration mode prompt as follows: >enable #config (config)#voice trunk t01 • • Set parameters for analog trunks, T1 trunks, Session Initiation Protocol (SIP) trunks, and more Specify the behaviors and permissions of these trunks 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... Voice Accounts 60000CRG0-35E Sample Prompt With This Set You Can... Specifying the voice account (config-4444)# you would like to configure at the Global Configuration mode prompt as follows: >enable #config (config)#voice user 4444 Copyright © 2012 ADTRAN, Inc. • • Set parameters for user accounts, line accounts, and loopback accounts Specify the behaviors and permissions of these accounts within the voice network 18 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. Command Set Accessed By... Voice Services Sample Prompt With This Set You Can... Specifying the voice service (config-aa1212)# you would like to configure at the Global Configuration mode prompt as follows: >enable #config (config)#voice autoattendant Example 1212 • • 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 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... VPN Parameters Specifying which parameter you (config-certwish to set at the Global chain)# Configuration mode prompt as follows: >enable #config (config)#crypto ca certificate chain MyProfile 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. • • Determine how your unit authenticates communication Set the parameters for keeping your unit secure 19 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. key Pressing the 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) 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 at the following prompt will place the cursor directly after the #: (config-eth 0/1)#ip address 192.33.55.6 Jump to the end of the displayed command line. For example, pressing at the following prompt will place the cursor directly after the 6: (config-eth 0/1)#ip address 192.33.55.6 Clears the current displayed command line. The following provides an example of the feature: (config-eth 0/1)#ip address 192.33.55.6 (Press here) (config-eth 0/1)# auto finish 60000CRG0-35E 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. Copyright © 2012 ADTRAN, Inc. 20 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.). 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 21 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 22 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 23 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 24 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 25 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 26 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 27 Command Reference Guide Virtual Interface Command Set Access Paths Command Set Sample Access Path For Full Command List, See... 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 Virtual Interface Command Set Access Paths 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 28 Command Reference Guide Wireless Interface Command Set Access Paths Command Set Sample Access Path For Full Command List, See... 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 Wireless Interface Command Set Access Paths 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 Routing Protocol Command Set Access Paths 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 29 Command Reference Guide Security and Services Command Set Access Paths Command Set Sample Access Path For Full Command List, See... PIM Sparse (config)#router pim-sparse (config-pim-sparse)# page 3015 RIP (config)#router rip (config-rip)# page 3020 Security and Services Command Set Access Paths 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 30 Command Reference Guide Voice Groups Command Set Access Paths Command Set Sample Access Path For Full Command List, See... 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 Voice Groups Command Set Access Paths 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 Voice Trunks Command Set Access Paths 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 31 Command Reference Guide Voice Accounts Command Set Access Paths Command Set Sample Access Path For Full Command List, See... 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 Voice Accounts Command Set Access Paths 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 32 Command Reference Guide Voice Services Command Set Access Paths Voice Services 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 VPN Parameter Command Set Access Paths 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 33 Command Reference Guide VPN Parameter Command Set Access Paths Command Set Sample Access Path For Full Command List, See... 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 34 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 35 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 on page 49 ping twamp on page 50 show clock on page 53 show snmp on page 54 show version on page 55 telnet on page 56 traceroute on page 58 traceroute ethernet on page 60 traceroute ipv6 on page 63 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 36 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 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: ****** # 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 37 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 38 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] ping [ip] ping [ip] data ping [ip] repeat ping [ip] size ping [ip] source ping [ip] timeout ping [ip] verbose ping [ip] wait ping [ip] vrf ping [ip] vrf ping [ip] vrf data ping [ip] vrf repeat ping [ip] vrf size ping [ip] vrf source ping [ip] vrf timeout ping [ip] vrf verbose ping [ip] vrf wait 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. Syntax Description ip Optional. Specifies an IPv4 ping. Optional. Specifies the egress interface when pinging an IPv4 address. Interfaces are specified in the format. For example, for an Ethernet interface, use eth 0/1. Type ping ? to display a list of valid interfaces. 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 Optional. Specifies an alphanumerical string to use (the ASCII equivalent) as the data pattern in the ECHO_REQ packets. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 39 Command Reference Guide Basic Mode Command Set repeat Optional. Specifies the number of loopback messages to be sent. Range is 1 to 1024. size Optional. Specifies the datagram size (in bytes) of the ping packet. Valid range is 1 to 1448 bytes. source 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 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 Optional. Specifies the VRF where the IPv4 address exists. wait 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 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 40 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 41 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 42 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 ping ethernet count ping ethernet data ping ethernet domain association ping ethernet domain none association ping ethernet drop-eligible ping ethernet interface ping ethernet mep ping ethernet priority ping ethernet repeat ping ethernet size ping ethernet timeout ping ethernet validate-data ping ethernet verbose ping ethernet wait After specifying the target for the loopback messages, the other parameters can be entered in any order. Syntax Description 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 Optional. Specifies the number of loopback messages to send. Range is 1 to 1000000. data 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 Optional. Specifies the maintenance domain to which the transmitting MEP belongs. domain none Optional. Specifies no maintenance domain. association Optional. Specifies the maintenance association to which the transmitting MEP belongs. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 43 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 Optional. Specifies the interface on which the transmitting MEP is configured. Specify an interface in the format . For example, for an Ethernet subinterface, use eth 0/1.1. For a list of appropriate interfaces, enter interface ? at the prompt. mep Specifies the MEP ID of the transmitting MEP. MEP ID range is 1 to 8191. priority Optional. Specifies the 802.1 priority bits that are sent in the loopback message. Range is 0 to 7. repeat Optional. Specifies the number of loopback messages to be sent. Range is 1 to 1024. size Optional. Specifies the size of the loopback message. Size ranges from 1 to 60 bytes. 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 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 44 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 and association 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 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). 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. 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 45 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 ping ipv6 ping ipv6 data ping ipv6 destination-option ping ipv6 hop-by-hop-option ping ipv6 repeat ping ipv6 size ping ipv6 source ping ipv6 timeout ping ipv6 verbose ping ipv6 wait ping ipv6 vrf ping ipv6 vrf ping ipv6 vrf data ping ipv6 vrf destination-option ping ipv6 vrf hop-by-hop-option ping ipv6 vrf repeat ping ipv6 vrf size ping ipv6 vrf source ping ipv6 vrf timeout ping ipv6 vrf verbose ping ipv6 vrf wait 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. Syntax Description Specifies the egress interface when pinging an IPv6 link-local address (any address that has the prefix FE80::/64). Interfaces are specified in the format. For example, for an Ethernet interface, use eth 0/1. Type ping ipv6 ? 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. 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 46 Command Reference Guide Basic Mode Command Set data 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 Optional. Specifies the number of loopback messages to be sent. Range is 1 to 1024. size Optional. Specifies the datagram size (in bytes) of the ping packet. Valid range is 1 to 1448 bytes. source 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 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 Optional. Specifies the VRF where the IPv6 address exists. wait 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. 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 47 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 48 Command Reference Guide Basic Mode Command Set ping stack-member Use the ping stack-member command to ping a member of the stack. Variations of this command include: ping stack-member ping stack-member vrf Syntax Description Specified which member of the stack to ping. vrf 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 # 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 49 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 ping twamp control-port ping twamp data pattern ping twamp data pattern ascii ping twamp data pattern hex ping twamp data random ping twamp data zero ping twamp dscp ping twamp interval ping twamp port ping twamp repeat ping twamp size ping twamp source ping twamp source-port ping twamp timeout ping twamp verbose ping twamp wait The subcommands can be used in a string of any available combination. Use the ? after each specified subcommand for a valid list of arguments and settings. Syntax Description 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 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 Pads the packet with a user-specified ascii pattern. hex Pads the packet with a user-specified hex pattern. random 60000CRG0-35E Pads the packet with random numbers. Copyright © 2012 ADTRAN, Inc. 50 Command Reference Guide zero Basic Mode Command Set Pads the packet with all zeros. dscp Optional. Specifies the differentiated services code point (DSCP) value. Valid range is 0 to 63. interval Optional. Specifies the interval between consecutive ping TWAMPs (in milliseconds). Valid range is 5 to 5000. port Optional. Specifies the destination port for the TWAMP test packets. Valid range is 1 to 65535. repeat Optional. Specifies the number of ping TWAMP packets. Valid range is 1 to 1000. size Optional. Specifies the datagram size. Valid range is 0 to 1462. source Optional. Specifies the source IP address. IP addresses should be expressed in dotted decimal notation (for example, 10.10.10.1). source-port Optional. Specifies the source port for the TWAMP test packets. Valid range is 1 to 65535. timeout 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 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 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 51 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 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 --MORE-- 60000CRG0-35E Copyright © 2012 ADTRAN, Inc. 52 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