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