CLI Guide

Using the CLI

This chapter introduces the command-line interface (CLI).

Topics:

• Accessing the CLI

• CLI output formats

• Using CLI interactively

• Using a script to access the CLI

• Command syntax

• Command completion, editing, and history

• Size representations

• Event log

Accessing the CLI

The CLI software that is embedded in the controller modules enables you to manage and monitor storage-system operation. You can

access the CLI in two ways:

• Use SSH or Telnet on a management host that is remotely connected to a controller module network port through a LAN.

• Use a serial cable to establish a serial connection from a computer to the CLI port on a controller module .

For information about accessing the CLI and obtaining IP values for storage system management, see the Dell EMC PowerVault ME4

Series Storage System Deployment Guide.

CLI output formats

The CLI has two output formats:

• Console format, which is the human-to-computer interface (HCI).

• API format, which is the computer-to-computer interface (CCI).

Console format enables users to interact with the CLI and obtain easily readable information. This format automatically sizes fields

according to content and adjusts content to window resizes. These capabilities would present problems for a CCI in the form of scripts or

other client software. In console format, some commands display confirmation prompts.

API format enables any external application to interact with the storage system. XML and JSON formats are supported. Both formats are

constructed to allow new fields to be added without impacting existing clients if they follow standard parsing conventions for the

respective format. In API format, commands do not use confirmation prompts.

Scripting is not supported using console format because labels, field sizes, and order of fields might change in future firmware releases. To

properly script CLI commands, use API format, which is expected to remain consistent from release to release; field names will be

consistent and new functionality will be added as new fields. These types of changes in API output will not impact a conventional XML or

JSON parsing engine.

You can change the CLI output format by using the set cli-parameters command.

Using CLI interactively

The CLI is an interactive application. When you are logged into the CLI, the CLI waits for a command and then responds to the command.

NOTE: In the interactive mode, confirmation is required for commands that can cause data unavailability or data loss.

The following example shows interactively starting an SSH session, logging into the CLI, running a command, and exiting the CLI:

$: ssh manage@IP-address

Password:

Using the CLI 11