Dell EMC PowerStore CLI User Guide 1.x December 2020 Rev.
Notes, cautions, and warnings NOTE: A NOTE indicates important information that helps you make better use of your product. CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem. WARNING: A WARNING indicates a potential for property damage, personal injury, or death. © 2020 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries.
Contents Additional Resources.....................................................................................................................4 Chapter 1: Introduction................................................................................................................. 5 Overview................................................................................................................................................................................5 Use PowerStore CLI in scripts..........
Preface As part of an improvement effort, revisions of the software and hardware are periodically released. Some functions that are described in this document are not supported by all versions of the software or hardware currently in use. The product release notes provide the most up-to-date information about product features. Contact your technical support professional if a product does not function properly or does not function as described in this document.
1 Introduction This document provides a reference for using the PowerStore command line interface (CLI) to work with your system. Topics: • • • • • • • • • • Overview Set up the PowerStore CLI client PowerStore CLI command syntax Action commands Get help Manage SSL certificates View the switches Access the system Display the header Save PowerStore CLI settings Overview The PowerStore Manager CLI enables you to run commands on a system through a prompt from a Microsoft Windows or UNIX/ Linux host.
Steps 1. Go to your support website. 2. Download the PowerStore CLI client for your operating system. 3. Perform the following actions based on your operating system: ● On Windows, double-click the installer and follow the prompts. The default installation location is: ○ 64-bit systems: C:\Program Files\Dell EMC\PowerStore CLI ○ 32-bit systems: C:\Program Files (x86)\Dell EMC\PowerStore Manager CLI NOTE: Check the box to have the installation directory added to the PATH system variable.
Switches Use switches to configure PowerStore CLI and connect to a system. Type switches immediately after pstcli. When typing more than one switch on the same line, separate each switch with a space. All switches start with a hyphen (-). View the switches on page 13 provides details on all available switches. Object types Object types identify the type of entity on which to perform an action, such as a local_user, host, volume, or cluster. All actions require an object type.
Example In the following example for changing the password of a user account, the action is set: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user -name operator set –password NewPassword456! –current_password OldPassword456! Action qualifiers Action qualifiers are parameters specific to actions, such as attributes or settings to modify when changing an object. All action qualifiers start with a hyphen (-).
Example The following example uses the create action command to create a volume. The new volume receives the ID 12345: pstcli -d 10.0.0.1 -u admin -p MyPassword456! -header volume create -name test -size 819200000 NOTE: The following output shows the header because the -header switch is included in the command. By default, the header is not displayed: PowerStore system: 10.0.0.
Qualifier Description ● table—The table format displays output as a table, with column headers and rows. By default, values that are too long to fit in a column are cut off. ● json—The JSON format is the JSON representation of the data, similar to the corresponding REST API response body. ○ -raw—Removes human-readable formatting such as new lines and indentation for JSON output. ● csv—The comma-separated values (CSV) format is similar to the table format, but the names and values are separated by commas.
"wwn": "naa.68ccf098007d921192aec35c4449c1b4", "state": "Ready", "size": 81920000 }, { "id": "616b80db-f8ad-46cb-b958-f9c8a7940770", "name": "tal2", "description": "", "type": "Primary", "wwn": "naa.68ccf09800c6c60a72678f4c3c71ddff", "state": "Ready", "size": 819200000 }, { "id": "cab12dab-a421-49e2-a9f0-8f0812b88bd9", "name": "tal4", "description": "", "type": "Primary", "wwn": "naa.
● Details about a specific action such as syntax and description of each parameter Help on the PowerStore CLI client For help on the client, including the use cases, switches, and system requests, type only pstcli or include the -help|-? switch. View the switches on page 13 provides details on all available switches. Example The following command displays information about the syntax and switches: pstcli -? Enter interactive session.
-is_replication_destination { yes | true | no | false } ] [ -async ] Modify the parameters of a volume. Where: [Choice] { -id | -name } -id Unique identifier of the volume to modify. -name Reference object (volume) by name. [Optional] -name New name of the volume. This value must contain 128 or fewer printable Unicode characters. [Optional] -description New description of the volume. This value must contain 128 or fewer printable Unicode characters.
Switches destination|d IP (IPv4 or IPv6) address or network name of the destination system. If you do not include this switch, the client uses the addresses that are specified for -default. -port Port number on the system. -user|-u Username for logging in to the system. -password|-p Password for logging in to the system. -ssl_policy|ssl Policy for handling unknown SSL certificates downloaded from the system.
Example 3 The following example sets the destination system as the default: pstcli -d 10.0.0.1 -u admin -p MyPassword456! -default Example 4 The following example removes the saved access credentials from destination system 10.0.0.1: pstcli -d 10.0.0.1 -remove_cred Access the system To access and run commands on a system through PowerStore CLI, specify the network name or management IP address of the system, your username, and your password.
Save PowerStore CLI settings You can save the following settings on the host on which you run PowerStore CLI: ● User access credentials, including your username and password, for each system you access For more information, see -save_cred on page 14 ● SSL certificates imported from the system ● Information about default system to access through PowerStore CLI, including the system name or IP address and the system port number For more information, see -default on page 14.
