Command Line Use And Guidance - ATTO Technology FibreBridge 2300E Installation And Operation Manual

8.1 Command line use and guidance

The command line interface (CLI) provides access to the ATTO FibreBridge Services through a set of
ASCII commands. CLI commands may be entered while in CLI mode.
FibreBridge Services provide configuration and
monitoring for the FibreBridge. Other programs
and "power users" use the command line interface
(CLI), a set of ASCII-based commands, to
perform these tasks. CLI commands may be
entered while in CLI mode.
➔ CLI commands are context sensitive and
generally follow a standard format:
[Get | Set] Command [Parameter 1 | Parameter 2]
followed by the return or enter key
➔ CLI commands are case insensitive: you
may type all upper or all lower case or a
mixture. Upper and lower case in this
manual and the help screen are for
clarification only.
➔ Commands generally have three types of
operation: get, set and immediate. They are
summarized here and in Exhibit 8.1-1.
➔ The get form returns the value of a
parameter or setting and is an
informational command.
Responses to get commands are specified
in the Results field for each command,
followed by Ready.
Exhibit 8.1-1 Command explanations.
Set commands configure the FibreBridge and display what you have changed after completing
the task. Commands which require a SaveConfiguration command to complete their
implementation will return Ready. *. Set commands which do not require a SaveConfiguration
command are immediately executed.
Get commands display information about the configuration of the FibreBridge. Responses to
get commands are specified in the Results field for each command, followed by Ready.
Screen messages, also called returns, may be either terse, with just the current information, or
verbose, with labels and the current information.
15
ATTO Technology FibreBridge 2300E/R/D Installation and Operation Manual
➔ The set form is an action that changes the
value of a parameter or configuration
setting. It may require a
SaveConfiguration command and a
restart of the system before it is
implemented. The restart can be
accomplished as part of the
SaveConfiguration command or by using
a separate FirmwareRestart command. A
number of set commands may be issued
before the SaveConfiguration command.
Responses to set commands are either an
error message or Ready. *. The asterisk
indicates you must use a
SaveConfiguration command to finalize
the set command. SaveConfiguration will
ask whether you want to restart the system
or not.
➔ Set commands which do not require a
SaveConfiguration command, defined as
immediate commands, are immediately
executed.
Responses to Immediate commands are
either an error message or data results
followed by Ready.
➔ Symbols, typefaces and abbreviations used
to indicate functions and elements of the
command line interface used in this
manual include those found below.