HPE 3PAR OS Command Line Interface Reference

HPE 3PAR OS Command Line Interface
Reference
HPE 3PAR OS 3.3.1 MU1
Abstract
This reference describes the HPE 3PAR Command Line Interface (CLI) commands that are
used to administer and maintain the HPE 3PAR StoreServ storage system.
Part Number: QL226-99642
Published: August 2017
©
Copyright 2017 Hewlett Packard Enterprise Development LP
Notices
The information contained herein is subject to change without notice. The only warranties for Hewlett
Packard Enterprise products and services are set forth in the express warranty statements accompanying
such products and services. Nothing herein should be construed as constituting an additional warranty.
Hewlett Packard Enterprise shall not be liable for technical or editorial errors or omissions contained
herein.
Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession,
use, or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer
Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government
under vendor's standard commercial license.
Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard
Enterprise has no control over and is not responsible for information outside the Hewlett Packard
Enterprise website.
Acknowledgments
Intel®, Itanium®, Pentium®, Intel Inside®, and the Intel Inside logo are trademarks of Intel Corporation in
the United States and other countries.
Microsoft® and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the
United States and/or other countries.
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
Java® and Oracle® are registered trademarks of Oracle and/or its affiliates.
UNIX® is a registered trademark of The Open Group.
Contents
CLI Command Syntax and Conventions.............................................14
Syntax and Conventions............................................................................................................. 14
Syntax Rules...............................................................................................................................14
Glob-Style Patterns.....................................................................................................................15
Numbering Formats.................................................................................................................... 16
Object Sets..................................................................................................................................16
Regular Expressions Patterns.................................................................................................... 16
Provisioning.................................................................................................................................17
VV Name Patterns...................................................................................................................... 18
®
Filename Conventions for Windows .........................................................................................19
Typical Command Layout in this Book........................................................................................19
Global Options and Environment Variables................................................................................ 20
Exit Status...................................................................................................................................20
Commands Quick Reference............................................................... 21
Adaptive Flash Cache Commands............................................................................................. 21
Adaptive Optimization (AO) Commands..................................................................................... 21
Certificate Commands.................................................................................................................22
CIM Server Commands...............................................................................................................22
Disk Enclosure Management Commands...................................................................................23
Drive Cage Management................................................................................................. 23
Encryption........................................................................................................................ 23
Physical Disk Management..............................................................................................24
Domain Management Commands.............................................................................................. 24
Dual Sign-on Request Commands............................................................................................. 26
File Access Audit Settings.......................................................................................................... 27
File Persona Commands............................................................................................................ 27
File Persona Antivirus Services........................................................................................28
File Persona Archiving..................................................................................................... 28
File Persona Group Accounts.......................................................................................... 29
File Persona NDMP..........................................................................................................29
File Persona Network Commands....................................................................................30
File Persona Routes.........................................................................................................30
File Persona Snapshots................................................................................................... 31
File Persona User Accounts.............................................................................................32
File Provisioning Group Commands........................................................................................... 32
File Share Commands................................................................................................................ 33
File Store Commands................................................................................................................. 33
Health and Alert Management Commands.................................................................................33
Alerts................................................................................................................................ 34
Events.............................................................................................................................. 34
System Health..................................................................................................................35
Help and Utility Commands........................................................................................................ 35
LDAP Management Commands................................................................................................. 36
Licensing Management Commands........................................................................................... 36
Node Subsystem Management Commands............................................................................... 36
Firmware Versions............................................................................................................36
Node Date Information..................................................................................................... 37
Controller Node Properties...............................................................................................37
Contents
3
Controller Node EEPROM Log........................................................................................ 37
Array and Controller Node Information............................................................................ 38
Network Interface Configuration.......................................................................................38
Port Information................................................................................................................39
Battery Management........................................................................................................40
System Manager.............................................................................................................. 40
Node Rescue....................................................................................................................40
Performance Management Commands...................................................................................... 40
Chunklet Statistics............................................................................................................41
Data Cache Memory Statistics.........................................................................................41
Node CPU Statistics.........................................................................................................41
Logical Disk Statistics.......................................................................................................41
Link Statistics................................................................................................................... 41
Physical Disk Statistics.....................................................................................................42
Port Statistics................................................................................................................... 42
System Tuner................................................................................................................... 42
Dynamic Optimization...................................................................................................... 42
Virtual LUN (Export) Statistics..........................................................................................43
Virtual Volume Statistics...................................................................................................43
Remote Copy Volume Statistics.......................................................................................43
Preserved Data Commands........................................................................................................43
Replication Commands...............................................................................................................43
Physical Copy...................................................................................................................44
Remote Copy................................................................................................................... 44
Virtual Copy......................................................................................................................46
Security Hardening Commands.................................................................................................. 47
SP Credential................................................................................................................... 47
Support Recovery Account Password..............................................................................47
Service Commands.....................................................................................................................47
Disk Enclosure................................................................................................................. 48
Node.................................................................................................................................48
General System Maintenance..........................................................................................49
QoS.................................................................................................................................. 49
Software Version.............................................................................................................. 49
SNMP Agent Commands............................................................................................................50
Sparing Commands.................................................................................................................... 51
SSH Access Commands.............................................................................................................52
SSH Banner Commands.............................................................................................................52
System Reporter Commands......................................................................................................52
Task Management Commands................................................................................................... 56
Task Schedule Commands......................................................................................................... 57
User Management Commands................................................................................................... 57
VASA Provider Server Commands............................................................................................. 59
Virtual File Server Commands.................................................................................................... 59
Virtual File Server Network Configuration........................................................................ 60
Virtual File Server Quota.................................................................................................. 60
Virtual File Server Configuration Backup Commands.................................................................60
Volume Management Commands...............................................................................................60
Common Provisioning Group Management..................................................................... 61
Host Management............................................................................................................61
Logical Disk Management................................................................................................63
Space and Storage Management.................................................................................... 63
Template Management.....................................................................................................64
Virtual Volume Management............................................................................................ 65
Virtual LUN (Export) Management................................................................................... 67
Web Services API (WSAPI) Commands.....................................................................................68
4
Contents
Add Command.......................................................................................69
addsnmpmgr............................................................................................................................... 69
Admit Commands................................................................................. 71
admithw.......................................................................................................................................71
admitpd....................................................................................................................................... 72
admitrcopylink............................................................................................................................. 73
admitrcopytarget......................................................................................................................... 74
admitrcopyvv...............................................................................................................................75
admitvv........................................................................................................................................78
Backup Command.................................................................................80
backupfsconf...............................................................................................................................80
Cancel Command..................................................................................82
canceltask................................................................................................................................... 82
Change Command................................................................................ 83
changedomain............................................................................................................................ 83
Check Commands.................................................................................84
checkhealth.................................................................................................................................84
checkld........................................................................................................................................86
checkpassword........................................................................................................................... 87
checkpd.......................................................................................................................................88
checkport.....................................................................................................................................89
checkrclink.................................................................................................................................. 90
checksnmp..................................................................................................................................92
checkvv....................................................................................................................................... 93
CLI Command........................................................................................96
cli.................................................................................................................................................96
Compact Commands.......................................................................... 100
compactcpg...............................................................................................................................100
compactld..................................................................................................................................101
Control Commands.............................................................................103
controlencryption.......................................................................................................................103
controliscsiport.......................................................................................................................... 105
controlmag................................................................................................................................ 107
controlpd................................................................................................................................... 108
controlport................................................................................................................................. 109
controlrecoveryauth...................................................................................................................117
controlsr.....................................................................................................................................117
Contents
5
Create Commands.............................................................................. 123
createaocfg............................................................................................................................... 123
createcert.................................................................................................................................. 124
createcpg.................................................................................................................................. 126
createdomain............................................................................................................................ 130
createdomainset....................................................................................................................... 131
createflashcache.......................................................................................................................132
createfpg................................................................................................................................... 133
createfsgroup............................................................................................................................ 134
createfshare.............................................................................................................................. 135
createfsip...................................................................................................................................140
createfsnap............................................................................................................................... 141
createfsnetwork.........................................................................................................................142
createfsroute............................................................................................................................. 143
createfstore............................................................................................................................... 144
createfsuser.............................................................................................................................. 145
creategroupsv........................................................................................................................... 146
creategroupvvcopy....................................................................................................................148
createhost................................................................................................................................. 151
createhostset............................................................................................................................ 153
creatercopygroup...................................................................................................................... 155
creatercopytarget...................................................................................................................... 156
createsched.............................................................................................................................. 157
createsnmpuser........................................................................................................................ 160
createspare............................................................................................................................... 161
createsralertcrit......................................................................................................................... 162
createsv.....................................................................................................................................170
createtemplate.......................................................................................................................... 173
createuser................................................................................................................................. 178
createvfs....................................................................................................................................179
createvlun................................................................................................................................. 181
createvv.....................................................................................................................................183
createvvcopy.............................................................................................................................188
createvvset................................................................................................................................192
Dismiss Commands............................................................................194
dismisspd.................................................................................................................................. 194
dismissrcopylink........................................................................................................................194
dismissrcopytarget.................................................................................................................... 195
dismissrcopyvv..........................................................................................................................196
Free Command.................................................................................... 199
freespace.................................................................................................................................. 199
Grow Commands................................................................................ 200
growfpg..................................................................................................................................... 200
growvv.......................................................................................................................................201
Hist Commands...................................................................................202
histch.........................................................................................................................................202
6
Contents
histld..........................................................................................................................................204
histpd.........................................................................................................................................207
histport.......................................................................................................................................211
histrcvv......................................................................................................................................214
histvlun......................................................................................................................................217
histvv.........................................................................................................................................221
Import Commands.............................................................................. 225
importcert.................................................................................................................................. 225
importvv.....................................................................................................................................226
Locate Commands.............................................................................. 230
locatecage.................................................................................................................................230
locatenode................................................................................................................................ 231
locatesys................................................................................................................................... 232
Move Commands................................................................................ 234
movech......................................................................................................................................234
movechtospare......................................................................................................................... 235
movepd..................................................................................................................................... 236
movepdtospare......................................................................................................................... 237
moverelocpd............................................................................................................................. 239
movetodomain.......................................................................................................................... 241
Promote Commands........................................................................... 244
promotegroupsv........................................................................................................................ 244
promotesv................................................................................................................................. 245
promotevvcopy..........................................................................................................................247
Remove Commands............................................................................248
removealert............................................................................................................................... 248
removeaocfg............................................................................................................................. 249
removecert................................................................................................................................ 249
removecorequest...................................................................................................................... 250
removecpg................................................................................................................................ 251
removedomain.......................................................................................................................... 252
removedomainset..................................................................................................................... 253
removeflashcache.....................................................................................................................255
removefpg................................................................................................................................. 255
removefsarchive........................................................................................................................256
removefsgroup.......................................................................................................................... 258
removefshare............................................................................................................................ 259
removefsip.................................................................................................................................260
removefsnap............................................................................................................................. 261
removefsnetwork.......................................................................................................................262
removefsroute........................................................................................................................... 263
removefstore............................................................................................................................. 264
removefsuser............................................................................................................................ 264
removehost............................................................................................................................... 265
removehostset.......................................................................................................................... 267
removeld................................................................................................................................... 268
Contents
7
removercopygroup.................................................................................................................... 269
removercopytarget.................................................................................................................... 271
removesched............................................................................................................................ 271
removesnmpmgr....................................................................................................................... 272
removesnmppw.........................................................................................................................273
removesnmpuser...................................................................................................................... 274
removespare............................................................................................................................. 275
removespcredential...................................................................................................................276
removesralertcrit....................................................................................................................... 276
removesshbanner..................................................................................................................... 277
removesshkey...........................................................................................................................278
removetask................................................................................................................................278
removetemplate........................................................................................................................ 280
removeuser............................................................................................................................... 280
removeuserconn....................................................................................................................... 281
removevfs..................................................................................................................................282
removevlun................................................................................................................................283
removevv...................................................................................................................................285
removevvset..............................................................................................................................287
removewsapisession.................................................................................................................288
Restore Command.............................................................................. 290
restorefsconf............................................................................................................................. 290
Service Commands.............................................................................292
servicecage...............................................................................................................................292
servicehost................................................................................................................................293
servicemag................................................................................................................................295
servicenode...............................................................................................................................299
Set Commands.................................................................................... 301
setalert...................................................................................................................................... 301
setaocfg.................................................................................................................................... 301
setauthparam............................................................................................................................ 303
setbattery.................................................................................................................................. 308
setcage..................................................................................................................................... 309
setcim........................................................................................................................................310
setclienv.................................................................................................................................... 312
setcorequest............................................................................................................................. 313
setcpg........................................................................................................................................314
setdate...................................................................................................................................... 319
setdomain................................................................................................................................. 321
setdomainset.............................................................................................................................322
setflashcache............................................................................................................................ 322
setfpg........................................................................................................................................ 324
setfs...........................................................................................................................................325
setfsarchive...............................................................................................................................333
setfsaudit...................................................................................................................................336
setfsav.......................................................................................................................................340
setfsgroup................................................................................................................................. 344
setfshare................................................................................................................................... 345
setfsip........................................................................................................................................352
setfsndmp..................................................................................................................................352
8
Contents
setfsnetwork..............................................................................................................................355
setfsquota................................................................................................................................. 356
setfsroute.................................................................................................................................. 358
setfstore.................................................................................................................................... 359
setfsuser....................................................................................................................................360
sethost.......................................................................................................................................361
sethostset..................................................................................................................................364
setlicense.................................................................................................................................. 364
setnet........................................................................................................................................ 366
setnode..................................................................................................................................... 369
setpassword..............................................................................................................................371
setpd......................................................................................................................................... 372
setqos........................................................................................................................................373
setrcopygroup........................................................................................................................... 375
setrcopytarget........................................................................................................................... 382
setsched....................................................................................................................................386
setsnmpmgr.............................................................................................................................. 387
setsnmppw................................................................................................................................388
setsralertcrit...............................................................................................................................389
setsshbanner............................................................................................................................ 395
setsshkey.................................................................................................................................. 396
setstatch....................................................................................................................................397
setstatpdch................................................................................................................................398
setsys........................................................................................................................................399
setsysmgr..................................................................................................................................403
settask.......................................................................................................................................405
settemplate............................................................................................................................... 406
setuser...................................................................................................................................... 407
setuseracl..................................................................................................................................408
setvasa......................................................................................................................................409
setvfs.........................................................................................................................................410
setvv.......................................................................................................................................... 411
setvvolsc................................................................................................................................... 414
setvvset.....................................................................................................................................416
setwsapi.................................................................................................................................... 416
Show Commands................................................................................ 418
showalert...................................................................................................................................418
showaocfg.................................................................................................................................419
showauthparam........................................................................................................................ 420
showbattery...............................................................................................................................421
showblock................................................................................................................................. 423
showcage..................................................................................................................................425
showcert....................................................................................................................................429
showcim.................................................................................................................................... 430
showclienv.................................................................................................................................431
showcorequest..........................................................................................................................432
showcpg....................................................................................................................................433
showdate...................................................................................................................................436
showdomain..............................................................................................................................437
showdomainset......................................................................................................................... 438
showeeprom............................................................................................................................. 439
showencryption......................................................................................................................... 440
showeventlog............................................................................................................................ 441
showfirmwaredb........................................................................................................................443
Contents
9
showflashcache........................................................................................................................ 444
showfpg.....................................................................................................................................447
showfs.......................................................................................................................................447
showfsarchive........................................................................................................................... 452
showfsaudit............................................................................................................................... 456
showfsav................................................................................................................................... 458
showfsgroup..............................................................................................................................459
showfshare................................................................................................................................460
showfsip.................................................................................................................................... 462
showfsnap.................................................................................................................................462
showfsnapclean........................................................................................................................ 464
showfsndmp..............................................................................................................................465
showfsnetwork.......................................................................................................................... 466
showfsquota..............................................................................................................................467
showfsroute...............................................................................................................................468
showfstore.................................................................................................................................469
showfsuser................................................................................................................................470
showhost...................................................................................................................................471
showhostset.............................................................................................................................. 472
showinventory........................................................................................................................... 474
showiscsisession.......................................................................................................................475
showld.......................................................................................................................................476
showldch................................................................................................................................... 481
showldmap................................................................................................................................483
showlicense.............................................................................................................................. 483
shownet.....................................................................................................................................484
shownode..................................................................................................................................485
shownodeenv............................................................................................................................489
showpatch.................................................................................................................................490
showpd......................................................................................................................................491
showpdata.................................................................................................................................496
showpdch..................................................................................................................................496
showpdvv.................................................................................................................................. 500
showport....................................................................................................................................502
showportarp.............................................................................................................................. 509
showportdev..............................................................................................................................510
showportisns............................................................................................................................. 513
showportlesb.............................................................................................................................514
showportpel...............................................................................................................................518
showqos....................................................................................................................................519
showrcopy.................................................................................................................................521
showrctransport.........................................................................................................................523
showrole....................................................................................................................................524
showrsv.....................................................................................................................................526
showsched................................................................................................................................ 527
showsnmpmgr...........................................................................................................................529
showsnmppw............................................................................................................................ 529
showsnmpuser..........................................................................................................................530
showspace................................................................................................................................ 531
showspare.................................................................................................................................534
showsr.......................................................................................................................................535
showsralertcrit...........................................................................................................................536
showsshbanner.........................................................................................................................537
showsshkey...............................................................................................................................538
showsys.................................................................................................................................... 539
showsysmgr.............................................................................................................................. 541
showtarget................................................................................................................................ 542
10
Contents
showtask................................................................................................................................... 545
showtemplate............................................................................................................................546
showtoc.....................................................................................................................................547
showtocgen...............................................................................................................................548
showuser...................................................................................................................................548
showuseracl.............................................................................................................................. 550
showuserconn...........................................................................................................................551
showvasa.................................................................................................................................. 552
showversion.............................................................................................................................. 553
showvfs..................................................................................................................................... 554
showvlun................................................................................................................................... 555
showvv...................................................................................................................................... 558
showvvcpg................................................................................................................................ 563
showvvmap............................................................................................................................... 565
showvvolsc................................................................................................................................565
showvvolvm...............................................................................................................................566
showvvpd.................................................................................................................................. 570
showvvset................................................................................................................................. 572
showwsapi.................................................................................................................................574
showwsapisession.................................................................................................................... 575
Shutdown Commands........................................................................ 578
shutdownnode...........................................................................................................................578
shutdownsys............................................................................................................................. 580
System Reporter (SR) Commands.................................................... 583
sraomoves.................................................................................................................................583
srcpgspace................................................................................................................................584
srhistld.......................................................................................................................................587
srhistpd......................................................................................................................................589
srhistport................................................................................................................................... 592
srhistvlun...................................................................................................................................595
srldspace...................................................................................................................................598
srpdspace................................................................................................................................. 601
srrgiodensity..............................................................................................................................604
srstatcache................................................................................................................................606
srstatcmp...................................................................................................................................609
srstatcpu....................................................................................................................................612
srstatfsav...................................................................................................................................614
srstatfsblock.............................................................................................................................. 617
srstatfscpu.................................................................................................................................619
srstatfsfpg..................................................................................................................................622
srstatfsmem...............................................................................................................................624
srstatfsnet..................................................................................................................................626
srstatfsnfs..................................................................................................................................629
srstatfssmb................................................................................................................................632
srstatfssnapshot........................................................................................................................634
srstatiscsi.................................................................................................................................. 636
srstatiscsisession...................................................................................................................... 639
srstatld.......................................................................................................................................642
srstatlink....................................................................................................................................644
srstatpd..................................................................................................................................... 647
srstatport................................................................................................................................... 649
srstatqos....................................................................................................................................652
Contents
11
srstatrcopy.................................................................................................................................655
srstatrcvv...................................................................................................................................658
srstatvlun...................................................................................................................................661
srstatvv......................................................................................................................................664
srsysspace................................................................................................................................ 667
srvvspace..................................................................................................................................669
Start Commands................................................................................. 674
startao....................................................................................................................................... 674
startcim......................................................................................................................................676
startfs........................................................................................................................................ 677
startfsarchive.............................................................................................................................678
startfsav.....................................................................................................................................679
startfsnapclean..........................................................................................................................681
startfsndmp............................................................................................................................... 682
startld........................................................................................................................................ 682
startnoderescue........................................................................................................................ 683
startrcopy.................................................................................................................................. 684
startrcopygroup......................................................................................................................... 684
starttask.....................................................................................................................................686
startvasa....................................................................................................................................686
startvv........................................................................................................................................687
startwsapi..................................................................................................................................688
Stat Commands...................................................................................689
statcache...................................................................................................................................689
statch.........................................................................................................................................693
statcmp......................................................................................................................................697
statcpu.......................................................................................................................................698
statfcoe......................................................................................................................................700
statfs..........................................................................................................................................701
statiscsi..................................................................................................................................... 702
statiscsisession......................................................................................................................... 705
statld..........................................................................................................................................706
statlink.......................................................................................................................................708
statpd........................................................................................................................................ 709
statport...................................................................................................................................... 713
statqos.......................................................................................................................................716
statrcopy....................................................................................................................................719
statrcvv......................................................................................................................................720
statvlun......................................................................................................................................723
statvv.........................................................................................................................................727
Stop Commands..................................................................................731
stopcim......................................................................................................................................731
stopfs.........................................................................................................................................731
stopfsarchive.............................................................................................................................732
stopfsav.....................................................................................................................................734
stopfsnapclean..........................................................................................................................735
stopfsndmp............................................................................................................................... 736
stoprcopy...................................................................................................................................736
stoprcopygroup......................................................................................................................... 737
stopvasa....................................................................................................................................738
12
Contents
stopwsapi.................................................................................................................................. 739
Sync Command................................................................................... 741
syncrcopy..................................................................................................................................741
Tune Commands................................................................................. 743
tunepd....................................................................................................................................... 743
tunesys......................................................................................................................................745
tunevv........................................................................................................................................748
Update Commands............................................................................. 752
updatesnapspace......................................................................................................................752
updatevv................................................................................................................................... 753
Upgrade Commands........................................................................... 755
upgradecage............................................................................................................................. 755
upgradepd.................................................................................................................................756
Wait Command.................................................................................... 758
waittask..................................................................................................................................... 758
Mapping roles and rights................................................................... 759
3PAR_AO Role ........................................................................................................................ 759
3PAR_RM Role ........................................................................................................................ 760
Audit Role................................................................................................................................. 761
Basic_edit Role ........................................................................................................................ 761
Browse Role .............................................................................................................................764
CO Role.................................................................................................................................... 764
Create Role ..............................................................................................................................765
Edit Role ...................................................................................................................................766
Service Role .............................................................................................................................771
Super Role ............................................................................................................................... 774
Command Authorities.........................................................................783
Websites.............................................................................................. 800
Support and other resources.............................................................801
Accessing Hewlett Packard Enterprise Support....................................................................... 801
Accessing updates....................................................................................................................801
Customer self repair..................................................................................................................802
Remote support........................................................................................................................ 802
Warranty information.................................................................................................................802
Regulatory information..............................................................................................................803
Documentation feedback.......................................................................................................... 803
Contents
13
CLI Command Syntax and Conventions
This chapter describes the command syntax for the HPE 3PAR OS CLI commands listed in this
reference. General control commands that do not follow the syntax rules are also listed, as well as globstyle patterns.
Syntax and Conventions
Most CLI commands use the following syntax:
cmd [subcmd] [options [arg]]... [<spec>...][<pattern>...]
The following table lists the syntax elements and provides their meanings:
Table 1: CLI Command Syntax
Element
Meaning
cmd
Specifies an operation to be executed, such as create, move, or show.
subcmd
Specifies a subcommand. Subcommands specify actions for commands to be
executed.
options
Indicates an optional command line element such as histch –rw.
arg
Indicates a specific variable of an option or subcommand. The argument is
often used to identify a specific node, volume, or disk.
spec
Indicates a specifier used with a required command line element such as the
command or option.
|
Specifies that only one of the command specifiers or options separated by
this character can be specified at a time.
{}
Indicates grouped elements. Do not type the braces; type only the information
inside the braces.
[]
Indicates optional elements. Do not type the brackets; type only the
information inside the brackets.
<>
Indicates user-supplied input.
...
Indicates that a specifier or an option can be used more than once in a
command.
Syntax Rules
The command syntax described in the table above obeys the following rules:
•
•
•
14
All command line elements are in lowercase letters, except where indicated in this reference.
Subcommands immediately follow the commands they modify.
Options, as indicated in this guide, are indicated by one or more letters, are preceded by a hyphen,
and are enclosed in brackets (for example: removealert [–a]).
CLI Command Syntax and Conventions
•
•
Options follow subcommands on the command line and precede any specifier.
An argument must directly follow the option or subcommand it is modifying and is required on the
command line, unless otherwise specified (for example: removealert –i <alert_ID>).
Multiple options and arguments on a command line are separated with a space.
Specifiers follow options.
User supplied input is identified by angled brackets (< >).
Unless noted otherwise, valid character formats include alphanumeric characters, periods, dashes,
and underscores. In general, the following length limits are enforced by the 3PAR OS CLI:
•
•
•
•
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
Virtual volume name ≤ 31 characters
Thinly Provisioned Virtual Volume (TPVV) name ≤ 31 characters
Virtual copy names ≤ 31 characters
Logical disk name ≤ 31 characters
Host name ≤ 31 characters
Common Provisioning Group (CPG) name ≤ 31 characters
Template name ≤ 31 characters
Domain name ≤ 31 characters
Snapshot name ≤ 31 characters
User name ≤ 31 characters
System name ≤ 31 characters
Glob-Style Patterns
Several of the commands in this reference allow a pattern to be specified to refine the output of the
commands. The patterns are used to match against a string. Strings are typically names such as host or
virtual volume names. For example, in the showhost host_name|pattern... command, a pattern
can be specified to refine the command output for a string of host names matching the specified pattern.
The pattern specifier, as used in the CLI commands, is specified in the form of a glob-style pattern.
Glob-style matching in the CLI is implemented by Tcl. A glob-style pattern consists of the symbols in the
following table:
Symbol
Explanation of Action
*
Matches any sequence of characters in a string, including a null string.
?
Matches any single character in a string.
[chars]
Matches any character in the set given by chars. A range of chars can be
specified using a dash (–). For example, [a–z] represents all the ASCII
characters from a through z.
\x
Matches the single character x.
The following actions are practical examples of the glob-style pattern in use:
Example
Explanation of Action
*
Shows all names.
[a]*
Matches all names beginning with the letter a.
[a–z]x*
Matches any character a-z in the first character position and "x" in the
second position, followed by any character "*".
Glob-Style Patterns
15
NOTE:
Brackets ([ ]) are significant in Tcl and must be escaped using a backslash (\) or enclosed in braces
({ }). Other characters such as star (*) are significant in most shells and must be escaped or quoted
if running CLI commands from the shell.
Numbering Formats
# clihelp sub,number
sub,number - explain the use of number format in commands.
Integer values may be specified in following formats in CLI commands:
•
•
•
decimal - decimal is base-10 number system and uses the digits 0 to 9.
octal - octal is base-8 number system. It uses the digits 0 to 7. The first character of the operand is 0
(For example: 010).
hexadecimal - hexadecimal is base-16 number system. It uses 0-9 to represent values zero to nine,
and a, A, b, B, c, C, d, D, e, E, f, F to represent values ten to fifteen. The first two characters of the
operand are 0x or 0X (For example: 0x100).
Object Sets
# clihelp sub,objectsets
sub,objectsets - Using object sets with commands.
Object sets provide a convenient method of grouping logically connected objects together. For example
all host members of an ESX cluster could be grouped together into an esxhosts host set, while the
common VVs exported to them might be in a esxexports VV set.
Sets are referred to in commands with the set: prefix. For example, to export the esxexports VV set to the
esxhosts host set you could use: createvlun set:esxexports 1 set:esxhosts which would
export the VVs sequentially from LUN 1 onward to the hosts in the esxhosts set. Any hosts that were later
added to the host set would also automatically be able to see these VVs.
As well as support for host and VV sets, the system currently supports domain sets. Only a host is able to
be a member of a domain set, which allows it to have VVs from all domains that are a member of the
domain set exported to it. This allows VVs under separate administrative control to all be centrally backed
up, for example.
Set members are ordered according to when they were added. This affects VV set exports and when they
are used for createvvcopy.
Not all commands support object sets in their parameters; those that do indicate that they will take a set
parameter in the command description. Examples of commands with set support are: createhost,
createvlun, createsv, createvvcopy, movetodomain, removevlun.
Regular Expressions Patterns
Patterns are specified as regular expressions. The clihelp -sub regexpat command describes
regular expressions in further detail:
sub,regexpat - Using regular expression (regex) pattern matching.
Regular expression patterns are used to match against strings. In the CLI the strings are usually
descriptive text such as help text or event message strings. See the Tcl re_syntax documentation for
detailed help; this information is only a summary.
16
Numbering Formats
Regular expressions are one or more branches separated by |, matching any string that matches any of
the branches.
A branch is zero or more quantified atoms concatenated, and it matches a match for the first quantified
atom, followed by a match of the second quantified atom, and so on. An empty branch matches an empty
string.
A quantified atom is an atom followed by an optional quantifier.
Quantifiers are:
* — 0 or more matches of the atom.
+ — 1 or more matches of the atom.
? — exactly one match of the atom.
{m} — exactly m matches of the atom.
{m,} — m or more matches of the atom.
{m,n} — m through n (inclusive) matches of the atom.
*? +? ?? {m}? {m,}? {m,n}? — Match the same possibilities as above but
prefer the smallest number instead of the largest number of matches.
m and n are unsigned decimal integers from 0 through 255 inclusive.
Atoms are:
(re) — Where re is any regexp, matches a match for re.
() — Matches an empty string.
[chars] — A bracket expression, usually matches a single character in the
list, or if the list begins with ^ matches a single character not in the
list. The chars may be a range specified, for example, as a-z, or 0-9. See
detailed Tcl re_syntax help on bracket expressions.
. — Matches any single character.
\k — Matches the non-alphanumeric character k.
\c — If c is alphanumeric, matches an escape (see Tcl re_syntax help).
{ — When followed by a character other than a digit, matches {, otherwise it
is a quantifier as described above.
x — Without any other significance, matches the character x.
Note that [ and ] are significant in Tcl and must be escaped using \ or enclosed in { }. Other characters,
such as *, are significant in most shells and must be escaped or quoted if running CLI commands from
another shell.
Provisioning
# clihelp sub,provisioning
sub,provisioning - explain how the virtual volume is provisioned.
Each virtual volume has the user space and snapshot space. The user space of the volume can be
provisioned from a CPG. The snapshot space of the volume can also be allocated from a CPG.
For a virtual volume with user space that is provisioned from a CPG, "createvv on page 183", "growvv
on page 201", and "tunevv on page 748" commands should be used to create, grow, and tune the
volume.
To determine whether or not the user space of the virtual volume is provisioned from a CPG, use the
"showvv -cpgalloc" command.
Provisioning
17
The following table displays the type of the virtual volume (it is the "Type" column of "showvv" output) and
its corresponding CLI commands for creating, growing, and tuning:
Snapshot Space
No
Not from a CPG
From a CPG
Base
Base
Base, cpvv
- createvv
- createvv
- createvv
- growvv
- growvv
- growvv
- tunevv
- tunevv
- tunevv
N/A
N/A
Base, tpvv
User Space
Full Provisioned,
from a CPG
Thin Provision
— createvv
- growvv
- tunevv
VV Name Patterns
# clihelp sub,vvnamepat
sub,vvnamepat - patterns supported for VV names.
Some commands allow the use of VV name patterns to indicate the destination virtual volume name(s) for
the command. These patterns are expanded based upon information such as the source virtual volume,
allowing a single pattern string to represent a group of different VVs. The following patterns are
supported:
•
•
@count@—The current count of VVs created.
@vvname@—The name of the current volume being snapshot.
In addition the following date/time related patterns are supported where it makes sense (not when the
destination should already exist, but when we are creating a new volume):
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
18
@a@—Abbreviated weekday name (Mon, Tue, etc.).
@A@—Full weekday name (Monday, Tuesday, etc.).
@b@—Abbreviated month name (Jan, Feb, etc.).
@B@—Full month name.
@C@—First two digits of the four-digit year (19 or 20).
@d@—Day of month (01 - 31).
@e@—Day of month (1 - 31), no leading zeros.
@g@—The ISO8601 year number corresponding to the ISO8601 week (%V), expressed as a two-digit
year-of-the-century, with leading zero if necessary.
@G@—The ISO8601 year number corresponding to the ISO8601 week (%V), expressed as a four-digit
number.
@h@—Abbreviated month name.
@H@—Hour in 24-hour format (00 - 23).
@I@—Hour in 12-hour format (01 - 12).
@j@—Day of year (001 - 366).
@k@—Hour in 24-hour format, without leading zeros (0 - 23).
@l@—Hour in 12-hour format, without leading zeros (1 - 12).
@m@—Month number (01 - 12).
VV Name Patterns
•
•
•
•
•
•
•
•
•
•
•
•
@M@—Minute (00 - 59).
@p@—AM/PM indicator.
@s@—Count of seconds since the epoch, expressed as a decimal integer.
@S@—Seconds (00 - 59).
@u@—Weekday number (Monday = 1, Sunday = 7).
@U@—Week of year (00 - 52), Sunday is the first day of the week.
@V@—Week of year according to ISO-8601 rules. Week 1 of a given year is the week containing 4
January.
@w@—Weekday number (Sunday = 0, Saturday = 6).
@W@—Week of year (00 - 52), Monday is the first day of the week.
@y@—Year without century (00 - 99).
@Y@—Year with century (e.g. 1990).
@Z@—Time zone name.
®
Filename Conventions for Windows
If a filename with an absolute or relative path is typed on the command line, there are no problems with
backslashes:
cli% importcert wsapi -ca C:\certs\ca-bundle.pem
If using the Windows® shell prompt, use:
C:\Users\w_user> importcert wsapi -ca C:\certs\ca-bundle.pem
If a filename is entered for a command using the CLI shell, a Tcl application, then each backslash must be
doubled:
cli% importcert wsapi -ca C:\\certs\\ca-bundle.pem
Or surround the filename with braces:
cli% importcert wsapi -ca {C:\certs\ca-bundle.pem}
Typical Command Layout in this Book
Typical CLI reference pages are formatted in the following order:
COMMAND NAME
The CLI command name is used as the section heading.
DESCRIPTION
The Description section briefly explains the use or purpose of the command.
SYNTAX
The Syntax section lists syntax patterns for the command. See Syntax and Conventions on page 14.
SUBCOMMANDS
The Subcommands section itemizes any subcommands available to the command. It will appear only
when applicable.
AUTHORITY
The Authority section defines the required user access and rights needed to use the command.
Filename Conventions for Windows
®
19
OPTIONS
The Options section lists and describes options you can use in conjunction with the command for varied
results. Some options and their specifiers are required, as indicated in the syntax, whereas some are
provided to increase the level and functionality of your output.
SPECIFIERS
The Specifiers section lists and describes specifiers that control aspects of how the command is
interpreted.
EXAMPLES
The Examples section contains sample commands as they might be issued, with results similar to what
you should expect when running the command with its available options.
NOTES
The Notes section contains other pertinent information that you might need to know about the command.
Global Options and Environment Variables
Several options and environment variables are available at the global level. For complete information
about these, see the HPE 3PAR Command Line Interface Administrator Guide.
Exit Status
Except where noted, the following codes are returned indicating success or failure for each individual
command:
•
•
•
0 indicates that the command was successful.
1 indicates that the command failed.
10 indicates that the command is failed but it can be retried.
Exit status 10 is only returned when the -enherror option or TPDCLIENHERROR environment variable
is used. See the cli on page 96 command.
NOTE:
These exit status codes only indicate the execution status of the command itself. The results of
individual CLI commands should be determined from the command output.
20
Global Options and Environment Variables
Commands Quick Reference
The HPE 3PAR Command Line Interface provides a host of commands allowing you to administer your
3PAR storage system. To aid your navigation through this manual, this section provides an overview of
the commands grouped by functionality.
Adaptive Flash Cache Commands
Command
Description
Authority
For Details See
createflashcache
Creates flash cache for
the cluster.
Super, Edit
createflashcache on
page 132
Remove flash cache
from the cluster.
Super, Edit
Sets the flash cache
policy for virtual
volumes.
Super, Edit
showflashcache
Shows either the status
of the flash cache per
node, or flash cache
policy for virtual
volumes.
Any role in the system.
statcache
Show the flash cache
Any role in the system.
and data cache statistics
in a timed loop.
removeflashcache
setflashcache
Any role granted the
flashcache_create
right.
Any role granted the
flashcache_remove
right.
Any role granted the
flashcache_set right.
removeflashcache on
page 255
setflashcache on page
322
showflashcache on
page 444
statcache on page 689
Adaptive Optimization (AO) Commands
Command
Description
Authority
For Details See
createaocfg
Creates an AO
configuration.
Super, Edit
createaocfg on page
123
removeaocfg
Removes specified AO
configurations from the
system.
Super, Edit
removeaocfg on page
249
Table Continued
Commands Quick Reference
21
Command
Description
Authority
For Details See
setaocfg
Updates an AO
configuration.
Super, Service, Edit
setaocfg on page 301
showaocfg
Shows AO
configurations in the
system.
Any role in the system.
showaocfg on page
419
Authority
For Details See
Certificate Commands
Command
Description
createcert
Create self-signed SSL Super
certificate or a certificate
signing request (CSR)
for the 3PAR Storage
System SSL services.
createcert on page 124
showcert
Show information about
SSL certificates of the
3PAR Storage System.
Any role in the system.
showcert on page 429
importcert
Imports certificates for a
given service.
Super
importcert on page
225
removecert
Removes certificates
that are no longer
trusted.
Super
removecert on page
249
Authority
For Details See
CIM Server Commands
Command
Description
setcim
Sets the properties of
Super, Service 1
the CIM server,
Any role granted the
including options to
cim_set right.
enable or disable the
SLP, HTTP and HTTPS
ports for the CIM server.
setcim on page 310
showcim
Displays the CIM server
setting information and
status.
Any role in the system.
showcim on page 430
startcim
Starts the CIM server to
service CIM requests.
Super, Service1
startcim on page 676
Any role granted the
cim_start right.
Table Continued
22
Certificate Commands
Command
Description
Authority
For Details See
stopcim
Stops the CIM server
from servicing CIM
requests.
Super, Service1
stopcim on page 731
1
Any role granted the
cim_stop right.
You must have access to all domains to run this command.
Disk Enclosure Management Commands
Drive Cage Management
Command
Description
Authority
For Details See
locatecage
Locates a particular
drive cage.
Super, Service1
locatecage on page
230
setcage
showcage
1
Sets parameters for a
drive cage.
Displays drive cage
information.
Any role granted the
cage_locate right.
Super, Service1
setcage on page 309
Any role granted the
cage_set right.
Any role in the system.
showcage on page 425
You must have access to all domains to run this command.
Encryption
Command
Description
Authority
For Details See
controlencryption
Controls data
encryption.
Super
controlencryption on
page 103
Any role granted the
encryption_control
right.
Super, Service (for
status subcommand
only).
Any role granted the
encryption_status
right.
showencryption
Shows data encryption.
Super, Service
Any role granted the
control_encryption
_status right.
showencryption on
page 440
Disk Enclosure Management Commands
23
Physical Disk Management
Command
Description
Authority
For Details See
admitpd
Admits one or all
physical disks to enable
their use.
Super, Service1
admitpd on page 72
Executes surface scans
on physical disks.
Super, Service1
checkpd
controlpd
dismisspd
movepd
Spins physical disks up
or down.
Dismisses one or more
physical disks from use.
Any role granted the
pd_admit right.
checkpd on page 88
Any role granted the
pd_check right.
Super, Service1
controlpd on page 108
Any role granted the
pd_control right.
Super, Service1
Any role granted the
pd_dismiss right.
dismisspd on page
194
Moves data from
specified Physical Disks
to a temporary location
selected by the system.
Super, Service, Edit
setpd
Marks physical disks as
allocatable for logical
disks.
Super, Service1
setpd on page 372
showpd
Displays physical disks
in the system.
Any role in the system.
showpd on page 491
1
movepd on page 236
Any role granted the
pd_move right.
You must have access to all domains to run this command.
Domain Management Commands
Command
Description
Authority
For Details See
changedomain
Changes the
currentdomain CLI
environment parameter.
Any role in the system.
changedomain on page
83
createdomain
Shows a list of domains
on the system.
Super1
createdomain on page
130
Any role granted the
domain_create right.
Table Continued
24
Physical Disk Management
Command
Description
Authority
For Details See
createdomainset
Defines a new set of
domains and provides
the option of assigning
one or more domains to
that set.
Super
createdomainset on
page 131
Any role granted the
domainset_create
right can create a
domain set.
Any role granted the
domainset_set right
can add domains to a
domain set.
movetodomain
Moves objects from one
domain to another.
Super, Edit1
Any role granted the
domain_moveto right.
movetodomain on
page 241
removedomain
Removes an existing
Super1
domain from the system.
Any role granted the
domain_remove right.
removedomain on
page 252
removedomainset
Removes a domain set
or removes domains
from an existing set.
removedomainset on
page 253
Super, Edit
Any role granted the
domainset_remove
right can remove a
domain set or domains
from a domain set.
setdomain
Sets the parameters and Super1
modifies the properties
Any role granted the
of a domain.
domain_set right.
setdomain on page
321
setdomainset
Sets the parameters and Super, Edit
modifies the properties
Any role granted the
of a domain set.
domainset_set right.
setdomainset on page
322
showdomain
Displays the list of
domains on a system.
Any role in the system.
showdomain on page
437
showdomainset
Displays the domain
sets defined on the
3PAR Storage System
and their members.
Any role in the system.
showdomainset on
page 438
1
You must have access to all domains to run this command.
Commands Quick Reference
25
Dual Sign-on Request Commands
Command
Description
Authority
For Details See
removecorequest
Removes rejected,
cancelled, or executed
dual sign-on requests.
CO
removecorequest
Approve or deny a
pending dual sign-on
command approval
request, modify the
queue size, execute an
approved request, or
cancel a pending
request.
CO, any role granted the setcorequest
corequest_set right
to approve/deny a
request or modify the
max queue size.
Displays status of CO
approval requests or
queue size.
CO, super and
command requester.
setcorequest
showcorequest
Any role granted the
corequest_remove
right.
Any role granted the
cotask_set right to
execute or cancel a
request.
CO and super user can
view all the requests in
queue while other users
can see only their own
requests.
Any user can view the
queuesize.
26
Dual Sign-on Request Commands
showcorequest
File Access Audit Settings
Command
Description
Authority
For Details See
setfsaudit
Set File Access Audit
settings.
Super, Edit
setfsaudit
Display File Access
Audit settings.
Any role in the system.
showfsaudit
Any role granted
fsaudit_set right.
showfsaudit
The showfsaudit
log -export
command requires Edit
role to access .admin
directory.
The showfsaudit
log -export -file
<client_filepath>
and showfsaudit
protobuf -export
can be executed by
Super role only.
File Persona Commands
Command
Description
Authority
For Details See
setfs
Update global File
Persona Settings
Super
setfs on page 325
showfs
Show information of a
File Persona cluster.
Any role in the system.
showfs on page 447
startfs
Initialize and start File
Persona on the system.
Super, Service
startfs on page 677
statfs
Show statistics for File
Persona.
Any role in the system.
statfs on page 701
stopfs
Stop or remove File
Persona.
Super, Service
stopfs on page 731
Any role granted the
fs_set right.
Any role granted the
fs_start right.
File Access Audit Settings
27
File Persona Antivirus Services
Command
Description
Authority
For Details See
setfsav
Set antivirus properties
for File Persona.
Super, Edit
setfsav on page 340
showfsav
Show antivirus
properties for File
Persona.
Any role in the system.
startfsav
Start antivirus service or Super, Edit
scan for File Persona.
Any role granted the
fsav_start right.
startfsav on page 679
stopfsav
Stop the antivirus
service or stop/pause a
scan.
Super, Edit
stopfsav on page 734
Command
Description
Authority
For Details See
removefsarchive
Deletes the WORM/
WORM-retained file(s),
removes the retention
period or deletes
retention validation scan
on the fstore.
Super, Edit1
removefsarchive
Set or modify archiving
properties for File
Persona.
Super, Edit1
Any role granted the
fsav_set right.
showfsav on page 458
Any role granted the
fsav_stop right.
File Persona Archiving
setfsarchive
Any role granted the
fsarchive_remove
right.
Super for -importfile
<source_path>.
setfsarchive
Any role granted the
fsarchive_set right.
Super for -importfile
<source_path>.
showfsarchive
Displays policy setting,
retention setting and
status of validation
scans.
Any role in the system1.
showfsarchive
The export
subcommand, as well as
the -importfile
<source_path> and
the -export
<target_path>
options can be
accessed only by users
with Super role.
Table Continued
28
File Persona Antivirus Services
Command
Description
Authority
For Details See
startfsarchive
Starts or resumes
validation jobs.
Super, Service1
startfsarchive
stopfsarchive
1
Stops or pauses data
validation jobs.
Any role granted the
fsarchive_start
right.
Super, Service1
stopfsarchive
Any role granted the
fsarchive_stop right.
You must have access to all domains to run this command.
File Persona Group Accounts
Command
Description
Authority
For Details See
createfsgroup
Create a local group
account associated with
File Persona.
Super
createfsgroup on page
134
showfsgroup
Show local group
information associated
with File Persona.
Any role in the system.
showfsgroup on page
459
removefsgroup
Remove a local group
account associated with
File Persona.
Super
removefsgroup on
page 258
Modify a local group
account associated with
File Persona.
Super
Command
Description
Authority
setfsndmp
Set NDMP properties for Super, Edit
File Persona.
Any role granted the
fsndmp_set right.
setfsndmp on page
352
showfsndmp
Show NDMP properties
for File Persona.
showfsndmp on page
465
setfsgroup
Any role granted the
fsgroup_create right.
Any role granted the
fsgroup_remove right.
Any role granted the
fsgroup_set right.
setfsgroup on page
344
File Persona NDMP
For Details See
Any role in the system.
Table Continued
File Persona Group Accounts
29
Command
Description
Authority
For Details See
startfsndmp
Start NDMP and ISCSI
service.
Super, Edit
startfsndmp on page
682
Stop NDMP and ISCSI
service.
Super, Edit
stopfsndmp
Any role granted the
fsndmp_start right.
Any role granted the
fsndmp_stop right.
stopfsndmp on page
736
File Persona Network Commands
Command
Description
Authority
For Details See
createfsnetwork
Configures multiple
networks by creating
new network.
Super
createfsnetwork
Removes the given
network.
Super
Modifies parameters for
multiple networks.
Super
Displays multiple
networks configuration.
Any role in the system.
showfsnetwork
Command
Description
Authority
For Details See
createfsroute
Create a route for a
target address with a
gateway.
Edit
createfsroute on page
143
Removes an existing
route for a target
address.
Edit
removefsnetwork
setfsnetwork
showfsnetwork
Any role granted
fsnetwork_create
right.
removefsnetwork
Any role granted
fsnetwork_remove
right.
setfsnetwork
Any role granted
fsnetwork_set right.
File Persona Routes
removefsroute
Any role granted the
fsroute_set right.
Any role granted the
fsroute_set right.
removefsroute on page
263
Table Continued
30
File Persona Network Commands
Command
Description
Authority
For Details See
setfsroute
Modifies an existing
route for a target
address.
Edit
setfsroute on page 358
Displays routes for
target addresses.
Any role in the system
showfsroute on page
468
showfsroute
Any role granted the
fsroute_set right.
File Persona Snapshots
Command
Description
Authority
For Details See
createfsnap
Create a snapshot for
File Persona.
Super, Edit
createfsnap on page
141
Remove file store
snapshots from File
Persona.
Super, Edit
showfsnap
Show snapshot
information for File
Persona.
Any role in the system.
showfsnap on page
462
showfsnapclean
Show details of an ondemand snapshot
reclamation task.
Any role in the system.
showfsnapclean on
page 464
startfsnapclean
Start or resume an ondemand snapshot
reclamation task.
Super, Service
startfsnapclean on
page 681
Stop or pause an ondemand snapshot
reclamation task.
Super, Service
removefsnap
stopfsnapclean
Any role granted the
fsnap_create right.
Any role granted the
fsnap_remove right.
Any role granted the
fsnapclean_start
right.
Any role granted the
fsnapclean_stop
right.
removefsnap on page
261
stopfsnapclean on
page 735
File Persona Snapshots
31
File Persona User Accounts
Command
Description
Authority
For Details See
createfsuser
Create a local user
account associated with
File Persona.
Super
createfsuser on page
145
Remove a local user
account associated with
File Persona.
Super
Modify a local user
account associated with
File Persona.
Super
Show local user
information associated
with File Persona.
Any role in the system.
removefsuser
setfsuser
showfsuser
Any role granted the
fsuser_create right.
Any role granted the
fsuser_remove right.
removefsuser on page
264
setfsuser on page 360
Any role granted the
fsuser_set right.
showfsuser on page
470
File Provisioning Group Commands
Command
Description
Authority
For Details See
createfpg
Create a file
provisioning group.
Super, Edit
createfpg on page 133
Grow a file provisioning
group.
Super, Edit
Remove a file
provisioning group.
Super, Edit
growfpg
removefpg
32
Any role granted the
fpg_create right.
growfpg on page 200
Any role granted the
fpg_grow right.
Any role granted the
fpg_remove right.
removefpg on page
255
setfpg
Modify the properties of Super, Edit
a file provisioning group.
Any role granted the
fpg_set right.
setfpg on page 324
showfpg
Show file provisioning
group information.
showfpg on page 447
File Persona User Accounts
Any role in the system.
File Share Commands
Command
Description
Authority
For Details See
createfshare
Create a file share.
Super, Edit
createfshare on page
135
Any role granted the
fshare_create right.
removefshare
setfshare
showfshare
Remove a file share
from a File Persona
cluster.
Super, Edit
Modify the properties of
a file share.
Super, Edit
Show file share
information.
Any role in the system.
showfshare on page
460
Any role granted the
fshare_remove right.
removefshare on page
259
setfshare on page 345
Any role granted the
fshare_set right.
File Store Commands
Command
Description
Authority
For Details See
createfstore
Create a file store.
Super, Edit
createfstore on page
144
Any role granted the
fstore_create right.
removefstore
Remove a file store.
Super, Edit
Any role granted the
fstore_remove right.
setfstore
showfstore
Modify the properties of
a file store.
Super, Edit
Show file store
information.
Any role in the system.
removefstore on page
264
setfstore on page 359
Any role granted the
fstore_set right.
showfstore on page
469
Health and Alert Management Commands
File Share Commands
33
Alerts
Command
Description
Authority
For Details See
removealert
Removes one or more
alerts.
Super, Service1
removealert on page
248
Sets the status of
system alerts.
Super, Service1
setalert
showalert
1
Displays system alerts.
Any role granted the
alert_remove right.
setalert on page 301
Any role granted the
alert_set right.
Any role in the system.
showalert on page 418
You must have access to all domains to run this command.
Alert Severity Levels
Table 2: Alert Severity Levels
Severity
Description
Fatal
A fatal event has occurred. It is no longer possible to take remedial action.
Critical
The event is critical and requires immediate action.
Major
The event requires immediate action.
Minor
An event has occurred that requires action, but the situation is not yet serious.
Degraded
An aspect of performance or availability may have become degraded. You must decide
if action is necessary.
Informational
The event is informational. No action is required other than acknowledging or
removing the alert.
Events
34
Command
Description
Authority
For Details See
showeventlog
Displays event logs.
Any role in the system.
showeventlog on page
441
Alerts
System Health
Command
Description
Authority
For Details See
checkhealth
Displays the status of
the system hardware
and software
components.
Super, Service
checkhealth on page
84
Any role granted the
health_check right.
Help and Utility Commands
Command
Description
Authority
cli
Provides a means to set Super, Service, Edit,
up your CLI session or to Browse
enter directly into a CLI
shell.
clihelp
Lists all commands or
details for a specified
command.
Super, Service, Edit,
Browse
cmore
Pages the output of
commands.
Super, Service, Edit,
Browse
help
Lists all commands or
details for a specified
command.
Super, Service, Edit,
Browse
setclienv
Sets the CLI
Super, Service, Edit,
environment parameters. Browse
For Details See
cli on page 96
setclienv on page 312
Any role granted the
clienv_set right.
showclienv
Displays the CLI
Any role in the system.
environment parameters.
showclienv on page
431
System Health
35
LDAP Management Commands
Command
Description
Authority
For Details See
setauthparam
Sets the authentication
parameters.
Super
setauthparam on page
303
showauthparam
Shows authentication
parameters and
integrates the
authentication and
authorization features
using LDAP.
Any role in the system.
showauthparam on
page 420
checkpassword
Supports authentication
and authorization using
LDAP.
Super, Service, Edit,
Browse
checkpassword on
page 87
Any role granted the
authparam_set right.
Any role granted the
password_checkany
right can check the
password of any user.
Any role granted the
password_checkown
right can only check
their own password.
Licensing Management Commands
Command
Description
Authority
For Details See
setlicense
Sets the license key.
Super, Service1
setlicense on page 364
Any role granted the
license_set right.
showlicense
1
Displays the installed
license info or key.
Any role in the system.
showlicense on page
483
You must have access to all domains to run this command.
Node Subsystem Management Commands
Firmware Versions
36
Command
Description
Authority
For Details See
showfirmwaredb
Displays a current
database of firmware
levels.
Any role in the system.
showfirmwaredb on
page 443
LDAP Management Commands
Node Date Information
Command
Description
Authority
For Details See
setdate
Sets the system time
and date on all nodes.
Super, Service1
setdate on page 319
Displays the date and
time on all system
nodes.
Any role in the system.
showdate
1
Any role granted the
date_set right.
showdate on page 436
You must have access to all domains to run this command.
Controller Node Properties
Command
Description
Authority
For Details See
setnode
Sets the properties of
the node components
such as the serial
number of the power
supply.
Super, Service1
setnode on page 369
Any role granted the
node_set right.
shownode
Displays an overview of
the node specific
properties.
Any role in the system.
shownode on page
485
shownodeenv
Displays the node's
environmental status.
Any role in the system.
shownodeenv on page
489
1
You must have access to all domains to run this command.
Controller Node EEPROM Log
Command
Description
Authority
showeeprom
Displays node EEPROM Any role in the system.
information.
For Details See
showeeprom on page
439
Node Date Information
37
Array and Controller Node Information
Command
Description
Authority
For Details See
locatenode
Locates a particular
node component by
blinking LEDs on the
node.
Super, Service1
locatenode on page
231
locatesys
Locates a system by
blinking its LEDs.
Any role granted the
node_locate right.
Super, Service1
locatesys on page 232
Any role granted the
sys_locate right.
setsys
Enables you to set
Super, Service1
system-wide parameters
Any role granted the
such as the raw space
sys_set right.
alert.
setsys on page 399
showsys
Displays the 3PAR
Storage System
properties, including
system name, model,
serial number, and
system capacity.
showsys on page 539
1
Any role in the system.
You must have access to all domains to run this command.
Network Interface Configuration
Command
Description
Authority
For Details See
setnet
Sets the administration
network interface
configuration.
Super, Service1
setnet on page 366
shownet
1
38
Any role granted the
net_set right.
Displays the network
Any role in the system.
configuration and status.
You must have access to all domains to run this command.
Array and Controller Node Information
shownet on page 484
Port Information
Command
Description
Authority
For Details See
checkport
Performs a loopback
test on Fibre Channel
ports.
Super, Service1
checkport on page 89
controlport
controliscsiport
Controls Fibre Channel
or Remote Copy ports.
Used to set up the
parameters and
characteristics of an
iSCSI port.
Any role granted the
port_check right.
Super, Service1
Any role granted the
port_control right.
Super, Service1
Any role granted the
port_control right.
controlport on page
109
controliscsiport on
page 105
showiscsisession
Shows the iSCSI active
sessions per port.
Any role in the system.
showiscsisession on
page 475
showport
Displays system port
information.
Any role in the system.
showport on page 502
showportarp
Shows the ARP table for Any role in the system.
iSCSI ports in the
system.
showportarp on page
509
showportdev
Displays detailed
information about
devices on a Fibre
Channel port.
Any role in the system.
showportdev on page
510
showportisns
Show iSNS host
information for iSCSI
ports in the system.
Any role in the system.
showportisns on page
513
showportlesb
Displays Link Error
Any role in the system.
Status Block information
about devices on a Fibre
Channel port.
showportlesb on page
514
showtarget
Displays unrecognized
targets.
Any role in the system.
showtarget on page
542
statiscsi
Displays the iSCSI
statistics.
Any role in the system.
statiscsi on page 702
statiscsisession
Displays the iSCSI
session statistics.
Any role in the system.
statiscsisession on
page 705
1
You must have access to all domains to run this command.
Port Information
39
Battery Management
Command
Description
Authority
For Details See
setbattery
Sets battery properties.
Super, Service1
setbattery on page 308
Any role granted the
battery_set right.
showbattery
1
Displays battery status
information.
Any role in the system.
showbattery on page
421
You must have access to all domains to run this command.
System Manager
Command
Description
Authority
For Details See
setsysmgr
Sets the system
manager startup state.
Super1
setsysmgr on page
403
Any role granted the
sysmgr_set right.
showsysmgr
Displays the system
manager startup state.
Any role in the system.
showsysmgr on page
541
showtoc
Displays the system
table of contents
summary.
Any role in the system.
showtoc on page 547
showtocgen
Displays the system
table of contents
generation number.
Any role in the system.
showtocgen on page
548
1
You must have access to all domains to run this command.
Node Rescue
Command
Description
Authority
startnoderescue
Initiates a node rescue, Super, Service
which initializes the
internal node disk of the
specified node to match
the contents of the other
node disks.
Performance Management Commands
40
Battery Management
For Details See
startnoderescue on
page 683
Chunklet Statistics
Command
Description
Authority
For Details See
histch
Displays histogram data
for individual chunklets.
Any role in the system.
histch on page 202
setstatch
Sets statistics collection
mode on chunklets.
Super, Edit
setstatch on page 397
Sets statistics collection
mode on physical disk
chunklets.
Super, Edit
Displays statistics for
individual chunklets.
Any role in the system.
statch on page 693
setstatpdch
statch
Any role granted the
statch_set right.
Any role granted the
statpdch_set right.
setstatpdch on page
398
Data Cache Memory Statistics
Command
Description
Authority
For Details See
statcmp
Displays statistics for
cache memory pages.
Any role in the system.
statcmp on page 697
Command
Description
Authority
For Details See
statcpu
Displays statistics for
CPU use.
Any role in the system.
statcpu on page 698
Command
Description
Authority
For Details See
histld
Displays histogram data
for logical disks.
Any role in the system.
histld on page 204
statld
Displays statistics for
logical disks.
Any role in the system.
statld on page 706
Command
Description
Authority
For Details See
statlink
Displays statistics for
links.
Any role in the system.
statlink on page 708
Node CPU Statistics
Logical Disk Statistics
Link Statistics
Chunklet Statistics
41
Physical Disk Statistics
Command
Description
Authority
For Details See
histpd
Displays histogram data
for physical disks.
Any role in the system.
histpd on page 207
statpd
Displays statistics for
physical disks.
Any role in the system.
statpd on page 709
Command
Description
Authority
For Details See
histport
Displays histogram data
for Fibre Channel ports.
Any role in the system.
histport on page 211
statport
Displays statistics for
Fibre Channel ports.
Any role in the system.
statport on page 713
Command
Description
Authority
For Details See
tunepd
Displays physical disks
with high service times
and optionally performs
load balancing.
Super, Edit
tunepd on page 743
Analyzes disk usage
and adjusts resources.
Super, Edit
Command
Description
Authority
For Details See
tunevv
Changes the layout of a
virtual volume.
Super, Edit
tunevv on page 748
Port Statistics
System Tuner
tunesys
Any role granted the
pd_tune right.
tunesys on page 745
Any role granted the
sys_tune right.
Dynamic Optimization
42
Physical Disk Statistics
Any role granted the
vv_tune right.
Virtual LUN (Export) Statistics
Command
Description
Authority
For Details See
histvlun
Displays histogram data
for VLUNs.
Any role in the system.
histvlun on page 217
statvlun
Displays statistics for
VLUNs.
Any role in the system.
statvlun on page 723
Virtual Volume Statistics
Command
Description
Authority
For Details See
histvv
Displays histogram data
for virtual volumes.
Any role in the system.
histvv on page 221
statvv
Displays statistics for
virtual volumes.
Any role in the system.
statvv on page 727
Remote Copy Volume Statistics
Command
Description
Authority
For Details See
histrcvv
Displays histogram data
for Remote Copy
volumes.
Any role in the system.
histrcvv on page 214
statrcvv
Displays statistics for
Remote Copy volumes.
Any role in the system.
statrcvv on page 720
Authority
For Details See
Preserved Data Commands
Command
Description
showpdata
Displays preserved data Any role in the system.
status.
showpdata on page
496
Replication Commands
Virtual LUN (Export) Statistics
43
Physical Copy
Command
Description
Authority
creategroupvvcopy
Creates consistent
Super, Edit
creategroupvvcopy on
group physical copies of
page 148
Any role granted the
a list of virtual volumes.
groupvvcopy_create
right.
createvvcopy
Copies a virtual volume.
Super, Edit
Any role granted the
vvcopy_create right.
promotevvcopy
Promotes a physical
copy back to a base
volume.
Super, Edit
Any role granted the
vvcopy_promote right.
For Details See
createvvcopy on page
188
promotevvcopy on
page 247
Remote Copy
NOTE:
Functionality of HPE 3PAR Remote Copy requires 3PAR Remote Copy license. See the HPE 3PAR
StoreServ Storage Concepts Guide for additional information.
Command
Description
admitrcopylink
Admits a network link for Super, Edit
Remote Copy use.
Any role granted the
rcopylink_admit
right.
admitrcopylink on
page 73
admitrcopytarget
Adds a target to a
Remote Copy volume
group
Super, Edit
admitrcopytarget on
page 74
Admits a virtual volume
to a Remote Copy
volume group.
Super, Edit
Performs a latency and
throughput test on a
remote copy link.
Super, Edit
Creates a group for
Remote Copy.
Super, Edit
admitrcopyvv
checkrclink
creatercopygroup
Authority
Any role granted the
rcopytarget_admit
right.
Any role granted the
rcopyvv_admit right.
Any role granted the
rclink_check right.
Any role granted the
rcopygroup_create
right.
For Details See
admitrcopyvv on page
75
checkrclink on page
90
creatercopygroup on
page 155
Table Continued
44
Physical Copy
Command
Description
Authority
For Details See
creatercopytarget
Creates a target for
Remote Copy.
Super, Edit1
creatercopytarget on
page 156
dismissrcopylink
Any role granted the
rcopytarget_create
right.
Dismisses a network link Super, Edit1
from Remote Copy use.
Any role granted the
rcopylink_dismiss
right.
dismissrcopytarget Dismisses a Remote
Copy target from a
Remote Copy volume
group.
Super, Edit
dismissrcopyvv
Dismisses a virtual
volume from a Remote
Copy volume group.
Super, Edit
Removes a group used
for Remote Copy.
Super, Edit
Removes a target used
for Remote Copy.
Super, Edit1
removercopygroup
removercopytarget
Any role granted the
rcopytarget_dismis
s right.
Any role granted the
rcopyvv_dismiss
right.
Any role granted the
rcopygroup_remove
right.
Any role granted the
rcopytarget_remove
right.
dismissrcopylink on
page 194
dismissrcopytarget on
page 195
dismissrcopyvv on
page 196
removercopygroup on
page 269
removercopytarget on
page 271
setrcopygroup
Sets a volume group’s
Super, Edit
setrcopygroup on page
policy for dealing with
375
Any role granted the
I/O failure and error
rcopygroup_set right.
handling, or switches
the direction of a volume
group.
setrcopytarget
Sets the Remote Copy
target state.
Super, Edit1
Displays the details of a
Remote Copy
configuration.
Any role in the system.
showrcopy
Any role granted the
rcopytarget_set
right.
setrcopytarget on page
382
showrcopy on page
521
Table Continued
Commands Quick Reference
45
Command
Description
Authority
For Details See
showrctransport
Shows status and info
about end-to-end
transport for Remote
Copy in the system.
Any role in the system.
showrctransport on
page 523
startrcopy
Starts a Remote Copy
subsystem.
Super, Edit1
startrcopy on page
684
Starts a Remote Copy
volume group.
Super, Edit
statrcopy
Displays Remote Copy
statistics.
Any role in the system.
statrcopy on page 719
stoprcopy
Stops a Remote Copy
subsystem.
Super, Edit1
stoprcopy on page 736
Stops a Remote Copy
volume group.
Super, Edit
Synchronizes Remote
Copy volume groups.
Super, Edit
startrcopygroup
stoprcopygroup
syncrcopy
1
Any role granted the
rcopy_start right.
Any role granted the
rcopygroup_start
right.
startrcopygroup on
page 684
Any role granted the
rcopy_stop right.
Any role granted the
rcopygroup_stop
right.
Any role granted the
rcopy_sync right.
stoprcopygroup on
page 737
syncrcopy on page
741
You must have access to all domains to run this command.
Virtual Copy
Command
Description
Authority
For Details See
createsv
Creates snapshot
volumes.
Super, Edit
createsv on page 170
creategroupsv
Any role granted the
sv_create right.
Creates consistent
Super, Edit
creategroupsv on page
group snapshots of a list
146
Any role granted the
of virtual volumes.
groupsv_create right.
Table Continued
46
Virtual Copy
Command
Description
Authority
For Details See
promotesv
Copies the differences
of a virtual copy back to
its base volume.
Super, Edit
promotesv on page
245
Copies the differences
of snapshots back to
their base volumes, to
allow to revert the base
volumes to an earlier
point in time.
Super, Edit
Updates a snapshot
virtual volume with a
new snapshot.
Super, Edit
promotegroupsv
updatevv
Any role granted the
sv_promote right.
Any role granted the
svgrp_promote right.
promotegroupsv on
page 244
updatevv on page 753
Any role granted the
vv_update right.
Security Hardening Commands
SP Credential
Command
Description
removespcredential Removes all Service
Processor credentials
on the array.
Authority
For Details See
Super
removespcredential on
page 276
Any role granted the
spcred_remove right.
Support Recovery Account Password
Command
Description
Authority
For Details See
controlrecoveryaut Control the method used Super
h
to authenticate recovery
Any role granted the
accounts.
recoveryauth_
control right.
controlrecoveryauth
on page 117
Super, Service (for
status subcommand
only)
Any role granted the
recoveryauth_
status right.
Service Commands
Security Hardening Commands
47
Disk Enclosure
Command
Description
Authority
For Details See
admithw
Admits new hardware
into the system.
Super, Service1
admithw on page 71
controlmag
Takes drives or
magazines on or off
loop.
Super, Service1
controlmag on page
107
Any role granted the
mag_control right.
servicecage
Prepares a drive cage
for service.
Super, Service1
servicecage on page
292
servicehost
Prepares a port for host
attachment.
Super, Service1
servicehost on page
293
servicemag
upgradecage
upgradepd
Prepares a drive
magazine for service.
Upgrades drive cage
firmware.
Any role granted the
host_service right.
Super, Service1
Any role granted the
mag_service right.
Super, Service1
Any role granted the
cage_upgrade right.
Upgrades disk firmware. Super, Service1
Any role granted the
pd_upgrade right.
1
servicemag on page
295
upgradecage on page
755
upgradepd on page
756
You must have access to all domains to run this command.
Node
Command
Description
Authority
For Details See
servicenode
Prepares a node for
service.
Super, Service1
servicenode on page
299
1
48
Any role granted the
node_service right.
You must have access to all domains to run this command.
Disk Enclosure
General System Maintenance
Command
Description
Authority
For Details See
shutdownnode
Shuts down an
individual system node.
Super, Service1
shutdownnode on
page 578
Shuts down the entire
system.
Super, Service1
shutdownsys
1
Any role granted the
node_shutdown right.
Any role granted the
sys_shutdown right.
shutdownsys on page
580
You must have access to all domains to run this command.
QoS
Command
Description
Authority
For Details See
setqos
Creates and updates
QoS rules in a system.
Super, Edit
setqos on page 373
showqos
Lists the QoS rules
configured in a system.
Any role in the system.
showqos on page 519
statqos
Displays historical
performance data
reports for QoS rules.
Any role in the system.
statqos on page 716
Command
Description
Authority
For Details See
showpatch
Displays patches
applied to a system.
Any role in the system.
showpatch on page
490
showversion
Displays software
versions.
Any role in the system.
showversion on page
553
Any role granted the
qos_set right can set
QoS configurations.
Software Version
General System Maintenance
49
SNMP Agent Commands
Command
Description
Authority
For Details See
addsnmpmgr
Adds an SNMP
manager to receive trap
notifications.
Super1
addsnmpmgr on page
69
Any role granted the
snmpmgr_ad right.
checksnmp
Allows a user to send an Super, Service
SNMPv2 test trap to the
Any role granted the
list of managers
snmp_check right.
removesnmpmgr
Removes an SNMP trap Super1
removesnmpmgr on
manager.
page 272
Any role granted the
snmpmgr_remove right.
removesnmppw
Removes an SNMP
password.
removesnmpuser
Removes an SNMP
user.
Super1
Any role granted the
snmppw_remove right.
Super, Service, Edit,
Browse
checksnmp on page
92
removesnmppw on
page 273
removesnmpuser on
page 274
Any role granted the
snmpuser_remove
right.
setsnmppw
setsnmpmgr
Changes an SNMP
manager's properties.
Super1
Any role granted the
snmppw_set right.
Super1
Any role granted the
snmpmgr_set right.
setsnmppw on page
388
setsnmpmgr on page
387
showsnmpmgr
Displays SNMP trap
managers.
Any role in the system.
showsnmpmgr on
page 529
showsnmppw
Displays SNMP access
passwords.
Any role in the system.
showsnmppw on page
529
showsnmpuser
Displays information
about SNMP users.
Any role in the system.
showsnmpuser on
page 530
1
50
Allows users to update
SNMP passwords.
You must have access to all domains to run this command.
SNMP Agent Commands
Sparing Commands
Command
Description
Authority
For Details See
createspare
Creates spare
chunklets.
Super, Service1
createspare on page
161
movech
movechtospare
movepd
movepdtospare
moverelocpd
removespare
showspare
1
Moves specified
chunklets.
Moves specified
chunklets to spare.
Any role granted the
spare_create right.
Super, Service, Edit1
Any role granted the
ch_move right.
Super, Service, Edit1
Any role granted the
ch_movetospare right.
Moves data from
specified physical disks
to a temporary location
selected by the system.
Super, Service, Edit
Moves specified
physical disks to spare.
Super, Service, Edit1
Moves chunklets
relocated from a
physical disk to another
physical disk.
movech on page 234
movechtospare on
page 235
movepd on page 236
Any role granted the
pd_move right.
Any role granted the
pd_movetospare right.
Super, Service1
Any role granted the
pd_movereloc right.
Removes spare
chunklets.
Service, Edit1
Displays information
about spare and
relocated chunklets.
Any role in the system.
Any role granted the
spare_remove right.
movepdtospare on
page 237
moverelocpd on page
239
removespare on page
275
showspare on page
534
You must have access to all domains to run this command.
Sparing Commands
51
SSH Access Commands
Command
Description
Authority
For Details See
setsshkey
Sets the SSH public key Super, Service, Edit,
for users enabling login Browse
without a password.
Any role granted the
sshkey_set right.
setsshkey on page 396
showsshkey
Displays all SSH public
keys that have been set
with setshhkey.
Any role in the system.
showsshkey on page
538
removesshkey
Removes a user's SSH
public key.
Super, Service, Edit,
Browse
removesshkey on page
278
Any role granted the
sshkey_remove right.
SSH Banner Commands
Command
Description
Authority
For Details See
removesshbanner
Removes the SSH
banner.
Super
removesshbanner on
page 277
Sets the SSH banner
that is displayed before
the user logs in.
Super
Display the SSH banner
that has been set with
setsshbanner.
Browse
setsshbanner
showsshbanner
Any role granted the
sshbanner_set right.
Any role granted the
sshbanner_set right.
Any role granted the
sshbanner_show right.
setsshbanner on page
395
showsshbanner on
page 537
System Reporter Commands
Command
Description
Authority
For Details See
controlsr
Make changes to the
System Reporter.
Super, Service
controlsr on page 117
createsralertcrit
Creates the criteria that
System Reporter
evaluates to determine
if a performance alert
should be generated.
Super, Service
createsralertcrit on
page 162
Any role granted the
sralertcrit_
create right.
Table Continued
52
SSH Access Commands
Command
Description
Authority
For Details See
removesralertcrit
Removes the criteria
that System Reporter
evaluates to determine
if a performance alert
should be generated.
Super, Service
removesralertcrit on
page 276
Sets the criteria that
System Reporter
evaluates to determine
if a performance alert
should be generated.
Super, Service
showsr
Displays System
Reporter status.
Any role in the system.
showsr on page 535
showsralertcrit
Displays the criteria
that System Reporter
evaluates to determine
if a performance alert
should be generated.
Any role in the system.
showsralertcrit on
page 536
sraomoves
Shows the space that
Adaptive Optimization
(AO) has moved
between tiers.
Any role in the system.
sraomoves on page
583
srcpgspace
Displays historical
space data reports for
common provisioning
groups (CPGs).
Any role in the system.
srcpgspace on page
584
srhistld
Displays historical
histogram performance
data reports for logical
disks.
Any role in the system.
srhistld on page 587
srhistpd
Displays historical
histogram data reports
for physical disks.
Any role in the system.
srhistpd on page 589
srhistport
Displays historical
histogram performance
data reports for ports.
Any role in the system.
srhistport on page
592
srhistvlun
Displays historical
Any role in the system.
histogram performance
data reports for VLUNs.
srhistvlun on page
595
srldspace
Displays historical
space data reports for
logical disks (LDs).
srldspace on page
598
setsralertcrit
Any role granted the
sralertcrit_
remove right.
Any role granted the
sralertcrit_set
right.
Any role in the system.
setsralertcrit on page
389
Table Continued
Commands Quick Reference
53
Command
Description
Authority
For Details See
srpdspace
Displays historical
space data reports for
physical disks (PDs).
Any role in the system.
srpdspace on page
601
srrgiodensity
Shows the distribution
of IOP/s intensity for
Logical Disk (LD)
regions for a common
provisioning group
(CPG) or Adaptive
Optimization (AO)
configuration.
Any role in the system.
srrgiodensity on page
604
srstatcmp
Displays historical
performance data
reports for cache
memory.
Any role in the system.
srstatcmp on page
609
srstatcpu
Displays historical
performance data
reports for CPUs.
Any role in the system.
srstatcpu on page 612
srstatfsav
Displays system
reporter performance
reports for file service
anti-virus.
Any role in the system.
srstatfsav on page
614
srstatfsblock
Displays System
reporter performance
reports for file service
block devices.
Any role in the system.
srstatfsblock on page
617
srstatfscpu
Displays system
reporter performance
reports for file service
CPU usage.
Any role in the system.
srstatfscpu on page
619
srstatfsfpg
Displays system
Any role in the system.
reporter performance
reports for file service
file provisioning groups.
srstatfsfpg on page
622
srstatfsmem
Displays system
reporter performance
reports for file service
memory usage.
Any role in the system.
srstatfsmem on page
624
srstatfsnet
Displays system
reporter performance
reports for file service
Ethernet interfaces.
Any role in the system.
srstatfsnet on page
626
Table Continued
54
Commands Quick Reference
Command
Description
Authority
For Details See
srstatfsnfs
Displays system
reporter performance
reports for file service
NFS.
Any role in the system.
srstatfsnfs on page
629
srstatfssmb
Displays system
reporter performance
reports for file service
SMB.
Any role in the system.
srstatfssmb on page
632
srstatfssnapshot
Displays system
reporter performance
reports for file service
snapshots.
Any role in the system.
srstatfssnapshot on
page 634
srstatiscsi
System reporter
performance for iSCSI
ports.
Any role in the system.
srstatiscsi
srstatiscsisession
System reporter
performance for iSCSI
sessions.
Any role in the system.
srstatiscsisession
srstatld
Displays historical
Any role in the system.
performance data
reports for logical disks.
srstatld on page 642
srstatlink
Displays historical
performance data
reports for links
(internode, PCI and
cache memory).
Any role in the system.
srstatlink on page 644
srstatpd
Displays historical
performance data
reports for physical
disks.
Any role in the system.
srstatpd on page 647
srstatport
Displays historical
performance data
reports for ports.
Any role in the system.
srstatport on page
649
srstatqos
Displays historical
performance data
reports for QoS rules.
Any role in the system.
srstatqos on page 652
srstatvlun
Displays historical
performance data
reports for VLUNs.
Any role in the system.
srstatvlun on page
661
Table Continued
Commands Quick Reference
55
Command
Description
Authority
For Details See
srstatvv
System reporter
Any role in the system.
performance reports for
virtual volumes.
srstatvv
srsysspace
System reporter space
reports for the system.
Any role in the system.
srsysspace
srvvspace
Displays historical
space data reports for
virtual volumes (VVs).
Any role in the system.
srvvspace on page
669
Task Management Commands
Command
Description
Authority
For Details See
canceltask
Cancels one or more
tasks.
Super, Edit
canceltask on page
82
removetask
Removes information
Super, Edit
about one or more tasks
Any role granted the
and their details.
task_remove right.
removetask on page
278
settask
Sets the priority on a
specified task.
Super, Edit
settask on page 405
showtask
Displays information
about tasks.
Any role in the system.
showtask on page 545
starttask
Executes commands
with long running times.
Super, Service, Edit
starttask on page 686
Asks the CLI to wait for
a task to complete
before proceeding.
Super, Service, Edit,
Browse
waittask
56
Any role granted the
task_cancel right.
Task Management Commands
Any role granted the
task_set right.
Any role granted the
task_start right.
Any role granted the
task_wait right.
waittask on page 758
Task Schedule Commands
Command
Description
Authority
For Details See
createsched
Allows users to
schedule tasks that are
periodically run by the
scheduler.
Super, Service
createsched on page
157
Removes a scheduled
task from the system.
Super, Service, Edit
removesched
Any role granted the
sched_create right.
Any role granted the
sched_remove right
can remove any user
scheduled tasks.
removesched on page
271
Any role granted the
sched_setown right
can only remove their
own scheduled tasks.
setsched
Allows users to
Super, Service
suspend, pause, change
Any role granted the
the schedule, change
sched_set right.
the parameters, and
change the name of
currently scheduled
tasks.
setsched on page 386
showsched
Displays the state of
tasks currently
scheduled on the
system.
showsched on page
527
Super, Service
Any extended role in the
system.
User Management Commands
Command
Description
Authority
For Details See
createuser
Creates user accounts.
Super1
createuser on page
178
Any role granted the
user_create right.
removeuser
removeuserconn
Removes user
accounts.
Removes user
connections.
Super1
Any role granted the
user_remove right.
Super1
Any role granted the
userconn_remove
right.
removeuser on page
280
removeuserconn on
page 281
Table Continued
Task Schedule Commands
57
Command
Description
Authority
For Details See
setpassword
Changes your
password.
Super, Service, Edit,
Browse2
setpassword on page
371
Any role granted the
password_setany
right can set any user
password.
Any role granted the
password_setown
right can only set their
own password.
setuser
Sets your user
properties.
Super, Edit, Browse
setuser on page 407
Any role granted the
user_setany right can
add, remove, and set
default domains for any
user.
Any role granted the
user_setown right can
only set their own
default domain.
setuseracl
58
Sets your Access
Control List (ACL).
Super, Edit
showuser
Displays user accounts.
Any role in the system.
showuser on page 548
showuseracl
Displays your access
control list (ACL).
Any role in the system.
showuseracl on page
550
showuserconn
Displays user
connections.
Any role in the system.
showuserconn on page
551
showrole
Displays information
about rights assigned to
roles in the system.
Any role in the system.
showrole on page 524
Any role granted the
useracl_set right.
1
You must have access to all domains to run this command.
2
Only the Super User can edit other user’s passwords.
Commands Quick Reference
setuseracl on page
408
VASA Provider Server Commands
Command
Description
Authority
For Details See
setvasa
Set the VASA Provider
server properties.
Super, Service
setvasa on page 409
showvasa
Show properties of the
VASA web service
provider.
Any role in the system.
startvasa
Start the VASA Provider Any role granted the
server to service HTTPS vasa_start right.
requests.
startvasa on page 686
showvasa
Show properties of the
VASA web service
provider.
Any role in the system.
showvasa on page 552
stopvasa
Stop the VASA Provider
server from servicing
HTTPS requests.
Super, Service
stopvasa on page 738
Any role granted the
vasa_set right.
showvasa on page 552
Any role granted the
vasa_stop right.
Virtual File Server Commands
Command
Description
Authority
For Details See
createvfs
Create a virtual file
server.
Super, Edit
createvfs on page 179
Remove a virtual file
server.
Super, Edit
Modify the properties of
a virtual file server.
Super, Edit
Show virtual file server
information.
Any role in the system.
removevfs
setvfs
showvfs
Any role granted the
vfs_create right.
Any role granted the
vfs_remove right.
removevfs on page
282
setvfs on page 410
Any role granted the
vfs_set right.
showvfs on page 554
VASA Provider Server Commands
59
Virtual File Server Network Configuration
Command
Description
Authority
For Details See
createfsip
Assigns an IP address
to a virtual file server.
Super, Edit
createfsip on page 140
Removes the network
configuration of a virtual
file server.
Super, Edit
Modify the network
configuration of a virtual
file server.
Super, Edit
Show the network
configuration of a virtual
file server.
Any role in the system.
showfsip on page 462
removefsip
setfsip
showfsip
Any role granted the
fsip_create right.
Any role granted the
fsip_remove right.
removefsip on page
260
setfsip on page 352
Any role granted the
fsip_set right.
Virtual File Server Quota
Command
Description
Authority
For Details See
setfsquota
Set the quotas for a
specific virtual file
server.
Super, Edit
setfsquota on page
356
Show the quotas for a
specific virtual file
server.
Any role in the system.
showfsquota
Any role granted the
fsquota_set right.
showfsquota on page
467
Virtual File Server Configuration Backup Commands
Command
Description
Authority
For Details See
backupfsconf
Create a configuration
backup for a virtual file
server.
Super, Service
backupfsconf on page
80
Restore a configuration
backup for a virtual file
server on the same or a
different system with
same fpg and vfs
structure.
Super, Service
restorefsconf
Any role granted the
fsconf_backup right.
Any role granted the
fsconf_restore right.
Volume Management Commands
60
Virtual File Server Network Configuration
restorefsconf on page
290
Common Provisioning Group Management
Command
Description
compactcpg
Consolidates logical disk Super, Edit
space in a CPG into as
Any role granted the
few logical disks as
cpg_compact right.
possible, allowing
unused logical disks to
be removed.
createcpg
Creates a Common
Provisioning Group
(CPG).
Super, Edit1
Removes CPGs.
Super, Edit1
removecpg
Authority
showcpg
1
compactcpg on page
100
createcpg on page 126
Any role granted the
cpg_create right.
Any role granted the
cpg_remove right.
setcpg
For Details See
Changes the properties
CPGs.
Super, Edit1
Displays CPGs.
Any role in the system.
removecpg on page
251
setcpg on page 314
Any role granted the
cpg_set right.
showcpg on page 433
You must have access to all domains to run this command.
Host Management
Command
Description
Authority
For Details See
createhost
Creates host and host
path definitions.
Super, Edit1
createhost on page
151
Creates a new set of
hosts and provides the
option of assigning one
or more existing hosts to
that set.
Super, Edit
createhostset
Any role granted the
host_create right.
Any role granted the
hostset_create right
can create a host set.
createhostset on page
153
Any role granted the
hostset_set right can
add hosts to a host set.
removehost
Removes host
definitions from the
system.
Super, Edit1
Any role granted the
host_remove right.
removehost on page
265
Table Continued
Common Provisioning Group Management
61
Command
Description
Authority
For Details See
removehostset
Removes a host set or
removes hosts from an
existing set.
Super, Edit
removehostset on
page 267
showhost
Displays defined hosts
in the system.
Any role in the system.
showhost on page 471
showhostset
Displays the host sets
defined on the 3PAR
Storage System and
their members.
Any role in the system.
showhostset on page
472
sethost
Sets properties on
existing system hosts,
including options to
annotate a host with
descriptor information
such as physical
location, IP address,
operating system,
model, and so on.
Super, Edit1
sethost on page 361
sethostset
Any role granted the
hostset_remove right
can remove a host set
or hosts from a host set.
Any role granted the
host_set right.
Sets the parameters and Super, Edit
modifies the properties
Any role granted the
of a host set.
hostset_annotate
right can only annotate
the comment of a host
set.
Any role granted the
hostset_set right can
set any host set
property.
1
62
You must have access to all domains to run this command.
Commands Quick Reference
sethostset on page
364
Logical Disk Management
Command
Description
checkld
Performs validity checks Super, Service1
of data on logical disks.
Any role granted the
ld_check right.
checkld on page 86
compactld
Consolidates space on
the logical disks.
Super, Edit
compactld on page
101
Removes logical disks.
Super, Service, Edit
removeld
Authority
For Details See
Any role granted the
ld_compact right.
removeld on page 268
Any role granted the
ld_remove right.
showld
Displays logical disks.
Any role in the system.
showld on page 476
startld
Starts logical disks.
Super, Service1
startld on page 682
Any role granted the
ld_start right.
1
You must have access to all domains to run this command.
Space and Storage Management
Command
Description
Authority
For Details See
showblock
Displays block mapping
information for virtual
volumes, logical disks,
and physical disks.
Any role in the system.
showblock on page
423
showldch
Displays logical disk to
physical disk chunklet
mapping.
Any role in the system.
showldch on page 481
showldmap
Displays logical disk to
virtual volume mapping.
Any role in the system.
showldmap on page
483
showpdch
Displays the status of
selected chunklets of
physical disks.
Any role in the system.
showpdch on page
496
showpdvv
Displays physical disk to Any role in the system.
virtual volume mapping.
showpdvv on page
500
showspace
Displays estimated free
space.
showspace on page
531
Any role in the system.
Table Continued
Logical Disk Management
63
Command
Description
Authority
For Details See
showvvmap
Displays virtual volume
to logical disk mapping.
Any role in the system.
showvvmap on page
565
showvvolvm
Displays information
about all virtual
machines (VVol-based)
or a specific virtual
machine in a system.
Any role in the system.
showvvolvm on page
566
showvvpd
Displays virtual volume
distribution across
physical disks.
Any role in the system.
showvvpd on page
570
Command
Description
Authority
For Details See
createtemplate
Creates templates for
the creation of logical
disks, virtual volumes,
thinly provisioned virtual
volumes, and common
provisioning groups.
Super1
createtemplate on page
173
Removes one or more
templates.
Super1
Template Management
removetemplate
settemplate
showtemplate
1
64
Modifies template
properties.
Displays existing
templates.
Any role granted the
template_create
right.
Any role granted the
template_remove
right.
Super1
Any role granted the
template_set right.
Any role in the system.
You must have access to all domains to run this command.
Template Management
removetemplate on
page 280
settemplate on page
406
showtemplate on page
546
Virtual Volume Management
Command
Description
admitvv
Creates and admits
Super
remotely exported virtual
Any role granted the
volume definitions to
vv_admit right.
enable the migration of
these volumes.
admitvv on page 78
checkvv
Performs validity checks Super, Service, Edit1
of virtual volume
Any role granted the
administrative
vv_check right.
information.
checkvv on page 93
createvv
Creates a virtual volume Super, Edit1
from logical disks.
Any role granted the
vv_create right.
createvv on page 183
createvvset
Defines a new set of
virtual volumes provides
the option of assigning
one or more existing
virtual volumes to that
set.
Super, Edit
createvvset on page
192
Frees SA and SD
spaces from a virtual
volume if they are not in
use.
Super, Edit
freespace
Authority
For Details See
Any role granted the
vvset_create right
can create a volume set.
Any role granted the
vvset_set right can
add volumes to a
volume set.
freespace on page 199
Any role granted the
space_free right.
growvv
Increases the size of a
Super, Edit1
virtual volume by adding
Any role granted the
logical disks.
vv_grow right.
growvv on page 201
importvv
Migrates data from a
remote LUN to the local
3PAR Storage System.
importvv on page 226
Super, Edit
Any role granted the
vv_import right.
Table Continued
Virtual Volume Management
65
Command
Description
Authority
For Details See
removevv
Removes virtual
volumes or logical disks
from common
provisioning groups.
Super, Edit
removevv on page 285
Any role granted the
basevv_remove right
can remove base
volumes.
Any role granted the
vvcopy_remove right
can remove physical
volumes.
Any role granted the
sv_remove right can
remove virtual copies.
removevvset
setvv
setvvolsc
Removes a virtual
volume set or virtual
volumes from an
existing set.
Super, Edit
Modifies properties
associated with a virtual
volume.
Super, Edit
Creates, removes, and
sets properties of
Storage Containers for
virtual volumes.
Super, Edit
Any role granted the
vvset_set right can
remove a volume set or
volumes from a volume
set.
removevvset on page
287
setvv on page 411
Any role granted the
vv_set right.
setvvolsc on page 414
Any role granted the
vvol_container_set
right.
setvvset
Sets the parameters and Super, Edit
modifies the properties
Any role granted the
of a virtual volume set.
vvset_set right.
setvvset on page 416
showrsv
Displays information
about reservation and
registration of VLUNs
connected on a Fibre
Channel port.
showrsv on page 526
showvv
Displays virtual volumes Any role in the system.
in the system.
showvv on page 558
showvvolsc
Display information
about VVol storage
containers in the
system.
showvvolsc on page
565
Any role in the system.
Any role in the system.
Table Continued
66
Commands Quick Reference
Command
Description
Authority
For Details See
showvvcpg
Displays the virtual
volume sets defined on
the 3PAR Storage
System and their
associated members.
Any role in the system.
showvvcpg on page
563
showvvset
Displays the virtual
volume sets defined on
the 3PAR Storage
System and their
members.
Any role in the system.
showvvset on page
572
startvv
Starts virtual volumes.
Super, Service1
startvv on page 687
Any role granted the
vv_start right.
updatesnapspace
1
Starts a task to update
the actual snapshot
space used by a virtual
volume.
Super, Edit
Any role granted the
snapspace_update
right.
updatesnapspace on
page 752
You must have access to all domains to run this command.
Virtual LUN (Export) Management
Command
Description
Authority
For Details See
createvlun
Creates a virtual volume Super, Edit
as a SCSI LUN.
Any role granted the
vlun_create right.
createvlun on page
181
removevlun
Removes VLUNs.
removevlun on page
283
Super, Edit
Any role granted the
vlun_remove right.
showvlun
Displays VLUNs in the
system.
Any role in the system.
showvlun on page 555
Virtual LUN (Export) Management
67
Web Services API (WSAPI) Commands
Command
Description
Authority
For Details See
removewapisession
Removes the WSAPI
user connections.
Super
removewsapisession
on page 288
Sets properties of the
Web Services API
server.
Super, Service
showwsapi
Displays the WSAPI
server service
configuration state.
Any role in the system.
showwsapi on page
574
showwsapisession
Displays the WSAPI
server sessions
connection information.
Any role in the system.
showwsapisession on
page 575
startwsapi
Starts the WSAPI
server.
Super, Service
startwsapi on page
688
Stops the WSAPI
server.
Super, Service
setwsapi
stopwsapi
68
Web Services API (WSAPI) Commands
Any role granted the
wsapisession_
remove right.
setwsapi on page 416
Any role granted the
wsapi_set right.
Any role granted the
wsapi_start right.
Any role granted the
wsapi_stop right.
stopwsapi on page
739
Add Command
addsnmpmgr
DESCRIPTION
The addsnmpmgr command adds an SNMP manager to receive trap notifications.
SYNTAX
addsnmpmgr [options <arg>] <manager_IP>
AUTHORITY
•
•
Super
Any role granted the snmpmgr_add right
OPTIONS
-notify {all|nodup|standard}
•
•
•
all—Enable all trap notification types defined by the HPE 3PAR MIB.
nodup—Enable all trap notification types defined by the HPE 3PAR MIB. Only send an alertNotify trap
if no other trap type will be sent for an event.
standard—Only send alertNotify type traps. This is the default.
-p <port_number>
Specifies the port number where the SNMP manager receives traps.
The port number and IP address are used together to uniquely identify the SNMP manager. Use this
option if the port number differs from the default of "162".
-pw <password>
Specifies the SNMP manager's access community string (password), using up to 32 alphanumeric
characters. If unspecified, the default is "public". This option only applies to SNMPv2.
-r <retry>
Specifies the number of times to send a trap (retry) using an integer from 1 through 15 if the SNMP
manager is not available. If not specified, the number of times a trap is sent defaults to 2.
This option is deprecated and will be removed in a subsequent release.
-snmpuser <username>
Specifies the SNMPv3 user name using up to 31 characters. The user name must be enabled for
SNMPv3 with the createsnmpuser on page 160 command. The username must be configured with the
same credential on both the SNMPv3 manager and the HPE 3PAR agent.
-t <timeout>
Specifies the number of seconds to wait before sending a trap (timeout) using an integer from 1 through
300. If not specified, the time defaults to 200 seconds. This option is deprecated and will be removed in a
subsequent release.
-version <version>
Integer value that specifies the SNMP version supported by the manager.
Use "2" for SNMPv2 or "3" for SNMPv3. The default is "2".
SPECIFIERS
Add Command
69
<manager_IP>
Specifies the IP address of the host where the manager runs. It must be valid IPv4 or IPv6 address. IPv6
address is in hexadecimal, is case insensitive, and is separated by colons. An example would be:
5def:2008:0:0:abcd:0:0:161a
In addition, a double colon (::) can be used once in an address to replace multiple fields of zeros. For
example:
5def:2008:0:0:abcd::161a
EXAMPLES
The following example shows the addition of SNMPv2 manager IPv4 address 123.45.67.89 with the
assigned password of alpha1:
cli% addsnmpmgr -pw alpha1 123.45.67.89
The following example shows the addition of SNMPv2 manager IPv6 address with port number and
nodup notification:
cli% addsnmpmgr -notify nodup -p 9162 5def:2008:abcd::161a
The following example shows the addition of SNMPv3 manager IPv6 address with user:
cli% addsnmpmgr -version 3 -snmpuser joe 5def:2008:abcd::161b
NOTES
Access to all domains is required to run this command.
The storage system does not support any form of name resolution. You must specify these IP addresses
directly.
Issue the showsnmpmgr on page 529 command to display the list of registered SNMP managers.
Issue the setsnmpmgr on page 387 command to change the SNMP user or version.
Issue the setsnmppw on page 388 command to change the SNMP passwords.
Issue the removesnmppw on page 273 command to remove SNMP passwords.
Issue the removesnmpmgr on page 272 command to remove SNMP managers.
70
Add Command
Admit Commands
admithw
DESCRIPTION
The admithw command admits new hardware into the system. If new disks are discovered on HPE
StoreServ 7200/c and 8200 systems, tunesys will be started automatically to redistribute existing
volumes to use the new capacity unless the -notune option is used. On other systems, tunesys needs to
be run manually after hardware installation.
SYNTAX
admithw [options]
AUTHORITY
•
Super, Service
OPTIONS
-checkonly
Only performs passive checks; does not make any changes.
-f
If errors are encountered, the admithw command ignores them and continues. The messages remain
displayed.
-nopatch
Suppresses the check for drive table update packages for new hardware enablement.
-notune
Do not automatically run tunesys to rebalance the system after new disks are discovered.
SPECIFIERS
None.
EXAMPLES
The following example displays a passive check of the system:
cli% admithw -checkonly
Checking nodes...
Checking volumes...
Checking system LDs...
Checking ports...
Checking state of disks...
Checking cabling...
Check complete.
NOTES
Access to all domains is required to run this command.
The admithw command handles any nodes, disks, or cages that have been added into the system.
Admit Commands
71
In addition to verifying that all expected hardware is present, the admithw command handles all checks,
including valid states, cabling, and firmware revisions.
The admithw command also handles creating system logical disks while adding and re-balancing spare
chunklets.
Spares are allocated according to the algorithm specified by the SparingAlgorithm system parameter.
If new disks are discovered in any combination, tunesys on page 745 will start automatically once
admithw has finished and will redistribute existing volumes to best use the newly added capacity. If notune is used, automatic volume re-balancing will not occur.
This command checks for drive table patch updates unless the -nopatch option is specified.
admitpd
DESCRIPTION
The admitpd command creates and admits PD definitions to enable the use of those disks.
SYNTAX
admitpd [option] [<world_wide_name>...]
AUTHORITY
•
•
Super, Service
Any role granted the pd_admit right
OPTIONS
-nold
Do not use the PD (as identified by the <world_wide_name> specifier) for logical disk allocation.
-nopatch
Suppresses the check for drive table update packages for new hardware enablement.
SPECIFIERS
<world_wide_name>
Indicates the World Wide Name (WWN) of the PD to be admitted. If WWNs are specified, only the
specified PD(s) are admitted. Otherwise, all available PDs are admitted.
EXAMPLES
The following example admits PDs in a 20-disk system:
cli% admitpd
20 disks admitted
NOTES
Access to all domains is required to run this command.
PDs cannot be used by the HPE 3PAR OS for storage until they are admitted into the system.
Specify the -nold option when adding a PD to replace a failed disk, whose chunklets were moved to spare
space. Specifying -nold prevents the allocation of the newly added PD and allows chunklets to be moved
back to the new disk. After chunklets have been moved back to the new disk, the administrator can allow
logical disks to be allocated again by issuing the setpd on page 372 command.
Verify the admittance of PD definitions by issuing the showpd on page 491 command.
72
admitpd
If no WWN is specified or if all the specified WWNs are admitted, the command succeeded. If multiple
WWNs are specified and not all can be admitted, the admitpd command fails.
This command checks for drive table patch updates unless the -nopatch option is specified.
admitrcopylink
DESCRIPTION
The admitrcopylink command adds one or more links (connections) to a remote copy target system.
SYNTAX
For remote copy over IP (RCIP), the syntax for the admitrcopylink command is as follows:
admitrcopylink <target_name> <N:S:P:IP_address>...
For remote copy over fibre channel (RCFC), the syntax for the admitrcopylink command is as follows:
admitrcopylink <target_name> <N:S:P:WWN>...
AUTHORITY
•
•
Super, Edit
Any role granted the rcopylink_admit right
OPTIONS
None.
SPECIFIERS
<target_name>
The target name, as specified with the creatercopytarget on page 156 command.
<node:slot:port:IP_address>...
Specifies the node, slot, and port of the Ethernet port on the local system and an IP address of the peer
port on the target system.
<node:slot:port:WWN>...
Specifies the node, slot, and port of the Fibre Channel port on the local system and World Wide Name
(WWN) of the peer port on the target system.
EXAMPLES
The following example adds a link on System2 (targetname), node 1. The IP address 193.1.2.11 specifies
the address on the target system:
cli% admitrcopylink System2 1:2:1:193.1.2.11
The following WWN creates an RCFC link to target System2, which connects to the local 5:3:2 (N:S:P) in
the target system:
cli% admitrcopylink System2 5:3:2:20010002AC000060
NOTES
admitrcopylink
73
IP targets are made up of pairs composed of the node, slot and port of the ethernet port on the local
system and an IP address of the peer port on the target system.
FC targets are made up of sets with the node, slot, and port of the FC port on the local system and WWN
of the peer port on the target system.
This command concludes by returning a list of one or more links to be admitted.
•
•
For IP targets, the list consists of pairs composed of the node containing the Ethernet port on the local
system and an IP address of the peer port on the target system.
For FC targets, the list consists of sets with the node, slot, and port of the FC port on the local system
and the WWN of the peer port on the target system.
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
Access to all domains is required to run this command.
The transport layer (RCIP or RCFC) is set using the creatercopytarget on page 156 command.
The specifier <node:IP_address> has been deprecated.
admitrcopytarget
DESCRIPTION
The admitrcopytarget command adds a target to a remote-copy volume group.
SYNTAX
admitrcopytarget <target_name> <mode> <group_name>
[<pri_vv_name:sec_vv_name> ...]
AUTHORITY
•
•
Super, Edit
Any role granted the rcopytarget_admit right
OPTIONS
None.
SPECIFIERS
<target_name>
Specifies the name of the target that was previously created with the creatercopytarget on page 156
command.
<mode>
Specifies the mode of the target as either synchronous (sync), asynchronous periodic (periodic), or
asynchronous streaming (async).
<group_name>
Specifies the name of the existing remote copy volume group created with the creatercopygroup on
page 155 command to which the target will be added.
<pri_vv_name:sec_vv_name>
Specifies the mapping between the names of a volume in the primary group and the corresponding
volume on the added target. This specifier must be included for every volume in the primary volume
group. This specifier is required only if the group contains volumes.
EXAMPLES
74
admitrcopytarget
In the following example, the admitrcopytarget command adds the target target1 in synchronous
mode to volume group Group1.
cli% admitrcopytarget target1 sync Group1
NOTES
Functionality of this command requires the HPE 3PAR Remote Copy Software license.
Contact your local service provider for more information.
Access to all domains is required to run this command.
A primary<->secondary volume mapping must be provided for each volume currently in the group.
admitrcopyvv
DESCRIPTION
The admitrcopyvv command adds an existing virtual volume to an existing remote copy volume group.
SYNTAX
admitrcopyvv [options] <VV_name>[:<snapname>] <group_name>
<target_name>:<sec_VV_name>...
AUTHORITY
•
•
Super, Edit
Any role granted the rcopyvv_admit right
OPTIONS
-pat
Specifies that the <VV_name> is treated as a glob-style pattern and that all remote copy volumes
matching the specified pattern are admitted to the remote copy group. When this option is used the
<sec_VV_name> and <snapname> (if specified) are also treated as patterns. It is required that the
secondary volume names and snapshot names can be derived from the local volume name by adding a
prefix, suffix or both. <snapname> and <sec_VV_name> should take the form prefix@vvname@suffix,
where @vvname@ resolves to the name of each volume that matches the <VV_name> pattern.
-createvv
Specifies that the secondary volumes should be created automatically. This specifier cannot be used
when starting snapshots (<VV_name>:<snapname>) are specified.
-nowwn
When used with -createvv, it ensures a different WWN is used on the secondary volume. Without this
option -createvv will use the same WWN for both primary and secondary volumes.
-nosync
Specifies that the volume should skip the initial sync. This is for the admission of volumes that have been
pre-synced with the target volume.
This specifier cannot be used when starting snapshots (<VV_name>:<snapname>) are specified.
SPECIFIERS
<VV_name>
admitrcopyvv
75
Specifies the name of the existing virtual volume to be admitted to an existing remote copy volume group
that was created with the creatercopygroup on page 155 command.
<snapname>
An optional read-only snapshot <snapname> can be specified along with the virtual volume name
<VV_name>. This snapshot is a starting snapshot.
When the group is started, a full sync is not performed. Instead, for synchronous groups, the volume will
synchronize deltas between <snapname> and the base volume. For asynchronous periodic groups, the
volume will synchronize deltas between <snapname> and a snapshot of the base. For asynchronous
streaming groups, the volume will synchronize deltas between <snapname> and the base volume.
<group_name>
Specifies the name of the existing remote copy volume group created with the creatercopygroup on
page 155 command, to which the volume will be added.
<sec_vv_pattern>
Specifies the pattern that is used to create the secondary virtual volume on the target system.
<target_name>:<sec_VV_name>
The target name associated with this group, as set with the creatercopygroup on page 155 command.
The target is created with the creatercopytarget on page 156 command. <sec_VV_name> specifies the
name of the secondary volume on the target system. One <target_name>:<sec_VV_name> must be
specified for each target of the group.
<pattern>
Specifies a glob-style pattern. If this specifier is not used, the <VV_name> specifier must be used. (For
more information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
EXAMPLES
In the following example, the admitrcopyvv command adds the volume vv1 to the primary volume
group Group1. At the same time, it adds the secondary volume vv1_remote on the target system
System2 to the corresponding secondary volume group (Group1.r<sys_ID>), which was previously
created when the creatercopygroup on page 155 command was issued:
cli% admitrcopyvv vv1 Group1 System2:vv1_remote
In the following example, the admitrcopyvv command adds all volumes beginning with tpvv to the
primary volume group (Group1). At the same time, it adds the secondary volumes, which are named the
same as the primary volumes (as specified by @vvname@), on the target system System2 to the
corresponding secondary volume group (Group1.r<sys_ID>):
cli% admitrcopyvv -pat tpvv* Group1 System2:@vvname@
In the following example, the admitrcopyvv command adds the volume vv1 to the primary volume
group (Group1). At the same time, it creates and adds the volume vv1.r on the target system InServ1_in
to the corresponding secondary volume group that was previously created when the creatercopygroup
on page 155 command was issued:
76
Admit Commands
cli% admitrcopyvv -createvv vv1 Group1 InServ1_in:vv1.r
In the following example, the admitrcopyvv command adds the volume vv1 to the primary volume
group (Group1). At the same time, it adds the volume vv1.r on the target system InServ1_in to the
corresponding secondary volume group that was previously created when the creatercopygroup on
page 155 command was issued.
It also specifies that the volume should not undergo an initial synchronization when the group is started:
cli% admitrcopyvv -nosync vv1 Group1 InServ1_in:vv1.r
In the following example, the admitrcopyvv command adds the volume vv1 to the primary volume
group (Group1). At the same time, it adds the volume vv1.r on the target system InServ1_in to the
corresponding secondary volume group that was previously created when the creatercopygroup on
page 155 command was issued.
It also specifies that the volume should be synced using rosv_vv1 as the starting snapshot:
cli% admitrcopyvv vv1:rosv_vv1 Group1 InServ1_in:vv1.r
In the following example, the admitrcopyvv command adds all the volumes that start with the name
testvv to the primary volume group (Group1). At the same time, it adds all the volume testvv*.r on the
target system InServ1_in to the corresponding secondary volume group that was previously created when
the creatercopygroup on page 155 command was issued. It also specifies that each volume should be
synchronized using rosv_testvv* as the starting snapshot:
cli% admitrcopyvv -pat testvv*:rosv_@vvname@ Group1 InServ1_in:@vvname@.r
NOTES
Functionality of this command requires the HPE 3PAR Remote Copy Software license. Contact your local
service provider for more information.
A secondary volume mapping must be provided for each target in the group.
The virtual volume and the remote copy group must be in the same domain or both in no domain.
The -nosync option will skip the full synchronization of this volume once the remote copy group is started.
On the primary system the showrcopy on page 521 SyncStatus will appear as New-PreSynced. On the
secondary the SyncStatus will appear as "New".
When a starting snapshot is specified, the snapshot will not be automatically deleted after the group is
started and resynced.
When a starting snapshot is specified, any changes between the specified snapshot and the point when
the group is started will be resynced. This is done instead of a full synchronization. On the primary system
the showrcopy on page 521 SyncStatus will appear as New-SyncFromSnap. On the secondary the
SyncStatus will appear as New.
If the -nosync option is not used and a starting snapshot is not specified, the volume will undergo a full
synchronization when the group is started.
Admit Commands
77
The showrcopy on page 521 SyncStatus will appear as New on both primary and secondary systems.
If a group's target has the mirror_config policy set and the group is a primary group, then this command is
mirrored to that target and the volume is added to the secondary volume group. If the policy is set and the
group is a secondary, this command fails.
For multiple target remote copy groups, in addition to adding the primary/secondary mapping on the
target systems, the relevant mapping between the target systems will be added to the backup groups.
admitvv
DESCRIPTION
The admitvv command creates and admits remotely exported virtual volume definitions to enable the
migration of these volumes. The newly created volume will have the WWN of the underlying remote
volume.
SYNTAX
admitvv [-domain <domain>] <vvname>:<WWN> [<vvname>:<WWN> ...]
admitvv [-domain <domain>] <vvname:<WWN>:<New WWN> [<vvname:<WWN>:<New
WWN>] ...
AUTHORITY
•
•
Super
Any role granted the vv_admit right
OPTIONS
-domain <domain>
Create the admitted volume in the specified domain. The default is to create it in the current domain, or
no domain if the current domain is not set.
SPECIFIERS
<vvname>
Specifies the local name that should be given to the volume being admitted (up to 31 characters in
length).
<WWN>
Specifies the World Wide Name (WWN) of the remote volumes to be admitted.
<New WWN>
Specifies the World Wide Name (WWN) for the local copy of the remote volume. If the keyword "auto" is
specified the system automatically generates a WWN for the virtual volume
EXAMPLES
The following example admits 2 remote VVs that have been exported to the storage system in
preparation for migration:
cli% admitvv migvv.0:50002AC00037001A migvv.1:50002AC00047001A
2 VVs admitted
NOTES
You need access to all domains in order to run this command.
The volume admitted using this command can be exported to hosts. However, all the data access to the
volume will be directed to the external LUN.
78
admitvv
The volume admitted using this command can be imported into local storage system by using the
importvv on page 226 command.
Admit Commands
79
Backup Command
backupfsconf
DESCRIPTION
The backupfsconf command creates a configuration backup for a virtual file system. Configuration
backup artifact is created with a standard name in the .admin file store under the virtual file server in a
directory configbackup. There will be one backup file created per virtual file server. The subsequent
backup will overwrite the backup artifact.
SYNTAX
backupfsconf [-fpg <fpgname>] <vfs>
AUTHORITY
•
•
Super, Service.
Any role granted fsconf_backup right
OPTIONS
-fpg <fpgname>
Specifies the file provisioning group (FPG) for the virtual file server.
SPECIFIERS
<vfs>
Specifies the name of the virtual file server.
EXAMPLES
The following example creates a configuration backup on FPG named "samplefpg" under virtual server
named "samplevfs":
cli% backupfsconf -fpg samplefpg samplevfs
NOTES
Access to all domains is required to run this command.
The Config backup artifact is created in the ".admin/configbackup" folder under the virtual file server
(VFS). If there is not adequate space available to create the artifact the backup creation will fail.
HPE recommends that you create the configuration backup before creating a data backup. The same
should be applied when creating a restore.
The following actions take place when creating a configuration backup or restore:
•
•
Backups of all the file stores, VFS IP, Share information of NFS, CIFS, and Object/Certificates, AC
configuration and Quota information.
Restores each of the backup points maintaining a restoration order.
The following manual steps must be taken when creating a configuration backup:
•
•
80
When the configuration backup is finished, use NDMP or other means to back up the config backup
folder located in the ".admin" folder (.admin/configbackup).
This folder contains the backup artifact.
Backup Command
•
•
•
Manually set up the FPG and the VFS, and then restore the configbackup folder under the VFS in the
".admin" file store (the folder containing the backup artifact).
Folder creation for each of the CIFS & NFS shares is handled by the NDMP data restore.
Manually configure the cluster-wide AV VSE data before doing a configuration restore.
See restorefsconf on page 290 for additional information on configuration restore.
Backup Command
81
Cancel Command
canceltask
DESCRIPTION
The canceltask command cancels one or more tasks.
SYNTAX
canceltask [option] {all|<task_ID>...}
AUTHORITY
•
•
Super, Service, Edit
Any role granted the task_cancel right
OPTIONS
-f
Forces the command. The command completes the process without prompting for confirmation.
SPECIFIERS
all
Cancels all active tasks. If not specified, a task ID(s) must be specified.
<task_ID>
Cancels only tasks identified by their task IDs. Task_ID must be an unsigned integer within 1-29999
range.
EXAMPLES
The following example shows how to cancel a task using the task ID:
cli% canceltask 1
Are you sure you want to cancel task 1?
select q=quit y=yes n=no: y
NOTES
The canceltask command can return before a cancellation is completed. Thus, resources reserved for
a task might not be immediately available. This can prevent actions like restarting the canceled task. Use
the waittask command to ensure orderly completion of the cancellation before taking other actions. See
waittask on page 758 for more details.
The -restart option associated with the tunevv command enables a canceled tunevv task to be
resumed. See tunevv on page 748 for more information.
A Service user is only allowed to cancel tasks started by that specific user.
82
Cancel Command
Change Command
changedomain
DESCRIPTION
The changedomain command changes the currentdomain CLI environment parameter.
SYNTAX
changedomain [<domain>]
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
<domain>
Name of the domain to be set as the working domain for the current CLI session. If the <domain>
parameter is not present or is equal to -unset then the working domain is set to no current domain.
EXAMPLES
The following example shows how to change the currentdomain Win:
cli% changedomain Win
The following examples shows two methods to unset the currentdomain:
cli% changedomain -unset
cli% changedomain
NOTES
This command is equivalent to setclienv currentdomain <domain>.
Change Command
83
Check Commands
checkhealth
DESCRIPTION
The checkhealth command checks the status of system hardware and software components, and
reports any issues.
SYNTAX
checkhealth [<options> | <Component>...]
AUTHORITY
•
•
Any role in the system
Users with Edit and Browse roles will not evaluate the system as fully as those with Super and Service
roles, and will only evaluate items available to the domains in which the user has privileges.
OPTIONS
-lite
Perform a minimal health check.
-svc
Perform a thorough health check. This is the default option.
-full
Perform the maximum health check. This option cannot be used with the -lite option.
-list
List all components that will be checked.
-quiet
Do not display which component is currently being checked. Do not display the footnote with the -list
option.
-d
Display detailed information regarding the status of the system.
SPECIFIERS
<Component>
Indicates the component to check. Use -list option to get the list of components.
EXAMPLES
In the following example, the overall health status of all the components is checked:
84
Check Commands
cli% checkhealth
Checking alert
Checking ao
Checking cabling
Checking cage
Checking cert
Checking dar
Checking date
Checking file
Checking fs
Checking host
Checking ld
Checking license
Checking network
Checking node
Checking pd
Checking pdch
Checking port
Checking qos
Checking rc
Checking snmp
Checking task
Checking vlun
Checking vv
Checking sp
Component -----Summary Description----- Qty
Alert
New alerts
8
Cabling
Bad SAS connection
1
Cage
Cages not on current firmware
8
LD
LDs with reduced availability
3
------------------------------------------4 total
20
In this example, the file, ld and task components are checked and the detailed information is displayed:
cli% checkhealth -d file ld task
Checking file
Checking ld
Checking task
Component --------Summary Description-------- Qty
File
Nodes with Dump or HBA core files
1
Task
Failed Tasks
2
------------------------------------------------2 total 3
Component -Identifier- ----Detailed Description---File
node:1
Dump or HBA core files found
Task
Task:529
Failed Task
Task
Task:530
Failed Task
--------------------------------------------------3 total
Check Commands
85
NOTES
None.
checkld
DESCRIPTION
The checkld command executes consistency checks of data on LDs in the event of an uncontrolled
system shutdown and optionally repairs inconsistent LDs.
SYNTAX
checkld [options] <LD_name>...
AUTHORITY
•
•
Super, Service
Any role granted the ld_check right
OPTIONS
-y|-n
Specifies that if errors are found they are either modified so they are valid (-y) or left unmodified (-n). If not
specified, errors are left unmodified (-n).
-progress
Poll sysmgr to get ldck report.
-recover <pdid:pdch>
Attempt to recover the chunklet specified by giving physical disk (<pdid>) and the chunklet's position on
that disk (<pdch>). If this options is specified, -y must be specified as well.
-rs <raidset_number>
Check only the specified RAID set.
SPECIFIERS
<LD_name>...
Requests that the integrity of a specified LD is checked. This specifier can be repeated to execute validity
checks on multiple LDs.
EXAMPLES
The following example displays a validity check of LD tp-6-sa-0.0, with the -progress option to be
informed of the check's progress:
cli% checkld -n -progress tp-6-sa-0.0
Performing a kernel level consistency check, will not try to fix
inconsistencies
ld tp-6-sa-0.0 has 5 rsets, checked 0, inconsistent 0
ld tp-6-sa-0.0 has 5 rsets, checked 0, inconsistent 0
ld tp-6-sa-0.0 has been checked
The following example tries to recover chunklet 1032:10 of LD vv.adm.0, and there will be output about
the progress:
86
checkld
cli% checkld -y -progress -recover 1032:10 vv.adm.0
NOTES
Access to all domains is required to run this command.
Repairing LDs refers to making LDs consistent.
Consistency for RAID-1 means that all mirrors in the set have the same data.
Consistency for RAID-5 or RAID-6 means that parity is consistent with the data in the set.
When -recover option is given, only one LD should be allowed and -y option should also be given.
The "checkld" command can be issued on any LD, started or not.
checkpassword
DESCRIPTION
The checkpassword command prompts for the user's password and then displays the steps the system
uses to authenticate the user and determine the user's role. The information includes whether the user is
local to the system or authenticated and authorized based on the configuration parameters set with the
setauthparam on page 303 command for use with LDAP.
SYNTAX
checkpassword [<user>]
AUTHORITY
•
•
•
Super, Edit, Browse, Service
Any role granted the password_checkany right can check the password of any user
Any role granted the password_checkown right can only check their own password
OPTIONS
None.
SPECIFIERS
<user>
If the <user> parameter is not specified, then the current user is used.
Only users with Super role with access to all domains can specify <user> names other than their own.
EXAMPLES
The following example displays the authentication and authorization of user User1:
cli% checkpassword User1
password:
+ attempting authentication and authorization using system-local data
user User1 is authenticated and authorized
The output of the checkpassword command is a series of information statements, each starting with a
plus sign ("+") that indicates the steps the system is using to authenticate the user and determine the role.
checkpassword
87
The last line of output shows the summary of the steps with the user either being unauthenticated or
authenticated and authorized.
NOTES
The output of the checkpassword command is based on current authentication and authorization
parameters and might differ from the user's actual authorization level if the setauthparam on page 303
command has been used to change parameters or data in the LDAP server has changed since the user
last logged in.
The showuserconn on page 551 command can be used to verify the authorization levels assigned at
login.
checkpd
DESCRIPTION
The checkpd command executes surface scans or diagnostics on physical disks (PD).
SYNTAX
checkpd scrub|diag [options ] <pd_ID>...
AUTHORITY
•
•
Super, Service
Any role granted the pd_check right
OPTIONS
The following options can only be used with the scrub specifier:
•
-ch <number>
•
To scan a specific chunklet rather than the entire disk.
-count <number>
To scan a number of chunklets starting from -ch.
The following options can only be used with the diag specifier:
88
•
-path <p>
•
Specifies a PD path as a, b, both, or system.
-test <type>
•
Specifies read, write, or verify test diagnostics. If no type is specified, the default is read. The "verify"
diag test option fills the test range with a pattern then reads back the data and verifies the data is
correct.
-iosize <size>
•
Specifies I/O size, valid ranges are from 1s to 1m. If no size is specified, the default is 128k.
-threads <num>
•
Specifies number of I/O threads, valid ranges are from 1 to 4. If the number of threads is not specified,
the default is 1.
-time <secs>
•
Indicates the number of seconds to run, from 1 to 36000. The -time option takes precedence if used
with other options such as -total or -range.
-total <size>
•
Indicates total bytes to transfer per disk. If a size is not specified, the default size is 1g.
-retry <number>
checkpd
•
Specifies the total number of retries on an I/O error. If the number of retries is not specified, the default
is 4.
-range <size>
Limits diagnostic regions to a specified size, from 2m to 2g.
SPECIFIERS
scrub
Scans one or more chunklets for media defects.
diag
Performs read, write, or verify test diagnostics.
<pd_ID>...
The ID of the PD to be checked. Only one pd_ID can be specified for the "scrub" test.
EXAMPLES
In the following example, chunklet 400 on PD 1 is scanned for media defects:
cli% checkpd scrub -ch 400 1
2015-06-09 04:41:37 MDT {22401} PD Scrubber Start: max chunk id 400 pd id 1
starting chunk id 400 system cycle
168hr chunk cycle 60s log level 5
2015-06-09 04:41:37 MDT {22401} Open system device...
2015-06-09 04:41:37 MDT {22401} Attach to system manager...
2015-06-09 04:41:37 MDT {22401} Waiting for system manager ready...
2015-06-09 04:41:37 MDT {22401} PD Scrubber 2.0 started
2015-06-09 04:41:37 MDT {22401} Thread 1863816960 started for node 0
2015-06-09 04:41:47 MDT {22401} Finished scanning pd 1 ch 400 status 1
2015-06-09 04:41:47 MDT {22401} No media errors detected
NOTES
Access to all domains is required to run this command.
The <size> specifier can include a letter to indicate units:
•
•
•
•
•
•
g = gigabytes (2^30)
t = terabytes (2^40)
p = petabytes (2^50)
m = 1048576 bytes
k = 1024 bytes
s = 512 bytes
I/O errors will be reported even if the eventual I/O succeeds due to retries.
Up to 40 PD IDs can be specified for the diag test type.
checkport
DESCRIPTION
The checkport command performs loopback tests on Fibre Channel ports.
SYNTAX
checkport [options <arg>] <node:slot:port>
checkport
89
AUTHORITY
•
•
Super, Service
Any role granted the port_check right
OPTIONS
-time <seconds_to_run>
Specifies the number of seconds for the test to run using an integer from 0 to 300.
-iter <iterations_to_run>
Specifies the number of times for the test to run using an integer from 1 to 1000000.
SPECIFIERS
<node:slot:port>
Specifies the port to be tested.
node
Specifies the node using a number from 0 through 7.
slot
Specifies the PCI slot in the specified node. Valid range is 0 - 9.
port
Specifies the port using a number from 1 through 4.
EXAMPLES
In the following example, the loopback test is performed on port 0:0:1 a total of five times:
cli% checkport -iter 5 0:0:1
Starting loopback test on port 0:0:1
Port 0:0:1 completed 5 loopback frames in 0 seconds
Passed
NOTES
Access to all domains is required to run this command.
When both the -time and -iter options are specified, the first limit reached terminates the program. If
neither are specified, the default is 1,000 iterations. The total run time is always limited to 300 seconds
even when not specified.
The default loopback is an ELS-ECHO sent to the HBA itself.
checkrclink
DESCRIPTION
The checkrclink command performs a connectivity, latency, and throughput test between two
connected HPE 3PAR storage systems.
SYNTAX
checkrclink subcommand [options] <N:S:P> [<dest_addr>] [<port>]
SUBCOMMANDS
checkrclink startclient [options] <N:S:P> <dest_addr> <time> [<port>]
90
checkrclink
checkrclink stopclient <N:S:P>
checkrclink startserver [options] <N:S:P> [<dest_addr>] [<port>]
checkrclink stopserver <N:S:P>
checkrclink portconn <N:S:P>
startclient
Start the link test.
stopclient
Stop the link test.
startserver
Start the server.
stopserver
Stop the server.
portconn
Uses the Cisco Discovery Protocol Reporter to show display information about devices that are
connected to network ports. Requires CDP to be enabled on the router.
AUTHORITY
•
•
Super, Service
Any role granted the rclink_check right
OPTIONS
-time <secs>
Specifies the number of seconds for the test to run using an integer from 300 to 172800. If not specified
this defaults to 172800 seconds (48 hours).
-fcip
Specifies if the link is running over fcip. Should only be supplied for FC interfaces.
SPECIFIERS
<N:S:P>
Specifies the interface from which to check the link, expressed as node:slot:port.
<dest_addr>
Specifies the address of the target system (for example, the IP address).
<time>
Specifies the test duration in seconds.
Specifies the number of seconds for the test to run using an integer from 300 to 172800.
<port>
Specifies the port on which to run the test. If this specifier is not used, the test automatically runs on port
3492.
EXAMPLES
The following example starts a client test on port 0:0:1 to IP address 10.100.10.10 with a duration of 60
seconds:
Check Commands
91
cli% checkrclink startclient 0:0:1 10.100.10.10 60
NOTES
Access to all domains is required to run this command.
Do not check the links if CPU usage is already close to 100%. The link check temporarily increases CPU
usage.
The remote copy ports must be configured via the controlport on page 109 command before this test
can be carried out; however, this test can be performed before links are admitted into the remote copy
target system. The test will run on IP or FC links. This test must be performed in two stages.
To run a test between System A and System B:
1. Start the server on System B, specifying the <N:S:P> for System B and the <dest_addr> for System A.
checkrclink startserver <N:S:P> <dest_addr>
If you are running the checkrclink test on RCFC links, note the IP address displayed in the output.
2. Start the client on the target system (System A), specifying the <N:S:P> for System A; the
<dest_addr> for System B (as an IP address for both RCIP and RCFC links); and the duration of the
test in seconds.
checkrclink startclient <N:S:P> <dest_addr> <time>
3. (Optional) To end the test before it completes, on System A, issue the following command:
checkrclink stopclient
4. After the test is complete, on System B, issue the following command:
checkrclink stopserver
To run a test between storage System A and B:
1. Start the server on storage System B, specifying the relevant <N:S:P>.
For IP ports only the IP address of storage System A should be specified.
If you are running the checkrclink test on RCFC links, note the IP address displayed in the output.
2. Start the client on storage System A, specifying the relevant <N:S:P>,the IP Address of storage
System B, and the duration of the test in seconds. For FC Links, the <dest_addr> is also specified as
an IP address, the required IP address is displayed in the output of the startserver subcommand.
By default this test will use port number 5001, however there is a optional parameter to allow the use to
specify their own port number.
checksnmp
DESCRIPTION
The checksnmp command allows a user to send an SNMPv2 test trap to the list of managers as
specified in showsnmpmgr.
92
checksnmp
SYNTAX
checksnmp
AUTHORITY
•
•
Super, Service
Any role granted the snmp_check right
OPTIONS
None.
SPECIFIERS
None.
EXAMPLES
cli% checksnmp
Trap sent to the following managers:
192.168.17.10:162
192.168.17.111:1000
The following is an example for the case when there are no SNMP managers configured.
cli% checksnmp
Cannot send test trap as no manager exists
NOTES
Managers must be registered first using the addsnmpmgr on page 69 command.
The test trap is in the form of an alertNotify trap with the following varbinds:
•
•
•
•
•
•
•
•
component = "test_trap"
details = "This is a test trap sent from Storage System <system name>, Serial Number <s/n>"
nodeID = ID of the node from which the trap was issued
severity = debug (6)
timeOccurred = time when the command was issued
id = 4294967295
messageCode= 4294967295
state = autoFixed (5)
checkvv
DESCRIPTION
The checkvv command executes validity checks of VV administration information in the event of an
uncontrolled system shutdown and optionally repairs corrupted virtual volumes. It can also be used to
check one or more virtual volumes to preview the potential space savings via deduplication technology.
SYNTAX
checkvv [options] <VV_name|pattern|VV_Set>...
AUTHORITY
checkvv
93
•
•
Super, Service, Edit
Any role granted the vv_check right
OPTIONS
-y|-n
Specifies that if errors are found they are either modified so they are valid (-y) or left unmodified (-n). If
not specified, errors are left unmodified (-n).
-offline
Specifies that VVs specified by <VV_name> be offlined before validating the VV administration
information. The entire VV tree will be offlined if this option is specified.
-fixsd
Specifies that VVs specified by <VV_name> be checked for compressed data consistency. The entire tree
will not be checked; only those VVs specified in the list will be checked.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-dedup_dryrun
Launches a dedup ratio calculation task in the background that analyzes the potential space savings with
HPE 3PAR Deduplication technology if the VVs specified were in a same deduplication group. The VVs
specified must be TPVVs only.
-compr_dryrun
Launches a compression ratio calculation task in the background that analyzes the potential space
savings with HPE 3PAR Compression technology of specified VVs. Specified volumes can be TPVVs,
TDVVs, fully provisioned volumes, and snapshots.
-dedup_compr_dryrun
Launches a background space estimation task that analyzes the overall savings of converting the
specified VVs into a Compressed TDVVs. Specified volumes can be TPVVs, TDVVs, Compressed
TPVVs, fully provisioned volumes, and snapshots.
This task will display compression and total savings ratios on a per-VV basis, and dedup ratio will be
calculated on a group basis of input VVs.
SPECIFIERS
<VV_name|pattern|VV_Set>
Requests that the integrity of the specified VV is checked. This specifier can be repeated to execute
validity checks on multiple VVs. Only base VVs are allowed.
The patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
EXAMPLES
The following example offlines and fixes virtual volume test1:
cli% checkvv -y -offline test1
The following example launches a deduplication estimation task on a VV set set1:
cli% checkvv -dedup_dryrun set:set1
94
Check Commands
NOTES
Access to all domains is required to run this command.
If -n invoked without -offline for the VVs which are started, there will likely be spurious
inconsistencies due to I/O activity.
Check Commands
95
CLI Command
cli
DESCRIPTION
The cli command provides a means to set up your CLI session or to enter directly into a CLI shell.
SYNTAX
cli [options] [commands]
AUTHORITY
•
Super, Edit, Browse, Service
OPTIONS
–v
Displays the CLI client version.
–b
Displays the CLI client build level.
–h
Displays help for the cli command.
–tpdportnum <portnum>
Use <portnum> for socket instead of default. For SSL sockets default port is 5783, otherwise default port
is 5782.
–sockssl
Use SSL for socket connection. SSL will be used if either this option is specified or the TPDSOCKSSL
environment variable is set. This option cannot be used in conjunction with the -nosockssl option or the
TPDNOSOCKSSL environment variable set.
-nosockssl
Do not use SSL for socket connection. SSL will not be used if either this option is specified or the
TPDNOSOCKSSL environment variable is set. This option cannot be used in conjunction with the sockssl option or the TPDSOCKSSL environment variable set.
-certfile <certfile>
Specify the certificate file which is used to validate authenticity of CLI server. Certificate in this file must be
in PEM (Privacy Enhanced Mail) format. The default file is <certdir>/cert. See -certdir option.
NOTE:
The Windows client requires that paths containing spaces must be enclosed in quotation marks.
-certdir <certdir>
Specify the directory in which to save the certificate exception file ("excp"). When CLI server certificate is
not verified by the certificate file ("cert"), the cli looks for its information in the certificate exception file. If
not found, the cli prompts user to accept and save it in this file. Next time the cli connects to the same CLI
server without prompt. The default is $HOME/.hpe3par on UNIX based systems and %USERPROFILE%
\.hpe3par on Windows.
96
CLI Command
NOTE:
The Windows client requires that paths containing spaces must be enclosed in quotation marks.
-nocertprompt
Do not prompt user for CLI server certificate which is not verified. The cli exits with an error message. The
default is to prompt user.
–sys <sysname>
Connect to system named <sysname>. If this option is not used cli uses the value of the TPDSYSNAME
environment variable. If the TPDSYSNAME environment variable is not set, the cli prompts the user for
the system name.
–cmdloop
Enter interactive command loop after executing commands specified on command line.
–hafter <nlines>
Prints a header after <nlines> of data. (Not available before version 2.2)
–nohdtot
Do not print header and totals. (Not available before version 2.2)
–csvtable
Prints table data as Comma Separated Values (CSV). (Not available before version 2.2)
–listdom
Include domain column where relevant. (Not available before version 2.2.3)
–clientname
Name of the client application. (Not available before version 3.1.1)
–clientver
Version of the client application. (Not available before version 3.1.1)
–clienthost
Name of the host the client application runs on. (Not available before version 3.1.1)
-conntimeout
The maximum time in seconds to establish the connection to the CLI server. It defaults to 36 seconds if
not set. (Not available before version 3.1.2)
-enherror
If set, perform enhanced error handling. (Not available before version 3.1.3)
-noenherror
If set, do not perform enhanced error handling. (Not available before version 3.1.3)
-matchbulkobjs
If set, perform operations on bulk VV patterns.
SPECIFIERS
[commands]
Any CLI command. This specifier is not required when issuing the cli command. If commands are
specified, the CLI exits after executing the commands unless the -cmdloop option is specified. If no
commands are specified in the command line, CLI enters the command loop.
CLI Command
97
ENVIRONMENT VARIABLES
TPDSOCKSSL
If set, use an SSL socket.
TPDNOSOCKSSL
If set, do not use an SSL socket.
TPDCERTFILE
Certificate file. Overridden by the -certfile option.
NOTE:
The Windows client requires that paths containing spaces must be enclosed in quotation marks.
TPDCERTDIR
Directory in which to save certificate exception file. Overridden by the -certdir option.
NOTE:
The Windows client requires that paths containing spaces must be enclosed in quotation marks.
TPDNOCERTPROMPT
If set, do not prompt user for CLI server certificate which is not verified. The cli exits with an error
message.
TPDSYSNAME
System to connect to. Overridden by the -sys option.
TPDCACHEDIR
Directory in which to cache the client bytecode.
TPDSTARTFILE
File containing code that is executed before any command line commands are executed or the interactive
command loop is entered. This file normally contains customization scripts.
TPDHAFTER
Number of lines after which the header is printed again. Overridden by the -hafter option. (Not available
before version 2.2)
TPDNOHDTOT
If set, do not print headers and totals. (Not available before version 2.2)
TPDCSVTABLE
If set, print table data as comma separated values (CSV). (Not available before version 2.2)
TPDLISTDOM
If set, include domain column where relevant. (Not available before version 2.2.3)
TPDCLIENTNAME
Client application name. Overridden by the -clientname option. (Not available before version 3.1.1)
TPDCLIENTVER
Client application version. Overridden by the -clientver option. (Not available before version 3.1.1)
TPDCLIENTHOST
98
CLI Command
The host the client application runs on. Overridden by the -clienthost option. (Not available before version
3.1.1)
TPDCONNTIMEOUT
The maximum time in seconds to establish the connection to the CLI server. Overridden by the conntimeout option. This timer defaults to 36 seconds if not set. (Not available before version 3.1.2)
TPDFORCE
If set, do not ask for confirmation.
TPDCLIENHERROR
If set to 1, perform enhanced error handling. If set to 0, do not perform enhanced error handling. (Not
available before version 3.1.3)
TPDMATCHBULKOBJS
If set, perform operations on bulk VV patterns.
EXAMPLES
None.
NOTES
None.
CLI Command
99
Compact Commands
compactcpg
DESCRIPTION
The compactcpg command consolidates logical disk space in Common Provisioning Groups (CPGs) into
as few logical disks as possible, allowing unused logical disks to be removed and their space reclaimed.
SYNTAX
compactcpg [options] <CPG_name>...
compactcpg -pat [options] <pattern>...
AUTHORITY
•
•
Super, Edit
Any role granted the cpg_compact right
OPTIONS
-pat
Compacts CPGs that match any of the specified patterns. This option must be used if the pattern specifier
is used.
-waittask
Waits for any created tasks to complete.
-trimonly
Removes unused logical disks after consolidating the space. This option will not perform any region
moves.
-nomatch
Removes only unused logical disks whose characteristics do not match the growth characteristics of the
CPG. Must be used with the -trimonly option. If all logical disks match the CPG growth characteristics, this
option has no effect.
-dr
Specifies that the operation is a dry run, and the tasks are not actually performed.
-f
Does not ask for confirmation before compacting the logical disks.
Unless the -f option is specified, the command asks for confirmation before compacting each CPG.
SPECIFIERS
<pattern>...
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) This specifier can be repeated to compact multiple CPGs. If this specifier is not
used, the <CPG_name> specifier must be used.
<CPG_name>...
Specifies the name of the CPG. Multiple CPGs can be specified.
EXAMPLES
100
Compact Commands
The following example shows how to compact a single CPG named testcpg and remove any unused
logical disks after consolidating the space:
cli% compactcpg -trimonly testcpg
Are you sure you want to compact CPG 'testcpg' ?
select q=quit y=yes n=no: y
Task 612 started
NOTES
Logical disks that are consolidated must have the same owner and backup nodes.
If one logical disk exists with a different owner and backup node, that logical disk will be compacted
individually.
Use -dr (dry run option) to determine whether or not to use the -nomatch option. The -nomatch option
should be used to preserve space in matching logical disks so that a future compactcpg can move data
from non-matching logical disks into those matching logical disks.
compactld
DESCRIPTION
The compactld command consolidates space on the LDs.
SYNTAX
compactld [options <arg>] <LD_name>...|<pattern>...
AUTHORITY
•
•
Super, Edit
Any role granted the ld_compact right
OPTIONS
-pat
Compacts the LDs that match any of the specified patterns.
-cons
This option consolidates regions into the fewest possible LDs.
When this option is not specified, the regions of each LD will be compacted within the same LD.
-waittask
Waits for any created tasks to complete.
-taskname <taskname>
Specifies a name for the task. When not specified, a default name is chosen.
-dr
Specifies that the operation is a dry run, and the tasks will not actually be performed.
-f
Does not ask for confirmation before compacting the LDs. Unless the -f option is specified, the command
asks for confirmation before compacting each LD.
-trimonly
compactld
101
Only unused LD space is removed. Regions are not moved.
SPECIFIERS
<LD_name>...
Specifies the name of the LD to be compacted. Multiple LDs can be specified.
<pattern>...
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) This specifier can be repeated to compact multiple LDs. If this specifier is not
used, the <LD_name> specifier must be used.
EXAMPLES
In the following example, LD pdsld0.0 is compacted:
cli% compactld -f pdsld0.0
Compacting LDs:
pdsld0.0
NOTES
None.
102
Compact Commands
Control Commands
controlencryption
DESCRIPTION
The controlencryption command provides various commands to control encryption.
SYNTAX
controlencryption backup <filename>
controlencryption checkekm [-all]
controlencryption enable [-ekm] <filename>
controlencryption rekey <filename>
controlencryption restore <filename>
controlencryption setekm -addserver <hostname|IP> <filename>
controlencryption setekm -ekmpass <filename>
controlencryption setekm -ekmuser <username> <filename>
controlencryption setekm -port <port> <filename>
controlencryption setekm -removeserver <hostname|IP> <filename>
controlencryption setekm -setserver <hostname|IP> <filename>
controlencryption status [options]
SUBCOMMANDS
backup
Specifies to backup the keystore.
checkekm
Verifies communication with at least one External Key Management server.
When -all is specified, verifies all External Key Management servers.
enable
Specifies to enable encryption. When -ekm is specified, the External Key Management server is used
instead of Local Key Management.
rekey
Specifies to rekey the Self Encrypting Drives (SEDs).
restore
Specifies to restore the keystore.
setekm -addserver
Specifies hostname(s) or IP(s) of External Key Management server(s) These servers are added to the list
of already configured servers. Multiple EKM servers can be specified using a comma separated list. Up to
four EKM servers can be defined.
setekm -ekmpass
Prompts for the password for the External Key Management server user.
Control Commands
103
setekm -ekmuser
Specifies the External Key Management server username.
setekm -port
Specifies port used to communicate with External Key Management server.
setekm -removeserver
Specifies hostname(s) or IP(s) of External Key Management server(s) These servers are removed from
the list of already configured servers.
Multiple EKM servers can be specified using a comma separated list.
setekm -setserver
Specifies hostname(s) or IP(s) of External Key Management server(s) Multiple EKM servers can be
specified using a comma separated list.
status
Specifies to list the current encryption status.
AUTHORITY
•
•
•
•
Super
Any role granted the control_encryption right
Super, Service (for status subcommand only)
Any role granted the control_encryption_status right
OPTIONS
-d
Provides details on the encryption status.
SPECIFIERS
<filename>
Specifies the name of the file in which to place the backup or the source of the file to restore.
<hostname|IP>
Specifies a server fully qualified domain name or IP address. Multiple servers can be specified using a
comma separated list.
EXAMPLES
The following example backs up the keystore to file backup1:
cli% controlencryption backup backup1
The following example restores the keystore from file backup1:
cli% controlencryption restore backup1
The following example configures an External Key Management server:
104
Control Commands
cli% controlencryption setekm -setserver ekm.example.com -port 9001
-ekmuser username backup1
Use the following to get a description of each column in the above examples:
clihelp -col controlencryption
NOTES
Access to all domains is required to run this command.
The keystore MUST be backed up to prevent total loss of data.
A password must be supplied (twice) on backup. The same password must be supplied on restore.
Because the backup needs to be stored off the nodes, all subcommands other than status need to be
executed using a version of the CLI running on a remote system.
IMPORTANT:
Backups when running with an External Key manager are for configuration information ONLY! While
this file is still important, as it is necessary to recover from a disaster, the keys are stored ONLY on
the EKM, and must be backed up independently. Also, when configuring the EKM and before
encryption is enabled, a backup filename is not required.
The Data Encryption license is required to use the enable subcommand. Also all disks must be SED.
For enable and rekey, there must be no failed disks.
If the state shows recovery_needed, the enable or latest rekey operation failed. Re-issue the operation to
fix this state.
controliscsiport
DESCRIPTION
The controliscsiport command is used to set properties of an iSCSI port.
SYNTAX
The syntax for the controliscsiport command can be one of the following:
controliscsiport addr <IP_address> <netmask|prefix_len> [-vlan <vlan_tag>] [f] <node:slot:port>
controliscsiport gw <gw_address> [-vlan <vlan_tag>] [-f] <node:slot:port>
controliscsiport mtu <mtusz_bytes> [-vlan <vlan_tag>] [-f] <node:slot:port>
controliscsiport isns <isns_address> [-vlan <vlan_tag>] [-f] <node:slot:port>
controliscsiport isnsport <isns_port> [-vlan <vlan_tag>] [-f]
<node:slot:port>
controliscsiport delete [-vlan <vlan_tag>] [-f] <node:slot:port>
controliscsiport ping [<count>] <ipaddr> [-vlan <vlan_tag>] <node:slot:port>
controliscsiport stgt <sendtgt_grp> [-vlan <vlan_tag>] [-f] <node:slot:port>
controliscsiport
105
SUBCOMMANDS
addr
Sets the IPv4 address and netmask, or IPv6 address and prefix length of the iSCSI port.
gw
Sets the gateway address of the iSCSI port.
mtu
Sets the maximum transmission unit (MTU) size for the iSCSI port.
isns
Sets the iSNS server IP address.
isnsport
Sets the TCP port number for the iSNS server. By default, the default iSNS port number is used.
delete
Deletes the iSCSI port configuration.
ping
Pings the specified IP address a specified number of times from the iSCSI port.
stgt
Sets the SendTargets Group Tag (STGT) for the iSCSI port.
AUTHORITY
•
•
Super, Service
Any role granted the port_control right
OPTIONS
-f
Do not ask for confirmation. The default is to ask for confirmation.
SPECIFIERS
<IP_address>
Indicates the IP address of the iSCSI target.
<netmask>
Indicates the IP netmask of the IPv4 iSCSI target.
<prefix_len>
Indicates the IP prefix length of the IPv6 iSCSI target.
<gw_address>
Indicates the IP address of the gateway.
<mtusz_bytes>
Indicates the MTU size in bytes.
<isns_address>
Indicates the IP address of the iSNS server.
<isns_port>
Indicates the TCP port number of the iSNS server. The default port number is 3205.
106
Control Commands
<count>
Indicates the number of ping packets to send. If a value is specified, it should be an integer from 1
through 64. If a value is not specified, the default is one packet.
<sendtgt_grp>
Indicates the STGT of the iSCSI target. <sendtgt_grp> is an integer in the range [0-65535].
<vlan_tag>
Indicates the VLAN tag number (1 to 4094).
<node:slot:port>
The physical location of the iSCSI target port.
EXAMPLES
In the following example, iSCSI port configuration is deleted:
cli% controliscsiport delete -f 1:1:1
NOTES
Access to all domains is required to run this command.
Issuing controliscsiport will return an error on a dual-port QLogic CNA card if either port is
configured in FCoE protocol.
controlmag
DESCRIPTION
The controlmag command takes drive magazines, or disk drives within a magazine, either on-loop or
off-loop. Use this command when replacing a drive magazine or disk drive within a drive magazine.
SYNTAX
controlmag offloop|onloop [options] <cage_name> <magazine>
SUBCOMMANDS
offloop|onloop
Specifies that the specified drive magazine or disk drive is either taken off-loop or brought back on-loop.
AUTHORITY
•
•
Super, Service
Any role granted the mag_control right
OPTIONS
-disk <disk_number>
Specifies that the operation is performed on the disk as determined by its position within the drive
magazine. If not specified, the operation is performed on the entire drive magazine.
-port a|b|both
Specifies that the operation is performed on port A, port B, or both A and B. If not specified, the operation
is performed on both ports A and B.
-f
controlmag
107
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<cage_name>
Specifies the name of the drive cage. Drive cage information can be viewed by issuing the showcage on
page 425 command.
<magazine>
Specifies the drive magazine number within the drive cage. Valid formats are
<drive_cage_number>.<drive_magazine> or <drive_magazine> (for example 1.3 or 3, respectively).
EXAMPLES
The following example requests that drive magazine 1 in drive cage cage0 be put on loop:
cli% controlmag onloop cage0 1
NOTES
Access to all domains is required to run this command.
Taking a drive magazine off-loop has the following consequences:
•
•
•
Relocation of chunklets.
Affected logical disks are put into write-through mode.
Momentary dip in throughput, but no loss of connectivity.
controlpd
DESCRIPTION
The controlpd command spins a PD up or down. This command is used when replacing a PD in a
drive magazine.
SYNTAX
controlpd spinup|spindown [options] <WWN>...
SUBCOMMANDS
spinup
Specifies that the PD is to spin up. If this subcommand is not used, then the spindown subcommand must
be used.
spindown
Specifies that the PD is to spin down. If this subcommand is not used, then the spinup subcommand must
be used.
AUTHORITY
•
•
Super, Service
Any role granted the pd_control right
OPTIONS
-ovrd
Specifies that the operation is forced, even if the PD is in use.
108
controlpd
SPECIFIERS
<WWN>...
Specifies the World Wide Name of the PD. This specifier can be repeated to identify multiple PDs.
EXAMPLES
The following example instigates the spin up of a PD identified by its WWN of 2000000087002078:
cli% controlpd spinup 2000000087002078
NOTES
Access to all domains is required to run this command.
The spin down operation cannot be performed on a PD that is in use unless the -ovrd option is used.
Issuing the controlpd command puts the specified disk drive in a not ready state. Further, if this
command is issued with the spindown subcommand, data on the specified drive becomes inaccessible.
controlport
DESCRIPTION
The controlport command controls all aspects of a Fibre Channel, Remote Copy, or File Persona port,
including the port's connection type and data rate. The controlport rcip and controlport rcfc
commands are required for setting up Remote Copy interfaces.
SYNTAX
The syntax for the controlport command can be one of the following:
controlport cl2 <cl2val> [-f] <node:slot:port>... (deprecated usage)
controlport config <connmode> [-ct <ctval>] [-unique_nwwn enable|disable] [virt_ports <num_virt_ports>] [-f] <node:slot:port>...
controlport ct <ctval> [-f] <node:slot:port>... (deprecated usage)
controlport failback <node:slot:port>...
controlport failover <node:slot:port>...
controlport fs add [-f] <node:slot:port>...
controlport fs delete [-f] <node:slot:port>...
controlport fs speed <value> {half|full} <node:slot:port>...
controlport fs speed auto <node:slot:port>...
controlport fs state {up|down} [-f] <node:slot:port>...
controlport intcoal <intcoalval> [-f] <node:slot:port>...
controlport label <port_label> [-f] <node:slot:port>...
controlport lip [-c <cagename>] [-portwwn <wwn>] [-f] <node:slot:port>...
controlport login <portwwn> [-f] <node:slot:port>...
controlport logout <portwwn> [-f] <node:slot:port>...
controlport nssync [-f] <node:slot:port>...
controlport offline <node:slot:port>...
controlport
109
controlport rate <rateval> [-f] <node:slot:port>...
controlport rcfc init [-f] <node:slot:port>
controlport rcfc delete [-f] <node:slot:port>
controlport rcip add [-f] <IP_address> <netmask> <node:slot:port>...
controlport rcip addr [-f] <IP_address> <netmask> <node:slot:port>...
controlport rcip gw [-f] <gateway_address> <node:slot:port>...
controlport rcip delete [-f] <node:slot:port>...
controlport rcip mtu <MTU_size> <node:slot:port>...
controlport rcip ping [-c <count>|-w <wait>|-s <size>|-pf] <IP_address>
<node:slot:port>...
controlport rcip speed <value> {half|full} <node:slot:port>...
controlport rcip speed auto <node:slot:port>...
controlport rcip state {up|down} [-f] <node:slot:port>...
controlport rst [-m <mode>|-l|-i] [-f] <node:slot:port>...
controlport tmwo (enable|disable) [-f] <node:slot:port>...
controlport vcn <vcnval> [-f] <node:slot:port>...
SUBCOMMANDS
cl2
Specifies the Fibre Channel Class-2 parameter of the port. The specified port will be reset. Note that this
subcommand is deprecated and will be removed in a subsequent release.
config
Sets the specified connection mode and type on FC ports. Also allows setting the unique node WWN
option for the port. When unique_nwwn is enabled, the port presents a unique node name on the
connection, which is needed by certain initiators such as ONTAP. This command is also used to configure
the mode of a CNA port. When configuring a peer port, the command can be used to create or remove
virtual peer ports.
ct
Sets the connection type. The specified port will be reset.
Note that this subcommand is deprecated and will be removed in a subsequent release.
failover
Fails the specified port over to a failover partner port using the virtual ports mechanism, if a valid partner
port is present.
failback
Reverts a port failover using the persistent ports mechanism, if port failover is currently active. The failedover port should be specified with this command.
fs add
Adds one or more specified ports as File Persona interfaces.
fs delete
Deletes one or more specified File Persona interfaces.
fs speed
110
Control Commands
Instructs the specified File Persona interface(s) to use the specified speed and duplex, or to auto
negotiate speed and duplex. The default is auto. Only for File Persona interfaces.
fs state {up|down}
Sets the specified File Persona interface(s) as either up or down.
intcoal
Enables or disables interrupt coalescing. The specified port will be reset.
label
Associates a human-readable label with the port. This subcommand is not supported with RCIP ports.
lip
Specifies that a Loop Initialization Primitive (LIP) command is issued from the port if there is a private loop
topology. If the -c option is specified, then the LIP command is issued through the specified drive cage. If
there is a point-to-point topology, then the link is reset. If there is a public loop or fabric topology, then a
Registered State Change Notification (RSCN) is issued to the fabric controller. If the -portwwn option is
specified, then a selective LIP or RSCN is issued to the specified attached port.
login
Performs Fibre Channel login to an attached port, identified by port WWN.
logout
Performs Fibre Channel logout from an attached port, identified by port WWN.
nssync
Verifies current port database against the Name Server when a fabric is attached. Entries present in the
database but missing from the Name Server are removed. Using this command is not required under
normal circumstances.
offline
Holds the specified port offline indefinitely. Issue controlport rst to bring the port back online.
rate
Specifies the data rate of the Fibre Channel port. The specified port will be reset.
rcfc init
Sets the specified Remote Copy interface on the local port. Only for RCFC ports.
rcfc delete
Deletes the configuration for the Remote Copy interface on the local port. This will bring the interfaces
down.
rcip add
Configures the given network port for Remote Copy with the specified IP address and netmask.
rcip addr
Sets the given Remote Copy interface to use the specified IP address and netmask.
rcip gw
Sets the gateway for one or more Remote Copy interfaces. Only for RCIP ports.
rcip delete
Deletes the configuration for one or more specified Remote Copy interfaces.
rcip mtu
Control Commands
111
Sets the Maximum Transfer Unit (MTU) size for the specified Remote Copy interface(s), overriding the
default of 1500. The largest supported value is 9000 and the smallest is 1000. Only for RCIP ports.
rcip ping
Performs a ping from the specified interface to the specified address.
Only for RCIP ports. Permitted for Super, Service, Edit, and Browse users.
rcip speed
Instructs the specified Remote Copy interface(s) to use the specified speed and duplex, or to auto
negotiate speed and duplex. The default is auto. Only for RCIP ports.
rcip state {up|down}
Sets the specified Remote Copy interface(s) as either up or down. Only for RCIP ports.
rst
Resets a port. This subcommand is not applicable to RCIP ports.
tmwo
Enables or disables target mode write optimization. The specified port will be reset.
vcn
Sets the VLUN Change Notification (VCN) generation support (enable or disable). When VCN generation
support is enabled with a public loop or fabric topology, a RSCN message is issued to the fabric controller
whenever a VLUN is created or removed. In addition, if enabled with a public loop topology, a LIP is
issued from the port whenever a VLUN is created or removed.
AUTHORITY
•
•
Super, Service
Any role granted the port_control right
OPTIONS
-c
When used with the lip subcommand:
•
-c <cage_name>
If using a private loop topology, a LIP command is issued from the port. If a cage is specified using the
<cage_name> argument, the LIP is issued through the cage controller. If using a point-to-point
topology, the link is reset. If using a public loop or fabric topology, a RSCN message is issued to the
fabric controller.
When used with the rcip ping subcommand:
•
-c <count>
Specifies the number of replies accepted by the system before terminating the command. The default
is 1; the maximum value is 25.
-ct
Sets the connection type. The specified port will be reset.
-unique_nwwn enable|disable
Enable or disable the use of a unique node wwn on the specified port.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
112
Control Commands
-i
Forces a mode change for a port even if the port's mode change value is prohibited. The partner port's
mode is changed with this option as well. Use with the controlport rst command. This option cannot
be used with the -l option.
-l
Forces the port to reload firmware. This option can only be used with the rst subcommand and cannot be
used with the -i option.
-m <mode>
This option can only be used with the rst subcommand. Resets the mode of the port. The port can be
reset to a target or initiator mode. If not specified, the port is reset to its current mode. If the port's mode
change value is prohibited, this command fails when attempting to reset to a different mode. Use
showport -c to see whether mode change is allowed or prohibited for a particular port. See NOTES for
additional information regarding port pair protection. This option is deprecated and will be removed in a
later release. Use controlport config to set target (host) or initiator (disk) modes.
-pf
Prevents packet fragmentation. This option can only be used with the rcip ping subcommand.
-portwwn <wwn>
Specifies the Fibre Channel worldwide port name of an attached device for which selective LIP reset will
be performed.
-s <size>
Specifies the packet size. If no size is specified, the option defaults to 64. This option can only be used
with the rcip ping subcommand.
-virt_ports <num_virt_ports>
Specifies the creation/removal of virtual peer ports while configuring a port using the controlport
config peer command.
If the number of virtual peer ports specified is greater than the number of existing virtual peer ports, then
additional virtual peer ports will be created to match the total num_virt_ports. The maximum number of
virtual peer ports that can be created is 8. The showport -peer command displays the virtual peer
ports.
If the number of virtual peer ports specified is zero, then the virtual peer ports are removed.
-w <wait>
Specifies the maximum amount of time to wait for replies. The default is the number of requested replies
plus 5. The maximum value is 30. This option can only be used with the rcip ping subcommand.
SPECIFIERS
<cl2val>
Specifies the Fibre Channel Class-2 parameter of the port. Parameters can be one of ack0, ack1, or
disable. This specifier must be provided when issuing the cl2 subcommand.
Note that this specifier is deprecated and will be removed in a subsequent release.
<connmode>
Specifies whether the port is used for a disk, host, peer, Remote Copy over Fibre Channel (rcfc), iSCSI
(iscsi) or Fibre Channel over Ethernet (fcoe) connection. This specifier must be used when issuing the
config command.
<ctval>
Control Commands
113
Specifies the connection parameter of the port. Parameters can be loop, or point. The loop parameter
sets the port to arbitrated loop mode, the point parameter sets the port to point-to-point mode. This
specifier must be provided when issuing the ct subcommand.
<gateway_address>
Specifies the gateway address for a Remote Copy interface.
<impval>
Specifies the IMP port attribute. The IMP value can be set as enable or disable. This specifier must be
used when issuing the imp subcommand.
<intcoalval>
Specifies if interrupt coalescing is enabled or disabled. The value can be set as enable or disable. This
specifier must be used with the intcoal subcommand.
<IP_address>
Specifies the IP address for a Remote Copy interface.
<MTU_size>
Specifies the MTU size for a Remote Copy interface using an integer from 1000 through 9000.
<netmask>
Specifies the netmask for a Remote Copy interface.
<node:slot:port>
Specifies the port to be controlled.
node
Specifies the node using a number between 0 and 7.
slot
Specifies the PCI slot in the specified node. Valid range is 0 - 9.
port
Specifies the port using a number from 1 through 4.
<port_label>
Specifies the value of the port label. The port label value is a human-readable string used for easy
identification of the port.
<portwwn>
Specifies the Fibre Channel worldwide port name of an attached port. This specifier is used with the login
and logout subcommands.
<rateval>
Specifies the data rate of the Fibre Channel port. Rates can be 1, 2, 4, 8, 16, 32, or auto. 1 sets the data
rate to 1 Gbps. And similarly for the other rates. The auto parameter sets the port to auto detect the data
rate. This specifier must be used when issuing the rate subcommand.
<value> {half|full}
Use only with the rcip speed subcommand. Specifies the speed setting (1000) and duplex setting (half or
full) for a Remote Copy interface. In addition to this specifier, you must also specify an interface using
<node:slot:port>. If no speed or duplex settings are specified, or if you specify auto with the rcip speed
subcommand, the system auto-negotiates the speed and duplex.
<vcnval>
114
Control Commands
Specifies the value of the VCN. The VCN value can be set to enable or disable. This specifier must be
used when issuing the vcn subcommand.
EXAMPLES
The following example shows how to increase MTU to 9000 on Gigabit Ethernet port 1 in node 6, slot 3:
cli% controlport rcip mtu 9000 6:3:1
Remote Copy change successful.
The following example shows how to set Remote Copy interface 172.16.1.11 on Gigabit Ethernet port 1 in
node 6, slot 3 using a netmask of 255.255.255.0:
cli% controlport rcip addr 172.16.1.11 255.255.255.0 6:3:1
Are you sure you want to change the address for 6:3:1?
select q=quit y=yes n=no: y
Remote Copy interface change successful.
The following example shows how to set the gateway for Gigabit Ethernet port 1 in node 6, slot 3 using a
gateway address of 172.16.1.1:
cli% controlport rcip gw 172.16.1.1 6:3:1
Are you sure you want to change the gateway for 6:3:1?
select q=quit y=yes n=no: y
Remote Copy interface change successful.
The following examples show usage of controlport config:
controlport
controlport
controlport
controlport
controlport
controlport
controlport
config
config
config
config
config
config
config
host -ct point 1:3:1
host -unique_nwwn enable 1:2:3
rcfc 0:0:1
disk 2:2:2
iscsi 1:8:1
peer -ct point 1:5:1
peer -virt_ports 8 3:2:1
NOTES
Access to all domains is required to run this command.
The -m <mode> option for the rst subcommand cannot be specified if there are active connections
already using the port (port online) except as noted in the following section under port pair protection.
Port pair protection:
Control Commands
115
•
•
•
For dual-port LSI Fibre Channel adapters, both ports in the pair must use the same mode (initiator or
target).
For quad-port LSI Fibre Channel adapters, each port pair (ports 1 and 2, ports 3 and 4) must use the
same mode.
Changing the mode of one port in a pair (for example, from initiator to target) causes the other port in
the pair to undergo a mode as well.
If there are active hosts or physical disks when issuing the controlport rst or offline commands,
a warning is returned and you are prompted for confirmation to complete the execution of the commands.
When issuing the controlport ct, cl2, rate, or vcn commands, if there are active disks on the port,
an error is returned. If there are active hosts on the port, the -f option is overridden (if specified), a
warning is returned, and you are prompted for confirmation to complete the execution of the commands.
When issuing the controlport cl2 or vcn commands, if the port is configured as peer connection
mode, an error is returned.
The controlport rcip add command is only allowed for node/slot/port combinations where there is
an interface installed.
The controlport rcip addr command is only allowed for node/slot/port combinations where there is
an interface installed.
Controlport config mode changes are not allowed when ports are online.
Removing virtual peer ports through controlport config peer -virt_ports 0 is not allowed
when the port is online.
Controlport config mode change to FCoE on dual-port QLogic CNA card will only successfully complete if
both iSCSI ports are unconfigured using controliscsiport addr (setting IP address and netmask to
zero values) or delete subcommands.
The ct, cl2, or rate subcommands automatically resets the port for the changes to take effect.
Issue the showport on page 502 command with either the -i or -par options to verify the success of the
controlport command.
Resetting a port causes a momentary dip in throughput, but no loss of connectivity.
The -f flag forces the operation. Without the flag, the command prompts for confirmation. In some cases,
unless the TPDFORCE_OVERRIDE environment variable is set, the command will ask for confirmation
even if the -f flag is specified because the operation may disrupt the system operation.
Use caution when changing modes for ports in LSI Fibre Channel adapters.
Changing the mode of one port in a pair (for example, from initiator to target) causes the other port in the
pair to also undergo a mode change. In the case where one port in the pair is offline (and therefore a
mode change can be allowed), but the partner port is online, changing the mode of the offline port causes
the online partner port to undergo mode change as well.
This results in loss of use of the partner port because it is no longer online.
Issuing the controlport rst -l command affects both ports of a port pair.
Only use this command when irreversible damage has been done to a port or port pair.
If specified, <ctval> will depend on <connmode> value:
•
•
•
•
•
•
116
If <connmode> is "disk" then <ctval> can only be "loop".
If <connmode> is "rcfc", then <ctval> can only be "point".
If <connmode> is "host", then <ctval> can be either "loop" or "point".
If <connmode> is "peer", then <ctval> can only be "point".
If <connmode> is "iscsi", then <ctval> can only be "point".
If <connmode> is "fcoe", then <ctval> can only be "point".
Control Commands
controlrecoveryauth
DESCRIPTION
The controlrecoveryauth command controls the method used to authenticate recovery accounts.
SYNTAX
controlrecoveryauth ciphertext <user>[,<user>]
controlrecoveryauth rollcred <user>[,<user>]
controlrecoveryauth setmethod ciphertext|totp
controlrecoveryauth status
SUBCOMMANDS
ciphertext <user>[,<user>]
Exports the user's Ciphertext for decryption by HPE Support.
rollcred <user>[,<user>]
Generates a new random password for the user if the StoreServ is in ciphertext mode.
setmethod ciphertext|totp
Changes the method of authentication. The two methods are described in the notes.
status
Returns the current authentication method.
AUTHORITY
•
•
•
•
Super
Any role granted the recoveryauth_control right
Super, Service (for status subcommand only)
Any role granted the recoveryauth_status right
OPTIONS
None.
SPECIFIERS
None.
EXAMPLES
None.
NOTES
Time-based One-Time Passwords (TOTP)—Random passwords are generated by HPE Support, they are
only valid for a single StoreServ and for a short period of time. TOTP is the default method.
Ciphertext—Random passwords are generated and encrypted by the StoreServ. The Ciphertext must be
decrypted by HPE Support.
The controlrecoveryauth command only manages accounts used by HPE support for console port
access.
controlsr
DESCRIPTION
The controlsr command manipulates the System Reporter utility.
controlrecoveryauth
117
SYNTAX
controlsr export [options]
controlsr grow <size>
controlsr grow -pct <percentage>
controlsr restore
controlsr setperiod [options] {hires|ldrg} <target_period>
controlsr setretention [options] <category> <target>[-<max>]
controlsr enable <data_type>[,<data_type>...]
controlsr disable <data_type>[,<data_type>...]
SUBCOMMANDS
export
Export a portion of the System Reporter data for external analysis.
grow
Increase the SR data storage space, allowing for longer data retention.
restore
Promote the .srdata snapshot to the .srdata volume.
setperiod [-estimate] {hires|ldrg} <target_period>
Changes the target period between samples of the hires or ldrg data categories. The hires data may have
a period between 1 minute and 5 minutes in full minute increments, specified as "1m" or "2m", etc. The
ldrg data (used by Adaptive Optimization) will be sampled at a 30 minute period, but changing the target
period specifies that the data samples may be thinned to a longer target period at the target retention
time. The available ldrg periods are "30m", "1h", "3h", "12h", and "24h".
setretention [-estimate] <category> <target>[-<max>]
Change the historical retention characteristics of different categories of System Reporter data. The
available categories are "hires", "hourly", "daily", and "ldrg". The target retention specifies a duration of
history for the data age-out algorithm to balance storage space between categories. The retention max
specifies a maximum retention duration for that category's data, beyond which historical data will be
removed. The data age-out algorithm balances the requests for multiple category retention targets, and
may not be able to achieve one or more of the retention targets. Retention target and max durations are
specified in either days (suffix d) or years (suffix y), e.g. "10d", "90d", or "2.5y" By default there is not a
max limit placed on any category. To remove the max setting from a category use a duration of 0, e.g.
"setretention hourly 90d-0"
enable <data_type>[,<data_type>...]
disable <data_type>[,<data_type>...]
Certain types of data can be disabled from being collected and reported by the System Reporter in order
to save storage space and processing time. The data types which can currently be disabled and enabled
are "fs", "bulkobjs", and "ldrg". Adaptive Optimization will not be possible while ldrg data type is disabled.
If there is only one class of disks in the system and AO will not be useful, disabling the ldrg data sampling
will free up a significant portion of the SR data storage space for other data.
AUTHORITY
•
Super, Service.
OPTIONS
The controlsr export subcommand requires one of the following options:
118
Control Commands
-ldrg
Export the LD region access data which Adaptive Optimization uses.
This output can be required for HPE 3PAR to analyze unexpected AO behavior. The output file can be
very large, so it is important to carefully select the required time range.
-hires
Export all of the System Reporter space and performance data at the highest available resolution, 5
minute samples.
-hourly
Export all of the System Reporter space and performance data at hourly resolution.
-daily
Export all of the System Reporter space and performance data at daily resolution.
-all
Export all of the System Reporter space and performance data for the hires, hourly, daily, and ldrg
categories together.
-ldrgsum
Export a summary of the LD region accesses. This export file format is used by the R3Tools utility to
perform analysis and modelling of the Adaptive Optimization configuration.
-cleanup
Use this option to remove an export file from the node if there was a problem with the automatic deletion.
The -cleanup option will only remove a previous export archive file if it is not being accessed. If the file is
being accessed, it may still be in the process of copying off of the node. Use the -f option to force the file
deletion if it is not being copied, but-cleanup will not proceed.
These options are also available to the controlsr export subcommand:
-btsecs <secs>
Select the begin time in seconds for the report. The value can be specified as either:
•
•
•
The absolute epoch time (for example 1351263600).
The absolute time as a text string in one of the following formats:
◦ Full time string including time zone: "2012-10-26 11:00:00 PDT"
◦ Full time string excluding time zone: "2012-10-26 11:00:00"
◦ Date string: "2012-10-26" or 2012-10-26
◦ Time string: "11:00:00" or 11:00:00
A negative number indicating the number of seconds before the current time. Instead of a number
representing seconds, <secs> can be specified with a suffix of m, h or d to represent time in minutes
(e.g. -30m), hours (e.g. -1.5h) or days (e.g. -7d).
If it is not specified then the time at which the report begins depends on the sample category (-hires, hourly, -daily):
•
•
•
For hires, the default begin time is 12 hours ago (-btsecs -12h).
For hourly, the default begin time is 7 days ago (-btsecs -7d).
For daily, the default begin time is 90 days ago (-btsecs -90d).
If begin time and sample category are not specified then the time the report begins is 12 hours ago and
the default sample category is hires. If -btsecs 0 is specified then the report begins at the earliest sample.
-etsecs <secs>
Select the end time in seconds for the report. If -attime is specified, select the time for the report. The
value can be specified as either:
Control Commands
119
•
•
•
The absolute epoch time (for example 1351263600).
The absolute time as a text string in one of the following formats:
◦ Full time string including time zone: "2012-10-26 11:00:00 PDT"
◦ Full time string excluding time zone: "2012-10-26 11:00:00"
◦ Date string: "2012-10-26" or 2012-10-26
◦ Time string: "11:00:00" or 11:00:00
A negative number indicating the number of seconds before the current time. Instead of a number
representing seconds, <secs> can be specified with a suffix of m, h or d to represent time in minutes
(e.g. -30m), hours (e.g. -1.5h) or days (e.g. -7d).
If it is not specified then the report ends with the most recent sample.
-estimate
Performs calculations to estimate the size of the output file that would be created by the export operation.
Must be used in conjunction with one of: -ldrg, -ldrgsum, -hires, -hourly, -daily, or -all. -btsecs and -etsecs
should also be included in order to create an accurate estimate.
-save
Rather than sending the export file to HPE 3PAR Central remote infrastructure, the -save option exports
the file to a location local to the machine that has initiated the remote CLI connection. This option must
also be used with -file, which specifies the export file location and name. The -save option is only
supported when the session is initiated via the Remote CLI Client.
-file <file>
Specifies the path and name to be used for the export file copied to the client system. If the value is a
directory, the default file name of exportsr_<category>_<serialnum>_<date>_<time>.tbz will be used. This
option must also be used with the -save option.
-f
When used in conjunction with the -cleanup option, the -f option forces cleanup of previous export files
that may still exist. The -f option will have no affect on any other operation of controlsr export.
-waittask
Specifies that the command will wait for any created tasks to complete.
-v
Displays the detailed status of the task as it executes. This option is only valid when combined with waittask.
This option is available to the controlsr grow subcommand:
-pct <percentage>
Allows the SR volume to be grown by a percentage of its current size.
<percentage> must be between 5 and 100.
The following options are available to the setperiod and setretention subcommands:
-estimate
Estimate the amount of history retention which will be possible if the given settings are changed.
Changing the settings of one category will affect the retention of all categories. An estimate will be
displayed for each category of data.
-f
Force the setting change without requiring confirmation when the new period or retention setting is not
estimated to be achievable.
SPECIFIERS
120
Control Commands
<size>[g|G]
Only applicable to the grow subcommand.
Specifies the size in MB to be added to the SR volume. The size must be an integer in the range from 8g
to 1T. The volume size is rounded up to the next multiple of 256M. If the value is followed by a g or G (no
whitespace before the suffix), the size is in GB.
<period>
Only applicable to the setperiod subcommand.
The hires data may have a period between 1 minute and 5 minutes in full minute increments, specified
with an m suffix: "1m", "2m", "3m", "4m", "5m". Depending on the size, configuration, and load on the
system, short hires periods may not be possible, and a warning will be presented.
The ldrg data will be sampled at a 30 minute period, but changing the target period specifies that the data
samples may be thinned to a longer period at the target retention time. The available ldrg periods are
"30m", "1h", "3h", "12h", and "24h".
<category>
In the setretention subcommand, the available categories are "hires", "hourly", "daily", and "ldrg".
In the setperiod subcommand, the available categories are "hires" and "ldrg".
<target>[-<max>]
Only applicable to the setretention subcommand.
The algorithm will attempt to meet all category target retentions. The retention max specifies a maximum
retention duration for that category's data, beyond which historical data will be removed.
The target and max retention durations are specified in either days (suffix d) or years (suffix y), e.g. "10d",
"90d", or "2.5y" To remove the max setting from a category use a value of 0.
EXAMPLES
The following example exports the hourly System Reporter data for the past 24 hours:
cli% controlsr export -hourly -btsecs -24h
The following example grows the SR volume with an increase of 40GB:
cli% controlsr grow 40G
The following example restores the latest .srdata snapshot to the .srdata volume:
cli% controlsr restore
To set the high resolution data retention target to 14 days:
cli% controlsr setretention hires 14d
Control Commands
121
To set a target and max retention of ldrg data:
cli% controlsr setretention ldrg 14d-31d
To remove a retention max use 0. The target must also be specified:
cli% controlsr setretention hourly 90d-0
To change the high resolution data sampling from the default of 5 minutes to 2 minutes:
cli% controlsr setperiod hires 2m
To change the period between ldrg samples at the target retention time from the default 30 minutes to 3
hours (leaving space for longer overall ldrg data retention):
cli% controlsr setperiod ldrg 3h
To disable the collection of any File Persona data in the System Reporter history:
cli% controlsr disable fs
NOTES
There is a size limit of 10GB of SR data to be exported per request. If the command is estimated to output
more than 10GB, the command will be rejected. Use the -btsecs and -etsecs options to define a small
enough request window such that less than 10GB of data is exported. The -estimate option can be used
to see the estimated size of output for a combination of options.
By default, the export file is copied to HPE 3PAR Central by a linked Service Processor. Use the -save
option to instead copy the file to the CLI client machine.
122
Control Commands
Create Commands
createaocfg
DESCRIPTION
The createaocfg command creates an Adaptive Optimization configuration.
SYNTAX
createaocfg [options <arg>] <aocfg_name>
AUTHORITY
•
Super, Edit
OPTIONS
-t0cpg <cpgname>
Specifies the Tier 0 CPG for this AO config.
-t1cpg <cpgname>
Specifies the Tier 1 CPG for this AO config.
-t2cpg <cpgname>
Specifies the Tier 2 CPG for this AO config.
-mode <mode>
Specifies the optimization bias for the AO config and can be one of the following:
•
•
•
Performance: Move more regions towards higher performance tier.
Balanced: Balanced between higher performance and lower cost.
Cost: Move more regions towards lower cost tier.
The default is Balanced.
-t0min <size>[g|G|t|T]
-t1min <size>[g|G|t|T]
-t2min <size>[g|G|t|T]
Specifies the minimum space utilization of the tier CPG for AO to maintain when optimizing regions
between tiers. The size can be specified in MB (default) or GB (using g or G) or TB (using t or T).
Setting a minimum to 0 (default) indicates that no minimum space utilization will be enforced.
-t0max <size>[g|G|t|T]
-t1max <size>[g|G|t|T]
-t2max <size>[g|G|t|T]
Specifies the maximum space utilization of the tier CPG. AO will move regions into and out of the CPG
based on their relative access rate history, but will not exceed this maximum size in the CPG.
The size can be specified in MB (default) or GB (using g or G) or TB (using t or T). Setting a max to 0
(default) indicates that AO will use other indicators to decide the maximum CPG space utilization:
either the CPG sdgl, sdgw, or maximum possible growth size.
SPECIFIERS
<aocfg_name>
Create Commands
123
Specifies an AO configuration name up to 31 characters in length.
EXAMPLES
The following example creates a new AO configuration called aocfg1.
The optimization bias (mode) is set to Cost. Tier 0 will use CPG R1SSDcpg, Tier 1 will use CPG
R5FCcpg and Tier 2 will use CPG R6NLcpg.
cli% createaocfg -t0cpg R1SSDcpg -t1cpg R5FCcpg -t2cpg R6NLcpg -mode Cost
aocfg1
The following example creates a new AO configuration called aocfg2.
The optimization bias is defaulted to Balanced, and no Tier 1 CPG is specified.
cli% createaocfg -t0cpg R1SSDcpg2 -t2cpg R6NLcpg2 aocfg2
NOTES
Two or more Tier CPGs must be defined.
If domains are used, all CPGs must be in the same domain or not in any.
A CPG can only belong to one AO configuration.
Active use of Adaptive Optimization requires an Adaptive Optimization license. Contact your local 3PAR
representative for information.
createcert
DESCRIPTION
The createcert command creates a self-signed certificate or a certificate signing request for a
specified service.
SYNTAX
createcert <SSL_service> {-csr|-selfsigned} [-f] [-keysize <keysize>] [-days
<days>] [<subject_attribute_options>] [<CSR_filename>]
AUTHORITY
•
Super
OPTIONS
-f
Used with -selfsigned to create a self-signed certificate and restarts the services that use the new
certificate without prompting user. When this option is not used, user is prompted before the
corresponding services are restarted.
-csr
Creates a certificate signing request for the service. No certificates are modified and no services are
restarted.
-selfsigned
124
createcert
Creates a self-signed certificate for the service. The previous certificate is removed and the service
restarted. The intermediate and/or root certificate authorities for a service are not removed.
-keysize <keysize>
Specifies the encryption key size in bits of the self-signed certificate. Valid values are 1024 and 2048. The
default value is 2048.
-days <days>
Specifies the valid days of the self-signed certificate. Valid values are between 1 and 3650 days (10
years). The default value is 1095 days (3 years).
-C <country>
Specifies the value of country (C) attribute of the subject of the certificate.
-ST <state>
Specifies the value of state (ST) attribute of the subject of the certificate.
-L <locality>
Specifies the value of locality (L) attribute of the subject of the certificate.
-O <organization>
Specifies the value of organization (O) attribute of the subject of the certificate.
-OU <organizational_unit>
Specifies the value of organizational unit (OU) attribute of the subject of the certificate.
-CN <common_name>
Specifies the value of common name (CN) attribute of the subject of the certificate. Over ssh, -CN must
be specified.
-SAN <subject_alt_name[,subject_alt_name]...>
Subject alternative name is a X509 extension that allows other pieces of information to be associated with
the certificate. Multiple SANs may be delimited with a comma.
SPECIFIERS
<SSL_service>
Valid service names are cim, cli, ekm-client, ekm-server, ldap, syslog-gen-client, syslog-gen-server,
syslog-sec-client, syslog-sec-server, wsapi, vasa, and unified-server.
EXAMPLES
The following example shows how to create a self-signed certificate. The encryption key size is 2048 bits
and the certificate is valid for 365 days:
cli% createcert unified-server -selfsigned -keysize 2048 -days 365
The following example shows how to create a self-signed certificate with multiple subject alternative
names (SANs):
cli% createcert unified-server -selfsigned \
-SAN DNS:theresnoplacelikehome.com,IP:127.0.0.1
NOTES
Note that the unified-server establishes a common certificate among cim, cli, and wsapi. Also, the CIM
and wsapi services are restarted when a self-signed certificate is generated.
Create Commands
125
Data at rest encryption using an external key manager employs the ekm-client and ekm-server services.
The external key manager services are not covered by the unified-server service.
Over ssh, -CN must be specified.
Use the importcert on page 225 command to import a signed CSR and use the showcert on page 429
command to display the certificates.
createcpg
DESCRIPTION
The createcpg command creates a Common Provisioning Group (CPG).
SYNTAX
createcpg [options <arg>] CPG_name
AUTHORITY
•
•
Super, Edit
Any role granted the cpg_create right
OPTIONS
-templ <template_name>
Use the options defined in template <template_name>. The template is created using the createtemplate
on page 173 command. Options specified in the template are read-only or read-write. The read-write
options may be overridden with new options at the time of their creation, but read-only options may not be
overridden at the time of creation.
Options not explicitly specified in the template take their default values, and all of these options are either
read-only or read-write (using the -nro or -nrw options of the createtemplate on page 173 command).
-f
Forces the command. The command completes the process without prompting for confirmation.
-aw <percent>
Specifies the percentage of used snapshot administration or snapshot data space that results in a
warning alert. A percent value of 0 disables the warning alert generation. The default is 0.
This option is deprecated and will be removed in a subsequent release.
-sdgs <size>[g|G|t|T]
Specifies the growth increment, the amount of logical disk storage created on each auto-grow operation.
The default growth increment may vary according to the number of controller nodes in the system. If
<size> is non-zero it must be 8G or bigger. The size can be specified in MB (default) or GB (using g or G)
or TB (using t or T). A size of 0 disables the auto-grow feature. The following table displays the default
and minimum growth increments per number of nodes:
126
Number of Nodes
Default
Minimum
1-2
32 GB
8 GB
3-4
64 GB
16 GB
5-6
96 GB
24 GB
7-8
128 GB
32 GB
createcpg
-sdgl <size>[g|G|t|T]
Specifies that the auto-grow operation is limited to the specified storage amount. The storage amount can
be specified in MB (default) or GB (using g or G) or TB (using t or T). A size of 0 (default) means no limit
is enforced. To disable auto-grow, set the limit to 1.
-sdgw <size>[g|G|t|T]
Specifies that the threshold of used logical disk space, when exceeded, results in a warning alert. The
size can be specified in MB (default) or GB (using g or G) or TB (using t or T). A size of 0 (default) means
no warning limit is enforced. To set the warning for any used space, set the limit to 1.
-sa <LD_name>...
Specifies that existing logical disks are added to the CPG and are used for snapshot admin (SA) space
allocation. The <LD_name> argument can be repeated to specify multiple logical disks.
This option is deprecated and will be removed in a subsequent release.
-sd <LD_name>..
Specifies that existing logical disks are added to the CPG and are used for snapshot data (SD) space
allocation. The <LD_name> argument can be repeated to specify multiple logical disks.
This option is deprecated and will be removed in a subsequent release.
-domain <domain>
Specifies the name of the domain with which the object will reside. The object must be created by a
member of a particular domain with Edit or Super role. The default is to create it in the current domain, or
no domain if the current domain is not set.
-t <RAID_type>
Specifies the RAID type of the logical disk: r0 for RAID-0, r1 for RAID-1, r5 for RAID-5, or r6 for RAID-6. If
no RAID type is specified, then the default is r6.
-ssz <size_number_chunklets>
Specifies the set size in terms of chunklets. The default depends on the RAID type specified: 2 for
RAID-1, 4 for RAID-5, and 8 for RAID-6.
-rs <size>
Specifies the number of sets in a row. The <size> is a positive integer.
If not specified, no row limit is imposed.
-ss <size_KB>
Specifies the step size from 32 KB to 512 KB. The step size should be a power of 2 and a multiple of 32.
The default value depends on raid type and device type used. If no value is entered and FC or NL drives
are used, the step size defaults to 256 KB for RAID-0 and RAID-1, and 128 KB for RAID-5.
If SSD drives are used, the step size defaults to 32 KB for RAID-0 and RAID-1, and 64 KB for RAID-5.
For RAID-6, the default is a function of the set size.
-ha port|cage|mag
Specifies that the layout must support the failure of one port pair, one cage, or one drive magazine (mag).
This option has no meaning for RAID-0. The default is cage availability.
-ch first|last
Specifies the chunklet location characteristics: either first (attempt to use the lowest numbered available
chunklets) or last(attempt to use the highest numbered available chunklets). If no argument is specified,
the default characteristic is first.
-p <pattern>
Create Commands
127
Specifies a pattern for candidate disks. Patterns are used to select disks that are used for creating logical
disks. If no pattern is specified, the option defaults to Fast Class (FC) disks. If specified multiple times,
each instance of the specified pattern adds additional candidate disks that match the pattern. The devtype pattern cannot be used to mix Nearline (NL), FC, and Solid State Drive (SSD) drives. An item is
specified as an integer, a comma-separated list of integers, or a range of integers specified from low to
high.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0- 7).
The primary path of the disks must be on the specified node(s).
-st <item>
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0- 7).
The primary path of the disks must be on the specified PCI slot(s).
-pt <item>
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0- 4).
The primary path of the disks must be on the specified port(s).
-cg <item>
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
•
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
output indicating the side of the cage is omitted when using the -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single comma
(e.g. 1,2,3). A range of drive magazines is separated with a hyphen(e.g. 0-7). The specified drive
magazine(s) must contain disks.
-pn <item>
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen(e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
•
Specifies one or more physical disks. Disks are identified by one or more integers(item). Multiple disks
are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g. 0-3).
Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
Specifies that physical disks with free chunklets greater than the number specified be selected.
-fc_lt <number>
Specifies that physical disks with free chunklets less than the number specified be selected.
128
Create Commands
•
-devid <model>
•
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the "showpd -i" command.
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd on page
491" command. If it is not specified, the default device type is FC.
-rpm <number>
Disks must be of the specified speed. Device speeds are shown in the RPM column of the showpd on
page 491 command. The number does not represent a rotational speed for the drives without
spinning media (SSD). It is meant as a rough estimation of the performance difference between the
drive and the other drives in the system. For FC and NL drives, the number corresponds to both a
performance measure and actual rotational speed. For SSD drive, the number is to be treated as
relative performance benchmark that takes into account in I/O per second, bandwidth and the access
time.
Disks that satisfy all of the specified characteristics are used.
For example -p -fc_gt 60 -fc_lt 230 -nd 2 specifies all the disks that have greater than 60 and less than
230 free chunklets and that are connected to node 2 through their primary path.
SPECIFIERS
<CPG_name>
Specifies the name of the common provisioning group being created.
EXAMPLES
The following example displays the creation of common provisioning group cpg1, whose logical disk
storage is set to auto-grow at 16 GB, has a growth limit of 32 GB, and receives a growth warning at 24
GB:
cli% createcpg -sdgs 16g -sdgl 32g -sdgw 24g cpg1
The following example displays disks that satisfy all of the specified characteristics are used. The
example specifies all the disks that have greater than 60 and less than 230 free chunklets and that are
connected to node 2 through their primary path:
cli% createcpg -p -fc_gt 60 -fc_lt 230 -nd 2
The following example specifies that all disks in cages 1 and 2 or magazine 4 of each cage will be used in
the common provisioning group:
cli% createcpg -p -cg 1-2 -p -mg 4 cpg3
NOTES
Access to all domains is required to run this command.
For this command:
Create Commands
129
•
•
•
KB = 1024 bytes
MB = 1048576 bytes
GB = 1073741824 bytes
When using the createcpg command, the size of the logical disk space created is the first integer
multiple of the RAID set size that is large enough to accommodate the requested virtual volume size. For
example, with the default RAID-5 layout with a set size of 768 MB, a requested virtual volume size of
8192 MB causes the creation of logical disks with a total size rounded up to an integer multiple of 768 that
is 8448 MB. The growth increment of CPGs is similarly rounded up because the growth is done by
creating logical disks that must be created in units of the logical disk RAID set size.
By default, logical disks are created using only physical disks with the same device type. (By default, the
Fast Class device type is used). Use the "-p -devtype NL", "-p -devtype SSD" to override this default. Use
showpd to see the device types of physical disks in the system.
The options -sdgs, -sdgl and -sdgw control the auto logical disk creation for the Common Provisioning
Group's snapshot data regions. Auto logical disk creation occurs when the amount of free logical disk
space falls below the specified grow(enlarge) size setting options (-sdgs, -sdgl).
If auto-grow is enabled, new logical disks will be created automatically in addition to any logical disks
specified with -sa or -sd options.
The following options, -t, -szs, -rs, 0ss, -ha, -ch, and -p are used to control auto logical disk creation (if
auto-grow is enabled).
If no device type is specified using the -p devtype option, Fast Class is assumed.
The following arguments, -tc_gt, -tc_lt, -fc_gt, -fc_lt, -devid, and -devtype are used to select the disks that
are used to create CPG based on the characteristics of the disk.
createdomain
DESCRIPTION
The createdomain command creates system domains.
SYNTAX
createdomain [options] <domain_name>
AUTHORITY
•
•
Super
Any role granted the domain_create right
OPTIONS
-comment <comment>
Specify any comments or additional information for the domain. The comment can be up to 511
characters long. Unprintable characters are not allowed. The comment must be placed inside quotation
marks if it contains spaces.
-vvretentiontimemax <time>{h|H|d|D}
Specify the maximum value that can be set for the retention time of a volume in this domain. <time> is a
positive integer value and in the range of 0 - 43,800 hours (1825 days). Time can be specified in days or
hours providing either the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
To disable setting the volume retention time in the domain, enter 0 for <time>.
SPECIFIERS
<domain_name>
130
createdomain
Specifies the name of the domain you are creating. The domain name can be no more than 31
characters. The name "all" is reserved.
EXAMPLES
The following example displays the creation of domain Engineering with an informational comment:
cli% createdomain -comment "This is a test domain." Engineering
NOTES
Access to all domains is required to run this command.
Use of this command requires a Domains license. Contact your local HPE representative for information.
createdomainset
DESCRIPTION
The createdomainset command defines a new set of domains and provides the option of assigning
one or more existing domains to that set. The command also allows the addition of domains to an existing
set by use of the -add option.
SYNTAX
createdomainset [options] <setname> [<domain | pattern>...]
AUTHORITY
•
•
•
Super, Edit
Any role granted the domainset_create right can create a domain set
Any role granted the domainset_set right can add domains to a domain set
OPTIONS
-add
Specifies that the domains listed should be added to an existing set. At least one domain must be
specified.
-comment <comment>
Specifies any comment or additional information for the set. The comment can be up to 255 characters
long. Unprintable characters are not allowed.
SPECIFIERS
<setname>
Specifies the name of the domain set to create or add to, using up to 27 characters in length.
<domain | pattern>...
Optional list of domains or glob-style patterns matching domains that are to be included in the domain set.
If no <domain> is specified a domain set with no domains is created.
EXAMPLES
To create a domain set with 2 domains in it:
cli% createdomainset domset domain1 domain2
createdomainset
131
An alternative method to create a domain set:
cli% createdomainset set:domset domain1 domain2
To create an empty domain set with a comment:
cli% createdomainset -comment "A placeholder set" emptyset
NOTES
Access to all domains is required to run this command.
createflashcache
DESCRIPTION
The createflashcache command creates flash cache of <size> for each node pair. The flash cache
will be created from SSD drives.
SYNTAX
createflashcache [options] <size>
AUTHORITY
•
•
Super, Edit
Any role granted the flashcache_create right
OPTIONS
-sim
Specifies that the Adaptive Flash Cache will be run in simulator mode. The simulator mode does not
require the use of SSD drives.
-t <RAID_type>
Specifies the RAID type of the logical disks for Flash Cache; r0 for RAID-0 or r1 for RAID-1. If no RAID
type is specified, the default is chosen by the storage system.
SPECIFIERS
<size>[g|G|t|T]
Specifies the size for the flash cache in MiB for each node pair. The flash cache size should be a multiple
of 16384 (16GiB), and be an integer. The minimum size of the flash cache is 64GiB. The maximum size
of the flash cache is based on the node types, ranging from 768GiB up to 12288GiB (12TiB). An optional
suffix (with no whitespace before the suffix) will modify the units to GiB (g or G suffix) or TiB (t or T suffix).
EXAMPLES
The following example shows how to create Flash Cache.
createflashcache 128g
NOTES
132
createflashcache
None.
createfpg
DESCRIPTION
The createfpg command creates a FPG of the given name and size within the specified CPG.
SYNTAX
createfpg -recover [-wait] [<vv1> <vv2> ...]
createfpg [options] <cpgname> <fpgname> <size>{t|T|g|G}
AUTHORITY
•
•
Super, Edit
Any role granted fpg_create right.
OPTIONS
-comment <comment>
Specifies the textual description of the FPG.
-full
Create the FPG using fully provisioned volumes.
-tdvv
Create the FPG using thinly deduplicated volumes.
-node <nodeid>
Bind the created FPG to the specified node.
-recover [<vv1> <vv2> ...]
Recovers the FPG which is involved in Remote DR and that was removed using the -forget option.
If VVs are specified after the -recover option, they will be attached and any FPGs on them will be
discovered. VV sets may also be specified using the set:<setname> modifier.
-wait
Wait until the associated task is completed before proceeding. This option will produce verbose task
information.
SPECIFIERS
<cpgname>
The CPG where the VVs associated with the FPG will be created
<fpgname>
The name of the FPG to be created
<size>
The size of the FPG to be created.
The specified size must be between 1T and 64T. A suffix (with no whitespace before the suffix) will modify
the units to TiB or GiB (t, T, g, or G suffix).
EXAMPLES
The following example creates an 18T FPG:
createfpg
133
cli% createfpg examplecpg examplefs 18T
The following example will attach fpg.1 to file persona, and the FPG recovered:
cli% createfpg -recover fpg.1
The following example will attach the VVs in set fpg1 to file persona and recover any discovered FPGs:
cli% createfpg -recover set:fpg1
NOTES
Access to all domains is required to run this command.
The following elements are created with each createfpg command, and the command will fail if any of
these are not available.
* a number of VVs (size determined by the FPG size) <fpgname>.n
If no node is specified, createfpg will automatically determine the node with least amount of storage
attached and bind the new FPG to this node.
The maximum length of a FPG name is 22 characters.
FPG names must not end in a .n format.
FPG names must be unique across systems using Remote Copy for replication of those FPGs. Using
duplicate names across systems will result in NFS and Object file shares being unavailable upon
recovery on the target system.
The minimum size for an FPG is 1TiB.
createfsgroup
DESCRIPTION
The createfsgroup command creates a new local group account associated with File Persona.
SYNTAX
createfsgroup [options] <groupname>
AUTHORITY
•
•
Super
Any role granted the fsgroup_create right
OPTIONS
-gid <number>
Specifies the group ID to be used.
-memberlist <string>
Specifies members of the group.
SPECIFIERS
<groupname>
Specifies the local group name using up to 256 characters. Valid characters are alphanumeric characters,
periods, dashes (except first character), and underscores.
EXAMPLES
134
createfsgroup
Create a local group named accounting specifying a GID:
cli% createfsgroup -gid 3000 accounting
NOTES
Access to all domains is required to run this command.
The -gid option can have any value between 1000 and 65535.
To access an SMB share, specify the group as "LOCAL_CLUSTER\<groupname>".
createfshare
DESCRIPTION
The createfshare command creates file shares for supported protocols.
SYNTAX
createfshare {smb|nfs|obj|ftp} [options <arg>] <vfs> <sharename>
SUBCOMMANDS
smb
Creates an SMB file share.
nfs
Creates an NFS file share.
obj
Creates an Object file share.
ftp
Creates an FTP file share.
AUTHORITY
•
•
Super, Edit
Any role granted the fshare_create right
OPTIONS
The following options are for all subcommands:
•
-fpg <fpgname>
Specifies the file provisioning group (FPG) that <vfs> belongs.
•
If this is not specified, the command will find out the FPG based on the specified <vfs>. However, if
<vfs> exists under multiple FPGs, -fpg must be specified.
-fstore <fstore>
•
Specifies the file store under which the share will be created. If this is not specified, the command
uses the <sharename> as the file store name. The file store will be created if it does not exist. If you
specify this option to create a file share, you will have to specify it when you set or remove the share
using setfshare on page 345/removefshare on page 259.
-sharedir <sharedir>
createfshare
135
•
Specifies the directory path to share. It can be a full path starting from "/", or a relative path under the
file store. If this is not specified, the share created will be rooted at the file store. If this option is
specified, option -fstore must be specified.
-comment <comment>
•
Specifies any comments or additional information for the share. The comment can be up to 255
characters long. Unprintable characters are not allowed.
-f
Specifies that the command is forced. When creating a share of a second protocol type for a given file
store, if this option is not used, the command requires confirmation before proceeding with its
operation.
The following options are specific to smb subcommand:
•
-abe {true|false}
•
Access Based Enumeration. Specifies if users can see only the files and directories to which they
have been allowed access on the shares. The default is "false".
-allowip <iplist>
•
Specifies client IP addresses that are allowed access to the share. Use commas to separate the IP
addresses. The default is "", which allows all IP addresses (i.e., empty means all are allowed).
-denyip <iplist>
•
Specifies client IP addresses that are denied access to the share. Use commas to separate the IP
addresses. The default is "", which denies none of IP addresses (i.e., empty means none is denied).
-allowperm <permlist>
Specifies the permission that a user/group is allowed to access the share. <permlist> must be
specified in the format of: "<user1>:<perm1>,<user2>:<perm2>,...". <user> can be a user or group
name. <perm> must be "fullcontrol", "read", or "change".
"Everyone" is a special user for all users and groups.
If the user is configured locally using "createfsuser", use <user> to specify the user (for example,
-allowperm user1:fullcontrol).
If the user is configured on Active Directory, use "setfs ad" to join Active Directory domain with
<domain> if it has not been done, and use "<domain>\\<user>" or "<ad-netbios>\\<user>" to
specify the user (for example, -allowperm example.com\\aduser:fullcontrol). The <adnetbios> can be found by running "showfs -ad".
If the user is configured on the LDAP server, use "setfs ldap" to create LDAP configuration with
<ldap-netbios> if it has not been done, and use "<ldap-netbios>\\<user>" to specify the user
(for example, -allowperm ldaphost\\ldapuser:read).
•
If not specified, no default permissions will be allowed for the new shares, which sets the same default
as a Windows Server 2012 R2 server would. This is to avoid a system administrator inadvertently
allowing any nonexplicitly specified user to be able to access the SMB share.
-denyperm <permlist>
Specifies the permission that a user/group is denied to access the share. <permlist> must be
specified in the format of: "<user1>:<perm1>,<user2>:<perm2>,...". <user> can be a user or
group name. <perm> must be "fullcontrol", "read", or "change".
"Everyone" is a special user for all users and groups.
If the user is configured locally using "createfsuser", use <user> to specify the user (for example,
-denyperm user1:fullcontrol).
If the user is configured on Active Directory, use "setfs ad" to join Active Directory domain with
<domain> if it has not been done, and use "<domain>\\<user>" or "<ad-netbios>\\<user>" to
136
Create Commands
specify the user (for example, -denyperm example.com\\aduser:fullcontrol). The <adnetbios> can be found running "showfs -ad".
•
If the user is configured on the LDAP server, use "setfs ldap" to create LDAP configuration with
<ldap-netbios> if it has not been done, and use "<ldap-netbios>\\<user>" to specify the user
(for example, -denyperm ldaphost\\ldapuser:read).
-audit {operation1:value1[,operation2:value2]...}
Specifies the operations to be audited at share level for SMB protocol on specified VFS. The event
can be audited based on values: success, failure, none, or all. The operations and values are case
insensitive. These operations will generate events when:
◦
◦
◦
◦
◦
◦
◦
◦
◦
•
TreeConnect: Connected to a share. To create an audit record for a user trying to access a share
that is not configured on the VFS, use the command: "setfsaudit smb -audit
Global:failure".
TreeDisconnect: Disconnected from a share. Note: Certain clients that use SMBv1 may not trigger
a TreeDisconnect when the client logs off.
Open: Open/Create a file or directory.
Close: Close a file or directory.
Rename: Rename a file or directory.
Delete: Delete a file or directory.
Read: Read from a file. Only the first read after the file was opened is reported.
Write: Write to a file. Only the first write after the file was opened is reported.
ChangeSecurity: Change security attributes.
For more details, please refer to the File Persona User Guide.
-cache {off|manual|optimized|auto}
Specifies client-side caching for offline files. Valid values are:
◦
•
"off": The client must not cache any files from this share. The share is configured to disallow
caching.
◦ "manual": The client must allow only manual caching for the files open from this share.
◦ "optimized": The client may cache every file that it opens from this share. Also, the client may
satisfy the file requests from its local cache. The share is configured to allow automatic caching of
programs and documents.
◦ "auto": The client may cache every file that it opens from this share. The share is configured to
allow automatic caching of documents. If this is not specified, the default is "manual".
-ca {true|false}
Specifies if SMB3 continuous availability features should be enabled for this share. If not specified, the
default is "true".
The following options are specific to nfs subcommand:
•
-options <options>
Specifies options to use for the share to be created. Standard NFS export options except
"no_subtree_check" are supported. Do not enter option "fsid", which is provided. If not specified, the
following options will be automatically set: sync, auth_nlm, wdelay, sec=sys, no_all_squash, crossmnt,
secure, subtree_check, hide, root_squash, ro.
In addition to the above options, below audit operations are also supported for NFS protocol on
specified VFS. The following options do not have values.
These operations will generate event when:
◦
◦
audit_open: Open a file. This is NFSv4 only.
audit_close: Close a file. This is NFSv4 only.
Create Commands
137
◦
◦
◦
◦
audit_meta: Rename a file or directory, creating a hardlink for a file, creating a file or directory and
removing a file or a directory.
audit_attr: Changing file/directory attributes.
audit_read: Read of a file/directory. Subsequent file reads are suppressed for a specific time
(currently 10m). Note that reads from a directory are never suppressed.
audit_write: Write to a file. Subsequent writes are suppressed for a specific time (currently 10m).
For more details, please refer to the File Persona User Guide.
•
See linux exports(5) man page for detailed information.
-clientip <clientlist>
Specifies the clients that can access the share. The NFS client can be specified by the name (for
example, sys1.example.com), the name with a wildcard (for example, *.example.com), or by its IP
address. Use comma to separate the IP addresses. If this is not specified, the default is "*".
The following options are specific to obj subcommand:
•
-ssl {true|false}
•
Specifies if SSL is enabled. The default is "false".
-urlpath <urlpath>
Specifies the URL that clients will use to access the share. If this is not specified, the command uses
<sharename> as <urlpath>.
The following options are specific to ftp subcommand:
•
-shareip <iplist>
•
Specifies the IP addresses to be assigned to the FTP share. The IP addresses must be assigned to
the specified VFS before creating the share. Use commas to separate multiple IP addresses. If this
option is not specified all the available IPs from the VFS which are not assigned to any other FTP
shares will be used to create the share.
-ssl {true|false}
•
Specifies if SSL is enabled. The default is "false".
-options <options>
Specifies the configuration options to be used for the FTP share. Options must be in the format of
option1=value1[,option2=value2].... If not specified, all options will be set to default values as shown
below.
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
138
accept_timeout=60
allow_anon_ssl=YES
anon_max_rate=0
anon_mkdir_write_enable=YES
anon_other_write_enable=NO
anon_umask=0077
anon_upload_enable=YES
anon_world_readable_only=NO
ascii_mode=both
chown_upload_mode=0600
connect_timeout=60
connection_mode=passive
data_connection_timeout=300
dirlist_enable=YES
file_access_mode=both
file_open_mode=0777
force_anon_logins_ssl=NO
Create Commands
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
◦
force_anon_data_ssl=NO
force_local_data_ssl=NO
force_local_logins_ssl=YES
hide_ids=NO
home_dir_prefix=/
home_dir_support=NO
idle_session_timeout=300
implicit_ssl=YES
local_max_rate=0
local_umask=0022
lock_upload_files=YES
login_access_mode=local
max_clients=250
mdtm_write=YES
no_anon_password=YES
pasv_max_port=49500
pasv_min_port=49251
require_ssl_reuse=NO
ssl_version=tlsv1
text_userdb_names=NO
All the above values can be modified after the share is created except "home_dir_prefix=/" and
"home_dir_support=NO". See File Persona User Guide for detailed information.
SPECIFIERS
The following specifiers are for all subcommands:
<vfs>
The virtual file server (VFS) under which the file store, if it does not exist, and the share will be created.
<sharename>
The share name to be created.
EXAMPLES
The following example creates SMB file share "myshare":
cli% createfshare smb -fstore myfstore myvfs myshare
The following example creates SMB share share1 with auditing enabled for successful TreeConnect
operation via SMB protocol:
cli% createfshare smb -audit TreeConnect:success vfs1 share1
The following example creates NFS file share:
cli% createfshare nfs -options ro -fstore myfstore myvfs myshare
The following example creates NFS share myshare with auditing options for open, write operations via
NFS protocol:
cli% createfshare nfs -options audit_open,audit_write -fstore \myfstore
myvfs myshare
Create Commands
139
The following example creates Object file share:
cli% createfshare obj -fstore myfstore myvfs myshare
The following example creates FTP file share with implicit file store creation:
cli% createfshare ftp -ssl true myvfs myshare
The following example creates FTP file share with share IP as 1.1.1.1:
cli% createfshare ftp -shareip 1.1.1.1 -fstore myfstore myvfs myshare
NOTES
Access to all domains is required to run this command.
The FPG and its underneath VFS must be created before creating file shares.
For SMB share permissions, the same user cannot be specified with the same permission in both "allowperm" and "-denyperm". Share permissions are different from file system permissions, i.e. ACLs
on files/folders. Option "-allowperm" grants users to access the share, which does not set the folder
permissions of the folder exported by the share. If a user wants to read a file, he must have read share
permissions and an ACE that grants him read permissions. Even if "Everyone:fullcontrol" is allowed, that
does not mean anyone can do anything, due to the additional restrictions of the folder ACLs. To modify
the folder ACL or permissions, connect to the share through the protocol and use the appropriate
mechanism for that protocol to modify the ACL or permissions to allow different access than what is
provided by default.
To access an SMB share: for users configured locally, specify "LOCAL_CLUSTER\<user>", for users
configured on Active Directory, specify "<domain>\<user>" or "<ad-netbios>\<user>", for users configured
on the LDAP server, specify "<ldap-netbios>\<user>".
For NFS shares, it is not allowed to create two shares which have identical clients (i.e. specified by clientip) and share directory (i.e. specified by -sharedir). If you create NFS shares without specifying
different -clientip and -sharedir options, the second "createfshare" will fail.
To create FTP/Object share, the VFS specified by <vfs> must have an associated IP address.
This command displays a warning message:
•
•
If user tries to create NFS/OBJ/FTP shares on a file store with "ntfs" security mode.
If user tries to create shares of different protocols on a file store with "legacy" security mode.
For the commands which involve implicit creation of file stores:
•
•
If the share is SMB, a warning message is displayed and the file store will be created in "ntfs" security
mode after the user confirmation.
If the share is NFS/OBJ/FTP, no warning message is displayed and the file store will be created in
"legacy" security mode.
For obj/ftp shares, the VFS must have a certificate associated with it to enable SSL.
createfsip
DESCRIPTION
The createfsip command assigns an IP address to a virtual file server (VFS).
SYNTAX
createfsip [options] <ipaddr> <subnet> <vfs>
140
createfsip
AUTHORITY
•
•
Super, Edit
Any role granted the fsip_create right
OPTIONS
-vlantag <tag>
Specifies the VLAN Tag to be used.
-fpg <fpg>
Specifies the file provisioning group (FPG) in which the VFS was created.
SPECIFIERS
<vfs>
Specifies the VFS to which the IP address will be assigned.
<ipaddr>
Specifies the IP address to be assign to the VFS.
<subnet>
Specifies the subnet mask to be used.
EXAMPLES
Assign the IP address 10.10.10.1 to VFS vfs_1:
cli% createfsip 10.10.10.1 255.255.255.0 vfs_1
NOTES
Access to all domains is required to run this command.
createfsnap
DESCRIPTION
The createfsnap command creates a file store snapshot for File Persona.
SYNTAX
createfsnap [options <arg>] <vfs> <fstore> <tag>
AUTHORITY
•
•
Super, Edit
Any role granted the fsnap_create right
OPTIONS
-retain <rcnt>
Number of snapshots to retain with the specified tag. Snapshots exceeding the count will be deleted,
oldest first. The valid range of <rcnt> is from 1 to 1024.
-f
Do not ask for confirmation before creating a snapshot with retention count (-retain). This option is
ignored if option -retain is not specified.
-fpg <fpgname>
createfsnap
141
Specifies the file provisioning group (FPG) that <vfs> belongs.
If this is not specified, the command will find out the FPG based on the specified <vfs>. However, if <vfs>
exists under multiple FPGs, -fpg must be specified.
SPECIFIERS
<vfs>
Specifies the name of the virtual file server (VFS).
<fstore>
Specifies the name of the file store that the snapshot will be taken.
This is the path relative to <vfs>.
<tag>
Specifies the suffix to be appended to the timestamp of snapshot creation time in ISO 8601 date and time
format, which will become the name of the created file store snapshot (for example: if "snapshot1" is
being used as <tag>, the snapshot name will be 2013-12-17T215020_snapshot1).
The name can be used as the value of option -snapname to display or remove a snapshot.
EXAMPLES
The following example creates a file store snapshot:
cli% createfsnap -fpg myfpg myvfs myfstore snapshot1
NOTES
Access to all domains is required to run this command.
If option -retain is specified and the file store already has the maximum number of snapshots taken, the
oldest snapshot will be deleted first before the new snapshot is created. If the command fails to create the
new snapshot, the deleted snapshot will not be restored.
createfsnetwork
DESCRIPTION
The createfsnetwork command creates a new network with the given network name.
SYNTAX
createfsnetwork [-comment <text>] [-mtu <mtuvalue>] [-mode <modevalue>]
<name> <N:S:P>,<N:S:P>,...
AUTHORITY
•
•
Super
Any role granted the fsnetwork_create right
OPTIONS
-comment <text>
Provides the description of the network. Space is allowed in the description. Maximum length can be 128
character.
-mtu <mtuvalue>
142
createfsnetwork
Specifies the size of the MTU for the network created. The range for <mtuvalue> must be between 1500
to 9000 (both inclusive).
-mode <modevalue>
Bonding Mode can take value either 1 or 6.
SPECIFIERS
<name>
Defines the name of the network to be created. Spaces are allowed in the name. Maximum length can be
64 characters.
<N:S:P>, <N:S:P>,..
Specifies the node, slot and port on which File Persona will be configured.
EXAMPLES
The following example creates a network with name as network1:
cli% createfsnetwork -comment testing -mtu 1500 -mode 6 network1
0:2:1,1:2:1
The following example creates a network with only mandatory parameters given:
cli% createfsnetwork user1 0:2:2,1:2:2
NOTES
Access to all domains is required to run this command.
createfsroute
DESCRIPTION
The createfsroute command creates a route for a target with non-default gateway.
SYNTAX
createfsroute [-vlan <vlantag>] <targetaddr> <subnet>|<prefixlen> <gateway>
AUTHORITY
•
•
Edit
Any role granted fsroute_set right
OPTIONS
-vlan <vlantag>
A VLAN tag with values ranging from 0 to 4094. Defaults to 0.
SPECIFIERS
<targetaddr>
The target IPv4/IPv6 address for which the gateway is to be assigned.
<subnet>|<prefixlen>
The subnet or prefix length for the target IP Address.
<gateway>
Gateway to be assigned to the target IP address.
createfsroute
143
EXAMPLES
The following example creates a route with vlan tag 10:
cli% createfsroute -vlan 10 10.16.101.11 255.255.0.0 10.16.101.1
The following example creates a route at vlan 0:
cli% createfsroute 10.16.101.11 255.255.0.0 10.16.101.1
NOTES
Access to all domains is required to run this command.
createfstore
DESCRIPTION
The createfstore command creates a new file store with the specified name for the specified file
provisioning group (FPG) and the virtual file server (VFS).
SYNTAX
createfstore -secmode {ntfs|legacy} [-f] [-comment <comment>] [-fpg
<fpgname>] [-secop_errsuppress {true|false}] <vfs> <fstore>
AUTHORITY
•
•
Super, Edit
Any role granted fstore_create right
OPTIONS
-fpg <fpgname>
Specifies the name of the FPG.
-comment <comment>
Specifies the textual description of the file store.
-secmode {ntfs|legacy}
Specifies the security mode of the file store. Valid values are:
•
•
legacy: File stores upgraded from 1.0 or 1.1 will be in this mode. New file stores can also be created
in this mode by specifying "legacy".
ntfs: Windows clients will get native NTFS ACL enforcement. Non-windows clients can create/read/
write/delete/rename files. Non-windows clients can also read the Permissions. But they will not be able
to set Permissions, change owner or change group except when the user trying to perform this
operation is "root".
-secop_errsuppress {true|false}
In "ntfs" security mode, permission changing operations will report error messages for non-root users
when this option is "false". This may not be the ideal behavior for some applications which are trying to
perform permission changing operations such as "chmod" implicitly over an NFSv3 client. This option can
be set to "true" to allow those applications to work with NFSv3 clients. If not specified, the option will be
set to "false". This option can be used only while creating file stores in "ntfs" security mode.
SPECIFIERS
<vfs>
Specifies the name of the virtual file server.
144
createfstore
<fstore>
Specifies the name of the file store to be created.
EXAMPLES
The following example creates a file store named "samplefstore" in "ntfs" security mode under virtual
server named "samplevfs":
cli% createfstore -secmode ntfs samplevfs samplefstore.
The following example creates a file store named "samplefstore" in "legacy" security mode on FPG
named "samplefpg" under virtual server named "samplevfs" and sets a comment "Sample fstore" with the
created file store:
cli% createfstore -secmode legacy -comment "Sample fstore" -fpg samplefpg
\samplevfs samplefstore
NOTES
Access to all domains is required to run this command.
The file store name cannot exceed 255 characters.
If clients from multiple protocols access NTFS file store simultaneously, it is recommended to set
"enableoplocks" and "enablesmbleases" to "false" (use "setfs smb" subcommand). Otherwise SMB
clients can cache file data locally. This could cause a client from a non-SMB protocol to see stale data (If
an SMB client updated a file but is keeping the update in its cache) or it could cause an SMB client to see
stale data (If a non-SMB protocol client updated a file after a SMB client had already read its contents and
cached the data). This behavior can be prevented by setting "enableoplocks" and "enablesmbleases" to
"false". Note that changing these settings may have a performance impact for SMB, depending on the
workload, but it is recommended if there will be simultaneous access by clients of multiple protocols.
createfsuser
DESCRIPTION
The createfsuser command creates a new local user.
SYNTAX
createfsuser [options] <username>
AUTHORITY
•
•
Super
Any role granted the fsuser_create right.
OPTIONS
-passwd <password>
Specifies the user's password.
-primarygroup <groupname>
Specifies the user's primary group.
-enable {true | false}
Specifies the user is enabled or disabled on creation.
-uid <userid>
Specifies the user ID to be used.
createfsuser
145
UIDs are numbers from zero to 65534. The numbers are grouped as follows:
•
•
•
UIDs 0-99 are globally allocated by the Debian project and are used for system accounts. The "root"
account, for instance, is UID 0.
UIDs 1000-29999 are normal user accounts.
UID 65534 is user "nobody", an account with no rights or permissions.
Users may usually be referred to by either username or UID.
-grplist <grouplist>
Specifies a list of additional groups the user is to be a member.
SPECIFIERS
<username>
Specifies the local user name using up to 20 characters. Valid characters are alphanumeric characters,
periods, dashes (except first character), and underscores.
EXAMPLES
Create a local user named jdoe:
cli% createfsuser -grplist finance,marketing
-primarygroup users jdoe
NOTES
Access to all domains is required to run this command.
If not specified, -uid will be given a default value.
The -uid option can have any value between 1000 and 65535.
User's primary group cannot be Built-in groups: "Administrators", "Users", "Guests" and "Backup
Operators".
If the -enabled option is not supplied the user will be enabled by default.
If a password is not supplied the user will be prompted to enter one.
To access an SMB share, specify the user as "LOCAL_CLUSTER\<username>".
creategroupsv
DESCRIPTION
The creategroupsv command creates consistent group snapshots of a list of virtual volumes.
Consistent group snapshots are all created at the same point in time so that related structures on different
volumes in the group remain consistent.
SYNTAX
creategroupsv [option] <copy_of_VV>[:[<snapshot_VV>][:[<ID>][:[<WWN>][:{RO|
RW}]]]]...
AUTHORITY
•
•
Super, Edit
Any role granted the groupsv_create right
OPTIONS
-ro
146
creategroupsv
By default, all snapshots are created read-write. The -ro option instead specifies that all snapshots
created will be read-only.
-match
The -match option specifies that snapshots are created matching each parent's read-only or read-write
setting.
The -ro and -match options cannot be combined. Either of these options can be overridden for an
individual snapshot VV in the colon separated specifiers.
-exp <time>{d|D|h|H}
Specifies the relative time from the current time that volume will expire. <time> is a positive integer value
and in the range of 1 - 43,800 hours (1825 days). Time can be specified in days or hours providing either
the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
-comment <comment>
Specifies any additional information up to 511 characters for the volume.
-f
Do not ask for confirmation before creating a volume with retention time (-retain).
-retain <time>{d|D|h|H}
Specifies the amount of time, relative to the current time, that the volume will be retained. <time> is a
positive integer value and in the range of 1 - 43,800 hours (1825 days). Time can be specified in days or
hours providing either the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
NOTE:
If the volume is not in any domain, then its retention time cannot exceed the value of the system's
VVRetentionTimeMax. The default value for the system's VVRetentionTimeMax is 14 days. If the
volume belongs to a domain, then its retention time cannot exceed the value of the domain's
VVRetentionTimeMax, if set. The retention time cannot be removed or reduced once it is set. If the
volume has its retention time set, it cannot be removed within its retention time. If both expiration
time and retention time are specified, then the retention time cannot be longer than the expiration
time.
This option requires the HPE 3PAR Virtual Lock license. Contact your local service provider for
more information.
-addtoset <VV_set>
Specifies that the snapshots will be added to the specified set. The set will be created if it does not exist.
-noblock
When a read-only snapshot is taken, the storage system blocks host i/o to the parent virtual volume while
the snapshot is being created. If the -noblock option is specified then the storage system will not block
host i/o to the parent virtual volume during snapshot creation. This option is only applicable for read-only
snapshots.
SPECIFIERS
<copy_of_VV>
Specifies the name of the Virtual Volume being copied (the parent volume).
<snapshot_VV>
Optional name of the snapshot Virtual Volumes. If <snapshot_VV> is not specified, the system tries to
automatically generate the snapshot name of the form <copy_of_VV>.<type><number> where <type> is
either ro or rw and <number> is either empty or the lowest number starting from 0 that does not conflict
Create Commands
147
with an existing volume name. If the generated name is too long (because the <copy_of_VV> name is too
long) the command will fail, and the user is required to specify <snapshot_VV> explicitly.
<ID>
Optional ID of the <snapshot_VV>. If the <ID> is not specified, an ID is chosen automatically.
<WWN>
Optional WWN of the snapshot VV. If <WWN> is not specified, a WWN will be chosen automatically.
{RO|RW}
Optional read-only or read-write setting to be applied only to the individual snapshot VV. Specifying this
setting overrides the -ro and -match options for this snapshot.
EXAMPLES
In the following example, virtual volumes VV1 and VV2 are created using the createvv on page 183
command. Then the creategroupsv command is used to create a read-only snapshot of each of the
volumes and display a list of the snapshots:
cli% createvv -snp_cpg cpg1 cpg1 VV1 4g
cli% createvv -snp_cpg cpg1 cpg1 VV2 4g
cli% creategroupsv -ro VV1 VV2
In this example, snapshots of VV1 and VV2 are created again, one read-only and one read-write. The first
snapshot has an automatic ID and WWN, while the second example snapshot specifies an ID and WWN.
cli% creategroupsv VV1:vv1.ro:::RO VV2:vv2.rw:321:50002AC0001A0024:RW
NOTES
If the volume is not in any domain, then its retention time cannot exceed the value of the system's
VVRetentionTimeMax. The default value for the system's VVRetentionTimeMax is 14 days. If the volume
belongs to a domain, then its retention time cannot exceed the value of the domain's
VVRetentionTimeMax, if set. The retention time cannot be removed or reduced once it is set. If the
volume has its retention time set, it cannot be removed within its retention time. If both expiration time and
retention time are specified, then the retention time cannot be longer than the expiration time. This option
requires the HPE 3PAR Virtual Lock License.
Contact your local HPE 3PAR Authorized Service Provider for more information.
Consistent group snapshots are all created at the same point in time so that related structures on different
volumes in the group remain consistent.
A maximum of 2048 virtual copies per volume are allowed.
A maximum of 500 virtual copies per volume are allowed.
Creating a read-only snapshot from an existing read-only snapshot, or creating a read-write snapshot
from a read-write snapshot or the base will create a hidden snapshot, therefore further reducing the
available number of virtual copies for that base volume.
creategroupvvcopy
DESCRIPTION
148
creategroupvvcopy
The creategroupvvcopy command creates consistent group physical copies of a list of virtual
volumes.
SYNTAX
The syntax for the creategroupvvcopy command can be one of the following:
creategroupvvcopy -p [options] <parent_VV>:<destination_VV>...
creategroupvvcopy -p -online [options]
<parent_VV>:<destination_cpg>:<VV_name>[:<wwn>]...
creategroupvvcopy -r [options] <destination_VV>...
creategroupvvcopy -halt <destination_VV>...
AUTHORITY
•
•
Super, Edit
Any role granted the groupvvcopy_create right
OPTIONS
-p
Starts a copy operation from the specified parent volume (as indicated using the <parent_VV> specifier)
to its destination volume (as indicated using the <destination_VV> specifier). First a set of consistent
group snapshots of all the <parent_VV> specifiers are taken and then each snapshot is copied to the
corresponding <destination_VV> specifier.
After the copies are complete, the snapshots are deleted unless the -s option is specified. Each
<parent_VV> specifier must be a base virtual volume or a read/write snapshot.
-r
Resynchronizes the set of destination volumes (as indicated using the <destination_VV> specifier) with
their respective parents using saved snapshots so that only the changes made since the last copy or
resynchronization are copied. The resynchronization operation can only be performed if snapshots of the
parents saved using the -s option in an earlier instance of the creategroupvvcopy command are
present. These old snapshots are replaced by a new set of consistent group snapshots for the next
resynchronization operation (such as the -s option need not be specified with the -r option).
-halt
Cancels an ongoing physical copy. This causes the destination volume (as indicated using the
<destination_VV> specifier) to be marked with the "cpf" status, which can be cleared up when a new copy
is started.
-s
Saves snapshots of the parent volume (as indicated with the <parent_VV> specifier) for quick
resynchronization and to retain the parent-copy relationships between each parent and destination
volume. The -s option is implied and need not be specified when the -r option is used. Each
<destination_VV> specifier remains marked as a physical copy of its <parent_VV> specifier until it is
promoted to a base virtual volume using the promotevvcopy command, which also removes the saved
snapshot of the <parent_VV> specifier. The saved snapshots should not be removed manually. If the
same <parent_VV> specifier is copied to different <destination_VV> specifiers with the -s option, a
different snapshot of the <parent_VV> specifier is saved for each <destination_VV> specifier.
-b
Use this specifier to block until all the copies are complete. Without this option, the command completes
before the copy operations are completed (use the showvv command to check the status of the copy
operations).
-pri <high|med|low>
Create Commands
149
Specifies the priority of the copy operation when it is started. This option allows the user to control the
overall speed of a particular task.
If this option is not specified, the creategroupvvcopy operation is started with default priority of
medium. High priority indicates that the operation will complete faster. Low priority indicates that the
operation will run slower than the default priority task. This option cannot be used with -halt option.
-online
Specifies that the copy is to be performed online. This means that the destination can be immediately
exported and is automatically created by this command, meaning that it cannot exist prior to executing
this command. This option requires the specification of a CPG for the destination volume and allows for
the options listed below. Finally, -online requires the -p option and is incompatible with the -r, -halt, -s, -b,
and -pri options.
-skip_zero
When copying from a thin provisioned source, only copy allocated portions of the source VV. Using this
option can save time, but only use it if the destination is newly created or has been re-initialized to zero. If
there is pre-existing data in the destination VV it will not be overwritten to match the source VV if the
same offset is not allocated in the source. This option cannot be combined with -r or -halt.
The following options can only be used when the -online option is specified:
•
-tpvv
•
Indicates that the VV the online copy creates should be a thinly provisioned volume. Cannot be used
with the -dedup option.
-tdvv
•
This option is deprecated, see -dedup.
-dedup
•
Indicates that the VV the online copy creates should be a thinly deduplicated volume, which is a thinly
provisioned volume with inline data deduplication. This option can only be used with a CPG that has
SSD (Solid State Drive) device type. Cannot be used with the -tpvv option.
-compr
•
Indicates that the VV the online copy creates should be a compressed virtual volume.
-snp_cpg <snp_cpg>
Specifies the name of the CPG from which the snapshot space will be allocated.
SPECIFIERS
<destination_VV>
Indicates the destination virtual volume.
<parent_VV>
Indicates the parent virtual volume.
<destination_cpg>
Specifies the destination CPG to use for the destination volume if the -online option is specified.
<VV_name>
Specifies the virtual volume name to use for the destination volume if the -online option is specified.
<wwn>
Specifies the WWN to use for the destination volume if the -online option is specified.
EXAMPLES
None.
150
Create Commands
NOTES
The source and destination volumes must be writable.
The destination volume cannot be a system volume or a File Persona volume.
The destination volume cannot be exported as a VLUN before or during the createvvcopy on page 188
command process.
The destination volume must be greater than or equal in size to the source volume.
If the -s option is specified to save a snapshot for fast resynchronization and the snapshot goes stale, the
copy fails.
A physical copy of a virtual volume fails in any situation that a snapshot copy fails or when there is
insufficient snapshot space or I/O errors.
The creategroupvvcopy command can be issued multiple times. However, the HPE 3PAR Storage
System allows only two active physical copy tasks to run concurrently. Any additional physical copy tasks
are queued, pending the completion of the active physical copy tasks. Consistent group snapshots are all
created at the same point in time so that related structures on different volumes in the group remain
consistent.
The -online option for an online copy automatically creates a destination volume, so unlike other physical
copies, the destination volume should not exist. The destination volume requires a CPG to be specified,
and optionally it can be either a TPVV, TDVV, or have a snapshot CPG associated with it.
Note that the -tpvv, -dedup, -compr, and -snp_cpg options apply to all copies. The destination volume can
be immediately exported (hence the reason for the online option). The online option is incompatible with
the -r, -halt, -s, -pri, and -b options.
createhost
DESCRIPTION
The createhost command defines a new system host and provides the option of assigning one or more
paths to that host. Paths can be either Fibre Channel WWNs or iSCSI names. The command also
provides options to annotate the host with descriptor information such as physical location, IP Address,
Operating System, Model, etc. In addition, if the Smart SAN license is installed, the desired relationship
between the host and array port for target-driven zoning can be specified.
SYNTAX
createhost [options] <hostname> [<WWN>...]
createhost -iscsi [options] <hostname> [<iscsi_name>...]
AUTHORITY
•
•
Super, Edit
Any role granted the host_create right
OPTIONS
-add
Add the specified WWN(s) or iscsi_name(s) to an existing host (at least one WWN or iscsi_name must be
specified). Do not specify host persona.
-domain <domain | domain_set>
Create the host in the specified domain or domain set. The default is to create it in the current domain, or
no domain if the current domain is not set. The domain set name must start with "set:".
-f
Forces the tear down of lower priority VLUN exports if necessary.
createhost
151
-persona <hostpersonaval>
Sets the host persona that specifies the personality for all ports which are part of the host set. This
selects certain variations in scsi command behavior which certain operating systems expect.
<hostpersonaval> is the host persona id number with the desired capabilities. These can be seen with
showhost -listpersona.
-loc <location>
Specifies the host's location.
-ip <IP address>
Specifies the host's IP address.
-os <OS>
Specifies the operating system running on the host.
-model <model>
Specifies the host's model.
-contact <contact>
Specifies the host's owner and contact information.
-comment <comment>
Specifies any additional information for the host.
-port <node:slot:port>...|<pattern>...
Specifies the desired relationship between the array port(s) and host for target-driven zoning. Multiple
array ports can be specified by either using a pattern or a comma-separated list. This option is used only
when the Smart SAN license is installed. At least one WWN needs to be specified with this option.
SPECIFIERS
<hostname>
Specifies the name of the host using up to 31 characters.
<WWN>
Specifies the World Wide Name (WWN) to be assigned or added to an existing host. This specifier can be
repeated to specify multiple WWNs.
This specifier is optional.
<iscsi_name>
Host iSCSI name to be assigned or added to a host. This specifier is optional.
EXAMPLES
The following example creates system host test01:
cli% createhost test01 2000000087041F72
The following example creates an iSCSI host test02:
152
Create Commands
cli% createhost -iscsi test02 iqn.1991-06.com.microsoft:dt-391-xp.hq.
3par.com
The following example creates host ibm520-13 with an AIX host persona:
cli% createhost -persona 8 ibm520-13 10000000C97B142E
The following example requests that host lynx be zoned with port 1 in node 0, slot 8:
cli% createhost -port 0:8:1 lynx 1000A0B3CC1C68BE
NOTES
Access to all domains is required to run this command.
If the host is running the HPE Host Agent then createhost may be called with no paths and the
hostname reported by the agent to create the host with all reported paths. If no agent is running then
createhost with no paths creates a host without assigning a host path. The -add option modifies an
existing host by associating a host path with that host. If the -add option is not used, the createhost
command defines a new host.
If assigning paths to a host being created, specify the -f option to remove any existing VLUNs associated
with those paths to avoid any conflicting VLUNs.
Verify the creation of a host by issuing the showhost on page 471 command.
The options that allow for adding descriptive information are for annotation purposes only; the information
provided here is not actively used by the storage server.
Although it is optional to specify a host persona, a host must have one.
If one is not specified, it will default to 1 (Generic). This will not operate correctly with all types of hosts.
The host persona can be changed with sethost -persona (see sethost on page 361).
Host personas should not be specified with the -add argument.
A port's FC parameters should be set with controlport config (see controlport on page 109).
createhostset
DESCRIPTION
The createhostset command defines a new set of hosts and provides the option of assigning one or
more existing hosts to that set. The command also allows the addition of hosts to an existing set by use of
the -add option.
SYNTAX
createhostset [options] <setname> [<host | pattern>...]
AUTHORITY
•
•
•
Super, Edit
Any role granted the hostset_create right can create a host set
Any role granted the hostset_set right can add hosts to a host set
createhostset
153
OPTIONS
-add
Specifies that the hosts listed should be added to an existing set. At least one host must be specified.
-comment <comment>
Specifies any comment or additional information for the set. The comment can be up to 255 characters
long. Unprintable characters are not allowed.
-domain <domain>
Create the host set in the specified domain. For an empty set the default is to create it in the current
domain, or no domain if the current domain is not set. A host set must be in the same domain as its
members; if hosts are specified as part of the creation then the set will be created in their domain. The domain option should still be used to specify which domain to use for the set when the hosts are
members of domain sets. A domain cannot be specified when adding a host to an existing set with the add option.
SPECIFIERS
<setname>
Specifies the name of the host set to create/add to, using up to 27 characters in length.
<host | pattern>...
Optional list of hosts or glob-style patterns matching hosts that are to be included in the host set. If no
<host> is specified a host set with no hosts is created.
EXAMPLES
To create an empty hostset:
cli% createhostset hostset
To add a host to the set:
cli% createhostset -add hostset hosta
To create a host set with hosts in it:
cli% createhostset hostset host1 host2
or
cli% createhostset set:hostset host1 host2
To create a host set with a comment and a host in it:
cli% createhostset -comment "A host set" oraset ora1
154
Create Commands
NOTES
None.
creatercopygroup
DESCRIPTION
The creatercopygroup command creates a remote copy volume group.
SYNTAX
creatercopygroup [options] <group_name> <target_name>:<mode>
[<target_name>:<mode>...]
AUTHORITY
•
•
Super, Edit
Any role granted the rcopygroup_create right
OPTIONS
-domain <domain>
Creates the remote copy group in the specified domain. The volume group must be created by a member
of a particular domain with Super or Edit privileges.
-usr_cpg <cpg name> <target_name>:<cpg_name>...
Specify the local user CPG and target user CPG that will be used for volumes that are auto-created. The
local CPG will only be used after failover and recovery.
-snp_cpg <cpg name> <target_name>:<cpg_name>...
Specify the local snap CPG and target snap CPG that will be used for volumes that are auto-created. The
local cpg will only be used after failover and recovery.
SPECIFIERS
<group_name>
Specifies the name of the volume group, using up to 22 characters if the mirror_config policy is set, or up
to 31 characters otherwise. This name is assigned with this command.
<target_name>
Specifies the target name associated with this group. This name should already have been assigned
using the creatercopytarget on page 156 command. The <target_name>:<mode> pair can be repeated
to specify multiple targets.
<mode>
Specifies that the mode of the created group, the available modes are:
•
•
•
sync—synchronous replication
async—asynchronous streaming replication
periodic—periodic asynchronous replication
The <target_name>:<mode> pair can be repeated to specify multiple targets. Refer to the remote copy
users guide for a detailed description of each operating mode.
EXAMPLES
The following example creates an asynchronous periodic mode volume group named Group1 whose
target system is System2 (target name System2_out):
creatercopygroup
155
creatercopygroup Group1 System2_out:periodic
If you are using domains, the syntax is as follows:
creatercopygroup -domain domain2 Group1 System2_out:periodic
If you are using volume auto-create:
creatercopygroup -usr_cpg Localcpg target:Targetcpg -snp_cpg Localsnp
target:Targetsnp groupname target:periodic
NOTES
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
When a Remote Copy group is created, a VV set will also be created. Its name will be the remote copy
group's name prepended with "RCP_", with numbers appended if necessary to make the set name
unique. Volumes will automatically be added to and removed from this set when volumes are admitted to
and dismissed from the group.
creatercopytarget
DESCRIPTION
The creatercopytarget command creates a remote copy target definition.
SYNTAX
Syntax for remote copy over IP (RCIP) is as follows:
creatercopytarget [options] <target_name> IP [node:slot:port:IP_address...]
Syntax for remote copy over fibre channel (RCFC) is as follows:
creatercopytarget [options] <target_name> FC <node_WWN>
[node:slot:port:WWN...]
AUTHORITY
•
•
Super, Edit
Any role granted the rcopytarget_create right
OPTIONS
-disabled
Create the target in disabled mode
SPECIFIERS
<target_name>
The name of the target definition to be created, specified by using up to 31 characters.
<node_WWN>
156
creatercopytarget
The node's World Wide Name (WWN) on the target system (Fibre channel target only).
<node:slot:port:IP_address>...
Specifies the node, slot, and port of the Ethernet port on the local system and an IP address of the peer
port on the target system.
<node:slot:port:WWN>...
Specifies the node, slot, and port of the Fibre Channel port on the local system and World Wide Name
(WWN) of the peer port on the target system.
EXAMPLES
The following example creates a target definition named System2 on the primary system, where the
Ethernet ports on the primary system are located at 0:3:1 and 1:3:1, and the corresponding IP addresses
on the backup system are 10.1.1.11 and 10.1.2.11:
creatercopytarget System2 IP 0:3:1:10.1.1.11 1:3:1:10.1.2.11
The following example creates a primary target definition named System1 on the backup system, where
the Ethernet ports on the backup system are located at 2:3:1 and 3:3:1, and the corresponding IP
addresses on the primary system are 10.1.1.96 and 10.1.2.96:
creatercopytarget System1 IP 2:3:1:10.1.1.96 3:3:1:10.1.2.96
The following example creates a target definition named System2 on the local system where the node
WWN of the target system is 20010002AC000060:
creatercopytarget System2 FC 20010002AC000060 0:4:1:22410002AC000060
1:4:1:23410002AC000060
NOTES
Functionality of this command requires the HPE 3PAR Remote Copy Software license. Contact your local
service provider for more information.
Access to all domains is required to run this command.
IP targets are made up of pairs composed of the node, slot and port of the ethernet port on the local
system and an IP address of the peer port on the target system.
FC targets are made up of sets with the node, slot, and port of the FC port on the local system and WWN
of the peer port on the target system.
createsched
DESCRIPTION
The createsched command provides users access to create tasks that are periodically run by the
scheduler.
SYNTAX
createsched [options] <cmd> <taskschedule> <schedname>
createsched
157
AUTHORITY
•
•
Super, Service, Edit
Any role granted the sched_create right
OPTIONS
-run_once
The task will only run once, at the specified time.
-no_alert
Failure of tasks created with 'no_alert' will not generate alerts if the task fails.
-f
Do not detect when a new scheduled task exceeds the recommended number of scheduled task starts
per minute. Do not ask for confirmation to create the new scheduled task.
SPECIFIERS
<cmd>
Specifies the cli command or the HPE-distributed script. Can be at most 1023 characters in length.
<taskschedule>
Specifies the crontab-style schedule. Each field can be at most 127 characters in length.
<schedname>
Specifies the name given to the schedule. The name can be up to 31 characters in length.
EXAMPLES
Create a scheduled task that will run every hour on the hour ("0 * * * *") and will create a readonly (-ro)
snapshot of sample_vv, that will expire in two hours (-exp 2h). The created snapshot will be named
sample_vv_set.HH.MMM where HH and MM refer to the hour and minute that the snapshot was created
(@vvname@.@H@.@M@):
createsched "createsv -ro -exp 2h @vvname@.@H@.@M@ vv" "0 * * * *" sv_task
Create a scheduled task which will create a consistent group snapshot.
The readonly snapshots will be created from the volume set set:dbora (for more information, issue "clihelp
-sub objectsets" or see Object Sets on page 16) that will expire in two hours (-exp 2h) and the snapshots
will be named using the pattern @vvname@.@s@ (volume name specified in the set, with the epoch in
seconds appended). The task will be named "snap_odbora_set" and run every hour on the hour during
the working hours from 8am to 5pm ("0 8-17 * * *"):
createsched "createsv -ro -exp 2h @vvname@.@s@ set:dbora" "0 8-17 * * *"
sv_dbora_task
If just a single vv then:
createsched "createsv -ro -exp 2h @vvname@.@s@ vvname" "0 * * * *"
snap_large_tpvv_a
158
Create Commands
Add a comment with spaces to createsv by surrounding the comment with escaped double quotes:
createsched "createsv -ro -exp 2h -comment \"Comment with spaces\"
@vvname@.@H@.@M@ vv" "0 * * * *" sv_task
NOTES
The names "all" and "upgrade" are reserved.
Only the following commands can be scheduled:
checkhealth, compactcpg, compactld, createfsnap, creategroupsv, createsv,
creategroupvvcopy, createvvcopy, importvv, moverelocpd, removevv, setqos,
setsralertcrit, setvv, startao, startfsav, startfsnapclean, syncrcopy,
tunepd, tunesys, tunevv, updatesnapspace, updatevv
The <taskschedule> string has five fixed fields:
minute, hour, day-of-month, month, day-of-week
To avoid spikes in resource utilization, it is recommended to spread out scheduled task start times as
much as possible. Createsched can predict out to 30 days when the newly scheduled task exceeds the
recommended number of scheduled task starts per minute. When this is detected, user confirmation is
requested to continue creating the schedule.
To skip this detection and confirmation, use the -f option.
Fields are separated by spaces. The allowed values for the fields are:
Field
Allowed Values
Minute
0-59
Hour
* or 0-23
Day-of-Month
* or 1-31
Month
* or 1-12
Day-of-Week
* or 0-6 (0 is Sunday)
Scheduling on February 29 is not supported.
Lists are allowed. A list is a set of numbers (or ranges) separated by commas. Examples: "1,2,5,9",
"0-4,8-12".
Ranges of numbers are allowed. Ranges are two numbers separated with a hyphen. The specified range
is inclusive. For example, 8-11 for an hour entry specifies execution at hours 8, 9, 10 and 11. Ranges
must be specified from low to high.
One of six special strings may also appear instead of the specification above:
Create Commands
159
String
Meaning
@yearly
Run every January 1st, "0 0 1 1 *"
@monthly
Run the first day of every month, "0 0 1 * *"
@weekly
Run every Sunday, "0 0 * * 0"
@daily
Run every midnight, "0 0 * * *"
@hourly
Run every hour, on the hour, "0 * * * *"
If some form of daylight savings or summer/winter time is in effect, then jobs scheduled during the
switchover period could be executed once, twice, or not at all.
createsnmpuser
DESCRIPTION
The createsnmpuser command creates the SNMPv3 user secret key used for generating
authentication and privacy keys. Username must correspond to an existing local user. The user will be
prompted to provide a password, which will be converted to a 20-byte secret key.
SYNTAX
createsnmpuser [options <arg>] <username>
AUTHORITY
•
•
Super
Any role granted the snmpuser_create right
OPTIONS
-p <password>
Specifies the user's password. The length of <password> must be 6 to 8 characters.
SPECIFIERS
<username>
Specifies the SNMPv3 user name. The user name must be an existing storage system local user.
EXAMPLES
The following example displays the setting of an SNMPv3 user:
cli% createsnmpuser <joe>
Please enter the password below. The password will be used to generate both
authentication and privacy secret keys for use in SNMPv3.
Password for user <joe>:
NOTES
Issuing the createsnmpuser command results in the system prompting for a password. Type in the
password for the user and then press ENTER. The password will be used to generate authentication and
privacy keys using SHA1. The generated key is 20 bytes in length.
160
createsnmpuser
createspare
DESCRIPTION
The createspare command allocates chunklet resources as spares. Chunklets marked as spare are
not used for logical disk creation and are reserved explicitly for spares, thereby guaranteeing a minimum
amount of spare space.
SYNTAX
createspare [options <arg>] <chunklet_specifier>...
AUTHORITY
•
•
Super, Service
Any role granted the spare_create right
OPTIONS
-f
Do not ask for confirmation. The default is to ask for confirmation.
-p
Specifies that partial completion of the command is acceptable.
Additionally, specified chunklets are marked as spare only if they are not spare already.
SPECIFIERS
<chunklet_specifier>...
The chunklet specifier is one of the following arguments:
<PD_ID:chunklet_number>
Specifies the identification of the physical disk and the chunklet number on the disk. This specifier can be
repeated.
<PD_ID:a>
Specifies the identification of the physical disk and all chunklets (a) on the disk. This specifier can be
repeated.
a:<chunklet_num>
Specifies a chunklet number on all physical disks. This specifier can be repeated.
-pos <cage:mag:disk:chunklet_num>
Specifies the position of a specific chunklet identified by its position in a drive cage, drive magazine,
physical disk, and chunklet number. This specifier can be repeated.
-pos <cage:mag:disk:a>
Specifies that all chunklets on a physical disk, identified by drive cage number, drive magazine number,
and physical disk number, are marked spare. This specifier can be repeated.
EXAMPLES
The following example marks chunklet 1 as spare for physical disk 15:
cli% createspare 15:1
createspare
161
The following example specifies the position in a drive cage, drive magazine, physical disk, and chunklet
number. -pos 1:0.2:3:121, where 1 is the drive cage, 0.2 is the drive magazine, 3 is the physical disk, and
121 is the chunklet number.
cli% createspare -pos 1:0.2:3:121
NOTES
Access to all domains is required to run this command.
To verify the creation of a spare chunklet, issue the showspare on page 534 command.
createsralertcrit
DESCRIPTION
The createsralertcrit command creates a criterion that System Reporter evaluates to determine if
a performance alert should be generated.
SYNTAX
createsralertcrit <type> [options <arg>] <condition>[,<condition>...] <name>
AUTHORITY
•
•
Super, Service
Any role granted the sralertcrit_create right
OPTIONS
Note that many of these options are dependent upon the type specifier, below.
Options common to all types:
•
-daily
•
This criterion will be evaluated on a daily basis at midnight.
-hourly
•
This criterion will be evaluated on an hourly basis.
-hires
This criterion will be evaluated on a high resolution (5 minute) basis.
•
This is the default.
-count <number>
•
The number of matching objects that must meet the criteria in order for the alert to be generated. Note
that only one alert is generated in this case and not one alert per affected object.
-recur <recurrences>/<samples>
•
The alert will only be generated if the other conditions of the criterion recur repeatedly. <recurrences>
is an integer value from 2 to 10, and <samples> is an integer from 2 to 10 representing the number of
previous System Reporter samples in which the recurrences will be examined. <samples> must be at
least the requested quantity of recurrences. Note that these samples refer to the selected resolution of
the criterion: hires, hourly, or daily.
-btsecs <relative_time>
A negative number indicating the number of seconds before the data sample time used to evaluate
conditions which compare against an average. Instead of a number representing seconds, btsecs can
be specified with a suffix of m, h or d to represent time in minutes (e.g. -30m), hours (e.g. -1.5h) or
days (e.g. -7d). The relative time cannot be more than 10 samples ago: 50 minutes for hires, 10 hours
162
createsralertcrit
•
for hourly, or 10 days for daily. If this option is not present the average is only computed for the most
recent data sample. The -btsecs option may not be combined with the -recur option.
-critical
•
This alert has the highest severity.
-major
•
This alert should require urgent action.
-minor
•
This alert should not require immediate action.
-info
•
This alert is informational only. This is the default.
-comment <comment>
Specifies comments or additional information for the criterion. The comment can be up to 511
characters long.
Options specific to the port type:
•
-port_type <type>[,<type>...]
Limit the data to port of the types specified. Allowed types are:
•
◦ disk—Disk port
◦ host—Host Fibre channel port
◦ iscsi—Host ISCSI port
◦ free—Unused port
◦ fs—File Persona port
◦ peer—Data Migration FC port
◦ rcip—Remote copy IP port
◦ rcfc—Remote copy FC port
-port <npat>:<spat>:<ppat>[,<npat>:<spat>:<ppat>...]
•
Ports with <port_n>:<port_s>:<port_p> that match any of the specified <npat>:<spat>:<ppat> patterns
are included, where each of the patterns is a glob-style pattern. If not specified, all ports are included.
-both | -ctl | -data
Specifies that both control and data transfers are displayed(-both), only control transfers are displayed
(-ctl), or only data transfers are displayed (-data). If this option is not specified, only data transfers are
displayed.
Fields applicable to the port type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the vlun type:
•
•
-host <host_name|host_set|host_wwn|pattern>[,<host_name|host_set|host_wwn|
pattern>...]
Limit the data to hosts with names that match one or more of the specified names or glob-style
patterns. Host set name must start with "set:" and can also include patterns. To specify the host by
WWN, start with "wwn:". A WWN can also include glob-style patterns.
-vv <VV_name|VV_set|pattern>[,<VV_name|VV_set|pattern>...]
Create Commands
163
•
Limit the data to VVs with names that match one or more of the specified names or glob-style patterns.
VV set name must be prefixed by "set:" and can also include patterns.
-l <LUN|pattern>[,<LUN|pattern>...]
•
Limit the data to LUNs that match one or more of the specified LUNs or glob-style patterns.
-port <npat>:<spat>:<ppat>[,<npat>:<spat>:<ppat>...]
•
Ports with <port_n>:<port_s>:<port_p> that match any of the specified <npat>:<spat>:<ppat> patterns
are included, where each of the patterns is a glob-style pattern. If not specified, all ports are included.
-vlun <host>:<vv>[:<lun>:<port_n>:<port_s>:<port_p>]
[,<host>:<vv>[:<lun>:<port_n>:<port_s>:<port_p>]]...
Limit the data to VLUNs matching the specified combination of host, VV, lun, and port. Each of these
components in this option may be a glob-style pattern. The host and VV components may specify a
corresponding object set by prefixing "set:" to the component. The host component may specify a
WWN by prefixing the component with "wwn:". The lun and port components are optional, and if not
present, data will be filtered to any matching combination of host and VV. This option cannot be
combined with -host, -vv, -l, or -port.
Fields applicable to the vlun type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the ld type:
•
-node <node>[,<node>...]
•
Limit the data to that corresponding to one of the specified nodes.
-cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
•
Limit the data to LDs in CPGs with names that match one or more of the specified names or glob-style
patterns.
{<LD_name>|<pattern>}[,{<LD_name>|<pattern>}]
LDs matching any of the specified LD_name or glob-style pattern are included. If not specified, all LDs
are included.
Fields applicable to the ld type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the pd type:
•
-disk_type <type>[,<type>...]
Limit the data to disks of the types specified. Allowed types are:
•
164
◦ FC—Fast Class
◦ NL—Nearline
◦ SSD—Solid State Drive
-rpm <speed>[,<speed>...]
Create Commands
•
Limit the data to disks of the specified RPM. Allowed speeds are 7, 10, 15, 100 and 150
{<PDID>|<pattern>}[,{<PDID>|<pattern>}]
PDs with IDs matching any of the specified PDID or glob-style pattern are included. If not specified, all
PDs are included.
Fields applicable to the pd type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the cmp type:
•
-node <node>[,<node>...]
Limit the data to that corresponding to one of the specified nodes.
Fields applicable to the cmp type:
read_hits, write_hits, reads, writes, totals, lock_blocks, read_hitpct,
write_hitpct, delack_nl, delack_fc, delack_ssd, free_page, clean_page,
write1_page, writen_page, writesched_page, writing_page, recov_page,
dirty_nl, dirty_fc, dirty_ssd, maxdirty_nl, maxdirty_fc, maxdirty_ssd
The following fields have been deprecated:
delack_fc10, delack_fc15, delack_ssd150, delack_ssd100, dirty_fc10,
dirty_fc15, dirty_ssd150, dirty_ssd100, maxdirty_fc10, maxdirty_fc15,
maxdirty_ssd150, maxdirty_ssd100 Each acts as an alias for the equivalent field without
distinction between disk speeds. For example delack_ssd100 or delack_ssd150 report equal to
delack_ssd.
Options specific to the cpu type:
•
-node <node>[,<node>...]
Limit the data to that corresponding to one of the specified nodes.
Fields applicable to the cpu type:
user_pct, sys_pct, idle_pct, interrupts, context_switches
Options specific to the link type:
•
-node <node>[,<node>...]
Limit the data to that corresponding to one of the specified nodes.
Fields applicable to the link type:
xcb_sent, kbps, xcb_size
Options specific to the qos type:
•
-target {{vvset|domain}:{<name>|<pattern>}|sys:all_others}[,...]
Limit the data to the specified QoS target rule(s).
Include a target type either {vvset|domain}, and a name or glob-style pattern.
The sys:all_others rule can be selected to display statistics for all other host I/O not regulated by any
"on" QoS rule.
Create Commands
165
Multiple targets types can be specified as a comma separated list.
Fields applicable to the qos type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, limit_iops, limit_kbps,
read_wait, write_wait, total_wait, rej, wait_qlen
Options specific to the rcopy type:
•
-target <TARGET_NAME|pattern>[,<TARGET_NAME|pattern>...]
Limit the data to TARGET_NAMEs that match one or more of the specified TARGET_NAMEs or globstyle patterns.
Fields applicable to the rcopy type:
rc_kbs, rc_kbps, rc_hbrttms
Options specific to the rcvv type:
•
-vv <VV_name|VV_set|pattern>[,<VV_name|VV_set|pattern>...]
Limit the data to VVs with names that match one or more of the specified names or glob-style patterns.
VV set name must be prefixed by "set:" and can also include patterns.
Fields applicable to the rcvv type:
lcl_read_iops, lcl_write_iops, lcl_total_iops, rmt_read_iops, rmt_write_iops,
rmt_total_iops, lcl_read_kbps, lcl_write_kbps, lcl_total_kbps, rmt_read_kbps,
rmt_write_kbps, rmt_total_kbps, lcl_read_svctms, lcl_write_svctms,
lcl_total_svctms, rmt_read_svctms, rmt_write_svctms, rmt_total_svctms,
lcl_read_ioszkb, lcl_write_ioszkb, lcl_total_ioszkb, rmt_read_ioszkb,
rmt_write_ioszkb, rmt_total_ioszkb, lcl_total_qlen, lcl_busy_pct,
rmt_total_qlen, rmt_busy_pct
Options specific to the cache type:
•
-node <node>[,<node>...]
Limit the data to that corresponding to one of the specified nodes.
Fields applicable to the cache type:
reads_per_sec, writes_per_sec, cmp_read_hit_pct, cmp_write_hit_pct,
fmp_read_hit_pct, fmp_write_hit_pct, read_back_iops, read_back_mbps,
destage_write_iops, destage_write_mbps, fmp_used_pct, fmp_q_dormant,
fmp_q_cold, fmp_q_norm, fmp_q_warm, fmp_q_hot, fmp_q_destage, fmp_q_read,
fmp_q_flush, fmp_q_wrtback, cmp_q_free, cmp_q_clean, cmp_q_write1,
cmp_q_writen, cmp_q_wrtsched, cmp_q_writing, cmp_q_dcowpend, cmp_q_dcowproc
Options specific to the LDSPACE type:
•
-disk_type <type>[,<type>...]
Limit the data to disks of the types specified. Allowed types are:
166
•
◦ FC—Fast Class
◦ NL—Nearline
◦ SSD—Solid State Drive
-owner <node>[,<node>...]
•
Limit data to LDs owned by the specified nodes.
-raid_type <type>[,<type>...]
Create Commands
•
Limit the data to RAID of the specified types. Allowed types are 0, 1, 5 and 6
-cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
•
Limit the data to LDs in CPGs with names that match one or more of the specified names or glob-style
patterns.
-ld <LD_name>|<pattern>[,<LD_name>|<pattern>]
LDs matching any of the specified LD_name or glob-style pattern are included. If not specified, all LDs
are included.
Fields applicable to the LDSPACE type:
raw_mb, used_mb, free_mb, total_mb
Options specific to the PDSPACE type:
•
-disk_type <type>[,<type>...]
Limit the data to disks of the types specified. Allowed types are:
•
◦ FC—Fast Class
◦ NL—Nearline
◦ SSD—Solid State Drive
-rpm <speed>[,<speed>...]
•
Limit the data to disks of the specified RPM. Allowed speeds are 7, 10, 15, 100 and 150.
-pd <PDID>|<pattern>[,<PDID>|<pattern>]
PDs with IDs matching any of the specified PDID or glob-style pattern are included. If not specified, all
PDs are included.
Fields applicable to the PDSPACE type:
nrm_used_ok, nrm_used_fail, nrm_avail_clean, nrm_avail_dirty, nrm_avail_fail,
spr_used_ok, spr_used_fail, spr_avail_clean, spr_avail_dirty, spr_avail_fail,
lifeleft_pct, t_degc
Options specific to the CPGSPACE type:
•
-disk_type <type>[,<type>...]
Limit the data to disks of the types specified. Allowed types are:
•
◦ FC—Fast Class
◦ NL—Nearline
◦ SSD—Solid State Drive
-raid_type <type>[,<type>...]
•
Limit the data to RAID of the specified types. Allowed types are 0, 1, 5 and 6
-cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
Limit the data to LDs in CPGs with names that match one or more of the specified names or glob-style
patterns.
Fields applicable to the CPGSPACE type:
adm_used_mb, snp_used_mb, usr_used_mb, total_used_mb, adm_free_mb,
snp_free_mb, usr_free_mb, total_free_mb, adm_mb, snp_mb, usr_mb, total_mb,
growth_avail_mb, private_base_mb, private_snap_mb, free_mb, shared_mb,
total_space_mb
Options specific to the VVSPACE type:
•
-usr_cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
Create Commands
167
•
Only include VVs whose usr space is mapped to a CPG whose name matches one of the specified
CPG_name or glob-style patterns.
-snp_cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
•
Only include VVs whose snp space is mapped to a CPG whose name matches one of the specified
CPG_name or glob-style patterns.
-prov <prov_type>[,<prov_type>...]
•
Only include VVs of the specified provisioning type(s). The possible values are: cpvv dds full peer snp
tdvv tpsd tpvv
-vv <VV_name|VV_set|pattern>[,<VV_name|VV_set|pattern>...]
•
Limit the data to VVs with names that match one or more of the specified names or glob-style patterns.
VV set name must be prefixed by "set:" and can also include patterns.
-compr <Yes|No|Off|NA>
Only include VVs of the specified compression setting.
Fields applicable to the VVSPACE type:
userrawrsvd_mb, snaprawrsvd_mb, adminrawrsvd_mb, totalrawrsvd_mb,
userused_mb, userfree_mb, userrsvd_mb, snapused_mb, snapfree_mb, snaprsvd_mb,
adminused_mb, adminfree_mb, adminrsvd_mb, totalused_mb, totalrsvd_mb,
virtualsize_mb
Options specific to the SYSSPACE type:
•
-disk_type <type>[,<type>...]
Limit the data to disks of the types specified. Allowed types are:
◦
◦
◦
FC—Fast Class
NL—Nearline
SSD—Solid State Drive
Fields applicable to the SYSSPACE type:
total_mb, alloc_mb, used_mb, system_mb, free_mb, failed_mb, compact_ratio,
dedup_ratio, overprov_ratio
SPECIFIERS
<type>
Type must be one of the following: port, vlun, pd, ld, cmp, cpu, link, qos, rcopy, rcvv, ldspace, pdspace,
cpgspace, vvspace, sysspace.
<condition>
The condition must be of the format <field><comparison><value> where field is one of the fields
corresponding to the type (see above), comparison is of the format <,<=,>,>=,=,!= and value is a numeric
value, or is a numeric value followed by %_average to indicate that the field is to be compared against the
average across multiple objects as as specified by filtering options and/or across multiple data sample
times as specified by the -btsecs option. See examples.
Note that some characters, such as < and >, are significant in most shells and must be escaped or
quoted when running this command from another shell. Multiple conditions may be separated by comma
(",") to indicate a logical AND requirement (conjunction). Conditions may be separated by the character
"~" to indicate a logical OR requirement (disjunction). AND logic takes precedence over OR logic, and
parentheses are not supported to override the natural precedence of the condition terms and logical
operators.
<name>
Specifies the name of the SR alert criterion, with a maximum of 31 characters.
168
Create Commands
EXAMPLES
The following example describes a criterion that generates an alert for each port that has more than 50
write IOPS in a high resolution sample:
cli% createsralertcrit port write_iops>50 write_port_check
The following example describes a criterion that generates an alert for each port that has more than
10000 write IOPS in a high resolution sample if the sum of all write IOPS for all ports exceeds 50000:
cli% createsralertcrit port write_iops>10000,sum_write_iops>50000
write_port_check
The following example describes a criterion that generates an alert if an hourly sample discovers that the
sum of all the write iops performed on node 1 exceed 10000:
cli% createsralertcrit port -hourly -port 1:*:* sum_write_iops>10000
port_1_writes
The following example describes a criterion that generates an alert for each LD that has more than 1000
reads with over an 8 ms latency (corresponding to column 10 in the read histogram) discovered during an
hourly sample:
cli% createsralertcrit ld -hourly read_time10>1000 ld_read
The following example describes a criterion that generates an alert if node 0 has mode than interrupts
and greater than 70% CPU utilization during a high resolution sample:
cli% createsralertcrit cpu -node 0 interrupts>100,sys_pct>70 node0busy
The following example describes a criterion that generates an alert if a high resolution sample discovers
that the sum of all IOPS of all ports in the system exceeds 100000:
cli% createsralertcrit port -daily sum_total_iops>100000 sys_busy
The following example describes a criterion that generates an alert if a VLUN experiences a sharp
increase in total IOPS from the previous hour:
cli% createsralertcrit vlun -hourly delta_total_iops>800 vlun_spike
Create Commands
169
The following example describes a criterion that generates an alert if 8 or more PDs experience at least
50ms average service time repeatedly, happening four times in any 6 high resolution periods (5 minutes
each):
cli% createsralertcrit pd -hires -count 8 -recur 4/6 total_svctms>50
recur8slow_pd
The following example creates a criterion for NL PDs, whereby an alert will be generated for any NL PD
whose write service time is more than 150% of the average write service times of all the NL PDs:
cli% createsralertcrit pd -disk_type NL write_svctms>150%_average slow_nl
The following example creates a criterion for Remote Copy VVs, whereby an alert will be generated for
any RC VV whose remote write service time for the past hour is more than 150% of the average remote
write service time of all the RC VVs over the past 5 hours:
cli% createsralertcrit rcvv -hourly -btsecs -5h
rmt_write_svctms>150%_average slow_rcvv
NOTES
The System Reporter periodically samples the performance of the system.
Each time a sample is taken, all of the criteria corresponding to that time interval are evaluated and
corresponding alerts are generated if all of the specified conditions are met. If previous samples satisfied
the criteria but the current sample does not, the alert is automatically fixed.
The sum referenced in conditions containing a sum field (sum_read_iops, sum_write_iops,
sum_total_iops, sum_read_kbps, sum_write_kbps, sum_total_kbps) is the total for the particular field for
everything matching the specified options. In the case of no options, this would be the total for all the
given objects.
Any condition data field, except for those with sum_ prefix, may have the delta_ prefix prepended. The
difference in the value of the field will be calculated from the previous sample. The delta can be negative.
Fields utilizing the sum_ or delta_ prefixes may not be compared to a group average (specified by
condition value %_average).
Conditions that contain histogram fields (read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0.. read_size15, write_size0..write_size15, total_size0..total_size15)
refer to all entries for the given histogram or greater. For example, referring to write_time10 means that
the condition is evaluating the sum of the I/Os that have a write_time greater than 8 milliseconds (which is
what column 10 refers to).
createsv
DESCRIPTION
The createsv command creates a point-in-time (snapshot) copy of a VV. Create snapshots to perform
such tasks as backing up data on the base volume and allowing multiple copies of a base volume to be
modified without affecting the original base volume.
SYNTAX
170
createsv
createsv [options] <SV_name> <copy_of_VV | VV_set | RC_group>
AUTHORITY
•
•
Super, Edit
Any role granted the sv_create right
OPTIONS
-ro
Specifies that the copied volume is read-only. If not specified, the volume is read/write.
-i <VV_ID>
Specifies the ID of the copied VV set. This option cannot be used when VV set is specified.
-rcopy
Specifies that synchronous snapshots be taken of a volume in a remote copy group. The same snapshot
<SV_name> will be applied on both the primary and secondary arrays.
-exp <time>{d|D|h|H}
Specifies the relative time from the current time that volume will expire. <time> is a positive integer value
and in the range of 1 - 43,800 hours (1825 days). Time can be specified in days or hours providing either
the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
-comment <comment>
Specifies any additional information up to 511 characters for the volume.
-f
Do not ask for confirmation before creating a volume with retention time (-retain).
-retain <time>{d|D|h|H}
Specifies the amount of time, relative to the current time, that the volume will be retained. <time> is a
positive integer value and in the range of 1 - 43,800 hours (1825 days). Time can be specified in days or
hours providing either the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
NOTE:
If the volume is not in any domain, then its retention time cannot exceed the value of the system's
VVRetentionTimeMax. The default value for the system's VVRetentionTimeMax is 14 days. If the
volume belongs to a domain, then its retention time cannot exceed the value of the domain's
VVRetentionTimeMax, if set. The retention time cannot be removed or reduced once it is set. If the
volume has its retention time set, it cannot be removed within its retention time. If both expiration
time and retention time are specified, then the retention time cannot be longer than the expiration
time.
This option requires the HPE 3PAR Virtual Lock license. Contact your local service provider for
more information.
-addtoset <VV_set>
Specifies that the snapshots will be added to the specified set. The set will be created if it does not exist.
SPECIFIERS
<SV_name>
Specifies the snapshot name, using up to 31 characters in length.
<copy_of_VV | VV_set>
Specifies the parent volume name or volume set name, using up to 31 characters. The VV_set name
must start with "set:". If copy_of VV is a VV set then svname can contain various patterns that are used to
Create Commands
171
form the snapshot volume name. (For more information, issue "clihelp sub,vvnamepat" or see VV Name
Patterns on page 18.) For remote copy groups, the group name should begin with "rcgroup:". For this
setting, @vvname@ replacements can be used. If a pattern is not given, the <SV_name> field is used as
a prefix, to which the VV_name is appended. This should be used in conjunction with the -rcopy flag.
EXAMPLES
The following example creates a read-only snapshot volume svro_vv0 from volume vv0:
cli% createsv -ro svr0_vv0 vv0
The following example creates snapshot volume svrw_vv0 from the snapshot svro_vv0:
cli% createsv svrw_vv0 svro_vv0
The following example creates a snapshot volume for each member of the VV set vvcopies. Each
snapshot will be named svro-<name of parent volume>:
cli% createsv -ro svro-@vvname@ set:vvcopies
If vvcopies contained VVs named vv.0, vv.1 and vv.2 this would result in snapshots named svro-vv.0,
svro-vv.1 and svro-vv.2.
The following example creates identical readonly snapshot volumes on both the primary and secondary
node:
cli% createsv -rcopy -ro sv_vv0 vv0
The following example creates the snapshots sv-vv.0, sv-vv.1, and sv-vv.2 and adds them to the VV set
vvsnaps:
cli% createsv -addtoset vvsnaps sv-@vvname@ set:vvcopies
The createsv command can also be used to create coordinated snapshots across a full remote copy
group:
cli% createsv -rcopy -ro sv_@vvname@_1 rcgroup:group1
If there are vv.1, vv.2 ...,vv.n within group1, this will result in sv_vv.1_1, sv_vv.2_1, ..., sv_vv.n_1. If
however, there is no pattern included, the <SV_name> is used as a prefix, appended with a '.':
cli% createsv -rcopy -ro sv rcgroup:group1
Assuming the same VVs as before, sv.vv.1, sv.vv.2, sv.vv.n will be created.
NOTES
If the volume is not in any domain, then its retention time cannot exceed the value of the system's
VVRetentionTimeMax. The default value for the system's VVRetentionTimeMax is 14 days. If the volume
belongs to a domain, then its retention time cannot exceed the value of the domain's
VVRetentionTimeMax, if set. The retention time cannot be removed or reduced once it is set. If the
volume has its retention time set, it cannot be removed within its retention time. If both expiration time and
retention time are specified, then the retention time cannot be longer than the expiration time. This option
requires the HPE 3PAR Virtual Lock License.
Contact your local HPE 3PAR Authorized Service Provider for more information.
172
Create Commands
A maximum of 2048 virtual copies per volume are allowed.
RW snapshots made directly against a base volume or another RW snapshot will reduce the available
amount by one for each.
RO snapshots made directly against another RO snapshot will also reduce the available amount by one
for each.
For a vv set the createsv command creates consistent group snapshots of the virtual volumes in the
set. Consistent group snapshots are all created at the same point in time so that related structures on
different volumes in the set remain consistent.
For remote copy (-rcopy), identical snapshots are created on both the primary and secondary arrays.
Only read-only snapshots may be taken with the -rcopy flag.
If the remote copy volume pair has different names on the primary and secondary arrays, any automatic
@vvname@ substitution will reflect the name of the primary array volume.
createtemplate
DESCRIPTION
The createtemplate command creates virtual volume (VV), logical disk (LD), and common
provisioning group (CPG) templates. Templates are sets of predetermined parameters that are applied to
the creation of virtual volumes, logical disks, and CPGs.
Use of this command with the vv specifier to create a VV is deprecated and will be removed in a
subsequent release. The createvv on page 183 command should be used instead to create a VV.
SYNTAX
createtemplate vv|ld|cpg [options <arg>] <template_name>
AUTHORITY
•
•
Super
Any role granted the template_create right
OPTIONS
The following options are valid for VV, LD, and CPG templates:
-nro
Indicates that properties not specified in the template are set to read-only.
-nrw
Indicates that properties not specified in the template are set to read-write.
-desc <description>
Specifies a description for the created template. The description can be up to 255 characters long.
-rw
Specifies that the list of property values in the remainder of the command line or until the next -rw or -ro
option are read-write, which means that they can be modified when the template is used.
-ro
Specifies that the list of property values in the remainder of the command line or until the next -rw or -ro
option are read-only, which means that they cannot be modified when the template is used.
If neither -ro nor -rw is specified, the default is -ro.
-t <RAID_type>
createtemplate
173
Specifies the RAID type of the logical disk: r0 for RAID-0, r1 for RAID-1, r5 for RAID-5, or r6 for RAID-6. If
no RAID type is specified, then the default is r6.
-ssz <size_number_chunklets>
Specifies the set size in terms of chunklets. The default depends on the RAID type specified: 2 for
RAID-1, 4 for RAID-5, and 8 for RAID-6.
-rs <size>
Specifies the number of sets in a row. The <size> is a positive integer.
If not specified, no row limit is imposed.
-ss <size_KB>
Specifies the step size from 32 KB to 512 KB. The step size should be a power of 2 and a multiple of 32.
The default value depends on raid type and device type used. If no value is entered and FC or NL drives
are used, the step size defaults to 256 KB for RAID-0 and RAID-1, and 128 KB for RAID-5.
If SSD drives are used, the step size defaults to 32 KB for RAID-0 and RAID-1, and 64 KB for RAID-5.
For RAID-6, the default is a function of the set size.
-ha port|cage|mag
Specifies that the layout must support the failure of one port pair, one cage, or one drive magazine (mag).
This option has no meaning for RAID-0. The default is cage availability.
-ch first|last
Specifies the chunklet location characteristics: either first (attempt to use the lowest numbered available
chunklets) or last(attempt to use the highest numbered available chunklets). If no argument is specified,
the default characteristic is first.
-p <pattern>
Specifies a pattern for candidate disks. Patterns are used to select disks that are used for creating logical
disks. If no pattern is specified, the option defaults to Fast Class (FC) disks. If specified multiple times,
each instance of the specified pattern adds additional candidate disks that match the pattern. The devtype pattern cannot be used to mix Nearline (NL), FC, and Solid State Drive (SSD) drives. An item is
specified as an integer, a comma-separated list of integers, or a range of integers specified from low to
high.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
174
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0- 7).
The primary path of the disks must be on the specified node(s).
-st <item>
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0- 7).
The primary path of the disks must be on the specified PCI slot(s).
-pt <item>
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0- 4).
The primary path of the disks must be on the specified port(s).
-cg <item>
Create Commands
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
•
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
on page 491 output indicating the side of the cage is omitted when using the -mg option. Drive
magazines are identified by one or more integers (item). Multiple drive magazines are separated with
a single comma (e.g. 1,2,3). A range of drive magazines is separated with a hyphen (e.g. 0-7). The
specified drive magazine(s) must contain disks.
-pn <item>
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen(e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
•
Specifies one or more physical disks. Disks are identified by one or more integers(item). Multiple disks
are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g. 0-3).
Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
Specifies that physical disks with free chunklets greater than the number specified be selected.
-fc_lt <number>
•
Specifies that physical disks with free chunklets less than the number specified be selected.
-devid <model>
•
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the "showpd -i" command.
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd"
command. If it is not specified, the default device type is FC.
-rpm <number>
Disks must be of the specified speed. Device speeds are shown in the RPM column of the showpd on
page 491 command. The number does not represent a rotational speed for the drives without
spinning media (SSD). It is meant as a rough estimation of the performance difference between the
drive and the other drives in the system. For FC and NL drives, the number corresponds to both a
performance measure and actual rotational speed. For SSD drive, the number is to be treated as
relative performance benchmark that takes into account in I/O per second, bandwidth and the access
time.
Disks that satisfy all of the specified characteristics are used. For example -p -fc_gt 60 -fc_lt 230 -nd 2
specifies all the disks that have greater than 60 and less than 230 free chunklets and that are
connected to node 2 through their primary path.
The following options are valid only for VV templates:
•
-type {cpvv|tdvv|tpvv|none}
Specifies the type of virtual volume for the template being created. Valid arguments are cpvv, tdvv,
tpvv, or none.
Create Commands
175
Use cpvv if the-cpg <CPG_name> option is used. If creating a template for creating TDVVs, use tdvv.
If creating a template for creating TPVVs, use tpvv.
•
If cpvv, tpvv, or tpvv are not specified, the default value is none meaning the created template is
applicable for the creation of any volume type. The "-type cpvv" option is deprecated and will be
removed in a subsequent release.
-size <size>[g|G|t|T]
•
Specifies the size of the virtual volume and logical disk. Size can be specified in megabytes (default),
in gigabytes by using the g|G parameter and terabytes by using the t|T parameter.
-spt <sectors_per_track>
•
Defines the virtual volume geometry sectors per track value that is reported to the hosts through the
SCSI mode pages. The valid range is between 4 to 8192 and the default value is 304.
-hpc <heads_per_cylinder>
•
Allows you to define the virtual volume geometry heads per cylinder value that is reported to the hosts
though the SCSI mode pages. The valid range is between 1 to 255 and the default value is 8.
-pol <pol>[,<pol>...]
Specifies the following policies that the created virtual volume follows.
If an argument is not specified, the option defaults to stale_ss.
◦
stale_ss
◦
Specifies that invalid snapshot volumes are permitted. Failure to update snapshot data does not
affect the write to the base volume, but the snapshot is considered invalid.
no_stale_ss
◦
Specifies that invalid snapshot volumes are not permitted. Failure to update a snapshot is
considered a failure to write to the base volume.
one_host
◦
This constrains the export of a volume to one host or one host cluster (when cluster names may be
used as a host name).
no_one_host
◦
This policy should only be used when exporting a virtual volume to multiple hosts for use by a
cluster-aware application, or when "port presents" VLUNs are used. This is the default policy
setting.
3par_host_dif
◦
This policy enables support for 3PAR implementation of host based DIF.
std_host_dif
◦
This policy enables support for standard SCSI implementation of host based DIF.
no_host_dif
This policy disables support for host DIF.
-usr_cpg <usr_cpg>
Specify the name of the CPG from which the user space will be allocated.
-usr_aw <percent>
This option enables user space allocation warning. Generates a warning alert when the user data space
of the TPVV exceeds the specified percentage of the virtual volume size.
-usr_al <percent>
Indicates the user space allocation limit. The user space of the TPVV is prevented from growing beyond
the indicated percentage of the virtual volume size. After this limit is reached, any new writes to the virtual
volume will fail.
176
Create Commands
-snp_cpg <snp_cpg>
The name of the CPG from which the snapshot space is allocated.
-snp_aw <percent>
Enables a snapshot space allocation warning. A warning alert is generated when the reserved snapshot
space of the VV exceeds the indicated percentage of the VV size.
-snp_al <percent>
Sets a snapshot space allocation limit. The snapshot space of the VV is prevented from growing beyond
the indicated percentage of the virtual volume size.
The following options are only used for CPG templates:
-aw <percent>
Specifies the percentage of used snapshot administration or snapshot data space that results in a
warning alert. A percent value of 0 disables the warning alert generation. The default is 0.
This option is deprecated and will be removed in a subsequent release.
-sdgs <size>[g|G|t|T]
Specifies the growth increment, the amount of logical disk storage created on each auto-grow operation.
The default growth increment may vary according to the number of controller nodes in the system. If
<size> is non-zero it must be 8G or bigger. The size can be specified in MB (default) or GB (using g or G)
or TB (using t or T). A size of 0 disables the auto-grow feature. The following table displays the default
and minimum growth increments per number of nodes:
Number of Nodes
Default
Minimum
1–2
32G
8G
3–4
64G
16G
5–6
96G
24G
7–8
128G
32G
-sdgl <size>[g|G|t|T]
Specifies that the auto-grow operation is limited to the specified storage amount. The storage amount can
be specified in MB (default) or GB (using g or G) or TB (using t or T). A size of 0 (default) means no limit
is enforced. To disable auto-grow, set the limit to 1.
-sdgw <size>[g|G|t|T]
Specifies that the threshold of used logical disk space, when exceeded, results in a warning alert. The
size can be specified in MB (default) or GB (using g or G) or TB (using t or T). A size of 0 (default) means
no warning limit is enforced. To set the warning for any used space, set the limit to 1.
SPECIFIERS
vv|ld|cpg
Specifies that the template is for the creation of a virtual volume (VV), logical disk (LD), or common
provisioning group (CPG).
<template_name>
Specifies the name of the template, up to 31 characters in length.
EXAMPLES
Create Commands
177
The following example creates a virtual volume called vvr1. The -ha and -pol option values are fixed. The
RAID type can be changed when the virtual volume is created. Note that if patterns are specified, it is not
possible to mix read-only and read-write pattern specifications:
cli% createtemplate vv -ha mag -rw -t r1 -ro -pol stale_ss vvr1
The command rejects the pattern:
cli% createtemplate vv -ro -p -nd 0 -rw -p -mg 1,2 vpatt
NOTES
Access to all domains is required to run this command.
By default, logical disks are created using only physical disks with the same device type. (By default, the
Fast Class device type is used). Use the "-p -devtype NL", "-p -devtype SSD" to override this default. Use
showpd to see the device types of physical disks in the system.
The value for -ssz and -rs can be set to -. This can be used in conjunction with the (default) read-only
property for options to ensure that their value cannot be changed when a virtual volume or logical disk or
CPG is created and the system is used to set the default values for these options.
The options -sdgs, -sdgl and -sdgw control the auto logical disk creation for the Common Provisioning
Group's snapshot data regions. Auto logical disk creation occurs when the amount of free logical disk
space falls below the specified grow (enlarge) size setting options (-sdgs, -sdgl).
For this command KB = 1024 bytes, MB = 1024 KB, GB = 1024 MB.
createuser
DESCRIPTION
The createuser command allows a user to create a new user with the specified name and role in the
specified domain.
SYNTAX
createuser [option] <username> <domainname> <role>
AUTHORITY
•
•
Super
Any role granted the user_create right
OPTIONS
-c <clear-text-password>
Specifies the user's password in clear-text format. The length of <clear-text-password> must be
between the admin defined minimum length and 32 characters. If no minimum has been defined, then the
default minimum value is 6.
SPECIFIERS
<username>
Name of the user. The username can be up to 31 characters long. Valid characters are alphanumeric
(letters and digits), period ("."), dash ("-") and an underscore ("_"). The first character must be
178
createuser
alphanumeric or an underscore for non-SSH users. To access the system via SSH, the first character of
the username must be alphanumeric.
<domainname>
Name of the domain. The domain name can be up to 31 characters long.
"all" can be used if the user is not to be in a specific domain.
<role>
The user role. Valid values for role are "browse", "edit", "service", "super", "audit" and any extended role.
Super, audit, and service roles cannot be given in individual domains.
Use showrole to list extended roles.
EXAMPLES
The following example displays the successful creation of a new user user1 with the clear-text password
123456, with access to domain testdomain and with edit role authority:
cli% createuser -c 123456 user1 testdomain edit
User created
NOTES
Access to all domains is required to run this command.
If no password is specified using -c then the user will be prompted for a clear text password.
Verify the creation of a new user by issuing the showuser on page 548 command.
createvfs
DESCRIPTION
createvfs creates a virtual file server (VFS). It can optionally create the file provisioning group (FPG) to
which the VFS will belong.
SYNTAX
createvfs [options] <ipaddr> <subnet> <vfsname>
AUTHORITY
•
•
Super,Edit
Any role granted vfs_create right
OPTIONS
Only one of the following certificate options can be specified:
•
-nocert
•
Do not create a self signed certificate associated with the VFS.
-certfile <certfile>
•
Use the certificate data contained in this file.
-certdata <certificate string>
Use the certificate data contained in this string.
-comment
Specifies any additional textual information.
createvfs
179
-bgrace <time>
The block grace time in seconds for quotas within the VFS.
-igrace <time>
The inode grace time in seconds for quotas within the VFS.
-snapquota {enable|disable}
Enables or disables the quota accounting flag for Snapshots at VFS level.
-fpg <fpgname>
The name of an existing FPG in which the VFS should be created.
-cpg <cpgname>
The CPG in which the FPG should be created.
-size <size>
The size of the FPG to be created.
-tdvv
Create the FPG with TDVV volumes.
-full
Create the FPG with fully provisioned volumes.
-node <nodeid>
The node to which the FPG should be assigned.
Can only be used when creating the FPG with the -cpg option.
-vlan <vlanid>
The VLAN ID associated with the VFSIP.
-wait
Wait until the associated task is completed before proceeding.
This option will produce verbose task information.
SPECIFIERS
<ipaddr>
The IP address to which the VFS should be assigned.
<subnet>
The subnet for the IP Address.
<vfsname>
The name of the VFS to be created.
EXAMPLES
The following example creates a VFS, examplevfs on examplefpg and generates a self signed certificate:
cli% createvfs -fpg examplefpg 10.10.10.10 255.255.0.0 examplevfs
The following example creates a VFS, Eng, and in doing so creates the associated FPG:
180
Create Commands
cli% createvfs -cpg examplecpg -size 8T 10.10.10.11 255.255.0.0 Eng
The following example creates a VFS on a specific node:
cli% createvfs -node 1 -cpg examplecpg -size 1T -snapquota enable
10.10.10.10 255.255.0.0 examplevfs
NOTES
Access to all domains is required to run this command.
If an FPG is created, it will be given the same name as the VFS.
Both names must be available for creation for the command to succeed.
Either -fpg or the parameters to create an FPG must be specified in order to create a VFS.
This command will spawn a task and return the taskid.
Certificates must be in PEM format, containing both public and private keys.
When specifying grace times, both block and inode grace times are required.
Grace times are specified in minutes.
When specifying -node, the FPG must be created alongside the creation of the VFS.
The VFS name cannot exceed 255 characters.
createvlun
DESCRIPTION
The createvlun command creates a VLUN template that enables export of a virtual volume as a SCSI
VLUN to a host or hosts. A SCSI VLUN is created when the current system state matches the rule
established by the VLUN template.
There are four types of VLUN templates:
•
•
•
•
Port presents—created when only the node:slot:port are specified. The VLUN is visible to any initiator
on the specified port.
Host set—created when a host set is specified. The VLUN is visible to the initiators of any host that is
a member of the set.
Host sees—created when the hostname is specified. The VLUN is visible to the initiators with any of
the host's WWNs.
Matched set—created when both hostname and node:slot:port are specified. The VLUN is visible to
initiators with the host's WWNs only on the specified port. Conflicts between overlapping VLUN
templates are resolved using prioritization, with port presents templates having the lowest priority and
matched set templates having the highest.
SYNTAX
The syntax for the createvlun command can be one of the following:
Port presents:
createvlun [options] <VV_name | VV_set> <LUN> <node:slot:port>
Host set:
createvlun
181
createvlun [options] <VV_name | VV_set> <LUN> <host_set>
Host sees:
createvlun [options] <VV_name | VV_set> <LUN> <host_name>
Matched set:
createvlun [options] <VV_name | VV_set> <LUN> <node:slot:port> <host_name>
createvlun [options] <VV_name | VV_set> <LUN> <host_name> <node:slot:port>
AUTHORITY
•
•
Super, Edit
Any role granted the vlun_create right
OPTIONS
-f
Specifies that the operation is forced and that the VLUN is created even if the specified virtual volume has
existing VLUNs. Unless the -f option is specified, the command asks for confirmation if a virtual volume
is already exported in a VLUN template.
-cnt <number>
Specifies that a sequence of VLUNs, as specified by the num argument, are exported to the same system
port and host that is created. The num argument can be specified as any integer. For each VLUN created,
the .int suffix of the VV_name specifier and LUN are incremented by one.
-novcn
Specifies that a VLUN Change Notification (VCN) not be issued after export. For direct connect or loop
configurations, a VCN consists of a Fibre Channel Loop Initialization Primitive (LIP). For fabric
configurations, a VCN consists of a Registered State Change
Notification (RSCN) that is sent to the fabric controller.
-ovrd
Specifies that existing lower priority VLUNs will be overridden, if necessary. Can only be used when
exporting to a specific host.
SPECIFIERS
<VV_name | VV_set>
Specifies the virtual volume or virtual volume set name, using up to 31 characters in length. The volume
name is provided in the syntax of basename.int. The VV set name must start with "set:".
<LUN>
Specifies the LUN as an integer from 0 through 16383. Alternatively n+ can be used to indicate a LUN
should be auto assigned, but be a minimum of n, or m-n to indicate that a LUN should be chosen in the
range m to n. In addition the keyword "auto" may be used and is treated as 0+.
<host_name>
Specifies the host where the LUN is exported, using up to 31 characters.
<host_set>
Specifies the host set where the LUN is exported, using up to 31 characters in length. The set name must
start with "set:".
<node:slot:port>
Specifies the system port of the virtual LUN export.
node
182
Create Commands
Specifies the system node, where the node is a number from 0 through 7.
slot
Specifies the PCI bus slot in the node, where the slot is a number from 0 through 5.
port
Specifies the port number on the FC card, where the port number is 1 through 4.
EXAMPLES
The following example exports virtual volume test on LUN 2:
cli% createvlun test 2 testhost
The following will export a VV test to a host set:
cli% createvlun test 1 set:host_set
The following will export a VV set test_set to a host:
cli% createvlun set:test_set 1 host
The following will export a VV set test_set to a host set:
cli% createvlun set:test_set 1 set:host_set
NOTES
If a volume is already exported as a VLUN, you will be prompted for confirmation if a new export of the
same volume is attempted.
The host and port can both be supplied when issuing this command (matched set). This is the most
restrictive access as both the host name and port must match before access to the VLUN is granted.
Verify the creation of VLUNs by issuing the showvlun on page 555 command.
Conflicts between overlapping VLUN templates are resolved by a priority order among templates with
matched set being the highest and port presents the lowest.
createvv
DESCRIPTION
The createvv command creates volumes that are provisioned from one or more common provisioning
groups. Volumes can be fully provisioned from a CPG or can be thinly provisioned. Users can optionally
specify a CPG for snapshot space for fully provisioned volumes and thinly provisioned volumes.
SYNTAX
createvv [options] <usr_cpg> <vvname>[.<index>] <size>[g|G|t|T]
AUTHORITY
•
•
Super, Edit
Any role granted the vv_create right
OPTIONS
-templ <tname>
createvv
183
Use the options defined in template <tname>. The template is created using the createtemplate on page
173 command. Options specified in the template are read-only or read-write. The read-write options may
be overridden with new options at creation time but read-only options may not be overridden their default
values, and all of these options are either read-only or read-write (using the -nro or -nrw options of the
createtemplate command). If not included, the -size and -usr_cpg options are automatically treated as
read-write even if the other unincluded properties are marked read-only.
-i <ID>
Specifies the ID of the volume. By default, the next available ID is chosen.
-cnt <count>
Specifies the number of identical VVs to create. This must be an integer from 1 through 999. If <id> is
specified with -i option, it is used as the id of the first VV and incremented by 1 for each subsequent
volume.
-shared
Specifies that the system will try to share the logical disks among the VVs. This option can only be used
with the -cnt option. This option cannot be used with the -tdvv or -tpvv option.
-wait <secs>
If the command would fail due to the lack of clean space, the -wait option specifies the number of
seconds to wait for the system to clean the dirty space before returning. If -wait 0 is issued, the command
returns immediately. If this option is not used, the command will keep waiting for dirty chunklets to be
cleaned if enough space will be available with the dirty chunklets cleaned. This option cannot be used
with the -tdvv or -tpvv option.
-exp <time>{d|D|h|H}
Specifies the relative time from the current time that volume will expire. <time> is a positive integer value
and in the range of 1 - 43,800 hours (1825 days). Time can be specified in days or hours providing either
the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
-comment <comment>
Specifies any additional information up to 511 characters for the volume.
-f
Do not ask for confirmation before creating a volume with retention time (-retain) or setting the host DIF
policy (-pol xxx_host_dif).
-retain <time>{d|D|h|H}
Specifies the amount of time, relative to the current time, that the volume will be retained. <time> is a
positive integer value and in the range of 1 - 43,800 hours (1825 days). Time can be specified in days or
hours providing either the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
NOTE:
If the volume is not in any domain, then its retention time cannot exceed the value of the system's
VVRetentionTimeMax. The default value for the system's VVRetentionTimeMax is 14 days. If the
volume belongs to a domain, then its retention time cannot exceed the value of the domain's
VVRetentionTimeMax, if set. The retention time cannot be removed or reduced once it is set. If the
volume has its retention time set, it cannot be removed within its retention time. If both expiration
time and retention time are specified, then the retention time cannot be longer than the expiration
time.
This option requires the HPE 3PAR Virtual Lock license. Contact your local service provider for
more information.
-spt <sectors_per_track>
184
Create Commands
Defines the virtual volume geometry sectors per track value that is reported to the hosts through the SCSI
mode pages. The valid range is between 4 to 8192 and the default value is 304.
-hpc <heads_per_cylinder>
Allows you to define the virtual volume geometry heads per cylinder value that is reported to the hosts
though the SCSI mode pages. The valid range is between 1 to 255 and the default value is 8.
-pol <pol>[,<pol>...]
Specifies the following policies that the created virtual volume follows.
If an argument is not specified, the option defaults to stale_ss.
•
stale_ss
•
Specifies that invalid snapshot volumes are permitted. Failure to update snapshot data does not affect
the write to the base volume, but the snapshot is considered invalid.
no_stale_ss
•
Specifies that invalid snapshot volumes are not permitted. Failure to update a snapshot is considered
a failure to write to the base volume.
one_host
•
This constrains the export of a volume to one host or one host cluster (when cluster names may be
used as a host name).
no_one_host
•
This policy should only be used when exporting a virtual volume to multiple hosts for use by a clusteraware application, or when "port presents" VLUNs are used. This is the default policy setting.
3par_host_dif
•
This policy enables support for 3PAR implementation of host based DIF.
std_host_dif
•
This policy enables support for standard SCSI implementation of host based DIF.
no_host_dif
•
This policy disables support for host DIF.
zero_detect
•
This policy enables the storage system to scan for zeros in the incoming write data. This feature when
used during physical copy to a TPVV will avoid allocating space for blocks containing zero. This
feature when used with a Thin Persistence license will reclaim allocated space when zero blocks are
written to the TPVV. This policy is only applicable for the base TPVV.
no_zero_detect
This policy disables the storage system to scan for zeros in the incoming write data to reclaim
allocated space on the volume. This is the default policy setting.
-snp_cpg <snp_cpg>
Specifies the name of the CPG from which the snapshot space will be allocated.
-snp_aw <percent>
Enables a snapshot space allocation warning. A warning alert is generated when the reserved snapshot
space of the VV exceeds the indicated percentage of the VV size.
-snp_al <percent>
Sets a snapshot space allocation limit. The snapshot space of the VV is prevented from growing beyond
the indicated percentage of the virtual volume size.
The following options can be used when creating thinly provisioned volumes:
Create Commands
185
-tdvv
Deprecated. Should use -dedup.
-tpvv
Specifies that the volume should be a thinly provisioned volume.
-minalloc <size>
This option specifies the default allocation size (in MB) to be set.
Allocation size specified should be at least (number-of-nodes * 256) and less than the CPG grow size.
-compr
Specifies that the volume should be a thinly compressed volume.
-dedup
Specifies that the volume should be a thinly deduplicated volume which is a thinly provisioned volume
with inline data deduplication. This option can only be used with CPG that has SSD (Solid State Drive)
device type.
-usr_aw <percent>
This option enables user space allocation warning. Generates a warning alert when the user data space
of the TPVV exceeds the specified percentage of the virtual volume size.
-usr_al <percent>
Indicates the user space allocation limit. The user space of the TPVV is prevented from growing beyond
the indicated percentage of the virtual volume size. After this limit is reached, any new writes to the virtual
volume will fail.
SPECIFIERS
<usr_cpg>
Specifies the name of the CPG from which the volume user space will be allocated. If the -tdvv or -tpvv
option is specified, the volume is thinly provisioned. Otherwise, the volume is fully provisioned. If the
name of the CPG is to be taken from a template, this field should be "-".
<vvname>[.<index>]
Specifies a VV name up to 31 characters in length. If the -cnt option is used, the optional decimal number
<index> specifies the name of the first VV(<vvname>.<index>). The <index> is incremented by 1 for each
subsequent VV. The <index> must be an integer from 0 to 999999. All VV names have the same length
constraint.
<size>[g|G|t|T]
Specifies the size for the volume in MB. The volume size is rounded up to the next multiple of 256 MB.
The size should be an integer. An optional suffix (with no whitespace before the suffix) will modify the
units to GB (g or G suffix) or TB (t or T suffix). If the size is to be taken from a template, this field should
be "-".
EXAMPLES
The following example creates a 10G TPVV named tpvv1 whose user space is allocated from the
common provisioning group cpg1. The user space allocation warning is set to 50 and the user space
allocation limit is set to 75:
cli% createvv -tpvv -usr_aw 50 -usr_al 75 cpg1 tpvv1 10G
The following example creates 3 VVs vv1.2, vv1.3, vv1.4:
186
Create Commands
cli% createvv -cnt 3 cpg1 vv1.2 1g
The following example creates 2 VVs vva.0 and vva.1 which may share LDs:
cli% createvv -cnt 2 -shared cpg1 vva 1g
The following example creates a TPVV name tpvv1 with the template, temp2:
cli% createvv -tpvv -templ temp2 cpg2 tpvv1 2g
The following example creates a TDVV name tdvv1 with the template, temp2:
cli% createvv -tdvv -templ temp2 cpg2 tdvv1 2g
The following example creates a TPVV with default allocation size of 2GB:
cli% createvv -tpvv -minalloc 2048 cpg2 tpvv1 1g
The following example creates a thinly compressed volume of size 16GB:
cli% createvv -compr cpg2 vv1 16g
NOTES
Access to all domains is required to run this command with logical disks specified.
Use of this command with the -tdvv or -tpvv option requires a Thin Provisioning license. Contact your local
HPE representative for information.
The -templ option is not valid for volumes that are fully provisioned.
Using the -shared option can be more efficient when creating a large number of small volumes since the
system will attempt to share the underlying logical disks. However, if volumes are subsequently removed,
this can lead to unused space in the logical disks that cannot be reclaimed. Using -cnt without the -shared
option avoids this problem, but can be inefficient when creating small volumes due to the overhead of
creating a larger number of unshared LDs for the volumes.
The -shared and -wait option cannot be used when creating thinly provisioned virtual volumes with the tdvv or -tpvv option.
-minalloc can be used only with -tpvv or -tdvv.
Verify the creation of virtual volumes by issuing the showvv on page 558 command.
Maximum size of Dedup and Compressed Volumes is 16 TB.
Create Commands
187
Minimum size of Compressed volumes is 16GB.
Maximum VV size of Fully provisioned volumes is 128 TB.
For this command MB = 1048576 bytes, GB = 1024MB, and TB = 1024GB.
createvvcopy
DESCRIPTION
The createvvcopy command creates a full physical copy of a virtual volume or a read-write virtual copy
on another virtual volume. This enables you to create copies of virtual volumes to perform tasks such as
moving data to a larger virtual volume or creating a copy of data for testing.
SYNTAX
The syntax for the createvvcopy command can be one of the following:
createvvcopy [options] -p <parent_volume | parent_volumeset>
<destination_volume | destination_volumeset>
createvvcopy -p <parent_volume | parent_volumeset> -online [-snp_cpg
<snap_cpg>] [{-tpvv | -dedup | -compr}] [-wwn <wwn>] <destination cpg>
<destination volume>
createvvcopy -r [options] <destination_volume | destination_volumeset>
createvvcopy -halt <destination_volume | destination_volumeset>
AUTHORITY
•
•
Super, Edit
Any role granted the vvcopy_create right
OPTIONS
-p <parent_volume | parent_volumeset>
Specifies that a snapshot of the specified parent volume or volume set is created and copied to a
specified destination volume or volume set (as indicated with the <destination_volume |
destination_volumeset> specifier). The set name must start with "set:". The parent volume must be a
base volume or read-write snapshot. This option cannot be used with the -r option. Also note that a
volume set cannot be specified with the -online option.
-r
Specifies that the destination volume be re-synchronized with its parent volume using a saved snapshot
so that only the changes since the last copy or resynchronization need to be copied. A snapshot of the
parent saved using the -s option in an earlier createvvcopy instance is required for the
resynchronization operation. This old snapshot is replaced by a new snapshot for the next
resynchronization operation (the -s option is implied, and need not be specified). This option cannot be
used with the -p option.
-halt
Specifies that an ongoing physical copy to be stopped. This will cause the destination volume to be
marked with the 'cpf' status, which will be cleared up when a new copy is started.
-s
Saves the snapshot of the source volume after the copy of the volume is completed. This enables a fast
copy for the next resynchronization. If not specified, the snapshot is deleted and the association of the
destination volume as a copy of the source volume is removed. The -s option is implied when the -r option
is used and need not be explicitly specified.
-b
188
createvvcopy
Specifies that this command blocks until the operation is completed. If not specified, the createvvcopy
command operation is started as a background task.
-pri <high|med|low>
Specifies the priority of the copy operation when it is started. This option allows the user to control the
overall speed of a particular task. If this option is not specified, the createvvcopy operation is started
with default priority of medium. High priority indicates that the operation will complete faster. Low priority
indicates that the operation will run slower than the default priority task. This option cannot be used with halt option.
-online
Specifies that the copy is to be performed online. This means that the destination can be immediately
exported and is automatically created by this command, meaning that it cannot exist prior to executing
this command. This option requires the specification of a CPG for the destination volume and allows for
the options listed below. Finally, -online requires the -p option and is incompatible with the -r, -halt, -s, -b,
and -pri options.
-addtoset <set_name>
Adds the VV copies to the specified VV set. The set will be created if it does not exist. Can only be used
with -online option.
-skip_zero
When copying from a thin provisioned source, only copy allocated portions of the source VV. Using this
option can save time, but only use it if the destination is newly created or has been re-initialized to zero. If
there is pre-existing data in the destination VV it will not be overwritten to match the source VV if the
same offset is not allocated in the source. This option cannot be combined with -r, -halt, or online.
The following options can only be used when the -online option is specified:
-tpvv
Indicates that the VV the online copy creates should be a thinly provisioned volume. Cannot be used with
the -dedup option.
-tdvv
This option is deprecated, see -dedup.
-dedup
Indicates that the VV the online copy creates should be a thinly deduplicated volume, which is a thinly
provisioned volume with inline data deduplication. This option can only be used with a CPG that has SSD
(Solid State Drive) device type. Cannot be used with the -tpvv option.
-compr
Indicates that the VV the online copy creates should be a compressed virtual volume.
-snp_cpg <snp_cpg>
Specifies the name of the CPG from which the snapshot space will be allocated.
-wwn <wwn>
Specifies that the WWN of the online copy virtual volume use <wwn>. If this option is not used, the
system will automatically choose the WWN based on the system serial number, the volume ID, and the
wrap counter.
SPECIFIERS
<destination_cpg>
Specifies the destination CPG to use for the destination volume if the -online option is specified.
<destination_volume | destination_volumeset>
Create Commands
189
Specifies the destination volume name or volume set name for the copy operation using up to 31
characters in length. The volume set name must start with "set:". The destination volume (or each
member of the destination volume set) must be a writable base volume (not a snapshot) of equal or
greater size than a parent volume (if specified) and it must not be exported as a VLUN.
EXAMPLES
The following example displays the creation of a copy of the virtual volume vv1:
cli% createvvcopy -p vv1 vv2
Started copy. child=vv2 parent=vv1
Create a set of copies for the volumes in set vvcopyset, keeping snapshots around for quick
resynchronization:
cli% createvvcopy -s -p set:vvcopyset set:copies
Child Parent Status TaskID
s1
vv1
started
14
s2
vv2
started
15
s3
vv3
queued
16
Re-synchronize the volumes in the volume set "copies":
cli% createvvcopy -r set:copies
Child Parent Status TaskID
s1
started
17
s2
started
18
s3
queued
19
Create a set of copies for the volumes in set vvcopyset, mapping the parent volumes to destination
volumes with a pattern:
cli% createvvcopy -p set:vvcopyset @vvname@-copy
Child
Parent Status TaskID
vv1-copy vv1
started
20
vv2-copy vv2
started
21
vv3-copy vv3
queued
22
Create an online copy of vv1 that is named vv2 that is a thin-provisioned volume, with cpg1 as the
storage space for vv2:
cli% createvvcopy -p vv1 -online -tpvv cpg1 vv2
Create an online copy of vv1 that is named vv2 which is fully-provisioned, using cpg1 as its user space
and cpg2 as its snapshot space:
cli% createvvcopy -p vv1 -online -snp_cpg cpg2 cpg1 vv2
Create online copies for each member of vvset, adding each copy to newset:
190
Create Commands
cli% createvvcopy -p set:vvset -online -addtoset newset -tpvv FC_r1
@vvname@-copy
NOTES
The source and destination volumes must be writable. If the online option is specified, the destination
volume must not already exist.
The destination volume cannot be a system volume or a File Persona volume.
The destination volume cannot be exported as a VLUN before or during the createvvcopy command
process (except if online, see below).
The destination volume must be greater than or equal in size to the source volume.
If both the destination and source are volume sets then they must contain the same number of members.
If the source is a volume set then the destination name can contain various patterns that are used to form
the copy volume name. (For more information, issue "clihelp sub,vvnamepat" or see VV Name Patterns
on page 18.) Note that the time/date related patterns are not supported in this command.
If the -s option is specified to save a snapshot for fast resynchronization and the snapshot goes stale, the
copy fails.
A physical copy of a virtual volume fails in any situation that a snapshot copy fails or when there is
insufficient snapshot space or I/O errors.
The createvvcopy command can be issued multiple times. However, only two active physical copy
tasks per node in cluster are allowed to run concurrently.
Any additional physical copy tasks are queued, pending the completion of the active physical copy tasks.
Online copy tasks are performed using the region mover, which allows only nine region move tasks to run
concurrently.
Multiple physical copy operations can occur simultaneously. Host-initiated I/O operations and those
operations initiated by issuing the createvvcopy command are executed at the same priority level. As a
result, noticeable performance degradation from a host perspective can be observed.
Issuing the createvvcopy command results in the creation of a temporary snapshot and, in the case of
-r, a resynchronization (resync) snapshot.
The temporary and resynchronization snapshots cannot be deleted while the copy is in progress.
Upon completion of the copy, the temporary snapshot is automatically deleted if the -s option is not
specified.
If the resynchronization snapshot is saved, it can later be manually deleted. If the resynchronization
snapshot is deleted, later resynchronization is not possible.
If the -s option is not specified, the relationship between the destination volume and source volume is not
retained.
Issue the showvv on page 558 command to verify that a virtual volume copy has been made.
Issue the showvv -d command to display the number of blocks remaining to be copied.
If the source or destination are volume sets then the createvvcopy command creates consistent group
snapshots at the same point in time so that related structures on different volumes in the group remain
consistent.
On systems that support zero_detect, if destination volume is a TPVV, zero_detect policy is enabled at
start of physical copy. After physical copy completes, the policy is changed to no_zero_detect, even when
the destination TPVV had zero_detect policy enabled before the start of physical copy operation.
Create Commands
191
When Thin Persistence license is present, createvvcopy command will reclaim allocated space when
zero blocks are written to the destination TPVV.
If the -pri option is not specified, the physical copy will start at the default priority and behavior will be
similar to previous releases. If the tunes and host I/O are running then it is recommended to start vvcopy
with default priority.
The -online option for an online copy automatically creates a destination volume, so unlike other physical
copies, the destination volume should not exist. The destination volume requires a CPG to be specified,
and optionally it can be either a TPVV, TDVV, or have a snapshot CPG associated with it.
The destination volume can be immediately exported (hence the reason for the online option). The online
option is incompatible with the -r, -halt, -s, -pri, and -b options. The destination volume to be created can
be named with pattern substitution based on the source volume name. (For more information, issue
"clihelp sub,vvnamepat" or see VV Name Patterns on page 18 for details.)
createvvset
DESCRIPTION
The createvvset command defines a new set of Virtual Volumes (VV) and provides the option of
assigning one or more existing VVs to that set. The command also allows the addition of VVs to an
existing set by use of the -add option.
SYNTAX
createvvset [options] <setname> [<VV | pattern>...]
AUTHORITY
•
•
•
Super, Edit
Any role granted the vvset_create right can create a volume set
Any role granted the vvset_set right can add volumes to a volume set
OPTIONS
-add
Specifies that the VVs listed should be added to an existing set. At least one VV must be specified.
-cnt <num>
Add a sequence of <num> VVs starting with "vvname". vvname should be of the format
<basename>.<int> For each VV in the sequence, the .<int> suffix of the vvname is incremented by 1.
-comment <comment>
Specifies any comment or additional information for the set. The comment can be up to 255 characters
long. Unprintable characters are not allowed.
-domain <domain>
Create the VV set in the specified domain. For an empty set the default is to create it in the current
domain, or no domain if the current domain is not set. A VV set must be in the same domain as its
members; if VVs are specified as part of the creation then the set will be created in their domain. A
domain cannot be specified when adding a VV to an existing set with the -add option.
SPECIFIERS
<setname>
Specifies the name of the vv set to create/add to, using up to 27 characters in length.
<VV | pattern>...
192
createvvset
Optional list of VVs or glob-style pattern matching VVs which are to be included in the VV set. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.) If no <VV> or <pattern>
is specified a VV set with no VVs is created. If the -cnt option is used then a VV must be specified.
EXAMPLES
To create an empty vvset:
cli% createvvset vvset
To add a VV to the set:
cli% createvvset -add vvset vv1
To create a VV set with a comment and a collection of VVs in it:
cli% createvvset -comment "Our Oracle VVs" -cnt 10 oravv oravv.0
To create a VV set with VVs in it:
cli% createvvset vvset vv1 vv2
Or:
cli% createvvset set:vvset vv1 vv2
NOTES
None.
Create Commands
193
Dismiss Commands
dismisspd
DESCRIPTION
The dismisspd command removes PD definitions from system use.
SYNTAX
dismisspd <PD_ID>...
AUTHORITY
•
•
Super, Service
Any role granted the pd_dismiss right
OPTIONS
None.
SPECIFIERS
<PD_ID>
Specifies the PD(s), identified by integers, to be removed from system use.
EXAMPLES
The following example removes a PD with ID 1:
cli% dismisspd 1
NOTES
Access to all domains is required to run this command.
A PD that is in use cannot be removed.
Verify the removal of a PD by issuing the showpd on page 491 command.
dismissrcopylink
DESCRIPTION
The dismissrcopylink command removes one or more links (connections) created with the
admitrcopylink command to a target system.
SYNTAX
Syntax for remote copy over IP (RCIP) is as follows:
dismissrcopylink <target_name> <node:slot:port:IP_address>...
Syntax for remote copy over FC (RCFC) is as follows:
dismissrcopylink <target_name> <node:slot:port:WWN>...
AUTHORITY
•
•
194
Super, Edit
Any role granted the rcopylink_dismiss right
Dismiss Commands
OPTIONS
None.
SPECIFIERS
<target_name>
The target name, as specified with the creatercopytarget command.
<node:slot:port:IP_address>...
Specifies the node, slot, and port of the Ethernet port on the local system and an IP address of the peer
port on the target system.
<node:slot:port:WWN>...
Specifies the node, slot, and port of the Fibre Channel port on the local system and World Wide Name
(WWN) of the peer port on the target system.
EXAMPLES
The following example removes the link from the Ethernet port located at 2:2:2 of System2:
dismissrcopylink System2 2:2:2:193.1.2.11
NOTES
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
Access to all domains is required to run this command.
This command should only be used to remove sending links.
This command cannot be used to remove the last link of a target system with started groups.
This command terminates with a list of one or more links to be dismissed.
For IP targets, this list is made up of pairs composed of the node containing the Ethernet port on the
primary system and an IP address on the backup system.
For Fibre Channel targets, this list is made up of sets with the node, slot, and port of the Fibre Channel
adaptor port on the primary system and a WWN address on the backup system.
IP targets are made up of pairs composed of the node, slot and port of the ethernet port on the local
system and an IP address of the peer port on the target system.
FC targets are made up of sets with the node, slot, and port of the FC port on the local system and WWN
of the peer port on the target system.
dismissrcopytarget
DESCRIPTION
The dismissrcopytarget command removes a remote copy target from a remote copy volume group.
SYNTAX
dismissrcopytarget [options] <target_name> <group_name>
AUTHORITY
•
•
Super, Edit
Any role granted the rcopytarget_dismiss right
dismissrcopytarget
195
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<target_name>
The name of the target to be removed.
<group_name>
The name of the group that currently includes the target.
EXAMPLES
The following example removes target Target1 from Group1:
cli% dismissrcopytarget Target1 Group1
NOTES
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
The dismissrcopytarget command will not allow the removal of a group's last target.
dismissrcopyvv
DESCRIPTION
The dismissrcopyvv command removes a virtual volume from a remote copy volume group.
SYNTAX
dismissrcopyvv [options] {<pattern> | <VV_name>} <group_name>
AUTHORITY
•
•
Super, Edit
Any role granted the rcopyvv_dismiss right
OPTIONS
-f
Does not ask for confirmation for the dismissrcopyvv command.
-pat
Specifies that specified patterns are treated as glob-style patterns and all remote copy volumes matching
the specified pattern will be dismissed from the remote copy group. This option must be used if the
<pattern> specifier is used.
-keepsnap
Specifies that the local volume's resync snapshot should be retained.
The retained snapshot will reflect the state of the secondary volume and might be used as the starting
snapshot if the volume is readmitted to a remote copy group. The snapshot name will begin with "sv.rcpy".
-removevv
196
dismissrcopyvv
Remove remote sides' volumes.
SPECIFIERS
<VV_name>
The name of the volume to be removed. Volumes are added to a group with the admitrcopyvv on page
75 command.
<pattern>
Specifies a glob-style pattern. This specifier can be repeated to dismiss multiple remote copy volumes. If
this specifier is not used, the <VV_name> specifier must be used.
<group_name>
The name of the group that currently includes the virtual volume.
EXAMPLES
The following example dismisses virtual volume vv1 from Group1:
cli% dismissrcopyvv vv1 Group1
The following example dismisses all virtual volumes that start with the name testvv from Group1:
cli% dismissrcopyvv -pat testvv* Group1
The following example dismisses volume vv1 from Group1 and removes the corresponding volumes of
vv1 on all the target systems of Group1.
cli% dismissrcopyvv -removevv vv1 Group1
The following example dismisses volume vv2 from Group2 and retains the resync snapshot associated
with vv2 for this group.
cli% dismissrcopyvv -keepsnap vv2 Group2
NOTES
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
Access to all domains is required to run this command.
A volume cannot be removed from a group that is not currently stopped.
The -keepsnap and -removevv options are mutually exclusive.
The dismissrcopyvv command removes any Remote Copy synchronization snapshots affiliated with
the removed volume.
Dismiss Commands
197
If a group's target has the mirror_config policy set and the group is a primary group, this command is
mirrored to that target and the volume is removed from the corresponding secondary group. If the policy
is set and the group is a secondary, this command fails.
198
Dismiss Commands
Free Command
freespace
DESCRIPTION
The freespace command frees snapshot administration and snapshot data spaces from a Virtual
Volume (VV) if they are not in use.
SYNTAX
freespace [options] <VV_name>...|<pattern>...
AUTHORITY
•
•
Super, Edit
Any role granted the space_free right
OPTIONS
-pat
Remove the snapshot administration and snapshot data spaces from all the virtual volumes that match
any of the specified glob-style patterns.
-f
Suppresses the prompt for confirmation before removing the snapshot administration and snapshot data
space of each volume.
SPECIFIERS
<VV_name>...
Specifies the virtual volume name, using up to 31 characters.
<pattern>...
Specifies a glob-style pattern. This specifier can be repeated to compact multiple volumes. If this specifier
is not used, the VV_name specifier must be used.
EXAMPLES
The following example demonstrates how to remove SA and SD space from virtual volume testd:
cli% freespace testd
NOTES
This command fails if the virtual volume is an old-style thin provisioned VV (created on a 2.2.4 release or
earlier) or it has snapshots.
Free Command
199
Grow Commands
growfpg
DESCRIPTION
The growfpg command grows a file provisioning group of the given name by the size specified, within
the CPG associated with the base FPG.
SYNTAX
growfpg <fpgname> <size>{t|T|g|G}
growfpg -recover_storage
AUTHORITY
•
•
Super, Edit
Any role granted fpg_grow right
OPTIONS
-nowwn
For use with -rcopy. Do not use the same VV WWN for secondary volumes.
-recover_storage
Rescans all VVs associated with FPGs and ensures all storage is available for use.
SPECIFIERS
<fpgname>
The name of the filesystem to be grown.
<size>
The size of the filesystem to be grown. The current FPG size plus <size> cannot exceed 64T.
EXAMPLES
The following example grows examplefpg by 8T:
cli% growfpg examplefpg 8T
NOTES
Access to all domains is required to run this command.
For each grow undertaken, VVs will be grown more evenly, with priority given to those which are
considered full by the StoreServ.
The grow operation will not be visible in the showfpg on page 447 output until the FPG is activated.
The growfpg command examines the existing FPG VVs to see if there is a remote copy relationship. If
one is found, the new volumes will be added to the appropriate group and target automatically. If an error
occurs, during this process the grow will not be undone. Secondary volumes are automatically created
and have the base VV name with "_sec" appended.
An FPG must be grown by a minimum of 100GiB.
200
Grow Commands
growvv
DESCRIPTION
The growvv command increases the size of a virtual volume.
SYNTAX
growvv [options] <VV_name> size[g|G|t|T]
AUTHORITY
•
•
Super, Edit
Any role granted the vv_grow right
OPTIONS
-f
Suppresses the requested confirmation before growing a virtual volume size from under 2T to over 2T.
SPECIFIERS
<VV_name>
Specifies the name of the virtual volume to grow.
<size>[g|G|t|T]
Specifies the size in MB to be added to the volume user space. The size must be an integer in the range
from 1 MB to 128 TB. The volume size is rounded up to the next multiple of 256 MB. If the value is
followed by a g or G (no whitespace before the suffix), the size is in GB; if by a t or T, the size is in TB.
EXAMPLES
The following example displays the enlarging of the virtual volume vv0 by 10G:
cli% growvv vv0 10g
NOTES
Access to all domains is required to run this command with logical disks specified.
For this command MB = 1048576 bytes, GB = 1024MB, and TB = 1024GB.
If the volume to be grown is in a Remote Copy group, the group must be stopped before the grow
operation is permitted.
The grow operations of Remote Copy volumes are coordinated between the primary and secondary
targets. A coordinated grow can be started from either the primary or secondary target. Volumes on
remote targets are grown to the intended size of the local volume. If a target cannot be contacted or
Remote Copy is not started, only the local volume will be grown. A check is first made to see if the local
and remote volumes can be grown by the requested amount. If this succeeds, all the volumes are grown;
however, if other volumes are grown during this process, it is possible that remote volumes are grown and
the local volume is not. If this occurs, remote volumes must be grown manually before the group can be
started.
If the volume to be grown is a member of a File Provisioning Group, it cannot be grown.
growvv
201
Hist Commands
histch
DESCRIPTION
The histch command displays a histogram of service times in a timed loop for individual chunklets.
SYNTAX
histch [options <arg>]
AUTHORITY
•
Any role in the system
OPTIONS
-ld <LD_name>
Specifies the logical disk name from which chunklet statistics are sampled.
-ch <chunklet_num>
Specifies that statistics are limited to only the specified chunklet, identified by number.
-metric both|time|size
Selects which metric to display. Metrics can be one of the following:
•
•
•
both—(Default)Display both I/O time and I/O size histograms
time—Display only the I/O time histogram
size—Display only the I/O size histogram
-timecols <fcol> <lcol>
For the I/O time histogram, shows the columns from the first column <fcol> through last column <lcol>.
The available columns range from 0 through 31.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>).
The last column (<lcol>) must be less than or equal to 31.
The first column includes all data accumulated for columns less than the first column and the last column
includes accumulated data for all columns greater than the last column.
The default value of <fcol> is 6.
The default value of <lcol> is 15.
-sizecols <fcol> <lcol>
For the I/O size histogram, shows the columns from the first column (<fcol>) through the last column
(<lcol>). Available columns range from 0 through 15.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>) (default value of 3).
The last column (<lcol>) must be less than or equal to 15 (default value of 11).
The default value of <fcol> is 3.
The default value of <lcol> is 11.
-pct
202
Hist Commands
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
-prev | -begin
Histogram displays data either from a previous sample (-prev) or from when the system was last started (begin). If no option is specified, the histogram shows data from the beginning of the command's
execution.
-rw
Specifies that the display includes separate read and write data. If not specified, the total is displayed.
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-filt <fspec>
Specifies that histograms below the threshold specified by the <fspec> argument are not displayed. The
<fspec> argument is specified in the syntax of <op>,<val_ms>, <count>.
•
•
•
<op> The <op> argument can be specified as one of the following:
◦ r—Specifies read statistics.
◦ w—Specifies write statistics.
◦ t—Specifies total statistics.
◦ rw—Specifies total read and write statistics.
<val_ms> Specifies the threshold service time in milliseconds.
<count> Specifies the minimum number of access above the threshold service time. When filtering is
done, the <count> is compared with the sum of all columns starting with the one which corresponds to
the threshold service time. For example, -t,8,100 means to only display the rows where the 8ms
column and all columns to the right adds up to more than 100.
-ni
Specifies that histograms for only non-idle devices are displayed. This option is shorthand for the option filt t,0,0.
SPECIFIERS
None.
EXAMPLES
The following example displays one iteration of a histogram of service times for system chunklets:
Hist Commands
203
cli% histch -iter 1
12:42:57 10/20/15 ------------Time (millisec)-----------Ldid
Ldname LdCh Pdid PdCh 0.26 0.53 1.05 2.1 4.2 8.4 17 34 67 135
2 tp-0-sa-0.0
1
21
0
0
0
0
0
0
0 0 0 0
0
2 tp-0-sa-0.0
0
45
0
0
0
0
0
0
0 0 0 0
0
1 tp-0-sa-0.1
1
20
0
0
0
0
0
0
1 0 0 0
0
1 tp-0-sa-0.1
0
42
0
0
0
0
0
0
1 0 0 0
0
0 admin.usr.0
1
22
3
0
0
0
1
0
3 2 0 0
0
0 admin.usr.0
0
44
3
0
0
0
0
1
3 2 0 0
0
----------------------------------------------------------------------total
0
0
0
1
1
8 4 0 0
0
For the previous example, before the histch command was issued, the setstatch start command
was issued for chunklets 0 and 1 on logical disks admin.usr.0, tp-0-sa-0.1, and tp-0-sa-0.0.
NOTES
For the following options, by default the histogram shows data from the start of the command.
The setstatch on page 397 command must be issued to enable statistics collection on chunklets before
issuing the histch command.
Each service time histogram column shows the number of accesses with service times between the point
in time shown in the column's heading to the point in time shown in the heading of the column to its right
(or infinity for the last column). Unless all columns are shown, the first column shows the number of
accesses with service times less than the heading of the second column.
Each I/O size histogram column shows the number of accesses with I/O size between the size shown in
the column's heading to the size shown in the heading of the column to its right (or infinity for the last
column).
For all the <name_or_pattern> fields, the patterns are glob-style (shell-style) patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
histld
DESCRIPTION
The histld command displays a histogram of service times for LDs in a timed loop.
SYNTAX
histld [options <arg>] [<LD_name_or_pattern> ...]
AUTHORITY
•
Any role in the system
OPTIONS
-vv {<VV_name>|<pattern>}...
Shows only logical disks that are mapped to virtual volumes with names matching any of the names or
patterns specified. Multiple volumes or patterns can be repeated using a comma separated list.
-domain {<domain_name>|<pattern>}...
Shows only logical disks that are in domains with names matching any of the names or patterns specified.
Multiple domain names or patterns can be repeated using a comma separated list.
-metric both|time|size
204
histld
Selects which metric to display. Metrics can be one of the following:
•
•
•
both—(Default)Display both I/O time and I/O size histograms
time—Display only the I/O time histogram
size—Display only the I/O size histogram
-timecols <fcol> <lcol>
For the I/O time histogram, shows the columns from the first column <fcol> through last column <lcol>.
The available columns range from 0 through 31.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>).
The last column (<lcol>) must be less than or equal to 31.
The first column includes all data accumulated for columns less than the first column and the last column
includes accumulated data for all columns greater than the last column.
The default value of <fcol> is 6.
The default value of <lcol> is 15.
-sizecols <fcol> <lcol>
For the I/O size histogram, shows the columns from the first column (<fcol>) through the last column
(<lcol>). Available columns range from 0 through 15.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>) (default value of 3).
The last column (<lcol>) must be less than or equal to 15 (default value of 11).
The default value of <fcol> is 3.
The default value of <lcol> is 11.
-pct
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
-prev | -begin
Histogram displays data either from a previous sample (-prev) or from when the system was last started (begin). If no option is specified, the histogram shows data from the beginning of the command's
execution.
-rw
Specifies that the display includes separate read and write data. If not specified, the total is displayed.
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Hist Commands
205
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-filt <fspec>
Specifies that histograms below the threshold specified by the <fspec> argument are not displayed. The
<fspec> argument is specified in the syntax of <op>,<val_ms>, <count>.
<op> The <op> argument can be specified as one of the following:
•
•
•
•
r—Specifies read statistics.
w—Specifies write statistics.
t—Specifies total statistics.
rw—Specifies total read and write statistics.
<val_ms> Specifies the threshold service time in milliseconds.
<count> Specifies the minimum number of access above the threshold service time. When filtering is
done, the <count> is compared with the sum of all columns starting with the one which corresponds to the
threshold service time. For example, -t,8,100 means to only display the rows where the 8ms column and
all columns to the right adds up to more than 100.
-ni
Specifies that histograms for only non-idle devices are displayed. This option is shorthand for the option filt t,0,0.
SPECIFIERS
[<LD_name_or_pattern>]
Specifies the LD(s) or pattern(s) for which the histogram data is collected.
EXAMPLES
The following example displays one iteration of a histogram of service times for all LDs:
cli% histld -iter 1
08:38:19 06/04/2015 ----------Time (millisec)---------- --------------Size
(bytes)-------------Ldname 0.50
1 2 4 8 16 32 64 128 256
4k
8k 16k 32k
64k 128k 256k 512k 1m
admin.usr.0
0
0 0 0 2 0 0 0
0
0
2
0
0
0
0
0
0
0 0
.srdata.usr.0
0
0 0 0 0 0 0 0
0
0
0
0
0
0
0
0
0
0 0
log0.0
0
0 0 0 0 0 0 0
0
0
0
0
0
0
0
0
0
0 0
pdsld0.0
0
0 0 0 0 0 0 0
0
0
0
0
0
0
0
0
0
0 0
NOTES
Each service time histogram column shows the number of accesses with service times between the point
in time shown in the column's heading to the point in time shown in the heading of the column to its right
(or infinity for the last column). Unless all columns are shown, the first column shows the number of
accesses with service times less than the heading of the second column.
206
Hist Commands
Each I/O size histogram column shows the number of accesses with I/O size between the size shown in
the column's heading to the size shown in the heading of the column to its right (or infinity for the last
column).
For all the <name_or_pattern> fields, the patterns are glob-style (shell-style) patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
If the <LD_name_or_pattern> specifier is used, then logical disks with names that match any of the
patterns are listed, otherwise all logical disks are listed. These patterns are glob-style patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
Patterns are specified as regular expressions. (For more information or regexps, issue "clihelp
sub,regexpat" or see Regular Expressions Patterns on page 16.) Issuing histld -n LD_name.*
displays histogram data for all LDs whose name begins with LD_name.
histpd
DESCRIPTION
The histpd command displays a histogram of service times for PDs.
SYNTAX
histpd [options <arg>]
AUTHORITY
•
Any role in the system
OPTIONS
-w <WWN>
Specifies the world wide name of the PD for which service times are displayed.
-nodes <node_list>
Specifies that the display is limited to specified nodes and physical disks connected to those nodes. The
node list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the node list is not specified, all disks on all nodes are displayed.
-slots <slot_list>
Specifies that the display is limited to specified PCI slots and physical disks connected to those PCI slots.
The slot list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist
of a single integer. If the slot list is not specified, all disks on all slots are displayed.
-ports <port_list>
Specifies that the display is limited to specified ports and physical disks connected to those ports. The
port list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the port list is not specified, all disks on all ports are displayed.
-devinfo
Indicates the device disk type and speed.
-metric both|time|size
Selects which metric to display. Metrics can be one of the following:
•
•
•
both—(Default)Display both I/O time and I/O size histograms
time—Display only the I/O time histogram
size—Display only the I/O size histogram
-timecols <fcol> <lcol>
histpd
207
For the I/O time histogram, shows the columns from the first column <fcol> through last column <lcol>.
The available columns range from 0 through 31.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>).
The last column (<lcol>) must be less than or equal to 31.
The first column includes all data accumulated for columns less than the first column and the last column
includes accumulated data for all columns greater than the last column.
The default value of <fcol> is 6.
The default value of <lcol> is 15.
-sizecols <fcol> <lcol>
For the I/O size histogram, shows the columns from the first column (<fcol>) through the last column
(<lcol>). Available columns range from 0 through 15.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>) (default value of 3).
The last column (<lcol>) must be less than or equal to 15 (default value of 11).
The default value of <fcol> is 3.
The default value of <lcol> is 11.
-pct
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
-prev | -begin
Histogram displays data either from a previous sample (-prev) or from when the system was last started(begin). If no option is specified, the histogram shows data from the beginning of the command's
execution.
-rw
Specifies that the display includes separate read and write data. If not specified, the total is displayed.
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-filt <fspec>
Specifies that histograms below the threshold specified by the <fspec> argument are not displayed. The
<fspec> argument is specified in the syntax of <op>,<val_ms>, <count>.
208
Hist Commands
<op> The <op> argument can be specified as one of the following:
•
•
•
•
r—Specifies read statistics.
w—Specifies write statistics.
t—Specifies total statistics.
rw—Specifies total read and write statistics.
<val_ms> Specifies the threshold service time in milliseconds.
<count> Specifies the minimum number of access above the threshold service time. When filtering is
done, the <count> is compared with the sum of all columns starting with the one which corresponds to the
threshold service time. For example, -t,8,100 means to only display the rows where the 8ms column and
all columns to the right adds up to more than 100.
-ni
Specifies that histograms for only non-idle devices are displayed. This option is shorthand for the option filt t,0,0.
-devsvtime
Specifies the time spent in the drive, not including queue time. Shows the average and current time in ms.
-p <pattern>
Specifies the pattern of PDs displayed in the histogram.
Patterns are used to filter and select the disks displayed in the histogram. If specified multiple times, each
instance of the specified pattern adds additional candidate disks that match the pattern.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0- 7).
The primary path of the disks must be on the specified node(s).
-st <item>
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0- 7).
The primary path of the disks must be on the specified PCI slot(s).
-pt <item>
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0- 4).
The primary path of the disks must be on the specified port(s).
-cg <item>
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
•
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
output indicating the side of the cage is omitted when using the -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single comma
(e.g. 1,2,3). A range of drive magazines is separated with a hyphen(e.g. 0-7). The specified drive
magazine(s) must contain disks.
-pn <item>
Hist Commands
209
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen (e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
•
Specifies one or more physical disks. Disks are identified by one or more integers (item). Multiple
disks are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g.
0-3). Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
Specifies that physical disks with free chunklets greater than the number specified be selected.
-fc_lt <number>
•
Specifies that physical disks with free chunklets less than the number specified be selected.
-devid <model>
•
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the "showpd -i" command.
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd"
command.
-rpm <number>
Drives must be of the specified relative performance metric, as shown in the "RPM" column of the
"showpd" command. The number does not represent a rotational speed for the drives without spinning
media (SSD). It is meant as a rough estimation of the performance difference between the drive and
the other drives in the system. For FC and NL drives, the number corresponds to both a performance
measure and actual rotational speed. For SSD drives, the number is to be treated as a relative
performance benchmark that takes into account I/O's per second, bandwidth and access time.
Disks that satisfy all of the specified characteristics are used.
For example -p -fc_gt 60 -fc_lt 230 -nd 2 specifies all the disks that have greater than 60 and less than
230 free chunklets and that are connected to node 2 through their primary path.
SPECIFIERS
None.
EXAMPLES
The following example displays a histogram of service times for all PDs:
cli% histpd
The following example displays a histogram of service times for all PDs and shows the columns from 8ms
to 8192 ms. Only PDs with more than 500 accesses with service time equal or greater than 16ms are
displayed:
210
Hist Commands
cli% histpd -begin -metric time -timecols 10 20 -filt t,16,500
23:01:12 08/09/10 ------------------Time (millisec)-----------------ID
Port
8
16
32 64 128 256 512 1024 2048 4096 8192
0
0:0:1 3647
550
29 1
0
0
0
0
0
0
0
1
1:0:1 2742
969 111 7
0
0
0
0
0
0
0
3
1:0:1 4181 2786 292 0
0
0
0
0
0
0
0
5
1:0:1 3397 1818 228 3
0
0
0
0
0
0
0
7
1:0:1 2793 1281
77 0
1
0
0
0
0
0
0
8
0:0:1 1449
801
23 0
0
0
0
0
0
0
0
9
1:0:1 2425 2779 287 3
0
0
0
0
0
0
0
11
1:0:1 3526
860 157 1
1
0
0
0
0
0
0
12
0:0:1 6049 2171
58 3
0
0 13
6
0
0
0
13
1:0:1 4444 2942 261 9
0
0
0
0
0
0
0
16
0:0:2 3630
555
35 0
0
0
0
0
0
0
0
17
1:0:2 2769
958 105 0
0
0
0
0
0
0
0
19
1:0:2 4227 2773 263 0
0
0
0
0
0
0
0
21
1:0:2 2757 2353 339 4
0
0
0
0
0
0
0
23
1:0:2 2735 1321
94 2
0
0
0
0
0
0
0
24
0:0:2 1360
577
15 2
0
2
3
0
0
0
0
25
1:0:2 2484 2420 286 0
0
0
0
0
0
0
0
27
1:0:2 4504
633 122 1
0
0
0
0
0
0
0
28
0:0:2 6059 2177
65 3
0
1
1
2
0
0
0
29
1:0:2 4245 3113 300 1
0
0
0
0
0
0
0
--------------------------------------------------------------------total
69423 33837 3147 40
2
3 17
8
0
0
0
Press the enter key to stop...
NOTES
Each service time histogram column shows the number of accesses with service times between the point
in time shown in the column's heading to the point in time shown in the heading of the column to its right
(or infinity for the last column). Unless all columns are shown, the first column shows the number of
accesses with service times less than the heading of the second column.
Each I/O size histogram column shows the number of accesses with I/O size between the size shown in
the column's heading to the size shown in the heading of the column to its right (or infinity for the last
column).
For all the <name_or_pattern> fields, the patterns are glob-style (shell-style) patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
histport
DESCRIPTION
The histport command displays a histogram of service times for ports within the system.
SYNTAX
histport [options <arg>]
AUTHORITY
•
Any role in the system
OPTIONS
-both | -ctl | -data
histport
211
Specifies that both control and data transfers are displayed (-both), only control transfers are displayed (ctl), or only data transfers are displayed (-data). If this option is not specified, only data transfers are
displayed.
-nodes <node_list>
Specifies that the display is limited to specified nodes and physical disks connected to those nodes. The
node list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the node list is not specified, all disks on all nodes are displayed.
-slots <slot_list>
Specifies that the display is limited to specified PCI slots and physical disks connected to those PCI slots.
The slot list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist
of a single integer. If the slot list is not specified, all disks on all slots are displayed.
-ports <port_list>
Specifies that the display is limited to specified ports and physical disks connected to those ports. The
port list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the port list is not specified, all disks on all ports are displayed.
-host|-disk|-rcfc|-peer
Specifies to display only host ports (target ports), only disk ports (initiator ports), only Fibre Channel
Remote Copy configured ports, or only Fibre Channel ports for Data Migration.
If no option is specified, all ports are displayed.
-metric both|time|size
Selects which metric to display. Metrics can be one of the following:
•
•
•
both—(Default)Display both I/O time and I/O size histograms
time—Display only the I/O time histogram
size—Display only the I/O size histogram
-timecols <fcol> <lcol>
For the I/O time histogram, shows the columns from the first column <fcol> through last column <lcol>.
The available columns range from 0 through 31.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>).
The last column (<lcol>) must be less than or equal to 31.
The first column includes all data accumulated for columns less than the first column and the last column
includes accumulated data for all columns greater than the last column.
The default value of <fcol> is 6.
The default value of <lcol> is 15.
-sizecols <fcol> <lcol>
For the I/O size histogram, shows the columns from the first column (<fcol>) through the last column
(<lcol>). Available columns range from 0 through 15.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>) (default value of 3).
The last column (<lcol>) must be less than or equal to 15 (default value of 11).
The default value of <fcol> is 3.
The default value of <lcol> is 11.
-pct
212
Hist Commands
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
-prev | -begin
Histogram displays data either from a previous sample (-prev) or from when the system was last started (begin). If no option is specified, the histogram shows data from the beginning of the command's
execution.
-rw
Specifies that the display includes separate read and write data. If not specified, the total is displayed.
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-filt <fspec>
Specifies that histograms below the threshold specified by the <fspec> argument are not displayed. The
<fspec> argument is specified in the syntax of <op>,<val_ms>, <count>.
<op> The <op> argument can be specified as one of the following:
•
•
•
•
r—Specifies read statistics.
w—Specifies write statistics.
t—Specifies total statistics.
rw—Specifies total read and write statistics.
<val_ms> Specifies the threshold service time in milliseconds.
<count> Specifies the minimum number of access above the threshold service time. When filtering is
done, the <count> is compared with the sum of all columns starting with the one which corresponds to the
threshold service time. For example, -t,8,100 means to only display the rows where the 8ms column and
all columns to the right adds up to more than 100.
-ni
Specifies that histograms for only non-idle devices are displayed. This option is shorthand for the option filt t,0,0.
SPECIFIERS
None.
EXAMPLES
The following example displays a histogram of service times for reads and writes to ports:
Hist Commands
213
cli% histport
12:35:24 10/20/04 ------------Time (millisec)------------Port
D/C 0.26 0.53 1.05 2.1 4.2 8.4 17 34 67 135
0:0:1
data
0
0
0
0
0
0
0 0 0
0
0:0:2
data 315 778
2
0
0
0
0 0 0
0
0:1:1
data
0
0
0
5 24 51 25 4 0
0
0:1:2
data
0
0
0
5 27 53 23 1 0
0
1:5:1
data
0
0
0
2 19 38 28 11 0
0
1:5:2
data
0
0
0
5 20 36 29 7 0
0
---------------------------------------------------------total
data 315 778
2 17 90 178 105 23 0
0
Press the enter key to stop...
NOTES
Each service time histogram column shows the number of accesses with service times between the point
in time shown in the column's heading to the point in time shown in the heading of the column to its right
(or infinity for the last column). Unless all columns are shown, the first column shows the number of
accesses with service times less than the heading of the second column.
Each I/O size histogram column shows the number of accesses with I/O size between the size shown in
the column's heading to the size shown in the heading of the column to its right (or infinity for the last
column).
For all the <name_or_pattern> fields, the patterns are glob-style (shell-style) patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
histrcvv
DESCRIPTION
The histrcvv command shows a histogram of total remote copy service times and backup remote copy
service times in a timed loop.
SYNTAX
histrcvv [options <arg>] [<VV_name>|<pattern>]...
AUTHORITY
•
Any role in the system
OPTIONS
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the statistics are to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-t <target_name>...|<pattern>...
Shows only volumes whose group is copied to the specified target name or pattern. Multiple target names
or patterns may be specified using a comma-separated list.
-port <port_NSP>...|<pattern>...
Show only volumes which are copied over the specified port or pattern.
214
histrcvv
Multiple ports or patterns may be specified using a comma-separated list.
-g <group_name>...|<pattern>...
Shows only volumes whose group matches the specified group name or pattern. Multiple group names or
patterns may be specified using a comma-separated list.
-async
Show only volumes which are being copied in asynchronous mode.
-sync
Show only volumes which are being copied in synchronous mode.
-periodic
Show only volumes which are being copied in periodic mode.
-primary
Show only volumes which are in the primary role.
-secondary
Show only volumes which are in the secondary role.
-targetsum
Specifies that the sums for all volumes of a target are displayed.
-portsum
Specifies that the sums for all volumes on a port are displayed.
-groupsum
Specifies that the sums for all volumes of a group are displayed.
-vvsum
Specifies that the sums for all targets and links of a volume are displayed.
-domainsum
Specifies that the sums for all volumes of a domain are displayed.
-domain <domainname>...|<pattern>...
Shows only the virtual volumes that are in domains with names that match the specified domain name(s)
or pattern(s).
-timecols <fcol> <lcol>
For the I/O time histogram, shows the columns from the first column <fcol> through last column <lcol>.
The available columns range from 0 through 31.
0 <= fcol < lcol <= 31 must be satisfied.
The default value of <fcol> is 6.
The default value of <lcol> is 15.
-pct
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
-prev
Specifies that the histogram displays data from a previous sample.
If no option is specified, the histogram shows data from the beginning of the command's execution.
Hist Commands
215
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-filt <fspec>
Specifies that histograms below the threshold specified by the <fspec> argument are not displayed. The
<fspec> argument is specified in the syntax of <op>,<val_ms>, <count>.
<op> The <op> argument can be specified as one of the following:
•
•
•
•
r—Specifies read statistics.
w—Specifies write statistics.
t—Specifies total statistics.
rw—Specifies total read and write statistics.
<val_ms> Specifies the threshold service time in milliseconds.
<count> Specifies the minimum number of access above the threshold service time. When filtering is
done, the <count> is compared with the sum of all columns starting with the one which corresponds to the
threshold service time. For example, -t,8,100 means to only display the rows where the 8ms column and
all columns to the right adds up to more than 100.
-ni
Specifies that histograms for only non-idle devices are displayed. This option is shorthand for the option filt t,0,0.
SPECIFIERS
<VV_name|pattern>
Displays statistics only for the specified virtual volume or volume name pattern. Multiple volumes or
patterns can be repeated (for example, <VV_name> <VV_name>). If not specified, all virtual volumes that
are configured for remote copy are listed.
EXAMPLES
The following example shows histograms sums for all synchronous Remote Copy volumes:
216
Hist Commands
cli% histrcvv -vvsum -sync
09:50:40 03/30/10 ----------Svt (millisec)---------- -------Rmt
Svt (millisec)-------VVname RCGroup Target Mode 0.50 1 2
4
8 16 32 64 128 256 0.50
1
2 4 8 16 32 64 128 256
testvv.2 multi.1
amp2 Sync
0 0 0 163 61 16 3 0
0
0
0 224
19 0 0 0 0 0
0
0
testvv.3 multi.1
amp2 Sync
0 0 0 138 62 37 4 2
0
0
0 224
19 0 0 0 0 0
0
0
testvv.8 sync.2
amp3 Sync
0 0 0
0
0
4 13 11
5
4
0
0
0 0 4 12 12 7
1
1
testvv.4 multi.1
amp2 Sync
0 0 0 54 132 52 17 2
0
0
0 252
5 0 0 0 0 0
0
0
testvv.0 multi.1
amp2 Sync
0 0 0 59 138 57 17 2
0
0
0 258
15 0 0 0 0 0
0
0
testvv.9 sync.2
amp3 Sync
0 0 0
0
1
0 14 8
6
3
0
0
0 0 2 7 14 4
4
1
testvv.1 multi.1
amp2 Sync
0 0 0 130 71 40 3 0
0
0
0 225
19 0 0 0 0 0
0
0
-----------------------------------------------------------------------------------------------total
0 0 0 544 465 206 71 25 11
7
0 1183
77 0 6 19 26 11
5
2
Press the enter key to stop...
Use the following to get a description of each column in the above examples:
clihelp -col histrcvv
NOTES
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
histvlun
DESCRIPTION
The histvlun command displays VLUN service time histograms.
SYNTAX
histvlun [options <arg>]
AUTHORITY
•
Any role in the system
OPTIONS
-domain <domain_name>...|<pattern>...
Shows only VLUNs whose virtual volumes are in domains with names that match one or more of the
specified domain names or patterns. Multiple domain names or patterns can be repeated using a commaseparated list.
-host <hostname>...|<pattern>...
histvlun
217
Shows only VLUNs exported to the specified host(s) or pattern(s).
Multiple host names or patterns can be repeated using a comma-separated list.
-v <VV_name>...|<pattern>...
Requests that only logical disks mapped to virtual volumes that match any of the specified names or
patterns be displayed. Multiple volume names or patterns can be repeated using a comma-separated list.
-l <LUN>...|<pattern>...
Specifies that VLUNs with LUNs matching the specified LUN(s) or pattern(s) are displayed. Multiple LUNs
or patterns can be repeated using a comma-separated list.
-nodes <node_list>
Specifies that the display is limited to specified nodes and physical disks connected to those nodes. The
node list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the node list is not specified, all disks on all nodes are displayed.
-slots <slot_list>
Specifies that the display is limited to specified PCI slots and physical disks connected to those PCI slots.
The slot list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist
of a single integer. If the slot list is not specified, all disks on all slots are displayed.
-ports <port_list>
Specifies that the display is limited to specified ports and physical disks connected to those ports. The
port list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the port list is not specified, all disks on all ports are displayed.
-lw
Lists the host's WWN or iSCSI name. This is especially useful when multiple WWNs or iSCSI names
belonging to the same host are visible on the same port.
-domainsum
Specifies that sums for VLUNs are grouped by domain in the display. All VLUNs to unnamed hosts are
added and displayed as a single set of data with a "-" host name.
-vvsum
Specifies that sums for VLUNs of the same virtual volume are displayed.
-hostsum
Specifies that sums for VLUNs are grouped by host in the display. All VLUNs to unnamed hosts are
added and displayed as a single set of data with a nameless host.
-metric both|time|size
Selects which metric to display. Metrics can be one of the following:
•
•
•
both—(Default) Display both I/O time and I/O size histograms
time—Display only the I/O time histogram
size—Display only the I/O size histogram
-timecols <fcol> <lcol>
For the I/O time histogram, shows the columns from the first column <fcol> through last column
<lcol>. The available columns range from 0 through 31.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>).
The last column (<lcol>) must be less than or equal to 31.
218
Hist Commands
The first column includes all data accumulated for columns less than the first column and the last column
includes accumulated data for all columns greater than the last column.
The default value of <fcol> is 6.
The default value of <lcol> is 15.
-sizecols <fcol> <lcol>
For the I/O size histogram, shows the columns from the first column (<fcol>) through the last column
(<lcol>). Available columns range from 0 through 15.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>) (default value of 3).
The last column (<lcol>) must be less than or equal to 15 (default value of 11).
The default value of <fcol> is 3.
The default value of <lcol> is 11.
-pct
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
-prev | -begin
Histogram displays data either from a previous sample (-prev) or from when the system was last started
(-begin). If no option is specified, the histogram shows data from the beginning of the command's
execution.
-rw
Specifies that the display includes separate read and write data. If not specified, the total is displayed.
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can
be specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-filt <fspec>
Specifies that histograms below the threshold specified by the <fspec> argument are not displayed. The
<fspec> argument is specified in the syntax of <op>,<val_ms>, <count>.
•
<op>
The <op> argument can be specified as one of the following:
◦
◦
r—Specifies read statistics.
w—Specifies write statistics.
Hist Commands
219
•
◦ t—Specifies total statistics.
◦ rw—Specifies total read and write statistics.
<val_ms>
•
Specifies the threshold service time in milliseconds.
<count>
Specifies the minimum number of access above the threshold service time. When filtering is done, the
<count> is compared with the sum of all columns starting with the one which corresponds to the
threshold service time. For example, -t,8,100 means to only display the rows where the 8ms
column and all columns to the right adds up to more than 100.
-ni
Specifies that histograms for only non-idle devices are displayed. This option is shorthand for the option filt t,0,0.
The VV filtering option includes:
-p <pattern>
Pattern for matching VVs to show. (see below for description of <pattern>) If the -p option is specified
multiple times, each instance of <pattern> adds additional candidate VVs that match that pattern.
A <pattern> is one or more of the following:
•
-vmname {<vmname>|<pattern>}[,{<vmname>|<pattern>}...]
•
Show only VVs whose vmname matches one or more of the vvname patterns.
-vmid <vmid>[,<vmid>...]
•
Show only VVs whose vmid matches one or more of the vmids.
-vmhost {<vmhost>|<pattern>}[,{<vmhost>|<pattern>}...]
•
Show only VVs whose vmhost matches one or more of the vmhost patterns.
-vvolstate {bound|unbound}
•
Show only VVs whose vvolstate matches the specified state - bound or unbound.
-vvolsc {<vvset>|<pattern>}[,{<vvset>|<pattern>}...]
Show only VVs whose storage container (vvset) name matches one or more of the vvset patterns.
SPECIFIERS
None.
EXAMPLES
The following example displays two iterations of a histogram of service times for all VLUNs:
cli% histvlun -iter 2
NOTES
Each service time histogram column shows the number of accesses with service times between the point
in time shown in the column's heading to the point in time shown in the heading of the column to its right
(or infinity for the last column). Unless all columns are shown, the first column shows the number of
accesses with service times less than the heading of the second column.
Each I/O size histogram column shows the number of accesses with I/O size between the size shown in
the column's heading to the size shown in the heading of the column to its right (or infinity for the last
column).
220
Hist Commands
For all the <name_or_pattern> fields, the patterns are glob-style (shell-style) patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
histvv
DESCRIPTION
The histvv command displays virtual volume service time histograms in a timed loop.
SYNTAX
histvv [options <arg>] [<VV_name>|<pattern>]...
AUTHORITY
•
Any role in the system
OPTIONS
-domain <domainname>...|<pattern>...
Shows only the virtual volumes that are in domains with names that match the specified domain name(s)
or pattern(s).
-metric both|time|size
Selects which metric to display. Metrics can be one of the following:
•
•
•
both—(Default) Display both I/O time and I/O size histograms
time—Display only the I/O time histogram
size—Display only the I/O size histogram
-timecols <fcol> <lcol>
For the I/O time histogram, shows the columns from the first column <fcol> through last column
<lcol>. The available columns range from 0 through 31.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>).
The last column (<lcol>) must be less than or equal to 31.
The first column includes all data accumulated for columns less than the first column and the last column
includes accumulated data for all columns greater than the last column.
The default value of <fcol> is 6.
The default value of <lcol> is 15.
-sizecols <fcol> <lcol>
For the I/O size histogram, shows the columns from the first column (<fcol>) through the last column
(<lcol>). Available columns range from 0 through 15.
The first column (<fcol>) must be a value greater than or equal to 0, but less than the value of the last
column (<lcol>) (default value of 3).
The last column (<lcol>) must be less than or equal to 15 (default value of 11).
The default value of <fcol> is 3.
The default value of <lcol> is 11.
-pct
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
histvv
221
-prev
Specifies that the histogram displays data from a previous sample.
If no option is specified, the histogram shows data from the beginning of the command's execution.
-rw
Specifies that the display includes separate read and write data. If not specified, the total is displayed.
-d <secs>
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command defaults to 2 seconds.
-iter <number>
Specifies that the histogram is to stop after the indicated number of iterations using an integer from 1
through 2147483647.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can
be specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-filt <fspec>
Specifies that histograms below the threshold specified by the <fspec> argument are not displayed. The
<fspec> argument is specified in the syntax of <op>,<val_ms>, <count>.
•
<op>
The <op> argument can be specified as one of the following:
•
◦ r—Specifies read statistics.
◦ w—Specifies write statistics.
◦ t—Specifies total statistics.
◦ rw—Specifies total read and write statistics.
<val_ms>
•
Specifies the threshold service time in milliseconds.
<count>
Specifies the minimum number of access above the threshold service time. When filtering is done, the
<count> is compared with the sum of all columns starting with the one which corresponds to the
threshold service time. For example, -t,8,100 means to only display the rows where the 8ms
column and all columns to the right adds up to more than 100.
-ni
Specifies that histograms for only non-idle devices are displayed. This option is shorthand for the option filt t,0,0.
The VV filtering option include:
-p <pattern>
Pattern for matching VVs to show (see below for description of <pattern>). If the -p option is specified
multiple times, each instance of <pattern> adds additional candidate VVs that match that pattern.
222
Hist Commands
A <pattern> is one or more of the following:
•
-vmname {<vmname>|<pattern>}[,{<vmname>|<pattern>}...]
•
Show only VVs whose vmname matches one or more of the vvname patterns.
-vmid <vmid>[,<vmid>...]
•
Show only VVs whose vmid matches one or more of the vmids.
-vmhost {<vmhost>|<pattern>}[,{<vmhost>|<pattern>}...]
•
Show only VVs whose vmhost matches one or more of the vmhost patterns.
-vvolstate {bound|unbound}
•
Show only VVs whose vvolstate matches the specified state — bound or unbound.
-vvolsc {<vvset>|<pattern>}[,{<vvset>|<pattern>}...]
Show only VVs whose storage container (vvset) name matches one or more of the vvset patterns.
SPECIFIERS
None.
EXAMPLES
The following example displays two iterations of a histogram of service times for all virtual volumes:
%cli histvv –iter 2
12:53:03 10/20/14 ------------Time (millisec)-----------VVname 0.26 0.53 1.05 2.1 4.2 8.4 17 34 67 135
admin
0
0
0
0
0
0 0 0 0
0
tpvv
29
0
0
0
0
0 0 0 0
0
--------------------------------------------------------total
29
0
0
0
0
0 0 0 0
0
12:53:05 10/20/14 ------------Time (millisec)-----------VVname 0.26 0.53 1.05 2.1 4.2 8.4 17 34 67 135
admin
0
0
0
0
0
0 0 0 0
0
tpvv
105
0
0
0
0
0 0 0 0
0
--------------------------------------------------------total
105
0
0
0
0
0 0 0 0
0
NOTES
Each service time histogram column shows the number of accesses with service times between the point
in time shown in the column's heading to the point in time shown in the heading of the column to its right
(or infinity for the last column). Unless all columns are shown, the first column shows the number of
accesses with service times less than the heading of the second column.
Each I/O size histogram column shows the number of accesses with I/O size between the size shown in
the column's heading to the size shown in the heading of the column to its right (or infinity for the last
column).
For all the <name_or_pattern> fields, the patterns are glob-style (shell-style) patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
If a <VV_name> or <pattern> are specified, then virtual volumes with names matching any of the
patterns are listed. Otherwise all virtual volumes are listed. These patterns are glob-style patterns. (For
more information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
Virtual volumes may be accessed externally by hosts and internally by the prefetcher. Virtual volume data
measured by this command include accesses by the prefetcher.
Hist Commands
223
In addition to external accesses by hosts, virtual volumes can be read internally by the system readahead prefetcher. The histvv data includes read-ahead accesses from the prefetcher that can cause
the read data to appear more than seen by the hosts. Use the histvlun -vvsum command to see data
for only accesses from the host.
Volumes for VMware virtual machines (VVols), which are hidden by default, may be included by using the
setclienv on page 312 command to set matchbulkobjs to "1".
Additionally, VVols can displayed if the CLI was started with the -matchbulkobjs option, or if the CLI
was started with the TPDMATCHBULKOBJS environment variable set to "1". Run "cli -h" and
"setclienv -h" for details of the environment variables. In addition, using the pattern matching options
-vmname, -vmid, -vmhost, -vvolstate, or -vvolsc will display VVols.
224
Hist Commands
Import Commands
importcert
DESCRIPTION
The importcert command allows a user to import certificates for a given service. The user can import a
CA bundle containing the intermediate and/or root CAs prior to importing the service certificate. The CA
bundle can also be imported alongside the service certificate.
SYNTAX
importcert <SSL_service> [-f] <service_cert> [<CA_bundle>]
importcert <SSL_service> [-f] -ca <CA_bundle>
AUTHORITY
•
Super
OPTIONS
-f
Import a certificate without prompting the user.
-ca <CA_bundle>
Allows the import of a CA bundle without importing a service certificate. Note the filename "stdin" can be
used to paste the CA bundle into the CLI.
SPECIFIERS
<SSL_service>
Valid service names are cim, cli, ekm-client, ekm-server, ldap, syslog-gen-client, syslog-gen-server,
syslog-sec-client, syslog-sec-server, wsapi, vasa, and unified-server.
EXAMPLES
The following example shows how to import a signed service certificate with the supporting CA for the cli
service:
cli% importcert cli cli-service.pem ca.pem
The following example shows how to import just the supporting CAs for the wsapi service without
importing the service certificate itself:
cli% importcert wsapi -ca ca-bundle.pem
Now that the CA bundle has been imported, the service certificate can be imported:
cli% importcert wsapi wsapi-service.pem
NOTES
The unified-server establishes a common certificate among cim, cli, and wsapi. Also, the CIM and wsapi
services are restarted when a self-signed certificate is generated.
Data at rest encryption using an external key manager employs the ekm-client and ekm-server services.
The external key manager services are not covered by the unified-server service.
Import Commands
225
The filename "stdin" can be used to paste the CA bundle and or service certificate into the CLI.
Use the createcert on page 124 command to create a CSR and use the showcert on page 429
command to display the certificates.
importvv
DESCRIPTION
The importvv command starts migrating the data from a remote LUN to the local HPE 3PAR Storage
System. The remote LUN should have been prepared using the admitvv on page 78 command.
SYNTAX
importvv [options] <usrcpg> <VV_name|pattern|VV_set> ...
AUTHORITY
•
•
Super, Edit
Any role granted the vv_import right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-snap <snapname>
Create a snapshot of the volume at the end of the import phase. While the data is getting imported the
local volume and the remote volume are kept in sync (in other words all the data is written while data is
getting imported is mirrored to the remote array.) Once the volume import is complete data is only written
to the volume on the array that was importing the data, and the volume on the old array will no longer be
updated. The -snap parameter will create a snapshot at the last phase of the import and the content of
the created snapshot will be identical to the state of volume on the old array when the import task is
completed.
If multiple VVs are being imported in a single command <snapname> should be a VV pattern. (For more
information, issue "clihelp sub,vvnamepat" or see VV Name Patterns on page 18.)
-snp_cpg <snp_cpg>
Specifies the name of the CPG from which the snapshot space will be allocated. This option needs to be
specified if the -snap option is specified.
-nocons
Any VV sets specified will not be imported as consistent groups.
Allows multiple VV sets to be specified.
If the VV set contains any VV members that in a previous import attempt were imported consistently, they
will continue to get imported consistently.
-pri <high|med|low>
Specifies the priority of migration of a volume or a volume set. If this option is not specified, the default
priority will be medium.
The volumes with priority set to high will migrate faster than other volumes with medium and low priority.
-jobid <Job_ID>
Specifies the Job ID up to 511 characters for the volume. The Job ID will be tagged in the events that are
posted during volume migration.
Use -jobid "" to remove the Job ID.
226
importvv
-notask
Performs import related pre-processing which results in transitioning the volume to exclusive state and
setting up of the "consistent" flagon the volume if importing consistently. The import task will not be
created, and hence volume migration will not happen. The "importvv" command should be rerun on the
volume at a later point of time without specifying the -notask option to initiate the actual migration of the
volume. With the -notask option, other options namely -tpvv, -dedup, -compr, -snp_cpg, -snap, -clrsrc, jobid and -pri cannot be specified.
-clrsrc
Performs cleanup on source array after successful migration of the volume. As part of the cleanup, any
exports of the source volume will be removed, the source volume will be removed from all of the VV sets
it is member of, the VV sets will be removed if the source volume is their only member, all of the
snapshots of source volume will be removed, and finally the source volume itself will be removed. The clrsrc option is valid only when the source array is running HPE 3PAR OS release 3.2.2 or higher. The
cleanup will not be performed if the source volume has any snapshots that have VLUN exports.
The following options can be used when creating thinly provisioned volumes:
-tpvv
Import the VV into a thinly provisioned space in the CPG specified in the command line. The import will
enable zero detect for the duration of import so that the data blocks containing zero do not occupy space
on the new array.
-tdvv
This option is deprecated, see -dedup.
-dedup
Import the VV into a thinly provisioned space in the CPG specified in the command line. This volume will
share logical disk space with other instances of this volume type created from the same CPG to store
identical data blocks for space saving.
-compr
Import the VV into a compressed virtual volume in the CPG specified in the command line.
-minalloc <size>
This option specifies the default allocation size (in MB) to be set for TPVVs and TDVVs.
SPECIFIERS
<usrcpg>
Specifies the name of the CPG from which the volume user space will be allocated. If the -tpvv option is
specified, the volume is thinly provisioned. Otherwise, the volume is fully provisioned.
<VV_name|pattern|VV_set> ...
Specifies the VVs with the specified name (up to 31 characters in length), matching the glob-style pattern
or that are members of the supplied VV set will be imported onto local storage. The VV set name must
start with "set:". This specifier can be repeated to import multiple VVs at the same time.
If a VV set is specified then by default all the VV members of the set will be imported consistently. Only
one VV set can be specified to import consistently in a single invocation of the importvv command.
The import parameters such as user and snapshot space CPGs, snapshot name, and provision type will
by default be common to all the VV members of the set. To specify different values for VV members of the
set, invoke the importvv command with the set name and specify individual VV members or patterns
and their own user and snapshot space CPGs, snapshot name, and provision type (see EXAMPLES).
Note that the import of a set will not complete until imports have been initiated and completed for all of the
VV members of the set.
Import Commands
227
To override the default behavior and to import VV members of the set individually, use the "-nocons"
option. There is no limit on the number of VV sets or individual VVs specified with "-nocons" option.
EXAMPLES
The following example imports vv1 previously admitted using the admitvv on page 78 command:
cli% importvv cpg1 vv1
The following example imports vv1 as a thin provisioned volume:
cli% importvv -tpvv cpg1 vv1
The following example imports multiple volumes as thin provisioned volumes and creates read only
snapshots:
cli% importvv -tpvv -snap @vvname@.ro -snp_cpg cpg2 cpg1 vv*
The following example imports vv1 with high priority:
cli% importvv -pri high cpg1 vv1
The following example imports vv1 by specifying Job_ID "testJob 99":
cli% importvv -jobid "testJob 99" cpg1 vv1
The following example imports vv1 as a thin provisioned volume that shares logical disk space with other
instances of the same volume type using the same CPG as vv1:
cli% importvv -dedup cpg1 vv1
The following example performs import related pre-processing including transitioning the volume to
exclusive state, without creating an import task:
cli% importvv -notask cpg1 vv1
The following example cleans up volume vv1 on source array after successful migration of the volume:
228
Import Commands
cli% importvv -clrsrc cpg1 vv1
The following example imports VV set vvset1 as a consistent group using full provisioning:
cli% importvv cpg1 set:vvset1
The following example imports VV set vvset1 with members vv1, vv2, and vv3 as a consistent group, with
vv1 and vv2 imported using thin provisioning, and vv3 imported using full provisioning:
cli% importvv -tpvv cpg1 set:vvset1 vv1 vv2
cli% importvv cpg2 set:vvset1 vv3
The following example imports VV sets vvset1 and vvset2 without using consistent groups, and
additionally imports vv7:
cli% importvv -nocons cpg1 set:vvset1 set:vvset2 vv7
NOTES
You need access to all domains in order to run this command.
The importvv command can be run manually, but it can also be scheduled to run automatically at a
specific time using the "createsched -run_once" command.
A volume is imported online but the volume can only be accessed using the storage system that is
importing the volume.
For all the <name_or_pattern> fields, the patterns are glob-style (shell-style) patterns. (For more
information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
The imported volumes can have different volume characteristics and is independent from legacy volume
characteristics.
Import Commands
229
Locate Commands
locatecage
DESCRIPTION
The locatecage command allows system administrators to locate a drive cage, drive magazine, fan,
power supply, io card or port in the system using the devices' locate LEDs.
SYNTAX
The syntax for the locatecage command can be one of the following:
To locate an entire drive cage:
locatecage [option <arg>] <cage_name>
To locate a drive magazine:
locatecage [option <arg>] <cage_name> <mag>
To locate a port:
locatecage [option <arg>] <cage_name> <port_name>
To locate a module:
locatecage [option <arg>] <cage_name> <module_name> <module_number>
AUTHORITY
•
•
Super, Service
Any role granted the cage_locate right
OPTIONS
-t <sec>
Specifies the number of seconds to blink the LEDs. For HPE 3PAR 7000 and HPE 3PAR 8000 storage
systems, the default time to blink the LEDs is 15minutes with a maximum time of one hour. For HPE
3PAR 20000 system, the default time to blink the LEDs is 1 hour with a maximum time of 7 days.
For all other systems, the default time to blink the LEDs is 60 seconds with a maximum time of 255
seconds.
SPECIFIERS
<cage_name>
Specifies the drive cage name as shown in the Name column of showcage command output.
<port_name>
Indicates the port specifiers. Accepted values are A0|B0|A1|B1|A2|B2|A3|B3. The <port_name> specifier
is not supported for DC3, DCS1, DCS2, DCS3, DCS4, DCS5, DCS6, DCS9, DCS10, DCN1, DCN3 and
DCN4 drive cages.
<mag>
Indicates the drive magazine by number.
For DC1 drive cages, accepted values are 0 through 4.
For DC2 and DC4 drive cages, accepted values are 0 through 9.
For DC3 drive cages, accepted values are 0 through 15.
230
Locate Commands
For DCS3, DCS5, DCS9 and DCN3 drive cages, accepted values are 0 through 11.
For DCS4, DCS6, DCS10 and DCN4 drive cages, accepted values are 0 through 23.
<module_name>
Indicates the module name to locate. Accepted values are enclosure|fan|powersupply|battery|iocard|disk|
magazine. The <module_name> specifier is only supported for DCS3, DCS4, DCS5, DCS6, DCS7,
DCS8, DCS9, DCS10, DCN2, DCN3 and DCN4 cages.
<module_number>
Indicates the module number to locate. The <module_number> specifier is only supported for DCS3,
DCS4, DCS5, DCS6, DCS7, DCS8, DCS9, DCS10, DCN2, DCN3 and DCN4 cages.
The allowed module numbers per module type are:
0 for enclosure.
0 .. 1 for fan (0 .. 3 on DCS7).
0 .. 1 for powersupply (0 .. 3 on DCS7).
0 .. 1 for battery (0 .. 3 on DCS7).
0 .. 1 for iocard.
0 .. 23 for disk or magazine.
EXAMPLES
The following example will locate the cage0 for 20 seconds:
cli% locatecage -t 20 cage0
NOTES
Access to all domains is required to run this command.
Issue the showcage on page 425 command for a list of cage names.
If no port or magazine is specified, all LEDs in the cage are set as amber or oscillate (depending on the
cage type).
If the port is specified, it turns green (not available in all cage types).
locatenode
DESCRIPTION
The locatenode command helps locate a particular node or its components by illuminating LEDs on the
node.
SYNTAX
locatenode [options] <nodeid>
AUTHORITY
•
•
Super, Service
Any role granted the node_locate right
OPTIONS
-t <sec>
locatenode
231
Specifies the number of seconds to illuminate the LEDs. For HPE 3PAR 7000 and HPE 3PAR 8000
storage systems, the default time to illuminate the LEDs is 15 minutes with a maximum time of one hour.
For STR (Safe to Remove) systems, the default time is one hour with a maximum time of one week. For
all other systems, the default time is 60 seconds with a maximum time of 255 seconds. Issuing
"locatenode -t 0 <nodeid>" will turn off LEDs immediately.
-ps <psid>
Only the service LED for the specified power supply will blink.
Accepted values for <psid> are 0 and 1.
-pci <slot>
Only the service LED corresponding to the PCI card in the specified slot will blink. Accepted values for
<slot> are 0 through 8.
-fan <fanid>
Only the service LED on the specified node fan module will blink.
Accepted values for <fanid> are 0 and 1 for HPE 3PAR 10000 systems.
Accepted values for <fanid> are 0, 1 and 2 for HPE 3PAR 20000 systems.
-drive
Only the service LED corresponding to the node's internal drive will blink.
-bat
Only the service LED on the battery backup unit will blink.
SPECIFIERS
<nodeid>
Indicates which node the locatenode operation will act on. Accepted values are 0 through 7.
EXAMPLES
In the following example, power supply 1 on node 3 is identified by blinking its hotplug LED for 90
seconds.
cli% locatenode -t 90 -ps 1 3
NOTES
Access to all domains is required to run this command.
On HPE 3PAR 7000 and HPE 3PAR 8000 series systems only the node LED can be illuminated.
locatesys
DESCRIPTION
The locatesys command helps locate a storage system by blinking the node status LEDs on all nodes
of the storage system alternating amber and green. By default, the LEDs in all connected cages are also
set amber or oscillate (depending on the cage).
SYNTAX
locatesys [options <arg>]
AUTHORITY
232
locatesys
•
•
Super, Service
Any role granted the sys_locate right
OPTIONS
-t <sec>
Specifies the number of seconds to blink the LEDs. For HPE 3PAR 7000 and HPE 3PAR 8000 storage
systems, the default time to blink the LEDs is 15minutes with a maximum time of one hour. For all other
systems, the default time to blink the LEDs is 60 seconds with a maximum time of 255 seconds.
-nodes <nodelist>
Specifies a comma-separated list of nodes on which to blink LEDs. The default is all nodes.
-nocage
Specifies that LEDs on the drive cages should not blink. The default is to blink LEDs for all cages in the
system.
SPECIFIERS
None.
EXAMPLES
In the following example, a storage system is identified by blinking the LEDs on all drive cages in the
system for 90 seconds.
cli% locatesys -t 90
NOTES
Access to all domains is required to run this command.
Locate Commands
233
Move Commands
movech
DESCRIPTION
The movech command moves a list of chunklets from one physical disk to another.
SYNTAX
movech [options] <fd:fp-td:tp> ...
AUTHORITY
•
•
Super, Service, Edit
Any role granted the ch_move right
OPTIONS
-nowait
Specifies that the command returns before the operation is completed.
-dr
Specifies that the operation is a dry run. No chunklets are actually moved.
-devtype
Permits the moves to happen to different device types.
-perm
Specifies that chunklets are permanently moved and the chunklets' original locations are not
remembered. If the -perm option is not specified, the chunklets' original locations are retained, thereby
allowing the chunklets to be returned to their original locations through the moverelocpd and
servicemag resume commands.
If this option is used on a non-spare chunklet and it is moved to itself, the chunklet's original location will
be cleared without actually moving the data. The same thing will occur, if the destination is left blank and
the system chooses a destination on the same disk.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-ovrd
Permits the moves to happen to a destination even when there will be a loss of quality because of the
move. This option is only necessary when the target of the move is not specified and the -perm flag is
used.
SPECIFIERS
<fd:fp>[<-td:tp>]...
Specifies that the chunklet located at the specified disk (<fd>) and the chunklet's position on that disk
(<fp>) be moved to either the specified destination disk (<td>) and chunklet position (<tp>), or a location
determined by the system if a destination (<-td:tp>) is not specified. This specifier must be used at least
once on the command line. Repeated use of this specifier allows multiple chunklets to be moved.
EXAMPLES
234
Move Commands
The following example moves the chunklet in position 0 on disk 24, to position 50 on disk 64 and chunklet
in position 0 on disk 25, to position 1 on disk 27.
cli% movech 24:0-64:50 25:0-27:1
Are you sure you want to move the chunklets?
select q=quit y=yes n=no: y
Move
-State- --Detailed_State--24:0-64:50 normal
normal
25:0-27:1 degraded disks_reused_in_row
The following example doesn't move the chunklet in position 0 on disk 10, to itself, but clears the
chunklet's original location.
cli% movech -perm 10:0-10:0
Are you sure you want to move the chunklets?
select q=quit y=yes n=no: y
Move
-State- -Detailed_State10:0-10:0
normal
no_data_move,normal
Use the following to get a description of each column in the above examples:
clihelp -col movech
NOTES
Access to all domains is required to run this command.
Chunklets moved through the movech command are only moved temporarily.
Issuing either the moverelocpd on page 239 or servicemag resume command (see the servicemag
on page 295 command) can move the chunklet back to its original position.
The -dr option can be used to see if the specified moves succeed and what the results (quality) of the
moves are.
movechtospare
DESCRIPTION
The movechtospare command moves data from specified physical disks to a temporary location
selected by the system.
SYNTAX
movechtospare [options] <fd:fp>
AUTHORITY
•
•
Super, Service, Edit
Any role granted the ch_movetospare right
OPTIONS
-nowait
Specifies that the command returns before the operation is completed.
movechtospare
235
-dr
Specifies that the operation is a dry run. No chunklets are actually moved.
-devtype
Permits the moves to happen to different device types.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<fd:fp>
Indicates that the move takes place from the specified physical disk (<fd>) and chunklet position (<fp>).
EXAMPLES
In the following example, chunklet 0 from physical disk 66 is moved to spare:
cli% movechtospare 66:0
Are you sure you want to move the chunklet to spare?
select q=quit y=yes n=no: y
Move
-State- -Detailed_State66:0-70:50 normal
normal
Use the following to get a description of each column in the above examples:
clihelp -col movechtospare
NOTES
Access to all domains is required to run this command.
movepd
DESCRIPTION
The movepd command moves data from specified physical disks to a temporary location selected by the
system.
SYNTAX
movepd [options] <PD_ID>...
AUTHORITY
•
•
Super, Service, Edit
Any role granted the pd_move right
OPTIONS
-nowait
Specifies that the command returns before the operation is completed.
-dr
Specifies that the operation is a dry run, and no physical disks are actually moved.
236
movepd
-devtype
Permits the moves to happen to different device types.
-perm
Makes the moves permanent, removes source tags after relocation.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<PD_ID>...
Specifies the physical disk ID. This specifier can be repeated to move multiple physical disks.
EXAMPLES
The following example displays a dry run of moving the data on physical disk 0 to free or spare space:
cli% movepd -dr 0
Are you sure you want to move the pd to spare?
select q=quit y=yes n=no: y
Move
-State- -Detailed_State0:0-66:50
normal
normal
0:1-62:51
normal
normal
0:2-92:51
normal
normal
0:3-88:52
normal
normal
0:4-50:53
normal
normal
0:5-86:54
normal
normal
0:6-82:55
normal
normal
Use the following to get a description of each column in the above examples:
clihelp -col movepd
NOTES
Access to all domains is required to run this command.
The destination physical disks do not need to be specified as the system automatically determines the
spare locations.
Specifying the -dr option can be used to see if the specified moves succeed and the results (quality) of
the moves.
movepdtospare
DESCRIPTION
The movepdtospare command moves data from specified physical disks to a temporary location
selected by the system.
SYNTAX
movepdtospare [options] <PD_ID>...
movepdtospare
237
AUTHORITY
•
•
Super, Service, Edit
Any role granted the pd_movetospare right
OPTIONS
-nowait
Specifies that the command returns before the operation is completed.
-dr
Specifies that the operation is a dry run. No physical disks are actually moved.
-devtype
Permits the moves to happen to different device types.
-vacate
Deprecated, use -perm instead.
-perm
Makes the moves permanent, removes source tags after relocation.
-ovrd
Permits the moves to happen to a destination even when there will be a loss of quality because of the
move. This option is only necessary when the target of the move is not specified and the -perm flag is
used.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<PD_ID>...
Specifies the physical disk ID. This specifier can be repeated to move multiple physical disks.
EXAMPLES
The following example displays a dry run of moving the data on physical disk 0 to free or spare space:
cli% movepdtospare -dr 0
Are you sure you want to move the pd to spare?
select q=quit y=yes n=no: y
Move
-State- -Detailed_State0:0-66:50
normal
normal
0:1-62:51
normal
normal
0:2-92:51
normal
normal
0:3-88:52
normal
normal
0:4-50:53
normal
normal
0:5-86:54
normal
normal
0:6-82:55
normal
normal
Use the following to get a description of each column in the above examples:
238
Move Commands
clihelp -col movepdtospare
NOTES
Access to all domains is required to run this command.
The destination physical disks do not need to be specified as the system automatically determines the
spare locations.
Specifying the -dr option can be used to see if the specified moves succeed and the results (quality) of
the moves.
moverelocpd
DESCRIPTION
The moverelocpd command moves chunklets that were on a physical disk to the target of relocation.
SYNTAX
moverelocpd [options] [<fd>[-<td>]...]
AUTHORITY
•
•
Super, Service
Any role granted the pd_movereloc right
OPTIONS
-nowait
Specifies that the command returns before the operation is completed.
-dr
Specifies that the operation is a dry run. No physical disks are actually moved.
-partial
Move as many chunklets as possible. If this option is not specified, the command fails if not all specified
chunklets can be moved.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-p <pattern>
Specifies a pattern to select <fd> disks. The <td> specifier cannot be used with this -p option. If no <fd>
are specified, then all disks that match the pattern are selected as the <fd> disks. If <fd> disks are
specified along with -p then only disks that match the pattern are selected as <fd> disk.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0-7).
The primary path of the disks must be on the specified node(s).
-st <item>
moverelocpd
239
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0-7). The
primary path of the disks must be on the specified PCI slot(s).
-pt <item>
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0-4). The
primary path of the disks must be on the specified port(s).
-cg <item>
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
•
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
output indicating the side of the cage is omitted when using the -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single comma
(e.g. 1,2,3). A range of drive magazines is separated with a hyphen (e.g. 0-7). The specified drive
magazine(s) must contain disks.
-pn <item>
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen (e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
•
Specifies one or more physical disks. Disks are identified by one or more integers (item). Multiple
disks are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g.
0-3). Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
Specifies that physical disks with free chunklets greater than the number specified be selected.
-fc_lt <number>
•
Specifies that physical disks with free chunklets less than the number specified be selected.
-devid <model>
•
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the "showpd -i" command.
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd"
command.
-rpm <number>
Drives must be of the specified relative performance metric, as shown in the "RPM" column of the
"showpd" command. The number does not represent a rotational speed for the drives without spinning
media (SSD). It is meant as a rough estimation of the performance difference between the drive and
the other drives in the system. For FC and NL drives, the number corresponds to both a performance
measure and actual rotational speed. For SSD drives, the number is to be treated as a relative
performance benchmark that takes into account I/O's per second, bandwidth and access time.
240
Move Commands
Disks that satisfy all of the specified characteristics are used. For example -p -fc_gt 60 -fc_lt
230 -nd 2 specifies all the disks that have greater than 60 and less than 230 free chunklets and that
are connected to node 2 through their primary path.
SPECIFIERS
<fd>[-<td>]...
Specifies that the chunklets that were relocated from specified disk (<fd>), are moved to the specified
destination disk (<td>). If destination disk (<td>) is not specified then the chunklets are moved back to
original disk (<fd>), see NOTES. The <fd> specifier is not needed if -p option is used, otherwise it must
be used at least once on the command line. If this specifier is repeated then the operation is performed
on multiple disks.
EXAMPLES
The following example moves chunklets that were on physical disk 8 that were relocated to another
position, back to physical disk 8:
cli% moverelocpd 8
Are you sure you want to move the chunklets ?
select q=quit y=yes n=no: y
Move
-State- -Detailed_State50:53-8:4
normal
normal
62:51-8:1
normal
normal
65:51-8:7
normal
normal
66:51-8:0
normal
normal
82:55-8:6
normal
normal
86:54-8:5
normal
normal
88:52-8:3
normal
normal
92:51-8:2
normal
normal
Use the following to get a description of each column in the above examples:
clihelp -col moverelocpd
NOTES
Access to all domains is required to run this command.
Chunklets moved from physical disk <fd> are treated as if they originated on disk <td>. Disk <td> can be
the same as disk <fd>.
Specifying the -dr option can be used to see if the specified moves succeed and what the results (quality)
of the moves are.
If the -partial option is used, the command relocates as many chunklets as possible and prints messages
for the chunklets it could not move.
If the <fd> move would reduce the availability of an LD and the <td> is not specified, then the system will
find the best available destination.
movetodomain
DESCRIPTION
The movetodomain command moves objects from one domain to another.
movetodomain
241
SYNTAX
movetodomain [options] <object_name> <domain_name | domain_set>
AUTHORITY
•
•
Super, Edit
Any role granted the domain_moveto right
OPTIONS
-vv
Specifies that the object is a virtual volume.
-cpg
Specifies that the object is a common provisioning group (CPG).
-host
Specifies that the object is a host.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<object_name>
Specifies the name of the object to be moved.
<domain_name | domain_set>
Specifies the domain or domain set to which the specified object is moved. The domain set name must
start with "set:".
To remove an object from any domain, specify the string "-unset" for the domain name or domain set
specifier.
EXAMPLES
The following example displays the movement of virtual volume vv1 to domain SampleDomain:
cli% movetodomain -vv vv1 SampleDomain
The following volumes will have their domain modified:
vv1
The following hosts will have their domain modified:
testhost
The following CPGs will have their domain modified:
SampleCPG
14 associated LDs will also have their domain changed.
Do you want to proceed with moving the above to domain SampleDomain?
select y=yes n=no: y
The following example displays the removal of host testhost from any domain:
242
Move Commands
cli% movetodomain -host testhost -unset
The following hosts will have their domain modified:
Id Name
2 testhost
Persona -WWN/iSCSI_Name- Port
Generic
Do you want to proceed with removing the domain of the above?
select y=yes n=no: y
NOTES
Access to all domains is required to run this command.
The movetodomain command moves all objects that are directly or indirectly related to the specified
object into the specified domain. Possible relationships include, but are not limited to, VLUNs between
hosts and virtual volumes, virtual volumes using a CPG for snapshot space, and two virtual volumes
sharing the same logical disc. If the -f option is not used, a list of all objects that will be modified is shown
before the confirmation prompt.
Only hosts are permitted to be members of domain sets.
When moving a host to a domain set all objects directly or indirectly related to that host must be members
of a domain contained in that domain set. If this is not the case then the command will fail.
If the -cpg option is selected and the selected CPG is part of an Adaptive Optimization (AO) configuration,
all CPGs in that AO configuration will be moved to the specified domain.
Move Commands
243
Promote Commands
promotegroupsv
DESCRIPTION
The promotegroupsv command copies the differences of snapshots back to their base volumes,
allowing you to revert the base volumes to an earlier point in time.
SYNTAX
promotegroupsv [options] <virtual_copy_name>[:<target_vvname>]...
AUTHORITY
•
•
Super, Edit
Any role granted the svgrp_promote right
OPTIONS
-rcp
Allows the promote operation to proceed even if the RW parent volume is currently in a Remote Copy
volume group, if that group has not been started. If the Remote Copy group has been started, this
command fails.
This option cannot be used in conjunction with the -halt option.
-pri <high|med|low>
Specifies the priority of the copy operation when it is started. This option allows the user to control the
overall speed of a particular task. If this option is not specified, the promotegroupsv operation is started
with default priority of medium. High priority indicates that the operation will complete faster. Low priority
indicates that the operation will run slower than the default priority task. This option cannot be used with halt option.
-halt
Cancels ongoing snapshot promotions. Marks the RW parent volumes with the "cpf" status that can be
cleaned up using the promotevvcopy on page 247 command or by issuing a new instance of the
promotesv on page 245 or promotegroupsv command.
This option cannot be used in conjunction with any other option.
-online
Indicates that the promote operation will be executed while the target volumes have VLUN exports. The
hosts should take the target LUNs offline to initiate the promote command, but can be brought online and
used during the background tasks. Each specified virtual copy and its base volume must be the same
size. The base volume is the only possible target of online promote, and is the default. To halt a promote
started with the online option, use the canceltask on page 82 command. The -halt, -target, and -pri
options cannot be combined with the -online option.
SPECIFIERS
<virtual_copy_name>[:<target_vvname>]...
Specifies the names of the virtual copy volumes to be promoted, using up to 31 characters in length.
Currently, vvset is not supported. If a RW target_vvname is supplied, then the target vv will be treated as
the RW parent volume to be rolled back. If the target_vvname is not supplied, then the virtual copy
volume will be promoted to its base. If the -online option is used, then no target names can be specified,
the virtual volume(s) will be promoted to the base.
244
Promote Commands
EXAMPLES
The following example illustrates how virtual volumes vv1 and vv2 can be promoted with the differences
from their base volume:
cli% promotegroupsv vv1 vv2
NOTES
A promote to a parent of larger size will include zeroing the additional capacity of the parent in order to
correctly represent the data from the smaller virtual copy. Such zeroing activity will proportionally increase
the duration of the promote task.
Issue the showvv on page 558 command to verify that differences in the snapshot volume are promoted
to its target volume.
Issue the showvv -d command to display the number of remaining blocks to be copied.
Without the -online option, the RW virtual copy and the target of the promote must not be exported. With
the -online option the base (target) may be exported, but no snapshots in the family tree may be
exported.
Only one promote operation is allowed at a time within a virtual volume family tree.
promotesv
DESCRIPTION
The promotesv command copies the differences of a snapshot back to its base volume, allowing you to
revert the base volume to an earlier point in time.
SYNTAX
promotesv [options] <virtual_copy_name | VV_set>
AUTHORITY
•
•
Super, Edit
Any role granted the sv_promote right
OPTIONS
-target <vvname|VV_set>
Copies the differences of the virtual copy to the specified RW parent in the same virtual volume family
tree. The default is to copy the differences to the base volume. This option cannot be used in conjunction
with the -halt or -online options.
When target is a set, the snapshot source must be a set as well. The order of the snapshot set must
correspond to the order of the target set.
-rcp
Allows the promote operation to proceed even if the RW parent volume is currently in a Remote Copy
volume group, if that group has not been started. If the Remote Copy group has been started, this
command fails.
This option cannot be used in conjunction with the -halt option.
-halt
promotesv
245
Cancels an ongoing snapshot promotion. Marks the RW parent volume with the "cpf" status that can be
cleaned up using the promotevvcopy on page 247 command or by issuing a new instance of the
promotesv command. This option cannot be used in conjunction with any other option.
-pri <high|med|low>
Specifies the priority of the copy operation when it is started. This option allows the user to control the
overall speed of a particular task. If this option is not specified, the promotesv operation is started with
default priority of medium. High priority indicates that the operation will complete faster. Low priority
indicates that the operation will run slower than the default priority task. This option cannot be used with halt option.
-online
Indicates that the promote operation will be executed while the target volume is online, with vlun exports.
The specified virtual copy and its base volume must be the same size. The base volume is the only
possible target of online promote, and is the default. To halt a promote started with the online option, use
the command. The -rcp, -halt, and -pri options cannot be combined with the -online option.
Indicates that the promote operation will be executed while the target volume has VLUN exports. The
host should take the target LUN offline to initiate the promote command, but can bring it online and use it
during the background task. The specified virtual copy and its base volume must be the same size. The
base volume is the only possible target of online promote, and is the default. To halt a promote started
with the online option, use the canceltask on page 82 command. The -halt, -target, and -pri
options cannot be combined with the -online option.
SPECIFIERS
<virtual_copy_name | VV_set>
Specifies the name of the virtual copy volume, or set of virtual copy volumes, to be promoted, using up to
31 characters in length. The vv set name must start with "set:".
EXAMPLES
The following example illustrates how virtual volume vv1 can be promoted with the differences from its
base volume:
cli% promotesv vv1
The following will promote all snapshots in a VV set:
cli% promotesv set:vv_set
The following will promote snapshot snap1 to parent vv1:
cli% promotesv -target vv1 snap1
The following will promote all snapshots in snapset to their parents in targetset:
cli% promotesv -target set:targetset set:snapset
NOTES
A promote to a parent of larger size will include zeroing the additional capacity of the parent in order to
correctly represent the data from the smaller virtual copy. Such zeroing activity will proportionally increase
the duration of the promote task.
Issue the showvv on page 558 command to verify that differences in the snapshot volume are promoted
to its target volume.
246
Promote Commands
Issue the showvv -d command to display the number of remaining blocks to be copied.
Without the -online option, the RW virtual copy and the target of the promote must not be exported.
With the -online option the base (target) may be exported, but no snapshots in the family tree may be
exported.
Only one promote operation is allowed at a time within a virtual volume family tree.
promotevvcopy
DESCRIPTION
The promotevvcopy command promotes a physical copy back to a regular base volume.
SYNTAX
promotevvcopy <physical_copy_name | VV_set>
AUTHORITY
•
•
Super, Edit
Any role granted the vvcopy_promote right
OPTIONS
None.
SPECIFIERS
<physical_copy_name | VV_set>
Specifies the name of the physical copy, or set of physical copies, to be promoted, using up to 31
characters in length. The vv set name must start with "set:".
EXAMPLES
The following example promotes virtual volume vv1 to a base volume:
cli% promotevvcopy vv1
The following will promote all VV copies in a VV set:
cli% promotevvcopy set:vv_set
NOTES
The physical copy must have completed the copy from the base volume.
The saved snapshot of the parent of <physical_copy_name> is also removed.
The promotevvcopy command can also be used to clean up a failed physical copy.
Issue the showvv on page 558 command to verify that promoted volume is a base volume.
After a physical copy has been promoted, the association between it and its parent volume is broken; the
physical copy and base volume can no longer resync. The saved snapshot of the parent of physical copy
is also removed.
promotevvcopy
247
Remove Commands
removealert
DESCRIPTION
The removealert command removes one or more alerts from the system.
SYNTAX
removealert [option] -a|<alert_ID>...
AUTHORITY
•
•
Super, Service
Any role granted the alert_remove right
OPTIONS
-a
Specifies all alerts from the system and prompts removal for each alert.
If this option is not used, then the <alert_ID> specifier must be used.
-f
Specifies that the command is forced. If this option is not used and there are alerts in the "new" state, the
command requires confirmation before proceeding with the operation.
SPECIFIERS
<alert_ID>...
Indicates a specific alert to be removed from the system. This specifier can be repeated to remove
multiple alerts. If this specifier is not used, the -a option must be used.
EXAMPLES
The following example displays all alerts from the system with the option to remove individual alerts:
cli% removealert -a
Id 120 - New
Occurred 4 times, last at Tue May 03 22:45:47 PDT 2005
Message code: 196609
Tue May 03 22:23:17 PDT 2015
Node: 0 Severity: Minor
Firmware coredump event
Firmware COREDUMP: recovered file /var/core/hba/
fwcore.n00.s02.p01.20050503.224547
Alert 120 is marked as "New".
Are you sure you want to remove it?
select q=quit y=yes n=no: y
...
NOTES
248
Remove Commands
CAUTION:
Use care when removing alerts. Alerts that have not been fixed or acknowledged should NOT be
removed.
Access to all domains is required to run this command.
removeaocfg
DESCRIPTION
The removeaocfg command removes specified Adaptive Optimization configurations from the system.
SYNTAX
removeaocfg [options] {<AOCFG_name>|<pattern>}...
AUTHORITY
•
Super, Edit
OPTIONS
-pat <pattern>
Specifies that specified patterns are treated as glob-style patterns and that all AO configurations matching
the specified pattern are removed. By default, confirmation is required to proceed with the command
unless the -f option is specified. This option must be used if the pattern specifier is used.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<AOCFG_name>
Specifies the name of the AO configuration to be removed
<pattern>
Specifies a glob-style pattern. This specifier can be repeated to remove multiple AO configurations. If this
specifier is not used, the <AOCFG_name> specifier must be used. (For more information, issue "clihelp
sub,globpat" or see Glob-Style Patterns on page 15.)
EXAMPLES
The following example removes AO configurations that start with test.
cli% removeaocfg -f -pat test*
NOTES
None.
removecert
DESCRIPTION
The removecert command is used to remove certificates that are no longer trusted. In most cases, it is
better to overwrite the offending certificate with importcert on page 225. The user specifies which service
to have its certificates removed. The removal can be limited to a specific type.
removeaocfg
249
SYNTAX
removecert {all|<SSL_service_name>} [-type <typename>]
AUTHORITY
•
Super
OPTIONS
-f
Skips the prompt warning the user of which certificates will be removed and which services will be
restarted.
-type <typename>
Allows the user to limit the removal to a specific type. Note that types are cascading. For example, intca
will cause the service certificate to also be removed.
Valid types are csr, cert, intca, and rootca.
SPECIFIERS
<SSL_service>
Valid service names are cim, cli, ekm-client, ekm-server, ldap, syslog-gen-client, syslog-gen-server,
syslog-sec-client, syslog-sec-server, wsapi, vasa, and unified-server.
The user may also specify all, which will remove certificates for all services.
EXAMPLES
The following example shows how to remove all certificates for the cli:
cli% removecert cli
The following example shows how to remove just the root Certificate Authority for the cli:
cli% removecert cli -type rootca
NOTES
Use of the removecert command may be confusing. The SSL server services (cim, cli, and wsapi) must
always have a certificate, and so a self-signed certificate will be automatically generated when their
certificate is removed.
removecorequest
DESCRIPTION
The removecorequest command removes specified requests from the queue.
SYNTAX
removecorequest [-f] -state {executed|cancelled|rejected}
removecorequest [-f] <requestid>
AUTHORITY
•
•
CO
Any role granted the corequest_remove right
OPTIONS
-f
250
removecorequest
Suppresses the warning message.
-state {executed|cancelled|rejected}
Specifies removal of all commands from queue whose state is cancelled, executed, or rejected.
SPECIFIERS
<requestid>
Request ID that is to be removed from queue.
EXAMPLES
This example shows how to remove a specific request with Id 12345:
cli% removecorequest 12345
This command will remove the request with id 12345.
Do you wish to continue?
select y=yes n=no:
This example shows how to remove a specific request with Id 12345 forcefully:
cli% removecorequest -f 12345
This example shows how to remove all executed requests:
cli% removecorequest -state executed
This example shows how to remove all rejected requests:
cli% removecorequest -state rejected
This example shows how to remove all cancelled requests:
cli% removecorequest -state cancelled
NOTES
None.
removecpg
DESCRIPTION
The removecpg command removes common provisioning groups (CPGs) from the system or removes
specific logical disks from common provisioning groups.
SYNTAX
removecpg [options <arg>] {<CPG_name>|<pattern>}...
AUTHORITY
•
•
Super, Edit
Any role granted the cpg_remove right
OPTIONS
-f
removecpg
251
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-sa <LD_name>
Specifies that the logical disk, as identified with the <LD_name> argument, used for snapshot
administration space allocation is removed.
The <LD_name> argument can be repeated to specify multiple logical disks.
This option is deprecated and will be removed in a subsequent release.
-sd <LD_name>
Specifies that the logical disk, as identified with the <LD_name> argument, used for snapshot data space
allocation is removed. The <LD_name> argument can be repeated to specify multiple logical disks.
This option is deprecated and will be removed in a subsequent release.
-pat
The specified patterns are treated as glob-style patterns and that all common provisioning groups
matching the specified pattern are removed.
By default, confirmation is required to proceed with the command unless the -f option is specified. This
option must be used if the pattern specifier is used.
SPECIFIERS
<CPG_name>
Specifies the name of the common provisioning group that is either being removed or losing logical disks.
<pattern>
Specifies a glob-style pattern. This specifier can be repeated to remove multiple common provisioning
groups. If this specifier is not used, the <CPG_name> specifier must be used. (For more information,
issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
EXAMPLES
The following example displays the removal of common provisioning group cpg1:
cli% removecpg cpg1
NOTES
Access to all domains is required to run this command.
The removecpg command fails if any of the logical disks, or the entire common provisioning group, is in
use by a thinly provisioned virtual volume.
If neither the -sa or -sd options are specified, the entire common provisioning group is removed, including
all logical disks.
The operation fails if any of the logical disks are in use.
removedomain
DESCRIPTION
The removedomain command removes an existing domain from the system.
SYNTAX
removedomain [option] <domain_name|pattern>...
252
removedomain
AUTHORITY
•
•
Super
Any role granted the domain_remove right
OPTIONS
-f
When using this option, the command does not ask for confirmation before removing the domain.
-pat
Specifies that names will be treated as glob-style patterns and that all domains matching the specified
pattern are removed.
SPECIFIERS
<domain_name|pattern>
Specifies the domain that is removed. If the -pat option is specified the domain_name will be treated as a
glob-style pattern, and multiple domains will be considered.
EXAMPLES
The following example removes the domain named sample_domain from the system:
cli% removedomain -f sample_domain
The following example removes the domains that start with test:
cli% removedomain -f -pat test*
The following example removes any domains that start with test or sample:
cli% removedomain -f -pat test* sample*
NOTES
Access to all domains is required to run this command.
The patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
Issuing the removedomain command with invalid domain names causes the command to exit without
removing any domains.
removedomainset
DESCRIPTION
The removedomainset command removes a domain set or removes domains from an existing set.
SYNTAX
removedomainset [options] <setname|pattern> [<domain|pattern>...]
AUTHORITY
removedomainset
253
•
•
Super, Edit
Any role granted the domainset_set right can remove a domain set or domains from a domain set
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-pat
Specifies that both the set name and domains will be treated as glob-style patterns.
SPECIFIERS
<setname|pattern>
Specifies the name of the domain set. If the -pat option is specified the setname will be treated as a globstyle pattern, and multiple domain sets will be considered.
<domain|pattern>
Optional list of domain names that are members of the set. If no <domain>s are specified, the domain set
is removed, otherwise the specified <domain>s are removed from the domain set. If the -pat option is
specified the domain will be treated as a glob-style pattern, and multiple domains will be considered.
EXAMPLES
To remove a domain set:
cli% removedomainset domainset
To remove a single domain from a set:
cli% removedomainset domainset domain1
The following example removes the domain sets that start with test:
cli% removedomainset -f -pat test*
The following example removes any domains that start with test or sample from all domain sets:
cli% removedomainset -f -pat * test* sample*
NOTES
Access to all domains is required to run this command.
The patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
254
Remove Commands
removeflashcache
DESCRIPTION
The removeflashcache command removes the flash cache from the cluster and will stop use of the
extended cache.
SYNTAX
removeflashcache [option]
AUTHORITY
•
•
Super, Edit
Any role granted the flashcache_remove right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
None.
EXAMPLES
The following example removes the flash cache from the cluster, and stops use of the extended cache:
removeflashcache
NOTES
None.
removefpg
DESCRIPTION
The removefpg command removes a file provisioning group and its underlying components from the
system.
SYNTAX
removefpg [options] <fpgname|pattern> ...
AUTHORITY
•
•
Super, Edit.
Any role granted fpg_remove right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-forget
Removes the specified file provisioning group which is involved in Remote DR, keeping the virtual volume
intact.
removeflashcache
255
-wait
Wait until the associated task is completed before proceeding.
This option will produce verbose task information.
-pat
The specified patterns are treated as glob-style patterns and that all file provisioning groups matching the
specified pattern are removed.
By default, confirmation is required to proceed with the command unless the -f option is specified. This
option must be used if the pattern specifier is used.
SPECIFIERS
<fpgname>
The name of the file provisioning group to be removed.
This specifier can be repeated to remove multiple common provisioning groups.
<pattern>
Specifies a glob-style pattern. This specifier can be repeated to remove multiple common provisioning
groups. If this specifier is not used, the <fpgname> specifier must be used. (For more information, issue
"clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
EXAMPLES
The following example removes a file provisioning group:
cli% removefpg examplefpg
NOTES
Access to all domains is required to run this command.
It is necessary to remove any shares on the file provisioning group before removing the file provisioning
group itself.
When using the -forget option, the VVs will need to be specified when the recover action is performed,
e.g. createfpg -recover <vv>.
removefsarchive
DESCRIPTION
The removefsarchive commands are used to delete the WORM/WORM-retained file(s), remove the
retention period, or delete the data validation scan on the fstore.
SYNTAX
The syntax for the removefsarchive command can be one of the following:
removefsarchive files [-basepath <basepath>] {-files <filepath>
[,<filepath>]... | -importfile <source_path> | -inputfile <pathoffile>} fstore <fstorename> [-fpg <fpgname>]<vfs>
removefsarchive retention [-basepath <basepath>] {-files <filepath>
[,<filepath>]... | -importfile <source_path> | -inputfile <pathoffile>} fstore <fstorename> [-fpg <fpgname>] <vfs>
removefsarchive scan [-fpg <fpgname>] -fstore <fstorename> <vfs> <jobid>
256
removefsarchive
removefsarchive auditlogs [-f] [-log <logname>] [-fpg <fpgname>] <vfs>
SUBCOMMANDS
files
Deletes the specified WORM/WORM-retained file(s).
retention
Removes the retention period for the file(s) specified.
scan
Removes the retention validation scan job.
auditlogs
Removes either all or a specific audit log from VFS.
AUTHORITY
•
•
Super, Edit
Any role granted the fsarchive_remove right
Super for -importfile <source_path>
OPTIONS
-f
Suppresses the confirmation from user before removing the specified audit log or all compressed audit
logs.
-basepath <basepath>
Base path of files for which retention settings are to be deleted.
-files <filepath>[,<filepath>]...
Relative path of files from the above base path to remove retention period or specified files. If basepath is
not specified, it should be the absolute path of files.
-inputfile <pathoffile>
Path of input file containing list of files for which retention settings are to be deleted. The input file should
be placed in file persona namespace (.admin file store). It should be absolute path of the input file, which
is visible to the file persona namespace.
-importfile <source_path>
Path of import file containing list of files for which retention settings to be removed or files to be deleted.
The input file should be present on client machine. The max size of import file can be up to 2GiB.
-fpg <fpgname>
Specifies the FPG that contains the VFS. This is required if VFS exists under multiple FPGs.
-fstore <fstorename>
Name of the file store under VFS.
-log <logname>
Name of the log file to be removed. If not mentioned, it will delete all the compressed logs at VFS level.
SPECIFIERS
<vfs>
Specifies the name of the VFS.
<jobid>
Remove Commands
257
Job Id of the data validation scan process.
EXAMPLES
This example deletes the specified WORM/WORM-retained files at the given file path:
cli% removefsarchive files -basepath /fpg1/vfs1 -files fstore1/abcd.txt,/
fstore2/pqr.txt -fpg fpg1
-fstore fstore1 vfs1
cli% removefsarchive files -basepath /fpg1/vfs1 -importfile /home/worm/
abcd.txt -fpg fpg1
-fstore fstore1 vfs1
This example removes the retention period for the specified file:
cli% removefsarchive retention -basepath /fpg1/vfs1 -inputfile /fpg1/
vfs1/.admin/abcd.txt
-fstore fstore1 -fpg fpg1 vfs1
cli% removefsarchive retention -basepath /fpg1/vfs1 -fstore fstore1 importfile /home/worm/abcd.txt
-fpg fpg1 vfs1
This example removes data validation scan process:
cli% removefsarchive scan -fstore fstore1 -fpg fpg1 vfs1 10
This example removes the audit logs:
cli% removefsarchive auditlogs -f -log
audit_fpg1_vfs1_2016-03-02-04-32-45.log.zip vfs1
cli% removefsarchive auditlogs vfs1
NOTES
Access to all domains is required to run this command.
The option -importfile <source_path> is not available with SSH access to CLI.
removefsgroup
DESCRIPTION
The removefsgroup command removes a local group account associated with File Persona.
SYNTAX
removefsgroup [options] <groupname|GID>
AUTHORITY
•
•
Super
Any role granted the fsgroup_remove right
OPTIONS
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation before
proceeding with its operation.
258
removefsgroup
SPECIFIERS
<groupname|GID>
Specifies the local group name using up to 31 characters or a numeric GID. Valid characters are
alphanumeric characters, periods, dashes (except first character), and underscores.
EXAMPLES
The following example removes a local group named accounting:
cli% removefsgroup accounting
NOTES
Access to all domains is required to run this command.
removefshare
DESCRIPTION
The removefshare command removes a file share for supported protocols.
SYNTAX
removefshare {smb|nfs|obj|ftp} [options <arg>] <vfs> <sharename>
SUBCOMMANDS
smb
Removes an SMB file share.
nfs
Removes an NFS file share.
obj
Removes an Object file share.
ftp
Removes an FTP file share.
AUTHORITY
•
•
Super, Edit
Any role granted the fshare_remove right
OPTIONS
The following options are for all subcommands:
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-fpg <fpgname>
Specifies the file provisioning group (FPG) that <vfs> belongs.
If this is not specified, the command will find out the FPG based on the specified <vfs>. However, if <vfs>
exists under multiple FPGs, -fpg must be specified.
-fstore <fstore>
removefshare
259
Specifies the file store that the file share to be removed belongs.
If this is not specified, the <sharename> will be used as <fstore>.
SPECIFIERS
<vfs>
Specifies the virtual file server (VFS) name.
<sharename>
The name of the share to be removed.
EXAMPLES
The following example removes the SMB file share "myshare" without prompting for confirmation:
cli% removefshare smb -f -fstore myfstore myvfs myshare
The following example removes the NFS file share "myshare":
cli% removefshare nfs -fpg myfpg -fstore myfstore myvfs myshare
The following example removes the Object share "myshare":
cli% removefshare obj -fstore myfstore myvfs myshare
The following example removes the FTP share "myshare":
cli% removefshare ftp -fstore myfstore myvfs myshare
NOTES
Access to all domains is required to run this command.
removefsip
DESCRIPTION
The removefsip command removes the network config of a virtual file server (VFS).
SYNTAX
removefsip [options] <vfs> <id|ip>
AUTHORITY
•
•
Super, Edit
Any role granted the fsip_remove right
OPTIONS
-fpg <fpgname>
260
removefsip
Specifies the file provisioning group (FPG) in which the VFS was created.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation before
proceeding with its operation.
SPECIFIERS
<id|ip>
Specifies the ID/IP for the network config.
<vfs>
Specifies the VFS which is to have its network config removed.
EXAMPLES
The following example removes the network configuration of virtual file server vfs_1:
cli% removefsip -f vfs_1 12345678
cli% removefsip -f vfs_1 10.10.10.1
NOTES
Access to all domains is required to run this command.
removefsnap
DESCRIPTION
The removefsnap command removes file store snapshots for File Persona.
SYNTAX
removefsnap [options <arg>] <vfs> <fstore>
AUTHORITY
•
•
Super, Edit
Any role granted the fsnap_remove right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-fpg <fpgname>
Specifies the file provisioning group (FPG) that <vfs> belongs.
If this is not specified, the command will find out the FPG based on the specified <vfs>. However, if <vfs>
exists under multiple FPGs, -fpg must be specified.
-snapname <name>
Specifies the name of the snapshot to be removed. If this is not specified, all snapshots of the file store
specified by <fstore> will be removed.
SPECIFIERS
<vfs>
Specifies the virtual file server (VFS) name.
removefsnap
261
<fstore>
Specifies the file store name.
EXAMPLES
The following example removes all snapshots of "myfstore":
cli% removefsnap -fpg myfpg myvfs myfstore
NOTES
Access to all domains is required to run this command.
removefsnetwork
DESCRIPTION
The removefsnetwork command removes the specified network. This command will disallow removal
of the default networks "user" and "cluster", as in that case, the user would have to reconfigure the default
network.
SYNTAX
removefsnetwork [-f] [-force] <name>
AUTHORITY
•
•
Super
Any role granted the fsnetwork_remove right
OPTIONS
-f
Suppresses confirmation from user before removing the network configuration.
-force
Forcefully removes the network configuration.
SPECIFIERS
<name>
Name of the network whose configuration is to be removed. Network names "cluster" and "user" are
default networks and hence cannot be removed by this command.
EXAMPLES
The following example removes the given network after confirmation from user:
cli% removefsnetwork <name>
The following example removes the given network without any confirmation from user:
cli% removefsnetwork -f <name>
The following example removes the given network forcefully without any confirmation from user:
cli% removefsnetwork -f -force <name>
262
removefsnetwork
NOTES
A warning message is displayed to the user, to confirm the action before removal of a network:
"This command will remove the network configuration for specified network
name. Do you want to continue? select q=quit y=yes n=no."
removefsroute
DESCRIPTION
removefsroute removes a route for a target identified with either route id or a unique combination of
target address, vlantag and subnet mask. A warning is displayed to user before removing the route.
SYNTAX
removefsroute [-f] {<targetaddr>,{<subnetmask>|<prefixlen>},<vlantag> |
<routeidentifier>}
AUTHORITY
•
•
Edit
Any role granted fsroute_set right.
OPTIONS
-f
Suppresses confirmation from user before removing the route.
SPECIFIERS
<targetaddr>
The target IPv4/IPv6 address for which the route is to be removed.
<subnetmask>|<prefixlen>
The subnet mask or prefix length for the target IP Address.
<vlantag>
The VLAN tag associated with route which needs to be removed.
<routeidentifier>
Instead of providing a combination of targetaddr,subnetmask|prefixlen and vlantag - a route identifier can
be provided. Obtain the route identifier from the "showfsroute -d" command.
EXAMPLES
The following example removes a route with following details:
cli% removefsroute 10.16.23.101,16,8
The following example deletes a route without confirmation:
cli% removefsroute -f 10.16.23.101,255.255.192.0,12
The following example deletes a route with specified route ID:
removefsroute
263
cli% removefsroute staticRoute4e426403-98a7-4025-9b11-ca59afd9971c
NOTES
Access to all domains is required to run this command.
removefstore
DESCRIPTION
The removefstore command removes a file store and its underlying components from the system.
SYNTAX
removefstore [options] <vfs> <fstore>
AUTHORITY
•
•
Super, Edit
Any role granted fstore_remove right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-fpg <fpgname>
The name of the parent file provisioning group (FPG).
SPECIFIERS
<vfs>
The name of the containing virtual file server (VFS).
<fstore>
The name of the file store to be removed.
EXAMPLES
The following example removes a file store:
cli% removefstore -f -fpg fpg1 vfs1 examplefstore.
NOTES
Access to all domains is required to run this command.
The command will remove all underlying shares.
removefsuser
DESCRIPTION
The removefsuser command removes a local user account.
SYNTAX
264
removefstore
removefsuser [options] <username|UID>
AUTHORITY
•
•
Super
Any role granted the fsuser_remove right
OPTIONS
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation before
proceeding with its operation.
SPECIFIERS
<username|UID>
Specifies the local user name using up to 31 characters or a numeric UID.
Valid characters are alphanumeric characters, periods, dashes (except first character), and underscores.
EXAMPLES
The following example removes a local user named jdoe:
cli% removefsuser -f jdoe
NOTES
Access to all domains is required to run this command.
removehost
DESCRIPTION
The removehost command removes a system host or paths to a host. If one or more paths are
specified, the command removes only those paths, otherwise the entire host definition is removed.
SYNTAX
removehost [options] <hostname|pattern> [<WWN>... | <iscsi_name> ...]
AUTHORITY
•
•
Super, Edit
Any role granted the host_remove right
OPTIONS
-rvl
Remove WWN(s) or iSCSI name(s) even if there are VLUNs exported to the host. This option cannot be
used if the entire host definition is being removed.
-iscsi
Specifies that the paths are iSCSI names. If this option is not specified, the paths are WWNs.
-pat
Specifies that host name will be treated as a glob-style pattern and that all hosts matching the specified
pattern are removed. This option cannot be used if the WWN or ISCSI_name specifiers are used.
-port <node:slot:port>...|<pattern>...
removehost
265
Specifies the NSP(s) for the zones, from which the specified WWN will be removed in the target driven
zoning. Multiple array ports can be specified by either using a pattern or a comma-separated list. At least
one WWN needs to be specified with this option.
SPECIFIERS
<hostname|pattern>
Specifies the host name, using up to 31 characters. If the -pat option is specified the hostname will be
treated as a glob-style pattern, and multiple hosts will be considered.
<WWN>
Only the specified WWN(s) path to the specified host is removed. This specifier is not required on the
command line. If a WWN is not specified, the entire host definition is removed.
<ISCSI_name>
Specifies the host iSCSI name to be removed from the specified host. If no ISCSI name is specified, the
entire host definition is removed.
EXAMPLES
The following example removes host test01:
cli% removehost test01
The following example removes the WWN 1000A0B3CC1C68BE for a host associated with the target
driven zone for port 1:2:1. This does not remove the WWN from the host. If you want to remove the WWN
from the host AND from the zone, then just use "removehost <host> <WWN>".
cli% removehost -port 1:2:1 lynx 1000A0B3CC1C68BE
The following example removes the hosts that start with test:
cli% removehost -pat test*
NOTES
Access to all domains is required to run this command.
A host that has one or more VLUNs exported on it cannot be removed.
Removing an entire host definition by issuing the removehost <hostname> command is not equivalent
to removing all of the paths associated with a host. The latter leaves a host definition with no paths
associated to it, whereas the former removes the entire host definition.
Verify the removal of hosts by issuing the showhost on page 471 command.
The patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
Issuing the removehost command with invalid host names causes the command to exit without
removing any hosts.
266
Remove Commands
removehostset
DESCRIPTION
The removehostset command removes a host set or removes hosts from an existing set.
SYNTAX
removehostset [options] <setname|pattern> [<host|pattern>...]
AUTHORITY
•
•
Super, Edit
Any role granted the hostset_set right can remove a host set or hosts from a host set
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-pat
Specifies that both the set name and hosts will be treated as glob-style patterns.
SPECIFIERS
<setname|pattern>
Name of the host set to remove. If the -pat option is specified the setname will be treated as a glob-style
pattern, and multiple host sets will be considered.
<host|pattern>
Optional list of host names that are members of the set.
If no <host>s are specified, the host set is removed, otherwise the specified <host>s are removed from
the host set. If the -pat option is specified the host will be treated as a glob-style pattern, and multiple
hosts will be considered.
EXAMPLES
The following example removes a host set:
cli% removehostset hostset
The following example removes a single host from a set:
cli% removehostset hostset host1
The following example removes the host sets that start with test:
cli% removehostset -f -pat test*
The following example removes any hosts that start with test or sample from all host sets:
removehostset
267
cli% removehostset -f -pat * test* sample*
NOTES
The patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
removeld
DESCRIPTION
The removeld command removes a specified LD from the system service group.
SYNTAX
removeld [options] {<LD_name>|<pattern>}...
AUTHORITY
•
•
Super, Service, Edit
Any role granted the ld_remove right
OPTIONS
-pat
Specifies glob-style patterns. All LDs matching the specified pattern are removed. By default, confirmation
is required to proceed with the command unless the -f option is specified. This option must be used if the
pattern specifier is used.
-dr
Specifies that the operation is a dry run and no LDs are removed.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-rmsys
Specifies that system resource LDs such as logging LDs and preserved data LDs are removed.
-unused
Specifies the command to remove non-system LDs. This option cannot be used with the -rmsys option.
SPECIFIERS
<LD_name>
Specifies the LD name, using up to 31 characters. Multiple LDs can be specified.
<pattern>
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) Multiple LDs can be specified. If this specifier is not used, the <LD_name>
specifier must be used.
EXAMPLES
The following example removes LD nf_vv_1.0.usr.1:
268
removeld
cli% removeld -f nf_vv_1.0.usr.1
NOTES
CAUTION:
System resource LDs are required for correct operation of the HPE 3PAR StoreServ Storage
system. Removal of system resource LDs should be performed by qualified service personnel.
Incorrect use of the -rmsys option can result in data loss.
If the LD is mapped to a virtual volume, the LD is not removed and the command stops at that LD.
Issuing the removeld command with the -pat option specified returns a request for confirmation to
remove LDs, unless the -f option is specified.
Do not issue the removeld command while a movech on page 234, movechtospare on page 235,
movepd on page 236, movepdtospare on page 237, or moverelocpd on page 239 operation is being
executed. Issue the showldch on page 481 command to view operations currently running on the
system.
Verify the removal of LDs by issuing the showld on page 476 command.
removercopygroup
DESCRIPTION
The removercopygroup command removes a remote copy volume group or multiple remote copy
groups that match a given pattern.
SYNTAX
removercopygroup [options] {<group_name> ... | <pattern> ...}
AUTHORITY
•
•
Super, Edit
Any role granted the rcopygroup_remove right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
If the Remote Copy group is not empty and -removevv is used, the command will ask for a confirmation
even if the -f option is used.
-removevv
Remove remote sides' volumes.
-keepsnap
Specifies that the local volume's resync snapshot should be retained. The retained snapshot will reflect
the state of the secondary volume and may be used as the starting snapshot should the volume be
readmitted to a remote copy group. The snapshot will begin with "sv.rcpy".
-pat
removercopygroup
269
Specifies that specified patterns are treated as glob-style patterns and all remote copy groups matching
the specified pattern will be removed. By default, confirmation is required to proceed with the command
unless the -f option is specified. This option must be used if the <pattern> specifier is used.
SPECIFIERS
<group_name>
The name of the group to be removed.
<pattern>
Specifies a glob-style pattern. This specifier can be repeated to remove multiple groups. If the <pattern>
specifier is not used, the <group_name> specifier must be used.
EXAMPLES
The following example removes Group1 from a remote copy system:
removercopygroup Group1
The following example removes remote copy groups that start with the name testgroup:
removercopygroup -pat testgroup*
The following example removes the remote copy group (Group1) and retains the resync snapshots
associated with each volume:
removercopygroup -keepsnap Group1
The following example removes Group1 and associated volumes from the local system and removes the
corresponding volumes on all the target systems of Group1:
removercopygroup -removevv Group1
NOTES
This command requires the HPE 3PAR Remote Copy Software license.
Contact your local service provider for more information.
This is not allowed if remote copy is in progress; the system will generate an error. The group must be
stopped using the stoprcopygroup on page 737 command.
You must have access to the domain of the specified group (<group_name>) to run this command.
If the mirror_config policy is set for this group's target system and the group is a primary group, this
command will be mirrored to the target and the corresponding secondary group will also be removed. If
the policy is set and the group is a secondary group, this command fails.
The -keepsnap and -removevv options are mutually exclusive.
270
Remove Commands
The removercopygroup command removes all the associations configured in the specified group and
removes the group name and any remote copy synchronization snapshots affiliated with volumes in the
group.
removercopytarget
DESCRIPTION
The removercopytarget command removes target designation from a remote copy system and
removes all links affiliated with that target definition.
SYNTAX
removercopytarget [options] <target_name>
AUTHORITY
•
•
Super, Edit
Any role granted the rcopytarget_remove right
OPTIONS
-cleargroups
Remove all groups that have no other targets or dismiss this target from groups with additional targets. All
groups that contain this target must be stopped before the -cleargroups command can be issued.
-f
Do not ask for confirmation when -cleargroups is specified.
SPECIFIERS
<target_name>
The target name for the target definition to be removed.
EXAMPLES
The following example removes targets System1 and System2 from the primary and backup systems in a
remote copy pair:
removercopytarget System1
removercopytarget System2
NOTES
Access to all domains is required to run this command.
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
A target definition cannot be deleted if it is being used by any group.
removesched
DESCRIPTION
The removesched command removes a scheduled task from the system.
SYNTAX
removesched [options] {<schedname>|<pattern>}...
removercopytarget
271
AUTHORITY
•
•
•
Super, Service, Edit
Any role granted the sched_setany right can remove any user scheduled tasks
Any role granted the sched_setown right can only remove their own scheduled tasks
OPTIONS
-pat
Specifies that certain patterns are treated as glob-style patterns and that all scheduled tasks matching the
specified pattern are removed. This option must be used if the pattern specifier is used.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<schedname>
Specifies the scheduled task name. This specifier can be repeated to remove multiple scheduled tasks. If
this specifier is not used, the pattern specifier must be used. Can be at most 31 characters in length.
<pattern>
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) This specifier can be repeated to remove multiple scheduled tasks. If this specifier
is not used, the <schedname> specifier must be used.
Can be at most 31 characters in length.
EXAMPLES
None.
NOTES
None.
removesnmpmgr
DESCRIPTION
The removesnmpmgr command removes previously registered SNMP managers from receiving traps.
SYNTAX
removesnmpmgr [option <arg>] <manager_IP>
AUTHORITY
•
•
Super
Any role granted the snmpmgr_remove right
OPTIONS
-p <port_number>
Specifies the port number where the manager receives traps. If not specified, the port number defaults to
162.
SPECIFIERS
<manager_IP>
Specifies the IPv4 or IPv6 address of the host where the manager runs.
IPv6 address is in hexadecimal, case insensitive, and separated by colons. An example would be:
272
removesnmpmgr
5def:2008:0:0:abcd:0:0:161a
In addition, a double colon (::) can be used once in an address to replace multiple fields of zeros. For
example:
5def:2008:0:0:abcd::161a
EXAMPLES
The following example displays the removal of a manager with the IPv4 address from the list of registered
managers:
cli% removesnmpmgr 123.45.67.89
The following example displays the removal of a manager with the IPv6 address from the list of registered
managers:
cli% removesnmpmgr 5def:2008:abcd::161a
NOTES
Access to all domains is required to run this command.
SNMP managers are registered by issuing the addsnmpmgr on page 69 command.
Verify the removal of SNMP managers by issuing the showsnmpmgr on page 529 command.
removesnmppw
DESCRIPTION
The removesnmppw command allows a user to remove SNMP access community string passwords.
SYNTAX
removesnmppw [options]
AUTHORITY
•
•
Super
Any role granted the snmppw_remove right
OPTIONS
-rw|-r|-w
Removes the read-write (-rw), read-only (-r) or write-only (-w) password.
If not specified, the read-write community string password is removed.
-f
Forces the operation so that the command does not require confirmation before proceeding.
SPECIFIERS
None.
EXAMPLES
The following example displays the removal of the read-write SNMP access password:
removesnmppw
273
cli% removesnmppw -f
NOTES
Access to all domains is required to run this command.
The following codes are returned indicating success or failure:
•
•
•
0 indicates that the password was removed and the command was successful.
1 indicates that the command failed.
2 indicates that the password does not exist.
After a password has been removed, the system manager can no longer use that password to send
requests to the SNMP agent.
Verify the removal of SNMP passwords by issuing the showsnmppw on page 529 command.
removesnmpuser
DESCRIPTION
The removesnmpuser command allows a user to remove SNMPv3 user.
SYNTAX
removesnmpuser [options] <username>
AUTHORITY
•
•
Super
Any role granted the snmpuser_remove right
OPTIONS
-f
Forces the operation so that the command does not require confirmation before proceeding.
SPECIFIERS
<username>
Specifies the SNMPv3 user name, using up to 31 characters.
EXAMPLES
The following example displays the removal of the an SNMPv3 user:
cli% removesnmpuser -f joe
NOTES
The following codes are returned indicating success or failure:
•
•
•
0 indicates that the password was removed and the command was successful.
1 indicates that the command failed.
2 indicates that the user does not exist.
After a user has been removed, an SNMPv3 manager can no longer use that username to send requests
to the SNMP agent. The removesnmpuser command has no impact on local user since it only removes
the user from SNMPv3.
274
removesnmpuser
An SNMPv3 user will also be removed if the removeuser on page 280 command has been issued on
that user.
Verify the removal of SNMPv3 users by issuing the showsnmpuser on page 530 command.
removespare
DESCRIPTION
The removespare command removes chunklets from the spare chunklet list.
SYNTAX
removespare [options] <chunklet_specifier>...
AUTHORITY
•
•
Super, Service
Any role granted the spare_remove right
OPTIONS
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation before
proceeding with its operation.
-p
Specifies that partial completion of the command is acceptable.
Chunklets specified that are not on the current service group spare list are ignored.
SPECIFIERS
<chunklet_specifier>...
The chunklet specifier can be issued in the following formats:
•
<PD_ID:chunklet_num>...
•
Specifies the identification of the physical disk (PD_ID) and the position number of the chunklet on the
disk (chunklet_num). This specifier can be repeated.
<PD_ID>:a...
•
Specifies the identification of the physical disk (PD_ID) and all (a) chunklets on the disk. This specifier
can be repeated.
a:<chunklet_num>...
•
Specifies the chunklet number on all physical disks. This specifier can be repeated.
a:a
•
Remove all spare chunklets that are not currently used.
-pos <cage:mag:disk:chunklet_num>
•
Specifies the position of a specific chunklet identified by its position in a drive cage, drive magazine,
physical disk, and chunklet number. For example -pos 1:0.2:3:121, where 1 is the drive cage, 0.2 is
the drive magazine, 3 is the physical disk, and 121 is the chunklet number.
-pos <cage:mag:disk:a>
Specifies that all chunklets on a physical disk, identified by drive cage number, drive magazine
number, and disk number, are marked to be removed.
EXAMPLES
The following example removes a spare chunklet from position 3 on physical disk 1:
removespare
275
cli% removespare 1:3
NOTES
Access to all domains is required to run this command.
Verify the removal of spare chunklets by issuing the showspare on page 534 command.
If a wildcard ("a") is used or the -p flag is specified, prints the number of spares removed. Otherwise, if all
the explicitly specified spares could not be removed, prints an error message.
removespcredential
DESCRIPTION
The removespcredential command removes the SP credentials on the array and sets a random
password for 3parsvc.
CAUTION:
It is a nontrivial process to reverse this action. It SHOULD NOT be run unless you are removing the
SP completely for security reasons.
SYNTAX
removespcredential
AUTHORITY
•
•
Super
Any role granted the spcred_remove right
OPTIONS
None.
SPECIFIERS
None.
EXAMPLES
The following example removes all the 3parservice, 3paredit and 3parbrowse users and sets a new
random password for 3parsvc user:
cli% removespcredential
NOTES
Once the command is executed, the 3paredit, 3parbrowse and 3parservice users are removed and a new
random password is set for 3parsvc. This command also removes the SSH key for 3parsvc.
removesralertcrit
DESCRIPTION
The removesralertcrit command removes a criterion that System Reporter evaluates to determine if
a performance alert should be generated.
276
removespcredential
SYNTAX
removesralertcrit [options <arg>] <name>|<pattern>
AUTHORITY
•
•
Super, Service
Any role granted the sralertcrit_remove right
OPTIONS
-pat
Specifies that certain patterns are treated as glob-style patterns and that all criteria matching the specified
pattern are removed. By default, confirmation is required to proceed with the command unless the -f
option is specified. This option must be used if the pattern specifier is used.
-f
Do not ask for confirmation before removing this criterion.
SPECIFIERS
<name>
Specifies the name of the criterion to remove.
<pattern>
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) This specifier can be repeated to remove multiple criteria tasks. If this specifier is
not used, the <name> specifier must be used.
EXAMPLES
The following example removes the criterion named busy_port:
cli% removesralertcrit busy_port
NOTES
Removing a criterion also automatically fixes all alerts associated with that criterion.
removesshbanner
DESCRIPTION
The removesshbanner command will remove the SSH banner that was set with the setsshbanner on
page 395 command.
SYNTAX
removesshbanner
AUTHORITY
•
•
Super
Any role granted the sshbanner_set right
OPTIONS
None.
SPECIFIERS
None.
removesshbanner
277
EXAMPLES
The following example will remove the SSH banner that has been set:
cli% removesshbanner
SSH Banner was removed.
NOTES
None.
removesshkey
DESCRIPTION
The removesshkey command removes SSH public key to disable key authentication.
SYNTAX
removesshkey [options]
AUTHORITY
•
•
Super, Service, Edit, Browse
Any role granted the sshkey_remove right
OPTIONS
-i key_ID
Only removes the key with the specified ID. The ID can be found in the output of showsshkey.
SPECIFIERS
None.
EXAMPLES
The following example removes all ssh keys for the current user:
cli% removesshkey
NOTES
After removing an SSH public key on the storage system, the user it belongs to cannot use the
associated private key to log in. If all SSH keys for a user are removed, the user must use name and
password to log in.
The showuser -k command can be used to display users that have SSH keys (see showuser on page
548).
Only a user can remove their keys.
removetask
DESCRIPTION
The removetask command removes information about one or more completed tasks and their details.
SYNTAX
removetask [options <arg>] -a
278
removesshkey
removetask [options <arg>] -t <hours>
removetask [options <arg>] <task_ID>...
AUTHORITY
•
•
Super, Edit
Any role granted the task_remove right
OPTIONS
-a
Removes all tasks including details.
-d
Remove task details only.
-f
Specifies that the command is to be forced. You are not prompted for confirmation before the task is
removed.
-t <hours>
Removes tasks that have not been active within the past <hours>, where <hours> is an integer from 1
through 99999.
SPECIFIERS
<task_ID>
Allows you to specify tasks to be removed using their task IDs.
EXAMPLES
The following example shows how to remove a task based on the task ID:
cli% removetask 2
Remove the following tasks?
2
select q=quit y=yes n=no: y
The following example shows how to remove all tasks, including details:
cli% removetask -a
Remove all tasks?
select q=quit y=yes n=no: y
NOTES
See the HPE 3PAR StoreServ Storage Concepts Guide and HPE 3PAR Command Line Interface
Administrator Guide for additional information and examples regarding task management and task
management commands.
With this command, the specified task ID and any information associated with it are removed from the
system. However, task IDs are not recycled, so the next task started on the system uses the next whole
integer that has not already been used. Task IDs roll over at 29999. The system stores information for the
most recent 2000 tasks.
Remove Commands
279
removetemplate
DESCRIPTION
The removetemplate command removes one or more virtual volume (VV), logical disk (LD), and
common provisioning group (CPG) templates.
SYNTAX
removetemplate [options] {<template_name>|<pattern>} ...
AUTHORITY
•
•
Super
Any role granted the template_remove right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-pat
The specified patterns are treated as glob-style patterns and that all templates matching the specified
pattern are removed. By default, confirmation is required to proceed with the command unless the -f
option is specified. This option must be used if the pattern specifier is used.
SPECIFIERS
<template_name>
Specifies the name of the template to be deleted, using up to 31 characters. This specifier can be
repeated to remove multiple templates.
<pattern>
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) This specifier can be repeated to remove multiple templates. If this specifier is not
used, the <template_name> specifier must be used.
EXAMPLES
The following example displays the forced removal of template vv1:
cli% removetemplate -f vv1
NOTES
Access to all domains is required to run this command.
removeuser
DESCRIPTION
The removeuser command removes a user account from the system.
SYNTAX
removeuser [option] <username>...
AUTHORITY
280
removetemplate
•
•
Super
Any role granted the user_remove right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<username>...
Specifies a login name using any combination of letters and numbers.
This argument can be repeated to specify multiple user names.
EXAMPLES
The following example displays the forced removal of user1 from the system:
cli% removeuser -f user1
User removed.
NOTES
Access to all domains is required to run this command.
Do not remove users 3parsvc and 3paradm.
A user cannot remove oneself. The last user on the system cannot be removed.
Verify the removal of users by issuing the showuser on page 548 command.
All open connections for a given user will be removed when that user is removed.
When a user's connection is removed any running commands will be aborted. Use showuserconn on
page 551 to examine open connections.
When successful, removeuser removes a user's SSH key.
Before attempting to remove a user connected through the WSAPI server, all sessions associated with
that WSAPI user must first be removed via the removewsapisession on page 288 command.
Use the showwsapisession on page 575 command to view the WSAPI session information details.
removeuserconn
DESCRIPTION
The removeuserconn command removes user connections to the current system.
SYNTAX
removeuserconn [options] <user_ID> <user_name> <IP_address>
AUTHORITY
•
•
Super
Any role granted the userconn_remove right
OPTIONS
-pat
removeuserconn
281
Specifies that the <user_ID>, <user_name>, and <IP_address> specifiers are treated as glob-style (shellstyle) patterns and all user connections matching those patterns are removed. By default, confirmation is
required to proceed with removing each connection unless the -f option is specified.
-dr
Specifies that the operation is a dry run and no connections are removed.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<user_ID>
Specifies the ID of the user to be removed.
<user_name>
Specifies the name of the user to be removed.
<IP_address>
Specifies the IP address of the user to be removed.
EXAMPLES
The following example displays the forced removal of user user1 at IP address 127.0.0.1:
cli% removeuserconn -f 2315 user1 127.0.0.1
Removing user connection Id:2315 Name:user1 Addr:127.0.0.1
NOTES
Access to all domains is required to run this command.
Because user connections can disappear from the time they are listed and the time they are removed, the
removeuserconn command continues past errors while removing individual connections if the -pat
option is specified.
Connections associated with the WSAPI server can only be removed via the removewsapisession on
page 288 command.
Use the showwsapisession on page 575 command to view the WSAPI session information details.
removevfs
DESCRIPTION
The removevfs command removes a virtual file server (VFS) and its underlying components from the
system.
SYNTAX
removevfs [options] <vfs>
AUTHORITY
•
•
Super, Edit
Any role granted vfs_remove right
OPTIONS
282
removevfs
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-fpg <fpgname>
Name of the file provisioning group (FPG) containing the VFS.
SPECIFIERS
<vfs>
The name of the VFS to be removed.
EXAMPLES
The following example removes a VFS examplevfs, which is contained in examplefpg:
cli% removevfs examplevfs
NOTES
Access to all domains is required to run this command.
All underlying elements will be removed from the system.
removevlun
DESCRIPTION
The removevlun command removes a virtual volume's SCSI LUN export definition from the system.
SYNTAX
removevlun [options] <VV|VVSet> <LUN> <n:s:p>
removevlun [options] <VV|VVSet> <LUN> <host|hostset>
removevlun [options] <VV|VVSet> <LUN> <host|hostset> <n:s:p>
removevlun [options] <VV|VVSet> <LUN> <n:s:p> <host|hostset>
AUTHORITY
•
•
Super, Edit
Any role granted the vlun_remove right
OPTIONS
-novcn
Specifies that a VLUN Change Notification (VCN) not be issued after removal of the VLUN.
For direct connect or loop configurations, a VCN consists of a Fibre Channel Loop Initialization Primitive
(LIP).
For fabric configurations, a VCN consists of a Registered State Change Notification (RSCN) that is sent to
the fabric controller.
-pat
Specifies that the <VV_name>, <LUN>, <node:slot:port>, and <host_name> specifiers are treated as
glob-style patterns and that all VLUNs matching the specified pattern are removed. By default,
confirmation is required to proceed with the command unless the -f option is specified.
-dr
removevlun
283
Specifies that the operation is a dry run and no VLUNs are removed.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-set
Remove all the VLUNs connected with the VVs in a vvset.
SPECIFIERS
<VV|VVSet>
Specifies the volume or volume set name, using up to 31 characters in length. The volume set name must
start with "set:".
<LUN>
Specifies the LUN id to remove.
<n:s:p>
Specifies that exports to the specified port are removed. If this specifier is not used, the <host|
hostset> specifier must be used.
•
n
•
Specifies the system node.
s
•
Specifies the PCI bus slot in the node.
p
Specifies the FCS port number of the card in PCI bus slot.
<host|hostset>
Specifier requests that exports to the specified host or host set, named using up to 31 characters, be
removed. The host set name must start with "set:". If this specifier is not used, the node:slot:port
specifier must be used.
EXAMPLES
The following example deletes VLUNs for volume vv0, LUN 0, host host1:
cli% removevlun -f vv0 0 host1
The following will remove exported VLUNs for vv0, LUN 1, host set host_set:
cli% removevlun -f vv0 1 set:host_set
The following will remove the VLUNs for VV set vv_set, starting with LUN 1, host host1:
cli% removevlun -f set:vv_set 1 host1
The following will remove the VLUNs for VV set vv_set, starting with LUN 1, host set host_set:
284
Remove Commands
cli% removevlun -f set:vv_set 1 set:host_set
NOTES
To remove a specific VLUN, you must supply the same specifiers and options that you used when that
VLUN was created. Use the showvlun -t command to view all created VLUN specifiers and options.
If the VLUN to be removed is a matched-set, both the port specifier and the hostname should be
specified.
Issuing the removevlun command with the -pat option specified returns a request for confirmation to
remove VLUNs, unless the -f option is specified.
Verify the removal of VLUNs by issuing the showvlun on page 555 command.
removevv
DESCRIPTION
The removevv command removes Virtual Volumes (VVs) from the system.
SYNTAX
removevv [options] <VV_name>|<pattern>...
removevv -expired [options] [<VV_name>|<pattern>...]
AUTHORITY
•
•
•
•
Super, Edit
Any role granted the vv_remove right can remove base volumes
Any role granted the vvcopy_remove right can remove physical volumes
Any role granted the sv_remove right can remove virtual copies
OPTIONS
-pat
Specifies that specified patterns are treated as glob-style patterns and that all VVs matching the specified
pattern are removed. By default, confirmation is required to proceed with the command unless the -f
option is specified. This option must be used if the pattern specifier is used.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-dr
Specifies that the operation is a dry run and no VVs are removed.
-stale
Specifies that all stale VVs can be removed.
This option cannot be used together with -expired.
-expired
Remove specified expired volumes.
This option cannot be used together with -stale.
-snaponly
removevv
285
Remove the snapshot copies only.
-cascade
Remove specified volumes and their descendent volumes as long as none has an active VLUN. It will
remove any VLUN templates as long as there were no active VLUNs. It will remove the volumes from all
the volume sets.
If -expired is specified, all expired volumes and their descendent volumes will be removed regardless if
they are expired or not.
If -stale is specified, all stale volumes and their descendent volumes will be removed regardless if they
are stale or not.
-nowait
Prevents command blocking that is normally in effect until the vv is removed. Removal of the vv is
performed in the background. Only snapshots can be removed with this option. An attempt to remove a
base VV results in an error.
SPECIFIERS
<VV_name>
Specifies the virtual volume name, using up to 31 characters. This specifier can be repeated to remove
multiple VVs. If this specifier is not used, the pattern specifier must be used.
<pattern>
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) This specifier can be repeated to remove multiple VVs. If this specifier is not used,
the <VV_name> specifier must be used.
EXAMPLES
The following example removes virtual volume vv0:
cli% removevv -f vv0
The following example removes all the expired volumes:
cli% removevv -f -expired
The following example removes the volumes that start with test and are snapshot copies:
cli% removevv -f -snaponly -pat test*
The following example removes vv1_snap if it is a snapshot and all its descendents:
cli% removevv -f -snaponly -cascade vv1_snap
NOTES
286
Remove Commands
Issuing the removevv command with invalid virtual volume names causes the command to exit without
removing any virtual volumes.
Any virtual volumes exported as VLUNs are not removed and the command stops at that virtual volume.
Any virtual volume that contains snapshots cannot be removed.
Verify the removal of VVs by issuing the showvv on page 558 command.
removevvset
DESCRIPTION
The removevvset command removes a VV set or removes VVs from an existing set. Exported VV sets
cannot be removed.
SYNTAX
removevvset [options] <setname|pattern> [<VV|pattern>...]
AUTHORITY
•
•
Super, Edit
Any role granted the vvset_set right can remove a volume set or volumes from a volume set
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-pat
Specifies that both the set name and VVs will be treated as glob-style patterns.
SPECIFIERS
<setname|pattern>
Specifies the name of the VV set to remove. If the -pat option is specified the setname will be treated as a
glob-style pattern, and multiple VV sets will be considered.
<VV|pattern>
Optional list of VV names that are members of the set.
If no <VV>s are specified, the vv set is removed, otherwise the specified <VV>s are removed from the VV
set. If the -pat option is specified each VV will be treated as a glob-style pattern, and multiple VVs will be
considered.
EXAMPLES
The following example removes a VV set:
cli% removevvset vvset
The following example removes a single VV from a set:
cli% removevvset vvset vv1
Trying to remove an exported VV set results in an error:
removevvset
287
cli% removevvset -f set:1
Unable to delete vv set 1 exported to lun 1, host h1
The following example removes the vvsets that start with test:
cli% removevvset -f -pat test*
The following example removes any VVs that start with test or sample from all vvsets:
cli% removevvset -f -pat * test* sample*
NOTES
The patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
removewsapisession
DESCRIPTION
The removewsapisession command removes the WSAPI user connections from the current system.
SYNTAX
removewsapisession [options] <id> <user_name> <IP_address>
AUTHORITY
•
•
Super
Any role granted the wsapisession_remove right
OPTIONS
-pat
Specifies that the <id>, <user_name> and <IP_address> specifiers are treated as glob-style (shell-style)
patterns and all WSAPI user connections matching those patterns are removed. By default, confirmation
is required to proceed with removing each connection unless the -f option is specified.
-dr
Specifies that the operation is a dry run and no connections are removed.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<id>
Specifies the Id of the WSAPI session connection to be removed.
<user_name>
Specifies the name of the WSAPI user to be removed.
288
removewsapisession
<IP_address>
Specifies the IP address of the WSAPI user to be removed.
EXAMPLES
The following example displays the forced removal of all sessions for user user1.
cli% removewsapisession -f -pat * user1 *
Removing user WSAPI connection id:1383876394258938 Name:user1 Ip_Addr:
16.94.225.96
Removing user WSAPI connection id:1383876393423508 Name:user1 Ip_Addr:
16.94.225.96
NOTES
Access to all domains is required to run this command.
Because user connections can disappear from the time they are listed and the time they are removed, the
removewsapisession command continues past errors while removing individual connections if the -pat
option is specified.
Remove Commands
289
Restore Command
restorefsconf
DESCRIPTION
The restorefsconf command restores a configuration backup for a VFS. The FPG/VFS names of the
source and destination need to match before the restore can be done. Configuration backup artifact
created by backupfsconf needs to be kept in the .admin file store of the destination VFS in the
directory configbackup.
SYNTAX
restorefsconf [-fpg <fpg>] <vfs>
AUTHORITY
•
•
Super, Service
Any role granted fsconf_restore right
OPTIONS
-fpg <fpgname>
Specifies the FPG for the VFS.
SPECIFIERS
<vfs>
Specifies the name of the VFS.
EXAMPLES
The following example restores a configuration backup on file provisioning group named "samplefpg" in
virtual server named "samplevfs":
cli% restorefsconf -fpg samplefpg samplevfs
NOTES
Access to all domains is required to run this command.
Hewlett Packard Enterprise recommends that you perform the configuration restore before restoring a
data backup.
When performing a configuration restore, the process maintains a restoration order of the file stores, VFS
IP, Share information of NFS, CIFS, and Object/Certificates, AV configuration and Quota information.
Manually configure the cluster-wide AV VSE data before doing a configuration restore.
The following actions must be observed when creating a configuration restore:
•
•
•
•
290
Manually set up the FPG and the VFS.
Create a folder called "configbackup" under the VFS in the .admin file store, and manually copy the
backup artifact into that folder.
The NDMP data restore creates folders for each of the CIFS and NFS shares.
The backed-up VFS IP is recreated during restore. It will fail if there is an IP conflict because the IP
already taken.
Restore Command
See "backupfsconf on page 80" for additional information on configuration backup and restore.
Restore Command
291
Service Commands
servicecage
DESCRIPTION
The servicecage command is necessary when executing removal and replacement actions for a drive
cage interface card module. The startfc or unstartfc subcommands are used to initiate service on a
cage, and the endfc subcommand is used to indicate that service is completed.
SYNTAX
servicecage remove [-f] <cagename>
servicecage startfc|unstartfc|endfc|resetfc|hresetfc|clearlog [-f] [-ovrd]
[a|b]|[<0|1>] <cagename>
SUBCOMMANDS
startfc
Prepare an FC-AL module for removal.
unstartfc
Stop the startfc subcommand.
endfc
Indicates that service on the drive cage is completed and allows the system to resume use of the
interface card module. Both startfc and unstartfc need this action to complete the service
operation.
Permitted for Edit, Super and Service roles.
resetfc
Initiates a soft reset of the interface card for DC1, DC3, DCS1, DCS2, and DCN1 drive cages. DC2 and
DC4 drive cages will be reset and the interface card specifier is ignored.
hresetfc
Initiates a hard reset of the interface card for DC1, DC3, DCS1, DCS2, and DCN1 drive cages. DC2 and
DC4 drive cages will be reset and the interface card specifier is ignored.
remove
Removes the indicated drive cage (indicated with the <cage_name> specifier) from the system. If this
subcommand is used, the a|b or 0|1 port specifier is not required. This command fails when the cage has
active ports or is in use.
clearlog
For DC2 and DC4 cages, clears the log in the cage. The Interface card module specifier is ignored. It is
not supported on any cages other than DC1, DC2 and DC4.
AUTHORITY
•
Super, Service
OPTIONS
-f
Forces the operation. When this option is not used, the command requires confirmation before
proceeding.
292
Service Commands
-ovrd
Forces the specified physical disk path offline even if it is the last remaining path.
SPECIFIERS
a|b
Specifies the side of the specified DC1 and DC3 drive cage to be serviced. This specifier is not required.
0|1
Specifies the side of the specified DC2, DC4, DCS1, DCS2 or DCN1 drive cage to be serviced. This
specifier is not required.
<cage_name>
Specifies the name of the drive cage to be serviced.
EXAMPLES
The following example displays the commencement of Fibre Channel hot-plugging for drive cage cage0:
cli% servicecage startfc -f -ovrd cage0
NOTES
Access to all domains is required to run this command.
Issuing the servicecage command results in chunklet relocation, causing a dip in throughput.
The unstartfc subcommand is provided if a mistake was made when issuing the servicecage
command. The unstartfc subcommand stops the original command.
After issuing the startfc or unstartfc subcommands, the endfc subcommand must be issued to
indicate that service is completed and to restore the drive cage to its normal state.
servicehost
DESCRIPTION
The servicehost command executes removal and replacement actions for a host connecting to a
storage system port.
SYNTAX
servicehost list
servicehost remove [-f] [<node:slot:port> [<WWN_or_iSCSI_name> ... ]]
servicehost copy [-f] <src_node:slot:port> <WWN_or_iSCSI_name_pattern>
<dest_node:slot:port>
SUBCOMMANDS
list
Displays a list of all inactive hosts. Permitted for all users.
remove
Removes an inactive host, as specified with the <WWN_or_iSCSI_name> specifier, from the indicated
port (<node:slot:port>) and its associated VLUNs. If the <WWN_or_iSCSI_name> specifier is not issued
with the remove subcommand, all inactive hosts on the specified port and their LUNs are removed. If the
servicehost
293
<node:slot:port> specifier is not used with the remove subcommand, all inactive hosts in the system and
their LUNs are removed.
copy
Copies all active VLUNs from the specified source port (as specified with <src_node:slot:port>) from host
WWNs or iSCSI names matching the specified pattern (<WWN_or_iSCSI_name_pattern>) to the
destination port (as specified with <dest_node:slot:port>). If necessary, the port is reset to target mode.
AUTHORITY
•
•
Super, Service
Any role granted the host_service right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<node:slot:port>
Specifies the host to be removed which is visible to the specified port.
This specifier can only be used with the remove subcommand.
<WWN_or_iSCSI_name>
Specifies a host's World Wide Name(WWN). This specifier can only be used with the remove and copy
subcommands. When used with the remove subcommand, this specifier can be repeated.
<WWN_or_iSCSI_name_pattern>
Specifies that the indicated WWN or iSCSI name is treated as a glob-style pattern.
<src_node:slot:port>
Specifies the source port when exporting VLUNs. This specifier can only be used with the copy
subcommand.
<dest_node:slot:port>
Specifies the destination port when exporting VLUNs. This specifier can only be used with the copy
subcommand.
EXAMPLES
The following example displays the creation of a host on port 0:2:1 for the export of VLUNs from port
2:1:1:
cli% servicehost copy 2:1:1 20000200000CF790 0:2:1
Are you sure you want to run servicehost?
select q=quit y=yes n=no: y
The following example displays the removal of an inactive host from port 2:1:1:
294
Service Commands
cli% servicehost remove 2:1:1 20000200000CF790
Removing inactive host 20000200000CF790 on port 2:1:1
Are you sure?
select q=quit y=yes n=no: y
NOTES
Access to all domains is required to run this command.
If the <WWN_or_iSCSI_name> specifier is not issued with the remove subcommand, all inactive hosts on
the specified port and their LUNs are removed.
If the <node:slot:port> specifier is not used with the remove subcommand, all inactive hosts in the system
and their LUNs are removed.
servicemag
DESCRIPTION
The servicemag command executes service on a drive magazine or disk.
SYNTAX
The syntax for the servicemag command can be one of the following:
servicemag start [options] <cage_ID> <magazine>
servicemag start [options] -pdid <PD_ID_0>...<PD_ID_3>
servicemag resume|unmark [options] <cage_ID> <magazine>
servicemag status [options] [<cage_ID> <magazine>]
servicemag clearstatus <cage_ID> <magazine>
SUBCOMMANDS
start
Specifies that the servicemag command informs the system manager to log or relocate disks on a drive
magazine so that the drive magazine can be removed for service.
resume
Specifies that the servicemag command informs the system manager that a drive magazine is replaced
and that data services can be resumed.
unmark
Specifies that the servicemag operation is stopped and its internal state is reset. Since the
servicemag operation is a multi-step process, specifying unmark stops the servicemag operation at
the completion of the current step. Relocation of chunklets is considered one step and can take from
several minutes to several hours (depending on number of chunklets) to complete. If servicemag
unmark' is issued during the relocation phase, the spin-down phase will indicate that the servicemag start operation 'Failed'. This can be confirmed by issuing servicemag status -d'. If the intent was
to prevent servicemag from completing, issue servicemag resume' to move the data back onto the
drive(s) in this magazine once the servicemag start' operation reports a failure. The 'unmark' option
should not be used without consulting with HPE engineering.
status
servicemag
295
Specifies that the status of the servicemag command operations on a drive magazine are displayed.
Permitted for Super, Service, Edit and Browse users. Summary status is given as default, and the -d
option may be used to get detailed status.
clearstatus
Clears the log shown by the servicemag command status for the given cage and magazine.
AUTHORITY
•
•
Super, Service
Any role granted the mag_service right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-wait
Specifies that the servicemag command must be completed before exiting.
If not specified, the servicemag command automatically exits before service begins and the remainder
of the process proceeds in the background. This option is only valid for the start/resume operations.
-log
Specifies that write operations to chunklets of valid disks are written to a logging area when the magazine
is out of service (or removed).
When the disks return and the servicemag resume option is issued, the data is written from the logging
logical disks to those disks. Chunklets are relocated to free or spare space if their failures would result in
a RAID set becoming invalid (for example, if two disks would be missing from a RAID-5 logical disk). All
other used chunklets are placed in the logging mode. This option is only valid for the start operation and
should always specify -nodisks or -pdid <PD_ID>.
CAUTION:
This option may reduce the redundancy level of RAID sets until servicemag resume completes
successfully.
-nodisks
Specifies that the serviced drive magazine's disk drives are valid and do not need to be replaced. This
option can only be used with the start subcommand and -log option.
-partial
This option can only be used with the resume subcommand. Specifies that as many chunklets as possible
are relocated. Error messages are printed for those chunklets that could not be relocated.
-pdid <PD_ID_0>...<PD_ID_3>
Specifies one to four physical disks (by physical disk ID) that need to be serviced or replaced. The PDs
have to be in the same cage and magazine. If the -log option is also specified, logging will only apply to
the remaining disks on the magazine and not the ones specified in this option. The disks specified in this
option will be vacated out to be replaced and will not be logged. This option can only be used with the
start subcommand, and cannot be used with the <cage_ID> or <magazine> specifiers.
-d
Displays detailed status of a servicemag operation. If the -d option is excluded, a summary of the status
is displayed. This option is only valid for the status subcommand.
-dryrun
296
Service Commands
This option is used to estimate the length of time a servicemag start or servicemag resume will
take to complete. If a -dryrun is started before an actual servicemag start or resume, the estimation will be
based on empirical data with no I/O on the system. For a more accurate estimate, which will do runtime
calculations based on the load on the system, please use 'servicemag status <cage_ID>
<magazine>' once 'servicemag start' or 'servicemag resume' has been initiated. This option is
only valid for the start and resume operations.
SPECIFIERS
<cage_ID>
Specifies the ID of the cage. Use the showcage on page 425 command to determine the system's drive
cage IDs.
<magazine>
Specifies the drive magazine within the specified drive cage to be serviced based on the side of the drive
magazine and drive magazine slot number.
For drive chassis with a single drive cage (type DC2, DC4, and DC3), the valid syntax is <position> (the
numeric position of the drive magazine).
Position values for DC2 drive cages can be from 0 to 9. Position values for DC3 drive cages can be from
0 to 15.
EXAMPLES
The following example displays the suspension and resumption of data services on drive magazine 0 in
drive cage 2:
Service Commands
297
cli% servicemag start -log -wait 2 0
Begin servicemag start log 2 0.0...
... disks in mag : 2 0.0
... valid disks: wwn [2000000087043098] id [20] diskpos [0]
.................... wwn [2000000087008150] id [21] diskpos [1]
... not valid disks:
... mark disk wwn [2000000087043098] id [20] as non usable for ld
allocation
... mark disk wwn [2000000087008150] id [21] as non usable for ld
allocation
... relocating chunklets to spare space
... relocating chunklets of fail sets after logging to spare space
... logging chunklets from pd wwn [2000000087043098] id [20]
... logging chunklets from pd wwn [2000000087008150] id [21]
... spinning down disk wwn [2000000087043098] id [20]
... spinning down disk wwn [2000000087008150] id [21]
... bypassing mag 2 0.0
... bypassed mag 2 0.0
servicemag start 2 0.0 Succeeded
cli% servicemag resume 2 0
Begin servicemag resume 2 0.0...
... onlooping mag 2 0.0
... checking for valid disks...
... disks in mag : 2 0.0
... valid disks: wwn [2000000087043098] id [20] diskpos [0]
.................... wwn [2000000087008150] id [21] diskpos [1]
.................... wwn [20000000870042F6] id [22] diskpos [2]
.................... wwn [2000000087007E6D] id [23] diskpos [3]
... not valid disks:
... playback chunklets from pd wwn [2000000087043098] id [20]
... playback chunklets from pd wwn [2000000087008150] id [21]
... playback chunklets from pd wwn [20000000870042F6] id [22]
... playback chunklets from pd wwn [2000000087007E6D] id [23]
... 74 chunklets still waiting to be played back or relocating...
.... 18 chunklets still waiting to be played back or relocating..
... All chunklets played back / relocated.
... no chunklets to move
... marking pd wwn [2000000087043098] id [20] as usable for ld
allocation
... marking pd wwn [2000000087008150] id [21] as usable for ld
allocation
... marking pd wwn [20000000870042F6] id [22] as usable for ld
allocation
... marking pd wwn [2000000087007E6D] id [23] as usable for ld
allocation
servicemag resume 2 0.0 Succeeded
NOTES
Access to all domains is required to run this command.
Issuing the servicemag command results in chunklet relocation that causes a dip in throughput.
298
Service Commands
When a servicemag command is issued with the -log option, all chunklets on the disks in the drive
magazine being serviced are marked as "normal,smag".
This state indicates an active servicemag operation on the disks.
Any I/O on the chunklets marked "normal,smag" changes the states to "logging" and I/O is written to the
logging logical disks.
Issuing the servicemag resume command causes playback of the log. Any chunklets in the "logging"
state enter "playback" state as their data is played back. After all the data is played back, the chunklets
return to the "normal" state. Any chunklets in the "normal,smag" state return directly to the "normal" state.
Chunklet states can be checked by issuing either the showldch or showpdch commands.
By default, the servicemag command relocates all chunklets in the magazine to destinations starting
first with local (such as on the owning node for the logical disk) spares, then local free space, then remote
spare and finally remote free space.
In the case when a drive needs to be replaced, the -log option should always be used in conjunction with
the -pdid option.
Replacing disks that have not had data completely relocated can lead to data loss. If the drives need to
be replaced, the -log option should be used in conjunction with the -pdid option.
For the servicemag start command only, instead of using the <cage_ID> <magazine> specifiers, the
disk(s) to be serviced can also be specified using the -pdid option. The advantage is that "servicemag
resume" will dismiss the old pdid when it successfully completes. However if "servicemag unmark
<cage_ID> <magazine>" is run after servicemag start command with -pdid option then the disk
will not be dismissed.
servicenode
DESCRIPTION
The servicenode command informs the system that a certain component will be replaced, and will
cause the system to indicate the physical location of that component.
SYNTAX
servicenode <subcommand> [options] <nodeid>
SUBCOMMANDS
start
Specifies the start of service on a node.
status
Displays the state of any active servicenode operations.
end
Specifies the end of service on a node.
AUTHORITY
•
•
Super, Service
Any role granted the node_service right
OPTIONS
-ps <psid>
Specifies which power supply will be placed into servicing-mode.
Accepted values for <psid> are 0 and 1.
servicenode
299
-pci <slot>
Only the service LED corresponding to the PCI card in the specified slot will be illuminated. Accepted
values for <slot> are 0 through 8.
-fan <fanid>
Specifies which node fan will be placed into servicing-mode. Accepted values for <fanid> are 0 and 1 for
HPE 3PAR 10000 systems and 0, 1, and 2 for HPE 3PAR 20000 systems.
-drive
Only the service LED corresponding to the node's internal drive will be illuminated.
-bat
Specifies that the node's battery backup unit will be placed into servicing-mode.
SPECIFIERS
<nodeid>
Indicates which node the servicenode operation will act on. Accepted values are 0 through 7.
EXAMPLES
In the following example, fan 1 on node 3 is put into servicing-mode.
cli% servicenode start -fan 1 3
NOTES
Access to all domains is required to run this command.
On HPE 3PAR 7000 and HPE 3PAR 8000 series systems only the node LED can be illuminated.
On Safe-To-Remove platforms such as HPE 3PAR 20000 systems, if a FRU is found unsafe to remove,
the command will return an error.
300
Service Commands
Set Commands
setalert
DESCRIPTION
The setalert command sets the status of system alerts.
SYNTAX
setalert new|ack|fixed {<alert_ID>...|-a}
AUTHORITY
•
•
Super, Service
Any role granted the alert_set right
OPTIONS
-a
Specifies that the status of all alerts be set. If not specified, the <alert_ID> specifier must be specified.
SPECIFIERS
<alert_ID>...
Specifies that the status of a specific alert be set. This specifier can be repeated to indicate multiple
specific alerts. Up to 99 alerts can be specified in one command. If not specified, the -a option must be
specified on the command line.
new|ack|fixed
Specifies that the alert(s), as indicated with the <alert_ID> specifier or with option -a, be set as "New"
(new), "Acknowledged" (ack), or "Fixed" (fixed).
EXAMPLES
The following example sets the status of all system alerts to "New":
cli% setalert new -a
NOTES
Verify the status of alerts by issuing the showalert on page 418 command.
Access to all domains is required to run this command.
setaocfg
DESCRIPTION
The setaocfg command updates an Adaptive Optimization configuration.
SYNTAX
setaocfg [options <arg>] <aocfg_name>
Set Commands
301
AUTHORITY
•
Super, Service, Edit
OPTIONS
-t0cpg <cpgname>
Specifies the Tier 0 CPG for this AO config.
-t1cpg <cpgname>
Specifies the Tier 1 CPG for this AO config.
-t2cpg <cpgname>
Specifies the Tier 2 CPG for this AO config.
-mode <mode>
Specifies the optimization bias for the AO config and can be one of the following:
•
•
•
Performance: Move more regions towards higher performance tier.
Balanced: Balanced between higher performance and lower cost.
Cost: Move more regions towards lower cost tier.
-t0min <size>[g|G|t|T]
-t1min <size>[g|G|t|T]
-t2min <size>[g|G|t|T]
Specifies the minimum space utilization of the tier CPG for AO to maintain when optimizing regions
between tiers. The size can be specified in MB (default) or GB (using g or G) or TB (using t or T).
Setting a minimum to 0 (default) indicates that no minimum space utilization will be enforced.
-t0max <size>[g|G|t|T]
-t1max <size>[g|G|t|T]
-t2max <size>[g|G|t|T]
Specifies the maximum space utilization of the tier CPG. AO will move regions into and out of the CPG
based on their relative access rate history, but will not exceed this maximum size in the CPG.
The size can be specified in MB (default) or GB (using g or G) or TB (using t or T). Setting a max to 0
(default) indicates that AO will use other indicators to decide the maximum CPG space utilization:
either the CPG sdgl, sdgw, or maximum possible growth size.
-name <newname>
Specifies a new name for the AO configuration of up to 31 characters in length.
SPECIFIERS
None.
EXAMPLES
The following example changes the optimization bias (mode) of an AO configuration called aocfg1 to
Performance:
cli% setaocfg -mode Performance aocfg1
The following example sets the tier 1 CPG for AO configuration aocfg2 to R5FCcpg. R5FCcpg must not
already be used in an AO configuration, and the tier 1 CPG for aocfg2 must not already be set:
302
Set Commands
cli% setaocfg -t1cpg R5FCcpg aocfg2
The following example swaps a CPG between tiers:
cli% setaocfg -t0cpg R1SSDcpg -t2cpg R6NLcpg aocfg3
The following example removes a CPG from a tier. This assumes that aocfg1 has 3 tiers initially:
cli% setaocfg -t0cpg "" aocfg1
NOTES
Two or more Tier CPGs must be defined.
If domains are in use on the system, all CPGs must be in the same domain or not in any domain.
A CPG can only belong to one AO configuration.
A CPG can be removed from a tier by specifying a null string "". At least two tiers must remain. When a
CPG is removed from a tier, the allocated space on that CPG is not removed and will remain in the CPG.
So before removing a CPG from the AOCFG, all the space in the CPG should be moved to other tiers.
This can be done by setting the max for the AOCFG tier to 1 which will force subsequent runs of
startao command to move space out of the CPG to other tiers. After all the space has been moved out
of the CPG, it can be removed from the AOCFG.
A CPG can be moved and swapped between tiers within the same AO configuration.
A CPG cannot be moved between AO configurations - it must first be removed from one and then added
to the second.
Active use of Adaptive Optimization requires an Adaptive Optimization license. Contact your local 3PAR
representative for information.
setauthparam
DESCRIPTION
The setauthparam command is used to set the authentication and authorization parameters.
SYNTAX
The syntax of the setauthparam command can be one of the following:
setauthparam [-f] <param> <value>
setauthparam [-f] <map-param> <map-value>...
setauthparam [-f] -clear <param>...
setauthparam [-f] -clearall
AUTHORITY
•
•
Super
Any role granted the authparam_set right
OPTIONS
setauthparam
303
-f
Does not ask for a confirmation before performing the operation.
-clearall
Clears all the authentication parameters.
-clear
Clears only the specified authentication parameters.
SPECIFIERS
Specifiers for the setauthparam command can be issued as the following:
Table 3: Values for <param> <value> Specifiers
<param>
<value>
account-name-attr
The attribute of an account object that holds the user's username.
account-obj
The objectClass attribute of an account object.
accounts-dn
Indicates the base of the subtree in the DIT to search for objects that
hold account information. Multiple bases can be specified using
multiple <value> arguments. It is mutually exclusively with the
groups-dn variable.
allow-ssh-key
Set this value to 1 to allow LDAP users to set a public SSH key with
the setsshkey on page 396 command (default 0). Clearing or setting
the variable to 0 disables the setting of new keys for LDAP users but
any existing keys remain until they are removed with the
removesshkey on page 278 command. This parameter only affects
LDAP users, not local users.
binding
The LDAP binding type must be one of the following:
•
•
domain-name-attr
simple—use simple binding with the server.
SASL—use a SASL mechanism that is expected by the server,
with the mechanism set by the sasl-mechanism variable.
When set, the mapping of groups to domains is enabled. For a user
that is a member of a group that maps to a role level, the value of
domain-name-attr is used to look up an attribute in the group that
holds the name of the domain. If the domain is too long or contains
characters that are not allowed in a domain name, the name is
truncated to the maximum length of a domain name and invalid
characters are replaced with an underscore ( _ ).
Table Continued
304
Set Commands
<param>
<value>
domain-name-prefix
When domain-name-prefix is set, the value of the attribute specified
by domain-name-attr is a candidate domain name. The value of
domain-name-prefix is a character string used to extract the domain
name from the candidate. The value is an optional exclamation point
( ! ) followed by a character string called the prefix. The exclamation
point is a flag that means the presence of the prefix is required and is
described more in the paragraphs that follow.
The candidate domain name is searched for the presence of the
prefix and if found, the domain name starts after the first occurrence
of the prefix and stops before the first space or tab following it or at
the end of the candidate domain name.
If the prefix is not found, the behavior depends on the flag. If the
exclamation point was not used (there is no flag), the candidate
domain name becomes the domain name. If the flag is present, the
candidate domain name is rejected and there is no domain name.
As a last step, and as described for domain-name-attr, domain names
can be truncated and have invalid characters replaced.
Some examples of the effects of domain-name-prefix are shown in
the following table, "Examples of Domain Name Prefix Effects".
group-name-attr
The attribute in the group object that holds the group's name.
group-obj
Indicates the objectClass attribute of a group object.
groups-dn
Indicates the base of the subtree in the DIT in which to search for
objects that hold group information. It is mutually exclusively with the
accounts-dn variable.
kerberos-realm
The Kerberos realm.
kerberos-server
Indicates the numeric IP address of the Kerberos server if different
from the LDAP server.
ldap-2FA-cert-field
The name of the field in the two factor authentication certificate that
will be used to uniquely identify the user in LDAP.
ldap-2FA-object-attr
The attribute in the LDAP object that corresponds to the two factor
authentication certificate field value.
ldap-port
Indicates the port of the LDAP server (default: 389 for non-SSL, 636
for SSL).
ldap-reqcert
Indicates whether a valid server certificate should be required in order
to proceed. (The default value is 0.)
Table Continued
Set Commands
305
<param>
<value>
ldap-server
Numeric IP address of the LDAP server.
If hostname, the value is the name of the LDAP server in its
certificate or the value of the LDAP principal stored in the Kerberos
database, and will usually be a fully-qualified domain name.
Multiple servers can be specified using multiple <value> arguments.
ldap-server-hn
Indicates the hostname of the LDAP server if ldap-server is an IP
address. This value must be set when the ldap-reqcert option is set or
the sasl-mechanism option is set to GSSAPI and ldap-server is set to
an IP address.
ldap-service-account
The username of the service account used to communicate with
LDAP to validate LDAP user security group membership.
ldap-service-accountpassword
The password that corresponds to the user set in ldap-serviceaccount.
ldap-ssl
To use SSL when communicating with the LDAP server, set the value
to 1. (The default value is 0.)
ldap-StartTLS
Set this parameter to one of the following:
•
•
•
ldap-type
no—(default) to not request the server use StartTLS.
try—to request the server use StartTLS but does not require it to
proceed.
require—requests that the server uses StartTLS and continues
only when it succeeds.
The type of LDAP server being used:
•
•
•
•
MSAD—Microsoft Active Directory.
OPEN—OpenLDAP.
RHDS—Red Hat Directory Server.
LOAD—Load Balancer.
member-attr
The attribute that holds the names of users in the group.
memberof-attr
The attribute that holds the name of a group of which the user is a
member.
native-domain
The default LDAP domain to be prepended to the Kerberos realm
when no other subdomain is supplied.
sasl-mechanism
When the binding is SASL, the SASL mechanism must be one
supported by the LDAP server. The system allows the mechanisms of
PLAIN, DIGEST-MD5, and GSSAPI.
Table Continued
306
Set Commands
<param>
<value>
user-attr
Indicates the attribute used to form a DN for simple binding. When
the attribute ends with a backslash, the DN is the concatenation of
the value of user-attr and the username . When the attribute does not
end with a backslash, it is as described for the user-dn-base variable.
user-dn-base
When using simple binding, the authentication process attempts to
bind the user to an entry in the server's Directory Information Tree
(DIT). The Distinguished Name (DN) of the entry is a concatenation
of the value of user-attr, "=", the username, ",", and the value of userdn-base. If group-obj is set to posixGroup, the value of user-dn-base
is also used as the base for searching for the user's posixAccount
entry, regardless of binding type.
Table 4: Examples of Domain Name Prefix Effects
Candidate
Domain-name-prefix
Result
dom1
ISDom=
dom1
ISDom=dom2
ISDom=
dom2
ISDom=dom3
!ISDom=
dom3
dom4
!ISDom=
There is no resulting domain name
because "ISDom=" does not appear in the
candidate.
Table 5: Values for Specifiers <map-param> and <map-value>
<map-param>
<map-value>
super-map
A group name that grants the user the Super role level if the user is a
member of that group. Multiple group names can be specified using
multiple <map-value> arguments. A value of “*” matches any group
name.
service-map
Same as super-map, but for the Service level.
edit-map
Same as super-map, but for the Edit level.
browse-map
Same as super-map, but for the Browse level.
create-map
Same as super-map, but for the Create level.
basic_edit-map
Same as super-map, but for the Basic_edit level.
3PAR_AO-map
Same as super-map, but for the 3PAR_AO level.
3PAR_RM-map
Same as super-map, but for the 3PAR_RM level.
The user will be mapped to highest permission level that matches.
Set Commands
307
EXAMPLES
None.
NOTES
When using Microsoft Active Directory, the minimum parameters that must be specified:
ldap-type, kerberos-realm and the necessary group permission maps.
The array will use GSSAPI SASL binding with the default values for all other parameters, using all LDAP
servers that have SRV records in DNS.
Users who have been provided with a password that allows successful binding with the LDAP server will
nevertheless be denied access if they are not members of any of the groups specified by the map
parameters.
The matching of a user's groups with the mapping rules is done in the order of the mapping parameters
provided previously. When there are multiple matches, the first match determines the user's role.
Domain names found with the use of domain-name-attr and domain-name-prefix are only potential
domains and a user will only have roles in those if they are actually existing domains. The showdomain
on page 437 command will list existing domains.
The showauthparam on page 420 command displays authentication parameter settings and the
checkpassword on page 87 command can be used to see how the parameters are used to bind with an
LDAP server and search for data to determine the user's role.
When domains are enabled, Super or Service role provide access across all domains. Any other domain
names are ignored for Super or Service role users. You can only have the Service role when no other
domains match for roles other than Super or Service. If other such domains match, the Service role match
is ignored.
setbattery
DESCRIPTION
The setbattery command may be used to set battery information such as the battery's expiration date,
its recharging time, and its serial number. This information gives the system administrator a record or log
of the battery age and battery charge status.
SYNTAX
setbattery [options <arg>] <node_ID>
setbattery [options <arg>] <node_ID> <powersupply_ID> <battery_ID>
AUTHORITY
•
•
Super, Service
Any role granted the battery_set right
OPTIONS
-s <serial_number>
Specifies the serial number of the battery using a limit of 31 alphanumeric characters. This option is not
supported on HPE 3PAR 10000 and 20000 systems.
-x <exp_date>
Specifies the expiration date of the battery (mm/dd/yyyy). The expiration date cannot extend beyond
2037.
-l
Specifies that the battery test log is reset and all previous test log entries are cleared.
308
setbattery
-r
Specifies that the battery recharge time is reset and that 10 hours of charging time are required for the
battery to be fully charged.
This option is deprecated.
SPECIFIERS
<node_ID>
Specifies the node number where the battery is installed. Node_ID is an integer from 0 through 7.
<powersupply_ID>
Specifies the power supply number on the node using either 0 (left side from the rear of the node) or 1
(right side from the rear of the node).
<battery_ID>
Specifies the battery number on the power supply where 0 is the first battery.
EXAMPLES
The following example resets the battery test log and the recharging time for a newly installed battery on
node 2, power supply 1, and battery 0, with an expiration date of July 4, 2006:
cli% setbattery -x 07/04/2006 2 1 0
NOTES
Access to all domains is required to run this command.
To view battery status information, issue the showbattery on page 421 command.
In order to modify battery attributes on HPE 3PAR 10000 systems and 20000 systems, only the node_ID
and the battery attributes of interest are required. Older platforms require the node_ID, powersupply_ID,
and battery_ID in order to modify battery attributes.
setcage
DESCRIPTION
The setcage command enables service personnel to set or modify parameters for a drive cage.
SYNTAX
setcage [subcommand <arg>]... <cage_name>
SUBCOMMANDS
position <position>
Sets a description for the position of the cage in the cabinet, where <position> is a description to be
assigned by service personnel (for example, "left-top")
ps <model>
Sets the model of a cage power supply, where <model> is a model name to be assigned to the power
supply by service personnel. This model name appears in the Model column of the showcage -d
command output.
AUTHORITY
setcage
309
•
•
Super, Service
Any role granted the cage_set right
OPTIONS
None.
SPECIFIERS
<cage_name>
Indicates the name of the drive cage that is the object of the setcage operation.
EXAMPLES
The following example demonstrates how to assign cage1 a position description:
cli% setcage position "Cabinet 0 Bay 5 " cage1
The following example demonstrates how to assign model names to the power supplies in cage1:
cli% setcage ps Magnetek cage1
NOTES
Access to all domains is required to run this command.
The parameters specified by the setcage command appear in the showcage -d output (see the
showcage on page 425 command).
The power supply model cannot be modified if the information is automatically retrieved from the system.
setcim
DESCRIPTION
The setcim command sets properties of the CIM server, including options to enable/disable the HTTP
and HTTPS ports for the CIM server. setcim allows a user to enable/disable the SLP port. The
command also sets the CIM server policy.
SYNTAX
setcim [options]
AUTHORITY
•
•
Super, Service
Any role granted the cim_set right
OPTIONS
-f
Forces the operation of the setcim command, bypassing the typical confirmation message.
At least one of the following options are required:
-slp {enable | disable}
Enables or disables the SLP port 427.
-http {enable | disable}
310
setcim
Enables or disables the HTTP port 5988.
-https {enable | disable}
Enables or disables the HTTPS port 5989.
-pol <policy>[,<policy>...]
Sets the cim server policy:
•
•
•
•
•
•
replica_entity—complies with SMI-S standard for usage of Replication Entity objects in associations.
This is the default policy setting.
no_replica_entity—does not comply with SMI-S standard for Replication Entity usage. Use only as
directed by HPE support personnel or Release Notes.
one_hwid_per_view—calling exposePaths with multiple initiatorPortIDs to create new view will result in
the creation of multiple SCSCIProtocolControllers (SPC), one StorageHardwareID per SPC. Multiple
hosts will be created each containing one FC WWN or iscsiname. This is the default policy setting.
no_one_hwid_per_view—calling exposePaths with multiple initiatorPortIDs to create new view will
result in the creation of only one SCSCIProtocolController (SPC) that contains all the
StorageHardwareIDs. One host will be created that contains all the FC WWNs or iscsinames.
use_pegasus_interop_namespace—use the pegasus defined interop namespace root/PG_interop.
This is the default policy setting.
no_use_pegasus_interop_namespace—use the SMI-S conformant interop namespace root/interop.
SPECIFIERS
None.
EXAMPLES
The following example disables the HTTPS ports:
cli% setcim -https disable
Warning: The CIM server is active and will restart.
Are you sure you want to continue?
select q=quit y=yes n=no: y
The following example enables the HTTPS port:
cli% setcim -https enable
Warning: The CIM server is active and will restart.
Are you sure you want to continue?
select q=quit y=yes n=no: y
The following example disables the HTTP port and enables the HTTPS port:
cli% setcim -http disable -https enable
WARNING: CIM server is active and it will restart.
Are you sure you want to continue?
select q=quit y=yes n=no: y
The following example sets the no_use_pegasus_interop_namespace policy:
cli% setcim -pol no_use_pegasus_interop_namespace
WARNING: CIM server is active and it will restart.
Are you sure you want to continue?
select q=quit y=yes n=no: y
The following example sets the replica_entity policy:
Set Commands
311
cli% setcim -pol replica_entity
NOTES
Access to all domains is required to run this command.
You cannot disable both of the HTTP and HTTPS ports.
When the CIM server is active, a warning message will be prompted to inform you of the current status of
the CIM server and asks for the confirmation to continue or not. The -f option forces the action without a
warning message.
setclienv
DESCRIPTION
The setclienv command sets the CLI environment parameters.
SYNTAX
setclienv <parameter> <value>
AUTHORITY
•
•
Super, Service, Edit, Browse
Any role granted the clienv_set right
OPTIONS
None.
SPECIFIERS
The specifiers include the parameters and values to which the parameters should be set. Valid
parameters and their values are as follows:
<parameter>
<values>
currentdomain
Enter one of the following:
•
•
listdom
Enter one of the following:
•
•
csvtable
0 - (Default) Do not include the domain column in the output.
1 - Include domain column where relevant.
Enter one of the following:
•
•
nohdtot
The name of the domain that you wish to set as the working domain for the
current CLI session.
-unset to set no current domain.
0 - (Default) Normal table printing format.
1 - Comma Separated Values (CSV) format.
Enter one of the following:
•
•
0 - (Default) Show header and total lines.
1 - Does not show the header and total lines.
Table Continued
312
setclienv
<parameter>
<values>
matchbulkobjs
Enter one of the following:
•
•
0 - (Default) Does not perform operation on bulk objects.
1 - Perform operations on bulk objects.
hafter
<nlines> - Specifies the number of lines of data to display before an output
header is displayed. If <nlines> is 10 or more, print the header after every
<nlines> of data. If <nlines> is less than 10, print the header only at the
beginning.
histstatnum
<nlines> - For the hist and stat commands, specifies the number of lines
of data to display as soon as the data is available. Default is 5000 if
histstatnum is not set, or set to 0. The data sorting will be within the
<histstatnum> rows.
editor
This parameter is only supported when connected via SSH. Specifies the
command line editing mode. Enter one of the following:
•
•
emacs - (Default) Use emacs-style line editing.
vi - Use vi-style line editing.
EXAMPLES
In the following example, the CLI environment is set to display domains information:
cli% setclienv listdom 1
NOTES
This command is only available when you are using a CLI shell or SSH.
setcorequest
DESCRIPTION
The setcorequest command is used to approve, deny, execute, or cancel a dual sign-on request or
modify the queue size.
SYNTAX
setcorequest queuesize <size>
setcorequest {approve|deny} [-comment <comment>] <requestid>
setcorequest {execute|cancel} <requestid>
SUBCOMMANDS
approve
Approves a pending dual sign-on request.
deny
Rejects a pending dual sign-on request.
execute
setcorequest
313
Executes an approved dual sign-on request.
cancel
Cancels a pending dual sign-on request.
queuesize
Modifies the requests queue size.
AUTHORITY
•
•
•
CO
Any role granted the corequest_set right can approve/deny a request or modify the maximum
queue size
Any role granted the cotask_set right can execute or cancel a request
OPTIONS
-comment <comment>
Specifies the comment to be included in the request. The maximum size of <comment> is 255
characters.
SPECIFIERS
<requestid>
Specifies the request ID.
EXAMPLES
This example shows how to approve a request with id 12345:
cli% setcorequest approve 12345
This example shows how to deny a request with id 12345:
cli% setcorequest deny 12345
This example shows how to modify queue size to 25:
cli% setcorequest queuesize 25
This example shows how to execute an approved request with id 12345:
cli% setcorequest execute 12345
This example shows how to cancel a pending request with id 12345:
cli% setcorequest cancel 12345
NOTES
Only approved requests can be executed.
Only the requests having approval state as "pending" can be cancelled.
setcpg
DESCRIPTION
314
setcpg
The setcpg command modifies existing Common Provisioning Groups (CPG).
SYNTAX
setcpg [options <arg>] <CPG_name>
AUTHORITY
•
•
Super, Service, Edit
Any role granted the cpg_set right.
OPTIONS
-sa <LD_name>...
Specifies that existing logical disks are added to the CPG and are used for snapshot admin (SA) space
allocation. The <LD_name> argument can be repeated to specify multiple logical disks.
This option is deprecated and will be removed in a subsequent release.
-sd <LD_name>..
Specifies that existing logical disks are added to the CPG and are used for snapshot data (SD) space
allocation. The <LD_name> argument can be repeated to specify multiple logical disks.
This option is deprecated and will be removed in a subsequent release.
-f
Forces the command. The command completes the process without prompting for confirmation.
-aw <percent>
Specifies the percentage of used snapshot administration or snapshot data space that results in a
warning alert. A percent value of 0 disables the warning alert generation. The default is 0.
This option is deprecated and will be removed in a subsequent release.
-sdgs <size>[g|G|t|T]
Specifies the growth increment, the amount of logical disk storage created on each auto-grow operation.
The default growth increment may vary according to the number of controller nodes in the system. If
<size> is non-zero it must be 8G or bigger. The size can be specified in MB (default) or GB (using g or G)
or TB (using t or T). A size of 0 disables the auto-grow feature. The following table displays the default
and minimum growth increments per number of nodes:
Table 6: Growth Increment Per Number of Nodes
Number of Nodes
Default
Minimum
1-2
32 GB
8 GB
3-4
64 GB
16 GB
5-6
96 GB
24 GB
7-8
128 GB
32 GB
-sdgl <size>[g|G|t|T]
Specifies that the auto-grow operation is limited to the specified storage amount. The storage amount can
be specified in MB (default) or GB (using g or G) or TB (using t or T). A size of 0 (default) means no limit
is enforced. To disable auto-grow, set the limit to 1.
-sdgw <size>[g|G|t|T]
Set Commands
315
Specifies that the threshold of used logical disk space, when exceeded, results in a warning alert. The
size can be specified in MB (default) or GB (using g or G) or TB (using t or T). A size of 0 (default) means
no warning limit is enforced. To set the warning for any used space, set the limit to 1.
-t <RAID_type>
Specifies the RAID type of the logical disk: r0 for RAID-0, r1 for RAID-1, r5 for RAID-5, or r6 for RAID-6. If
no RAID type is specified, then the default is r6.
-ssz <size_number_chunklets>
Specifies the set size in terms of chunklets. The default depends on the RAID type specified: 2 for
RAID-1, 4 for RAID-5, and 8 for RAID-6.
-rs <size>
Specifies the number of sets in a row. The <size> is a positive integer.
If not specified, no row limit is imposed.
-ss <size_KB>
Specifies the step size from 32 KB to 512 KB. The step size should be a power of 2 and a multiple of 32.
The default value depends on raid type and device type used. If no value is entered and FC or NL drives
are used, the step size defaults to 256 KB for RAID-0 and RAID-1, and 128 KB for RAID-5.
If SSD drives are used, the step size defaults to 32 KB for RAID-0 and RAID-1, and 64 KB for RAID-5.
For RAID-6, the default is a function of the set size.
-ha port|cage|mag
Specifies that the layout must support the failure of one port pair, one cage, or one drive magazine (mag).
This option has no meaning for RAID-0. The default is cage availability.
-ch first|last
Specifies the chunklet location characteristics: either first (attempt to use the lowest numbered available
chunklets) or last (attempt to use the highest numbered available chunklets). If no argument is specified,
the default characteristic is first.
-p <pattern>
Specifies a pattern for candidate disks. Patterns are used to select disks that are used for creating logical
disks. If no pattern is specified, the option defaults to Fast Class (FC) disks. If specified multiple times,
each instance of the specified pattern adds additional candidate disks that match the pattern. The devtype pattern cannot be used to mix Nearline (NL), FC, and Solid State Drive (SSD) drives. An item is
specified as an integer, a comma-separated list of integers, or a range of integers specified from low to
high.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
316
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0-7).
The primary path of the disks must be on the specified node(s).
-st <item>
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0-7). The
primary path of the disks must be on the specified PCI slot(s).
-pt <item>
Set Commands
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0-4). The
primary path of the disks must be on the specified port(s).
-cg <item>
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
•
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
output indicating the side of the cage is omitted when using the -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single comma
(e.g. 1,2,3). A range of drive magazines is separated with a hyphen(e.g. 0-7). The specified drive
magazine(s) must contain disks.
-pn <item>
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen(e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
•
Specifies one or more physical disks. Disks are identified by one or more integers (item). Multiple
disks are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g.
0-3). Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
Specifies that physical disks with free chunklets greater than the number specified be selected.
-fc_lt <number>
•
Specifies that physical disks with free chunklets less than the number specified be selected.
-devid <model>
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list.
•
Models can be displayed by issuing the "showpd -i" command.
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd"
command. If it is not specified, the default device type is FC.
-rpm <number>
Disks must be of the specified speed. Device speeds are shown in the RPM column of the showpd
command. The number does not represent a rotational speed for the drives without spinning media
(SSD). It is meant as a rough estimation of the performance difference between the drive and the
other drives in the system. For FC and NL drives, the number corresponds to both a performance
measure and actual rotational speed. For SSD drive, the number is to be treated as relative
performance benchmark that takes into account in I/O per second, bandwidth and the access time.
Disks that satisfy all of the specified characteristics are used.
For example -p -fc_gt 60 -fc_lt 230 -nd 2 specifies all the disks that have greater than 60 and less than
230 free chunklets and that are connected to node 2 through their primary path.
Set Commands
317
-sax <LD_name>[,<LD_name>...]
Specifies that the logical disk, as identified with the <LD_name> argument, used for snapshot
administration space allocation be removed.
The <LD_name> argument can be repeated to specify multiple logical disks-sdx
<LD_name>[,<LD_name>...]
Specifies that the logical disk, as identified with the <LD_name> argument, used for snapshot data space
allocation be removed. The <LD_name> argument can be repeated to specify multiple logical disks.
-name <newname>
Specifies the name of the Common Provisioning Group (CPG) to be modified to. <newname> can be up
to 31 characters in length.
SPECIFIERS
<CPG_name>
Specifies the name of the common provisioning group being modified.
EXAMPLES
The following example displays the modification of the auto-growth parameters for common provisioning
group cpg1:
cli% setcpg -sdgs 16 -sdgl 48 -sdgw 36 cpg1
The following example removes the -cg pattern:
cli% setcpg -p -cg "" cpg1
The following example shows that this command sets the parameter that will be used for future grows and
it will OVERWRITE all previously set parameters. (use "showcpg -sdg" to verify):
cli% createcpg -sdgl 48 -sdgw 36 cpg1
cli% showcpg -sdg cpg*
------(MB)-----Id Name Warn Limit Grow Args
2 cpg1
36
48 32768 -p -devtype FC
cli% setcpg -p -nd 0,1 -devtype FC cpg1
cli% showcpg -sdg cpg*
------(MB)-----Id Name Warn Limit Grow Args
2 cpg1
36
48 32768 -p -nd 0,1 -devtype FC
NOTES
Access to all domains is required to run this command.
With this command, you can change the device type of a CPG from logical disks of one device type to
logical disks of another device type (device types are Fast Class (FC), Nearline (NL), Solid State Drive
(SSD).
318
Set Commands
This implies that, within a CPG, one can have logical disks of type FC, type NL, and type SSD. However,
this is only permitted so that, if a user wants to change the type of a CPG from FC to NL or SSD, they can
first change the new logical disk creation characteristics using setcpg and then use region moves to
change the device types of existing logical disks. For this same reason, users are permitted to add logical
disks of a different device type to a CPG.
This command sets the parameters that will be used for future grows. Unless the only growth parameters
(-sdgs, -sdgw or -sdgl) are being changed, this command will OVERWRITE all previously set parameters.
The options -sdgs, -sdgl and -sdgw control the auto logical disk creation for the Common Provisioning
Group's snapshot data regions. Auto logical disk creation occurs when the amount of free logical disk
space falls below the specified grow (enlarge) size setting options (-sdgs, -sdgl).
If auto-grow is enabled, new logical disks will be created automatically in addition to any logical disks
specified with -sa or -sd options.
To remove the pattern, enter "" after the <pattern>.
To move a CPG from one domain to another, use the movetodomain on page 241 command.
setdate
DESCRIPTION
The setdate command allows you to set the system time and date on all nodes.
SYNTAX
The syntax for the setdate command can be one of the following:
setdate <MMDDhhmm>[[<CC>]<YY>][<.ss>]
setdate -tzlist [group]
setdate -tz <tzname>
AUTHORITY
•
•
Super, Service
Any role granted the date_set right
OPTIONS
-tzlist [group]
Displays a timezone within a group, if a group is specified. If a group is not specified, displays a list of
valid groups.
-tz <tzname>
Sets the timezone on all nodes. The option must have a valid tzname from the list provided with the -tzlist
command.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation that
proposed time is correct before proceeding to change the time.
SPECIFIERS
<MMDD>
Specifies the month (MM) and day (DD).
<hhmm>
Specifies the hour (hh) and minute (mm) on a 24-hour clock.
<CC>
setdate
319
Specifies the century (CC) and cannot be used unless a year is specified (YY). This specifier is not
required.
<YY>
Specifies a year (YY). This specifier is not required.
<.ss>
Specifies seconds (ss). This specifier is not required.
EXAMPLES
The following example displays the current date on the node:
cli% showdate
The following example displays the timezones with the -tzlist option:
cli% setdate -tzlist
The following example narrows down the list to the required timezone of Etc:
cli% setdate -tzlist Etc
The following example shows the timezone being set:
cli% setdate -tz Etc/GMT
The following example verifies the timezone is set to the required setting:
cli% showdate
NOTES
Access to all domains is required to run this command.
Specifiers must be provided in one of the combinations listed as follows when issuing the setdate
command:
•
•
•
•
•
•
MMDDhhmm
MMDDhhmmYY
MMDDhhmmCCYY
MMDDhhmm.ss
MMDDhhmmYY.ss
MMDDhhmmCCYY.ss
Check node dates by issuing the showdate on page 436 command.
320
Set Commands
To set the date using Network Time Protocol (NTP), use the "setnet ntp" command to specify an NTP
server. The date will not change immediately, as NTP corrects the time slowly to avoid issues.
setdomain
DESCRIPTION
The setdomain command sets the parameters and modifies the properties of a domain.
SYNTAX
setdomain [options] <domain_name>
AUTHORITY
•
•
Super
Any role granted the domain_set right
OPTIONS
-name <name>
Changes the name of the domain.
-comment <comment>
Specifies comments or additional information for the domain. The comment can be up to 511 characters
long and must be enclosed in quotation marks. Unprintable characters are not allowed within the
<comment> specifier.
-vvretentiontimemax <time>{h|H|d|D}
Specifies the maximum value that can be set for the retention time of a volume in this domain. <time> is a
positive integer value and in the range of 0 - 43,800 hours (1825 days). Time can be specified in days or
hours providing either the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
To remove the maximum volume retention time for the domain, enter '-vvretentiontimemax ""'. As a result,
the maximum volume retention time for the system is used instead.
To disable setting the volume retention time in the domain, enter 0 for <time>.
SPECIFIERS
<domain_name>
Indicates the name of the domain.
EXAMPLES
In the following example, the name of a domain named Domain1 is changed to DomainX:
cli% setdomain -name DomainX Domain1
The following example displays the addition of a comment to the domain Engineering:
cli% setdomain -comment "This is a comment for engineering." Engineering
NOTES
Access to all domains is required to run this command.
setdomain
321
For moving objects into a domain, use the movetodomain on page 241 command.
setdomainset
DESCRIPTION
The setdomainset command sets the parameters and modifies the properties of a domain set.
SYNTAX
setdomainset [options <arg>] <setname>
AUTHORITY
•
•
•
Super, Edit
Any role granted the domainset_annotate right can only annotate the comment of a domain set
Any role granted the domainset_set right can set any domain set property
OPTIONS
-comment <comment>
Specifies any comment or additional information for the set. The comment can be up to 255 characters
long. Unprintable characters are not allowed.
-name <newname>
Specifies a new name for the domain set, using up to 27 characters in length.
SPECIFIERS
<setname>
Specifies the name of the domain set to modify.
EXAMPLES
This example renames a set from test1 to test2:
cli% setdomainset -name test2 test1
This example changes the comment on set test2:
cli% setdomainset -comment "This used to be set test1" test2
NOTES
Access to all domains is required to run this command.
setflashcache
DESCRIPTION
The setflashcache command allows you to set the policy of the flash cache for virtual volumes. The
policy is set by using virtual volume sets (vvset). The sys:all is used to enable the policy on all virtual
volumes in the system.
SYNTAX
setflashcache {enable|disable} {vvset:<name|pattern>|sys:all} ...
322
setdomainset
setflashcache {clear} {sys:all}
SUBCOMMANDS
enable
Will turn on the flash cache policy for the target object.
disable
Will turn off flash cache policy for the target object.
clear
Will turn off policy and can only be issued against the sys:all target.
AUTHORITY
•
•
Super, Edit
Any role granted the flashcache_set right
OPTIONS
None.
SPECIFIERS
vvset:<name|pattern>
<name> refers to the target object name as listed in the showvvset command. Pattern is glob-style
(shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see Glob-Style Patterns on
page 15.)
sys:all
The policy is applied to all virtual volumes.
EXAMPLES
The following example will enable flash cache policy for vvset1:
cli% setflashcache enable vvset:vvset1
The following example will enable flash cache policy for vvset1 and vvset2:
cli% setflashcache enable vvset:vvset1 vvset:vvset2
The following example will disable flash cache policy for vvset1 and vvset1:
cli% setflashcache disable vvset:vvset1 vvset:vvset2
The following example will enable the flash cache policy for all volumes in the system:
cli% setflashcache enable sys:all
The following example will clear the sys:all will turn off the global policy for virtual volumes:
Set Commands
323
cli% setflashcache clear sys:all
The following example will disable the policy for all virtual volume sets:
cli% setflashcache disable sys:all
NOTES
It is possible that a virtual volume can be in multiple virtual volume sets and that flash cache policy for
those sets may contradict each other.
In these cases the "enable" setting will take precedence. This is also true when the policy is enabled at
the system level.
Issuing disable for the sys:all will disable the policy at the system level.
Issuing clear for the sys:all will turn off the global policy for virtual volumes but will leave the policy for any
vvset that is in place.
setfpg
DESCRIPTION
The setfpg command allows the user to enable and disable various properties associated with a File
Provisioning Group.
SYNTAX
setfpg [options] <fpgname>
AUTHORITY
•
•
Super, Edit
Any role granted fpg_set right
OPTIONS
-f
Do not ask for confirmation.
-comment <comment string>
Specifies any addition textual information.
-rmcomment
Clears the comment string.
-activate
Makes the File Provisioning Group available.
-deactivate
Makes the File Provisioning Group unavailable.
-primarynode <nodeid>
Specifies the primary node to which the FPG will be assigned. Appropriate <nodeid> values are defined
as those on which File Persona has been enabled.
324
setfpg
-failover
Specifies that the FPG should be failed over to its alternate node. If it has previously failed over to the
secondary, this will cause it to fail back to the primary node. Will fail if a graceful failover is not possible.
-forced
In the event of failure to failover, this will attempt a forced failover.
-upgrade
Upgrades the On-disk version.
SPECIFIERS
<fpgname>
The fsname is the name of the file provisioning group to be modified.
EXAMPLES
The following example shows the assignment of examplefpg to node 1:
cli% setfpg -primarynode 1 examplefpg
The following example sets the comment for examplefpg:
cli% setfpg -comment "Example comment string" examplefpg
The following example activates examplefpg:
cli% setfpg -activate examplefpg
The following example upgrades the current on disk version of examplefpg:
cli% setfpg -upgrade examplefpg
NOTES
Access to all domains is required to run this command.
The -primarynode and -failover options are mutually exclusive.
When assigning primary nodes, the secondary node will be implicit as a couplet pair [0,1] [2,3] [4,5] [6,7].
This action will fail if the graceful failover is not possible.
The -failover and -primarynode options will result in temporary unavailability of the Virtual File
Servers associated with the FPG being migrated, and also the unavailability of any associated shares. An
implicit -deactivate and -activate process is undertaken during a migration to the alternate node.
setfs
DESCRIPTION
The setfs command configures the various components through subcommands.
SYNTAX
The syntax for the setfs command can be one of the following:
setfs ad [-passwd <password>] <user> <domain>
setfs ad -leave [-f]
setfs
325
setfs auth -clearcache
setfs auth [-f] <provider> ...
setfs dns {<ipaddress-list> [<suffix-list>]|-delete}
setfs gw {<ipaddress>|-delete}
setfs obj [-keepalive {true|false}] [-timeout <secs>] [-maxclients <num>] [rblksize <size>] [-wblksize <size>] [-f]
setfs ldap [-passwd <binddnpwd>] [-schema <schema>] [{-usessl|-usetls} {certfile <file>|-certdata <data>} -certcn <certcn>] <server> <binddn>
<searchbase> <netbios>
setfs ldap -delete [-f]
setfs nodeip -ipaddress <ipaddress> -subnet <subnet> [-vlantag <vlanid>]
<nodeid>
setfs nodeip -delete <nodeid>
setfs bond <bond_mode>
setfs mtu <mtu_size>
setfs idmap <nfsv4domain>
setfs idmap -delete [-f]
setfs rfc2307 [-f] {enable|disable}
setfs smb [-f] [-enableoplocks {true|false}] [-signingenabled {true|false}]
[-signingrequired {true|false}] [-ignorewritethroughrequests {true|false}] [supportpersistenthandles {true|false}] [-smb3dialectenable {true|false}] [enablesmb2ad {true|false}] [-enablesmbleases {true|false}] [-enabledirleases
{true|false}] [-enablesmb2 {true|false}]
setfs usermap [-f] -enable {true|false}
setfs usermap -importconf <file_path_on_client>
setfs usermap -export {users|groups} -provider <provider>
SUBCOMMANDS
ad
Joins or leaves Active Directory domain.
auth
Sets authentication provider settings.
dns
Sets or clears DNS settings.
gw
Sets or deletes Gateway IP address.
obj
Sets Object settings.
ldap
Configures or deletes LDAP configuration.
nodeip
Sets or deletes Node network settings.
326
Set Commands
mtu
Sets the mtu size for all the File Persona nodes.
bond
Sets the bond mode for all the File Persona nodes.
idmap
Sets NFSv4 domain name for NFS ID mapping.
rfc2307
Enables or disables RFC2307 for the Active Directory provider.
smb
Allows setting of tunable parameters for SMB component. At least one parameter needs to be supplied.
Asks for confirmation from user if they want to proceed.
usermap
Configures the user mapping.
AUTHORITY
•
•
Super
Any role granted fs_set right.
OPTIONS
The following options are for the ad subcommand:
•
-passwd <password>
•
Specifies the password of the authorized user. If this is not specified, the user will be prompted for a
clear text password.
-leave
•
Disconnects File Persona nodes from Active Directory domain. If this option is not specified, the
subcommand joins File Persona nodes to active directory domain.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
The following options are for the auth subcommand:
•
<provider> ...
•
Specifies the provider order. Values must be: Ldap, Local, or ActiveDirectory. One provider must be
Local.
-f
•
Specifies that the operation is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-clearcache
Clears name cache of the cluster. This option cannot be used with any other option. This option can be
used in case of any modifications to the external authentication provider such as user deletion or
removal of user from groups.
The following options are for the dns subcommand:
•
<ipaddress-list>
•
Specifies the DNS addresses. The value for ipaddress-list is a comma separated list.
<suffix-list>
Set Commands
327
•
Specifies the DNS suffixes. The value for suffix-list is a comma separated list.
-delete
Clears the DNS settings (addresses and suffixes).
The following options are for the gw subcommand:
•
<ipaddress>
•
Specifies the IP Address for the Gateway.
-delete
Removes the gateway to allow reconfiguration of node addresses to another subnet.
The following options are for the obj subcommand:
•
-keepalive {true|false}
•
Specifies whether persistent connections should be allowed or not for the default Object profile. The
default value is "true".
-timeout <secs>
•
Specifies the timeout value in seconds for the persistent connections for the default Object profile. The
valid range is from 1 to 2592000. The default value is 5 seconds.
-maxclients <num>
•
Specifies the maximum number of simultaneous connections for the default Object profile. The valid
range is from 1 to 128. The default value is 50 connections.
-rblksize <size>
•
Specifies the socket read block size for the default Object profile. The size can be specified with a "K"
or "M" to indicate the unit in kilobyte or megabyte (for example, -rblksize 10K). The valid range is
from 8K to 2048M bytes. The default value is 8K.
-wblksize <size>
•
Specifies the file write block size for the default Object profile. The size can be specified with a "K" or
"M" to indicate the unit in kilobyte or megabyte (for example, -wblksize 1M). The valid range is from
8K to 2047M bytes. The default value is 8K.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
The following options are for the ldap subcommand:
328
•
-passwd <binddnpwd>
•
Specifies the password associated with the bind DN <binddn>.
-schema {posix|samba}
•
Specifies the schema used to create user and group accounts on the LDAP server. If this is not
specified, the default is "posix".
-usetls
•
Indicates to use TLS connection between File Persona nodes and the LDAP server.
-usessl
•
Indicates to use SSL connection between File Persona nodes and the LDAP server.
-certcn <certcn>
•
Specifies the CN or common name used when the certificate is generated, which has to be the fully
qualified hostname of the LDAP server. When option -usetls or -usessl is specified, this option
must be specified.
-certfile <file>
Set Commands
•
Specifies the certificate file name. The command will read certificate from this file. When option usetls or -usessl is specified, this option or -certdata must be specified.
-certdata <data>
•
Specifies the certificate data. When option -usetls or -usessl is specified, this option or certfile must be specified.
-delete
•
Deletes LDAP configuration for File Persona.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
The following options are for the nodeip subcommand:
•
-ipaddress <ipaddress>
•
Specifies the IP Address to be used for the node.
-subnet <subnet>
•
Specifies the subnet mask to be used for the node.
-vlantag <vlanid>
•
Specifies the VLAN tag used for the node. Defaults to 0.
-delete
Deletes a specified node IP.
The following options are for the idmap subcommand:
•
-delete
•
Deletes NFSv4 domain name.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
The following options are for the rfc2307 subcommand:
•
{disable|enable}
•
Specifies if RFC2307 should be disabled or enabled for the "ActiveDirectory" provider. If enabled, the
AD provider expects UIDs and GIDs to be found in the Active Directory and not formulated using the
SID as is the default behavior. This allows users to customize UIDs and GIDs. In the case of rfc2307
being enabled and the user does not have a configured UID/GID, the user is not given write access,
even if granted through an ACL. If this subcommand is not run, the default is "disable".
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
The following options are for the smb subcommand:
•
-enableoplocks {true|false}
•
Enables or disables Oplocks.
-signingenabled {true|false}
•
SMB Signing can be either true or false.
-signingrequired {true|false}
•
If signing is required, set this to true else set this to false.
-ignorewritethroughrequests {true|false}
Set Commands
329
•
Ignores Write-through Requests if this option is set to true.
-supportpersistenthandles {true|false}
•
Enables or disables support for Persistent handles.
-smb3dialectenable {true|false}
•
Enables or disables SMB3 Dialect.
-enablesmb2ad {true|false}
•
Enables or disables SMB2 connections to Active Directory servers only.
-enablesmbleases {true|false}
•
SMB leases can be enabled or disabled by setting this option.
-enabledirleases {true|false}
•
Directory leases are enabled or disabled.
-enablesmb2 {true|false}
•
Enables or disables SMB2 globally for client connections.
-f
Suppresses the confirmation from the user.
The following options are for the usermap subcommand:
•
-enable {true|false}
•
Enables or disables the user mapping. Default is disabled. This option cannot be used with any other
option except -f.
-importconf <filepath_on_client>
•
Imports the user mapping configuration from the file specified on client. This option cannot be used
with any other option except -f.
-export {users|groups}
•
Exports the users/groups entries to a file. If this option is specified, -provider must also be
specified. This option generates a task id. See "showfs -usermap" for the command to copy the
exports file to the client.
-provider {Local|Ldap|ActiveDirectory}
•
Specifies the type of <provider> to be used to export users/groups entries. If this option is specified,
-export must also be specified.
-f
Suppresses the warning message. If this option is not used, the command may require a confirmation
before proceeding with its operation.
SPECIFIERS
The following specifiers are for the ad subcommand:
•
<user>
•
Specifies the authorized user to access Active Directory domain controller.
<domain>
Specifies the domain name of Active Directory which File Persona nodes are to join.
The following specifiers are for the ldap subcommand:
•
330
<server>
Set Commands
•
Specifies the fully qualified hostname or IPv4 address of the LDAP server you want to configure. If
non-standard port is used (i.e., not 389 or 636), the port number must be specified with the server in
the format of <server>:<port>.
<binddn>
•
Specifies the distinguished name (i.e., DN), which will be used to authenticate to the LDAP server to
read data. This account must have privileges to read the subtree specified by <searchbase>. Write
permissions are not required.
<searchbase>
•
Specifies the LDAP base used to search user/group accounts.
<netbios>
Netbios specifies the name of the LDAP Domain. It can be up to 15 alphanumeric characters with no
spaces. The name must be unique on the network. To access an SMB share, you specify
"<netbios>\<ldap-username>" as the user name.
The following specifier is for the idmap subcommand:
•
<nfsv4domain>
Specifies NFSv4 domain name for ID mapping. For NFSv4 to work correctly, the NFSv4 client and the
NFSv4 server need to be in the same NFSv4 domain.
The following specifier is for the mtu subcommand:
•
<mtu_size>
Specifies the size of the MTU for all the File Persona nodes.
The following specifier is for the bond subcommand:
•
<bond_mode>
Specifies the bond mode for all the File Persona nodes.
EXAMPLES
The following examples show usage of setfs command with different subcommands and respective
options:
cli% setfs
cli% setfs
cli% setfs
cli% setfs
cli% setfs
cli% setfs
cli% setfs
cli% setfs
netbios
cli% setfs
cli% setfs
cli% setfs
cli% setfs
cli% setfs
cli% setfs
cli% setfs
ad admin ad.example.com
ad -leave
auth Ldap Local
auth -clearcache
dns 192.168.8.80,127.127.5.50 foo.com,bar.com
gw 10.10.10.10
obj -keepalive false
ldap 1.1.1.1 cn=Manager,dc=example,dc=com dc=example,dc=com
nodeip -ipaddress 10.10.10.11 -subnet 255.255.240.0 0
nodeip -delete 0
mtu 1500
bond 1
idmap example.com
rfc2307 enable
smb -enablesmb2ad true -signingrequired true
The following example enables the user mapping:
cli% setfs usermap -f -enable true
Set Commands
331
The following example imports the user mapping configuration from the file /home/usermap/
mymapping.cfg:
cli% setfs usermap -importconf /home/usermap/mymapping.cfg
The following example exports the ldap user entries to a file:
cli% setfs usermap -export users -provider Ldap
NOTES
Access to all domains is required to run this command.
For the obj subcommand, Object service daemon will be restarted for the change to take effect.
For the auth subcommand, HPE-SMB services will be restarted to change the stacking order, which
causes client I/O errors.
"ActiveDirectory" must be in the provider stacking order to use "setfs ad". After joining Active Directory
domain, the computer names for the nodes will be displayed as "<serial number>-<node ID>" by
Windows "Active Directory Users and Computers". For example, if the CLI "showsys" shows ID "0" and
the serial number "1234567", Windows will display the computer name "1234567-0" for the node.
For the ldap subcommand, if neither option -usessl nor -usetls is specified, the connection between
File Persona nodes and the LDAP server will not be encrypted, and the certificate specified by certfile or -certdata will be ignored.
"Ldap" must be in the provider stacking order to use "setfs ldap".
To use NFSv4, you must run "setfs idmap" to set NFS domain name.
For the usermap subcommand, HPE-SMB services will be restarted to enable/disable the user mapping,
which causes client I/O errors.
The configuration file for -importconf can have maximum of 1024 entries in the format
"domainname1\username1<operator>domainname2\username2" and the number of characters in domain
name must be less than 14 and that of username must be less than 104.
The option -importconf <file_path_on_client> is not available with SSH access to CLI.
The supported operators for -importconf are as follows:
•
•
•
332
=>: Unidirectional replace rule for static mapping. Once the "From" user is authenticated, replaces the
"From" user identity with the "To" user identity. If the "To" user is missing any part of the identity, if the
AD provider is in rfc2307 mode and the UID or primary GID is missing the rule will report a failure
when it is evaluated. If the "To" user is an LDAP user and LDAP is configured to be in POSIX schema,
SID will be synthesized. If the "To" user is an AD user and AD is configured to be in unprovisioned
mode, UID/GID will be synthesized. This type of mapping consolidates cross-protocol access to the
same AD or LDAP account. It assures common access across protocols without duplicating accounts
and group memberships across name services. Bi-directional mapping is not useful in this scenario.
==: Bidirectional join/merge rule for static and dynamic mapping. Joins the native IDs from both the
"From" user and the "To" user. There is no positional relationship based on the rule as it is a
bidirectional rule. If an AD user logs in, the user identity includes the SID for the AD user and UID/GID
of the mapped LDAP user. If an LDAP user logs in, the user identity includes UID/GID of the LDAP
user and SID of the mapped AD user. By using a wildcard for both "From" and "To", instead of a
specific name this rule can be used to support dynamic mapping. For example, *==* would result in
any user from a provider to be mapped to another user with the same name from another provider.
Co-existence of replace rules along with bidirectional rules in the mapping file is not a supported
configuration. Bi directional rules also require group mapping rules. If the group names between both
providers are the same and if the mapping file has a dynamic rule that would address this scenario as
the dynamic mapping rule also applies to groups. However if the group names are not the same
Set Commands
across the providers then there has to be a specific mapping rule for the desired group names. While
the mapping rule for supplemental groups may be added as needed, for a bidirectional mapping to
work, the primary group has to be mapped either through a specific static rule or through dynamic rule.
setfsarchive
DESCRIPTION
The setfsarchive commands are used to set retention policy and retention properties for files in FPG
at VFS or FSTORE level.
SYNTAX
The syntax for the setfsarchive command can be one of the following:
setfsarchive pol [-mode {enterprise|compliance} -defperiod <defaultperiod> minperiod <period> -maxperiod <period> -autocommperiod <period>] [retenvalidation {enable|disable}] [-fstore <fstorename>] [-fpg <fpgname>]
<vfs>
setfsarchive pol_inherit -inheritance {enable|disable} -fstore <fstorename>
[-fpg <fpgname>] <vfs>
setfsarchive legalhold {-set | -clear} [-basepath <basepath>] {-files
<filepath>[,<filepath>]... | -importfile <source_path> | -inputfile
<pathoffile>} -fstore <fstorename> [-fpg <fpgname>] <vfs>
setfsarchive retention [-basepath <basepath>] {-files
<filepath>[,<filepath>]... | -importfile <source_path> | -inputfile
<pathoffile>} -expdate <expirydate> -fstore <fstorename> [-fpg <fpgname>]
<vfs>
SUBCOMMANDS
pol
Configures the retention policy for the FSTORE or VFS in the file provisioning group.
legalhold
Set or release the legal hold for the file(s) specified.
retention
Changes retention expiration date for the specified retained file(s). Retention expiry date can be valid
future date provided in any of the formats as supported by POSIX date command. See the Linux touch(1)
man page under -t for supported time/date formats. The new expiry date should be less than current date
and time plus the maximum retention period specified in the retention policy for the namespace. In case
the expiry date value exceeds the maximum limit, the file retention expiry date will be set to the current
date and time plus max retention period.
pol_inherit
It is used to enable or disable the policy inheritance at the FSTORE level. Policy inheritance can be
disabled only on FSTORE which does not have files and local retention policy.
AUTHORITY
•
•
•
Super, Edit
Any role granted fsarchive_set right.
Super for -importfile <source_path>.
OPTIONS
<period>
setfsarchive
333
When using a period option in the command, a decimal number is optionally followed by one of the
following characters:
•
•
•
•
•
•
•
s (seconds)
m (minutes)
h (hours)
d (days)
w (weeks)
M (months)
y (years)
If no character is specified, the decimal number is interpreted as seconds.
-fpg <fpgname>
Specifies the FPG that contains the VFS. This is required if VFS exists under multiple FPGs.
-fstore <fstorename>
File store name.
-mode {enterprise}
Retention mode.
-defperiod <period>
Default retention period. The valid range is in between minimum and maximum retention period set.
-minperiod <period>
Minimum retention period. The valid range is 2s - 100y.
-maxperiod <period>
Maximum retention period. The valid range is 2s - 100y.
-autocommperiod <period>
Retention auto commit period. The valid range is 5m - 1y. It can be set to 0 to disable autocommit period.
-inheritance {enable|disable}
Enable or disable the policy inheritance.
-basepath <basepath>
Base path of files for which retention settings are to be modified.
-set
Sets the legal hold for the file(s) specified.
-clear
Releases the legal hold for the file(s) specified.
-files <filepath>[,<filepath>]...
Relative path of files from the above base path for which retention settings are to be set or modified. If
basepath is not specified absolute path of the files should be specified.
-inputfile <pathoffile>
Path of the input file containing list of files for which retention setting is to be changed or legal hold is to
be set or released. The input file should be placed in file persona namespace (.admin file store). It should
be absolute path of the input file, which is visible to the file persona namespace. This input file should
contain absolute path of files if basepath is not specified. If basepath is specified, it should be relative
path of the files starting from the basepath.
334
Set Commands
-importfile <source_path>
Path of the input file containing list of files for which retention setting is to be changed or legal hold is to
be set or released. The input file should be present on client machine. The max size of import file can be
up to 2GiB.
-expdate <expirydate>
Retention expiry date can be any valid future date provided in any of the formats as supported by POSIX
touch/date command. See the touch(1) man page documentation for the time/date supported formats.
The new expiry date should be less than current date and time plus the maximum retention period
specified in the retention policy for that namespace. In case the expiry date value exceeds the maximum
limit, the file retention expiry date will be set to the current date and time plus max retention period.
-retenvalidation {enable|disable}
Enable or disable the retention validation scan.
SPECIFIERS
<vfs>
Specifies the name of the VFS.
EXAMPLES
Configures the retention policy for the files in the file provisioning group at VFS or File store level:
cli% setfsarchive pol -mode enterprise -defperiod 5M -minperiod 3d \
-maxperiod 5y -autocommperiod 1h -fstore fstore1 \
-fpg fpg1 vfs1
Sets inheritance of policy at File store level:
cli% setfsarchive pol_inherit -inheritance disable -fstore fstore1 \
-fpg fpg1 vfs1
Sets legal hold for the specified file:
cli% setfsarchive legalhold -set -basepath /fpg1/vfs1
-files fstore1/abcd.txt,fstore2/xyz.txt -fstore fstore1
-fpg fpg1 vfs1
cli% setfsarchive legalhold -set -basepath /fpg1/vfs1
-inputfile /fpg1/vfs1/.admin/abcd.txt -fstore fstore1
-fpg fpg1 vfs1
cli% setfsarchive legalhold -set -importfile /home/worm/file.txt \
-fstore fstore1 -fpg fpg1 vfs1
cli% setfsarchive legalhold -set -importfile /home/worm/file.txt \
-fpg fpg1 vfs1
Releases legal hold for the specified file:
Set Commands
335
cli% setfsarchive legalhold -clear -basepath /fpg1/vfs1
-files fstore1/abcd.txt,fstore2/xyz.txt -fstore fstore1
-fpg fpg1 vfs1
cli% setfsarchive legalhold -clear -basepath /fpg1/vfs1
-inputfile /fpg1/vfs1/.admin/abcd.txt -fstore fstore1
-fpg fpg1 vfs1
Changes the retention expiration date for the specified retained file(s):
cli% setfsarchive retention -basepath /fpg1/vfs1
-files fstore1/abcd.txt,fstore2/xyz.txt -expdate 3years
-fstore fstore1 -fpg fpg1 vfs1
cli% setfsarchive retention -basepath /fpg1/vfs1 \
-inputfile /fpg1/vfs1/.admin/abcd.txt -expdate 3years
-fstore fstore1 -fpg fpg1 vfs1
cli% setfsarchive retention -importfile /home/worm/file.txt \
-expdate 3years -fstore fstore1 -fpg fpg1 vfs1
cli% setfsarchive retention -basepath /fpg1/vfs1 -files 3.txt
-expdate "2016-08-22 22:59:00" -fstore fstore1
-fpg fpg1 vfs1
NOTES
Access to all domains is required to run this command.
For pol subcommand one of -mode, -defperiod, -minperiod, -maxperiod, and autocommperiod or -retenvalidation or both must be specified.
The option -importfile <source_path> is not available with SSH access to CLI.
setfsaudit
DESCRIPTION
The setfsaudit command modifies File Access Audit settings.
SYNTAX
The syntax for the setfsaudit command can be one of the following:
setfsaudit client -type {internal|external} [-fpg <fpgname>] <vfs>
setfsaudit logpol [options] <vfs>
setfsaudit replica -enable {true|false} [-fpg <fpgname>] <vfs>
setfsaudit smb -audit {operation1:value[,operation2:value]...} [-fpg
<fpgname>] <vfs>
setfsaudit user [-delete] [-fpg <fpgname>] <username> <vfs>
setfsaudit log -delete [-fpg <fpgname>] <logfile> <vfs>
336
setfsaudit
SUBCOMMANDS
client
Specifies type of client authorized to consume logs.
logpol
Configure the log policy for defined VFS.
replica
Enables or disables replica of a message queue to another node.
smb
Set global level file access audit configuration for SMB protocol.
user
Adds or removes authorization for a user to access file access audit log messages. The user name is
only applicable when the client type is external.
log
Deletes the specified compressed audit log file.
AUTHORITY
•
•
Super, Edit
Any role granted the fsaudit_set right
OPTIONS
The following options are for all subcommands:
•
-fpg <fpgname>
Specifies the FPG that <vfs> belongs. If this is not specified, the command will determine the FPG
based on the specified <vfs>. However, if <vfs> exists under multiple FPGs, -fpg must be specified.
The following options are specific to the client subcommand:
•
-type {<internal|external>}
Specifies type of client authorized to consume logs. Internal client is an application built to consume
stored logs periodically.
External client is an ISV that will consume File Access Audit logs. Default is internal.
The following options are specific to the logpol subcommand:
•
-size <number>
•
Maximum size of log file to be generated in MBs, Once the log file reaches this size, it will be
compressed. Default is 100MB. The supported size range is between 50 and 500.
-time <number>
•
Maximum time in minutes for which log file to be generated. When the log file is created, time counter
is started. Once it reaches the number specified in -time argument, log file will be compressed. The
supported time range is between 1 and 300.
-retention <number>[m|d|h]
Retention is either a number of logs to keep, or duration in months/days/hours to keep log files. When
the duration is exceeded, the compressed log file is deleted. Auto deletion of log files is disabled by
default.
If only a number is specified, the log file count is "number" (maximum 50). After the specified number
is reached, the oldest log file will be removed.
Set Commands
337
•
Maximum possible values for duration in months/days/hours are 1m/30d/720h respectively. 1 month is
equivalent to 30 days.
-format {proto|xml|json}
Supported log file format. Supported formats are: proto, xml, and json. Default format is json.
The following options are specific to the replica subcommand:
•
-enable {true|false}
Enables or disables the replica of message queue. Replica is disabled by default.
The following options are specific to the smb subcommand:
•
-audit {operation1:value[,operation2:value]...}
Specifies the events to be audited on a global level for SMB protocol on a specified VFS. Supported
operations are logon, logoff and global. Supported values are success, failure, none (No logging), and
all (logging for both success and failure). The operation/values are case insensitive. By default, all
operations are set to "none". Operations are:
◦
logon
Log on (authenticate) to the SMB server.
NOTE:
In case of a logon failure (invalid user/password), the user sid and name will be null and
status = 0.
◦
logoff
Log off from the SMB server.
NOTE:
Changing this setting while a session has already been established (logon) has no effect.
This setting is only evaluated at the beginning of a session.
◦
global
Setting flag to failure allows auditing of TreeConnects to shares that are not defined within the VFS.
NOTE:
Only the failure flag is currently supported.
The following options are specific to the user subcommand:
•
-delete
Delete authorization to access File Access Audit log messages for the specified user.
The following options are specific to the log subcommand:
•
-delete
Deletes the specified compressed audit log file.
SPECIFIERS
The following specifiers are for all subcommands:
•
338
<vfs>
Set Commands
The VFS for which file access audit settings to be modified.
The following specifiers are specific to the user subcommand:
•
<username>
Name of the user to be added/removed for authorization. <username> should either be in NT4
(<domain>\\<user>) or UPN (<user>@<domain>) format.
If the user is configured on Active Directory, use "setfs ad" to join Active Directory domain with
<domain> if it has not been done, and then specify the user.
If the user is configured on the LDAP server, use "setfs ldap" to create LDAP configuration with
<ldap-netbios> if it has not been done, and then specify the user.
For users configured locally, use "LOCAL_CLUSTER" as domain.
NOTE:
Domain name is case sensitive.
The following specifiers are specific to the log subcommand:
•
<logfile>
Name of a compressed audit log file.
EXAMPLES
The following example enables internal client as a consumer for the VFS vfs1:
cli% setfsaudit client -type internal vfs1
The following example enables or overwrites existing file access audit log policy settings for internal client
on specified VFS for a max log file size of 50MB, retention period of seven days and log format as xml:
cli% setfsaudit logpol -size 50 -retention 7d -format xml vfs1
The following example enables replica for vfs1 related audit logs:
cli% setfsaudit replica -enable true -fpg fpg1 vfs1
The following example disables replica for vfs1 related audit logs:
cli% setfsaudit replica -enable false -fpg fpg1 vfs1
The following example enables auditing event on vfs1 for successful logon operation via SMB protocol:
cli% setfsaudit smb -audit logon:success vfs1
The following example authorizes local user user1 to access vfs1 related audit logs:
cli% setfsaudit user user1 vfs1
The following example authorizes AD user user2 to access vfs1 related audit logs:
cli% setfsaudit user "2008ad.lab\\user2" vfs1
Set Commands
339
The following example authorizes LOCAL_CLUSTER user Administrator to access vfs1 related audit logs:
cli% setfsaudit user "Administrator@LOCAL_CLUSTER" vfs1
The following example unauthorizes local user user1 from accessing vfs1 related audit logs:
cli% setfsaudit user -delete user1 vfs1
NOTES
Log policy is created implicitly during VFS creation.
When client is set as external, execution of setfsaudit logpol command will result in error.
When replica is enabled, there will be performance hit on both active and passive FPG nodes.
Whenever log format (e.g., json, xml, or proto) changes, rotation of log file occurs and new log file is
created.
Options -size and -time are mutually exclusive.
To display File access audit settings (such as client type, logpol, replica and authorized user) use
"showfsaudit pol".
setfsav
DESCRIPTION
The setfsav command configures antivirus properties for File Persona.
SYNTAX
The syntax for the setfsav command can be one of the following:
setfsav vse [[+|-]<vselist>]
setfsav pol [-scan {enable|disable|inherit}] [-vendor <vendor_name>] [-fileop
{open|openclose|inherit}] [-unavail {allow|deny|inherit}] [-excludesize
{<size>|inherit}] [-excludeext {<ext>[,<ext>...]|inherit}] [-inheritall] [fpg <fpgname>] [-fstore <fstore>] <vfs>
setfsav quar {exportlist|move|reset|delete|clearcount} [-fpg <fpgname>] [fstore <fstore>] [-quar_file <filepath>] <vfs>
SUBCOMMANDS
vse
Specifies the virus scan engine (VSE).
pol
Specifies the antivirus policies.
quar
Specifies the management of quarantined files. It has following subcommands
exportlist
Export the list of quarantined files to default (.admin/AV/Quarantine in specified VFS) location.
move
Move quarantined files to default location (.admin/AV/Quarantine folder in specified VFS) with timestamp.
reset
340
setfsav
Reset quarantined files under specified virtual file server (VFS)/file store.
delete
Delete quarantined files under specified VFS/file store.
clearcount
Delete AV statistics for a specified VFS.
AUTHORITY
•
•
Super, Edit
Any role granted the fsav_set right
OPTIONS
[+|-]<vselist>
Specifies the IPv4 address and port number of an external VSE. "port" is allowed only while adding
<vselist> to the existing VSE list.
If <vselist> has a prefix:
•
•
+ add <vselist> to the existing VSE list. The "vseip:port" tuple in <vselist> must not be present
in the existing VSE list. It must be specified in the format of:
"<vseip:port>[,<vseip:port>]...".
- remove <vselist> from the existing VSE list. The "vseip" in <vselist> must be present in the
existing VSE list. It must be specified in the format of: "<vseip>[,<vseip>]...".
If <vselist> has no prefix, <vselist> will be used as the new list.
Adding "vseip:port" to an empty VSE list will automatically start the antivirus service.
When the last "vseip" is removed from the list, the antivirus service will be stopped automatically.
-fpg <fpgname>
The name of the file provisioning group (FPG) in which the VFS was created.
-fstore <fstore>
Specifies the file store name.
-inheritall
Inherits all the settings from the VFS for the specified file store, overriding any previous settings in the file
store.
Only valid when -fstore option is specified.
-scan {enable|disable|inherit}
Enables or disables the antivirus scan, or inherits the scan setting from VFS.
If not specified, the default value is disable for VFS, inherit for file store.
-vendor <vendor_name>
Specifies the antivirus vendor name.
Valid values are MCAFEE, SYMANTEC, TRENDMICRO, SOPHOS, or KASPERSKY.
Only valid in VFS context.
-quar_file <filepath>
Specifies the path of file on VFS containing list of quarantined files. The file contains quarantined files,
one per line. This option can only be used with move, reset and delete operations.
-fileop {open|openclose|inherit}
Set Commands
341
Specifies the policy that determines which file operations trigger antivirus scans. The policies are:
•
•
•
open—Scan on file open.
openclose—Scan on file open and file close.
inherit—Inherits the fileop setting from VFS.
If it is not specified, the default is "open" when applied to a VFS, "inherit" when applied to a file store.
-unavail {allow|deny|inherit}
Specifies the scan policy to determine how targeted file operations are handled when an external VSE is
not available.
The policies are:
•
•
•
allow—All operations triggering scans are allowed to run to completion.
deny—All operations triggering scans are blocked and returned with an error.
inherit—Inherits the unavail setting from VFS.
If it is not specified, the default is "allow" when applied to a VFS, "inherit" when applied to a file store.
-excludesize {<size>|inherit}
Excludes all files larger than the specified size (MB). The value of size is an integer from 0 to
2147483647.
If this option is not specified or size is 0, all files will be included in antivirus scan.
If "inherit" is specified, the "excludesize" setting will be inherited from VFS.
-excludeext {<ext>[,<ext>,...]|inherit}
Excludes all files having the specified extension.
If this option is not specified or ext is '', all files will be included in antivirus scan.
If "inherit" is specified, the "excludeext" setting will be inherited from VFS.
SPECIFIERS
<vfs>
The VFS name, using up to 31 characters.
EXAMPLES
The following example shows how to configure VSE IP and port. Antivirus service starts automatically:
cli% setfsav vse 10.2.2.156:9443
The following example shows how to add a new VSE IP and port:
cli% setfsav vse +10.2.2.157:9444
The following example shows how to remove a specific VSE IP:
cli% setfsav vse -10.2.2.156
The following example shows how to configure various antivirus properties for VFS:
cli% setfsav pol -scan enable -vendor SYMANTEC -fileop open
-excludesize 10 -excludeext htm,jpg testvfs
342
Set Commands
-unavail allow
The following example shows how to override VFS antivirus properties "fileop" and "excludesize" into file
store:
cli% setfsav pol -fstore engineering -fileop openclose
testvfs
-excludesize 100
The following example shows how to inherit VFS antivirus properties "fileop" and "excludesize" into file
store:
cli% setfsav pol -fstore engineering -fileop inherit
testvfs
-excludesize inherit
The following example shows how to inherit all of the VFS antivirus properties into file store:
cli% setfsav pol -inheritall -fstore engineering testvfs
The following example shows how to set no exclusion for size in file store:
cli% setfsav pol -fstore engineering -excludesize 0 testvfs
The following example shows how to export list of quarantined filed under unityvfs:
cli% setfsav quar exportlist unityvfs
The following example shows how to move quarantined files under VFS unityvfs:
cli% setfsav quar move unityvfs
The following example shows how to reset quarantined files under file store engineering under VFS
unityvfs:
cli% setfsav quar reset -fstore engineering unityvfs
The following example shows how to delete quarantined files under file store engineering under VFS
unityvfs:
cli% setfsav quar delete -fstore engineering unityvfs
The following example shows how to delete AV statistics for a VFS vfs1:
cli% setfsav quar clearcount vfs1
The following example shows how to move the quarantined files listed in file_move:
cli% setfsav quar move -quar_file .admin/AV/Quarantine/file_move \
unityvfs
The following example shows how to reset the quarantined files listed in file_reset:
cli% setfsav quar reset -quar_file .admin/AV/Quarantine/file_reset \
unityvfs
Set Commands
343
The following example shows how to delete the quarantined files listed in file_delete:
cli% setfsav quar delete -quar_file .admin/AV/Quarantine/file_delete \
unityvfs
NOTES
Access to all domains is required to run this command.
For all options allowing the specification of "inherit": This is only valid when applied to a file store, i.e., in
conjunction with the "-fstore" option.
The following steps need to be followed to manage the quarantined files:
1. Administrator archives the list of quarantined files in <file> by using "setfsav quar
exportlist" option.
2. Administrator evaluates the infected files in <file> and decides what operation to be done (reset,
move, or delete) for each of the quarantined files.
When only "setfsav vse" is specified, it will clear the VSE list.
setfsgroup
DESCRIPTION
The setfsgroup command modifies a local group account.
SYNTAX
setfsgroup [options] <groupname>
AUTHORITY
•
•
Super
Any role granted the fsgroup_set right.
OPTIONS
-memberlist <list>
Specifies user members of the group. It is a set of comma separated strings.
If <list> has a prefix (for example, +user1):
•
•
+ — add <list> to the existing user list. Users in <list> must not be in the existing list.
- — remove <list> from the existing list. Users in <list> must be already in the existing list.
If specified, the prefix will be applied to the entire list.
If <list> has no prefix, <list> will be used as the new user list. If "" is specified user list will be emptied.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation before
proceeding with its operation.
SPECIFIERS
<groupname>
Specifies the local group name using up to 31 characters. Valid characters are alphanumeric characters,
periods, dashes (except first character), and underscores.
EXAMPLES
The following example shows how to add a user jdoe to local group named accounting:
344
setfsgroup
cli% setfsgroup -memberlist +jdoe accounting
NOTES
Access to all domains is required to run this command.
setfshare
DESCRIPTION
The setfshare command modifies File Share properties for supported protocols.
SYNTAX
setfshare {smb|nfs|obj|ftp} [options <arg>] <vfs> <sharename>
SUBCOMMANDS
smb
Sets file share options for SMB.
nfs
Sets file share options for NFS.
obj
Sets file share options for Object.
ftp
Sets file share options for FTP.
AUTHORITY
•
•
Super, Edit
Any role granted the fshare_set right
OPTIONS
The following options are for all subcommands:
•
-acl [+|-]<permlist>
Specifies the ACL permissions that are allowed on a share directory.
This option cannot be used when -mode is used. Setting ACL permissions will break cross protocol
functionality and may cause loss of modebits information. A warning prompt is displayed to the users
asking if they wish to proceed.
The <permlist> contains the list of ACEs. Use commas to separate ACEs.
Each ACE contains four values named type, flag, principal and permissions.
These four values should be separated by ":".
◦
Example: A:fd:OWNER@:rwax,A:fdg:GROUP@:rwax
If <permlist> has a prefix (for example: +A:fd:OWNER@:rwa,A:g:GROUP@:rwxa,.):
◦
◦
+ — add <permlist> to the existing permlist. The ACEs in <permlist> may be present in the existing
list. The new <permlist> is inserted at the head of the existing ACL, in the same order specified.
- — remove <permlist> from the existing list. The ACEs in <permlist> must be already in the
existing list. The first matching entry will be removed.
setfshare
345
If specified, the prefix will be applied to the entire <permlist>.
If <permlist> has no prefix, it will be used as the new permlist.
The values for <permlist> fields type:flag:principal:permissions will be as follows.
Duplicate ACEs are allowed. The order specified for the ACEs will be maintained.
The "type" field can take only one of the following values:
◦
◦
◦
◦
A—allow
D—deny
U—audit
L—alarm
The "flags" is optional and can take one or more of the following values:
◦
◦
◦
◦
◦
◦
◦
f—file-inherit
d—directory-inherit
p—no-propagate-inherit
i—inherit-only
S—successful-access
F—failed-access
g—group (denotes that <principal> is a group)
The "principal" field can be any named user or group or one of the following values:
◦
◦
◦
OWNER@
GROUP@
EVERYONE@
The "permissions" field can take one or more of the following values:
•
◦ r—read-data | list-directory
◦ w—write-data | create-file
◦ a—append-data | create-subdirectory
◦ x—execute
◦ d—delete
◦ D—delete-child (directories only)
◦ t—read-attrs
◦ T—write-attrs
◦ n—read-named-attrs
◦ N—write-named-attrs
◦ c—read-ACL
◦ C—write-ACL
◦ o—write-owner
◦ y—synchronize
-mode <modebits>
Specifies the modebits permissions that are allowed on a share directory.
This option cannot be used when -acl is used. Setting mode bits will break cross protocol
functionality and may cause loss of ACL information.
•
A warning prompt is displayed to the users asking if they wish to proceed.
-owner <name>
Specifies the name of the owner to which the share directory belongs.
346
Set Commands
If the owner is configured on Active Directory, use "setfs ad" to join Active Directory domain with
<domain> if it has not been done, and use "<domain>\\<uname>" or "<ad-netbios>\\<uname>" to
specify the owner (for example, -owner example.com\aduser).
The "<ad-netbios>" is Active Directory NetBIOS name, which can be found by running "showfs -ad".
•
If the owner is configured on the LDAP server, use "setfs ldap" to create LDAP configuration with
<ldap-netbios> if it has not been done, and use "<ldap-netbios>\\<owner>" to specify the owner (for
example, -owner ldaphost\\ldapuser). The "<ldap-netbios>" is the LDAP server NetBIOS
name, which can be found by running "showfs -ldap".
-group <name>
Specifies the name of the group to which the share directory belongs.
If the group is configured on Active Directory, use "setfs ad" to join Active Directory domain with
<domain> if it has not been done, and use "<domain>\\<gname>" or "<ad-netbios>\\<uname>" to
specify the user (for example, -group example.com\adgroup).
The <ad-netbios> is Active Directory NetBIOS name, which can be found by running "showfs -ad".
•
If the group is configured on the LDAP server, use "setfs ldap" to create LDAP configuration with
<ldap-netbios> if it has not been done, and use "<ldap-netbios>\\<gname>" to specify the user (for
example, -group ldaphost\\ldapgroup).
-f
•
This option specifies that the command is forced. When setting ACL permissions or modebits of a
share directory, if this option is not used, the command requires confirmation before proceeding with
its operation.
-fpg <fpgname>
Specifies the file provisioning group (FPG) that <vfs> belongs. If this is not specified, the command will
find out the FPG based on the specified <vfs>.
•
However, if <vfs> exists under multiple FPGs, -fpg must be specified.
-fstore <fstore>
Specifies the file store that the share to be modified belongs.
•
If this is not specified, the <sharename> will be used as the file store name to identify the share.
-comment <comment>
Specifies any comments or additional information for the share. The comment can be up to 255
characters long. Unprintable characters are not allowed.
The following options are specific to the smb subcommand:
•
-abe {true|false}
•
Access Based Enumeration. Specifies if users can see only the files and directories to which they
have been allowed access on the shares.
-allowip [+|-]<iplist>
Specifies client IP addresses that are allowed access to the share. Use commas to separate the IP
addresses. If <iplist> has a prefix (for example: +1.1.1.0,2.2.2.0):
◦
◦
•
+ — add <iplist> to the existing allowed list. The IP addresses in <iplist> must not be in the existing
allowed list.
- — remove <iplist> from the existing allowed list. The IP addresses in <iplist> must be already in
the existing allowed list.
If specified, the prefix will be applied to the entire <iplist>. If <iplist> has no prefix, <iplist> will be used
as the new allowed list.
-denyip [+|-]<iplist>
Set Commands
347
Specifies client IP addresses that are denied access to the share. Use commas to separate the IP
addresses. If <iplist> has a prefix (for example: +1.1.1.0,2.2.2.0):
◦
◦
•
+ — add <iplist> to the existing denied list. The IP addresses in <iplist> must not be in the existing
denied list.
- — remove <iplist> from the existing denied list. The IP addresses in <iplist> must already be in
the existing denied list.
If specified, the prefix will be applied to the entire <iplist>. If <iplist> has no prefix, <iplist> will be used
as the new denied list.
-allowperm [+|-|=]<permlist>
Specifies the permissions that users/groups are allowed to access the share. <permlist> must be
specified in the format of: "<user1>:<perm1>,<user2>:<perm2>,...". The <user> can be a user or
group name specified using the same format as described in createfshare. <perm> must be
"fullcontrol", "read", or "change".
If <permlist> has a prefix (for example: +Everyone:read):
◦
◦
◦
•
+ — add <permlist> to the existing allowed list. Users/groups in <permlist> must not be in the
existing allowed list.
- — remove <permlist> from the existing allowed list. Users/groups in <permlist> must be already
in the existing allowed list.
= — modify the existing allowed list with <permlist>. Users/groups in <permlist> must be already in
the existing allowed list.
If specified, the prefix will be applied to the entire <permlist>. If <permlist> has no prefix, <permlist>
will be used as the new allowed list.
-denyperm [+|-|=]<permlist>
Specifies the permissions that users/groups are denied to access the share. <permlist> must be
specified in the format of: "<user1>:<perm1>,<user2>:<perm2>,...". The <user> can be a user or
group name specified using the same format as described in createfshare. <perm> must be
"fullcontrol", "read", or "change".
If <permlist> has a prefix (for example, +Everyone:read):
◦
◦
◦
•
+ — add <permlist> to the existing denied list. Users/groups in <permlist> must not be in the
existing denied list.
- — remove <permlist> from the existing denied list. Users/groups in <permlist> must be already in
the existing denied list.
= — modify the existing denied list with <permlist>. Users/groups set in <permlist> must be already
in the existing denied list.
If specified, the prefix will be applied to the entire <permlist>. If <permlist> has no prefix, <permlist>
will be used as the new denied list.
-audit {operation1:value1[,operation2:value2]...}
Specifies the operations to be audited at share level for SMB protocol on specified VFS. The specified
operations will be modified and all the operations that are not specified will be set to default values.
Supported operations are mentioned below. The event can be audited based on operations: success,
failure, none or all outcome. The operation/values are case insensitive.
The operations listed below will generate events when:
◦
◦
348
TreeConnect—Connected to a share. To create an audit record for a user trying to access a share
that is not configured on the VFS, use the command: "setfsaudit smb -audit
Global:failure".
TreeDisconnect—Disconnected from a share.
Set Commands
NOTE:
Certain clients that use SMBv1 may not trigger a TreeDisconnect when the client logs off.
◦
◦
◦
◦
◦
◦
◦
•
Open—Open/Create a file or directory.
Close—Close a file or directory.
Rename—Rename a file or directory.
Delete—Delete a file or directory.
Read—Read from a file. Only the first read after the file was opened is reported.
Write—Write to a file. Only the first write after the file was opened is reported.
ChangeSecurity—Change security attributes.
For more details, see the File Persona User Guide.
-cache {off|manual|optimized|auto}
Specifies client-side caching for offline files. Valid values are:
◦
•
"off"—The client must not cache any files from this share. The share is configured to disallow
caching.
◦ "manual"—The client must allow only manual caching for the files open from this share.
◦ "optimized": The client may cache every file that it opens from this share. Also, the client may
satisfy the file requests from its local cache. The share is configured to allow automatic caching of
programs and documents.
◦ "auto"—The client may cache every file that it opens from this share. The share is configured to
allow automatic caching of documents.
-ca {true|false}
Specifies if SMB3 continuous availability features should be enabled for this share.
The following options are specific to the nfs subcommand:
•
-options <options>
Specifies the new options to use for the share. This completely overwrites the options you set
previously. Standard NFS export options except "no_subtree_check" are supported. Do not enter
option "fsid", which is provided. If not specified, the following options will be automatically set: sync,
auth_nlm, wdelay, sec=sys, no_all_squash, crossmnt, secure, subtree_check, hide, root_squash, ro.
In addition to the above options, below audit operations are also supported for NFS protocol on
specified VFS. The following options do not have values.
The operations listed below will generate events when:
◦
◦
◦
◦
◦
◦
audit_open—Open a file. This is NFSv4 only.
audit_close—Close a file. This is NFSv4 only.
audit_meta—Rename a file or directory, creating a hardlink for a file, creating a file or directory and
removing a file or a directory.
audit_attr—Changing file/directory attributes.
audit_read—Read of a file/directory. Subsequent file reads are suppressed for a specific time
(currently 10m). Note, reads from a directory are never suppressed.
audit_write—Write to a file. Subsequent writes are suppressed for a specific time (currently 10m).
For more details, see the File Persona User Guide.
•
See linux exports(5) man page for detailed information on valid options.
-clientip [+|-]<iplist>
Specifies the clients that can access the share. The NFS client can be specified by the name (for
example, sys1.example.com), the name with a wildcard (for example, *.example.com), or by its IP
address. Use comma to separate the IP addresses.
If <iplist> has a prefix (for example, +1.1.1.0,2.2.2.0):
Set Commands
349
◦
◦
+ — add <iplist> to the existing list. IP addresses in <iplist> must not be in the existing list.
- — remove <iplist> from the existing list. IP addresses in <iplist> must be already in the existing
list.
If specified, the prefix will be applied to the entire <iplist>. If <iplist> has no prefix, <iplist> will be used
as the new list.
The following options are specific to the obj subcommand:
•
-ssl {true|false}
Specifies to enable or disable SSL.
The following options are specific to the ftp subcommand:
•
-options [+]<options>
Specifies the configuration options to be modified for the FTP share. Options must be in the format of
option1=value1[,option2=value2].... If no prefix is specified, the specified options will be modified and
all the options that are not specified will be set to default values. If prefix "+" is specified only the
specified values will be modified. Setting options to "" will set all the values to default.
•
See <options> under "createfshare ftp" for supported values.
-ssl {true|false}
•
Specifies to enable or disable SSL.
-shareip [+|-]<iplist>
This option is used to add, remove or overwrite IP addresses of the FTP share. To add/overwrite, the
IPs mentioned in the <iplist> must be assigned to the specified VFS. Use commas to separate the IP
addresses.
If <iplist> has a prefix (for example, +1.1.1.0,2.2.2.0):
◦
◦
+ — add <iplist> to the existing list. IP addresses in <iplist> must not be in the existing list.
- — remove <iplist> from the existing list. IP addresses in <iplist> must be already in the existing
list.
If no prefix is specified it overwrites the existing IP list with the specified <iplist>. If specified, the prefix
will be applied to the entire <iplist>.
SPECIFIERS
<vfs>
Specifies the virtual file server (VFS) that the share to be modified belongs.
<sharename>
Specifies the name of the share to be modified.
EXAMPLES
The following example allows the host with IP address "100.1.1.1" to access SMB file share "myshare":
cli% setfshare smb -allowip 100.1.1.1 -fstore myfstore myvfs myshare
The following example modifies options of NFS file share with export path /<myfpg>/myvfs/myfstore to
become "rw", where <myfpg> is the file provisioning group that myvfs belongs:
cli% setfshare nfs -options rw -fstore myfstore myvfs myshare
The following example changes the Object share "myshare" to enable SSL:
350
Set Commands
cli% setfshare obj -ssl true -fstore myfstore myvfs myshare
The following example sets ACL permissions and owner name on NFS file share "myshare":
cli% setfshare nfs -acl +A:fd:OWNER@:rwax -owner user1 -fstore \
myfstore myvfs myshare
The following example sets NFS share myshare with auditing option for open, close operation via NFS
protocol:
cli% setfshare nfs -options audit_open,audit_close -fstore myfstore \
myvfs myshare
The following example sets modebits and group name on SMB file share "myshare":
cli% setfshare smb -mode 755 -group group1 -fstore myfstore myvfs \
myshare
The following example sets owner and group on OBJ file share "myshare":
cli% setfshare obj -owner user1 -group group1 -fstore myfstore myvfs myshare
The following example adds IP 1.1.1.1 to FTP file share "myshare":
cli% setfshare ftp -shareip +1.1.1.1 -fstore myfstore myvfs myshare
The following example disables ssl on FTP file share "myshare":
cli% setfshare ftp -ssl false -fstore myfstore myvfs myshare
The following example modifies the option "anon_other_write_enable" to "yes" and resets all other
options to default, on FTP file share "myshare":
cli% setfshare ftp -options anon_other_write_enable=yes -fstore \
myfstore myvfs myshare
The following example modifies the option "anon_other_write_enable" to "yes" and leaves all other
options as they are on FTP file share "myshare":
cli% setfshare ftp -options +anon_other_write_enable=yes -fstore \
myfstore myvfs myshare
The following example modifies SMB share share1 with auditing enabled for successful TreeConnect
operation via SMB protocol:
cli% setfshare smb -audit TreeConnect:success vfs1 share1
NOTES
Access to all domains is required to run this command.
Set Commands
351
For setting SMB permissions, the same user cannot be specified with the same permission in both
"allowperm" and "denyperm".
setfsip
DESCRIPTION
The setfsip command modifies the network config of a virtual file server (VFS).
SYNTAX
setfsip [options] <vfs> <id|ip>
AUTHORITY
•
•
Super, Edit
Any role granted the fsip_set right
OPTIONS
-vlantag <tag>
Specifies the VLAN Tag to be used.
-ip <ipaddr>
Specifies the new IP address.
-subnet <subnet>
Specifies the new subnet mask.
-fpg <fpgname>
Specifies the file provisioning group (FPG) in which the VFS was created.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation before
proceeding with its operation.
SPECIFIERS
<id|ip>
Specifies the ID/IP for the network config.
<vfs>
Specifies the VFS which is to have its network config modified.
EXAMPLES
The following example modifies the subnet mask to 255.255.255.254 of VFS vfs_1:
cli% setfsip -subnet 255.255.255.254 vfs_1 12345678
cli% setfsip -subnet 255.255.255.254 vfs_1 10.10.10.1
NOTES
Access to all domains is required to run this command.
setfsndmp
DESCRIPTION
352
setfsip
The setfsndmp command configures NDMP properties for file persona like DMA, VTL and session
cancellation. When no option is specified after setfsndmp command, it is an error scenario.
SYNTAX
The syntax for the setfsndmp command can be one of the following:
setfsndmp conf
•
•
•
•
[-dma [+|-]<dma_ip_list>] [-username <username>]
[-passwd <password>] [-enable_sessions {false|true}]
[-loglevel <level>] [-tcpwinsize <bytes>]
[-maxsessions <numsessions>]
setfsndmp vtl [-force] [+|-]<vtliplist>
setfsndmp sessions -cancel <session_list>
SUBCOMMANDS
conf
Configures NDMP parameters on the cluster.
vtl
Discover and add a target VTL device with the specified IP to the Unity Cluster. It can also be used to
delete an already added target VTL device.
sessions -cancel
Cancels NDMP sessions specified with session IDs.
AUTHORITY
•
•
Super, Edit
Any role granted the fsndmp_set right
OPTIONS
The following options are specific to the conf subcommand:
[-dma [+|-]<dma_ip_list>] [-username <username>]
[-passwd <password>] [-enable_sessions {false|true}]
[-loglevel <level>] [-tcpwinsize <bytes>]
[-maxsessions <numsessions>]
Specifies DMA . At least one of the parameters should be given after subcommand "conf" to modify the
DMA configuration.
•
-dma
Valid IP address of the DMA machine.
◦
+<dma_ip_list>
◦
add dma IP to the existing configuration.
-<dma_ip_list>
•
remove dma IP from the existing configuration.
-username
•
Username to be verified while connecting from the DMA.
-passwd
Password to be verified while connecting from the DMA.
Set Commands
353
•
-enable_sessions true | false
(case insensitive)
◦ false—No further NDMP sessions will be allowed
◦ true—Allow further NDMP sessions.
-loglevel
•
Sets the NDMP trace log level. Range from 0 to 10
◦ 10—represents the most logging
◦ 0—represents only critical logs and error messages
-tcpwinsize
•
Sets the TCP window size for NDMP data transfer.
Range from 65534 - 163840
-maxsessions
•
Sets the maximum number of concurrent sessions per NDMP server.
Range from 1 - 128
vtl [-force] [+|-]<vtliplist>
Discover and add or remove target VTL device with the specified IP to or from the Unity Cluster. VTL
devices are added to the cluster list even if target VTL device is not discovered.
•
+<vtliplist>
•
discover and add VTL IP to the unity cluster list.
-<vtliplist>
remove the VTL IP from the list.
-force -<vtliplist>
forcefully remove the VTL IP from the list.
sessions -cancel <session_list>
Cancels NDMP sessions specified with session IDs.
SPECIFIERS
None.
EXAMPLES
The following example shows how to configure NDMP parameters on the cluster:
cli% setfsndmp conf -dma +1.2.3.4,4.5.6.7 -username ndmp
-passwd ndmp -enable_sessions true -loglevel 5
-tcpwinsize 163840 -maxsessions 128
The following example shows how to discover and add/remove target vtl device with the specified IP to
the Unity Cluster:
cli% setfsndmp vtl +1.2.3.4,4.5.6.7
cli% setfsndmp vtl -4.5.6.7
cli% setfsndmp vtl -force -1.2.3.4
354
Set Commands
The following example cancels NDMP sessions specified with session IDs:
cli% setfsndmp sessions -cancel 34545,6766
NOTES
Access to all domains is required to run this command.
If no option is specified after setfsndmp, help will be displayed as it is an error case.
setfsndmp -conf <parameters> configures NDMP parameters on the cluster.
VTL IPs can be modified by using vtl subcommand and NDMP sessions can be cancelled by using
sessions -cancel subcommand.
setfsnetwork
DESCRIPTION
The setfsnetwork command modifies the configuration for a given network.
SYNTAX
setfsnetwork [-f] [-ports [+|-]N:S:P,.] [-comment <text>] <name>
AUTHORITY
•
•
Super
Any role granted the fsnetwork_set right
OPTIONS
-f
Suppress the confirmation message displayed to the user before modifying any network configuration.
-port +|- N:S:P,..
Defines the N:S:P to be modified for the given network. This adds, removes, or replaces the port set
depending upon the prefix given.
-comment <text>
Modifies the description for the given network.
SPECIFIERS
<name>
Name of the network whose configuration is to be modified. The network names "cluster" and "user"
(default networks) cannot be modified.
EXAMPLES
The following example modifies the ports for the given network:
cli% setfsnetwork -ports +1:2:1,1:3:1 user1
The following example modifies the description for the given network:
cli% setfsnetwork -f -comment 'testing network' user1
NOTES
setfsnetwork
355
Access to all domains is required to run this command.
setfsquota
DESCRIPTION
The setfsquota command modifies the quotas for a given virtual file server (VFS).
SYNTAX
setfsquota [options] <vfsname>
AUTHORITY
•
•
Super, Edit.
Any role granted fsquota_set right.
OPTIONS
-fpg <fpgname>
Specifies the name of the file provisioning group (FPG) hosting the VFS.
-username <uname>
The username of the quotas to be modified.
If the user is configured on Active Directory, use "setfs ad" to join Active Directory domain with <domain>
if it has not been done, and use "<domain>\\<uname>" or "<ad-netbios>\\<uname>" to specify the user
(for example, -username example.com\aduser).
The "<ad-netbios>" is Active Directory NetBIOS name, which can be found by running "showfs -ad".
If the user is configured on the LDAP server, use "setfs ldap" to create LDAP configuration with <ldapnetbios> if it has not been done, and use "<ldap-netbios>\\<username>" to specify the user (for example,
-username ldaphost\\ldapuser). The "<ldap-netbios>" is the LDAP server NetBIOS name, which can be
found by running "showfs -ldap".
-groupname <gname>
The groupname of the quotas to be modified.
If the group is configured on Active Directory, use "setfs ad" to join Active Directory domain with
<domain> if it has not been done, and use "<domain>\\<gname>" or "<ad-netbios>\\<uname>" to specify
the user (for example, -groupname example.com\adgroup).
The <ad-netbios> is Active Directory NetBIOS name, which can be found by running "showfs -ad".
If the group is configured on the LDAP server, use "setfs ldap" to create LDAP configuration with <ldapnetbios> if it has not been done, and use "<ldap-netbios>\\<gname>" to specify the user (for example, groupname ldaphost\\ldapgroup).
-uid <uid>
The user id of the quotas to be deleted. This is supported only with -clear. Options -uid, -gid, -username
and -groupname are mutually exclusive.
-gid <gid>
The group id of the quotas to be deleted. This is supported only with -clear. Options -uid, -gid, -username
and-groupname are mutually exclusive.
-fstore <fstore>
The file store to which you wish to apply quotas.
-scapacity <soft capacity limit>
356
setfsquota
An integer value in MiB for the soft capacity storage quota. The maximum value is the maximum size
supported by FPG in MiB. 0 - No quota
-hcapacity <hard capacity limit>
An integer value in MiB for the hard capacity storage quota. The maximum value is the maximum size
supported by FPG in MiB. 0 - No quota
-sfile <soft file limit>
An integer limit of the number of files for the soft file quota. The maximum value is 250000000. 0 - No
quota
-hfile <hard file limit>
An integer limit of the number of files for the hard file quota. The maximum value is 250000000. 0 - No
quota
-clear
Clears the quotas of the specified object.
-archive
Stores the quota information associated with the VFS in a file.
-restore <file>
Applies the quota information stored in the file to the VFS.
SPECIFIERS
<vfsname>
Specifies the name of the VFS associated with the quotas.
EXAMPLES
The following example sets the quotas for group gExample to 1024MB soft and 2048MB hard:
cli% setfsquota -groupname gExample -scapacity 1024 -hcapacity 2048 \
-sfile 1024 -hfile 2048 examplevfs
The following example deletes the quotas for user with uid 11001:
cli% setfsquota -uid 11001 -clear examplevfs
The following example restores a set of quotas for the examplevfs VFS:
cli% setfsquota -restore /examplefpg/examplevfs/.admin/Quotas/
quotas_examplefpg_examplevfs.exports examplevfs
NOTES
Access to all domains is required to run this command.
Only one set of quotas may be specified per call.
Set Commands
357
setfsroute
DESCRIPTION
The setfsroute command modifies a route for a target identified with either route id or a unique
combination of target address, vlantag and subnet mask. Currently only gateway can be modified. A
warning is displayed to user before modifying the route.
SYNTAX
setfsroute modifygw [-f] {<targetaddr>,{<subnetmask>|<prefixlen>},<vlantag> |
<routeidentifier>} <gateway>
SUBCOMMANDS
modifygw
Modifies the gateway of the route specified.
AUTHORITY
•
•
Edit
Any role granted fsroute_set right.
OPTIONS
-f
Suppresses confirmation from user before modifying the route.
SPECIFIERS
<targetaddr>
The target IPv4/IPv6 address of the route to be modified.
<subnetmask>|<prefixlen>
The subnet mask or prefix length for the target IP Address.
<vlantag>
The VLAN tag associated with the route to be modified.
<routeidentifier>
Instead of providing a combination of targetaddr,subnetmask|prefixlen and vlantag, a route identifier can
be provided. Obtain the route identifier from the "showfsroute -d" command.
<gateway>
New gateway to be assigned to the target IP address.
EXAMPLES
The following example modifies a route with following details:
cli% setfsroute modifygw 10.16.23.101,16,8 10.16.23.1
The following example modifies a route without confirmation:
cli% setfsroute modifygw -f 10.16.23.101,255.255.192.0,12 10.16.23.1
358
setfsroute
The following example modifies a route with specified route ID:
cli% setfsroute modifygw staticRoute4e426403-98a7-4025-9b11-ca59afd9971c
10.16.23.1
NOTES
Access to all domains is required to run this command.
setfstore
DESCRIPTION
Allows modification of the specified file store.
SYNTAX
setfstore [options] <vfs> <fstore>
AUTHORITY
•
•
Super, Edit
Any role granted fstore_set right.
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
-comment <comment>
Specifies any addition textual information.
-fpg <fpgname>
The name of the parent file provisioning group (FPG).
-secop_errsuppress {true|false}
Enables or disables the security operations error suppression for file stores in "ntfs" security mode. In
"ntfs" security mode, permission changing operations will report error messages for non-root users when secop_errsuppress is "false". This may not be the ideal behavior for some applications trying to implicitly
perform a permission changing operation such as "chmod" over an NFSv3 client. This tunable can be set
to "true" to allow those applications to work with NFSv3 clients. This option cannot be used for file stores
in "legacy" security mode.
-secmode ntfs
Specifies the security mode of the file store. Security mode of a file store can be changed to NTFS from
LEGACY. Valid values are:
•
ntfs
Windows and non-Windows clients can create/read/write/delete/ rename file objects (files and
directories). Permissions on new file objects will be based on NTFS inheritance rules. Windows clients
can view and set permissions (Windows ACLs). Non-windows clients can view permissions, but
cannot modify them (change of ownership, group, mode bits or POSIX ACLs are not permitted).
SPECIFIERS
<vfs>
The name of the containing virtual file server (VFS).
setfstore
359
<fstore>
The name of the file store to be modified.
EXAMPLES
The following example sets the comment string for the specified file store:
cli$ setfstore -comment "Example comment string." -fpg fpg1 vfs1
examplefstore
The following example modifies the security operation error suppression tunable to "true":
cli$ setfstore -secop_errsuppress "true" vfs1 examplefstore
NOTES
Access to all domains is required to run this command.
setfsuser
DESCRIPTION
The setfsuser command modifies a local user account associated with File Persona.
SYNTAX
setfsuser [options] <username>
AUTHORITY
•
•
Super
Any role granted the fsuser_set right
OPTIONS
-primarygroup <groupname>
Specifies the user's primary group.
-passwd <password>
Specifies the user's password. The -passwd option and -passprompt option are mutually exclusive
options.
-passprompt
Indicates a password prompt request to enter password. The -passwd option and -passprompt option are
mutually exclusive options.
-enable {true|false}
Specifies if the user is enabled or not.
-grplist <list>
Specifies a list of additional groups which the user is to be a member. It is a set of comma separated
strings.
If <list> has a prefix (for example, +group1):
360
•
+
•
add <list> to the existing group list. Groups in <list> must not be in the existing list.
-
setfsuser
remove <list> from the existing list. Groups in <list> must be already in the existing list.
If specified, the prefix will be applied to the entire list.
If <list> has no prefix, <list> will be used as the new group list. If "" is specified the group list will be
emptied.
-f
Specifies that the operation is forced. If this option is not used, the command requires confirmation before
proceeding with its operation.
SPECIFIERS
<username>
Specifies the local user name using up to 31 characters. Valid characters are alphanumeric characters,
periods, dashes (except first character), and underscores.
EXAMPLES
The following example modifies a local user named jdoe:
cli% setfsuser -primarygroup finance jdoe
NOTES
Access to all domains is required to run this command.
User's primary group cannot be Built-in groups:
"Administrators", "Users", "Guests" and "Backup Operators".
sethost
DESCRIPTION
The sethost command sets properties on existing system hosts, including options to annotate a host
with descriptor information such as physical location, IP Address, Operating System, Model, etc. The
command also provides the ability to configure or remove iSCSI CHAP authentication information and to
reset a host, aborting all its pending I/O.
SYNTAX
sethost [options <arg>] <hostname>
sethost initchap [-f] [options <arg>] <secret> {<hostname> | <pattern> ...}
sethost targetchap [-f] [options <arg>] <secret> {<hostname> | <pattern> ...}
sethost removechap [-target] [-f] {<hostname> | <pattern> ...}
sethost clearagent <WWN | iscsi_name>
sethost rst <hostname>
sethost rst -wwn <WWN> <node:slot:port>
sethost rst -iscsi_name <iscsi_name> <node:slot:port>
SUBCOMMANDS
initchap
Sets the initiator CHAP authentication information on one or more hosts.
targetchap
sethost
361
Sets the target CHAP authentication information on one or more hosts
removechap
Remove CHAP authentication on one or more hosts. By default, this removes all CHAP information for all
specified hosts. Using this subcommand with the -target option removes only target CHAP information.
clearagent
Clear any host agent data associated with the host.
rst
Reset a host or host initiator, aborting all pending commands from the host initiator(s) and releasing any
SCSI-2 reservations held by the initiator(s).
AUTHORITY
•
•
Super, Edit
Any role granted the host_set right
OPTIONS
-loc <location>
Specifies the location of the host.
-ip <IP address>
Specifies the IP address of the host.
-os <OS>
Specifies the operating system running on the host.
-model <model>
Specifies the model of the host.
-contact <contact>
Specifies the contact information for the host.
-comment <comment>
Specifies any additional information for the host.
-name <hostname>
Specifies the new name of the host up to 31 characters in length.
-persona <hostpersonaval>
Sets the host persona that specifies the personality for all ports which are part of the host set. This
selects certain variations in scsi command behavior which certain operating systems expect.
<hostpersonaval> is the host persona id number with the desired capabilities. These can be seen with
showhost -listpersona.
The following options are for use with the initchap and targetchap subcommands:
-f
Do not ask for confirmation before performing the operation.
-chapname <chapname>
Used to specify the initiator or target CHAP name. If this option is not specified, then the initiator CHAP
name defaults to the host name and the target CHAP name defaults to the HPE 3PAR System name.
-hex
The CHAP secret is treated as a hex number.
362
Set Commands
The following options are for use with the removechap subcommand:
-target
Removes only the target CHAP authentication.
SPECIFIERS
<hostname>
Name of the host up to 31 characters in length.
<pattern>
Specifies that properties are set for all hosts matching the specified pattern.
<secret>
The CHAP secret for the host or the target. If -hex is specified, it is treated as a hex number. Otherwise it
should be a printable ASCII string 12 to 16 characters in length with no spaces, or 16 bytes in HEX.
<WWN | iscsi_name>
The World Wide Name (WWN) or iSCSI name of the host which should be reset or for which host agent
data should be cleared.
<node:slot:port>
•
node
•
Specifies the node using a number from 0 through 7.
slot
Specifies the PCI slot in the specified node. Valid ranges are:
0 - 9 for the HPE 3PAR 10000 storage system platform.
0 - 3 for the HPE 3PAR 7200 and HPE 3PAR 7400 storage system platforms.
•
0 - 3 for the HPE 3PAR 8200 and HPE 3PAR 8400 storage system platforms.
port
Specifies the port using a number from 1 through 4.
EXAMPLES
The following examples change the settings of a host:
cli%
cli%
cli%
cli%
cli%
cli%
cli%
sethost
sethost
sethost
sethost
sethost
sethost
sethost
-contact "Joe Smith" -model "Sun Ultra 60" queasy10
initchap "MyChapSecret" queasy10
targetchap -hex "30313233343536373839303132333435" queasy10
removechap -target queasy10
clearagent 210100E08B32A58A
-persona 1 queasy10
rst -wwn 210100E08B32A58A 0:2:3
NOTES
Access to all domains is required for the clearagent subcommand.
The CHAP configuration operations are applied to all hosts whose names match one or more of the
specified <hostname> or <pattern>. The patterns are treated as glob-style (shell-style) patterns. (For
more information, issue "clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
The options that allow for adding descriptor information are for annotation purposes only; the information
provided here is not actively used by the storage server.
Set Commands
363
Remove a descriptor by passing an empty string to the command.
Verify modification of host properties by issuing the showhost on page 471 command.
sethostset
DESCRIPTION
The sethostset command sets the parameters and modifies the properties of a host set.
SYNTAX
sethostset [options <arg>] <setname>
AUTHORITY
•
•
•
Super, Edit
Any role granted the hostset_annotate right can only annotate the comment of a host set
Any role granted the hostset_set right can set any host set property
OPTIONS
-comment <comment>
Specifies any comment or additional information for the set. The comment can be up to 255 characters
long. Unprintable characters are not allowed.
-name <newname>
Specifies a new name for the host set, using up to 27 characters in length.
SPECIFIERS
<setname>
Specifies the name of the host set to modify.
EXAMPLES
The following example shows how to rename a set from foo to bar:
cli% sethostset -name bar foo
The following example shows how to change the comment on a set:
cli% sethostset -comment "This used to be set foo" bar
NOTES
None.
setlicense
DESCRIPTION
The setlicense command sets the license key information.
SYNTAX
setlicense [options <arg>]
364
sethostset
AUTHORITY
•
•
Super, Service
Any role granted the license_set right
OPTIONS
-f <filename>
Specifies the file from which the license key is read.
-noconfirm
Specifies that the system does not prompt for confirmation for the new license key.
SPECIFIERS
None.
EXAMPLES
The following example displays the setting of a license key:
cli% setlicense
If this software is being provided to you for a limited evaluation period,
then your license shall be governed by the current HPE Software License
Terms (or as otherwise agreed between us) with the exception that the
term of the license shall expire upon the earlier of the evaluation period
notified to you or 120 days. Upon expiration of the license, you must cease
using the software and HPE reserves the right to disable the software
without notice. By using or activating the software you are agreeing to
these terms.
Do you agree to these terms and conditions? y=yes n=no: yes
Please enter the new license key below. When finished, press enter on an
empty line. If the key is entered by hand, note that characters other than
letters and numbers are ignored, and the key is not case-sensitive.
60R3–0C1G...
NOTES
Access to all domains is required to run this command.
HPE's license terms and conditions must be accepted before proceeding with this command.
This command prompts for a new license key. To finish entering the license key, press ENTER on a blank
line.
When the license key is being interpreted, all characters other than letters (without case sensitivity) and
numbers are ignored, and the letters are not case-sensitive.
After the new license key has been entered, the changes between the existing license key and the new
license key are displayed. There is a prompt to confirm the changes unless the -noconfirm option is given,
in which case the information is not displayed, and the new license key will be entered immediately.
The entered license key is accepted only if it is recognized as a valid key.
A valid license key includes an appropriate serial number and is associated with the number of nodes in
the system for which the license key is being entered.
Set Commands
365
setnet
DESCRIPTION
The setnet command sets the administration network interface configuration.
SYNTAX
The syntax for the setnet command can be one of the following:
setnet startaddr <old_IP> <new_IP> <new_netmask>|<prefix_len>
setnet startgateway <new_gateway>
setnet finish [-f]
setnet abort
setnet cleargateway [-f] [-v4] [-v6]
setnet speed <IP_addr> auto|<mbps> <duplex>
setnet failoverping <IP_addr> {<ping_addr>|none}
setnet ntp {none | [-add|-set|-remove] [-force] <server_addr>}
setnet changenode [<node_ID>]
setnet addaddr <old_IP> <new_IP> {<new_netmask>|<prefix_len>}
setnet removeaddr <old_IP>
setnet dns {none | [-add|-remove] <server_addr>}
setnet disableports {yes|no}
SUBCOMMANDS
startaddr
Specifies that the system start switching the old IP address (<old_IP> specifier) to the new IP address
(<new_IP> specifier) with the specified netmask (<new_netmask> specifier).
startgateway
Specifies that the gateway is immediately set to the specified IP address if no gateway is currently
defined. If a gateway is currently defined, the system starts switching the old gateway to the new gateway.
Both IPv4 and IPv6 can be changed with this command.
finish
Specifies that outstanding changes from the startaddr and startgateway subcommands be completed.
abort
Specifies that any attempt to configure a new IP address or gateway fails. The system returns to its
previous state.
cleargateway
Specifies that all the existing system gateways are removed if neither the -v4 or -v6 options are given.
The -v4 option specifies that only the IPv4 gateway be removed. The -v6 option specifies that only the
IPv6 gateway be removed. The -f option overrides the prompt confirming to clear the gateway(s).
speed
Specifies that the network interface is set to the specified speed and duplex as indicated with the <mbps>
and <duplex> specifiers.
failoverping
366
setnet
Specifies that on IP failover, a ping is sent to the specified IP address as indicated with the <ping_addr>
specifier.
ntp {none | [-add|-set|-remove] [-force] <server_addr>}
Specifies the NTP server the system should use to synchronize its clocks. The server may be an IP
address or hostname. To add or set a NTP server it must be resolvable. The -force option can be used to
override this check.
changenode
Forces the system to change which node has an active Ethernet interface.
If a node ID is specified, it switches to that node. Otherwise, any node with a connected Ethernet
interface is chosen.
addaddr
Specifies that the new IP (<new_IP> specifier)is added to the interface that is currently assigned the
old_IP (<old_IP> specifier). The old IP and new IP should be of different IP versions (IPv4 or IPv6).
removeaddr
Specifies that the old IP (<old_IP> specifier) be de-configured.
The old IP can only be an IPv6 address.
dns {none | [-add|-remove] <serveraddr>}
Specifies the DNS server the system should use to resolve host names. The server must be specified as
an IP address.
disableports {yes|no}
Specifies the network configuration functionality where if the option is specified as "yes" will disable the
non-encrypted ports, if option "no" is specified, it will enable the non-encrypted ports. Disabling nonencrypted ports will also prevent the service processor from monitoring events, which will prevent the
generation of email notifications about system issues.
AUTHORITY
•
•
Super, Service
Any role granted the net_set right
OPTIONS
-add
Specifies that the server should be added to an existing set.
-remove
Specifies that the server should be removed from an existing set.
-set
Specifies that the server should be the only server in a set.
-f
Specifies that the operation is forced even if verification has not occurred. This option can only be used
with the finish and cleargateway subcommands.
SPECIFIERS
<old_IP>
Specifies an existing IP address that is to be changed. This specifier is used in conjunction with the
<new_IP> and <new_netmask> specifiers and can only be used with the startaddr, addaddr and
removeaddr subcommands.
Set Commands
367
<new_IP>
Specifies a new IP address to which the system is configured. This specifier is used in conjunction with
the <old_IP> and <new_netmask> specifiers and can only be used with the startaddr and addaddr
subcommands.
<new_netmask>
Specifies a new netmask to which the system is configured. This specifier is used in conjunction with the
<old_IP> and <new_IP> specifiers and can only be used with the startaddr and addaddr subcommands.
<prefix_len>
Specifies a new prefix_len to which the system is configured. This specifier is used in conjunction with the
<old_IP> and <new_IP> specifiers. This specifier can only be used when <new_IP> is of IPv6 type and
can only be used with the startaddr and addaddr subcommands.
<new_gateway>
Specifies the IP address of the new gateway for the system. This specifier can only be used with the
startgateway subcommand.
auto|<mbps> <duplex>
Specifies that the speed of the network interface is either auto negotiated (auto), or specified manually
using the <duplex> and <mbps> specifiers.
•
<mbps>
•
Specifies the speed of the network interface. Valid values are either 10, 100, or 1000. This specifier
can only be used with the <duplex> specifier and with the speed subcommand.
<duplex>
Specifies the duplex of the network interface. Valid values are either half or full. This specifier can only
be used with the <mbps> specifier and with the speed subcommand.
<IP_addr>
Specifies the IP address of the node. This specifier can only be used with the failoverping subcommand.
<IP_addr> must be an IPv4 address.
<ping_addr>|none
Specifies that during an IP failover, a ping either be sent to the specified IP address (<ping_addr>) or not
sent at all (none). This specifier can only be used with the failoverping subcommand.
<ping_addr> must be an IPv4 address.
[<node_ID>]
Specifies the node, by ID, that has an active Ethernet interface. This specifier can only be issued with the
changenode subcommand. This specifier is not required.
EXAMPLES
The following example displays the switching of the old IP address with a new IP address and netmask:
cli% setnet startaddr 10.0.23.42 192.168.5.218 255.255.252.0
Change of IP address successfully started.
The following example displays the gateway being cleared:
368
Set Commands
cli% setnet cleargateway
If the machine that the HPE 3PAR CLI is running on is not on the same
subnet as the HPE 3PAR Storage System it is connected to, clearing the
gateway will render the storage system unreachable from that machine,
and any future connections will need to be made from a system which
is on the same subnet as the storage system.
Are you sure you want to clear the gateway (y/n)?
y
Gateway modified successfully.
The following example modifies the disableports option:
cli% setnet disableports yes
Disabling non-encrypted ports will disable SP event handling,
Recovery Manager for VMWare and SRA. Disabling SP event handling will
prevent support personnel from being notified of system problems.
Disabling non-encrypted ports should only be done if there is a strict
requirement for all connections to be encrypted.
Are you sure you want to disable non-encrypted ports?
select q=quit y=yes n=no: y
NOTES
Access to all domains is required to run this command.
If successful, this command causes any clients currently connected to lose their connection.
To make it possible to change the network configuration without running the risk of losing contact with the
system because of misconfiguration, the setnet command uses a two step process. When a new IP
address is specified with the setnet startaddr command, the system is configured to listen to both
the old and new IP addresses. When a new gateway is specified with the setnet gateway command,
the system switches between the old and new gateways when it sees packets addressed to it being
routed through those gateways.
After a connection has been made with the new configuration, the setnet finish command can be
used to remove the old configuration. While in the middle of this process, additional work must be done
by the system. It is preferable to run the setnet finish command after the new configuration has been
verified.
When changing gateways, starting a connection takes longer than usual, as the first reply packet is
typically routed through the previously used gateway address.
NTP servers may be an IP address or hostname. When adding or setting a NTP server the StoreServ
checks to see if the NTP server is resolvable.
setnode
DESCRIPTION
The setnode command sets properties of the node components such as serial number of the power
supply.
setnode
369
SYNTAX
setnode ps <PS_ID> [options] <node_ID>
SUBCOMMANDS
ps
Sets the power supply properties
AUTHORITY
•
•
Super, Service
Any role granted the node_set right
OPTIONS
-s <serial_number>
Specify the serial number. It is up to 8 characters in length.
SPECIFIERS
<PS_ID>
Specifies the power supply ID.
<node_ID>
Specifies the node ID.
EXAMPLES
The following example displays setting the serial number of the node power supply:
370
Set Commands
cli% shownode ps
Node PS -Serial- -PSState-ChrgLvl(%)
0
0 -NotPresent
NotPresent
0
0
1 FFFFFFFF OK
OK
0
1
0 FFFFFFFF OK
OK
0
1
1 -NotPresent
NotPresent
0
cli%
cli% setnode ps 1 -s 12345678 0
cli% shownode -ps
Node PS -Serial- -PSState-ChrgLvl(%)
0
0 -NotPresent
NotPresent
0
0
1 12345678 OK
OK
0
1
0 FFFFFFFF OK
OK
0
1
1 -NotPresent
NotPresent
0
cli%
cli% setnode ps 0 -s aabbccdd 1
cli% shownode -ps
Node PS -Serial- -PSState-ChrgLvl(%)
0
0 -NotPresent
NotPresent
0
0
1 12345678 OK
100
1
0 AABBCCDD OK
100
1
1 -NotPresent
NotPresent
0
FanState ACState DCState -BatState--
--
--
OK
OK
OK
OK
OK
OK
--
--
--
FanState ACState DCState -BatState--
--
--
OK
OK
OK
OK
OK
OK
--
--
--
FanState ACState DCState -BatState--
--
--
OK
OK
OK
OK
OK
OK
OK
OK
--
--
--
NOTES
Access to all domains is required to run this command.
At least one option must be specified.
setpassword
DESCRIPTION
The setpassword command allows a user with Super role to change the password for any user and
create a password file on a client. Edit-, browse-, or service-level users can use the setpassword
command to change their own passwords or save their password files on a client.
SYNTAX
setpassword [options <arg>]
setpassword
371
AUTHORITY
•
•
•
•
Super, Service, Edit, Browse
Any role granted the password_setany right can set any user password.
Any role granted the password_setown right can only set their own password.
Only users with Super role can set the minimum password length.
OPTIONS
-u <username>
Specifies the login name of the user whose password is being changed. If a login name is not specified,
the command defaults to the current user.
-minlen <N>
Sets the minimum password length for all users. Where N is an integer from 6 to 32. This option can only
be used by itself. The current minimum password length is displayed by showsys -d.
SPECIFIERS
None.
EXAMPLES
The following example displays the prompts encountered when changing a user's (user1) password:
cli% setpassword -u user1
password:
Old password:
The following example displays the how to set the minimum password length:
cli% setpassword -minlen 12
NOTES
Only a user with Super role can set another user's password and set the minimum password length. The
default minimum password len is 15.
Passwords can be no longer than 32 printable characters.
The format of the entry in the file is <username> <encrypted_password>. This file may be referenced by
the TPDPWFILE environment variable or -pwf command line option for subsequent commands.
Without any options, the command will prompt to change the invoking user's password on the storage
system.
Changing a user's password has no effect on SSH access if the user has set a valid key with the
setsshkey on page 396 command. Until the SSH key is removed the user will not have to provide the
new password.
setpd
DESCRIPTION
The setpd command marks a PD as allocatable or non allocatable for logical disks (LD).
SYNTAX
setpd ldalloc on|off <PD_ID>...
372
setpd
SUBCOMMANDS
ldalloc on|off
Specifies that the PD, as indicated with the PD_ID specifier, is either allocatable (on) or non-allocatable
(off) for LDs.
AUTHORITY
•
•
Super, Service
Any role granted the pd_set right
OPTIONS
None.
SPECIFIERS
<PD_ID>...
Specifies the PD identification using an integer.
EXAMPLES
The following example displays PD 0 marked as non allocatable for LDs:
cli% setpd ldalloc off 0
NOTES
Access to all domains is required to run this command.
This command can be used when the system has disks that are not to be used until a later time.
Verify the status of PDs by issuing the showpd -state command (see the showpd on page 491
command).
setqos
DESCRIPTION
The setqos command creates and updates QoS rules in a system.
SYNTAX
setqos [options] [{{vvset|domain}:{<name>|<pattern>}|sys:all_others}]...
AUTHORITY
•
•
Super, Edit
Any role granted the qos_set right can set QoS configurations.
OPTIONS
-pri {high|normal|low}
Set the QoS scheduling priority of the QoS rule (of this target object).
The default priority is "normal".
-io {none|[{<MinGoal>}-]<MaxLimit>}
Sets the I/O issue count Min goal and Max limit for QoS throttling.
setqos
373
If only <MaxLimit> is given, sets both I/O issue count rate Min goal and Max limit to the given value. If
"none" is specified, there is no limit on I/O issue count. Note even when there is no limit for I/O issue
count, I/O-bandwidth-count based throttling (-bw) can still dynamically put a limit on it.
-bw {none|[<MinGoal>[k|K|m|M|g|G]-]<MaxLimit>[k|K|m|M|g|G]]}
Sets the I/O issue bandwidth rate Min goal and Max limit for QoS throttling. If only <MaxLimit> is given,
sets both I/O issue bandwidth rate Min goal and Max limit to the given value. If "none" is specified, there
is no limit on I/O issue bandwidth rate. Note even when there is no limit for I/O issue count, I/Obandwidth-rate based throttling (-io) can still dynamically put a limit on it. The default unit is byte. The
integer can optionally be followed with k or K to indicate a multiple of 1000, m or M to indicate a multiple
of 1,000,000, or g or G to indicate a multiple of 1,000,000,000.
-lt {<target>[s|ms|us]|default}
Set the QoS I/O committing target latency to be <target>. <target> is in units of milliseconds (ms) if no
suffix is specified. If "default" is specified, the latency goal will be cleared.
{-on|-off}
Control QoS scheduling for the target object. By default QoS scheduling is "on".
-clear
Turn "off" QoS scheduling of the rule and clear its setting.
-vv {<VV_name>|<pattern>}[,{<VV_name>|<pattern>}]...
Applies only to QoS rules whose targets include virtual volumes with names matching any of the names
or patterns specified.
SPECIFIERS
{{vvset|domain}:{<name>|<pattern>}|sys:all_others}
The target objects of QoS setting. <name> and <pattern> refer to the target object name, as listed in the
show{vvset|domain} commands. If sys:all_others is specified, the QoS rule will be applied to the group of
all virtual volumes, which do not have any specific QoS "on".
EXAMPLES
The following example sets the IOPs Min goal and Max limit of vvset vsa to 300:
cli% setqos -io 300 vvset:vsa
The following example turns "off" the QoS scheduling for vvset vsa:
cli% setqos -off vvset:vsa
The following example removes all QoS settings of all vvsets:
cli% setqos -clear vvset:*
NOTES
374
Set Commands
Maximum limit - this is the maximum amount of IOPS or bandwidth, or both, which a given VVset or
Domain is allowed to achieve. Best practice is to use the System Reporter data to quantify the volumes'
performances and set QoS rules accordingly.
Minimum goal - this is the minimum amount of IOPS or bandwidth, or both, below which the system will
not throttle a given VVset or Domain in order to meet the latency goal of a higher priority workload. These
VVsets or Domains may consume more IOPS/bandwidth than what the goal is (up to the Max), but will be
throttled to the given goal as the system gets busier.
Latency Goal - this is the Svctime goal the system will target to fulfill for a given QoS rule. In order for the
goal to work, rules with a minimum goal must exist so the system can throttle those workloads.
Three Priority Levels exist: high, normal and low. As the system gets busier it will start targeting lower
priority workloads and throttling their performances to meet higher priority workloads' latency goals. High
priority level should be used against critical applications, lower priority on less critical applications.
For all the <pattern> fields, the patterns are glob-style (shell-style) patterns. (For more information, issue
"clihelp sub,globpat" or see Glob-Style Patterns on page 15.) When -vv option is present, the setting is
only applied to target objects with existing QoS configuration. To limit the new settings to target objects
with existing QoS configuration, it is useful to specify -vv * in the command line.
QoS rules only manage host I/O.
For this command KB = 1000 bytes.
Using this command to create new QoS rules requires a Priority Optimization license. Contact your local
HPE representative for information.
setrcopygroup
DESCRIPTION
The setrcopygroup command performs the following actions: Sets the policy of the remote copy
volume group for dealing with I/O failure and error handling. Switches the direction of transfer between
volume groups. Sets a resynchronization period for volume groups in asynchronous periodic mode. Sets
the minimum stop period and defined stop order for groups in asynchronous streaming mode. Sets the
group's mode. Sets a frequency which Remote Copy takes coordinated snapshots in asynchronous
streaming mode.
SYNTAX
The syntax for the setrcopygroup command can be one of the following:
setrcopygroup pol [option] [<pattern>] <policy> [<group_name>]
setrcopygroup period [option] [<pattern>] <period_value> <target_name>
[<group_name>]
setrcopygroup mode [option] [<pattern>]<mode_value> <target_name>
[<group_name>]
setrcopygroup snap_freq [option] [<pattern>]<freq_value>
<target_name>[<group_name>]
setrcopygroup <dr_operation> [options] [<pattern>] [<target_name|
group_name>...]
setrcopygroup cpg -usr_cpg <cpg_name> <target_name>:<cpg_name>... -snp_cpg
<cpg_name> <target_name>:<cpg_name>... <group_name>
setrcopygroup cpg -usr_cpg_unset -snp_cpg_unset <group_name>
setrcopygroup vvol -removetest <group_name>
SUBCOMMANDS
setrcopygroup
375
pol
Sets the policy of the Remote Copy volume groups for dealing with I/O failure and error handling.
period
Specifies that groups that are in asynchronous periodic mode should be periodically synchronized in
accordance with the specified <period_value>.
Groups that are in asynchronous streaming mode will transition to "Logging" state when replication
resources drop below sustainable limits.
The <period_value> is used to define the order that these groups will be stopped and restarted
automatically, as well as the minimum elapsed time each specific group will be restarted once the
replication resources are restored.
Groups with the largest <period_value> will be stopped first and restarted last.
A <period_value> of 0 will prevent automatic restarting of the group, these groups will need to be started
manually.
snap_freq
Specifies the interval at which Remote Copy takes coordinated snapshots. Only applicable in
asynchronous streaming mode. The interval can be a minimum of five minutes and up to a maximum of
one year.
mode
Specifies the mode to which the volume group is set.
cpg
Specifies the local and target cpg
<dr_operation>
Specifies the operation of the group(s). Valid operations are:
•
reverse
Changes the natural and current direction of all specified groups.
•
The operation is mirrored resulting in a direction change on both systems. This option is very flexible
depending on the options that are provided, however it should not be used as a part of the normal
disaster recovery process.
failover
•
Changes secondary volume groups to primary volume groups on the active system in the event of a
server failure. If the group has multiple targets it will also attempt to pull more recent data from other
targets and start Remote Copy to those targets when complete.
switchover
•
Migrates the remote copy group from primary to secondary without impacting the host IO. This
command requires that associated hosts are connected to both the primary and secondary arrays. The
WWNs of primary and secondary volumes are consistent and the host persona of the host must
support RTPG.
recover
•
Used for groups on which the failover operation has already been run. Changes matching primary
volume groups on the backup system to secondary volume groups and then starts and synchronizes
all groups.
restore
Used for groups on which the failover operation has already been run. The restore command will
implicitly execute the recover operation on any group after a failover, which has not yet been
recovered, prior to performing the restore. It identifies and differentiates between those groups
376
Set Commands
•
requiring a simple restore and those requiring both a recover and then a restore, and orchestrates the
execution of the required tasks to returns all groups to their natural direction and starts them. In
addition to being context specific, the execution of the restore operation now takes a best effort
approach. If one or more groups in the list of groups passed to the operation is not in the correct state
for a restore or a combined recover and restore, it will return to the user with an error code. However, it
will process those groups that are deemed eligible for the simple or combined operation before
returning.
override
This command overrides the failsafe state which is applied to remote copy group allowing the
associated volumes to be exported to attached hosts.
vvol
This command specifies a VMware VVol specific operation on the remote copy group. Valid operations
are:
•
-removetest
Specifies that the INTEST state of this VMware VVol group be cleaned up.
AUTHORITY
•
•
Super, Edit
Any role granted the rcopygroup_set right.
OPTIONS
-t <tname>
When used with <dr_operation> subcommands, specifies the target to which the <dr_operation>
command applies to. This is optional for single target groups, but is required for multi-target groups. If no
groups are specified, it applies to all relevant groups. When used with the pol subcommand, specified for
a group with multiple targets then the command only applies to that target, otherwise it will be applied to
all targets.
NOTE:
The -t option without the groups listed in the command, will only work in a unidirectional
configuration. For bidirectional configurations, the -t option must be used along with the groups
listed in the command.
-f
Does not ask for confirmation for disaster recovery commands.
-nostart
Specifies that groups are not started after role reversal is completed.
This option can be used for failover, recover and restore subcommands.
-nosync
Specifies that groups are not synced after role reversal is completed through the recover, restore and
failover specifiers.
-discard
Specifies not to check a group's other targets to see if newer data should be pushed from them if the
group has multiple targets. The use of this option can result in the loss of the most recent changes to the
group's volumes and should be used carefully. This option is only valid for the failover specifier.
-nopromote
Set Commands
377
This option is only valid for the failover and reverse specifiers. When used with the reverse specifier,
specifies that the synchronized snapshots of groups that are switched from primary to secondary not be
promoted to the base volume. When used with the failover specifier, it indicates that snapshots of groups
that are switched from secondary to primary should not be promoted to the base volume in the case
where all volumes of the group were not synchronized to the same time point.
The incorrect use of this option can lead to the primary secondary volumes not being consistent.
-nosnap
Specifies that snapshots are not taken of groups that are switched from secondary to primary.
Additionally, existing snapshots are deleted if groups are switched from primary to secondary. The use of
this option may result in a full synchronization of the secondary volumes. This option can be used for
failover, restore, and reverse subcommands.
-stopgroups
Specifies that groups are stopped before running the reverse subcommand.
-local
The -local option only applies to the "reverse" operation and then only when the -natural or -current
options to the "reverse" operation are specified. Specifying -local with the "reverse" operation and an
associated -natural or -current option will only affect the array where the command is issued and will not
be mirrored to any other arrays in the Remote Copy configuration.
-natural
Specifying the -natural option with the "reverse" operation changes the role of the groups but not the
direction of data flow between the groups on the arrays. For example, if the role of the groups are
"primary" and "secondary", issuing the -natural option with the "reverse" operation will result in the role of
the groups becoming "primary-rev" and "secondary-rev" respectively. The direction of data flow between
the groups is not affected only the roles. Since the -natural option does not change the direction of data
flow between groups it does not require the groups be stopped.
-current
Specifying the -current option with the "reverse" operation changes both the role and the direction of data
flow between the groups. For example, if the roles of the groups are "primary" and "secondary", issuing
the -current option to the "reverse" operation will result in the roles of the group becoming "secondary-rev"
and "primary-rev" respectively and the direction data flow between the groups is reversed. Since the current option actually reverses the direction of data replication it requires the group be stopped.
Both the -natural and -current options must be used with care to ensure the Remote Copy groups do not
end up in a non-deterministic state (like "secondary", "secondary-rev" for example) and to ensure data
loss does not occur by inadvertently changing the direction of data flow and re-syncing old data on top of
newer data.
-waittask
Wait for all tasks created by this command to complete before returning.
This option applies to the failover, recover, restore, and reverse subcommands.
-pat
Specifies that specified patterns are treated as glob-style patterns and all remote copy groups matching
the specified pattern will be set. The -pat option can specify a list of patterns. This option must be used if
<pattern> specifier is used.
-usr_cpg <cpg name> <target_name>:<cpg_name>
Specifies the local user CPG and target user CPG that will be used for volumes that are auto-created.
The local CPG will only be used after failover and recover.
-snp_cpg <cpg name> <target_name>:<cpg_name>
378
Set Commands
Specifies the local snap CPG and target snap CPG that will be used for volumes that are auto-created.
The local CPG will only be used after failover and recover.
-usr_cpg_unset
Unset all user CPGs that are associated with this group.
-snp_cpg_unset
Unset all snap CPGs that are associated with this group.
SPECIFIERS
<pattern>
Specifies a glob-style pattern. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.) If this specifier is not used, the <group_name> or <target_name> specifier must be
used.
<policy>
Specifies the policy to assign to the group. This specifier can only be used with the pol subcommand.
Valid policies are:
•
auto_failover
Configure automatic failover on a remote copy group. This feature will perform an automatic failover
on a remote copy group when used in conjunction with the Quorum Witness functionality.
Secondary volumes will be subject to a remote copy failover operation. Any of the secondary volumes
that are exported to attached hosts will become accessible.
•
If a network fails and prompts a failover, any primary volumes will be placed into a failsafe state to
prevent data corruption and inconsistency between primary and secondary volumes.
no_auto_failover
•
Remote-copy groups will not be subject to automatic failover (default).
auto_recover
Specifies that if the remote copy group is stopped as a result of the remote copy links going down, the
group is restarted automatically after the links come back up. If this policy is enabled for a group while
the group is stopped after link failures it will only be started when the links come up for the failed
target. If the links are already up at the time the policy is set then the group will not be restarted at that
time.
•
If the virtual volumes in the remote copy group were created using the admitrcopyvv -createvv
command, in the event of remote copy stopping due to link failures, the remote copy group goes into
failsafe mode. Failsafe mode requires that the remote copy group be started manually using the
startrcopygroup command.
no_auto_recover
•
Specifies that if the remote copy is stopped as a result of the remote copy links going down, the group
must be restarted manually after the links come back up (default).
over_per_alert
•
If a synchronization of a periodic remote copy group takes longer to complete than its synchronization
period then an alert will be generated. This is the default behavior.
no_over_per_alert
•
If a synchronization of a periodic remote copy group takes longer to complete than its synchronization
period then an alert will not be generated.
path_management
Volumes in the specified group will be enabled to support ALUA. The Target Port Group states of the
volumes will be presented as ACTIVE on the primary and as STANDBY on the secondary.
Set Commands
379
•
no_path_management
•
ALUA behavior will be disabled for volumes in the group. The Target Port Group state of the volumes
will be presented as ACTIVE (default).
mt_pp
•
Specifies that the group is participating in a multi-target Peer Persistence configuration. The group
must have two targets, one of which must be synchronous. The path_management and auto_failover
policies will also be set for the synchronous group target.
no_mt_pp
Disables the multi-target Peer Persistence configuration. This will also remove the path_management
and auto_failover policies.
<group_name>
Specifies the name of the volume group whose policy is set, or whose target direction is switched.
<target_name>
Specifies the target name for the target definition created with the creatercopytarget command.
<mode_value>
Specifies the mode, sync, periodic or async to which the group is set. This specifier can only be used with
the mode subcommand.
<period_value>s|m|h|d
Specifies the time period in units of seconds (s), minutes (m), hours (h), or days (d), for automatic
resynchronization (eg. 14h for 14 hours).
The time can be a minimum of five minutes (for asynchronous periodic groups) and up to a maximum of
one year, or set to zero. This specifier can only be used with the period subcommand.
For asynchronous periodic mode, this value is used to specify the time period for automatic
resynchronization. A <period_value> of 0 will prevent automatic resynchronization. The minimum period
value for asynchronous streaming groups is thirty seconds.
For asynchronous streaming mode, the <period_value> is used to define the order in which these groups
will be stopped and restarted automatically, as well as the minimum elapsed time after which each
specific group will be restarted once the replication resources are restored. Groups with the largest
<period_value> will be stopped first and restarted last. The <period_value> can be a minimum of 30
seconds, the default value is 5 minutes. Values between 1 and 29 seconds will be rejected. A
<period_value> of 0 is allowed and will prevent automatic restarting of the group; these groups will need
to be started manually. If groups have the same <period_value>, the group using the most replication
resources will be stopped first and restarted last.
When changing mode from asynchronous streaming to asynchronous periodic, <period_value> will be
reconfigured if it is not valid. For example if an asynchronous streaming mode group has a
<period_value> of 30 seconds when changed to asynchronous periodic mode, <period_value> will be
changed to 5 minutes.
<freq_value>s|m|h|d
Specify the time period in units of seconds(s), minutes (m), hours (h), or days (d), for automatic
coordinated snapshots taken on both local and remote systems. The time must be longer than or equal to
five minutes and not more than one year in duration. If the value is set to zero, automatic coordinated
snapshots will be turned off. Only applicable in asynchronous streaming mode.
EXAMPLES
The following example sets the group policy for Group1:
setrcopygroup pol auto_recover Group1
380
Set Commands
The following example sets the group policy for all the groups that start with the name testgroup:
setrcopygroup pol
-pat testgroup* auto_recover
The following example reverses the current direction of secondary group (Group1) so that I/O might be
applied to the group after disaster recovery:
setrcopygroup failover Group1.r121
The following example reverses the current direction of all secondary groups that start with the name
testgroup so that I/O can be applied to the groups during disaster recovery:
setrcopygroup failover
-pat testgroup*
The following example sets Group1 to be automatically synchronized every 30 minutes to System2:
setrcopygroup period 30m System2 Group1
The following example sets volume groups that start with the name testgroup to synchronize to its
asynchronous periodic mode target InServ2 every 30 minutes:
setrcopygroup period
-pat testgroup* 30m InServ2
The following example sets the local user and snap CPG, and the target usr and snp CPG for the group
testgroup:
setrcopygroup cpg -usr_cpg u_cpg RC603:remote_u_cpg
RC603:remote_s_cpg testgroup
-snp_cpg s_cpg
The following example will unset the local user and snap CPG for the group testgroup:
setrcopygroup cpg -usr_cpg_unset -snp_cpg_unset testgroup
The following example will configure Remote Copy to take coordinated snapshots of all volumes in an
asynchronous streaming group every two hours:
setrcopygroup snap_freq 2h target1 group1
NOTES
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
When issuing the setrcopygroup <dr_operation> command, either the <group_name> specifier,
the <target_name> specifier, or the <pattern> specifier must be specified.
Do not use the reverse value of the <dr_operation> as part of the normal disaster recovery process.
The period can be set only for groups whose mode is asynchronous periodic or asynchronous streaming
(see creatercopygroup on page 155).
For groups whose mode is asynchronous streaming, using a period value of 0 means that groups which
are stopped due to low levels of replication resources will not be automatically started. You must specify a
period using setrcopygroup period <value> if you want specific groups to be considered first for
stopping and also considered for automatically starting again when availability of replication resources
improve.
Set Commands
381
The minimum period for asynchronous streaming groups is 30 seconds.
The default period for asynchronous streaming groups is five minutes.
Reversing the direction of primary volumes will result in the loss of any data changed after the group was
stopped.
There is no default resynchronization period. For groups whose mode is asynchronous periodic, you must
specify a resynchronization period using setrcopygroup period <value> or resynchronizations will
not automatically take place.
The minimum interval for periodic resynchronizations is five minutes.
If the mirror_config policy is set for this group's target and the group is a primary group, then the
setrcopygroup command is mirrored to the target when the period and pol subcommands are used.
Use the -nosnap option when the primary server has failed or where the disks are ruined or in an
unknown state. For example, an uncontrolled shutdown can result in loss of data. If you suspect that the
primary volumes are not in a known good state, you should use this option to force a FULL RESYNC
when the primary system is restored.
The -nosnap option can be used when making a secondary group take over as the primary after a
disaster takes down the primary (setrcopygroup failover -nosnap...). This option indicates that
no incremental resynchronization of the primary group is possible while the primary system is coming
back online. Without this option, a snapshot is taken when the secondary server takes over as the
primary. That snapshot is used to do an INCREMENTAL synchronization of the primary after it is restored.
This assumes that there was no loss of data in the primary volumes when the primary server went down.
The switchover command is only supported for synchronous remote copy groups that are started and
synced. The command must be issued on the primary array and upon completion of the command the
remote copy group will be restarted in the reverse direction.
setrcopytarget
DESCRIPTION
The setrcopytarget command adjusts the characteristics of a target definition.
SYNTAX
The syntax for the setrcopytarget command can be one of the following:
setrcopytarget pol <policy> <target_name>
setrcopytarget name <new_name> <target_name>
setrcopytarget tput <tput_value> <target_name>
setrcopytarget tunelinks <bandwidth> <latency> <target_name>
setrcopytarget autotunelinks <target_name>
setrcopytarget {enable|disable} <target_name>
setrcopytarget witness create [-remote] <witness_ip> <target>
setrcopytarget witness {start|stop|remove} [-remote] <target>
setrcopytarget witness check [-remote] [-node node_id] <witness_ip> [target]
SUBCOMMANDS
pol
Sets the policy for the specified target using the <policy> specifier.
name
382
setrcopytarget
Changes the name of the indicated target using the <new_name> specifier.
tput
Sets the maximum throughput value for each of the target's links.
Applicable to RCIP links only.
tunelinks
Adjust performance values for the target's links using the <bandwidth> and <latency> specifiers.
Applicable to RCIP links only.
autotunelinks
Automatically adjust performance values for the target's links. Applicable to RCIP links only. For
consistent results, this should be issued to the target links on both systems.
enable | disable
Enables or disables the target.
witness create
Create an association between a synchronous target and a Quorum Witness (QW) as part of a Peer
Persistence configuration.
witness start|stop|remove
Activate, deactivate and remove the ATF configuration.
witness check
Check connectivity to Quorum Witness.
AUTHORITY
•
•
Super, Edit
Any role granted the rcopytarget_set right.
OPTIONS
-remote
Used to forward a witness subcommand to the be executed on the remote HPE 3PAR Storage System.
When used in conjunction with the "witness check" subcommand the target must be specified - when
executing on the local storage system target specification is not required to check connectivity with the
Quorum Witness.
-node
Used to conjunction with the "witness check" subcommand to test the connectivity to the Quorum Witness
via the Quorum Announce process running on the specified node. Otherwise, the command simply
verifies that there is at least one operational route to the witness.
SPECIFIERS
<target_name>
Specifies the target name for the target definition previously created with the creatercopytarget
command.
<policy>
This specifier can only be used with the pol subcommand. The policy can be one of the following:
•
mirror_config|no_mirror_config
Specifies that all configuration commands (creatercopygroup, removercopygroup, admitrcopyvv,
dismissrcopyvv, setrcopygroup pol/period, startrcopygroup, and stoprcopygroup) involving the
Set Commands
383
specified target are duplicated (mirror_config) or not duplicated (no_mirror_config). If not specified, all
configuration commands are duplicated.
NOTE:
The no_mirror_config specifier should only be used to allow recovery from an unusual error
condition and only used after consulting your HPE representative.
<new_name>
The new name for the indicated target. This specifier can only be used with the name subcommand.
<tput_value>
Specifies the maximum throughput for this target's links, and is used to limit the total throughput of the
link. You can optionally specify g or G (gigabytes), m or M (megabytes), or k or K (kilobytes) following the
throughput value to indicate size (with no space between the specified value and size type). The default is
kilobytes. This specifier can only be used with the tput subcommand. A value of 0 will remove the
throughput.
<bandwidth>
The measured bandwidth of the connection to the target, specified in kilobytes (KB) per second. This
specifier can only be used with the tunelinks subcommand.
<latency>
The measured round-trip latency of the connection to the target, specified in milliseconds (ms). This
specifier can only be used with the tunelinks subcommand.
<witness_ip>
The IP address of the Quorum Witness (QW) application, to which the HPE 3PAR Storage System will
connect to update its status periodically.
EXAMPLES
The following example will set the throughput of each link of target InServ-B to 5 megabytes per second:
cli% setrcopytarget tput 5M InServ-B
The following example shows how to check the connectivity to the Quorum Witness application, IP
address 10.0.0.1 via the Quorum Announcer process on node 0 of the mirror HPE 3PAR Storage System
over target tar1:
cli% setrcopytarget witness check -remote -node 0 10.0.0.1 tar1
The following example shows how to create and associate a Peer Persistence quorum with target tar1.
The Quorum Announcer process on the local nodes will post health updates to the Quorum Witness
application at IP address 10.0.0.1 and will monitor the health of the mirror storage system over target tar1
via its health updates to the witness at 10.0.0.1:
cli% setrcopytarget witness create 10.0.0.1 tar1
384
Set Commands
The following example shows how to tune RCIP links for a bandwidth of 2048 KB/s and a round-trip
latency of 20 ms on target tar1:
setrcopytarget tunelinks 2048 20 tar1
The following example shows how to have the system automatically tune RCIP links on target tar1:
setrcopytarget autotunelinks tar1
NOTES
Access to all domains is required to run this command.
This command requires the HPE 3PAR Remote Copy Software license. Contact your local service
provider for more information.
If the mirror_config policy is set and the setrcopytarget command is issued with the pol
subcommand, the duplicated configuration commands cannot be issued on the secondary. Doing so
results in an error.
There must be an active connection between the systems in the Remote Copy pair to issue commands
on the primary to be mirrored to the secondary. If there is no connection, the commands return an error.
The setrcopytarget command requires the groups associated with it be stopped prior to using the
following options:
•
•
setrcopytarget name <new_name> <target_name>
setrcopytarget tput <throughput> <target_name>
The setrcopytarget command with the following arguments can be run without bringing down its
Remote Copy groups:
•
•
•
setrcopytarget pol <policy> <target_name>
setrcopytarget tunelinks <bandwidth> <latency> <target_name>
setrcopytarget autotunelinks <target_name>
Under normal operating conditions the mirror_config policy should never be changed to no_mirror_config.
This policy option is included only as a method to correct several unusual error conditions that might
occur in the course of operation which result in a mismatch in configuration between the two sides of a
Remote Copy pair. For instance, it is possible for a group to be created, or a volume to be added to a
group, only on one side of the pair if the operation is interrupted by a network failure. In such cases it
might be necessary to temporarily change the policy to no_mirror_config in order to bring the
configurations into alignment. After being corrected the mirror_config policy should be immediately
restored. Such operations should generally only be undertaken on the advice of a HPE representative.
The setrcopytarget witness subcommands are provided to locally create and associate a target with
a Peer Persistence quorum and to manage the operational state of the quorum.
The results of tuning RCIP links are reflected in the output of:
showrcopy -d targets
The "Socks" field shows the number sockets allocated for the specified tune parameters, and the "Buffsz"
field shows the size (in bytes) of the buffers.
Targets whose links are subject to "autotunelinks" will show a "Buffsz" of zero.
The tunelinks subcommand will disable the autotunelinks behavior.
Set Commands
385
The default performance values for an RCIP target before taking any tuning action are equivalent to those
produced by running:
setrcopytarget tunelinks 2048 20 <target_name>
setsched
DESCRIPTION
The setsched command allows users to suspend, pause, change the schedule, and change the name
of currently scheduled tasks.
SYNTAX
setsched [options] <schedname>
setsched [-suspend | -resume] <schedname>
setsched [-suspend_all | -resume_all]
AUTHORITY
•
•
•
Super, Service, Edit
Any role granted the sched_setany right can set any user scheduled task properties
Any role granted the sched_setown right can only set their own scheduled task properties
OPTIONS
-suspend <schedname>
Suspends execution of a specified task.
This will not halt execution of an already running task.
Cannot be used with any other options.
-suspend_all
Will suspend execution of all scheduled tasks.
This will not halt execution of an already running task.
Cannot be used with any other options.
-resume <schedname>
Will resume scheduling of a specified task.
Cannot be used with any other options.
-resume_all
Will resume scheduling of all scheduled tasks.
Cannot be used with any other options.
-s <newschedule>
Set a new schedule for a given task. The newschedule is a cron-style schedule for the task to be run on.
Each field can be at most 127 characters in length.
-f
Do not detect when a modified scheduled task exceeds the recommended number of scheduled task
starts per minute. Do not ask for confirmation to modify the scheduled task. This option only applies to the
setsched -s option for setting a new schedule.
-name <newname>
386
setsched
Set a new name for a given task. The newname is the new name to be given to the specified task. This
can be at most 31 characters in length.
-no_alert
Failures of tasks will no longer generate an alert.
-alert
Failures of tasks will generate an alert. This is set by default.
SPECIFIERS
<schedname>
The name of the scheduled task to modify.
EXAMPLES
None.
NOTES
To avoid spikes in resource utilization, it is recommended to spread out scheduled task start times as
much as possible. Setsched -s can predict out to 30 days when the modified scheduled task exceeds
the recommended number of scheduled task starts per minute. When this is detected, user confirmation
is requested to continue modifying the schedule.
To skip this detection and confirmation, use the -f option.
setsnmpmgr
DESCRIPTION
The setsnmpmgr command changes an SNMP manager's properties.
SYNTAX
setsnmpmgr [options <arg>] <manager_IP>
AUTHORITY
•
•
Super
Any role granted the snmpmgr_set right
OPTIONS
-notify {all|nodup|standard}
•
all
•
Enable all trap notification types defined by the HPE 3PAR MIB.
nodup
•
Enable all trap notification types defined by the HPE 3PAR MIB. Only send an alertNotify trap if no
other trap type will be sent for an event.
standard
Only send alertNotify type traps. This is the default.
-p <port_number>
Specifies the port number where the SNMP manager receives traps.
The port number and IP address are used together to uniquely identify the SNMP manager. Use this
option if the port number differs from the default of "162".
-pw <password>
setsnmpmgr
387
Specifies the SNMP manager's access community string (password), using up to 32 alphanumeric
characters. If not specified, the default is "public".
-snmpuser <username>
Specifies the SNMPv3 user name using up to 31 characters. The user name must be enabled for
SNMPv3 with the createsnmpuser on page 160 command.
-version <version>
Integer value that specifies the SNMP version supported by the manager.
Use "2" for SNMPv2 and "3" for SNMPv3. The default is "2".
SPECIFIERS
<manager_IP>
Specifies the IP address of the host where the manager runs. It must be valid IPv4 or IPv6 address. IPv6
address is in hexadecimal, is case insensitive, and is separated by colons. An example would be:
5def:2008:0:0:abcd:0:0:161a
In addition, a double colon (::) can be used once in an address to replace multiple fields of zeros. For
example:
5def:2008:0:0:abcd::161a
EXAMPLES
The following example modifies the SNMP manager IPv4 address 123.45.67.89 with the assigned
password of alpha1 and standard trap notification:
cli% setsnmpmgr -pw alpha1 123.45.67.89 -notify standard
The following example modifies the user and version properties of the SNMP manager identified by the
IPv4 address 123.45.67.89. The manager will receive all trap notification types for an event:
cli% setsnmpmgr -snmpuser john -version 3 -notify all 123.45.67.89
NOTES
Access to all domains is required to run this command.
The storage system does not support any form of name resolution. You must specify these IP addresses
directly.
Issue the addsnmpmgr on page 69 command to add an SNMP manager.
Issue the showsnmpmgr on page 529 command to display the list of registered SNMP managers.
Issue the setsnmppw on page 388 command to change the SNMP passwords.
Issue the removesnmppw on page 273 command to remove SNMP passwords.
Issue the removesnmpmgr on page 272 command to remove SNMP managers.
setsnmppw
DESCRIPTION
The setsnmppw command allows a user to update SNMP community string passwords. The SNMP
password is required for the system manager to send requests to the SNMP agent.
SYNTAX
setsnmppw [options] <password>
388
setsnmppw
AUTHORITY
•
•
Super
Any role granted the snmppw_set right
OPTIONS
-rw|-r|-w
Specifies that the read-write (-rw), read-only (-r), or write-only (-w) community password is changed. If not
specified, the read-write password is changed.
SPECIFIERS
<password>
Specifies the new user-defined password using up to 50 alphanumeric characters.
EXAMPLES
The following example changes the read-write SNMP community string password to newpassword1:
cli% setsnmppw newpassword1
The following example changes the read-only SNMP password to newpassword2 by specifying the -r
option on the command line:
cli% setsnmppw -r newpassword2
The following example changes the write-only SNMP password to newpassword3 by specifying the -w
option on the command line:
cli% setsnmppw -w newpassword3
NOTES
Access to all domains is required to run this command.
The default initial read-write password is public.
If the read-only or write-only passwords do not exist, they are created.
Verify SNMP passwords by issuing the showsnmppw on page 529 command.
setsralertcrit
DESCRIPTION
The setsralertcrit command allows users to change the state and attributes of System Reporter
threshold alert criteria.
SYNTAX
setsralertcrit {options} [-pat] {<name>|<pattern>|-all}
AUTHORITY
setsralertcrit
389
•
•
Super, Service
Any role granted the sralertcrit_set right.
OPTIONS
Options available to criteria of any type:
-daily
This criterion will be evaluated on a daily basis at midnight.
-hourly
This criterion will be evaluated on an hourly basis.
-hires
This criterion will be evaluated on a high resolution (5 minute) basis. This is the default.
-count <number>
The number of matching objects that must meet the criteria in order for the alert to be generated. Note
that only one alert is generated in this case and not one alert per affected object.
-recur <recurrences>/<samples>
The alert will only be generated if the other conditions of the criterion recur repeatedly. <recurrences> is
an integer value from 2 to 10, and <samples> is an integer from 2 to 10 representing the number of
previous System Reporter samples in which the recurrences will be examined. <samples> must be at
least the requested quantity of recurrences. Note that these samples refer to the selected resolution of
the criterion: hires, hourly, or daily.
-btsecs <relative_time>
A negative number indicating the number of seconds before the data sample time used to evaluate
conditions which compare against an average. Instead of a number representing seconds, btsecs can be
specified with a suffix of m, h or d to represent time in minutes (e.g. -30m), hours (e.g. -1.5h) or days (e.g.
-7d). The relative time cannot be more than 10 samples ago: 50 minutes for hires, 10 hours for hourly, or
10 days for daily. If this option is not present the average is only computed for the most recent data
sample. The -btsecs option may not be combined with the -recur option.
-critical
This alert has the highest severity.
-major
This alert should require urgent action.
-minor
This alert should not require immediate action.
-info
This alert is informational only. This is the default.
-enable
Enables the specified criterion.
-disable
Disables the specified criterion.
-comment <comment>
Specifies comments or additional information for the criterion. The comment can be up to 511 characters
long.
-name <newname>
390
Set Commands
Specifies that the name of the SR alert be changed to <newname>, with a maximum of 31 characters.
-condition <field><comparison><value>[,...]
Specifies the condition(s) that causes the event to trigger, and is determined by the applicable fields listed
below by event type.
Name based filtering options:
-pat
Specifies that certain patterns are treated as glob-style patterns and that all criteria matching the specified
pattern will be modified. This option must be used if the pattern specifier is used. This option cannot be
combined with -name, -condition, or any of the type-specific filtering options.
-all
Specifies that all criteria will have the designated operation applied to them, changing the state or
attributes of all criteria. This option cannot be combined with -name, -condition, or any of the type-specific
filtering options.
Type based filtering options:
Options specific to the PORT type:
-port_type <type>[,<type>...]
-port <npat>:<spat>:<ppat>[,<npat>:<spat>:<ppat>...]
-both | -ctl | -data
Fields applicable to the PORT type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops, sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the VLUN type:
-host <host_name|host_set|pattern>[,<host_name|host_set|pattern>...]
-vv <VV_name|VV_set|pattern>[,<VV_name|VV_set|pattern>...]
-l <LUN|pattern>[,<LUN|pattern>...]
-port <npat>:<spat>:<ppat>[,<npat>:<spat>:<ppat>...]
Fields applicable to the VLUN type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops, sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the LD type:
-node <node>[,<node>...]
-cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
-ld <LD_name>|<pattern>[,<LD_name>|<pattern>]
Fields applicable to the LD type:
Set Commands
391
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops, sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the PD type:
-disk_type <type>[,<type>...]
-rpm <speed>[,<speed>...]
-pd <PDID>|<pattern>[,<PDID>|<pattern>]
Fields applicable to the PD type:
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops, sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, avg_busy,
read_time0..read_time31, write_time0..write_time31,
total_time0..total_time31, read_size0..read_size15,
write_size0..write_size15, total_size0..total_size15
Options specific to the CMP type:
-node <node>[,<node>...]
Fields applicable to the CMP type:
read_hits, write_hits, reads, writes, totals, lock_blocks, read_hitpct,
write_hitpct, delack_nl, delack_fc, delack_ssd, free_page, clean_page,
write1_page, writen_page, writesched_page, writing_page, recov_page,
dirty_nl, dirty_fc, dirty_ssd, maxdirty_nl, maxdirty_fc, maxdirty_ssd
The following fields have been deprecated:
delack_fc10, delack_fc15, delack_ssd150, delack_ssd100, dirty_fc10,
dirty_fc15, dirty_ssd150, dirty_ssd100, maxdirty_fc10, maxdirty_fc15,
maxdirty_ssd150, maxdirty_ssd100
Each acts as an alias for the equivalent field without distinction between disk speeds. For example
delack_ssd100 or delack_ssd150 report equal to delack_ssd.
Options specific to the CPU type:
-node <node>[,<node>...]
Fields applicable to the CPU type:
user_pct, sys_pct, idle_pct, interrupts, context_switches
Options specific to the LINK type:
-node <node>[,<node>...]
Fields applicable to the LINK type:
xcb_sent, kbps, xcb_size
Options specific to the QOS type:
-target {{vvset|domain}:{<name>|<pattern>}|sys:all_others}[,...]
Fields applicable to the QOS type:
392
Set Commands
read_iops, write_iops, total_iops, read_kbps, write_kbps, total_kbps,
read_svctms, write_svctms, total_svctms, read_ioszkb, write_ioszkb,
total_ioszkb, qlen, sum_read_iops, sum_write_iops, sum_total_iops,
sum_read_kbps, sum_write_kbps, sum_total_kbps, limit_iops, limit_kbps,
read_wait, write_wait, total_wait, rej, wait_qlen
Options specific to the RCOPY type:
-target <TARGET_NAME|pattern>[,<TARGET_NAME|pattern>...]
Fields applicable to the RCOPY type:
rc_kbs, rc_kbps, rc_hbrttms
Options specific to the RCVV type:
-vv <VV_name|VV_set|pattern>[,<VV_name|VV_set|pattern>...]
Fields applicable to the RCVV type:
lcl_read_iops, lcl_write_iops, lcl_total_iops, rmt_read_iops, rmt_write_iops,
rmt_total_iops, lcl_read_kbps, lcl_write_kbps, lcl_total_kbps, rmt_read_kbps,
rmt_write_kbps, rmt_total_kbps, lcl_read_svctms, lcl_write_svctms,
lcl_total_svctms, rmt_read_svctms, rmt_write_svctms, rmt_total_svctms,
lcl_read_ioszkb, lcl_write_ioszkb, lcl_total_ioszkb, rmt_read_ioszkb,
rmt_write_ioszkb, rmt_total_ioszkb, lcl_total_qlen, lcl_busy_pct,
rmt_total_qlen, rmt_busy_pct
Options specific to the CACHE type:
-node <node>[,<node>...]
Fields applicable to the CACHE type:
reads_per_sec, writes_per_sec, cmp_read_hit_pct, cmp_write_hit_pct,
fmp_read_hit_pct, fmp_write_hit_pct, read_back_iops, read_back_mbps,
destage_write_iops, destage_write_mbps, fmp_used_pct, fmp_q_dormant,
fmp_q_cold, fmp_q_norm, fmp_q_warm, fmp_q_hot, fmp_q_destage, fmp_q_read,
fmp_q_flush, fmp_q_wrtback, cmp_q_free, cmp_q_clean, cmp_q_write1,
cmp_q_writen, cmp_q_wrtsched, cmp_q_writing, cmp_q_dcowpend, cmp_q_dcowproc
Options specific to the LDSPACE type:
-disk_type <type>[,<type>...]
-owner <node>[,<node>...]
-raid_type <type>[,<type>...]
-cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
-ld <LD_name>|<pattern>[,<LD_name>|<pattern>]
Fields applicable to the LDSPACE type:
raw_mb, used_mb, free_mb, total_mb
Options specific to the PDSPACE type:
-disk_type <type>[,<type>...]
-rpm <speed>[,<speed>...]
-pd <PDID>|<pattern>[,<PDID>|<pattern>]
Fields applicable to the PDSPACE type:
nrm_used_ok, nrm_used_fail, nrm_avail_clean, nrm_avail_dirty, nrm_avail_fail,
spr_used_ok, spr_used_fail, spr_avail_clean, spr_avail_dirty, spr_avail_fail,
lifeleft_pct, t_degc
Set Commands
393
Options specific to the CPGSPACE type:
-disk_type <type>[,<type>...]
-raid_type <type>[,<type>...]
-cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
Fields applicable to the CPGSPACE type:
adm_used_mb, snp_used_mb, usr_used_mb, total_used_mb, adm_free_mb,
snp_free_mb, usr_free_mb, total_free_mb, adm_mb, snp_mb, usr_mb, total_mb,
growth_avail_mb
Options specific to the VVSPACE type:
-usr_cpg <CPG_name|pattern>[,<CPG_name|pattern>...]
-snp_cpg <CPG_name|pattern[,<CPG_name|pattern>...]
-prov <prov_type>[,<prov_type>...]
-vv <VV_name|VV_set|pattern>[,<VV_name|VV_set|pattern>...]
-compr <Yes|No|Off|NA>
Fields applicable to the VVSPACE type:
userrawrsvd_mb, snaprawrsvd_mb, adminrawrsvd_mb, totalrawrsvd_mb,
userused_mb, userfree_mb, userrsvd_mb, snapused_mb, snapfree_mb, snaprsvd_mb,
adminused_mb, adminfree_mb, adminrsvd_mb, totalused_mb, totalrsvd_mb,
virtualsize_mb
Options specific to the SYSSPACE type:
-disk_type <type>[,<type>...]
Fields applicable to the SYSSPACE type:
total_mb, alloc_mb, used_mb, system_mb, free_mb, failed_mb, compact_ratio,
dedup_ratio, overprov_ratio
SPECIFIERS
<name>
Specifies the name of the criterion to modify.
<pattern>
Specifies alert criteria by matching their names as to the glob-style pattern. (For more information, issue
"clihelp sub,globpat" or see Glob-Style Patterns on page 15.) Requires the -pat option. May not be
combined with the -all option.
EXAMPLES
The following example disables the criterion called port_writes:
cli% setsralertcrit -disable port_writes
The following example removes the RPM filter from a PDSPACE criterion:
cli% setsralertcrit -rpm "" crit_name
394
Set Commands
The following example changes the threshold conditions of an existing criterion:
cli% setsralertcrit -condition read_iops>500~write_iops>800 pd_crit
The following example shows how to change the name of an existing criterion:
cli% setsralertcrit -name new_name crit_name
The following example changes the severity of a criterion to critical:
cli% setsralertcrit -critical crit_name
NOTES
Disabling or changing a criterion also automatically fixes all alerts associated with that criterion.
All options can be specified in any order.
Note that the criterion's TYPE cannot be changed.
Each option replaces the criterion's existing setting. For example -hourly option can change the frequency
of a -hires criteria and the -condition option will replace the existing condition(s).
Options that require a value can be cleared with a value of "". The -name and -condition options cannot
be cleared.
<condition>
The condition must be of the format <field><comparison><value> where field is one of the fields
corresponding to the type (see above), comparison is of the format <,<=,>,>=,=,!= and value is a numeric
value, or is a numeric value followed by %_average to indicate that the field is to be compared against the
average across multiple objects as as specified by filtering options and/or across multiple data sample
times as specified by the -btsecs option. See examples. Note that some characters, such as < and >, are
significant in most shells and must be escaped or quoted when running this command from another shell.
Multiple conditions may be separated by comma (",") to indicate a logical AND requirement (conjunction).
Conditions may be separated by the character "~" to indicate a logical OR requirement (disjunction). AND
logic takes precedence over OR logic, and parentheses are not supported to override the natural
precedence of the condition terms and logical operators.
setsshbanner
DESCRIPTION
The setsshbanner command sets the SSH banner that is displayed before the user logs in. This
command prompts for a new SSH banner. After finish entering the banner text, press ENTER. The
banner text provided by the user will be saved. To verify the banner, use the showsshbanner on page
537 command.
SYNTAX
setsshbanner
AUTHORITY
setsshbanner
395
•
•
Super
Any role granted the sshbanner_set right
OPTIONS
None.
SPECIFIERS
None.
EXAMPLES
To set an SSH banner, type "setsshbanner", then follow the instructions at the prompt:
cli% setsshbanner
NOTES
None.
setsshkey
DESCRIPTION
The setsshkey command sets the SSH public key for a user. The user will be prompted to provide an
SSH public key. To finish entering the public key, press enter on a blank line. The key must have been
generated using the ssh-keygen utility. The public key is contained in the user-defined file named
with .pub extension. The user can open this file with an ASCII editor to copy the key and paste it. After
setting an SSH public key on the storage system, the user can use the corresponding private key to log
on without a password. If the -add option is not given, this new key replaces the existing keys if any.
SYNTAX
setsshkey [options]
AUTHORITY
•
•
Super, Service, Edit, Browse
Any role granted the sshkey_set right
OPTIONS
-add
Specifies that the given key should be added to the list of authorized keys instead of replacing existing
ones.
SPECIFIERS
None.
EXAMPLES
To set a user's SSH public key just type "setsshkey" then follow the instructions at the prompt:
396
setsshkey
cli% setsshkey
Please enter the SSH public key below. When finished, press enter twice.
The key is usually long. It's better to copy it from inside an editor
and paste it here. (Please make sure there are no extra blanks.)
The maximum number of characters used to represent the SSH key
(including the "from" option, key type, and additional comments) is 4095.
ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAp+4Z3zT8Sq6t3s08q/MMd2ZnMpRc/3tyHMk63dH
R8b/VgV6ewXNfYhhfTGWRdZ1dtyLFXnuEPuf+z8EtinFStinTzA3FiJ0agK7rLoNtn/F0jBaGWm
SWukqzAQA2VJvq/keaLVMT3+J3nvXEUcjS4fApeeLwFgKczOX511oaHDtn2ys2C5l+mLw1VDUJL
wIKJljOWqr68ToeRgTDmoppOI3cG14ryF0re4xKANHFQLnSCt5ANjqD2jpnyEABuOvBX7G6vI5g
zQFfcAda/a2bq563/AHr8Ehhi5EVy+GSCqjj8cr0/zHSZyX6llQUfe0YxmayPEKlods6bDi5oxG
COw== user1@server1
NOTES
Issuing the setsshkey command results in the system prompting for your SSH public key. Copy and
paste the key using the aforementioned ASCII editor on the command line and then press ENTER.
After setting an SSH public key on the system, use the corresponding private key to log on without a
password. A single ssh key may be used for multiple hosts with a single use of setsshkey, or different
keys may be used for different hosts. To restrict the usage of a key to a particular host, a "from" option
can be added to the beginning of a key. For example:
from="192.168.1.1" ssh-rsa AAAAB3Nza...
The maximum number of characters used to represent the SSH key (including the "from" option, key type,
and additional comments) is 4095.
LDAP users are only allowed to set an SSH key if the setauthparam on page 303 command has been
used to set the allow-ssh-key parameter to 1. When an LDAP user runs the setsshkey command, the
user's role is recorded and is assigned when the user logs in using the key. Changes in the group-to-role
mappings set with the setauthparam on page 303 command or changes in the user's data in the LDAP
server have no effect as long as the user has an SSH key.
Removing the user's SSH key forces a new role to be determined at the user's next login.
Only one key may be entered at a time; to enter multiple keys, run setsshkey again with the -add
option.
setstatch
DESCRIPTION
The setstatch command starts and stops the statistics collection mode for chunklets.
SYNTAX
setstatch start|stop <LD_name> <chunklet_num>
SUBCOMMANDS
start|stop
Specifies that the collection of statistics is either started or stopped for the specified logical disk and
chunklet.
AUTHORITY
setstatch
397
•
•
Super, Edit
Any role granted the statch_set right
OPTIONS
None.
SPECIFIERS
<LD_name>
Specifies the name of the logical disk in which the chunklet to be configured resides.
<chunklet_num>
Specifies the chunklet that is configured using the setstatch command.
EXAMPLES
The following example displays the start of statistics collection on chunklet 0 of logical disk test:
cli% setstatch start test 0
NOTES
After the statistic collection mode for the chunklet is set, you can then use either the histch on page 202
command or the statch on page 693 command to view the chunklet's statistics.
setstatpdch
DESCRIPTION
The setstatpdch command sets the statistics collection mode for all in-use chunklets on a physical
disk.
SYNTAX
setstatpdch start|stop <PD_ID>
SUBCOMMANDS
start|stop
Specifies that the collection of statistics is either started or stopped for chunklets on the specified physical
disk used by logical disks.
AUTHORITY
•
•
Super, Edit
Any role granted the statpdch_set right
OPTIONS
None.
SPECIFIERS
<PD_ID>
Specifies the physical disk ID.
EXAMPLES
The following example displays the start of statistics collection on all physical disk chunklets of physical
disk 0:
398
setstatpdch
cli% setstatpdch start 0
NOTES
After the statistic collection mode for the chunklet is set, you can then use either the histch on page 202
command or the statch on page 693 command to view the chunklet's statistics.
setsys
DESCRIPTION
The setsys command sets properties of the system, including options to annotate a system with
descriptor information such as physical location, owner, contact information, etc. The command also
enables you to set system-wide parameters such as the raw space alert.
SYNTAX
setsys [options]
setsys <parameter>
AUTHORITY
•
•
Super, Service
Any role granted the sys_set right
OPTIONS
The following option is for changing the name of the system:
-name <systemname>
Specifies the new name of the system up to 31 characters in length.
The following options allow annotation of system with descriptor information:
-loc <location>
Specifies the location of the system.
-owner <owner>
Specifies the owner of the system.
-contact <contact>
Specifies the contact information for the system.
-comment <comment>
Specifies any additional information for the system.
-f
Forces the command. The command completes the process without prompting for confirmation.
SPECIFIERS
The following parameters can be configured on the system and are issued for the <parameter> specifier:
RawSpaceAlertFC <value>
Sets the user configurable space alert threshold (10 to 100000 GiB) for Fast Class type drives. When the
total space on the available chunklets (both clean and unclean) for the specified drive type falls below the
specified value, one of the four system standard alert levels may be posted.
The used space system standard alert levels are at 50%, 75%, 85%, and 95%.
setsys
399
The supplied space alert threshold is converted from GiB free to percentage used. If any of the system
standard alert levels are below this computed value, they will be suppressed.
A value of 0 will cancel the user-specified alert threshold and revert back to the system standard alerts of
50%, 75%, 85%, and 95%. To minimize the alerts, use the specified value of 10 (GiB).
The default <value> for RawSpaceAlertFC is 0.
RawSpaceAlertNL <value>
Performs the same function as RawSpaceAlertFC, but should be used for Nearline type drives.
RawSpaceAlertSSD <value>
Performs the same function as RawSpaceAlertFC, but should be used for Solid State Drive type drives.
RemoteSyslog <value>
Enables or disables sending events as syslog messages to both remote syslog servers. A value of 0
disables the logging, and a value of 1 enables logging. The syslog messages are sent with a facility user
and with event severities mapped to syslog priority levels as follows:
Table 7: Event severity
Event Severity
syslog Level
fatal
alert
critical
alert
major
crit
minor
err
degraded
warning
info
info
RemoteSyslogHost {{<hostname>|<IPv4>}[:<port>]|<IPv6>|[<IPv6>]:<port>},
{{<hostname>|<IPv4>}[:<port>]|<IPv6>|[<IPv6>]:<port>}, {{<hostname>|<IPv4>}
[:<port>]|<IPv6>|[<IPv6>]:<port>}
Sets the hostname or IP address and optionally the port of the remote syslog server to which general
events will be sent as syslog messages. When configuring the destination with both the IPv6 address and
port, please note that the IPv6 address must by encapsulated by square brackets. Up to three servers
can be specified by separating with commas.
If the port is not configured one of the following default ports will be used; 514 for UDP, 601 for TCP, 6514
for TLS. The status of the syslog servers may be seen by running "showsys -d".
RemoteSyslogSecurityHost {{<hostname>|<IPv4>}[:<port>]|<IPv6>|
[<IPv6>]:<port>}, {{<hostname>|<IPv4>}[:<port>]|<IPv6>|[<IPv6>]:<port>},
{{<hostname>|<IPv4>}[:<port>]|<IPv6>|[<IPv6>]:<port>}
Sets the hostname or IP address and optionally the port of the remote syslog server to which security
events will be sent as syslog messages. When configuring the destination with both the IPv6 address and
port, please note that the IPv6 address must by encapsulated by square brackets. Up to three servers
can be specified by separating with commas.
Security messages will only be sent over TLS. If the port is not configured port 6514 will be used. The
status of the syslog servers may be seen by running "showsys -d".
400
Set Commands
SparingAlgorithm <value>
Sets the sparing algorithm used by the admithw on page 71 command. Valid values are Default (roughly
2.5% with minimums), Minimal (roughly 2.5% without minimums), Maximal (one disk's worth in every
cage), and Custom (not managed automatically by the system).
VVRetentionTimeMax <time>{h|H|d|D}
Specifies the maximum value that can be set for the retention time of a volume. <time> is a positive
integer value and in the range of 0 - 43,800 hours (1825 days). Time can be specified in days or hours
providing either the "d" or "D" for day and "h" or "H" for hours following the entered time value. The default
value for <time> is 14 days.
To disable setting the volume retention time in the system, enter 0 for <time>.
UpgradeNote <value>
Sets a note that will be displayed when checkupgrade is run. To include spaces, enclose the value
inside double quotes. To erase an existing note, specify "". Maximum length is 127 characters.
PortFailoverEnabled {yes|no}
Enables or disables the automatic failover of target ports to their designated partner ports. If enabled,
automatic failover is triggered when a node goes down. The default is "yes".
AutoExportAfterReboot {yes|no}
Enables or disables automatically exporting vluns after a reboot. If disabled, vluns and host ports will not
become active after a reboot until "setsysmgr export_vluns" is issued. The default is "yes".
AllowWrtbackSingleNode <value>
Allow the system to continue caching when in a single node state up to the specified number of days.
Once passed that, all LDs will go into write-through. This does not include single node states that occur
as a result of an upgrade. <value> can be 0 to 7 days. The default is 0 which puts all LDs into writethrough immediately when in single node state.
AllowWrtbackUpgrade <value>
Allow the system to continue caching when in a single node state during an upgrade up to the specified
number of days. This does not include single node states that occur during a non-upgrade situation.
<value> can be 0 to 7 days. The default is 0 which puts all LDs into write-through immediately when in
single node state during an upgrade.
AllowR5OnFCDrives {yes|no}
Enables or disables support for RAID-5 on FC drives. If disabled, new RAID-5 CPGs cannot be created
on FC drives. HPE strongly recommends RAID-6 for FC drives. The default is "no".
AllowR5OnNLDrives {yes|no}
Enables or disables support for RAID-5 on NL drives. If disabled, new RAID-5 CPGs cannot be created
on NL drives. HPE strongly recommends RAID-6 for high capacity NL drives. The default is "no".
AllowR0 {yes|no}
Enables or disables support for RAID-0. If disabled, new RAID-0 CPGs cannot be created on this system.
RAID-0 virtual volumes do not offer data protection. The default is "no".
DisableDedup {yes|no}
New write requests to TDVVs serviced by the system will not be deduplicated if this parameter is set to
"yes". Setting this parameter to "no" will enable writes to TDVVs to be deduplicated. The default is "no".
EventLogSize <value>
Set Commands
401
Sets the size of the event log. The range is 0.5 MB to 4 MB and the default value is 4 MB. This sets the
size of the individual files; 11 of those files are retained. When the current most recent file hits this size,
the oldest file is removed.
SessionTimeout <time>[h|m]
Specifies the value that can be set for the idle session timeout for a CLI session. <time> is a positive
integer value and in the range of 180 seconds (3 minutes) - 86399 seconds (23:59:59 hours). Time can
be specified in hours, minutes or seconds providing "h" or "m" and just the value for the number of
seconds. Note that, when entering the value in seconds, "s" should not be used.
The default value for <time> is 60 minutes (1 hour).
HostDIF {yes|no}
Enables or disables HPE 3PAR implementation of host based Data Integrity Field (DIF) support for all
ports (FC only). This will only affect VVs which have their host DIF policy set to "3par_host_dif". The
default value is "yes" on systems capable of DIF.
HostDIFTemplate <value>
Sets the default host DIF settings to be used by the createvv command. <value> can be "no_host_dif" (no
support for host DIF), "3par_host_dif" (HPE 3PAR implementation of DIF) or "std_host_dif" (standard
SCSI implementation of DIF). The default value is "3par_host_dif" on systems capable of DIF. Note that
the host DIF support is available on FC ports only.
ComplianceOfficerApproval {yes|no}
Specifies whether to enable or disable the compliance officer approval mode.
OverprovRatioWarning <value>
Specifies an overprovisioning ratio, which when exceeded by the system, a device type, or a CPG, results
in a warning alert. A ratio of 0 (default) means no warning alert is generated. A ratio of 3 means that there
is 3 times the size virtually available than what is physically available. Note that this will be different
across each CPG and for the system as a whole.
OverprovRatioLimit <value>
Specifies that the system, device types, and all CPGs are limited to the specified overprovisioning ratio. A
ratio of 0 (default) means no limit is enforced. A ratio of 3 means that there is 3 times the size virtually
available than what is physically available. Note that this will be different across each CPG and for the
system as a whole.
DisableCompr <value>
New write requests to the Compressed VVs serviced by the system will not be compressed if this
parameter is set to "yes". Setting this parameter to "no" will enable writes to the Compressed VVs to be
compressed. <value> can be "yes" or "no". The default is "no".
RemoteCopyHostThrottling {yes|no}
Enables or disables Remote Copy throttling policy for host IO replicated in asynchronous streaming
mode. As Remote Copy resources approach the maximum limits on systems where
RemoteCopyHostThrottling is set to "yes" then host IO that is replicated to asynchronous streaming
groups are subjected to active host IO management to reduce resource consumption and prevent some
or all groups from becoming suspended.
When the policy is set to "no" then host IO replicated to asynchronous streaming groups will not be
subjected to any active host IO management which may result in some or all Remote Copy groups
becoming suspended sooner.
When the Remote Copy resources reach maximum limits some or all Remote Copy groups may be
suspended until system resources become available once more.
This default is "no", for no throttling.
402
Set Commands
EXAMPLES
The following example displays setting a raw space alert of 800 gigabytes:
cli% setsys RawSpaceAlertFC 800
cli% showsys -param
System parameters from configured settings
----Parameter-------Value---RawSpaceAlertFC
:
800
RawSpaceAlertNL
:
0
RemoteSyslog
:
1
RemoteSyslogHost
:
192.168.6.15
SparingAlgorithm
:
Minimal
CopySpaceReclaim
:
0
EventLogSize
:
4M
VVRetentionTimeMax
:
336 Hours
The following example displays setting EventLogSize to 2MB:
cli% setsys EventLogSize 2
The following examples demonstrate setting the timeout in hours, minutes and seconds:
NOTE:
The value in seconds requires no "s" suffix.
cli% setsys SessionTimeout 4h
cli% setsys SessionTimeout 10m
cli% setsys SessionTimeout 240
The following examples demonstrate setting RemoteSyslogHost with a port:
cli%
cli%
cli%
cli%
8080
setsys
setsys
setsys
setsys
RemoteSyslogHost
RemoteSyslogHost
RemoteSyslogHost
RemoteSyslogHost
https://example.com:8080
127.0.0.1:8080
[2620:0:a04:1120:15:252:204:235]:8080
127.0.0.1:8080,127.0.0.2,https://example.com:
NOTES
Access to all domains is required to run this command.
Use the "showsys -param" command to see the current settings of the above values (see the showsys
on page 539 command).
setsysmgr
DESCRIPTION
The setsysmgr command sets the system manager startup state.
SYNTAX
The syntax of the setsysmgr command can be one of the following:
setsysmgr [option] wipe <system_name>
setsysmgr
403
setsysmgr [option] tocgen [<toc_gen_number>]
setsysmgr [option] force_iderecovery
setsysmgr [option] force_idewipe
setsysmgr [option] export_vluns
SUBCOMMANDS
wipe
Requests that the specified system be started in the new system state.
CAUTION:
If this option is used, critical warning messages may be missed!
tocgen
Specifies that the system is to be started with the specified table of contents generation number.
force_iderecovery
Specifies that the system starts the recovery process from the IDE disk even if all virtual volumes have
not been started.
force_idewipe
Specifies that the system wipes the IDE power fail partition. The system is shutdown and restarted, during
which time all logical disks and virtual volumes are checked.
export_vluns
If the AutoExportAfterReboot option has been set to no, after a power failure or uncontrolled shutdown
vluns will not be automatically exported, and host ports will be in a suspended state. This command will
re-export the luns and enable the host ports after this happens.
AUTHORITY
•
•
Super
Any role granted the sysmgr_set right
OPTIONS
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
WARNING:
This option will result in the loss of data and configuration info.
SPECIFIERS
<system_name>
Specifies the name of the system to be started, using up to 31 characters.
<toc_gen_number>
Specifies the table of contents generation number for the system to start with.
EXAMPLES
The following example starts system "mysystem" in the new system state:
404
Set Commands
cli% setsysmgr wipe mysystem
The following example starts a system's powerfail recovery despite being unable to start one or more
volumes:
cli% setsysmgr force_iderecovery
NOTES
Access to all domains is required to run this command.
Issuing the setsysmgr command can potentially remove the entire state of the system causing data
loss.
Use this command only when the system cannot start up normally.
If the wipe subcommand is specified, all system data and configuration information including customer
data and virtual volume layout are destroyed.
If the force_iderecovery subcommand is specified, the system can delete data for some of the unstarted
virtual volumes. The system can run the checkvv on page 93 and checkld on page 86 commands to
make the virtual volumes and logical disks consistent, thereby resulting in a possible data loss.
settask
DESCRIPTION
The settask command sets the priority on specified task.
SYNTAX
settask [-f] -pri <high|med|low> <task_ID>
AUTHORITY
•
•
Super, Edit
Any role granted the task_set right
OPTIONS
-f
Forces the command. The command completes the process without prompting for confirmation.
-pri <high|med|low>
Specifies the priority of the task.
SPECIFIERS
<task_ID>
Sets the priority on a task specified by the task ID.
The <task_ID> must be an unsigned integer from 1 to 29999.
EXAMPLES
The following example shows how to set a priority on a task using the task ID:
settask
405
cli% settask -pri high 497
Are you sure you want to set priority on task 497?
select q=quit y=yes n=no: y
high priority is set on task id: 497
NOTES
Currently, only physical copy, promotesv, and importvv tasks are supported.
Setting priority on other types of tasks will result in an error. Task priorities can only be set one at a time. If
the specified task is not active or valid, it will result in an error.
settemplate
DESCRIPTION
The settemplate command modifies the properties of existing templates.
SYNTAX
settemplate <option_value>... [option <arg>] <template_name>
AUTHORITY
•
•
Super
Any role granted the template_set right
OPTIONS
-remove <option>...
Indicates that the option(s) that follow -remove are removed from the existing template. When specifying
an option for removal, do not specify the option's value. For valid options, see the createtemplate on
page 173 command.
SPECIFIERS
<option_value>...
Indicates the specified options and their values (if any) are added to an existing template. The specified
option replaces the existing option in the template. For valid options, see the createtemplate on page
173 command.
<template_name>
Specifies the name of the template to be modified, using up to 31 characters.
EXAMPLES
In the following example, template vvtemp1 is modified to support the availability of data should a drive
magazine fail (mag) and to use the the stale_ss policy:
cli% settemplate -ha mag -pol stale_ss vvtemp1
In the following example, the -nrw and -ha mag options are added to the template template1, and the -t
option is removed:
406
settemplate
cli% settemplate -nrw -ha mag -remove -t template1
NOTES
Access to all domains is required to run this command.
The -desc option cannot be removed from a template (it can be changed to an empty string).
The -nrw and -nro options cannot be removed from a template. These options can only be replaced by
specifying either -nrw or -nro before the -remove option.
All options available for the createcpg on page 126 command can be used with the settemplate
command to modify an existing template.
Options preceded with -remove are removed from an existing template.
When adding options to a template, specify the option flag and its value (if any).
When removing options from a template, specify the option flag only.
setuser
DESCRIPTION
The setuser command sets the user properties.
SYNTAX
setuser [options] <user>
AUTHORITY
•
•
•
Super, Edit, Browse
Any role granted the user_setany right can add, remove, and set default domains for any user.
Any role granted the user_setown right can only set their own default domain.
OPTIONS
-f
Specifies that the command is forced. No confirmation is requested before executing the command.
-adddomain <domain>:<role>[,<domain>:<role>...]
Adds a specified user (<user>) to the specified domain (<domain>) at the specified role (<role>). Super,
audit, and service roles are not allowed.
-rmdomain <domain_name_or_pattern>[,<domain_name_or_pattern>...]
Remove the user from each domain with a name that matches one or more of the
<domain_name_or_pattern> options.
-defaultdomain <domain>
Changes the default domain of the user to a specified domain. You must already have permission set in
the domain. Specify "-unset" as the domain name to unset the default domain. The Browse and Edit
authorities for this command and option can be used by any user with their own user name.
SPECIFIERS
<user>
Specifies the name of the user.
EXAMPLES
setuser
407
In the following example, user 3paruser is permitted edit role in the domain Engineering:
cli% setuser -adddomain Engineering:edit 3paruser
NOTES
The -adddomain and -rmdomain options cannot be used on a user that is currently logged in. Existing
sessions can be terminated with the removeuserconn on page 281 command.
"-defaultdomain all" is not valid to reset the default domain of the user.
The setuser command cannot be used with audit users.
The CO role cannot be added to a single domain and must always be present in "all" domains. A user
with CO role can be given only browse role. Only a user with browse role can be given a CO role. Browse
role should be always in a specific domain in order to coexist along with the CO role.
setuseracl
DESCRIPTION
The setuseracl command sets the Access Control List (ACL).
SYNTAX
setuseracl [options] <user_name> <operation> <name_or_pattern>...
AUTHORITY
•
•
Super, Edit
Any role granted the useracl_set right
OPTIONS
-add
Adds names or patterns of objects at the end of an existing ACL.
-remove
Removes names or patterns of objects from an ACL.
SPECIFIERS
<user_name>
Specifies the name of the user whose ACL is being set.
<operation>
Specifies the operation for which the ACL is being defined.
The only value currently accepted is updatevv, which updates a snapshot with a new snapshot.
<name_or_pattern>...
Specifies a space-separated list of names or patterns of objects on which the operation (as specified by
the <operation> argument) is performed.
The object type is dependent on the specified operation. For example, the objects or names specified for
the updatevv operation are virtual volume names.
This specifier is required. If an empty string is specified without any option, then any existing ACL for the
<user_name>, <operation> is removed.
EXAMPLES
408
setuseracl
The following example sets the ACL for user testuser1 and allows testuser1 to update the snapshot
virtual volumes of virtual volumes vv1 and vv2:
cli% setuseracl testuser1 updatevv vv1 vv2
The following example shows how to add vv3 and vv4 to the ACL for user testuser1:
cli% setuseracl -add testuser1 updatevv vv3 vv4
The following example shows how to remove vv3 from the ACL for user testuser1:
cli% setuseracl -remove testuser1 updatevv vv3
The following example shows how to clear the ACL for user testuser1:
cli% setuseracl testuser1 updatevv ""
NOTES
The -add and -remove options are mutually exclusive.
If the names or pattern of objects to add already exist, the request is ignored.
If the names or pattern of objects to remove do not exist, the request is ignored.
setuseracl cannot be used with audit users.
setvasa
DESCRIPTION
The setvasa command sets properties of the VASA Provider server, including the option to reset the
VASA SSL signed certificate to a self-signed one so that the VASA Provider can be re-registered with a
different VMware vCenter.
SYNTAX
setvasa [options]
AUTHORITY
•
•
Super, Service
Any role granted the vasa_set right
OPTIONS
-f
Forces the operation of the setvasa command, bypassing the typical confirmation message.
-reset
setvasa
409
If the VASA Provider certificate management mode (see -certmgmt option) is set to client, this option will
reset VASA SSL certificate to a new self-signed certificate. This option will also, regardless of certificate
management mode, remove all trusted vSphere client certificates. The VASA provider server will be
restarted after the self-signed certificate is created and/or trusted certificates are removed. This option will
cause all operations between the VASA Provider and the vSphere environment to cease, until the VASA
Provider is re-registered in vCenter.
-certmgmt {server|client}
Specifies if the VASA provider should allow management of its SSL certificate by the vSphere
infrastructure, or be locally managed on the array. If set to "client", vSphere will take over management of
the VASA provider's certificate. However, only one vSphere infrastructure may use this VASA Provider. If
set to "server", the array certificate management tools may be used. See createcert on page 124 for
additional information.
SPECIFIERS
None.
EXAMPLES
To reset VASA Provider certificate:
cli% setvasa -reset
WARNING: The VASA Provider server is enabled and will be restarted.
Are you sure you want to continue (y/n)? y
NOTES
Access to all domains is required to run this command.
When the VASA Provider server is enabled, you will be prompted for confirmation before continuing.
setvfs
DESCRIPTION
The setvfs command allows modification of the specified virtual file server (VFS).
SYNTAX
setvfs [options] <vfs>
AUTHORITY
•
•
Super, Edit
Any role granted vfs_set right
OPTIONS
Only one of the following certificate options can be specified:
410
•
-certfile <certfile>
•
Use the certificate data contained in this file.
-certdata <certificate string>
•
Use the certificate data contained in this string.
-certgen
•
Generates and sets a certificate for the VFS.
-rmcert
setvfs
Remove the certificate from the VFS.
-fpg <fpgname>
The name of the file provisioning group (FPG) to which the VFS belongs.
-comment <comment_text>
Specifies any additional textual information.
-bgrace <bgrace>
Specifies the block grace time in seconds for quotas within the VFS.
-igrace <igrace>
Specifies the inode grace time in seconds for quotas within the VFS.
SPECIFIERS
<vfs>
The name of the VFS to be modified.
EXAMPLES
The following example modifies the comment assigned to examplevfs:
cli% setvfs -comment "An example comment." examplevfs
NOTES
Access to all domains is required to run this command.
Grace times are specified in seconds.
Certificates must be in PEM format, containing both public and private keys.
setvv
DESCRIPTION
The setvv command changes the properties associated with a virtual volume. Use the setvv to modify
volume names, volume policies, allocation warning and limit levels, and the volume's controlling common
provisioning group (CPG).
SYNTAX
setvv [options <arg>] <VV_name|pattern>...
AUTHORITY
•
•
•
•
Super, Edit
Any role granted the vv_set right can edit the properties of base volumes
Any role granted the vvcopy_set right can edit the properties of physical copies of volumes
Any role granted the sv_set right can edit the properties of virtual copies of volumes
OPTIONS
-name <newname>
Specifies that the name of the virtual volume be changed to a new name ( as indicated by the
<new_name> specifier) that uses up to 31 characters.
-wwn <new_wwn>
setvv
411
Specifies that the WWN of the virtual volume be changed to a new WWN as indicated by the <new_wwn>
specifier. If <new_wwn> is set to "auto", the system will automatically choose the WWN based on the
system serial number, the volume ID, and the wrap counter. This option is not allowed for the admitted
volume before it is imported, or while the import process is taking place.
Only one of the following options can be specified:
•
-udid <Udid_Val>
•
Specifies the user defined identifier for VVs for OpenVMS hosts. Udid value should be between 0 to
65535 and can be identical for several VVs.
-clrrsv
•
Specifies that all reservation keys (i.e. registrations) and all persistent reservations on the virtual
volume are cleared.
-clralua
Restores ALUA state of the virtual volume to ACTIVE/OPTIMIZED state.
In ACTIVE/OPTIMIZED state hosts will have complete access to the volume.
-exp <time>{d|D|h|H}
Specifies the relative time from the current time that volume will expire. <time> is a positive integer value
and in the range of 0 - 43,800 hours (1825 days). Time can be specified in days or hours providing either
the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
To remove the expiration time for the volume, enter 0 for <time>.
-comment <comment>
Specifies any additional information up to 511 characters for the volume. Use -comment "" to remove the
comments.
-f
Do not ask for confirmation before setting or modifying volumes with retention time (-retain) or modifying
the host DIF policy (-pol xxx_host_dif).
-retain <time>{d|D|h|H}
Specifies the amount of time, relative to the current time, that the volume will be retained. <time> is a
positive integer value and in the range of 1 - 43,800 hours (1825 days). Time can be specified in days or
hours providing either the 'd' or 'D' for day and 'h' or 'H' for hours following the entered time value.
NOTE:
If the volume is not in any domain, then its retention time cannot exceed the value of the system's
VVRetentionTimeMax. The default value for the system's VVRetentionTimeMax is 14 days. If the
volume belongs to a domain, then its retention time cannot exceed the value of the domain's
VVRetentionTimeMax, if set. The retention time cannot be removed or reduced once it is set. If the
volume has its retention time set, it cannot be removed within its retention time. If both expiration
time and retention time are specified, then the retention time cannot be longer than the expiration
time.
This option requires the HPE 3PAR Virtual Lock license. Contact your local service provider for
more information.
-pol <policy>[,<policy>...]
Specifies the following policies that the created virtual volume follows.
If an argument is not specified, the option defaults to stale_ss.
412
Set Commands
•
•
•
•
•
•
•
•
•
stale_ss—Specifies that invalid snapshot volumes are permitted. Failure to update snapshot data does
not affect the write to the base volume, but the snapshot is considered invalid.
no_stale_ss—Specifies that invalid snapshot volumes are not permitted. Failure to update a snapshot
is considered a failure to write to the base volume.
one_host—This constrains the export of a volume to one host or one host cluster (when cluster names
may be used as a host name).
no_one_host—This policy should only be used when exporting a virtual volume to multiple hosts for
use by a cluster-aware application, or when "port presents" VLUNs are used. This is the default policy
setting.
3par_host_dif—This policy enables support for 3PAR implementation of host based DIF.
std_host_dif—This policy enables support for standard SCSI implementation of host based DIF.
no_host_dif—This policy disables support for host DIF.
zero_detect—This policy enables the storage system to scan for zeros in the incoming write data. This
feature when used during physical copy to a TPVV will avoid allocating space for blocks containing
zero. This feature when used with a Thin Persistence license will reclaim allocated space when zero
blocks are written to the TPVV. This policy is only applicable for the base TPVV.
no_zero_detect—This policy disables the storage system to scan for zeros in the incoming write data
to reclaim allocated space on the volume. This is the default policy setting.
-snp_cpg <snp_cpg>
Specifies that the volume snapshot space is to be provisioned from the specified CPG. If no snp_cpg is
currently defined, or no snapshots exist for the volume, the snp_cpg may be set to any CPG. If snapshots
exist the snp_cpg may only be changed if the current snp_cpg is part of an AOCFG, and only to another
CPG in the AOCFG.
-snp_aw <percent>
Enables a snapshot space allocation warning. A warning alert is generated when the reserved snapshot
space of the VV exceeds the indicated percentage of the VV size.
-snp_al <percent>
Sets a snapshot space allocation limit. The snapshot space of the VV is prevented from growing beyond
the indicated percentage of the virtual volume size.
The following options can only be used on fully provisioned volumes:
-usr_cpg <usr_cpg>
Specifies that the volume user space is to be provisioned from the specified CPG. The usr_cpg of a VV
can only be changed if its existing usr_cpg is in an AOCFG, and the target CPG is in the same AOCFG.
The following options can only be used on thinly provisioned volumes:
-usr_aw <percent>
This option enables user space allocation warning. Generates a warning alert when the user data space
of the TPVV exceeds the specified percentage of the virtual volume size.
-usr_al <percent>
Indicates the user space allocation limit. The user space of the TPVV is prevented from growing beyond
the indicated percentage of the virtual volume size. After this limit is reached, any new writes to the virtual
volume will fail.
-spt <sectors_per_track>
Defines the virtual volume geometry sectors per track value that is reported to the hosts through the SCSI
mode pages. The valid range is between 4 to 8192 and the default value is 304.
-hpc <heads_per_cylinder>
Allows you to define the virtual volume geometry heads per cylinder value that is reported to the hosts
though the SCSI mode pages. The valid range is between 1 to 255 and the default value is 8.
Set Commands
413
SPECIFIERS
<vvname|pattern>
Specifies the virtual volume name or all virtual volumes that match the pattern specified, using up to 31
characters. The patterns are glob- style patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.) Valid characters include alphanumeric characters, periods, dashes,
and underscores.
EXAMPLES
The following example sets the policy of virtual volume vv1 to no_stale_ss:
cli% setvv -pol no_stale_ss vv1
Use the command to change the name:
cli% setvv -name newtest test
The following example modifies the WWN of virtual volume vv1:
cli% setvv -wwn 50002AC0001A0024 vv1
The following example modifies the udid value for virtual volume vv1:
cli% setvv -udid 1715 vv1
NOTES
At least one option must be specified.
To view policies assigned to the system's virtual volumes, issue the showvv -pol command (see the
showvv on page 558 command).
It is not possible to rename a virtual volume that is already associated with a Remote Copy group.
Changing the usr_cpg or snp_cpg of a VV only changes where new allocations occur, and does not move
any existing allocations.
The snp_cpg and usr_cpg can only be set for a base VV.
See the HPE 3PAR Command Line Interface Administrator Guide for instructions on creating CPGs and
volumes.
setvvolsc
DESCRIPTION
setvvolsc can be used to create and remove storage containers for VMware Virtual Volumes (VVols).
VVols are managed by the vSphere environment, and storage containers are used to maintain a logical
collection of them. No physical space is pre-allocated for a storage container. In the HPE 3PAR OS,
special VV sets (see showvvset on page 572) are used to manage VVol storage containers.
414
setvvolsc
SYNTAX
setvvolsc [options] set:<vvset>
AUTHORITY
•
•
Super, Edit
Any role granted the vvset_set right
OPTIONS
-create
An empty existing <vvset> not already marked as a VVol Storage Container will be updated. The VV set
should not contain any existing volumes (see -keep option below), must not be already marked as a
storage container, nor may it be in use for other services, such as for remote copy groups, QoS, etc.
-remove
If the specified VV set is a VVol storage container, this option will remove the VV set storage container
and remove all of the associated volumes. The user will be asked to confirm that the associated volumes
in this storage container should be removed.
-keep
Used only with the -create option. If specified, allows a VV set with existing volumes to be marked as a
VVol storage container. However, this option should only be used if the existing volumes in the VV set are
VVols.
-f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
SPECIFIERS
<vvset>
The Virtual Volume set (VV set) name, which is used, or to be used, as a VVol storage container.
EXAMPLES
The following example can be used to create a new VVol storage container, known as FinanceTeam:
cli% createvvset FinanceTeam
cli% setvvolsc -create set:FinanceTeam
The following example can be used to remove an existing VVol storage container, and all its associated
volumes:
cli% setvvolsc -remove set:FinanceTeam
Are you sure you wish to remove the FinanceTeam storage container and
all its associated volumes? (y/n): y
cli% removevvset -f FinanceTeam
NOTES
None.
Set Commands
415
setvvset
DESCRIPTION
The setvvset command sets the parameters and modifies the properties of a Virtual Volume(VV) set.
SYNTAX
setvvset [options <arg>] <setname>
AUTHORITY
•
•
•
Super, Edit
Any role granted the vvset_annotate right can only annotate the comment of a volume set
Any role granted the vvset_set right can set any volume set property
OPTIONS
-comment <comment>
Specifies any comment or additional information for the set. The comment can be up to 255 characters
long. Unprintable characters are not allowed.
-name <newname>
Specifies a new name for the VV set using up to 27 characters.
SPECIFIERS
<setname>
Specifies the name of the vv set to modify.
EXAMPLES
To rename a set from foo to bar:
cli% setvvset -name bar foo
To change the comment on a set bar:
cli% setvvset -comment "This used to be set foo" bar
NOTES
None.
setwsapi
DESCRIPTION
The setwsapi command sets properties of the Web Services API server, including options to enable or
disable the HTTP and HTTPS ports.
SYNTAX
setwsapi [options]
AUTHORITY
416
setvvset
•
•
Super, Service
Any role granted the wsapi_set right
OPTIONS
-f
Forces the operation of the setwsapi command, bypassing the typical confirmation message.
At least one of the following options are required:
-httpenable | disable
Enables or disables the HTTP port.
-https enable | disable
Enables or disables the HTTPS port.
-timeout <value>
Specifies the value that can be set for the idle session timeout for a WSAPI session. <value> is a positive
integer and in the range of 3-1440 minutes or (3 minutes to 24 hours). Changing the session timeout
takes effect immediately and will affect already opened and subsequent WSAPI sessions.
The default timeout value is 15 minutes.
SPECIFIERS
None.
EXAMPLES
To disable the HTTPS port:
cli% setwsapi -https disable
WARNING: The Web Services API server is active and will restart.
Are you sure you want to continue (y/n)? y
NOTES
Access to all domains is required to run this command.
You cannot disable both of the HTTP and HTTPS ports.
When the Web Services API server is active, a warning message showing the current status of the Web
Services API server is displayed and you will be prompted for confirmation before continuing. The -f
option forces the action without a warning message and prompt.
Setting the session timeout alone is not service affecting and will not restart the WSAPI server. However,
if the timeout option is specified along with service affecting options like -https or -http the WSAPI server
will restart.
Set Commands
417
Show Commands
showalert
DESCRIPTION
The showalert command displays the status of system alerts. When issued without options, all new
customer alerts are displayed.
SYNTAX
showalert [options]
AUTHORITY
•
Any role in the system
OPTIONS
The selection of alerts to be displayed is controlled by selecting one of the following options:
-n
Specifies that only new customer alerts are displayed.
This is the default.
-a
Specifies that only acknowledged alerts are displayed.
-f
Specifies that only fixed alerts are displayed.
-all
Specifies that all customer alerts are displayed.
The format of the alert display is controlled by the following options:
-d
Specifies that detailed information is displayed. Cannot be specified with the -oneline option.
-oneline
Specifies that summary information is displayed in a tabular form with one line per alert. For customer
alerts, the message text will be truncated if it is too long unless the -wide option is also specified.
-svc
Specifies that only service alerts are displayed. This option can only be used with the -d or -oneline
formatting options.
-wide
Do not truncate the message text. Only valid for customer alerts and if the-oneline option is also
specified.
SPECIFIERS
None.
EXAMPLES
The following example displays new customer alerts on a system:
418
Show Commands
cli% showalert -n
Id
State
Message Code
Time
Severity
Type
Message
:
:
:
:
:
:
:
1
New
0x2200de
2015-07-17 20:14:29 PDT
Degraded
Component state change
Node 0, Power Supply 1, Battery 0 Degraded (Unknown)
Id
State
Message Code
Time
Severity
Type
Message
:
:
:
:
:
:
:
1
New
0x2200de
2008-07-17 20:14:29 PDT
Degraded
Component state change
Node 0, Power Supply 1, Battery 0 Degraded (Unknown)
2 alerts
NOTES
Without any options, the showalert command displays all customer alerts in the New state.
Set the status of alerts by issuing the setalert on page 301 command.
Alerts can be removed by issuing the removealert on page 248 command.
showaocfg
DESCRIPTION
The showaocfg command shows Adaptive Optimization (AO) configurations in the system.
SYNTAX
showaocfg [options <arg>] [<AOCFG_name>...|<pattern>...]
AUTHORITY
•
Any role in the system
OPTIONS
-domain <domain_name_or_pattern,...>
Shows only AO configurations that are in domains with names matching one or more of the
<domain_name_or_pattern> argument. This option does not allow listing objects within a domain of which
the user is not a member. Patterns are glob-style (shell-style) patterns. (For more information, issue
"clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
SPECIFIERS
[<AOCFG_name>...|<pattern>...]
Specifies that AO configurations matching either the specified AO configuration name or those AO
configurations matching the specified pattern are displayed. This specifier can be repeated to display
information for multiple AO configurations. If not specified, all AO configurations in the system are
displayed.
EXAMPLES
showaocfg
419
Use the following to get a description of each column:
clihelp -col showaocfg
NOTES
AO will limit the space utilization of a CPG to the lowest of: max, warn, or limit. If none of these values is
set for the AOCFG tier or CPG, then AO will only be bounded by the available raw space of the CPG
characteristics.
showauthparam
DESCRIPTION
The showauthparam command shows authentication parameters.
SYNTAX
showauthparam
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
None.
EXAMPLES
The following is example output from the showauthparam command:
cli% showauthparam
Param
ldap-server
ldap-server-hn
binding
sasl-mechanism
kerberos-realm
accounts-dn
account-obj
account-name-attr
memberof-attr
edit-map
browse-map
domain-name-attr
group-obj
domain-name-prefix
-----------------Value----------------xxx.xxx.xx.xx
domaincontroller.work.com
sasl
GSSAPI
NTDOM1.work.COM
OU=Users,DC=work,DC=com
user
sAMAccountName
memberOf
CN=Software,CN=Users,DC=work,DC=com
CN=Eng,CN=Users,DC=work,DC=com
description
group
!InServDomain=
NOTES
The authentication parameters are set by setauthparam command. See the setauthparam on page
303 command for more information about the authentication parameters.
420
showauthparam
showbattery
DESCRIPTION
Displays battery status information such as serial number, expiration date and battery life, which could be
helpful in determining battery maintenance schedules.
SYNTAX
showbattery [options] [<node_ID> ...]
showbattery -listcols
AUTHORITY
•
Any role in the system
OPTIONS
-listcols
List the columns available to be shown with the -showcols option described below (issue 'clihelp -col
showbattery' for help on each column).
-showcols <column>[,<column>...]
Explicitly select the columns to be shown using a comma-separated list of column names. For this option,
the full column names are shown in the header.
Issue 'showbattery -listcols' to list the available columns.
-d
Specifies that detailed battery information, including battery test information, serial numbers, and
expiration dates, is displayed.
-log
Show battery test log information. This option is not supported on HPE 3PAR 7000 nor on HPE 3PAR
8000 series systems.
-i
Show battery inventory information.
-state
Show detailed battery state information.
-s
This is the same as -state.
This option is deprecated and will be removed in a future release.
-svc
Displays inventory information with HPE serial number, spare part etc.
This option must be used with -i option and it is not supported on HPE 3PAR 10000 systems
SPECIFIERS
<node_ID>...
Displays the battery information for the specified node ID(s). This specifier is not required. Node_ID is an
integer from 0 through 7.
EXAMPLES
The following example displays battery status information:
showbattery
421
cli%
Node
Testing
0
1
2
3
showbattery
Assem_Serial -State- -Service_LED- ChrgLvl(%) -ExpDate-- Expired
00000028
00000046
00000120
00000123
OK
OK
OK
OK
Off
Off
Off
Off
100
100
100
100
03/08/2020
03/09/2020
03/12/2020
03/12/2020
No
No
No
No
No
No
No
No
The following example displays detailed battery information:
cli% showbattery -d
--------------Node 0 PS 0 Battery 0--------------Node ID
:
0
Power Supply ID
:
0
Battery ID
:
0
Manufacturer
:
MAG
Model
:
0800-0016-50.0B
Serial Number
:
70315366
State
:
OK
Charge State
:
FullyCharged
Charge Level(%)
:
100
Max Battery Life(mins) :
25
Expired
:
No
Test in Progress
:
No
Expiration Date
:
03/08/2020
The following example displays the inventory information for the battery using the showbattery -i
command:
cli% showbattery -i
Node PS Bat -Manufacturer0 0 0 -0 1 0 -1 0 0 -1 1 0 --
-Model-----
-SerialFFFFFFFF
FFFFFFFF
---
The following example displays the battery test log information using the showbattery -log command:
422
Show Commands
cli% showbattery -log
Node Test Result Dur(mins) ---------Time---------0
0 Passed
1 2015-04-14 12:12:23 MDT
0
1 Passed
3 2015-04-15 09:18:36 MDT
0
2 Passed
3 2015-04-16 08:02:57 MDT
0
3 Passed
3 2015-04-21 07:03:32 MDT
0
4 Passed
3 2015-04-22 07:04:34 MDT
0
5 Passed
1 2015-04-24 07:53:04 MDT
0
6 Passed
1 2015-07-01 08:45:23 MDT
0
7 Passed
1 2015-05-07 10:32:13 MDT
0
8 Passed
1 2015-05-22 06:39:54 MDT
0
9 Passed
1 2015-06-05 06:41:14 MDT
1
0 Passed
1 2015-04-14 12:13:24 MDT
1
1 Passed
3 2015-04-15 09:18:37 MDT
1
2 Passed
3 2015-04-16 08:02:57 MDT
1
3 Passed
3 2015-04-21 07:03:31 MDT
1
4 Passed
3 2015-04-22 07:04:34 MDT
1
5 Passed
1 2015-04-24 07:53:14 MDT
1
6 Passed
1 2015-06-19 08:44:07 MDT
1
7 Passed
1 2015-05-07 10:09:12 MDT
1
8 Passed
1 2015-05-22 06:40:55 MDT
1
9 Passed
1 2015-06-05 06:42:15 MDT
The following example displays the detailed status of the battery using the showbattery -s command:
cli% showbattery -state
Node PS Bat -State- -Detailed_State0 0
0 OK
Normal
0 1
0 OK
Normal
1 0
0 OK
Normal
1 1
0 OK
Normal
Use the following to get a description of each column in the above examples:
clihelp -col showbattery
NOTES
Battery information is set by issuing the setbattery on page 308 command.
showblock
DESCRIPTION
The showblock command displays block mapping information for virtual volumes, logical disks, and
physical disks.
SYNTAX
showblock [options <arg>] <dev> <block> [<eblock>]
showblock
423
AUTHORITY
•
Any role in the system
OPTIONS
-d
Specifies that detailed information is displayed for the specified device and block.
SPECIFIERS
<dev>
The <dev> specifier is specified as one of the following arguments:
•
vv <VV_name> usr|snp|adm
•
Specifies the virtual volume name and the area (usr, snp, or adm) of that volume for the block mapping
information to be displayed.
ld <LD_name>
•
Specifies the logical disk name.
pd <PD_ID>
Specifies the ID of the physical disk.
<block>
Specifies the 512 byte block number on the specified device.
[<eblock>]
Specifies an end range when used with the <block> specifier. Additional mapping for blocks at the start of
each device mapping boundary for the range indicated by <block> and <eblock> is displayed. This
specifier is optional.
EXAMPLES
The following example displays block mapping information for block 0 in the user space of virtual volume
admin:
cli% showblock vv admin usr 0
VVname Spc
VVBlock
LDname
LDBlock PDid Chnk
PDblock
admin usr 0x00000000
admin.usr.0 0x00000000
88
0 0x00080000
=
=
=
= 0x00000000
58
0 0x00080000
The following example displays detailed block mapping information for block 0 in the user space of virtual
volume admin:
cli% showblock –d vv admin usr 0
VV/LD
Name
Block
Region
VV usr:
admin 0x00000000 0x00000000–0x0007FFFF (0–256MB)
LD
:
admin.usr.0 0x00000000 0x00000000–0x0007FFFF (0–256MB)
PD Chnk
PDStep
Block
LDStep
88
0 0x00080000–0x000801FF 0x00080000 0x00000000–0x000001FF
58
0 0x00080000–0x000801FF 0x00080000 0x00000000–0x000001FF
424
Show Commands
The following example displays block mapping information from blocks 0x100 through 0x400 in the user
space of virtual volume admin:
cli% showblock vv admin usr 0x100 0x400
VVname Spc
VVBlock
LDname
LDBlock PDid Chnk
PDblock
admin usr 0x00000100
admin.usr.0 0x00000100
88
0 0x00080100
=
=
=
= 0x00000100
58
0 0x00080100
admin usr 0x00000200
admin.usr.0 0x00000200
87
0 0x00080000
=
=
=
= 0x00000200
56
0 0x00080000
admin usr 0x00000400
admin.usr.0 0x00000400
70
1 0x00100000
=
=
=
= 0x00000400
54
0 0x00080000
The following example displays detailed block mapping information from blocks 0x100 through 0x400 in
the user space of virtual volume admin:
cli% showblock –d vv admin usr 0x100 0x400
VV/LD
Name
Block
Region
VV usr:
admin 0x00000100 0x00000000–0x0007FFFF (0–256MB)
LD
:
admin.usr.0 0x00000100 0x00000000–0x0007FFFF (0–256MB)
PD Chnk
PDStep
Block
LDStep
88
0 0x00080000–0x000801FF 0x00080100 0x00000000–0x000001FF
58
0 0x00080000–0x000801FF 0x00080100 0x00000000–0x000001FF
---------------------------------------------------------------VV/LD
Name
Block
Region
VV usr:
admin 0x00000200 0x00000000–0x0007FFFF (0–256MB)
LD
:
admin.usr.0 0x00000200 0x00000000–0x0007FFFF (0–256MB)
PD Chnk
PDStep
Block
LDStep
87
0 0x00080000–0x000801FF 0x00080000 0x00000200–0x000003FF
56
0 0x00080000–0x000801FF 0x00080000 0x00000200–0x000003FF
---------------------------------------------------------------VV/LD
Name
Block
Region
VV usr:
admin 0x00000400 0x00000000–0x0007FFFF (0–256MB)
LD
:
admin.usr.0 0x00000400 0x00000000–0x0007FFFF (0–256MB)
PD Chnk
PDStep
Block
LDStep
70
1 0x00100000–0x001001FF 0x00100000 0x00000400–0x000005FF
54
0 0x00080000–0x000801FF 0x00080000 0x00000400–0x000005FF
...
NOTES
None.
showcage
DESCRIPTION
The showcage command displays information about drive cages.
SYNTAX
The syntax of the showcage command can be one of the following:
showcage
425
showcage [options] [-d] [<cagename>...]
showcage [-sfp [-d|-ddm]] [<cagename> ...]
showcage -i [<cagename> ...]
showcage -svc -i [<cagename> ...]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Specifies that more detailed information about the drive cage is displayed. If this option is not used, then
only summary information about the drive cages is displayed.
-e
Displays error information. This option is not valid for DCS1 or DCS2 cages.
-c
Specifies to use cached information. This option displays information faster because the cage does not
need to be probed, however, some information might not be up-to-date without that probe.
-sfp
Specifies information about the SFP(s) attached to a cage. Currently, additional SFP information can only
be displayed for DC2 and DC4 cages.
-ddm
Specifies the SFP DDM information. This option can only be used with the-sfp option and cannot be used
with the -d option.
-i
Specifies that inventory information about the drive cage is displayed.
If this option is not used, then only summary information about the drive cages is displayed.
-svc
specifies that inventory information with HPE serial number, spare part etc.
is displayed. This option must be used with -i option and it is supported only on HPE 3PAR 7000 and HPE
3PAR 8000 series systems
SPECIFIERS
<cagename>...
Specifies a drive cage name for which information is displayed. This specifier can be repeated to display
information for multiple cages. If no specifiers are used, the command defaults to displaying information
about all cages in the system.
EXAMPLES
The following example displays information for a single system’s drive cages:
cli% showcage
Id Name LoopA Pos.A LoopB Pos.B Drives Temp RevA RevB Model FormFactor
0 cage0 1:0:1
0 0:0:1
0
24 30-33 402e 402e DCN1 SFF
1 cage1 1:0:2
0 0:0:2
0
24 32-34 402e 402e DCS2 SFF
426
Show Commands
The following example displays detailed information about a system's drive cages:
Show Commands
427
cli% showcage -d
Id Name LoopA Pos.A
0 cage0 0:6:1
0
1 cage1 0:6:2
0
2 cage2 0:6:3
0
3 cage3 0:6:4
0
LoopB Pos.B Drives Temp RevA RevB Model
1:6:1
0
16 27-37 2.64 2.64 DC4
1:6:2
0
16 27-37 2.64 2.64 DC4
1:6:3
0
16 21-31 2.64 2.64 DC4
1:6:4
0
16 21-31 2.64 2.64 DC4
FormFactor
LFF
LFF
LFF
LFF
-----------Cage detail info for cage0 --------Position: --Fibre Channel Info PortA0 PortB0 PortA1 PortB1
Link_Speed 4Gbps
--- 4Gbps
----------------------------------SFP
Info----------------------------------FCAL SFP -State- --Manufacturer-- MaxSpeed(Gbps) TXDisable TXFault RXLoss
DDM
0
0 OK
FINISAR CORP.
4.2 No
No
No
Yes
1
1 OK
FINISAR CORP.
4.2 No
No
No
Yes
Interface Board Info
FCAL0
FCAL1
Link A RXLEDs
Green
Off
Link A TXLEDs
Green
Off
Link B RXLEDs
Off
Green
Link B TXLEDs
Off
Green
LED(Loop_Split)
Off
Off
LEDS(system,hotplug) Green,Off Green,Off
-----------Midplane Info----------Firmware_status
Current
Product_Rev
2.64
State
Normal Op
Loop_Split
0
VendorId,ProductId
3PARdata,DC4
Unique_ID 1062030000771400
Power Supply Info State Fan State AC Assem_Part
ps0
OK
OK OK
PO1
ps1
OK
OK OK
PO1
ps2
OK
OK OK
PO1
ps3
OK
OK OK
PO1
-----Magazine Info----Mag SysLED HplLED Disks
0 Green
Off
4
1 Green
Off
4
8 Green
Off
4
9 Green
Off
4
---State--LoopA LoopB
Ready Ready
Ready Ready
Ready Ready
Ready Ready
-------------Drive Info------------- ----LoopA----- ----LoopB----Drive
NodeWWN
LED Temp(C) ALPA LoopState ALPA LoopState
0:0 2000b45253958a4d Green
34 0xe1
OK 0xe1
OK
428
Show Commands
...
-----------Cage detail info for cage1 --------...
Use the following to get a description of each column in the above examples:
clihelp -col showcage
NOTES
The power supply model, as shown in the Model column of the showcage -d output, is set by service
personnel using the setcage on page 309 command.
showcert
DESCRIPTION
The showcert command has two forms. The first is a table with a high level overview of the certificates
used by the SSL Services. This table is customizable with the -showcols option. The second form
provides detailed certificate information in either human readable format or in PEM (Privacy Enhanced
Mail) format. It can also save the certificates in a specified file. With both forms the user is able to select
the certificates with the -service and -type options.
SYNTAX
The syntax for the showcert command can be one of the following:
showcert [-showcols <column>,[<column>...]] [-service <SSL_service_name(s)>]
[-type <certificate_type(s)>]
showcert {-pem|-text} [-service <SSL_service_name(s)>] [-type
<certificate_type(s)>] [-file <filename>]
showcert -listcols
AUTHORITY
•
Any role in the system
OPTIONS
-listcols
Displays the valid table columns.
-showcols <column>,[<column>...]
Changes the columns displayed in the table.
-service <SSL_service_name>
Displays only the certificates used by the service(s). Multiple services must be delimited by a comma.
Valid service names are cim, cli, ekm-client, ekm-server, ldap, syslog-gen-client, syslog-gen-server,
syslog-sec-client, syslog-sec-server, wsapi, vasa, and unified-server.
-type <certificate_type>
showcert
429
Displays only certificates of the specified type, e.g., only root CA. Multiple types must be delimited by a
comma.
Valid types are csr, cert, intca, and rootca.
-pem
Displays the certificates in PEM format. When a filename is specified the certificates are exported to the
file.
-text
Displays the certificates in human readable format. When a filename is specified the certificates are
exported to the file.
-file <filename>
Specifies the export file of the -pem or -text option.
SPECIFIERS
None.
EXAMPLES
The following example shows how to display the certificate in table format.
cli% showcert
The following example shows how to display the certificate used by the cli in PEM format.
cli% showcert -service cli -type cert -pem
Use the following to get a description of each column in the above examples:
clihelp -col showcert
NOTES
Use the createcert on page 124 command to create self-signed certificates and importcert on page 225
to import signed certificates.
An asterisk following the service of a CA indicates that it is used by multiple services.
showcim
DESCRIPTION
The showcim command displays the CIM server service state being configured, either enabled or
disabled. It also displays the server current running status, either active or inactive. It displays the current
status of the HTTP and HTTPS ports and their port numbers. In addition, it shows the current status of
the SLP port, that is either enabled or disabled.
SYNTAX
showcim [options]
AUTHORITY
•
Any role in the system
OPTIONS
-pol
430
showcim
Show CIM server policy information
SPECIFIERS
None.
EXAMPLES
The following example shows the current CIM status:
cli% showcim
-Service- -State-- --SLP-- SLPPort -HTTP-- HTTPPort -HTTPS- HTTPSPort PGVer
CIMVer
Enabled
Active
Enabled
427 Enabled
5988 Enabled
5989 2.9.1
3.2.2
The following example shows the current CIM policy:
cli% showcim -pol
--------------Policy--------------replica_entity,one_hwid_per_view,use_pegasus_interop_namespace
Use the following to get a description of each column in the above examples:
clihelp -col showcim
NOTES
None.
showclienv
DESCRIPTION
The showclienv command displays the CLI environment parameters.
SYNTAX
showclienv
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
None.
EXAMPLES
The following example displays the currently set CLI environment variables for sample system
TestSystem:
showclienv
431
cli% showclienv
Parameter Value
csvtable 0
nohdtot
0
hafter
-1
listdom
0
editor
emacs
NOTES
See the setclienv on page 312 command for a complete description of the environment parameters.
showcorequest
DESCRIPTION
The showcorequest command displays the status of CO approval requests or queue size.
SYNTAX
showcorequest [-d] [-request <requestid>]
showcorequest [-state {approved|pending|rejected|executed|inprogress|
cancelled}]
showcorequest -queuesize
AUTHORITY
•
•
CO, super and command requester
CO and super user can view all the requests in queue while other users can see only their own
requests
Any user can view the queue size
•
OPTIONS
-request <requestid>
Limits the output to <requestid>.
-queuesize
Displays the queue size. The maximum size of queue is 99.
-d
Provides the detailed output. This option can be used only with -request option.
SPECIFIERS
None.
EXAMPLES
The following example shows status of request ID 12345:
cli% showcorequest -request 12345
The following example displays list of all requests and their status:
cli% showcorequest
432
showcorequest
The following example displays the queue size of the CO list:
cli% showcorequest -queuesize
The following example displays the approved requests:
cli% showcorequest -state approved
NOTES
Options -request, -state, and -queuesize are mutually exclusive.
showcpg
DESCRIPTION
The showcpg command displays common provisioning groups (CPGs) in the system.
SYNTAX
showcpg [options <arg>] [<CPG_name>...|<pattern>...]
AUTHORITY
•
Any role in the system
OPTIONS
-listcols
List the columns available to be shown in the -showcols option described below (see "clihelp -col
showcpg" for help on each column).
-showcols <column>[,<column>...]
Explicitly select the columns to be shown using a comma-separated list of column names. For this option
the full column names are shown in the header. Run "showcpg -listcols" to list the available
columns. Run "clihelp -col showcpg" for a description of each column.
The following options cannot be used together with other options except -sortcol, -hist and -domain:
-d
Displays detailed information about the CPGs. The following columns are shown:
Id Name Warn% VVs TPVVs TDVVs UsageUsr UsageSnp Base SnpUsed Free Total LDUsr
LDSnp RC_UsageUsr RC_UsageSnp DDSType
-r
Specifies that raw space used by the CPGs is displayed. The following columns are shown:
Id Name Warn% VVs TPVVs TDVVs UsageUsr UsageSnp Base RBase SnpUsed SnpRUsed
Free RFree Total RTotal
-alert
Indicates whether alerts are posted. The following columns are shown:
Id Name Warn% UsrTotal DataWarn DataLimit DataAlertW% DataAlertW DataAlertL
DataAlertF
-alerttime
Show times when alerts were posted (when applicable). The following columns are shown:
Id Name DataAlertW% DataAlertW DataAlertL DataAlertF
showcpg
433
-sag
Specifies that the snapshot admin space auto-growth parameters are displayed. The following columns
are displayed:
Id Name AdmWarn AdmLimit AdmGrow AdmArgs
-sdg
Specifies that the snapshot data space auto-growth parameters are displayed. The following columns are
displayed:
Id Name DataWarn DataLimit DataGrow DataArgs
-space (-s)
Show the space saving of CPGs. The following columns are displayed:
Id Name Warn% PrivateBase PrivateSnp Shared Free Total Compaction Dedup
DataReduce Overprov
The following options can be used together with other options:
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-hist
Specifies that current data from the CPG, as well as the CPG's history data is displayed.
-domain <domain_name_or_pattern,...>
Shows only CPGs that are in domains with names matching one or more of the
<domain_name_or_pattern> argument. This option does not allow listing objects within a domain of which
the user is not a member.
Patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
-aocfg <aocfg_name>
Show only CPGs that are in the AOCFG <aocfg_name>.
SPECIFIERS
[<CPG_name>...|<pattern>...]
Specifies that CPGs matching either the specified CPG name or those CPGs matching the specified
pattern are displayed. This specifier can be repeated to display information for multiple CPGs. If not
specified, all CPGs in the system are displayed.
EXAMPLES
The following example displays a system's CPGs:
434
Show Commands
cli% showcpg
----Volumes---- -Usage- ----------(MiB)----------Id Name Warn% VVs TPVVs TDVVs Usr Snp Base
Snp
Free Total
2 cpg1
2
0
0
2
1 24576
512 36352 60928
0 FC_r1
2
2
0
2
2 1024
1024 30720 32768
1 FC_r6
2
0
2
2
1 1536
512 34816 36864
----------------------------------------------------------------3 total
6
4 27136 103936 101888 130560
The following example displays the historical data for the CPGs:
cli% showcpg -hist
CPG FC_r6
----Volumes---- -Usage- -------(MiB)-------Time
Warn% VVs TPVVs TDVVs Usr Snp Base Snp Free Total
Sep 21 11:56:33
2
0
2
2
1 1536 512 34816 36864
Sep 21 03:37:01
0
0
0
0
0
0
0
0
0
Sep 20 03:37:01
0
0
0
0
0
0
0
0
0
-----------------------------------------------------------------CPG cpg1
----Volumes---- -Usage- --------(MiB)-------Time
Warn% VVs TPVVs TDVVs Usr Snp Base Snp Free Total
Sep 21 11:56:33
2
0
0
2
1 24576 512 36352 60928
Sep 21 03:37:01
0
0
0
0
0
0
0
0
0
------------------------------------------------------------------CPG FC_r1
----Volumes---- -Usage- --------(MiB)-------Time
Warn% VVs TPVVs TDVVs Usr Snp Base Snp Free Total
Sep 21 11:56:33
2
2
0
2
2 1024 1024 30720 32768
Sep 21 03:37:01
0
0
0
0
0
0
0
0
0
Sep 20 03:37:01
0
0
0
0
0
0
0
0
0
-------------------------------------------------------------------
The following example displays the common provisioning group's snapshot data space's autogrowth
parameters:
cli% showcpg -sdg
-----(MiB)-----Id Name Warn Limit Grow
2 cpg1
- 32768
0 FC_r1
- 32768
1 FC_r6
- 32768
Args
-ha mag -t r6 -p -devtype FC
-ssz 2 -ha cage -t r1 -p -devtype FC
-ssz 8 -ha mag -t r6 -p -devtype FC
The following example displays the alerts posted for the CPGs:
Show Commands
435
cli% showcpg -alert
-------------Data--------------(MiB)- -Setting(MiB)Alerts
Id Name Warn%
Total
Warn
Limit W% W L F
2 cpg1
25088
4096
5120 - - Y 0 FC_r1
2048
- - - - 1 FC_r6
2048
- - - - -
Use the following to get a description of each column in the above examples:
clihelp -col showcpg
NOTES
When using the createvv command, the size of the logical disk space created is the first integer
multiple of the RAID set size that is large enough to accommodate the requested virtual volume size.
For example, with the RAID-5 layout with a set size of 3 GiB, a requested virtual volume size of 8 GiB
causes the creation of logical disks with a total size rounded up to an integer multiple of 3 GiB that is 9
GiB. The growth increment of CPGs is similarly rounded up because the growth is done by creating
logical disks that must be created in units of the logical disk RAID set size.
For this command, 1 MiB = 1048576 bytes.
A Domain column may be included by using the setclienv on page 312 command to set listdom to 1. The
listdom option is also set to 1 if the CLI was started with the -listdom option, or if the CLI was started with
the TPDLISTDOM environment variable set. Issue "cli -h" and "setclienv -h" for details about
environment variables.
showdate
DESCRIPTION
The showdate command displays the date and time for each system node.
SYNTAX
showdate
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
None.
EXAMPLES
The following example displays the date and time for the system node:
436
showdate
cli%
Node
0
1
showdate
Date
2013-04-17 17:07:44 PDT (US/Pacific)
2013-04-17 17:07:44 PDT (US/Pacific)
NOTES
Set date and time information on nodes by issuing the setdate on page 319 command.
The output of the showdate command include an abbreviated timezone which may be non-unique. A
unique and parenthesized long format timezone name is appended at the end of each row. The long
format timezone name is the official timezone string set via setdate.
showdomain
DESCRIPTION
The showdomain command displays a list of domains in a system.
SYNTAX
showdomain [options]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Specifies that detailed information is displayed.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
SPECIFIERS
None.
EXAMPLES
The following example displays detailed information about a system's domains:
cli% showdomain -d
ID Domain
-----CreationTime-----1 TestDomain1 2015-06-22 14:23:30 PDT
2 TestDomain2 2015-06-22 14:23:30 PDT
3 TestDomain3 2015-06-22 14:23:30 PDT
--Comments--- -VVRetentionTimeMaxBeef Test
0 Hours
Chicken Test
0 Hours
Pork Test
0 Hours
Use the following to get a description of each column in the above examples:
showdomain
437
clihelp -col showdomain
NOTES
If the VVRetentionTimeMax is "--", then the maximum volume retention time for the system is used
instead.
If the VVRetentionTimeMax is 0, then the volume retention time in the domain is disabled.
showdomainset
DESCRIPTION
The showdomainset command lists the domain sets defined on the system and their members.
SYNTAX
showdomainset [options] [<setname_or_pattern>...]
showdomainset -domain [options] [<domainname_or_pattern>...]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Show a more detailed listing of each set.
-domain
Show domain sets that contain the supplied domains or patterns
SPECIFIERS
<setname_or_pattern>...
An optional list of setnames or patterns. If no setnames or patterns are specified all sets are displayed,
otherwise only sets with names matching one or more of the setnames or patterns are displayed.
The patterns are glob-style patterns. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.)
<domainname_or_pattern>...
Specifies that the domain sets containing domains with the specified names or matching the glob-style
patterns should be displayed.
EXAMPLES
The “Total” line in the output specifies the total number of unique objects.
To show all domain sets defined to the system:
438
showdomainset
cli% showdomainset
Id Name
Members
7 domainset domainset.1
domainset.2
23 newset
testdomain
-----------------------------------2 total
3
Show details of a specific set:
cli% showdomainset -d newset
Id Name
Members
Comment
23 newset testdomain this set has been renamed and now has a comment
------------------------------------------------1 total
1
Show domain sets containing domains matching the pattern domainset.*:
cli% showdomainset -domain domainset.*
Id Name
Members
7 domainset domainset.1
domainset.2
------------------------------1 total
2
Use the following to get a description of each column in the above examples:
clihelp -col showdomainset
NOTES
None.
showeeprom
DESCRIPTION
The showeeprom command displays node EEPROM log information.
SYNTAX
showeeprom [options] [<node_ID>...]
AUTHORITY
•
Any role in the system
OPTIONS
-dead
showeeprom
439
Specifies that an EEPROM log for a node that has not started or successfully joined the cluster be
displayed. If this option is used, it must be followed by a non empty list of nodes.
SPECIFIERS
<node_ID>...
Specifies the node ID for which EEPROM log information is retrieved.
Multiple node IDs are separated with a single space (0 1 2). If no specifiers are used, the EEPROM log
for all nodes is displayed.
EXAMPLES
The following example displays the EEPROM log for all nodes:
cli% showeeprom
Node: 0
-------Board revision: 0920-1053-03.01
Assembly: FLH 2007/50 Serial 0039
System serial: 1000183
BIOS version: 4.8.34
OS version: 3.2.2.204
Reset reason: Unknown
Last boot: 2015-06-24 02:43:13 MDT
Last cluster join: 2015-06-24 02:45:43 MDT
Last panic: 2015-06-23 16:35:43 MDT
Last panic request: 2015-06-16 20:33:22 MDT
Error ignore code: 00
SMI context: 00
Last HBA mode: 2a000000
BIOS state: ff 23 26 27 28 29 2b 80
TPD state: 34 40 ff 2a 2c 2e 30 32
Code 128 (BIOS update) - Subcode 0x2020103 (2020102) 2015-06-12 17:34:37 MDT
Code 128 (BIOS update) - Subcode 0x2020102 (2020009) 2015-06-12 12:37:45 MDT
Node: 1
-------...
NOTES
None.
showencryption
DESCRIPTION
The showencryption command shows Data Encryption information.
SYNTAX
showencryption [options]
AUTHORITY
•
•
440
Super, Service
Any role granted the control_encryption_status right
showencryption
OPTIONS
-d
Provides details on the encryption status.
SPECIFIERS
None.
EXAMPLES
Use the following to get a description of each column:
clihelp -col showencryption
NOTES
If the state shows recovery_needed, the enable or latest rekey operation failed. Re-issue the operation to
fix this state.
showeventlog
DESCRIPTION
The showeventlog command displays the current system event log.
SYNTAX
showeventlog [options <arg>]
AUTHORITY
•
Any role in the system
OPTIONS
-min <number>
Specifies that only events occurring within the specified number of minutes are shown. The <number> is
an integer from 1 through 2147483647.
-more
Specifies that you can page through several events at a time.
-oneline
Specifies that each event is formatted as one line.
-d
Specifies that detailed information is displayed.
-startt <time>
Specifies that only events after a specified time are to be shown. The time argument can be specified as
either <timespec>, <datespec>, or both. If you would like to specify both a <timespec> and <datespec>,
you must place quotation marks around them; for example, -startt "2012-10-29 00:00".
<timespec>
Specified as the hour (hh), as interpreted on a 24 hour clock, where minutes (mm) and seconds (ss) can
be optionally specified. Acceptable formats are hh:mm:ss or hhmm.
<datespec>
showeventlog
441
Specified as the month (mm or month_name) and day (dd), where the year (yy) can be optionally
specified. Acceptable formats are mm/dd/yy, month_name dd, dd month_name yy, or yy-mm-dd. If the
syntax yy-mm-dd is used, the year must be specified.
-endt <time>
Specifies that only events before a specified time are to be shown. The time argument can be specified
as either <timespec>, <datespec>, or both.
See -startt option for descriptions of <timespec> and <datespec>.
The <pattern> argument in the following options is a regular expression pattern that is used to match
against the events each option produces. (For more information, issue "clihelp sub,regexpat" or see
Regular Expressions Patterns on page 16.) For each option, the pattern argument can be specified
multiple times by repeating the option and <pattern>. For example:
showeventlog -type Disk.* -type <tpdtcl client> -sev Major The "-sev Major" displays
all events of severity Major and with a type that matches either the regular expression Disk.* or <tpdtcl
client>.
-sev <pattern>
Specifies that only events with severities that match the specified pattern(s) are displayed. The supported
severities include Fatal, Critical, Major, Minor, Degraded, Informational and Debug.
-nsev <pattern>
Specifies that only events with severities that do not match the specified pattern(s) are displayed. The
supported severities include Fatal, Critical, Major, Minor, Degraded, Informational and Debug.
-class <pattern>
Specifies that only events with classes that match the specified pattern(s) are displayed.
-nclass <pattern>
Specifies that only events with classes that do not match the specified pattern(s) are displayed.
-node <pattern>
Specifies that only events from nodes that match the specified pattern(s) are displayed.
-nnode <pattern>
Specifies that only events from nodes that do not match the specified pattern(s) are displayed.
-type <pattern>
Specifies that only events with types that match the specified pattern(s) are displayed.
-ntype <pattern>
Specifies that only events with types that do not match the specified pattern(s) are displayed.
-msg <pattern>
Specifies that only events, whose messages match the specified pattern(s), are displayed.
-nmsg <pattern>
Specifies that only events, whose messages do not match the specified pattern(s), are displayed.
-comp <pattern>
Specifies that only events, whose components match the specified pattern(s), are displayed.
-ncomp <pattern>
Specifies that only events, whose components do not match the specified pattern(s), are displayed.
SPECIFIERS
442
Show Commands
None.
EXAMPLES
The following example displays the system events occurred during the last 20 minutes:
cli% showeventlog -min 20
The following example displays the system events same as above using the -oneline option:
cli% showeventlog -min 20 -oneline
The following example displays CRC errors in the last 10 minutes using the -msg option:
cli% showeventlog -debug -min 10 -msg CRC
The following example displays Remote Copy messages in the last 5 minutes using the -comp option:
cli% showeventlog -min 5 -comp rmm
NOTES
The HPE 3PAR OS stores 33 MB of event logs in segments of 3MB each (the active event log and the
most recent 10 generations) When one 3MB segment is filled, events are written to the next segment.
When all eleven segments are filled, they are overwritten beginning with the oldest segment.
showfirmwaredb
DESCRIPTION
The showfirmwaredb command displays the current database of firmware levels for possible upgrade.
If issued without any options, the firmware for all vendors is displayed.
SYNTAX
showfirmwaredb [options]
AUTHORITY
•
Any role in the system
OPTIONS
-n <vendor_name>
Specifies that the firmware vendor from the SCSI database file is displayed.
-l
Reloads the SCSI database file into the system.
-all
showfirmwaredb
443
Specifies current and past firmware entries are displayed. If not specified, only current entries are
displayed.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
SPECIFIERS
None.
EXAMPLES
The following example displays the current database of firmware levels and prints firmware data:
cli% showfirmwaredb
Vendor Prod_rev Dev_Id Fw_status Cage_type
Firmware_File
HITACHI [C1C1] DK..DJ-18FC Current DC4
/opt/tpd/fw/drive/MDJFC1C1.BIN
...
SEAGATE [0004] ST318203FC Current DC4
/opt/tpd/fw/drive/0004.lod
...
Source file: /var/opt/tpd/scsi_db.cfg
NOTES
The firmware information displayed by the showfirmwaredb command is used when issuing the
upgradecage on page 755 and upgradepd on page 756 commands.
showflashcache
DESCRIPTION
The showflashcache command displays the status of the flash cache for each node or displays the
flash cache policy for virtual volumes.
SYNTAX
showflashcache [options] [<name|pattern>]
AUTHORITY
•
Any role in the system
OPTIONS
-vvset
Specifies that the virtual volume set with flash cache enabled will be displayed instead of the status for
the nodes. Only virtual volume sets matching the SPECIFIER name or pattern will be displayed.
-vv
444
showflashcache
Specifies that the virtual volumes with flash cache enabled will be displayed instead of the status for the
nodes. Only virtual volumes matching the SPECIFIER name or pattern will be displayed.
SPECIFIERS
<name|pattern>
Specifies that information is displayed for virtual volumes or virtual volume sets matching the specified
name or pattern. This is valid only if -vv or -vvset is also specified. If not specified, the default with -vv is
for all virtual volumes and for -vvset is for all virtual volume sets.
EXAMPLES
The following examples display the status of the flash cache for each node:
Show Commands
445
cli% showflashcache
-(MB)Node Mode
State
Size
Used%
0 SSD
Normal 131072
30
1 SSD
Normal 131072
15
----------------------------------------------------2 total
262144
cli% showflashcache -vvset
Id VVSetName
AFCPolicy
0 vs1
enabled
1 vs2
enabled
2 vs3
enabled
----------------------------------------3 total
cli% showflashcache -vvset vs1
Id VVSetName AFCPolicy
0 vs1
enabled
----------------------------------------1 total
cli% showflashcache -vv
VVid
VVName
AFCPolicy
1777
VV20720_0001
enabled
1778
VV20786_0000
enabled
1779
VV20855_0000
enabled
1780
VV20720_0001
enabled
1781
VV20786_0000
enabled
1782
VV20855_0000
enabled
1783
VV20720_0001
enabled
1784
VV20786_0000
enabled
1785
VV20855_0000
enabled
------------------------------10
total
cli% showflashcache -vv VV20720_0001
VVid
VVName
AFCPolicy
1777
VV20720_0001
enabled
-------------------------------1
total
Use the following to get a description of each column in the above examples:
clihelp -col showflashcache
NOTES
446
Show Commands
Patterns are glob-style (shell-style) patterns. (For more information, issue "clihelp sub,globpat" or see
Glob-Style Patterns on page 15.)
If name or pattern is not specified then all virtual volumes or virtual volume sets will be returned.
showfpg
DESCRIPTION
The showfpg command displays information on file provisioning groups
SYNTAX
showfpg [options] [<fpgname>]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Detailed output.
SPECIFIERS
<fpgname>
Limit output to the specified file provisioning group.
EXAMPLES
The following example shows a verbose listing of the file provisioning group, examplefpg:
cli% showfpg -d examplefpg
NOTES
Access to all domains is required to run this command.
A version displayed with "*" indicates current version is upgradable.
showfs
DESCRIPTION
The showfs command displays information on File Persona nodes.
SYNTAX
showfs [options]
showfs -usermap
showfs -usermap [-d] {-username <username> | -groupname <groupname> | -userid
<uid|sid> | -groupid <gid|sid>} [-mapped <true|false>]
showfs -usermap -exportconf -file <client_filepath>
showfs -usermap -export {users|groups} -provider <provider> -file
<client_filepath>
AUTHORITY
showfpg
447
•
•
Any role in the system
Super role is required to use -file and -d options.
OPTIONS
-obj
Displays the Object default profile settings.
-net
Displays network configuration.
-ad
Displays Active Directory domain information.
-ldap
Displays LDAP configuration.
-auth
Displays the auth provider stacking order.
-idmap
Displays NFSv4 domain name information.
-rfc2307
Displays RFC2307 configuration.
-smb
Displays values of various SMB tunable parameters.
-usermap
Displays the user mapping status, mapped user/group profiles. Copies the exported users/group entries
or mapping configuration to the client.
The following options are only allowed with -usermap:
448
•
-username <username>
•
Displays the mapped information for the specified username. <username> should be in UPN format.
-userid <uid|sid>
•
Displays the mapped information for the specified user uid/sid.
-groupname <groupname>
•
Displays the mapped information for the specified groupname. <groupname> should be in UPN
format.
-groupid <gid|sid>
•
Displays the mapped information for the specified group gid/sid.
-d
•
Displays the detailed information of mapped users. This option is allowed only for users with super
role.
-exportconf
•
Exports and copies the mapping configuration to the client. If this option is specified, "-file
<filepath_on_client>" must also be specified.
-export {users|groups}
Show Commands
•
Specifies the type of exported entries to be copied to the client. If this option is specified, "-provider
<provider>" and "-file <filepath_on_client>" must also be specified. See "setfs usermap" for the
command to create the exports.
-provider {Local|Ldap|ActiveDirectory}
•
Specifies the type of <provider> to be used to copy the exported entries. This option can only be used
with -export.
-file <filepath_on_client>
•
Specifies the file path on client to which the mapping configuration or exported users/groups are to be
copied to. This option can be used with only -export and -exportconf.
-mapped {true|false}
Specifies whether mapped user details are to be displayed or its own details are to be displayed. By
default, the mapped user details will be displayed. This option can only be used with -username, userid and -d.
SPECIFIERS
None.
EXAMPLES
Show Commands
449
cli% showfs
Node FSNode State
Active InCluster ----Version----- ---N:S:P--BondMode MTU
0 Yes
Running No
Yes
1.0.0.3-20140708
0:2:1,0:2:2
1 Yes
Running Yes
Yes
1.0.0.3-20140708
1:2:1,1:2:2
cli% showfs -obj
Non-SSL Port
SSL Port
Allow Persistent Connections
Timeout for Persistent Connections
Maximum Clients
Read Block Size (KB)
Write Block Size (KB)
:
:
:
:
:
:
:
80
443
true
5
50
8.00
8.00
cli% showfs -net
IP_Address
Node
Subnet VLAN_Tag Network
10.135.4.221
0 255.255.255.0
0 user
10.135.4.222
1 255.255.255.0
0 user
Default Route: 10.135.4.254 user
DNS servers:
10.35.0.1 10.10.0.6 10.10.15.8
DNS suffixes: ibftc.vpi.example.com 2003ad.lab
cli% showfs -ad
Domain Name : EXAMPLE.COM
NetBIOS Name : EXAMPLE
Forest
: EXAMPLE.COM
Status
: Online
cli% showfs -ldap
LDAP Server
Administrator DN
Search Base
Netbios Name
SSL/TLS
State
:
:
:
:
:
:
100.10.10.10
cn=Manager,dc=example,dc=com
dc=example,dc=com
hostname
disabled
OK
cli% showfs -auth
Provider Stacking Order: ActiveDirectory, Local
cli% showfs -idmap
NFSv4 domain name: example.com
cli% showfs -rfc2307
RFC2307: enabled
cli% showfs -smb
SMB TUNABLES PARAMETERS
enableoplocks
signingenabled
signingrequired
450
Show Commands
: true
: true
: false
ignorewritethroughrequests
supportpersistenthandles
smb3dialectenable
enablesmb2ad
enablesmbleases
enabledirleases
enablesmb2
cli% showfs -usermap
Mapping Enabled
:
State
:
Health Description :
Corrective Action :
:
:
:
:
:
:
:
true
true
true
true
true
true
true
true
OK
Component is healthy.
--
cli% showfs -usermap -username trk1@2008ad
----------Mapping----------From
Type To
2008AD\trk1 =>
2008ad\trk2
cli% showfs -usermap -groupid 1176528715
----------------Mapping----------------From
Type To
2008AD\trk1_group =>
2008ad\trk2_group
The following two commands are allowed only for users with super role:
Show Commands
451
cli% showfs -usermap -userid 1176528713 -d
SID
:
S-1-5-21-2943099029-2375420575-3763763779-550730
UID
: 1176528714
GID
: 1175978497
UPN
: trk2@2008AD.LAB
NetBIOS Name
: 2008AD
SAM Account Name
: trk2
Domain
: CN=trk2,DC=2008ad,DC=lab
Primary Group Name
: 2008AD\domain^users
Alias Name
: -Map Found
: true
Primary Group SID
: S-1-5-21-2943099029-2375420575-3763763779-513
Additional Info
: trk2
Password Expired
: false
Password Never Expires
: true
Prompt Password Change
: false
User Can Change Password : true
Account Disabled
: false
Account Expired
: false
Account Locked
: false
Mapping From
: 2008AD\trk1
Mapping To
: 2008ad\trk2
Mapping Type
: =>
cli% showfs -usermap -groupname trk1_group@2008ad -d
GID
: 1176528716
SID
: S-1-5-21-2943099029-2375420575-3763763779-550732
NetBIOS Name
: 2008AD
UNIX Name
: 2008AD\trk2_group
SAM Account Name : trk2_group
Domain
: CN=trk2_group,DC=2008ad,DC=lab
Alias Name
: -Map Found
: true
Mapping From
: 2008AD\trk1_group
Mapping To
: 2008ad\trk2_group
Mapping Type
: =>
Use the following to get a description of each column in the above examples:
clihelp -col showfs
NOTES
Access to all domains is required to run this command.
If no options are specified a summary of the nodes status is displayed.
The options -export and -exportconf are not available with SSH access to CLI.
showfsarchive
DESCRIPTION
The showfsarchive command displays retention policy, retention setting for specified files and
information of already running validation scans.
452
showfsarchive
SYNTAX
The syntax for the showfsarchive command can be one of the following:
showfsarchive pol [-fstore <fstorename>] [-fpg <fpgname>] [<vfs>]
showfsarchive files [-basepath <basepath>] {-files
<filepath>[,<filepath>,...] | -importfile <source_path> | -inputfile
<pathoffile>} [-fpg <fpgname>] <vfs>
showfsarchive scan [-jobid <jobid>] [-exportsummary | -export <target_path>]
-fstore <fstorename> [-fpg <fpgname>] <vfs>
showfsarchive auditlogs [-export {all|<logname>}] [-fpg <fpgname>] <vfs>
showfsarchive export <taskid> <target_path>
SUBCOMMANDS
pol
Displays the retention policy configured at VFS or FSTORE level for specific FPG.
files
List the retention setting for the specified file at the given path or for all the files at the given path
(Including wildcard characters in filenames). This subcommand will spawn a task and return the taskid.
scan
This command inquires about the retention validation scan process with the provided job id. If no job Id is
given, all validation scans are listed.
Inquiry of validation scan contains the following fields:
•
•
•
•
•
Validated - File has been compared against a stored checksum of content and metadata.
Skipped - File could not be validated and was skipped.
ContInconsistent - Content checksum is corrupted or inconsistent.
MetaInconsistent - metadata checksum is corrupted or inconsistent.
JobError - The validation job ended with errors.
Once the job is completed, the summary file of the validation job can be exported to .admin file store
using the "-exportsummary" option.
auditlogs
This subcommand will list all the audit logs at the VFS level.
export
This subcommand is used to export the result file that is generated upon admin retention command
execution to the specified target location.
AUTHORITY
•
•
•
Any role in the system
Only the -export option requires "Edit" role.
The "export" subcommand, and the "-importfile <source_path>" and "-export
<target_path>" options can be accessed only by users with Super role.
OPTIONS
-fpg <fpgname>
Specifies the FPG that contains the VFS. This is required if VFS exists under multiple FPGs.
-fstore <fstorename>
File store name.
Show Commands
453
-basepath <basepath>
Base path of files for which retention settings are to be displayed.
-files <filepath>[,<filepath>,]...
Relative path of files from the above base path for which retention settings are to be displayed.
-inputfile <pathoffile>
Path of the input file containing list of files for which retention settings are to be displayed. The input file
should be placed in file persona namespace (.admin file store). It should be absolute path of the input file,
which is visible to the file persona namespace.
-importfile <source_path>
Path of the input file containing list of files for which retention settings are to be displayed. The input file
should be present on client machine. The max size of import file can be up to 2GB.
-jobid <jobid>
Job Id of the running data validation scan process.
-exportsummary
Exports the summary of validation scan to .admin file store.
-export {all|<logname>}
Exports either all or a specific audit log to the .admin file store inside the VFS. If the string "all" is
specified, it will export all of the log files and if the name of a log file is specified, it will export the given log
file.
-export <target_path>
Exports the summary file of validation scan to the specified target path.
SPECIFIERS
<vfs>
Specifies the name of the VFS.
<taskid>
Specifies the task id which mentions the result file.
<target_path>
Specifies the target path on client machine to export the result file.
EXAMPLES
The following example displays the properties of retention policy configured on VFS vfs1:
cli% showfsarchive pol -fpg fpg1 vfs1
The following example displays the properties of retention policy configured on fstore fstore1:
cli% showfsarchive pol -fstore fstore1 -fpg fpg1 vfs1
The following example will list the retention setting for the file(s) specified in filepath:
454
Show Commands
cli% showfsarchive files -basepath /fpg1/vfs1
-files /fstore/abcd.txt,/fstore2/xyz.txt
-fpg fpg1 vfs1
cli% showfsarchive files -basepath /fpg1/
-inputfile /fpg1/vfs1/.admin/s2.txt -fpg fpg1 vfs1
cli% showfsarchive files -importfile /home/worm/file.txt -fpg fpg1 vfs1
The following example inquires about data validation scan process:
cli% showfsarchive scan -fstore fstore1 -fpg fpg1 vfs1
The following example inquires about data validation scan process of a particular job:
cli% showfsarchive scan -jobid 10 -fstore fstore1 -fpg fpg1 vfs1
The following example exports summary of a particular job to .admin fstore:
cli% showfsarchive scan -exportsummary -jobid 10 -fstore fstore1
-fpg fpg1 vfs1
The following example shows admin audit logs:
cli% showfsarchive auditlogs vfs1
The following example exports all audit logs to the .admin folder of VFS:
cli% showfsarchive auditlogs -export all vfs1
The following example exports specified audit log to .admin folder of VFS:
cli% showfsarchive auditlogs -export audit_fpg1_vfs1.log vfs1
The following example exports summary of a particular job to /home/archive_results.txt on client machine:
cli% showfsarchive scan -export /home/archive_results.txt -jobid 10
-fstore fstore1 -fpg fpg1 vfs1
The following example exports result file of CLI task 1234 to /home/WORM/output.txt on client machine:
cli% showfsarchive export 1234 /home/WORM/output.txt
NOTES
Access to all domains is required to run this command.
Columns displayed with "-" indicate not applicable.
Inquiry of validation scan contains the following fields:
•
•
•
•
•
Validated - File has been compared against a stored checksum of content and metadata.
Skipped - File could not be validated and was skipped.
ContInconsistent - Content checksum is corrupted or inconsistent.
MetaInconsistent - metadata checksum is corrupted or inconsistent.
JobError - The validation job ended with errors.
Show Commands
455
The following subcommand and options are not available with SSH access to CLI.
•
•
•
export
-importfile <source_path>
-export <target_path>
showfsaudit
DESCRIPTION
The showfsaudit command displays File Access Audit settings.
SYNTAX
The syntax for showfsaudit can be one of the following:
showfsaudit pol [-fpg <fpgname>] [-vfs <vfsname>]
showfsaudit log [-fpg <fpgname>] <vfs>
showfsaudit log -export [-fpg <fpgname>] <vfs>
showfsaudit log -export -file <client_filepath> [-fpg <fpgname>] <vfs>
<logfile>
showfsaudit protobuf -export <client_filepath>
showfsaudit smb [-fpg <fpgname>] [-vfs <vfsname>]
SUBCOMMANDS
pol
Display file access audit policy related details.
log
Display list of file access audit policy log files generated.
protobuf
Export file access audit policy related protocol specific event definition files.
smb
Displays global level file access audit configuration for SMB protocol.
AUTHORITY
•
•
•
Any role in the system.
The showfsaudit log -export command requires Edit role to access .admin directory.
The showfsaudit log -export -file <client_filepath> and showfsaudit protobuf
-export commands can be executed by Super role only.
OPTIONS
The following options are specific to the pol and smb subcommands:
•
-fpg <fpgname>
•
Limit the display to virtual file servers (VFS) contained within the FPG.
-vfs <vfsname>
Limit the display to the specified virtual file server.
The following options are specific to the log and protobuf subcommands:
•
456
-export
showfsaudit
Exports specified logfile to .admin folder on file store or path on client's machine.
The following options are specific to the log subcommand:
•
-file <client_filepath>
Specifies the target path on client machine to export the log file. If -file is not specified, exports log
file to .admin directory on file store.
SPECIFIERS
The following specifiers are specific to the log subcommand:
•
<logfile>
•
Log file to be exported.
<vfs>
The VFS for which file access audit log policy file details to be displayed.
The following specifiers are specific to the protobuf subcommand:
•
<client_filepath>
Specifies the target path on client machine to export the protocol specific event definition file.
Extension of client_filepath needs to be ".tar".
EXAMPLES
The following example displays file access audit policy defined for specified VFS in a cluster:
cli% showfsaudit pol
VFS name
FPG name
Audit host
Queue names
Authorized user
Exchange name
Replica Enabled
ClientType
LogRotationCriteria
RetentionPeriod
Format
-vfs vfs1
: vfs1
: fpg1
: 079d888f-8a2f-41a3-b0de-151b06ee192c_5
: nfs,smb
: testuser
: hpe.exchange
: true
: internal
: 100mb
: 0d
: json
The following example displays list of compressed log files:
cli% showfsaudit log vfs1
Audit Logs
------------nfs.log_2017-01-17-10-37-23.zip
The following example exports the active log file to the sub-directory "fileauditing" under the .admin file
store:
cli% showfsaudit log -export -fpg fpg1 vfs1
The following example copies log file to client path:
cli% showfsaudit log -export -file /home/smblog.zip -fpg fpg1 vfs1
activeLogs_2017-02-10-09-00-28.zip
Show Commands
457
The following example copies protocol specific event definition files to client path:
cli% showfsaudit protobuf -export /home/cluster1_protofiles.tar
The following example displays information for vfs1:
cli% showfsaudit smb -vfs vfs1
VFS
FPG
AuditOptions
---------------------------------vfs1 fpg1 global:none,logon:success,logoff:all
NOTES
None.
showfsav
DESCRIPTION
The showfsav command displays antivirus properties for File Persona. When no options are specified,
the virus scan engine (VSE) information is displayed. With appropriate subcommands, the policies or
scans associated with a virtual file server (VFS) or file store may be displayed.
SYNTAX
The syntax for the showfsav command can be one of the following:
showfsav
showfsav svc
showfsav scan [-fpg <fpgname>] [-fstore <fstore>] <vfs>
showfsav pol [-fpg <fpgname>] [-fstore <fstore>] [<vfs>]
showfsav quar [-fpg <fpgname>] <vfs>
SUBCOMMANDS
svc
Specifies that status of AV service to be displayed.
scan
Specifies that scan information to be displayed.
pol
Specifies that policy information to be displayed.
Vendor displayed as "--" represents not-applicable.
quar
Specifies that statistics of quarantined files to be displayed.
AUTHORITY
•
Any role in the system
OPTIONS
-fpg <fpgname>
Limits the display to virtual file servers (VFS) contained within the FPG.
-fstore <fstore>
458
showfsav
Specifies the file store for which to display the policies or active scans.
SPECIFIERS
<vfs>
Specifies the VFS for which to display the policies or active scans.
EXAMPLES
The following example displays various antivirus properties for a VFS named "testvfs":
cli% showfsav pol testvfs
The following example displays various antivirus properties for the file store named "engineering" under
VFS "testvfs":
cli% showfsav pol -fstore engineering testvfs
NOTES
Access to all domains is required to run this command.
The stopfsav scan <vfs_name> <scan_id> command can be used to stop the running scan.
The stopfsav scan -pause <vfs_name> <scan_id> command can be used to pause the running
scan (see stopfsav on page 734).
[o] represents the setting has been overridden in file store.
The quar subcommand is only applicable for VFS.
showfsgroup
DESCRIPTION
The showfsgroup command displays information about groups associated with the File Persona
subsystem.
SYNTAX
showfsgroup [options] [<groupname|pattern> ...]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Display full details on the local groups.
SPECIFIERS
<groupname>
Limit the output to the group specified.
EXAMPLES
The following example displays information about group admin:
showfsgroup
459
cli% showfsgroup admin
Use the following to get a description of each column in the above examples:
clihelp -col showfsgroup
NOTES
Access to all domains is required to run this command.
showfshare
DESCRIPTION
The showfshare command displays file share information for supported protocols.
SYNTAX
showfshare
showfshare {smb|nfs|obj|ftp} [options <arg>] [<sharename>|<pattern>]
showfshare {smb|nfs|obj|ftp} -dirperm [-fpg <fpgname>] -vfs <vfs> -fstore
<fstorename> <sharename>
SUBCOMMANDS
smb
Displays file shares information for SMB.
nfs
Displays file shares information for NFS.
obj
Displays file shares information for Object.
ftp
Displays file shares information for FTP.
If no subcommand is specified, this command displays file shares for all protocols.
AUTHORITY
•
Any role in the system
OPTIONS
The following options are for all subcommands:
-dirperm
Displays ACL permissions, UNIX permissions and owner group permissions of a share directory. If this
option is used, -fstore and share name must also be specified.
-fpg <fpgname>
Specifies the file provisioning group name. This limits the share output to those shares associated with
the specified file provisioning group.
460
showfshare
-vfs <vfs>
Specifies the virtual file server name. This limits the share output to those shares associated with the
specified virtual file server. If this option is specified, but -fpg is not specified, the command will find out
the file provisioning group based on <vfs>.
However, if <vfs> exists under multiple file provisioning groups, -fpg must be specified.
-fstore <fstore>
Specifies the file store name. This limits the share output to only those shares associated with the
specified file store. If this is specified, option -vfs must be specified.
-pat
Specifies the file share names using the glob-style pattern. Shares which have the name matching any of
the specified glob-style patterns will be displayed. The -pat option can specify a list of patterns, and it
must be used if specifier <pattern> is used.
-d
Shows share attributes which are not displayed by other options.
SPECIFIERS
<pattern|sharename>
Displays only shares with names matching the specified <sharename> or one of the glob-style patterns.
EXAMPLES
The following example displays all SMB file shares with all attributes:
cli% showfshare smb -d
The following example displays all SMB file shares matching the pattern "share*":
cli% showfshare smb -pat "share*"
The following example displays SMB file shares associated with the VFS "myvfs":
cli% showfshare smb -vfs myvfs
The following example displays all NFS file shares:
cli% showfshare nfs
The following example displays NFS file shares associated with the virtual file server "myvfs":
cli% showfshare nfs -vfs myvfs
The following example displays a single Object file share:
cli% showfshare obj -vfs myvfs myshare
The following example displays a single FTP file share:
cli% showfshare ftp -vfs myvfs myshare
The following example displays share directory permissions of NFS file share "myshare":
Show Commands
461
cli% showfshare nfs -dirperm -vfs myvfs -fstore myfstore myshare
Use the following to get a description of each column in the above examples:
clihelp -col showfshare
NOTES
Access to all domains is required to run this command.
To specify VFS or file store filters, the parent components must be specified.
When displaying allow/deny permissions for SMB shares, this command displays users/groups configured
on Active Directory or the LDAP server in the format of "<netbios>\<name>". The <netbios> is the Active
Directory or LDAP server NetBIOS name, which can be found by running "showfs -ad" or "showfs -ldap".
showfsip
DESCRIPTION
The showfsip command shows the network config of a Virtual File Server.
SYNTAX
showfsip [options] <vfs>
AUTHORITY
•
Any role in the system
OPTIONS
-fpg <fpgname>
Specifies the File Provisioning Group in which the Virtual File Server was created.
SPECIFIERS
<vfs>
Specifies the Virtual File Server which is to have its network config modified.
EXAMPLES
This example displays the network config of Virtual File Server vfs_1:
cli% showfsip -fpg fpg_1 vfs_1
NOTES
Access to all domains is required to run this command.
showfsnap
DESCRIPTION
The showfsnap command lists the snapshots for File Persona.
SYNTAX
showfsnap [options <arg>] [<snapname>|<pattern>]
462
showfsip
AUTHORITY
•
Any role in the system
OPTIONS
-d
Displays detailed output that displays creation time of the snapshot in addition to other fields.
-fpg <fpgname>
Specifies the file provisioning group (FPG) name. This option limits the snapshot output to those
associated snapshots with the specified FPG.
-vfs <vfs>
Specifies the virtual file server (VFS) name. This option limits the snapshot output to those snapshots
associated with the specified VFS. If this option is specified, but -fpg is not specified, the command will
find out the FPG based on <vfs>. However, if <vfs> exists under multiple FPGs, -fpg must be specified.
-fstore <fstore>
Specifies the file store name. This option limits the snapshot output to only those snapshots associated
with the specified file store. If this is specified, option -vfs must be specified.
-pat
Specifies the snapshot names using glob-style patterns. Snapshots which have the name matching any
of the specified glob-style patterns will be displayed. Patterns can be repeated using a comma-separated
list. The -pat option must be used if <pattern> specifier is used.
SPECIFIERS
<snapname|pattern>
Displays only snapshots with names matching the specified <snapname> or one of glob-style patterns.
EXAMPLES
The following example displays all snapshots for "myfstore":
cli% showfsnap -vfs myvfs -fstore myfstore
SnapshotName
FPG
VFS
FileStore
2014-10-02T201925_myfsnap
myfpg myvfs myfstore
-----------------------------------------------cli% showfsnap -d
-----------------------showfsnap-----------------------Snapshot Name
: 2014-10-02T201925_myfsnap
File Provisioning Group
: myfpg
Virtual File Server
: myvfs
File Store
: myfstore
Creation Time
: 2014-10-02 13:19:25
Use the following to get a description of each column in the above examples:
clihelp -col showfsnap
NOTES
Access to all domains is required to run this command.
Show Commands
463
If no arguments are specified, this command displays all snapshots created in the File Persona cluster.
showfsnapclean
DESCRIPTION
The showfsnapclean command displays the details of an on-demand snapshot reclamation task active
on a file provisioning group.
SYNTAX
The syntax for the showfsnapclean command is as follows:
showfsnapclean [options] [<fpgname>]
AUTHORITY
•
Any role in the system.
OPTIONS
-d
Detailed output.
SPECIFIERS
<fpgname>
Specifies the name of the file provisioning group.
EXAMPLES
The following example displays the running reclamation task on FPG fpg1:
cli% showfsnapclean fpg1
---------------ID--------------- FPG
------End------- CumSpaceRecovered
3fc6487f0f374358a06b21ec743bec0b fpg1
2014-08-07 23:27
0
cli% showfsnapclean -d fpg1
TaskId
:
TaskState
:
StartTime
:
EndTime
:
VerboseMode
:
LogLevel
:
Strategy
:
EntriesScanned
:
EntriesReclaimed
:
InodesReclaimed
:
InodesSkipped
:
AvgFileSizeKb
:
CumulativeSpaceRecovered
:
Errors
:
ExitStatus
:
State
-----Start------
COMPLETED 2014-08-07 23:26
3fc6487f0f374358a06b21ec743bec0b
UNKNOWN
1399076631197
0
false
N/A
DEFAULT
0
0
0
0
0
0
0
N/A
If the task is not running and there is no history of completed tasks, the following output is displayed:
464
showfsnapclean
cli% showfsnapclean fpg1
No reclamation task running on FPG fpg1 (Server error: 400)
Use the following to get a description of each column in the above examples:
clihelp -col showfsnapclean
NOTES
Access to all domains is required to run this command.
showfsndmp
DESCRIPTION
The showfsndmp command displays NDMP properties for File Persona. When no options are specified,
this command displays the global service status of NDMP and cluster-wide IQN. With appropriate options
specified, VTL devices/tapes information, configuration of DMA, and session status are displayed.
SYNTAX
The syntax for the showfsndmp command can be:
showfsndmp
showfsndmp -conf
showfsndmp -vtl {vtldevices|vtltapes}
showfsndmp -sessions {active|completed} [-d]
AUTHORITY
•
Any role in the system
OPTIONS
-conf
Displays the current value of all NDMP configurable parameters.
-vtl vtldevices|vtltapes
Displays list of all target VTL devices when set to vtl devices. Lists all target VTL tapes when set to
vtl tapes.
-sessions active [-d]
Displays active/running NDMP sessions. Using -d displays all the details.
-sessions completed [-d]
Displays all completed NDMP sessions. Using -d displays all the details.
SPECIFIERS
None.
EXAMPLES
The following example will display the global service status of all NDMP services and cluster-wide IQN:
showfsndmp
465
cli% showfsndmp
The following example will display various NDMP parameters for File Persona:
cli% showfsndmp -conf
The following example will display a list of all target VTL devices or VTL tapes:
cli% showfsndmp -vtl vtldevices
cli% showfsndmp -vtl vtltapes
The following example will display the active NDMP sessions:
cli% showfsndmp -sessions active
The following example will display the active NDMP sessions with details:
cli% showfsndmp -sessions active -d
The following example will display the completed NDMP sessions:
cli% showfsndmp -sessions completed
The following example will display completed NDMP sessions with details:
cli% showfsndmp -sessions completed -d
NOTES
Access to all domains is required to run this command.
If no option is specified after showfsndmp, global service status and cluster-wide IQN is displayed.
The command showfsndmp -conf displays the NDMP parameters for the File Persona.
VTL information can be displayed by using the -vtl option.
NDMP sessions-related information can be displayed by using the -sessions option.
showfsnetwork
DESCRIPTION
The showfsnetwork command displays multiple network configurations.
SYNTAX
showfsnetwork [-d] [-pat] [<networkname>|<pattern>]
AUTHORITY
•
Any role in the system.
OPTIONS
-d
Used to display detailed information for network configuration.
466
showfsnetwork
-pat
Specifies the network names using glob-style patterns. Networks which have the name matching any of
the specified glob-style patterns will be displayed. Patterns can be repeated using a comma-separated
list. The -pat option must be used if <pattern> specifier is used.
SPECIFIERS
None.
EXAMPLES
The following example displays the short description for all configured networks:
cli% showfsnetwork
The following example displays detailed output for all configured networks:
cli% showfsnetwork -d
The following example displays the network with the name matching to the given pattern:
cli% showfsnetwork -pat user
NOTES
Access to all domains is required to run this command.
The "cluster" network details are automatically excluded, as it is not a data network.
showfsquota
DESCRIPTION
The showfsquota command displays the quotas for File Persona.
SYNTAX
showfsquota [options]
AUTHORITY
•
Any role in the system.
OPTIONS
-username <uname>
The user name of the quotas to be displayed.
-groupname <gname>
The group name of the quotas to be displayed.
-fstore <fstore>
The file store of the quotas to be displayed.
-vfs <vfs>
Specifies the name of the virtual file server associated with the quotas.
-fpg <fpgname>
Specifies the name of the file provisioning group hosting the virtual file server.
SPECIFIERS
showfsquota
467
None.
EXAMPLES
The following example displays the quotas for the virtual file server examplevfs:
cli% showfsquota -vfs examplevfs
NOTES
Access to all domains is required to run this command.
Only one set of quotas may be specified per call.
To apply to all users or groups, use the -all specifier.
Users/groups configured on Active Directory or the LDAP server are displayed in the format of "<netbios>
\<name>". The <netbios> is the Active Directory or LDAP server NetBIOS name, which can be found by
running "showfs -ad" or "showfs -ldap".
showfsroute
DESCRIPTION
The showfsroute command displays all routes including default or created with createfsroute.
SYNTAX
showfsroute [-d] [-target <targetaddr>] [-vlan <vlantag>] [-gateway
<gatewayaddr>]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Displays the detailed information for each route.
-target <targetaddr>
Takes an IPv4/IPv6 address and lists all routes for this address.
-vlan <vlantag>
Takes an integer value and lists routes configured on this vlan.
-gateway <gatewayaddr>
Displays all routes with this gateway.
SPECIFIERS
None.
EXAMPLES
The following example will display all the routes:
cli% showfsroute
The following example displays all routes for specified target address:
468
showfsroute
cli% showfsroute -target 10.16.26.111
The following example will display the route for specified target address at given vlan tag and gateway:
cli% showfsroute -target 10.16.26.111 -vlan 10 -gateway 10.16.26.1
The following example will display a detailed list of all routes:
cli% showfsroute -d
Use the following to get a description of each column in the above examples:
clihelp -col showfsroute
NOTES
Access to all domains is required to run this command.
If no option is specified after showfsroute all routes will be listed.
showfstore
DESCRIPTION
The showfstore command displays information on the file stores.
SYNTAX
The syntax for the showfstore command is as follows:
showfstore [-fpg <fpgname> [-vfs <vfs> [-fstore <fstore>]]]
AUTHORITY
•
Any role in the system.
OPTIONS
-fpg <fpgname>
Limit the display to virtual file servers contained within the FPG.
-vfs <vfs>
Limit the display to the specified virtual file server.
-fstore <fstore>
Limit the display to the specified file store.
SPECIFIERS
None.
EXAMPLES
showfstore
469
The following example displays all file stores on FPG named "fpg1" under VFS named "vfs1":
cli% showfstore -fpg fpg1 -vfs vfs1
--------Security-------Fstore VFS
FPG State
Mode
ErrorSuppression
.admin vfs1
fstore1 vfs1
fpg1 normal
fpg1 normal
legacy
ntfs
-Comment-
false
false
Use the following to get a description of each column in the above examples:
clihelp -col showfstore
NOTES
Access to all domains is required to run this command.
To specify VFS or fstore filters, the parent components must be specified.
showfsuser
DESCRIPTION
The showfsuser command displays information about local users associated with the File Persona
subsystem.
SYNTAX
showfsuser [options] [<user|pattern> ...]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Display full details on the local users.
SPECIFIERS
<username>
Limit the output to the user specified.
EXAMPLES
The following example displays information about user joe:
cli% showfsuser joe
Use the following to get a description of each column in the above examples:
470
showfsuser
clihelp -col showfsuser
NOTES
Access to all domains is required to run this command.
showhost
DESCRIPTION
The showhost command displays information about defined hosts and host paths in the system.
SYNTAX
showhost [options <arg>] [<host_name>... | <pattern> ... | <host_set> ... ]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Shows a detailed listing of host and path information. This option can be used with -agent and -domain
options.
-verbose
Shows a verbose listing of all host information. This option cannot be used with -d.
-chap
Shows the CHAP authentication properties. This option cannot be used with -d.
-desc
Shows the host descriptor information. This option cannot be used with -d.
-agent
Shows information provided by host agent.
-pathsum
Shows summary information about hosts and paths. This option cannot be used with -d.
-persona
Shows the host persona settings in effect. This option cannot be used with -d.
-listpersona
Lists the defined host personas. This option cannot be used with -d.
-noname
Shows only host paths (WWNs and iSCSI names) not assigned to any host.
This option cannot be used with -d.
-domain <domainname_or_pattern,...> | <domain_set>
Shows only hosts that are in domains or domain sets that match one or more of the specifier
<domainname_or_pattern> or set <domainset> arguments. The set name <domain_set> must start with
"set:". This specifier does not allow listing objects within a domain of which the user is not a member.
-lesb
showhost
471
Shows the CRC error counts for the host/port.
SPECIFIERS
<host_name>...
Name of the host up to 31 characters in length. This specifier can be repeated to specify multiple hosts.
<pattern>...
Specifies that information is shown for all hosts matching the specified glob-style pattern. This specifier
can be repeated to show information for multiple hosts using different patterns.
<host_set>...
Specifies that information about all the hosts that are members of set <host_set> should be displayed.
The set name <host_set> must start with "set:". Acts as if all members were individually specified as
parameters to the comment. May be repeated to specify multiple host sets.
EXAMPLES
The following example displays detailed host and path information:
cli% showhost -d
The following will show all hosts in host set, host_set1:
cli% showhost set:host_set1
Id Name Persona
-WWN/iSCSI_Name- Port
0 host1 Generic-ALUA
1 host2 Generic-ALUA
Use the following to get a description of each column in the above examples:
clihelp -col showhost
NOTES
If hostnames, host sets or patterns are specified, then hosts with names that match any of the patterns or
are members of the sets are listed.
Otherwise all hosts are listed. Patterns are glob-style (shell-style) patterns. (For more information, issue
"clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
Host descriptor information is available only for hosts that have been assigned a name via the createhost
on page 151 command.
A Domain column may be included by using the setclienv command to set listdom to 1. The listdom
option is also set to 1 if the CLI was started with the -listdom option, or if the CLI was started with the
TPDLISTDOM environment variable set. Issue "cli -h" and "setclienv -h" for details of the
environment variables.
showhostset
DESCRIPTION
472
showhostset
The showhostset command lists the host sets defined on the storage system and their members.
SYNTAX
showhostset [options] [<setname_or_pattern>...]
showhostset -host [options] [<hostname_or_pattern>...]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Show a more detailed listing of each set.
-host
Show host sets that contain the supplied hostnames or patterns
SPECIFIERS
<setname_or_pattern>...
An optional list of setnames or patterns. If no setnames or patterns are specified all sets are displayed,
otherwise only sets with names matching one or more of the setnames or patterns are displayed.
The patterns are glob-style patterns. (For more information, issue "clihelp sub,globpat" or see Glob-Style
Patterns on page 15.)
<hostname_or_pattern>...
Specifies that the sets containing hosts with the specified names or matching the glob-style patterns
should be displayed.
EXAMPLES
Show all host sets defined to the system:
cli% showhostset
Id Name
Members
22 myset
18 seta
3 sunv40z-09 sunv40z-09-0
sunv40z-09-1
sunv40z-09-2
sunv40z-09-3
---------------------------3 total 4
Show the details of myset only:
cli% showhostset -d myset
Id Name Members Comment
22 myset This is an empty set
------------------------------------1 total 0
Show the host sets containing host sun40z-09-0:
Show Commands
473
cli% showhostset -host sun40z-09-0
Id Name
Members
3 sunv40z-09 sunv40z-09-0
sunv40z-09-1
sunv40z-09-2
sunv40z-09-3
---------------------------1 total 4
Use the following to get a description of each column in the above examples:
clihelp -col showhostset
NOTES
A Domain column may be included by using the setclienv on page 312 command to set listdom to 1. The
listdom option is also set to 1 if the CLI was started with the -listdom option, or if the CLI was started with
the TPDLISTDOM environment variable set. Issue "cli -h" and "setclienv -h" for details of the
environment variables.
Total line in the output specifies the total number of unique objects.
showinventory
DESCRIPTION
Shows information about all the hardware components in the system.
SYNTAX
showinventory [options]
AUTHORITY
•
Any role in the system
OPTIONS
-svc
Displays inventory information with HPE serial number, spare part number, and so on. It is not supported
on HPE 3PAR 10000 systems.
SPECIFIERS
None.
EXAMPLES
None.
NOTES
The inventory is divided into sections and inventory for each of these sections can be shown separately
with the following commands:
474
showinventory
Section
Command
Node
shownode -i
Battery
showbattery -i
Port
showport -i
Cage
showcage -i
Disk
showpd -i
showiscsisession
DESCRIPTION
The showiscsisession command shows the iSCSI sessions.
SYNTAX
showiscsisession [options <arg>] [<node:slot:port>|<pattern>...]
AUTHORITY
•
Any role in the system
OPTIONS
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-d
Specifies that more detailed information about the iSCSI session is displayed. If this option is not used,
then only summary information about the iSCSI session is displayed.
-state
Specifies the connection state of current iSCSI sessions. If this option is not used, then only summary
information about the iSCSI session is displayed.
SPECIFIERS
<node:slot:port>
Requests that information for a specified port is displayed. This specifier can be repeated to display
session information about multiple ports. If not specified, session information for all ports in the system is
displayed.
•
node
•
Specifies the node using a number from 0 through 7.
slot
showiscsisession
475
Specifies the PCI slot in the specified node. Valid range is 0 - 9.
port
•
Specifies the port using a number from 1 through 4.
<pattern>
Specifies that sessions matching the specified glob-style pattern are displayed. This specifier can be
repeated to display session information about multiple ports and iSCSI names. If not specified, session
information for all ports and iSCSI names in the system is displayed.
EXAMPLES
The following example demonstrates iSCSI session information with VLAN support:
N:S:P ---IPAddr---- TPGT TSIH Conns ------------iSCSI_Name-------------------StartTime------- VLAN State
0:1:1 192.168.50.11
11
15
1 iqn.1994-05.com.redhat:77334663e399
2016-10-07 07:25:38 MDT
- ONLINE
1:1:1 192.168.50.11 111
15
1 iqn.1994-05.com.redhat:77334663e399
2016-10-07 07:25:42 MDT
- ONLINE
---------------------------------------------------------------------------------------------------------Use the following to get a description of each column in the above examples:
clihelp -col showiscsisession
NOTES
None.
showld
DESCRIPTION
The showld command displays configuration information about the system's LDs.
SYNTAX
showld [options <arg>] [<LD_name> |<pattern>...]
AUTHORITY
•
Any role in the system
OPTIONS
-cpg <CPG_name|pattern>...
Requests that only LDs in common provisioning groups (CPGs) that match the specified CPG names or
patterns be displayed. Multiple CPG names or patterns can be repeated using a comma-separated list
(for example -cpg <CPG_name>,<CPG_name>...)
-vv <VV_name|pattern>...
Requests that only LDs mapped to virtual volumes that match and of the specified names or patterns be
displayed. Multiple volume names or patterns can be repeated using a comma-separated list (for example
-vv <VV_name>,<VV_name>...).
-domain <domainname|pattern>...
476
showld
Only shows LDs that are in domains with names that match any of the names or specified patterns.
Multiple domain names or patterns can be repeated using a comma separated list (for example -domain
<domainname_name>,<domainname_name>...).
-degraded
Only shows LDs with degraded availability.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
-d
Requests that more detailed layout information is displayed.
-ck
Requests that checkld information is displayed.
-p
Requests that policy information about the LD is displayed.
-state
Requests that the detailed state information is displayed.
This is the same as -s.
-s
Requests that the detailed state information is displayed.
This option is deprecated and will be removed in a subsequent release.
SPECIFIERS
<LD_name>...
Requests that information for a specified LD is displayed. This specifier can be repeated to display
configuration information about multiple LDs. If not specified, configuration information for all LDs in the
system is displayed.
<pattern>...
Specifies that the LD matching the specified glob-style pattern is displayed. This specifier can be
repeated to display configuration information about multiple LDs. If not specified, configuration information
for all LDs in the system is displayed.
EXAMPLES
The following example displays information for system LDs:
Show Commands
477
cli% showld
Id Name
RAID -Detailed_StateWThru MapV
2 .srdata.usr.0
1 normal
N
Y
3 .srdata.usr.1
1 normal
N
Y
0 admin.usr.0
1 normal
N
Y
1 admin.usr.1
1 normal
N
Y
8 log0.0
N
9 log1.0
Y
N
10 pdsld0.0
Y
N
11 pdsld0.1
Y
N
12 pdsld0.2
Y
N
...
Own SizeMB UsedMB Use
Lgct LgId
0/1
40960
40960 C,V
0
---
1/0
40960
40960 C,V
0
---
0/1
5120
5120 V
0
---
1/0
5120
5120 V
0
---
1 normal
0/-
20480
0 log
0
---
1 normal
1/-
20480
0 log
0
---
1 normal
1/0
1024
0 P,F
0
---
1 normal
0/1
4096
0 P
0
---
1 normal
1/0
4096
0 P
0
---
Y
The following example displays information for LDs in a four node system:
478
Show Commands
cli% showld
Id Name
RAID -Detailed_StateLgId WThru MapV
4 .srdata.usr.0
1 normal
--N
Y
5 .srdata.usr.1
1 normal
--N
Y
6 .srdata.usr.2
1 normal
--N
Y
7 .srdata.usr.3
1 normal
--N
Y
8 .srdata.usr.4
1 normal
--N
Y
9 .srdata.usr.5
1 normal
--N
Y
10 .srdata.usr.6
1 normal
--N
Y
11 .srdata.usr.7
1 normal
--N
Y
0 admin.usr.0
1 normal
--N
Y
1 admin.usr.1
1 normal
--N
Y
2 admin.usr.2
1 normal
--N
Y
3 admin.usr.3
1 normal
--N
Y
12 log0.0
1 normal
--Y
N
13 log1.0
1 normal
--Y
N
14 log2.0
1 normal
--Y
N
15 log3.0
1 normal
--Y
N
...
Own
SizeMB
UsedMB Use
Lgct
0/1/2/3
14336
14336 V
0
0/1/3/2
6144
6144 V
0
1/0/2/3
14336
14336 V
0
1/0/3/2
6144
6144 V
0
2/3/0/1
14336
14336 V
0
2/3/1/0
6144
6144 V
0
3/2/0/1
14336
14336 V
0
3/2/1/0
6144
6144 V
0
0/1/2/3
3072
3072 V
0
1/0/3/2
3072
3072 V
0
2/3/0/1
3072
3072 V
0
3/2/1/0
3072
3072 V
0
0/-/-/-
20480
0 log
0
1/-/-/-
20480
0 log
0
2/-/-/-
20480
0 log
0
3/-/-/-
20480
0 log
0
The following example displays detailed information about the system LDs:
Show Commands
479
cli% showld -d
Id Name
CPG RAID Own SizeMB RSizeMB RowSz StepKB SetSz Refcnt
Avail CAvail
-----CreationTime------ ---CreationPattern---7 .srdata.usr.0 --1 0/1 30720
61440
15
256
2
0
cage port
2016-07-13 10:06:06 PDT -8 .srdata.usr.1 --1 1/0 30720
61440
15
256
2
0
cage port
2016-07-13 10:06:06 PDT -0 admin.usr.0
--1 0/1
5120
10240
5
256
2
0
cage port
2016-07-13 10:02:26 PDT -1 admin.usr.1
--1 1/0
5120
10240
5
256
2
0
cage port
2016-07-13 10:02:26 PDT -2 log0.0
--1 0/- 20480
40960
4
256
2
0
cage port
2016-07-13 10:03:17 PDT -p -nd 0
3 log1.0
--1 1/- 20480
40960
4
256
2
0
cage port
-------------------------------------------------------------------------------------------------------------------------------6
112640 225280
The following example displays policy information about system LDs:
cli% showld -p
Id Name
Keep_Preserved Dev_Type RPM
7 .srdata.usr.0
1 FC
10
8 .srdata.usr.1
1 FC
10
0 admin.usr.0
1 FC
10
1 admin.usr.1
1 FC
10
2 log0.0
0 FC
10
3 log1.0
0 FC
10
...
The following example displays detailed states of each LD:
cli% showld -state
Id Name
7 .srdata.usr.0
8 .srdata.usr.1
0 admin.usr.0
1 admin.usr.1
2 log0.0
3 log1.0
...
-State- -Detailed_Statenormal normal
normal normal
normal normal
normal normal
normal normal
normal normal
Use the following to get a description of each column in the above examples:
480
Show Commands
clihelp -col showld
NOTES
For this command, KB=1024 bytes and MB=1048576 bytes.
A Domain column may be included by using the setclienv on page 312 command to set listdom to 1. The
listdom option is also set to 1 if the CLI was started with the -listdom option, or if the CLI was started with
the TPDLISTDOM environment variable set. Issue "cli -h" and "setclienv -h" for details of the
environment variables.
showldch
DESCRIPTION
The showldch command displays configuration information about the chunklet mapping for one logical
disk (LD).
SYNTAX
showldch [options <arg>] <LD_name>
AUTHORITY
•
Any role in the system
OPTIONS
-degraded
Shows only the chunklets in sets that cause the logical disk availability to be degraded. For example, if
the logical disk normally has cage level availability, but one set has two chunklets in the same cage, then
the chunklets in that set are shown. This option cannot be specified with option -lformat or -linfo.
-lformat <form>
Shows the logical disk's row and set layout on the physical disk, where the line format <form> is one of:
•
•
row—One line per logical disk row.
set—One line per logical disk set.
-linfo <info>[,<info>...]
Specifies the information shown for each logical disk chunklet, where <info> can be one of:
•
•
•
pdpos—Shows the physical disk position (default).
pdid—Shows the physical disk ID.
pdch—Shows the physical disk chunklet.
If multiple <info> fields are specified, each corresponding field will be shown separately by a dash (-).
SPECIFIERS
<LD_name>
Specifies the logical disk name.
EXAMPLES
The following example displays information about chunklets for logical disk r1.usr.0:
showldch
481
cli% showldch r1.usr.0
Ldch Row Set PdPos Pdid Pdch State Usage Media Sp From
0
0
0 1:3:2
30
0 normal
ld valid N --1
0
0 1:3:3
31
3 normal
ld valid N 10:0
2
0
1 2:3:1
45
0 normal
ld valid N --3
0
1 1:3:0
28
0 normal
ld valid N --4
0
2 0:1:2
6
0 normal
ld valid N --5
0
2 2:1:3
39
0 normal
ld valid N --6
0
3 0:2:0
8
0 normal
ld valid N --7
0
3 1:2:2
26
0 normal
ld valid N --8
0
4 2:3:3
47
0 normal
ld valid N --9
0
4 1:1:2
22
0 normal
ld valid N --10 0
5 2:2:3
43
0 normal
ld valid N --11 0
5 0:3:0
12
0 normal
ld valid N --12 0
6 0:0:0
0
0 normal
ld valid N --13 0
6 1:0:2
18
0 normal
ld valid N --14 0
7 2:0:1
33
0 normal
ld valid N --15 0
7 2:0:2
34
5 normal
ld valid N 16:1
To
---------------------------------
The following example displays information about degraded chunklets for logical disk r1.usr.0:
cli% showldch -degraded r1.usr.0
Ldch Row Set PdPos Pdid Pdch State Usage Media Sp From To
0
0 0 1:3:2
30
0 normal
ld valid N --- --1
0 0 1:3:3
31
3 normal
ld valid N 10:0 --14
0 7 2:0:1
33
0 normal
ld valid N --- --15
0 7 2:0:2
34
5 normal
ld valid N 16:1 --cli% showldch -degraded r1.usr.1
No degraded sets in LD r1.usr.1
The following example displays row and set layout including pdid and pdch for chunklets for logical disk
test.usr.0.
cli% showldch -lformat row -linfo pdid,pdch test.usr.0
---------Set0---------- ---------Set1---------row
Ch0
Ch1
Ch2
Ch3
Ch0
Ch1
Ch2
Ch3
0 2:3:1 1:2:2 0:3:2 1:3:0 0:0:0 2:0:1 1:2:0 0:1:0
1 2:3:3 1:0:2 0:0:2 2:0:3 0:2:2 1:1:0 2:1:1 1:3:0
2 0:3:0 2:2:1 1:2:2 2:1:3 0:1:2 1:3:2 2:3:1 0:2:2
3 0:2:0 1:2:0 2:1:3 1:0:0 2:2:3 0:0:0 1:1:2 0:1:0
4 2:3:3 1:0:2 0:3:2 2:0:1 0:0:2 1:3:0 2:1:1 1:1:2
Use the following to get a description of each column in the above examples:
clihelp -col showldch
482
Show Commands
NOTES
None.
showldmap
DESCRIPTION
The showldmap command displays the mapping from a logical (LD) disk to virtual volumes (VVs).
SYNTAX
showldmap <LD_name>
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
<LD_name>
Specifies the logical disk name.
EXAMPLES
The following example displays the region of logical disk v0.usr.0 that is used for a virtual volume:
cli% showldmap v0.usr.0
Area Start(MB) Length(MB) VVId VVName
0
0
512
0
v0
VVSp VVOff(MB)
usr 0
Use the following to get a description of each column in the above examples:
clihelp -col showldmap
NOTES
None.
showlicense
DESCRIPTION
The showlicense command displays the currently installed license key and current license information.
SYNTAX
showlicense [options]
AUTHORITY
•
Any role in the system
OPTIONS
-raw
showldmap
483
Specifies that the license key originally entered (the raw license) be displayed. The license key is
displayed in a manner that is acceptable input for the setlicense command.
SPECIFIERS
None.
EXAMPLES
The following example displays the currently installed license information:
cli% showlicense
License key was generated on Mon Sep 14 18:30:24 2015
License features currently enabled:
3PAR OS Suite
Dynamic Optimization
Recovery Manager for Exchange
Recovery Manager for Oracle
System Reporter
Remote Copy
Thin Provisioning (102400G)
VSS Provider for Microsoft Windows
License features enabled on a trial basis:
Virtual Copy
Expires on November 13, 2015
The following example displays the original license key entered on the system:
cli% showlicense -raw
60R3-0C1G-60R3-2C1G-60R3-0C9G-70R3-0C1G
60RK-0C0A-FSXZ-8YZ4-Z884-84DW-7CD6-JLKB...
NOTES
Without options, a description of which features are enabled is displayed, When the license was
generated and any expiration dates are also shown. If the -raw option is specified, the license key will be
printed in a manner that is acceptable input for the setlicense on page 364 command.
shownet
DESCRIPTION
The shownet command displays the configuration and status of the administration network interfaces,
including the configured gateway and network time protocol (NTP) server.
SYNTAX
shownet [option]
AUTHORITY
•
Any role in the system
OPTIONS
-d
484
shownet
Show detailed information.
SPECIFIERS
None.
EXAMPLES
The following example displays the status of the system administration network interfaces:
cli% shownet -d
IP Address: 192.168.5.191 Netmask 255.255.252.0
Assigned to nodes: 01
Connected through node 0
Status: Active
Admin interface on node 0
MAC Address: 00:02:AC:43:00:34
RX Packets:
534389
RX Bytes:
67828134
RX Errors:
0
RX Dropped:
0
RX FIFO Errors:
0
RX Frame Errors:
0
RX Multicast:
0
RX Compressed:
0
TX
TX
TX
TX
TX
TX
TX
TX
Packets:
Bytes:
Errors:
Dropped:
FIFO Errors:
Collisions:
Carrier Errors:
Compressed:
121669
60638375
0
0
0
0
0
0
Remote copy interface in slot 1 on node 0
...
Admin interface on node 1
...
Use the following to get a description of each column in the above examples:
clihelp -col shownet
NOTES
If the -d option is specified, information for administration, File Persona, node rescue, and Remote Copy
over IP (RCIP) interfaces is displayed. This information is useful for debugging possible network issues.
shownode
DESCRIPTION
The shownode command displays an overview of the node-specific properties and its component
information. Various command options can be used to display the properties of PCI cards, CPUs,
Physical Memory, IDE drives, and Power Supplies.
SYNTAX
shownode [option] [<node_ID> ...]
shownode
485
AUTHORITY
•
Any role in the system
OPTIONS
The following options are for node summary and inventory information:
-listcols
List the columns available to be shown with the -showcols option described below (see 'clihelp -col
shownode' for help on each column).
By default (if none of the information selection options below are specified) the following columns are
shown:
Node Name State Master InCluster LED Control_Mem Data_Mem Available_Cache
To display columns pertaining to a specific node component use the -listcols option in conjunction with
one of the following options: -pci, -cpu, -mem, -drive, -fan, -ps, -mcu, -uptime.
-showcols <column>[,<column>...]
Explicitly select the columns to be shown using a comma-separated list of column names. For this option,
the full column names are shown in the header.
Run 'shownode -listcols' to list Node component columns.
Run 'shownode -listcols <node_component>' to list columns associated with a specific
<node_component>.
<node_component> can be one of the following options: -pci, -cpu, -mem,-drive, -fan, -ps, -mcu, uptime.
If a specific node component option is not provided, then -showcols expects Node columns as input.
If a column (Node or specific node component) does not match either the Node columns list or a specific
node component columns list, then 'shownode -showcols <cols>' request is denied.
If an invalid column is provided with -showcols, the request is denied.
The -showcols option can also be used in conjunction with a list of node IDs.
Run 'clihelp -col shownode' for a description of each column.
-i
Shows node inventory information in table format.
-d
Shows node and its component information in table format.
The following options are for node component information. These options cannot be used together with
options, -i and -d:
-verbose
Displays detailed information in verbose format. It can be used together with the following component
options.
-fan
Displays the node fan information.
-pci
Displays PCI card information.
-cpu
Displays CPU information.
486
Show Commands
-mem
Displays physical memory information.
-drive
Displays the disk drive information.
-ps
Displays power supply information.
-mcu
Displays MicroController Unit information.
-state
Displays the detailed state information for node or power supply (-ps).
This is the same as -s.
-s
Displays the detailed state information for node or power supply (-ps).
This option is deprecated and will be removed in a subsequent release.
-uptime
Show the amount of time each node has been running since the last shutdown.
-svc
Displays inventory information with HPE serial number, spare part etc.
This option must be used with -i option and it is not supported on HPE 3PAR 10000 systems.
SPECIFIERS
<node_ID>...
Displays the node information for the specified node ID(s). This specifier is not required. Node_ID is an
integer from 0 through 7.
EXAMPLES
The following example displays the operating environment status for all nodes in the system:
cli% shownode
Control Data
Cache
Node -Name-- -State-- Master InCluster ---LED--- Mem(MB) Mem(MB)
Available(%)
0 nodeh7 Degraded No
Yes
GreenBlnk
2048
2048
100
1 nodeh3c Degraded Yes
Yes
GreenBlnk
2048
2048
100
The following examples display detailed information (-d option) for the nodes including their components
in a table format. The shownode -d command can be used to display the tail information of the nodes
including their components in name and value pairs.
Show Commands
487
cli% shownode -mem
-----------------------------------Physical
Memory-----------------------------------Node Riser Slot SlotID -Name-- -Usage- --Type---Latency- Size(MB)
0 n/a
0 J4200 DIMM0
Control FB-DIMM
CL5.0/5.0 2048
0 n/a
1 J4300 DIMM1
Control FB-DIMM
CL5.0/5.0 2048
0 2-slot
0 J0901 DIMM0.0 Data
DDR_SDRAM
CL2.0/2.5 2048
0 4-slot
1 J0900 DIMM1.0 Data
DDR_SDRAM
CL2.0/2.5 2048
0 4-slot
2 J1300 DIMM2.0 Data
DDR_SDRAM
CL2.0/2.5 2048
1 n/a
0 J4200 DIMM0
Control FB-DIMM
CL5.0/5.0 2048
1 n/a
1 J4300 DIMM1
Control FB-DIMM
CL5.0/5.0 2048
1 2-slot
0 J0901 DIMM0.0 Data
DDR_SDRAM
CL2.0/2.5 2048
1 4-slot
1 J0900 DIMM1.0 Data
DDR_SDRAM
CL2.0/2.5 2048
1 4-slot
2 J1300 DIMM2.0 Data
DDR_SDRAM
CL2.0/2.5 2048
--Manufacturer--- -SerialMicron Technology E20BCA01
Micron Technology E20BCA0C
Micron Technology E010DF6E
Micron Technology E010DF67
Micron Technology E010DF63
Micron Technology E20BC9AC
Micron Technology E20BC9AE
Micron Technology E010DF95
Micron Technology E010DF97
Micron Technology E010DF96
cli% shownode -drive
----------------------------Internal Drives---------------------------Node Drive -Manufacturer- ---Model--- -Serial- -Firmware- Size(MB) Type
0
0 Seagate
ST9100821AS 5NJ09DF3 3.AAB
95396 SATA
1
0 Seagate
ST9100821AS 5NJ08NA4 3.AAB
95396 SATA
cli% shownode -pci
--------------------------PCI
Node Slot Type -Manufacturer0
0 FC
QLOGIC
0
1 FC
QLOGIC
1
0 FC
QLOGIC
Cards--------------------------Model- -Serial- -Rev- Firmware
2302
D13503
1
3.3.16
2302
D44171
1
3.3.16
2302
C31037
1
3.3.16
cli% shownode -cpu
--------------------------------CPUs-------------------------------Node CPU -Manufacturer- -----Serial----- CPUSpeed(MHz) BusSpeed(MHz)
0
0 GenuineIntel
000188AAF2AEA667
995
132.76
0
1 GenuineIntel
0000D8D47BD100A6
995
132.76
1
0 GenuineIntel
0000F5A65AAD5D6F
995
132.72
1
1 GenuineIntel
00028FE5F6E4068D
995
132.72
488
Show Commands
cli% shownode -ps
-------------------------Power Supplies-------------------------Node PS -PSState-- FanState ACState DCState -BatState- ChrgLvl(%)
0 0 OK
OK
OK
OK
OK
100
0 1 OK
OK
OK
OK
OK
100
1 0 OK
OK
OK
OK
OK
100
1 1 OK
OK
OK
OK
OK
100
cli%
Node
0
1
2
3
shownode -state
-State- -Detailed_StateOK
OK
OK
OK
OK
OK
OK
OK
Use the following to get a description of each column in the above examples:
clihelp -col shownode
NOTES
None.
shownodeenv
DESCRIPTION
The shownodeenv command displays the node operating environment status, including voltages and
temperatures.
SYNTAX
shownodeenv [options <arg>...]
AUTHORITY
•
Any role in the system
OPTIONS
-n <node_ID>...
Specifies the ID of the node whose environment status is displayed.
Multiple node IDs can be specified as a series of integers separated by a space (1 2 3). If no option is
used, then the environment status of all nodes is displayed.
SPECIFIERS
None.
EXAMPLES
The following example displays the operating environment status for all nodes in the system:
shownodeenv
489
cli% shownodeenv
Node 0
--------Measurement
CPU0 1.32V:
CPU1 1.32V:
82563 1.20V:
31154 1.30V:
82563 1.90V:
...
Node 1
--------Measurement
...
Reading
1.31 V
1.31 V
1.22 V
1.29 V
1.92 V
Lo Limit Hi Limit
1.28 V
1.36 V
1.28 V
1.36 V
1.13 V
1.26 V
1.22 V
1.37 V
1.79 V
2.00 V
Status
Within
Within
Within
Within
Within
Reading
Lo Limit Hi Limit
Status
Use the following to get a description of each column in the above examples:
clihelp -col shownodeenv
NOTES
None.
showpatch
DESCRIPTION
The showpatch command displays patches applied to a system.
SYNTAX
showpatch [option <arg>]
AUTHORITY
•
Any role in the system
OPTIONS
-hist
Specifies the history of all patches and updates applied to the system.
-d <ID>
Shows details on a specified patch ID.
SPECIFIERS
None.
EXAMPLES
The following example shows all patches installed on the system:
cli% showpatch
490
showpatch
Tolerance
Tolerance
Tolerance
Tolerance
Tolerance
The showpatch command is specific to each individual patch and typically displays these fields:
Patch ID.
Release Version.
Synopsis.
Date.
Bugs fixed.
Description.
Affected Packages.
Obsoletes.
Requires.
by this patch.
Notes.
Specifies
Specifies
Specifies
Specifies
Specifies
Specifies
Specifies
Specifies
Specifies
the patch ID.
TPD or UI release affected by the patch.
the purpose of the patch.
the build date of the patch.
the bugs fixed.
a detailed description of the problem or fix.
the new packages being changed.
the patch IDs deleted by this patch.
the patch IDs of any other patches required
Specifies any special instructions for the patch.
Use the following to get a description of each column in the above examples:
clihelp -col showpatch
NOTES
This command displays all the patches currently affecting the system if options are not used.
showpd
DESCRIPTION
The showpd command displays configuration information about a system's physical disks.
SYNTAX
showpd [options] [<PD_ID> ...]
showpd -listcols
AUTHORITY
•
Any role in the system
OPTIONS
-listcols
List the columns available to be shown in the -showcols option described below (see 'clihelp -col
showpd' for help on each column).
The [options] are generally of two kinds: those that select the type of information that is displayed, and
those that filter the list of PDs that are displayed.
By default (if none of the information selection options below are specified) the following columns are
shown:
Id CagePos Type RPM State Size_MB Free_MB Port_A0 Port_B0 Port_A1 Port_B1
Capacity
Options that select the type of information shown include the following:
-showcols <column>[,<column>...]
showpd
491
Explicitly select the columns to be shown using a comma-separated list of column names. For this option
the full column names are shown in the header. For other options that select the type of information, the
column names may not be exactly the same and there may be spanning headers on top of the column
names.
Run 'showpd -listcols' to list the available columns.
Run 'clihelp -col showpd' for a description of each column.
-i
Show disk inventory (inquiry) data.
The following columns are shown:
Id CagePos State Node_WWN MFR Model Serial FW_Rev Protocol MediaType
AdmissionTime.
-e
Show disk environment and error information. Note that reading this information places a significant load
on each disk.
The following columns are shown:
Id CagePos Type State Rd_CErr Rd_UErr Wr_CErr Wr_UErr Temp_DegC LifeLeft_PCT.
-c
Show chunklet usage information. Any chunklet in a failed disk will be shown as "Fail".
The following columns are shown:
Id CagePos Type State Total_Chunk Nrm_Used_OK Nrm_Used_Fail Nrm_Unused_Free
Nrm_Unused_Uninit Nrm_Unused_Unavail Nrm_Unused_Fail Spr_Used_OK
Spr_Used_Fail Spr_Unused_Free Spr_Unused_Uninit Spr_Unused_Fail.
-s
Show detailed state information.
This option is deprecated and will be removed in a subsequent release.
-state
Show detailed state information. This is the same as -s.
The following columns are shown:
Id CagePos Type State Detailed_State SedState.
-path
Show current and saved path information for disks.
The following columns are shown:
Id CagePos Type State Path_A0 Path_A1 Path_B0 Path_B1 Order.
-space
Show disk capacity usage information (in MB).
The following columns are shown:
Id CagePos Type State Size_MB Volume_MB Spare_MB Free_MB Unavail_MB
Failed_MB.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
492
Show Commands
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
The PD filtering options include:
-failed
Specifies that only failed physical disks are displayed.
-degraded
Specifies that only degraded physical disks are displayed. If both-failed and -degraded are specified, the
command shows failed disks and degraded disks.
-p <pattern>
Physical disks matching the specified pattern are displayed.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0-7).
The primary path of the disks must be on the specified node(s).
-st <item>
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0-7). The
primary path of the disks must be on the specified PCI slot(s).
-pt <item>
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0-4). The
primary path of the disks must be on the specified port(s).
-cg <item>
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
•
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
output indicating the side of the cage is omitted when using the -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single comma
(e.g. 1,2,3). A range of drive magazines is separated with a hyphen(e.g. 0-7). The specified drive
magazine(s) must contain disks.
-pn <item>
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen(e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
Show Commands
493
•
Specifies one or more physical disks. Disks are identified by one or more integers (item). Multiple
disks are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g.
0-3). Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
Specifies that physical disks with free chunklets greater than the number specified be selected.
-fc_lt <number>
•
Specifies that physical disks with free chunklets less than the number specified be selected.
-devid <model>
•
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the "showpd -i" command.
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd"
command.
-rpm <number>
Drives must be of the specified relative performance metric, as shown in the "RPM" column of the
"showpd" command. The number does not represent a rotational speed for the drives without spinning
media (SSD). It is meant as a rough estimation of the performance difference between the drive and
the other drives in the system. For FC and NL drives, the number corresponds to both a performance
measure and actual rotational speed. For SSD drives, the number is to be treated as a relative
performance benchmark that takes into account I/O's per second, bandwidth and access time.
Disks that satisfy all of the specified characteristics are used.
For example -p -fc_gt 60 -fc_lt 230 -nd 2 specifies all the disks that have greater than 60 and less than
230 free chunklets and that are connected to node 2 through their primary path.
-nodes <node_list>
Specifies that the display is limited to specified nodes and physical disks connected to those nodes. The
node list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the node list is not specified, all disks on all nodes are displayed.
-slots <slot_list>
Specifies that the display is limited to specified PCI slots and physical disks connected to those PCI slots.
The slot list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist
of a single integer. If the slot list is not specified, all disks on all slots are displayed.
-ports <port_list>
Specifies that the display is limited to specified ports and physical disks connected to those ports. The
port list is specified as a series of integers separated by commas (e.g. 1,2,3). The list can also consist of
a single integer. If the port list is not specified, all disks on all ports are displayed.
-w <world-wide_name>...
Specifies the WWN of the physical disk. This option and argument can be specified if the <PD_ID>
specifier is not used. This option should be the last option in the command line.
SPECIFIERS
<PD_ID>
494
Show Commands
Specifies a physical disk ID. This specifier can be used if the -w option is not specified.
EXAMPLES
The following example displays chunklet use information for all disks:
cli% showpd -c
The following example displays chunklet use information for the Nearline disks only:
cli% showpd -c -p -devtype NL
The following example displays disk information for the Nearline disks on cage 0 and 3 only:
cli% showpd -p -cg 0,3 -devtype NL
The following example displays disk information for the Nearline disks on cage 0 and sort the output by
the cage position:
cli% showpd -sortcol 1 -p -cg 0,0 -devtype NL
The following example displays all the FC disks in magazine 0 of cage 4 and 5:
cli% showpd -p -mg 0 -cg 4,5 -devtype FC
The following example displays all the FC disks in magazine 0 of all cages and all FC disks in cages 4
and 5:
cli% showpd -p -mg 0 -devtype FC -p -cg 4,5 -devtype FC
Use the following to get a description of each column in the above examples:
clihelp -col showpd
NOTES
In the showpd output, when the position of the disk is not valid (for example, in the case of a missing
disk), the most recent position might be displayed, followed by a question mark (?).
To see the device type for a physical disk (Fast Class, Nearline, or Solid State Drive), use showpd.
Show Commands
495
Without the -i, -c, -e, -s, -path or -space options, basic information about the physical disk is printed. Note
that the primary path to the disk is shown by an asterisk (*) in either the APort or BPort column, and a
minus (-) sign following a path indicates the port is disabled.
If the <PD_ID> specifier is not specified and -w is not specified, all disks will be displayed.
showpdata
DESCRIPTION
The showpdata command displays information about the preserved data in the system.
SYNTAX
showpdata [<LD_name>]
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
<LD_name>
Requests that preserved data for a specific LD is displayed. This specifier is not required on the
command line. If not specified, then the amount of preserved data by LD is displayed.
EXAMPLES
The following example displays preserved data information for LD admin.usr.3:
cli% showpdata admin.usr.3
showpdata v0.usr.0
Preserved LD raid sets
Ldname
Set
PreservedCnt
admin.usr.3
0 1
No preserved chunklets
NOTES
Access to all domains is required to run this command if no LD name is specified. If an LD name is
specified, then access to the domain of the LD is required.
showpdch
DESCRIPTION
The showpdch command displays the status of selected physical disk (PD) chunklets.
SYNTAX
showpdch [options]
showpdch [options] <pdid>|<pattern>... (deprecated usage)
AUTHORITY
•
Any role in the system
OPTIONS
496
showpdata
The following filtering options specify conditions that a chunklet should meet in order for the chunklet to
be displayed.
Multiple conditions can be specified and a chunklet will be displayed if any of the specified conditions are
met. By default (if no filtering options are specified) only those chunklets that are mapped to an LD are
displayed.
-a
Specifies that information about all chunklets is displayed.
-fail
Specifies that information about failed chunklets(media-failed chunklets, disk-failed chunklets, or
chunklets marked as failed by the operating system) is displayed.
-mov
Specifies that information about chunklets that have moved, are scheduled to move, or are moving, is
displayed.
-from <pdid,...>
Specifies chunklets that have moved or are to be moved from the matching PD IDs are displayed.
-cln
Specifies that information for clean chunklets is displayed.
-cng
Specifies that information for chunklets that are being cleaned by the system, is displayed.
-tgt
Specifies that information for chunklets marked as targets of relocation is displayed.
-src
Specifies that information about chunklets that are marked as sources of relocation, is displayed.
-spr
Specifies that information about chunklets that are marked as spares, is displayed.
-log
Specifies that information about chunklets that are logging is displayed.
-sync
Specifies that information about chunklets that are synchronizing with their RAID sets is displayed.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
The following option is used to filter the disks on which the chunklets are to be displayed.
-p <pattern>
Specifies a pattern for disks whose chunklets are to be displayed.
If no pattern is specified, all disks are included.
Show Commands
497
If specified multiple times, each instance of the specified pattern adds additional candidate disks
matching the pattern.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0-7).
The primary path of the disks must be on the specified node(s).
-st <item>
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0-7). The
primary path of the disks must be on the specified PCI slot(s).
-pt <item>
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0-4). The
primary path of the disks must be on the specified port(s).
-cg <item>
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
•
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
output indicating the side of the cage is omitted when using the -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single comma
(e.g. 1,2,3). A range of drive magazines is separated with a hyphen (e.g. 0-7). The specified drive
magazine(s) must contain disks.
-pn <item>
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen(e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
•
Specifies one or more physical disks. Disks are identified by one or more integers (item). Multiple
disks are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g.
0-3). Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
•
Specifies that physical disks with free chunklets greater than the
number specified be selected.
-fc_lt <number>
•
Specifies that physical disks with free chunklets less than the number specified be selected.
-devid <model>
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the "showpd -i" command.
498
Show Commands
•
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd"
command.
-rpm <number>
Drives must be of the specified relative performance metric, as shown in the "RPM" column of the
"showpd" command. The number does not represent a rotational speed for the drives without spinning
media (SSD). It is meant as a rough estimation of the performance difference between the drive and
the other drives in the system. For FC and NL drives, the number corresponds to both a performance
measure and actual rotational speed. For SSD drives, the number is to be treated as a relative
performance benchmark that takes into account I/O's per second, bandwidth and access time.
Disks that satisfy all of the specified characteristics are used.
For example -p -fc_gt 60 -fc_lt 230 -nd 2 specifies all the disks that have greater than 60 and less than
230 free chunklets and that are connected to node 2 through their primary path.
SPECIFIERS
<pdid>|<pattern>... (deprecated usage)
Specifies the PD IDs or the PD ID pattern for disks whose chunklets are to be displayed.
EXAMPLES
The following example displays information about chunklets on PD 1:
cli% showpdch 1
Pdid Chnk
LdName LdCh
State Usage Media Sp Cl From To
1
0
vvfromcpg2.usr.1
0 normal
ld valid N N --- --1
1
vvfromcpg2.usr.1
4 normal
ld valid N N --- --1
2
vvfromcpg2.usr.1
8 normal
ld valid N N --- -----------------------------------------------------------------------Total chunklets: 3
Display chunklets currently on physical disk 1 that have moved from other disks:
cli%showpdch -mov -p -dk 1
Display chunklets on all physical disks that were moved from physical disk 4 and 5:
cli%showpdch -from 4,5
Display spare chunklets on physical disks on cage 3:
cli%showpdch -spr -p -cg 3
Use the following to get a description of each column in the above examples:
Show Commands
499
clihelp -col showpdch
NOTES
If no option is specified, the showpdch command defaults to displaying information about chunklets used
for logical disks.
showpdvv
DESCRIPTION
The showpdvv command displays the virtual volumes that are mapped to a particular physical disk.
SYNTAX
showpdvv [options] [<PD_ID>[:<chunklet>]...]
AUTHORITY
•
Any role in the system
OPTIONS
-sum
Shows number of chunklets used by virtual volumes for different space types for each physical disk.
-p <pattern>
Specifies a pattern to select <PD_ID> disks.
The following arguments can be specified as patterns for this option:
An item is specified as an integer, a comma-separated list of integers, or a range of integers specified
from low to high.
•
-nd <item>
•
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes are
separated with a single comma (e.g. 1,2,3). A range of nodes is separated with a hyphen (e.g. 0-7).
The primary path of the disks must be on the specified node(s).
-st <item>
•
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots are
separated with a single comma (e.g. 1,2,3). A range of slots is separated with a hyphen (e.g. 0-7). The
primary path of the disks must be on the specified PCI slot(s).
-pt <item>
•
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports are
separated with a single comma (e.g. 1,2,3). A range of ports is separated with a hyphen (e.g. 0-4). The
primary path of the disks must be on the specified port(s).
-cg <item>
•
Specifies one or more drive cages. Drive cages are identified by one or more integers (item). Multiple
drive cages are separated with a single comma (e.g. 1,2,3). A range of drive cages is separated with a
hyphen (e.g. 0-3). The specified drive cage(s) must contain disks.
-mg <item>
Specifies one or more drive magazines. The "1." or "0." displayed in the CagePos column of showpd
output indicating the side of the cage is omitted when using the -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single comma
500
showpdvv
•
(e.g. 1,2,3). A range of drive magazines is separated with a hyphen (e.g. 0-7). The specified drive
magazine(s) must contain disks.
-pn <item>
•
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one or
more integers (item). Multiple disk positions are separated with a single comma (e.g. 1,2,3). A range of
disk positions is separated with a hyphen (e.g. 0-3). The specified position(s) must contain disks.
-dk <item>
•
Specifies one or more physical disks. Disks are identified by one or more integers (item). Multiple
disks are separated with a single comma (e.g. 1,2,3). A range of disks is separated with a hyphen (e.g.
0-3). Disks must match the specified ID(s).
-tc_gt <number>
•
Specifies that physical disks with total chunklets greater than the number specified be selected.
-tc_lt <number>
•
Specifies that physical disks with total chunklets less than the number specified be selected.
-fc_gt <number>
•
•
Specifies that physical disks with free chunklets greater than the
number specified be selected.
-fc_lt <number>
•
Specifies that physical disks with free chunklets less than the number specified be selected.
-devid <model>
•
Specifies that physical disks identified by their models be selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the "showpd -i" command.
-devtype <type>
•
Specifies that physical disks must have the specified device type (FC for Fast Class, NL for Nearline,
SSD for Solid State Drive) to be used. Device types can be displayed by issuing the "showpd"
command.
-rpm <number>
Drives must be of the specified relative performance metric, as shown in the "RPM" column of the
"showpd" command. The number does not represent a rotational speed for the drives without spinning
media (SSD). It is meant as a rough estimation of the performance difference between the drive and
the other drives in the system. For FC and NL drives, the number corresponds to both a performance
measure and actual rotational speed. For SSD drives, the number is to be treated as a relative
performance benchmark that takes into account I/O's per second, bandwidth and access time.
Disks that satisfy all of the specified characteristics are used.
For example -p -fc_gt 60 -fc_lt 230 -nd 2 specifies all the disks that have greater than 60 and less than
230 free chunklets and that are connected to node 2 through their primary path.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
SPECIFIERS
<PD_ID>
Show Commands
501
Specifies the physical disk ID using an integer. This specifier is not required if -p option is used, otherwise
it must be used at least once on the command line.
[:<chunklet>]
Specifies the chunklet number in a physical disk to which virtual volumes are mapped. This specifier is
not required. This specifier cannot be used along with -p option.
EXAMPLES
The following example displays that the user space virtual volumes v0 and v1, respectively, are mapped
to physical disk 44:
cli%
PDId
44
44
showpdvv 44
CagePos Type
2:3:2
FC 10
2:3:2
FC 10
RPM VVId VVName VVSp
109 v0
usr
110 v1
usr
The following example displays the summary output for volumes mapped to physical disk 55:
cli% showpdvv -sum 55
PDId CagePos Type
55 4:9:0
FC
55 4:9:0
FC
----Chunklets---RPM VVId VVName Adm Snp Usr Total
15
2 v0
0
0
2
2
15
3 v1
0
0 20
20
Use the following to get a description of each column in the above examples:
clihelp -col showpdvv
NOTES
None.
showport
DESCRIPTION
The showport command displays information about ports in the system.
SYNTAX
showport [options] [-failed] [-sortcol <col>[,<dir>]] [<node:slot:port> |
<pattern>...]
AUTHORITY
•
Any role in the system
OPTIONS
-i
Shows port hardware inventory information.
-c
502
showport
Displays all devices connected to the port. Such devices include cages (for initiator ports), hosts (for
target ports) and ports from other storage system (for RCFC and peer ports).
-par
Displays a parameter listing such as the configured data rate of a port and the maximum data rate that
the card supports. Also shown is the type of attachment (Direct Connect or Fabric Attached) and whether
the unique_nwwn and VCN capabilities are enabled.
-rc
Displays information that is specific to the Remote Copy ports.
-rcfc
Displays information that is specific to the Fibre Channel Remote Copy ports.
-peer
Displays information that is specific to the Fibre Channel ports for Data Migration.
-rcip
Displays information specific to the Ethernet Remote Copy ports.
-iscsi
Displays information about iSCSI ports.
-iscsiname
Displays iSCSI names associated with iSCSI ports.
-iscsivlans
Displays information about VLANs on iSCSI ports.
-fcoe
Displays information that is specific to Fibre Channel over Ethernet (FCoE) ports.
-sfp
Displays information about the SFPs attached to ports.
-ddm
Displays Digital Diagnostics Monitoring (DDM) readings from the SFPs if they support DDM. This option
must be used with the -sfp option.
-d
Displays detailed information about the SFPs attached to ports. This option is used with the -sfp option.
-failed
Shows only failed ports.
-state
Displays the detailed state information. This is the same as -s.
-s
Displays the detailed state information.
This option is deprecated and will be removed in a subsequent release.
-ids
Displays the identities hosted by each physical port.
-fs
Show Commands
503
Displays information specific to the Ethernet File Persona ports.
To see IP address, netmask and gateway information on File Persona, run "showfs -net".
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
SPECIFIERS
<node:slot:port>...
Requests that information for a specified port is displayed.
This specifier can be repeated to display configuration information about multiple ports. If not specified,
configuration information for all ports in the system is displayed.
node
Specifies the node using a number from 0 through 7.
slot
Specifies the PCI slot in the specified node. Valid range is 0 - 9.
port
Specifies the port using a number from 1 through 4.
<pattern>...
Specifies that the port matching the specified glob-style pattern is displayed. This specifier can be
repeated to display configuration information about multiple ports. If not specified, configuration
information for all ports in the system is displayed.
EXAMPLES
The following example displays information about all ports in the system:
504
Show Commands
cli% showport
N:S:P
Mode
State ----Node_WWN---- -Port_WWN/HW_Addr- Type
Protocol Label Partner FailoverState
0:0:1
target
ready 2FF70002AC0000AA
20010002AC0000AA host
FC
1:0:1
none
0:0:2 initiator
ready 2FF70002AC0000AA
20020002AC0000AA disk
FC
0:0:3
target loss_sync 2FF70002AC0000AA
20030002AC0000AA free
FC
1:0:3
none
0:0:4
target
ready 2FF70002AC0000AA
20040002AC0000AA host
FC
0:3:1
target loss_sync 2FF70002AC0000AA
20310002AC0000AA free
FC
1:3:1
none
0:3:2 initiator
ready 2FF70002AC0000AA
20320002AC0000AA disk
FC
0:4:1
target
ready
00C0DD086530 iscsi
iSCSI
1:4:1
none
0:4:2
target loss_sync
00C0DD086532 iscsi
iSCSI
1:4:2
none
0:5:1 initiator
ready 2FF70002AC0000AA
20510002AC0000AA disk
FC
0:5:2
target
ready 2FF70002AC0000AA
20520002AC0000AA host
FC
1:5:2
none
0:6:1
peer
offline
0002AC53069C rcip
IP RCIP0
1:0:1
target
ready 2FF70002AC0000AA
21010002AC0000AA host
FC
0:0:1
none
1:0:2 initiator
ready 2FF70002AC0000AA
21020002AC0000AA disk
FC
1:0:3
target loss_sync 2FF70002AC0000AA
21030002AC0000AA free
FC
0:0:3
none
1:0:4 initiator
ready 2FF70002AC0000AA
21040002AC0000AA host
FC
1:3:1
target loss_sync 2FF70002AC0000AA
21310002AC0000AA free
FC
0:3:1
none
1:3:2 initiator loss_sync 2FF70002AC0000AA
21320002AC0000AA free
FC
1:4:1
target
ready
00C0DD0779C1 iscsi
iSCSI
0:4:1
none
1:4:2
target
offline
00C0DD0779C3 iscsi
iSCSI
0:4:2
none
1:5:1 initiator
ready 2FF70002AC0000AA
21510002AC0000AA disk
FC
1:5:2
target
ready 2FF70002AC0000AA
21520002AC0000AA host
FC
0:5:2
none
1:6:1
peer
offline
0002AC520041 rcip
IP RCIP1
The following example displays hardware and connection information about the ports settings:
Show Commands
505
cli% showport -i
N:S:P Brand Model
0:0:1 LSI
9205-8e
0:0:2 LSI
9205-8e
0:1:1 QLOGIC QLE2672
0:1:2 QLOGIC QLE2672
0:2:1 QLOGIC QLE8242
0:2:2 QLOGIC QLE8242
Rev
01
01
02
02
58
58
Firmware
17.11.00.00
17.11.00.00
8.1.1
8.1.1
4.15.2
4.15.2
Serial
SP12430085
SP12430085
RFE1228G50820
RFE1228G50820
PCGLTX0RC1G3PX
PCGLTX0RC1G3PX
HWType
SAS
SAS
FC
FC
CNA
CNA
The following example displays devices connected to ports and information about the ports settings on
node 0 slot 4:
cli% showport -par 0:4:*
N:S:P Connmode ConnType CfgRate MaxRate Class2
UniqNodeWwn VCN
IntCoal TMWO
0:4:1 host
point
auto
4Gbps
disabled disabled
disabled
enabled enabled
0:4:2 host
point
auto
4Gbps
disabled disabled
disabled
enabled enabled
0:4:3 disk
loop
auto
4Gbps
disabled disabled
disabled
enabled n/a
0:4:4 disk
loop
auto
4Gbps
disabled disabled
disabled
enabled n/a
---------------------------------------------------------------------------4
The following example displays each system ports' configuration:
cli% showport -par
N:S:P Connmode ConnType CfgRate
IntCoal TMWO
Smart_SAN
0:0:1 disk
point
6Gbps
enabled n/a
n/a
0:0:2 disk
point
6Gbps
enabled n/a
n/a
0:1:1 host
point
auto
enabled disabled n/a
0:1:2 host
point
auto
enabled disabled n/a
0:7:1 host
point
auto
enabled disabled n/a
0:7:2 host
point
auto
enabled disabled n/a
MaxRate Class2
UniqNodeWwn VCN
6Gbps
n/a
n/a
n/a
6Gbps
n/a
n/a
n/a
16Gbps
disabled disabled
disabled
16Gbps
disabled disabled
disabled
16Gbps
disabled disabled
disabled
16Gbps
disabled disabled
disabled
The following example displays information about all Remote Copy ports:
506
Show Commands
cli% showport -rc
N:S:P State
HwAddr
Rate
5:3:2 ready 25320002AC000006
2Gbps
4:1:1 ready 24110002AC000006
2Gbps
0:5:1 ready
0002B39B2013 100Mbps
Type
rcip
rcip
rcip
The following example displays the detailed state of the port:
cli% showport -state
N:S:P --State-- -Detailed_State0:0:1 loss_sync loss_sync
0:0:2 loss_sync loss_sync
0:3:1 offline
offline
0:3:1 offline
offline
0:5:1 loss_sync loss_sync
-------------------------------10
The following example displays information about RCIP ports:
cli% showport -rcip
N:S:P State ---HwAddr--- IPAddr Netmask Gateway MTU Rate Duplex AutoNeg
0:1:1 offline 000423C21B72 - - - - n/a n/a n/a
0:1:1 offline 000423C21B73 - - - - n/a n/a n/a
1:2:1 offline 000423ADE95E - - - - n/a n/a n/a
1:2:1 offline 000423ADE95F - - - - n/a n/a n/a
The following example displays information about iSCSI ports:
cli% showport -iscsi
N:S:P State IPAddr
Netmask/PrefixLen Gateway TPGT MTU
Rate
iSNS_Addr iSNS_Port STGT VLAN
0:2:1 ready 1df9:7b7b:790::21 64
::
21 1500
10Gbps ::
3205
21 Y
0:2:2 ready 10.99.1.3
255.255.255.0
0.0.0.0
22 1500 10Gbps
0.0.0.0
3205
22 Y
1:2:1 ready 1df9:7b7b:790::121 64
::
121 1500
10Gbps ::
3205 121 Y
1:2:2 ready 10.99.1.4
255.255.255.0
0.0.0.0 122 1500 10Gbps
0.0.0.0
3205 122 Y
-----------------------------------------------------------------------------------------------------4
The following example displays information about iSCSI names associated with iSCSI ports:
Show Commands
507
cli% showport -iscsiname
N:S:P IPAddr ---------------iSCSI_Name---------------1:3:1 0.0.0.0 iqn.2000-05.com.3pardata:21310002ac00000a
1:3:2 0.0.0.0 iqn.2000-05.com.3pardata:21320002ac00000a
The following example displays information about VLANs on iSCSI ports:
cli% showport -iscsivlans
N:S:P VLAN IPAddr
Netmask/PrefixLen Gateway MTU TPGT STGT
iSNS_Addr iSNS_Port
0:6:1
- 10.100.31.61
255.255.255.0
0.0.0.0 1500
61
61
0.0.0.0
3205
0:6:2
12 10.100.12.62
255.255.255.0
0.0.0.0 1500 1025 1025
0.0.0.0
3205
1:6:1
- 10.100.31.161
255.255.255.0
0.0.0.0 1500 161 161
0.0.0.0
3205
1:6:2
12 10.100.12.162
255.255.255.0
0.0.0.0 1500 1024 1024
0.0.0.0
3205
2:6:1
13 1df9:7b7b:53b3::13:261 64
::
1500 1027
1027 ::
3205
2:8:2
- 10.100.31.82
255.255.255.0
0.0.0.0 1500 282 282
0.0.0.0
3205
3:6:1
13 1df9:7b7b:53b3::13:361 64
::
1500 1026
1026 ::
3205
3:8:2
- 10.100.31.83
255.255.255.0
0.0.0.0 1500 382 382
0.0.0.0
3205
--------------------------------------------------------------------------------------------8
The following example displays all ports that are configured as peer:
cli% showport -peer
N:S:P Mode State ----Node_WWN---- ----Port_WWN---- Rate
0:5:1 initiator ready 2FF70202AC000007 20510202AC000007 2Gbps
The following examples display both standard and detailed information about SFPs attached to ports:
508
Show Commands
cli% showport
N:S:P -State0:0:1 OK
0:0:2 OK
0:3:2 OK
1:0:1 OK
1:0:2 OK
-sfp
-Manufacturer- MaxSpeed(Gbps) TXDisable
FINISAR_CORP.
2.10 No
FINISAR_CORP.
2.10 No
SIGMA-LINKS
2.10 No
FINISAR_CORP.
2.10 No
FINISAR_CORP.
2.10 No
TXFault
No
No
No
No
No
RXLoss
No
Yes
Yes
No
Yes
DDM
Yes
Yes
Yes
Yes
Yes
cli% showport -sfp -d
------------Port 0:0:2-----------N:S:P
:
0:0:2
State
:
Degraded
Manufacturer :
PICOLIGHT
Part Number
:
PL-XPL-VE-S24-31
Serial Number :
425EF1E6
Revision
:
N/A
MaxSpeed(Gbps):
2.10
Qualified
:
No
TX Disable
:
-TX Fault
:
-RX Loss
:
-RX Power Low :
No
DDM Support
:
No
----------Port 1:3:1----------N:S:P
:
1:3:1
State
:
OK
Manufacturer :
FINISAR_CORP.
Part Number
:
FTLF8519P2BNL
Serial Number :
U76031S
Revision
:
A
MaxSpeed(Gbps):
2.10
Qualified
:
Yes
TX Disable
:
No
TX Fault
:
No
RX Loss
:
No
RX Power Low :
No
DDM Support
:
Yes
Use the following to get a description of each column in the above examples:
clihelp -col showport
NOTES
None.
showportarp
DESCRIPTION
The showportarp command shows the ARP table for iSCSI ports in the system.
showportarp
509
SYNTAX
showportarp [<node>:<slot>:<port>]
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
[<node>:<slot>:<port>]
Specifies the port for which information about devices on that port are displayed.
node Specifies the node.
slot Specifies the PCI bus slot in the specified node.
port Specifies the iSCSI port number of the PCI card in the specified PCI bus slot. If <N>:<S>:<P> is
not specified, the ARP table for all iSCSI ports is displayed.
If <node>:<slot>:<port> is not specified, the ARP table for all iSCSI ports is displayed.
EXAMPLES
The following example displays the ARP table for the iSCSI ports in the system.
cli% showportarp
N:S:P
HwAddr
1:3:1 00E07BF8BF87
1:3:1 001143CD039A
IPAddr
Time (mins)
192.168.9.1
0
192.168.8.151
0
In the example output above:
•
•
•
HwAddr. The MAC address of a remote host discovered through the MAC address resolution process.
IPAddr. The IP address of the remote host to which the port is attempting to connect.
Time (mins). The amount of time (in minutes) that the entry has been in the table. When the entry has
been in the table for 20 minutes, it is removed.
Use the following to get a description of each column in the above examples:
clihelp -col showportarp
NOTES
None.
showportdev
DESCRIPTION
The showportdev command displays detailed information about devices on a specified port.
SYNTAX
showportdev loop|all|ns|fcf|sas|fcswitch|fcfabric <node:slot:port>
510
showportdev
showportdev sas [options] <node:slot:port>
showportdev findport <WWN> <node:slot:port>
showportdev tzone [[options] <node:slot:port>]
showportdev uns [options] <node:slot:port>
showportdev lldp [options] [<node:slot:port>]
showportdev dcbx [options] [<node:slot:port>]
SUBCOMMANDS
loop
Specifies that information is returned for arbitrated loop devices that are attached to the specified port.
This subcommand is only for use with Fibre Channel arbitrated loop ports.
all
Specifies that information for all devices attached to the specified port is returned.
ns
Specifies that information for the switch name server database is returned. This subcommand is only for
use with fabric-attached topologies.
fcf
Specifies that information for all Fibre Channel over Ethernet forwarders (FCFs) known to the specified
port is returned. This subcommand is for use only with Fibre Channel over Ethernet (FCoE) ports.
sas
Specifies that information for all devices in the SAS topology attached to the specified port is returned.
This subcommand is only for use with SAS ports.
fcswitch
Specifies that a list of all switches in the Fibre Channel fabric is returned. This subcommand is only for
use with fabric-attached Fibre Channel ports.
fcfabric
Specifies that a description of the Fibre Channel fabric is returned. This subcommand is only for use with
fabric-attached Fibre Channel ports.
findport
Searches the Fibre Channel fabric attached to the specified port for information on the supplied WWN.
Supplying the term "this" in place of a WWN indicates that the port WWN of the specified HPE 3PAR
Storage System host port should be used. This subcommand is only for use with fabric-attached Fibre
Channel ports.
tzone
Without the <node:slot:port>, this command will return a list of all the current target-driven zones for any
port. If the <node:slot:port> is provided, then detailed information about the target-driven zone for this port
will be provided. This command is only used with fabric-attached Fibre Channel ports.
uns
Specifies that information for all initiators from the switch unzoned name server database is returned. This
subcommand is only for use with fabric-attached topologies.
lldp
Specifies available Link Layer Discovery Protocol information for each iSCSI port physically connected is
returned. If the <node:slot:port> is provided, then only information for this port will be displayed. This
subcommand is only used with iSCSI QLogic 83XX series ports.
Show Commands
511
dcbx
Specifies available Data Center Bridging Exchange Protocol information for each iSCSI port physically
connected is returned. If the <node:slot:port> is provided, then only information for this port will be
displayed. This subcommand is only used with iSCSI QLogic 83XX series ports.
AUTHORITY
•
Any role in the system
OPTIONS
-pel
Includes the SAS Phy Error Log (PEL) data for each phy in the SAS topology. This option is only valid
when using the sas subcommand.
-d
Includes detailed initiator information: HBA Manufacturer, HBA Model, HBA Firmware Version, HBA OS
Name/Version, the HBA port's supported and current speeds, HBA port's OS device name, hostname,
alias name(s), and whether the Smart SAN QoS and Security features are supported.
When used with the tzone or uns subcommand. When used with the lldp or dcbx subcommand, this
option will return relevant detailed information on the LLDP and DCBX information received from the peer
device. This option is only valid when using either the tzone, uns, lldp or dcbx subcommand.
-app
Includes detailed information provided from the DCBX Application Protocol TLV configured on the peer
device.
-pfc
Includes detailed information from the DCBX Priority Flow Control TLV configured on the peer device.
-pg
Includes detailed information from the DCBX Priority Groups TLV configured on the peer device.
SPECIFIERS
[<node:slot:port>]
Specifies the port for which information about devices on that port are displayed.
node Specifies the node.
slot Specifies the PCI bus slot in the specified node.
port Specifies the Fibre Channel port number of the PCI card in the specified PCI bus slot.
[<WWN>]
Specifies the Fibre Channel worldwide port name of an attached port.
EXAMPLES
The following example displays information about all devices attached to Fibre Channel port 1:0:2:
512
Show Commands
cli% showportdev all 1:0:2
PtId LpID Hadr Node_WWN
Name
0xd3 0x0c 0x00 2FF70002AC000013
1:0:2
0xef 0x00 0xef 2000000087002078
pd7
0xe8 0x01 0xe8 2000000087002515
pd6
...
Port_WWN
ftrs
svpm
bbct flen
21020002AC000013 0x8800 0x0022 n/a
0x0800
2200000087002078 0x8800 0x0012 n/a
0x0800
2200000087002515 0x8800 0x0012 n/a
0x0800
The following example displays the SAS topology for port 1:0:2:
cli% showportdev sas 1:0:2
The following example displays the SAS topology with PEL data for port 1:0:2:
cli% showportdev sas -pel 1:0:2
The following example displays the attached Fibre Channel fabric for port 0:2:3:
cli% showportdev findport 21002C27D752ABC7 0:2:3
cli% showportdev findport this 0:2:3
The following example searches the attached Fibre Channel fabric for the port WWN of port 0:2:3:
cli% showportdev findport this 0:2:3
Use the following to get a description of each column in the above examples:
clihelp -col showportdev
NOTES
The loop subcommand is functional only in a private loop topology.
showportisns
DESCRIPTION
The showportisns command shows iSNS host information for iSCSI ports in the system.
SYNTAX
showportisns
513
showportisns [<node>:<slot>:<port>]
AUTHORITY
•
Any role in the system
OPTIONS
None.
SPECIFIERS
[<node:slot:port>]
Specifies the port for which information about devices on that port are displayed.
node Specifies the node.
slot Specifies the PCI bus slot in the specified node.
port Specifies the Fibre Channel port number of the PCI card in the specified PCI bus slot.
If this specifier is not specified, iSNS host information for all iSCSI ports is displayed.
EXAMPLES
The following example displays hosts discovered by the iSCSI port from the iSNS server in the system.
cli% showportisns
N:S:P Host_IPAddr
Host_alias------0:2:2 10.99.1.12
Initiator>
1:2:2 10.99.1.12
Initiator>
1:2:2 10.99.1.11
Initiator>
1
-----------Host_iSCSI_Name----------- -----VLAN
iqn.1991-05.com.microsoft:dl360g7-409 <MS SW iSCSI
iqn.1991-05.com.microsoft:dl360g7-409 <MS SW iSCSI
iqn.1991-05.com.microsoft:dl360g7-409 <MS SW iSCSI
Use the following to get a description of each column in the above examples:
clihelp -col showportisns
NOTES
None.
showportlesb
DESCRIPTION
The showportlesb command displays Fibre Channel Link Error Status Block (LESB) counters (the
number of errors accumulated for Fibre Channel devices). The LESB is composed of six counters that
can measure Fibre Channel signal integrity or status.
SYNTAX
showportlesb reset [node:slot:port]
showportlesb compare [all | node:slot:port]
showportlesb single|both [-portwwn <wwn>] node:slot:port
showportlesb hist [options] node:slot:port
514
showportlesb
showportlesb diffhist [options] node:slot:port
SUBCOMMANDS
reset
Specifies that internal counters are checked against current LESB counters and event alerts and are
raised as necessary. All ports for the internal counters are reset.
compare
Specifies that internal HPE 3PAR counters are checked against current LESB counters.
single|both
The single subcommand specifies that counters for the indicated port are displayed. The both
subcommand specifies that counters for both ports, if the device is dual ported, are displayed. If the port
WWN of an attached device is specified using the -portwwn option, only counters for that device are
displayed.
hist
Displays the history of LESB raw counters on the specified port of loop devices.
diffhist
Displays differences between historical samples of LESB counters on the specified port of loop devices.
AUTHORITY
•
Any role in the system
OPTIONS
-startt <time>
Specifies that samples taken of LESB counters should commence after the indicated time (<time>). Time
can be specified in hours or as a specific date. When specifying the time in hours, the following formats
can be used:
•
•
hh[:mm[:ss]], where hh is the hour, mm is the minute (optional), and ss is the second (optional).
hhmm, where hh is interpreted as 24 hour clock.
When specifying the time as a date, the following formats can be used:
•
•
•
•
mm/dd[/yy], where mm is the month, dd is the day, and yy is the year (optional).
monthname dd[,yy], where dd is the day and yy is the year (optional).
dd monthname [yy], where dd is the day and yy is the year (optional).
yy-mm-dd, where yy is the year, mm is the month, and dd is the day.
-endt <time>
Specifies that samples taken of LESB counters cease after the indicated time (<time>).
<time> can be specified in hours or as a specific date.
When specifying in hours, the following can be used:
•
•
hh[:mm[:ss]], where hh is the hour, mm is the minute (optional), and ss is the second (optional).
hhmm, where hh is interpreted as a 24 hour clock.
When specifying the time as a date, the following formats can be used:
•
•
•
•
•
mm/dd[/yy], where mm is the month, dd is the day, and yy is the year
(optional).
monthname dd[,yy], where dd is the day and yy is the year (optional).
dd monthname [yy], where dd is the day and yy is the year (optional).
yy-mm-dd, where yy is the year, mm is the month, and dd is the day.
Show Commands
515
-portwwn <wwn>
Specifies the port WWN of an attached device from which LESB counters should be retrieved.
SPECIFIERS
[<node:slot:port>]
Specifies the port for which information about devices on that port are displayed.
node Specifies the node.
slot Specifies the PCI bus slot in the specified node.
port Specifies the Fibre Channel port number of the PCI card in the specified PCI bus slot.
This specifier is required for the single, both, hist, and diffhist subcommands, and optional for the
compare subcommand. If this specifier is not used with the compare subcommand, then all ports are
compared.
<wwn>
Specifies the port WWN of an attached device. This specifier may be used with the single and both
subcommands.
EXAMPLES
The following example displays the comparison of all ports:
cli% showportlesb compare
Port <1:0:1>
Loop <1:0:1> Time since last save: 0:00:28
ID ALPA LinkFail LossSync LossSig PrimSeq InvWord InvCRC
<1:0:1> 0xef
1
19
19
0
0
0
pd7
0x6d
1
5
0
0
270
0
pd6
0x72
1
4
0
0
524
0
pd5
0x73
1
4
0
0
335
0
pd4
0x76
1
4
0
0
334
0
pd3
0x79
1
4
0
0
401
0
pd2
0x80
1
4
0
0
344
0
pd1
0x81
1
4
0
0
270
0
pd0
0x88
1
4
0
0
401
0
Port <0:0:1>
Loop <0:0:1> Time since last save: 0:00:28
ID ALPA LinkFail LossSync LossSig PrimSeq InvWord InvCRC
<0:0:1> 0xef
1
19
19
0
0
0
pd7
0x6d
1
5
0
0
465
0
pd6
0x72
1
5
0
0
890
0
pd5
0x73
1
4
0
0
969
0
pd4
0x76
1
5
0
0
761
0
pd3
0x79
1
4
0
0
815
0
pd2
0x80
1
4
0
0
925
0
pd1
0x81
1
7
0
0
3283
0
pd0
0x88
1
258
0
0
269
0
LESB compare completed
The following example displays the counters for port 1:0:2:
516
Show Commands
cli% showportlesb single 1:0:2
ID ALPA LinkFail LossSync LossSig PrimSeq InvWord InvCRC
cage1
0x1
3
4
0
0
755
0
pd12
0xef
1245
39201
0
0 156804
0
pd13
0xe8
1
1608
0
0
6432
0
pd14
0xe4
1
1586
0
0
6344
0
pd15
0xe2
1
1588
0
0
6352
0
pd16
0xe1
2
5088
0
0
20352
0
pd17
0xe0
1
1596
0
0
6384
0
pd18
0xdc
1
1595
0
0
6380
0
pd19
0xda
1
1596
0
0
6384
0
pd20
0xd9
2
5047
0
0
20188
0
pd21
0xd6
1
1604
0
0
6416
0
pd22
0xd5
1
1609
0
0
6436
0
pd23
0xd4
1
1616
0
0
6464
0
<1:0:2>
0xd3
0
1
1
0
0
0
cage0
0x18
1
165
0
0
26
0
pd8
0x67
2
865794
0
0 3463176
0
pd9
0x66
1
63932
0
0 255728
0
pd10
0x65
1
61572
0
0 246288
0
pd11
0x63
1
61525
0
0 246100
0
pd4
0x6c
2
67006
0
0 268024
0
pd5
0x6b
1
63474
0
0 253896
0
pd6
0x6a
1
63471
0
0 253884
0
pd7
0x69
1
63598
0
0 254392
0
pd0
0x72
2
65863
0
0 263452
0
pd1
0x71
1
64024
0
0 256096
0
pd2
0x6e
1
63942
0
0 255768
0
pd3
0x6d
1
63897
0
0 255588
0
The following example displays the reset of internal counters and ports:
cli% showportlesb reset
LESB reset completed
Use the following to get a description of each column in the above examples:
clihelp -col showportlesb
NOTES
If the both subcommand is specified, the resulting output text is greater than 80 columns wide.
Internal counters are checked every 10 minutes.
Each LESB counter is a 32-bit, unsigned integer.
LESB counters on Fibre Channel devices cannot be reset.
Show Commands
517
showportpel
DESCRIPTION
The showportpel command displays SAS Phy Error Log (PEL) counters (the number of errors
accumulated for SAS devices). The PEL is composed of four counters that can measure SAS signal
integrity or status.
SYNTAX
showportpel reset
showportpel compare [all | node:slot:port]
showportpel single|both [-sasaddr <sasaddr>] node:slot:port
showportpel hist [options] node:slot:port
showportpel diffhist [options] node:slot:port
SUBCOMMANDS
reset
Specifies that internal counters are checked against current PEL counters and event alerts are raised as
necessary. All ports of the internal counters are reset.
compare
Specifies that internal counters are checked against current PEL counters.
single|both
The single subcommand specifies that counters for the indicated port are displayed. The both
subcommand specifies that counters for both ports, if the device is dual ported, are displayed. If the SAS
address of an attached device is specified using the -sasaddr option, only counters for that device are
displayed.
hist
Displays the history of PEL raw counters on the specified port of loop devices.
diffhist
Displays differences between historical samples of PEL counters on the specified port of loop devices.
AUTHORITY
•
Any role in the system
OPTIONS
-startt <time>
Specifies that samples taken of PEL counters should commence after the indicated time (<time>).
-endt <time>
Specifies that samples taken of PEL counters cease after the indicated time (<time>).
<time> can be specified in hours or as a specific date.
When specifying in hours, the following can be used:
•
•
hh[:mm[:ss]], where hh is the hour, mm is the minute (optional), and ss is the second (optional).
hhmm, where hh is interpreted as a 24 hour clock.
When specifying the time as a date, the following formats can be used:
•
•
518
mm/dd[/yy], where mm is the month, dd is the day, and yy is the year (optional).
monthname dd[,yy], where dd is the day and yy is the year (optional).
showportpel
•
•
dd monthname [yy], where dd is the day and yy is the year (optional).
yy-mm-dd, where yy is the year, mm is the month, and dd is the day.
-sasaddr <sasaddr>
Specifies the SAS address of an attached device from which PEL counters should be retrieved.
SPECIFIERS
[<node:slot:port>]
Specifies the port for which information about devices on that port are displayed.
node Specifies the node.
slot Specifies the PCI bus slot in the specified node.
port Specifies the SAS port number of the PCI card in the specified PCI bus slot.
This specifier is required for the single, both, hist, and diffhist subcommands, and optional for the
compare subcommand. If this specifier is not used with the compare subcommand, then all ports are
compared.
<sasaddr>
Specifies the SAS address of an attached device. This specifier may be used with the single and both
subcommands.
EXAMPLES
The following example displays the comparison of all ports:
cli% showportpel compare
The following example displays the counters for port 1:0:2:
cli% showportpel single 1:0:2
Use the following to get a description of each column in the above examples:
clihelp -col showportpel
NOTES
If the both subcommand is specified, the resulting output text is greater than 80 columns wide.
Internal counters are checked every 10 minutes.
Each PEL counter is a 32-bit, unsigned integer.
PEL counters on SAS devices cannot be reset.
showqos
DESCRIPTION
The showqos command lists the QoS rules configured in a system.
showqos
519
SYNTAX
showqos [options] [{{vvset|domain}:{<name>|<pattern>}|sys:all_others}]...
AUTHORITY
•
Any role in the system
OPTIONS
-domain {<domainname|pattern>}...
Shows statistics for rules with target objects in domains with names that match one or more of the
specified domains or patterns. If -domain is not specified, statistics for all rules with target objects in the
current domain are shown. See the currentdomain parameter in the setclienv on page 312 and
showclienv on page 431 commands.
{-on|-off}
List QoS rules that are "on" or "off" only.
-vv {<VV_name>|<pattern>}[,{<VV_name>|<pattern>}]...
Applies only to QoS rules whose targets include virtual volumes with names matching any of the names
or patterns specified.
-sortcol <col>[,<dir>][:<col>[,<dir>]...]
Sorts command output based on column number (<col>). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, the direction of sorting (<dir>) can be
specified as follows:
•
•
inc—Sort in increasing order (default).
dec—Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows with the same information in them
as earlier columns will be sorted by values in later columns.
SPECIFIERS
{{vvset|domain}:{<name>|<pattern>}|sys:all_others}
The QoS rules to list. If none is specified, it lists all configured QoS rules. <name> and <pattern> refer to
the target object name of the rule, as listed in show{vvset|domain} commands.
EXAMPLES
To show all QoS rules defined in the system:
cli% showqos
-I/O_per_second- -KBytes_per_secId Type Name QoS Priority
Min
Max
Min
Max LatencyGoal
42 vvset vsa off normal
300
43 vvset vsb on normal
- 4000
- 204800
44 vvset vsc on normal
- 102400
45 vvset vsd on normal
- 5000
- 256000
-------------------------------------------------------------------------4 total
Only show QoS rules that are "on":
520
Show Commands
cli% showqos -on
-I/O_per_second- -KBytes_per_secId Type Name QoS Priority
Min
Max
Min
Max LatencyGoal
43 vvset vsb on normal
- 4000
- 204800
44 vvset vsc on normal
- 102400
45 vvset vsd on normal
- 5000
- 256000
-------------------------------------------------------------------------3 total
Show QoS rules containing VV vv1:
cli% showqos -vv vv1
-I/O_per_second- -KBytes_per_secId Type Name QoS Priority
Min
Max
Min
Max LatencyGoal
43 vvset vsb on normal
- 4000
- 204800
45 vvset vsd on normal
- 5000
- 256000
-------------------------------------------------------------------------2 total
Use the following to get a description of each column in the above examples:
clihelp -col showqos
NOTES
For all the <pattern> fields, the patterns are glob-style (shell-style) patterns. (For more information, issue
"clihelp sub,globpat" or see Glob-Style Patterns on page 15.)
A Domain column may be included by using the setclienv on page 312 command to set listdom to 1. The
listdom option is also set to 1 if the CLI was started with the -listdom option, or if the CLI was started with
the TPDLISTDOM environment variable set. Run "cli -h" and "setclienv -h" for details of the
environment variables.
showrcopy
DESCRIPTION
The showrcopy command displays details of the Remote Copy configuration.
SYNTAX
showrcopy [options <arg>] [links]
showrcopy [options <arg>] [groups [<name_or_pattern> ...]]
showrcopy [options <arg>] [targets [<name_or_pattern> ...]]
AUTHORITY
•
Any role in the system
OPTIONS
-d
Displays more detailed configuration information.
showrcopy
521
-qw
Display additional target specific Peer Persistence related configuration where applicable.
-domain <domainname_or_pattern>[,<domainname_or_pattern>...]
Shows only Remote Copy groups whose virtual volumes are in domains with names matching one or
more of the specified domain name or pattern. This option does not allow listing objects within a domain
of which the user is not a member.
SPECIFIERS
links
Specifies all Remote Copy links.
groups [<name_or_pattern>]
Specifies either all Remote Copy volume groups or specific Remote Copy volume group(s) by name or
glob-style patterns.
targets [<name_or_pattern>]
Specifies either all target definitions or specific target(s) definition by name or glob-style patterns.
EXAMPLES
The following example displays output from the showrcopy command:
cli% showrcopy
The following example displays output from the showrcopy groups <pat> command, where <pat> is
specified as b* and 1*:
cli% showrcopy groups b* l*
Use the following to get a description of each column in the above examples:
clihelp -col showrcopy
NOTES
This command requires the HPE 3PAR Remote Copy license. Contact your local service provide