10400455-002
©2008-14 Overland Storage, Inc.
266
Appendix E
Command Line Interface
RAINcloudOS includes a command line interface (SnapCLI) that is accessible through SSH.
Using the CLI, users can access information about most of the SnapScale configuration
parameters and perform configuration and maintenance functions without using the Web
Management Interface or SSM.
IMPORTANT: Some administrative tasks must still be performed using the Web Management
Interface. The CLI is intended as a convenient way to perform some functions; it is not intended
as an alternative to using the Web Management Interface.
Topics in Command Line Interface
•
•
•
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.
For example, to see a list of available commands once you have logged into SnapCLI, type “
?
”
at the prompt.
To see a description of a specific command, type the command name (for example,
date
) +
“
help
” or “
?
”:
Type
Result
?
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 (such as, tab-
complete).
{command}
tab
List any arguments and/or options available for that command.
