HP StoreVirtual LeftHand OS Command Line
Interface User Guide
Abstract
For the latest version of this guide, see the HP website http://www.hp.com/support/StoreVirtualManuals.
HP Part Number: AX696-10014
Published: August 2015
Edition: 8
© Copyright 2008, 2015 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.
Acknowledgements
Microsoft® and Windows® are trademarks of the Microsoft group of companies.
Revision History
Revision 1
November 2008
Release version 8.0 of the Command Line Interface. Added the following commands: addVirtualManager, assignVolume, assignVolumeChap,
cacheCredentials, cancelRemoteSnapshot, clearCredentials, cloneSnapshot, configureRaid, connectVolume, convertSnapshotTempSpace,
createAdminGroup, createAdminUser, createCluster, createGroup, createRemoteAssociation, createRemoteSnapshot, createSite, createSnapshot,
createVolume, deleteAdminGroup, deleteAdminUser, deleteCluster, deleteGroup, deleteRemoteAssociation, deleteSite, deleteSnapshot,
deleteSnapshotTempSpace, deleteVirtualManager, deleteVolume, disconnectLocalVolume, discoverTcp, discoverUdp, dismountVolume, getClusterInfo,
getGroupInfo, getLocalVolumes, getNsmInfo, getNsmLogs, getPerformanceStats, getRemoteSnapshotInfo, getScsiInfo, getSiteInfo, getSnapshotInfo,
getSystemInfo, getVolumeInfo, getVolumeControllingServer, help, makePrimary, makeRemote, modifyAdminGroup, modifyAdminUser, modifyCluster,
modifyGroup, modifyRemoteAssociation, modifySite, modifySnapshot, modifySnmpTrapTarget, modifyVolume, mountVolume, provisionVolume,
rebalanceVip, recoverQuorum, removeVolume, resetSession, rollbackSnapshot, runDiagnostic, setDnsInfo, shutdownGroup, shutdownNsm,
startManager, startVirtualManager, stopManager, stopVirtualManager, testCredentials, unassignVolume, utility, vssSnapshot, waitForUpdate.
Revision 2
March 2010
Release version 8.5 of the Command Line Interface. Added the following commands: clearVssVolumeFlags, getAlertLog, getServerCapabilities,
getServerVolumeInfo, getSupportInfo, removeSnapshotsetLicenseKey.
Revision 3
November 2010
Release version 9.0 of the Command Line Interface. Added the following commands: assignVolumeToServer, clearAlertsPolicy, clearDnsInfo,
clearEmailServerInfo, clearSnmpNotifyPolicy, clearSnmpServiceInfo, createEmailNotifyPolicy, createServer,
createSnapshotSchedulecreateSnmpCommunityString, createSnmpTrapTarget, createSyslogNotifyPolicy, deleteEmailNotifyPolicy, deleteServer,
deleteSnapshotSchedule, deleteSnmpCommunityString, deleteSnmpTrapTarget, deleteSyslogNotifyPolicy, getDnsInfogetEventLog, getNotificationPolicy,
getServerInfo, getSnapshotScheduleInfo, getSnmpInfo, modifyEmailNotifyPolicy, modifyRemoteSnapshotSchedule, modifyServer,
modifySnapshotSchedule, modifySnmpCommunityString, modifySyslogNotifyPolicy, setAlertsPolicy, setEmailServerInfo, setSnmpNotifyPolicy,
setSnmpServiceInfo, startSnmpService, stopSnmpService, unassignVolumeToServer, waitForEvent.
Revision 4
September 2011
Release version 9.5 of the Command Line Interface. Added the following commands: getServerJobInfo.
Revision 5
November 2012
Release version 10.0 of the Command Line Interface. Added the following commands: clearADInfo, deleteAutoMountPolicy, findADInfo, findFile,
getADInfo, getAutoMountPolicy, modifyNSM, setADInfo, setAutoMountPolicy. Removed the following commands: AssignVolume (use
AssignVolumeToServer instead); provisionVolume (functionality divided over CreateVolume, AssignVolumeToServer, ConnectVolume, and MountVolume).
Revision 6
September 2013
Release version 11.0 of the Command Line Interface. Added the following commands: setSupportLogin, setTraceOff, setTraceOn. Updated the
following commands: createVolume, makePrimary, makeRemote, modifyVolume.
Revision 7
January 2015
Release version 12.0 of the Command Line Interface. Added the SpaceReclaim parameter to the modifyGroup command. Added the
SpaceReclaimWarn and SpaceReclaimCrit parameters to the createCluster and modifyCluster commands.
Revision 8
August 2015
Release version 12.5 of the Command Line Interface. Corrected formatting in the SpaceReclaimWarn and SpaceReclaimCrit parameters for the
createCluster and modifyCluster commands and SpaceReclaimWarn for the modifyGroup command. Added createQuorumWitness and
deleteQuorumWitness commands.
Contents
1 Overview..................................................................................................6
System Requirements.................................................................................................................6
Installing the CLI.......................................................................................................................6
Accessing the CLI.....................................................................................................................6
Concurrent CLI commands.........................................................................................................6
Global parameters...................................................................................................................7
Syntax.....................................................................................................................................7
Return codes..........................................................................................................................10
2 Commands..............................................................................................16
addVirtualManager................................................................................................................16
assignVolumeChap.................................................................................................................16
assignVolumeToServer.............................................................................................................17
cacheCredentials....................................................................................................................18
cancelRemoteSnapshot............................................................................................................19
clearAlertsPolicy.....................................................................................................................19
clearCredentials.....................................................................................................................20
clearADInfo...........................................................................................................................20
clearDnsInfo...........................................................................................................................21
clearEmailServerInfo...............................................................................................................22
clearSnmpNotifyPolicy.............................................................................................................22
clearSnmpServiceInfo..............................................................................................................23
clearVssVolumeFlags...............................................................................................................23
cloneSnapshot........................................................................................................................24
configureRaid.........................................................................................................................24
connectVolume.......................................................................................................................25
convertSnapshotTempSpace.....................................................................................................26
createAdminGroup.................................................................................................................26
createAdminUser....................................................................................................................27
createCluster..........................................................................................................................28
createEmailNotifyPolicy...........................................................................................................29
createGroup..........................................................................................................................30
createQuorumWitness.............................................................................................................30
createRemoteAssociation.........................................................................................................31
createRemoteSnapshot............................................................................................................32
createServer...........................................................................................................................34
createSite..............................................................................................................................35
createSnapshot.......................................................................................................................36
createSnapshotSchedule..........................................................................................................37
createSnmpCommunityString....................................................................................................39
createSnmpTrapTarget.............................................................................................................40
createSyslogNotifyPolicy..........................................................................................................41
createVolume.........................................................................................................................42
deleteAdminGroup.................................................................................................................43
deleteAdminUser....................................................................................................................44
deleteAutoMountPolicy............................................................................................................44
deleteCluster..........................................................................................................................45
deleteEmailNotifyPolicy...........................................................................................................45
deleteGroup..........................................................................................................................46
deleteQuorumWitness.............................................................................................................47
deleteRemoteAssociation.........................................................................................................47
deleteServer...........................................................................................................................48
Contents
3
deleteSite..............................................................................................................................49
deleteSnapshot.......................................................................................................................50
deleteSnapshotSchedule..........................................................................................................50
deleteSnapshotTempSpace.......................................................................................................51
deleteSnmpCommunityString....................................................................................................52
deleteSnmpTrapTarget.............................................................................................................53
deleteSyslogNotifyPolicy..........................................................................................................53
deleteVirtualManager..............................................................................................................54
deleteVolume.........................................................................................................................55
disconnectLocalVolume............................................................................................................55
discoverTcp............................................................................................................................56
discoverUdp..........................................................................................................................56
dismountVolume.....................................................................................................................57
findADInfo.............................................................................................................................57
getADInfo..............................................................................................................................59
getAlertLog............................................................................................................................60
getAutoMountPolicy................................................................................................................61
getClusterInfo.........................................................................................................................61
getDnsInfo.............................................................................................................................62
getEventLog...........................................................................................................................63
getGroupInfo.........................................................................................................................64
getLocalVolumes.....................................................................................................................65
getNotificationPolicy...............................................................................................................66
getNsmInfo............................................................................................................................66
getNsmLogs...........................................................................................................................67
getPerformanceStats................................................................................................................68
getRemoteSnapshotInfo...........................................................................................................69
getScsiInfo.............................................................................................................................70
getServerCapabilities..............................................................................................................70
getServerInfo..........................................................................................................................71
getServerJobInfo.....................................................................................................................72
getServerVolumeInfo...............................................................................................................73
getSiteInfo.............................................................................................................................74
getSnapshotInfo......................................................................................................................75
getSnapshotScheduleInfo.........................................................................................................76
getSnmpInfo..........................................................................................................................77
getSupportInfo.......................................................................................................................78
getSystemInfo.........................................................................................................................78
getVolumeInfo........................................................................................................................79
getVolumeControllingServer.....................................................................................................80
help......................................................................................................................................81
makePrimary..........................................................................................................................81
makeRemote..........................................................................................................................82
modifyAdminGroup................................................................................................................83
modifyAdminUser...................................................................................................................84
modifyCluster.........................................................................................................................85
modifyEmailNotifyPolicy..........................................................................................................86
modifyGroup.........................................................................................................................87
modifyNSM...........................................................................................................................88
modifyRemoteAssociation........................................................................................................89
modifyRemoteSnapshotSchedule...............................................................................................90
modifyServer.........................................................................................................................91
modifySite.............................................................................................................................92
modifySnapshot.....................................................................................................................93
modifySnapshotSchedule.........................................................................................................94
4
Contents
modifySnmpCommunityString...................................................................................................95
modifySnmpTrapTarget............................................................................................................95
modifySyslogNotifyPolicy.........................................................................................................96
modifyVolume........................................................................................................................97
mountVolume.........................................................................................................................98
rebalanceVip.........................................................................................................................99
recoverQuorum....................................................................................................................100
removeSnapshot...................................................................................................................101
removeVolume......................................................................................................................101
resetSession.........................................................................................................................102
rollbackSnapshot..................................................................................................................103
runDiagnostic.......................................................................................................................104
setADInfo............................................................................................................................104
setAlertsPolicy......................................................................................................................105
setAutoMountPolicy...............................................................................................................106
setDnsInfo............................................................................................................................107
setEmailServerInfo................................................................................................................107
setGossipList........................................................................................................................108
setLicenseKey.......................................................................................................................109
setSnmpNotifyPolicy..............................................................................................................110
setSnmpServiceInfo...............................................................................................................111
setSupportLogin....................................................................................................................111
setTraceOff..........................................................................................................................112
setTraceOn..........................................................................................................................112
shutdownGroup....................................................................................................................113
shutdownNsm......................................................................................................................113
startManager.......................................................................................................................114
startSnmpService..................................................................................................................115
startVirtualManager..............................................................................................................115
stopManager.......................................................................................................................116
stopSnmpService..................................................................................................................116
stopVirtualManager..............................................................................................................117
testCredentials......................................................................................................................118
unassignVolume...................................................................................................................118
unassignVolumeToServer........................................................................................................119
utility..................................................................................................................................120
vssSnapshot.........................................................................................................................121
waitForEvent........................................................................................................................122
waitForUpdate.....................................................................................................................123
3 Support and other resources....................................................................124
Contacting HP......................................................................................................................124
HP Insight Remote Support.....................................................................................................124
Related information...............................................................................................................125
4 Documentation feedback.........................................................................126
Contents
5
1 Overview
The LeftHand OS command-line interface (CLI, also referred to as CLIQ,) is built upon the API
released with version 8.x. You can develop your own automation, scripting and management
using the CLI.
For instructions about using the CLI, see “Syntax” (page 7).
The “Global parameters” (page 7) section describes functionality that applies to the entire CLI
and includes commands to customize global operations.
System Requirements
•
Windows Server 2008 R2
•
Windows Vista
•
Windows 7
•
Windows 8
•
Windows Server 2012
•
Windows Server 2012 R2
•
10 MB available space
Installing the CLI
Download the HP StoreVirtual CLI installer from the HP StoreVirtual downloads page (http://
www.hp.com/go/StoreVirtualDownloads) and run the installer on the computer that you will use
to administer the SAN. The installation wizard automatically installs the CLI software to the following
default location in Windows: C:\Program Files\HP\StoreVirtual\CLI
Accessing the CLI
You can access the CLI through a Windows application called CLIQ and/or connect directly to
the StoreVirtual storage system by SSH. If all connections to the StoreVirtual storage system are
done using SSH, it is not necessary to install the Windows CLIQ. To log in through SSH, enter the
storage system IP address and the designated port of 16022, as shown in the following example:
ssh –p 16022 -l <user> <storage system IP>
Concurrent CLI commands
No more than five concurrent commands from distinct users should be sent to a single storage
system. Users can experience timeouts and performance declines with the sixth concurrent command.
For example, CLI commands from users Sue, Bob, Jim, Alan, and Les can be received and serviced
by a single storage system simultaneously. However, adding a sixth simultaneous command from
Steve could result in a timeout or performance decline for any of the users.
More than five simultaneous commands can be achieved by distributing CLI sessions across each
storage system in a management group. For example, in a three-node management group, six
unique users can simultaneously send commands by distributing them as follows:
6
•
Sue and Bob send commands to StorageSystem–1
•
Jim and Alan send commands to StorageSystem–2
•
Les and Steve send commands to StorageSystem–3
Overview
Global parameters
prompt=<true | false>
Some commands prompt before proceeding. This default behavior can be turned off by specifying
prompt=false.
output=<XML | Normal>
In the default case, the CLI returns information to standard output, formatted in a way that's easy
to read rather than easy to parse. The XML setting returns all output information as an XML document,
allowing easier parsing of the result. There is no guarantee that newer versions of the API will
preserve the same formatting in the default case. It is strongly discouraged to use this form of the
CLI programmatically. Use the XML output type if the output must be parsed.
separator=<c>
Some CLI parameters comprise parameters for multiple operations. For example, when using the
snapshotVolumes command, allows the user to specify simultaneous snapshots of multiple
volumes. In this scenario, some parameters specify an ordered list that apply to each snapshot in
succession:
description="This applies to snapshot1;This applies to snapshot2"
The default separator character is a semicolon (;). If a semicolon is used in the body of a parameter,
you can use a different character as the separator (such as a comma).
Syntax
The CLI specifies parameters in the form of parameter=<parameter> (specification), rather than
dictating a particular order (positional) notation.
Parameter ordering
The order of parameters is not specified. For example, the following are equivalent commands
that perform the same task:
cliq deleteVolume volumeName=theVolume userName=user passWord=secret
login=10.1.2.3
cliq deleteVolume login=10.1.2.3 passWord=secret userName=user
The method parameter may be optionally specified as "method=<command>":
cliq userName=user passWord=secret login=10.1.2.3 volumeName=theVolume
method=deleteVolume
Case sensitivity
All commands and parameter names are case-insensitive. For example, createVolume,
CreateVolume, and CREATEVOLUME are all the same command. In some cases, parameter
values, while not sensitive, are case significant as the system will preserve the case specified. For
example, the description parameter value in the createVolume command preserves the case
specified by the caller, and imposes this on the newly created volume.
True/False
Any parameter that indicates true/false, may be specified as "1|0" or "true|false".
Global parameters
7
Command abbreviation
There is no command or parameter abbreviation in the CLI when scripted. All commands and
parameter names must be fully specified. This is to prevent ambiguity in legacy scripts if new
commands or parameters are added.
OS error code integration
The CLI maps error codes to reasonable OS status codes (status in Linux, ERRORLEVEL in DOS).
Since these are limited to 0–255, some of the OS errors may have less granularity than the API
error codes.
Composite commands
Some commands take multiple elements for the parameter value. In this case, the parameter is
interpreted as an delimiter-separated ordered list. For example:
volumeName=volume1;volume2
login=10.0.1.2;10.1.2.3;10.2.3.4
If a parameter contains fewer elements in the list than needed for the composite command, the last
one in the list will be repeated. There must be at least one element in the list, if it's required.
Size specification
When volume sizes or thresholds are specified, the format is <size><units>, where units are:
•
KB—kilobytes (2^10)
•
MB—megabytes (2^20)
•
GB—gigabytes (2^30)
•
TB—terabytes (2^40)
•
PB—petabytes (2^50)
There is no default for size units; the units must be specified. These are defined as International
System of Units (SI) for file storage (popular use).
For example, size:
•
10 MB—1,048,576 bytes
•
10 GB—10,737,418,240 bytes
Password prompt
When credentials are required in the CLI, you may not want to display the password by typing
the "password=" parameter. If the username parameter is specified without the password parameter,
you will be prompted interactively for the password. This password will not be displayed.
cliq getGroupInfo login=10.0.1.2 username=admin
password: *******
DNS names
You can specify a manager using a host name, provided it can be resolved by DNS:
cliq getGroupInfo login=Exchange-1 username=admin password=secret
Storage System CLI
When commands are executed on the storage systems (via SSH), no authentication parameters
are required:
getGroupInfo
8
Overview
Windows CLI
When commands are executed from a Windows server connected to a storage system,
authentication parameters are required:
cliq getGroupInfo login=10.1.2.3 userName=admin passWord=secret
Also, the remotegroupname parameter (used in commands createRemoteAssociation,
deleteRemoteAssociation, modifyRemoteAssociation, createRemoteSnapshot,
and createSnapshotSchedule) only applies when using the Windows CLI.
Disallowed characters in credentials
If an administrative user name or password uses characters in the CMC that are not allowed in
the CLI, CLI commands that use those credentials will not succeed. To resolve this issue, do one of
the following:
•
Change the existing credentials in the CMC to use characters allowed in both the CMC and
CLI.
•
Create a new administrative user/group that only uses characters permitted by the CMC and
CLI and use that user/group for the CLI commands.
Disallowed characters in the CMC credentials
Dot (‘.’)
Colon (‘:’)
Forward slash (‘/’)
Comma (' , ')
Backward slash ('\')
Semi-colon (';')
Single-quote (' ' ')
Additional characters disallowed in the CLI
Equal sign (‘=’)
Double quotes (‘ " ‘)
Command availability
When commands are available for both Windows and SSH, a command example is given for
both. If a command is only available for Windows, a command example is given only for Windows.
Command line conventions
Symbol
Description
|
Used to separate input options. For example,
{ userName= passWord= | groupName= }
means that you enter userName with the passWord or the groupName
parameter.
{}
Denotes a required parameter. For example,
{login}
must be specified.
Syntax
9
Symbol
Description
[]
Denotes an optional parameter. For example, [namePrefix] is an optional
input.
italic
Denotes a replaceable parameter. For example, Parameter volumeName is
the name of the volume.
Integrated command shell
The CLI has an integrated shell that is executed by default when connecting directly to a storage
system, or when running cliq.exe without any parameters:
HP StoreVirtual LeftHand OS Command Line Interface, vxx.x.xx.xxxx
(C) Copyright 20xx-20xx Hewlett-Packard Development Company, L.P.
(type exit to quit)
CLIQ>
The integrated shell supports rich command line editing features specific to the HP StoreVirtual API.
The following editing keys are supported:
Key
Meaning
LEFT
Moves the cursor one space to the left.
RIGHT
Moves the cursor one space to the right.
BACKSPACE
Deletes the character under the cursor and moves the cursor to the left.
DELETE
Deletes the character under the cursor.
UP
Recalls the previous command entered.
DOWN
Recalls the first command entered.
HOME
Moves the cursor to the beginning of the line.
END
Moves the cursor to the end of the line.
ESCAPE
Clears the current command line.
INSERT
Toggles between insert mode (the default) and overwrite mode.
TAB
Completes the command. If the command method is not yet fully resolved,
repeated TAB keys will cycle through the possible command methods
(SHIFT+TAB will cycle in reverse). If the method is fully resolved, then
parameters associated with that command will be proposed. The parameters
suggested start with those required for the command, followed by optional
parameters. No mutually exclusive parameters will be suggested.
!#
Recalls the command from the previous command list by number (for example,
!3 will recall the third command from the command list.
Return codes
All commands return an XML response containing a 32-bit result code, and a description of the
result. Example:
<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<gauche version="1.0">
<response description="Succeeded" result="0"/>
</gauche>
Success results are non-negative values, while negative values indicate an error. Many errors
returned by LeftHand OS do not return ordinal values that can be conveniently mapped into an
10
Overview
API and CLI return code. In all cases, the error description string is returned, but it is not feasible
to return a sensible ordinate value (other than GaucheGeneralError) without parsing the description
string.
Result
Value
OS Status
Description
CliqSuccess
0
0
Everything succeeded normally
CliqNothingDone
1
1
Operation has succeeded, but nothing was done (the
system was already in the requested state).
CliqOperationPending
2
2
Operation has not failed, but is not yet complete. The
"handle" parameter contains a value that can be used
to query and cancel the operation.
CliqOperationAbandoned 3
3
Operation was cancelled or abandoned.
CliqNothingFound
4
4
Operation found no objects.
CliqSnapshotSet
5
5
This snapshot was a part of the snapshot set.
CliqVssSnapshotWarning
6
6
Warning: The writer operation failed.
CliqPITSnapshotWarning
7
7
Warning: Point in time snapshot is created.
CliqParameterIgnored
8
8
The operation succeeded but a parameter was ignored
as it is not applicable.
CliqUnexpected
0x80001001
128
An unexpected error has occurred.
CliqXmlError
0x80001002
129
The XML given is not well-formed.
CliqParameterFormat
0x80001003
130
The parameter is not specified correctly.
CliqParameterRepeat
0x80001004
131
A parameter is repeated.
CliqMissingMethod
0x80001005
132
The command method is missing.
CliqMissingParameter
0x80001006
133
One or more expected parameters are missing.
CliqUnrecognizedCommand 0x80001007
134
This command is unrecognized.
CliqUnrecognizedParameter 0x80001008
135
This parameter is unrecognized.
CliqIncompatibleParameters 0x80001009
136
Two or more parameters supplied are incompatible
with each other.
CliqNotYetImplemented
0x8000100A
137
This is a legal command, but it has not been
implemented yet.
CliqNoMemory
0x8000100B
138
Out of memory.
CliqVolumeNotFound
0x8000100C
139
Could not find the requested volume.
CliqVolumeInUse
0x8000100D
140
The requested volume is in use.
CliqVolumeInitFailure
0x8000100E
141
Volume initialization failed.
CliqUnrecognizedVolume
0x8000100F
142
The volume is an unrecognized type.
CliqOperationFailed
0x80001010
143
General LeftHand OS error - the operation failed.
CliqCredentialsFailed
0x80001011
144
The supplied credentials are incorrect.
CliqInvalidParameter
0x80001012
145
Invalid parameter.
CliqObjectNotFound
0x80001013
146
Object not found.
CliqConnectionFailure
0x80001014
147
Failed to connect to the API server.
CliqNotEnoughSpace
0x80001015
148
Not enough space to complete the command.
CliqNoManager
0x80001016
149
Could not find a manager.
Return codes
11
12
Result
Value
OS Status
Description
CliqSocketError
0x80001017
150
Network socket error.
CliqOperationTimedOut
0x80001018
151
Operation exceeded the specified timeout.
CliqNoPlatformSupport
0x80001019
152
This operating system type does not support the
operation.
CliqNoPlatformSupport
0x8000101A
153
This operating system version does not support the
operation.
CliqUtilityNotFound
0x8000101B
154
The utility command requested was not found.
CliqUtilityNotAllowed
0x8000101C
155
The utility command requested is not in the allowed list.
CliqUtilityIllegalParameter
0x8000101D
156
The utility command contains unsupported parameters
or redirection.
CliqUtilityFailed
0x8000101E
157
The utility command executed, but returned a non-zero
status code.
CliqNodeNotFound
0x8000101F
158
The specified storage system cannot be found.
CliqIllegalUsername
0x80001020
159
The username must be 3–40 characters, starting with
a letter.
CliqIllegalPassword
0x80001021
160
The password must be 5–40 characters, not / or :.
CliqFileError
0x80001022
161
General file error.
CliqMissingInitiator
0x80001023
162
No iSCSI initiator found.
CliqInitiatorStopped
0x80001024
163
The iSCSI initiator is not running.
CliqSanIqTooOld
0x80001025
164
The version of LeftHand OS software must be upgraded.
CliqDefaultAdmin
0x80001026
165
You cannot delete, modify permissions, or remove the
last user from the default administration group.
CliqVssProviderNotInstalled 0x80001027
166
The HP StoreVirtual VSS Provider is not installed.
CliqVssProviderNotRunning 0x80001028
167
The HP StoreVirtual VSS Provider is not running.
CliqVolumeNoSessions
0x80001029
168
Cannot create an application-managed snapshot
because there are no iSCSI connections associated
with this volume. To create application-managed
snapshots, there must be at least one application server
associated with the volume via an iSCSI connection.
The volume must be connected to a VSS-enabled server.
CliqVolumeMultipleSessions 0x8000102A
169
Cannot create an application-managed snapshot
because there is more than one IQN (iSCSI Qualified
Name) associated with this volume. To create
application-managed snapshots, there must be only
one application server associated with the volume.
CliqNoVssCapabilities
0x8000102B
170
Cannot create an application-managed snapshot
because the server does not support this capability.
CliqServerUnresponsive
0x8000102C
171
Cannot create an application-managed snapshot
because the system could not communicate to the
necessary software component on the application
server.
CliqVssSnapshotFailed
0x8000102D
172
Cannot create an application-managed snapshot
because the system could not quiesce the application
associated with this volume.
CliqVssLunInfoFailed
0x8000102E
173
Cannot create an application-managed snapshot
because the system failed to get LUN data.
Overview
Result
Value
OS Status
Description
CliqVssWriterUnavailable
0x8000102F
174
The VSS writer operation failed.
CliqSnapshotInProgress
0x80001030
175
Another app-managed snapshot is in progress.
CliqWindowsServerIsBusy
0x80001031
176
The application server is busy.
CliqUpdateVssProvider
0x80001032
177
This version of VSS provider must be upgraded.
CliqVssOperationTimedOut 0x80001033
178
VSS operation timed out.
CliqVolumeConnectionFailure 0x80001034
179
Volume connection failure.
CliqServerInCluster
0x80001035
180
Server is in Cluster and cannot be changed via CliQ.
CliqVolumeError
0x80001036
181
Volume error.
CliqVolumeNoServer
0x80001037
182
Failed to contact Application Aware Snapshot
Manager.
CliqUnsupportedApplication 0x80001038
183
This application is not supported.
CliqServerVersionMismatch 0x80001039
184
Server version is not compatible.
CliqSnapshotNameExists
0x8000103A
185
The snapshot with this name already exists.
CliqVolumeInvalidSet
0x8000103B
186
Invalid volume set.
CliqNoVirtualManager
0x8000103C
187
A Virtual Manager was not found.
CliqIllegalUserGroupName 0x8000103D
188
User group name must be 3–40 characters a–z, 0–9,
- or .; the first character must be a lowercase letter
(a-z).
CliqIllegalUserDescription
0x8000103E
189
Username must be 3–40 characters A–., a–z, 0–9, or .; the first character must be a letter (A–. or a-z).
CliqIllegalIQN
0x8000103F
190
IQN must be letters or numbers or the . or : characters.
CliqIllegalWWN
0x80001040
191
WWN must be 16 Hex letters or numbers (A-F, 0-9) or
the : character.
CliqHbaError
0x80001041
192
HBA status error.
CliqHbaNotSupported
0x80001042
193
HBA function not supported.
CliqHbaInvalidHandle
0x80001043
194
HBA function, invalid handle.
CliqHbaInvalidArgument
0x80001044
195
HBA function, bad argument.
CliqHbaIllegalWWN
0x80001045
196
WWN not recognized.
CliqHbaIllegalIndex
0x80001046
197
HBA function, Index not recognized.
CliqHbaMoreData
0x80001047
198
HBA function, larger buffer required.
CliqHbaStaleData
0x80001048
199
Information has changed since the last call to
HBA.RefreshInformation.
CliqHbaScsiCheckCondition 0x80001049
200
SCSI Check Condition reported.
CliqHbaBusy
0x8000104A
201
Adapter busy or reserved, retry may be effective.
CliqHbaTryAgain
0x8000104B
202
Request timed out, retry may be effective.
CliqHbaUnavailable
0x8000104C
203
Referenced HBA has been removed or deactivated.
CliqHbaElsReject
0x8000104D
204
The requested ELS was rejected by the local adapter.
CliqHbaInvalidLun
0x8000104E
205
The specified LUN is not provided by the specified
adapter.
Return codes
13
14
Result
Value
OS Status
Description
CliqHbaIncompatible
0x8000104F
206
An incompatibility has been detected among the library
and driver modules invoked which will cause one or
more functions in the highest version that all support to
operate incorrectly.
CliqHbaAmbitiousWWN
0x80001050
207
Multiple adapters have a matching WWN. This could
occur if the NodeWWN of multiple adapters is
identical.
CliqHbaLocalBus
0x80001051
208
A persistent binding request included a bad local SCSI
bus number.
CliqHbaLocalTarget
0x80001052
209
A persistent binding request included a bad local SCSI
target number.
CliqHbaLocalLun
0x80001053
210
A persistent binding request included a bad local SCSI
logical unit number.
CliqHbaLocalScsiIdBound
0x80001054
211
A persistent binding set request included a local SCSI
ID that was already bound.
CliqHbaTargetFcId
0x80001055
212
A persistent binding request included a bad or
unlocatable FCP Target FCID.
CliqHbaTargetNodeWWN 0x80001056
213
A persistent binding request included a bad FCP Target
Node WWN.
CliqHbaTargetPortWWN
0x80001057
214
A persistent binding request included a bad FCP Target
Port WWN.
CliqHbaTargetLun
0x80001058
215
A persistent binding request included an FCP Logical
Unit Number not defined by the identified Target.
CliqHbaTargetLuid
0x80001059
216
A persistent binding request included an undefined or
otherwise inaccessible Logical Unit Unique Identifier.
CliqHbaNoSuchBinding
0x8000105A
217
A persistent binding remove request included a binding
which did not match a binding established by the
specified port.
CliqHbaNotTarget
0x8000105B
218
A SCSI command was requested to an Nx.Port that
was not a SCSI Target Port.
CliqHbaUnsupportedFc4
0x8000105C
219
A request was made concerning an unsupported FC-4
protocol.
CliqHbaIncapable
0x8000105D
220
A request was made to enable unimplemented
capabilities for a port.
CliqHbaTargetBusy
0x8000105E
221
A SCSI function was requested at a time when issuing
the requested command would cause a SCSI
overlapped command condition (see SAM-3).
CliqHbaNotLoaded
0x8000105F
222
A call was made to HBA.FreeLibrary when no library
was loaded.
CliqHbaAlreadyLoaded
0x80001060
223
A call was made to HBA.LoadLibrary when a library
was already loaded.
CliqHbaIllegalFcid
0x80001061
224
The Address Identifier specified in a call to
HBA.SendRNIDV2 violates access control rules for that
call.
CliqHbaAscsiDevice
0x80001062
225
SCSI device.
CliqHbaInvalidProtocolType 0x80001063
226
Invalid protocol.
CliqHbaBadEventType
0x80001064
227
Bad event type.
CliqMissingCIMProperty
0x80001065
228
An expected CIM property value was not found.
Overview
Result
Value
OS Status
Description
CliqSANiQFeatureNotSupported 0x80001066
229
The requested feature or operation is not supported.
CliqParameterDeprecated
0x80001067
230
The '%s' parameter has been deprecated.
CliqNodeNotInGroup
0x80001068
231
Node must be in a management group.
CliqRemoteSnapshotNotFound 0x80001069
232
The snapshot was not found.
CliqMultipleIPAddresses
0x8000106A
233
Multiple IP addresses were encountered.
CliqUnsupportedFC
0x8000106B
234
This command is not supported for Fibre Channel.
CliqVolumeNotMounted
0x8000106C
235
The volume is not mounted on a server.
CliqMissingADParameter
0x8000106D
236
One or more Active Directory parameters entered are
incorrect or missing.
CliqIncorrectADServer
0x8000106E
237
The Active Directory server or possibly the BASEDN is
incorrect or does not match.
CliqLastAdminUser
0x8000106F
238
You cannot delete the last user who is in a
fully-permissioned group.
CliqOperationNotPermitted 0x80001070
239
The attempted operation is not permitted.
CliqUnsupportedParameter 0x80001071
240
A supplied parameter is unsupported on this
management group.
CliqVSSInvalidBackupDoc
0x80001072
241
The backup document file path is invalid.
CliqCredentialsMissing
0x80001073
242
Management group login credentials are not in the
credential cache on the controlling server.
CliqSizeTooLarge
0x80001074
243
The requested size is too large.
Return codes
15
2 Commands
addVirtualManager
Description
Add a virtual manager to a group.
Syntax
addVirtualManager {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter, you must
include the passWord parameter with it. Or, you can use the groupName parameter
instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use the userName
and passWord parameters. Because groupName has cached credentials, it does not
require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName parameter is used.
Example 1 Windows
cliq addVirtualManager login=10.0.1.2 userName=admin passWord=secret
Example 2 SSH
addVirtualManager
assignVolumeChap
Description
Assign a volume to a server. This assignment sets the access to a volume, using CHAP authentication.
Syntax
assignVolumeChap {login=} { userName= passWord= | groupName= } {volumeName=}
{targetSecret=} [namePrefix=] [accessRights=] [chapName=] [initiatorSecret=]
[vipLoadBalance=] [exclusiveAccess=]
Parameters
16
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
Commands
Name
Description
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{targetSecret}
The CHAP target secret for the volume.
[namePrefix]
A prefix string for newly created objects. A unique number value will be
concatenated to this prefix to guarantee name uniqueness.
[accessRights]
The access rights to the volume. Value are r—Read-only, x—No access, and
rw—Read-write (default).
[chapName]
The CHAP name for the volume. If this is not specified, the IQN of the local
server is used (this parameter is required if run on a storage system).
[initiatorSecret]
The CHAP initiator secret for the volume.
[vipLoadBalance]
Use VIP load balancing for this host. Values are 0—Disabled and 1—Enabled.
The default value is 1.
[exclusiveAccess]
Remove any previous server access rights to this volume. Values are
0—Disabled and 1—Enabled. The default value is 1.
Example 3 Windows
cliq assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret
login=10.0.1.2 userName=admin passWord=secret
Example 4 SSH
assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret
assignVolumeToServer
Description
Assign a volume to a server (use for either iSCSI or Fibre Channel).
Syntax
assignVolumeToServer {login=} { userName= passWord= | groupName= }
{volumeName=} {serverName=} [accessRights=] [transport=] [lun=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{serverName}
The name of the server.
assignVolumeToServer
17
Name
Description
[accessRights]
The access rights to the volume. Values are r—Read-only, x—No access,
and rw—Read-write (default).
[transport]
Set the communication path to iSCSI or Fibre Channel. Values are iSCSI and
FC. Lowercase is accepted.
[lun]
Set the LUN for the Fibre Channel attached volume. The value can be 1-255.
NOTE:
LUN 255 is not supported by Microsoft Windows.
Example 5 Windows
cliq assignVolumeToServer volumeName=TheVolume serverName=TheServer
login=10.0.1.2 userName=admin passWord=secret
Example 6 SSH
assignVolumeToServer volumeName=TheVolume serverName=TheServer
cacheCredentials
Description
Encrypt, cache, and associate the username/password with the management group name in the
registry. Thereafter, the management group name can be used instead of the username/password
for CLI command credentials. The credentials entered must have full administrative rights to the
management group.
NOTE: This command will test to verify that the credentials entered have full administrative rights
to the management group. If the login (IP address) is not provided, it will try to discover the
management group.
Syntax
cacheCredentials {userName=} {passWord=} {groupName=} [login=] [waitForData=]
Parameters
18
Name
Description
{userName}
The authentication user name for the storage system.
{passWord}
The password for the storage system.
{groupName}
The name of the management group.
[login]
The IP addresses or DNS-resolvable names of one or more storage systems.
[waitForData]
The number of milliseconds to wait for the discovery packets (the default is
5000ms if unspecified). On Windows, the default wait time can be adjusted
by setting the DWORD registry value
HKLM\Software\HP\StoreVirtual\MaxDiscoverWaitTimeInSeconds.
Commands
Example 7 Windows
cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret
OR
cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret
login=10.0.18.9
cancelRemoteSnapshot
Description
Cancel a remote snapshot.
Syntax
cancelRemoteSnapshot {login=} { userName= passWord= | groupName= }
{snapshotName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{snapshotName}
The name of the remote snapshot.
Example 8 Windows
cliq cancelRemoteSnapshot snapshotName=TheSnapshot login=10.0.1.2
userName=admin passWord=secret
Example 9 SSH
cancelRemoteSnapshot snapshotName=TheSnapshot
clearAlertsPolicy
Description
Clear the Alerts and Events Policy information.
Syntax
clearAlertsPolicy {login=} { userName= passWord= | groupName= }
cancelRemoteSnapshot
19
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 10 Windows
cliq clearAlertsPolicy login=10.0.1.3 userName=admin passWord=secret
Example 11 SSH
clearAlertsPolicy
clearCredentials
Description
Remove the association between a username/password pair and a management group name from
the registry cached credentials.
Syntax
clearCredentials {groupName=}
Parameters
Name
Description
{groupName}
The name of the management group.
Example 12 Windows
cliq clearCredentials groupName=TheGroup
clearADInfo
Description
Remove the active directory configuration from the management group.
Syntax
clearADInfo {login=} { userName= passWord= | groupName= }
20
Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 13 Windows
cliq clearADInfo login=10.0.1.3 userName=admin passWord=secret
Example 14 SSH
clearADInfo
clearDnsInfo
Description
Clear the DNS settings.
Syntax
clearDnsInfo {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
clearDnsInfo
21
Example 15 Windows
cliq clearDnsInfo login=10.0.1.3 userName=admin passWord=secret
Example 16 SSH
clearDnsInfo
clearEmailServerInfo
Description
Clear the email server settings.
Syntax
clearEmailServerInfo {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 17 Windows
cliq clearEmailServerInfo login=10.0.1.3 userName=admin passWord=secret
Example 18 SSH
clearEmailServerInfo
clearSnmpNotifyPolicy
Description
Clear the SNMP Notification Policy settings.
Syntax
clearSnmpNotifyPolicy {login=} { userName= passWord= | groupName= }
Parameters
22
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
Commands
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 19 Windows
cliq clearSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secret
Example 20 SSH
clearSnmpNotifyPolicy
clearSnmpServiceInfo
Description
Clear the SNMP Server information.
Syntax
clearSnmpServiceInfo {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 21 Windows
cliq clearSnmpServiceInfo login=10.0.1.3 userName=admin passWord=secret
Example 22 SSH
clearSnmpServiceInfo
clearVssVolumeFlags
Description
Clear all Volume Shadow Copy Service (VSS) snapshot information from the disk. This command
is only supported for Windows Server 2008 and higher.
Syntax
clearVssVolumeFlags {volumeName=}
clearSnmpServiceInfo
23
Parameters
Name
Description
{volumeName}
The name of the locally attached storage device (for example, E:). This is not
the name of the volume in the management group.
Example 23 Windows
cliq clearVssVolumeFlags volumeName=x:
cloneSnapshot
Description
Create one or more SmartClone volumes from a StoreVirtual snapshot. These SmartClone volumes
have all the functionality of normal volumes.
Syntax
cloneSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=}
{volumeName=} [description=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{snapshotName}
The name of the remote snapshot.
{volumeName}
The name of the volume in the management group.
[description]
Optional description
Example 24 Windows
cliq cloneSnapshot snapshotName=Snapshot1 volumeName=MyClone1;MyClone2
login=10.0.1.2 userName=admin passWord=secret
Example 25 SSH
cloneSnapshot snapshotName=Snapshot1 volumeName=MyClone1;MyClone2
configureRaid
Description
Reconfigure the RAID setting on a storage system. The storage system cannot be in a management
group.
24
Commands
Syntax
configureRaid {login=} { userName= passWord= | groupName= } {configuration=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{configuration}
The RAID type to set. The possible RAID levels are reported with the
getNsmInfo command.
Example 26 Windows
cliq configureRaid configuration="RAID 10" login=10.0.1.2 userName=admin
passWord=secret
Example 27 SSH
configureRaid configuration="RAID 10"
connectVolume
Description
Connect an already present array volume to an application server host (iSCSI only). For
FibreChannel, this command will only poll the local volumes for up to 1 minute to detect when the
volume is connected by the Windows PNP system.
Syntax
connectVolume {login=} { userName= passWord= | groupName= } {volumeName=}
[initiatorport=] [persistent=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
connectVolume
25
Name
Description
[initiatorport]
The iSCSI initiator IP outbound bind port number. If not specified, the default
value is any unused IP port.
[persistent]
Automatically restore the iSCSI connection when the computer starts up.
Example 28 Windows
cliq connectVolume volumeName=MyVolume login=10.1.2.3 userName=admin
passWord=secret
convertSnapshotTempSpace
Description
Convert snapshot temporary space to a volume.
Syntax
convertSnapshotTempSpace {login=} { userName= passWord= | groupName= }
{volumeName=} {snapshotName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{snapshotName}
The name of the remote snapshot.
Example 29 Windows
cliq convertSnapshotTempSpace snapshotName=MySnapshot
volumeName=NewVolume login=10.1.2.3 userName=admin passWord=secret
Example 30 SSH
convertSnapshotTempSpace snapshotName=MySnapshot volumeName=NewVolume
createAdminGroup
Description
Create an administrative group.
Syntax
createAdminGroup {login=} { userName= passWord= | groupName= }
{adminGroupName=} [description=] [adminUserName=] [permissions=] [adGroup=]
26
Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{adminGroupName}
The administrative group name.
[description]
Optional description
[adminUserName]
Specifies the users that this group comprises.
[permissions]
Permissions for the group. This is a character sequence specifying the
allowable permissions in the following order: Group, Network, Storage
System, Report. The Password permissions are subsumed by the Group
permissions. For each group, the allowable permissions are: r—Read- only,
w—Read-write (Report does not support this), and f—Full-access (Report does
not support this). An example is wwrr.
NOTE:
[adGroup]
If not specified, the permissions are set to rrrr.
The name of the associated active directory group.
Example 31 Windows
cliq createAdminGroup login=10.0.1.3 userName=admin passWord=secret
description="My shiny new group" adminGroupName=powerusers
adminUserName=user1;user2 permissions=fffr
Example 32 SSH
createAdminGroup description="My shiny new group"
adminGroupName=powerusers adminUserName=user1;user2 permissions=ffffr
createAdminUser
Description
Create an administrative user.
Syntax
createAdminUser {login=} { userName= passWord= | groupName= }
{adminUserName=} {adminPassWord=} [description=] {adminGroupName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
createAdminUser
27
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{adminUserName}
Specifies the users that this group comprises.
{adminPassWord}
The password for the administrative user.
[description]
Optional description
{adminGroupName}
The administrative group name.
Example 33 Windows
cliq createAdminUser login=10.0.1.3 userName=admin passWord=secret
description="My shiny new user" adminUserName=user adminPassWord=secret
adminGroupName="Full Administrator"
Example 34 SSH
createAdminUser description="My shiny new user" adminUserName=user
adminPassWord=secret adminGroupName="Full Administrator"
createCluster
Description
Create a cluster in a management group.
Syntax
createCluster {login=} { userName= passWord= | groupName= } {clusterName=}
{node=} [description=] [useVip=] [vip=] [SpaceReclaimWarn=] [SpaceReclaimCrit=]
Parameters
28
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{clusterName}
The name of the cluster.
{node}
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
[description]
Optional description
[useVip]
Use virtual IP (VIP) addressing. Values are 0 or 1 (default).
Commands
Name
Description
[vip]
A delimited list of virtual IP address or DNS-resolvable name and subnet
mask.
NOTE: Since each VIP contains two parameters, IP address and subnet
mask, both must be specified in order, even if empty. If multiple VIPs are
entered, they must be on different subnets.
[SpaceReclaimWarn]
Sets the percentage of allocated pages that will trigger a warning to the host
that storage system space is almost full. The default is 90.
[SpaceReclaimCrit]
Sets the percentage of allocated pages that will trigger an alarm to the host
that storage system space is critical. The default is 95. Once the alarm
threshold is reached, no writes can be performed.
Example 35 Windows
cliq createCluster login=10.0.1.3 userName=admin passWord=secret
clusterName=TheCluster description="My shiny new cluster" useVip=1
node=10.1.2.4 vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0
Example 36 SSH
createCluster clusterName=TheCluster description="My shiny new cluster"
useVip=1 node=10.1.2.4
vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0
createEmailNotifyPolicy
Description
Configure which level of events from the management group are sent via email to the designated
recipients.
Syntax
createEmailNotifyPolicy {login=} { userName= passWord= | groupName= }
{email=} [verbosity=] { alertOnInfo= | alertOnWarning= | alertOnCritical=
} [emailLocale=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{email}
The email address of the recipient.
[verbosity]
The level of returned information via email notification. Values are 1—Brief,
2—Standard, and 3—Verbose.
createEmailNotifyPolicy
29
Name
Description
{alertOnInfo}
{alertOnCritical}
Values are 0—Email will not be sent on informational events, warning events,
and critical events and 1—Email will be sent for informational events, warning
events, and critical events. The default is 0 for
createEmailNotifyPolicy. Either alertOnInfo, alertOnWarning,
or alertOnCritical must be specified or the command will be rejected.
[emailLocale]
English (default), Chinese, Japanese, Korean, Spanish
{alertOnWarning}
Example 37 Windows
cliq createEmailNotifyPolicy login=10.0.1.3 userName=admin
passWord=secret [email protected] alertOnWarning=1
Example 38 SSH
createEmailNotifyPolicy [email protected] alertOnWarning=1
createGroup
Description
Create a new management group. This command may take several minutes to complete.
NOTE: You cannot create a split network configuration when using the createGroup command
to create a management group. You must create the split network configuration after the
management group is created.
Syntax
createGroup {groupName=} {node=} {groupName=} {userName=} {passWord=}
Parameters
Name
Description
{node}
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
{groupName}
The name of the management group.
{userName}
The authentication user name for the storage system.
{passWord}
The password for the storage system.
Example 39 Windows
cliq createGroup groupName=TheGroup node=10.1.2.3;10.1.2.4 userName=admin
passWord=secret
Example 40 SSH
createGroup groupName="MG2" node=10.1.2.3;10.1.2.4 userName=admin
passWord=secret
createQuorumWitness
Description
Configure the Quorum Witness process on both nodes in a two-node management group.
30
Commands
Syntax
createQuorumWitness {login=} { userName= passWord= | groupName= }
{fileSharePath=} [fileShareFilename=] [fileShareUsername=]
[fileSharePassword=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{username}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use the
userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName or passWord parameters.
{passWord}
The password for the storage system. Required when the userName parameter
is used.
{fileSharePath}
The path to the file share (or shared disk) to which both nodes will have access.
This shared disk runs the LeftHand OS software, which now includes the
Quorum Witness process.
NOTE: The path to the file share (or shared disk) should be on a separate
network and not use the interconnect between the nodes in the management
group.
[fileShareFilename]
The file name of the file share.
[fileShareUsername]
The user name used to access the file share.
[fileSharePassword]
The password used to access the file share.
Example 41 Windows
cliq createQuorumWitness login=10.0.23.65 userName=admin passWord=secret
fileSharePath="10.2.13.48:/data/tnq_dir"
fileShareFilename="Quorum_Witness_201409160830"
fileShareUsername=Administrator fileSharePassword=sawt00th
Example 42 SSH
createQuorumWitness fileSharePath="10.2.13.48:/data/tnq_dir"
fileShareFilename="Quorum_Witness_201409160830"
fileShareUsername=Administrator fileSharePassword=sawt00th
createRemoteAssociation
Description
Create a remote group-to-primary group association. This association is done automatically when
a remote snapshot is created, so this command is not usually needed.
Syntax
createRemoteAssociation {login=} { userName= passWord= | groupName= }
{remote=} [remoteUserName=] [remotePassWord=] [primaryBandwidth=]
[remoteBandwidth=] [remotegroupname=]
createRemoteAssociation
31
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{remote}
The IP address or DNS-resolvable names of one or more remote storage
system.
[remoteUserName]
The authentication user name for the remote group.
[remotePassWord]
The password for the remote group.
[primaryBandwidth]
The bandwidth used in a copy from the primary group to the remote group.
Values are:
• Kb—Kilobits/sec (1000 Bits/second)
• Mb—Megabits/sec (1000 Kilobits/second)
• Gb—Gigabits/sec (1000 Megabits/second)
[remoteBandwidth]
The bandwidth used in a copy from the remote group to the primary group.
Values are:
• Kb—Kilobits/sec (1000 Bits/second)
• Mb—Megabits/sec (1000 Kilobits/second
• Gb—Gigabits/sec (1000 Megabits/second)
[remotegroupname]
The name of the remote management group. This parameter only applies
when using the Windows CLI.
Example 43 Windows
cliq createRemoteAssociation login=10.0.1.2 userName=admin
passWord=secret remote=10.0.1.3 remoteUserName=admin
remotePassWord=secret primaryBandwidth=10Mb remoteBandwidth=10Mb
Example 44 SSH
createRemoteAssociation remote=10.0.1.3 remoteUserName=admin
remotePassWord=secret primaryBandwidth=10Mb remoteBandwidth=10Mb
createRemoteSnapshot
Description
Create a remote snapshot of a StoreVirtual volume.
Syntax
createRemoteSnapshot {login=} { userName= passWord= | groupName= } {remote=}
[remoteUserName=] [remotePassWord=] [remotegroupname=] {primarySnapshot=}
{remoteCluster=} {remoteVolume=} {remoteSnapshot=} [description=]
[primaryBandwidth=] [remoteBandwidth=]
32
Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{remote}
The IP address or DNS-resolvable names of one or more remote storage
system
[remoteUserName]
The authentication user name for the remote group.
[remotePassWord]
The password for the remote group.
[remotegroupname]
The name of the remote management group to identify cached credentials
(from Authentication Console) to use instead of
remoteUserName/remotePassWord parameters. This parameter only
applies when using the Windows CLI.
{primarySnapshot}
The name of the local snapshot to remote copy.
{remoteCluster}
The name of the remote cluster to host the remote volume.
{remoteVolume}
The name of the remote volume to host the snapshot.
{remoteSnapshot}
The name of the remote snapshot to create.
[description]
Optional description.
[primaryBandwidth]
The bandwidth used in a copy from the primary group to the remote group.
Values are:
• Kb—Kilobits/sec (1000 Bits/second)
• Mb—Megabits/sec (1000 Kilobits/second)
• Gb—Gigabits/sec (1000 Megabits/second)
[remoteBandwidth]
The bandwidth used in a copy from the remote group to the primary group.
Values are:
• Kb—Kilobits/sec (1000 Bits/second)
• Mb—Megabits/sec (1000 Kilobits/second)
• Gb—Gigabits/sec (1000 Megabits/second)
createRemoteSnapshot
33
Example 45 Windows
cliq createRemoteSnapshot login=10.1.2.3 userName=admin passWord=secret
primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0 remoteVolume=Volume0
description="Exchange DB-1" remote=10.1.2.4 remoteUserName=admin
remotePassWord=secret remoteCluster="10.0.1.21"
Example 46 SSH
createRemoteSnapshot primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0
remoteVolume=Volume0 description="Exchange DB-1" remote=10.1.2.4
remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.21"
createServer
Description
Create a representation of a client server in a management group. This “server” can be associated
with iSCSI or Fibre Channel initiators and be granted access to volumes.
Syntax
createServer {login=} { userName= passWord= | groupName= } {serverName=}
[description=] [allowiSCSIAccess=] [vipLoadBalance=] [useCHAP=] [initiator=]
[targetSecret=] [chapName=] [initiatorSecret=] [controllingserver=]
[allowfcaccess=] [wwpn=] [bootvolumelun=] [bootvolumename=]
Parameters
34
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{serverName}
The name of the server.
[description]
Optional description
[allowiSCSIAccess]
Allow iSCSI access for this host. Values are 0—Disable and 1—Enable. If
volumes are attached to a client server via iSCSI and a value of 0 is entered,
the client server will lose its ability to communicate with the attached volumes.
If an IQN is entered and Fibre Channel is NOT configured, the default will
be 1, otherwise no default will be selected.
[vipLoadBalance]
Use VIP load balancing for this host. Values are 0—Disabled and 1—Enabled.
The default value is 1.
useCHAP
Use CHAP Authentication for this host. Values are 0—Disabled and
1—Enabled.
[initiator]
A semicolon delimited string of host IQNs. Valid characters are any letter,
number, international character or the-, ., and : characters.
targetSecret
The CHAP target secret for the volume.
Commands
Name
Description
[chapName]
The CHAP name for the volume. If this is not specified, the IQN of the local
server is used (this parameter is required if run on a storage system).
[initiatorSecret]
The CHAP initiator secret for the volume.
[controllingserver]
Enter the IP address of the client server that has Application Aware Snapshot
Manager (AASM) installed on it. It will coordinate the snapshot with the
applications using SAN volumes. This is required for managed snapshots of
Fibre Channel connected volumes. This is also required for VMware managed
snapshots, enter the Virtual Center Server IP address.
[allowfcaccess]
Allow Fibre Channel ports to be assigned to the client. Values are 0—Disable
and 1—Enable. If volumes are attached to a client server via Fibre Channel
and a value of 0 is entered, the client will lose its ability to communicate with
the attached volumes.
[wwpn]
A semicolon delimited list of the unique World Wide Port Name for one or
more Fibre Channel ports. Expected WWPN formatting is 16 Hex characters
with or without the : character as a delimiter (for example,
20:21:00:0E:B3:01:AB:C6 or 2021000EB301ABC6). Lower case hex
characters a–f are also accepted.
[bootvolumelun]
The LUN (1–255) of the boot volume. Valid only for a Fibre Channel attached
volume. If present, then bootvolumename must also be specified.
NOTE:
[bootvolumename]
LUN 255 is not supported by Microsoft Windows.
The volume name of the boot volume. Valid only for a Fibre Channel attached
volume. If present, then bootvolumelun must also be specified.
Example 47 Windows
cliq createServer serverName=TheServer useCHAP=0
initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.mynetworks.com
login=10.0.1.2 userName=admin passWord=secret
Example 48 SSH
createServer serverName=TheServer useCHAP=0
initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.myworks.com
createSite
Description
Create a site in a multi-site SAN.
Syntax
createSite {login=} { userName= passWord= | groupName= } {siteName=}
[description=] [primary=] [node=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
createSite
35
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{siteName}
The name of the site.
[description]
Optional description
[primary]
This site is the primary site. Values are 0—Disabled and 1—Enabled. 1 is
the default.
[node]
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
Example 49 Windows
cliq createSite siteName=Headquarters login=10.0.1.2 userName=admin
passWord=secret
Example 50 SSH
createSite siteName=Headquarters
createSnapshot
Description
Create a snapshot of one or more StoreVirtual volumes.
Syntax
createSnapshot {login=} { userName= passWord= | groupName= } {volumeName=}
{snapshotName=} [description=] [inheritAccess=] [managed=] [wait=]
Parameters
36
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{snapshotName}
The name of the remote snapshot.
[description]
Optional description
[inheritAccess]
Values are 0—The snapshot will not inherit the volume list, authentication
group, ACL relationships of the original volume (default) and 1—The snapshot
will inherit the volume list, authentication group, ACL relationships of the
original volume.
Commands
Name
Description
[managed]
Values are 0—The snapshot(s) will not attempt to use VSS on the host
connected to the volume (default) and 1—The snapshot(s) will attempt to use
VSS on the host connected to the volume.
[wait]
Determines whether to wait for the application managed snapshot process
to complete or not. Values are 0—Do not wait and 1—Wait for it to complete
(default).
Example 51 Windows
cliq createSnapshot volumeName=volume0;volume1
snapshotName=snapshot0;snapshot1 login=10.0.1.2 userName=admin
passWord=secret
Example 52 SSH
createSnapshot volumeName=volume0;volume1
snapshotName=snapshot0;snapshot1
createSnapshotSchedule
Description
Create a local or remote snapshot schedule.
Syntax
createSnapshotSchedule {login=} { userName= passWord= | groupName= }
{volumeName=} {scheduleName=} {recurperiod=} {starttime=} [description=]
[retentioncount=] [retentionseconds=] [remoteip=] [remoteUserName=]
[remotePassWord=] [remoteCluster=] [remoteVolume=] [remoteretentioncount=]
[remoteretentionseconds=] [managed=] [remotegroupname=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{scheduleName}
The name of the schedule
{recurperiod}
The recurrence frequency of the snapshots, specified in seconds. Period may
be 0 to indicate the schedule never occurs, otherwise Period must be at least
1800 seconds (30 minutes).
{starttime}
The start time of the schedule. Specified as ISO 8601. Format is
YYYY-MM-DDTHH:MM:SSZ. YYYY represents the year, MM is the month,
DD is the day of the month, HH is the hour in 24 hour format, MM is the
minutes, SS is the seconds. The time must always be expressed in UTC time.
createSnapshotSchedule
37
38
Name
Description
[description]
Optional description
[retentioncount]
The number of snapshots to maintain. Must be between 1 and 50. Either
retentioncount or retentionseconds must be specified.
[retentionseconds]
How long snapshots should be retained. Either retentioncount or
retentionseconds must be specified.
[remoteip]
The IP address of the remote group.
[remoteUserName]
The authentication user name for the remote group.
[remotePassWord]
The password for the remote group.
[remoteCluster]
The name of the remote cluster to host the remote volume.
[remoteVolume]
The name of the remote volume to host the snapshot.
[remoteretentioncount]
The number of remote snapshots to maintain. Must be between 1 and 50.
Either remoteretentioncount or remoteretentionseconds must
be specified.
[remoteretentionseconds]
How long remote snapshots should be retained. Either
remoteretentioncount or remoteretentionseconds must be
specified.
[managed]
Values are 0—The snapshot(s) will not attempt to use VSS on the host
connected to the volume (default) and 1—The snapshot(s) will attempt to use
VSS on the host connected to the volume.
[remotegroupname]
The name of the remote management group. This parameter only applies
when using the Windows CLI.
Commands
Example 53 Windows (local snapshot schedule)
cliq createSnapshotSchedule scheduleName="schedule0" description="First
snapshot schedule" starttime="2007-06-15T01:01:00Z" recurperiod="3600"
volumeName="volume0" remoteVolume="volume0" retentioncount=5
login="10.0.1.3" userName="admin" passWord="secret"
Example 54 Windows (remote snapshot schedule)
cliq createSnapshotSchedule scheduleName="schedule0"
starttime="2014-12-09T15:03:00Z" recurperiod="1800" volumeName="volume0"
remoteVolume="volume0" retentioncount=5 remoteip="10.254.114.160"
remoteUserName="admin" remotePassWord="secret"
remoteCluster="Cluster_Name" remoteretentioncount=3 login="10.0.1.3"
userName="admin" passWord="secret"
Example 55 SSH (local snapshot schedule)
createSnapshotSchedule scheduleName="schedule0" description="First
snapshot schedule" starttime="2007-06-15T01:01:00Z" recurperiod="3600"
volumeName="volume0" remoteVolume="volume0" retentioncount=5"
Example 56 SSH (remote snapshot schedule)
createSnapshotSchedule scheduleName="schedule0"
starttime="2014-12-09T15:03:00Z" recurperiod="1800" volumeName="volume0"
remoteVolume="volume0" retentioncount=5 remoteip="10.254.114.160"
remoteUserName="admin" remotePassWord="secret"
remoteCluster="Cluster_Name" remoteretentioncount=3
createSnmpCommunityString
Description
Create an SNMP community string. The community string must be the same for all. If no item exists,
the community string is used, otherwise it is ignored and the community string of existing items is
used. Either specify the IP address (IP address or host name) or an IP mask and IP subnet.
Syntax
createSnmpCommunityString {login=} { userName= passWord= | groupName= }
[communityString=] [ipAddress=] [ipMask=] [ipSubnet=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{communityString}
The SNMP community string.
createSnmpCommunityString
39
Name
Description
[ipAddress]
The IP address or host name of the SNMP server.
[ipMask]
An IP address mask for SNMP notification.
[ipSubnet]
An IP address subnet for SNMP notification.
Example 57 Windows
cliq createSnmpCommunityString login=10.0.1.3 userName=admin
passWord=secret ipAddress=10.0.10.25 communityString=NewString
Example 58 SSH
createSnmpCommunityString ipAddress=10.0.10.25 communityString=NewString
createSnmpTrapTarget
Description
Create an SNMP trap target. The community string must be the same for all trap targets. If no trap
targets exist, the community string is used, otherwise it is ignored and the community string of
existing trap targets is used.
Syntax
createSnmpTrapTarget {login=} { userName= passWord= | groupName= }
{ipAddress=} {version=} {communityString=}
Parameters
40
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{ipAddress}
The IP address or host name of the SNMP server.
{version}
The SNMP version. Values are 1—Version 1 and 2—Version 2.
{communityString}
The SNMP community string.
Commands
Example 59 Windows
cliq createSnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret
ipAddress=10.0.10.25 version=1 communityString=TrapString
Example 60 SSH
createSnmpTrapTarget ipAddress=10.0.10.25 version=1
communityString=TrapString
createSyslogNotifyPolicy
Description
Create a Syslog Notification Policy.
Syntax
createSyslogNotifyPolicy {login=} { userName= passWord= | groupName= }
{ipAddress=} { alertOnInfo= | alertOnWarning= | alertOnCritical= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{ipAddress}
The IP address or host name of the Syslog server.
{alertOnInfo}
Values are 0—The log does not include informational events, warning events,
and critical events and 1—The log includes informational events, warning
events, and critical events. The default is 0 for
createSyslogNotifyPolicy. Either alertOnInfo, alertOnWarning,
or alertOnCritical must be specified or the command will be rejected.
{alertOnWarning}
{alertOnCritical}
createSyslogNotifyPolicy
41
Example 61 Windows
cliq createSyslogNotifyPolicy login=10.0.1.3 userName=admin
passWord=secret ipAddress="10.0.10.25" alertOnCritical="1"
alertOnWarning=1
Example 62 SSH
createSyslogNotifyPolicy ipAddress="10.0.10.25" alertOnCritical="1"
alertOnWarning=1
createVolume
Description
Create a SAN volume without connecting to a host.
CAUTION:
Enabling checksums may impact volume I/O performance.
Syntax
createVolume {login=} { userName= passWord= | groupName= } {volumeName=}
{clusterName=} {size=} [description=] [replication=] [parity=] [checkSum=]
[thinProvision=] [adaptiveOptimization=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{clusterName}
The name of the cluster.
{size}
The size of the volume, with units specified:
• <n> KB – n Kilobytes (1024 bytes)
• <n> MB – n Megabytes (1024 Kilobytes)
• <n> GB – n Gigabytes (1024 Megabytes)
• <n> TB – n Terabytes (1024 Gigabytes)
• <n> PB – n Petabytes (1024 Terabytes)
[description]
Optional description
[replication]
The replication level for the volume. Values are 1, 2, 3, and 4.
[parity]
The number of parity storage systems for the data on this volume. This enables
parity network RAID on the volume. Replication and parity are supported in
the following combinations:
• replication:1, parity:0 Network RAID-0 (None)
• replication:2, parity:0 Network RAID-10 (2-way Mirror)
42
Commands
Name
Description
• replication:3, parity:0 Network RAID-10+1 (3-way Mirror)
• replication:4, parity:0 Network RAID-10+2 (4-way Mirror)
• replication:2, parity:1 Network RAID-5 (Single parity)
• replication:3, parity:2 Network RAID-6 (Dual Parity)
[checkSum]
Values are 0—The volume does not use checksums and 1—The volume uses
checksums.
[thinProvision]
Enable or disable thin provisioning. Values are 0—The volume does not use
thin provisioning and 1—The volume is thin-provisioned (in a thinly
provisioned volume, reserve may be < length).
[adaptiveOptimization]
Enable or disable adaptive optimization. Values are 0—Disable and
1—Enable. 1 is the default.
Example 63 Windows
cliq createVolume volumeName=MyVolume clusterName=TheCluster size=100GB
description="Exchange DB-1" login=10.0.1.2;10.0.1.3 userName=admin
passWord=secret
Example 64 SSH
createVolume volumeName=MyVolume clusterName=TheCluster size=100GB
description="Exchange DB-1"
deleteAdminGroup
Description
Delete an administrative group.
Syntax
deleteAdminGroup {login=} { userName= passWord= | groupName= }
{adminGroupName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{adminGroupName}
The administrative group name.
deleteAdminGroup
43
Example 65 Windows
cliq deleteAdminGroup login=10.0.1.3 userName=admin passWord=secret
adminGroupName=powerusers
Example 66 SSH
deleteAdminGroup adminGroupName=powerusers
deleteAdminUser
Description
Delete an administrative user. The last administrator user ID of the default administrative group
cannot be removed.
Syntax
deleteAdminUser {login=} { userName= passWord= | groupName= }
{adminUserName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{adminUserName}
Specifies the users that this group comprises.
Example 67 Windows
cliq deleteAdminUser login=10.0.1.3 userName=admin passWord=secret
adminUserName=user
Example 68 SSH
deleteAdminUser adminUserName=user
deleteAutoMountPolicy
Description
Delete the auto-mount policy for the HP StoreVirtual Recovery Manager application on this computer.
Either the groupName and volumeName parameters or the All parameter must be specified
when using this command. Using the command without any parameters will result in an error.
Syntax
deleteAutoMountPolicy [groupName=] [volumeName=] [All=]
44
Commands
Parameters
Name
Description
[groupName]
The name of the management group.
[volumeName]
The name of the volume in the management group.
[All]
Deletes all auto-mount policies on this computer. The value is 1.
Example 69 Windows
cliq deleteAutoMountPolicy groupName="MG2" volumeName="Vol1"
deleteCluster
Description
Delete a cluster. All storage systems are removed.
Syntax
deleteCluster {login=} { userName= passWord= | groupName= } {clusterName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{clusterName}
The name of the cluster.
Example 70 Windows
cliq deleteCluster clusterName=TheCluster login=10.1.2.3 userName=admin
passWord=secret
Example 71 SSH
deleteCluster clusterName=TheCluster
deleteEmailNotifyPolicy
Description
Delete an Email Notification Policy. The designated recipient will no longer receive emails from
management group alerts.
Syntax
deleteEmailNotifyPolicy {login=} { userName= passWord= | groupName= }
{email=}
deleteCluster
45
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{email}
The email address of the recipient.
Example 72 Windows
cliq deleteEmailNotifyPolicy [email protected] login=10.1.2.3
userName=admin passWord=secret
Example 73 SSH
deleteEmailNotifyPolicy [email protected]
deleteGroup
Description
Delete a management group. All storage systems are removed.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
deleteGroup {login=} {userName=} {passWord=} {groupName=}
Parameters
46
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system.
{passWord}
The password for the storage system.
{groupName}
The name of the management group.
Commands
Example 74 Windows
cliq deleteGroup login=10.1.2.3 userName=admin passWord=secret
groupName="MG2"
Example 75 SSH
deleteGroup groupName="MG2"
deleteQuorumWitness
Description
Stop the Quorum Witness process on both nodes in a two-node management group.
NOTE: If the storage system used by the management group is down when issuing this command,
the command will fail because doing so will result in a loss of quorum. Retry the command when
the storage system is working properly.
Syntax
deleteQuorumWitness {login=} { userName= passWord= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{username}
The authentication user name for the storage system.
{passWord}
The password for the storage system.
Example 76 Windows
cliq deleteQuorumWitness login=10.0.23.65 userName=admin passWord=secret
Example 77 SSH
deleteQuorumWitness login=10.0.23.65 userName=admin passWord=secret
deleteRemoteAssociation
Description
Delete a remote group to primary group association.
Syntax
deleteRemoteAssociation {login=} { userName= passWord= | groupName= }
{remote=} [remoteUserName=] [remotePassWord=] [remotegroupname]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
deleteQuorumWitness
47
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{remote}
The IP address or DNS-resolvable names of one or more remote storage
system.
[remoteUserName]
The authentication user name for the remote group.
[remotePassWord]
The password for the remote group.
[remotegroupname]
The name of the remote management group. This parameter only applies
when using the Windows CLI.
Example 78 Windows
cliq deleteRemoteAssociation login=10.0.1.2 userName=admin
passWord=secret remote=10.0.1.3 remoteUserName=admin
remotePassWord=secret
Example 79 SSH
deleteRemoteAssociation remote=10.0.1.3 remoteUserName=admin
remotePassWord=secret
deleteServer
Description
Delete a server.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
deleteServer {login=} { userName= passWord= | groupName= } {serverName=}
Parameters
48
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
Commands
Name
Description
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{serverName}
The name of the server.
Example 80 Windows
cliq deleteServer serverName=MyServer login=10.1.2.3 userName=admin
passWord=secret
Example 81 SSH
deleteServer serverName=MyServer
deleteSite
Description
Delete a site in a multi-site SAN.
Syntax
deleteSite {login=} { userName= passWord= | groupName= } {siteName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{siteName}
The name of the site.
deleteSite
49
Example 82 Windows
cliq deleteSite siteName=Headquarters login=10.1.2.3 userName=admin
passWord=secret
Example 83 SSH
deleteSite siteName=Headquarters
deleteSnapshot
Description
Delete a snapshot.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
deleteSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{snapshotName}
The name of the remote snapshot.
Example 84 Windows
cliq deleteSnapshot snapshotName=Snapshot0 login=10.1.2.3 userName=admin
passWord=secret
Example 85 SSH
deleteSnapshot snapshotName=Snapshot0
deleteSnapshotSchedule
Description
Delete a previously created snapshot schedule.
50
Commands
Syntax
deleteSnapshotSchedule {login=} { userName= passWord= | groupName= }
{scheduleName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{scheduleName}
The name of the schedule.
Example 86 Windows
cliq deleteSnapshotSchedule scheduleName="Exchange Backup" login=10.1.2.3
userName=admin passWord=secret
Example 87 SSH
deleteSnapshotSchedule scheduleName="Exchange Backup"
deleteSnapshotTempSpace
Description
Delete the snapshot temporary space.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
deleteSnapshotTempSpace {login=} { userName= passWord= | groupName= }
{snapshotName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
deleteSnapshotTempSpace
51
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{snapshotName}
The name of the remote snapshot.
Example 88 Windows
cliq deleteSnapshotTempSpace snapshotName=TheSnapshot login=10.1.2.3
userName=admin passWord=secret
Example 89 SSH
deleteSnapshotTempSpace snapshotName=TheSnapshot
deleteSnmpCommunityString
Description
Delete an SNMP community string. Either specify an IP address (as IP address or host name) or IP
mask and IP subnet.
Syntax
deleteSnmpCommunityString {login=} { userName= passWord= | groupName= }
[ipAddress=] [ipMask=] [ipSubnet=]
Parameters
52
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[ipAddress]
This is the IP address or host name of the SNMP server.
[ipMask]
An IP address mask for SNMP notification.
[ipSubnet]
An IP address subnet for SNMP notification.
Commands
Example 90 Windows
cliq deleteSnmpCommunityString ipAddress=10.0.10.25 login=10.1.2.3
userName=admin passWord=secret
Example 91 SSH
deleteSnmpCommunityString ipAddress=10.0.10.25
deleteSnmpTrapTarget
Description
Delete an SNMP trap target.
Syntax
deleteSnmpTrapTarget {login=} { userName= passWord= | groupName= }
{ipAddress=} {version=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{ipAddress}
This is the IP address or host name of the SNMP server.
{version}
The SNMP version. Values are 1—Version 1 and 2—Version 2.
Example 92 Windows
cliq deleteSnmpTrapTarget ipAddress=10.10.10.25 login=10.1.2.3
userName=admin passWord=secret version=2
Example 93 SSH
deleteSnmpTrapTarget ipAddress=10.10.10.25 version=2
deleteSyslogNotifyPolicy
Description
Delete a Syslog Notification Policy.
Syntax
deleteSyslogNotifyPolicy {login=} { userName= passWord= | groupName= }
{ipAddress=}
deleteSnmpTrapTarget
53
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{ipAddress}
This is the IP address or host name of the Syslog server.
Example 94 Windows
cliq deleteSyslogNotifyPolicy ipAddress=10.10.10.25 login=10.1.2.3
userName=admin passWord=secret
Example 95 SSH
deleteSyslogNotifyPolicy ipAddress=10.10.10.25
deleteVirtualManager
Description
Delete a virtual manager from a group.
Syntax
deleteVirtualManager {login=} { userName= passWord= | groupName= }
Parameters
54
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Commands
Example 96 Windows
cliq deleteVirtualManager login=10.1.2.3 userName=admin passWord=secret
Example 97 SSH
deleteVirtualManager
deleteVolume
Description
This command forcibly deletes a StoreVirtual volume without disconnecting from the host.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
deleteVolume {login=} { userName= passWord= | groupName= } {volumeName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
Example 98 Windows
cliq deleteVolume volumeName=MyVolume login=10.1.2.3 userName=admin
passWord=secret
Example 99 SSH
deleteVolume volumeName=MyVolume
disconnectLocalVolume
Description
Disconnect a StoreVirtual volume from the host. This command is only supported for iSCSI.
Syntax
disconnectLocalVolume {volumeName=}
deleteVolume
55
Parameters
Name
Description
{volumeName}
The drive letter or mount point on the host for the volume.
Example 100 Windows
cliq disconnectLocalVolume volumeName=z:
discoverTcp
Description
Discover storage systems and management groups on the network, using TCP.
Syntax
discoverTCP {node=} [groupOrder=] [receivePort=] [waitForData=]
Parameters
Name
Description
{node}
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
[groupOrder]
Return storage systems ordered by group membership. Values are 0—Default
or 1.
[receivePort]
The TCP port to receive the discovery packets (defaults to an unused port if
unspecified).
[waitForData]
The number of milliseconds to wait for the discovery packets (the default is
5000ms if unspecified). On Windows, the default wait time can be adjusted
by setting the DWORD registry value in
HKLM\Software\HP\StoreVirtual\MaxDiscoverWaitTimeInSeconds.
Example 101 Windows
cliq discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4
Example 102 SSH
discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4
discoverUdp
Description
Discover storage systems and management groups on the network, using UDP.
Syntax
discoverUdp {ipMask=} {ipSubnet=} [groupOrder=] [receivePort=] [waitForData=]
56
Commands
Parameters
Name
Description
{ipMask}
An IP address mask for SNMP notification.
{ipSubnet}
An IP address subnet for SNMP notification.
[groupOrder]
Return storage systems ordered by group membership. Values are 0—Default
or 1.
[receivePort]
The TCP port to receive the discovery packets (defaults to an unused port if
unspecified).
[waitForData]
The number of milliseconds to wait for the discovery packets (the default is
5000ms if unspecified). On Windows, the default wait time can be adjusted
by setting the DWORD registry value in
HKLM\Software\HP\StoreVirtual\MaxDiscoverWaitTimeInSeconds.
Example 103 Windows
cliq discoverUdp ipMask=255.255.240.0 ipSubnet=10.0.0.0
Example 104 SSH
discoverUdp ipMask=255.255.240.0 ipSubnet=10.0.0.0
dismountVolume
Description
Dismount the volume.
Syntax
dismountVolume {mountPoint=}
Parameters
Name
Description
{mountPoint}
The drive letter or mount point on the host for the volume.
Example 105 Windows
cliq dismountVolume mountPoint="c:\hp storevirtual recovery
snapshots\bbmg1\clvol-01_sch_ss_1.1271"
Example 106 SSH
dismountVolume mountPoint="I:"
findADInfo
Description
Query the management group for information about the associated AD domain.
Syntax
findADInfo {login=} { userName= passWord= | groupName= } [hostName=]
[adUserName=] [ldaps=]
dismountVolume
57
Parameters
58
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[hostName]
The name or IP address of an active directory server. When you specify host
name in the query, BASEDN is returned for this server. The name must be
specified in the following format: ldap://10.10.10.10.
[adUserName]
An active directory user name. When you specify it, a list of active directory
groups that the user belongs to is returned.
[ldaps]
Use a secure LDAP connection. Set it to false to change; the default is true.
Commands
Example 107 Windows
CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 hostname=ldap://10.21.66.9
HP StoreVirtual LeftHand OS Command Line Interface, vxx.x.x.x (C) Copyright 20xx-20xx Hewlett-Packard Development
Company, L.P.
RESPONSE
result
processingTime
name
memoryUsage
description
0
4044
CliqSuccess
838317
Operation succeeded.
INFO
basedn DC=win8dom,DC=com
cliq>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 hostname=ldap://10.21.66.91 ldaps=1
HP StoreVirtual LeftHand OS Command Line Interface, vxx.x.x.x (C) Copyright 20xx-20xx Hewlett-Packard Development
Company, L.P.
RESPONSE
result
processingTime
name
memoryUsage
description
0
4776
CliqSuccess
838981
Operation succeeded.
INFO
basedn DC=win8dom,DC=com
CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 [email protected]
HP StoreVirtual LeftHand OS Command Line Interface, vxx.x.x.x (C) Copyright 20xx-20xx Hewlett-Packard Development
Company, L.P.
RESPONSE
result
0
processingTime 3971
name
CliqSuccess
memoryUsage
837947
description
Operation succeeded.
GROUP
name group_1-1-1
GROUP
name SANFull
getADInfo
Description
Get the current Active Directory configuration of the management group.
Syntax
getADInfo {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
getADInfo
59
Response
INFO ...
Name
Description
INFO
This section contains active directory information.
Example 108 Windows
cliq getADInfo login=10.0.1.3 userName=admin passWord=secret
HP StoreVirtual LeftHand OS Command Line Interface, vxx.
(C) Copyright 20xx-20xx Hewlett-Packard Development Company, L.P.
RESPONSE
result
processingTime
name
memoryUsage
description
INFO
userContext
configValid
bindUser
baseDN
adServer
0
13556
CliqSuccess
835357
Operation succeeded
true
[email protected]
DC=win8dom,DC=com
ldap://10.21.66.91/
getAlertLog
Description
Display information from the Alerts log.
Syntax
getAlertLog {login=} { userName= passWord= | groupName= } [logFile]
Parameters
60
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[logFile]
The name of the local file used to store the returned information.
Commands
Example 109 Windows
cliq getAlertLog login=10.1.2.3 userName=admin passWord=secret
OR
cliq getAlertLog
getAutoMountPolicy
Description
Get all of the auto-mount policies defined for the HP StoreVirtual Recovery Manager application
on this computer.
Syntax
getAutoMountPolicy
Parameters
None
Example 110 Windows
cliq getAutoMountPolicy
getClusterInfo
Description
Display information about a cluster.
Syntax
getClusterInfo {login=} { userName= passWord= | groupName= } [clusterName=]
[searchDepth=] [verbose=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[clusterName]
The name of the cluster.
[searchDepth]
Defines the types of objects to inspect. Values are 1—Clusters only,
2—Clusters and volumes, 3—Clusters, volumes and snapshots, and
4—Clusters, volumes, snapshots and remote snapshots (default). The greater
the search depth number, the longer the call can take.
[verbose]
Determines how much information to return. Values are 0—Get summary
information only (better performance) and 1—Get all information (better
information; default). The greater the verbose number, the longer the call
can take.
getAutoMountPolicy
61
Response Syntax
CLUSTER ...
NSM ...
VIP ...
VOLUME ...
Name
Description
CLUSTER
This section cluster contains information.
NSM
This section contains storage system information.
VIP
This section contains VIP information.
VOLUME
This section contains volume information.
Example 111 Windows
cliq getClusterInfo clusterName=Cluster0 login=10.1.2.3 userName=admin
passWord=secret
Example 112 SSH
getClusterInfo clusterName=Cluster0
getDnsInfo
Description
Get the DNS settings.
Syntax
getDnsInfo {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Response Syntax
DNSINFO ...
62
Name
Description
DNSINFO
This section contains DNS information.
Commands
Example 113 Windows
cliq getDnsInfo login=10.0.1.3 userName=admin passWord=secret
Example 114 SSH
getDnsInfo
getEventLog
Description
Get event information.
Syntax
getEventLog {login=} { userName= passWord= | groupName= } [type=] [format=]
[report=] [time=] [component=] [severity=] [object=] [system=] [source=] [user=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[type]
Event type. Values are AllAlerts, AllEvents, GlobalAlerts, GlobalEvents,
LocalAlerts, and LocalEvents.
[format]
Output format. Values are Remote, Client, and Xml.
[report]
Output verbosity. Values are Brief, Standard, and Verbose.
[time]
Time filter. The format is YYYYMMDDhhmmss:YYYYMMDDhhmmss.
[component]
Component filter. Values are Saniq, Hal, and Sys.
[severity]
Severity filter. Values are Info, Warning, and Critical.
[object]
Object filter. Values are MgmtGroup, RemoteMgmtGroup, Cluster, Manager,
VirtualManager, Store, SnapshotSchedule, Volume, and Snapshot.
[system]
System filter. Values are System, Controller, Cache, Disk, Boot, Backplane,
Fan, Temperature, Voltage, PowerSupply, and RAID.
[source]
Source filter, source name
[user]
The name of the administrative user.
getEventLog
63
Example 115 Windows
cliq getEventLog login=10.1.2.3 userName=admin passWord=secret
type=AllEvents format=XML component=Saniq severity=warning;Critical
object=Cluster system=System;Disk
Example 116 SSH
getEventLog type=AllEvents format=XML component=Saniq
severity=warning;Critical object=Cluster system=System;Disk
getGroupInfo
Description
Get information about a management group.
NOTE: When issuing the getgroupinfo command for a management group, you may see the
following status information at the end of the output:
STATUS
value 32774
description Unlicensed
This message indicates that the license key for a feature you are using in your SAN has not been
licensed yet. Once you apply the license key, this status message will no longer display.
Syntax
getGroupInfo {login=} { userName= passWord= | groupName= } [searchDepth=]
[verbose=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[searchDepth]
Defines which objects to inspect. Values are 1—Groups only, 2—Groups
and clusters, 3—Groups, clusters and volumes, 4—Groups, clusters, volumes
and snapshots, and 5—Groups, clusters, volumes, snapshots and remote
snapshots (default). The greater the search depth number, the longer the call
can take.
[verbose]
Determines how much information to return. Values are 0—Get summary
information only (better performance), and 1—Get all information (better
information; default). The greater the verbose number, the longer the call
can take.
Response Syntax
GROUP ...
64
Commands
ALERTANDEVENTPOLICY ...
EMAILNOTIFYPOLICY ...
EMAILSERVERINFO ...
SNMPSERVICEPOLICY ...
SNMPNOTIFICATIONPOLICY ...
SNMPCOMMUNITYSTRING ...
SNMPTRAPTARGET ...
FIBRECHANNEL ...
DNSINFO ...
NSM ...
CUSTOMERINFO ...
SERVERAPPLICATION ...
CLIENTAPPLICATION ...
REMOTEASSOCIATION ...
ADMINGROUP ...
CLUSTER ...
Name
Description
GROUP
This section contains group information.
ALERTANDEVENTPOLICY
This section contains alert and event policy information.
EMAILNOTIFYPOLICY
This section contains email notification policy information.
EMAILSERVERINFO
This section contains email server information.
SNMPSERVICEPOLICY
This section contains SNMP service policy information.
SNMPNOTIFICATIONPOLICY
This section contains SNMP notification policy information.
SNMPCOMMUNITYSTRING
This section contains SNMP community string information.
SNMPTRAPTARGET
This section contains SNMP trap target information.
FIBRECHANNEL
This section contains Fibre Channel information.
DNSINFO
This section contains DNS information.
NSM
This section contains storage system information.
CUSTOMERINFO
This section contains customer information.
SERVERAPPLICATION
This section contains server application information.
CLIENTAPPLICATION
This section contains client application information.
REMOTEASSOCIATION
This section contains remote association information.
ADMINGROUP
This section contains admin group information.
CLUSTER
This section cluster contains information.
Example 117 Windows
cliq getGroupInfo login=10.1.2.3 userName=admin passWord=secret
Example 118 SSH
getGroupInfo
getLocalVolumes
Description
Get information about connected volumes hosted by the HP StoreVirtual storage system.
getLocalVolumes
65
Syntax
getLocalVolumes [searchDepth=]
Parameters
Name
Description
[searchDepth]
Determines the amount of information to obtain. Values are 0—Get locally
mounted StoreVirtual volumes and snapshots and 1—Get additional
information about associated volumes or VSS volume sets (default).
Example 119 Windows
cliq getLocalVolumes
getNotificationPolicy
Description
Get information about the Alerts and Events Policy, Email Notification Policy, Syslog Notification
Policy, and Email Server Setting.
Syntax
getNotificationPolicy {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 120 Windows
cliq getNotificationPolicy login=10.1.2.3 userName=admin passWord=secret
Example 121 SSH
getNotificationPolicy
getNsmInfo
Description
Get information about a storage system.
Syntax
getNsmInfo {login=} { userName= passWord= | groupName= }
66
Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Response Syntax
NSM ...
FIBRECHANNEL ...
NIC ...
BONDTYPE ...
GOSSIPADDRESS ...
RAIDSETTING ...
Name
Description
NSM
This section contains storage system information.
FIBRECHANNEL
This section contains Fibre Channel information.
NIC
This section contains NIC information.
BONDTYPE
This section contains supported bond type information.
GOSSIPADDRESS
This section contains gossip address information.
RAIDSETTING
This section contains supported RAID type information.
Example 122 Windows
cliq getNsmInfo login=10.1.2.3 userName=admin passWord=secret
Example 123 SSH
getNsmInfo
getNsmLogs
Description
This command gathers all log files from a storage system and stores the archive locally.
Syntax
getNsmLogs {login=} { userName= passWord= | groupName= } {logFile=}
getNsmLogs
67
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{logFile}
The name of the local file used to store the returned information.
Example 124 Windows
cliq getNsmLogs login=10.1.2.3 userName=admin passWord=secret
logFile=c:\logs.tar.gz
getPerformanceStats
Description
Get performance monitoring statistics.
Syntax
getPerformanceStats {login=} { userName= passWord= | groupName= } [interval=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[interval]
The interval in between counter sampling in milliseconds. Defaults to 6000.
NOTE: Because the internal sampling frequency is 6 seconds, it is not
recommended to set this value to less than 6000.
68
Commands
Example 125 Windows
cliq getPerformanceStats login=10.1.2.3 userName=admin passWord=secret
Example 126 SSH
getPerformanceStats
getRemoteSnapshotInfo
Description
Get information about remote snapshots.
Syntax
getRemoteSnapshotInfo {login=} { userName= passWord= | groupName= }
[snapshotName=] [verbose=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[snapshotName]
The name of the remote snapshot.
[verbose]
Determines how much information to return. Values are 0—Get summary
information only (better performance), and 1—Get all information (better
information; default). The greater the verbose number, the longer the call
can take.
Response Syntax
REMOTESNAPSHOT...
Name
Description
REMOTESNAPSHOT
This section contains remote snapshot information.
getRemoteSnapshotInfo
69
Example 127 Windows
cliq getRemoteSnapshotInfo snapshotName=TheSnapshot login=10.1.2.3
userName=admin passWord=secret
Example 128 SSH
getRemoteSnapshotInfo snapshotName=TheSnapshot
getScsiInfo
Description
Get SCSI inquiry information about a locally connected volume.
Syntax
getScsiInfo {volumeName=}
Parameters
Name
Description
{volumeName}
The name of the locally attached storage device (for example, E:). This is not
the name of the volume in the management group.
Example 129 Windows
cliq getScsiInfo volumeName=z:
getServerCapabilities
Description
Query a Windows server for its HP StoreVirtual integration capabilities. If this call succeeds, the
actual capabilities will be returned. For anticipated future releases, this may also include information
about virtual machine hosting (VMware, Citrix, Hyper-V), and Server information.
NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target
Windows server for this call to succeed.
Syntax
getServerCapabilities {serverIp=}
Parameters
70
Name
Description
{serverIp}
The Windows server IP address.
Commands
Example 130 Windows
cliq getServerCapabilities serverIp=10.0.1.2
Example 131 SSH
getServerCapabilities serverIp=10.0.1.2
getServerInfo
Description
Display information about server configurations in the management group, which contain permission
settings for application servers to connect to StoreVirtual volumes.
Syntax
getServerInfo {login=} { userName= passWord= | groupName= } [serverName=]
[serverclustername=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[serverName]
The name of the server.
[serverclustername]
The name of the server cluster.
Response Syntax
SERVER ...
VOLUME ...
Name
Description
SERVER
This section contains server information.
VOLUME
This section contains volume information.
getServerInfo
71
Example 132 Windows
cliq getServerInfo login=10.0.1.2 userName=admin passWord=secret
Example 133 SSH
getServerInfo
getServerJobInfo
Description
Display information about completed and running HP StoreVirtual application-managed snapshot
jobs on a Windows application server.
NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target
Windows server for this call to succeed.
Syntax
getServerJobInfo {serverIp=} [jobId=] [volumeName=]
Parameters
Name
Description
{serverIp}
The Windows server IP address.
[jobId]
Job ID
[volumeName]
The name of the volume in the management group.
Response Syntax
response
description=""
name=""
processingTime=""
result=""
job
applicationIntegration=""
description=""
endTime=""
instanceID=""
percentComplete=""
result=""
startTime=""
status=""
volumeName=""
response
description
Operation succeeded.
name
GaucheSuccess
processingTime 1443
result
0
job
applicationIntegration 1
description
Operation succeeded.
endTime
10:00:00
instanceID
1234
percentComplete
100
result
0
72
Commands
startTime
status
volumeName
10:10:00
Completed
volume
Name
Description
description
Command result description
name
Name of the CLIQ error
processingTime
Processing time
result
Result code for the CLI command
job
The job data
applicationIntegration
Managed application type. Values are 0—VSS and 1—VMware.
description
Job description
endTime
Time when the job is completed
instanceID
Instance ID
percentComplete
Percent complete
result
The result of the job
startTime
The time the job was started
status
The status of the job
volumeName
The name of the volume in the management group
Example 134 Windows
cliq getServerJobInfo serverIp=1.2.3.4 jobId=1123
Example 135 SSH
getServerJobInfo serverIp=1.2.3.4 jobId=1123
getServerVolumeInfo
Description
Display information about StoreVirtual volumes attached to the target Windows application server.
NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target
Windows server for this call to succeed.
Syntax
getServerVolumeInfo {serverIp=} [searchDepth=]
Parameters
Name
Description
{serverIp}
The Windows server IP address.
[searchDepth]
Defines which objects to inspect. Values are 1—Volumes only, 2—Volumes
and snapshots, and 3—Volumes, snapshots and remote snapshots (default).
The greater the search depth number, the longer the call can take.
getServerVolumeInfo
73
Response Syntax
VOLUME ...
Name
Description
VOLUME
This section contains volume information.
Example 136 Windows
cliq getServerVolumeInfo serverIp="10.0.1.45"
Example 137 SSH
getServerVolumeInfo serverIp="10.0.1.45"
getSiteInfo
Description
Get site information on multi-site SANs.
Syntax
getSiteInfo {login=} { userName= passWord= | groupName= } [siteName=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[siteName]
The name of the site.
Response Syntax
SITE ...
NSM ...
74
Name
Description
SITE
This section contains site information.
NSM
This section contains storage system information.
Commands
Example 138 Windows
cliq getSiteInfo siteName=TheSite login=10.1.2.3 userName=admin
passWord=secret
Example 139 SSH
getSiteInfo siteName=TheSite
getSnapshotInfo
Description
Get information about a snapshot.
Syntax
getSnapshotInfo {login=} { userName= passWord= | groupName= } [snapshotName=]
[searchDepth=] [verbose=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[snapshotName]
The name of the remote snapshot.
[searchDepth]
Defines which objects to inspect. Values are 1—Snapshots only and
2—Snapshots and remote snapshots (default). The greater the search depth
number, the longer the call can take.
[verbose]
Determines how much information to return. Values are 0—Get summary
information only (better performance) and 1—Get all information (better
information; default). The greater the verbose number, the longer the call
can take.
Response Syntax
SNAPSHOT ...
STATUS ...
SESSION ...
PERMISSION ...
REMOTESNAPSHOT ...
Name
Description
SNAPSHOT
This section contains snapshot information.
STATUS
This section contains status information.
SESSION
This section contains session information.
getSnapshotInfo
75
Name
Description
PERMISSION
This section contains permission information.
REMOTESNAPSHOT
This section contains remote snapshot information.
Example 140 Windows
cliq getSnapshotInfo snapshotName=TheSnapshot login=10.1.2.3
userName=admin passWord=secret
Example 141 SSH
getSnapshotInfo snapshotName=TheSnapshot
getSnapshotScheduleInfo
Description
Get information about snapshot schedules.
Syntax
getSnapshotScheduleInfo {login=} { userName= passWord= | groupName= }
[scheduleName=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[scheduleName]
The name of the schedule.
Response Syntax
SCHEDULE ...
76
Name
Description
SCHEDULE
This section contains schedule information.
Commands
Example 142 Windows
cliq getSnapshotScheduleInfo login=10.0.1.3 userName=admin
passWord=secret
Example 143 SSH
getSnapshotScheduleInfo
getSnmpInfo
Description
Get information about the SNMP service and targets.
Syntax
getSnmpInfo {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Response Syntax
SNMPSERVICEPOLICY ...
SNMPNOTIFICATIONPOLICY ...
SNMPCOMMUNITYSTRING ...
SNMPTRAPTARGET ...
Name
Description
SNMPSERVICEPOLICY
This section contains SNMP service policy information.
SNMPNOTIFICATIONPOLICY
This section contains SNMP notification policy information.
SNMPCOMMUNITYSTRING
This section contains SNMP community string information.
SNMPTRAPTARGET
This section contains SNMP trap target information.
getSnmpInfo
77
Example 144 Windows
cliq getSnmpInfo login=10.1.2.3 userName=admin passWord=secret
Example 145 SSH
getSnmpInfo
getSupportInfo
Description
Gather all support log files from a management group and all its member storage systems. If the
specified storage system does not belong to any management group, then only logs from the
storage system will be collected. This command stores the archive locally.
Syntax
getSupportInfo {login=} { userName= passWord= | groupName= } [filepath=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[filepath]
The path to hold the final archive; if not specified, the current directory will
be used.
Response Syntax
INFO ...
FCADAPTER ...
Name
Description
INFO
This section contains active directory information.
FCADAPTER
This section contains Fibre Channel adapter information.
Example 146 Windows
cliq getSupportInfo login=10.1.2.3 userName=admin passWord=secret
filepath=c:\temp
getSystemInfo
Description
Get information about the StoreVirtual applications installed on the Windows application server.
78
Commands
Syntax
getSystemInfo
Parameters
None
Response Syntax
INFO ...
FCADAPTER ...
Name
Description
INFO
This section contains active directory information.
FCADAPTER
This section contains Fibre Channel adapter information.
Example 147 Windows
cliq getSystemInfo
getVolumeInfo
Description
Get information about a volume.
Syntax
getVolumeInfo {login=} { userName= passWord= | groupName= } [volumeName=]
[searchDepth=] [verbose=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[volumeName]
The name of the volume in the management group.
[searchDepth]
Defines which objects to inspect. Values are 1—Volumes only, 2—Volumes
and snapshots, and 3—Volumes, snapshots and remote snapshots (default).
The greater the search depth number, the longer the call can take.
[verbose]
Determines how much information to return. Values are 0—Get summary
information only (better performance) and 1—Get all information (better
information; default). The greater the verbose number, the longer the call
can take.
getVolumeInfo
79
Response Syntax
VOLUME ...
STATUS ...
REMOTESNAPSHOT ...
SNAPSHOT ...
SCHEDULE ...
PERMISSION ...
Name
Description
VOLUME
This section contains volume information.
STATUS
This section contains status information.
REMOTESNAPSHOT
This section contains remote snapshot information.
SNAPSHOT
This section contains snapshot information.
SCHEDULE
This section contains schedule information.
PERMISSION
This section contains permission information.
Example 148 Windows
cliq getVolumeInfo volumeName=volume0 login=10.1.2.3 userName=admin
passWord=secret
Example 149 SSH
getVolumeInfo volumeName=volume0
getVolumeControllingServer
Description
Get the IP address of the controlling server defined for a volume in the management group.
Syntax
getVolumeControllingServer {login=} { userName= passWord= | groupName= }
{volumeName=}
Parameters
80
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
Commands
Example 150 Windows
cliq getVolumeControllingServer login=10.0.1.2 userName=admin
passWord=secret volumeName="The Volume"
Example 151 SSH
getVolumeControllingServer volumeName="The Volume"
help
Description
Get information about the currently supported API command set.
Syntax
help [command=]
Parameters
Name
Description
[command]
A specific command for more detailed help information.
NOTE: If help is specified with no parameters, a list of possible return codes
is returned.
Example 152 Windows
cliq help command=getSystemInfo
Example 153 SSH
help command=getSystemInfo
makePrimary
Description
Promote a remote volume to a primary production volume.
Syntax
makePrimary {login=} { userName= passWord= | groupName= } {volumeName=}
[size=] [thinProvision=] [adaptiveOptimization=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
help
81
Name
Description
{volumeName}
The name of the volume in the management group.
[size]
The size of the volume, with units specified as:
• <n> MB – n Megabytes (1024 Kilobytes)
• <n> GB – n Gigabytes (1024 Megabytes)
• <n> TB – n Terabytes (1024 Gigabytes)
[thinProvision]
Enable or disable thin provisioning. Values are 0—The volume does not use
thin provisioning, 1—The volume is thin-provisioned (in a thinly provisioned
volume, reserve may be < length).
[adaptiveOptimization]
Enable or disable adaptive optimization. Values are 0—Disable and
1—Enable. 1 is the default.
Example 154 Windows
cliq makePrimary login=10.1.2.3 userName=admin passWord=secret
volumeName="TheVolume" size=1GB
Example 155 SSH
makePrimary volumeName="TheVolume" size=1GB
makeRemote
Description
Demote a primary volume to a remote snapshot target.
Syntax
makeRemote {login=} { userName= passWord= | groupName= } {volumeName=}
{snapshotName=} [adaptiveOptimization=]
Parameters
82
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{snapshotName}
The name of the remote snapshot.
[adaptiveOptimization]
Enable or disable adaptive optimization. Values are 0—Disable and
1—Enable. 0 is the default.
Commands
Example 156 Windows
cliq makeRemote login=10.1.2.3 userName=admin passWord=secret
volumeName="TheVolume" snapshotName="TheSnapshot"
Example 157 SSH
makeRemote volumeName="TheVolume" snapshotName="TheSnapshot"
modifyAdminGroup
Description
Modify one or more properties of the SAN administrative group.
CAUTION: If the adminUserName parameter is used, all user IDs that are currently in the group
that are not included with this parameter will be removed.
Syntax
modifyAdminGroup {login=} { userName= passWord= | groupName= }
{adminGroupName=} [adminUserName=] [description=] [permissions=] [adGroup=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{adminGroupName}
The administrative group name.
[adminUserName]
Specifies the users that this group comprises.
[description]
Optional description
[permissions]
Permissions for the group. This is a character sequence specifying the
allowable permissions in the following order: Group, Network, Storage
System, Report. The Password permissions are subsumed by the Group
permissions. For each group, the allowable permissions are: r—Read- only,
w—Read-write (Report does not support this), and f—Full-access (Report does
not support this).
NOTE:
[adGroup]
If this is not specified, the permissions are set to rrrr.
The name of the associated active directory group.
modifyAdminGroup
83
Example 158 Windows
cliq modifyAdminGroup login=10.0.1.3 userName=admin passWord=secret
description="My shiny new group" adminGroupName=powerusers
adminUserName=user1;user2 permissions=fffr
Example 159 SSH
modifyAdminGroup description="My shiny new group"
adminGroupName=powerusers adminUserName=user1;user2 permissions=fffr
modifyAdminUser
Description
Modify an administrative user.
Syntax
modifyAdminUser {login=} { userName= passWord= | groupName= }
{adminUserName=} [description=] [adminPassWord=]
Parameters
84
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{adminUserName}
Specifies the users that this group comprises.
[description]
Optional description
[adminPassWord]
The password for the administrative user.
Commands
Example 160 Windows
cliq modifyAdminUser login=10.0.1.3 userName=admin passWord=secret
description="My shiny new user" adminUserName=user adminPassWord=secret
Example 161 SSH
modifyAdminUser description="My shiny new user" adminUserName=user
adminPassWord=secret
modifyCluster
Description
Modify settings on a cluster.
CAUTION:
•
Modifying a cluster will cause a restripe of every volume in the cluster.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
cliq modifyCluster {login=} { userName= passWord= | groupName= }
{clusterName=} [newName] [description=] [useVip=] [node=] [vip=]
[SpaceReclaimWarn=] [SpaceReclaimCrit=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{clusterName}
The name of the cluster.
[newName]
The new name for the cluster.
[description]
Optional description
[useVip]
Determines whether virtual IP (VIP) addressing is used. Values are 0 and 1
(default).
[node]
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
[vip]
A delimited list of virtual IP address or DNS-resolvable name and subnet
mask.
NOTE: Since each VIP contains two parameters, IP address and subnet
mask, both must be specified in order, even if empty. If multiple VIPs are
entered, they must be on different subnets.
modifyCluster
85
Name
Description
[SpaceReclaimWarn]
Sets the percentage of allocated pages that will trigger a warning to the host
that storage system space is almost full. The default is 90.
[SpaceReclaimCrit]
Sets the percentage of allocated pages that will trigger an alarm to the host
that storage system space is critical. The default is 95. Once the alarm
threshold is reached, no writes can be performed.
Example 162 Windows
cliq modifyCluster clusterName=TheCluster login=10.0.1.3 userName=admin
passWord=secret description="My shiny new cluster" useVip=1 node=10.1.2.4
vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0
Example 163 SSH
modifyCluster clusterName=TheCluster description="My shiny new cluster"
useVip=1 node=10.1.2.4
vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0
modifyEmailNotifyPolicy
Description
Modify an Email Notification Policy.
Syntax
modifyEmailNotifyPolicy {login=} { userName= passWord= | groupName= }
{email=} [verbosity=] { alertOnInfo= | alertOnWarning= | alertOnCritical=
} [emailLocale=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{email}
The email address of the recipient.
[verbosity]
The level of returned information via email notification. Values are 1—Brief,
2—Standard, and 3—Verbose.
{alertOnInfo}
{alertOnCritical}
Values are 0—Email will not be sent on informational events, warning events,
and critical events and 1—Email will be sent for informational events, warning
events, and critical events. The default is 0 for
modifyEmailNotifyPolicy. Either alertOnInfo, alertOnWarning,
or alertOnCritical must be specified or the command will be rejected.
[emailLocale]
English (default), Chinese, Japanese, Korean
{alertOnWarning}
86
Commands
Example 164 Windows
cliq modifyEmailNotifyPolicy login=10.0.1.3 userName=admin
passWord=secret email="[email protected]" alertOnCritical=1
Example 165 SSH
modifyEmailNotifyPolicy email="[email protected]" alertOnCritical=1
modifyGroup
Description
Modify settings on a management group.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
•
Once the SpaceReclaim parameter is enabled, it cannot be disabled, nor can the LeftHand
OS be downgraded below version 11.0. The only way to disable the SpaceReclaim
parameter is to delete the management group. You can then create a new management group
(with the same name as the deleted management group) that has SpaceReclaim disabled.
Syntax
modifyGroup {login=} { userName= passWord= | groupName= } [node=]
[bandwidthPriority=] [customerName=] [supportId=] [contactName=]
[postalAddress=] [postalAddress2=] [cityName=] [stateName=] [countryName=]
[postalCode=] [telephoneNumber=] [emailaddress=] [SpaceReclaim=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[node]
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
[bandwidthPriority]
The manager bandwidth. Values are:
• Kb—Kilobits/sec (1000 Bits/second)
• Mb—Megabits/sec (1000 Kilobits/second)
• Gb—Gigabits/sec (1000 Megabits/second)
[customerName]
Customer name
[supportId]
Support ID provided by HP StoreVirtual support.
modifyGroup
87
Name
Description
[contactName]
Contact name
[postalAddress]
Postal address line 1
[postalAddress2]
Postal address line 2
[cityName]
Postal city
[stateName]
Postal state
[countryName]
Postal country
[postalCode]
Postal code
[telephoneNumber]
Contact telephone number
[emailaddress]
The notification email.
[SpaceReclaim]
Set to 1 to enable Space Reclamation; the default is 0.
Example 166 Windows
cliq modifyGroup login=10.0.1.2 userName=admin passWord=secret
node=10.0.1.2;10.0.1.3
Example 167 SSH
modifyGroup node=10.0.1.2;10.0.1.3
modifyNSM
Description
Modify storage system Fibre Channel port states between enabled and disabled.
Syntax
modifyNSM {login=} { userName= passWord= | groupName= } {fcenabled=}
Parameters
88
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{fcenabled}
Enable or disable the Fibre Channel port(s). Values are 0—Disable and
1—Enable. The default is 0. If a WWPN is entered, this value will stay at
the default value of 0 unless specifically set by using this parameter.
Commands
Example 168 Windows
cliq modifyNSM login=10.0.1.2 userName=admin passWord=secret fcenabled=1
Example 169 SSH
modifyNSM fcenabled=1
modifyRemoteAssociation
Description
Modify a previously created remote volume association.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
modifyRemoteAssociation {login=} { userName= passWord= | groupName= }
{remote=} [remoteUserName=] [remotePassWord=] [primaryBandwidth=]
[remoteBandwidth=] [remotegroupname=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{remote}
The IP address or DNS-resolvable names of one or more remote storage
system.
[remoteUserName]
The authentication user name for the remote group.
[remotePassWord]
The password for the remote group.
[primaryBandwidth]
The bandwidth used in a copy from the primary group to the remote group.
Values are:
• Kb—Kilobits/sec (1000 Bits/second)
• Mb—Megabits/sec (1000 Kilobits/second)
• Gb—Gigabits/sec (1000 Megabits/second)
modifyRemoteAssociation
89
Name
Description
[remoteBandwidth]
The bandwidth used in a copy from the remote group to the primary group.
Values are:
• Kb—Kilobits/sec (1000 Bits/second)
• Mb—Megabits/sec (1000 Kilobits/second)
• Gb—Gigabits/sec (1000 Megabits/second)
[remotegroupname]
The name of the remote management group. This parameter only applies
when using the Windows CLI.
Example 170 Windows
cliq modifyRemoteAssociation login=10.0.1.2 userName=admin
passWord=secret remote=10.0.1.3 remoteUserName=admin
remotePassWord=secret remoteBandwidth=10Mb
Example 171 SSH
modifyRemoteAssociation remote=10.0.1.3 remoteUserName=admin
remotePassWord=secret remoteBandwidth=10Mb
modifyRemoteSnapshotSchedule
Description
Modify a previously created remote snapshot schedule.
Syntax
modifyRemoteSnapshotSchedule {login=} { userName= passWord= | groupName=
} {scheduleName=} [remoteretentioncount=] [remoteretentionseconds=]
Parameters
90
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{scheduleName}
The name of the schedule.
[remoteretentioncount]
The number of remote snapshots to maintain. Must be between 1 and 50.
Either remoteretentioncount or remoteretentionseconds must
be specified.
[remoteretentionseconds]
How long remote snapshots should be retained. Either
remoteretentioncount or remoteretentionseconds must be
specified.
Commands
Example 172 Windows
cliq modifyRemoteSnapshotSchedule scheduleName="TheSchedule"
login="10.0.1.2" userName="admin" passWord="secret"
remoteretentioncount="10"
Example 173 SSH
modifyRemoteSnapshotSchedule scheduleName="TheSchedule"
remoteretentioncount="10"
modifyServer
Description
Modify a server.
Syntax
modifyServer {login=} { userName= passWord= | groupName= } {serverName=}
[description=] [allowiSCSIAccess=] [vipLoadBalance=] [useCHAP=] [initiator=]
[targetSecret=] [chapName=] [initiatorSecret=] [controllingserver=]
[allowfcaccess=] [wwpn=] [bootvolumelun=] [bootvolumename=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{serverName}
The name of the server.
[description]
Optional description
[allowiSCSIAccess]
Allow iSCSI access for this host. Values are 0—Disable and 1—Enable. If
volumes are attached to a client server via iSCSI and a value of 0 is entered,
the client server will lose its ability to communicate with the attached volumes.
If an IQN is entered and Fibre Channel is NOT configured, the default will
be 1, otherwise no default will be selected.
[vipLoadBalance]
Use VIP load balancing for this host. Values are 0—Disabled and 1—Enabled.
The default value is 1.
[useCHAP]
Use CHAP Authentication for this host. Values are 0—Disabled and
1—Enabled.
[initiator]
A semicolon delimited string of host IQNs. If this is not specified, the IQN
of the local server is used (this parameter is required if run on a storage
system). Valid characters are any letter, number, international character or
-, ., and : characters.
[targetSecret]
The CHAP target secret for the volume.
[chapName]
The CHAP name for the volume. If this is not specified, the IQN of the local
server is used (this parameter is required if run on a storage system).
modifyServer
91
Name
Description
[initiatorSecret]
The CHAP initiator secret for the volume.
[controllingserver]
The IP address of the client server that has Application Aware Snapshot
Manager (AASM) installed on it. It will coordinate the snapshot with the
applications using SAN volumes. This is required for managed snapshots of
Fibre Channel connected volumes. This is also required for VMware managed
snapshots; if applicable, enter the Virtual Center Server IP address.
[allowfcaccess]
Allow Fibre Channel ports to be assigned to the client. Values are 0—Disable
and 1—Enable. If volumes are attached to a client server via Fibre Channel
and a value of 0 is entered, the client will lose its ability to communicate with
the attached volumes.
[wwpn]
A semicolon delimited list of the unique World Wide Port Names for one or
more Fibre Channel ports. Expected WWPN formatting is 16 Hex characters
with or without the : character as a delimiter. For example:
20:21:00:0E:B3:01:AB:C6 or 2021000EB301ABC6. Lower case hex
characters a-f are also accepted.
[bootvolumelun]
The LUN (1–255) of the boot volume. Valid only for a Fibre Channel attached
volume. If present, then bootvolumename must also be specified.
NOTE:
[bootvolumename]
LUN 255 is not supported by Microsoft Windows.
The volume name of the boot volume. Valid only for a Fibre Channel attached
volume. If present, then bootvolumelun must also be specified.
Example 174 Windows
cliq modifyServer serverName=TheServer useCHAP=0
initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.mynetworks.com
login=10.0.1.2 userName=admin passWord=secret
Example 175 SSH
modifyServer serverName=TheServer useCHAP=0
initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.mynetworks.com
modifySite
Description
Modify a site in a multi-site SAN.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
modifySite {login=} { userName= passWord= | groupName= } {siteName=} [node=]
[description=] [primary=]
92
Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{siteName}
The name of the site.
[node]
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
[description]
Optional description
[primary]
Designates this site as the primary site. Values are 0—Disabled or
1—Enabled. 1 is the default.
Example 176 Windows
cliq modifySite siteName=TheSite description="My Site" login=10.0.1.2
userName=admin passWord=secret
Example 177 SSH
modifySite siteName=TheSite description="My Site"
modifySnapshot
Description
Modify snapshot settings.
Syntax
modifySnapshot {login=} { userName= passWord= | groupName= } {snapshotName=}
[description=] [autogrowpages=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{snapshotName}
The name of the remote snapshot.
modifySnapshot
93
Name
Description
[description]
Optional description
[autogrowpages]
Automatically grow the pages.
Example 178 Windows
cliq modifySnapshot description="New Description" login=10.0.1.2
userName=admin passWord=secret snapshotName=TheSnapshot
Example 179 SSH
modifySnapshot description="New Description" snapshotName=TheSnapshot
modifySnapshotSchedule
Description
Modify a previously created snapshot schedule.
Syntax
modifySnapshotSchedule {login=} { userName= passWord= | groupName= }
{scheduleName=} [description=] [recurperiod=] [starttime=] [retentioncount=]
[retentionseconds=] [paused=]
Parameters
94
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{scheduleName}
The name of the schedule.
[description]
Optional description
[recurperiod]
The recurrence frequency of the snapshots, specified in seconds. Period may
be 0 to indicate the schedule never occurs, otherwise Period must be at least
1800 seconds (30 minutes).
[starttime]
The start time of the schedule. Specified as ISO 8601. Format is
YYYY-MM-DDTHH:MM:SSZ. YYYY represents the year, MM is the month,
DD is the day of the month, HH is the hour in 24 hour format, MM is the
minutes, and SS is the seconds. The time must always be expressed in GMT
time.
[retentioncount]
Defines the number of snapshots to maintain. Must be between 1 and 50.
Either retentioncount or retentionseconds must be specified.
[retentionseconds]
Defines how long snapshots should be retained. Either retentioncount
or retentionseconds must be specified.
[paused]
The state of the snapshot schedule. Values are 0—Schedule is not paused
and 1—Schedule is paused.
Commands
Example 180 Windows
cliq modifySnapshotSchedule scheduleName="TheSchedule" description="First
snapshot schedule" login="10.0.1.2" userName="admin" passWord="secret"
Example 181 SSH
modifySnapshotSchedule scheduleName="TheSchedule" description="First
snapshot schedule"
modifySnmpCommunityString
Description
Modify the community string for all SNMP.
Syntax
modifySnmpCommunityString {login=} { userName= passWord= | groupName= }
{communityString=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{communityString}
The SNMP community string.
Example 182 Windows
cliq modifySnmpCommunityString login=10.0.1.3 userName=admin
passWord=secret communityString="NewString"
Example 183 SSH
modifySnmpCommunityString communityString="NewString"
modifySnmpTrapTarget
Description
Modify an SNMP trap target.
Syntax
modifySnmpTrapTarget {login=} { userName= passWord= | groupName= }
{communityString=}
modifySnmpCommunityString
95
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{communityString}
The SNMP community string.
Example 184 Windows
cliq modifySnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret
communityString="TheString"
Example 185 SSH
modifySnmpTrapTarget communityString="TheString"
modifySyslogNotifyPolicy
Description
Modify a Syslog Notification Policy.
Syntax
modifySyslogNotifyPolicy {login=} { userName= passWord= | groupName= }
{ipAddress=} { alertOnInfo= | alertOnWarning= | alertOnCritical= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{ipAddress}
This is the IP address or Host Name of the Syslog server.
{alertOnInfo}
Values are 0—The log does not include informational events, warning events,
and critical events and 1—The log includes informational events, warning
events, and critical events. The default is 0 for
modifySyslogNotifyPolicy. Either alertOnInfo, alertOnWarning,
or alertOnCritical must be specified or the command will be rejected.
{alertOnWarning}
{alertOnCritical}
96
Commands
Example 186 Windows
cliq modifySyslogNotifyPolicy login=10.0.1.3 userName=admin
passWord=secret ="10.0.10.25" alertOnInfo="1"
Example 187 SSH
modifySyslogNotifyPolicy ="10.0.10.25" alertOnInfo="1"
modifyVolume
Description
Modify volume settings.
CAUTION:
•
Enabling checksums may impact volume I/O performance.
•
Changing the replication level of this volume will cause it to restripe, and may impact I/O
performance. This will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
modifyVolume {login=} { userName= passWord= | groupName= } {volumeName=}
[description=] [replication=] [parity=] [checkSum=] [thinProvision=]
[autogrowSeconds=] [clusterName=] [size=] [autogrowpages=]
[adaptiveOptimization=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
[description]
Optional description
[replication]
The replication level for the volume. Values are 1, 2, 3, and 4.
[parity]
The number of parity storage systems for the data on this volume. This enables
parity network RAID on the volume. Replication and parity are supported in
the following combinations:
• replication:1, parity:0 Network RAID-0 (None)
• replication:2, parity:0 Network RAID-10 (2-way Mirror)
• replication:3, parity:0 Network RAID-10+1 (3-way Mirror)
• replication:4, parity:0 Network RAID-10+2 (4-way Mirror)
modifyVolume
97
Name
Description
• replication:2, parity:1 Network RAID-5 (Single parity)
• replication:3, parity:2 Network RAID-6 (Dual Parity)
[checkSum]
Values are 0—The volume does not use checksums and 1—The volume uses
checksums.
[thinProvision]
Enable or disable thin provisioning. Values are 0—The volume does not use
thin provisioning and 1—The volume is thin-provisioned (in a thinly
provisioned volume, reserve may be < length).
[autogrowSeconds]
The amount to grow the volume when it is thin-provisioned and new pages
must be added, based on the current growth rate. A value of 0 means no
autogrow.
[clusterName]
The name of the cluster.
[size]
The size of the volume, with units specified as:
• <n> KB—n Kilobytes (1024 bytes)
• <n> MB—n Megabytes (1024 Kilobytes)
• <n> GB—n Gigabytes (1024 Megabytes)
• <n> TB—n Terabytes (1024 Gigabytes)
• <n> PB—n Petabytes (1024 Terabytes)
[autogrowpages]
Automatically grow the pages.
[adaptiveOptimization]
Enable or disable adaptive optimization. Values are 0—Disable and
1—Enable. The default is that the volume retains the current setting (what
was set when either the volume was created or last modified).
Example 188 Windows
cliq modifyVolume description="New Description" login=10.0.1.2
userName=admin passWord=secret volumeName=TheVolume
Example 189 SSH
modifyVolume description="New Description" volumeName=TheVolume
mountVolume
Description
Mount a volume to the specified mount point.
CAUTION: Prior to mounting the volume, the volume must be assigned to the server
(assignVolume) and connected (connectVolume).
Syntax
mountVolume {groupName=} {volumeName=} {mountpoint=} [forcecreate=]
Parameters
98
Name
Description
{groupName}
The name of the management group.
{volumeName}
The name of the volume in the management group.
Commands
Name
Description
{mountPoint}
The drive letter or mount point on the host for the volume.
[forcecreate]
Forces the creation of the volume with formatting as NTFS.
Example 190 Windows
cliq mountVolume groupName=MG2 volumeName=TheVolume mountPoint=z:
rebalanceVip
Description
Rebalance the connections to a volume when using a virtual IP address.
Syntax
rebalanceVip {login=} { userName= passWord= | groupName= } {volumeName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
rebalanceVip
99
Example 191 Windows
cliq rebalanceVip volumeName=MyVolume login=10.1.2.3 userName=admin
passWord=secret
Example 192 SSH
rebalanceVip volumeName=MyVolume
recoverQuorum
Description
Rescue a management group after quorum has been irretrievably lost. This command needs to be
run on a storage system with a working manager so it can retrieve the management group database
from that manager to restore the management group.
CAUTION:
•
Once you have chosen to proceed with the recover quorum operation, there is no way to
undo the effects. If possible, it is highly recommended that you attempt to recover quorum
instead by bringing up any offline managers that might still be accessible. As part of the
recover quorum operation, all configured managers that are offline will be deleted from the
management group and all storage servers that are offline will be ejected from the management
group and cluster(s).
•
Contact support before proceeding. Only use the recoverQuorum command when actively
working with support personnel and they direct you to invoke the command.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
recoverQuorum {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
100 Commands
Example 193 Windows
cliq recoverQuorum login=10.1.2.3 userName=admin passWord=secret
Example 194 SSH
recoverQuorum
removeSnapshot
Description
Disconnect a SAN snapshot from the host, then delete it. If the snapshot cannot be disconnected
(because it is in use, or for any other reason), it will not be deleted.
Syntax
removeSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{snapshotName}
The name of the remote snapshot.
Example 195 Windows
cliq removeSnapshot snapshotName=z: login=10.0.1.2 userName=admin
passWord=secret
removeVolume
Description
Disconnect a StoreVirtual volume from the host, then delete it. If the volume cannot be disconnected
(because it is in use, or for any other reason), it will not be deleted.
Syntax
removeVolume {login=} { userName= passWord= | groupName= } {volumeName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
removeSnapshot
101
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
Example 196 Windows
cliq removeVolume volumeName=z: login=10.0.1.2 userName=admin
passWord=secret
resetSession
Description
Reset the iSCSI session associated with a volume. Some initiators will attempt to reconnect after
the reset.
Syntax
resetSession {login=} { userName= passWord= | groupName= } {volumeName=}
[initiator=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
[initiator]
A semicolon delimited string of host IQNs. If this is not specified, the IQN
of the local server is used (this parameter is required if run on a storage
system). Valid characters are any letter, number, international character or
-, ., and : characters.
102 Commands
Example 197 Windows
cliq resetSession volumeName=MyVolume login=10.1.2.3 userName=admin
passWord=secret
Example 198 SSH
resetSession volumeName=MyVolume
rollbackSnapshot
Description
Roll back a snapshot.
CAUTION:
•
The rollbackSnapshot command will replace the original volume with a new one based
on the contents of the snapshot and delete any snapshots created after the snapshot which is
being rolled back.
•
If the original volume is specified, this will replace it with a new volume based on the contents
of the snapshot and delete any snapshots created after the snapshot being rolled back.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
rollbackSnapshot {login=} { userName= passWord= | groupName= }
{snapshotName=} [description=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{snapshotName}
The name of the remote snapshot.
[description]
Optional description
rollbackSnapshot 103
Example 199 Windows
cliq rollbackSnapshot snapshotName=TheSnapshot login=10.0.1.2
userName=admin passWord=secret
Example 200 SSH
rollbackSnapshot snapshotName=TheSnapshot
runDiagnostic
Description
Run one or all storage system diagnostics.
Syntax
runDiagnostic {login=} { userName= passWord= | groupName= } [diagnosticName=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[diagnosticName]
The name of the diagnostic to run (if unspecified, all diagnostics are listed;
if * is specified, all are run).
Example 201 Windows
cliq runDiagnostic login=10.0.1.2 userName=admin passWord=secret
diagnosticName=drvstat
Example 202 SSH
runDiagnostic diagnosticName=drvstat
setADInfo
Description
Set the Active Directory association and configuration of the management group.
Syntax
setADInfo {login=} { userName= passWord= | groupName= } {adServer=} {baseDN=}
[bindUserName=] [bindPassWord=] [userContext=] [testOnly=] [ldaps=]
104 Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{adServer}
The active directory host.
{baseDN}
The base DN.
[bindUserName]
An active directory user name used to query the Active Directory infrastructure.
[bindPassWord]
The active directory password for the binduser.
[userContext]
The user context.
[testOnly]
Set this flag to true to test the configuration only. If not, set the default is false.
[ldaps]
Use a secure LDAP connection. Set it to false to change; the default is true.
Example 203 Windows
cliq setADInfo login=10.0.1.3 userName=admin passWord=secret
bindUserName=user adServer=ldap://10.0.1.25 baseDN="win8dom,DC=com"
userContext=private testOnly=true ldaps=false
Example 204 SSH
setADInfo adServer=ldap://10.0.1.25 baseDN=2
setAlertsPolicy
Description
Set information for the Alerts and Events Policy.
Syntax
setAlertsPolicy {login=} { userName= passWord= | groupName= } {aging=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
setAlertsPolicy 105
Name
Description
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{aging}
The aging in months.
Example 205 Windows
cliq setAlertsPolicy login=10.0.1.3 userName=admin passWord=secret
aging="2"
Example 206 SSH
setAlertsPolicy aging="2"
setAutoMountPolicy
Description
Set or modify the auto-mount policy or the mount location for auto-mount policies for the HP
StoreVirtual Recovery Manager application on this computer.
CAUTION: The HP StoreVirtual Recovery Manager must be installed on the system to implement
auto-mount polices defined by the CLIQ.
Syntax
setAutoMountPolicy [groupName=] [volumeName=] [retentionCount=] [mountPoint=]
[paused=]
Parameters
Name
Description
[groupName]
The name of the management group
[volumeName]
The name of the volume in the management group.
[retentionCount]
The number of snapshots to keep mounted for the specified volume of the
auto-mount policy. This parameter is required when configuring the auto-mount
policy.
[mountPoint]
Set the mount location on the host for where snapshots are mounted by the
HP StoreVirtual Auto-Mount service. This parameter is not required when
configuring an auto-mount policy.
[paused]
The state of the snapshot schedule. Values are 0—Schedule is not paused
and 1—Schedule is paused.
106 Commands
Example 207 Setting an auto-mount policy (Windows)
cliq setAutoMountPolicy groupName=MG1 volumeName=ExchangeVol1
retentionCount=5
Example 208 Setting a mount location (Windows)
cliq setAutoMountPolicy mountPoint=C:\StoreVirtual\RecoveredSnaps
setDnsInfo
Description
Set information for DNS.
CAUTION:
This command overwrites all current values for each parameter.
Syntax
setDnsInfo {login=} { userName= passWord= | groupName= } [domainname=]
[suffix=] {server=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[domainname]
The domain name.
[suffix]
DNS suffixes.
{server}
List of DNS servers, IP addresses.
Example 209 Windows
cliq setDnsInfo login=10.0.1.3 userName=admin passWord=secret
server=10.23.0.101 suffix=suffix1;suffix2 domainname=domainname
Example 210 SSH
setDnsInfo server=10.23.0.101 suffix=suffix1;suffix2
domainname=domainname
setEmailServerInfo
Description
Set the configuration information for the email server used to email alerts to configured recipients.
setDnsInfo 107
Syntax
setEmailServerInfo {login=} { userName= passWord= | groupName= } [ipAddress=]
[email=] [portNumber=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[ipAddress]
The IP address or host name of the email server.
[email]
The email address of the sender.
[portNumber]
The port number to send email on. If omitted, the current port number will
be retained (defaulted to port 25).
Example 211 Windows
cliq setEmailServerInfo login=10.0.1.3 userName=admin passWord=secret
ipAddress=10.23.0.101 portNumber=2309 [email protected]
Example 212 SSH
setEmailServerInfo ipAddress=10.23.0.101 portNumber=2309
[email protected]
setGossipList
Description
Set the gossip list on a storage system. Typically, the gossip list is managed by the LeftHand OS
agent. This is a backup mechanism that the API provides for imposing this if it is set incorrectly.
CAUTION:
•
This operation is irreversible.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
setGossipList {login=} { userName= passWord= | groupName= } {node=}
108 Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{node}
The delimited list of node names or IP addresses, or DNS-resolvable node
names of the storage systems the cluster comprises.
Example 213 Windows
cliq setGossipList login=10.0.1.2 userName=admin passWord=secret
node=10.0.1.3;10.0.1.4
Example 214 SSH
setGossipList node=10.0.1.3;10.0.1.4
setLicenseKey
Description
Set the license key on a storage system.
Syntax
setLicenseKey {login=} { userName= passWord= | groupName= } {licenseKey=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{licenseKey}
License key obtained from HP.
setLicenseKey 109
Example 215 Windows
cliq setLicenseKey login=10.0.1.2 userName=admin passWord=secret
licenseKey=0447-10AB-A698AB5A-318D-86B0-FAA8-454A-63B7-3B2B-00F5-11F5-62EF-9270E91A-0340-09A2-ABA1-8E87-7BAF-E527-E905-0DE2-E921-34A1A730-737B-718C-9063-7183-8CAF-4B3E-25
Example 216 SSH
setLicenseKey licenseKey=0447-10AB-A698AB5A-318D-86B0-FAA8-454A-63B7-3B2B-00F5-11F5-62EF-9270E91A-0340-09A2-ABA1-8E87-7BAF-E527-E905-0DE2-E921-34A1A730-737B-718C-9063-7183-8CAF-4B3E-25
setSnmpNotifyPolicy
Description
Set SNMP Notification Policy settings.
Syntax
setSnmpNotifyPolicy {login=} { userName= passWord= | groupName= }
[verbosity=] { alertOnInfo= | alertOnWarning= | alertOnCritical= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[verbosity]
The level of returned information via email notification. Values are 1—Brief,
2—Standard, and 3—Verbose.
{alertOnInfo}
Values are 0—Do not transmit informational events, warning events, and
critical events and 1—Transmit informational events, warning events, and
critical events. Either alertOnInfo, alertOnWarning, or
alertOnCritical must be specified or the command will be rejected.
{alertOnWarning}
{alertOnCritical}
110
Commands
Example 217 Windows
cliq setSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secret
alertOnWarning=1
Example 218 SSH
setSnmpNotifyPolicy alertOnWarning=1
setSnmpServiceInfo
Description
Set information about the SNMP Service.
Syntax
setSnmpServiceInfo {login=} { userName= passWord= | groupName= }
[contactinfo=] [location=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[contactinfo]
Contact information.
[location]
Location information.
Example 219 Windows
cliq setSnmpServiceInfo login=10.0.1.3 userName=admin passWord=secret
contactinfo="Mr Douglas" location="main office"
Example 220 SSH
setSnmpServiceInfo contactinfo="Mr Douglas" location="main office"
setSupportLogin
Description
Enable/disable support logins.
CAUTION:
•
This command will modify the state of support logins.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
setSnmpServiceInfo
111
Syntax
setSupportLogin {login=} { userName= passWord= | groupName= } {enabled=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{enabled=}
Enable or disable the feature. Values are 0—Disable and 1—Enable.
Example 221 Windows
cliq setSupportLogin enabled=1 login=10.0.1.3 userName=admin
passWord=secret
Example 222 SSH
setSupportLogin enabled=1
setTraceOff
Description
Stop the support logging for the current CLIQ process instance. This change is not shared or
persistent between CLIQ instances.
Syntax
setTraceOff
Parameters
None
Example 223 Windows
cliq setTraceOff
setTraceOn
Description
Start the support logging for the current CLIQ process instance. This change is not shared or
persistent between CLIQ instances.
Syntax
setTraceOn
112
Commands
Parameters
None
Example 224 Windows
cliq setTraceOn
shutdownGroup
Description
Perform a soft shutdown of a management group.
Syntax
shutdownGroup {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 225 Windows
cliq shutdownGroup login=10.0.1.2 userName=admin passWord=secret
Example 226 SSH
shutdownGroup
shutdownNsm
Description
Shut down a storage system.
CAUTION:
•
Shutting down a storage node may cause loss of access to volumes or degrade performance.
•
This command will display a prompt, requiring confirmation before proceeding. This prompt
may be overridden with an optional prompt=0 parameter on the command line; in this case,
the command will always execute without pausing for confirmation.
Syntax
shutdownNsm {login=} { userName= passWord= | groupName= } {action=} [delay=]
shutdownGroup
113
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{action}
The operation to perform. Values are Shutdown—Powers off the storage
system, Restart—Reboots the storage system, and Cancel—Cancels a restart
or shutdown, if pending.
[delay]
The number of minutes to delay prior to shutdown or restart (defaults to 0).
Example 227 Windows
cliq shutdownNsm action=Restart delay=10 login=10.0.1.2 userName=admin
passWord=secret
Example 228 SSH
shutdownNsm action=Restart delay=10
startManager
Description
Start the manager on a storage system.
Syntax
startManager {login=} { userName= passWord= | groupName= }
Parameters
114
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Commands
Example 229 Windows
cliq startManager login=10.0.1.2 userName=admin passWord=secret
Example 230 SSH
startManager
startSnmpService
Description
Start the SNMP Service.
Syntax
startSnmpService {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 231 Windows
cliq startSnmpService login=10.0.1.2 userName=admin passWord=secret
Example 232 SSH
startSnmpService
startVirtualManager
Description
Start a virtual manager on a storage system.
Syntax
startVirtualManager {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
startSnmpService
115
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 233 Windows
cliq startVirtualManager login=10.0.1.2 userName=admin passWord=secret
Example 234 SSH
startVirtualManager
stopManager
Description
Stop the manager on a storage system.
Syntax
stopManager {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 235 Windows
cliq stopManager login=10.0.1.2 userName=admin passWord=secret
Example 236 SSH
stopManager
stopSnmpService
Description
Stop the SNMP Service.
Syntax
stopSnmpService {login=} { userName= passWord= | groupName= }
116
Commands
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 237 Windows
cliq stopSnmpService login=10.0.1.2 userName=admin passWord=secret
Example 238 SSH
stopSnmpService
stopVirtualManager
Description
Stop a virtual manager on a storage system.
Syntax
stopVirtualManager {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
stopVirtualManager
117
Example 239 Windows
cliq stopVirtualManager login=10.0.1.2 userName=admin passWord=secret
Example 240 SSH
stopVirtualManager
testCredentials
Description
Test the login credentials for a management group.
Syntax
testCredentials {login=} { userName= passWord= | groupName= }
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
Example 241 Windows
cliq testCredentials login=10.0.1.2 userName=admin passWord=secret
Example 242 SSH
testCredentials
unassignVolume
Description
Disassociate a volume from all servers.
Syntax
unassignVolume {login=} { userName= passWord= | groupName= } {volumeName=}
Parameters
118
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
Commands
Name
Description
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
Example 243 Windows
cliq unassignVolume volumeName=TheVolume login=10.0.1.2 userName=admin
passWord=secret
Example 244 SSH
unassignVolume volumeName=TheVolume
unassignVolumeToServer
Description
Disassociate a volume with a server.
Syntax
unassignVolumeToServer {login=} { userName= passWord= | groupName= }
{volumeName=} {serverName=}
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
{volumeName}
The name of the volume in the management group.
{serverName}
The name of the server.
unassignVolumeToServer
119
Example 245 Windows
cliq unassignVolumeToServer volumeName=TheVolume serverName=TheServer
login=10.0.1.2 userName=admin passWord=secret
Example 246 SSH
unassignVolumeToServer volumeName=TheVolume serverName=TheServer
utility
Description
Execute a utility program on a storage system.
CAUTION:
This command is recommended for HP Support only.
Syntax
utility {login=} { userName= passWord= | groupName= } [run=] [logFile=]
[useZip=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[run]
The utility and parameters to execute on the storage system. If this parameter
is not specified, a list of possible commands is returned.
[logFile]
The name of the local file used to store the returned information.
[useZip]
When used, the resulting log file will be zipped.
120 Commands
Example 247 Windows examples
cliq utility run="ping -c 10 10.3.2.1" login=10.1.2.3 userName=admin
passWord=secret
cliq utility run=groupsupportinfo login=10.1.2.3 userName=admin
passWord=secret
cliq utility run=hardwarereport login=10.1.2.3 userName=admin
passWord=secret
Example 248 SSH examples
utility run="ping -c 10 10.3.2.1"
utility run=groupsupportinfo
utility run=hardwarereport
vssSnapshot
Description
Create snapshots of volumes attached to the local computer using the Application Aware Snapshot
Manager VSS requestor client (Windows only).
Syntax
vssSnapshot [volumeName=] [persistent=] [transportable=] [backupDoc=]
[writerInfo=] [shadowInfo=] [deleteShadowCopies=] [excludeWriters=]
[includeWriters=] [runCommand=] [importShadow=] [mountShadow=]
[breakShadowCopies=] [maskLun=] [snapshotName=] { userName= passWord= |
groupName= } [description=]
Parameters
Name
Description
[volumeName]
The name of the locally attached storage device (for example, E:). This is not
the name of the volume in the management group.
[persistent]
Determines whether the snapshot is persistent. Values are 0 and 1 (default).
[transportable]
Determines whether the snapshot is transportable. Values are 0 and 1
(default).
[backupDoc]
The name of the backup document file.
[writerInfo]
Display information about VSS writers. Values are status—Writer status,
metadataSummary—Summary of the VSS writers, and
metadataDetail—Detailed information on the VSS writers.
[shadowInfo]
Display information about VSS shadow copies. Values are all—Show
information on all shadow copies, <shadow Set GUID>—Show information
on shadow copies belonging to this shadow set, and <shadow Copy
GUID>—Show information on this shadow copy.
[deleteShadowCopies]
Delete VSS shadow copies. Values are all—Delete all shadow copies,
<volume>—Delete the oldest shadow copy of this volume, <shadow Set
GUID>—Delete all shadow copies in this shadow set, and <shadow Copy
GUID>—Delete the shadow copy with this ID.
[excludeWriters]
List of writer GUIDs to exclude from the shadow copy.
[includeWriters]
List of writer GUIDs to include in the shadow copy. If the writer is found to
not participate in the snapshot, no snapshot will be taken.
vssSnapshot
121
Name
Description
[runCommand]
Custom command executed after shadow creation, import or between break
and make-it-write.
[importShadow]
Transportable VSS snapshot import.
[mountShadow]
Expose the shadow copy as a mount point or drive letter. The format is
mountShadow="<GUID>;<mountOrDrive>".
[breakShadowCopies]
Break the shadow copy set.
[maskLun]
Mask the shadow copy LUN from the host. It works in conjunction with
breakShadowCopies and is valid only when breakShadowCopies is
specified (Windows 2008 only).
[snapshotName]
The name of the remote snapshot.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[description]
Optional description
Example 249 Windows
cliq vsssnapshot persistent=1 transportable=1 volumename=Vol1
snapshotname=Vol1_Snapshot inheritaccess=1 description="My Snap"
backupdoc="C:\Users\admin\AppData\Local\Temp\lhn2D96.tmp"
waitForEvent
Description
Wait for an alert or event message.
Syntax
waitForEvent {login=} { userName= passWord= | groupName= } [receivePort=]
[timetowait=]
Parameters
122
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[receivePort]
The TCP port to receive the discovery packets (defaults to an unused port if
unspecified).
[timetowait]
The maximum amount of time to wait before timing out.
Commands
Example 250 Windows
cliq waitForEvent login=10.0.1.2 userName=admin passWord=secret
Example 251 SSH
waitForEvent
waitForUpdate
Description
Block on a change to the state in the management group.
Syntax
waitForUpdate {login=} { userName= passWord= | groupName= } [receivePort=]
[timetowait=]
Parameters
Name
Description
{login}
The IP addresses or DNS-resolvable names of one or more storage systems.
{userName}
The authentication user name for the storage system. If you use this parameter,
you must include the passWord parameter with it. Or, you can use the
groupName parameter instead of userName and passWord.
{groupName}
The name of the management group. Use this parameter if you do not use
the userName and passWord parameters. Because groupName has cached
credentials, it does not require the userName and passWord parameters.
{passWord}
The password for the storage system. Required when the userName
parameter is used.
[receivePort]
The TCP port to receive the discovery packets (defaults to an unused port if
unspecified).
[timetowait]
The maximum amount of time to wait before timing out.
Example 252 Windows
cliq waitForUpdate login=10.1.2.3 userName=admin passWord=secret
Example 253 SSH
waitForUpdate
waitForUpdate
123
3 Support and other resources
Contacting HP
For worldwide technical support information, see the HP support website:
http://www.hp.com/support
Before contacting HP, collect the following information:
•
Product model names and numbers
•
Technical support registration number (if applicable)
•
Product serial numbers
•
Error messages
•
Operating system type and revision level
•
Detailed questions
Subscription service
HP recommends that you register your product for HP Support Alerts at:
http://www.hp.com/go/e-updates
After registering, you will receive e-mail notification of product enhancements, new driver versions,
firmware updates, and other product resources.
HP Insight Remote Support
HP strongly recommends that you register your device for remote support to enable enhanced
delivery of your HP Warranty, HP Care Pack Service, or HP contractual support agreement. HP
Insight Remote Support supplements your monitoring continuously to ensure maximum system
availability by providing intelligent event diagnosis, and automatic, secure submission of hardware
event notifications to HP, which will initiate a fast and accurate resolution, based on your product’s
service level. Notifications can be sent to your authorized HP Channel Partner for onsite service,
if configured and available in your country.
HP Insight Remote Support is available as part of your HP Warranty, HP Care Pack Service, or HP
contractual support agreement. For more information, see the product documentation on the HP
website (http://www.hp.com/go/insightremotesupport/docs).
124
Support and other resources
Related information
You can find related documents on the product manuals page:
http://www.hp.com/support/StoreVirtualManuals
You can also find related documents on the Storage Information Library:
http://www.hp.com/go/storage/docs
HP websites
For additional information, see the following HP websites:
•
http://www.hp.com
•
http://www.hp.com/go/storage
•
http://www.hp.com/service_locator
•
http://www.hp.com/go/StoreVirtualDownloads
•
http://www.hp.com/go/storevirtualcompatibility
•
http://www.hp.com/storage/whitepapers
Related information
125
4 Documentation feedback
HP is committed to providing documentation that meets your needs. To help us improve the
documentation, send any errors, suggestions, or comments to Documentation Feedback
([email protected]). Include the document title and part number, version number, or the URL
when submitting your feedback.
126
Documentation feedback