ManualsPro DELL EMC Dell EMC EMC PowerStore Scalable All Flash Storage User Guide

Dell EMC EMC PowerStore Scalable All Flash Storage User Guide

June 10, 2024
DELL EMC

Dell EMC EMC PowerStore Scalable All-Flash Storage

Dell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage- PRODUCT

Product Information

The Dell EMC PowerStore is a storage solution that provides a command-line interface (CLI) for managing and automating routine tasks. The PowerStore CLI can be installed on Microsoft Windows or UNIX/Linux computers, and it sends commands to the system through the secure HTTPS protocol using the PowerStore REST API.

Usage Instructions

1. Set up the PowerStore CLI client

To install the PowerStore CLI client, follow these steps:

  1. Go to your support website.
  2. Download the PowerStore CLI client for your operating system.
  3. On Windows, double-click the installer and follow the prompts. On UNIX/Linux, type: rpm -ihv , where is the name of the installer.
  4. Launch the PowerStore CLI client.

2. Use PowerStore CLI in scripts

Use scripts with PowerStore CLI to automate routine tasks, such as provisioning storage or scheduling snapshots to protect stored data. For example, create a script to create a snapshot of an iSCSI LUN and delete the older snapshots created before it. Customer Support does not provide sample scripts or support for custom scripting.

3. Certificate verification

Ensure that you verify the certificate before using the PowerStore CLI command.

4. PowerStore CLI command syntax

Refer to the product release notes for the most up-to-date information about PowerStore CLI command syntax.

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.

Additional Resources

For support, product, and licensing information, refer to the product release notes or contact your technical support professional if a product does not function properly or does not function as described in the user manual.

Notes, cautions, and warnings

  • NOTE indicates important information that helps you make better use of your product.
  • CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the problem.
  • WARNING indicates a potential for property damage, personal injury, or death.

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.

Where to get help

Support, product, and licensing information can be obtained as follows:

Product information

Troubleshooting

  • For information about products, software updates, licensing, and service, go to https://www.dell.com/support and locate the appropriate product support page.

Technical support

  • For technical support and service requests, go to https://www.dell.com/support and locate the Service Requests page. To open a service request, you must have a valid support agreement. Contact your Sales Representative for details about obtaining a valid support agreement or to answer any questions about your account.

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/TLS 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. The PowerStore Manager
  • CLI is intended for users who want to interactively manage a PowerStore system, or to use commands in scripts for automating routine tasks.
  • Use the PowerStore Manager CLI to manage a system. Tasks include:
  • Configuring and monitoring the system
  • Managing users
  • Provisioning storage
  • Protecting data
  • Controlling host access to storage
  • Refer to the PowerStore CLI Reference Guide on https://www.dell.com/support for more information on the commands and associated qualifiers available with
  • PowerStore.

Use PowerStore CLI in scripts

  • Use scripts with PowerStore CLI to automate routine tasks, such as provisioning storage or scheduling snapshots to protect stored data. For example, create a script to create a snapshot of an iSCSI LUN and delete the older snapshots created before it. Customer Support does not provide sample scripts or support for custom scripting.

Set up the PowerStore CLI client

  • You can install and launch the PowerStore CLI client on a Microsoft Windows or UNIX/Linux computer. PowerStore CLI sends commands to the system through the secure HTTPS protocol using the PowerStore REST API.
Install the PowerStore CLI client

About this task

  • To install the PowerStore CLI client:

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.
    • On UNIX/Linux, type: rpm -ihv , where filename is the name of the installer. The default installation location is: /opt/dellemc/pstcli-/bin/, where is the version of the client installed.
Launch the PowerStore CLI client

About this task
After installing the PowerStore CLI client, you can launch the client on a Microsoft Windows or UNIX/Linux computer. To launch the PowerStore CLI client, perform the following in a command prompt based on your operating system:
Steps

  1. If you have a Windows operating system, type: pstcli.exe
  2. If you have a UNIX/Linux operating system, type: /usr/bin/pstcli

Certificate verification
In order to establish a secure connection between PowerStore CLI and its backend server, a Public Key infrastructure (PKI) is used. An important component of PKI is certificate verification. Certificate verification provides a way for a user to verify the backend server being contacted.
When PowerStore CLI connects to a server requesting a secure connection, the server sends its identification in the form of a digital certificate. The certificate usually contains the following:

  • Server name
  • Trusted certificate authority (CA)
  • Server’s public encryption key.
  • The PowerStore CLI client can contact the server that issued the certificate (the trusted CA) and confirm the validity of the certificate before proceeding. When the certificate is verified, PowerStore CLI and its backend server will establish the connection and begin to exchange data.

PowerStore CLI command syntax

  • The syntax of an example command line is as follows: pstcli ] [] [

    Executable

    • All command lines begin with the executable pstcli. If you do not start each command line with pstcli, the command fails and you must rerun the command. If you run only pstcli, without any switches or commands, the list of switches and their descriptions is displayed.
    • If you are in session mode, you do not have to include pstcli in the command line. Also, you can press TAB after typing the first letter of the switch to autocomplete the switch.

    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. The one exception is the -help switch, which can be used without an object type. Get help on page 11 explains how to use the -help switch.
    • The object instance on which you perform an action is designated by an identifier that is called an object qualifier, as explained in Object qualifiers on page 7.

    Example 1

    • In the following example for creating a user, the object type is local_user: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user create –name user1 –password Password789! –role_id operator

    Example 2

    • The following example for viewing all user accounts on the system shows that the object type is also local_user. An object identifier is not specified, so the show action displays a list of all user accounts: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user show

    Object qualifiers

    • Object qualifiers are unique identifiers for objects on the system. Object qualifiers are displayed in the following format:
    • id
    • name
    • All object types have identifiers that can be used as qualifiers to specify a unique object instance. Some object types have names. For object types that have names, the name qualifier can be used as an alternate to the ID qualifier.
    • When you create an object, such as a user or network interface, it receives an ID, which is the primary object qualifier for that object. The uniqueness of the ID is only guaranteed in the scope of the specified object type. When performing actions such as viewing, modifying, or deleting an object, you specify an object qualifier. All object qualifiers start with a hyphen (-).

    Example

    • In the following example for changing the password of a user account, the object type is local_user, and the qualifier that is used is -name, with a value of operator:
      pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user -name operator set –password NewPassword123! –current_password MyPassword456!

    Actions

    • Actions are the operations that are performed on an object instance or object type, including creating, modifying, viewing, and deleting. Actions are always required. Action commands on page 8 provides details on each of the action commands.

    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

    • In the following example for changing a role and password for a user account, the action qualifiers are -password, -current_password, and -role:
      pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user -name lab3_operator set -password NewPassword123! -current_password MyPassword456! -role administrator

    Size qualifiers

    • Use size qualifiers to indicate a specific capacity-size value. In this case, 1 KB equals 1024 bytes.

    • To specify a fraction, use a period. For example, type 2.4T for 2.4 terabytes. The output for a size value displays the exact number of bytes and the specified size value:
      Size = 1209462790557 (1.1TB)

    • The following table lists the size qualifiers. The qualifiers are case-sensitive.

    Table 1. Size qualifiers

    Qualifier Measurement
    K Kilobyte
    M Megabyte
    G Gigabyte
    T Terabyte
    P Petabyte

    Action commands
    When using PowerStore CLI, there are four primary action commands that you can perform on object types or objects: creating, modifying or configuring, viewing, and deleting. This section explains each of these four action commands. PowerStore CLI command syntax on page 6 explains the relationship between action commands, object types, and objects.
    The create action command
    The create action command creates an object on the system that is based on the specified object type. If the command is successful, the new object receives an object qualifier, or ID, that identifies the object on the system.
    Format

    create []

    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:Dell-EMC- EMC-PowerStore-Scalable-All-Flash-Storage-FIG-1

    The set action command

    The set action command modifies an object instance that is specified by object type and object qualifier. If the object identified by the object qualifier does not exist, an error results.
    Format

    [] set [] **Example** **The following example uses the set action command to change the name of a volume:** pstcli -d 10.0.0.1 -u admin -p MyPassword456! volume –name old_name set –name new_name **The following output should be displayed:** Success.
    The show action command

    The show action command displays a list of objects that exist on the system and the attributes of those objects. You can
    specify an object qualifier to view the attributes for a single object. The show action command provides qualifiers for changing the display of the output, including the format and the attributes to include. The available output formats are name-value pair (NVP), table, JSON, and comma-separated values (CSV).
    Format

    [] show [-select ,…] [-sort (+|-)] [-offset ] [{ -limit | -all }] [-output {nvp | table | json [-raw]| csv [-table] [-noformat]}] **Action qualifiers**
    Qualifier Description
    -o, -output Specify the output format. Value is one of the following:

    ●nvp—The name-value pair (NVP) format displays output as name=value.

    ●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.

    Qualifier Description
      ●        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.

    ○        -noformat—Removes human-readable formatting for size and speed values to ease data import.

    ○        -table—Exports csv with table formatting; instances with embedded arrays are split into several lines after importing csv as a table.

    -select| Display the list of fields specified instead of the default fields.
    -sort| Sort the output by the specified fields. Prefix a field with + to sort ascending (default), or – to sort descending.
    -offset| Specifies where to start in a result set. Offset 0 is the normal start of the list. Offset 100 skips the first 100 instances and start the output with the 100th instance.
    -limit |

    -all

    | Specifies how many instances to show. The default is 100. -all displays all instances, up to a limit of 2000. For longer lists, use -offset and -limit together to show chunks of data iteratively.

    Name-value pair formatDell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage- FIG-2

    Table formatDell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage- FIG-3

    JSON formatDell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage- FIG-4Dell-EMC-EMC-PowerStore- Scalable-All-Flash-Storage-FIG-5

    Comma-separated values format

    The delete action command

    The delete action command removes an object from the system based on the specified object and object qualifier.
    Format

    [] delete **Example** The following command deletes user1: pstcli -d 10.0.0.1 -u admin -p MyPassword456! local_user –name user1 delete
    Get help

    For help with using the CLI, use the -help, –help, -h, –h or -?.
    Depending on the context where this command is used, it can provide the following information:

    • List of CLI object types
    • Details about a specific object such as attributes and action syntax
    • 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

    • Does the following command display information about the syntax and switches: pstcli -?Dell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage-FIG-7

    Help on object types

    • For help on object types, specify the object type with the -help switch to view a list of supported action commands.

    Example

    • The following command displays the action commands to set (change) and show a DNS server setting with the dns object type. In the output, the items in brackets are the actions, such as creating and modifying, that can be performed on the object type: pstcli -d 10.0.0.1 -u admin -p MyPassword456! dns –?Dell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage-FIG-8

    Help on actions

    • For help on an action command, type the object type and action command followed by -h, -help, or -?.

    Example

    • The following command displays the list of volume attributes that you can change: pstcli -destination 10.55.34.87 -u admin -p MyPassword456! /volume set -?Dell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage-FIG-9Dell-EMC-EMC-PowerStore-Scalable-All-Flash-Storage-FIG-10

    Manage SSL/TLS certificates

    • When logging in to the system through PowerStore CLI, the system uses SSL/TLS certificates to secure communications between the CLI client and the system. You can manage these certificates and configure a policy for the PowerStore CLI to use when receiving unknown certificates. All downloaded certificates are stored in the secure, local lockbox on the client system. Save PowerStore CLI settings on page 15 explains how settings are saved.

    View the switches

    • The PowerStore CLI switches apply only to your installed PowerStore CLI client. Use the switches to access a system, upload files to the system, and manage security certificates.

    Format

    • pstcli [{-help|-h|-?}]

    Switches

    • destination-dIP (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. Value is one of the following:
    • interactive — Prompt the user to accept the certificates for the current session (default).
    • reject — Automatically reject the certificates.
    • accept — Automatically accept the certificates.
    • store — Automatically accept and store the certificates.
    • cert_list List of all certificates stored locally in the lockbox.
    • cert_clear Delete all certificates stored locally in the lockbox.
    • cert del Delete one or more certificates from the lockbox. Type a comma-separated list of certificate IDs.
      • NOTE: Use -cert_list to view a list of stored certificates with their IDs.
    • help|-h|-? Display information about the syntax and switches, a list of command categories available on the target system, and information about getting further help on specific topics.
    • save_ cred Save the access credentials that are specified for the -user and -password switches to a local security file in the lockbox. With the access credentials saved, PowerStore CLI automatically applies them to the specified system destination and port pair each time you run a command. Save PowerStore CLI settings on page 15 explains saving user account credentials to the local client system.
    • remove_cred Remove the specified user account from the lockbox.
    • Remove_all_creds Remove all user accounts from the lockbox.
    • default Save the destination, port pair, and SSL policy as defaults. You can use the -default switch with the -destination, -port, or -ssl_policy switches, or with any combination of those switches. The saved SSL policy applies to the client for all destinations. Also, you can update the destination and port separately. Save PowerStore CLI settings on page 15 explains saving user account credentials to the local client system.
    • header Shows the header message (system IP address, port number, and so on), which is hidden by default, above the command output.
    • -v|-version Display the version of your PowerStore CLI.
    • -clear_ cache Clear cached data.

    Example 1

    • The following example accesses the destination system 10.0.0.1 as user admin with password MyPassword456!: pstcli -d 10.0.0.1 -u admin -p MyPassword456!

    Example 2

    • The following example saves the access credentials for the specified user: pstcli -d 10.0.0.1 -u admin -p MyPassword456! -save_cred

    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.

    Format

    • [{-d|-destination} ] [{-u|-user} ] [{-p|-password} ]

    Switches

    • destination|-d IP 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. If no default address exists, the client uses the localhost address 127.0.0.1.
    • user|-u Username for logging in to the system. For example, admin.
    • password|-p Password for logging in to the system.
    • port Specify the port number through which to access the system.
      • NOTE: If you do not include the -port switch, PowerStore CLI accesses the system through default port 443.
    • default Save the destination, port pair, and SSL policy as defaults. You can use the -default switch with the-destination, -port, or -ssl_policy switches, or with any combination of those switches. The saved SSL policy applies to the client for all destinations. Also, you can update the destination and port separately. Save PowerStore CLI settings on page 15 explains saving user account credentials to the local client system.
    Display the header

    You can display the header each time you run a switch or command. The header displays the destination system, system port number, the syntax, and communication protocol used (HTTPS).
    The following example shows the header that is displayed after including the -header switch in a command:

    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
    • 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.
    • PowerStore CLI saves the settings to a secure lockbox that resides locally on the host on which PowerStore CLI is installed. The stored data is only available on the host where it was saved and to the user who saved it. The lockbox resides in the following locations:
    • On Windows XP: C:\Documents and Settings\\Local Settings \Application Data\.pstcli
    • On Windows 7 and Windows 10: C:\Users\${user_name}\AppData\Local\.pstcli
    • On UNIX/Linux: /.pstcli
    • © 2020 – 2022 Dell Inc. or its subsidiaries. All rights reserved. Dell, EMC, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners.

    Read User Manual Online (PDF format)

    Loading......

    Download This Manual (PDF format)

    Download this manual  >>

    DELL EMC User Manuals

    Dell EMC PowerEdge R650 Instruction Manual
    DELL EMC
    DELL EMC PowerEdge XR12 Rack Server Instruction Manual
    DELL EMC
    DELL EMC Support and Service for APEX Instructions
    DELL EMC
    DELL EMC R340 PowerEdge Rack Server User Guide
    DELL EMC
    DELL EMC Repository Manager Version 3.4.1 User Guide
    DELL EMC
    DELL EMC SC9000 Storage Array User Guide
    DELL EMC
    DELL EMC OpenManage Enterprise Power Manager 3.0 User Guide
    DELL EMC
    DELL EMC OpenManage Plug-in version 3.2.0 for Nagios Core User Guide
    DELL EMC
    DELL EMC Repository Manager Version 3.4.2 Release Notes User Guide
    DELL EMC
    DELL EMC PowerEdge MX7000 Management Module User Guide
    DELL EMC
    DELL EMC EMC PowerStoreOS Release Notes Instructions
    DELL EMC
    Dell EMC EMC PowerStore Scalable All Flash Storage User Guide
    DELL EMC
    Dell EMC MX7000 OpenManage Enterprise User Guide
    DELL EMC
    DELL EMC E660 VxRail Hyperconverged Storage User Manual
    DELL EMC
    DELL EMC PowerEdge R650xs Rack Server User Guide
    DELL EMC
    DELL EMC 12M1H PowerEdge R450 Intel Xeon Silver User Guide
    DELL EMC
    Dell EMC S3048-ON EMC PowerSwitch Installation Guide
    DELL EMC
    Dell EMC PowerEdge T440 Tower Server User Guide
    DELL EMC
    Dell EMC EMC Secured Component Verification Reference User Guide
    DELL EMC
    Dell EMC DRM-3-4-4 Repository Manager User Guide
    DELL EMC

    Related Manuals

    HoMEDICS TH-SPTF2000-GB Truheat Rechargeable Shiatsu Pillow Instruction Manual
    Homedics
    jaycar XC4314 Gaming Desk with RGB LEDs Instruction Manual
    Jaycar
    AIRSTAGE UTY-TFSXH3 WLAN Adapter USB WiFi interface Instruction Manual
    AIRSTAGE
    RetroSound PA02 Power Antenna Installation Guide
    RetroSound
    pTron Avento Lite High Bass Wireless Earphones Instruction Manual
    pTron
    EcoSavers Timer Shower Coach Time User Manual
    ECOSAVERS
    TYRO remote Musca 2S Remote Control Instructions
    TYRO remote
    KARCHER VC 6 Cordless Vacuum Cleaner Instructions
    Karcher
    Gmobi GD467C Magnetic Wireless Charger User Manual
    Gmobi
    REMINGTON S8A9 Series Flat Iron User Guide
    Remington
    MPS Cornice-Camino-Caldera Wood Frames for Fireplaces Instruction Manual
    MPS
    CONRAD 2498548 Bike Stand Instruction Manual
    CONRAD
    sinope LM4110-ZB Tank Monitor Installation Guide
    sinope
    DuroMax XP4500iH 4500 Watt Dual Fuel Portable Inverter Generator Instructions
    DuroMax
    Pyle PDWM811RD UHF 2 Channel Wireless Handheld Microphone User Guide
    Pyle
    RICE LAKE H151-11-5 Class I MDR Physician Scale Instruction Manual
    RICE LAKE
    MASTERFORCE 21133 Overhead Storage Rack User Manual
    MASTERFORCE
    Circutor ePick GPRS NET DataBox Gateway Instruction Manual
    Circutor
    TRISTAR VE-5923 Desk Fan Instruction Manual
    Tristar
    Qaise QPB-21501 Portable Speaker Instruction Manual
    Qaise
    HELITE Airbag e-GP Air Electronic User Guide
    HELITE
    EJEAS AIH1 Smart Helmet Headset User Manual
    EJEAS
    VOLLRATH FC-4SH-48208-BR-SW Low Profile Heat Strips Instruction Manual
    VOLLRATH
    Shenzhen Cenwapet Technology C-collar S08 No-Bark Collar User Manual
    Shenzhen Cenwapet Technology
    oricom BC090 12V Battery Charger User Manual
    oricom
    LIEBHERR SIGN27 Integrated Freezer Owner’s Manual
    LIEBHERR
    FRECAN GA 530 Built In Range Extractor Hood Instruction Manual
    FRECAN
    Whirlpool 400011710470 Built In Electric Oven Instruction Manual
    Whirlpool
    VACLIFE VL188 Cordless Vacuum Cleaner User Manual
    VacLife
    LNC YUMNR2LWS4911F8 Vine 3 Light 13 Inch LED Flush Mount Light Installation Guide
    LNC
    Contact Us   Privacy Policy   6.239ms