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.
Page 3
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).
Page 7
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...
Page 9
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.
Page 13
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...
Upgrade key: de76efcfeb4c8eeb6901188475dd0917 Boot ROM version 03.00.18 Checksum: 7A3D built on: Fri Nov 08 13:12:25 2002 Copyright (c) 1999-2002 ADTRAN Inc. Serial number C14C6308 UNIT_2 uptime is 0 days 4 hours 59 minutes 43 seconds System returned to ROM by Warm Start Current system image file is "030018adv.biz"...
Page 92
Command was altered to support 4-byte AS number (previously AOS only supported 2-byte numbers). Release 18.3 Command syntax was changed to remove the ip keyword for ADTRAN internetworking products. In addition, the any-vrf, vrf <name>, and ipv4 parameters were added.
Page 117
Command was changed to require the ip keyword for ADTRAN internetworking products only. Release R10.1.0 Command was changed to require the ip keyword for ADTRAN voice products. Usage Examples The following example clears all counters for the IPv4 ACL labeled MatchAll: >enable...
Page 119
Command was expanded to include the vrf parameter. Release 18.3 Command syntax was changed to remove the hyphen and the server keyword for ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the server keyword for ADTRAN voice products.
Page 228
Command was introduced. Release 18.3 Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN internetworking products. In addition, the scan, database, route-table, and soft-reset parameters were added. Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN voice products.
Page 237
Release 1.1 Command was introduced. Release 2.1 Additional debug messages were implemented for dial-backup operation to ADTRAN’s IQ and Express Series products. Functional Notes The debug dial-backup command activates debug messages to aid in the troubleshooting of dial-backup links. Usage Examples The following example activates debug messages for dial-backup operation: >enable...
Page 284
Command was changed to require the ip keyword for ADTRAN internetworking products only. Release R10.1.0 Command was changed to require the ip keyword for ADTRAN voice products. Functional Notes The debug ip firewall command activates debug messages to provide real-time information about the IPv4 AOS stateful inspection firewall operation.
Page 286
Command was changed to require the ip keyword for ADTRAN internetworking products only. Release R10.1.0 Command was changed to require the ip keyword for ADTRAN voice products. Usage Examples The following example activates debug messages associated with SIP information with AOS firewall operation: >enable...
Page 384
If the primary boot image is located on the erased file system, the unit will be adversely affected after a reboot. The firmware has to be replaced using the procedure explained in the Upgrading AOS Firmware configuration guide, article number 1630, available online at https://supportforums.adtran.com. Syntax Description <filename>...
Page 428
<name> parameters. Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN voice products. Command was also expanded to include the ipv6 and <ipv6 address/prefix-length> parameters. Usage Examples The following sample output of the show bgp ipv4 summary command shows a summarized list of the configured BGP neighbors, as well as their status and statistics.
Page 431
<name>, and exact parameters. Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN voice products. Command was also expanded to include the ipv6 parameter. Usage Examples In the following example, all BGP routes are displayed whose community numbers match those listed in the show bgp community command.
Page 434
<name> parameters. Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN voice products. The command was also expanded to include the ipv6 parameter. Functional Notes Information displayed includes the ID of this router and its autonomous system (AS) number, the...
Page 436
<name> parameters. Release R10.1.0 Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN voice products. Command was also expanded to include the ipv6 and <ipv6 address> parameters. Functional Notes Entries that are not filtered by prefix lists are marked with an asterisk (*) to show they are valid.
Page 445
Use the show buffers users command to display a list of the top users of packet buffers. Typically, this command will only be used as a debug tool by ADTRAN personnel. Variations of this command include: show buffers users...
Page 470
3037. For more information about configuring desktop auditing, refer to the Configuring Desktop Auditing in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following is sample output from the show desktop-auditing dhcp command: #show desktop-auditing dhcp Client MAC/IP: 00:E0:29:0E:D5:E3 / 10.23.220.1 / xpsp3-host...
Page 542
Command was expanded to include the Gigabit Ethernet interface. Release 18.3 Command syntax was changed to remove the hyphen and the client keyword for ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the client keyword for ADTRAN voice products.
Release 18.3 Command syntax was changed to remove the hyphen and the server keyword on ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the server keyword on ADTRAN voice products.
Page 688
If checkdisk passed without incident, the command displays the output File is empty. This command is only applicable to ADTRAN integrated communications products (ICPs). The output of all show commands can be limited by appending the following modifiers to the end of the command: | begin <text>, | exclude <text>, and | include <text>.
Page 724
Release R10.1.0 Command was expanded to include the hmr parameters. Command was also changed to require the ip keyword for the access-list and policy-class parameters for ADTRAN voice products. Usage Examples The following is sample output from the show running-config command: >enable...
The following is sample output from the show system command: >enable #show system ADTRAN, Inc. OS version 07.00.20 Checksum: 3B2FCC0F, built on Tue Jun 01 13:36:36 2004 Boot ROM version 07.00.20 Checksum: 604D, built on: Tue Jun 01 13:59:11 2004 Copyright (c) 1999-2004, ADTRAN, Inc.
Functional Notes The show tech command runs a script that creates a showtech.txt file in flash memory that contains the command output from the following show commands: Not all listed show commands apply to all ADTRAN products. show version show modules...
Page 783
Usage Examples The following is sample output from the show users command: >enable #show users - CONSOLE 0 'adtran' logged in and enabled Idle for 00:00:00 - TELNET 0 (172.22.12.60:3998) 'password-only' logged in (not enabled) Idle for 00:00:14 - FTP (172.22.12.60:3999) 'adtran' logged in (not enabled)
Page 784
Command Reference Guide Enable Mode Command Set show version Use the show version command to display the current ADTRAN Operating System (AOS) version information. The output of all show commands can be limited by appending the following modifiers to the end of the command: | begin <text>, | exclude <text>, and | include <text>. The...
Page 857
3361. For more information about AAA accounting, or AAA configuration in general, refer to the Configuring AAA in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example creates a list called myList and specifies that accounting records are generated for...
Page 868
If the unit fails to make a connection with the first group listed, it will try the next group specified. For security reasons, ADTRAN recommends that the local authentication method be used instead of the none authentication method. Using the local authentication method prevents unauthorized users from gaining access to the device during a period in which the links to all authentication servers are down.
Page 869
3296. For more information about AAA authentication, or AAA configuration in general, refer to the Configuring AAA in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example specifies using the line password as the first method of authentication and using the...
Page 872
If the unit fails to make a connection with the first group listed, it will try the next group specified. For security reasons, ADTRAN recommends that the local authentication method be used instead of the none authentication method. Using the local authentication method prevents unauthorized users from gaining access to the device during a period in which the links to all authentication servers are down.
Page 873
3296. For more information about AAA authentication, or AAA configuration in general, refer to the Configuring AAA in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example creates a login authentication list called myList and specifies using the local...
Page 876
If the unit fails to make a connection with the first group listed, it will try the next group specified. For security reasons, ADTRAN recommends that the local authentication method be used instead of the none authentication method. Using the local authentication method prevents unauthorized users from gaining access to the device during a period in which the links to all authentication servers are down.
Page 879
If the unit fails to make a connection with the first group listed, it will try the next group specified. For security reasons, ADTRAN recommends that the local authentication method be used instead of the none authentication method. Using the local authentication method prevents unauthorized users from gaining access to the device during a period in which the links to all authentication servers are down.
Page 880
3361. For more information about AAA authorization, or AAA configuration in general, refer to the Configuring AAA in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example creates a command authorization method list called myList, which authorizes...
Page 881
For more information about AAA authorization, or AAA configuration in general, refer to the Configuring AAA in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example enables authorization of configuration mode commands:...
Page 882
For more information about AAA authorization, or AAA configuration in general, refer to the Configuring AAA in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example enables AAA authorization use on console interfaces:...
Page 884
If the unit fails to make a connection with the first group listed, it will try the next group specified. For security reasons, ADTRAN recommends that the local authentication method be used instead of the none authentication method. Using the local authentication method prevents unauthorized users from gaining access to the device during a period in which the links to all authentication servers are down.
Page 889
If AAA is enabled, AAA methods will override other security methods specified in the line interface. For more information about the use and configuration of AAA, refer to the Configuring AAA in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example activates AAA services:...
Page 895
(MSP) server. Communication ® can be either via Hypertext Transfer Protocol (HTTP) or Hypertext Transfer Protocol over Secure Socket Layer (HTTPS). Auto-link allows a client device to connect to an ADTRAN n-Command MSP network ® management appliance. Use the no form of this command to disable auto-link or to return to the default communication method.
Page 903
Functional Notes Detailed instructions for upgrading AOS and loading files into flash memory are found on the AOS Documentation CD shipped with your unit or online at https://supportforums.adtran.com. Usage Examples The following example specifies the file myimage.biz, stored in flash memory, as the VoIP startup image: (config)#boot voip flash myimage.biz...
Page 924
ID (enter this value in (Lightweight Directory Access Protocol (LDAP) format). fqdn <name> Specifies a fully qualified domain name (FQDN) (e.g., adtran.com) as the remote ID. user-fqdn <name> Specifies a user FQDN or email address (e.g., user1@adtran.com) as the remote ID.
Page 926
Example for typical asn1-dn format with wildcards used to match a portion of the remote ID: crypto ike remote-id asn1-dn “CN=*, C=US, S=ALCA, L=Huntsville, O=Adtran, OU=*” (matches any remote ID string with the same values for the C, S, L, and O fields, and any values in the CN...
Page 933
Desktop Auditing Local Policy Command Set on page 3037. For more information about desktop auditing, refer to the Configuring Desktop Auditing in AOS configuration guide available online at https://supportforums.adtran.com. Usage Examples The following example creates a desktop auditing local policy and enters the policy’s configuration mode:...
Page 934
3037. For more information about desktop auditing, refer to the Configuring Desktop Auditing in AOS configuration guide available online at https://supportforums.adtran.com. There is a storage limit of 2000 NAP entries on the AOS unit. When this limit is reached, new entries overwrite the old entries.
Page 935
By default, this command is enabled. Command History Release 3.1 Command was introduced. Release 18.3 Command syntax was changed to remove the ip keyword for ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products.
Page 936
Command was introduced. Release 16.1 Command was expanded to include the vrf parameter. Release 18.3 Command syntax was changed to remove the ip keyword for ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products.
Page 938
Command was expanded to include the source-interface parameter. Release 18.2 Command was expanded to include the failover parameter. Release 18.3 Command syntax was changed to remove the ip keyword for ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products.
Page 950
Use the no form of this command to disable rebooting when the minimum memory limitation is violated. Executing the exception memory minimum command may cause the unit to reboot. ADTRAN recommends only using this command if advised by ADTRAN Technical Support. Syntax Description <value>...
Page 958
ADTRAN internetworking products. Release R10.1.0 The command syntax was changed to remove the ip keyword for ADTRAN voice products. Functional Notes The host name can be any combination of numbers and letters as long as it is not a valid IPv4 or IPv6 address or does not exceed 256 characters.
Page 961
Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Usage Examples The following example assigns the AAA list Mylist1 to HTTP authentication:...
Page 966
Command syntax was changed to remove the ip keyword to support IPv6 in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Usage Examples The following example specifies that the AOS GUI is displayed in French Canadian:...
Page 969
Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Usage Examples The following example enables the SSL cipher suite rc4-sha for HTTP connections:...
Page 970
Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Usage Examples The following example enables the HTTP secure server:...
Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Usage Examples The following example enables the HTTP server:...
Page 972
Command syntax was changed to remove the ip keyword for IPv6 in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Usage Examples The following example limits the maximum number of allowed HTTP sessions to 75:...
Page 973
Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Usage Examples The following example changes the HTTP session timeout period to 1500 seconds:...
Page 974
Command syntax was changed to remove the ip keyword for IPv6 support in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the ip keyword for ADTRAN voice products. Functional Notes This command allows you to override the sender field in the IP packet. If you have multiple interfaces in your unit, changing the sender tells the receiver where to send replies.
Page 990
Release 10.1 Command was introduced. Release 18.3 Command syntax was changed to remove the hyphen and the server parameter for ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the server parameter for ADTRAN voice products.
Page 991
Command was expanded to include the vrf parameter. Release 18.3 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN voice products.
Page 993
Release 2.1 Command was introduced. Release 18.3 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN voice products.
Page 994
Release 2.1 Command was introduced. Release 18.3 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN voice products.
Page 995
Release 2.1 Command was introduced. Release 18.3 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN internetworking products. Release R10.1.0 Command syntax was changed to remove the hyphen and the server keyword in ADTRAN voice products.
Need help?
Do you have a question about the AOS Version R10.1.0 and is the answer not in the manual?
Questions and answers