SANtricity

Storage Manager
Command Line Interface and
Script Commands
Quick Reference for Version 9.25
ES1790-0-E1, First Edition

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 and
current. 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.

Contents
COMMAND LINE INTERFACE AND SCRIPT COMMANDS QUICK REFERENCE
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................................................................................................... 14
Recurring 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........................................................................................ 47
Remote 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

SANtricity Storage Manager CLI Quick Reference for Version 9.25

ii

SANtricity Storage Manager CLI Quick Reference for Version 9.25

List of Tables
COMMAND LINE INTERFACE AND SCRIPT COMMANDS QUICK REFERENCE
Table 1. Command Name Conventions .................................................................................... 3
Table 2. Command Line Parameters ......................................................................................... 5
Table 3. Exit Status ................................................................................................................. 10
Table 4. Object Types and Identifiers ..................................................................................... 15
Table 5. Recurring Syntax Elements ....................................................................................... 16
Table 6. Script Commands ...................................................................................................... 23

SANtricity Storage Manager CLI Quick Reference for Version 9.25

iii

iv

SANtricity Storage Manager CLI Quick Reference for Version 9.25

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
Italic indicates the title of documents, variables and placeholders in text, emphasized
words, and new terms.
Bold indicates choices in procedures and other emphasized text.
Monospace indicates arguments, code examples, command-line text, command options,
commands, directories, error messages, file names, folders, on-screen text, and user input.
Monospace italic indicates command variables in code, parameters, and
placeholders and variables in code.
Monospace bold indicates keywords and values.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

vi

SANtricity Storage Manager CLI Quick Reference for Version 9.25

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.25 for any updated information regarding hardware, software, or firmware
products 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, and
repair. 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

SANtricity Storage Manager CLI Quick Reference for Version 9.25

vii

viii

SANtricity Storage Manager CLI Quick Reference for Version 9.25

Command Line Interface and Script

Commands 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 quick
reference 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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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 the
DOS C:\ prompt, a Linux operating system path, or a Solaris operating system path. Each
command 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 Structure

The 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 storageArray parameters script-commands;
where:

SMcli invokes the command line interface

storageArray is the name or the IP address of the storage array

parameters are CLI parameters that define the environment and purpose for the
command

script-commands is one or more script commands or the name of a script file

containing script commands. (The script commands are the storage array
configuration commands.)

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface

Usage Notes
If you enter SMcli and a storage array name, but do not specify CLI parameters, script
commands, 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 the
results, and enter the next command without typing the complete SMcli string.
Interactive mode is useful for determining configuration errors and quickly testing
configuration changes.
If you enter SMcli without any parameters or with an incorrect parameter, the script
engine 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

SANtricity Storage Manager CLI Quick Reference for Version 9.25

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

The following are general forms of the CLI commands, showing the parameters and
terminals used in each command. Table 2 on page 5 lists definitions for the parameters
shown in the general form of the CLI commands.
SMcli host-name-or-IP-address [host-name-or-IP-address]
[-c command; {command2};]
[-n storage-array-name | -w WWN]
[-o outputfile][-p password][-e][-S][-quick]
SMcli host-name-or-IP-address [host-name-or-IP-address]
[-f scriptfile]
[-n storage-array-name | -w WWN]
[-o outputfile][-p password][-e][-S][-quick]
SMcli (-n storage-array-name | -w WWN)
[-c command; {command2};]
[-o outputfile][-p password][-e][-S][-quick]
SMcli (-n storage-array-name | -w WWN)
[-f scriptfile]
[-o outputfile][-p password][-e][-S][-quick]
SMcli -a email:email-address
[host-name-or-IP-address1 [host-name-or-IP-address2]]
[-n storage-array-name | -w WWN | -h host-name |
-r (host_sa | direct_sa)]
[-I information-to-include][-q frequency][-S]
SMcli -x email:email-address
[host-name-or-IP-address1 [host-name-or-IP-address2]]
[-n storage-array-name | -w WWN | -h host-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]]
[-n storage-array-name | -w WWN | -h host-name |
-r (host_sa | direct_sa)] [-S]
SMcli -d [-w][-i][-s][-v][-S]
SMcli -m host-name-or-IP-address -F email-address
[-g contactInfoFile][-S]
SMcli -A [host-name-or-IP-address [host-name-or-IP-address]]
[-S]
SMcli -X (-n storage-array-name | -w WWN | -h host-name)
SMcli -?

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface

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 -n or -w
parameter 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 the
Enterprise Management Window (EMW), you can specify
the storage array by its user-supplied name using the -n
parameter.
If you have previously configured a storage array in the
EMW, you can specify the storage array by its World Wide
Name using the -w parameter.

-A

Use this parameter to add a storage array to the configuration files.

If you do not follow the -A parameter with a
host-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 host is 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-address is the email address where you want the alert
message to be sent.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

Parameter

Definition

-c

Use this parameter to indicate that you are entering one or more
script commands to run on the specified storage array. Terminate
each command by a semicolon (;).
You cannot place more than one -c parameter on the same
command line. You can include more than one script command
after the -c parameter.

-d

Use this parameter to display the contents of the script

configuration 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 a

syntax check first.

-F (uppercase)

Use this parameter to specify the email address from which all
alerts will be sent.

-f

Use this parameter to specify a file name containing script

commands that you want to run on the specified storage array.
(This parameter is similar to the -c parameter in that both are
intended for running script commands. The -c parameter runs
individual script commands. The -f parameter runs a file of script
commands.)
By default, any errors encountered when running the script
commands in a file are ignored, and the file continues to run. To
override this behavior, use the set session
errorAction=stop command in the script file.

-g

Use this parameter to specify an ASCII file containing email

sender 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.txt file exists.

-h

Use this parameter to specify the host name that is running the
SNMP agent to which the storage array is connected. Use this
parameter with the -a and -x parameters.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface

Parameter

Definition

-I

Use this parameter to specify the type of information to be

included in the email alert notifications. Valid information
arguments are:

-i

eventOnly
profile
supportBundle

Use this parameter to display the IP address of the known storage

arrays. Use this parameter with the -d parameter. The format of
the 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 on

which 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 -n parameter if more than one storage array is connected to
the host at the specified address.
The storage array name is required when the
host-name-or-IP-address is 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 not
be a duplicate name of any other configured storage array.

-o

Use this parameter with the -c or -f parameter to specify a file

name 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 on
which you want to run commands. A password is not necessary
under the following conditions:
1.
2.
3.

A password has not been set on the storage array.

The password is specified in a script file you are running.
You specify the password using the -c parameter and the
set session password=password command.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

Parameter

Definition

-q

Use this parameter to specify how frequently you want to include

additional profile or support bundle information in the email alert
notifications. An email alert notification containing at least the
basic event information is always generated for every critical
event. If you set the -I parameter to eventOnly, the only valid
argument for -q is everyEvent. If you set the -I parameter to
either profile or supportBundle, this information is
included with the emails with the frequency specified by the -q
parameter.
Valid frequency arguments are:

-quick

everyEvent Information is returned with every email

alert notification
2 Information is returned no more than once every two
hours
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

Use this parameter to reduce the amount of time that is required to

run a single-line operation. (An example of a single-line operation
is the recreate snapshot volume command. This
parameter 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 -a or -x parameter to specify the

name 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
-r parameter enables you to set or change the alert notifications
for all storage arrays under each organizer node.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface

Parameter

Definition

-S (uppercase)

Use this parameter to suppress informational messages describing

command 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 -d parameter to display the alert

settings in the configuration file.

-v

Use this parameter with the -d parameter 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. This
parameter is an alternate to the -n parameter. Use the -w
parameter with the -d parameter to display the WWNs of the
known 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 an

email address alert destination. The community is the SNMP
community name for the trap, and the host is 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 CLI

commands.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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

10

Exit Status

Status
Value

Meaning

The command terminated without an error.

The command terminated with an error. Information about the

error is also displayed.

The script file does not exist.

An error occurred while opening an output file.

A storage array is not at the specified address

Addresses specify different storage arrays.

A storage array name does not exist for the host agent connected.

The storage array name was not at the specified address.

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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Command Line Interface

Status
Value

Meaning

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 -I value in the email alert notification was specified.

33

An invalid -f value in the email alert notification was specified.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

11

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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 while
running 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 called
string 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 a
name, you must insert a caret (^) before each special script character. Special characters
are ^, |, <, and >.

Insert a caret before each special script character when used with the -n, -o, -f,
and -p parameters. For example, to specify storage array CLI>CLIENT, enter the
following 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\;

12

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . CLI Command Formatting

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 -c parameter
varies depending on your operating system. On Windows operating systems, enclose the
script command following the -c parameter in double quotation marks ( ). On UNIX
operating systems, enclose the script command following the -c parameter in single
quotation 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_<_Bonds. The new volume name
is Finance. The controller host names are finance1 and finance2. The storage array
is protected, requiring the password TestArray.
Windows operating system:
SMcli finance1 finance2 -c set session
password=\TestArray\; delete volume[\Stock_^<_
Bonds\]; create volume driveCount[3] RAIDLEVEL=3
capacity=10GB userLabel=\Finance\; show storageArray
healthStatus;
UNIX and Solaris operating systems:
SMcli finance1 finance2 -c set session
password=TestArray; delete volume[Stock_<_Bonds];
create volume driveCount[3] RAIDLEVEL=3 capacity=10GB
userLabel=Finance; show storageArray healthStatus;

This example shows how to run commands in a script file named scriptfile.scr on a
storage array named Example. In this example, the storage array is protected by the
password My_Array. Output, as a result of commands in the script file, goes to file
output.txt.
Windows operating system:
SMcli -n Example -f scriptfile.scr -p My_Array -o
output.txt
UNIX operating system:
SMcli -n Example -f scriptfile.scr -p My_Array -o
output.txt

SANtricity Storage Manager CLI Quick Reference for Version 9.25

13

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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 can
run 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:
command operand-data {statement-data}
where:

command identifies the action to be performed

operand-data represents the objects associated with a storage array that you want to
configure or manage

statement-data provides the information needed to perform the command

The syntax for operand-data is:

(object-type | allobject-types | [qualifier] (object-type
[identifier] {object-type identifier]} | object-types
[identifier-list]))
You can identify an object in four ways:

14

Object type Use an object type when the command is not referencing a specific
object

all parameter 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])

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Script Commands

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 4 lists the object type and identifiers associated with the object types.

Table 4 Object Types and Identifiers

Object Type

Identifier

controller

a or b

drive

Tray ID and slot ID

drivechannel

Drive channel identifier

host

User label

hostchannel

Host channel identifier

hostgroup

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

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 16 lists the recurring syntax and the
values that you can use with the syntax. The conventions listed in Table 1 on page 3 define
the meaning of the syntax values.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

15

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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, slotID

drive-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)

16

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Script Commands

Recurring Syntax

Syntax Value

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 repositoryRAIDLevel with
repositoryDrives. Do not specify RAID level or
drives with volume group. Do not set
trayLossProtect when 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}

SANtricity Storage Manager CLI Quick Reference for Version 9.25

17

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

Recurring Syntax

Syntax Value

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

For tray loss protection to work, each physical disk in a volume group must be on a separate
module. If you set trayLossProtect=TRUE and have selected more than one physical disk
from any one module, the storage array returns an error. If you set
trayLossProtect=FALSE, the storage array performs operations, but the volume group you
create might not have tray loss protection.

To determine if a free capacity area exists, issue the show volumeGroup command.

The default physical disk (drive type) is fibre (Fibre Channel).

If you set trayLossProtect=TRUE, the storage array returns an error if the controller
firmware cannot find drives that will enable the new volume group to have tray loss protection. If
you set trayLossProtect=FALSE, the storage array performs the operation even if it means
that the volume group might not have tray loss protection.

The driveType parameter is not required if only one type of physical disk is in the storage
array. If you use the driveType parameter, you must also use the hotSpareCount and
volumeGroupWidth parameters. If you do not use the driveType parameter, the
configuration defaults to Fibre Channel physical disks.

volumesPerGroupCount is the number of equal capacity volumes per volume group.

18

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . About the Script Commands

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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

19

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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 show statement to embed comments in a script file that you want to display
while 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;

20

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Command Formatting

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 command
description.

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 raidLevel parameter in the command
description appears as:
raidLevel=(0 | 1 | 3 | 5)
To use the raidLevel parameter 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)

SANtricity Storage Manager CLI Quick Reference for Version 9.25

21

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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 to
include 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 is
used 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.

22

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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

Script Commands
Table 6 Script Commands
activate
activate storageArray feature=remoteMirror
repositoryRAIDLevel=(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=remoteMirror
repositoryVolumeGroup=volumeGroupNumber
[freeCapacityArea=freeCapacityIndexNumber
trayLossProtect=(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=remoteMirror
repositoryRAIDLevel=(1 | 3 | 5)
repositoryDriveCount=numberOfDrives
[driveType=(fibre | SATA | PATA)
trayLossProtect=(TRUE | FALSE)]
This command creates the mirror repository volume and activates the Remote
Volume 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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

23

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

autoConfigure
autoConfigure storageArray [driveType=(fibre | SATA | PATA)
raidLevel=(0 | 1 | 3 | 5) volumeGroupWidth=numberOfDrives
volumeGroupCount=numberOfVolumeGroups
volumesPerGroupCount=numberOfVolumesPerGroup
hotSpareCount=numberOfHotspares segmentSize=segmentSizeValue
readAheadMultiplier=multiplierValue]
This command automatically configures a storage array. Before entering the
this command, enter the show storageArray autoConfiguration
command 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 storageArray command, the controllers set
up 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] optimalStatus
timeout=timeoutValue
This command returns the status of a Remote Volume Mirror. Use this
command 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.

24

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

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 this
command, 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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

25

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

create hostGroup userLabel=hostGroupName

This command creates a new host group.
create hostPort identifier=wwn userLabel=portLabel
host=hostName
[hostType=(hostTypeIndexLabel | hostTypeIndexNumber)]
This command creates a new host port object.
create volume driveCount=numberOfDrives
raidLevel=(0 | 1 | 3 | 5)
userLabel=volumeName
[driveType=(fibre | SATA | PATA)
capacity=volumeCapacity
owner=(a | b)
readAheadMultiplier=multiplierValue
segmentSize=segmentSizeValue
usageHint=(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 driveCount parameter. If you want to
create volumes with disks of different capacities, use the following create
volume drives command.
create volume volumeGroup=volumeGroupNumber
userLabel=volumeName
[freeCapacityArea=freeCapacityIndexNumber
capacity=volumeCapacity
owner=(a | b)
readAheadMultiplier=multiplierValue
segmentSize=segmentSizeValue
usageHint=(fileSystem | dataBase | multiMedia)]
This command creates a volume in the free space of a volume group.

26

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

create volume drives=(trayID1,slotID1...trayIDn,slotIDn)

raidLevel=(0 | 1 | 3 | 5)
userLabel=volumeName
[capacity=volumeCapacity
owner=(a | b)
readAheadMultiplier=multiplierValue
segmentSize=segmentSizeValue
usageHint=(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=primaryVolumeName
secondary=secondaryVolumeName
(remotestorageArrayName=storageArrayName |
remoteStorageArrayWwn=wwn) [remotePassword=password
syncPriority=(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=percentValue
repositoryPercentOfBase=percentValue
repositoryUserLabel=repositoryName
repositoryFullPolicy=(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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

27

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

create snapshotVolume baseVolume=baseVolumeName

[repositoryVolumeGroup=volumeGroupNumber
freeCapacityArea=freeCapacityIndexNumber]
[userLabel=snapshotVolumeName
warningThresholdPercent=percentValue
repositoryPercentOfBase=percentValue
repositoryUserLabel=repositoryName
repositoryFullPolicy=(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=numberOfDrives
driveType=(fibre | SATA | PATA) userLabel=snapshotVolumeName
warningThresholdPercent=percentValue
repositoryPercentOfBase=percentValue
repositoryUserLabel=repositoryName
repositoryFullPolicy=(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=sourceName target=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.

28

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

29

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

disable
disable storageArray feature=(storagePartition2 |
storagePartition4 | storagePartition8 | storagePartition16 |
storagePartition64 | storagePartitionMax | snapshot |
remoteMirror | volumeCopy)
This command disables a storage array feature. Issue the show
storageArray command to display a list of the feature identifiers for all
enabled 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, use
the downLoad storageArray NVSRAM command.
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.

30

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

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=volumeGroupNumber userLabel=volumeName
capacity=volumeCapacity offset=offsetValue
raidLevel=(0 | 1 | 3 | 5) segmentSize=segmentSizeValue
[owner=(a | b) readAheadMultiplier=multiplierValue]
This command creates a RAID volume with the given properties without
initializing 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 mirrorRepository
repositoryRAIDLevel=(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 mirrorRepository
repositoryVolumeGroup=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 to
define the volume group in which the Remote Volume Mirror repository
volume will be located.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

31

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

recreate storageArray mirrorRepository

repositoryRAIDLevel=(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=percentValue
repositoryFullPolicy=(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.

32

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

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 specific
controller. 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 diagnosticData command to save the
diagnostic 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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

33

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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.

34

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

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 reset
storageArray diagnosticData command to reset the diagnostic data
registers.
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 performanceMonitorInterval
and set session performanceMonitorIterations commands to
specify 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 RLSBaseline
command 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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

35

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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 tray
serviceAllowedIndicator command.)
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 drive command.)
set (drive [trayID,slotID] | drives [trayID1,slotID1 ...
trayIDn,slotIDn]) serviceAllowedIndicator=(on | off)
This command turns on or turns off the Service Action Allowed indicator light
on 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.

36

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

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=hostName
hostType=(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=storageArrayPassword
performanceMonitorInterval=intervalValue
performanceMonitorIterations=iterationValue
This command defines how you want the current script engine session to run.
set (volume [volumeName] |
volumes [volumeName1 ... volumeNamen])
userLabel=snapshotVolumeName
warningThresholdPercent=percentValue
repositoryFullPolicy=(failBaseWrites | failSnapShot)
This command defines the properties for a snapshot volume and enables you to
rename a snapshot volume.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

37

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

set storageArray alarm=(enable |disable | mute)

cacheBlockSize=cacheBlockSizeValue
cacheFlushStart=cacheFlushStartSize
cacheFlushStop=cacheFlushStopSize
defaultHostType=(hostTypeName | hostTypeIdentifier)
failoverAlertDelay=delayValue mediaScanRate=(disabled | 1-30)
password=password userLabel=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 by
synchronizing 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.

38

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

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 serviceAllowedIndicator
command.)
set (allVolumes | volume [volumeName] |
volumes [volumeName1 ... volumeNamen] | volume <wwn>)
cacheFlushModifier=cacheFlushModifierValue
cacheWithoutBatteryEnabled=(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 <wwn>)
addCapacity=volumeCapacity
[addDrives=(trayID1,slotID1 ... trayIDn,slotIDn)]
redundancyCheckEnabled=(TRUE | FALSE)
segmentSize=segmentSizeValue userLabel=volumeName
This command defines the properties for a volume. This command is applicable
to only one volume.
set (volume [volumeName] | volume <wwn> | 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.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

39

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

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 entire
NVSRAM.
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 firmware or download
storageArray driveFirmware command.
show allHostPorts
For all host ports connected to a storage array, this command returns host port
identifier, host port name, and host type.

40

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

show remoteMirror candidates primary=volumeName

remoteStorageArrayName=storageArrayName
This command returns information about the candidate volumes on the remote
storage array that you can use as secondary volumes for a primary volume.
show remoteMirror (localVolume [volumeName] |
localVolumes [volumeName1 ... volumeNamen])
synchronizationProgress
This command returns the progress of data synchronization between the
primary volume and secondary volume in a Remote Volume Mirror. This
command displays the progress as a percentage of data synchronization that has
been completed.
show storageArray profile batteryAge connections defaultHostType
healthStatus hostTypeTable hotSpareCoverage features time
volumeDistribution [summary]
This command returns configuration information about the storage array. The
parameters return lists of values for the components and features in the storage
array. You can enter the command with a single parameter or more than one
parameter. If you enter the command without any parameters, the entire storage
array profile is displayed (which is the same information as if you entered the
profile parameter).
show storageArray autoConfiguration
[driveType=(fibre | SATA | PATA) raidLevel=(0 | 1 | 3 | 5)
volumeGroupWidth=numberOfDrives
volumeGroupCount=numberOfVolumeGroups
volumesPerGroupCount=numberOfVolumesPerGroup
hotSpareCount=numberOfHotspares segmentSize=segmentSizeValue
readAheadMultiplier=multiplierValue]
This command displays the default auto configuration that the storage array
will create if you issue the autoConfigure storageArray command. If
you want to determine whether the storage array can support specific
properties, enter the parameter for the properties when you issue this command.
You do not, however, need to enter any parameters for this command to return
configuration information. If you do not specify any properties, this command
returns the RAID 5 candidates for each physical disk type. If RAID 5
candidates are not available, this command returns candidates for RAID 3,
RAID 1, or RAID 0. When you specify auto-configuration properties, the
controllers will validate that the firmware supports the properties.
show storageArray hostTopology
This command returns storage partition topology, host type labels, and host
type index for the host storage array.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

41

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

show storageArray lunMappings [host [hostName] |

hostgroup [hostGroupName]]
This command returns information from the storage array profile about the
storage array LUN mappings. Default group LUN mappings are always
displayed. If you run this command without any parameters, this command
returns all LUN mappings.
show storageArray unreadableSectors
This command returns a table of the addresses of all sectors in the storage array
that cannot be read.
show string
This command shows a string of text from a script file. This command is
similar to the echo command in MS DOS and UNIX.
show (allVolumes | volume [volumeName] |
volumes [volumeName1 ... volumeNamen]) [summary]
This command returns detailed information about all volumes in a storage
array.
show volume [volumeName] actionProgress
For a long-running operation that is currently running on a volume, this
command returns the volume action and percentage completed of the operation.
show volumeCopy (allVolumes | source [sourceName] |
target [targetName])
This command returns information about volume copy operations. You can
retrieve information about a specific volume copy pair or all volume copy pairs
in the storage array.
show volumeCopy sourceCandidates
This command returns information about the candidate volumes that you can
use as the source for a volume copy operation.
show volumeCopy source [sourceName] targetCandidates
This command returns information about the candidate volumes that you can
use as the target for a volume copy operation.

42

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

show volumeGroup [volumeGroupNumber]

For a volume group, this command returns status (online or offline), drive type
(Fibre, SATA, or PATA), tray loss protection (yes or no), current owner
(controller slot A or slot B), associated volumes and free capacity, and
associated physical disks (drives).
Note:
You can use the free capacity area value when creating a volume based on the
free capacity of a volume group.
show (allVolumes | volume [volumeName] |
volumes [volumeName1 ... volumeNamen]) performanceStats
This command returns information about the performance of the volumes in a
storage array.
show (allVolumes | volume [volumeName] |
volumes [volumeName1 ... volumeNamen]) reservations
This command returns information about the volumes that have reservations.
start
start driveChannel [(1 | 2 | 3 | 4)] locate
This command identifies the physical disk modules connected to a specific
physical disk channel by turning on the indicator lights for the physical disk
module connected. (Use the stop driveChannel locate command to
turn off the indicator lights on the physical disk module.)
start drive [trayID,slotID] initialize
This command starts physical disk initialization.
Caution:
Potential storage array configuration damage This command destroys
user data.
start drive [trayID,slotID] locate
This command locates a physical disk by turning on the indicator lights on the
physical disk. (Use the stop drive locate command to turn off the
indicator lights on the physical disk.)
start drive [trayID,slotID] reconstruct
This command starts reconstructing a physical disk.
start remoteMirror primary [volumeName] synchronize
This command starts Remote Volume Mirror synchronization.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

43

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

start storageArray locate

This command locates a storage array by turning on the indicator lights for the
storage array. (Use the stop storageArray locate command to turn
off the indicator lights for the storage array.)
start tray [trayID] locate
This command locates a module by turning on the indicator lights. (Use the
stop tray locate command to turn off the indicator lights for the
module.)
start volumeGroup [volumeGroupNumber] defragment
This command starts a defragment operation on the specified volume group.
Note:
Defragmenting a volume group starts a long-running operation that you cannot
stop.
start volumeGroup [volumeGroupNumber] locate
This command identifies the physical disks that are logically grouped together
to form the specified volume group by blinking the indicator lights on the
physical disks. (Use the stop volumeGroup locate command to turn
off the indicator lights on the physical disks.)
start volume [volumeName] initialize
This command starts the formatting of a volume in a storage array.
Note:
Initializing a volume is a long-running operation that you cannot stop.
stop
stop drive locate
This command turns off the physical disk indicator lights that were turned on
by the start drive locate command.
stop driveChannel locate
This command turns off the indicator lights on the physical disk module that
were turned on by the start driveChannel locate command.
stop snapshot (volume [volumeName] |
volumes [volumeName1 ... volumeNamen])
This command stops a copy-on-write operation.

44

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Script Commands

stop storageArray driveFirmwareDownload

This command stops a firmware download to the physical disks in a storage
array that was started with the download storageArray
driveFirmware command. This command does not stop a firmware
download that is already in progress to a physical disk; however, this command
stops all firmware downloads to physical disks that are waiting for the
download.
stop storageArray locate
This command turns off the indicator lights on the storage array that were
turned on by the start storage array locate command.
stop tray locate
This command turns off the indicator lights on the module that were turned on
by the start tray locate command.
stop volumeCopy target [targetName] [source [sourceName]]
This command stops a volume copy operation.
stop volumeGroup locate
This command turns off the indicator lights on the physical disks that were
turned on by the start volumeGroup locate command.
suspend
suspend remoteMirror (primary [primaryVolumeName] |
primaries [primaryVolumeName1 ... primaryVolumeNamen])
writeConsistency=(TRUE | FALSE)
This command suspends a Remote Volume Mirror operation.

SANtricity Storage Manager CLI Quick Reference for Version 9.25

45

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

Commands Listed by Function

This section presents the commands organized into groups related to storage array
physical, logical, and operational features.

Controller Commands
Clear Drive Channel Statistics
Diagnose Controller
Enable Controller
Reset Controller
Save Controller NVSRAM
Set Controller
Set Controller Service Action Allowed Indicator
Set Drive Channel Status
Set Host Channel
Show Controller
Show Controller NVSRAM
Show Drive Channel Stats
Start Drive Channel Locate
Stop Drive Channel Locate

Host Topology Commands

Create Host
Create Host Group
Create Host Port
Delete Host
Delete Host Group
Delete Host Port
Set Host
Set Host Group

46

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Commands Listed by Function

Set Host Port

Show Host Ports

Module Commands
Download Environmental Card Firmware
Set Tray Identification
Set Tray Alarm
Set Tray Service Action Allowed Indicator
Start Tray Locate
Stop Tray Locate

Physical Disk (Drive) Commands

Download Drive Firmware
Revive Drive
Save Drive Log
Set Drive Hot Spare
Set Drive Service Action Allowed
Set Drive State
Show Drive
Show Drive Download Progress
Start Drive Initialize
Start Drive Locate
Start Drive Reconstruction
Stop Drive Locate

Remote Volume Mirroring Commands

Activate Remote Volume Mirroring Feature
Check Remote Volume Mirror Status
Create Remote Volume Mirror
Deactivate Remote Volume Mirror

SANtricity Storage Manager CLI Quick Reference for Version 9.25

47

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

Diagnose Remote Mirror

Re-create Remote Volume Mirroring Repository
Remove Remote Volume Mirror
Resume Remote Volume Mirror
Set Remote Volume Mirror
Show Remote Volume Mirror Volume Candidates
Show Remote Volume Mirror Volume Synchronization Progress
Start Remote Volume Mirror Synchronization
Suspend Remote Volume Mirror

Session Command
Set Session

Snapshot Commands
Create Snapshot Volume
Re-create Snapshot
Set Snapshot Volume
Stop Snapshot

Storage Array Commands

Activate Storage Array Firmware
Autoconfigure Storage Array
Autoconfigure Storage Array Hot Spares
Clear Storage Array Configuration
Clear Storage Array Event Log
Clear Storage Array Firmware Pending Area
Disable Storage Array Feature
Download Storage Array Drive Firmware
Download Storage Array Firmware/NVSRAM
Download Storage Array NVSRAM

48

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Commands Listed by Function

Enable Storage Array Feature Key

Reset Storage Array Battery Install Date
Reset Storage Array Diagnostic Data
Reset Storage Array RLS Baseline
Reset Storage Array SOC Baseline
Reset Storage Array Volume Distribution
Save Storage Array Configuration
Save Storage Array Diagnostic Data
Save Storage Array Events
Save Storage Array Performance Statistics
Save Storage Array RLS Counts
Save Storage Array SOC Counts
Save Storage Array State Capture
Save Storage Array Support Data
Set Storage Array
Set Storage Array Redundancy Mode
Set Storage Array Time
Set Storage Array Tray Positions
Show Storage Array
Show Storage Array Auto Configure
Show Storage Array Host Topology
Show Storage Array LUN Mappings
Show Storage Array Unreadable Sectors
Start Storage Array Locate
Stop Storage Array Drive Firmware Download
Stop Storage Array Locate

Uncategorized Command
Show String

SANtricity Storage Manager CLI Quick Reference for Version 9.25

49

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

Volume Commands
Check Volume Parity
Clear Volume Reservations
Clear Volume Unreadable Sectors
Create RAID Volume (Automatic Drive Select)
Create RAID Volume (Free Capacity Base Select)
Create RAID Volume (Manual Drive Select)
Delete Volume
Recover RAID Volume
Remove Volume LUN Mapping
Repair Volume Parity
Set Volume
Show Volume
Show Volume Action Progress
Show Volume Performance Statistics
Show Volume Reservations
Start Volume Initialization

Volume Copy Commands

Create Volume Copy
Recopy Volume Copy
Remove Volume Copy
Set Volume Copy
Show Volume Copy
Show Volume Copy Source Candidates
Show Volume Copy Target Candidates
Stop Volume Copy

50

SANtricity Storage Manager CLI Quick Reference for Version 9.25

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Commands Listed by Function

Volume Group Commands

Delete Volume Group
Revive Volume Group
Set Volume Group
Show Volume Group
Start Volume Group Defragment
Start Volume Group Locate
Stop Volume Group Locate

SANtricity Storage Manager CLI Quick Reference for Version 9.25

51

Command Line Interface and Script Commands Quick Reference. . . . . . . . . . . . . . . . . . . . . . . . . .

52

SANtricity Storage Manager CLI Quick Reference for Version 9.25