7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
1/62
SANtricityStorage Manager
Command Line Interface andScript Commands
Quick Reference for Version 9.25
ES1790-0-E1, First Edition
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
2/62
Proprietary Rights Notice
This document contains proprietary information of LSI Logic Corporation. The information contained
herein is not to be used by or disclosed to third parties without the express written permission of an officer of
LSI Logic. Any products described herein are licensed products of LSI Logic.
Document Description
Document ES1790-0-E1, First Edition. July 2006
This document will remain the official reference source for all revisions and releases of this product until
rescinded by an update.
Disclaimer
It is the policy of LSI Logic Corporation to improve products as new technology, components, software, and
firmware become available. LSI Logic reserves the right to make changes to any products herein at any time
without notice. All features, functions, and operations described herein may not be marketed by LSI Logic
in all parts of the world. In some instances, photographs and figures are of equipment prototypes. Therefore,
before using this document, consult your LSI Logic representative for information that is applicable andcurrent. LSI LOGIC DOES NOT ASSUME ANY RESPONSIBILITY OR LIABILITY FOR THE USE OF
ANY PRODUCTS DESCRIBED HEREIN EXCEPT AS EXPRESSLY AGREED TO IN WRITING BY
LSI LOGIC.
License Restriction
The purchase or use of an LSI Logic Corporation product does not convey a license under any patent,
copyright, trademark, or other intellectual property right of LSI Logic or third parties.
Copyright Notice
2006. LSI Logic Corporation. All rights reserved.
Trademark Acknowledgments
Engenio, the Engenio design, HotScale, SANtricity, and SANshare are trademarks or registered trademarks
of LSI Logic Corporation. All other brand and product names may be trademarks of their respective
companies.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
3/62
SANtricityStorage Manager CLI Quick Reference for Version 9.25 i
Contents
COMMANDLINEINTERFACEANDSCRIPTCOMMANDSQUICKREFERENCE
About the Command Line Interface............................................................................................ 2
Command Line Interface Structure........................................................................................ 2
Usage Notes ........................................................................................................................... 3
CLI Commands ...................................................................................................................... 3
CLI Command Formatting........................................................................................................ 12
Usage Examples................................................................................................................... 13
About the Script Commands ..................................................................................................... 14
Script Command Structure................................................................................................... 14Recurring Syntax Elements.................................................................................................. 15
Script Command Formatting..................................................................................................... 21
Script Commands ...................................................................................................................... 23
Commands Listed by Function ................................................................................................. 46
Controller Commands .......................................................................................................... 46
Host Topology Commands .................................................................................................. 46
Module Commands .............................................................................................................. 47
Physical Disk (Drive) Commands........................................................................................ 47Remote Volume Mirroring Commands ............................................................................... 47
Session Command................................................................................................................ 48
Snapshot Commands............................................................................................................ 48
Storage Array Commands.................................................................................................... 48
Uncategorized Command..................................................................................................... 49
Volume Commands.............................................................................................................. 50
Volume Copy Commands.................................................................................................... 50
Volume Group Commands .................................................................................................. 51
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
4/62
ii SANtricityStorage Manager CLI Quick Reference for Version 9.25
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
5/62
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
6/62
iv SANtricityStorage Manager CLI Quick Reference for Version 9.25
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
7/62
SANtricityStorage Manager CLI Quick Reference for Version 9.25 v
Document Conventions
Definitions of Safety Notices
DANGER Indicates an imminently hazardous situation that will result in death or
severe personal injury.
WARNING Indicates a potentially hazardous situation that could result in death or
severe personal injury.
CAUTION Indicates a potentially hazardous situation that could result in moderate or
minor personal injury.
Definitions of Informational Notices
CAUTION Indicates a potentially hazardous situation that could result in data loss (or
other interruption) or equipment damage.
IMPORTANT Indicates information or criteria that is necessary to perform a procedure
correctly.
NOTE Indicates a clarification of a concept or presents a maintenance tip.
Typographic Conventions
Italicindicates the title of documents, variables and placeholders in text, emphasized
words, and new terms.
Boldindicates choices in procedures and other emphasized text.
Monospaceindicates arguments, code examples, command-line text, command options,commands, directories, error messages, file names, folders, on-screen text, and user input.
Monospace italicindicates command variables in code, parameters, and
placeholders and variables in code.
Monospace boldindicates keywords and values.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
8/62
vi SANtricityStorage Manager CLI Quick Reference for Version 9.25
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
9/62
SANtricityStorage Manager CLI Quick Reference for Version 9.25 vii
About This Document
This document is a quick reference that lists the command line interface commands and
the script commands for the SANtricity Storage Manager Version 9.25 software. This
document provides the following information:
A brief overview of the command line interface and script commands
The command line interface commands
The script commands
The command syntax
A brief description of the purpose of each script command
This document assumes that the user has a knowledge of basic storage area network
(SAN) hardware and installation skills. Read the Storage System Product Release Notes
for Version 9.25for any updated information regarding hardware, software, or firmwareproducts that might not be described in this document.
Intended Readers
This document is intended for system operators, system administrators, and service
personnel who are responsible for operating, maintaining, troubleshooting, and servicing a
storage array. Users must be familiar with computer system operation, maintenance, andrepair. In addition, they should understand disk array, Redundant Array of Independent
Disks (RAID) concepts, network, and Fibre Channel technologies. The reader must have a
basic knowledge of SAN hardware functionality (controllers, drives, hosts) and SAN
cabling.
Related Publications
SANtricity Storage Manager Command Line Interface and Script Commands
Programming Guide for Version 9.25
Storage System Product Release Notes for Version 9.25
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
10/62
viii SANtricityStorage Manager CLI Quick Reference for Version 9.25
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
11/62
SANtricityStorage Manager CLI Quick Reference for Version 9.25 1
Command Line Interface and ScriptCommands Quick Reference
The command line interface and script commands provide a tool set that enables users to
configure and maintain a storage array directly from the command line in the operating
system. This quick reference provides:
A brief description of the command line interface
A list of the commands and parameters for the command line interface (CLI)
An overview of the script commands
An explanation of the command formatting
A table that alphabetically lists the script commands and briefly describes the
purpose of each command
A functional list of the commands, in which the commands are organized by
operational utility in the storage array
This quick reference helps you find the correct syntax and parameters for the commands
that you are using. It is not intended to be a complete programming guide. This quickreference is for users who have read and understood the information in the SANtricity
Storage Manager Command Line Interface and Script Commands Programming Guide. If
you have questions related to the commands or parameters listed in this quick reference,
refer to the programming guide for additional information.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
12/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
2 SANtricityStorage Manager CLI Quick Reference for Version 9.25
About the Command Line Interface
The command line interface is a software tool that enables storage array installers,
developers, and engineers to configure and monitor storage arrays. Using the command
line interface, you can issue commands from an operating system prompt, such as theDOS C:\prompt, a Linux operating system path, or a Solaris operating system path. Eachcommand performs a specific action for managing a storage array or returning information
about the status of a storage array. You can enter individual commands or you can run
script files when you need to perform operations more than once (such as installing the
same configuration on several storage arrays). The command line interface enables you to
load a script file from a disk and run the script file. The command line interface provides a
way to run storage management commands on more than one network storage array. You
can use the command line interface in both installation sites and development
environments.
Command Line Interface StructureThe commands you run on the CLI provide access to the script engine, specify the storage
array to receive the script commands, and set operation environment parameters.
A CLI command consists of the following elements:
The term SMcli
The storage array identifier
The parameters
The script commands
The general form of a CLI command is:
SMcli storageArrayparametersscript-commands;
where:
SMcliinvokes the command line interface
storageArrayis the name or the IP address of the storage array
parametersare CLI parameters that define the environment and purpose for the
command
script-commandsis one or more script commands or the name of a script filecontaining script commands. (The script commands are the storage array
configuration commands.)
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
13/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface
SANtricityStorage Manager CLI Quick Reference for Version 9.25 3
Usage Notes
If you enter SMcliand a storage array name, but do not specify CLI parameters, scriptcommands, or a script file, the command line interface runs in interactive mode.
Interactive mode enables you to run individual commands without prefixing the
commands with SMcli. In interactive mode, you can enter a single command, view theresults, and enter the next command without typing the complete SMclistring.Interactive mode is useful for determining configuration errors and quickly testing
configuration changes.
If you enter SMcliwithout any parameters or with an incorrect parameter, the scriptengine returns usage information.
CLI Commands
This section lists the CLI commands that you can use to perform the following actions:
Identify storage arrays
Specify passwords
Add storage arrays to configuration files
Specify communications parameters
Enter individual script configuration commands
Specify a file containing script configuration commands
Table 1 lists the conventions used in the general form of a CLI command.
Table 1 Command Name Conventions
Convention Definition
a | b Alternative (a or b)
italicized-words Terminals
[...](square brackets) Zero or one occurrence(Square brackets are also used as a
delimiter for some command
parameters.)
{...}(curly braces) Zero or more occurrences
(a | b | c) Choose only one of the alternatives
bold Terminals
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
14/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
4 SANtricityStorage Manager CLI Quick Reference for Version 9.25
The following are general forms of the CLI commands, showing the parameters and
terminals used in each command. Table 2 on page 5lists definitions for the parameters
shown in the general form of the CLI commands.
SMclihost-name-or-IP-address [host-name-or-IP-address]
[-c command; {command2};][-nstorage-array-name| -wWWN][-ooutputfile][-ppassword][-e][-S][-quick]
SMclihost-name-or-IP-address [host-name-or-IP-address][-fscriptfile][-nstorage-array-name| -wWWN][-ooutputfile][-ppassword][-e][-S][-quick]
SMcli(-nstorage-array-name| -wWWN)[-c command; {command2};][-ooutputfile][-ppassword][-e][-S][-quick]
SMcli(-nstorage-array-name| -wWWN)[-fscriptfile][-ooutputfile][-ppassword][-e][-S][-quick]
SMcli-aemail:email-address[host-name-or-IP-address1[host-name-or-IP-address2]][-nstorage-array-name| -wWWN| -hhost-name|-r (host_sa| direct_sa)][-Iinformation-to-include][-qfrequency][-S]
SMcli-xemail:email-address[host-name-or-IP-address1[host-name-or-IP-address2]]
[-nstorage-array-name| -wWWN| -hhost-name|-r (host_sa| direct_sa)] [-S]
SMcli(-a| -x) trap:community, host-name-or-IP-address[host-name-or-IP-address1[host-name-or-IP-address2]][-nstorage-array-name| -wWWN| -hhost-name|-r (host_sa| direct_sa)] [-S]
SMcli-d [-w][-i][-s][-v][-S]
SMcli-mhost-name-or-IP-address-Femail-address[-gcontactInfoFile][-S]
SMcli-A[host-name-or-IP-address[host-name-or-IP-address]][-S]
SMcli-X (-nstorage-array-name| -wWWN| -hhost-name)
SMcli-?
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
15/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface
SANtricityStorage Manager CLI Quick Reference for Version 9.25 5
Table 2 Command Line Parameters
Parameter Definition
host-name-or-IP-address You can specify either the host name or the Internet Protocol (IP)address (xxx.xxx.xxx.xxx) of an in-band managed storage array or
an out-of-band managed storage array.
If you are managing a storage array using a host through
in-band storage management, you must use the -nor -wparameter if more than one storage array is connected to the
host.
If you are managing a storage array using out-of-band storage
management through the Ethernet connection on each
controller, you must specify the host-name-or-IP-address of
the controllers.
If you have previously configured a storage array in theEnterprise Management Window (EMW), you can specify
the storage array by its user-supplied name using the -nparameter.
If you have previously configured a storage array in the
EMW, you can specify the storage array by its World Wide
Name using the -wparameter.
-A Use this parameter to add a storage array to the configuration files.If you do not follow the -Aparameter with ahost-name-or-IP-address, auto-discovery scans the local subnet
for storage arrays.
-a Use this parameter to add a Simple Network Management Protocol(SNMP) trap destination or an email address alert destination.
When adding an SNMP trap destination, the SNMP
community is automatically defined as the community name
for the trap and the hostis the IP address or Domain Name
Server (DNS) host name of the system to which the trap
should be sent.
When adding an email address for an alert destination, the
email-addressis the email address where you want the alert
message to be sent.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
16/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
6 SANtricityStorage Manager CLI Quick Reference for Version 9.25
-c Use this parameter to indicate that you are entering one or morescript commands to run on the specified storage array. Terminate
each command by a semicolon (;).
You cannot place more than one -cparameter on the samecommand line. You can include more than one script command
after the -cparameter.
-d Use this parameter to display the contents of the scriptconfiguration file. The format of the file contents is:
storage-Array-name host-name1 host-name-2
-e Use this parameter to run the commands without performing asyntax check first.
-F(uppercase) Use this parameter to specify the email address from which allalerts will be sent.
-f Use this parameter to specify a file name containing scriptcommands that you want to run on the specified storage array.
(This parameter is similar to the -cparameter in that both areintended for running script commands. The -cparameter runsindividual script commands. The -fparameter runs a file of scriptcommands.)
By default, any errors encountered when running the script
commands in a file are ignored, and the file continues to run. Tooverride this behavior, use the set sessionerrorAction=stopcommand in the script file.
-g Use this parameter to specify an ASCII file containing emailsender contact information that will be included in all email alert
notifications. The CLI assumes the ASCII file is text only, without
delimiters or any expected format. Do not use this parameter if a
userdata.txtfile exists.
-h Use this parameter to specify the host name that is running theSNMP agent to which the storage array is connected. Use this
parameter with the -aand -xparameters.
Parameter Definition
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
17/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface
SANtricityStorage Manager CLI Quick Reference for Version 9.25 7
-I Use this parameter to specify the type of information to beincluded in the email alert notifications. Valid information
arguments are:
eventOnly
profile
supportBundle
-i Use this parameter to display the IP address of the known storagearrays. Use this parameter with the -dparameter. The format ofthe file contents is:
storage-Array-name IP-address-1 IP-address-2
-m Use this parameter to specify the host name or IP address of the
email server from which email alert notifications will be sent.
-n Use this parameter to specify the name of the storage array onwhich you want to run the script commands. This name is optional
when you use a host-name-or-IP-address; however, if you are
using the in-band method for managing the storage array, you must
use the -nparameter if more than one storage array is connected tothe host at the specified address.
The storage array name is required when the
host-name-or-IP-addressis not used; however, the name of the
storage array configured for use in the Enterprise Management
Window (EMW) (that is, listed in the configuration file) must notbe a duplicate name of any other configured storage array.
-o Use this parameter with the -cor -fparameter to specify a filename for all output text that is a result of running the script
commands. If you do not specify an output file, the output text
goes to stdout. All output from commands that are not script
commands is sent to stdout, regardless of whether this parameter is
set.
-p Use this parameter to specify the password for the storage array onwhich you want to run commands. A password is not necessary
under the following conditions:
1. A password has not been set on the storage array.
2. The password is specified in a script file you are running.
3. You specify the password using the -cparameter and theset session password=passwordcommand.
Parameter Definition
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
18/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
8 SANtricityStorage Manager CLI Quick Reference for Version 9.25
-q Use this parameter to specify how frequently you want to includeadditional profile or support bundle information in the email alert
notifications. An email alert notification containing at least thebasic event information is always generated for every critical
event. If you set the -Iparameter to eventOnly, the only validargument for -qis everyEvent. If you set the -Iparameter toeitherprofileor supportBundle, this information is
included with the emails with the frequency specified by the -qparameter.
Valid frequency arguments are:
everyEvent Information is returned with every email
alert notification
2 Information is returned no more than once every twohours
4 Information is returned no more than once every four
hours
8 Information is returned no more than once every eight
hours
12 Information is returned no more than once every 12
hours
24 Information is returned no more than once every 24
hours
-quick Use this parameter to reduce the amount of time that is required to
run a single-line operation. (An example of a single-line operationis the recreate snapshot volumecommand. Thisparameter reduces time by not running background processes for
the duration of the command.
Do not use this parameter for operations involving more than one
single-line operation. Extensive use of this command can overrun
the controller with more commands than the controller can
process, which causes operational failure. Also, status and
configuration updates normally collected from background
processes will not be available to the CLI. This parameter causes
operations that depend on background information to fail.
-r Use this parameter with the -aor -xparameter to specify thename of an organizer node. The name of an organizer node can be
either direct_sa(out-of-band storage array organizer node) or
host_sa(in-band storage arrays organizer node [host-agent]). The
-rparameter enables you to set or change the alert notificationsfor all storage arrays under each organizer node.
Parameter Definition
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
19/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface
SANtricityStorage Manager CLI Quick Reference for Version 9.25 9
-S(uppercase) Use this parameter to suppress informational messages describingcommand progress that appear when running script commands.
(Suppressing informational messages is also called silent mode.)This parameter suppresses the following messages:
Performance syntax check
Syntax check complete
Executing script
Script execution complete
SMcli completed successfully
-s(lowercase) Use this parameter with the -dparameter to display the alertsettings in the configuration file.
-v Use this parameter with the -dparameter to display the current
global status of the known devices in a configuration file.
-w Use this parameter to specify the WWN of the storage array. Thisparameter is an alternate to the -nparameter. Use the -wparameter with the -dparameter to display the WWNs of theknown storage arrays. The format of the file content is:
storage-array-name world-wide-name
IP-address-1 IP-address-2
-X(uppercase) Use this parameter to delete a storage array from a configuration.
-x( lowercase) Use this parameter to remove an SNMP trap destination or anemail address alert destination. The communityis the SNMP
community name for the trap, and the hostis the IP address or
DNS host name of the system to which you want the trap sent.
-? Use this parameter to display usage information about the CLIcommands.
Parameter Definition
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
20/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
10 SANtricityStorage Manager CLI Quick Reference for Version 9.25
Exit Status
After you run a CLI command, status is displayed that indicates the success of the
operation that is defined by the command. The statuses are shown in Table 3 .
Table 3 Exit Status
Status
ValueMeaning
0 The command terminated without an error.
1 The command terminated with an error. Information about the
error is also displayed.
2 The script file does not exist.
3 An error occurred while opening an output file.
4 A storage array is not at the specified address
5 Addresses specify different storage arrays.
6 A storage array name does not exist for the host agent connected.
7 The storage array name was not at the specified address.
8 The storage array name was not in the configuration file.
10 A management class does not exists for the storage array.
11 A storage array was not found in the configuration file.
12 An internal error occurred.
13 Invalid script syntax was found.
14 The RAID controller module was unable to communicate with the
storage array.
15 A duplicate argument was entered.
16 An execution error occurred.
17 A host was not at the specified address.
18 The WWID was not in the configuration file.19 The WWID was not at the address.
20 An unknown IP address was specified.
21 The event monitor configuration file was corrupted.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
21/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface
SANtricityStorage Manager CLI Quick Reference for Version 9.25 11
22 The storage array was unable to communicate with the event
monitor.
23 The RAID controller module was unable to write alert settings.
24 The wrong organizer node was specified.
25 The command was not available.
26 The device was not in the configuration file.
27 An error occurred while updating the configuration file.
28 An unknown host error occurred.
29 The sender contact information file was not found.
30 The sender contact information file could not be read.
31 The userdata.txt file exists.
32 An invalid -Ivalue in the email alert notification was specified.
33 An invalid -fvalue in the email alert notification was specified.
Status
ValueMeaning
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
22/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
12 SANtricityStorage Manager CLI Quick Reference for Version 9.25
CLI Command Formatting
Double quotation marks ( ) used as part of a name or label require special consideration
when you run the CLI and script commands on a Microsoft Windows operating system.
The following bullet items explain how to use double quotation marks in names whilerunning CLI and script commands on a Windows operating system.
When double quotation marks ( ) are part of a name or argument, you must insert a
backslash (\) before each double quotation mark character. For example:
-c set storageArray userLabel=\Engineering\;
where Engineering is the storage array name. A second example is:
-n \My\_Array
where My_Array is the name of the storage array.
You cannot use double quotation marks ( ) as part of a character string (also calledstring literal) within a script command. For example, you cannot enter the following
string to set the storage array name to Finance Array:
-c set storageArray userLabel=\\Finance\Array\;
In the UNIX and Solaris operating systems, the delimiters around names or labels are
single quotation marks ( ). The UNIX versions of the previous examples are:
-c set storageArray userLabel=Engineering;
-n My_Array
In a Windows operating system, if you do not use double quotation marks ( ) around aname, you must insert a caret (^) before each special script character. Special characters
are ^, |, .
Insert a caret before each special script character when used with the -n, -o, -f,and -pparameters. For example, to specify storage array CLI>CLIENT, enter thefollowing string:
-n CLI^>CLIENT
Insert one caret (^) before each special script character when used within a script
command string literal. For example, to change the name of a storage array to
FINANCE_|_PAYROLL, enter the following string:
-c set storageArray userLabel=\FINANCE_^|_PAYROLL\;
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
23/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CLI Command Formatting
SANtricityStorage Manager CLI Quick Reference for Version 9.25 13
Usage Examples
The following examples show how to enter CLI commands on a command line. The
examples show the syntax, form, and, in some examples, script commands. Examples are
shown for both Windows and UNIX systems. Note that the usage for the -cparametervaries depending on your operating system. On Windows operating systems, enclose the
script command following the -cparameter in double quotation marks ( ). On UNIXoperating systems, enclose the script command following the -cparameter in singlequotation marks ( ).
This example shows how to delete an existing volume and create a new volume on a
storage array. The existing volume name is Stocks_
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
24/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
14 SANtricityStorage Manager CLI Quick Reference for Version 9.25
About the Script Commands
You can use the script commands to configure and manage a storage array. The script
commands are distinct from the CLI commands; however, you enter the script commands
using the command line interface. You can enter individual script commands, or you canrun a file of script commands. When you enter an individual script command, you include
it as part of a CLI command. When you run a file of script commands, you include the file
name as part of a CLI command. The script commands are processed by a script engine
that performs the following functions:
Verifies command syntax
Interprets the commands
Converts the commands to the appropriate protocol-compliant commands
Passes the commands to the storage array
At the storage array, the script commands are run by the storage array controllers.
Script Command Structure
All script commands have the following structure:
commandoperand-data{statement-data}
where:
commandidentifies the action to be performed
operand-datarepresents the objects associated with a storage array that you want toconfigure or manage
statement-dataprovides the information needed to perform the command
The syntax for operand-datais:
(object-type| allobject-types| [qualifier] (object-type[identifier] {object-type identifier]} | object-types[identifier-list]))
You can identify an object in four ways:
Object type Use an object type when the command is not referencing a specific
object
allparameter All objects of the specified type in the storage array (for example,
allVolumes)
Square brackets ([ ]) Use square brackets to identify a specific object on which to
perform the command (for example, volume[engineering])
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
25/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .About the Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 15
List of identifiers A subset of objects in square brackets (for example,
volumes[sales engineering marketing])
A qualifier is necessary if you want to include additional information to describe the
objects. Table 4lists the object type and identifiers associated with the object types.
Table 4 Object Types and Identifiers
Statement data is in the form of attribute=value(raidLevel=5), an attribute name
(batteryInstallDate), or an operation name(redundancyCheck).
Recurring Syntax Elements
Recurring syntax elements are a general category of variables and parameters you can use
in one or more script commands. Table 5 on page 16lists the recurring syntax and thevalues that you can use with the syntax. The conventions listed in Table 1 on page 3define
the meaning of the syntax values.
Object Type Identifier
controller a or b
drive Tray ID and slot ID
drivechannel Drive channel identifier
host User label
hostchannel Host channel identifierhostgroup User label
hostport User label
remote mirror Primary volume user label
snapshot Volume user label
storagearray Not applicable
tray Tray ID
volume Volume user label or volume World Wide Name (WWN) (set
command only)
volumecopy Target volume and, optionally, the source volume user labels
volumegroup Volume group number
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
26/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
16 SANtricityStorage Manager CLI Quick Reference for Version 9.25
Table 5 Recurring Syntax Elements
Recurring Syntax Syntax Value
raid-level (0 | 1 | 3 | 5)
repository-raid-level (1 | 3 | 5)
capacity-spec integer-literal [KB | MB | GB | TB | Bytes]
segment-size-spec integer-literal
boolean (TRUE | FALSE)
user-label string-literal
user-label-list user-label {user-label}
create-raid-vol-attr-value-list create-raid-volume-attribute-value-pair
{create-raid-volume-attribute-value-pair}
create-raid-volume-attribute-value-pair capacity=capacity-spec|
owner=(a | b) |
readAheadMultiplier=integer-literal|
segmentSize=integer-literal
trayId (099)
slot-id (132)
port-id (0127)
drive-spec trayID, slotIDdrive-spec-list drive-spec{drive-spec}
tray-id-list trayID{trayID}
hex-literal 0xhexadecimal-literal
volume-group-number integer-literal
filename string-literal
error-action (stop | continue)
drive-channel-identifier (1 | 2 | 3 | 4)
drive-channel-identifier-list drive-channel-identifier{drive-channel-identifier}
host-channel-identifier
(all command modules except E6000)
(a1 | a2 | b1 | b2)
host-channel-identifier
(E6000 command module only)
(a1 | a2 | a3 | a4)
(b1 | b2 | b3 | b4)
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
27/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .About the Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 17
drive-type (fibre | SATA | PATA)
feature-identifier (storagePartition2 | storagePartition4 |
storagePartition8 | storagePartition16 |
storagePartition64 | storagePartitionMax |
snapshot | remoteMirror | volumeCopy)
repository-spec instance-based-repository-spec |
count-based-repository-spec
instance-based-repository-spec repositoryRAIDLevel=repository-raid-level
repositoryDrives=(drive-spec-list)
[trayLossProtect=boolean1]
repositoryVolumeGroup=volume-group-number
[freeCapacityArea=integer-literal2]
Specify repositoryRAIDLevelwith
repositoryDrives. Do not specify RAID level or
drives with volume group. Do not set
trayLossProtectwhen specifying a volume group.
count-based-repository-spec repositoryRAIDLevel=repository-raid-level
repositoryDriveCount=integer-literal
[driveType= drive-type3]
[trayLossProtect=boolean4]
WWN string-literal
nvsram-offset hex-literal
host-type string-literal | integer literal
nvsram-byte-setting nvsram-value->0xhexadecimal | integer-literal
nvsram-bit-setting nvsram-mask, nvsram-value->0xhexadecimal,
0xhexadecimal | integer-literal
ip-address (0255).(0255).(0255).(0255)
autoconfigure-vols-attr-value-list autoconfigure-vols-attr-value-pair
{autoconfigure-vols-attr-value-pair}
Recurring Syntax Syntax Value
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
28/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
18 SANtricityStorage Manager CLI Quick Reference for Version 9.25
1For tray loss protection to work, each physical disk in a volume group must be on a separatemodule. If you set trayLossProtect=TRUEand have selected more than one physical disk
from any one module, the storage arrayreturns an error. If you settrayLossProtect=FALSE, the storage arrayperforms operations, but the volume group youcreate might not have tray loss protection.
2To determine if a free capacity area exists, issue the show volumeGroupcommand.
3The default physical disk (drive type) is fibre (Fibre Channel).
4If you set trayLossProtect=TRUE, the storage arrayreturns an error if the controllerfirmware cannot find drives that will enable the new volume group to have tray loss protection. Ifyou set trayLossProtect=FALSE, the storage arrayperforms the operation even if it meansthat the volume group might not have tray loss protection.
5The driveTypeparameter is not required if only one type of physical disk is in the storage
array. If you use the driveTypeparameter, you must also use the hotSpareCountandvolumeGroupWidthparameters. If you do not use the driveTypeparameter, theconfiguration defaults to Fibre Channel physical disks.
6volumesPerGroupCountis the number of equal capacity volumes per volume group.
autoconfigure-vols-attr-value-pair driveType=drive-type5|
raidLevel=raid-level|
volumeGroupWidth=integer-literal|volumeGroupCount=integer-literal|
volumesPerGroupCount=integer-literal6|
hotSpareCount=integer-literal|
segmentSize=segment-size-spec|
readAheadMultiplier=integer-literal
create-volume-copy-attr-value-list create-volume-copy-attr-value-pair
{create-volume-copy-attr-value-pair}
create-volume-copy-attr-value-pair copyPriority=(highest | high | medium | low |
lowest)|
targetReadOnlyEnabled=boolean
recover-raid-volume-attr-value-list recover-raid-volume-attr-value-pair
{recover-raid-volume-attr-value-pair}
recover-raid-volume-attr-value-pair owner=(a | b)|
readAheadMultiplier=integer-literal
cache-flush-modifier-setting immediate, 0, .25, .5, .75, 1, 1.5, 2, 5, 10, 20, 60,
120, 300, 1200, 3600, infinite
Recurring Syntax Syntax Value
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
29/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .About the Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 19
Usage Notes
The following list provides guidelines for writing script commands on the command line:
You must end all commands with a semicolon (;).
You can enter more than one command on a line, but you must separate each
command with a semicolon (;).
You must separate each base command and its associated primary and secondary
parameters with a space.
The script engine is not case sensitive. You can enter commands using uppercase,
lowercase, or mixed-case letters.
Add comments to your scripts to make it easier for you and future users to
understand the purpose of the script commands. For information on how to add
comments, see Adding Comments to a Script File on page 20.
NOTE: While the CLI and script commands are not case sensitive, user labels (such
as for volume, hosts, or host ports) are case sensitive. If you try to map to an
object identified by a user label, you must enter the user label exactly as it is
defined, or the CLI and script commands will fail.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
30/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
20 SANtricityStorage Manager CLI Quick Reference for Version 9.25
Adding Comments to a Script File
You can add comments to a script file in three ways.
The script engine interprets as a comment any text typed after two forward slashes (/
/) until an end-of-line character is reached. If the script engine does not find an
end-of-line character in the script after processing a comment, an error message is
displayed, and the script operation is terminated. This error commonly occurs when
a comment is placed at the end of a script and you have forgotten to press the Enter
key.
// Deletes the existing configuration.set storageArray resetConfiguration=true;
The script engine interprets any text typed between/ *and * /as a comment. If the
script engine does not find both a beginning and ending comment notation, an error
message is displayed, and the script operation is terminated.
/* Deletes the existing configuration */set storageArray resetConfiguration=true;
Use the showstatement to embed comments in a script file that you want to displaywhile the script file is running. Enclose the text you want to display by using double
quotation marks ( ).
show Deletes the existing configuration;set storageArray resetConfiguration=true;
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
31/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Command Formatting
SANtricityStorage Manager CLI Quick Reference for Version 9.25 21
Script Command Formatting
This section describes the general rules for formatting a script command and how the
command syntax is presented in the following command descriptions. Syntax unique to a
specific command is explained in the Notes section at the end of each commanddescription.
The script commands are not case sensitive. You can type the commands in
lowercase, uppercase, or mixed-case letters. (In the following command
descriptions, mixed-case letters are used as an aid to reading the command names
and understanding the purpose of the command.)
You must enter spaces in the commands as they are shown in the command
descriptions.
Square brackets are used in two ways:
As part of the command syntax
To indicate the parameters are optional
The description of each parameter tells you if you need to enclose a parameter value
in square brackets.
Parentheses shown in the command syntax enclose specific choices for a parameter;
that is, if you want to use the parameter, you must enter one of the values enclosed in
parentheses. Generally, you do not include parentheses in a command; however, in
some instances, when you enter lists, you must enclose the list in parentheses. Such a
list might be a list of tray ID values and slot ID values. The description of each
parameter tells you if you need to enclose a parameter value in parentheses.
Vertical bars in a command indicate or and separate the valid entries for the
parameter. For example, the syntax for the raidLevelparameter in the commanddescription appears as:
raidLevel=(0 | 1 | 3 | 5)
To use the raidLevelparameter to set a RAID level of 5, enter:
raidLevel=5
When you specify physical disk locations using tray ID and slot ID values, separate
the ID values by a comma. If you are entering more than one set of ID values,
separate each set of values by a space. Enclose the set of values in parentheses. For
example:
(1,1 1,2 1,3 1,4 2,1 2,2 2,3 2,4)
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
32/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
22 SANtricityStorage Manager CLI Quick Reference for Version 9.25
Italic terms in the command indicate a value or information that you need to provide.
For example, when you encounter the italicized term:
numberOfDrives
replace the italicized term with a value for the number of physical disks you want toinclude with the command.
You can use any combination of alphanumeric characters, hyphens (-), and
underscores (_) for the names of the following components:
Storage arrays
Host groups
Hosts
Volume groups
Volumes
Host ports
Names can have a maximum of 30 characters. If the label contains more than one
word, underscores, or hyphens, enclose the name in double quotation marks. In some
usages, you must also surround the name with square brackets. The description of
each parameter indicates whether you need to enclose a parameter in double
quotation marks or square brackets. The character string cannot contain a new line.
You must use unique names; if you do not use unique names, the controller firmware
returns an error.
On Windows operating systems, the name must be enclosed between two
backslashes (\) in addition to other delimiters. For example, the following name isused in a command running under a Windows operating system:
[\Engineering\]
For a UNIX system, and when used in a script file, the name appears as:
[Engineering]
When you enter a World Wide Name (WWN) of a host port, some usage requires
you to surround the WWN with double quotation marks. In other uses, you must
surround the WWN with angle brackets (< >). The description of the WWN
parameter indicates whether you need to enclose the WWN in double quotation
marks or angle brackets.
Script commands must end with a semicolon (;). You can enter more than one script
command on the command line each time you enter a CLI command.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
33/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 23
Script Commands
Table 6 Script Commands
activate
activate storageArray feature=remoteMirrorrepositoryRAIDLevel=(1 | 3 | 5)repositoryDrives=(trayID1,slotID1 ... trayIDn,slotIDn)[trayLossProtect=(TRUE | FALSE)]
This command creates the mirror repository volume and activates the Remote
Volume Mirror feature. This command enables users to define which physical
disks will be used for the repository volume.
activate storageArray feature=remoteMirrorrepositoryVolumeGroup=volumeGroupNumber
[freeCapacityArea=freeCapacityIndexNumbertrayLossProtect=(TRUE | FALSE)]
This command creates the mirror repository volume and activates the Remote
Volume Mirroring feature. This command enables users to define the volume
group in which the repository volume will be located.
activate storageArray feature=remoteMirrorrepositoryRAIDLevel=(1 | 3 | 5)repositoryDriveCount=numberOfDrives[driveType=(fibre | SATA | PATA)trayLossProtect=(TRUE | FALSE)]
This command creates the mirror repository volume and activates the RemoteVolume Mirroring feature. This command enables users to define the number
of physical disks to be used for the repository volume.
activate storageArray firmware
This command activates firmware previously downloaded to the pending
configuration area on the controllers in the storage array.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
34/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
24 SANtricityStorage Manager CLI Quick Reference for Version 9.25
autoConfigure
autoConfigure storageArray [driveType=(fibre | SATA | PATA)raidLevel=(0 | 1 | 3 | 5) volumeGroupWidth=numberOfDrives
volumeGroupCount=numberOfVolumeGroups
volumesPerGroupCount=numberOfVolumesPerGrouphotSpareCount=numberOfHotsparessegmentSize=segmentSizeValuereadAheadMultiplier=multiplierValue]
This command automatically configures a storage array. Before entering the
this command, enter the show storageArray autoConfigurationcommand to return a list of valid physical disk types, RAID levels, volume
information, and hot spare information. If you want to modify the
configuration, you can change the parameters to meet your configuration
requirements. You can change a single parameter or all parameters. After you
enter the autoConfigure storageArraycommand, the controllers setup the storage array by using either the default parameters or those you
selected.
autoConfigure storageArray hotSpares
This command automatically defines and configures the hot spares in a storage
array. You can run this command at any time. This command provides the best
hot spare coverage for a storage array.
check
check remoteMirror localVolume [volumeName] optimalStatustimeout=timeoutValue
This command returns the status of a Remote Volume Mirror. Use thiscommand to determine when Remote Volume Mirror status becomes Optimal.
check volume [volumeName] parity [parityErrorFile=filename][mediaErrorFile=filename] [priority=(highest | high | medium |low | lowest)] [startingLBA=LBAvalue] [endingLBA=LBAvalue][verbose=(TRUE|FALSE)]
This command checks a volume for parity and media errors and writes the
results of the check to a file.
clear
clear allDriveChannels stats
This command resets the statistics for all physical disk channels.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
35/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 25
clear storageArray configuration
This command clears the entire configuration from the controllers in a storage
array. Information defining all volume groups, volumes, and hot spares is
deleted. Use this command when you need to create a new configuration on a
storage array that already has a configuration defined.
Caution:
Potential storage array configuration damage As soon as you run this
command, the existing storage array configuration is deleted.
clear storageArray eventLog
This command clears the storage array event log by deleting the data in the
Event Log buffer.
Caution:
Potential storage array configuration damage As soon as you run thiscommand, the existing Event Log in the storage array is deleted.
clear storageArray firmwarePendingArea
This command deletes from the pending area buffer a firmware image or
nonvolatile static random access memory (NVSRAM) values you have
previously downloaded.
Caution:
Potential storage array configuration damage As soon as you run this
command, the contents of the existing pending area in the storage array are
deleted.
clear (allVolumes | volume [volumeName] |volumes [volumeName1 ... volumeNamen]) reservations
This command clears persistent volume reservations.
clear (allVolumes | volume [volumeName] |volumes [volumeName1 ... volumeNamen]) unreadableSectors
This command clears unreadable sector information from one or more
volumes.
create
create host userLabel=hostName[hostGroup=(hostGroupName|defaultGroup)]
This command creates a new host object. If you do not specify a host group in
which to create the new host, it is created in the default group.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
36/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
26 SANtricityStorage Manager CLI Quick Reference for Version 9.25
create hostGroup userLabel=hostGroupName
This command creates a new host group.
create hostPort identifier=wwnuserLabel=portLabel
host=hostName[hostType=(hostTypeIndexLabel| hostTypeIndexNumber)]
This command creates a new host port object.
create volume driveCount=numberOfDrivesraidLevel=(0 | 1 | 3 | 5)userLabel=volumeName[driveType=(fibre | SATA | PATA)capacity=volumeCapacityowner=(a | b)readAheadMultiplier=multiplierValue
segmentSize=segmentSizeValueusageHint=(fileSystem | dataBase | multiMedia)trayLossProtect=(TRUE | FALSE)]
This command creates a volume group across the storage array physical disks
and a new volume in the volume group. The storage array controllers choose
the physical disks to be included in the volume.
Important:
If you have physical disks with different capacities, you cannot automatically
create volumes by specifying the driveCountparameter. If you want tocreate volumes with disks of different capacities, use the following createvolume drivescommand.
create volume volumeGroup=volumeGroupNumberuserLabel=volumeName[freeCapacityArea=freeCapacityIndexNumbercapacity=volumeCapacityowner=(a | b)readAheadMultiplier=multiplierValuesegmentSize=segmentSizeValueusageHint=(fileSystem | dataBase | multiMedia)]
This command creates a volume in the free space of a volume group.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
37/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 27
create volume drives=(trayID1,slotID1...trayIDn,slotIDn)raidLevel=(0 | 1 | 3 | 5)userLabel=volumeName[capacity=volumeCapacity
owner=(a | b)readAheadMultiplier=multiplierValuesegmentSize=segmentSizeValueusageHint=(fileSystem | dataBase | multiMedia)trayLossProtect=(TRUE | FALSE)]
This command creates a new volume group and volume and enables you to
specify the physical disks for the volume.
Important:
You cannot use mixed physical disk types in the same volume group and
volume. This command fails if you specify different types of physical disks for
the RAID volume.
create remoteMirror primary=primaryVolumeNamesecondary=secondaryVolumeName(remotestorageArrayName=storageArrayName|remoteStorageArrayWwn=wwn) [remotePassword=passwordsyncPriority=(highest | high | medium | low | lowest)
writeOrder=(preserved | notPreserved)writeMode=(synchronous | asynchronous)]
This command creates both the primary and secondary volumes for a Remote
Volume Mirror. This command also sets the write mode (synchronous or
asynchronous) and synchronization priority.
create snapshotVolume baseVolume=baseVolumeName[repositoryRAIDLevel=(1 | 3 | 5)repositoryDrives=(trayID1,slotID1 ... trayIDn,slotIDn)userLabel=snapshotVolumeName
warningThresholdPercent=percentValuerepositoryPercentOfBase=percentValuerepositoryUserLabel=repositoryNamerepositoryFullPolicy=(failBaseWrites | failSnapShot)trayLossProtect=(TRUE | FALSE)]
This command creates a snapshot volume. This command enables users to
define which physical disks will be used for the snapshot repository volume.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
38/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
28 SANtricityStorage Manager CLI Quick Reference for Version 9.25
create snapshotVolume baseVolume=baseVolumeName[repositoryVolumeGroup=volumeGroupNumberfreeCapacityArea=freeCapacityIndexNumber][userLabel=snapshotVolumeName
warningThresholdPercent=percentValuerepositoryPercentOfBase=percentValuerepositoryUserLabel=repositoryNamerepositoryFullPolicy=(failBaseWrites | failSnapShot)trayLossProtect=(TRUE | FALSE)]
This command creates a snapshot volume. This command enables users to
define the volume group in which the snapshot repository volume will be
located.
create snapshotVolume baseVolume=baseVolumeName[repositoryRAIDLevel=(1 | 3 | 5)repositoryDriveCount=numberOfDrivesdriveType=(fibre | SATA | PATA) userLabel=snapshotVolumeName
warningThresholdPercent=percentValuerepositoryPercentOfBase=percentValuerepositoryUserLabel=repositoryNamerepositoryFullPolicy=(failBaseWrites | failSnapShot)trayLossProtect=(TRUE | FALSE)]
This command creates a snapshot volume. This command enables users to
define the number of physical disks for the snapshot volume. The controller
firmware chooses which physical disks to use for the snapshot volume.
create volumeCopy source=sourceNametarget=targetName
[copyPriority=(highest | high | medium | low | lowest)targetReadOnlyEnabled=(TRUE | FALSE)]
This command creates a volume copy and starts the volume copy operation.
Important:
You can have a maximum of eight volume copies in progress at one time. If
you try to create more than eight volume copies at one time, the controllers
return a status of Pending until one of the volume copies that is in process
finishes and returns a status of complete.
deactivate
deactivate storageArray feature=remoteMirror
This command deactivates the Remote Volume Mirroring feature and
disassembles the mirror repository volume. The host port dedicated to the
Remote Volume Mirror is made available for host I/O activity.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
39/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 29
delete
delete host [hostName]
This command deletes a host.
delete hostGroup [hostGroupName]
This command deletes a host group.
delete hostPort [hostPortName]
This command deletes a host port.
delete (allVolumes | volume [volumeName] |volumes [volumeName1 ... volumeNamen])
This command deletes one or more standard volumes or snapshots and
snapshot repository volumes.
Caution:
Potential storage array configuration damage All data in the volume is
lost as soon as you run this command.
delete volumeGroup [volumeGroupNumber]
This command deletes an entire volume group and its associated volumes.
Caution:
Potential storage array configuration damage All data in the volume
group is lost as soon as you run this command.
diagnose
diagnose controller [(a | b)]loopbackDriveChannel=(allchannels | (1 | 2 | 3 | 4))testID=(1 | 2 | 3 | discreteLines) [patternFile=filename]
This command runs diagnostic tests on the controller. The diagnostic tests
consist of loop-back tests in which data is written to physical disks and read
from the physical disks.
diagnose remoteMirror (primary [primaryVolumeName] |primaries [primaryVolumeName1 ... primaryVolumeNamen])testID=connectivity
This command tests the connection between the specified primary volumes and
mirror volumes on a storage array with the Remote Volume Mirroring feature
installed.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
40/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
30 SANtricityStorage Manager CLI Quick Reference for Version 9.25
disable
disable storageArray feature=(storagePartition2 |storagePartition4 | storagePartition8 | storagePartition16 |
storagePartition64 | storagePartitionMax | snapshot |remoteMirror | volumeCopy)
This command disables a storage array feature. Issue the showstorageArraycommand to display a list of the feature identifiers for allenabled features in the storage array.
download
download drive [trayID,slotID] firmware file=filename
This command downloads a firmware image to a physical disk.
download (allTrays | tray [trayID]) firmware file=filename
This command downloads module firmware.
download storageArray driveFirmware file=filename[file=filename2...file=filenameN]
This command downloads firmware images to all physical disks in the storage
array.
download storageArray firmware [, NVSRAM ] file=filename[, NVSRAM-filename] [downgrade=(TRUE | FALSE)][activateNow=(TRUE | FALSE)]
This command downloads firmware and, optionally, NVSRAM values for the
storage array controller. If you want to download only NVSRAM values, usethe downLoad storageArray NVSRAMcommand.
download storageArray NVSRAM file=filename
This command downloads NVSRAM values for the storage array controller.
enable
enable controller [(a | b)] dataTransfer
This command revives a controller that has become quiesced while running
diagnostics.
enable storageArray feature file=filename
This command enables a feature using a feature key file.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
41/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 31
recopy
recopy volumeCopy target [targetName] [source [sourceName]][copyPriority=(highest | high | medium | low | lowest)
targetReadOnlyEnabled=(TRUE | FALSE)]This command reinitiates a volume copy operation using an existing volume
copy pair.
recover
recover volume (drive=(trayID,slotID) |drives=(trayID1,slotID1 ... trayIDn,slotIDn) |volumeGroup=volumeGroupNumberuserLabel=volumeNamecapacity=volumeCapacityoffset=offsetValueraidLevel=(0 | 1 | 3 | 5) segmentSize=segmentSizeValue[owner=(a | b) readAheadMultiplier=multiplierValue]
This command creates a RAID volume with the given properties withoutinitializing any of the user data areas on the disks. Parameter values are derived
from the Recovery Profile data file for the storage array.
recreate
recreate storageArray mirrorRepositoryrepositoryRAIDLevel=(1 | 3 | 5)repositoryDrives=(trayID1,slotID1... trayIDn,slotIDn)[trayLossProtect=(TRUE | FALSE)]
This command creates a new Remote Volume Mirror repository volume using
the parameters defined for a previous Remote Volume Mirror repository
volume. The underlying requirement is that you have previously created a
Remote Volume Mirror repository volume. This command enables users to
define which physical disks will be used for the Remote Volume Mirror
repository volume.
recreate storageArray mirrorRepositoryrepositoryVolumeGroup=volumeGroupNumber[freeCapacityArea=freeCapacityIndexNumber]
This command creates a new Remote Volume Mirror repository volume using
the parameters defined for a previous Remote Volume Mirror repository
volume. The underlying requirement is that you have previously created a
Remote Volume Mirror repository volume. This command enables users todefine the volume group in which the Remote Volume Mirror repository
volume will be located.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
42/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
32 SANtricityStorage Manager CLI Quick Reference for Version 9.25
recreate storageArray mirrorRepositoryrepositoryRAIDLevel=(1 | 3 | 5)repositoryDriveCount= numberOfDrives[driveType=(fibre | SATA | PATA) trayLossProtect=(TRUE | FALSE)]
This command creates a new Remote Volume Mirror repository volume using
the parameters defined for a previous Remote Volume Mirror repository
volume. The underlying requirement is that you have previously created a
Remote Volume Mirror repository volume. This command enables users to
define the number of physical disks to be used for the Remote Volume Mirror
repository volume.
recreate snapshot (volume [volumeName] |volumes [volumeName1 ... volumeNamen])[userLabel=snapshotVolumeName
warningThresholdPercent=percentValuerepositoryFullPolicy=(failBaseWrites | failSnapShot)]
This command starts a fresh copy-on-write operation using an existing
snapshot volume.
remove
remove remoteMirror (localVolume [volumeName] |localVolumes [volumeName1 ... volumeNamen])
This command removes the mirror relationship between the primary volume
and secondary volume.
remove volumeCopy target [targetName] [source [sourceName]]
This command removes a volume copy pair.
remove (allVolumes | volume [volumeName] |volumes [volumeName1 ... volumeNamen] | accessVolume) lunMapping(host=hostName| hostGroup=(hostGroupName| defaultGroup))
This command removes the logical unit number mapping.
repair
repair volume [volumeName] parity parityErrorFile=filename[verbose=(TRUE | FALSE)]
This command repairs the parity errors on a volume.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
43/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 33
reset
reset controller [(a | b)]
This command resets a controller.
Important:
When you reset a controller, the controller is not available for I/O operations
until the reset is complete. If a host is using volumes owned by the controller
being reset, the I/O directed to the controller will be rejected. Before resetting
the controller, either verify that the volumes owned by the controller are not in
use or ensure that a multi-path driver is installed on all hosts using these
volumes.
reset storageArray batteryInstallDate [controller=(a | b)]
This command resets the age of the batteries in a storage array to zero days.
You can reset the batteries for an entire storage array or the battery in a specificcontroller. The E6000 command module does not support this command.
reset storageArray diagnosticData
This command resets the NVSRAM that contains the storage array diagnostic
data. This command, however, does not delete the diagnostic data. This
command replaces the Needs Attention status with the Diagnostic Data
Available status. The old diagnostic data is then automatically written over
when new data is captured. The memory that contains the diagnostic data is
also cleared when the controllers reboot. Before resetting the diagnostic data,
use the save storageArray diagnosticDatacommand to save thediagnostic data to a file.
reset storageArray RLSBaseline
This command resets the Read Link Status (RLS) baseline for all devices.
reset storageArray SOCBaseline
This command resets the baseline for all switch-on-a-chip (SOC) devices
accessed through the controllers. This command resets the baseline by setting
all SOC counts to 0. This command is valid only for Fibre Channel devices in
an Arbitrated Loop topology.
reset storageArray volumeDistribution
This command reassigns (moves) all volumes to their preferred controller.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
44/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
34 SANtricityStorage Manager CLI Quick Reference for Version 9.25
resume
resume remoteMirror (primary [volumeName] |primaries [volumeName1 ... volumeNamen])
writeConsistency=(TRUE | FALSE)This command resumes a suspended Remote Volume Mirroring operation.
revive
revive drive [trayID,slotID]
This command forces the specified physical disk to the Optimal state.
revive volumeGroup [volumeGroupNumber]
This command forces the specified volume group and associated failed
physical disks to the Optimal state.
Caution:
Possible data corruption or data loss Correct use of this command depends
on the data configuration on all physical disks in the volume group. Never
attempt to revive a physical disk unless supervised by a Customer and
Technical Support representative.
save
save controller [(a | b)] NVSRAM file=filename
This command saves a copy of the controller NVSRAM values to a file. This
command saves all regions.
save allDrives logFile=filename
This command saves the log sense data to a file. Log sense data is maintained
by the storage array for each physical disk.
save storageArray configuration file=filename[(allconfig | globalSettings=(TRUE | FALSE)volumeConfigAndSettings=(TRUE | FALSE)hostTopology=(TRUE | FALSE) lunMappings=(TRUE | FALSE))]
This command creates a script file that you can use to create the current storage
array volume configuration.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
45/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 35
save storageArray diagnosticData [(controller | esm)]file=filename
This command saves the storage array diagnostic data from either the
controllers or the environmental service monitors (ESMs) to a file. You can
review the file contents at a later time. You can also send the file to a Customer
and Technical Support representative for further review. After you have saved
the diagnostic data, you can reset the NVSRAM registers that contain the
diagnostic data so that the old data can be overwritten. Use the resetstorageArray diagnosticDatacommand to reset the diagnostic dataregisters.
save storageArray (allEvents | criticalEvents) file=filename[count=numberOfEvents]
This command saves events from the Major Event Log (MEL) to a file. You
can save either all the events or only the critical events.
save storageArray performanceStats file=filename
This command saves the performance statistics to a file. Before you use this
command, issue the set session performanceMonitorIntervaland set session performanceMonitorIterationscommands tospecify how often statistics are collected.
save storageArray RLSCounts file=filename
This command saves the Read Link Status (RLS) counters to a file. Before
using this command, issue the reset storageArray RLSBaselinecommand to get current data.
save storageArray SOCCounts file=filename
This command saves the SOC error statistics to a file. This command is valid
only for Fibre Channel devices in an Arbitrated Loop topology.
save storageArray stateCapture file=filename
This command saves the state capture to a file.
save storageArray supportData file=filename
This command saves the support-related information to a file.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
46/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
36 SANtricityStorage Manager CLI Quick Reference for Version 9.25
set
set controller [(a | b)]availability=(online | offline | serviceMode) |
bootp |ethernetPort [(1 | 2)] ipAddress=ipAddress|gatewayIPAddress=ipAddress|globalNVSRAMByte [nvsramOffset]=(nvsramByteSetting|nvsramBitSetting) |hostNVSRAMByte [hostType, nvsramOffset]=(nvsramByteSetting|nvsramBitSetting) |ipAddress=ipAddress|rloginEnabled=(TRUE | FALSE) |subnetMask=ipAddress
This command defines the properties for the controllers.
set controller=[(a | b)] serviceAllowedIndicator=(on | off)
This command turns on or turns off the Service Action Allowed indicator light
on an E6000 command module controller. This command is valid only for
E6000 command modules. (To turn on or turn off the Service Action Allowed
indicator light on the power-fan canister or interconnect-battery canister in an
E6000 command module, use the set trayserviceAllowedIndicatorcommand.)
set driveChannel [(1 | 2 | 3 | 4)] status=(optimal | degraded)
This command defines how the physical disk channel performs.
set (drive [trayID,slotID] |drives [trayID1,slotID1 ... trayIDn,slotIDn])hotSpare=(TRUE | FALSE)
This command assigns or unassigns one or more physical disks as a hot spare.
set drive [trayID,slotID] operationalState=failed
This command sets a physical disk to the failed state. (To return a physical disk
to the Optimal state, use the revive drivecommand.)
set (drive [trayID,slotID] | drives [trayID1,slotID1 ...trayIDn,slotIDn]) serviceAllowedIndicator=(on | off)
This command turns on or turns off the Service Action Allowed indicator lighton a physical disk in the FC-4 16x drive module. If the storage array does not
support the Service Action Allowed indicator light feature, this command
returns an error. If the storage array supports the command but is unable to turn
on or turn off the indicator light, this command returns an error.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
47/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 37
set host [hostName] hostGroup=(hostGroupName| none |defaultGroup) userLabel=newHostName
This command assigns a host to a host group or moves a host to a different host
group. You can also create a new host group and assign the host to the new host
group with this command. The actions performed by this command depend on
whether the host has individual volume-to-LUN mappings or does not have
individual volume-to-LUN mappings.
set hostChannel [(a1 | a2 | b1 | b2)] preferredID=portID
This command defines the loop ID for the host channel. For the E6000
command module, valid host channel values are a1, a2, a3, a4, b1, b2, b3,
or b4.
set hostGroup [hostGroupName] userLabel=newHostGroupName
This command renames a host group.
set hostPort [portLabel] host=hostNamehostType=(hostTypeIndexLabel| hostTypeIndexNumber)userLabel=newPortLabel
This command changes the host type for a host port. You can also change a
host port label with this command.
set remoteMirror (localVolume [volumeName] |localVolumes [volumeName1 ... volumeNamen])role=(primary | secondary) [force=(TRUE | FALSE)]syncPriority=(highest | high | medium | low | lowest)
writeOrder=(preserved | notPreserved)writeMode=(synchronous | asynchronous)
This command defines the properties for a Remote Volume Mirror pair.
set session errorAction=(stop | continue)password=storageArrayPasswordperformanceMonitorInterval=intervalValueperformanceMonitorIterations=iterationValue
This command defines how you want the current script engine session to run.
set (volume [volumeName] |volumes [volumeName1 ... volumeNamen])
userLabel=snapshotVolumeNamewarningThresholdPercent=percentValuerepositoryFullPolicy=(failBaseWrites | failSnapShot)
This command defines the properties for a snapshot volume and enables you to
rename a snapshot volume.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
48/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
38 SANtricityStorage Manager CLI Quick Reference for Version 9.25
set storageArray alarm=(enable |disable | mute)cacheBlockSize=cacheBlockSizeValuecacheFlushStart=cacheFlushStartSizecacheFlushStop=cacheFlushStopSize
defaultHostType=(hostTypeName | hostTypeIdentifier)failoverAlertDelay=delayValuemediaScanRate=(disabled | 1-30)password=passworduserLabel=storageArrayName
This command defines the properties of the storage array.
set storageArray redundancyMode=(simplex | duplex)
This command sets the storage array redundancy mode to either simplex or
duplex. Use simplex mode when you have a single controller. Use duplex mode
when you have two controllers.
set storageArray time
This command sets the clocks on both controllers in a storage array bysynchronizing the controller clocks with the clock of the host from which you
issue this command.
set storageArray trayPositions=(controller | 0-99)
This command defines the position of the modules in a storage array. You must
include all modules in the storage array when you enter this command.
set (allTrays | tray [trayID] alarm=(enable |disable | mute))
This command turns on, turns off, or mutes the audible alarm for a specific
module or all modules in a storage array.
set tray [serial-number] id=80-99
This command sets the ID of an E6000 command module in a storage array.
The range of valid command module IDs is from 80 through 99. This range
avoids conflicts with existing drive module IDs used for attached drive
modules.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
49/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 39
set tray [trayID] (powerFan [(left | right)] |interconnect | esm [(left | right)]) serviceAllowedIndicator=(on| off)
This command turns on or turns off the Service Action Allowed indicator light
on a power-fan canister, an interconnect-battery canister, or an environmental
services monitor (ESM) canister. If the storage array does not support the
Service Action Allowed indicator light feature, this command returns an error.
If the storage array supports the command but is unable to turn on or turn off
the indicator light, this command returns an error. (To turn on or turn off the
Service Action Allowed indicator light on a controller in an E6000 command
module, use the set controller serviceAllowedIndicatorcommand.)
set (allVolumes | volume [volumeName] |volumes [volumeName1 ... volumeNamen] | volume )cacheFlushModifier=cacheFlushModifierValuecacheWithoutBatteryEnabled=(TRUE | FALSE)
mediaScanEnabled=(TRUE | FALSE)mirrorCacheEnabled=(TRUE | FALSE)modificationPriority=(highest | high | medium | low | lowest)owner=(a | b) readCacheEnabled=(TRUE | FALSE)
writeCacheEnabled=(TRUE | FALSE)readAheadMultiplier=integer-literal
This command defines the properties for a volume. This command is applicable
to one or more volumes.
set (volume [volumeName] | volume )
addCapacity=volumeCapacity[addDrives=(trayID1,slotID1 ... trayIDn,slotIDn)]redundancyCheckEnabled=(TRUE | FALSE)segmentSize=segmentSizeValueuserLabel=volumeName
This command defines the properties for a volume. This command is applicable
to only one volume.
set (volume [volumeName] | volume | accessVolume)logicalUnitNumber=LUN(host=hostName |hostGroup=(hostGroupName | defaultGroup)
This command defines the properties for a volume. This command is applicable
to volume mapping.
set volumeCopy target [targetName] [source [sourceName]]copyPriority=(highest | high | medium | low | lowest)targetReadOnlyEnabled=(TRUE | FALSE)
This command defines the properties for a volume copy pair.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
50/62
Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .
40 SANtricityStorage Manager CLI Quick Reference for Version 9.25
set volumeGroup [volumeGroupNumber]addDrives=(trayID1,slotID1... trayIDn,slotIDn)raidLevel=(0 | 1 | 3 | 5) owner=(a | b)availability=(online | offline)
This command defines the properties for a volume group.
show
show (allControllers | controller [(a | b)]) [summary]
For each controller in a storage array, this command returns status, physical
characteristics, and configuration information.
show (allControllers | controller [(a | b)]) NVSRAM[hostType=(hostTypeIndexLabel| host=hostName)]
This command returns the NVSRAM bytes for the specified host type. If users
do not enter the optional parameters, this command returns the entireNVSRAM.
show (allDrives [driveType=(fibre | SATA | PATA)] |drive [trayID,slotID] |drives [trayID1,slotID1... trayIDn,slotIDn]) [summary]
For each physical disk in the storage array, this command returns total number
of physical disks, type of physical disk (Fibre, serial advanced technology
attachment [SATA], or parallel advanced technology attachment [PATA]),
basic physical disk information, physical disk channel information, hot spare
coverage, and details for each physical disk.
show (driveChannel [(1 | 2 | 3 | 4)] |driveChannels [(1 | 2 | 3 | 4) ... (1n | 2n | 3n | 4n)] |allDriveChannels) stats
This command displays cumulative physical disk channel I/O and error
information. If the controller has automatically degraded a channel, this
command also displays interval statistics. When using this command, you can
display information about one specific physical disk channel, several physical
disk channels, or all physical disk channels.
show allDrives downloadProgress
This command returns the status of firmware downloads for the physical disks
targeted by the download drive firmwareor downloadstorageArray driveFirmwarecommand.
show allHostPorts
For all host ports connected to a storage array, this command returns host port
identifier, host port name, and host type.
7/24/2019 SMcli and Script Commands Quick Reference for SANtricity Ver 9.25 ES1790-0-E1
51/62
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands
SANtricityStorage Manager CLI Quick Reference for Version 9.25 41
show remoteMirror candidates primary=volumeNameremoteStorag