HP 2.0TB User Manual

HP StoreVirtual Storage Command-LineInterface User GuideThis guide provides information for using the command-line interface provided with the HP Stor

10| HP StoreVirtual CLI| Return CodesReturn CodesAll GAUCHE commands return an XML response containing a 32-bit result code, and a description o

100| HP StoreVirtual CLI| Commandscliq utility run= login= userName= passWord=login Required The IP addresses or DNS-resolvable names of one or

HP StoreVirtual CLI| Commands| 101breakShadowCopies Optional Break the shadow copy setmaskLun Optional Mask the shadow copy LUN from the host. It

102| HP StoreVirtual CLI| Commandslogin Required The IP addresses or DNS-resolvable names of one or more storagesystemsuserName Conditional The

HP StoreVirtual CLI| Return Codes| 11Result Value OS Status DescriptionCliqUnrecognizedParameter 0x80001008 135 This parameter is unrecognized.Cli

12| HP StoreVirtual CLI| Return CodesResult Value OS Status DescriptionCliqIllegalPassword 0x80001021 160 The password must be 5..40characters,

HP StoreVirtual CLI| Return Codes| 13Result Value OS Status DescriptionCliqVssLunInfoFailed 0x8000102E 173 Cannot create an application-managed sn

14| HP StoreVirtual CLI| Return CodesResult Value OS Status DescriptionCliqHbaStaleData 0x80001048 199 Information has changed since thelast cal

HP StoreVirtual CLI| Return Codes| 15Result Value OS Status DescriptionNumber not defined by theidentified Target.CliqHbaTargetLuid 0x80001059 216

16| HP StoreVirtual CLI| Return CodesResult Value OS Status DescriptionCliqMultipleIPAddresses 0x8000106A 233 Multiple IP addresses wereencounte

HP StoreVirtual CLI| Commands| 17CommandsaddVirtualManagerThis command adds a virtual manager to a group.Availability: Windows, SSHVersion: 8.0Req

18| HP StoreVirtual CLI| CommandsaccessRights Optional The access rights to the volume: r - read-only, x - no access, rw - read-write (default)i

HP StoreVirtual CLI| Commands| 19Examplecliq assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret login=10.0.1.2 userName=admin passWord=

2|HP StoreVirtual CLI|TOCContentsOverview...

20| HP StoreVirtual CLI| CommandsuserName Required The authentication user name for the storage system.passWord Required The password for the st

HP StoreVirtual CLI| Commands| 21groupName Conditional The name of the management group with cached credentials.(Parameters userName/passWord or g

22| HP StoreVirtual CLI| CommandsclearDnsInfoThis command clears the DNS settings.Availability: Windows, SSHVersion: 9.0Request Syntaxcliq clear

HP StoreVirtual CLI| Commands| 23clearSnmpNotifyPolicyThis command clears the SNMP Notification Policy settings.Availability: Windows, SSHVersion:

24| HP StoreVirtual CLI| CommandsclearVssVolumeFlagsThis command resets snapshot flags in the vss volume. This command is only supported for Win

HP StoreVirtual CLI| Commands| 25configureRaidThis command reconfigures the RAID setting on a storage system.Availability: Windows, SSHVersion: 8.

26| HP StoreVirtual CLI| CommandsExamplecliq connectVolume volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secretconvertSnapshotTempS

HP StoreVirtual CLI| Commands| 27groupName Conditional The name of the management group with cached credentials.(Parameters userName/passWord or g

28| HP StoreVirtual CLI| CommandsExamplecliq createAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user&q

HP StoreVirtual CLI| Commands| 29createEmailNotifyPolicyThis command configures which level of events from the management group are sent via email

HP StoreVirtual CLI|TOC|3deleteSnmpTrapTarget... 46d

30| HP StoreVirtual CLI| Commandscliq createGroup groupName= node= userName= passWord=node Required The delimited list of node names or IP addre

HP StoreVirtual CLI| Commands| 31Examplecliq createRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=

32| HP StoreVirtual CLI| Commands remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.21"cliq c

HP StoreVirtual CLI| Commands| 33via FibreChannel and a value of 0 is entered, the client will lose itsability to communicate with the attached vo

34| HP StoreVirtual CLI| CommandscreateSnapshotThis command creates a snapshot of one or more LeftHand OS volumes.Availability: Windows, SSHVers

HP StoreVirtual CLI| Commands| 35login Required The IP addresses or DNS-resolvable names of one or more storagesystemsuserName Conditional The aut

36| HP StoreVirtual CLI| CommandscreateSnmpCommunityStringThis command creates an SNMP Community String. The Community String must be the same f

HP StoreVirtual CLI| Commands| 37groupName Conditional The name of the management group with cached credentials.(Parameters userName/passWord or g

38| HP StoreVirtual CLI| CommandsExamplecliq createSyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ipAddress="10.0.10.25&q

HP StoreVirtual CLI| Commands| 39Examplecliq createVolume volumeName=MyVolume clusterName=TheCluster size=100GB description="Exchange DB-1&qu

4|HP StoreVirtual CLI|TOCprovisionVolume...

40| HP StoreVirtual CLI| CommandsgroupName Conditional The name of the management group with cached credentials.(Parameters userName/passWord or

HP StoreVirtual CLI| Commands| 41Examplecliq deleteCluster clusterName=TheCluster login=10.1.2.3 userName=admin passWord=secretcliq deleteCluster

42| HP StoreVirtual CLI| CommandsgroupName Required The name of the management groupExamplecliq deleteGroup login=10.1.2.3 userName=admin passWo

HP StoreVirtual CLI| Commands| 43Request Syntaxcliq deleteServer serverName= login= userName= passWord=login Required The IP addresses or DNS-reso

44| HP StoreVirtual CLI| CommandsWarningsThis operation is irreversible.Request Syntaxcliq deleteSnapshot snapshotName= login= userName= passWor

HP StoreVirtual CLI| Commands| 45deleteSnapshotTempSpaceThis command deletes the snapshot temporary space.Availability: Windows, SSHVersion: 8.0Wa

46| HP StoreVirtual CLI| CommandsipSubnet Optional An IP Address subnet for SNMP notification.Examplecliq deleteSnmpCommunityString ipAddress=10

HP StoreVirtual CLI| Commands| 47groupName Conditional The name of the management group with cached credentials.(Parameters userName/passWord or g

48| HP StoreVirtual CLI| CommandsuserName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or group

HP StoreVirtual CLI| Commands| 49Examplecliq discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4cliq discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4di

HP StoreVirtual CLI| Overview| 5OverviewThe LeftHand OS command-line interface (CLI) is built upon the API released with version 8.x. Develop your

50| HP StoreVirtual CLI| CommandsfindADInfoThis command queries the management group for information about the associated AD domain.Availability

HP StoreVirtual CLI| Commands| 51 name CliqSuccess memoryUsage 838981 description Operation succeeded. INFO basedn DC=win8dom,D

52| HP StoreVirtual CLI| CommandsVersion: 10.0Request Syntaxcliq getADInfo login= userName= passWord=login Required The IP addresses or DNS-reso

HP StoreVirtual CLI| Commands| 53userName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or groupNa

54| HP StoreVirtual CLI| CommandssearchDepth Optional Which objects to inspect 1 - Clusters only, 2 - Clusters and volumes, 3- Clusters, volumes

HP StoreVirtual CLI| Commands| 55Examplecliq getDnsInfo login=10.0.1.3 userName=admin passWord=secretcliq getDnsInfogetEventLogThis command return

56| HP StoreVirtual CLI| CommandsRequest Syntaxcliq getGroupInfo login= userName= passWord=login Required The IP addresses or DNS-resolvable nam

HP StoreVirtual CLI| Commands| 57Examplecliq getGroupInfo login=10.1.2.3 userName=admin passWord=secretcliq getGroupInfogetLocalVolumesThis comman

58| HP StoreVirtual CLI| CommandsgetNsmInfoThis command returns information about a storage system.Availability: Windows, SSHVersion: 8.0Request

HP StoreVirtual CLI| Commands| 59userName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or groupNa

6| HP StoreVirtual CLI| Global ParametersGlobal Parametersprompt=<true | false>Some potentially destructive commands prompt before proceed

60| HP StoreVirtual CLI| CommandsuserName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or group

HP StoreVirtual CLI| Commands| 61serverIp Required The Windows server IP address.Examplecliq getServerCapabilities serverIp=10.0.1.2cliq getServer

62| HP StoreVirtual CLI| Commandscliq getServerJobInfo serverIp= jobId=serverIp Required The Windows server IP address.jobId Optional Job IDvolu

HP StoreVirtual CLI| Commands| 63getServerVolumeInfoThis command returns the features of a volume by interrogating a remote server. This will retu

64| HP StoreVirtual CLI| CommandsSITE This section contains site information.NSM This section contains NSM information.Examplecliq getSiteInfo s

HP StoreVirtual CLI| Commands| 65Examplecliq getSnapshotInfo snapshotName=TheSnapshot login=10.1.2.3 userName=admin passWord=secretcliq getSnapsho

66| HP StoreVirtual CLI| CommandsuserName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or group

HP StoreVirtual CLI| Commands| 67FCADAPTER This section contains fibre channel adapter information.Examplecliq getSupportInfo login=10.1.2.3 userN

68| HP StoreVirtual CLI| CommandssearchDepth Optional Which objects to inspect 1 - Volumes only, 2 - Volumes and snapshots,3 - Volumes, snapshot

HP StoreVirtual CLI| Commands| 69Examplecliq getVolumeControllingServer login=10.0.1.2 userName=admin passWord=secret volumeName="The Volume&

HP StoreVirtual CLI| Syntax| 7SyntaxCLIQ is the command-line interface (CLI) for the HP StoreVirtual Storage Solution. The CLI specifiesparameters

70| HP StoreVirtual CLI| CommandsExamplecliq makePrimary login=10.1.2.3 userName=admin passWord=secret volumeName="TheVolume" size=1GB

HP StoreVirtual CLI| Commands| 71userName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or groupNa

72| HP StoreVirtual CLI| CommandsExamplecliq modifyAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user&q

HP StoreVirtual CLI| Commands| 73modifyEmailNotifyPolicyThis command modifies an Email Notification Policy.Availability: Windows, SSHVersion: 9.0R

74| HP StoreVirtual CLI| CommandsRequest Syntaxcliq modifyGroup login= userName= passWord= node=login Required The IP addresses or DNS-resolvabl

HP StoreVirtual CLI| Commands| 75fcenabled Required Enable or disable the fibrechannel port(s). This can be one of: 0 -disable, 1 - enable. Defaul

76| HP StoreVirtual CLI| CommandsmodifyRemoteSnapshotScheduleThis command modifies a previously created remote snapshot schedule.Availability: W

HP StoreVirtual CLI| Commands| 77serverName Required The name of the serverdescription Optional Optional descriptionallowiSCSIAccess Optional Allo

78| HP StoreVirtual CLI| CommandsThis operation is irreversible.Request Syntaxcliq modifySite siteName= description= login= userName= passWord=l

HP StoreVirtual CLI| Commands| 79Examplecliq modifySnapshot description="New Description" login=10.0.1.2 userName=admin passWord=secret

8| HP StoreVirtual CLI| SyntaxIf a parameter contains fewer elements in the list than needed for the composite command, the last one in thelist

80| HP StoreVirtual CLI| CommandsmodifySnmpCommunityStringThis command modifies the Community String for all SNMP.Availability: Windows, SSHVers

HP StoreVirtual CLI| Commands| 81Examplecliq modifySnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret communityString="TheStringcli

82| HP StoreVirtual CLI| CommandsWarningsUsing a stridePages value other than the default may impact volume IO performance.Using an initialQuota

HP StoreVirtual CLI| Commands| 83mountVolumeThis command mounts a volume to the specified mount point.Availability: WindowsVersion: 8.0WarningsPri

84| HP StoreVirtual CLI| CommandspassWord Conditional The password for the storage system. (Parameters userName/passWordor groupName must be spe

HP StoreVirtual CLI| Commands| 85passWord Conditional The password for the storage system. (Parameters userName/passWordor groupName must be speci

86| HP StoreVirtual CLI| CommandsremoveSnapshotThis command disconnects a SAN snapshot from the host, then deletes it. If the snapshot cannot be

HP StoreVirtual CLI| Commands| 87resetSessionThis command resets the iSCSI session associated with a volume. Some initiators will attempt to recon

88| HP StoreVirtual CLI| CommandsuserName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or group

HP StoreVirtual CLI| Commands| 89login Required The IP addresses or DNS-resolvable names of one or more storagesystemsuserName Conditional The aut

HP StoreVirtual CLI| Syntax| 9>cliqHP StoreVirtual LeftHand OS Command Line Interface, v10.5 (type exit to quit)(C) Copyright 2007-2013 Hewlett

90| HP StoreVirtual CLI| CommandssetAutoMountPolicyThis command sets the auto-mount policy for the HP StoreVirtual Recovery Manager application

HP StoreVirtual CLI| Commands| 91server Optional List of DNS servers, IP addresses.Examplecliq setDnsInfo login=10.0.1.3 userName=admin passWord=s

92| HP StoreVirtual CLI| Commandscliq setGossipList login= userName= passWord= node=login Required The IP addresses or DNS-resolvable names of o

HP StoreVirtual CLI| Commands| 93setSnmpNotifyPolicyThis command sets SNMP Notification Policy settings.Availability: Windows, SSHVersion: 9.0Requ

94| HP StoreVirtual CLI| CommandspassWord Conditional The password for the storage system. (Parameters userName/passWordor groupName must be spe

HP StoreVirtual CLI| Commands| 95login Required The IP addresses or DNS-resolvable names of one or more storagesystemsuserName Conditional The aut

96| HP StoreVirtual CLI| Commandscliq startSnmpService login= userName= passWord=login Required The IP addresses or DNS-resolvable names of one

HP StoreVirtual CLI| Commands| 97login Required The IP addresses or DNS-resolvable names of one or more storagesystemsuserName Conditional The aut

98| HP StoreVirtual CLI| CommandsuserName Conditional The authentication user name for the storage system. (ParametersuserName/passWord or group

HP StoreVirtual CLI| Commands| 99passWord Conditional The password for the storage system. (Parameters userName/passWordor groupName must be speci