Command-Line Interface (CLI) Overview

Table 1. Conventions on CLI command syntax
Item format	Description
item	A required item (command, subcommand, argument, option).
<item>	A placeholder variable.
[item]	An optional item.

In the CLI, enter commands in the following format:

# xicli <command> <subcommand> <required_args> [optional_args]

To show the full list of commands, run

# xicli -h

To show the xicli version, run

# xicli -v

CLI syntax specifics:

Type the arguments of the subcommands in one line.
Subcommand arguments are separated by spaces.
Use short or long forms of subcommand argument options.
To get the list of all subcommands and arguments, add the -h option::
```
# xicli <command> <subcommand> -h
```

Table 2. The list of available commands <command>
config	Operations with the configuration file.
drive	Operations with the drives.
license	Operations with the license.
log	Operations with the event log.
mail	Operations with the mail notifications.
pool	Operations with the spare pools.
raid	Operations with the RAIDs.
settings	Operations with the additional settings of the xicli program.
update	Operations with the Update Check service.

A detailed description of the commands and subcommands is presented in the corresponding sections of the document.