Dell PowerVault MD3420 User Manual
Dell PowerVault MD 34XX/38XX Series
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.
Copyright © 2014 Dell Inc. All rights reserved. This product is protected by U.S. and international copyright and
intellectual property laws. Dell™ and the Dell logo are trademarks of Dell Inc. in the United States and/or other
jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies.
2014 - 02
Rev. A06
Contents
1 CLI Command Updates.......................................................................................... 17
New Commands..................................................................................................................................17
Updated Commands........................................................................................................................... 17
2 About The Command Line Interface..................................................................19
How To Use The Command Line Interface.......................................................................................20
Usage Notes.................................................................................................................................. 20
CLI Commands............................................................................................................................. 20
Command Line Parameters.......................................................................................................... 22
Formatting Considerations.................................................................................................................26
Detailed Error Reporting.....................................................................................................................26
Exit Status.............................................................................................................................................27
Usage Examples.................................................................................................................................. 28
3 About The Script Commands...............................................................................31
Script Command Structure.................................................................................................................32
Script Command Synopsis..................................................................................................................33
Recurring Syntax Elements.................................................................................................................34
Usage Guidelines.................................................................................................................................39
Adding Comments To A Script File.................................................................................................... 39
4 Configuring A Storage Array................................................................................41
Configuring A Storage Array............................................................................................................... 41
Determining What Is On Your Storage Array............................................................................... 42
Saving A Configuration To A File.................................................................................................. 43
Using The Create Virtual Disk Command.................................................................................... 44
Using The Auto Configure Command..........................................................................................47
Modifying Your Configuration............................................................................................................48
Setting The Storage Array Password............................................................................................ 49
Setting Up SMTP And SNMP Alerts...............................................................................................49
Setting The RAID Controller Module Clocks................................................................................50
Setting The Storage Array Host Type........................................................................................... 50
Setting Modification Priority......................................................................................................... 50
Assigning Global Hot Spares......................................................................................................... 51
Selecting The Event Levels For Alert Notifications.......................................................................51
Configuring Alert Notifications..................................................................................................... 52
5 Using The Snapshot Feature................................................................................ 55
Before Using Snapshot CLI Commands.............................................................................................55
Snapshot Images And Groups............................................................................................................ 55
Snapshot Groups And Snapshot Consistency Groups...................................................................... 56
Snapshot Groups...........................................................................................................................56
Snapshot Consistency Groups..................................................................................................... 56
Understanding Snapshot Repositories............................................................................................... 57
Snapshot Consistency Group Repositories..................................................................................57
Consistency Groups And Remote Replication...................................................................................57
Creating Snapshot Images..................................................................................................................57
Creating A Snapshot Image.......................................................................................................... 58
Deleting A Snapshot Image.......................................................................................................... 58
Creating A Consistency Group Snapshot Virtual Disk................................................................. 58
Creating A Consistency Group Snapshot Image......................................................................... 59
Deleting A Snapshot Virtual Disk Or A Consistency Group Snapshot Virtual Disk.....................60
Deleting A Consistency Group Snapshot Image......................................................................... 60
Scheduling Snapshot Images....................................................................................................... 60
Starting, Stopping And Resuming A Snapshot Rollback...............................................................61
Creating A Snapshot Group..........................................................................................................62
Deleting A Snapshot Group.......................................................................................................... 62
Reviving A Snapshot Group.......................................................................................................... 62
Creating A Consistency Group..................................................................................................... 63
Deleting A Consistency Group..................................................................................................... 63
Setting Consistency Group Attributes..........................................................................................63
Adding A Member Virtual Disk To A Consistency Group............................................................ 64
Removing A Member Virtual Disk From A Consistency Group................................................... 65
Changing The Pre-read Consistency Check Setting Of An Overall Repository Virtual Disk..... 65
Setting Snapshot Virtual Disk Repository Virtual Disk Capacity.................................................. 67
Setting Snapshot Group Repository Virtual Disk Capacity.......................................................... 67
Reviving Disk Groups, Physical Disks, Snapshot Groups, And Snapshot Virtual Disks...............68
6 Using The Snapshot (Legacy) Feature...............................................................69
Using Host Servers To Create An Initial Snapshot Virtual Disk..........................................................70
Creating A Snapshot Virtual Disk.........................................................................................................71
Enabling The Snapshot Virtual Disk Feature................................................................................. 71
Creating A Snapshot Virtual Disk With User-Assigned Physical Disks......................................... 71
Preparing Host Servers To Create An Initial Snapshot Virtual Disk............................................. 72
Creating The Initial Snapshot Virtual Disk.................................................................................... 72
Creating A Snapshot Virtual Disk With Software-Assigned Physical Disks..................................73
Creating A Snapshot Virtual Disk By Specifying A Number Of Physical Disks............................ 74
User-Defined Parameters..............................................................................................................75
Names Of Snapshot Virtual Disks And Repository Virtual Disks.................................................. 77
Changing Snapshot Virtual Disk Settings............................................................................................77
Stopping And Deleting A Snapshot Virtual Disk.................................................................................78
Re-creating The Snapshot Virtual Disk ........................................................................................78
Preparing Host Servers To Re-create A Snapshot Virtual Disk....................................................78
Re-creating A Snapshot Virtual Disk.............................................................................................79
7 Using The Virtual Disk Copy Feature................................................................. 81
About Virtual Disk Copy...................................................................................................................... 81
Virtual Disk Copy Types.......................................................................................................................81
Creating A Virtual Disk Copy.............................................................................................................. 82
Enabling The Virtual Disk Copy Feature.......................................................................................83
Determining Virtual Disk Copy Candidates..................................................................................83
Creating A Virtual Disk Copy.........................................................................................................83
Preparing Host Servers To Create A Virtual Disk Copy................................................................83
Copying The Virtual Disk.............................................................................................................. 84
Viewing Virtual Disk Copy Properties.................................................................................................85
Changing Virtual Disk Copy Settings................................................................................................. 86
Recopying A Virtual Disk.....................................................................................................................87
Preparing Host Servers To Recopy A Virtual Disk........................................................................ 87
Recopying The Virtual Disk...........................................................................................................88
Stopping A Virtual Disk Copy..............................................................................................................88
Removing Copy Pairs..........................................................................................................................88
Interaction With Other Features.........................................................................................................89
About Snapshot (Legacy) Premium Features With Virtual Disk Copy...............................................89
8 Using The Remote Replication Premium Feature.......................................... 91
How Remote Replication Works.........................................................................................................91
Replication Pairs And Replication Repositories................................................................................. 92
Differences Between Remote Replication And Remote Replication (Legacy) Features..................92
Link Interruptions Or Secondary Virtual Disk Errors..........................................................................92
Resynchronization.............................................................................................................................. 93
Remote Replication Group.................................................................................................................93
Previous Users Of Remote Replication (Legacy) Premium Feature..................................................94
Remote Replication Requirements And Restrictions........................................................................ 94
Primary And Secondary Virtual Disks................................................................................................. 94
Setting Up Remote Replication.......................................................................................................... 95
Enabling The Remote Replication Premium Feature........................................................................ 95
Activating The Remote Replication Premium Feature...................................................................... 95
Creating A Remote Replication Group...............................................................................................95
Adding Primary Virtual Disk To Remote Replication Group..............................................................96
Changing Remote Replication Group Settings..................................................................................96
Adding Secondary Virtual Disk To Remote Replication Group......................................................... 97
Suspending A Remote Replication Group..........................................................................................97
Deleting A Remote Replication Group...............................................................................................98
Removing A Virtual Disk Or Repository Virtual Disk From A Remote Replication Group................98
Disabling The Remote Replication Premium Feature....................................................................... 98
Deactivating The Remote Replication Premium Feature..................................................................98
Interaction With Other Premium Features.........................................................................................99
Standard Remote Replication Commands........................................................................................ 99
9 Using The Remote Replication (Legacy) Premium Feature....................... 101
How Remote Replication (Legacy) Works........................................................................................101
Replication Repository Virtual Disks...........................................................................................102
Replication Relationships............................................................................................................102
Data Replication.......................................................................................................................... 102
Link Interruptions Or Secondary Virtual Disk Errors.................................................................. 103
Resynchronization...................................................................................................................... 104
Creating A Remote Replicated Pair..................................................................................................104
Performance Considerations......................................................................................................105
Enabling The Remote Replication (Legacy) Premium Feature..................................................105
Activating The Remote Replication (Legacy) Premium Feature................................................105
Determining Candidates For A Remote Replicated Pair............................................................108
Creating A Remote Replicated Pair............................................................................................ 108
Changing Remote Replication (Legacy) Settings............................................................................ 109
Suspending And Resuming A Replication Relationship...................................................................109
Removing A Replication Relationship...............................................................................................110
Deleting A Primary Virtual Disk Or A Secondary Virtual Disk........................................................... 111
Disabling The Remote Replication (Legacy) Premium Feature........................................................111
Deactivating The Remote Replication (Legacy) Premium Feature.................................................. 111
Interaction With Other Premium Features........................................................................................111
Snapshot Virtual Disks..................................................................................................................112
Virtual Disk Copy..........................................................................................................................112
Storage Partitioning..................................................................................................................... 112
Virtual Disk Expansion..................................................................................................................113
10 Maintaining A Storage Array.............................................................................115
Routine Maintenance.........................................................................................................................115
Running A Media Scan.................................................................................................................115
Running A Consistency Check With A Media Scan.................................................................... 116
Resetting A RAID Controller Module...........................................................................................117
Enabling RAID Controller Module Data Transfer........................................................................117
Resetting Battery Age...................................................................................................................117
Removing Persistent Reservations.............................................................................................. 117
Synchronizing RAID Controller Module Clocks......................................................................... 118
Locating Physical Disks................................................................................................................118
Performance Tuning..........................................................................................................................118
Monitoring Performance.............................................................................................................118
Changing RAID Levels................................................................................................................. 119
Changing Segment Size.............................................................................................................. 119
Defragmenting A Disk Group......................................................................................................120
Using SSD Cache...............................................................................................................................120
Enabling SSD Cache For A Virtual Disk.......................................................................................120
Creating SSD Cache.....................................................................................................................121
Adding Physical Disks To Existing SSD Cache............................................................................ 121
Removing Physical Disks From Existing SSD Cache...................................................................121
SSD Cache Performance Modeling.............................................................................................121
Additional Information About SSD Cache And Performance Modeling................................... 122
Troubleshooting and Diagnostics.................................................................................................... 122
Collecting Physical Disk Data......................................................................................................122
Diagnosing A RAID Controller Module.......................................................................................122
Recovery Operations.........................................................................................................................123
Setting RAID Controller Module Operational Mode.................................................................. 123
Changing RAID Controller Module Ownership..........................................................................124
Initializing A Physical Disk........................................................................................................... 124
Reconstructing A Physical Disk...................................................................................................124
Initializing A Virtual Disk.............................................................................................................. 125
Redistributing Virtual Disks .........................................................................................................125
11 Script Commands................................................................................................127
Command Formatting Rules.............................................................................................................127
Firmware Compatibility Levels..........................................................................................................129
Commands Listed By Function.........................................................................................................129
Disk Group Commands...............................................................................................................129
Enclosure Commands.................................................................................................................129
Host Topology Commands........................................................................................................ 130
iSCSI Commands.........................................................................................................................130
Physical Disk Commands............................................................................................................130
RAID Controller Module Commands..........................................................................................131
Remote Replication Commands.................................................................................................131
Session Command...................................................................................................................... 132
Show String Command...............................................................................................................132
Snapshot Commands..................................................................................................................132
SSD Cache Commands...............................................................................................................133
Storage Array Commands...........................................................................................................133
Virtual Disk Commands...............................................................................................................134
Virtual Disk Copy Commands.....................................................................................................135
12 Commands Listed Alphabetically................................................................... 137
Activate Remote Replication Feature............................................................................................... 137
Activate Storage Array Firmware...................................................................................................... 139
Add Member To Consistency Group............................................................................................... 140
Add Physical Disks To SSD Cache.................................................................................................... 142
Add Virtual Disk To Remote Replication Group...............................................................................143
Autoconfigure Storage Array............................................................................................................ 144
Autoconfigure Storage Array Hot Spares.........................................................................................146
Blink SSD Cache................................................................................................................................146
Cancel Remote Replication Group Role Reversal........................................................................... 147
Change SSD Cache Application Type.............................................................................................. 147
Check Remote Replication Status....................................................................................................148
Check Remote Replication Group Consistency..............................................................................148
Check Repository Consistency........................................................................................................ 149
Check Storage Array Connectivity................................................................................................... 150
Check Virtual Disk Consistency........................................................................................................ 151
Clear Physical Disk Port Statistics.....................................................................................................152
Clear Remote Replication Fault........................................................................................................ 153
Clear Storage Array Configuration................................................................................................... 154
Clear Storage Array Core Dump.......................................................................................................155
Clear Storage Array Event Log..........................................................................................................155
Clear Storage Array Firmware Pending Area....................................................................................156
Clear Storage Array Recovery Mode................................................................................................ 156
Clear Virtual Disk Reservations......................................................................................................... 156
Clear Virtual Disk Unreadable Sectors..............................................................................................157
Configure Automatic Support Bundle Collection............................................................................158
Convert Snapshot (Legacy) Virtual Disk To Snapshot Group..........................................................158
Create Consistency Group............................................................................................................... 159
Create Consistency Group Snapshot Image....................................................................................161
Create Consistency Group Snapshot Virtual Disk........................................................................... 162
Create Consistency Group Snapshot Virtual Disk Mapping............................................................164
Create Disk Group.............................................................................................................................165
Create Disk Pool................................................................................................................................168
Create Host........................................................................................................................................170
Create Host Group.............................................................................................................................171
Create Host Port................................................................................................................................ 171
Create iSCSI Initiator......................................................................................................................... 172
Create RAID Virtual Disk (Automatic Physical Disk Select).............................................................. 173
Create RAID Virtual Disk (Free Capacity Base Select)...................................................................... 175
Create RAID Virtual Disk (Manual Physical Disk Select)................................................................... 177
Create RAID Virtual Disk On A Disk Pool......................................................................................... 180
Create Read-Only Snapshot Virtual Disk......................................................................................... 182
Create Remote Replication...............................................................................................................183
Create Remote Replication Group...................................................................................................185
Create Snapshot Group.................................................................................................................... 187
Create Snapshot Image.................................................................................................................... 190
Create Snapshot (Legacy) Virtual Disk..............................................................................................191
Create Snapshot Virtual Disk............................................................................................................ 196
Create SSD Cache.............................................................................................................................198
Create Storage Array Security Key....................................................................................................199
Create Virtual Disk Copy...................................................................................................................201
Deactivate Remote Replication (Legacy).........................................................................................203
Delete Consistency Group............................................................................................................... 203
Delete Consistency Group Snapshot Image................................................................................... 204
Delete Consistency Group Snapshot Virtual Disk........................................................................... 205
Delete Disk Group............................................................................................................................ 205
Delete Disk Pool............................................................................................................................... 206
Delete Host....................................................................................................................................... 206
Delete Host Group............................................................................................................................207
Delete Host Port............................................................................................................................... 207
Delete iSCSI Initiator.........................................................................................................................208
Delete Snapshot Group....................................................................................................................209
Delete Snapshot Image.................................................................................................................... 209
Delete Snapshot (Legacy) Virtual Disk.............................................................................................. 211
Delete Snapshot Virtual Disk.............................................................................................................212
Delete Snapshot Virtual Disk or Delete Snapshot Virtual Disk Schedule........................................ 212
Delete SSD Cache............................................................................................................................. 213
Delete Virtual Disk............................................................................................................................. 213
Delete Virtual Disk On A Disk Pool................................................................................................... 214
Diagnose RAID Controller Module................................................................................................... 215
Diagnose RAID Controller Module iSCSI Host Cable.......................................................................217
Diagnose Remote Replication..........................................................................................................218
Disable Storage Array Feature...........................................................................................................219
Display Automatic Support Bundle Collection Configuration........................................................ 219
Display Support Bundle Collection Schedule..................................................................................220
Download Enclosure Management Module Firmware................................................................... 220
Download Physical Disk Firmware................................................................................................... 221
Download Storage Array Firmware/NVSRAM.................................................................................. 222
Download Storage Array Physical Disk Firmware............................................................................223
Download Storage Array NVSRAM...................................................................................................224
Enable Disk Group Security..............................................................................................................224
Enable Disk Pool Security................................................................................................................. 225
Enable Or Disable SSD Cache For A Virtual Disk.............................................................................226
Enable RAID Controller Module Data Transfer................................................................................226
Enable Storage Array Feature........................................................................................................... 227
Establish Remote Replicated Pair.....................................................................................................228
Increase Virtual Disk Capacity On A Disk Pool................................................................................ 229
Load Storage Array DBM Database.................................................................................................. 229
Modify Disk Pool................................................................................................................................231
Recopy Virtual Disk Copy................................................................................................................. 232
Recover SAS Port MisWire................................................................................................................ 233
Re-Create Remote Replication Repository Virtual Disk..................................................................234
Re-Create Snapshot......................................................................................................................... 236
Reduce Disk Pool Capacity.............................................................................................................. 238
Register SNMP Community..............................................................................................................239
Register SNMP Trap Destination......................................................................................................240
Reinitialize Thin Virtual Disk............................................................................................................. 240
Remove Incomplete Remote Replicated Pair From Remote Replication Group...........................241
Remove Member Virtual Disk From Consistency Group................................................................ 242
Remove Physical Disks From SSD Cache........................................................................................ 242
Remove Remote Replication............................................................................................................243
Remove Virtual Disk Copy................................................................................................................244
Remove Virtual Disk From Remote Replication Group...................................................................244
Remove Virtual Disk LUN Mapping.................................................................................................. 245
Rename A Snapshot Virtual Disk......................................................................................................246
Rename SSD Cache.......................................................................................................................... 247
Repair Virtual Disk Consistency........................................................................................................247
Replace Physical Disk....................................................................................................................... 248
Reset iSCSI IP Address...................................................................................................................... 249
Reset RAID Controller Module.........................................................................................................249
Reset Remote Replication Group Statistics.....................................................................................250
Reset Storage Array Battery Install Date.......................................................................................... 252
Reset Storage Array iSCSI Baseline...................................................................................................252
Reset Storage Array SAS PHY Baseline.............................................................................................253
Reset Storage Array Virtual Disk Distribution...................................................................................253
Resume Consistency Group Snapshot Virtual Disk.........................................................................254
Resume Remote Replication............................................................................................................ 255
Resume Remote Replication Group................................................................................................ 255
Resume Snapshot Image Rollback...................................................................................................256
Resume Snapshot (Legacy) Rollback............................................................................................... 257
Resume Snapshot Virtual Disk..........................................................................................................258
Resume SSD Cache.......................................................................................................................... 259
Revive Disk Group.............................................................................................................................259
Revive Disk Pool............................................................................................................................... 260
Revive Physical Disk..........................................................................................................................260
Revive Snapshot Group.....................................................................................................................261
Revive Snapshot Virtual Disk.............................................................................................................261
Save Enclosure Log Data..................................................................................................................262
Save Physical Disk Channel Fault Isolation Diagnostic Status........................................................ 262
Save Physical Disk Log......................................................................................................................263
Save RAID Controller Module NVSRAM...........................................................................................263
Save Remote Replication Group Statistics.......................................................................................264
Save Storage Array Configuration....................................................................................................266
Save Storage Array Core Dump........................................................................................................267
Save Storage Array DBM Database...................................................................................................267
Save Storage Array DBM Validator Information File........................................................................269
Save Storage Array Events................................................................................................................ 270
Save Storage Array iSCSI Statistics....................................................................................................271
Save Storage Array Performance Statistics...................................................................................... 272
Save Storage Array SAS PHY Counts................................................................................................ 272
Save Storage Array State Capture.....................................................................................................273
Save Storage Array Support Data......................................................................................................273
Schedule Support Bundle Collection Configuration.......................................................................274
Scheduling Snapshots.......................................................................................................................275
Set Consistency Group Attributes.................................................................................................... 276
Set Consistency Group Snapshot Virtual Disk................................................................................. 277
Set Disk Group ................................................................................................................................. 278
Set Disk Group Forced State.............................................................................................................279
Set Disk Pool.....................................................................................................................................280
Set Disk Pool Complete.................................................................................................................... 281
Set Enclosure Attribute..................................................................................................................... 281
Set Enclosure Identification..............................................................................................................282
Set Event Alert Filtering.....................................................................................................................283
Set Foreign Physical Disk to Native..................................................................................................283
Set Host.............................................................................................................................................284
Set Host Channel..............................................................................................................................285
Set Host Group................................................................................................................................. 286
Set Host Port..................................................................................................................................... 287
Set iSCSI Initiator...............................................................................................................................287
Set iSCSI Target Properties...............................................................................................................288
Set Physical Disk Channel Status..................................................................................................... 289
Set Physical Disk Hot Spare..............................................................................................................289
Set Physical Disk State......................................................................................................................290
Set RAID Controller Module.............................................................................................................290
Set Read-Only Snapshot Virtual Disk To A Read/Write Virtual Disk............................................... 294
Set Remote Replication....................................................................................................................294
Set Remote Replication Group........................................................................................................ 296
Set Session........................................................................................................................................300
Set Snapshot Group Attributes......................................................................................................... 301
Set Snapshot Group Media Scan......................................................................................................302
Set Snapshot Group Repository Virtual Disk Capacity....................................................................303
Set Snapshot Group Schedule......................................................................................................... 304
Set Snapshot (Legacy) Virtual Disk...................................................................................................305
Set Snapshot Virtual Disk Media Scan..............................................................................................308
Set Snapshot Virtual Disk Repository Virtual Disk Capacity............................................................309
Set Storage Array...............................................................................................................................310
Set Storage Array Enclosure Positions..............................................................................................312
Set Storage Array ICMP Response....................................................................................................313
Set Storage Array iSNS Server IPv4 Address..................................................................................... 313
Set Storage Array iSNS Server IPv6 Address.....................................................................................314
Set Storage Array iSNS Server Listening Port................................................................................... 314
Set Storage Array Learn Cycle.......................................................................................................... 315
Set Storage Array Redundancy Mode...............................................................................................316
Set Storage Array Security Key..........................................................................................................316
Set Storage Array Time......................................................................................................................317
Set Storage Array Unnamed Discovery Session............................................................................... 317
Set Thin Virtual Disk Attributes..........................................................................................................317
Set Virtual Disk...................................................................................................................................319
Set Virtual Disk Attributes For A Disk Pool....................................................................................... 322
Set Virtual Disk Copy.........................................................................................................................327
Set Virtual Disk Mapping...................................................................................................................328
Show Blocked Events....................................................................................................................... 329
Show Consistency Group Snapshot Image.....................................................................................330
Show Current iSCSI Sessions............................................................................................................331
Show Disk Group.............................................................................................................................. 332
Show Disk Group Export Dependencies..........................................................................................333
Show Disk Group Import Dependencies......................................................................................... 333
Show Disk Pool................................................................................................................................. 334
Show Host Ports............................................................................................................................... 334
Show Physical Disk........................................................................................................................... 335
Show Physical Disk Channel Statistics.............................................................................................336
Show Physical Disk Download Progress..........................................................................................337
Show RAID Controller Module.........................................................................................................338
Show RAID Controller Module NVSRAM......................................................................................... 338
Show Remote Replication Group.................................................................................................... 339
Show Remote Replication Group Synchronization Progress.........................................................340
Show Remote Replication Virtual Disk Candidates......................................................................... 341
Show Remote Replication Virtual Disk Synchronization Progress..................................................341
Show SNMP Communities............................................................................................................... 342
Show SNMP MIB II System Group Variables....................................................................................344
Show Snapshot Group......................................................................................................................344
Show Snapshot Image......................................................................................................................346
Show Snapshot Virtual Disks............................................................................................................ 347
Show SSD Cache.............................................................................................................................. 348
Show SSD Cache Statistics...............................................................................................................349
Show Storage Array...........................................................................................................................352
Show Storage Array Auto Configure................................................................................................354
Show Storage Array Core Dump......................................................................................................356
Show Storage Array DBM Database.................................................................................................356
Show Storage Array Host Topology.................................................................................................356
Show Storage Array LUN Mappings................................................................................................. 357
Show Storage Array Negotiation Defaults........................................................................................357
Show Storage Array Power Information.......................................................................................... 358
Show Storage Array Unconfigured iSCSI Initiators..........................................................................358
Show Storage Array Unreadable Sectors.........................................................................................358
Show String....................................................................................................................................... 359
Show Thin Virtual Disk......................................................................................................................359
Show Virtual Disk...............................................................................................................................361
Show Virtual Disk Action Progress................................................................................................... 362
Show Virtual Disk Copy.................................................................................................................... 363
Show Virtual Disk Copy Source Candidates.................................................................................... 363
Show Virtual Disk Copy Target Candidates.....................................................................................364
Show Virtual Disk Performance Statistics........................................................................................364
Show Virtual Disk Reservations........................................................................................................ 365
Start Configuration Database Diagnostic........................................................................................ 365
Start Consistency Group Snapshot Rollback...................................................................................366
Start Disk Group Blink.......................................................................................................................367
Start Disk Group Defragment...........................................................................................................368
Start Disk Group Export....................................................................................................................368
Start Disk Group Import................................................................................................................... 369
Start Disk Pool Locate...................................................................................................................... 369
Start Enclosure Blink.........................................................................................................................370
Start iSCSI DHCP Refresh................................................................................................................. 370
Start Physical Disk Blink.....................................................................................................................371
Start Physical Disk Channel Blink......................................................................................................371
Start Physical Disk Channel Fault Isolation Diagnostics.................................................................. 371
Start Physical Disk Initialize...............................................................................................................373
Start Physical Disk Reconstruction...................................................................................................373
Start Remote Replication Synchronization...................................................................................... 373
Start Remote Replication (Legacy) Synchronization....................................................................... 374
Start Secure Physical Disk Erase.......................................................................................................374
Start Snapshot Rollback.................................................................................................................... 375
Start Snapshot Image Rollback.........................................................................................................376
Start SSD Cache Performance Modeling......................................................................................... 377
Start Storage Array Blink................................................................................................................... 378
Start Storage Array Configuration Database Diagnostic................................................................. 378
Start Storage Array iSCSI Refresh.....................................................................................................380
Start Virtual Disk Initialization...........................................................................................................380
Stop Configuration Database Diagnostic.........................................................................................381
Stop Consistency Group Snapshot Rollback................................................................................... 381
Stop Consistency Group Snapshot Virtual Disk...............................................................................382
Stop Disk Group Blink.......................................................................................................................383
Stop Disk Pool Locate.......................................................................................................................383
Stop Enclosure Blink.........................................................................................................................383
Stop Pending Snapshot Images On Consistency Group................................................................ 383
Stop Physical Disk Blink....................................................................................................................384
Stop Physical Disk Channel Blink.....................................................................................................384
Stop Physical Disk Channel Fault Isolation Diagnostics..................................................................384
Stop Snapshot Group Image............................................................................................................ 385
Stop Snapshot Group Pending Snapshot Images........................................................................... 385
Stop Snapshot (Legacy)....................................................................................................................386
Stop Snapshot (Legacy) Rollback..................................................................................................... 387
Stop Snapshot Rollback....................................................................................................................388
Stop Snapshot Image Rollback........................................................................................................ 389
Stop Snapshot Virtual Disk............................................................................................................... 390
Stop SSD Cache Performance Modeling.........................................................................................390
Stop Storage Array Blink................................................................................................................... 392
Stop Storage Array Configuration Database Diagnostic................................................................. 392
Stop Storage Array iSCSI Session..................................................................................................... 393
Stop Storage Array Physical Disk Firmware Download................................................................... 393
Stop Virtual Disk Copy......................................................................................................................393
Suspend Remote Replication...........................................................................................................394
Suspend Remote Replication Group................................................................................................395
Suspend SSD Cache..........................................................................................................................395
Test Remote Replication Group Connectivity.................................................................................396
Test SNMP Trap Destination.............................................................................................................397
Unregister SNMP Community..........................................................................................................398
Unregister SNMP Trap Destination.................................................................................................. 398
Update SNMP Community...............................................................................................................398
Update SNMP MIB II System Group Variables................................................................................. 399
Update SNMP Trap Destination....................................................................................................... 400
Validate Storage Array Security Key.................................................................................................400
13 Sample Script Files.............................................................................................403
Configuration Script Example 1....................................................................................................... 403
Configuration Script Example 2.......................................................................................................404
16
1
CLI Command Updates
This chapter reflects new and updated commands that are available for use with the Dell PowerVault
MD34XX/MD38XX Series storage arrays.
NOTE: Not all commands are valid with all storage arrays. Some commands are specific to certain
platforms.
CAUTION: Script commands are capable of changing the configuration and may cause loss of
data if not used correctly. Command operations are performed as soon as you run the
commands. Before using the script commands, ensure that you have backed up all data, and have
saved the current configuration so that you can reinstall it if the changes do not work.
New Commands
The following commands have been added to this guide to reflect the additional functionality available in
the PowerVault MD34xx and MD38xx series of storage arrays.
• Recover SAS Port Mis-Wire
• Reduce Disk Pool Capacity
• Register SNMP Community
• Register SNMP Trap Destination
• Set Event Alert Filtering
• Show Blocked Events
• Show SNMP Communities
• Show SNMP MIB II System Group Variables
• Show Storage Array Power Information
• Test SNMP Trap Destination
• Unregister SNMP Community
• Unregister SNMP Trap Destination
• Update SNMP Community
• Update SNMP Trap Destination
• Update SNMP MIB II System Group Variables
Updated Commands
The syntax of the following commands has been modified, updated, or enhanced since the last release of
this document.
NOTE: not all commands are valid with all storage arrays. Some commands are specific to certain
platforms.
17
• Activate Remote Replication (Legacy)
• Download Storage Array NVSRAM
• Resume Remote Replication Group
• Resume Snapshot (Legacy) Rollback
• Set RAID Controller Module
• Set Remote Replication (Legacy)
• Set Storage Array
• Start Remote Replication Synchronization
• Stop Snapshot (Legacy) Rollback
18
2
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 Administrator's Guide, 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 dell.com/support 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.
19
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.
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 provide 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
20
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.
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)
command; {command2};"]
[-c "
[-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]]
21
[-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
-A
-a
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.
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.
Use to add an SNMP trap destination or an e-mail
address alert destination.
22
• 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.
Parameter Definition
-c
-d
-e
-F (uppercase)
-f (lowercase)
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.
Use to display the contents of the script
configuration file.
Use to disable syntax checking when executing the
current CLI command.
Use to specify the e-mail address from which all
alerts will be sent.
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)
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.
parameter allows you to execute
-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.
23
Parameter Definition
-h
-I
-i
-m
-n
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.
Use to specify the type of information to be
included in the e-mail alert notifications. The
following are valid information arguments:
• 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.
Use with the -d parameter to display the IP address
of the known storage arrays.
Use to specify the host name or IP address of the
e-mail server from which to send e-mail alert
notifications.
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
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.
-n parameter if more than one storage
24
-o
-p
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.
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.
Parameter Definition
• 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
-r
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 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.
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 (outof-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
25
Parameter Definition
-s (lowercase)
-v
-X (uppercase)
-x (lowercase)
-?
Formatting Considerations
Use with the -d parameter to display the alert
settings in the configuration file.
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).
Use to delete a storage array from the
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).
Use 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.
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:
26
• 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.
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
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.
27
Status Value Meaning
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.
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.
28
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= delete virtualDisk
["Stocks_<_Bonds"]; create virtualDisk physicalDiskCount[3] raidLevel=5
capacity=10 GB 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. The -e parameter runs the file without checking syntax. Executing an SMcli command without
checking syntax enables the file to run more quickly; however, the SMcli command may not execute
correctly if the syntax is incorrect.
SMcli -n Example -f scriptfile.scr -e
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:
SMcli -n Example -f scriptfile.scr -p "My_Array" - o output.txt
Linux:
SMcli -n Example -f scriptfile.scr -p ‘My_Array’ - o output.txt
This example shows how to display all storage arrays that are currently discovered in the current
configuration. The command in this example returns the host name of each storage array.
SMcli -d
If you want to know the IP address of each storage array in the configuration, add the -i parameter to the
command.
SMcli -d -i
29
30
Loading...