HP StoreVirtual 4000 User Manual

HP StoreVirtual LeftHand OS Command Line Interface User Guide

Abstract

For the latest version of this guide, see the HP website http://www.hp.com/support/StoreVirtualManuals.

HP Part Number: AX696-96291 Published: September 2013 Edition: 6

Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.

DateEdition

DescriptionSoftware

Version

8.0November 20081

Added the following commands: addVirtualManager, assignVolume,

assignVolumeChap, cacheCredentials, cancelRemoteSnapshot, clearCredentials, cloneSnapshot, configureRaid, connectVolume, convertSnapshotTempSpace, createAdminGroup, createAdminUser, createCluster, createGroup, createRemoteAssociation, createRemoteSnapshot, createSite, createSnapshot, createVolume, deleteAdminGroup, deleteAdminUser, deleteCluster, deleteGroup, deleteRemoteAssociation, deleteSite, deleteSnapshot, deleteSnapshotTempSpace, deleteVirtualManager, deleteVolume, disconnectLocalVolume, discoverTcp, discoverUdp, dismountVolume, getClusterInfo, getGroupInfo, getLocalVolumes, getNsmInfo, getNsmLogs, getPerformanceStats, getRemoteSnapshotInfo, getScsiInfo, getSiteInfo, getSnapshotInfo, getSystemInfo, getVolumeInfo, getVolumeControllingServer, help, makePrimary, makeRemote, modifyAdminGroup, modifyAdminUser, modifyCluster, modifyGroup, modifyRemoteAssociation, modifySite, modifySnapshot, modifySnmpTrapTarget, modifyVolume, mountVolume, provisionVolume, rebalanceVip, recoverQuorum, removeVolume, resetSession, rollbackSnapshot, runDiagnostic, setDnsInfo, shutdownGroup, shutdownNsm, startManager, startVirtualManager, stopManager, stopVirtualManager, testCredentials, unassignVolume, utility, vssSnapshot, waitForUpdate

8.5March 20102

Added the following commands: clearVssVolumeFlags, getAlertLog,

getServerCapabilities, getServerVolumeInfo, getSupportInfo, removeSnapshotsetLicenseKey

9.0November 20103

Added the following commands: assignVolumeToServer,

clearAlertsPolicy, clearDnsInfo, clearEmailServerInfo, clearSnmpNotifyPolicy, clearSnmpServiceInfo, createEmailNotifyPolicy, createServer, createSnapshotSchedulecreateSnmpCommunityString, createSnmpTrapTarget, createSyslogNotifyPolicy, deleteEmailNotifyPolicy, deleteServer, deleteSnapshotSchedule, deleteSnmpCommunityString, deleteSnmpTrapTarget, deleteSyslogNotifyPolicy, getDnsInfogetEventLog, getNotificationPolicy, getServerInfo, getSnapshotScheduleInfo, getSnmpInfo, modifyEmailNotifyPolicy, modifyRemoteSnapshotSchedule, modifyServer, modifySnapshotSchedule, modifySnmpCommunityString, modifySyslogNotifyPolicy, setAlertsPolicy, setEmailServerInfo, setSnmpNotifyPolicy, setSnmpServiceInfo, startSnmpService, stopSnmpService, unassignVolumeToServer, waitForEvent

Added the following commands: getServerJobInfo9.5September 20114

DateEdition

Version

DescriptionSoftware

10.0November 20125

11.0September 20136

Added the following commands: clearADInfo, deleteAutoMountPolicy,

findADInfo, findFile, getADInfo, getAutoMountPolicy, modifyNSM, setADInfo, setAutoMountPolicy

Removed the following commands: AssignVolume (use AssignVolumeToServer instead); provisionVolume (functionality divided over CreateVolume, AssignVolumeToServer, ConnectVolume, and MountVolume)

Added the following commands: setSupportLogin, setTraceOff, setTraceOn

Updated the following commands: createVolume, makePrimary, makeRemote, modifyVolume

1 Overview

The LeftHand OS command-line interface (CLI, also referred to as CLIQ,) is built upon the API released with version 8.x. You can develop your own automation, scripting and management using the CLI.

For instructions about using the CLI, see the Syntax section. The Global parameters section describes functionality that applies to the entire CLI and includes

commands to customize global operations.

System Requirements

• Windows Server 2003 SP1

• Windows Server 2003 R2

• Windows Server 2008 R2, SP1, and SP2

• Windows XP SP2

• Windows Vista

• Windows 7

• Windows 8

• Windows Server 2012

• Windows Server 2012 R2

• 10 MB available space

Installing the CLI

Install the CLI from the Management Software DVD. The installation wizard automatically installs the CLI software to the following default location in Windows and sets the environment variable:

C:\Program Files\HP\StoreVirtual\CLI

Accessing the CLI

The CLI is installed on each StoreVirtual storage system and can be accessed by SSH. To log in, enter the storage system IP address and the designated port of 16022, as shown in the following example:

ssh –p 16022 -l <user> <storage system IP>

Concurrent CLI commands

No more than five concurrent commands from distinct users should be sent to a single storage system. Users can experience timeouts and performance declines with the sixth concurrent command. For example, CLI commands from users Sue, Bob, Jim, Alan, and Les can be received and serviced by a single storage system simultaneously. However, adding a sixth simultaneous command from Steve could result in a timeout or performance decline for any of the users.

More than five simultaneous commands can be achieved by distributing CLI sessions across each storage system in a management group. For example, in a three-node management group, six unique users can simultaneously send commands by distributing them as follows:

• Sue and Bob send commands to StorageSystem–1

• Jim and Alan send commands to StorageSystem–2

• Les and Steve send commands to StorageSystem–3

7

Global parameters

prompt=<true | false>

Some 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. The XML setting returns all output information as an XML document, allowing easier parsing of the result. There is no guarantee that newer versions of the API will preserve the same formatting in the default case. It is strongly discouraged to use this form of the CLI programmatically. Use the XML output type if the output must be parsed.

separator=<c>

Some CLI parameters comprise parameters for multiple operations. For example, when using the snapshotVolumes command, allows the user to specify simultaneous snapshots of multiple volumes. In this scenario, some parameters specify an ordered list that apply to each snapshot in succession:

description="This applies to snapshot1;This applies to snapshot2"

The default separator character is a semicolon (;). If a semicolon is used in the body of a parameter, you can use a different character as the separator (such as a comma).

Syntax

The CLI specifies parameters in the form of parameter=<parameter> (specification), rather than dictating a particular order (positional) notation.

Parameter ordering

The order of parameters is not specified. For example, the following are equivalent commands that perform the same task:

cliq deleteVolume volumeName=theVolume userName=user passWord=secret login=10.1.2.3

cliq deleteVolume login=10.1.2.3 passWord=secret userName=user

The method parameter may be optionally specified as "method=<command>":

cliq userName=user passWord=secret login=10.1.2.3 volumeName=theVolume method=deleteVolume

Case sensitivity

All commands and parameter names are case-insensitive. For example, createVolume, CreateVolume, and CREATEVOLUME are all the same command. 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 preserves the case specified by the caller, and imposes this on the newly created volume.

True/False

Any parameter that indicates true/false, may be specified as "1|0" or "true|false".

8 Overview

Command abbreviation

There is no command or parameter abbreviation in the CLI when scripted. All commands and parameter names must be fully specified. This is to prevent ambiguity in legacy scripts if new commands or parameters are added.

OS error code integration

The CLI maps error codes to reasonable OS status codes (status in Linux, ERRORLEVEL in DOS). Since these are limited to 0..255, some of the OS errors may have less granularity than the API error codes.

Composite commands

Some commands take multiple elements for the parameter value. In this case, the parameter is interpreted as an delimiter-separated ordered list. For example:

volumeName=volume1;volume2

login=10.0.1.2;10.1.2.3;10.2.3.4

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:

• KB—kilobytes (2^10)

• MB—megabytes (2^20)

• GB—gigabytes (2^30)

• TB—terabytes (2^40)

• PB—petabytes (2^50)

There is no default for size units; the units must be specified. These are defined as International System of Units (SI) for file storage (popular use).

For example, size:

• 10 MB—1,048,576 bytes

• 10 GB—10,737,418,240 bytes

Password prompt

When credentials are required in the CLI, you may not want to display the password by typing the "password=" parameter. If the username parameter is specified without the password parameter, you will be prompted interactively for the password. This password will not be displayed.

cliq getGroupInfo login=10.0.1.2 username=admin

password: *******

DNS names

You can specify a manager using a host name, provided it 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

Syntax 9

Command availability

When commands are available for both Windows and SSH, a command example is given for both. If a command is only available for Windows, a command example is given only for Windows.

Command line conventions

DescriptionSymbol

|

{ }

[ ]

italic

Used to separate input options. For example, { userName= passWord= | groupName= } means that you enter userName with the passWord or the groupName parameter.

Denotes a required parameter. For example, {login} must be specified.

Denotes an optional parameter. For example, [namePrefix] is an optional input.

Denotes a replaceable parameter. For example, Parameter volumeName is the name of the volume.

Integrated command shell

The CLI has an integrated shell that is executed by default when connecting directly to a storage system, or when running cliq.exe without any parameters:

CLIQ>

The integrated shell supports rich command line editing features specific to the HP StoreVirtual API. The following editing keys are supported:

TAB

MeaningKey

Moves the cursor one space to the left.LEFT

Moves the cursor one space to the right.RIGHT

Deletes the character under the cursor and moves the cursor to the left.BACKSPACE

Deletes the character under the cursor.DELETE

Recalls the previous command entered.UP

Recalls the first command entered.DOWN

Moves the cursor to the beginning of the line.HOME

Moves the cursor to the end of the line.END

Clears the current command line.ESCAPE

Toggles between insert mode (the default) and overwrite mode.INSERT

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 reverse). If the method is fully resolved, then parameters associated with that command will be proposed. The parameters

10 Overview

MeaningKey

suggested start with those required for the command, followed by optional parameters. No mutually exclusive parameters will be suggested.

!#

Return codes

All 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>

Success results are non-negative values, while negative values indicate an error. Many errors returned by LeftHand OS do not return ordinal values that can be conveniently mapped into an API and CLI return code. In all cases, the error description string is returned, but it is not feasible to return a sensible ordinate value (other than GaucheGeneralError) without parsing the description string.

Recalls the command from the previous command list by number (for example, !3 will recall the third command from the command list.

DescriptionOS StatusValueResult

Everything succeeded normally00CliqSuccess

11CliqNothingDone

Operation has succeeded, but nothing was done (the system was already in the requested state).

22CliqOperationPending

88CliqParameterIgnored

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.

Operation was cancelled or abandonded.33CliqOperationAbandoned

Operation found no objects.44CliqNothingFound

This snapshot was a part of the snapshot set.55CliqSnapshotSet

Warning: The writer operation failed.66CliqVssSnapshotWarning

Warning: Point in time snapshot is created.77CliqPITSnapshotWarning

The operation succeeded but a parameter was ignored as it is not applicable.

An unexpected error has occurred.1280x80001001CliqUnexpected

The XML given is not well-formed.1290x80001002CliqXmlError

The parameter is not specified correctly.1300x80001003CliqParameterFormat

A parameter is repeated.1310x80001004CliqParameterRepeat

The command method is missing.1320x80001005CliqMissingMethod

One or more expected parameters are missing.1330x80001006CliqMissingParameter

This command is unrecognized.1340x80001007CliqUnrecognizedCommand

This parameter is unrecognized.1350x80001008CliqUnrecognizedParameter

1360x80001009CliqIncompatibleParameters

Two or more parameters supplied are incompatible with each other.

Return codes 11

DescriptionOS StatusValueResult

1370x8000100ACliqNotYetImplemented

This is a legal command; it means it just has not been done yet.

Out of memory.1380x8000100BCliqNoMemory

Could not find the requested volume.1390x8000100CCliqVolumeNotFound

The requested volume is in use.1400x8000100DCliqVolumeInUse

Volume initialization failed.1410x8000100ECliqVolumeInitFailure

The volume is an unrecognized type.1420x8000100FCliqUnrecognizedVolume

General LeftHand OS error - the operation failed.1430x80001010CliqOperationFailed

The supplied credentials are incorrect.1440x80001011CliqCredentialsFailed

Invalid parameter.1450x80001012CliqInvalidParameter

Object not found.1460x80001013CliqObjectNotFound

Failed to connect to the API server.1470x80001014CliqConnectionFailure

Not enough space to complete the command.1480x80001015CliqNotEnoughSpace

Could not find a manager.1490x80001016CliqNoManager

Network socket error.1500x80001017CliqSocketError

Operation exceeded the specified timeout.1510x80001018CliqOperationTimedOut

1520x80001019CliqNoPlatformSupport

1530x8000101ACliqNoPlatformSupport

1560x8000101DCliqUtilityIllegalParameter

1570x8000101ECliqUtilityFailed

1590x80001020CliqIllegalUsername

This operating system type does not support the operation.

This operating system version does not support the operation.

The utility command requested was not found.1540x8000101BCliqUtilityNotFound

The utility command requested is not in the allowed list.1550x8000101CCliqUtilityNotAllowed

The utility command contains unsupported parameters or redirection.

The utility command executed, but returned a non-zero status code.

The specified storage system cannot be found.1580x8000101FCliqNodeNotFound

The username must be 3–40 characters, starting with a letter.

The password must be 5–40 characters, not / or :.1600x80001021CliqIllegalPassword

General file error.1610x80001022CliqFileError

No iSCSI initiator found.1620x80001023CliqMissingInitiator

The iSCSI initiator is not running.1630x80001024CliqInitiatorStopped

The version of LeftHand OS software must be upgraded.1640x80001025CliqSanIqTooOld

12 Overview

1650x80001026CliqDefaultAdmin

1680x80001029CliqVolumeNoSessions

You cannot delete, modify permissions, or remove the last user from the default administration group.

The HP StoreVirtual VSS Provider is not installed.1660x80001027CliqVssProviderNotInstalled

The HP StoreVirtual VSS Provider is not running.1670x80001028CliqVssProviderNotRunning

Cannot create an application-managed snapshot because there are no iSCSI connections associated with this volume. To create application-managed

DescriptionOS StatusValueResult

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.

1690x8000102ACliqVolumeMultipleSessions

1700x8000102BCliqNoVssCapabilities

1710x8000102CCliqServerUnresponsive

1720x8000102DCliqVssSnapshotFailed

1730x8000102ECliqVssLunInfoFailed

Cannot create an application-managed snapshot because there is more than one IQN (iSCSI Qualified Name) associated with this volume. To create application-managed snapshots, there must be only one application server associated with the volume.

Cannot create an application-managed snapshot because the server does not support this capability.

Cannot create an application-managed snapshot because the system could not communicate to the necessary software component on the application server.

Cannot create an application-managed snapshot because the system could not quiesce the application associated with this volume.

Cannot create an application-managed snapshot because the system failed to get LUN data.

The VSS writer operation failed.1740x8000102FCliqVssWriterUnavailable

Another app-managed snapshot is in progress.1750x80001030CliqSnapshotInProgress

The application server is busy.1760x80001031CliqWindowsServerIsBusy

This version of VSS provider must be upgraded.1770x80001032CliqUpdateVssProvider

VSS operation timed out.1780x80001033CliqVssOperationTimedOut

Volume connection failure.1790x80001034CliqVolumeConnectionFailure

Server is in Cluster and cannot be changed via CliQ.1800x80001035CliqServerInCluster

Volume error.1810x80001036CliqVolumeError

1820x80001037CliqVolumeNoServer

1880x8000103DCliqIllegalUserGroupName

1890x8000103ECliqIllegalUserDescription

1910x80001040CliqIllegalWWN

Failed to contact Application Aware Snapshot Manager.

This application is not supported.1830x80001038CliqUnsupportedApplication

Server version is not compatible.1840x80001039CliqServerVersionMismatch

The snapshot with this name already exists.1850x8000103ACliqSnapshotNameExists

Invalid volume set.1860x8000103BCliqVolumeInvalidSet

A Virtual Manager was not found.1870x8000103CCliqNoVirtualManager

User group name must be 3–40 characters a–z, 0–9,

- or .; the first character must be a lowercase letter (a-z).

Username must be 3–40 characters A–., a–z, 0–9, or .; the first character must be a letter (A–. or a-z).

IQN must be letters or numbers or the . or : characters.1900x8000103FCliqIllegalIQN

WWN must be 16 Hex letters or numbers (A-F, 0-9) or the : character.

HBA status error.1920x80001041CliqHbaError

HBA function not supported.1930x80001042CliqHbaNotSupported

HBA function, invalid handle.1940x80001043CliqHbaInvalidHandle

Return codes 13

DescriptionOS StatusValueResult

HBA function, bad argument.1950x80001044CliqHbaInvalidArgument

WWN not recognized.1960x80001045CliqHbaIllegalWWN

HBA function, Index not recognized.1970x80001046CliqHbaIllegalIndex

HBA function, larger buffer required.1980x80001047CliqHbaMoreData

1990x80001048CliqHbaStaleData

2050x8000104ECliqHbaInvalidLun

2060x8000104FCliqHbaIncompatible

2070x80001050CliqHbaAmbitiousWWN

2080x80001051CliqHbaLocalBus

2090x80001052CliqHbaLocalTarget

Information has changed since the last call to HBA.RefreshInformation.

SCSI Check Condition reported.2000x80001049CliqHbaScsiCheckCondition

Adapter busy or reserved, retry may be effective.2010x8000104ACliqHbaBusy

Request timed out, retry may be effective.2020x8000104BCliqHbaTryAgain

Referenced HBA has been removed or deactivated.2030x8000104CCliqHbaUnavailable

The requested ELS was rejected by the local adapter.2040x8000104DCliqHbaElsReject

The specified LUN is not provided by the specified adapter.

An incompatibility has been detected among the library and driver modules invoked which will cause one or more functions in the highest version that all support to operate incorrectly.

Multiple adapters have a matching WWN. This could occur if the NodeWWN of multiple adapters is identical.

A persistent binding request included a bad local SCSI bus number.

A persistent binding request included a bad local SCSI target number.

2100x80001053CliqHbaLocalLun

2110x80001054CliqHbaLocalScsiIdBound

2120x80001055CliqHbaTargetFcId

2130x80001056CliqHbaTargetNodeWWN

2140x80001057CliqHbaTargetPortWWN

2150x80001058CliqHbaTargetLun

2160x80001059CliqHbaTargetLuid

2170x8000105ACliqHbaNoSuchBinding

2180x8000105BCliqHbaNotTarget

2190x8000105CCliqHbaUnsupportedFc4

A persistent binding request included a bad local SCSI logical unit number.

A persistent binding set request included a local SCSI ID that was already bound.

A persistent binding request included a bad or unlocatable FCP Target FCID.

A persistent binding request included a bad FCP Target Node WWN.

A persistent binding request included a bad FCP Target Port WWN.

A persistent binding request included an FCP Logical Unit Number not defined by the identified Target.

A persistent binding request included an undefined or otherwise inaccessible Logical Unit Unique Identifier.

A persistent binding remove request included a binding which did not match a binding established by the specified port.

A SCSI command was requested to an Nx.Port that was not a SCSI Target Port.

A request was made concerning an unsupported FC-4 protocol.

14 Overview

DescriptionOS StatusValueResult

2200x8000105DCliqHbaIncapable

2210x8000105ECliqHbaTargetBusy

2220x8000105FCliqHbaNotLoaded

2230x80001060CliqHbaAlreadyLoaded

2240x80001061CliqHbaIllegalFcid

A request was made to enable unimplemented capabilities for a port.

A SCSI function was requested at a time when issuing the requested command would cause a SCSI overlapped command condition (see SAM-3).

A call was made to HBA.FreeLibrary when no library was loaded.

A call was made to HBA.LoadLibrary when a library was already loaded.

The Address Identifier specified in a call to HBA.SendRNIDV2 violates access control rules for that call.

SCSI device.2250x80001062CliqHbaAscsiDevice

Invalid protocol.2260x80001063CliqHbaInvalidProtocolType

Bad event type.2270x80001064CliqHbaBadEventType

An expected CIM property value was not found.2280x80001065CliqMissingCIMProperty

The requested feature or operation is not supported.2290x80001066CliqSANiQFeatureNotSupported

The '%s' parameter has been deprecated.2300x80001067CliqParameterDeprecated

Node must be in a management group.2310x80001068CliqNodeNotInGroup

The snapshot was not found.2320x80001069CliqRemoteSnapshotNotFound

Multiple IP addresses were encountered.2330x8000106ACliqMultipleIPAddresses

This command is not supported for Fibre Channel.2340x8000106BCliqUnsupportedFC

The volume is not mounted on a server.2350x8000106CCliqVolumeNotMounted

2360x8000106DCliqMissingADParameter

2370x8000106ECliqIncorrectADServer

2380x8000106FCliqLastAdminUser

2400x80001071CliqUnsupportedParameter

2420x80001073CliqCredentialsMissing

One or more Active Directory parameters entered are incorrect or missing.

The Active Directory server or possibly the BASEDN is incorrect or does not match.

You cannot delete the last user who is in a fully-permissioned group.

The attempted operation is not permitted.2390x80001070CliqOperationNotPermitted

A supplied parameter is unsupported on this management group.

The backup document file path is invalid.2410x80001072CliqVSSInvalidBackupDoc

Management group login credentials are not in the credential cache on the controlling server.

The requested size is too large.2430x80001074CliqSizeTooLarge

Return codes 15

2 Commands

addVirtualManager

Description

Add a virtual manager to a group.

Syntax

addVirtualManager {login=} { userName= passWord= | groupName= }

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

Example 1 Windows

cliq addVirtualManager login=10.0.1.2 userName=admin passWord=secret

Example 2 SSH

addVirtualManager

assignVolumeChap

Description

Assign a volume to a server. This assignment sets the access to a volume, using CHAP authentication.

Syntax

assignVolumeChap {login=} { userName= passWord= | groupName= } {volumeName=} {targetSecret=} [namePrefix=] [accessRights=] [chapName=] [initiatorSecret=] [vipLoadBalance=] [exclusiveAccess=]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.{passWord}

Parameters

{userName}

{groupName}

16 Commands

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

DescriptionName

{passWord}

[namePrefix]

[accessRights]

[chapName]

[vipLoadBalance]

[exclusiveAccess]

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

The CHAP target secret for the volume.{targetSecret}

A prefix string for newly created objects. A unique number value will be concatenated to this prefix to guarantee name uniqueness.

The access rights to the volume. Value are r—Read-only, x—No access, and rw—Read-write (default).

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

The CHAP initiator secret for the volume.[initiatorSecret]

Use VIP load balancing for this host. Values are 0—Disabled and 1—Enabled. The default value is 1.

Remove any previous server access rights to this volume. Values are 0—Disabled and 1—Enabled. The default value is 1.

Example 3 Windows

cliq assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret login=10.0.1.2 userName=admin passWord=secret

Example 4 SSH

assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret

assignVolumeToServer

Description

Assign a volume to a server (use for either iSCSI or Fibre Channel).

Syntax

assignVolumeToServer {login=} { userName= passWord= | groupName= } {volumeName=} {serverName=} [accessRights=] [transport=] [lun=]

Parameters

{userName}

{groupName}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

{passWord}

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

The name of the server.{serverName}

assignVolumeToServer 17

DescriptionName

[accessRights]

[transport]

[lun]

Example 5 Windows

cliq assignVolumeToServer volumeName=TheVolume serverName=TheServer login=10.0.1.2 userName=admin passWord=secret

Example 6 SSH

assignVolumeToServer volumeName=TheVolume serverName=TheServer

cacheCredentials

Description

Encrypt, cache, and associate the username/password with the management group name in the registry. Thereafter, the management group name can be used instead of the username/password for CLI command credentials. The credentials entered must have Full Administrator rights to the management group.

The access rights to the volume. Values are r—Read-only, x—No access, and rw—Read-write (default).

Set the communication path to iSCSI or Fibre Channel. Values are iSCSI and FC. Lowercase is accepted.

Set the LUN for the Fibre Channel attached volume. The value can be 1-255.

NOTE: LUN 255 is not supported by Microsoft Windows.

NOTE: This command will test to verify that the credentials entered have full administrative rights

to the management group. If the login (IP address) is not provided, it will try to discover the management group.

Syntax

cacheCredentials {userName=} {passWord=} {groupName=} [login=] [waitForData=]

Parameters

DescriptionName

The authentication user name for the storage system.{userName}

The password for the storage system.{passWord}

The name of the management group.{groupName}

The IP addresses or DNS-resolvable names of one or more storage systems.[login]

[waitForData]

The number of milliseconds to wait for the discovery packets (the default is 5000ms if unspecified). On Windows, the default wait time can be adjusted by setting the DWORD registry value HKLM\Software\HP\StoreVirtual\MaxDiscoverWaitTimeInSeconds.

18 Commands

Example 7 Windows

cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret

OR

cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret login=10.0.18.9

cancelRemoteSnapshot

Description

Cancel a remote snapshot.

Syntax

cancelRemoteSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 8 Windows

cliq cancelRemoteSnapshot snapshotName=TheSnapshot login=10.0.1.2 userName=admin passWord=secret

Example 9 SSH

cancelRemoteSnapshot snapshotName=TheSnapshot

clearAlertsPolicy

Description

Clear the Alerts and Events Policy information.

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.{snapshotName}

Syntax

clearAlertsPolicy {login=} { userName= passWord= | groupName= }

cancelRemoteSnapshot 19

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 10 Windows

cliq clearAlertsPolicy login=10.0.1.3 userName=admin passWord=secret

Example 11 SSH

clearAlertsPolicy

clearCredentials

Description

Remove the association between a username/password pair and a management group name from the registry cached credentials.

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Syntax

clearCredentials {groupName=}

Parameters

Example 12 Windows

cliq clearCredentials groupName=TheGroup

clearADInfo

Description

Remove the active directory configuration from the management group.

Syntax

clearADInfo {login=} { userName= passWord= | groupName= }

DescriptionName

The name of the management group.{groupName}

20 Commands

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 13 Windows

cliq clearADInfo login=10.0.1.3 userName=admin passWord=secret

Example 14 SSH

clearADInfo

clearDnsInfo

Description

Clear the DNS settings.

Syntax

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

clearDnsInfo {login=} { userName= passWord= | groupName= }

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

clearDnsInfo 21

Example 15 Windows

cliq clearDnsInfo login=10.0.1.3 userName=admin passWord=secret

Example 16 SSH

clearDnsInfo

clearEmailServerInfo

Description

Clear the email server settings.

Syntax

clearEmailServerInfo {login=} { userName= passWord= | groupName= }

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 17 Windows

cliq clearEmailServerInfo login=10.0.1.3 userName=admin passWord=secret

Example 18 SSH

clearEmailServerInfo

clearSnmpNotifyPolicy

Description

Clear the SNMP Notification Policy settings.

Syntax

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

clearSnmpNotifyPolicy {login=} { userName= passWord= | groupName= }

Parameters

{userName}

22 Commands

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

DescriptionName

{groupName}

{passWord}

Example 19 Windows

cliq clearSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secret

Example 20 SSH

clearSnmpNotifyPolicy

clearSnmpServiceInfo

Description

Clear the SNMP Server information.

Syntax

clearSnmpServiceInfo {login=} { userName= passWord= | groupName= }

Parameters

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

{userName}

{groupName}

{passWord}

Example 21 Windows

cliq clearSnmpServiceInfo login=10.0.1.3 userName=admin passWord=secret

Example 22 SSH

clearSnmpServiceInfo

clearVssVolumeFlags

Description

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Clear all volume shadow copy service (VSS) snapshot information from the disk. This command is only supported for Windows Server 2008 and higher.

Syntax

clearVssVolumeFlags {volumeName=}

clearSnmpServiceInfo 23

Parameters

DescriptionName

{volumeName}

Example 23 Windows

cliq clearVssVolumeFlags volumeName=x:

cloneSnapshot

Description

Create one or more SmartClone volumes from a StoreVirtual snapshot. These SmartClone volumes have all the functionality of normal volumes.

Syntax

cloneSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=} {volumeName=} [description=]

Parameters

The name of the locally attached storage device (for example, E:). This is not the name of the volume in the management group.

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 24 Windows

cliq cloneSnapshot snapshotName=Snapshot1 volumeName=MyClone1;MyClone2 login=10.0.1.2 userName=admin passWord=secret

Example 25 SSH

cloneSnapshot snapshotName=Snapshot1 volumeName=MyClone1;MyClone2

configureRaid

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.{snapshotName}

The name of the volume in the management group.{volumeName}

Optional description[description]

Description

Reconfigure the RAID setting on a storage system. The storage system cannot be in a management group.

24 Commands

Syntax

configureRaid {login=} { userName= passWord= | groupName= } {configuration=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

{configuration}

Example 26 Windows

cliq configureRaid configuration="RAID 10" login=10.0.1.2 userName=admin passWord=secret

Example 27 SSH

configureRaid configuration="RAID 10"

connectVolume

Description

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The RAID type to set. The possible RAID levels are reported with the getNsmInfo command.

Connect an already present array volume to an application server host (iSCSI only). For FibreChannel, this command will only poll the local volumes for up to 1 minute to detect when the volume is connected by the Windows PNP system.

Syntax

connectVolume {login=} { userName= passWord= | groupName= } {volumeName=} [initiatorport=] [persistent=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

connectVolume 25

DescriptionName

[initiatorport]

Example 28 Windows

cliq connectVolume volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret

convertSnapshotTempSpace

Description

Convert snapshot temporary space to a volume.

Syntax

convertSnapshotTempSpace {login=} { userName= passWord= | groupName= } {volumeName=} {snapshotName=}

Parameters

The iSCSI initiator IP outbound bind port number. If not specified, the default value is any unused IP port.

Automatically restore the iSCSI connection when the computer starts up.[persistent]

DescriptionName

{userName}

{groupName}

{passWord}

Example 29 Windows

cliq convertSnapshotTempSpace snapshotName=MySnapshot volumeName=NewVolume login=10.1.2.3 userName=admin passWord=secret

Example 30 SSH

convertSnapshotTempSpace snapshotName=MySnapshot volumeName=NewVolume

createAdminGroup

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

The name of the remote snapshot.{snapshotName}

Description

Create an administrative group.

Syntax

createAdminGroup {login=} { userName= passWord= | groupName= } {adminGroupName=} [description=] [adminUserName=] [permissions=] [adGroup=]

26 Commands

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[permissions]

Example 31 Windows

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The administrative group name.{adminGroupName}

Optional description[description]

Specifies the users that this group comprises.[adminUserName]

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), and f—Full-access (Report does not support this). An example is wwrr.

NOTE: If not specified, the permissions are set to rrrr.

The name of the associated active directory group.[adGroup]

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

Example 32 SSH

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

createAdminUser

Description

Create an administrative user.

Syntax

createAdminUser {login=} { userName= passWord= | groupName= } {adminUserName=} {adminPassWord=} [description=] {adminGroupName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

createAdminUser 27

DescriptionName

{groupName}

{passWord}

Example 33 Windows

cliq createAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user" adminUserName=user adminPassWord=secret adminGroupName="Full Administrator"

Example 34 SSH

createAdminUser description="My shiny new user" adminUserName=user adminPassWord=secret adminGroupName="Full Administrator"

createCluster

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Specifies the users that this group comprises.{adminUserName}

The password for the administrative user.{adminPassWord}

Optional description[description]

The administrative group name.{adminGroupName}

Description

Create a cluster in a management group.

Syntax

createCluster {login=} { userName= passWord= | groupName= } {clusterName=} {node=} [description=] [useVip=] [vip=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the cluster.{clusterName}

{node}

28 Commands

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

Optional description[description]

DescriptionName

Use virtual IP (VIP) addressing. Values are 0 or 1 (default).[useVip]

[vip]

Example 35 Windows

cliq createCluster login=10.0.1.3 userName=admin passWord=secret clusterName=TheCluster description="My shiny new cluster" useVip=1 node=10.1.2.4 vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0

Example 36 SSH

createCluster clusterName=TheCluster description="My shiny new cluster" useVip=1 node=10.1.2.4 vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0

createEmailNotifyPolicy

Description

Configure which level of events from the management group are sent via email to the designated recipients.

A delimited list of virtual IP address or DNS-resolvable name and subnet mask.

NOTE: Since each VIP contains two parameters, IP address and subnet

mask, both must be specified in order, even if empty. If multiple VIPs are entered, they must be on different subnets.

Syntax

createEmailNotifyPolicy {login=} { userName= passWord= | groupName= } {email=} [verbosity=] { alertOnInfo= | alertOnWarning= | alertOnCritical= } [emailLocale=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[verbosity]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The email address of the recipient.{email}

The level of returned information via email notification. Values are 1—Brief, 2—Standard, and 3—Verbose.

{alertOnInfo}

{alertOnWarning}

Values are 0—Email will not be sent on informational events, warning events, and critical events and 1—Email will be sent for informational events, warning events, and critical events. The default is 0 for createEmailNotifyPolicy. Either alertOnInfo, alertOnWarning, or alertOnCritical must be specified or the command will be rejected.

createEmailNotifyPolicy 29

{alertOnCritical}

Example 37 Windows

cliq createEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret email=myemail@myhost.com alertOnWarning=1

Example 38 SSH

createEmailNotifyPolicy email=myemail@myhost.com alertOnWarning=1

createGroup

Description

Create a new management group. This command may take several minutes to complete.

Syntax

createGroup {groupName=} {node=} {groupName=} {userName=} {passWord=}

Parameters

DescriptionName

English (default), Chinese, Japanese, Korean, Spanish[emailLocale]

{node}

Example 39 Windows

cliq createGroup groupName=TheGroup node=10.1.2.3;10.1.2.4 userName=admin passWord=secret

Example 40 SSH

createGroup groupName="MG2" node=10.1.2.3;10.1.2.4 userName=admin passWord=secret

createRemoteAssociation

Description

Create a remote group-to-primary group association. This association is done automatically when a remote snapshot is created, so this command is not usually needed.

DescriptionName

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

The name of the management group.{groupName}

The authentication user name for the storage system.{userName}

The password for the storage system.{passWord}

Syntax

createRemoteAssociation {login=} { userName= passWord= | groupName= } {remote=} [remoteUserName=] [remotePassWord=] [primaryBandwidth=] [remoteBandwidth=] [remotegroupname=]

30 Commands

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

{remote}

[primaryBandwidth]

[remoteBandwidth]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The IP address or DNS-resolvable names of one or more remote storage system.

The authentication user name for the remote group.[remoteUserName]

The password for the remote group.[remotePassWord]

The bandwidth used in a copy from the primary group to the remote group. Values are:

• Kb—Kilobits/sec (1000 Bits/second)

• Mb—Megabits/sec (1000 Kilobits/second)

• Gb—Gigabits/sec (1000 Megabits/second)

The bandwidth used in a copy from the remote group to the primary group. Values are:

• Kb—Kilobits/sec (1000 Bits/second)

• Mb—Megabits/sec (1000 Kilobits/second

• Gb—Gigabits/sec (1000 Megabits/second)

Example 41 Windows

cliq createRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin remotePassWord=secret primaryBandwidth=10Mb remoteBandwidth=10Mb

Example 42 SSH

createRemoteAssociation remote=10.0.1.3 remoteUserName=admin remotePassWord=secret primaryBandwidth=10Mb remoteBandwidth=10Mb

createRemoteSnapshot

Description

Create a remote snapshot of a StoreVirtual volume.

Syntax

createRemoteSnapshot {login=} { userName= passWord= | groupName= } {remote=} [remoteUserName=] [remotePassWord=] [remotegroupname=] {primarySnapshot=} {remoteCluster=} {remoteVolume=} {remoteSnapshot=} [description=] [primaryBandwidth=] [remoteBandwidth=]

The name of the remote management group.[remotegroupname]

createRemoteSnapshot 31

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

{remote}

[remotegroupname]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The IP address or DNS-resolvable names of one or more remote storage system

The authentication user name for the remote group.[remoteUserName]

The password for the remote group.[remotePassWord]

The name of the remote management group to identify cached credentials (from Authentication Console) to use instead of remoteUserName/remotePassWord parameters.

The name of the local snapshot to remote copy.{primarySnapshot}

The name of the remote cluster to host the remote volume.{remoteCluster}

The name of the remote volume to host the snapshot.{remoteVolume}

The name of the remote snapshot to create.{remoteSnapshot}

[primaryBandwidth]

[remoteBandwidth]

Optional description.[description]

The bandwidth used in a copy from the primary group to the remote group. Values are:

• Kb—Kilobits/sec (1000 Bits/second)

• Mb—Megabits/sec (1000 Kilobits/second)

• Gb—Gigabits/sec (1000 Megabits/second)

The bandwidth used in a copy from the remote group to the primary group. Values are:

• Kb—Kilobits/sec (1000 Bits/second)

• Mb—Megabits/sec (1000 Kilobits/second)

• Gb—Gigabits/sec (1000 Megabits/second)

32 Commands

Example 43 Windows

cliq createRemoteSnapshot login=10.1.2.3 userName=admin passWord=secret primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0 remoteVolume=Volume0 description="Exchange DB-1" remote=10.1.2.4 remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.21"

Example 44 SSH

createRemoteSnapshot primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0 remoteVolume=Volume0 description="Exchange DB-1" remote=10.1.2.4 remoteUserName=admin remotePassWord=secret remoteCluster="10.0.1.21"

createServer

Description

Create a representation of a client server in a management group. This “server” can be associated with iSCSI or Fibre Channel initiators and be granted access to volumes.

Syntax

createServer {login=} { userName= passWord= | groupName= } {serverName=} [description=] [allowiSCSIAccess=] [vipLoadBalance=] [useCHAP=] [initiator=] [targetSecret=] [chapName=] [initiatorSecret=] [controllingserver=] [allowfcaccess=] [wwpn=] [bootvolumelun=] [bootvolumename=]

Parameters

{userName}

{groupName}

{passWord}

[allowiSCSIAccess]

[vipLoadBalance]

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the server.{serverName}

Optional description[description]

Allow iSCSI access for this host. Values are 0—Disable and 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 Fibre Channel is NOT configured, the default will be 1, otherwise no default will be selected.

Use VIP load balancing for this host. Values are 0—Disabled and 1—Enabled. The default value is 1.

useCHAP

[initiator]

Use CHAP Authentication for this host. Values are 0—Disabled and 1—Enabled.

A semicolon delimited string of host IQNs. Valid characters are any letter, number, international character or the-, ., and : characters.

The CHAP target secret for the volume.targetSecret

createServer 33

DescriptionName

[chapName]

[controllingserver]

[allowfcaccess]

[wwpn]

[bootvolumelun]

[bootvolumename]

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

The CHAP initiator secret for the volume.[initiatorSecret]

Enter the IP address of the client server that has Application Aware Snapshot Manager (AASM) installed on it. It will coordinate the snapshot with the applications using SAN volumes. This is required for managed snapshots of Fibre Channel connected volumes. This is also required for VMware managed snapshots, enter the Virtual Center Server IP address.

Allow Fibre Channel ports to be assigned to the client. Values are 0—Disable and 1—Enable. If volumes are attached to a client server via Fibre Channel and a value of 0 is entered, the client will lose its ability to communicate with the attached volumes.

A semicolon delimited list of the unique World Wide Port Name for one or more Fibre Channel ports. Expected WWPN formatting is 16 Hex characters with or without the : character as a delimiter (for example, 20:21:00:0E:B3:01:AB:C6 or 2021000EB301ABC6). Lower case hex characters a–f are also accepted.

The LUN (1–255) of the boot volume. Valid only for a Fibre Channel attached volume. If present, then bootvolumename must also be specified.

NOTE: LUN 255 is not supported by Microsoft Windows.

The volume name of the boot volume. Valid only for a Fibre Channel attached volume. If present, then bootvolumelun must also be specified.

Example 45 Windows

cliq createServer serverName=TheServer useCHAP=0 initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.mynetworks.com login=10.0.1.2 userName=admin passWord=secret

Example 46 SSH

createServer serverName=TheServer useCHAP=0 initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.myworks.com

createSite

Description

Create a site in a multi-site SAN.

Syntax

createSite {login=} { userName= passWord= | groupName= } {siteName=} [description=] [primary=] [node=]

Parameters

DescriptionName

{userName}

34 Commands

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

DescriptionName

{groupName}

{passWord}

[primary]

[node]

Example 47 Windows

cliq createSite siteName=Headquarters login=10.0.1.2 userName=admin passWord=secret

Example 48 SSH

createSite siteName=Headquarters

createSnapshot

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the site.{siteName}

Optional description[description]

This site is the primary site. Values are 0—Disabled and 1—Enabled. 1 is the default.

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

Description

Create a snapshot of one or more StoreVirtual volumes.

Syntax

createSnapshot {login=} { userName= passWord= | groupName= } {volumeName=} {snapshotName=} [description=] [inheritAccess=] [managed=] [wait=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

[inheritAccess]

The name of the remote snapshot.{snapshotName}

Optional description[description]

Values are 0—The snapshot will not inherit the volume list, authentication group, ACL relationships of the original volume (default) and 1—The snapshot will inherit the volume list, authentication group, ACL relationships of the original volume.

createSnapshot 35

DescriptionName

[managed]

[wait]

Example 49 Windows

cliq createSnapshot volumeName=volume0;volume1 snapshotName=snapshot0;snapshot1 login=10.0.1.2 userName=admin passWord=secret

Example 50 SSH

createSnapshot volumeName=volume0;volume1 snapshotName=snapshot0;snapshot1

createSnapshotSchedule

Description

Create a local or remote snapshot schedule.

Syntax

Values are 0—The snapshot(s) will not attempt to use VSS on the host connected to the volume (default) and 1—The snapshot(s) will attempt to use VSS on the host connected to the volume.

Determines whether to wait for the application managed snapshot process to complete or not. Values are 0—Do not wait and 1—Wait for it to complete (default).

createSnapshotSchedule {login=} { userName= passWord= | groupName= } {volumeName=} {scheduleName=} {recurperiod=} {starttime=} [description=] [retentioncount=] [retentionseconds=] [remoteip=] [remoteUserName=] [remotePassWord=] [remoteCluster=] [remoteVolume=] [remoteretentioncount=] [remoteretentionseconds=] [managed=] [remotegroupname=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

The name of the schedule{scheduleName}

{recurperiod}

{starttime}

36 Commands

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

The start time of the schedule. Specified as ISO 8601. Format is YYYY-MM-DDTHH:MM:SSZ. YYYY represents the year, MM is the month, DD is the day of the month, HH is the hour in 24 hour format, MM is the minutes, SS is the seconds. The time must always be expressed in UTC time.

DescriptionName

Optional description[description]

[retentioncount]

[retentionseconds]

[remoteretentioncount]

[remoteretentionseconds]

[managed]

The number of snapshots to maintain. Must be between 1 and 50. Either retentioncount or retentionseconds must be specified.

How long snapshots should be retained. Either retentioncount or retentionseconds must be specified.

The IP address of the remote group.[remoteip]

The authentication user name for the remote group.[remoteUserName]

The password for the remote group.[remotePassWord]

The name of the remote cluster to host the remote volume.[remoteCluster]

The name of the remote volume to host the snapshot.[remoteVolume]

The number of remote snapshots to maintain. Must be between 1 and 50. Either remoteretentioncount or remoteretentionseconds must be specified.

How long remote snapshots should be retained. Either remoteretentioncount or remoteretentionseconds must be specified.

Values are 0—The snapshot(s) will not attempt to use VSS on the host connected to the volume (default) and 1—The snapshot(s) will attempt to use VSS on the host connected to the volume.

The name of the remote management group.[remotegroupname]

Example 51 Windows

cliq createSnapshotSchedule scheduleName="schedule0" description="First snapshot schedule" starttime="2007-06-15T01:01:00Z" recurperiod="3600" volumeName="volume0" remoteVolume="volume0" retentioncount=5 login="10.0.1.3" userName="admin" passWord="secret"

Example 52 SSH

createSnapshotSchedule scheduleName="schedule0" description="First snapshot schedule" starttime="2007-06-15T01:01:00Z" recurperiod="3600" volumeName="volume0" remoteVolume="volume0" retentioncount=5"

createSnmpCommunityString

Description

Create 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 the IP address (IP address or host name) or an IP mask and IP subnet.

Syntax

createSnmpCommunityString {login=} { userName= passWord= | groupName= } [communityString=] [ipAddress=] [ipMask=] [ipSubnet=]

createSnmpCommunityString 37

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The SNMP community string.{communityString}

The IP address or host name of the SNMP server.[ipAddress]

An IP address mask for SNMP notification.[ipMask]

An IP address subnet for SNMP notification.[ipSubnet]

Example 53 Windows

cliq createSnmpCommunityString login=10.0.1.3 userName=admin passWord=secret ipAddress=10.0.10.25 communityString=NewString

Example 54 SSH

createSnmpCommunityString ipAddress=10.0.10.25 communityString=NewString

createSnmpTrapTarget

Description

Create an SNMP Trap Target. The Community String must be the same for all Trap Targets. If no Trap Targets exists, the Community String is used, otherwise it is ignored and the Community String of existing Trap Targets is used.

Syntax

createSnmpTrapTarget {login=} { userName= passWord= | groupName= } {ipAddress=} {version=} {communityString=}

Parameters

{userName}

{groupName}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

{passWord}

38 Commands

The password for the storage system. Required when the userName parameter is used.

The IP address or host name of the SNMP server.{ipAddress}

Example 55 Windows

cliq createSnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret ipAddress=10.0.10.25 version=1 communityString=TrapString

Example 56 SSH

createSnmpTrapTarget ipAddress=10.0.10.25 version=1 communityString=TrapString

createSyslogNotifyPolicy

Description

Create a Syslog Notification Policy.

Syntax

createSyslogNotifyPolicy {login=} { userName= passWord= | groupName= } {ipAddress=} { alertOnInfo= | alertOnWarning= | alertOnCritical= }

DescriptionName

The SNMP Version. Values are 1—Version 1 and 2—Version 2.{version}

The SNMP community string.{communityString}

Parameters

{userName}

{groupName}

{passWord}

{alertOnInfo}

{alertOnWarning}

{alertOnCritical}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The IP address or host name of the Syslog server.{ipAddress}

Values are 0—The log does not include informational events, warning events, and critical events and 1—The log includes informational events, warning events, and critical events. The default is 0 for createSyslogNotifyPolicy. Either alertOnInfo, alertOnWarning, or alertOnCritical must be specified or the command will be rejected.

createSyslogNotifyPolicy 39

Example 57 Windows

cliq createSyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ipAddress="10.0.10.25" alertOnCritical="1" alertOnWarning=1

Example 58 SSH

createSyslogNotifyPolicy ipAddress="10.0.10.25" alertOnCritical="1" alertOnWarning=1

createVolume

Description

Create a SAN volume without connecting to a host.

CAUTION: Enabling checksums may impact volume I/O performance.

Syntax

createVolume {login=} { userName= passWord= | groupName= } {volumeName=} {clusterName=} {size=} [description=] [replication=] [parity=] [checkSum=] [thinProvision=] [adaptiveOptimization=]

Parameters

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

The name of the cluster.{clusterName}

The size of the volume, with units specified:{size}

• <n>KB – n Kilobytes (1024 bytes)

• <n>MB – n Megabytes (1024 Kilobytes)

• <n>GB – n Gigabytes (1024 Megabytes)

• <n>TB – n Terabytes (1024 Gigabytes)

• <n>PB – n Petabytes (1024 Terabytes)

[parity]

40 Commands

Optional description[description]

The replication level for the volume. Values are 1, 2, 3, and 4.[replication]

The number of parity storage systems for the data on this volume. 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)

DescriptionName

• 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]

[thinProvision]

[adaptiveOptimization]

Example 59 Windows

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

Example 60 SSH

createVolume volumeName=MyVolume clusterName=TheCluster size=100GB description="Exchange DB-1"

deleteAdminGroup

Description

Delete an administrative group.

Values are 0—The volume does not use checksums and 1—The volume uses checksums.

Enable or disable thin provisioning. Values are 0—The volume does not use thin provisioning and 1—The volume is thin-provisioned (in a thinly provisioned volume, reserve may be < length).

Enable or disable adaptive optimization. Values are 0—Disable and 1—Enable. 1 is the default.

Syntax

deleteAdminGroup {login=} { userName= passWord= | groupName= } {adminGroupName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The administrative group name.{adminGroupName}

deleteAdminGroup 41

Example 61 Windows

cliq deleteAdminGroup login=10.0.1.3 userName=admin passWord=secret adminGroupName=powerusers

Example 62 SSH

deleteAdminGroup adminGroupName=powerusers

deleteAdminUser

Description

Delete an administrative user. The last administrator user ID of the default administrative group cannot be removed.

Syntax

deleteAdminUser {login=} { userName= passWord= | groupName= } {adminUserName=}

Parameters

DescriptionName

{userName}

{groupName}

{passWord}

Example 63 Windows

cliq deleteAdminUser login=10.0.1.3 userName=admin passWord=secret adminUserName=user

Example 64 SSH

deleteAdminUser adminUserName=user

deleteAutoMountPolicy

Description

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Specifies the users that this group comprises.{adminUserName}

Delete the auto-mount policy for the HP StoreVirtual Recovery Manager application on this computer.

Syntax

deleteAutoMountPolicy [groupName=] [volumeName=]

42 Commands

Parameters

Example 65 Windows

cliq deleteAutoMountPolicy groupName="MG2" volumeName="Vol1"

deleteCluster

Description

Delete a cluster. All storage systems are removed.

Syntax

deleteCluster {login=} { userName= passWord= | groupName= } {clusterName=}

Parameters

DescriptionName

The name of the management group.[groupName]

The name of the volume in the management group.[volumeName]

DescriptionName

{userName}

{groupName}

{passWord}

Example 66 Windows

cliq deleteCluster clusterName=TheCluster login=10.1.2.3 userName=admin passWord=secret

Example 67 SSH

deleteCluster clusterName=TheCluster

deleteEmailNotifyPolicy

Description

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the cluster.{clusterName}

Delete an Email Notification Policy. The designated recipient will no longer receive emails from management group alerts.

Syntax

deleteEmailNotifyPolicy {login=} { userName= passWord= | groupName= } {email=}

deleteCluster 43

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 68 Windows

cliq deleteEmailNotifyPolicy email=myemail@myhost.com login=10.1.2.3 userName=admin passWord=secret

Example 69 SSH

deleteEmailNotifyPolicy email=myemail@myhost.com

deleteGroup

Description

Delete a management group. All storage systems are removed.

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The email address of the recipient.{email}

CAUTION:

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

deleteGroup {login=} {userName=} {passWord=} {groupName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system.{userName}

The password for the storage system.{passWord}

The name of the management group.{groupName}

44 Commands

Example 70 Windows

cliq deleteGroup login=10.1.2.3 userName=admin passWord=secret groupName="MG2"

Example 71 SSH

deleteGroup groupName="MG2"

deleteRemoteAssociation

Description

Delete a remote group to primary group association.

Syntax

deleteRemoteAssociation {login=} { userName= passWord= | groupName= } {remote=} [remoteUserName=] [remotePassWord=] [remotegroupname]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

{remote}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The IP address or DNS-resolvable names of one or more remote storage system.

The authentication user name for the remote group.[remoteUserName]

The password for the remote group.[remotePassWord]

The name of the remote management group.[remotegroupname]

deleteRemoteAssociation 45

Example 72 Windows

cliq deleteRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin remotePassWord=secret

Example 73 SSH

deleteRemoteAssociation remote=10.0.1.3 remoteUserName=admin remotePassWord=secret

deleteServer

Description

Delete a server.

CAUTION:

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

deleteServer {login=} { userName= passWord= | groupName= } {serverName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 74 Windows

cliq deleteServer serverName=MyServer login=10.1.2.3 userName=admin passWord=secret

Example 75 SSH

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the server.{serverName}

deleteServer serverName=MyServer

deleteSite

Description

Delete a site in a multi-site SAN.

46 Commands

Syntax

deleteSite {login=} { userName= passWord= | groupName= } {siteName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 76 Windows

cliq deleteSite siteName=Headquarters login=10.1.2.3 userName=admin passWord=secret

Example 77 SSH

deleteSite siteName=Headquarters

deleteSnapshot

Description

Delete a snapshot.

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the site.{siteName}

CAUTION:

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

deleteSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

deleteSnapshot 47

DescriptionName

{passWord}

Example 78 Windows

cliq deleteSnapshot snapshotName=Snapshot0 login=10.1.2.3 userName=admin passWord=secret

Example 79 SSH

deleteSnapshot snapshotName=Snapshot0

deleteSnapshotSchedule

Description

Delete a previously created snapshot schedule.

Syntax

deleteSnapshotSchedule {login=} { userName= passWord= | groupName= } {scheduleName=}

Parameters

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.{snapshotName}

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the schedule.{scheduleName}

48 Commands

Example 80 Windows

cliq deleteSnapshotSchedule scheduleName="Exchange Backup" login=10.1.2.3 userName=admin passWord=secret

Example 81 SSH

deleteSnapshotSchedule scheduleName="Exchange Backup"

deleteSnapshotTempSpace

Description

Delete the snapshot temporary space.

CAUTION:

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

deleteSnapshotTempSpace {login=} { userName= passWord= | groupName= } {snapshotName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 82 Windows

cliq deleteSnapshotTempSpace snapshotName=TheSnapshot login=10.1.2.3 userName=admin passWord=secret

Example 83 SSH

deleteSnapshotTempSpace snapshotName=TheSnapshot

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.{snapshotName}

deleteSnmpCommunityString

Description

Delete an SNMP CommunityString. Either specify an IP address (as IP address or host name) or IP mask and IP subnet.

deleteSnapshotTempSpace 49

Syntax

deleteSnmpCommunityString {login=} { userName= passWord= | groupName= } [ipAddress=] [ipMask=] [ipSubnet=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 84 Windows

cliq deleteSnmpCommunityString ipAddress=10.0.10.25 login=10.1.2.3 userName=admin passWord=secret

Example 85 SSH

deleteSnmpCommunityString ipAddress=10.0.10.25

deleteSnmpTrapTarget

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

This is the IP address or host name of the SNMP server.[ipAddress]

An IP address mask for SNMP notification.[ipMask]

An IP address subnet for SNMP notification.[ipSubnet]

Description

Delete an SNMP trap target.

Syntax

deleteSnmpTrapTarget {login=} { userName= passWord= | groupName= } {ipAddress=} {version=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

50 Commands

Example 86 Windows

cliq deleteSnmpTrapTarget ipAddress=10.10.10.25 login=10.1.2.3 userName=admin passWord=secret version=2

Example 87 SSH

deleteSnmpTrapTarget ipAddress=10.10.10.25 version=2

deleteSyslogNotifyPolicy

Description

Delete a Syslog Notification Policy.

Syntax

deleteSyslogNotifyPolicy {login=} { userName= passWord= | groupName= } {ipAddress=}

DescriptionName

This is the IP address or host name of the SNMP server.{ipAddress}

The SNMP version. Values are 1—Version 1 and 2—Version 2.{version}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 88 Windows

cliq deleteSyslogNotifyPolicy ipAddress=10.10.10.25 login=10.1.2.3 userName=admin passWord=secret

Example 89 SSH

deleteSyslogNotifyPolicy ipAddress=10.10.10.25

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

This is the IP address or host name of the Syslog server.{ipAddress}

deleteVirtualManager

Description

Delete a virtual manager from a group.

Syntax

deleteVirtualManager {login=} { userName= passWord= | groupName= }

deleteSyslogNotifyPolicy 51

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 90 Windows

cliq deleteVirtualManager login=10.1.2.3 userName=admin passWord=secret

Example 91 SSH

deleteVirtualManager

deleteVolume

Description

This command forcibly deletes a StoreVirtual volume without disconnecting from the host.

CAUTION:

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

deleteVolume {login=} { userName= passWord= | groupName= } {volumeName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

52 Commands

The name of the volume in the management group.{volumeName}

Example 92 Windows

cliq deleteVolume volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret

Example 93 SSH

deleteVolume volumeName=MyVolume

disconnectLocalVolume

Description

Disconnect a StoreVirtual volume from the host. This command is only supported for iSCSI.

Syntax

disconnectLocalVolume {volumeName=}

Parameters

DescriptionName

The drive letter or mount point on the host for the volume.{volumeName}

Example 94 Windows

cliq disconnectLocalVolume volumeName=z:

discoverTcp

Description

Discover storage systems and management groups on the network, using TCP.

Syntax

discoverTCP {node=} [groupOrder=] [receivePort=] [waitForData=]

Parameters

{node}

[groupOrder]

[receivePort]

DescriptionName

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

Return storage systems ordered by group membership. Values are 0—Default or 1.

The TCP port to receive the discovery packets (defaults to an unused port if unspecified).

[waitForData]

The number of milliseconds to wait for the discovery packets (the default is 5000ms if unspecified). On Windows, the default wait time can be adjusted by setting the DWORD registry value in HKLM\Software\HP\StoreVirtual\MaxDiscoverWaitTimeInSeconds.

disconnectLocalVolume 53

Example 95 Windows

cliq discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4

Example 96 SSH

discoverTCP groupOrder=1 node=10.1.2.3;10.1.2.4

discoverUdp

Description

Discover storage systems and management groups on the network, using UDP.

Syntax

discoverUdp {ipMask=} {ipSubnet=} [groupOrder=] [receivePort=] [waitForData=]

Parameters

DescriptionName

An IP address mask for SNMP notification.{ipMask}

An IP address subnet for SNMP notification.{ipSubnet}

[groupOrder]

[receivePort]

[waitForData]

Example 97 Windows

cliq discoverUdp ipMask=255.255.240.0 ipSubnet=10.0.0.0

Example 98 SSH

discoverUdp ipMask=255.255.240.0 ipSubnet=10.0.0.0

dismountVolume

Description

Dismount the volume.

Syntax

Return storage systems ordered by group membership. Values are 0—Default or 1.

The TCP port to receive the discovery packets (defaults to an unused port if unspecified).

The number of milliseconds to wait for the discovery packets (the default is 5000ms if unspecified). On Windows, the default wait time can be adjusted by setting the DWORD registry value in

HKLM\Software\HP\StoreVirtual\MaxDiscoverWaitTimeInSeconds.

dismountVolume {mountPoint=}

Parameters

54 Commands

DescriptionName

The drive letter or mount point on the host for the volume.{mountPoint}

Example 99 Windows

cliq dismountVolume mountPoint="c:\hp storevirtual recovery snapshots\bbmg1\clvol-01_sch_ss_1.1271"

Example 100 SSH

dismountVolume mountPoint="I:"

findADInfo

Description

Query the management group for information about the associated AD domain.

Syntax

findADInfo {login=} { userName= passWord= | groupName= } [hostName=] [adUserName=] [ldaps=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[hostName]

[adUserName]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name or IP address of an active directory server. When you specify host name in the query, BASEDN is returned for this server. The name must be specified in the following format: ldap://10.10.10.10.

An active directory user name. When you specify it, a list of active directory groups that the user belongs to is returned.

Use a secure LDAP connection. Set it to false to change; the default is true.[ldaps]

findADInfo 55

Example 101 Windows

CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 hostname=ldap://10.21.66.9 HP StoreVirtual Command Line Interface, v10.0.0.1 (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P.

RESPONSE result 0 processingTime 4044 name CliqSuccess memoryUsage 838317 description Operation succeeded.

INFO basedn DC=win8dom,DC=com

cliq>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 hostname=ldap://10.21.66.91 ldaps=1 HP StoreVirtual Command Line Interface, v10.0.0.1 (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P.

RESPONSE result 0 processingTime 4776 name CliqSuccess memoryUsage 838981 description Operation succeeded.

INFO basedn DC=win8dom,DC=com

CLIQ>findadinfo login=10.01.72.3 username=joeuser password=abcd1234 adusername=dtest@win8dom.com HP StoreVirtual Command Line Interface, v10.0.0.1 (C) Copyright 2007-2012 Hewlett-Packard Development Company, L.P. RESPONSE result 0 processingTime 3971 name CliqSuccess memoryUsage 837947 description Operation succeeded.

GROUP name group_1-1-1

GROUP name SANFull

getADInfo

Description

Get the current active directory configuration of the management group.

Syntax

getADInfo {login=} { userName= passWord= | groupName= }

Parameters

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

56 Commands

Response

INFO ...

DescriptionName

This section contains active directory information.INFO

Example 102 Windows

RESPONSE result 0 processingTime 13556 name CliqSuccess memoryUsage 835357 description Operation succeeded

INFO userContext configValid true bindUser win8bind@win8dom.com baseDN DC=win8dom,DC=com adServer ldap://10.21.66.91/

getAlertLog

Description

This command returns Alerts.log information.

Syntax

getAlertLog {login=} { userName= passWord= | groupName= } [logFile]

Parameters

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the local file used to store the returned information.[logFile]

getAlertLog 57

Example 103 Windows

cliq getAlertLog login=10.1.2.3 userName=admin passWord=secret

OR

cliq getAlertLog

getAutoMountPolicy

Description

Get all of the auto-mount policies defined for the HP StoreVirtual Recovery Manager application on this computer.

Syntax

getAutoMountPolicy

Parameters

None

Example 104 Windows

cliq getAutoMountPolicy

getClusterInfo

Description

This command returns information about a cluster.

Syntax

getClusterInfo {login=} { userName= passWord= | groupName= } [clusterName=] [searchDepth=] [verbose=]

Parameters

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

[searchDepth]

[verbose]

58 Commands

The name of the cluster.[clusterName]

Defines the types of objects to inspect. Values are 1—Clusters only, 2—Clusters and volumes, 3—Clusters, volumes and snapshots, and 4—Clusters, volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take.

Determines how much information to return. Values are 0—Get summary information only (better performance) and 1—Get all information (better information; default). The greater the verbose number, the longer the call can take.

Response Syntax

CLUSTER ... NSM ... VIP ... VOLUME ...

DescriptionName

This section cluster contains information.CLUSTER

This section contains storage system information.NSM

This section contains VIP information.VIP

This section contains volume information.VOLUME

Example 105 Windows

cliq getClusterInfo clusterName=Cluster0 login=10.1.2.3 userName=admin passWord=secret

Example 106 SSH

getClusterInfo clusterName=Cluster0

getDnsInfo

Description

Get the DNS settings.

Syntax

getDnsInfo {login=} { userName= passWord= | groupName= }

Parameters

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Response Syntax

DNSINFO ...

DescriptionName

This section contains DNS information.DNSINFO

getDnsInfo 59

Example 107 Windows

cliq getDnsInfo login=10.0.1.3 userName=admin passWord=secret

Example 108 SSH

getDnsInfo

getEventLog

Description

Get event information.

Syntax

getEventLog {login=} { userName= passWord= | groupName= } [type=] [format=] [report=] [time=] [component=] [severity=] [object=] [system=] [source=] [user=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[type]

[object]

[system]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Event type. Values are AllAlerts, AllEvents, GlobalAlerts, GlobalEvents, LocalAlerts, and LocalEvents.

Output format. Values are Remote, Client, and Xml.[format]

Output verbosity. Values are Brief, Standard, and Verbose.[report]

Time filter. The format is YYYYMMDDhhmmss:YYYYMMDDhhmmss.[time]

Component filter. Values are Saniq, Hal, and Sys.[component]

Severity filter. Values are Info, Warning, and Critical.[severity]

Object filter. Values are MgmtGroup, RemoteMgmtGroup, Cluster, Manager, VirtualManager, Store, SnapshotSchedule, Volume, and Snapshot.

System filter. Values are System, Controller, Cache, Disk, Boot, Backplane, Fan, Temperature, Voltage, PowerSupply, and RAID.

60 Commands

Source filter, source name[source]

The name of the administrative user.[user]

Example 109 Windows

cliq getEventLog login=10.1.2.3 userName=admin passWord=secret type=AllEvents format=XML component=Saniq severity=warning;Critical object=Cluster system=System;Disk

Example 110 SSH

getEventLog type=AllEvents format=XML component=Saniq severity=warning;Critical object=Cluster system=System;Disk

getGroupInfo

Description

Get information about a management group.

Syntax

getGroupInfo {login=} { userName= passWord= | groupName= } [searchDepth=] [verbose=]

Parameters

DescriptionName

{userName}

{groupName}

{passWord}

[searchDepth]

[verbose]

Response Syntax

GROUP ... ALERTANDEVENTPOLICY ... EMAILNOTIFYPOLICY ... EMAILSERVERINFO ... SNMPSERVICEPOLICY ... SNMPNOTIFICATIONPOLICY ... SNMPCOMMUNITYSTRING ... SNMPTRAPTARGET ... FIBRECHANNEL ... DNSINFO ... NSM ... CUSTOMERINFO ...

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Defines which objects to inspect. Values are 1—Groups only, 2—Groups and clusters, 3—Groups, clusters and volumes, 4—Groups, clusters, volumes and snapshots, and 5—Groups, clusters, volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take.

Determines how much information to return. Values are 0—Get summary information only (better performance), and 1—Get all information (better information; default). The greater the verbose number, the longer the call can take.

getGroupInfo 61

SERVERAPPLICATION ... CLIENTAPPLICATION ... REMOTEASSOCIATION ... ADMINGROUP ... CLUSTER ...

DescriptionName

This section contains group information.GROUP

This section contains alert and event policy information.ALERTANDEVENTPOLICY

This section contains email notification policy information.EMAILNOTIFYPOLICY

This section contains email server information.EMAILSERVERINFO

This section contains SNMP service policy information.SNMPSERVICEPOLICY

This section contains SNMP notification policy information.SNMPNOTIFICATIONPOLICY

This section contains SNMP community string information.SNMPCOMMUNITYSTRING

This section contains SNMP trap target information.SNMPTRAPTARGET

This section contains Fibre Channel information.FIBRECHANNEL

This section contains DNS information.DNSINFO

This section contains storage system information.NSM

Example 111 Windows

cliq getGroupInfo login=10.1.2.3 userName=admin passWord=secret

Example 112 SSH

getGroupInfo

getLocalVolumes

Description

Get information about connected volumes hosted by the HP StoreVirtual storage system.

Syntax

This section contains customer information.CUSTOMERINFO

This section contains server application information.SERVERAPPLICATION

This section contains client application information.CLIENTAPPLICATION

This section contains remote association information.REMOTEASSOCIATION

This section contains admin group information.ADMINGROUP

This section cluster contains information.CLUSTER

getLocalVolumes [searchDepth=]

Parameters

[searchDepth]

62 Commands

DescriptionName

Determines the amount of information to obtain. Values are 0—Get locally mounted StoreVirtual volumes and snapshots and 1—Get additional information about associated volumes or VSS volume sets (default).

Example 113 Windows

cliq getLocalVolumes

getNotificationPolicy

Description

Get information about the Alerts and Events Policy, Email Notification Policy, Syslog Notification Policy, and Email Server Setting.

Syntax

getNotificationPolicy {login=} { userName= passWord= | groupName= }

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 114 Windows

cliq getNotificationPolicy login=10.1.2.3 userName=admin passWord=secret

Example 115 SSH

getNotificationPolicy

getNsmInfo

Description

Get information about a storage system.

Syntax

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

getNsmInfo {login=} { userName= passWord= | groupName= }

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

getNotificationPolicy 63

DescriptionName

{groupName}

{passWord}

Response Syntax

NSM ... FIBRECHANNEL ... NIC ... BONDTYPE ... GOSSIPADDRESS ... RAIDSETTING ...

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

DescriptionName

This section contains storage system information.NSM

This section contains Fibre Channel information.FIBRECHANNEL

This section contains NIC information.NIC

This section contains supported bond type information.BONDTYPE

Example 116 Windows

cliq getNsmInfo login=10.1.2.3 userName=admin passWord=secret

Example 117 SSH

getNsmInfo

getNsmLogs

Description

This command gathers all log files from a storage system and stores the archive locally.

Syntax

getNsmLogs {login=} { userName= passWord= | groupName= } {logFile=}

Parameters

This section contains gossip address information.GOSSIPADDRESS

This section contains supported RAID type information.RAIDSETTING

DescriptionName

{userName}

{groupName}

64 Commands

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

DescriptionName

{passWord}

Example 118 Windows

cliq getNsmLogs login=10.1.2.3 userName=admin passWord=secret logFile=c:\logs.tar.gz

getPerformanceStats

Description

Get performance monitoring statistics.

Syntax

getPerformanceStats {login=} { userName= passWord= | groupName= } [interval=]

Parameters

The password for the storage system. Required when the userName parameter is used.

The name of the local file used to store the returned information.{logFile}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[interval]

Example 119 Windows

cliq getPerformanceStats login=10.1.2.3 userName=admin passWord=secret

Example 120 SSH

getPerformanceStats

getRemoteSnapshotInfo

Description

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The interval in between counter sampling in milliseconds. Defaults to 6000.

NOTE: Because the internal sampling frequency is 6 seconds, it is not

recommended to set this value to less than 6000.

Get information about remote snapshots.

Syntax

getRemoteSnapshotInfo {login=} { userName= passWord= | groupName= } [snapshotName=] [verbose=]

getPerformanceStats 65

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[verbose]

Response Syntax

REMOTESNAPSHOT...

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.[snapshotName]

Determines how much information to return. Values are 0—Get summary information only (better performance), and 1—Get all information (better information; default). The greater the verbose number, the longer the call can take.

DescriptionName

This section contains remote snapshot information.REMOTESNAPSHOT

Example 121 Windows

cliq getRemoteSnapshotInfo snapshotName=TheSnapshot login=10.1.2.3 userName=admin passWord=secret

Example 122 SSH

getRemoteSnapshotInfo snapshotName=TheSnapshot

getScsiInfo

Description

Get SCSI inquiry information about a locally connected volume.

Syntax

getScsiInfo {volumeName=}

Parameters

{volumeName}

DescriptionName

The name of the locally attached storage device (for example, E:). This is not the name of the volume in the management group.

66 Commands

Example 123 Windows

cliq getScsiInfo volumeName=z:

getServerCapabilities

Description

Interrogate a Windows server for its HP StoreVirtual integration capabilities. If this call succeeds, the actual capabilities will be returned. For anticipated future releases, this may also include information about virtual machine hosting (VMware, Citrix, Hyper-V), and Server information.

NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target

Windows server for this call to succeed.

Syntax

getServerCapabilities {serverIp=}

Parameters

DescriptionName

The Windows server IP address.{serverIp}

Example 124 Windows

cliq getServerCapabilities serverIp=10.0.1.2

Example 125 SSH

getServerCapabilities serverIp=10.0.1.2

getServerInfo

Description

This will return information about server configurations in the management group, which contain permission settings for application servers to connect to StoreVirtual volumes.

Syntax

getServerInfo {login=} { userName= passWord= | groupName= } [serverName=] [serverclustername=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

getServerCapabilities 67

DescriptionName

The name of the server.[serverName]

The name of the server cluster.[serverclustername]

Response Syntax

SERVER ... VOLUME ...

DescriptionName

This section contains server information.SERVER

This section contains volume information.VOLUME

Example 126 Windows

cliq getServerInfo login=10.0.1.2 userName=admin passWord=secret

Example 127 SSH

getServerInfo

getServerJobInfo

Description

Display information about completed and running HP StoreVirtual Application Managed Snapshot snapshot jobs on a Windows Application Server.

NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target

Windows server for this call to succeed.

Syntax

getServerJobInfo {serverIp=} [jobId=] [volumeName=]

Parameters

Response Syntax

DescriptionName

The Windows server IP address.{serverIp}

Job ID[jobId]

The name of the volume in the management group.[volumeName]

response description="" name="" processingTime="" result="" job applicationIntegration="" description="" endTime=""

68 Commands

instanceID="" percentComplete="" result="" startTime="" status="" volumeName=""

response description Operation succeeded. name GaucheSuccess processingTime 1443 result 0 job applicationIntegration 1 description Operation succeeded. endTime 10:00:00 instanceID 1234 percentComplete 100 result 0 startTime 10:10:00 status Completed volumeName volume

DescriptionName

Command result descriptiondescription

Name of the CLIQ errorname

Processing timeprocessingTime

Result code for the CLI commandresult

The job datajob

Managed application type. Values are 0—VSS and 1—VMware.applicationIntegration

Job descriptiondescription

Time when the job is completedendTime

Instance IDinstanceID

Percent completepercentComplete

The result of the jobresult

The time the job was startedstartTime

The status of the jobstatus

The name of the volume in the management groupvolumeName

Example 128 Windows

cliq getServerJobInfo serverIp=1.2.3.4 jobId=1123

Example 129 SSH

getServerVolumeInfo

Description

This command returns information for StoreVirtual volumes attached to the target Windows application server.

getServerVolumeInfo 69

NOTE: HP StoreVirtual Application Aware Snapshot Manager must be installed on the target

Windows server for this call to succeed.

Syntax

getServerVolumeInfo {serverIp=} [searchDepth=]

Parameters

DescriptionName

The Windows server IP address.{serverIp}

[searchDepth]

Response Syntax

VOLUME ...

Example 130 Windows

cliq getServerVolumeInfo serverIp="10.0.1.45"

Example 131 SSH

getServerVolumeInfo serverIp="10.0.1.45"

getSiteInfo

Description

Defines which objects to inspect. Values are 1—Volumes only, 2—Volumes and snapshots, and 3—Volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take.

DescriptionName

This section contains volume information.VOLUME

Get site information on multi-site SANs.

Syntax

getSiteInfo {login=} { userName= passWord= | groupName= } [siteName=]

Parameters

{userName}

{groupName}

70 Commands

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

DescriptionName

{passWord}

The password for the storage system. Required when the userName parameter is used.

The name of the site.[siteName]

Response Syntax

SITE ... NSM ...

DescriptionName

This section contains site information.SITE

This section contains storage system information.NSM

Example 132 Windows

cliq getSiteInfo siteName=TheSite login=10.1.2.3 userName=admin passWord=secret

Example 133 SSH

getSiteInfo siteName=TheSite

getSnapshotInfo

Description

Get information about a snapshot.

Syntax

getSnapshotInfo {login=} { userName= passWord= | groupName= } [snapshotName=] [searchDepth=] [verbose=]

Parameters

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.[snapshotName]

getSnapshotInfo 71

DescriptionName

[searchDepth]

[verbose]

Response Syntax

SNAPSHOT ... STATUS ... SESSION ... PERMISSION ... REMOTESNAPSHOT ...

Defines which objects to inspect. Values are 1—Snapshots only and 2—Snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take.

Determines how much information to return. Values are 0—Get summary information only (better performance) and 1—Get all information (better information; default). The greater the verbose number, the longer the call can take.

DescriptionName

This section contains snapshot information.SNAPSHOT

This section contains status information.STATUS

This section contains session information.SESSION

This section contains permission information.PERMISSION

Example 134 Windows

cliq getSnapshotInfo snapshotName=TheSnapshot login=10.1.2.3 userName=admin passWord=secret

Example 135 SSH

getSnapshotInfo snapshotName=TheSnapshot

getSnapshotScheduleInfo

Description

Get information about snapshot schedules.

Syntax

getSnapshotScheduleInfo {login=} { userName= passWord= | groupName= } [scheduleName=]

Parameters

This section contains remote snapshot information.REMOTESNAPSHOT

DescriptionName

{userName}

72 Commands

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

DescriptionName

{groupName}

{passWord}

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the schedule.[scheduleName]

Response Syntax

SCHEDULE ...

DescriptionName

This section contains schedule information.SCHEDULE

Example 136 Windows

cliq getSnapshotScheduleInfo login=10.0.1.3 userName=admin passWord=secret

Example 137 SSH

getSnapshotScheduleInfo

getSnmpInfo

Description

Get information about the SNMP Service and Targets.

Syntax

getSnmpInfo {login=} { userName= passWord= | groupName= }

Parameters

{userName}

{groupName}

{passWord}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Response Syntax

SNMPSERVICEPOLICY ... SNMPNOTIFICATIONPOLICY ...

getSnmpInfo 73

SNMPCOMMUNITYSTRING ... SNMPTRAPTARGET ...

Example 138 Windows

cliq getSnmpInfo login=10.1.2.3 userName=admin passWord=secret

Example 139 SSH

getSnmpInfo

getSupportInfo

Description

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.

DescriptionName

This section contains SNMP service policy information.SNMPSERVICEPOLICY

This section contains SNMP notification policy information.SNMPNOTIFICATIONPOLICY

This section contains SNMP community string information.SNMPCOMMUNITYSTRING

This section contains SNMP trap target information.SNMPTRAPTARGET

Syntax

getSupportInfo {login=} { userName= passWord= | groupName= } [filepath=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[filepath]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The path to hold the final archive; if not specified, the current directory will be used.

Response Syntax

INFO ... FCADAPTER ...

74 Commands

Example 140 Windows

cliq getSupportInfo login=10.1.2.3 userName=admin passWord=secret filepath=c:\temp

getSystemInfo

Description

Get information about the StoreVirtual applications installed on the Windows application server.

Syntax

getSystemInfo

Parameters

None

Response Syntax

DescriptionName

This section contains active directory information.INFO

This section contains Fibre Channel adapter information.FCADAPTER

INFO ... FCADAPTER ...

Example 141 Windows

cliq getSystemInfo

getVolumeInfo

Description

Get information about a volume.

Syntax

getVolumeInfo {login=} { userName= passWord= | groupName= } [volumeName=] [searchDepth=] [verbose=]

DescriptionName

This section contains active directory information.INFO

This section contains Fibre Channel adapter information.FCADAPTER

Parameters

{userName}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

getSystemInfo 75

DescriptionName

{groupName}

{passWord}

[searchDepth]

[verbose]

Response Syntax

VOLUME ... STATUS ... REMOTESNAPSHOT ... SNAPSHOT ... SCHEDULE ... PERMISSION ...

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.[volumeName]

Defines which objects to inspect. Values are 1—Volumes only, 2—Volumes and snapshots, and 3—Volumes, snapshots and remote snapshots (default). The greater the search depth number, the longer the call can take.

Determines how much information to return. Values are 0—Get summary information only (better performance) and 1—Get all information (better information; default). The greater the verbose number, the longer the call can take.

Example 142 Windows

cliq getVolumeInfo volumeName=volume0 login=10.1.2.3 userName=admin passWord=secret

Example 143 SSH

getVolumeInfo volumeName=volume0

getVolumeControllingServer

Description

Returns the IP address of the controlling server defined for a volume in the management group.

DescriptionName

This section contains volume information.VOLUME

This section contains status information.STATUS

This section contains remote snapshot information.REMOTESNAPSHOT

This section contains snapshot information.SNAPSHOT

This section contains schedule information.SCHEDULE

This section contains permission information.PERMISSION

Syntax

getVolumeControllingServer {login=} { userName= passWord= | groupName= } {volumeName=}

76 Commands

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

help

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

Example 144 Windows

cliq getVolumeControllingServer login=10.0.1.2 userName=admin passWord=secret volumeName="The Volume"

Example 145 SSH

getVolumeControllingServer volumeName="The Volume"

Description

Get information about the currently supported API command set.

Syntax

help [command=]

Parameters

[command]

Example 146 Windows

cliq help command=getSystemInfo

Example 147 SSH

help command=getSystemInfo

makePrimary

Description

Promote a remote volume to a primary production volume.

DescriptionName

A specific command for more detailed help information.

NOTE: If help is specified with no parameters, a list of possible return codes

is returned.

help 77

Syntax

makePrimary {login=} { userName= passWord= | groupName= } {volumeName=} [size=] [thinProvision=] [adaptiveOptimization=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[thinProvision]

[adaptiveOptimization]

Example 148 Windows

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

The size of the volume, with units specified as:[size]

• <n>MB – n Megabytes (1024 Kilobytes)

• <n>GB – n Gigabytes (1024 Megabytes)

• <n>TB – n Terabytes (1024 Gigabytes)

Enable or disable thin provisioning. Values are 0—The volume does not use thin provisioning, 1—The volume is thin-provisioned (in a thinly provisioned volume, reserve may be < length).

Enable or disable adaptive optimization. Values are 0—Disable and 1—Enable. 1 is the default.

cliq makePrimary login=10.1.2.3 userName=admin passWord=secret volumeName="TheVolume" size=1GB

Example 149 SSH

makePrimary volumeName="TheVolume" size=1GB

makeRemote

Description

Demote a primary volume to a remote snapshot target.

Syntax

makeRemote {login=} { userName= passWord= | groupName= } {volumeName=} {snapshotName=} [adaptiveOptimization=]

78 Commands

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[adaptiveOptimization]

Example 150 Windows

cliq makeRemote login=10.1.2.3 userName=admin passWord=secret volumeName="TheVolume" snapshotName="TheSnapshot"

Example 151 SSH

makeRemote volumeName="TheVolume" snapshotName="TheSnapshot"

modifyAdminGroup

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

The name of the remote snapshot.{snapshotName}

Enable or disable adaptive optimization. Values are 0—Disable and 1—Enable. 1 is the default.

Description

Modify one or more properties of the SAN administrative group.

CAUTION: If the adminUserName parameter is used, all user IDs that are currently in the group

that are not included with this parameter will be removed.

Syntax

modifyAdminGroup {login=} { userName= passWord= | groupName= } {adminGroupName=} [adminUserName=] [description=] [permissions=] [adGroup=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

modifyAdminGroup 79

DescriptionName

The administrative group name.{adminGroupName}

Specifies the users that this group comprises.[adminUserName]

Optional description[description]

[permissions]

Example 152 Windows

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

Example 153 SSH

modifyAdminGroup description="My shiny new group" adminGroupName=powerusers adminUserName=user1;user2 permissions=fffr

modifyAdminUser

Description

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), and f—Full-access (Report does not support this).

NOTE: If this is not specified, the permissions are set to rrrr.

The name of the associated active directory group.[adGroup]

Modify an administrative user.

Syntax

modifyAdminUser {login=} { userName= passWord= | groupName= } {adminUserName=} [description=] [adminPassWord=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Specifies the users that this group comprises.{adminUserName}

Optional description[description]

80 Commands

The password for the administrative user.[adminPassWord]

Example 154 Windows

cliq modifyAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user" adminUserName=user adminPassWord=secret

Example 155 SSH

modifyAdminUser description="My shiny new user" adminUserName=user adminPassWord=secret

modifyCluster

Description

Modify settings on a cluster.

CAUTION:

• Modifying a cluster will cause a restripe of every volume in the cluster.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

cliq modifyCluster {login=} { userName= passWord= | groupName= } {clusterName=} [newName] [description=] [useVip=] [node=] [vip=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[useVip]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the cluster.{clusterName}

The new name for the cluster.[newName]

Optional description[description]

Determines whether virtual IP (VIP) addressing is used. Values are 0 and 1 (default).

[node]

[vip]

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

A delimited list of virtual IP address or DNS-resolvable name and subnet mask.

NOTE: Since each VIP contains two parameters, IP address and subnet

mask, both must be specified in order, even if empty. If multiple VIPs are entered, they must be on different subnets.

modifyCluster 81

Example 156 Windows

cliq modifyCluster clusterName=TheCluster login=10.0.1.3 userName=admin passWord=secret description="My shiny new cluster" useVip=1 node=10.1.2.4 vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0

Example 157 SSH

modifyCluster clusterName=TheCluster description="My shiny new cluster" useVip=1 node=10.1.2.4 vip=10.1.2.99;255.255.0.0;150.215.017.009;255.255.240.0

modifyEmailNotifyPolicy

Description

Modify an Email Notification Policy.

Syntax

modifyEmailNotifyPolicy {login=} { userName= passWord= | groupName= } {email=} [verbosity=] { alertOnInfo= | alertOnWarning= | alertOnCritical= } [emailLocale=]

Parameters

{userName}

{groupName}

{passWord}

[verbosity]

{alertOnInfo}

{alertOnWarning}

{alertOnCritical}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The email address of the recipient.{email}

The level of returned information via email notification. Values are 1—Brief, 2—Standard, and 3—Verbose.

Values are 0—Email will not be sent on informational events, warning events, and critical events and 1—Email will be sent for informational events, warning events, and critical events. The default is 0 for modifyEmailNotifyPolicy. Either alertOnInfo, alertOnWarning, or alertOnCritical must be specified or the command will be rejected.

English (default), Chinese, Japanese, Korean[emailLocale]

82 Commands

Example 158 Windows

cliq modifyEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret email="myemail@myhost.com" alertOnCritical=1

Example 159 SSH

modifyEmailNotifyPolicy email="myemail@myhost.com" alertOnCritical=1

modifyGroup

Description

Modify settings on a management group.

CAUTION:

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

modifyGroup {login=} { userName= passWord= | groupName= } [node=] [bandwidthPriority=] [customerName=] [supportId=] [contactName=] [postalAddress=] [postalAddress2=] [cityName=] [stateName=] [countryName=] [postalCode=] [telephoneNumber=] [emailaddress=]

Parameters

{userName}

{groupName}

{passWord}

[node]

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

The manager bandwidth. Values are:[bandwidthPriority]

• Kb—Kilobits/sec (1000 Bits/second)

• Mb—Megabits/sec (1000 Kilobits/second)

• Gb—Gigabits/sec (1000 Megabits/second)

Customer name[customerName]

Support ID provided by HP StoreVirtual support.[supportId]

Contact name[contactName]

Postal address line 1[postalAddress]

Postal address line 2[postalAddress2]

modifyGroup 83

Example 160 Windows

cliq modifyGroup login=10.0.1.2 userName=admin passWord=secret node=10.0.1.2;10.0.1.3

Example 161 SSH

modifyGroup node=10.0.1.2;10.0.1.3

modifyNSM

Description

DescriptionName

Postal city[cityName]

Postal state[stateName]

Postal country[countryName]

Postal code[postalCode]

Contact telephone number[telephoneNumber]

The notification email.[emailaddress]

Modify storage system Fibre Channel port states between enabled and disabled.

Syntax

modifyNSM {login=} { userName= passWord= | groupName= } {fcenabled=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

{fcenabled}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

Enable or disable the Fibre Channel port(s). Values are 0—Disable and 1—Enable. The default is 0. If a WWPN is entered, this value will stay at the default value of 0 unless specifically set by using this parameter.

84 Commands

Example 162 Windows

cliq modifyNSM login=10.0.1.2 userName=admin passWord=secret fcenabled=1

Example 163 SSH

modifyNSM fcenabled=1

modifyRemoteAssociation

Description

Modify a previously created remote volume association.

CAUTION:

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

modifyRemoteAssociation {login=} { userName= passWord= | groupName= } {remote=} [remoteUserName=] [remotePassWord=] [primaryBandwidth=] [remoteBandwidth=] [remotegroupname=]

Parameters

{userName}

{groupName}

{passWord}

{remote}

[primaryBandwidth]

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The IP address or DNS-resolvable names of one or more remote storage system.

The authentication user name for the remote group.[remoteUserName]

The password for the remote group.[remotePassWord]

The bandwidth used in a copy from the primary group to the remote group. Values are:

• Kb—Kilobits/sec (1000 Bits/second)

• Mb—Megabits/sec (1000 Kilobits/second)

• Gb—Gigabits/sec (1000 Megabits/second)

modifyRemoteAssociation 85

DescriptionName

[remoteBandwidth]

The bandwidth used in a copy from the remote group to the primary group. Values are:

• Kb—Kilobits/sec (1000 Bits/second)

• Mb—Megabits/sec (1000 Kilobits/second)

• Gb—Gigabits/sec (1000 Megabits/second)

The name of the remote management group.[remotegroupname]

Example 164 Windows

cliq modifyRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin remotePassWord=secret remoteBandwidth=10Mb

Example 165 SSH

modifyRemoteAssociation remote=10.0.1.3 remoteUserName=admin remotePassWord=secret remoteBandwidth=10Mb

modifyRemoteSnapshotSchedule

Description

Modify a previously created remote snapshot schedule.

Syntax

modifyRemoteSnapshotSchedule {login=} { userName= passWord= | groupName= } {scheduleName=} [remoteretentioncount=] [remoteretentionseconds=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[remoteretentioncount]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the schedule.{scheduleName}

The number of remote snapshots to maintain. Must be between 1 and 50. Either remoteretentioncount or remoteretentionseconds must be specified.

[remoteretentionseconds]

86 Commands

How long remote snapshots should be retained. Either remoteretentioncount or remoteretentionseconds must be specified.

Example 166 Windows

cliq modifyRemoteSnapshotSchedule scheduleName="TheSchedule" login="10.0.1.2" userName="admin" passWord="secret" remoteretentioncount="10"

Example 167 SSH

modifyRemoteSnapshotSchedule scheduleName="TheSchedule" remoteretentioncount="10"

modifyServer

Description

Modify a server.

Syntax

modifyServer {login=} { userName= passWord= | groupName= } {serverName=} [description=] [allowiSCSIAccess=] [vipLoadBalance=] [useCHAP=] [initiator=] [targetSecret=] [chapName=] [initiatorSecret=] [controllingserver=] [allowfcaccess=] [wwpn=] [bootvolumelun=] [bootvolumename=]

Parameters

{userName}

{groupName}

{passWord}

[allowiSCSIAccess]

[vipLoadBalance]

[useCHAP]

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the server.{serverName}

Optional description[description]

Allow iSCSI access for this host. Values are 0—Disable and 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 Fibre Channel is NOT configured, the default will be 1, otherwise no default will be selected.

Use VIP load balancing for this host. Values are 0—Disabled and 1—Enabled. The default value is 1.

Use CHAP Authentication for this host. Values are 0—Disabled and 1—Enabled.

[initiator]

[chapName]

A semicolon delimited string of host IQNs. If this is not specified, the IQN of the local server is used (this parameter is required if run on a storage system). Valid characters are any letter, number, international character or

-, ., and : characters.

The CHAP target secret for the volume.[targetSecret]

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

modifyServer 87

DescriptionName

The CHAP initiator secret for the volume.[initiatorSecret]

[controllingserver]

[allowfcaccess]

[wwpn]

[bootvolumelun]

[bootvolumename]

The IP address of the client server that has Application Aware Snapshot Manager (AASM) installed on it. It will coordinate the snapshot with the applications using SAN volumes. This is required for managed snapshots of Fibre Channel connected volumes. This is also required for VMware managed snapshots; if applicable, enter the Virtual Center Server IP address.

Allow Fibre Channel ports to be assigned to the client. Values are 0—Disable and 1—Enable. If volumes are attached to a client server via Fibre Channel and a value of 0 is entered, the client will lose its ability to communicate with the attached volumes.

A semicolon delimited list of the unique World Wide Port Names for one or more Fibre Channel ports. Expected WWPN formatting is 16 Hex characters with or without the : character as a delimiter. For example: 20:21:00:0E:B3:01:AB:C6 or 2021000EB301ABC6. Lower case hex characters a-f are also accepted.

The LUN (1–255) of the boot volume. Valid only for a Fibre Channel attached volume. If present, then bootvolumename must also be specified.

NOTE: LUN 255 is not supported by Microsoft Windows.

The volume name of the boot volume. Valid only for a Fibre Channel attached volume. If present, then bootvolumelun must also be specified.

Example 168 Windows

cliq modifyServer serverName=TheServer useCHAP=0 initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.mynetworks.com login=10.0.1.2 userName=admin passWord=secret

Example 169 SSH

modifyServer serverName=TheServer useCHAP=0 initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.mynetworks.com

modifySite

Description

Modify a site in a multi-site SAN.

CAUTION:

• This operation is irreversible.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

Syntax

modifySite {login=} { userName= passWord= | groupName= } {siteName=} [node=] [description=] [primary=]

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

88 Commands

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[node]

[primary]

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the site.{siteName}

The delimited list of node names or IP addresses, or DNS-resolvable node names of the storage systems the cluster comprises.

Optional description[description]

Designates this site as the primary site. Values are 0—Disabled or 1—Enabled. 1 is the default.

Example 170 Windows

cliq modifySite siteName=TheSite description="My Site" login=10.0.1.2 userName=admin passWord=secret

Example 171 SSH

modifySite siteName=TheSite description="My Site"

modifySnapshot

Description

Modify snapshot settings.

Syntax

modifySnapshot {login=} { userName= passWord= | groupName= } {snapshotName=} [description=] [autogrowpages=]

Parameters

{userName}

{groupName}

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

{passWord}

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.{snapshotName}

modifySnapshot 89

Example 172 Windows

cliq modifySnapshot description="New Description" login=10.0.1.2 userName=admin passWord=secret snapshotName=TheSnapshot

Example 173 SSH

modifySnapshot description="New Description" snapshotName=TheSnapshot

modifySnapshotSchedule

Description

Modify a previously created snapshot schedule.

Syntax

modifySnapshotSchedule {login=} { userName= passWord= | groupName= } {scheduleName=} [description=] [recurperiod=] [starttime=] [retentioncount=] [retentionseconds=] [paused=]

DescriptionName

Optional description[description]

Automatically grow the pages.[autogrowpages]

Parameters

{userName}

{groupName}

{passWord}

[recurperiod]

[starttime]

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the schedule.{scheduleName}

Optional description[description]

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

The start time of the schedule. Specified as ISO 8601. Format is YYYY-MM-DDTHH:MM:SSZ. YYYY represents the year, MM is the month, DD is the day of the month, HH is the hour in 24 hour format, MM is the minutes, and SS is the seconds. The time must always be expressed in GMT time.

[retentioncount]

[retentionseconds]

[paused]

90 Commands

Defines the number of snapshots to maintain. Must be between 1 and 50. Either retentioncount or retentionseconds must be specified.

Defines how long snapshots should be retained. Either retentioncount or retentionseconds must be specified.

The state of the snapshot schedule. Values are 0—Schedule is not paused and 1—Schedule is paused.

Example 174 Windows

cliq modifySnapshotSchedule scheduleName="TheSchedule" description="First snapshot schedule" login="10.0.1.2" userName="admin" passWord="secret"

Example 175 SSH

modifySnapshotSchedule scheduleName="TheSchedule" description="First snapshot schedule"

modifySnmpCommunityString

Description

Modify the Community String for all SNMP.

Syntax

modifySnmpCommunityString {login=} { userName= passWord= | groupName= } {communityString=}

Parameters

DescriptionName

{userName}

{groupName}

{passWord}

Example 176 Windows

cliq modifySnmpCommunityString login=10.0.1.3 userName=admin passWord=secret communityString="NewString"

Example 177 SSH

modifySnmpCommunityString communityString="NewString"

modifySnmpTrapTarget

Description

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The SNMP community string.{communityString}

Modify an SNMP Trap Target.

Syntax

modifySnmpTrapTarget {login=} { userName= passWord= | groupName= } {communityString=}

modifySnmpCommunityString 91

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 178 Windows

cliq modifySnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret communityString="TheString"

Example 179 SSH

modifySnmpTrapTarget communityString="TheString"

modifySyslogNotifyPolicy

Description

Modify a Syslog Notification Policy.

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The SNMP community string.{communityString}

Syntax

modifySyslogNotifyPolicy {login=} { userName= passWord= | groupName= } {ipAddress=} { alertOnInfo= | alertOnWarning= | alertOnCritical= }

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

{alertOnInfo}

{alertOnWarning}

{alertOnCritical}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

This is the IP address or Host Name of the Syslog server.{ipAddress}

Values are 0—The log does not include informational events, warning events, and critical events and 1—The log includes informational events, warning events, and critical events. The default is 0 for modifySyslogNotifyPolicy. Either alertOnInfo, alertOnWarning, or alertOnCritical must be specified or the command will be rejected.

92 Commands

Example 180 Windows

cliq modifySyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ="10.0.10.25" alertOnInfo="1"

Example 181 SSH

modifySyslogNotifyPolicy ="10.0.10.25" alertOnInfo="1"

modifyVolume

Description

Modify volume settings.

CAUTION:

• Enabling checksums may impact volume I/O performance.

• Changing the replication level of this volume will cause it to restripe, and may impact I/O

performance. This will display a prompt, requiring confirmation before proceeding. This prompt may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

modifyVolume {login=} { userName= passWord= | groupName= } {volumeName=} [description=] [replication=] [parity=] [checkSum=] [thinProvision=] [autogrowSeconds=] [clusterName=] [size=] [autogrowpages=] [adaptiveOptimization=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

Optional description[description]

The replication level for the volume. Values are 1, 2, 3, and 4.[replication]

[parity]

The number of parity storage systems for the data on this volume. 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)

modifyVolume 93

DescriptionName

• replication:2, parity:1 Network RAID-5 (Single parity)

• replication:3, parity:2 Network RAID-6 (Dual Parity)

[checkSum]

[thinProvision]

[autogrowSeconds]

[adaptiveOptimization]

Example 182 Windows

Values are 0—The volume does not use checksums and 1—The volume uses checksums.

Enable or disable thin provisioning. Values are 0—The volume does not use thin provisioning and 1—The volume is thin-provisioned (in a thinly provisioned volume, reserve may be < length).

The amount to grow the volume when it is thin-provisioned and new pages must be added, based on the current growth rate. A value of 0 means no autogrow.

The name of the cluster.[clusterName]

The size of the volume, with units specified as:[size]

• <n>KB—n Kilobytes (1024 bytes)

• <n>MB—n Megabytes (1024 Kilobytes)

• <n>GB—n Gigabytes (1024 Megabytes)

• <n>TB—n Terabytes (1024 Gigabytes)

• <n>PB—n Petabytes (1024 Terabytes)

Automatically grow the pages.[autogrowpages]

Enable or disable adaptive optimization. Values are 0—Disable and 1—Enable. 1 is the default.

cliq modifyVolume description="New Description" login=10.0.1.2 userName=admin passWord=secret volumeName=TheVolume

Example 183 SSH

modifyVolume description="New Description" volumeName=TheVolume

mountVolume

Description

Mount a volume to the specified mount point.

CAUTION: Prior to mounting the volume, the volume must be assigned to the server

(assignVolume) and connected (connectVolume).

Syntax

mountVolume {groupName=} {volumeName=} {mountpoint=} [forcecreate=]

Parameters

DescriptionName

The name of the management group.{groupName}

94 Commands

The name of the volume in the management group.{volumeName}

Example 184 Windows

cliq mountVolume groupName=MG2 volumeName=TheVolume mountPoint=z:

rebalanceVip

Description

Rebalance the connections to a volume when using a virtual IP address.

Syntax

rebalanceVip {login=} { userName= passWord= | groupName= } {volumeName=}

Parameters

DescriptionName

The drive letter or mount point on the host for the volume.{mountPoint}

Forces the creation of the volume with formatting as NTFS.[forcecreate]

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

rebalanceVip 95

Example 185 Windows

cliq rebalanceVip volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret

Example 186 SSH

rebalanceVip volumeName=MyVolume

recoverQuorum

Description

This command is used to rescue a management group after quorum has been irretrievably lost. This command needs to be run on a storage system with a working manager so it can retrieve the management group database from that manager to restore the management group.

CAUTION:

• Once you have chosen to proceed with the recover quorum operation, there is no way to

undo the effects. If possible, it is highly recommended that you attempt to recover quorum instead by bringing up any offline managers that might still be accessible. As part of the recover quorum operation, all configured managers that are offline will be deleted from the management group and all storage servers that are offline will be ejected from the management group and cluster(s).

• Contact support before proceeding. Only use the recoverQuorum command when actively

working with support personnel and they direct you to invoke the command.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

recoverQuorum {login=} { userName= passWord= | groupName= }

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

96 Commands

Example 187 Windows

cliq recoverQuorum login=10.1.2.3 userName=admin passWord=secret

Example 188 SSH

recoverQuorum

removeSnapshot

Description

Disconnect a SAN snapshot from the host, then delete it. If the snapshot cannot be disconnected (because it is in use, or for any other reason), it will not be deleted.

Syntax

removeSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

Example 189 Windows

cliq removeSnapshot snapshotName=z: login=10.0.1.2 userName=admin passWord=secret

removeVolume

Description

Disconnect a StoreVirtual volume from the host, then delete it. If the volume cannot be disconnected (because it is in use, or for any other reason), it will not be deleted.

Syntax

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.{snapshotName}

removeVolume {login=} { userName= passWord= | groupName= } {volumeName=}

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

removeSnapshot 97

DescriptionName

{groupName}

{passWord}

Example 190 Windows

cliq removeVolume volumeName=z: login=10.0.1.2 userName=admin passWord=secret

resetSession

Description

Reset the iSCSI session associated with a volume. Some initiators will attempt to reconnect after the reset.

Syntax

resetSession {login=} { userName= passWord= | groupName= } {volumeName=} [initiator=]

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

Parameters

{userName}

{groupName}

{passWord}

[initiator]

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the volume in the management group.{volumeName}

A semicolon delimited string of host IQNs. If this is not specified, the IQN of the local server is used (this parameter is required if run on a storage system). Valid characters are any letter, number, international character or

-, ., and : characters.

98 Commands

Example 191 Windows

cliq resetSession volumeName=MyVolume login=10.1.2.3 userName=admin passWord=secret

Example 192 SSH

resetSession volumeName=MyVolume

rollbackSnapshot

Description

Roll back a snapshot.

CAUTION:

• The rollbackSnapshot command will replace the original volume with a new one based

on the contents of the snapshot and delete any snapshots created after the snapshot which is being rolled back.

• If the original volume is specified, this will replace it with a new volume based on the contents

of the snapshot and delete any snapshots created after the snapshot being rolled back.

• This command will display a prompt, requiring confirmation before proceeding. This prompt

may be overridden with an optional prompt=0 parameter on the command line; in this case, the command will always execute without pausing for confirmation.

Syntax

rollbackSnapshot {login=} { userName= passWord= | groupName= } {snapshotName=} [description=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the remote snapshot.{snapshotName}

Optional description[description]

rollbackSnapshot 99

Example 193 Windows

cliq rollbackSnapshot snapshotName=TheSnapshot login=10.0.1.2 userName=admin passWord=secret

Example 194 SSH

rollbackSnapshot snapshotName=TheSnapshot

runDiagnostic

Description

Run one or all storage system diagnostics.

Syntax

runDiagnostic {login=} { userName= passWord= | groupName= } [diagnosticName=]

Parameters

DescriptionName

The IP addresses or DNS-resolvable names of one or more storage systems.{login}

{userName}

{groupName}

{passWord}

[diagnosticName]

Example 195 Windows

cliq runDiagnostic login=10.0.1.2 userName=admin passWord=secret diagnosticName=drvstat

Example 196 SSH

runDiagnostic diagnosticName=drvstat

setADInfo

Description

The authentication user name for the storage system. If you use this parameter, you must include the passWord parameter with it. Or, you can use the groupName parameter instead of userName and passWord.

The name of the management group. Use this parameter if you do not use the userName and passWord parameters. Because groupName has cached credentials, it does not require the userName and passWord parameters.

The password for the storage system. Required when the userName parameter is used.

The name of the diagnostic to run (if unspecified, all diagnostics are listed; if * is specified, all are run).

Set the active directory association and configuration of the management group.

Syntax

setADInfo {login=} { userName= passWord= | groupName= } {adServer=} {baseDN=} [bindUserName=] [bindPassWord=] [userContext=] [testOnly=] [ldaps=]

100 Commands

HP StoreVirtual 4000 User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

HP StoreVirtual LeftHand OS Command Line Interface User Guide

Contents

1 Overview

Global parameters

Syntax

Return codes

2 Commands

addVirtualManager

assignVolumeChap

assignVolumeToServer

cacheCredentials

cancelRemoteSnapshot

clearAlertsPolicy

clearCredentials

clearADInfo

clearDnsInfo

clearEmailServerInfo

clearSnmpNotifyPolicy

clearSnmpServiceInfo

clearVssVolumeFlags

cloneSnapshot

configureRaid

connectVolume

convertSnapshotTempSpace

createAdminGroup

createAdminUser

createCluster

createEmailNotifyPolicy

createGroup

createRemoteAssociation

createRemoteSnapshot

createServer

createSite

createSnapshot

createSnapshotSchedule

createSnmpCommunityString

createSnmpTrapTarget

createSyslogNotifyPolicy

createVolume

deleteAdminGroup

deleteAdminUser

deleteAutoMountPolicy

deleteCluster

deleteEmailNotifyPolicy

deleteGroup

deleteRemoteAssociation

deleteServer

deleteSite

deleteSnapshot

deleteSnapshotSchedule

deleteSnapshotTempSpace

deleteSnmpCommunityString

deleteSnmpTrapTarget

deleteSyslogNotifyPolicy

deleteVirtualManager

deleteVolume

disconnectLocalVolume

discoverTcp

discoverUdp

dismountVolume

findADInfo

getADInfo

getAlertLog

getAutoMountPolicy

getClusterInfo

getDnsInfo

getEventLog

getGroupInfo

getLocalVolumes

getNotificationPolicy

getNsmInfo

getNsmLogs

getPerformanceStats

getRemoteSnapshotInfo

getScsiInfo

getServerCapabilities