Dell PowerVault MD3260 Series User manual

Dell PowerVault Modular Disk Storage Arrays
CLI Guide

Notes, Cautions, and Warnings
NOTE: A NOTE indicates important information that helps you make better use of your computer.
CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid the
problem.
WARNING: A WARNING indicates a potential for property damage, personal injury, or death.
©2012 Dell Inc.
Trademarks used in this text: Dell™, the Dell logo, Dell Boomi™, Dell Precision™, OptiPlex™, Latitude™, PowerEdge™, PowerVault™,
PowerConnect™, OpenManage™, EqualLogic™, Compellent™, KACE™, FlexAddress™, Force10™and Vostro™are trademarks of Dell
Inc. Intel®, Pentium®, Xeon®, Core®and Celeron®are registered trademarks of Intel Corporation in the U.S. and other countries. AMD®
is a registered trademark and AMD Opteron™, AMD Phenom™and AMD Sempron™are trademarks of Advanced Micro Devices, Inc.
Microsoft®, Windows®, Windows Server®, Internet Explorer®, MS-DOS®, Windows Vista®and Active Directory®are either trademarks
or registered trademarks of Microsoft Corporation in the United States and/or other countries. Red Hat®and Red Hat®
Enterprise Linux®are registered trademarks of Red Hat, Inc. in the United States and/or other countries. Novell®and SUSE®are
registered trademarks of Novell Inc. in the United States and other countries. Oracle®is a registered trademark of Oracle Corporation
and/or its affiliates. Citrix®, Xen®, XenServer®and XenMotion®are either registered trademarks or trademarks of Citrix Systems, Inc. in
the United States and/or other countries. VMware®, Virtual SMP®, vMotion®, vCenter®and vSphere®are registered trademarks or
trademarks of VMware, Inc. in the United States or other countries. IBM®is a registered trademark of International Business Machines
Corporation.
2012 - 08
Rev. A04

Contents
Notes, Cautions, and Warnings...................................................................................................2
1 About The Command Line Interface......................................................................................11
How To Use The Command Line Interface.............................................................................................................11
Usage Notes.....................................................................................................................................................12
CLI Commands..................................................................................................................................................12
Command Line Parameters..............................................................................................................................14
Formatting Considerations......................................................................................................................................18
Detailed Error Reporting.........................................................................................................................................18
Exit Status...............................................................................................................................................................19
Usage Examples.....................................................................................................................................................20
2 About The Script Commands...................................................................................................23
Script Command Structure.....................................................................................................................................23
Script Command Synopsis......................................................................................................................................25
Recurring Syntax Elements.....................................................................................................................................26
Usage Guidelines....................................................................................................................................................30
Adding Comments To A Script File.........................................................................................................................30
3 Configuring A Storage Array...................................................................................................33
Configuring A Storage Array...................................................................................................................................33
Determining What Is On Your Storage Array...................................................................................................34
Saving A Configuration To A File......................................................................................................................35
Using The Create Virtual Disk Command.........................................................................................................36
Using The Auto Configure Command...............................................................................................................38
Modifying Your Configuration.................................................................................................................................40
Setting The Storage Array Password...............................................................................................................40
Setting Up SMTP And SNMP Alerts.................................................................................................................40
Setting The RAID Controller Module Clocks....................................................................................................41
Setting The Storage Array Host Type...............................................................................................................41
Setting Modification Priority............................................................................................................................42
Assigning Global Hot Spares............................................................................................................................42
Selecting The Event Levels For Alert Notifications..........................................................................................43
Configuring Alert Notifications.........................................................................................................................43
4 Using The Snapshot Feature...................................................................................................45
Using Host Servers To Create An Initial Snapshot Virtual Disk..............................................................................46

Creating A Snapshot Virtual Disk............................................................................................................................46
Enabling The Snapshot Virtual Disk Feature....................................................................................................47
Creating A Snapshot Virtual Disk With User-Assigned Physical Disks...........................................................47
Preparing Host Servers To Create An Initial Snapshot Virtual Disk................................................................47
Creating The Initial Snapshot Virtual Disk........................................................................................................48
Creating A Snapshot Virtual Disk With Software-Assigned Physical Disks....................................................49
Creating A Snapshot Virtual Disk By Specifying A Number Of Physical Disks................................................49
User-Defined Parameters................................................................................................................................50
Names Of Snapshot Virtual Disks And Repository Virtual Disks......................................................................52
Changing Snapshot Virtual Disk Settings...............................................................................................................53
Stopping And Deleting A Snapshot Virtual Disk.....................................................................................................53
Re-creating The Snapshot Virtual Disk ...........................................................................................................54
Preparing Host Servers To Re-create A Snapshot Virtual Disk.......................................................................54
Re-creating A Snapshot Virtual Disk................................................................................................................54
5 Using The Virtual Disk Copy Feature......................................................................................57
Creating A Virtual Disk Copy...................................................................................................................................58
Enabling The Virtual Disk Copy Feature...........................................................................................................58
Determining Virtual Disk Copy Candidates......................................................................................................58
Creating A Virtual Disk Copy............................................................................................................................58
Preparing Host Servers To Create A Virtual Disk Copy....................................................................................59
Copying The Virtual Disk..................................................................................................................................59
Viewing Virtual Disk Copy Properties.....................................................................................................................60
Changing Virtual Disk Copy Settings......................................................................................................................61
Recopying A Virtual Disk........................................................................................................................................62
Preparing Host Servers To Recopy A Virtual Disk...........................................................................................62
Recopying The Virtual Disk..............................................................................................................................62
Stopping A Virtual Disk Copy..................................................................................................................................63
Removing Copy Pairs..............................................................................................................................................63
Interaction With Other Features.............................................................................................................................64
Storage Partitioning.........................................................................................................................................64
Snapshot Virtual Disks.....................................................................................................................................64
6 Using The Remote Replication Premium Feature................................................................67
How Remote Replication Works.............................................................................................................................67
Replication Repository Virtual Disks................................................................................................................68
Replication Relationships.................................................................................................................................68
Data Replication...............................................................................................................................................68
Link Interruptions Or Secondary Virtual Disk Errors........................................................................................69
Resynchronization............................................................................................................................................69
Creating A Remote Replicated Pair........................................................................................................................70
Performance Considerations...........................................................................................................................70

Enabling The Remote Replication Premium Feature........................................................................................71
Activating The Remote Replication Premium Feature.....................................................................................71
Determining Candidates For A Remote Replicated Pair..................................................................................73
Creating A Remote Replicated Pair..................................................................................................................73
Changing Remote Replication Settings..................................................................................................................74
Suspending And Resuming A Replication Relationship.........................................................................................75
Removing A Replication Relationship.....................................................................................................................75
Deleting A Primary Virtual Disk Or A Secondary Virtual Disk.................................................................................76
Disabling The Remote Replication Premium Feature.............................................................................................76
Deactivating The Remote Replication Premium Feature........................................................................................76
Interaction With Other Premium Features..............................................................................................................76
Snapshot Virtual Disks.....................................................................................................................................77
Virtual Disk Copy..............................................................................................................................................77
Storage Partitioning.........................................................................................................................................77
Virtual Disk Expansion......................................................................................................................................78
7 Maintaining A Storage Array..................................................................................................79
Routine Maintenance.............................................................................................................................................79
Running A Media Scan.....................................................................................................................................79
Running A Consistency Check.........................................................................................................................80
Resetting A RAID Controller Module................................................................................................................80
Enabling RAID Controller Module Data Transfer.............................................................................................81
Resetting Battery Age......................................................................................................................................81
Removing Persistent Reservations..................................................................................................................81
Synchronizing RAID Controller Module Clocks................................................................................................81
Locating Physical Disks...................................................................................................................................81
Performance Tuning...............................................................................................................................................82
Monitoring Performance..................................................................................................................................82
Changing RAID Levels......................................................................................................................................83
Changing Segment Size...................................................................................................................................83
Defragmenting A Disk Group............................................................................................................................83
Troubleshooting and Diagnostics...........................................................................................................................83
Collecting Physical Disk Data..........................................................................................................................84
Diagnosing A RAID Controller Module.............................................................................................................84
Recovery Operations..............................................................................................................................................84
Setting RAID Controller Module Operational Mode.........................................................................................85
Changing RAID Controller Module Ownership.................................................................................................85
Initializing A Physical Disk...............................................................................................................................85
Reconstructing A Physical Disk.......................................................................................................................86
Initializing A Virtual Disk...................................................................................................................................86
Redistributing Virtual Disks .............................................................................................................................86

8 Script Commands......................................................................................................................89
Command Formatting Rules....................................................................................................................................89
Firmware Compatibility Levels................................................................................................................................91
Commands Listed By Function................................................................................................................................91
Disk Group Commands.....................................................................................................................................91
Enclosure Commands.......................................................................................................................................91
Host Topology Commands................................................................................................................................91
iSCSI Commands..............................................................................................................................................92
Physical Disk Commands.................................................................................................................................92
RAID Controller Module Commands................................................................................................................93
Remote Replication Commands.......................................................................................................................93
Session Command............................................................................................................................................94
Show String Command.....................................................................................................................................94
Snapshot Commands........................................................................................................................................94
Storage Array Commands................................................................................................................................94
Virtual Disk Commands....................................................................................................................................95
Virtual Disk Copy Commands...........................................................................................................................96
Commands Listed Alphabetically............................................................................................................................96
Activate Remote Replication Feature...............................................................................................................96
Activate Storage Array Firmware....................................................................................................................99
Autoconfigure Storage Array...........................................................................................................................99
Autoconfigure Storage Array Hot Spares......................................................................................................100
Check Remote Replication Status..................................................................................................................100
Check Virtual Disk Consistency......................................................................................................................101
Clear Physical Disk Port Statistics.................................................................................................................102
Clear Storage Array Configuration.................................................................................................................102
Clear Storage Array Core Dump.....................................................................................................................103
Clear Storage Array Event Log.......................................................................................................................103
Clear Storage Array Firmware Pending Area................................................................................................103
Clear Storage Array Recovery Mode.............................................................................................................104
Clear Virtual Disk Reservations......................................................................................................................104
Clear Virtual Disk Unreadable Sectors...........................................................................................................104
Configure Automatic Support Bundle Collection...........................................................................................105
Create Disk Group..........................................................................................................................................105
Create Disk Pool.............................................................................................................................................109
Create Host.....................................................................................................................................................111
Create Host Group..........................................................................................................................................111
Create Host Port.............................................................................................................................................111
Create iSCSI Initiator......................................................................................................................................112
Create RAID Virtual Disk (Automatic Physical Disk Select)...........................................................................113
Create RAID Virtual Disk (Free Capacity Base Select)..................................................................................114

Create RAID Virtual Disk (Manual Physical Disk Select)...............................................................................116
Create RAID Virtual Disk On A Disk Pool........................................................................................................119
Create Remote Replication.............................................................................................................................120
Create Snapshot Virtual Disk.........................................................................................................................122
Scheduling Snapshots....................................................................................................................................126
Create Storage Array Security Key................................................................................................................127
Create Virtual Disk Copy.................................................................................................................................129
Deactivate Remote Replication......................................................................................................................130
Delete Disk Group..........................................................................................................................................130
Delete Disk Pool.............................................................................................................................................131
Delete Host.....................................................................................................................................................131
Delete Host Group..........................................................................................................................................131
Delete Host Port.............................................................................................................................................132
Delete iSCSI Initiator......................................................................................................................................132
Delete Snapshot Virtual Disk or Delete Snapshot Virtual Disk Schedule......................................................133
Delete Virtual Disk..........................................................................................................................................133
Delete Virtual Disk On A Disk Pool.................................................................................................................134
Diagnose RAID Controller Module.................................................................................................................135
Diagnose RAID Controller Module iSCSI Host Cable.....................................................................................136
Diagnose Remote Replication........................................................................................................................137
Disable Storage Array Feature.......................................................................................................................138
Display Automatic Support Bundle Collection Configuration........................................................................138
Display Support Bundle Collection Schedule................................................................................................138
Download Enclosure Management Module Firmware..................................................................................139
Download Physical Disk Firmware.................................................................................................................139
Download Storage Array Firmware/NVSRAM...............................................................................................140
Download Storage Array Physical Disk Firmware.........................................................................................141
Download Storage Array NVSRAM...............................................................................................................142
Enable Disk Group Security............................................................................................................................142
Enable Disk Pool Security..............................................................................................................................142
Enable RAID Controller Module Data Transfer..............................................................................................143
Enable Storage Array Feature........................................................................................................................143
Increase Virtual Disk Capacity On A Disk Pool..............................................................................................144
Load Storage Array DBM Database...............................................................................................................144
Recopy Virtual Disk Copy...............................................................................................................................145
Re-Create Remote Replication Repository Virtual Disk.................................................................................146
Re-Create Snapshot.......................................................................................................................................148
Reduce Disk Pool Capacity............................................................................................................................150
Remove Remote Replication..........................................................................................................................150
Remove Virtual Disk Copy..............................................................................................................................151
Remove Virtual Disk LUN Mapping................................................................................................................151
Repair Virtual Disk Consistency.....................................................................................................................152

Replace Physical Disk....................................................................................................................................152
Reset RAID Controller Module.......................................................................................................................153
Reset Storage Array Battery Install Date.......................................................................................................154
Reset Storage Array iSCSI Baseline..............................................................................................................154
Reset Storage Array SAS PHY Baseline........................................................................................................155
Reset Storage Array Virtual Disk Distribution................................................................................................155
Resume Remote Replication..........................................................................................................................155
Resume Snapshot Rollback............................................................................................................................156
Revive Disk Group..........................................................................................................................................156
Revive Disk Pool.............................................................................................................................................157
Revive Physical Disk......................................................................................................................................157
Save Enclosure Log Data...............................................................................................................................157
Save Physical Disk Channel Fault Isolation Diagnostic Status......................................................................158
Save Physical Disk Log..................................................................................................................................158
Save RAID Controller Module NVSRAM........................................................................................................158
Save Storage Array Configuration.................................................................................................................159
Save Storage Array Events............................................................................................................................160
Save Storage Array iSCSI Statistics..............................................................................................................161
Save Storage Array Performance Statistics..................................................................................................161
Save Storage Array SAS PHY Counts............................................................................................................162
Save Storage Array State Capture.................................................................................................................162
Save Storage Array Support Data..................................................................................................................162
Schedule Support Bundle Collection Configuration......................................................................................163
Scheduling Snapshots....................................................................................................................................164
Set Disk Group ...............................................................................................................................................165
Set Disk Group Forced State..........................................................................................................................167
Set Disk Pool..................................................................................................................................................167
Set Enclosure Attribute..................................................................................................................................168
Set Enclosure Identification...........................................................................................................................168
Set Foreign Physical Disk to Native...............................................................................................................169
Set Host..........................................................................................................................................................169
Set Host Channel............................................................................................................................................170
Set Host Group...............................................................................................................................................171
Set Host Port..................................................................................................................................................171
Set iSCSI Initiator...........................................................................................................................................172
Set iSCSI Target Properties...........................................................................................................................172
Set Physical Disk Channel Status..................................................................................................................173
Set Physical Disk Hot Spare...........................................................................................................................174
Set Physical Disk State..................................................................................................................................174
Set RAID Controller Module...........................................................................................................................175
Set Remote Replication..................................................................................................................................177
Set Session.....................................................................................................................................................179

Set Snapshot Virtual Disk...............................................................................................................................180
Set Storage Array...........................................................................................................................................181
Set Storage Array Enclosure Positions..........................................................................................................183
Set Storage Array ICMP Response................................................................................................................184
Set Storage Array iSNS Server IPv4 Address................................................................................................184
Set Storage Array iSNS Server IPv6 Address................................................................................................185
Set Storage Array iSNS Server Listening Port...............................................................................................185
Set Storage Array Learn Cycle.......................................................................................................................185
Set Storage Array Redundancy Mode...........................................................................................................186
Set Storage Array Security Key.....................................................................................................................186
Set Storage Array Time..................................................................................................................................187
Set Storage Array Unnamed Discovery Session...........................................................................................187
Set Virtual Disk...............................................................................................................................................187
Set Virtual Disk Copy......................................................................................................................................190
Show Current iSCSI Sessions........................................................................................................................191
Show Disk Group............................................................................................................................................192
Show Disk Group Export Dependencies........................................................................................................192
Show Disk Group Import Dependencies........................................................................................................193
Show Disk Pool...............................................................................................................................................193
Show Host Ports.............................................................................................................................................193
Show Physical Disk........................................................................................................................................194
Show Physical Disk Channel Statistics..........................................................................................................195
Show Physical Disk Download Progress.......................................................................................................196
Show RAID Controller Module.......................................................................................................................196
Show RAID Controller Module NVSRAM.......................................................................................................197
Show Remote Replication Virtual Disk Candidates........................................................................................198
Show Remote Replication Virtual Disk Synchronization Progress................................................................198
Show Storage Array.......................................................................................................................................199
Show Storage Array Auto Configure..............................................................................................................200
Show Storage Array Host Topology...............................................................................................................201
Show Storage Array LUN Mappings..............................................................................................................202
Show Storage Array Negotiation Defaults.....................................................................................................202
Show Storage Array Unconfigured iSCSI Initiators.......................................................................................202
Show Storage Array Unreadable Sectors......................................................................................................203
Show String....................................................................................................................................................203
Show Virtual Disk...........................................................................................................................................203
Show Virtual Disk Action Progress................................................................................................................205
Show Virtual Disk Copy..................................................................................................................................205
Show Virtual Disk Copy Source Candidates..................................................................................................206
Show Virtual Disk Copy Target Candidates....................................................................................................206
Show Virtual Disk Performance Statistics.....................................................................................................206
Show Virtual Disk Reservations.....................................................................................................................207

Start Configuration Database Diagnostic......................................................................................................207
Start Disk Group Blink....................................................................................................................................208
Start Disk Group Defragment.........................................................................................................................208
Start Disk Group Export..................................................................................................................................208
Start Disk Group Import..................................................................................................................................209
Start Disk Pool Locate....................................................................................................................................209
Start Enclosure Blink......................................................................................................................................209
Start iSCSI DHCP Refresh..............................................................................................................................210
Start Physical Disk Blink................................................................................................................................210
Start Physical Disk Channel Blink..................................................................................................................211
Start Physical Disk Channel Fault Isolation Diagnostics...............................................................................211
Start Physical Disk Initialize...........................................................................................................................212
Start Physical Disk Reconstruction................................................................................................................212
Start Remote Replication Synchronization....................................................................................................213
Start Secure Physical Disk Erase...................................................................................................................213
Start Snapshot Rollback.................................................................................................................................213
Stop Snapshot Rollback.................................................................................................................................214
Start Storage Array Blink...............................................................................................................................214
Start Storage Array iSCSI Refresh.................................................................................................................214
Start Virtual Disk Initialization........................................................................................................................215
Stop Configuration Database Diagnostic.......................................................................................................215
Stop Disk Group Blink.....................................................................................................................................215
Stop Disk Pool Locate....................................................................................................................................216
Stop Enclosure Blink......................................................................................................................................216
Stop Physical Disk Blink.................................................................................................................................216
Stop Physical Disk Channel Blink...................................................................................................................216
Stop Physical Disk Channel Fault Isolation Diagnostics................................................................................216
Stop Snapshot................................................................................................................................................217
Stop Storage Array Blink................................................................................................................................217
Stop Storage Array iSCSI Session.................................................................................................................217
Stop Storage Array Physical Disk Firmware Download.................................................................................217
Stop Virtual Disk Copy....................................................................................................................................218
Suspend Remote Replication.........................................................................................................................218
Validate Storage Array Security Key.............................................................................................................219
9 Sample Script Files.................................................................................................................221
Configuration Script Example 1............................................................................................................................221
Configuration Script Example 2............................................................................................................................222
10 CLI Command Updates.........................................................................................................225
New Commands....................................................................................................................................................225
Updated Commands..............................................................................................................................................225

1
About The Command Line Interface
This guide is intended for system administrators, developers, and engineers who need to use the command line
interface (CLI) tool and its associated commands and script files. Selected CLI commands perform functions that can
also be accessed from the Modular Disk (MD) Storage Manager, which is the graphical user interface (GUI) to the
storage array. See the Owner’s Manual , which describes the Storage Manager software that is used to create and
manage multiple storage arrays. For additional information, see the hardware and software manuals that shipped with
your system.
NOTE: Always check for updates on support.dell.com and read the updates first because they often supersede
information in other documents.
NOTE: CLI commands do not have interactive warnings for destructive commands.
CLI 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
Microsoft Windows command prompt (C:\) or a Linux operating system terminal.
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 run script files when you need to perform operations more than
once (such as installing the same configuration on several storage arrays). A script file can be loaded and run from the
command line interface. You can also run commands in an interactive mode. Interactive mode enables you to connect to
a specific storage array and rapidly enter a command, determine the effect on the storage array, and then enter a new
command.
The command line interface gives you direct access to a script engine utility in the Dell PowerVault Modular Disk
Storage Manager software (MD Storage Manager). The script engine reads the commands, or runs a script file, from the
command line and performs the operations instructed by the commands.
You can use the command line interface to perform the following functions:
• Directly access the script engine and run commands in interactive mode or using a script file.
• Create script command batch files to be run on multiple storage arrays when you need to install the same
configuration on different storage arrays.
• Run script commands on a storage array directly connected to a host, a storage array connected to a host by an
Ethernet, or a combination of both.
• Display configuration information about the storage arrays.
• Add storage arrays to and remove storage arrays from the management domain.
• Perform automatic discovery of all storage arrays attached to the local subnet.
• Add or delete Simple Network Management Protocol (SNMP) trap destinations and e-mail alert notifications.
• Specify the mail server and sender e-mail address or Simple Mail Transport Protocol (SMTP) server for alert
notifications.
• Direct the output to a standard command line display or to a named file.
How To Use The Command Line Interface
Using the CLI commands, you can access the script engine, specify which storage array receives the script commands,
and set operation environment parameters.
11

A CLI command consists of the following elements:
• The term SMcli
• Storage array identifier
• Parameters
• Script commands
The following syntax is the general form of a CLI command:
SMcli storageArray parameters script-commands;
where,
SMcli invokes the command line interface
storageArray is the host name or IP address of the storage array
parameters are the CLI parameters that define the environment and purpose of the command
script-commands are the commands or name of the script file containing the script commands
The script commands are the storage array configuration commands. About The Script Commands presents an overview
of the script commands. Script Commands provides definitions, syntax, and parameters for the script commands.
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. 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.
NOTE: The SMcli command is installed under the client directory of the selected path during a management station
install of the MD Storage Manager software.
NOTE: The SMcli command should be a component of the system environment command path.
CLI Commands
This section lists the CLI commands you can use to perform the following functions:
• Identify storage arrays
• Set passwords
• Add storage arrays
• Specify communication parameters
• Enter individual script configuration commands
• Specify a file containing script configuration commands
The following are general forms of the CLI commands, showing the parameters and terminals used in each command.
The table below lists definitions for the parameters shown in the CLI commands.
12

Table 1. Command Name Conventions
Parameter Definition
a|b pipe symbol indicating alternative ("a" or "b")
italicized-words terminals
[...] (square brackets) zero or one occurrence
{...} (curly brackets) zero or more occurrences
<...> (angle brackets) occurrence exceeds maximum limit of 30 characters
(a|b|c) choose only one of the alternatives
bold terminals
SMcli host-name-or-IP-address [host-name-or-IPaddress]
[-c "command; {command2};"]
[-n storage-array-name | -w WWID]
[-o outputfile][-p password][-e][-S]
SMcli host-name-or-IP-address
[host-name-or-IP-address] [-f scriptfile]
[-n storage-array-name | -w WWID]
[-o outputfile] [-p password] [-e] [-S]
SMcli (-n storage-array-name | -w WWID)
[-c "command; {command2};"]
[-o outputfile][-p password][-e][-S]
SMcli (-n storage-array-name | -w WWID)
[-f scriptfile]
[-o outputfile] [-p password] [-e] [-S]
SMcli (-n storage-array-name | -w WWID)
[-o outputfile][-p password][-e][-S]
SMcli -a email:email-address
[host-name-or-IP-address1
[host-name-or-IP-address2]]
[-n storage-array-name | -w WWID | -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 WWID | -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]]
13

[-n storage-array-name | -w WWID | -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 WWID |
-h host-name)
SMcli -?
Command Line Parameters
Table 2. Command Line Parameters
Parameter Definition
host‑name-or-IP-address Specify either the host name or the Internet Protocol (IP)
address of an in-band managed storage array (IPv4 or
IPv6) or an out-of-band managed storage array (IPv4 or
IPv6).
• If you manage a storage array by using a host
connected directly to the storage array (in‑band
storage management), you must use the -n
parameter if more than one storage array is
connected to the host.
• If you manage a storage array through an Ethernet
connection (out-of-band storage management),
you must specify the
host‑name‑or‑IP‑address of the redundant
array of independent disks (RAID) controller
modules.
• If you have previously configured a storage array
in the graphical user interface (GUI) of the MD
Storage Manager, you can specify the storage
array by its user‑supplied name by using the -n
parameter.
-A Use to add a storage array to the configuration files. If you
do not follow the -A parameter with a
host‑name‑or‑IP‑address, automatic discovery
scans the local subnet for storage arrays.
-a Use to add an SNMP trap destination or an e-mail 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 e-mail address for an alert
destination, the email-address is the e-mail
address to which to send the alert message.
14

Parameter Definition
-c Use to indicate that you are entering one or more script
commands to run on the specified storage array.
Terminate each command by using 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 to display the contents of the script configuration file.
-e Use to disable syntax checking when executing the
current CLI command.
-F (uppercase) Use to specify the e-mail address from which all alerts will
be sent.
-f (lowercase) Use to specify a file name containing script commands
intended 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 allows you to execute individual script
commands. The -f (lowercase) parameter allows
you to execute script commands contained in a file.
NOTE: 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 to specify an ASCII file that contains e-mail sender
contact information to include in all e-mail alert
notifications. The CLI assumes the ASCII file is text only,
without delimiters or any expected format. A typical file
contains the following information:
• Name
• Title
• Company
• Phone
• Pager
NOTE: You can use any file name that your operating
system supports. You must not use userdata.txt. Some
operating systems reserve userdata.txt for system
information.
-h Use with the -a and -x parameters to specify the host
name that is running the SNMP agent to which the
storage array is connected.
-I Use to specify the type of information to be included in the
e-mail alert notifications. The following are valid
information arguments:
15

Parameter Definition
•eventOnly— Only event information is
included in the e-mail.
•profile— Event and array profile information is
included in the e-mail.
•supportBundle— Event and support bundle
information is included in the e-mail.
NOTE: You can enter only one information argument
each time you execute the command. If you want all
of the information, you must run the command three
times.
-i Use with the -d parameter to display the IP address of the
known storage arrays.
-m Use to specify the host name or IP address of the e-mail
server from which to send e-mail alert notifications.
-n Use to specify the name of the storage array on which to
run the script commands. This name is optional when you
use 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 host‑name-
or-IP-address is not used; however, the name of the
storage array configured for use in the MD Storage
Manager GUI (that is, listed in the configuration file) must
not be a duplicate name of any other configured storage
array.
-o Use with the -c or -f parameter to specify a file name for
all output text that is a result of running the script
commands.
-p Use to specify the password for the storage array on
which to run commands. A password is not necessary
under the following conditions:
• A password has not been set on the storage array.
• The password is specified in a script file that is
running.
• The storage array password is specified by using
the -c parameter and the set session
password= password command.
-q Use to specify how frequently to include additional profile
or support bundle information in the e-mail alert
notifications. An e-mail alert notification that contains 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
16

Parameter Definition
everyEvent. If you set the-I parameter to either
profile or supportBundle, this information is
included with the e-mails with the frequency specified by
the-q parameter.
Valid frequency arguments are:
•everyEvent— Information is returned with
every e-mail 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.
-r Use with the -a or -x parameter to specify the name of a
management station. The name of a management station
can be either direct_sa (out-of-band storage array) or
host_sa (in-band storage arrays [host-agent]). The -r
parameter enables you to set or change the alert
notifications for all storage arrays under each
management station.
-S (uppercase) Use to suppress the 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 with the -d parameter to display the alert settings in
the configuration file.
-v Use with the -d parameter to display the current global
status of the known devices in the storage array
configuration file. (The configuration file lists all of the
devices in a storage array configuration and the
relationship between the devices. Use the configuration
file to reconstruct a storage array).
-X (uppercase) Use to delete a storage array from the configuration file.
(The configuration file lists all of the devices in a storage
17

Parameter Definition
array configuration and the relationship between the
devices. Use the configuration file to reconstruct a
storage array).
-x (lowercase) Use to remove an SNMP trap destination or an e-mail
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.
Formatting Considerations
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 explains the use of quotation marks in names while
running CLI and script commands on Windows.
When quotation marks (" ") are part of an argument, you must insert a backslash (\) before each quotation mark
character unless you are in interactive mode. For example:
-c "set storageArray userLabel=\"Engineering\";"
where, Engineering is the storage array name.
You cannot use 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\";"
On a Linux operating system, the delimiters around names or labels are single quotation marks (‘ ’). The Linux versions of
the previous examples are:
-c ‘set storageArray userLabel="Engineering";’
Detailed Error Reporting
Error data collected from an error encountered by the CLI is written to a file. Detailed error reporting under the CLI
works as follows:
• If the CLI must abnormally end execution or abort script command execution, error data is collected and saved
before the CLI aborts.
• The CLI automatically saves the error data by writing the data to a file with a standard name.
• The CLI does not have any provisions to avoid overwriting an existing version of the file containing error data.
For error processing, errors appear as two types:
• Parameter or syntax errors you might enter
• Exceptions that occur as a result of an operational error
When the CLI encounters either type of error, it writes information describing the error directly to the command line and
sets a return code. Depending on the return code, the CLI might also write additional information about which parameter
caused the error. The CLI also writes information about what command syntax was expected to help you identify any
syntax errors you might have entered.
18

When an exception occurs while executing a command, the CLI automatically saves the error information to a file
named excprpt.txt. The CLI attempts to place excprpt.txt in the directory specified by the system property
devmgr.datadir, which by default is the "client/data" directory under the main installation directory in Windows and
the /var/opt/SM directory in Linux. If for any reason the CLI cannot place the file in the devmgr.datadir-specified
directory, the CLI saves the excprpt.txt file in the same directory from which the CLI is running. You cannot change the
file name or location. The excprpt.txt file is overwritten every time an exception occurs. To save the information in the
excprpt.txt file, you must to copy the information to a new file or directory.
Exit Status
After you run a CLI command or a CLI and script command, status is displayed that indicates the success of the
operation defined by the command. The status values are shown in the following table.
Table 3. Exit Status
Status Value Meaning
0 The command terminated without an error.
1 The command terminated with an error. Error information is also displayed.
2 The script file does not exist.
3 An error occurred while opening an output file.
4 A storage array is not at the specified address.
5 Addresses specify different storage arrays.
6 A storage array name does not exist for the host agent connected.
7 The storage array name was not at the specified address.
8 The storage array name was not in the configuration file.
10 A management class does not exist 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 World Wide Identifier (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.
22 The storage array was unable to communicate with the event monitor.
23 The RAID controller module was unable to write alert settings.
19

Status Value Meaning
24 The wrong management station 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 e-mail alert notification was specified.
33 An invalid -f value in the e-mail alert notification was specified.
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 Linux operating systems. The
usage for the
-c parameter varies depending on your operating system. On Windows operating systems, put quotation
marks (" ") around the script command following the -c parameter. On Linux operating systems, put single quotation
marks (‘ ’) around the script command following the -c parameter.
NOTE: See Script Commands for descriptions of the script commands used in the following examples.
This example shows how to change the name of a storage array. The original name of the storage array is Payroll_Array.
The new name is Finance_Array.
Windows:
SMcli -n "Payroll_Array" -c "set storageArray userLabel=\"Finance_Array\";"
Linux:
SMcli -n ‘Payroll_Array’ -c ‘set storageArray userLabel="Finance_Array";’
This example shows how to delete an existing virtual disk and create a new virtual disk on a storage array. The existing
virtual disk name is Stocks_<_Bonds. The new virtual disk name is Finance. The RAID controller module host names are
finance1 and finance2. The storage array is protected and requires the password TestArray.
Windows:
SMcli finance1 finance2 -c "set session password= \"TestArray\"; delete
virtualDisk [\"Stocks_<_Bonds\"];create virtualDisk physicalDiskCount[3]
raidLevel=5 capacity=10 GB userLabel=\"Finance\"; show storageArray
healthStatus;"
Linux:
SMcli finance1 finance2 -c ‘set session password= "TestArray"; delete
virtualDisk ["Stocks_<_Bonds"]; create virtualDisk physicalDiskCount[3]
raidLevel=5 capacity=10 GB userLabel="Finance"; show storageArray healthStatus;’
20