Notes, Understanding command syntax, Notes xx understanding command syntax xx – Brocade Mobility RFS Controller CLI Reference Guide (Supporting software release 5.5.0.0 and later) User Manual

Page 17

Advertising
background image

xx

Brocade Mobility RFS Controller CLI Reference Guide

53-1003098-01

For readability, command names in the narrative portions of this guide are presented in bold; for
example, show version.

Notes

The following notice statement is used in this manual.

NOTE

A note provides a tip, guidance or advice, emphasizes important information, or provides a reference
to related information.

Understanding command syntax

bold text

Identifies command names

Identifies the names of user-manipulated GUI elements

Identifies keywords

Identifies text to enter at the GUI or CLI

italic text

Provides emphasis

Identifies variables

Identifies document titles

code

text

Identifies CLI output

<variable>

Variables are described with a short description enclosed within a ‘<‘ and a ‘>’ pair.
For example, the command,

RFController>show interface ge 1

is documented as

show interface ge <idx>

show – The command – Display information

interface

– The keyword – The interface

<idx> – The variable – ge Index value

|

The pipe symbol. This is used to separate the variables/keywords in a list.
For example, the command

RFController> show .....

is documented as

show [adoption|advanced-wips|boot|captive-portal|......]

where:

show – The command

[adoption|advanced-wips|boot|captive-portal|......

]

– Indicates the different commands that can be

combined with the show command. However, only one of the above list can be used at a time.
show adoption ...

show advanced-wips ...

show boot ...

Advertising