CLI Guide
Menu Submenus Description
• list-volumes
CLI Command Syntax
CLI commands have the following structure:
CLI> <main_menu> <submenu(s)> <command> <argument(s)> -<option(s)>
where:
• CLI> – Command prompt where you type the command
• <main_menu> – Name of the main menu
• <submenu(s)> – Names of one or more submenus (separated with spaces). Certain menus have multiple levels of submenus.
• <command> – Name of the command that you want to execute
• <argument(s)> – Arguments (separated with spaces) that you must enter with the command to execute the command
successfully. You might have none or multiple arguments depending on the command that you want to execute. You must enter
the arguments for a command in the correct order.
• <option(s)> – Options (separated with a space) that are available for a command. You might have none or multiple options
depending on the command that you want to execute and you might need to enter at least one of the available options for the
command to execute successfully. Each option for a command must start with a hyphen (-).
Navigating the CLI
When navigating the CLI, the following commands are available throughout the system:
• back — Moves back one level in the menu hierarchy
• main — Returns to the main menu
• help — Lists information about currently available menus, commands, arguments, and options
• history — Lists previously executed commands
• exit or quit — Exits the CLI
• find — Lists menus and commands containing the text you supply
Entering Commands in the CLI
There are two ways to enter commands in the CLI:
• Enter a command by navigating one menu at a time
• Enter a single line command
Press the Tab key to automatically complete a menu, submenu, command, or option name after entering a unique portion of the
name. Tab completion can be useful in when entering long commands. For example, entering net and then pressing Tab is the same
as entering networking. If there are several items that begin with those characters, the CLI displays the possibilities. For example,
entering NAS-volumes n and then pressing Tab displays NAS-pool and NFS-exports.
Press Tab again to see the available submenus, commands, and options under the given string. For example, entering events and
then pressing Tab twice displays the available events commands: list and view.
You can also use the CLI to abbreviate a command if the abbreviation uniquely identies the command. For example, the following
commands are identical: events system list and events system li.
10
About the CLI