Skip to main content

Using the ONTAP command-line interface

The ONTAP command-line interface (CLI) provides a command-based view of the management interface. You enter commands at the storage system prompt, and command results are displayed in text.

The CLI command prompt is represented as cluster_name::>.

If you set the privilege level (that is, the -privilege parameter of the set command) to advanced , the prompt includes an asterisk (*), for example, cluster_name::*>.

  • Understanding the different shells for CLI commands (cluster administrators only)
    The cluster has three different shells for CLI commands, the clustershell, the nodeshell, and the systemshell. The shells are for different purposes, and they each have a different command set.
  • Methods of navigating CLI command directories
    Commands in the CLI are organized into a hierarchy by command directories. You can run commands in the hierarchy either by entering the full command path or by navigating through the directory structure.
  • Rules for specifying values in the CLI
    Most commands include one or more required or optional parameters. Many parameters require you to specify a value for them. A few rules exist for specifying values in the CLI.
  • Methods of viewing command history and reissuing commands
    Each CLI session keeps a history of all commands issued in it. You can view the command history of the session that you are currently in. You can also reissue commands.
  • Keyboard shortcuts for editing CLI commands
    The command at the current command prompt is the active command. Using keyboard shortcuts enables you to edit the active command quickly. These keyboard shortcuts are similar to those of the UNIX tcsh shell and the Emacs editor.
  • Use of administrative privilege levels
    ONTAP commands and parameters are defined at three privilege levels: admin, advanced, and diagnostic. The privilege levels reflect the skill levels required in performing the tasks.
  • Setting the privilege level in the CLI
    You can set the privilege level in the CLI by using the set command. Changes to privilege level settings apply only to the session you are in. They are not persistent across sessions.
  • Setting display preferences in the CLI
    You can set display preferences for a CLI session by using the set command and rows command. The preferences you set apply only to the session you are in. They are not persistent across sessions.
  • Methods of using query operators
    The management interface supports queries and UNIX-style patterns and wildcards to enable you to match multiple values in command-parameter arguments.
  • Methods of using extended queries
    You can use extended queries to match and perform operations on objects that have specified values.
  • Methods of customizing show command output by using fields
    When you use the –instance parameter with a show command to display details, the output can be lengthy and include more information than you need. The –fields parameter of a show command enables you to display only the information you specify.
  • Understanding positional parameters
    You can take advantage of the positional parameter functionality of the ONTAP CLI to increase efficiency in command input. You can query a command to identify parameters that are positional for the command.
  • Methods of accessing ONTAP man pages
    ONTAP manual (man) pages explain how to use ONTAP commands. They are available at the command line and on the Lenovo Data Center Support site in the command reference guides.