manualshive.com logo in svg

HP Storevirtual 4000, User Manual

Share
Download
HP Storevirtual 4000 User Manual Download Page 27

HP Lefthand CLI |  Commands |  

27

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. The Password permissions are subsumed by the Group

permissions.For each group, the allowable permissions are: r - read-

only, w - read-write (Report does not support this), f - full-access (Report

does not support this)For example:Note: if this is not specified, the

permissions are set to rrrr

adGroup

Optional

The name of the associated active directory group.

Example

cliq createAdminGroup login=10.0.1.3 userName=admin passWord=secret
 description="My shiny new group" adminGroupName=PowerUsers
 adminUserName=user1;user2 permissions=fffr

cliq createAdminGroup description="My shiny new group"
 adminGroupName=PowerUsers adminUserName=user1;user2
 permissions=ffffr

createAdminUser

This command creates an administrative user.

Availability

: Windows, SAN/iQ

Version

: 8.0

Request Syntax

cliq createAdminUser login= userName= passWord= description= adminUserName=
adminPassWord= adminGroupName=

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).

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.

adminPassWord

Required

The password for the administrative user

description

Optional

Optional description

adminGroupName

Required

The administrative group name

Summary of Contents for Storevirtual 4000

Page 1: ... 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: ...olume 25 convertSnapshotTempSpace 26 createAdminGroup 26 createAdminUser 27 createCluster 28 createEmailNotifyPolicy 29 createGroup 29 createRemoteAssociation 30 createRemoteSnapshot 31 createServer 32 createSite 33 createSnapshot 34 createSnapshotSchedule 34 createSnmpCommunityString 36 createSnmpTrapTarget 36 createSyslogNotifyPolicy 37 createVolume 38 deleteAdminGroup 39 deleteAdminUser 39 dele...

Page 3: ...etScsiInfo 60 getServerCapabilities 60 getServerInfo 61 getServerJobInfo 61 getServerVolumeInfo 63 getSiteInfo 63 getSnapshotInfo 64 getSnapshotScheduleInfo 65 getSnmpInfo 65 getSupportInfo 66 getSystemInfo 67 getVolumeInfo 67 getVolumeControllingServer 68 help 69 makePrimary 69 makeRemote 70 modifyAdminGroup 70 modifyAdminUser 71 modifyCluster 72 modifyEmailNotifyPolicy 73 modifyGroup 73 modifyNS...

Page 4: ...MountPolicy 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 98 testCredentials 98 unassignVolume 99 unassignVolumeToServer 99 utility 100 vssSnapshot 100 waitForEvent 101 waitForUpdate 1...

Page 5: ...Windows Vista Windows 7 Windows Server 2012 Datacenter 10 MB available space Installing the CLI Install the CLI from the Management Software DVD The installation wizard automatically installs the command line software to the following default location in Windows and sets the environment variable C Program Files HP HP LeftHand HP LeftHand CLI Sample Scripts You can obtain sample scripts from the HP...

Page 6: ... formatting in the default case It is strongly discouraged to use this form of the CLI programmatically If the output needs to be parsed the XML variant is preferred separator c Some CLI parameters comprise parameters for multiple operations For example the snapshotVolumes command allows the user to specify simultaneous snapshotting of multiple volumes In this scenario some parameters specify an o...

Page 7: ... is applicable to languages that have a notion of case sensitivity All commands and parameter names are case insensitive createVolume is the same as CreateVolume is the same as CREATEVOLUME In some cases parameter values while not sensitive are case significant as the system will preserve the case specified For example the description parameter value in the createVolume command will preserve the c...

Page 8: ...me admin password DNS names You can also specify managers as a host name provided they can be resolved by DNS cliq getGroupInfo login Exchange 1 username admin password secret Storage System CLI When commands are executed on the storage systems via SSH no authentication parameters are required getGroupInfo Concurrent CLIQ commands No more than 5 concurrent commands from distinct users should be se...

Page 9: ...lls the first command entered HOME Moves the cursor to the beginning of the line END Moves the cursor to the end of the line ESCAPE Clears the current command line INSERT Toggles between insert mode the default and overwrite mode TAB Completes the command If the command method is not yet fully resolved repeated TAB keys will cycle through the possible command methods SHIFT TAB will cycle in revers...

Page 10: ... requested state CliqOperationPending 2 2 Operation has not failed but is not yet complete The handle parameter contains a value that can be used to query and cancel the operation CliqOperationAbandoned 3 3 Operation was cancelled or abandonded CliqNothingFound 4 4 Operation found no objects CliqSnapshotSet 5 5 This snapshot was a part of the snapshot set CliqVssSnapshotWarning 6 6 Warning The wri...

Page 11: ...bject not found CliqConnectionFailure 0x80001014 147 Failed to connect to the API server CliqNotEnoughSpace 0x80001015 148 Not enough space to complete the command CliqNoManager 0x80001016 149 Could not find a manager CliqSocketError 0x80001017 150 Network socket error CliqOperationTimedOut 0x80001018 151 Operation exceeded the specified timeout CliqNoPlatformSupport 0x80001019 152 This operating ...

Page 12: ...re no iSCSI connections associated with this volume To create application managed 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 wit...

Page 13: ...verVersionMismatch 0x80001039 184 Server version is not compatible CliqSnapshotNameExists 0x8000103A 185 The snapshot with this name already exists CliqVolumeInvalidSet 0x8000103B 186 Invalid volume set CliqNoVirtualManager 0x8000103C 187 A Virtual Manager was not found CliqIllegalUserGroupName 0x8000103D 188 Username must be 3 40 characters a z 0 9 or _ first character must be a lower case letter...

Page 14: ...st version that all support to operate incorrectly CliqHbaAmbitiousWWN 0x80001050 207 Multiple adapters have a matching WWN This could occur if the NodeWWN of multiple adapters is identical CliqHbaLocalBus 0x80001051 208 A persistent binding request included a bad local SCSI bus number CliqHbaLocalTarget 0x80001052 209 A persistent binding request included a bad local SCSI target number CliqHbaLoc...

Page 15: ...me 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_LoadLibrary when a library was already loaded CliqHbaIllegalFcid 0x80001061 224 The Address Identifier specified in a call to HBA_SendRNIDV2 violates a...

Page 16: ...16 HP Lefthand CLI Return Codes Result Value OS Status Description CliqMultipleIPAddresses 0x8000106A 233 Multiple IP addresses were encountered ...

Page 17: ...liq addVirtualManager assignVolume This command assigns a volume to a server This assignment sets the access to a volume based on host iqn s This command only supports iSCSI Availability Windows SAN iQ Version 8 0 Request Syntax cliq assignVolume volumeName initiator login userName passWord login Required The IP addresses or DNS resolvable names of one or more storage systems userName Conditional ...

Page 18: ...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 groupName Conditional The name of the managem...

Page 19: ...h cached credentials Parameters userName passWord or groupName must be specified volumeName Required The name of the volume serverName Required The name of the server accessRights Optional The access rights to the volume r read only x no access rw read write default transport Optional Set communication path to iSCSI or FibreChannel This can be one of iSCSI or FC lower case accepted lun Optional Se...

Page 20: ...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 snapshotName Required The name of the remote snapshot Example cliq cancelRemoteSnapshot snapshotName TheSnapshot login 10 0 1 2 userName admin passWord secret cliq cancelRemoteSnapshot snapshotN...

Page 21: ...ials groupName TheGroup clearADInfo This command removes the active directory configuration from the management group Availability Windows SAN iQ Version 10 0 Request Syntax cliq clearADInfo 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 passW...

Page 22: ...fied Example cliq clearDnsInfo login 10 0 1 3 userName admin passWord secret cliq clearDnsInfo clearEmailServerInfo This command clears the email server settings Availability Windows SAN iQ Version 9 0 Request Syntax cliq clearEmailServerInfo login userName passWord login Required The IP addresses or DNS resolvable names of one or more storage systems userName Conditional The authentication user n...

Page 23: ...must be specified Example cliq clearSnmpNotifyPolicy login 10 0 1 3 userName admin passWord secret cliq clearSnmpNotifyPolicy clearSnmpServiceInfo This command clears the SNMP Server Info Availability Windows SAN iQ Version 9 0 Request Syntax cliq clearSnmpServiceInfo login userName passWord login Required The IP addresses or DNS resolvable names of one or more storage systems userName Conditional...

Page 24: ...sWord 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 groupName Conditional The name of the management group wi...

Page 25: ...o command Example cliq configureRaid configuration RAID 10 login 10 0 1 2 userName admin passWord secret cliq configureRaid configuration RAID 10 connectVolume This command connects an already present array volume to an application server host Availability Windows Version 8 0 Request Syntax cliq connectVolume volumeName login userName passWord login Required The IP addresses or DNS resolvable name...

Page 26: ...h cached credentials Parameters userName passWord or groupName must be specified volumeName Required The name of the volume snapshotName Required The name of the remote snapshot Example cliq convertSnapshotTempSpace snapshotName MySnapshot volumeName NewVolume login 10 1 2 3 userName admin passWord secret cliq convertSnapshotTempSpace snapshotName MySnapshot volumeName NewVolume createAdminGroup T...

Page 27: ...tion My shiny new group adminGroupName PowerUsers adminUserName user1 user2 permissions fffr cliq createAdminGroup description My shiny new group adminGroupName PowerUsers adminUserName user1 user2 permissions ffffr createAdminUser This command creates an administrative user Availability Windows SAN iQ Version 8 0 Request Syntax cliq createAdminUser login userName passWord description adminUserNam...

Page 28: ...pName Conditional The name of the management group with cached credentials Parameters userName passWord or groupName must be specified clusterName Required The name of the cluster node Required The delimited list of node names or IP addresses or DNS resolvable node names of the storage systems the cluster comprises description Optional Optional description useVip Optional Should virtual IP VIP add...

Page 29: ...not be sent on informational events and 1 email will be sent for informational events The default is 0 for createEmailNotifyPolicy A combination of parameters alertOnInfo or alertOnWarning or alertOnCritical must be specified alertOnWarning Conditional Values are 0 email will not be sent on warning events and 1 email will be sent for warning events The default is 0 for createEmailNotifyPolicy A co...

Page 30: ...ired 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 groupName Conditional The name of the management group with cached creden...

Page 31: ...d The IP address or DNS resolvable names of one or more remote storage system remoteUserName Optional The authentication user name for the remote group remotePassWord Optional The password for the remote group remotegroupname Optional The name of the remote management group to identify cached credentials from Authentication Console to use instead of remoteUserName remotePassWord parameters primary...

Page 32: ... 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 If an IQN is entered and FibreChannel is NOT configured the default will be 1 otherwise no default will be selected vipLoadBalance Optional Use VIP load balancing for this host This can be one of 0 disabled or 1 enabled 1 is ...

Page 33: ...91 05 com microsoft w gregorio corp lefthandnetworks com createSite This command creates a site in a multi site SAN Availability Windows SAN iQ Version 8 0 Request Syntax cliq createSite siteName 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 ...

Page 34: ...Optional 0 the snapshot will not inherit the volume list authentication group ACL relationships of the original volume default 1 the snapshot will inherit the volume list authentication group ACL relationships of the original volume managed Optional 0 the snapshot s will not attempt to use VSS on the host connected to the volume default 1 the snapshot s will attempt to use VSS on the host connecte...

Page 35: ...etentionseconds Optional How long snapshots should be retained Either retentioncount or retentionseconds must be specified remoteip Optional The IP address of the remote group remoteUserName Optional The authentication user name for the remote group remotePassWord Optional The password for the remote group remoteCluster Optional The name of the remote cluster to host the remote volume remoteVolume...

Page 36: ...ng Optional The SNMP community string ipAddress Optional This is the IP address or Host Name to be configured ipMask Optional An IP adderss mask for SNMP notification ipSubnet Optional An IP Address subnet for SNMP notification Example cliq createSnmpCommunityString login 10 0 1 3 userName admin passWord secret ipAddress 10 0 10 25 communityString NewString cliq createSnmpCommunityString ipAddress...

Page 37: ... 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 ipAddress Required This is the IP address or Host Name to be configured alertOnInfo Conditional Values ...

Page 38: ...fied groupName Conditional The name of the management group with cached credentials Parameters userName passWord or groupName must be specified volumeName Required The name of the volume clusterName Required The name of the cluster size Required 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 description Op...

Page 39: ...d or groupName must be specified 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 Example cliq deleteAdminGroup login 10 0 1 3 userName admin passWord secret adminGroupName PowerUsers cliq deleteAdminGroup adminGroupName PowerUsers deleteAdminUser This com...

Page 40: ...roup volumeName Optional The name of the volume Example cliq deleteAutoMountPolicy groupName MG2 volumeName Vol1 cliq deleteAutoMountPolicy deleteCluster This command deletes a cluster All storage systems are removed Availability Windows SAN iQ Version 8 0 Request Syntax cliq deleteCluster clusterName login userName passWord login Required The IP addresses or DNS resolvable names of one or more st...

Page 41: ... 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 email Required The email address of the recipient Example cliq deleteEmailNotifyPolicy email myemail myhost com login 10 1 2 3 userName admin passWord secret cliq delet...

Page 42: ...e 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 remote Required The IP address or DNS resolvable names of one or more remote storage system remoteUserName Optional The authentication user name for the remote group r...

Page 43: ...erver serverName MyServer deleteSite This command deletes a site in a multi site SAN Availability Windows SAN iQ Version 8 0 Request Syntax cliq deleteSite siteName 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 s...

Page 44: ...passWord secret cliq deleteSnapshot snapshotName Snapshot0 deleteSnapshotSchedule This command deletes a previously created snapshot schedule Availability Windows SAN iQ Version 9 0 Request Syntax cliq deleteSnapshotSchedule scheduleName login userName passWord login Required The IP addresses or DNS resolvable names of one or more storage systems userName Conditional The authentication user name f...

Page 45: ...apshotTempSpace snapshotName TheSnapshot login 10 1 2 3 userName admin passWord secret cliq deleteSnapshotTempSpace snapshotName TheSnapshot deleteSnmpCommunityString This command deletes an SNMP CommunityString Either specify an IP Address as IP Address or Hostname or IP Mask and IP Subnet Availability Windows SAN iQ Version 9 0 Request Syntax cliq deleteSnmpCommunityString ipAddress login userNa...

Page 46: ... 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 Example cliq deleteSnmpTrapTarget ipAddress 10 10 10 25 login 10 1 2 3 userName admin passWord secret version 2 cliq deleteSnmpTra...

Page 47: ...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 groupName Conditional The name of the management group with cached credentials Parameters userName passWord or groupName must be ...

Page 48: ...This command is only supported for iSCSI Availability Windows Version 8 0 Request Syntax cliq disconnectLocalVolume volumeName volumeName Required The name of the volume Example cliq disconnectLocalVolume volumeName z discoverTcp This command discovers storage systems and management groups on the network using TCP Availability Windows SAN iQ Version 8 0 Request Syntax cliq discoverTCP groupOrder n...

Page 49: ...ership This can be one of 0 default 1 receivePort Optional The TCP port to receive the discovery packets defaults to an unused port if unspecified waitForData Optional The number of milliseconds to wait for the discovery packets defaults to 3000 if unspecified Example cliq discoverUdp ipMask 255 255 240 0 ipSubnet 10 0 0 0 cliq discoverUdp ipMask 255 255 240 0 ipSubnet 10 0 0 0 dismountVolume This...

Page 50: ...rectory server when you specify hostname in the query you get back BASEDN for this server The name must be specified in the following format ldap 10 10 10 10 adUserName Optional An active directory user name when you specify it you get back list of active directory groups that user belongs to ldaps Optional Use secure ldap connection set it to false to change default is true Example CLIQ findadinf...

Page 51: ...roup_1 1 1 GROUP name SANFull findFile Availability Windows SAN iQ Version 10 0 Request Syntax cliq findFile login userName passWord source Required Source filter source name filter Optional The optional search filter copy Optional The optional ability to copy found file s and folder s default is false destination Optional The optional destination for copied file s and folder s recurse Optional Th...

Page 52: ...assWord 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 0 processingTime 13556 name CliqSuccess memoryUsage 835357 description Operation succeeded INFO userCon...

Page 53: ...and Recovery Manager application on this computer Availability Windows Version 10 0 Request Syntax cliq getAutoMountPolicy Example cliq getAutoMountPolicy cliq getAutoMountPolicy getClusterInfo This command returns information about a cluster Availability Windows SAN iQ Version 8 0 Request Syntax cliq getClusterInfo clusterName login userName passWord login Required The IP addresses or DNS resolva...

Page 54: ...s section contains volume information Example cliq getClusterInfo clusterName Cluster0 login 10 1 2 3 userName admin passWord secret cliq getClusterInfo clusterName Cluster0 getDnsInfo This command gets the DNS settings Availability Windows SAN iQ Version 9 0 Request Syntax cliq getDnsInfo login userName passWord login Required The IP addresses or DNS resolvable names of one or more storage system...

Page 55: ...ts LocalEvents format Optional Output format This can be one of Remote Client Xml report Optional Output verbosity This can be one of Brief Standard Verbose time Optional Time filter format YYYYMMDDhhmmss YYYYMMDDhhmmss component Optional Component filter This can be one or more of Saniq Hal Sys severity Optional Severity filter This can be one or more of Info Warning Critical object Optional Obje...

Page 56: ...OTIFYPOLICY EMAILSERVERINFO SNMPSERVICEPOLICY SNMPNOTIFICATIONPOLICY SNMPCOMMUNITYSTRING SNMPTRAPTARGET FIBRECHANNEL DNSINFO NSM CUSTOMERINFO SERVERAPPLICATION CLIENTAPPLICATION REMOTEASSOCIATION ADMINGROUP CLUSTER GROUP This section contains group information ALERTANDEVENTPOLICY This section contains alert and event policy information EMAILNOTIFYPOLICY This section contains email notification pol...

Page 57: ...rts and Events Policy Email Notification Policy Syslog Notification Policy and Email Server Setting Availability Windows SAN iQ Version 9 0 Request Syntax cliq getNotificationPolicy 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 gr...

Page 58: ...ECHANNEL NIC BONDTYPE GOSSIPADDRESS RAIDSETTING NSM This section contains NSM information FIBRECHANNEL This section contains fibre channel information NIC This section contains NIC information BONDTYPE This section contains supported bond type information GOSSIPADDRESS This section contains gossip address information RAIDSETTING This section contains supported raid type information Example cliq ge...

Page 59: ...ntication 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 interval Optional The interval in between...

Page 60: ...SHOT This section contains remote snapshot information Example cliq getRemoteSnapshotInfo snapshotName TheSnapshot login 10 1 2 3 userName admin passWord secret cliq getRemoteSnapshotInfo snapshotName TheSnapshot getScsiInfo This command returns SCSI inquiry information about a locally connected volume Availability Windows Version 8 0 Request Syntax cliq getScsiInfo volumeName volumeName Required ...

Page 61: ...rameters 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 serverName Optional The name of the server serverclustername Optional The name of the ...

Page 62: ...or processingTime Processing time result Result code job The job data applicationIntegration Managed application type 0 VSS 1 VMWare endTime Time when the job is completed instanceID Instance ID percentComplete Percent complete volumeName The name of the volume Example Request cliq getServerJobInfo serverIp 1 2 3 4 jobId 1123 Example Response response description Operation succeeded name GaucheSuc...

Page 63: ...erverVolumeInfo serverIp 10 0 1 45 cliq getServerVolumeInfo serverIp 10 0 1 45 getSiteInfo This command returns site information on multi site SANs Availability Windows SAN iQ Version 8 0 Request Syntax cliq getSiteInfo siteName 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 st...

Page 64: ...pName must be specified groupName Conditional The name of the management group with cached credentials Parameters userName passWord or groupName must be specified snapshotName Optional The name of the remote snapshot searchDepth Optional Which objects to inspect 1 Snapshots only 2 Snapshots and remote snapshots default The greater the search depth number the longer the call can take verbose Option...

Page 65: ...st 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 scheduleName Optional The name of the schedule Response Syntax SCHEDULE SCHEDULE This section contains schedule information Exam...

Page 66: ...et cliq getSnmpInfo getSupportInfo This command gathers all support log files from a management group and all its member storage systems If the specified storage system does not belong to any management group then only logs from the storage system will be collected This command stores the archive locally Availability Windows Version 8 5 Request Syntax cliq getSupportInfo login userName passWord fi...

Page 67: ... getSystemInfo cliq getSystemInfo getVolumeInfo This command returns information about a volume Availability Windows SAN iQ Version 8 0 Request Syntax cliq getVolumeInfo volumeName 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 gro...

Page 68: ...tains schedule information PERMISSION This section contains permission information Example cliq getVolumeInfo volumeName volume0 login 10 1 2 3 userName admin passWord secret cliq getVolumeInfo volumeName volume0 getVolumeControllingServer This command is used to retrieve the controlling server of a volume Availability Windows SAN iQ Version 8 0 Request Syntax cliq getVolumeControllingServer login...

Page 69: ...0 Request Syntax cliq makePrimary login userName passWord volumeName size 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...

Page 70: ...ified groupName Conditional The name of the management group with cached credentials Parameters userName passWord or groupName must be specified volumeName Required The name of the volume snapshotName Required The name of the remote snapshot Example cliq makeRemote login 10 1 2 3 userName admin passWord secret volumeName TheVolume snapshotName TheSnapshot cliq makeRemote volumeName TheVolume snaps...

Page 71: ... to rrrr adGroup Optional The name of the associated active directory group Example cliq modifyAdminGroup login 10 0 1 3 userName admin passWord secret description My shiny new group adminGroupName PowerUsers adminUserName user1 user2 permissions fffr cliq modifyAdminGroup description My shiny new group adminGroupName PowerUsers adminUserName user1 user2 permissions fffr modifyAdminUser This comma...

Page 72: ... name of the management group with cached credentials Parameters userName passWord or groupName must be specified clusterName Required The name of the cluster newName Optional The new name for the cluster description Optional Optional description useVip Optional Should virtual IP VIP addressing be used This can be one of 0 1 default node Optional The delimited list of node names or IP addresses or...

Page 73: ...l events and 1 email will be sent for informational events The default is 0 for createEmailNotifyPolicy A combination of parameters alertOnInfo or alertOnWarning or alertOnCritical must be specified alertOnWarning Conditional Values are 0 email will not be sent on warning events and 1 email will be sent for warning events The default is 0 for createEmailNotifyPolicy A combination of parameters ale...

Page 74: ...ntactName Optional Contact name postalAddress Optional Postal address line 1 postalAddress2 Optional Postal address line 2 cityName Optional Postal city stateName Optional Postal state countryName Optional Postal country postalCode Optional Postal code telephoneNumber Optional Contact telephone number emailaddress Optional The notification email Example cliq modifyGroup login 10 0 1 2 userName adm...

Page 75: ...or groupName must be specified groupName Conditional The name of the management group with cached credentials Parameters userName passWord or groupName must be specified remote Required The IP address or DNS resolvable names of one or more remote storage system remoteUserName Optional The authentication user name for the remote group remotePassWord Optional The password for the remote group primar...

Page 76: ... 50 Either remoteretentioncount or remoteretentionseconds must be specified remoteretentionseconds Optional How long remote snapshots should be retained Either remoteretentioncount or remoteretentionseconds must be specified Example cliq modifyRemoteSnapshotSchedule scheduleName TheSchedule login 10 0 1 2 userName admin passWord secret remoteretentioncount 10 cliq modifyRemoteSnapshotSchedule sche...

Page 77: ... it It will coordinate the snapshot with the applications using SAN volumes This is required for managed snapshots of FibreChannel connected volumes This is also required for VMware managed snapshots enter the Virtual Center Server IP address allowfcaccess Optional Allow FibreChannel ports to be assigned to the client This can be one of 0 disable or 1 enable If volumes are attached to a client ser...

Page 78: ... 1 is the default Example cliq modifySite siteName TheSite description My Site login 10 0 1 2 userName admin passWord secret cliq modifySite siteName TheSite description My Site modifySnapshot This command modifies snapshot settings Availability Windows SAN iQ Version 8 0 Request Syntax cliq modifySnapshot description login userName passWord snapshotName login Required The IP addresses or DNS reso...

Page 79: ...duleName Required The name of the schedule description Optional Optional description recurperiod Optional The recurrence frequency of the snapshots specified in seconds Period may be 0 to indicate the schedule never occurs otherwise Period must be at least 1800 seconds 30 minutes starttime Optional The start time of the schedule Specified as ISO 8601 Format is YYYY MM DDTHH MM SSZ YYYY represents ...

Page 80: ...yString Required The SNMP community string Example cliq modifySnmpCommunityString login 10 0 1 3 userName admin passWord secret communityString NewString cliq modifySnmpCommunityString communityString NewString modifySnmpTrapTarget This command modifies an SNMP Trap Target Availability Windows SAN iQ Version 8 0 Request Syntax cliq modifySnmpTrapTarget login userName passWord communityString login...

Page 81: ...address or Host Name to be configured alertOnInfo Conditional Values are 0 the log does not includes informational events and 1 the log includes informational events The default is 0 for createSyslogNotifyPolicy A combination of parameters alertOnInfo or alertOnWarning or alertOnCritical must be specified alertOnWarning Conditional Values are 0 the log does not includes warning events and 1 the lo...

Page 82: ...olume This enables parity network RAID on the volume Replication and parity are supported in the following combinations replication 1 parity 0 Network RAID 0 None replication 2 parity 0 Network RAID 10 2 way Mirror 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 Ne...

Page 83: ...er assignVolume and connected connectVolume Request Syntax cliq mountVolume groupName volumeName mountpoint create groupName Required The name of the management group volumeName Required The name of the volume mountPoint Required The drive letter or mount point on the host for the volume LUN will be uninitialized if not specified forcecreate Optional Create if it does not exist Example cliq mountV...

Page 84: ...ions replication 1 parity 0 Network RAID 0 None replication 2 parity 0 Network RAID 10 2 way Mirror 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 Optional 0 the volume does not use checksums1 the volume uses checksums thinProvi...

Page 85: ...oupName must be specified groupName Conditional The name of the management group with cached credentials Parameters userName passWord or groupName must be specified volumeName Required The name of the volume Example cliq rebalanceVip volumeName MyVolume login 10 1 2 3 userName admin passWord secret cliq rebalanceVip volumeName MyVolume recoverQuorum This command is used to rescue a management grou...

Page 86: ...serName admin passWord secret cliq recoverQuorum removeSnapshot This command disconnects a SAN snapshot from the host then deletes it If the snapshot cannot be disconnected because it s in use or for any other reason it will not be deleted Availability Windows Version 8 5 Request Syntax cliq removeSnapshot snapshotName login userName passWord login Required The IP addresses or DNS resolvable names...

Page 87: ...me z login 10 0 1 2 userName admin passWord secret resetSession This command resets the iSCSI session associated with a volume Some initiators will attempt to reconnect after the reset Availability Windows SAN iQ Version 8 0 Request Syntax cliq resetSession volumeName login userName passWord login Required The IP addresses or DNS resolvable names of one or more storage systems userName Conditional...

Page 88: ...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 groupName Conditional The name of the management group...

Page 89: ...d 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 groupName Conditional The name of the management group with c...

Page 90: ...ired The aging in months Example cliq setAlertsPolicy login 10 0 1 3 userName admin passWord secret aging 2 cliq setAlertsPolicy aging 2 setAutoMountPolicy This command sets the auto mount policy for the HP LeftHand Recovery Manager application on this computer Availability Windows Version 10 0 Warnings The HP LeftHand Recovery Manager must be installed on the system to implement automount polices...

Page 91: ... domainname Optional The domain name suffix Optional DNS suffixes server Optional List of DNS servers IP addresses Example cliq setDnsInfo login 10 0 1 3 userName admin passWord secret server 10 23 0 101 suffix suffix1 suffix2 domainname domainname cliq setDnsInfo server 10 23 0 101 suffix suffix1 suffix2 domainname domainname setEmailServerInfo This command sets the configuration information for ...

Page 92: ...ly Availability Version future Warnings This operation is irreversible Request Syntax cliq setGossipList 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 stor...

Page 93: ...1 A730 737B 718C 9063 7183 8CAF 4B3E 25 setSnmpNotifyPolicy This command sets SNMP Notification Policy settings Availability Windows SAN iQ Version 9 0 Request Syntax cliq setSnmpNotifyPolicy login userName passWord verbosity alertOnCritical login Required The IP addresses or DNS resolvable names of one or more storage systems userName Conditional The authentication user name for the storage syste...

Page 94: ...cation 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 contactinfo Optional Contact information loc...

Page 95: ...in 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 groupName Conditional The name of the management group with cached...

Page 96: ...r startSnmpService This command starts the SNMP Service Availability Windows SAN iQ Version 9 0 Request Syntax cliq startSnmpService 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 Th...

Page 97: ...ger This command stops the manager on a storage system Availability Windows SAN iQ Version 8 0 Request Syntax cliq stopManager 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 pass...

Page 98: ... 8 0 Request Syntax cliq stopVirtualManager 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 speci...

Page 99: ...resses 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 groupName Conditional The name of the management group with cached credentials Parameter...

Page 100: ...mmended for HP support only Request Syntax cliq utility run 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 groupNa...

Page 101: ...ters Optional List of writer GUIDs to exclude from the shadow copy includeWriters Optional List of writer GUIDs to include in the shadow copy if the writer is found to not participate in the snapshot no snapshot will be taken runCommand Optional Custom command executed after shadow creation import or between break and make it write importShadow Optional Transportable VSS snapshot import mountShado...

Page 102: ...ret cliq waitForEvent waitForUpdate This command will block on a change to the state in the management group Availability Windows SAN iQ Version 8 0 Request Syntax cliq waitForUpdate 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 g...

Reviews:

No comments

Brands by name

Popular brands

Load more brands