IBM Spectrum Virtualize for SAN Volume Controller andStorwize Family

Command-Line Interface User's Guide

GC27-2287-14

IBM

**** MISSING FILE ****This file was generated during the publishing process

This edition applies to IBM Spectrum Virtualize for SAN Volume Controller and Storwize Family Version 7.8.1, andto all subsequent releases and modifications until otherwise indicated in new editions.

This edition replaces GC27-2287-13.

Copyright IBM Corporation 2003, 2017.US Government Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

Tables . . . . . . . . . . . . . . . ix

About this guide . . . . . . . . . . . xiWho should use this guide . . . . . . . . . xiAccessibility . . . . . . . . . . . . . . xiEmphasis . . . . . . . . . . . . . . . xiSAN Volume Controller library and relatedpublications . . . . . . . . . . . . . . xiIBM Publications Center . . . . . . . . . . xiiiSending your comments . . . . . . . . . . xiiiSyntax diagrams . . . . . . . . . . . . xiii

Terminology . . . . . . . . . . . . . xvCLI special characters. . . . . . . . . . xviUsing wildcards in the CLI . . . . . . . . xviData types and value ranges . . . . . . . xviiCLI commands and parameters . . . . . . xxiCLI flags . . . . . . . . . . . . . . xxiiCLI messages . . . . . . . . . . . . xxiiiCLI deprecated and discontinued commands xxiiiUnderstanding capacity indicators . . . . . xxvAttributes of the -filtervalue parameters . . . xxv

Chapter 1. Setting up an SSH client . . . 1Setting up an SSH client on a Windows host. . . . 2

Generating an SSH key pair using PuTTY . . . 2Configuring a PuTTY session for the CLI . . . . 3Connecting to the CLI using PuTTY . . . . . 4Starting a PuTTY session for the CLI . . . . . 6

Preparing the SSH client on an AIX or Linux host . . 6Generating an SSH key pair using OpenSSH. . . 7Connecting to the CLI using OpenSSH . . . . 8

Working with local and remote users . . . . . . 8UNIX commands available in interactive SSHsessions . . . . . . . . . . . . . . . . 9Copying the software update files by using PuTTYpscp or openssh scp . . . . . . . . . . . . 9

Chapter 2. Using the CLI . . . . . . . 11Setting the clustered system time by using the CLI 11Setting cluster date and time . . . . . . . . 12Viewing and updating license settings by using theCLI . . . . . . . . . . . . . . . . . 12Displaying clustered system properties by using theCLI . . . . . . . . . . . . . . . . . 13Maintaining passwords using the CLI . . . . . 14Using the dump commands to work with directories 15Re-adding a repaired node to a clustered system byusing the CLI. . . . . . . . . . . . . . 16Displaying node properties by using the CLI . . . 20Discovering MDisks using the CLI . . . . . . 20Creating storage pools using the CLI . . . . . . 22Adding MDisks to storage pools using the CLI . . 24Setting a quorum disk using the CLI . . . . . . 25

Modifying the amount of available memory forCopy Services, Volume Mirroring, and RAID arraysby using the CLI . . . . . . . . . . . . 26Creating volumes using the CLI . . . . . . . 28Adding a copy to a volume . . . . . . . . . 31Deleting a copy from a volume . . . . . . . . 31Configuring host objects using the CLI . . . . . 31Creating host mappings by using the CLI . . . . 33Creating FlashCopy mappings using the CLI . . . 33

Preparing and starting a FlashCopy mappingusing the CLI. . . . . . . . . . . . . 34Stopping FlashCopy mappings by using the CLI 35Deleting a FlashCopy mapping using the CLI . . 36

Creating a FlashCopy consistency group and addingmappings using the CLI . . . . . . . . . . 36

Preparing and starting a FlashCopy consistencygroup using the CLI . . . . . . . . . . 37Stopping a FlashCopy consistency group usingthe CLI . . . . . . . . . . . . . . . 39Deleting a FlashCopy consistency group usingthe CLI . . . . . . . . . . . . . . . 39

Creating Metro Mirror, Global Mirror, oractive-active relationships using the CLI . . . . . 40

Modifying Metro Mirror, Global Mirror, oractive-active relationships using the CLI . . . . 40Starting and stopping Metro Mirror, GlobalMirror, or active-active relationships using theCLI . . . . . . . . . . . . . . . . 41Displaying the progress of Metro Mirror, GlobalMirror, or active-active relationships using theCLI . . . . . . . . . . . . . . . . 42Switching Metro Mirror or Global Mirrorrelationships using the CLI . . . . . . . . 42Deleting Metro Mirror, Global Mirror, oractive-active relationships using the CLI . . . . 43

Creating Metro Mirror, Global Mirror, oractive-active consistency groups using the CLI. . . 43

Modifying Metro Mirror, Global Mirror, oractive-active consistency groups using the CLI. . 43Starting and stopping Metro Mirror, GlobalMirror, or active-active consistency-group copyprocesses using the CLI . . . . . . . . . 44Deleting Metro Mirror, Global Mirror, oractive-active consistency groups using the CLI. . 44

Creating Metro Mirror and Global Mirrorpartnerships using the CLI . . . . . . . . . 45

Modifying Metro Mirror and Global Mirrorpartnerships using the CLI . . . . . . . . 46Starting and stopping Metro Mirror and GlobalMirror partnerships using the CLI . . . . . . 47Deleting Metro Mirror and Global Mirrorpartnerships using the CLI . . . . . . . . 47

Determining the WWNNs of a node using the CLI 47Listing node-dependent volumes using the CLI . . 48Determining the volume name from the deviceidentifier on the host . . . . . . . . . . . 49

Copyright IBM Corp. 2003, 2017 iii

Determining the host that a volume maps . . . . 50Determining the relationship between volume andMDisks using the CLI . . . . . . . . . . . 50Determining the relationship between MDisks andcontroller LUNs using the CLI . . . . . . . . 50Increasing the size of your system by using the CLI 51

Adding a node to increase the size of the system 51Validating and repairing mirrored volume copies byusing the CLI. . . . . . . . . . . . . . 54Repairing a thin-provisioned volume using the CLI 56Recovering offline volumes using the CLI . . . . 56

Recovering a node and returning it to the systemby using the CLI . . . . . . . . . . . 57Recovering offline volumes using the CLI . . . 58Moving offline volumes to their original I/Ogroup using the CLI . . . . . . . . . . 58

Recording WWPN changes of replaced host HBAs 59Expanding volumes using the CLI . . . . . . . 60

Expanding a volume that is mapped to an AIXhost . . . . . . . . . . . . . . . . 61Expanding a volume that is mapped to aMicrosoft Windows host by using the CLI . . . 61

Shrinking a volume using the CLI . . . . . . . 62Migrating extents using the CLI . . . . . . . 63Migrating volumes between pools using the CLI . . 64Moving a volume between I/O groups using theCLI . . . . . . . . . . . . . . . . . 66Creating an image-mode volume using the CLI . . 67Migrating data to an image mode volume using theCLI . . . . . . . . . . . . . . . . . 68Deleting a node from a system by using the CLI . . 68Completing the system maintenance procedure byusing the CLI. . . . . . . . . . . . . . 70Modifying system IP addresses using the CLI . . . 71Changing the system gateway address by using theCLI . . . . . . . . . . . . . . . . . 72Changing the relationship bandwidth for a systemby using the CLI . . . . . . . . . . . . 72Configuring the system for iSCSI hosts . . . . . 73

Configuring or modifying an iSCSI alias by usingthe CLI . . . . . . . . . . . . . . . 74Configuring the iSNS server address using theCLI . . . . . . . . . . . . . . . . 75Configuring system iSCSI authentication usingthe CLI . . . . . . . . . . . . . . . 75

Configuring remote authentication service using CLI 76Configuring remote authentication service withLightweight Directory Access Protocol (LDAP)using the CLI. . . . . . . . . . . . . 76

Changing user groups . . . . . . . . . . . 77Changing users . . . . . . . . . . . . . 78Setting up SNMP notifications using the CLI . . . 79Setting up syslog notifications using the CLI . . . 80Setting up email event notifications and inventoryreports using the CLI . . . . . . . . . . . 80Setting up email servers using the CLI . . . . . 82Changing user passwords using the CLI. . . . . 82Changing the locale setting using the CLI . . . . 83Viewing the feature log using the CLI . . . . . 83Analyzing the error log using the CLI . . . . . 83Shutting down a system by using the CLI . . . . 84

Updating the software automatically using the CLI 85

Chapter 3. Array commands . . . . . 89charray . . . . . . . . . . . . . . . . 89charraymember . . . . . . . . . . . . . 90lsarray . . . . . . . . . . . . . . . . 93lsarrayinitprogress. . . . . . . . . . . . 100lsarraylba. . . . . . . . . . . . . . . 101lsarraymember . . . . . . . . . . . . . 103lsarraymembergoals . . . . . . . . . . . 106lsarraymemberprogress . . . . . . . . . . 109lsarrayrecommendation . . . . . . . . . . 111lsarraysyncprogress . . . . . . . . . . . 114lspotentialarraysize . . . . . . . . . . . 115mkarray . . . . . . . . . . . . . . . 117mkdistributedarray . . . . . . . . . . . 120recoverarray . . . . . . . . . . . . . . 123recoverarraybycluster (Discontinued) . . . . . 123recoverarraybysystem . . . . . . . . . . 123rmarray . . . . . . . . . . . . . . . 124

Chapter 4. Audit log commands . . . 125catauditlog . . . . . . . . . . . . . . 125dumpauditlog . . . . . . . . . . . . . 126lsauditlogdumps (Deprecated) . . . . . . . . 128

Chapter 5. Backup and restorecommands . . . . . . . . . . . . 129svcconfig . . . . . . . . . . . . . . . 129backup . . . . . . . . . . . . . . . 130clear . . . . . . . . . . . . . . . . 131cron . . . . . . . . . . . . . . . . 132recover . . . . . . . . . . . . . . . 132restore. . . . . . . . . . . . . . . . 133restore. . . . . . . . . . . . . . . . 135

Chapter 6. Cloud account commands 137chcloudaccountawss3. . . . . . . . . . . 137chcloudaccountswift . . . . . . . . . . . 139lscloudaccount . . . . . . . . . . . . . 142lscloudaccountusage . . . . . . . . . . . 144lscloudaccountimportcandidate . . . . . . . 146mkcloudaccountawss3 . . . . . . . . . . 147mkcloudaccountswift . . . . . . . . . . . 148rmcloudaccount . . . . . . . . . . . . 149testcloudaccount . . . . . . . . . . . . 150

Chapter 7. Clustered systemcommands . . . . . . . . . . . . 153addnode (SAN Volume Controller only) . . . . 153addiscsistorageport . . . . . . . . . . . 156cfgportip . . . . . . . . . . . . . . . 157chbanner . . . . . . . . . . . . . . . 163chcluster (Discontinued) . . . . . . . . . . 165chiogrp . . . . . . . . . . . . . . . 165chnode . . . . . . . . . . . . . . . 168chnodebattery . . . . . . . . . . . . . 171chnodebootdrive . . . . . . . . . . . . 171

iv Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

chnodehw (SVC) / chnodecanisterhw (Storwizefamily products) . . . . . . . . . . . . 173chquorum . . . . . . . . . . . . . . 174chsecurity . . . . . . . . . . . . . . 176chsite . . . . . . . . . . . . . . . . 176chsystem . . . . . . . . . . . . . . . 177chsystemcert . . . . . . . . . . . . . 184chsystemip . . . . . . . . . . . . . . 186chthrottle . . . . . . . . . . . . . . . 189cleardumps . . . . . . . . . . . . . . 189cpdumps . . . . . . . . . . . . . . . 191detectiscsistorageportcandidate . . . . . . . 192dumpconfig (Discontinued). . . . . . . . . 194help . . . . . . . . . . . . . . . . 194lsclustercandidate (Discontinued) . . . . . . . 195lscluster (Discontinued) . . . . . . . . . . 195lsclusterip (Discontinued) . . . . . . . . . 195lsclusterstats (Discontinued) . . . . . . . . 195lsdiscoverystatus . . . . . . . . . . . . 195lsfabric . . . . . . . . . . . . . . . 197lsfcportcandidate . . . . . . . . . . . . 200lsiscsistorageport . . . . . . . . . . . . 201lsiscsistorageportcandidate . . . . . . . . . 204lsiogrp . . . . . . . . . . . . . . . 206lshbaportcandidate (Deprecated) . . . . . . . 210lsiogrphost . . . . . . . . . . . . . . 210lsiogrpcandidate . . . . . . . . . . . . 210lsiostatsdumps (Deprecated) . . . . . . . . 211lsiotracedumps (Deprecated) . . . . . . . . 211lsnode (SVC) / lsnodecanister (Storwize familyproducts) . . . . . . . . . . . . . . . 211lsnodebattery . . . . . . . . . . . . . 216lsnodecandidate (SAN Volume Controller). . . . 219lsnodedependentvdisks (Deprecated) . . . . . 220lsnodehw (SVC) / lsnodecanisterhw (Storwizefamily products) . . . . . . . . . . . . 221lsnodestats (SVC) / lsnodecanisterstats (Storwizefamily products) . . . . . . . . . . . . 223lsnodevpd (SVC) / lsnodecanistervpd (Storwizefamily products) . . . . . . . . . . . . 231lsportusb . . . . . . . . . . . . . . . 240lsportip . . . . . . . . . . . . . . . 242lsportfc . . . . . . . . . . . . . . . 250lsportsas . . . . . . . . . . . . . . . 252lsquorum. . . . . . . . . . . . . . . 254lsroute. . . . . . . . . . . . . . . . 256lstimezones . . . . . . . . . . . . . . 257lssasportcandidate . . . . . . . . . . . . 258lssecurity . . . . . . . . . . . . . . . 259lssite . . . . . . . . . . . . . . . . 260lsthrottle . . . . . . . . . . . . . . . 261lssystem . . . . . . . . . . . . . . . 263lssystemcert . . . . . . . . . . . . . . 270lssystemip . . . . . . . . . . . . . . 272lssystemstats . . . . . . . . . . . . . 275lstargetportfc . . . . . . . . . . . . . 279mkquorumapp . . . . . . . . . . . . . 281mkthrottle . . . . . . . . . . . . . . 282ping . . . . . . . . . . . . . . . . 284rmiscsistorageport . . . . . . . . . . . . 285

rmnode (SVC) / rmnodecanister (Storwize familyproducts) . . . . . . . . . . . . . . . 285rmportip . . . . . . . . . . . . . . . 288rmthrottle . . . . . . . . . . . . . . 289setclustertime (Discontinued) . . . . . . . . 289setsystemtime . . . . . . . . . . . . . 289setpwdreset . . . . . . . . . . . . . . 290settimezone . . . . . . . . . . . . . . 290showtimezone . . . . . . . . . . . . . 291startstats . . . . . . . . . . . . . . . 292stopstats (Deprecated) . . . . . . . . . . 293stopcluster (Discontinued) . . . . . . . . . 293stopsystem . . . . . . . . . . . . . . 293

Chapter 8. Clustered systemdiagnostic and service-aid commands 297applysoftware . . . . . . . . . . . . . 297caterrlog (Deprecated) . . . . . . . . . . 300caterrlogbyseqnum (Deprecated) . . . . . . . 300cherrstate (Deprecated) . . . . . . . . . . 300chdnsserver . . . . . . . . . . . . . . 300cheventlog . . . . . . . . . . . . . . 301chsyslogserver . . . . . . . . . . . . . 301clearerrlog . . . . . . . . . . . . . . 302cpfabricdumps (Discontinued) . . . . . . . . 303dumperrlog . . . . . . . . . . . . . . 303finderr . . . . . . . . . . . . . . . 304setevent (Discontinued) . . . . . . . . . . 304lscimomdumps (Deprecated) . . . . . . . . 304lscopystatus . . . . . . . . . . . . . . 304lsdumps . . . . . . . . . . . . . . . 305lsdnsserver . . . . . . . . . . . . . . 307lserrlogbyfcconsistgrp (Deprecated) . . . . . . 308lserrlogbyfcmap (Deprecated) . . . . . . . . 308lserrlogbyhost (Deprecated) . . . . . . . . 308lserrlogbyiogrp (Deprecated) . . . . . . . . 308lserrlogbymdisk (Deprecated) . . . . . . . . 308lserrlogbymdiskgrp (Deprecated) . . . . . . . 308lserrlogbynode (Deprecated) . . . . . . . . 308lserrlogbyrcconsistgrp (Deprecated) . . . . . . 308lserrlogbyrcrelationship (Deprecated) . . . . . 309lserrlogbyvdisk (Deprecated) . . . . . . . . 309lserrlogdumps (Deprecated) . . . . . . . . 309lsfeaturedumps (Deprecated) . . . . . . . . 309lseventlog . . . . . . . . . . . . . . 309lsservicestatus . . . . . . . . . . . . . 315lssyslogserver . . . . . . . . . . . . . 320lssoftwaredumps (Deprecated). . . . . . . . 321lssoftwareupgradestatus (Deprecated) . . . . . 321lsupdate . . . . . . . . . . . . . . . 322mkdnsserver . . . . . . . . . . . . . 325mksyslogserver . . . . . . . . . . . . . 325rmdnsserver . . . . . . . . . . . . . . 327rmsyslogserver . . . . . . . . . . . . . 327setlocale . . . . . . . . . . . . . . . 328svqueryclock . . . . . . . . . . . . . 329writesernum. . . . . . . . . . . . . . 329

Chapter 9. Controller command . . . 331chcontroller . . . . . . . . . . . . . . 331

Contents v

lscontroller . . . . . . . . . . . . . . 332lscontrollerdependentvdisks . . . . . . . . 336

Chapter 10. Drive commands . . . . 339applydrivesoftware . . . . . . . . . . . 339chdrive . . . . . . . . . . . . . . . 342lsdrive. . . . . . . . . . . . . . . . 343lsdriveclass . . . . . . . . . . . . . . 349lsdrivelba. . . . . . . . . . . . . . . 351lsdriveprogress . . . . . . . . . . . . . 352lsdriveupgradeprogress . . . . . . . . . . 354triggerdrivedump . . . . . . . . . . . . 356

Chapter 11. Email and eventnotification commands . . . . . . . 359chemail . . . . . . . . . . . . . . . 359chemailserver . . . . . . . . . . . . . 361chemailuser . . . . . . . . . . . . . . 362chsnmpserver . . . . . . . . . . . . . 363lsemailserver . . . . . . . . . . . . . 364lsemailuser . . . . . . . . . . . . . . 365lssnmpserver . . . . . . . . . . . . . 366mkemailserver . . . . . . . . . . . . . 367mkemailuser . . . . . . . . . . . . . 368mksnmpserver . . . . . . . . . . . . . 370rmemailserver . . . . . . . . . . . . . 371rmemailuser . . . . . . . . . . . . . . 371rmsnmpserver . . . . . . . . . . . . . 372sendinventoryemail . . . . . . . . . . . 372setemail (Discontinued) . . . . . . . . . . 373startemail. . . . . . . . . . . . . . . 373stopemail. . . . . . . . . . . . . . . 374testemail . . . . . . . . . . . . . . . 374

Chapter 12. Enclosure commands . . 377addcontrolenclosure . . . . . . . . . . . 377chenclosure . . . . . . . . . . . . . . 377chenclosurecanister . . . . . . . . . . . 378chenclosuredisplaypanel . . . . . . . . . . 380chenclosurepsu . . . . . . . . . . . . . 380chenclosuresem. . . . . . . . . . . . . 381chenclosureslot . . . . . . . . . . . . . 381(satask) chenclosurevpd (Deprecated) . . . . . 383lsenclosure . . . . . . . . . . . . . . 383lsenclosurebattery . . . . . . . . . . . . 386lscontrolenclosurecandidate (Storwize familyproducts only) . . . . . . . . . . . . . 389lsenclosurecanister. . . . . . . . . . . . 390lsenclosurechassis (Flex V7000 Storage Node). . . 393lsenclosuredisplaypanel . . . . . . . . . . 394lsenclosurefanmodule . . . . . . . . . . 396lsenclosurepsu . . . . . . . . . . . . . 398lsenclosuresem . . . . . . . . . . . . . 400lsenclosureslot . . . . . . . . . . . . . 402lsenclosurestats . . . . . . . . . . . . . 405lssasfabric . . . . . . . . . . . . . . 409resetleds . . . . . . . . . . . . . . . 411triggerenclosuredump . . . . . . . . . . 412

Chapter 13. Encryption commands 413chencryption . . . . . . . . . . . . . 413lsencryption . . . . . . . . . . . . . . 415

Chapter 14. Licensing andfeaturization commands. . . . . . . 419activatefeature . . . . . . . . . . . . . 419chlicense . . . . . . . . . . . . . . . 420deactivatefeature . . . . . . . . . . . . 422lsfeature . . . . . . . . . . . . . . . 423lslicense . . . . . . . . . . . . . . . 425

Chapter 15. FlashCopy commands 429chfcconsistgrp . . . . . . . . . . . . . 429chfcmap . . . . . . . . . . . . . . . 429lsfcconsistgrp . . . . . . . . . . . . . 431lsfcmap . . . . . . . . . . . . . . . 434lsfcmapcandidate . . . . . . . . . . . . 438lsfcmapprogress . . . . . . . . . . . . 438lsfcmapdependentmaps . . . . . . . . . . 439lsrmvdiskdependentmaps . . . . . . . . . 440mkfcconsistgrp . . . . . . . . . . . . . 441mkfcmap . . . . . . . . . . . . . . . 442prestartfcconsistgrp . . . . . . . . . . . 444prestartfcmap . . . . . . . . . . . . . 446rmfcconsistgrp . . . . . . . . . . . . . 447rmfcmap . . . . . . . . . . . . . . . 448startfcconsistgrp . . . . . . . . . . . . 448startfcmap . . . . . . . . . . . . . . 450stopfcconsistgrp . . . . . . . . . . . . 451stopfcmap . . . . . . . . . . . . . . 453

Chapter 16. Host commands . . . . . 455addhostclustermember . . . . . . . . . . 455addhostiogrp . . . . . . . . . . . . . 456addhostport . . . . . . . . . . . . . . 456chhost . . . . . . . . . . . . . . . . 458chhostcluster . . . . . . . . . . . . . 459lshost . . . . . . . . . . . . . . . . 461lshostcluster . . . . . . . . . . . . . . 465lshostclustermember . . . . . . . . . . . 467lshostclustervolumemap . . . . . . . . . . 468lshostiogrp . . . . . . . . . . . . . . 470lsiscsiauth . . . . . . . . . . . . . . 471mkhost . . . . . . . . . . . . . . . 472mkhostcluster . . . . . . . . . . . . . 474mkvolumehostclustermap . . . . . . . . . 475rmhost . . . . . . . . . . . . . . . 476rmhostcluster . . . . . . . . . . . . . 477rmhostclustermember . . . . . . . . . . 478rmvolumehostclustermap . . . . . . . . . 479rmhostiogrp . . . . . . . . . . . . . . 480rmhostport . . . . . . . . . . . . . . 481

Chapter 17. Information commands 483ls2145dumps (Deprecated) . . . . . . . . . 483lsconfigdumps (Discontinued) . . . . . . . . 483lssshkeys (Discontinued) . . . . . . . . . 483

vi Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

Chapter 18. Key server commands 485chkeyserver . . . . . . . . . . . . . . 485chkeyserverisklm . . . . . . . . . . . . 486lskeyserver . . . . . . . . . . . . . . 487lskeyserverisklm . . . . . . . . . . . . 488mkkeyserver . . . . . . . . . . . . . 490rmkeyserver . . . . . . . . . . . . . . 491testkeyserver . . . . . . . . . . . . . 492

Chapter 19. Livedump commands . . 493cancellivedump. . . . . . . . . . . . . 493lslivedump . . . . . . . . . . . . . . 493preplivedump . . . . . . . . . . . . . 494triggerlivedump . . . . . . . . . . . . 494

Chapter 20. Managed disk commands 497addmdisk . . . . . . . . . . . . . . 497applymdisksoftware (Discontinued) . . . . . . 498chmdisk . . . . . . . . . . . . . . . 498detectmdisk . . . . . . . . . . . . . . 500dumpallmdiskbadblocks. . . . . . . . . . 501dumpmdiskbadblocks . . . . . . . . . . 502includemdisk . . . . . . . . . . . . . 503lsmdisk . . . . . . . . . . . . . . . 504lsmdiskdumps (Deprecated) . . . . . . . . 510lsmdisklba . . . . . . . . . . . . . . 510lsmdiskcandidate . . . . . . . . . . . . 511lsmdiskextent . . . . . . . . . . . . . 512lsmdiskmember . . . . . . . . . . . . 514setquorum (Deprecated) . . . . . . . . . . 515triggermdiskdump (Discontinued) . . . . . . 516

Chapter 21. Storage pool commands 517chmdiskgrp . . . . . . . . . . . . . . 517lsfreeextents . . . . . . . . . . . . . . 519lsmdiskgrp . . . . . . . . . . . . . . 519mkmdiskgrp . . . . . . . . . . . . . 527rmmdisk . . . . . . . . . . . . . . . 531rmmdiskgrp . . . . . . . . . . . . . . 532

Chapter 22. Copy services commands 535chpartnership . . . . . . . . . . . . . 535chrcconsistgrp . . . . . . . . . . . . . 538chrcrelationship . . . . . . . . . . . . 540lspartnership . . . . . . . . . . . . . 544lspartnershipcandidate . . . . . . . . . . 548lsrcconsistgrp . . . . . . . . . . . . . 549lsrcrelationship . . . . . . . . . . . . . 552lsrcrelationshipcandidate . . . . . . . . . 556lsrcrelationshipprogress . . . . . . . . . . 557mkfcpartnership . . . . . . . . . . . . 558mkippartnership . . . . . . . . . . . . 559mkpartnership (Discontinued) . . . . . . . . 561mkrcconsistgrp . . . . . . . . . . . . . 561mkrcrelationship . . . . . . . . . . . . 562rmpartnership . . . . . . . . . . . . . 566rmrcconsistgrp . . . . . . . . . . . . . 566rmrcrelationship . . . . . . . . . . . . 567startrcconsistgrp . . . . . . . . . . . . 568startrcrelationship . . . . . . . . . . . . 571

stoprcconsistgrp . . . . . . . . . . . . 573stoprcrelationship . . . . . . . . . . . . 576switchrcconsistgrp. . . . . . . . . . . . 578switchrcrelationship . . . . . . . . . . . 579

Chapter 23. Migration commands . . . 581lsmigrate . . . . . . . . . . . . . . . 581migrateexts . . . . . . . . . . . . . . 582migratetoimage. . . . . . . . . . . . . 583migratevdisk . . . . . . . . . . . . . 585

Chapter 24. Service informationcommands . . . . . . . . . . . . 587host . . . . . . . . . . . . . . . . 587sainfo lsbootdrive . . . . . . . . . . . . 587sainfolscmdstatus . . . . . . . . . . . . 589lsfiles . . . . . . . . . . . . . . . . 590lshardware . . . . . . . . . . . . . . 591lsservicenodes . . . . . . . . . . . . . 593lsservicerecommendation . . . . . . . . . 594lsservicestatus . . . . . . . . . . . . . 595traceroute . . . . . . . . . . . . . . 600

Chapter 25. Service mode commands(Discontinued) . . . . . . . . . . . 601applysoftware (Discontinued) . . . . . . . . 601svcservicemodetask cleardumps (Discontinued) . . 601svcservicemodetask dumperrlog (Discontinued) 601exit (Discontinued) . . . . . . . . . . . 601

Chapter 26. Service mode informationcommands (Discontinued) . . . . . . 603ls2145dumps (Discontinued) . . . . . . . . 603lscimomdumps (Discontinued) . . . . . . . 603lsclustervpd (Discontinued). . . . . . . . . 603lserrlogdumps (Discontinued) . . . . . . . . 603lsfeaturedumps (Discontinued) . . . . . . . 603lsiostatsdumps (Discontinued) . . . . . . . . 603lsiotracedumps (Discontinued) . . . . . . . 603lsmdiskdumps (Discontinued) . . . . . . . . 603lssoftwaredumps (Discontinued) . . . . . . . 603

Chapter 27. Service task commands 605satask chbootdrive. . . . . . . . . . . . 605chnodeled . . . . . . . . . . . . . . 605chserviceip . . . . . . . . . . . . . . 607satask chvpd . . . . . . . . . . . . . 609chwwnn . . . . . . . . . . . . . . . 611cpfiles . . . . . . . . . . . . . . . . 612dumpinternallog (Discontinued) . . . . . . . 613installsoftware . . . . . . . . . . . . . 613leavecluster . . . . . . . . . . . . . . 614metadata . . . . . . . . . . . . . . . 615(satask) mkcluster . . . . . . . . . . . . 616mkcluster (Deprecated) . . . . . . . . . . 617satask overridequorum . . . . . . . . . . 617rescuenode . . . . . . . . . . . . . . 618resetpassword . . . . . . . . . . . . . 618restartservice . . . . . . . . . . . . . 619

Contents vii

(satask) setlocale . . . . . . . . . . . . 620setpacedccu . . . . . . . . . . . . . . 621settempsshkey . . . . . . . . . . . . . 621snap . . . . . . . . . . . . . . . . 622startservice . . . . . . . . . . . . . . 623stopnode . . . . . . . . . . . . . . . 623stopservice . . . . . . . . . . . . . . 624t3recovery . . . . . . . . . . . . . . 625

Chapter 28. User managementcommands . . . . . . . . . . . . 627chauthservice . . . . . . . . . . . . . 627chcurrentuser . . . . . . . . . . . . . 629chldap. . . . . . . . . . . . . . . . 630chldapserver . . . . . . . . . . . . . 633chuser . . . . . . . . . . . . . . . . 634chusergrp . . . . . . . . . . . . . . 636lscurrentuser . . . . . . . . . . . . . 636lsldap . . . . . . . . . . . . . . . . 637lsldapserver . . . . . . . . . . . . . . 638lsuser . . . . . . . . . . . . . . . . 640lsusergrp . . . . . . . . . . . . . . . 641mkldapserver . . . . . . . . . . . . . 643mkuser . . . . . . . . . . . . . . . 644mkusergrp . . . . . . . . . . . . . . 645rmldapserver . . . . . . . . . . . . . 648rmuser . . . . . . . . . . . . . . . 648rmusergrp . . . . . . . . . . . . . . 649testldapserver . . . . . . . . . . . . . 649

Chapter 29. Volume commands. . . . 653addvolumecopy . . . . . . . . . . . . 653addvdiskcopy . . . . . . . . . . . . . 655addvdiskaccess . . . . . . . . . . . . . 661analyzevdisk . . . . . . . . . . . . . 662analyzevdiskbysystem . . . . . . . . . . 663backupvolume . . . . . . . . . . . . . 664backupvolumegroup . . . . . . . . . . . 665chvdisk . . . . . . . . . . . . . . . 666chvolumegroup. . . . . . . . . . . . . 670expandvdisksize . . . . . . . . . . . . 671lsdependentvdisks. . . . . . . . . . . . 674lshostvdiskmap. . . . . . . . . . . . . 675lsmetadatavdisk . . . . . . . . . . . . 677lsrepairsevdiskcopyprogress . . . . . . . . 678lsrepairvdiskcopyprogress . . . . . . . . . 679lssevdiskcopy . . . . . . . . . . . . . 681lsvdisk . . . . . . . . . . . . . . . 687lsvdiskaccess . . . . . . . . . . . . . 701lsvdiskanalysis . . . . . . . . . . . . . 703lsvdiskanalysisprogress . . . . . . . . . . 706lsvdiskcopy . . . . . . . . . . . . . . 707

lsvdiskdependentmaps . . . . . . . . . . 713lsvdiskextent . . . . . . . . . . . . . 713lsvdiskfcmapcopies . . . . . . . . . . . 715lsvdiskfcmappings. . . . . . . . . . . . 716lsvdiskhostmap. . . . . . . . . . . . . 717lsvdisklba . . . . . . . . . . . . . . 718lsvdiskmember . . . . . . . . . . . . . 719lsvdiskprogress . . . . . . . . . . . . . 721lsvdisksyncprogress . . . . . . . . . . . 722lsvolumebackup . . . . . . . . . . . . 723lsvolumebackupgeneration . . . . . . . . . 725lsvolumebackupprogress . . . . . . . . . 727lsvolumegroup . . . . . . . . . . . . . 729lsvolumerestoreprogress . . . . . . . . . . 731mkmetadatavdisk . . . . . . . . . . . . 733mkvdisk . . . . . . . . . . . . . . . 734mkvdiskhostmap . . . . . . . . . . . . 743mkvolume . . . . . . . . . . . . . . 745mkvolumegroup . . . . . . . . . . . . 748mkimagevolume . . . . . . . . . . . . 749movevdisk . . . . . . . . . . . . . . 751recovervdisk. . . . . . . . . . . . . . 753recovervdiskbycluster (Discontinued) . . . . . 754recovervdiskbyiogrp . . . . . . . . . . . 754recovervdiskbysystem . . . . . . . . . . 754repairsevdiskcopy . . . . . . . . . . . . 755repairvdiskcopy . . . . . . . . . . . . 756restorevolume . . . . . . . . . . . . . 757rmvdisk . . . . . . . . . . . . . . . 758rmmetadatavdisk . . . . . . . . . . . . 761rmvdiskcopy . . . . . . . . . . . . . 762rmvdiskaccess . . . . . . . . . . . . . 763rmvdiskhostmap . . . . . . . . . . . . 763rmvolumegroup . . . . . . . . . . . . 764rmvolumebackupgeneration . . . . . . . . 765shrinkvdisksize . . . . . . . . . . . . . 766rmvolume . . . . . . . . . . . . . . 768rmvolumecopy . . . . . . . . . . . . . 770splitvdiskcopy . . . . . . . . . . . . . 771

Chapter 30. Command-line interfacemessages . . . . . . . . . . . . . 775

Appendix. Accessibility features forSAN Volume Controller . . . . . . . 945

Notices . . . . . . . . . . . . . . 947Trademarks . . . . . . . . . . . . . . 949

Index . . . . . . . . . . . . . . . 951

viii Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

Tables

1. IBM websites for help, services, andinformation . . . . . . . . . . . . xii

2. SAN Volume Controller library . . . . . . xii3. IBM documentation and related websites xiii4. Syntax diagrams . . . . . . . . . . xiv5. Abbreviations . . . . . . . . . . . . xv6. Data types . . . . . . . . . . . . xvii7. Capacity indicators . . . . . . . . . xxv8. UNIX commands for interactive SSH sessions 99. Maximum volume capacity by extent size 23

10. Examples of memory required . . . . . . 2611. RAID level comparisons . . . . . . . . 2712. Volume copy resynchronization rates . . . . 3013. charraymember combination options . . . . 9214. Array output . . . . . . . . . . . . 9515. lsarrayinitprogress output . . . . . . . 10116. lsarraylba output . . . . . . . . . . 10217. lsarraymember output . . . . . . . . 10418. lsarraymembergoals output . . . . . . . 10719. lsarraymemberprogress output . . . . . . 11020. lsarrayrecommendation output. . . . . . 11221. lsarraysyncprogress output . . . . . . . 11522. lspotentialarraysize output . . . . . . . 11723. lscloudaccount output . . . . . . . . 14224. lscloudaccountusage output. . . . . . . 14525. lscloudaccountimportcandidate output 14626. Memory required for RAID arrays, Copy

Services, and volume mirroring . . . . . 16727. RAID level comparisons . . . . . . . . 16728. Number of extents reserved by extent size 17529. IP address list formats . . . . . . . . 18830. lsfcportcandidate output . . . . . . . . 20131. lsiscsistorageport output . . . . . . . . 20232. lsiscsistorageportcandidate output . . . . 20533. lsnode or lsnodecanister attribute values 21334. lsnodebattery attribute values . . . . . . 21735. lsnodecandidate outputs . . . . . . . . 22036. Attribute values for lsnodehw and

lsnodecanisterhw . . . . . . . . . . 22137. Attribute values for lsnodestats or

lsnodecanister . . . . . . . . . . . 22438. Stat_name field values . . . . . . . . 22639. Attribute values for lsnodevpd and

lsnodecanistervpd . . . . . . . . . . 23240. lsportusb output . . . . . . . . . . 24041. lsportip output . . . . . . . . . . . 24442. lsportfc output . . . . . . . . . . . 25143. lsportsas output. . . . . . . . . . . 25344. lsquorum output . . . . . . . . . . 25545. lssasportcandidate output . . . . . . . 25946. lssecurity attribute values . . . . . . . 26047. lssite attribute values . . . . . . . . . 26148. lsthrottle output. . . . . . . . . . . 26249. lssystem output . . . . . . . . . . . 26350. lssystemcert output . . . . . . . . . 27151. lssystemip output . . . . . . . . . . 274

52. lssystemstats attribute values . . . . . . 27653. Stat_name field values . . . . . . . . 27754. lstargetportfc output . . . . . . . . . 28055. lsdnsserver output . . . . . . . . . . 30756. lseventlog output . . . . . . . . . . 31157. lsservicestatus output . . . . . . . . . 31558. lssyslogserver output . . . . . . . . . 32159. lscontroller output . . . . . . . . . . 33460. lsdrive output . . . . . . . . . . . 34561. lsdriveclass output . . . . . . . . . . 35062. lsdrivelba output . . . . . . . . . . 35263. lsenclosure output . . . . . . . . . . 38464. lsenclosurebattery outputs . . . . . . . 38765. lscontrolenclosurecandidate attribute values 38966. lsenclosurecanister output . . . . . . . 39167. lsenclosurechassis outputs . . . . . . . 39468. ? output . . . . . . . . . . . . . 39569. lsenclosurefanmodule attribute values 39770. lsenclosurepsu output. . . . . . . . . 39971. lsenclosuresem output . . . . . . . . 40172. lsenclosureslot output . . . . . . . . . 40373. lsenclosurestats outputs . . . . . . . . 40774. Stat_name field values . . . . . . . . 40975. lssasfabric output . . . . . . . . . . 41076. lsencryption output . . . . . . . . . 41677. lsfeature outputs . . . . . . . . . . 42478. lslicense output . . . . . . . . . . . 42679. Relationship between the cleaning rate, data

rate, and grains per second values . . . . 43180. Relationship between the cleaning rate, data

rate, and grains per second values . . . . 44481. lshost output. . . . . . . . . . . . 46482. lshostcluster output . . . . . . . . . 46683. lshostclustermember output. . . . . . . 46784. lshostclustervolumemap output . . . . . 46985. lskeyserver output . . . . . . . . . . 48786. lskeyserverisklm output . . . . . . . . 48987. lslivedump outputs . . . . . . . . . 49488. MDisk output . . . . . . . . . . . 50689. lsmdisklba command output . . . . . . 51190. Parameter differences for child pools and

parent pools . . . . . . . . . . . . 51891. Parameter differences for child pools and

storage pools. . . . . . . . . . . . 52992. lspartnership attribute values . . . . . . 54593. lsrcconsistgrp command output values 55094. lsrcrelationship command attributes and

values . . . . . . . . . . . . . . 55495. stoprcconsistgrp consistency group states 57596. stoprcrelationship consistency group states 57797. lsbootdrive attribute values . . . . . . . 58898. lshardware attribute values . . . . . . . 59299. lsservicenodes outputs . . . . . . . . 593

100. lsservicestatus output . . . . . . . . . 595101. lsldap attribute values . . . . . . . . 638102. lsldapserver attribute values . . . . . . 639

Copyright IBM Corp. 2003, 2017 ix

103. testldapserver attribute values . . . . . . 650104. Storage pool Easy Tier settings . . . . . . 658105. Relationship between the syncrate value and

the data copied per second . . . . . . . 660106. Relationship between the syncrate value and

the data copied per second . . . . . . . 669107. lsmetadatavdisk output . . . . . . . . 678108. Easy Tier status values . . . . . . . . 693109. lsvdiskanalysis output . . . . . . . . 704110. lsvdiskanalysisprogress output . . . . . . 706

111. lsvdisklba command output scenarios 719112. lsvolumebackup output . . . . . . . . 725113. lsvolumebackupgeneration output . . . . 727114. lsvolumebackupprogress output . . . . . 728115. lsvolumegroup output . . . . . . . . 730116. lsvolumerestoreprogress output . . . . . 732117. Relationship between the syncrate value and

the data copied per second . . . . . . . 741118. Accepted IP address formats . . . . . . 913

x Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

About this guide

This publication provides information that helps you configure and use the IBM Spectrum Virtualize forSAN Volume Controller and Storwize Family.

Who should use this guideThis guide is intended for system administrators or others who install and use the SAN VolumeController or Storwize V7000.

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.

AccessibilityIBM strives to provide products with usable access for everyone, regardless of age or ability.

This product uses standard Windows navigation keys.

For more information, see the accessibility features topic in the Reference section.

EmphasisDifferent typefaces are used in this guide to show emphasis.

The following typefaces are used to show emphasis:

Boldface Text in boldface represents menu items.

Bold monospace Text in bold monospace represents command names.

Italics Text in italics is used to emphasize a word. In commandsyntax, it is used for variables for which you supplyactual values, such as a default directory or the name ofa system.

Monospace Text in monospace identifies the data or commands thatyou type, samples of command output, examples ofprogram code or messages from the system, or names ofcommand flags, parameters, arguments, and name-valuepairs.

SAN Volume Controller library and related publicationsProduct manuals, other publications, and websites contain information that relates to SAN VolumeController.

IBM Knowledge Center for SAN Volume Controller

The information collection in the IBM Knowledge Center contains all of the information that is requiredto install, configure, and manage the system. The information collection in the IBM Knowledge Center isupdated between product releases to provide the most current documentation. The information collectionis available at the following website:

Copyright IBM Corp. 2003, 2017 xi

http://www.ibm.com/support/knowledgecenter/STPVGU

SAN Volume Controller library

Unless otherwise noted, the publications in the library are available in Adobe portable document format(PDF) from a website.

ibm.com/shop/publications/order

Click Search for publications to find the online publications you are interested in, and then view ordownload the publication by clicking the appropriate item.

Table 1 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

Support for SAN Volume Controller (2145) www.ibm.com/support

Support for IBM System Storage and IBM TotalStorage products www.ibm.com/support/

Each PDF publication in the Table 2 library is also available in the IBM Knowledge Center by clicking thenumber in the Order number column:

Table 2. SAN Volume Controller library

Title Description Order number

IBM SAN Volume Controller Model2145-SV1 Hardware Installation Guide

The guide provides the instructionsthat the IBM service representativeuses to install the hardware for SANVolume Controller model 2145-SV1.

GI13-4547

IBM SAN Volume Controller HardwareMaintenance Guide

The guide provides the instructionsthat the IBM service representativeuses to service the SAN VolumeController hardware, including theremoval and replacement of parts.

GC27-2283

IBM SAN Volume ControllerTroubleshooting Guide

The guide describes the features ofeach SAN Volume Controller model,explains how to use the front panelor service assistant GUI, andprovides maintenance analysisprocedures to help you diagnose andsolve problems with the SAN VolumeController.

GC27-2284

IBM Spectrum Virtualize for SANVolume Controller and Storwize FamilyCommand-Line Interface User's Guide

The guide describes the commandsthat you can use from the SANVolume Controller command-lineinterface (CLI).

GC27-2287

IBM documentation and related websites

Table 3 on page xiii lists websites that provide publications and other information about the SAN VolumeController or related products or technologies. The IBM Redbooks publications provide positioning andvalue guidance, installation and implementation experiences, solution scenarios, and step-by-stepprocedures for various products.

xii Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

http://www.ibm.com/support/knowledgecenter/STPVGUhttp://ibm.com/shop/publications/orderhttp://www.ibm.com/planetwidehttp://www.ibm.com/supporthttp://www.ibm.com/support/

Table 3. IBM documentation and related websites

Website Address

IBM Publications Center ibm.com/shop/publications/order

IBM Redbooks publications www.redbooks.ibm.com/

Related accessibility information

To view a PDF file, you need Adobe Reader, which can be downloaded from the Adobe website:

www.adobe.com/support/downloads/main.html

IBM Publications CenterThe IBM Publications Center is a worldwide central repository for IBM product publications andmarketing material.

The IBM Publications Center website offers customized search functions to help you find the publicationsthat you need. You can view or download publications at no charge. Access the IBM Publications Centerthrough the following website:

ibm.com/shop/publications/order

Sending your commentsYour feedback is important in helping to provide the most accurate and highest quality information.

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 thetopic and use the feedback link in the running footer of that page to identify the topic for which youhave a comment.

v Send your comments by email to starpubs@us.ibm.com. Include the following information for thispublication or use suitable replacements for the publication title and form number for the publicationon which you are commenting: Publication title: IBM Spectrum Virtualize for SAN Volume Controller and Storwize Family 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 diagramsA syntax diagram uses symbols to represent the elements of a command and to specify the rules forusing these elements.

Table 4 on page xiv 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.

About this guide xiii

http://ibm.com/shop/publications/orderhttp://www.redbooks.ibm.com/http://www.adobe.com/support/downloads/main.htmlhttp://ibm.com/shop/publications/orderhttp://publib.boulder.ibm.com/infocenter/svc/ic/index.jsp?topic=/com.ibm.storage.svc.console.doc/feedback.htmhttp://publib.boulder.ibm.com/infocenter/svc/ic/index.jsp?topic=/com.ibm.storage.svc.console.doc/feedback.htmmailto:starpubs@us.ibm.com?subject=SAN%20Volume%20Controller%20and%20Storwize%20V7000%20Command-Line%20Interface%20User's%20Guide%20(GC27-2287-02)

Table 4. Syntax diagrams

Element Syntax Description

Main path line >>>() () () >>Begins on the left with doublearrowheads >< and ends on theright with two arrowheads facingeach other. If a diagram is longerthan one line, each line to becontinued ends with a single>arrowhead and the next line beginswith a single arrowhead. Read thediagrams from lefttoright,toptobottom, following the mainpath line.

Keyword esscli

Represents the name of a command,flag, parameter, or argument. Akeyword is not in italics. Spell akeyword exactly as it is shown inthe syntax diagram.

Required keywords a AccessFile

u Useridp Password

Indicate the parameters orarguments that you must specify forthe command. Required keywordsappear on the main path line.Required keywords that cannot beused together are stacked vertically.

Optional keywords

h-help?

Indicate the parameters orarguments that you can choose tospecify for the command. Optionalkeywords appear below the mainpath line. Mutually exclusiveoptional keywords are stackedvertically.

Default value

FCP

protocol = FICON

Appears above the main path line.

Repeatable keywordor value newports = ALL

PortId1,PortId2,...

Represents a parameter or argumentthat you can specify more than once.A repeatable keyword or value isrepresented by an arrow returning tothe left above the keyword or value.

Variable AccessFile

Represents the value that you needto supply for a parameter orargument, such as a file name, username, or password. Variables are initalics.

Space separator u Userid p Password

Adds a blank space on the mainpath line to separate keywords,parameters, arguments, or variablesfrom each other.

xiv Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

Table 4. Syntax diagrams (continued)

Element Syntax Description

Quotation markdelimiters d " ess = EssId host =

'Host Name' profile = ProfileName

"

Indicates the start and end of aparameter or argument that containsmultiple values. Enclose one or morenamevalue pairs in a set of doublequotation marks for a particularparameter or argument. If the valueof a parameter or namevalue paircontains a blank or white space,enclose the entire value in a set ofsingle quotation marks.

Equalsign operator " ess = EssId profile =

ProfileName "

Separates a name from its value in anamevalue pair.

Syntax fragment Fragment Name

Fragment name:

( fragment details )

Breaks up syntax diagrams that aretoo long, too complex, or repetitious.The fragment name is inserted in themain diagram, and the actualfragment is shown below the maindiagram.

TerminologyThese are abbreviations that are most commonly used for the command-line interface (CLI) operations.

Table 5 shows the abbreviations and offers a brief description.

Table 5. Abbreviations

Name Object type

Host Refers to a single host

Host cluster Refers to a host cluster (which is part of a servers thatshare a set of volumes)

Host object Refers to a list of worldwide port names WWPNs andiSCSI names

Volume copy Referred to as vdiskcopy

Thin-provisioned volume copy Referred to as sevdiskcopy

Managed disk Referred to as MDisk

MDisk group or storage pool Referred to as storage pool

I/O group Referred to as iogrp

Node, node canister, enclosure Refers to node or node canister or enclosure, dependingon the system

Clustered system (system) or cluster Referred to as system

VDisk or volume Referred to as volume

Controller Refers to a controller that is part of a clustered system

IBM FlashCopy mapping Referred to as fcmap

IBM FlashCopy consistency group Referred to as fcconsistgrp

Metro Mirror or Global Mirror relationship Referred to as rcrelationship

About this guide xv

Table 5. Abbreviations (continued)

Name Object type

Metro Mirror or Global Mirror consistency group Referred to as rcconsistgrp

HyperSwap mirroring consistency group Referred to as hyperswap

Unsupported/unknown object unknown

CLI special charactersThe following special characters are used in the command-line interface (CLI) command examples.

minus (-) signFlags are prefixed with a - (minus) sign. Flags define the action of a command or modify theoperation of a command. You can use multiple flags, followed by parameters, when you issue acommand. The - character cannot be used as the first character of an object name.

vertical bar (|)A vertical bar signifies that you choose only one value. For example, [ a | b ] in bracketsindicates that you can choose a, b, or nothing. Similarly, { a | b } in braces indicates that youmust choose either a or b.

delimiters (: or , or !)Delimiters are used to delimit items listed after issuing an information command.v Colon (:) is used to delimit items in a list in a command (for example mkhost -name myhost

-hbawwpn AA22000011112222:AA22000011112223).v Comma (,) is used to delimit items in a list in a command if item values can contain a colon.v Exclamation mark (!) is used to delimit items in a command if the item values can contain a

colon or comma. Exclamation points generally do not show up in example output and are agood delimiter to use.

Using wildcards in the CLIYou can use wildcards in the SAN Volume Controller command-line interface (CLI).

The CLI supports the use of the asterisk character (*) as a wildcard within the arguments of certainparameters. There are some behavioral issues that must be considered when using wildcards in order toprevent unexpected results. These behavioral issues and the ways to avoid them are as follows:1. Running the command while logged onto the node.

The shell will attempt to interpret any of the special characters if they are not escaped (preceded witha backslash character). Wildcards will be expanded into a list of files if any files exist that match thewildcards. If no matching files exist, the wildcard is passed to the SAN Volume Controller commanduntouched.To prevent expansion, issue the following command in one of its formats:

cleardumps -prefix '/dumps/*.txt' with single quotation marks(), or

cleardumps -prefix /dumps/\*.txt using a backslash (\), or

cleardumps -prefix "/dumps/*.txt" with double quotation marks("").

2. Running the command through Secure Shell (SSH), for example from a host.This method is slightly more complicated because the host shell processes the command line before itis passed through SSH to the shell on the clustered system (system). This means an extra layer of

xvi Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

protection is required around the wildcard as the host shell will strip off any protecting quotes, and ifthe wildcard is exposed to the system shell, this will result in the wildcard being expanded in thesystem shell.To prevent expansion, issue the following command in one of its formats:

cleardumps "'/dumps/*.txt'" with single quotation marks ()inside of double quotation marks (""), or

cleardumps '/dumps/\*.txt' using a backslash (\) inside ofsingle quotation marks (), or

cleardumps '"/dumps/*.txt"' with double quotation marks ("")inside of single quotation marks ().

Data types and value rangesThe maximum length of any single parameter entered into the command line is 2176 bytes.

Note: When creating a new object, the clustered system (system) assigns a default -type name if one isnot specified. The default -type name consists of the object prefix and the lowest available integerstarting from 0 (except for nodes starting from 1); for example, vdisk23; the default -type name must beunique.

Table 6 lists the data types and the value ranges for each.

Table 6. Data types

Data types Value ranges

filename_arg This is a (optionally fully qualified) file name, containing a maximum of 169characters. Valid characters are:

v . (period; the field must not start with, end with, or contain two consecutiveperiods)

v / (forward slash)v - (hyphen)v _ (underscore)v az (lowercase letters, A through Z)v AZ (uppercase letters, A through Z)v 09 (numerals 0 through 9)

About this guide xvii

Table 6. Data types (continued)

Data types Value ranges

directory_or_file_filter Specifies a directory, file name filter, or both, within the specified directory. Validdirectory values are:

v /dumpsv /dumps/auditv /dumps/configsv /dumps/elogsv /dumps/featurev /dumps/iostatsv /dumps/iotracev /dumps/software

The file name filter can be any valid file name, containing a maximum of 128characters, with or without the * (wildcard), and appended to the end of adirectory 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 azv AZv 09

filename_prefix The prefix of a file name, containing a maximum of 128 characters. Valid charactersare:

v -v _v azv AZv 09

name_arg Names can be specified or changed using the create and modify functions. The viewcommands provide both the name and ID of an object.Note: The system name is set when the system is created.

The first character of a name_arg must be nonnumeric. The first character of an objectname cannot be a (dash) because the CLI (command-line interface) interprets it asbeing the next parameter.

Valid characters are:

v . (a period - the field must not start with, end with, or contain two consecutiveperiods)

v /v -v _v spacev a through zv A through Zv 0 through 9

xviii Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

Table 6. Data types (continued)

Data types Value ranges

password This is a user-defined password containing a maximum of 15 characters. Validcharacters are:

v - (cannot be used as the first character)v _v azv AZv 09

serial_number The format of this number conforms to IBM standard C-S 1-1121-018 1999-06 SerialNumbering for IBM products. The serial number is 7 digits, the first two of whichdefine the manufacturing location, leaving 5 digits for the product.

The standard defines a way to extend the serial number using letters in the place ofnumbers 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) addressformats are supported:

IPv4 (no port set, SAN Volume Controller uses default)1.2.3.4

IPv4 with specific port1.2.3.4:22

Full IPv6, default port1234:1234:0001:0123:1234:1234:1234:1234

Full IPv6, default port, leading zeros suppressed1234:1234:1:123:1234:1234:1234:1234

Full IPv6 with port[2002:914:fc12:848:209:6bff:fe8c:4ff6]:23

Zero-compressed IPv6, default port2002::4ff6

Zero-compressed IPv6 with port[2002::4ff6]:23

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 systemname, and is modifiable.

A combination of the host name and the dns_name is used to access the system, forexample: 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 validfor 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 isused to create a system, or when a node is added to a system. A node_id value isnever reused in a system.

Node IDs are internally represented as 64-bit numbers, and like other IDs, cannot bemodified by user commands.

About this guide xix

Table 6. Data types (continued)

Data types Value ranges

xxx_id All objects are referred to by unique integer IDs, assigned by the system when theobjects are created. All IDs are represented internally as 32-bit integers; node IDs arean exception.

IDs in the following ranges identify the various types of objects:

v node_id: A positive decimal integer greater than or equal to 1v mdisk_grp_id: 0127v io_grp_id: 03 (See Note.)v mdisk_id: 04095v vdisk_id: 08191v copy_id: 01v host_id: 01023v flash_const_grp_id: 0255v remote_const_grp_id: 0255v fcmap_id: 04095v rcrel_id: 08191v controller_id: 063

Note: The io_group 4 exists but is used only in certain error recovery procedures.

These IDs, like node IDs, cannot be modified by user commands.Note: IDs are assigned at run time by the system and cannot be relied upon to bethe same after; for example, the configuration restoration. Use object names inpreference to IDs when working with objects.

xxx_list A colon-delimited list of values of type xxx.

wwpn_arg The Fibre Channel worldwide port name (WWPN), expressed as a 64-bithexadecimal number and consisting of the characters 09, af, and AF; for example:1A2B30C67AFFE47B.Note: Entering WWPN 0 in the command string causes a command failure.

panel_name This is a string of up to six characters corresponding to the number on the printedlabel below the display on the front panel of a node in the system.

sequence_number A 32-bit unsigned integer, expressed in decimal format.

csi_num_arg A 32-bit unsigned integer, expressed in decimal format.

percentage_arg An 8-bit unsigned integer, expressed in decimal 0100 format.

extent_arg A 32-bit unsigned integer, expressed in decimal format.

num_extents_arg A 32-bit unsigned integer, expressed in decimal format.

threads_arg An 8-bit unsigned integer, expressed in decimal format. Valid values are 1, 2, 3, or 4.

velocity_arg The fabric speed in gigabytes per second (GBps). Valid values are 1 or 2.

timezone_arg The ID as detailed in the output of the lstimezones command.

timeout_arg The command timeout period. An integer from 0 to 600 (seconds).

stats_time_arg The frequency at which statistics are gathered. Valid values are 1 to 60 minutes inincrements of 1 minute.

xx Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

Table 6. Data types (continued)

Data types Value ranges

directory_arg Specifies a directory, file name filter, or both, within the specified directory. Validdirectory values are:

v /dumpsv /dumps/auditv /dumps/cimomv /dumps/configsv /dumps/elogsv /dumps/featurev /dumps/iostatsv /dumps/iotracev /home/admin/upgrade

The file name filter can be any valid file name, containing a maximum of 128characters, with or without the wildcard (*, an asterisk), and appended to the end ofa directory value. Valid characters are:

v *v . (the field must not start with, end with, or contain two consecutive periods)v /v -v _v azv AZv 09

locale_arg The system locale setting. Valid values are:

v 0 en_US: US English (default)v 1 zh_CN: Simplified Chinesev 2 zh_TW: Traditional Chinesev 3 ja_JP: Japanesev 4 fr_FR: Frenchv 5 de_DE: Germanv 6 it_IT: Italianv 7 es_ES: Spanish

key_arg A user-defined identifier for a secure shell (SSH) key, containing a maximum of 30characters.

user_arg Specifies the user: admin or service.

copy_rate A numeric value of 0100.

copy_type Specifies the Mirror copy type: Metro or Global.

The maximum number of values entered into a colon-separated list is 128; exceeding this maximumnumber returns an error.

CLI commands and parametersCommand-line interface (CLI) commands and parameters are represented in the syntax diagram.

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

About this guide xxi

key to fill in the rest of the command name. If there are multiple commands that start with the samecharacters, then a list of possible commands is returned. You can type in more characters until thecommand 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 specifying a command against a specific object, the object ID or name must be the last

argument in the line.

A valid parameter meets the following requirements:v Parameters can be entered in any order.v If a parameter has an associated argument, the argument must always follow the parameter.v A parameter must start with a '-'; otherwise, it is assumed to be an argument.v The maximum length of any single parameter that can be entered into the CLI is 128 bytes.v An argument can contain multiple data items. The maximum number of data items that you can enter

into such a list is 128. For a component list, separate the individual items by a colon.v Any parameter with an argument can be entered as -parameter=argument.v Entering -param= means the argument is an empty string, equivalent to -param.v The symbol '--' is valid as the next to last entry on the command line. It specifies that the next entry is

the target object name or ID, even if it begins with a hyphen.chuser -usergrp=-usergrp -- -password

v The symbol '--' is valid as the final word on the command line.

Examples that are validmkuser -name fred -usergrp 0 -password bucketsmkuser -name fred -usergrp 0 -password=bucketsmkuser -name=-barney -usergrp=0 -password=buckets

chuser -usergrp 1 fredchuser -usergrp 1 -- fredchuser -usergrp 1 -- -barney

Examples that are invalidchuser -usergrp 1 fred --chuser -usergrp 1 -- fred --chuser -- -usergrp 1 fredchuser -usergrp 1 -barney

CLI flagsThe following flags are common to all command-line interface (CLI) commands.

-? or -hPrint help text. For example, issuing lssystem -h provides a list of the actions available with thelssystem command.

-nomsgWhen used, this flag prevents the display of the successfully created output. For example, ifyou issue the following command:

mkmdiskgrp -ext 16

it displays:

MDisk Group, id [6], successfully created

xxii Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

However, if the -nomsg parameter is added, for example:

mkmdiskgrp -ext 16 -nomsg

the following information is displayed:

6

This parameter can be entered for any command, but is only acted upon by those commands thatgenerate the successfully created outputs. All other commands ignore this parameter.

CLI messagesEnsure that you are familiar with the command-line interface (CLI) messages.

When some commands complete successfully, textual output is normally provided. However, somecommands do not provide any output. The phrase No feedback is used to indicate that no output isprovided. If the command does not complete successfully, an error is generated. For example, if thecommand 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.

CLI deprecated and discontinued commandsSome command-line interface (CLI) commands are discontinued or deprecated and replaced with newcommands.

Command-line interface (CLI) commands can be discontinued or deprecated and replaced with newcommands that are more effective. This action can affect scripting, which is done to simplify tasks such asspecifying (repeated) commands.

A discontinued command is removed from the CLI and can no longer be used. In most instances, there isa replacement command for discontinued commands.

A deprecated command can still be used if the appropriate command prefix is specified (svctask orsvcinfo, for example). In most instances, there is a replacement command for deprecated commands.

The following commands are deprecated:v These commands are replaced by lseventlog:

caterrlog caterrlogbyseqnum lserrlogbyfcconsistgrp lserrlogbyfcmap lserrlogbyhost lserrlogbyiogrp lserrlogbymdisk lserrlogbymdiskgrp lserrlogbynode lserrlogbyrcconsistgrp lserrlogbyrcrelationship lserrlogbyvdisk

v These commands are replaced by lsdumps: ls2145dumps lsauditlogdumps

About this guide xxiii

lserrlogdumps lscimomdumps lsfeaturedumps lsiostatsdumps lsiotracedumps lsmdiskdumps lssoftwaredumps

v lssoftwareupgradestatus is replaced by lsupdatev chenclosurevpd is replaced by chvpdv cherrstate is replaced by cheventlogv lsnodedependentvdisks is replaced by lsdependentvdisksv setquorum is replaced by chquorumv mkpartnership is replaced by mkippartnership and mkfcpartnershipv lshbaportcandidate is replaced by lssasportcandidate and lsfcportcandidate

The following commands are discontinued:v These commands are replaced by lsdumps:

svcservicemodeinfo ls2145dumps svcservicemodeinfo lsclustervpd svcservicemodeinfo lserrlogdumps svcservicemodeinfo lsfeaturedumps svcservicemodeinfo lsiostatsdumps svcservicemodeinfo lsiotracedumps svcservicemodeinfo lsmdiskdumps svcservicemodeinfo lssoftwaredumps

v These commands are replaced by the user management commands: addsshkeys lsauth mkauth rmsshkey rmallsshkeys rmauth

v applymdisksoftware is replaced by applydrivesoftwarev chcluster is replaced by chsystemv cpfabricdumps has no replacementv dumpconfig has no replacementv dumpinternallog has no replacementv lscluster is replaced by lssystemv lsclustercandidate is replaced by lspartnershipcandidatev lsclusterip is replaced by lssystemv lsclusterstats is replaced by lssystemstatsv lsconfigdumps has no replacementv recoverarraybycluster is replaced by recoverarraybysystemv recoverdiskbycluster is replaced by recoverdiskbysystemv svcservicemodeinfo lsclustervpd is replaced by satask lsservicestatus

xxiv Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

v svcservicemodetask applysoftware is replaced by satask installsoftwarev svcservicemodetask cleardumps is replaced by cleardumpsv svcservicemodetask dumperrlog is replaced by dumperrlogv svcservicemodetask exit is replaced by stopservicev setclustertime is replaced by setsystemtimev stopcluster is replaced by stopsystemv triggermdiskdump is replaced by triggerdrivedumpv setevent is replaced by chsnmpserver, lssnmpserver, mksnmpserver, and rmsnmpserverv setemail is replaced by chemail, chemailserver, lsemailserver, mkemailserver, and rmemailserver

Understanding capacity indicatorsThe system uses base-2 (binary numeral) as capacity indicators for volumes, drives, and other systemobjects. The management GUI and the command-line interface (CLI) use different abbreviations toindicate capacity, but the value for these capacity indicators is the same.

The following table displays the differences in how capacity indicators are displayed in the managementGUI and the CLI.

Table 7. Capacity indicators. This table displays the differences in how capacity indicators are displayed in themanagement GUI and the CLI.

Metric GUI Abbreviation CLI Abbreviation Value

kibibyte KiB KB 1024

mebibyte MiB MB 1,048,576

gibibyte GiB GB 1,073,741,824

tebibyte TiB TB 1,099,511,627,776

pebibyte PiB PB 1,125,899,906,842,624

exbibyte EiB EB 1,152,921,504,606,846,976

zebibyte ZiB ZB 1,180,591,620,717,411,303,424

yobibyte YiB YB 1,208,925,819,614,629,174,706,176

Attributes of the -filtervalue parametersThe -filtervalue parameter filters a view that is based on specific attribute values that relate to eachobject type. You can combine multiple filters to create specific searches, for example, -filtervaluename=fred:status=online. The help (-filtervalue) specifies the attributes that are available for eachobject type.

The -filtervalue parameter must be specified with attrib=value. The -filtervalue? and -filtervalueparameters cannot be specified together.

Note: The qualifier characters less than () must be enclosed within double quotationmarks (""). For example, -filtervalue vdisk_count ""1. It is also valid to includethe entire expression within double quotation marks. For example, -filtervalue "vdisk_count

v gb (Gigabytes)v tb (Terabytes)v pb (Petabytes)

Capacity values displayed in units other than bytes might be rounded. When filtering on capacity, use aunit of bytes, -unit b, for exact filtering.

You can use the asterisk (*) character as a wildcard character when names are used. The asteriskcharacter can be used either at the beginning or the end of a text string, but not both. Only one asteriskcharacter can be used in a -filtervalue parameter.

xxvi Spectrum Virtualize for 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 betweenthe host system and the SAN Volume Controller command-line interface (CLI).

Overview

The system acts as the SSH server in this relationship. The SSH client provides a secure environment inwhich to connect to a remote machine. Authentication is completed using user name and password. Ifyou require command-line access without entering a password, it uses the principles of public andprivate keys for authentication.

Authenticating SSH logins

Generate a Secure Shell (SSH) key pair to use the command-line interface (CLI). Additionally, when youuse 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-basedauthentication that is supported in the OpenSSH client that is available for AIX. This scheme is based onthe supplied password (or if you require command-line access without entering a password, thenpublic-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 isdone using separate keys. This means that it is not possible to derive the decryption key from theencryption key.

Because physical possession of the private key allows access to the system, the private key must be keptin 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 requirecommand-line access without entering a password, the key pair) authenticates the connection. The keyconsists of two halves: the public keys and private keys. The SSH client public key is put onto SSHServer (B) using some means outside of the SSH session. When SSH client (A) tries to connect, the privatekey on SSH client (A) is able to authenticate with its public half on SSH server (B).

The system supports up to 32 interactive SSH sessions on the management IP address simultaneously.

Note: After one hour, a fixed SSH interactive session times out, which means the SSH session isautomatically closed. This session timeout limit is not configurable.

To connect to the system, the SSH client requires a user login name and an SSH password (or if yourequire command-line access without entering a password, the key pair). Authenticate to the systemusing a management user name and password. When using an SSH client to access a system, you mustuse your SVC_username and password. The system uses the password (and if not a password, the SSHkey 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 toprovide an SSH client.

Copyright IBM Corp. 2003, 2017 1

You can connect to the system using the same user name with which you log into the system.

Setting up an SSH client on a Windows hostYou can prepare the SSH client on a Windows host.

The workstation for the SAN Volume Controller include the PuTTY client program, which is a MicrosoftWindows SSH client program. The PuTTY client program can be installed on your workstation in one ofthese ways:v If you purchased the workstation hardware option from IBM, the PuTTY client program has been

preinstalled on the hardware.v You can use the workstation software installation CD to install the PuTTY client program.v You can use the separate PuTTY client program-installation wizard, putty-version-installer.exe. You

can download the PuTTY client program from this website:Download Putty

Note: Before you install the PuTTY client program, ensure that your Windows system meets the systemrequirements.

To connect to the system, the SSH client requires a user login name and an SSH password (or if yourequire command-line access without entering a password, the key pair). Authenticate to the systemusing a management user name and password. When using an SSH client to access a system, you mustuse your SVC_username and password. The system uses the password (and if not a password, the SSHkey 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.

Generating an SSH key pair using PuTTYTo use the SAN Volume Controller command-line interface, you must generate a Secure Shell (SSH) keypair using PuTTY.

About this task

Generate SSH keys using the PuTTY key generator (PuTTYgen):

Procedure1. 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.

Note: Leave the number of bits in a generated key value at 1024.3. Click Generate and then move the cursor around the blank area of the Key section to generate the

random characters that create a unique key. When the key has been completely generated, theinformation about the new key is displayed in the Key section.Attention: Do not modify the Key fingerprint or the Key comment fields; this can cause your key tono longer be valid.

4. (Optional) Enter a passphrase in the Key passphrase and Confirm passphrase fields. The passphraseencrypts the key on the disk; therefore, it is not possible to use the key without first entering thepassphrase.

5. Save the public key by:a. Click Save public key. You are prompted for the name and location of the public key.

2 Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html

b. Type icat.pub as the name of the public key and specify the location where you want to save thepublic key. For example, you can create a directory on your computer called keys to store both thepublic 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 thepublic and private keys. It is recommended that you save your public and private keys in thesame location.

d. Click Save.7. Close the PuTTY Key Generator window.

Configuring a PuTTY session for the CLIYou must configure a PuTTY session using the Secure Shell (SSH) password. If you require command lineaccess without entering a password, use the SSH key pair that you created for the command-lineinterface (CLI).

About this task

Attention: Do not run scripts that create child processes that run in the background and call SANVolume Controller commands. This can cause the system to lose access to data and cause data to be lost.

Complete the following steps to configure a PuTTY session for the CLI:

Procedure1. 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-loginusername field.

11. Click Session in the Category navigation tree. The Basic options for your PuTTY session aredisplayed.

12. In the Host Name (or IP Address) field, type the name or Internet Protocol (IP) address of one of theSAN 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.

Chapter 1. Secure Shell 3

15. Click Save.

Results

You have now configured a PuTTY session for the CLI.

Note: If you configured more than one IP address for the SAN Volume Controller system, repeat theprevious steps to create another saved session for the second IP address. This can then be used if the firstIP address is unavailable.

Connecting to the CLI using PuTTYEnsure that you are familiar with how to run the PuTTY and plink utilities.

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 tothe SSH user to accept the SSH server public key or user password. Because this is the first time that youconnect to an SSH server, the server is not included in the SSH client list of known hosts. Therefore, thereis a fingerprint challenge, which asks if you accept the responsibility of connecting with this host. If youtype 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 fingerprintand 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 ispresented if the fingerprint of an SSH server changes from the one previously accepted. In this case, youmust 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 isperformed on the clustered system. As a result, a challenge is sent because the fingerprint of the SSHserver has changed.

All command-line interface (CLI) commands are run in an SSH session. You can run the commands inone of the following modes:v An interactive prompt modev 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 system supports up to 32 interactive SSH sessions on the management IP address simultaneously.

Note: After one hour, a fixed SSH interactive session times out, which means the SSH session isautomatically closed. This session timeout limit is not configurable.

The following is an example of the command that you can issue to start interactive mode:C:\support utils\putty @svcconsoleip

where support utils\putty is the location of your putty.exe file, is the IP address of yourmanagement GUI, and 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 thesystem, the following output is displayed when ssh_key=yes:

4 Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

http://www.chiark.greenend.org.uk/~sgtatham/putty/download.html

IBM_2145:cluster0:superuser>lsuserid name password ssh_key remote usergrp_id usergrp_name0 superuser yes yes no 0 SecurityAdmin1 smith no yes no 4 Monitor2 jones no yes no 2 CopyOperator

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.208The servers host key is not cached in the registry. Youhave no guarantee that the server is the computer youthink it is.The servers key fingerprint is:ssh-rsa 1024 e4:c9:51:50:61:63:e9:cd:73:2a:60:6b:f0:be:25:bfIf you trust this host, enter "y" to add the key toPuTTYs cache and carry on connecting.If you want to carry on connecting just once, withoutadding the key to the cache, enter "n".If you do not trust this host, press Return to abandon theconnection.Store key in cache? (y/n) yUsing user name "superuser".Authenticating with public key "imported-openssh-key"IBM_2145:your_cluster_name:superuser>

Single line command

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_name0 superuser yes yes no 0 SecurityAdmin1 smith no yes no 4 Monitor2 jones no yes no 2 CopyOperator

Note: If you are submitting a CLI command with all parameters in single line command mode, you arechallenged upon first appearance of the SSH server host fingerprint. Ensure that the SSH server hostfingerprint 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 commandmode:

Chapter 1. Secure Shell 5

C:\Program Files\IBM\svcconsole\cimom>plink superuser@9.43.225.208 lsuserThe servers host key is not cached in the registry. You

have no guarantee that the server is the computer youthink it is.The servers key fingerprint is:ssh-rsa 1024 e4:c9:51:50:61:63:e9:cd:73:2a:60:6b:f0:be:25:bfIf you trust this host, enter "y" to add the key toPuTTYs cache and carry on connecting.If you want to carry on connecting just once, withoutadding the key to the cache, enter "n".If you do not trust this host, press Return to abandon theconnection.Store key in cache? (y/n) yAuthenticating with public key "imported-openssh-key"id name password ssh_key remote usergrp_id usergrp_name0 superuser yes yes no 0 SecurityAdmin1 smith no yes no 4 Monitor2 jones no yes no 2 CopyOperator

Starting a PuTTY session for the CLIYou must start a PuTTY session to connect to the command-line interface (CLI).

Before you begin

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 pairthat you created for the CLI.

About this task

Start a PuTTY session:

Procedure1. 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 anduploaded the SSH password or key pair, a PuTTY Security Alert window is displayed. Click Yes toaccept the change and trust the new key.

4. Type the SVC_username in the login as field and press Enter.

Preparing the SSH client on an AIX or Linux hostYou can prepare the Secure Shell (SSH) client on an AIX or Linux host.

Before you begin

Ensure that you have an SSH client installed on your system:

IBM AIX operating systemsFor IBM AIX 5L for POWER, versions 5.1, 5.2, 5.3, and AIX version 6.1 for IBM POWERarchitecture, you can obtain the OpenSSH client from the bonus packs, but you also must obtainits prerequisite, OpenSSL, from the IBM AIX toolbox for Linux applications for IBM PowerSystems. For AIX 4.3.3, you can obtain the software from the AIX toolbox for Linux applications.You can also obtain the AIX installation images from IBM developerWorks at the followingwebsite:

6 Spectrum Virtualize for SAN Volume Controller and Storwize Family: Command-Line Interface User's Guide

oss.software.ibm.com/developerworks/projects/openssh

Linux operating systemsThe OpenSSH client is installed by default on most Linux distributions. If it is not installed onyour 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 informationabout the openSSH client, visit the following website:

www.openssh.org/portable.html

About this task

Authentication to the system generally requires the use of a password, but if there is no password youcan use a key pair. Use these steps to set up an RSA key pair on the AIX or Linux host and the clusteredsystem:

Results

To authenticate using an SSH key, use the following command:ssh -i full_path_to_key username@my_system

Where my_system is the name of the system IP, username@my_system is the user name that you also loginto the system with, and full_path_to_key is the full path to the key file that was generated in the previousstep. Authenticate to the system using a SVC_username and password. (If you require command-lineaccess without using a password, SSH keys can be used.) The system determines which user is logging infrom 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.

For more information, see Connecting to the CLI using OpenSSH on page 8.

Generating an SSH key pair using OpenSSHYou can generate an SSH key pair using OpenSSH.

About this task

Set up an RSA key pair on the AIX or Linux host and the clustered system:

Procedure1. Create an RSA key pair by issuing a command on the host that is similar to this command:

ssh-keygen -t rsa

You can also create a a valid ECDSA key pair for authentication:ssh-keygen -t ecdsa

Tip: Issue the command from the $HOME/.ssh directory.This process generates two user named files. If you select the name key, the files are named key andkey.pub. Where key is the name of the private key and key.pub is the name of the public key.

2. Associate the public key with a user on the clustered system using the management GUI.

Chapter 1. Secure Shell 7

http://oss.software.ibm.com/developerworks/projects/opensshhttp://www.openssh.org/portable.htmlhttp://www.openssh.org/portable.html

Connecting to the CLI using OpenSSHYou can connect to the command-line interface (CLI) using OpenSSH.

To connect to a clustered system using a SVC_username and SSH password, issue:ssh username@my_system

To use an SSH key, issue:-i full_path_to_key

Where my_system is the name of the system IP, full_path_to_key is the full path to the key file that wasgenerated in the previous step, and SVC_username is the user name that you want to use on SAN VolumeController.

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.

Working with local and remote usersYou can create either a local or a remote user to access a SAN Volume Controller clustered system(system).

Before you begin

You can create two categories of users that acces