Preface, Command option notation, Audience – Amer Networks E5 CLI User Manual

Page 9: Notation

Preface

Audience

The target audience for this reference guide is:

•

Administrators that are responsible for configuring and managing the Clavister Security
Gateway.

•

Administrators that are responsible for troubleshooting the Clavister Security Gateway.

This guide assumes that the reader is familiar with the Clavister Security Gateway, and has the
necessary basic knowledge in network security.

Notation

The following notation is used throughout this reference guide when specifying the options of a
command:

Angle brackets or
-option=

Used for specifying the name of an option or a description
of a value.

Square brackets [option] or
-option[=value]

Used for specifying that an option or a value for an option is
optional and can be omitted.

Curly brackets {value1 | value2 |
value3}

Used for specifying the available values for an option.

Ellipsis ...

Used for specifying that more than one value can be
specified for the option.

Example 1. Command option notation

One of the usages for the help command looks like this:

help -category={COMMANDS | TYPES} []

This means that help has an option called

category

which has two possible values which are

COMMANDS

and

TYPES

. There is also an optional option called

Topic

which in this case is a

search string used to specify what help topic to display. Since the topic is optional, it is possible
to exclude it when running the command.

Both of the following examples are valid for the usage described above:

Device:/> help -category=COMMANDS
Device:/> help -category=COMMANDS activate

The usage for the routes command is:

routes [-all] [-switched] [-flushl3cache[=]] [-num=]