HP P4000 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual
HP P4000 Manual
View all HP P4000 manuals
Add to My Manuals
Save this manual to your list of manuals |
HP P4000 manual content summary:
- HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 1
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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 2
commands...8 Size specification...8 Password prompt...8 Key file ...9 DNS names ...9 Storage System CLI...9 Integrated command shell...9 Global parameters...10 prompt=...10 output= ...10 separator= ...10 inputFile= ...10 Commands ...11 addVirtualManager ...12 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 3
connectVolume ...29 convertSnapshotTempSpace ...30 createAdminGroup ...31 createAdminUser ...33 createCluster ...34 createEmailNotifyPolicy ...35 createGroup ...37 createKey ...38 createRemoteAssociation ...39 createRemoteSnapshot ...41 createServer ...43 createSite ...45 createSnapshot ...46 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 4
disconnectLocalVolume ...70 discoverTcp ...71 discoverUdp ...72 getAlertLog ...73 getClusterInfo ...74 getDnsInfo ...75 getEventLog ...76 getGroupInfo ...78 getLocalVolumes ...79 getNotificationPolicy ...80 getNsmInfo ...81 getNsmLogs ...82 getPerformanceStats ...83 getRemoteSnapshotInfo ...84 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 5
modifyRemoteSnapshotSchedule 110 modifyServer ...111 modifySite ...113 modifySnapshot...114 modifySnapshotSchedule ...115 modifySnmpCommunityString...116 modifySnmpTrapTarget ...117 modifySyslogNotifyPolicy ...118 modifyVolume ...119 provisionVolume...121 rebalanceVip ...123 recoverQuorum ...124 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 6
unassignVolumeToServer ...147 vssSnapshot ...148 waitForEvent ...150 waitForUpdate...151 Return Codes ...152 6 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 7
(CLI) for the HP P4000 Storage Solution. The CLI specifies parameters in the form parameter passWord=secret login=10.1.2.3 is equivalent to cliq deleteVolume login=10.1.2.3 passWord= the caller, and impose this on the newly created volume. True/False Any parameter that indicates true/false, may - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 8
For example: volumeName=volume1;volume2 login=10.0.1.2;10.1.2.3;10.2.3.4 If a parameter contains fewer elements 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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 9
=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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 10
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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 11
Commands The following section lists the commands supported 11 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 12
addVirtualManager This command adds a virtual manager to a group. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 13
volume, based on host iqn(s). Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password the volume r - read-only w - write-only rw - read-write (default) - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 14
Remove any previous server access rights to this volume. This can be one of: 0 1 - default Example Command: cliq assignVolume volumeName=TheVolume initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.lefthandnetworks.com login=10.0.1.2 userName=admin passWord=secret 14 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 15
. This assignment sets the access to a volume, using CHAP authentication. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 16
for this host. This can be one of: 0 1 - default exclusiveAccess Remove any previous server access rights to this volume. This can be one of: 0 1 - default Example Command: cliq assignVolumeChap volumeName=TheVolume targetSecret=HolyHandGrenade login=10.0.1.2 userName=admin passWord=secret 16 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 17
of the volume serverName The name of the server Optional Parameters: accessRights The access rights to the volume r - read-only w - write-only rw - read-write (default) Example Command: cliq assignVolumeToServer volumeName=TheVolume serverName=TheServer login=10.0.1.2 userName=admin passWord=secret - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 18
cacheCredentials This command caches the management group credentials and IP addresses in the registry. Availability: Windows Required Parameters: userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is specified instead of the - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 19
snapshot. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems. This is the login information for the remote group containing the specified snapshot. userName The authentication user name for the group passWord The password - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 20
Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems. This is the login information for the remote group containing the specified snapshot. userName The authentication user name for the group passWord The password for the - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 21
clearCredentials This command removes the management group credentials from the cache. Availability: Windows Required Parameters: groupName The name of the group Optional Parameters: none Example Command: cliq clearCredentials groupName=TheGroup 21 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 22
This command clears the DNS settings. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 23
This command clears the email server settings. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 24
clears the SNMP Notification Policy settings. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 25
This command clears the SNMP Server Info. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 26
clearVssVolumeFlags This command resets snapshot flags in the vss volume. Availability: Windows Required Parameters: volumeName The name of the volume Optional Parameters: none Example Command: cliq clearVssVolumeFlags volumeName=x: 26 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 27
from a SAN/iQ snapshot. These SmartClone volumes have all the functionality of normal volumes. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 28
configureRaid This command reconfigures the RAID setting on a storage system. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password for the storage system - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 29
command connects an already present array volume to an application server host. Availability: Windows Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 30
convertSnapshotTempSpace This command converts snapshot temporary space to a volume. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 31
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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 32
Example Command: cliq createAdminGroup login=10.0.1.3 userName=admin passWord=secret description="My shiny new group" adminGroupName=PowerUsers adminUserName=user1;user2 permissions=fffr 32 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 33
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password user Example Command: cliq createAdminUser login=10.0.1.3 userName=admin passWord=secret description="My shiny new user - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 34
This command creates a cluster in a management group. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 35
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password (default 0) 0 - the log does not includes warning events 1 - the log includes warning events alertOnCritical (default 0) - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 36
emailLocale (default English (United States)) English Chinese Japanee Korean Example Command: cliq createEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret [email protected] verbosity=1 36 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 37
. Availability: Windows, SAN/iQ Required Parameters: node The IP address or DNS-resolvable name of one or more storage systems groupName The name of the group userName The authentication user name for the new management group passWord The password for the new management group Optional Parameters - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 38
to be created login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group Optional Parameters: none Example Command: cliq createKey login=10.0.1.2 userName=admin passWord=secret keyFile=c:.key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 39
when a remote snapshot is created, so this command is not usually needed. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 40
Optional Parameters: none Example Command: cliq createRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin remotePassWord=secret primaryBandwidth=10Mb remoteBandwidth=10Mb 40 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 41
This command creates a remote snapshot of one or more SAN/iQ volumes. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 42
Optional Parameters: description The description of the remote snapshot primaryBandwidth The remote copy bandwidth to the primary group second) Example Command: cliq createRemoteSnapshot login=10.1.2.3 userName=admin passWord=secret primarySnapshot=Snapshot0 remoteSnapshot=Snapshot0 remoteVolume= - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 43
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password of 0 1 - default vipLoadBalance Use VIP load balancing for this host. This can be one of: 0 1 - default useCHAP Use CHAP - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 44
. initiatorSecret The CHAP initiator secret for this host. Example Command: cliq createServer serverName=TheServer useChap=0 initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.lefthandnetworks.com login=10.0.1.2 userName=admin passWord=secret 44 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 45
username and password parameters) siteName The name of the site Optional Parameters: description Description for the site primary This site is the primary site. This can be one of: 0 1 - default Example Command: cliq createSite siteName=Headquarters login=10.0.1.2 userName=admin passWord=secret 45 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 46
will not attempt to use VSS on the host connected to the volume (default) 1 - the snapshot(s) will attempt to use VSS on the host connected to the volume Example Command: cliq createSnapshot volumeName=volume0;volume1 snapshotName=snapshot0;snapshot1 login=10.0.1.2 userName=admin passWord=secret 46 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 47
This command creates a local or remote snapshot schedule. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 48
must be specified. Example Command: 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" 48 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 49
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password createSnmpCommunityString login=10.0.1.3 userName=admin passWord=secret ipAddress=10.0.10.25 communityString=NewString 49 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 50
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password : cliq createSnmpTrapTarget login=10.0.1.3 userName=admin passWord=secret ipAddress=10.0.10.25 version=1 communitystring - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 51
warning events 1 - the log includes warning events alertOnCritical (default 0) 0 - the log does not includes critical events 1 - the log includes critical events Example Command: cliq createSyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ipAddress="10.0.10.25" alertOnCritical="1" 51 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 52
createVolume This command creates a SAN volume without connecting to a host. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 53
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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 54
This command deletes an administrative group. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 55
This command deletes an administrative user. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 56
a cluster. All storage systems are removed. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 57
command deletes an Email Notification Policy. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 58
This command deletes a management group. All storage systems are removed. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 59
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password : cliq deleteRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 60
deleteServer This command deletes a Server. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 61
This command deletes a site in a multi-site SAN. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 62
deleteSnapshot This command deletes a snapshot. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 63
This command deletes a previously created snapshot schedule. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 64
deleteSnapshotTempSpace This command deletes the snapshot temporary space. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 65
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for Example Command: cliq deleteSnmpCommunityString ipAddress=10.0.10.25 login=10.1.2.3 userName=admin passWord=secret 65 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 66
This command deletes an SNMP Trap Target. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 67
This command deletes a Syslog Notification Policy. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 68
deleteVirtualManager This command deletes a virtual manager from a group. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 69
command forcibly deletes a SAN volume without disconnecting from the host. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 70
disconnectLocalVolume This command disconnects a SAN volume from the host. Availability: Windows Required Parameters: volumeName The name of the volume from the host perspective Optional Parameters: none Example Command: cliq disconnectLocalVolume volumeName=z: 70 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 71
systems and management groups on the network, using TCP. Availability: Windows, SAN/iQ Required Parameters: node One or more IP addresses or DNS-resolvable names to attempt to find Optional Parameters: groupOrder Return storage systems ordered by group membership. This can be one of: 0 - default - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 72
This command discovers storage systems and management groups on the network, using UDP. Availability: Windows, SAN/iQ Required Parameters: ipMask An IP This can be one of: 0 - default 1 receivePort The UDP port to receive the discovery packets (defaults to an unused port if unspecified) waitForData - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 73
userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is specified instead of the username and password parameters) Optional Parameters: none Example Command: cliq getAlertLog login=10.1.2.3 userName=admin passWord=secret 73 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 74
, volumes, snapshots and remote snapshots (default) verbose How much information to return 0 - Get summary information only (better performance) 1 - Get all information (better information - default) Example Command: cliq getClusterInfo clusterName=Cluster0 login=10.1.2.3 userName=admin passWord - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 75
getDnsInfo This command gets the DNS settings. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 76
getEventLog This command returns event information. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file ( - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 77
Manager VirtualManager Store SnapshotSchedule Volume Snapshot system System filter. This can be one or more of: System Controller Cache Disk Boot Backplane Fan Temperature Voltage PowerSupply RAID source Source filter, source name user User filter, user name Example Command: cliq getEventLog login - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 78
Groups, clusters, volumes, snapshots and remote snapshots (default) verbose How much information to return 0 - Get summary information only (better performance) 1 - Get all information (better information - default) Example Command: cliq getGroupInfo login=10.1.2.3 userName=admin passWord=secret 78 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 79
getLocalVolumes This command returns information about connected volumes hosted by the HP P4000 array. Availability: Windows Required Parameters: none Optional Parameters: none Example Command: cliq getLocalVolumes 79 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 80
Notification Policy, and Email Server Setting. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password for the storage system keyFile The encrypted key file - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 81
command returns information about a storage system. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password for the storage system keyFile The encrypted key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 82
the storage system keyFile The encrypted key file (this is specified instead of the username and password parameters) logFile The name of the local file for the log archive Optional Parameters: none Example Command: cliq getNsmLogs login=10.1.2.3 userName=admin passWord=secret logFile=c:.tar.gz 82 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 83
getPerformanceStats This command returns performance monitoring statistics. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password for the storage system - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 84
snapshots in the group are returned verbose How much information to return 0 - Get summary information only (better performance) 1 - Get all information (better information - default) Example Command: cliq getRemoteSnapshotInfo snapshotName=snapshot0 login=10.1.2.3 userName=admin passWord=secret - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 85
getScsiInfo This command returns SCSI inquiry information about a locally connected volume. Availability: Windows Required Parameters: volumeName The name of the volume as mounted on the host. Optional Parameters: none Example Command: cliq getScsiInfo volumeName=z: 85 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 86
(Vmware, Citrix, Hyper-V), and Server information. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of the application server userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 87
permission settings for servers to connect to SAN/iQ volumes. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of the application server userName The authentication user name for the group passWord The password for the group keyFile The encrypted key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 88
a remote server. This will return VSS associated volumes. Availability: Windows, SAN/iQ Required Parameters: login Contains authentication information about an application server userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 89
This command returns site information on multi-site SANs. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 90
2 - Snapshots and remote snapshots (default) verbose How much information to return 0 - Get summary information only (better performance) 1 - Get all information (better information - default) Example Command: cliq getSnapshotInfo snapshotName=snapshot0 login=10.1.2.3 userName=admin passWord=secret - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 91
This command returns information about snapshot schedules. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 92
command returns information about the SNMP Service and Targets. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password for the storage system keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 93
management group, then only logs from the storage system will be collected. This command stores the archive locally. Availability: Windows Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 94
getSystemInfo This command returns version information about the API, and other dependent libraries. Availability: Windows, SAN/iQ Required Parameters: none Optional Parameters: none Example Command: cliq getSystemInfo 94 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 95
- Volumes, snapshots and remote snapshots (default) verbose How much information to return 0 - Get summary information only (better performance) 1 - Get all information (better information - default) Example Command: cliq getVolumeInfo volumeName=volume0 login=10.1.2.3 userName=admin passWord=secret - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 96
help This command returns information about the currently supported API command set. Availability: Windows, SAN/iQ Required Parameters: none Optional Parameters: command A specific command for more detailed help information Note: if help is specified with no parameters, a list of possible - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 97
: MB - n Megabytes (1024 Kilobytes) GB - n Gigabytes (1024 Megabytes) TB - n Terabytes (1024 Gigabytes) Optional Parameters: size snapshot is used for the volume size.) Example Command: cliq makePrimary login=10.1.2.3 userName=admin passWord=secret volumeName="TheVolume" size=1GB 97 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 98
This command demotes a primary volume to a remote snapshot target. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 99
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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 100
Example Command: cliq modifyAdminGroup login=10.0.1.3 userName=admin passWord=secret description="My shiny new group" adminGroupName=PowerUsers adminUserName=user1;user2 permissions=fffr 100 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 101
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password The password for the administrative user Example Command: cliq modifyAdminUser login=10.0.1.3 userName=admin passWord= - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 102
This command changes settings on a cluster. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 103
Example Command: 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; 103 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 104
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password (default 0) 0 - the log does not includes warning events 1 - the log includes warning events alertOnCritical (default 0) - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 105
Example Command: cliq modifyEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret emailAddress="[email protected]' verbosity="2" 105 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 106
group comprises bandwidthPriority The manager bandwidth Kb - Kilobits/sec (1000 Bits/second) Mb - Megabits/sec (1000 Kilobits/second) Gb - Gigabits/sec (1000 Megabits/second) customerName Customer name supportId Support ID provided by HP P4000 contactName Contact name postalAddress Postal - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 107
cityName Postal city stateName Postal state countryName Postal country postalCode Postal code telephoneNumber Contact telephone number emailAddress Contact email address Example Command: cliq modifyGroup login=10.0.1.2 userName=admin passWord=secret node=10.0.1.2;10.0.1.3 107 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 108
This command modifies a previously created remote volume association. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 109
Example Command: cliq modifyRemoteAssociation login=10.0.1.2 userName=admin passWord=secret remote=10.0.1.3 remoteUserName=admin remotePassWord=secret remoteBandwidth=10Mb 109 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 110
command modifies a previously created remote snapshot schedule. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 111
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password of 0 1 - default vipLoadBalance Use VIP load balancing for this host. This can be one of: 0 1 - default useCHAP Use CHAP - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 112
. initiatorSecret The CHAP initiator secret for this host. Example Command: cliq modifyServer serverName=TheServer useChap=0 initiator=iqn.1991-05.com.microsoft:w-gregorio.corp.lefthandnetworks.com login=10.0.1.2 userName=admin passWord=secret 112 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 113
SAN. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password siteName=TheSite description="My Site" login=10.0.1.2 userName=admin passWord=secret 113 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 114
modifySnapshot This command modifies snapshot settings. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 115
This command modifies a previously created snapshot schedule. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 116
modifies the Community String for all SNMP. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 117
This command modifies an SNMP Trap Target. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 118
warning events 1 - the log includes warning events alertOnCritical (default 0) 0 - the log does not includes critical events 1 - the log includes critical events Example Command: cliq modifySyslogNotifyPolicy login=10.0.1.3 userName=admin passWord=secret ipAddress="10.0.10.25" alertOnInfo="1" 118 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 119
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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 120
the the default may impact application server performance. minReplication values of 3 and 4 are experimental and have not been fully regression tested. Use at your own risk. Example Command: cliq modifyVolume description="New Description" login=10.0.1.2 userName=admin passWord=secret volumeName - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 121
provisionVolume This command creates a volume and connects it to the host. Availability: Windows Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 122
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 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 123
rebalances the connections to a volume when using a virtual IP address. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 124
servers that are offline will be ejected from the management group and cluster(s). Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 125
name for the group passWord The password for the group keyFile The encrypted key file (this is specified instead of the username and password parameters) snapshotName The name of the snapshot Optional Parameters: none Example Command: cliq removeSnapshot snapshotName=z: login=10.0.1.2 userName=admin - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 126
the group passWord The password for the group keyFile The encrypted key file (this is specified instead of the username and password parameters) volumeName The name of the volume Optional Parameters: none Example Command: cliq removeVolume volumeName=z: login=10.0.1.2 userName=admin passWord=secret - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 127
associated with a volume. Some initiators will attempt to reconnect after the reset. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 128
: 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. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 129
runs one or all storage system diagnostics. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password for the storage system keyFile The encrypted key file - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 130
and Events Policy. This item is a singleton. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file (this is - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 131
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password Command: cliq setDnsInfo login=10.0.1.3 userName=admin passWord=secret server=10.23.0.101 suffix=suffix1;suffix2 domainname - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 132
SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password : cliq setEmailServerInfo login=10.0.1.3 userName=admin passWord=secret ipAddress=10.23.0.101 portNumber=2309 email= - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 133
group keyFile The encrypted key file (this is specified instead of the username and password parameters) node A list of IP addresses for the managers in the group Optional Parameters: none Example Command: cliq setGossipList login=10.0.1.2 userName=admin passWord=secret node=10.0.1.3;10.0.1.4 133 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 134
group keyFile The encrypted key file (this is specified instead of the username and password parameters) licenseKey Licensekey purchased from HP Example Command: cliq setLicenseKey login=10.0.1.2 userName=admin passWord=secret licenseKey=0447-10AB-A698-AB5A-318D-86B0-FAA8-454A-63B7-3B2B-00F5-11F5 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 135
not includes warning events 1 - the log includes warning events alertOnCritical (default 0) 0 - the log does not includes critical events 1 - the log includes critical events Example Command: cliq setSnmpNotifyPolicy login=10.0.1.3 userName=admin passWord=secret verbosity=1 alertOnCritical=1 135 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 136
sets information about the SNMP Service. This item is a singleton. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 137
This command forces a soft shutdown of a management group. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 138
SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password (defaults to 0) Example Command: cliq shutdownNsm action=Restart delay=10 login=10.0.1.2 userName=admin passWord=secret 138 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 139
startManager This command starts the manager on a storage system. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 140
startSnmpService This command starts the SNMP Service. Availability: Windows, SAN/iQ Required Parameters login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 141
This command starts a virtual manager on a storage system. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 142
stopManager This command stops the manager on a storage system. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 143
stopSnmpService This command stops the SNMP Service. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file ( - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 144
This command stops a virtual manager on a storage system. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 145
This command tests the login credentials for a management group. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 146
unassignVolume This command disassociates a volume from all servers. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 147
the volume serverName The name of the server Optional Parameters: accessRights The access rights to the volume r - read-only w - write-only rw - read-write (default) Example Command: cliq unassignVolumeToServer volumeName=TheVolume serverName=TheServer login=10.0.1.2 userName=admin passWord=secret - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 148
Parameters: volumeName The list of volumes to snapshot persistent Is the snapshot persistent? This can be one of: 0 1 - default transportable Is the snapshot transportable? This can be one of: 0 - default 1 backupDoc The name of the backup document file writerInfo Display information about VSS - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 149
as a mount point or drive letter - the format of this is mountShadow=";" breakShadowCopies Break the shadow copy set snapshotName The list of snapshot names userName The authentication user name for the group passWord The authentication user password for the group description - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 150
waits for an alert or event message. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable name of a storage system userName The authentication user name for the storage system passWord The password for the storage system keyFile The encrypted key file (this - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 151
on a change to the state in the management group. Availability: Windows, SAN/iQ Required Parameters: login The IP address or DNS-resolvable names of one or more storage systems userName The authentication user name for the group passWord The password for the group keyFile The encrypted key file - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 152
. 3 CliqOperationAbandoned Operation was intentionally cancelled or abandoned. 4 CliqNothingFound Nothing was found. 5 CliqSnapshotSet This snapshot was a part of the snapshot set. 6 CliqVssSnapshotWarning Warning: The writer operation failed. 128 CliqUnexpected An unexpected error has occurred. 129 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 153
other. 137 CliqNotYetImplemented This is a legal command - we just haven't done it yet. 138 CliqNoMemory Out of memory. 139 CliqVolumeNotFound Could not find the requested volume. 140 CliqVolumeInUse 153 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 154
use. 141 CliqVolumeInitFailure Volume initialization failed. 142 CliqUnrecognizedVolume The volume is an unrecognized type. 143 CliqOperationFailed General SAN/iQ error - the space to complete the command. 149 CliqNoManager Could not find a manager. 150 CliqSocketError Network socket error. 154 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 155
operating system type does not support the operation. 153 CliqIncorrectOsVersion This operating system version does not support the operation. 154 CliqUtilityNotFound The must be 3..40 characters, starting with a letter. 160 CliqIllegalPassword The password must be 5..40 characters, not / or :. 155 - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 156
the last user from the default administration group. 166 CliqVssProviderNotInstalled The HP P4000 VSS Provider is not installed. 167 CliqVssProviderNotRunning The HP P4000 VSS Provider is not running. 168 CliqVolumeNoSessions Cannot create an application-managed snapshot because there are no iSCSI - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 157
installed and running.) 170 CliqNoVssCapabilities Cannot create an application-managed snapshot because the server does not support this capability. 171 CliqServerUnresponsive Cannot create an application-managed snapshot because the system could not communicate to the necessary software component - HP P4000 | 9.0 HP StorageWorks P4000 SAN/iQ Command-Line Interface User Manual - Page 158
VSS operation timed out. 179 CliqVolumeConnectionFailure Volume connection failure. 158
AX696-96026
November 2010
CLIQ
The SAN/iQ Command-Line Interface
User Guide
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>
Commands