Command-line interface
You can use the command-line interface (CLI) to manage the SAN Volume Controller by typing commands.
- Syntax diagrams
A syntax diagram uses symbols to represent the elements of a command and to specify the rules for using these elements. - Using wildcards in the CLI
You can use wildcards in the SAN Volume Controller command-line interface (CLI). - Data types and value ranges
The maximum length of any single parameter entered into the command line is 2176 bytes. - Terminology
These are abbreviations that are most commonly used for the command-line interface (CLI) operations. - CLI flags
The following flags are common to all command-line interface (CLI) commands. - CLI messages
Ensure that you are familiar with the command-line interface (CLI) messages. - CLI commands and parameters
Command-line interface (CLI) commands and parameters are represented in the syntax diagram. - CLI special characters
The following special characters are used in the command-line interface (CLI) command examples. - CLI deprecated and discontinued commands
Some command-line interface (CLI) commands are discontinued or deprecated and replaced with new commands. - Understanding capacity indicators
The system uses base-2 (binary numeral) as capacity indicators for volumes, drives, and other system objects. The management GUI and the command-line interface (CLI) use different abbreviations to indicate capacity, but the value for these capacity indicators is the same. - Attributes of the -filtervalue parameters
The -filtervalue parameter filters a view that is based on specific attribute values that relate to each object type. You can combine multiple filters to create specific searches, for example, -filtervalue name=fred:status=online. The help (-filtervalue) specifies the attributes that are available for each object type. - Setting up an SSH client
Secure Shell (SSH) is a client-server network application. It is used as a communication vehicle between the host system and the SAN Volume Controller command-line interface (CLI). - Copying the software update files by using PuTTY pscp or openssh scp
PuTTY pscp (or scp) provides a file transfer application for secure shell (SSH) to copy files either between two directories on the configuration node or between the configuration node and another host. - Using the CLI
The SAN Volume Controller clustered system (system) command-line interface (CLI) is a collection of commands that you can use to manage the SAN Volume Controller. - Array commands
Array commands capture information that can assist you with managing arrays. - Audit log commands
An audit log keeps track of action commands that are issued through a Secure Shell (SSH) session or through the management GUI. - Backup and restore commands
Backup and restore commands are used for backing up and restoring configuration information with the SAN Volume Controller. - Cloud account commands
Cloud account commands are used to create, change, or list details about cloud accounts. - Clustered system commands
Clustered system (system) commands are used to monitor and modify systems. - Clustered system diagnostic and service-aid commands
Clustered system diagnostic and service-aid commands are designed to diagnose and find clustered system (system) problems. - Controller command
Use the controller command to modify the name of a storage controller. - Copy services commands
The Copy Service commands enable you to work with the Metro Mirror, Global Mirror, and HyperSwap® services that the SAN Volume Controller provides. - Drive commands
Use the drive commands to capture information to assist with managing drives. - Enclosure commands
Enclosure commands capture information that can assist you with managing enclosures. - Email and event notification commands
You can use the command-line interface (CLI) to enable your system to send notifications. - Encryption commands
Security commands are used to create, change, or list details about clustered system (system) encryption features. - FlashCopy commands
The FlashCopy® commands enable you to work with FlashCopy methods and functions with the SAN Volume Controller. - Host commands
The host commands enable you to work with host objects with the SAN Volume Controller. - Information commands
The information commands enable you display specific types of SAN Volume Controller information. - Key server commands
Key server commands are used to create, change, or list details about key servers. - Licensing and featurization commands
The licensing commands enable you to work with SAN Volume Controller licensed functions. - Livedump commands
Use the livedump commands to manage the node livedumps on SAN Volume Controller. - Managed disk commands
The managed disk commands enable you to work with managed disk options with the SAN Volume Controller. - Storage pool commands
Use the storage pool commands to work with storage pool options with the SAN Volume Controller. - Migration commands
The migration commands enable you to work with migration options with the SAN Volume Controller. - Service information commands
Service information commands are used to view the status of the hardware and to report hardware errors. - Service task commands
Service task command information enables you to service the node hardware. - User management commands
You can use the command-line interface (CLI) to configure remote authentication service and manage users and user groups on the clustered system. - Volume commands
The volume commands enable you to work with volume options with the SAN Volume Controller.
Related concepts: