About this guide, Cli syntax, Dependency delimiters – Amer Networks WLO220T CLI User Manual

Page 5: Object naming conventions, Nested dependencies

Advertising
background image

P R E F A C E

1

2

CLI Reference Guide

About This Guide

This guide describes the commands used to configure and manage VF-based devices from a
management interface.

CLI Syntax

The CLI syntax may include options, switches, parameters, and other features. Some command
descriptions use dependency delimiters. Dependency delimiters indicate which command features
are mandatory, and in which contexts.

Dependency Delimiters

Special characters are used to show the dependencies between commands features.

¢The { and } symbols denote a mandatory feature. Features enclosed by these symbols are

essential for execution of the command.

¢The [ and ] symbols denote an optional feature. Features enclosed by these symbols are not

essential for execution of the command, although omitting such features might adversely affect
the outcome.

¢The | symbol denotes an “or” relationship between two features. When this symbol appears

between two features on the same line, you can use either feature (but not both). When this
symbol appears at the end of a line, you can use the feature on that line, or the one below it.

Nested Dependencies

CLI commands can have nested dependencies. Nested dependencies make features optional in
some contexts, and mandatory in others. The three hypothetical features shown below
demonstrate this principle.

[ feature_1 { feature_2 | feature_3 } ]

The delimiters [ and ] surround the entire clause. Consequently, you can omit feature_1,
feature_2, and feature_3, and still execute the command successfully. However, because the
{ and } delimiters surround feature_2 and feature_3, you must include either feature_2 or
feature_3 if you include feature_1. Otherwise, you cannot successfully execute the command.

Object Naming Conventions

The CLI employs the following conventions regarding the names of objects:

If a name string includes one or more spaces, the entire string must be enclosed within double
quotes ( “ ); for example, set address trust “local LAN” 10.1.1.0/24.

The CLI trims any spaces leading or trailing text within a set of double quotes; for
example, “ local LAN ” becomes “local LAN”.

The CLI treats multiple consecutive spaces as a single space.

Advertising
This manual is related to the following products: