How it Works
HP
Loading...
S
Loading...
Loading...
StoreVirtual 4000
User Manual
122 pgs1.01 Mb0
User Manual
288 pgs8.14 Mb0
User Manual
40 pgs1.28 Mb0
User Manual
57 pgs810.56 Kb0
Table of contents
Loading...

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.
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.
DateEdition
DescriptionSoftware
Version
8.0November 20081
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
8.5March 20102
Added the following commands: clearVssVolumeFlags, getAlertLog,
getServerCapabilities, getServerVolumeInfo, getSupportInfo, removeSnapshotsetLicenseKey
9.0November 20103
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
Added the following commands: getServerJobInfo9.5September 20114
DateEdition
Version
DescriptionSoftware
10.0November 20125
11.0September 20136
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)
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
4 Contents
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
6 Contents

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".
8 Overview
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
DescriptionSymbol
|
{ }
[ ]
italic
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.
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:
TAB
MeaningKey
Moves the cursor one space to the left.LEFT
Moves the cursor one space to the right.RIGHT
Deletes the character under the cursor and moves the cursor to the left.BACKSPACE
Deletes the character under the cursor.DELETE
Recalls the previous command entered.UP
Recalls the first command entered.DOWN
Moves the cursor to the beginning of the line.HOME
Moves the cursor to the end of the line.END
Clears the current command line.ESCAPE
Toggles between insert mode (the default) and overwrite mode.INSERT
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
MeaningKey
suggested start with those required for the command, followed by optional parameters. No mutually exclusive parameters will be suggested.
!#

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.
Recalls the command from the previous command list by number (for example, !3 will recall the third command from the command list.
DescriptionOS StatusValueResult
Everything succeeded normally00CliqSuccess
11CliqNothingDone
Operation has succeeded, but nothing was done (the system was already in the requested state).
22CliqOperationPending
88CliqParameterIgnored
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.33CliqOperationAbandoned
Operation found no objects.44CliqNothingFound
This snapshot was a part of the snapshot set.55CliqSnapshotSet
Warning: The writer operation failed.66CliqVssSnapshotWarning
Warning: Point in time snapshot is created.77CliqPITSnapshotWarning
The operation succeeded but a parameter was ignored as it is not applicable.
An unexpected error has occurred.1280x80001001CliqUnexpected
The XML given is not well-formed.1290x80001002CliqXmlError
The parameter is not specified correctly.1300x80001003CliqParameterFormat
A parameter is repeated.1310x80001004CliqParameterRepeat
The command method is missing.1320x80001005CliqMissingMethod
One or more expected parameters are missing.1330x80001006CliqMissingParameter
This command is unrecognized.1340x80001007CliqUnrecognizedCommand
This parameter is unrecognized.1350x80001008CliqUnrecognizedParameter
1360x80001009CliqIncompatibleParameters
Two or more parameters supplied are incompatible with each other.
Return codes 11
DescriptionOS StatusValueResult
1370x8000100ACliqNotYetImplemented
This is a legal command; it means it just has not been done yet.
Out of memory.1380x8000100BCliqNoMemory
Could not find the requested volume.1390x8000100CCliqVolumeNotFound
The requested volume is in use.1400x8000100DCliqVolumeInUse
Volume initialization failed.1410x8000100ECliqVolumeInitFailure
The volume is an unrecognized type.1420x8000100FCliqUnrecognizedVolume
General LeftHand OS error - the operation failed.1430x80001010CliqOperationFailed
The supplied credentials are incorrect.1440x80001011CliqCredentialsFailed
Invalid parameter.1450x80001012CliqInvalidParameter
Object not found.1460x80001013CliqObjectNotFound
Failed to connect to the API server.1470x80001014CliqConnectionFailure
Not enough space to complete the command.1480x80001015CliqNotEnoughSpace
Could not find a manager.1490x80001016CliqNoManager
Network socket error.1500x80001017CliqSocketError
Operation exceeded the specified timeout.1510x80001018CliqOperationTimedOut
1520x80001019CliqNoPlatformSupport
1530x8000101ACliqNoPlatformSupport
1560x8000101DCliqUtilityIllegalParameter
1570x8000101ECliqUtilityFailed
1590x80001020CliqIllegalUsername
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.1540x8000101BCliqUtilityNotFound
The utility command requested is not in the allowed list.1550x8000101CCliqUtilityNotAllowed
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.1580x8000101FCliqNodeNotFound
The username must be 3–40 characters, starting with a letter.
The password must be 5–40 characters, not / or :.1600x80001021CliqIllegalPassword
General file error.1610x80001022CliqFileError
No iSCSI initiator found.1620x80001023CliqMissingInitiator
The iSCSI initiator is not running.1630x80001024CliqInitiatorStopped
The version of LeftHand OS software must be upgraded.1640x80001025CliqSanIqTooOld
12 Overview
1650x80001026CliqDefaultAdmin
1680x80001029CliqVolumeNoSessions
You cannot delete, modify permissions, or remove the last user from the default administration group.
The HP StoreVirtual VSS Provider is not installed.1660x80001027CliqVssProviderNotInstalled
The HP StoreVirtual VSS Provider is not running.1670x80001028CliqVssProviderNotRunning
Cannot create an application-managed snapshot because there are no iSCSI connections associated with this volume. To create application-managed
DescriptionOS StatusValueResult
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.
1690x8000102ACliqVolumeMultipleSessions
1700x8000102BCliqNoVssCapabilities
1710x8000102CCliqServerUnresponsive
1720x8000102DCliqVssSnapshotFailed
1730x8000102ECliqVssLunInfoFailed
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.
Cannot create an application-managed snapshot because the server does not support this capability.
Cannot create an application-managed snapshot because the system could not communicate to the necessary software component on the application server.
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.1740x8000102FCliqVssWriterUnavailable
Another app-managed snapshot is in progress.1750x80001030CliqSnapshotInProgress
The application server is busy.1760x80001031CliqWindowsServerIsBusy
This version of VSS provider must be upgraded.1770x80001032CliqUpdateVssProvider
VSS operation timed out.1780x80001033CliqVssOperationTimedOut
Volume connection failure.1790x80001034CliqVolumeConnectionFailure
Server is in Cluster and cannot be changed via CliQ.1800x80001035CliqServerInCluster
Volume error.1810x80001036CliqVolumeError
1820x80001037CliqVolumeNoServer
1880x8000103DCliqIllegalUserGroupName
1890x8000103ECliqIllegalUserDescription
1910x80001040CliqIllegalWWN
Failed to contact Application Aware Snapshot Manager.
This application is not supported.1830x80001038CliqUnsupportedApplication
Server version is not compatible.1840x80001039CliqServerVersionMismatch
The snapshot with this name already exists.1850x8000103ACliqSnapshotNameExists
Invalid volume set.1860x8000103BCliqVolumeInvalidSet
A Virtual Manager was not found.1870x8000103CCliqNoVirtualManager
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.1900x8000103FCliqIllegalIQN
WWN must be 16 Hex letters or numbers (A-F, 0-9) or the : character.
HBA status error.1920x80001041CliqHbaError
HBA function not supported.1930x80001042CliqHbaNotSupported
HBA function, invalid handle.1940x80001043CliqHbaInvalidHandle
Return codes 13
DescriptionOS StatusValueResult
HBA function, bad argument.1950x80001044CliqHbaInvalidArgument
WWN not recognized.1960x80001045CliqHbaIllegalWWN
HBA function, Index not recognized.1970x80001046CliqHbaIllegalIndex
HBA function, larger buffer required.1980x80001047CliqHbaMoreData
1990x80001048CliqHbaStaleData
2050x8000104ECliqHbaInvalidLun
2060x8000104FCliqHbaIncompatible
2070x80001050CliqHbaAmbitiousWWN
2080x80001051CliqHbaLocalBus
2090x80001052CliqHbaLocalTarget
Information has changed since the last call to HBA.RefreshInformation.
SCSI Check Condition reported.2000x80001049CliqHbaScsiCheckCondition
Adapter busy or reserved, retry may be effective.2010x8000104ACliqHbaBusy
Request timed out, retry may be effective.2020x8000104BCliqHbaTryAgain
Referenced HBA has been removed or deactivated.2030x8000104CCliqHbaUnavailable
The requested ELS was rejected by the local adapter.2040x8000104DCliqHbaElsReject
The specified LUN is not provided by the specified adapter.
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.
Multiple adapters have a matching WWN. This could occur if the NodeWWN of multiple adapters is identical.
A persistent binding request included a bad local SCSI bus number.
A persistent binding request included a bad local SCSI target number.
2100x80001053CliqHbaLocalLun
2110x80001054CliqHbaLocalScsiIdBound
2120x80001055CliqHbaTargetFcId
2130x80001056CliqHbaTargetNodeWWN
2140x80001057CliqHbaTargetPortWWN
2150x80001058CliqHbaTargetLun
2160x80001059CliqHbaTargetLuid
2170x8000105ACliqHbaNoSuchBinding
2180x8000105BCliqHbaNotTarget
2190x8000105CCliqHbaUnsupportedFc4
A persistent binding request included a bad local SCSI logical unit number.
A persistent binding set request included a local SCSI ID that was already bound.
A persistent binding request included a bad or unlocatable FCP Target FCID.
A persistent binding request included a bad FCP Target Node WWN.
A persistent binding request included a bad FCP Target Port WWN.
A persistent binding request included an FCP Logical Unit Number not defined by the identified Target.
A persistent binding request included an undefined or otherwise inaccessible Logical Unit Unique Identifier.
A persistent binding remove request included a binding which did not match a binding established by the specified port.
A SCSI command was requested to an Nx.Port that was not a SCSI Target Port.
A request was made concerning an unsupported FC-4 protocol.
14 Overview
DescriptionOS StatusValueResult
2200x8000105DCliqHbaIncapable
2210x8000105ECliqHbaTargetBusy
2220x8000105FCliqHbaNotLoaded
2230x80001060CliqHbaAlreadyLoaded
2240x80001061CliqHbaIllegalFcid
A request was made to enable unimplemented capabilities for a port.
A SCSI function was requested at a time when issuing the requested command would cause a SCSI overlapped command condition (see SAM-3).
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.2250x80001062CliqHbaAscsiDevice
Invalid protocol.2260x80001063CliqHbaInvalidProtocolType
Bad event type.2270x80001064CliqHbaBadEventType
An expected CIM property value was not found.2280x80001065CliqMissingCIMProperty
The requested feature or operation is not supported.2290x80001066CliqSANiQFeatureNotSupported
The '%s' parameter has been deprecated.2300x80001067CliqParameterDeprecated
Node must be in a management group.2310x80001068CliqNodeNotInGroup
The snapshot was not found.2320x80001069CliqRemoteSnapshotNotFound
Multiple IP addresses were encountered.2330x8000106ACliqMultipleIPAddresses
This command is not supported for Fibre Channel.2340x8000106BCliqUnsupportedFC
The volume is not mounted on a server.2350x8000106CCliqVolumeNotMounted
2360x8000106DCliqMissingADParameter
2370x8000106ECliqIncorrectADServer
2380x8000106FCliqLastAdminUser
2400x80001071CliqUnsupportedParameter
2420x80001073CliqCredentialsMissing
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.2390x80001070CliqOperationNotPermitted
A supplied parameter is unsupported on this management group.
The backup document file path is invalid.2410x80001072CliqVSSInvalidBackupDoc
Management group login credentials are not in the credential cache on the controlling server.
The requested size is too large.2430x80001074CliqSizeTooLarge
Return codes 15

2 Commands

addVirtualManager

Description
Add a virtual manager to a group.
Syntax
addVirtualManager {login=} { userName= passWord= | groupName= }
Parameters
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
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=]
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.
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.
The password for the storage system. Required when the userName parameter is used.{passWord}
Parameters
{userName}
{groupName}
16 Commands
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
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.
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.
DescriptionName
{passWord}
[namePrefix]
[accessRights]
[chapName]
[vipLoadBalance]
[exclusiveAccess]
The password for the storage system. Required when the userName parameter is used.
The name of the volume in the management group.{volumeName}
The CHAP target secret for the volume.{targetSecret}
A prefix string for newly created objects. A unique number value will be concatenated to this prefix to guarantee name uniqueness.
The access rights to the volume. Value are r—Read-only, x—No access, and rw—Read-write (default).
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).
The CHAP initiator secret for the volume.[initiatorSecret]
Use VIP load balancing for this host. Values are 0—Disabled and 1—Enabled. The default value is 1.
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
{userName}
{groupName}
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
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.
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.
The name of the volume in the management group.{volumeName}
The name of the server.{serverName}
assignVolumeToServer 17
DescriptionName
[accessRights]
[transport]
[lun]
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.
The access rights to the volume. Values are r—Read-only, x—No access, and rw—Read-write (default).
Set the communication path to iSCSI or Fibre Channel. Values are iSCSI and FC. Lowercase is accepted.
Set the LUN for the Fibre Channel attached volume. The value can be 1-255.
NOTE: LUN 255 is not supported by Microsoft Windows.
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
DescriptionName
The authentication user name for the storage system.{userName}
The password for the storage system.{passWord}
The name of the management group.{groupName}
The IP addresses or DNS-resolvable names of one or more storage systems.[login]
[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
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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.
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.
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.
The password for the storage system. Required when the userName parameter is used.
The name of the remote snapshot.{snapshotName}
Syntax
clearAlertsPolicy {login=} { userName= passWord= | groupName= }
cancelRemoteSnapshot 19
Parameters
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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.
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.
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.
The password for the storage system. Required when the userName parameter is used.
Syntax
clearCredentials {groupName=}
Parameters
Example 12 Windows
cliq clearCredentials groupName=TheGroup

clearADInfo

Description
Remove the active directory configuration from the management group.
Syntax
clearADInfo {login=} { userName= passWord= | groupName= }
DescriptionName
The name of the management group.{groupName}
20 Commands
Parameters
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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
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.
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.
The password for the storage system. Required when the userName parameter is used.
clearDnsInfo {login=} { userName= passWord= | groupName= }
Parameters
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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.
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.
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
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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
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.
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.
The password for the storage system. Required when the userName parameter is used.
clearSnmpNotifyPolicy {login=} { userName= passWord= | groupName= }
Parameters
{userName}
22 Commands
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
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.
DescriptionName
{groupName}
{passWord}
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
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.
The password for the storage system. Required when the userName parameter is used.
{userName}
{groupName}
{passWord}
Example 21 Windows
cliq clearSnmpServiceInfo login=10.0.1.3 userName=admin passWord=secret
Example 22 SSH
clearSnmpServiceInfo

clearVssVolumeFlags

Description
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
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.
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.
The password for the storage system. Required when the userName parameter is used.
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
DescriptionName
{volumeName}
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
The name of the locally attached storage device (for example, E:). This is not the name of the volume in the management group.
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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

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.
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.
The password for the storage system. Required when the userName parameter is used.
The name of the remote snapshot.{snapshotName}
The name of the volume in the management group.{volumeName}
Optional description[description]
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
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
{configuration}
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
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.
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.
The password for the storage system. Required when the userName parameter is used.
The RAID type to set. The possible RAID levels are reported with the getNsmInfo command.
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
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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.
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.
The password for the storage system. Required when the userName parameter is used.
The name of the volume in the management group.{volumeName}
connectVolume 25
DescriptionName
[initiatorport]
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
The iSCSI initiator IP outbound bind port number. If not specified, the default value is any unused IP port.
Automatically restore the iSCSI connection when the computer starts up.[persistent]
DescriptionName
{userName}
{groupName}
{passWord}
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

The IP addresses or DNS-resolvable names of one or more storage systems.{login}
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.
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.
The password for the storage system. Required when the userName parameter is used.
The name of the volume in the management group.{volumeName}
The name of the remote snapshot.{snapshotName}
Description
Create an administrative group.
Syntax
createAdminGroup {login=} { userName= passWord= | groupName= } {adminGroupName=} [description=] [adminUserName=] [permissions=] [adGroup=]
26 Commands
Parameters
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
[permissions]
Example 31 Windows
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.
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.
The password for the storage system. Required when the userName parameter is used.
The administrative group name.{adminGroupName}
Optional description[description]
Specifies the users that this group comprises.[adminUserName]
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.
The name of the associated active directory group.[adGroup]
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
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{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
DescriptionName
{groupName}
{passWord}
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

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.
The password for the storage system. Required when the userName parameter is used.
Specifies the users that this group comprises.{adminUserName}
The password for the administrative user.{adminPassWord}
Optional description[description]
The administrative group name.{adminGroupName}
Description
Create a cluster in a management group.
Syntax
createCluster {login=} { userName= passWord= | groupName= } {clusterName=} {node=} [description=] [useVip=] [vip=]
Parameters
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
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.
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.
The password for the storage system. Required when the userName parameter is used.
The name of the cluster.{clusterName}
{node}
28 Commands
The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.
Optional description[description]
DescriptionName
Use virtual IP (VIP) addressing. Values are 0 or 1 (default).[useVip]
[vip]
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.
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.
Syntax
createEmailNotifyPolicy {login=} { userName= passWord= | groupName= } {email=} [verbosity=] { alertOnInfo= | alertOnWarning= | alertOnCritical= } [emailLocale=]
Parameters
DescriptionName
The IP addresses or DNS-resolvable names of one or more storage systems.{login}
{userName}
{groupName}
{passWord}
[verbosity]
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.
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.
The password for the storage system. Required when the userName parameter is used.
The email address of the recipient.{email}
The level of returned information via email notification. Values are 1—Brief, 2—Standard, and 3—Verbose.
{alertOnInfo}
{alertOnWarning}
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
{alertOnCritical}
Example 37 Windows
cliq createEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret email=myemail@myhost.com alertOnWarning=1
Example 38 SSH
createEmailNotifyPolicy email=myemail@myhost.com 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
DescriptionName
English (default), Chinese, Japanese, Korean, Spanish[emailLocale]
{node}
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.
DescriptionName
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.{groupName}
The authentication user name for the storage system.{userName}
The password for the storage system.{passWord}
Syntax
createRemoteAssociation {login=} { userName= passWord= | groupName= } {remote=} [remoteUserName=] [remotePassWord=] [primaryBandwidth=] [remoteBandwidth=] [remotegroupname=]
30 Commands
Loading...
+ 92 hidden pages
Buy Points How it Works FAQ Contact Us Questions and Suggestions Privacy Policy Cookie Policy Terms of Use