Adaptec 5325301507 - Snap Server 4400 NAS, Administrator'S Manual

Page: 183 / 250

SnapServer Administrator Guide 167 SnapServer Administrator Guide 167
Appendix B
Command Line Interface
GuardianOS includes a command line interface (SnapCLI) accessible through SSH.
Using the CLI, users can access information about most of the SnapServer
configuration parameters and perform configuration and maintenance functions
without using the GuardianOS web interface or SSM.
Note
Some administrative tasks must still be performed using the Administration
Tool. The CLI is intended as a convenient way to perform some functions; it is not
intended as an alternative to using the GUI.
Topics in Command Line Interface
• SnapCLI Syntax
• SnapCLI Commands
• Scripts in SnapCLI
SnapCLI Syntax
SnapCLI command syntax uses three parameters: COMMANDS, ARGUMENTS,
and OPTIONS. To generate commands in SnapCLI, use the following syntax:
COMMAND [ARGUMENT] [OPTIONS]
where
COMMAND
is the name of one of the SnapCLI commands,
ARGUMENT
is an
action available for that command, and
OPTIONS
are additional parameters for
the command.
Once logged into the CLI, there are several ways of displaying information about
available parameters.
Type To...
? see an overview of the CLI, with a list of available commands and a
description of command syntax.
{command} help see a description of that particular command’s function and a list of
options available for the command.
tab finish the command you have started to type (i.e., tab-complete).
{command} tab list any arguments and/or options available for that command.