3. Conventions and CLI Commands
The following table describes the typographic conventions used in the documentation.
Convention
Description
[]
This convention indicates optional values.
Example: [a | b] indicates that you can choose a, b, or none.
{}
This convention indicates required values.
Example: {a | b} indicates that you must choose a or b.
|
This convention indicates that you have a choice between two or more
choices.
<>
This convention indicates placeholder text that is replaced by the user
or the system.
This following table covers all available CLI commands. Each command topic includes at least three of the
following sections.
Section
Description
Description
This section describes the purpose of the command.
Command
This section is the main or entire command you enter in the CLI.
Syntax
This section shows any mandatory or optional parameters you add to
the main command.
For details on how to differentiate between optional or mandatory
parameters, see Conventions.
Parameters
This section is any mandatory or optional argument or arguments and
their possible values you enter in the CLI.
Examples
This section shows an example or examples of the command in the
CLI.
Device Access
The CLI commands in this section are related to device access.
Help
Description
Display all available commands.
Command
help
Command-Line Interface User Guide
Conventions and CLI Commands
5
