Command syntax conventions, Command examples, Notes, cautions, and warnings – Brocade Fabric OS Message Reference (Supporting Fabric OS v7.3.0) User Manual

Page 18

Advertising
background image

xviii

Fabric OS Message Reference

53-1003140-01

For readability, command names in the narrative portions of this guide are presented in mixed
lettercase: for example, switchShow. In actual examples, command lettercase is all lowercase.

Command syntax conventions

Command syntax in this manual follows these conventions:

Command examples

This book describes how to perform configuration tasks using the Fabric OS command line
interface, but does not describe the commands in detail. For complete descriptions of all Fabric OS
commands, including syntax, operand description, and sample output, see the Fabric OS
Command Reference
.

Notes, cautions, and warnings

The following notices and statements are used in this manual. They are listed below in order of
increasing severity of potential hazards.

NOTE

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

ATTENTION

An Attention statement indicates potential damage to hardware or data.

command

Commands are printed in bold.

--

option, option

Command options are printed in bold.

-

argument, arg

Arguments.

[ ]

Optional element.

variable

Variables are printed in italics. In the help pages, values are underlined or
enclosed in angled brackets < >.

...

Repeat the previous element, for example “member[;member...]”

value

Fixed values following arguments are printed in plain font. For example,

--

show WWN

|

Boolean. Elements are exclusive. Example:

--

show

-

mode egress | ingress

Advertising