HP StoreVirtual 4000 User Manual

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

Published: September 2013

Edition: 6

© Copyright 2008, 2013 Hewlett-Packard Development Company, L.P.

Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.

Edition	Date	Software	Description
		Version
1	November 2008	8.0	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
2	March 2010	8.5	Added the following commands: clearVssVolumeFlags, getAlertLog,
			getServerCapabilities, getServerVolumeInfo, getSupportInfo,
			removeSnapshotsetLicenseKey
3	November 2010	9.0	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
4	September 2011	9.5	Added the following commands: getServerJobInfo

Edition	Date	Software	Description
		Version
5	November 2012	10.0	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)
6	September 2013	11.0	Added the following commands: setSupportLogin, setTraceOff,
			setTraceOn

Updated the following commands: createVolume, makePrimary, makeRemote, modifyVolume

Contents
1 Overview..................................................................................................	7
Global parameters...................................................................................................................	8
Syntax.....................................................................................................................................	8
Return codes..........................................................................................................................	11
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
createRemoteAssociation.........................................................................................................	30
createRemoteSnapshot............................................................................................................	31
createServer...........................................................................................................................	33
createSite..............................................................................................................................	34
createSnapshot.......................................................................................................................	35
createSnapshotSchedule..........................................................................................................	36
createSnmpCommunityString....................................................................................................	37
createSnmpTrapTarget.............................................................................................................	38
createSyslogNotifyPolicy..........................................................................................................	39
createVolume.........................................................................................................................	40
deleteAdminGroup.................................................................................................................	41
deleteAdminUser....................................................................................................................	42
deleteAutoMountPolicy............................................................................................................	42
deleteCluster..........................................................................................................................	43
deleteEmailNotifyPolicy...........................................................................................................	43
deleteGroup..........................................................................................................................	44
deleteRemoteAssociation.........................................................................................................	45
deleteServer...........................................................................................................................	46
deleteSite..............................................................................................................................	46
deleteSnapshot.......................................................................................................................	47
deleteSnapshotSchedule..........................................................................................................	48
deleteSnapshotTempSpace.......................................................................................................	49
deleteSnmpCommunityString....................................................................................................	49
deleteSnmpTrapTarget.............................................................................................................	50

4Contents

deleteSyslogNotifyPolicy..........................................................................................................	51
deleteVirtualManager..............................................................................................................	51
deleteVolume.........................................................................................................................	52
disconnectLocalVolume............................................................................................................	53
discoverTcp............................................................................................................................	53
discoverUdp..........................................................................................................................	54
dismountVolume.....................................................................................................................	54
findADInfo.............................................................................................................................	55
getADInfo..............................................................................................................................	56
getAlertLog............................................................................................................................	57
getAutoMountPolicy................................................................................................................	58
getClusterInfo.........................................................................................................................	58
getDnsInfo.............................................................................................................................	59
getEventLog...........................................................................................................................	60
getGroupInfo.........................................................................................................................	61
getLocalVolumes.....................................................................................................................	62
getNotificationPolicy...............................................................................................................	63
getNsmInfo............................................................................................................................	63
getNsmLogs...........................................................................................................................	64
getPerformanceStats................................................................................................................	65
getRemoteSnapshotInfo...........................................................................................................	65
getScsiInfo.............................................................................................................................	66
getServerCapabilities..............................................................................................................	67
getServerInfo..........................................................................................................................	67
getServerJobInfo.....................................................................................................................	68
getServerVolumeInfo...............................................................................................................	69
getSiteInfo.............................................................................................................................	70
getSnapshotInfo......................................................................................................................	71
getSnapshotScheduleInfo.........................................................................................................	72
getSnmpInfo..........................................................................................................................	73
getSupportInfo.......................................................................................................................	74
getSystemInfo.........................................................................................................................	75
getVolumeInfo........................................................................................................................	75
getVolumeControllingServer.....................................................................................................	76
help......................................................................................................................................	77
makePrimary..........................................................................................................................	77
makeRemote..........................................................................................................................	78
modifyAdminGroup................................................................................................................	79
modifyAdminUser...................................................................................................................	80
modifyCluster.........................................................................................................................	81
modifyEmailNotifyPolicy..........................................................................................................	82
modifyGroup.........................................................................................................................	83
modifyNSM...........................................................................................................................	84
modifyRemoteAssociation........................................................................................................	85
modifyRemoteSnapshotSchedule...............................................................................................	86
modifyServer.........................................................................................................................	87
modifySite.............................................................................................................................	88
modifySnapshot ....................................................................................................................	89
modifySnapshotSchedule.........................................................................................................	90
modifySnmpCommunityString...................................................................................................	91
modifySnmpTrapTarget............................................................................................................	91
modifySyslogNotifyPolicy.........................................................................................................	92
modifyVolume........................................................................................................................	93
mountVolume.........................................................................................................................	94
rebalanceVip.........................................................................................................................	95

Contents 5

recoverQuorum......................................................................................................................	96
removeSnapshot.....................................................................................................................	97
removeVolume........................................................................................................................	97
resetSession...........................................................................................................................	98
rollbackSnapshot....................................................................................................................	99
runDiagnostic.......................................................................................................................	100
setADInfo............................................................................................................................	100
setAlertsPolicy......................................................................................................................	101
setAutoMountPolicy...............................................................................................................	102
setDnsInfo............................................................................................................................	103
setEmailServerInfo................................................................................................................	103
setGossipList........................................................................................................................	104
setLicenseKey.......................................................................................................................	105
setSnmpNotifyPolicy..............................................................................................................	106
setSnmpServiceInfo...............................................................................................................	107
setSupportLogin....................................................................................................................	107
setTraceOff..........................................................................................................................	108
setTraceOn..........................................................................................................................	108
shutdownGroup....................................................................................................................	109
shutdownNsm......................................................................................................................	109
startManager.......................................................................................................................	110
startSnmpService..................................................................................................................	111
startVirtualManager..............................................................................................................	111
stopManager.......................................................................................................................	112
stopSnmpService..................................................................................................................	112
stopVirtualManager..............................................................................................................	113
testCredentials......................................................................................................................	114
unassignVolume...................................................................................................................	114
unassignVolumeToServer........................................................................................................	115
utility..................................................................................................................................	116
vssSnapshot.........................................................................................................................	117
waitForEvent........................................................................................................................	118
waitForUpdate.....................................................................................................................	119
3 Support and other resources....................................................................	120
Contacting HP......................................................................................................................	120
Subscription service..........................................................................................................	120
HP Insight Remote Support software........................................................................................	120
Related information...............................................................................................................	120
HP websites....................................................................................................................	121
4 Documentation feedback.........................................................................	122

6Contents

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 the Syntax section.

The Global parameters section describes functionality that applies to the entire CLI and includes commands to customize global operations.

System Requirements

•Windows Server 2003 SP1

•Windows Server 2003 R2

•Windows Server 2008 R2, SP1, and SP2

•Windows XP SP2

•Windows Vista

•Windows 7

•Windows 8

•Windows Server 2012

•Windows Server 2012 R2

•10 MB available space

Installing the CLI

Install the CLI from the Management Software DVD. The installation wizard automatically installs the CLI software to the following default location in Windows and sets the environment variable:

C:\Program Files\HP\StoreVirtual\CLI

Accessing the CLI

The CLI is installed on each StoreVirtual storage system and can be accessed by SSH. To log in, 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:

•Sue and Bob send commands to StorageSystem–1

•Jim and Alan send commands to StorageSystem–2

•Les and Steve send commands to StorageSystem–3

7

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

8Overview

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

Syntax 9

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.
[ ]	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, v11.0.00.1252

(C) Copyright 2008-2013 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

10 Overview

Key	Meaning
	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 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
CliqSuccess	0	0
CliqNothingDone	1	1
CliqOperationPending	2	2
CliqOperationAbandoned	3	3
CliqNothingFound	4	4
CliqSnapshotSet	5	5
CliqVssSnapshotWarning	6	6
CliqPITSnapshotWarning	7	7
CliqParameterIgnored	8	8
CliqUnexpected	0x80001001	128
CliqXmlError	0x80001002	129
CliqParameterFormat	0x80001003	130
CliqParameterRepeat	0x80001004	131
CliqMissingMethod	0x80001005	132
CliqMissingParameter	0x80001006	133
CliqUnrecognizedCommand	0x80001007	134
CliqUnrecognizedParameter	0x80001008	135
CliqIncompatibleParameters	0x80001009	136

Description

Everything succeeded normally

Operation has succeeded, but nothing was done (the system was already in the requested state).

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.

Operation was cancelled or abandonded.

Operation found no objects.

This snapshot was a part of the snapshot set.

Warning: The writer operation failed.

Warning: Point in time snapshot is created.

The operation succeeded but a parameter was ignored as it is not applicable.

An unexpected error has occurred.

The XML given is not well-formed.

The parameter is not specified correctly.

A parameter is repeated.

The command method is missing.

One or more expected parameters are missing.

This command is unrecognized. This parameter is unrecognized.

Two or more parameters supplied are incompatible with each other.

Return codes

11

Result	Value	OS Status
CliqNotYetImplemented	0x8000100A	137
CliqNoMemory	0x8000100B	138
CliqVolumeNotFound	0x8000100C	139
CliqVolumeInUse	0x8000100D	140
CliqVolumeInitFailure	0x8000100E	141
CliqUnrecognizedVolume	0x8000100F	142
CliqOperationFailed	0x80001010	143
CliqCredentialsFailed	0x80001011	144
CliqInvalidParameter	0x80001012	145
CliqObjectNotFound	0x80001013	146
CliqConnectionFailure	0x80001014	147
CliqNotEnoughSpace	0x80001015	148
CliqNoManager	0x80001016	149
CliqSocketError	0x80001017	150
CliqOperationTimedOut	0x80001018	151
CliqNoPlatformSupport	0x80001019	152
CliqNoPlatformSupport	0x8000101A	153
CliqUtilityNotFound	0x8000101B	154
CliqUtilityNotAllowed	0x8000101C	155
CliqUtilityIllegalParameter	0x8000101D	156
CliqUtilityFailed	0x8000101E	157
CliqNodeNotFound	0x8000101F	158
CliqIllegalUsername	0x80001020	159
CliqIllegalPassword	0x80001021	160
CliqFileError	0x80001022	161
CliqMissingInitiator	0x80001023	162
CliqInitiatorStopped	0x80001024	163
CliqSanIqTooOld	0x80001025	164
CliqDefaultAdmin	0x80001026	165
CliqVssProviderNotInstalled	0x80001027	166
CliqVssProviderNotRunning	0x80001028	167
CliqVolumeNoSessions	0x80001029	168

Description

This is a legal command; it means it just has not been done yet.

Out of memory.

Could not find the requested volume.

The requested volume is in use.

Volume initialization failed.

The volume is an unrecognized type.

General LeftHand OS error - the operation failed.

The supplied credentials are incorrect.

Invalid parameter.

Object not found.

Failed to connect to the API server.

Not enough space to complete the command.

Could not find a manager.

Network socket error. Operation exceeded the specified timeout.

This operating system type does not support the operation.

This operating system version does not support the operation.

The utility command requested was not found. The utility command requested is not in the allowed list.

The utility command contains unsupported parameters or redirection.

The utility command executed, but returned a non-zero status code.

The specified storage system cannot be found.

The username must be 3–40 characters, starting with a letter.

The password must be 5–40 characters, not / or :.

General file error.

No iSCSI initiator found.

The iSCSI initiator is not running.

The version of LeftHand OS software must be upgraded.

You cannot delete, modify permissions, or remove the last user from the default administration group.

The HP StoreVirtual VSS Provider is not installed. The HP StoreVirtual VSS Provider is not running.

Cannot create an application-managed snapshot because there are no iSCSI connections associated with this volume. To create application-managed

12 Overview

Result	Value	OS Status	Description
			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
CliqVssLunInfoFailed	0x8000102E	173
CliqVssWriterUnavailable	0x8000102F	174
CliqSnapshotInProgress	0x80001030	175
CliqWindowsServerIsBusy	0x80001031	176
CliqUpdateVssProvider	0x80001032	177
CliqVssOperationTimedOut	0x80001033	178
CliqVolumeConnectionFailure	0x80001034	179
CliqServerInCluster	0x80001035	180
CliqVolumeError	0x80001036	181
CliqVolumeNoServer	0x80001037	182
CliqUnsupportedApplication	0x80001038	183
CliqServerVersionMismatch	0x80001039	184
CliqSnapshotNameExists	0x8000103A	185
CliqVolumeInvalidSet	0x8000103B	186
CliqNoVirtualManager	0x8000103C	187
CliqIllegalUserGroupName	0x8000103D	188
CliqIllegalUserDescription	0x8000103E	189
CliqIllegalIQN	0x8000103F	190
CliqIllegalWWN	0x80001040	191
CliqHbaError	0x80001041	192
CliqHbaNotSupported	0x80001042	193
CliqHbaInvalidHandle	0x80001043	194

Cannot create an application-managed snapshot because the system could not quiesce the application associated with this volume.

Cannot create an application-managed snapshot because the system failed to get LUN data.

The VSS writer operation failed.

Another app-managed snapshot is in progress.

The application server is busy.

This version of VSS provider must be upgraded.

VSS operation timed out.

Volume connection failure.

Server is in Cluster and cannot be changed via CliQ. Volume error.

Failed to contact Application Aware Snapshot Manager.

This application is not supported.

Server version is not compatible.

The snapshot with this name already exists.

Invalid volume set.

A Virtual Manager was not found.

User group name must be 3–40 characters a–z, 0–9, - or .; the first character must be a lowercase letter (a-z).

Username must be 3–40 characters A–., a–z, 0–9, - or .; the first character must be a letter (A–. or a-z).

IQN must be letters or numbers or the . or : characters.

WWN must be 16 Hex letters or numbers (A-F, 0-9) or the : character.

HBA status error. HBA function not supported.

HBA function, invalid handle.

Return codes 13

Result	Value	OS Status	Description
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.
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.

14 Overview

Result	Value	OS Status	Description
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
CliqHbaAlreadyLoaded	0x80001060	223
CliqHbaIllegalFcid	0x80001061	224
CliqHbaAscsiDevice	0x80001062	225
CliqHbaInvalidProtocolType	0x80001063	226
CliqHbaBadEventType	0x80001064	227
CliqMissingCIMProperty	0x80001065	228
CliqSANiQFeatureNotSupported	0x80001066	229
CliqParameterDeprecated	0x80001067	230
CliqNodeNotInGroup	0x80001068	231
CliqRemoteSnapshotNotFound	0x80001069	232
CliqMultipleIPAddresses	0x8000106A	233
CliqUnsupportedFC	0x8000106B	234
CliqVolumeNotMounted	0x8000106C	235
CliqMissingADParameter	0x8000106D	236
CliqIncorrectADServer	0x8000106E	237
CliqLastAdminUser	0x8000106F	238
CliqOperationNotPermitted	0x80001070	239
CliqUnsupportedParameter	0x80001071	240
CliqVSSInvalidBackupDoc	0x80001072	241
CliqCredentialsMissing	0x80001073	242
CliqSizeTooLarge	0x80001074	243

A call was made to HBA.FreeLibrary when no library was loaded.

A call was made to HBA.LoadLibrary when a library was already loaded.

The Address Identifier specified in a call to HBA.SendRNIDV2 violates access control rules for that call.

SCSI device.

Invalid protocol.

Bad event type.

An expected CIM property value was not found.

The requested feature or operation is not supported.

The '%s' parameter has been deprecated.

Node must be in a management group.

The snapshot was not found.

Multiple IP addresses were encountered.

This command is not supported for Fibre Channel.

The volume is not mounted on a server.

One or more Active Directory parameters entered are incorrect or missing.

The Active Directory server or possibly the BASEDN is incorrect or does not match.

You cannot delete the last user who is in a fully-permissioned group.

The attempted operation is not permitted.

A supplied parameter is unsupported on this management group.

The backup document file path is invalid.

Management group login credentials are not in the credential cache on the controlling server.

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

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.

16 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 Administrator 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

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.

18 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

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.

22 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: If not specified, the permissions are set to rrrr.
[adGroup]	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=]

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

28 Commands

Name	Description
[useVip]	Use virtual IP (VIP) addressing. Values are 0 or 1 (default).
[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.

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]

{alertOnInfo}

{alertOnWarning}

The level of returned information via email notification. Values are 1—Brief, 2—Standard, and 3—Verbose.

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.

createEmailNotifyPolicy 29

Name	Description
{alertOnCritical}
[emailLocale]	English (default), Chinese, Japanese, Korean, Spanish

Example 37 Windows

cliq createEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret email=[e-mail] alertOnWarning=1

Example 38 SSH

createEmailNotifyPolicy email=[e-mail] alertOnWarning=1

createGroup

Description

Create a new management group. This command may take several minutes to complete.

Syntax

createGroup {groupName=} {node=} {groupName=} {userName=} {passWord=}

Parameters

Name

{node}

{groupName} {userName} {passWord}

Description

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

The name of the management group.

The authentication user name for the storage system. 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

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=]

30 Commands