Dell PowerVault, PowerVault 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.
© 2013 Dell Inc. All Rights Reserved.
Trademarks used in this text: Dell™, the Dell logo, Dell Boomi™, Dell Precision™ , OptiPlex™, Latitude™, PowerEdge™,
PowerVault™, PowerConnect™, OpenManage™, EqualLogic™, Compellent™, KACE™, FlexAddress™, Force10™, Venue
™
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®, vMotion®, vCenter®,
vCenter SRM™ 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.
2013 - 12
Rev. A06
Contents
1 About The Command Line Interface.................................................................. 15
How To Use The Command Line Interface....................................................................................... 16
Usage Notes...................................................................................................................................16
CLI Commands..............................................................................................................................16
Command Line Parameters.......................................................................................................... 18
Formatting Considerations................................................................................................................. 22
Detailed Error Reporting..................................................................................................................... 22
Exit Status............................................................................................................................................ 23
Usage Examples.................................................................................................................................. 24
2 About The Script Commands...............................................................................27
Script Command Structure.................................................................................................................28
Script Command Synopsis..................................................................................................................29
Recurring Syntax Elements.................................................................................................................30
Usage Guidelines.................................................................................................................................35
Adding Comments To A Script File.................................................................................................... 35
3 Configuring A Storage Array................................................................................37
Configuring A Storage Array............................................................................................................... 37
Determining What Is On Your Storage Array............................................................................... 38
Saving A Configuration To A File.................................................................................................. 39
Using The Create Virtual Disk Command.................................................................................... 40
Using The Auto Configure Command......................................................................................... 43
Modifying Your Configuration............................................................................................................44
Setting The Storage Array Password............................................................................................ 45
Setting Up SMTP And SNMP Alerts...............................................................................................45
Setting The RAID Controller Module Clocks............................................................................... 46
Setting The Storage Array Host Type........................................................................................... 46
Setting Modification Priority......................................................................................................... 46
Assigning Global Hot Spares.........................................................................................................47
Selecting The Event Levels For Alert Notifications.......................................................................47
Configuring Alert Notifications.....................................................................................................48
4 Using The Snapshot Feature................................................................................ 51
Before Using Snapshot CLI Commands............................................................................................. 51
Snapshot Images And Groups.............................................................................................................51
Snapshot Groups And Snapshot Consistency Groups...................................................................... 52
Snapshot Groups...........................................................................................................................52
Snapshot Consistency Groups......................................................................................................52
Understanding Snapshot Repositories............................................................................................... 53
Snapshot Consistency Group Repositories..................................................................................53
Consistency Groups And Remote Replication...................................................................................53
Creating Snapshot Images..................................................................................................................53
Creating A Snapshot Image.......................................................................................................... 54
Deleting A Snapshot Image...........................................................................................................54
Creating A Consistency Group Snapshot Virtual Disk................................................................. 54
Creating A Consistency Group Snapshot Image......................................................................... 55
Deleting A Snapshot Virtual Disk Or A Consistency Group Snapshot Virtual Disk.....................56
Deleting A Consistency Group Snapshot Image..........................................................................56
Scheduling Snapshot Images........................................................................................................56
Starting, Stopping And Resuming A Snapshot Rollback.............................................................. 57
Creating A Snapshot Group..........................................................................................................58
Deleting A Snapshot Group.......................................................................................................... 58
Reviving A Snapshot Group.......................................................................................................... 58
Creating A Consistency Group..................................................................................................... 59
Deleting A Consistency Group..................................................................................................... 59
Setting Consistency Group Attributes..........................................................................................59
Adding A Member Virtual Disk To A Consistency Group............................................................ 60
Removing A Member Virtual Disk From A Consistency Group................................................... 61
Changing The Pre-read Consistency Check Setting Of An Overall Repository Virtual Disk......61
Setting Snapshot Virtual Disk Repository Virtual Disk Capacity.................................................. 63
Setting Snapshot Group Repository Virtual Disk Capacity.......................................................... 63
Reviving Disk Groups, Physical Disks, Snapshot Groups, And Snapshot Virtual Disks...............64
5 Using The Snapshot (Legacy) Feature............................................................... 65
Using Host Servers To Create An Initial Snapshot Virtual Disk......................................................... 66
Creating A Snapshot Virtual Disk........................................................................................................ 67
Enabling The Snapshot Virtual Disk Feature.................................................................................67
Creating A Snapshot Virtual Disk With User-Assigned Physical Disks.........................................67
Preparing Host Servers To Create An Initial Snapshot Virtual Disk.............................................68
Creating The Initial Snapshot Virtual Disk....................................................................................68
Creating A Snapshot Virtual Disk With Software-Assigned Physical Disks................................. 69
Creating A Snapshot Virtual Disk By Specifying A Number Of Physical Disks............................70
User-Defined Parameters..............................................................................................................71
Names Of Snapshot Virtual Disks And Repository Virtual Disks.................................................. 73
Changing Snapshot Virtual Disk Settings........................................................................................... 73
Stopping And Deleting A Snapshot Virtual Disk.................................................................................74
Re-creating The Snapshot Virtual Disk ........................................................................................74
Preparing Host Servers To Re-create A Snapshot Virtual Disk....................................................74
Re-creating A Snapshot Virtual Disk.............................................................................................75
6 Using The Virtual Disk Copy Feature................................................................. 77
About Virtual Disk Copy...................................................................................................................... 77
Virtual Disk Copy Types.......................................................................................................................77
Creating A Virtual Disk Copy...............................................................................................................78
Enabling The Virtual Disk Copy Feature....................................................................................... 79
Determining Virtual Disk Copy Candidates..................................................................................79
Creating A Virtual Disk Copy.........................................................................................................79
Preparing Host Servers To Create A Virtual Disk Copy................................................................79
Copying The Virtual Disk.............................................................................................................. 80
Viewing Virtual Disk Copy Properties................................................................................................. 81
Changing Virtual Disk Copy Settings..................................................................................................82
Recopying A Virtual Disk.....................................................................................................................83
Preparing Host Servers To Recopy A Virtual Disk........................................................................ 83
Recopying The Virtual Disk...........................................................................................................84
Stopping A Virtual Disk Copy..............................................................................................................84
Removing Copy Pairs..........................................................................................................................84
Interaction With Other Features.........................................................................................................85
About Snapshot (Legacy) Premium Features With Virtual Disk Copy...............................................85
7 Using The Remote Replication Premium Feature.......................................... 87
How Remote Replication Works........................................................................................................ 87
Replication Pairs And Replication Repositories................................................................................. 88
Differences Between Remote Replication And Remote Replication (Legacy) Features..................88
Link Interruptions Or Secondary Virtual Disk Errors..........................................................................88
Resynchronization.............................................................................................................................. 89
Remote Replication Group.................................................................................................................89
Previous Users Of Remote Replication (Legacy) Premium Feature..................................................90
Remote Replication Requirements And Restrictions........................................................................ 90
Primary And Secondary Virtual Disks................................................................................................. 90
Setting Up Remote Replication...........................................................................................................91
Enabling The Remote Replication Premium Feature.........................................................................91
Activating The Remote Replication Premium Feature.......................................................................91
Creating A Remote Replication Group...............................................................................................91
Adding Primary Virtual Disk To Remote Replication Group..............................................................92
Changing Remote Replication Group Settings..................................................................................92
Adding Secondary Virtual Disk To Remote Replication Group.........................................................93
Suspending A Remote Replication Group......................................................................................... 93
Deleting A Remote Replication Group...............................................................................................94
Removing A Virtual Disk Or Repository Virtual Disk From A Remote Replication Group................94
Disabling The Remote Replication Premium Feature....................................................................... 94
Deactivating The Remote Replication Premium Feature..................................................................94
Interaction With Other Premium Features.........................................................................................95
Standard Remote Replication Commands........................................................................................ 95
8 Using The Remote Replication (Legacy) Premium Feature......................... 97
How Remote Replication (Legacy) Works..........................................................................................97
Replication Repository Virtual Disks.............................................................................................98
Replication Relationships..............................................................................................................98
Data Replication............................................................................................................................98
Link Interruptions Or Secondary Virtual Disk Errors.................................................................... 99
Resynchronization...................................................................................................................... 100
Creating A Remote Replicated Pair..................................................................................................100
Performance Considerations...................................................................................................... 101
Enabling The Remote Replication (Legacy) Premium Feature.................................................. 101
Activating The Remote Replication (Legacy) Premium Feature................................................ 101
Determining Candidates For A Remote Replicated Pair............................................................104
Creating A Remote Replicated Pair............................................................................................ 104
Changing Remote Replication (Legacy) Settings.............................................................................105
Suspending And Resuming A Replication Relationship...................................................................105
Removing A Replication Relationship.............................................................................................. 106
Deleting A Primary Virtual Disk Or A Secondary Virtual Disk...........................................................107
Disabling The Remote Replication (Legacy) Premium Feature.......................................................107
Deactivating The Remote Replication (Legacy) Premium Feature................................................. 107
Interaction With Other Premium Features.......................................................................................107
Snapshot Virtual Disks.................................................................................................................108
Virtual Disk Copy.........................................................................................................................108
Storage Partitioning.................................................................................................................... 108
Virtual Disk Expansion.................................................................................................................109
9 Maintaining A Storage Array...............................................................................111
Routine Maintenance.........................................................................................................................111
Running A Media Scan................................................................................................................. 111
Running A Consistency Check With A Media Scan.................................................................... 112
Resetting A RAID Controller Module...........................................................................................113
Enabling RAID Controller Module Data Transfer........................................................................113
Resetting Battery Age.................................................................................................................. 113
Removing Persistent Reservations.............................................................................................. 113
Synchronizing RAID Controller Module Clocks......................................................................... 114
Locating Physical Disks................................................................................................................114
Performance Tuning..........................................................................................................................114
Monitoring Performance.............................................................................................................114
Changing RAID Levels..................................................................................................................115
Changing Segment Size...............................................................................................................115
Defragmenting A Disk Group...................................................................................................... 116
Using SSD Cache............................................................................................................................... 116
Enabling SSD Cache For A Virtual Disk....................................................................................... 116
Creating SSD Cache.....................................................................................................................117
Adding Physical Disks To Existing SSD Cache............................................................................ 117
Removing Physical Disks From Existing SSD Cache...................................................................117
SSD Cache Performance Modeling.............................................................................................117
Additional Information About SSD Cache And Performance Modeling....................................118
Troubleshooting and Diagnostics.....................................................................................................118
Collecting Physical Disk Data......................................................................................................118
Diagnosing A RAID Controller Module....................................................................................... 118
Recovery Operations.........................................................................................................................119
Setting RAID Controller Module Operational Mode...................................................................119
Changing RAID Controller Module Ownership......................................................................... 120
Initializing A Physical Disk........................................................................................................... 120
Reconstructing A Physical Disk.................................................................................................. 120
Initializing A Virtual Disk...............................................................................................................121
Redistributing Virtual Disks ......................................................................................................... 121
10 Script Commands............................................................................................... 123
Command Formatting Rules.............................................................................................................123
Firmware Compatibility Levels..........................................................................................................125
Commands Listed By Function.........................................................................................................125
Disk Group Commands...............................................................................................................125
Enclosure Commands.................................................................................................................125
Host Topology Commands........................................................................................................ 126
iSCSI Commands.........................................................................................................................126
Physical Disk Commands............................................................................................................126
RAID Controller Module Commands..........................................................................................127
Remote Replication Commands.................................................................................................127
Session Command...................................................................................................................... 128
Show String Command...............................................................................................................128
Snapshot Commands..................................................................................................................128
SSD Cache Commands...............................................................................................................129
Storage Array Commands...........................................................................................................129
Virtual Disk Commands...............................................................................................................130
Virtual Disk Copy Commands..................................................................................................... 131
11 Commands Listed Alphabetically....................................................................133
Activate Remote Replication Feature............................................................................................... 133
Activate Storage Array Firmware.......................................................................................................135
Add Member To Consistency Group................................................................................................136
Add Physical Disks To SSD Cache.................................................................................................... 138
Add Virtual Disk To Remote Replication Group...............................................................................139
Autoconfigure Storage Array............................................................................................................140
Autoconfigure Storage Array Hot Spares......................................................................................... 142
Blink SSD Cache................................................................................................................................ 142
Cancel Remote Replication Group Role Reversal........................................................................... 143
Change SSD Cache Application Type.............................................................................................. 143
Check Remote Replication Status....................................................................................................144
Check Remote Replication Group Consistency..............................................................................144
Check Repository Consistency.........................................................................................................145
Check Storage Array Connectivity................................................................................................... 146
Check Virtual Disk Consistency........................................................................................................147
Clear Physical Disk Port Statistics.....................................................................................................148
Clear Remote Replication Fault........................................................................................................149
Clear Storage Array Configuration................................................................................................... 150
Clear Storage Array Core Dump....................................................................................................... 151
Clear Storage Array Event Log.......................................................................................................... 151
Clear Storage Array Firmware Pending Area....................................................................................152
Clear Storage Array Recovery Mode.................................................................................................152
Clear Virtual Disk Reservations......................................................................................................... 152
Clear Virtual Disk Unreadable Sectors..............................................................................................153
Configure Automatic Support Bundle Collection............................................................................154
Convert Snapshot (Legacy) Virtual Disk To Snapshot Group..........................................................154
Create Consistency Group................................................................................................................155
Create Consistency Group Snapshot Image....................................................................................157
Create Consistency Group Snapshot Virtual Disk........................................................................... 158
Create Consistency Group Snapshot Virtual Disk Mapping............................................................160
Create Disk Group............................................................................................................................. 161
Create Disk Pool................................................................................................................................164
Create Host....................................................................................................................................... 166
Create Host Group............................................................................................................................ 167
Create Host Port................................................................................................................................167
Create iSCSI Initiator.........................................................................................................................168
Create RAID Virtual Disk (Automatic Physical Disk Select)..............................................................169
Create RAID Virtual Disk (Free Capacity Base Select).......................................................................171
Create RAID Virtual Disk (Manual Physical Disk Select)................................................................... 173
Create RAID Virtual Disk On A Disk Pool..........................................................................................176
Create Read-Only Snapshot Virtual Disk..........................................................................................178
Create Remote Replication...............................................................................................................179
Create Remote Replication Group................................................................................................... 181
Create Snapshot Group.................................................................................................................... 183
Create Snapshot Image.................................................................................................................... 186
Create Snapshot (Legacy) Virtual Disk..............................................................................................187
Create Snapshot Virtual Disk............................................................................................................ 192
Create SSD Cache.............................................................................................................................194
Create Storage Array Security Key....................................................................................................195
Create Virtual Disk Copy................................................................................................................... 197
Deactivate Remote Replication (Legacy)......................................................................................... 199
Delete Consistency Group............................................................................................................... 199
Delete Consistency Group Snapshot Image................................................................................... 200
Delete Consistency Group Snapshot Virtual Disk............................................................................201
Delete Disk Group.............................................................................................................................201
Delete Disk Pool............................................................................................................................... 202
Delete Host....................................................................................................................................... 202
Delete Host Group............................................................................................................................203
Delete Host Port............................................................................................................................... 203
Delete iSCSI Initiator.........................................................................................................................204
Delete Snapshot Group....................................................................................................................205
Delete Snapshot Image.................................................................................................................... 205
Delete Snapshot (Legacy) Virtual Disk............................................................................................. 207
Delete Snapshot Virtual Disk............................................................................................................208
Delete Snapshot Virtual Disk or Delete Snapshot Virtual Disk Schedule....................................... 208
Delete SSD Cache.............................................................................................................................209
Delete Virtual Disk............................................................................................................................ 209
Delete Virtual Disk On A Disk Pool...................................................................................................210
Diagnose RAID Controller Module....................................................................................................211
Diagnose RAID Controller Module iSCSI Host Cable...................................................................... 213
Diagnose Remote Replication.......................................................................................................... 214
Disable Storage Array Feature...........................................................................................................215
Display Automatic Support Bundle Collection Configuration........................................................ 215
Display Support Bundle Collection Schedule.................................................................................. 216
Download Enclosure Management Module Firmware....................................................................216
Download Physical Disk Firmware....................................................................................................217
Download Storage Array Firmware/NVSRAM.................................................................................. 218
Download Storage Array Physical Disk Firmware............................................................................219
Download Storage Array NVSRAM...................................................................................................220
Enable Disk Group Security..............................................................................................................220
Enable Disk Pool Security................................................................................................................. 221
Enable Or Disable SSD Cache For A Virtual Disk............................................................................. 222
Enable RAID Controller Module Data Transfer................................................................................222
Enable Storage Array Feature........................................................................................................... 223
Establish Remote Replicated Pair.....................................................................................................224
Increase Virtual Disk Capacity On A Disk Pool................................................................................ 225
Load Storage Array DBM Database.................................................................................................. 225
Modify Disk Pool............................................................................................................................... 227
Recopy Virtual Disk Copy................................................................................................................. 228
Re-Create Remote Replication Repository Virtual Disk..................................................................229
Re-Create Snapshot..........................................................................................................................231
Reinitialize Thin Virtual Disk..............................................................................................................233
Remove Incomplete Remote Replicated Pair From Remote Replication Group.......................... 234
Remove Member Virtual Disk From Consistency Group................................................................ 235
Remove Physical Disks From SSD Cache........................................................................................ 235
Remove Remote Replication............................................................................................................236
Remove Virtual Disk Copy................................................................................................................ 237
Remove Virtual Disk From Remote Replication Group................................................................... 237
Remove Virtual Disk LUN Mapping.................................................................................................. 238
Rename A Snapshot Virtual Disk...................................................................................................... 239
Rename SSD Cache..........................................................................................................................240
Repair Virtual Disk Consistency....................................................................................................... 240
Replace Physical Disk........................................................................................................................241
Reset iSCSI IP Address...................................................................................................................... 242
Reset RAID Controller Module......................................................................................................... 242
Reset Remote Replication Group Statistics..................................................................................... 243
Reset Storage Array Battery Install Date.......................................................................................... 245
Reset Storage Array iSCSI Baseline.................................................................................................. 245
Reset Storage Array SAS PHY Baseline.............................................................................................246
Reset Storage Array Virtual Disk Distribution...................................................................................246
Resume Consistency Group Snapshot Virtual Disk.........................................................................246
Resume Remote Replication............................................................................................................248
Resume Remote Replication Group................................................................................................ 248
Resume Snapshot Image Rollback.................................................................................................. 249
Resume Snapshot (Legacy) Rollback...............................................................................................250
Resume Snapshot Virtual Disk.......................................................................................................... 251
Resume SSD Cache.......................................................................................................................... 252
Revive Disk Group.............................................................................................................................252
Revive Disk Pool................................................................................................................................253
Revive Physical Disk.......................................................................................................................... 253
Revive Snapshot Group.................................................................................................................... 254
Revive Snapshot Virtual Disk............................................................................................................ 254
Save Enclosure Log Data.................................................................................................................. 255
Save Physical Disk Channel Fault Isolation Diagnostic Status........................................................ 255
Save Physical Disk Log......................................................................................................................256
Save RAID Controller Module NVSRAM........................................................................................... 256
Save Remote Replication Group Statistics.......................................................................................257
Save Storage Array Configuration.................................................................................................... 259
Save Storage Array Core Dump....................................................................................................... 260
Save Storage Array DBM Database.................................................................................................. 260
Save Storage Array DBM Validator Information File........................................................................ 262
Save Storage Array Events................................................................................................................ 263
Save Storage Array iSCSI Statistics................................................................................................... 264
Save Storage Array Performance Statistics...................................................................................... 265
Save Storage Array SAS PHY Counts................................................................................................265
Save Storage Array State Capture.................................................................................................... 266
Save Storage Array Support Data..................................................................................................... 266
Schedule Support Bundle Collection Configuration.......................................................................267
Scheduling Snapshots...................................................................................................................... 268
Set Consistency Group Attributes....................................................................................................269
Set Consistency Group Snapshot Virtual Disk.................................................................................270
Set Disk Group ..................................................................................................................................271
Set Disk Group Forced State.............................................................................................................272
Set Disk Pool......................................................................................................................................273
Set Disk Pool Complete....................................................................................................................274
Set Enclosure Attribute..................................................................................................................... 274
Set Enclosure Identification..............................................................................................................275
Set Foreign Physical Disk to Native.................................................................................................. 276
Set Host............................................................................................................................................. 276
Set Host Channel.............................................................................................................................. 278
Set Host Group..................................................................................................................................278
Set Host Port..................................................................................................................................... 279
Set iSCSI Initiator...............................................................................................................................279
Set iSCSI Target Properties...............................................................................................................280
Set Physical Disk Channel Status......................................................................................................281
Set Physical Disk Hot Spare.............................................................................................................. 281
Set Physical Disk State...................................................................................................................... 282
Set RAID Controller Module.............................................................................................................282
Set Read-Only Snapshot Virtual Disk To A Read/Write Virtual Disk............................................... 285
Set Remote Replication....................................................................................................................286
Set Remote Replication Group........................................................................................................ 288
Set Session........................................................................................................................................ 292
Set Snapshot Group Attributes.........................................................................................................293
Set Snapshot Group Media Scan......................................................................................................294
Set Snapshot Group Repository Virtual Disk Capacity.................................................................... 295
Set Snapshot Group Schedule......................................................................................................... 295
Set Snapshot (Legacy) Virtual Disk...................................................................................................296
Set Snapshot Virtual Disk Media Scan..............................................................................................300
Set Snapshot Virtual Disk Repository Virtual Disk Capacity............................................................ 301
Set Storage Array...............................................................................................................................301
Set Storage Array Enclosure Positions.............................................................................................304
Set Storage Array ICMP Response................................................................................................... 305
Set Storage Array iSNS Server IPv4 Address.................................................................................... 305
Set Storage Array iSNS Server IPv6 Address.................................................................................... 306
Set Storage Array iSNS Server Listening Port...................................................................................306
Set Storage Array Learn Cycle..........................................................................................................307
Set Storage Array Redundancy Mode.............................................................................................. 307
Set Storage Array Security Key.........................................................................................................308
Set Storage Array Time.....................................................................................................................308
Set Storage Array Unnamed Discovery Session.............................................................................. 309
Set Thin Virtual Disk Attributes.........................................................................................................309
Set Virtual Disk................................................................................................................................... 311
Set Virtual Disk Attributes For A Disk Pool........................................................................................314
Set Virtual Disk Copy.........................................................................................................................319
Set Virtual Disk Mapping...................................................................................................................320
Show Consistency Group Snapshot Image......................................................................................321
Show Current iSCSI Sessions............................................................................................................323
Show Disk Group.............................................................................................................................. 324
Show Disk Group Export Dependencies..........................................................................................324
Show Disk Group Import Dependencies......................................................................................... 325
Show Disk Pool................................................................................................................................. 325
Show Host Ports............................................................................................................................... 326
Show Physical Disk........................................................................................................................... 326
Show Physical Disk Channel Statistics.............................................................................................328
Show Physical Disk Download Progress..........................................................................................329
Show RAID Controller Module.........................................................................................................329
Show RAID Controller Module NVSRAM......................................................................................... 330
Show Remote Replication Group.....................................................................................................331
Show Remote Replication Group Synchronization Progress......................................................... 332
Show Remote Replication Virtual Disk Candidates......................................................................... 332
Show Remote Replication Virtual Disk Synchronization Progress................................................. 333
Show Snapshot Group......................................................................................................................334
Show Snapshot Image...................................................................................................................... 335
Show Snapshot Virtual Disks............................................................................................................ 336
Show SSD Cache...............................................................................................................................337
Show SSD Cache Statistics...............................................................................................................339
Show Storage Array.......................................................................................................................... 342
Show Storage Array Auto Configure................................................................................................344
Show Storage Array Core Dump......................................................................................................345
Show Storage Array DBM Database.................................................................................................345
Show Storage Array Host Topology.................................................................................................346
Show Storage Array LUN Mappings.................................................................................................346
Show Storage Array Negotiation Defaults....................................................................................... 347
Show Storage Array Unconfigured iSCSI Initiators..........................................................................347
Show Storage Array Unreadable Sectors......................................................................................... 347
Show String.......................................................................................................................................348
Show Thin Virtual Disk......................................................................................................................348
Show Virtual Disk.............................................................................................................................. 349
Show Virtual Disk Action Progress....................................................................................................351
Show Virtual Disk Copy.....................................................................................................................351
Show Virtual Disk Copy Source Candidates.................................................................................... 352
Show Virtual Disk Copy Target Candidates..................................................................................... 353
Show Virtual Disk Performance Statistics........................................................................................ 353
Show Virtual Disk Reservations........................................................................................................ 353
Start Configuration Database Diagnostic........................................................................................ 354
Start Consistency Group Snapshot Rollback...................................................................................355
Start Disk Group Blink.......................................................................................................................356
Start Disk Group Defragment...........................................................................................................356
Start Disk Group Export.................................................................................................................... 357
Start Disk Group Import....................................................................................................................357
Start Disk Pool Locate.......................................................................................................................358
Start Enclosure Blink.........................................................................................................................358
Start iSCSI DHCP Refresh................................................................................................................. 359
Start Physical Disk Blink.................................................................................................................... 359
Start Physical Disk Channel Blink.....................................................................................................360
Start Physical Disk Channel Fault Isolation Diagnostics................................................................. 360
Start Physical Disk Initialize...............................................................................................................361
Start Physical Disk Reconstruction...................................................................................................362
Start Remote Replication Synchronization......................................................................................362
Start Remote Replication (Legacy) Synchronization.......................................................................363
Start Secure Physical Disk Erase.......................................................................................................363
Start Snapshot Rollback....................................................................................................................364
Start Snapshot Image Rollback........................................................................................................ 364
Start SSD Cache Performance Modeling.........................................................................................365
Start Storage Array Blink...................................................................................................................366
Start Storage Array Configuration Database Diagnostic.................................................................366
Start Storage Array iSCSI Refresh.....................................................................................................368
Start Virtual Disk Initialization...........................................................................................................369
Stop Configuration Database Diagnostic........................................................................................ 369
Stop Consistency Group Snapshot Rollback...................................................................................370
Stop Consistency Group Snapshot Virtual Disk............................................................................... 371
Stop Disk Group Blink........................................................................................................................371
Stop Disk Pool Locate.......................................................................................................................372
Stop Enclosure Blink......................................................................................................................... 372
Stop Pending Snapshot Images On Consistency Group.................................................................372
Stop Physical Disk Blink.................................................................................................................... 373
Stop Physical Disk Channel Blink..................................................................................................... 373
Stop Physical Disk Channel Fault Isolation Diagnostics..................................................................373
Stop Snapshot Group Image............................................................................................................ 374
Stop Snapshot Group Pending Snapshot Images............................................................................374
Stop Snapshot (Legacy).................................................................................................................... 375
Stop Snapshot (Legacy) Rollback..................................................................................................... 376
Stop Snapshot Rollback.................................................................................................................... 377
Stop Snapshot Image Rollback.........................................................................................................377
Stop Snapshot Virtual Disk................................................................................................................378
Stop SSD Cache Performance Modeling......................................................................................... 379
Stop Storage Array Blink................................................................................................................... 381
Stop Storage Array Configuration Database Diagnostic................................................................. 381
Stop Storage Array iSCSI Session..................................................................................................... 382
Stop Storage Array Physical Disk Firmware Download...................................................................382
Stop Virtual Disk Copy......................................................................................................................382
Suspend Remote Replication........................................................................................................... 383
Suspend Remote Replication Group............................................................................................... 384
Suspend SSD Cache......................................................................................................................... 384
Test Remote Replication Group Connectivity.................................................................................385
Validate Storage Array Security Key................................................................................................. 386
12 Sample Script Files............................................................................................. 389
Configuration Script Example 1........................................................................................................389
Configuration Script Example 2....................................................................................................... 390
13 CLI Command Updates.....................................................................................393
New Commands...............................................................................................................................393
Updated Commands........................................................................................................................ 395
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 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.
15
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
16
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)
[-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]]
17
[-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.
18
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.
19
Parameter Definition
-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:
• 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.
20
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
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.
-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 (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
21
Parameter Definition
-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 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 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.
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:
22
• 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 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.
23
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.
24
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
25
26
2
About The Script Commands
You can use the script commands to configure and manage a storage array. The script commands are
distinct from the command line interface (CLI) commands; however, you enter the script commands
using the command line interface. You can enter individual script commands, or run a file of script
commands. When entering an individual script command, include it as part of a CLI command. When
running a file of script commands, include the file name as part of a CLI command. The script commands
are processed by a script engine that performs the following functions:
• Verifies command syntax
• Interprets the commands
• Converts the commands to the appropriate protocol-compliant commands, which is, in turn, run by
the RAID controller module
• Passes the commands to the storage array
At the storage array, the redundant array of independent disks (RAID) controller modules in the storage
array runs the script commands.
The script engine and script commands support the storage array configuration and management
operations listed in .
Table 4. Configuration and Management Operations
Operation Activities
Virtual disk, disk group configuration Creating, deleting, and setting priority; labeling;
setting physical disk composition when creating
virtual disks; setting segment size; and setting
media scan control
Physical disk configuration Configuring the hot spare
RAID controller module configuration Defining virtual disk ownership, changing mode
settings, defining network settings, and setting host
port IDs
General storage array configuration Resetting a configuration to defaults, labeling,
checking the health status, setting the time of day,
clearing the Major Event Log, and setting the
media scan rate
NVSRAM configuration Downloading and modifying the user configuration
region at the bit and byte level, displaying
nonvolatile static random access memory
(NVSRAM) values
Product identification Retrieving the enclosure profile display data
Battery management Setting the battery installation date
Firmware management Downloading RAID controller module, enclosure
management module (EMM), and physical disk
firmware
27
Script Command Structure
All script commands have the following structure:
command operand-data {statement-data}
where, command identifies the action to be performed, operand-data represents the storage array
component to configure or manage (such as a RAID controller module, physical disk, or disk group), and
statement-data is what you want to do to the component (such as, specifying the RAID level or
availability of a disk group).
The general form of the syntax for operand-data is as follows:
(object-type | allobject-types | [qualifier]
(object-type [identifier] {object-type
[identifier]} | object-types [identifier-list]))
An operand-data object can be identified four ways:
• The object types and object qualifiers
• The all parameter
• Brackets
• A list of identifiers
NOTE: You can use any combination of alphanumeric characters, hyphens, and underscores for the
names. Command names can have a maximum of 30 characters. If you exceed the maximum
character limit, replace square brackets ([ ]) with angle brackets (< >) to overcome this limitation.
Use an object type when the command is not referencing a specific object. The all parameter means all
objects of the specified type in the storage array (for example,
allVirtualDisks).
To perform a command on a specific object, use brackets to identify the object (for example,
virtualDisk[engineering]). Specify a subset of objects with a list of identifiers in brackets (for example,
virtualDisks[sales engineering marketing]). In a list of identifiers, use a blank space as the delimiter. A
qualifier is necessary if you want to include additional information to describe the objects.
The following table lists the object type and identifiers associated with the object types.
Table 5. Object Types and Identifiers
Object Type Identifier
controller 0 or 1
physicalDisk Enclosure ID and the slot ID
physicalDiskChannel Physical disk channel identifier
GroupName Remote Replication virtual disk user label
host User label
hostChannel Host channel identifier
hostGroup User label
hostPort User label
snapVirtualDiskName Virtual disk user label
snapshot Virtual disk user label
28
Object Type Identifier
snapGroup A snapshot group contains a sequence of snapshot
images of an associated base virtual disk. A snapshot
group has a repository virtual disk that is used to
save data for all of the snapshot images that are part
of the snapshot group.
snapGroupName Virtual disk group user label
storageArray Not applicable
enclosure Enclosure ID
virtualDisk Virtual disk user label or the World Wide Identifier
(WWID) for the virtual disk (set command only)
virtualDiskCopy Target virtual disk and, optionally, the source virtual
disk user labels
diskGroup Virtual disk group number
Statement data is in the form of attribute=value (such as raidLevel=5), an attribute name (such as
batteryInstallDate), or an operation name (such as consistencyCheck).
Script Command Synopsis
Because you can use the script commands to define and manage the different aspects of a storage array
(such as host topology, physical disk configuration, RAID controller module configuration, virtual disk
definitions, and disk group definitions), the actual number of commands is extensive. The commands,
however, fall into general categories that are reused when you apply the commands to the different
aspects of a storage array.
The following table lists the general form of the script commands and provides a definition of each
command.
Table 6. General Form of the Script Commands
Command Syntax Description
activate object {statement‑data} Sets up the environment so that an operation can
take place or performs the operation if the
environment is already correctly set up.
autoConfigure storageArray{statement-data} Automatically creates a configuration based on
parameters specified in the command.
check object {statement‑data} Starts a synchronous operation to report on errors
in the object.
clear object {statement‑data} Discards the contents of some attribute of an
object. This is a destructive operation that cannot
be reversed.
create object {statement‑data} Creates an object of the specified type.
deactivate object {statement‑data} Removes the environment for an operation.
delete object Deletes a previously created object.
29
Command Syntax Description
diagnose object {statement‑data} Runs a test and displays the results.
disable object {statement‑data} Prevents a feature from operating.
download object {statement‑data} Transfers data to the storage array or hardware
associated with the storage array.
enable object {statement‑data} Allows a feature to operate.
recopy object {statement‑data} Restarts a virtual disk copy operation by using an
existing virtual disk copy pair. You can change
attributes before the operation is restarted.
recover object {statement‑data} Re-creates an object from saved configuration
data and the statement attributes (similar to the
create command).
recreate object {statement‑data} Restarts a snapshot operation using an existing
snapshot virtual disk. You can change attributes
before the operation is restarted.
remove object {statement‑data} Removes a relationship from between objects.
repair object {statement‑data} Repairs errors found by the check command.
reset object {statement‑data} Returns the hardware or object to an initial state.
resume object Starts a suspended operation. The operation
begins where it left off when suspended.
revive object Forces the object from the Failed to the Optimal
state. Use only as part of an error recovery
procedure.
save object {statement‑data} Writes information about the object to a file.
set object {statement‑data} Changes object attributes. All changes are
completed when the command returns.
show object {statement‑data} Displays information about the object.
start object {statement‑data} Starts an asynchronous operation. You can stop
some operations after they have started. You can
query the progress of some operations.
stop object {statement‑data} Stops an asynchronous operation.
suspend object {statement‑data} Suspends an operation. You can then restart the
suspended operation, and it continues from the
point at which it was suspended.
Recurring Syntax Elements
Recurring syntax elements are a general category of variables and parameters you can use in one or
more script commands. The recurring syntax is used in the general definitions of the script commands
that are listed in Script Commands. The following table lists the recurring syntax and the syntax values
that you can use with the syntax.
30
Loading...