HP MSA 1040 HP MSA 1040 CLI Reference Guide (762782-001, March 2014) - Page 3

Contents

3

1

Using the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

CLI output formats. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

13

Using CLI interactively. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

14

Using a script to access the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

14

Using the XML API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

16

Scripting guidelines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

17

XML API examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

18

XML API optimization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

19

Command syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

General rules for specifying commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

Specifying disks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

Specifying vdisks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

Specifying volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

Specifying ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

20

User password rules. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

Command completion, editing, and history . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

Viewing help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

21

Size representations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

Event log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

22

2

Categorical list of commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Current commands by category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

23

Deprecated commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

27

Removed commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

28

3

Alphabetical list of commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

abort replication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

30

abort scrub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

31

abort verify . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

32

abort volumecopy. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

33

add replication-volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

34

clear cache . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

36

clear disk-metadata. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

37

clear events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

39

clear expander-status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

cls (Deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

40

convert master-to-std . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

41

convert std-to-master . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

42

create certificate. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43

create chap-record . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

45

create host. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

create host-wwn-name (Deprecated) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

46

create master-volume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

47

create remote-system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

49

create replication-set . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

50

create schedule . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

55

create snap-pool. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

57

create snapshots. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

58

create task. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

59

create temp-license . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

62

create user. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

63

create vdisk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

66

create volume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

68

Contents

HP MSA 1040 HP MSA 1040 CLI Reference Guide (762782-001, March 2014) - Page 3

Contents, Using the CLI .13, Categorical list of commands .. 23, Alphabetical list of commands .29

Page 3 highlights

Section	Page
Contents	3
Tables	11
Using the CLI	13
Accessing the CLI	13
CLI output formats	13
Using CLI interactively	14
Using a script to access the CLI	14
Using the XML API	16
Scripting guidelines	17
XML API examples	18
XML API optimization	19
Command syntax	20
General rules for specifying commands	20
Specifying disks	20
Specifying vdisks	20
Specifying volumes	20
Specifying ports	20
User password rules	21
Command completion, editing, and history	21
Viewing help	21
Size representations	22
Event log	22
Categorical list of commands	23
Current commands by category	23
Deprecated commands	27
Removed commands	28
Alphabetical list of commands	29
abort replication	30
abort scrub	31
abort verify	32
abort volumecopy	33
add replication-volume	34
clear cache	36
clear disk-metadata	37
clear events	39
clear expander-status	40
cls (Deprecated)	40
convert master-to-std	41
convert std-to-master	42
create certificate	43
create chap-record	45
create host	46
create host-wwn-name (Deprecated)	46
create master-volume	47
create remote-system	49
create replication-set	50
create schedule	55
create snap-pool	57
create snapshots	58
create task	59
create temp-license	62
create user	63
create vdisk	66
create volume	68
create volume-set	70
delete all-master-volumes	73
delete all-snapshots	74
delete chap-records	75
delete global-spare	76
delete host	77
delete host-wwn-name (Deprecated)	77
delete iscsi-host (Deprecated)	77
delete master-volume	78
delete remote-system	79
delete replication-set	80
delete schedule	81
delete snap-pool	82
delete snapshot	83
delete snapshot-write-data	84
delete task	85
delete user	86
delete vdisk (Deprecated)	86
delete vdisks	87
delete vdisk-spare	88
delete volumes	89
dequarantine	90
detach replication-volume	93
down disk	95
exit	96
expand snap-pool	97
expand vdisk	98
expand volume	100
export snapshot	101
fail	102
help	102
history (Deprecated)	102
map volume	103
meta	106
ping	107
reattach replication-volume	108
release volume	110
remote	111
remove replication-volume	112
replicate snapshot	113
replicate volume	114
rescan	115
reset all-statistics	116
reset controller-statistics	117
reset disk-error-statistics	118
reset disk-statistics	119
reset host-channel-link (Deprecated)	119
reset host-link	120
reset host-port-statistics	121
reset smis-configuration	122
reset snapshot	124
reset vdisk-statistics	125
reset volume-statistics	126
restart	127
restore defaults	129
resume replication	130
rollback master-volume	131
scrub vdisk	132
scrub volume	133
set advanced-settings	134
set auto-write-through-trigger	139
set awt	140
set cache-parameters	141
set chap-record	143
set cli-parameters	144
set controller-date	146
set debug-log-parameters	148
set disk-parameters	149
set drive-parameters (Deprecated)	149
set email-parameters	150
set enclosure	152
set expander-fault-isolation	153
set expander-phy	154
set global-spare	156
set host-name	157
set host-parameters	158
set host-wwn-name (Deprecated)	160
set iscsi-host (Deprecated)	160
set iscsi-parameters	161
set job-parameters (Deprecated)	162
set led	162
set network-parameters	163
set ntp-parameters	165
set output-format (Deprecated)	165
set password	166
set priorities	167
set prompt	168
set protocols	169
set remote-system	171
set replication-primary-volume	172
set replication-volume-parameters	175
set schedule	177
set snap-pool-policy	179
set snap-pool-threshold	181
set snmp-parameters	182
set spares	183
set syslog-parameters	184
set system	185
set task	186
set user	188
set vdisk	192
set vdisk-spare	193
set volume	194
show advanced-settings	195
show auto-write-through-trigger	199
show awt	200
show cache-parameters	201
show certificate	204
show channels (Deprecated)	204
show chap-records	205
show cli-parameters	206
show configuration	208
show controller-date	209
show controllers	210
show controller-statistics	213
show debug-log-parameters	215
show disk-parameters	216
show disks	217
show disk-statistics	222
show drive-parameters (Deprecated)	225
show email-parameters	226
show enclosures	228
show enclosure-status (Deprecated)	229
show events	230
show expander-status	232
show fans	234
show frus	236
show host-maps	238
show host-parameters	240
show host-port-statistics	244
show host-wwn-names (Deprecated)	245
show hosts	246
show inquiry	247
show iscsi-parameters	248
show job-parameters (Deprecated)	249
show license	250
show master-volumes	252
show network-parameters	254
show ntp-status	256
show output-format (Deprecated)	256
show port-wwn (Deprecated)	256
show ports	257
show power-supplies	261
show priorities	262
show protocols	263
show provisioning	265
show redundancy-mode	268
show refresh-counters	270
show remote-systems	271
show replication-images	273
show replication-sets	276
show replication-volumes	280
show sas-link-health	283
show schedule-details	285
show schedules	286
show sensor-status	288
show shutdown-status	290
show snap-pools	291
show snapshots	293
show snmp-parameters	296
show syslog-parameters	297
show system	298
show system-parameters	301
show task-details	302
show tasks	307
show unwritable-cache	313
show users	314
show vdisks	317
show vdisk-statistics	320
show versions	323
show volumecopy-status	324
show volume-maps	325
show volume-names	327
show volume-reservations	328
show volumes	330
show volume-statistics	333
shutdown	335
start vdisk	336
stop vdisk	337
stty (Deprecated)	338
suspend replication	338
test	339
trust	340
unfail controller	345
unmap volume	346
verify links	347
verify remote-link	349
verify vdisk	350
versions	351
volumecopy	352
XML API basetype properties	355
advanced-settings-table	356
attribute-priorities	361
auto-write-through-trigger	362
cache-parameter	363
cache-settings	365
certificate-status	366
chap-records	367
cli-parameters	368
compact-flash	371
controller-cache-parameters	372
controllers	373
controller-statistics	377
debug-log-parameters	379
disk-hist-statistics	383
disk-statistics	385
drive-parameters	387
drive-summary	388
drives	389
email-parameters	395
enclosure-fru	396
enclosure-list	397
enclosures	398
enclosure-sku	401
events	402
expander-ports	403
fan	404
fc-port	406
host-port-statistics	407
hosts	408
host-view	409
host-view-mappings	410
inquiry	411
io-modules	412
iscsi-parameters	414
iscsi-port	415
license	416
log-header-table	419
master-volumes	420
network-parameters	421
ntp-status	423
policy-threshold	424
port	425
power-supplies	427
product-info	429
provisioning	430
redundancy	431
refresh-counters	433
remote-addresses	434
remote-links	435
remote-system	436
replicate-volume-tasks	438
replication-image	439
replication-image-params	440
replication-set	441
replication-volume	442
replication-volume-summary	445
reset-snapshot-tasks	446
sas-status-controller-a	447
schedules	450
security-communications-protocols	451
sensors	453
show-other-mc-status	454
shutdown-status	455
snap-pools	456
snapshots	457
snapshot-with-retention-tasks	460
snap-tasks	461
snmp-parameters	462
status	463
syslog-parameters	464
system	465
system-parameters-table	467
tasks	470
time-settings-table	472
unhealthy-component	473
unwritable-cache	475
users	476
vdisk-hist-statistics	479
vdisk-statistics	480
versions	481
virtual-disk-summary	482
virtual-disks	483
volume-copy-status	488
volume-copy-tasks	489
volume-names	490
volume-reservations	491
volumes	492
volume-statistics	497
volume-view	499
volume-view-mappings	500
Support and other resources	501
Contacting HP	501
Subscription service	501
Product advisories	501
Related information	501
Typographic conventions	502
Documentation feedback	503
Settings changed by restore defaults	505
Glossary	507