HP StoreVirtual 4000 User Manual
Lefthand storage command-line interface user guide
Hide thumbs
Also See for StoreVirtual 4000:
- User manual (282 pages) ,
- Configuration manual (40 pages) ,
- Specification (36 pages)
Table of Contents
Advertisement
Quick Links
HP
Lefthand Storage Command-Line Interface
User Guide
This guide provides information for using the command-line interface provided with the HP Lefthand Storage software.
Command syntax is included, and a link to sample scripts available from the HP website.
Part Number : AX696-96182
Second edition : November 2012
Advertisement
Table of Contents
Related Manuals for HP StoreVirtual 4000
Summary of Contents for HP StoreVirtual 4000
- Page 1 Lefthand Storage Command-Line Interface User Guide This guide provides information for using the command-line interface provided with the HP Lefthand Storage software. Command syntax is included, and a link to sample scripts available from the HP website. Part Number : AX696-96182 Second edition : November 2012...
-
Page 2: Table Of Contents
Contents Overview..........................5 Global Parameters........................6 Syntax........................... 7 Return Codes........................10 Commands...........................17 addVirtualManager..................... 17 assignVolume......................17 assignVolumeChap...................... 18 assignVolumeToServer....................19 cacheCredentials......................19 cancelRemoteSnapshot....................20 clearAlertsPolicy......................20 clearCredentials......................21 clearADInfo........................ 21 clearDnsInfo........................22 clearEmailServerInfo....................22 clearSnmpNotifyPolicy....................23 clearSnmpServiceInfo....................23 clearVssVolumeFlags....................24 cloneSnapshot......................24 configureRaid......................25 connectVolume......................25 convertSnapshotTempSpace..................26 createAdminGroup...................... 26 createAdminUser......................27 createCluster.......................28 createEmailNotifyPolicy....................29... - Page 3 deleteSnmpTrapTarget....................46 deleteSyslogNotifyPolicy....................46 deleteVirtualManager....................47 deleteVolume......................47 disconnectLocalVolume....................48 discoverTcp........................ 48 discoverUdp....................... 49 dismountVolume......................49 findADInfo........................50 findFile........................51 getADInfo........................51 getAlertLog......................... 52 getAutoMountPolicy..................... 53 getClusterInfo......................53 getDnsInfo........................54 getEventLog........................ 55 getGroupInfo......................55 getLocalVolumes......................57 getNotificationPolicy....................57 getNsmInfo......................... 58 getNsmLogs........................ 58 getPerformanceStats.....................59 getRemoteSnapshotInfo....................
- Page 4 provisionVolume......................83 rebalanceVip......................85 recoverQuorum......................85 removeSnapshot......................86 removeVolume......................87 resetSession........................ 87 rollbackSnapshot......................88 runDiagnostic......................88 setADInfo........................89 setAlertsPolicy......................90 setAutoMountPolicy......................90 setDnsInfo........................91 setEmailServerInfo....................... 91 setGossipList....................... 92 setLicenseKey......................92 setSnmpNotifyPolicy....................93 setSnmpServiceInfo...................... 94 shutdownGroup......................94 shutdownNsm......................95 startManager......................95 startSnmpService......................96 startVirtualManager..................... 96 stopManager......................97 stopSnmpService......................97 stopVirtualManager.....................
-
Page 5: Overview
Overview The SAN/iQ command-line interface (CLI) is built upon the SAN/iQ 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. -
Page 6: Global Parameters
Global Parameters prompt=<true | false> Some potentially destructive commands prompt before proceeding. This default behavior can be turned off by specifying "prompt=false". output=<XML | Normal> In the default case, the CLI returns information to standard output, formatted in a way that's easy to read rather than easy to parse. -
Page 7: Syntax
Syntax CLIQ is the command-line interface (CLI) for the HP LeftHand Storage Solution. The CLI specifies parameters in the form parameter=<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... - Page 8 If a parameter contains fewer elements in the list than needed for the composite command, the last one in the list will be repeated. There must be at least one element in the list, if it's required. Size specification When volume sizes or thresholds are specified, the format is <size><units>, where units are: •...
- Page 9 >cliq SAN/iQ Command Line Interface, v10.0 (type exit to quit) (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P. CLIQ> The integrated shell supports rich command line editing features specific to the HP LeftHand API. The following editing keys are supported: Meaning LEFT Moves the cursor one space to the left.
-
Page 10: Return Codes
Return Codes All GAUCHE commands return an XML response containing a 32-bit result code, and a description of the result. Example: <?xml version="1.0" encoding="UTF-8" standalone="no" ?> <gauche version="1.0"> <response description="Succeeded" result="0"/> </gauche> Success results are nonnegative values, while negative values indicate an error. Many errors returned by SAN/iQ and Hydra unfortunately do not return ordinal values that can be conveniently mapped into an API and CLI return code. - Page 11 Result Value OS Status Description CliqUnrecognizedParameter 0x80001008 This parameter is unrecognized. CliqIncompatibleParameters 0x80001009 Two or more parameters supplied are incompatible with each other. CliqNotYetImplemented 0x8000100A This is a legal command - we just haven't done it yet. CliqNoMemory 0x8000100B Out of memory. CliqVolumeNotFound 0x8000100C Could not find the requested...
- Page 12 Result Value OS Status Description CliqIllegalPassword 0x80001021 The password must be 5..40 characters, not / or :. CliqFileError 0x80001022 General file error. CliqMissingInitiator 0x80001023 No iSCSI initiator found. CliqInitiatorStopped 0x80001024 The iSCSI initiator is not running. CliqSanIqTooOld 0x80001025 The version of SAN/iQ software must be upgraded.
- Page 13 Result Value OS Status Description CliqVssLunInfoFailed 0x8000102E Cannot create an application- managed snapshot because the system failed to get LUN data. CliqVssWriterUnavailable 0x8000102F The VSS writer operation failed. CliqSnapshotInProgress 0x80001030 Another app-managed snapshot is in progress. CliqWindowsServerIsBusy 0x80001031 The application server is busy. CliqUpdateVssProvider 0x80001032 This version of VSS provider must be...
- Page 14 Result Value OS Status Description CliqHbaStaleData 0x80001048 Information has changed since the last call to HBA_RefreshInformation. CliqHbaScsiCheckCondition 0x80001049 SCSI Check Condition reported. CliqHbaBusy 0x8000104A Adapter busy or reserved, retry may be effective. CliqHbaTryAgain 0x8000104B Request timed out, retry may be effective.
- Page 15 Result Value OS Status Description Number not defined by the identified Target. CliqHbaTargetLuid 0x80001059 A persistent binding request included an undefined or otherwise inaccessible Logical Unit Unique Identifier. CliqHbaNoSuchBinding 0x8000105A A persistent binding remove request included a binding which did not match a binding established by the specified port.
- Page 16 Result Value OS Status Description CliqMultipleIPAddresses 0x8000106A Multiple IP addresses were encountered. 16 | HP Lefthand CLI | Return Codes...
-
Page 17: Commands
Commands addVirtualManager This command adds a virtual manager to a group. Availability: Windows, SAN/iQ Version: 8.0 Request Syntax cliq addVirtualManager login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 18: Assignvolumechap
accessRights Optional The access rights to the volume: r - read-only, x - no access, rw - read- write (default) initiator Optional 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). -
Page 19: Assignvolumetoserver
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, SAN/iQ Version: 9.0 Request Syntax cliq assignVolumeToServer volumeName= serverName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage... -
Page 20: Cancelremotesnapshot
userName Required The authentication user name for the storage system. passWord Required The password for the storage system. groupName Required The name of the management group Example cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret cancelRemoteSnapshot This command cancels a remote snapshot. Availability: Windows, SAN/iQ Version: 8.0 Request Syntax cliq cancelRemoteSnapshot snapshotName= login= userName= passWord=... -
Page 21: Clearcredentials
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. -
Page 22: Cleardnsinfo
clearDnsInfo This command clears the DNS settings. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq clearDnsInfo login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 23: Clearsnmpnotifypolicy
clearSnmpNotifyPolicy This command clears the SNMP Notification Policy settings. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq clearSnmpNotifyPolicy login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 24: Clearvssvolumeflags
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 SAN/iQ snapshot. -
Page 25: Configureraid
configureRaid This command reconfigures the RAID setting on a storage system. Availability: Windows, SAN/iQ Version: 8.0 Request Syntax cliq configureRaid configuration= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. -
Page 26: Convertsnapshottempspace
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, SAN/iQ Version: 8.0 Request Syntax cliq convertSnapshotTempSpace snapshotName= volumeName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional... -
Page 27: Createadminuser
groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). adminGroupName Required The administrative group name description Optional Optional description adminUserName Optional Specifies the users that this group comprises. permissions Optional Permissions for the group. This is a character sequence specifying the allowable permissions in the following order: Group,Network,Storage System,Report. -
Page 28: Createcluster
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, SAN/iQ Version: 8.0 Request Syntax cliq createCluster login= userName= passWord= clusterName= description= useVip= node= vip= login... -
Page 29: Createemailnotifypolicy
createEmailNotifyPolicy This command configures which level of events from the management group are sent via email to the designated recipients. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq createEmailNotifyPolicy login= userName= passWord= email= verbosity= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional... -
Page 30: Createremoteassociation
cliq createGroup groupName= node= userName= passWord= node Required The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises. groupName Required The name of the management group userName Required The authentication user name for the storage system. passWord Required The password for the storage system. -
Page 31: Createremotesnapshot
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 SAN/iQ volume. Availability: Windows, SAN/iQ Version: 8.0 Request Syntax cliq createRemoteSnapshot login= userName= passWord= primarySnapshot= remoteSnapshot= remoteVolume= description= remote= remoteUserName= remotePassWord= remoteCluster= login... -
Page 32: Createserver
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. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax... -
Page 33: Createsite
via FibreChannel and a value of 0 is entered, the client will lose its ability to communicate with the attached volumes. wwpn Optional 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. -
Page 34: Createsnapshot
createSnapshot This command creates a snapshot of one or more SAN/iQ volumes. Availability: Windows, SAN/iQ Version: 8.0 Request Syntax cliq createSnapshot volumeName= snapshotName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. - Page 35 login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified).
-
Page 36: Createsnmpcommunitystring
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, SAN/iQ Version: 9.0 Request Syntax... -
Page 37: Createsyslognotifypolicy
groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). ipAddress Required This is the IP address or Host Name to be configured. version Required The SNMP Version. 1 - Version 1, 2 - Version 2 communityString Required The SNMP community string. -
Page 38: Createvolume
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, SAN/iQ Version: 8.0 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. -
Page 39: Deleteadmingroup
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, SAN/iQ Version: 8.0 Request Syntax cliq deleteAdminGroup login= userName= passWord= adminGroupName= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName... -
Page 40: Deleteautomountpolicy
groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). adminUserName Required 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 LeftHand Recovery Manager application on this computer. -
Page 41: Deleteemailnotifypolicy
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, SAN/iQ Version: 9.0 Request Syntax cliq deleteEmailNotifyPolicy email= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage... -
Page 42: Deleteremoteassociation
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, SAN/iQ Version: 8.0 Request Syntax cliq deleteRemoteAssociation login= userName= passWord= remote= remoteUserName= remotePassWord= login Required... -
Page 43: Deletesite
Request Syntax cliq deleteServer serverName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. -
Page 44: Deletesnapshotschedule
Warnings This operation is irreversible. Request Syntax cliq deleteSnapshot snapshotName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. -
Page 45: Deletesnapshottempspace
deleteSnapshotTempSpace This command deletes the snapshot temporary space. Availability: Windows, SAN/iQ Version: 8.0 Warnings This operation is irreversible. Request Syntax cliq deleteSnapshotTempSpace snapshotName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. -
Page 46: Deletesnmptraptarget
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, SAN/iQ Version: 9.0 Request Syntax cliq deleteSnmpTrapTarget ipAddress= login= userName= passWord= version= login Required The IP addresses or DNS-resolvable names of one or more storage... -
Page 47: Deletevirtualmanager
groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). ipAddress Required 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. -
Page 48: Disconnectlocalvolume
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 49: Discoverudp
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, SAN/iQ Version: 8.0 Request Syntax cliq discoverUdp ipMask= ipSubnet= ipMask Required An IP adderss mask for SNMP notification. ipSubnet Required An IP Address subnet for SNMP notification. -
Page 50: Findadinfo
Optional Use secure ldap connection, set it to false to change, default is true. Example CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 hostname=ldap://10.21.66.9 SAN/iQ Command Line Interface, v10.0.0.1 (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P. RESPONSE result processingTime 4044 name CliqSuccess memoryUsage... -
Page 51: Findfile
CliqSuccess memoryUsage 838981 description Operation succeeded. INFO basedn DC=win8dom,DC=com CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 bindusername=dtest@win8dom.com SAN/iQ Command Line Interface, v10.0.0.1 (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P. RESPONSE result processingTime 3971 name CliqSuccess memoryUsage 837947 description Operation succeeded. GROUP name group_1-1-1... -
Page 52: Getalertlog
(Parameters userName/passWord or groupName must be specified). Response Syntax INFO ... INFO This section contains active directory information. Example cliq getADInfo login=10.0.1.3 userName=admin passWord=secret SAN/iQ Command Line Interface, v10. (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P. RESPONSE result processingTime 13556 name CliqSuccess memoryUsage 835357... -
Page 53: Getautomountpolicy
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 54: Getdnsinfo
searchDepth 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. verbose Optional How much information to return 0 - Get summary information only... -
Page 55: Geteventlog
Example cliq getDnsInfo login=10.0.1.3 userName=admin passWord=secret cliq getDnsInfo getEventLog This command returns event information. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq getEventLog login= userName= passWord= type= format= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional... - Page 56 Request Syntax cliq getGroupInfo login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system.
-
Page 57: Getlocalvolumes
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 LeftHand 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). -
Page 58: Getnsminfo
getNsmInfo This command returns information about a storage system. Availability: Windows, SAN/iQ Version: 8.0 Request Syntax cliq getNsmInfo login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 59: Getperformancestats
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). logFile Required 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.gz... -
Page 60: Getscsiinfo
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 61: Getserverinfo
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 SAN/iQ volumes. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq getServerInfo login= userName= passWord=... - Page 62 cliq getServerJobInfo serverIp= jobId= serverIp Required The Windows server IP address. jobId Optional Job ID volumeName Optional The name of the volume Response Syntax response description="" name="" processingTime="" result="" applicationIntegration="" description="" endTime="" instanceID="" percentComplete="" result="" startTime="" status="" volumeName="" description Optional description name Name of the CLIQ error processingTime...
-
Page 63: Getservervolumeinfo
getServerVolumeInfo This command returns the features of a volume by interrogating a remote server. This will return VSS associated volumes. Availability: Windows, SAN/iQ Version: 8.5 Request Syntax cliq getServerVolumeInfo serverIp= serverIp Required The Windows server IP address. searchDepth Optional Which objects to inspect 1 - Volumes only, 2 - Volumes and snapshots, 3 - Volumes, snapshots and remote snapshots (default). -
Page 64: Getsnapshotinfo
SITE 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, SAN/iQ Version: 8.0 Request Syntax cliq getSnapshotInfo snapshotName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage... -
Page 65: Getsnapshotscheduleinfo
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, SAN/iQ Version: 9.0 Request Syntax cliq getSnapshotScheduleInfo login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional... -
Page 66: Getsupportinfo
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 67: Getsysteminfo
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, SAN/iQ Version: 8.0 Request Syntax cliq getSystemInfo Response Syntax INFO ... FCADAPTER ... -
Page 68: Getvolumecontrollingserver
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. verbose Optional How much information to return 0 - Get summary information only (better performance), 1 - Get all information (better information - default). -
Page 69: Help
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, SAN/iQ Version: 8.0 Request Syntax cliq help command= command Optional A specific command for more detailed help informationNote: if help is specified with no parameters, a list of possible return codes is returned Example cliq help command=getSystemInfo... -
Page 70: Makeremote
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, SAN/iQ Version: 8.0 Request Syntax cliq makeRemote login= userName= passWord= volumeName= snapshotName= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName... -
Page 71: Modifyadminuser
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 72: Modifycluster
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, SAN/iQ Version: 8.0 Warnings Modifying a cluster will cause a restripe of every volume in the cluster. Request Syntax cliq modifyCluster clusterName= login= userName= passWord= description= useVip= node= vip=... -
Page 73: Modifyemailnotifypolicy
modifyEmailNotifyPolicy This command modifies an Email Notification Policy. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq modifyEmailNotifyPolicy login= userName= passWord= email= verbosity= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 74: Modifynsm
Request Syntax cliq modifyGroup login= userName= passWord= node= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. -
Page 75: Modifyremoteassociation
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. -
Page 76: Modifyremotesnapshotschedule
modifyRemoteSnapshotSchedule This command modifies a previously created remote snapshot schedule. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq modifyRemoteSnapshotSchedule scheduleName= login= userName= passWord= remoteretentioncount= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. -
Page 77: Modifysite
serverName Required The name of the server description Optional Optional description allowiSCSIAccess Optional Allow iSCSI access for this host. This can be one of: 0 = disable or 1 = enable. If volumes are attached to a client server via iSCSI and a value of 0 is entered, the client server will lose its ability to communicate with the attached volumes. -
Page 78: Modifysnapshot
Version: 8.0 Warnings This operation is irreversible. Request Syntax cliq modifySite siteName= description= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 79: Modifysnapshotschedule
autogrowpages Optional Automatically grow the pages. 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, SAN/iQ Version: 9.0 Request Syntax cliq modifySnapshotSchedule scheduleName= description= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage... -
Page 80: Modifysnmpcommunitystring
modifySnmpCommunityString This command modifies the Community String for all SNMP. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq modifySnmpCommunityString login= userName= passWord= communityString= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 81: Modifysyslognotifypolicy
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, SAN/iQ Version: 9.0 Request Syntax cliq modifySyslogNotifyPolicy login= userName= passWord= ipAddress= alertOnInfo= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional... - Page 82 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.
-
Page 83: Mountvolume
size Optional The size of the volume, with units specified: <n>MB - n Megabytes (1024 Kilobytes), <n>GB - n Gigabytes (1024 Megabytes), <n>TB - n Terabytes (1024 Gigabytes) autogrowpages Optional Automatically grow the pages. Example cliq modifyVolume description="New Description" login=10.0.1.2 userName=admin passWord=secret volumeName=TheVolume cliq modifyVolume description="New Description"... - Page 84 Changing the replication level of this volume will cause it to restripe, and may impact IO performance. Request Syntax cliq provisionVolume clusterName= volumeName= description= size= mountPoint= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional...
-
Page 85: Rebalancevip
chapName Optional 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 Optional The CHAP initiator secret for the volume. Example cliq provisionVolume clusterName=TheCluster volumeName=TheVolume description=NewVolume size=100GB mountPoint=z: login=10.0.1.2... -
Page 86: Removesnapshot
Contact support before proceeding. Only use the Recover Quorum command when actively working with support personnel and they direct you to invoke the command. Request Syntax cliq recoverQuorum login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional... -
Page 87: Removevolume
removeVolume This command disconnects a SAN volume from the host, then deletes it. If the volume cannot be disconnected (because it's in use, or for any other reason), it will not be deleted. Availability: Windows Version: 8.0 Request Syntax cliq removeVolume volumeName= login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage... -
Page 88: Rollbacksnapshot
Example cliq resetSession volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret cliq resetSession volumeName=MyVolume rollbackSnapshot This command rolls back a snapshot. WARNING: 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. -
Page 89: Setadinfo
login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 90: Setalertspolicy
setAlertsPolicy This command sets information for the Alerts and Events Policy. Availability: Windows, SAN/iQ Version: 9.0 Request Syntax cliq setAlertsPolicy login= userName= passWord= aging= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. -
Page 91: Setdnsinfo
Example cliq setAutoMountPolicy cliq setAutoMountPolicy setDnsInfo This command sets information for DNS. Availability: Windows, SAN/iQ Version: 8.0 Request Syntax cliq setDnsInfo login= userName= passWord= server= suffix= domainname= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional... -
Page 92: Setgossiplist
groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). ipAddress Optional This is the IP address or Host Name to be configured. email Optional The email address of the sender. portNumber Optional The Port Number to send email on. -
Page 93: Setsnmpnotifypolicy
Request Syntax cliq setLicenseKey login= userName= passWord= licenseKey= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. -
Page 94: Setsnmpserviceinfo
alertOnCritical Conditional Values are: 0 = do not transmit critical events and, 1 = trasmit critical events. (A combination of parameters alertOnInfo or alertOnWarning or alertOnCritical must be specified). Example cliq setSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secret alertOnWarning=1 cliq setSnmpNotifyPolicy alertOnWarning=1 setSnmpServiceInfo This command sets information about the SNMP Service. -
Page 95: Shutdownnsm
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 96: Startsnmpservice
Version: 8.0 Request Syntax cliq startManager login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. -
Page 97: Stopmanager
cliq startVirtualManager login= userName= passWord= login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 98: Stopvirtualmanager
login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). -
Page 99: Unassignvolume
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 100: Utility
userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified). groupName Conditional The name of the management group with cached credentials. (Parameters userName/passWord or groupName must be specified). -
Page 101: Waitforevent
Version: 8.0 Request Syntax cliq vssSnapshot volumeName= volumeName Optional The name of the volume persistent Optional Is the snapshot persistent? This can be one of: 0, 1 - default transportable Optional Is the snapshot transportable? This can be one of: 0 - default, 1 backupDoc Optional The name of the backup document file... -
Page 102: Waitforupdate
login Required The IP addresses or DNS-resolvable names of one or more storage systems userName Conditional The authentication user name for the storage system. (Parameters userName/passWord or groupName must be specified). passWord Conditional The password for the storage system. (Parameters userName/passWord or groupName must be specified).