Home » HP Manuals » Storage Devices » HP 2000fc » Manual Viewer

HP 2000fc Hp StorageWorks 2000 Family Modular Smart Array CLI reference guide - Page 21

Elements and attributes of the DTD are described in the following table., Element

View all HP 2000fc manuals

Add to My Manuals
Save this manual to your list of manuals

Page 21 highlights

Elements and attributes of the DTD are described in the following table. Element RESPONSE OBJECT PROPERTY COMP Description and Attributes The RESPONSE is the top level XML object. The request attributes contain the details of the request that was sent. The RESPONSE is a container for objects that are returned as part of the request. All commands have a status object as part of the RESPONSE which provides a message and return code. A return code of 0 indicates that the command was successful. Any other return code is an error code. The OBJECT element is a container for properties. Each OBJECT also has attributes which describe the OBJECT characteristics. • oid (Object Identifier) - A unique number per request which identifies the OBJECT within a response. This number is used as a reference in associations that the response may contain. • name - The class name of the object. • basetype - The generic class name of the object. This is used to distinguish between differing types of objects within a response. A response can contain a number of volumes all of which may be of different classes (standard volumes, snap-pools, snapshots, etc.). The response also contains a status object. The basetype indicates which object is a volume and which object is a status object. The PROPERTY element provides the detailed information for each OBJECT. The element value is the actual data content to be used. The attributes provide further details on how to interpret the data. • display-name - The suggested label to use in a user interface for the data value. • raw - Indicates whether or not a value should be displayed to a user. If this value is false, the value might apply only to a programmatic interface which can use the value for calculations. • size - The number of columns to use to display the value. • type - The type that the data should be interpreted as. • key - Indicates whether or not this values can be used as a key to other commands. • name - The name of the property. The name attribute is used for unique identification within an object. The composition element gives the association between a grouping object and a part of object. This provides a description of the hierarchy of the objects that are part of the response. • P - The part component oid. • G - The grouping component oid. Chapter 1 Using the CLI 21

Section	Page
Contents	3
About This Guide	11
Intended Audience	11
Prerequisites	11
Document Conventions	12
HP Technical Support	13
Customer Self Repair	13
Product Warranties	13
Subscription Service	14
HP Websites	14
Documentation Feedback	14
1	15
Using the CLI	15
Accessing the CLI	15
Operation Modes	16
Using the XML API	19
DTD	20
Example	22
Command Syntax	25
Keywords and Parameters	25
Disk Drive Syntax	25
Virtual Disk Syntax	26
Volume Syntax	26
Host Nickname Syntax	27
Volume Mapping Syntax	27
Command Completion, Editing, and History	28
Viewing Command Help	29
Size of Devices and Logical Units	29
Event Log	30
2	31
Command Categories	31
CLI and Users	31
Virtual Disks and Disk Drives	32
Volumes and Mapping	32
Snapshots	33
Volume Copy (Clone)	33
Task Scheduling	33
Event Notification	34
Configuration and Utilities	34
Service Utilities	35
3	37
Command Descriptions	37
abort create	38
abort scrub	39
abort verify	40
abort volumecopy	41
alias	42
clear cache	44
clear disk-metadata	45
clear event	46
clear expander-status	47
convert master-to-std	48
convert std-to-master	49
create chap-record	50
create host-wwn-name	52
create iscsi-host	53
create master-volume	54
create schedule	56
create snap-pool	58
create snapshots	59
create task	60
create user	63
create vdisk	65
create volume	68
delete all-master-volumes	70
delete all-snapshots	71
delete chap-records	72
delete global-spare	73
delete host-wwn-name	74
delete iscsi-host	75
delete master-volume	76
delete schedule	77
delete snap-pool	78
delete snapshot	79
delete snapshot-write-data	80
delete task	81
delete user	82
delete vdisk	83
delete vdisk-spare	85
delete volume	86
exit	87
expand snap-pool	88
expand vdisk	90
expand volume	92
map volume	94
ping	97
rescan	98
reset host-channel-link	99
reset snapshot	100
restart	101
restore defaults	103
rollback master-volume	104
scrub vdisk	106
set auto-write-through-trigger	107
set awt	109
set cache-parameters	110
Cache Policy	110
Cache Optimization Mode	111
Read-Ahead Size	111
Independent Cache Performance Mode	112
set chap-record	116
set cli-parameters	118
set controller-date	120
set debug-log-parameters	122
set drive-parameters	124
set expander-fault-isolation	125
set expander-phy	127
set global-spare	129
set host-parameters	130
set host-port-interconnects	132
set host-wwn-name	133
set iscsi-host	134
set iscsi-parameters	135
set job-parameters	137
set led	138
set network-parameters	139
set password	141
set prompt	142
set protocols	143
set snap-pool-policy	145
set snap-pool-threshold	147
set snmp-parameters	149
set system	150
set user	151
set vdisk	153
set vdisk-spare	154
set volume	155
show auto-write-through-trigger	156
show cache-parameters	157
show channels	159
show chap-records	162
show cli-parameters	164
show configuration	166
show controller-date	168
show debug-log	169
show debug-log-parameters	172
show disks	174
show drive-parameters	177
show enclosure-status	178
show events	181
show expander-status	184
show frus	186
show host-maps	188
show host-parameters	190
show host-port-interconnects	193
show host-wwn-names	194
show iscsi-hosts	195
show iscsi-parameters	196
show job-parameters	198
show license	199
show master-volumes	200
show network-parameters	202
show ntp-status	204
show port-wwn	206
show protocols	207
show redundancy-mode	208
show schedule-details	210
show schedules	212
show sensor-status	213
show shutdown-status	215
show snap-pools	216
show snapshots	218
show snmp-parameters	220
show system	222
show task-details	223
show tasks	227
show users	228
show vdisks	230
show versions	232
show volumecopy-status	233
show volume-maps	235
show volumes	237
shutdown	240
stty	241
trust	242
unmap volume	244
verify vdisk	246
versions	247
volumecopy	248
4	251
Troubleshooting Using the CLI	251
Viewing Command Help	252
clear cache	252
clear expander-status	252
ping	253
rescan	253
reset host-channel-link	253
restart	253
restore defaults	254
set debug-log-parameters	254
set expander-fault-isolation	255
set expander-phy	255
set led	255
set protocols	256
show debug-log	256
show debug-log-parameters	256
show enclosure-status	257
show events	257
show expander-status	257
show frus	257
show protocols	258
show redundancy-mode	258
trust	258
Problems Scheduling Tasks	259
Create the Task	259
Reset Snapshot	259
Schedule the Task	259
Errors Associated with Scheduling Tasks	260
Missing Parameter Data Error	260
Glossary	261

Match case Limit results 1 per page

Chapter 1

Using the CLI

Elements and attributes of the DTD are described in the following table.

Element

Description and Attributes

RESPONSE

The

RESPONSE

is the top level XML object. The request attributes

contain the details of the request that was sent. The

RESPONSE

is a

container for objects that are returned as part of the request.

All commands have a status object as part of the

RESPONSE

which

provides a message and return code. A return code of

indicates that the

command was successful. Any other return code is an error code.

OBJECT

The

OBJECT

element is a container for properties. Each

OBJECT

also

has attributes which describe the

OBJECT

characteristics.

•

oid

(Object Identifier) - A unique number per request which identifies

the

OBJECT

within a response. This number is used as a reference in

associations that the response may contain.

•

name

- The class name of the object.

•

basetype

- The generic class name of the object. This is used to

distinguish between differing types of objects within a response. A

response can contain a number of volumes all of which may be of

different classes (standard volumes, snap-pools, snapshots, etc.). The

response also contains a status object. The

basetype

indicates which

object is a volume and which object is a status object.

PROPERTY

The

PROPERTY

element provides the detailed information for each

OBJECT

. The element value is the actual data content to be used. The

attributes provide further details on how to interpret the data.

•

display-name

- The suggested label to use in a user interface for

the data value.

•

raw

- Indicates whether or not a value should be displayed to a user. If

this value is

false

, the value might apply only to a programmatic

interface which can use the value for calculations.

•

size

- The number of columns to use to display the value.

•

type

- The type that the data should be interpreted as.

•

key

- Indicates whether or not this values can be used as a key to other

commands.

•

name

- The name of the property. The

name

attribute is used for

unique identification within an object.

COMP

The composition element gives the association between a grouping object

and a part of object. This provides a description of the hierarchy of the

objects that are part of the response.

•

P - The part component oid.

•

G - The grouping component oid.