Home » HP Manuals » Storage Devices » HP StorageWorks MSA2324fc » Manual Viewer

HP StorageWorks MSA2324fc HP StorageWorks 2300 Family Modular Smart Array CLI - Page 11

Using the CLI, CLI output modes

View all HP StorageWorks MSA2324fc manuals

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

Page 11 highlights

1 Using the CLI This chapter introduces the HP StorageWorks 2000 G2 Modular Smart Array command-line interface (CLI). Accessing the CLI The CLI software embedded in controller modules enables you to manage a storage system out of band. You can access the CLI in two ways: • By using Telnet, an SSH application, or a terminal emulator on a management host that is remotely connected through a LAN to a controller module's network port. See your product's user guide for information about setting management port IP addresses using the CLI. • By using a terminal emulator on a management host that is directly connected to a controller module's serial CLI port. Table 2 Default usernames and passwords Username Password Access level monitor !monitor Monitor (view only) manage !manage Manage (view and change) CLI output modes The CLI has two output modes: • Console mode, which is the human-to-computer interface (HCI). • API mode, which is the computer-to-computer interface (CCI). Console mode enables users to interact with the CLI and obtain easily readable information. This mode automatically sizes fields according to content, adjusts content to window resizes, and displays some information in localized form. These capabilities would present problems for a CCI in the form of scripts or other client software. API mode uses XML format and enables any external application to interact with the storage system. The XML format is constructed to permit new fields to be added without impacting existing clients if they follow standard XML parsing conventions. The XML format also contains alternate fields for values which may be localized, such as a state value. These values are guaranteed not to change with different languages and can be used for scripting. Scripting is not supported using console mode because labels, field sizes, and order of fields may change in future firmware releases. To properly script using the CLI, use API mode. API mode is expected to remain consistent from release to release; field names will be consistent and new functionality will be added as new fields. These types of changes in XML output will not impact a conventional XML parsing engine. You can change the CLI output mode by using the set cli-parameters command; see Example on page 88. HP StorageWorks 2000 G2 Modular Smart Array CLI Reference Guide 11

Section	Page
Contents	3
Tables	7
About this guide	9
Intended audience	9
Prerequisites	9
Related documentation	9
Document conventions and symbols	9
HP technical support	10
Product warranties	10
Subscription service	10
HP web sites	10
Documentation feedback	10
Using the CLI	11
Accessing the CLI	11
CLI output modes	11
Using CLI interactively	12
Using CLI scripts	12
Using the XML API	13
Scripting guidelines	14
XML API examples	14
XML API DTD content	16
XML API basetypes	17
XML API optimization	17
Command syntax	19
Keywords and parameters	19
Disks	19
Vdisks	19
Volumes	19
Ports	19
Command completion, editing, and history	20
Viewing help	20
Size representations	21
Event log	21
Categorical list of commands	23
Alphabetical list of commands	25
abort scrub	26
abort verify	27
abort volumecopy	28
clear cache	29
clear disk-metadata	30
clear events	31
clear expander-status	32
convert master-to-std	33
convert std-to-master	34
create chap-record	35
create host	36
create master-volume	37
create schedule	38
create snap-pool	39
create snapshots	40
create task	41
create user	43
create vdisk	45
create volume	47
create volume-copy	48
create volume-set	49
delete all-master-volumes	50
delete all-snapshots	51
delete chap-records	52
delete host	53
delete master-volume	54
delete schedule	55
delete snap-pool	56
delete snapshot	57
delete snapshot-write-data	58
delete task	59
delete user	60
delete vdisk	61
delete volume	62
dequarantine	63
exit	64
expand master-volume	65
expand snap-pool	66
expand vdisk	67
expand volume	68
map volume	69
meta	71
ping	72
rescan	73
reset host-link	74
reset snapshot	75
restart	76
restore defaults	77
rollback master-volume	78
scrub vdisk	79
set advanced-settings	80
set auto-write-through-trigger	82
set awt	82
set cache-parameters	83
Cache write policy	84
Cache optimization mode	84
Cache read-ahead size	84
Cache redundancy mode	85
set chap-record	86
set cli-parameters	87
set controller-date	90
set debug-log-parameters	91
set disk-parameters	92
set email-parameters	93
set enclosure	94
set expander-fault-isolation	95
set expander-phy	96
set host-name	97
set host-parameters	98
set iscsi-parameters	100
set job-parameters	101
set led	102
set network-parameters	103
set password	104
set prompt	105
set protocols	106
set snap-pool-policy	107
set snap-pool-threshold	108
set snmp-parameters	109
set spares	110
set system	111
set user	112
set vdisk	114
set volume	115
show advanced-settings	116
show auto-write-through-trigger	118
show awt	118
show cache-parameters	119
show chap-records	121
show cli-parameters	122
show configuration	124
show controller-date	125
show controllers	126
show debug-log-parameters	128
show disk-parameters	129
show disks	130
show email-parameters	132
show enclosure-status	133
show enclosures	135
show events	136
show expander-status	138
show frus	140
show host-maps	141
show host-parameters	143
show hosts	145
show iscsi-parameters	146
show job-parameters	147
show license	148
show master-volumes	149
show network-parameters	151
show ntp-status	152
show ports	153
show protocols	155
show redundancy-mode	156
show refresh-counters	157
show sas-link-health	158
show schedule-details	159
show schedules	160
show sensor-status	161
show shutdown-status	163
show snap-pools	164
show snapshots	165
show snmp-parameters	167
show system	168
show system-parameters	169
show task-details	170
show tasks	173
show users	174
show vdisks	175
show volume-maps	177
show volumecopy-status	178
show volumes	179
shutdown	181
stty	182
test	183
trust	183
unmap volume	184
verify vdisk	185
versions	185
volumecopy	186
Glossary	189

Match case Limit results 1 per page

HP StorageWorks 2000 G2 Modular Smart Array CLI Reference Guide

Using the CLI

This chapter introduces the HP StorageWorks 2000 G2 Modular Smart Array command-line interface

(CLI).

Accessing the CLI

The CLI software embedded in controller modules enables you to manage a storage system out of band.

You can access the CLI in two ways:

•

By using Telnet, an SSH application, or a terminal emulator on a management host that is remotely

connected through a LAN to a controller module’s network port. See your product’s user guide for

information about setting management port IP addresses using the CLI.

•

By using a terminal emulator on a management host that is directly connected to a controller module’s

serial CLI port.

CLI output modes

The CLI has two output modes:

•

Console mode, which is the human-to-computer interface (HCI).

•

API mode, which is the computer-to-computer interface (CCI).

Console mode enables users to interact with the CLI and obtain easily readable information. This mode

automatically sizes fields according to content, adjusts content to window resizes, and displays some

information in localized form. These capabilities would present problems for a CCI in the form of scripts or

other client software.

API mode uses XML format and enables any external application to interact with the storage system. The

XML format is constructed to permit new fields to be added without impacting existing clients if they follow

standard XML parsing conventions. The XML format also contains alternate fields for values which may be

localized, such as a state value. These values are guaranteed not to change with different languages and

can be used for scripting.

Scripting is not supported using console mode because labels, field sizes, and order of fields may change

in future firmware releases. To properly script using the CLI, use API mode. API mode is expected to remain

consistent from release to release; field names will be consistent and new functionality will be added as

new fields. These types of changes in XML output will not impact a conventional XML parsing engine.

You can change the CLI output mode by using the

set cli-parameters

command; see

Example

on page 88.

Table 2

Default usernames and passwords

Username

Password

Access level

monitor

!monitor

Monitor (view only)

manage

!manage

Manage (view and change)