CLI reference

Edit online

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 system command-line interface (CLI).
Data types and value ranges
The maximum length of any single parameter entered into the command line is 2176 bytes.
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.
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.
UNIX commands available on the CLI
You can use several UNIX-based commands while working with interactive SSH sessions.
Array commands
Use the array commands to manage arrays and their properties.
Audit log commands
Use the audit log commands to track command specifications and related data. An audit log keeps track of successful action commands that are issued by users through all supported interfaces.
Backup and restore commands
Use the backup and restore commands to back up and restore configuration information about the system.
Cloud commands
Use the cloud commands to create, change, or list details about cloud-related objects.
Clustered system commands
Use the system commands to monitor and modify systems and their properties.
Clustered system diagnostic and service-aid commands
Use the clustered system diagnostic and service-aid commands to diagnose and find system problems.
Controller commands
Use the controller commands to modify the name of a storage controller.
Copy Service commands
Use the Copy Service commands to work with the Metro Mirror, Global Mirror, and HyperSwap® services that are provided by the system.
Drive commands
Use the drive commands to capture information to assist with managing drives.
Enclosure commands
Use the enclosure commands to manage enclosures and their properties.
Call home and event notification commands
Use the call home and event notification commands to enable your system to send notifications.
Encryption commands
Use the encryption and security commands are used to create, change, or list system encryption feature details.
Policy-based replication commands
Policy-based replication uses volume group and replication policies to automatically deploy and manage the replication. Policy-based replication significantly simplifies configuring, managing, and monitoring replication between two systems. Use the following set of commands to change, create or delete the replication policies.
Fibre Channel portset
Use the following set of commands to associate a Fibre Channel I/O port ID with portset, list the mapping between Fibre Channel I/O port ID and portset objects and to remove Fibre Channel I/O port ID association from the portset.
FlashCopy commands
Use the FlashCopy® commands to work with FlashCopy® system methods and functions.
FlashSystem grid commands
Host commands
Use the host commands to work with host objects on your system.
Licensing and featurization commands
Use the licensing and featurization commands to work with licensed system functions.
Livedump commands
Use the livedump commands to manage the node livedumps.
Managed disk commands
Use the managed disk commands to work with managed disk options on a system.
Migration commands
Use the migration commands to work with migration options for the system storage system.
Multifactor authentication commands
Use the following set of commands to configure the system-wide IBM Security Verify and Duo Security multifactor authentication settings.
IP addresses commands
Use the following set of commands to configure or create portset, IP objects and associate them with host objects.
Partition commands
The High Availability (HA) solution uses Storage Partitions, a configuration object that is designed to be the single point of management for HA objects. These partitions contain volumes, volume groups, hosts and host-to-volume mappings.
Provisioning policies commands
Use the provisioning policies commands to simplify the provisioning of storage.
Recovery access key command
Use the recovery access key command to unlock the system storage.
Legacy Safeguarded policy commands
These Safeguarded policy commands are used for a method of simplifying copies that are made on IBM® Copy Services Manager. This is legacy functionality that has been replaced by the Safeguarded Snapshots feature.
Service information commands
Use the service information commands to view hardware status and to report hardware errors.
Service task commands
Use the service task commands to service the node hardware (such as IBM Storage Virtualize™).
Single sign-on commands
Use the following set of commands to configure the system-wide single sign-on authentication settings.
System certificates commands
Use the System Certificates commands to manage the system certificate. The system certificate is used to enable secure connections between systems or applications across networks.
Snapshot commands
Use the following set of commands to create a management model that allows a storage administrator or automation engine to handle the defined use-cases without having to manage the internal implementation.
Snapshot policy commands
Use the following set of commands to set a schedule for snapshot creation and retention.
Storage pool commands
Use the storage pool commands to work with storage pool options on the system.Use storage pool commands to work with managed disk group options.
Truststore management commands
Use the truststore management commands to configure repositories of certificates and tag stores for use with network services.
Two person integrity commands
Use two person integrity (TPI) commands to create, view, approve, cancel, and update role elevation requests. To use these commands, you must have the Restricted Security Administrator role or the Security Administrator role. For example, if you have Security Administrator role you already hold a valid approved TPI request, and you can approve or cancel your own or other TPI request.
User management and access control commands
Use the user management and access control commands to configure remote authentication service, access control, and manage users and groups on the system.
Volume commands
Use the volume commands to work with volume options for the system.

Parent topic: Command-line interface