HP StoreVirtual VSA Software User Manual

P4000 Command-Line Interface User Guide

This guide provides information for using the command-line interface provided with the P4000 software. Command syntax is included, and a link to sample scripts available from the HP website.

Part Number : AX696-96069 First edition : September 2011

Overview............................................................................................................................... 5

Global Parameters...................................................................................................................6

Syntax................................................................................................................................... 7

Return Codes........................................................................................................................10

Commands...........................................................................................................................16

addVirtualManager..................................................................................................... 16

assignVolume..............................................................................................................16

assignVolumeChap......................................................................................................17

assignVolumeToServer................................................................................................. 17

cacheCredentials.........................................................................................................18

cancelRemoteSnapshot.................................................................................................18

clearAlertsPolicy.......................................................................................................... 19

clearCredentials.......................................................................................................... 19

clearDnsInfo................................................................................................................19

clearEmailServerInfo.................................................................................................... 20

clearSnmpNotifyPolicy................................................................................................. 20

clearSnmpServiceInfo...................................................................................................21

clearVssVolumeFlags....................................................................................................21

cloneSnapshot.............................................................................................................21

configureRaid............................................................................................................. 22

connectVolume............................................................................................................22

convertSnapshotTempSpace..........................................................................................23

createAdminGroup...................................................................................................... 23

createAdminUser.........................................................................................................24

createCluster...............................................................................................................25

createEmailNotifyPolicy................................................................................................25

createGroup............................................................................................................... 26

createKey................................................................................................................... 26

createRemoteAssociation.............................................................................................. 27

createRemoteSnapshot................................................................................................. 27

createServer............................................................................................................... 28

createSite................................................................................................................... 29

createSnapshot........................................................................................................... 29

createSnapshotSchedule...............................................................................................30

createSnmpCommunityString.........................................................................................31

createSnmpTrapTarget................................................................................................. 32

createSyslogNotifyPolicy.............................................................................................. 32

createVolume..............................................................................................................33

deleteAdminGroup...................................................................................................... 34

deleteAdminUser......................................................................................................... 34

deleteCluster...............................................................................................................35

deleteEmailNotifyPolicy................................................................................................35

deleteGroup............................................................................................................... 36

deleteRemoteAssociation.............................................................................................. 36

deleteServer................................................................................................................37

deleteSite................................................................................................................... 37

deleteSnapshot............................................................................................................38

deleteSnapshotSchedule...............................................................................................38

deleteSnapshotTempSpace........................................................................................... 39

deleteSnmpCommunityString.........................................................................................39

deleteSnmpTrapTarget................................................................................................. 40

2|HP P4000 CLI|TOC

deleteSyslogNotifyPolicy.............................................................................................. 40

deleteVirtualManager.................................................................................................. 41

deleteVolume.............................................................................................................. 41

disconnectLocalVolume.................................................................................................42

discoverTcp................................................................................................................ 42

discoverUdp............................................................................................................... 42

getAlertLog................................................................................................................. 43

getClusterInfo..............................................................................................................43

getDnsInfo.................................................................................................................. 44

getEventLog................................................................................................................ 44

getGroupInfo.............................................................................................................. 45

getLocalVolumes..........................................................................................................45

getNotificationPolicy....................................................................................................46

getNsmInfo.................................................................................................................46

getNsmLogs................................................................................................................47

getPerformanceStats.....................................................................................................47

getRemoteSnapshotInfo................................................................................................ 48

getScsiInfo..................................................................................................................48

getServerCapabilities...................................................................................................48

getServerInfo...............................................................................................................49

getServerJobInfo..........................................................................................................49

getServerVolumeInfo.................................................................................................... 51

getSiteInfo.................................................................................................................. 51

getSnapshotInfo...........................................................................................................52

getSnapshotScheduleInfo..............................................................................................52

getSnmpInfo................................................................................................................53

getSupportInfo............................................................................................................ 53

getSystemInfo..............................................................................................................53

getVolumeInfo............................................................................................................. 54

help...........................................................................................................................54

makePrimary...............................................................................................................55

makeRemote............................................................................................................... 55

modifyAdminGroup..................................................................................................... 56

modifyAdminUser........................................................................................................56

modifyCluster..............................................................................................................57

modifyEmailNotifyPolicy...............................................................................................58

modifyGroup.............................................................................................................. 58

modifyRemoteAssociation............................................................................................. 59

modifyRemoteSnapshotSchedule....................................................................................60

modifyServer...............................................................................................................60

modifySite.................................................................................................................. 61

modifySnapshot...........................................................................................................61

modifySnapshotSchedule..............................................................................................62

modifySnmpCommunityString........................................................................................63

modifySnmpTrapTarget................................................................................................ 63

modifySyslogNotifyPolicy............................................................................................. 64

modifyVolume............................................................................................................. 64

provisionVolume..........................................................................................................65

rebalanceVip.............................................................................................................. 66

recoverQuorum........................................................................................................... 67

removeSnapshot..........................................................................................................67

removeVolume............................................................................................................ 68

resetSession................................................................................................................ 68

rollbackSnapshot.........................................................................................................69

runDiagnostic..............................................................................................................69

setAlertsPolicy............................................................................................................. 70

HP P4000 CLI|TOC|3

setDnsInfo...................................................................................................................70

setEmailServerInfo....................................................................................................... 71

setGossipList............................................................................................................... 71

setLicenseKey..............................................................................................................72

setSnmpNotifyPolicy.................................................................................................... 72

setSnmpServiceInfo......................................................................................................73

shutdownGroup...........................................................................................................73

shutdownNsm............................................................................................................. 74

startManager.............................................................................................................. 74

startSnmpService......................................................................................................... 75

startVirtualManager..................................................................................................... 75

stopManager.............................................................................................................. 76

stopSnmpService......................................................................................................... 76

stopVirtualManager..................................................................................................... 77

testCredentials.............................................................................................................77

unassignVolume.......................................................................................................... 77

unassignVolumeToServer.............................................................................................. 78

utility..........................................................................................................................78

vssSnapshot................................................................................................................ 79

waitForEvent............................................................................................................... 80

waitForUpdate............................................................................................................ 80

4|HP P4000 CLI|TOC

Overview

The SAN/iQ command-line interface (CLI) is built upon the SAN/iQ API released with version 8.x. Develop your own automation, scripting and management using the CLI.

• For instructions about using the CLI, see the Syntax section, immediately following this introduction.

• The section on Global Parameters 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 Windows XP SP2 Windows Vista 10 MB available space

Installing the CLI

Install the CLI from the HP StorageWorks P4000 Management Software for Microsoft Windows DVD. The installation wizard automatically installs the command-line software to the following default location in Windows: C:\Program Files\HP\P4000\HP P4000 CLI and sets the environment variable.

Sample Scripts

You can obtain sample scripts from the HP website: www.hp.com/go/P4000downloads.

On-System CLI

The CLI is installed on storage systems and can be accessed by SSH.

• Log in to the on-system CLI using the system IP address and the designated port 16022.

• If logging in from a command line, you must type the following command:

ssh –p 16022 -l <user> <NSM-IP>

HP P4000 CLI|Overview|5

Global Parameters

prompt=<true | false>

Some potentially destructive commands prompt before proceeding. This default behavior can be turned off by specifying "prompt=false".

output=<XML | Normal>

In the default case, the CLI returns information to standard output, formatted in a way that's easy to read rather than easy to parse. 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. If the output needs to be parsed, the XML variant is preferred.

separator=<c>

Some CLI parameters comprise parameters for multiple operations. For example, the "snapshotVolumes" command allows the user to specify simultaneous snapshotting of multiple volumes. In this scenario, some parameters specify an 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 the same character is used in the body of a parameter then separator can be changed to something else.

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

inputFile=<file>

This takes all command input from a file containing XML input.

6|HP P4000 CLI|Global Parameters

Syntax

CLIQ is the command-line interface (CLI) for the HP P4000 Storage Solution. The CLI specifies parameters in the form parameter=<parameter> (specification), rather than dictating a particular order (positional) notation.

Parameter ordering

Ordering of parameters is not specified. Any order will do. For example:

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

is equivalent to

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

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

This section is applicable to languages that have a notion of case sensitivity. All commands and parameter names are case-insensitive. "createVolume" is the same as "CreateVolume" is the same as "CREATEVOLUME". In some cases, parameter values, while not sensitive, are case significant as the system will preserve the case specified. For example, the description parameter value in the createVolume command will preserve the case specified by the caller, and impose this on the newly created volume.

True/False

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

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 will map 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:

• MB - megabytes (2^20)

HP P4000 CLI|Syntax|7

• GB - gigabytes (2^30)

• TB - terabytes (2^40)

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

Some values may be specified as either a size or percentage, for example, reserveQuota. The units will determine how this is interpreted. For example:

• 10MB - 1,048,576 bytes

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

• 10% - 1/10 of the current volume size

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: *******

Key file

Instead of specifying username/password parameters, you may choose to specify an encrypted key file which contains the credentials. This file can be kept in a secure location, or otherwise access-controlled. To create this file, use the createKey command.

cliq createKey login=10.0.1.2 username=admin password=secret keyfile=key.dat cliq getGroupInfo login=10.0.1.2 keyfile=key.dat

DNS names

You can also specify managers as a host name, provided they can be resolved by DNS:

cliq getGroupInfo login=Exchange-1 username=admin password=secret

Storage System CLI

When commands are executed on the storage systems (via SSH), no authentication parameters are required:

getGroupInfo

Integrated command shell

The CLIQ command line has an integrated shell that's executed by default when connecting directly to a storage system, or running cliq.exe without any parameters:

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

LEFT Moves the cursor one space to the left.

8|HP P4000 CLI|Syntax

Key Meaning

RIGHT Moves the cursor one space to the right.

BACKSPACE Deletes the character under the cursor and

moves the cursor to the left.

DELETE Deletes the character under the cursor.

UP Recalls the previous command entered.

DOWN Recalls the first command entered.

HOME Moves the cursor to the beginning of the line.

END Moves the cursor to the end of the line.

ESCAPE Clears the current command line.

INSERT Toggles between insert mode (the default) and

overwrite mode.

TAB Completes the command. If the command

method is not yet fully resolved, repeated TAB keys will cycle through the possible command methods (SHIFT-TAB will cycle in reverse). If the method is fully resolved, then parameters associated with that command will be proposed. The parameters suggested start with those required for the command, followed by optional parameters. No mutually exclusive parameters will be suggested.

HP P4000 CLI|Syntax|9

Return Codes

All GAUChE commands return an XML response containing a 32-bit result code, and a description of the result. Example:

<?xml version="1.0" encoding="UTF-8" standalone="no" ?> <gauche version="1.0"> <response description="Succeeded" result="0"/> </gauche>

Success results are nonnegative values, while negative values indicate an error. Many errors returned by SAN/iQ and Hydra unfortunately do not return ordinal values that can be conveniently mapped into an API and CLI return code. In all cases, we can return the error description string, but it won't be feasible to return a sensible ordinate value (other than GaucheGeneralError) without parsing the description string.

Result Value OS Status Description

CliqSuccess 0 0 Everything

succeeded normally

CliqNothingDone 1 1 Operation has

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

CliqOperationPending 2 2 Operation has not

failed, but is not yet complete. The "handle" parameter contains a value that can be used to query and cancel the operation.

CliqOperationAbandoned 3 3 Operation was

cancelled or abandonded.

CliqNothingFound 4 4 Operation found no

objects.

CliqSnapshotSet 5 5 This snapshot

was a part of the snapshot set.

CliqVssSnapshotWarning 6 6 Warning: The

writer operation failed.

CliqPITSnapshotWarning 7 7 Warning: Point in

time snapshot is created.

CliqParameterIgnored 8 8 The operation

10|HP P4000 CLI|Return Codes

succeeded but a parameter was

Result Value OS Status Description

ignored as it is not applicable.

CliqUnexpected 0x80001001 128 An unexpected

error has occurred.

CliqXmlError 0x80001002 129 The XML given is

not well-formed.

CliqParameterFormat 0x80001003 130 The parameter

is not specified correctly.

CliqParameterRepeat 0x80001004 131 A parameter is

repeated.

CliqMissingMethod 0x80001005 132 The command

method is missing.

CliqMissingParameter 0x80001006 133 One or more

expected parameters are missing.

CliqUnrecognizedCommand0x80001007 134 This command is

unrecognized.

CliqUnrecognizedParameter0x80001008 135 This parameter is

unrecognized.

CliqIncompatibleParameters0x80001009 136 Two or more

parameters supplied are incompatible with each other.

CliqNotYetImplemented 0x8000100A 137 This is a legal

command - we just haven't done it yet.

CliqNoMemory 0x8000100B 138 Out of memory.

CliqVolumeNotFound 0x8000100C 139 Could not find the

requested volume.

CliqVolumeInUse 0x8000100D 140 The requested

volume is in use.

CliqVolumeInitFailure 0x8000100E 141 Volume

initialization failed.

CliqUnrecognizedVolume 0x8000100F 142 The volume is an

unrecognized type.

CliqOperationFailed 0x80001010 143 General SAN/iQ

error - the operation failed.

CliqCredentialsFailed 0x80001011 144 The supplied

credentials are incorrect.

CliqInvalidParameter 0x80001012 145 Invalid parameter.

HP P4000 CLI|Return Codes|11

Result Value OS Status Description

CliqObjectNotFound 0x80001013 146 Object not found.

CliqConnectionFailure 0x80001014 147 Failed to connect to

the API server.

CliqNotEnoughSpace 0x80001015 148 Not enough space

to complete the command.

CliqNoManager 0x80001016 149 Could not find a

manager.

CliqSocketError 0x80001017 150 Network socket

error.

CliqOperationTimedOut 0x80001018 151 Operation

exceeded the specified timeout.

CliqNoPlatformSupport 0x80001019 152 This operating

system type does not support the operation.

CliqNoPlatformSupport 0x8000101A 153 This operating

system version does not support the operation.

CliqUtilityNotFound 0x8000101B 154 The utility command

requested was not found.

CliqUtilityNotAllowed 0x8000101C 155 The utility command

requested is not in the allowed list.

CliqUtilityIllegalParameter 0x8000101D 156 The utility

command contains unsupported parameters or redirection.

CliqUtilityFailed 0x8000101E 157 The utility command

executed, but returned a non-zero status code.

CliqNodeNotFound 0x8000101F 158 The specified

storage system can't be found.

CliqIllegalUsername 0x80001020 159 The username

must be 3..40 characters, starting with a letter.

CliqIllegalPassword 0x80001021 160 The password

12|HP P4000 CLI|Return Codes

must be 5..40 characters, not / or :.

Result Value OS Status Description

CliqFileError 0x80001022 161 General file error.

CliqMissingInitiator 0x80001023 162 No iSCSI initiator

found.

CliqInitiatorStopped 0x80001024 163 The iSCSI initiator

is not running.

CliqSanIqTooOld 0x80001025 164 The version of

SAN/iQ software must be upgraded.

CliqDefaultAdmin 0x80001026 165 You cannot

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

CliqVssProviderNotInstalled0x80001027 166 The HP P4000

VSS Provider is not installed.

CliqVssProviderNotRunning0x80001028 167 The HP P4000

VSS Provider is not running.

CliqVolumeNoSessions 0x80001029 168 Cannot create

an applicationmanaged snapshot because there are no iSCSI connections associated with this volume. To create applicationmanaged snapshots, there must be at least one application server associated with the volume via an iSCSI connection.The volume must be connected to a VSSenabled server.

CliqVolumeMultipleSessions0x8000102A 169 Cannot create

an applicationmanaged snapshot because there is more than one IQN (iSCSI Qualified Name) associated with this volume. To create application-

HP P4000 CLI|Return Codes|13

Result Value OS Status Description

managed snapshots, there must be only one application server associated with the volume.

CliqNoVssCapabilities 0x8000102B 170 Cannot create

an applicationmanaged snapshot because the server does not support this capability.

CliqServerUnresponsive 0x8000102C 171 Cannot create

an applicationmanaged snapshot because the system could not communicate to the necessary software component on the application server.

CliqVssSnapshotFailed 0x8000102D 172 Cannot create

an applicationmanaged snapshot because the system could not quiesce the application associated with this volume.

CliqVssLunInfoFailed 0x8000102E 173 Cannot create

an applicationmanaged snapshot because the system failed to get LUN data.

CliqVssWriterUnavailable 0x8000102F 174 The VSS writer

operation failed.

CliqVssSnapshotInProgress 0x80001030 175 Another app-

managed snapshot is in progress.

CliqWindowsServerIsBusy 0x80001031 176 The application

server is busy.

CliqUpdateVssProvider 0x80001032 177 This version of VSS

provider must be upgraded.

CliqVssOperationTimedOut0x80001033 178 VSS operation

timed out.

CliqVolumeConnectionFailure0x80001034 179 Volume connection

failure.

14|HP P4000 CLI|Return Codes

Result Value OS Status Description

CliqServerInCluster 0x80001035 180 Server is in Cluster

and cannot be changed via CliQ.

CliqVolumeError 0x80001036 181 Volume error.

CliqVolumeNoServer 0x80001037 182 Failed to contact

Application Aware Snapshot Manager.

CliqUnsupportedApplication0x80001038 183 This application is

not supported.

CliqServerVersionMismatch0x80001039 184 Server version is

not compatible.

CliqSnapshotNameExists 0x8000103A 185 The snapshot with

this name already exists.

CliqVolumeInvalidSet 0x8000103B 186 Invalid volume set.

HP P4000 CLI|Return Codes|15

Commands

addVirtualManager

This command adds a virtual manager to a group.

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

cliq addVirtualManager login= userName= passWord=

login Required The IP address or DNS-resolvable names of one or more storage systems userName Required The authentication user name for the storage system passWord Required The password for the storage system

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

Example

cliq addVirtualManager login=10.0.1.2 userName=admin passWord=secret cliq addVirtualManager

assignVolume

This command assigns a volume to a server. This assignment sets the access to a volume, based on host iqn(s).

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

cliq assignVolume volumeName= initiator= login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

volumeName Required The name of the volume

namePrefix Optional A prefix string for newly created objects. A unique number value will be concatenated

to this prefix to guarantee name uniqueness.

accessRights Optional The access rights to the volume: r - read-only, x - no access, rw - read-write (default)

initiator Optional A semicolon delimited string of host IQN's. If this is not specified, the IQN of the local

server is used (this parameter is required if run on a storage system).

vipLoadBalance Optional Use VIP load balancing for this host. This can be one of: 0, 1 - default exclusiveAccess Optional Remove any previous server access rights to this volume. This can be one of: 0, 1 -

default

16|HP P4000 CLI|Commands

Example

cliq assignVolume volumeName=TheVolume initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.hp.com login=10.0.1.2 userName=admin passWord=secret

cliq assignVolume volumeName=TheVolume initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.hp.com

assignVolumeChap

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

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

cliq assignVolumeChap volumeName= targetSecret= login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

volumeName Required The name of the volume

targetSecret Required The CHAP target secret for the volume.

namePrefix Optional A prefix string for newly created objects. A unique number value will be concatenated

to this prefix to guarantee name uniqueness.

accessRights Optional The access rights to the volume: r - read-only, x - no access, rw - read-write (default)

chapName Optional The CHAP name for the volume. If this is not specified, the IQN of the local server is

used (this parameter is required if run on a storage system).

initiatorSecret Optional The CHAP initiator secret for the volume. vipLoadBalance Optional Use VIP load balancing for this host. This can be one of: 0, 1 - default exclusiveAccess Optional Remove any previous server access rights to this volume. This can be one of: 0, 1 -

default

Example

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

cliq assignVolumeChap volumeName=TheVolume targetSecret=ItsASecret

assignVolumeToServer

This command assigns a volume to a server.

Availability: Windows, SAN/iQ

Version: 9.0

Request Syntax

cliq assignVolumeToServer volumeName= serverName= login= userName= passWord=

HP P4000 CLI|Commands|17

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

volumeName Required The name of the volume

serverName Required The name of the server

accessRights Optional The access rights to the volume: r - read-only, x - no access, rw - read-write (default)

Example

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

cliq assignVolumeToServer volumeName=TheVolume serverName=TheServer

cacheCredentials

This command caches the management group credentials and IP addresses in the registry.

Availability: Windows

Version: 8.0

Request Syntax

cliq cacheCredentials groupName= userName= passWord=

userName Required The authentication user name for the storage system passWord Required The password for the storage system

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

groupName Required The name of the group

Example

cliq cacheCredentials groupName=TheGroup userName=admin passWord=secret

cancelRemoteSnapshot

This command cancels a remote snapshot.

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

cliq cancelRemoteSnapshot snapshotName= login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

snapshotName Required The name of the remote snapshot

18|HP P4000 CLI|Commands

parameters)

Example

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

cliq cancelRemoteSnapshot snapshotName=TheSnapshot

clearAlertsPolicy

This command clears the Alerts and Events Policy information

Availability: Windows, SAN/iQ

Version: 9.0

Request Syntax

cliq clearAlertsPolicy login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

Example

cliq clearAlertsPolicy login=10.0.1.3 userName=admin passWord=secret cliq clearAlertsPolicy

clearCredentials

This command removes the management group credentials from the cache.

Availability: Windows

Version: 8.0

Request Syntax

cliq clearCredentials groupName=

groupName Required The name of the group

Example

cliq clearCredentials groupName=TheGroup

clearDnsInfo

This command clears the DNS settings.

Availability: Windows, SAN/iQ

Version: 9.0

HP P4000 CLI|Commands|19

Request Syntax

cliq clearDnsInfo login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

Example

cliq clearDnsInfo login=10.0.1.3 userName=admin passWord=secret cliq clearDnsInfo

clearEmailServerInfo

This command clears the email server settings.

Availability: Windows, SAN/iQ

Version: 9.0

Request Syntax

cliq clearEmailServerInfo login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

Example

cliq clearEmailServerInfo login=10.0.1.3 userName=admin passWord=secret

cliq clearEmailServerInfo

clearSnmpNotifyPolicy

This command clears the SNMP Notification Policy settings.

Availability: Windows, SAN/iQ

Version: 9.0

Request Syntax

cliq clearSnmpNotifyPolicy login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

20|HP P4000 CLI|Commands

parameters)

Example

cliq clearSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secret

cliq clearSnmpNotifyPolicy

clearSnmpServiceInfo

This command clears the SNMP Server Info.

Availability: Windows, SAN/iQ

Version: 9.0

Request Syntax

cliq clearSnmpServiceInfo login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

Example

cliq clearSnmpServiceInfo login=10.0.1.3 userName=admin passWord=secret

cliq clearSnmpServiceInfo

clearVssVolumeFlags

This command resets snapshot flags in the vss volume.

Availability: Windows

Version: 8.5

Request Syntax

cliq clearVssVolumeFlags volumeName=

volumeName Required The name of the volume

Example

cliq clearVssVolumeFlags volumeName=x:

cloneSnapshot

This command creates one or more SmartClone volumes from a SAN/iQ snapshot. These SmartClone volumes have all the functionality of normal volumes.

Availability: Windows, SAN/iQ

HP P4000 CLI|Commands|21

Version: 8.0

Request Syntax

cliq cloneSnapshot snapshotName= volumeName= login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

snapshotName Required The name of the remote snapshot

volumeName Required The name of the volume

Example

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

cliq cloneSnapshot snapshotName=Snapshot1 volumeName=MyClone1;MyClone2

configureRaid

This command reconfigures the RAID setting on a storage system.

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

cliq configureRaid configuration= login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

configuration Required The RAID type to set. The possible RAID levels are reported in the getNsmInfo call.

Example

cliq configureRaid configuration="RAID10" login=10.0.1.2 userName=admin passWord=secret

connectVolume

This command connects an already present array volume to an application server host.

Availability: Windows

Version: 8.0

Request Syntax

22|HP P4000 CLI|Commands

cliq connectVolume volumeName= login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

volumeName Required The name of the volume

Example

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

convertSnapshotTempSpace

This command converts snapshot temporary space to a volume.

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

cliq convertSnapshotTempSpace snapshotName= volumeName= login= userName= passWord=

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

volumeName Required The name of the volume

snapshotName Required The name of the remote snapshot

Example

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

cliq convertSnapshotTempSpace snapshotName=MySnapshot volumeName=NewVolume

createAdminGroup

This command creates an administrative group.

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

cliq createAdminGroup login= userName= passWord= description= adminGroupName= adminUserName= permissions=

HP P4000 CLI|Commands|23

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

adminGroupName Required The administrative group name

description Optional Optional description

adminUserName Optional Specifies the users that this group comprises

permissions Optional Permissions for the group. This is a character sequence specifying the allowable

permissions in the following order: Group,Network,Storage System,Report. The Password permissions are subsumed by the Group permissions.For each group, the allowable permissions are: r - read-only, w - read-write (Report does not support this), f

- full-access (Report does not support this)For example:Note: if this is not specified, the permissions are set to rrrr

Example

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

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

createAdminUser

This command creates an administrative user.

Availability: Windows, SAN/iQ

Version: 8.0

Request Syntax

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

keyFile Required The encrypted key file (this is specified instead of the username and password

parameters)

adminUserName Required Specifies the users that this group comprises

adminPassWord Required The password for the administrative user

description Optional Optional description

adminGroupName Optional The administrative group name

Example

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

cliq createAdminUser description="My shiny new user" adminUserName=user adminPassWord=secret

24|HP P4000 CLI|Commands

+ 56 hidden pages

HP StoreVirtual VSA Software User Manual

Contents

Overview

Global Parameters

Syntax

Return Codes

Commands

addVirtualManager

assignVolume

assignVolumeChap

assignVolumeToServer

cacheCredentials

cancelRemoteSnapshot

clearAlertsPolicy

clearCredentials

clearDnsInfo

clearEmailServerInfo

clearSnmpNotifyPolicy

clearSnmpServiceInfo

clearVssVolumeFlags

cloneSnapshot

configureRaid

connectVolume

convertSnapshotTempSpace

createAdminGroup

createAdminUser