Command Line Interface and Script Commands Programming Guide

IBM

System

Storage

DS3000,

DS4000,

and

DS5000

Command

Line

Interface

and

Script

Commands

Programming

Guide

Note

Beforeusingthisinformationandtheproductitsupports,readtheinformationin“Notices”onp.263.

SecondEdition

ThiseditionappliestoDS5000StorageManagerVersion10.30,DS4000StorageManagerVersion10.15,andDS3000 StorageManagerVersion2.17softwarereleaselevelsandtoallsubsequentreleasesandmodificationsuntil otherwiseindicatedinneweditions.

Contents

Figures

.

.

.

.

.

.

.

.

.

.

.

.

.

. vii

Tables

.

.

.

.

.

.

.

.

.

.

.

.

.

.

. ix

About

this

document

.

.

.

.

.

.

.

.

. xi

DS3000,DS4000,andDS5000softwareandfirmware support . . . xi

Whoshouldreadthisdocument . . . xi

Noticesusedinthisdocument . . . xii

Gettinginformation,help,andservice . . . xii

Beforeyoucall . . . xii

Usingthedocumentation. . . xii

FindingStorageManagersoftware,controller firmware,andreadmefiles . . . xii

EssentialWebsitesforDS3000,DS4000,and DS5000supportinformation . . . xiii

Softwareserviceandsupport . . . xiv

Hardwareserviceandsupport. . . xiv

Firesuppressionsystems . . . xiv

Howtosendyourcomments . . . xiv

Trademarks

.

.

.

.

.

.

.

.

.

.

.

. xvii

Chapter

1.

About

the

Command

Line

Interface

.

.

.

.

.

.

.

.

.

.

.

.

.

. 1

HowtoUsetheCommandLineInterface. . . 1

UsageNotes . . . 1

CLICommands . . . 2

CommandLineTerminals . . . 3

FormattingConsiderations. . . 6

DetailedErrorReporting . . . 7

ExitStatus . . . 7

UsageExamples . . . 8

Chapter

2.

About

the

Script

Commands

11

ScriptCommandSynopsis . . . 12

RecurringSyntaxElements . . . 14

UsageGuidelines . . . 17

AddingCommentstoaScriptFile. . . 17

Chapter

3.

Script

Commands

.

.

.

.

. 19

NamingConventions . . . 19

FirmwareCompatibilityLevels . . . 20

FormattingRulesforScriptCommands . . . 20

DS3000,DS4000,andDS5000supportandminimum firmwarelevels . . . 21

ActivateEnhancedRemoteMirroringFeature . . . 31

ActivateStorageSubsystemFirmware . . . 33

AutoconfigureStorageSubsystem . . . 33

AutoconfigureStorageSubsystemHotSpares . . . 35

CheckLogicalDriveParity . . . 35

CheckRemoteMirrorStatus. . . 36

ClearDriveChannelStatistics . . . 36

ClearLogicalDriveReservations . . . 37

ClearLogicalDriveUnreadableSectors . . . 37

ClearStorageSubsystemConfiguration . . . 38

ClearStorageSubsystemEventLog . . . 38

ClearStorageSubsystemFirmwarePendingArea. . 39

CreateArray . . . 39

CreateFlashCopyLogicalDrive . . . 41

CreateHost . . . 44

CreateHostGroup . . . 44

CreateHostPort. . . 45

CreateiSCSIInitiator . . . 46

CreateRAIDLogicalDrive(AutomaticDriveSelect) 46 CreateRAIDLogicalDrive(FreeCapacityBase Select) . . . 48

CreateRAIDLogicalDrive(ManualDriveSelect) . 50

CreateRemoteMirror . . . 52

CreateVolumeCopy . . . 54

DeactivateRemoteMirror . . . 55

DeleteArray . . . 55

DeleteHost . . . 55

DeleteHostGroup . . . 55

DeleteHostPort. . . 56

DeleteiSCSIInitiator . . . 56

DeleteLogicalDrive. . . 57

DiagnoseController . . . 57

DiagnoseRemoteMirror . . . 58

DisableStorageSubsystemFeature . . . 59

DownloadDriveFirmware . . . 59

DownloadEnvironmentalCardFirmware . . . . 60

DownloadStorageSubsystemFirmware/NVSRAM 61 DownloadStorageSubsystemDriveFirmware . . 61

DownloadStorageSubsystemNVSRAM. . . 62

EnableController . . . 62

EnableStorageSubsystemFeatureKey . . . 63

RecopyVolumeCopy . . . 63

RecoverRAIDLogicalDrive. . . 64

Re-createEnhancedRemoteMirroringRepository LogicalDrive. . . 65

Re-createFlashCopy . . . 67

Re-createFlashCopyCollection. . . 68

RemoveLogicalDriveLUNMapping . . . 68

RemoveRemoteMirror . . . 69

RemoveVolumeCopy. . . 69

RepairLogicalDriveParity . . . 70

ReplaceDrive . . . 70

ResetController . . . 71

ResetStorageSubsystemBatteryInstallDate . . . 71

ResetStorageSubsystemDiagnosticData . . . . 72

ResetStorageSubsystemiSCSIBaseline . . . 72

ResetStorageSubsystemLogicalDriveDistribution 72 ResetStorageSubsystemRLSBaseline . . . 73

ResetStorageSubsystemSOCBaseline . . . 73

ResumeRemoteMirror . . . 73

ReviveArray . . . 74

ReviveDrive . . . 74

SaveDriveChannelFaultIsolationDiagnostic

Status . . . 75

SaveDriveLog . . . 75

SaveStorageSubsystemConfiguration . . . 75

SaveStorageSubsystemDiagnosticData . . . . 76

SaveStorageSubsystemEvents. . . 77

SaveStorageSubsystemiSCSIStatistics . . . 77

SaveStorageSubsystemPerformanceStatistics . . 78

SaveStorageSubsystemRLSCounts . . . 78

SaveStorageSubsystemSOCCounts. . . 79

SaveStorageSubsystemStateCapture . . . 79

SaveStorageSubsystemSupportData . . . 79

SetArray . . . 80

SetArrayForcedState. . . 81

SetController. . . 81

SetControllerServiceActionAllowedIndicator . . 84

SetDriveChannelStatus . . . 84

SetDriveHotSpare . . . 85

SetDriveServiceActionAllowedIndicator. . . . 85

SetDriveState . . . 86

SetEnclosureAlarm . . . 86

SetEnclosureIdentification . . . 86

SetEnclosureServiceActionAllowedIndicator . . 87

SetFlashCopyLogicalDrive. . . 88

SetHost . . . 89

SetHostChannel . . . 90

SetHostGroup . . . 91

SetHostPort . . . 91

SetiSCSIInitiator . . . 92

SetiSCSITargetProperties . . . 92

SetLogicalDrive . . . 93

SetRemoteMirror . . . 97

SetSession . . . 99

SetStorageSubsystem . . . 100

SetStorageSubsystemEnclosurePositions . . . 102

SetStorageSubsystemICMPResponse. . . 102

SetStorageSubsystemiSNSServerIPv4Address 103 SetStorageSubsystemiSNSServerIPv6Address 103 SetStorageSubsystemiSNSServerListeningPort 104 SetStorageSubsystemiSNSServerRefresh . . . 104

SetStorageSubsystemLearnCycle . . . 105

SetStorageSubsystemRedundancyMode. . . . 105

SetStorageSubsystemTime . . . 106

SetUnnamedDiscoverySession . . . 106

SetVolumeCopy . . . 106

ShowArray . . . 107

ShowArrayExportDependencies . . . 107

ShowArrayImportDependencies . . . 108

ShowController . . . 108

ShowControllerNVSRAM . . . 109

ShowCurrentiSCSISessions . . . 110

ShowDrive . . . 110

ShowDriveChannelStats . . . 111

ShowDriveDownloadProgress . . . 111

ShowEnhancedRemoteMirroringLogicalDrive Candidates . . . 112

ShowEnhancedRemoteMirroringLogicalDrive SynchronizationProgress . . . 112

ShowHostPorts . . . 113

ShowLogicalDrive . . . 113

ShowLogicalDriveActionProgress. . . 114

ShowLogicalDrivePerformanceStatistics. . . . 114

ShowLogicalDriveReservations. . . 115

ShowStorageSubsystem . . . 115

ShowStorageSubsystemAutoConfigure . . . . 116

ShowStorageSubsystemHostTopology . . . . 117

ShowStorageSubsystemLUNMappings . . . . 118

ShowStorageSubsystemNegotiationDefaults . . 118

ShowStorageSubsystemUnreadableSectors . . . 118

ShowString . . . 119

ShowUnconfigurediSCSIInitiators . . . 119

ShowVolumeCopy . . . 119

ShowVolumeCopySourceCandidates . . . 120

ShowVolumeCopyTargetCandidates . . . 120

StartArrayDefragment . . . 120

StartArrayExport. . . 121

StartArrayImport. . . 121

StartArrayLocate. . . 122

StartDriveChannelFaultIsolationDiagnostics . . 122

StartDriveChannelLocate. . . 123

StartDriveInitialize . . . 123

StartDriveLocate . . . 124

StartDriveReconstruction . . . 124

StartEnclosureLocate . . . 124

StartEnhancedRemoteMirroringSynchronization 124 StartiSCSIDHCPRefresh . . . 125

StartLogicalDriveInitialization . . . 125

StartStorageSubsystemLocate . . . 125

StopArrayLocate . . . 126

StopDriveChannelFaultIsolationDiagnostics . . 126

StopDriveChannelLocate . . . 126

StopDriveLocate . . . 127

StopEnclosureLocate . . . 127

StopFlashCopy . . . 127

StopiSCSISession. . . 127

StopStorageSubsystemDriveFirmwareDownload 128 StopStorageSubsystemLocate . . . 128

StopVolumeCopy . . . 128

SuspendRemoteMirror . . . 129

ScriptCommandsListedbyFunction . . . 129

ControllerCommands . . . 129

DiskDriveCommands . . . 130

EnclosureCommands . . . 130

HostTopologyCommands . . . 131

iSCSICommands . . . 131

EnhancedRemoteMirroringCommands . . . 132

SessionCommand. . . 132

FlashCopyCommands . . . 132

StorageSubsystemCommands . . . 132

UncategorizedCommands . . . 134

LogicalDriveCommands . . . 134

VolumeCopyCommands . . . 135

ArrayCommands . . . 135

Chapter

4.

Configuring

a

Storage

Subsystem

.

.

.

.

.

.

.

.

.

.

.

. 137

RAIDLevels. . . 145

Hosts . . . 147

HostGroups . . . 147

HostBusAdapterHostPorts . . . 147

LogicalUnitNumbers . . . 148

ConfiguringaStorageSubsystem. . . 148

DeterminingWhatIsonYourStorage Subsystem . . . 148

ClearingtheConfiguration . . . 151

UsingtheAutoConfigureCommand . . . . 151

UsingtheCreateLogicalDriveCommand . . . 153

ModifyingYourConfiguration. . . 156

SettingtheControllerClocks . . . 156

SettingtheStorageSubsystemPassword . . . 156

SettingtheStorageSubsystemHostType . . . 157

SettingtheStorageSubsystemCache . . . . 157

SettingtheModificationPriority . . . 161

AssigningGlobalHotSpares . . . 161

SavingaConfigurationtoaFile . . . 161

Chapter

5.

Using

the

FlashCopy

Premium

Feature

.

.

.

.

.

.

.

.

.

. 163

HowFlashCopyWorks . . . 163

CreatingaFlashCopyLogicalDrive . . . 164

CreatingaFlashCopyLogicalDrivewith User-AssignedDiskDrives. . . 164

CreatingaFlashCopyLogicalDrivewith Software-AssignedDiskDrives . . . 165

CreatingaFlashCopyLogicalDriveby SpecifyingaNumberofDiskDrives. . . 166

User-DefinedParameters . . . 166

FlashCopyLogicalDriveNamesandFlashCopy RepositoryLogicalDriveNames . . . 168

ChangingFlashCopyLogicalDriveSettings . . . 168

Stopping,Restarting,andDeletingaFlashCopy LogicalDrive . . . 169

Chapter

6.

Using

the

Enhanced

Remote

Mirroring

Premium

Feature

.

. 171

HowEnhancedRemoteMirroringWorks . . . . 171

MirrorRepositoryLogicalDrives. . . 172

MirrorRelationships . . . 172

DataReplication . . . 173

LinkInterruptionsorSecondaryLogicalDrive Errors . . . 173

Resynchronization. . . 174

CreatingaRemote-MirrorPair . . . 174

PerformanceConsiderations . . . 175

EnablingtheEnhancedRemoteMirroring Feature . . . 175

ActivatingtheEnhancedRemoteMirroring Feature . . . 175

DeterminingCandidatesforaRemote-Mirror Pair . . . 177

CreatingaRemote-MirrorPair . . . 178

ChangingEnhancedRemoteMirroringSettings 179 SuspendingandResumingaMirrorRelationship 179 RemovingaMirrorRelationship . . . 180

DeletingaPrimaryLogicalDriveoraSecondary LogicalDrive . . . 180

DisablingtheEnhancedRemoteMirroringFeature 181 DeactivatingtheEnhancedRemoteMirroring Feature . . . 181

InteractionwithOtherFeatures . . . 181

StoragePartitioning . . . 181

FlashCopyLogicalDrives . . . 181

VolumeCopy . . . 182

DynamicLogicalDriveExpansion . . . 182

AsynchronousEnhancedRemoteMirroringUtility 182 DescriptionoftheAsynchronousEnhanced RemoteMirroringUtility . . . 182

OperationoftheAsynchronousEnhanced RemoteMirroringUtility . . . 183

RunningtheAsynchronousEnhancedRemote MirroringUtility . . . 184

ConfigurationUtility . . . 184

Chapter

7.

Using

the

VolumeCopy

Premium

Feature

.

.

.

.

.

.

.

.

.

. 187

HowVolumeCopyWorks . . . 187

SourceLogicalDrive . . . 187

TargetLogicalDrive . . . 188

VolumeCopyandPersistentReservations . . . 188

StorageSubsystemPerformance . . . 189

Restrictions . . . 189

VolumeCopyCommands . . . 189

CreatingaVolumeCopy . . . 190

EnablingtheVolumeCopyFeature . . . 190

DeterminingVolumeCopyCandidates . . . . 190

CreatingaVolumeCopy . . . 191

ViewingVolumeCopyProperties . . . 192

ChangingVolumeCopySettings . . . 192

RecopyingaLogicalDrive . . . 193

StoppingaVolumeCopy. . . 194

RemovingCopyPairs . . . 194

InteractionwithOtherFeatures . . . 195

StoragePartitioning . . . 195

FlashCopyLogicalDrives . . . 195

EnhancedRemoteMirroring . . . 196

Chapter

8.

Maintaining

a

Storage

System

.

.

.

.

.

.

.

.

.

.

.

.

.

. 199

RoutineMaintenance. . . 199

RunningaMediaScan . . . 199

RunningaRedundancyCheck . . . 200

ResettingaController . . . 200

EnablingaControllerDataTransfer . . . 200

ResettingtheBatteryAge . . . 201

RemovingPersistentReservations . . . 201

SynchronizingtheControllerClocks. . . 201

LocatingDiskDrives . . . 201

RelocatinganArray . . . 201

PerformanceTuning . . . 203

MonitoringthePerformance . . . 203

ChangingtheRAIDLevels . . . 204

ChangingtheSegmentSize. . . 204

ChangingtheCacheParameters . . . 204

DefragmentinganArray. . . 205

TroubleshootingandDiagnostics . . . 205

CollectingDriveData . . . 207

DiagnosingaController . . . 207

RunningReadLinkStatusDiagnostics . . . . 208

CollectingSwitch-on-a-ChipErrorStatistics . . 210

RecoveryOperations . . . 211

SettingtheControllerOperationalMode . . . 211

ChangingtheControllerOwnership. . . 212

InitializingaDrive . . . 212

ReconstructingaDrive . . . 212

InitializingaLogicalDrive . . . 213

RedistributingLogicalDrives . . . 213

ReplacingCRUs . . . 213

Chapter

9.

Examples

of

Information

Returned

by

the

Show

Commands

.

. 215

ShowStorageSubsystemCommand. . . 215

ShowControllerNVSRAM . . . 238

ShowDrive . . . 245

ShowDriveChannelStatus. . . 247

ShowLogicalDrives . . . 249

Chapter

10.

Example

Script

Files

.

.

. 253

ConfigurationScriptExample1 . . . 253

ConfigurationScriptExample2 . . . 254

Chapter

11.

Deprecated

Commands

and

Parameters

.

.

.

.

.

.

.

.

.

. 257

DeprecatedCommands . . . 257

DeprecatedParameters . . . 261

Appendix.

Additional

Documentation

263

Notices

.

.

.

.

.

.

.

.

.

.

.

.

.

. 267

Glossary

.

.

.

.

.

.

.

.

.

.

.

.

. 269

Figures

1. HostandStorageRelationship. . . 138

2. DS3200HostPorts . . . 140

3. DS3400HostPorts . . . 140

4. DS4200andDS4700HostPorts . . . 140

Tables

1. CommandNameSyntaxConventions . . . . 2 2. CommandLineTerminals . . . 3 3. ExitStatus . . . 7 4. ConfigurationandManagementOperations 11 5. ObjectTypesandIdentifiers . . . 12 6. GeneralFormoftheScriptCommands 13 7. RecurringSyntaxElements . . . 14 8. DS3000,DS4000,andDS5000commands,listed

alphabetically . . . 22 9. ValidCharactersforaCHAPSecret . . . . 90 10. HostPortsandtheTypeofHostInterfaceson

ControllerModules . . . 139 11. MaximumNumberofDiskDrives . . . . 142 12. MaximumNumberofDiskDrivesinaArray

BasedonCapacity . . . 143 13. LogicalDriveSpecificationsbySupported

ControllerModel . . . 145 14. RAIDLevelConfigurations . . . 145 15. MaximumNumberofHBAHostPortsper

Controller. . . 147 16. DefaultValuesforSegmentSizeandCache

ReadPrefetch . . . 153

17. ValuesforthecacheFlushModifierParameter 159 18. ComponentsofaFlashCopyLogicalDrive 163 19. FlashCopyLogicalDriveCommands 164 20. FlashCopyLogicalDriveParameters 167 21. MaximumNumberofDefinedMirrors 171 22. VolumeCopyCommands. . . 189 23. InformationAboutStorageSubsystem

Performance . . . 203 24. SupportDatafortheStorageSubsystem 205 25. RLSBaselineDatafortheStorageSubsystem 208 26. DeprecatedCommands . . . 257 27. DeprecatedParameters . . . 261 28. DS3000StorageSubsystemdocumenttitlesby

usertasks. . . 263 29. DS4000StorageSubsystemdocumenttitlesby

usertasks. . . 263 30. StorageExpansionEnclosuredocumenttitles

byusertasks. . . 264 31. DS3000andDS4000–relateddocumenttitles

About

this

document

Thisdocumentisaprogramming guidethatdescribesthecommandlineinterfaceand thescript commandsforDS3000,DS4000™,and DS5000StorageManagersoftwaretoconfigure,operate,and maintainastorage subsystem.Thisdocumentdescribesallofthescriptcommands,explainsthepurpose ofthecommands,showsthecompletesyntaxofthecommands,anddefinestheparametersforthe commands.

ForinformationaboutusingtheStorageManagergraphical userinterface(GUI)orconfiguringyourhost operatingsystems,seethefollowingdocuments:

v IBMSystemStorageDS3000StorageManagerInstallationand HostSupportGuide v IBMSystemStorageDS4000StorageManagerInstallationand HostSupportGuide v IBMSystemStorageDS5000StorageManagerInstallationand HostSupportGuide

Thisdocumentdoesnotcoverhardwareinstallationorintegration.Forinformationaboutthesetopics, seetheInstallationandSupportGuidethatisappropriateforyourstorage subsystem.See“Additional Documentation,”onpage263fora listofthesedocuments.

ChecktheDS3000,DS4000,orDS5000 readmefiles forthemostup-to-dateinformationregarding hardware,software,orfirmwareproductsthatmight notbe describedinthisdocument.

DS3000,

DS4000,

and

DS5000

software

and

firmware

support

Thecommandlineinterfaceand thescriptcommandsdescribedin thisdocumentaresupportedwiththe followingsoftwareandfirmwarelevels:

v DS3000:DS3000 StorageManager Version2.xxsoftwareinconjunctionwithfirmware6.xx.xx.xxand later.

v DS4000:DS4000 StorageManager Version10.xx softwareinconjunctionwith theDS4000 controller firmwareversion7.xx.xx.xxand later.

Note: Some ofthescriptcommandsarealsosupportedinearlierversions ofDS4000controller

firmware.Pleasesee“DS3000,DS4000,andDS5000support andminimumfirmwarelevels” onpage21 fortheminimumcontrollerfirmwarethatisrequiredtosupport eachscriptcommand.Thistable also showswhichcommandsaresupportedwiththeDS3000,DS4000,orDS5000productsonly,twoof the three,orallthree.

v DS5000:DS5000 StorageManager Version10.30softwareinconjunctionwiththeDS5000controller firmwareversion7.30.

Who

should

read

this

document

Thisdocumentassumesthattheuserhasaknowledgeofbasicstorage areanetwork(SAN)hardware andinstallationskills.

Thisdocumentisintendedforsystem operators,system administrators,and servicepersonnelwho are responsibleforoperating,maintaining,troubleshooting,and servicingaDS3000,DS4000,or DS5000 storagesubsystem.Usersmust befamiliarwithcomputersystem operation,maintenance, andrepair.In addition,theyshouldunderstanddiskstoragetechnology,RedundantArrayofIndependentDisks (RAID)concepts,networking,andFibreChannelandiSCSItechnologies.Thereadermust havea basic knowledgeofSANhardwarefunctionality(controllers,drives,and hosts)andSANcabling.

| | | | | | | |

Notices

used

in

this

document

Thisdocumentcontains thefollowingnoticesthatare designedtohighlightkeyinformation: Note: Thesenoticesprovidetips, guidance,oradvice.

Important:

Thesenoticesprovideinformationoradvice thatmighthelpyouavoidinconvenientorproblem situations.

Attention:

Thesenoticesindicatepossibledamagetoprograms,devicesordata.An attentionnoticeisplaced justbefore theinstructionorsituation inwhichdamagecould occur.

Getting

information,

help,

and

service

Ifyouneedhelp,service,ortechnicalassistanceorjustwantmoreinformationaboutIBM®_products,you willfind awidevarietyofsourcesavailable fromIBMtoassistyou.Thissection containsinformation aboutwheretogoforadditionalinformationaboutIBMand IBMproducts,whattodo ifyouexperience aproblemwithyour system,andwhomtocallforservice,if itisnecessary.

Before

you

call

Beforeyoucall,takethesestepstotrytosolve theproblemyourself: v Checkall cablestomakesurethattheyare connected.

v Checkthepowerswitchestomakesurethatthesystemisturnedon.

v Usethetroubleshootinginformationinyoursystem documentation,andusethediagnostictoolsthat comewith yoursystem.

v Checkfortechnicalinformation,hints,tips,andnew devicedriversattheIBMsupport Websitepages thatarelistedinthis section.

v UseanIBM discussionforumontheIBMWebsitetoaskquestions.

Youcansolve manyproblemswithoutoutsideassistancebyfollowingthetroubleshootingprocedures thatIBMprovidesintheStorageManageronline helporinthedocumentsthatareprovidedwith your systemandsoftware.Theinformationthatcomeswithyour systemalsodescribesthediagnostic tests thatyoucanperform.Mostsubsystems,operatingsystems,andprogramscome withinformationthat containstroubleshootingproceduresand explanationsoferrormessagesanderrorcodes.Ifyoususpecta softwareproblem,seetheinformationfortheoperatingsystemorprogram.

Using

the

documentation

Informationaboutyour IBMsystemand preinstalledsoftware,ifany,isavailableinthedocumentsthat comewithyour system.Thisincludesprintedbooks,online documents,readmefiles,and helpfiles.See thetroubleshootinginformationinyoursystemdocumentationforinstructionsforusingthediagnostic programs.Thetroubleshootinginformationorthediagnosticprogramsmighttellyouthatyouneed additionalorupdateddevicedriversorothersoftware.

Finding

Storage

Manager

software,

controller

firmware,

and

readme

files

StorageManagersoftwareandcontrollerfirmwareare availableontheproductCDand canalsobe downloadedfromtheWeb.StorageManagerreadmefilesare alsofoundontheWeb.

Important: BeforeyouinstallStorageManagersoftware,consultthereadmefileforyourhostoperating system.Updatedreadmefilescontainthelatestdevicedriverversions,firmwarelevels,limitations,and otherinformationnotfoundinthis document.

www.ibm.com/servers/storage/support/disk/

2. Click thelinkforyour storagesubsystem(forexample,DS3400orDS4800).

3. Whenthesupportpageforyourstorage subsystemopens,clicktheDownloadlinkintheSupport& Downloads box.TheSoftwareand devicedriverspageopens.

4. IntheStorageManagersectionofthetable,locateyouroperatingsystemand versionlevel,andclick ontheversionlinkintherighthandcolumn.Thespecificpageforyour storagesubsystemand operatingsystem versionopens.

5. InthetableunderFiledetails, clickonthe*.txtfilelink, andtheREADMEwillopeninyourWeb browser.

Essential

Web

sites

for

DS3000,

DS4000,

and

DS5000

support

information

Themostup-to-dateinformationaboutDS3000,DS4000,andDS5000 storagesubsystemsand Storage Manager,includingdocumentationandthemostrecent software,firmware,and NVSRAMdownloads, canbefoundatthefollowingWebsites.

IBMSystemStorage™_{DiskStorageSystems}

Findlinkstosoftwareand firmwaredownloads,readmes,andsupportpagesfor allIBMSystem Storagedisk storagesystems,includingDS3000,DS4000,andDS5000:

www.ibm.com/systems/support/storage/disk IBMSystemStorageInteroperationCenter(SSIC)

Findtechnicalsupportinformationforyour specificDS3000,DS4000,or DS5000storage subsystem/hostconfiguration,includingthelatestrecommendedfirmwareversions foryour system,byusingthisinteractiveWeb-based utility:

www.ibm.com/systems/support/storage/config/ssic/index.jsp

IBMDS3000,DS4000,orDS5000andBladeCenter® PremiumFeatureActivation

Activatea DS3000,DS4000,orDS5000premiumfeaturebyusingthis Web-basedutility: https://www-912.ibm.com/PremiumFeatures/jsp/keyPrereq.jsp

IBMSystemStorageDS3000,DS4000,andDS5000InteroperabilitySupport

FindthelatestinformationaboutoperatingsystemandHBAsupport,clusteringsupport,storage areanetwork(SAN)fabricsupport,andStorageManagerfeaturesupport:

v DS3000:www.ibm.com/systems/storage/disk/ds3000/pdf/interop.pdf

v DS4000/ DS5000:www.ibm.com/servers/storage/disk/ds4000/interop-matrix.html StorageArea Network(SAN) Support

FindinformationaboutusingSANswitches,includinglinkstoSANuserguides andother documents:

www.ibm.com/systems/support/storage/san SupportforIBMSystemp™_,AIX5L™_,andLinux®_servers

FindthelatestsupportinformationforSystemp,AIX®_{,Linux,BladeCenter,andi5/OS}®_servers: www.ibm.com/systems/support/supportsite.wss/brandmain?brandind=5000025

SupportforIBMSystemx™_servers

FindthelatestsupportinformationforSystemxIntel-andAMD-basedservers: www.ibm.com/systems/support/supportsite.wss/brandmain?brandind=5000008 eServer™SystempandAIXInformationCenter

FindeverythingyouneedtoknowaboutusingAIXwith Systempand POWER™servers: publib.boulder.ibm.com/infocenter/pseries/index.jsp?

| | | |

FixCentral

Findfixesandupdatesforyour system’ssoftware,hardware,andhostoperatingsystem: www.ibm.com/eserver/support/fixes

IBMSystemStorageproducts

FindinformationaboutallIBMSystemStorageproducts: www.storage.ibm.com

IBMPublicationsCenter FindIBM publications:

www.ibm.com/shop/publications/order/

Software

service

and

support

ThroughIBMSupportLine,forafee youcangettelephone assistancewith usage,configuration,and softwareproblems.ForinformationaboutwhichproductsaresupportedbySupportLineinyour country orregion,gotothefollowingWebsite:

www.ibm.com/services/sl/products

FormoreinformationabouttheIBMSupportLineand otherIBMservices,gotothefollowingWebsites: v www.ibm.com/services

v www.ibm.com/planetwide

Hardware

service

and

support

YoucanreceivehardwareservicethroughIBM IntegratedTechnology Servicesor throughyourIBM reseller,ifyourresellerisauthorizedbyIBMtoprovidewarrantyservice.GotothefollowingWebsite forsupporttelephonenumbers:

www.ibm.com/planetwide

IntheU.S.and Canada,hardwareserviceandsupport isavailable 24hoursaday,7 daysaweek.Inthe U.K.,theseservicesareavailable MondaythroughFriday,from9a.m.to 6p.m.

Fire

suppression

systems

Afiresuppressionsystemistheresponsibilityofthecustomer.Thecustomer’sowninsurance

underwriter,localfiremarshal,or alocalbuildinginspector,orboth,shouldbeconsulted inselectinga firesuppressionsystemthatprovidesthecorrectlevelofcoverageand protection.IBMdesigns and manufacturesequipmenttointernalandexternal standardsthatrequirecertainenvironmentsforreliable operation.BecauseIBM doesnottestanyequipmentforcompatibilitywith firesuppressionsystems,IBM doesnotmake compatibilityclaimsofanykindnordoesIBMproviderecommendationsonfire

suppressionsystems.

How

to

send

your

comments

Yourfeedbackisimportanttohelpus providethehighest qualityinformation.Ifyouhaveanycomments aboutthisdocument,youcansubmittheminoneofthefollowingways:

E-mail

Submityour commentsbye-mailto: starpubs@us.ibm.com

Besuretoinclude thenameandordernumber ofthedocumentand,if applicable,thespecific locationof thetextthatyouare commentingon,suchasa pagenumberortablenumber.

Mail

Sendyourcommentsto:

International Business Machines Corporation Information Development

Department GZW 9000 South Rita Road Tucson, Arizona USA

85744-0001

Besuretoinclude thenameandordernumberof thedocumentand,if applicable,thespecific locationof thetextthatyouare commentingon,suchasa pagenumberortablenumber.

Trademarks

ThefollowingtermsaretrademarksofInternationalBusiness MachinesCorporation intheUnitedStates, othercountries,orboth:

AIX DS4000 eServer FlashCopy IBM POWER RS/6000 System p System Storage

Microsoft®_Windows®_{andWindows NT}®_{are registeredtrademarksof MicrosoftCorporationinthe} UnitedStates,othercountries,orboth.

Java™_{andallJava-basedtrademarksandlogosare trademarksorregisteredtrademarksofSun} Microsystems,Inc.intheUnitedStates,othercountries,orboth.

Linuxisa registeredtrademarkofLinusTorvaldsintheUnitedStates, othercountries,orboth. UNIX®isaregisteredtrademarkofTheOpenGroup intheUnitedStatesandothercountries. Othercompany,product,orservicenamesmaybetrademarksorservicemarks ofothers.

Chapter

1.

About

the

Command

Line

Interface

Note: Attention: IBMrecommends usingtheStorageManagerclientGUItomanageyourstorage subsystems.– Thecommand-lineinterfacedoesnothaveanymechanismstopreventyoufrom inadvertentlymaking unwantedchanges tothestorage subsystem.Becausethescriptcommandsare capableofdamaginga configurationand causinglossofdataaccessifnotusedcorrectly,IBM

recommendsusingtheStorageManager clientGUItomanageyour storagesubsystemconfigurations. Thecommand-lineinterface(CLI)isasoftwaretoolthatletsstorage subsysteminstallers,developers,and engineersconfigureandmonitorstorage subsystems.UsingtheCLI,youcanruncommandsfroman operatingsystemprompt,suchastheWindowscommandprompt,a Linuxoperatingsystemconsole,or aSolaris operatingsystemconsole.

Eachcommandperformsaspecific actionformanagingastorage subsystemorreturninginformation aboutthestatusofa storagesubsystem.Youcanenterindividualcommands,oryoucanrunscriptfiles whenyouneedto performoperationsmorethanonce.For example,youcanrunscript fileswhenyou wanttoinstall thesameconfigurationonseveralstoragesubsystems.TheCLIletsyouload ascriptfile fromadiskand runthescriptfile.TheCLIprovides awayto runstoragemanagement commandson morethanonenetworkstorage subsystem.YoucanusetheCLIbothininstallationsitesandin developmentenvironments.

How

to

Use

the

Command

Line

Interface

ThecommandsthatyourunontheCLIprovideaccesstothescriptengine, specifythestoragesubsystem toreceivethescriptcommands,andset operationenvironment parameters.

ACLIcommandconsistsoftheseelements: v ThetermSMcli

v Thestoragesubsystemidentifier v Parameters

v Scriptcommands

ACLIcommandtakesthisform:

SMcli storageSubsystem parameters script-commands; v SMcliinvokesthecommandlineinterface.

Note: Ifyouissuethecommandfromthedirectoryor folderthatdoesnotcontaintheSMcli.exe program,youneedtoinclude theappropriatepath:directoryName/SMcli.

v storageSubsystemisthenameortheIPaddressofthestoragesubsystem.

v parametersare CLIparametersthatdefinetheenvironmentand thepurposeforthecommand. v script-commandsareoneormorescriptcommandsorthenameofascriptfilethatcontainsscript

commands.(Thescriptcommandsarethestoragesubsystemconfigurationcommands.)

Usage

Notes

IfyouenterSMcliand astoragesubsystemnamebutdonotspecifyCLIparameters,scriptcommands,or ascriptfile,thecommandlineinterfacerunsininteractivemode.Interactivemodeletsyourun

individualcommandswithoutprefixingthecommandswith SMcli.Ininteractivemode,youcanentera singlecommand,view theresults,andenterthenextcommandwithouttypingthecompleteSMcli string. Interactivemodeisusefulfordeterminingconfigurationerrors andquicklytestingconfigurationchanges.

Toendaninteractivemodesession,typetheoperatingsystem-specificcommandforterminatinga program(suchasControl-ContheUNIXoperatingsystemortheWindowsoperatingsystem).Typing theterminationcommand(Control-C)whileininteractivemodeturnsoffinteractivemodeand returns operationofthecommandprompttoaninputmodethatrequiresyoutotypethecompleteSMclistring. IfyouenteranincompleteorinaccurateSMcli stringthatdoesnothavethecorrectsyntax,parameter names,options, orterminals,thescriptenginereturnsusageinformation.

CLI

Commands

Thefollowingtableliststheconventionsusedinthecommandstatementsyntaxtomanage thestorage subsystem.

Table1.CommandNameSyntaxConventions

Convention Definition

(a|b|c) Alternative(“a”or“b”or“c”)

italicized-words A_parameterterminal_(athat_responseneedsuser_toainput_variable)tofulfilla

[...](squarebrackets) Zerooroneoccurrence(squarebracketsarealso usedasadelimiterforsomecommandparameters)

{...}(curlybraces) Zeroormoreoccurrences

bold Aterminalthatneedsacommandparameterentered tostartanaction

GeneralformsoftheCLIcommandsfollow,whichshowtheterminals andtheparametersthatare used ineachcommand.

SMcli DNS-network-name-or-IP-address [DNS-network-name-or-IP-address]

[-c “command; {command2};”]

[-n storage-system-name | -w wwID]

[-o outputfile] [-p password] [-e] [-S] [-quick]

SMcli DNS-network-name-or-IP-address[DNS-network-name-or-IP-address]

[-f scriptfile]

[-n storage-system-name | -w wwID]

[-o outputfile] [-p password] [-e] [-S] [-quick]

SMcli (-n storage-system-name | -w wwID)

[-c “command; {command2};”]

[-o outputfile] [-p password] [-e] [-S] [-quick]

SMcli (-n storage-system-name -w wwID)

[-f scriptfile]

[-o outputfile] [-p password] [-e] [-S] [-quick]

SMcli -a email: email-address [host-name-or-IP-address1

[host-name-or-IP-address2]]

[-n storage-system-name | -w wwID | -h host-name | -r (host_sa | direct_sa)]

[-I information-to-include] [-q frequency] [-S]

SMcli -x email: email-address [host-name-or-IP-address1

[host-name-or-IP-address2]]

[-n storage-system-name | -w wwID | -h host-name | -r (host_sa | direct_sa)] [-S]

SMcli (-a | -x) trap: community, host-name-or-IP-address

[host-name-or-IP-address1 [host-name-or-IP-address2]]

[-n storage-system-name | -w wwID | -h host-name | -r (host_sa | direct_sa)] [-S] SMcli-d[-w][-i][-s][-v][-S]

SMcli -m host-name-or-IP-address -F email-address

[-g contactInfoFile] [-S]

SMcli-A[host-name-or-IP-address[host-name-or-IP-address]][-S]

|

SMcli-X(-n storage-system-name| -wwwID|-h host-name) SMcli-?

Command

Line

Terminals

Table2.CommandLineTerminals

Terminal Definition

host-name-or-IP-address SpecifieseitherthehostnameortheInternetProtocol(IP)address (xxx.xxx.xxx.xxx)ofanin-bandmanagedstoragesubsystemoran out-of-bandmanagedstoragesubsystem.

v Ifyouaremanagingastoragesubsystembyusingahostthrough in-bandstoragemanagement,youmustusethe-nterminalorthe-w terminalifmorethanonestoragesubsystemisconnectedtothehost. v Ifyouaremanagingastoragesubsystembyusingout-of-bandstorage

managementthroughtheEthernetconnectiononeachcontroller,you mustspecifythehost-name-or-IP-addressofthecontrollers.

v IfyouhavepreviouslyconfiguredastoragesubsystemintheEnterprise ManagementWindow,youcanspecifythestoragesubsystembyits user-suppliednamebyusingthe-nterminal.

v

IfyouhavepreviouslyconfiguredastoragesubsystemintheEnterprise ManagementWindow,youcanspecifythestoragesubsystembyits World-WideIdentifier(WWID)byusingthe-wterminal.

-A

Addsastoragesubsystemtotheconfigurationfile.Ifyoudonotfollowthe -Aterminalwithahost-name-or-IP-address,auto-discoveryscansthelocal subnetforstoragesubsystems.

-a AddsaSimpleNetworkManagementProtocol(SNMP)trapdestinationor anemailaddressalertdestination.

v

WhenyouaddanSNMPtrapdestination,theSNMPcommunityis automaticallydefinedasthecommunitynameforthetrap,andthehostis theIPaddressorDomainNameServer(DNS)hostnameofthesystemto whichthetrapshouldbesent.

v

Whenyouaddanemailaddressforanalertdestination,theemail-address istheemailaddresstowhichyouwantthealertmessagetobesent. -c Indicatesthatyouareenteringoneormorescriptcommandstorunonthe

specifiedstoragesubsystem.Endeachcommandwithasemicolon(;).You cannotplacemorethanone-cterminalonthesamecommandline.Youcan includemorethanonescriptcommandafterthe-cterminal.

-d

Showsthecontentsofthescriptconfigurationfile.Thefilecontenttakes thisformat:storage-system-namehost-name1host-name2

-e Runsthecommandswithoutperformingasyntaxcheckfirst. -F(uppercase) Specifiestheemailaddressfromwhichallalertswillbesent.

Table2.CommandLineTerminals (continued)

Terminal Definition

-f(lowercase)

Specifiesafilenamethatcontainsscriptcommandsthatyouwanttorunon thespecifiedstoragesubsystem.(Thisterminalissimilartothe-cterminal inthatbothterminalsareintendedforrunningscriptcommands.The-c terminalrunsindividualscriptcommands.The-fterminalrunsafileof scriptcommands.)

Bydefault,anyerrorsthatareencounteredwhenrunningthescript commandsinafileareignored,andthefilecontinuestorun.Tooverride thisbehavior,usethesetsessionerrorAction=stopcommandinthescript file.

-g

SpecifiesanASCIIfilethatcontainsemailsendercontactinformationthat willbeincludedinallemailalertnotifications.TheCLIassumesthatthe ASCIIfileistextonly,withoutdelimitersoranyexpectedformat.Donot usethisterminalifauserdata.txtfileexists.

-h SpecifiesthehostnamethatisrunningtheSNMPagenttowhichthe storagesubsystemisconnected.Usethisterminalwiththe-aterminaland the-xterminal.

-I Specifiesthetypeofinformationtobeincludedintheemailalert notifications.Youcanselectthesevalues:

v eventOnly v profile v supportBundle -i

ShowstheIPaddressoftheknownstoragesubsystems.Usethisterminal withthe-dterminal.Thefilecontentstakesthisformat:

storage-system-nameIP-address1IPaddress2

-m SpecifiesthehostnameortheIPaddressoftheemailserverfromwhich emailalertnotificationsaresent.

-n

Specifiesthenameofthestoragesubsystemonwhichyouwanttorunthe scriptcommands.Thisnameisoptionalwhenyouusea

host-name-or-IP-address.Ifyouareusingthein-bandmethodformanaging thestoragesubsystem,youmustusethe-nterminalifmorethanone storagesubsystemisconnectedtothehostatthespecifiedaddress.The storagesubsystemnameisrequiredwhenthehost-name-or-IP-addressisnot used.Thenameofthestoragesubsystemthatisconfiguredforuseinthe EnterpriseManagementWindow(thatis,thenameislistedinthe configurationfile)mustnotbeaduplicatenameofanyotherconfigured storagesubsystem.

-o Specifiesafilenameforalloutputtextthatisaresultofrunningthescript commandswhenyouusethisterminalwiththe-cterminalorthe-f terminal.Ifyoudonotspecifyanoutputfile,theoutputtextgoesto standardoutput(stdout).Alloutputfromcommandsthatarenotscript commandsissenttostdout,regardlessofwhetherthisterminalisset. -p Specifiesthepasswordforthestoragesubsystemonwhichyouwanttorun

commands.Apasswordisnotnecessaryundertheseconditions: v Apasswordhasnotbeensetonthestoragesubsystem.

v Thepasswordisspecifiedinascriptfilethatyouarerunning.

v Youspecifythepasswordbyusingthe-cterminalandthesetsession password=passwordcommand.

Table2.CommandLineTerminals (continued)

Terminal Definition

-q Specifiesthefrequencythatyouwanttoincludeadditionalprofileor supportbundleinformationintheemailalertnotifications.Anemailalert notificationcontainingatleastthebasiceventinformationisalways generatedforeverycriticalevent.Ifyousetthe-IterminaltoeventOnly,the onlyvalidvalueforthe-qterminaliseveryEvent.Ifyousetthe-Iterminal toeithertheprofilevalueorthesupportBundlevalue,thisinformationis includedwiththeemailswiththefrequencyspecifiedbythe-qterminal. Thesevaluesarevalidfrequencyvalues:

v everyEvent–Informationisreturnedwitheveryemailalertnotification.

v 2–Informationisreturnednomorethanonceeverytwohours.

v 4–Informationisreturnednomorethanonceeveryfourhours.

v 8–Informationisreturnednomorethanonceeveryeighthours.

v 12–Informationisreturnednomorethanonceevery12hours.

v 24–Informationisreturnednomorethanonceevery24hours. -quick

Reducestheamountoftimethatisrequiredtorunasingle-lineoperation. Anexampleofasingle-lineoperationistherecreateflashCopyLogicalDrive command.Thisterminalreducestimebynotrunningbackgroundprocesses forthedurationofthecommand.

Donotusethisterminalforoperationsthatinvolvemorethanone single-lineoperation.Extensiveuseofthiscommandcanoverrunthe controllerwithmorecommandsthanthecontrollercanprocess,which causesoperationalfailure.Also,statusupdatesandconfigurationupdates thatarecollectedusuallyfrombackgroundprocesseswillnotbeavailable totheCLI.Thisterminalcausesoperationsthatdependonbackground informationtofail.

-r

Setsorchangesthealertnotificationsforallofthestoragesubsystemsthat aremanagedbyaspecificstoragemanagementstation.Usethe-rterminal withthe-aterminalorthe-xterminal.Forstoragesubsystemsthatare managedout-of-band,usethedirect_savalue.Forstoragesubsystemsthat aremanagedin-band,usethehost_savalue.

-S(uppercase) Suppressesinformationalmessagesdescribingthecommandprogressthat appearwhenyourunscriptcommands.(Suppressinginformational messagesisalsocalledsilentmode.)Thisterminalsuppressesthese messages:

v Performance syntax check

v Syntax checkcomplete

v Executingscript

v Script executioncomplete

v

SMcli completed successfully

-s(lowercase) Showsthealertsettingsintheconfigurationfilewhenusedwiththe-d terminal.

-v Showthecurrentglobalstatusoftheknowndevicesinaconfigurationfile whenusedwiththe-dterminal.

-w

SpecifiestheWWIDofthestoragesubsystem.Thisterminalisanalternate tothe-nterminal.Usethe-wterminalwiththe-dterminaltoshowthe WWIDsoftheknownstoragesubsystems.Thefilecontenttakethisformat: storage-system-nameworld-wide-IDIPaddress1IP-address2.

Table2.CommandLineTerminals (continued)

Terminal Definition

-x(lowercase) RemovesanSNMPtrapdestinationoranemailaddressalertdestination. ThecommunityistheSNMPcommunitynameforthetrap,andthehostis theIPaddressorDNShostnameofthesystemtowhichyouwantthetrap sent.

-? ShowsusageinformationabouttheCLIcommands.

Formatting

Considerations

Doublequotationmarks (“”) thatare usedaspart ofanameorlabelrequire specialconsiderationwhen youruntheCLIcommandsand thescriptcommandsona MicrosoftWindowsoperatingsystem.This sectiondescribeshow tousedoublequotationmarks innameswhilerunningCLIcommandsandscript commandsonaWindowsoperatingsystem.

Whendoublequotation marks(“”) arepartofa nameorvalue, youmust insertabackslash(\)before eachdoublequotationmarkcharacter.For example:

-cset storageSubsystemuserLabel=\“Engineering\”;”

where“Engineering”isthestoragesubsystemname.Asecondexampleis: -n\“My\”_StorageSubsystem

where“My”_StorageSubsystemisthenameofthestoragesubsystem.

Youcannotusedoublequotationmarks(“ ”)aspartofa characterstring(alsocalledstringliteral)within ascriptcommand. Forexample,youcannotenterthefollowingstringtosetthestoragesubsystemname to“FinanceSubsystem″:

-c“setstorageSubsystemuserLabel=\”\”Finance\”Subsystem\”;”

IntheLinuxoperatingsystemand theSolarisoperatingsystem,thedelimitersaroundnamesorlabels aresinglequotationmarks (‘’).TheUNIXversionsofthepreviousexamples areasfollows:

-c ‘set storageSubsystem userLabel=“Engineering”;’ -n “My”_StorageSubsystem

InaWindowsoperatingsystem,if youdonotusedoublequotationmarks(“ ”)arounda name,you mustinsert acaret(^)beforeeachspecial scriptcharacter.Specialcharactersare^,|,<,and>. Insertacaretbefore eachspecial scriptcharacterwhenusedwith theterminals-n,-o,-f,and-p.For example,tospecifystorage subsystemCLI>CLIENT,enterthis string:

-nCLI^>CLIENT

Insertonecaret(^)beforeeachspecialscript characterwhenusedwithin astringliteralina script command.Forexample,tochangethenameofastorage subsystemtoFINANCE_|_PAYROLL, enterthe followingstring:

Detailed

Error

Reporting

ErrordatacollectedfromanerrorencounteredbytheCLIiswritten toafile.Detailederrorreporting undertheCLIworksasfollows:

v IftheCLImust abnormallyendrunningCLIcommandsandscriptcommands,errordataiscollected andsavedbeforetheCLIfinishes.

v TheCLIsavestheerrordatabywritingthedatatoa standardfilename.

v TheCLIautomaticallysavesthedatatoafile.Specialcommandlineoptionsarenotrequiredtosave theerrordata.

v Youarenotrequiredtoperform anyactiontosave theerrordatatoa file.

v TheCLIdoesnothaveanyprovisiontoavoidover-writing anexistingversionofthefilethatcontains errordata.

Forerrorprocessing,errors appearastwotypes: v Terminalerrorsorsyntax errorsthatyoumight enter v Exceptionsthatoccurasa resultofanoperationalerror

WhentheCLIencounterseithertypeoferror, theCLIwritesinformationthatdescribestheerrordirectly tothecommandlineandsetsareturn code.Depending onthereturncode,theCLIalsomight write additionalinformationaboutwhichterminal causedtheerror.The CLIalso writesinformationabout whatit wasexpectinginthecommandsyntax tohelpyouidentifyanysyntaxerrorsthatyoumighthave entered.

Whenanexceptionoccurswhilea commandisrunning,theCLIcapturestheerror.Attheendof processingthecommand(afterthecommandprocessinginformationhasbeenwrittentothecommand line),theCLIautomaticallysavestheerrorinformationtoa file.

Thenameofthefiletowhicherrorinformationissavedisexcprpt.txt.TheCLItriestoplacethe

excprpt.txtfileinthedirectorythatisspecifiedbythesystemproperty devmgr.datadir.Ifforanyreason theCLIcannotplacethefileinthedirectoryspecifiedbydevmgr.datadir,theCLIsavestheexcprpt.txt fileinthesame directoryfromwhichtheCLIisrunning.Youcannotchangethefilenameorthelocation. Theexcprpt.txtfileisoverwritteneverytimethatan exceptionoccurs. Ifyouwanttosavethe

informationintheexcprpt.txtfile,youmust copytheinformationtoa newfileora newdirectory. Note: InWindows,thisisspecifiedbytheregistrykey:

HKLM\SOFTWARE\storage\SMclient\SunJVMOption1

Ina typicalinstallationwithnochanges inthedefault installationdirectory,thelocationis: v Windowsoperatingsystems:c:\Program Files\IBM_DS....\client\data

v UNIX-basedoperatingsystems:/var/opt/SM

Exit

Status

Thefollowingtableliststheexitstatusesthatmight bereturnedandthemeaningofeachstatus. Table3.ExitStatus

StatusValue Meaning

0 Thecommandterminatedwithoutanerror.

1 Thecommandterminatedwithanerror.Informationabouttheerroralso appears.

2 Thescriptfiledoesnotexist.

Table3.ExitStatus (continued)

StatusValue Meaning

4 Astoragesubsystemwasnotatthespecifiedaddress. 5 Addressesspecifydifferentstoragesubsystems.

6 Astoragesubsystemnamedoesnotexistforthehostagentthatis connected.

7 Thestoragesubsystemnamewasnotatthespecifiedaddress. 8 Thestoragesubsystemnamewasnotintheconfigurationfile. 10 Amanagementclassdoesnotexistforthestoragesubsystem. 11 Astoragesubsystemwasnotfoundintheconfigurationfile. 12 Aninternalerroroccurred.

13 Invalidscriptsyntaxwasfound.

14 Thecontrollerwasunabletocommunicatewiththestoragesubsystem. 15 Aduplicateargumentwasentered.

16 Anexecutionerroroccurred.

17 Ahostwasnotatthespecifiedaddress. 18 TheWWIDwasnotintheconfigurationfile. 19 TheWWIDwasnotattheaddress.

20 AnunknownIPaddresswasspecified.

21 TheEventMonitorconfigurationfilewascorrupted.

22 ThestoragesubsystemwasunabletocommunicatewithEventMonitor. 23 Thecontrollerwasunabletowritealertsettings.

24 Thewrongorganizernodewasspecified. 25 Thecommandwasnotavailable.

26 Thedevicewasnotintheconfigurationfile.

27 Anerroroccurredwhileupdatingtheconfigurationfile. 28 Anunknownhosterroroccurred.

29 Thesendercontactinformationfilewasnotfound. 30 Thesendercontactinformationfilecouldnotberead. 31

Theuserdata.txtfileexists.

32 Aninvalid-Ivalueintheemailalertnotificationwasspecified. 33 Aninvalid-fvalueintheemailalertnotificationwasspecified.

Usage

Examples

ThefollowingexamplesshowhowtoenterCLIcommandsonacommandline.Theexamplesshowthe syntax,theform,and,insomeexamples,scriptcommands.Examplesareshown forboththeWindows operatingsystemandtheUNIXoperatingsystem.Notethattheusage forthe-cterminalvaries dependingonyour operatingsystem.OnWindows operatingsystems,enclosethescriptcommand followingthe-cterminalindoublequotationmarks (“”).On UNIXoperatingsystems,enclosethescript commandfollowingthe-cterminalinsinglequotationmarks(‘’).(For descriptionsofthescript

Thisexampleshowshow tochangethenameofa storagesubsystem.Theoriginalnameofthestorage subsystemisPayroll_Subsystem.Thenew nameisFinance_Subsystem.Thestoragesubsystemis managedin-bandthroughthehostnameICTSANT.

v Windowsoperatingsystem:

SMcliICTSANT-n“Payroll_Subsystem”-c“setstorageSubsystemuserLabel=\“Finance_Subsystem\”;” v UNIXoperatingsystem:

SMcliICTSANT-n‘Payroll_Subsystem’-c‘setstorageSubsystemuserLabel=“Finance_Subsystem”;’ Thisexampleshowshow todeleteanexistinglogicaldriveand createanew logicaldriveona storage subsystem.TheexistinglogicaldrivenameisStocks_<_Bonds.ThenewlogicaldrivenameisFinance. Thecontrollerhostnamesarefinance1andfinance2.Thestoragesubsystemisprotected,requiringthe passwordTestSubsystem.

v Windowsoperatingsystem:

SMclifinance1finance2-c‘setsessionpassword=\”TestSubsystem\”;deletelogicalDrive [\”Stocks_^<_Bonds\”];createlogicalDrivedriveCount[3]RAIDLEVEL=3capacity=10GB userLabel=\”Finance\”;showstorageSubsystemhealthStatus;”

v UNIXoperatingsystem:

SMclifinance1finance2-c‘setsessionpassword=“TestSubsystem”;deletelogicalDrive [“Stocks_<Bonds”];createlogicalDrivedriveCount[3]RAIDLEVEL=3capacity=10GB userLabel=“Finance”;showstorageSubsystemhealthStatus;’

Thisexampleshowshow toruncommandsina scriptfilenamedscriptfile.scr ona storagesubsystem namedExample.The-eterminal causesthefiletorunwithoutcheckingthesyntax.Runningascriptfile withoutcheckingthesyntaxletsthefilerunmorequickly;however,thefilemightnotruncorrectly becausethesyntaxfora commandmight beincorrect.

SMcli-nExample-fscriptfile.scr-e

Thisexampleshowshow toruncommandsina scriptfilenamedscriptfile.scr ona storagesubsystem namedExample.Inthisexample,thestoragesubsystemisprotectedbythepasswordMySubsystem. Output,asaresult ofcommandsinthescriptfile,goestofileoutput.txt.

v Windowsoperatingsystem:

SMcli-nExample-fscriptfile.scr-p“My_Subsystem”-ooutput.txt v UNIXoperatingsystem:

SMcli-nExample-fscriptfile.scr-p‘My_Subsystem’-ooutput.txt

Thisexampleshowshow toshowallofthestoragesubsystemsinthecurrentconfiguration.The commandinthis examplereturnsthehostnameofeachstoragesubsystem.

SMcli-d

IfyouwanttoknowtheIPaddressofeachstorage subsystemintheconfiguration, addthe-i terminalto thecommand.

Chapter

2.

About

the

Script

Commands

Youcanusethescriptcommandstoconfigureandmanagea storagesubsystem.Youcanenterindividual scriptcommands,oryoucanruna fileofscriptcommands.

ToinvoketheStorageManager Command-LineInterface(SMcli), usetheSMclicommand.

Note: Whenyouenteranindividual scriptcommand,youincludeitaspartofa SMclicommand. When yourunafileofscriptcommands,youinclude thefilenameaspartofa SMclicommand.

Thescriptcommandsareprocessedbya scriptenginethatperformsthefollowingfunctions: v Verifiesthecommandsyntax

v Interpretsthecommands

v Convertsthecommandstotheappropriateprotocol-compliantcommands v Passesthecommandstothestoragesubsystem

Atthestoragesubsystemlevel,thestoragesubsystemcontrollers runscriptcommands. Thescriptengineand thescript commandssupport thestorage subsystemconfigurationand managementoperationsthatarelisted inthefollowingtable:

Table4.ConfigurationandManagementOperations

Operation Activities

Cacheconfiguration Controllingallcacheparameters,bothatthestoragesubsystemleveland theindividuallogicaldrivelevel

Logicaldrive

configurationandarray configuration

Creating,deleting,andsettingthereconstructionprioritycontrol; labeling;settingdrivecompositionwhencreatinglogicaldrives;setting thesegmentsize;andsettingthemediascancontrol

Diskdriveconfiguration Assigninghotspares

Controllerconfiguration Defininglogicaldriveownership,changingmodesettings,defining networksettings,andsettinghostchannelIDs

Generalstoragesubsystem configuration

Resettingaconfigurationtodefaults,labeling,checkingthehealthstatus, settingthetimeofday,clearingtheEventLog,andsettingthemedia scanrate

NVSRAMconfiguration Downloadingandmodifyingtheuserconfigurationregionatthebit levelandthebytelevel,showingnonvolatilestaticrandomaccess memory(NVSRAM)values

Productidentification Retrievingtheenclosureprofiledisplaydata Batterymanagement Settingthebatteryinstallationdate

Firmwaremanagement Downloadingcontrollerfirmware,theenvironmentalservicesmonitor (ESM)firmware,andthediskdrivefirmware

Script

Command

Structure

Allscriptcommandshavethefollowingstructure: command operand-data (statement-data)

wherecommandidentifies theactiontobeperformed, operand-datarepresentstheobjectsassociatedwith a storagesubsystemthatyouwanttoconfigureormanage,andstatement-dataprovidestheinformation neededtoperform thecommand.

Thesyntaxforoperand-dataisasfollows:

(object-type | allobject-types | [qualifier] (object-type [identifier] {object-type [identifier]} |

object-types [identifier-list]))

Anobjectcanbeidentifiedfourways: objecttype,all parameterprefix,squarebrackets,ora listof identifiers.Useanobjecttypewhenthecommandisnotreferencinga specificobject. Theallparameter prefixmeansallobjectsofthespecifiedtypeinthestoragesubsystem(forexample,allLogicalDrives).To performa commandona specificobject,usesquarebracketstoidentifytheobject(forexample,

logicalDrive[engineering]).Specifyasubsetof objectswith alistofidentifiers insquarebrackets(for example,logicalDrives[salesengineering marketing]).Aqualifierisrequiredif youwanttoinclude additionalinformationtodescribetheobjects.

Thefollowingtableliststheobjecttypeandtheidentifiersthatareassociatedwith eachobjecttype. Table5.ObjectTypesandIdentifiers

ObjectType Identifier controller aorb

drive EnclosureIDandslotID

drivechannel Drivechannelidentifier

host Userlabel

hostchannel Hostchannelidentifier

hostgroup Userlabel

hostport Userlabel

remotemirror Primarylogicaldriveuserlabel

flashcopy Logicaldriveuserlabel

storagesubsystem Notapplicable

enclosure EnclosureID

logicalDrive LogicaldriveuserlabelorlogicaldriveWorld-Wide Identifier(WWID)(setcommandonly)

volumecopy Targetlogicaldriveuserlabeland,optionally,the sourcelogicaldriveuserlabel

array Arraynumber

Statementdataisintheform of:

v Parameter=value(suchasraidLevel=5) v Parameter-name(suchasbatteryInstallDate) v Operation-name(suchasredundancyCheck)

Script

Command

Synopsis

Becauseyoucanusethescriptcommandstodefineandmanage thedifferentaspectsofa storage subsystem(suchashosttopology, diskdriveconfiguration,controllerconfiguration, logicaldrive

definitions,andarraydefinitions),theactualnumberofcommandsisextensive.Thecommands,however, fallintogeneralcategories thatarereusedwhenyouapplythecommandstothedifferentaspectsofa storagesubsystem.Thefollowingtableliststhegeneralformofthescriptcommandsandprovides a definitionofeachcommand.

Table6.GeneralFormoftheScriptCommands

Syntax Description

activate object {statement-data} Setsuptheenvironmentsothatanoperationcantake

placeorperformstheoperationiftheenvironmentis alreadysetupcorrectly.

autoConfigure storageSubsystem {statement-data}

Automaticallycreatesaconfigurationthatisbasedon theparametersthatarespecifiedinthecommand.

check object {statement-data} Startsanoperationtoreportonerrorsintheobject,

whichisasynchronousoperation.

clear object {statement-data} Discardsthecontentsofsomeattributeofanobject.

Thisoperationisdestructiveandcannotbereversed.

create object {statement-data} Createsanobjectofthespecifiedtype. deactivate object {statement-data} Removestheenvironmentforanoperation. delete object Deletesapreviouslycreatedobject.

diagnose object {statement-data} Runsatestandshowstheresults. disable object {statement-data} Preventsafeaturefromoperating.

download object {statement-data} Transfersdatatothestoragesubsystemortothe

hardwarethatisassociatedwiththestoragesubsystem.

enable object {statement-data} Setsafeatureoperate.

recopy object {statement-data} RestartsaVolumeCopyoperationbyusinganexisting

VolumeCopypair.Youcanchangetheparameters beforetheoperationisrestarted.

recover object {statement-data} Re-createsanobjectfromsavedconfigurationdataand

thestatementparameters.(Thiscommandissimilarto thecreatecommand.)

recreate object {statement-data} Restartsaflashcopyoperationbyusinganexisting

flashcopylogicaldrive.Youcanchangetheparameters beforetheoperationisrestarted.

remove object {statement-data} Removesarelationshipfrombetweenobjects. repair object {statement-data} Repairserrorsfoundbythecheckcommand. reset object {statement-data} Returnsthehardwareoranobjecttoaninitialstate. resume object Startsasuspendedoperation.Theoperationstarts

whereitleftoffwhenitwassuspended.

revive object ForcestheobjectfromtheFailedstatetotheOptimal state.Usethiscommandonlyaspartofanerror recoveryprocedure.

save object {statement-data} Writesinformationabouttheobjecttoafile.

set object {statement-data} Changesobjectattributes.Allchangesarecompleted

whenthecommandreturns.

show object {statement-data} Showsinformationabouttheobject.

start object {statement-data} Startsanasynchronousoperation.Youcanstopsome

operationsaftertheyhavestarted.Youcanquerythe progressofsomeoperations.

Table6.GeneralFormoftheScriptCommands (continued)

Syntax Description

suspend object {statement-data} Stopsanoperation.Youcanthenrestartthesuspended

operation,anditcontinuesfromthepointwhereitwas suspended.

Recurring

Syntax

Elements

Recurringsyntaxelementsare ageneralcategoryofvariablesandoptionsthatyoucanuseinoneor morescriptcommands.Therecurringsyntax isusedinthegeneraldefinitionsofthescriptcommands thatarelistedinChapter3,“ScriptCommands,”onpage19

Thefollowingtableliststherecurringsyntaxandthesyntax valuesthatyoucanusewith thesyntax. Note: Acommandstatementappears inamonospacefont. Thestatementvariablesareina monospace italicfont.Options aredescribedseparately,andusuallythechoicesareshown asTRUEorFALSE,asa letter(a),a number(42),oranumber-range(0-99)selection.

Table7.RecurringSyntaxElements

RecurringSyntax SyntaxValue

raid-level (0 | 1 | 3 | 5 | 6)

repository-raid-level (1 | 3 | 5 | 6)

capacity-spec integer-literal[KB | MB | GB | TB | Bytes]

segment-size-spec integer-literal

boolean (TRUE | FALSE)

user-label string-literal

user-label-list user-label {user-label}

create-raid-logicalDrive-attr-value-list create-raid-logicalDrive-attribute-value-pair

{create-raid-logicalDrive-attribute-value-pair}

create-raid-logicalDrive-attribute-value-pair capacity=capacity-spec | owner=(a | b) | cacheReadPrefetch=(TRUE | FALSE) | segmentSize=integer-literal

noncontroller-enclosureID (0-99)

slotID (1-32)

portID (0-127)

drive-spec enclosureID, slotID

drive-spec-list drive-spec {drive-spec}

Table7.RecurringSyntaxElements (continued)

RecurringSyntax SyntaxValue

hex-literal 0xhexadecimal-literal

array-number integer-literal

filename string-literal

error-action (stop | continue)

drive-channel-identifier (1 | 2 | 3 | 4)

drive-channel-identifier-list drive-channel-identifier {drive-channel-identifier}

host-channel-identifier(allcontroller modulesexcepttheDS4800(Models82, 84,88)-seriescontrollermodules)

(a1 | a2 | b1 | b2)

host-channel-identifier(DS4800(Models82, 84,88)-seriescontrollermodulesonly)

(a1 | a2 | a3 | a4) (b1 | b2 | b3 | b4)

drive-type (fibre | SATA | SAS)

feature-identifier (storagePartition2 | storagePartition4 | storagePartition8 | storagePartition16 | storagePartition64 | storagePartition128 | storagepartition256 | storagepartition512 | storagePartitionMax | flashCopy | remoteMirror | volumeCopy)

repository-spec instance-based-repository-spec | count-based-repository-spec

instance-based-repository-spec repositoryRAIDLevel=repository-raid-level

repositoryDrives=(drive-spec-list) [enclosureLossProtect=boolean1

] repositoryArray=array-number

freeCapacityArea=integer-literal2

SpecifyrepositoryRAIDLevelwithrepositoryDrives.Do notspecifytheRAIDlevelorthediskdriveswiththe array.DonotsetenclosureLossProtectwhenyouspecifya array.

count-based-repository-spec repositoryRAIDLevel=repository-raid-level

repositoryDriveCount=integer-literal [driveType=drive-type3 ] [enclosureLossProtect=boolean4 ] wwID string-literal nvsram-offset hex-literal

Table7.RecurringSyntaxElements (continued)

RecurringSyntax SyntaxValue

nvsram-byte-setting nvsram-value-> 0xhexadecimal | integer-literal

nvsram-bit-setting nvsram-mask, nvsram-value-> 0xhexadecimal, 0xhexadecimal | integer-literal

ip-addressforIPv4 Four_periodgroups_″.″ offournumericcharacters(0-9)separatedby

(0255).(0255).(0255).(0255)

ip-addressforIPv6 Eightgroupsoffourhexadecimalcharacters(0-9andA-F) separatedbysemicolon″:″

(02AF):(02AF):(02AF):(02AF): (02AF):(02AF):(02AF):(02AF)

autoconfigure-logicaldrive-attr-value-list autoconfigure-logicaldrive-attr-value-pair

{autoconfigure-logicaldrive-attr-value-pair}

autoconfigure-logicaldrive-attr-value-pair driveType=drive-type 5

| raidLevel=raid-level | arrayWidth=integer-literal | arrayCount= integer-literal | logicalDrivesPerArrayCount=integer-literal 6 | hotSpareCount=integer-literal |

segmentSize=segment-size-spec | cacheReadPrefetch=(TRUE | FALSE)

create-volume-copy-attr-value-list create-volume-copy-attr-value-pair

{create-volume-copy-attr-value-pair}

create-volume-copy-attr-value-pair copyPriority=(highest | high | medium | low | lowest) | targetReadOnlyEnabled=boolean

recover-raid-logicalDrive-attr-value-list recover-raid-logicalDrive-attr-value-pair

{recover-raid-logicalDrive-attr-value-pair}

recover-raid-logicalDrive-attr-value-pair owner=(a | b) | cacheReadPrefetch=(TRUE | FALSE)

cache-flush-modifier-setting immediate, 0, .25, .5, .75, 1, 1.5, 2, 5, 10, 20, 60, 120, 300, 1200, 3600, infinite