Professional Documents
Culture Documents
IBM v7000 Expansion Installation PDF
IBM v7000 Expansion Installation PDF
Family
Version 7.2.0
GC27-2287-05
Note
Before using this information and the product it supports, read the information in “Notices” on page 665.
This edition applies to IBM System Storage SAN Volume Controller, Version 7.2, and to all subsequent releases and
modifications until otherwise indicated in new editions.
This edition replaces GC27-2287-02.
© Copyright IBM Corporation 2003, 2013.
US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract
with IBM Corp.
Contents
Tables . . . . . . . . . . . . . . . ix Modifying the amount of available memory for
Copy Services and Volume Mirroring features using
About this guide . . . . . . . . . . . xi the CLI . . . . . . . . . . . . . . . . 24
Creating volumes using the CLI . . . . . . . 26
Who should use this guide . . . . . . . . . xi
Adding a copy to a volume using the CLI . . . . 28
Accessibility . . . . . . . . . . . . . . xi
Deleting a copy from a volume using the CLI . . . 29
Summary of changes for GC27-2287-05 SAN Volume
Configuring host objects using the CLI . . . . . 30
Controller Command-Line Interface User's Guide . . xi
Creating host mappings using the CLI . . . . . 31
Emphasis . . . . . . . . . . . . . . . xii
Creating FlashCopy mappings using the CLI . . . 31
SAN Volume Controller library and related
Preparing and starting a FlashCopy mapping
publications . . . . . . . . . . . . . . xii
using the CLI. . . . . . . . . . . . . 32
How to order IBM publications. . . . . . . . xv
Stopping FlashCopy mappings using the CLI . . 33
Sending your comments . . . . . . . . . . xv
Deleting a FlashCopy mapping using the CLI . . 34
Syntax diagrams. . . . . . . . . . . . . xv
Creating a FlashCopy consistency group and adding
Terminology . . . . . . . . . . . . xvii
mappings using the CLI . . . . . . . . . . 34
CLI special characters . . . . . . . . . xvii
Preparing and starting a FlashCopy consistency
Using wildcards in the SAN Volume Controller
group using the CLI . . . . . . . . . . 36
CLI . . . . . . . . . . . . . . . xvii
Stopping a FlashCopy consistency group using
Data types and value ranges . . . . . . . xviii
the CLI . . . . . . . . . . . . . . . 37
CLI commands and parameters . . . . . . xxiii
Deleting a FlashCopy consistency group using
CLI flags . . . . . . . . . . . . . xxiii
the CLI . . . . . . . . . . . . . . . 37
CLI messages . . . . . . . . . . . . xxiv
Creating Metro Mirror or Global Mirror
Attributes of the -filtervalue parameters . . . xxiv
relationships using the CLI . . . . . . . . . 38
Modifying Metro Mirror or Global Mirror
Chapter 1. Setting up an SSH client . . . 1 relationships using the CLI . . . . . . . . 39
Setting up an SSH client on a Windows host. . . . 1 Starting and stopping Metro Mirror or Global
Generating an SSH key pair using PuTTY . . . 2 Mirror relationships using the CLI. . . . . . 39
Configuring a PuTTY session for the CLI . . . . 3 Displaying the progress of Metro Mirror or
Connecting to the CLI using PuTTY . . . . . 4 Global Mirror relationships using the CLI . . . 39
Starting a PuTTY session for the CLI . . . . . 5 Switching Metro Mirror or Global Mirror
Preparing the SSH client on an AIX or Linux host . . 6 relationships using the CLI . . . . . . . . 40
Generating an SSH key pair using OpenSSH. . . 7 Deleting Metro Mirror and Global Mirror
Connecting to the CLI using OpenSSH . . . . 7 relationships using the CLI . . . . . . . . 40
Working with local and remote users . . . . . . 7 Creating Metro Mirror or Global Mirror consistency
groups using the CLI . . . . . . . . . . . 41
Chapter 2. Copying the SAN Volume Modifying Metro Mirror or Global Mirror
Controller software upgrade files using consistency groups using the CLI . . . . . . 41
PuTTY scp . . . . . . . . . . . . . 9 Starting and stopping Metro Mirror or Global
Mirror consistency-group copy processes using
the CLI . . . . . . . . . . . . . . . 42
Chapter 3. Using the CLI . . . . . . . 11 Deleting Metro Mirror or Global Mirror
Setting the clustered system time using the CLI . . 11 consistency groups using the CLI . . . . . . 42
Setting cluster date and time . . . . . . . . 12 Creating Metro Mirror and Global Mirror
Viewing and updating license settings using the CLI 12 partnerships using the CLI . . . . . . . . . 42
Displaying clustered system properties using the Modifying Metro Mirror and Global Mirror
CLI . . . . . . . . . . . . . . . . . 13 partnerships using the CLI . . . . . . . . 43
Maintaining passwords for the front panel using the Starting and stopping Metro Mirror and Global
CLI . . . . . . . . . . . . . . . . . 14 Mirror partnerships using the CLI . . . . . . 44
Re-adding a repaired node to a clustered system Deleting Metro Mirror and Global Mirror
using the CLI. . . . . . . . . . . . . . 15 partnerships using the CLI . . . . . . . . 45
Displaying node properties using the CLI . . . . 18 Determining the WWPNs of a node using the CLI 45
Discovering MDisks using the CLI . . . . . . 19 Listing node-dependent volumes using the CLI . . 46
Creating storage pools using the CLI . . . . . . 20 Determining the VDisk name from the device
Adding MDisks to storage pools using the CLI . . 23 identifier on the host . . . . . . . . . . . 46
Setting a quorum disk using the CLI . . . . . . 24 Determining the host that a VDisk (volume) maps 47
iv SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lsclustercandidate (Discontinued) . . . . . . . 139 lserrlogbyfcconsistgrp (Deprecated) . . . . . . 210
lscluster (Discontinued) . . . . . . . . . . 140 lserrlogbyfcmap (Deprecated) . . . . . . . . 210
lsclusterip (Discontinued) . . . . . . . . . 140 lserrlogbyhost (Deprecated) . . . . . . . . 210
lsclusterstats (Discontinued) . . . . . . . . 140 lserrlogbyiogrp (Deprecated) . . . . . . . . 210
lsdiscoverystatus . . . . . . . . . . . . 140 lserrlogbymdisk (Deprecated) . . . . . . . . 210
lsfabric . . . . . . . . . . . . . . . 141 lserrlogbymdiskgrp (Deprecated) . . . . . . . 210
lshbaportcandidate (Discontinued) . . . . . . 143 lserrlogbynode (Deprecated) . . . . . . . . 210
lsfcportcandidate . . . . . . . . . . . . 143 lserrlogbyrcconsistgrp (Deprecated) . . . . . . 210
lssasportcandidate . . . . . . . . . . . . 144 lserrlogbyrcrelationship (Deprecated) . . . . . 211
lsiogrp . . . . . . . . . . . . . . . 145 lserrlogbyvdisk (Deprecated) . . . . . . . . 211
lsiogrphost . . . . . . . . . . . . . . 147 lserrlogdumps (Deprecated) . . . . . . . . 211
lsiogrpcandidate . . . . . . . . . . . . 148 lsfeaturedumps (Deprecated) . . . . . . . . 211
lsiostatsdumps (Deprecated) . . . . . . . . 149 lseventlog . . . . . . . . . . . . . . 211
lsiotracedumps (Deprecated) . . . . . . . . 149 lssyslogserver . . . . . . . . . . . . . 215
lsnode (SVC) / lsnodecanister (Storwize family lssoftwaredumps (Deprecated). . . . . . . . 217
products) . . . . . . . . . . . . . . . 149 lssoftwareupgradestatus . . . . . . . . . . 217
lsnodecandidate (SAN Volume Controller). . . . 153 setlocale . . . . . . . . . . . . . . . 218
lsnodedependentvdisks (Deprecated) . . . . . 154 svqueryclock . . . . . . . . . . . . . 219
lsnodehw (SVC) / lsnodecanisterhw (Storwize writesernum. . . . . . . . . . . . . . 220
family products) . . . . . . . . . . . . 154
lsnodestats (SVC) / lsnodecanisterstats (Storwize Chapter 10. Controller command . . . 221
family products) . . . . . . . . . . . . 156 chcontroller . . . . . . . . . . . . . . 221
lsnodevpd (SVC) / lsnodecanistervpd (Storwize lscontroller . . . . . . . . . . . . . . 222
family products) . . . . . . . . . . . . 163 lscontrollerdependentvdisks . . . . . . . . 225
lsportip . . . . . . . . . . . . . . . 172
lsportfc . . . . . . . . . . . . . . . 176
Chapter 11. Drive commands. . . . . 227
lsportsas . . . . . . . . . . . . . . . 179
applydrivesoftware . . . . . . . . . . . 227
lsroute. . . . . . . . . . . . . . . . 181
chdrive . . . . . . . . . . . . . . . 230
lstimezones . . . . . . . . . . . . . . 181
lsdrive. . . . . . . . . . . . . . . . 231
lssystem . . . . . . . . . . . . . . . 182
lsdrivelba. . . . . . . . . . . . . . . 233
lssystemip . . . . . . . . . . . . . . 187
lsdriveprogress . . . . . . . . . . . . . 235
lssystemstats . . . . . . . . . . . . . 189
ping . . . . . . . . . . . . . . . . 193
| lsdriveupgradeprogress . . . . . . . . . . 236
triggerdrivedump . . . . . . . . . . . . 238
rmnode (SVC) / rmnodecanister (Storwize family
products) . . . . . . . . . . . . . . . 194
rmportip . . . . . . . . . . . . . . . 196 Chapter 12. Email and event
setclustertime (Discontinued) . . . . . . . . 197 notification commands . . . . . . . 239
setsystemtime . . . . . . . . . . . . . 197 chemail . . . . . . . . . . . . . . . 239
setpwdreset . . . . . . . . . . . . . . 197 chemailserver . . . . . . . . . . . . . 241
settimezone . . . . . . . . . . . . . . 198 chemailuser . . . . . . . . . . . . . . 242
showtimezone . . . . . . . . . . . . . 199 chsnmpserver . . . . . . . . . . . . . 243
startstats . . . . . . . . . . . . . . . 199 chsyslogserver . . . . . . . . . . . . . 244
stopstats (Deprecated) . . . . . . . . . . 201 lsemailserver . . . . . . . . . . . . . 245
stopcluster (Discontinued) . . . . . . . . . 201 lsemailuser . . . . . . . . . . . . . . 246
stopsystem . . . . . . . . . . . . . . 201 lssnmpserver . . . . . . . . . . . . . 247
mkemailserver . . . . . . . . . . . . . 248
Chapter 9. Clustered system mkemailuser . . . . . . . . . . . . . 249
diagnostic and service-aid commands 203 mksnmpserver . . . . . . . . . . . . . 250
mksyslogserver . . . . . . . . . . . . . 252
applysoftware . . . . . . . . . . . . . 203
rmemailserver . . . . . . . . . . . . . 253
caterrlog (Deprecated) . . . . . . . . . . 205
rmemailuser . . . . . . . . . . . . . . 253
caterrlogbyseqnum (Deprecated) . . . . . . . 205
rmsnmpserver . . . . . . . . . . . . . 254
cherrstate (Discontinued) . . . . . . . . . 205
rmsyslogserver . . . . . . . . . . . . . 254
cheventlog . . . . . . . . . . . . . . 205
sendinventoryemail . . . . . . . . . . . 255
clearerrlog . . . . . . . . . . . . . . 206
setemail (Discontinued) . . . . . . . . . . 255
cpfabricdumps (Discontinued) . . . . . . . . 206
startemail. . . . . . . . . . . . . . . 255
dumperrlog . . . . . . . . . . . . . . 206
stopemail. . . . . . . . . . . . . . . 256
finderr . . . . . . . . . . . . . . . 207
testemail . . . . . . . . . . . . . . . 257
setevent (Discontinued) . . . . . . . . . . 208
lscimomdumps (Deprecated) . . . . . . . . 208
lscopystatus . . . . . . . . . . . . . . 208 Chapter 13. Enclosure commands . . 259
lsdumps . . . . . . . . . . . . . . . 208 addcontrolenclosure . . . . . . . . . . . 259
Contents v
chenclosure . . . . . . . . . . . . . . 259 lssshkeys (Discontinued) . . . . . . . . . 333
chenclosurecanister . . . . . . . . . . . 260
chenclosureslot . . . . . . . . . . . . . 261 Chapter 18. Livedump commands . . 335
chenclosurevpd. . . . . . . . . . . . . 263 cancellivedump. . . . . . . . . . . . . 335
lsenclosure . . . . . . . . . . . . . . 264 lslivedump . . . . . . . . . . . . . . 335
lsenclosurebattery . . . . . . . . . . . . 267 preplivedump . . . . . . . . . . . . . 336
lscontrolenclosurecandidate (Storwize family triggerlivedump . . . . . . . . . . . . 336
products only) . . . . . . . . . . . . . 268
lsenclosurecanister. . . . . . . . . . . . 269
Chapter 19. Managed disk commands 339
lsenclosurechassis (Flex V7000 Storage Node). . . 271
applymdisksoftware (Discontinued) . . . . . . 339
lsenclosurepsu . . . . . . . . . . . . . 273
chmdisk . . . . . . . . . . . . . . . 339
lsenclosureslot . . . . . . . . . . . . . 275
chquorum . . . . . . . . . . . . . . 339
lsenclosurestats . . . . . . . . . . . . . 277
dumpallmdiskbadblocks. . . . . . . . . . 341
lssasfabric . . . . . . . . . . . . . . 280
dumpmdiskbadblocks . . . . . . . . . . 342
resetleds . . . . . . . . . . . . . . . 281
includemdisk . . . . . . . . . . . . . 343
triggerenclosuredump . . . . . . . . . . 282
lsmdisk . . . . . . . . . . . . . . . 344
lsmdiskdumps (Deprecated) . . . . . . . . 349
Chapter 14. Licensing commands . . 285 lsmdisklba . . . . . . . . . . . . . . 349
chlicense . . . . . . . . . . . . . . . 285 lsmdiskcandidate . . . . . . . . . . . . 350
dumpinternallog . . . . . . . . . . . . 287 lsmdiskextent . . . . . . . . . . . . . 351
lslicense . . . . . . . . . . . . . . . 288 lsmdiskmember . . . . . . . . . . . . 353
lsquorum . . . . . . . . . . . . . . . 354
Chapter 15. IBM FlashCopy setquorum (Deprecated) . . . . . . . . . . 356
commands . . . . . . . . . . . . 291 triggermdiskdump (Discontinued) . . . . . . 356
chfcconsistgrp . . . . . . . . . . . . . 291
chfcmap . . . . . . . . . . . . . . . 291 Chapter 20. Managed disk group
lsfcconsistgrp . . . . . . . . . . . . . 293 commands . . . . . . . . . . . . 357
lsfcmap . . . . . . . . . . . . . . . 295 addmdisk . . . . . . . . . . . . . . 357
lsfcmapcandidate . . . . . . . . . . . . 297 chmdiskgrp . . . . . . . . . . . . . . 358
lsfcmapprogress . . . . . . . . . . . . 298 mkmdiskgrp . . . . . . . . . . . . . 359
lsfcmapdependentmaps . . . . . . . . . . 299 lsfreeextents . . . . . . . . . . . . . . 361
lsrmvdiskdependentmaps . . . . . . . . . 300 lsmdiskgrp . . . . . . . . . . . . . . 362
mkfcconsistgrp . . . . . . . . . . . . . 301 rmmdisk . . . . . . . . . . . . . . . 366
mkfcmap . . . . . . . . . . . . . . . 301 rmmdiskgrp . . . . . . . . . . . . . . 367
prestartfcconsistgrp . . . . . . . . . . . 304
prestartfcmap . . . . . . . . . . . . . 305
Chapter 21. Metro Mirror and Global
rmfcconsistgrp . . . . . . . . . . . . . 306
rmfcmap . . . . . . . . . . . . . . . 307 Mirror commands . . . . . . . . . 369
startfcconsistgrp . . . . . . . . . . . . 308 chpartnership . . . . . . . . . . . . . 369
startfcmap . . . . . . . . . . . . . . 309 chrcconsistgrp . . . . . . . . . . . . . 371
stopfcconsistgrp . . . . . . . . . . . . 311 chrcrelationship . . . . . . . . . . . . 373
stopfcmap . . . . . . . . . . . . . . 312 lspartnership . . . . . . . . . . . . . 377
lsrcconsistgrp . . . . . . . . . . . . . 380
lsrcrelationship . . . . . . . . . . . . . 382
Chapter 16. Host commands . . . . . 315
lsrcrelationshipcandidate . . . . . . . . . 385
addhostiogrp . . . . . . . . . . . . . 315
lsrcrelationshipprogress . . . . . . . . . . 386
addhostport . . . . . . . . . . . . . . 315
| mkfcpartnership . . . . . . . . . . . . 387
chhost . . . . . . . . . . . . . . . . 317
| mkippartnership . . . . . . . . . . . . 388
mkhost . . . . . . . . . . . . . . . 318
mkpartnership (Discontinued) . . . . . . . . 389
rmhost . . . . . . . . . . . . . . . 320
mkrcconsistgrp . . . . . . . . . . . . . 389
lshost . . . . . . . . . . . . . . . . 320
mkrcrelationship . . . . . . . . . . . . 390
lshostiogrp . . . . . . . . . . . . . . 324
rmpartnership . . . . . . . . . . . . . 393
lsiscsiauth . . . . . . . . . . . . . . 325
rmrcconsistgrp . . . . . . . . . . . . . 394
rmhostiogrp . . . . . . . . . . . . . . 326
rmrcrelationship . . . . . . . . . . . . 394
rmhostport . . . . . . . . . . . . . . 327
startrcconsistgrp . . . . . . . . . . . . 395
startrcrelationship . . . . . . . . . . . . 398
Chapter 17. Information commands 331 stoprcconsistgrp . . . . . . . . . . . . 400
ls2145dumps (Deprecated) . . . . . . . . . 331 stoprcrelationship . . . . . . . . . . . . 401
lsconfigdumps (Discontinued) . . . . . . . . 331 switchrcconsistgrp . . . . . . . . . . . . 403
lspartnershipcandidate . . . . . . . . . . 331 switchrcrelationship . . . . . . . . . . . 404
| lssite . . . . . . . . . . . . . . . . 332
vi SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 22. Migration commands . . . 407 stopnode . . . . . . . . . . . . . . . 448
lsmigrate . . . . . . . . . . . . . . . 407 stopservice . . . . . . . . . . . . . . 449
migrateexts . . . . . . . . . . . . . . 408 t3recovery . . . . . . . . . . . . . . 449
migratetoimage. . . . . . . . . . . . . 409
migratevdisk . . . . . . . . . . . . . 410 Chapter 27. Tracing commands. . . . 451
setdisktrace . . . . . . . . . . . . . . 451
Chapter 23. Service information settrace . . . . . . . . . . . . . . . 451
commands . . . . . . . . . . . . 413 starttrace . . . . . . . . . . . . . . . 454
lscmdstatus . . . . . . . . . . . . . . 413 stoptrace . . . . . . . . . . . . . . . 454
lsfiles . . . . . . . . . . . . . . . . 413
lshardware . . . . . . . . . . . . . . 414 Chapter 28. User management
lsservicenodes . . . . . . . . . . . . . 417 commands . . . . . . . . . . . . 457
lsservicerecommendation . . . . . . . . . 418 chauthservice . . . . . . . . . . . . . 457
lsservicestatus . . . . . . . . . . . . . 419 chcurrentuser . . . . . . . . . . . . . 459
chldap. . . . . . . . . . . . . . . . 460
Chapter 24. Service mode commands chldapserver . . . . . . . . . . . . . 463
(Discontinued) . . . . . . . . . . . 427 chuser . . . . . . . . . . . . . . . . 464
applysoftware (Discontinued) . . . . . . . . 427 chusergrp . . . . . . . . . . . . . . 466
svcservicemodetask cleardumps (Discontinued) . . 427 getstatus . . . . . . . . . . . . . . . 466
svcservicemodetask dumperrlog (Discontinued) 427 lscurrentuser . . . . . . . . . . . . . 467
exit (Discontinued) . . . . . . . . . . . 427 lsldap . . . . . . . . . . . . . . . . 467
lsldapserver . . . . . . . . . . . . . . 469
mkldapserver . . . . . . . . . . . . . 470
Chapter 25. Service mode information lsuser . . . . . . . . . . . . . . . . 471
commands (Discontinued) . . . . . . 429 lsusergrp . . . . . . . . . . . . . . . 473
ls2145dumps (Discontinued) . . . . . . . . 429 mkuser . . . . . . . . . . . . . . . 474
lscimomdumps (Discontinued) . . . . . . . 429 mkusergrp . . . . . . . . . . . . . . 475
lsclustervpd (Discontinued). . . . . . . . . 429 rmldapserver . . . . . . . . . . . . . 477
lserrlogdumps (Discontinued) . . . . . . . . 429 rmuser . . . . . . . . . . . . . . . 478
lsfeaturedumps (Discontinued) . . . . . . . 429 rmusergrp . . . . . . . . . . . . . . 478
lsiostatsdumps (Discontinued) . . . . . . . . 429 testldapserver . . . . . . . . . . . . . 479
lsiotracedumps (Discontinued) . . . . . . . 429
lsmdiskdumps (Discontinued) . . . . . . . . 429 Chapter 29. Virtual disk commands 483
lssoftwaredumps (Discontinued) . . . . . . . 429
addvdiskcopy . . . . . . . . . . . . . 483
addvdiskaccess . . . . . . . . . . . . . 488
Chapter 26. Service task commands 431 chvdisk . . . . . . . . . . . . . . . 489
activatefeature (Storwize V3500 and Storwize expandvdisksize . . . . . . . . . . . . 492
V3700). . . . . . . . . . . . . . . . 431 lshostvdiskmap. . . . . . . . . . . . . 494
deactivatefeature (Storwize V3500 and Storwize lsrepairsevdiskcopyprogress . . . . . . . . 496
V3700). . . . . . . . . . . . . . . . 432 lsrepairvdiskcopyprogress . . . . . . . . . 498
chnodeled . . . . . . . . . . . . . . 432 lssevdiskcopy . . . . . . . . . . . . . 500
chserviceip . . . . . . . . . . . . . . 433 lsvdisk . . . . . . . . . . . . . . . 503
chwwnn . . . . . . . . . . . . . . . 435 lsvdiskaccess . . . . . . . . . . . . . 510
cpfiles . . . . . . . . . . . . . . . . 436 lsvdiskcopy . . . . . . . . . . . . . . 511
help . . . . . . . . . . . . . . . . 437 lsvdiskdependentmaps . . . . . . . . . . 515
installsoftware . . . . . . . . . . . . . 438 lsvdiskextent . . . . . . . . . . . . . 515
leavecluster . . . . . . . . . . . . . . 438 lsvdiskfcmapcopies . . . . . . . . . . . 517
metadata . . . . . . . . . . . . . . . 439 lsvdiskfcmappings. . . . . . . . . . . . 518
mkcluster (satask) . . . . . . . . . . . . 440 lsvdiskhostmap. . . . . . . . . . . . . 518
mkcluster (Deprecated) . . . . . . . . . . 441 lsvdisklba . . . . . . . . . . . . . . 520
lsfeature (Storwize V3500 and Storwize V3700) . . 441 lsvdiskmember . . . . . . . . . . . . . 521
| overridequorum (satask). . . . . . . . . . 442 lsvdiskprogress . . . . . . . . . . . . . 523
rescuenode . . . . . . . . . . . . . . 443 lsvdisksyncprogress . . . . . . . . . . . 523
resetpassword . . . . . . . . . . . . . 443 lsdependentvdisks. . . . . . . . . . . . 524
restartservice . . . . . . . . . . . . . 444 mkvdisk . . . . . . . . . . . . . . . 526
setlocale (satask) . . . . . . . . . . . . 445 mkvdiskhostmap . . . . . . . . . . . . 534
setpacedccu . . . . . . . . . . . . . . 446 movevdisk . . . . . . . . . . . . . . 536
settempsshkey . . . . . . . . . . . . . 446 recovervdisk. . . . . . . . . . . . . . 537
snap . . . . . . . . . . . . . . . . 447 recovervdiskbycluster (Discontinued) . . . . . 538
startservice . . . . . . . . . . . . . . 447 recovervdiskbyiogrp . . . . . . . . . . . 538
Contents vii
recovervdiskbysystem . . . . . . . . . . 539 Index . . . . . . . . . . . . . . . 669
repairsevdiskcopy . . . . . . . . . . . . 539
repairvdiskcopy . . . . . . . . . . . . 540
rmvdisk . . . . . . . . . . . . . . . 541
rmvdiskcopy . . . . . . . . . . . . . 543
rmvdiskaccess . . . . . . . . . . . . . 544
rmvdiskhostmap . . . . . . . . . . . . 545
shrinkvdisksize . . . . . . . . . . . . . 545
splitvdiskcopy . . . . . . . . . . . . . 548
Notices . . . . . . . . . . . . . . 665
Trademarks . . . . . . . . . . . . . . 667
viii SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Tables
1. IBM websites for help, services, and 41. lsenclosure output . . . . . . . . . . 265
information . . . . . . . . . . . . xii 42. lsenclosurebattery outputs . . . . . . . 267
2. SAN Volume Controller library. . . . . . xiii 43. lscontrolenclosurecandidate attribute values 269
3. Other IBM publications . . . . . . . . xiv 44. lsenclosurecanister output . . . . . . . 270
4. IBM documentation and related websites xiv 45. lsenclosurechassis outputs . . . . . . . 272
5. Syntax diagrams . . . . . . . . . . . xv 46. lsenclosurepsu output. . . . . . . . . 274
6. Abbreviations . . . . . . . . . . . xvii 47. lsenclosureslot output . . . . . . . . . 275
7. Data types . . . . . . . . . . . . xix 48. lsenclosurestats outputs . . . . . . . . 278
8. Valid filter attributes . . . . . . . . . xxv 49. Stat_name field values . . . . . . . . 280
9. Maximum volume capacity by extent size 22 50. lssasfabric output . . . . . . . . . . 280
10. Memory required for Volume Mirroring and 51. lslicense output . . . . . . . . . . . 288
Copy Services . . . . . . . . . . . . 25 52. Relationship between the rate, data rate and
11. RAID level comparisons . . . . . . . . 25 grains per second values . . . . . . . . 293
12. Volume copy resynchronization rates . . . . 27 53. Relationship between the rate, data rate and
13. charraymember combination options . . . . 87 grains per second values . . . . . . . . 303
14. MDisk output . . . . . . . . . . . . 89 54. lshost output. . . . . . . . . . . . 323
15. lsarrayinitprogress output . . . . . . . . 93 | 55. lssite attribute values . . . . . . . . . 332
16. lsarraylba output. . . . . . . . . . . 94 56. lslivedump outputs . . . . . . . . . 336
17. lsarraymember output . . . . . . . . . 95 57. Number of extents reserved by extent size 341
18. lsarraymembergoals output . . . . . . . 98 58. MDisk output . . . . . . . . . . . 346
19. lsarraymemberprogress output . . . . . . 100 59. lsmdisklba command output . . . . . . 350
20. lsarraysyncprogress output . . . . . . . 102 | 60. lsquorum output . . . . . . . . . . 355
21. IP address list formats . . . . . . . . 128 61. lspartnership attribute values . . . . . . 377
22. Memory required for volume Mirroring and 62. lsrcconsistgrp command output values 381
Copy Services . . . . . . . . . . . 130 63. lsrcrelationship command attributes and
23. RAID level comparisons . . . . . . . . 131 values . . . . . . . . . . . . . . 384
24. lsfcportcandidate output . . . . . . . . 144 64. stoprcconsistgrp consistency group states 400
25. lssasportcandidate output . . . . . . . 145 65. stoprcrelationship consistency group states 402
26. lsnode or lsnodecanister attribute values 150 66. lshardware attribute values . . . . . . . 415
27. lsnodecandidate outputs . . . . . . . . 154 67. lsservicenodes outputs . . . . . . . . 417
28. Attribute values for lsnodehw and 68. lsservicestatus output . . . . . . . . . 419
lsnodecanisterhw . . . . . . . . . . 155 69. lsservicestatus output . . . . . . . . . 421
29. Attribute values for lsnodestats or 70. lsfeature outputs . . . . . . . . . . 441
lsnodecanister . . . . . . . . . . . 157 71. lsldap attribute values . . . . . . . . 468
30. Stat_name field values . . . . . . . . 162 72. lsldapserver attribute values . . . . . . 469
31. lsportip output . . . . . . . . . . . 174 73. testldapserver attribute values . . . . . . 480
32. lsportfc output . . . . . . . . . . . 177 74. Storage pool Easy Tier settings . . . . . . 485
33. lsportsas output. . . . . . . . . . . 179 75. Relationship between the rate value and the
34. lssystem output . . . . . . . . . . . 183 data copied per second . . . . . . . . 487
35. lssystemstats attribute values . . . . . . 190 76. Relationship between the rate value and the
36. Stat_name field values . . . . . . . . 191 data copied per second . . . . . . . . 491
37. lseventlog output . . . . . . . . . . 212 77. lsvdisklba command output scenarios 521
38. lscontroller output . . . . . . . . . . 224 78. Relationship between the rate value and the
39. lsdrive output . . . . . . . . . . . 232 data copied per second . . . . . . . . 532
40. lsdrivelba output . . . . . . . . . . 234
Before you use the SAN Volume Controller, you should have an understanding of storage area networks
(SANs), the storage requirements of your enterprise, and the capabilities of your storage units.
Accessibility
IBM strives to provide products with usable access for everyone, regardless of age or ability.
For more information, see the accessibility features topic in the Reference section.
New information
The following new commands have been added for this edition:
v chsite
v lsdriveupgradeprogress
v lssite
v lssystemsoftwareupgrade
v mkfcpartnership
v mkippartnership
v overridequorum
Changed information
Emphasis
Different typefaces are used in this guide to show emphasis.
The IBM System Storage SAN Volume Controller Information Center contains all of the information that
is required to install, configure, and manage the SAN Volume Controller. The information center is
updated between SAN Volume Controller product releases to provide the most current documentation.
The information center is available at the following website:
publib.boulder.ibm.com/infocenter/svc/ic/index.jsp
Unless otherwise noted, the publications in the SAN Volume Controller library are available in Adobe
portable document format (PDF) from the following website:
www.ibm.com/e-business/linkweb/publications/servlet/pbi.wss
The following table lists websites where you can find help, services, and more information:
Table 1. IBM websites for help, services, and information
Website Address
Directory of worldwide contacts http://www.ibm.com/planetwide
xii SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 1. IBM websites for help, services, and information (continued)
Website Address
Support for SAN Volume Controller (2145) www.ibm.com/storage/support/
2145
Support for IBM System Storage and IBM TotalStorage products www.ibm.com/storage/support/
Each of the PDF publications in the Table 2 is also available in the information center by clicking the
number in the “Order number” column:
Table 2. SAN Volume Controller library
Title Description Order number
IBM System Storage SAN Volume This guide provides the instructions GC27-3923
Controller Model 2145-CG8 Hardware that the IBM service representative
Installation Guide uses to install the hardware for SAN
Volume Controller model 2145-CG8.
IBM System Storage SAN Volume This guide provides the instructions GC27-2283
Controller Hardware Maintenance Guide that the IBM service representative
uses to service the SAN Volume
Controller hardware, including the
removal and replacement of parts.
IBM System Storage SAN Volume This guide describes the features of GC27-2284
Controller Troubleshooting Guide each SAN Volume Controller model,
explains how to use the front panel,
and provides maintenance analysis
procedures to help you diagnose and
solve problems with the SAN Volume
Controller.
IBM System Storage SAN Volume This guide contains translated GA32-0844
Controller Safety Notices caution and danger statements. Each
caution and danger statement in the
SAN Volume Controller
documentation has a number that
you can use to locate the
corresponding statement in your
language in the IBM System Storage
SAN Volume Controller Safety Notices
document.
IBM System Storage SAN Volume This document introduces the major GA32-0843
Controller Read First Flyer components of the SAN Volume
Controller system and describes how
to get started installing the hardware
and software.
IBM Statement of Limited Warranty This multilingual document provides Part number: 4377322
(2145 and 2076) information about the IBM warranty
for machine types 2145 and 2076.
IBM License Agreement for Machine This multilingual guide contains the SC28-6872 (contains Z125-5468)
Code License Agreement for Machine Code
for the SAN Volume Controller
product.
Table 3 lists IBM publications that contain information related to the SAN Volume Controller.
Table 3. Other IBM publications
Title Description Order number
IBM System Storage Productivity This guide introduces the IBM System SC23-8824
Center Introduction and Planning Storage Productivity Center hardware and
Guide software.
Read This First: Installing the IBM This guide describes how to install the GI11-8938
System Storage Productivity Center IBM System Storage Productivity Center
hardware.
IBM System Storage Productivity This guide describes how to configure the SC27-2336
Center User's Guide IBM System Storage Productivity Center
software.
IBM System Storage Multipath This guide describes the IBM System GC52-1309
Subsystem Device Driver User's Guide Storage Multipath Subsystem Device
Driver for IBM System Storage products
and how to use it with the SAN Volume
Controller.
Table 4 lists websites that provide publications and other information about the SAN Volume Controller
or related products or technologies.
Table 4. IBM documentation and related websites
Website Address
IBM Storage Management Pack for Microsoft The IBM Storage Host Software Solutions Information Center
System Center Operations Manager (SCOM) describes how to install, configure, and use the IBM Storage
Management Pack for Microsoft System Center Operations Manager.
IBM Storage Management Console for VMware The IBM Storage Host Software Solutions Information Center
vCenter describes how to install, configure, and use the IBM Storage
Management Console for VMware vCenter, which enables SAN
Volume Controller and other IBM storage systems to be integrated
in VMware vCenter environments.
IBM Storage Device Driver for VMware VAAI IBM Storage Host Software Solutions Information Center describes
how to install, configure, and use the IBM Storage Device Driver for
VMware VAAI.
IBM Storage Management Console for VMware The IBM Storage Host Software Solutions Information Center
vCenter Site Recovery Manager (SRM) describes how to install, configure, and use the IBM Storage
Management Console for VMware vCenter Site Recovery Manager.
IBM Publications Center www.ibm.com/e-business/linkweb/publications/servlet/pbi.wss
®
IBM Redbooks publications www.redbooks.ibm.com/
To view a PDF file, you need Adobe Reader, which can be downloaded from the Adobe website:
www.adobe.com/support/downloads/main.html
xiv SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
How to order IBM publications
The IBM Publications Center is a worldwide central repository for IBM product publications and
marketing material.
The IBM Publications Center offers customized search functions to help you find the publications that
you need. Some publications are available for you to view or download at no charge. You can also order
publications. The publications center displays prices in your local currency. You can access the IBM
Publications Center through the following website:
www.ibm.com/e-business/linkweb/publications/servlet/pbi.wss
To submit any comments about this book or any other SAN Volume Controller documentation:
v Go to the feedback page on the website for the SAN Volume Controller Information Center at
publib.boulder.ibm.com/infocenter/svc/ic/index.jsp?topic=/com.ibm.storage.svc.console.doc/
feedback.htm. There you can use the feedback page to enter and submit comments or browse to the
topic and use the feedback link in the running footer of that page to identify the topic for which you
have a comment.
v Send your comments by email to starpubs@us.ibm.com. Include the following information for this
publication or use suitable replacements for the publication title and form number for the publication
on which you are commenting:
– Publication title: IBM System Storage SAN Volume Controller and IBM Storwize V7000 Command-Line
Interface User's Guide
– Publication form number: GC27-2287-01
– Page, table, or illustration numbers that you are commenting on
– A detailed description of any information that should be changed
Syntax diagrams
A syntax diagram uses symbols to represent the elements of a command and to specify the rules for
using these elements.
Table 5 explains how to read the syntax diagrams that represent the command-line interface (CLI)
commands. In doing so, it defines the symbols that represent the CLI command elements.
Table 5. Syntax diagrams
Element Syntax Description
Main path line >>><>() () () >>Begins on the left with double
arrowheads ()>< and ends on the
right with two arrowheads facing
each other (). If a diagram is longer
than one line, each line to be
continued ends with a single>
arrowhead () and the next line
begins with a single arrowhead.
Read the diagrams from
left–to–right, top–to–bottom,
following the main path line.
ProfileName "
xvi SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 5. Syntax diagrams (continued)
Element Syntax Description
Syntax fragment Breaks up syntax diagrams that are
Fragment Name too long, too complex, or repetitious.
The fragment name is inserted in the
Fragment name: main diagram, and the actual
fragment is shown below the main
( fragment details ) diagram.
Terminology
These are abbreviations that are most commonly used for the command-line interface operations.
Note: When creating a new object, the clustered system (system) assigns a default -type name if one is
not specified. The default -type name consists of the object prefix and the lowest available integer starting
from 0 (except for nodes starting from 1); for example, vdisk23; the default -type name must be unique.
Table 7 on page xix lists the data types and the value ranges for each.
xviii SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 7. Data types
Data types Value ranges
filename_arg This is a (optionally fully qualified) file name, containing a maximum of 169
characters. Valid characters are:
v . (period; the field must not start with, end with, or contain two consecutive
periods)
v / (forward slash)
v - (hyphen)
v _ (underscore)
v a–z (lowercase letters, A through Z)
v A–Z (uppercase letters, A through Z)
v 0–9 (numerals 0 through 9)
directory_or_file_filter Specifies a directory, file name filter, or both, within the specified directory. Valid
directory values are:
v /dumps
v /dumps/audit
v /dumps/configs
v /dumps/elogs
v /dumps/feature
v /dumps/iostats
v /dumps/iotrace
v /dumps/software
The file name filter can be any valid file name, containing a maximum of 128
characters, with or without the “*” (wildcard), and appended to the end of a
directory value. Valid characters are:
v * (asterisk/wildcard)
v . (the field must not start with, end with, or contain two consecutive periods)
v /
v -
v _
v a–z
v A–Z
v 0–9
filename_prefix The prefix of a file name, containing a maximum of 128 characters. Valid characters
are:
v -
v _
v a–z
v A–Z
v 0–9
The first character of a name_arg must be nonnumeric. The first character of an object
name cannot be a–(dash) because the CLI (command-line interface) interprets it as
being the next parameter.
The standard defines a way to extend the serial number using letters in the place of
numbers in the 5-digit field.
ip_address_arg The argument follows the standard rules for dotted decimal notation.
The following Internet Protocol 4 (IPv4) and Internet Protocol 6 (IPv6) address
formats are supported:
IPv4 (no port set, SAN Volume Controller uses default)
1.2.3.4
IPv4 with specific port
1.2.3.4:22
Full IPv6, default port
1234:1234:0001:0123:1234:1234:1234:1234
Full IPv6, default port, leading zeros suppressed
1234:1234:1:123:1234:1234:1234:1234
Full IPv6 with port
[2002:914:fc12:848:209:6bff:fe8c:4ff6]:23
Zero-compressed IPv6, default port
2002::4ff6
Zero-compressed IPv6 with port
[2002::4ff6]:23
xx SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 7. Data types (continued)
Data types Value ranges
dns_name This is the dotted domain name for the system subnet (for example, ibm.com).
hostname The host name assigned to the system. This name can be different from the system
name, and is modifiable.
A combination of the host name and the dns_name is used to access the system, for
example: https://hostname.ibm.com/
capacity_value The capacity expressed within a range of 512 bytes to 2 petabytes (PB).
Tip: Specify the capacity as megabytes (MB), kilobytes (KB), gigabytes (GB), or PB.
When using MB, specify the value in multiples of 512 bytes. A capacity of 0 is valid
for a striped or sequential volume. The smallest number of supported bytes is 512.
node_id A node ID differs from other IDs in that it is a unique ID assigned when a node is
used to create a system, or when a node is added to a system. A node_id value is
never reused in a system.
Node IDs are internally represented as 64-bit numbers, and like other IDs, cannot be
modified by user commands.
xxx_id All objects are referred to by unique integer IDs, assigned by the system when the
objects are created. All IDs are represented internally as 32-bit integers; node IDs are
an exception.
The file name filter can be any valid file name, containing a maximum of 128
characters, with or without the wildcard (*, an asterisk), and appended to the end of
a directory value. Valid characters are:
v *
v . (the field must not start with, end with, or contain two consecutive periods)
v /
v -
v _
v a–z
v A–Z
v 0–9
locale_arg The system locale setting. Valid values are:
v 0 en_US: US English (default)
v 1 zh_CN: Simplified Chinese
v 2 zh_TW: Traditional Chinese
v 3 ja_JP: Japanese
v 4 fr_FR: French
v 5 de_DE: German
v 6 it_IT: Italian
v 7 es_ES: Spanish
key_arg A user-defined identifier for a secure shell (SSH) key, containing a maximum of 30
characters.
user_arg Specifies the user: admin or service.
copy_rate A numeric value of 0–100.
copy_type Specifies the Mirror copy type: Metro or Global.
xxii SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The maximum number of values entered into a colon-separated list is 128; exceeding this maximum
number returns an error.
The SAN Volume Controller command-line interface offers command line completion for command entry.
Command line completion allows you to type in the first few characters of a command and press the Tab
key to fill in the rest of the command name. If there are multiple commands that start with the same
characters, then a list of possible commands is returned. You can type in more characters until the
command name is unambiguous.
CLI parameters can be entered in any order except in the following situations:
v When a command name is specified, the first argument given must be the action that you want to be
performed.
v Where you are performing an action against a specific object, the object ID or name must be the last
argument in the line.
CLI flags
The following flags are common to all command-line interface (CLI) commands.
-? or -h
Print help text. For example, issuing lssystem -h provides a list of the actions available with the
lssystem command.
mkmdiskgrp -ext 16
it displays:
This parameter can be entered for any command, but is only acted upon by those commands that
generate the successfully created outputs. All other commands ignore this parameter.
CLI messages
Ensure that you are familiar with the command-line interface (CLI) messages.
When some commands complete successfully, textual output is normally provided. However, some
commands do not provide any output. The phrase No feedback is used to indicate that no output is
provided. If the command does not complete successfully, an error is generated. For example, if the
command has failed as a result of the cluster being unstable, the following output is provided:
v CMMVC5786E The action failed because the cluster is not in a stable state.
The -filtervalue parameter must be specified with attrib=value. The -filtervalue? and -filtervalue
parameters cannot be specified together.
Note: The qualifier characters left bracket (<) and right bracket (>) must be enclosed within double
quotation marks (""). For example, -filtervalue vdisk_count "<"4 or port_count ">"1. It is also valid
to include the entire expression within double quotation marks. For example,-filtervalue
"vdisk_count<4"
When an attribute requires the -unit parameter, it is specified after the attribute. For example,
-filtervalue capacity=24 -unit mb. The following input options are valid for the -unit parameter:
v b (bytes)
v mb (Megabytes)
v gb (Gigabytes)
v tb (Terabytes)
v pb (Petabytes)
xxiv SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Capacity values displayed in units other than bytes might be rounded. When filtering on capacity, use a
unit of bytes, -unit b, for exact filtering.
Table 8 provides a list of valid filter attributes, as well as descriptions, qualifiers and wildcards for each
object type.
You can use the asterisk (*) character as a wildcard character when names are used. The asterisk
character can be used either at the beginning or the end of a text string, but not both. Only one asterisk
character can be used in a -filtervalue parameter.
Table 8. Valid filter attributes
Object Attribute Valid Qualifiers Wildcard Description
Valid
cluster cluster_name or name = Yes The clustered system (system) name.
cluster_unique_id or id =, <, <=, >, >= No The system ID.
node node_name or name = Yes The node name.
id =, <, <=, >, >= No The node ID.
status = No The status of the node. The
following values are valid for node
status:
v adding
v deleting
v online
v offline
v pending
IO_group_name = Yes The I/O group name.
IO_group_ID =, <, <=, >, >= No The I/O group ID.
hardware = No The following values are valid for
hardware type: 8G4, CF8, CG8, and
8A4
io_grp HWS_name or name = Yes The I/O group name.
HWS_unique_id or id =, <, <=, >, >= No The I/O group ID.
node_count =, <, <=, >, >= No The number of nodes in the I/O
group.
host_count =, <, <=, >, >= No The number of hosts associated with
the io_grp.
controller controller_id or id =, <, <=, >, >= No The controller ID.
xxvi SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 8. Valid filter attributes (continued)
Object Attribute Valid Qualifiers Wildcard Description
Valid
mdiskgrp name = Yes The MDisk group name.
storage_pool_id or id =, <, <=, >, >= No The MDisk group ID.
mask_count =, <, <=, >, >= No The number of MDisks in the group.
vdisk_count =, <, <=, >, >= No The number of VDisks (volumes) in
the group.
status = No The status of the MDisk group. The
valid input options are online,
degraded_ports, degraded_paths,
excluded, and offline.
extent_size =, <, <=, >, >= No The extent size. (MB)
easy_tier = No Determines if Easy Tier is permitted
to manage the storage pool:
v on
v off
easy_tier_status = No Determines if automatic data
placement function on a storage pool
is activated:
v active
v inactive
vdisk vdisk_name or name = Yes The name of the volume.
vdisk_id or id =, <, <=, >, >= No The ID of the volume.
IO_group_name = Yes The name of the I/O group.
IO_group_id =, <, <=, >, >= No The ID of the I/O group.
status = No The status of the volume.
xxviii SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 8. Valid filter attributes (continued)
Object Attribute Valid Qualifiers Wildcard Description
Valid
fcmap FC_mapping_name or name = Yes The FlashCopy mapping name.
FC_id or id =, <, <=, >, >= No The FlashCopy mapping ID.
source_vdisk_name = Yes The source volume name.
source_vdisk_id =, <, <=, >, >= No The source volume ID.
target_vdisk_name = Yes The target volume name.
target_vdisk_id =, <, <=, >, >= No The target volume ID.
group_name = Yes The consistency group name.
group_id =, <, <=, >, >= No The consistency group ID.
status = No The mapping status.
xxx SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 8. Valid filter attributes (continued)
Object Attribute Valid Qualifiers Wildcard Description
Valid
rcconsistgrp group_id or id =, <, <=, >, >= No The consistency group ID.
name = Yes The consistency group name.
master_cluster_id =, <, <=, >, >= No The master system ID.
master_cluster_name = Yes The master system name.
aux_cluster_id =, <, <=, >, >= No The auxiliary system ID.
aux_cluster_name = Yes The auxiliary system name.
primary = No The consistency group primary. The
following values are valid for
primary:
v master
v aux
state = No The consistency group state. The
following values are valid for state:
v inconsistent_stopped
v inconsistent_copying
v consistent_stopped
v
v idling
v idling_disconnected
v inconsistent_disconnected
v consistent_disconnected
v empty
relationship_count =, <, <=, >, >= No The relationship count.
xxxii SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 1. Setting up an SSH client
Secure Shell (SSH) is a client-server network application. It is used as a communication vehicle between
the host system and the SAN Volume Controller command-line interface (CLI).
Overview
The SAN Volume Controller clustered system (system) acts as the SSH server in this relationship. The
SSH client provides a secure environment in which to connect to a remote machine. Authentication is
performed using SVC_username and password. If you require command-line access without entering a
password, it uses the principles of public and private keys for authentication.
Generate a Secure Shell (SSH) key pair to use the command-line interface (CLI). Additionally, when you
use the SSH to log in to the system, you must use the RSA-based private key authentication.
When you are using AIX® hosts, SSH logins are authenticated on the system using the RSA-based
authentication that is supported in the OpenSSH client that is available for AIX. This scheme is based on
the supplied password (or if you require command-line access without entering a password, then
public-key cryptography is used) by using an algorithm known commonly as RSA.
Note: The authentication process for host systems that are not AIX is similar.
With this scheme (as in similar OpenSSH systems on other host types), the encryption and decryption is
done using separate keys. This means that it is not possible to derive the decryption key from the
encryption key.
Because physical possession of the private key allows access to the system, the private key must be kept
in a protected place, such as the .ssh directory on the AIX host, with restricted access permissions.
When SSH client (A) attempts to connect to SSH server (B), the SSH password (if you require
command-line access without entering a password, the key pair) authenticates the connection. The key
consists of two halves: the public keys and private keys. The SSH client public key is put onto SSH
Server (B) using some means outside of the SSH session. When SSH client (A) tries to connect, the private
key on SSH client (A) is able to authenticate with its public half on SSH server (B).
To connect to the system, the SSH client requires a user login name and an SSH password (or if you
require command-line access without entering a password, the key pair). Authenticate to the system
using a SAN Volume Controller management user name and password. When using an SSH client to
access a system, you must use your SVC_username and password. The system uses the password (and if
not a password, the SSH key pair) to authorize the user accessing the system.
You can connect to the system using the same user name with which you log into the system.
For Microsoft Windows hosts, PuTTY can be downloaded from the Internet and used at no charge to
provide an SSH client.
You can connect to the system using the same user name with which you log into Storwize V7000.
Note: Before you install the PuTTY client program, ensure that your Windows system meets the system
requirements.
If you want to use an SSH client other than the PuTTY client, this website offers SSH client alternatives
for Windows:
www.openssh.org/windows.html
To connect to the system, the SSH client requires a user login name and an SSH password (or if you
require command-line access without entering a password, the key pair). Authenticate to the system
using a SAN Volume Controller management user name and password. When using an SSH client to
access a system, you must use your SVC_username and password. The system uses the password (and if
not a password, the SSH key pair) to authorize the user accessing the system.
You can connect to the system using the same user name with which you log into Storwize V7000.
Procedure
1. Start PuTTYgen by clicking Start > Programs > PuTTY > PuTTYgen. The PuTTY Key Generator
panel is displayed.
2. Click SSH-2 RSA as the type of key to generate.
2 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
b. Type icat.pub as the name of the public key and specify the location where you want to save the
public key. For example, you can create a directory on your computer called keys to store both the
public and private keys.
c. Click Save.
6. Save the private key by:
a. Click Save private key. The PuTTYgen Warning panel is displayed.
b. Click Yes to save the private key without a passphrase.
c. Type icat as the name of the private key, and specify the location where you want to save the
private key. For example, you can create a directory on your computer called keys to store both the
public and private keys. It is recommended that you save your public and private keys in the
same location.
d. Click Save.
7. Close the PuTTY Key Generator window.
Attention: Do not run scripts that create child processes that run in the background and call SAN
Volume Controller commands. This can cause the system to lose access to data and cause data to be lost.
Perform the following steps to configure a PuTTY session for the CLI:
Procedure
1. Select Start > Programs > PuTTY > PuTTY. The PuTTY Configuration window opens.
2. Click Session in the Category navigation tree. The Basic options for your PuTTY session are
displayed.
3. Click SSH as the Protocol option.
4. Click Only on clean exit as the Close window on exit option. This ensures that connection errors are
displayed.
5. Click Connection > SSH in the Category navigation tree. The options controlling SSH connections
are displayed.
6. Click 2 as the Preferred SSH protocol version.
7. Click Connection > SSH > Auth in the Category navigation tree. The Options controller SSH
authentication are displayed.
8. Click Browse or type the fully qualified file name and location of the SSH client and password. If no
password is used, the private key in the Private key file for authentication field.
9. Click Connection > Data in the Category navigation tree.
10. Type the user name that you want to use on the SAN Volume Controller in the Auto-login
username field.
11. Click Session in the Category navigation tree. The Basic options for your PuTTY session are
displayed.
12. In the Host Name (or IP Address) field, type the name or Internet Protocol (IP) address of one of the
SAN Volume Controller clustered system (system) IP addresses or host names.
13. Type 22 in the Port field. The SAN Volume Controller system uses the standard SSH port.
14. Type the name that you want to use to associate with this session in the Saved Sessions field. For
example, you can name the session SAN Volume Controller System 1.
Results
Note: If you configured more than one IP address for the SAN Volume Controller system, repeat the
previous steps to create another saved session for the second IP address. This can then be used if the first
IP address is unavailable.
Note: Windows users can download PuTTY from the following website: Download Putty.
The Secure Shell (SSH) protocol specifies that the first access to a new host server sends a challenge to
the SSH user to accept the SSH server public key or user password. Because this is the first time that you
connect to an SSH server, the server is not included in the SSH client list of known hosts. Therefore, there
is a fingerprint challenge, which asks if you accept the responsibility of connecting with this host. If you
type y, the host fingerprint and IP address are saved by the SSH client.
When you use PuTTY, you must also type y to accept this host fingerprint. However, the host fingerprint
and IP address are stored in the registry for the user name that is logged onto Windows.
The SSH protocol also specifies that once the SSH server public key is accepted, another challenge is
presented if the fingerprint of an SSH server changes from the one previously accepted. In this case, you
must decide if you want to accept this changed host fingerprint.
Note: The SSH server keys on the SAN Volume Controller are regenerated when a microcode load is
performed on the clustered system. As a result, a challenge is sent because the fingerprint of the SSH
server has changed.
All command-line interface (CLI) commands are run in an SSH session. You can run the commands in
one of the following modes:
v An interactive prompt mode
v A single line command mode, which is entered one time to include all parameters
Interactive mode
For interactive mode, you can use the PuTTY executable to open the SSH restricted shell.
The following is an example of the command that you can issue to start interactive mode:
C:\support utils\putty <username>@svcconsoleip
where support utils\putty is the location of your putty.exe file, <username> is the IP address of your
management GUI, and <username> is the user name that you want to use.
If you were to issue the lsuser command, which lists the SSH client public keys that are stored on the
SAN Volume Controller clustered system, the following output is displayed when ssh_key=yes:
IBM_2145:cluster0:superuser>lsuser
id name password ssh_key remote usergrp_id usergrp_name
0 superuser yes yes no 0 SecurityAdmin
1 smith no yes no 4 Monitor
2 jones no yes no 2 CopyOperator
4 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
You can type exit and press Enter to escape the interactive mode command.
The following is an example of the host fingerprint challenge when using plink in interactive mode:
C:\Program Files\IBM\svcconsole\cimom>plink superuser@9.43.225.208
The server’s host key is not cached in the registry. You
have no guarantee that the server is the computer you
think it is.
The server’s key fingerprint is:
ssh-rsa 1024 e4:c9:51:50:61:63:e9:cd:73:2a:60:6b:f0:be:25:bf
If you trust this host, enter "y" to add the key to
PuTTY’s cache and carry on connecting.
If you want to carry on connecting just once, without
adding the key to the cache, enter "n".
If you do not trust this host, press Return to abandon the
connection.
Store key in cache? (y/n) y
Using user name "superuser".
Authenticating with public key "imported-openssh-key"
IBM_2145:your_cluster_name:superuser>
For single line command mode, you can type the following all on one command line:
C:\Program Files\IBM\svcconsole\cimom>
plink superuser@9.43.225.208 lsuser
Authenticating with public key "imported-openssh-key"
id name password ssh_key remote usergrp_id usergrp_name
0 superuser yes yes no 0 SecurityAdmin
1 smith no yes no 4 Monitor
2 jones no yes no 2 CopyOperator
Note: If you are submitting a CLI command with all parameters in single line command mode, you are
challenged upon first appearance of the SSH server host fingerprint. Ensure that the SSH server host
fingerprint is accepted before you submit a batch script file.
The following is an example of the host fingerprint challenge when using plink in single line command
mode:
C:\Program Files\IBM\svcconsole\cimom>
plink superuser@9.43.225.208 lsuser
The server’s host key is not cached in the registry. You
have no guarantee that the server is the computer you
think it is.
The server’s key fingerprint is:
ssh-rsa 1024 e4:c9:51:50:61:63:e9:cd:73:2a:60:6b:f0:be:25:bf
If you trust this host, enter "y" to add the key to
PuTTY’s cache and carry on connecting.
If you want to carry on connecting just once, without
adding the key to the cache, enter "n".
If you do not trust this host, press Return to abandon the
connection.
Store key in cache? (y/n) y
Authenticating with public key "imported-openssh-key"
id name password ssh_key remote usergrp_id usergrp_name
0 superuser yes yes no 0 SecurityAdmin
1 smith no yes no 4 Monitor
2 jones no yes no 2 CopyOperator
This task assumes that you have already configured and saved a PuTTY session using the Secure Shell
(SSH) password. If you require command line access without entering a password, use the SSH key pair
that you created for the CLI: “Generating an SSH key pair using PuTTY” on page 2
Procedure
1. Select Start > Programs > PuTTY > PuTTY. The PuTTY Configuration window opens.
2. Select the name of your saved PuTTY session and click Load.
3. Click Open.
Note: If this is the first time that the PuTTY application is being used since you generated and
uploaded the SSH password or key pair, a PuTTY Security Alert window is displayed. Click Yes to
accept the change and trust the new key.
4. Type the SVC_username in the login as field and press Enter.
oss.software.ibm.com/developerworks/projects/openssh
Linux operating systems
The OpenSSH client is installed by default on most Linux distributions. If it is not installed on
your system, consult your Linux installation documentation or visit the following website:
www.openssh.org/portable.html
The OpenSSH client can run on a variety of additional operating systems. For more information
about the openSSH client, visit the following website:
www.openssh.org/portable.html
Authentication to the system generally requires the use of a password, but if there is no password you
can use a key pair. Use these steps to set up an RSA key pair on the AIX or Linux host and the clustered
system:
6 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Results
Where my_system is the name of the system IP,SVC_username is the user name that you also log into the
system with, and full_path_to_key is the full path to the key file that was generated in the previous step.
Authenticate to the system using a SVC_username and password. (If you require command-line access
without using a password, SSH keys can be used.) The system determines which user is logging in from
the key the user is using.
Note: You can omit -i full_path_to_key if you configure the SSH client to use the key file automatically.
If you use the Secure Shell (SSH) to log into the system, use the password defined for accessing the GUI.
You can also use RSA-based private key authentication.
Set up an RSA key pair on the AIX or Linux host and the clustered system:
Procedure
1. Create an RSA key pair by issuing a command on the host that is similar to this command:
ssh-keygen -t rsa
Where my_system is the name of the system IP, full_path_to_key is the full path to the key file that was
generated in the previous step, and SVC_username is the user name that you want to use on SAN Volume
Controller.
Note: You can omit -i full_path_to_key if you configure the SSH client to use the key file automatically.
For more SSH information, refer to the OpenSSH documentation.
You can create two categories of users that access the system. These types are based on how the users are
authenticated to the system. Local users must provide the SVC_username and password, and if you
require command line access without entering a password, a Secure Shell (SSH) key - or both. Local users
are authenticated through the authentication methods that are located on the SAN Volume Controller
system.
If the local user needs access to management GUI, a password is needed for the user. Access to the
command-line interface (CLI) is also possible with the same password or (alternatively) a valid SSH key
can be used. An SSH password is required if a user is working with both interfaces. User groups define
roles that authorize the users within that group to a specific set of operations on the system.
Local users must be part of a user group that is defined on the system.
A remote user is authenticated on a remote service usually provided by a SAN management application,
such as IBM Tivoli® Storage Productivity Center, and does not need local authentication methods. For a
remote user, a password (preferred) is required, and if you require command line access without entering
a password an SSH key is required to use the command-line interface.
Remote users only need local credentials to access the management GUI if the remote service is down.
The user groups a remote user is a member of are defined by the remote authentication service. To define
a remote user, create an user group on the local machine that is also defined on the remote authentication
service.
You can connect to the system using the same user name with which you log into Storwize V7000.
Procedure
1. Select Access > Users .
2. Select the appropriate user group.
3. Click Create User .
4. Enter the information on the new user and click Create.
8 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 2. Copying the SAN Volume Controller software
upgrade files using PuTTY scp
PuTTY scp (pscp) provides a file transfer application for secure shell (SSH) to copy files either between
two directories on the configuration node or between the configuration node and another host.
To use the pscp application, you must have the appropriate permissions on the source and destination
directories on your respective hosts.
The pscp application is available when you install an SSH client on your host system. You can access the
pscp application through a Microsoft Windows command prompt.
Procedure
1. Start a PuTTY session.
2. Configure your PuTTY session to access your SAN Volume Controller clustered system (system).
3. Save your PuTTY configuration session. For example, you can name your saved session SVCPUTTY.
4. Open a command prompt.
5. Issue this command to set the path environment variable to include the PuTTY directory:
set path=C:\Program Files\putty;%path%
where C:\Program Files\putty is the directory where PuTTY is installed.
6. Issue this command to copy the package onto the node where the CLI runs:
pscp -load saved_putty_configuration
directory_software_upgrade_files/software_upgrade_file_name
username@cluster_ip_address:/home/admin/upgrade
where saved_putty_configuration is the name of the PuTTY configuration session,
directory_software_upgrade_files is the location of the software upgrade files, software_upgrade_file_name
is the name of the software upgrade file, username is the name that you want to use on the SAN
Volume Controller, and cluster_ip_address is an IP address of your clustered system.
Note: Saving the PuTTY configuration session in step 3 and then loading the PuTTY configuration
session in step 6 is optional. To copy without loading a PuTTY configuration session, use the
following syntax:
pscp directory_software_upgrade_files/software_upgrade_file_name
username@cluster_ip_address:/home/admin/upgrade
If there is insufficient space to store the software upgrade file on the system, the copy process fails. In
this case, perform the following steps:
a. Use pscp to copy data that you want to preserve from the /home/admin/upgrade directory.
b. Use the following command to delete dump files in the /home/admin/upgrade directory:
# cleardumps -prefix /home/admin/upgrade
c. Repeat step 6.
Overview
The CLI commands use the Secure Shell (SSH) connection between the SSH client software on the host
system and the SSH server on the SAN Volume Controller system.
Before you can use the CLI, you must have already created a system.
Note: After the first SSH public key is stored, you can add additional SSH public keys using either the
management GUI or the CLI.
Procedure
1. Issue the showtimezone CLI command to display the current time-zone settings for the system. The
time zone and the associated time-zone ID are displayed.
This task assumes that you have already launched the management GUI.
You can set the System Date and time manually, or by specifying an NTP server:
Procedure
1. Click Manage Systems > Set System Time in the portfolio. The System Date and Time Settings panel
is displayed.
2. To use NTP to manage the clustered system date and time, enter an Internet Protocol Version 4 (IPv4)
address and click Set NTP Server.
Note: If you are using a remote authentication service to authenticate users to the SAN Volume
Controller clustered system, then both the system and the remote service should use the same NTP
server. Consistent time settings between the two systems ensure interactive performance of the
management GUI and correct assignments for user roles.
3. To set the clustered system date and time manually, continue with the following steps.
4. Type your changes into the Date, Month, Year, Hours and Minutes fields and select a new time zone
from the Time Zone list
5. Select Update cluster time and date, Update cluster time zone, or both.
6. Click Update to submit the update request to the clustered system.
SAN Volume Controller provides two license options: Physical Disk Licensing and Capacity Licensing. To
view and update your SAN Volume Controller license settings:
Procedure
1. Issue the lslicense CLI command to view the current license settings for the clustered system
(system).
12 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
2. Issue the chlicense CLI command to change the licensed settings of the system.
Attention:
v License settings are entered when the system is first created; do not update the settings unless you
have changed your license.
v To select Physical Disk Licensing, run the chlicense command with one or more of the
physical_disks, physical_flash, and physical_remote parameters.
v To select Capacity Licensing, run the chlicense command with one or more of the -flash, -remote,
and -virtualization parameters. If the physical disks value is nonzero, these parameters cannot be
set.
Procedure
The clustered system (system) superuser password can be reset using the front panel of the configuration
node. To meet varying security requirements, this functionality can be enabled or disabled using the CLI.
Complete the following steps to view and change the status of the password reset feature:
1. Issue the setpwdreset CLI command to view and change the status of the password reset feature for
the SAN Volume Controller front panel.
14 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
2. Record the system superuser password because you cannot access the system without it.
Storwize® V7000: The system superuser password can be reset using a USB key. To meet varying security
requirements, this functionality can be enabled or disabled using the CLI. Complete the following steps to
view and change the status of the password reset feature:
1. Issue the setpwdreset CLI command to view and change the status of the password reset feature for
the Storwize® V7000.
2. Record the system superuser password because you cannot access the system without it.
Before you add a node to a clustered system, you must make sure that the switchd\ zoning is configured
such that the node being added is in the same zone as all other nodes in the clustered system. If you are
replacing a node and the switch is zoned by worldwide port name (WWPN) rather than by switch port,
make sure that the switch is configured such that the node being added is in the same VSAN/zone.
Attention:
1. If you are re-adding a node to the SAN, ensure that you are adding the node to the same I/O group
from which it was removed. Failure to do this can result in data corruption. You must use the
information that was recorded when the node was originally added to the clustered system. If you do
not have access to this information, call the IBM Support Center to add the node back into the
clustered system without corrupting the data.
2. The LUNs that are presented to the ports on the new node must be the same as the LUNs that are
presented to the nodes that currently exist in the clustered system. You must ensure that the LUNs are
the same before you add the new node to the clustered system.
3. LUN masking for each LUN must be identical on all nodes in a clustered system. You must ensure
that the LUN masking for each LUN is identical before you add the new node to the clustered
system.
4. You must ensure that the model type of the new node is supported by the SAN Volume Controller
software level that is currently installed on the clustered system. If the model type is not supported
by the SAN Volume Controller software level, upgrade the clustered system to a software level that
supports the model type of the new node. See the following website for the latest supported software
levels:
www.ibm.com/storage/support/2145
Applications on the host systems direct I/O operations to file systems or logical volumes that are
mapped by the operating system to virtual paths (vpaths), which are pseudo disk objects supported by
the Subsystem Device Driver (SDD). SDD maintains an association between a vpath and a SAN Volume
Controller volume. This association uses an identifier (UID) which is unique to the volume and is never
reused. The UID permits SDD to directly associate vpaths with volumes.
SDD operates within a protocol stack that contains disk and Fibre Channel device drivers that are used to
communicate with the SAN Volume Controller using the SCSI protocol over Fibre Channel as defined by
If an error occurs, the error recovery procedures (ERPs) operate at various tiers in the protocol stack.
Some of these ERPs cause I/O to be redriven using the same WWNN and LUN numbers that were
previously used.
SDD does not check the association of the volume with the vpath on every I/O operation that it
performs.
Before you add a node to the clustered system, you must check to see if any of the following conditions
are true:
v The clustered system has more than one I/O group.
v The node being added to the clustered system uses physical node hardware or a slot which has
previously been used for a node in the clustered system.
v The node being added to the clustered system uses physical node hardware or a slot which has
previously been used for a node in another clustered system and both clustered systems have visibility
to the same hosts and back-end storage.
If any of the previous conditions are true, the following special procedures apply:
v The node must be added to the same I/O group that it was previously in. You can use the
command-line interface (CLI) command lsnode or the management GUI to determine the WWN of the
clustered system nodes.
v Before you add the node back into the clustered system, you must shut down all of the hosts using the
clustered system. The node must then be added before the hosts are rebooted. If the I/O group
information is unavailable or it is inconvenient to shut down and reboot all of the hosts using the
clustered system, then do the following:
– On all of the hosts connected to the clustered system, unconfigure the Fibre Channel adapter device
driver, the disk device driver, and multipathing driver before you add the node to the clustered
system.
– Add the node to the clustered system, and then reconfigure the Fibre Channel adapter device driver,
the disk device driver, and multipathing driver.
The following two scenarios describe situations where the special procedures can apply:
v Four nodes of an eight-node clustered system have been lost because of the failure of a pair of 2145
UPS or four 2145 UPS-1U. In this case, the four nodes must be added back into the clustered system
using the CLI command addnode or the management GUI.
Note: You do not need to run the addnode command on a node with a partner that is already in a
clustered system; the clustered system automatically detects an online candidate.
Note: The addnode command is a SAN Volume Controller command. For Storwize V7000, use the
addcontrolenclosure command.
v A user decides to delete four nodes from the clustered system and add them back into the clustered
system using the CLI command addnode or the management GUI.
Note: The addnode command is a SAN Volume Controller command. For Storwize V7000, use the
addcontrolenclosure command.
For 5.1.0 nodes, the SAN Volume Controller automatically re-adds nodes that have failed back to the
clustered system. If the clustered system reports an error for a node missing (error code 1195) and that
16 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
node has been repaired and restarted, the clustered system automatically re-adds the node back into the
clustered system. This process can take up to 20 minutes, so you can manually re-add the node by
completing the following steps:
Procedure
1. Issue the lsnode CLI command to list the nodes that are currently part of the clustered system and
determine the I/O group for which to add the node.
The following is an example of the output that is displayed:
lsnode -delim :
id:name:UPS_serial_number:WWNN:status:IO_group_id:IO_group_name
:config_node:UPS_unique_id:hardware:iscsi_name:iscsi_alias
:panel_name:enclosure_id:canister_id:enclosure_serial_number
1:node1::50050868010050B2:online:0:io_grp0:yes::100:iqn.1986-03.com.ibm
:2145.cluster0.node1::02-1:2:1:123ABCG
2:node2::50050869010050B2:online:0:io_grp0:no::100:iqn.1986-03.com.ibm
:2145.cluster0.node2::02-2:2:2:123ABDG
id:name:UPS_serial_number:WWNN:status:IO_group_id:IO_group_name
:config_node:UPS_unique_id:hardware:iscsi_name:iscsi_alias
:panel_name:enclosure_id:canister_id:enclosure_serial_number
1:node1::50050868010050B2:online:0:io_grp0:yes::100:iqn.1986-03.com.ibm
:2145.cluster0.node1::02-1:2:1:123ABCG
2:node2::50050869010050B2:online:0:io_grp0:no::100:iqn.1986-03.com.ibm
:2145.cluster0.node2::02-2:2:2:123ABDG
2. Issue the lsnodecandidate CLI command to list nodes that are not assigned to a clustered system and
to verify that a second node is added to an I/O group.
Note: The lsnodecandidate command is a SAN Volume Controller command. For Storwize V7000,
use the lscontrolenclosurecandidate command.
The following is an example of the output that is displayed:
lsnodecandidate -delim :
id:panel_name:UPS_serial_number:UPS_unique_id:hardware
5005076801000001:000341:10L3ASH:202378101C0D18D8:8A4
5005076801000009:000237:10L3ANF:202378101C0D1796:8A4
50050768010000F4:001245:10L3ANF:202378101C0D1796:8A4
....
3. Issue the addnode CLI command to add a node to the clustered system.
Note: The addnode command is a SAN Volume Controller command. For Storwize V7000, use the
addcontrolenclosure command.
Important: Each node in an I/O group must be attached to a different uninterruptible power supply.
The following is an example of the CLI command you can issue to add a node to the clustered system
using the panel name parameter:
addnode -panelname 000237
-iogrp io_grp0
Where 000237 is the panel name of the node, io_grp0 is the name of the I/O group that you are
adding the node to.
The following is an example of the CLI command you can issue to add a node to the clustered system
using the WWNN parameter:
id:name:UPS_serial_number:WWNN:status:IO_group_id:IO_group_name:config_node:UPS_unique_id:
hardware:iscsi_name:iscsi_alias
1:node1:10L3ASH:0000000000000000:offline:0:io_grp0:no:1000000000003206:
8A4:iqn.1986-03.com.ibm:2145.ndihill.node1:
Note: If this command is issued quickly after you have added nodes to the clustered system, the
status of the nodes might be adding. The status is shown as adding if the process of adding the nodes
to the clustered system is still in progress. You do not have to wait for the status of all the nodes to be
online before you continue with the configuration process.
Results
Procedure
1. Use the lsnode CLI command to display a concise list of nodes in the clustered system (system).
Issue this CLI command to list the nodes in the system:
lsnode -delim :
This is an example of the output that is displayed:
id:name:UPS_serial_number:WWNN:status:IO_group_id:IO_group_name:config_node:UPS_unique_id:hardware:iscsi_name:iscsi_alias:
panel_name:enclosure_id:canister_id:enclosure_serial_number
1:node1:UPS_Fake_SN:50050768010050B1:online:0:io_grp0:yes:10000000000050B1:8G4:iqn.1986-03.com.ibm:2145.cluster0.node1:000368:::
2. Issue the lsnode CLI command and specify the node ID or name of the node that you want to receive
detailed output.
The following is an example of the CLI command you can issue to list detailed output for a node in
the system:
lsnode -delim : group1node1
18 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Where group1node1 is the name of the node for which you want to view detailed output.
The following is an example of the output that is displayed:
id:1
name:group1node1
UPS_serial_number:10L3ASH
WWNN:500507680100002C
status:online
IO_group_id:0
IO_group_name:io_grp0
partner_node_id:2
partner_node_name:group1node2
config_node:yes
UPS_unique_id:202378101C0D18D8
port_id:500507680110002C
port_status:active
port_speed:2GB
port_id:500507680120002C
port_status:active
port_speed:2GB
port_id:500507680130002C
port_status:active
port_speed:2GB
port_id:500507680140003C
port_status:active
port_speed:2GB
hardware:8A4
iscsi_name:iqn.1986-03.com.ibm:2145.ndihill.node2
iscsi_alias
failover_active:no
failover_name:node1
failover_iscsi_name:iqn.1986-03.com.ibm:2145.ndihill.node1
failover_iscsi_alias
The clustered system (system) automatically discovers the back-end controller and integrates the
controller to determine the storage that is presented to the SAN Volume Controller nodes when back-end
controllers are:
v Added to the Fibre Channel
v Included in the same switch zone as a SAN Volume Controller system
The Small Computer System Interface (SCSI) logical units (LUs) that are presented by the back-end
controller are displayed as unmanaged MDisks. However, if the configuration of the back-end controller
is modified after this has occurred, the SAN Volume Controller system might be unaware of these
configuration changes. You can request that the SAN Volume Controller system rescans the Fibre Channel
SAN to update the list of unmanaged MDisks.
Note: The automatic discovery completed by SAN Volume Controller system does not write anything to
an unmanaged MDisk. You must instruct the SAN Volume Controller system to add an MDisk to a
storage pool or use an MDisk to create an image mode volume.
Procedure
1. Issue the detectmdisk CLI command to manually scan the Fibre Channel network. The scan discovers
any new MDisks that might have been added to the system and can help rebalance MDisk access
across the available controller device ports.
Results
You have now seen that the back-end controllers and switches have been set up correctly and that the
SAN Volume Controller system recognizes the storage that is presented by the back-end controller.
Example
This example describes a scenario where a single back-end controller is presenting eight SCSI LUs to the
SAN Volume Controller system:
1. Issue detectmdisk.
2. Issue lsmdiskcandidate.
This output is displayed:
id
0
1
2
3
4
5
6
7
Attention: If you add an MDisk to a storage pool as an MDisk, any data on the MDisk is lost. If you
want to keep the data on an MDisk (for example, because you want to import storage that was
previously not managed by SAN Volume Controller), you must create image mode volumes instead.
20 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Assume that the clustered system (system) has been set up and that a back-end controller has been
configured to present new storage to the SAN Volume Controller.
If you are using a SAN Volume Controller solid-state drive (SSD) managed disk, ensure that you are
familiar with the SSD configuration rules.
If you intend to keep the volume allocation within one storage system, ensure that all MDisks in the
storage pool are presented by the same storage system.
Ensure that all MDisks that are allocated to a single storage pool are of the same RAID type. If the
storage pool has more than one tier of storage, ensure that all MDisks in the same tier are of the same
RAID type. When using Easy Tier®, all of the MDisks in a storage pool in the same tier should be similar
and have similar performance characteristics. If you do not use Easy Tier, the storage pool should contain
only one tier of storage, and all of the MDisks in the storage pool should be similar and have similar
performance characteristics.
Consider the following factors as you decide how many (storage pools) to create:
v A volume can only be created using the storage from one storage pool. Therefore, if you create small
(storage pools), you might lose the benefits that are provided by virtualization, namely more efficient
management of free space and a more evenly distributed workload for better performance.
v If any MDisk in an storage pool goes offline, all the (volumes) in the storage pool go offline. Therefore
you might want to consider using different storage pools for different back-end controllers or for
different applications.
v If you anticipate regularly adding and removing back-end controllers or storage, this task is made
simpler by grouping all the MDisks that are presented by a back-end controller into one storage pool.
v All the MDisks in a storage pool should have similar levels of performance or reliability, or both. If a
storage pool contains MDisks with different levels of performance, the performance of the (volumes) in
this group is limited by the performance of the slowest MDisk. If a storage pool contains MDisks with
different levels of reliability, the reliability of the (volumes) in this group is that of the least reliable
MDisk in the group.
Note: When you create a storage pool with a new solid-state drive (SSD), the new SSD is automatically
formatted and set to a block size of 512 bytes.
Even with the best planning, circumstances can change and you must reconfigure your (storage pools)
after they have been created. The data migration facilities that are provided by the SAN Volume
Controller enable you to move data without disrupting I/O.
Consider the following factors as you decide the extent size of each new storage pool:
v You must specify the extent size when you create a new storage pool.
v You cannot change the extent size later; it must remain constant throughout the lifetime of the storage
pool.
v Storage pools can have different extent sizes; however, this places restrictions on the use of data
migration.
v The choice of extent size affects the maximum size of a volume in the storage pool.
Table 9 on page 22 compares the maximum volume capacity for each extent size. The maximum is
different for thin-provisioned volumes. Because the SAN Volume Controller allocates a whole number of
extents to each volume that is created, using a larger extent size might increase the amount of storage
Important: You can specify different extent sizes for different storage pools; however, you cannot migrate
(volumes) between storage pools with different extent sizes. If possible, create all your storage pools with
the same extent size.
Procedure
where maindiskgroup is the name of the storage pool that you want to create, 32 MB is the size of the
extent you want to use, and mdsk0, mdsk1, mdsk2, mdsk3 are the names of the four MDisks that you want
to add to the group.
Results
Example
The following example provides a scenario where you want to create a storage pool, but you do not have
any MDisks available to add to the group. You plan to add the MDisks at a later time. You use the
mkmdiskgrp CLI command to create the storage pool bkpmdiskgroup and later used the addmdisk CLI
command to add mdsk4, mdsk5, mdsk6, mdsk7 to the storage pool.
1. Issue mkmdiskgrp -name bkpmdiskgroup -ext 32
where bkpmdiskgroup is the name of the storage pool that you want to create and 32 MB is the size of
the extent that you want to use.
2. You find four MDisks that you want to add to the storage pool.
3. Issue addmdisk -mdisk mdsk4:mdsk5:mdsk6:mdsk7 bkpdiskgroup
22 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
where mdsk4, mdsk5, mdsk6, mdsk7 are the names of the MDisks that you want to add to the storage
pool and bkpdiskgroup is the name of the storage pool for which you want to add MDisks.
The MDisks must be in unmanaged mode. Disks that already belong to a storage pool cannot be added
to another storage pool until they have been deleted from their current storage pool. An MDisk can be
deleted from a storage pool under these circumstances:
v If the MDisk does not contain any extents in use by a virtual disk volume
v If you can first migrate the extents in use onto other free extents within the group
Important: Do not add an MDisk using this procedure if you are mapping the MDisk to an image mode
volume. Adding an MDisk to a storage pool enables the SAN Volume Controller to write new data to the
MDisk; therefore, any existing data on the MDisk is lost. If you want to create an image mode volume,
use the mkvdisk command instead of addmdisk.
If you are using a SAN Volume Controller solid-state drive (SSD) managed disk, ensure that you are
familiar with the SSD configuration rules.
The SAN Volume Controller performs tests on the MDisks in the list before the MDisks are allowed to
become part of a storage pool when:
v Adding MDisks to a storage pool using the addmdisk command
v Creating a storage pool using the mkmdiskgrp -mdisk command
These tests include checks of the MDisk identity, capacity, status and the ability to perform both read and
write operations. If these tests fail or exceed the time allowed, the MDisks are not added to the group.
However, with the mkmdiskgrp -mdisk command, the storage pool is still created even if the tests fail, but
it does not contain any MDisks. If tests fail, confirm that the MDisks are in the correct state and that they
have been correctly discovered.
Note: The first time that you add a new solid-state drive (SSD) to a storage pool, the SSD is
automatically formatted and set to a block size of 512 bytes.
2. Issue the addmdisk CLI command to add MDisks to the storage pool.
This is an example of the CLI command you can issue to add MDisks to a storage pool:
addmdisk -mdisk mdisk4:mdisk5:mdisk6:mdisk7 bkpmdiskgroup
Where mdisk4:mdisk5:mdisk6:mdisk7 are the names of the MDisks that you want to add to the storage
pool and bkpmdiskgroup is the name of the storage pool for which you want to add the MDisks.
Note: Quorum functionality is not supported for internal drives on SAN Volume Controller nodes.
To set an MDisk as a quorum disk, use the chquorum command. Storwize V7000: To set an external
MDisk as a quorum disk, use the chquorum command.
When setting an MDisk as a quorum disk, keep the following recommendations in mind:
v When possible, distribute the quorum candidate disks so that each MDisk is provided by a different
storage system. For a list of storage systems that support quorum disks, search for supported hardware
list at the following website:
www.ibm.com/storage/support/2145
v Before you set the quorum disk with the chquorum command, use the lsquorum command to ensure
that the MDisk you want is online.
Storwize V7000: Quorum disk configuration describes how quorum disks are used by the system, and how
they are selected. The system automatically assigns quorum disks. Do not override the quorum disk
assignment if you have a Storwize V7000 without external MDisks. For a Storwize V7000 with more than
one control enclosure and with external MDisks, distribute the quorum candidate disks (when possible)
so that each MDisk is provided by a different storage system. For a list of storage systems that support
quorum disks, search for supported hardware list at the following website:
www.ibm.com/storage/support/2145
24 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
About this task
Table 10 provides an example of the amount of memory that is required for Volume Mirroring and each
Copy Service feature.
Table 10. Memory required for Volume Mirroring and Copy Services
1 MB of memory provides the following volume
Feature Grain size capacity for the specified I/O group
Metro Mirror or Global Mirror 256 KB 2 TB of total Metro Mirror and Global Mirror volume
capacity
FlashCopy 256 KB 2 TB of total FlashCopy source volume capacity
FlashCopy 64 KB 512 GB of total FlashCopy source volume capacity
Incremental FlashCopy 256 KB 1 TB of total incremental FlashCopy source volume
capacity
Incremental FlashCopy 64 KB 256 GB of total incremental FlashCopy source volume
capacity
Volume Mirroring 256 KB 2 TB of mirrored volume capacity
Notes:
1. For multiple FlashCopy targets, you must consider the number of mappings. For example, for a mapping with a
grain size of 256 KB, 8 KB of memory allows one mapping between a 16 GB source volume and a 16 GB target
volume. Alternatively, for a mapping with a 256 KB grain size, 8 KB of memory allows two mappings between
one 8 GB source volume and two 8 GB target volumes.
2. When creating a FlashCopy mapping, if you specify an I/O group other than the I/O group of the source
volume, the memory accounting goes towards the specified I/O group, not towards the I/O group of the source
volume.
3. For Volume Mirroring, the full 512 MB of memory space provides 1 PB of total mirroring capacity.
4. In this table, capacity refers to the virtual capacity of the volume. For thin-provisioned volumes with different
virtual capacities and real capacities, the virtual capacity is used for memory accounting.
Table 11 provides an example of RAID level comparisons with their bitmap memory cost, where MS is
the size of the member drives and MC is the number of member drives.
Table 11. RAID level comparisons
Approximate bitmap memory
Level Member count Approximate capacity Redundancy cost
RAID-0 1-8 MC * MS None (1 MB per 2 TB of MS) * MC
RAID-1 2 MS 1 (1 MB per 2 TB of MS) *
(MC/2)
RAID-5 3-16 (MC-1) * MS 1 1 MB per 2 TB of MS with a
strip size of 256 KB; double
RAID-6 5-16 less than (MC-2 * MS) 2
with strip size of 128 KB.
RAID-10 2-16 (evens) MC/2 * MS 1 (1 MB per 2 TB of MS) *
(MC/2)
Note: There is a margin of error on the approximate bitmap memory cost of approximately 15%. For example, the
cost for a 256 KB RAID-5 is ~1.15 MB for the first 2 TB of MS.
To modify and verify the amount of memory that is available, perform the following steps:
If the volume that you are creating maps to a solid-state drive (SSD), the data that is stored on the
volume is not protected against SSD failures or node failures. To avoid data loss, add a volume copy that
maps to an SSD on another node.
This task assumes that the clustered system (system) has been set up and that you have created storage
pools. You can establish an empty storage pool to hold the MDisks that are used for image mode
volumes.
Note: If you want to keep the data on an MDisk, create image mode (volumes). This task describes how
to create a volume with striped virtualization.
Procedure
26 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
id:name:status:mdisk_count:vdisk_count:capacity:extent_size:free_capacity:virtual_capacity:
used_capacity:real_capacity:overallocation:warning:easy_tier:easy_tier_status
0:mdiskgrp0:degraded:4:0:34.2GB:16:34.2GB:0:0:0:0:0:auto:inactive
1:mdiskgrp1:online:4:6:200GB:16:100GB:400GB:75GB:100GB:200:80:on:active
2. Decide which storage pool you want to provide the storage for the volume.
3. Issue the lsiogrp CLI command to show the I/O groups and the number of volumes assigned to each
I/O group.
Note: It is normal for systems with more than one I/O group to have storage pools that have
volumes in different I/O groups. You can use FlashCopy to make copies of volumes regardless of
whether the source and target volume are in the same I/O group. If you plan to use intra-system
Metro Mirror or Global Mirror, both the master and auxiliary volume must be in the same I/O group.
The following is an example of the CLI command that you can issue to list I/O groups:
lsiogrp -delim :
The following is an example of the output that is displayed:
id:name:node_count:vdisk_count:host_count
0:io_grp0:2:0:2
1:io_grp1:2:0:1
2:io_grp2:0:0:0
3:io_grp3:0:0:0
4:recovery_io_grp:0:0:0
4. Decide which I/O group you want to assign the volume to. This determines which SAN Volume
Controller nodes in the system process the I/O requests from the host systems. If you have more than
one I/O group, make sure you distribute the volumes between the I/O groups so that the I/O
workload is shared evenly between all SAN Volume Controller nodes.
5. Issue the mkvdisk CLI command to create a volume.
The rate at which the volume copies will resynchronize after loss of synchronization can be specified
using the syncrate parameter. Table 12 defines the rates.
Table 12. Volume copy resynchronization rates
Syncrate value Data copied per second
1-10 128 KB
11-20 256 KB
21-30 512 KB
31-40 1 MB
41-50 2 MB
51-60 4 MB
61-70 8 MB
71-80 16 MB
81-90 32 MB
91-100 64 MB
The default setting is 50. The synchronization rate must be set such that the volume copies will
resynchronize quickly after loss of synchronization.
The following is an example of the CLI command that you can issue to create a volume with two
copies using the I/O group and storage pool name and specifying the synchronization rate:
mkvdisk -iogrp io_grp1 -mdiskgrp grpa:grpb -size500 -vtype striped
-copies 2 –syncrate 90
Note: If you want to create two volume copies of different types, create the first copy using the
mkvdisk command and then add the second copy using the addvdiskcopy command.
6. Issue the lsvdisk CLI command to list all the volumes that have been created.
The addvdiskcopy command adds a copy to an existing volume, which changes a nonmirrored volume
into a mirrored volume.
Creating mirrored copies of a volume allows the volume to remain accessible even when a managed disk
(MDisk) that the volume depends on becomes unavailable. You can create copies of a volume either from
different storage pools or by creating an image mode copy of the volume. Copies allow for availability of
data; however, they are not separate objects. You can only create or change mirrored copies from the
volume.
28 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
In addition, you can use volume mirroring as an alternative method of migrating volumes between
storage pools. For example, if you have a nonmirrored volume in one storage pool and want to migrate
that volume to a second storage pool, you can add a new copy of the volume by specifying the second
storage pool for that volume copy. After the copies have synchronized, you can delete the copy in the
first storage pool. The volume is migrated to the second storage pool while remaining online during the
migration.
For image copies, you must specify the virtualization type using the -vtype parameter and an MDisk that
is in unmanaged mode using the -mdisk parameter. This MDisk must be in the unmanaged mode. The
-vtype parameter is optional for sequential (seq) and striped volumes. The default virtualization type is
striped.
Use the syncrate parameter to specify the rate at which the volume copies will resynchronize after loss of
synchronization. The topic that describes creating volumes using the CLI describes this parameter.
where 0 is the name of the managed disk group and vdisk8 is the volume to which the copy will be
added.
The command returns the IDs of the newly created volume copies.
The rmvdiskcopy CLI command deletes the specified copy from the specified volume. The command fails
if all other copies of the volume are not synchronized; in this case, you must specify the -force
parameter, delete the volume, or wait until the copies are synchronized. You must specify the
vdisk_name|vdisk_id parameter last on the command line.
Important: Using the -force parameter might result in a loss of access. Use it only under the direction of
the IBM Support Center.
Issue the rmvdiskcopy CLI command to delete a mirrored copy from a volume:
rmvdiskcopy -copy 1 vdisk8
where 1 is the ID of the copy to delete and vdisk8 is the virtual disk to delete the copy from.
If you are configuring a host object on a Fibre Channel attached host, ensure that you have completed all
zone and switch configuration. Also test the configuration to ensure that zoning was created correctly.
If you are configuring a host object on the cluster that uses iSCSI connections, ensure that you have
completed the necessary host-system configurations and have configured the cluster for iSCSI
connections.
Procedure
1. Issue the mkhost CLI command to create a logical host object for a Fibre Channel attached host.
Assign your worldwide port name (WWPN) for the host bus adapters (HBAs) in the hosts.
This is an example of the CLI command that you can issue to create a Fibre Channel attached host:
mkhost -name new_name -fcwwpn wwpn_list
where new_name is the name of the host and wwpn_list is the WWPN of the HBA.
where iscsi_name_list specifies one or more iSCSI qualified names (IQNs) of this host. Up to 16 names can be
specified, provided that the command-line limit is not reached. Each name should comply with the iSCSI standard,
RFD 3720.
3. To add ports to a Fibre Channel attached host, issue the addhostport CLI command.
This command adds another HBA WWPN wwpn_list to the host that was created in step 1.
30 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
For example, issue the following CLI command:
addhostport -iscsiname iscsi_name_list new_name
where iscsi_name_list specifies the comma-separated list of IQNs to add to the host. This command adds an IQN to
the host that was created in step 2 on page 30.
5. To set the Challenge Handshake Authentication Protocol (CHAP) secret that is used to authenticate
the host for iSCSI I/O, issue the chhost CLI command. This secret is shared between the host and the
cluster. For example, issue the following CLI command:
chhost -chapsecret chap_secret
where chap_secret is the CHAP secret that is used to authenticate the host for iSCSI I/O. To list the
CHAP secret for each host, use the lsiscsiauth command. To clear any previously set CHAP secret
for a host, use the chhost -nochapsecret command.
What to do next
After you have created the host object on the cluster, you can map volumes to a host.
If you are unable to discover the disk on the host system or if there are fewer paths available for each
disk than expected, test the connectivity between your host system and the cluster. Depending on the
connection type to the host, these steps might be different. For iSCSI-attached hosts, test your
connectivity between the host and SAN Volume Controller ports by pinging SAN Volume Controller from
the host. Ensure that the firewall and router settings are configured correctly and validate that the values
for the subnet mask and gateway are specified correctly for the SAN Volume Controller host
configuration.
For Fibre Channel attached hosts, ensure that the active switch configuration includes the host zone and
check the host-port link status. To verify end-to-end connectivity, you can use the lsfabric CLI command
or the View Fabric panel under Service and Maintenance container in the management GUI.
Procedure
1. Issue the mkvdiskhostmap CLI command to create host mappings.
This example is a CLI command you can issue to create host mappings:
mkvdiskhostmap -host demohost1 mainvdisk1
Where demohost1 is the name of the host and mainvdisk1 is the name of the volume.
2. After you have mapped volumes to hosts, discover the disks on the host system. This step requires
that you access the host system and use the host-system utilities to discover the new disks that are
made available by the SAN Volume Controller. You also have the option of creating a file system for
those new disks. Consult your host-system documentation for more information on completing this
task.
A FlashCopy mapping specifies the source and target virtual disk, or VDisk (volume). Source volumes
and target volumes must meet these requirements:
v They must be the same size
v They must be managed by the same clustered system (system)
A volume can be the source in up to 256 mappings. A mapping is started at the point in time when the
copy is required.
Procedure
1. The source and target volume must be the exact same size. Issue the lsvdisk -bytes CLI command to
find the size (capacity) of the volume in bytes.
2. Issue the mkfcmap CLI command to create a FlashCopy mapping.
This CLI command example creates a FlashCopy mapping and sets the copy rate:
mkfcmap -source mainvdisk1 -target bkpvdisk1
-name main1copy -copyrate 75
| Where mainvdisk1 is the name of the source VDisk (volume), bkpvdisk1 is the name of the volume that
| you want to make the target volume, main1copy is the name that you want to call the FlashCopy
| mapping, and 75 is the copy rate (which translates to MB per second).
This is an example of the CLI command you can issue to create FlashCopy mappings without the
copy rate parameter:
mkfcmap -source mainvdisk2 -target bkpvdisk2
-name main2copy
Where mainvdisk2 is the name of the source volume , bkpvdisk2 is the name of the volume that you
want to make the target volume, main2copy is the name that you want to call the FlashCopy mapping.
| Note: The default copy rate of 50 (which translates to 2 MB per second) is used if you do not specify
| a copy rate.
If the specified source and target volumes are also the target and source volumes of an existing
mapping, the mapping that is being created and the existing mapping become partners. If one
mapping is created as incremental, its partner is automatically incremental. A mapping can have only
one partner.
3. Issue the lsfcmap CLI command to check the attributes of the FlashCopy mappings that have been
created:
This is an example of a CLI command that you can issue to view the attributes of the FlashCopy
mappings:
lsfcmap -delim :
Where -delim specifies the delimiter. This is an example of the output that is displayed:
id:name:source_vdisk_id:source_vdisk_name:target_vdisk_id:target_vdisk_name:
group_id:group_name:status:progress:copy_rate:clean_progress:incremental
0:main1copy:77:vdisk77:78:vdisk78:::idle_or_copied:0:75:100:off
1:main2copy:79:vdisk79:80:vdisk80:::idle_or_copied:0:50:100:off
32 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
About this task
Starting a FlashCopy mapping creates a point-in-time copy of the data on the source virtual disk (VDisk)
and writes it to the target VDisk (volume) for the mapping.
Procedure
1. Issue the prestartfcmap CLI command to prepare the FlashCopy mapping.
To run the following command, the FlashCopy mapping cannot belong to a consistency group.
prestartfcmap -restore main1copy
Where main1copy is the name of the FlashCopy mapping.
This command specifies the optional restore parameter, which forces the mapping to be prepared
even if the target VDisk is being used as a source in another active FlashCopy mapping.
The mapping enters the preparing state and moves to the prepared state when it is ready.
2. Issue the lsfcmap CLI command to check the state of the mapping.
The following is an example of the output that is displayed:
lsfcmap -delim :
id:name:source_vdisk_id:source_vdisk_name:target_vdisk_id:
target_vdisk_name:group_id:group_name:status:progress:copy_rate
0:main1copy:0:mainvdisk1:1:bkpvdisk1:::prepared:0:50
Results
You have created a point-in-time copy of the data on a source VDisk and written that data to a target
VDisk. The data on the target VDisk is only recognized by the hosts that are mapped to it.
Procedure
1. To stop a FlashCopy mapping, issue the following stopfcmap command:
stopfcmap fc_map_id or fc_map_name
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
The split parameter can be specified only when stopping a map that has a progress of 100 as shown
by the lsfcmap command. The split parameter removes the dependency of any other mappings on
the source volume. It might be used prior to starting another FlashCopy mapping whose target disk is
the source disk of the mapping being stopped. After the mapping is stopped with the split option,
you can start the other mapping without the restore option.
The rmfcmap CLI command deletes an existing mapping if the mapping is in the idle_or_copied or
stopped state. If it is in the stopped state, the force parameter is required to specify that the target VDisk
(volume) is brought online. If the mapping is in any other state, you must stop the mapping before you
can delete it.
If deleting the mapping splits the tree that contains the mapping, none of the mappings in either
resulting tree can depend on any mapping in the other tree. To display a list of dependent FlashCopy
mappings, use the lsfcmapdependentmaps command.
Procedure
1. To delete an existing mapping, issue the rmfcmap CLI command:
rmfcmap fc_map_id or fc_map_name
where fc_map_id or fc_map_name is the ID or name of the mapping to delete.
2. To delete an existing mapping and bring the target VDisk online, issue the following command:
rmfcmap -force fc_map_id or fc_map_name
where fc_map_id or fc_map_name is the ID or name of the mapping to delete.
Results
34 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
About this task
If you have created several FlashCopy mappings for a group of virtual disks (volumes) that contain
elements of data for the same application, it can be convenient to assign these mappings to a single
FlashCopy consistency group. You can then issue a single prepare or start command for the whole group.
For example, you can copy all of the files for a database at the same time.
Procedure
To add FlashCopy mappings to a new FlashCopy consistency group, complete the following steps.
1. Issue the mkfcconsistgrp CLI command to create a FlashCopy consistency group.
The following CLI command is an example of the command you can issue to create a FlashCopy
consistency group:
mkfcconsistgrp -name FCcgrp0 -autodelete
Where FCcgrp0 is the name of the FlashCopy consistency group. The -autodelete parameter specifies
to delete the consistency group when the last FlashCopy mapping is deleted or removed from the
consistency group.
2. Issue the lsfcconsistgrp CLI command to display the attributes of the group that you have created.
The following CLI command is an example of the command you can issue to display the attributes of
a FlashCopy consistency group:
lsfcconsistgrp -delim : FCcgrp0
The following output is an example of the output that is displayed:
id:1
name:FCcgrp0
status:idle_or_copied
autodelete:on
FC_mapping_id:0
FC_mapping_name:fcmap0
FC_mapping_id:1
FC_mapping_name:fcmap1
Note: For any group that has just been created, the status reported is empty
3. Issue the chfcmap CLI command to add FlashCopy mappings to the FlashCopy consistency group:
The following CLI commands are examples of the commands you can issue to add Flash Copy
mappings to the FlashCopy consistency group:
chfcmap -consistgrp FCcgrp0 main1copy
chfcmap -consistgrp FCcgrp0 main2copy
Where FCcgrp0 is the name of the FlashCopy consistency group and main1copy, main2copy are the
names of the FlashCopy mappings.
4. Issue the lsfcmap CLI command to display the new attributes of the FlashCopy mappings.
The following output is an example of the output that is displayed:
lsfcmap -delim :
id:name:source_vdisk_id:source_vdisk_name:target_vdisk_id:
target_vdisk_name:group_id:group_name:status:progress:copy_rate
0:main1copy:28:maindisk1:29:bkpdisk1:1:FCcgrp0:idle_copied::75
1:main2copy:30:maindisk2:31:bkpdisk2:1:FCcgrp0:idle_copied::50
5. Issue the lsfcconsistgrp CLI command to display the detailed attributes of the group.
The following CLI command is an example of the command that you can issue to display detailed
attributes:
lsfcconsistgrp -delim : FCcgrp0
Where FCcgrp0 is the name of the FlashCopy consistency group, and -delim specifies the delimiter.
Successful completion of the FlashCopy process creates a point-in-time copy of the data on the source
virtual disk (VDisk) and writes it to the target VDisk (volume) for each mapping in the group. When
several mappings are assigned to a FlashCopy consistency group, only a single prepare command is
issued to prepare every FlashCopy mapping in the group; only a single start command is issued to start
every FlashCopy mapping in the group.
Procedure
To prepare and start a FlashCopy consistency group, complete the following steps.
1. Issue the prestartfcconsistgrp CLI command to prepare the FlashCopy consistency group. This
command must be issued before the copy process can begin.
Remember: A single prepare command prepares all of the mappings simultaneously for the entire
group.
An example of the CLI command issued to prepare the FlashCopy consistency group:
prestartfcconsistgrp -restore maintobkpfcopy
Where maintobkpfcopy is the name of the FlashCopy consistency group.
The optional restore parameter forces the consistency group to be prepared—even if the target
volume is being used as a source volume in another active mapping. An active mapping is in the
copying, suspended, or stopping state. The group enters the preparing state, and then moves to the
prepared state when it is ready.
2. Issue the lsfcconsistgrp command to check the status of the FlashCopy consistency group.
An example of the CLI command issued to check the status of the FlashCopy consistency group.
lsfcconsistgrp -delim :
An example of the output displayed:
id:name:status
1:maintobkpfcopy:prepared
3. Issue the startfcconsistgrp CLI command to start the FlashCopy consistency group to make the copy.
Remember: A single start command starts all the mappings simultaneously for the entire group.
An example of the CLI command issued to start the FlashCopy consistency group mappings:
startfcconsistgrp -prep -restore maintobkpfcopy
Where maintobkpfcopy is the name of the FlashCopy consistency group.
Include the prep parameter, and the system automatically issues the prestartfcconsistgrp command
for the specified group.
36 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: Combining the restore parameter with the prep parameter, force-starts the consistency group.
This occurs even if the target volume is being used as a source volume in another active mapping. An
active mapping is in the copying, suspended, or stopping state.
The FlashCopy consistency group enters the copying state and returns to the idle_copied state when
complete.
4. Issue the lsfcconsistgrp command to check the status of the FlashCopy consistency group.
An example of the CLI command issued to check the status of the FlashCopy consistency group:
lsfcconsistgrp -delim : maintobkpfcopy
Where maintobkpfcopy is the name of the FlashCopy consistency group.
An example of the output displayed during the copying process:
id:name:status
1:maintobkpfcopy:copying
The stopfcconsistgrp CLI command stops all processing that is associated with a FlashCopy consistency
group that is in one of the following processing states: prepared, copying, stopping, or suspended.
Results
The rmfcconsistgrp CLI command deletes an existing FlashCopy consistency group. The force parameter
is required only when the consistency group that you want to delete contains mappings.
Important: Using the force parameter might result in a loss of access. Use it only under the direction of
the IBM Support Center.
Procedure
1. To delete an existing consistency group that does not contain mappings, issue the rmfcconsistgrp CLI
command:
rmfcconsistgrp fc_map_id or fc_map_name
where fc_map_id or fc_map_name is the ID or name of the consistency group to delete.
2. To delete an existing consistency group that contains mappings that are members of the consistency
group, issue the following command:
rmfcconsistgrp -force fc_map_id or fc_map_name
where fc_map_id or fc_map_name is the ID or name of the mapping to delete.
All the mappings that are associated with the consistency group are removed from the group and
changed to stand-alone mappings. To delete a single mapping in the consistency group, you must use
the rmfcmap command.
Results
Procedure
1. To create a Metro Mirror relationship, run the mkrcrelationship command. For example, enter:
mkrcrelationship -master master_vdisk_id
-aux aux_vdisk_id -cluster cluster_id
Where master_vdisk_id is the ID of the master volume, aux_vdisk_id is the ID of the auxiliary volume,
and system_id is the ID of the remote clustered system.
2. To create a new Global Mirror relationship, run the mkrcrelationship command with the -global
parameter. For example, enter either one of the following commands:
Where master_vdisk_id is the ID of the master volume, aux_vdisk_id is the ID of the auxiliary volume,
and system_id is the ID of the remote system.
3. To create a new relationship with cycling enabled:
mkrcrelationship -global -cycling multi
38 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Modifying Metro Mirror or Global Mirror relationships using the CLI
You can use the command-line interface (CLI) to modify certain attributes of Metro Mirror or Global
Mirror relationships. You can change only one attribute at a time for each command submission.
To modify Metro Mirror or Global Mirror relationships, run the chrcrelationship command.
Procedure
Run the chrcrelationship command to change the name of a Metro Mirror or Global Mirror relationship.
For example, to change the relationship name, enter:
chrcrelationship -name new_rc_rel_name previous_rc_rel_name
Where new_rc_rel_name is the new name of the relationship and previous_rc_rel_name is the previous name
of the relationship.
Or, run the chrcrelationship command to remove a relationship from whichever consistency group it is a
member of. For example, enter:
chrcrelationship -force -noconsistgrp rc_rel_name/id
Important: Using the -force parameter might result in a loss of access. Use it only under the direction of
the IBM Support Center.
To start and stop Metro Mirror or Global Mirror relationships, perform these steps:
Procedure
1. To start a Metro Mirror or Global Mirror relationship, run the startrcrelationship command. For
example, enter:
startrcrelationship rc_rel_id
Where rc_rel_id is the ID of the relationship that you want to start in a stand-alone relationship.
2. To stop a Metro Mirror or Global Mirror relationship, run the stoprcrelationship command. This
command applies to a stand-alone relationship.
For example, enter:
stoprcrelationship rc_rel_id
Where rc_rel_id is the ID of the stand-alone relationship that you want to stop mirroring I/O.
To display the progress of the background copy of Metro Mirror or Global Mirror relationships, run the
lsrcrelationshipprogress command.
Procedure
1. To display data progress without headings for columns of data or for each item of data in a Metro
Mirror or Global Mirror relationship, run the lsrcrelationshipprogress -nohdr command. For example,
to display data of the relationship with headings suppressed, enter:
lsrcrelationshipprogress -nohdr rc_rel_name
Where rc_rel_name is the name of the specified object type.
2. To display the progress of a background copy of a Metro Mirror or Global Mirror relationship as a
percentage, run the lsrcrelationshipprogress -delim command. The colon character (:) separates all
items of data in a concise view, and the spacing of columns does not occur. In a detailed view, the
data is separated from its header by the specified delimiter. For example, enter:
lsrcrelationshipprogress -delim : 0
The resulting output is displayed, such as in this example:
id:progress
0:58
To switch the roles of primary and secondary volumes in Metro Mirror or Global Mirror relationships,
follow these steps:
Procedure
1. To make the master disk in a Metro Mirror or Global Mirror relationship to be the primary, run the
switchrcrelationship -primary master command. For example, enter:
switchrcrelationship -primary master rc_rel_id
Where rc_rel_id is the ID of the relationship to switch.
2. To make the auxiliary disk in a Metro Mirror or Global Mirror relationship to be the primary, run the
switchrcrelationship -primary aux command. For example, enter:
switchrcrelationship -primary aux rc_rel_id
Where rc_rel_id is the ID of the relationship to switch.
Remember:
v You cannot switch a global relationship if cycling is (automatically) set.
v To switch the direction of a multi cycling mode-based relationship, the relationship must stop with
access enabled. Then, start by using -force in the opposite direction. (Using the force parameter
might result in a loss of access. Use it only under the direction of the IBM Support Center.)
Deleting Metro Mirror and Global Mirror relationships using the CLI
You can use the command-line interface (CLI) to delete Metro Mirror and Global Mirror relationships.
40 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Procedure
To delete Metro Mirror and Global Mirror relationships, run the rmrcrelationship command. For
example, enter:
rmrcrelationship rc_rel_name/id
To create Metro Mirror or Global Mirror consistency groups, perform these steps:
Procedure
1. To create a Metro Mirror or Global Mirror consistency group, run the mkrcconsistgrp command. For
example, enter:
mkrcconsistgrp -name new_name -cluster cluster_id
where new_name is the name of the new consistency group and cluster_id is the ID of the remote
cluster for the new consistency group. If -cluster is not specified, a consistency group is created only
on the local cluster. The new consistency group does not contain any relationships and will be in the
empty state.
2. To add Metro Mirror or Global Mirror relationships to the group, run the chrcrelationship command.
For example, enter:
chrcrelationship -consistgrp consist_group_name rc_rel_id
where consist_group_name is the name of the new consistency group to assign the relationship to and
rc_rel_id is the ID of the relationship.
To assign or modify the name of a Metro Mirror or Global Mirror consistency group, run the
chrcconsistgrp command.
Procedure
1. Run the chrcconsistgrp command to assign a new name of a Metro Mirror or Global Mirror
consistency group. For example, enter:
chrcconsistgrp -name new_name_arg
Where new_name_arg is the assigned new name of the consistency group.
2. Run the chrcconsistgrp command to change the name of the consistency group. For example, enter:
chrcconsistgrp -name new_consist_group_name previous_consist_group_name
Where new_consist_group_name is the assigned new name of the consistency group and
previous_consist_group_name is the previous name of the consistency group.
To start and stop Metro Mirror or Global Mirror consistency-group copy processes, perform these steps:
Procedure
1. To start a Metro Mirror or Global Mirror consistency-group copy process, set the direction of copy if it
is undefined and optionally mark the secondary VDisks of the consistency group as clean. Run the
startrcconsistgrp command. For example, enter:
startrcconsistgrp rc_consist_group_id
Where rc_consist_group_id is the ID of the consistency group to start processing.
2. To stop the copy process for a Metro Mirror or Global Mirror consistency group, run the
stoprcconsistgrp command.
For example, enter:
stoprcconsistgrp rc_consist_group_id
Where rc_consist_group_id is the ID of the consistency group that you want to stop processing.
If the group is in a consistent state, you can also use this command to enable write access to the
secondary virtual disks (VDisks) in the group.
To delete existing Metro Mirror or Global Mirror consistency groups, follow these steps:
Procedure
1. To delete a Metro Mirror or Global Mirror consistency group, run the rmrcconsistgrp command. For
example, enter:
rmrcconsistgrp rc_consist_group_id
Where rc_consist_group_id is the ID of the consistency group to delete.
2. If a Metro Mirror or Global Mirror consistency group is not empty, you must use the -force
parameter to delete the consistency group. For example, enter:
rmrcconsistgrp -force rc_consist_group_id
Where rc_consist_group_id is the ID of the consistency group to delete. This command causes all
relationships that are members of the deleted group to become stand-alone relationships.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
Creating Metro Mirror and Global Mirror partnerships using the CLI
You can use the command-line interface (CLI) to create Metro Mirror and Global Mirror partnerships
between two clustered systems.
42 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
About this task
Perform the following steps to create Metro Mirror and Global Mirror partnerships:
Procedure
1. To create Metro Mirror and Global Mirror partnerships for Fibre Channel connections, run the
mkfcpartnership command. To create Metro Mirror and Global Mirror partnerships for IP connections,
run the mkippartnership command. For example, for Fibre Channel connections enter:
mkfcpartnership -linkbandwidthmbits bandwidth_in_mbps
-backgroundcopyrate percentage_of_available_bandwidth remote_cluster_id
| where bandwidth_in_mbps specifies the bandwidth (in megabytes per second) that is used by the
| background copy process between the clustered systems, percentage_of_available_bandwidth specifies the
| maximum percentage of link bandwidth to be used by the background copy process, and
| remote_cluster_id is the ID of the remote clustered system. For IP connections, enter:
mkippartnership -type ip_address_type
-clusterip remote_cluster_ip_address
-chapsecret chap_secret
-linkbandwidthmbits bandwidth_in_mbps
-backgroundcopyrate percentage_of_available_bandwidth
where ip_address_type specifies the IP address type ("ipv4" or "ipv6") that is used by the remote copy
process between the clustered systems, remote_cluster_ip_address specifies the IP address of the remote
clustered system, chap_secret specifies the CHAP secret of the remote clustered system (this is
optional), bandwidth_in_mbps specifies the bandwidth (in megabytes per second) that is used by the
background copy process between the clustered systems, and percentage_of_available_bandwidth
specifies the maximum percentage of link bandwidth to be used by the background copy process (this
is optional).
2. Run the command mkfcpartnership command for Fiber Channel connections or mkippartnership
command for IP connections from the remote clustered system. For example, for Fibre Channel
connections enter:
mkfcpartnership -linkbandwidthmbits bandwidth_in_mbps
-backgroundcopyrate percentage_of_available_bandwidth
local_cluster_id
where bandwidth_in_mbps specifies the bandwidth (in megabytes per second) that is used by the
background copy process between the clustered systems, percentage_of_available_bandwidth specifies the
maximum percentage of link bandwidth to be used by the background copy process, and
remote_cluster_id is the ID of the local clustered system.
For Internet Protocol (IP) connecrions, enter:
mkippartnership -type ip_address_type
-clusterip local_cluster_ip_address
-chapsecret chap_secret
-linkbandwidthmbits bandwidth_in_mbps
-backgroundcopyrate percentage_of_available_bandwidth
where ip_address_type specifies the IP address type ("ipv4" or "ipv6") that is used by the background
copy process between the clustered systems, remote_cluster_ip_address specifies the IP address of the
local clustered system, chap_secret specifies the CHAP secret of the local clustered system (this is
optional), bandwidth_in_mbps specifies the bandwidth (in megabytes per second) that is used by the
background copy process between the clustered systems, and percentage_of_available_bandwidth
specifies the maximum percentage of link bandwidth to be used by the background copy process (this
is optional).
Modifying Metro Mirror and Global Mirror partnerships using the CLI
You can use the command-line interface (CLI) to modify Metro Mirror and Global Mirror partnerships.
The partnership bandwidth, which is also known as background copy, controls the rate at which data is
sent from the local system to the remote clustered system (system). The partnership bandwidth can be
changed to help manage the use of intersystem links. It is measured in megabytes per second (MBps).
Perform the following steps to modify Metro Mirror and Global Mirror partnerships:
Procedure
1. To modify Metro Mirror and Global Mirror partnerships, run the chpartnership command. For
example, enter:
chpartnership -type ip_address_type
-clusterip remote_cluster_ip_address
-chapsecret chap_secret
-nochapsecret -linkbandwidthmbits bandwidth_in_mbps
-backgroundcopyrate percentage_of_available_bandwidth remote_cluster_id
where ip_address_type specifies the IP address type ("ipv4" or "ipv6") that is used by the background
copy process between the clusters (only used for IP connections), remote_cluster_ip_address specifies the
IP address of the remote cluster (only used for IP connections), chap_secret specifies the CHAP secret
of the remote cluster (only used for IP connections), bandwidth_in_mbps specifies the bandwidth (in
megabytes per second) that is used by the background copy process between the clusters (this is
optional), percentage_of_available_bandwidth specifies the maximum percentage of aggregate link
bandwidth that can be used for background copy operations (this is optional), and remote_cluster_id is
the ID or name of the remote system.
2. Run the chpartnership command from the remote system. For example, enter:
chpartnership -type ip_address_type
-clusterip local_cluster_ip_address
-chapsecret chap_secret -nochapsecret
-linkbandwidthmbits bandwidth_in_mbps
-backgroundcopyrate percentage_of_available_bandwidth local_cluster_id
where ip_address_type specifies the IP address type ("ipv4" or "ipv6") that is used by the background
copy process between the clusters (only used for IP connections), local_cluster_ip_address specifies the
IP address of the local cluster (only used for IP connections), chap_secret specifies the CHAP secret of
the local cluster (only used for IP connections), bandwidth_in_mbps specifies the bandwidth (in
megabytes per second) that is used by the background copy process between the clusters (this is
optional), percentage_of_available_bandwidth specifies the maximum percentage of aggregate link
bandwidth that can be used for background copy operations (this is optional), and local_cluster_id is
the ID or name of the local system.
Perform the following steps to start and stop Metro Mirror and Global Mirror partnerships:
Procedure
1. To start a Metro Mirror or Global Mirror partnership, run the chpartnership command from either
cluster. For example, enter:
chpartnership -start cluster_id
Where is the ID of the local or remote cluster. The mkfcpartnership or mkippartnership command
starts the partnership by default.
44 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
2. To stop a Metro Mirror or Global Mirror partnership, run the chpartnership command from either
cluster.
For example, enter:
chpartnership -stop cluster_id
Where cluster_id is the ID of the local or remote cluster.
Deleting Metro Mirror and Global Mirror partnerships using the CLI
You can use the command-line interface (CLI) to delete Metro Mirror and Global Mirror partnerships.
Perform the following steps to delete Metro Mirror and Global Mirror partnerships:
Procedure
1. If a Metro Mirror or Global Mirror partnership has configured relationships or groups, you must stop
the partnership before you can delete it. For example, enter:
chpartnership -stop remote_cluster_id
Where remote_cluster_id is the ID of the remote cluster.
2. To delete a Metro Mirror and Global Mirror partnership, run the rmpartnership command from either
cluster. For example, enter:
rmpartnership remote_cluster_id
Where remote_cluster_id is the ID of the remote cluster.
Procedure
1. Issue the lsnode CLI command to list the nodes in the clustered system.
2. Record the name or ID of the node for which you want to determine the WWPNs.
3. Issue the lsportfc CLI command and specify the node name or ID that was recorded in step 2.
The following is an example of the CLI command you can issue:
lsportfc -filtervalue node_id=2
Where node_id=2 is the name of the node for which you want to determine the WWPNs. The
following is the output from the command:
id fc_io_port_idport_id type port_speed node_id node_name WWPN nportid status
0 1 1 fc 8Gb 2 node2 5005076801405F82 010E00 active
1 2 2 fc 8Gb 2 node2 5005076801305F82 010A00 active
2 3 3 fc 8Gb 2 node2 5005076801105F82 010E00 active
3 4 4 fc 8Gb 2 node2 5005076801205F82 10A00 active
4 5 3 ethernet 10Gb 2 node2 5005076801505F82 540531 active
5 6 4 ethernet 10Gb 2 node2 5005076801605F82 E80326 active
If a node goes offline or is removed from a clustered system, all volumes that are dependent on the node
go offline. Before taking a node offline or removing a node from a clustered system, run the
lsdependentvdisks command to identify any node-dependent volumes.
By default, the lsdependentvdisks command also checks all available quorum disks. If the quorum disks
are accessible only through the specified node, the command returns an error.
Various scenarios can produce node-dependent volumes. The following examples are common scenarios
in which the lsnodedependentvdisks command will return node-dependent volumes:
1. The node contains solid-state drives (SSDs) and also contains the only synchronized copy of a
mirrored volume.
2. The node is the only node that can access an MDisk on the SAN fabric.
3. The other node in the I/O group is offline (all volumes in the I/O group are returned).
4. Pinned data in the cache is stopping the partner node from joining the I/O group.
To resolve (1), allow volume mirror synchronizations between SSD MDisks to complete. To resolve (2-4),
bring any offline MDisks online and repair any degraded paths.
Note: The command lists the node-dependent volumes at the time the command is run; subsequent
changes to a clustered system require running the command again.
Procedure
1. Issue the lsdependentvdisks CLI command.
The following example shows the CLI format for listing the volumes that are dependent on node01:
lsdependentvdisks -drive -delim : 0:1
The following example shows the output that is displayed:
vdisk_id:vdisk_name
4:vdisk4
5:vdisk5
2. If the lsdependentvdisks command returns an error, you must move your quorum disks to MDisks
that are accessible through all nodes. Rerun the command until no errors are returned.
3. Reissue the lsdependentvdisks command. When the command returns no volumes, the clustered
system is free from any node-dependent volumes.
The following example shows the command syntax for listing the volumes that are dependent on
node01:
lsdependentvdisks -node01 :
The following example shows the command output if there are no node-dependent volumes in the
clustered system:
vdisk_id vdisk_name
Determining the VDisk name from the device identifier on the host
You can use the command-line interface (CLI) to determine the virtual disk (VDisk) name from the device
identifier on the host.
46 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
About this task
Each VDisk that is exported by the SAN Volume Controller is assigned a unique device identifier. The
device identifier uniquely identifies the VDisk (volume) and can be used to determine which VDisk
corresponds to the volume that the host sees.
Perform the following steps to determine the VDisk name from the device identifier:
Procedure
1. Find the device identifier. For example, if you are using the subsystem device driver (SDD), the disk
identifier is referred to as the virtual path (vpath) number. You can issue the following SDD command
to find the vpath serial number:
datapath query device
For other multipathing drivers, refer to the documentation that is provided with your multipathing
driver to determine the device identifier.
2. Find the host object that is defined to the SAN Volume Controller and corresponds with the host that
you are working with.
a. Find the worldwide port numbers (WWPNs) by looking at the device definitions that are stored
by your operating system. For example, on AIX the WWPNs are in the ODM and if you use
Windows you have to go into the HBA Bios.
b. Verify which host object is defined to the SAN Volume Controller for which these ports belong.
The ports are stored as part of the detailed view, so you must list each host by issuing the
following CLI command:
lshost id | name
Where name/id is the name or ID of the host.
c. Check for matching WWPNs.
3. Issue the following command to list the VDisk-to-host mappings:
lshostvdiskmap hostname
Where hostname is the name of the host.
4. Find the VDisk UID that matches the device identifier and record the VDisk name or ID.
Perform the following steps to determine the host that the volume maps:
Procedure
1. Find the volume name or ID that you want to check.
2. Issue the following CLI command to list the hosts that this volume maps:
lsvdiskhostmap vdiskname/id
where vdiskname/id is the name or ID of the volume.
3. Find the host name or ID to determine which host this volume maps.
v If no data is returned, the volume does not map any hosts.
Select one or more of the following options to determine the relationship between volumes and MDisks:
Procedure
v To display a list of the IDs that correspond to the MDisks that comprise the volume, issue the
following CLI command:
lsvdiskmember vdiskname/id
where vdiskname/id is the name or ID of the volume.
v To display a list of IDs that correspond to the volumes that are using this MDisk, issue the following
CLI command:
lsmdiskmember mdiskname/id
where mdiskname/id is the name or ID of the MDisk.
v To display a table of volume IDs and the corresponding number of extents that are being used by each
volume, issue the following CLI command:
lsmdiskextent mdiskname/id
where mdiskname/id is the name or ID of the MDisk.
v To display a table of MDisk IDs and the corresponding number of extents that each MDisk provides as
storage for the given volume, issue the following CLI command:
lsvdiskextent vdiskname/id
where vdiskname/id is the name or ID of the volume.
Each MDisk corresponds with a single RAID array, or with a single partition on a given RAID array. Each
RAID controller defines a LUN number for this disk. The LUN number and controller name or ID are
needed to determine the relationship between MDisks and RAID arrays or partitions.
Perform the following steps to determine the relationship between MDisks and RAID arrays:
Procedure
1. Issue the following command to display a detailed view of the MDisk:
lsmdisk mdiskname
Where mdiskname is the name of the MDisk for which you want to display a detailed view.
2. Record the controller name or controller ID and the controller LUN number.
3. Issue the following command to display a detailed view of the controller:
lscontroller controllername
Where controllername is the name of the controller that you recorded in step 2.
48 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
4. Record the vendor ID, product ID, and WWNN. You can use this information to determine what is
being presented to the MDisk.
5. From the native user interface for the given controller, list the LUNs it is presenting and match the
LUN number with that noted in step 1 on page 48. This tells you the exact RAID array or partition
that corresponds with the MDisk.
Perform the following steps to increase the size of your clustered system:
Procedure
1. Add a node to your clustered system and repeat this step for the second node.
2. If you want to balance the load between the existing I/O groups and the new I/O groups, you can
migrate your volumes to new I/O groups. Repeat this step for all volumes that you want to assign to
the new I/O group.
Adding a node to increase the size of a clustered system using the CLI
You can use the command-line interface (CLI) to increase the size of a clustered system by adding a pair
of nodes to create a full I/O group.
Attention: If you are adding a node that was previously removed from a clustered system (system)
ensure that these conditions have been met:
v All hosts that accessed the removed node through its worldwide port names (WWPNs) have been
reconfigured to use the WWPN for the new node or to no longer access the node. Failure to do so can
result in data corruption.
v Ensure that the system ID has been reset on the new control enclosure. This can be performed using
– Either of the new control enclosure nodes using the Command-Line Interface (CLI) - visit:
“chenclosurevpd” on page 263
– The Service Assistant system by performing these steps:
- Connect to the service assistant on either of the nodes in the control enclosure.
- Select Configure Enclosure.
- Select the Reset the system ID option. Do not make any other changes on the panel.
- Click Modify to make the changes.
Complete these steps to add a node and increase the size of a clustered system:
Procedure
1. Install the new nodes. Connect the nodes to the Fibre Channel.
2. Using the front panel of the node, record the WWNN. The front panel only shows the last 5 digits of
the WWNN.
3. Issue this command to verify that the node is detected on the fabric:
svcinfo lsnodecandidate
Note: You only need to do this step for the first node that is added. The second node of the pair uses
the same I/O group number.
7. Issue this command to add the node to the clustered system:
addnode -wwnodename WWNN -iogrp newiogrpname/id [-name newnodename]
Where WWNN is the WWNN of the node, newiogrpname/id is the name or ID of the I/O group that
you want to add the node to and newnodename is the name that you want to assign to the node. If you
do not specify a new node name, a default name is assigned; however, it is recommended you specify
a meaningful name.
What to do next
Add additional nodes until the I/O group contains two nodes. You may need to reconfigure your storage
systems to allow the new nodes to access them. If the storage system uses mapping to present RAID
arrays or partitions to the clustered system and the WWNNs or the worldwide port names have changed,
you must modify the port groups that belong to the clustered system.
Attention: Run the repairvdiskcopy command only if all volume copies are synchronized.
When you issue the repairvdiskcopy command, you must use only one of the -validate, -medium, or
-resync parameters. You must also specify the name or ID of the volume to be validated and repaired as
the last entry on the command line. After you issue the command, no output is displayed.
-validate
Use this parameter if you only want to verify that the mirrored volume copies are identical. If any
difference is found, the command stops and logs an error that includes the logical block address
(LBA) and the length of the first difference. You can use this parameter, starting at a different LBA
each time to count the number of differences on a volume.
50 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-medium
Use this parameter to convert sectors on all volume copies that contain different contents into virtual
medium errors. Upon completion, the command logs an event, which indicates the number of
differences that were found, the number that were converted into medium errors, and the number
that were not converted. Use this option if you are unsure what the correct data is, and you do not
want an incorrect version of the data to be used.
-resync
Use this parameter to overwrite contents from the specified primary volume copy to the other
volume copy. The command corrects any differing sectors by copying the sectors from the primary
copy to the copies being compared. Upon completion, the command process logs an event, which
indicates the number of differences that were corrected. Use this action if you are sure that either the
primary volume copy data is correct or that your host applications can handle incorrect data.
-startlba lba
Optionally, use this parameter to specify the starting Logical Block Address (LBA) from which to start
the validation and repair. If you previously used the validate parameter, an error was logged with
the LBA where the first difference, if any, was found. Reissue repairvdiskcopy with that LBA to
avoid reprocessing the initial sectors that compared identically. Continue to reissue repairvdiskcopy
using this parameter to list all the differences.
Issue the following command to validate and, if necessary, automatically repair mirrored copies of the
specified volume:
repairvdiskcopy -resync -startlba 20 vdisk8
Notes:
1. Only one repairvdiskcopy command can run on a volume at a time.
2. Once you start the repairvdiskcopy command, you cannot use the command to stop processing.
3. The primary copy of a mirrored volume cannot be changed while the repairvdiskcopy -resync
command is running.
4. If there is only one mirrored copy, the command returns immediately with an error.
5. If a copy being compared goes offline, the command is halted with an error. The command is not
automatically resumed when the copy is brought back online.
6. In the case where one copy is readable but the other copy has a medium error, the command process
automatically attempts to fix the medium error by writing the read data from the other copy.
7. If no differing sectors are found during repairvdiskcopy processing, an informational error is logged
at the end of the process.
Checking the progress of validation and repair of volume copies using the CLI
Use the lsrepairvdiskcopyprogress command to display the progress of mirrored volume validation and
repairs. You can specify a volume copy using the -copy id parameter. To display the volumes that have
two or more copies with an active task, specify the command with no parameters; it is not possible to
have only one volume copy with an active task.
To check the progress of validation and repair of mirrored volumes, issue the following command:
lsrepairvdiskcopyprogress –delim :
The repairsevdiskcopy command automatically detects and repairs corrupted metadata. The command
holds the volume offline during the repair, but does not prevent the disk from being moved between I/O
groups.
If a repair operation completes successfully and the volume was previously offline because of corrupted
metadata, the command brings the volume back online. The only limit on the number of concurrent
repair operations is the number of virtual disk copies in the configuration.
When you issue the repairsevdiskcopy command, you must specify the name or ID of the volume to be
repaired as the last entry on the command line. Once started, a repair operation cannot be paused or
cancelled; the repair can only be terminated by deleting the copy.
Attention: Use this command only to repair a space-efficient volume (thin-provisioned volume) that has
reported corrupt metadata.
Notes:
1. Because the volume is offline to the host, any I/O that is submitted to the volume while it is being
repaired fails.
2. When the repair operation completes successfully, the corrupted metadata error is marked as fixed.
3. If the repair operation fails, the volume is held offline and an error is logged.
Checking the progress of the repair of a space-efficient volume using the CLI
Issue the lsrepairsevdiskcopyprogress command to list the repair progress for space-efficient volume
copies of the specified volume. If you do not specify a volume, the command lists the repair progress for
all space-efficient copies in the system.
Note: Only run this command after you run the repairsevdiskcopy command, which you must only run
as required by the fix procedures or by the IBM Support Center.
If you have lost both nodes in an I/O group and have, therefore, lost access to all the volumes that are
associated with the I/O group, you must perform one of the following procedures to regain access to
your volumes. Depending on the failure type, you might have lost data that was cached for these
volumes and the volumes are now offline.
One node in an I/O group has failed and failover has started on the second node. During the failover
process, the second node in the I/O group fails before the data in the write cache is written to hard disk.
52 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The first node is successfully repaired but its hardened data is not the most recent version that is
committed to the data store; therefore, it cannot be used. The second node is repaired or replaced and has
lost its hardened data, therefore, the node has no way of recognizing that it is part of the clustered
system.
Perform the following steps to recover from an offline volume when one node has down-level hardened
data and the other node has lost hardened data:
Procedure
1. Recover the node and add it back into the system.
2. Delete all IBM FlashCopy mappings and Metro Mirror or Global Mirror relationships that use the
offline volumes.
3. Run the recovervdisk, recovervdiskbyiogrp or recovervdiskbysystem command.
4. Re-create all FlashCopy mappings and Metro Mirror or Global Mirror relationships that use the
volumes.
Example
Data loss scenario 2
Both nodes in the I/O group have failed and have been repaired. The nodes have lost their hardened
data, therefore, the nodes have no way of recognizing that they are part of the system.
Perform the following steps to recover from an offline volume when both nodes have lost their hardened
data and cannot be recognized by the system:
1. Delete all FlashCopy mappings and Metro Mirror or Global Mirror relationships that use the offline
volumes.
2. Run the recovervdisk, recovervdiskbyiogrp or recovervdiskbysystem command.
3. Create all FlashCopy mappings and Metro Mirror or Global Mirror relationships that use the volumes.
Perform the following steps to recover a node and return it to the clustered system:
Procedure
1. Run the lsnode command (for Storwize V7000 nodes) to verify that the node is offline.
2. Run the rmnode Nodename/ID command to remove the old instance of the offline node from the
clustered system.
3. Run the lsnodecandidate command to verify that the node is visible on the fabric.
4. Run the addnode -wwnodename WWNN -iogrp IOgroupname/ID -name NodeName to add the node back
into the clustered system, where WWNN is the worldwide node name, IOgroupname/ID is the I/O
group name or ID, and NodeName is the name of the node.
Note: In a service situation, a node should normally be added back into a clustered system using the
original node name. If the partner node in the I/O group has not also been deleted, this is the default
name that is used if the -name parameter is not specified.
5. Run the lsnode command to verify that the node is online.
Procedure
1. Issue the following CLI command to list all volumes that are offline and belong to an I/O group,
enter:
lsvdisk -filtervalue IO_group_name=
IOGRPNAME/ID:status=offline
where IOGRPNAME/ID is the name of the I/O group that failed.
2. To acknowledge data loss for a volume with a fast_write_state of corrupt and bring the volume back
online, enter:
recovervdisk vdisk_id | vdisk_name
where vdisk_id | vdisk_name is the name or ID of the volume.
Notes:
v If the specified volume is space-efficient or has space-efficient copies, the recovervdisk command
starts the space-efficient repair process.
v If the specified volume is mirrored, the recovervdisk command starts the resynchronization process.
3. To acknowledge data loss for all virtual disks in an I/O group with a fast_write_state of corrupt and
bring them back online, enter:
recovervdiskbyiogrp io_group_id | io_group_name
where io_group_id | io_group_name is the name or ID of the I/O group.
Notes:
v If any volume is space-efficient or has space-efficient copies, the recovervdiskbyiogrp command
starts the space-efficient repair process.
v If any volume is mirrored, the recovervdiskbyiogrp command starts the resynchronization process.
4. To acknowledge data loss for all volumes in the clustered system with a fast_write_state of corrupt and
bring them back online, enter:
recovervdiskbycluster
Notes:
v If any volume is space-efficient or has space-efficient copies, the recovervdiskbycluster command
starts the space-efficient repair process.
v If any volume is mirrored, the recovervdiskbycluster command starts the resynchronization
process.
Moving offline volumes to their original I/O group using the CLI
You can move offline volumes to their original I/O group using the command-line interface (CLI).
After a node or an I/O group fails, you can use the following procedure to move offline volumes to their
original I/O group.
Attention: Do not move volumes to an offline I/O group. Ensure that the I/O group is online before
you move the volume back to avoid any further data loss.
54 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Perform the following steps to move offline volumes to their original I/O group:
Procedure
1. Issue the following command to move the volume back into the original I/O group:
movevdisk -iogrp IOGRP3 -node 7 DB_Volume
where 7 is the name of the node that you want to move the volume, IOGRP3, is the name or ID of
the I/O group that you want to migrate the volume to, and DB_Volume is the name or ID of
the volume that you want to migrate.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
2. Issue the following command to verify that the volumes are now online:
lsvdisk -filtervalue IO_group_name=
IOGRPNAME/ID
where IOGRPNAME/ID is the name or ID of the original I/O group.
Because it is sometimes necessary to replace the host-bus adapter (HBA) that connects the host to the
SAN, you must inform the SAN Volume Controller of the new worldwide port names (WWPNs) that this
HBA contains.
Procedure
To inform the SAN Volume Controller of a change to a defined host object, complete the following steps.
1. Issue this CLI command to list the candidate HBA ports:
lsfcportcandidate
You should see a list of the HBA ports that are available for addition to host objects. One or more of
these HBA ports should correspond with the one or more WWPNs that belong to the new HBA port.
2. Locate the host object that corresponds with the host in which you have replaced the HBA. The
following CLI command lists all the defined host objects:
lshost
3. Issue the following CLI command to list the WWPNs that are currently assigned to the host object:
lshost hostobjectname
where hostobjectname is the name of the host object.
4. Issue the following CLI command to add the new ports to the existing host object:
addhostport -fcwwpn one or more existing WWPNs
separated by : hostobjectname/ID
where one or more existing WWPNs separated by : is the WWPNs that are currently assigned to the host
object and hostobjectname/ID is the name or ID of the host object.
5. Issue the following CLI command to remove the old ports from the host object:
rmhostport -fcwwpn one or more existing WWPNs
separated by : hostobjectname/ID
where one or more existing WWPNs separated by a colon (:) are the WWPNs that are currently
assigned to the host object and hostobjectname/ID is the name or ID of the host object.
Any mappings that exist between the host object and the virtual disks or VDisks (volumes) are
automatically applied to the new WWPNs. Therefore, the host sees the volumes as the same SCSI LUNs
as before.
What to do next
See the IBM System Storage Multipath Subsystem Device Driver User's Guide or the documentation that is
provided with your multipathing driver for additional information about dynamic reconfiguration.
VDisks (volumes) that are mapped for FlashCopy or that are in Metro Mirror relationships cannot be
expanded.
Ensure that you have run Windows Update and have applied all recommended updates to your system
before you attempt to expand a volume that is mapped to a Windows host.
Determine the exact size of the source or master volume by issuing the following CLI command:
lsvdisk -bytes vdiskname
where vdiskname is the name of the volume for which you want to determine the exact size.
A volume that is not mapped to any hosts and does not contain any data can be expanded at any time. If
the volume contains data that is in use, you can expand the volumes if your host has a supported AIX or
Microsoft Windows operating system.
See the software restrictions page on the following website for supporting information and restrictions on
expanding volumes: www.ibm.com/storage/support/2145
The AIX chvg command options provide the ability to expand the size of a physical volume that the
Logical Volume Manager (LVM) uses, without interruptions to the use or availability of the system. See
the AIX System Management Guide Operating System and Devices for more information.
56 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Expanding a volume that is mapped to a Microsoft Windows host
using the CLI
You can use the command-line interface (CLI) to dynamically expand the size of a volume that is mapped
to a Microsoft Windows host.
Perform the following steps to expand a volume that is mapped to a Windows host:
Procedure
1. Issue the following CLI command to expand the volume:
expandvdisksize -size disk_size -unit data_unit vdisk_name/vdisk_id
where disk_size is the capacity by which you want to expand the volume, b | kb | mb | gb | tb | pb
is the data_unit to use in conjunction with the capacity and vdisk_name/vdisk_id is the name of the
volume or the ID of the volume to expand.
2. On the Windows host, start the Computer Management application and open the Disk Management
window under the Storage branch.
Results
You will see the volume that you expanded now has some unallocated space at the end of the disk.
You can expand dynamic disks without stopping I/O operations in most cases. However, in some
applications the operating system might report I/O errors. When this problem occurs, either of the
following entries might be recorded in the System event log:
Event Type: Information
Event Source: dmio
Event Category: None
Event ID: 31
Description: dmio:
Harddisk0 write error at block ######## due to
disk removal
Attention: This is a known problem with Windows 2000 and is documented in the Microsoft knowledge
base as article Q327020. If either of these errors are seen, run Windows Update and apply the
recommended fixes to resolve the problem.
What to do next
If the Computer Management application was open before you expanded the volume, use the Computer
Management application to issue a rescan command.
If the disk is a Windows basic disk, you can create a new primary or extended partition from the
unallocated space.
If the disk is a Windows dynamic disk, you can use the unallocated space to create a new volume
(simple, striped, mirrored) or add it to an existing volume.
Volumes can be reduced in size, if it is necessary. You can make a target or auxiliary volume the same
size as the source or master volume when you create FlashCopy mappings, Metro Mirror relationships, or
Global Mirror relationships. However, if the volume contains data, do not shrink the size of the disk.
Attention:
1. The SAN Volume Controller arbitrarily reduces the capacity of the volume by removing one or more
extents from those that are allocated to the volume. You cannot control which extents are removed so
you cannot guarantee that it is unused space that is removed.
2. If the volume contains data that is being used, do not attempt under any circumstances to shrink a volume
without first backing up your data.
3. For performance reasons, some operating systems or file systems use the outer edge of the disk.
You can use the shrinkvdisksize command to shrink the physical capacity that is allocated to the
particular volume by the specified amount. You can also shrink the virtual capacity of a thin-provisioned
volume without altering the physical capacity assigned to the volume.
For more information about the command parameters, see the IBM System Storage SAN Volume Controller
and IBM Storwize V7000 Command-Line Interface User's Guide.
Procedure
The SAN Volume Controller provides various data migration features. These can be used to move the
placement of data both within storage pools and between storage pools. These features can be used
concurrently with I/O operations. You can use either of these methods to migrate data:
1. Migrating data (extents) from one MDisk to another (within the same storage pool). This can be used
to remove highly utilized MDisks.
2. Migrating volumes from one storage pool to another. This can be used to remove highly utilized
storage pools. For example, you can reduce the utilization of a group of MDisks.
Notes:
58 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
1. The source MDisk must not currently be the source MDisk for any other migrate extents operation.
2. The destination MDisk must not be the destination MDisk for any other migrate extents operation.
Migration commands fail if the target or source volume is offline, or if there is insufficient quorum disk
space to store the metadata. Correct the offline or quorum disk condition and reissue the command.
You can determine the usage of particular MDisks by gathering input/output (I/O) statistics about nodes,
MDisks, and volumes. After you have gathered this data, you can analyze it to determine which MDisks
are highly utilized. The procedure then takes you through querying and migrating extents to elsewhere in
the same storage pool. This procedure can only be performed using the command-line tools.
If performance monitoring tools, such as IBM Tivoli Storage Productivity Center, indicate that a managed
disk in the pool is being overutilized, you can migrate some of the data onto other MDisks within the
same storage pool.
Procedure
1. Determine the number of extents that are in use by each volume for the given MDisk by issuing this
CLI command:
lsmdiskextent mdiskname
This command returns the number of extents that each volume is using on the given MDisk. You
should pick some of these to migrate elsewhere in the group.
2. Determine the other MDisks that reside in the same storage pool.
a. To determine the storage pool that the MDisk belongs to, issue this CLI command:
lsmdisk mdiskname | ID
b. List the MDisks in the group by issuing this CLI command:
You can issue the lsmdiskextent newmdiskname command for each of the target MDisks to ensure that
you are not just moving the over-utilization to another MDisk. Check that the volume that owns the
set of extents to be moved does not already own a large set of extents on the target MDisk.
4. For each set of extents, issue this CLI command to move them to another MDisk:
where num_extents is the number of extents on the vdiskid. The newmdiskname | ID value is the name
or ID of the MDisk to migrate this set of extents to.
Note: The number of threads indicates the priority of the migration processing, where 1 is the lowest
priority and 4 is the highest priority.
5. Repeat the previous steps for each set of extents that you are moving.
6. You can check the progress of the migration by issuing this CLI command:
lsmigrate
You can determine the usage of particular MDisks by gathering input/output (I/O) statistics about nodes,
MDisks, and volumes. After you have gathered this data, you can analyze it to determine which volumes
or MDisks are hot. You can then migrate volumes from one storage pool to another.
Perform the following step to gather statistics about MDisks and volumes:
1. Use secure copy (scp command) to retrieve the dump files for analyzing. For example, issue the
following:
scp clusterip:/dumps/iostats/v_*
This copies all the volume statistics files to the AIX host in the current directory.
2. Analyze the dumps to determine which volumes are hot. It might be helpful to also determine which
MDisks are being used heavily as you can spread the data that they contain more evenly across all
the MDisks in the group by migrating the extents.
After you analyze the I/O statistics data, you can determine which volumes are hot. You also need to
determine the storage pool that you want to move this volume to. Either create a new storage pool or
determine an existing group that is not yet overly used. To do this, check the I/O statistics files that you
generated and then ensure that the MDisks or VDisks in the target storage pool are used less than those
in the source group.
You can use data migration or volume mirroring to migrate data between MDisk groups. Data migration
uses the command migratevdisk. Volume mirroring uses the commands addvdiskcopy and rmvdiskcopy.
When you issue the migratevdisk command, a check is made to ensure that the destination of the
migration has enough free extents to satisfy the command. If it does, the command proceeds. The
command takes some time to complete.
Notes:
v You cannot use the SAN Volume Controller data migration function to move a volume between storage
pools that have different extent sizes.
v Migration commands fail if the target or source volume is offline, or if there is insufficient quorum disk
space to store the metadata. Correct the offline or quorum disk condition and reissue the command.
When you use data migration, it is possible for the free destination extents to be consumed by another
process; for example, if a new volume is created in the destination storage pool or if more migration
commands are started. In this scenario, after all the destination extents are allocated, the migration
commands suspend and an error is logged (error ID 020005). To recover from this situation, use either of
the following methods:
v Add additional MDisks to the target storage pool. This provides additional extents in the group and
allows the migrations to be restarted. You must mark the error as fixed before you reattempt the
migration.
v Migrate one or more VDisks that are already created from the storage pool to another group. This frees
up extents in the group and allows the original migrations to be restarted.
Perform the following steps to use the migratevdisk command to migrate volumes between storage
pools:
60 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Procedure
1. After you determine the volume that you want to migrate and the new storage pool you want to
migrate it to, issue the following CLI command:
migratevdisk -vdisk vdiskname/ID -mdiskgrp
newmdiskgrname/ID -threads 4
2. You can check the progress of the migration by issuing the following CLI command:
lsmigrate
What to do next
When you use data migration, the volume goes offline if either storage pool fails. Volume mirroring can
be used to minimize the impact to the volume because the volume goes offline only if the source storage
pool fails.
Perform the following steps to use volume mirroring to migrate volumes between storage pool:
1. After you determine the volume that you want to migrate and the new storage pool that you want to
migrate it to, issue the following command:
addvdiskcopy -mdiskgrp newmdiskgrname/ID vdiskname/ID
2. The copy ID of the new copy is returned. The copies now synchronize such that the data is stored in
both storage pools. You can check the progress of the synchronization by issuing the following
command:
lsvdisksyncprogress
3. After the synchronization is complete, remove the copy from the original I/O group to free up extents
and decrease the utilization of the storage pool. To remove the original copy, issue the following
command:
rmvdiskcopy -copy original copy id vdiskname/ID
Attention: These migration tasks can be non-disruptive if performed correctly and hosts mapped to the
volume support non disruptive volume move. The cached data that is held within the system must first
be written to disk before the allocation of the volume can be changed.
Modifying the I/O group that services the volume can be done concurrently with I/O operations if the
host supports non disruptive volume move. It also requires a rescan at the host level to ensure that the
multipathing driver is notified that the allocation of the preferred node has changed and the ports by
which the volume is accessed has changed. This can be done in the situation where one pair of nodes has
become over utilized.
If there are any host mappings for the volume, the hosts must be members of the target I/O group or the
migration fails.
Make sure you create paths to I/O groups on the host system. After the system has successfully added
the new I/O group to the volume's access set and you have moved selected volumes to another I/O
group, detect the new paths to the volumes on the host. The commands and actions on the host vary
depending on the type of host and the connection method used. These steps must be completed on all
hosts to which the selected volumes are currently mapped.
You can also use the management GUI to move volumes between I/O groups non-disruptively. In the
management GUI, select Volumes > Volumes. On the Volumes panel, select the volume that you want to
To move a volume between I/O groups using the CLI, complete the following steps:
Procedure
1. Issue the following command: addvdiskaccess -iogrp iogrp id/name volume id/name
2. Issue the following command: movevdisk -iogrp destination iogrp -node new preferred node
volume id/name
3. Issue the appropriate commands on the hosts mapped to the volume to detect the new paths to the
volume in the destination I/O group.
4. Once you confirm the new paths are online, remove access from the old I/O group: rmvdiskaccess
-iogrp iogrp id/name volume id/name
5. Issue the appropriate commands on the hosts mapped to the volume to remove the paths to the old
I/O group.
Make sure you are aware of the following before you create image mode volumes:
1. Unmanaged-mode managed disks (MDisks) that contain existing data cannot be differentiated from
unmanaged-mode MDisks that are blank. Therefore, it is vital that you control the introduction of
these MDisks to the clustered system by adding these disks one at a time. For example, map a single
LUN from your RAID storage system to the clustered system and refresh the view of MDisks. The
newly detected MDisk is displayed.
2. Do not manually add an unmanaged-mode MDisk that contains existing data to a storage pool. If you
do, the data is lost. When you use the command to convert an image mode volume from an
unmanaged-mode disk, you will select the storage pool where it should be added.
See this website for more information:
| http://www-947.ibm.com/support/entry/portal/overview/hardware/system_storage/storage_software/
| storage_virtualization/san_volume_controller_(2145)
Procedure
1. Stop all I/O operations from the hosts. Unmap the logical disks that contain the data from the hosts.
2. Create one or more storage pools.
3. Map a single array or logical unit from your RAID storage system to the clustered system. You can do
this through a switch zoning or a RAID storage system based on your host mappings. The array or
logical unit appears as an unmanaged-mode MDisk to the SAN Volume Controller.
4. Issue the lsmdisk command to list the unmanaged-mode MDisks.
If the new unmanaged-mode MDisk is not listed, you can perform a fabric-level discovery. Issue the
detectmdisk command to scan the Fibre Channel network for the unmanaged-mode MDisks.
62 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: The detectmdisk command also rebalances MDisk access across the available storage system
device ports.
5. Convert the unmanaged-mode MDisk to an image mode virtual disk.
Note: If the volume that you are converting maps to a solid-state drive (SSD), the data that is stored
on the volume is not protected against SSD failures or node failures. To avoid data loss, add a volume
copy that maps to an SSD on another node.
Issue the mkvdisk command to create an image mode virtual disk object.
6. Map the new volume to the hosts that were previously using the data that the MDisk now contains.
You can use the mkvdiskhostmap command to create a new mapping between a volume and a host.
This makes the image mode volume accessible for I/O operations to the host.
Results
After the volume is mapped to a host object, the volume is detected as a disk drive with which the host
can perform I/O operations.
What to do next
If you want to virtualize the storage on an image mode volume, you can transform it into a striped
volume. Migrate the data on the image mode volume to managed-mode disks in another storage pool.
Issue the migratevdisk command to migrate an entire image mode volume from one storage pool to
another storage pool.
The migratetoimage CLI command allows you to migrate the data from an existing VDisk (volume) onto
a different managed disk (MDisk).
When the migratetoimage CLI command is issued, it migrates the data of the user specified source VDisk
onto the specified target MDisk. When the command completes, the VDisk is classified as an image mode
VDisk.
Note: Migration commands fail if the target or source VDisk is offline, or if there is insufficient quorum
disk space to store the metadata. Correct the offline or quorum disk condition and reissue the command.
The MDisk specified as the target must be in an unmanaged state at the time the command is run.
Issuing this command results in the inclusion of the MDisk into the user specified MDisk group.
Issue the following CLI command to migrate data to an image mode VDisk:
where vdiskname/ID is the name or ID of the VDisk, newmdiskname/ID is the name or ID of the new
MDisk, and newmdiskgrpname/ID is the name or ID of the new MDisk group (storage pool).
After the node is deleted, the other node in the I/O group enters write-through mode until another node
is added back into the I/O group.
By default, the rmnode command flushes the cache on the specified node before taking the node offline.
When operating in a degraded state, the SAN Volume Controller ensures that data loss does not occur as
a result of deleting the only node with the cache data.
Attention:
v If you are removing a single node and the remaining node in the I/O group is online, the data can be
exposed to a single point of failure if the remaining node fails.
v If both nodes in the I/O group are online and the volumes are already degraded before deleting the
node, redundancy to the volumes is already degraded. Removing a node might result in loss of access
to data, and data loss might occur if the force option is used.
v Removing the last node in the clustered system destroys the clustered system. Before you delete the
last node in the clustered system, ensure that you want to destroy the clustered system.
v When you delete a node, you remove all redundancy from the I/O group. As a result, new or existing
failures can cause I/O errors on the hosts. These failures can occur:
– Host configuration errors
– Zoning errors
– Multipathing software configuration errors
v If you are deleting the last node in an I/O group and there are volumes assigned to the I/O group,
you cannot delete the node from the clustered system if the node is online. You must back up or
migrate all data that you want to save before you delete the node. If the node is offline, you can delete
the node.
v To take the specified node offline immediately without flushing the cache or ensuring that data loss
does not occur, run the rmnode command with the force parameter. The force parameter forces
continuation of the command even though any node-dependent volumes will be taken offline. Use the
force parameter with caution; access to data on node-dependent volumes will be lost.
Procedure
1. If you are deleting the last node in an I/O group, determine the volumes that are still assigned to this
I/O group:
a. Issue this CLI command to request a filtered view of the volumes:
lsvdisk -filtervalue IO_group_name=name
Note: If volumes are assigned to this I/O group that contain data that you want to continue to access,
back up the data or migrate the volumes to a different (online) I/O group.
2. If this node is not the last node in the clustered system, turn off the power to the node that you
intend to remove. This step ensures that the multipathing device driver, such as the subsystem device
driver (SDD), does not rediscover the paths that are manually removed before you issue the delete
node request.
64 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Attention:
a. If you are removing the configuration node, the rmnode command causes the configuration node to
move to a different node within the clustered system. This process might take a short time,
typically less than a minute. The clustered system IP address remains unchanged, but any SSH
client attached to the configuration node might must reestablish a connection.
b. If you turn on the power to the node that has been removed and it is still connected to the same
fabric or zone, it attempts to rejoin the clustered system. The clustered system causes the node to
remove itself from the clustered system and the node becomes a candidate for addition to this
clustered system or another clustered system.
c. If you are adding this node into the clustered system, ensure that you add it to the same I/O
group that it was previously a member of. Failure to do so can result in data corruption.
d. In a service situation, a node should normally be added back into a clustered system using the
original node name. As long as the partner node in the I/O group has not been deleted too, this is
the default name used if -name is not specified.
3. Before you delete the node, update the multipathing device driver configuration on the host to
remove all device identifiers that are presented by the volumes that you intend to remove. If you are
using the subsystem device driver, the device identifiers are referred to as virtual paths (vpaths).
Attention: Failure to perform this step can result in data corruption.
See the IBM System Storage Multipath Subsystem Device Driver User's Guide for details about how to
dynamically reconfigure SDD for the given host operating system.
4. Issue this CLI command to delete a node from the clustered system:
Attention: Before you delete the node: The rmnode command checks for node-dependent volumes,
which are not mirrored at the time that the command is run. If any node-dependent volumes are
found, the command stops and returns a message. To continue removing the node despite the
potential loss of data, run the rmnode command with the force parameter. Alternatively, follow these
steps before you remove the node to ensure that all volumes are mirrored:
a. Run the lsdependentvdisks command.
b. For each node-dependent volume that is returned, run the lsvdisk command.
c. Ensure that each volume returns in-sync status.
rmnode node_name_or_identification
Where node_name_or_identification is the name or identification of the node.
Note: Before removing a node, the command checks for any node-dependent volumes that would go
offline. If the node that you selected to delete contains a solid-state drive (SSD) that has dependent
volumes, volumes that use the SSDs go offline and become unavailable if the node is deleted. To
maintain access to volume data, mirror these volumes before removing the node. To continue
removing the node without mirroring the volumes, specify the force parameter.
Procedure
1. Issue the finderr command to analyze the error log for the highest severity of unfixed errors. This
command scans the error log for any unfixed errors. Given a priority ordering defined within the
code, the highest priority of unfixed errors is returned.
2. Issue the dumperrlog command to dump the contents of the error log to a text file.
3. Locate and fix the error.
Note: Clearing the error log does not fix the errors.
5. Issue the cherrstate command to toggle the state of an error between unfixed and fixed.
Attention: When you specify a new IP address for a system, the existing communication with the
system is broken. You must reconnect to the system with the new IP address.
Procedure
66 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
10. Optionally, if you want to delete all of the IPv6 addresses in the system after you have changed all
addresses to IPv4, issue this command:
chsystem -noip_6
11. The IP routing table provides details of the gateway that is used for IP traffic to a range of IP
addresses for each Ethernet port. This information can be used to diagnose configuration node
accessibility problems. To display the IP routing table, enter this CLI command:
lsroute
12. The ping command can be used to diagnose IP configuration problems by checking whether a given
IP address is accessible from the configuration node. The command can be useful for diagnosing
problems where the configuration node cannot be reached from a specific management server. For
example, enter this CLI command:
ping ipv4_address | ipv6_address
where ipv4_address | ipv6_address is either the IPv4 address or the IPv6 address.
Procedure
The relationship bandwidth limit controls the maximum rate at which any one remote-copy relationship
can synchronize. The overall limit is controlled by the bandwidth parameter of each system partnership.
The default value for the relationship bandwidth limit is 25 megabytes per second (MBps), but you can
change this by following these steps:
Procedure
1. Issue the lssystem command to list the current relationship bandwidth limit of the system. For
example:
lssystem system_id_or_system_name
Before completing any iSCSI-configuration tasks on the system, it is important that you complete all the
iSCSI-related configuration on the host machine. Because the system supports a variety of host machines,
consult the documentation for specific instructions and requirements for a particular host. For a list of
supported hosts, see this website:
www.ibm.com/storage/support/2145
To configure a system for iSCSI, follow these general tasks on the host system:
1. Select a software-based iSCSI initiator, such as Microsoft Windows iSCSI Software Initiator and verify
the iSCSI driver installation.
2. If required, install and configure a multipathing driver for the host system.
In addition, determine a naming convention for iSCSI names, such as iSCSI qualified names (IQNs) for
your system. Hosts use iSCSI names to connect to the node. Each node, for example, has a unique IQN,
and the system name and node name are used as part of that IQN. Each node, for example, has a unique
IQN, and the system name and node name are used as part of that IQN.
Port IP addresses are the IP addresses that are used by iSCSI-attached hosts to perform I/O.
Procedure
1. To configure a new port IP address to a specified Ethernet port of a node with an IPv4 address, enter
the following command-line interface (CLI) command:
cfgportip -node node_name | node_id -ip ipv4addr
-gw ipv4gw -mask subnet_mask -failover port_id
where node_name | node_id specifies the name or ID of the node that is being configured, ipv4addr is
the IPv4 address for the Ethernet port, ipv4gw is the IPv4 gateway IP address, subnet_mask is the IPv4
subnet mask, and port_id specifies the Ethernet port ID (1 or 2). To view a list of ports, use the
lsportip command.
The optional -failover parameter specifies that the port is to be used during failover. If the node that
is specified is the only online node in the I/O group, the address is configured and presented by this
node. When another node in the I/O group comes online, the failover address is presented by that
node. If two nodes in the I/O group are online when the command is issued, the address is presented
by the other node to the partner node.
2. To configure a new port IP address that belongs to a partner node with an IPv6 address in the I/O
group, enter the following CLI command:
68 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
cfgportip -node node_name | node_id -ip_6 ipv6addr
-gw_6 ipv6gw -prefix_6 prefix -failover port_id
where node_name | node_id specifies the name or ID of the node that is being configured, ipv4addr is
the IPv4 address for the Ethernet port, ipv4gw is the IPv4 gateway IP address, subnet_mask is the IPv4
subnet mask, and port_id specifies the Ethernet port ID (1 or 2). To view a list of ports, use the
lsportip command.
The optional -failover parameter specifies that the data is failover data, which is data that is related
to the partner node. If the node that is specified is the only online node in the I/O group, the address
is configured and presented by this node. When another node in the I/O group comes online, the
failover address is presented by that node. If two nodes in the I/O group are online when the
command is issued, the address is presented by the other node to that specified.
3. To remove an iSCSI IP address from a node Ethernet port, enter either of these CLI commands. The
following command deletes an IPv4 configuration for the specified iSCSI Ethernet port:
rmportip -failover
-node node_name | node_id port_id
where node_name | node_id specifies the name or ID of the node with the Ethernet port that the IP
address is being removed from and port_id specifies the Ethernet port ID. To list the valid values for
the Ethernet port, enter the lsportip command. The optional -failover parameter indicates that the
specified data is failover data.
The following command deletes an IPv6 configuration for the specified iSCSI Ethernet port:
rmportip -ip_6 -failover
-node node_name | node_id port_id
where -ip_6 indicates that this command will remove an IPv6 configuration, node_name | node_id
specifies the name or ID of the node with the Ethernet port that the IP address is being removed
from, and port_id specifies the Ethernet port ID. To list the valid values for the Ethernet port, enter the
lsportip command. The optional -failover parameter indicates that the specified data is failover
data.
What to do next
After you configure your IP addresses, you can optionally create iSCSI aliases.
Procedure
1. To configure a new port IP address to a specified Ethernet port of a node, enter the following CLI
command:
chnode -iscsialias alias node_name | node_id
where alias node_name | node_id specifies the name or ID of the node.
2. To specify that the name or iSCSI alias that is being set is the name or alias of the partner node in the
I/O group, enter the following CLI command. When there is no partner node, the values set are
applied to the partner node when it is added to the clustered system. If this parameter is used when
there is a partner node, the name or alias of that node changes
chnode -iscsialias alias -failover node_name | node_id
where alias specifies the iSCSI name of the node and node_name | node_id specifies the node to be
modified.
After you create iSCSI aliases, you can optionally configure the address for the Internet Storage Name
Service (iSNS) server for the system.
Procedure
1. To specify an IPv4 address for the iSCSI storage name service (SNS), enter the following CLI
command:
chsystem -isnsip sns_server_address
where sns_server_address is the IP address of the iSCSI storage name service in IPv4 format.
2. To specify an IPv6 address for the iSCSI storage name service (SNS), enter the following CLI
command:
chsystem -isnsip_6 ipv6_sns_server_address
where ipv6_sns_server_address is the IP address of the iSCSI storage name service in IPv6 format.
To configure authentication between the SAN Volume Controller system and the iSCSI-attached hosts,
follow these steps:
Procedure
1. To set the authentication method for the iSCSI communications of the system , enter the following CLI
command:
chsystem -iscsiauthmethod chap -chapsecret chap_secret
where chap sets the authentication method for the iSCSI communications of the system and chap_secret
sets the CHAP secret to be used to authenticate the system via iSCSI. This parameter is required if the
iscsiauthmethod chap parameter is specified. The specified CHAP secret cannot begin or end with a
space.
2. To clear any previously set CHAP secret for iSCSI authentication, enter the following CLI command:
chsystem -nochapsecret
70 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
What to do next
After you configure the CHAP secret for the SAN Volume Controller system, ensure that the system
CHAP secret is added to each iSCSI-attached host. On all iSCSI-attached hosts, specify a CHAP secret
that the hosts use to authenticate to the SAN Volume Controller system.
If a user is configured on the clustered system as a local user, only local credentials are used. Otherwise,
when using the management GUI or the command-line interface (CLI), users entering their password are
authenticated against the remote service, and their roles are determined according to group memberships
defined on the remote service. If a user is configured on the clustered system as a remote user with an
SSH key, the user can additionally access the command-line interface using this Secure Shell (SSH) key.
Group memberships continue to be determined from the remote service.
To use the SAN Volume Controller with TIP, follow these steps:
Procedure
1. Configure the system with the location of the remote authentication server. Issue the chauthservice
command to change system settings, and issue the lssystem command to view system settings.
Remember: You can use either an http or https connection to the server. If you use http, the user,
password, and SSH key information is transmitted as clear text over the IP network.
2. Configure user groups (with roles) on the system by matching those that are used by the
authentication service. For each group of interest known to the authentication service, a SAN Volume
Controller user group must be created with the same name and with the remote setting enabled. For
example, if members of a group called sysadmins require the SAN Volume Controller Administrator
(Administrator) role, issue the following command:
mkusergrp -name sysadmins -remote -role Administrator
If none of the groups for a user match any of the SAN Volume Controller user groups, the user
cannot access the system.
3. Configure users who do not require Secure Shell (SSH) access. SAN Volume Controller users use the
remote authentication service and do not require SSH access should be deleted from the system.
Remember: A superuser cannot be deleted and cannot use the remote authentication service.
4. Configure users who require SSH access. All SAN Volume Controller users who use the remote
authentication service and require SSH access must have remote settings enabled and the same
password and an SSH key set both on the system and on the authentication service.
5. Configure the system time. The current time of both the SAN Volume Controller clustered system and
the system that is running the remote authentication service must match.
Note: If a user was created on the CMM, the user needs to log in to the CMM and change their
password before logging into the system. An endpoint cannot use an account that was created on the
CMM until the CMM user logs into the CMM and changes their CMM account password.
v Users on provisioned LDAP servers with IBMRBS permissions of Supervisor Access or Supervisor Role
can log in to the system as the SVC Administrator, but cannot run satask or sainfo commands.
v All authentication commands and settings are disabled.
– Automatically provisioned settings are not visible to the user and are not displayed by the lssystem
or lsldapserver commands.
– The chauthservice -refresh command is enabled.
All options on the system GUI LDAP panel are disabled.
Tip: A superuser cannot be authenticated using a remote Lightweight Directory Access Protocol (LDAP
server). However, other users can authenticate in this manner.
Procedure
72 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
For each group of interest known to the authentication service, a SAN Volume Controller user group
must be created with the same name and with the remote setting enabled. For example, if members of
a group called sysadmins require the SAN Volume Controller Administrator (admin) role, issue the
following command:
mkusergrp -name sysadmins -remote -role Administrator
If none of the user groups match a SAN Volume Controller user group, the user cannot access the
system.
4. Verify your LDAP configuration using the testldapserver command.
To test the connection to the LDAP servers, issue the command without any options. A username can
be supplied with or without a password to test for configuration errors. To perform a full
authentication attempt against each server, issue the following commands:
testldapserver -username username -password password
5. Issue the following command to enable LDAP authentication:
chauthservice -type ldap -enable yes
6. Configure users who do not require Secure Shell (SSH) key access.
SAN Volume Controller users who must use the remote authentication service and do not require SSH
key access should be deleted from the system.
Roles apply to both local and remote users on the system and are based on the user group to which the
user belongs. A local user can only belong to a single group; therefore, the role of a local user is defined
by the single group that the user belongs to. Remote users can belong to one or more groups; therefore,
the roles of remote users are assigned according to the groups that the remote user belongs to.
Procedure
1. Issue the mkusergrp CLI command to create a new user group. For example:
mkusergrp -name group_name -role role_name -remote
where group_name specifies the name of the user group and role_name specifies the role that is
associated with any users that belong to this group. The remote parameter specifies that the group is
visible to the remote authentication service.
The command returns the ID of the user group that was created. To create user groups in the
management GUI, select Access > Users. From the Global Actions menu, select New User Group.
2. Issue the chusergrp CLI command to change attributes of an existing user group. For example:
chusergrp -role role_name -remote yes | no group_id_or_name
where role_name specifies the role that is associated with any users that belong to this group and
group_id_or_name specifies the group to be changed. The remote parameter specifies whether the
group is visible to the authentication server.
where group_id_or_name specifies the group to delete. The force parameter specifies to delete the
group even if there are users in the user group. All users that were assigned to this group are
assigned to the Monitor group.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
To delete a user group in the management GUI, select Access > Users. Select a user group and select
Delete from the Actions menu.
4. Issue the lsusergrp CLI command to display the user groups that have been created on the system.
For example:
lsusergrp usergrp_id_or_name
where group_id_or_name specifies the user group to view. If you do not specify a user group ID or
name, all user groups on the system are displayed.
System users must provide either a password, a Secure Shell (SSH) key, or both. Local users are
authenticated through the authentication methods that are located on the system.
You can create two categories of users that access the clustered system (system). These user types are
based on how they authenticate to the system:
v Some users must provide an SSH password (or if not possible an SSH key).
v If a user needs access to the management GUI, a password is needed for the user.
| v If the user requires access to the command-line interface (CLI), either a valid SSH key file or password
| and SSH key can be used.
v Users must be part of a user group that is defined on the system.
Remote users should also configure local credentials if they need to access the system when the remote
service is down. Remote users have their groups defined by the remote authentication service.
Procedure
1. Issue the mkuser CLI command to create either a local or remote user to access Storwize V7000. For
example:
mkuser -name user_name -remote
where user_name specifies the name of the user. The remote parameter specifies that the user
authenticates to the remote authentication service.
mkuser -name user_name -usergrp group_name_or_id
74 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
where user_name specifies the name of the user and group_name_or_id specifies the name or ID of the
user group with which the local user is associated.
The usergrp parameter specifies that the user authenticate to the system using system authentication
methods.
2. Issue the chuser CLI command to change the attributes of an existing user. For example:
chuser -usergrp group_id_or_name user_id_or_name
where the group_id_or_name specifies the new group for the user and user_id_or_name specifies the
user to be changed.
3. Issue the chcurrentuser CLI command to change the attributes of the current user. For example:
chcurrentuser -nokey
where the nokey parameter specifies that the SSH key of the user is to be deleted.
4. Issue the rmuser CLI command to delete a user: For example:
rmuser user_id_or_name
where user_id_or_name specifies the ID or name of the user view. If you do not specify an ID or name,
the concise view is displayed. If you do not specify a user ID or name, all users on the system are
displayed.
6. Issue the lscurrentuser CLI command to display the name and role of the logged-in user. For
example:
lscurrentuser
The name and the role of the user are displayed.
The notification settings apply to the entire cluster. You can specify the types of events that cause the
cluster to send a notification. The cluster sends a Simple Network Management Protocol (SNMP)
notification. The SNMP setting represents the type of notification.
SNMP is the standard protocol for managing networks and exchanging messages. SNMP enables the
SAN Volume Controller to send external messages that notify personnel about an event. You can use an
SNMP manager to view the messages that the SNMP agent sends.
The possible types of event notifications are error, warning, and information. Event notifications are
reported to the SNMP destinations of your choice. To specify an SNMP destination, you must provide a
valid IP address and SNMP community string.
Note: A valid community string can contain up to 60 letters or digits (most characters). A maximum of
six SNMP destinations can be specified.
In configurations that use SNMP, the SAN Volume Controller uses the notifications settings to call home
if errors occur. You must specify Error and send the trap to the IBM System Storage Productivity Center
or the master console if you want the SAN Volume Controller to call home when errors occur.
Procedure
1. To create a new SNMP server to receive notifications, use the mksnmpserver CLI command. For
example, enter one of the following commands:
mksnmpserver -ip 9.11.255.634
where 9.11.255.634 is the IP addresses for this server.
mksnmpserver -ip 9.11.255.634 -port remoteportnumber
where 9.11.255.634 is the IP addresses for this server and remoteportnumber is the port number for the
remote SNMP server.
2. To change the settings of an existing SNMP server, enter the chsnmpserver command. For example:
chsnmpserver -name newserver snmp_server_name_or_id
where newserver is the new name or ID of the server and snmp_server_name_or_id is the name or ID of
the server to be modified.
3. To remove an existing SNMP server from the system, enter the rmsnmpserver command. For example:
rmsnmpserver snmp_server_name_or_id
where snmp_server_name_or_id is either the name or the ID of the SNMP server to be deleted.
4. To display either a concise list or a detailed view of the SNMP servers that are detected by the cluster,
enter the lssnmpserver command. For example, to display a concise view, enter the following
command:
lssnmpserver -delim :
The syslog protocol is a standard protocol for forwarding log messages from a sender to a receiver on an
IP network. The IP network can be either IPv4 or IPv6. The system can send syslog messages that notify
personnel about an event. The system can transmit syslog messages in either expanded or concise format.
You can use a syslog manager to view the syslog messages that the system sends. The system uses the
User Datagram Protocol (UDP) to transmit the syslog message. You can specify up to a maximum of six
syslog servers.You can use the management GUI or the command-line interface to configure and modify
your syslog settings.
The syslog event notification settings apply to the entire clustered system (system). You can specify the
types of events that cause the system to send a notification. The possible types of notifications are error,
warning, or information.
Note: Servers that are configured with facility values of 0 - 3 receive syslog messages in concise format.
Servers that are configured with facility values of 4 - 7 receive syslog messages in fully expanded format.
To configure and work with notification settings, use the following commands:
76 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Procedure
1. Issue the mksyslogserver CLI command to specify the action that you want to take when a syslog
error or event is logged to the error log. For example, you can issue the following CLI command to
set up a syslog notification:
mksyslogserver mysyslogserver1 -ip 9.11.255.123
where mysyslogserver1 is the name given to the Syslog server definition and 9.11.255.123 is the
external Internet Protocol (IP) address of the syslog server.
2. To modify a syslog notification, issue the chsyslogserver command. For example:
chsyslogserver mysyslogserver1 -ip 9.11.255.123
where mysyslogserver1 is the name given to the Syslog server definition and 9.11.255.123 is the
external IP address of the syslog server.
3. To delete a syslog notification, issue the rmsyslogserver command. For example:
rmsyslogservfer mysyslogserver1 -force
4. To display either a concise list or a detailed view of syslog servers that are configured on the system,
issue the lssyslogserver command. For example, to display a concise view, enter the following
command:
lssyslogserver -delim :
To set up, manage, and activate email event, inventory, and Call Home notifications, complete the
following steps:
Procedure
1. Enable your system to use the email notification function. To do this, issue the mkemailserver CLI
command. Up to six SMTP email servers can be configured to provide redundant access to the
external email network.
This example creates an email server object. It specifies the name, IP address, and port number of the
SMTP email server. After you issue the command, you see a message that indicates that the email
server was successfully created.
mkemailserver -ip ip_address -port port_number
where ip_address specifies the IP address of a remote email server and port_number specifies the port
number for the email server.
2. Add recipients of email event and inventory notifications to the email event notification facility. To do
this, issue the mkemailuser CLI command.
The following example adds email recipient manager2008 and designates that this recipient to receive
email error-type event notifications.
mkemailuser -address manager2008@ibm.com
-error on -usertype local
Note: Inventory information is automatically reported to service personnel when you activate error
reporting.
6. Optionally, test the email notification function to ensure that it is operating correctly and send an
inventory email notification. SAN Volume Controller uses the notifications settings to call home if
errors occur.
v To send a test email notification to one or more recipients, issue the testemail CLI command. You
must either specify all or the user ID or user name of an email recipient that you want to send a
test email to.
v To send an inventory email notification to all recipients that are enabled to receive inventory email
notifications, issue the sendinventoryemail CLI command. There are no parameters for this
command.
v Use the stopemail command to stop the email and inventory notification function. There are no
parameters for this command.
You can specify a server object that describes a remote Simple Mail Transfer Protocol (SMTP) email server
to receive event notifications from the clustered system. You can specify up to six servers to receive
notifications. To configure and work with email servers, use the following commands:
78 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Procedure
1. Issue the mkemailserver CLI command to create an email server object that describes a remote Simple
Mail Transfer Protocol (SMTP) email server. For example, issue the following CLI command to set up
an email server:
mkemailserver -ip ip_address
where ip_address is the IP address of a remote email server. This must be a valid IPv4 or IPv6 address.
2. To change the parameters of an existing email server object, issue the chemailserver command. For
example:
chemailserver -ip ip_address email_server_name_or_id
where ip_address is the IP address of the email server object and email_server_name_or_id is the name or
ID of the server object to be changed.
3. To delete a specified email server object, issue the rmemailserver command. For example:
rmemailserver email_server_name_or_id
4. To display either a concise list or a detailed view of email servers that are configured on the system,
issue the lsemailserver command. For example, to display a concise view, enter the following
command:
lsemailserver -delim :
| Procedure
| Where superuser_password is the new password you want to use for the user superuser.
|
Changing the locale setting using the CLI
You can use the command-line interface (CLI) to specify the locale for a SAN Volume Controller cluster.
The language that you select as your locale setting is used to display command results and error
messages in the CLI.
Issue the setlocale CLI command with the ID for the locale.
| Example
| For example, issue the following CLI command to change the locale setting from US English to Japanese:
| setlocale -locale 3
Procedure
1. Issue the lsdumps command to return a list of dumps in the /dumps/feature destination directory. The
feature log is maintained by the cluster. The feature log records events that are generated when
license parameters are entered or when the current license settings have been breached.
2. Issue the lsdumps command to return a list of the files that exist of the type specified on the given
node.
Procedure
Issue the following CLI command to list error log entries by file type: lseventlog
Results
This command lists the error log entries. You can filter by type; for example, lseventlog -filtervalue
object_type=mdisk displays the error log by managed disks (MDisks).
You can display the whole log or filter the log so that only errors, events, or unfixed errors are displayed.
You can also request that the output is sorted either by error priority or by time. For error priority, the
most serious errors are the lowest-numbered errors. Therefore, the most serious errors are displayed first
in the table. For time, either the older or the latest entry can be displayed first in the output.
80 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
About this task
To power off your Storwize V7000 system, complete the following steps:
This procedure is for upgrading from SAN Volume Controller version 6.1.0 or later. To upgrade from
version 5.1.x or earlier, see the relevant information center or publications that are available at this
website:
www.ibm.com/storage/support/2145
Attention: Before you start an upgrade, you must check for offline or degraded volumes. An offline
volume can cause write data that has been modified to be pinned in the SAN Volume Controller cache.
This prevents volume failover and causes a loss of input/output (I/O) access during the upgrade. If the
fast_write_state is empty, a volume can be offline and not cause errors during the upgrade.
Procedure
1. Download, install, and run the latest version of the Software Upgrade Test Utility to verify that there
are no issues with the current clustered system (system) environment. You can download the most
current version of this tool at the following website:
http://www.ibm.com/support/docview.wss?uid=ssg1S4000585
2. Download the SAN Volume Controller code from the www.ibm.com/storage/support/2145 site.
v If you want to write the SAN Volume Controller code to a CD, you must download the CD image.
v If you do not want to write the SAN Volume Controller code to a CD, you must download the
installation image.
3. Use PuTTY scp (pscp) to copy the upgrade files to the node.
4. Ensure that the upgrade file has been successfully copied.
Before you begin the upgrade, you must be aware of the following:
v The installation process fails under the following conditions:
– If the code that is installed on the remote system is not compatible with the new code or if there
is an intersystem communication error that does not allow the system to check that the code is
compatible.
– If any node in the system has a hardware type that is not supported by the new code.
– If the SAN Volume Controller determines that one or more volumes in the system would be
taken offline by rebooting the nodes as part of the upgrade process. You can find details about
which volumes would be affected by using the lsdependentvdisks command. If you are
prepared to lose access to data during the upgrade, you can use the force flag to override this
restriction.
v The upgrade is distributed to all the nodes in the system by using internal connections between the
nodes.
v Nodes are updated one at a time.
v Nodes will run the new code concurrently with normal system activity.
Note: If a status of stalled_non_redundant is displayed, proceeding with the remaining set of node
upgrades might result in offline volumes. Contact an IBM service representative to complete the
upgrade.
7. To verify that the upgrade successfully completed, issue the lsnodevpd CLI command for each node
that is in the system. The code version field displays the new code level.
Results
When a new code level is applied, it is automatically installed on all the nodes that are in the system.
82 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 4. Overview of the dumps commands
The lsdumps command returns a list of dumps in a particular directory.
Use the lsdumps command with the optional prefix parameter to specify a directory. If you do not
specify a directory, /dumps is used as the default. Use the optional node_id_or_name parameter to specify
the node to list the available dumps for. If you do not specify a node, the available dumps on the
configuration node are listed.
An audit log keeps track of action commands that are issued through an SSH session or from the
management GUI. To list a specified number of the most recently audited commands, issue the
catauditlog command. To dump the contents of the audit log to a file on the current configuration node,
issue the dumpauditlog command. This command also clears the contents of the audit log.
Dumps contained in the /dumps/cimom directory are created by the CIMOM (Common Information Model
Object Manager) that runs on the clustered system (system). These files are produced during normal
operations of the CIMOM.
Dumps that are contained in the /dumps/elogs directory are dumps of the contents of the error and event
log at the time that the dump was taken. An error or event log dump is created by using the dumperrlog
command. This dumps the contents of the error or event log to the /dumps/elogs directory. If no file
name prefix is supplied, the default errlog_ is used. The full default file name is
errlog_NNNNNN_YYMMDD_HHMMSS, where NNNNNN is the node front panel name. If the command
is used with the -prefix parameter, the prefix value is used instead of errlog.
Dumps contained in the /dumps/feature directory are dumps of the featurization log. A featurization log
dump is created by using the dumpinternallog command. This dumps the contents of the featurization
log to the /dumps/feature directory to a file called feature.txt. Only one of these files exists, so every
time the dumpinternallog command is run, this file is overwritten.
Dumps that are contained in the /dumps/iostats directory are dumps of the per-node I/O statistics for
disks on the system. An I/O statistics dump is created by using the startstats command. As part of this
command, you can specify a time interval for the statistics to be written to the file; the default is 15
minutes. Every time the time interval is encountered, the I/O statistics that have been collected are
written to a file in the /dumps/iostats directory. The file names that are used for storing I/O statistics
dumps are Nm_stats_NNNNNN_YYMMDD_HHMMSS, Nv_stats_NNNNNN_YYMMDD_HHMMSS,
Dumps that are contained in the /dumps/iotrace directory are dumps of I/O trace data. The type of data
that is traced depends on the options specified by the settrace command. The collection of the I/O trace
data is started by using the starttrace command. The I/O trace data collection is stopped when the
stoptrace command is used. It is when the trace is stopped that the data is written to the file. The file
name is prefix_NNNNNN_YYMMDD_HHMMSS, where prefix is the value entered for the filename
parameter in the settrace command, and NNNNNN is the node name.
Dumps that are contained in the /dumps/mdisk directory are copies of solid-state drive (SSD) MDisk
internal logs. These dumps are created using the triggerdrivedump command. The file name is
mdiskdump_NNNNNN_MMMM_YYMMDD_HHMMSS, where NNNNNN is the name of the node that
contains the MDisk, and MMMM is the decimal ID of the MDisk.
Software upgrade packages are contained in the /home/admin/upgrade directory. These directories exist on
every node in the system.
Dumps of support data from a disk drive are contained in the /dumps/drive directory. This data can help
to identify problems with the drive, and does not contain any data that applications may have written to
the drive.
Dumps that are contained in the /dumps directory result from application abends. Such dumps are written
to the /dumps directory. The default file names are dump.NNNNNN.YYMMDD.HHMMSS, where NNNNNN
is the node front panel name. In addition to the dump file, there might be some trace files written to this
directory that are named NNNNNN.trc.
Because files can only be copied from the current configuration node (using secure copy), you can issue
the cpdumps command to copy the files from a nonconfiguration node to the current configuration node.
84 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 5. Array commands
Array commands capture information that can assist you with managing arrays.
charray
Use the charray command to change array attributes.
Syntax
charray
-name new_name_arg -sparegoal 0-100 -balanced
mdisk_id
-slowwritepriority latency mdisk_name
redundancy
Parameters
-name
(Optional) The new name to apply to the array MDisk.
-sparegoal 0-100
(Optional) Sets the number of spares to protect the array members with. The value can be a number
between 1 and 100.
-balanced
(Optional) Forces the array to balance and configure the spare goals of the present drives.
-slowwritepriority latency | redundancy
(Optional) Controls array ability to complete write operations that take too long, even if it
temporarily compromises redundancy.
The value can be either latency or redundancy:
v latency implies the feature is enabled for normal I/O operations
v redundancy implies the feature is not enabled for normal I/O operations
The default value is latency mode for existing arrays, unless the array is RAID-0 (in which case
redundancy mode is required).
Description
This command changes an array's attributes.
An invocation example
charray -sparegoal 2 mdisk52
An invocation example
charray -balanced 3
charraymember
Use the charraymember command to modify an array member's attributes, or to swap a member of a
RAID array with that of another drive.
Syntax
charraymember -member member_id -balanced mdisk_id
-newdrive new_drive_id mdisk_name
-immediate -unbalanced
Parameters
-member member_id
Identifies the array member index to operate on.
-balanced
(Optional) Forces the array member spare goals to be set to the:
v Present array member goals
v Existing exchange goals
v The newDrive goals
-newdrive new_drive_id
(Optional) Identifies the drive to add to the array.
-immediate
(Optional) Specifies that the old disk is to be immediately removed from the array, and the new disk
rebuilt. If you do not choose this option, exchange is used; this preserves redundancy during the
rebuild.
-unbalanced
(Optional) Forces the array member to change if the newDrive does not meet array member goals.
mdisk_id
(Either the ID or the name is required.) Identifies which ID array the MDisk command applies to.
mdisk_name
(Either the ID or the name is required.) Identifies which name array the MDisk command applies to.
86 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
This command modifies an array member's attributes, or to swap a member of a RAID array with that of
another drive. Table 13 shows the command combination options.
Table 13. charraymember combination options
Option Description
-balanced v Member goals are set to the properties of the existing member or exchange drive.
v The command will fail if the member is not populated with a drive.
v Member goals are set to the properties of the current member drives being
exchanged into the array count as members.
v If no exchange exists, the existing member drive goals are used.
-newdrive drive_id v The command processes the exchange, and does NOT update the member goals.
v You must specify a new drive that is an exact match for the member goals.
v The command will fail if the drive is not an exact match.
-newdrive drive_id The command processes the exchange and updates the member goals to the
-balanced properties of the new drive.
-newdrive drive_id v The command processes the exchange and does NOT update the member goals.
-unbalanced
v This is only permitted when the array is degraded and the member is empty.
v This means -immediate is mute, the exchange is always immediate.
v Later, if drives are a sufficient member goal match, the array rebalance selects
those drives.
v A balancing exchange restarts the member goals.
An invocation example to force an exchange and make the array change its goals
to the new drive
charraymember -member 3 -newdrive 9 -balanced mdisk5
lsarray
Use the lsarray command to list the array MDisks.
Syntax
lsarray
-filtervalue attribute=value
-unit b
kb
mb
gb
pb
tb
-filtervalue? -bytes mdisk_id
mdisk_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filter attributes matching the specified values; see
-filtervalue? for the supported attributes. Only objects with a value that matches the filter attribute
value are returned. If capacity is specified, the units must also be included. Use the unit parameter to
interpret the value for size or capacity.
Note: Some filters allow the use of a wildcard when entering the command. The following rules
apply to the use of wildcards when using the CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
88 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v When using a wildcard character, you must enclose the filter entry within double quotation marks
(""), as follows:
lsarray -filtervalue "name=md*"
-filtervalue?
(Optional) Includes all of the valid filter attributes in the report. The following filter attributes are
valid for the lsarray command:
v mdisk_id
v mdisk_name
v status
v mode
v mdisk_grp_id
v mdisk_grp_name
v capacity
v fast_write_state
v raid_status
v raid_level
v redundancy
v strip_size
v spare_goal
v spare_protection_min
v balanced
v tier
Any parameters specified with the -filtervalue? parameter are ignored.
| -unit b | kb | mb | gb | pb | tb
| (Optional) Requests output of capacities in bytes (instead of rounded values).
-bytes
(Optional) Requests output of capacities in bytes (instead of rounded values).
mdisk_id
(Optional) The identity of the array MDisk.
mdisk_name
(Optional) The name of the array MDisk.
Description
This command returns a concise list or a detailed view of array MDisks visible to the clustered system
(system).Table 14 provides the attribute values that can be displayed as output view data.
Table 14. MDisk output
Attribute Values
status v online
v offline
v excluded
v degraded (applies only to internal MDisks)
mode unmanaged, managed, image, array
quorum_index 0, 1, 2, or blank if the MDisk is not being used as a quorum disk
block_size 512 bytes (or blank) in each block of storage
90 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Degraded
(Internal MDisks only) The array has members that are degraded, or the raid_status is
degraded.
Offline
All paths to the MDisk are lost.
Excluded
The MDisk is excluded from use by the system; the MDisk port error count exceeded the
threshold.
Syntax
lsarrayinitprogress
-nohdr -filtervalue attribute_value
-filtervalue? -delim delimiter mdisk id
mdisk_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsarraysyncprogress -filtervalue mdisk_id="1*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
v estimated_completion_time
v mdisk_id
v mdisk_name
v progress
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
mdisk_id
(Optional) The identity of the array MDisk.
mdisk_name
(Optional) The user-defined MDisk name.
92 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
This command shows the progress of array background initialization. Table 15 shows possible outputs.
Table 15. lsarrayinitprogress output
Attribute Value
progress The percentage of initialization task that has been completed.
estimated_completion_time The expected initialization task completion time, in YYMMDDHHMMSS format.
lsarraylba
Use the lsarraylba command to permit an array logical block address (LBA) to be found from a drive
and LBA.
Syntax
lsarraylba -drivelba lba -drive drive_id
-delim delimiter
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
Description
This command permits an array LBA to be found on a drive and LBA. Table 16 shows possible outputs.
Table 16. lsarraylba output
Attribute Value
type The type of MDisk extent allocation:
v allocated
v unallocated
mdisk_lba The LBA on the array MDisk (blank if none).
mdisk_start The start of range of LBAs (strip) on the array MDisk (blank if none).
mdisk_end The end of range of LBAs (strip) on the array MDisk (blank if none).
drive_start The start of range of LBAs (strip) on the drive (blank if none).
drive_end The end of range of LBAs (strip) on the drive (blank if none).
lsarraymember
Use the lsarraymember command to list the member drives of one or more array MDisks.
Syntax
lsarraymember
-filtervalue attribute=value -filtervalue?
-delim delimiter mdisk_id mdisk_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filter attributes matching the specified values; see
-filtervalue? for the supported attributes. Only objects with a value that matches the filter attribute
value are returned. If capacity is specified, the units must also be included. Use the unit parameter
to interpret the value for size or capacity.
Note: Some filters allow the use of a wildcard when entering the command. The following rules
apply to the use of wildcards when using the CLI:
v The wildcard character is an asterisk (*).
94 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
v When using a wildcard character, you must enclose the filter entry within double quotation marks
(""), as follows:
lsmdisk -filtervalue "name=md*"
-filtervalue?
(Optional) Includes all of the valid filter attributes in the report. The following filter attributes are
valid for the lsarraymember command:
v mdisk_id
v mdisk_name
v member_id
v drive_id
v new_drive_id
v spare_protection
v balanced
Any parameters specified with the -filtervalue? parameter are ignored.
-delim delimiter
(Optional) By default, in a concise view all columns of data are space-separated, with the width of
each column set to the maximum possible width of each item of data. In a detailed view, each item of
data is an individual row, and if displaying headers, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. Enter -delim : on the command line, and the colon character (:) separates all
items of data in a concise view (for example, the spacing of columns does not occur); in a detailed
view, the specified delimiter separates the data from its header
mdisk_id
(Optional) The identity of the array MDisk.
mdisk_name
(Optional) The MDisk name that you provided.
Description
This command lists the member drives of one or more array MDisks. It describes positions within an
array unoccupied by a drive. The positions determine how mirroring the RAIDs takes place; for example,
determining if x is mirrored to y for RAID-10, where parity starts from RAID-5.
96 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| 2:mdisk2:0:0:::2:exact:0:
| 2:mdisk2:1:2:5::3:exact:2:130103204044
| 2:mdisk2:2:::::::
| 2:mdisk2:3:8:::0:no::
lsarraymembergoals
Use the lsarraymembergoals command to list the spare goals for member drives of one or more array
MDisks.
Syntax
lsarraymembergoals
-filtervalue attribute_value -filtervalue?
-delim delimiter -bytes mdisk_id
mdisk_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsarraymembergoals -filtervalue mdisk_id="1*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
Description
This command lists the spare goals for member drives of one or more array MDisks. Table 18 provides
the potential output for this command.
Table 18. lsarraymembergoals output
Attribute Values
member_id The ID of the array member which represents the drive order in the RAID array.
drive_id The ID of the drive for the member ID (blank if none is configured).
capacity_goal The capacity goal for the array member (same for all members in the array).
tech_type_goal The technology goal for the array member:
v sas_ssd
v sas_hdd
v sas_nearline_hdd
RPM_goal The RPM goal for array member (blank for SSDs).
enclosure_id_goal The ID of the member enclosure goal (blank if any can be selected).
slot_id_goal The ID of the member slot goal.
node_id_goal The node ID of the goal.
98 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example (a four-member RAID 10 SAS array that is split across
chains)
lsarraymembergoals -delim : mdisk_2
lsarraymemberprogress
Use the lsarraymemberprogress command to display array member background process status.
Syntax
lsarraymemberprogress
-nohdr -filtervalue attribute_value
-filtervalue? -delim delimiter mdisk_id
mdisk_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsarraymemberprogress -filtervalue mdisk_id="1*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
v estimated_completion_time
v drive_id
v mdisk_id
v mdisk_name
v member_id
v new_drive_id
v progress
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
mdisk_id
(Optional) The identity of the array MDisk.
mdisk_name
(Optional) The MDisk name that you provided.
Description
This command displays array member background process status. Exchange cannot start on a rebuilding
member because both component rebuild and exchange are shown in the same view. Table 19 provides
the potential output for this command.
Table 19. lsarraymemberprogress output
Attribute Value
member_id The array member index.
drive_id The ID of the drive.
task The identity of task:
v rebuild indicates the array is recovering all the data on the component
(after it was removed)
v exchange indicates the component is copying data to another drive
v resync indicates this member is unsynchronized and is performing write
operations that were completed early
new_drive_id The identity of drive being exchanged.
100 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 19. lsarraymemberprogress output (continued)
Attribute Value
progress The task percentage complete.
estimated_completion_time The expected task completion time in the format YYMMDDHHMMSS. It is blank if
completion time is unknown.
An invocation example
lsarraymemberprogress
lsarraysyncprogress
Use the lsarraysyncprogress command to display how synchronized a RAID array is.
Syntax
lsarraysyncprogress
-nohdr -filtervalue attribute_value
-filtervalue? -delim delimiter mdisk_id
mdisk_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsarraysyncprogress -filtervalue mdisk_id="1*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
v estimated_completion_time
v mdisk_id
v mdisk_name
v progress
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
mdisk_id
(Optional) The ID of the MDisk you want to view.
mdisk_name
(Optional) The user-defined name of the MDisk you want to view.
Description
This command shows you how synchronized a RAID array is. It includes internal activity that is working
toward a fully synchronized array. Table 20 provides the potential output.
Table 20. lsarraysyncprogress output
Attribute Value
progress The percentage of the array that is synchronized.
estimated_completion_time The expected synchronization completion time (YYMMDDHHMMSS; blank if completion
time unknown).
102 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
A concise view (qualified with mdisk id for mdisk2) invocation example
lsarraysyncprogress –delim : mdisk2
A concise view (qualified with mdisk id for in sync mdisk10) invocation example
lsarraysyncprogress –delim : mdisk_10
mkarray
Use the mkarray command to create an MDisk array and add it to a storage pool.
Syntax
mkarray -level raid0 -drive drive_id_list
raid1 -strip 128
raid5 256
raid6
raid10
-sparegoal 0-(MAX_DRIVES-1) -name new_name_arg
mdiskgrp_id
-slowwritepriority latency mdiskgrp_name
redundancy
Parameters
-level
Sets the RAID level for the array MDisk being created.
The following requirements apply for RAID levels:
v RAID-0: Stripes data across all members, provides no redundancy.
v RAID-1: Mirrored pair of drives, allows reading from either drive. Can tolerate either drive failing.
v RAID-5: These arrays stripe data over the member drives with one parity strip on every stripe and
can tolerate no more than one member drive failure.
v RAID-6: These arrays stripe data over the member drives with two parity strips on every stripe
and can tolerate any two concurrent member drive failures.
v RAID-10: These arrays are in a set of up to eight mirrored pairs with the data striped across
mirrors; they can tolerate the failure of one drive in each mirror and they allow reading from both
drives in a mirror.
Restriction: RAID-5 and RAID-6 are for Storwize V7000, Flex V7000 Storage Node, Storwize V3500,
and Storwize V3700 products.
-drive drive_id_list
Identifies the drive or drives to use as members of the RAID array.
| Restriction: This restriction applies to any pair-based array levels for drives located in nodes instead
| of enclosures.
| v RAID-0: All drives in a RAID-0 array of internal drives must be located in the same node.
| v RAID-1: The pair of drives must contain one drive from one node in the I/O group, and one drive
| from the other node.
| v RAID-10: The drives are specified as a sequence of drive pairs. Each pair of drives must contain
| one drive from a node in the I/O group, and a drive from the other node.
-strip 128 | 256
(Optional) Sets strip size (in kilobytes) for the array MDisk being created. The default is 256 KB.
| -sparegoal 0-(MAX_DRIVES-1)
(Optional) Sets the number of spares that this array's members should be protected by. The default is
1 (except for RAID-0 arrays, which have a default of 0).
-name new_name_arg
(Optional) Specifies the name to which you want to apply the array MDisk.
-slowwritepriority latency | redundancy
(Optional) Controls array ability to complete write operations that take too long, even if it
temporarily compromises redundancy.
The value can be either latency or redundancy:
v latency implies the feature is enabled for normal I/O operations
v redundancy implies the feature is not enabled for normal I/O operations
The default value is latency mode for existing arrays, unless the array is RAID-0 (in which case
redundancy mode is required).
Description
This command creates an array MDisk RAID array and adds it to an storage pool. Although the array
tier is automatically determined, you can change it later using the chmdisk command.
104 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example (to create fully redundant arrays)
mkarray -level raid1 -drive 4:5 -strip 128 mdiskgrp_4
recoverarray
Use the recoverarray command to recover a specific corrupt array in a dead domain scenario.
Syntax
recoverarray mdisk_id mdisk_name
Parameters
mdisk_id
(Optional) Identifies (by ID) the specific array to recover.
mdisk_name
(Optional) Identifies (by user-assigned name) the specific array to recover.
Description
This command recovers a specific corrupt array. An array has metadata representing ongoing or pending
platform writes, which are lost when the domain nodes are lost.
An invocation example
recoverarray mdisk_1
recoverarraybycluster (Discontinued)
Attention: The recoverarraybycluster command has been discontinued. Use the recoverarraybysystem
command instead.
recoverarraybysystem
Use the recoverarraybysystem command to recover corrupt arrays in a dead domain scenario.
Syntax
recoverarraybysystem
Parameters
None.
Description
Use the recoverarraybysystem command to recover corrupt arrays in a dead domain scenario.
rmarray
Use the rmarray command to remove an array MDisk from the configuration.
Syntax
| rmarray -mdisk mdisk_id_list mdiskgrp_id
mdisk_name_list -force mdiskgrp_name
Parameters
| -mdisk mdisk_id_list | mdisk_name_list
| Identifies the array MDisk or a colon-delimited list of MDisks to remove from the storage pool.
-force
(Optional) Forces a remove when the MDisk has allocated extents by migrating the used extents to
free extents in the storage pool.
| mdiskgrp_id
| Identifies (by ID) the MDisk group to remove the created array MDisk from.
| mdiskgrp_name
| Identifies (by user-defined name) the MDisk group to remove the created array MDisk from.
Description
This command removes an array MDisk from the configuration. Each array is divided into candidate
drives.
An invocation example
rmarray -mdisk 6 mdiskgrp_10
106 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 6. Audit log commands
An audit log keeps track of action commands that are issued through a Secure Shell (SSH) session or
through the management GUI.
catauditlog
Use the catauditlog command to display the in-memory contents of the audit log.
Syntax
catauditlog
-delim delimiter -first number_of_entries_to_return
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
-first number_of_entries_to_return
(Optional) Specifies the number of most recent entries to display.
This command lists a specified number of the most recently audited commands.
The in-memory portion of the audit log holds approximately 1 MB of audit information. Depending on
the command text size and the number of parameters, this equals 1 MB records or approximately 6000
commands.
Once the in-memory audit log reaches maximum capacity, the log is written to a local file on the
configuration node in the /dumps/audit directory. The catauditlog command only displays the
in-memory part of the audit log; the on-disk part of the audit log is in readable text format and does not
require any special command to decode it.
The in-memory log entries are reset and cleared automatically, ready to accumulate new commands. The
on-disk portion of the audit log can then be analyzed at a later date.
The lsdumps command with -prefix /dumps/auditcan be used to list the files on the disk.
As commands are executed they are recorded in the in-memory audit log. When the in-memory audit log
becomes full it is automatically dumped to an audit log file and the in-memory audit log is cleared.
Use the this command to display the in-memory audit log. Use the dumpauditlog command to manually
dump the contents of the in-memory audit log to a file on the current configuration node and clear the
contents of the in-memory audit log
An invocation example
This example lists the five most recent audit log entries.
catauditlog -delim : -first 5
dumpauditlog
Use the dumpauditlog command to reset or clear the contents of the in-memory audit log. The contents of
the audit log are sent to a file in the/dumps/audit directory on the current configuration node.
Syntax
dumpauditlog
Parameters
Description
This command dumps the contents of the audit log to a file on the current configuration node. It also
clears the contents of the audit log. This command is logged as the first entry in the new audit log.
108 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Audit log dumps are automatically maintained in the /dumps/audit directory. The local file system space
is used by audit log dumps and is limited to 200 MB on any node in the clustered system. The space
limit is maintained automatically by deleting the minimum number of old audit log dump files so that
the /dumps/audit directory space is reduced below 200 MB. This deletion occurs once per day on every
node in the system. The oldest audit log dump files are considered to be the ones with the lowest audit
log sequence number. Also, audit log dump files with a clustered system ID number that does not match
the current one are considered to be older than files that match the system ID, regardless of sequence
number.
Other than by running dumps (or copying dump files among nodes), you cannot alter the contents of the
audit directory. Each dump file name is generated automatically in the following format:
auditlog_firstseq_lastseq_timestamp_systemid
where
v firstseq is the audit log sequence number of the first entry in the log
v lastseq is the audit sequence number of the last entry in the log
v timestamp is the timestamp of the last entry in the audit log that is being dumped
v systemid is the system ID at the time that the dump was created
The audit log dump files names cannot be changed.
The audit log entries in the dump files contain the same information as displayed by the catauditlog
command; however, the dumpauditlog command displays the information with one field per line. The
“lsdumps” on page 208 command displays a list of the audit log dumps that are available on the nodes
in the clustered system.
Use this command to manually dump the contents of the in-memory audit log to a file on the current
configuration node and clear the contents of the in-memory audit log. Use the “catauditlog” on page 107
command to display the in-memory audit log.
An invocation example
dumpauditlog
lsauditlogdumps (Deprecated)
Attention: The lsauditlogdumps command is deprecated. Use the lsdumps command to display a list of
files in a particular dumps directory.
| svcconfig
| Use the svcconfig command help option to obtain summary information about the syntax of the
| svcconfig command and actions. You can enter this command any time after a clustered system (system)
| is created.
| Syntax
| svcconfig backup
-quiet off
-v on
|
| svcconfig clear
-all -q -v on
-quiet off
|
| svcconfig restore
| -f -q -prepare
-force -quiet -fmt
-fmtdisk
-execute
-fmt
-fmtdisk
|
| off
-v on
|
| svcconfig -ver
|
| Parameters
| backup
| (Optional) Saves the current clustered system (system) configuration in the /tmp directory.
| -quiet
| Suppresses standard output (STDOUT) messages from the console.
| clear
| (Optional) Erases the files in the /tmp directory.
| -all
| Erases all configuration files.
| -q | quiet
| Suppresses console output (STDOUT).
| Description
| An invocation example
| svcconfig -ver
| svcconfig -?
| svcconfig backup -h
backup
Use the backup command to back up the configuration. Enter this command any time after creating
clustered system (system).
Syntax
svcconfig backup
-quiet off
-v on
112 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
-quiet
Suppresses standard output (STDOUT) messages from the console.
-v on | off
Displays normal (off, the default state) or verbose (on) command messages.
Description
The backup command extracts and stores configuration information from the system. The backup
command produces the svc.config.backup.xml, svc.config.backup.sh, and svcconfig.backup.log files,
and saves them in the /tmp folder. The .xml file contains the extracted configuration information; the .sh
file contains a script of the commands used to determine the configuration information; and the .log file
contains details about command usage.
The underscore character (_) prefix is reserved for backup and restore command usage; do not use the
underscore character in any object names.
An invocation example
svcconfig backup
clear
Use the clear command to erase files in the /tmp directory that were previously produced by other
svcconfig commands. You can enter this command any time after a clustered system (system) has been
created.
Syntax
svcconfig clear
-all -q -v on
-quiet off
Parameters
-all
Erases all configuration files.
-q | quiet
Suppresses console output (STDOUT).
-v on | off
Produces verbose output (on); the default is regular output (off).
Description
You can use the svcconfig clear command without the -all parameter to erase files of the form:
You can use the svcconfig clear command with the -all parameter to erase files of the form:
/tmp/svc.config*.sh
/tmp/svc.config*.log
/tmp/svc.config*.xml
/tmp/svc.config*.bak
An invocation example
svcconfig clear -all
cron
Use the cron command to back up the configuration. Enter this command any time after creating the
clustered system (system).
Syntax
svcconfig cron
-quiet off
-v on
Parameters
-q, -quiet
Suppresses standard output (STDOUT) messages from the console.
-v on, -v off
Displays normal (off, the default state) or verbose (on) command messages.
Description
This command generates configuration files and places them in the configuration files directory. The file
svc.config.cron.xml_(node) contains configuration detail. The file svc.config.cron.log_(node) contains
a log of events. The file svc.config.cron.sh_(node) contains a script of the commands used to determine
the configuration.
An invocation example
svcconfig cron
svcconfig cron -q
svcconfig cron -v on
recover
Use the recover command to recover the clustered system configuration in two phases, the preparation
phase and the execution phase. This is a component of T3 Recovery.
114 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
svcconfig recover
-f -q -prepare
-force -quiet -execute
off
-v on
Parameters
-execute
(Optional) Runs the command script svc.config.recover.sh and produces a log of events in
svc.config.recover.execute.log.
-f, -force
(Optional) Forces continued processing where possible.
-prepare
(Optional) Verifies the current configuration against the information in svc.config.backup.xml on the
configuration to be recovered. Prepares commands for processing in svc.config.recover.sh, and
produces a log of events in svc.config.recover.prepare.log.
-q, -quiet
(Optional) Suppresses console output (STDOUT).
-v on, -v off
(Optional) Produces verbose output (on); the default is regular output (off).
Description
The recover command recovers the target system configuration from the svc.config.backup.xml file, and
associated .key files (if present) in the configuration files folder.
The recover operation is performed in two phases: prepare and execute. If neither the -prepare nor the
-execute option is specified, the command performs both phases in sequence, producing only a single
event log: svc.config.recover.log.
An invocation example
svcconfig recover -prepare
svcconfig recover -execute
restore
Use the restore command to restore the clustered system (system) to its previous configuration. This
command uses the configuration files in the /tmp folder .
Syntax
svcconfig restore
-f -q -prepare
-force -quiet -fmt
-fmtdisk
-execute
-fmt
-fmtdisk
Chapter 7. Backup and restore commands 115
off
-v on
Parameters
-f | force
(Optional) Forces continued processing where possible.
-q | quiet
(Optional) Suppresses console output (STDOUT).
| -prepare -fmt | fmtdisk
(Optional) Verifies the current configuration against the information in svc.config.backup.xml; then
prepares commands for processing in svc.config.restore.sh, and then produces a log of events in
svc.config.restore.prepare.
-execute
(Optional) Runs the command script svc.config.restore.sh, and produces a log of events in
svc.config.restore.execute.log.
| -fmt
| (Optional) Specifies that the Virtual Disk should be formatted before use. Includes the -fmtdisk
| option on all mkvdisk commands to be issued. You cannot specify -fmt with -execute.
| -fmtdisk
| (Optional) Specifies that the Virtual Disk should be formatted before use. You cannot specify -fmtdisk
| with -execute.
-v on | off
(Optional) Produces verbose output (on); the default is regular output (off).
Description
The restore command restores the target system configuration from the svc.config.backup.xml file in
the /tmp folder. If neither the -prepare nor the -execute option is specified, the command performs both
phases in sequence, producing only a single event log: svc.config.restore.log.
The restore operation is also known as a T4 (Tier 4) Recovery, and should only be used on a system
having just been started. The restore operation should not be used on a system having any nonautomatic
objects configured, such as MDisk groups (storage pools) or VDisks (volumes).
The command pauses for eight minutes if any nodes are added during this process, informing the user of
this at run-time.
An invocation example
svcconfig restore
An invocation example
svcconfig restore -execute
116 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
svcconfig restore -prepare -fmt
Syntax
| addnode -panelname panel_name
| -wwnodename wwnn_arg -name new_name_arg
| -iogrp iogroup_name
| iogroup_id -site site_name_or_id
|
Parameters
-panelname panel_name
(Required if you do not specify the -wwnodename parameter) Specifies the node that you want to
add to a system by the name that is displayed on the display panel. You cannot use this parameter
with the -wwnodename parameter.
-wwnodename wwnn_arg
(Required if you do not specify the -panelname parameter) Specifies the node that you want to add
to the system by the worldwide node name (WWNN). You cannot use this parameter with the
-panelname parameter.
-name new_name_arg
(Optional) Specifies a name for the node that you want to add to the system. You can use this name
in subsequent commands to refer to the node, instead of using the node ID.
Note: Node names supplied with the -name parameter on the addnode and chnode commands must
not already be in use as node names or as node failover_names.
If you assign a name, this name is displayed as the node name from then on. If you do not assign a
name, a default name is used. The default name that is used depends on whether the node is
replacing one that has previously been deleted. When a node is deleted, its name is retained in the
I/O group as the failover name of its partner node. If no nodes remain in an I/O group, no failover
names are retained. Only one failover name can be stored for each node. If you add a node into an
I/O group that has a retained failover name and do not specify a node name, the retained failover
name is assigned to this node. If you do not specify a name and there is no retained failover name,
the name assigned has the format nodeX.
Important: The iSCSI Qualified Name (IQN) for each node is generated using the system and node
names. If you are using the iSCSI protocol and the target name for this node is already active on its
partner node, and iSCSI hosts are attached to it. Adding the node with a different name changes the
IQN of this node in the system and might require reconfiguration of all iSCSI-attached hosts.
-iogrp iogroup_name | iogroup_id
(Required) Specifies the I/O group to which you want to add this node.
| Remember: If the system topology is stretched and the I/O group has a configured node, this new
| node must be in another site location.
Description
Note: The addnode command is a SAN Volume Controller command. For Storwize V7000, use the
addcontrolenclosure command.
This command adds a new node to the system. You can obtain a list of candidate nodes (those that are
not already assigned to a system) by typing lsnodecandidate.
Note: The lsnodecandidate command is a SAN Volume Controller command. For Storwize V7000, use
the lscontrolenclosurecandidate command.
Note: This command is successful only if the node-enclosure system ID matches the system, or is blank.
Before you add a node to the system, you must check to see if any of the following conditions are true. If
the following conditions exist, failure to follow the procedures that are documented here might result in
the corruption of all data that is managed by the system.
v Is the new node being used to replace a failed node in the system?
v Does the node being added to the system use physical node hardware that has been used as a node in
another system, and are both system recognized by the same hosts?
If any of the previous conditions are true, you must take the following actions:
1. Add the node to the same I/O group that it was previously in. You can use the command-line
interface command lsnode or the management GUI to determine the WWNN of the system nodes.
2. Shut down all of the hosts that use the system, before you add the node back into the system.
3. Add the node back to the system before the hosts are restarted. If the I/O group information is
unavailable or it is inconvenient to shut down and restart all of the hosts that use the system, you can
do the following:
a. On all of the hosts that are connected to the system, unconfigure the Fibre Channel adapter device
driver, the disk device driver, and the multipathing driver before you add the node to the system.
b. Add the node to the system, and then reconfigure the Fibre Channel adapter device driver, the
disk device driver, and multipathing driver.
If you are adding a new node to a system, take the following actions:
1. Ensure that the model type of the new node is supported by the SAN Volume Controller of code for
the system. If the model type is not supported by the system code, you must upgrade the system to a
version of code that supports the model type of the new node.
2. Record the node serial number, the WWNN, all WWPNs, and the I/O group to which the node has
been added. You might need to use this information later. Having it available can prevent possible
data corruption if the node must be removed from and re-added to the clustered system.
When you add a node to the system using the addnode command or the system GUI, you must confirm
whether the node has previously been a member of the system. If it has, follow one of these two
procedures:
120 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v Add the node to the same I/O group that it was previously in. You can determine the WWNN of the
nodes in the system using the lsnode command.
v If you cannot determine the WWNN of the nodes in the cluster, call the support team to add the node
back into the system without corrupting the data.
When a node is added to a system, it displays a state of adding. It can take as long as 30 minutes for the
node to be added to the system, particularly if the version of code the node has changed.
Attention: If the node remains in the adding state for more than 30 minutes, contact your support
representative to assist you in resolving this issue.
When a node is deleted, its name is retained in an I/O group as the failover name of its partner node. If
no nodes remain in an I/O group, no failover names are retained.
The addnode command fails if you specify a name that is either an existing node name or a retained
failover name, or if the system has a configuration that exceeds the limits for the node being added.
Specify a different name for the node being added.
An invocation example
addnode -wwnodename 5005076801e08b -iogrp io_grp0
| An invocation example
| addnode -panelname 123456 -iogrp 1 -site 2
chcluster (Discontinued)
Attention: The chcluster command has been discontinued. Use the chsystem command instead.
chsystem
Use the chsystem command to modify the attributes of an existing clustered system. Enter this command
any time after a system has been created. All the parameters that are associated with this command are
optional. However, you must specify one or more parameters with this command.
Syntax
| chsystem
| -name system_name -rcbuffersize new_size_in_MB
|
| -speed fabric_speed -alias id_alias
|
| -icatip icat_console_ip_address -invemailinterval interval
|
| -gmlinktolerance link_tolerance -gmmaxhostdelay max_host_delay
|
|
Chapter 8. Clustered system commands 121
|
| -gminterdelaysimulation inter_system_delay_simulation
|
| -gmintradelaysimulation intra_system_delay_simulation
|
| -icatip ipv4_icat_ip_address -icatip_6 ipv6_icat_ip_address
|
| -ntpip ipv4_ntp_ip_address -ntpip_6 ipv6_ntp_ip_address
|
| -isns sns_server_address -isnsip sns_server_address
|
| -isns_6 ipv6_sns_server_address -isnsip_6 ipv6_sns_server_address
|
| -relationshipbandwidthlimit bandwidth_in_mbps -infocenterurl url
|
| -iscsiauthmethod none -rcauthmethod none
chap chap
|
| -chapsecret chap_secret -compressiondestagemode -layer replication
-nochapsecret storage
|
| -cacheprefetch on -regensslcert -localfcportmask port_mask
off
|
| -partnerfcportmask port_mask -topology standard
stretched
|
Parameters
-name system_name
(Optional) Specifies a new name for the system.
Important: The Internet Small Computer System Interface (iSCSI) Qualified Name (IQN) for each
node is generated using the system and node names. If you are using the Internet Small Computer
System Interface (iSCSI) protocol, changing either name also changes the IQN of all of the nodes in
the system and might require reconfiguration of all iSCSI-attached hosts.
-rcbuffersize new_size_in_MB
(Optional) Specifies the amount of memory, in megabytes (MB), to use on each node for Metro Mirror
and Global Mirror communications, from 48 to 512 MB. The default is 48 MB.
Important: Adjust this setting only when directed by the IBM Support Center.
All nodes in the system must be online and have a minimum of 8 gigabytes (GB), which is 8192
megabytes MB, of memory to change this setting. This parameter operates on the local system only.
Changing this setting is disruptive to Metro Mirror and Global Mirror operations.
Remember: Before changing this setting you must stop all partnerships with this system.
122 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-speed fabric_speed
(Optional) Specifies the speed of the fabric to which this system is attached. Valid values are 1 or 2
(GB).
Attention: Changing the speed on a running system breaks input or output (I/O) service to the
attached hosts. Before changing the fabric speed, stop I/O from active hosts and force these hosts to
flush any cached data by unmounting volumes (for UNIX host types) or by removing drive letters
(for Windows host types). Some hosts might need to be rebooted to detect the new fabric speed.
-alias id_alias
(Optional) Specifies an alternate name that does not change the basic ID for the system, but does
influence the VDisk_UID of every vdiskhostmap, both existing and new. These objects are created for a
system whose ID matches the alias. Therefore, changing the system alias causes loss of host system
access, until each host scans for volumes presented by the system.
-icatip icat_console_ip_address
(Optional) Specifies the new IP address that is used by the system. The format of this IP address
must be a dotted decimal notation with the port; for example, 255.255.255.255:8080. If you specify
this parameter, it overwrites any existing -icatip_6 address.
-invemailinterval interval
(Optional) Specifies the interval at which inventory emails are sent to the designated email recipients.
The interval range is 0 to 15. The interval is measured in days. Setting the value to 0 turns off the
inventory email notification function.
-gmlinktolerance link_tolerance
(Optional) Specifies the length of time, in seconds, for which an inadequate intersystem link is
tolerated for a Global Mirror operation. The parameter accepts values from 20 to 400 seconds in steps
of 10 seconds. The default is 300 seconds. You can disable the link tolerance by entering a value of
zero (0) for this parameter.
-gmmaxhostdelay max_host_delay
(Optional) Specifies the maximum time delay, in milliseconds, at which the Global Mirror link
tolerance timer starts counting down. This threshold value determines the additional impact that
Global Mirror operations can add to the response times of the Global Mirror source volumes. You can
use this parameter to increase the threshold from the default value of 5 milliseconds.
-gminterdelaysimulation inter_system_delay_simulation
| (Optional) Specifies the intersystem delay simulation, which simulates the Global Mirror round trip
| delay between two systems, in milliseconds. The default is 0; the valid range is 0 to 250 milliseconds.
-gmintradelaysimulation intra_system_delay_simulation
| (Optional) Specifies the intrasystem delay simulation, which simulates the Global Mirror round trip
| delay in milliseconds. The default is 0; the valid range is 0 to 250 milliseconds.
-icatip icat_console_ipv4_address
(Optional) Specifies the system's new IPv4 address by the system.
-icatip_6 icat_console_ipv6_address
(Optional) Specifies the system's new IPv6 address. If you specify this parameter, it overwrites any
existing -icatip address. The format of the IPv6 address must be:
v Eight colon-separated groups of four hexadecimal digits; for example:
[1234:1234:abcd:0123:0000:0000:7689:6576]:23
v Eight colon-separated groups of hexadecimal digits with leading zeros omitted; for example:
[1234:1234:abcd:123:0:0:7689:6576]:23
v Suppression of one or more consecutive all 0 groups; for example:
[1234:1234:abcd:123::7689:6576]:23
-ntpip ipv4_ntp_ip_address
(Optional) Specifies the IPv4 address for the Network Time Protocol (NTP) server. Configuring an
Note: Before you specify -ntpip_6, an IPv6 prefix and gateway must be set for the system.
(Optional) Specifies the IPv6 address for the NTP server. Configuring an NTP server address causes
the system to immediately start using that NTP server as its time source. To stop using the NTP
server as a time source, invoke the -ntpip_6 parameter with a zero address, as follows:
chsystem -ntpip_6 0::0
| -isns sns_server_address
| (Optional) Specifies the IPv4 address for the iSCSI storage name service (SNS). To stop using the
| configured IPv4 iSCSI SNS server, specify the -isns parameter with a zero address, as follows:
| chsystem -isns 0.0.0.0
-isnsip sns_server_address
(Optional) Specifies the IPv4 address for the iSCSI storage name service (SNS). To stop using the
configured IPv4 iSCSI SNS server, specify the -isnsip parameter with a zero address, as follows:
chsystem -isnsip 0.0.0.0
| -isns_6 ipv6_sns_server_address
| (Optional) Specifies the IPv6 address for the iSCSI SNS. To stop using the configured IPv6 iSCSI SNS
| server, specify the -isns_6 parameter with a zero address, as follows:
| chsystem -isns_6 0::0
-isnsip_6 ipv6_sns_server_address
(Optional) Specifies the IPv6 address for the iSCSI SNS. To stop using the configured IPv6 iSCSI SNS
server, specify the -isnsip_6 parameter with a zero address, as follows:
chsystem -isnsip_6 0::0
-relationshipbandwidthlimit bandwidth_in_mbps
(Optional) Specifies the new background copy bandwidth in megabytes per second (MBps), from 1 -
1000. The default is 25 MBps. This parameter operates system-wide and defines the maximum
background copy bandwidth that any relationship can adopt. The existing background copy
bandwidth settings defined on a partnership continue to operate, with the lower of the partnership
and volume rates attempted.
Note: Do not set this value higher than the default without establishing that the higher bandwidth
can be sustained.
-infocenterurl url
Specifies the preferred information center URL to override the one used by the GUI. Because this
information is interpreted by the Internet browser, the specified information might contain a
hostname or an IP address.
Remember: View the currently-configured URL in the GUI preferences panel. This panel can also
help reset this value to the default setting.
-iscsiauthmethod none | chap
(Optional) Sets the authentication method for the iSCSI communications of the system:
v chap indicates Internet Small Computer System Interface (iSCSI) authentication is turned on
v none indicates iSCSI partnership authentication is turned off
| -rcauthmethod none | chap
| (Optional) Turns authentication on or off for Remote Copy (RC) partnership requests that are native
| IP partnerships:
| v chap indicates RC authentication is turned on
124 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| v none indicates RC partnership authentication is turned off
-chapsecret chap_secret
(Optional) Sets the Challenge Handshake Authentication Protocol (CHAP) secret to be used to
authenticate the system using iSCSI. This parameter is required if the iscsiauthmethod chap
parameter is specified. The specified CHAP secret cannot begin or end with a space.
| -compressiondestagemode
| (Optional) Sets the compression destage mode.
-nochapsecret
(Optional) Clears any previously set CHAP secret for iSCSI authentication. Thenochapsecret
parameter cannot be specified if chapsecret is specified.
-layer replication | storage
(Optional) Specifies which layer a system resides in. The system can create partnerships with systems
in the same layer.
Note: If you specify -layer you must specify either replication or storage. This option can be used if no
other systems are visible on the fabric, and no system partnerships are defined.
-cacheprefetch on | off
(Optional) Indicates whether cache prefetching is enabled or disabled across the system. Adjust this
only when following direction from the IBM Support Center.
-regensslcert
Regenerates the SSL certificates. Use this option if the SSL certificate expires.
| -localfcportmask port_mask
| (Optional) Indicates the Fibre Channel (FC) input/output (I/O) port mask for local system
| node-to-node communications. The port mask is 64 binary bits and is made up of a combination of
| 0's and 1's, where 0 indicates that the corresponding FC I/O port cannot be used and 1 indicates that
| it can be used. The mask is applied to all nodes in the local system. At least two ports must be
| selected for local system node-to-node communications. The mask must result in at least 2 FC
| connections between each node in the local system, using only the selected ports and FC zones
| visible to those ports. Valid mask values might range from 0011 (only ports 1 and 2 enabled) to
| 1111111111111111111111111111111111111111111111111111111111111111 (all ports enabled). For
| example, a mask of 111111101101 enables ports 1, 3, 4, 6, 7, 8, 9, 10, 11, and 12.
| Remember: A partial mask (fewer than 64 characters) is zero-extended, meaning that any ports not
| specified are not enabled.
| -partnerfcportmask port_mask
| (Optional) Indicates the FC I/O port mask for partnered system-to-system communications. The port
| mask is 64 binary bits and is made up of a combination of 0's and 1's, where 0 indicates that the
| corresponding FC I/O port cannot be used and 1 indicates that it can be used. The mask is applied to
| all nodes in the local system. Valid mask values might range from 0000 (no ports enabled) to
| 1111111111111111111111111111111111111111111111111111111111111111 (all ports enabled). For
| example, a mask of 111111101101 enables ports 1, 3, 4, 6, 7, 8, 9, 10, 11, and 12.
| Remember: A partial mask (fewer than 64 characters) is zero-extended, meaning that any ports not
| specified are not enabled.
| -topology standard | stretched
| (Optional) Indicates the intended system topology, which is either standard or stretched.
Description
This command modifies specific features of a system. Multiple features can be changed by issuing a
single command.
All command parameters are optional, but you must specify at least one parameter.
Use the chsystemip command to modify the system IP address and service IP address.
| Remember: Setting a CHAP secret key for the system does not turn on authentication for iSCSI hosts or
| RC partnerships. Turn off authentication by issuing -iscsiauthmethod or -rciauthmethod.
An invocation example
chsystem -ntpip 9.20.165.16
| To set the local mask to sixty-two 0's and two 1's, indicating FC I/O ports with IDs 1 and 2 are capable of
| local node communication:
| chsystem -localfcportmask 11
| To set the partner mask to sixty-three 0's and one 1, indicating that FC I/O port with ID 2 is capable of
| remote node communication:
| svctask chsystem -partnerfcportmask 0010
126 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| An invocation example to set authentication for RC
| chsystem -chapsecret ABCB1234 -iscsiauthmethod none -rcauthmethod chap
chsystemip
Use the chsystemip command to modify the Internet Protocol (IP) configuration parameters for the
clustered system.
Syntax
chsystemip -clusterip ipv4addr
-gw ipv4addr
-mask subnet_mask -noip -clusterip_6 ipv6addr
-gw_6 ipv6addr -prefix_6 prefix -noip_6
-port system_port
Parameters
-clusterip ipv4addr
(Optional) Changes the IPv4 system IP address. When you specify a new IP address for a system, the
existing communication with the system is broken.
| : The -clusterip parameter cannot be used if there are any active IPv4 partnerships with the system.
-gw ipv4addr
(Optional) Changes the IPv4 default gateway IP address of the system.
-mask subnet_mask
(Optional) Changes the IPv4 subnet mask of the system.
-noip
(Optional) Unconfigures the IPv4 stack on the specified port, or both ports if none is specified.
Note: This parameter does not affect node service address configurations.
-clusterip_6 ipv6addr
(Optional) Sets the IPv6 system address for the port.
| : The -clusterip_6 parameter cannot be used if there are any active IPv6 partnerships with the
| system.
-gw_6 ipv6addr
(Optional) Sets the IPv6 default gateway address for the port.
-prefix_6 prefix
(Optional) Sets the IPv6 prefix.
-noip_6
(Optional) Unconfigures the IPv6 stack on the specified port, or both ports if none is specified.
Description
This command modifies IP configuration parameters for the system. The first time you configure a
second port, all IP information is required. Port 1 on the system must always have one stack fully
configured.
There are two active system ports on the configuration node. There are also two active service ports on
any node in which you are performing a service action.
If the system IP address is changed, the open command-line shell closes during the processing of the
command. You must reconnect to the new IP address if connected through that port.
If there is no port 2 available on any of the system nodes, the chsystemip command fails.
The noip and noip_6 parameters can be specified together only if the port is also specified. The noip and
noip_6 parameters cannot be specified with any parameters other than port.
Note: The noip and noip_6 parameters do not affect node service address configurations.
Port 1 must have an IPv4 or IPv6 system address. The configuration of port 2 is optional.
Service IP addresses for all ports and stacks are initialized to Dynamic Host Configuration Protocol
(DHCP). A service IP address is always configured.
Note: If the console_ip is the same as IP address system port 1, Internet Protocol Version 4 (IPv4)
followed by IPv6, change the console_ip when the system IP is changed. If the console_ip differs from
the system port 1 IP address, do not change the console_ip when the system IP is changed.
Modifying an IP address: List the IP address of the system by issuing the lssystem command. Modify
the IP address by issuing the chsystemip command. You can either specify a static IP address or have the
system assign a dynamic IP address.
An invocation example
chsystemip -clusterip 9.20.136.5 -gw 9.20.136.1 -mask 255.255.255.0 -port 1
128 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
chiogrp
Use the chiogrp command to modify the name of an I/O group, or the amount of memory that is
available for Copy Services or VDisk (volume) mirroring operations.
Syntax
chiogrp
-name new_name
Parameters
-name new_name
(Optional) Specifies the name to assign to the I/O group. The -name parameter cannot be specified
with the -feature, -size, or -kb parameters.
-feature flash | remote | mirror | raid
(Optional) Specifies the feature to modify the amount of memory for Copy Services or volume
mirroring. You must specify this parameter with the -size parameter. You cannot specify this
parameter with the -name parameter.
Note: Specifying remote changes the amount of memory that is available for Metro Mirror or Global
Mirror processing. Any volume that is in a Metro Mirror or Global Mirror relationship uses memory
in its I/O group, including master and auxiliary volumes, and volumes that are in inter-clustered
system (inter-system) or intra-system relationships.
-size memory_size
(Optional) Specifies the amount of memory that is available for the specified Copy Services or
volume mirroring function. Valid input is 0 or any integer. The default unit of measurement for this
parameter is megabytes (MB); you can use the kilobytes -kb parameter to override the default. You
must specify this parameter with the -feature parameter. You cannot specify this parameter with the
-name parameter.
-kb
(Optional) Changes the units for the -size parameter from megabytes (MB) to kilobytes (KB). If you
specify this parameter, the -sizememory_size value must be any number divisible by 4. You must
specify this parameter with the -feature and -size parameters. You cannot specify this parameter
with the -name parameter.
io_group_id | io_group_name
(Required) Specifies the I/O group to modify. You can modify an I/O group by using the -name or
the -feature parameter.
-maintenance yes|no
(Optional) Specifies whether the I/O group should be in maintenance mode. The I/O group should
be placed in maintenance mode while carrying out service procedures on storage enclosures. Once
you enter maintenance mode, it continues until either:
v It is explicitly cleared, OR
v 30 minutes elapse
Description
The chiogrp command modifies the name of an I/O group or the amount of memory that is available for
Copy Services or volume mirroring.
| Use the -feature and -size parameters (together) to change the amount of memory available in the I/O
| group to Flash Copy (FC), Remote Copy (RC), volume mirroring, or RAID. For example:
| chiogrp -feature flash -size 40 0
| You can assign a name to an I/O group or change the name of a specified I/O group. You can change the
amount of memory that is available for Copy Services or volume mirroring operations by specifying the
-feature flash | remote | mirror parameter - and a memory size. For volume mirroring and Copy
Services (Flash Copy®, Metro Mirror, and Global Mirror), memory is traded against memory that is
available to the cache.
The amount of memory can be decreased or increased. Consider the following memory sizes when you
use this command:
v The default amount of memory for FlashCopy® is 20 MB.
v The default amount of memory for Metro Mirror and Global Mirror is 20 MB.
v The default memory size for mirrored volumes is 20 MB.
v The maximum amount of memory that can be specified for Flash Copy® is 512 MB.
v The maximum amount of memory that can be specified for Metro Mirror and Global Mirror is 512 MB.
v The maximum memory size that can be specified for mirrored volumes is 512 MB.
v The maximum combined amount of memory across all features is 552 MB.
Table 22 demonstrates the amount of memory required for volume mirroring and Copy Services. Each 1
MB of memory provides the following volume capacities and grain sizes:
Table 22. Memory required for volume Mirroring and Copy Services
1 MB of memory provides the
following volume capacity for the
Feature Grain size specified I/O group
Metro Mirror and Global Mirror 256 KB 2 TB of total Metro Mirror and
Global Mirror volume capacity
Flash Copy® 256 KB 2 TB of total FlashCopy source
volume capacity
Flash Copy® 64 KB 512 GB of total FlashCopy source
volume capacity
Incremental Flash Copy® 256 KB 1 TB of total Incremental FlashCopy
source volume capacity
Incremental Flash Copy® 64 KB 256 GB of total Incremental
FlashCopy source volume capacity
Volume mirroring 256 KB 2 TB of mirrored volumes
Table 23 on page 131 provides an example of RAID level comparisons with their bitmap memory cost,
where MS is the size of the member drives and MC is the number of member drives.
130 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 23. RAID level comparisons
Approximate bitmap memory
Level Member count Approximate capacity Redundancy cost
RAID-0 1-8 MC * MS None (1 MB per 2 TB of MS) * MC
RAID-1 2 MS 1 (1 MB per 2 TB of MS) *
(MC/2)
RAID-5 3-16 (MC-1) * MS 1 1 MB per 2 TB of MS with a
strip size of 256 KB; double
RAID-6 5-16 less than (MC-2 * MS) 2
with strip size of 128 KB.
RAID-10 2-16 (evens) MC/2 * MS 1 (1 MB per 2 TB of MS) *
(MC/2)
Note: There is a margin of error on the approximate bitmap memory cost of approximately 15%. For example, the
cost for a 256 KB RAID-5 is ~1.15 MB for the first 2 TB of MS.
For multiple Flash Copy® targets, you must consider the number of mappings. For example, for a
mapping with a 256 KB grain size, 8 KB of memory allows one mapping between a 16 GB source volume
and a 16 GB target volume. Alternatively, for a mapping with a 256 KB grain size, 8 KB of memory
allows two mappings between one 8 GB source volume and two 8 GB target volumes.
When you create a Flash Copy® mapping, if you specify an I/O group other than the I/O group of the
source volume, the memory accounting goes towards the specified I/O group, not towards the I/O group
of the source volume.
An invocation example
chiogrp -name testiogrpone io_grp0
Syntax
chnode | chnodecanister
-iscsialias alias -failover
-noiscsialias
object_id
object_name
Parameters
-iscsialias alias
(Optional) Specifies the iSCSI name of the node or node canister. The maximum length is 79
characters.
Note: Node or node canister names supplied with -name on chnode / chnodecanister commands
must not be in use already as node or node canister names or as node or node canister failover
names.
Important: The iSCSI Qualified Name (IQN) for each node or node canister is generated using the
clustered system and node or node canister names. If you are using the iSCSI protocol, changing
either name also changes the IQN of all of the nodes or node canisters in the clustered system and
might require reconfiguration of all iSCSI-attached hosts.
| -site site_or_site_name
| (Optional) Specifies the numeric site value or site name for the existing node. The value is 1, 2, or 3.
| -nosite
| (Optional) Resets the site value.
object_id | object_name
(Required) Specifies the object name or ID that you want to modify. The variable that follows the
parameter is either:
v The object name that you assigned when you added the node to the clustered system
v The object ID that is assigned to the node (not the worldwide node name)
Description
If the failover parameter is not specified, this command changes the name or iSCSI alias of the node or
node canister. The name can then be used to identify the node or node canister in subsequent commands.
The failover parameter is used to specify values that are normally applied to the partner node or node
canister in the I/O group. When the partner node or node canister is offline, the iSCSI alias and IQN are
assigned to the remaining node or node canister in the I/O Group. The iSCSI host data access is then
132 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
preserved. If the partner node or node canister is offline when these parameters are set, the node or node
canister they are set on handles iSCSI I/O requests to the iSCSI alias specified, or the IQN that is created
using the node or node canister name. If the partner node or node canister in the I/O group is online
when these parameters are set, the partner node or node canister handles iSCSI requests to the iSCSI alias
specified, and its node or node canister name and IQN change.
Note: When using VMware ESX, delete the static paths (in the iSCSI initiator properties) that contain the
old target IQN.
This ensures that the node canister name change does not impact iSCSI I/O during events such as a
target failover.
An invocation example
chnode -name testnodeone nodeone
An invocation example
chnodecanister -name testnodeone nodeone
| An invocation example
| chnode -site 1 node2
An invocation example
chnodecanister -site 1 node2
| chsite
| Use the chsite command to change the site name.
| Parameters
| -namesite_name | site_id_or_existing_name
| (Required) Specifies the new or existing name for the site. The new name is the site_name and the
| name of the site being changed is the site_id_or_existing_name.
| Description
| Remember: This command is only applicable when a system is configured as a stretched system by
| issuing the chsystem -topology command.
| In a stretched configuration these are spread across two or more geographic locations or sites:
| v Nodes
| v Storage
| v Host servers
| v Infrastructure
| An invocation example
| chsite -name Quorum 3
Syntax
chnodehw | chnodecanisterhw
-legacy version -force object_id
object_name
Parameters
-legacy version
(Optional) Sets the hardware configuration to make it compatible with the 6.3.0.0 code level. The
format is four decimal numbers separated by periods, and there can be up to sixteen characters.
-force
(Optional) Allow the node to restart and change its hardware configuration even if this will cause
volumes to go offline.
134 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
object_id | object_name
(Optional) Specifies the object name or ID.
Description
This command automatically reboots the node or node canister if the node or node canister hardware is
different than its configured hardware. After rebooting, the node or node canister begins to use its
hardware, and does not use the previous configuration.
Use the -legacy parameter if you want to establish a partnership with another clustered system that is
running an earlier level of code than the local system. The value supplied for the -legacy parameter must
be the code level of the other clustered system.
An invocation example of how to update the node hardware configuration for the
node named node7 (including if the node reboot causes an I/O outage)
chnodehw -force node7
cleardumps
Use the cleardumps command to clear (or delete) the various dump directories on a specified node.
Parameters
-prefix directory_or_file_filter
(Required) Specifies the directory, files, or both to be cleared. If a directory is specified, with no file
filter, all relevant dump or log files in that directory are cleared. You can use the following directory
arguments (filters):
v /dumps (clears all files in all subdirectories)
v /dumps/cimom
v /dumps/configs
v /dumps/elogs
v /dumps/feature
v /dumps/iostats
v /dumps/iotrace
v /dumps/mdisk
v /home/admin/upgrade
In addition to the directory, you can specify a filter file. For example, if you specify
/dumps/elogs/*.txt, all files in the /dumps/elogs directory that end in .txt are cleared.
Note: The following rules apply to the use of wildcards when using the CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard.
v With a wildcard, you must use double quotation marks (" ") around the filter entry, such as in the
following entry:
>cleardumps -prefix "/dumps/elogs/*.txt"
node_id | node_name
(Optional) Specifies the node to be cleared. The variable that follows the parameter is either:
v The node name, that is, the label that you assigned when you added the node to the clustered
system (system)
v The node ID that is assigned to the node (not the worldwide node name).
Description
This command deletes all the files that match the directory/file_filter argument on the specified node.
If no node is specified, the configuration node is cleared.
You can clear all the dumps directories by specifying /dumps as the directory variable.
You can clear all the files in a single directory by specifying one of the directory variables.
You can list the contents of these directories on the given node by using the lsxxxxdumps commands.
You can use this command to clear specific files in a given directory by specifying a directory or file
name. You can use the wildcard character as part of the file name.
136 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: To preserve the configuration and trace files, any files that match the following wildcard patterns
are not cleared:
v *svc.config*
v *.trc
v *.trc.old
An invocation example
cleardumps -prefix /dumps/configs
cpdumps
Use the cpdumps command to copy dump files from a nonconfiguration node onto the configuration node.
Note: In the rare event that the /dumps directory on the configuration node is full, the copy action ends
when the directory is full and provides no indicator of a failure. Therefore, clear the /dumps directory
after migrating data from the configuration node.
Syntax
cpdumps -prefix directory node_name
file_filter node_id
Parameters
-prefix directory | file_filter
(Required) Specifies the directory, or files, or both to be retrieved. If a directory is specified with no
file filter, all relevant dump or log files in that directory are retrieved. You can use the following
directory arguments (filters):
v /dumps (retrieves all files in all subdirectories)
v /dumps/audit
v /dumps/cimom
v /dumps/configs
v /dumps/elogs
v /dumps/feature
v /dumps/iostats
v /dumps/iotrace
v /dumps/mdisk
v /home/admin/upgrade
v (Storwize V7000)/dumps/enclosure
In addition to the directory, you can specify a file filter. For example, if you specified
/dumps/elogs/*.txt, all files in the /dumps/elogs directory that end in .txt are copied.
Note: The following rules apply to the use of wildcards with the CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, you must surround the filter entry with double quotation marks (""), as
follows:
Description
This command copies any dumps that match the directory or file criteria from the given node to the
current configuration node.
You can retrieve dumps that were saved to an old configuration node. During failover processing from
the old configuration node to another node, the dumps that were on the old configuration node are not
automatically copied. Because access from the CLI is only provided to the configuration node, clustered
system files can only be copied from the configuration node. This command enables you to retrieve files
and place them on the configuration node so that you can then copy them.
You can view the contents of the directories by using the lsxxxxdumps commands.
An invocation example
cpdumps -prefix /dumps/configs nodeone
detectmdisk
Use the detectmdisk command to manually rescan the Fibre Channel network for any new managed
disks (MDisks) that might have been added, and to rebalance MDisk access across all available controller
device ports.
Syntax
detectmdisk
Parameters
None
Description
This command causes the clustered system (system) to rescan the Fibre Channel network. The rescan
discovers any new MDisks that have been added to the system and rebalances MDisk access across the
available controller device ports. This command also detects any loss of controller port availability, and
updates the SAN Volume Controller configuration to reflect any changes.
Note: Although it might appear that the detectmdisk command has completed, some extra time might be
required for it to run. The detectmdisk is asynchronous and returns a prompt while the command
continues to run in the background. You can use the lsdiscoverystatus command to list the discovery
status.
138 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
In general, the system automatically detects disks when they appear on the network. However, some
Fibre Channel controllers do not send the required SCSI primitives that are necessary to automatically
discover the new disks.
If you have attached new storage and the system has not detected it, you might need to run this
command before the system detects the new disks.
When back-end controllers are added to the Fibre Channel SAN and are included in the same switch
zone as a system, the system automatically discovers the back-end controller and determines what
storage is presented to it. The SCSI LUs that are presented by the back-end controller are displayed as
unmanaged MDisks. However, if the configuration of the back-end controller is modified after this has
occurred, the system might be unaware of these configuration changes. Run this command to rescan the
Fibre Channel network and update the list of unmanaged MDisks.
Note: The automatic discovery that is performed by the system does not write to an unmanaged MDisk.
Only when you add an MDisk to a storage pool, or use an MDisk to create an image mode virtual disk,
is the storage actually used.
To identify the available MDisks, issue the detectmdisk command to scan the Fibre Channel network for
any MDisks. When the detection is complete, issue the lsmdiskcandidate command to show the
unmanaged MDisks; these MDisks have not been assigned to a storage pool. Alternatively, you can issue
the lsmdisk command to view all of the MDisks.
If disk controller ports have been removed as part of a reconfiguration, the SAN Volume Controller
detects this change and reports the following error because it cannot distinguish an intentional
reconfiguration from a port failure:
1630 Number of device logins reduced
If the error persists and redundancy has been compromised, the following more serious error is reported:
1627 Insufficient redundancy in disk controller connectivity
You must issue the detectmdisk command to force SAN Volume Controller to update its configuration
and accept the changes to the controller ports.
Note: Only issue the detectmdisk command when all of the disk controller ports are working and
correctly configured in the controller and the SAN zoning. Failure to do this could result in errors not
being reported.
An invocation example
detectmdisk
dumpconfig (Discontinued)
Attention: The dumpconfig command is discontinued.
lsclustercandidate (Discontinued)
Attention: The lsclustercandidate command has been discontinued. Use the lspartnershipcandidate
command instead.
lsclusterip (Discontinued)
Attention: The lsclusterip command has been discontinued. Use the lssystemip command instead.
lsclusterstats (Discontinued)
Attention: The lsclusterstats command is discontinued. Use the lssystemstats command instead.
lsdiscoverystatus
Use the lsdiscoverystatus command to determine whether a discovery operation is in progress.
Syntax
lsdiscoverystatus
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays the state of all discoveries in the cluster. During discovery, the system updates
the drive and MDisk records. You must wait until the discovery has finished and is inactive before you
attempt to use the system.This command displays one of the following results:
active There is a discovery operation in progress at the time that the command is issued.
inactive
There are no discovery operations in progress at the time that the command is issued.
If the Fibre Channel functions are used only to enable the nodes to cluster, then the Fibre Channel line
will not be displayed in the lsdiscoverystatus command. The fc_fabric line will only appear if there is at
least one Fibre Channel controller.
140 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
lsdiscoverystatus -delim :
lsfabric
Use the lsfabric command to generate a report that displays the Fibre Channel (FC) connectivity
between nodes, controllers, and hosts.
Syntax
lsfabric
-node node_id_or_name
-port port_id
-wwpn wwpn
-host host_id_or_name
-controller controller_id_or_name
-cluster cluster_id_or_name
Parameters
-node node_id_or_name
(Optional) Displays the output for all ports for the specified node. The only parameter that you can
specify with the -node parameter is the -port parameter.
-port port_id
(Optional) Displays a concise view of all worldwide port names (WWPNs) that are logged into the
specified port ID and node. The -port parameter must be specified with only the -node parameter. A
valid port_id value is from a minimum of one through a maximum equal to the number of node Fibre
Channel (FC) I/O ports. It specifies the port number in the vital product data (VPD) or the
hexadecimal WWPN of the local port.
-wwpn wwpn
(Optional) Displays a list of all ports that have a login to the specified WWPN. You cannot use the
-wwpn parameter with any other parameter.
-host host_id_or_name
(Optional) Specifies a host name or ID. Issuing thelsfabric command with the -host parameter is
equivalent to issuing the lsfabric wwpnwwpn command for every configured WWPN of the specified
host. For example, a host with two ports that are zoned to one port of every node in a eight-node
clustered system (system) produces 16 lines of output. You cannot use the -host parameter with any
other parameter.
-controller controller_id_or_name
(Optional) Specifies a controller ID or name. You cannot use the -controller parameter with any
other parameter in this command. Issuing thelsfabric command with the -controller parameter is
equivalent to issuing the lsfabric wwpn wwpn command for every configured WWPN of the specified
controller. For example, a controller with 4 ports connected to a 8 node system with 2 counterpart
SANs produces 64 lines of output.
-cluster cluster_id_or_name
(Optional) Specifies a system ID or name. You cannot use the -cluster parameter with any other
parameter. Issuing thelsfabric command with the -cluster parameter is equivalent to issuing the
Note: The system must be configured in a remote copy partnership with the local system ; it must
appear in the lssystem view.
Description
The lsfabric command can be issued with any of the parameters to display a limited subset of
information. If the command is issued without any parameters, it provides output for every node.
Remember: The value of the local_port field is the number of the node's Fibre Channel (FC) port.
Note: It can take up to 10 seconds after a command for a controller port to change from inactive
to active. It can take up to 5 minutes after a command for a host port to change from inactive to
active.
| state blocked
| This shows connections that are blocked due to the system's port mask settings.
type One of the following values is displayed:
v host
v node
v controller
v unknown
v nas
You can issue this command to view all the information about the connections that are available to your
system.
Remember: The lsfabric command is limited to displaying 16,384 entries. If you have a large system
configuration that exceeds these limits you must filter the output (for example, by node or node port) to
view all fabric login records.
An invocation example
lsfabric -delim :
The resulting output, in which each row of output contains the following colon-separated columns:
142 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
remote_wwpn:remote_nportid:id:node_name:local_wwpn:
local_port:local_nportid:state:name:cluster_name:type
| An invocation example that shows unused (because the system's mask settings
| are blocked) node logins
| lsfabric -delim :
lshbaportcandidate (Discontinued)
This command is discontinued. Use the either lsfcportcandidate or lssasportcandidate command
instead. Use the lshbaportcandidate command to list the unconfigured, logged-in host bus adapter
(HBA) ports.
lsfcportcandidate
Use the lsfcportcandidate command to list the Fibre Channel (FC) ports. This information is used to
find open FC ports.
Syntax
lsfcportcandidate
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
Note: The lsfcportcandidate command presents a list of host FC ports that are logged in to nodes.
However, there are situations when the information that is presented might include host FC ports that are
no longer logged in or even part of the SAN fabric. For example, if a host FC port is unplugged from a
An invocation example
lsfcportcandidate
lssasportcandidate
Use the lssasportcandidate command to list the unconfigured serial-attached SCSI (SAS) ports logged in
and available to add to the SAS world-wide port name (WWPN) or host objects.
Syntax
lssasportcandidate
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
Note: The lssasportcandidate command presents a list of host SAS ports that are logged in to nodes.
However, there are situations when the list might include host SAS ports that are no longer logged in or
even part of the SAN fabric. For example, if a host SAS port is unplugged from a switch but
144 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lssasportcandidate shows the WWPN that is logged in to all nodes, the incorrect entry is removed when
another device is plugged in to the same switch port that previously contained the removed host SAS
port.
An invocation example
lssasportcandidate
lsiogrp
Use the lsiogrp command to display a concise list or a detailed view of input/ouput (I/O) groups
visible to the clustered system (system).
The list report style can be used to obtain the following two styles of report:
v A list containing concise information about all the I/O groups that are visible to the system. Each entry
in the list corresponds to a single I/O group.
v The detailed information about a single I/O group.
Syntax
lsiogrp
-filtervalue attribute=value -nohdr
-delim delimiter -filtervalue? -bytes object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcard characters when using the CLI:
v The wildcard character is an asterisk (*), which must be the first or last character in the string.
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""), as follows:
lsiogrp -filtervalue "name=md*"
Description
This command returns a concise list or a detailed view of I/O groups visible to the system.
146 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
id:name:node_count:vdisk_count:host_count
0:io_grp0:1:0:0
1:io_grp1:0:0:0
2:io_grp2:0:0:0
3:io_grp3:0:0:0
4:recovery_io_grp:0:0:0
lsiogrphost
Use the lsiogrphost command to display a list of the hosts mapped to a specified I/O group.
Syntax
lsiogrphost
-nohdr -delim delimiter iogrp_id
iogrp_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
The lsiogrphost command displays a list of hosts that are mapped to a specified I/O group.
An invocation example
lsiogrphost -delim : 0
lsiogrpcandidate
Use the lsiogrpcandidate command to list the I/O groups that can have nodes added to them.
Syntax
lsiogrpcandidate
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The lsiogroupcandidate command displays a list of I/O groups to which nodes can be added. Only the
I/O group IDs are displayed.
An invocation example
lsiogrpcandidate
148 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lsiostatsdumps (Deprecated)
Attention: The lsiostatsdumps command is deprecated. Use the lsdumps command to display a list of
files in a particular dumps directory.
lsiotracedumps (Deprecated)
Attention: The lsiotracedumps command is deprecated. Use the lsdumps command to display a list of
files in a particular dumps directory.
The list report style can be used to obtain two styles of report:
v A list containing concise information about all the nodes or node canister on a system. Each entry in
the list corresponds to a single node or node canister.
v The detailed information about a single node or node canister.
Syntax
lsnode | lsnodecanister
-filtervalue attribute=value -nohdr
-delim delimiter -filtervalue? object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the Command-Line Interface (CLI):
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard.
v When using a wildcard, you must enclose the filter entry within double quotation marks (""):
lsnode -filtervalue "name=md*"
-filtervalue?
Displays a list of valid filter attributes for the -filtervalueattribute=value parameter. The valid filters
for the lsnode command are:
v id
v status
v IO_group_name
v IO_group_id
v name
v hardware
v config_node/config_nodecanister
v iscsi_alias
Description
This command returns a concise list or a detailed view of nodes or node canisters that are part of the
system. Table 26 provides the possible values that are applicable to the attributes that are displayed as
data in the output views.
Table 26. lsnode or lsnodecanister attribute values
Attribute Value
status offline | service | flushing | pending | online | adding | deleting
config_node no | yes
port_status active | inactive | not installed
hardware The machine model number (for example, CG8 or 8A4).
UPS_serial_number The serial number of the UPS.
UPS_unique_id The unique ID of the UPS.
panel_name The unique identifier for the node.
enclosure_id Blank.
canister_id Blank.
enclosure_serial_number Blank.
service_IP_mode Current mode of the service IPv4
v Empty if IPv4 is not active
v One of the following:
– static (if the service IP is set by the user)
– dhcp (if the service IP is set successfully using DHCP server)
– dhcpfallback (if the service IP is set to a default value after a DHCP server
request failed)
150 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 26. lsnode or lsnodecanister attribute values (continued)
Attribute Value
service_IP_mode_6 Current mode of the service IPv6
v Empty if IPv6 is not active
v Either static (if the service IP is set by the user) or dhcp (if the service IP set
successfully using DHCP server).
| site_id Indicates the site node value.
| site_name Indicates the site name.
The first four Fibre Channel (FC) input/output (I/O) ports display the worldwide port name (WWPN),
state, and speed. If there are less than four FC I/O ports, the fields display with a WWPN of
0000000000000000, port_status of inactive, and port_speed of N/A. To examine the FC ports, use the
lsportfc command.
A concise invocation example for Storwize V7000, Flex V7000 Storage Node,
Storwize V5000, Storwize V3500, and Storwize V3700
lsnodecanister -delim ,
| hardware,8A4
iscsi_name,iqn.1986-03.com.ibm:2145.ldcluster-19.hlcn114289
iscsi_alias,
failover_active,no
failover_name,hlcn114253
failover_iscsi_name,iqn.1986-03.com.ibm:2145.ldcluster-19.hlcn114253
failover_iscsi_alias,
panel_name,114289
enclosure_id,
canister_id,
enclosure_serial_number,
service_IP_address,9.180.29.52
service_gateway,9.180.28.1
service_subnet_mask,255.255.254.0
service_IP_address_6,
service_gateway_6,
service_prefix_6,
| site_id,1
| site_name,DataCenterA
A detailed invocation example for Storwize V7000, Flex V7000 Storage Node,
Storwize V3500, and Storwize V3700
lsnodecanister -delim , 1
152 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
port_id,5005076801102978
port_status,active
port_speed,4Gb
port_id,5005076801202978
port_status,active
port_speed,4Gb
hardware,DH8
iscsi_name,iqn.1986-03.com.ibm:2145.ldcluster-19.hlcn114289
iscsi_alias,
failover_active,no
failover_name,hlcn114253
failover_iscsi_name,iqn.1986-03.com.ibm:2145.ldcluster-19.hlcn114253
failover_iscsi_alias,
panel_name,114289
enclosure_id,
canister_id,
enclosure_serial_number,
service_IP_address,9.180.29.52
service_gateway,9.180.28.1
service_subnet_mask,255.255.254.0
service_IP_address_6,
service_gateway_6,
service_prefix_6,
service_IP_mode,dhcpfallback
service_IP_mode_6
identify_LED,on
site_id,1
site_name,DataCenterA
Syntax
lsnodecandidate
-nohdr -delim delimiter -svcconfig
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: The lsnodecandidate command is a SAN Volume Controller command. For Storwize V7000, use
the lscontrolenclosurecandidate command.
This command displays a list of nodes that are available to add to the clustered system. This includes
nodes that are not already part of a clustered system, but are compatible with the clustered system code
level. Nodes with hardware types that are incompatible with the installed code are not listed.
An invocation example
lsnodecandidate -delim :
lsnodedependentvdisks (Deprecated)
Attention: The lsnodedependentvdisks command is deprecated. Use the lsdependentvdisks command
instead.
Syntax
lsnodehw | lsnodecanisterhw object_id
-delim delimiter object_name
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
object_id | object_name
(Required) Specifies the object name or ID.
154 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
Table 28 provides the possible values that are applicable to the attributes that are displayed as data in the
output views.
Table 28. Attribute values for lsnodehw and lsnodecanisterhw
Attribute Value
id The node or node canister unique ID.
name The node or node canister name.
status The node or node canister status.
IO_group_id The input/output (I/O) group ID.
IO_group_name The I/O group name.
hardware The hardware model.
actual_different Indicates if the node or node canister hardware is different from the configured
hardware.
actual_valid Indicates if the node or node canister hardware is valid.
memory_configured The configured amount of memory (in GB).
member_actual The currently installed amount of memory (in GB).
memory_valid Indicates if the actual memory is a valid configuration.
cpu_count The maximum number of CPUs for the node.
cpu_socket The ID of socket the CPU fields refer to.
cpu_configured The configured CPU for this socket.
cpu_actual The currently installed CPU in this socket.
cpu_valid Indicates if the currently installed CPU is a valid configuration.
adapter_count The maximum number of adapters for the node (differs by node type).
adapter_location The location of this adapter.
adapter_configured The configured adapter for this location.
adapter_actual The currently installed adapter for this location.
adapter_valid Indicates if the adapter in this location is valid.
ports_different Indicates if the current hardware is able to provide more I/O ports? The values are
yes and no.
An invocation example for Storwize V7000, Flex V7000 Storage Node, Storwize
V5000, Storwize V3500, and Storwize V3700
lsnodecanisterhw -delim , 1
Syntax
| lsnodestats
| lsnodecanisterstats -delim delimiter
|
| -filtervalue attribute=value -filtervalue?
|
| -history stat_list node_or_nodecanister_id
node_or_nodecanister_name
|
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
156 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view. (For example, the spacing of columns does not occur.) In a detailed
view, the data is separated from its header by the specified delimiter.
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsenclosurestats -filtervalue stat_name=temp_f
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue attribute=value parameter:
v node_id
v node_name
v stat_name
-history stat_list
(Optional) Provides a table of statistical values for the specified node. The stat_list is a
colon-delimited list of one or more statistical values. A table is generated for each entry in the
stat_list.
Description
This command returns a concise list or a detailed view of nodes or node canisters that are part of the
clustered system. Table 29 provides the possible values that are applicable to the attributes that are
displayed as data in the output views.
Table 29. Attribute values for lsnodestats or lsnodecanister
Attribute Value
node_id The ID of the node or node canister.
node_name The name of the node or node canister.
stat_current The current value of the statistic field.
stat_list The system history of the reported statistics. The list of statistics can contain multiple
items separated by colons.
stat_name The name of the statistic field. See Table 30 on page 162 for descriptions of available
statistics.
stat_peak The peak value of the statistic field in the last five minutes.
stat_peak_time The time that the peak occurred.
sample_time The time of the sample occurrence.
stat_value The statistical value at the epoch interval.
An invocation example
lsnodestats
158 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
2 node2 vdisk_w_mb 112 134 111123105349
2 node2 vdisk_w_io 662 805 111123105504
2 node2 vdisk_w_ms 100 104 111123105624
2 node2 mdisk_r_mb 20 21 111123105809
2 node2 mdisk_r_io 951 1330 111123105739
2 node2 mdisk_r_ms 2 7 111123105529
2 node2 mdisk_w_mb 112 134 111123105349
2 node2 mdisk_w_io 684 834 111123105504
2 node2 mdisk_w_ms 16 36 111123105619
2 node2 drive_r_mb 17 132 111123105619
2 node2 drive_r_io 899 1920 111123105619
2 node2 drive_r_ms 6 12 111123105344
2 node2 drive_w_mb 171 206 111123105504
2 node2 drive_w_io 1837 2230 111123105504
2 node2 drive_w_ms 11 26 111123105619
An invocation example of an historical view that can list multiple statistics and
requires a node-based invocation
lsnodestats -history cpu_pc:fc_mb:sas_mb node1
An invocation example
lsnodecanisterstats
160 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
2 node2 vdisk_r_io 796 1180 111123105739
2 node2 vdisk_r_ms 2 8 111123105529
2 node2 vdisk_w_mb 112 134 111123105349
2 node2 vdisk_w_io 662 805 111123105504
2 node2 vdisk_w_ms 100 104 111123105624
2 node2 mdisk_r_mb 20 21 111123105809
2 node2 mdisk_r_io 951 1330 111123105739
2 node2 mdisk_r_ms 2 7 111123105529
2 node2 mdisk_w_mb 112 134 111123105349
2 node2 mdisk_w_io 684 834 111123105504
2 node2 mdisk_w_ms 16 36 111123105619
2 node2 drive_r_mb 17 132 111123105619
2 node2 drive_r_io 899 1920 111123105619
2 node2 drive_r_ms 6 12 111123105344
2 node2 drive_w_mb 171 206 111123105504
2 node2 drive_w_io 1837 2230 111123105504
2 node2 drive_w_ms 11 26 111123105619
An invocation example of an historical view that can list multiple statistics and
requires a node-based invocation
lsnodecanisterstats -history cpu_pc:fc_mb:sas_mb node1
The following table provides the possible values that are applicable to the values that are displayed for
the stat_name attribute.
Table 30. Stat_name field values
Value Description
compression_cpu_pc Displays the percentage of allocated CPU capacity utilized for compression.
cpu_pc Displays the percentage of allocated CPU capacity utilized for the system.
fc_mb Displays the total number of megabytes transferred per second for Fibre Channel
traffic on the system. This value includes host I/O and any bandwidth that is used
for communication within the system.
fc_io Displays the total input/output (I/O) operations transferred per seconds for Fibre
Channel traffic on the system. This value includes host I/O and any bandwidth that
is used for communication within the system.
sas_mb Displays the total number of megabytes transferred per second for serial-attached
SCSI (SAS) traffic on the system. This value includes host I/O and bandwidth that is
used for background RAID activity.
sas_io Displays the total I/O operations transferred per second for SAS traffic on the
system. This value includes host I/O and bandwidth that is used for background
RAID activity.
iscsi_mb Displays the total number of megabytes transferred per second for iSCSI traffic on the
system.
iscsi_io Displays the total I/O operations transferred per second for iSCSI traffic on the
system.
write_cache_pc Displays the percentage of the write cache usage for the node.
total_cache_pc Displays the total percentage for both the write and read cache usage for the node.
vdisk_mb Displays the average number of megabytes transferred per second for read and write
operations to volumes during the sample period.
vdisk_io Displays the average amount of I/O operations transferred per second for read and
write operations to volumes during the sample period.
vdisk_ms Displays the average amount of time in milliseconds that the system takes to respond
to read and write requests to volumes over the sample period.
mdisk_mb Displays the average number of megabytes transferred per second for read and write
operations to MDisks during the sample period.
mdisk_io Displays the average amount of I/O operations transferred per second for read and
write operations to MDisks during the sample period.
mdisk_ms Displays the average amount of time in milliseconds that the system takes to respond
to read and write requests to MDisks over the sample period.
drive_mb Displays the average number of megabytes transferred per second for read and write
operations to drives during the sample period
drive_io Displays the average amount of I/O operations transferred per second for read and
write operations to drives during the sample period.
drive_ms Displays the average amount of time in milliseconds that the system takes to respond
to read and write requests to drives over the sample period.
vdisk_w_mb Displays the average number of megabytes transferred per second for read and write
operations to volumes during the sample period.
162 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 30. Stat_name field values (continued)
Value Description
vdisk_w_io Displays the average amount of I/O operations transferred per second for write
operations to volumes during the sample period.
vdisk_w_ms Displays the average amount of time in milliseconds that the system takes to respond
to write requests to volumes over the sample period.
mdisk_w_mb Displays the average number of megabytes transferred per second for write
operations to MDisks during the sample period.
mdisk_w_io Displays the average amount of I/O operations transferred per second for write
operations to MDisks during the sample period.
mdisk_w_ms Displays the average amount of time in milliseconds that the system takes to respond
to write requests to MDisks over the sample period.
drive_w_mb Displays the average number of megabytes transferred per second for write
operations to drives during the sample period
drive_w_io Displays the average amount of I/O operations transferred per second for write
operations to drives during the sample period.
drive_w_ms Displays the average amount of time in milliseconds that the system takes to respond
write requests to drives over the sample period.
vdisk_r_mb Displays the average number of megabytes transferred per second for read operations
to volumes during the sample period.
vdisk_r_io Displays the average amount of I/O operations transferred per second for read
operations to volumes during the sample period.
vdisk_r_ms Displays the average amount of time in milliseconds that the system takes to respond
to read requests to volumes over the sample period.
mdisk_r_mb Displays the average number of megabytes transferred per second for read operations
to MDisks during the sample period.
mdisk_r_io Displays the average amount of I/O operations transferred per second for read
operations to MDisks during the sample period.
mdisk_r_ms Displays the average amount of time in milliseconds that the system takes to respond
to read requests to MDisks over the sample period.
drive_r_mb Displays the average number of megabytes transferred per second for read operations
to drives during the sample period
drive_r_io Displays the average amount of I/O operations transferred per second for read
operations to drives during the sample period.
drive_r_ms Displays the average amount of time in milliseconds that the system takes to respond
to read requests to drives over the sample period.
Syntax
lsnodevpd | lsnodecanistervpd
-nohdr -delim delimiter
object_id
object_name
Description
This command displays the VPD for the specified node or node canister. Each field is reported on a new
line. All fields are strings. The VPD is split into sections. Each section has a section heading. The number
of fields in that section follows each heading. Each section is separated by an empty line.
For example:
Some sections contain information about multiple objects of that type. Each object within the section is
separated by an empty line.
For example:
object2 field1:value
object2 field2:value
Note: For 8F4, 8G4, and 8A4 nodes, the VPD displays the device serial number of the Fibre Channel card
as N/A.
164 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example for SAN Volume Controller
lsnodevpd 1
processor: 6 fields
part_number 46D1266
processor_location Processor 1
manufacturer Intel(R) Corporation
version Intel(R) Xeon(R) CPU E5530 @ 2.40GHz
speed 2400
status Enabled
memory module: 96 fields
part_number 44T1493
device_location DIMM01
bank_location BANK01
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM02
bank_location BANK02
size (MB) 4096
manufacturer Samsung
serial_number 99062848
part_number 44T1493
device_location DIMM03
bank_location BANK03
size (MB) 4096
manufacturer Samsung
serial_number C7062848
part_number 44T1493
device_location DIMM04
bank_location BANK04
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM06
bank_location BANK06
size (MB) 4096
manufacturer Hynix
serial_number 2AF41112
part_number 44T1493
device_location DIMM07
bank_location BANK07
size (MB) 4096
manufacturer Hynix
serial_number D128312E
part_number 44T1493
device_location DIMM08
bank_location BANK08
size (MB) 4096
manufacturer Hynix
serial_number D028C12E
part_number 44T1493
device_location DIMM09
bank_location BANK09
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM10
bank_location BANK10
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM11
bank_location BANK11
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM12
bank_location BANK12
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM13
bank_location BANK13
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM14
bank_location BANK14
166 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM15
bank_location BANK15
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
part_number 44T1493
device_location DIMM16
bank_location BANK16
size (MB) No Module Installed
manufacturer Not Specified
serial_number Not Specified
fan: 12 fields
part_number 43V6929
location location1
part_number 43V6929
location location2
part_number 43V6929
location location3
part_number 43V6929
location location4
part_number 43V6929
location location5
part_number 43V6929
location location6
part_number 31P1338
manufacturer JDSU
device PLRXPLVCSH423N
serial_number C945VK0KU
supported_speeds 2,4,8 Gbps
connector_type LC
part_number 31P1338
manufacturer JDSU
device PLRXPLVCSH423N
serial_number C945VK0KT
supported_speeds 2,4,8 Gbps
connector_type LC
transmitter_type SN
wavelength 850
max_distance_by_cable_type OM1:20,OM2:50,OM3:150
hw_revision 2
port_number 3
part_number 31P1338
manufacturer JDSU
device PLRXPLVCSH423N
serial_number C945VK0RA
supported_speeds 2,4,8 Gbps
connector_type LC
transmitter_type SN
wavelength 850
max_distance_by_cable_type OM1:20,OM2:50,OM3:150
hw_revision 2
port_number 4
part_number Unknown
manufacturer N/A
device N/A
serial_number N/A
supported_speeds 10,100 Mbps,1 Gbps
connector_type N/A
transmitter_type N/A
wavelength N/A
max_distance_by_cable_type N/A
hw_revision N/A
port_number 2
168 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
card_type Ethernet
part_number 31P1559
port_numbers 3 4
location 2
device_serial_number BT05149496
manufacturer Emulex Corp
device Emulex/OneConnect 10Gb NIC (be3)
card_revision 1.0
chip_revision 0.2
part_number 31P1549
manufacturer JDSU
device PLRXPLSCS4321N
serial_number C825UB0D2
supported_speeds 10 Gbps
connector_type LC
transmitter_type 10G Base-SR
wavelength 850
max_distance_by_cable_type OM1:30,OM2:80,OM3:300
hw_revision 1
port_number 4
device: 24 fields
part_number 31P1339
bus USB
device 0
model IBM USB Endeavour
revision 1.1
serial_number NA
approx_capacity 0
hw_revision 0
part_number 42D0673
bus scsi
device 0
model MBE2073RC
revision SC13
serial_number D3A01C0HSC13SC13SC1
approx_capacity 68
hw_revision
part_number N/A
bus scsi
device 0
model STEC USB 2.0
revision 1113
serial_number NA
approx_capacity 1
hw_revision
An invocation example for Storwize V7000, Flex V7000 Storage Node, Storwize
V5000, Storwize V3500, and Storwize V3700
lsnodecanistervpd 1
id 1
processor: 6 fields
processor_location Processor 1
manufacturer Intel(R) Corporation
version Intel(R) Xeon(R) CPU E5530 @ 2.40GHz
speed 2400
status Enabled
CPU_part_number 46D1266
part_number 44T1493
device_location DIMM02
bank_location BANK02
size (MB) 4096
manufacturer Samsung
serial_number 99062848
part_number 44T1493
device_location DIMM03
bank_location BANK03
size (MB) 4096
170 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
manufacturer Samsung
serial_number C7062848
...
fan: 12 fields
part_number 43V6929
location location1
part_number 43V6929
location location2
part_number 43V6929
location location3
...
device: 15 fields
part_number 31P1339
bus USB
device 0
model IBM USB Endeavour
revision 1.0
serial_number NA
approx_capacity 0
hw_revision 0
part_number 42D0673
bus scsi
device 0
model ST973452SS
revision B623
serial_number 3TA00BZ20109B623
software: 8 fields
code_level 5.1.0.0 (build 16.1.0906240000)
nodecanister_name nodecanister1
ethernet_status 1
ethernet_status 0
WWNN 0x500507680100350d
id 1
MAC_address 00 21 5e 09 09 08
MAC_address 00 21 5e 09 09 0a
UPS: 10 fields
electronics_assembly_part_number 64P8326
battery_part_number 31P0710
UPS_assembly_part_number 64P8326
input_power_cable_part_number CountryDependent
UPS_serial_number 100084O050
UPS_type 2145UPS 1U
UPS_internal_part_number P31P0875
UPS_unique_id 0x20400002047c0140
UPS_main_firmware 1.02
UPS_comms_firmware 1.20
...
lsportip
Use the lsportip command to list the Internet Small Computer Systems Interface (iSCSI) Internet
Protocol (IP) addresses assigned for each port on each node in the clustered system.
Syntax
lsportip
-filtervalue attribute=value -filtervalue? -nohdr
-delim delimiter ethernet_port_id
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
v When using a wildcard, enclose the filter entry within double quotation marks (""), as follows:
lsportip -filtervalue "node_name=md*"
172 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-filtervalue?
(Optional) Displays the valid filter attributes. The following filter attributes for the lsportip
command are valid:
v id
v node_id
v node_name
v state
v failover
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command lists all port IP addresses for each node in the clustered system. The concise view displays
two rows of output for each ethernet port. Each node has two Ethernet ports.
Use the lsportip command with the optional ethernet_port_id parameter to display a detailed view of
the specified port.
Both output rows for a port show the MAC address of that port if it can be determined. If the node and
the ethernet link are online, the rows also show the speed and duplex state of the link. The duplex field
can have values of Half or Full, or it is blank if the node is offline.
The first row for each port shows any Internet Small Computer System Interface, an Internet Protocol
(iSCSI) addresses that have been configured for that port and are not failed over to a different node. The
failover field on this row is set to no. The second row for each port shows any iSCSI addresses that have
been configured for the partner node, or for the local node with failover, and that are active on the port.
The failover field on this row is set to yes.
The state field is set to unconfigured if there are no iSCSI addresses configured on the port. The state
field is set to offline if there are configured addresses but the link is down, and online if the link is up.
Any offline rows indicate a potential problem.
This command enables you to view information about system port status.
In the examples below (which list different port configuration options) there are two lines for each
possible ethernet port, which represent the port and iSCSI behavioral effects. Port indices are assigned
statically, and higher indices are used for optional ports. In the example for the two-node or two-node
canister system (of 8A4 nodes), port 1 configuration node 1 compels the failover to come online. The
partner port on the other node, port 1 on node 3, also comes online. Consequently, this port assumes the
IP address if port 1 node 1 fails.
174 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
1:6:destiny34:::::::00:21:5e:09:21:54:Full:online:100Mb/s:yes
2:6:destiny34:::::::00:21:5e:09:21:56::unconfigured::no
2:6:destiny34:::::::00:21:5e:09:21:56::unconfigured::yes
lsportfc
Use the lsportfc command to view the status and properties of the system's Fibre Channel (FC)
input/output (I/O) ports.
Syntax
lsportfc
-filtervalue attribute=value -filtervalue? -nohdr
176 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-delim delimiter object_id
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
-filtervalue?
(Optional) Displays the valid filter attributes. The following filter attributes for the lsportfc
command are valid:
v type
v status
v node_id
v fc_io_port_id
v attachment
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command enables you to view information about system port status.
Table 32 provides the attribute values that can be displayed as output view data.
178 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
port_speed 10Gb
node_id 6
node_name node3
WWPN 50050768015051E5
nportid 012701
status active
switch_WWPN 202700053346FA3D
fpma 0E:FC:00:01:27:01
vlanid 100
fcf_MAC 00:05:73:C2:CA:B4
| cluster_use none
lsportsas
Use the lsportsas command to display the status of all SAS ports in the clustered system.
Syntax
lsportsas
-delim delimiter
-nohdr
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum allowable width for each data item. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. If you enter -delim : on the command line, the colon character (:) separates all items of data
in a concise view; for example, the spacing of columns does not occur. In a detailed view, the data is
separated from its header by the specified delimiter.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed view. This parameter suppresses the display of these headings.
Description
This command enables you to view information about system port status.
| This command output shows all available paths, defined by zoning, independent of their usage. This
| means the command output includes paths not used because of port masking.
Table 33 provides the attribute values that can be displayed as output view data.
Table 33. lsportsas output
Attribute Description
id Indicates the line number within the displayed information (numeric string).
port_id Indicates the ID of the node containing the port.
port_speed Indicates the speed of the I/O port (in XGb). This is the fastest local link speed for the
SAS port. The value is the last-known port speed if the port is inactive, and N/A if port
has is unused and has never been active.
node_id Indicates the ID of the node containing the port (numeric string).
node_name Indicates the name of the node containing the port (alphanumeric string).
An invocation example
lsportsas
An invocation example
lsportsas
An invocation example
lsportsas
lsroute
Use the lsroute command to display the IP routing table.
Syntax
lsroute
Parameters
Description
This command displays the IP routing table. The table provides details of the gateway that is used for IP
traffic to a range of IP addresses for each Ethernet port. This information can be used to diagnose
configuration node accessibility problems. The lsroute command is equivalent to the Linux route
command.
An invocation example
lsroute
lstimezones
Use the lstimezones command to list the time zones that are available on the clustered system (system).
Each timezone is assigned an ID that can be used in the settimezone command to set the time zone.
Syntax
lstimezones
-nohdr -delim delimiter
Description
This command displays a list of all the time zones that are available on the system. Each time zone is
assigned an ID. This ID can be used in the settimezone command.
An invocation example
lstimezones
lssystem
Use the lssystem command to display a detailed view of a clustered system (system).
Syntax
lssystem
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each item of data in a detailed style view. The
-nohdr parameter suppresses the display of these headings.
182 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
Table 34 provides the attribute values that can be displayed as output view data.
Table 34. lssystem output
Attribute Possible Values
layer The value can be either:
| v replication, which means the system can create
| partnerships
| v storage (default), which means the system can present
| storage
location The location is local or remote.
statistics status The status is on or off.
auth_service_type Tivoli Integrated Portal (TIP) or Native Lightweight
Directory Access Protocol (LDAP)
auth_service_configured True if the auth_service_type is configured and either
one of the following is true:
v The auth_service_type is LDAP-only (if at least one
LDAP server is configured)
v The auth_service_type is TIP-only:
– The name, password, and URL are established
– An SSL certificate is created (if an HTTPS URL is
available)
auth_service_enabled True if the auth_service_type is configured
email_state The possible values are:
v running
v stopped
v invalid
partnership The possible values are:
v fully_configured
partially_configured_local
partially_configured_local_stopped
not_present
fully_configured_stopped
fully_configured_remote_stopped
fully_configured_local_excluded
fully_configured_remote_excluded
fully_configured_exceeded
184 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| Information about the remote system is reported by the lssystem command if either the mkfcpartnership
| or mkippartnership command has been issued from the local system to the remote system; for example, if
| the partnership has been at least partially established from the local system.
You can issue the lssystem command to display a detailed view of the system.
Detailed view shows the fields described for remote systems only; if the system Location is local, then
Partnership and Bandwidth do not apply (and are not defined or provided). For a remote system, these
fields indicate the following information:
v Location: remote
v Partnership:
fully_configured
| The mkfcpartnership or mkippartnership command has been issued in both directions and the
| remote system is online and available.
partially_configured_local
| The mkfcpartnership or mkippartnership command has only been issued from the local system
| to the remote system. The remote system is online and available for partnership.
partially_configured_local_stopped
| The mkfcpartnership or mkippartnership command has only been issued from the local system
| to the remote system. The chpartnership command with the stop parameter has been issued
| from the local system, and the remote system is online and available. You need to issue the
| chpartnership command with the start parameter on the local system, and mkfcpartnership
| or mkippartnership on the remote system.
not_present
| The mkfcpartnership or mkippartnership command has been issued from the local system to
| the remote system, and the remote system is not available. Either the remote system is offline,
| or it is not connected to the local system.
fully_configured_stopped
| The mkfcpartnership or mkippartnership command has been issued in both directions and the
| remote system is online and available. The chpartnership command with the stop parameter
| has been issued from the local system.
fully_configured_remote_stopped
| The mkfcpartnership or mkippartnership command has been issued in both directions and the
| remote system is online and available. The chpartnership command with the stop parameter
| has been issued from the remote system.
fully_configured_local_excluded
| The mkfcpartnership or mkippartnership command has been issued in both directions. The
| local system has excluded the connection to the remote system due to too many problems, or
| either system in the partnership is unable to sustain the I/O workload for the Metro Mirror or
| Global Mirror relationships.
fully_configured_remote_excluded
| The mkfcpartnership or mkippartnership command has been issued in both directions. The
| remote system has excluded the connection to the local system due to too many problems, or
| either system in the partnership is unable to sustain the I/O workload for the Metro Mirror or
| Global Mirror relationships.
fully_configured_exceeded
There are too many systems in the system network, and the partnership from the local system
to the remote has been disabled. Refer to the 1710/1720 errors in the system error log at the
local and remote system.
v Bandwidth: The bandwidth available on the intersystem link for background copy, in megabytes per
second (MBps).
iscsi_auth_method:chap
iscsi_chap_secret:MYCLUSTERCHAP
auth_service_configured:no
auth_service_enabled:no
auth_service_url
auth_service_user_name
auth_service_pwd_set:no
auth_service_cert_set:no
auth_service_type:tip
relationship_bandwidth_limit:25
tier generic_ssd
tier_capacity:0.00MB
tier_free_capacity:0.00MB
tier generic_hdd
tier_capacity:60.49TB
tier_free_capacity:59.72TB
186 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
has_nas_key:no
layer:replication
| rc_auth_method:none
rc_buffer_size:48
compression_active:yes
compression_virtual_capacity:1000.00MB
compression_compressed_capacity:0.41MB
compression_uncompressed_capacity:512.05MB
cache_prefetch:on
email_organization:UEFA
email_machine_address:1 Chelsea Blvd
email_machine_city:Fulham
email_machine_state:XX
email_machine_zip:OU812
email_machine_country:GB
total_drive_raw_capacity:900.00GB
| local_fc_port_mask:0000000000000000000000000000000000000000000000000000000000001101
| partner_fc_port_mask:0000000000000000000000000000000000000000000000000000000000000011
| topology:stretched
| topology_status:dual_site
lssystemip
Use the lssystemip command to display a list of the clustered system (system) management IP addresses
configured for each port.
Syntax
lssystemip
-nohdr -delim delimiter
system_id
-filtervalue attribute=value -filtervalue? system_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: Some filters allow the asterisk character (*) when you enter the command. The following rules
apply to the use of wildcard characters when using the command-line interface (CLI):
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, you must enclose the filter entry within double quotation marks (""), as
shown in the following example:
lssystemip -filtervalue "system_name=md*"
-filtervalue?
(Optional) displays a list of filters that can be applied against this view. The following filter attributes
are valid for the lssystemip command:
v port_id
v system_name
v system_id
system_id | system_name
(Required) Specifies the name or ID of a system.
Description
This command displays a list of the system management IP addresses configured for each port.
188 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
gateway_6 2001:0db8:85a3:0000:0000:8a2e:0370:7334
prefix_6 64
system_id 000002006CC0B71A
system_name cl1
location local
port_id 2
IP_address 192.168.1.2
subnet_mask 255.255.255.0
gateway 192.168.1.1
IP_address_6 2001:0db8:85a3:0000:0000:8a2e:0370:7334
gateway_6 2001:0db8:85a3:0000:0000:8a2e:0370:7334
prefix_6 64
lssystemstats
Use the lssystemstats command to display the most recent values of all node statistics in a clustered
system (system), or to display a history of values for a given subset of available statistics across all nodes
in a system. This command also can be used to display a history of values for a given subset of available
statistics.
Syntax
lssystemstats
-delim delimiter -filtervalue attribute=value
-filtervalue? -history stat_list
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
-filtervalueattribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsenclosurestats -filtervalue stat_name=temp_f
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalueattribute=value parameter:
v stat_name
-history stat_list
Provides the most recent node statistical values, specific node statistical values, or historical data for
any node. .
This command returns one set of statistics for all the nodes in the system. The statistical values are
determined using samples received from each node .
Note: Values are rounded to the nearest integer when appropriate (for example, between 1 and 99 when
considering percentages).
Table 35 provides the attribute values that can be displayed as output view data.
Table 35. lssystemstats attribute values
Attribute Value
stat_current The current value of the statistic field.
stat_list The system history of the reported statistics.
stat_name The name of the statistic field.
stat_peak The peak value of the statistic field in the last five minutes.
stat_peak_time The time that the peak occurred.
sample_time The time of the sample occurrence.
stat_value The statistical value at the epoch interval.
Remember: Filtering is supported on the stat_name field using the concise view.
190 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
drive_r_io 2940 3952 111123104104
drive_r_ms 11 18 111123104314
drive_w_mb 231 250 111123104129
drive_w_io 2825 3156 111123104129
drive_w_ms 16 24 111123104314
power_w 12300 12354 120402111338
temp_c 33 35 120402111333
temp_f 97 95 120402111333
The resulting partial output for the historical system summary example:
sample_time stat_name stat_value
111123104224 fc_io 2120
111123104229 fc_io 2102
111123104234 fc_io 2041
111123104239 fc_io 2211
111123104244 fc_io 2204
111123104249 fc_io 2046
111123104254 fc_io 1997
111123104259 fc_io 2081
111123104304 fc_io 2123
111123104309 fc_io 2030
111123104314 fc_io 1754
111123104319 fc_io 1640
111123104324 fc_io 1759
111123104329 fc_io 1638
111123104334 fc_io 1804
111123104339 fc_io 2011
111123104344 fc_io 2028
111123104349 fc_io 2171
111123104354 fc_io 2055
111123104359 fc_io 2167
111123104404 fc_io 2140
111123104409 fc_io 2111
Table 36 provides the possible values that are applicable to the values that are displayed for the
stat_name attribute.
Table 36. Stat_name field values
Value Description
compression_cpu_pc Displays the percentage of allocated CPU capacity utilized for compression.
cpu_pc Displays the percentage of allocated CPU capacity utilized for the system.
fc_mb Displays the total number of megabytes transferred per second for Fibre Channel
traffic on the system. This value includes host I/O and any bandwidth that is used
for communication within the system.
fc_io Displays the total input/output (I/O) operations transferred per seconds for Fibre
Channel traffic on the system. This value includes host I/O and any bandwidth that
is used for communication within the system.
192 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 36. Stat_name field values (continued)
Value Description
drive_w_ms Displays the average amount of time in milliseconds that the system takes to respond
write requests to drives over the sample period.
vdisk_r_mb Displays the average number of megabytes transferred per second for read operations
to volumes during the sample period.
vdisk_r_io Displays the average amount of I/O operations transferred per second for read
operations to volumes during the sample period.
vdisk_r_ms Displays the average amount of time in milliseconds that the system takes to respond
to read requests to volumes over the sample period.
mdisk_r_mb Displays the average number of megabytes transferred per second for read operations
to MDisks during the sample period.
mdisk_r_io Displays the average amount of I/O operations transferred per second for read
operations to MDisks during the sample period.
mdisk_r_ms Displays the average amount of time in milliseconds that the system takes to respond
to read requests to MDisks over the sample period.
drive_r_mb Displays the average number of megabytes transferred per second for read operations
to drives during the sample period
drive_r_io Displays the average amount of I/O operations transferred per second for read
operations to drives during the sample period.
drive_r_ms Displays the average amount of time in milliseconds that the system takes to respond
to read requests to drives over the sample period.
power_w Displays the power consumed in watts.
temp_c Displays the ambient temperature in Celsius.
temp_f Displays the ambient temperature in Fahrenheit.
ping
Use the ping command to diagnose IP configuration problems by checking whether the specified IP
address is accessible from the configuration node.
Syntax
ping ipv4_address
ipv6_address
Parameters
ipv4_address | ipv6_address
(Required) Specifies the clustered system IP address.
Description
This command checks whether the specified IP address is accessible from the configuration node.
Note: You can only use this command on ports 1 and 2 (for management traffic).
The ping takes place only from the configuration node. It can be useful for diagnosing problems where
the configuration node cannot be reached from a specific management server.
An invocation example
Syntax
rmnode | rmnodecanister object_id
-force object_name
Parameters
-force
(Optional) Overrides the checks that this command runs. The parameter overrides the following two
checks:
v If the command results in volumes going offline, the command fails unless the force parameter is
used.
v If the command results in a loss of data because there is unwritten data in the write cache that is
contained only within the node or node canister to be removed, the command fails unless the
force parameter is used.
If you use the force parameter as a result of an error about volumes going offline, you force the node
or node canister removal and run the risk of losing data from the write cache. The force parameter
should always be used with caution.
object_id | object_name
(Required) Specifies the object name or ID that you want to modify. The variable that follows the
parameter is either:
v The object name that you assigned when you added the node to the clustered system
v The object ID that is assigned to the node (not the worldwide node name)
Description
This command removes a node or node canister from the clustered system. This makes the node or node
canister a candidate to be added back into this clustered system or into another system. After the node or
node canister is deleted, the other node in the I/O group enters write-through mode until another node
or node canister is added back into the I/O group.
By default, the rmnode / rmnodecanister command flushes the cache on the specified node before the
node or node canister is taken offline. In some circumstances, such as when the system is already
degraded (for example, when both nodes in the I/O group are online and the virtual disks within the
I/O group are degraded), the system ensures that data loss does not occur as a result of deleting the only
node or node canister with the cache data.
194 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The cache is flushed before the node or node canister is deleted to prevent data loss if a failure occurs on
the other node or node canister in the I/O group.
To take the specified node or node canister offline immediately without flushing the cache or ensuring
data loss does not occur, run the rmnode / rmnodecanister command with the -force parameter.
Prerequisites:
Before you issue the rmnode / rmnodecanister command, perform the following tasks and read the
following Attention notices to avoid losing access to data:
1. Determine which virtual disks (VDisks, or volumes) are still assigned to this I/O group by issuing the
following command. The command requests a filtered view of the volumes, where the filter attribute
is the I/O group.
lsvdisk -filtervalue IO_group_name=name
Note: Any volumes that are assigned to the I/O group that this node or node canister belongs to are
assigned to the other node or node canister in the I/O group; the preferred node or node canister is
changed. You cannot change this setting back.
2. Determine the hosts that the volumes are mapped to by issuing the lsvdiskhostmap command.
3. Determine if any of the volumes that are assigned to this I/O group contain data that you need to
access:
v If you do not want to maintain access to these volumes, go to step 5.
v If you do want to maintain access to some or all of the volumes, back up the data or migrate the
data to a different (online) I/O group.
4. Determine if you need to turn the power off to the node or node canister:
v If this is the last node or node canister in the clustered system, you do not need to turn the power
off to the node or node canister. Go to step 5.
v If this is not the last node or node canister in the cluster, turn the power off to the node or node
canister that you intend to remove. This step ensures that the Subsystem Device Driver (SDD) does
not rediscover the paths that are manually removed before you issue the delete node or node
canister request.
5. Update the SDD configuration for each virtual path (vpath) that is presented by the volumes that you
intend to remove. Updating the SDD configuration removes the vpaths from the volumes. Failure to
update the configuration can result in data corruption. See the Multipath Subsystem Device Driver:
User's Guide for details about how to dynamically reconfigure SDD for the given host operating
system.
6. Quiesce all I/O operations that are destined for the node or node canister that you are deleting.
Failure to quiesce the operations can result in failed I/O operations being reported to your host
operating systems.
Attention:
1. Removing the last node in the cluster destroys the clustered system. Before you delete the last node or
node canister in the clustered system, ensure that you want to destroy the clustered system.
2. If you are removing a single node or node canister and the remaining node or node canister in the
I/O group is online, the data can be exposed to a single point of failure if the remaining node or node
canister fails.
3. This command might take some time to complete since the cache in the I/O group for that node or
node canister is flushed before the node or node canister is removed. If the -force parameter is used,
the cache is not flushed and the command completes more quickly. However, if the deleted node or
node canister is the last node or node canister in the I/O group, using the -force option results in the
Notes:
1. If you are removing the configuration node or node canister, the rmnode / rmnodecanister command
causes the configuration node or node canister to move to a different node or node canister within the
clustered system. This process might take a short time: typically less than a minute. The clustered
system IP address remains unchanged, but any SSH client attached to the configuration node or node
canister might need to reestablish a connection. The management GUI reattaches to the new
configuration node or node canister transparently.
2. If this is the last node or node canister in the clustered system or if it is currently assigned as the
configuration node, all connections to the system are lost. The user interface and any open CLI
sessions are lost if the last node or node canister in the clustered system is deleted. A time-out might
occur if a command cannot be completed before the node or node canister is deleted.
rmportip
Use the rmportip command to remove an Internet Small Computer System Interface (iSCSI) Internet
Protocol (IP) address from a node Ethernet port.
Syntax
rmportip -node node_name port_id
-failover -ip_6 node_id
Parameters
-failover
(Optional) Specifies that the failover IP address information be removed for the specified port.
-ip_6
(Optional) Specifies that the Internet Protocol Version 6 (IPv6) address be removed for the specified
port. If this parameter is not used, the Internet Protocol Version 4 (IPv4) address is removed by
default.
-node node_name | node_id
(Required) Specifies the node with the Ethernet port that the IP address is being removed from.
port_id
(Required) Specifies which port (1, 2, 3, or 4) to apply changes to.
196 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
This command removes an IPv4 or IPv6 address from an Ethernet port of a node.
setclustertime (Discontinued)
Attention: The setclustertime command has been discontinued. Use the setsystemtime command
instead.
setsystemtime
Use the setsystemtime command to set the time for the clustered system (system).
Syntax
setsystemtime -time time_value
Parameters
-time time_value
(Required) Specifies the time to which the system must be set. This must be in the following format
(where 'M' is month, 'D' is day, 'H' is hour, 'm' is minute, and 'Y' is year):
MMDDHHmmYYYY
Description
An invocation example
setsystemtime -time 040509142003
setpwdreset
Use the setpwdreset command to view and change the status of the password-reset feature for the
display panel.
Parameters
-disable
Disables the password-reset feature that is available through the front panel menu system.
-enable
Enables the password-reset feature that is available through the front panel menu system.
-show
Displays the status of the password-reset feature, which is either enabled or disabled.
Description
| The system provides an option to reset the system superuser password to the default value.Use the front
| panel menu system.
This command allows access if the system superuser password is forgotten. If this feature remains
enabled, make sure there is adequate physical security to the system hardware.
An invocation example
setpwdreset -show
This output means that the password or reset feature that is available through the front panel menu
system is enabled. If the password status is [0], this feature is disabled.
settimezone
Use the settimezone command to set the time zone for the clustered system (system).
Syntax
settimezone -timezone timezone_arg
Parameters
-timezone timezone_arg
Specifies the time zone to set for the system.
Description
This command sets the time zone for the system. Use the -timezone parameter to specify the numeric ID
of the time zone that you want to set. Issue the lstimezones command to list the time-zones that are
available on the system. A list of valid time-zones settings is displayed in a list.
Set the time zone to use when formatting the error log that is produced by issuing dumperrlog
198 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Issue the showtimezone command to display the current time-zone settings for the system. The system ID
and its associated time-zone are displayed. Issue the setsystemtime command to set the time for the
system.
An invocation example
settimezone -timezone 5
showtimezone
Use the showtimezone command to display the current time zone settings for the cluster.
Syntax
showtimezone
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a single time zone and its associated ID. This is the current time zone setting for
the cluster. A list of available time-zones can be viewed by running the lstimezones command. The time
zone can be changed by running the settimezone command.
An invocation example
showtimezone -delim :
startstats
Use the startstats command to modify the interval at which per-node statistics for virtual disks
(VDisks, or volumes), managed disks (MDisks), and nodes are collected.
Parameters
-interval time_in_minutes
Specifies the time in minutes. This is the time interval between the gathering of statistics, from 1 to 60
minutes in increments of 1 minute.
Description
Running the startstats command will reset the statistics timer to zero (0), and give it a new interval at
which to sample. Statistics are collected at the end of each sampling period as specified by the -interval
parameter. These statistics are written to a file, with a new file created at the end of each sampling
period. Separate files are created for MDisks, volumes and node statistics.
A maximum of 16 files are stored in the directory at any one time for each statistics file type, for
example:
Nm_stats_nodepanelname_date_time
Nv_stats_nodepanelname_date_time
Nn_stats_nodepanelname_date_time
Statistics files are created for all time intervals. Before the 17th file for each type is created, the oldest file
of that type is deleted.
stats_type_stats_nodepanelname_date_time
Where stats_type is Nm for MDisks, Nv for volumes, and Nn for node statistics. nodepanelname is the current
configuration node panel name, date is in the format of yymmdd, and time is in the format of hhmmss.
Statistics are collected for each MDisk and recorded in the Nm_stats_nodepanelname_date_time file,
including the following statistical information:
v The number of SCSI read and write commands that are processed during the sample period
v The number of blocks of data that are read and written during the sample period
v Per MDisk, cumulative read and write external response times in milliseconds
v Per MDisk, cumulative read and write queued response times
Statistics are collected for each volume and recorded in the Nv_stats_nodepanelname_date_time file,
including the following statistical information:
v The total number of processed SCSI read and write commands
v The total amount of read and written data
200 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v Cumulative read and write response time in milliseconds
v Statistical information about the read/write cache usage
v Global Mirror statistics including latency
Statistics are collected for the node from which the statistics file originated and recorded in the
Nn_stats_nodepanelname_date_time file, including the following statistical information:
v Usage figure for the node from which the statistic file was obtained
v The amount of data transferred to and received from each port on the node to other devices on the
SAN
v Statistical information about communication to other nodes on the fabric
An invocation example
startstats -interval 25
stopstats (Deprecated)
The stopstats command is deprecated. You can no longer disable statistics collection.
stopcluster (Discontinued)
Attention: The stopcluster command has been discontinued. Use the stopsystem command instead.
stopsystem
Use the stopsystem command to shut down a single node or the entire clustered system in a controlled
manner. When you issue this command, you are prompted with a confirmation of intent to process the
command.
Syntax
stopsystem
-force -node node_name
node_id
Parameters
-force
(Optional) Specifies that the node that is being shut down is the last online node in a given I/O
group. The -force parameter also overrides the checks that this command runs. The parameter
overrides the following two checks:
v If the command results in volumes going offline, the command fails unless the -force parameter is
used.
v If the node being shut down is the last online node in the I/O group, the command fails unless the
-force parameter is used.
If you use the -force parameter as a result of an error about volumes going offline, you force the
node to shut down, even if it is the last online node in the I/O group. The -force parameter should
always be used with caution.
Description
If you enter this command with no parameters, the entire system is shut down. All data is flushed to disk
before the power is removed.
If you enter this command with either a node ID or node name, the specified node is shut down. After
the command completes, the remaining node in the I/O group enters write-through mode until the
power to the node is returned, and the node rejoins the system.
Entering y or Y to the confirmation message processes the command. No feedback is then displayed.
Entering anything other than y or Y results in the command not processing. No feedback is displayed.
If you need to shut down the entire system or a single node, use this command instead of using the
power button on the nodes or powering off the main power supplies to the system.
Attention: Do not power off the uninterruptible power supply or remove the power cable from the
node.
Storwize V7000: If you need to shut down the system or a single node, use this command instead of
using the power button on power supplies, or powering off the mains to the system.
Using this command to shut down a single node fails if shutting down the node makes any volumes
inaccessible, or if it is the last node in an I/O group. If you still need to shut down the node, you can use
the -force option to override these checks.
An invocation example
stopsystem
202 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 9. Clustered system diagnostic and service-aid
commands
Clustered system diagnostic and service-aid commands are designed to diagnose and find clustered
system problems.
The SAN Volume Controller enables you to perform service activity, such as problem determination and
repair activities, with a limited set of command-line tools. When you are logged in under the
administrator role, all command-line activities are permitted. When you are logged in under the service
role, only those commands that are required for service are enabled. The clustered system diagnostic and
service-aid commands apply under the service role.
applysoftware
Use the applysoftware command to upgrade the clustered system (system) to a new level of system code
(code).
Syntax
applysoftware -file filename_arg
-force -file filename_arg -prepare
-abort
Parameters
-force
(Optional) Specifies that the upgrade or abort should proceed even if there is a lack of redundancy in
the system. Disabling redundancy checking might cause loss of data, or loss of access to data. Use the
force parameter with the abort parameter if one or more nodes are offline.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
-file filename_arg
(Required for performing an upgrade) Specifies the filename of the installation upgrade package.
Copy the upgrade package onto the configuration node before running the applysoftware command.
Note: The file parameter cannot be used with the abort parameter.
-prepare
(Optional) Prepares the system for a manual code level upgrade.
Note: The abort parameter can be used with the force parameter, but not the file or prepare
parameters.
Description
This command starts the upgrade process of the system to a new level of code. The applysoftware
command applies a level of code to the node as a service action (Paced Upgrade) to upgrade the specific
node, or as an automatic upgrade process that upgrades all of the nodes on a system.
The applysoftware command cannot be used in service state, which means the system must be running
in order for the command to be used and be successful. This command is synchronous and therefore
reports success or failure.
The code package as specified by the file name must first be copied onto the current configuration node
in the /home/admin/upgrade directory; use the PuTTy secure copy (scp) application to copy the file.
If the applysoftware command is successful, the lssoftwareupgradestatus command reports the status is
prepared. If the applysoftware command fails, the lssoftwareupgradestatus command reports the status
the status will be reported is inactive.
If specified, the prepare parameter must succeed in order to successfully upgrade. It is recommended to
use the same package for the prepare as the actual upgrade. The prepare parameter can be canceled by
using the abort parameter (even after the system is prepared) as long as the lssoftwareupgradestatus
command reports the status as prepared.
Important: The -prepare might time out. If this occurs, the prepare causes an asynchronous condition,
and the lssoftwareupgradestatus command reports the prepare as "preparing". If this occurs then wait
until lssoftwareupgradestatus reports the upgrade as "prepared" before proceeding with the manual
upgrade process.
The command completes as soon as the upgrade process is successful. The command fails and the
upgrade package is deleted if:
v The given package fails an integrity check due to corruption.
v Any node in the system has a hardware type not supported by the new code.
v The new code level does not support upgrades from the currently installed code.
v The code level of a remote system is incompatible with the new code.
v There are any volumes that are dependent on the status of a node.
Note: The force parameter can be used to override this if you are prepared to lose access to data
during the upgrade. Before proceeding, use the lsdependentvdisks command with the node parameter
to list the node-dependent volumes at the time the command is run. If the command returns an error,
move the quorum disks to MDisks that are accessible through all nodes. Rerun the command until no
errors are returned.
The lsdumps command allows you to view the contents of the /home/admin/upgrade directory.
204 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
No feedback
An invocation example
No feedback
An invocation example
applysoftware -abort
No feedback
caterrlog (Deprecated)
The caterrlog command has been deprecated. Use the lseventlog command instead.
caterrlogbyseqnum (Deprecated)
The caterrlogbyseqnum command has been deprecated. Use the lseventlog command instead.
cherrstate (Discontinued)
Attention: The cherrstate command has been discontinued. Use the cheventlog command instead.
cheventlog
Use the cheventlog command to modify events in the event log.
Syntax
cheventlog -fix sequence_number
Parameters
-fix sequence_number
(Optional) Mark an unfixed event as fixed.
Description
clearerrlog
Use the clearerrlog command to clear all entries from the error log including status events and any
unfixed errors.
Syntax
clearerrlog
-force
Parameters
-force
(Optional) Specifies that the clearerrlog command be processed without confirmation requests. If the
-force parameter is not supplied, you are prompted to confirm that you want to clear the log.
Description
This command clears all entries from the error log. The entries are cleared even if there are unfixed errors
in the log. It also clears any status events that are in the log.
Attention: This command is destructive. Use it only when you have either rebuilt the clustered system
or have fixed a major problem that has caused entries in the error log that you do not want to manually
fix.
An invocation example
clearerrlog -force
cpfabricdumps (Discontinued)
Attention: The cpfabricdumps command is discontinued.
dumperrlog
Use the dumperrlog command to dump the contents of the error log to a text file.
Syntax
dumperrlog
-prefix filename_prefix
Parameters
-prefix filename_prefix
(Optional) A file name is created from the prefix and a time stamp, and has the following format:
206 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
prefix_NNNNNN_YYMMDD_HHMMSS
Note: If the -prefix parameter is not supplied, the dump is directed to a file with a system-defined
prefix of errlog.
Description
When run with no parameters, this command dumps the clustered system (system) error log to a file
using a system-supplied prefix of errlog, which includes the node ID and time stamp. When a file name
prefix is provided, the same operation is performed but the details are stored in the dumps directory
within a file with a name that starts with the specified prefix.
A maximum of ten error-log dump files are kept on the system. When the 11th dump is made, the oldest
existing dump file is overwritten.
Error log dump files are written to /dumps/elogs. The contents of this directory can be viewed using the
lsdumps command.
Files are not deleted from other nodes until you issue the cleardumps command.
An invocation example
dumperrlog -prefix testerrorlog
finderr
Use the finderr command to analyze the error log for the highest severity unfixed error.
Syntax
finderr
Parameters
None
Description
The command scans the error log for any unfixed errors. Given a priority ordering within the code, the
highest priority unfixed error is returned to standard output.
You can use this command to determine the order in which to fix the logged errors.
An invocation example
finderr
lscimomdumps (Deprecated)
Attention: The lscimomdumps command is deprecated. Use the lsdumps command to display a list of files
in a particular dumps directory.
lscopystatus
Use the lscopystatus command to determine whether any file copies are currently in progress.
Syntax
lscopystatus
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays an indicator that shows if a file copy is currently in progress. Only one file can
be copied in the clustered system at a time.
An invocation example
lscopystatus
lsdumps
Use the lsdumps command to display a list of files in a particular dumps directory on one of the nodes in
the cluster.
208 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
lsdumps
-nohdr -delim delimiter -prefix directory_name
node_id_or_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a list of files detected by a node. You can specify the name of the directory to list
files for, and the node ID or name. If you do not specify a directory, the /dumps directory is used.
The files are listed in order of time created, with the oldest files listed first.
lserrlogbyfcconsistgrp (Deprecated)
The lserrlogbyfcconsistgrp command has been deprecated. Use the lseventlog command instead.
lserrlogbyfcmap (Deprecated)
Attention: The lserrlogbyfcmap command has been deprecated. Use the lseventlog command instead.
lserrlogbyhost (Deprecated)
Attention: The lserrlogbyhost command has been deprecated. Use the lseventlog command instead.
lserrlogbyiogrp (Deprecated)
Attention: The lserrlogbyiogrp command has been deprecated. Use the lseventlog command instead.
lserrlogbymdisk (Deprecated)
Attention: The lserrorlogbymdisk command has been deprecated. Use the lseventlog command instead.
lserrlogbymdiskgrp (Deprecated)
Attention: The lserrlogbymdiskgrp command has been deprecated. Use the lseventlog command
instead.
lserrlogbynode (Deprecated)
Attention: The lserrlogbynode command has been deprecated. Use the lseventlog command instead.
lserrlogbyrcconsistgrp (Deprecated)
Attention: The lserrlogbyrcconsistgrp command has been deprecated. Use the lseventlog command
instead.
210 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lserrlogbyrcrelationship (Deprecated)
The lserrlogbyrcrelationship command has been deprecated. Use the lseventlog command instead.
lserrlogbyvdisk (Deprecated)
Attention: The svcinfo lserrlogbyvdisk command has been deprecated. Use the svcinfo lseventlog
command instead.
lserrlogdumps (Deprecated)
Attention: The lserrlogdumps command is deprecated. Use the lsdumps command to display a list of files
in a particular dumps directory.
lsfeaturedumps (Deprecated)
Attention: The lsfeaturedumps command is deprecated. Use the lsdumps command to display a list of
files in a particular dumps directory.
lseventlog
Use the lseventlog command to display a concise view of the system event log, or a detailed view of one
entry from the log.
Syntax
lseventlog
-alert yes|no -message yes|no -monitoring yes|no
-expired yes|no -fixed yes|no -count entry_limit
-order date|severity sequence_number
Parameters
-alert
(Optional) Includes (or excludes) events with alert status.
-message
(Optional) Includes events with message status.
-monitoringyes|no
(Optional) Includes events with monitoring status.
-expiredyes|no
(Optional) Includes (or excludes) events with expired status.
-fixedyes|no
(Optional) Includes (or excludes) events with fixed status.
-countentry_limit
(Optional) Indicates the maximum number of events to display.
-order date|severity
(Optional) Indicates what order the events should be in. Ordering by date displays the oldest events
first. Ordering by severity displays the events with the highest severity first. If multiple events have
the same severity, then they are ordered by date, with the oldest event being displayed first.
Chapter 9. Clustered system diagnostic and service-aid commands 211
The following list shows the order of severity, starting with the most severe:
1. Unfixed alerts (sorted by error code; the lowest error code has the highest severity)
2. Unfixed messages
3. Monitoring events (sorted by error code; the lowest error code has the highest severity)
4. Expired events
5. Fixed alerts and messages
sequence_number
(Optional) Indicates if the command should display a full view of the event.
Description
This command displays a concise view of the system event log, or a detailed view of one entry from the
log. You can sort the events and entries by severity or age.
Table 37 provides the attribute values that can be displayed as output view data.
Table 37. lseventlog output
Attribute Description Value
machine_type Node machine type and model Alphanumeric string (up to 7
number characters long )
serial number Node serial number Alphanumeric string (up to 7
characters long )
sequence_number Sequence number of the event Numeric 0-8000000
first_timestamp When the event was added to the log YYMMDDHHMMSS
first_timestamp_epoch When the event was added to the log Numeric 32-bit
(in seconds) after the epoch occurs
last_timestamp When the event was most recently YYMMDDHHMMSS
updated
last_timestamp_epoch Most recent update (in seconds) after Numeric 32-bit
an epoch for an event
fixed_timestamp Time stamp when event is fixed YYMMDDHHMMSS
fixed_timestamp_epoch Time stamp (in seconds) when an Numeric string
event is fixed after an epoch occurs
fru Field-replaceable unit (FRU) for error ASCII string up to 255 characters
or event; this field contains probable long
FRUs (separated by commas)
212 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 37. lseventlog output (continued)
Attribute Description Value
object_type The type of the object the event is v mdisk
logged against
v mdiskgrp
v vdisk (or vdisk copy)
v node
v host
v io_grp (iogroup in dumperrlog)
v fc_consist_grp (fcgrp in dumperrlog)
v rc_consist_grp (rcgrp in
dumperrlog)
v fc_map (fcmap in dumperrlog; flash
in caterrlog)
v rc_relationship (rcmap in
dumperrlog; remote in caterrlog)
v cluster
v controller (device in caterrlog and
dumperrlog)
v quorum
v migrate
v email_server (email server in
caterrlog and dumperrlog)
v enclosure
v drive
object_id ID of the object the event is logged Numeric 64-bit; displayed in decimal
against for all object types except clustered
systems
Invocation examples
214 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
This example shows all unfixed 1065 errors, in order of occurrence:
lseventlog -filtervalue error_code=1065:fixed=no
sequence_number:last_timestamp:object_type:object_id:object_name:copy_id:
status:fixed:event_id:error_code:description
400:100106132413:vdisk:2:my_vdisk:1:alert:no:060001:1865:
Space Efficient Virtual Disk Copy offline due to insufficient space
401:100106140000:cluster::ldcluster-2::message:no:981001:
:Cluster Fabric View updated by fabric discovery
sequence_number 120
first_timestamp 111130100419
first_timestamp_epoch 1322647459
last_timestamp 111130100419
last_timestamp_epoch 1322647459
object_type node
object_id 1
object_name node1
copy_id
reporting_node_id 1
reporting_node_name node1
root_sequence_number
event_count 1
status alert
fixed yes
auto_fixed no
notification_type error
event_id 073003
event_id_text More/Less fibre channel ports operational
error_code 1060
error_code_text Fibre Channel ports not operational
machine_type 21458F4
serial_number 75BZPMA
fru none
fixed_timestamp 111202141004
fixed_timestamp_epoch 1322835004
sense1 03 03 00 00 00 00 00 00 00 00 00 00 00 00 00 00
sense2 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
sense3 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
sense4 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
sense5 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
sense6 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
sense7 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
sense8 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
lssyslogserver
Use the lssyslogserver command to return a concise list or a detailed view of syslog servers that are
configured on the clustered system.
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
Use this command to display a concise list or a detailed view of syslog servers that are configured on the
clustered system.
216 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lssoftwaredumps (Deprecated)
Attention: The lssoftwaredumps command is deprecated. Use the lsdumps command to display a list of
files in a particular dumps directory.
lssoftwareupgradestatus
Use the lssoftwareupgradestatus command to display the status of a machine code (code) upgrade.
Syntax
lssoftwareupgradestatus
-nohdr
Parameters
-nohdr
(Optional) Suppresses the display of headings.
Description
Remember:
v It is important to understand which volumes must have a particular node being online. If a status of
stalled_non_redundant is displayed, proceeding with the remaining set of node upgrades might result
in offline volumes (which results in data loss). Contact an IBM service representative to complete the
manual upgrade.
v In some cases before an upgrade can be performed, you must increase the -rsize value of the VDisk
(volume).
| Note: Rebooting does not restore the code to its original code level.
| config_holding
| Indicates a transient state in which the command line has been deactivated to run new
| commands, which allows the move to the cluster_holding state.
| downgrading
| Indicates a downgrade is in progress.
| inactive
| Indicates no upgrade is running.
| initializing
| Indicates the memory necessary for the upgrade is being allocated.
| An invocation example
lssoftwareupgradestatus
An invocation example
lssoftwareupgradestatus
setlocale
Use the setlocale command to change the locale setting for the clustered system (system). It also
changes command output to the chosen language.
Syntax
setlocale -locale locale_id
Parameters
-locale locale_id
Specifies the locale ID. The value must be a numeric value depending on the desired language (as
indicated below)
Description
This command changes the language in which error messages are displayed as output from the
command-line interface. Subsequently, all error messages from the command-line tools are generated in
the chosen language. This command is run when you request a change of language (locale) and is
218 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
generally run from the web page. Issue the setlocale command to change the locale setting for the
system; all interface output is changed to the chosen language. For example, to change the language to
Japanese, type the following:
setlocale -locale 3
where 3 is the value for Japanese. The following values are supported:
v 0 US English (default)
v 1 Simplified Chinese
v 2 Traditional Chinese
v 3 Japanese
v 4 French
v 5 German
v 6 Italian
v 7 Spanish
v 8 Korean
v 9 Portuguese (Brazilian)
Note: This command does not change the front panel display panel settings.
svqueryclock
Use the svqueryclock command to return the date, time, and current time-zone of the clustered system
(system).
Syntax
svqueryclock
Parameters
None
Description
This command returns the date, time and current time-zone of the system.
writesernum
Use the writesernum command to write the node serial number into the planar NVRAM.
Syntax
writesernum -sernum serial_number node_id
node_name
Parameters
-sernum serial_number
(Required) Specifies the serial number to write to the nonvolatile memory of the system planar.
node_id | node_name
(Required) Specifies the node where the system planar is located. The serial number is written to this
system planar. This name is not the worldwide node name (WWNN).
Description
This command writes the node serial number into the planar NVRAM and then reboots the system. You
can find the serial number at the front of the node without having to remove it from the rack. The
seven-digit alphanumeric serial number is located on a label on the front of the node. The serial number
on the label might contain a hyphen. Omit this hyphen when typing the serial number with the
writesernum command.
Note: Once you have written the serial number to the planar NVRAM, you can issue the lsnodevpd
command to verify that the number is correct. The system_serial_number field contains the serial number.
An invocation example
writesernum -sernum 1300027 node1
220 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 10. Controller command
Use the controller command to modify the name of a storage controller.
chcontroller
Use the chcontroller command to modify the attributes of a controller.
Syntax
chcontroller
-name new_name -allowquorum yes
no
| controller_id
controller_name -site site_or_site_name
Parameters
-name new_name
(Optional) Specifies the new name to be assigned to the controller.
-allowquorum yes | no
(Optional) Specifies that the controller is allowed or is not allowed to support quorum disks. A value
of yes enables a suitable controller to support quorum disks. A value of no disables a controller from
supporting quorum disks, provided that the specified controller is not currently hosting a quorum
disk.
controller_id | controller_name
(Required) Specifies the controller to modify; use either the controller name or the controller ID.
| -site site_or_site_name
| (Optional) Specifies the numeric site value or site name for the controller. The value is 1, 2, or 3.
| -nosite
| (Optional) Resets the site value for the controller.
Description
This command changes the name of the controller that is specified by the controller_id | controller_name
variable to the value that you specify with the -name parameter.
If any controller that is associated with an MDisk shows the allow_quorum attribute set to no with the
lscontroller command, the set quorum action fails for that MDisk. Before using the chcontroller
command to set the -allowquorum parameter to yes on any disk controller, check the following website to
see whether the controller supports quorum.
www.ibm.com/storage/support/2145
You can add a new disk controller system to your SAN at any time. Follow the switch zoning guidelines
in the section about switch zoning. Also, ensure that the controller is set up correctly for use with the
clustered system (system).
To add a new disk controller system to a running configuration, ensure that the system has detected the
new storage MDisks by issuing the detectmdisk command. The controller has automatically been
© Copyright IBM Corp. 2003, 2013 221
assigned a default name. If you are unsure of which controller is presenting the MDisks, issue the
lscontroller command to list the controllers. The new controller is listed with the highest numbered
default name. Record the controller name and follow the instructions in the section about determining a
disk controller system name.
These MDisks correspond to the RAID arrays or partitions that you have created. Record the field
controller LUN number. The field controller LUN number corresponds with the LUN number that you
assigned to each of the arrays or partitions.
Create a new managed disk group and add only the RAID arrays that belong to the new controller to
this storage pool. Avoid mixing RAID types; for each set of RAID array types (for example, RAID-5 or
RAID-1), create a new storage pool. Assign this storage pool an appropriate name; if your controller is
called FAST650-abcand the storage pool contains RAID-5 arrays, assign the MDisk a name similar to
F600-abc-R5. Issue the following command:
Note: This creates a new storage pool with an extent size of 16 MB.
An invocation example
chcontroller -name newtwo 2
| An invocation example
| chcontroller -site DRsite controller1
lscontroller
Use the lscontroller command to display a concise list or a detailed view of controllers that are visible
to the clustered system (system).
Syntax
lscontroller
-filtervalue attribute=value -nohdr
-delim delimiter -filtervalue? controller_id
controller_name
222 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
-filtervalue?
(Optional) Displays the valid filter attributes. The following filter attributes for the lscontroller
command are valid:
v controller_name
v id
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command returns a concise list, or a detailed view, of controllers visible to the system.
The following values are applicable to the data in the output views:
degraded no, yes
To differentiate the name of a storage controller from the name shown on the system, list the storage
controllers by issuing the lscontroller command. Record the controller name or ID for the controller
that you want to determine. For the controller in question, issue the lscontroller controller name | id
command, where controller name | id is the controller name or ID. Record the worldwide node name
(WWNN) for the controller. You can use the WWNN to determine the actual storage controller by
launching the native controller user interface, or by using the command line tools it provides to verify the
actual controller that has the WWNN.
Notes:
1. The mdisk_link_count value is the number of MDisks currently associated with this storage controller.
Remember: This value is reset by specific maintenance procedures or when the event log is cleared.
3. A SAN connection from a node or node canister port to a controller port for a single MDisk is a path.
The controller port path_count value is the number of paths that are currently being used to submit
input/output (I/O) data to this controller port.
4. The storage controller max_path_count value is the highest value that the storage controller path_count
has reached since it was last reset to the path_count value. This value is reset by specific maintenance
procedures or when the system error log is cleared.
Important: The max_path_count value is the highest value that the path_count has reached since it was
last reset to the path_count value.
Remember: This value is reset by specific maintenance procedures or when the event log is cleared.
5. The allow_quorum value identifies if the controller is currently enabled to support quorum disks.
Quorum support is either enabled or disabled depending on the controller hardware type.
6. The ctrl_s/n value is the controller serial number.
Important: This data comes from vendor-controlled sources and might not be available.
Table 38 provides the attribute values that can be displayed as output view data.
This table provides the attribute values that can be displayed as output view data.
Table 38. lscontroller output
Attribute Possible Values
id Indicates the controller ID.
name Indicates the controller name.
WWNN Indicates the world-wide node name (WWNN).
mdisk_link_count Indicates the MDisk link count.
max_mdisk_link_count Indicates the maximum MDisk link count.
degraded Indicates if the controller has degraded MDisks.
vendor_id Indicates the vendor identification name or number.
product_id_low Indicates the product identification.
product_id_high Indicates the product identification.
product_revision Indicates the product revision.
ctrl_s/n Indicates the controller serial number.
allow_quorum Indicates the controller can support quorum disks.
WWPN Indicates the world-wide port name (WWPN).
path_count Indicates the number of paths that are currently being
used to submit input/output (I/O) data to the controller
port.
max_path_count Indicates the maximum number of paths that are
currently being used to submit input/output (I/O) data
to the controller port.
| site_id Indicates the site value for the controller. This numeric
| value is 1, 2, 3 or blank.
224 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 38. lscontroller output (continued)
Attribute Possible Values
| site_name Indicates the site name for the controller. This is an
| alphanumeric value or is blank.
| fabric_type Indicates a Fibre Channel (FC) or SAS controller.
lscontrollerdependentvdisks
Use the lscontrollerdependentvdisks command to list the volumes that are dependent on the specified
controller.
Syntax
lscontrollerdependentvdisks controller_id_list
controller_name_list
Description
The lscontrollerdependentvdisks command lists the volumes that are dependent on the status of the
specified controllers. If a controller goes offline, the dependent volumes also go offline. Before taking a
controller offline for maintenance, you can use the command to ensure that you do not lose access to any
volumes.
If you have multiple controllers configured as a single subsystem, you must specify all of the controllers
in the subsystem, using a single command invocation.
The lscontrollerdependentvdisks command also checks for quorum disks on the specified controller list.
If any quorum disks are on the specified controller list, the command returns an error. All quorum disks
must be moved before performing any maintenance. After moving quorum disks, reissue the command to
list the dependent volumes.
Note: The command lists the volumes that are dependent on the controllers at the time the command is
run; subsequent changes to your system require rerunning the command.
An invocation example
lscontrollerdependentvdisks controller0
226 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 11. Drive commands
Use the drive commands to capture information to assist with managing drives.
applydrivesoftware
Use the applydrivesoftware command to upgrade drives.
Syntax
| applydrivesoftware -file name -drive drive_id
| firmware -all
-type fpga
|
| -force -allowreinstall -allowdowngrade
|
| applydrivesoftware -cancel
|
Parameters
-file name
(Required) Specifies the firmware upgrade file name that must be copied to the /home/admin/
upgrade/ directory on the configuration node.
| -type fgpa | firmware
(Optional) Specifies the type of drive firmware to update. Drive firmware updates can be performed
online, concurrently with I/O. However, fpga updates require the drive to be taken offline, which
means target drives must be made candidate before issuing the applydrivesoftware command. The
default value is firmware. See the chdrive command for more details.
| -all
| (Optional) Specifies that the drive firmware should be applied to every drive in the system, as long
| as that drive is online and has use member, use spare, or use candidate.
| This does not apply to:
| v Drives that have dependent volumes
| v Drives that are members of non-redundant arrays
| Drives hosting quorum qualify, but there is risk. To avoid this risk use -drive and make sure the
| quorum is moved in between applydrivesoftware invocations. Use the chquorum command to avoid
| upgrading a drive that is hosting quorum.
| If you specify -all you must specify the -type as firmware.
| Remember: The -all parameter differs from the -drive parameter because unsuitable drives are not
| added to the list of drives scheduled for upgrade when you use -all.
-drive drive_id
| (Optional) Specifies one drive ID or a list of drive IDs (separated by a colon, :) to be upgraded. The
| maximum number of IDs is 128. If you have more than 128, use -all or multiple applydrivesoftware
| invocations to complete the upgrade.
Note: Restore redundancy to the system (where possible) instead of using the -force parameter.
Important: Using the force parameter might result in a data loss. Use it only under the direction of
the IBM Support Center, or if you are willing to accept the risk of data loss in the array or pool to
which the drive belongs.
| -allowreinstall
| (Optional) Specifies to make the system install the current level (again) onto drives that contain a file
| in the package.
| Remember: Use this parameter only under the direction of the IBM Support Center.
| -cancel
| (Optional) Specifies that the command be stopped.
Description
Use this command to upgrade the firmware of drives that are managed by the system.
There are two types of drive software that can be updated using this command:
v firmware
v fpga
Drive firmware updates can be performed online while the drive is in use. When used on an array
member drive applydrivesoftware checks for volumes that are dependent on the drive and refuses to run
if any are found. Drive dependent volumes are usually caused by non-redundant or degraded RAID
arrays. Where possible you should restore redundancy to the system by replacing any failed drives before
using the applydrivesoftware command. When this is not possible, for example on drives that are
members of a RAID0 array, you can either add redundancy to the volume by adding a second copy in
another pool, or use the -force parameter to bypass the dependant volume check. Only use -force if you
are willing to accept the risk of data loss on dependent volumes - if the drive fails during the firmware
update.
| Drive firmware updates occur asynchronously, and conclude after the applydrivesoftware command
| completes. To see the status of the updates, use the lsdriveupgradeprogress command.
Drive fpga updates might require the drive to be taken offline for several minutes. Drives must be
changed to the candidate state before applydrivesoftware can be used to update fpga software. The fpga
228 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
updates occur asynchronously, continuing in the background after the applydrivesoftware command has
returned. You must check the FPGA_level field in lsdrive N, where N is the drive_id, to see whether or
not the update completed successfully.
Remember: Interrupting an fpga update by removing power from the drive or enclosure might make the
drive unusable. Only one drive's fpga can be updated per applydrivesoftware invocation. Make sure that
the upgrade is complete before unseating the drive or removing power from the enclosure.
An invocation example
No feedback
An invocation example
CMMVC6953E The action cannot be completed because vdisks are dependent on the specified mdisk.
Force is required.
| An invocation example
| No feedback
| An invocation example
| No feedback
| An invocation example
| No feedback
| An invocation example
| No feedback
| An invocation example
| applydrivesoftware -cancel
| No feedback
chdrive
Use the chdrive command to change the drive properties.
Syntax
chdrive -use drive_id
unused -allowdegraded
candidate
spare
failed
-task format
certify
recover
Parameters
-use
Describes the role of the drive:
v unused: the drive is not in use and will not be used as a spare
v candidate: the drive is available for use in an array
v spare: the drive can be used as a hot spare if required
v failed: the drive has failed.
Note: To create member drives, add the drives to arrays using the charray command.
-allowdegraded
(Optional) Permits permission for a change of drive to continue, even if a hotspare is not available.
-task
Causes the drive to perform a task:
v format: a drive is formatted for use in an array; only permitted when drive is a candidate or has
failed validation
v certify: the disk is analyzed to verify the integrity of the data it contains; permitted for any drive
that is a candidate, spare, or member
v recover: recover an offline SSD drive without losing data; permitted when the drive is offline
because a build is required, or when the drive has failed validation
drive_id
The identity of the drive.
230 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
lsdrive
Use the lsdrive command to display configuration information and drive vital product data (VPD).
Syntax
lsdrive
-filtervalue attribute_value -filtervalue? -bytes drive_id
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""): lsdrive
-filtervalue mdisk_id="1*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
v capacity
v enclosure_id
v error_sequence_number
v id
v mdisk_id
v mdisk_name
v member_id
v node_id
v node_name
v slot_id
v status
v tech_type
v use
-bytes
(Optional) The size (capacity) of the drive in bytes.
drive_id
(Optional) The identity of the drive.
232 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 39. lsdrive output (continued)
Attribute Value
node_id For a drive contained within a node, the node ID where the drive is located. For a drive
contained within an enclosure, blank.
quorum_id The ID of quorum disk; blank if not quorum disk.
port_1_status The connectivity status of the target for MDisk enumeration, with states.
port_2_status The connectivity status of the target for MDisk enumeration, with states.
FPGA_level:1.99
mdisk_id:0
mdisk_name:mdisk0
member_id:0
enclosure_id:1
slot:2
node_id:
node_name:
quorum_id:
port_1_status:online
port_2_status:online
lsdrivelba
Use the lsdrivelba command to map array MDisk logical block address (LBA) to a set of drives.
Syntax
lsdrivelba
-delim delimiter -mdisklba lba
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
-mdisklba lba
(Optional) The logical block address (LBA) on the MDisk. The LBA must be specified in hex, with a
0x prefix.
-mdiskmdisk_id | mdisk_name
(Optional) The ID or name of the MDisk.
Description
This command maps the array MDisk logical block address (LBA) to a set of drives.
This is an example of a five-member RAID-5 array with strip size of 256 KB:
lsdrivelba -delim : -mdisklba 0x000 -mdisk 2
234 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lsdriveprogress
Use the lsdriveprogress command to view the progress of various drive tasks.
Syntax
lsdriveprogress
-delim delimiter drive_id
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
drive_id
(Optional) The drive for which you want to view progress.
Description
An invocation example
lsdriveprogress -delim :
| lsdriveupgradeprogress
| Use the lsdriveupgradeprogress command to view the status or progress of drives with pending
| downloads.
| Syntax
| lsdriveupgradeprogress
-delim delimiter drive_id
|
| Parameters
| -delim delimiter
| (Optional) By default in a concise view, all columns of data are space-separated. The width of each
| column is set to the maximum possible width of each item of data. In a detailed view, each item of
| data has its own row, and if the headers are displayed, the data is separated from the header by a
| space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
| one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
| items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
| view, the data is separated from its header by the specified delimiter.
| drive_id
| (Optional) Specifies the upgrade status or progress for a single drive. If not specified, the upgrade
| status for all scheduled drives is displayed.
| Description
236 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| v D is day
| v H is hour
| v (The second) M is minute
| v S is second
| The value is blank if the status is either canceled or blank.
triggerdrivedump
Use the triggerdrivedump command to collect support data from a disk drive. This data can help to
understand problems with the drive, and does not contain any data that applications may have written to
the drive.
Syntax
triggerdrivedump drive_id
Parameters
drive_id
The ID of the drive to dump.
Description
Use this command to collect internal log data from a drive and store the information in a file in the
/dumps/drive directory. This directory is on one of the nodes connected to the drive.
An invocation example
triggerdrivedump 1
Note: The system chooses the node on which to run the statesave.
238 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 12. Email and event notification commands
You can use the command-line interface (CLI) to enable your system to send notifications.
chemail
Use the chemail command to set or modify contact information for email event notifications. At least one
of the parameters must be specified to modify settings.
Syntax
chemail
-reply reply_email_address -contact contact_name
-primary primary_telephone_number -alternate alternate_telephone_number
-location location -contact2 contact_name2
-primary2 primary_telephone_number2 -alternate2 alternate_telephone_number2
-nocontact2 -organization organization -address address
-city city -state state -zip zip -country country
Parameters
-reply reply_email_address
(Optional) Specifies the email address to which a reply is sent.
-contact contact_name
(Optional) Specifies the name of the person to receive the email.
For machine types 2071 and 2072 the maximum number of characters is 30. For other machine types
the maximum number of characters is 72.
-primary primary_telephone_number
(Optional) Specifies the primary contact telephone number.
Note: For machine types 2071 and 2072 (in the United States and Canada), the value entered must be
exactly ten decimal digits. For machines types 2071 and 2072 (in other countries) the value entered
can be five to nineteen decimal digits. Otherwise, there can be up to nineteen characters.
-alternate alternate_telephone_number
(Optional) Specifies the alternate contact telephone number that is used when you cannot reach the
primary contact on the primary phone.
-location location
(Optional) Specifies the physical location of the system that is reporting the error. The location value
must not contain punctuation or any other characters that are not alphanumeric or spaces.
Note: For machine types 2071 and 2072 (in the United States and Canada), the value entered must be
exactly ten decimal digits. For machines types 2071 and 2072 (in other countries) the value entered
can be five to nineteen decimal digits. Otherwise, there can be up to nineteen characters.
-alternate2 alternate_telephone_number2
(Optional) Specifies the alternate contact telephone number for the second contact person.
-nocontact2
(Optional) Removes all the contact details for the second contact person.
-organization organization
(Optional) Specifies the user's organization as it should appear in Call Home emails.
-address address
(Optional) Specifies the first line of the user's address as it should appear in Call Home email.
-city city
(Optional) Specifies the user's city as it should appear in Call Home email.
-state state
(Optional) Specifies the user's state as it should appear in Call Home email. This is a two-character
value such as NY for New York.
-zip zip
(Optional) Specifies the user's zip code or postal code as it should appear in Call Home email.
-country country
(Optional) Specifies the country in which the machine resides as it should appear in Call Home
email. This is a two-character value such as US for United States.
For machine types 2071 and 2072 this value cannot be US or CA if the value for primary or primary2
telephone number is not blank or exactly 10 digits.
Description
This command sets or modifies contact information that is used by the email event notification facility.
Note: If you are starting the email event notification facility, the reply, contact, primary, and location
parameters are required. If you are modifying contact information used by the email event notification
facility, at least one of the parameters must be specified.
These fields do not have to be set to start the email notification system, but if the new fields are set they
are included in the email event notifications.
240 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
chemail -reply ddrogba@uk.uefa.com
-contact ’Didier Drogba’
-primary 01962817668
-location ’C block’
-organization UEFA
-address ’1 Chelsea Blvd’
-city Fulham
-zip 0U812
-machine_country GB
An invocation example
chemail -primary 0441234567 -location ’room 256 floor 1 IBM’
An invocation example
chemail -country US -primary 8458765309
chemailserver
Use the chemailserver command to modify the parameters of an existing email server object.
Syntax
chemailserver
-name server_name -ip ip_address
email_server_name
-port port email_server_id
Parameters
-name server_name
(Optional) Specifies a unique name to assign to the email server object. The name must be a 1-
through 63-character string, and cannot start with a hyphen or number. When specifying a server
name, emailserver is a reserved word.
-ip ip_address
(Optional) Specifies the IP address of the email server object. This must be a valid IPv4 or IPv6
address. IPv6 addresses can be zero compressed.
-port port
(Optional) Specifies the port number for the email server. This must be a value of 0 - 65535. The
default value is 25.
email_server_name | email_server_id
(Required) Specifies the name or ID of the server object to be modified.
Use this command to change the settings of an existing email server object. The email server object
describes a remote Simple Mail Transfer Protocol (SMTP) email server.
You must specify either the current name or the ID of the object returned at creation time. Use the
lsemailserver command to obtain this ID.
An invocation example
chemailserver -name newserver 0
chemailuser
Use the chemailuser command to modify the settings that are defined for an email recipient.
Syntax
chemailuser
-address user_address -usertype support
local
on on on
-error off -warning off -info off
userid_or_name
-name user_name on
-inventory off
Parameters
-address user_address
(Optional) Specifies the email address of the person receiving the email or inventory notifications, or
both. The user_address value must be unique.
-usertype support | local
(Optional) Specifies the type of user, either local or support, based on the following definitions:
support
Address of the support organization that provides vendor support.
local All other addresses.
-error on | off
(Optional) Specifies whether the recipient receives error-type event notifications. Set to on, error-type
event notifications are sent to the email recipient. Set to off, error-type event notifications are not sent
to the recipient.
-warning on | off
(Optional) Specifies whether the recipient receives warning-type event notifications. Set to on,
warning-type event notifications are sent to the email recipient. Set to off, warning-type event
notifications are not sent to the recipient.
242 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-info on | off
(Optional) Specifies whether the recipient receives informational event notifications. Set to on,
informational event notifications are sent to the email recipient. Set to off, informational event
notifications are not sent to the recipient.
-name user_name
(Optional) Specifies the user name of the new email event notification recipient. The user_name value
must be unique, must not contain spaces, and must not contain all numbers. The name emailusern,
where n is a number, is reserved and cannot be specified as one of your user names.
-inventory on | off
(Optional) Specifies whether this recipient receives inventory email notifications.
userid_or_name
(Required) Specifies the email recipient for whom you are modifying settings.
Description
This command modifies the settings that are established for an email recipient. Standard rules regarding
names apply; therefore, it is not possible to change a name to emailusern, where n is a number.
Note: Before the usertype parameter can be set to support, the -warning and -info flags must be set to
off.
An invocation example
The following example modifies email settings for email recipient manager2008:
chemailuser -usertype local manager2008
An invocation example
chsnmpserver
Use the chsnmpserver command to modify the parameters of an existing SNMP server.
Syntax
chsnmpserver
-name server_name -ip ip_address
snmp_server_name
-info on -port port snmp_server_id
off
Parameters
-name server_name
(Optional) Specifies a name to assign to the SNMP server. The name must be unique. When
specifying a server name, snmp is a reserved word.
-ip ip_address
(Optional) Specifies an IP address to assign to the SNMP server. This must be a valid IPv4 or IPv6
address.
-community community
(Optional) Specifies the community name for the SNMP server.
-error on | off
(Optional) Specifies whether the server receives error notifications. Set to on, error notifications are
sent to the SNMP server. Set to off, error notifications are not sent to the SNMP server.
-warning on | off
(Optional) Specifies whether the server receives warning notifications. Set to on, warning notifications
are sent to the SNMP server. Set to off, warning notifications are not sent to the SNMP server.
-info on | off
(Optional) Specifies whether the server receives information notifications. Set to on, information
notifications are sent to the SNMP server. Set to off, information notifications are not sent to the
SNMP server.
-port port
(Optional) Specifies the remote port number for the SNMP server. This must be a value of 1 - 65535.
snmp_server_name | snmp_server_id
(Required) Specifies the name or ID of the server to be modified.
Description
Use this command to change the settings of an existing SNMP server. You must specify either the current
name of the server or the ID returned at creation time. Use the lssnmpserver command to obtain this ID.
An invocation example
chsnmpserver -name newserver 0
chsyslogserver
Use the chsyslogserver command to modify the parameters of an existing syslog server.
Syntax
chsyslogserver
-name server_name -ip ip_address
244 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-facility facility -error on -warning on
off off
syslog_server_name
-info on syslog_server_id
off
Parameters
-name server_name
(Optional) Specifies a name to assign to the syslog server. The name must be unique. When
specifying a server name, syslog is a reserved word.
-ip ip_address
(Optional) Specifies an IP address to assign to the syslog server. This must be a valid IPv4 or IPv6
address.
-facility facility
(Optional) Specifies a facility number to identify the origin of the message to the receiving server.
Servers configured with facility values of 0 - 3 receive syslog messages in concise format. Servers
configured with facility values of 4 - 7 receive syslog messages in fully-expanded format.
-error on | off
(Optional) Specifies whether the server receives error notifications. Set to on, error notifications are
sent to the syslog server. Set to off, error notifications are not sent to the syslog server.
-warning on | off
(Optional) Specifies whether the server receives warning notifications. Set to on, warning notifications
are sent to the syslog server. Set to off, warning notifications are not sent to the syslog server.
-info on | off
(Optional) Specifies whether the server receives information notifications. Set to on, information
notifications are sent to the syslog server. Set to off, information notifications are not sent to the
syslog server.
syslog_server_name | syslog_server_id
(Required) Specifies the name or ID of the server to be modified.
Description
Use this command to change the settings of an existing syslog server. You must specify either the current
name of the server or the ID returned at creation time. Use the lssyslogserver command to obtain this
ID.
An invocation example
chsyslogserver -facility 5 2
lsemailserver
Use the lsemailserver command to display a concise list or a detailed view of email servers configured
on the clustered system (system).
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
Use this command to display a concise list or a detailed view of email servers that are configured on the
system.
lsemailuser
Use the lsemailuser command to generate a report that lists the email event notification settings for all
email recipients, an individual email recipient, or a specified type (local or support) of email recipient.
246 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
lsemailuser
-type support -delim delimiter id_or_name
local
Parameters
-type support | local
(Optional) Specifies the types of email recipients you want to view, either customer or support based
as determined by the following definitions:
support
Address of the support organization that provides vendor support.
local All other addresses.
-delim delimiter
(Optional) By default in a concise view, all columns of data are space separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, a colon separates all items of data in
a concise view; the spacing of columns does not occur. In a detailed view, the data is separated from
its header by a colon.
id_or_name
(Optional) Specifies the user ID or user name of the email event recipient for whom you want to see
the email notification settings.
Description
When you issue this command, a report is displayed that lists the email event notification settings for all
email recipients, an individual email recipient, or a specified type (local or support) of email recipient.
The concise and detailed views report the same information.
A concise invocation example listing information for all email recipients using the
email event notification facility
lsemailuser -delim :
lssnmpserver
Use the lssnmpserver command to return a concise list or a detailed view of SNMP servers that are
configured on the clustered system (system).
Syntax
lssnmpserver
-nohdr -delim delimiter snmp_server_name
snmp_server_id
Description
Use this command to display a concise list or a detailed view of SNMP servers that are configured on the
system.
mkemailserver
Use the mkemailserver command to create an email server object that describes a remote Simple Mail
Transfer Protocol (SMTP) email server.
Syntax
mkemailserver -ip ip_address
-name server_name -port port
248 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
-name server_name
(Optional) Specifies a unique name to assign to the email server object. The name must be a 1-
through 63-character string, and cannot start with a hyphen or number. If a name is not specified,
then a system default of emailservern is applied, where n is the object ID. When specifying a server
name, emailserver is a reserved word.
-ip ip_address
(Required) Specifies the IP address of a remote email server. This must be a valid IPv4 or IPv6
address. IPv6 addresses can be zero compressed.
-port port
(Optional) Specifies the port number for the email server. This must be a value of 1 - 65535. The
default value is 25.
Description
This command creates an email server object that represents the SMTP server. The SAN Volume
Controller uses the email server to send event notification and inventory emails to email users. It can
transmit any combination of error, warning, and informational notification types.
The SAN Volume Controller supports up to six email servers to provide redundant access to the external
email network. The email servers are used in turn until the email is successfully sent from the SAN
Volume Controller. The attempt is successful when the SAN Volume Controller gets a positive
acknowledgement from an email server that the email has been received by the server.
An invocation example
mkemailserver -ip 2.2.2.2 -port 78
mkemailuser
Use the mkemailuser command to add a recipient of email event and inventory notifications to the email
event notification facility. Add up to twelve recipients (one recipient at a time).
Syntax
mkemailuser -address user_address
-name user_name
-usertype support
local on on
-error off -warning off
on on
-info off -inventory off
Parameters
-name user_name
(Optional) Specifies the name of the person who is the recipient of email event notifications. The
user_name value must be unique, must not contain spaces, and must not contain only numbers. If you
Description
This command adds email recipients to the email event and inventory notification facility. You can add
up to twelve recipients, one recipient at a time. When an email user is added, if a user name is not
specified, a default name is allocated by the system. This default name has the form of emailuser1,
emailuser2, and so on. Email notification starts when you process the startemail command.
Note: Before you can set the usertype parameter to support, turn the -warning and -info flags off.
An invocation example
mkemailuser -address manager2008@ibm.com -error on -usertype local
mksnmpserver
Use the mksnmpserver command to create a Simple Network Management Protocol (SNMP) server to
receive notifications.
250 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
mksnmpserver -ip ip_address
-name server_name
-community community on on
-error off -warning off
on -port port
-info off
Parameters
-name server_name
(Optional) Specifies a unique name to assign to the SNMP server. If a name is not specified, then a
system default of snmpn is applied, where n is the ID of the server. When specifying a server name,
snmp is a reserved word.
-ip ip_address
(Required) Specifies the IP address of the SNMP server. This must be a valid IPv4 or IPv6 address.
-community community
(Optional) Specifies the community name for the SNMP server. If you do not specify a community
name, then the default name of public is used.
-error on | off
(Optional) Specifies whether the server receives error notifications. Set to on, error notifications are
sent to the SNMP server. Set to off, error notifications are not sent to the SNMP server. The default
value is on.
-warning on | off
(Optional) Specifies whether the server receives warning notifications. Set to on, warning notifications
are sent to the SNMP server. Set to off, warning notifications are not sent to the SNMP server. The
default value is on.
-info on | off
(Optional) Specifies whether the server receives information notifications. Set to on, information
notifications are sent to the SNMP server. Set to off, information notifications are not sent to the
SNMP server. The default value is on.
-port port
(Optional) Specifies the remote port number for the SNMP server. This must be a value of 1 - 65535.
The default value is 162.
Description
An invocation example
mksnmpserver -ip 2.2.2.2 -port 78
Syntax
mksyslogserver -ip ip_address
-name server_name
-facility facility on on
-error off -warning off
on
-info off
Parameters
-name server_name
(Optional) Specifies a unique name to assign to the syslog server. If a name is not specified, then a
system default of syslogn is applied, where n is the ID of the server. When specifying a server name,
syslog is a reserved word.
-ip ip_address
(Required) Specifies the Internet Protocol (IP) address of the syslog server. This must be a valid
Internet Protocol Version 4 (IPv4) or Internet Protocol Version 6 (IPv6) address.
-facility facility
(Optional) Specifies the facility number used in syslog messages. This number identifies the origin of
the message to the receiving server. Servers configured with facility values of 0 - 3 receive syslog
messages in concise format. Servers configured with facility values of 4 - 7 receive syslog messages in
fully-expanded format. The default value is 0.
-error on | off
(Optional) Specifies whether the server receives error notifications. Set to on, error notifications are
sent to the syslog server. Set to off, error notifications are not sent to the syslog server. The default
value is on.
-warning on | off
(Optional) Specifies whether the server receives warning notifications. Set to on, warning notifications
are sent to the syslog server. Set to off, warning notifications are not sent to the syslog server. The
default value is on.
-info on | off
(Optional) Specifies whether the server receives information notifications. Set to on, information
notifications are sent to the syslog server. Set to off, information notifications are not sent to the
syslog server. The default value is on.
Description
This command creates a syslog server to receive notifications. The syslog protocol is a client-server
standard for forwarding log messages from a sender to a receiver on an IP network. Syslog can be used
to integrate log messages from different types of systems into a central repository.
252 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
mksyslogserver -ip 1.2.3.4
rmemailserver
Use the rmemailserver command to delete the specified email server object.
Syntax
rmemailserver email_server_name
email_server_id
Parameters
email_server_name | email_server_id
(Required) Specifies the name or ID of the email server object to be deleted.
Description
Use this command to delete an existing email server object that describes a remote Simple Mail Transfer
Protocol (SMTP) email server. You must specify either the current name or the ID of the object returned at
creation time. Use the lsemailserver command to obtain this ID.
Note: Email service stops when the last email server is removed. Use the startemail command to
reactivate the email and inventory notification function after at least one email server has been
configured.
An invocation example
rmemailserver email4
rmemailuser
Use the rmemailuser command to remove a previously defined email recipient from the system.
Syntax
rmemailuser userid_or_name
Parameters
userid_or_name
(Required) Specifies the user ID or user name of the email recipient to remove.
Description
rmsnmpserver
Use the rmsnmpserver command to delete the specified Simple Network Management Protocol
(SNMP)server.
Syntax
rmsnmpserver snmp_server_name
snmp_server_id
Parameters
snmp_server_name | snmp_server_id
(Required) Specifies the name or ID of the SNMP server to be deleted.
Description
Use this command to delete an existing SNMP server. You must specify either the current name of the
server or the ID returned at creation time. Use the lssnmpserver command to obtain this ID.
An invocation example
rmsnmpserver snmp4
rmsyslogserver
Use the rmsyslogserver command to delete the specified syslog server.
Syntax
rmsyslogserver syslog_server_name
syslog_server_id
Parameters
syslog_server_name | syslog_server_id
(Required) Specifies the name or ID of the syslog server to be deleted.
254 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
Use this command to delete an existing syslog server. You must specify either the current name of the
server or the ID returned at creation time. Use the lssyslogserver command to obtain this ID.
An invocation example
rmsyslogserver 2
sendinventoryemail
Use the sendinventoryemail command to send an inventory email notification to all email recipients able
to receive inventory email notifications. There are no parameters for this command.
Syntax
sendinventoryemail
Parameters
Description
This command sends an inventory email notification to all email recipients who are enabled to receive
inventory email notifications. This command fails if the startemail command has not been processed and
at least one email recipient using the email event and inventory notification facility has not been set up to
receive inventory email notifications. This command also fails if the email infrastructure has not been set
up.
An invocation example
In the following example, you send an inventory email notification to all email recipients who are
enabled to receive them:
sendinventoryemail
setemail (Discontinued)
Attention: The setemail command is discontinued. E-mail notification can be configured using the
following commands: mkemailserver, chemailserver, rmemailserver, chemail, and lsemailserver.
startemail
Use the startemail command to activate the email and inventory notification function. There are no
parameters for this command.
Parameters
Description
This command enables the email event notification service. No emails are sent to users until the
startemail command has been run and at least one user has been defined to the system.
Note: This command fails if the chemail command has not been used to provide adequate configuration
details. The following chemail parameters must be specified:
v reply
v contact
v primary
v location
stopemail
Use the stopemail command to stop the email and inventory notification function. There are no
parameters for this command.
Syntax
stopemail
Parameters
Description
This command stops the email error notification function. No emails are sent to users until the
startemail command is reissued.
256 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
testemail
Use the testemail command to send an email notification to one user of the email notification function
or to all users of the email notification function to ensure that the function is operating correctly.
Syntax
testemail userid_or_name
-all
Parameters
userid_or_name
(Required if you do not specify -all) Specifies the user ID or user name of the email recipient that
you want to send a test email to. You cannot use this parameter with the -all parameter. The
userid_or_name value must not contain spaces.
-all
(Required if you do not specify userid_or_name) Sends a test email to all email users configured to
receive notification of events of any notification type. No attempt is made to send the test email to a
user who does not have any notification setting set to on.
Description
This command sends test emails to the specified users. The email recipient expects to receive the test
email within a specified service time. If the email is not received within the expected time period, the
recipient must contact the administrator to ensure that the email settings for the user are correct. If there
is still a problem, you must contact the IBM Support Center.
The email recipient uses the test email to check that the Simple Mail Transfer Protocol (SMTP) name, the
IP address, the SMTP port, and the user address are valid.
addcontrolenclosure
Use the addcontrolenclosure command to add control enclosures to the clustered system.
Syntax
addcontrolenclosure -iogrp io_grp_id_or_name -sernum enclosure_serial_number
Parameters
-iogrp io_grp_id_or_name
The I/O group in which you want to put the control enclosure.
-sernum enclosure_serial_number
The serial number of the control enclosure you want to add.
Description
An invocation example
addcontrolenclosure -iogrp 0 -sernum 2361443
chenclosure
Use the chenclosure command to modify enclosure properties.
Syntax
chenclosure -identify yes|no enclosure_id
-managed yes|no
-id enclosure_id
Parameters
Note: Optional parameters are mutually exclusive. Exactly one of the optional parameters must be set.
-identify yes|no
(Optional) Causes the identify LED start or stop flashing.
-managed yes|no
(Optional) Changes the enclosure to a managed or unmanaged enclosure.
Description
chenclosurecanister
Use the chenclosurecanister command to modify the properties of an enclosure canister.
Syntax
| chenclosurecanister -excludesasport yes -port 1
| no 2 -force
3
4
-identify yes
no
Note:
1. The -port and -excludesasport parameters must be specified together.
2. Exactly one of the optional parameters must be set.
Parameters
260 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: Using the -force flag might result in loss of access to your data.
-force
(Optional) Forces the enclosure on the canister to be excluded.
Important: Using the -force parameter might result in a loss of access. Use it only under the
direction of the IBM Support Center.
-identify yes | no
(Optional) Changes the state of fault light-emitting diode (LED) either to or from slow_flashing.
-port 1 | 2 | 3 | 4
(Optional) The SAS port to include or exclude.
Ports 3 and 4 are for Storwize V5000 only.
canister_id
The canister to which you want to apply the change.
enclosure_id
The enclosure for which the canister is a member.
Description
chenclosureslot
Use the chenclosureslot command to modify the properties of an enclosure slot.
Syntax
chenclosureslot -slot slot_id
-identify yes
no
-exclude yes
no -port port_id -force
enclosure_id
Note:
1. Optional parameters are mutually exclusive.
2. You can only specify the port parameter or the -force parameter when you also specify the -exclude
parameter.
Parameters
-identify yes | no
(Optional) Change the state of fault light-emitting diode (LED) to or from slow_flashing.
-exclude yes | no
(Optional) Ensures that an enclosure slot port is excluded. The following list gives details of the
options you can use with this parameter:
v -exclude yes -port port_id -slot slot_id enclosureid: The port you specify with port_id is excluded.
If the current state of the port is excluded_by_enclosure, excluded_by_drive, or
excluded_by_cluster, this command will appear to have no effect. However, if the current state of
the port is online, then that state will change to excluded_by_cluster. The port will remain
excluded until you rerun this command with no selected.
Attention: This command will check for dependent volumes. If issuing this command would
result in losing access to data, then the command will fail and an error message will display. You
can use the -force flag to ignore these errors, but this could result in loss of access to data.
v -exclude no -port port_id -slot slot_id enclosureid: The port is put into online state, provided
there are no other reasons to exclude the port. If you issue this command when the port is online,
then it will have no effect. However, if you issue this command when the port is excluded, then
the port state will do one of the following:
– Change to online status immediately.
– Change to online status after all other reasons for the port to be excluded have been removed.
v -exclude yes | no -slot slot_id enclosureid: If you issue this command without defining a port, the
command simultaneously acts on both ports.
-port 1 | 2
(Optional) The port on the canister to be excluded. If it is not specified, -exclude acts on both ports.
| -force
| (Optional) Forces the port on the canister to be excluded.
| Important: Using the -force parameter might result in a loss of access. Use it only under the
| direction of the IBM Support Center.
-slot slot_id
| (Required) The slot ID. The slots are numbered 1 (leftmost) to 24 (rightmost) when viewed from in
| front of the enclosure, in 24-slot enclosures. In 12-slot enclosures, the slots are arranged in numerical
| order in three rows with four slots. For example, the:
| v First row contains slots 1, 2, 3, and 4 (in that order)
| v Second row contains slots 5, 6,7, and 8 (in that order)
| v Third row contains slots 9, 10, 11, and 12 (in that order)
enclosure_id
(Required) The enclosure that the slot is a member of.
Description
262 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The resulting output:
No feedback
chenclosurevpd
Use the chenclosurevpd command to cause the partner node in the enclosure to warmstart, so that it can
acquire the changed midplane vital product data (VPD), and to change fields in the control enclosure
VPD.
Syntax
satask chenclosurevpd
-serial -type
serial_number machine_type
-wwnn1 -wwnn2 -resetclusterid -machinepartnumber mpn panel_name
wwnn1 wwnn2
Parameters
satask
System Administrator task; service commands that are only used in specific circumstances.
-serial serial_number
(Optional) The new serial number for the enclosure. The serial_number must be set on a replacement
enclosure to match the values of the enclosure being replaced.
-type machine_type
(Optional) The type of machine. The machine_type must be set on a replacement enclosure to match
the values of the enclosure being replaced.
-wwnn1 wwnn1
(Optional) The WWNN of canister 1. The wwnn1 must be set on a replacement enclosure to match the
values of the enclosure being replaced.
Note: If you change wwnn1 on an operating system, you might need to also change the host and
Fibre Channel configuration settings.
-wwnn2 wwnn2
(Optional) The WWNN of canister 2. The wwnn2 must be set on a replacement enclosure to match the
values of the enclosure being replaced.
Note: If you change wwnn2 on an operating system, you might need to also change the host and
Fibre Channel configuration settings.
-resetclusterid
(Optional) Requests that the stored cluster be zeroed out (eliminated).
Attention: The cluster ID indicates if the enclosure, and the drives it contains, are part of a cluster.
Resetting it indicates it is no longer part of a cluster, and any data required on the drives is not
required. This might result in loss of access to your data.
Description
Use this command to change fields in the control enclosure VPD. The node must be in candidate or
service state when you run this command, and cannot be part of a cluster.
An invocation example
satask chenclosurevpd -serial 123456
lsenclosure
Use the lsenclosure command to view a summary of the enclosures.
Syntax
lsenclosure
-filtervalue attribute_value -filtervalue?
-delim delimiter enclosure_id
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""): lsenclosure
-filtervalue id="1*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
v drive_slots
v id
v IO_group_id
v IO_group_name
v managed
v online_canisters
v online_PSUs
v product_MTM
v serial_number
264 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v status
v total_canisters
v total_PSUs
v type
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
enclosure_id
Detailed information for the enclosure that you specify.
Description
This command enables you to view a summary of the enclosures (including current status information for
canisters and power and cooling units, and other enclosure attributes). Table 41 shows the possible
outputs:
Table 41. lsenclosure output
Attribute Description
id Indicates the ID of the enclosure.
status Indicates if an enclosure is visible to the SAS network:
v online if a managed or unmanaged enclosure is visible
v offline if a managed enclosure is not visible, and other fields hold their last known
values.
v degraded if an enclosure is visible, but not down both strands
type Indicates the type of enclosure:
v control
v expansion
managed Indicates if the enclosure is managed:
v yes
v no
IO_group_id Indicates the I/O group the enclosure belongs to; blank if canisters are connected to two
different I/O groups.
IO_group_name Indicates the I/O group the enclosure belongs to; blank if canisters are connected to two
different I/O groups.
fault_LED Indicates the status of the fault light-emitting diode (LED) on the enclosure:
v on if a service action is required immediately on the enclosure or a component within
the enclosure (including a canister, power unit, or non-spared drive).
v slow_flashing if there is insufficient battery power to run I/O
v off if there are faults on the enclosure or its components
identify_LED Indicates the state of the identify LED:
v off if the enclosure is not identified
v slow_flashing if the enclosure is being identified
serial_number 64G005S
FRU_part_number 85Y5896
FRU_identity 11S85Y5962YHU9994G005S
total_canisters 2
online_canisters 2
total_PSUs 2
online_PSUs 2
266 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
drive_slots 12
firmware_level_1 10
firmware_level_2 F6C07926
machine_part_number 2072L2C
lsenclosurebattery
Use the lsenclosurebattery command to display information about the batteries in the enclosure power
supply units (PSUs).
Syntax
lsenclosurebattery
-delim delimiter
enclosure_id
-battery battery_id
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum width of each item of data. A detailed view provides each item of data
in its own row, and if the headers are displayed, the data is separated from the header by a space.
The -delim parameter overrides this behavior. Valid input for the -delim parameter is a one-byte
character. If you enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a detailed view, the
data is separated from its header by the specified delimiter.
-battery battery_id enclosure_id
(Optional) Provides a detailed view of the specified enclosure battery. Valid only when an enclosure
is specified.
enclosure_id
(Optional) Lists the batteries for the specified enclosure.
Description
This command displays information about the batteries in the enclosure PSUs. The concise view displays
a line for each battery slot in every control enclosure, regardless of whether they exist. Batteries are not
shown for expansion enclosures. Table 42 shows possible outputs.
Table 42. lsenclosurebattery outputs
Attribute Description
enclosure_id The identity of the enclosure that contains the battery.
battery_id Identifies the battery in the enclosure.
status The status of the battery:
v online: The battery is present and working as usual
v degraded: The battery is present but not working as usual
v offline: The battery cannot be detected
An invocation example
lsenclosurebattery -delim :
Syntax
lscontrolenclosurecandidate
Parameters
None.
268 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
Table 43 provides the possible values that are applicable to the attributes that are displayed as data in the
output views.
Table 43. lscontrolenclosurecandidate attribute values
Attribute Value
serial_number The serial number for the enclosure.
product_MTM The MTM for the enclosure.
lsenclosurecanister
Use the lsenclosurecanister command to view a detailed status for each canister in an enclosure.
Syntax
lsenclosurecanister
-delim delimiter
enclosure_id
-canister canister_id
Parameters
enclosure_id
Lists the canisters for the specified enclosure.
-canister canister_id
Valid only when the enclosure_id is specified. Provides a detailed view of the canister for the
specified enclosure.
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
Description
This command enables you to view a detailed status for each canister in an enclosure. Table 44 on page
270 shows the possible outputs:
270 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 44. lsenclosurecanister output (continued)
Attribute Description
firmware_level_2 The version of the first other microcode image (canister bootloader version) installed on
the canister.
firmware_level_3 The version of the second other microcode (canister complex programmable logic
device, or CPLD, version) image installed on the canister.
firmware_level_4 The version of the third other microcode image (canister flash configuration version)
installed on the canister.
firmware_level_5 The version of the canister metadata (canister VPD version) installed on the canister.
firmware_level_2 0501
firmware_level_3 14
firmware_level_4 B69F66FF
firmware_level_5 5C2A6A44
Syntax
lsenclosurechassis
enclosure_id
Description
This command has both a detailed and concise view. The enclosure_id keyword is required for the detailed
view.
The following table displays information about chassis-specific enclosure properties and shows possible
outputs.
Table 45. lsenclosurechassis outputs
Attribute Description
enclosure_id Specifies the enclosure identifier. It is a numeric character between the numbers 1
and 99.
chassis_name Specifies the chassis name. It can be set from the CMM, and is blank or an
alphanumeric string containing up to 128 characters.
canister_1_bay Specifies the first canister bay's enclosure position within the chassis. It is a
numeric character between the numbers 0 and 254.
canister_2_bay Specifies the second canister bay's enclosure position within the chassis. It is a
numeric character between the numbers 0 and 254.
numbering scheme Specifies the chassis numbering scheme set from the CMM. It can be a numeric
character between the numbers 0 and 255.
pos_in_rack Specifies the chassis position within the rack set from the CMM. It must be an
alphanumeric 2-character string.
rack_location Specifies the location of the rack containing the chassis set from the CMM. It can
be blank or an alphanumeric string containing up to 128 characters.
rack_room Specifies the room that contains the rack set from the CMM. It can be blank or an
alphanumeric string containing up to 128 characters.
chassis_mtm Specifies the chassis machine type or model. The type or model is an
alphanumeric string containing up to 22 characters.
chassis_sn Specifies the chassis serial number. The serial number is an alphanumeric string
containing up to 22 characters.
chassis_uuid Specifies the chassis unique user identifier. The identifier is an alphanumeric
string containing up to 128 characters.
chassis_rack Specifies the identifier for the rack that contains the chassis. The identifier is
blank or an alphanumeric string containing up to 128 characters.
An invocation example
lsenclosurechassis 1
272 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
chassis_mtm 2078-219
chassis_sn 64H123R
chassis_uuid 987654321
chassis_rack Rack47
lsenclosurepsu
Use the lsenclosurepsu command to view information about each power-supply unit (PSU) in the
enclosure.
Syntax
lsenclosurepsu
enclosure_id
-psu psu_id
-filtervalue attribute_value -filtervalue? -delim delimiter
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsenclosurepsu -filtervalue status
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
v enclosure_id
v psu_id
v status
-psu psu_id
(Optional) Valid only when the enclosure_id is specified. Provides a detailed view of the PSU for the
specified enclosure.
enclosure_id
(Optional) Lists the PSUs for the specified enclosure.
This command enables you to view information about each power-supply unit (PSU) in the enclosure.
Table 46 shows the possible outputs:
Table 46. lsenclosurepsu output
Attribute Description
enclosure_id Indicates the ID of the enclosure containing the PSU.
psu_id Indicates the ID of the PSU in the enclosure.
status Indicates the status of the power and cooling unit in the enclosure:
v online indicates a PSU is present and working normally
v offline indicates aa PSU cannot be detected
v degraded indicates a PSU is present but not working normally
fan_failed v on indicates that if the AC, DC, and fan LEDs are all on, there is a PSU fault. If only
the fan LED is on, then there is a fan failure.
v off indicates the fans in this PSU are OK.
redundant Indicates if you can remove this power supply:
v If the PSU is on an expansion enclosure, then the other PSU must be online.
v If the PSU is on a control enclosure, then the other PSU must be online, and the
battery on that PSU must contain enough charge to allow the canisters to dump state
and cache data before shutting down.
error_sequence_number Indicates the error log (or event log) number of the highest priority error for this object.
This is typically blank; however, if there is a problem (for example, the status is
degraded), then it contains the sequence number of that error event.
FRU_part_number Indicates the FRU part number of the PSU.
FRU_identity Indicates the 11S number, combining the manufacturing part number and the serial
number.
firmware_level_1 Indicates the version of the microcode image (power supply firmware version) installed
on the power supply.
firmware_level_2 Indicates the version of the power supply metadata (power supply vital product data,
or VPD, version) installed on the power supply.
An invocation example
lsenclosurepsu -delim :
274 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lsenclosureslot
Use the lsenclosureslot command to view information about each drive slot in the enclosure.
Syntax
lsenclosureslot
-delim delimiter -nohdr
-slot slot_id enclosure_id
enclosure_id
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. This parameter suppresses the display of these headings.
-slot slot_id
(Optional) Valid only when an enclosure is specified. Gives detailed view for that enclosure slot.
enclosure_id
(Optional) Lists slots for that enclosure. Must be specified if -slot is used.
Description
This command enables you to view information about each drive slot in the enclosure, such as whether a
drive is present, and the port status for that drive. Table 47 shows the possible outputs:
Table 47. lsenclosureslot output
Attribute Description
enclosure_id The identity of the enclosure which contains the drive slot.
slot_id Identifies which of the drive slots in the enclosure this is.
port_1_status The status of enclosure slot port 1. If the port is bypassed for multiple reasons, only one
is shown. In order of priority, they are:
v online: enclosure slot port 1 is online
v excluded_by_drive: the drive excluded the port
v excluded_by_enclosure: the enclosure excluded the port
v excluded_by_system: the clustered system (system) has excluded the port
An invocation example
lsenclosureslot -delim :
276 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
1:21:online:online:yes:8
1:22:online:online:yes:0
1:23:online:online:yes:3
1:24:online:online:yes:2
lsenclosurestats
Use the lsenclosurestats command to display the most recent values (averaged) of all enclosure
statistics. It can also display a history of those values for any given subset of the available statistics.
Syntax
lsenclosurestats
-filtervalue? -filtervalue attribute=value
enclosure_id
-history stat_list
Parameters
-history stat_list
(Optional) Produces a history of values for enclosure statistics.
enclosure_id
(Optional) Indicates the unique enclosure identifier (a number between 1 and 99).
-filtervalueattribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""):
lsenclosurestats -filtervalue stat_name=temp_f
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue parameter:
v enclosure_id
v stat_name
If you specify -history stat_list you must also specify enclosure_id. Filtering is supported for the
concise view but not the detailed view.
Multiple statistical histories can be requested. The limit is the current maximum number of different
statistical names published in the concise view. The concise view defines the output order.
For the detailed view, enclosure power is averaged over thirty seconds to provide immediate power.
Remember: This command cannot be used for products that do not support environmental statistics.
This is an invocation example for products that do not support environmental statistics - a message is
displayed:
lsenclosurestats
Table 48 displays information about chassis-specific enclosure properties and shows possible outputs for
products that support environmental statistics.
Table 48. lsenclosurestats outputs
Attribute Description
enclosure_id Indicates the enclosure identifier; it can be a numeric character between 1 and
264.
sample_time Indicates the time during which the sample occurred.
stat_name Indicates the name of the statistical field.
stat_current Indicates the current value of the statistical field.
stat_peak Indicates the peak value of the statistic field. The last five minutes is used for
samples.
stat_peak_time Indicates the time that the peak occurred.
stat_value Indicates the value of the statistic.
Remember: Filtering is supported on the enclosure_id and stat_name fields using the concise view.
An invocation example
lsenclosurestats
278 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
lsenclosurestats -history power_w 1
lssasfabric
Use the lssasfabric command to see which canisters are visible to a node, and the order of these
canisters.
Syntax
lssasfabric
Parameters
Description
Use this command to see which canisters are visible to a node, and the order of these canisters. Table 50
describes possible outputs.
Table 50. lssasfabric output
Attribute Description
enclosure_id The identity of the enclosure the strand goes to.
canister_id The canister in the enclosure that the strand goes to.
canister_port_id The canister port that the strand goes to.
control_enclosure_id The identity of the enclosure the strand comes from.
node_canister_id The identity of the canister the strand comes from.
node_canister_port_id The node canister port the strand is from. This should be the same as the chain ID.
position The position in the strand or chain.
IO_group_id The I/O group the strand belongs to. This should be the same as the enclosure IO
group.
IO_group_name The I/O group the strand belongs to. This should be the same as the enclosure IO
group.
node_id The identity of the node that the strand is from. This is the same physical object as
the node_canister
node_name The name of the node that the strand is from. This is the same physical object as
the node_canister.
Enclosure 1 is the control enclosure, Enclosure 2 is on chain 1 (node canister port 1) using canister port 1
as its connector, and Enclosure 3 is on chain 2 (node canister port 2) using canister port 2 as its connector.
280 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lssasfabric
Note: In this guide, the following output is split into two parts. This is for illustrative purposes; the
output will not appear in two parts when you run this command.
| This examples shows the output when using this command for a pair of expansion enclosures that are
| wired correctly to a set of BFN nodes.
| lssasfabric
resetleds
Use the resetleds command to simultaneously switch off all light-emitting diodes (LEDs) in the clustered
system (system).
Syntax
resetleds
Parameters
None.
Description
The command simultaneously switches off all LEDs in the system. This ensures that, when an identity
LED is switched on, it is the only one in the system. This command works only on LEDs on devices that
can be communicated with; it will fail if an object is offline or if the enclosure is an unsupported type.
Some LEDs are not affected by this command (for example, LEDs on independently controlled objects,
LEDs with hardware-only controls, or LEDs on offline objects).
triggerenclosuredump
Use the triggerenclosuredump command to force the specified enclosure or enclosures to dump data.
Syntax
triggerenclosuredump -port port_id -iogrp iogrp_id_or_name
-enclosure enclosure_id
Note:
1. You can only use one of the optional parameters (-port or -enclosure).
2. If -port is specified, -iogrp must also be specified.
3. If -iogrp is specified, -port must also be specified.
Parameters
-port port_id
(Optional) If the system is wired correctly, this value is identical to the ID of the chain with the
enclosures you want to dump. If the system is wired incorrectly, all the enclosures connected to port
port_id of either node canister are dumped.
-iogrp iogrp_id_or_name
(Optional) The ID or name of the I/O group the control enclosure belongs to.
-enclosure enclosure_id
(Optional) The ID of the enclosure you want to dump.
Description
This command requests the canisters in the enclosure or enclosures specified to dump data. The dumped
data is subsequently collected and moved to /dumps/enclosure on the nodes that are connected to the
enclosure. There is one file for each canister successfully dumped and they may be located on different
nodes. Dumps are for use by the IBM Support Center, which has the tools to interpret the dump data.
Use the cpdumps command to copy the files from the system. This command does not disrupt access to
the enclosures.
To trigger enclosure dumps from all enclosures connected to port 1 of the control
enclosure in iogrp 2
triggerenclosuredump -port 1 -iogrp 2
282 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The data is dumped to the /dumps/enclosure directory if command is successful.
chlicense
Use the chlicense command to change license settings for clustered system (system) features.
Syntax
This applies to Storwize V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700:
Parameters
This applies to Storwize V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700:
-flash capacity_TB
(Optional) Changes system licensing for the FlashCopy feature. To change the licensed capacity for
the FlashCopy feature, specify a capacity in terabytes (TB).
Note: Only use the optional flash parameter with the SAN Volume Controller.
-remote capacity_TB
(Optional) Changes system licensing for the Metro Mirror and Global Mirror feature. To change the
licensed capacity for the Metro Mirror and Global Mirror feature, specify a capacity in terabytes (TB).
Note: For Storwize V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700, specify
the total number of internal and external enclosures that you have licensed on your system. You must
have a Remote Mirroring license for all enclosures.
-virtualization capacity_TB
(Optional) Changes system licensing for the Virtualization feature. To change the licensed capacity for
the Virtualization feature, specify a capacity in terabytes (TB).
Note: For Storwize V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700, specify
the number of enclosures of external storage that you have been authorized by IBM to use.
Note: All Storwize V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700 systems
support compression.
Note: Not all SAN Volume Controller systems support compression. However, you can set a
compression license value on a system that has no nodes that support compression.
Note:
v If the -physical_disks value is set to zero, the -physical_flash and -physical_remote values are
turned off.
v If the -physical_disks value is nonzero, the -flash, -remote, and -virtualization values cannot
be set.
v If the -physical_disks value is nonzero, only the FlashCopy and RemoteCopy usage is monitored
and appropriate error messages are logged.
v If the -flash, -remote, or -virtualization values are nonzero, the -physical_flash,
-physical_remote, and -physical_disks values cannot be set.
Description
The chlicense command changes license settings for the system. Any change that is made is logged as an
event in the license setting log.
For Storwize V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700, the enclosure license
already includes virtualization of internal drives on your system. You can use this command to set any
additional options. The total amounts for your system or systems must not exceed the total capacity
authorization that you have obtained from IBM.
For SAN Volume Controller the default is to have no copy services functions licensed, but this does not
stop you from creating and using Copy Services. However, errors are placed in the license settings log
that state that you are using an unlicensed feature. The command-line tool return code also notifies you
that you are using an unlicensed feature.
For Storwize V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700, the default is to have
no Metro Mirror or Global Mirror function licensed, but this does not stop you from creating and using
Copy Services. However, errors are placed in the license settings log that state that you are using an
unlicensed feature. The command-line tool return code also notifies you that you are using an unlicensed
feature.
The total virtualized capacity can also be modified with this command. This is the number of terabytes
(TB) of virtual disk capacity that can be configured by the system.
286 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
When you reach 90% capacity, any attempt to create or extend Virtual Disks, Relationships, or Mappings
results in a message from the command-line tool. This does not stop you from creating and expanding
Virtual Disks, Relationships, or Mappings. When usage reaches or exceeds 100% capacity, errors are
placed in the license settings log.
Any error that is placed in the license settings log results in a generic error being placed in the system
error log. This occurs when you issue a command that violates the license agreement. The return code
also notifies you that you are violating the license settings.
An invocation example
chlicense -remote 5
An invocation example
The resulting output:
No feedback
dumpinternallog
Use the dumpinternallog command to dump the contents of the license settings error and event log to a
file on the current configuration node.
Syntax
dumpinternallog
Parameters
None
Description
This command dumps the contents of the internal license settings error and event log to a file on the
current configuration node.
This file is always called feature.txt and is created, or overwritten, in the /dumps/feature directory on
the configuration node.
Before making any entries, the license settings log contains only zeros. A dump of this log from the
dumpinternallog command results in an empty file.
lslicense
Use the lslicense command to display current license settings for clustered system (system) features.
Syntax
lslicense
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) Suppresses the display of these headings. By default, headings are displayed for each
column of data (in a concise style view providing general information about objects of a particular
type) and for each item of data (in a detailed style view providing much more information about a
specific object of a particular type).
Description
The lslicense command displays license settings for system features, including remote copy and
virtualization settings.
SAN Volume Controller also includes FlashCopy settings. The displayed output for SAN Volume
Controller lists capacity values in terabytes (TB) and feature enablement. The displayed output for
Storwize V7000, Flex System V7000 Storage Node, Storwize V3500, and Storwize V3700 lists enclosure
license values.
Use the chlicense command to change the feature license settings. Because the feature license settings are
entered when the system is first created, you must only update the settings if you have changed your
license.
Table 51 provides the possible values that are applicable to the attributes that are displayed as data in the
output views.
Table 51. lslicense output
Attribute Possible Values
used_flash Indicates the amount Flash Copy (FC) memory used.
used_remote Indicates the amount of remote copy memory used.
288 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 51. lslicense output (continued)
Attribute Possible Values
used_virtualization Indicates the amount of virtualization memory used.
license_flash Indicates the FC license settings.
license_remote Indicates remote copy license settings.
license_virtualization Indicates license virtualization settings.
license_physical_disks Indicates the amount of physical disk space available for
the license.
license_physical_flash Indicates if the license physical flash is on or off.
license_physical_remote Indicates if the license physical remote is on or off.
used_compression_capacity Indicates the total virtual size of volumes with
compressed copies, in total bytes (numeric format with
two decimal places).
license_compression_capacity Indicates the licensed compression capacity, in total bytes
(numeric format).
license_compression_enclosures Indicates which licensed enclosures have compression
(numeric format).
license_easy_tier Indicates which enclosures Easy Tier can be run on.
An invocation example
lslicense
chfcconsistgrp
Use the chfcconsistgrp command to change the name of a consistency group or marks the group for
auto-deletion.
Syntax
chfcconsistgrp
-name new_name_arg -autodelete on | off
fc_consist_group_id
fc_consist_group_name
Parameters
-name new_name_arg
(Optional) Specifies the new name to assign to the consistency group.
-autodelete on | off
(Optional) Deletes the consistency group when the last mapping that it contains is deleted or
removed from the consistency group.
fc_consist_group_id | fc_consist_group_name
(Required) Specifies the ID or existing name of the consistency group that you want to modify.
Description
The chfcconsistgrp command changes the name of a consistency group, marks the group for
auto-deletion, or both.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
chfcconsistgrp -name testgrp1 fcconsistgrp1
chfcmap
Use the chfcmap command to modify attributes of an existing mapping.
Syntax
chfcmap
-name new_name_arg -force
fc_map_id
-autodelete on -cleanrate rate fc_map_name
off
Parameters
-name new_name_arg
(Optional) Specifies the new name to assign to the mapping. The -name parameter cannot be used
with any other optional parameters.
-force
(Optional) Specifies that the mapping be modified to a stand-alone mapping (equivalent to creating
the mapping without a consistency group ID). You cannot specify the -force parameter with the
-consistgrp parameter.
-consistgrp consist_group_id | consist_group_name
(Optional) Specifies the consistency group for which you want to modify the mapping. You cannot
specify the -consistgrp parameter with the -force parameter.
Note: The consistency group cannot be modified if the specified consistency group is in the
preparing, prepared, copying, suspended, or stopping. .
-copyrate rate
(Optional) Specifies the copy rate. The rate value can be 0 - 100. The default value is 50. A value of 0
indicates no background copy process. For the supported -copyrate values and their corresponding
rates, see Table 52 on page 293.
-autodelete on | off
(Optional) Specifies that the autodelete function be turned on or off for the specified mapping. When
you specify the -autodelete on parameter, you are deleting a mapping after the background copy
completes. If the background copy is already complete, the mapping is deleted immediately.
-cleanrate rate
(Optional) Sets the cleaning rate for the mapping. The rate value can be 0 - 100. The default value is
50.
fc_map_id | fc_map_name
(Required) Specifies the ID or name of the mapping to modify. Enter the ID or name last on the
command line.
Description
Attention: You must enter the fc_map_id | fc_map_name last on the command line.
If you have created several FlashCopy mappings for a group of VDisks (volumes) that contain elements
of data for the same application, you can assign these mappings to a single FlashCopy consistency group.
You can then issue a single prepare command and a single start command for the whole group, for
example, so that all of the files for a particular database are copied at the same time.
The -copyrate parameter specifies the copy rate. If 0 is specified, background copy is disabled. The
-cleanrate parameter specifies the rate for cleaning the target volume. The cleaning process is only active
if the mapping is in the copying state and the background copy has completed, the mapping is in the
copying state and the background copy is disabled, or the mapping is in the stopping state. You can
292 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
disable cleaning when the mapping is in the copying state by setting the -cleanrate parameter to 0. If the
-cleanrate is set to 0, the cleaning process runs at the default rate of 50 when the mapping is in the
stopping state to ensure that the stop operation completes.
Table 52 provides the relationship of the copy rate and cleaning rate values to the attempted number of
grains to be split per second. A grain is the unit of data represented by a single bit.
Table 52. Relationship between the rate, data rate and grains per second values
User-specified rate
attribute value Data copied/sec 256 KB grains/sec 64 KB grains/sec
1 - 10 128 KB 0.5 2
11 - 20 256 KB 1 4
21 - 30 512 KB 2 8
31 - 40 1 MB 4 16
41 - 50 2 MB 8 32
51 - 60 4 MB 16 64
61 - 70 8 MB 32 128
71 - 80 16 MB 64 256
81 - 90 32 MB 128 512
91 - 100 64 MB 256 1024
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
chfcmap -name testmap 1
lsfcconsistgrp
Use the lsfcconsistgrp command to display a concise list or a detailed view of FlashCopy consistency
groups that are visible to the clustered system (system). This information is useful for tracking FlashCopy
consistency groups.
The list report style can be used to obtain two styles of report:
v A list containing concise information about all of the FlashCopy consistency groups on a system. (Each
entry in the list corresponds to a single FlashCopy consistency group.)
v The detailed information about a single FlashCopy consistency group.
Syntax
lsfcconsistgrp
-filtervalue attribute=value -nohdr
-delim delimiter -filtervalue? object_id
object_name
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is an asterisk character (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
v When you use a wildcard, surround the filter entry with double quotation marks (""), as follows:
lsfcconsistgrp -filtervalue "name=md*"
-nohdr
(Optional) By default, headings are displayed for each item of data in a concise view. The -nohdr
parameter suppresses the display of these headings. Detailed view is not valid for this command.
Description
This command returns a concise list or a detailed view of FlashCopy consistency groups that are visible
to the system.
The following list provides values of the status attribute that are displayed as data in the output views:
status empty, idle_or_copied, preparing, prepared, copying, stopped, suspended, stopping
start_time
Specifies the time the group was started in YYMMDDHHMMSS format (or blank).
294 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
A concise invocation example
lsfcconsistgrp -delim :
lsfcmap
Use the lsfcmap command generate a list containing concise information about all of the FlashCopy
mappings that are visible to the cluster, or detailed information for a single FlashCopy mapping.
Syntax
lsfcmap
-filtervalue attribute=value -nohdr
-delim delimiter -filtervalue? object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""), as follows:
Description
This command returns a concise list or a detailed view of FlashCopy mappings that are visible to the
cluster.
The following list shows attribute values that can be displayed as output view data:
status idle_or_copied, preparing, prepared, copying, stopped, suspended or stopping
start_time
Displays the time that the copy was last started. It is in the format YYMMDDHHMMSS. If a copy
has not been started, a blank line is displayed.
296 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: Using rc_controlled indicates that the map is for internal use only. It cannot be manipulated
externally.
lsfcmapcandidate
Use the lsfcmapcandidate command to list all of the VDisks (volumes) that are associated with fewer
than 256 FlashCopy mappings.
Syntax
lsfcmapcandidate
-nohdr -source -target
-delim delimiter
Description
This command returns a list of volumes that are associated with fewer than 256 FlashCopy mappings.
An invocation example
lsfcmapcandidate
lsfcmapprogress
Use the lsfcmapprogress command to display the progress of the background copy of a FlashCopy
mapping. This information is displayed as a percentage-completed value.
Syntax
lsfcmapprogress fcmap_id
-nohdr -delim delimiter fcmap_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each item of data in a detailed style view. The
-nohdr parameter suppresses the display of these headings.
298 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
parameter overrides this behavior. Valid input for the -delim parameter is a one byte character. If you
enter -delim : on the command line, the data is separated from its header by a colon character (:).
fcmap_id | fcmap_name
(Required) Specifies that you want the report to display the progress of the background copy for the
designated FlashCopy mapping.
Description
This command reports a percentage for the progress of the background copy being done on the specified
FlashCopy mapping.
An invocation example
lsfcmapprogress 0
lsfcmapdependentmaps
Use the lsfcmapdependentmaps command to display the FlashCopy mappings that are dependent on the
user specified mapping.
Syntax
lsfcmapdependentmaps fc_id
-nohdr -delim delimiter fc_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command returns a list of dependent FlashCopy mappings. This command can be used to determine
the list of FlashCopy mappings that would also stop if you stopped a mapping using the -force parmeter.
Note: If a period of time elapses between the time you process the lsfcmap command and the
lsfcmapdependentmaps command, there could be a difference between the actual number of dependent
mappings being processed and the number that was reported by the lsfcmap command.
An invocation example
lsfcmapdependentmaps -delim : 2
lsrmvdiskdependentmaps
Use the lsrmvdiskdependentmaps command to display all FlashCopy mappings that must be stopped for
the specified volume to be deleted.
Syntax
lsrmvdiskdependentmaps vdisk_name
-nohdr -delim delimiter vdisk_id
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command returns a list of the FlashCopy mappings that must be stopped before the specified
volume can be deleted. Any mappings that are returned in the list for the volume are automatically
stopped when the volume is deleted with the force option.
300 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
lsrmvdiskdependentmaps -delim : 0
mkfcconsistgrp
Use the mkfcconsistgrp command to create a new FlashCopy consistency group and identification name.
Syntax
mkfcconsistgrp
-name consist_group_name -autodelete
Parameters
-name consist_group_name
(Optional) Specifies a name for the consistency group. If you do not specify a consistency group
name, a name is automatically assigned to the consistency group. For example, if the next available
consistency group ID is id=2, the consistency group name is fccstgrp2.
-autodelete
(Optional) Deletes the consistency group when the last mapping that it contains is deleted or
removed from the consistency group.
Description
This command creates a new consistency group and identification name. The ID of the new group is
displayed when the command process completes.
If you have created several FlashCopy mappings for a group of VDisks (volumes) that contain elements
of data for the same application, you might find it convenient to assign these mappings to a single
FlashCopy consistency group. You can then issue a single prepare command and a single start command
for the whole group, for example, so that all of the files for a particular database are copied at the same
time.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
Remember: Names representing Metro Mirror or Global Mirror consistency groups relationships are
restricted to fifteen characters in length (not sixty-three for an extended character set).
An invocation example
mkfcconsistgrp
mkfcmap
Use the mkfcmap command to create a new FlashCopy mapping, which maps a source VDisk (volume) to
a target volume for subsequent copying.
-name new_name_arg -consistgrp consist_group_id
consist_group_name
-copyrate rate -autodelete -grainsize 64 -incremental
256
-cleanrate rate -iogrp iogroup_name
iogroup_id
Parameters
-source src_vdisk_id | src_vdisk_name
(Required) Specifies the ID or name of the source volume.
-target target_vdisk_id | target_vdisk_name
(Required) Specifies the ID or name of the target volume.
-name new_name_arg
(Optional) Specifies the name to assign to the new mapping.
-consistgrp consist_group_id | consist_group_name
(Optional) Specifies the consistency group to add the new mapping to. If you do not specify a
consistency group, the mapping is treated as a stand-alone mapping.
-copyrate rate
(Optional) Specifies the copy rate. The rate value can be 0 - 100. The default value is 50. A value of 0
indicates no background copy process. For the supported -copyrate values and their corresponding
rates, see Table 53 on page 303.
-autodelete
(Optional) Specifies that a mapping be deleted when the background copy completes. The default,
which applies if this parameter is not entered, is that autodelete is set to off.
-grainsize 64 | 256
(Optional) Specifies the grain size for the mapping. The default value is 256. Once set, this value
cannot be changed.
Remember: If either the source or target disk contains compressed copies, the default value is 64
(unless source or target disk is part of a mapping with grainsize 256 KB).
-incremental
(Optional) Marks the FlashCopy mapping as an incremental copy. The default is nonincremental.
Once set, this value cannot be changed.
-cleanrate rate
(Optional) Sets the cleaning rate for the mapping. The rate value can be 0 - 100. The default value is
50.
-iogrp iogroup_name | iogroup_id
(Optional) Specifies the I/O group for the FlashCopy bitmap. Once set, this value cannot be changed.
The default I/O group is either the source volume, if a single target map, or the I/O group of the
other FlashCopy mapping to which either the source or target VDisks (volumes) belong.
302 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: If not enough bitmap space is available to complete this command, more space will
automatically be allocated in the bitmap memory (unless you have already reached the maximum
bitmap memory).
Description
This command creates a new FlashCopy mapping. This mapping persists until it is manually deleted, or
until it is automatically deleted when the background copy completes and the autodelete parameter set
to on. The source and target VDisks (volumes) must be specified on the mkfcmap command. The mkfcmap
command fails if the source and target volumes are not identical in size. Issue the lsvdisk -bytes
command to find the exact size of the source volume for which you want to create a target disk of the
same size. The target volume that you specify cannot be a target volume in an existing FlashCopy
mapping. A mapping cannot be created if the resulting set of connected mappings exceeds 256 connected
mappings.
The mapping can optionally be given a name and assigned to a consistency group, which is a group of
mappings that can be started with a single command. These are groups of mappings that can be
processed at the same time. This enables multiple VDisks (volumes) to be copied at the same time, which
creates a consistent copy of multiple disks. This consistent copy of multiple disks is required by some
database products in which the database and log files reside on different disks.
If the specified source and target VDisks (volumes) are the target and source volumes, respectively, of an
existing mapping, then the mapping being created and the existing mapping become partners. If one
mapping is created as incremental, then its partner is automatically incremental. A mapping can have
only one partner.
You can create a FlashCopy mapping in which the target volume is a member of a Metro Mirror or
Global Mirror relationship, unless one of the following conditions applies:
v The relationship is with a clustered system that is running an earlier code level.
v The I/O group for the mapping is different than the I/O group for the proposed mapping target
volume.
The copyrate parameter specifies the copy rate. If 0 is specified, background copy is disabled. The
cleanrate parameter specifies the rate for cleaning the target volume. The cleaning process is only active
if the mapping is in the copying state and the background copy has completed, the mapping is in the
copying state and the background copy is disabled, or the mapping is in the stopping state. You can
disable cleaning when the mapping is in the copying state by setting the cleanrate parameter to 0. If the
cleanrate is set to 0, the cleaning process runs at the default rate of 50 when the mapping is in the
stopping state to ensure that the stop operation completes.
Table 53 provides the relationship of the copy rate and cleaning rate values to the attempted number of
grains to be split per second. A grain is the unit of data represented by a single bit.
Remember: If either the specified source or target volume is defined as a change volume for a
relationship, mkfcmap is not successful.
Table 53. Relationship between the rate, data rate and grains per second values
User-specified rate
attribute value Data copied/sec 256 KB grains/sec 64 KB grains/sec
1 - 10 128 KB 0.5 2
11 - 20 256 KB 1 4
21 - 30 512 KB 2 8
31 - 40 1 MB 4 16
41 - 50 2 MB 8 32
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
mkfcmap -source 0 -target 2 -name mapone
prestartfcconsistgrp
Use the prestartfcconsistgrp command to prepare a consistency group (a group of FlashCopy
mappings) so that the consistency group can be started. This command flushes the cache of any data that
is destined for the source volume and forces the cache into the write-through mode until the consistency
group is started.
Syntax
prestartfcconsistgrp fc_consist_group_id
-restore fc_consist_group_name
Parameters
-restore
(Optional) Specifies the restore flag. This forces the consistency group to be prepared even if the
target volume of one of the mappings in the consistency group is being used as a source volume of
another active mapping. An active mapping is in the copying, suspended, or stopping state.
fc_consist_group_id | fc_consist_group_name
(Required) Specifies the name or ID of the consistency group that you want to prepare.
Description
This command prepares a consistency group (a group of FlashCopy mappings) to subsequently start. The
preparation step ensures that any data that resides in the cache for the source volume is first flushed to
disk. This step ensures that the FlashCopy target volume is identical to what has been acknowledged to
the host operating system as having been written successfully to the source volume.
You can use the restore parameter to force the consistency group to be prepared even if the target
volume of one or more mappings in the consistency group is being used as a source volume of another
active mapping. In this case the mapping restores as shown in the lsfcmap view. If the restore parameter
is specified when preparing a consistency group where none of the target volumes are the source volume
of another active mapping, then the parameter is ignored.
304 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
You must issue the prestartfcconsistgrp command to prepare the FlashCopy consistency group before
the copy process can be started. When you have assigned several mappings to a FlashCopy consistency
group, you must issue a single prepare command for the whole group to prepare all of the mappings at
once.
The consistency group must be in the idle_or_copied or stopped state before it can be prepared. When
you enter the prestartfcconsistgrp command, the group enters the preparing state. After the
preparation is complete, the consistency group status changes to prepared. At this point, you can start the
group.
If FlashCopy mappings are assigned to a consistency group, the preparing and the subsequent starting of
the mappings in the group must be performed on the consistency group rather than on an individual
FlashCopy mapping that is assigned to the group. Only stand-alone mappings, which are mappings that
are not assigned to a consistency group, can be prepared and started on their own. A FlashCopy
consistency group must be prepared before it can be started.
This command is rejected if the target of a FlashCopy mapping in the consistency group is in a Metro
Mirror or Global Mirror relationship, except where the relationship is one of the following types and is
the secondary target of the remote copy:
v idling
v disconnected
v consistent_stopped
v inconsistent_stopped
The FlashCopy(r) mapping also fails in the following cases:
v You use the prep parameter.
v The target volume is an active remote copy primary or secondary volume.
v The FlashCopy target (and remote copy primary target) volume is offline. If this occurs, the FlashCopy
mapping stops and the target volume remains offline.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
prestartfcconsistgrp 1
prestartfcmap
Use the prestartfcmap command to prepare a FlashCopy mapping so that it can be started. This
command flushes the cache of any data that is destined for the source volume and forces the cache into
the write-through mode until the mapping is started.
Syntax
prestartfcmap fc_map_id
-restore fc_map_name
Description
This command prepares a single mapping for subsequent starting. The preparation step ensures that any
data that resides in the cache for the source volume is first transferred to disk. This step ensures that the
copy that is made is consistent with what the operating system expects on the disk.
The restore parameter can be used to force the mapping to be prepared even if the target volume is
being used as a source volume of another active mapping. In this case, the mapping is restoring as
shown in the lsfcmap view. If the restore parameter is specified when preparing a mapping where the
target volume is not the source volume of another active mapping, then the parameter is ignored.
Note: To prepare a FlashCopy mapping that is part of a consistency group, you must use the
prestartfcconsistgrp command.
The mapping must be in the idle_or_copied or stopped state before it can be prepared. When the
prestartfcmap command is processed, the mapping enters the preparing state. After the preparation is
complete, it changes to the prepared state. At this point, the mapping is ready to start.
This command is rejected if the target of the FlashCopy mappings is the secondary volume in a Metro
Mirror or Global Mirror relationship (so that the FlashCopy target is the remote copy secondary).
Note: If the remote copy is idling or disconnected, even if the FlashCopy and remote copy are pointing
to the same volume, the auxiliary volume is not necessarily the secondary volume. In this case, you can
start a FlashCopy mapping.
The FlashCopy mapping also fails in the following cases:
v The remote copy is active.
v The FlashCopy target (and remote copy primary target) volume is offline. If this occurs, the FlashCopy
mapping stops and the target volume remains offline.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
prestartfcmap 1
rmfcconsistgrp
Use the rmfcconsistgrp command to delete a FlashCopy consistency group.
306 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
rmfcconsistgrp fc_consist_group_id
-force fc_consist_group_name
Parameters
-force
(Optional) Specifies that all of the mappings that are associated with a consistency group that you
want to delete are removed from the group and changed to stand-alone mappings. This parameter is
only required if the consistency group that you want to delete contains mappings.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
fc_consist_group_id | fc_consist_group_name
(Required) Specifies the ID or name of the consistency group that you want to delete.
Description
This command deletes the specified FlashCopy consistency group. If there are mappings that are
members of the consistency group, the command fails unless you specify the -force parameter. When
you specify the -force parameter, all of the mappings that are associated with the consistency group are
removed from the group and changed to stand-alone mappings.
To delete a single mapping in the consistency group, you must use the rmfcmap command.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
rmfcconsistgrp fcconsistgrp1
rmfcmap
Use the rmfcmap command to delete an existing mapping.
Syntax
rmfcmap fc_map_id
-force fc_map_name
Parameters
-force
(Optional) Specifies that the target volume is brought online. This parameter is required if the
FlashCopy mapping is in the stopped state.
fc_map_id | fc_map_name
(Required) Specifies the ID or name of the FlashCopy mapping to delete. Enter the ID or name last
on the command line.
The rmfcmap command deletes the specified mapping if the mapping is in the idle_or_copied or stopped
state. If it is in the stopped state, the -force parameter is required. If the mapping is in any other state,
you must stop the mapping before you can delete it.
Deleting a mapping only deletes the logical relationship between the two virtual disks; it does not affect
the virtual disks themselves. However, if you force the deletion, the target virtual disk (which might
contain inconsistent data) is brought back online.
If the target of the FlashCopy mapping is a member of the remote copy, the remote copy can be affected
in the following ways:
v If a stopped FlashCopy mapping is deleted and the I/O group associated with the FlashCopy mapping
is suspended while this delete is being processed, then all remote copy relationships associated with
the target volume of a the FlashCopy mapping that were active while the FlashCopy mapping was
copying can be corrupted. You must resynchronize them next time you start the system.
v If a stopped FlashCopy mapping that has previously failed to prepare is deleted, then all remote copy
relationships in the set of remote copy relationships associated with the target volume can be
corrupted. You must resynchronize them next time you start the system.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
rmfcmap testmap
startfcconsistgrp
Use the startfcconsistgrp command to start a FlashCopy consistency group of mappings. This
command makes a point-in-time copy of the source volumes at the moment that the command is started.
Syntax
startfcconsistgrp fc_consist_group_id
-prep -restore fc_consist_group_name
Parameters
-prep
(Optional) Specifies that the designated FlashCopy consistency group be prepared prior to starting
the FlashCopy consistency group. A FlashCopy consistency group must be prepared before it can be
started. When you use this parameter, the system automatically issues the prestartfcconsistgrp
command for the group that you specify.
-restore
(Optional) Specifies the restore flag. When combined with the prep option, this forces the consistency
group to be prepared even if the target volume of one of the mappings in the consistency group is
being used as a source volume in another active mapping. An active mapping is in the copying,
suspended, or stopping state.
fc_consist_group_id | fc_consist_group_name
(Required) Specifies the ID or name of the consistency group mapping to start.
308 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
This command starts a consistency group, which results in a point-in-time copy of the source volumes of
all mappings in the consistency group. You can combine the restore parameter with the prep parameter
to force the consistency group to be prepared prior to starting, even if the target volume of one or more
mappings in the consistency group is being used as a source volume of another active mapping. In this
case, the mapping is restoring as shown in the lsfcmap view. If the restore parameter is specified when
starting a consistency group where none of the target volumes are the source volume of another active
mapping, the parameter is ignored.
If a consistency group is started and the target volume of the mapping being started has up to four other
incremental FlashCopy mappings using the target, the incremental recording is left on. If there are more
than four other incremental FlashCopy mappings using the target volume, the incremental recording for
all of these mappings is turned off until they are restarted.
Note: The startfcconsistgrp command can take some time to process particularly if you have specified
the prep parameter. If you use the prep parameter, you give additional processing control to the system
because the system must prepare the mapping before the mapping is started. If the prepare process takes
too long, the system completes the prepare but does not start the consistency group. In this case, error
message CMMVC6209E displays. To control the processing times of the prestartfcconsistgrp and
startfcconsistgrp commands independently of each other, do not use the prep parameter. Instead, first
issue the prestartfcconsistgrp command, and then issue the startfcconsistgrp command to start the
copy.
This command is rejected if the target of the FlashCopy mapping in the specified consistency group is the
secondary volume in a Metro Mirror or Global Mirror relationship (so that the FlashCopy target is the
remote copy secondary).
Note: If the remote copy is idling or disconnected, even if the FlashCopy and remote copy are pointing
to the same volume, the auxiliary volume is not necessarily the secondary volume. In this case, you can
start a FlashCopy mapping.
The FlashCopy mapping also fails in the following cases, if the target of the FlashCopy mapping in the
specified consistency group is the primary volume in a Metro Mirror or Global Mirror relationship (so
that the FlashCopy target is the remote copy primary):
v The remote copy is active.
v The FlashCopy target (and remote copy primary target) volume is offline. If this occurs, the FlashCopy
mapping stops and the target volume remains offline.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
startfcconsistgrp -prep 2
startfcmap
Use the startfcmap command to start a FlashCopy mapping. This command makes a point-in-time copy
of the source volume at the moment that the command is started.
Parameters
-prep
(Optional) Specifies that the designated mapping be prepared prior to starting the mapping. A
mapping must be prepared before it can be started. When you use this parameter, the system
automatically issues the prestartfcmap command for the group that you specify.
Note: If you have already used the prestartfcmap command, you cannot use the -prep parameter on
the startfcmap command; the command fails. However, if the FlashCopy has successfully prepared
before, the startfcmap command succeeds.
-restore
(Optional) Specifies the restore flag. When combined with the prep option, this forces the mapping to
be prepared even if the target volume is being used as a source volume in another active mapping.
An active mapping is in the copying, suspended, or stopping state.
fc_map_id | fc_map_name
Specifies the ID or name of the mapping to start.
Description
This command starts a single mapping, which results in a point-in-time copy of the source volume. You
can combine the restore parameter with the prep parameter to force the mapping to be prepared prior to
starting, even if the target volume is being used as a source volume of another active mapping. In this
case, the mapping is restoring as shown in the lsfcmap view. If the restore parameter is specified when
starting a mapping where the target volume is not the source volume of another active mapping, the
parameter is ignored and the mapping is not restoring as shown in the lsfcmap view.
If a mapping is started and the target volume of the mapping being started has up to four other
incremental FlashCopy mappings using the target, the incremental recording is left on. If there are more
than four other incremental FlashCopy mappings using the target volume, the incremental recording for
all of these mappings is turned off until they are restarted.
Note: The startfcmap command can take some time to start, particularly if you use the prep parameter.
If you use the prep parameter, you give additional starting control to the system. The system must
prepare the mapping before the mapping is started. To keep control when the mapping starts, you must
issue the prestartfcmap command before you issue the startfcmap command.
This command is rejected if the target of the FlashCopy mapping is the secondary volume in a Metro
Mirror or Global Mirror relationship (so that the FlashCopy target is the remote copy secondary).
Note: If the remote copy is idling or disconnected, even if the FlashCopy and remote copy are pointing
to the same volume, the auxiliary volume is not necessarily the secondary volume. In this case, you can
start a FlashCopy mapping.
The FlashCopy mapping also fails in the following cases, if the target of the FlashCopy mapping is the
primary volume in a Metro Mirror or Global Mirror relationship (so that the FlashCopy target is the
remote copy primary):
v The remote copy is active.
v The FlashCopy target (and remote copy primary target) volume is offline. If this occurs, the FlashCopy
mapping stops and the target volume remains offline.
310 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
startfcmap -prep 2
stopfcconsistgrp
Use the stopfcconsistgrp command to stop all processing that is associated with a FlashCopy
consistency group that is in one of the following processing states: prepared, copying, stopping, or
suspended.
Syntax
stopfcconsistgrp fc_consist_group_id_or_name
-force
-split
Parameters
-force
(Optional) Specifies that all processing that is associated with the mappings of the designated
consistency group be stopped immediately.
Note: When you use this parameter, all FlashCopy mappings that depend on the mappings in this
group (as listed by the lsfcmapdependentmaps command) are also stopped.
If the -force parameter is not specified, the command is rejected if the target volume of the
FlashCopy consistency group is the primary in a relationship that is mirroring I/O:
v consistent_synchronized
v consistent_copying
v inconsistent_copying
If the -force parameter is specified, any Metro Mirror or Global Mirror relationships associated with
the target volumes of the FlashCopy mappings in the specified consistency group stops. If a remote
copy relationship associated with the target was mirroring I/O when the map was copying, it might
lose its difference recording capability and require a full resychronization upon a subsequent restart.
-split
(Optional) Breaks the dependency on the source volumes of any mappings that are also dependent on
the target volume. This parameter can only be specified when stopping a consistency group where all
maps in the group have progress of 100 as shown by the lsfcmap command.
fc_consist_group_id_or_name
(Required) Specifies the name or ID of the consistency group that you want to stop.
Description
This command stops a group of mappings in a consistency group. If the copy process is stopped, the
target disks become unusable unless they already contain complete images of the source. Disks that
contain complete images of the source have a progress of 100, as indicated in the lsfcmap command
output. The target volume is reported as offline if it does not contain a complete image. Before you can
access this volume, the group of mappings must be prepared and restarted.
Note: Prior to SVC 4.2.0, the stopfcconsistgrp command always caused the consistency group to go to
the stopped state, taking the target volumes offline.
The split option can be used when all of the maps in the group have progress of 100. It removes the
dependency of any other maps on the source volumes. It might be used prior to starting another
FlashCopy consistency group whose target disks are the source disks of the mappings being stopped.
Once the consistency group has been stopped with the split option, the other consistency group could
then be started without the restore option.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
stopfcconsistgrp testmapone
stopfcmap
Use the stopfcmap command to stop all processing that is associated with a FlashCopy mapping that is in
one of the following processing states: prepared, copying, stopping, or suspended.
Syntax
stopfcmap fc_map_id_or_name
-force
-split
Parameters
-force
(Optional) Specifies that all processing that is associated with the designated mapping be stopped
immediately.
Note: When you use this parameter, all FlashCopy mappings that depend on this mapping (as listed
by the lsfcmapdependentmaps command) are also stopped.
If the -force parameter is not specified, the command is rejected if the target volume of the
FlashCopy mapping is the primary in a relationship which is mirroring I/O:
v consistent_synchronized
v consistent_copying
v inconsistent_copying
If the -force parameter is specified to a FlashCopy mapping whose target volume is also in a Metro
Mirror or Global Mirror relationship, the relationship stops. If a remote copy relationship associated
with the target was mirroring I/O when the map was copying, it might lose its difference recording
capability and require a full resychronization on a subsequent restart.
-split
(Optional) Breaks the dependency on the source volume of any mappings that are also dependent on
the target disk. This parameter can only be specified when stopping a map that has progress of 100
as shown by the lsfcmap command.
312 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
fc_map_id_or_name
(Required) Specifies the name or ID of the mapping to stop.
Description
This command stops a single mapping. If the copy process is stopped, the target disk becomes unusable
unless it already contained a complete image of the source (that is, unless the map had a progress of 100
as shown by the lsfcmap command). Before you can use the target disk, the mapping must once again be
prepared and then reprocessed (unless the target disk already contained a complete image).
Only stand-alone mappings can be stopped using the stopfcmap command. Mappings that belong to a
consistency group must be stopped using the stopfcconsistgrp command.
If the mapping is in the idle_or_copied state, the stopfcmap command has no effect and the mapping
stays in the idle_or_copied state.
Note: Before SAN Volume Controller 4.2.0, the stopfcmap command always changed the mapping state to
stopped and took the target volume offline. This change can break scripts that depend on the previous
behavior.
The split option can be used when the mapping has progress of 100. It removes the dependency of any
other mappings on the source volume. It might be used prior to starting another FlashCopy mapping
whose target disk is the source disk of the mapping being stopped. Once the mapping has been stopped
with the split option, the other mapping could then be started without the restore option.
Note: Maps that are rc_controlled are not shown in the view when this command is specified.
An invocation example
stopfcmap testmapone
addhostiogrp
Use the addhostiogrp command to map I/O groups to an existing host object.
Syntax
addhostiogrp -iogrp iogrp_list host_name
-iogrpall host_id
Parameters
-iogrp iogrp_list
(Required if you do not use -iogrpall) Specifies a colon-separated list of one or more I/O groups
that must be mapped to the host. You cannot use this parameter with the -iogrpall parameter.
-iogrpall
(Required if you do not use -iogrp) Specifies that all the I/O groups must be mapped to the
specified host. You cannot use this parameter with the -iogrp parameter.
host_id | host_name
(Required) Specifies the host to which the I/O groups must be mapped, either by ID or by name.
Description
This command allows you to map the list of I/O groups to the specified host object.
An invocation example
addhostiogrp -iogrpall testhost
addhostport
Use the addhostport command to add worldwide port names (WWPNs) or iSCSI names to an existing
host object.
Syntax
addhostport -saswwpn wwpn_list host_name
-fcwwpn wwpn_list -force host_id
-iscsiname iscsi_name_list
Parameters
-saswwpn wwpn_list
(Required if you do not use -iscsiname or -fcwwpn) Specifies a list of Serial Attached SCSI (SAS)
WWPNs with a 16-character hexadecimal string.
Description
This command adds a list of host bust adapter (HBA) WWPNs or iSCSI names to the specified host
object. Any virtual disks that are mapped to this host object automatically map to the new ports.
Only WWPNs that are logged-in unconfigured can be added. For a list of candidate WWPNs, use the
lssasportcandidate or lsfcportcandidate command.
Some HBA device drivers do not log in to the fabric until they can recognize target logical unit numbers
(LUNs). Because they do not log in, their WWPNs are not recognized as candidate ports. You can specify
the force parameter with the addhostport command to stop the validation of the WWPN list.
Note: When all I/O groups are removed from an iSCSI host, you cannot add a port to the iSCSI host
until you have mapped the iSCSI host to at least one I/O group. After mapping the iSCSI host to at least
one I/O group, resubmit the addhostport command. After adding the port to the host, you must create a
host authentication entry using the chhost command.
An invocation example
addhostport -saswwpn 210100E08B251DD4 host1
An invocation example
addhostport -fcwwpn 210100E08B251EE6 host1
An invocation example
addhostport -iscsiname iqn.localhost.hostid.7f000001 mchost13
316 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
chhost
Use the chhost command to change the name or type of a host object. This does not affect any existing
virtual disk-to-host mappings.
Syntax
chhost
-type hpux -mask port_login_mask
tpgs
generic
openvms
host_name
-name new_name_arg -chapsecret chap_secret host_id
-nochapsecret
Parameters
-type hpux | tpgs | generic | openvms
(Optional) Specifies the type of host: hpux, tpgs, generic, or openvms. The default is generic. The
tpgs parameter enables extra target-port unit attentions. Refer to SAN Volume Controller host
attachment documentation for more information on the hosts that require the type parameter.
-name new_name_arg
(Optional) Specifies the new name that you want to assign to the host object.
-mask port_login_mask
(Optional) Specifies which node target ports a host can access and the Fibre Channel (FC) port mask
for the host. Worldwide port names (WWPNs) in the host object must access volumes from the node
ports that are included in the mask and are in the host object's I/O group. The port mask is 64 binary
bits and is made up of a combination of 0's and 1's, where 0 indicates that the corresponding FC I/O
port cannot be used and 1 indicates that it can be used. The right-most bit in the mask corresponds to
FC I/O port 1. Valid mask values might range from 0000 (no ports enabled) to
1111111111111111111111111111111111111111111111111111111111111111 (all ports enabled). For
example, a mask of 111111101101 enables ports 1, 3, 4, 6, 7, 8, 9, 10, 11, and 12.
-chapsecret chap_secret
(Optional) Sets the Challenge Handshake Authentication Protocol (CHAP) secret used to authenticate
the host for Internet Small Computer System Interface (iSCSI) I/O. This secret is shared between the
host and the cluster. The CHAP secret for each host can be listed using the lsiscsiauth command.
-nochapsecret
(Optional) Clears any previously set CHAP secret for this host. Thenochapsecret parameter cannot be
specified if chapsecret is specified.
host_name | host_id
(Required) Specifies the host object to modify, either by ID or by current name.
Description
This command can change the name of the specified host to a new name, or it can change the type of
host. This command does not affect any of the current virtual disk-to-host mappings.
The port mask applies to logins from the host initiator port that are associated with the host object. For
each login between a host bus adapter (HBA) port and node port, the node examines the port mask that
Note: When all I/O groups are removed from an iSCSI host, the lsiscsiauth command does not display
the authentication entry for that host. Use the addhostiogrp command to map the iSCSI host to at least
one I/O group, and then use the addhostport command to add the iSCSI port into it. You must also add
authentication for that host using the chhost command with either the chapsecret or nochapsecret
parameter.
An invocation example
chhost -name testhostlode -mask 111111101101 hostone
An invocation example
chhost -type openvms 0
mkhost
Use the mkhost command to create a logical host object.
Syntax
mkhost -saswwpn wwpn_list
-name new_name -fcwwpn wwpn_list
-iscsiname iscsi_name_list
-iogrp iogrp_list -mask port_login_mask -force
-type hpux
tpgs
generic
openvms
Parameters
-name new_name
(Optional) Specifies a name or label for the new host object.
-saswwpn wwpn_list
(Required if you do not use iscsiname or fcwwpn) Specifies a list of Serial Attached SCSI (SAS)
WWPNs with a 16-character hexadecimal string.
-fcwwpn wwpn_list
(Required if you do not use iscsiname or saswwpn) Indicates a list of Fibre Channel (FC) WWPNs
WWPN with a 16-character hexadecimal string.
318 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-iscsiname iscsi_name_list
(Required if you do not use fcwwpn or saswwpn) Specifies the comma-separated list of iSCSI names to
add to the host. At least one WWPN or iSCSI name must be specified. You cannot use this parameter
with the fcwwpn or saswwpn parameter.
-iogrp iogrp_list
(Optional) Specifies a set of one or more input/output (I/O) groups that the host can access the
VDisks (volumes) from. I/O groups are specified using their names or IDs, separated by a colon.
Names and IDs can be mixed in the list. If this parameter is not specified, the host is associated with
all I/O groups.
-mask port_login_mask
(Optional) Specifies which node target ports a host can access and the Fibre Channel (FC) port mask
for the host. Worldwide port names (WWPNs) in the host object must access volumes from the node
ports that are included in the mask and are in the host object's I/O group. The port mask is 64 binary
bits and is made up of a combination of 0's and 1's, where 0 indicates that the corresponding FC I/O
port cannot be used and 1 indicates that it can be used. The right-most bit in the mask corresponds to
FC I/O port 1. Valid mask values might range from 0000 (no ports enabled) to
1111111111111111111111111111111111111111111111111111111111111111 (all ports enabled). For example, a
mask of 111111101101 enables ports 1, 3, 4, 6, 7, 8, 9, 10, 11, and 12.
-force
(Optional) Specifies that a logical host object be created without validation of the WWPNs.
-type hpux | tpgs | generic | openvms
(Optional) Specifies the type of host. The default is generic. The tpgs parameter enables extra
target-port unit attentions. Refer to SAN Volume Controller host attachment documentation for more
information on the hosts that require the type parameter.
Description
The mkhost command associates one or more HBA WWPNs or iSCSI names with a logical host object.
This command creates a new host. The ID is displayed when the command completes. You can
subsequently use this object when you map virtual disks to hosts by using the mkvdiskhostmap command.
Issue the mkhost command only once. The clustered system scans the fabric for WWPNs in the host zone.
The system itself cannot filter into the hosts to determine which WWPNs are in which hosts. Therefore,
you must use the mkhost command to identify the hosts.
After you identify the hosts, mappings are created between hosts and virtual disks. These mappings
effectively present the virtual disks to the hosts to which they are mapped. All WWPNs in the host object
are mapped to the virtual disks.
Some HBA device drivers do not log in to the fabric until they can see target logical unit numbers
(LUNs). Because they do not log in, their WWPNs are not recognized as candidate ports. You can specify
the force parameter with this command to stop the validation of the WWPN list.
This command fails if you add the host to an I/O group that is associated with more host ports or host
objects than is allowed by the limits within the system.
An invocation example
mkhost -name hostone -saswwpn 210100E08B251DD4:210100F08C262DD8 -force -mask 111111101101
An invocation example
mkhost -fcwwpn 210100E08B251EE6:210100F08C262EE7 -type openvms
rmhost
Use the rmhost command to delete a host object.
Syntax
rmhost host_name
-force host_id
Parameters
-force
(Optional) Specifies that you want the system to delete the host object even if mappings still exist
between this host and virtual disks (VDisks). When the -force parameter is specified, the mappings
are deleted before the host object is deleted.
host_name | host_id
(Required) Specifies the host object to delete, either by ID or by name.
Description
The rmhost command deletes the logical host object. The WWPNs that were contained by this host object
(if it is still connected and logged in to the fabric) are returned to the unconfigured state. When you issue
the lsfcportcandidate or lssasportcandidate command, the host objects are listed as candidate ports.
If any mappings still exist between this host and virtual disks, the command fails unless you specify the
-force parameter. When the -force parameter is specified, the rmhost command deletes the mappings
before the host object is deleted.
An invocation example
rmhost host_one
lshost
Use the lshost command to generate a list with concise information about all the hosts visible to the
clustered system (system) and detailed information about a single host.
320 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
lshost
-filtervalue attribute=value -nohdr -delim delimiter
-filtervalue? object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller command-line interface (CLI):
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard.
v When using a wildcard character, you must enclose the filter entry within double quotation marks
("" ), as follows:
lshost -filtervalue "name=md*"
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
This command returns a concise list or a detailed view of hosts visible to the system.
For Fibre Channel (FC) ports, the node_logged_in_count field provides the number of nodes that the host
port is logged into. For Internet Small Computer System Interface (iSCSI) ports, the
node_logged_in_count field provides the number of iSCSI sessions from the host iSCSI Qualified Name
(IQN).
The following list provides the different states for a fabric attach FC host port:
active The host port is active if all nodes with VDisk (volume) mappings have a login for the specified
worldwide port name (WWPN) and at least one node has received SCSI commands from the
WWPN within the last five minutes.
degraded
The host port is degraded if one or more nodes with volume mappings do not have a login for
the specified WWPN.
inactive
The host port is inactive if all the nodes with volume mappings have a login for the specified
WWPN but no nodes have seen any Small Computer System Interface (SCSI) commands from the
WWPN within the last five minutes.
offline
The host port is offline if one or more input/output (I/O) groups with volume mappings do not
have a login for the specified WWPN.
The following list provides the different states for a direct attach FC host port:
active The host port is active if a node has a login for the specified WWPN and the node has received
SCSI commands from the WWPN within the last five minutes.
inactive
The host port is inactive if all the nodes with volume mappings have a login for the specified
WWPN but no nodes have seen any Small Computer System Interface (SCSI) commands from the
WWPN within the last five minutes.
offline
The host port is offline if there is no login for the specified WWPN.
If a host does not have any volume mappings it is reported as offline or inactive.
Note: The lshost command presents a list of host HBA ports that are logged in to nodes. However, there
are situations when the information presented can include host HBA ports that are no longer logged in or
even part of the SAN fabric. For example, a host HBA port is unplugged from a switch, but lshost still
shows the WWPN logged in to all nodes. If this occurs, the incorrect entry is removed when another
device is plugged in to the same switch port that previously contained the removed host HBA port.
The following list provides the different states for a specified iscsiname:
active The iscsiname is active if all I/O groups with volume mappings have at least one associated iscsi
session for the specified iscsiname.
inactive
The iscsiname is inactive if the host has no volume mappings but at least one iSCSI session for
the specified iscsiname is present.
offline
The iscsiname is offline if one or more I/O groups with volume mappings do not have an
associated iSCSI session for the specified iscsiname.
322 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The following list provides the different states for host_status:
online The host has full connectivity. A host using just one style of connectivity is online if it uses one of
these:
Fiber Attach Fiber Channel (FAFC)
Every port is active or inactive, and is logged into every online node in each I/O group
in which the host has volume mappings.
Direct Attach Fibre Channel (DAFC)
The host has an active or inactive login to every node in I/O groups to which the host
has volume mappings.
Internet Small Computer System Interface (iSCSI)
The host has an iSCSI session with each I/O group with which the host has volume
mappings.
offline
The host has no connectivity. This might be because the host has been powered down and is not
on.
Remember: If an iSCSI host is only logged into I/O groups for which it is not configured, the
associated host object status is offline.
degraded
The host is not fully connected, which might be introduced by a configuration error or a
hardware failure. This can cause a loss of access during any planned maintenance activity and
should be corrected as soon as possible.
Remember: An iSCSI host that has no mapped volumes is degraded if it is logged in to some, but
not all, of the I/O groups to which it belongs.
mask The Fiber Channel (FC) I/O ports (which exist on a node) hosts can access.
An invocation example
lshost 0
lshostiogrp
Use the lshostiogrp command to display a list the I/O groups associated with a specified host.
Syntax
lshostiogrp host_id
-nohdr -delim delimiter host_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
324 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Note: If there is no data to be displayed, headings are not displayed.
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
host_id | host_name
(Required) The name or ID of the host for which the list of I/O groups is required.
Description
This command displays a list of all the I/O groups that are mapped to the specified host.
An invocation example
lshostiogrp -delim : hostone
lsiscsiauth
Use the lsiscsiauth command to list the Challenge Handshake Authentication Protocol (CHAP) secret
configured for authenticating an entity to the SAN Volume Controller clustered system (system).
Syntax
lsiscsiauth
-nohdr -delim delimiter
-filtervalue attribute=value -filtervalue?
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: Some filters allow the asterisk character (*) when you enter the command. The following rules
apply to the use of wildcard characters with the SAN Volume Controller CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, you must enclose the filter entry within double quotation marks (""), as
follows:
lsiscsiauth -filtervalue "name=md*"
-filtervalue?
(Optional) displays a list of filters that can be applied against this view. The following filter attributes
are valid for the lsiscsiauth command:
v type
v id
v name
v iscsi_auth_method
v iscsi_chap_secret
Description
This command lists the CHAP secret configured for authenticating an entity to the SAN Volume
Controller system. The command also displays the configured iSCSI authentication method. The
iscsi_auth_method field can have values of none or chap.
When you create an iSCSI host using the mkhost command with the iscsiname parameter, the host is
initially configured with the authentication method as none, and no CHAP secret is set. To set a CHAP
secret for authenticating the iSCSI host with the SAN Volume Controller system, use the chhost
command with the chapsecret parameter.
An invocation example
lsiscsiauth
rmhostiogrp
Use the rmhostiogrp command to to delete mappings between one or more input/output (I/O) groups
and a specified host object.
Syntax
326 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
rmhostiogrp -iogrp iogrp_list host_name
-iogrpall -force host_id
Parameters
-iogrp iogrp_list
(Required) Specifies a set of one or more I/O group mappings that will be deleted from the host. You
cannot use this parameter with the iogrpall parameter.
-iogrpall
(Optional) Specifies that all the I/O group mappings that are associated with the specified host must
be deleted from the host. You cannot use this parameter with the iogrp parameter.
-force
(Optional) Specifies that you want the system to remove the specified I/O group mappings on the
host even if the removal of a host to I/O group mapping results in the loss of VDisk-to-host
mappings (host mappings).
host_id | host_name
(Required) Specifies the identity of the host either by ID or name from which the I/O group
mappings must be deleted.
Description
The rmhostiogrp command deletes the mappings between the list of I/O groups and the specified host
object.
If a host is defined in two I/O groups, and has access to a volume through both I/O groups, an attempt
to remove the host from just one of those I/O groups fails, even with -force specified. To resolve this
problem, do one of the following:
v Delete the host mappings that are causing the error
v Delete the volumes or the host
Note: When all I/O groups are removed from an Internet Small Computer System Interface (iSCSI) host,
and you want to add an iSCSI port to the host, refer to the addhostport and chhost commands.
An invocation example
rmhostiogrp -iogrp 1:2 host0
rmhostport
Use the rmhostport command to delete worldwide port names (WWPNs) or Internet Small Computer
System Interface (iSCSI) names from an existing host object.
Syntax
rmhostport -saswwpn wwpn_list host_name
-fcwwpn wwpn_list -force host_id
-iscsiname iscsi_name_list
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
host_name | host_id
(Required) Specifies the host name or the host ID.
Description
This command deletes the list of host-bus adapter (HBA) WWPNs or iSCSI names from the specified host
object. If the WWPN ports are still logged in to the fabric, they become unconfigured and are listed as
candidate WWPNs.
Any virtual disks that are mapped to this host object are automatically unmapped from the ports.
| List the candidate Fibre Channel (FC) or serial-attached SCSI (SAS) ports by issuing the
| lsfcportcandidate or lssasportcandidate command. A list of the ports that are available to be added to
| host objects is displayed. The following command lists all the defined host objects:
| lshost
| To list the WWPNs that are currently assigned to the host, issue the following:
| lshost hostobjectname
Add the new ports to the existing host object by issuing the following command:
where one or more existing WWPNs separated by : and hostobjectname/id correspond to those values listed in
the previous steps.
Remove the old ports from the host object by issuing the following command:
328 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
where one or more existing WWPNs separated by : corresponds with those WWPNs that are listed in the
previous step that belong to the old HBA that has been replaced. Any mappings that exist between the
host object and VDisks are automatically applied to the new WWPNs. Therefore, the host recognizes that
the VDisks are the same SCSI LUNs as before.
An invocation example
rmhostport -saswwpn 210100E08B251DD4 host1
An invocation example
rmhostport -fcwwpn 210100E08B251EE6 host1
An invocation example
rmhostport -iscsiname iqn.localhost.hostid.7f000001 mchost13
These commands return no output but exit successfully when there is no information to display.
Note: IDs are assigned at run-time by the system and cannot be relied upon to be the same after
configuration restoration. Therefore, use object names instead of IDs whenever possible.
ls2145dumps (Deprecated)
Attention: The ls2145dumps command is deprecated. Use the lsdumps command to display a list of files
in a particular dumps directory.
lsconfigdumps (Discontinued)
Attention: The lsconfigdumps command is discontinued.
lspartnershipcandidate
Use the lspartnershipcandidate command to list the clustered systems available for setting up a
partnership with the local system. This is a prerequisite for creating inter-system Metro or Global Mirror
relationships.
Syntax
lspartnershipcandidate
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a list of systems that are available as candidate partner systems to form a Metro
Mirror or Global Mirror partnership between two systems.
An invocation example
lspartnershipcandidate
| lssite
| Use the lssite command to report the names of the sites.
| Syntax
| lssite
|
| Parameters
| Description
| Remember: This command is only applicable when a system is configured as a stretched system by
| issuing the chsystem -topology command.
| In a stretched configuration these are spread across two or more geographic locations or sites:
| v Nodes
| v Storage
| v Host servers
| v Infrastructure
| Table 55 provides the attribute values that can be displayed as output view data.
| Table 55. lssite attribute values
| Attribute Value
| id Identifies the numeric value representing the site. The value can be 1, 2, or 3.
| name Identifies the site name.
|
| An invocation example
| lssite
332 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| id name
| 1 CPD1
| 2 CPD2
| 3 Quorum
lssshkeys (Discontinued)
Attention: The lssshkeys command is discontinued. Use the user management commands to configure
remote authentication service and manage users and user groups on the cluster.
cancellivedump
Use the cancellivedump command to cancel a live dump.
Syntax
cancellivedump node_name
node_id
Parameters
node_name|node_id
Identifies the node name or ID.
Description
Use this command if you issue a preplivedump command, but then decide not to issue a triggerlivedump
command. This releases the resources you allocated for the livedump. This event is located in the node
trace (.trc) file. For this command to succeed, the node must be in a livedump prepared state.
An invocation example
cancellivedump node1
lslivedump
Use the lslivedump command to query the livedump state of a node.
Syntax
lslivedump node_name
node_id
Parameters
node_name|node_id
Identifies the node name or ID.
Description
You can issue this command repeatedly to determine if a live dump is in progress for the node. Table 56
on page 336 provides the possible values that are applicable to the attributes that are displayed as data in
the output views.
An invocation example
lslivedump node1
preplivedump
Use the preplivedump command to reserve the system resources that are required for livedump.
Syntax
preplivedump node_name
node_id
Parameters
node_name|node_id
Identifies the node name or ID.
Description
You can prepare more than one node for livedump at a time by issuing the preplivedump command
consecutively. However, you can only trigger one livedump at a time, with an automatic lag time of 30
seconds between each trigger event. This helps maintain node stability.
You can issue multiple preplivedump commands on the same node; however, only a preplivedump
command followed by a triggerlivedump command results in output.
Because the livedump resource allocation can take time to execute, you can issue this command to
prepare the livedump but trigger it at a later time. This command times out after 60 seconds. The
preplivedump event is located in the node trace (.trc) file.
An invocation example
preplivedump node1
triggerlivedump
Use the triggerlivedump command to capture the metadata that you want to dump, and write the dump
file to the internal disk on the node.
336 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
triggerlivedump node_name
node_id
Parameters
node_name|node_id
Identifies the node name or ID.
Description
You can issue this command to trigger a livedump command. Only one triggerlivedump action can be in
progress at one time, with an automatic lag time of 30 seconds between each trigger event. The node
must have a livedump state of prepared for this command to succeed. Output is recorded in the node
trace (.trc) file.
After you issue the triggerlivedump command, the command captures data and returns you to the CLI
interface so that you can issue additional commands. While you issue additional commands, the
livedump disk file is written to the disk in the background, and the livedump state shows as dumping.
After the write is complete, the state shows as inactive.
An invocation example
triggerlivedump node1
If the clustered system (system) detects an MDisk, it automatically adds it to the list of known MDisks. If
you subsequently delete the RAID that corresponds to the MDisk, the system only deletes the MDisk
from the list if the MDisk is offline and it has a mode of unmanaged (it does not belong to an MDisk
group).
applymdisksoftware (Discontinued)
Attention: The applymdisksoftware command has been discontinued. Use the applydrivesoftware
command to upgrade drives.
chmdisk
Use the chmdisk command to modify the name of a managed disk (MDisk).
Syntax
chmdisk mdisk_id
-name new_name_arg -tier generic_ssd mdisk_name
generic_hdd
Parameters
-name new_name_arg
(Required) Specifies the new name to be applied to the managed disk.
-tiergeneric_ssd | generic_hhd
(Optional) Specifies the new tier of the MDisk.
mdisk_id | mdisk_name
(Required) Specifies the ID or name of the managed disk to modify.
Description
Note: If you do not specify a new name the command cannot complete. Also, you do not use this
command to change the tier.
An invocation example
chmdisk -tier generic_hdd mdisk13
chquorum
Use the chquorum command to change the quorum association.
quorum_id
Parameters
-active
(Optional) Makes the specified quorum ID the active one. The active parameter must be used if
neither the mdisk nor the drive parameters are specified.
-mdisk mdisk_id | mdisk_name | -drive drive_id
(Optional) Specifies the MDisk or drive to be this quorum ID.
Description
Use the chquorum command to change the quorum association. To identify the drive or MDisk that is the
current active quorum disk, use the lsquorum command.
Attention: Only assign quorum to drives in the control enclosure or to external MDisks. Some
maintenance procedures require that quorum is moved temporarily to expansion enclosures. Once that
procedure is complete, return the quorum drives to the control enclosure.
The chquorum command is not synchronous, but usually takes only a few seconds to complete. In some
situations it can take several minutes.
The clustered system (system) uses the quorum disk or drive as a tie breaker when exactly half of the
nodes that were previously a member of the system are present.
The use of a quorum disk or drive allows the system to manage a SAN fault that splits the system
exactly in half. One half of the system continues to operate and the other half stops until SAN
connectivity is restored.
There is only one quorum disk or drive; however, the system uses three as quorum candidates. The
system selects the actual quorum disk or drive from the pool of quorum candidates. The quorum
candidates also hold a copy of important system metadata. Just over 256 MB is reserved for this purpose
on each quorum candidate disk. When using an MDisk as quorum disk, this space is allocated from the
storage pool. The number of extents required depends on the extent size for the managed disk group
containing the MDisk. Table 57 on page 341 provides the number of extents reserved for quorum use by
extent size.
340 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 57. Number of extents reserved by extent size
Extent size (MB) Number of extents reserved for quorum use
16 17
32 9
64 5
128 3
256 2
512 1
1024 1
2048 1
4096 1
8192 1
When you issue this command, the MDisk or drive that currently is assigned the quorum index number
is set to a nonquorum disk. The system automatically assigns quorum indexes.
You can set the active quorum disk or drive with the active parameter. This can be useful in a system
configuration to ensure that the most highly-available quorum disk or drive is used.
An invocation example
chquorum -mdisk 45 2
dumpallmdiskbadblocks
Use the dumpallmdiskbadblocks command to dump bad block counts to a dump file used by the fix
procedures and the satask snap command.
Syntax
dumpallmdiskbadblocks
Parameters
None
Description
Use the dumpallmdiskbadblocks command to dump bad block counts to a readable ASCII dump file for
use by fix procedures and the satask snap command. The output contains bad blocks for which an error
log has been raised.
Use lsdumps -prefix /dumps/mdisk to list the output files. Use cleardumps -prefix /dumps/mdisk to clear
the output files.
Mdisk id: 2
Mdisk name: mdisk2
Number of bad blocks: 4
Mdisk id: 5
Mdisk name: mdisk 5
Number of bad blocks: 1
dumpmdiskbadblocks
Use the dumpmdiskbadblocks command to write the bad block counts and locations that are on a specified
MDisk to a dump file for use by fix procedures.
Syntax
dumpmdiskbadblocks object_id
object_name
Parameters
object_id | object_name
(Required) Specifies the MDisk for which you need to dump the bad block record table.
Description
Use the dumpmdiskbadblocks command to write the bad block counts and locations that are on a specified
MDisk to a readable ASCII dump file for use by fix procedures. The output consists of bad blocks for
which an error log has been raised.
Use lsdumps -prefix /dumps/mdisk to list the output files. Use cleardumps -prefix /dumps/mdisk to clear
the output files.
The reported error log sequence numbers correspond to the first error seen in the bad block record,
which is a 512-block region.
v If there are multiple error logs in the same region, the earliest error sequence is used.
v If there are error logs of different types in the same region, error sequence numbers for bad blocks
caused by medium errors on RAID member drives take precedence.
v If a range of bad blocks runs across record boundaries, the sequence number corresponding to the last
record is used.
342 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The maximum number of dump files is 20.
An invocation example
dumpmdiskbadblocks 3
Mdisk id: 3
Mdisk name: mdisk3
Number of bad blocks: 6
Mdisk id: 3
Mdisk name: mdisk3
Number of bad blocks: 0
includemdisk
Use the includemdisk command to include a disk that has been excluded by the clustered system
(system).
Syntax
includemdisk mdisk_id
mdisk_name
Parameters
mdisk_id | mdisk_name
(Required) Specifies the ID or name of the managed disk to add back into the system.
Description
You might exclude a disk from the system because of multiple I/O failures. These failures might be
caused by noisy links. Once a fabric-related problem has been fixed, the excluded disk can be added back
into the system.
Running this command against an MDisk might change its state, whether the state is reported as
excluded.
Note: If an MDisk is in the excluded state, is offline, and does not belong to an MDisk group, issuing an
include command for this MDisk results in the MDisk record being deleted from the system.
lsmdisk
Use the lsmdisk command to display a concise list or a detailed view of managed disks (MDisks) visible
to the clustered system (system). It can also list detailed information about a single MDisk.
Syntax
lsmdisk
-filtervalue attribute=value -filtervalue?
-nohdr -bytes -delim delimiter -unit b
kb
mb
gb
pb
tb
object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filter attributes matching the specified values; see
-filtervalue? for the supported attributes. Only objects with a value that matches the filter attribute
value are returned. If capacity is specified, the units must also be included. Use the unit parameter
to interpret the value for size or capacity.
Note: Some filters allow the use of a wildcard when entering the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
v When using a wildcard character, you must enclose the filter entry within double quotation marks
(""), as follows:
lsmdisk -filtervalue "name=md*"
-filtervalue?
(Optional) Includes all of the valid filter attributes in the report. The following filter attributes are
valid for the lsmdisk command:
v id
v name
v status
v mode
v mdisk_grp_id
v mdisk_grp_name
344 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v capacity
v quorum_index
v block_size
v controller_name
v ctrl_WWNN
v controller_id
v path_count
v max_path_count
v ctrl_LUN_#
v UID
v preferred_WWPN
v active_WWPN
v tier
Any parameters specified with the -filtervalue? parameter are ignored.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command returns a concise list or a detailed view of MDisks visible to the system. Table 58 on page
346 provides the potential output for MDisks.
Note: The automatic discovery performed by the system does not write anything to an unmanaged
MDisk. It is only when you add an MDisk to an MDisk group (storage pool), or use an MDisk to create
an image mode VDisk (volume), that the system uses the storage.
346 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
To see which MDisks are available, issue the detectmdisk command to manually rescan the Fibre Channel
network for any new MDisks. Issue the lsmdiskcandidate command to show the unmanaged MDisks.
These MDisks have not been assigned to an MDisk group (storage pool).
Notes:
1. A SAN Volume Controller connection from a node or node canister port to a storage controller port
for a single MDisk is a path. The Mdisk path_count value is the number of paths currently being used
to submit input/output (I/O) to this MDisk.
2. The MDisk max_path_count value is the highest value path_count has reached since the MDisk was last
fully online.
3. The preferred_WWPN is one of the World Wide Port Names (WWPNs) the storage controller has
specified as a preferred WWPN. If the controller has nothing specified, this is a blank field.
4. The active_WWPN indicates the WWPN of the storage controller port currently being used for I/O.
a. If no storage controller ports are available for I/O, this is a blank field.
b. If multiple controller ports are actively being used for I/O, this field's value is many.
348 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
lsmdiskdumps (Deprecated)
Attention: The lsmdiskdumps command is deprecated. Use the lsdumps command to display a list of files
in a particular dumps directory.
lsmdisklba
Use the lsmdisklba command to list the MDisk and logical block address (LBA) for the specified VDisk
(volume) LBA.
Syntax
lsmdisklba -vdisklba vdisklba
-copy id -delim delimiter
-vdisk vdisk_id
- nohdr vdisk_name
Parameters
-vdisklba vdisklba
(Required) Specifies the 64–bit hexadecimal logical block address (LBA) on the volume. The LBA
must be specified in hex, with a 0x prefix.
-copy id
(Optional) Specifies the volume copy ID to list the MDisk and LBA for. If this parameter is not
specified, the command lists MDisks and LBAs for all volume copies.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The lsmdisklba command returns the logical block address (LBA) of the MDisk that is associated with
the volume LBA. For mirrored volume, the command lists the MDisk LBA for both the primary and the
copy.
If applicable, the command also lists the range of LBAs on both the volume and MDisk that are mapped
in the same extent, or for space-efficient disks, in the same grain. If a space-efficient volume is offline and
the specified LBA is not allocated, the command displays the volume LBA range only.
Table 59 summarizes the data that can be returned with this command.
Table 59. lsmdisklba command output
Mirrored VDisk with one normal copy and
one offline space-efficient copy
Fully allocated, LBA not allocated on
Field single copy VDisk space-efficient VDisk Normal copy Space-efficient copy
copy_id yes yes yes yes
mdisk_id yes no yes no
mdisk_name yes no yes no
type allocated unallocated allocated offline
mdisk_lba yes no yes no
mdisk_start yes no yes no
mdisk_end yes no yes no
vdisk_start yes yes yes yes
vdisk_end yes yes yes yes
An invocation example
lsmdisklba -vdisk 0 -vdisklba 0x123
lsmdiskcandidate
Use the lsmdiskcandidate command to list all unmanaged MDisks by MDisk ID.
Syntax
lsmdiskcandidate
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
350 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
Description
This command displays a list of MDisks that are unmanaged. Only the MDisk IDs are displayed.
When back-end controllers are added to the Fibre Channel SAN and are included in the same switch
zone as a cluster, the cluster automatically detects the back-end controller to determine which storage is
presented to the node. The SCSI logical units that are presented by the back-end controller are displayed
as unmanaged MDisks. However, if the configuration of the back-end controller is modified after this has
occurred, the cluster might be unaware of these configuration changes. You can then request that the
cluster rescan the Fibre Channel SAN to update the list of unmanaged MDisks.
Note: The automatic detection performed by the cluster does not write anything to a unmanaged MDisk.
It is only when you instruct the cluster to add an MDisk to a managed disk group or use a MDisk to
create an image mode virtual disk that the storage is actually used.
Check to see which MDisks are available by issuing the detectmdisk command to manually scan the
Fibre Channel network for any MDisks. Issue the lsmdiskcandidate command to show the unmanaged
MDisks. These MDisks have not been assigned to an MDisk group. Alternatively, you can issue the
lsmdisk command to view all of the MDisks.
An invocation example
lsmdiskcandidate
lsmdiskextent
Use the lsmdiskextent command to display the extent allocation between managed disks and virtual
disks. The output lists a VDisk ID, VDisk copy ID, and the number of extents.
Syntax
lsmdiskextent mdisk_name
-nohdr -delim delimiter mdisk_id
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The command displays a list, in which each entry contains a VDisk ID, VDisk copy ID, and the number
of extents. These VDisk copies are using extents on the specified MDisk. The number of extents being
used on each MDisk is also shown.
Every VDisk copy is constructed from one or more MDisks. At times, you might have to determine the
relationship between the two objects. The following procedure allows you to determine the relationships.
To determine the relationship between VDisk copies and MDisks, issue the following command for each
VDisk copy:
where vdisk_name | vdisk_id is the name or ID of the VDisk copy. This displays a list of IDs that
correspond to the MDisks that make up the VDisk copy.
To determine the relationship between VDisk copies and MDisks and the number of extents that are
provided by each MDisk, you must use the command-line interface. For each VDisk copy, issue the
following command:
where vdisk_name | vdisk_id is the name or ID of the VDisk copy. This displays a table of MDisk IDs and
the corresponding number of extents that each MDisk is providing as storage for the given VDisk copy.
To determine the relationship between MDisks and VDisk copies, issue the following command for each
MDisk:
where mdisk_name | mdisk_id is the name or ID of the MDisk. This displays a list of IDs that correspond
to the VDisk copies that are using this MDisk.
To determine the relationship between MDisks and VDisk copies and the number of extents that are used
by each VDisk copy, you must use the command-line interface. For each MDisk, issue the following
command:
where mdisk_name | mdisk_id is the name or ID of the MDisk. This command displays a table of VDisk
copy IDs and the corresponding number of extents that are being used by each VDisk copy.
352 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
lsmdiskextent -delim : mdisk0
lsmdiskmember
Use the lsmdiskmember command to display a list of VDisks (volumes) that use extents on the specified
MDisk. That is, the volumes use extents on the managed disk that are specified by the MDisk ID.
Syntax
lsmdiskmember mdisk_id
-nohdr -delim delimiter mdisk_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a list of volumes that use extents on the managed disk that are specified by the
ID. The list displays members of the respective object and is independent of the state of the individual
members; that is, if they are in offline state, they are still displayed.
Every volume is constructed from one or more MDisks. To determine the relationship between volume
copies and MDisks, issue the following command:
where vdisk_id | vdisk_name is the name or ID of the volume copy. This displays a list of IDs that
correspond to the MDisks that make up the volume copy.
To determine the relationship between volume copies and MDisks and the number of extents that are
provided by each MDisk, you must use the command-line interface. For each volume copy, issue the
following command:
where vdisk_id | vdisk_name is the name or ID of the VDisk copy. This command displays a table of
MDisk IDs and the corresponding number of extents that each MDisk provides as storage for the volume
copy.
To determine the relationship between MDisks and volume copies, issue the following command:
where mdisk_id | mdisk_name is the name or ID of the MDisk. This command displays a list of IDs that
correspond to the volume copies that are using this MDisk.
To determine the relationship between MDisks and volume copies and the number of extents that are
used by each volume copy, you must use the command-line interface. For each MDisk mdisk_id |
mdisk_name, issue the following command:
where mdisk_id | mdisk_name is the name or ID of the MDisk. This command displays a table of volume
copy IDs and the corresponding number of extents that are being used by each volume copy.
An invocation example
lsmdiskmember -delim : 1
lsquorum
| Use the lsquorum command to list the quorum devices that the clustered system (system) is currently
| using to store quorum data.
Syntax
lsquorum
-nohdr -delim delimiter quorum_index
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The nohdr parameter suppresses the display of these
headings.
354 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The delim parameter overrides this behavior. Valid input for the delim parameter is a one-byte
character. If you enter -delim : on the command line, the colon character (:) separates all items of
data in a concise view; for example, the spacing of columns does not occur. In a detailed view, the
data is separated from its header by the specified character.
quorum_index
| (Optional) Specifies the quorum device by its index number. The number can be either 0, 1, or 2.
| When you use this parameter, a detailed view of the specified device is returned. If you do not
| specify a device, then a concise view of all quorum devices is displayed.
Description
This command displays a concise list or a detailed view of the MDisks or drives that the system is
currently using to store quorum data. This information can be used to ensure that the quorum candidates
are on separate storage subsystems.
| Note: The object type is either MDisk or drive, but only MDisks are used to hold quorum data. If the
| quorum object type is a drive, the controller ID and name fields are blank.
| Table 60 provides the attribute values that can be displayed as output view data.
| Table 60. lsquorum output
| Attribute Possible Values
| quorum_index Indicates the quorum device by index number (either 0,
| 1, or 2).
| status Indicates the quorum device status.
| name Indicates the name of the object used as the quorum
| device.
| controller_id Indicates the ID of the controller of an mdisk object used
| as the quorum device.
| controller_name Indicates the name of the controller of an mdisk object
| used as the quorum device.
| active Indicates if this is the active quorum device the system
| will use as a tie breaker.
| object_tupe Indicates the type of object the quorum device uses.
| override Indicates if the automatic quorum selection for this
| quorum device was overridden.
| site_id Indicates the site value for the quorum device. This
| numeric value is 1, 2, 3 or blank.
| site_name Indicates the site name for the quorum device. This is an
| alphanumeric value or is blank.
|
setquorum (Deprecated)
Attention: The setquorum command is deprecated. Use the chquorum command to change the quorum
association.
triggermdiskdump (Discontinued)
Attention: The triggermdiskdump command is discontinued. Use the triggerdrivedump command to
collect support data from a disk drive.
356 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 20. Managed disk group commands
The following commands enable you to work with managed disk group options with the SAN Volume
Controller.
addmdisk
Use the addmdisk command to add one or more managed disks to an existing managed disk group.
Syntax
addmdisk -mdisk mdisk_id_list
mdisk_name_list -tier generic_ssd
generic_hdd
mdisk_group_id
mdisk_group_name
Parameters
-mdisk mdisk_id_list | mdisk_name_list
(Required) Specifies one or more managed disk IDs or names to add to the group.
-tier
(Optional) Specifies the tier of the MDisk or MDisks being added.
Unless otherwise specified, the current tier value associated with the MDisk will be retained. The
default value for a newly discovered unmanaged MDisk is generic_hdd. You can change this value by
using the chmdisk command.
External SSDs cannot be detected automatically. If you want external SSDs to be known by the
system, you must either specify the tier when adding the managed disk to the mdisk group, or use
the chmdisk command.
mdisk_group_id | mdisk_group_name
(Required) Specifies the ID or name of the managed disk group to add the disks to. When an MDisk
is added, the warning threshold for the MDisk group is automatically scaled.
Description
This command adds the managed disks that you specify to the group. The disks can be specified in terms
of the managed disk ID or the managed disk name.
The managed disks must be in unmanaged mode. Disks that already belong to a group cannot be added
to another group until they have been deleted from their current group. You can delete a managed disk
from a group under the following circumstances:
v If the managed disk does not contain any extents in use by a virtual disk
v If you can first migrate the extents in use onto other free extents within the group.
| Remember: Do not include an Mdisk in an MDisk group if it can only be used in image mode.
chmdiskgrp
Use the chmdiskgrp command to modify the name that is assigned to a managed disk (MDisk) group or
to set the warning threshold for the MDisk group.
Syntax
chmdiskgrp -name new_name_arg
-warning disk_size | disk_size_percentage % -unit b
kb
mb
gb
tb
pb
mdisk_group_name
-easytier auto mdisk_group_id
on
off
Parameters
-name new_name_arg
Specifies the new name of the managed disk group.
-warning disk_size | disk_size_percentage%
(Optional) Sets a threshold at which a warning is generated. The warning is generated the first time
that the threshold is exceeded by the used-disk capacity in the MDisk group. You can specify a
disk_size integer, which defaults to megabytes (MB) unless the -unit parameter is specified; or you
can specify a disk_size%, which is a percentage of the MDisk group size. To disable warnings, specify
0 or 0%.
-unit b | kb | mb | gb | tb | pb
(Optional) Specifies the data units for the -warning parameter.
mdisk_group_id | mdisk_group_name
(Required) Specifies the ID or name of the managed disk group to modify.
-easytier
Specifies if the Easy Tier function is on or off for this MDisk group, or if it is automatically
determined.
358 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
This command modifies the name, or label, assigned to a given managed disk group. Subsequently, you
can use the new name to refer to the managed disk group.
The command can also be used to set the warning threshold for the managed disk group. The warning
threshold is the threshold at which a warning is generated when it is exceeded by the used-disk capacity
in the MDisk group.
An invocation example
chmdiskgrp -name testmdiskgrp -easytier on Group0
mkmdiskgrp
Use the mkmdiskgrp command to create a new managed disk group (storage pool).
Syntax
mkmdiskgrp
-name new_name_arg -mdisk mdisk_id_list
mdisk_name_list
-ext extent_size
-tier generic_ssd
generic_hdd
-warning disk_size | disk_size_percentage % -unit b
kb
mb
gb
tb
pb
-easytier auto
on
off
Parameters
-name new_name_arg
(Optional) Specifies a name to assign to the new group.
-mdisk mdisk_id_list | mdisk_name_list
(Optional) Specifies a colon-separated list of managed disk IDs or names to add to the group. You
can create an empty MDisk group by not specifying the -mdisk parameter.
-ext extent_size
(Required) Specifies the size of the extents for this group in MB. The ext parameter must have one of
the following values: 16, 32, 64, 128, 256, 512, 1024, 2048, 4096, or 8192 (MB).
-warning disk_size | disk_size_percentage%
(Optional) Generates a warning when the used disk capacity in the MDisk group first exceeds the
specified threshold. You can specify a disk_size integer, which defaults to megabytes (MB) unless the
Note:
v If -easytier is set to auto, SAN Volume Controller automatically enables Easy Tier functions when
the MDisk group contains MDisk from more than one tier, and will disable Easy Tier functions
when the MDisk group contains MDisk from only one tier.
v If -easytier is set to on, then Easy Tier functions will be active.
v If -easytier is set to off, then Easy Tier functions will be inactive.
Description
The mkmdiskgrp command creates a new managed disk group and assigns the group name if specified.
The ID of the new group is returned if the command is successful. Managed disk groups are collections
of managed disks. Each group is divided into chunks, called extents, which are used to create
VDisks(volumes).
Optionally, you can specify a list of managed disks that will be added to this group. These managed
disks cannot belong to another group, and they must have a mode of unmanaged. Use the
lsmdiskcandidate command to get a list of suitable candidates. If -tier is specified, it will apply to all of
the MDisks.
Each managed disk that is a member of this group is split into extents. The storage that is available on
these disks is added to a pool of extents that is available in this group. When a virtual disk is created
from this group, free extents from the pool are used, in accordance with the policy used when the virtual
disk was first created.
All managed disks subsequently added to this group are split into extents of the same size as the size
that is assigned to the group.
When choosing an extent size, take into account the amount of storage you want to virtualize in this
group. The system maintains a mapping of extents between virtual disks and managed disks. The
clustered system (system) can only manage a finite number of extents (4 194 304). One system can
virtualize the following number of extents:
v 64 TB – if all managed disk groups have extent sizes of 16 MB.
v 2 PB – if all managed disk groups have extent sizes of 512 MB.
v 32 PB – if all managed disk groups have extent sizes of 8192 MB.
Important: The extent size for the MDisk group can also limit volume size. Consider the maximum
volume size you want to use when creating MDisk groups. Refer to the information on creating MDisk
groups for a comparison of the maximum volume capacity for each extent size. The maximum is different
for space-efficient thin-provisioned volumes.
Note: When an image mode volume is created, the MDisk group increases in capacity by the size of the
image mode volume (not the MDisk capacity), because the image mode volume might be smaller than
360 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
the MDisk itself. If an extent is migrated from the image mode volume or MDisk to elsewhere in the
group, the volume becomes a striped volume (no longer image mode). At this point the available capacity
might increase, because the extra capacity available on the MDisk (for example, the capacity that was not
part of the image mode volume) becomes available.
An invocation example
mkmdiskgrp -mdisk mdisk13 -tier generic_hdd -easytier off -ext 512
An invocation example
mkmdiskgrp -mdisk mdisk0:mdisk1:mdisk2:mdisk3 -ext 32
lsfreeextents
Use the lsfreeextents command to list the number of free extents that are available on a specified
MDisk.
Syntax
lsfreeextents mdisk_id
-nohdr -delim delimiter mdisk_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a count of the number of free extents on the specified MDisk.
lsmdiskgrp
Use the lsmdiskgrp command to display a concise list or a detailed view of MDisk groups (storage pools)
that are visible to the clustered system (system).
Syntax
lsmdiskgrp
-filtervalue attribute=value -nohdr -bytes
-delim delimiter -filtervalue? object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards when using the CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
v When using a wildcard, you must enclose the filter entry within double quotation marks (""), as
follows:
lsmdiskgrp -filtervalue "name=md*"
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
362 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
the specific object is returned and any value specified by the -filtervalue parameter is ignored. If
you do not specify the object_id | object_name parameter, the concise view of all objects matching the
filtering requirements specified by the -filtervalue parameter are displayed.
-filtervalue?
Displays a list of valid filter attributes. The valid filters for the lsmdiskgrp command are:
v name
v storage_pool_id
v mdisk_count
v vdisk_count
v extent_size
v status
v id
v easy_tier
v easy_tier_status
Description
This command returns a concise list or a detailed view of storage pools visible to the system.
Note:
1. If easy_tier is on, then easy_tier_status is active
2. if easy_tier is off, then easy_tier_status is inactive
3. If easy_tier is auto, then the value of easy_tier_status is determined by the number of tiers an
storage pool has.
easy_tier_status
Whether the Easy Tier functions are active on an storage pool:
v active
v inactive
tier Which tier information is being reported:
v generic_ssd
v generic_hdd
tier_mdisk_count
The number of MDisks in the tier.
tier_capacity
The total MDisk capacity assigned to the volume in the tier.
Note: For space-efficient copies, the capacity by tier will be the real capacity.
tier_free_capacity
The unused amount of MDisk storage in the tier.
compression_active
Indicates if there are any compressed volume copies in the storage pool.
compression_virtual_capacity
The total virtual capacity for all compressed volume copies in the storage pool. This is in
unsigned decimal format.
compression_compressed_capacity
The total used capacity for all compressed volume copies in the storage pool. This is in unsigned
decimal format.
compression_uncompressed_capacity
The total uncompressed used capacity for all compressed volume copies in the storage pool. This
is in unsigned decimal format.
| site_id
| Indicates the site value for the MDisk group. This numeric value is 1, 2, 3 or blank.
| site_name
| Indicates the site name for the MDisk group. This is an alphanumeric value or is blank.
The following define the status fields, from lowest to highest priority:
Online
The storage pool is online and available.
Offline
All paths to the storage pool are lost.
364 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
A concise invocation example
lsmdiskgrp -delim :
rmmdisk
Use the rmmdisk command to delete a managed disk (MDisk) from a managed disk group.
Syntax
rmmdisk -mdisk mdisk_id_list mdisk_group_id
mdisk_name_list -force mdisk_group_name
Parameters
-mdisk mdisk_id_list | mdisk_name_list
(Required) Specifies one or more managed disk IDs or names to delete from the group.
-force
(Optional) Migrates data on the specified disks to other disks in the group. The command completes
asynchronously if -force is specified.
mdisk_group_id | mdisk_group_name
(Required) Specifies the ID or name of the managed disk group to delete the disks from. The warning
threshold for an MDisk group is automatically scaled when MDisks are deleted.
Description
This command attempts to remove the managed disk or disks from the group.
Deleting a managed disk from a group can only be done if the managed disk does not contain any
extents in use by a virtual disk. If there are extents in use and you do not supply the force flag, the
command fails.
Attention: If this disk being removed has already been powered down, removed, or is experiencing a
power outage, the migration is pending and does not complete until the MDisk comes back online. The
MDisk is not removed from the list of MDisks that are contained in the group.
If the disk has been deliberately removed, the only method of removing the MDisk is to remove the
entire group itself.
Ensure that you do not destroy any controller LUNs until you have deleted them from the MDisk group
that they belong to.
The rmmdisk command fails if there are insufficient free extents on other disks in the mdisk group for the
duration of the command.
366 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
If you do specify the force flag, an attempt will be made to migrate the extents that are in use onto other
free extents within the group. If there are not enough free extents in the group, the command will fail
even if the force flag is specified.
When an array MDisk is in a storage pool, five extents in the storage pool are reserved for internal use. If
you attempt to remove an MDisk when an array MDisk is in the storage pool, the command will fail
(even if the -force flag is specified), if five free extents do not remain in the storage pool.
To delete the disks from the group, you have the following options:
v You can delete the virtual disk that is using the extents specified on the managed disk.
v You can add more managed disks to the group, rerun the command and specify the -force parameter.
When data is being migrated from the managed disk, it might take some time for the command to
complete. The command itself will return with a success code, notifying you that migration is in progress.
An event is logged when the migration is complete and the disk is deleted from the group at this time.
You can also check the progress of any active migrations by running the lsmigrate command.
If the -force parameter is used, the rmmdisk command fails if offline Managed Disks or no online
quorum disks will prevent the migration. Correct the offline or quorum disk condition and try reissuing
the command.
| Remember: When using the -mdisk parameter, MDisks are removed if there is one (or more) SAS MDisk
| specified in the list.
An invocation example
rmmdisk -mdisk mdisk12 -force Group3
rmmdiskgrp
Use the rmmdiskgrp command to delete a managed disk group (storage pool) without being able to
recover it.
Syntax
rmmdiskgrp mdisk_group_id
-force mdisk_group_name
Parameters
-force
(Optional) Specifies that all virtual disks and virtual disk-to-host mappings be deleted. When you use
this parameter, all managed disks in the group are removed and the group itself is deleted.
mdisk_group_id | mdisk_group_name
(Required) Specifies the ID or name of the managed disk group that is to be deleted.
Description
The rmmdiskgrp command deletes the specified managed disk group. The -force parameter is required
if there are virtual disks that have been created from this group or if there are managed disks in the
group. Otherwise, the command fails.
The command deletes all volume copies in the specified MDisk group. If the volume has no remaining
synchronized copies in other MDisk groups, the volume is also deleted.
Attention:
1. This command partially completes asynchronously. All virtual disks, host mappings, and Copy
Services relationships are deleted before the command completes. The deletion of the managed disk
group then completes asynchronously.
2. Before you issue the command, ensure that you want to delete all mapping information; data that is
contained on virtual disks cannot be recovered after the managed disk group has been deleted.
In detail, if you specify the -force parameter and the virtual disks are still using extents in this group,
the following actions are initiated or occur:
v The mappings between that disk and any host objects and the associated Copy Services relationships
are deleted.
v If the virtual disk is a part of a FlashCopy mapping, the mapping is deleted.
Note: If the mapping is not in the idle_or_copied or stopped states, the mapping is force-stopped and
then deleted. Force-stopping the mapping might cause other FlashCopy mappings in the system to also
be stopped. See the description for the -force parameter in the stopfcmap command for additional
information.
v Any virtual disk that is in the process of being migrated into or out of the managed disk group is
deleted. This frees up any extents that the virtual disk was using in another managed disk group.
v Virtual disks are deleted without first flushing the cache. Therefore, the storage controller LUNs that
underlie any image mode MDisks might not contain the same data as the image mode volume prior to
the deletion.
v If there are managed disks in the group, all disks are deleted from the group. They are returned to the
unmanaged state.
v The group is deleted.
Attention: If you use the -force parameter to delete all the managed disk groups in your system, you
are returned to the processing state where you were after you added nodes to the system. All data that is
contained on the virtual disks is lost and cannot be recovered.
An invocation example
rmmdiskgrp -force Group3
368 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 21. Metro Mirror and Global Mirror commands
The Copy Service commands enable you to work with the Metro Mirror and Global Mirror services that
the SAN Volume Controller provides.
chpartnership
Use the chpartnership command to modify the bandwidth of the partnership between the local clustered
system (system) and the remote system that is specified in the command. This affects the bandwidth that
is available for background copy in a system partnership by either Metro Mirror or Global Mirror
operations. Additionally, use this command to disable and re-enable the partnership, which allows permit
the local system to be disconnected and then reconnected to the remote system.
Syntax
| chpartnership
| -type ipv4 -clusterip newipv4addr
ipv6 newipv6addr
|
| -chapsecret newCHAPsecret -nochapsecret
|
| -backgroundcopyrate percentage -linkbandwidthmbits link_bandwidth_in_mbps
| remote_system_id
| -start remote_system_name
-stop
|
Parameters
| -type ipv4 | ipv6
| (Optional) Specifies the Internet Protocol (IP) address format for the partnership using either of the
| following case-sensitive strings:
| v ipv4 for Internet Protocol Version 4 (IPv4)
| v ipv6 for Internet Protocol Version 6 (IPv6)
| This migrates a partnership from ipv4 to ipv6 or vice versa.
| -clusterip newipv4addr | newipv6addr
| (Optional) Specifies the new partner system IP address, either ipv4 or ipv6. Systems connected over IP
| links are not displayed by lspartnershipcandidate before executing mkippartnership. This does not
| apply to FC-based or FCoE-based connections.
| Specify this parameter when creating partnerships with systems connected over native IP links. To
| change the partner system IP address, specify chapartnership -stop to stop the partnership.
| -chapsecret newCHAPsecret
| (Optional) Specifies the new Challenge-Handshake Authentication Protocol (CHAP) secret of the
| partner system. The maximum size of the CHAP secret is eighty alphanumeric characters.
| -nochapsecret
| (Optional) Resets the CHAP secret used to authenticate with the partner system. Specify
| Remember: Specifying a remote system ID or name with chpartnership does not affect the remote
| system. To change the system name, specify chsystem.
Description
| This command modifies the bandwidth of the partnership between the local system and the remote
| system specified in the command. This affects the bandwidth available for a background copy in Metro
| Mirror or Global Mirror relationships (from the local to the remote system) . To modify the background
| copy bandwidth from remote system to local system, issue chpartnership a second time for the remote
| system.
| Change the CHAP secret or system IP for partnerships created using IP links. Before changing the partner
| CHAP secret or system IP, stop the partnership.
| Important:
| v If you start with a fully configured remote copy partnership, the state (as reported by lspartnership)
| is fully_configured.
| v If a stop partnership is issued, the state is not_present (typically for ten seconds or less) before it
| becomes fully_configured_stopped.
| Note: The local and remote systems in an IP partnerships must use the same IP address types, IPv4 or
| IPv6.
370 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
chpartnership -stop cluster1
chrcconsistgrp
Use the chrcconsistgrp command to modify attributes of an existing Metro Mirror or Global Mirror
consistency group, such as changing the name of a consistency group.
Syntax
chrcconsistgrp
-name new_name_arg -global
-cycleperiodseconds period -metro
-cyclingmode none
multi
Parameters
-name new_name_arg
(Optional) Specifies the new name to assign to the consistency group.
-cycleperiodseconds period
(Optional) Specifies the cycle period in seconds. The minimum cycle period value is 60 seconds, and
the default is 300 seconds.
This defines an optional cycle period that applies to Global Mirror relationships with a cycling mode
of multi. A Global Mirror relationship using the multi cycling_mode performs a complete cycle each
period. It might be provided for any relationship, but cannot be used for none when considering
Metro or Global Mirror relationships.
-cyclingmode none | multi
(Optional) Specifies the behavior of Global Mirror for this relationship.
v Specifying none, the default, gives identical behavior to Global Mirror in previous versions of SAN
Volume Controller.
v Specifying multi uses the cycling protocol.
To start a relationship with cycling_mode set to multi, change volumes must be defined for the
relationship.
Note: The cycling_mode can only be changed when the relationship is stopped and in
consistent_stopped or inconsistent_stopped states.
-metro
(Optional) Specifies the change in the consistency group's copy type and converts a Global Mirror
(with or without change volumes) relationship to a Metro Mirror relationship.
-global
(Optional) Specifies the change in the consistency group's copy type and converts a Metro Mirror
relationship to a Global Mirror relationship.
Remember: This parameter is not mutually-exclusive with -cyclingmode. If you do not specify
-cyclingmode and the relationship is Metro Mirror, the cycling_mode value is none.
rc_consist_group_name | rc_consist_group_id
(Required) Specifies the ID or existing name of the consistency group that you want to modify.
Description
This command modifies the specified attributes of the supplied consistency group, one attribute at a time.
Note:
v All parameters are mutually-exclusive with the exception of the -cyclingmode, which is
mutually-exclusive with all parameters but -global.
v One of the optional parameters must be specified.
v A Global Mirror consistency group with cycling mode set to multi requires that change volumes are
defined for the primary and secondary volumes of each relationship in the group before it can be
started.
v For intersystem relationships the -cycleperiodseconds and -cyclingmode parameters can only be
specified when the two systems are connected. If the two systems become disconnected while the
372 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
command is being processed, then the command might be completed with the change having been
performed at the system that received the task invocation only (and the other system is updated upon
re-connection).
chrcrelationship
Use the chrcrelationship command to modify certain attributes of an existing relationship, such as to
add a relationship to a consistency group, to remove a relationship from a consistency group, and to
change the name of the relationship. You can only change one attribute at a time.
Syntax
chrcrelationship -masterchange
master_change_vdisk_id -global
master_change_vdisk_name -metro
-auxchange
aux_change_vdisk_id
aux_change_vdisk_name
-nomasterchange
-noauxchange
-name new_name_arg
-consistgrp consist_group_id
consist_group_name
-noconsistgrp
-cycleperiodseconds period
-cyclingmode none
multi
rc_rel_id
rc_rel_name
Parameters
-masterchange master_change_vdisk_id | master_change_vdisk_name
(Optional) Specifies a change volume association for the master volume in the relationship.
-auxchange aux_change_vdisk_id | aux_change_vdisk_name
(Optional) Specifies a change volume association for the auxiliary volume in the relationship.
-nomasterchange
(Optional) Specifies a defined change volume on the master volume should be removed from the
relationship.
| Note: To use this parameter the specified change volume must no longer be in use by the
| relationship, including change volumes of a running relationship (inconsistent_copying,
| consistent_copying, or consistent_synchronized).
| This does not include a primary change volume of a stopped relationship. A secondary change
| volume of a relationship stopped from consistent_copying is considered in use if the change volume
| Note: To use this parameter the specified change volume must no longer be in use by the
| relationship, including change volumes of a running relationship (inconsistent_copying,
| consistent_copying, or consistent_synchronized).
| This does not include a primary change volume of a stopped relationship. A secondary change
| volume of a relationship stopped from consistent_copying is considered in use if the change volume
| is supplying the consistent image. If this change volume needs to be removed, the relationships must
| first be stopped using the -access parameter in order to apply the consistent image to the secondary
| volume.
-name new_name_arg
(Optional) Specifies a new label to assign to the relationship.
-consistgrp consist_group_id | consist_group_name
(Optional) Specifies a new consistency group to assign the relationship to. Only relationships of the
same copy type (Global or Metro Mirror) can be assigned to the same consistency group.
-noconsistgrp
(Optional) Removes the specified relationship from a consistency group, making the relationship a
standalone relationship.
-cycleperiodseconds period
(Optional) Specifies the cycle period in seconds. The minimum cycle period value is 60 seconds. The
default is 300 seconds (5 minutes).
This defines an optional cycle period that applies to Global Mirror relationships with a cycling mode
of multi. A Global Mirror relationship using the multi cycling_mode performs a complete cycle at
most once each period.
-cyclingmode none | multi
(Optional) Specifies the behavior of Global Mirror for this relationship.
v Specifying none, the default, gives identical behavior to Global Mirror in previous versions of SAN
Volume Controller.
v Specifying multi uses the cycling protocol.
To start a relationship with cycling_mode set to multi, change volumes must be defined for the
relationship.
Note: The cycling_mode can only be changed when the relationship is stopped and in
consistent_stopped or inconsistent_stopped status.
-metro
(Optional) Specifies the change in the relationship's copy type and converts a Global Mirror (with or
without change volumes) relationship to a Metro Mirror relationship.
-global
(Optional) Specifies the change in the relationship's copy type and converts a Metro Mirror
relationship to a Global Mirror relationship.
Remember: This parameter is not mutually-exclusive with -cyclingmode. If you do not specify
-cyclingmode and the relationship is Metro Mirror, the cycling_mode value is none.
374 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
rc_rel_name | rc_rel_id
(Required) Specifies the ID or name of the relationship.
Description
This command modifies the specified attributes of the supplied relationship, one attribute at a time. In
addition to changing the name of a consistency group, this command can be used for the following
purposes.
Remember:
v All parameters are mutually-exclusive with the exception of the -cyclingmode, which is
mutually-exclusive with all parameters but -global.
v One of the optional parameters must be specified.
v You can add a stand-alone relationship to a consistency group by specifying the -consistgrp parameter
and the name or ID of the consistency group. The relationship and consistency group must be
connected when the command is issued and must share the following components:
– Master system
– Auxiliary system
– State (unless the group is empty)
– Primary (unless the group is empty)
– Type (unless the group is empty)
– Cycling mode (unless the group is empty)
When the first relationship is added to an empty group, the group takes on the same state, primary
(copy direction), type (Metro or Global Mirror), and cycling mode as the relationship. Subsequent
relationships must have the same state, copy direction, and type as the group in order to be added to
it. A relationship can only belong to one consistency group.
v You can remove a relationship from a consistency group by specifying the -noconsistgrp parameter
and the name or ID of the relationship. Although you do not have to specify or confirm the name of
the consistency group, verify which group the relationship belongs to before you issue this command.
This form of the modify relationship command succeeds in the connected or disconnected states. If the
systems are disconnected the relationship is only removed from the consistency group on the local
system, at the time the command is issued. When the systems are reconnected the relationship is
automatically removed from the consistency group on the other system. Alternatively, you can issue an
explicit modify (chrcrelationship) command to remove the relationship from the group on the other
system while it is still disconnected.
Note: If you remove all relationships from the group, the relationship type is reset to empty_group.
When you add a relationship to the empty group, the group again takes on the same type as the
relationship.
v To move a relationship between two consistency groups, you must issue the chrcrelationship
command twice. Use the -noconsistgrp parameter to remove the relationship from its current group,
and then use the -consistgrp parameter with the name of the new consistency group.
Remember: You cannot specify a master and auxiliary change volume in the same command.
If the relationships cycle_period_seconds does not match that of the consistency group it is added to, the
newly-added relationship copies the cycle_period_seconds value from the group. If later removed from
the group, the copied cycle_period_seconds value remains.
When a Global Mirror relationship with a cycling_mode value of multi is added to a group that is not
empty, both the group and the relationship must be stopped.
An invocation example
chrcrelationship -cyclingmode multi relB
376 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
chrcrelationship -cycleperiodseconds 20 relC
lspartnership
Use the lspartnership command to display a concise or detailed view of the current clustered systems
(systems) that are associated with the local system.
Syntax
lspartnership -filtervalue attribute=value -filtervalue? system_id
system_name
Parameters
-filtervalueattribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed. If a capacity is specified, the units must also be included.
v Some filters allow the asterisk character (*) when you enter the command. The following rules
apply to the use of wildcard characters with the SAN Volume Controller command-line interface
(CLI):
– The wildcard character is an asterisk (*).
– The command can contain a maximum of one wildcard.
– When you use a wildcard, you must enclose the filter entry within double quotation marks (""):
lspartnership -filtervalue "name=md*"
-filtervalue?
(Optional) displays a list of filters that can be applied against this view. The following filter attributes
are valid:
v id
v name
system_id | system_name
(Optional) Specifies the name or ID of a system. Using this parameter displays the detailed view of
the specific partner system, and any value specified by the -filtervalue (which filters a view that is
based on specific attribute values that relate to each object type) parameter is ignored. When
specifying system_id or system_name parameter, the concise view of all systems that match the
filtering requirements that are specified by the -filtervalue parameter are displayed.
Description
378 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 61. lspartnership attribute values (continued)
Attribute Value
| cluster_ip Displays the partner system IP address, which can be IPv4 or IPv6. This information
| is displayed for both FC-based and IP-based partnerships. For IP-based partnership
| this field displays the system IP address t specified while creating the partnership
| using mkippartnership. For FC partnerships, any one of the system IP addresses is
| displayed.
| chap_secret Displays the Challenge-Handshake Access Protocol (CHAP) secret (up to eighty
| alphanumeric characters) for the partner system. The CHAP authenticates the local
| system r with the partner system during discover and Internet Small Computer
| System Interface (iSCSI) system session creation. For FC-based and FCoE-based
| relationships this field is always blank.
| link_bandwidth_mbits Displays the aggregate bandwidth for the Remote Copy (RC) link in Megabits (Mbps)
| per second. This is a numeric value is 0 to 100000. If there are multiple links between
| the local and remote systems, this parameter is set to the sum of the link bandwidths
| for these links.
| background_copy_rate Displays the bandwidth allocation for background copy operations performed over
| the replication link. It is expressed as a percentage of the link bandwidth value, and
| is the maximum rate at which background copy operations are performed. This is a
| numeric value from 0 to 100 .
| event_log_sequence Displays the last sequence number (indicating the last event) from event log for this
| partnership. This is a numeric value is 100 to 8000000. For FC-based and FCoE-based
| relationships this field is always blank.
Syntax
lsrcconsistgrp
-filtervalue attribute=value -nohdr
-delim delimiter -filtervalue? object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller command line interface (CLI):
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
v When using a wildcard, you must enclose the filter entry with double quotation marks (""), as
follows:
lsrcconsistgrp -filtervalue "name=md*"
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
380 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v master_cluster_id
v master_cluster_name
v aux_cluster_id
v aux_cluster_name
v primary
v state
v relationship_count
v id
v copy_type
Description
This command returns a concise list or a detailed view of Global or Metro Mirror consistency groups that
are visible to the system.
Table 62 provides possible values for the attributes that are displayed as data in the output views.
Table 62. lsrcconsistgrp command output values
Attribute Value
primary n/a, master, aux
state consistent_copying, inconsistent_stopped, inconsistent_copying, consistent_stopped,
consistent_synchronized, idling, idling_disconnected, inconsistent_disconnected
consistent_disconnected, empty
cycle_period_seconds The minimum period in seconds between multiple cycles (integer between 60 an 86400;
default is 300).
cycling_mode The type of Global or Metro Mirroring cycling to use: none or multi (default is none)
freeze_time The time in YY/MM/DD/HH/MM format.
status online, primary_offline, secondary_offline,
sync in_sync, out_of_sync
copy_type metro, global, empty_group
Note: The names of the Global or Metro Mirror relationships and consistency groups might be blank if
the relationship or consistency groups are intersystem and the system partnership is disconnected.
The sync attribute has a value of in_sync when the contents are synchronized (identical) between VDisks
(volumes). If write operations take place on either the primary or secondary volume after a consistent
(stopped) or idling state occurs, they will no longer be synchronized.
248:jdemo_BA_cons1:0000020060406746:clusterB:0000020061413ABA:clusterA:master:
consistent_stopped:2:global:none:06/06/27/08/31/37
249:rccstgrp0:0000020061413ABA:clusterA:0000020061413ABA:clusterA::empty:0
:empty_group
250:jdemo_BA_cons2:0000020060406746:clusterB:0000020061413ABA:clusterA:master:
inconsistent_stopped:1:metro:none:06/06/27/08/31/37
251:BA_cons1:0000020060406746:clusterB:0000020061413ABA:clusterA:master:
consistent_stopped:4:metro:none:06/06/27/08/31/37
lsrcrelationship
Use the lsrcrelationship command to return a concise list or a detailed view of Metro or Global Mirror
relationships visible to the clustered system (system).
Syntax
lsrcrelationship
-filtervalue attribute=value -nohdr
-delim delimiter -filtervalue? object_id
object_name
Parameters
-filtervalue attribute=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are returned. If a capacity is specified, the units must also be included.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is an asterisk (*).
v The command can contain a maximum of one wildcard, which must be the first or last character in
the string.
v When using a wildcard, you must enclose the filter entry with double quotation marks (" "), as
follows:
lsrcrelationship -filtervalue "name=md*"
382 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: If there is no data to be displayed, headings are not displayed even if the -nohdr parameter is
specified.
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
object_id | object_name
(Optional) Specifies the name or ID of an object. When you use this parameter, the detailed view of
the specific object is returned and any value that is specified by the -filtervalue parameter is
ignored. If you do not specify the object_id | object_name parameter, the concise view of all objects
matching the filtering requirements that are specified by the -filtervalue parameter are displayed.
-filtervalue?
(Optional) Specifies that you want your report to display any or all of the list of valid filter attributes.
The valid filter attributes for the lsrcrelationship command are:
v RC_rel_id
v RC_rel_name
v master_system_id
v master_system_name
v master_vdisk_id
v master_vdisk_name
v aus_system_id
v aux_system_name
v aux_vdisk_id
v aux_vdisk_name
v primary
v consistency_group_id
v consistency_group_name
v state
v progress
v copy_type
Description
This command returns a concise list or a detailed view of Metro or Global Mirror relationships visible to
the system.
Table 63 on page 384 provides possible values for the attributes that are displayed as data in the output
views.
Note: The names of the Global or Metro Mirror relationships and consistency groups can be blank if the
relationship or consistency groups are intersystem and the system partnership is disconnected.
The sync attribute has a value of in_sync when the contents are synchronized (identical) between
volumes. If write operations take place on either the primary or secondary volume after a consistent
(stopped) or idling state occurs, they will no longer be synchronized.
384 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
id:name:master_cluster_id:master_cluster_name:master_vdisk_id:master_vdisk_name:
aux_cluster_id:aux_cluster_name:aux_vdisk_id:
aux_vdisk_name:primary:consistency_group_id:consistency_group_name:state:bg_copy
_priority:progress:copy_type:cycling_mode:freeze_time
45:jrel_AB1:0000020061413ABA:clusterA:45:jdisk_B8:0000020060406746:clusterB:38:j
disk_B1:master:::consistent_stopped:50:metro:none:06/06/27/08/31/37ib
48:jrel_AB2:0000020061413ABA:clusterA:48:jdisk_A4:0000020060406746:clusterB:41:j
disk_B4:master:::consistent_synchronized:50:metro:none:06/06/27/09/31/37
49:jrel_BA_1:0000020060406746:clusterB:42:jdisk_B5:0000020061413ABA:clusterA:49:j
disk_A5:master:248:jdemo_BA_cons1:consistent_stopped:50:metro:none:06/06/27/10/31/37
50:jrel_BA_2:0000020060406746:clusterB:43:jdisk_B6:0000020061413ABA:clusterA:
50:jdisk_A6:master:248:jdemo_BA_cons1:consistent_stopped:50:metro:none:06/06/27/11/31/37
lsrcrelationshipcandidate
Use the lsrcrelationshipcandidate command to lists VDisks (volumes) that can form Metro or Global
Mirror relationships. You can list eligible volumes that are on the local or remote clustered system
(system).
Syntax
lsrcrelationshipcandidate
-master master_vdisk_id
master_vdisk_name
-aux aux_cluster_id -nohdr -delim delimiter
aux_cluster_name
Parameters
-master master_vdisk_id | master_vdisk_name
(Required) Specifies a particular VDisk (volume) to use as the master volume. The command finds
candidates that match the size of this volume. If you are requesting candidate volumes on the local
system, this command also matches the io_group.
Chapter 21. Metro Mirror and Global Mirror commands 385
-aux aux_cluster_id | aux_cluster_name
(Required) Specifies a remote system with volume candidates for an intersystem relationship. If you
do not specify this parameter, the candidates on the local system are displayed.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a list of volumes that can be either the master or the auxiliary disk for a Metro or
Global Mirror relationship. Volume IDs and names are displayed.
Note: Volumes that are flash disks are excluded from the view when a FlashCopy map is constructed.
An invocation example
lsrcrelationshipcandidate -delim :
lsrcrelationshipprogress
Use the lsrcrelationshipprogress command to display the progress of the background copy of a Metro
Mirror or Global Mirror relationship as a percentage. When the initial background copy process for a
relationship completes, a null value is displayed for the progress of that relationship.
Syntax
lsrcrelationshipprogress
-nohdr -delim delimiter
rcrelationship_id
rcrelationship_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
386 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
rcrelationship_id | rcrelationship_name
Specifies the object ID or name of the specified type.
Description
This command displays the progress of the background copy of a Metro Mirror or Global Mirror
relationship as a percentage.
An invocation example
lsrcrelationshipprogress -delim : 0
| mkfcpartnership
| Use the mkfcpartnership command to define partnerships using Fibre Channel (FC) or Fibre Channel
| over Ethernet (FCoE).
| Syntax
| mkfcpartnership -linkbandwidthmbits link_bandwidth_in_mbps
|
| remote_system_id
| -backgroundcopyrate percentage remote_system_name
|
| Parameters
| -linkbandwidthmbits link_bandwidth_in_mbps
| (Required) Specifies the aggregate bandwidth of the Remote Copy (RC) link between two clustered
| systems (systems in megabits per second (mbps). It is a numeric value from 1 to 100000.
| This command defines FC-based or FCoE-based partnerships. However, all existing partnerships are
| automatically upgraded to FC partnerships, any invocation of this command is applicable only to
| FC-based partnerships, and all partnerships created are FC-based partnerships.
| An invocation example
| mkfcpartnership –linkbandwidthmbits 100 –backgroundcopyrate 50 remote-system-2
| An invocation example
| mkfcpartnership –linkbandwidthmbits 1024 –backgroundcopyrate 25 remote-system-3
| mkippartnership
| Use the mkippartnership command to define a new partnership created over Internet Protocol (IP) links.
| Syntax
| -linkbandwidthmbits link_bandwidth_in_mbps
| -backgroundcopyrate percentage
|
| Parameters
| -type ipv4 | ipv6
| (Required) Specifies the Internet Protocol (IP) address format for the partnership using either of the
| following case-sensitive strings:
| v ipv4 for Internet Protocol Version 4 (IPv4)
| v ipv6 for Internet Protocol Version 6 (IPv6)
| All Transmission Control Protocol (TCP) Remote Copy (RC) connections between the primary and
| remote clustered systems (systems) are created using specific IP addresses. Partnership creation fails if
| the Internet Protocol (IP) address types specified for either primary or remote systems are not the
| same.
| -clusterip ipadr
| (Required) Specifies the partner system IP address, either ipv4 or ipv6. Systems connected over IP
| links are not displayed by lspartnershipcandidate before executing mkippartnership. This does not
| apply to FC-based or FCoE-based connections.
| -chapsecret CHAPsecret
| (Optional) Specifies the Challenge-Handshake Authentication Protocol (CHAP) secret of the partner
| system. The maximum size of the CHAP secret is eighty alphanumeric characters.
| -linkbandwidthmbits link_bandwidth_in_mbps
| (Required) Specifies the aggregate bandwidth of the RC link between two clustered systems (systems)
| in megabits per second (mbps). It is a numeric value from 1 to 100000.
388 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| -backgroundcopyrate percentage
| (Optional) Specifies the maximum percentage of aggregate link bandwidth that can be used for
| background copy operations. It is a numeric value from 0 to 100, and the default value is 50, which
| means that a maximum of 50% of the aggregate link bandwidth can be used for background copy
| operations.
| Description
| This command defines a new partnership created over Internet Protocol (IP) links. A remote system IP
| must be specified so its IP ports are enabled for data replication. RC sessions can then be created between
| the two partners.
| In FC-based or FCoE-based partnerships, the partner system must first be a partnership candidate
| (displayed by lspartnership). Then it can become part of a partnership, created specifying
| mkfcpartnership with the remote system ID or name.
| For IP partnerships, specifying mkippartnership with the cluster IP address and CHAP secret of the
| partner creates the partnership.
| All TCP connections are established using either IPv4 or IPv6, and it cannot be a mix of the two IP
| address types.
| Both systems in a partnership must have at least one IP address from an identical replication group to
| establish RC partnerships. Replication groups are numeric values that specify the pools of local IP
| addresses that establish Remote Copy partnerships with pools of IP addresses configured on the partner
| system.
| An invocation example
| mkippartnership –type ipv4 –clusterip 192.168.32.19
| –chapsecret mychapsecret –linkbandwidthmbits 100 –backgroundcopyrate 50
| An invocation example
| mkippartnership –type ipv6 –clusterip fe80::200:f8ff:fe21:67cf
| –chapsecret mychapsecret –linkbandwidthmbits 1024 –backgroundcopyrate 25
mkpartnership (Discontinued)
This command is discontinued. Use the either mkfcpartnership or mkippartnership command instead.
mkrcconsistgrp
Use the mkrcconsistgrp command to create a new, empty Metro Mirror or Global Mirror consistency
group. If the -cluster parameter is not specified, the consistency group is created on the local clustered
system (system) only.
Parameters
-name new_name
(Optional) Specifies a name for the new consistency group.
-cluster cluster_id | cluster_name
(Optional) Specifies the name or ID of the remote system. If -cluster is not specified, a consistency
group is created only on the local system.
Description
This command creates a new consistency group. The ID of the new group is displayed after the
command processes. The name must be unique across all consistency groups that are known to the
systems within this consistency group. If the consistency group involves two system, the systems must be
in communication throughout the create process.
The new consistency group does not contain any relationships and will be in the empty state. You can
add Metro Mirror or Global Mirror relationships to the group using the chrcrelationship command.
Remember: Names representing Metro Mirror or Global Mirror consistency groups relationships are
restricted to fifteen characters in length (not sixty-three for an extended character set).
An invocation example
mkrcconsistgrp -name rc_testgrp
mkrcrelationship
Use the mkrcrelationship command to create a new Global or Metro Mirror relationship with volumes in
the same clustered system (system), forming an intrasystem relationship or intersystem relationship (if it
involves more than one clustered system).
Syntax
mkrcrelationship -master master_vdisk_id -aux aux_vdisk_id
master_vdisk_name aux_vdisk_name
-cluster cluster_id
cluster_name -name new_name_id
-consistgrp consist_group_id -sync
consist_group_name
390 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-global
-cyclingmode none
multi
Parameters
-master master_vdisk_id | master_vdisk_name
(Required) Specifies the ID or name of the master_vdisk_id or master_vdisk_name.
-aux aux_vdisk_id | aux_vdisk_name
(Required) Specifies the ID or name of the aux_vdisk_id or aux_vdisk_name.
-cluster cluster_id | cluster_name
(Required) Specifies the ID or name of the remote cluster.
v If you are creating an intrasystem relationship, enter the ID of the local system. The volumes in the
relationship must belong to the same I/O group within the system.
v If you are creating an intersystem relationship, enter the ID of the remote system. To create a
relationship in two different systems, the systems must be connected at the time that the
mkrcrelationship command is received.
-name new_name_id
(Optional) Specifies a label to assign to the relationship.
-consistgrp consist_group_id | consist_group_name
(Optional) Specifies a consistency group that this relationship joins. If you do not supply the
-consistgrp parameter, the relationship is created as a stand-alone relationship that can be started,
stopped, and switched on its own.
Note: Metro and Global Mirror relationships cannot belong to the same consistency group. When the
first relationship is added to the consistency group, the group takes on the same type as the
relationship. Subsequently, only relationships of that type can be added to the consistency group.
-sync
(Optional) Specifies that you want the system to create a synchronized relationship. The -sync
parameter guarantees that the master and auxiliary disks contain identical data at the point that the
relationship is created. You must ensure that the auxiliary disk is created to match the master disk
and that no input transactions take place to either disk before you issue the create command. The
initial background synchronization is skipped.
-global
(Optional) Specifies that you want the system to create a new Global Mirror relationship. If you do
not specify the -global parameter, a Metro Mirror relationship is created instead.
-cyclingmode none | multi
(Optional) Specifies the behavior of Global Mirror for this relationship.
v Specifying none, the default, gives identical behavior to Global Mirror in previous versions of SAN
Volume Controller.
v Specifying multi uses the cycling protocol.
The default cycle period is 300 seconds. The cycle period can be modified after the relationship has
been created by using the chrcrelationship command. To start a relationship with cycling_mode set
to multi, change volumes must be defined for the relationship.
This command creates a new Global or Metro Mirror relationship. A Metro Mirror relationship defines
the relationship between two volumes: a master volume and an auxiliary volume. This relationship
persists until it is deleted. The auxiliary virtual disk must be identical in size to the master virtual disk or
the command fails, and if both volumes are in the same system, they must both be in the same I/O
group. The master and auxiliary cannot be in an existing relationship. Any defined FlashCopy mappings
that have the proposed master volume as the target of the FlashCopy mapping must be using the same
I/O group as the master volume. Any defined FlashCopy mappings that have the proposed auxiliary
volume as the target of the FlashCopy mapping must be using the same I/O group as the auxiliary
volume.
Note: You cannot create a remote copy relationship with this command if the auxiliary volume is an
active FlashCopy mapping target.
You can optionally give the relationship a name. The name must be a unique relationship name across
both systems.
The relationship can optionally be assigned to a consistency group. A consistency group ensures that a
number of relationships are managed so that, in the event of a disconnection of the relationships, the data
in all relationships within the group is in a consistent state. This can be important in, for example, a
database application where data files and log files are stored on separate volumes and consequently are
managed by separate relationships. In the event of a disaster, the primary and secondary sites might
become disconnected. As the disconnection occurs and the relationships stop copying data from the
primary to the secondary site, there is no assurance that updates to the two separate secondary volumes
will stop in a consistent manner if the relationships that are associated with the volumes are not in a
consistency group.
For proper database operation, it is important that updates to the log files and the database data are
made in a consistent and orderly fashion. It is crucial in this example that the log file volume and the
data volume at the secondary site are in a consistent state. This can be achieved by putting the
relationships that are associated with these volumes into a consistency group. Both Metro Mirror and
Global Mirror processing ensure that updates to both volumes at the secondary inh_site are stopped,
leaving a consistent image based on the updates that occurred at the primary site.
If you specify a consistency group, both the group and the relationship must have been created using the
same master system and the same auxiliary system. The relationship must not be a part of another
consistency group. If the consistency group is empty, it acquires the type of the first relationship that is
added to it. Therefore, each subsequent relationship that you add to the consistency group must have the
same type.
If the consistency group is not empty, the consistency group and the relationship must be in the same
state. If the consistency group is empty, it acquires the state of the first relationship that is added to it. If
the state has an assigned copy direction, the direction of the consistency group and the relationship must
match that direction.
392 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
If you do not specify a consistency group, a stand-alone relationship is created.
If you specify the -sync parameter, the master and auxiliary virtual disks contain identical data at the
point when the relationship is created. You must ensure that the auxiliary is created to match the master
and that no data movement occurs to either virtual disk before you issue the mkrcrelationship
command.
If you specify the -global parameter, a Global Mirror relationship is created. Otherwise, a Metro Mirror
relationship is created instead.
The volumes specified on the -master and -aux parameters cannot be master or auxiliary volumes in an
existing relationship.
An invocation example
mkrcrelationship -master vdisk1 -aux vdisk2 -name rccopy1
-cluster 0000020063432AFD
An invocation example
mkrcrelationship -master vdiskA -aux vdiskB
-cluster clusterB
-name new_rel
-global
-cyclingmode multi
rmpartnership
Use the rmpartnership command to remove a Metro Mirror or Global Mirror partnership on one
clustered system (system). Because the partnership exists on both systems, it is necessary to run this
command on both systems to remove both sides of the partnership. If the command is run on only one
system, the partnership enters a partially configured state on the other system.
Syntax
rmpartnership remote_cluster_id
remote_cluster_name
Parameters
remote_cluster_id | remote_cluster_name
(Required) Specifies the system ID or the name of the remote system.
Description
This command deletes one half of a partnership on a system. To remove the entire partnership, you must
run the command twice, once on each system.
Attention: Before running the rmpartnership command, you must remove all relationships and groups
that are defined between the two systems. To display system relationships and groups, run the
lsrcrelationship and lsrcconsistgrp commands. To remove the relationships and groups that are
defined between the two systems, run the rmrcrelationship and rmrcconsistgrp commands.
Chapter 21. Metro Mirror and Global Mirror commands 393
An invocation example
rmpartnership cluster1
rmrcconsistgrp
Use the rmrcconsistgrp command to delete an existing Metro Mirror or Global Mirror consistency group.
Syntax
rmrcconsistgrp rc_consist_group_id
-force rc_consist_group_name
Parameters
-force
(Optional) Specifies that you want the system to remove any relationship belonging to a group before
the consistency group is deleted. The relationship itself is not deleted; it becomes a stand-alone
relationship.
Note: The -force parameter must be used to delete a consistency group when the consistency group
has any Metro Mirror or Global Mirror relationships that is associated with it. If you do not use the
-force parameter, the command fails.
rc_consist_group_id | rc_consist_group_name
(Required) Specifies the ID or the name of the consistency group to delete.
Description
This command deletes the specified consistency group. You can issue this command for any existing
consistency group. If the consistency group is disconnected at the time that the command is issued, the
consistency group is only deleted on the cluster that is connected. When the clusters reconnect, the
consistency group is automatically deleted on the other cluster. Alternatively, if the clusters are
disconnected, and you still want to remove the consistency group on both clusters, you can issue the
rmrcconsistgrp command separately on both of the clusters.
If the consistency group is not empty, the -force parameter is required to delete the group. This removes
the relationships from the consistency group before the group is deleted. These relationships become
stand-alone relationships. The state of these relationships is not changed by the action of removing them
from the consistency group.
An invocation example
rmrcconsistgrp rctestone
rmrcrelationship
Use the rmrcrelationship command to delete an existing Metro Mirror or Global Mirror relationship.
394 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
rmrcrelationship rc_rel_id
-force rc_rel_name
Parameters
-force
(Optional) Specifies that the relationship should be deleted even if it results in the secondary volume
containing inconsistent data. This only applies to Global Mirror relationships using multi cycling
mode.
rc_rel_id | rc_rel_name
(Required) Specifies the ID or the name of the relationship.
Description
Deleting a relationship only deletes the logical relationship between the two virtual disks; it does not
affect the virtual disks themselves.
If the relationship is disconnected at the time that the command is issued, the relationship is only deleted
on the clustered system (system) where the command is being run. When the systems reconnect, the
relationship is automatically deleted on the other system. Alternatively, if the systems are disconnected
and if you still want to remove the relationship on both systems, you can issue the rmrcrelationship
command independently on both of the systems.
If Global Mirror relationship using multicycling mode, and you attempt to delete the relationship without
enabling access first, specifying rmrcrelationship might fail with an error because the relationship does
not currently have a fully consistent secondary volume. Specifying -force overrides this test. This is not
the default behavior, and you can quiesce and delete the relationship in order to use the secondary
volume's data immediately. If the map is still performing the background copy to migrate data from the
change volume to the secondary volume, the changed volume and associated FlashCopy mappings
remain defined when rmrcrelationship completes. The FlashCopy mappings are deleted after the
background copy completes, and the change volume becomes unusable again.
If you delete an inconsistent relationship, the secondary virtual disk becomes accessible even though it is
still inconsistent. This is the one case in which Metro or Global Mirror does not inhibit access to
inconsistent data.
An invocation example
rmrcrelationship rccopy1
startrcconsistgrp
Use the startrcconsistgrp command to start the Global or Metro Mirror consistency group copy process,
set the direction of copy if it is undefined, and optionally mark the secondary volumes of the consistency
group as clean.
rc_consist_group_id
rc_consist_group_name
Parameters
-primary master | aux
(Optional) Specifies the copy direction by defining whether the master or auxiliary disk becomes the
primary (source). This parameter is required when the primary is undefined if, for example, the
consistency group is in the Idling state.
-force
(Optional) Specifies that you want the system to process the copy operation even if it might lead to a
temporary loss of consistency while synchronization occurs. This parameter is required if the
consistency group is in the ConsistentStopped state, but is not synchronized or is in the idling state,
but is not synchronized.
-clean
(Optional) Specifies that the volume that is to become a secondary is clean for each of the
relationships belonging to the group; any changes made on the secondary volume are ignored, and
only changes made on the clean primary volume are considered during synchronization of the
primary and secondary disks. The consistency group must be in an Idling (connected) state for this
parameter to work.
Attention: This flag should only be used if all data changed on the secondary volumes while the
consistency group was in the idling state matches the state of the primary volumes when the
consistency group was stopped. Otherwise, relationships that are not consistent are reported as
consistent. Once this has been done there is no method to determine whether these volumes ever
reach a true consistent state until a full background copy can be carried out again.
rc_consist_group_id | rc_consist_group_name
(Required) Specifies the ID or name of the consistency group to start.
Description
This command starts a Global or Metro Mirror stand-alone consistency group. You cannot use this
command to start a remote copy relationship if the primary volume is a target volume of a prepared
FlashCopy mapping.
This command can only be issued to a consistency group that is connected. For a consistency group that
is idling, this command assigns a copy direction (primary and secondary roles) and begins the copy
process. Otherwise, this command restarts a previous copy process that was stopped either by a stop
command or by an I/O error.
If the resumption of the copy process leads to a period of time when the relationship is not consistent,
then you must specify the -force parameter when you restart the relationship. This situation can arise if
the relationship had been stopped and then further input transactions had been performed on the
original primary disk of the relationship. When you use the -force parameter in this situation, the data
on the secondary disk is not usable (because it is inconsistent) in a disaster recovery circumstance.
In the idling state, you must provide the -primary parameter. In other connected states, you can provide
the -primary parameter, but it must match the existing setting.
396 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The -force parameter is required if consistency would be lost by starting a copy operation. This can
occur if write operations on either primary or secondary volumes have taken place since the
ConsistentStopped or idling state occurred. If the command is issued without the -force parameter in
such circumstances, the command fails . In general, the -force parameter is required if the group is in
one of the following states:
v Consistent_Stopped but not synchronized (sync=out_of_sync)
v Idling but not synchronized
The -force parameter is not required if the group is in one of the following states:
v Inconsistent_Stopped
v Inconsistent_Copying
v Consistent_Synchronized
However, the command does not fail if you specify the -force parameter.
The -clean parameter is used when a Global or Metro Mirror group is started and the secondary
volumes in this group are assumed to be clean, which means that any changes that have been made at
the secondary are ignored and only changes made at the primary are considered when synchronizing the
primary and secondary volumes. The -clean parameter can be used in the following scenario:
1. A consistency group is created with the -sync parameter. At this point, it does not matter if the
primary and secondary contain the same data, even though the use of the -sync parameter implies
that this is true.
2. A stoprcconsistgrp command is issued with the -access parameter. This permits access to the
secondary disk. Change recording begins at the primary.
3. An image of the primary disk is copied and loaded on to the secondary disk. It is permissible to
allow updates to the primary disk during the image copy as this image can be only a fuzzy image of
the primary disk.
4. A startrcconsistgrp command that specifies the -primary master, -force, and -clean parameters is
issued. The auxiliary disk is marked as clean and changes on the master disk that have occurred since
the relationship was stopped are copied to the auxiliary disk.
5. Once the background copy has completed, relationships in the group become consistent and
synchronized.
| After restarting a consistency group in either of these states (Idling or multi), the data on the secondary
| volumes is not usable for disaster recovery until the consistency group becomes consistent.
| A Global Mirror consistency group with a cycling_mode of multi in either of these states does not require
| the -force parameter because consistent secondary images are retained. However, if such a consistency
| group is in idling state and written data has been received at any secondary volume in the consistency
| group, the -force flag is still required, because the secondary volumes have a divergent image that
| cannot represent a consistent earlier state.
After creating a background copy the relationship remains in copying state, waiting for the remainder of
the period time to expire before performing a new cycle. If the secondary change volume is deconfigured
when the background copy completes, the relationship stops as if there is no cycle period.
startrcrelationship
Use the startrcrelationship command to start the Metro Mirror or Global Mirror relationship copy
process, set the direction of copy if undefined, and (optionally) mark the secondary volume of the
relationship as clean. The relationship must be a stand-alone relationship.
Syntax
startrcrelationship
-primary master -force -clean
aux
rc_rel_id
rc_rel_name
Parameters
-primary master | aux
(Optional) Specifies the copy direction by defining whether the master or auxiliary disk becomes the
primary (source). This parameter is required when the primary is undefined if, for example, the
relationship is in the idling state.
-force
(Optional) Specifies that you want the system to process the copy operation even if it might lead to a
temporary loss of consistency while synchronization occurs. This parameter is required if the
relationship is in the ConsistenStoppes state, but is not synchronized or in the Idling state, but is not
synchronized.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
-clean
(Optional) Specifies that the volume that is to become a secondary is clean; any changes made on the
secondary volume are ignored, and only changes made on the clean primary volume are considered
when synchronizing the primary and secondary disks. The relationship must be in an Idling
(connected) state for this parameter to work.
Attention: This flag should only be used if all data changed on the secondary volumes while the
consistency group was in the idling state matches the state of the primary volumes when the
consistency group was stopped. Otherwise, relationships that are not consistent are reported as
consistent. Once this has been done there is no method to determine whether these volumes ever
reach a true consistent state until a full background copy can be carried out again.
rc_rel_id | rc_rel_name
(Required) Specifies the ID or name of the relationship that you want to start in a stand-alone
relationship.
Description
The startrcrelationship command starts a stand-alone relationship. The command fails if it is used to
start a relationship that is part of a consistency group.
398 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
This command can only be issued to a relationship that is connected. For a relationship that is idling, this
command assigns a copy direction (primary and secondary roles) and begins the copy process.
Otherwise, this command restarts a previous copy process that was stopped either by a stop command or
by some I/O error.
Note: A command in idling state is rejected if any of the indicated secondary volumes is the target of an
existing FlashCopy map.
In the idling state, you must provide the -primary parameter. In other connected states, you can provide
the -primary parameter, but it must match the existing setting.
The -force parameter is required if consistency would be lost by starting a copy operation. This can
occur if input transactions have occurred on either the primary or secondary volumes since the
ConsistentStopped or Idling state occurred. This happens when the relationship is in either of these
states:
v ConsistentStopped but not synchronized
v Idling but not synchronized
After restarting a relationship in either of these states, the data on the secondary volume is not usable for
disaster recovery until the relationship becomes consistent.
A Global Mirror relationship with a cycling_mode of multi in either of these states does not require the
-force parameter because a consistent secondary image is retained. However, if such a relationship is in
idling state and written data has been received at the secondary volume, the -force flag is still required,
because the secondary volume has a divergent image that cannot represent a consistent earlier state.
The -force parameter is not required if the relationship is in one of the following states:
v InconsistentStopped
v InconsistentCopying
v ConsistentSynchronized
However, the command does not fail if you specify the -force parameter.
After creating a background copy the relationship remains in copying state, waiting for the remainder of
the period time to expire before performing a new cycle. If the secondary change volume is deconfigured
when the background copy completes, the relationship stops as if there is no cycle period.
An invocation example
startrcrelationship rccopy1
Syntax
stoprcconsistgrp rc_consist_group_id
-access rc_consist_group_name
Parameters
-access
(Optional) Allows write access to consistent secondary volumes in the consistency group.
rc_consist_group_id | rc_consist_group_name
(Required) Specifies the ID or the name of the consistency group to stop all processing for.
Description
This command applies to a consistency group. You can issue this command to stop processing on a
consistency group that is copying from primary volumes to secondary volumes.
If the consistency group is in an inconsistent state, all copy operations stop and do not resume until you
issue the startrcconsistgrp command. When a consistency group is in a consistent state (for example, in
the consistent_stopped, consistent_synchronized, consistent_copying or consistent_disconnected
state) you can issue the access parameter with the stoprcconsistgrp command to enable write access to
the secondary virtual disks within that group. For a consistency group in the consistent_synchronized
state, this command causes a consistency freeze.
The consistent_copying state is a consistent state. A consistency group in this state transitions to
consistent_stopped state if it receives a stoprcconsistgrp command. Because the secondary change
volume holds the consistent image, a stopped consistent_copying relationship might not have its
secondary change volume deconfigured. This can be achieved by enabling access or completing
synchronization so the secondary disk contains a consistent image. A relationship in consistent_copying
or consistent_stopped accepts stoprcrelationship -access transition to idling state.
The consistent image that is present on the change volume is made accessible at the secondary volume
and after the command has completed the secondary volume can serve host read and write I/O. A
FlashCopy background copy operation begins to migrate the data for the consistent image from the
change volume to the secondary volume. While the background copy operation is in progress, the change
volume for the secondary volume remains in use. It may be necessary to process I/O before the reverse
FlashCopy map can be triggered, causing the enable access command to time out. In this case, the
relationship delays transitioning to idling until the reverse map starts and write access is available. Read
access to the consistent data remains available.
400 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 64. stoprcconsistgrp consistency group states (continued)
Initial state Final state Notes
inconsistent_copying inconsistent_stopped If access is specified, the command
is rejected with no effect and the
relationship remains in the
inconsistent_copying state.
consistent_stopped consistent_stopped If access is specified, the final state
is idling.
consistent_synchronized consistent_stopped If access is specified, the final state
is idling. If access is not specified,
the final state is
consistent_stopped.
consistent_copying consistent_stopped If access is specified, the final state
is idling. If access is not specified,
the final state is
consistent_stopped.
idling idling Remains in idling state whether
access is specified or not.
idling_disconnected unchanged If specified without access, the
relationship or group remains in
idling_disconnected state. If the
clustered systems reconnect, the
relationship/group is in either
inconsistent_stopped or
consistent_stopped state.
inconsistent_disconnected inconsistent_stopped The command is rejected, with or
without the access flag.
consistent_disconnected consistent_stopped The command is rejected if specified
without access. If specified with
access, the relationship or group
moves to idling_disconnected.
An invocation example
stoprcconsistgrp rccopy1
stoprcrelationship
Use the stoprcrelationship command to stop the copy process for a Metro Mirror or Global Mirror
stand-alone relationship. You can also use this command to enable write access to a consistent secondary
volume.
Syntax
stoprcrelationship rc_rel_id
-access rc_rel_name
Parameters
-access
(Optional) Specifies that the system allow write access to a consistent secondary volume.
Description
If the relationship is in an inconsistent state, any copy operation stops and does not resume until you
issue a startrcrelationship command. For a relationship in the consistent_synchronized state, this
command causes a consistency freeze.
The consistent image that is present on the change volume is made accessible at the secondary volume
and once the command has completed the secondary volume can serve host read and write I/O. A
FlashCopy background copy operation begins to migrate the data for the consistent image from the
change volume to the secondary volume. While the background copy operation is in progress, the change
volume for the secondary volume remains in use. As there might be I/O to process before the reverse
FlashCopy map might be triggered, the enable access command can time out. In this case, the
relationship delays transitioning to idling until the reverse map starts and write access is available. Read
access to the consistent data remains available.
Table 65. stoprcrelationship consistency group states
Initial state Final state Notes
inconsistent_stopped inconsistent_stopped If access is specified, the command
is rejected.
inconsistent_copying inconsistent_stopped If access is specified, the command
is rejected with no effect and the
relationship remains in the
inconsistent_copying state.
consistent_stopped consistent_stopped If access is specified, the final state
is idling.
consistent_synchronized consistent_stopped If access is specified, the final state
is idling. If access is not specified,
the final state is
consistent_stopped.
consistent_copying consistent_stopped If access is specified, the final state
is idling. If access is not specified,
the final state is
consistent_stopped.
idling idling Remains in idling state whether
access is specified or not.
402 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 65. stoprcrelationship consistency group states (continued)
Initial state Final state Notes
idling_disconnected unchanged If specified without access, the
relationship or group remains in
idling_disconnected state. If the
clustered systems reconnect, the
relationship or group is in either
inconsistent_stopped or
consistent_stopped state.
inconsistent_disconnected inconsistent_stopped The command is rejected, with or
without the access flag.
consistent_disconnected consistent_stopped The command is rejected if
specified without access. If
specified with access, the
relationship or group moves to
idling_disconnected state.
An invocation example
stoprcrelationship rccopy1
switchrcconsistgrp
Use the switchrcconsistgrp command to reverse the roles of the primary and secondary volumes in a
Metro Mirror or Global Mirror consistency group when that consistency group is in a consistent state. All
the relationships in the consistency group are affected by this change.
Syntax
switchrcconsistgrp -primary master rc_consist_group_id
aux rc_consist_group_name
Parameters
-primary master | aux
(Required) Specifies whether the master or auxiliary side of the relationships in the group will
become the primary volumes.
rc_consist_group_id | rc_consist_group_name
(Required) Specifies the ID or name of the consistency group to switch.
Description
This command applies to a consistency group. It is normally issued to reverse the roles of the primary
and secondary virtual disks in a consistency group, perhaps as part of a failover process that is associated
with a disaster recovery event. Write access to the former primary volumes is lost and write access to the
new primary volumes is acquired. This command is successful when the consistency group is in a
connected, consistent state, and when reversing the direction of the relationships would not lead to a loss
of consistency, for example, when the consistency group is consistent and synchronized. The consistency
group must be in one of the following states in order for the switchrcconsistgrp command to process
correctly:
v ConsistentSynchronized
An invocation example
switchrcconsistgrp -primary aux rccopy2
switchrcrelationship
Use the switchrcrelationship command to reverse the roles of primary and secondary virtual disks in a
stand-alone Metro Mirror or Global Mirror relationship when that relationship is in a consistent state.
Syntax
switchrcrelationship -primary master rc_rel_id
aux rc_rel_name
Parameters
-primary master | aux
(Required) Specifies whether the master disk or the auxiliary disk is to be the primary.
rc_rel_id | rc_rel_name
(Required) Specifies the ID or the name of the relationship to switch.
Description
Note: A command in idling state is rejected if any of the indicated secondary volumes is the target of
an existing FlashCopy map.
404 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The relationship moves to the ConsistentSynchronized state after the successful completion of this
command. If you specify the -primary parameter with the current primary, the command has no effect.
The switchrcrelationship command is rejected if you use Global Mirroring with the multi cycling mode.
An invocation example
switchrcrelationship -primary master rccopy2
lsmigrate
Use the lsmigrate command to display the progress of all current data migration operations.
Syntax
lsmigrate
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
If you use multiple threads to migrate data, the progress will increment when all threads have completed
the migration of an extent. For large extent sizes with many threads, this can result in quite large
increments in the percentage progress.
Description
This command displays information of all the migrations that are currently in progress.
Note: Only user-initiated migrations are reported using this command. Easy Tier migrations are not
included in the output.
An invocation example
lsmigrate -delim :
Syntax
migrateexts -source source_mdisk_id -target target_mdisk_id
source_mdisk_name target_mdisk_name
-exts number_of_extents
-threads number_of_threads -copy id
-vdisk vdisk_id
vdisk_name
Parameters
-source source_mdisk_id | source_mdisk_name
(Required) Specifies the MDisk on which the extents currently reside.
-target target_mdisk_id | target_mdisk_name
(Required) Specifies the MDisk to migrate the extents to.
-exts number_of_extents
(Required) Specifies the number of extents to migrate.
-threads number_of_threads
(Optional) Specifies the number of threads to use while migrating these extents. You can specify 1 - 4
threads. The default number of threads is 4.
-copy id
(Required if the specified VDisk (volume) has more than one copy) Specifies the volume copy that
the extents belong to.
-vdisk vdisk_id | vdisk_name
(Required) Specifies the volume that the extents belong to.
Description
This command migrates a given number of extents from the source virtual disk and the managed disk
that contains extents that are used to make up the virtual disk. The target is a managed disk within the
same managed disk group.
If a large number of extents are being migrated, you can specify 1 - 4 threads. You can issue the
lsmigrate command to check the progress of the migration.
The migrateexts command fails if there are insufficient free extents on the target managed disk. To avoid
this problem, do not issue new commands that use extents until the extents migration is completed.
The migrateexts command fails if the target or source volume is offline, or if Easy Tier is active for the
volume copy. Correct the offline condition before attempting to migrate the volume.
Note: Migration activity on a single managed disk is limited to a maximum of 4 concurrent operations.
This limit does not take into account whether the managed disk is the source or the destination target. If
more than four migrations are scheduled for a particular managed disk, further migration operations are
queued pending the completion of one of the currently running migrations. If a migration operation is
408 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
stopped for any reason, a queued migration task can be started. However, if a migration is suspended,
the current migration continues to use resources and a pending migration is not started. For example, the
following setup is a possible initial configuration:
v MDiskGrp 1 has volume 1 created in it
v MDiskGrp 2 has volume 2 created in it
v MDiskGrp 3 has only one MDisk
With the previous configuration, the following migration operations are started:
v Migration 1 migrates volume 1 from MDiskGrp 1 to MDiskGrp 3, running with 4 threads.
v Migration 2 migrates volume 2 from MDiskGrp 2 to MDiskGrp 3, running with 4 threads.
Due to the previous limitations, the two migration operations do not always run at the same speed.
MDiskGrp 3 has only one MDisk and the two migration operations have a total of 8 threads that are trying
to access the one MDisk. Four threads are active. The remaining threads are in standby mode waiting to
access the MDisk.
| Remember: This command cannot be used if the source MDisk is an SAS MDisk (which works in image
| mode only).
An invocation example
migrateexts -vdisk vdisk4 -source mdisk4 -exts
64 -target mdisk6 -threads 4
migratetoimage
Use the migratetoimage command to migrate data from a volume (image mode) onto a new image mode
volume copy. The target disk does not have to be in the same MDisk group (storage pool) as the source
disk.
Syntax
migratetoimage -vdisk source_vdisk_id
-copy id source_vdisk_name
-mdisk unmanaged_target_mdisk_id
-threads number_of_threads unmanaged_target_mdisk_name
-mdiskgrp managed_disk_group_id
-tier generic_ssd managed_disk_group_name
generic_hdd
Parameters
-vdisk source_vdisk_id | name
(Required) Specifies the name or ID of the source volume to be migrated.
-copy id
(Required if the specified volume has more than one copy) Specifies the volume copy to migrate
from.
-threads number_of_threads
(Optional) Specifies the number of threads to use during the migration of extents. You can specify 1 -
4 threads. The default number of threads is 4.
Description
The migratetoimage command migrates the data of a user-specified volume by consolidating its extents
(which might reside on one or more MDisks) onto the extents of the target MDisk that you specify. After
migration is complete, the volume is classified as an image type volume, and the corresponding mdisk is
classified as an image mode MDisk.
The managed disk that is specified as the target must be in an unmanaged state at the time that the
command is run. Running this command results in the inclusion of the MDisk into the user-specified
MDisk (storage pool) group.
The migratetoimage command fails if the target or source volume is offline. Correct the offline condition
before attempting to migrate the volume.
| Remember: This command cannot be used if the source MDisk is an SAS MDisk (which works in image
| mode only).
An invocation example
The following example specifies that the user wants to migrate the data from vdisk1 onto mdisk5 and that
the MDisk must be put into the MDisk group (storage pool) mdgrp2.
migratetoimage -vdisk vdisk1 -mdisk mdisk5 -tier generic_ssd -mdiskgrp mdgrp2
migratevdisk
Use the migratevdisk command to migrate an entire virtual disk from one managed disk group to
another managed disk group.
Syntax
migratevdisk -mdiskgrp mdisk_group_id
mdisk_group_name -threads number_of_threads
-vdisk vdisk_id
-copy id vdisk_name
Parameters
-mdiskgrp mdisk_group_id | mdisk_group_name
(Required) Specifies the new managed disk group ID or name.
410 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-threads number_of_threads
(Optional) Specifies the number of threads to use during the migration of these extents. You can
specify 1 - 4 threads. The default number of threads is 4.
-copy id
(Required if the specified volume has more than one copy) Specifies the VDisk (volume) copy to
migrate.
-vdisk vdisk_id | vdisk_name
(Required) Specifies the virtual disk ID or name to migrate in to a new managed disk group.
Description
The migratevdisk command migrates the specified virtual disk into a new managed disk group; all the
extents that make up the virtual disk are migrated onto free extents in the new managed disk group.
You can issue the lsmigrate command to view the progress of the migration.
The process can be prioritized by specifying the number of threads to use during the migration. Using
only one thread puts the least background load on the system.
The migratevdisk command fails if there are insufficient free extents on the targeted managed disk group
for the duration of the command. To avoid this problem, do not issue new commands that use extents
until the volume migration is completed.
The migratevdisk command fails if the target volume or source volume is offline. Correct the offline
condition before attempting to migrate the volume.
Remember:
v This command cannot be used on a volume owned by a filesystem.
| v This command cannot be used if the source MDisk is an SAS MDisk (which works in image mode
| only).
An invocation example
migratevdisk -vdisk 4 -mdiskgrp Group0 -threads 2
lscmdstatus
Use the lscmdstatus command to display the status of any currently running service-aid task.
Syntax
sainfo lscmdstatus
panel_name
Parameters
panel_name
The name of the panel. This command will fail if the panel_name ID is not in the list returned by
lsservicenodes.
Description
This command displays the status of any currently running service-aid task. If no task is running, then
the completion status of the last task will be displayed.
If no service-aid tasks have run since the node was last restarted, the command will return immediately
with no output. Otherwise, it will display something similar to example below.
An invocation example
lscmdstatus
lsfiles
Use the lsfiles command to display the files on the node that you want to retrieve with the satask
cpfiles command.
Syntax
sainfo lsfiles
-prefix path panel_name
Description
This command displays a list of the files on the node that you want to retrieve using the satask cpfiles
command.
An invocation example
sainfo lsfiles -prefix /dumps
lshardware
Use the lshardware command to view the configured and actual hardware configuration of a node in the
clustered system (system).
Syntax
sainfo lshardware
-delim delimiter panel_name
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
414 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
panel_name
(Optional) The node panel name.
Description
When the node is in a service state, use this command to view the current hardware configuration.
Table 66 provides the possible values that are applicable to the attributes that are displayed as data in the
output views.
Table 66. lshardware attribute values
Attribute Value
panel_name The node panel name.
node_id The node unique ID; blank if not in a system.
node_name The node name; blank if not in a system.
node_status The node status.
hardware The hardware model.
actual_different Indicates if the node hardware is different than the configured hardware.
actual_valid Indicates if the node hardware is valid.
memory_configured The configured amount of memory (in GB).
member_actual The currently installed amount of memory (in GB).
memory_valid Indicates if the actual memory is a valid configuration.
cpu_count The maximum number of CPUs for the node.
cpu_socket The ID of socket to which the CPU fields refer.
cpu_configured The configured CPU for this socket.
cpu_actual The currently installed CPU in this socket.
cpu_valid Indicates if the currently installed CPU is a valid configuration.
adapter_count The maximum number of adapters for the node (differs by node type).
adapter_location The location of this adapter.
adapter_configured The configured adapter for this location.
adapter_actual The currently installed adapter for this location.
adapter_valid Indicates if the adapter in this location is valid.
ports_different Indicates whether adapter ports can support more functions.
416 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
adapter_actual,1Gb/s Ethernet adapter
adapter_valid,yes
adapter_location,0
adapter_configured,1Gb/s Ethernet adapter
adapter_actual,1Gb/s Ethernet adapter
adapter_valid,yes
adapter_location,0
adapter_configured,Four port 8Gb/s FC adapter card
adapter_actual,Four port 8Gb/s FC adapter card
adapter_valid,yes
adapter_location,0
adapter_configured,High-speed SAS adapter
adapter_actual,High-speed SAS adapter
adapter_valid,yes
adapter_location,0
adapter_configured,Midplane bus adapter
adapter_actual,Midplane bus adapter
adapter_valid,yes
adapter_location,1
adapter_configured,Two port 10Gb/s ethernet adapter
adapter_actual,Two port 10Gb/s ethernet adapter
adapter_valid,yes
ports_different,no
lsservicenodes
Use the lsservicenodes command to displays a list of all the nodes that can be serviced using the service
assistant CLI.
Syntax
sainfo lsservicenodes
Parameters
None
Description
This command displays a list of all the nodes that can be serviced using the service assistant CLI. This
list includes nodes that at a code level of at least 6.2.0, are visible on the fabric, and are one of the
following:
v The partner node in a control enclosure to the node that is running the command.
v In the same clustered system as the node running the command.
v In candidate state.
v Not in a clustered system and in service state.
v Not in an enclosure with a stored clustered system ID (which is not the clustered system ID of the
local node).
Nodes not clustered with the local node will not be shown unless they are the partner node. Table 67
shows possible outputs.
Table 67. lsservicenodes outputs
Attribute Value
panel_name The front panel name, enclosure IDs, or canister IDs that identify the node.
cluster_id Blank if node is a candidate; otherwise, the value is determined from vpd_cluster.
An invocation example
sainfo lsservicenodes
lsservicerecommendation
Use the lsservicerecommendation command to determine what actions should be performed when
servicing a node.
Syntax
sainfo lsservicerecommendation
panel_name
Parameters
panel_name
(Optional) If no panel ID is provided, the service recommendation for the local node is returned. If a
panel_name from the list returned by lsservicenodes is specified, then the service recommendation
for that node is returned. The command will fail if the panel_name is not in the list returned by
lsservicenodes.
Description
This command enables you to determine what actions should be performed when servicing a node.
An invocation example
418 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
lsservicestatus
Use the lsservicestatus command to display the current status of a node.
Syntax
sainfo lsservicestatus
panel_name
Parameters
panel_name
(Optional) If a panel_name is provided, the service recommendation for the local node is returned. If a
panel_name from the list returned by lsservicenodes is specified, then the service recommendation
for that node is returned. The command fails if the panel_name ID is not in the list returned by
lsservicenodes. This output is returned as the node status on all Universal Serial Bus (USB) flash
drive commands.
Note: For 2145 nodes the panel name is a six digit number on the node front panel. For 2076 nodes
the panel name is the value of the enclosure ID and canister ID or the enclosure serial number and
canister location.
Description
Use this command to display the current status of a node. This command provides all the information
that can be obtained using the front panel of a SAN Volume Controller node. You can run this command
on any node, even one that is not part of a clustered system (system), to obtain the vital product data
(VPD) and error status.
420 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 68. lsservicestatus output (continued)
Attribute Value
product_serial The node serial number.
time_to_charge The estimated start time (in minutes) needed for 50% of the battery to be charged.
battery_charging The percentage of charge of the batteries.
disk_WWNN_prefix The most recently used WWNN prefix.
node_WWNN N/A
enclosure_WWNN_1 N/A
enclosure_WWNN_2 N/A
node_part_identity N/A
node_FRU_part N/A
enclosure_part_identity N/A
PSU_count N/A
PSU_id N/A
PSU_status N/A
battery_count N/A
battery_id N/A
battery_status N/A
| local_fc_port_mask Indicates the FC I/O ports that a system can use for node-to-node communications on a
| local system if those FC I/O ports exist on a node. The value is 64 binary bits.
| partner_fc_port_mask Indicates the FC I/O ports that a system can use for system-to-system communications on
| a partnered system if those FC I/O ports exist on a node. The value is 64 binary bits.
| cluster_topology Indicates the system topology (set using the chsystem command).
| site_id Indicates the site node value.
| site_name Indicates the site name.
Storwize® V7000, Flex V7000 Storage Node, Storwize V3500, and Storwize V3700: Table 69 shows
possible outputs.
Note: On a node that is not part of a system, some of the fields are blank or N/A.
Table 69. lsservicestatus output
Attribute Value
console_ip An Internet Proticol (IP) Version 4 or 6 address
Note: This field might be blank if the node is not present in a system.
has_nas_key yes | no
Note: This field might be blank if the node is not present in a system.
panel_name The front panel name, enclosure IDs, or canister IDs that identify the node.
system_id Specifies the ID of a system.
system_name Specifies the name of a system. When you use this parameter, the detailed view of the specific system is displayed and any
value that you specified by the -filtervalue parameter is ignored. If you do not specify the cluster_name parameter, the concise
view of all systems that match the filtering requirements that are specified by the -filtervalue parameter are displayed.
system_status The error code is the same as the one displayed on the front panel.
system_ip_count The maximum number of management addresses you can configure.
system_ip_port This, and fields down to prefix_6, are repeated for each management address.
system_ip The IPv4 management IP address.
system_gw The IPv4 management IP gateway.
system_mask The IPv4 management IP mask.
system_ip_6 The IPv6 management IP address.
system_gw_6 The IPv6 management IP gateway.
system_prefix_6 The IPv6 management IP prefix.
422 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Table 69. lsservicestatus output (continued)
Attribute Value
machine_part_number Blank.
node_machine_part Blank.
_number_copy
| local_fc_port_mask Indicates the Fibre Channel (FC) input/output (I/O) ports that a system can use for node-to-node communications on a local
| system if those FC I/O ports exist on a node. The value is 64 binary bits.
partner_fc_port_mask Indicates the FC I/O ports that a system can use for system-to-system communications on a partner system if those FC I/O
ports exist on a node. The value is 64 binary bits.
An invocation example
lsservicestatus
service_IP_address
service_gateway
service_subnet_mask
service_IP_address_6
service_gateway_6
service_prefix_6
service_IP_mode dhcpfallback
node_sw_version 6.4.0.0
node_sw_build 64.8.1205180000
cluster_sw_build 64.8.1205180000
node_error_count 0
fc_ports 4
port_id 1
port_status Active
port_speed 8Gb
port_WWPN 500507680140a22f
SFP_type Short-wave
port_id 2
port_status Active
port_speed 8Gb
port_WWPN 500507680130a22f
SFP_type Short-wave
port_id 3
port_status Active
port_speed 8Gb
port_WWPN 500507680110a22f
product_serial 75HAXYA
time_to_charge 0
battery_charging 0
dump_name 150434
node_WWNN 500507680100a22f
disk_WWNN_suffix 0A22F
panel_WWNN_suffix 0A22F
UPS_serial_number
UPS_status
enclosure_WWNN_1
enclosure_WWNN_2
node_part_identity
node_FRU_part
enclosure_identity
PSU_count
PSU_id
PSU_status
PSU_id
PSU_status
node_location_copy
node_product_mtm_copy
node_product_serial_copy
node_WWNN_1_copy
node_WWNN_2_copy
latest_cluster_id
next_cluster_id
console_IP 192.168.8.241:443
has_nas_key no
fc_io_ports 6
fc_io_port_id 1
fc_io_port_WWPN 500507680140a22f
fc_io_port_switch_WWPN 200000051e630f9a
fc_io_port_state Active
fc_io_port_FCF_MAC N/A
fc_io_port_vlanid N/A
fc_io_port_type FC
fc_io_port_type_port_id 1
424 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
fc_io_port_id 2
fc_io_port_WWPN 500507680130a22f
fc_io_port_switch_WWPN 200400051e630f9a
fc_io_port_state Active
fc_io_port_FCF_MAC N/A
fc_io_port_vlanid N/A
fc_io_port_type FC
fc_io_port_type_port_id 2
fc_io_port_id 3
fc_io_port_WWPN 500507680110a22f
fc_io_port_switch_WWPN 200000051e7ded49
fc_io_port_state Active
fc_io_port_FCF_MAC N/A
fc_io_port_vlanid N/A
fc_io_port_type FC
fc_io_port_type_port_id 3
fc_io_port_id 4
fc_io_port_WWPN 500507680120a22f
fc_io_port_switch_WWPN 200400051e7ded49
fc_io_port_state Active
fc_io_port_FCF_MAC N/A
fc_io_port_vlanid N/A
fc_io_port_type FC
fc_io_port_type_port_id 4
fc_io_port_id 5
fc_io_port_WWPN 500507680150a22f
fc_io_port_switch_WWPN 2064000573cd6201
fc_io_port_state Active
fc_io_port_FCF_MAC 00:05:73:CD:62:00
fc_io_port_vlanid 100
fc_io_port_type Ethernet
fc_io_port_type_port_id 3
fc_io_port_id 6
fc_io_port_WWPN 500507680160a22f
fc_io_port_switch_WWPN 2064000573c8a701
fc_io_port_state Active
fc_io_port_FCF_MAC 00:05:73:C8:A7:00
fc_io_port_vlanid 100
fc_io_port_type Ethernet
fc_io_port_type_port_id 4service_IP_mode
service_IP_mode_6
machine_part_number 2072S2C
node_machine_part_number_copy 2072L2C
| local_fc_port_mask:0000000000000000000000000000000000000000000000000000000000001101
| partner_fc_port_mask:0000000000000000000000000000000000000000000000000000000000000011
| cluster_topology stretched
| site_id 1
| site_name DataCenterA
applysoftware (Discontinued)
Attention: The svcservicemodetask applysoftware command is discontinued. Use the satask
installsoftware command instead.
Discontinued.
Discontinued.
Discontinued.
exit (Discontinued)
Attention: The svcservicemodetask exit command is discontinued. Use the satask stopservice
command instead.
ls2145dumps (Discontinued)
Attention: The svcservicemodeinfo ls2145dumps command is discontinued. Use the lsdumps command to
display a list of files in a particular dumps directory.
lscimomdumps (Discontinued)
Attention: The svcservicemodeinfo lscimomdumps command is discontinued. Use the lsdumps command
to display a list of files in a particular dumps directory.
lsclustervpd (Discontinued)
Attention: The svcservicemodeinfo lsclustervpd command is discontinued. Use the sainfo
lsservicestatus command instead.
lserrlogdumps (Discontinued)
Attention: The svcservicemodeinfo lserrlogdumps command is discontinued. Use the lsdumps command
to display a list of files in a particular dumps directory.
lsfeaturedumps (Discontinued)
Attention: The svcservicemodeinfo lsfeaturedumps command is discontinued. Use the lsdumps
command to display a list of files in a particular dumps directory.
lsiostatsdumps (Discontinued)
Attention: The svcservicemodeinfo lsiostatsdumps command is discontinued. Use the lsdumps
command to display a list of files in a particular dumps directory.
lsiotracedumps (Discontinued)
Attention: The svcservicemodeinfo lsiotracedumps command is discontinued. Use the lsdumps
command to display a list of files in a particular dumps directory.
lsmdiskdumps (Discontinued)
Attention: The svcservicemodeinfo lsmdiskdumps command is discontinued. Use the lsdumps command
to display a list of files in a particular dumps directory.
lssoftwaredumps (Discontinued)
Attention: The svcservicemodeinfo lssoftwaredumps command is discontinued. Use the lsdumps
command to display a list of files in a particular dumps directory.
Syntax
activatefeature
-trial feature_id licenskey key
feature_name
licensekeyfile filepath
Parameters
-trial feature_id | feature_name
(Optional) Activates the trial period for the feature of the specified ID using an unsigned 16-bit
integer:
v Valid integer values are 0, 1 and 3.
v Valid names are turbo_performance, easy_tier, and remote_mirroring.
-licensekey key
(Optional) Provides the license key to activate a feature consisting of 16 hexadecimal characters
organized in four groups of four numbers with each group separated by a hyphen (such as
0123-4567-89AB-CDEF).
-licensekeyfile filepath
(Optional) Provides the full path-to-file containing all required license information using an
alphanumeric string consisting of 1 to 256 characters.
Description
A license key file can contain one or more license keys. If you specify a key file, every key in the file is
applied to the system. The license key is checked against the control enclosure serial number and
machine type and model. If there are 0 values to report, the command cannot complete successfully on
the clustered system. If you cannot apply a key successfully to the system, the command adds any
remaining keys.
If a feature is already activated, and the you activate a feature again using a key, the command completes
successfully.
Remember:
v You cannot perform a trial when a feature is activated.
v You can activate a feature while a trial is in progress.
Syntax
deactivatefeature feature_id
feature_name
Parameters
feature_id | feature_name
(Required) Deactivates the feature (or feature trial). This is a unique ID or name using either one of
these two formats:
v Unsigned 16-bit integer
v Alphanumeric string using between 0 and 25 characters.
Description
An invocation example
deactivatefeature 1
chnodeled
Use the chnodeled command to turn on or off the location light-emitting diode (LED) for the specified
canister.
Syntax
satask chnodeled -on -battery slot panel_name
-off bootdrive
Parameters
satask
System Administrator task; service commands that are only used in specific circumstances.
-on | -off
(Required) Turns the location LED for the specified canister on or off.
| panel_name
| (Optional) Specifies a unique panel name used to apply the command to a valid node on the fabric.
432 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
Note: The location LED is mapped onto the physical LEDs using different methods, depending on your
hardware. Refer to the documentation for your hardware platform for more information.
chserviceip
Use the chserviceip command to set the service address for a specific node.
Syntax
Parameters
panel_name
(Optional) Identifies the node being serviced.
-serviceip
(Required) The IPv4 address for the service assistant.
Note: The IPv4 service address can be unconfigured by setting the address to 0.0.0.0.
-gw
(Optional) The IPv4 gateway for the service assistant.
-mask
(Optional) The IPv4 subnet for the service assistant.
-serviceip_6
(Required) The IPv6 address for the service assistant.
Note: The IPv6 service address can be unconfigured by setting the address to 0:0:0:0:0:0:0:0.
-gw_6
(Optional) The IPv6 gateway for the service assistant.
-prefix_6
(Optional) The IPv6 prefix for the service assistant.
-dhcp
(Optional) Attempts to obtain an IPv4 address from Dynamic Host Configuration Protocol (DHCP).
Storwize V7000:
-default
(Optional) Resets the IPv4 service address of a Storwize V7000 to the default address.
panel_name
(Optional) Identifies the node being serviced.
-serviceip
(Required) The IPv4 address for the service assistant.
Note: The IPv4 service address can be unconfigured by setting the address to 0.0.0.0.
-gw
(Optional) The IPv4 gateway for the service assistant.
-mask
(Optional) The IPv4 subnet for the service assistant.
-serviceip_6
(Required) The IPv6 address for the service assistant.
-gw_6
(Optional) The IPv6 gateway for the service assistant.
-prefix_6
(Optional) The IPv6 prefix for the service assistant.
-resetpassword
(Optional) Sets the service assistant password to default.
-dhcpfallback
(Optional) Establish a new service address (specifically IPv4) using DHCP, and allow error recovery
procedures.
Note: This parameter applies only to Flex System V7000 Storage Node.
Description
This command sets the service assistant IP address for a specific node. If the node is part of clustered
system (system) then the system gateway, subnet and prefix will be used unless specified otherwise. If
the node is a candidate node, the subnet, prefix and gateway must be specified. If you specify an IPV4 or
IPV6 address, but do not provide a gateway, mask, or prefix, then the existing gateway, mask, and prefix
values are preserved.
When -dhcpfallback is specified, the current service interface is restarted and the new service IPv4
address is established using DHCP. If the DHCP request fails, the service IP address is set statically based
on the node's physical location.
434 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Do not use the -dhcpfallback parameter for IPv6. These flags allocate a new address because the
command causes the service interface to restart.
Consequently, you can configure both an IPv4 and an IPv6 address concurrently. Setting the IPv4 address
does not change the IPv6 setting, and setting the IPv6 address will not change the IPv4 setting. It is
possible to clear any values set by setting the IPv4 address to 0.0.0.0 or leaving the IPv6 value empty.
Remember:
– If -gw is specified, -mask must also be specified.
– If -gw_6 is specified, -prefix_6 must also be specified.
An invocation example
satask chserviceip
chwwnn
Use the chwwnn command to modify the node World Wide Node Name (WWNN).
Syntax
satask chwwnn -wwnnsuffix wwnn_suffix
panel_name
Parameters
-wwnnsuffix
(Required) The suffix to be used for node wwnn.
panel_name
(Optional) Identifies the node being serviced.
Description
This command modifies the WWNN. Use the lsservicestatus command to view suggested WWNNs.
cpfiles
Use the cpfiles command to copy files from another node.
Syntax
satask cpfiles -prefix directory -source source_panel_name
file_filter
target_panel_name
Parameters
satask
System Administrator task; service commands that are only used in specific circumstances.
-prefix directory | file_filter
(Required) Specifies the directory, files, or directory and files to be retrieved. The path must exist in a
permitted listable directory. You can use the following -prefix filters:
v /dumps (retrieves all files in all subdirectories)
v /dumps/audit
v /dumps/cimom
v /dumps/configs
v /dumps/drive
v /dumps/elogs
v /dumps/enclosure
v /dumps/feature
v /dumps/iostats
v /dumps/iotrace
v /dumps/mdisk
v /dumps/syslogs
v /home/admin/upgrade
v /dumps/enclosure
Note:
v You can also specify a file filter. For example, if you specify /dumps/elogs/*.txt, all files in the
/dumps/elogs directory that end in .txt are copied.
v If you use a wildcard, the following rules apply:
1. The wildcard character is an asterisk (*).
2. The command can contain a maximum of one wildcard.
3. When you use a wildcard, you must surround the filter entry with double quotation marks
("x"). For example: satask cpfiles -prefix "/dumps/elogs/*.txt"
-source source_panel_name
(Required) Identifies the source node files will be copied from.
436 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
target_panel_name
(Optional) Identifies the node that files will be copied to. If no panel name is provided, the files will
be copied to the local node.
Description
This command copies files from another node. You can monitor the progress of the copy using the sainfo
lscmdstatus command.
help
Use the help (or man) command to display help information for system commands.
Syntax
help
man command_name
Parameters
command_name
(Optional) Indicates the command name.
Description
Use this command to display help information for system commands. If you specify a command name
using command_name, the complete help file text for the command is displayed. If you do not specify a
command name, a comprehensive list of all commands is displayed (with one brief descriptive line). This
list includes these commands:
v satask,
v sainfo
v svcconfig
v svc_snap
v svc_livedump
An invocation example
help
Syntax
Parameters
-file
(Required) The file name of code installation package.
Note: The argument to -file must be present on the local node; the argument is automatically
copied to the target panel_name.
-ignore
(Optional) Overrides prerequisite checking and forces installation of the code.
-pacedccu
(Optional) Causes the node to initiate a paced Concurrent Code Upgrade (in which you define when
the node begins its upgrade) instead of a normal Concurrent Code Upgrade (in which each node in
the clustered system automatically upgrades in sequence).
panel_name
(Optional) Identifies the node being serviced.
Description
An invocation example
satask installsoftware -file install_pkg.gpg nodeB_panel_name
leavecluster
Use the leavecluster command to remove clustered system (system) state data, location information, and
other history from a node.
Syntax
satask leavecluster -force
panel_name
Parameters
-force
(Required) The -force parameter is required because this service action can cause temporary or
permanent loss of access to data. Use this command only when a service procedure instructs you to
do so.
438 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
panel_name
(Optional) Identifies the node being serviced. The default is the node on which the command is
entered.
Description
Use this command to remove system state data, location information, and other history from a node.
An invocation example
satask leavecluster -force 78G00F3-2 /* this forces the node with panel_name=78G00F3-2 out of the clustered system */
An invocation example
satask leavecluster -force /* this forces the node on which the command is entered out of the clustered system*/
metadata
Use the metadata command to recover a virtualization table.
Syntax
satask metadata -rebuildcluster
-end end_arg
Parameters
satask
System Administrator task; service commands that are only used in specific circumstances.
-rebuildcluster
Creates a cluster from the metadata found in /dumps/t3_recovery.bin created by the -dump process.
-scan
Scan the specified MDisk or drive for system metadata.
-dump
Dump metadata from the specified MDisk or drive to file /dumps/t3_recovery.bin
-end end_arg
The last LBA in which to look for metadata on the disk.
Description
Use the “lscmdstatus” on page 413 command to see the status of the command.
An invocation example
satask metadata -scan -file scan.0.xml
-disk 600a0b80000f14ee0000008e4146bdee00000000000000000000000000000000 -start 0
mkcluster (satask)
Use the mkcluster command to create a new clustered system (system).
Syntax
satask mkcluster -clusterip -ipv4_ip
-name cluster_name panel_name
Parameters
-clusterip ipv4_ip
(Optional) The Internet Protocol Version 4 (IPv4) address for system Ethernet port 1.
-gw ipv4_gw
(Optional) The IPv4 gateway for system Ethernet port 1.
-mask ipv4_mask
(Optional) The IPv4 subnet for system Ethernet port 1.
-clusterip_6 ipv6_ip
(Optional) The Internet Protocol Version 6 (IPv6) address for system Ethernet port 1.
440 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-gw_6 ipv6_gw
(Optional) The IPv6 gateway for system Ethernet port 1.
-prefix_6 ipv6_subnet
(Optional) The IPv6 prefix for system Ethernet port 1.
-name cluster_name
(Optional) The name of the new system.
panel_name
(Optional) Identifies the node being serviced.
Description
mkcluster (Deprecated)
The mkcluster command is deprecated. Use the satask mkcluster command to create a new clustered
system (system).
Syntax
lsfeature
Parameters
None
Description
This table provides the attribute values that can be displayed as output view data.
Table 70. lsfeature outputs
Attribute Possible Values
id Indicates the unique ID (2-character) feature number.
An invocation example
lsfeature
| overridequorum (satask)
| Use the overridequorum command to invoke the manual override command.
| Syntax
| Parameters
| -force
| (Required) Overrides any quorum decision made by the system.
| Important: Using this option might result in a loss of access. If used incorrectly this results in
| different nodes in the system using different copies of mirrored volumes simultaneously. Only use
| this command for disaster recovery scenarios where all nodes at one site have been lost.
442 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
| Description
| This command invokes the manual override command. This command is valid on nodes that are in
| starting state with either of the following node errors:
| v 551
| v 921
| Remember: This command is only applicable when a system is configured as a stretched system by
| issuing the chsystem -topology command.
| An invocation example
| satask overridequorum
rescuenode
Use the rescuenode command to start automatic recovery for a specific node.
Syntax
satask rescuenode -force
-panel_name
Parameters
panel_name
(Optional) Identifies the node being serviced.
-force
The -force parameter is required because this service action can cause temporary or permanent loss
of access to data. Use this command only when the node reports corrupted system code (code).
Description
This command starts automatic recovery for a specific node. Use this command only when the node
reports corrupted code.
An invocation example
satask rescuenode -force 112233
resetpassword
Use the resetpassword command to reset the clustered system (system) superuser password to passw0rd.
Syntax
satask resetpassword
Description
This command resets the system superuser password to passw0rd. You are prompted for a new password
when you next log in to the graphical user interface (GUI).
An invocation example
satask resetpassword
restartservice
Use the restartservice command to restart a named service.
Syntax
satask restartservice -service service_name panel_name
Parameters
satask
System Administrator task; service commands that are only used in specific circumstances.
-service service_name
Specifies the name of the service that you want to restart. The following services are supported:
sshd
Secure Shell Daemon
slpd
Service Location Protocol Daemon
easy
Easy Tier
tomcat
Web server
cimom
CIMOM
panel_name
Identifies the node being serviced.
Description
When directed to do so by IBM support, use this command to restart a named service.
An invocation example
satask restartservice -service cimom
444 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
setlocale (satask)
Use the setlocale command to change the satask and sainfo command output to the chosen language
on the current node.
Syntax
satask setlocale -locale locale_id
Parameters
-locale locale_id
Specifies the locale ID.
Description
This command changes the language in which error messages are displayed as output from the
command-line interface. Subsequently, all error messages from the command-line tools are generated in
the chosen language. This command is run when you request a change of language (locale) and is
generally run from the web page. Issue the satask setlocale command to change the locale setting for
the system; all interface output is changed to the chosen language. For example, to change the language
to Japanese, type the following:
where 3 is the value for Japanese. The following values are supported:
v 0 US English (default)
v 1 Simplified Chinese
v 2 Traditional Chinese
v 3 Japanese
v 4 French
v 5 German
v 6 Italian
v 7 Spanish
v 8 Korean
v 9 Portuguese (Brazilian)
Note: This command does not change the front panel display panel settings.
Syntax
satask setpacedccu
panel_name
Parameters
panel_name
(Optional) Identifies the node being serviced.
Description
Use this command to flag a node to participate in a user-paced concurrent code upgrade. This command
can only be used when the node is:
v In a service state
v Error-free
v Not part of a cluster when the node is out of a service state
An invocation example
setpacedccu
settempsshkey
Use the settempsshkey command to install a temporary Secure Shell (SSH) key for a superuser ID to run
commands in the service assistant CLI.
Syntax
satask settempsshkey -keyfile filename
-panel_name
Parameters
-keyfile filename
Specifies the name of the file that contains the Secure Shell (SSH) public key. The file identified by
filename must be on the local node (or on the USB flash drive, if you execute the command from
there).
panel_name
(Optional) Identifies the node being serviced.
Description
This command installs a temporary SSH key for a superuser ID to run commands in the service assistant
CLI (for example, to copy files to or from the node).
446 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
You can only perform this command when performing a service action. Installing a temporary key will
replace any available existing keys. The key will be deleted when the node joins a cluster or is rebooted
or power cycled.
An invocation example
settempsshkey
snap
Use the snap command to create a snap file on the node that you specify.
Syntax
satask snap
-dump -noimm panel_name
Parameters
-dump
(Optional) Collects the existing dump.
-noimm
(Optional) Disables Integrated Management Module (IMM) First Failure Data Capture (FFDC)
initiation and collection.
panel_name
(Optional) Identifies the node being serviced.
Description
This command creates a snap file on the node that you specify.
An invocation example
snap
Important: The name of the output file (placed on the specified node) is
snap.single.nodeid.date.time.tgz.
An invocation example
snap -noimm
startservice
Use the startservice command to enter a service state.
Parameters
satask
System Administrator task; service commands that are only used in specific circumstances.
-force
(Optional) Overrides checking of clustered system (system) membership.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
panel_name
(Optional) Identifies the node being serviced.
Description
This command enters a service state. For example, you might use a service state to remove a node from
the candidate list, or to prevent it from automatically being added to a system again. The -force flag is
required if the action could interrupt I/O (last node in cluster or IO group). This commands holds the
node in service state until it is cleared using the satask stopservice command, or until the I/O process
is restarted.
An invocation example
satask startservice
stopnode
Use the stopnode command to power off, reboot, or warmstart a node.
Syntax
satask stopnode -poweroff
-reboot panel_name
-warmstart
Parameters
-poweroff
(Required) Powers off the node.
-reboot
(Required) Reboots the node.
Attention: To use the -reboot parameter, you should first be in service state. To enter service state,
issue the satask startservice command. After the reboot completes, you can exit from service state.
-warmstart
(Required) Restarts the I/O process and issues a diagnostic dump.
448 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
panel_name
(Optional) Identifies the node being serviced.
Description
Use this command to power off a node, reboot a node, or restart the I/O process.
stopservice
Use the stopservice command to exit a service state.
Syntax
satask stopservice
-panel_name
Parameters
panel_name
(Optional) Identifies the node being serviced.
Description
This command exits service state entered using the startservice command, and exits the service state on
the local node.
An invocation example
satask stopservice
t3recovery
Use the t3recovery command to prepare and start a T3 recovery.
Syntax
satask t3recovery -prepare
-execute panel_name
Parameters
panel_name
(Optional) Identifies the node being serviced.
-prepare
(Required) Search for T3 recovery data. This locates the date of the necessary backup file and quorum
disk.
Description
Important: Progress of a T3 recovery can be displayed using the sainfo lscmdstatus command.
An invocation example
satask t3recovery -prepare
An invocation example
satask t3recovery -execute
450 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Chapter 27. Tracing commands
Tracing commands capture information that can assist you with troubleshooting managed disks and
virtual disks (volumes).
setdisktrace
Use the setdisktrace command to set a list of disks of a given type, to include in a disk trace.
Syntax
setdisktrace -type mdisk -set -all
vdisk -reset -objectid -id
name_list
Parameters
-type mdisk | vdisk
(Required) Specifies the object type for the disks.
-set
(Optional) Specifies the set argument. You cannot use the -set parameter with the -reset parameter.
-reset
(Optional) Specifies the reset argument. You cannot use the -set parameter with the -reset
parameter.
-all
(Optional) Traces all disks of the specified type. You cannot use the -all parameter with the
-objectid parameter.
-objectid id | name_list
(Optional) Specifies a list of one or more disk IDs or names. You cannot use the -objectid parameter
with the -all parameter.
Description
The setdisktrace command marks the disks to be included in the next triggered trace.
The command is used with the settrace command, which sets the options that result in a trace file and
the data that is included in the trace file.
An invocation example
setdisktrace -type mdisk -objectid
mdisk1:mdisk3:mdisk11:mdisk10:mdisk9:mdisk5 -reset
settrace
Use the settrace command to set options to trace certain I/O operations through the system.
-timestamp -data -tag -detect -init
-percent percentage -cmdlist cmd_list
-cmdmask cmd_mask
-skcqlist skcq_list
-skcqmask skcq_mask
-abort -timestamp -data -sense -cmds
-percent percentage -cmdlist cmd_list
-cmdmask cmd_mask
-skcqlist skcq_list
-skcqmask skcq_mask
Parameters
-type mdisk | vdisk
(Required) Specifies the type of objects to trace.
-file filename
(Required) Specifies the file name prefix for the trace file.
-trigger full | status | command | timeout | trigger | abort
(Required) Specifies an action for when the trace is started (triggered).
full Specifies to stop the trace when the trace buffer is full, for MDisks and VDisks (volumes).
status Sets a trigger for when the specified SCSI status (-skcqlist) is reported in sense data, for
MDisks and volumes.
command
Specifies a trigger for when the given SCSI command (-cmdlist) is sent, for MDisks and
volumes.
timeout
Sets a trigger for when a timeout occurs, for MDisks only.
trigger
Specifies to keep running until the trigger event, for MDisks only.
452 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
abort Sets a trigger for when an abnormal end occurs, for volumes only.
-abort
(Optional) Adds abnormal ending details to the trace, for volumes only.
-timestamp
(Optional) Adds a time-stamp to each entry in the trace. A file name is created from the prefix plus a
time-stamp. The file name is in the form prefix, where AAAAAA is the panel name of the node
generating the trace file.
-data
(Optional) Adds I/O data to the trace.
-tag
(Optional) Adds CCB tags to the trace, for MDisks only.
-detect
(Optional) Adds MDisk discovery details to the trace, for MDisks only.
-init
(Optional) Adds MDisk initialization details to the trace, for MDisks only.
-sense
(Optional) Adds SCSI sense data to the trace, for volumes only.
-cmds
(Optional) Adds commands data to the trace, for volumes only.
-percent percentage
(Optional) Specifies the trigger point in the trace file, which determines the amount of data to collect
after the trigger point. The default value is 50, which places the trigger point in the middle of the
trace file.
-cmdlist cmd_list
(Optional) Adds the commands in the cmd_list to the trace file.
-cmdmask cmd_mask
(Optional) Adds the commands in the cmd_mask to the trace file. The -cmdmask parameter must be
used with the -cmdlist.
-skcqlist skcq_list
(Optional) Specifies an SKCQ list, which adds only those SKCQ details to the trace file.
-skcqmask skcq_mask
(Optional) Specifies an SKCQ mask, which adds only those SKCQ details to the trace file. The
-skcqmask parameter must be used with the -skcqlist
Description
The settrace command sets the various I/O tracing options for managed disks or virtual disks. When the
relevant disk type trace is subsequently triggered, the options specify the data to be included in the trace
file.
The file name specifies a file name prefix to use when you are generating a trace file. The system
appends the node panel name and a timestamp to the file name.
A maximum of 10 trace files are kept on the clustered system (system). When the eleventh trace is made,
the oldest existing trace file is overwritten.
The directory can also hold files that are retrieved from other nodes. These files are not counted. The
system deletes the oldest file to maintain the maximum number of files.
starttrace
Use the starttrace command to begin tracing I/O operations that are based on the option currently set
for the specified object type and the list of disks to trace.
Syntax
starttrace -type mdisk
vdisk
Parameters
-type mdisk | vdisk
(Required) Specifies the object type to trigger.
Description
This command starts the collection of I/O tracing information. The trace file is generated according to the
options that you specified in the settrace command. The disks that are traced are those that are
identified in the list that is set by the setdisktrace command.
The traces are written to the /dumps/iotrace directory. You can view the contents of this directory using
the lsiotracedumps command.
An invocation example
starttrace -type vdisk
stoptrace
Use the stoptrace command to stop tracing operations for the specified disk type.
Syntax
stoptrace -type mdisk
vdisk
Parameters
-type mdisk | vdisk
(Required) Specifies the object type to stop tracing.
Description
This command stops the tracing of I/O operations for the specified object type.
454 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
stoptrace -type mdisk
chauthservice
Use the chauthservice command to configure the remote authentication service of the clustered system
(system).
Syntax
chauthservice
-enable yes -type tip -url url
no ldap
-username user_name -password -sslcert file_name
password
-refresh
Parameters
-enable yes | no
(Optional) Enables or disables the SAN Volume Controller system's use of the remote authentication
server. When the enable parameter is set to no, remote authentications are failed by the system, but
local authentications continue to operate normally.
-type tip | ldap
(Optional) Specifies the authentication service type (TIP or native LDAP). Before changing -type,
ensure that the remote authentication type selected is properly configured.
Remember:
v The remote authentication service must be enabled (-enable yes) for this setting to come into
effect.
v Before changing -type from ldap to tip, ensure that all users configured for remote authentication
have both an SSH key and password configured.
-url url
(Optional - Tivoli Integrated Portal only) Specifies the website address (URL) of the Tivoli Integrated
Portal (TIP). The host part of the URL must be a valid numeric IPv4 or IPv6 network address. You
can use the following characters in the URL:
v a - z
v A - Z
v 0 - 9
v _
v ~
v :
v [
Note: If you clear the cache, anyone using the system might have to log in again (for example, if
credentials are provided to one of the defined LDAP servers).
Description
This command can be used to select and enable a remote authentication service for use with the system.
The system can be configured to authenticate users against Tivoli Integrated Portal (TIP) or using
Lightweight Directory Access Protocol (LDAP).
Before enabling remote authentication, ensure that the properties of the service are properly configured
on the system. It is not necessary to disable the remote authentication service to change its properties.
This command can be used to configure the TIP properties. LDAP authentication can be configured using
the chldap command, and LDAP servers can be added to the system using the mkldapserver command.
Remember: For the authentication type to be set to LDAP with authorization enabled (true), an LDAP
server must be configured. For authentication type to be set to TIP with authorization enabled (true), the
TIP settings (URL, user name, password) must be configured.
To disable the remote authentication service in a controlled manner when it is not available, use the
enable parameter with the no option.
When the authentication service is enabled or the configuration is changed, the system does not test
whether the remote authentication system is operating correctly.
v To establish whether the system is operating correctly, issue the lscurrentuser command for a
remotely authenticated user. If the output lists the user roles obtained from the remote authentication
server, remote authentication is operating successfully. If the output is an error message, remote
authentication is not working correctly, and the error message describes the problem.
458 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v To establish whether LDAP is operating correctly, in addition to the lscurrentuser command, issue the
testldapserver command. The testldapserver command can be issued whether or not remote
authentication is enabled, and can be used to test the connection to LDAP servers, as well as user
authorization and authentication.
The website address in the TIP url parameter can have either of the following formats:
v http://network_address:http remote authentication service port number/path_to_service
v https://network_address:https remote authentication service port number/path_to_service
The network address must be an IPv4 or IPv6 address. Do not use the corresponding host name.
For example, if the system network IPv4 address is 9.71.45.108, you could enter either of the following
corresponding addresses:
http://9.71.45.108:16310/TokenService/services/Trust
https://9.71.45.108:16311/TokenService/services/Trust
An invocation example
An invocation example
To disable remote authentication:
chauthservice -enable no
An invocation example
An invocation example
chcurrentuser
Use the chcurrentuser command to change the attributes of the current user.
Parameters
-password cleartext_password
(Optional) Specifies the new password to be associated with the current user. The password cannot
start or end with a blank. It must consist of a string of 6 - 64 printable ASCII characters. You can
optionally specify the password with the password parameter. If you do not specify the password, the
system prompts you for it before running the command and does not display the password that you
type. Either the password parameter or the nopassword parameter can be set.
-nopassword
(Optional) Specifies that the user's password is to be deleted.
-keyfile sshkey_filename
(Optional) Specifies the name of the file that contains the Secure Shell (SSH) public key. Either the
keyfile parameter or the nokey parameter can be set.
-nokey
(Optional) Specifies that the user's SSH key is to be deleted.
Description
Use the chcurrent user command to modify the attributes of the current user.
An invocation example
chcurrentuser -password secret -nokey
chldap
Use the chldap command to change system-wide Lightweight Directory Access Protocol (LDAP)
configuration. This command can be used to configure remote authentication with LDAP. These settings
apply when authenticating against any of the LDAP servers configured using the mkldapserver
command.
Syntax
chldap
-type
ad
itds
other
-reset
460 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-username username -security tls
-password none
password
-encpassword
password
-userattribute user_attribute -groupattribute group_attribute
-auditlogattribute auditlogattribute -nestedgroupsearch client
server
off
Parameters
-type ad |itds|other | -reset
(Optional) Specify the LDAP server type, or reset LDAP configuration to defaults for the current
server type. Defaults for the configured server type:
v Active Directory (AD)
v IBM Tivoli Directory Server (ITDS)
v Other
-username username
(Optional) Specifies a username for administrative binding. This can be:
Note:
v A distinguished name (DN)
v A user principal name (UPN) or NT login name for Active Directory
-password password
(Optional) Specifies the password for the administrative binding. You can optionally specify the
password with this parameter. If you do not specify the password, the system prompts you for it
before running the command and does not display the password that you type.
-encpassword password
(Optional) Specifies the password for the enclosure. You can optionally specify the password with this
parameter. If you do not specify the password, the system prompts you for it before running the
command and does not display the password that you type.
-security tls | none
(Optional) Specifies the type of security to use when communicating with LDAP servers.
-userattribute user_attribute
(Optional) Specifies the LDAP attribute used to determine the user name of remote users. The user
attribute must exist in your LDAP schema and must be unique for each of your users.
-groupattribute group_attribute
(Optional) Specifies the LDAP attribute used to determine the group memberships of remote users.
The attribute must contain either the DN of a group or a colon-separated list of group names.
-auditlogattribute auditlogattribute
(Optional) Specifies the LDAP attribute used to determine the identity of remote users. When a user
performs an audited action, this information is recorded in the audit.
-authcacheminutes auth_cache_minutes
(Optional) Specifies the period for which to cache authentication details.
Description
The chldap command can be run whether or not LDAP authentication is enabled. Specifying -reset or
-type populates the default values unless otherwise specified.
The -type parameter values are only set to defaults for the specified type if the type is different from the
existing type.
If the type is itds, -nestedgroupsearch cannot be executed (nested groups are evaluated by default). If
the type is ad, -nestedgroupsearch can only be set to client or off because there is no server support. If
the type is other, the -nestedgroupsearch parameter is fully configurable.
Use -username to specify a distinguished name (DN), user principal name (UPN), or NT login name.
Distinguished names (DN) must be a sequence of attribute=value pairs separated by a comma (,),
semi-colon(;), or plus sign (+). A backslash (\,) should be used to escape special characters, and can also
be used to specify UTF-8 characters using their byte encoding. For example, c acute can be represented as
\C4\87. NT logins are valid for only the Active Directory and should be in the DOMAIN\user format. These
logins must not start or end with a period (.) and both the DOMAIN and the user should not use the
following characters: \/:?"<>| UPN logins are valid for Active Directory only and should be in the
format user@suffix. Both user and suffix not use spaces or the following characters: ()<>,;:\"[]@
Tip:
v Remember that -userattribute, -groupattribute, and -auditlogattribute accept values that:
1. Must begin with a letter
2. Only contain ASCII letters, digit characters, and hyphens
3. Are case-insensitive
The following LDAP (first-time) configuration suggestions assist with LDAP server setup:
Important:
v Ensure that the system is configured appropriately according to your LDAP schema. Issue chldap
-type to populate the system's LDAP configuration with the server type defaults. Issue chldap -reset
to return to these defaults at any time.
– (Advanced) For all server types, users are authenticated with a username configured in the LDAP
attribute user_attribute. This attribute must exist in the LDAP schema and must be unique for
each user. It is configurable by issuing chldap -userattribute. Active Directory users can also
authenticate using their UPN or NT login names.
– (Advanced) Authenticated users are assigned roles according to their LDAP group memberships.
Each user's group memberships must be stored in the LDAP attribute group_attribute. This can be
either an LDAP attribute containing the DN of the user's LDAP group, or an LDAP attribute
containing a colon-separated list of user group names. It is configurable by issuing chldap
-groupattribute.
– (Advanced) When an LDAP authenticated user runs a command that is audited, the user's login
name is placed in the audit log. The name is extracted from the LDAP attribute
audit_log_attribute, which is configurable by issuing chldap -auditlogattribute.
462 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v Ensure that the system is able to search within the user and group trees on LDAP servers. By default
the system authenticates anonymously. Consequently, you must either permit anonymous searches of
the LDAP directory, or create an LDAP user with the appropriate permissions and issue the chldap
-username and chldap -password commands to instruct the system to search as this user.
v Ensure that the system is able to connect with the appropriate level of security. Passwords are sent to
the LDAP server as clear text, so Transport Layer Security (TLS) encryption is recommended. Issue
chldap -security to change the security level.
v (Advanced): On Active Directory and some other LDAP servers, the system (by default) identifies
groups to which users belong directly. To assign users permissions according to a parent group, enable
the nested group search on the client by issuing chldap -nestedgroupsearch. This setting has an
additional performance overhead and supports up to 8 levels of nesting.
An invocation example
chldap -type
itds -username uid=joebloggs,cn=admins,dc=company,dc=com -password passw0rd
-auditlogattribute descriptiveName
chldapserver
Use the chldapserver command to modify a Lightweight Directory Access Protocol (LDAP) server.
Syntax
chldapserver
-ip ip_address -name server_name -port port
-sslcert file_name -basedn base_dn -preferred yes
-nosslcert -nobasedn no
ldap_server_id
ldap_server_name
Parameters
-ip ip_address
(Optional) Specifies the server IP address (Internet Protocol Version 4 or 6).
-name server_name
(Optional) Specifies the LDAP server name.
-port port
(Optional) Specifies the LDAP server port.
-sslcert file_name | -nosslcert
(Optional) Set (-sslcert) or clear (-nosslcert) the secure socket layer (SSL) certificate.
-basedn base_dn | -nobasedn
(Optional) Use the base distinguished name (DN) for search (-nobasedn indicates to use the default
DN).
-preferred yes | no
(Optional) Specifies whether the server is preferred over other configured LDAP servers (or not
preferred).
Description
Important: During normal operation, LDAP requests are sent to -preferred servers depending on
availability. If no servers are marked as -preferred, LDAP requests are sent to configured servers based
on availability.
If -sslcert is specified, the server certificate is verified while authenticating. The SSL certificate must
exist on the current node. If -nosslcert is specified, any certificate file is deleted and the server certificate
is not checked.
The -basedn parameter indicates the distinguished name (DN) to use as a base from which to search for
users in the LDAP directory. If Transport Layer Security (TLS) is enabled and -sslcert is specified, the
server certificate is verified during authentication. The secure socket layer (SSL) certificate must exist on
the node being used. Otherwise, a server certificate is not checked.
The clustered system (system) must be configured with an appropriate version IP address when -ip is
specified. The IP address specified with the -ip parameter must be of a version supported by the system.
The certificate file must be in valid privacy enhanced mail (PEM) format and have a maximum length of
4096 bytes.
Remember: There can be a maximum of six configured LDAP servers. If you attempt to create a seventh
LDAP server an error is returned.
chuser
Use the chuser command to change the attributes of an existing user.
464 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
chuser
-password -keyfile sshkey_filename
cleartext_password -nokey
-nopassword
user_id_or_name
-remote yes -usergrp group_id_or_name
no
Parameters
-password cleartext_password
(Optional) Specifies the new password to be associated with the user. The password cannot start or
end with a blank. It must consist of a string of 6 - 64 printable ASCII characters. You can optionally
specify the password with the password parameter. If you do not specify the password, the system
prompts you for it before running the command and does not display the password that you type.
Either the password parameter or the nopassword parameter can be set.
-nopassword
(Optional) Specifies that the user's password is to be deleted.
-keyfile sshkey_filename
(Optional) Specifies the name of the file that contains the Secure Shell (SSH) public key. Either the
keyfile parameter or the nokey parameter can be set.
-nokey
(Optional) Specifies that the user's SSH key is to be deleted.
-remote yes | no
(Optional) Specifies whether the user authenticates to the cluster using a remote authentication
service. Either yes or no must be set.
-usergrp group_id_or_name
(Optional) Specifies the new group for the user.
user_id_or_name
(Required) Specifies the user whose attributes are to be changed.
Description
You must have the Security Administrator role to create, delete, or change a user.
Only use the usergrp parameter for local users. If you change a user from local to remote, the user's
association with any group is removed.
If you change a user from remote to local, a user group must be specified. If you change a user from
local to remote, the user must have both a password and an SSH key.
If you use the keyfile parameter, the SSH key file should be placed in the /tmp directory before running
this command. When you run the command, the SSH key is copied into cluster state and activated for
the user, and the input file is deleted.
chusergrp
Use the chusergrp command to change the attributes of an existing user group.
Syntax
chusergrp group_id
-role role_name -remote yes group_name
no
Parameters
-role role_name
(Optional) Specifies the role to be associated with users that belong to this group. One of the
following roles must be selected: Monitor, CopyOperator, Service, Administrator, or SecurityAdmin.
-remote yes | no
(Optional) Specifies whether this user group should be used to set the role of remote users. Either the
yes or no option must be set.
group_id | group_name
(Required) The ID or name of the user group whose attributes are to be changed.
Description
Use the chusergrp command to modify the attributes of an existing user group.
You must have the Security Administrator role to create, delete, or change a user.
An invocation example
chusergrp -role Administrator admin
getstatus
Use the getstatus command to determine the current service state of the node canister.
Attention: Run this command only when instructed by the IBM Support Center. Running this command
before consulting IBM can affect your I/O operations.
Syntax
sainfo getstatus
466 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
Description
This command writes the output from each node to the USB flash drive.
This command calls the sainfo lsservicenodes command, the sainfo lsservicestatus command, and
the sainfo lsservicerecommendation command.
lscurrentuser
Use the lscurrentuser command to display the name and role of the logged-in user.
Syntax
lscurrentuser
-nohdr -delim delimiter
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays the name and role of the current user.
An invocation example
lscurrentuser
lsldap
Use the lsldap command to display the details for the system-wide Lightweight Directory Access
Protocol (LDAP) configuration.
Parameters
-delim delimiter
(Optional) By default, in a concise view all columns of data are space-separated, with the width of
each column set to the maximum possible width of each item of data. In a detailed view, each item of
data is an individual row, and if displaying headers, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. Enter -delim : on the command line, and the colon character (:) separates all
items of data in a concise view (for example, the spacing of columns does not occur); in a detailed
view, the specified delimiter separates the data from its header
Description
Table 71 provides the attribute values that can be displayed as output view data.
Table 71. lsldap attribute values
Attribute Value
type LDAP server type:
v Active Directory: ad
v IBM Tivoli Directory Server: itds
v Other: other
enabled Is native LDAP authentication enabled?
error_sequence_number Sequence number of non-fixed LDAP configuration error log
username Binding username or distinguished name (or blank if there is none)
security Type of security in use:
v Transport Layer Security: tls
v No security: none
user_attribute LDAP attribute representing user login
group_attribute LDAP attribute representing user group membership
audit_log_attribute LDAP attribute representing user name in audit log
auth_cache_minutes Period (in minutes) for which to cache session details
nested_group_search Handling of nested groups:
v No nested group handling: off
v Search nested groups on the client: client
v Search nested groups on the server: server
An invocation example
lsldap -delim :
468 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
user_attribute:sAMAccountName
group_attribute:memberOf
audit_log_attribute:userPrincipalName
auth_cache_minutes:10
nested_group_search:off
lsldapserver
Use the lsldapserver command to display the most recent details for all configured Lightweight
Directory Access Protocol (LDAP) servers.
Syntax
lsldapserver
ldap_server_id -delim delimiter
ldap_server_name
Parameters
ldap_server_id | ldap_server_name
(Optional) Specifies the ID or name for LDAP server being used.
-delim delimiter
(Optional) By default, in a concise view all columns of data are space-separated, with the width of
each column set to the maximum possible width of each item of data. In a detailed view, each item of
data is an individual row, and if displaying headers, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. Enter -delim : on the command line, and the colon character (:) separates all
items of data in a concise view (for example, the spacing of columns does not occur); in a detailed
view, the specified delimiter separates the data from its header
Description
Remember:
v The base distinguished name (DN) is located at the end of the concise view information; other fields
must be added before the base DN.
v The command fails if a server is specified that does not exist.
Table 72 provides the attribute values that can be displayed as output view data.
Table 72. lsldapserver attribute values
Attribute Value
id ID of the LDAP server
name Name of the LDAP server
error_sequence_number Sequence number of non-fixed LDAP server error log
IP address IP address of the LDAP server (Internet Protocol Versions 4 and 6)
port LDAP server port
cert_set Certificate setting (Is a certificate configured?)
preferred Server preference (Is this server preferred?)
base_dn Base distinguished name used in LDAP searches
This command displays details for the configured Lightweight Directory Access Protocol (LDAP) servers.
mkldapserver
Use the mkldapserver command to display the data used to create a Lightweight Directory Access
Protocol (LDAP) server.
Syntax
mkldapserver -ip ip_address
-name server_name -port port
-sslcert file_name -basedn base_dn -preferred
Parameters
-ip ip_address
(Required) Specifies the server IP address (Internet Protocol Version 4 or 6).
-name server_name
(Optional) Specifies the LDAP server name.
-port port
(Optional) Specifies the LDAP server port.
-sslcert file_name
(Optional) Set the SSL certificate.
-basedn base_dn
(Optional) Use the base distinguished name for search.
470 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-preferred
(Optional) Specifies that this server is preferred over other configured LDAP servers.
Description
Important: During normal operation, LDAP requests are sent to -preferred servers depending on
availability. If no servers are marked as -preferred, LDAP requests are sent to configured servers based
on availability.
The -basedn parameter indicates the distinguished name (DN) to use as a base from which to search for
users in the LDAP directory. If Transport Layer Security (TLS) is enabled and -sslcert is specified, the
server certificate is verified during authentication. The secure socket layer (SSL) certificate must exist on
the node being used, otherwise a server certificate is not checked.
The clustered system (system) must be configured with an appropriate version IP address when -ip is
specified. The IP address specified with the -ip parameter must be of a version supported by the system.
The certificate file must be in valid privacy enhanced mail (PEM) format and have a maximum length of
4096 bytes.
Remember: There is a maximum of six configured LDAP servers. Attempting to create a seventh LDAP
server returns an error.
An invocation example
mkldapserver -ip 192.135.60.3
lsuser
Use the lsuser command to display a list of the users that have been created on the clustered system
(system).
Syntax
lsuser
-nohdr -delim delimiter
-filtervalue attribute=value -filtervalue? userid_or_name
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is the asterisk (*).
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""), as follows:
lsuser -filtervalue "usergrp_name=md*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalueattribute=vaule parameter:
v password
v ssh_key
v remote
v usergrp_id
v usergrp_name
userid_or_name
(Optional) Specifies the ID or name of the user for which the association is being deleted. If this is
specified, the detailed view for the specified user is displayed in the ouput. If you do not specify an
ID or name, the concise view is displayed.
Description
This command displays a list of users that have been created on the system.
472 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
A detailed invocation example
lsuser 1
lsusergrp
Use the lsusergrp command to display a list of the user groups that have been created on the clustered
system (system).
Syntax
lsusergrp
-nohdr -delim delimiter
-filtervalue attribute=value -filtervalue? usergrp_id_or_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: Some filters allow the use of a wildcard when you enter the command. The following rules
apply to the use of wildcards with the SAN Volume Controller CLI:
v The wildcard character is the asterisk (*), which must be used as the first or last character in the
string.
v The command can contain a maximum of one wildcard.
v When you use a wildcard, enclose the filter entry within double quotation marks (""), as follows:
lsusergrp -filtervalue "role=md*"
-filtervalue?
(Optional) Displays the valid filter attributes for the -filtervalue attribute=value parameter:
Description
This command displays a list of user groups that have been created on the system.
An invocation example
lsusergrp
mkuser
Use the mkuser command to create either a local or a remote user to access a SAN Volume Controller
clustered system (system).
Syntax
| mkuser -name user_name -remote
| -usergrp group_id
group_name
|
| -password -keyfile sshkey_filename
cleartext_password
|
Parameters
-name user_name
(Required) Specifies the unique user name. The user name cannot start or end with a blank. The user
name must consist of a string of 1 - 256 ASCII characters, with the exception of the following
characters: %:",*' .
-remote | -usergrp
(Required) Specifies whether the user authenticates to the system using a remote authentication
service or system authentication methods.Either the remote parameter or the usergrp parameter must
be set. If usergrp is specified, it must be followed by group_name or group_id (see next parameter).
group_name | group_id
(Required if usergrp is specified) The ID or name of the user group with which the local user is to be
associated.
-password cleartext_password
(Optional) Specifies the password to be associated with the user. The password cannot start or end
with a blank. It must consist of a string of 6 - 64 printable ASCII characters. You can optionally
474 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
specify the password with the password parameter. If you do not specify the password, the system
prompts you for it before running the command and does not display the password that you type.
-keyfile sshkey_filename
(Optional) Specifies the name of the file that contains the Secure Shell (SSH) public key.
Description
The mkuser command creates a new local or remote user to access a system. The command returns the ID
of the created user.
You must have the Security Administrator role to create, delete, or change a user.
If you create a local user, you must specify the existing user group that the user belongs to. All local
users must have a group. The user group defines roles that provide the user with access to specific
operations on the system. You must also specify either the keyfile or password parameter, or both.
If you create a remote user, you must specify both the keyfile and password parameters. Remote users
have their groups defined by the remote authentication service.
Up to 400 users can be defined on the system. You can also create new users and assign keys to them.
If you use the keyfile parameter, the SSH key file should be placed in the /tmp directory before running
this command. When you run the command, the SSH key is copied into system state and activated for
the user, and the input file is deleted.
An invocation example
mkuser -name jane -usergrp Service -password secret
mkusergrp
Use the mkusergrp command to create a new user group.
Syntax
mkusergrp -name group_name -role role_name
-remote
Parameters
-name group_name
(Required) Specifies the unique user group name. The group name cannot start or end with a blank.
The group name must consist of a string of 1 - 64 ASCII characters, with the exception of the
following characters: %:",*' .
-role role_name
(Required) Specifies the role to be associated with all users that belong to this user group. One of the
following roles must be selected:
v Monitor
v CopyOperator
v Service
v Administrator
Description
The mkusergrp command creates a new user group to organize users of the SAN Volume Controller
clustered system (system) by role. Use the lsusergrp command to view a list of user groups that have
been created on the system.
You must have the security administrator role (SecurityAdmin role name) to create, delete, or change a
user group.
Each user group has one role that determines the role of users that belong to that group. Use the role
parameter to specify one of the following roles for the user group:
Monitor
Users can issue all information commands and, additionally, the following commands:
v finderr
v dumperrlog
v dumpinternallog
v chcurrentuser
v ping
v svcconfig backup
CopyOperator
Users can issue the following commands:
v prestartfcconsistgrp
v startfcconsistgrp
v stopfcconsistgrp
v chfcconsistgrp
v prestartfcmap
v startfcmap
v stopfcmap
v chfcmap
v startrcconsistgrp
v stoprcconsistgrp
v switchrcconsistgrp
v chrcconsistgrp
v startrcrelationship
v stoprcrelationship
v switchrcrelationship
v chrcrelationship
v chpartnership
. In addition, users can issue all of the commands allowed by the Monitor role.
Service
Users can issue the following commands:
476 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v applysoftware
v setlocale
v addnode
v rmnode
v cherrstate
v writesernum
v detectmdisk
v includemdisk
v clearerrlog
v cleardumps
v settimezone
v stopcluster
v startstats
v stopstats
v settime
. In addition, users can issue all of the commands allowed by the Monitor role.
Administrator
Users can issue all commands except:
v chauthservice
v mkuser
v rmuser
v chuser
v mkusergrp
v rmusergrp
v chusergrp
v setpwdreset
SecurityAdmin
Users can issue all commands.
An invocation example
mkusergrp -name support -role Service
rmldapserver
Use the rmldapserver command to delete a Lightweight Directory Access Protocol (LDAP) server.
Syntax
rmldapserver ldap_server_id
ldap_server_name
Description
Remember:
v If remote authentication with LDAP is enabled, the final LDAP server cannot be deleted. To delete the
final LDAP server disable LDAP authentication by specifying chauthservice -enable no.
v The rmldapserver command can be specified whether or not LDAP authentication is enabled.
An invocation example
rmldapserver ldapserver0
rmuser
Use the rmuser command to delete a user.
Syntax
rmuser user_id
user_name
Parameters
user_id or user_name
(Required) Specifies the user to be removed.
Description
You must have the Security Administrator role to create, delete, or modify a user.
An invocation example
rmuser jane
rmusergrp
Use the rmusergrp command to delete a user group.
Syntax
rmusergrp group_id
-force group_name
478 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
-force
(Optional) Specifies that the user group should be deleted even if there are users in the group.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
group_id | group_name
(Required) The ID or name of the user group to be removed.
Description
You must have the Security Administrator role to create, delete, or change a user group.
User groups with users cannot normally be deleted. If you use the force parameter, the group is deleted
and all of the users in that group are assigned to the Monitor group. Default user groups cannot be
deleted, even if the force parameter is set.
An invocation example
rmusergrp support
testldapserver
Use the testldapserver command to test a Lightweight Directory Access Protocol (LDAP) server.
Syntax
testldapserver
-username user_name
-password
password
-delim delimiter
ldap_server_id
ldap_server_name
Parameters
-username user_name
(Optional) Specifies the user name to test.
-password password
(Optional) Specifies the password to test. You can optionally specify the password with this
parameter. If you do not specify the password, the system prompts you for it before running the
command and does not display the password that you type.
Note: The -password parameter is only valid if -username is specified. The actual password does not
need to be supplied.
ldap_server_id|ldap_server_name
(Optional) Specifies the LDAP server ID or name to test.
Description
Important: This command works whether or not LDAP authentication is selected or enabled with the
chauthservice command.
Table 73. testldapserver attribute values
Attribute Value
id LDAP server ID
name LDAP server name
error Critical server error (or success, depending on situation) encountered
An invocation example with one LDAP server and no specific user information
testldapserver -delim ":" ldapserver1
480 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
id:name:error
0:ldapserver0:CMMVC6518E The task has failed because no roles
are defined for the current user on the system.
1:ldapserver1:CMMVC7075I The LDAP task completed successfully.
2:ldapserver2:CMMVC7075I The LDAP task completed successfully.
addvdiskcopy
Use the addvdiskcopy command to add a copy to an existing VDisk (volume), which changes a
nonmirrored volume into a mirrored volume.
Note: The first syntax diagram depicts the addition of a sequential or striped mode volume. The second
syntax diagram depicts the addition of an image mode volume.
Syntax
-mdisk mdisk_id_list
mdisk_name_list
-rsize disk_size
disk_size_percentage% -warning disk_size -autoexpand 32
auto disk_size_percentage% -grainsize 64
128
256
-compressed
vdisk_name
-fmtdisk -createsync -syncrate rate mb -easytier on vdisk_id
-unit b off
kb
gb
tb
pb
-rsize disk_size
disk_size_percentage% -warning disk_size -autoexpand 32
auto disk_size_percentage% -grainsize 64
128
256
-compressed
-import
-fmtdisk -createsync -syncrate rate mb -tier generic_ssd -easytier on
-unit b generic_hdd off
kb
gb
tb
pb
vdisk_name
vdisk_id
-rsize disk_size
disk_size_percentage% -warning disk_size
auto disk_size_percentage%
-compressed
-import
Parameters
-mdiskgrp mdisk_group_id_list | mdisk_group_name_list
(Required) Specifies the managed disk groups to use to create copies for the virtual disk. You must
specify a group for each copy that is being added.
-mirrorwritepriority latency | redundancy
(Optional) Specifies how to configure the mirror write algorithm priority.
1. Choosing latency means a copy that is slow to respond to a write input/output (I/O) becomes
unsynchronized, and the write I/O completes if the other copy successfully writes the data.
2. Choosing redundancy means a copy that is slow to respond to a write I/O synchronizes
completion of the write I/O with the completion of the slower I/O in order to maintain
synchronization.
3. If not specified, the current value is unchanged.
-vtype seq | striped | image
(Optional) Specifies the virtualization type for the copy: sequential, striped, or image. The type can be
different than the virtualization types for other copies on the volume. The default virtualization type
is striped.
-mdisk mdisk_id_list | mdisk_name_list
(Optional) Specifies one or more managed disks (MDisks). For sequential and image mode copies,
you must specify a single MDisk that has sufficient free extents. For image mode copies, the MDisk
must be in unmanaged mode. For sequential mode copies the MDisk must be in the managed mode.
-syncrate rate
(Optional) Specifies the copy synchronization rate. A value of zero (0) prevents synchronization. For
the supported -syncrate values and their corresponding rates, see Table 75 on page 487.
If not specified, the current value is unchanged.
-createsync
(Optional) Suppresses the synchronization of the new volume copy with the primary copy. Using this
parameter can cause data corruption if the primary copy fails and leaves an unsynchronized
secondary copy to provide data. Using this parameter can cause loss of read stability in unwritten
areas if the primary copy fails, data is read from the primary copy, and then different data is read
from the secondary copy. To avoid data loss or read stability loss, use this parameter only for a
primary copy that has been formatted and not written to, and with the -fmtdisk parameter.
-fmtdisk
(Optional) Formats a sequential or striped mode copy. You must also specify the -createsync
parameter, which labels the formatted copy as identical to the primary copy. The -fmtdisk parameter
causes the volume to go offline until new volume copy formatting completes. To query the formatting
progress, use the lsvdiskprogress command.
-rsize disk_size | disk_size_percentage%| auto
(Optional) Makes the copy space-efficient and specifies the real size of the copy. Specify the disk_size
| disk_size_percentage value using an integer, or an integer immediately followed by the percent
character (%). The default units for disk_size are megabytes (MB); to specify different units, use the
484 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-unit parameter. The auto option creates a volume copy that uses the entire size of the MDisk; if you
specify the -rsize auto option, you must also specify the -vtype image option.
compressed
(Optional) Adds exactly one copy to an existing volume that already has (only) one copy a volume,
and enables compression. Requires the -rsize parameter also be specified.
Remember:
v You cannot specify this parameter with the -grainsize parameter.
v When you specify this parameter with the -import parameter, you must specify -rsize auto.
-warning disk_size | disk_size_percentage%
(Optional) Requires that the -rsize parameter also be specified. Generates a warning when the used
disk capacity on the space-efficient copy first exceeds the specified threshold. You can specify a
disk_size integer, which defaults to megabytes (MB) unless the -unit parameter is specified; or you can
specify a disk_size%, which is a percentage of the virtual disk size. If -autoexpand is enabled, the
default value for -warning is 80% of the virtual disk capacity. If -autoexpand is not enabled, the
default value for warning is 80% of the real capacity. To disable warnings, specify 0.
-autoexpand
(Optional) Requires that the -rsize parameter also be specified. Specifies that space-efficient copies
automatically expand their real capacities by allocating new extents from their managed disk group.
If the -autoexpand parameter is specified, the -rsize parameter specifies a capacity that is reserved by
the copy. This protects the copy from going offline when its managed disk group runs out of space
by allowing it to consume this reserved space first.
-grainsize 32 | 64 | 128 | 256
(Optional) Requires that the -rsize parameter also be specified. Sets the grain size (KB) for a
space-efficient volume copy. The grain size value must be 32, 64, 128, or 256 KB. The default is 256
KB.
-unit b | kb | mb | gb | tb | pb
(Optional) Specifies the data units for the -rsize and -warning parameters.
-import
(Optional) Imports an image mode disk that contains a space-efficient volume into the clustered
system (system). Requires that the -rsize and -vtype image parameters also be specified.
vdisk_name | vdisk_id
(Required) Specifies the virtual disk to add the volume copy to, either by ID or by name.
-tiergeneric_ssd | generic_hhd
(Optional) Specifies the MDisk tier when an image mode copy is added.
-easytieron | off
(Optional) Determines if the IBM System Storage Easy Tier function is allowed to move extents for
this volume. If a volume copy is striped and not being migrated the following table applies:
Table 74. Storage pool Easy Tier settings
Storage pool Easy Tier Number of tiers in the Volume copy Easy Tier Volume copy Easy Tier
setting storage pool setting status
Off One Off inactive (see note 2 on page
486)
Off One On inactive (see note 2 on page
486)
Off Two Off inactive (see note 2 on page
486)
Off Two On inactive (see note 2 on page
486)
Description
The addvdiskcopy command adds a copy to an existing volume , which changes a nonmirrored volume
into a mirrored volume. Use the mkdiskgrp parameter to specify the managed disk group that provide
storage for the copy; the lsmdiskgrp command lists the available managed disk groups and the amount
of available storage in each group.
The addvdiskcopy command can be specified with a file system volume, but must be used with the same
storage pool for that volume.
Remember: Only compressed copies are allowed to be added to file system volumes.
The addvdiskcopy command adds a different volume copy, such as a copy created from a uncompressed
to compressed conversion or a compressed to uncompressed conversion.
486 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
If the -mdisk parameter is also specified, you can supply a list of managed disks to use as the
stripe set. This can be two or more managed disks from the same managed disk group. The same
circular algorithm is used across the striped set. However, a single managed disk can be specified
more than once in the list. For example, if you enter -m 0:1:2:1, the extents are from the
following managed disks: 0, 1, 2, 1, 0, 1, 2, and so forth. All MDisks that are specified in the
-mdisk parameter must be in managed mode.
image This policy allows image mode virtual disks to be created when a managed disk already has data
on it, perhaps from a previrtualized subsystem. When an image mode virtual disk is created, it
directly corresponds to the (previously unmanaged) managed disk that it was created from;
therefore, virtual disk logical block address (LBA) x equals managed disk LBA x. You can use this
command to bring a nonvirtualized disk under the control of the system. After it is under the
control of the system, you can migrate the virtual disk from the single managed disk. When it is
migrated, the virtual disk is no longer an image mode virtual disk.
You can add image mode volumes to an already populated managed disk group (storage pool)
with other types of volumes, such as a striped or sequential.
Note: An image mode copy must be at least as large as the volume that it is being added to, but
any capacity beyond the size of the volume is not accessible.
Remember:
v Create the first compressed volume copy for an I/O group to activate compression.
v You cannot create or move a compressed volume copy to an I/O group that contains (at least) one
node that does not support compressed volumes. You must use another I/O group, but note that this
does not affect moving to the recovery I/O group.
Table 75 provides the relationship of the rate value to the data copied per second.
Table 75. Relationship between the rate value and the data copied per second
User-specified rate attribute value Data copied/sec
1 - 10 128 KB
11 - 20 256 KB
21 - 30 512 KB
31 - 40 1 MB
41 - 50 2 MB
51 - 60 4 MB
61 - 70 8 MB
71 - 80 16 MB
81 - 90 32 MB
91 - 100 64 MB
An invocation example
addvdiskcopy -mdiskgrp 0 -easytier off vdisk8
addvdiskaccess
Use the addvdiskaccess to add an I/O group (or groups) to the set of I/O groups in which a volume can
be made accessible to hosts.
Syntax
addvdiskaccess -iogrp iogrp_id_list vdisk_id
iogrp_name_list vdisk_name
Parameters
-iogrp iogrp_id_list | iogrp_name_list
(Required) Specifies a list of I/O groups to add to the I/O group volume access set.
vdisk_id | vdisk_name
(Required) Specifies the volume to which to add access through the specified I/O groups.
Description
If an I/O group is already a member of the access set, no error is generated and no action is taken for
that I/O group. All host mappings for the volume are added to the I/O groups in the list. The -force
option is not required to extend additional mappings to other I/O groups.
When an I/O group is added to the access set, it creates access to the volume from the hosts that are
mapped to the volume from the nodes in the I/O group. If the volume is mapped twice, it is also
mapped twice through all additional I/O groups.
Two mappings are created if a host is mapped to a volume with two I/O groups. Hosts are limited to 512
host-to-volume mappings, which means a host can be mapped to:
v 512 volumes in a single I/O group
v 256 volumes across two I/O groups
v 64 volumes across four I/O groups
488 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The command fails if any host mapped to the volume is detected as a host system that does not support
volumes mapped from multiple I/O groups.
An invocation example
This example adds I/O group 2 to the volume access set for DB_Volume:
addvdiskaccess -iogrp 2 DB_Volume
An invocation example
This example adds I/O groups 2 and 3 to the volume access set for volume ID 3:
addvdiskaccess -iogrp 2:3 3
chvdisk
Use the chvdisk command to modify the properties of a volume, such as the disk name, I/O governing
rate, or unit number.
| Syntax
| chvdisk -name new_name_arg vdisk_name
-cache readwrite vdisk_id
none -force
-rate throttle_rate [ -unitmb ]
-udid vdisk_udid
-warning disk_size
-unit b
kb
mb
gb
tb
pb
disk_size_percentage %
-copy id
-autoexpand on
off -copy id
-primary copy_id
-syncrate rate
-easytier on
off -copy id
-mirrorwritepriority latency
redundancy
|
Parameters
-name new_name_arg
(Optional) Specifies a new name to assign to the volume. You cannot use this parameter with the
-rate or -udid parameters. This parameter is required if you do not use the -rate or -udid
parameters.
Chapter 29. Virtual disk commands 489
-cache readwrite | none
| (Optional) Specifies the caching options for the volume. Valid entries are:
| v readwrite to enable the cache for the volume
| v none to disable the cache mode for the volume
-force
(Optional) The force parameter can only be used for changing the I/O group of a volume or the
caching mode. Use the force parameter with the iogrp parameter to force the volume to be removed
from an I/O group. Use the force parameter with the cache parameter to specify that you want the
system to change the cache mode of the volume even if the I/O group is offline. This option
overrides the cache flush mechanism.
Attention: If the force parameter is used for changing the caching mode, the contents of the cache
are discarded and the volume might be corrupted by the loss of the cached data. This could occur if
the system is able to destage all write data from the cache or not. The force parameter should be
used with caution.
Important: Using the force parameter might result in a loss of access. Use it only under the direction
of the IBM Support Center.
-rate throttle_rate [-unitmb]
(Optional) Specifies the I/O governing rate for the volume, which caps the amount of I/O that is
accepted. The default throttle_rate units are I/Os. To change the throttle_rate units to megabytes per
second (MBps), specify the -unitmb parameter. The governing rate for a volume can be specified by
I/Os or by MBps, but not both. However, you can set the rate to I/Os for some volumes and to
MBps for others.
You cannot use this parameter with the -name or -udid parameters.
-udid vdisk_udid
(Optional) Specifies the unit number (-udid) for the disk. The vdisk_udid is an identifier that is
required to support OpenVMS hosts; no other systems use this parameter. Valid options are a decimal
number from 0 to 32 767 or a hexadecimal number from 0 to 0x7FFF. A hexadecimal number must be
preceded by 0x (for example, 0x1234). If you do not use the -udid parameter, the default -udid is 0.
You cannot use this parameter with the -name or -node parameters.
-warning disk_size | disk_size_percentage%
(Optional) Generates a warning when the used disk capacity on the space-efficient copy first exceeds
the specified threshold. You can specify a disk_size integer, which defaults to MBs unless the -unit
parameter is specified; or you can specify a disk_size%, which is a percentage of the volume size. To
disable warnings, specify 0 or 0%.
-unit b | kb | mb | gb | tb | pb
(Optional) Specifies the data units to use for the -warningdisk_size parameter. The default unit value is
MB.
-autoexpand on | off
(Optional) Specifies whether space-efficient volume copies automatically expand their real capacities
by allocating new extents from their managed disk group. To use this parameter, the volume must be
space-efficient.
-copy id
(Optional) Specifies the copy to apply the changes to. You must specify this parameter with the
-autoexpand or -warning parameter. The -copy parameter is required if the specified volume is
mirrored and only one volume copy is space-efficient. If both copies are space-efficient and the -copy
parameter is not specified, the specified -autoexpand or -warning parameter is set on both copies.
-primary copy_id
(Optional) Specifies the primary copy. Changing the primary copy only takes effect when the new
490 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
primary copy is online and synchronized. If the new primary is online and synchronized when the
command is issued, the change takes effect immediately.
-syncrate rate
(Optional) Specifies the copy synchronization rate. A value of zero (0) prevents synchronization. The
default value is 50. See Table 76 for the supported -syncrate values and their corresponding rates.
-easytier on | off
(Optional) Enables or disables the IBM System Storage Easy Tier function.
-mirrorwritepriority latency | redundancy
(Optional) Specifies how to configure the mirror write algorithm priority. A change to the mirror
write priority is reflected in the volume's view immediately and in the volume's behavior after all
prior input and output (I/O) completes.
1. Choosing latency means a copy that is slow to respond to a write I/O becomes unsynchronized,
and the write I/O completes if the other copy successfully writes the data
2. Choosing redundancy means a copy that is slow to respond to a write I/O synchronizes
completion of the write I/O with the completion of the slower I/O in order to maintain
synchronization.
3. If not specified, the current value is unchanged.
vdisk_name | vdisk_id
(Required) Specifies the volume to modify, either by ID or by name.
Description
The chvdisk command modifies a single property of a volume. To change the volume name and modify
the synchronization rate, for example, you must issue the command twice.
Note: If the volume is offline, use one of the recovervdisk commands to recover the volume and bring it
back online.
Important: To change the caching I/O group for a volume, use the movevdisk command.
You can specify a new name or label. You can use the new name subsequently to refer to the volume.
You can set a limit on the amount of I/O transactions that is accepted for this volume. It is set in terms of
I/Os per second or MBs per second. By default, no I/O governing rate is set when a volume is created.
Attention: All capacities, including changes, must be in multiples of 512 bytes. An error occurs if you
specify a capacity that is not a multiple of 512, which can only happen when byte units (-b) are used. The
default capacity is in MB.
When the volume is created, there is no throttling applied to it. Using the -rate parameter can change
this. To change the volume back to an unthrottled state, specify 0 (zero) with the -rate parameter.
Table 76 provides the relationship of the rate value to the data copied per second.
Table 76. Relationship between the rate value and the data copied per second
User-specified rate attribute value Data copied/sec
1 - 10 128 KB
11 - 20 256 KB
21 - 30 512 KB
31 - 40 1 MB
An invocation example
chvdisk -rate 2040 1
expandvdisksize
Use the expandvdisksize command to expand the size of a VDisk (volume) by a given capacity.
Syntax
expandvdisksize -size disk_size
-rsize disk_size -mdisk mdisk_id_list
mdisk_name_list
vdisk_name
-fmtdisk -unit b -copy id vdisk_id
kb
mb
gb
tb
pb
Parameters
-size disk_size
(Optional) Specifies the capacity by which the virtual disk is expanded. Disk size is used with the
value of the unit. All capacities, including changes must be in multiples of 512 bytes. An error occurs
if you specify a capacity that is not a multiple of 512, which can only occur when byte units (-unit b)
are used. However, an entire extent is reserved even if it is only partially used. The default disk_size
unit is megabytes (MB). You cannot specify the -size parameter with the -rsize parameter. You must
specify either -size or -rsize. If the volume is space-efficient, MDisks cannot be specified.
-rsize disk_size
(Optional) Specifies the capacity by which to increase the real size of a space-efficient volume. Specify
the disk_size value using an integer. Specify the unit for a disk_size integer using the -unit parameter;
the default unit is megabytes (MB). The -rsize value can be greater than, equal to, or less than the
size of the volume. You cannot specify the -rsize parameter with the -size parameter. You must
specify either -size or -rsize.
-copy id
(Optional) Specifies the copy to change the real capacity for. You must also specify the -rsize
parameter; you can only modify the real capacity of a volume copy. The -copy parameter is required
492 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
if the specified volume is mirrored and only one copy is space-efficient. If the volume is mirrored,
both copies are space-efficient and -copy is not specified, both copies are modified by the same
amount.
-mdisk mdisk_id_list | mdisk_name_list
(Optional) Specifies the list of one or more MDisks to be used as the stripe set. The extents that
expand the volume come from the specified list of MDisks. All MDisks in the list must be part of the
same MDisk group. The -mdisk parameter cannot be used if the specified volume is mirrored.
-fmtdisk
(Optional) Specifies that the volume be formatted before use. This parameter formats the new extents
that have been added to the volume as a result of the expandvdisksize command. The
expandvdisksize command completes asynchronously if you use this parameter.
-unit b | kb | mb | gb | tb | pb
(Optional) Specifies the disk_size unit for the -size or -rsize parameter. The default value is
megabytes (MB).
vdisk_name | vdisk_id
(Required) Specifies the virtual disk to modify, either by ID or by name.
Description
Use the expandvdisksize command to expand the physical capacity that is allocated to a particular
volume by the specified amount.
The command can also be used to expand the virtual capacity of a space-efficient volume without
altering the physical capacity that is assigned to the volume. To change the capacity of a
non-space-efficient volume, or the virtual capacity of a space-efficient volume, use the -size parameter.
To change the real capacity of a space-efficient volume, use the -rsize parameter.
Note: You can not expand the capacity of any volume in a Global Mirror or Metro Mirror relationship,
regardless of whether it is a Primary, Secondary, or a Change Volume. To expand the capacity of a
volume in a Global Mirror or Metro Mirror relationship:
1. Delete the relationship.
2. Increase the size of all the volumes. All volumes in a relationship must have the exact same size
(virtual capacity).
3. Re-create the relationship with the larger volumes.
When the mirror is restarted, it will do a complete initial synchronization, replicating the entire primary
volume to the secondary volume.
You can not expand the capacity of any volume in a FlashCopy mapping, regardless of whether it is a
source or target, or what state the mapping is in. To expand the capacity of a volume in a Flashcopy
mapping:
1. Delete all the mappings in that FlashCopy tree. (There is a root source volume and some targets either
directly or cascaded off of other targets - the entire tree must be deleted.)
2. Increase the size of all volumes in the original FlashCopy tree. All volumes in a tree must be the same
size (virtual capacity).
3. Re-create all the FlashCopy mappings with the new larger volumes.
When a FlashCopy is restarted after being deleted (including if it is an incremental FlashCopy) the entire
volume becomes part of any background copy because it is the start of a new mapping.
To run the expandvdisksize command on a mirrored volume, all copies of the volume must be
synchronized. The command formats all copies of a mirrored volume automatically.
Remember:
1. You cannot resize (expand) an image mode volume.
2. You cannot shrink a volume that is part of a file system.
lshostvdiskmap
Use the lshostvdiskmap command to display a list of VDisk (volume)s mapped to a given host. These are
the volumes that are recognized by the specified host.
Syntax
lshostvdiskmap
-nohdr -delim delimiter host_id
host_name
494 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a list of volume IDs and names. These are the volumes that have been mapped
to the specified host; that is, they are visible to the specified host. The SCSI LUN ID is also displayed.
This SCSI LUN ID is the ID by which the volume is recognized by the host.
Each volume that is exported by the clustered system is assigned a unique virtual path (VPATH) number.
This number identifies the volume and determines which volume corresponds to the volume that the
hosts recognize. This procedure can only be performed using the command-line interface.
For a specific volume based on which operating system and multipath software are used, you can use
different commands to determine the VPATH serial number. For example, issuing datapath query device
finds the VPATH serial number for volumes mapped to AIX sddpcm.
Find the host that is defined to the clustered system that corresponds with the host that you are working
with.
1. The worldwide port names (WWPNs) are an attribute of the host bus adapter (HBA). You can find
these by looking at the device definitions stored by your operating system. For example, on AIX® they
are in the Object Data Manager (ODM), in Windows® they are in the Device Manager details for the
given HBA.
2. Verify which host is defined to the clustered system that these ports belong to. The ports are stored as
part of the detailed view, so you must list each host in turn by issuing the following command:
where host_name | host_id is the name or ID of the host. Check for matching WWPNs.
Note: Name your hosts accordingly. For example, if the actual host is called orange, also name the
host that is defined to the clustered system orange.
When you have the hostname defined to the clustered system and the vpath serial number, issue the
following command:
where hostname is the name of the host. A list is displayed. Look for the volume UID that matches the
vpath serial number and record the volume name or ID.
An invocation example
lshostvdiskmap -delim : 2
lsrepairsevdiskcopyprogress
The lsrepairsevdiskcopyprogress command lists the repair progress for space-efficient volume copies or
compressed volume copies.
Syntax
lsrepairsevdiskcopyprogress
-nohdr -delim delimiter -copy id
vdisk_name
vdisk_id
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
496 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
-copy id
(Optional) Lists the repair progress for the specified copy.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The lsrepairsevdiskcopyprogress command lists the repair progress for space-efficient or compressed
copies for the specified volume. If you do not specify a volume, the command lists the repair progress for
all space-efficient or compressed copies in the clustered system.
Remember: Only run this command after running the repairsevdiskcopy command, which you must
only run as required by the fix procedures or by the IBM Support Center.
The command returns values for the following volume copy attributes:
task Specifies the active task.
v repairing indicates repair of a space-efficient volume copy
v compressed_repairing indicates repair of a compressed volume copy.
progress
Specifies the task completion percentage.
estimated_completion_time
Specifies the expected duration of the task in the format YYMMDDHHMMSS (or blank if the estimated
completion time is unknown).
An invocation example
lsrepairsevdiskcopyprogress –delim :
An invocation example
lsrepairsevdiskcopyprogress –delim : vdisk0
lsrepairvdiskcopyprogress
Use the lsrepairvdiskcopyprogress command to display the progress of volume repairs and validations.
Syntax
lsrepairvdiskcopyprogress
-nohdr -delim delimiter -copy id
vdisk_name
vdisk_id
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The lsrepairvdiskcopyprogress command displays the progress of repairs and validations being made to
mirrored volumes. Use this command to track progress after running the repairvdiskcopy command. You
can specify a volume copy using the -copy parameter. To display the volumes that have two or more
copies with an active task, specify the command with no parameters; it is not possible to have only one
volume copy with an active task.
The command displays progress for the following types of volume copies:
v All volume copies display the same task; validate, medium or resync, depending on the specified
parameter.
498 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v All volume copies display the same percentage and estimated completion time.
v If specified, non-mirrored volumes are displayed as a single copy with a blank task; they are not
displayed in the full concise view.
v Once a task completes, the task is blank for all copies.
v If the task is blank, the percentage and the completion time are also blank.
The command returns values for the following volume repair attributes:
vdisk_id
Indicates the volume ID.
vdisk_name
Indicates the volume name.
copy_id
Indicates the system-assigned identifier for the volume copy.
task Indicates the active task. The values can be repairing or compressed_repairing.
progress
Indicates the task completion percentage. This value is 0 when task is in compressed_repairing
state.
estimated_completion_time
Indicates the expected time (duration) the task completion time. The value is in the YYMMDDHHMMSS
format, and is blank if the duration is not known.
An invocation example
lsrepairvdiskcopyprogress –delim :
An invocation example
lsrepairvdiskcopyprogress –delim : vdisk0
An invocation example
lsrepairvdiskcopyprogress –delim : -copy 0 vdisk0
Syntax
lssevdiskcopy
-nohdr -bytes -delim delimiter
-copy id -filtervalue? vdisk_name
vdisk_id
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The lssevdiskcopy command lists all space-efficient copies of the specified volume. If you do not specify
a volume, the command lists all space-efficient volume copies in the clustered system.
500 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The command provides a concise view of the space-efficient properties of the selected volume copies.
Run the lsvdiskcopy command to see a concise view of the properties that are common to space-efficient
and non-space-efficient volume copies. See the description of the lsvdisk command for a description of
the fields that are shown in the view.
The command returns values for the following volume copy attributes:
copy_id
Specifies a system-assigned identifier for the volume copy. The value can be 0 or 1.
status The value can be online or offline. A copy is offline if all nodes cannot access the storage pool
that contains the copy.
sync Indicates whether the volume copy is synchronized.
primary
Indicates whether the volume copy is the primary copy. A volume has exactly one primary copy.
The value can be yes or no.
mdiskgrp_id/name
Specifies the name and ID of the storage pool that the volume copy belongs to.
type Specifies the virtualization type of the volume. The value can be striped, sequential or image.
mdisk_id/name
Specifies the MDisk that is used for sequential and image mode volumes.
fast_write_state
Specifies the cache state of the volume copy. The value can be empty, not_empty, corrupt, or
repairing. The value is always empty for non-space-efficient copies. A cache state of corrupt
indicates that the volume is space-efficient and requires repair that is initiated by a recovervdisk
command or the repairsevdiskcopy command.
used_capacity
Specifies the portion of real_capacity that is being used to store data. For non-space-efficient
copies, this value is the same as the volume capacity. If the volume copy is space-efficient, the
value increases from zero to the real_capacity value as more of the volume is written to.
real_capacity
Specifies the amount of physical storage that is allocated from an storage pool to this volume
copy. If the volume copy is not space-efficient, the value is the same as the volume capacity. If the
volume copy is space-efficient, the value can be different.
free_capacity
Specifies the difference between the real_capacity and used_capacity values.
overallocation
Expressed as a percentage, specifies the ratio of volume capacity to real_capacity values. This
value is always 100 for non-space-efficient volumes.
autoexpand
Specifies whether autoexpand is enabled on a space-efficient volume. The value can be on or off.
warning
Expressed as a percentage, for space-efficient volume copies only. A warning is generated when
the ratio of used_capacity to volume capacity reaches the specified level.
grainsize
For space-efficient volume copies, specifies the grain size chosen for the volume copy when it
was created.
Note:
1. If easy_tier is on, then easy_tier_status can take on any value.
2. if easy_tier is off, then easy_tier_status is measured or inactive.
easy_tier_status
Which Easy Tier functions are active for the volume copy:
v Active : You can move extents of this volume copy for performance (automatic data
placement).
v Measured: Statistics are being gathered for this volume copy, but no extents will be moved.
v Inactive: No Easy Tier function is active.
tier Which tier information is being reported:
v generic_ssd
v generic_hdd
tier_capacity
The total MDisk capacity assigned to the volume in the tier.
Note: For space-efficient copies, the capacity by tier will be the real capacity.
compressed_copy
Indicates whether or not the volume copy is compressed.
uncompressed_used_capacity
For compressed volumes, indicates the amount of data written to the volume before compression.
An invocation example
lssevdiskcopy –delim :
An invocation example
lssevdiskcopy -delim : -copy 0 0
502 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
mdisk_name:
fast_write_state:not_empty
used_capacity:2.00GB
real_capacity:2.01GB
free_capacity:6.00GB
overallocation:796
autoexpand:on
warning:25
grainsize:256
se_copy:yes
easy_tier:on
easy_tier_status:active
tier:generic_ssd
tier_capacity:64.00MB
tier:generic_hdd
tier_capacity:2.00GB
compressed_copy:yes
uncompressed_used_capacity:3.27GB
lsvdisk
Use the lsvdisk command to display a concise list or a detailed view of VDisks (volumes) that are
recognized by the clustered system (system).
Syntax
lsvdisk
-filtervalue attrib=value -nohdr -bytes
-delim delimiter -filtervalue? object_id
object_name
Parameters
-filtervalue attrib=value
(Optional) Specifies a list of one or more filters. Only objects with a value that matches the filter
attribute value are displayed. If a capacity is specified, the units must also be included.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Note: It is not possible to filter the lsvdisk command with mdisk_grp_name=many to identify
mirrored volumes. Instead, filter on copy_count=2.
Description
This command displays a concise list or a detailed view of attributes for all volumes and volume copies
in the system.
The volume is offline and unavailable if one of the following takes place:
v Both nodes in the I/O group are missing.
v None of the nodes in the I/O group that are present can access the volume.
v All synchronized copies for this volumes are in storage pools that are offline.
v The volume is formatting.
If you have a degraded volume and all of the associated nodes and MDisks are online, call the IBM
Support Center for assistance. A volume is reported as degraded if any of the following occurs:
504 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
v One of the nodes in the I/O group is missing.
v One of the nodes in the I/O group cannot access all the MDisks in the storage pool that the volume
spans. In this case MDisks are shown as degraded and the fix procedures for MDisks should be
followed to resolve the problem.
v The fast write cache pins data for one or more volumes in the I/O group and is unable to perform a
failback until the situation is resolved. An error log indicating that the cache has pinned data is
displayed. Follow the fix procedures for this error log to resolve the problem. The most common
causes of pinned data are the following:
– One or more volumes in an I/O group is offline due to an asymmetric failure and has pinned data
in the cache. Asymmetric failures can occur because of SAN Volume Controller fabric faults or
misconfiguration, back-end controller faults or misconfiguration or because repeated errors has led
to the system excluding access to a MDisk through one or more nodes.
– One or more volumes in an I/O group is offline due to a problem with a FlashCopy mapping.
Remember: This value must be numeric. (The value is zero if no node is configured in the I/O
group that contains the preferred node.)
fast_write_state
Specifies the cache state for the volume. The value can be empty, not_empty, corrupt, or
repairing. A cache state of corrupt indicates that the volume requires recovery by using one of
the recovervdisk commands. A cache state of repairing indicates that repairs initiated by a
recovervdisk command are in progress.
cache Specifies the cache mode of the volume. The value can be readonly, readwrite, or none.
udid Specifies the unit number for the volume. Only OpenVMS hosts require a unit number.
fc_map_count
Specifies the number of FlashCopy mappings that the volume belongs to.
sync_rate
Specifies the rate for synchronization for mirrored copies.
se_copy_count
Specifies the number of space-efficient copies.
Remember: This value represents only space- efficient copies and is not used for compressed
volume copies.
filesystem
Expressed as a value string (long object name with a maximum of 63 characters), specifies the full
name for file system which owns this volume; otherwise, it is blank.
mirror_write_priority
Specifies the mirror write algorithm priority being used if the volume is mirrored.
RC_change
Specifies if a volume is a change volume of a Global Mirror or Metro Mirror relationship.
compressed_copy_count
Specifies the number of compressed volume copies.
access_IO_group_count
Specifies the number of I/O groups in the volume access set.
The command returns values for the following volume copy attributes:
copy_id
Specifies a system-assigned identifier for the volume copy. The value can be 0 or 1.
status The value can be online or offline. A copy is offline if all nodes cannot access the storage pool
that contains the copy.
sync Indicates whether the volume copy is synchronized.
primary
Indicates whether the volume copy is the primary copy. A volume has exactly one primary copy.
The value can be Yes or No.
506 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
mdiskgrp_id
Specifies the ID of the storage pool that the volume copy belongs to.
mdiskgrp_name
Specifies the name of the storage pool that the volume copy belongs to.
| type Specifies the virtualization type of the volume. The value can be striped, seq, or image.
mdisk_id
Specifies the MDisk ID that is used for sequential and image mode volumes.
mdisk_name
Specifies the MDisk name that is used for sequential and image mode volumes.
fast_write_state
Specifies the cache state of the volume copy. The value can be empty, not_empty, corrupt, or
repairing. The value is always empty for non-space-efficient copies. A cache state of corrupt
indicates that the volume is space-efficient and requires repair that is initiated by a recovervdisk
command or the repairsevdiskcopy command.
used_capacity
Specifies the portion of real_capacity that is being used to store data. For non-space-efficient
copies, this value is the same as the volume capacity. If the volume copy is space-efficient, the
value increases from zero to the real_capacity value as more of the volume is written to.
real_capacity
Specifies the amount of physical storage that is allocated from an storage pool to this volume
copy. If the volume copy is not space-efficient, the value is the same as the volume capacity. If the
volume copy is space-efficient, the value can be different.
free_capacity
Specifies the difference between the real_capacity and used_capacity values.
overallocation
Expressed as a percentage of the volume capacity, specifies the ratio of volume capacity to
real_capacity values. This value is always 100 for non-space-efficient or compressed volumes.
Remember: This value can be any percentage (but not blank) for compressed volume copies.
autoexpand
Specifies whether autoexpand is enabled on a space-efficient volume. The value can be on or off.
Remember: This value can be any percentage for compressed volume copies.
grainsize
For space-efficient volume copies, specifies the grain size chosen for the volume copy when it
was created.
Remember: This value is yes for space- efficient copies and no for compressed volume copies.
Note:
1. If easy_tier is on, then easy_tier_status can take on any value.
2. If easy_tier is off, then easy_tier_status is measured or inactive.
easy_tier_status
Which Easy Tier functions are active for the volume copy:
v Active: may move extents of this volume copy for performance (automatic data placement).
v Measured: statistics are being gathered for this volume copy, but no extents will be moved.
v Inactive: no Easy Tier function is active.
tier The tier information being reported:
v generic_ssd
v generic_hdd
tier_capacity
The total MDisk capacity assigned to the volume in the tier.
Note: For space-efficient copies, the capacity by tier will be the real capacity.
compressed_copy
Indicates if the volume copy is compressed.
uncompressed_used_capacity
For compressed volumes, indicates the amount of data written to the volume before compression.
508 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
compressed_copy_count:1
access_IO_group_count:2
copy_id:0
status:online
sync:yes
primary:yes
mdisk_grp:1
mdisk_grp_name:mdisk_group_1
type:striped
mdisk_id:
mdisk_name:
fast_write_state:empty
used_capacity:16.00GB
real_capacity:16.00GB
free_capacity:6.00GB
overallocation:100
autoexpand:
warning:
grainsize:
se_copy:no
easy_tier:off
easy_tier_status:inactive
tier:generic_ssd
tier_capacity:0.00MB
tier:generic_hdd
tier_capacity:16.00GB
compressed_copy:no
uncompressed_used_copy:16.00GB
copy_id:1
status:offline
sync:no
primary:no
mdisk_grp:2
mdisk_grp_name:mdisk_group_2
type:striped
mdisk_id:
mdisk_name:
fast_write_state:not_empty
used_capacity:2.00GB
real_capacity:4.00GB
free_capacity:2.00GB
overallocation:400
autoexpand:on
warning:20
grainsize:256
se_copy:no
easy_tier:on
easy_tier_status:active
tier:generic_ssd
tier_capacity:64.00MB
tier:generic_hdd
tier_capacity:3.94GB
compressed_copy:yes
uncompressed_used_copy:5.56GB
lsvdiskaccess
Use the lsvdiskaccess command to display a list of all I/O groups in the volume access set.
510 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
lsvdiskaccess
vdisk_id
vdisk_name
Parameters
vdisk_id | vdisk_name
(Optional) Specifies the volume for which to list access I/O groups.
Description
The lsvdiskaccess command lists the I/O groups in a volume access set. An accessible volume in an I/O
group does not indicate the volume is mapped to any hosts. There is a detailed view and concise view,
but the detailed view does not contain more information than the concise view.
lsvdiskcopy
Use the lsvdiskcopy command to list volume copy information.
-filtervalue? vdisk_name
vdisk_id
-copy copy_id vdisk_name
vdisk_id
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
512 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
The lsvdiskcopy command lists information for volume copies. If you specify the command with no
parameters, all volumes and copies in the clustered system are listed.
The command returns values for the following volume copy attributes:
copy_id
Specifies a system-assigned identifier for the volume copy. The value can be 0 or 1.
status The value can be online or offline. A copy is offline if all nodes cannot access the storage pool
that contains the copy.
sync Indicates whether the volume copy is synchronized.
primary
Indicates whether the volume copy is the primary copy. A volume has exactly one primary copy.
The value can be yes or no.
mdiskgrp_id/name
Specifies the name and ID of the storage pool that the volume copy belongs to.
type Specifies the virtualization type of the volume. The value can be striped, sequential or image.
mdisk_id/name
Specifies the MDisk that is used for sequential and image mode volumes.
fast_write_state
Specifies the cache state of the volume copy. The value can be empty, not_empty, corrupt, or
repairing. The value is always empty for non-space-efficient copies. A cache state of corrupt
indicates that the volume is space-efficient and requires repair that is initiated by a recovervdisk
command or the repairsevdiskcopy command.
used_capacity
Specifies the portion of real_capacity that is being used to store data. For non-space-efficient
copies, this value is the same as the volume capacity. If the volume copy is space-efficient, the
value increases from zero to the real_capacity value as more of the volume is written to.
Remember: This value is the same as the volume capacity value for fully-allocated copies.
real_capacity
Specifies the amount of physical storage that is allocated from an storage pool to this volume
copy. If the volume copy is not space-efficient, the value is the same as the volume capacity. If the
volume copy is space-efficient, the value can be different.
Remember: This value is the same as the volume capacity value for fully-allocated copies.
free_capacity
Specifies the difference between the real_capacity and used_capacity values.
Note:
1. If easy_tier is on, then easy_tier_status can take on any value.
2. if easy_tier is off, then easy_tier_status is measured or inactive.
easy_tier_status
Which Easy Tier functions are active for the volume copy:
v Active: may move extents of this volume copy for performance (automatic data placement).
v Measured: statistics are being gathered for this volume copy, but no extents will be moved.
v Inactive: no Easy Tier function is active.
tier Which tier information is being reported:
v generic_ssd
v generic_hdd
tier_capacity
The total MDisk capacity assigned to the volume in the tier.
Note: For space-efficient copies, the capacity by tier will be the real capacity.
compressed_copy
Indicates whether or not the volume copy is compressed.
uncompressed_used_capacity
For compressed volumes, indicates the amount of data written to the volume before compression.
An invocation example
lsvdiskcopy -delim :
An invocation example
lsvdiskcopy -copy 0 –delim : vv1
514 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
primary:yes
mdisk_grp:1
mdisk_grp name:mdisk_group_1
type:striped
mdisk_id:
mdisk_name:
fast_write_state:not_empty
used_capacity:2.00GB
real_capacity:8.00GB
free_capacity:6.00GB
overallocation:200
autoexpand:on
warning:25
grainsize:256
se_copy:yes
easy_tier:on
easy_tier_status:active
tier:generic_ssd
tier_capacity:64.00MB
tier:generic_hdd
tier_capacity:7.94GB
compressed_copy:yes
uncompressed_used_capacity:1.0MB
lsvdiskdependentmaps
Use the lsvdiskdependentmaps command to display all FlashCopy mappings with target volumes that are
dependent upon data held on the specified volume.
Syntax
lsvdiskdependentmaps vdisk_id
vdisk_name
Parameters
vdisk_id | vdisk_name
(Required) Specifies the name or ID of a volume.
Description
The lsvdiskdependentmaps command displays FlashCopy mappings that have target volumes that are
dependent upon data held on the specified vdisk_id | vdisk_name. This can be used to determine whether
a FlashCopy mapping can be prepared. Issue the command for the target volume vdisk_id | vdisk_name of
the FlashCopy mapping to be prepared. If no FlashCopy mappings are returned, the FlashCopy mapping
can be prepared. Any FlashCopy mappings that are returned in the list must be stopped or be in the
idle_or_copied state, before the new FlashCopy mapping can be prepared.
lsvdiskextent
Use the lsvdiskextent command to list the MDisk extents provided for the specified volumes.
vdisk_name
vdisk_id
Parameters
-copy copy_id
(Optional) Displays a list of MDisks that are members of the specified volume copy.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The lsvdiskextent command displays a list of MDisk IDs and the number of extents that each MDisk
provides to the specified volumes.
Each volume is constructed from one or more MDisks. To determine the relationship between a volume
and its MDisks, issue the following command:
where vdisk_name | vdisk_id is the name or ID of the volume. This command displays a list of MDisk IDs
that make up the volume.
To determine the number of extents that are provided by each MDisk, issue the following command:
where vdisk_name | vdisk_id is the name or ID of the volume. This command displays a table of MDisk
IDs and the corresponding number of extents that each MDisk provides as storage for the given volume.
To determine the relationship between MDisks and volumes, issue the following command for each
MDisk:
516 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
where mdisk_name | mdisk_id is the name or ID of the MDisk. This command displays a list of IDs that
corresponds to the volumes that are using this MDisk.
To determine the relationship between MDisks and volumes, and the number of extents that are used by
each volume, you must use the command-line interface. For each MDisk, issue the following command:
where mdisk_name | mdisk_id is the name or ID of the MDisk. This command displays a table of volume
IDs and the corresponding number of extents that are used by each volume.
An invocation example
lsvdiskextent -delim : vdisk0
lsvdiskfcmapcopies
Use the lsvdiskfcmapcopies command to display a list of all FlashCopy mappings with a target volume
containing a valid copy of the specified volume.
Syntax
lsvdiskfcmapcopies vdisk_name
-nohdr -delim delimiter vdisk_id
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command returns a list of the FlashCopy mappings that have a target volume with a valid copy of
the specified volume. The target volumes of these mappings can be considered as candidate source
volumes for mappings to restore from.
The mappings returned are in the copying, idle_copied, or stopping state with 100% progress.
An invocation example
lsvdiskfcmapcopies -delim : 0
lsvdiskfcmappings
Use the lsvdiskfcmappings command to display a list of FlashCopy mappings to which the volume
belongs. A volume can be part of up to 256 FlashCopy mappings.
Syntax
lsvdiskfcmappings vdisk_name
vdisk_id
Parameters
vdisk_name | vdisk_id
(Required) Specifies the name or ID of the volume for which a list of all FlashCopy mappings is
required.
Description
The lsvdiskfcmappings command returns a list of all FlashCopy mappings that the volume is a member
of. The list is returned in no particular order.
An invocation example
lsvdiskfcmappings -delim : vdisk2
lsvdiskhostmap
Use the lsvdiskhostmap command to list the VDisks (volumes) to the host mapping. These hosts have the
specified volumes mapped to them; the volumes is visible to these hosts.
Syntax
lsvdiskhostmap vdisk_id
-nohdr -delim delimiter vdisk_name
518 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a list of host IDs and names. These hosts have the specified volume mapped to
them; that is, the volume is visible to these hosts. The SCSI LUN ID is also displayed. The SCSI LUN ID
is the ID by which the volume is recognized by the host.
Determining the host that a volume is mapped to: List the hosts that this volume is mapped to, by
issuing the following command:
where vdisk_id | vdisk_name is the name or ID of the volume. A list is displayed. Look for the host name
or ID to determine which host this volume is mapped to. If no data is displayed, the volume is not
mapped to any hosts.
lsvdisklba
Use the lsvdisklba command to list the volume and logical block address (LBA) for the specified MDisk
LBA.
Syntax
lsvdisklba -mdisklba mdisklba
-delim delimiter - nohdr
-mdisk mdisk_id
mdisk_name
Parameters
-mdisklba mdisklba
(Required) Specifies the 64-bit hexadecimal LBA on the MDisk. The LBA must be specified in hex,
with a 0x prefix.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
The lsvdisklba command returns the LBA of the volume that is associated with the MDisk LBA.
If applicable, the command also lists the range of LBAs on both the volume and MDisk that are mapped
in the same extent, or for space-efficient disks, in the same grain.
520 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
The vdisk_lba field provides the corresponding LBA on the virtual capacity for the input LBA. For
compressed volume copies it is blank, and the system provides the ranges of virtual LBAs that are
compressed into the input LBA.
An invocation example
lsvdisklba -mdisk 1 -mdisklba 0x100123
lsvdiskmember
Use the lsvdiskmember command to display a list of MDisks that are members of the specified volume.
Syntax
lsvdiskmember
-copy copy_id -nohdr -delim delimiter
vdisk_id
vdisk_name
Parameters
-copy copy_id
(Optional) Displays a list of MDisks that are members of the specified volume copy.
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays a list of managed disks, which provide extents that make up the volume that is
specified by the ID.
Every volume is constructed from one or more MDisks. At times, you might have to determine the
relationship between the two objects. The following procedure allows you to determine the relationships.
If you use the lsmdiskmember command, the concise view displays a list of volumes. These are the
volumes that are using extents on the managed disk that is specified by the ID. The list displays the
members of the respective object and is independent of the state of the individual members; that is, if
they are in offline state, they are still displayed.
To determine the relationship between volumes and MDisks, issue the following command:
where vdisk_id | vdisk_name is the name or ID of the volume. This displays a list of IDs that correspond
to the MDisks that make up the volume.
To determine he relationship between volumes and MDisks, and the number of extents that are provided
by each MDisk, you must use the command-line interface. Issue the following command:
where vdisk_id | vdisk_name is the name or ID of the volume. This displays a table of MDisk IDs and the
corresponding number of extents that each MDisk provides as storage for the specified volume.
To determine the relationship between MDisks and volumes, issue the following command:
where mdisk_id | mdisk_name is the name or ID of the MDisk. This displays a list of IDs that correspond
to the volumes that are using this MDisk.
To determine he relationship between MDisks and volumes, and the number of extents that are used by
each volume, you must use the command-line interface. For a specified MDisk, issue the following
command:
where mdisk_id | mdisk_name is the name or ID of the MDisk. This displays a table of volume IDs and the
corresponding number of extents that are used by each volume.
522 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example
lsvdiskmember 1
lsvdiskprogress
Use the lsvdiskprogress command to track the progress during new volume formatting.
Syntax
lsvdiskprogress
-nohdr -delim delimiter vdisk_id
vdisk_name
Parameters
-nohdr
(Optional) By default, headings are displayed for each column of data in a concise style view, and for
each item of data in a detailed style view. The -nohdr parameter suppresses the display of these
headings.
Description
This command displays the progress of the format of a new volume as a completed percentage. If the
volume has multiple copies, the command reports the average progress of the format.
An invocation example
lsvdiskprogress -delim : 0
lsvdisksyncprogress
Use the lsvdisksyncprogress command to display the progress of volume copy synchronization.
Parameters
-copy id
(Optional) Specifies the volume copy ID to list synchronization progress for. You must also specify a
vdisk_name | vdisk_id value. If you do not specify this parameter, progress is displayed for all copies.
vdisk_name | vdisk_id
(Optional) Specifies the volume name or ID to list synchronization progress for.
Description
To display the volume copies that require synchronization, specify the command with no parameters. To
display the synchronization progress for all copies of a volume, specify the command with the vdisk_name
| vdisk_id parameter. Estimated completion time is displayed in the YYMMDDHHMMSS format. The command
displays progress for the following special cases as:
v A synchronized copy displays a progress of 100 and a blank estimated completion time.
v An offline copy or a copy with a zero synchronization rate displays a blank estimated completion time.
An offline copy displays (gradually) decreasing progress if the volume is being written to.
v Nonmirrored volumes are displayed as a single copy with a progress of 100, and a blank estimated
completion time.
The lsvdisksyncprogress command also displays the progress of a mirrored volume synchronization.
After you create a mirrored volume using the mkvdisk or addvdiskcopy command, you can use the
command to monitor the progress of the synchronization.
An invocation example
lsvdisksyncprogress
An invocation example
lsvdisksyncprogress vdisk0
lsdependentvdisks
Use the lsdependentvdisks command to view which volumes go offline if you remove a specific piece of
hardware from the system.
524 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Syntax
lsdependentvdisks -delim delimiter
-node node_id_or_name
-controller controller_id_or_name_list
-mdisk mdisk_id_or_name_list
-drive drive_id_list
-enclosure enclosure_id -canister canister_id
Parameters
-delim delimiter
(Optional) By default in a concise view, all columns of data are space-separated. The width of each
column is set to the maximum possible width of each item of data. In a detailed view, each item of
data has its own row, and if the headers are displayed, the data is separated from the header by a
space. The -delim parameter overrides this behavior. Valid input for the -delim parameter is a
one-byte character. If you enter -delim : on the command line, the colon character (:) separates all
items of data in a concise view; for example, the spacing of columns does not occur. In a detailed
view, the data is separated from its header by the specified delimiter.
-node
(Optional) Specifies the node for which volume dependency is required.
-controller
(Optional) Specifies the controllers for which volume dependency is required.
-mdisk
(Optional) Specifies the MDisks for which volume dependency is required.
-drive
(Optional) Specifies the drives for which volume dependency is required. There is a maximum of 128
entries.
-enclosure
(Optional) Specifies the enclosure for which volume dependency is required. You can remove a
control enclosure without affecting your other data.
-canister
(Optional) Specifies an enclosure canister if -enclosure. This option is not valid for any other type.
Description
Use this command to view which volumes go offline if you remove a specific piece of hardware from the
system. Use this command before you perform maintenance, to determine which volumes are affected.
An invocation example
lsdependentvdisks -delim : -drive 0:1
Note: This means that if drives 0 and 1 are removed, then volume vdisk4 and volume vdisk5 will go
offline.
Note: The first syntax diagram depicts the creation of a sequential or striped mode volume. The second
syntax diagram depicts the creation of an image mode volume.
| Syntax
|
| -size disk_size -accessiogrp iogrp_id_list -fmtdisk
iogrp_name_list
|
| -rsize disk_size
disk_size_percentage% -warning disk_size -autoexpand 32
auto disk_size_percentage% -grainsize 64
128
256
|
| -compressed -copies num_copies -mirrorwritepriority latency
-createsync -syncrate rate redundancy
|
| -mdisk mdisk_id_list -node node_name mb -name new_name_arg
mdisk_name_list node_id -unit b
kb
gb
tb
pb
|
| readwrite -tier generic_ssd -easytier on
-cache none generic_hdd off
|
-size disk_size -accessiogrp iogrp_id_list -fmtdisk
iogrp_name_list
-rsize disk_size
disk_size_percentage% -warning disk_size -autoexpand 32
auto disk_size_percentage% -grainsize 64
128
256
-import -copies num_copies -syncrate rate -mirrorwritepriority latency -udid vdisk_udid
redundancy
-vtype image -mdisk mdisk_id_list -node node_name mb -name new_name_arg
mdisk_name_list node_id -unit b
kb
gb
tb
pb
readwrite -tier generic_ssd -easytier
-cache none generic_hdd on
off
526 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Parameters
-mdiskgrp mdisk_group_id_list | mdisk_group_name_list
(Required) Specifies one or more managed disk groups (storage pools) to use when you are creating
this volume. If you are creating multiple copies, you must specify one managed disk group per copy.
The primary copy is allocated from the first managed disk group in the list.
-iogrp io_group_id | io_group_name
(Required) Specifies the I/O group (node pair) with which to associate this volume.
Remember:
v Create the first compressed volume copy for an I/O group to activate compression.
v You cannot create or move a volume copy that is compressed to an I/O group that contains at least
one node that does not support compressed volumes. You must select another I/O group to move
the volume copy to (but this does not affect moving to the recovery I/O group).
-accessiogrp iogroup_id_list | iogroup_name_list
(Optional) Specifies the members of the volume I/O group access set. If this option is not specified,
only the caching I/O group is added to the volume I/O group access set. If any access I/O groups
are specified, only those I/O groups are in the access set (including if that set does not include the
caching I/O group).
-udid vdisk_udid
(Optional) Specifies the unit number (udid for the disk. The udid is an identifier that is required to
support OpenVMS hosts; no other systems use this parameter. Valid options are a decimal number 0 -
32 767, or a hexadecimal number 0 - 0x7FFF. A hexadecimal number must be preceded by 0x (for
example, 0x1234).
-size disk_size
(Required for sequential or striped volume creation) (Optional for image volume creation) Specifies
the capacity of the volume, which is used with the value of the unit. All capacities, including
changes, must be in multiples of 512 bytes. An error occurs if you specify a capacity that is not a
multiple of 512, which can only happen when byte units (-b) are used. However, an entire extent is
reserved even if it is only partially used. The default capacity is in MB. You can specify a capacity of
0. Specify the size in bytes in multiples of logical block address (LBA) sizes.
Note: If you do not specify the -size parameter when you create an image mode disk, the entire
MDisk capacity is used.
-rsize disk_size | disk_size_percentage% | auto
(Optional) Defines how much physical space is initially allocated to the space-efficient volume
(thin-provisioned volume). This parameter makes the volume space-efficient; otherwise, the volume is
fully allocated. Specify the disk_size | disk_size_percentage value using an integer, or an integer
immediately followed by the percent character (%). Specify the units for a disk_size integer using the
-unit parameter; the default is MB. The -rsize value can be greater than, equal to, or less than the
size of the volume. The auto option creates a volume copy that uses the entire size of the MDisk; if
you specify the -rsize auto option, you must also specify the -vtype image option.
-fmtdisk
(Optional) Specifies that the volume be formatted before it can be used. The -fmtdisk parameter
formats (sets to all zeros) the extents that make up this volume after it is created. If this parameter is
used, the command completes asynchronously; you can query the status using the lsvdiskprogress
command.
The -fmtdisk parameter is not required when creating space-efficient volumes. Space-efficient
volumes return zeros for extents that have not been written to.
The -fmtdisk parameter synchronizes mirrored copies by default.
Note: You cannot specify this parameter with the -vtype image parameter.
528 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-vtype seq | striped | image
(Optional) Specifies the virtualization type. When creating sequential or image mode volumes, you
must also specify the -mdisk parameter. The default virtualization type is striped.
-node node_id | node_name
(Optional) Specifies the preferred node ID or the name for I/O operations to this volume. You can
use the -node parameter to specify the preferred access node.
Note: This parameter is required for the subsystem device driver (SDD). The system chooses a
default if you do not supply this parameter.
-unit b | kb | mb | gb | tb | pb
(Optional) Specifies the data units to use in conjunction with the capacity that is specified by the
-size and -rsize parameters. The default unit type is MB.
-mdisk mdisk_id_list | mdisk_name_list
(Optional) Specifies one or more managed disks. For sequential and image mode volumes, the
number of MDisks must match the number of copies. For sequential mode volumes, each MDisk
must belong to the specified storage pool. For striped volumes, you cannot specify the -mdisk
parameter if the -copies value is greater than 1. When creating a single copy striped volume, you can
specify a list of MDisks to stripe across.
-name new_name_arg
(Optional) Specifies a name to assign to the new volume.
-cache readwrite | none
| (Optional) Specifies the caching options for the volume. Valid entries are:
| v readwrite to enable the cache for the volume
| v none to disable the cache mode for the volume
-tiergeneric_ssd | generic_hhd
(Optional) Specifies the MDisk tier when an image mode copy is added.
generic_ssd
Refers to storage that uses solid-state drive technology
generic_hdd
Refers to storage that uses hard-disk drive technology
Note: This applies to both copies if you are creating mirrored volume with two image mode copies
using this command.
-easytier on | off
Determines if the IBM(r) System Storage(r) Easy Tier(tm) function is allowed to move extents for this
volume.
Description
This command creates a new volume object. You can use the command to create a variety of types of
volume objects, making it one of the most complex commands.
You must decide which managed disk group or groups provide the storage for the volume. Use the
lsmdiskgrp command to list the available managed disk groups and the amount of free storage in each
group. If you are creating a volume with more than one copy, each storage pool that you specify must
have enough space for the size of the volume.
Important: The extent size for the storage pool can limit volume size. Consider the maximum volume
size you want to use when creating storage pools. Refer to the information on creating storage pools for a
comparison of the maximum volume capacity for each extent size. The maximum is different for
space-efficient volume (thin-provisioned volumes).
Choose an I/O group for the volume. This determines which nodes in the system process the I/O
requests from the host systems. If you have more than one I/O group, ensure that you distribute the
volumes between the I/O groups so that the I/O workload is shared evenly between all nodes. Use the
lsiogrp command to show the I/O groups and the number of volumes that are assigned to each I/O
group.
Note: It is normal for systems with more than one I/O group to have storage pools that have volumes in
different I/O groups. FlashCopy processing can make copies of volumes whether the source and target
530 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
volumes are in the same I/O group. If, however, you plan to use intra-system Metro or Global Mirror
operations, ensure that both the master and auxiliary volume are in the same I/O group.
Specify the virtualization type using the -vtype parameter; the supported types are sequential (seq),
striped, and image.
sequential (seq)
This virtualization type creates the volume using sequential extents from the specified MDisk (or
MDisks, if creating multiple copies). The command fails if there are not enough sequential extents
on the specified MDisk.
striped
This is the default virtualization type. If the -vtype parameter is not specified, striped is the
default; all managed disks in the managed disk group are used to create the volume. The striping
is at an extent level; one extent from each managed disk in the group is used. For example, a
managed disk group with 10 managed disks uses one extent from each managed disk, then it
uses the 11th extent from the first managed disk, and so on.
If the -mdisk parameter is also specified, you can supply a list of managed disks to use as the
stripe set. This can be two or more managed disks from the same managed disk group. The same
circular algorithm is used across the striped set. However, a single managed disk can be specified
more than once in the list. For example, if you enter -mdisk 0:1:2:1, the extents are from the
following managed disks: 0, 1, 2, 1, 0, 1, 2, and so forth. All MDisks that are specified in the
-mdisk parameter must be in the managed mode.
A capacity of 0 is allowed.
image This virtualization type allows image mode volumes to be created when a managed disk already
has data on it, perhaps from a previrtualized subsystem. When an image mode volume is created,
it directly corresponds to the (previously unmanaged) managed disk that it was created from.
Therefore, with the exception of space-efficient image mode volumes, volume logical block
address (LBA) x equals managed disk LBA x. You can use this command to bring a
nonvirtualized disk under the control of the system. After it is under the control of the system,
you can migrate the volume from the single managed disk. When it is migrated, the volume is no
longer an image mode volume.
You can add image mode volumes to an already populated storage pool with other types of
volumes, such as a striped or sequential.
Important: An image mode volume must be 512 bytes or greater. At least one extent is allocated
to an image mode volume.
You must use the -mdisk parameter to specify an MDisk that has a mode of unmanaged. The
-fmtdisk parameter cannot be used to create an image mode volume.
Remember: If you create a mirrored volume from two image mode MDisks without specifying a
-size value, the capacity of the resulting volume is the smaller of the two MDisks, and the
remaining space on the larger MDisk is not accessible.
Table 78 provides the relationship of the rate value to the data copied per second.
Table 78. Relationship between the rate value and the data copied per second
User-specified rate attribute value Data copied/sec
1 - 10 128 KB
11 - 20 256 KB
21 - 30 512 KB
31 - 40 1 MB
41 - 50 2 MB
51 - 60 4 MB
61 - 70 8 MB
71 - 80 16 MB
81 - 90 32 MB
91 - 100 64 MB
An invocation example
mkvdisk -mdiskgrp Group0 -size 0
-iogrp 0 -vtype striped -mdisk mdisk1 -node 1
An invocation example
532 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
An invocation example for creating a space-efficient volume
mkvdisk -mdiskgrp Group0 -iogrp 0 -vtype striped -size 10 -unit gb -rsize 20% -autoexpand -grainsize 32
An invocation example for creating a volume with I/O groups 0 and 1 in its I/O
group access set
mkvdisk -iogrp 0 -mdiskgrp 0 -size 500 -accessiogrp 0:1
mkvdiskhostmap
Use the mkvdiskhostmap command to create a new mapping between a VDisk (volume) and a host, which
makes the volume accessible for input/output (I/O) operations to the specified host.
Syntax
mkvdiskhostmap -host host_id
-force host_name -scsi scsi_num_arg
vdisk_name
vdisk_id
Parameters
-force
(Optional) Allows multiple volume-to-host assignments, which are not normally allowed.
-host host_id | host_name
(Required) Specifies the host to map the volume to, either by ID or by name.
-scsi scsi_num_arg
(Optional) Specifies the Small Computer System Interface (SCSI) logical unit number (LUN) ID to
assign to this volume on the given host. The scsi_num_arg parameter contains the SCSI LUN ID that
is assigned to the volume on the given host for all I/O groups that provide access to the volume. You
must check your host system for the next available SCSI LUN ID on the given host bus adapter
(HBA). If you do not specify the -scsi parameter, the next available SCSI LUN ID in each I/O group
that provides access is provided to the host.
vdisk_name | vdisk_id
(Required) Specifies the name of the volume that you want to map to the host, either by ID or by
name.
534 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Description
This command creates a new mapping between the volume and the specified host. The volume is
presented to the host as if the disk is directly attached to the host. It is only after this command is
processed, that the host can perform I/O transactions to the volume.
Optionally, you can assign a SCSI LUN ID to the mapping. When the HBA in the host scans for devices
that are attached to it, it discovers all volumes that are mapped to its Fibre Channel ports. When the
devices are found, each one is allocated an identifier (SCSI LUN ID). For example, the first disk found is
usually SCSI LUN 1, and so on. You can control the order in which the HBA discovers volumes by
assigning the SCSI LUN ID, as required. If you do not specify a SCSI LUN ID, the cluster automatically
assigns the next available SCSI LUN ID, if any mappings already exist with that host. When you issue
the mkvdiskhostmap command, the assigned SCSI LUN ID number is returned.
If you generate different SCSI LUN IDs, only one is returned. The returned ID is for the
highest-numbered I/O group to which the volume was mapped. To view other values, issue
lshostvdiskmap or lsvdiskhostmap.
The SCSI LUN ID is used for the highest numbered I/O group to which the volume is mapped. < !--
Note: The command fails if the volume is accessible through more than one I/O group and the host
being mapped is known to the system.
-->
Some HBA device drivers stop when they find a gap in the SCSI LUN IDs. For example:
v Volume 1 is mapped to Host 1 with SCSI LUN ID 1
v Volume 2 is mapped to Host 1 with SCSI LUN ID 2
v Volume 3 is mapped to Host 1 with SCSI LUN ID 4
When the device driver scans the HBA, it must stop after identifying volumes 1 and 2, because no SCSI
LUN is mapped with ID 3. For optimal performance, ensure that the SCSI LUN ID allocation is
contiguous.
You can create multiple volume assignments. Normally, multiple volume-to-host assignments are not
used because corruption is likely to occur if more than one host can access a disk. However, in certain
multiple path environments, such as in the IBM SAN File System, a volume must be mapped to more
than one host. To map to more than one host, you must use the mkvdiskhostmap command with the
-force parameter. For example:
mkvdiskhostmap -host host1 -force 4
mkvdiskhostmap -host host2 -force 4
These commands create two host-to-volume mappings for Volume 4 that map to host1 and host2.
Omitting the -force parameter causes the mapping to fail if that volume is already mapped to a host.
The command also fails if the host object (to which this mapping is being made) is not associated with
the I/O group containing the volume.
movevdisk
Use the movevdisk command to move the caching I/O group of a volume.
Syntax
movevdisk -iogrp iogrp_id
iogrp_name -force -node node_id
node_name
vdisk_id
vdisk_name
Parameters
-iogrp iogrp_id | iogrp_name
(Required) Specifies the I/O group to move the volume to.
-force
(Optional) Use the force parameter to force the volume to be removed from an I/O group. This
option overrides the cache flush mechanism.
Remember:
v If the you specify the -force parameter the contents of the cache are discarded and the volume
might be corrupted by the loss of the cached data. Use the -force parameter with caution.
v If the force parameter is used to move a volume that has out-of-sync copies, a full
resynchronization is required.
-node node_id | node_name
(Optional) Specifies the node ID or name in the new I/O group that is assigned as the preferred
node.
vdisk_id | vdisk_name
(Required) Specifies the volume to move.
Description
Use the movevdisk command to migrate a single volume to a new I/O group. Repeat for other volumes
as required.
The movevdisk command does not change which I/O groups can access the volume - only the caching
I/O group is changed. You can move a volume that is in a Flash Copy (FC) mapping, but the FC bitmaps
remain in the original I/O group. You cannot move the volumes cannot when the FC mapping is in
preparing or prepared state. Additionally, a volume cannot be moved if it is the target of a FC mapping
that is in stopping state.
| Note: You can not move a volume in a Global Mirror or Metro Mirror relationship, regardless of whether
| it is a primary, secondary, or change volume. To move a volume in a Global Mirror or Metro Mirror
| relationship, the relationship must first be deleted.
536 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
If your system is running with more than one I/O group, you can (non-disruptively) change the
preferred node using the movevdisk command.
A compressed volume can also be moved, and you can also specify the preferred node in the new I/O
group.
If the volume is offline, use one of the recovervdisk commands to recover the volume and bring it back
online. To specify a preferred node for the volume, use the -node node_id | node_name parameter with
the movevdisk command. Use the movevdisk command to change the I/O group with which this volume
is associated.
Remember: To avoid data loss, make sure that the I/O group is online before moving the volume.
v An offline volume to the recovery I/O group
Use of the recovery I/O group is not required. Instead, use one of the recovervdisk commands to recover
the volume and bring it back online.
You can migrate a volume to a new I/O group to manually balance the workload across the nodes in the
clustered system. You might end up with a pair of nodes that are overworked and another pair that are
underworked.
An invocation example to move DB_Volume to I/O group IOGRP3 with a new preferred
node id 7
movevdisk -iogrp IOGRP3 -node 7 DB_Volume
recovervdisk
Use the recovervdisk command to acknowledge VDisk (volume) data loss and brings the volume back
online.
Syntax
recovervdisk vdisk_name
-copy copy_id vdisk_id
Parameters
vdisk_name | vdisk_id
(Required) Specifies the virtual disk to recover.
-copy copy_id
(Optional) Specifies the ID of the copy to recover.
The specified volume, and all copies if mirrored, are recovered and brought back online. If the volume is
space-efficient or has space-efficient copies, this command triggers the space-efficient repair process. If the
volume is mirrored, the recovervdisk command triggers a resynchronization from a synchronized copy.
The progress of the resynchronization can be monitored using the lsvdisksyncprogress command. The
volume remains online during the resynchronization process.
The recovervdisk command also starts the repair of any space-efficient copies that have a fast_write_state
of corrupt. The progress of the repair process can be monitored using the lsrepairsevdiskcopyprogress
command.
A volume that is still offline because it is being repaired following the recovervdisk command has a
fast_write_state of repairing. The volume is brought online when the repair process is complete.
recovervdiskbycluster (Discontinued)
Attention: The recovervdiskbycluster command has been discontinued. Use the recovervdiskbysystem
command instead.
recovervdiskbyiogrp
Use the recovervdiskbyiogrp command to acknowledge data loss for all VDisks (volumes) in the
specified I/O group with a fast_write_state of corrupt and brings the volumes back online.
Syntax
recovervdiskbyiogrp io_group_name
io_group_id
Parameters
io_group_name | io_group_id
(Required) Specifies the I/O group for virtual disk recovery.
Description
All volumes in the specified I/O group that have a fast_write_state of corrupt; and all copies, if mirrored,
are recovered and brought back online. If any of the volumes are space_efficient or have space_efficient
copies, the recovervdiskbyiogrp command triggers the space-efficient repair process. If volumes are
mirrored, the command triggers a resynchronization from a synchronized copy. The progress of the
resynchronization can be monitored by using the lsrepairsevdiskcopyprogress command. volumes
remain online during the resynchronization process.
If none of the volumes in the specified I/O group have a fast_write_state of corrupt, the
recovervdiskbyiogrp command still starts the repair process for any corrupt copies of mirrored volumes.
The progress of the repair process can be monitored using the lsrepairsevdiskcopyprogress command. If
there are no corrupt volumes or no repairs to copies are required, no error is returned.
538 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
volumes that are still offline because they are being repaired following the recovervdiskbyiogrp
command have a fast_write_state of repairing. volumes are brought online when the repair process is
complete.
An invocation example
recovervdiskbyiogrp iogrp2
recovervdiskbysystem
Use the recovervdiskbysystem command to acknowledge data loss for all VDisks (volumes) in the
clustered system (system) with a fast_write_state of corrupt and brings the volumes back online.
Syntax
recovervdiskbysystem
Parameters
Description
All volumes in the system that have a fast_write_state of corrupt; and all copies, if mirrored, are
recovered and brought back online. If any of the volumes are space-efficient or have space-efficient
copies, the recovervdiskbysystem command triggers the space-efficient repair process. If volumes are
mirrored, the command triggers a resynchronization from a synchronized copy. The progress of the
resynchronization can be monitored by using the lsvdisksyncprogress command. Volumes remain online
during the resynchronization process.
If none of the volumes in the system have a fast_write_state of corrupt, the recovervdiskbysystem
command still starts the repair process for any corrupt copies of mirrored volumes. The progress of the
repair process can be monitored using the lsrepairsevdiskcopyprogress command. If there are no
corrupt volumes or no repairs to copies are required, no error is returned.
Volumes that are still offline because they are being repaired following the recovervdiskbysystem
command have a fast_write_state of repairing. Volumes are brought online when the repair process is
complete.
An invocation example
recovervdiskbysystem
repairsevdiskcopy
The repairsevdiskcopy command repairs the metadata on a space-efficient volume copy or a compressed
volume copy.
Parameters
-copy 0 | 1
(Optional) Specifies the volume copy to repair.
vdisk_name | vdisk_id
(Required) Specifies the volume to repair.
Description
Running the command automatically detects corrupted metadata. The command holds the volume offline
during the repair, but does not prevent the disk from being moved between I/O groups.
If a repair operation completes successfully and the volume was previously offline because of corrupted
metadata, the command brings the volume back online. The only limit on the number of concurrent
repair operations is the number of virtual disk copies in the configuration. Once started, a repair
operation cannot be paused or canceled; the repair can only be ended by deleting the copy.
An invocation example
repairsevdiskcopy vdisk8
repairvdiskcopy
Use the repairvdiskcopy command to detect and (optionally) correct any VDisk (volume) copies that are
not identical.
Syntax
repairvdiskcopy -medium vdisk_name
-resync -startlba lba vdisk_id
-validate
Parameters
-medium
(Optional) Converts sectors that contain different readable data into virtual medium errors on the
specified volume. It fixes preexisting medium errors found on only one volume copy by replacing
them with data from the other volume copy. This parameter cannot be used with the -validate and
-resync parameters. You must specify one of the three parameters.
-resync
(Optional) Corrects sectors that contain different readable data by copying contents from the primary
volume copy to other copies on the specified volume. It fixes preexisting medium errors found on
540 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
only one volume by replacing them with data from the other volume. This parameter cannot be used
with the -medium and -validate parameters. You must specify one of the three parameters.
-validate
(Optional) Reports the first difference in readable data found on synchronized online copies of the
specified volume, on or after the specified -startlba value. This parameter cannot be used with the
-medium and -resync parameters. You must enter one of the three parameters.
-startlba lba
(Optional) Specifies a starting logical block address (LBA) on which to begin the command. The LBA
must be specified in hex, with a 0x prefix.
vdisk_name | vdisk_id
(Required) Specifies the virtual disk to repair. You must specify this parameter last on the command
line.
Description
The repairvdiskcopy command detects and optionally, corrects any volume copies that are not identical.
For the purposes of comparison preexisting medium errors found on only one volume are ignored and
fixed by replacing them with data from the other volume copy. The results are logged to the SAN Volume
Controller error log. The -validate parameter compares synchronized online copies of the specified
volume. The -medium parameter changes any sectors that are not identical into virtual medium errors. The
-resync parameter copies any sectors that are not identical to the other volume copies. The -validate
parameter copies any sectors that are not identical to the other volume copies. You must specify
-validate, -medium, or -resync.
Attention:
1. Before you run the repairvdiskcopy command, ensure that all volume copies are synchronized.
2. Only one repairvdiskcopy command can run on a volume at a time. You must wait for the
repairvdiskcopy command to complete processing before running the command again.
3. Once you start the repairvdiskcopy command, you cannot use the command to stop processing.
4. The primary copy of a mirrored volume cannot be changed while the repairvdiskcopy -resync
command is running.
Use the -startlba parameter to specify a starting Logical Block Address (LBA). Enter an LBA value from
0 to full disk size minus one. The parameter logs the first error found and then stops the command. By
repeating this parameter, you can collect all of the instances where the volume copies are not identical.
During repairvdiskcopy command operation, the volume remains online. The I/O and synchronization
operations are allowed while the command is in progress.
The rate for the repairvdiskcopy command is controlled by the synchronization rate of the volume that is
being repaired. To suspend the repair process, set the synchronization rate of the volume to 0 using the
chvdisk command.
An invocation example
repairvdiskcopy -resync -startlba 0x0 vdisk8
rmvdisk
Use the rmvdisk command to delete a VDisk (volume).
Parameters
-force
(Optional) Deletes the specified volume, even if mappings still exist between this volume and one or
more hosts. This parameter deletes any host-to-volume mappings and any FlashCopy mappings that
exist for this volume. If the -force deletion of a volume causes dependent mappings to be stopped,
any target volumes for those mappings that are in Metro Mirror or Global Mirror relationships are
also stopped. The dependent mappings can be identified by using the lsvdiskdependentmaps
command on the volume that you want to delete.
vdisk_id | vdisk_name
Specifies the name of the volume to delete, either by ID or by name.
Note: To deactivate compression, delete the last compressed volume copy for an I/O group.
Description
This command deletes an existing managed mode volume or an existing image mode volume. The
extents that made up this volume are returned to the pool of free extents that are available on the
managed disk group, if the volume is in managed mode.
Attention: Any data that was on the volume is lost. Before you issue this command, ensure that the
volume (and any data that resides on it) is no longer required.
When you use this command to delete a managed mode volume, all the data on the volume is deleted.
The extents that make up the volume are returned to the pool of free extents that are available in the
managed disk group.
If host mappings exist for the volume, or if any FlashCopy mappings would be affected, the deletion
fails. You can use the-force parameter to force the deletion. If you use the -force parameter, mappings
that have the volume as source or target are deleted, other mappings in a cascade might be stopped, and
then the volume is deleted. The -force parameter also deletes any Metro Mirror or Global Mirror
relationships that exist for the specified volume.
If the volume is in the process of migrating to an image mode volume (using the migratetoimage
command), the deletion fails unless you use the -force parameter. If you use the -force parameter, the
migration is halted and then the volume is deleted. Before you issue this command, ensure that the
volume (and any data that resides on it) is no longer required.
If the volume is mirrored and one or both copies is in image mode, you must first wait for all fast-write
data to be moved to the controller logical unit. This ensures that the data on the controller is consistent
with the data on the image mode volume before the volume is deleted. This process can take several
minutes to complete, and is indicated by the fast_write_state state of the volume being empty. If the
-force parameter is specified, the fast-write data is discarded and the volume is deleted immediately; the
data on the controller logical unit is left inconsistent and unusable. If the copies are not synchronized,
you must use the -force parameter.
542 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
If you run the command while data is in the cache, the system attempts to move the data out of the
cache; this process can time out, however.
If there are any virtual medium errors on the volume, the command fails. You can force the deletion by
using the -force parameter; however, this can cause data integrity problems.
Note: A virtual medium error occurs when you copy data from one disk (the source) to another (the
target). Reading the source indicates that there is a medium error. At that moment, you must have two
identical copies of data and you must then simulate a medium error on the target disk. You can simulate
a medium error on the target disk by creating a virtual medium error on the target disk.
If FlashCopy mappings or host mappings exist for the volume, the deletion fails unless you use the
-force parameter. If you use the -force parameter, mappings are deleted and the volume is deleted. If
there is any data that is not staged in the fast write cache for this volume, the deletion of the volume
fails. When the -force parameter is specified, any data that is not staged in the fast write cache is
deleted. Deleting an image mode volume causes the managed disk that is associated with the volume to
be removed from the managed disk group. The mode of the managed disk is returned to unmanaged.
If the relationship is in consistent_copying or consistent_stopped state, and the change volume is being
used by a Global Mirror relationship using multicycling mode, the relationship moves to
inconsistent_copying or inconsistent_stopped state.
Note: If the relationship is part of a consistency group entire group is affected by this state transition.
The secondary volume becomes corrupt, and inaccessible for host input/output I/O data if:
v A changed volume is part of an idling relationship
v The changed volume is being used for secondary protection
v The background copy process is still migrating the change volume data to the secondary volume
You must issue recovervdisk to gain access to the volume contents once more. If a change volume was
part of an idling relationship and being used for Global Mirror relationship using multicycling mode,
and the relationship was deleted but the background copy process continued and is still migrating data
to the secondary volume then the secondary volume also becomes corrupt. In any of these cases, this
recovervdisk fails without -force being specified.
Note:
v The -force parameter must be used if rmvdisk is specified and rejected if the volume is a change
volume for a relationship.
v If the volume is a change volume for a relationship, specifying rmvdisk with -force removes the
change volume from the relationship.
An invocation example
rmvdisk -force vdisk5
rmvdiskcopy
Use the rmvdiskcopy command to remove a VDisk (volume) copy from a volume.
Parameters
-copy copy_id
(Required) Specifies the ID of the copy to delete.
-force
(Optional) Forces the deletion of the last synchronized copy of a volume, which deletes the entire
volume. The parameter also forces the deletion of a nonmirrored volume, a copy that is migrating to
image mode, or an image-mode copy that has virtual medium errors.
vdisk_name | vdisk_id
(Required) Specifies the virtual disk to delete the copy from. You must specify this parameter last on
the command line.
Description
The rmvdiskcopy command deletes the specified copy from the specified volume. The command fails if all
other copies of the volume are not synchronized; in this case, you must specify the -force parameter,
delete the volume or more, or wait until the copies are synchronized.
An invocation example
rmvdiskcopy -copy 1 vdisk8
rmvdiskaccess
Use the rmvdiskaccess command to delete one or more I/O groups from the set of I/O groups in which
a volume can be made accessible to hosts.
Syntax
rmvdiskaccess -iogrp iogrp_id_list vdisk_id
iogrp_name_list vdisk_name
Parameters
-iogrp iogrp_id_list | iogrp_name_list
(Required) Specifies a list of I/O groups to remove from the I/O group access set of the volume.
vdisk_id | vdisk_name
(Required) Specifies the volume from which to remove access I/O groups.
Description
The rmvdiskaccess command removes I/O groups from the volume access set. However, it cannot
remove all I/O groups from the access set; a volume must have at least one I/O group in an access set.
When an I/O group is removed from the access set, all host mappings created through that I/O group
(for the volume) are deleted. Consequently, you cannot access the volume through any related I/O group
nodes.
544 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Remember: If an I/O group in the list is not in the access set, no error is generated, but no action is
taken for that I/O group.
An invocation example to remove I/O groups 2 and 3 from the volume access set
for volume ID 3
rmvdiskaccess -iogrp 2:3 3
rmvdiskhostmap
Use the rmvdiskhostmap command to delete an existing host mapping the volume is no longer accessible
for input/output (I/O) transactions on the given host.
Syntax
rmvdiskhostmap -host host_id vdisk_id
host_name vdisk_name
Parameters
-host host_id | host_name
(Required) Specifies the host that you want to remove from the map with the volume, either by ID or
by name.
vdisk_id | vdisk_name
(Required) Specifies the name of the volume that you want to remove from the host mapping, either
by ID or by name.
Description
This command deletes an existing mapping between the specified volume and the host. This effectively
stops the volume from being available for I/O transactions on the given host.
This command also deletes a Small Computer System Interface (SCSI) or persistent reservation that a host
has on a volume. Once the reservation is removed, a new host is allowed to access the volume in the
future because the original host no longer has access.
Note: The rmvdiskhostmap command deletes the host mapping for all I/O groups in the access I/O
group set of the volume.
Use caution when you process this command because to the host, it seems as if the volume has been
deleted or is offline.
An invocation example
rmvdiskhostmap -host host1 vdisk8
shrinkvdisksize
Use the shrinkvdisksize command to reduce the size of a VDisk (volume) by the specified capacity.
vdisk_name
vdisk_id
Parameters
-size size_change
(Optional) Specifies the size reduction (change in size) for the designated virtual disk. The -size
parameter cannot be used with the -rsize parameter. You must specify either -size or -rsize.
Important: This parameter does reduce the size of a volume (the specified virtual size capacity).
-rsize size_change
(Optional) Reduces the real size of a space-efficient volume by the specified amount. This indicates
the change in size as a result of the reduction. Specify the size_change value using an integer. Specify
the units for a size_change integer using the -unit parameter; the default is MB. You must specify
either -rsize or -size.
-copy id
(Optional) Specifies the copy to change the real capacity for. You must also specify the -rsize
parameter. If the -copy parameter is not specified, all copies of the volume are reduced. This
parameter is required if the volume is mirrored and only one copy is space-efficient.
-unit b | kb | mb | gb | tb | pb
(Optional) Specifies the data units to be used in conjunction with the value that is specified by the
-size parameter.
vdisk_name | vdisk_id
(Required) Specifies the virtual disk that you want to modify, either by ID or by name.
Description
The shrinkvdisksize command reduces the capacity that is allocated to the particular virtual disk by the
amount that you specify. You cannot shrink the real size of a space-efficient volume below its used size.
All capacities, including changes, must be in multiples of 512 bytes. An entire extent is reserved even if it
is only partially used. The default capacity units are MB.
The command can be used to shrink the physical capacity that is allocated to a particular volume by the
specified amount. The command can also be used to shrink the virtual capacity of a space-efficient
volume without altering the physical capacity assigned to the volume. To change the capacity of a
non-space-efficient disk, use the -size parameter. To change the real capacity of a space-efficient disk, use
the -rsize parameter. To change the virtual capacity of a space-efficient disk, use the -size parameter.
When the virtual size of a space-efficient volume is changed, the warning threshold is automatically
scaled to match. The new threshold is stored as a percentage.
546 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
To run the shrinkvdisksize command on a mirrored volume, all copies of the volume must be
synchronized.
Attention: If the volume contains data that is being used, do not shrink the volume without backing up
the data first.
The clustered system (system) arbitrarily reduces the capacity of the volume by removing a partial, one
or more extents from those allocated to the volume. You cannot control which extents are removed and so
you cannot assume that it is unused space that is removed.
Before you shrink a volume, validate that the volume is not mapped to any host objects. If the volume is
mapped, data is displayed. For example:
lsvdiskhostmap 0
id name SCSI_id host_id host_name vdisk_UID IO_group_id IO_group_name
0 TL_VDISKSTR1 0 0 laura 60050768018282941000000000000000 0 io_grp0
You can determine the exact capacity of the source or master volume by issuing the lsvdisk -bytes
vdiskname command. Shrink the volume by the required amount by issuing the shrinkvdisksize -size
size_change-unit b | kb | mb | gb | tb | pb vdisk_name | vdisk_id command.
Remember:
1. You cannot resize (shrink) an image mode volume.
2. You should not shrink the disk if the virtual disk contains data.
3. You cannot shrink a volume that is part of a file system.
splitvdiskcopy
Use the splitvdiskcopy command to create a separate VDisk (volume) from a synchronized copy of a
mirrored volume.
Syntax
| splitvdiskcopy -copy id
| -iogrp io_group_id
io_group_name
|
| -accessiogrp iogrp_id_list -node node_id
iogrp_name_list node_name
|
| -name new_name -cache readwrite -udid udid
none
| vdisk_name
| -force vdisk_id
|
Parameters
-copy id
(Required) Specifies the ID of the copy to split.
-iogrp io_group_id | io_group_name
(Optional) Specifies the I/O group to add the new volume to. The default is the I/O group of the
specified volume.
-accessiogrp iogroup_id_list | iogroup_name_list
(Optional) Specifies which I/O groups provide access to the volume. If the -accessiogrp parameter is
used, the specified I/O groups provide access even if that set includes either the caching I/O group
of the original volume or the caching I/O group of the new volume. If the flag is not specified and
the original volume has only its caching I/O group in the set of I/O groups that provide access to
the original volume, the new volume is assigned its caching I/O group as the only I/O group that
provides access (which might not be the same as caching I/O group of the original volume).
Otherwise, the new volume provides access using the same set of I/O groups used with the original
mirrored volume.
Note: The I/O groups specified are not required to include the caching I/O group.
-node node_id | node_name
(Optional) Specifies the preferred node ID or the name for I/O operations to this volume. You can
use the -node parameter to specify the preferred access node.
-name new_name
(Optional) Assigns a name to the new volume.
548 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
-cache readwrite | none
| (Optional) Specifies the caching options for the new volume. (Optional) Specifies the caching options
| for the volume. Valid entries are:
| v readwrite to enable the cache for the volume
| v none to disable the cache mode for the volume
-udid udid
(Optional) Specifies the udid for the new volume. The udid is a required identifier for OpenVMS
hosts; no other hosts use this parameter. Supported values are a decimal number 0 - 32767, or a
hexadecimal number 0 - 0x7FFF. A hexadecimal number must be preceded by 0x; for example,
0x1234. The default udid value is 0.
-force
(Optional) Allows the split to proceed even when the specified copy is not synchronized, or even
when the cache flush is likely to fail. The newly created volume might not be consistent.
Description
The splitvdiskcopy command creates a new volume in the specified I/O Group from a copy of the
specified volume. If the copy that you are splitting is not synchronized, you must use the -force
parameter. The command fails if you are attempting to remove the only synchronized copy. To avoid this,
wait for the copy to synchronize or split the unsynchronized copy from the volume by using the -force
parameter. You can run the command when either volume copy is offline.
An invocation example
splitvdiskcopy -copy 1 vdisk8
An invocation example for creating a volume with I/O groups 2 and 3 in it's I/O
group access set
splitvdiskcopy -copy 1 -iogrp 2 -node 7 -accessiogrp 2:3 DB_Disk
The CLI displays a return value upon completion of the command. If the command completes normally
and without error, the return code is 0. If the command fails, the return code is 1 and the Error Code is
sent to standard error. If the command succeeds, but the cluster is operating near its licensed
virtualization limit, the return code can still be 1, and a warning Error Code is sent to standard error.
When a create command is issued, the message ID that has been assigned to the new object is returned as
part of the success message sent to standard output. If the -quiet parameter is used, only the message ID
is sent to standard output.
User response: Specify command completely, and Explanation: The command has completed, but the
resubmit the command. acknowledgement of the command completion contains
a return code that is not defined.
CMMVC5713E Some parameters are mutually User response: Determine whether or not the
exclusive. command has succeeded. If the command has not
succeeded, resubmit the command. If the problem
Explanation: Certain commands have two or more persists, contact IBM technical support for assistance.
parameters that are mutually exclusive. You have
submitted a command using at least two mutually
exclusive parameters. CMMVC5719E A value of VALUE requires the
parameter PARAMETER to be specified.
User response: Specify a supported combination of
parameters, and resubmit the command. Explanation: Certain commands have required
combinations of parameters based on either the entry of
a parameter or the value for a parameter. When you
CMMVC5714E The parameter list is empty. enter the specified value, you must enter the specified
Explanation: Certain parameters require one or more parameter.
values in a colon separated parameter list. You have User response: Specify the required parameter, and
specified at least one parameter without the required resubmit the command.
parameter list.
User response: Specify at least one value for all
parameters that require a value, and resubmit the
command.
552 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5721E • CMMVC5731E
CMMVC5721E VALUE is not a valid time stamp CMMVC5727E VALUE is not a valid filter.
format. The valid time stamp format is
Explanation: You can filter the output of some views
YYMMDDHHMMSS.
by using the -filtervalue parameter. The specified string
Explanation: The specified value is not a valid time that you have entered is not a supported value for the
stamp format. The valid format is YYMMDDHHMMSS. -filtervalue parameter in this view.
User response: Use the correct time stamp format, and User response: Ensure that you use a supported value
resubmit the command. for the -filtervalue parameter, and resubmit the
command.
CMMVC5722E VALUE contains a month value that
is not valid. The valid time stamp CMMVC5728E %1 is not a valid time format. The
format is YYMMDDHHMMSS. valid time format is
MMDDHHmmYYYY with YYYY<2070.
Explanation: The month value (MM) that you have
specified is not valid. Explanation: The specified value should be in the
format MMDDHHmmYYYY with YYYY less than 2070.
User response: Specify a valid month value, and
resubmit the command. User response: Follow the correct format, and
resubmit the command.
CMMVC5723E VALUE contains a day value that is
not valid. The valid time stamp format CMMVC5729E One or more components in the list
is YYMMDDHHMMSS. is not valid.
Explanation: The day value (DD) that you have Explanation: Certain parameters support one or more
specified is not valid. items of data in a colon separated list. At least one of
the items in the list that you have entered is not
User response: Specify a valid day value, and
correct.
resubmit the command.
User response: Ensure that you enter supported
values in the list, and resubmit the command.
CMMVC5724E VALUE contains an hour value that is
not valid. The valid time stamp format
is YYMMDDHHMMSS. CMMVC5730E VALUE is only valid when VALUE
has a value of VALUE .
Explanation: The hour value (HH) that you have
specified is not valid. Explanation: The specified command and parameter
combination that you have entered requires the
User response: Specify a valid hour value, and
specified parameter value.
resubmit the command.
User response: Ensure that you specify the correct
parameter value for the command and parameter
CMMVC5725E VALUE contains a minutes value that
combination that you enter, and resubmit the
is not valid. The valid time stamp
command.
format is YYMMDDHHMMSS.
Explanation: The minutes value (MM) that you have
CMMVC5731E VALUE can only be entered when
specified is not valid.
VALUE has been entered.
User response: Specify a valid minutes value, and
Explanation: Certain commands have required
resubmit the command.
combinations of parameters based either on the
inclusion of a specified parameter, or on the value
CMMVC5726E VALUE contains a seconds value that entered for a specified parameter. When you include
is not valid. The valid time stamp the first specified string in the command, you must
format is YYMMDDHHMMSS. enter the second specified string as a parameter.
Explanation: The seconds value (SS) that you have User response: Ensure that you enter a supported
specified is not valid. combination or parameters and values, and resubmit
the command.
User response: Specify a valid seconds value, and
resubmit the command.
CMMVC5732E The command cannot be initiated CMMVC5739E The argument ARGUMENT does not
because it was not run on the contain enough characters.
configuration node.
Explanation: The field length of the specified
Explanation: The command that you have specified argument is less than the minimum supported field
must be run on the configuration node. length for the argument.
User response: Log off of the node service IP address, User response: Specify the correct argument, and
log on to the management IP address, and run the resubmit the command.
command on the configuration node.
CMMVC5740E The filter flag VALUE is not valid.
CMMVC5733E Enter at least one parameter.
Explanation: You can filter the output of some views
Explanation: You must specify at least one parameter by using the -filtervalue parameter. The specified string
for the command that you have submitted. that you have entered is not a supported value for the
-filtervalue parameter in this view.
User response: Specify at least one parameter, and
resubmit the command. User response: Ensure that you use a supported value
for the -filtervalue parameter, and resubmit the
command.
CMMVC5734E A combination of values was entered
that is not valid.
CMMVC5741E The filter value VALUE is not valid.
Explanation: You have specified a combination of
values that is not correct. Explanation: You can filter the output of some views
by using the -filtervalue parameter. Each filter has an
User response: Specify a supported combination of
associated value. The syntax is -filtervalue filter=value.
values, and resubmit the command.
The specified string that you have entered is not a
supported value for the -filtervalue filter that you
CMMVC5735E The name entered is not valid. Enter specified in this view.
an alphanumeric string that does not
User response: Ensure that you use a supported value
start with a number.
for the -filtervalue filter that you specify, and resubmit
Explanation: The first character of an object name the command.
cannot be numeric.
User response: Specify an alphanumeric string that CMMVC5742E A specified parameter is out of its
does not start with a numeric, and resubmit the valid range.
command.
Explanation: You have entered data that is not in the
range of values that is supported for the parameter that
CMMVC5737E The parameter PARAMETER has been you have entered.
entered multiple times. Enter the
User response: Ensure that you enter data values that
parameter only one time.
are supported for the parameter that you enter, and
Explanation: The specified parameter was entered resubmit the command.
more than once.
User response: Delete all duplicate parameters, and CMMVC5743E A specified parameter does not
resubmit the command. comply with the step value.
Explanation: A parameter was specified that does not
CMMVC5738E The argument ARGUMENT contains comply with the step value.
too many characters.
User response: Specify the correct parameter, and
Explanation: The field length of the specified resubmit the command.
argument is longer than the maximum supported field
length for the argument.
CMMVC5744E Too many objects were specified in
User response: Specify the correct argument, and the command.
resubmit the command.
Explanation: There were too many objects specified in
the command.
User response: Specify the correct object, and resubmit
the command.
554 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5745E • CMMVC5758E
CMMVC5745E Too few objects were specified in the CMMVC5752E Request failed. The object contains
request. child objects, these must be deleted
first.
Explanation: There were not enough objects specified
in the command. Explanation: The operation failed because the
specified object contains child objects.
User response: Specify the correct object, and resubmit
the command. User response: Delete the child objects, and resubmit
the command.
CMMVC5746E The requested operation cannot be
applied to the object specified. CMMVC5753E The specified object does not exist or
is not a suitable candidate.
Explanation: The requested operation is not valid for
this object. Explanation: The specified object does not exist or is
not a suitable candidate.
User response: Specify a valid operation, and
resubmit the command. User response: Specify the correct object, and resubmit
the command.
CMMVC5747E The action requested is invalid -
internal error. CMMVC5754E The specified object does not exist, or
the name supplied does not meet the
Explanation: The operation that was requested is not
naming rules.
valid.
Explanation: The specified object does not exist, or the
User response: Specify the correct operation, and
name of the object does not meet the naming
resubmit the command.
requirements.
User response: Specify the correct object name, and
CMMVC5748E The action requested is invalid -
resubmit the command.
internal error.
Explanation: The operation that was requested is not
CMMVC5755E Cannot create as the sizes of the
valid.
specified objects do not match.
User response: Specify the correct operation, and
Explanation: The sizes of the specified objects do not
resubmit the command.
match.
User response: Not applicable.
CMMVC5749E The dump filename specified already
exists.
CMMVC5756E Cannot perform the request as the
Explanation: The dump file name that was specified
object id is already mapped to another
already exists.
object or is the subject of an FC or RC
User response: Specify a different dump file name, relationship.
and resubmit the command.
Explanation: The operation failed because the
specified object is already mapped.
CMMVC5750E The dump file could not be created -
User response: Specify a different object, and resubmit
the file system is probably full.
the command.
Explanation: The dump file was not created. The file
system might be full.
CMMVC5757E Self Defining Structure (SDS)
User response: Not applicable. defaults not found - internal error.
Explanation: The defaults for the self describing
CMMVC5751E The dump file could not be written structure were not found.
to.
User response: Not applicable.
Explanation: The dump file could not be written to
disk.
CMMVC5758E Object name already exists.
User response: Not applicable.
Explanation: The object name already exists.
User response: Specify a unique object name, and
resubmit the command.
CMMVC5759E An internal error has occurred - CMMVC5769E The requested operation requires all
memory could not be allocated. nodes to be online - one or more nodes
are not online.
Explanation: The memory cannot be allocated.
Explanation: The operation requires that all nodes be
User response: Not applicable.
online. One or more nodes are not online.
User response: Check that each node is online, and
CMMVC5760E Failed to add the node to the cluster
resubmit the command.
member list.
Explanation: The node could not be added to the
CMMVC5770E The SSH key file supplied is invalid.
cluster.
Explanation: The file for the SSH key is not valid.
User response: Not applicable.
User response: Specify a different file, and resubmit
the command.
CMMVC5761E Failed to delete the node from the
cluster member list.
CMMVC5771E The operation requested could not
Explanation: The node could not be deleted from the
complete, usually due to child objects
cluster.
existing. To force the operation, specify
User response: Not applicable. the force flag.
Explanation: The operation failed, probably, because
CMMVC5762E The request did not complete before the object contains child objects.
the timeout period expired.
User response: Specify the -force flag to complete the
Explanation: The operation failed because the timeout operation, and resubmit the command.
period expired.
User response: Resubmit the command. CMMVC5772E The operation requested could not be
performed because an upgrade is in
progress.
CMMVC5763E The node failed to go online.
Explanation: The operation failed because an upgrade
Explanation: The node failed to go online. is in progress.
User response: Not applicable. User response: Wait for the upgrade to complete, and
resubmit the command.
CMMVC5764E The mode change request is invalid -
internal error CMMVC5773E The object selected is in the wrong
Explanation: The specified mode change is not valid. mode to perform the requested
operation.
User response: Specify a different mode, and resubmit
the command. Explanation: The operation failed because the selected
object is in the wrong mode.
CMMVC5765E The object specified is no longer a User response: Specify the correct mode, and resubmit
candidate - a change occurred during the the command.
request.
Explanation: The specified object is no longer a CMMVC5774E The userid supplied is not valid.
candidate. A change occurred during the request. Explanation: The userid is not valid.
User response: Specify a different object, and resubmit User response: Specify a different userid, and
the command. resubmit the command.
CMMVC5767E One or more of the parameters CMMVC5775E The directory attribute specified is
specified are invalid or a parameter is not valid.
missing.
Explanation: The directory attribute is not valid.
Explanation: One or more of the specified parameters
is not valid. User response: Specify a different directory, and
resubmit the command.
User response: Specify the correct parameter, and
resubmit the command.
556 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5776E • CMMVC5790E
CMMVC5776E The directory listing could not be CMMVC5784E The cluster name specified is not
retrieved. unique, specify the cluster using the
cluster ID.
Explanation: The directory listing could not be
retrieved. Explanation: The cluster name is not unique.
User response: Specify a different directory listing, User response: Specify the cluster using the cluster ID,
and resubmit the command. and resubmit the command.
CMMVC5777E The node could not be added to the CMMVC5785E The filename specified contains an
IO Group, because the other node in the illegal character.
IO Group is in the same power domain.
Explanation: The filename contains an illegal
Explanation: The node was not added to the I/O character.
group because the other node in the I/O Group is in
User response: Specify a valid filename, and resubmit
the same power domain.
the command.
User response: Specify a different node from another
I/O group, and resubmit the command.
CMMVC5786E The action failed because the cluster
is not in a stable state.
CMMVC5778E Cannot create another cluster, a
Explanation: The action failed because the cluster is
cluster already exists.
not in a stable state.
Explanation: The cluster was not created because one
User response: Not applicable.
already exists.
User response: Not applicable.
CMMVC5787E The cluster was not created because a
cluster already exists.
CMMVC5780E The action could not be completed
Explanation: The cluster was not created because a
using the Remote Cluster name. Use the
cluster already exists.
Remote Cluster Unique ID instead.
User response: Not applicable.
Explanation: The unique ID of the remote cluster is
required for this command.
CMMVC5788E The service IP address is not valid.
User response: Specify the unique ID of the remote
cluster, and resubmit the command. Explanation: The service IP address is not valid.
User response: Specify the correct service IP address,
CMMVC5781E The cluster ID specified is invalid. and resubmit the command.
Explanation: The cluster ID is not valid.
CMMVC5789E The cluster was not modified because
User response: Specify a different cluster ID, and
the IP address, subnet mask, service
resubmit the command.
address, SNMP address, or gateway
address is not valid.
CMMVC5782E The object specified is offline.
Explanation: The cluster was not modified because the
Explanation: The object is offline. IP address, subnet mask, service address, SNMP
address, or gateway address is not valid.
User response: Specify an object that is online, and
resubmit the command. User response: Specify all correct attributes, and
resubmit the command.
CMMVC5783E The information is not available to
complete this command. CMMVC5790E The node was not added to the
cluster because the maximum number of
Explanation: This error is only returned when the
nodes has been reached.
node is in the service state.
Explanation: The node was not added to the cluster
User response: None.
because the maximum number of nodes has been
reached.
User response: Not applicable.
CMMVC5796E The action failed because the I/O CMMVC5802E The upgrade of the cluster could not
group that the node belongs to is proceed because there is an I/O group in
unstable. the cluster that contains only one node.
The upgrade requires that each node in
Explanation: A previous configuration command
an I/O group be shut down and
might not yet have completed.
restarted. If there is only one node in an
User response: Wait for the previous command to I/O group, I/O operations could be lost
complete, and resubmit the command. if I/O operations are not stopped before
beginning the upgrade.
CMMVC5797E The node was not deleted because Explanation: The upgrade of the cluster could not
this is the last node in the I/O group proceed because there is an I/O group in the cluster
and there are virtual disks (VDisks) that contains only one node. The upgrade requires that
associated with the I/O group. each node in an I/O group be shut down and restarted.
If there is only one node in an I/O group, I/O
Explanation: The specified node is the last node in the operations could be lost if I/O operations are not
I/O group and there are volumes associated with the stopped before beginning the upgrade.
558 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5803E • CMMVC5814E
Explanation: The action failed because the managed Explanation: The quorum index number for the
disk (MDisk) does not exist. managed disk (MDisk) was not set because quorum is
not allowed on one or more associated controllers.
User response: Specify a different MDisk, and
resubmit the command. User response: Specify an MDisk that has quorum
enabled on all of its associated controllers, and
resubmit the command.
CMMVC5815E The managed disk group was not CMMVC5821E The managed disk (MDisk) was not
created because an entity that was added to the MDisk group because not
specified in the command does not enough MDisks were included in the
exist. list.
Explanation: The storage pool was not created Explanation: The managed disk (MDisk) was not
because an entity that was specified in the command added to the storage pool because not enough MDisks
does not exist. were included in the list.
User response: Specify a different entity, and resubmit User response: Include more MDisks in the list, and
the command. resubmit the command.
CMMVC5816E The action failed because an entity CMMVC5822E The managed disk (MDisk) was not
that was specified in the command does added to the MDisk group because too
not exist. many MDisks were included in the list.
Explanation: The action failed because an entity that Explanation: The managed disk (MDisk) was not
was specified in the command does not exist. added to the storage pool because too many MDisks
were included in the list.
User response: Specify a different entity, and resubmit
the command. User response: Delete the extra MDisks in the list, and
resubmit the command.
CMMVC5817E The specified managed disk group
was invalid. CMMVC5823E The managed disk (MDisk) was not
deleted from the MDisk group because
Explanation: The storage pool was not renamed
the MDisk is part of another MDisk
because the name was not valid.
group.
User response: Specify a different storage pool name,
Explanation: The managed disk (MDisk) was not
and resubmit the command.
deleted from the storage pool because the MDisk is
part of another storage pool.
CMMVC5818E The managed disk group was not
User response: Not applicable.
deleted because there is at least one
MDisk in the group.
CMMVC5824E The managed disk (MDisk) was not
Explanation: The storage pool was not deleted
deleted from the MDisk group because
because there is at least one MDisk in the group.
it does not belong to the MDisk group.
User response: Not applicable.
Explanation: The managed disk (MDisk) was not
deleted from the storage pool because it does not
CMMVC5819E The managed disk (MDisk) was not belong to the storage pool.
added to the MDisk group because the
User response: Not applicable.
MDisk is part of another MDisk group.
Explanation: The managed disk (MDisk) was not
CMMVC5825E The managed disk (MDisk) was not
added to the storage pool because the MDisk is part of
deleted from the MDisk group because
another storage pool.
a virtual disk (VDisk) is allocated from
User response: Not applicable. one or more of the specified MDisks. A
forced deletion is required.
CMMVC5820E The managed disk (MDisk) was not Explanation: The managed disk (MDisk) was not
added to the MDisk group because an deleted from the storage pool because a volume is
entity that was specified in the allocated from one or more of the specified MDisks.
command does not exist.
User response: Specify the -force option, and resubmit
Explanation: The managed disk (MDisk) was not the command.
added to the storage pool because an entity that was
specified in the command does not exist.
CMMVC5826E The virtual disk (VDisk) was not
User response: Specify a different entity, and resubmit created because an entity that was
the command. specified in the command does not
exist.
Explanation: The volume was not created because an
560 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5827E • CMMVC5837E
562 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5849E • CMMVC5859E
User response: Not applicable. User response: Specify the correct MDisk, and
resubmit the command.
CMMVC5861E The action failed because there were CMMVC5867E The action failed because the
not enough extents on the managed disk worldwide port name is already
(MDisk). assigned or is not valid.
Explanation: The action failed because there were not Explanation: The action failed because the worldwide
enough extents on the managed disk (MDisk). port name is already assigned or is not valid.
User response: Specify another extent, and resubmit User response: Specify a different worldwide port
the command. name, and resubmit the command.
CMMVC5862E The action failed because the virtual CMMVC5868E The action failed because an entity
disk (VDisk) is being formatted. that was specified in the command does
not exist.
Explanation: The action failed because the volume is
being formatted. Explanation: The action failed because an entity that
was specified in the command does not exist.
User response: Wait for the volume to be successfully
formatted, and resubmit the command. User response: Specify a different entity, and resubmit
the command.
CMMVC5863E The migration failed because there
are not enough free extents on the target CMMVC5869E The host object was not renamed
managed disk (MDisk). because the host ID or name is not
valid.
Explanation: The migration failed because there are
not enough free extents on the target managed disk Explanation: The host object was not renamed because
(MDisk). the host ID or name is not valid.
User response: Specify another free extent, and User response: Specify a different host ID or name,
resubmit the command. and resubmit the command.
CMMVC5864E The extent information was not CMMVC5870E The host object was not deleted
returned because the source extent is not because an entity that was specified in
used. the command does not exist.
Explanation: The extent information was not returned Explanation: The host object was not deleted because
because the source extent is not used. an entity that was specified in the command does not
exist.
User response: Specify a different source extent, and
resubmit the command. User response: Specify the correct entity, and resubmit
the command.
564 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5871E • CMMVC5883E
CMMVC5887E The FlashCopy mapping was not CMMVC5893E The action failed because an entity
created because the source or target that was specified in the command does
virtual disk (VDisk) must not be in not exist.
router mode.
Explanation: The action failed because an entity that
Explanation: The FlashCopy mapping was not created was specified in the command does not exist.
because the source or target volume must not be in
User response: Specify the correct entity, and resubmit
router mode.
the command.
User response: Specify a different source or target
volume, and resubmit the command.
CMMVC5894E The FlashCopy consistency group
was not deleted because you are trying
CMMVC5888E The action failed because an entity to delete consistency group 0 or the
that was specified in the command does name of the consistency group is not
not exist. valid.
Explanation: The action failed because an entity that Explanation: The FlashCopy consistency group was
was specified in the command does not exist. not deleted because the name of the consistency group
is not valid or you are trying to delete consistency
User response: Specify the correct entity, and resubmit
group 0.
the command.
566 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5895E • CMMVC5904E
User response: Specify the correct consistency group, Explanation: The FlashCopy mapping was not deleted
and resubmit the command. because the mapping or consistency group is in the
stopped state.
CMMVC5895E The FlashCopy consistency group User response: Specify the -force option to delete the
was not deleted because it contains mapping.
mappings. To delete this consistency
group, a forced deletion is required.
CMMVC5900E The FlashCopy mapping was not
Explanation: The FlashCopy consistency group was deleted because the mapping or
not deleted because it contains mappings. consistency group is in the suspended
state. The mapping or consistency group
User response: Specify that -force option to delete the
must be stopped first.
consistency group.
Explanation: The FlashCopy mapping was not deleted
because the mapping or consistency group is in the
CMMVC5896E The FlashCopy mapping was not
suspended state. The mapping or consistency group
deleted because the mapping or
must be stopped first.
consistency group is in the preparing
state. The mapping or consistency group User response: Stop the consistency group, and
must be stopped first. resubmit the command.
Explanation: The FlashCopy mapping was not deleted
because the mapping or consistency group is in the CMMVC5901E The FlashCopy mapping was not
preparing state. The mapping or consistency group prepared because the mapping or
must be stopped first. consistency group is already in the
preparing state.
User response: Stop the consistency group, and
resubmit the command. Explanation: The FlashCopy mapping was not
prepared because the mapping or consistency group is
already in the preparing state.
CMMVC5897E The FlashCopy mapping was not
deleted because the mapping or User response: Not applicable.
consistency group is in the prepared
state. The mapping or consistency group
CMMVC5902E The FlashCopy mapping was not
must be stopped first.
prepared because the mapping or
Explanation: The FlashCopy mapping was not deleted consistency group is already in the
because the mapping or consistency group is in the prepared state.
prepared state. The mapping or consistency group must
Explanation: The FlashCopy mapping was not
be stopped first.
prepared because the mapping or consistency group is
User response: Stop the consistency group, and already in the prepared state.
resubmit the command.
User response: Not applicable.
568 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5916E • CMMVC5923E
User response: Not applicable. User response: Perform the following steps:
1. Ensure that at least one of the nodes in the I/O
CMMVC5916E The properties of the FlashCopy group of the mapping is online.
mapping were not modified because the 2. Fix all of the unfixed events in the event log.
mapping or consistency group is in the 3. Follow the fix procedures.
suspended state.
Explanation: The properties of the FlashCopy You might be required to delete and re-add ALL of the
mapping were not modified because the mapping or FlashCopy maps and Global and Metro Mirror
consistency group is in the suspended state. relationships in the I/O group.
CMMVC5917E The FlashCopy mapping was not CMMVC5920E The FlashCopy mapping was not
created because there is no memory in created because the consistency group is
which to create the bitmap. not idle.
Explanation: The FlashCopy mapping was not created Explanation: The FlashCopy mapping was not created
because there is no memory to create the bitmap. because the consistency group is not idle.
User response: Not applicable. User response: Not applicable.
CMMVC5918E The FlashCopy mapping was not CMMVC5921E The properties of the FlashCopy
prepared, either because there are no mapping were not modified because the
online nodes in the I/O group or consistency group is not idle.
because there are unrecovered
FlashCopy mappings or unrecovered Explanation: The properties of the FlashCopy
Global Mirror or Metro Mirror mapping were not modified because the consistency
relationships in the I/O group. group is not idle.
Explanation: This error might be caused by a User response: Not applicable.
temporary loss of all of the nodes in the I/O group,
which causes all of the FlashCopy mappings and
CMMVC5922E The FlashCopy mapping was not
Global and Metro Mirror relationships of the I/O group
created because the destination virtual
to be unusable.
disk (VDisk) is too small.
User response: Perform the following steps:
Explanation: The FlashCopy mapping was not created
1. Ensure that at least one of the nodes in the I/O because the destination volume is too small.
group of the mapping is online.
User response: Specify a different volume, and
2. Fix all of the unfixed events in the event log.
resubmit the command.
3. Follow the fix procedures.
You might be required to delete and re-add ALL of the CMMVC5923E The FlashCopy mapping cannot be
FlashCopy maps and Global and Metro Mirror created, either because there are no
relationships in the I/O group. online nodes in the I/O group or
because there are unrecovered
FlashCopy mappings or unrecovered
Resubmit the command.
Global Mirror or Metro Mirror
relationships in the I/O group.
CMMVC5919E The FlashCopy mapping or
Explanation: This error might be caused by a
consistency group was not started, either
temporary loss of all of the nodes in the I/O group,
because there are no online nodes in the
which causes all of the FlashCopy mappings and
I/O group or because there are
Global and Metro Mirror relationships of the I/O group
unrecovered FlashCopy mappings or
to be unusable.
unrecovered Global Mirror or Metro
Mirror relationships in the I/O group. User response: Perform the following steps:
Explanation: This error might be caused by a 1. Ensure that at least one of the nodes in the I/O
temporary loss of all of the nodes in the I/O group, group of the mapping is online.
which causes all of the FlashCopy mappings and 2. Fix all of the unfixed events in the event log.
Global and Metro Mirror relationships of the I/O group 3. Follow the fix procedures.
to be unusable.
CMMVC5925E The remote cluster partnership was User response: Unlock the master or auxiliary volume,
not created because it already exists. and resubmit the command.
Explanation: The action failed because the cluster ID Explanation: The Remote Copy relationship was not
is not valid. created because the master or auxiliary volume is in the
recovery I/O group.
User response: Specify the correct cluster ID, and
resubmit the command. User response: Not applicable.
CMMVC5928E The action failed because the cluster CMMVC5934E The Remote Copy relationship was
name is a duplicate of another cluster. not created because the master or
auxiliary virtual disk (VDisk) is in the
Explanation: The action failed because the cluster router mode.
name is a duplicate of another cluster.
Explanation: The Remote Copy relationship was not
User response: Specify a different cluster name, and created because the master or auxiliary volume is in the
resubmit the command. router mode.
User response: Not applicable.
CMMVC5929E The Remote Copy partnership was
not deleted because it has already been
deleted. CMMVC5935E The action failed because an object
that was specified in the command does
Explanation: The Remote Copy partnership was not not exist.
deleted because it has already been deleted.
Explanation: The action failed because an object that
User response: Not applicable. was specified in the command does not exist.
570 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5936E • CMMVC5948E
572 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5963E • CMMVC5975E
CMMVC5980E The operation was not performed Explanation: The tracing of I/O operations was not
because the master and auxiliary started because the volume or managed disk (MDisk)
clusters are not connected. failed to return statistics.
Explanation: The operation was not performed User response: Not applicable.
because the master and auxiliary clusters are not
connected. CMMVC5987E VALUE is not a valid command line
User response: Not applicable. option.
Explanation: The specified string that you have
CMMVC5981E The operation was not performed entered is not a supported command line option.
because the relationship is in the User response: Specify a supported option, and
freezing state. resubmit the command.
Explanation: The operation was not performed
574 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC5988E • CMMVC6001E
User response: Not applicable. Explanation: The upgrade package is not compatible
with the current version or the system.
CMMVC5991E The Remote Copy consistency group User response: Check the available upgrade packages
was not stopped as there are no Remote and find the correct upgrade package for your current
Copy relationships within the group. version and for your system. If the upgrade package is
correct for your system, check the version requirements
Explanation: The Remote Copy consistency group was for the package. You might have to upgrade the current
not stopped as there are no Remote Copy relationships version to an intermediate version before you upgrade
within the group. to the latest version. (For example, if your current
User response: Not applicable. version is 1 and you are trying to upgrade to version 3,
you might need to upgrade to version 2 before
applying the version 3 upgrade.)
CMMVC5992E The Remote Copy consistency group
was not stopped as there are no Remote
Copy relationships within the group. CMMVC5999W Featurization for this facility has not
been enabled.
Explanation: The Remote Copy consistency group was
not stopped as there are no Remote Copy relationships Explanation: Featurization for this facility has not
within the group. been enabled.
CMMVC5993E The specified upgrade package does CMMVC6000W Featurization for this facility has not
not exist. been enabled.
Explanation: The specified upgrade package does not Explanation: Featurization for this facility has not
exist. been enabled.
CMMVC5994E Error in verifying the signature of the CMMVC6001E The FlashCopy consistency group
upgrade package. was not started as there are no
FlashCopy mappings within the group.
Explanation: The system could not verify the
signature of the upgrade package due to the following Explanation: The FlashCopy consistency group was
reasons: not started as there are no FlashCopy mappings within
the group.
CMMVC6003E This command can not be run on a CMMVC6010E Unable to complete the command as
node that is in the service state. there are insufficient free extents, or the
command requested an expansion of 0
Explanation: This command can not be run on a node size.
that is in the service state.
Explanation: There are not enough free extents to
User response: Not applicable. meet the request.
User response: Not applicable.
CMMVC6004E The delimiter value VALUE is invalid.
Explanation: The specified value is not a valid CMMVC6011E This cluster is part of a remote
delimiter value. cluster partnership. Because this
User response: Specify a different delimiter. upgrade package will make changes to
the cluster state, it cannot be applied to
the current code level until all remote
CMMVC6005E The view request failed as the cluster partnerships are deleted.
specified object is not a member of an
appropriate group. Explanation: You have attempted to apply software
when a Remote Copy relationship to a remote cluster
Explanation: A view was request on an object that has exists.
been incorrectly initialized.
User response: Delete the Remote Copy relationship
User response: Ensure that the object is correctly to the remote clusters, and resubmit the command.
initialized before resubmitting the view request.
576 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6014E • CMMVC6025E
CMMVC6014E The command failed because the CMMVC6020E The upgrade failed because the
requested object is either unavailable or system was unable to distribute the
does not exist. package to all of the nodes.
Explanation: The command failed because the Explanation: The system could not complete the
requested object is either unavailable or does not exist. process of updating files. A full disk is a possible cause.
User response: Ensure that all parameters have been User response: Ensure that all nodes are online, and
correctly entered. If this is the case the determine why use the cleandumps command to clean the upgrades
the object is unavailable, then resubmit the command. directory.
CMMVC6026E The RC consistency group is not in CMMVC6031E The operation was not performed
the stopped state. because the FlashCopy consistency
group is empty.
Explanation: The action failed as the Metro Mirror
consistency group is not in the stopped state. Explanation: An attempt was made to prestart an
empty FlashCopy consistency group.
User response: Ensure that the Metro Mirror
consistency group is in the stopped state before User response: Not applicable.
resubmitting the command.
CMMVC6032E The operation was not performed
CMMVC6027E The RC consistency group is not the because one or more of the entered
primary master. parameters is invalid for this operation.
Explanation: The RC consistency group requested in Explanation: An parameter that is not valid was
the command is not the Metro Mirror primary master. entered for the command.
User response: Ensure that the parameters have been User response: If attempting to change the I/O group
entered correctly on the command line. to which the volume belongs, ensure that the volume is
not already a part of the group.
CMMVC6028E This package cannot be applied to
the current code level because it CMMVC6033E The action failed due to an internal
contains changes to the cluster state and error.
there are remote cluster partnerships
Explanation: An internal error caused the action to
defined.
fail.
Explanation: The action failed because there is a
User response: Not applicable.
connected remote cluster. The upgrade cannot be
applied because it would put the remote cluster at a
different code level than the local cluster. CMMVC6034E The action failed because the
maximum number of objects has been
User response: Ensure that the cluster partnership is
reached.
unconfigured before resubmitting the command. Ensure
that you unconfigure the remote cluster and upgrade Explanation: The action failed because the maximum
the code on it before reconfiguring the cluster number of objects has been reached.
partnership.
User response: Not applicable.
Explanation: The concurrent upgrade failed as two or Explanation: An operation was requested to create an
more nodes were at differing code levels. All nodes object that already exists.
must be at the same code level before a software User response: Ensure that the name you are
upgrade can be performed. attempting to apply to a new object does not exist, or
User response: Use the service assistant to bring all change the name before re-issuing the command.
nodes to the same level before resubmitting the
concurrent upgrade. CMMVC6036E An invalid action was requested.
Explanation: The action failed because it is not a valid
CMMVC6030E The operation was not performed action with the command that was issued.
because the FlashCopy mapping is part
of a consistency group. The action must User response: Issue an action that is valid with the
be performed at the consistency group command.
level.
Explanation: An attempt was made to stop a CMMVC6037E The action failed as the object is not
FlashCopy mapping. This failed as the FlashCopy empty.
mapping is part of a consistency group. Explanation: The action failed because an object was
User response: Issue the stop command to the specified.
FlashCopy consistency group. This will stop all User response: Resubmit the command without
FlashCopies within that group that are in progress. specifying an object.
578 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6038E • CMMVC6051E
CMMVC6038E The action failed as the object is CMMVC6045E The action failed, as the -force flag
empty. was not entered.
Explanation: The action failed because an object was Explanation: The action failed because the -force
not specified. option was not entered.
User response: Specify an object, and resubmit the User response: Specify the -force option in the
command. command.
CMMVC6039E The action failed as the object is not CMMVC6046E The action failed as too many
a member of a group. candidates were selected.
Explanation: The action failed because the object is Explanation: The action failed because too many
not a member of a group. candidates were specified.
User response: Specify an object that is part of a User response: Specify fewer candidates in the
group, and resubmit the command. command.
CMMVC6040E The action failed as the object is not CMMVC6047E The action failed as too few
a parent. candidates were selected.
Explanation: The action failed because the object is Explanation: An action was requested with too few
not a parent object. candidate objects.
User response: Specify an object that is a parent, and User response: Determine the correct number of
resubmit the command. candidates required for the specific command and
reissue the command.
CMMVC6041E The action failed as the cluster is
full. CMMVC6048E The action failed as the object is
busy.
Explanation: The action failed because the cluster is
full. Explanation: The action failed because the object is
busy.
User response: Remove data from the cluster, and
resubmit the command. User response: Not applicable.
CMMVC6042E The action failed as the object is not CMMVC6049E The action failed as the object is not
a cluster member. ready.
Explanation: The action failed because the object is Explanation: The action failed because the object is
not a member of the cluster. not ready.
User response: Specify an object that is a member of User response: Not applicable.
the cluster, and resubmit the command.
CMMVC6050E The action failed as the command
CMMVC6043E The action failed as the object is a was busy.
member of a group.
Explanation: The action failed because the command
Explanation: The action failed because the object is a is busy.
member of a group.
User response: Not applicable.
User response: Specify an object that is not a member
of a group, and resubmit the command.
CMMVC6051E An unsupported action was selected.
Explanation: The action failed because it is not valid
CMMVC6044E The action failed as the object is a
with the command.
parent.
User response: Specify an action that is valid with the
Explanation: The action failed because the object is a
command.
parent object.
User response: Specify an object that is not a parent
object, and resubmit the command.
CMMVC6052E The action failed as the object is a CMMVC6060E The action failed as the object is
member of a FlashCopy mapping. being deleted.
Explanation: The object is a member of a FlashCopy Explanation: The action failed because the object is
mapping, thus it cannot be deleted. being deleted.
User response: Specify an object that is not a member User response: Not applicable.
of a FlashCopy mapping, or remove the object from the
FlashCopy mapping.
CMMVC6061E The action failed as the object is
being resized.
CMMVC6053E An invalid WWPN was entered.
Explanation: The action failed because the object is
Explanation: A worldwide port name (WWPN) that is being resized.
not valid was specified.
User response: Check that the object is in the correct
User response: Specify a valid WWPN. mode, and resubmit the command.
CMMVC6054E The action failed as not all nodes are CMMVC6062E The action failed as the object is
online. being moved between HWS.
Explanation: One or more nodes are not online. Explanation: An attempt was made to perform an
action against an object that is currently being moved
User response: Check that each node is online, and
between I/O groups.
resubmit the command.
User response: Re-issue the command when the move
operation has completed.
CMMVC6055E The action failed as an upgrade is in
progress.
CMMVC6063E The action failed as there are no
Explanation: The action failed because a software
more disks in the group.
upgrade is in progress.
Explanation: An attempt was made to perform an
User response: Wait for the software upgrade to
action against a group that contained no disks.
complete, and resubmit the command.
User response: Either add disks to the group and
reissue the command, or select another group against
CMMVC6056E The action failed as the object is too
which to execute the action.
small.
Explanation: The action failed because the object is
CMMVC6064E The action failed as the object has an
too small.
invalid name.
User response: Specify a different object, and resubmit
Explanation: An attempt was made to create or
the command.
rename an object using a name that is not valid.
User response: Use a name that meets the naming
CMMVC6058E The action failed as the object is in
standards and reissue the command.
the recovery HWS.
Explanation: An attempt was made to perform an
CMMVC6065E The action failed as the object is not
operation on a node that is in the recovery I/O group.
in a group.
User response: Get the node into one of the other I/O
Explanation: An attempt was made to perform an
groups and reissue the command.
action on an object that was not in an appropriate
group.
CMMVC6059E The action failed as the object is in
User response: Ensure that the object is a member of
an invalid mode.
an appropriate group and reissue the command.
Explanation: The action failed because the object is in
the wrong mode.
CMMVC6066E The action failed as the system is
User response: Check that the object is in the correct running low on memory.
mode, and resubmit the command.
Explanation: The system is running low on memory.
User response: Not applicable.
580 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6067E • CMMVC6081E
CMMVC6067E The action failed as the SSH key was CMMVC6075E The expand failed as the last extent is
not found. not a complete extent.
Explanation: An attempt was made to perform an Explanation: The expand failed as the last extent is
action using an SSH key that does not exist. not a complete extent.
User response: Reissue the command using a key that User response: Assign a different extent, and resubmit
does exist. the command.
CMMVC6068E The action failed as there are no free CMMVC6076E The command failed because the
SSH keys. virtual disk cache is not empty. Either
wait for the cache to flush or use the
Explanation: An attempt was made to use an SSH key
force flag to discard the contents of the
when there are no free SSH keys.
cache.
User response: Upload additional keys and reissue the
Explanation: The command failed due to an error
command.
during the flushing of the volume.
User response: Not applicable.
CMMVC6069E The action failed as the SSH key is
already registered.
CMMVC6077E WARNING - Unfixed errors should
Explanation: An attempt was made to register an SSH
be fixed before applying an upgrade.
key that was already registered.
Depending on the nature of the errors,
User response: Not applicable. they might cause the upgrade process to
fail. It is highly recommended to fix
these errors before proceeding. If a
CMMVC6070E An invalid or duplicated parameter, particular error cannot be fixed, contact
unaccompanied argument, or incorrect the support center.
argument sequence has been detected.
Ensure that the input is as per the help. Explanation: Unfixed errors should be fixed before
applying an upgrade. Depending on the nature of the
Explanation: The parameters entered for a command errors, they might cause the upgrade process to fail. It
were not valid. is highly recommended to fix these errors before
User response: Correct the parameters and reissue the proceeding.
command. User response: If the error cannot be fixed, contact the
support center.
CMMVC6071E The VDisk-to-host mapping was not
created because the VDisk is already CMMVC6078E The action failed because the object
mapped to a host. is in an invalid mode.
Explanation: The volume is already mapped to a host. Explanation: An attempt was made to perform an
User response: Not applicable. action against an object in a mode that did not allow
for that action to be performed.
CMMVC6073E The maximum number of files has User response: Get the object into a suitable mode
been exceeded. and reissue the command.
CMMVC6082E The attempt to abort metadata CMMVC6089E The metadata at the requested lba is
recovery failed because the previous flagged as invalid.
operation has completed.
Explanation: The metadata at the requested lba is
Explanation: The attempt to cancel metadata recovery flagged as not valid.
failed because the previous operation has completed.
User response:
User response: None.
CMMVC6090E The metadata header checksum
CMMVC6083E Metadata recovery could not find a verification failed.
valid dumpfile required for the rebuild
Explanation: The metadata header checksum
operation.
verification failed.
Explanation: Metadata recovery could not find a valid
User response:
dumpfile required for the rebuild operation.
582 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6096E • CMMVC6109E
CMMVC6096E The metadata recovery task could not CMMVC6104E Action ACTION not run
be initiated because the required
Explanation: An unexpected error has occurred.
back-end resource could not be found.
User response: Contact IBM technical support for
Explanation: The back-end resource that is required
assistance.
for the task is unavailable.
User response: Ensure that the required back-end
CMMVC6105E Different names for source
resource is available, and reinitiate the task.
SOURCE_CLUSTER_NAME and target
TARGET_CLUSTER_NAME clusters
CMMVC6097E The metadata recovery task could not
Explanation: The backup configuration cannot be
be initiated because the system was
restored to the target cluster because the source and
unable to send the required I/O to the
target cluster have different names.
back-end resource.
User response: Perform one of the following actions:
Explanation: The back-end resource is possibly not
(1) Use a different backup configuration. (2) Delete the
configured properly.
cluster and recreate it with the same name as that
User response: Ensure that the required back-end stored in the backup configuration file.
resource is accessible, and reinitiate the task.
CMMVC6106W Target cluster has non-default
CMMVC6098E The copy failed as the specified node id_alias ALIAS .
is the configuration node.
Explanation: The specified id_alias of the target
Explanation: The copy failed because the specified cluster is a non-default value. Clusters should have the
node is the configuration node. default value. The non-default value suggests that the
cluster is customized and is not suitable for restoration.
User response: Check your command. Correct the
Restoration changes the id_alias.
specified node and resubmit..
User response: Change the id_alias to a default value,
and resubmit the command.
CMMVC6100E OPTION not consistent with ACTION
Explanation: The specified option is not supported for
CMMVC6107E NUMBER_OF_OBJECTS io_grp
the specified action.
objects in target cluster;
User response: Remove the option, and resubmit the NUMBER_OF_REQUIRED_OBJECTS are
command. required
Explanation: The number of I/O groups in the target
CMMVC6101E OPTION not consistent with OPTION cluster is not sufficient to accommodate the I/O groups
defined in the backup configuration file. Determine
Explanation: The two specified options cannot be why there are not enough I/O groups.
used together.
User response: Correct the problem, and resubmit the
User response: Remove one of the options, and command.
resubmit the command.
584 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6123E • CMMVC6136W
CMMVC6123E No PROPERTY for TYPE NAME . CMMVC6130W Inter-cluster PROPERTY VALUE will
not be restored.
Explanation: An unexpected error has occurred.
Explanation: The restoration of inter-cluster objects is
User response: Contact IBM technical support for
not supported.
assistance.
User response: Not applicable.
CMMVC6124E No TYPE with PROPERTY VALUE
CMMVC6131E No location cluster information
Explanation: An unexpected error has occurred.
Explanation: An unexpected error has occurred.
User response: Contact IBM technical support for
assistance. User response: Contact IBM technical support for
assistance.
CMMVC6125E No unique ID for TYPE NAME
CMMVC6132E The object OBJECT of type TYPE has
Explanation: An unexpected error has occurred.
a property PROPERTY with an incorrect
User response: Contact IBM technical support for value INCORRECT_VALUE . The
assistance. operation cannot proceed until the
property has the correct value
CORRECT_VALUE . Take administrative
CMMVC6126E No TYPE with unique ID VALUE action to change the value and try again.
Explanation: An unexpected error has occurred. Explanation: The specified object has the specified
User response: Contact IBM technical support for property of the specified type with the specified
assistance. incorrect value. The property most likely reflects the
state of the object.
CMMVC6127I The SSH key IDENTIFIER for USER is User response: Change the state to the required value,
already defined; the SSH key will not and resubmit the command.
be restored
Explanation: An identical SSH key for this user is CMMVC6133E Required TYPE property PROPERTY
already defined on the cluster. Therefore, the key in the not found
backup file will not be restored. Explanation: An unexpected error has occurred.
User response: Specify a different SSH key, and User response: Contact IBM technical support for
resubmit the command. assistance.
CMMVC6129E VDisk-to-host mapping objects have CMMVC6135E Argument VALUE for OPTION is not
VDisk_UID values that are not valid.
consistent.
Explanation: The specified argument that you have
Explanation: All of the host mapping objects do not supplied is not valid for the specified option.
have the same number for the volume LUN instance.
Therefore, there is a possibility the backup User response: Supply an valid argument, and
configuration file is corrupt. The LUN instance number resubmit the command.
should be the same for all host mapping objects that
are associated with a specific volume. The LUN
CMMVC6136W No SSH key file FILENAME
instance number is incorporated into the volume ID
property. Explanation: The specified file, which should contain
the SSH key, is not present and will not be restored.
User response: Determine why the LUN instance
The backup operation will continue.
number is not the same, correct the problem, and
resubmit the command. User response: No action is required. You might have
to manually restore the key.
CMMVC6137W No SSH key file FILENAME; key not CMMVC6143E The required configuration file
restored FILENAME does not exist.
Explanation: An SSH key cannot be restored because Explanation: A file that is critical for successful
the specified file, which is expected to contain the SSH operation is missing.
key, is not present. The restore operation will continue.
User response: Check your command. Specify the
User response: After the restore is complete, locate the correct configuration file and resubmit the command.
file containing the key, and perform one of the
following actions: (1) Rename the file so that it has the
CMMVC6144W The object with default name NAME
correct name, and resubmit the command. (2) Restore
has been restored as
the key manually using the addsshkey command.
SUBSTITUTE_NAME .
Explanation: An object with a default name bas been
CMMVC6138E OPTION is required
restored with a different name. Ensure that you account
Explanation: An option is missing. The option might for this name change when using the restored cluster in
be listed as optional, but circumstances make the the future. To avoid this problem in the future, choose
option mandatory. an appropriate name for each object in the cluster.
User response: Supply the option, and resubmit the User response: Choose an appropriate name for each
command. object in the cluster.
CMMVC6139E Incorrect XML tag nesting in CMMVC6145I First use the COMMAND -prepare
FILENAME command.
Explanation: There is a problem with the content of a Explanation: This advisory is given prior to
configuration file. There is a problem parsing the XML CMMVC6103E when an intermediate file is missing.
in the file, because the XML records are not consistent.
User response: .The command you submitted cannot
The file might be corrupt, or the file has been
be processed at the moment. Follow the message and
truncated.
submit a different command first.
User response: Replace this copy with a good copy,
and resubmit the command. If the problem persists,
CMMVC6146E Problem parsing OBJECT_TYPE data:
contact IBM technical support for assistance.
LINE
Explanation: An unexpected error has occurred.
CMMVC6140E No default name for type TYPE
User response: Contact the support center.
Explanation: An unexpected error has occurred.
User response: Contact IBM technical support for
CMMVC6147E TYPE NAME has a name beginning
assistance.
with PREFIX .
Explanation: An object has been encountered that has
CMMVC6141E The option OPTION does not support
a name beginning with the specified reserved prefix.
an argument.
The only valid reason for an object with this kind of
Explanation: An argument has been supplied for an name is that a restoration command did not complete
option that does not support one. successfully.
User response: Remove the argument, and resubmit User response: Ensure that no object uses the reserved
the command. prefix in its name, and resubmit the command.
586 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6149E • CMMVC6182W
Explanation: The code version on one or more nodes Explanation: Metadata recovery cannot use the
is incompatible with the new version. provided MDisk ID, which is not valid or destroyed.
User response: Refer to the compatibility requirements User response: Check your command and correct the
for the code version you are adding. Update the cluster specified MDisk. Resubmit the command.
to meet the compatibility requirements, and then
perform the upgrade.
CMMVC6206E The upgrade failed as a file
containing the code for the specified
CMMVC6201E The node could not be added because MCP version was not found.
of incompatible code. The status code is
Explanation: There are two files required to
STATUS_CODE .
successfully complete a code upgrade. One file contains
Explanation: The node could not be added because of the files that make up the base operating system, and
incompatible code. the other file contains the code. This message appears if
the OS version is incompatible with the code.
User response: Upgrade the code on the node that has
been rejected to the same level as the cluster to which it User response: Upload two compatible files, and
will be added, and resubmit the command. resubmit the command.
CMMVC6202E The cluster was not modified because CMMVC6207E The action failed because the virtual
the IP address is not valid. disk (VDisk) is part of a Remote Copy
mapping.
Explanation: An attempt was made to change the IP
address of a cluster to an address that is not valid. Explanation: An action was performed against a
volume that is part of a Remote Copy mapping.
User response: Correct the address and reissue the
command. User response: Remove the volume from the Remote
Copy mapping before resubmitting the command.
588 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6210E • CMMVC6218E
User response: Wait for the migration to complete and Explanation: The Remote Copy relationship was not
reissue the command. created because the master or auxiliary volume is a
member of a Remote Copy mapping.
CMMVC6212E The command failed because data in User response: Select a different volume to make up
the cache has not been committed to the mapping.
disk.
Explanation: The command failed because data in the CMMVC6217E The maximum number of hosts for
cache has not been committed to disk. the cluster is already configured.
User response: Check your command to ensure you Explanation: You must remove at least one host
have specified the correct volume and target. Make the definition before you can resubmit the command.
correction and resubmit the command. Otherwise,
User response: Determine whether the action is
investigate why the data has not been committed and
required.
how the data imust be committed.
If the action is required, review the current
configuration to determine whether any current host
CMMVC6213E You are trying to recover region data
definitions are not required. Remove at least one host
that was created by a code level
definition that is not required, and resubmit the
different from the one you are currently
command.
running on the node.
Explanation: You are trying to recover region data
CMMVC6218E The maximum number of host/IO
that was created by a code level different from the one
group pairs for the cluster is already
you are currently running on the node.
configured.
User response: Contact your administrator and inform
Explanation: You must remove at least one host I/O
them of this error. There might be the need to upgrade
group pair definition before you can resubmit the
the code level on the server you are using. Wait until
command.
the server is upgraded before resubmitting your
command.. User response: Determine whether the action is
required.
If the action is required, review the current
590 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6227I • CMMVC6238E
592 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6246E • CMMVC6254E
CMMVC6246E The FlashCopy mapping was not CMMVC6250E The command failed because the
created because the target virtual disk authorization record is not set to the
(VDisk) is already a source VDisk in a default role. Use rmauth to set the
FlashCopy mapping. default role.
Explanation: A volume cannot simultaneously be both Explanation: The command failed because the
the source of a FlashCopy mapping and the target of a authorization record is not set to the default role.
FlashCopy mapping. The target volume that you have
User response: Use rmauth to set the default role.
specified is currently defined as the source of a
FlashCopy mapping.
CMMVC6251E The command failed because the
User response: You have two options. One option is
specified role was not found.
specify a different target volume and resubmit the
command. The other option is delete all of the existing Explanation: The command failed because the
FlashCopy mappings that contain the target volume specified role was not found.
that you have specified and resubmit the command.
User response: Check the command and correct the
specified role. If you have specified a role that you
CMMVC6247E The FlashCopy mapping was not think does exist, check with your administrator for
created because the target virtual disk clarification. Make the correction and resubmit the
(VDisk) is already a target VDisk in a command.
FlashCopy mapping.
Explanation: A volume cannot simultaneously be the CMMVC6252E The command failed authorization
target of more than one FlashCopy mapping. The target because the session SSH key is invalid
volume that you have specified is currently defined as or was deleted.
the target of another FlashCopy mapping.
Explanation: The command failed authorization
User response: You have two options. One option is because the session SSH key is not valid or was
specify a different target volume and resubmit the deleted.
command. The other option is delete the existing
FlashCopy mapping that contains the target volume User response: Check the command and ensure that
that you have specified and resubmit the command. you have specified a valid SSH key. Make the
correction and resubmit the command.
594 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6278E • CMMVC6288E
User response: Ensure that the email system is User response: Ensure that the User ID that you
configured correctly. Ensure that you have configured specify is defined, and resubmit the task.
the SMTP environment correctly, and resubmit the task.
CMMVC6288E The FlashCopy mapping or
CMMVC6282E Sendmail error EX_NOPERM. The consistency group could not be started
user does not have permission to because a source VDisk is the target of
perform the requested operation. another FC Map that is keeping the
VDisk inaccessible.
Explanation: The send email task has failed because
the User ID does not have authorization to submit the Explanation: You cannot start a FlashCopy mapping
task. or consistency group when a source volume in the
FlashCopy mapping or consistency group is the target
User response: Ensure that authorizations for your volume of another FlashCopy mapping that is holding
User ID in the email and SMTP configurations are the volume as inaccessible. The task cannot be initiated
correct, and resubmit the task. because a source volume in the FlashCopy mapping or
consistency group that you are attempting to start is
the target of another FlashCopy mapping that is either
prepared, preparing, stopped or stopping with a
progress of less than 100%.
596 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6298E • CMMVC6304E
v Ensure that the controller settings are correct and to delete all of the existing mappings that contain the
that the MDisk logical unit is correctly configured. source volume and resubmit the command. The third
v Ensure that the MDisk logical unit state is one that option is to delete all of the existing mappings that
passes the validation. A Read Only or faulty MDisk contain the target volume and resubmit the command.
fails the validation.
v Check the Fibre Channel fabric and storage controller CMMVC6301E The create failed because the
for faults that might reduce the reliability of cluster specified consistency group does not
communication with the MDisk. exist.
v View the cluster event log for more information Explanation: The FlashCopy mapping was not created
about the failed validation. because the consistency group that you specified does
not exist. You must create a consistency group before
CMMVC6298E The command failed because a target you can place a mapping in that group.
VDisk has dependent FlashCopy User response: Either create the FlashCopy
mappings. consistency group that you specified and resubmit the
Explanation: The target volume of the FlashCopy command, or resubmit the command and specify an
mapping, or the target volume of at least one of the existing consistency group.
FlashCopy mappings in the consistency group, has
other FlashCopy mappings that are dependent on the CMMVC6302E The create failed because the
data on the target volume. resulting tree of FlashCopy mappings
User response: Use the lsvdiskdependentmaps would exceed the upper limit.
command and specify the target volume to determine Explanation: Either the source volume or the target
which FlashCopy mappings are dependent on the volume, or both, are already members of other
target volume. Either wait for these mappings to reach FlashCopy mappings. The FlashCopy mapping was not
the idle_or_copied state, or stop these mappings. created because the new FlashCopy mapping that you
Resubmit the command that produced this error. attempted to create would have linked two existing
mapping trees into a single tree that exceeds the
CMMVC6299E The create failed because the source maximum number of mappings that are supported for
and target VDisks are members of a single tree.
FlashCopy mappings that have different User response: You have two options. The first option
grain sizes. is to resubmit the command and specify a different
Explanation: All FlashCopy mappings that are in a source or target volume. The second option is to delete
tree of connected mappings must have the same grain a sufficient number of the existing FlashCopy
size. The new FlashCopy mapping that you attempted mappings in which either the source or the target
to create would have linked two existing trees that volume is a member so that the combined mapping
have different grain sizes. tree does not exceed the maximum number of
mappings that are supported for a single tree, and
User response: You have three options. The first resubmit the command.
option is to resubmit the command and specify a
different source or target volume. The second option is
to delete all of the existing mappings that contain the CMMVC6303E The create failed because the source
source volume and resubmit the command. The third and target VDisks are the same.
option is to delete all of the existing mappings that Explanation: A particular volume cannot be both the
contain the target volume and resubmit the command. source and the target in a FlashCopy mapping. The
FlashCopy mapping was not created because you have
CMMVC6300E The create failed because the source specified the same volume as both the source and the
and target VDisks are members of target.
FlashCopy mappings that belong to User response: Resubmit the command and specify
different I/O groups. source and target volumes that are not identical.
Explanation: All FlashCopy mappings in a tree of
connected mappings must be in the same I/O group. CMMVC6304E The create failed because the source
The new FlashCopy mapping that you attempted to VDisk does not exist.
create would have linked two existing trees that are in
different I/O groups. Explanation: You must specify an existing volume as
the source of a FlashCopy mapping. The FlashCopy
User response: You have three options. The first mapping was not created because the source volume
option is to resubmit the command and specify a that you specified does not exist.
different source or target volume. The second option is
User response: Either create the source volume that
598 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6311E • CMMVC6323E
CMMVC6311E The command failed because the CMMVC6315E The command failed because the
source VDisk is the target of a specified grain size is not valid.
FlashCopy mapping that is in the
Explanation: The command failed because the grain
specified consistency group.
size that you specified is not a supported value.
Explanation: A particular volume cannot be both the
User response: Either resubmit the command and
source of one FlashCopy mapping and the target of
specify a supported value for the grain size, or
another FlashCopy mapping in the same consistency
resubmit the command and do not specify the grain
group. The FlashCopy mapping was not created
size attribute. If you do not specify the grain size
because the source volume of the FlashCopy mapping
attribute, the default grain size value is used.
that you attempted to create is already the target
volume of a FlashCopy mapping in the consistency
group that you specified. CMMVC6319E The command has failed because a
combination of IPv4 and IPv6
User response: Resubmit the command and specify a
parameters were entered.
different consistency group.
Explanation: The task accepts either IPv4 or IPv6
parameters. You cannot specify a combination of IPv4
CMMVC6312E The command failed because the
and IPv6 parameters for this task.
target VDisk is the source of a
FlashCopy mapping that is in the User response: Specify only IPv4 or only IPv6
specified consistency group. parameters, and resubmit the task.
Explanation: A particular volume cannot be both the
source of one FlashCopy mapping and the target of CMMVC6320E The command has failed because the
another FlashCopy mapping in the same consistency IPv4 address is not valid.
group. The FlashCopy mapping was not created
because the target volume of the FlashCopy mapping Explanation: The valid IPv4 address format is d.d.d.d,
that you attempted to create is already the source where d is a decimal value from 0-255.
volume of a FlashCopy mapping in the consistency User response: Specify a valid IPv4 address, and
group that you specified. resubmit the task.
User response: Resubmit the command and specify a
different consistency group. CMMVC6321E The command has failed because the
IPv4 subnet mask is not valid.
CMMVC6313E The command failed because the Explanation: The valid IPv4 address format is d.d.d.d,
specified background copy rate is where d is a decimal value from 0-255.
invalid.
User response: Specify a valid IPv4 subnet mask, and
Explanation: The command failed because the resubmit the task.
background copy rate that you specified is not a
supported value.
CMMVC6322E The command has failed because the
User response: Either resubmit the command and IPv4 gateway address is not valid.
specify a supported value for the background copy
rate, or resubmit the command and do not specify the Explanation: The valid IPv4 address format is d.d.d.d,
background copy rate attribute. If you do not specify where d is a decimal value from 0-255.
the background copy rate attribute, the default User response: Specify a valid IPv4 gateway address,
background copy rate value is used. and resubmit the task.
CMMVC6314E The command failed because the CMMVC6323E The command has failed because the
specified cleaning rate is not valid. IPv6 address is not valid.
Explanation: The command failed because the Explanation: Valid IPv6 address formats are:
cleaning rate that you specified is not a supported
v x:x:x:x:x:x:x:x
value.
v x:x:x:x:x:x:d.d.d.d
User response: Either resubmit the command and
specify a supported value for the cleaning rate, or where d is a decimal value from 0-255 of an IPv4
resubmit the command and do not specify the cleaning address and x is a hexadecimal value of an IPv6
rate attribute. If you do not specify the cleaning rate address.
attribute, the default cleaning rate value is used.
600 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6329E • CMMVC6335E
CMMVC6329E The command has failed because the CMMVC6332E The command has failed because an
IP address is not valid. IPv6 email server address was specified
and the cluster does not have an IPv6
Explanation: The valid IPv4 address format is d.d.d.d,
address.
where d is a decimal value from 0-255.
Explanation: The cluster can only communicate with a
Valid IPv6 address formats are:
server through an IPv6 address if an IPv6 cluster
v x:x:x:x:x:x:x:x management IP address is configured.
v x:x:x:x:x:x:d.d.d.d
User response: Either configure the cluster to have an
IPv6 cluster management address or use an email
where d is a decimal value from 0-255 of an IPv4 server that has an IPv4 address, and resubmit the task.
address and x is a hexadecimal value of an IPv6
address.
Note: You do not need to remove the IPv4 address if
you configure the cluster to have an IPv6 cluster
A special syntax is available to compress long strings of management address.
zero bits. The use of '::' indicates multiple groups of
zeros. The '::' can appear only once in an address. The
'::' can also be used to compress the leading or trailing CMMVC6333E The command has failed because an
zeros in an address. IPv4 email server address was specified
v Example: 123.123.123.123 and the cluster does not have an IPv4
address.
v Example: 1080:0:0:0:8:800:200C:417A, which can be
compressed to 1080::8:800:200C:417A Explanation: The cluster can only communicate with a
v Example: 0:0:0:0:0:FFFF:129.144.52.38, which can be server through an IPv4 address if an IPv4 cluster
compressed to ::FFFF:129.144.52.38 management IP address is configured.
v Example: 0:0:0:0:0:0:13.1.68.3, which can be User response: Either configure the cluster to have an
compressed to ::13.1.68.3 IPv4 cluster management address or use an email
server that has an IPv6 address, and resubmit the task.
User response: Specify a valid IP address, and
resubmit the task.
Note: You do not need to remove the IPv6 address if
you configure the cluster to have an IPv4 cluster
CMMVC6330E The command has failed because an management address.
IPv6 address was specified and the
cluster does not have an IPv6 address.
CMMVC6334E The command failed as the email
Explanation: The cluster can only communicate with a port number supplied is invalid.
server through an IPv6 address if an IPv6 cluster
Explanation: The value that you entered for an email
management IP address is configured.
port number is not a valid email port number.
User response: Either configure the cluster to have an
User response: Specify a valid email port number, and
IPv6 cluster management address or specify an IPv4
resubmit the task.
address, and resubmit the task.
Note: You do not need to remove the IPv4 address if CMMVC6335E The command failed as the
you configure the cluster to have an IPv6 cluster combination of parameters provided are
management address. either mutually incompatible or would
leave the cluster without a functioning
protocol stack.
CMMVC6331E The command has failed because an
IPv4 address was specified and the Explanation: You have submitted a task with a
cluster does not have an IPv4 address. combination of parameters and parameter values that is
not supported or that does not provide the minimum
Explanation: The cluster can only communicate with a amount of required information.
server through an IPv4 address if an IPv4 cluster
management IP address is configured. User response: Ensure that you specify a supported
combination of parameters and parameter values, and
User response: Either configure the cluster to have an resubmit the task.
IPv4 cluster management address or specify an IPv6
address, and resubmit the task.
CMMVC6336E The virtual disk (VDisk) copy was CMMVC6341E The action failed because the virtual
not created because the grain size must disk (VDisk) copy is not space-efficient
be 32, 64, 128 or 256. or compressed.
Explanation: You have supplied an incorrect value for Explanation: You are attempting to run a command
the -grainsize parameter when you attempted to create that is valid only for thin-provisioned or compressed
a thin-provisioned volume copy. volumes.
User response: Specify a supported grain size, and User response: Specify a thin-provisioned or
resubmit the command. compressed volume, and resubmit the command.
CMMVC6337E The action failed because the CMMVC6342E The virtual disk (VDisk) copy was
warning size must be a multiple of 512 not shrunk because its real size cannot
bytes. be less than its used size.
Explanation: You are attempting to create a Explanation: You are attempting to reduce the real
thin-provisioned volume copy but you have entered an size that is allocated to a thin-provisioned volume copy,
incorrect value for the -warning parameter. The value but the command cannot be initiated because it would
can either be a percentage of the volume capacity or an make the real size less than the size that is currently
absolute value that is a multiple of 512 bytes. used.
User response: Enter a supported warning value, and User response: Determine the used size of the volume
resubmit the command. copy, and resubmit the command using a -rsize
parameter value that is greater than or equal to the
used size.
CMMVC6338E The action failed because the
warning size can not be larger than the
virtual size. CMMVC6343E The virtual disk (VDisk) copy was
not shrunk because its real size can not
Explanation: You are attempting to create a
be negative.
thin-provisioned volume copy but you have entered an
incorrect value for the -warning parameter. The Explanation: You are attempting to reduce the real
warning value cannot be greater than the volume size that is allocated to a thin-provisioned volume copy,
capacity. but the command cannot be initiated because it would
make the real size less than zero.
User response: Enter a supported warning value, and
resubmit the command. User response: Determine the real size of the volume
copy, and resubmit the command using a supported
-rsize parameter value.
CMMVC6339E The virtual disk (VDisk) copy was
not created because the virtual size was
not provided. CMMVC6344E The repair operation cannot start
because the virtual disk (VDisk) copy is
Explanation: You are attempting to create an
already being repaired.
image-mode thin-provisioned volume but you did not
set the -size parameter. Explanation: You are attempting to repair a
thin-provisioned or compressed volume copy, but the
User response: Resubmit the command using the -size
copy is already being repaired.
parameter.
User response: Specify the correct volume and copy
parameters, and resubmit the command.
CMMVC6340E The action failed because the value
supplied for real size is not a multiple
of 512 bytes. CMMVC6345E The repair operation cannot start
because the virtual disk (VDisk) copy
Explanation: You are attempting to create or resize a
was created using -import but the
thin-provisioned volume copy but you have entered an
cluster could not recognize its format.
incorrect value for the -rsize parameter. All sizes must
be integer multiples of 512 bytes. Explanation: You are attempting to repair a
thin-provisioned or compressed volume copy that is
User response: Resubmit the command using a
reporting corrupt metadata. The cluster cannot repair
supported -rsize parameter value.
the volume copy because it was not recognized as a
valid thin-provisioned or compressed volume when it
was imported into this cluster. The most probable cause
is that the wrong MDisk was used when the volume
copy was imported.
602 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6346E • CMMVC6354E
User response: Ensure that you specify a supported User response: Submit an lsvdiskcopy command to
combination of parameters and parameter values, and show all of the available copies for this volume. Select
resubmit the task. a copy that exists, and then resubmit the command that
caused this error.
When the copy is synchronized, resubmit the command synchronize. If you want the synchronization process
that caused this error. to complete more quickly, increase the rate by
submitting a chvdisk command. When the copy is
synchronized, resubmit the command that caused
CMMVC6355E The command failed because an
this error.
image mode copy is not synchronized
and -force was not specified. v Resubmit the command and specify the -force
parameter.
Explanation: When you specify an image mode copy
for this command, the copy must be synchronized Note: When you specify the -force parameter with the
unless you also specify the -force parameter. command that caused this error, the created volume is
User response: Perform one of the following actions: no longer guaranteed to have identical data to the
original volume when the split is performed.
v Use the lsvdisksyncprogress command to view the
synchronization status. Wait for the copy to
synchronize. If you want the synchronization process CMMVC6358E The command failed because the
to complete more quickly, increase the rate by copy specified is the only synchronized
submitting a chvdisk command. When the copy is copy.
synchronized, resubmit the command that caused
Explanation: The command failed because the copy
this error.
specified is the only synchronized copy.
v Resubmit the command and specify the -force
parameter. User response: Use the lsvdisksyncprogress
command to view the synchronization status. Wait for
Note: When you specify the -force parameter with the another copy to synchronize. If you want the
command that caused this error, the image mode copy synchronization process to complete more quickly,
is no longer guaranteed to have the correct volume increase the rate by submitting a chvdisk command.
data. When the copy has synchronized, resubmit the
command that caused this error.
User response: Perform one of the following actions: User response: Fix all of the errors that are associated
with the volume copies, and resubmit the command.
v Use the lsvdisksyncprogress command to view the
synchronization status. Wait for the copy to
synchronize. If you want the synchronization process CMMVC6363E The command failed because the
to complete more quickly, increase the rate by Logical Block Address (LBA) specified
submitting a chvdisk command. When the copy is is invalid for this virtual disk (VDisk).
synchronized, resubmit the command that caused
Explanation: You must specify a Logical Block
this error.
Address (LBA) that is a valid address for this volume.
v Resubmit the command and specify the -force
parameter. User response: Use the lsvdisk command to obtain
the volume size, and resubmit the command that
Note: When you specify the -force parameter with the caused this error using a logical block address that is in
command that caused this error, the entire volume copy range.
is resynchronized.
CMMVC6364E The command failed because the
CMMVC6357E The command failed because the logical block address (LBA) requested is
copy specified is not synchronized and too large for the disk.
-force was not specified. Explanation: You have specified an LBA in
Explanation: When you specify a copy for this conjunction with a volume or MDisk, but the LBA is
command, the copy must be synchronized unless you too large and does not exist on the disk.
also specify the -force parameter. User response: Check the size of the disk, and
User response: Perform one of the following actions: resubmit the command using an LBA that exists on the
disk.
v Use the lsvdisksyncprogress command to view the
synchronization status. Wait for the copy to
604 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6365E • CMMVC6374W
CMMVC6365E The command timed out. CMMVC6369W The FlashCopy storage capacity that
the cluster is using is approaching the
Explanation: The command has not completed in a
FlashCopy storage capacity that is
reasonable amount of time. Processing of the command
licensed.
required the software to wait for a set of MDisk reads
or writes to complete, and the predefined reasonable Explanation: You are being warned that the
wait time has been exceeded. FlashCopy storage capacity license might be exceeded
soon.
User response: Resolve any MDisk or fabric event log
entries, and resubmit the command. User response: Upgrade the FlashCopy storage
capacity license to prevent recurrence of this warning
message.
CMMVC6366E One or more nodes in the cluster has
hardware that is not supported by the
new code. CMMVC6370W The Remote Copy storage capacity
that the cluster is using is approaching
Explanation: The version of code that you are
the Remote Copy storage capacity that is
attempting to install does not support the hardware in
licensed.
at least one node in the cluster.
Explanation: You are being warned that the Remote
User response: Check the release notes for the version
Copy storage capacity license might be exceeded soon.
of code that you want to install. Upgrade hardware so
that all of the hardware in the cluster is supported by User response: Upgrade the Remote Copy storage
the new version of code, and resubmit the task. capacity license to prevent recurrence of this warning
message.
CMMVC6367E A remote cluster is running software
that is incompatible with the new CMMVC6372W The virtualized storage capacity that
software package. the cluster is using is approaching the
virtualized storage capacity that is
Explanation: The version of software that you are
licensed.
attempting to install on the local cluster does not
support the version of software that is installed on the Explanation: You are being warned that the
remote cluster. virtualized storage capacity license might be exceeded
soon.
User response: Check the release notes for the version
of software that you want to install. Perform one of the User response: Upgrade the virtualized storage
following actions: capacity license to prevent recurrence of this warning
v Upgrade the software on the remote cluster to a message.
version that is supported by the version of software
that you want to install on the local cluster before CMMVC6373W The virtualized storage capacity that
you upgrade the software on the local cluster. the cluster is using exceeds the
v Delete the cluster partnership to stop all remote copy virtualized storage capacity that is
relationships between the clusters, and resubmit the licensed.
task.
Explanation: You are being warned that the
virtualized storage capacity license has been exceeded.
CMMVC6368E The new code might be incompatible
User response: Upgrade the virtualized storage
with the remote cluster.
capacity license to prevent recurrence of this warning
Explanation: The version compatibility between message.
clusters cannot be checked because the remote cluster is
not accessible.
CMMVC6374W The FlashCopy storage capacity that
User response: Perform one of the following actions: the cluster is using exceeds the
v Ensure that the link to the remote cluster is FlashCopy storage capacity that is
functioning properly, and resubmit the task. licensed.
v Delete the cluster partnership to stop all remote copy Explanation: You are being warned that the
relationships between the clusters, and resubmit the FlashCopy storage capacity license has been exceeded.
task.
User response: Upgrade the FlashCopy storage
capacity license to prevent recurrence of this warning
message.
CMMVC6375W The Remote Copy storage capacity CMMVC6400E The command failed because a
that the cluster is using exceeds the specified managed disk (MDisk) is
Remote Copy storage capacity that is already in use.
licensed.
Explanation: You cannot specify an MDisk for this
Explanation: You are being warned that the Remote command if it is already in a storage pool or is being
Copy storage capacity license has been exceeded. used as an image mode volume.
User response: Upgrade the Remote Copy storage User response: Specify an MDisk that is not being
capacity license to prevent recurrence of this warning used as an image mode volume and is not in a storage
message. pool, and resubmit the command.
CMMVC6394E The command failed because an CMMVC6401E The command failed because one or
attempt to make the virtual disk cache more of the specified managed disks
empty took too long. (MDisks) that you have specified are
not in the required managed disk group.
Explanation: The failed command must empty the
volume cache before attempting the requested action to Explanation: The command requires that all of the
ensure that data is preserved. The empty volume cache MDisks that you specify must be in the same storage
subtask has taken too long, and therefore the command pool.
that you have submitted was not initiated so that other
User response: Ensure that all of the MDisks that you
configuration activity can occur.
specify are in the same storage pool, and resubmit the
The system continues attempting to empty the volume command.
cache.
The storage associated with the volume is probably CMMVC6402E The command failed because the
overloaded. managed disk (MDisk) is not in the
required managed disk group.
User response: Wait a few minutes to allow the
volume cache to empty. Resubmit the command. Explanation: All of the MDisks that you specify must
be in the required storage pool. At least one of the
Alternatively, you can use the -force parameter, if the
source MDisks that you have specified in the command
command supports the -force parameter, to bypass the
is not in the required storage pool.
empty volume cache subtask. However, specifying the
-force parameter will discard cache data for the User response: Ensure that all of the MDisks that you
volume. Only use the -force flag with this command if specify are in the storage pool that you specify, and
you do not intend to use the existing contents of the resubmit the command.
volume.
In addition to the above actions, investigate the CMMVC6403E The command failed because the
performance of the network storage devices associated target managed disk (MDisk) is not in
with this volume. The performance of host applications the required managed disk group.
using these devices might be degraded.
Explanation: All of the MDisks that you specify must
Remedial action to resolve a performance problem be in the required storage pool. At least one of the
enables host application performance to return to target MDisks that you have specified in the command
optimal conditions, and prevents this error message is not in the required storage pool.
from recurring when you resubmit the command that
User response: Ensure that all of the MDisks that you
caused this error.
specify are in the storage pool that you specify, and
resubmit the command.
CMMVC6399E The command failed because there is
not enough memory available for
CMMVC6404E The command failed because the
reservation.
source and target managed disk groups
Explanation: At least one node in the cluster cannot must be different.
reserve the required amount of memory. This might be
Explanation: The source and target storage pools that
caused by pinned data in the cache.
you specify for a cross storage pool migration must be
User response: Check for events in the event log. different.
Follow the fix procedures to resolve the problem.
User response: Ensure that the source and target
storage pools that you specify for a cross storage pool
migration are different, and resubmit the command.
606 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6405E • CMMVC6415E
CMMVC6416E The command failed because the CMMVC6424E The Send Inventory email operation
managed disk group warning threshold failed because there are no inventory
is too high. email users.
Explanation: You must specify a storage pool warning Explanation: The send inventory functionality has
threshold size that is equal to or less than the size of been enabled but no email users with the ability to
the storage pool when all of the MDisks have been receive inventory emails have been created.
added, or you must specify a storage pool warning
User response: Either turn off the send inventory
percentage that is equal to or less than the maximum
email functionality or create an email user account that
warning threshold percentage.
is capable of receiving inventory emails. Refer to the
User response: Specify valid values for the storage documentation for the mke-mailuser command for help
pool warning threshold size or percentage, and on creating email users.
resubmit the command.
CMMVC6425E The action failed because the
CMMVC6417E The command failed because the maximum number of objects has been
managed disk group warning threshold reached.
is invalid.
Explanation: The action failed because the maximum
Explanation: To specify the warning threshold there number of objects has been reached.
must be at least one managed MDisk in the storage
User response: Check the object specified in the
pool.
command and determine if you need to specify a
User response: Ensure that there is at least one MDisk different object. Make the correction and resubmit the
defined for the storage pool or remove the warning command.
threshold, and resubmit the command.
CMMVC6426E The command failed because a
CMMVC6418E The command failed because the specified managed disk (MDisk) is
virtual disk (VDisk) is in the process of already in use.
being resized.
Explanation: You cannot specify an MDisk that is
Explanation: When you submit this command, you already configured as an image mode volume.
cannot specify a volume that is being resized.
User response: Specify an unmanaged disk, and
User response: Wait for the resize volume operation to resubmit the task.
complete. If you still want to submit this command
after the operation has completed, resubmit the
CMMVC6427E The command failed because one or
command.
more of the specified managed disks
(MDisks) are not in the required
CMMVC6419E The command failed because one or managed disk group.
more of the specified managed disks
Explanation: The create volume task requires that all
(MDisks) are in the process of being
of the MDisks that you specify must be in the same
deleted.
storage pool.
Explanation: When you submit this command, you
User response: Ensure that all of the MDisks that you
cannot specify an MDisk that is being deleted with the
specify are in the same storage pool, and resubmit the
-force option.
task.
User response: Wait for the delete MDisk operation to
complete. Do not include any MDisks that have been
CMMVC6428E The command failed because the
deleted in the list of MDisks that you specify, and
source managed disk (MDisk) is not in
resubmit the command.
the required managed disk group.
Explanation: The task requires that all of the source
CMMVC6423E The Send Inventory email operation
MDisks that you specify must be in the same storage
failed because email is not started.
pool.
Explanation: The send inventory email functionality
User response: Ensure that all of the source MDisks
has been enabled but the email service has not been
that you specify are in the same storage pool, and
started.
resubmit the task.
User response: Disable the send inventory email
functionality or start the email service.
608 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6429E • CMMVC6439E
610 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6450W • CMMVC6456E
relationships or consistency groups that are configured you create a Global Mirror or Metro Mirror
in the local cluster and that are associated with the relationship.
remote cluster of the partnership.
User response: Identify all of the Global or Metro CMMVC6453W You have disabled the physical disk
Mirror relationships or consistency groups in the local license scheme but the capacity license
cluster that are configured between this cluster and the scheme is not set.
remote cluster of the partnership. Remove all of the
Explanation: The task has succeeded. However, you
relationships and groups that you have identified, and
should configure a license scheme before you create a
resubmit the task.
FlashCopy, Global Mirror or Metro Mirror relationship.
You can configure a physical disk license scheme or a
Note: Do not remove relationships or groups that are
capacity license scheme, but not both.
associated with a different cluster, and do not remove
relationships or groups that are contained entirely User response: If you do not have a virtualization
within the local cluster. feature license that is valid for this cluster, contact your
IBM sales representative and obtain a license. Ensure
that the license settings for this cluster match the
CMMVC6450W A FlashCopy mapping was created
license that you have for this cluster.
but physical_flash is not enabled.
Explanation: The create FlashCopy mapping task has
CMMVC6454E The command failed because the
succeeded. However, physical_flash should be enabled
physical disk license scheme is not
when you create a FlashCopy mapping in the physical
enabled.
disk license scheme.
Explanation: You can only enable physical_flash or
User response: Ensure that you have the appropriate
physical_remote when the physical disk license scheme
virtualization license for the cluster configuration that
is enabled.
you want to enable. Ensure that the license settings for
this cluster match the license. User response: Ensure that you have the appropriate
virtualization license for the cluster configuration that
Delete the FlashCopy mapping or enable
you want to enable. Ensure that the license settings for
physical_flash.
this cluster match the license. Resubmit the task if it
supported by the license.
CMMVC6451W A Global Mirror or Metro Mirror
relationship was created but
CMMVC6455E The command failed because a
physical_remote is not enabled.
capacity license scheme parameter was
Explanation: The create Global Mirror or Metro Mirror specified but the physical disk license
relationship task has succeeded. However, scheme is enabled.
physical_remote should be enabled when you create a
Explanation: You cannot enable the capacity license
Global Mirror or Metro Mirror relationship and the
scheme or specify a capacity license scheme parameter
cluster uses the physical disk license scheme.
while the cluster is using the physical disk license
User response: Ensure that you have the appropriate scheme.
virtualization license for the cluster configuration that
User response: Ensure that you have the appropriate
you want to enable. Ensure that the license settings for
virtualization license for the cluster configuration that
this cluster match the license.
you want to enable. Ensure that the license settings for
Delete the Global Mirror or Metro Mirror relationship this cluster match the license. Resubmit the task if it
or enable physical_remote. supported by the license.
CMMVC6452W You are using the physical disk CMMVC6456E The command failed because a
license scheme but the values for physical disk license scheme parameter
physical_flash and physical_remote are was specified but the capacity license
not set. scheme is enabled.
Explanation: The task has succeeded. However, you Explanation: You cannot enable the physical disk
should enable physical_flash before you create a license scheme or specify a physical disk license
FlashCopy mapping and you should enable scheme parameter while the cluster is using the
physical_remote before you create a Global Mirror or capacity license scheme.
Metro Mirror mapping.
User response: Ensure that you have the appropriate
User response: Enable physical_flash before you create virtualization license for the cluster configuration that
a FlashCopy mapping. Enable physical_remote before you want to enable. Ensure that the license settings for
this cluster match the license. Resubmit the task if it diagnosing problems with MDisks. There will be an
supported by the license. entry in the event log for the corresponding MDisks.
v If you submitted any other command to migrate a
CMMVC6457E One or more quorum disks are on the volume copy, determine the storage pool to which
specified controller. the volume is defined, and follow the procedure for
bringing the storage pool online. There will be an
Explanation: You cannot disable the setting that entry in the event log for the corresponding storage
allows a controller to support a quorum disk while a pool.
quorum disk is configured on the controller.
User response: Move all quorum disks from the CMMVC6461E The command failed because starting
controller to a different storage system using the the migration will result in VDisks
setquorum command, and resubmit this task. going offline in the source managed
disk group.
CMMVC6458E The specified controller cannot Explanation: A migration from an image mode
support quorum disks. volume will use the source storage pool and the source
Explanation: The controller type of the controller that storage pool assumes the combined state of the image
you specified does not support quorum disks. mode MDisk and the storage pool. If the online or
offline states of the image mode MDisk and the storage
User response: Specify a controller that has a pool are different on different nodes, the source volume
controller type that supports quorum disks, and might go offline or all of the volumes in the source
resubmit the task. storage pool might go offline.
User response: For each node, note the online or
CMMVC6459E The mkrcrelationship command offline states of the source volume and the source
failed because the same VDisk was storage pool. If one entity is online and the other is
specified as the master and auxiliary offline, bring online whichever is offline. Taking the
VDisk. online entity offline is not recommended because other
volumes might go offline.
Explanation: A relationship cannot be created from a
volume to itself. The mkrcrelationship command
requires that you specify two different volumes for the CMMVC6462E The command failed because starting
master and auxiliary positions. These can be two the migration will result in VDisks
volumes in the local cluster, or a volume in each of two going offline because the target
different clusters. managed disk group is offline.
User response: Specify a master volume and an Explanation: The migration process assigns the
auxiliary volume that are not identical to each other, volume an online or offline state based on the states of
and resubmit the task. the source and target storage pools. In this case, based
on the offline state of the target storage pool the
volume that is currently online would have been taken
CMMVC6460E The command failed because the
offline. The command cannot be initiated because this
migration source is offline.
action is not supported. There will be an entry in the
Explanation: The source of the migration is offline. event log for the corresponding storage pool.
The offline source is either an image mode MDisk or
User response: For each node, note the online or
the entire storage pool.
offline state of the source and target storage pools. For
User response: each node, if one of these two storage pools is online
v If you submitted the rmmdisk command and and the other is offline, bring online whichever storage
specified a regular MDisk, determine the storage pool is offline. Taking the online storage pool offline is
pool to which the source MDisk is defined, and not recommended because other volumes might go
follow the procedure for bringing the storage pool offline.
online. There will be an entry in the event log for the
corresponding storage pool. CMMVC6463E The command failed because Starting
v If you submitted the rmmdisk command and the migration will result in VDisks
specified an image mode MDisk, determine the going offline because a target MDisk is
source MDisk and follow the procedure for bringing offline.
the image mode MDisk online. There will be an
Explanation: The volume is currently online. The
entry in the event log for the corresponding MDisks.
migration process assigns the volume an online or
v If you submitted a command to migrate a copy of an offline state based on the states of the source and target
image mode volume, determine the corresponding MDisks. In this case, based on the offline state of the
source MDisk and follow the procedure for
612 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6464E • CMMVC6471E
target MDisk, the volume would have been taken FlashCopy mapping that is being restored.
offline. The task cannot be initiated because this action
User response: Ensure that the target volume in the
is not supported.
map that you are attempting to start or prepare is not
User response: Bring the target MDisk online by the source volume of another FlashCopy mapping that
following the recommended procedure for bringing an is being restored when you submit the task. You could
MDisk online, and resubmit the command. stop the associated map that is being restored, or you
could wait for the map that is being restored to reach
the Idle_or_Copied state.
CMMVC6464E The Create FlashCopy mapping task
cannot be initiated because the size of
the source VDisk is being changed by a CMMVC6469E The Split stop FlashCopy map task
previously submitted task. cannot be initiated because the mapping
is either being restored or is not in the
Explanation: You cannot submit this task while the
copy complete state.
Change volume size task is in progress.
Explanation: You cannot split stop a FlashCopy map
User response: Wait until the Change volume size
while it is being restored or is not in the copy complete
task completes, and then resubmit the task.
state.
User response: Ensure that the map is not being
CMMVC6465E The Create FlashCopy mapping task
restored and is in the copy complete state when you
cannot be initiated because the size of
submit this task.
the target VDisk is being changed by a
previously submitted task.
CMMVC6470E The Start or Prepare FlashCopy
Explanation: You cannot submit this task while the
mapping task cannot be initiated
Change volume size task is in progress.
because the target VDisk is being used
User response: Wait until the Change volume size by a different FlashCopy map.
task completes, and then resubmit the task.
Explanation: You cannot start or prepare a map while
the target of the map is also the target volume of
CMMVC6466E The Create FlashCopy mapping task another map that is in one of the following states:
cannot be initiated because an identical copying, stopping, suspended, prepared or preparing.
map already exists.
User response: Ensure that the target volume in the
Explanation: A map between the source and target map that you are attempting to start or prepare is not
volumes that you have specified is defined. You cannot the target volume of another FlashCopy mapping that
define a map that is exactly the same as a map that is is in one of the unsupported states when you submit
already defined. this task.
CMMVC6468E The Start or Prepare FlashCopy User response: Either upgrade the downlevel cluster
mapping task cannot be initiated software version to a version that supports this task or
because the target volume is the source remove the partnership to the cluster that has the
of a different FlashCopy map that is downlevel software version, and resubmit the task.
being restored.
Explanation: You cannot start or prepare a map while
the target of the map is the source volume of another
614 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6480E • CMMVC6490E
CMMVC6483E The task cannot be initiated because CMMVC6488E The task cannot be initiated because
the user group name that you have you have specified a user group ID that
specified already exists. is not correct.
Explanation: Each user group must have a unique Explanation: You must specify a valid user group ID
name. when you submit this task.
User response: If you want to define a new user User response: Specify a valid user group ID, and
group with the name that you had specified, you must resubmit the task.
first delete the existing user group that has that same
name. Specify a user group name that does not exist
CMMVC6489E The task cannot be initiated because
when you submit this task.
you have specified more than one
password.
CMMVC6484E The task cannot be initiated because
Explanation: This task allows you to specify only one
the role that you have specified is not
password.
supported.
User response: Specify only one password, and
Explanation: Examples of valid roles are
resubmit the task.
SecurityAdmin, Administrator, CopyOperator, Service,
and Monitor.
CMMVC6490E The task cannot be initiated because
User response: Specify a supported role, and resubmit
you have specified both a user group
the task.
and the use of the remote authentication
service.
CMMVC6485E The Delete user group task has failed
Explanation: You cannot specify a user group when
because there is at least one user that is
you specify the use of the remote authentication
defined as a member of the group, and
service.
you did not specify the -force parameter.
User response: Either specify a user group or specify
Explanation: You cannot delete a user group that is
Explanation: You cannot define the user superuser to Explanation: The action failed because the node
use the remote authentication service. hardware is incompatible with the current I/O group
member.
User response: Ensure that you have specified the
correct user, and resubmit the task. User response: Recheck your command for the
specified I/O group and verify that it is correct. Make
the correction and resubmit the command. If your
CMMVC6496E The task cannot be initiated because original command is correct, do further research to
you cannot remove the superuser correct this pproblem.
password.
Explanation: The user superuser must always have a
password defined.
User response: Ensure that you have specified the
correct user when you submit the task.
616 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6502E • CMMVC6508E
CMMVC6502E The FlashCopy mapping was not CMMVC6506E The task has failed because a timeout
prepared because preparing consistency has occurred while communicating with
group 0 is not a valid operation. the authentication service.
Explanation: The FlashCopy mapping was not Explanation: The cluster is configured to use an
prepared because preparing consistency group 0 is not authentication service to control which users are
a valid operation. authorized to access the cluster. A timeout has occurred
while the cluster was attempting to contact the
User response: Recheck your command and ensure
authentication service. This timeout is probably the
that you specified the correct consistency group. Make
result of a TCP/IP network problem or of an incorrect
the correction and resubmit the command. If you
configuration. Configuring the incorrect IP address or
specified the correct consistency group, then more
protocol in the authentication service URL causes this
research is necessary to correct this problem.
error. The protocol can be either http or https.
User response: Ensure that the cluster authentication
CMMVC6503E The FlashCopy mapping or
service configuration is correct. Ensure that the
consistency group was not stopped
Ethernet network between the cluster and the
because stopping consistency group 0 is
authentication service is functioning properly. Ensure
not a valid operation.
that the authentication service is functioning properly.
Explanation: The FlashCopy mapping or consistency Resubmit the task.
group was not stopped because stopping consistency
group 0 is not a valid operation.
CMMVC6507E The task has failed because the
User response: Recheck your command to ensure that authentication service reports an
you specified the FlashCopy mapping or consistency incorrect user name or password.
group that you intended. Make the correction and
Explanation: The cluster is configured to use an
resubmit the command. If the command was correct,
authentication service to control which users are
more research is needed before you can resubmit the
authorized to access the cluster.
command.
If the password for the user name has recently been
changed on the authentication service, you might be
CMMVC6504E The task cannot be initiated because
required to force the cluster to refresh its authentication
the SSH key file that you have specified
cache. You can force the refresh using the cluster
does not contain a valid SSH key.
console View Cluster Properties, Remote Authentication
Explanation: You must specify an SSH key file that panel or by submitting the Command-Line Interface
contains a valid SSH key. command chauthservice -refresh.
User response: Specify an SSH key file that contains a User response: Ensure that the user name and
valid SSH key, and resubmit the task. password that you use is correct.
If the password for the user name has recently been
CMMVC6505E The task has failed because an error changed on the authentication service, force the cluster
has occurred while communicating with to refresh its authentication cache.
the authentication service.
If the user name that you are using also has a
Explanation: The cluster is configured to use an password configured on the cluster, ensure that the
authentication service to control which users are password that is configured on the cluster is identical
authorized to access the cluster. An error has occurred to the password that is configured for that user name
while the cluster was attempting to contact the on the authentication service.
authentication service. The error is probably the result
Resubmit the task.
of an incorrect configuration, either of the cluster or of
the authentication service. This error occurs if the SSL
certificate, user name or password is incorrect. CMMVC6508E The task has failed because the
authentication service reports that the
User response: Ensure that the authentication service
authentication token has expired.
is functioning properly. Ensure that the cluster
authentication service configuration is correct. Resubmit Explanation: The cluster is configured to use an
the task. authentication service to control which users are
authorized to access the cluster. The authentication
token, which is saved as a browser cookie, has expired.
You can modify the token expiration property that is
set by the authentication service to reduce the
frequency of this error in the future.
User response: Either acquire a new authentication User response: Submit a create new quorum disk task.
token or log in with a user name and password, and When that task has completed, submit a task to activate
resubmit the task. the new disk.
CMMVC6509E The task has failed because the user CMMVC6513E The task has failed because you
name is not configured on the cluster. cannot activate a quorum disk until all
of the quorum disks have been
Explanation: If the user name is defined on an
initialized.
authentication service and you want to use that service
for cluster authentication, you must configure the Explanation: The initialization process for at least one
cluster to use that authentication service. disk has not yet completed. You cannot select a disk as
the active disk until the initialize process for all of the
User response: Ensure that you are using the correct
quorum disks has completed.
user name.
User response: Wait until the initialize quorum disk
If the user name is not configured on the cluster and
process has completed for all of the quorum disks, and
you want to use the cluster to authenticate, create a
resubmit the task.
new user with the user name that you want to use on
the cluster.
CMMVC6514E The task has failed because the disk
If the user name is defined on an authentication service
that you have selected to activate is not
and you want to use that service for cluster
online.
authentication, configure the cluster to use that
authentication service. Explanation: A disk must be online to be eligible for
activation.
Resubmit the task.
User response: Either bring the disk that you have
selected online or select a different disk that is already
CMMVC6510E The task has failed because the user
online, and resubmit the task.
name or password is not correct.
Explanation: The password that you are using does
CMMVC6515E The task has failed because at least
not match the password that is configured on the
one quorum disk is in the Excluded
cluster for the user name that you are using.
state.
User response: Enter the correct user name or
Explanation: You cannot activate a quorum disk when
password, and resubmit the task.
one or more of the quorum disks are in the Excluded
state.
CMMVC6511E The task has failed because the
User response: Either create additional quorum disks
cluster is not configured correctly to use
or change the configuration so that none of the quorum
the authentication service.
disks is in the Excluded state. Ensure that none of the
Explanation: The user name that you are using is quorum disks are in the Excluded state, and resubmit
configured to be authenticated using an authentication the task.
service, but either the cluster is not configured to use
an authentication service or the function is not enabled.
CMMVC6516E The command has failed because an
User response: If you want to use an authentication IPv4 cluster address cannot be removed
service, configure the cluster to use the service. while remote IPv4 services are
configured.
If you do not want to use an authentication service,
modify the configuration of the user name on the Explanation: The configured management IP address
cluster to remove the designation for the use of the protocols determine whether IPv4 or IPv6 or both are
authentication service. enabled on the cluster. If a cluster does not have an
IPv4 cluster address the IPv4 protocol stack will not be
Resubmit the task. enabled, and therefore remote services such as email
servers or SNMP servers cannot be accessed through an
CMMVC6512E The task has failed because you IPv4 address.
cannot both create a new quorum disk User response: If you can only access the service
and set that new disk to active using the through an IPv4 address and you need to continue to
same command. use the service, you will also have to continue to
Explanation: The create new quorum disk task and set specify an IPv4 cluster address even if you do not
disk to active task must be done using two separate intend to manage your cluster through this address.
tasks. Otherwise, re-configure the cluster so that all remote
618 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6517E • CMMVC6523E
services use only IPv6 addresses, and resubmit the task the user group of a user account from 'SecurityAdmin'
to remove the IPv4 cluster address. to a different user group.
CMMVC6517E The command has failed because an CMMVC6520E You cannot use this task to modify
IPv6 cluster address cannot be removed the properties of the current user
while remote IPv6 services are because those properties are only
configured. defined by an authentication service.
Explanation: The configured management IP address Explanation: The current user is not defined on the
protocols determine whether IPv4 or IPv6 or both are cluster. The current user is defined on an authentication
enabled on the cluster. If a cluster does not have an service, and the cluster is configured to use that
IPv6 cluster address the IPv6 protocol stack will not be authentication service. You must use the authentication
enabled, and therefore remote services such as email service to change the current user's password.
servers or SNMP servers cannot be accessed through an
If you want to enable command-line interface (CLI)
IPv6 address.
access to the cluster by using an SSH key, you must
User response: If you can only access the service define the current user on the cluster and associate the
through an IPv6 address and you need to continue to SSH key with that user. If you also want to continue
use the service, you will also have to continue to using the authentication service for the current user,
specify an IPv6 cluster address even if you do not you must enable the 'remote' setting for the new
intend to manage your cluster through this address. current user account that you create on the cluster.
Otherwise, re-configure the cluster so that all remote User response: If you want to change your password,
services use only IPv4 addresses, and resubmit the task use the authentication service for that task.
to remove the IPv6 cluster address.
If you want to enable command-line interface (CLI)
access to the cluster by using an SSH key, define your
CMMVC6518E The task has failed because no roles user account on the cluster and associate the ssh key
are defined for the current user on the with that definition. If you also want to continue using
cluster. the authentication service to authorize your user
account, enable the 'remote' setting for your newly
Explanation: The cluster has been configured to use
created user account on the cluster.
an authentication service to control which users are
authorized to access the cluster. The user's credentials
were accepted by the authentication service, but none CMMVC6521E The task cannot be initiated because
of the groups defined for the user on the authentication it would have resulted in a user account
service match any of the user groups that are defined definition for a local user that specifies
on the cluster. neither a password nor an SSH key.
User response: Perform the following steps in Explanation: The definition of a local user must
sequence: always specify either a password or an SSH key.
1. Determine which user groups are defined for the User response: When you submit this task, ensure
user on the authentication service. that you have specified the correct user account and
2. Ensure that at least one user group that is defined parameters, and that all local user definitions would
for the user on the authentication service is also still specify either a password or an SSH key after the
defined on the cluster. task completes.
3. Ensure that at least one user group that is defined
for the user on both the authentication service and CMMVC6522E Authorization has failed.
the cluster has its 'remote' parameter set to
'enabled'. Explanation: An SSH login attempt has failed. This
message will be followed by a second message that will
4. Resubmit the task.
contain detailed information about the cause of the
error.
CMMVC6519E The task has failed because you
User response: Follow the instructions in the second
cannot change the user group of the
error message to solve the problem.
'superuser' account to anything other
than 'SecurityAdmin'.
CMMVC6523E The URL that you have entered is not
Explanation: The user group that is assigned to the
valid.
user name 'superuser' must always be 'SecurityAdmin'.
This assignment cannot be changed. Explanation: The URL must start with either http://
or https:// and must use only the following characters:
User response: Ensure that you specify a user account
A-Z, a-z, 0-9, - _ : [ ] . ~ / %.
other than 'superuser' if you submit a task to change
620 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6533E • CMMVC6541E
CMMVC6533E The command cannot be initiated CMMVC6537E The command cannot be initiated
because the specified array member because the drive that you have
does not exist in the selected array. specified has a Use property that is not
supported for the task.
Explanation: This command requires that the array
member that you specify is an LDisk. It is possible that Explanation: You can submit the lsdrive command to
the array member that you specified was an LDisk that display the Use property of a drive and to determine
was recently deconfigured due to an error. You can use which drives are available.
the lsarraymember command to display the available
User response: Consult the command documentation
members of an array.
to determine what drive Use property values are
User response: Select an array member that has an supported for this command. Ensure that you select a
associated LDisk, and resubmit the command. drive that has a value for the Use property that is
supported when you submit this command.
CMMVC6534E The command cannot be initiated
because the drive that you have CMMVC6538E The command cannot be initiated
specified does not exist. because at least one of the drives that
you have specified has a Use property
Explanation: You have specified a drive ID that is not
that is not Candidate.
defined.
Explanation: Every drive that you specify for this
User response: Use the lsdrive command to display
command must have a Use property of Candidate. You
existing drive IDs. Specify only existing drive IDs, and
can submit the lsdrive command to display the Use
resubmit the command.
property of existing drives.
User response: Ensure that all of the drives that you
CMMVC6535E The command cannot be initiated
specify have a Use property of Candidate, and
because you have specified an incorrect
resubmit the command.
number of drives to configure an array
using the RAID geometry that you have
specified. CMMVC6539E The command cannot be initiated
because the array does not have
Explanation: Each RAID geometry requires a
sufficient redundancy.
minimum number of available drives in order to
configure an array using that geometry. For example, a Explanation: The array must have sufficient
RAID 6 geometry requires that you specify at least four redundancy when you submit this command. The task
available drives. The number of drives that you have that you have requested would have taken the array
specified is less than the minimum number of drives offline.
that are required for the RAID geometry that you have
User response: Fix all errors that are related to the
specified.
array that you have specified and restore redundancy
User response: Ensure that you specify a sufficient to the array before you resubmit the command.
number of drives to accommodate the RAID geometry
that you specify, and resubmit the command. You
CMMVC6540E The task cannot be initiated because
might want to specify a different number of drives or a
the space-efficient grain size is too small
different RAID geometry.
to accommodate the virtual capacity that
you have requested for the VDisk.
CMMVC6536E The command cannot be initiated
Explanation: The virtual capacity that you have
because you have specified more drives
requested would required a larger number of grains
than the specified RAID geometry
than the supported maximum for the specified grain
permits.
size.
Explanation: The number of drives that you specify
User response: Either increase the grain size, decrease
must be within the supported range of number of
the requested virtual capacity of the volume, or both,
drives that is supported for the RAID geometry that
and resubmit the task.
you specify. For example, a RAID 1 geometry requires
that you specify exactly two available drives.
CMMVC6541E The task cannot be initiated because
User response: Specify a number of available drives
the virtual capacity that you have
that is supported for the RAID geometry that you
requested for the VDisk is larger than
specify, and resubmit the command.
the maximum capacity that is supported
for the extent size.
Explanation: The extent size of the storage pool that
CMMVC6542E The remote authentication task has CMMVC6547W The Download FPGA firmware task
failed. has been initiated. The MDisk remains
Offline while the task is in progress. Do
Explanation: An error has occurred while attempting
not remove power from the drive or
to authenticate a user account using a remote
node while the task in is progress.
authentication service. You can run the svc_snap task to
gather cluster information that can be used in problem Explanation: The task might take approximately
determination. fifteen minutes to complete. When the task completes,
the drive status changes to Online automatically.
User response: Contact IBM technical support for
assistance. User response: Ensure that electrical power is
continuously being supplied to the node and the drive,
at least until the task completes and the drive status
CMMVC6543E The task cannot be initiated because
changes to Online.
you can only specify a direct-attached
managed drive when you submit the
task. CMMVC6548E The FPGA firmware cannot be
applied because the drive has a use
Explanation: The drive that you have specified either
other than candidate.
is not managed or is not a local drive.
Explanation: Updating a drive FPGA level is not
User response: Specify a direct-attached MDisk when
guaranteed to maintain data integrity, therefore the
you submit this task.
drive must not be part of an array. To ensure this, the
drive must have a use of "candidate" before the
CMMVC6544E The task cannot be initiated at this package can be applied.
time because the direct-attached
User response: If the drive is currently in the "failed"
managed drive that you have specified
state, run through all maintenance actions required for
is too busy. Resubmit the task when the
the drive before continuing. If the drive is a spare or
drive is less busy.
unused, the drive use can be changed through the GUI
Explanation: The task takes approximately thirty or through the chdrive command. If a drive is
seconds to complete. When the direct-attached currently part of an array, a hot spare must be
managed drive is busy, the time that is required to configured and the drive use changed to failed, before
complete the task increases. When the drive is too busy, changing the use to candidate.
the task cannot complete in a reasonable amount of
time.
CMMVC6549E The Authentication task has failed
User response: Resubmit the task when the because the authentication service URL
direct-attached managed drive is less busy. that you have specified is not a valid
URL.
CMMVC6545E The Apply Drive Software task has Explanation: This error might be caused by the
failed to access the software download authentication service not operating correctly or by an
image. incorrect URL being defined for the authentication
service. You can use the chauthservice command to
Explanation: Either the image file cannot be read, the change the URL that is defined in the cluster for the
validation signature is incorrect, the drive type or authentication service.
software type is not correct, or the image file has been
corrupted. User response: Ensure that the authentication service
is operating correctly. Ensure that the authentication
User response: Reinstall the software download service URL that is defined in the cluster is correct, and
image, and resubmit the task. If the problem persists, resubmit the task.
contact IBM technical support for assistance.
622 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6550E • CMMVC6556E
CMMVC6552E The Authentication task has failed User response: Ensure that the authentication service
because an SSL connection could not be is functioning correctly, and resubmit the task. If the
established with the authentication problem persists, contact the authentication service
service. technical support for assistance.
624 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6563E • CMMVC6571E
volume, depending on the current cache mode and become idle_copied or stopped, and resubmit the
requested cache mode. One example of a risk of command.
potential loss of cache data would be changing the
cache mode from readwrite to none.
CMMVC6576E The command has failed because the
User response: Either follow service procedures to VDisk that you specified is a source or
bring the I/O group online or specify the -force flag to target of a FlashCopy mapping that is in
force the change of the cache mode of the volume, and the stopping state.
resubmit the task.
Explanation: If the volume is the source or target of a
FlashCopy mapping, the FlashCopy mapping must be
CMMVC6572E The command has failed because the in the idle_copied state or the stopped state when you
I/O group that manages the virtual disk change the cache mode of the volume.
(VDisk) that you specified is not stable.
User response: Either remove or stop the FlashCopy
Explanation: The unstable I/O group condition is mapping and wait for the FlashCopy mapping state to
typically transient, and usually occurs during I/O become idle_copied or stopped, and resubmit the
group failover or fail back processing. command.
User response: Wait a few minutes, and resubmit the
command. CMMVC6577E The command has failed because the
VDisk that you specified is a source or
target of a FlashCopy mapping that is in
CMMVC6573E The command has failed because the
the copying state.
VDisk that you specified is a source or
target of a FlashCopy mapping that is in Explanation: If the volume is the source or target of a
the prepared state. FlashCopy mapping, the FlashCopy mapping must be
in the idle_copied state or the stopped state when you
Explanation: If the volume is the source or target of a
change the cache mode of the volume.
FlashCopy mapping, the FlashCopy mapping must be
in the idle_copied state or the stopped state when you User response: Either remove or stop the FlashCopy
change the cache mode of the volume. mapping and wait for the FlashCopy mapping state to
become idle_copied or stopped, and resubmit the
User response: Either remove or stop the FlashCopy
command.
mapping and wait for the FlashCopy mapping state to
become idle_copied or stopped, and resubmit the
command. CMMVC6578E The command has failed because the
iSCSI name is already assigned or is not
valid.
CMMVC6574E The command has failed because the
VDisk that you specified is a source or Explanation: The cluster does not support duplicate
target of a FlashCopy mapping that is in iSCSI names. A valid iSCSI name cannot contain a
the suspended state. comma or leading or trailing spaces.
Explanation: If the volume is the source or target of a User response: Ensure that you specify a unique and
FlashCopy mapping, the FlashCopy mapping must be valid iSCSI name, and resubmit the command.
in the idle_copied state or the stopped state when you
change the cache mode of the volume.
CMMVC6579E The command cannot be initiated
User response: Either remove or stop the FlashCopy because the cluster Ethernet port 1 must
mapping and wait for the FlashCopy mapping state to always be fully configured in either the
become idle_copied or stopped, and resubmit the IPv4 or IPv6 format.
command.
Explanation: This error can be caused by an attempt
to delete the only address that is configured on the
CMMVC6575E The command has failed because the primary Ethernet port on the cluster.
VDisk that you specified is a source or
User response: When you delete an IP address on the
target of a FlashCopy mapping that is in
primary Ethernet port, ensure that the other supported
the preparing state.
IP format is already configured on that port.
Explanation: If the volume is the source or target of a
FlashCopy mapping, the FlashCopy mapping must be
CMMVC6580E The command cannot be initiated
in the idle_copied state or the stopped state when you
because the iSCSI alias that you
change the cache mode of the volume.
specified contained either leading or
User response: Either remove or stop the FlashCopy trailing space characters.
mapping and wait for the FlashCopy mapping state to
626 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6581E • CMMVC6589E
Explanation: The space character cannot be the service is not being used, disable the service, and
starting or ending character of an iSCSI alias name. resubmit the task.
User response: Ensure that the iSCSI alias that you
specify does not being or end with a space character, CMMVC6585E The command cannot be initiated
and resubmit the command. because the array that you have
specified has a geometry of RAID 0,
which is not a redundant geometry.
CMMVC6581E The command has failed because the
maximum number of allowed iSCSI Explanation: The array that you specify for this
qualified names (IQNs) has been command must have a redundant geometry, and RAID
reached, or the IQN is already assigned 0 is not a redundant geometry.
or is not valid.
User response: Ensure that you specify an array that
Explanation: IQNs cannot exceed the maximum has a redundant geometry when you submit the
number allowed, must not be duplicated, must not command.
contain a comma, and must not contain leading or
trailing spaces.
CMMVC6586E The command cannot be initiated
User response: If the number of IQNs is within the because the action would cause array
allowed maximum, ensure that you specify a unique data loss due to the unsynchronized
and valid IQN, and resubmit the command. state of the array.
Explanation: To avoid data loss, this command is not
CMMVC6582E The task has failed because the iSCSI permitted to process an array that is not synchronized.
host that you specified is not mapped to
User response: Use the lsarraysyncprogress
an I/O group.
command to ensure that the synchronization process
Explanation: You cannot add a port to an iSCSI host completes for this array, and resubmit the task.
until you have mapped the iSCSI host to at least one
I/O group.
CMMVC6587E The command did not complete
User response: Map the iSCSI host to at least one I/O because I/O for the array was not
group, and resubmit the command. quiesced within the allotted time
period.
CMMVC6583E The command has failed because the Explanation: All outstanding I/O for the array must
name that you specified contains a complete before the configuration can be changed. The
character that is not supported for a command has failed because there is still outstanding
node or cluster name. I/O to be processed for the array, and the maximum
amount of time allotted to the command has expired.
Explanation: A node or cluster name cannot contain
any of the following characters or ASCII hexadecimal User response: Resubmit the task.
values:
v 0000-001F ASCII control characters CMMVC6588E The command cannot be initiated
v 0020-002C The space character !“”# $ % the because a drive that you have specified
ampersand character ' ( ) * + , has a capacity that is smaller than the
v 002F / minimum capacity that is required for
the array that you have specified.
v 003B-0040 ; the 'less than' character = > ? @
v 005B-0060 [ \ ] ^ _ ` Explanation: You can use the lsarraymembergoals
command to identify the capacity requirement for a
v 007B-007F { | } ~ and the DEL character
member of the array that you specified.
User response: Specify a valid name, and resubmit the
User response: Specify a drive that has sufficient
command.
capacity for the array that you specify when you
submit the command.
CMMVC6584E The command cannot be initiated
because it would unconfigure the
CMMVC6589E The command was not initiated
remote authentication service while the
because the drive that you have
service is enabled.
specified does not sufficiently match the
Explanation: You cannot unconfigure the remote array member goals and you did not
authentication service while it is enabled. specify the -balanced parameter.
User response: Ensure that the remote authentication Explanation: If you do not specify the -balanced
628 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6608E • CMMVC6617E
630 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC6628E • CMMVC7011E
User response: Ensure that the enclosure is online and Remove at least one iSCSI qualified name or WWPN
cabled correctly, and resubmit the command. that is not required, and resubmit the command.
CMMVC6628E The enclosure that you have specified CMMVC6999E The command cannot be initiated
cannot be changed to unmanaged mode because the maximum number of iSCSI
because one or more drives are in use. qualified names (IQNs) for the host has
been reached.
Explanation: The status of the enclosure that you have
specified will not allow the enclosure to be unmanaged Explanation: The specified host is already configured
by the cluster. with the maximum number of IQNs.
User response: Stop using the drives, and resubmit User response: None.
the command.
CMMVC7003E The command cannot be initiated
CMMVC6630E A drive dump was not created because the power supply unit (PSU)
because a command was rejected by the that you have specified is offline.
drive that you have specified.
Explanation: The power supply unit (PSU) that you
Explanation: When initiating a drive dump, a specify must be online when you submit the command.
sequence of commands is sent to the drive. One or
User response: Fix any errors associated with the
more of these commands was rejected by the drive that
specified PSU. Ensure that the PSU is online, and
you have specified.
resubmit the command.
User response: Fix any errors associated with the
drive, enclosure, and cabling, or specify a different
CMMVC7005E The command cannot be initiated
drive, and resubmit the command.
because enclosures do not exist for the
I/O group that you have specified.
CMMVC6631E The task was not completed because
Explanation: You have submitted a command and
the drive that you have specified was
specified an I/O group that is not associated with an
unavailable.
enclosure. You can submit the lsenclosure command to
Explanation: The drive that you have specified did show all of the existing enclosures and their associated
not have the required connectivity to complete the task. I/O groups.
User response: Fix any errors associated with the User response: Specify an I/O group that is associated
drive, or specify a different drive, and resubmit the with an enclosure when you submit the command.
command.
CMMVC7010E The command cannot be initiated
CMMVC6988E The command cannot be initiated because the MDisk mode is set to Array.
because the maximum number of iSCSI
Explanation: This command requires the selected
qualified names (IQNs) for the cluster
MDisk to be a SAN MDisk (an MDisk that is not an
has been reached.
array made from local drives). The selected MDisk has
Explanation: The specified cluster is already its mode set to Array.
configured with the maximum number of IQNs.
User response: Use lsmdisk to list the MDisks, and
User response: None. resubmit the command against an MDisk with a mode
other than Array.
CMMVC6998E The maximum number of iSCSI
qualified names (IQNs) plus WWPNs CMMVC7011E The array cannot be created because
for the cluster is already configured. no quorum disks are currently
configured.
Explanation: The command cannot be initiated
because the maximum number of iSCSI qualified Explanation: When creating an array, quorum disks
names (IQNs) plus WWPNs for the cluster has been are required to back up metadata for the array.
reached. Creating an array while no quorum disks are
configured is not permitted. Quorum disks can be
User response: Determine whether the action is
assigned to drives in the control enclosure
required.
automatically, or manually by using the chquorum
If the action is required, review the current command.
configuration to determine whether any current iSCSI
User response: Manage the control enclosure, and
qualified name or WWPN definitions are not required.
ensure that all drives within the enclosure are online
before resubmitting the command. creating a new VDisk or resizing an existing VDisk,
you requested a VDisk size that is an incomplete
number of blocks.
CMMVC7014E The command cannot be initiated
because one or more of the drives are User response: Resubmit the command with a valid
not supported for this RAID level. VDisk size.
Explanation: Only certain RAID levels are supported
in some configurations. CMMVC7020E The command failed because the
maximum number of VDisks for this
User response: Consult the configuration guide to
I/O group already exist.
determine supported RAID levels.
Explanation: The system has a limit of VDisks per
I/O group. A new VDisk cannot be created in an I/O
CMMVC7015E The command cannot be initiated
group that has already reached the limit of VDisks.
because one or more of the drives are
located in the wrong node. User response: Choose another I/O group or delete
some VDisks in this I/O group.
Explanation: For RAID 0, all of the members must be
located in the same node. For RAID 1 or RAID 10,
mirrored pairs must be located in different nodes. CMMVC7021E The command failed because the
maximum number of VDisk copies
User response: Consult the configuration guide to
already exist.
determine which drives to use for the selected RAID
level. Explanation: The system has a limit on the number of
VDisk copies that can be created. An additional VDisk
copy cannot be created because the limit has been
CMMVC7016E Authorization has failed because the
reached.
private key is not valid for the user
name that you have specified. User response: Delete some existing VDisk copies and
resubmit the command.
Explanation: The private key and user name that you
have provided do not match what has been defined on
the cluster. CMMVC7022E The command failed because NTP is
active.
User response: Ensure that the private key is valid for
the specified user name, and log in again. Explanation: You have attempted to manually set the
cluster time while the cluster is configured to use NTP
(network time protocol) to set its time.
CMMVC7017E Login has failed because the
maximum number of concurrent CLI User response: Disable NTP, and resubmit the
sessions has been reached. command. If you are trying to set the time manually
because the cluster time is incorrect, check the settings
Explanation: The cluster supports up to 10 concurrent
on the NTP server.
CLI sessions. The login attempt would have exceeded
the supported limit.
CMMVC7023E The command failed because the
User response: Reduce the number of open CLI
requested node name is in use as the
sessions, and log in again.
failover name of another node.
Explanation: You have attempted to add a node to a
CMMVC7018E The command failed because the
cluster or rename a node that is already in the cluster.
requested VDisk size is too large.
The new name that you have requested for the node is
Explanation: The system has a maximum size for not valid because one of the nodes in the cluster has
virtual disks (VDisks) that is currently 256 TB. While been configured with the requested new name as its
creating a new VDisk or resizing an existing VDisk, failover name.
you requested a VDisk size that exceeds the maximum.
User response: Either resubmit the command
User response: Resubmit the command with a smaller specifying a different node name, or modify the
VDisk size. configuration of the node in the cluster to change its
matching failover name to a different failover name.
632 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC7024E • CMMVC7033E
CMMVC7024E The command failed because the CMMVC7029E The task cannot be completed
maximum number of file systems because one or more of the target
already exist. VDisks of the FlashCopy mappings is
the primary of a mirroring Metro Mirror
Explanation: The maximum number of file systems
or Global Mirror relationship.
has been reached. Additional file systems cannot be
created. Explanation: The target VDisk is part of a remote
copy relationship that is active.
User response: Remove an unused file system and
reissue the command, or extend an existing file system User response: Either force stop the FlashCopy
by creating the VDisk there. consistency group or stop any remote copy
relationships.
CMMVC7025E The command failed because the
VDisk is associated with a file system CMMVC7030E The task cannot be completed
and cannot be removed under your because the target VDisk of the
current user role. FlashCopy mapping is the primary of a
mirroring Metro Mirror or Global
Explanation: You are attempting to remove a VDisk
Mirror relationship.
that is associated with a file system. However, you do
not possess the required role for file system actions and Explanation: The target of the FlashCopy map is a
VDisk removal. component of an active FlashCopy map.
User response: Resubmit the task using the SONAS User response: Either force stop the FlashCopy map
remove VDisk command. or stop the remote copy relationship.
CMMVC7026E The command failed because VDisks CMMVC7031E The task cannot be completed
exist in the file system. because the FlashCopy mapping target
VDisk is a secondary in a Metro Mirror
Explanation: You are attempting to delete an MDisk
or Global Mirror relationship, or is the
group with which VDisks are associated. The MDisk
primary in an active relationship.
group cannot be removed while the associated VDisks
remain. Explanation: The target VDisk of the FlashCopy map
is part of an active remote copy relationship.
User response: Remove the file system VDisks, and
resubmit the command to remove the MDisk group. User response: Stop the remote copy relationship.
CMMVC7027E The command failed because the CMMVC7032E The task cannot be completed
requested action is not permitted on a because one or more of the target
VDisk that is in a file system. VDisks of the FlashCopy mappings is
either a secondary in a Metro Mirror or
Explanation: The VDisk that you have specified is
Global Mirror relationship or the
associated with a file system, which disallows the
primary of an active relationship.
requested action.
Explanation: A target VDisk of a FlashCopy map in
User response: The command cannot be completed on
the consistency group is part of an active remote copy
this VDisk. It will only succeed with a VDisk that is not
relationship.
associated with a file system.
User response: Stop any remote relationships
containing a target VDisk of a map in the consistency
CMMVC7028E The task cannot be completed
group.
because the FlashCopy target VDisk that
you have specified is in a Metro Mirror
or Global Mirror relationship, and the CMMVC7033E The task failed because the current
I/O group of the VDisk is different than hardware configuration is not valid.
that of the proposed FlashCopy
Explanation: You have issued the “chnodehw”
mapping.
command to enable new hardware that is faulty,
Explanation: The FlashCopy map must be in the same unsupported, or incompletely installed.
I/O group as the target VDisk because the VDisk is a
User response: Follow service procedures as
component of a remote copy relationship.
prompted by the management GUI to correct the
User response: Specify the I/O group of the target hardware configuration. Then reissue the command.
VDisk when creating the FlashCopy map.
634 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC7048E • CMMVC7056E
CMMVC7048E The action failed because the Explanation: The LDAP server type that you have
compressed VDisk copies are not all specified is predefined to perform nested group search.
corrupted.
User response: Check your command to ensure that
Explanation: You have issued the repairsevdiskcopy you have specified the correct type. Remember that the
or recovervdisk -copy command against a compressed following rules apply to type and -nestedgroupsearch:
VDisk copy that is not marked as corrupt. Unlike v If the type is itds, -nestedgroupsearch cannot be
thin-provisioned VDisk copies, the repair process for processed
compressed VDisk copies can only be run if the system
v If the type is ad, -nestedgroupsearch can only be set
detects that they are corrupted.
to client or off because there is no server support.
User response: The issued command is not required. v If the type is other, the -nestedgroupsearch
If the VDisk is offline, consult the Troubleshooting Guide parameter is fully configurable
to resolve the problem.
After making your correction, resubmit the command.
CMMVC7049E The command failed because VDisks
are obstructing resources required by CMMVC7053E The task cannot be initiated because
the compression function. the nested group search value (server) is
Explanation: Compression could not be enabled not valid for the target LDAP server
because a VDisk prevented internal resources from type.
being reassigned from cache. A VDisk is offline or data Explanation: The LDAP server type that you have
could not be flushed from the cache quickly enough. specified only supports client-side nested group search.
User response: If any VDisks are offline, follow User response: Reissue the task specifying client-side
service procedures to bring them online before nested group search.
resubmitting the command.
User response: Remove a configured LDAP server, semicolon (;), or plus sign (+), and include special
and resubmit the task. characters and UTF-8 characters that are
appropriately escaped with a backslash (\).
CMMVC7057E The task cannot be initiated because v NT logins are valid for Active Directory only and
the specified LDAP server is the only should be in the format DOMAIN\user. They must
configured LDAP server. not start or end with a period (.) and both DOMAIN
and user must exclude characters in the set: \ / : ? "
Explanation: Removing the specified LDAP server <>|
would result in the failure of the remote authentication
v UPN logins are valid for Active Directory only and
service.
must be in the format user@suffix. Both user and
User response: Disable the remote authentication suffix must exclude spaces and the following
service by submitting the chauthservice command, and characters: ( ) < > , ; : \ " [ ] @
reissue the task.
User response: Reissue the task specifying a valid
Distinguished Name, NT login, or User Principal
CMMVC7058E The task cannot be initiated because Name.
no LDAP server is configured.
Explanation: The LDAP remote authentication service CMMVC7062E The task cannot be initiated because
cannot be used until at least one LDAP server has been you have specified an LDAP attribute
configured. To configure LDAP servers, the that is not valid.
mkldapserver command can be submitted.
Explanation: An LDAP attribute name can contain
User response: Configure a valid LDAP server, and only alphanumeric characters and hyphens, and the
reissue the task. name must begin with a letter.
User response: Reissue the task specifying a valid
CMMVC7059E The task cannot be initiated because LDAP attribute name.
some remote users are not configured
with an SSH key and password for the
CMMVC7063E The task cannot be initiated because
specified remote authentication service.
the Distinguished Name that you have
Explanation: An SSH key and password are required specified is not valid.
for all users of the remote authentication service. To
Explanation: A Distinguished Name must be a
identify remote users without an SSH key and
sequence of attribute=value pairs separated by a
password, the lsuser command can be submitted. To
comma (,), semicolon (;), or plus sign (+) that includes
configure the user's authentication settings, you can use
special characters and UTF-8 characters escaped with a
the chuser command.
backslash (\).
User response: Configure the remote users with an
User response: Reissue the task specifying a valid
SSH key and password or configure the users as local.
Distinguished Name.
636 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC7065E • CMMVC7071E
CMMVC7065E User authentication failed because a CMMVC7068E User authentication failed because
timeout occurred while communicating one or more LDAP servers rejected an
with one or more LDAP servers. attempt to bind with the LDAP
administrator credentials configured on
Explanation: A timeout occurred while the cluster was
the cluster.
attempting to contact the LDAP servers. This timeout
might be caused by a TCP/IP network problem, the Explanation: A user name and password were
LDAP servers not operating correctly, or by an incorrect configured on the cluster for LDAP authentication and
IP address and port being defined for the LDAP an LDAP server has refused an attempt to bind with
servers. The event has been logged and the these credentials. The event has been logged and the
corresponding service procedure can be used to resolve corresponding service procedure can be used to resolve
this issue. To change the IP address and port of an this issue. To change the user name and password
LDAP server, a security administrator can use the defined on the cluster, a security administrator can
chldapserver command. submit the chldap command.
User response: Ensure that LDAP servers and the User response: Ensure that the LDAP credentials
TCP/IP network between them and the cluster are configured on the cluster match the credentials that are
functional. Ensure that the IP address and port defined configured on all LDAP servers, and reissue the task.
for each LDAP server is correct, and reissue the task.
CMMVC7069E User authentication failed because
CMMVC7066E User authentication failed because an one or more LDAP servers report an
SSL connection could not be established incorrect user name or password.
with one or more LDAP servers.
Explanation: The user name and password that you
Explanation: An incorrect LDAP security have provided do not match any user name and
configuration exists on the cluster or an SSL certificate password on the configured LDAP servers. If the
on the cluster is not valid. The event was logged and password for the user name has recently changed on
the corresponding service procedure is available to the configured LDAP servers, it may be necessary to
resolve this issue. To turn off transport layer security, a force the cluster to refresh its authentication cache. To
security administrator can submit the chldap command force a refresh, a security administrator can submit the
or submit the chldapserver command to set the SSL chauthservice -refresh command.
certificate for an LDAP server.
User response: Ensure that the user name and
User response: Ensure that the SSL configuration on password are correct. Ensure that any recently changed
each LDAP server is correct and that the SSL certificate passwords are flushed from the cache of the cluster,
defined in the cluster for each LDAP server is correct, and reissue the task.
or ensure that Transport Layer Security is disabled.
Then reissue the task.
CMMVC7070E User authentication failed because
the LDAP user attribute is incorrectly
CMMVC7067E User authentication failed because configured on one or more LDAP
one or more LDAP servers rejected an servers.
anonymous bind attempt.
Explanation: The LDAP configuration on the cluster
Explanation: A user name and password were not specifies an LDAP user attribute that does not exist on
specified on the cluster for LDAP authentication and the LDAP server. Users cannot be identified by user
the LDAP server has refused an attempt to bind name because the attribute is incorrectly configured.
anonymously. The event has been logged and the The event has been logged and the corresponding
corresponding service procedure can be used to resolve service procedure is available to resolve this issue. To
this issue. To configure a user name and the password specify a different user attribute, a security
for LDAP authentication, a security administrator can administrator can submit the chldap command.
submit the chldap command.
User response: Ensure that the LDAP user attribute
User response: Ensure that all LDAP servers are specified on the cluster is correct. Ensure that the
configured to allow anonymous bind, or configure a schema on the configured LDAP servers includes the
user name and password for LDAP authentication. specified attribute, and reissue the task.
Then reissue the task.
CMMVC7071E User authentication failed because
the LDAP group attribute is incorrectly
configured on one or more LDAP
servers.
Explanation: The LDAP configuration on the cluster
specifies an LDAP group attribute that does not exist credentials allow the LDAP server to be searched, and
on the LDAP server. The groups to which a user reissue the task.
belongs cannot be identified because the attribute is
incorrectly configured. The event has been logged and
CMMVC7075I The LDAP task completed
the corresponding service procedure can be used to
successfully.
resolve this issue. To specify a different group attribute,
a security administrator can submit the chldap Explanation: The LDAP task completed successfully.
command.
User response: None.
User response: Ensure that the LDAP group attribute
specified on the cluster is correct. Ensure that the
schema on the configured LDAP servers includes the CMMVC7076E VOLUME cannot be created with
specified attribute, and reissue the task. VALUE without VALUE.
Explanation: You are attempting to create a thin
CMMVC7072E User authentication failed because provisioned file system volume without compression.
the LDAP group attribute is not in a Thin provisioned file system volumes must include
valid format on one or more LDAP compression.
servers. User response: Create a thin provisioned file system
Explanation: The LDAP group attribute in the user volume with compression or create a file system
entry on the configured LDAP servers is in an invalid volume without thin provisioning.
format. The event has been logged and the
corresponding service procedure can be used to resolve CMMVC7077E The command failed because adding
this issue. The attribute must be a multivalued attribute a thin provisioned copy to a file system
containing the distinguished names of groups, or a volume is not allowed.
colon-separated list of up to eight user group names.
Explanation: You are attempting to add a VDisk copy
User response: Ensure that the LDAP group attribute to a file system volume that is not compressed but is
is correctly formatted on the LDAP servers, and reissue thin provisioned. Only copies with compression or
the task. without thin provisioning can be added to file system
volumes.
CMMVC7073E User authentication failed because User response: Add a copy either with compression
the LDAP audit log attribute is not or without thin provisioning to the file system volume.
configured correctly on one or more
LDAP servers.
CMMVC7078E The command cannot be initiated
Explanation: The LDAP configuration on the cluster because adding a copy to the storage
specifies an LDAP audit log attribute that does not pool of file system VDisks is not
exist on the LDAP server. The string to use in the audit allowed.
log cannot be identified because this attribute is
incorrectly configured. The event has been logged and Explanation: You are attempting to add a VDisk copy
the corresponding service procedure can be used to to a file system volume from a different storage pool.
resolve this issue. To specify a different audit log Only copies from the same storage pool can be added
attribute, a security administrator can issue the chldap to file system volumes.
command. User response: Add a VDisk copy to a storage pool
User response: Ensure that the LDAP audit log within the same file system VDisk, only.
attribute is correctly specified on the cluster. Ensure
that the schema on the LDAP servers includes the CMMVC7079E The command failed because a
specified attribute, and reissue the task. volume copy must be different when
added to a file system volume.
CMMVC7074E The task cannot be initiated because Explanation: You are only allowed to add a different
the user could not be found on any of volume copy to perform conversions between
the configured LDAP servers. uncompressed and compressed.
Explanation: The remote user is configured but either User response: Add a compressed copy to a file
no entry for the user exists on the configured LDAP system volume with an uncompressed copy or an
servers, or more than one entry was found. The event uncompressed copy to a file system volume with a
has been logged and the corresponding service compressed copy.
procedure can be used to resolve this issue.
User response: Ensure that the user name is unique
on the LDAP servers. Ensure that the LDAP bind
638 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC7080W • CMMVC7159E
Explanation: The nodes of an I/O group must be with VDisks of a different size.
brought online before the change VDisk can be
User response: Choose a change VDisk with a size
associated.
that matches those with which it is being associated.
User response: Ensure that the nodes of the I/O
group are online.
CMMVC7165E The change VDisk could not be
disassociated because the Metro Mirror
CMMVC7160E The change VDisk could not be or Global Mirror relationship does not
associated because the I/O group has have one configured.
insufficient free bitmap space.
Explanation: An attempt was made to disassociate a
Explanation: The I/O group must have additional change VDisk where one does not currently exist.
bitmap space to allow the change VDisk to be
User response: Verify whether the intended change
associated.
VDisk was specified.
User response: Increase the total bitmap space of the
I/O group.
CMMVC7166E The change VDisk could not be
disassociated because it is currently in
CMMVC7161E The change VDisk could not be use by the Metro Mirror or Global
associated because the master change Mirror relationship.
VDisk can only be configured from the
Explanation: An attempt was made to disassociate a
master cluster, and the auxiliary change
change VDisk that is currently in use.
VDisk from the auxiliary cluster. The
change VDisk must be configured from User response: Verify whether the intended change
the remote cluster. VDisk was specified.
Explanation: A change VDisk must be associated from
a cluster of the same type (master or auxiliary). CMMVC7167E The change VDisk could not be
associated because it is mapped to a
User response: Configure the change VDisk from the
host.
remote cluster.
Explanation: A change VDisk cannot be associated if
it is mapped to a host.
CMMVC7162E The change VDisk could not be
associated because one is already User response: Unmap the change VDisk from its
configured for the specified Metro host, or choose a different change VDisk.
Mirror or Global Mirror relationship.
Explanation: A change VDisk has been previously CMMVC7168E The VDisk-to-host mapping was not
configured for the specified Metro Mirror or Global created because the VDisk is a change
Mirror relationship. VDisk for a Metro Mirror or Global
Mirror relationship.
User response: Ensure that the change VDisk is
associated where a change VDisk has not been Explanation: A VDisk cannot be mapped to a host if it
configured. is associated as a change VDisk.
User response: Choose a different change VDisk.
CMMVC7163E The change VDisk could not be
associated because it is already involved
in a Metro Mirror or Global Mirror CMMVC7169E The Remote Copy relationship could
relationship. not be deleted because this would
corrupt the secondary VDisk.
Explanation: The change VDisk is currently associated
with a Metro Mirror or Global Mirror relationship. Explanation: The deletion of the relationship is being
prevented as a safeguard against corrupting the
User response: Choose an unassociated change VDisk secondary. The result can be prevented by allowing
for the specified Metro Mirror or Global Mirror resynchronization, or by overriding the safeguard.
relationship.
User response: Allow the relationship to become
synchronized before deleting, or reissue the command
CMMVC7164E The change VDisk could not be with the -force flag to allow corruption of the
associated because its size is different secondary.
from those in the Metro Mirror or
Global Mirror relationship.
Explanation: A change VDisk cannot be associated
640 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC7170E • CMMVC7180E
CMMVC7170E The Remote Copy relationship could CMMVC7175E Enabling access to the secondary
not be created because the specified VDisks of the Remote Copy consistency
master VDisk is already a change VDisk group could not be completed because
for a different relationship. the relationships in the group are not
mutually consistent.
Explanation: A master VDisk cannot be selected as a
change VDisk of a Remote Copy relationship while Explanation: The relationships in the consistency
currently defined for a different relationship. group must be mutually consistent before access to the
secondary VDisks can be enabled.
User response: Choose a different master VDisk.
User response: Ensure that the relationships in the
Remote Copy consistency group are mutually
CMMVC7171E The Remote Copy relationship could
consistent.
not be created because the specified
auxiliary VDisk is already a change
VDisk for a different relationship. CMMVC7176E The Remote Copy relationship could
not be added to the consistency group
Explanation: An auxiliary VDisk cannot be selected as
because the cycling modes do not
a change VDisk of a Remote Copy relationship while
match.
currently defined for a different relationship.
Explanation: The cycling modes of the Remote Copy
User response: Choose a different auxiliary VDisk.
relationship and the consistency group to which it is
being added must match.
CMMVC7172E Enabling access to the secondary
User response: Ensure that the cycling modes match.
VDisk of the Remote Copy relationship
could not be completed in a reasonable
time. CMMVC7177E The Remote Copy relationship could
not be added to the consistency group
Explanation: A timeout occurred before the task could
because the cycling periods do not
be completed. The relationship is continuing to enable
match.
access, and will have a state of idling when access is
enabled. Explanation: The cycling periods of the Remote Copy
relationship and the consistency group to which it is
User response: Check the event log for any events to
being added must match.
be resolved, and resubmit the task.
User response: Ensure that the cycling periods match.
CMMVC7173E Enabling access to the secondary
VDisks of the Remote Copy consistency CMMVC7178E The Remote Copy relationship could
group could not be completed in a not be started in a reasonable time. It is
reasonable time. now stopped.
Explanation: A timeout occurred before the task could Explanation: A timeout occurred before the task could
be completed. The consistency group is continuing to be completed.
enable access, and will have a state of idling when
User response: Check the event log for any problems
access is enabled.
that need to be resolved, and resubmit the task.
User response: Check the event log for any problems
that need to be resolved, and resubmit the task.
CMMVC7179E The Remote Copy consistency group
could not be started in a reasonable
CMMVC7174E The task cannot be completed time. It is now stopped.
because the other cluster is running a
Explanation: A timeout occurred before the task could
software version that is not recent
be completed.
enough.
User response: Check the event log for any problems
Explanation: The software version of the one of the
that need to be resolved, and resubmit the task.
clusters is not supported.
User response: Upgrade the software version of the
CMMVC7180E The Remote Copy relationship could
cluster.
not be started because no master change
VDisk is defined.
Explanation: A master change VDisk must be defined
for the Remote Copy relationship.
CMMVC7182E The Remote Copy consistency group CMMVC7188E The command failed because the
could not be started because no master master virtual disk (VDisk) is in a file
change VDisk is defined. system.
Explanation: A master change VDisk must be defined Explanation: The specified task cannot be performed
for the Remote Copy consistency group. on a master VDisk while it is in a file system.
User response: Define a master change VDisk. User response: Choose a different master VDisk, if the
specified VDisk cannot be removed from the file
system.
CMMVC7183E The Remote Copy consistency group
could not be started because no
auxiliary change VDisk is defined. CMMVC7189E The change VDisk could not be
associated because it is in a file system.
Explanation: An auxiliary change VDisk must be
defined for the Remote Copy consistency group. Explanation: The specified change VDisk cannot be
associated while it is in a file system.
User response: Define an auxiliary change VDisk.
User response: Choose a different change VDisk, if the
specified VDisk cannot be removed from the file
CMMVC7184E The task cannot be completed as the system.
Remote Copy object is not stopped.
Explanation: The task cannot be completed as the CMMVC7203E The command failed because the
Remote Copy object is not stopped. hardware configuration of the local
User response: Stop the Remote Copy object. cluster is not compatible with the code
of a partnered cluster.
CMMVC7185E The change VDisk could not be Explanation: The hardware configuration of the local
associated because the Metro Mirror or cluster is not compatible with the code of a partnered
Global Mirror relationship has a VDisk cluster. See the chnodehw explanation for more
on this cluster that is in a different I/O information.
group. User response: Make sure the hardware configuration
Explanation: The I/O group of the change VDisk and code level of all the clusters in a partnership are
conflicts with an I/O group in the relationship with compatible before you create the partnership. Run
which an association was attempted. chnodehw for diagnostic information.
CMMVC7186E The Remote Copy relationship was Explanation: The user entered a command which is
not created because the master virtual not supported by the product they are using.
disk (VDisk) is in a file system. User response: Review the documentation and select
Explanation: The specified task cannot be performed an appropriate command for the product.
while the master VDisk is in a file system.
User response: Choose a different master VDisk, if the CMMVC7206E The command failed because a
specified VDisk cannot be removed from the file parameter is not supported.
system. Explanation: The user entered a parameter which is
not supported by the product they are using.
User response: Review the documentation and select
642 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC7218E • CMMVC7239E
CMMVC7242E No help available for [%1]. Explanation: A drive fault is preventing further
actions.
Explanation: There is no help available for this
command. [%1] shows the command for which help is User response: Replace the drive.
not available.
User response: None. CMMVC7306E The command cannot be initiated
because no array currently exists.
CMMVC7243E The specified port mask cannot be Explanation: No array has been created. No further
applied because insufficient paths action is possible.
would exist for node communication. User response: Create an array before using this
Explanation: The localfcportmask port mask value command.
that was specified would cause one or more nodes to
lose contact with the system. CMMVC7307E The command cannot be initiated
User response: Check zoning. Fix any port errors in because the battery slot number
the event log. Use the lsfabric CLI command to specified is invalid.
ensure that when the correct port mask is specified and Explanation: Batteries occupy slot numbers 1 and 2
applied, all nodes would still have two paths to contact only for batteries.
every other node in the system.
User response: Select Slot 1 or 2.
644 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC7311E • CMMVC7325E
646 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8005E • CMMVC8019E
CMMVC8005E Cannot execute on a node displaying CMMVC8012E The operation did not complete in
hardware errors. the time allowed.
Explanation: You cannot execute this operation on a Explanation: The operation did not complete in the
node displaying hardware errors. time allowed.
User response: Fix the errors or choose another node User response: Set the time allowed for operations to
and try the operation again. complete appropriately. Determine if another operation
or error caused the problem.
CMMVC8006E Cannot execute on a node displaying
errors. CMMVC8013E Incompatible parameters set.
Explanation: You cannot execute this operation on a Explanation: Parameters provided are mutually
node displaying errors. exclusive.
User response: Fix the errors or choose another node User response: Set appropriate parameters and try the
and try the operation again. operation again.
CMMVC8009E Cannot execute on a node canister. CMMVC8016E Node would be clustered if not in
service state.
Explanation: You cannot execute this operation on a
node canister. Explanation: Cannot run because the node will be in
cluster when it exits service.
User response: Choose an appropriate target and try
the operation again. User response: Fix the problem and try the operation
again.
CMMVC8010E Not from a USB stick.
CMMVC8017E Info value not recognised.
Explanation: You cannot execute this operation from a
USB stick. Explanation: Info value not recognized.
User response: Change location to an appropriate User response: Use a valid info value and try the
place and try the operation again. operation again.
CMMVC8011E Version too high for this client. CMMVC8018E Provided buffer was too small.
Explanation: You cannot execute this operation during Explanation: Provided buffer was too small.
CCU.
User response: Increase the buffer size.
User response: Wait until the CCU has completed and
try the operation again.
CMMVC8019E Task could interrupt IO and force
flag not set.
Explanation: Running on an active node could impact
I/O.
User response: [User response needed]. User response: Wait a few moments and try again.
648 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8036E • CMMVC8053E
CMMVC8037E A required parameter is missing. CMMVC8046E Partner node has lost cluster data.
Explanation: A required parameter is missing. Explanation: Partner node has lost cluster data.
User response: Rerun the operation with the required User response: [Need user response].
parameter set.
CMMVC8047E Not a valid ssh key.
CMMVC8038E Required parameters are missing.
Explanation: Argument is not a valid ssh key.
Explanation: Required parameters are missing.
User response: Use a valid ssh key for the argument.
User response: Rerun the operation with the required
parameters set.
CMMVC8048E Invalid file permissions.
Explanation: Cannot execute the argument. The file
CMMVC8039E The [%1] parameter is missing its
has invalid file permissions.
associated arguments.
User response: Set valid file permissions.
Explanation: The parameter is missing an argument.
User response: Rerun the operation with the required
CMMVC8049E Invalid cluster name.
arguments for the parameter.
Explanation: User provided an invalid cluster name.
CMMVC8040E [%1] is not a supported parameter. User response: Use a valid cluster name.
Explanation: The parameter is not supported.
CMMVC8050E Unable to unpack files.
User response: Rerun the operation using a supported
parameter. Explanation: Install failed because we failed to unzip
install package.
CMMVC8041E [%1] is not a valid command line User response: Unzip install package and retry.
option.
Explanation: The command given does not exist. CMMVC8051E Utilities package installed.
User response: Use an existing command. Explanation: The utilities package installed
successfully.
CMMVC8042E Invalid or inconsistent arguments. User response: None.
Explanation: Invalid or inconsistent arguments. For
example, the argument at the end is not a recognized CMMVC8052E Utilities package installed.
panel id.
Explanation: The package install signature verify
User response: Use valid and consistent arguments. failed.
User response:
CMMVC8043E This command can only be run by
the superuser.
CMMVC8053E The specific upgrade package cannot
Explanation: Cannot execute because user is not be installed on this hardware level.
superuser.
Explanation: The software is incompatible with the
User response: Have a superuser run the command. hardware level.
User response:
CMMVC8044E Command completed successfully.
Explanation: Command completed successfully. This
message is only used within lscmdstatus.
User response: None.
650 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8066E • CMMVC8266E
User response: The user must cancel the current User response: Use lshostvdiskmap to find the list of
upgrade that is in progress and re-prepare with the vdisks that are mapped to the host in multiple iogrps.
desired upgrade package. Then for each one either a) remove the host/vdisk
mapping or b) remove the iorgp that the host is being
removed from the vdisk's access iogrp set.
CMMVC8269E The attempt to prepare the cluster for
upgrade has failed because the previous
upgrade is in prepare_failed state. The CMMVC8274E The entry in the event log cannot be
previous upgrade must first be aborted fixed because the given sequence
before reattempting the upgrade. number is out of range.
Explanation: The current status of Explanation: The event log entry sequence number
lssoftwareupgradestatus reports the upgrade as must be in the range 100 to 9,999,999 inclusive.
prepare_failed. This is an indication the user has User response: Please supply a valid event log entry
already attempted to prepare an upgrade, or started an sequence number in the range 100 to 9,999,999
upgrade and in either scenario, the prepare has failed inclusive.
due to offline vdisks. The cache flush has failed.
User response: The user needs to correct the error that
caused the prepare to fail. Offline vdisks are the most
652 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8275E • CMMVC8298E
CMMVC8275E An entry with the given sequence CMMVC8280E The host has at least one volume
number cannot be found in the event mapped which is accessible through
log. more than one I/O group, and the port
being added is from a host system
Explanation: The fix request has failed because an
which does not support volumes being
entry with the given sequence number cannot be found
mapped from multiple I/O groups.
in the event log.
Explanation: The host has at least one volume
User response: Please supply a sequence number of
mapped which is accessible through more than one I/O
an entry that exists in the event log.
group, and the port being added is from a host system
which does not support volumes being mapped from
CMMVC8276E The entry in the event log cannot be multiple I/O groups.
fixed because it has expired or is in the
User response: Choose a different port to add to the
monitoring state.
host.
Explanation: The entry in the event log cannot be
fixed because it has expired or is in the monitoring
CMMVC8281E The host has at least one volume
state.
mapped which is accessible through
User response: Expired and monitoring entries in the more than one I/O group, and the port
event log cannot be fixed. being added is from a host with an iscsi
name. Iscsi hosts do not support
volumes being mapped from multiple
CMMVC8277E The MTM format must be XXXX-YYY I/O groups.
where X is a numeric value, and Y is
numeric or upper case character. Explanation: The host has at least one volume
mapped which is accessible through more than one I/O
Explanation: The user has attempted to change the group, and the port being added is from a host with an
MTM but provided an incorrect format. iscsi name. Iscsi hosts do not support volumes being
User response: Reissue the command with the MTM mapped from multiple I/O groups.
with the correct format. The format must be XXXX-YYY User response: Choose a different port to add to the
where XXXX are numeric values and YYY are host.
alphanumeric characters. Any alphabetic characters
must be upper case.
CMMVC8282E At least one host mapped to the
volume does not support volumes being
CMMVC8278E The volume is accessible through mapped from multiple I/O groups.
more than one I/O group, and the host
being mapped to the volume does not Explanation: At least one host mapped to the volume
support volumes being mapped from does not support volumes being mapped from multiple
multiple I/O groups. I/O groups.
Explanation: The volume is accessible through more User response: Unmap the host which does not
than one I/O group, and the host being mapped to the support access from multiple I/O groups.
volume does not support volumes being mapped from
multiple I/O groups.
CMMVC8283E At least one host mapped to the
User response: Choose a different host or volume to volume has an iscsi name. Iscsi hosts do
map. not support volumes being mapped
from multiple I/O groups.
CMMVC8279E The volume is accessible through Explanation: At least one host mapped to the volume
more than one I/O group, and the host has an iscsi name. Iscsi hosts do not support volumes
being mapped to the volume has an being mapped from multiple I/O groups.
iSCSI name. iSCSI hosts do not support
User response: Unmap the host which does not
volumes being mapped from multiple
support access from multiple I/O groups.
I/O groups.
Explanation: The volume is accessible through more
CMMVC8298E The system cannot open the file.
than one I/O group, and the host being mapped to the
volume has an iSCSI name. iSCSI hosts do not support Explanation: The file specified after the -file option
volumes being mapped from multiple I/O groups. cannot be opened.
User response: Choose a different host or volume to User response: Refer to the documentation for the
map. upgrade file to ensure that the upgrade file is correct.
User response: Refer to the documentation for the Explanation: An svctask applydrivesoftware
upgrade file to ensure that the upgrade file is correct. command has been issued, but some drives that have
been specified are offline.
Obtain a new copy of the correct package file, copy it
to the system, then run the command again. User response: Ensure the drives specified are in the
online or degraded state.
654 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8309E • CMMVC8319E
| CMMVC8321E The '-drive' option requires a drive | Explanation: The command is stopped if user change
| ID. | the use of the drive, because some drive may be
| changed to "unused" while the command is ongoing.
| Explanation: One or more drive IDs should be listed
| after the '-drive' option. | User response: Check the use of the drive that you
| specified on the command line. If it is still appropriate
| User response: Repeat the command, using the correct | to upload new firmware to the drive, repeat the
| syntax. | command.
| CMMVC8322E The task cannot be initiated because | CMMVC8327E The -allowreinstall and
| some of the specified drives have an | -allowdowngrade options cannot be
| unsupported drive technology. | used with option -type fpga.
| Explanation: Drive technology is the value of field | Explanation: When we applydrivesoftware fpga type
| "tech_type" of "svcinfo lsdrive". The technology should | drives, we don't permit to reinstall or downgrade
| be "sas_ssd", "sas_hdd", or "sas_nearline" but not | drives.
| "unsupported".
| User response: To download drive FGPA software,
| User response: Use the lsdrive command to | repeat the command but ensure the -allowreinstall and
| determine which drives have an unsupported drive | -allowdowngrade options are omitted.
| technology. Repeat the command but do not include
| the drive ID of any drive with an unsupported drive
| type. | CMMVC8328E No package file is specified or
| invalid package file name is used.
| CMMVC8323E The task cannot be applied to unused | Explanation: User input invalid package file name.
| drives when multiple drives are
| User response: Please input right package file name,
| specified.
| and repeat the command.
| Explanation: applydrivesoftware can not be applied
| to drives whose status are "unused".
| CMMVC8329E The task cannot be initiated because
| User response: Repeat the command, but do not | downloading to one or more drives
| include the drive ID of any drive that is currently | could cause volumes to go offline. Force
| unused. | is required.
| Explanation: With any drive software upgrade there is
| CMMVC8324E There are no drive software upgrades | a risk that the drive might become unusable. If the
| scheduled. | drive is a member of a RAID0 array, consider whether
| to introduce additional redundancy to the protect the
| Explanation: The command is not ongoing while user | data on that drive.
| input -cancel option.
| User response: If the drive is not a member of a
| User response: No action is required. | RAID0 array, fix any errors in the event log that relate
| to the array. When the drive is a member of an array
| with sufficient redundancy, repeat the command.
| Alternatively, consider using the '-force' option.
656 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8336E • CMMVC8350e
CMMVC8336E Site was not specified. Site must be CMMVC8341E Site value is not valid. Can only
specified because topology is stretched. specify site 1 or site 2.
Explanation: Site was not specified. Site must be Explanation: Site value is not valid. Can only specify
specified because topology is stretched. site 1 or site 2.
User response: Identify the site of the new node and User response: Specify either site 1 or site 2.
resubmit the command with -site flag.
Or, change system topology. CMMVC8342E Cannot set stretched topology
because some nodes do not have a
Note: Changing the topology will disable the DR configured site.
feature.
Explanation: Cannot set stretched topology because
some nodes do not have a configured site.
CMMVC8337E Site specified not valid. System
User response: Configure site for each node and then
topology is stretched and the other
set topology.
member has been configured to the
same site.
CMMVC8343E Cannot set stretched topology
Explanation: Site specified not valid. System topology
because some I/O groups have 2 nodes
is stretched and the other member has been configured
in the same site.
to the same site.
Explanation: Cannot set stretched topology because
User response: Identify a node in a different site to
some I/O groups have 2 nodes in the same site.
the existing node and resubmit.
User response: Assign each node of the I/O group to
Or, change system topology.
a different site then set topology.
CMMVC8339E Not supported on this system. | Explanation: All IP partnerships must be stopped
| before rcauthmethod can be changed.
Explanation: Not supported on this system.
| User response: Use chpartnership -stop to stop
User response: The feature is SAN Volume Controller | partnerships, then run the command again.
only. Wait for a later release.
| safe to remove without issuing a chnodebattery | User response: No action possible. The only option is
| -remove command. To turn on the LED, the battery | to remove the existing partnership and create a new
| must be replaced and brought online. | partnership.
| CMMVC8351e The command has failed because the | CMMVC8357e Maximum number of allowed
| specified battery is not redundant. | partnerships exceeded.
| Explanation: A request to prepare a battery for | Explanation: This error occurs when the administrator
| removal cannot be completed because the specified | attempts to set up more than 3 partnerships. A
| battery is not redundant. | maximum of 3 FC partnerships, or 2 FC and 1 IP
| partnerships, can exist.
| User response: Remove the condition that is causing
| the lack of redundancy. Such conditions may include | User response: No action possible. The only option is
| the partner battery being offline or not fully charged, or | to remove one of the existing partnerships and create a
| one of the boot drives being offline. | new partnership.
| CMMVC8352e The task cannot be initiated because | CMMVC8358e No local cluster IPs for the
| the download type is not valid. | partnership type configured.
| Explanation: If -type is specified, only firmware or | Explanation: This error occurs when the administrator
| fpga is supported now. | tries to create a partnership of type IPv4, but has not
| configured any IPv4 type cluster IPs on the local
| User response: Check the input download type and
| cluster. The same error is seen if the administrator tries
| repeat the command with a supported download type.
| to create a partnership of type IPv6, but has not
| configured any IPv6 type cluster IPs on the local
| CMMVC8353e CHAP authentication failure | cluster.
| Explanation: The partner discovery has refused a | User response: The administrator must execute the
| discovery request because the CHAP secret specified | cfgportip CLI to configure the local IP address
| using the. | depending on the type of IP partnership which is to be
| created.
| User response: Correct chapsecret must be provided.
| CMMVC8356e Remote Copy port groups not | CMMVC8361e All IP addresses of the partnership
| configured or incorrectly configured. | type are either down or not configured.
| Explanation: This error occurs when the administrator | Explanation: This error occurs when partner discovery
| attempts to set up more than one partnership of type | is not reporting any matching remote ports. Example:
| IPv4 or IPv6. | The partnership type is IPv4, but all ethernet ports on
658 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8362e • CMMVC8284E
660 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
CMMVC8295E • CMMVC8297E
Accessibility features
The SAN Volume Controller Information Center and its related publications are accessibility-enabled. The
accessibility features of the Information Center are described in Viewing information in the information
center in the Information Center.
Keyboard navigation
You can use keys or key combinations to perform operations and initiate menu actions that can also be
done through mouse actions. You can navigate the SAN Volume Controller Information Center from the
keyboard by using the shortcut keys for your browser or screen-reader software. See your browser or
screen-reader software Help for a list of shortcut keys that it supports.
See the IBM Human Ability and Accessibility Center for more information about the commitment that
IBM has to accessibility.
IBM may not offer the products, services, or features discussed in this document in other countries.
Consult your local IBM representative for information on the products and services currently available in
your area. Any reference to an IBM product, program, or service is not intended to state or imply that
only that IBM product, program, or service may be used. Any functionally equivalent product, program,
or service that does not infringe any IBM intellectual property right may be used instead. However, it is
the user's responsibility to evaluate and verify the operation of any non-IBM product, program, or
service.
IBM may have patents or pending patent applications covering subject matter described in this
document. The furnishing of this document does not grant you any license to these patents. You can send
license inquiries, in writing, to:
For license inquiries regarding double-byte character set (DBCS) information, contact the IBM Intellectual
Property Department in your country or send inquiries, in writing, to:
The following paragraph does not apply to the United Kingdom or any other country where such
provisions are inconsistent with local law: INTERNATIONAL BUSINESS MACHINES CORPORATION
PROVIDES THIS PUBLICATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Some
states do not allow disclaimer of express or implied warranties in certain transactions, therefore, this
statement may not apply to you.
This information could include technical inaccuracies or typographical errors. Changes are periodically
made to the information herein; these changes will be incorporated in new editions of the publication.
IBM may make improvements and/or changes in the product(s) and/or the program(s) described in this
publication at any time without notice.
Any references in this information to non-IBM Web sites are provided for convenience only and do not in
any manner serve as an endorsement of those Web sites. The materials at those Web sites are not part of
the materials for this IBM product and use of those Web sites is at your own risk.
IBM may use or distribute any of the information you supply in any way it believes appropriate without
incurring any obligation to you.
IBM Corporation
Almaden Research
650 Harry Road
Bldg 80, D3-304, Department 277
San Jose, CA 95120-6099
U.S.A.
Such information may be available, subject to appropriate terms and conditions, including in some cases,
payment of a fee.
The licensed program described in this document and all licensed material available for it are provided
by IBM under terms of the IBM Customer Agreement, IBM International Program License Agreement or
any equivalent agreement between us.
Any performance data contained herein was determined in a controlled environment. Therefore, the
results obtained in other operating environments may vary significantly. Some measurements may have
been made on development-level systems and there is no guarantee that these measurements will be the
same on generally available systems. Furthermore, some measurements may have been estimated through
extrapolation. Actual results may vary. Users of this document should verify the applicable data for their
specific environment.
Information concerning non-IBM products was obtained from the suppliers of those products, their
published announcements or other publicly available sources. IBM has not tested those products and
cannot confirm the accuracy of performance, compatibility or any other claims related to non-IBM
products. Questions on the capabilities of non-IBM products should be addressed to the suppliers of
those products.
All statements regarding IBM's future direction or intent are subject to change or withdrawal without
notice, and represent goals and objectives only.
All IBM prices shown are IBM's suggested retail prices, are current and are subject to change without
notice. Dealer prices may vary.
This information is for planning purposes only. The information herein is subject to change before the
products described become available.
This information contains examples of data and reports used in daily business operations. To illustrate
them as completely as possible, the examples include the names of individuals, companies, brands, and
products. All of these names are fictitious and any similarity to the names and addresses used by an
actual business enterprise is entirely coincidental.
COPYRIGHT LICENSE:
This information contains sample application programs in source language, which illustrate programming
techniques on various operating platforms. You may copy, modify, and distribute these sample programs
in any form without payment to IBM, for the purposes of developing, using, marketing or distributing
application programs conforming to the application programming interface for the operating platform for
which the sample programs are written. These examples have not been thoroughly tested under all
conditions. IBM, therefore, cannot guarantee or imply reliability, serviceability, or function of these
programs. The sample programs are provided "AS IS", without warranty of any kind. IBM shall not be
liable for any damages arising out of your use of the sample programs.
666 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
If you are viewing this information softcopy, the photographs and color illustrations may not appear.
Trademarks
IBM, the IBM logo, and ibm.com® are trademarks or registered trademarks of International Business
Machines Corp., registered in many jurisdictions worldwide. Other product and service names might be
trademarks of IBM or other companies. A current list of IBM trademarks is available on the web at
Copyright and trademark information at www.ibm.com/legal/copytrade.shtml.
Adobe, the Adobe logo, PostScript, and the PostScript logo are either registered trademarks or trademarks
of Adobe Systems Incorporated in the United States, and/or other countries.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation or its subsidiaries in
the United States and other countries.
Java and all Java-based trademarks and logos are trademarks or registered trademarks of Oracle and/or
its affiliates.
Linux and the Linux logo is a registered trademark of Linus Torvalds in the United States, other
countries, or both.
Microsoft, Windows, and the Windows logo are trademarks of Microsoft Corporation in the United
States, other countries, or both.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Other product and service names might be trademarks of IBM or other companies.
Notices 667
668 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Index
Special characters C CLI (command-line interface) (continued)
using to update clustered system
-filtervalue argument xxiv cancellivedump command 335 license 12
catauditlog command 107 CLI commands
caterrlog command 205 chcluster
A caterrlogbyseqnum command 205
changing
modifying cluster (system) IP
about this document address 66
passwords 79 chcurrentuser 74
sending comments xv
charray command 85 chfcmap 35
accessibility xi, 663
charraymember command 86 chlicense 12
repeat rate
chauthservice command 457 chsystem
up and down buttons 663
chcluster command 121 changing clustered system gateway
accessing
chcontroller commands 221 address 67
publications 663
chcurrentuser command 460 changing relationship
activatefeature command 431
chdrive command 230 bandwidth 67
addcontrolenclosure command 259
chemail command 239 modifying cluster (system) IP
addhostiogrp command 315
chemailserver command 241 address 66
addhostport command 315
chemailuser command 242 chuser 74
adding
chenclosure command 259 chusergrp 73
nodes 15
chenclosurecanister command 260 lscluster
addmdisk command 357
chenclosureslot command 261 modifying clustered (system) IP
addnode command 119
chenclosurevpd command 263 address 66
addvdiskaccess command 488
cherrstate command 205 lscurrentuser 74
addvdiskcopy command 483
cheventlog command 205 lsfcconsistgrp 35, 36
applydrivesoftware command 227
chfcconsistgrp command 291 lsfcmap 32, 35
applymdisksoftware command 339
chfcmap command 291 lslicense 12
applysoftware command 203, 427
chhost command 317 lssystem
array commands
chiogrp command 129 changing clustered system gateway
charray 85
chldap command 460 address 67
charraymember 86
chldapserver command 463 changing relationship
lsarray 88
chlicense command 285 bandwidth 67
lsarrayinitprogress 92
chmdisk command 339 displaying clustered system
lsarraylba 93
chmdiskgrp command 358 properties 13
lsarraymember 94
chnode / chnodecanister command 131 lssytem
lsarraymembergoals 97
chnodehw / chnodecanisterhw modifying clustered (system) IP
lsarraymemberprogress 99
command 134 address 66
lsarraysyncprogress 101
chnodeled command 432 lsuser 74
mkarray 103
chpartnership command 369 lsusergrp 73
overview 85
chquorum command 340 lsvdisk 32
recoverarray 105
chrcconsistgrp command 371 mkfcconsistgrp 35
recoverarraybysystem 105
chrcrelationship command 373 mkfcmap 32
rmarray 106
chserviceip command 433 mkuser 74
audit log commands
chsite command 134 mkusergrp 73
catauditlog 107
chsnmpserver command 243 prestartfcconsistgrp 36
dumpauditlog 108
chsyslogserver command 244 rmuser 74
lsauditlogdumps 111
chsystem command 121 rmusergrp 73
overview 107
chsystemip command 127 setlocale 79
authentication
chuser command 465 startfcconsistgrp 36
SSH logins 1
chusergrp command 466 cluster date and time
chvdisk command 489 setting 12
chwwnn command 435
B clear command 113
cluster error log
displaying 205
backup and restore commands 111 help 111 clustered syetem commands
backup command 112 cleardumps command 136, 427 rmportip 196
help 111 clearerrlog command 206 clustered system
backup commands CLI (command-line interface) authentication
backup 112 configuring PuTTY 3 configuring clustered system
clear 113 getting started 11 iSCSI 70
cron 114 preparing SSH client on AIX or configuring for iSCSI 68
Linux 6 configuring iSCSI authentication 70
preparing SSH client on Windows 2 recovering nodes 53
670 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
commands (continued) commands (continued) commands (continued)
lshostiogrp 324 migrateexts 408 setdisktrace 451
lshostvdiskmap 494 migratetoimage 409 setlocale 218, 445
lsiogrp 145 migratevdisk 410 setpacedccu 446
lsiogrpcandidate 148 mkarray 103 setpwdreset 198
lsiogrphost 147 mkcluster 440 setquorum 356
lsiostatsdumps 149, 429 mkemailserver 248 setsystemtime 197
lsiotracedumps 149, 429 mkemailuser 249 settempsshkey 446
lsiscsiauth 325 mkfcconsistgrp 301 settimezone 198
lslicense 288 mkfcmap 302 settrace 452
lslivedump 335, 336 mkfcpartnership 387 showtimezone 199
lsmdisk 344 mkhost 318 shrinkvdisksize 546
lsmdiskcandidate 350 mkippartnership 388 snap 447
lsmdiskdumps 349, 429 mkmdiskgrp 359 splitvdiskcopy 548
lsmdiskextent 351 mkrcconsistgrp 390 startemail 256
lsmdiskgrp 362 mkrcrelationship 390 startfcconsistgrp 308
lsmdisklba 349 mksnmpserver 251 startfcmap 310
lsmdiskmember 353 mksyslogserver 252 startrcconsistgrp 396
lsmigrate 407 mkuser 474 startrcrelationship 398
lsnodecandidate 153 mkusergrp 475 startservice 448
lsnodedependentvdisks 154 mkvdisk 526 startstats 200
lsnodehw / lsnodecanisterhw 154 mkvdiskhostmap 534 starttrace 454
lsnodestats / lsnodecanisterstats 156 movevdisk 536 stopcluster 201
lsnodevpd / lsnodecanistervpd 163 overridequorum 442 stopemail 256
lspartnership command 377 ping 193 stopfcconsistgrp 311
lspartnershipcandidate 331 prestartfcconsistgrp 304, 308 stopfcmap 312
lsportfc 176 prestartfcmap 305 stopnode 448
lsportip 172 recover 115 stoprcconsistgrp 400
lsportsas 179 recoverarray 105 stoprcrelationship 401
lsquorum 354 recoverarraybysystem 105 stopservice 449
lsrcconsistgrp 380 recovervdisk 537 stopsystem 201
lsrcrelationship 382 recovervdiskbyiogrp 538 stoptrace 454
lsrcrelationshipcandidate 385 recovervdiskbysystem 539 svcconfig 111
lsrcrelationshipprogress 386 repairsevdiskcopy 540 svqueryclock 219
lsrepairsevdiskcopyprogress 496 repairvdiskcopy 540 switchrcconsistgrp 403
lsrepairvdiskcopyprogress 498 rescuenode 443 switchrcrelationship 404
lsrmvdiskdependentmaps 300 resetleds 281 t3recovery 449
lsroute 181 resetpassword 443 testemail 257
lssasportcandidate 144 restartservice 444 triggerenclosuredump 282
lsservicenodes 417 restore 115 triggerlivedump 337
lsservicerecommendation 418 rmarray 106 triggermdiskdump 357
lsservicestatus 419 rmemailserver 253 user management 457
lssevdiskcopy 500 rmemailuser 253 writesernum 220
lssite 332 rmfcconsistgrp 307 commands/ lsnodecanister
lssnmpserver 247 rmfcmap 307 lsnode 149
lssoftwaredumps 217, 431 rmhost 320 comments, sending xv
lssoftwareupgradestatus 217 rmhostiogrp 326 communications
lssyslogserver 216 rmhostport 327 determining between hosts and virtual
lssystem 182 rmmdisk 366 disks 47
lssystemip 187 rmmdiskgrp 367 configuring
lssystemstats 189 rmnode / rmnodecanister 194 iSNS server address 70
lstimezones 181 rmpartnership 393 PuTTY 3
lsuser 471 rmportip 196 remote authentication service using
lsusergp 473 rmrcconsistgrp 394 CLI 71, 72
lsvdisk 503 rmrcrelationship 395 remote authentication service with
lsvdiskaccess 511 rmsnmpserver 254 Lightweight Directory Access
lsvdiskcopy 512 rmsyslogserver 254 Protocol (LDAP) using CLI 72
lsvdiskdependentmaps 515 rmuser 478 remote authentication service with
lsvdiskextent 516 rmusergrp 478 Tivoli Integrated Portal (TIP) using
lsvdiskfcmapcopies 517 rmvdisk 542 CLI 71
lsvdiskfcmappings 518 rmvdiskaccess 544 Connecting to the CLI using OpenSSH 7
lsvdiskhostmap 518 rmvdiskcopy 544 consistency group
lsvdisklba 520 rmvdiskhostmap 545 deleting FlashCopy 38
lsvdiskmember 521 satask mkcluster 441 stoppingFlashCopy 37
lsvdiskprogress 523 sendinventoryemail 255 consistency groups, Global Mirror
lsvdisksyncprogress 524 service information 413 creating 41
metadata 439 service task 431 deleting 42
Index 671
consistency groups, Global Mirror dump files filtering
(continued) listing 331, 429 FlashCopy
modifying 41 lsfeaturedumps 211 consistency groups 293
starting and stopping 42 dumpallmdiskbadblocks command 341 mappings 295, 300, 515, 517
consistency groups, Metro Mirror dumpauditlog command 108 finderr command 207
creating 41 dumperrlog command 206, 427 FlashCopy
deleting 42 dumpinternallog command 287 consistency group
modifying 41 dumpmdiskbadblocks command 342 deleting using CLI 38
starting and stopping 42 stopping using CLI 37
controller commands consistency groups
chcontroller 221
overview 221
E creating using CLI 35
preparing using the CLI 36
email
controllers starting using the CLI 36
inventory reports 77
changing 221 deleting consistency group 38
setting up event notification 77
command 221, 222 deleting mapping 34
email and event notification commands
cpdumps command 137 mapping
chemailserver 241
cpfiles command 436 deleting using CLI 34
chsnmpserver 243
creating stopping 33
chsyslogserver 244
host mappings 31 mappings
mkemailserver 248
creating users 8 adding to consistency group 35
mksnmpserver 251
cron command 114 creating using CLI 32
mksyslogserver 252
help 111 memory 25
rmemailserver 253
current time zone 199 stopping consistency group 37
rmsnmpserver 254
FlashCopy commands
rmsyslogserver 254
chfcconsistgrp 291
email commands
D chemail 239
chfcmap 291
mkfcconsistgrp 301
data migration progress chemailuser 242
mkfcmap 302
viewing 407 lsemailuser 247
overview 291
date and time mkemailuser 249
prestartfcconsistgrp 304, 308
setting cluster 12 overview 239
prestartfcmap 305
deactivatefeature command 432 rmemailuser 253
rmfcconsistgrp 307
deleting sendinventoryemail 255
rmfcmap 307
nodes 64 startemail 256
startfcconsistgrp 308
dependent maps stopemail 256
startfcmap 310
viewing 299 testemail 257
stopfcconsistgrp 311
detectmdisk command 138 email servers
stopfcmap 312
determining setting up
FlashCopy progress 298
communications between hosts and CLI 78
free extents 361
virtual disks 47 enclosure commands
front panel
diagnostic and service-aid commands lsenclosure 264
password 14
clearerrlog lsenclosurecanister 269
clustered system 206 lsenclosurepsu 273
cluster lsenclosureslot 275
svqueryclock 219 overridequorum 442 G
clustered system 203 overview 259 gateway address
applysoftware 203 error log dump files changing 67
cheventlog 205 viewing 429 Generating an SSH key pair using
setlocale 218, 445 error notification OpenSSH 7
writesernum 220 SYSLOG 76 getstatus command 466
dumperrlog event notification commands getting started
cluster 206 overview 239 using the CLI (command-line
finderr exit command 429 interface) 11
clustered system 207 expanding using the command-line interface
overview 203 volume 56 (CLI) 11
discovering expandvdisksize command 492 Global Mirror
managed disks 19 extent allocation memory 25
disks viewing 351 Global Mirror commands
migrating 60 extents chpartnership 369
migrating image mode 63 migrating chrcconsistgrp 371
documentation using the CLI (command-line chrcrelationship 373
improvement xv interface) 58 mkrcconsistgrp 390
drive commands mkrcrelationship 390
applydrivesoftware 227 overview 369
chdrive 230
lsdrive 231
F rmpartnership 393
rmrcconsistgrp 394
featurization settings 288
lsdrivelba 233 rmrcrelationship 395
overview 227 startrcconsistgrp 396
672 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Global Mirror commands (continued) information commands (continued) information commands (continued)
startrcrelationship 398 lserrlogbymdisk 210 lsvdiskhostmap 518
stoprcconsistgrp 400 lserrlogbymdiskgp 210 lsvdisklba 520
stoprcrelationship 401 lserrlogbynode 210 lsvdiskmember 521
switchrcconsistgrp 403 lserrlogbyrcconsistgrp 211 lsvdiskprogress 523
switchrcrelationship 404 lserrlogbyrcrelationship 211 overview 331
lserrlogbyvdisk 211 resetleds 281
lserrlogdumps 211 showtimezone 199
H lseventlog 211
lsfabric 141
stopcluster 201
triggerenclosuredump 282
help command 437
lsfcconsistgrp 293 information commands/ lsnodecanister
host commands
lsfcmap 295 lsnode 149
addhostiogrp 315
lsfcmapcandidate 297 installsoftware command 438
addhostport 315
lsfcmapdependentmaps 299 inventory commands
addvdiskaccess 488
lsfcmapprogress 298 chemail 239
chhost 317
lsfeaturedumps 211 chsystem 121
mkhost 318
lsfreeextents 361 mkemailuser 249
movevdisk 536
lshardware 414 rmemailuser 253
overview 315
lshost 321 sendinventoryemail 255
rmhost 320
lshostiogrp 324 startemail 256
rmhostiogrp 326
lshostvdiskmap 494 stopemail 256
rmhostport 327
lsiogrp 145 testemail 257
rmvdiskaccess 544
lsiogrpcandidate 148 IP addresses
host I/O group 324
lsiogrphost 147 changing 66
host objects
lsiostatsdumps 149 iSCSI alias
configuring using CLI 30
lsiotracedumps 149 configuring 69
hosts
lsiscsiauth 325 modifying 69
commands 315
lslicense 288 iSNS server address
determining VDisk names 47
lsmdisk 344 configuring 70
mapping volumes 31
lsmdiskcandidate 350
viewing 321
lsmdiskdumps 349
lsmdiskextent 351
lsmdiskgrp 362
K
I lsmdisklba 349
keyboards
accessibility features 663
image mode volumes lsmdiskmember 353
converting to managed mode lsmigrate 407
using CLI (command-line lsnodecandidate 153
interface) 62 lsnodedependentvdisks 154 L
includemdisk command 343 lsnodehw / lsnodecanister 154 language
information center xii lsnodestats / lsnodecanisterstats 156 changing locale 79
information commands 300, 460, 463, lsnodevpd / lsnodecanistervpd 163 ldapserver command 469
468, 469, 470, 477, 479, 517 lspartnership command 377 license
addcontrolenclosure 259 lspartnershipcandidate 331 changing settings 285
caterrlog 205 lsportfc 176 updating
caterrlogbyseqnum 205 lsportip 172 using the CLI (command-line
chenclosure 259 lsportsas 179 interface) 12
chenclosurecanister 260 lsquorum 354 viewing 288
chenclosureslot 261 lsrcconsistgrp 380 licensing commands 285
chnodehw / chnodecanisterhw 134 lsrcrelationship 382 chlicense 285
chsite 134 lsrcrelationshipcandidate 385 dumpinternallog 287
ls2145dumps 331 lsrcrelationshipprogress 386 Lightweight Directory Access Protocol
lscimomdumps 208 lsroute 181 (LDAP) using CLI
lscontrolenclosurecandidate 268 lssite 332 configuring remote authentication
lscontroller 222 lssnmpserver 247 service 72
lscopystatus 208 lssoftwaredumps 217 list dump command 83
lscurrentuser 467 lssyslogserver 216 livedump commands 335
lsdependentvdisks 525 lssystem 182 cancellivedump 335
lsdiscoverystatus 140 lssystemip 187 lslivedump 335, 336
lsdumps 209 lssystemstats 189 triggerlivedump 337
lsemailserver 246 lstimezones 181 locale
lsenclosurebattery 267 lsuser 471 changing 79
lsenclosurechassis 271 lsusergrp 473 ls2145dumps command 331, 429
lsenclosurestats 277 lsvdisk 503 lsarray command 88
lserrlogbyfcconsistgrp 210 lsvdiskaccess 511 lsarrayinitprogress command 92
lserrlogbyfcmap 210 lsvdiskdependentmaps 515 lsarraylba command 93
lserrlogbyhost 210 lsvdiskextent 516 lsarraymember command 94
lserrlogbyiogrp 210 lsvdiskfcmappings 518 lsarraymembergoals command 97
Index 673
lsarraymemberprogress command 99
lsarraysyncprogress command 101
lslicense command 288
lslivedump command 335, 336
M
lsauditlogdumps command 111 lsmdisk command 344 maintaining
lscimomdumps command 208, 429 lsmdiskcandidate command 350 passwords 14
lsclustervpd command 429 lsmdiskdumps command 349, 429 managed disk commands
lscmdstatus command 413 lsmdiskextent command 351 applymdisksoftware 339
lscontrolenclosurecandidate lsmdiskgrp command 362 chmdisk 339
command 268 lsmdisklba command 349 chquorum 340
lscontroller command 222 lsmdiskmember command 353 includemdisk 343
lscontrollerdependentvdisks lsmigrate command 407 lsquorum 354
command 225 lsnode command 149 overview 339
lscopystatus command 208 lsnodecandidate command 153 setquorum 356
lscurrentuser command 467 lsnodedependentvdisks command 154 triggermdiskdump 357
lsdependentvdisks command 525 lsnodehw / lsnodecanisterhw managed disk group commands
lsdiscoverystatus command 140 command 154 addmdisk 357
lsdrive command 231 lsnodestats / lsnodecanisterstats chmdiskgrp 358
lsdrivelba command 233 command 156 mkmdiskgrp 359
lsdriveprogress 235 lsnodevpd / lsnodecanistervpd overview 357
lsdriveprogress command 235 command 163 rmmdisk 366
lsdriveupgradeprogress 236 lspartnership command 377 rmmdiskgrp 367
lsdriveupgradeprogress command 236 lspartnershipcandidate command 331 managed disks
lsdumps command 209 lsportfc command 176 viewing disks 344, 349
lsemailserver command 246 lsportip command 172 viewing groups 362
lsemailuser command 247 lsportsas command 179 managed disks (MDisks)
lsenclosure command 264 lsquorum command 354 adding 23
lsenclosurebattery command 267 lsrcconsistgrp command 380 discovering 19
lsenclosurecanister command 269 lsrcrelationship command 382 rebalancing access 19
lsenclosurechassis command 271 lsrcrelationshipcandidate command 385 volume relationships 48
lsenclosurepsu command 273 lsrcrelationshipprogress command 386 managed mode virtual disks
lsenclosureslot command 275 lsrepairsevdiskcopyprogress converting from image mode
lsenclosurestats command 277 command 496 using the CLI (command-line
lserrlogbyfcconsistgrp command 210 lsrepairvdiskcopyprogress interface) 62
lserrlogbyfcmap command 210 command 498 mapping
lserrlogbyhost command 210 lsrmvdiskdependentmaps command 300 deleting FlashCopy 34
lserrlogbyiogrp command 210 lsroute command 181 master console
lserrlogbymdisk command 210 lssasportcandidate command 144 configuration 2
lserrlogbymdiskgp command 210 lsservicenodes command 417 MDisk commands
lserrlogbynode command 210 lsservicerecommendation command 418 dumpallmdiskbadblocks 341
lserrlogbyrcconsistgrp command 211 lsservicestatus command 419 dumpmdiskbadblocks 342
lserrlogbyrcrelationship command 211 lssevdiskcopy command 500 MDisks (managed disks)
lserrlogbyvdisk command 211 lssite command 332 adding 23
lserrlogdumps command 211, 429 lssnmpserver command 247 volume relationships 48
lseventlog command 211 lssoftwaredumps command 217, 431 MDisks See managed disks 339, 357
lsfabric command 141 lssoftwareupgradestatus command 217 metadata command 439
lsfcconsistgrp command 293 lssyslogserver command 216 Metro Mirror
lsfcmap command 295 lssystem command 182 memory 25
lsfcmapcandidate command 297 lssystemip command 187 Metro Mirror and Global Mirror
lsfcmapdependentmaps command 299 lssystemstats command 189 commands
lsfcmapprogress command 298 lstimezones command 181 mkfcpartnership 387
lsfcportcandidate command 143 lsuser command 471 mkippartnership 388
lsfeature command 441 lsusergrp command 473 Metro Mirror commands
lsfeaturedumps command 211 lsvdisk command 503 chpartnership 369
lsfeaturedumps commands 429 lsvdiskaccess command 511 chrcconsistgrp 371
lsfiles command 413 lsvdiskcopy command 512 mkrcconsistgrp 390
lsfreeextents command 361 lsvdiskdependentmaps command 515 mkrcrelationship 390
lshardware command 414 lsvdiskextent command 516 overview 369
lshost command 321 lsvdiskfcmapcopies command 517 rmpartnership 393
lshostiogrp command 324 lsvdiskfcmappings command 518 rmrcconsistgrp 394
lshostvdiskmap command 494 lsvdiskhostmap command 518 rmrcrelationship 395
lsiogrp command 145 lsvdisklba command 520 startrcconsistgrp 396
lsiogrpcandidate command 148 lsvdiskmember command 521 startrcrelationship 398
lsiogrphost command 147 lsvdiskprogress command 523 stoprcconsistgrp 400
lsiostatsdumps command 149, 429 lsvdisksyncprogress command 524 stoprcrelationship 401
lsiotracedumps command 149 switchrcconsistgrp 403
lsiotracedumps commands 429 switchrcrelationship 404
lsiscsiauth command 325 migrateexts command 408
lsldap command 468 migratetoimage command 409
migratevdisk command 410
674 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
migratingvolumes overview (continued) rebalancing
extents clustered system diagnostic and managed disks (MDisks) access 19
using the CLI (command-line service-aid commands 203 recover command 115
interface) 58 controller commands 221 help 111
migration 407 drive commands 227 recover commands
migration commands dumps commands 83 recover 115
migrateexts 408 email commands 239 recoverarray command 105
migratetoimage 409 enclosure commands 259 recoverarraybysystem command 105
migratevdisk 410 event notification commands 239 recovering
overview 407 FlashCopy commands 291 offline volumes
mkarray command 103 host commands 315 using CLI 52
mkcluster command 440 information commands 331 recovervdisk command 537
See sastask mkcluster licensing commands 285 recovervdiskbyiogrp command 538
mkemailserver command 248 managed disk commands 339 recovervdiskbysystem command 539
mkemailuser command 249 managed disk group commands 357 related information xii
mkfcconsistgrp command 301 migration commands 407 relationships, Global Mirror
mkfcmap command 302 secure shell 1 creating 38
mkfcpartnership command 387 service mode commands 427 deleting 41
mkhost commands 318 service mode information displaying 40
mkippartnership command 388 commands 429 modifying 39
mkldapserver command 470 tracing commands 451 starting and stopping 39
mkmdiskgrp command 359 user management commands 457 switching 40
mkrcconsistgrp command 390 relationships, Metro Mirror
mkrcrelationship command 390 creating 38
mksnmpserver command 251
mksyslogserver command 252
P deleting 41
displaying 40
partnerships, Global Mirror
mkuser command 474 modifying 39
creating 43
mkusergrp command 475 starting and stopping 39
deleting 45
mkvdisk commands 526 switching 40
modifying 44
mkvdiskhostmap command 534 remote authentication
starting and stopping 44
movevdisk command 536 configuring using CLI 71, 72
partnerships, Metro Mirror
removing
creating 43
nodes 64
deleting 45
N modifying 44
repairing
space-efficient volume 52
navigation starting and stopping 44
repairsevdiskcopy command 540
accessibility 663 passwords
repairvdiskcopy command 540
nodes changing 79
rescuenode command 443
adding 15, 119 front panel 14
resetleds command 281
addnode command 119 ping command 193
resetpassword command 443
changing 131 plink utility
restartservice command 444
chnode/ chnodecanister running 4
restore command 115
command 131 port IP addresses
help 111
deleting 64, 194 configuring 68
restore commands
lsnodestats / lsnodecanisterstats powering off
clear 113
command 156 system 81
restore 115
removing 64 prestartfcconsistgrp command 304
rmarray command 106
returning to clustered system 53 prestartfcmap command 305
rmemailserver command 253
rmnode / rmnodecanister publications
rmemailuser command 253
command 194 accessing 663
rmfcconsistgrp command 307
statistics 156 PuTTY
rmfcmap command 307
viewing 149 configuring 3
rmhost command 320
general details 18 generating an SSH key pair 2
rmhostiogrp command 326
running the plink utility 4
rmhostport command 327
scp (pscp) 9
rmldapserver command 477
O PuTTY session
configuring for the CLI 3
rmmdisk command 366
OpenSSH, Connecting to the CLI rmmdiskgrp command 367
using 7 rmnode / rmnodecanister command 194
OpenSSH, Generating an SSH key pair rmpartnership command 393
using 7 Q rmportip command 196
overridequorum command 442 quorum disks rmrcconsistgrp command 394
overview setting with CLI 24 rmrcrelationship command 395
array commands 85 rmsnmpserver command 254
audit log commands 107 rmsyslogserver command 254
backup and restore commands 111
cluster commands 119
R rmuser command 478
rmusergrp command 478
reader feedback, sending xv
rmvdisk command 542
Index 675
rmvdiskaccess command 544 service mode commands stopemail command 256
rmvdiskcopy command 544 applysoftware 427 stopfcconsistgrp command 311
rmvdiskhostmap command 545 cleardumps 427 stopfcmap command 312
running dumperrlog 427 stopnode command 448
PuTTY plink utility 4 exit 429 stopping
overview 427 FlashCopy mapping 33
service mode information commands stoprcconsistgrp command 400
S ls2145dumps 429
lscimomdumps 429
stoprcrelationship command 401
stopservice command 449
SAN Volume Controller
lsclustervpd 429 stopstats command 201
front panel password 14
lserrlogdumps 429 stopsystem command 201
properties 18
lsfeaturedumps 429 stoptrace command 454
SAN Volume Controller library
lsiostatsdumps 429 storage pools
related publications xii
lsiotracedumps 429 creating using the CLI 20
scanning
lsmdiskdumps 429 subnet mask
Fibre Channel network 19
lssoftwaredumps 431 changing 67
rebalancing MDisk access 19
overview 429 svcconfig command 111
scp
service task commands 431 svqueryclock command 219
PuTTY application 9
cpfiles 436 switchrcconsistgrp command 403
secure shell
Service task commands switchrcrelationship command 404
PuTTY 3
help 437 SYSLOG 76
secure shell (SSH)
setdisktrace command 451 system log
authenticating logins 1
setlocale command 218, 445 information 76
client
setpacedccu command 446
AIX or Linux 6
setpwdreset command 198
Windows 2
creating keys 2
setquorum command 356
setsystemtime command 197
T
overview 1 t3recovery command 449
settempsshkey command 446
secure shell client testemail command 257
settimezone command 198
preparing for CLI on AIX 6 testldapserver command 479
setting
preparing for CLI on Linux 6 time
quorum disks 24
security 1 setting clustered system
settings
sending using the CLI (command-line
email server 78
comments xv interface) 11
error notification 76
sendinventoryemail command 255 time zones 181
event notification 75
service commands tracing commands
settrace command 452
chenclosurevpd 263 overview 451
shortcut keys
chnodeled 432 setdisktrace 451
keyboard 663
chserviceip 433 settrace 452
showtimezone command 199
chwwnn 435 starttrace 454
shrinkvdisksize command 58, 546
installsoftware 438 stoptrace 454
snap command 447
leavecluster 438 trademarks 667
SNMP traps 75
lscmdstatus 413 triggerenclosuredump command 282
software
lsfcportcandidate 143 triggerlivedump command 337
upgrading using the command-line
lsfiles 413 triggermdiskdump command 357
interface (CLI) 81
lssasportcandidate 144
software packages
lsservicenodes 417
listing 431
lsservicerecommendation 418
lsservicestatus 419
viewing 217 U
splitvdiskcopy command 548 Updating
metadata 439
SSH (secure shell) license
rescuenode 443
client system using the CLI (command-line
resetpassword 443
preparing to issue CLI interface) 12
restartservice 444
commands 6 upgrading
setpacedccu 446
SSH See secure shell 1 software using the command-line
settempsshkey 446
SSH keys interface (CLI) 81
snap 447
creating 2 user groups
startservice 448
startemail command 256 creating using CLI 73
stopnode 448
startfcconsistgrp command 308 modifying using CLI 73
stopservice 449
startfcmap command 310 user management commands 457
t3recovery 449
startrcconsistgrp command 396 chauthservice 457
service information commands 413
startrcrelationship command 398 chcurrentuser 460
Service information commands
startservice command 438, 448 chuser 465
activatefeature 431
startstats command 200 chusergrp 466
deactivatefeature 432
starttrace command 454 mkuser 474
lsfeature 441
statistics 189, 460, 463, 468, 469, 470, mkusergrp 475
service mode
477, 479 rmuser 478
commands 427
stopcluster command 201 rmusergrp 478
information commands 429
676 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
users volume disks
creating 8 removing 544
creating using CLI 74 volume extent
modifying using CLI 74 viewing 516
Volume Mirroring
memory 25
V volume) 57
volumes
validating
adding a copy 28
volume copies 50
converting
VDisks (virtual disks)
from image mode to managed
determining name of 47
mode 62
viewing
creating 526
clustered systems 182
listing node dependent 46
Global Mirror
recovering 54
consistency groups 380
recovering from offline
relationships 382
using CLI 52
I/O groups 145
using the CLI 54
Metro Mirror
viewing 503
consistency groups 380
viewing disks 520
relationships 382
Viewing
license
using the CLI (command-line W
interface) 12 writesernum command 220
virtual disks (VDisks)
determining name of 47
vital product data (VPD)
listing 429
viewing 163
volume
copying 483
creating 26
deleting a copy 29
determining mappings 47
expanding 56, 57
managed disks (MDisks)
relationships 48
MDisks (managed disks)
relationships 48
migrating 61
shrinkvdisksize command 58
viewing FlashCopy mappings 518
volume commands
addvdiskcopy 483
chvdisk 489
expandvdisksize 492
lscontrollerdependentvdisks 225
lsrepairsevdiskcopyprogress 496
lsrepairvdiskcopyprogress 498
lssevdiskcopy 500
lsvdiskcopy 512
lsvdisksyncprogress 524
mkvdisk 526
mkvdiskhostmap 534
overview 483
recovervdisk 537
recovervdiskbyiogrp 538
recovervdiskbysystem 539
repairsevdiskcopy 540
repairvdiskcopy 540
rmvdisk 542
rmvdiskcopy 544
rmvdiskhostmap 545
shrinkvdisksize 546
splitvdiskcopy 548
volume copies
validating 50
Index 677
678 SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide
Printed in USA
GC27-2287-05