Kontron AT8404 CLI - Manual (Page 28)

Using the Command-Line Interface AT8404
AT8404 CLI Reference Manual Page 1 - 2
1. Using the Command-Line Interface
The command-line interface (CLI) is a text-based way to manage and monitor the system. You can access the CLI
by using a direct serial connection or by using a remote logical connection with telnet or SSH.
This chapter describes the CLI syntax, conventions, and modes. It contains the following sections:
• 1.1 “Command Syntax” on page 1 - 2
• 1.2 “Command Conventions” on page 1 - 2
• 1.3 “Common Parameter Values” on page 1 - 3
• 1.4 “Slot/Port Naming Convention” on page 1 - 4
• 1.5 “Using the “No” Form of a Command” on page 1 - 4
• 1.6 “FASTPATH Modules” on page 1 - 4
• 1.7 “Command Modes” on page 1 - 5
• 1.8 “Command Completion and Abbreviation” on page 1 - 7
• 1.9 “CLI Error Messages” on page 1 - 7
• 1.10 “CLI Line-Editing Conventions” on page 1 - 7
• 1.11 “Using CLI Help” on page 1 - 8
• 1.12 “Accessing the CLI” on page 1 - 8
1.1 Command Syntax
A command is one or more words that might be followed by one or more parameters. Parameters can be required
or optional values.
Some commands, such as show network or clear vlan, do not require parameters. Other commands, such
as network parms, require that you supply a value after the command. You must type the parameter values in a
specific order, and optional parameters follow required parameters. The following example describes the network
parms command syntax:
Format network parms [gateway]
• network parms is the command name.
• and are parameters and represent required values that you must enter after you type
the command keywords.
• [gateway] is an optional parameter, so you are not required to enter a value in place of the parameter.
The CLI Command Reference lists each command by the command name and provides a brief description of the
command. Each command reference also contains the following information:
• Format shows the command keywords and the required and optional parameters.
• Mode identifies the command mode you must be in to access the command.
• Default shows the default value, if any, of a configurable setting on the device.
The show commands also contain a description of the information that the command shows.
1.2 Command Conventions
In this document, the command name is in bold font. Parameters are in italic font. You must replace the
parameter name with an appropriate value, which might be a name or number. Parameters are order dependent.