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.
© Copyright 2008, 2013 Hewlett-Packard Development Company, L.P. Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license. The information contained herein is subject to change without notice.
Edition Date Software Description Version 5 November 2012 10.0 Added the following commands: clearADInfo, deleteAutoMountPolicy, findADInfo, findFile, getADInfo, getAutoMountPolicy, modifyNSM, setADInfo, setAutoMountPolicy Removed the following commands: AssignVolume (use AssignVolumeToServer instead); provisionVolume (functionality divided over CreateVolume, AssignVolumeToServer, ConnectVolume, and MountVolume) 6 September 2013 11.
Contents 1 Overview..................................................................................................7 Global parameters...................................................................................................................8 Syntax.....................................................................................................................................8 Return codes..........................................................................................................
deleteSyslogNotifyPolicy..........................................................................................................51 deleteVirtualManager..............................................................................................................51 deleteVolume.........................................................................................................................52 disconnectLocalVolume.........................................................................................
recoverQuorum......................................................................................................................96 removeSnapshot.....................................................................................................................97 removeVolume........................................................................................................................97 resetSession.................................................................................................
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.
Global parameters prompt= Some 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.
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.
Command availability When commands are available for both Windows and SSH, a command example is given for both. If a command is only available for Windows, a command example is given only for Windows. Command line conventions Symbol Description | Used to separate input options. For example, { userName= passWord= | groupName= } means that you enter userName with the passWord or the groupName parameter. {} Denotes a required parameter. For example, {login} must be specified.
Key Meaning suggested start with those required for the command, followed by optional parameters. No mutually exclusive parameters will be suggested. !# Recalls the command from the previous command list by number (for example, !3 will recall the third command from the command list. Return codes All commands return an XML response containing a 32-bit result code, and a description of the result. Example: PAGE 12Result Value OS Status Description CliqNotYetImplemented 0x8000100A 137 This is a legal command; it means it just has not been done yet. CliqNoMemory 0x8000100B 138 Out of memory. CliqVolumeNotFound 0x8000100C 139 Could not find the requested volume. CliqVolumeInUse 0x8000100D 140 The requested volume is in use. CliqVolumeInitFailure 0x8000100E 141 Volume initialization failed. CliqUnrecognizedVolume 0x8000100F 142 The volume is an unrecognized type.
Result Value OS Status Description snapshots, there must be at least one application server associated with the volume via an iSCSI connection. The volume must be connected to a VSS-enabled server. CliqVolumeMultipleSessions 0x8000102A 169 Cannot create an application-managed snapshot because there is more than one IQN (iSCSI Qualified Name) associated with this volume. To create application-managed snapshots, there must be only one application server associated with the volume.
Result Value OS Status Description CliqHbaInvalidArgument 0x80001044 195 HBA function, bad argument. CliqHbaIllegalWWN 0x80001045 196 WWN not recognized. CliqHbaIllegalIndex 0x80001046 197 HBA function, Index not recognized. CliqHbaMoreData 0x80001047 198 HBA function, larger buffer required. CliqHbaStaleData 0x80001048 199 Information has changed since the last call to HBA.RefreshInformation. CliqHbaScsiCheckCondition 0x80001049 200 SCSI Check Condition reported.
Result Value OS Status Description CliqHbaIncapable 0x8000105D 220 A request was made to enable unimplemented capabilities for a port. CliqHbaTargetBusy 0x8000105E 221 A SCSI function was requested at a time when issuing the requested command would cause a SCSI overlapped command condition (see SAM-3). CliqHbaNotLoaded 0x8000105F 222 A call was made to HBA.FreeLibrary when no library was loaded. CliqHbaAlreadyLoaded 0x80001060 223 A call was made to HBA.
2 Commands addVirtualManager Description Add a virtual manager to a group. Syntax addVirtualManager {login=} { userName= passWord= | groupName= } Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.
Name Description {passWord} The password for the storage system. Required when the userName parameter is used. {volumeName} The name of the volume in the management group. {targetSecret} The CHAP target secret for the volume. [namePrefix] A prefix string for newly created objects. A unique number value will be concatenated to this prefix to guarantee name uniqueness. [accessRights] The access rights to the volume. Value are r—Read-only, x—No access, and rw—Read-write (default).
Name Description [accessRights] The access rights to the volume. Values are r—Read-only, x—No access, and rw—Read-write (default). [transport] Set the communication path to iSCSI or Fibre Channel. Values are iSCSI and FC. Lowercase is accepted. [lun] Set the LUN for the Fibre Channel attached volume. The value can be 1-255. NOTE: LUN 255 is not supported by Microsoft Windows. Example 5 Windows cliq assignVolumeToServer volumeName=TheVolume serverName=TheServer login=10.0.1.
Example 7 Windows cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret OR cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret login=10.0.18.9 cancelRemoteSnapshot Description Cancel a remote snapshot. Syntax cancelRemoteSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=} Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 15 Windows cliq clearDnsInfo login=10.0.1.3 userName=admin passWord=secret Example 16 SSH clearDnsInfo clearEmailServerInfo Description Clear the email server settings. Syntax clearEmailServerInfo {login=} { userName= passWord= | groupName= } Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it.
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. Example 19 Windows cliq clearSnmpNotifyPolicy login=10.0.1.
Parameters Name Description {volumeName} The name of the locally attached storage device (for example, E:). This is not the name of the volume in the management group. Example 23 Windows cliq clearVssVolumeFlags volumeName=x: cloneSnapshot Description Create one or more SmartClone volumes from a StoreVirtual snapshot. These SmartClone volumes have all the functionality of normal volumes.
Syntax configureRaid {login=} { userName= passWord= | groupName= } {configuration=} Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group.
Name Description [initiatorport] The iSCSI initiator IP outbound bind port number. If not specified, the default value is any unused IP port. [persistent] Automatically restore the iSCSI connection when the computer starts up. Example 28 Windows cliq connectVolume volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret convertSnapshotTempSpace Description Convert snapshot temporary space to a volume.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. {adminUserName} Specifies the users that this group comprises. {adminPassWord} The password for the administrative user.
Name Description [useVip] Use virtual IP (VIP) addressing. Values are 0 or 1 (default). [vip] A delimited list of virtual IP address or DNS-resolvable name and subnet mask. NOTE: Since each VIP contains two parameters, IP address and subnet mask, both must be specified in order, even if empty. If multiple VIPs are entered, they must be on different subnets. Example 35 Windows cliq createCluster login=10.0.1.
Name Description {alertOnCritical} [emailLocale] English (default), Chinese, Japanese, Korean, Spanish Example 37 Windows cliq createEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret email=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.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 43 Windows cliq createRemoteSnapshot login=10.1.2.3 userName=admin passWord=secret primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0 remoteVolume=Volume0 description="Exchange DB-1" remote=10.1.2.4 remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.21" Example 44 SSH createRemoteSnapshot primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0 remoteVolume=Volume0 description="Exchange DB-1" remote=10.1.2.4 remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.
Name Description [chapName] The CHAP name for the volume. If this is not specified, the IQN of the local server is used (this parameter is required if run on a storage system). [initiatorSecret] The CHAP initiator secret for the volume. [controllingserver] Enter the IP address of the client server that has Application Aware Snapshot Manager (AASM) installed on it. It will coordinate the snapshot with the applications using SAN volumes.
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. {siteName} The name of the site. [description] Optional description [primary] This site is the primary site. Values are 0—Disabled and 1—Enabled. 1 is the default.
Name Description [managed] Values are 0—The snapshot(s) will not attempt to use VSS on the host connected to the volume (default) and 1—The snapshot(s) will attempt to use VSS on the host connected to the volume. [wait] Determines whether to wait for the application managed snapshot process to complete or not. Values are 0—Do not wait and 1—Wait for it to complete (default). Example 49 Windows cliq createSnapshot volumeName=volume0;volume1 snapshotName=snapshot0;snapshot1 login=10.0.1.
Name Description [description] Optional description [retentioncount] The number of snapshots to maintain. Must be between 1 and 50. Either retentioncount or retentionseconds must be specified. [retentionseconds] How long snapshots should be retained. Either retentioncount or retentionseconds must be specified. [remoteip] The IP address of the remote group. [remoteUserName] The authentication user name for the remote group. [remotePassWord] The password for the remote group.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Name Description {version} The SNMP Version. Values are 1—Version 1 and 2—Version 2. {communityString} The SNMP community string. Example 55 Windows cliq createSnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret ipAddress=10.0.10.25 version=1 communityString=TrapString Example 56 SSH createSnmpTrapTarget ipAddress=10.0.10.25 version=1 communityString=TrapString createSyslogNotifyPolicy Description Create a Syslog Notification Policy.
Example 57 Windows cliq createSyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ipAddress="10.0.10.25" alertOnCritical="1" alertOnWarning=1 Example 58 SSH createSyslogNotifyPolicy ipAddress="10.0.10.25" alertOnCritical="1" alertOnWarning=1 createVolume Description Create a SAN volume without connecting to a host. CAUTION: Enabling checksums may impact volume I/O performance.
Name Description • replication:3, parity:0 Network RAID-10+1 (3-way Mirror) • replication:4, parity:0 Network RAID-10+2 (4-way Mirror) • replication:2, parity:1 Network RAID-5 (Single parity) • replication:3, parity:2 Network RAID-6 (Dual Parity) [checkSum] Values are 0—The volume does not use checksums and 1—The volume uses checksums. [thinProvision] Enable or disable thin provisioning.
Example 61 Windows cliq deleteAdminGroup login=10.0.1.3 userName=admin passWord=secret adminGroupName=powerusers Example 62 SSH deleteAdminGroup adminGroupName=powerusers deleteAdminUser Description Delete an administrative user. The last administrator user ID of the default administrative group cannot be removed.
Parameters Name Description [groupName] The name of the management group. [volumeName] The name of the volume in the management group. Example 65 Windows cliq deleteAutoMountPolicy groupName="MG2" volumeName="Vol1" deleteCluster Description Delete a cluster. All storage systems are removed. Syntax deleteCluster {login=} { userName= passWord= | groupName= } {clusterName=} Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 70 Windows cliq deleteGroup login=10.1.2.3 userName=admin passWord=secret groupName="MG2" Example 71 SSH deleteGroup groupName="MG2" deleteRemoteAssociation Description Delete a remote group to primary group association. Syntax deleteRemoteAssociation {login=} { userName= passWord= | groupName= } {remote=} [remoteUserName=] [remotePassWord=] [remotegroupname] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems.
Example 72 Windows cliq deleteRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin remotePassWord=secret Example 73 SSH deleteRemoteAssociation remote=10.0.1.3 remoteUserName=admin remotePassWord=secret deleteServer Description Delete a server. CAUTION: • This operation is irreversible. • This command will display a prompt, requiring confirmation before proceeding.
Syntax deleteSite {login=} { userName= passWord= | groupName= } {siteName=} Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group.
Name Description {passWord} The password for the storage system. Required when the userName parameter is used. {snapshotName} The name of the remote snapshot. Example 78 Windows cliq deleteSnapshot snapshotName=Snapshot0 login=10.1.2.3 userName=admin passWord=secret Example 79 SSH deleteSnapshot snapshotName=Snapshot0 deleteSnapshotSchedule Description Delete a previously created snapshot schedule.
Example 80 Windows cliq deleteSnapshotSchedule scheduleName="Exchange Backup" login=10.1.2.3 userName=admin passWord=secret Example 81 SSH deleteSnapshotSchedule scheduleName="Exchange Backup" deleteSnapshotTempSpace Description Delete the snapshot temporary space. CAUTION: • This operation is irreversible. • This command will display a prompt, requiring confirmation before proceeding.
Syntax deleteSnmpCommunityString {login=} { userName= passWord= | groupName= } [ipAddress=] [ipMask=] [ipSubnet=] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group.
Name Description {ipAddress} This is the IP address or host name of the SNMP server. {version} The SNMP version. Values are 1—Version 1 and 2—Version 2. Example 86 Windows cliq deleteSnmpTrapTarget ipAddress=10.10.10.25 login=10.1.2.3 userName=admin passWord=secret version=2 Example 87 SSH deleteSnmpTrapTarget ipAddress=10.10.10.25 version=2 deleteSyslogNotifyPolicy Description Delete a Syslog Notification Policy.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 92 Windows cliq deleteVolume volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret Example 93 SSH deleteVolume volumeName=MyVolume disconnectLocalVolume Description Disconnect a StoreVirtual volume from the host. This command is only supported for iSCSI. Syntax disconnectLocalVolume {volumeName=} Parameters Name Description {volumeName} The drive letter or mount point on the host for the volume.
Example 95 Windows cliq discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4 Example 96 SSH discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4 discoverUdp Description Discover storage systems and management groups on the network, using UDP. Syntax discoverUdp {ipMask=} {ipSubnet=} [groupOrder=] [receivePort=] [waitForData=] Parameters Name Description {ipMask} An IP address mask for SNMP notification. {ipSubnet} An IP address subnet for SNMP notification.
Example 99 Windows cliq dismountVolume mountPoint="c:\hp storevirtual recovery snapshots\bbmg1\clvol-01_sch_ss_1.1271" Example 100 SSH dismountVolume mountPoint="I:" findADInfo Description Query the management group for information about the associated AD domain. Syntax findADInfo {login=} { userName= passWord= | groupName= } [hostName=] [adUserName=] [ldaps=] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems.
Example 101 Windows CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 hostname=ldap://10.21.66.9 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 4044 CliqSuccess 838317 Operation succeeded. INFO basedn DC=win8dom,DC=com cliq>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 hostname=ldap://10.21.66.
Response INFO ... Name Description INFO This section contains active directory information. Example 102 Windows cliq getADInfo login=10.0.1.3 userName=admin passWord=secret HP StoreVirtual Command Line Interface, v10. (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P. RESPONSE result processingTime name memoryUsage description INFO userContext configValid bindUser baseDN adServer 0 13556 CliqSuccess 835357 Operation succeeded true win8bind@win8dom.com DC=win8dom,DC=com ldap://10.21.66.
Example 103 Windows cliq getAlertLog login=10.1.2.3 userName=admin passWord=secret OR cliq getAlertLog getAutoMountPolicy Description Get all of the auto-mount policies defined for the HP StoreVirtual Recovery Manager application on this computer. Syntax getAutoMountPolicy Parameters None Example 104 Windows cliq getAutoMountPolicy getClusterInfo Description This command returns information about a cluster.
Response Syntax CLUSTER ... NSM ... VIP ... VOLUME ... Name Description CLUSTER This section cluster contains information. NSM This section contains storage system information. VIP This section contains VIP information. VOLUME This section contains volume information. Example 105 Windows cliq getClusterInfo clusterName=Cluster0 login=10.1.2.3 userName=admin passWord=secret Example 106 SSH getClusterInfo clusterName=Cluster0 getDnsInfo Description Get the DNS settings.
Example 107 Windows cliq getDnsInfo login=10.0.1.3 userName=admin passWord=secret Example 108 SSH getDnsInfo getEventLog Description Get event information. Syntax getEventLog {login=} { userName= passWord= | groupName= } [type=] [format=] [report=] [time=] [component=] [severity=] [object=] [system=] [source=] [user=] Parameters 60 Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system.
Example 109 Windows cliq getEventLog login=10.1.2.3 userName=admin passWord=secret type=AllEvents format=XML component=Saniq severity=warning;Critical object=Cluster system=System;Disk Example 110 SSH getEventLog type=AllEvents format=XML component=Saniq severity=warning;Critical object=Cluster system=System;Disk getGroupInfo Description Get information about a management group.
SERVERAPPLICATION ... CLIENTAPPLICATION ... REMOTEASSOCIATION ... ADMINGROUP ... CLUSTER ... Name Description GROUP This section contains group information. ALERTANDEVENTPOLICY This section contains alert and event policy information. EMAILNOTIFYPOLICY This section contains email notification policy information. EMAILSERVERINFO This section contains email server information. SNMPSERVICEPOLICY This section contains SNMP service policy information.
Example 113 Windows cliq getLocalVolumes getNotificationPolicy Description Get information about the Alerts and Events Policy, Email Notification Policy, Syslog Notification Policy, and Email Server Setting. Syntax getNotificationPolicy {login=} { userName= passWord= | groupName= } Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system.
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. Response Syntax NSM ... FIBRECHANNEL ... NIC ... BONDTYPE ... GOSSIPADDRESS ... RAIDSETTING ... Name Description NSM This section contains storage system information.
Name Description {passWord} The password for the storage system. Required when the userName parameter is used. {logFile} The name of the local file used to store the returned information. Example 118 Windows cliq getNsmLogs login=10.1.2.3 userName=admin passWord=secret logFile=c:\logs.tar.gz getPerformanceStats Description Get performance monitoring statistics.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 123 Windows cliq getScsiInfo volumeName=z: getServerCapabilities Description Interrogate a Windows server for its HP StoreVirtual integration capabilities. If this call succeeds, the actual capabilities will be returned. For anticipated future releases, this may also include information about virtual machine hosting (VMware, Citrix, Hyper-V), and Server information. NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target Windows server for this call to succeed.
Name Description [serverName] The name of the server. [serverclustername] The name of the server cluster. Response Syntax SERVER ... VOLUME ... Name Description SERVER This section contains server information. VOLUME This section contains volume information. Example 126 Windows cliq getServerInfo login=10.0.1.
instanceID="" percentComplete="" result="" startTime="" status="" volumeName="" response description Operation succeeded. name GaucheSuccess processingTime 1443 result 0 job applicationIntegration 1 description Operation succeeded.
NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target Windows server for this call to succeed. Syntax getServerVolumeInfo {serverIp=} [searchDepth=] Parameters Name Description {serverIp} The Windows server IP address. [searchDepth] Defines which objects to inspect. Values are 1—Volumes only, 2—Volumes and snapshots, and 3—Volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take. Response Syntax VOLUME ...
Name Description {passWord} The password for the storage system. Required when the userName parameter is used. [siteName] The name of the site. Response Syntax SITE ... NSM ... Name Description SITE This section contains site information. NSM This section contains storage system information. Example 132 Windows cliq getSiteInfo siteName=TheSite login=10.1.2.
Name Description [searchDepth] Defines which objects to inspect. Values are 1—Snapshots only and 2—Snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take. [verbose] Determines how much information to return. Values are 0—Get summary information only (better performance) and 1—Get all information (better information; default). The greater the verbose number, the longer the call can take. Response Syntax SNAPSHOT ... STATUS ... SESSION ...
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. [scheduleName] The name of the schedule. Response Syntax SCHEDULE ... Name Description SCHEDULE This section contains schedule information.
SNMPCOMMUNITYSTRING ... SNMPTRAPTARGET ... Name Description SNMPSERVICEPOLICY This section contains SNMP service policy information. SNMPNOTIFICATIONPOLICY This section contains SNMP notification policy information. SNMPCOMMUNITYSTRING This section contains SNMP community string information. SNMPTRAPTARGET This section contains SNMP trap target information. Example 138 Windows cliq getSnmpInfo login=10.1.2.
Name Description INFO This section contains active directory information. FCADAPTER This section contains Fibre Channel adapter information. Example 140 Windows cliq getSupportInfo login=10.1.2.3 userName=admin passWord=secret filepath=c:\temp getSystemInfo Description Get information about the StoreVirtual applications installed on the Windows application server. Syntax getSystemInfo Parameters None Response Syntax INFO ... FCADAPTER ...
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. [volumeName] The name of the volume in the management group. [searchDepth] Defines which objects to inspect.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Syntax makePrimary {login=} { userName= passWord= | groupName= } {volumeName=} [size=] [thinProvision=] [adaptiveOptimization=] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Name Description {adminGroupName} The administrative group name. [adminUserName] Specifies the users that this group comprises. [description] Optional description [permissions] Permissions for the group. This is a character sequence specifying the allowable permissions in the following order: Group, Network, Storage System, Report. The Password permissions are subsumed by the Group permissions.
Example 154 Windows cliq modifyAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user" adminUserName=user adminPassWord=secret Example 155 SSH modifyAdminUser description="My shiny new user" adminUserName=user adminPassWord=secret modifyCluster Description Modify settings on a cluster. CAUTION: • Modifying a cluster will cause a restripe of every volume in the cluster. • This command will display a prompt, requiring confirmation before proceeding.
Example 156 Windows cliq modifyCluster clusterName=TheCluster login=10.0.1.3 userName=admin passWord=secret description="My shiny new cluster" useVip=1 node=10.1.2.4 vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0 Example 157 SSH modifyCluster clusterName=TheCluster description="My shiny new cluster" useVip=1 node=10.1.2.4 vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0 modifyEmailNotifyPolicy Description Modify an Email Notification Policy.
Example 158 Windows cliq modifyEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret email="myemail@myhost.com" alertOnCritical=1 Example 159 SSH modifyEmailNotifyPolicy email="myemail@myhost.com" alertOnCritical=1 modifyGroup Description Modify settings on a management group. CAUTION: • This operation is irreversible. • This command will display a prompt, requiring confirmation before proceeding.
Name Description [cityName] Postal city [stateName] Postal state [countryName] Postal country [postalCode] Postal code [telephoneNumber] Contact telephone number [emailaddress] The notification email. Example 160 Windows cliq modifyGroup login=10.0.1.2 userName=admin passWord=secret node=10.0.1.2;10.0.1.3 Example 161 SSH modifyGroup node=10.0.1.2;10.0.1.3 modifyNSM Description Modify storage system Fibre Channel port states between enabled and disabled.
Example 162 Windows cliq modifyNSM login=10.0.1.2 userName=admin passWord=secret fcenabled=1 Example 163 SSH modifyNSM fcenabled=1 modifyRemoteAssociation Description Modify a previously created remote volume association. CAUTION: • This operation is irreversible. • This command will display a prompt, requiring confirmation before proceeding.
Name Description [remoteBandwidth] The bandwidth used in a copy from the remote group to the primary group. Values are: • Kb—Kilobits/sec (1000 Bits/second) • Mb—Megabits/sec (1000 Kilobits/second) • Gb—Gigabits/sec (1000 Megabits/second) [remotegroupname] The name of the remote management group. Example 164 Windows cliq modifyRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.
Example 166 Windows cliq modifyRemoteSnapshotSchedule scheduleName="TheSchedule" login="10.0.1.2" userName="admin" passWord="secret" remoteretentioncount="10" Example 167 SSH modifyRemoteSnapshotSchedule scheduleName="TheSchedule" remoteretentioncount="10" modifyServer Description Modify a server.
Name Description [initiatorSecret] The CHAP initiator secret for the volume. [controllingserver] The IP address of the client server that has Application Aware Snapshot Manager (AASM) installed on it. It will coordinate the snapshot with the applications using SAN volumes. This is required for managed snapshots of Fibre Channel connected volumes. This is also required for VMware managed snapshots; if applicable, enter the Virtual Center Server IP address.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Name Description [description] Optional description [autogrowpages] Automatically grow the pages. Example 172 Windows cliq modifySnapshot description="New Description" login=10.0.1.2 userName=admin passWord=secret snapshotName=TheSnapshot Example 173 SSH modifySnapshot description="New Description" snapshotName=TheSnapshot modifySnapshotSchedule Description Modify a previously created snapshot schedule.
Example 174 Windows cliq modifySnapshotSchedule scheduleName="TheSchedule" description="First snapshot schedule" login="10.0.1.2" userName="admin" passWord="secret" Example 175 SSH modifySnapshotSchedule scheduleName="TheSchedule" description="First snapshot schedule" modifySnmpCommunityString Description Modify the Community String for all SNMP.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 180 Windows cliq modifySyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ="10.0.10.25" alertOnInfo="1" Example 181 SSH modifySyslogNotifyPolicy ="10.0.10.25" alertOnInfo="1" modifyVolume Description Modify volume settings. CAUTION: • Enabling checksums may impact volume I/O performance. • Changing the replication level of this volume will cause it to restripe, and may impact I/O performance. This will display a prompt, requiring confirmation before proceeding.
Name Description • replication:2, parity:1 Network RAID-5 (Single parity) • replication:3, parity:2 Network RAID-6 (Dual Parity) [checkSum] Values are 0—The volume does not use checksums and 1—The volume uses checksums. [thinProvision] Enable or disable thin provisioning. Values are 0—The volume does not use thin provisioning and 1—The volume is thin-provisioned (in a thinly provisioned volume, reserve may be < length).
Name Description {mountPoint} The drive letter or mount point on the host for the volume. [forcecreate] Forces the creation of the volume with formatting as NTFS. Example 184 Windows cliq mountVolume groupName=MG2 volumeName=TheVolume mountPoint=z: rebalanceVip Description Rebalance the connections to a volume when using a virtual IP address.
Example 185 Windows cliq rebalanceVip volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret Example 186 SSH rebalanceVip volumeName=MyVolume recoverQuorum Description This command is used to rescue a management group after quorum has been irretrievably lost. This command needs to be run on a storage system with a working manager so it can retrieve the management group database from that manager to restore the management group.
Example 187 Windows cliq recoverQuorum login=10.1.2.3 userName=admin passWord=secret Example 188 SSH recoverQuorum removeSnapshot Description Disconnect a SAN snapshot from the host, then delete it. If the snapshot cannot be disconnected (because it is in use, or for any other reason), it will not be deleted. Syntax removeSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=} Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems.
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. {volumeName} The name of the volume in the management group. Example 190 Windows cliq removeVolume volumeName=z: login=10.0.1.
Example 191 Windows cliq resetSession volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret Example 192 SSH resetSession volumeName=MyVolume rollbackSnapshot Description Roll back a snapshot. CAUTION: • The rollbackSnapshot command will replace the original volume with a new one based on the contents of the snapshot and delete any snapshots created after the snapshot which is being rolled back.
Example 193 Windows cliq rollbackSnapshot snapshotName=TheSnapshot login=10.0.1.2 userName=admin passWord=secret Example 194 SSH rollbackSnapshot snapshotName=TheSnapshot runDiagnostic Description Run one or all storage system diagnostics. Syntax runDiagnostic {login=} { userName= passWord= | groupName= } [diagnosticName=] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Name Description {passWord} The password for the storage system. Required when the userName parameter is used. {aging} The aging in months. Example 199 Windows cliq setAlertsPolicy login=10.0.1.3 userName=admin passWord=secret aging="2" Example 200 SSH setAlertsPolicy aging="2" setAutoMountPolicy Description Set or modify the auto-mount policy or the mount location for auto-mount policies for the HP StoreVirtual Recovery Manager application on this computer.
Example 201 Setting an auto-mount policy (Windows) cliq setAutoMountPolicy groupName=MG1 volumeName=ExchangeVol1 retentionCount=5 Example 202 Setting a mount location (Windows) cliq setAutoMountPolicy mountPoint=C:\StoreVirtual\RecoveredSnaps setDnsInfo Description Set information for DNS. CAUTION: This command overwrites all current values for each parameter.
Syntax setEmailServerInfo {login=} { userName= passWord= | groupName= } [ipAddress=] [email=] [portNumber=] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 209 Windows cliq setLicenseKey login=10.0.1.
Example 211 Windows cliq setSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secret alertOnWarning=1 Example 212 SSH setSnmpNotifyPolicy alertOnWarning=1 setSnmpServiceInfo Description Set information about the SNMP Service. Syntax setSnmpServiceInfo {login=} { userName= passWord= | groupName= } [contactinfo=] [location=] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system.
Syntax setSupportLogin {login=} { userName= passWord= | groupName= } {enabled=} Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group.
Parameters None Example 218 Windows or SSH cliq setTraceOn shutdownGroup Description Perform a soft shutdown of a management group. Syntax shutdownGroup {login=} { userName= passWord= | groupName= } Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 223 Windows cliq startManager login=10.0.1.2 userName=admin passWord=secret Example 224 SSH startManager startSnmpService Description Start the SNMP Service. Syntax startSnmpService {login=} { userName= passWord= | groupName= } Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it.
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. Example 227 Windows cliq startVirtualManager login=10.0.1.
Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord. {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters.
Example 233 Windows cliq stopVirtualManager login=10.0.1.2 userName=admin passWord=secret Example 234 SSH stopVirtualManager testCredentials Description Test the login credentials for a management group. Syntax testCredentials {login=} { userName= passWord= | groupName= } Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system.
Name Description {groupName} The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters. {passWord} The password for the storage system. Required when the userName parameter is used. {volumeName} The name of the volume in the management group. Example 237 Windows cliq unassignVolume volumeName=TheVolume login=10.0.1.
Example 239 Windows cliq unassignVolumeToServer volumeName=TheVolume serverName=TheServer login=10.0.1.2 userName=admin passWord=secret Example 240 SSH unassignVolumeToServer volumeName=TheVolume serverName=TheServer utility Description Execute a utility program on a storage system. CAUTION: This command is recommended for HP support only.
Example 241 Windows examples cliq utility run="ping -c 10 10.3.2.1" login=10.1.2.3 userName=admin passWord=secret cliq utility run=groupsupportinfo login=10.1.2.3 userName=admin passWord=secret cliq utility run=hardwarereport login=10.1.2.3 userName=admin passWord=secret Example 242 SSH examples utility run="ping -c 10 10.3.2.
Name Description [runCommand] Custom command executed after shadow creation, import or between break and make-it-write. [importShadow] Transportable VSS snapshot import. [mountShadow] Expose the shadow copy as a mount point or drive letter. The format is mountShadow=";". [breakShadowCopies] Break the shadow copy set. [maskLun] Mask the shadow copy LUN from the host.
Example 244 Windows cliq waitForEvent login=10.0.1.2 userName=admin passWord=secret Example 245 SSH waitForEvent waitForUpdate Description Block on a change to the state in the management group. Syntax waitForUpdate {login=} { userName= passWord= | groupName= } [receivePort=] [timetowait=] Parameters Name Description {login} The IP addresses or DNS-resolvable names of one or more storage systems. {userName} The authentication user name for the storage system.
3 Support and other resources Contacting HP For worldwide technical support information, see the HP support website: http://www.hp.com/support Before contacting HP, collect the following information: • Product model names and numbers • Technical support registration number (if applicable) • Product serial numbers • Error messages • Operating system type and revision level • Detailed questions Subscription service HP recommends that you register your product for HP Support Alerts at: http://www.
HP websites For additional information, see the following HP websites: • http://www.hp.com • http://www.hp.com/go/storage • http://www.hp.com/service_locator • http://www.hp.com/go/StoreVirtualDownloads • http://www.hp.com/go/storevirtualcompatibility • http://www.hp.
4 Documentation feedback HP is committed to providing documentation that meets your needs. To help us improve the documentation, send any errors, suggestions, or comments to Documentation Feedback (docsfeedback@hp.com). Include the document title and part number, version number, or the URL when submitting your feedback.
