Hp 3Par F200 9 6Tb 16 600Gb 15K Hdd Field Starter Kit Command Reference Guide Line Interface

Hp-3Par-T400-Configuration-Base-Command-Reference-Guide-156365 hp-3par-t400-configuration-base-command-reference-guide-156365

Hp-3Par-Storeserv-7450-2-Node-Base-Command-Reference-Guide-156343 hp-3par-storeserv-7450-2-node-base-command-reference-guide-156343

Hp-3Par-Storeserv-7200-2-Node-Storage-Base-Command-Reference-Guide-156325 hp-3par-storeserv-7200-2-node-storage-base-command-reference-guide-156325

Hp-3Par-Storeserv-7200-16Gb-Virtualization-Base-System-San-Kit-Command-Reference-Guide-156323 hp-3par-storeserv-7200-16gb-virtualization-base-system-san-kit-command-reference-guide-156323

Hp-3Par-Storeserv-10400-16Gb-Control-32Gb-Data-Cache-Iec-Rack-Config-Base-Command-Reference-Guide-156293 hp-3par-storeserv-10400-16gb-control-32gb-data-cache-iec-rack-config-base-command-reference-guide-156293

2015-01-05

: Hp Hp-3Par-F200-9-6Tb-16-600Gb-15K-Hdd-Field-Starter-Kit-Command-Reference-Guide-156262 hp-3par-f200-9-6tb-16-600gb-15k-hdd-field-starter-kit-command-reference-guide-156262 hp pdf

Open the PDF directly: View PDF PDF.
Page Count: 676

DownloadHp Hp-3Par-F200-9-6Tb-16-600Gb-15K-Hdd-Field-Starter-Kit-Command-Reference-Guide- 3PAR Command Line Interface Reference Hp-3par-f200-9-6tb-16-600gb-15k-hdd-field-starter-kit-command-reference-guide
Open PDF In BrowserView PDF
HP 3PAR Command Line Interface Reference
HP 3PAR OS 3.1.2

Abstract
This reference describes the HP 3PAR Command Line Interface (CLI) commands that are used to administer and maintain the
HP 3PAR storage system.

HP Part Number: QL226-97016
Published: June 2013

© Copyright 2013 Hewlett-Packard Development Company, L.P.
Confidential computer software. Valid license from HP 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.
The information contained herein is subject to change without notice. The only warranties for HP 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. HP shall
not be liable for technical or editorial errors or omissions contained herein.
Acknowledgments
Microsoft® and Windows ® are U.S. registered trademarks of Microsoft Corporation.
Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.
All other trademarks and registered trademarks are owned by their respective owners.

Contents
1 CLI Command Syntax and Conventions.......................................................11
Syntax and Conventions..........................................................................................................11
Syntax Rules...........................................................................................................................11
Glob-Style Pattern...................................................................................................................12
Numbering Formats................................................................................................................13
Object Sets............................................................................................................................13
Regular Expressions Patterns.....................................................................................................13
Provisioning...........................................................................................................................14
VV Name Patterns..................................................................................................................15
Filename Conventions for Windows®........................................................................................16
Typical Command Layout in this Book........................................................................................16
Global Options and Environment Variables................................................................................17
Exit Status..............................................................................................................................17

2 Commands Quick Reference......................................................................18
Adaptive Optimization (AO) Commands....................................................................................18
Control Commands.................................................................................................................18
Disk Enclosure Management Commands...................................................................................19
Drive Cage Management....................................................................................................19
Physical Disk Management..................................................................................................19
Domain Management Commands............................................................................................19
Health and Alert Management Commands................................................................................20
Alerts...............................................................................................................................20
Alert Severity Levels.......................................................................................................20
Events..............................................................................................................................21
System Health...................................................................................................................21
Help and Utility Commands.....................................................................................................21
Task Management Commands.................................................................................................21
LDAP Management Commands................................................................................................22
Licensing Management Commands...........................................................................................22
Node Subsystem Management Commands................................................................................22
Firmware Versions..............................................................................................................22
Node Date Information.......................................................................................................23
Controller Node Properties..................................................................................................23
Controller Node EEPROM Log.............................................................................................23
Array and Controller Node Information.................................................................................23
Network Interface Configuration..........................................................................................24
Port Information.................................................................................................................24
Battery Management..........................................................................................................25
System Manager................................................................................................................25
Node Rescue.....................................................................................................................25
Performance Management Commands......................................................................................25
Chunklet Statistics..............................................................................................................25
Data Cache Memory Statistics.............................................................................................26
Node CPU Statistics...........................................................................................................26
Logical Disk Statistics..........................................................................................................26
Link Statistics.....................................................................................................................26
Physical Disk Statistics........................................................................................................26
Port Statistics.....................................................................................................................26
System Tuner.....................................................................................................................27
Dynamic Optimization........................................................................................................27
Virtual LUN (Export) Statistics...............................................................................................27
Contents

3

Virtual Volume Statistics......................................................................................................27
Remote Copy Volume Statistics.............................................................................................28
Preserved Data Commands......................................................................................................28
Replication Commands............................................................................................................28
Physical Copy...................................................................................................................28
Remote Copy....................................................................................................................28
Virtual Copy......................................................................................................................30
Service Commands.................................................................................................................30
Disk Enclosure...................................................................................................................30
Node...............................................................................................................................31
General System Maintenance..............................................................................................31
QoS Commands................................................................................................................31
System Upgrade................................................................................................................32
SNMP Agent Commands.........................................................................................................32
System Reporter Commands.....................................................................................................33
CIM Server Commands...........................................................................................................34
Sparing Commands................................................................................................................34
SSH Access Commands...........................................................................................................35
Task Schedule Commands.......................................................................................................35
User Management Commands.................................................................................................36
Volume Management Commands.............................................................................................37
Common Provisioning Group Management...........................................................................37
Host Management.............................................................................................................37
Logical Disk Management...................................................................................................38
Space and Storage Management.........................................................................................38
Template Management.......................................................................................................39
Virtual Volume Management...............................................................................................39
Virtual LUN (Export) Management........................................................................................41
Web Services API (WSAPI) Commands......................................................................................41

3 Add Command........................................................................................42
addsnmpmgr.........................................................................................................................42

4 Admit Commands.....................................................................................44
admithw................................................................................................................................44
admitpd................................................................................................................................46
admitrcopylink.......................................................................................................................48
admitrcopytarget....................................................................................................................50
admitrcopyvv.........................................................................................................................51
admitvv.................................................................................................................................54

5 Cancel Command....................................................................................55
canceltask.............................................................................................................................55

6 Change Command...................................................................................56
changedomain.......................................................................................................................56

7 Check Commands....................................................................................57
checkhealth...........................................................................................................................57
checkld.................................................................................................................................59
checkpassword.......................................................................................................................61
checkpd................................................................................................................................63
checkport..............................................................................................................................65
checkrclink ............................................................................................................................67
checksnmp.............................................................................................................................70
checkvv.................................................................................................................................71

4

Contents

8 CLI Command..........................................................................................72
cli.........................................................................................................................................72

9 Compact Commands................................................................................75
compactcpg...........................................................................................................................75
compactld.............................................................................................................................77

10 Control Commands.................................................................................79
controlencryption....................................................................................................................79
controliscsiport.......................................................................................................................81
controlmag............................................................................................................................83
controlpd...............................................................................................................................85
controlport.............................................................................................................................87

11 Create Commands..................................................................................95
createald...............................................................................................................................95
createaldvv............................................................................................................................99
createaocfg.........................................................................................................................105
createavv............................................................................................................................107
createcpg............................................................................................................................110
createdomain.......................................................................................................................115
createdomainset...................................................................................................................116
creategroupsv......................................................................................................................117
creategroupvvcopy...............................................................................................................119
createhost............................................................................................................................121
createhostset........................................................................................................................123
createld...............................................................................................................................125
creatercopygroup.................................................................................................................127
creatercopytarget..................................................................................................................129
createsched.........................................................................................................................131
createsnmpuser....................................................................................................................134
createspare..........................................................................................................................135
createsv...............................................................................................................................137
createtemplate.....................................................................................................................139
createtpvv............................................................................................................................145
createuser............................................................................................................................149
createvlun............................................................................................................................151
createvv..............................................................................................................................154
createvvcopy........................................................................................................................158
createvvset...........................................................................................................................162

12 Dismiss Commands...............................................................................164
dismisspd............................................................................................................................164
dismissrcopylink...................................................................................................................165
dismissrcopytarget................................................................................................................167
dismissrcopyvv.....................................................................................................................168

13 Free Command.....................................................................................170
freespace............................................................................................................................170

14 Grow Commands.................................................................................171
growaldvv...........................................................................................................................171
growavv..............................................................................................................................176
growtpvv.............................................................................................................................178
growvv................................................................................................................................179

15 Hist Commands....................................................................................180
histch..................................................................................................................................180
Contents

5

histld...................................................................................................................................183
histpd.................................................................................................................................186
histport................................................................................................................................191
histrcvv................................................................................................................................194
histvlun...............................................................................................................................197
histvv..................................................................................................................................201

16 Import Command..................................................................................204
importvv..............................................................................................................................204

17 Locate Commands................................................................................206
locatecage..........................................................................................................................206
locatenode..........................................................................................................................208
locatesys.............................................................................................................................209

18 Move Commands.................................................................................210
movech...............................................................................................................................210
movechtospare.....................................................................................................................213
movepd...............................................................................................................................215
movepdtospare....................................................................................................................217
moverelocpd........................................................................................................................219
movetodomain.....................................................................................................................223

19 Promote Commands..............................................................................225
promotesv............................................................................................................................225
promotevvcopy.....................................................................................................................227

20 Remove Commands..............................................................................228
removealert..........................................................................................................................228
removeaocfg........................................................................................................................230
removecpg..........................................................................................................................231
removedomain.....................................................................................................................233
removedomainset.................................................................................................................234
removehost..........................................................................................................................235
removehostset.......................................................................................................................237
removeld.............................................................................................................................238
removercopygroup................................................................................................................240
removercopytarget................................................................................................................242
removesched........................................................................................................................243
removesnmpmgr...................................................................................................................244
removesnmppw....................................................................................................................246
removesnmpuser...................................................................................................................247
removespare........................................................................................................................248
removesshkey.......................................................................................................................250
removetask..........................................................................................................................251
removetemplate....................................................................................................................253
removeuser..........................................................................................................................254
removeuserconn...................................................................................................................255
removevlun..........................................................................................................................256
removevv.............................................................................................................................258
removevvset.........................................................................................................................260

21 Service Commands...............................................................................261
servicecage.........................................................................................................................261
servicehost...........................................................................................................................263
servicemag..........................................................................................................................265
servicenode.........................................................................................................................269

6

Contents

22 Set Commands.....................................................................................271
setalert................................................................................................................................271
setaocfg..............................................................................................................................272
setauthparam.......................................................................................................................274
setbattery............................................................................................................................278
setcage...............................................................................................................................280
setcim.................................................................................................................................282
setclienv..............................................................................................................................284
setcpg.................................................................................................................................286
setdate................................................................................................................................291
setdomain...........................................................................................................................293
setdomainset........................................................................................................................295
sethost.................................................................................................................................296
sethostset.............................................................................................................................299
setlicense.............................................................................................................................300
setnet..................................................................................................................................302
setnode...............................................................................................................................306
setntp..................................................................................................................................308
setpassword.........................................................................................................................309
setpd..................................................................................................................................311
setqos.................................................................................................................................312
setrcopygroup......................................................................................................................314
setrcopytarget......................................................................................................................319
setsched..............................................................................................................................322
setsnmpmgr.........................................................................................................................324
setsnmppw..........................................................................................................................326
setsnmpuser.........................................................................................................................328
setsshkey.............................................................................................................................329
setstatch..............................................................................................................................331
setstatpdch..........................................................................................................................332
setsys..................................................................................................................................333
setsysmgr.............................................................................................................................336
settask.................................................................................................................................338
settemplate..........................................................................................................................339
setuser................................................................................................................................341
setuseracl............................................................................................................................342
setvv...................................................................................................................................344
setvvset...............................................................................................................................348
setwsapi..............................................................................................................................349

23 Show Commands.................................................................................350
showalert............................................................................................................................350
showaocfg...........................................................................................................................352
showauthparam....................................................................................................................353
showbattery.........................................................................................................................354
showblock...........................................................................................................................358
showcage............................................................................................................................361
showcim..............................................................................................................................365
showclienv...........................................................................................................................367
showcpg.............................................................................................................................368
showdate............................................................................................................................373
showdomain........................................................................................................................374
showdomainset....................................................................................................................376
showeeprom........................................................................................................................378
showeventlog.......................................................................................................................381
Contents

7

showfirmwaredb...................................................................................................................384
showhost.............................................................................................................................386
showhostset.........................................................................................................................389
showinventory......................................................................................................................391
showiscsisession...................................................................................................................392
showld................................................................................................................................394
showldch.............................................................................................................................400
showldmap..........................................................................................................................404
showlicense.........................................................................................................................405
shownet..............................................................................................................................407
shownode............................................................................................................................409
shownodeenv.......................................................................................................................417
showpatch...........................................................................................................................419
showpd...............................................................................................................................420
showpdata..........................................................................................................................431
showpdch............................................................................................................................432
showpdvv............................................................................................................................437
showport.............................................................................................................................440
showportarp........................................................................................................................449
showportdev........................................................................................................................450
showportisns........................................................................................................................453
showportlesb.......................................................................................................................454
showqos..............................................................................................................................458
showrcopy...........................................................................................................................460
showrctransport....................................................................................................................464
showrole.............................................................................................................................467
showrsv...............................................................................................................................469
showsched...........................................................................................................................471
showsnmpmgr......................................................................................................................473
showsnmppw.......................................................................................................................474
showsnmpuser......................................................................................................................475
showspace..........................................................................................................................476
showspare...........................................................................................................................479
showsshkey..........................................................................................................................481
showsys...............................................................................................................................482
showsysmgr.........................................................................................................................486
showtarget...........................................................................................................................488
showtask.............................................................................................................................490
showtemplate.......................................................................................................................494
showtoc..............................................................................................................................495
showtocgen.........................................................................................................................496
showuser.............................................................................................................................497
showuseracl.........................................................................................................................499
showuserconn......................................................................................................................500
showversion.........................................................................................................................502
showvlun.............................................................................................................................503
showvv................................................................................................................................506
showvvcpg..........................................................................................................................519
showvvmap.........................................................................................................................521
showvvpd............................................................................................................................523
showvvset............................................................................................................................527
showwsapi..........................................................................................................................529

24 Shutdown Commands...........................................................................530
shutdownnode......................................................................................................................530
8

Contents

shutdownsys.........................................................................................................................533

25 System Reporter (SR) commands ............................................................535
sraomoves...........................................................................................................................535
srcpgspace..........................................................................................................................537
srhistld................................................................................................................................539
srhistpd...............................................................................................................................542
srhistport.............................................................................................................................545
srhistvlun.............................................................................................................................548
srldspace.............................................................................................................................551
srpdspace...........................................................................................................................554
srrgiodensity........................................................................................................................556
srstatcmp.............................................................................................................................558
srstatcpu..............................................................................................................................560
srstatld................................................................................................................................562
srstalink...............................................................................................................................564
srstatpd...............................................................................................................................566
srstatport.............................................................................................................................568
srstatqos..............................................................................................................................570
srstatvlun.............................................................................................................................572
srvvspace............................................................................................................................574

26 Start Commands...................................................................................577
startao................................................................................................................................577
startcim...............................................................................................................................579
startld.................................................................................................................................580
startnoderescue....................................................................................................................581
startrcopy............................................................................................................................582
startrcopygroup....................................................................................................................583
starttask..............................................................................................................................585
startvv.................................................................................................................................586
startwsapi............................................................................................................................587

27 Stat Commands....................................................................................588
statch..................................................................................................................................588
statcmp...............................................................................................................................592
statcpu................................................................................................................................594
statfcoe ..............................................................................................................................596
statiscsi...............................................................................................................................598
statiscsisession......................................................................................................................600
statld..................................................................................................................................602
statlink................................................................................................................................606
statpd.................................................................................................................................607
statport...............................................................................................................................612
statqos................................................................................................................................616
statrcopy.............................................................................................................................619
statrcvv................................................................................................................................621
statvlun...............................................................................................................................625
statvv..................................................................................................................................629

28 Stop Commands...................................................................................633
stopcim...............................................................................................................................633
stoprcopy............................................................................................................................634
stoprcopygroup....................................................................................................................636
stopwsapi............................................................................................................................638

Contents

9

29 Sync Command....................................................................................639
syncrcopy............................................................................................................................640

30 Tune Commands..................................................................................642
tunealdvv............................................................................................................................642
tunepd................................................................................................................................647
tunesys................................................................................................................................651
tunetpvv..............................................................................................................................654
tunevv.................................................................................................................................656

31 Update Commands...............................................................................658
updatesnapspace.................................................................................................................658
updatevv.............................................................................................................................660

32 Upgrade Commands.............................................................................662
upgradecage.......................................................................................................................662
upgradepd..........................................................................................................................664

33 Wait Command...................................................................................665
waittask..............................................................................................................................665

34 Support and Other Resources.................................................................666
Contacting HP......................................................................................................................666
HP 3PAR documentation........................................................................................................666
Typographic conventions.......................................................................................................669
HP 3PAR branding information...............................................................................................669

35 Documentation feedback.......................................................................670
Index.......................................................................................................671

10

Contents

1 CLI Command Syntax and Conventions
This chapter describes the command syntax for the HP 3PAR OS CLI commands listed in this
reference. General control commands that do not follow the syntax rules are also listed as well
as glob-style patterns.

Syntax and Conventions
Most CLI commands use the following syntax.
[cmd [subcmd] [options [arg]]... [...] [...]
Table 1 (page 11) Lists all 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 in the table above obeys the following rules:
•

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]).

•

Options follow subcommands on the command line and precede any specifier.

Syntax and Conventions

11

•

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

•

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 HP 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 Pattern
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.

12

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.

CLI Command Syntax and Conventions

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
"*".

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 Ox or OX (For example: Ox100).

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 do: createvlun set:esxexports 1
set:esxhostswhich 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:
Numbering Formats

13

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 help text is only a summary.
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)
{

x

When followed by a character other than a digit, matches {,
otherwise it is a quantifier as described above.
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", "growvv", and
"tunevv" commands should be used to create, grow, and tune the volume.
14

CLI Command Syntax and Conventions

For a virtual volume with user space that is not provisioned from a CPG, "createaldvv", "growaldvv",
and "tunealdvv" commands should be used instead.
To determine whether or not the user space of the virtual volume is provisioned from a CPG, use
the "showvv -cpgalloc" command.
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

— createaldvv
- growaldvv

— createaldvvUser
Space

— createaldvvUser
Space

- tunealdvv

- growaldvv

- growaldvv

- tunealdvv

- tunealdvv

Base

Base

Base, cpvv

— creatvv

— creatvv

— creatvv

- growvv

- growvv

- growvv

- tunevv

- tunevv

- tunevv

N/A

N/A

Base, tpvv

User Space
Full Provisioned,
not from a CPG

Full Provisioned,
from a CPG

Thin Provision

— creatpvv, creatvv
- growpvv, growvv
- tunepvv, 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):
•

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

VV Name Patterns

15

•

@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).

•

@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 -pwf C:\password\system1 ...
If a filename is entered for a command using the CLI shell, a Tcl application, then each backslash
must be doubled:
cli% setpassword -saveonly -file C:\\password\\system1\\browse_user1
If using the Windows® shell prompt, use:
C:\Users\w_user> setpassword -saveonly -file
C:\password\system1\browse_user1

Typical Command Layout in this Book
Typical CLI reference pages are formatted similarly as the examples that follow:

COMMAND NAME
The section heading includes the name of the CLI command.

DESCRIPTION
This section describes the use or purpose of the command.

16

CLI Command Syntax and Conventions

AUTHORITY
This section defines the user access required within the HP 3PAR Storage System to use the
command.

SUBCOMMANDS
This section indicates any necessary subcommands required to complete the use of the command.

SYNTAX
See Section (page 11).

OPTIONS
This section lists the available 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
Specifies a suggested input required by the user.

RESTRICTIONS
This section includes any restrictions that must be followed in order to achieve maximum results.

EXAMPLES
This section lists sample output with results similar to what you should expect when running the
command and it’s available options.

NOTES
Any pertinent information about the command that might help increase understanding and reliability
is often provided in the Notes section.

Global Options and Environment Variables
Several options and environment variables are available at the global level. For complete information
about these, refer to the HP 3PAR OS CLI Administrator’s Manual.

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.

Note that 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. For example, if you
issue the addsnmpmgr command with an invalid IP address, the command output returns Invalid
IP address and an SNMP manager is not added; however, the exit status is 0 (successful)
because the command itself was successfully executed, even though the intended result of the
command (adding an SNMP manager) was not achieved.

Global Options and Environment Variables

17

2 Commands Quick Reference
The HP 3PAR Command Line Interface provides a host of commands allowing you to administer
your HP 3PAR storage system. To facilitate your navigation through this manual, this section provides
an overview of the commands grouped by functionality.

Adaptive Optimization (AO) Commands
Command

Description

Authority

For Details See

createaocfg

Creates an AO
configuration.

Super, Edit

“createaocfg” (page 105)

removeaocfg

Removes specified AO
configurations from the
system.

Super, Edit

“removeaocfg” (page 230)

setaocfg

Updates an AO
configuration.

Super, Edit

“setaocfg” (page 272)

showaocfg

Shows AO configurations in Any role in the system.
the system.

“showaocfg” (page 352)

Command

Description

Authority

For Details See

controlencryption

Controls data encryption.

Super

“controlencryption”
(page 79)

Control Commands

Any role granted to the
encryption_control
right
Super, Service (for status
subcommand only)
Any role granted to the
encryption_status right

18

Commands Quick Reference

Disk Enclosure Management Commands
Drive Cage Management
Command

Description

Authority

For Details See

locatecage

Locates a particular drive
cage.

Super, Service1

“locatecage” (page 206)

Sets parameters for a drive
cage.

Super, Service1

Displays drive cage
information.

Any role in the system.

setcage

showcage
1

Any role granted the
cage_locate right.
“setcage” (page 280)

Any role granted the
cage_set right.
“showcage” (page 361)

You need access to all domains in order to run this command.

Physical Disk Management
Command
admitpd

checkpd

controlpd

dismisspd

Description

Authority

For Details See
1

Admits one or all physical
disks to enable their use.

Super, Service

Executes surface scans on
physical disks.

Super, Service1

Spins physical disks up or
down.

Super, Service

Dismisses one or more
physical disks from use.

Super, Service1

“admitpd” (page 46)

Any role granted the
pd_admit right.
“checkpd” (page 63)

Any role granted the
pd_check right.
1

“controlpd” (page 85)

Any role granted the
pd_control right.
“dismisspd” (page 164)

Any role granted the
pd_dismiss right.

setpd

Marks physical disks as
Super, Service1
allocatable for logical disks.

“setpd” (page 311)

showpd

Displays physical disks in the Any role in the system.
system.

“showpd” (page 420)

1

You need access to all domains in order to run this command.

Domain Management Commands
Command

Description

Authority

For Details See

changedomain

Changes the currentdomain Any role in the system.
CLI environment parameter.

createdomain

Shows a list of domains on
the system.

Super1

“changedomain” (page 56)
“createdomain” (page 115)

Any role granted the
domain_create right.

Disk Enclosure Management Commands

19

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.

“createdomainset”
Super
(page 116)
Any role granted the
domainset_create right.

movetodomain

Moves objects from one
domain to another.

Super, Edit1

“movetodomain” (page 223)

Any role granted the
domain_moveto right.

removedomain

Removes an existing domain Super, Edit1
from the system.

“removedomain” (page 233)

removedomainset

Removes a domain set or
removes domains from an
existing set.

Super, Edit

“removedomainset”
(page 234)

Sets the parameters and
modifies the properties of a
domain.

Super1

setdomainset

Sets the parameters and
modifies the properties of a
domain set.

Super, Edit
Any role granted the
domainset_set right.

“setdomainset” (page 295)

showdomain

Displays the list of domains
on a system.

Any role in the system.

“showdomain” (page 374)

showdomainset

Displays the domain sets
defined on the HP 3PAR
Storage System and their
members.

Any role in the system.

“showdomainset” (page 376)

setdomain

1

Any role granted the
domainset_remove right.

“setdomain” (page 293)

Any role granted the
domain_set right.

You need access to all domains in order to run this command.

Health and Alert Management Commands
Alerts
Command

Description

Authority

removealert

Removes one or more alerts. Super, Service1

For Details See
“removealert” (page 228)

Any role granted the
alert_remove right.
setalert

showalert
1

Sets the status of system
alerts.

Super, Service1

Displays system alerts.

Any role in the system.

“setalert” (page 271)

Any role granted the
alert_set right.
“showalert” (page 350)

You need access to all domains in order to run this command.

Alert Severity Levels
Table 2 Alert Severity Levels

20

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.

Commands Quick Reference

Table 2 Alert Severity Levels (continued)
Severity

Description

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
Command

Description

Authority

For Details See

showeventlog

Displays event logs.

Any role in the system.

“showeventlog” (page 381)

Command

Description

Authority

For Details See

checkhealth

Displays the status of the
system hardware and
software components.

Super, Service
Any role granted the
health_check right.

“checkhealth” (page 57)

For Details See

System Health

Help and Utility Commands
Command

Description

Authority

cli

Provides a means to set up
your CLI session or to enter
directly into a CLI shell.

Super, Edit, Browse, Service “CLI Command” (page 72)

clihelp

Lists all commands or details Super, Edit, Browse, Service
for a specified command.

cmore

Pages the output of
commands.

help

Lists all commands or details Super, Edit, Browse, Service
for a specified command.

setclienv

Sets the CLI environment
parameters.

showclienv

Displays the CLI environment Any role in the system.
parameters.

Super, Edit, Browse, Service

Super, Service, Edit, Browse “setclienv” (page 284)
Any role granted the
clienv_set right.
“showclienv” (page 367)

Task Management Commands
Command

Description

Authority

For Details See

canceltask

Cancels one or more tasks.

Super, Edit
Any role granted the
task_cancel right.

“canceltask” (page 55)

removetask

Removes information about Super, Edit
one or more tasks and their Any role granted the
details.
task_remove right.

“removetask” (page 251)

Help and Utility Commands

21

Command

Description

Authority

For Details See

settask

Sets the priority on a
specified task.

Super, Edit
Any role granted the
task_set right.

“settask” (page 338)

showtask

Displays information about
tasks.

Any role in the system.

“showtask” (page 490)

starttask

Executes commands with
long running times.

Super, Service
Edit Any role granted the
task_start right.

“starttask” (page 585)

waittask

Asks the CLI to wait for a
task to complete before
proceeding.

Super, Service, Edit, Browse “waittask” (page 665)
Any role granted the
task_wait right.

LDAP Management Commands
Command

Description

Authority

For Details See

setauthparam

Sets the authentication
parameters.

Super
Any role granted the
authparam_set right.

“setauthparam” (page 274)

showauthparam

Shows authentication
parameters and integrates
the authentication and
authorization features using
LDAP.

Any role in the system.

“showauthparam” (page 353)

checkpassword

Supports authentication and Super, Edit, Browse, Service “checkpassword” (page 61)
authorization using LDAP.
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” (page 300)

Any role granted the
license_set right.
showlicense
1

Displays the installed license Any role in the system.
info or key.

“showlicense” (page 405)

You need access to all domains in order to run this command.

Node Subsystem Management Commands
Firmware Versions

22

Command

Description

showfirmwaredb

Displays a current database Any role in the system.
of firmware levels.

Commands Quick Reference

Authority

For Details See
“showfirmwaredb”
(page 384)

Node Date Information
Command

Description

Authority

For Details See

setdate

Sets the system time and
date on all nodes.

Super, Service1

“setdate” (page 291)

showdate
1

Displays the date and time
on all system nodes.

Any role granted the
date_set right.
Any role in the system.

“showdate” (page 373)

You need access to all domains in order to run this command.

Controller Node Properties
Command
setnode

Description
Sets the properties of the
node components such as
the serial number of the
power supply.

Authority

For Details See

Super, Service

1

“setnode” (page 306)

Any role granted the
node_set right.

shownode

Displays an overview of the
node specific properties.

Any role in the system.

“shownode” (page 409)

shownodeenv

Displays the node’s
environmental status.

Any role in the system.

“shownodeenv” (page 417)

1

You need access to all domains in order to run this command.

Controller Node EEPROM Log
Command

Description

Authority

For Details See

showeeprom

Displays node EEPROM
information.

Any role in the system.

“showeeprom” (page 378)

Authority

For Details See

Array and Controller Node Information
Command

Description

locatenode

Locates a particular node
Super, Service1
component by blinking LEDs
Any role granted the
on the node.
node_locate right.

“locatenode” (page 208)

locatesys

Locates a system by blinking Super, Service1
its LEDs.
Any role granted the
sys_locate right.

“locatesys” (page 209)

setsys

Super, Service1
Enables you to set
system-wide parameters such
Any role granted the
as the raw space alert.
sys_set right.

“setsys” (page 333)

showsys

Displays the HP 3PAR
Storage System properties,
including system name,
model, serial number, and
system capacity.

“showsys” (page 482)

Any role in the system.

Node Subsystem Management Commands

23

1

You need access to all domains in order to run this command.

Network Interface Configuration
Command
setnet

Description
Sets the administration
network interface
configuration.

Authority
Super, Service

For Details See
1

Any role granted the
net_set right.

setntp

Sets the NTP server to which Super, Service1
the HP 3PAR Storage System
Any role granted the
synchronizes.
ntp_set right.

shownet

Displays the network
configuration and status.

1

“setnet” (page 302)

Any role in the system.

“setntp” (page 308)

“shownet” (page 407)

You need access to all domains in order to run this command.

Port Information
Command

Authority

For Details See
1

checkport

Performs a loopback test on Super, Service
Fibre Channel ports.
Any role granted the
port_check right.

controlport

Controls Fibre Channel or
Remote Copy ports.

Super, Service1

“checkport” (page 65)

“controlport” (page 87)

Any role granted the
port_control right.
port_control

Used to set up the
parameters and
characteristics of an iSCSI
port.

Super, Edit1

showiscsisession

Shows the iSCSI active
sessions per port.

Any role in the system.

“showiscsisession”
(page 392)

showport

Displays system port
information.

Any role in the system.

“showport” (page 440)

showportarp

Shows the ARP table for
iSCSI ports in the system.

Any role in the system.

“showportarp” (page 449)

showportdev

Displays detailed
information about devices
on a Fibre Channel port.

Any role in the system.

“showportdev” (page 450)

showportisns

Show iSNS host information Any role in the system.
for iSCSI ports in the system.

“showportisns” (page 453)

showportlesb

Displays Link Error Status
Block information about
devices on a Fibre Channel
port.

Any role in the system.

“showportlesb” (page 454)

showtarget

Displays unrecognized
targets.

Any role in the system.

“showtarget” (page 488)

statfcoe

Shows Fibre Channel over
Ethernet information.

Any role in the system.

“statfcoe ” (page 596)

controliscsiport

24

Description

Commands Quick Reference

“controliscsiport” (page 81)

Any role granted the
port_control right.

Command

Description

Authority

For Details See

statiscsi

Displays the iSCSI statistics.

Any role in the system.

“statiscsi” (page 598)

statiscsisession

Displays the iSCSI session
statistics.

Any role in the system.

“statiscsisession” (page 600)

1

You need access to all domains in order to run this command.

Battery Management
Command

Description

Authority

For Details See

setbattery

Sets battery properties.

Super, Service1

“setbattery” (page 278)

Any role granted the
battery_set right.
showbattery
1

Displays battery status
information.

Any role in the system.

“showbattery” (page 354)

You need access to all domains in order to run this command.

System Manager
Command

Description

Authority

For Details See

setsysmgr

Sets the system manager
startup state.

Super1

“setsysmgr” (page 336)

Any role granted the
sysmgr_set right.

showsysmgr

Displays the system manager Any role in the system.
startup state.

“showsysmgr” (page 486)

showtoc

Displays the system table of
contents summary.

“showtoc” (page 495)

showtocgen

Displays the system table of Any role in the system.
contents generation number.

1

Any role in the system.

“showtocgen” (page 496)

You need access to all domains in order to run this command.

Node Rescue
Command

Description

Authority

For Details See

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.

“startnoderescue” (page 581)

Performance Management Commands
Chunklet Statistics
Command

Description

Authority

For Details See

histch

Displays histogram data for Any role in the system.
individual chunklets.

“histch” (page 180)

setstatch

Sets statistics collection
mode on chunklets.

“setstatch” (page 331)

Super, Edit
Any role granted the
statch_set right.

Performance Management Commands

25

Command

Description

Authority

For Details See

setstatpdch

Sets statistics collection
mode on physical disk
chunklets.

Super, Edit
Any role granted the
statpdch_set right.

“setstatpdch” (page 332)

statch

Displays statistics for
individual chunklets.

Any role in the system.

“statch” (page 588)

Data Cache Memory Statistics
Command

Description

Authority

For Details See

statcmp

Displays statistics for cache
memory pages.

Any role in the system.

“statcmp” (page 592)

Command

Description

Authority

For Details See

statcpu

Displays statistics for CPU
use.

Any role in the system.

“statcpu” (page 594)

Command

Description

Authority

For Details See

histld

Displays histogram data for Any role in the system.
logical disks.

“histld” (page 183)

statld

Displays statistics for logical Any role in the system.
disks.

“statld” (page 602)

Command

Description

Authority

For Details See

statlink

Displays statistics for links.

Any role in the system.

“statlink” (page 606)

Command

Description

Authority

For Details See

histpd

Displays histogram data for Any role in the system.
physical disks.

“histpd” (page 186)

statpd

Displays statistics for
physical disks.

Any role in the system.

“statpd” (page 607)

Command

Description

Authority

For Details See

histport

Displays histogram data for Any role in the system.
Fibre Channel ports.

“histport” (page 191)

statport

Displays statistics for Fibre
Channel ports.

“statport” (page 612)

Node CPU Statistics

Logical Disk Statistics

Link Statistics

Physical Disk Statistics

Port Statistics

26

Commands Quick Reference

Any role in the system.

System Tuner
Command

Description

Authority

For Details See

tunepd

Displays physical disks with Super, Edit
high service times and
Any role granted the
optionally performs load
pd_tune right.
balancing.

“tunepd” (page 647)

tunesys

Analyzes disk usage and
adjusts resources.

Super, Edit
Any role granted the
sys_tune right.

“tunesys” (page 651)

Description

Authority

For Details See

Dynamic Optimization
Command

1

tunealdvv

Super, Edit
Allows the RAID and
Availability characteristics
Any role granted the
of an existing Thin
vv_tune right.
Provisioned Virtual Volume
to be dynamically modified.
See the HP 3PAR Command
Line Interface Administrator’s
Manual for a complete
discussion of HP 3PAR
System Tuner Software and
the use of the tunealdvv
command.

“tunealdvv” (page 642)

tunetpvv

Changes the layout of a
Thinly Provisioned Virtual
Volume (TPVV).

Super, Edit

“tunetpvv” (page 654)

Changes the layout of a
virtual volume.

Super, Edit

tunevv

1

Any role granted the
vv_tune right.
“tunevv” (page 656)

Any role granted the
vv_tune right.

You need access to all domains in order to run this command.

Virtual LUN (Export) Statistics
Command

Description

Authority

For Details See

histvlun

Displays histogram data for Any role in the system.
VLUNs.

“histvlun” (page 197)

statvlun

Displays statistics for VLUNs. Any role in the system.

“statvlun” (page 625)

Command

Description

For Details See

histvv

Displays histogram data for Any role in the system.
virtual volumes.

“histvv” (page 201)

statvv

Displays statistics for virtual
volumes.

“statvv” (page 629)

Virtual Volume Statistics
Authority

Any role in the system.

Performance Management Commands

27

Remote Copy Volume Statistics
Command

Description

Authority

For Details See

histrcvv

Displays histogram data for Any role in the system.
Remote Copy volumes.

“histrcvv” (page 194)

statrcvv

Displays statistics for Remote Any role in the system.
Copy volumes.

“statrcvv” (page 621)

Preserved Data Commands
Command

Description

Authority

For Details See

showpdata

Displays preserved data
status.

Any role in the system.

“showpdata” (page 431)

Command

Description

Authority

For Details See

creategroupvvcopy

Creates consistent group
physical copies of a list of
virtual volumes.

Super, Edit
Any role granted the
groupvvcopy_create
right.

“creategroupvvcopy”
(page 119)

createvvcopy

Copies a virtual volume.

Super, Edit
Any role granted the
vvcopy_create right.

“createvvcopy” (page 158)

promotevvcopy

Promotes a physical copy
back to a base volume.

Super, Edit
Any role granted the
vvcopy_promote right.

“promotevvcopy” (page 227)

Replication Commands
Physical Copy

Remote Copy
NOTE: Functionality of HP 3PAR Remote Copy requires an HP 3PAR Remote Copy license. See
the HP 3PAR StoreServ Storage Concepts Guide for additional information.
Command

Description

Authority

For Details See

admitrcopylink

Admits a network link for
Remote Copy use.

Super, Edit

“admitrcopylink” (page 48)

admitrcopytarget

28

Adds a target to a Remote
Copy volume group

Any role granted the
rcopylink_admit right.
Super, Edit
Any role granted the
rcopytarget_admit
right.

“admitrcopytarget”
(page 50)

admitrcopyvv

Admits a virtual volume to a Super, Edit
Remote Copy volume group. Any role granted the
rcopyvv_admit right.

“admitrcopyvv” (page 51)

checkrclink

Super, Edit
Performs a latency and
throughput test between two Any role granted the
connected HP 3PAR Storage rclink_check right.
Systems.

“checkrclink ” (page 67)

Commands Quick Reference

Command

Description

Authority

creatercopygroup

Creates a group for Remote Super, Edit
Copy.
Any role granted the
rcopygroup_create
right.

creatercopytarget

Creates a target for Remote
Copy.

Super, Edit1

dismissrcopylink

Dismisses a network link
from Remote Copy use.

Super, Edit1 Any role
granted the
rcopylink_dismiss
right.

“dismissrcopylink” (page 165)

dismissrcopytarget

Dismisses a Remote Copy
target from a Remote Copy
volume group.

Super, Edit

“dismissrcopytarget”
(page 167)

Any role granted the
rcopytarget_create
right.

Any role granted the
rcopytarget_dismiss
right.

For Details See
“creatercopygroup”
(page 127)

“creatercopytarget”
(page 129)

dismissrcopyvv

Dismisses a virtual volume
Super, Edit
from a Remote Copy volume Any role granted the
group.
rcopyvv_dismiss right.

removercopygroup

Removes a group used for
Remote Copy.

Super, Edit Any role granted “removercopygroup”
the rcopygroup_remove (page 240)
right.

removercopytarget

Removes a target used for
Remote Copy.

Super, Edit1

Sets the volume group’s
policy for dealing with I/O
failure and error handling,
or switches the direction of
a volume group.

Super, Edit

setrcopygroup

Any role granted the
rcopytarget_remove
right.

“dismissrcopyvv” (page 168)

“removercopytarget”
(page 242)

“setrcopygroup” (page 314)

Any role granted the
rcopygroup_set right.

setrcopytarget

Sets the Remote Copy target Super, Edit1
state.
Any role granted the
rcopytarget_set right.

“setrcopytarget” (page 319)

showrcopy

Displays the details of a
Any role in the system.
Remote Copy configuration.

“showrcopy” (page 460)

showrctransport

Shows status and
Any role in the system.
information about end-to-end
transport for Remote Copy
in the system.

“showrctransport” (page 464)

startrcopy

Starts a Remote Copy
subsystem.

Super, Edit1

Starts a Remote Copy
volume group.

Super, Edit

Displays Remote Copy
statistics.

Any role in the system.

startrcopygroup

statrcopy

“startrcopy” (page 582)

Any role granted the
rcopy_start right.
“startrcopygroup” (page 583)

Any role granted the
rcopygroup_start right.
“statrcopy” (page 619)

Replication Commands

29

Command

Description

Authority

For Details See

stoprcopy

Stops a Remote Copy
subsystem.

Super, Edit1

“stoprcopy” (page 634)

Stops a Remote Copy
volume group.

Super, Edit

Synchronizes Remote Copy
volume groups.

Super, Edit

stoprcopygroup

syncrcopy

1

Any role granted the
rcopy_stop right.
“stoprcopygroup” (page 636)

Any role granted the
rcopygroup_stop right.
“syncrcopy” (page 640)

Any role granted the
rcopy_sync right.

You need access to all domains in order to run this command.

Virtual Copy
Command

Description

Authority

For Details See

createsv

Creates snapshot volumes.

Super, Edit

“createsv” (page 137)

Any role granted the
sv_create right.
creategroupsv

Creates consistent group
snapshots of a list of virtual
volumes.

Super, Edit

“creategroupsv” (page 117)

Any role granted the
groupsv_create right.

promotesv

Copies the differences of a Super, Edit
virtual copy back to its base Any role granted the
volume.
sv_promote right.

“promotesv” (page 225)

updatevv

Updates a snapshot virtual Super, Edit
volume with a new snapshot. Any role granted the
vv_update right.

“updatevv” (page 660)

Command

Description

Authority

For Details See

admithw

Admits new hardware into
the system.

Super, Service1

“admithw” (page 44)

controlmag

Takes drives or magazines
on or off loop.

Super, Service1

“controlmag” (page 83)

Prepares a drive cage for
service.

Super, Service1

servicehost

Prepares a port for host
attachment.

Super, Service1 Any role
“servicehost” (page 263)
granted the host_service
right.

servicemag

Prepares a drive magazine
for service.

Super, Service1

Service Commands
Disk Enclosure

servicecage

30

Commands Quick Reference

Any role granted the
mag_control right.
“servicecage” (page 261)

Any role granted the
cage_service right.

“servicemag” (page 265)

Command

Description

Authority

For Details See

Any role granted the
mag_service right.
upgradecage

upgradepd

Upgrades drive cage
firmware.

Super, Service1

Upgrades disk firmware.

Super, Service1

“upgradecage” (page 662)

Any role granted the
cage_upgrade right.
“upgradepd” (page 664)

Any role granted the
pd_upgrade right.
1

You need access to all domains in order to run this command.

Node
Command

Description

Authority

servicenode

Prepares a node for service. Super, Service1

For Details See
“servicenode” (page 269)

Any role granted the
node_service right.
1

You need access to all domains in order to run this command.

General System Maintenance
Command

Description

Authority

For Details See

shutdownnode

Shuts down an individual
system node.

Super, Service1 Any role
granted the
node_shutdown right.

“shutdownnode” (page 530)

shutdownsys

Shuts down the entire
system.

Super, Service1

“shutdownsys” (page 533)

1

Any role granted the
sys_shutdown right.

You need access to all domains in order to run this command.

QoS Commands
Command

Description

Authority

For Details See

setqos

Creates and updates QoS
rules in a system.

Super, Edit

“setqos” (page 312)

Any role granted the
qos_set right can set QoS
configurations.

showqos

Lists the QoS rules
configured in a system.

Any role in the system.

statqos

Displays historical
Any role in the system.
performance data reports for
QoS rules

“showqos” (page 458)
“statqos” (page 616)

Service Commands

31

System Upgrade
Command

Description

Authority

For Details See

showpatch

Displays patches applied to Any role in the system.
a system.

“showpatch” (page 419)

showversion

Displays software versions.

Any role in the system.

“showversion” (page 502)

Authority

For Details See

SNMP Agent Commands
Command

1

addsnmpmgr

Adds an SNMP manager to Super
receive trap notifications.
Any role granted the
snmpmgr_ad right.

“addsnmpmgr” (page 42)

checksnmp

Allows a user to send an
SNMPv2 test trap to the list
of managers

Super, Service
Any role granted the
snmp_check right

“checksnmp” (page 70)

removesnmpmgr

Removes an SNMP trap
manager.

Super1

“removesnmpmgr”
(page 244)

Removes an SNMP
password.

Super1

removesnmpuser

Removes an SNMP user.

Super, Service, Edit, Browse “removesnmpuser”
Any role granted the
(page 247)
snmpuser_remove right.

setsnmppw

Allows users to update
SNMP passwords.

Super1

Changes an SNMP
manager's properties.

Super1

removesnmppw

setsnmpmgr

32

Description

Any role granted the
snmpmgr_remove right.

“removesnmppw” (page 246)

Any role granted the
snmppw_remove right.

“setsnmppw” (page 326)

Any role granted the
snmppw_set right.
“setsnmpmgr” (page 324)

Any role granted the
snmpmgr_set right.

setsnmpuser

Sets the SNMPv3 user secret Super, Service, Edit, Browse “setsnmpuser” (page 328)
key used for generating
Any role granted the
authentication and privacy snmpuser_set right.
keys.

showsnmpmgr

Displays SNMP trap
managers.

Any role in the system.

“showsnmpmgr” (page 473)

showsnmppw

Displays SNMP access
passwords.

Any role in the system.

“showsnmppw” (page 474)

showsnmpuser

Displays information about
SNMP users.

Any role in the system.

“showsnmpuser” (page 475)

Commands Quick Reference

1

You need access to all domains in order to run this command.

System Reporter Commands
Command

Description

Authority

sraomoves

Any role in the system.
Shows the space that
Adaptive Optimization (AO)
has moved between tiers.

“sraomoves” (page 535)

srcpgspace

Displays historical space
Any role in the system.
data reports for common
provisioning groups (CPGs).

“srcpgspace” (page 537)

srhistld

Displays historical histogram Any role in the system.
performance data reports for
logical disks.

“srhistld” (page 539)

srhistpd

Displays historical histogram Any role in the system.
data reports for physical
disks.

“srhistpd” (page 542)

srhistport

Displays historical histogram Any role in the system.
performance data reports for
ports.

“srhistport” (page 545)

srhistvlun

Displays historical histogram Any role in the system.
performance data reports for
VLUNs.

“srhistvlun” (page 548)

srldspace

Displays historical space
Any role in the system.
data reports for logical disks
(LDs).

“srldspace” (page 551)

srpdspace

Displays historical space
data reports for physical
disks (PDs).

“srpdspace” (page 554)

srrgiodensity

Shows the distribution of
Any role in the system.
IOP/s intensity for Logical
Disk (LD) regions for a
common provisioning group
(CPG) or Adaptive
Optimization (AO)
configuration.

“srrgiodensity” (page 556)

srstatcmp

Displays historical
Any role in the system.
performance data reports for
cache memory.

“srstatcmp” (page 558)

srstatcpu

Displays historical
Any role in the system.
performance data reports for
CPUs.

“srstatcpu” (page 560)

srstatld

Displays historical
Any role in the system.
performance data reports for
logical disks.

“srstatld” (page 562)

srstatlink

Displays historical
Any role in the system.
performance data reports for
links (internode, PCI and
cache memory).

“srstalink” (page 564)

srstatpd

Displays historical
Any role in the system.
performance data reports for
physical disks.

“srstatpd” (page 566)

Any role in the system.

For Details See

System Reporter Commands

33

Command

Description

Authority

For Details See

srstatport

Any role in the system.
Displays historical
performance data reports for
ports.

“srstatport” (page 568)

srstatqos

Displays historical
Any role in the system.
performance data reports for
QoS rules.

“srstatqos” (page 570)

srstatvlun

Any role in the system.
Displays historical
performance data reports for
VLUNs.

“srstatvlun” (page 572)

srvvspace

Displays historical space
data reports for virtual
volumes (VVs).

Any role in the system.

“srvvspace” (page 574)

Description

Authority

For Details See

CIM Server Commands
Command

1

setcim

Sets the properties of the
Super, Service
CIM server, including
Any role granted the
options to enable or disable
cim_set right.
the SLP, HTTP and HTTPS
ports for the CIM server.

“setcim” (page 282)

showcim

Displays the CIM server
setting information and
status.

Any role in the system.

“showcim” (page 365)

startcim

Starts the CIM server to
service CIM requests.

Super, Service1

“startcim” (page 579)

stopcim

1

Stops the CIM server from
servicing CIM requests.

Any role granted the
cim_start right.
Super, Service1

“stopcim” (page 633)

Any role granted the
cim_stop right.

You need access to all domains in order to run this command.

Sparing Commands
Command
createspare

Description
Creates spare chunklets.

Authority
Super, Service

For Details See
1

“createspare” (page 135)

Any role granted the
spare_create right.
movech

Moves specified chunklets.

Super, Service, Edit1

“movech” (page 210)

Any role granted the
ch_move right.

34

movechtospare

Moves specified chunklets to Super, Service, Edit1
spare.
Any role granted the
ch_movetospare right.

“movechtospare” (page 213)

movepd

Moves data from specified Super, Service, Edit
Physical Disks (PDs) to a
Any role granted the
temporary location selected pd_move right.
by the system.

“movepd” (page 215)

Commands Quick Reference

Command

Description

Authority

For Details See

movepdtospare

Moves specified physical
disks to spare.

Super, Service, Edit1

“movepdtospare” (page 217)

Moves chunklets relocated
from a physical disk to
another physical disk.

Super, Service1

moverelocpd

removespare

Removes spare chunklets.

Any role granted the
pd_movetospare right.
“moverelocpd” (page 219)

Any role granted the
pd_movereloc right.
Edit, Service1

“removespare” (page 248)

Any role granted the
spare_remove right.
showspare

1

Displays information about
spare and relocated
chunklets.

Any role in the system.

“showspare” (page 479)

You need access to all domains in order to run this command.

SSH Access Commands
Command

Description

Authority

For Details See

setsshkey

Sets the SSH public key for Super, Service, Edit, Browse “setsshkey” (page 329)
users enabling login without Any role granted the
a password.
sshkey_set right.

showsshkey

Displays all SSH public keys Any role in the system.
that have been set with
setshhkey.

removesshkey

Removes a user’s SSH public Super, Service, Edit, Browse “removesshkey” (page 250)
key.
Any role granted the
sshkey_remove right.

“showsshkey” (page 481)

Task Schedule Commands
Command

Description

Authority

For Details See

createsched

Allows users to schedule
tasks that are periodically
run by the scheduler.

Super, Service
Any role granted the
sched_createright.

“createsched” (page 131)

removesched

Removes a scheduled task
from the system.

Super, Service
Any role granted the
sched_remove right.

“removesched” (page 243)

setsched

Allows users to suspend,
Super, Service
pause, change the schedule, Any role granted the
change the parameters, and sched_set right.
change the name of
currently scheduled tasks.

“setsched” (page 322)

showsched

Displays the state of tasks
currently scheduled on the
system.

“showsched” (page 471)

Super, Service
Any extended role in the
system.

SSH Access Commands

35

User Management Commands
Command

Description

Authority

For Details See

createuser

Creates user accounts.

Super1

“createuser” (page 149)

Any role granted the
user_create right.
removeuser

Removes user accounts.

Super1

“removeuser” (page 254)

Any role granted the
user_remove right.
removeuserconn

Removes user connections.

Super1

“removeuserconn” (page 255)

Any role granted the
userconn_remove right.
setpassword

Changes your password.

Super, Edit, Service,
Browse2

“setpassword” (page 309)

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” (page 341)
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.

36

setuseracl

Sets your Access Control List Super, Edit
(ACL).
Any role granted the
useracl_set right.

“setuseracl” (page 342)

showuser

Displays user accounts.

“showuser” (page 497)

showuseracl

Displays your access control Any role in the system.
list (ACL).

“showuseracl” (page 499)

showuserconn

Displays user connections.

Any role in the system.

“showuserconn” (page 500)

showrole

Displays information about
rights assigned to roles in
the system.

Any role in the system.

“showrole” (page 467)

Any role in the system.

1

You need access to all domains in order to run this command.

2

Only the Super User can edit other user’s passwords.

Commands Quick Reference

Volume Management Commands
Common Provisioning Group Management
Command

Description

compactcpg

Super, Edit
Consolidates logical disk
space in a CPG into as few Any role granted the
logical disks as possible,
cpg_compact right.
allowing unused logical
disks to be removed.

createcpg

Creates a Common
Provisioning Group (CPG).

Super, Edit1

Removes CPGs.

Super, Edit1

removecpg

Authority

For Details See
“compactcpg” (page 75)

“createcpg” (page 110)

Any role granted the
cpg_create right.
“removecpg” (page 231)

Any role granted the
cpg_remove right.
setcpg

showcpg
1

Changes the properties
CPGs.

Super, Edit1

Displays CPGs.

Any role in the system.

“setcpg” (page 286)

Any role granted the
cpg_set right.
“showcpg” (page 368)

You need access to all domains in order to run this command.

Host Management
Command

Description

Authority

For Details See

createhost

Creates host and host path
definitions.

Super, Edit1

“createhost” (page 121)

createhostset

removehost

removehostset

Creates a new set of hosts
and provides the option of
assigning one or more
existing hosts to that set.

Any role granted the
host_create right.
Super, Edit

“createhostset” (page 123)

Any role granted the
hostset_create right.

Removes host definitions
from the system.

Super, Edit1

Removes a host set or
removes hosts from an
existing set.

Super, Edit

“removehost” (page 235)

Any role granted the
host_remove right.
“removehostset” (page 237)

Any role granted the
hostset_remove right.

showhost

Displays defined hosts in the Any role in the system.
system.

“showhost” (page 386)

showhostset

Displays the host sets
defined on the HP 3PAR
Storage System and their
members.

“showhostset” (page 389)

Any role in the system.

Volume Management Commands

37

Command

Description

sethost

Super, Edit1
Sets properties on existing
system hosts, including
Any role granted the
options to annotate a host
host_set right.
with descriptor information
such as physical location, IP
address, operating system,
model, and so on.

“sethost” (page 296)

sethostset

Sets the parameters and
modifies the properties of a
host set.

“sethostset” (page 299)

1

Authority

Super, Edit

For Details See

Any role granted the
hostset_set right.

You need access to all domains in order to run this command.

Logical Disk Management
Command

Description

Authority

For Details See

checkld

Performs validity checks of
data on logical disks.

Super, Service1

“checkld” (page 59)

compactld

Consolidates space on the
logical disks.

Any role granted the
ld_check right.
Super, Edit

“compactld” (page 77)

Any role granted the
ld_compact right.

createald

Automatically creates logical Super, Edit1
disks.
Any role granted the
ld_create right.

createld

Creates logical disks.

Super, Edit1

“createald” (page 95)

“createld” (page 125)

Any role granted the
ld_create right.
removeld

Removes logical disks.

Super, Service, Edit

“removeld” (page 238)

Any role granted the
ld_remove right.
showld

Displays logical disks.

Any role in the system.

“showld” (page 394)

startld

Starts logical disks.

Super, Service1

“startld” (page 580)

Any role granted the
ld_start right.
1

You need access to all domains in order to run this command.

Space and Storage Management

38

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” (page 358)

showldch

Displays logical disk to
physical disk chunklet
mapping.

Any role in the system.

“showldch” (page 400)

showldmap

Displays logical disk to
virtual volume mapping.

Any role in the system.

“showldmap” (page 404)

Commands Quick Reference

Command

Description

Authority

For Details See

showpdch

Displays the status of
selected chunklets of
physical disks.

Any role in the system.

“showpdch” (page 432)

showpdvv

Displays physical disk to
virtual volume mapping.

Any role in the system.

“showpdvv” (page 437)

showspace

Displays estimated free
space.

Any role in the system.

“showspace” (page 476)

showvvmap

Displays virtual volume to
logical disk mapping.

Any role in the system.

“showvvmap” (page 521)

showvvpd

Displays virtual volume
distribution across physical
disks.

Any role in the system.

“showvvpd” (page 523)

Command

Description

Authority

For Details See

createtemplate

Creates templates for the
Super1
creation of logical disks,
Any role granted the
virtual volumes, thinly
template_create right.
provisioned virtual volumes,
and common provisioning
groups.

removetemplate

Removes one or more
templates.

Super1

Modifies template
properties.

Super1

Template Management

settemplate

showtemplate
1

Displays existing templates.

“createtemplate” (page 139)

“removetemplate” (page 253)

Any role granted the
template_remove right.
“settemplate” (page 339)

Any role granted the
template_set right.
Any role in the system.

“showtemplate” (page 494)

You need access to all domains in order to run this command.

Virtual Volume Management
Command

Description

Authority

admitvv

Creates and admits remotely Super Any role granted the
exported virtual volume
vv_admit right.
definitions to enable the
migration of these volumes.

“admitvv” (page 54)

checkvv

Performs validity checks of
Super, Service, Edit1
virtual volume administrative
Any role granted the
information.
vv_check right.

“checkvv” (page 71)

createaldvv

Automatically creates virtual Super, Edit1
volumes and their underlying
Any role granted the
logical disks.
vv_create right.

“createaldvv” (page 99)

createavv

Automatically creates virtual Super, Edit1
volumes.
Any role granted the
vv_create right.

“createavv” (page 107)

createtpvv

Creates a TPVV.

“createtpvv” (page 145)

Super, Edit

For Details See

Volume Management Commands

39

Command

Description

Authority

For Details See

Any role granted the
vv_create right.
createvv

Creates a virtual volume
from logical disks.

Super, Edit1

“createvv” (page 154)

Any role granted the
vv_create right.

createvvset

Defines a new set of virtual Super, Edit
volumes provides the option Any role granted the
of assigning one or more
vvset_create right.
existing virtual volumes to
that set.

“createvvset” (page 162)

freespace

Super, Edit
Frees SA and SD spaces
from a virtual volume if they Any role granted the
are not in use.
space_free right.

“freespace” (page 170)

growaldvv

Automatically increases the Super, Edit1
size of a virtual volume and
Any role granted the
its underlying logical disks.
vv_grow right.

“growaldvv” (page 171)

growavv

Automatically increases the
size of a virtual volume.

Super, Edit1

“growavv” (page 176)

Any role granted the
vv_grow right.

growtpvv

Enlarges a thin provisioning Super, Edit
virtual volume.
Any role granted the
vv_grow right.

“growtpvv” (page 178)

growvv

Increases the size of a virtual Super, Edit1
volume by adding logical
Any role granted the
disks.
vv_grow right.

“growvv” (page 179)

importvv

Migrates data from a remote Super, Service, Edit
LUN to the local HP 3PAR
Any role granted the
Storage System.
vv_import right.

“importvv” (page 204)

removevv

Removes virtual volumes or
logical disks from common
provisioning groups.

“removevv” (page 258)

Super, Edit
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

Removes a virtual volume set Super, Edit
or virtual volumes from an
Any role granted the
existing set.
vvset_remove right.

“removevvset” (page 260)

setvv

Modifies properties
associated with a virtual
volume.

Super, Edit

“setvv” (page 344)

Sets the parameters and
modifies the properties of a
virtual volume set.

Super, Edit

setvvset

40

Commands Quick Reference

Any role granted the
vv_set right.

Any role granted the
vvset_set right.

“setvvset” (page 348)

Command

Description

Authority

For Details See

showrsv

Displays information about
reservation and registration
of VLUNs connected on a
Fibre Channel port.

Any role in the system.

“showrsv” (page 469)

showvv

Displays virtual volumes in
the system.

Any role in the system.

“showvv” (page 506)

showvvcpg

Displays the virtual volume Any role in the system.
sets defined on the HP 3PAR
Storage System and their
associated members.

“showvvcpg” (page 519)

showvvset

Displays the virtual volume Any role in the system.
sets defined on the HP 3PAR
Storage System and their
members.

“showvvset” (page 527)

startvv

Starts virtual volumes.

Super, Service1

“startvv” (page 586)

Any role granted the
vv_start right.
updatesnapspace

1

Starts a task to update the
Super, Edit
“updatesnapspace”
actual snapshot space used Any role granted the
(page 658)
by a virtual volume.
snapspace_update right.

You need access to all domains in order to run this command.

Virtual LUN (Export) Management
Command

Description

Authority

For Details See

createvlun

Creates a virtual volume as
a SCSI LUN.

Super, Edit
Any role granted the
vlun_create right.

“createvlun” (page 151)

removevlun

Removes VLUNs.

Super, Edit
Any role granted the
vlun_remove right.

“removevlun” (page 256)

showvlun

Displays VLUNs in the
system.

Any role in the system.

“showvlun” (page 503)

Web Services API (WSAPI) Commands
Command

Description

Authority

For Details See

setwsapi

Sets properties of the Web
Services API server.

Super, Service
Any role granted the
wsapi_set right.

“setwsapi” (page 349)

showwsapi

Displays the WSAPI server
service configuration state.

Any role in the system.

“showwsapi” (page 529)

startwsapi

Starts the WSAPI server.

Super, Service
Any role granted the
wsapi_start right.

“startwsapi” (page 587)

stopwsapi

Stops the WSAPI server.

Super, Service
Any role granted the
wsapi_stop right.

“stopwsapi” (page 638)

Web Services API (WSAPI) Commands

41

3 Add Command
addsnmpmgr
DESCRIPTION
The addsnmpmgr command adds an SNMP manager to receive alert (traps) notifications.
WARNING! SNMP cannot be used in Common Criteria mode. It might compromise the security
of the storage system.

SYNTAX
addsnmpmgr [options ] 

AUTHORITY
•

Super

•

Any role granted the snmpmgr_add right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–p 
Specifies the port number where the SNMP manager receives traps. This option is used if the port
number differs from the default of 162.
–pw 
Specifies the SNMP manager’s access community string (password), using up to 32 alphanumeric
characters. If unspecified, the agents send traps without an access password.
–r 
Specifies the number of times to send a trap () 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.
-snmpuser 
Specifies the SNMPv3 user name using up to 31 characters. The user name must be enabled for
SNMPv3 with the createsnmpuser command.
–t 
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.
-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

Specifies the IP address of the host where the manager runs. It must be a valid IPv4 or IPv6 address.
The IPv6 address is in hexadecimal, is case insensitive, and is separated by colons. For example:
5de:2008:0:0abcd:0:0:161a
In addition, a double colon (::) can be used once in an address to replace multiple fields of zeros.
For example:
42

Add Command

5de:2008:0:0abcd::161a.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example displays the addition of SNMP manager IPv4 address 123.45.67.89
with the assigned password of alpha1:
cli% addsnmpmgr –pw alpha1 123.45.67.89

The following example displays the addition of SNMP manager IPv6 address
5def:2008:abcd::161a with port number 9162:
cli% addsnmpmgr -p 9162 5def:2008:abcd::161a

NOTES
•

The HP 3PAR storage system does not support any form of name resolution. You must specify
these IP addresses directly.

•

Issue the showsnmpmgr command to display the list of registered SNMP managers.

•

Issue the setsnmppw command to change the SNMP passwords.

•

Issue the removesnmppw command to remove SNMP passwords.

•

Issue the removesnmpmgr command to remove SNMP managers. See “removesnmpmgr”
(page 244) for additional information.

addsnmpmgr

43

4 Admit Commands
admithw
DESCRIPTION
The admithw command admits new hardware into the system.

AUTHORITY
Super, Service
NOTE:

You need access to all domains in order to run this command.

SYNTAX
admithw [options]

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.

SPECIFIERS
None.

RESTRICTIONS
Access to all domains is required to run this command.

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

44

•

The admithw command handles any nodes, disks, or cages that have been added into the
system.

•

In addition to verifying that all expected hardware is present, the admithw command handles
all checks, including valid states, cabling, and firmware revisions.

Admit Commands

•

The admithw command also handles creating system logical disks while adding and
rebalancing spare chunklets.

•

Spares are allocated according to the algorithm specified by the Sparing Algorithm system
parameter.

admithw

45

admitpd
DESCRIPTION
The admitpd command creates and admits physical disk definitions to enable the use of those
disks.

AUTHORITY
•

Super, Service

•

Any role granted the pd_admit right.

NOTE:

You need access to all domains in order to run this command.

SYNTAX
admitpd [option] [...]

OPTIONS
–nold
Do not use the physical disk (as identified by the WWN specifier) for logical disk allocation. See
“NOTES” for more information about the –nold option.
-f
Do not prompt for confirmation when attempting to admit disks from other systems.

SPECIFIERS
[...]
Indicates the World-Wide Name (WWN) of the physical disk to be admitted. If WWNs are
specified, only the specified physical disk(s) are admitted. Otherwise, all available physical disks
are admitted.

RESTRICTIONS
•

Access to all domains is required to run this command.

•

If multiple WWNs are specified and not all can be admitted, the admitpd command fails.

EXAMPLES
The following example admits physical disks in a 20-disk system:
cli% admitpd
20 disks admitted

NOTES

46

•

Physical disks cannot be used by the HP 3PAR operating system for storage until they are
admitted into the system.

•

Specify the –nold option when adding a physical disk to replace a failed disk, whose chunklets
were moved to spare space. Specifying –nold prevents the allocation of the newly added
physical disk 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 command.

Admit Commands

•

Verify the admittance of physical disk definitions by issuing the showpd command. See
“showpd” (page 420).

•

If no WWN is specified or if all the specified WWNs are admitted, the command succeeds.
If all the specified WWNs could not be admitted, the command fails.

admitpd

47

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

For Remote Copy over Fibre Channel (RCFC), the syntax for the admitrcopylink command
is as follows:

admitrcopylink  ...

AUTHORITY
•

Super, Edit

•

Any role granted the rcopylink_admit right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
None.

SPECIFIERS

The target name, as specified with the creatercopytarget command.
...
Specifies the node, slot, and port of the Ethernet port on the primary system and an IP address on
the target system.
...
Specifies the node, slot, and port of the Fibre Channel adaptor port on the primary system and a
World Wide Name (WWN) address on the target system.

RESTRICTIONS
Functionality of this command requires the HP 3PAR Remote Copy Software license. Contact your
local service provider for more information.

EXAMPLES
The following example adds a link on System2 (), using the node, slot, and
port information of node 1, slot 1, port 1 of the Ethernet port on the primary system. 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 FC 5:3:2:20010002AC000060
48

Admit Commands

NOTES
•

The transport layer (RCIP or RCFC) is set using the creatercopytarget command.

•

This command concludes by returning a list of one or more links to be admitted.

•

For IP targets this list is made up 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 this list is 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.

•

The specifier  has been deprecated.

admitrcopylink

49

admitrcopytarget
DESCRIPTION
The admitrcopytarget command adds a target to a Remote Copy volume group.

SYNTAX
admitrcopytarget   
[:]...

AUTHORITY
•

Super, Edit

•

Any role granted the rcopytarget_admit right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
None.

SPECIFIERS

Specifies the name of the target that was previously created with the creatercopytarget
command.

Specifies the mode of the target as either synchronous (sync) or asynchronous periodic (periodic).

Specifies the name of the existing Remote Copy volume group created with the creatercopygroup
command to which the target will be added.
[:]...
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 not required only if the group contains no volumes.

RESTRICTIONS
Functionality of this command requires the HP 3PAR Remote Copy license. Contact your local
service provider for further information.

EXAMPLES
In the following example, the admitrcopytarget command adds the target target1 in
synchronous mode to volume group Group1.
cli% admitrcopytarget target1 sync Group1

NOTES
None.

50

Admit Commands

admitrcopyvv
DESCRIPTION
The admitrcopyvv command adds an existing virtual volume to an existing Remote Copy volume
group.

SYNTAX
admitrcopyvv [options] [:] 
:...

AUTHORITY
•

Super, Edit

•

Any role granted the rcopyvv_admit right.

OPTIONS
-pat
Specifies that the  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  and  (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.  and  should take the form
prefix@vvname@suffix, where @vvname@ resolves to the name of each volume that matches the
 pattern.
-createvv
Specifies that the secondary volumes should be created automatically.
-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
(:) are specified.

SPECIFIERS

Specifies the name of the existing virtual volume to be admitted to an existing Remote Copy volume
group that was created with the creatercopygroup command.

An optional read-only snapshot  can be specified along with the virtual volume 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
 and the base volume. For asynchronous periodic groups, the volume will synchronize
deltas between  and a snapshot of the base.

Specifies the name of the existing Remote Copy volume group created with the creatercopygroup
command, to which the volume will be added.

Specifies the pattern that is used to create the secondary virtual volume on the target system.
:

admitrcopyvv

51

The target name associated with this group, as set with the creatercopygroup command. The
target is created with the creatercopytarget command.  specifies the name
of the secondary volume on the target system. One : must be
specified for each target of the group.

Specifies a glob-style pattern. If this specifier is not used, the  specifier must be used.
For more information, issue: clihelp sub,globpat

RESTRICTIONS
Functionality of this command requires the HP 3PAR Remote Copy license. Contact your local
service provider for more information.

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), which
was previously created when the creatercopygroup 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 virtual volumes (as specified by @vvname@), on the target system
System2 to the corresponding secondary volume group (Group1.r).
cli% admitrcopyvv -pat tpvv* Group1 InServ2:@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 command was issued:
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 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 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

52

Admit Commands

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 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
•

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 after the Remote Copy
group is started. On the primary system, the showrcopy SyncStatus will appear as
New-PreSynced. On the secondary system, the SyncStatus will appear as New.

•

When a starting snapshot is specified, any deltas 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 SyncStatus will appear as New-SyncFromSnap.
On the secondary system 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. The showrcopy 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.

admitrcopyvv

53

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 ] : [: ...]
admitvv [-domain ] :: [:] ...

AUTHORITY
•

Super, Edit

•

Any role granted the vv_admit right.

OPTIONS
-domain 
Creates 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

Specifies the local name of the volume to be admitted (up to 31 characters in length).

Specifies the World Wide Name (WWN) of the remote volumes to be admitted.

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.

RESTRICTIONS
Functionality of this command requires the Peer Motion license. Contact your local service provider
for more information.

EXAMPLES
The following example admits two remote VVs that have been exported to the HP 3PAR storage
system in preparation for migration:
cli% admitvv migvv.0:50002AC00037001A migvv.1:50002AC00047001A
2 VVs admitted

NOTES

54

•

You need access to all domains in order to run this command.

•

The volume admitted using this command can be exported to hosts but all data access to the
volume will be directed to the external LUN.

•

The volume admitted using this command can be imported by the HP 3PAR Storage System
using the importvv command.

Admit Commands

5 Cancel Command
canceltask
DESCRIPTION
The canceltask command cancels one or more tasks.

SYNTAX
canceltask [option] {all|...}

AUTHORITY
•

Service, Super, 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.
...
Cancels only tasks identified by their task IDs. The  must be an unsigned integer from
1 through 9999. If not specified, all tasks are cancelled.

RESTRICTIONS
None.

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
•

See the HP 3PAR OS CLI Administrator’s Manual for additional information and examples
regarding task management and task management commands.

•

The canceltask command can return before a cancellation is completed. As a result,
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” (page 665) for details.

•

The tunevv restart command enables you to resume a canceled tunevv task. See
“tunevv” (page 656) for more information.

•

A Service user is only allowed to cancel tasks started by that specific user.

canceltask

55

6 Change Command
changedomain
DESCRIPTION
The changedomain command changes the currentdomain CLI environment parameter.

SYNTAX
changedomain []

AUTHORITY
Any role in the system.

OPTIONS
None.

SPECIFIERS

Name of the domain to be set as the working domain for the current CLI session. If the 
parameter is not present or is equal to -unset, then the working domain is set to no current
domain.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example shows how to change the current domain Win:
cli% changedomain Win

The following examples shows two methods to unset the current domain:
cli% changedomain -unset
cli% changedomain

NOTES
This command is equivalent to the setclienv currentdomain  command.

56

Change Command

7 Check Commands
checkhealth
DESCRIPTION
The checkhealth command checks the status of system hardware and software components,
and reports any issues.
NOTE: For information about system alerts, go to http://www.hp.com/support/hpgt/3par and
select your server platform.

SYNTAX
checkhealth [ | ]

AUTHORITY
•

Super, Service

•

Any role granted the health_check right.

OPTIONS
-lite
Will perform a minimal health check.
–list
Will list all components that will be checked.
–quiet
Will not display which component is currently being checked.
–detail
Will display detailed information regarding the status of the system.

SPECIFIERS

Indicates the component to check. Use -list option to get the list of components.

RESTRICTIONS
None.

EXAMPLES
The following example displays as sample output of the checkhealth command:
cli% checkhealth
Checking alert
Checking cage
Checking date
Checking ld
Checking license
Checking network
Checking node
Checking pd
Checking pdch
Checking port
checkhealth

57

Checking rc
Checking snmp
Checking task
Checking vlun
Checking vv
Component ------------Description------------ Qty
Alert
New alerts
6
Cage
Cages not on current firmware
2
Date
Date is not the same on all nodes
1
LD
LDs not mapped to a volume
3
License
Golden License.
1
PD
PDs that are degraded or failed
2
pdch
LDs with chunklets on a remote disk
5
vlun
Hosts not connected to a port
3
vlun
Paths not reported by host agent
2

NOTES
None.

58

Check Commands

checkld
DESCRIPTION
The checkld command executes consistency checks of data on logical disks in the event of an
uncontrolled system shutdown and optionally repairs inconsistent logical disks.

SYNTAX
checkld [options] ...
Any role granted the ld_check right

AUTHORITY
•

Super, Service

•

Any role granted the ld_check right

NOTE:

You need access to all domains in order to run this command.

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).
-p
Poll sysmgr to get ldck results.
-recover 
Attempt to recover the chunklet specified by giving physical disk () and the chunklet's
position on that disk (). If this option is specified, -y must be specified as well.
-rs 
Check only the specified RAID set.

SPECIFIERS
...
Requests that the integrity of a specified logical disk is checked. This specifier can be repeated to
execute validity checks on multiple logical disks.

RESTRICTIONS
•

Access to all domains is required to run this command.

•

The checkld command should not be issued for logical disks that have been started because
it can return incorrect mismatches.

EXAMPLES
The following example displays a validity check of logical disk vv63.admn.0:
cli% checkld –n vv63.adm.0
Performing a consistency check only (no repairs)
Working on ld vv63.adm.0 (955)
compare:/dev/tpddev/pd/33 0x2180000 with:/dev/tpddev/pd/11 0x2180000 1 of 1
Logical disk vv63.adm.0 Check completed, logical disk consistent

checkld

59

The following example attempts to recover chunklet 1032:10 of logical disk vv.adm.0, and there
will be output about the progress:
cli% checkld -y -p -recover 1032:10 vv.adm.0

NOTES

60

•

Repairing logical disks refers to making logical disks 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.

•

The checkld –n command can be issued at any time as it reads only from the logical disk.
If this command is issued for a started logical disk, false negative errors can be reported
because of the contents of the physical disks changing during I/O and the difference in mirror
update time.

•

The checkld –y command can only be issued when the logical disk is in the not started
state.

Check Commands

checkpassword
DESCRIPTION
The checkpassword command prompts for the 's password and then displays the steps
the system uses to authenticate the user and determine the user's access to the system. The
information includes whether the user is local to the system or authenticated and authorized based
on the configuration parameters set with setauthparam command for use with LDAP.

SYNTAX
checkpassword []

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.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
None.

SPECIFIER

If the  parameter is not specified, then the current user is used. Only users with Super
privileges with access to all domains can specify  names other than their own.

RESTRICTIONS
None.

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 privilege level.

•

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

checkpassword

61

setauthparam command has been used to change parameters or data in the LDAP server
has changed since the user last logged in.
•

62

The showuserconn command can be used to verify the authorization levels assigned at
login.

Check Commands

checkpd
DESCRIPTION
The checkpd command executes surface scans or diagnostics on physical disks.

SYNTAX
checkpd scrub|diag [options ] ...

AUTHORITY
•

Super, Service

•

Any role granted the pd_check right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
The following options can only be used with the scrub specifier:
-ch 
To scan a specific chunklet rather than the entire disk.
-count 
To scan a number of chunklets starting from -ch.
The following options can only be used with the diag specifier:
-path 

Specifies a physical disk path as a, b, both, or system.
-test 
Specifies read, write, or verify test diagnostics. If no type is specified, the default is read.
-iosize 
Specifies I/O size, valid ranges are from 1s to 1m. If no size is specified, the default is 128k.
-threads 
Specifies of I/O threads, valid ranges are from 1 to 4. If the number of threads is not specified,
the default is 1.
-time 
Indicates the number of seconds to run, from 1 to 36000.
-total 
Indicates total bytes to transfer per disk. If a size is not specified, the default size is 1g.
-retry 
Specifies the total number of retries on an I/O error. If the number of retries is not specified, the
default is 4.
-range 
Limits diagnostic regions to a specified size, from 2m to 2g.

SPECIFIERS
scrub
Scans one or more chunklets for media defects.
diag
checkpd

63

Performs read, write, or verifies test diagnostics.
...
The ID of the physical disk to be checked. Only one pd_ID can be specified for the “scrub” test.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
In the following example, chunklet 500 on physical disk 1 is scanned for media defects:
cli%
{Tue
{Tue
{Tue
{Tue
{Tue
{Tue
{Tue
{Tue
{Tue

checkpd scrub -ch 500 1
Jul 10 17:11:26 PDT 2007}
Jul 10 17:11:26 PDT 2007}
Jul 10 17:11:26 PDT 2007}
Jul 10 17:11:26 PDT 2007}
Jul 10 17:11:26 PDT 2007}
Jul 10 17:11:26 PDT 2007}
Jul 10 17:11:27 PDT 2007}
Jul 10 17:11:39 PDT 2007}
Jul 10 17:11:39 PDT 2007}

{31391}
{31391}
{31391}
{31391}
{31391}
{31391}
{31393}
{31393}
{31391}

Open system device...
Attach to system manager...
Waiting for system manager ready...
PD Scrubber 1.5 started
Thread 16386 started for port 0:0:1
Starting scan of pd 1 on port 0:0:1
Scanning pd 1 ch 500
Scan pd 1 ch 500 finished with 0 errors
No media errors detected

NOTES

64

•

The  specifier can include a letter to indicate units:

•

g = gigabytes (2^30)

•

t = terabytes (2^40)

•

p = petabytes (2^50)

•

m = 1048576 byte

•

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 physical disk IDs can be specified for the diag test type.

Check Commands

checkport
DESCRIPTION
The checkport command performs a loopback test on Fibre Channel ports.

SYNTAX
checkport [options ] 

AUTHORITY
Super, Service
Any role granted the port_check right.
NOTE:

You need access to all domains in order to run this command.

OPTIONS
–time 
Specifies the number of seconds the test is to run. Use an integer from 0 to 300.
–iter 
Specifies the number of times the test is to run. Use an integer from 1 to 1000000.

SPECIFIERS

Specifies the port to be tested.
node
Specifies the node using a number from 0 through 7.
slot
Specifies the PCI bus slot in the specified node using a number from 0 through 5 for platforms
other than the V-Class. For V-Class systems, the PCI slot number ranges from 0 through 9.
port
Specifies the Fibre Channel port number of the PCI card in the specified PCI bus slot using 1 through
4.

RESTRICTIONS
Access to all domains is required to run this command.

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

checkport

65

NOTES

66

•

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.

Check Commands

checkrclink
DESCRIPTION
The checkrclink command performs a connectivity, latency, and throughput test between two
connected HP 3PAR storage systems.

SYNTAX
•

checkrclink startclient   
][:[,]...]
Sorts command output based on column number (). Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, you can specify the direction
of sorting () as follows:
inc
Sort in increasing order (default).
dec
Sort in decreasing order.
Multiple can specify multiple columns on the command line by using a colon (:). Rows having the
same column(s) are sorted by the values in the latter specified columns.
–filt 
Specifies that histograms below the threshold specified by the  argument are not displayed.
The  argument is specified in the syntax of ,,.
•


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


Specifies the threshold service time in milliseconds.

•


Specifies the minimum number of access above the threshold service time. When filtering is
done, the  is compared with the sum of all columns starting with the one which
corresponds to the threshold service time. For example,-t,8,100 specifies that only the rows
where the 8ms column and all columns to the right adds up to more than 100 are to be
displayed.

–ni
Specifies that histograms for only nonidle devices are displayed. This option is shorthand for the
option –filt t,0,0.

histch

181

SPECIFIERS
None.

RESTRICTIONS
None.

EXAMPLES
The following example displays one iteration of a histogram of service times for system chunklets:
cli% histch –iter 1
12:42:57 10/20/04 ------------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

182

•

The setstatch command must be issued to enable statistics collection on chunklets before
issuing the histch command. See “setstatch” (page 331) for additional information.

•

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

Hist Commands

histld
DESCRIPTION
The histld command displays a histogram of service times for Logical Disks (LDs) in a timed
loop.

SYNTAX
histld [options ] [...]

AUTHORITY
Any role in the system.

OPTIONS
-vv ...|...
Show only LDs that are mapped to Virtual Volumes (VVs) with names that match any of the names
or patterns specified. Multiple volumes or patterns can be repeated using a comma separated list.
-domain ...|...
Shows only LDs that are in domains with names that match any of the names or patterns specified.
Multiple volumes or patterns can be repeated using a comma separated list.
–metric both|time|size
Selects which metric to display. Metrics can be one of the following:
•

both - (Default) Displays both I/O time and I/O size histograms.

•

time - Displays only the I/O time histogram.

•

size - Displays only the I/O size histogram.

–timecols  
For the I/O time histogram, shows the columns from the first column  through last column
. The available columns range from 0 through 31.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 6).

•

The last column () must be less than or equal to 31 (default value of 15).

•

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.

–sizecols  
For the I/O size histogram, show the columns from the first column () through the last
column (). Available columns range from 0 through 15.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 3).

•

The last column () must be less than or equal to 15 (default value of 11).

-pct
Shows the access count in each bucket as a percentage. If this option is not specified, the histogram
shows the access counts.
NOTE: For the following options, by default the histogram shows data from the start of the
command.
–prev|–begin
histld 183

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 
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 
Specifies that the histogram is to stop after the indicated number of iterations using an integer from
1 through 2147483647.
–sortcol  [,][:[,]...]
Sorts command output based on column number . Columns are numbered from left to right,
beginning with 0. You must specify a column number. In addition, you can specify the direction
of sorting  as follows:
inc
Sort in increasing order (default).
dec
Sort in decreasing order.
–filt 
Specifies that histograms below the threshold specified by the  argument are not displayed.
The  argument is specified in the syntax of ,,.
•


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


Specifies the threshold service time in milliseconds.

•


Specifies the minimum number of access above the threshold service time. When filtering is
done, the  is compared with the sum of all columns starting with the one which
corresponds to the threshold service time. For example,-t,8,100 specifies that only the rows
where the 8ms column and all columns to the right adds up to more than 100 are to be
displayed.

–ni
Specifies that histograms for only nonidle devices are displayed. This option is shorthand for the
option –filt t,0,0.

SPECIFIERS
[]...
184 Hist Commands

Specifies the LD(s) or pattern(s) for which the histogram data is collected.

RESTRICTIONS
None.

EXAMPLES
The following example displays one iteration of a histogram of service times for all LDs:
cli% histld –iter 1
12:38:49 10/20/04 ------------Time (millisec)-----------Ldame 0.26 0.53 1.05 2.1 4.2 8.4 17 34 67 135
tp–0–sa–0.0
0
0
0
0
0
0 0 0 0
0
tp–0–sd–0.1
0
0
0
0
0
0 0 0 0
0
tp–0–sd–0.0
0
0
0
0
0
0 0 0 0
0
admin.usr.0
0
0
0
0
1
6 6 1 0
0
tp–0–sa–0.1
0
0
0
0
0
0 0 0 0
0
tp–0–sd–0.3
0
0
0
0
0
0 0 0 0
0
tp–0–sd–0.2
0
0
0
0
0
0 0 0 0
0
--------------------------------------------------------total
0
0
0
0
1
6 6 1 0
0

NOTES
•

Each service time histogram column shows the number of accesses with service times between
the time shown in the column's heading to the 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).

•

If the  specifier is used, then logical disks with names that match
any of the patterns are listed, otherwise all LDs are listed. These patterns are glob-style patterns
(see help on sub,globpat).

•

Patterns are specified as regular expressions. Refer to “Glob-Style Pattern” (page 12) for further
information. Issuing histld –n LD_name.* displays histogram data for all LDs whose
name begins with LD_name.

histld 185

histpd
DESCRIPTION
The histpd command displays a histogram of service times for Physical Disks (PDs).

SYNTAX
histpd [options ]

AUTHORITY
Any role in the system.

OPTIONS
–w 
Specifies the World Wide Name (WWN) of the physical disk for which service times are displayed.
–nodes 
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 (1,2,3). The list can also
consist of a single integer (1). If the node list is not specified, all disks on all nodes are displayed.
–slots 
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 (1,2,3). The list can
also consist of a single integer (1). If the slot list is not specified, all disks on all slots are displayed.
–ports 
Specifies that the display is limited to specified port slots and physical disks connected to those
port slots. The port list is specified as a series of integers separated by commas (1,2,3). The list
can also consist of a single integer (1). 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) Displays both I/O time and I/O size histograms.

•

time - Displays only the I/O time histogram.

•

size - Displays only the I/O size histogram.

–timecols  
For the I/O time histogram, shows the columns from the first column  through last column
. The available columns range from 0 through 31.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column (). The default value of  is 6.

•

The last column () must be less than or equal to 31. The default value of  is
15.

•

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.

–sizecols  

186 Hist Commands

For the I/O size histogram, show the columns from the first column () through the last
column (). Available columns range from 0 through 15.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column (). The default value of  is 3.

•

The last column () must be less than or equal to 15. The default value of  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.
NOTE: For the following options, by default the histogram shows data from the start of the
command.
–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 
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 
Specifies that the histogram is to stop after the indicated number of iterations using an integer from
1 through 2147483647.
–sortcol  [,][:[,]...]
Sorts command output based on column number . Columns are numbered from left to right,
beginning with 0. You must specify a column number. In addition, you can specify the direction
of sorting  as follows:
inc
Sort in increasing order (default).
dec
Sort in decreasing order.
–filt 
Specifies that histograms below the threshold specified by the  argument are not displayed.
The  argument is specified in the syntax of ,,.
•


The  argument can be specified as one of the following:

◦

r - Specifies read statistics.

◦

w - Specifies write statistics.

histpd

187

•

◦

t - Specifies total statistics.

◦

rw - Specifies total read and write statistics.


Specifies the threshold service time in milliseconds.

•


Specifies the minimum number of access above the threshold service time. When filtering is
done, the  is compared with the sum of all columns starting with the one which
corresponds to the threshold service time. For example,-t,8,100 specifies that only the rows
where the 8ms column and all columns to the right adds up to more than 100 are to be
displayed.

–ni
Specifies that histograms for only nonidle devices are displayed. This option is shorthand for the
option –filt t,0,0.
–p 
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:
NOTE: An item is specified as an integer, a comma-separated list of integers, or a range of
integers specified from low to high.
–nd 
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes
are separated with a single comma (1,2,3). A range of nodes is separated with a hyphen (0–7).
The primary path of the disks must be on the specified node number(s).
–st 
Specifies one or more PCI slots. Slots are identified by one or more integers (). Multiple
slots are separated with a single comma (1,2,3). A range of slots is separated with a hyphen
(0–7). The primary path of the disks must be on the specified PCI slot number(s).
–pt 
Specifies one or more ports. Ports are identified by one or more integers (). Multiple ports
are separated with a single comma (1,2,3). A range of ports is separated with a hyphen (0–5).
The primary path of the disks must be on the specified port number(s).
–cg 
Specifies one or more drive cages. Drive cages are identified by one or more integers ().
Multiple drive cages are separated with a single comma (1,2,3). A range of drive cages is
separated with a hyphen (0–3). The specified drive cage(s) must contain disks.
–mg 
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 -mg option. Drive magazines are
identified by one or more integers (). Multiple drive magazines are separated with a single
comma (1,2,3). A range of drive magazines is separated with a hyphen (0–3). The specified
drive magazine(s) must contain disks.
–pn 
Specifies one or more disk positions within a drive magazine. Disk positions are identified by one
or more integers (). Multiple disk positions are separated with a single comma (1,2,3).

188 Hist Commands

A range of disk positions is separated with a hyphen (0–3). The specified position(s) must contain
disks.
–dk 
Specifies one or more physical disks. Disks are identified by one or more integers ().
Multiple disks are separated with a single comma (1,2,3). A range of disks is separated with a
hyphen (0–3). Disks must match the specified ID(s).
NOTE: The following arguments are used to limit the disks that are used to create logical disks
based on the characteristics of the disk drive.
–tc_gt 
Specifies that physical disks with total chunklets greater than the number specified are selected.
–tc_lt 
Specifies that physical disks with total chunklets less than the number specified are selected.
–fc_gt 
Specifies that physical disks with free chunklets greater than the number specified are selected.
–fc_lt 
Specifies that physical disks with free chunklets less than the number specified are selected.
–devid 
Specifies that physical disks identified by their models are selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the showpd -i command.
–devtype 
Specifies that physical disks must have the specified device type (FC for Fibre Channel, NL for
nearline, or SSD for solid state drive) to be used. Device types can be displayed by issuing the
showpd command.
-rpm 
Disks must be of the specified speed. Device speeds are shown in the RPM column of the showpd
-i 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
None.

RESTRICTIONS
None.

histpd 189

EXAMPLES
The following example displays a histogram of service times for all physical disks 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:
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).

•

Previous options –n , –s , and –p  have
been replaced with –nodes , –slots , and –ports
.

190 Hist Commands

histport
DESCRIPTION
The histport command displays a histogram of service times for ports within the system.

SYNTAX
histport [options ]

AUTHORITY
Any role in the system.

OPTIONS
–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.
–nodes 
Specifies that the display is limited to specified nodes and Physical Disks (PDs) connected to those
nodes. The node list is specified as a series of integers separated by commas (1,2,3). The list
can also consist of a single integer (1). If the node list is not specified, all disks on all nodes are
displayed.
–slots 
Specifies that the display is limited to specified PCI slots and PDs connected to those PCI slots. The
slot list is specified as a series of integers separated by commas (1,2,3). The list can also consist
of a single integer (1). If the slot list is not specified, all disks on all nodes are displayed.
–ports 
Specifies that the display is limited to specified ports and PDs connected to those ports. The port
list is specified as a series of integers separated by commas (1,2,3). The list can also consist of
a single integer (1). If the port list is not specified, all disks on all nodes are displayed.
–host|disk|-rcfc|-peer
Displays only host ports (target ports), disk ports (initiator ports), Fibre Channel Remote Copy
configured ports, or 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) Displays both I/O time and I/O size histograms.

•

time - Displays only the I/O time histogram.

•

size - Displays only the I/O size histogram.

–timecols  
For the I/O time histogram, show the columns from the first column  through last column
. The available columns range from 0 through 31.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 6).

•

The last column () must be less than or equal to 31 (default value of 15).

•

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

191

–sizecols  
For the I/O size histogram, show the columns from the first column () through the last
column (). Available columns range from 0 through 15.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 3).

•

The last column () must be less than or equal to 15 (default value of 11).

-pct
Shows the access count in each bucket as a percentage.
NOTE: For the following options, by default the histogram shows data from the start of the
command.
–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 
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 
Specifies that the histogram is to stop after the indicated number of iterations using an integer from
1 through 2147483647.
–sortcol  [,][:[,]...]
Sorts command output based on column number . Columns are numbered from left to right,
beginning with 0. You must specify a column number. In addition, you can specify the direction
of sorting  as follows:
inc
Sort in increasing order (default).
dec
Sort in decreasing order.
Multiple columns can be specified and separated by a colon (:). Rows that have the same
information in them as earlier columns will be sorted by values in later columns.
–filt 
Specifies that histograms below the threshold specified by the  argument are not displayed.
The  argument is specified in the syntax of ,,.
•


The  argument can be specified as one of the following:

◦

r - Specifies read statistics.

◦

w - Specifies write statistics.

192 Hist Commands

•

◦

t - Specifies total statistics.

◦

rw - Specifies total read and write statistics.


Specifies the threshold service time in milliseconds.

•


Specifies the minimum number of access above the threshold service time. When filtering is
done, the  is compared with the sum of all columns starting with the one which
corresponds to the threshold service time. For example,-t,8,100 specifies that only the rows
where the 8ms column and all columns to the right adds up to more than 100 are to be
displayed.

–ni
Specifies that histograms for only nonidle devices are displayed. This option is shorthand for the
option –filt t,0,0.

SPECIFIERS
None.

RESTRICTIONS
None.

EXAMPLES
The following example displays a histogram of service times for reads and writes to ports:
li% 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).

•

Previous options –n , –s , and –p  have been
replaced with –nodes , –slots , and –ports
.
histport

193

histrcvv
DESCRIPTION
The histrcvv command shows a histogram of total Remote Copy service times and backup
system Remote Copy service times in a timed loop.

SYNTAX
histrcvv [options ][|]...

AUTHORITY
Any role in the system.

OPTIONS
-d 
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified, the command uses a 2-second default interval.
-iter 
Specifies that the statistics are to stop after the indicated number of iterations using an integer from
1 through 2147483647.
-t ...|...
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 ...|...
Show only volumes that are copied over the specified port, expressed as , or pattern of
ports. Multiple ports or patterns may be specified using a comma-separated list.
-g ...|...
Shows only volumes whose volume group matches the specified group name or pattern of names.
Multiple group names or patterns may be specified using a comma-separated list.
-sync
Show only volumes that are being copied in synchronous mode.
-periodic
Show only volumes which are being copied in asynchronous periodic mode.
-primary
Show only virtual volumes in the primary role.
-secondary
Show only virtual volumes in the secondary role.
-targetsum
Displays the sums for all volumes of a target.
-portsum
Displays the sums for all volumes on a port.
-groupsum
Displays the sums for all volumes of a volume group.
-vvsum
Displays the sums for all targets and links of a virtual volume.
-domainsum
194

Hist Commands

Displays the sums for all volumes of a domain.
-domain ...|...
Shows only the virtual volumes that are in domains with names that match the specified domain
name(s) or pattern(s).
-timecols  
For the I/O time histogram, shows the columns from the first column () through the last column
(). The available columns range from 0 through 31.
•

 must be equal to or greater than 0. The default value of  is 6.

•

 must be:

◦

greater than 

◦

less than or equal to 31

The default value of  is 15.
-pct
Shows the number of times the service time appears in each bucket as a percentage. If this option
is not specified, the histogram shows the service times.
-prev
Specifies that the histogram displays data from a previous sample.
–sortcol  [,][:[,]...]
Sorts command output based on column number (). Columns are numbered from left to right,
beginning with 0. You must specify a column number.
In addition, you can specify the direction of sorting ():
•

inc - Sort in increasing order (the default).

•

dec - Sort in decreasing order.

–filt 
Specifies that histograms below the threshold specified by the  argument are not displayed.
To specify the  argument, use the syntax: ,,.
•

 - The argument can be:

•

 - Specifies the threshold service time in milliseconds.

•

 - Specifies the minimum number of times the service time is above the threshold
service time. When filtering is done, the  is compared with the sum of all columns,
starting with the one that corresponds to the threshold service time.

For example, -filt t,8,100 specifies that the display should include only the rows where the
8ms column and each subsequent column to the right adds up to more than 100.
-ni
Displays histograms for all non-idle devices. This option is shorthand for the option -filt t,0,0.

SPECIFIERS
...
Displays statistics only for the specified virtual volume or volume name pattern. Multiple volumes
or patterns can be repeated (for example,  ...). If not specified, all
virtual volumes that are configured for Remote Copy are listed.

histrcvv 195

RESTRICTIONS
None.

EXAMPLES
The following example shows histograms sums for all synchronous Remote Copy volumes:
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
26 11
5

0 0 0 544 465 206 71 25
2

Press the enter key to stop...

NOTES
None.

196

Hist Commands

11

7

0 1183 77 0 6 19

histvlun
DESCRIPTION
The histvlun command displays Virtual Volume Logical Unit Number (VLUN) service time
histograms.

SYNTAX
histvlun [options ]

AUTHORITY
Any role in the system.

OPTIONS
-domain ...|...
Shows only VLUNs whose Virtual Volumes (VVs) 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 comma-separated list.
–host ...|...
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 ...|...
Requests that only LDs mapped to VVs that match and of the specified names or patterns be
displayed. Multiple volume names or patterns can be repeated using a comma-separated list.
–l ...|...
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 
Specifies that only exports from the specified nodes are to be displayed. The node list is specified
as a series of integers separated by commas (1,2,3). The list can also consist of a single integer
(1). If the node list is not specified, all disks on all nodes are displayed.
–slots 
Specifies that only exports from the specified slots are to be displayed. The slot list is specified as
a series of integers separated by commas (1,2,3). The list can also consist of a single integer (1).
If the slot list is not specified, all disks on all slots are displayed.
–ports 
Specifies that only exports to the specified ports are to be displayed. The port list is specified as
a series of integers separated by commas (1,2,3). The list can also consist of a single integer (1).
If the port list is not specified, all disks on all ports are displayed.
–lw
Lists the host’s World Wide Name (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 VV are displayed.
histvlun

197

–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) Displays both I/O time and I/O size histograms.

•

time - Displays only the I/O time histogram.

•

size - Displays only the I/O size histogram.

–timecols  
For the I/O time histogram, show the columns from the first column  through last column
. The available columns range from 0 through 31.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 6).

•

The last column () must be less than or equal to 31 (default value of 15).

•

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.

–sizecols  
For the I/O size histogram, show the columns from the first column () through the last
column (). Available columns range from 0 through 15.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 3).

•

The last column () must be less than or equal to 15 (default value of 11).

-pct
Shows the access count in each bucket as a percentage.
NOTE: For the following options, by default the histogram shows data from the start of the
command.
–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 
Specifies the interval in seconds that statistics are sampled from using an integer from 1 through
2147483. If no count is specified.
–iter 
Specifies that the histogram is to stop after the indicated number of iterations using an integer from
1 through 2147483647.
–sortcol  [,][:[,]...]
Sorts command output based on column number . Columns are numbered from left to right,
beginning with 0. At least one column must be specified. In addition, you can specify the direction
of sorting  as follows:
inc
198 Hist Commands

Sort in increasing order (default).
dec
Sort in decreasing order.
–filt 
Specifies that histograms below the threshold specified by the  argument are not displayed.
The  argument is specified in the syntax of ,,.
•


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


Specifies the threshold service time in milliseconds.

•


Specifies the minimum number of access above the threshold service time. When filtering is
done, the  is compared with the sum of all columns starting with the one which
corresponds to the threshold service time. For example,-t,8,100 specifies that only the rows
where the 8ms column and all columns to the right adds up to more than 100 are to be
displayed.

–ni
Specifies that histograms for only nonidle devices are displayed. This option is shorthand for the
option –filt t,0,0.

SPECIFIERS
None.

RESTRICTIONS
None.

EXAMPLES
The following example displays two iterations of a histogram of service times for all VLUNs:
cli% histvlun –iter 2
12:48:50 10/20/04 ------------Time (millisec)-----------Lun VVname
Host Port 0.26 0.53 1.05 2.1 4.2 8.4 17 34 67 135
0
tpvv queasy09 0:0:2
0
1
20
0
0
0 0 0 0
0
----------------------------------------------------------------total
0
1
20
0
0
0 0 0 0
0
12:48:52 10/20/04 ------------Time (millisec)-----------Lun VVname
Host Port 0.26 0.53 1.05 2.1 4.2 8.4 17 34 67 135
0
tpvv queasy09 0:0:2
0
1
30
0
0
0 0 0 0
0
----------------------------------------------------------------total
0
1
30
0
0
0 0 0 0
0

histvlun 199

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

•

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). Unless all columns are shown, the first column shows the number
of accesses with service times less than the heading of the second column.

•

Previous options –n , –s , and –p  have been
replaced with –nodes , –slots , and –ports
.

200 Hist Commands

histvv
DESCRIPTION
The histvv command displays Virtual Volume (VV) service time histograms in a timed loop.

SYNTAX
histvv [options ] [|]...

AUTHORITY
Any role in the system.

OPTIONS
-domain ...|...
Shows only the VVs 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) Displays both I/O time and I/O size histograms.

•

time - Displays only the I/O time histogram.

•

size - Displays only the I/O size histogram.

–timecols  
For the I/O time histogram, show the columns from the first column  through last column
. The available columns range from 0 through 31.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 6).

•

The last column () must be less than or equal to 31 (default value of 15).

•

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.

–sizecols  
For the I/O size histogram, show the columns from the first column () through the last
column (). Available columns range from 0 through 15.
•

The first column () must be a value greater than or equal to 0, but less than the value
of the last column () (default value of 3).

•

The last column () must be less than or equal to 15 (default value of 11).

-pct
Shows the access count in each bucket as a percentage.
NOTE: For the following options, by default the histogram shows data from the start of the
command.
–prev
Histogram displays data from a previous sample.
–rw
Specifies that the display includes separate read and write data. If not specified, the total is
displayed.
–d 
histvv 201

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 
Specifies that the histogram is to stop after the indicated number of iterations using an integer from
1 through 2147483647.
–sortcol  [,][:[,]...]
Sorts command output based on column number . Columns are numbered from left to right,
beginning with 0. You must specify a column number. In addition, you can specify the direction
of sorting  as follows:
inc
Sort in increasing order (default).
dec
Sort in decreasing order.
–filt 
Specifies that histograms below the threshold specified by the  argument are not displayed.
The  argument is specified in the syntax of ,,.
•


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


Specifies the threshold service time in milliseconds.

•


Specifies the minimum number of access above the threshold service time. When filtering is
done, the  is compared with the sum of all columns starting with the one which
corresponds to the threshold service time. For example,-t,8,100 specifies that only the rows
where the 8ms column and all columns to the right adds up to more than 100 are to be
displayed.

–ni
Specifies that histograms for only nonidle devices are displayed. This option is shorthand for the
option –filt t,0,0.

SPECIFIERS
None.

RESTRICTIONS
None.

202 Hist Commands

EXAMPLES
The following example displays two iterations of a histogram of service times for all VVs:
%cli histvv –iter 2
12:53:03 10/20/04 ------------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/04 ------------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).

•

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). Unless all columns are shown, the first column shows the number
of accesses with service times less than the heading of the second column.

•

If a  or  are specified, then VVs with names that match any of the
patterns are listed, otherwise all VVs are listed. Refer to “Glob-Style Pattern” (page 12) for
further information.

•

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.

•

In addition to external accesses by hosts, VVs can be read internally by the system read-ahead
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 -vvsumcommand
to see data for only accesses from the host.

histvv 203

16 Import Command
importvv
DESCRIPTION
The importvv command initiates the migration of data from a remote LUN to the local HP 3PAR
Storage System. The remote LUN must be prepared for migration by using the admitvv command
before using the importvv command.

SYNTAX
importvv [options]   ...

AUTHORITY
•

Super, Service, 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 
Creates a snapshot of the volume at the end of the import phase. While the data is being imported,
the local volume and the remote volume are kept in sync (i.e., all the data that 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 the volume
on the old array when the import task is completed.
If multiple VVs are being imported in a single command,  should be a VV pattern.
See help sub,vvnamepat for details.
-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 used.
The following options can be used when creating thinly provisioned volumes:
-tpvv
Imports the volume 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.

SPECIFIERS

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.
...
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 is 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.
204 Import Command

RESTRICTIONS
Functionality of this command requires the Peer Motion license. Contact your local service provider
for more information.

EXAMPLES
The following example imports vv1 previously admitted using the admitvv 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*

NOTES
A volume is imported online but the volume can only be accessed using the HP 3PAR storage
system that is importing the volume.
For all the  fields, the patterns are glob-style (shell-style) patterns. Refer to
“Glob-Style Pattern” (page 12) for further information.

importvv 205

17 Locate Commands
locatecage
DESCRIPTION
The locatecage command allows system administrators to locate a drive cage, drive magazine,
or port in the system using the devices’ blinking LEDs.

SYNTAX
The syntax for the locatecage command can be one of the following:
•

To locate an entire drive cage:

locatecage [option ] 
•

To locate a drive magazine:

locatecage [option ]  
•

To locate a port:

locatecage [option ]  

AUTHORITY
•

Super, Service

•

Any role granted the cage_locate right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–t 
Specifies the number of seconds, from 0 through 255 seconds, to blink the LED. If the argument is
not specified, the option defaults to 60 seconds.

SPECIFIERS

Specifies the drive cage name as shown in the Name column of showcage command output.

Indicates the port specifiers. Accepted values are A0|B0|A1|B1|A2|B2|A3|B3. If a port is
specified, the port LED will oscillate between green and off. The  specifier is not
supported for DC3 drive cages.

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.

RESTRICTIONS
•

Access to all domains is required to run this command.

•

The  specifier is not supported for DC3 drive cages.

206 Locate Commands

EXAMPLES
The following example causes the Fibre Channel LEDs on the drive cage cage0 to blink for 20
seconds:
cli% locatecage –t 20 cage0

NOTES
•

Issue the showcage 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).

locatecage 207

locatenode
DESCRIPTION
The locatenode command helps locate a particular node or its components by blinking LEDs on
the node. By default all LEDs on the node will blink.

SYNTAX
locatenode [options] 

AUTHORITY
•

Super, Service

•

Any role granted the node_locate right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
-t 
Specifies the number of seconds, from 0 through 255, to blink the LEDs. If not specified, the option
defaults to 60 seconds.
-ps 
Blinks the hotplug LED for the specified power supply.
-pci 
Blinks the hotplug LED corresponding to the PCI card in the specified slot.
-fan 
Blinks the hotplug LED on the specified node fan module.
-drive
Blinks the hotplug LED corresponding to the node's internal drive.
-bat
Blinks the hotplug LED on the battery backup unit.

SPECIFIERS

Indicates which node the locatenode operation will act on. Accepted values are 0 through 7.

RESTRICTIONS
Access to all domains is required to run this command.

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

208 Locate Commands

locatesys
DESCRIPTION
The locatesys command helps locate a storage system by blinking the node status LEDs on all
nodes of a storage system alternating between amber and green. By default, the LEDs in all
connected cages are also set as amber or oscillating (depending on the cage).

SYNTAX
locatesys [options ]

AUTHORITY
•

Super, Service

•

Any role granted the sys_locate right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–t 
Specifies the number of seconds to blink the LEDs. The default is 60 seconds; the maximum is 255
seconds.
-nodes 
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.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
In the following example, an HP 3PAR Storage System is identified by blinking the LEDs on all
drive cages in the system for 90 seconds.
cli% locatesys -t 90

NOTES
None.

locatesys 209

18 Move Commands
movech
DESCRIPTION
The movech command moves a list of chunklets from one physical disk to another.

SYNTAX
movech [options] ...

AUTHORITY
•

Super, Service, Edit

•

Any role granted the ch_move right.

NOTE:

You need access to all domains in order to run this command.

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.
–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
[<–td:tp>]...
Specifies that the chunklet located at the specified PD () and the chunklet’s position on that
disk () be moved to either the specified destination disk () and chunklet position (),
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.

RESTRICTIONS
Access to all domains is required to run this command.
210

Move Commands

EXAMPLES
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 columns in the previous example are identified as follows:
•

Status. The overall status of the move.

•

normal. Indicates the chunklet has successfully moved with no loss of quality.

•

degraded. Indicates the chunklet has successfully moved with loss of quality.

•

failed. Indicates the chunklet was not moved.

•

Detailed_State. Provides additional details of the move with General Information, Error
Information, or Degraded Information.

General Information:
•

dest_unknown. Destination is unknown.

•

dest_unknown. Destination is known.

•

valid_move. Source and Destination are valid.

•

ch_moved. Chunklet was moved.

•

ch_move_pending. Chunklet move is pending due to -nowait option.

•

move_error. Error moving chunklet.

Error Information:
•

error_type_unknown. An unknown error occurred.

•

spares_not_found. No suitable spares available.

•

duplicate_src. Duplicate source input.

•

duplicate_dest. Duplicate destination in chunklet list.

•

src_relocating. Source is relocating.

•

ch_synching. Chunklet is synchronizing.

•

src_no_ld. Source not associated with an LD.

•

src_ld_invalid. Source associated with invalid LD.

•

src_set_invalid. Source is in invalid set.

•

src_not_found. Source chunklet does not exist.

•

invalid_dest. Destination is invalid.

•

move_failed. Chunklet move failed.

•

disk_relocating. Disk is relocating.

Degraded Information:
•

disks_reused_in_row. Disks reused in row.

•

connection_degraded. Connection is degraded.
movech

211

•

remote_pds_used. Remote PDs used.

•

ldpattern_not_obeyed. LD pattern was not obeyed.

•

raid_availability_reduced. RAID availability reduced.

NOTES

212

•

Chunklets moved through the movech command are only moved temporarily. Issuing either
the moverelocpd or servicemag resume command can move the chunklet back to its
original position.

•

Specifying the –dr option can be used to see if the specified moves succeed and what the
results (quality) of the moves are.

Move Commands

movechtospare
DESCRIPTION
The movechtospare command moves data from specified Physical Disks (PDs) to a temporary
location selected by the system.

SYNTAX
movechtospare [options] 

AUTHORITY
•

Super, Service, Edit

•

Any role granted the ch_movetospare right.

NOTE:

You need access to all domains in order to run this command.

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.
–f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.

SPECIFIERS

Indicates that the move takes place from the specified PD () and chunklet position ().

RESTRICTIONS
Access to all domains is required to run this command.

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
-Status- -Detailed_State-66:0-54:49 normal
ch_moved,normal

The columns in the previous example are identified as follows:
•

Status. The overall status of the move.

•

normal. Indicates the chunklet has successfully moved with no loss of quality.

•

degraded. Indicates the chunklet has successfully moved with loss of quality.
movechtospare

213

•

failed. Indicates the chunklet was not moved.

•

Detailed_State. Provides additional details of the move with General Information, Error
Information, or Degraded Information.

General Information:
•

dest_unknown. Destination is unknown.

•

dest_unknown. Destination is known.

•

valid_move. Source and Destination are valid.

•

ch_moved. Chunklet was moved.

•

ch_move_pending. Chunklet move is pending due to -nowait option.

•

move_error. Error moving chunklet.

Error Information:
•

error_type_unknown. An unknown error occurred.

•

spares_not_found. No suitable spares available.

•

duplicate_src. Duplicate source input.

•

duplicate_dest. Duplicate destination in chunklet list.

•

src_relocating. Source is relocating.

•

ch_synching. Chunklet is synchronizing.

•

src_no_ld. Source not associated with an LD.

•

src_ld_invalid. Source associated with invalid LD.

•

src_set_invalid. Source is in invalid set.

•

src_not_found. Source chunklet does not exist.

•

invalid_dest. Destination is invalid.

•

move_failed. Chunklet move failed.

•

disk_relocating. Disk is relocating.

Degraded Information:
•

disks_reused_in_row. Disks reused in row.

•

connection_degraded. Disks reused in row.

•

remote_pds_used. Connection Degraded.

•

ldpattern_not_obeyed. LD pattern was not obeyed.

•

raid_availability_reduced. RAID availability reduced.

NOTES
None.

214

Move Commands

movepd
DESCRIPTION
The movepd command moves data from specified Physical Disks (PDs) to a temporary location
selected by the system.

SYNTAX
movepd [options] ...

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.
-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
...
Specifies the physical disk ID. This specifier can be repeated to move multiple physical disks.

RESTRICTIONS
Access to all domains is required to run this command.

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

movepd

215

NOTES

216

•

The destination physical disks do not need to be specified; 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.

Move Commands

movepdtospare
DESCRIPTION
The movepdtospare command moves data from specified Physical Disks (PDs) to a temporary
location selected by the system.

SYNTAX
movepdtospare [options] ...

AUTHORITY
•

Super, Service, Edit

•

Any role granted the pd_movetospare right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–nowait
Specifies that the command returns before the operation is completed.
-dr
Specifies that the operation is a dry run. No PDs are actually moved.
–devtype
Permits the moves to happen to different device types.
-vacate
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
...
Specifies the PD ID. This specifier can be repeated to move multiple PDs.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example displays a dry run of moving the data on PD 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
-Status- -Detailed_State-0:0-92:49 normal
valid_move,normal
0:1-62:50 normal
valid_move,normal
0:2-42:51 normal
valid_move,normal
0:3-88:52 normal
valid_move,normal
0:4-62:53 normal
valid_move,normal
0:5-90:55 normal
valid_move,normal
0:6-88:55 normal
valid_move,normal

movepdtospare

217

The columns in the previous example are identified as follows:
•

Status. The overall status of the move.

•

normal. Indicates the chunklet has successfully moved with no loss of quality.

•

degraded. Indicates the chunklet has successfully moved with loss of quality.

•

failed. Indicates the chunklet was not moved.

•

Detailed_State. Provides additional details of the move with General Information, Error
Information, or Degraded Information.

General Information:
•

dest_unknown. Destination is unknown.

•

dest_unknown. Destination is known.

•

valid_move. Source and Destination are valid.

•

ch_moved. Chunklet was moved.

•

ch_move_pending. Chunklet move is pending due to -nowait option.

•

move_error. Error moving chunklet.

Error Information:
•

error_type_unknown. An unknown error occurred.

•

spares_not_found. No suitable spares available.

•

duplicate_src. Duplicate source input.

•

duplicate_dest. Duplicate destination in chunklet list.

•

src_relocating. Source is relocating.

•

ch_synching. Chunklet is synchronizing.

•

src_no_ld. Source not associated with an LD.

•

src_ld_invalid. Source associated with invalid LD.

•

src_set_invalid. Source is in invalid set.

•

src_not_found. Source chunklet does not exist.

•

invalid_dest. Destination is invalid.

•

move_failed. Chunklet move failed.

•

disk_relocating. Disk is relocating.

Degraded Information:
•

disks_reused_in_row. Disks reused in row.

•

connection_degraded. Disks reused in row.

•

remote_pds_used. Connection Degraded.

•

ldpattern_not_obeyed. LD pattern was not obeyed.

•

raid_availability_reduced. RAID availability reduced.

NOTES

218

•

The destination PDs 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 succeeds and the results
(quality) of the moves.

Move Commands

moverelocpd
DESCRIPTION
The moverelocpd command moves chunklets that were on a physical disk to the target of
relocation.

SYNTAX
moverelocpd [options] [[–...]

AUTHORITY
•

Super, Service

•

Any role granted the pd_movereloc right.

NOTE:

You need access to all domains in order to run this command.

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 
Specifies a pattern to select  disks. The  specifier cannot be used with this -p option.
If no  are specified, then all disks that match the pattern are selected as the  disks. If
 disks are specified along with -p then only disks that match the pattern are selected as 
disk. The following arguments can be specified as patterns for this option:
-nd 
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 
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 
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 
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). Disks must reside in the specified drive cage(s).
moverelocpd

219

-mg 
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 -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). Disks
must reside in the specified drive magazine(s).
-pn 
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). Disks must reside in the specified
position(s).
-dk 
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 
Specifies that physical disks with total chunklets greater than the number specified are selected.
-tc_lt 
Specifies that physical disks with total chunklets less than the number specified are selected.
-fc_gt 
Specifies that physical disks with free chunklets greater than the number specified are selected.
-fc_lt 
Specifies that physical disks with free chunklets less than the number specified are selected.
-devid 
Specifies that physical disks identified by their models are selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the showpd -i command.
-devtype 
Specifies that physical disks must have the specified device type (FC for Fibre Channel, NL for
nearline, or SSD for solid state drive) to be used. Device types can be displayed by issuing the
showpd command.
-rpm 
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.

SPECIFIERS
[–]...
Specifies that the chunklets that were relocated from specified disk (), are moved to the
specified destination disk (). If destination disk () is not specified then the chunklets are
moved back to original disk (). The  specifier is not needed if -p option is used, otherwise
220 Move Commands

it must be used at least once on the command line. If this specifier is repeated then the operation
is performed on multiple disks.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example moves chunklets that were on PD 8 that were relocated to another position,
back to PD 8:
cli% moverelocpd 8
Are you sure you want to move the chunklets ?
select q=quit y=yes n=no: y
Move
-Status- -Detailed_State42:51-8:2 normal
normal
62:50-8:1 normal
normal
62:53-8:4 normal
normal
62:57-8:7 normal
normal
64:49-8:0 normal
normal
88:52-8:3 normal
normal
88:55-8:6 normal
normal
90:55-8:5 normal
normal

The columns in the previous example are identified as follows:
•

Status. The overall status of the move.

•

normal. Indicates the chunklet has successfully moved with no loss of quality.

•

degraded. Indicates the chunklet has successfully moved with loss of quality.

•

failed. Indicates the chunklet was not moved.

•

Detailed_State. Provides additional details of the move with General Information, Error
Information, or Degraded Information.

General Information:
•

dest_unknown. Destination is unknown.

•

dest_unknown. Destination is known.

•

valid_move. Source and Destination are valid.

•

ch_moved. Chunklet was moved.

•

ch_move_pending. Chunklet move is pending due to -nowait option.

•

move_error. Error moving chunklet.

Error Information:
•

error_type_unknown. An unknown error occurred.

•

spares_not_found. No suitable spares available.

•

duplicate_src. Duplicate source input.

•

duplicate_dest. Duplicate destination in chunklet list.

•

src_relocating. Source is relocating.

•

ch_synching. Chunklet is synchronizing.

•

src_no_ld. Source not associated with an LD.

•

src_ld_invalid. Source associated with invalid LD.
moverelocpd 221

•

src_set_invalid. Source is in invalid set.

•

src_not_found. Source chunklet does not exist.

•

invalid_dest. Destination is invalid.

•

move_failed. Chunklet move failed.

•

disk_relocating. Disk is relocating.

Degraded Information:
•

disks_reused_in_row. Disks reused in row.

•

connection_degraded. Disks reused in row.

•

remote_pds_used. Connection Degraded.

•

ldpattern_not_obeyed. LD pattern was not obeyed.

•

raid_availability_reduced. RAID availability reduced.

NOTES
•

Chunklets moved from physical disks 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 succeeds 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.

222 Move Commands

movetodomain
DESCRIPTION
The movetodomain command moves objects from one domain to another.

SYNTAX
movetodomain [options]  

AUTHORITY
•

Super, Edit

•

Any role granted the domain_moveto right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–vv
Specifies that the object is a virtual volume.
-cpg
Specifies that the object is a 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

Specifies the name of the object to be moved.

Specifies the domain or domain set to which the specified object is moved. The domain set name
must start with set:. To remove the domain from an object from any domain, specify the string
-unset for the  or  specifier.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example displays the movement of VV 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:
thehost
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
movetodomain 223

The following example displays the removal of the host testhost from any domain:
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
•

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, Virtual Volume Logical Unit Numbers (VLUNs) between hosts and VVs, VVs using a CPG
for snapshot space, and two VVs sharing the same logical disk. 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 otherwise 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.

224 Move Commands

19 Promote Commands
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] 

AUTHORITY
•

Super, Edit

•

Any role granted the sv_promote right.

OPTIONS
-target
Copy the differences of the virtual copy to the specified RW parent in the same VV family tree.
The default is to copy the differences to the base volume. This option cannot be used with the
-halt option.
–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
Cancels an ongoing snapshot promotion. Marks the RW parent volume with the cpf status, which
can be cleaned up using the promotevvcopy (see “promotevvcopy” (page 227)) command or by
issuing a new instance of the promotesv command. This option cannot be used in conjunction
with any other option.
-pri 
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 a 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 can not be used with -halt option.

SPECIFIERS

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 virtual volume set name must start with set:.

RESTRICTIONS
•

The virtual copy and its base volume must not be exported.

•

Only one promote operation is allowed at a time within a VV family tree.

promotesv 225

EXAMPLES
The following example illustrates how virtual volume vv1 can be promoted with the differences
from its base volume:
cli% promotesv vv1

NOTES
•

Issue the showvv 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.

•

The RW virtual copy and the target of the promote must not be exported.

•

Only one promote operation is allowed at a time within a virtual volume family tree.

226 Promote Commands

promotevvcopy
DESCRIPTION
The promotevvcopy command promotes a physical copy back to a regular base volume.

SYNTAX
promotevvcopy 

AUTHORITY
•

Super, Edit

•

Any role granted the vvcopy_promote right.

OPTIONS
None.

SPECIFIERS

Specifies the name of the physical copy to be promoted, using up to 31 characters.

RESTRICTIONS
The physical copy must have completed the copy from the base volume.

EXAMPLES
The following example promotes virtual volume 85 to a base volume:
cli% promotevvcopy 85

NOTES
•

The saved snapshot of the parent of  is also removed.

•

The promotevvcopy command can also be used to clean up a failed physical copy.

•

Issue the showvv 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 227

20 Remove Commands
removealert
DESCRIPTION
The removealert command removes one or more alerts from the system.
CAUTION: Use care when removing alerts. Alerts that have not been fixed or acknowledged
should not be removed.

SYNTAX
removealert [option] –a|...

AUTHORITY
•

Super, Service

•

Any role granted the alert_remove right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–a
Specifies all alerts from the system and prompts removal for each alert. If this option is not used,
then the  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 its operation.

SPECIFIERS
...
Indicates a specific alert 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.

RESTRICTIONS
Access to all domains is required to run this command.

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 2005
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".
228 Remove Commands

Are you sure you want to remove it?
select q=quit y=yes n=no: y
Id 131 – New
Message code: 1114115
Thu May 05 00:11:25 PDT 2005
Node: 0 Severity: Minor
Too many events are being logged
Too many events are being generated. 2 event files were rolled over in less
than 1800 seconds. Current event files could not be archived because too many
have been archived already.
Alert 131 is marked as "New".
Are you sure you want to remove it?
select q=quit y=yes n=no: y
Id 133 – New
Message code: 1966081
Thu May 05 00:25:27 PDT 2005
Node: 0 Severity: Degraded
Cage log event
cage2–A, loop 1:0:2, cage time Thu May 5 00:25:29 2005. Fan at position 1 is
running at high speed. Internal parameters: 0x0003 0x0109 01 01 00 00 00 00 00
00 00 00 00 00.
Alert 133 is marked as "New".
Are you sure you want to remove it?
select q=quit y=yes n=no:

NOTES
Use care when removing alerts. Alerts that have not been fixed or acknowledged should NOT be
removed.

removealert 229

removeaocfg
DESCRIPTION
The removeaocfg command removes specified Adaptive Optimization configurations from the
system.

AUTHORITY
Super, Edit

SYNTAX
removeaocfg [options] {|}...

OPTIONS
-pat 
Indicates 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

Specifies the name of the AO configuration to be removed.

Specifies a glob-style pattern. This specifier can be repeated to remove multiple AO configurations.
If this specifier is not used, the  specifier must be used. Refer to “Glob-Style Pattern”
(page 12) for further information.

NOTES
None.

EXAMPLES
The following example removes AO configurations that start with test.
cli% removeaocfg -f -pat test*

230 Remove Commands

removecpg
DESCRIPTION
The removecpg command removes Common Provisioning Groups (CPGs) from the system or
removes specific Logical Disks (LDs) from CPGs.

AUTHORITY
•

Super, Edit

•

Any role granted the cpg_remove right.

NOTE:

You need access to all domains in order to run this command.

SYNTAX
removecpg [options ] {|}...

OPTIONS
–f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.
–ld
Specifies that after the CPG is removed, all LDs that were part of the CPG are also removed. This
is the default behavior.
–sa 
Specifies that the LD, as identified with the  argument, used for snapshot administration
space allocation is removed. The  argument can be repeated to specify multiple LDs.
This option is deprecated and will be removed in a subsequent release.
–sd 
Specifies that the LD, as identified with the  argument, used for snapshot data space
allocation is removed. The  argument can be repeated to specify multiple LDs. 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

Specifies the name of the CPG that is either being removed or losing LDs.

Specifies a glob-style pattern. This specifier can be repeated to remove multiple common provisioning
groups. If this specifier is not used, the  specifier must be used. See “Glob-Style
Pattern” (page 12) for more information.

removecpg

231

RESTRICTIONS
•

Access to all domains is required to run this command.

•

The removecpg command fails if any of the LDs, or the entire CPG, is in use by a Thinly
Provisioned Virtual Volume (TPVV).

EXAMPLES
The following example displays the removal of CPG cpg1:
cli% removecpg cpg1

NOTES
•

By default, this command deletes any unused LDs. This is equivalent to using the –ld option.
The –ld option still exists for backward compatibility.

•

If neither the –sa or –sd options are specified, the entire CPG is removed, including all LDs.

•

The operation fails if any of the LDs are in use.

232 Remove Commands

removedomain
DESCRIPTION
The removedomain command removes an existing domain from the system.

SYNTAX
removedomain [option] 

AUTHORITY
•

Super

•

Any role granted the domain_remove right.

Super
NOTE:

You need access to all domains in order to run this command.

OPTIONS
–f
When using this option, the command does not ask for confirmation before removing the domain.

SPECIFIERS

Specifies the domain that is removed.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example removes the domain named sample_domain from the system:
cli% removedomain –f sample_domain

NOTES
None.

removedomain 233

removedomainset
DESCRIPTION
The removedomainset command removes a domain set or removes domains from an existing
set.

SYNTAX
removedomainset [options]  [...]

AUTHORITY
•

Super, Edit

•

Any role granted the domainset_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

Specifies the name of the domain set.
...
Optional list of domain names that are members of the set. If no  is specified, the domain
set is removed, otherwise the specified  is removed from the domain set.

RESTRICTIONS
None.

EXAMPLES
To remove a domain set:
cli% removedomainset domainset

To remove a single domain from a set:
cli% removedomainset domainset domain1

NOTES
None.

234 Remove Commands

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]  [...|...]

AUTHORITY
•

Super, Edit

•

Any role granted the host_remove right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–rvl
Remove World Wide Name(s) (WWN(s)) or iSCSI names even if there are Virtual Volume Logical
Unit Numbers (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.

SPECIFIERS

Specifies the host name, using up to 31 characters.

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.

Specifies the host iSCSI name to be removed from the specified host. If no ISCSI name is specified,
the entire host definition is removed.

RESTRICTIONS
•

Access to all domains is required to run this command.

•

A host that has one or more VLUNs exported on it cannot be removed.

EXAMPLES
The following example removes host test01:
cli% removehost test01

removehost 235

NOTES
•

Removing an entire host definition by issuing the removehost  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 command.

236 Remove Commands

removehostset
DESCRIPTION
The removehostset command removes a host set or removes hosts from an existing set.

SYNTAX
removehostset [options]  [...]

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.

SPECIFIERS

Name of the host set to remove.
...
Optional list of host names that are members of the set. If no  is specified, the host set is
removed, otherwise the specified  is removed from the host set.

RESTRICTIONS
None.

EXAMPLES
To remove a host set:
cli% removehostset hostset

To remove a single host from a set:
cli% removehostset hostset host1

NOTES
None.

removehostset 237

removeld
DESCRIPTION
The removeld command removes a specified Logical Disk (LD) from the system service group.

SYNTAX
removeld [options] {|}...

AUTHORITY
•

Super, Service, Edit

•

Any role granted the ld_remove right.

OPTIONS
–pat
Specified patterns are treated as glob-style patterns and 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. See
the HP 3PAR StoreServ Storage Concepts Guide for information on logging logical disks and
preserved data logical disks.
CAUTION: System resource logical disks are required for correct operation of the HP 3PAR
storage system. Removal of system resource logical disks should be performed by qualified service
personnel. Incorrect use of the –rmsys option can result in data loss.
-unused
Specifies the command to remove non-system logical disks. This option cannot be used with the
-rmsys option.

SPECIFIERS

Specifies the LD name, using up to 31 characters. Multiple LDs can be specified.

Specifies a glob-style pattern. Multiple LDs can be specified. If this specifier is not used, the
 specifier must be used. See “Glob-Style Pattern” (page 12) for more information.

RESTRICTIONS
•

System resource LDs are required for correct operation of the HP 3PAR 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
logical disk.

238 Remove Commands

•

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, movech2spare, movepd2spare,
or moverelocpd operation is being executed. Issue the showldch command to view
operations currently running on the system. See “showldch” (page 400) for additional
information.

EXAMPLES
The following example removes logical disk nf_vv_1.0.usr.1:
cli% removeld -f nf_vv_1.0.usr.1

NOTES
Verify the removal of LDs by issuing the showld command. See “showld” (page 394) for additional
information.

removeld 239

removercopygroup
DESCRIPTION
The removercopygroup command removes a Remote Copy volume group or multiple Remote
Copy groups that match a given pattern.

SYNTAX
removercopygroup [options]  | ...

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, a confirmation is
requested even if -f 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
Specifies that specified patterns are treated as glob-style patterns and that 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 
specifier is used.

SPECIFIERS

The name of the group to be removed.

Specifies a glob-style pattern. This specifier can be repeated to remove multiple groups. If the
 specifier is not used, the  specifier must be used.
CAUTION:
command.

Ensure that the correct group to be removed has been selected before executing this

RESTRICTIONS
•

This command requires the HP 3PAR Remote Copy Software license. Contact local service
provider for further 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 command.

•

You need access to the domain of the specified group () in order to run this
command.

240 Remove Commands

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
•

If the mirror_config policy is set for this group’s target system and the group is a primary
group, then 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, then this
command will fail.

•

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.

•

The -keepsnap and -removevv options are mutually exclusive.

removercopygroup

241

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] 

AUTHORITY
•

Super, Edit

•

Any role granted the rcopytarget_remove right.

NOTE:

You need access to all domains in order to run this command.

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 this can be issued.
-f
Do not ask for confirmation when -cleargroups is specified.

SPECIFIERS

The target name for the target definition to be removed.

RESTRICTIONS
•

This command requires the HP 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.

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

242 Remove Commands

removesched
DESCRIPTION
The removesched command removes a scheduled task from the system.

SYNTAX
removesched [options] 

AUTHORITY
•

Super, Service, Edit

•

Any role granted the sched_remove right.

OPTIONS
-pat
Specifies that certain patterns are treated as glob-style patterns and that all scheduled tasks 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

Specifies the schedule that is removed. Can be at most 31 characters in length.

Specifies a glob-style pattern. This specifier can be repeated to remove multiple scheduled tasks.
If this specifier is not used, the  specifier must be used. The  can be
up to 31 characters in length.

RESTRICTIONS
None.

EXAMPLES
None.

NOTES
None.

removesched 243

removesnmpmgr
DESCRIPTION
The removesnmpmgr command removes preregistered SNMP managers from receiving alerts
(traps).
WARNING! SNMP cannot be used in Common Criteria mode. It might compromise the security
of the storage system.

SYNTAX
removesnmpmgr [option ] 

AUTHORITY
•

Super

•

Any role granted the snmpmgr_remove right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–p 
Specifies the port number where the manager receives traps. If not specified, the port number
defaults to 162.

SPECIFIERS

Specifies the IPv4 or IPv6 address of the host where the manager runs. IPv6 address is in
hexadecimal, 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

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example displays the removal of a manager with the IPv4 address 123.45.67.89
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
5def:2008:abcd::161a from the list of registered managers:
cli% removesnmpmgr 5def:2008:abcd::161a

244 Remove Commands

EXIT STATUS
The following codes are returned indicating success or failure:
•

0 indicates that the trap manager host was removed and the command was successful.

•

1 indicates that the command failed.

•

2 indicates that the host is not on the list of registered hosts.

NOTES
•

SNMP managers are registered by issuing the addsnmpmgr command. See “addsnmpmgr”
(page 42) for additional information.

•

Verify the removal of SNMP managers by issuing the showsnmpmgr command. See
“showsnmpmgr” (page 473) for more information.

removesnmpmgr 245

removesnmppw
DESCRIPTION
The removesnmppw command allows a user to remove SNMP access community string passwords.
WARNING! SNMP cannot be used in Common Criteria mode. It might compromise the security
of the storage system.

SYNTAX
removesnmppw [options]

AUTHORITY
•

Super

•

Any role granted the snmppw_remove right.

NOTE:

You need access to all domains in order to run this command.

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.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example displays the removal of the read/write SNMP access password:
cli% removesnmppw -f

EXIT STATUS
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 a password does not exist.

NOTES
•

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 command. See
“showsnmppw” (page 474) for additional information.

246 Remove Commands

removesnmpuser
DESCRIPTION
The removesnmpuser command allows a user to remove an SNMPv3 user.
WARNING! SNMP cannot be used in Common Criteria mode. It might compromise the security
of the storage system.

SYNTAX
removesnmpuser [options] 

AUTHORITY
•

Super, Service, Edit, Browse

•

Any role granted the snmpuser_remove right.

OPTIONS
–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 an SNMP user:
cli% removesnmpuser -f joe

EXIT STATUS
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 a password does not exist.

NOTES
After a user has been removed, an SNMPv3 manager can no longer use that username to send
requests to the SNMP agent. An SNMP user will also be removed if the removeuser command
has been issued on that user.
Verify the removal of SNMP users by issuing the showsnmpuser command.

removesnmpuser 247

removespare
DESCRIPTION
The removespare command removes chunklets from the spare chunklet list.

SYNTAX
removespare [options] ...

AUTHORITY
•

Super, Service

•

Any role granted the spare_remove right.

NOTE:

You need access to all domains in order to run this command.

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
...
The chunklet specifier can be issued in the following formats:
...
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.
:a...
Specifies the identification of the physical disk (PD_ID) and all (a) chunklets on the disk. This
specifier can be repeated.
a:...
Specifies the chunklet number on all physical disks. This specifier can be repeated.
a:a
Removes all spare chunklets that are not currently used.
–pos 
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 
Specifies that all chunklets on a physical disk, identified by drive cage number, drive magazine
number, and disk number, are marked to be removed.

RESTRICTIONS
Access to all domains is required to run this command.

248 Remove Commands

EXAMPLES
The following example removes a spare chunklet from position 3 on physical disk 1:
cli% removespare 1:3

NOTES
•

Verify the removal of spare chunklets by issuing the showspare command. See “showspare”
(page 479) for more information.

•

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.

removespare 249

removesshkey
DESCRIPTION
The removesshkey command removes your Secure Shell (SSH) public key to disable key
authentication.

SYNTAX
removesshkey [... ]

AUTHORITY
•

Super, Service, Edit, Browse

•

Any role granted the sshkey_remove right.

OPTIONS
None.

SPECIFIERS
...
Specifies the name of the user whose SSH key is removed. If not specified, the SSH key for the
current user is removed.

RESTRICTIONS
Only Super level users are allowed to remove other users’ keys.
None.

EXAMPLES
The following example displays the removal of your SSH public key:
cli% removesshkey

NOTES
•

After removing the user's SSH public key on the HP 3PAR Storage System, the user cannot
use the SSH key authentication to log in. The user must use name and password to log in.

•

The showuser -k command can be used to display users that have SSH keys.

250 Remove Commands

removetask
DESCRIPTION
The removetask command removes information about one or more completed tasks and their
details.

SYNTAX
The syntax of the removetask command can be one of the following:
•

removetask [options ] –a

•

removetask [options ] –t 

•

removetask [options ] ...

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 
Removes tasks that have not been active within the past , where  is an integer
from 1 through 240.

SPECIFIERS
...
Allows you to specify tasks to be removed using their task IDs.

RESTRICTIONS
None.

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

removetask

251

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 HP 3PAR StoreServ Storage Concepts Guide and HP 3PAR Command Line Interface
Administrator’s Manual 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 9999. The
system stores information for the most recent 1000 tasks.

252 Remove Commands

removetemplate
DESCRIPTION
The removetemplate command removes one or more Virtual Volume (VV), Logical Disk (LD),
and Common Provisioning Group (CPG) templates.

SYNTAX
removetemplate [options]{|}...

AUTHORITY
•

Super

•

Any role granted the template_remove right.

NOTE:

You need access to all domains in order to run this command.

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

Specifies the name of the template to be deleted, using up to 31 characters. This specifier can be
repeated to remove multiple templates.

Specifies a glob-style pattern. This specifier can be repeated to remove multiple templates. If this
specifier is not used, the  specifier must be used. See “Glob-Style Pattern”
(page 12) for more information

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example displays the forced removal of template vv1:
cli% removetemplate -f vv1

NOTES
None.

removetemplate 253

removeuser
DESCRIPTION
The removeuser command removes a user account from the system.

SYNTAX
removeuser [option] ...

AUTHORITY
•

Super

•

Any role granted the user_remove right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.

SPECIFIERS
...
Specifies a login name using any combination of letters and numbers. This argument can be
repeated to specify multiple user names.

RESTRICTIONS
•

Access to all domains is required to use this command.

•

Do not remove users 3parsvc and 3paradm.

•

A user cannot remove oneself. The last user on the system cannot be removed.

EXAMPLES
The following example displays the forced removal of user1 from the system:
cli% removeuser –f user1
User removed.

NOTES
•

Verify the removal of users by issuing the showuser command. See “showuser” (page 497)
for additional information.

•

The removeuser command does not affect currently connected users. If an attempt is made
to remove a user that is currently connected, an error message will be returned.

254 Remove Commands

removeuserconn
DESCRIPTION
The removeuserconn command removes user connections to the current system.

AUTHORITY
•

Super

•

Any role granted the userconn_remove right.

NOTE:

You need access to all domains in order to run this command.

SYNTAX
removeuserconn [options]   

OPTIONS
–pat
Specifies that the , , and  specifiers are treated as
glob-style (shell-style) 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

Specifies the ID of the user to be removed.

Specifies the name of the user to be removed.

Specifies the IP address of the user to be removed.

RESTRICTIONS
Access to all domains is required to run this command.

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
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.
removeuserconn 255

removevlun
DESCRIPTION
The removevlun command removes a Virtual Volume’s (VVs) SCSI Logical Unit Number (LUN)
export definition from the system.

SYNTAX
The syntax for the removevlun command can be one of the following:
•

removevlun [options]   

•

removevlun [options]   

•

removevlun [options]    

•

removevlun [options]    

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 Inititalization
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 , ,< N:S:P>, and  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
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.

SPECIFIERS

Specifies the volume or volume set name, using up to 31 characters in length. The volume set name
must start with set:.

Specifies the LUN ID to remove.

Specifies that exports to the specified port are removed. If this specifier is not used, the host_name
specifier must be used.
node
Specifies the system port where node is a number from 0 through 7.
256 Remove Commands

slot
Specifies the PCI bus slot in the node where slot is a number from 0 through 5.
port
Specifies the FCS port number of the card in PCI bus slot using 1 through 4.

Specifier requests that exports to the specified host or host set, named using up to 31 characters
in length, be removed. The host set name must start with set:. If this specifier is not used, the
N:S:P specifier must be used.

RESTRICTIONS
•

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.

•

Issuing the removevlun command with the –pat option specified returns a request for
confirmation to remove VLUNs, unless the –f option is specified.

EXAMPLES
The following example deletes VLUNs for volume vv0, LUN 0, host host1:
cli% removevlun –f vv0 0 host1

NOTES
•

If the VLUN to be removed is a matched set, use the port and host_name specifiers.

•

Verify the removal of VLUNs by issuing the showvlun command. See “showvlun” (page 503)
for more information.

removevlun 257

removevv
DESCRIPTION
The removevv command removes Virtual Volumes (VVs) from the system.

SYNTAX
The syntax of the removevv command can be as follows:
•

removevv [options] |...

•

removevv -expired [options] [VV_name>|...]

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.
–expired
Remove specified expired volumes. This option cannot be used with the -stale option.
–snaponly
Remove the snapshot copies only.
–cascade
Remove all the 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 the -expired option is specified, all expired volumes and their descendent volumes will
be removed regardless if they are expired or not. If the -stale option 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

258 Remove Commands

Specifies the VV name, using up to 31 characters in length. This specifier can be repeated to
remove multiple VVs. If this specifier is not used, the pattern specifier must be used.

Specifies a glob-style pattern. This specifier can be repeated to remove multiple VVs. If this specifier
is not used, the  specifier must be used. See “Glob-Style Pattern” (page 12) for more
information.

RESTRICTIONS
•

Issuing the removevv command with invalid VV names causes the command to exit without
removing any VVs.

•

Any VVs exported as Virtual Volume Logical Unit Numbers (VLUNs) are not removed and the
command stops at that VV.

•

Any VV that contains snapshots cannot be removed.

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:
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
•

By default, this command deletes any unused LDs that are not also part of a CPG. This is
equivalent to using the –ld option. The –ld option still exists for backward compatibility.

•

A newly created LD is guaranteed to be clean. Chunklets of LDs that are removed are cleaned
before they are reused. However regions of an LD that were previously used (for example by
another VV) can contain data from its previous use. If these regions of the LD are mapped to
your user space of a VV, that data can be visible to the host to which the VV is exported.

If this is a concern, remove LDs when the VV is removed and use only newly created LDs for your
user space. Previous data in LDs used for snapshot data space or snapshot admin space is not
visible to you because these spaces are only visible after being written with new data.
•

Verify the removal of VVs by issuing the showvv command. See “showvv” (page 506) for
additional information.

removevv 259

removevvset
DESCRIPTION
The removevvset command removes a VV set or removes VVs from an existing set.

SYNTAX
removevvset [options]  [...]

AUTHORITY
•

Super, Edit

•

Any role granted the vvset_remove 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.

SPECIFIERS

Specifies the name of the VV set to remove.
...
Optional list of VV names that are members of the set. If no  is specified, the VV set is removed,
otherwise the specified  is removed from the VV set.

RESTRICTIONS
None.

EXAMPLES
To remove a VV set:
cli% removevvset vvset

To remove a single VV from a set:
cli% removevvset vvset vv1

NOTES
None.

260 Remove Commands

21 Service Commands
servicecage
DESCRIPTION
The servicecage command is necessary when executing removal and replacement actions for
a drive cage FC-AL 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
The syntax for the servicecage command can be one of the following:
•

servicecage remove [-f] 

•

servicecage startfc|unstartfc|endfc|resetfc|hresetfc|clearlog [-f]
[-ovrd] [a|b]|[0|1] 

AUTHORITY
•

Super, Service

•

Any role granted the cage_service right.

NOTE:

You need access to all domains in order to run this command.

Can vary for each subcommand as noted in the following section.

SUBCOMMANDS
startfc
Prepare an FC-AL module for removal.
unstartfc
Stop the startfc subcommand. See “NOTES” for additional information about the unstartfc
subcommand.
endfc
Indicates that service on the drive cage is completed and allows the system to resume use of the
FC-AL module. Both startfc and unstartfc need this action to complete the service operation.
See “NOTES” for additional information about the endfc subcommand. Permitted for Edit user
in addition to Super and Service users.
resetfc
•

For DC1 and DC3 drive cages, soft resets the FC-AL module.

•

For DC2 and DC4 drive cages, resets the cage. FC-AL specifier is ignored.

hresetfc
•

For DC1 and DC3 drive cages, hard reset the FC-AL module.

•

For DC2 and DC4 drive cages, hard reset the cage. FC-AL specifier is ignored.

remove
Removes the indicated drive cage (indicated with the  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. Only permitted for a Super user.

servicecage

261

clearlog
•

For DC2 and DC4 drive cages, clear the log in the cage. FC-AL specifier is ignored.

•

For DC3 drive cages, clearlog is not supported.

OPTIONS
–f
Forces the operation. When this option is not used, the command requires confirmation before
proceeding.
–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 or DC3 drive cage to be serviced.
0|1
Specifies the side of the specified DC2 or DC4 drive cage to be serviced.

Specifies the name of the drive cage to be serviced.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example displays the commencement of Fibre Channel hot-plugging for drive cage
cage0:
cli% servicecage startfc –f -ovrd cage0

NOTES
•

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.

262 Service Commands

servicehost
DESCRIPTION
The servicehost command executes removal and replacement actions for a host connecting to
an HP 3PAR Storage System port.

SYNTAX
The syntax for the servicehost command can be one of the following:
•

servicehost list

•

servicehost remove [-f] [ [...]]

•

servicehost copy [-f]  


AUTHORITY
•

Super, Service

•

Any role granted the host_service right.

NOTE:

You need access to all domains in order to run this command.

Can vary for each subcommand as noted in the following section.

SUBCOMMANDS
list
Displays a list of all inactive hosts. Permitted for all users.
remove
Removes an inactive host, as specified with the  specifier, from the
indicated port () and its associated VLUNs. If the  specifier is
not issued with the remove subcommand, all inactive hosts on the specified port and their LUNs
are removed. If the  specifier is not used with the remove subcommand, all inactive
hosts in the system and their LUNs are removed. See “RESTRICTIONS” for additional information
about the remove subcommand.
copy
Copies all active VLUNs from the specified source port (as specified with ) from
host WWNs or iSCSI names matching the specified pattern ()
to the destination port (as specified with ). If necessary, the port is reset to target
mode.

OPTIONS
–f
Specifies that the command is forced. If this option is not used, the command requires confirmation
before proceeding with its operation.

SPECIFIERS

Specifies the host to be removed which is visible to the specified port. This specifier can only be
used with the remove subcommand.


servicehost 263

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.

Specifies that the indicated WWN or iSCSI name is treated as a glob-style pattern. See “Glob-Style
Pattern” (page 12) for more information.

Specifies the source port when exporting VLUNs. This specifier can only be used with the copy
subcommand.

Specifies the destination port when exporting VLUNs. This specifier can only be used with the copy
subcommand.

RESTRICTIONS
•

Access to all domains is required to run this command.

•

If the  specifier is not issued with the remove subcommand, all
inactive hosts on the specified port and their LUNs are removed.

•

If the  specifier is not used with the remove subcommand, all inactive hosts in the
system and their LUNs are removed.

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:
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
None.

264 Service Commands

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]  

•

servicemag start [options] -pdid ...

•

servicemag resume|unmark [options]  

•

servicemag status [options] [ ]

•

servicemag clearstatus  

AUTHORITY
•

Super, Service

•

Any role granted the mag_service right.

NOTE:

You need access to all domains in order to run this command.

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 multistep 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 HP 3PAR engineering.
status
Specifies that the status of the servicemag command operations on a drive magazine are
displayed. This subcommand is permitted for Super, Service, Edit and Browse users. Summary
status is provided by default, and the -d option can be used to get detailed status.
clearstatus
Clears the log shown by the servicemag command status for the given cage and magazine.

OPTIONS
–f
servicemag 265

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 or 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 (LDs) 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 LD). All other used chunklets are placed
in the logging mode. This option is only valid for the start operation.
-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 ...
Specifies one to four physical disks (by physical disk ID) that need to be serviced or replaced. 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  or  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
Estimates the length of time a servicemag start or servicemag resume command will
complete. If the -dryrun option is started before an actual servicemag start or resume
command, 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 system load, use the
servicemag status   command after servicemag start or
servicemag resume command has been initiated. This option is only valid for the start and
resume operations.

SPECIFIERS

Specifies the ID of the cage. Use the showcage command to determine the system’s drive cage
IDs.


266 Service Commands

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

RESTRICTIONS
•

Access to all domains is required to run this command.

•

Users with Browse level authority can only issue the servicemag status command.

EXAMPLES
The following example displays the suspension and resumption of data services on drive magazine
0 in drive cage 2:
cli% servicemag start –log –wait 2 0.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]
....................
wwn [20000000870042F6] id [22] diskpos [2]
....................
wwn [2000000087007E6D] id [23] diskpos [3]
... 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
... mark disk wwn [20000000870042F6] id [22] as non usable for ld allocation
... mark disk wwn [2000000087007E6D] id [23] 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]
... logging chunklets from pd wwn [20000000870042F6] id [22]
... logging chunklets from pd wwn [2000000087007E6D] id [23]
... spinning down disk wwn [2000000087043098] id [20]
... spinning down disk wwn [2000000087008150] id [21]
... spinning down disk wwn [20000000870042F6] id [22]
... spinning down disk wwn [2000000087007E6D] id [23]
... bypassing mag 2 0.0
... bypassed mag 2 0.0
servicemag start 2 0.0 –– Succeeded
cli%
cli% sevicemag resume 2 0.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

servicemag 267

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

Issuing the servicemag command results in chunklet relocation that causes a dip in throughput.

•

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
(see “Show Commands” (page 350)).

•

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  
specifiers, the disk(s) to be serviced can also be specified using the -pdid option. The
advantage is that the servicemag resume command will dismiss the old PDID when it
successfully completes.

268 Service Commands

servicenode
DESCRIPTION
The servicenode command informs the system that a certain component is to be replaced, and
causes the system to indicate the physical location of that component.

SYNTAX
servicenode  [options] 

AUTHORITY
•

Super, Service

•

Any role granted the node_service right.

NOTE:

You need access to all domains in order to run this command.

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.

OPTIONS
-ps 
Specifies which power supply will be placed into service.
-pci 
Specifies which PCI card will be placed into service.
-fan 
Specifies which node fan will be placed into service.
-drive
Specifies that the node's internal drive will be placed into service.
-bat
Specifies that the node's battery backup unit will be placed into service.

SPECIFIERS

Indicates which node the servicenode operation will act on. Accepted values are 0 through 7.

RESTRICTIONS
Access to all domains is required to run this command.

servicenode 269

EXAMPLES
In the following example, fan 1 on node 3 is put into servicing-mode:
cli% servicenode -fan 1 3

NOTES
None.

270 Service Commands

22 Set Commands
setalert
DESCRIPTION
The setalert command sets the status of system alerts.

SYNTAX
setalert new|ack|fixed {...|–a}

AUTHORITY
•

Super, Service

•

Any role granted the alert_set right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–a
Specifies that the status of all alerts be set to new, acknowledged (ack), or fixed. If not specified,
the  specifier must be specified on the command line.

SPECIFIERS
...
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  specifier or with option –a, be set
as new, acknowledged (ack), or fixed.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example sets the status of all system alerts as new:
cli% setalert new -a

NOTES
Verify the status of alerts by issuing the showalert command. See “showalert” (page 350) for
additional information.

setalert

271

setaocfg
DESCRIPTION
The setaocfg command updates an Adaptive Optimization (AO) configuration.

AUTHORITY
Super, Edit

SYNTAX
setaocfg [options ] 

OPTIONS
-t0cpg 
Specifies the Tier 0 CPG for this AO config.
-t1cpg 
Specifies the Tier 1 CPG for this AO config.
-t2cpg 
Specifies the Tier 2 CPG for this AO config.
-mode 
Specifies the optimization bias for the AO configuration, which can be one of the following:
•

Performance — Move more regions toward higher performance.

•

Balanced — Balanced between higher performance and lower cost.

•

Cost — Move more regions toward lower cost tier.

-name 
Specifies a new name for the AO configuration of up to 31 characters in length.

SPECIFIERS
None.

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

•

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
HP representative for more information.

272 Set Commands

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

setaocfg 273

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]  
setauthparam [-f]  ...
setauthparam [-f] -clear ...
setauthparam [-f] -clearall

AUTHORITY
•

Super

•

Any role granted the authparam_set right.

OPTIONS
-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:
•

  - See “Values for setauthparam Specifiers” (page 274).

•

  - See “Examples of Domain Name Prefix Effects” (page 276)

•

 - See “Values for Specifiers  and ” (page 276).

Table 3 Values for setauthparam Specifiers

274





ldap-server

Numeric IP address of the LDAP server.

ldap-server-hn

Indicates the host name of the LDAP server. This value must
be set when the ldap-reqcert option is set or the
sasl-mechanism option is set to GSSAPI. 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.

ldap-port

Indicates the port of the LDAP server (default: 389 for
non-SSL, 636 for SSL).

ldap-ssl

To use SSL when communicating with the LDAP server, set
the value to 1. (The default value is 0).

ldap-reqcert

Indicates whether a valid server certificate should be
required in order to proceed (The default value is 0).

Set Commands

Table 3 Values for setauthparam Specifiers (continued)




ldap-ssl-cacert

Indicates the path name of the file containing the certificate
of the Certificate Authority that has issued the LDAP server's
certificate, or a “– “ to prompt you to enter the certificate
text.

ldap-StartTLS

Set this parameter to one of the following:
• no – to not request the server use StartTLS . Default.
• 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.

binding

The LDAP binding type must be one of the following:
• 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.

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 user-dn-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.

user-attr

Indicates the attribute used to form a DN for simple binding.
When the attribute ends with a back slash, the DN is the
concatenation of the value of the user-attr variable
and the username . When the attribute does not end with
a back slash, it is as described for the user-dn-base
variable.

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.

kerberos-server

Indicates the numeric IP address of the Kerberos server if
different from the LDAP server.

kerberos-realm

The Kerberos realm.

allow-ssh-key

Set this value to 1 to allow LDAP users to set a public SSH
key with the setsshkey 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 variable. This parameter
only affects LDAP users, not local users.

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.

group-obj

Indicates the objectClass attribute of a group object.

group-name-attr

The attribute in the group object that holds the group's
name.

member-attr

The attribute that holds the names of users in the group.

accounts-dn

Indicates the base of the subtree in the DIT in which to
search for objects that hold account information. It is
mutually exclusively with the groups-dn variable.
setauthparam 275

Table 3 Values for setauthparam Specifiers (continued)




account-obj

The objectClass attribute of an account object.

account-name-attr

The attribute of an account object that holds the user's
username .

memberof-attr

The attribute that holds the name of a group of which the
user is a member.

domain-name-attr

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 ( _ ).

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 Table 4 (page 276):
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=

In the last case there is no resulting domain name because ISDom= does not appear in the
candidate.
Table 5 Values for Specifiers  and 




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  arguments.
A value of “ * ” matches any group name.

service-map

Same as super-map, but for the Service level.

276 Set Commands

Table 5 Values for Specifiers  and  (continued)




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.

NOTE:

The IMC refers to  specifiers as Authorization Groups.

EXAMPLES
For a comprehensive example of the setauthparam command used during LDAP setup, see the
LDAP chapter of the HP 3PAR Command Line Interface Administrator’s Manual.

NOTES
•

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

•

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 command will list existing domains.

•

The showauthparam command displays authentication parameter settings and the
checkpassword 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 level.

•

When HP 3PAR Domains are enabled, you can only have Super or Service roles for the
domain all. Any other domain names are ignored for Super or Service level users. You can
only have the Service role when no other domains match for levels other than Super or Service.
If other such domains match, the Service level match is ignored.

setauthparam 277

setbattery
DESCRIPTION
The setbattery command sets 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 ]   
setbattery [options ] 

AUTHORITY
•

Super, Service

•

Any role granted the battery_set right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–s 
Specifies the serial number of the battery using a limit of eight alphanumeric characters.
–x 
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.
–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.

SPECIFIERS

Specifies the node number where the battery is installed.

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

Specifies the battery number on the power supply where 0 is the first battery.
NOTE: The  and  specifiers can be obtained from the output of
the showbattery command.

RESTRICTIONS
Access to all domains is required to run this command.

278 Set Commands

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, 2010:
cli% setbattery -x 07/04/2010 2 1 0

NOTES
To view battery status information, issue the showbattery command. See “showbattery” (page 354)
for information about the showbattery command.

setbattery 279

setcage
DESCRIPTION
The setcage command enables service personnel to set or modify parameters for a drive cage.

SYNTAX
setcage [subcommand ]... 

AUTHORITY
•

Super, Service

•

Any role granted the cage_set right.

NOTE:

You need access to all domains in order to run this command.

SUBCOMMANDS
position 
Sets a description for the position of the cage in the cabinet, where  is a description
to be assigned by service personnel (for example, left-top)
ps 
Sets the model of a cage power supply, where  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.

OPTIONS
None.

SPECIFIERS

Indicates the name of the drive cage that is the object of the setcage operation.

RESTRICTIONS
Access to all domains is required to run this command.

EXAMPLES
The following example demonstrates how to assign cage1 a position description of Side Left:
cli% setcage position Cabinet 0 Bay 5 Side Left cage1

The following example demonstrates how to assign model names to the power supplies in cage1.
In this example, cage1 has two power supplies (0 and 1). Both power supplies are assigned model
name Magnetek.
cli% setcage ps 0 Magnetek ps 1 Magnetek cage1

280 Set Commands

NOTES
•

The parameters specified by the setcage command appear in the showcage –d output
(see “showcage” (page 361)).

•

The power supply model cannot be modified if the information is automatically retrieved from
the system.

setcage

281

setcim
DESCRIPTION
The setcim command sets the properties of the CIM server, including options to enable or disable
the HTTP and HTTPS ports for the CIM server. The command also provides the ability to configure
the port numbers associated with these two protocols. In addition, it allows users to enable or
disable the SLP port.

SYNTAX
setcim [options]

AUTHORITY
•

Super, Service

•

Any role granted the cim_set right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
-f
Forces the operation of the setcim command, bypassing the typical confirmation message.
NOTE:

At least one of the following options are required when issuing the setcim command.

-slp enable|disable
Enables or disables the SLP port.
-http enable|disable
Enables or disables the HTTP port.
-httpport 
Sets the HTTP port (49152 - 65535). The default value is 5988.
-https enable|disable
Enables or disables the HTTPS port.
-httpsport 
Sets the HTTPS port (49152 - 65535). The default value is 5989.

SPECIFIERS
None.

RESTRICTIONS
•

Access to all domains is required to run this command.

•

You cannot disable both of the HTTP and HTTPS ports.

•

You cannot set the same port number for both of the HTTP and HTTPS ports.

282 Set Commands

EXAMPLES
To disable the HTTPS ports:
cli% setcim -https disable
Warning: The CIM server is active and will restart.
Are you sure you want to continue (Y/N)? Y

To enable the HTTPS port and set the HTTPS port number to 49153:
cli% setcim -https enable -httpsport 49153
Warning: The CIM server is active and will restart.
Are you sure you want to continue (Y/N)? Y

NOTES
When the CIM server is active, a warning message appears to inform you of the current status of
the CIM server and asks you for confirmation to continue or not. The -f option forces the action
without a warning message.

setcim 283

setclienv
DESCRIPTION
The setclienv command sets the CLI environment parameters.

SYNTAX
setclienv  

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:




currentdomain

Enter one of the following:
• 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.

listdom

Enter one of the following:
• 0 - (Default) Do not include the domain column in the output.
• 1 - Include domain column where relevant.

csvtable

Enter one of the following:
• 0 - (Default) Normal table printing format.
• 1 - Comma Separated Values (CSV) format.

nohdtot

Enter one of the following:
• 0 - (Default) Show header and total lines.
• 1 - Does not show the header and total lines.

hafter

 - Specifies the number of lines of data to display before an output header is displayed.
If  is 10 or more, print the header after every  of data. If  is less than
10, print only the header at the beginning.

histstatnum

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

editor

NOTE: 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.

RESTRICTIONS
None.

284 Set Commands

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.

setclienv 285

setcpg
DESCRIPTION
The setcpg command modifies existing Common Provisioning Groups (CPG).

SYNTAX
setcpg [options ] 

AUTHORITY
•

Super, Edit, Service

•

Any role granted the cpg_set right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
–sa ...
Specifies additional Logical Disks (LDs) that have already been created to be used for snapshot
administration space allocation. The  argument can be repeated to specify multiple
logical disks. This option is deprecated and will be removed in a subsequent release.
–sd ...
Specifies additional logical disks that have already been created to be used for snapshot data
space allocation. The  argument can be repeated to specify multiple logical disks.
This option is deprecated and will be removed in a subsequent release.
–aw 
Specifies the percentage of used snapshot data space or snapshot administration space that, when
reached, results in a warning alert. To disable the warning, enter 0. 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.
NOTE: The following options 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).
–sdgs  [g|G|t|T]
Specifies the growth increment, the amount of logical disk storage created, on each autogrow
operation. The default and minimum growth increments vary according to the number of controller
nodes in the system. If  is non-zero it must be 8G or bigger. A size of 0 disables the
auto-grow feature. Size can be specified in megabytes (default) or in gigabytes by using the g|G
parameter and terabytes by using the t|T parameter. To specify the size in gigabytes, enter g or
G, for terabytes, enter t or T, directly after the specified size (no space). 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

286 Set Commands

Table 6 Growth Increment Per Number of Nodes (continued)
Number of Nodes

Default

Minimum

5-6

96 GB

24 GB

7-8

128 GB

32 GB

–sdgl  [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  [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.
NOTE:

The following options are used to control auto logical disk creation.

–t 
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, the default is r1.
–ssz 
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 
Specifies the number of sets in a row using an integer from 1 through 2147483647. If not specified,
no row limit is imposed.
–ss 
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). If no availability level is specified, the default is cage. This option has no meaning for
RAID-0.
–ch first|last
Specifies the characteristics of the chunklets, either first (attempt to use the lowest numbered
available chunklets) or last (attempt to use the lowest numbered available chunklets). If no
argument is specified, the default characteristic is first.
–p 
Specifies a pattern for disks. Patterns are used to select disks that are used for creating logical
disks. If no pattern is specified, the option defaults to all disks of the default device type specified
at creation time. 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:
NOTE: An item is specified as an integer, a comma-separated list of integers, or a range of
integers specified from low to high.
setcpg 287

–nd 
Specifies one or more nodes. Nodes are identified by one or more integers (item). Multiple nodes
are separated with a single comma (1,2,3). A range of nodes is separated with a hyphen (0–7).
The primary path of the disks must be on the specified node(s).
–st 
Specifies one or more PCI slots. Slots are identified by one or more integers (item). Multiple slots
are separated with a single comma (1,2,3). A range of slots is separated with a hyphen (0–7).
The primary path of the disks must be on the specified PCI slot(s).
–pt 
Specifies one or more ports. Ports are identified by one or more integers (item). Multiple ports
are separated with a single comma (1,2,3). A range of ports is separated with a hyphen (0–4).
The primary path of the disks must be on the specified port(s).
–cg 
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 (1,2,3). A range of drive cages is
separated with a hyphen (0–3). The specified drive cage(s) must contain disks.
–mg 
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 -mg option. Drive magazines are
identified by one or more integers (item). Multiple drive magazines are separated with a single
comma (1,2,3). A range of drive magazines is separated with a hyphen (0–3). The specified
drive magazine(s) must contain disks.
–pn 
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 (1,2,3). A
range of disk positions is separated with a hyphen (0–3). The specified position(s) must contain
disks.
–dk 
Specifies one or more physical disks. Disks are identified by one or more integers (item). Multiple
disks are separated with a single comma (1,2,3). A range of disks is separated with a hyphen
(0–3). Disks must match the specified ID(s).
NOTE: The following options are used to select the disks that are used to create common
provisioning groups based on the characteristics of the disk.
–tc_gt 
Specifies that physical disks with total chunklets greater than the number specified are selected.
–tc_lt 
Specifies that physical disks with total chunklets less than the number specified are selected.
–fc_gt 
Specifies that physical disks with free chunklets greater than the number specified are selected.
–fc_lt 
Specifies that physical disks with free chunklets less than the number specified are selected.
–devid 
Specifies that physical disks identified by their models are selected. Models can be specified in a
comma-separated list. Models can be displayed by issuing the showpd -i command.
–devtype 
288 Set Commands

Specifies that physical disks must have the specified device type (FC for Fibre Channel, NL for
nearline, or 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 
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 connected to node 2 through their primary path.
–sax [,...]
Specifies that the logical disk, as identified with the  argument, used for snapshot
administration space allocation be removed. The  argument can be repeated to specify
multiple logical disks.
–sdx [,...]
Specifies that the logical disk, as identified with the  argument, used for snapshot data
space allocation be removed. The  argument can be repeated to specify multiple LDs.
–name 
Specifies the name of the Common Provisioning Group (CPG) to be modified to.  can
be up to 31 characters in length.

SPECIFIERS

Specifies the name of the CPG being modified.

RESTRICTIONS
•

Access to all domains is required to run this command.

•

This command sets the parameters that will be used for future grows. Unless the the only growth
parameters (-sdgs, -sdgw or -sdgl) are being changed, this command will OVERWRITE
all previously-set parameters.

EXAMPLES
The following example displays the modification of the auto-growth parameters for CPG cpg1:
cli% setcpg –sdgs 16g –sdgl 48g –sdgw 36g cpg1

The following example removes the -cpg pattern:
cli% setcpg -ha cage -t r5 -p -cg "" -devtype FC cpg1

NOTES
•

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 Fibre Channel (FC),
setcpg 289

nearline (NL), or solid state drive (SSD)). 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.
•

The options -sdgs, -sdgl and -sdgw control the auto LD creation for the CPG’s snapshot
data regions. Auto LD creation occurs when the amount of free LD space falls below the
specified grow (enlarge) size setting options (-sdgs, -sdgl).

•

If auto-grow is enabled, new LDs will be created automatically in addition to any LDs specified
with -sa or -sd options.

•

Enter "" after the  option to remove the pattern.

•

Use movetodomain command to move a CPG from one domain to another.

290 Set Commands

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 [[]][<.ss>]

•

setdate –tzlist [group]

•

setdate –tz 

AUTHORITY
•

Super, Service

•

Any role granted the date_set right.

NOTE:

You need access to all domains in order to run this command.

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 
Sets the timezone on all nodes. The option must have a valid tzname from the list provided with
the –tzlist command.

SPECIFIERS

Specifies the month (MM) and day (DD).

Specifies the hour (hh) and minute (mm) on a 24-hour clock.

Specifies the century (CC) and cannot be used unless a year is specified (YY). This specifier is not
required.

Specifies a year (YY). This specifier is not required.
<.ss>
Specifies seconds (ss). This specifier is not required.
Specifiers can only be used in combinations as listed in RESTRICTIONS in the section that follows.

RESTRICTIONS
•

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

setdate

291

•

MMDDhhmmYY

•

MMDDhhmmCCYY

•

MMDDhhmm.ss

•

MMDDhhmmYY.ss

•

MMDDhhmmCCYY.ss

EXAMPLES
The following example shows the timezone being set:
Timezone set successfully.

The following example verifies the timezone is set to the required setting:
7

Mon Oct 10 23:14:52 GMT 2005

NOTES
•

Specifies 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 command. See “showdate” (page 373) for
additional information.

292 Set Commands

setdomain
DESCRIPTION
The setdomain command sets the parameters and modifies the properties of a domain.

SYNTAX
setdomain [options ] 

AUTHORITY
•

Super

•

Any role granted the domain_set right.

NOTE:

You need access to all domains in order to run this command.

OPTIONS
-name 
Changes the name of the domain.
-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  specifier.
-vvretentiontimemax [h|H|d|D]
Specifies the maximum value that can be set for the retention time of a volume in this domain.
Source Exif Data: 
File Type                       : PDF
File Type Extension             : pdf
MIME Type                       : application/pdf
PDF Version                     : 1.6
Linearized                      : No
Author                          : Hewlett-Packard Company
Create Date                     : 2013:06:20 22:52:40Z
Keywords                        : 3PAR, alerts, remote copy, reference, commands, support, service edition, documentation, feedback
Modify Date                     : 2013:06:20 16:24:03-07:00
XMP Toolkit                     : Adobe XMP Core 5.2-c001 63.139439, 2010/09/27-13:37:26
Format                          : application/pdf
Title                           : HP 3PAR Command Line Interface Reference
Creator                         : Hewlett-Packard Company
Producer                        : XEP 4.18 build 20100322
Trapped                         : False
Creator Tool                    : Unknown
Metadata Date                   : 2013:06:20 16:24:03-07:00
Document ID                     : uuid:a4bdb6ea-5d34-46da-8b02-1e05fe678eb5
Instance ID                     : uuid:744dff1b-9e9e-42a0-b745-dece8bad1eab
Page Mode                       : UseOutlines
Page Count                      : 676
EXIF Metadata provided by EXIF.tools

Navigation menu