Hp StoreVirtual VSA Software User Manual

HPP4000 Command-Line Interface User GuideThis guide provides information for using the command-line interface provided with the P4000 software. Comman

10|HP P4000 CLI|Return CodesReturn CodesAll GAUChE commands return an XML response containing a 32-bit result code, and a description of theresult

HP P4000 CLI|Return Codes|11Result Value OS Status Descriptionignored as it is notapplicable.CliqUnexpected 0x80001001 128 An unexpectederror has

12|HP P4000 CLI|Return CodesResult Value OS Status DescriptionCliqObjectNotFound 0x80001013 146 Object not found.CliqConnectionFailure 0x80001014

HP P4000 CLI|Return Codes|13Result Value OS Status DescriptionCliqFileError 0x80001022 161 General file error.CliqMissingInitiator 0x80001023 162

14|HP P4000 CLI|Return CodesResult Value OS Status Descriptionmanagedsnapshots, theremust be only oneapplication serverassociated with thevolume.C

HP P4000 CLI|Return Codes|15Result Value OS Status DescriptionCliqServerInCluster 0x80001035 180 Server is in Clusterand cannot bechanged via CliQ

16|HP P4000 CLI|CommandsCommandsaddVirtualManagerThis command adds a virtual manager to a group.Availability: Windows, SAN/iQVersion: 8.0Request S

HP P4000 CLI|Commands|17Examplecliq assignVolume volumeName=TheVolume initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.hp.com login=10.0.1.2 us

18|HP P4000 CLI|Commandslogin Required The IP address or DNS-resolvable names of one or more storage systemsuserName Required The authentication u

HP P4000 CLI|Commands|19Examplecliq cancelRemoteSnapshot snapshotName=TheSnapshot login=10.0.1.2 userName=admin passWord=secretcliq cancelRemoteSn

2|HP P4000 CLI|TOCContentsOverview...

20|HP P4000 CLI|CommandsRequest Syntaxcliq clearDnsInfo login= userName= passWord= login Required The IP address or DNS-resolvable names of one or

HP P4000 CLI|Commands|21Examplecliq clearSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secretcliq clearSnmpNotifyPolicyclearSnmpServiceI

22|HP P4000 CLI|CommandsVersion: 8.0Request Syntaxcliq cloneSnapshot snapshotName= volumeName= login= userName= passWord= login Required The IP ad

HP P4000 CLI|Commands|23cliq connectVolume volumeName= login= userName= passWord= login Required The IP address or DNS-resolvable names of one or

24|HP P4000 CLI|CommandskeyFile Required The encrypted key file (this is specified instead of the username and passwordparameters)adminGroupName R

HP P4000 CLI|Commands|25createClusterThis command creates a cluster in a management group.Availability: Windows, SAN/iQVersion: 8.0Request Syntaxc

26|HP P4000 CLI|CommandsalertOnInformation Optional 0 - the log does not includes informational events (default), 1 - the log includesinformationa

HP P4000 CLI|Commands|27Examplecliq createKey login=10.0.1.2 userName=admin passWord=secret keyFile=c:\secret.keycreateRemoteAssociationThis comma

28|HP P4000 CLI|Commandslogin Required The IP address or DNS-resolvable names of one or more storage systemsuserName Required The authentication u

HP P4000 CLI|Commands|29chapName Optional The CHAP name for the volume. If this is not specified, the IQN of the local server isused (this paramet

HP P4000 CLI|TOC|3deleteSyslogNotifyPolicy... 40deleteV

30|HP P4000 CLI|CommandspassWord Required The password for the storage systemkeyFile Required The encrypted key file (this is specified instead of

HP P4000 CLI|Commands|31remotePassWord Optional The password for the remote groupremoteKeyFile Optional The encrypted key file for the remote grou

32|HP P4000 CLI|CommandscreateSnmpTrapTargetThis command creates an SNMP Trap Target. The Community String must be the same for all Trap Targets.I

HP P4000 CLI|Commands|33alertOnWarning Optional 0 - the log does not includes warning events (default), 1 - the log includes warningeventsalertOnC

34|HP P4000 CLI|CommandsExamplecliq createVolume volumeName=MyVolume clusterName=TheCluster size=100GB description="Exchange DB-1" login

HP P4000 CLI|Commands|35Examplecliq deleteAdminUser login=10.0.1.3 userName=admin passWord=secret adminUserName=usercliq deleteAdminUser adminUser

36|HP P4000 CLI|CommandsExamplecliq deleteEmailNotifyPolicy [email protected] login=10.1.2.3 userName=admin passWord=secretcliq dele

HP P4000 CLI|Commands|37Examplecliq deleteRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin rem

38|HP P4000 CLI|CommandsExamplecliq deleteSite siteName=Headquarters login=10.1.2.3 userName=admin passWord=secretcliq deleteSite siteName=Headqua

HP P4000 CLI|Commands|39Examplecliq deleteSnapshotSchedule scheduleName="Exchange Backup" login=10.1.2.3 userName=admin passWord=secretc

4|HP P4000 CLI|TOCsetDnsInfo...70s

40|HP P4000 CLI|CommandsExamplecliq deleteSnmpCommunityString ipAddress=10.0.10.25 login=10.1.2.3 userName=admin passWord=secretcliq deleteSnmpCom

HP P4000 CLI|Commands|41Examplecliq deleteSyslogNotifyPolicy ipAddress=10.10.10.25 login=10.1.2.3 userName=admin passWord=secretcliq deleteSyslogN

42|HP P4000 CLI|CommandsdisconnectLocalVolumeThis command disconnects a SAN volume from the host.Availability: WindowsVersion: 8.0Request Syntaxcl

HP P4000 CLI|Commands|43groupOrder Optional Return storage systems ordered by group membership. This can be one of: 0 - default, 1receivePort Opti

44|HP P4000 CLI|CommandsExamplecliq getClusterInfo clusterName=Cluster0 login=10.1.2.3 userName=admin passWord=secretcliq getClusterInfo clusterNa

HP P4000 CLI|Commands|45system Optional System filter. This can be one or more of: System, Controller, Cache, Disk, Boot,Backplane, Fan, Temperatu

46|HP P4000 CLI|CommandsExamplecliq getLocalVolumesgetNotificationPolicyThis command returns information about the Alerts and Events Policy, Email

HP P4000 CLI|Commands|47getNsmLogsThis command gathers all log files from a storage system and stores the archive locally.Availability: WindowsVer

48|HP P4000 CLI|CommandsgetRemoteSnapshotInfoThis command returns information about remote snapshots.Availability: Windows, SAN/iQVersion: 8.0Requ

HP P4000 CLI|Commands|49Version: 8.5Request Syntaxcliq getServerCapabilities login= userName= passWord= login Required The IP address or DNS-resol

HP P4000 CLI|Overview|5OverviewThe SAN/iQ command-line interface (CLI) is built upon the SAN/iQ API released with version 8.x. Developyour own aut

50|HP P4000 CLI|CommandsserverIp Required The Windows server IP address.jobId Optional Job IDResponse Syntaxresponse description=""

HP P4000 CLI|Commands|51getServerVolumeInfoThis command returns the features of a volume by interrogating a remote server. This will return VSSass

52|HP P4000 CLI|CommandsgetSnapshotInfoThis command returns information about a snapshot.Availability: Windows, SAN/iQVersion: 8.0Request Syntaxcl

HP P4000 CLI|Commands|53getSnmpInfoThis command returns information about the SNMP Service and Targets.Availability: Windows, SAN/iQVersion: 9.0Re

54|HP P4000 CLI|CommandsVersion: 8.0Request Syntaxcliq getSystemInfo Examplecliq getSystemInfocliq getSystemInfogetVolumeInfoThis command returns

HP P4000 CLI|Commands|55Examplecliq help command=getSystemInfocliq help command=getSystemInfomakePrimaryThis command promotes a remote volume to a

56|HP P4000 CLI|CommandsExamplecliq makePrimary login=10.1.2.3 userName=admin passWord=secret volumeName="TheVolume" snapshotName="

HP P4000 CLI|Commands|57userName Required The authentication user name for the storage systempassWord Required The password for the storage system

58|HP P4000 CLI|CommandsmodifyEmailNotifyPolicyThis command modifies an Email Notification Policy.Availability: Windows, SAN/iQVersion: 9.0Request

HP P4000 CLI|Commands|59contactName Optional Contact namepostalAddress Optional Postal address line 1postalAddress2 Optional Postal address line 2

6|HP P4000 CLI|Global ParametersGlobal Parametersprompt=<true | false>Some potentially destructive commands prompt before proceeding. This d

60|HP P4000 CLI|CommandsmodifyRemoteSnapshotScheduleThis command modifies a previously created remote snapshot schedule.Availability: Windows, SAN

HP P4000 CLI|Commands|61chapName Optional The CHAP name for the volume. If this is not specified, the IQN of the local server isused (this paramet

62|HP P4000 CLI|CommandsuserName Required The authentication user name for the storage systempassWord Required The password for the storage system

HP P4000 CLI|Commands|63Examplecliq modifySnapshotSchedule scheduleName="TheSchedule" description="First snapshot schedule" lo

64|HP P4000 CLI|CommandsExamplecliq modifySnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret ipAddress="10.0.10.25" versiony=&

HP P4000 CLI|Commands|65keyFile Required The encrypted key file (this is specified instead of the username and passwordparameters)volumeName Requi

66|HP P4000 CLI|CommandsuserName Required The authentication user name for the storage systempassWord Required The password for the storage system

HP P4000 CLI|Commands|67passWord Required The password for the storage systemkeyFile Required The encrypted key file (this is specified instead of

68|HP P4000 CLI|CommandspassWord Required The password for the storage systemkeyFile Required The encrypted key file (this is specified instead of

HP P4000 CLI|Commands|69Examplecliq resetSession volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secretcliq resetSession volumeName=MyV

HP P4000 CLI|Syntax|7SyntaxCLIQ is the command-line interface (CLI) for the HP P4000 Storage Solution. The CLI specifies parametersin the form par

70|HP P4000 CLI|CommandsExamplecliq runDiagnostic login=10.0.1.2 userName=admin passWord=secret diagnosticName=healthCheckcliq runDiagnostic diagn

HP P4000 CLI|Commands|71passWord Required The password for the storage systemkeyFile Required The encrypted key file (this is specified instead of

72|HP P4000 CLI|CommandsRequest Syntaxcliq setGossipList login= userName= passWord= node= login Required The IP address or DNS-resolvable names of

HP P4000 CLI|Commands|73Request Syntaxcliq setSnmpNotifyPolicy login= userName= passWord= verbosity= alertOnCritical= login Required The IP addres

74|HP P4000 CLI|CommandsVersion: 8.0Request Syntaxcliq shutdownGroup login= userName= passWord= login Required The IP address or DNS-resolvable na

HP P4000 CLI|Commands|75userName Required The authentication user name for the storage systempassWord Required The password for the storage system

76|HP P4000 CLI|CommandsExamplecliq startVirtualManager login=10.0.1.2 userName=admin passWord=secretcliq startVirtualManagerstopManagerThis comma

HP P4000 CLI|Commands|77stopVirtualManagerThis command stops a virtual manager on a storage system.Availability: Windows, SAN/iQVersion: 8.0Reques

78|HP P4000 CLI|CommandsRequest Syntaxcliq unassignVolume volumeName= login= userName= passWord= login Required The IP address or DNS-resolvable n

HP P4000 CLI|Commands|79login Required The IP address or DNS-resolvable names of one or more storage systemsuserName Required The authentication u

8|HP P4000 CLI|Syntax• GB - gigabytes (2^30)• TB - terabytes (2^40)There is no default for size units - the units must be specified. These are def

80|HP P4000 CLI|Commandsdescription Optional Optional descriptionExamplecliq vssSnapshot volumeName=y:;z:waitForEventThis command waits for an ale

HP P4000 CLI|Syntax|9Key MeaningRIGHT Moves the cursor one space to the right.BACKSPACE Deletes the character under the cursor andmoves the cursor