HP StoreVirtual Storage Command-Line Interface User Guide This guide provides information for using the command-line interface provided with the HP StoreVirtual Storage software. Command syntax is included, along with a link to sample scripts available from the HP website.
Contents Overview............................................................................................................................... 5 Global Parameters...................................................................................................................6 Syntax................................................................................................................................... 7 Return Codes...............................................................................
deleteSnmpTrapTarget................................................................................................. 46 deleteSyslogNotifyPolicy.............................................................................................. 46 deleteVirtualManager.................................................................................................. 47 deleteVolume..............................................................................................................
provisionVolume..........................................................................................................83 rebalanceVip.............................................................................................................. 84 recoverQuorum........................................................................................................... 85 removeSnapshot..........................................................................................................86 removeVolume...
Overview The LeftHand OS command-line interface (CLI) is built upon the API released with version 8.x. Develop your own automation, scripting and management using the CLI. • For instructions about using the CLI, see the Syntax section. • The section on Global Parameters describes functionality that applies to the entire CLI and includes commands to customize global operations.
Global Parameters prompt= Some potentially destructive commands prompt before proceeding. This default behavior can be turned off by specifying "prompt=false". output= 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.
Syntax CLIQ is the command-line interface (CLI) for the HP StoreVirtual Storage Solution. The CLI specifies parameters in the form parameter= (specification), rather than dictating a particular order (positional) notation. Parameter ordering Ordering of parameters is not specified. Any order will do. For example: cliq deleteVolume volumeName=theVolume userName=user passWord=secret login=10.1.2.3 is equivalent to cliq deleteVolume login=10.1.2.
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 , where units are: • MB - megabytes (2^20) • GB - gigabytes (2^30) • TB - terabytes (2^40) There is no default for size units - the units must be specified.
>cliq HP StoreVirtual LeftHand OS Command Line Interface, v10.5 (type exit to quit) (C) Copyright 2007-2013 Hewlett-Packard Development Company, L.P. 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.
Return Codes All GAUCHE commands return an XML response containing a 32-bit result code, and a description of the result. Example: Success results are nonnegative values, while negative values indicate an error. Many errors returned by LeftHand OS and Hydra unfortunately do not return ordinal values that can be conveniently mapped into an API and CLI return code.
Result Value OS Status Description CliqUnrecognizedParameter 0x80001008 135 This parameter is unrecognized. CliqIncompatibleParameters 0x80001009 136 Two or more parameters supplied are incompatible with each other. CliqNotYetImplemented 0x8000100A 137 This is a legal command - we just haven't done it yet. CliqNoMemory 0x8000100B 138 Out of memory. CliqVolumeNotFound 0x8000100C 139 Could not find the requested volume. CliqVolumeInUse 0x8000100D 140 The requested volume is in use.
Result Value OS Status Description CliqIllegalPassword 0x80001021 160 The password must be 5..40 characters, not / or :. CliqFileError 0x80001022 161 General file error. CliqMissingInitiator 0x80001023 162 No iSCSI initiator found. CliqInitiatorStopped 0x80001024 163 The iSCSI initiator is not running. CliqSanIqTooOld 0x80001025 164 The version of LeftHand OS software must be upgraded.
Result Value OS Status Description CliqVssLunInfoFailed 0x8000102E 173 Cannot create an applicationmanaged snapshot because the system failed to get LUN data. CliqVssWriterUnavailable 0x8000102F 174 The VSS writer operation failed. CliqSnapshotInProgress 0x80001030 175 Another app-managed snapshot is in progress. CliqWindowsServerIsBusy 0x80001031 176 The application server is busy. CliqUpdateVssProvider 0x80001032 177 This version of VSS provider must be upgraded.
Result Value OS Status Description 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.
Result Value OS Status Description 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 208 A SCSI command was requested to an Nx_Port that was not a SCSI Target Port.
Result Value OS Status Description CliqMultipleIPAddresses 0x8000106A 233 Multiple IP addresses were encountered.
Commands addVirtualManager This command adds a virtual manager to a group. Availability: Windows, SSH Version: 8.0 Request Syntax cliq addVirtualManager login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system.
accessRights Optional initiator Optional vipLoadBalance Optional exclusiveAccess Optional The access rights to the volume: r - read-only, x - no access, rw - readwrite (default) A semicolon delimited string of host IQN's. If this is not specified, the IQN of the local server is used (this parameter is required if run on a storage system). Valid characters are any letter, number, international character or '-', '.' and ':' characters. Use VIP load balancing for this host.
Example cliq assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret login=10.0.1.2 userName=admin passWord=secret cliq assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret assignVolumeToServer This command assigns a volume to a server (use for either iSCSI or FibreChannel). Availability: Windows, SSH Version: 9.
userName passWord groupName Required Required Required The authentication user name for the storage system. The password for the storage system. The name of the management group Example cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret cancelRemoteSnapshot This command cancels a remote snapshot. Availability: Windows, SSH Version: 8.
groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). Example cliq clearAlertsPolicy login=10.0.1.3 userName=admin passWord=secret cliq clearAlertsPolicy clearCredentials This command removes the association between a username/password pair and a management group name from the registry cached credentials. Availability: Windows Version: 8.
clearDnsInfo This command clears the DNS settings. Availability: Windows, SSH Version: 9.0 Request Syntax cliq clearDnsInfo login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system.
clearSnmpNotifyPolicy This command clears the SNMP Notification Policy settings. Availability: Windows, SSH Version: 9.0 Request Syntax cliq clearSnmpNotifyPolicy login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system.
clearVssVolumeFlags This command resets snapshot flags in the vss volume. This command is only supported for Windows Server 2008 and higher. Availability: Windows Version: 8.5 Request Syntax cliq clearVssVolumeFlags volumeName= volumeName Required The name of the volume Example cliq clearVssVolumeFlags volumeName=x: cloneSnapshot This command creates one or more SmartClone volumes from a LeftHand OS snapshot. These SmartClone volumes have all the functionality of normal volumes.
configureRaid This command reconfigures the RAID setting on a storage system. Availability: Windows, SSH Version: 8.0 Request Syntax cliq configureRaid configuration= login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional configuration Required The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified).
Example cliq connectVolume volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret convertSnapshotTempSpace This command converts snapshot temporary space to a volume. Availability: Windows, SSH Version: 8.
groupName Conditional adminGroupName description adminUserName permissions Required Optional Optional Optional adGroup Optional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). The administrative group name Optional description Specifies the users that this group comprises. Permissions for the group. This is a character sequence specifying the allowable permissions in the following order: Group,Network,Storage System,Report.
Example cliq createAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user" adminUserName=user adminPassWord=secret adminGroupName="Full Administrator" cliq createAdminUser description="My shiny new user" adminUserName=user adminPassWord=secret adminGroupName="Full Administrator" createCluster This command creates a cluster in a management group. Availability: Windows, SSH Version: 8.
createEmailNotifyPolicy This command configures which level of events from the management group are sent via email to the designated recipients. Availability: Windows, SSH Version: 9.
cliq createGroup groupName= node= userName= passWord= node Required groupName userName passWord Required Required Required 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 cliq createGroup groupName=TheGroup node=10.1.2.3;10.1.2.
Example cliq createRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin remotePassWord=secret primaryBandwidth=10Mb remoteBandwidth=10Mb cliq createRemoteAssociation remote=10.0.1.3 remoteUserName=admin remotePassWord=secret primaryBandwidth=10Mb remoteBandwidth=10Mb createRemoteSnapshot This command creates a remote snapshot of a LeftHand OS volume. Availability: Windows, SSH Version: 8.
remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.21" cliq createRemoteSnapshot primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0 remoteVolume=Volume0 description="Exchange DB-1" remote=10.1.2.4 remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.21" createServer This command creates a representation of a client server in a management group. This "server" can be associated with iSCSI or FibreChannel initiators and be granted access to volumes.
wwpn Optional bootvolumelun Optional bootvolumename Optional via FibreChannel and a value of 0 is entered, the client will lose its ability to communicate with the attached volumes. A semicolon delimited list of the unique World Wide Port Name for one or more FibreChannel ports. Expected WWPN formatting is 16 Hex characters with or without the ':' character as a delimiter. For example: 20:21:00:0E:B3:01:AB:C6 or 2021000EB301ABC6. Lower case hex characters a-f are also accepted.
createSnapshot This command creates a snapshot of one or more LeftHand OS volumes. Availability: Windows, SSH Version: 8.
login Required userName Conditional passWord Conditional groupName Conditional volumeName scheduleName recurperiod Required Required Required starttime Required description retentioncount Optional Optional retentionseconds Optional remoteip remoteUserName remotePassWord remoteCluster remoteVolume remoteretentioncount Optional Optional Optional Optional Optional Optional remoteretentionseconds Optional managed Optional remotegroupname Optional The IP addresses or DNS-resolvable names
createSnmpCommunityString This command creates an SNMP Community String. The Community String must be the same for all. If no item exists, the Community String is used, otherwise it is ignored and the Community String of existing items is used. Either specify IPAddress (ip address or hostname) or an IP mask and IP Subnet. Availability: Windows, SSH Version: 9.
groupName ipAddress version communityString Conditional Required Required Required The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). This is the IP address or Host Name to be configured. The SNMP Version. 1 - Version 1, 2 - Version 2 The SNMP community string. Example cliq createSnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret ipAddress=10.0.10.25 version=1 communityString=TrapString cliq createSnmpTrapTarget ipAddress=10.
Example cliq createSyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ipAddress="10.0.10.25" alertOnCritical="1" alertOnWarning=1 cliq createSyslogNotifyPolicy ipAddress="10.0.10.25" alertOnCritical="1" alertOnWarning=1 createVolume This command creates a SAN volume without connecting to a host. Availability: Windows, SSH Version: 8.0 Warnings Using a stridePages value other than the default may impact volume IO performance.
Example cliq createVolume volumeName=MyVolume clusterName=TheCluster size=100GB description="Exchange DB-1" login=10.0.1.2;10.0.1.3 userName=admin passWord=secret cliq createVolume volumeName=MyVolume clusterName=TheCluster size=100GB description="Exchange DB-1" deleteAdminGroup This command deletes an administrative group. Availability: Windows, SSH Version: 8.
groupName adminUserName Conditional Required The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). Specifies the users that this group comprises. Example cliq deleteAdminUser login=10.0.1.3 userName=admin passWord=secret adminUserName=user cliq deleteAdminUser adminUserName=user deleteAutoMountPolicy This command deletes the auto-mount policy for the HP StoreVirtual Recovery Manager application on this computer.
Example cliq deleteCluster clusterName=TheCluster login=10.1.2.3 userName=admin passWord=secret cliq deleteCluster clusterName=TheCluster deleteEmailNotifyPolicy This command deletes an Email Notification Policy. The designated recipient will no longer receive emails from management group alerts. Availability: Windows, SSH Version: 9.
groupName Required The name of the management group Example cliq deleteGroup login=10.1.2.3 userName=admin passWord=secret groupName="MG2" cliq deleteGroup groupName="MG2" deleteRemoteAssociation This command deletes a remote group to primary group association. Availability: Windows, SSH Version: 8.
Request Syntax cliq deleteServer serverName= login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional serverName Required The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified).
Warnings This operation is irreversible. Request Syntax cliq deleteSnapshot snapshotName= login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional snapshotName Required The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system.
deleteSnapshotTempSpace This command deletes the snapshot temporary space. Availability: Windows, SSH Version: 8.0 Warnings This operation is irreversible. Request Syntax cliq deleteSnapshotTempSpace snapshotName= login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional snapshotName Required The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system.
ipSubnet Optional An IP Address subnet for SNMP notification. Example cliq deleteSnmpCommunityString ipAddress=10.0.10.25 login=10.1.2.3 userName=admin passWord=secret cliq deleteSnmpCommunityString ipAddress=10.0.10.25 deleteSnmpTrapTarget This command deletes an SNMP Trap Target. Availability: Windows, SSH Version: 9.
groupName ipAddress Conditional Required The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). This is the IP address or Host Name to be configured. Example cliq deleteSyslogNotifyPolicy ipAddress=10.10.10.25 login=10.1.2.3 userName=admin passWord=secret cliq deleteSyslogNotifyPolicy ipAddress=10.10.10.25 deleteVirtualManager This command deletes a virtual manager from a group. Availability: Windows, SSH Version: 8.
userName Conditional passWord Conditional groupName Conditional volumeName Required The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). The name of the volume Example cliq deleteVolume volumeName=MyVolume login=10.1.2.
Example cliq discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4 cliq discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4 discoverUdp This command discovers storage systems and management groups on the network, using UDP. Availability: Windows, SSH Version: 8.0 Request Syntax cliq discoverUdp ipMask= ipSubnet= ipMask ipSubnet groupOrder Required Required Optional receivePort Optional waitForData Optional An IP adderss mask for SNMP notification. An IP Address subnet for SNMP notification.
findADInfo This command queries the management group for information about the associated AD domain. Availability: Windows, SSH Version: 10.0 Request Syntax cliq findADInfo login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional hostName Optional adUserName Optional ldaps Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system.
name memoryUsage description CliqSuccess 838981 Operation succeeded. INFO basedn DC=win8dom,DC=com CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 adusername=dtest@win8dom.com HP StoreVirtual Command Line Interface, v10.0.0.1 (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P. RESPONSE result processingTime name memoryUsage description 0 3971 CliqSuccess 837947 Operation succeeded.
Version: 10.0 Request Syntax cliq getADInfo login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials.
userName Conditional passWord Conditional groupName Conditional logFile Optional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified).
searchDepth Optional verbose Optional Which objects to inspect 1 - Clusters only, 2 - Clusters and volumes, 3 - Clusters, volumes and snapshots, 4 - Clusters, volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take. How much information to return 0 - Get summary information only (better performance), 1 - Get all information (better information default). The greater the verbose number, the longer the call can take. Response Syntax CLUSTER ...
Example cliq getDnsInfo login=10.0.1.3 userName=admin passWord=secret cliq getDnsInfo getEventLog This command returns event information. Availability: Windows, SSH Version: 9.
Request Syntax cliq getGroupInfo login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional searchDepth Optional verbose Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified).
Example cliq getGroupInfo login=10.1.2.3 userName=admin passWord=secret cliq getGroupInfo getLocalVolumes This command returns information about connected volumes hosted by the HP StoreVirtual array. Availability: Windows Version: 8.0 Request Syntax cliq getLocalVolumes searchDepth Optional Which objects to inspect 1 - Volumes only, 2 - Volumes and snapshots, 3 - Volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take.
getNsmInfo This command returns information about a storage system. Availability: Windows, SSH Version: 8.0 Request Syntax cliq getNsmInfo login= userName= passWord= login Required userName Conditional passWord Conditional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system.
userName Conditional passWord Conditional logFile Required The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the local file used to store the returned information Example cliq getNsmLogs login=10.1.2.3 userName=admin passWord=secret logFile=c:\logs.tar.
userName Conditional passWord Conditional groupName Conditional snapshotName verbose Optional Optional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified).
serverIp Required The Windows server IP address. Example cliq getServerCapabilities serverIp=10.0.1.2 cliq getServerCapabilities serverIp=10.0.1.2 getServerInfo This will return information about server configurations in the management group, which contain permission settings for real client servers to connect to LeftHand OS volumes. Availability: Windows, SSH Version: 9.
cliq getServerJobInfo serverIp= jobId= serverIp jobId volumeName Required Optional Optional The Windows server IP address.
getServerVolumeInfo This command returns the features of a volume by interrogating a remote server. This will return VSS associated volumes. Availability: Windows, SSH Version: 8.5 Request Syntax cliq getServerVolumeInfo serverIp= serverIp searchDepth Required Optional The Windows server IP address. Which objects to inspect 1 - Volumes only, 2 - Volumes and snapshots, 3 - Volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take.
SITE NSM This section contains site information. This section contains NSM information. Example cliq getSiteInfo siteName=TheSite login=10.1.2.3 userName=admin passWord=secret cliq getSiteInfo siteName=TheSite getSnapshotInfo This command returns information about a snapshot. Availability: Windows, SSH Version: 8.
Example cliq getSnapshotInfo snapshotName=TheSnapshot login=10.1.2.3 userName=admin passWord=secret cliq getSnapshotInfo snapshotName=TheSnapshot getSnapshotScheduleInfo This command returns information about snapshot schedules. Availability: Windows, SSH Version: 9.
userName Conditional passWord Conditional groupName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). Response Syntax SNMPSERVICEPOLICY ... SNMPNOTIFICATIONPOLICY ... SNMPCOMMUNITYSTRING ...
FCADAPTER This section contains fibre channel adapter information. Example cliq getSupportInfo login=10.1.2.3 userName=admin passWord=secret filepath=c:\temp getSystemInfo This command returns version information about the API, and other dependent libraries. Availability: Windows, SSH Version: 8.0 Request Syntax cliq getSystemInfo Response Syntax INFO ... FCADAPTER ... INFO FCADAPTER This section contains active directory information. This section contains fibre channel adapter information.
searchDepth Optional verbose Optional Which objects to inspect 1 - Volumes only, 2 - Volumes and snapshots, 3 - Volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take. How much information to return 0 - Get summary information only (better performance), 1 - Get all information (better information default). The greater the verbose number, the longer the call can take. Response Syntax VOLUME ... STATUS ... REMOTESNAPSHOT ... SNAPSHOT ...
Example cliq getVolumeControllingServer login=10.0.1.2 userName=admin passWord=secret volumeName="The Volume" cliq getVolumeControllingServer volumeName="The Volume" help This command returns information about the currently supported API command set. Availability: Windows, SSH Version: 8.
Example cliq makePrimary login=10.1.2.3 userName=admin passWord=secret volumeName="TheVolume" size=1GB cliq makePrimary volumeName="TheVolume" size=1GB makeRemote This command demotes a primary volume to a remote snapshot target. Availability: Windows, SSH Version: 8.
userName Conditional passWord Conditional groupName Conditional adminGroupName adminUserName description permissions Required Optional Optional Optional adGroup Optional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials.
Example cliq modifyAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user" adminUserName=user adminPassWord=secret cliq modifyAdminUser description="My shiny new user" adminUserName=user adminPassWord=secret modifyCluster This command changes settings on a cluster. Availability: Windows, SSH Version: 8.0 Warnings Modifying a cluster will cause a restripe of every volume in the cluster.
modifyEmailNotifyPolicy This command modifies an Email Notification Policy. Availability: Windows, SSH Version: 9.
Request Syntax cliq modifyGroup login= userName= passWord= node= login Required userName Conditional passWord Conditional groupName Conditional node Optional bandwidthPriority Optional customerName supportId contactName postalAddress postalAddress2 cityName stateName countryName postalCode telephoneNumber emailaddress Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional Optional The IP addresses or DNS-resolvable names of one or more storage systems The aut
fcenabled Required Enable or disable the fibrechannel port(s). This can be one of: 0 disable, 1 - enable. Default is 0. If a WWPN is entered, this value will stay at its default value of 0 unless specifically set by using this parameter. Example cliq modifyNSM login=10.0.1.2 userName=admin passWord=secret fcenabled=1 modifyRemoteAssociation This command modifies a previously created remote volume association. Availability: Windows, SSH Version: 8.0 Warnings This operation is irreversible.
modifyRemoteSnapshotSchedule This command modifies a previously created remote snapshot schedule. Availability: Windows, SSH Version: 9.
serverName description allowiSCSIAccess Required Optional Optional vipLoadBalance Optional useCHAP Optional initiator Optional targetSecret chapName Optional Optional initiatorSecret controllingserver Optional Optional allowfcaccess Optional wwpn Optional bootvolumelun Optional bootvolumename Optional The name of the server Optional description Allow iSCSI access for this host. This can be one of: 0 = disable or 1 = enable.
This operation is irreversible. Request Syntax cliq modifySite siteName= description= login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional siteName node Required Optional description primary Optional Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system.
Example cliq modifySnapshot description="New Description" login=10.0.1.2 userName=admin passWord=secret snapshotName=TheSnapshot cliq modifySnapshot description="New Description" snapshotName=TheSnapshot modifySnapshotSchedule This command modifies a previously created snapshot schedule. Availability: Windows, SSH Version: 9.
modifySnmpCommunityString This command modifies the Community String for all SNMP. Availability: Windows, SSH Version: 9.0 Request Syntax cliq modifySnmpCommunityString login= userName= passWord= communityString= login Required userName Conditional passWord Conditional groupName Conditional communityString Required The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system.
Example cliq modifySnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret communityString="TheString cliq modifySnmpTrapTarget communityString="TheString" modifySyslogNotifyPolicy This command modifies a Syslog Notification Policy. Availability: Windows, SSH Version: 9.
Warnings Using a stridePages value other than the default may impact volume IO performance. Using an initialQuota value other than the default may impact volume IO performance. Enabling checksums may impact volume IO performance. Changing the replication level of this volume will cause it to restripe, and may impact IO performance.
mountVolume This command mounts a volume to the specified mount point. Availability: Windows Version: 8.0 Warnings Prior to mounting the volume, the volume must be assigned to the server (assignVolume) and connected (connectVolume).
passWord Conditional groupName Conditional clusterName volumeName size Required Required Required description replication parity Optional Optional Optional checkSum thinProvision Optional Optional mountPoint Optional namePrefix Optional vipLoadBalance Optional targetSecret chapName Optional Optional initiatorSecret Optional The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials.
passWord Conditional groupName Conditional volumeName Required The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). The name of the volume Example cliq rebalanceVip volumeName=MyVolume login=10.1.2.
removeSnapshot This command disconnects a SAN snapshot from the host, then deletes it. If the snapshot cannot be disconnected (because it's in use, or for any other reason), it will not be deleted. Availability: Windows Version: 8.
resetSession This command resets the iSCSI session associated with a volume. Some initiators will attempt to reconnect after the reset. Availability: Windows, SSH Version: 8.0 Request Syntax cliq resetSession volumeName= login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional volumeName initiator Required Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system.
userName Conditional passWord Conditional groupName Conditional snapshotName description Required Optional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified).
login Required userName Conditional passWord Conditional groupName Conditional adServer baseDN bindUserName Required Required Optional bindPassWord userContext testOnly Optional Optional Optional ldaps Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified).
setAutoMountPolicy This command sets the auto-mount policy for the HP StoreVirtual Recovery Manager application on this computer. Availability: Windows Version: 10.0 Warnings The HP StoreVirtual Recovery Manager must be installed on the system to implement automount polices defined by the CLIQ. When running the command, if no groupName parameter is supplied, default credentials will be modified.
server Optional List of DNS servers, IP addresses. Example cliq setDnsInfo login=10.0.1.3 userName=admin passWord=secret server=10.23.0.101 suffix=suffix1;suffix2 domainname=domainname cliq setDnsInfo server=10.23.0.101 suffix=suffix1;suffix2 domainname=domainname setEmailServerInfo This command sets the configuration information for the email server used to email alerts to configured recipients. Availability: Windows, SSH Version: 9.
cliq setGossipList login= userName= passWord= node= login Required userName Conditional passWord Conditional groupName Conditional node Required The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials.
setSnmpNotifyPolicy This command sets SNMP Notification Policy settings. Availability: Windows, SSH Version: 9.
passWord Conditional groupName Conditional contactinfo location Optional Optional The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). Contact information. Location information. Example cliq setSnmpServiceInfo login=10.0.1.
login Required userName Conditional passWord Conditional groupName Conditional action Required delay Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials.
cliq startSnmpService login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials.
login Required userName Conditional passWord Conditional groupName Conditional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified).
userName Conditional passWord Conditional groupName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). Example cliq stopVirtualManager login=10.0.1.
passWord Conditional groupName Conditional volumeName Required The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). The name of the volume Example cliq unassignVolume volumeName=TheVolume login=10.0.1.
cliq utility run= login= userName= passWord= login Required userName Conditional passWord Conditional groupName Conditional run Optional logFile useZip Optional Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified).
breakShadowCopies maskLun Optional Optional snapshotName userName Optional Conditional passWord Conditional description Optional Break the shadow copy set Mask the shadow copy LUN from the host. It works in conjunction with breakShadowCopies and is valid only when breakShadowCopies is specified (Windows 2008 only). The name of the remote snapshot The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system.
login Required userName Conditional passWord Conditional groupName Conditional receivePort Optional timetowait Optional The IP addresses or DNS-resolvable names of one or more storage systems The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). The password for the storage system. (Parameters userName/passWord or groupName must be specified). The name of the management group with cached credentials.
