ADTRAN AOS Version R10.1.0 Command Reference Manual page 9

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