HP P4000 User Manual
HP P4000 User Manual

HP P4000 User Manual

Command-line interface
Hide thumbs Also See for P4000:
Table of Contents

Advertisement

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>
AX696-96026
.
Commands
November 2010

Advertisement

Table of Contents
loading

Summary of Contents for HP P4000

  • Page 1: User Guide

    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.
  • Page 2: Table Of Contents

    Syntax ........................... 7 Parameter ordering ........................7 Case sensitivity ..........................7 True/False .............................7 Command abbreviation ........................7 OS error code integration .......................7 Composite commands ........................8 Size specification..........................8 Password prompt ...........................8 Key file ............................9 DNS names ............................9 Storage System CLI .........................9 Integrated command shell ......................9 Global parameters .......................
  • 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 createSnapshotSchedule ......................47 createSnmpCommunityString .......................
  • 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 getScsiInfo ...........................
  • 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 removeSnapshot ........................125 removeVolume .......................... 126 resetSession ..........................
  • Page 6 unassignVolumeToServer ......................147 vssSnapshot ..........................148 waitForEvent ..........................150 waitForUpdate ........................... 151 Return Codes ........................152...
  • Page 7: Syntax

    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...
  • Page 8: Composite Commands

    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.
  • Page 9: Key File

    SAN/iQ Command Line Interface, v9.0 (type exit to quit) (C) Copyright 2007-2009 Hewlett-Packard Development Company, L.P. CLIQ> The integrated shell supports rich command line editing features specific to the HP P4000 API. The following editing keys are supported: Meaning LEFT Moves the cursor one space to the left.
  • Page 10: Global Parameters

    Global parameters prompt=<true | false> Some potentially destructive commands prompt before proceeding. This default behavior can be turned off by specifying "prompt=false". output=<XML | Normal> In the default case, the CLI returns information to standard output, formatted in a way that's easy to read rather than easy to parse.
  • Page 11: Commands

    Commands The following section lists the commands supported...
  • Page 12: Addvirtualmanager

    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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 13: Assignvolume

    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 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...
  • Page 14 Remove any previous server access rights to this volume. This can be one of: 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...
  • Page 15: Assignvolumechap

    assignVolumeChap This command assigns a volume to a server. 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...
  • Page 16 vipLoadBalance Use VIP load balancing for this host. This can be one of: 1 - default exclusiveAccess Remove any previous server access rights to this volume. This can be one of: 1 - default Example Command: cliq assignVolumeChap volumeName=TheVolume targetSecret=HolyHandGrenade login=10.0.1.2 userName=admin passWord=secret...
  • Page 17: Assignvolumetoserver

    assignVolumeToServer This command assigns a volume to 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 specified instead of the username and password parameters) volumeName...
  • Page 18: Cachecredentials

    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 username and password parameters) groupName The name of the group Optional Parameters:...
  • Page 19: Cancelremotesnapshot

    cancelRemoteSnapshot This command cancels a remote 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 for the group keyFile...
  • Page 20: Clearalertspolicy

    clearAlertsPolicy This command clears the Alerts and Events Policy information 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...
  • Page 21: Clearcredentials

    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...
  • Page 22: Cleardnsinfo

    clearDnsInfo 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 is specified instead of the username and password parameters) Optional Parameters: none...
  • Page 23: Clearemailserverinfo

    clearEmailServerInfo 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 is specified instead of the username and password parameters) Optional Parameters:...
  • Page 24: Clearsnmpnotifypolicy

    clearSnmpNotifyPolicy This command 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 is specified instead of the username and password parameters) Optional Parameters:...
  • Page 25: Clearsnmpserviceinfo

    clearSnmpServiceInfo 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 specified instead of the username and password parameters) Optional Parameters:...
  • Page 26: Clearvssvolumeflags

    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:...
  • Page 27: Clonesnapshot

    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 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...
  • Page 28: Configureraid

    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 keyFile The encrypted key file (this is specified instead of the username and password parameters) configuration...
  • Page 29: Connectvolume

    connectVolume This 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 encrypted key file (this is specified instead of the username and password parameters)
  • Page 30: Convertsnapshottempspace

    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 keyFile The encrypted key file (this is specified instead of the username and password parameters) volumeName...
  • Page 31: Createadmingroup

    createAdminGroup This command creates 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 is specified instead of the username and password parameters) adminGroupName The administrative group name...
  • 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...
  • Page 33: Createadminuser

    createAdminUser This command creates 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 is specified instead of the username and password parameters) adminUserName The administrative user name...
  • Page 34: Createcluster

    createCluster 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 file (this is specified instead of the username and password parameters) clusterName...
  • Page 35: Createemailnotifypolicy

    createEmailNotifyPolicy This command creates 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 is specified instead of the username and password parameters) emailAddress...
  • Page 36 emailLocale (default English (United States)) English Chinese Japanee Korean Example Command: cliq createEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret emailAddress=myemail@myhost.com verbosity=1...
  • Page 37: Creategroup

    createGroup This command creates a new management group. This command may take several minutes to complete. 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...
  • Page 38: Createkey

    createKey This command creates an encrypted key file that can be used to specify credentials instead of username/password. Availability: Windows Required Parameters: keyFile The name for the key file 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...
  • Page 39: Createremoteassociation

    createRemoteAssociation This command creates a remote group-to-primary group association. This association is done automatically when a remote snapshot is created, so this command is not usually needed. 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...
  • 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...
  • Page 41: Createremotesnapshot

    createRemoteSnapshot 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 encrypted key file (this is specified instead of the username and password parameters)
  • Page 42 remoteSnapshot The name of the remote snapshot to create Optional Parameters: description The description of the remote snapshot primaryBandwidth The remote copy bandwidth to the primary group (this is at the group level) <n>Kb - Kilobits/sec (1000 Bits/second) <n>Mb - Megabits/sec (1000 Kilobits/second) <n>Gb - Gigabits/sec (1000 Megabits/second) remoteBandwidth The remote copy bandwidth to the remote group (this is at the group level)
  • Page 43: Createserver

    createServer This command creates 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 specified instead of the username and password parameters) serverName The name of the server Optional Parameters:...
  • Page 44 chapName The CHAP name for this host. targetSecret The CHAP target secret for this host. 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...
  • Page 45: Createsite

    createSite This command creates 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 is specified instead of the username and password parameters) siteName...
  • Page 46: Createsnapshot

    createSnapshot This command creates a 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 encrypted key file (this is specified instead of the username and password parameters) volumeName...
  • Page 47: Createsnapshotschedule

    createSnapshotSchedule 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 file (this is specified instead of the username and password parameters) volumeName...
  • Page 48 How long snapshots should be retained. Either retentioncount or retentionseconds must be specified. remotegroupip The IP address of the remote group. remoteCluster The name of the remote cluster this parameter is required if remotegroupip is specified remoteVolume The name of the remote volume to snapshot - this parameter is required if remotegroupip is specified remoteretentioncount The number of remote snapshots to maintain.
  • Page 49: Createsnmpcommunitystring

    createSnmpCommunityString This command creates an SNMP Community String. The Community String must be the same for all. If no item exists, the Community String is used, otherwise it is ignored and the Community String of existing items is used. Either specify IPAddress (ip address or hostname) or an IP mask and IP Subnet.
  • Page 50: Createsnmptraptarget

    createSnmpTrapTarget This command creates an SNMP Trap Target. The Community String must be the same for all Trap Targets. If no Trap Targets exists, the Community String is used, otherwise it is ignored and the Community String of existing Trap Targets is used. Availability: Windows, SAN/iQ Required Parameters: login...
  • Page 51: Createsyslognotifypolicy

    createSyslogNotifyPolicy This command creates 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 (this is specified instead of the username and password parameters) ipAddress...
  • Page 52: Createvolume

    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 The encrypted key file (this is specified instead of the username and password parameters) volumeName...
  • Page 53 The number of parity storage systems for the data on this volume. This enables parity network RAID on the volume. Replication and parity are supported in the following combinations: replication:1, parity:0 Network RAID-0 (None) replication:2, parity:0 Network RAID-10 (2-way Mirror) replication:3, parity:0 Network RAID-10+1 (3-way Mirror) replication:4, parity:0 Network RAID-10+2 (4-way Mirror) replication:2, parity:1 Network RAID-5 (Single parity)
  • Page 54: Deleteadmingroup

    deleteAdminGroup 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 is specified instead of the username and password parameters) adminGroupName The administrative group name...
  • Page 55: Deleteadminuser

    deleteAdminUser 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 is specified instead of the username and password parameters) adminUserName The administrative user name...
  • Page 56: Deletecluster

    deleteCluster This command deletes 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 specified instead of the username and password parameters) clusterName...
  • Page 57: Deleteemailnotifypolicy

    deleteEmailNotifyPolicy This 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 is specified instead of the username and password parameters) emailAddress...
  • Page 58: Deletegroup

    deleteGroup 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 The encrypted key file (this is specified instead of the username and password parameters) groupName...
  • Page 59: Deleteremoteassociation

    deleteRemoteAssociation This command deletes a remote group to primary group 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 encrypted key file (this is specified instead of the username and password parameters) remote...
  • Page 60: Deleteserver

    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 specified instead of the username and password parameters) serverName The name of the server.
  • Page 61: Deletesite

    deleteSite 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 is specified instead of the username and password parameters) siteName...
  • Page 62: Deletesnapshot

    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 is specified instead of the username and password parameters) snapshotName The name of the snapshot Optional Parameters:...
  • Page 63: Deletesnapshotschedule

    deleteSnapshotSchedule 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 key file (this is specified instead of the username and password parameters) scheduleName...
  • Page 64: Deletesnapshottempspace

    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 The encrypted key file (this is specified instead of the username and password parameters) snapshotName...
  • Page 65: Deletesnmpcommunitystring

    deleteSnmpCommunityString This command deletes an SNMP CommunityString. Either specify an IP Address (as IP Address or Hostname) or IP Mask and IP Subnet. Availability: Windows, SAN/iQ 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...
  • Page 66: Deletesnmptraptarget

    deleteSnmpTrapTarget 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 specified instead of the username and password parameters) ipAddress...
  • Page 67: Deletesyslognotifypolicy

    deleteSyslogNotifyPolicy 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 (this is specified instead of the username and password parameters) ipAddress...
  • Page 68: Deletevirtualmanager

    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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 69: Deletevolume

    deleteVolume This 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 The encrypted key file (this is specified instead of the username and password parameters)
  • Page 70: Disconnectlocalvolume

    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:...
  • Page 71: Discovertcp

    discoverTcp This command discovers storage 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 receivePort The TCP port to receive the discovery packets (defaults to an unused port if unspecified)
  • Page 72: Discoverudp

    discoverUdp This command discovers storage systems and management groups on the network, using UDP. Availability: Windows, SAN/iQ Required Parameters: ipMask An IP address mask for UDP discovery ipSubnet An IP address subnet for UDP discovery Optional Parameters: groupOrder Return storage systems ordered by group membership. This can be one of: 0 - default receivePort The UDP port to receive the discovery packets (defaults to an unused port if unspecified)
  • Page 73: Getalertlog

    getAlertLog This command returns Alerts.log information. 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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters: none Example Command:...
  • Page 74: Getclusterinfo

    getClusterInfo This command returns information about 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 specified instead of the username and password parameters) Optional Parameters:...
  • Page 75: Getdnsinfo

    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 is specified instead of the username and password parameters) Optional Parameters: none...
  • Page 76: Geteventlog

    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 (this is specified instead of the username and password parameters) Optional Parameters: type Event type.
  • Page 77 component Component filter. This can be one or more of: Saniq severity Severity filter. This can be one or more of: Info Warning Critical object Object filter. This can be one or more of: MgmtGroup RemoteMgmtGroup Cluster Manager VirtualManager Store SnapshotSchedule Volume Snapshot...
  • Page 78: Getgroupinfo

    getGroupInfo This command returns information about 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 file (this is specified instead of the username and password parameters) Optional Parameters:...
  • 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...
  • Page 80: Getnotificationpolicy

    getNotificationPolicy This command returns information about the Alerts and Events Policy, Email Notification Policy, Syslog 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...
  • Page 81: Getnsminfo

    getNsmInfo This 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 file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 82: Getnsmlogs

    getNsmLogs This command gathers all log files from a storage system and 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 password for the storage system keyFile...
  • Page 83: Getperformancestats

    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 keyFile The encrypted key file (this is specified instead of the username and password parameters) Optional Parameters: interval...
  • Page 84: Getremotesnapshotinfo

    getRemoteSnapshotInfo This command returns information about remote snapshots. 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 specified instead of the username and password parameters) snapshotName...
  • Page 85: Getscsiinfo

    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:...
  • Page 86: Getservercapabilities

    This will interrogate a remote server for its HP P4000 integration capabilities. If this call succeeds, the actual capabilities will be returned. The only acceptable result here is VSS Snapshot Integration. For anticipated future releases, this may also include information about virtual machine hosting (Vmware, Citrix, Hyper-V), and Server information.
  • Page 87: Getserverinfo

    getServerInfo This will return information about server objects, which contain 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...
  • Page 88: Getservervolumeinfo

    getServerVolumeInfo This command returns the features of a volume by interrogating a remote server. This will return VSS associated volumes. Availability: Windows, SAN/iQ 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...
  • Page 89: Getsiteinfo

    getSiteInfo 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 file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 90: Getsnapshotinfo

    getSnapshotInfo This command returns information about 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 is specified instead of the username and password parameters) Optional Parameters:...
  • Page 91: Getsnapshotscheduleinfo

    getSnapshotScheduleInfo 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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 92: Getsnmpinfo

    getSnmpInfo This 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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 93: Getsupportinfo

    getSupportInfo This command gathers all support log files from a management group and all its member storage systems. If the specified storage system does not belong to any management group, then only logs from the storage system will be collected. This command stores the archive locally.
  • Page 94: Getsysteminfo

    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...
  • Page 95: Getvolumeinfo

    getVolumeInfo This command returns information about 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 keyFile The encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 96: Help

    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 return codes is returned Example Command: cliq help command=getSystemInfo...
  • Page 97: Makeprimary

    makePrimary This command promotes a remote volume to a primary production 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 keyFile The encrypted key file (this is specified instead of the username and password parameters) volumeName...
  • Page 98: Makeremote

    makeRemote 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 encrypted key file (this is specified instead of the username and password parameters) volumeName...
  • Page 99: Modifyadmingroup

    modifyAdminGroup This command modifies 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 is specified instead of the username and password parameters) adminGroupName The administrative group name...
  • 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...
  • Page 101: Modifyadminuser

    modifyAdminUser This command modifies 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 is specified instead of the username and password parameters) adminUserName The administrative user name...
  • Page 102: Modifycluster

    modifyCluster 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 specified instead of the username and password parameters) clusterName...
  • 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;...
  • Page 104: Modifyemailnotifypolicy

    modifyEmailNotifyPolicy This command modifies 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 is specified instead of the username and password parameters) emailAddress...
  • Page 105 Example Command: cliq modifyEmailNotifyPolicy login=10.0.1.3 userName=admin passWord=secret emailAddress="myemail@myhost.com' verbosity="2"...
  • Page 106: Modifygroup

    The manager bandwidth <n>Kb - Kilobits/sec (1000 Bits/second) <n>Mb - Megabits/sec (1000 Kilobits/second) <n>Gb - Gigabits/sec (1000 Megabits/second) customerName Customer name supportId Support ID provided by HP P4000 contactName Contact name postalAddress Postal address line 1 postalAddress2 Postal address line 2...
  • 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...
  • Page 108: Modifyremoteassociation

    modifyRemoteAssociation 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 encrypted key file (this is specified instead of the username and password parameters) remote...
  • 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...
  • Page 110: Modifyremotesnapshotschedule

    modifyRemoteSnapshotSchedule This 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 key file (this is specified instead of the username and password parameters) scheduleName...
  • Page 111: Modifyserver

    modifyServer This command modifies 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 specified instead of the username and password parameters) serverName The name of the server Optional Parameters:...
  • Page 112 chapName The CHAP name for this host. targetSecret The CHAP target secret for this host. 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...
  • Page 113: Modifysite

    modifySite This command modifies 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 is specified instead of the username and password parameters) siteName...
  • Page 114: Modifysnapshot

    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 file (this is specified instead of the username and password parameters) snapshotName The name of the snapshot to modify Optional Parameters:...
  • Page 115: Modifysnapshotschedule

    modifySnapshotSchedule 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 key file (this is specified instead of the username and password parameters) scheduleName...
  • Page 116: Modifysnmpcommunitystring

    modifySnmpCommunityString This command 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 specified instead of the username and password parameters) communityString...
  • Page 117: Modifysnmptraptarget

    modifySnmpTrapTarget 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 specified instead of the username and password parameters) ipAddress...
  • Page 118: Modifysyslognotifypolicy

    modifySyslogNotifyPolicy This command modifies 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 (this is specified instead of the username and password parameters) ipAddress...
  • Page 119: Modifyvolume

    modifyVolume This command modifies volume 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 is specified instead of the username and password parameters) volumeName The name of the volume to modify Optional Parameters:...
  • Page 120 0 - The volume is not thin-provisioned 1 - The volume is thin-provisioned (in a thinly provisioned volume, reserve may be < length) initialQuota The initial quota for the volume, as a percentage or size - the volume resets to this initial size when a snapshot is taken reserveQuota The reserve quota for the volume, as a percentage or size - this is the size guaranteed to be...
  • Page 121: Provisionvolume

    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 encrypted key file (this is specified instead of the username and password parameters) clusterName...
  • Page 122 The number of parity storage systems for the data on this volume. This enables parity network RAID on the volume. Replication and parity are supported in the following combinations: replication:1, parity:0 Network RAID-0 (None) replication:2, parity:0 Network RAID-10 (2-way Mirror) replication:3, parity:0 Network RAID-10+1 (3-way Mirror) replication:4, parity:0 Network RAID-10+2 (4-way Mirror) replication:2, parity:1 Network RAID-5 (Single parity)
  • Page 123: Rebalancevip

    rebalanceVip This command 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...
  • Page 124: Recoverquorum

    recoverQuorum This command is used to rescue a management group after quorum has been irretrievably lost. This command needs to be run on a storage system with a working manager so it can retrieve the management group database from that manager to restore the management group.
  • Page 125: Removesnapshot

    removeSnapshot This command disconnects a SAN snapshot from the host, then deletes it. If the snapshot cannot be disconnected (because it's in use, or for any other reason), it will not be deleted. Availability: Windows 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...
  • Page 126: Removevolume

    removeVolume This command disconnects a SAN volume from the host, then deletes it. If the volume cannot be disconnected (because it's in use, or for any other reason), it will not be deleted. Availability: Windows 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...
  • Page 127: Resetsession

    resetSession This command resets the iSCSI session 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 keyFile...
  • Page 128: Rollbacksnapshot

    rollbackSnapshot This command rolls back a snapshot. WARNING: The rollbackSnapshot command will replace the original volume with a new one based on the contents of the snapshot and delete any snapshots created after the snapshot which is being rolled back. Availability: Windows, SAN/iQ Required Parameters: login...
  • Page 129: Rundiagnostic

    runDiagnostic This command 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 (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 130: Setalertspolicy

    setAlertsPolicy This command sets information for the Alerts 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...
  • Page 131: Setdnsinfo

    setDnsInfo This command sets information for DNS. 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 specified instead of the username and password parameters) ipAddress The IP Address or Hostname.
  • Page 132: Setemailserverinfo

    setEmailServerInfo This command sets information for the email server. 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...
  • Page 133: Setgossiplist

    setGossipList This command sets the gossip list on a storage system. In the normal case, the gossip list is managed by the SAN/iQ agent. This is a backup mechanism that the API provides for imposing this if it's set incorrectly. Availability: Windows, SAN/iQ Required Parameters: login...
  • Page 134: Setlicensekey

    setLicenseKey This command sets the license key 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 key file (this is specified instead of the username and password parameters) licenseKey...
  • Page 135: Setsnmpnotifypolicy

    setSnmpNotifyPolicy This command sets SNMP Notification Policy settings. 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 specified instead of the username and password parameters)
  • Page 136: Setsnmpserviceinfo

    setSnmpServiceInfo This command 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...
  • Page 137: Shutdowngroup

    shutdownGroup 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 file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 138: Shutdownnsm

    shutdownNsm This command shuts down 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 file (this is specified instead of the username and password parameters) action...
  • Page 139: Startmanager

    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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 140: Startsnmpservice

    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 (this is specified instead of the username and password parameters) Optional Parameters: none...
  • Page 141: Startvirtualmanager

    startVirtualManager 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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 142: Stopmanager

    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 key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 143: Stopsnmpservice

    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 (this is specified instead of the username and password parameters) Optional Parameters: none...
  • Page 144: Stopvirtualmanager

    stopVirtualManager 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 encrypted key file (this is specified instead of the username and password parameters) Optional Parameters:...
  • Page 145: Testcredentials

    testCredentials 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 The encrypted key file (this is specified instead of the username and password parameters) groupName...
  • Page 146: Unassignvolume

    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 encrypted key file (this is specified instead of the username and password parameters) volumeName...
  • Page 147: Unassignvolumetoserver

    unassignVolumeToServer This command disassociates a volume with 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 specified instead of the username and password parameters) volumeName...
  • Page 148: Vsssnapshot

    vssSnapshot This command snapshots volumes using the VSS requestor client (Windows only). Availability: Windows (2003, 2008 only) Required Parameters: none Optional Parameters: volumeName The list of volumes to snapshot persistent Is the snapshot persistent? This can be one of: 1 - default transportable Is the snapshot transportable? This can be one of: 0 - default...
  • Page 149 <shadow Copy GUID> - delete the shadow copy with this id excludeWriters List of writer GUIDs to exclude from the shadow copy includeWriters List of writer GUIDs to include in the shadow copy - if the writer is found to not participate in the snapshot, no snapshot will be taken runCommand Custom command executed after shadow creation, import or between break and make-it-write...
  • Page 150: Waitforevent

    waitForEvent This command 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 is specified instead of the username and password parameters) Optional Parameters:...
  • Page 151: Waitforupdate

    waitForUpdate This command will block 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...
  • Page 152: Return Codes

    Return Codes CliqSuccess Everything succeeded normally. CliqNothingDone Operation has succeeded, but nothing was done (the system was already in the requested state). CliqOperationPending 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 Operation was intentionally cancelled or abandoned.
  • Page 153 CliqParameterFormat The parameter is not specified correctly. CliqParameterRepeat A parameter is repeated. CliqMissingMethod The command method is missing. CliqMissingParameter One or more expected parameters are missing. CliqUnrecognizedCommand This command is unrecognized. CliqUnrecognizedParameter This parameter is unrecognized. CliqIncompatibleParameters Two or more parameters supplied are incompatible with each other. CliqNotYetImplemented This is a legal command - we just haven't done it yet.
  • Page 154 The requested volume is in use. CliqVolumeInitFailure Volume initialization failed. CliqUnrecognizedVolume The volume is an unrecognized type. CliqOperationFailed General SAN/iQ error - the operation failed. CliqCredentialsFailed The supplied credentials are incorrect. CliqInvalidParameter Invalid parameter. CliqObjectNotFound Object not found. CliqConnectionFailure Failed to connect to the API server. CliqNotEnoughSpace Not enough space to complete the command.
  • Page 155 CliqOperationTimedOut Operation exceeded the specified timeout. CliqNoPlatformSupport This operating system type does not support the operation. CliqIncorrectOsVersion This operating system version does not support the operation. CliqUtilityNotFound The utility command requested was not found. CliqUtilityNotAllowed The utility command requested is not in the allowed list. CliqUtilityIllegalParameter The utility command contains unsupported parameters or redirection.
  • Page 156 CliqDefaultAdmin You cannot delete, modify permissions, or remove the last user from the default administration group. CliqVssProviderNotInstalled The HP P4000 VSS Provider is not installed. CliqVssProviderNotRunning The HP P4000 VSS Provider is not running. CliqVolumeNoSessions Cannot create an application-managed snapshot because there are no iSCSI connections associated with this volume.
  • Page 157 associated with the volume or the servers must be in a server cluster. (Note: ensure all servers have VSS installed and running.) CliqNoVssCapabilities Cannot create an application-managed snapshot because the server does not support this capability. CliqServerUnresponsive Cannot create an application-managed snapshot because the system could not communicate to the necessary software component on the application server.
  • Page 158 VSS operation timed out. CliqVolumeConnectionFailure Volume connection failure.

This manual is also suitable for:

Storevirtual 4000San/iq

Table of Contents