HP 3PAR Web Services API 1.3.1 Developer's Guide Abstract This guide provides instructions and reference information for the HP 3PAR Web Services API.
© Copyright 2012, 2014 Hewlett-Packard Development Company, L.P. The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall not be liable for technical or editorial errors or omissions contained herein.
Contents 1 Introduction.............................................................................................11 About the WSAPI....................................................................................................................11 Getting Started.......................................................................................................................11 Starting and Configuring the Server.....................................................................................
CPG Creation Errors...........................................................................................................47 Modifying a CPG...................................................................................................................48 CPG Modification Success..................................................................................................48 CPG Modification Errors.....................................................................................................
Host Modification Errors.....................................................................................................77 Removing a Host....................................................................................................................79 Host Removal Success........................................................................................................79 Host Removal Errors........................................................................................................
HTTP Response...........................................................................................................104 Removing a VLUN................................................................................................................104 VLUN Removal Success.....................................................................................................105 VLUN Removal Errors.......................................................................................................
All-Tasks Status Query Errors.........................................................................................131 Querying the Status of a Single Task..................................................................................131 Successful Query of Single-Task Status...........................................................................131 Single Copy Task Query Errors.....................................................................................133 Canceling a Task.................
Tables 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 HP 3PAR CLI Commands for the WSAPI Server....................................................................11 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests......................................16 Server HTTP Headers in the WSAPI....................................................................................17 API Types................
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 Host Creation Error Codes................................................................................................74 Message Body JSON Objects for Host Modification Request..................................................75 Host hostEditOperation Enumeration...........................................................................
5 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 Error Codes for Creation, Resynchronization, or Stopping of Physical Copies of Volumes.........114 Message Body action JSON Object..............................................................................116 JSON Object Members of the Parameter Object for Promoting a Virtual Copy.......................
1 Introduction This HP 3PAR Web Services API 1.3 Developer's Guide describes how to write a client that uses the HP 3PAR Web Services API (WSAPI) to manage HP 3PAR storage systems. HP 3PAR storage systems include both hardware components that store data, and software applications to manage data. About the WSAPI The API consists of a server and a definition of the operations, inputs, and outputs of the API.
Table 1 HP 3PAR CLI Commands for the WSAPI Server (continued) Command Description Authority Any role granted the wsapisession_remove right Before attempting to use the CLI removeuser command to remove a user connected through the WSAPI server, all sessions associated with that WSAPI user must first be removed by issuing the CLI removewsapisession command. Connections associated with the WSAPI server can be removed only by issuing the removewsapisession command. (Since WSAPI 1.
Perl SDK The Perl SDK includes: • A module with methods for accessing the HP 3PAR storage system. • Modules with mappings of the error codes and enumerated properties used by WSAPI. • Example programs that demonstrates creation, querying, and deleting of base entities.
2 Accessing the WSAPI The HP 3PAR Web Services API (WSAPI) makes it possible to manage CPGs, hosts and host sets, volumes and volume sets, VLUNs, ports, tasks, quality of service (QoS) rules, and to query system information and available storage space, through a series of HTTP or HTTPS requests. NOTE: For security reasons, HTTPS is the preferred choice and is used by default. Throughout this document, HTTP is used to refer to both. The behavior is the same using both protocols.
Protocol and Message Format Clients communicate with the WSAPI server using HTTPS and data structures represented with JSON. URI Format All operations of the API are performed using an HTTP method (GET, POST, PUT, or DELETE) and a Uniform Resource Identifier (URI). In the following example, the URI corresponds to the volume named projectXvol residing on the HP 3PAR storage system with the hostname storsys1.example.com: https://storsys1.example.
Table 2 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests Header Description Values Required Accept The response format the client can accept. One of the following: No • application/json • application/* • application/json* • application/+json • */json • */* • */json* • */+json where * is literally an asterisk (*) and is any string of characters. Accept-Language The response language the client can accept.
NOTE: The Host header is optional if the request URI contains :. If the request URI does not contain the host and port number, then the Host header must be specified. Server HTTP Headers Table 3 (page 17) shows HTTP headers included by the Web Services API in responses. Table 3 Server HTTP Headers in the WSAPI HTTP Header Value Description Server HP3PAR-WSAPI The HP 3PAR Web Services API Server.
include all members. A client can perform one of two possible operations when creating the JSON object: • Include only the members required for the operation or • Include a member that is not required, but with a value that means it should be ignored. NOTE: A JSON object that has only ignored fields or null fields will be considered empty. A JSON array with no elements is considered empty. Objects and arrays composed of sub-objects or sub-arrays that are empty are themselves considered empty.
When using tools that deserialize JSON into a class, this allows an omitted property of enumeration type to be detected, since the member will not be assigned a non-zero value of a property and will retain its default or preset value of 0. For enumerations, the symbols used in this document are for convenience in referring to values of enumerations, but are not part of the WSAPI. Integer values representing the symbols appear in JSON objects. Clients can use any symbols with the integers.
Table 4 API Types (continued) Type Description • . (period) • _ (underscore) • - (hyphen) A hyphen (-) is disallowed as the first character. A name of zero characters is represented in JSON as the empty string (“”). An unset name is represented in JSON as “null” (without the quotes). name31 JSON string of 31 or fewer characters, in which the following characters are allowed: a-z A-Z 0-9 . (dot) - (dash) NOTE: Dash (-) is disallowed as the first character.
property syntax is used to define the components of the query string. The subproperties of a complex property are accessed by using brackets ([ ]) to enclose the expressions related to the complex property. Only the OR operator is supported.
The code Member Just as is the case with CLI text, the text in the desc member (see Table 5 (page 22)) is subject to change and cannot be relied upon. To avoid that problem, the WSAPI provides a reliable code for an error. The error code member is a JSON numeric type. Only codes that are defined in Table 5 (page 22) and in Table 6 (page 25) will be returned. For applications that change behavior based on errors, only the code member should be relied on.
Table 5 Generic WSAPI code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description probably be assigned a more specific error code in a future version of the API. Client code that checks for specific error codes should treat an unrecognized code the same as OTHER, so an unchanged client will behave the same in the future even if the error code is changed to a new (and more specific) error code. 30 (Not used.
Table 5 Generic WSAPI code Member Status and Error Codes (continued) 24 API Error API Error Code HTTP Code Description INV_INPUT_EXCEEDS_LENGTH 57 400 Bad Request Invalid input: string length exceeds limit. JSON_SYNTAX_ERR 60 400 Bad Request JSON syntax error. When the error is associated with an object member, the HTTP ref member contains the name of the member.
Table 5 Generic WSAPI code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description has returned an unexpected error, preventing the API server from fulfilling the request. (Since WSAPI 1.2) INV_INPUT_ALL_WHITE_SPACES_STR 182 400 Bad Request Invalid input: All-white-spaces string. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) EMPTY_HTTP_HOST_HDR 186 404 Bad Request The HTTP Host header is empty or missing.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description for the specified volume size. • In CPG creation, when the storage system's hardware configuration does not support the requested LD layout. • In CPG creation, when the chunklets that are required for the requested LD layout are in the process of being cleaned. 26 HAS_RO_CHILD 25 409 Conflict The volume has a read-only child.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description cannot be present with another name-value parameter that is present. The HTTP ref member contains the name. INV_INPUT_EMPTY_STR 45 400 Bad Request A JSON input object contains a name-value pair with an empty string (distinct from a null string) where a string of length greater than zero is required.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description (Since WSAPI 1.2) EXISTENT_PATH 73 409 Conflict Host WWN/iSCSI name is already used by another host. (Since WSAPI 1.2) NON_EXISTENT_CHAP 74 404 Not Found No CHAP has been configured for host. (Since WSAPI 1.2) NON_UNIQUE_CHAP_SECRET 75 409 Conflict Target CHAP and initiator CHAP are the same. Target CHAP secret and initiator CHAP secret must be unique. (Since WSAPI 1.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description INV_OPERATION_VV_PEER_VOLUME 83 403 Forbidden Operation not allowed on peer volume. (Since WSAPI 1.2) INV_OPERATION_VV_INTERNAL_VOLUME 84 403 Forbidden Operation not allowed on internal volume. (Since WSAPI 1.2) INV_OPERATION_VV_SYS_VOLUME 85 403 Forbidden Operation not allowed on system volume. (Since WSAPI 1.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description INV_OPERATION_VV_CPG_ON_SNAPSHOT 96 409 Conflict CPG cannot be assigned to a snapshot. INV_OPERATION_VLUN_PCOPY_TARGET_VV 97 409 Conflict Volume is a target of physical copy. INV_INPUT_DUP_PATH 98 400 Bad Request Duplicate path specified. LUN_HOSTPERSONA_CONFLICT 99 409 Conflict LUN number and persona capability conflict.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description greater than the minimum goal. (Since WSAPI 1.3) INV_INPUT_BW_MIN_GOAL_GRT_MAX_LIMIT 113 400 Bad Request The bandwidth maximum limit should be greater than the minimum goal. (Since WSAPI 1.3) EXISTENT_QOS_RULE 114 400 Bad Request The QoS rule already exists. (Since WSAPI 1.3) INV_INPUT_BELOW_RANGE 115 400 Bad Request The number is below the expected range. (Since WSAPI 1.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description INV_OPERATION_VV_NO_SNAPSHOT_ALLOWED 125 403 Forbidden The parent volume must allow snapshots. (Since WSAPI 1.3) INV_OPERATION_VV_COPY_PARENT_TOO_BIG 126 409 Conflict The parent volume is larger in size than the destination volume. (Since WSAPI 1.3) INV_OPERATION_VV_CLEANUP_IN_PROGRESS 127 403 Forbidden Internal volume cleanup is in progress. (Since WSAPI 1.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description (Since WSAPI 1.3) EMPTY_SET 138 404 Not Found The set is empty. (Since WSAPI 1.3) INV_OPERATION_VV_READONLY_TO_READONLY_SNAP 139 403 Forbidden Creating a read-only copy from a read-only volume is not permitted. (Since WSAPI 1.3) INV_OPERATION_VV_SNAP_PARENT_SAME_BASE 140 403 Forbiddenn Two parent snaps share same base volume. (Since WSAPI 1.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description (Since WSAPI 1.3) INV_INPUT_VV_GROW_SIZE 152 400 Bad Request Invalid grow size.(Since WSAPI 1.3) VV_NEW_SIZE_EXCEED_CPG_LIMIT 153 403 Forbidden New volume size exceeds CPG limit(Since WSAPI 1.3) VV_NEW_SIZE_IS_SMALLER 154 403 Forbidden New volume size is smaller than current size. (Since WSAPI 1.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description (Since WSAPI 1.3) INV_OPERATION_VV_MODIFY_USR_CPG_CPVV 164 409 Conflict Invalid operation: Cannot change USR CPG of an FPVV. (Since WSAPI 1.3) INV_OPERATION_VV_IS_PCOPY 165 INV_OPERATION_CANNOT_STOP_ONLINE_PROMOTE 166 409 Conflict Invalid operation: The volume is a physical copy. 403 Forbidden Invalid operation: The online promote cannot be stopped.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) INV_OPERATION_RC_TASK 173 409 Conflict Invalid operation: Remote copy synchronizations can be canceled only by using a stoprcopygroup operation. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) NON_ACTIVE_TASK 175 400 Bad Request The task is not active at this time. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.
Table 6 Operation-specific API code Member Status and Error Codes (continued) API Error API Error Code HTTP Code Description (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) INV_OPERATION_VV_PROMOTE_IS_NOT_IN_PROGRESS 185 409 Conflict Invalid operation: Volume promotion is not in progress. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) The desc Member The desc member provides supplementary information that helps explain the reason for the error code.
HTTP Error Codes In addition to the API-specific error information, the response to a client request that has failed will include an HTTP error code. Each API error code is associated with an HTTP status code as shown in “Generic WSAPI code Member Status and Error Codes” (page 22). The following is an example of a bad client request, followed by the server response showing API error code 5 in association with HTTP status code, 403 Forbidden: Request POST /api/v1/credentials HTTP/1.
Creating a Session Key Except when querying the API version and when creating and deleting a session key, the session key is required for all operations and is passed in an HTTP header with the name X-HP3PAR-WSAPI-SessionKey. Each session key is associated with the IP address of the client that originally requested it, and subsequent use is restricted to requests from that same IP address.
Session Key Security Because session keys allow access to the storage server, client applications should not display session keys or otherwise make them visible to end users. Revealing a session key is similar to revealing a password in that an unauthorized person who obtains a session key can use it to access the storage server until the key is deleted. Multiple Session Keys A multi-threaded client application can use one session key in multiple threads concurrently.
(1) * (maximum number of sessions per node) ◦ Four-node or eight-node clusters: If n is the number of nodes on these systems, then: – If the master and network nodes are on the same machine, then the number of nodes processing the request will be n - 1, and the total number of WSAPI sessions will be: (n - 1) * (maximum number of sessions per node) – If the master and network nodes are on separate machines, then the number of nodes processing the request will be n - 2, and the total number of WSAPI sess
3 Working with Common Provisioning Groups You can use a common provisioning group (CPG) to create a virtual pool of logical disks that allows virtual volumes to share the resources of the CPG and allocates space on demand. You can create fully-provisioned virtual volumes (FPVVs) and thinly-provisioned virtual volumes (TPVVs) that draw space from the logical disk pool.
CPG HA Enumeration Upon creation, modification, or query, specify the high–availability (HA) setting as a JSON object HA with an enumeration based on Table 12 (page 43). Table 12 CPG HA Enumeration Symbol Value Description PORT 1 Support failure of a port. CAGE 2 Support failure of a drive cage. MAG 3 Support failure of a drive magazine.
Table 14 CPG diskPatterns JSON Object (continued) Member Value Ignored values magList string Null Specifies one or more drive magazines. Drive magazines are identified by one or more integers. Multiple drive magazines are separated with a single comma (1,2,3). A range of drive magazines is separated with a hyphen (0–7). The specified magazine(s) must contain disks. diskPosList string Null Specifies one or more disk positions within a drive magazine.
CPG Space Usage Objects The SDUsage, SAUsage and UsrUsage objects, all of which use the same members, are sub-objects of the cpg object returned by queries. Those members are listed in Table 16 (page 45). Table 16 CPG SDUsage, SAUsage, and UsrUsage JSON Objects Member JSON Type API Type Description totalMiB number uint32 Total logical disk space in MiB. rawTotalMiB number uint32 Total physical (raw) logical disk space in MiB. usedMiB number uint32 Amount of logical disk used, in MiB.
Table 19 CPG DetailedState Enumeration Symbol Value Description SA_LIMIT_REACHED 1 Administrative space is at limit. SD_LIMIT_REACHED 2 Copy space is at limit. SA_GROW_FAILED 3 Administrative space grow failed. SD_GROW_FAILED 4 Copy space grow failed. SA_WARN_REACHED 5 Administrative space is at warning level. SD_WARN_REACHED 6 Copy space at warning level.
Table 20 Message Body JSON Objects for CPG Creation and Modification (continued) Member JSON Type disableAutoGrow Boolean API Type Ignored Values Description If True, CPG auto grow is disabled. The default setting is False. For CPG modification only. rmGrowthLimit Boolean If True, no auto grow limit is enforced. The default setting is False. For CPG modification only. rmWarningAlert Boolean If True, no warning limit is enforced. The default setting is False. For CPG modification only.
Table 21 CPG Creation and Modification Error Codes (continued) API Error HTTP Code Description INV_INPUT_WARN_GT_LIMIT 400 Bad Request The allocation warning level is higher than the allocation limit. INV_OPERATION_CPG_RAID0_DISABLED 403 Forbidden Invalid operation. RAID-0 must be enabled. (Since WSAPI 1.2) Invalid operation. RAID-5 on NL drives must be enabled. INV_OPERATION_CPG_RAID5_NL_DISABLED 403 Forbidden (Since WSAPI 1.
/api/v1/cpgs/ NOTE: The new CPG name appears if the CPG name is successfully updated. If it is not updated, then is . CPG Modification Errors If an error occurs, the system returns one of the error codes shown in Table 21 (page 47), or a generic error code listed in “Generic WSAPI code Member Status and Error Codes” (page 22).
Table 25 CPG Query members JSON Objects Member JSON Type API Type Description id number uint32 CPG ID uuid string uuid string The UUID that was automatically assigned to the CPG at creation. name string name31 CPG name. Domain string name31 Domain to which the CPG belongs. warningPct number uint32 Percentage usage at which to issue an alert. This is set with the CLI createcpg –aw parameter, which is deprecated and not exposed by this API.
Single-CPG Query Success Upon a successful single-CPG query, the HTTP code 200 OK is returned. Unless an error occurs, the response includes JSON objects as specified in Table 25 (page 50). Single-CPG Query Errors Possible error codes for a single-CPG query are shown in Table 27 (page 51). For generic API error codes, see Table 5 (page 22). Table 27 Single-CPG Query Error Codes API Error HTTP Code Description NON_EXISTENT_CPG 404 Not Found CPG does not exist. (Since WSAPI 1.
4 Working with Storage Volumes This chapter describes how to manage storage volumes. The sections apply to creation, modification, and query operations on storage volumes. You can perform the following operations on storage volumes: • Create a storage volume • Modify a storage volume (since WSAPI 1.2) • Remove a storage volume (since WSAPI 1.2) • Query a storage volume (since WSAPI 1.
Table 30 Volume state Enumeration Symbol Value Description NORMAL 1 The VV is operating normally. DEGRADED 2 The VV is in degraded state. FAILED 3 The VV is operating abnormally. Volume DetailedState Enumeration Types Details of the volume's state are enumerated in Table 31 (page 53). DetailedState is not a JSON object itself, but is rather an enumeration that applies to multiple JSON objects, including failedStates, degradedStates, and additionalStates.
Volume policies Configuration Object The policies of a volume are specified by the policies JSON object, as detailed in Table 32 (page 54). Table 32 Volume policies JSON Objects Member Value Description staleSS Boolean True: Stale snapshots. If there is no space for a copy-on-write operation, the snapshot is allowed to go stale but the host write can proceed without an error. False: No stale snapshots. If there is no space for a copy-on-write operation, the host write will fail.
Creating a Storage Volume This section contains information about creating storage volumes. NOTE: Any user with Super or Edit role, or any role granted the vv_create right (for base volumes), the vvcopy_create right (for physical copies of volumes), or the sv_create right (for snapshots), can create a volume. For more information about creating snapshots, see “Creating Snapshots” (page 112).
Table 34 Message Body JSON Objects for Base-volume Creation (continued) Member JSON Type API Type Ignored Values Description ssSpcAllocWarningPct number igint32 Negative values Enables a snapshot space allocation warning. A warning alert is generated when the reserved snapshot space of the VV exceeds the indicated percentage of the VV size. ssSpcAllocLimitPct number igint32 Negative values Sets a snapshot space allocation limit.
/api/v1/volumes/ Volume Creation Errors An error condition returns one of the errors in Table 35 (page 57). For generic API error codes, see Table 5 (page 22). Table 35 Base-Volume and Snapshot Creation Error Codes API Error HTTP Code Description INV_INPUT 400 Bad Request Invalid parameter or JSON object. EXISTENT_VOL 409 Conflict The volume already exists. TOO_LARGE 400 Bad Request Volume size is above the architectural limit.
Table 36 Message Body JSON Objects for Volume Modification Request (continued) Member JSON Type API Type Ignored Values Description retentionHours number igint32 Zero and negative values Time in hours that the volume would be retained. (Since WSAPI 1.2) policies object policies object None except caching Specify virtual volume and system, which are policies. ignored if false. (Since WSAPI 1.2) snapCPG string name31 None The snap CPG name. (Since WSAPI 1.
Table 36 Message Body JSON Objects for Volume Modification Request (continued) Member JSON Type API Type Ignored Values Description If False, and expiration time value is 0, then Ignore. If False, and expiration time value is positive, then set. (Since WSAPI 1.2) rmSsSpcAllocLimit Boolean None If True, remove snapshot space allocation limit. If False, and limit value is 0, then ignore. If False, and limit value is positive, then set. (Since WSAPI 1.
Table 37 Volume Modification Request Error Codes (continued) API Error HTTP Code Description INV_INPUT_VV_POLICY 400 Bad Request Invalid policy specification (for example, caching or system is set to true). (Since WSAPI 1.2) INV_INPUT_EXCEEDS_LENGTH 400 Bad Request Invalid input: string length exceeds limit. (Since WSAPI 1.2) INV_INPUT_TIME 400 Bad Request Invalid time specified. INV_OPERATION_VV_MODIFY_USR_CPG_TPVV 403 Forbidden usr_cpg cannot be modified on a TPVV. (Since WSAPI 1.
Table 37 Volume Modification Request Error Codes (continued) API Error HTTP Code Description moved to a CPG before the user space. (Since WSAPI 1.2) INV_OPERATION_VV_VOLUME_ACCOUNTING_IN_PROGRESS 409 Conflict The volume cannot be renamed until snapshot accounting has finished. (Since WSAPI 1.2) INV_OPERATION_VV_ZERO_DETECT_TPVV 403 Forbidden The zero_detect policy can be used only on TPVVs. (Since WSAPI 1.2) INV_OPERATION_VV_CPG_ON_SNAPSHOT 409 Conflict CPG cannot be assigned to a snapshot.
Table 39 Enumeration for the action JSON Object (continued) Symbol Value Description (Since WSAPI 1.3) PROMOTE_VIRTUAL_COPY 4 Promote a virtual copy. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) STOP_PROMOTE_VIRTUAL_COPY 5 Stop the promote virtual copy task. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) TUNE_VOLUME 6 Tune a VV. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) Volume Growth Success Upon a successful request to grow a volume, the HTTP status code 200 OK is returned.
Table 40 Volume Growth Error Codes (continued) API Error HTTP Code Description INV_OPERATION_VV_INTERNAL_VOLUME 403 Forbidden This operation is not allowed on an internal volume. (Since WSAPI 1.3) INV_OPERATION_VV_VOLUME_CONV_IN_PROGRESS 409 Conflict Invalid operation: VV conversion is in progress. (Since WSAPI 1.3) INV_OPERATION_VV_ONLINE_COPY_IN_PROGRESS 409 Conflict Invalid operation: online copy is in progress. (Since WSAPI 1.
Table 40 Volume Growth Error Codes (continued) API Error HTTP Code Description INV_OPERATION_VV_PARENT_OF_PCOPY 409 Conflict invalid operation: Volume is the parent of physical copy. (Since WSAPI 1.3) NO_SPACE 400 Bad Request Insufficient space for requested operation. (Since WSAPI 1.3) Tuning a Virtual Volume To tune a volume, use the HTTP PUT method on the following URI: https://:8080/api/v1/volumes/ where is the name of the volume to be tuned.
Table 41 JSON Object Members for a Volume Tune Operation (continued) Member JSON Type API Type Ignored Values Description (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) Enumeration for the tuneOperationEnum JSON object is shown in Table 42 (page 65). Table 42 tuneOperationEnum Enumeration for Tuning a Volume Symbol Value Description USR_CPG 1 Change the user CPG of the volume. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) SNP_CPG 2 Change the snap CPG of the volume. (Since WSAPI 1.3.
Virtual Volume Tuning Errors An error condition returns an error code as shown in Table 44 (page 66). For generic API error codes, see Table 5 (page 22). Table 44 Error Codes for Volume Tuning API Error HTTP Code Description INV_INPUT_ILLEGAL_CHAR 400 Bad Request Invalid volume name or CPG name. (Since WSAPI 1.3) NON_EXISTENT_CPG 404 Not Found The CPG does not exist. (Since WSAPI 1.3) CPG_NOT_IN_SAME_DOMAIN 403 Forbidden The CPG is not in the current domain. (Since WSAPI 1.
Table 44 Error Codes for Volume Tuning (continued) API Error HTTP Code Description (Since WSAPI 1.3) INV_OPERATION_VV_TASK_CANCEL_IN_PROGRESS 409 Conflict Invalid operation: A task involving the volume is being canceled. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) INV_OPERATION_VV_PROMOTE_IN_PROGRESS 409 Conflict Invalid operation: Volume promotion is in progress. (Since WSAPI 1.3) INV_OPERATION_VV_TUNE_IN_PROGRESS 409 Conflict Invalid operation: Volume tuning is in progress.
Table 45 Storage Volume Removal Error Codes API Error HTTP Code Description NON_EXISTENT_VOL 404 Not Found The volume does not exist. RETAINED 409 Conflict The volume retention time has not expired. HAS_RO_CHILD 409 Conflict The volume has read-only child. HAS_CHILD 409 Conflict The volume has child VV. (Since WSAPI 1.2) IN_USE 409 Conflict The volume is in use by VV set, VLUN, etc. (Since WSAPI 1.
Table 46 Message Body JSON Objects for Volume Query (continued) Member JSON Type API Type Description copyOf string name31 If the VV is a physical copy or virtual copy of another VV, this field indicates the VV that this VV is a copy of. baseId number uint32 The ID of the VV that is the base VV (at the root of the snapshot tree) for the VV. readOnly Boolean Boolean true: Read only false: Read and write allowed. state number state Enum State of the VV.
Table 46 Message Body JSON Objects for Volume Query (continued) Member JSON Type API Type Description exceeds the indicated percentage of the virtual volume size. ssSpcAllocLimitPct number igint32 Sets a snapshot space allocation limit. The snapshot space of the VV is prevented from growing beyond the indicated percentage of the VV size. usrSpcAllocWarningPct number igint32 This field enables a user space allocation warning.
the process, there is no way to report the error to the client. The only solution is to close the connection. The client will not receive the terminating zero-length CRLF chunk at the end of response. To help the client debug and resolve the issue, the WSAPI will send the API error code and its description as part of the JSON payload when the error occurs.
Volume Query with WWN Filtering Success Upon a successful query, a message body is returned with JSON object members as shown in Table 49 (page 72). Table 49 Message Body JSON Objects for Volume Query with WWN Filtering Member JSON Type API Type Description Total number int32 Number of volume objects returned, or zero if no WWNs matched volume records. Since WSAPI 1.3 Members array of objects Where N >= 0, an array of Storage volume properties. volume property objects. An Since WSAPI 1.
5 Working with Hosts This chapter describes how to manage hosts. The sections apply to creation, modification, removal, and query operations on hosts. Creating a Host Create a host using the HTTP POST method. Use the following URI: https://:8080/api/v1/hosts Table 51 (page 73) shows the members that the message body can include. NOTE: Any user with Super or Edit role, or any role granted the host_create right, can perform this operation. Access to all domains is required for this operation.
Table 51 Message Body JSON Objects for Host Creation (continued) Member JSON Type Value Range Mandatory Ignored Values Description (Since WSAPI 1.2) descriptors HostDescriptors descriptors object No Null See HostDescriptors. (Since WSAPI 1.2) When creating a host, the name is required. Other members are optional.
Table 52 Host Creation Error Codes (continued) API Error HTTP Code Description WWN specification contains non-hexadecimal digit. (Since WSAPI 1.2) EXISTENT_PATH iSCSI name or WWN is already claimed by other host. 409 Conflict (Since WSAPI 1.2) EXISTENT_HOST Host name is already used. 409 Conflict (Since WSAPI 1.2) NO_SPACE No space to create host. 400 Bad Request Modifying a Host Modify a host using the HTTP PUT method.
Table 53 Message Body JSON Objects for Host Modification Request (continued) Member JSON Type API Type Ignored Values Description persona number hostPersona Enum Zero and negative values The ID of the persona to modify the host’s persona to. (Since WSAPI 1.2) descriptors HostDescriptors descriptors object Null The description of the host. (Since WSAPI 1.2) chapOperation chapOperationMode chapName number hostEditOperation Enum number string Zero and negative values Add or remove.
Table 56 (page 77) shows the enumeration for the hostPersona JSON object.
Table 57 Host Modification Error Codes (continued) API Error HTTP Code Description forcePathRemoval is specified and pathOperation is Add. The forcePathRemoval operation can be used only with path removal. Both iSCSINames and FCWWNs are specified. The system can handle either FC WWN or iSCSI names in one operation, but not both. (Multiple FC WWN or iSCSI names can be specified.) chapOperation is Add, and chapRemoveTargetOnly is specified. chapRemoveTargetOnly is for chap removal only.
Table 57 Host Modification Error Codes (continued) API Error HTTP Code Description INV_INPUT_ILLEGAL_CHAR 400 Bad Request Any error from host or iSCSI name parsing. EXISTENT_HOST 409 Conflict New host name is already used. NON_EXISTENT_HOST 404 Not Found Host to be modified does not exist. INV_INPUT_TOO_MANY_WWN_OR_iSCSI 400 Bad Request More than 1024 WWNs or iSCSI names are specified. INV_INPUT_WRONG_TYPE 400 Bad Request Input value is of the wrong type.
Querying Host Information Querying All Hosts Query hosts using the HTTP GET method. Use the following URI with no message body: https://:8080/api/v1/hosts Querying a Single Host To query a single host, use the following URI with no message body: https://:8080/api/v1/hosts/ Host Query Success Unless an error occurs, the response will include a message body that is a JSON array of zero or more JSON objects, as shown in Table 59 (page 80).
descriptors is an optional sub-object of the host object for creation and modification. The descriptors sub-object is also returned within the host object following a query. See Table 60 (page 81). Table 60 Host descriptors JSON Objects Member JSON Type Description location string The host’s location. (Since WSAPI 1.2) IPAddr string The host’s IP address. (Since WSAPI 1.2) os string The operating system running on the host. (Since WSAPI 1.2) model string The host’s model. (Since WSAPI 1.
Table 62 Host iSCSIPaths JSON Objects Member JSON Type Description name string An iSCSI name to be assigned to the host. (Since WSAPI 1.2) portPos portPos See Table 63 (page 82). (Since WSAPI 1.2) string IPAddr IP address for Remote Copy. (Since WSAPI 1.2) string firmwareVersion HBA firmware version. (Since WSAPI 1.2) string vendor HBA vendor. (Since WSAPI 1.2) string model HBA model. (Since WSAPI 1.2) string driverVersion HBA driver version (Since WSAPI 1.
Table 64 Host agent JSON Objects (continued) Member JSON Type API Type Description (Since WSAPI 1.2) osVersion string Name255 The operating system version of the host agent. (Since WSAPI 1.2) osPatch string Name255 The operating system patch level of host agent. (Since WSAPI 1.2) multiPathSoftware string Name255 The multipathing software in use by the host agent. (Since WSAPI 1.2) multiPathSoftwareVersion string Name255 The multipathing software version. (Since WSAPI 1.
Querying Host Information with WWN Filtering To query a host with a given WWN or iSCSI name, use the HTTP GET method. You must specify the FCPaths WWN or the iSCSIPaths name in the URI, as shown in the following example: https:// :8080/api/v1/hosts?query=" FCPaths[wwn==5001438024226EAE OR wwn==20010002AC000999 OR wwn==10000000C98C4D95] OR iSCSIPaths[name==iqn.1991-05.com.microsoft:fakeISCSIHost1 OR name==iqn.1991-05.com.microsoft:fakeISCSIHost2 OR name==iqn.1991-05.com.
6 Working with Host Sets and VV Sets This chapter describes how to manage sets for VVs and hosts. The sections describe how to create, modify, remove, and perform query operations on sets.
Host-Set or VV-Set Creation Success Upon successful creation of the host set, the location portion of the response header contains the URI for the newly created host in the following format: api/v1/hostsets/ Upon successful creation of the VV set, the location portion of the response header contains the URI for the newly created VV set in the following format: api/v1/volumesets/ The system returns the following HTTP status code: HTTP_CREATED Host-Set or VV-Set Creation Error
https://:8080/api/v1/hostsets/ To modify a VV set, use the HTTP PUT method in the following URI, with message body parameters as shown in Table 69 (page 87): https://:8080/api/v1/volumesets/ Table 69 Message Body JSON Objects Modifying a Host Set or VV Set Member JSON Type API Type Ignored Values Description action number memEditOperation Zero and negative values. Add or remove.
Table 70 Host-Set or VV-Set Modification Error Codes (continued) API Error HTTP Code Description (Since WSAPI 1.3) NON_EXISTENT_SET 404 Not Found The set does not exist. (Since WSAPI 1.3) MEMBER_IN_DOMAINSET 409 Conflict The host is in a domain set. (Since WSAPI 1.3) MEMBER_IN_SET 409 Conflict The object is already part of the set. (Since WSAPI 1.3) MEMBER_NOT_IN_SET 404 Not Found The object is not part of the set. (Since WSAPI 1.
Host-Set or VV-Set Removal Errors If an error occurs, the system returns one of the error codes shown in Table 71 (page 89), or a general error code as shown in Table 5 (page 22). A glob-style pattern is not supported when removing hosts or volumes from sets. If you attempt to remove hosts or volumes from sets by using a glob-style pattern, the INV_INPUT_ILLEGAL_CHAR error code (400 Bad Request) will be returned.
Table 73 The members Object of the SetObjectProperty JSON Array for Host-Set or VV-Set Query Response (continued) Member JSON Type API Type Description comment string Print255 Comment for the set. setmembers array of string array of name31 The members of the set. All-Host-Sets or All-VV-Sets Query Errors For generic API error codes, see Table 5 (page 22).
7 Working with Ports and Switches This section defines API operations on ports. Port Configuration and Enumeration Objects The following tables show enumeration and configuration objects that are used by VLUN operations. The Inform API server configuration object portPos is defined in Table 63 (page 82). The HP 3PAR OS API server returns the port mode enumeration, as shown in Table 75 (page 91).
Table 76 Port portLinkState Enumeration (continued) Symbol Value Description COREDUMP 9 Taking coredump. (Since WSAPI 1.2) OFFLINE 10 Link is offline. (Since WSAPI 1.2) FWDEAD 11 Firmware is dead. (Since WSAPI 1.2) IDLE_FOR_RESET 12 Link is idle for reset. (Since WSAPI 1.2) DHCP_IN_PROGRESS 13 DHCP is in progress. (Since WSAPI 1.2) PENDING_RESET 14 Link reset is pending. (Since WSAPI 1.2) The HP 3PAR OS API server returns port connection type enumeration, as shown in Table 77 (page 92).
Table 78 Port portProtocol Enumeration Symbol Value Description FC 1 Fibre Channel. (Since WSAPI 1.2) iSCSI 2 iSCSI. (Since WSAPI 1.2) FCOE 3 Fibre Channel over Ethernet (Since WSAPI 1.2) IP 4 Internet Protocol (remote copy) (Since WSAPI 1.2) SAS 5 Serial-attached SCSI. (Since WSAPI 1.2) The HP 3PAR OS API server returns port failover state enumeration as shown in Table 79 (page 93). Table 79 Port portFailOverState Enumeration Symbol Value Description NONE 1 No failover in operation.
Table 80 Message Body JSON Objects for Port Collection Member JSON Type API Type Description Total number int32 Number of port objects returned. (Since WSAPI 1.2) members array of objects array of Port Property objects Storage port properties. (Since WSAPI 1.2) The total is the number of objects in the collection. The members object is a JSON array of zero or more JSON objects, one object for each port on the system. These objects are described in Table 81 (page 94).
Table 81 Message Body Port Property JSON Objects for All-Ports Query (continued) Member JSON Type API Type Description Maximum length is 15 characters. (Since WSAPI 1.2) device array of string array of name31 Array of device name (cage0, host1, etc.) of the device connected to the port. (Since WSAPI 1.2) partnerPos object portPos object Location of failover partner port in :: format. (Since WSAPI 1.
Querying A Single Port To query port information for a single instance, use the HTTP GET method in the URI, with no message body, where is the port :: value: https://:8080/api/v1/ports/ Single-Port Query Success Upon success, the HTTP code 200 OK is returned. Unless an internal server error occurs, the response includes a message body as specified in Table 82 (page 96).
The total is the number of objects in the collection. members is an array of zero or more JSON objects, one for each device connected to the port, as described in Table 85 (page 97). Table 85 Message Body for QoSProperty JSON Object for the portDevices Query Member JSON Type API Type Description portId string Hex Port ID of the device. (Since WSAPI 1.3) loopId string Hex Arbitrated loop physical address of the device. (Since WSAPI 1.
FC-Switches Query Success Upon a successful query, the response includes a message body as shown in Table 86 (page 98). Table 86 Message Body JSON Objects for FCswitches Query Member JSON Type API Type Description total number int32 Number of FCswitches objects returned. (Since WSAPI 1.3) members array of objects array of FCswitches property FC switch properties. objects (Since WSAPI 1.3) The total JSON object is the number of objects in the collection.
FC Switches Query Errors For generic API error codes, see Table 5 (page 22).
8 Working with Virtual LUNs This chapter describes the API operations you can perform on virtual logical unit numbers (VLUNs). A VLUN is a pairing between a virtual volume (VV) and a logical unit number (LUN), expressed as either a VLUN template or an active VLUN. A VLUN template sets up an association between a VV and one of the following combinations by establishing the export rule, the manner in which the volume is exported.
Table 91 VLUN multipathing Configuration Enumeration Symbol Value Description UNKNOWN 1 Unknown. ROUND_ROBIN 2 Round Robin. FAILOVER 3 Failover. VLUN failedPathPol Enumeration The API server will communicate the failed path monitoring method (failedPathPol) enumerated as shown in Table 92 (page 101). Table 92 VLUN failedPathPol Configuration Enumeration Symbol Value Description UNKNOWN 1 Unknown. SCSI_TEST_UNIT_READY 2 SCSI test unit is ready. INQUIRY 3 Inquiry.
Table 93 Message Body JSON Objects for VLUN Template Request (continued) Member JSON Type API Type Ignored Values Description The host set should be in set:hostset_name format. portPos object noVcn Boolean portPos None.1, 2 System port of VLUN exported to. It includes node number, slot number, and card port number. None.1 Specifies that a VLUN change notification (VCN) not be issued after export (-novcn). Default: False. This is an optional field. overrideLowerPriority Boolean None.
VLUN Creation Errors Upon failure, the error code and API-specific error information is returned, as shown in Table 94 (page 103). For generic API error codes, see Table 5 (page 22). Table 94 VLUN Creation Error Codes API Error HTTP Code Description INV_INPUT_MISSING_REQUIRED 400 Bad Request Missing volumeName or incomplete port info, specifying override option without hostname. Since WSAPI 1.2. INV_INPUT 400 Bad Request Missing volumeName or LUN or both hostname and portPos members.
VLUN Creation Example The following example creates a matched VLUN type template for test_vv02 volume. HTTP Request POST /api/v1/vluns HTTP/1.1 Host: storsys1.example.com:8080 Accept: application/json Content-Type: application/json X-HP3PAR-WSAPI-SessionKey: 2-33fe8891e288b34b3f914410e7cc7907-a93d1c50 { "volumeName":"test_vv02", "lun":252, "hostname":"mysystem", "portPos":{ "node": 2, "slot": 2, "cardPort": 4 }, "noVcn":false, "overrideLowerPriority":false } HTTP Response HTTP/1.
Table 95 URI Parameters for VLUN Removal (continued) URI Parameter1 Ignored Values None (required if volume is exported to host or Name of the host or host set to which the volume host set, or to both the host or host set and port) or VV set is to be exported. For VLUN of port type, the value is empty. Description The host set should be in set:{hostset_name} format. None (required if volume is exported to port, or Specifies the system port of the VLUN export.
Accept: application/json Content-Type: application/json X-HP3PAR-WSAPI-SessionKey: 2-33fe8891e288b34b3f914410e7cc7907-a93d1c50 HTTP Response HTTP/1.1 200 OK Date: Mon, 16 Apr 2012 07:16:39 GMT Server: hp3par-wsapi Cache-Control: no-cache Pragma: no-cache Connection: close Querying VLUNs The VLUN query collects information about all the VLUN templates and active VLUNs on the system. Querying All VLUNs To query for VLUN information, use the HTTP GET method in the URI.
Table 98 JSON Objects in members Object for All-VLUNs Query Member JSON Type API Type Description lun number uint32 Exported LUN value. volumeName string name31 Name of exported virtual volume name or VV set name. hostname string name31 Host name or host set name to which the VLUN is exported. remoteName string name31 Host WWN, or iSCSI name, or SAS address; depends on port type. portPos object portPos object System port of VLUN exported to.
Host: storsys1.example.com:8080 Accept: application/json Content-Type: application/json X-HP3PAR-WSAPI-SessionKey: 2-33fe8891e288b34b3f914410e7cc7907-a93d1c50 HTTP Response {"total": 2, "members": [ { "lun": 1, "volumeName": "vol1.
where: • is the VLUN identifier returned in the location header after the VLUN was created. • format can be one of the following: ◦ ,,, ◦ ,, ◦ ,,, The and fields are mandatory. The and fields are optional, but one or both of them must be specified. NOTE: The use of patterns or sets in querying volumes and hosts is not supported in WSAPI 1.2.
Table 100 JSON Objects for members object in Single-VLUN Query Response (continued) Member JSON Type API Type Description remoteName string name31 Host WWN, or iSCSI name, or SAS address, depending on the port type. (Since WSAPI 1.2) portPos object portPos object System port of VLUN exported to. It includes node number, slot number, and cardPort number. type number VLUNType enum VLUN type. (Since WSAPI 1.2) volumeWWN string WWN WWN of exported volume. (Since WSAPI 1.
Table 101 Single-VLUN Query Error Codes (continued) API Error HTTP Code Description NON_EXISTENT_VLUN 404 Not found Requested VLUN does not exist. (Since WSAPI 1.2) NON_EXISTENT_VOL 404 Not found Requested volume does not exist. (Since WSAPI 1.2) NON_EXISTENT_HOST 404 Not found INV_INPUT_PORT_SPECIFICATION 400 Bad Request Requested host does not exist. Incorrect port specification. (Since WSAPI 1.2) INV_INPUT_ILLEGAL_CHAR 400 Bad Request Volume name or host name contains invalid character.
9 Performing Copy Operations You can use the WSAPI server to make snapshots of volumes and VV sets, make physical copies of volumes and VV sets, resynchronize a physical copy to its parent volume or VV set, and to stop a physical-copy operation. Creating Snapshots To create a snapshot of a volume, use the HTTP POST method in the URI: https://:8080/api/v1/volumes/ where is the name of the volume being copied.
The message body is a JSON object with two members, action and parameters. The action member must have the value createPhysicalCopy, and the parameters member is a JSON object with members as described in Table 103 (page 113). Table 103 Message Body parameters JSON Object Members for Physical Copy Creation Member JSON Type API Type Ignored Values Description destVolume string name31 (Required) Specifies the destination volume. Since WSAPI 1.
Physical Copy of Volume Creation Success A successful operation returns the HTTP status code 200 OK. The response location header will contain the destination-volume URI. The body of the JSON object will return the task ID of the physical-copy task. Physical Copy of Volume Errors Possible errors during the creation, resynchronization, or stopping of physical copies of volumes are shown in Table 105 (page 114). For generic API error codes, see Table 5 (page 22).
Table 105 Error Codes for Creation, Resynchronization, or Stopping of Physical Copies of Volumes (continued) API Error HTTP Code Description INV_OPERATION_VV_READONLY_SNAPSHOT 403 Forbidden The parent volume is a read-only snapshot. (Since WSAPI 1.3) INV_OPERATION_VV_COPY_TO_BASE 403 Forbidden The destination volume is the base volume of a parent volume. (Since WSAPI 1.3) INV_OPERATION_VV_VOLUME_CONV_IN_PROGRESS 409 Conflict The volume is in a conversion operation. (Since WSAPI 1.
Table 105 Error Codes for Creation, Resynchronization, or Stopping of Physical Copies of Volumes (continued) API Error HTTP Code INV_OPERATION_VV_COPY_PARENT_TOO_BIG 409 Conflict Description The size of the parent volume is larger than the size of the destination volume. (Since WSAPI 1.3) INV_OPERATION_VV_NO_PARENT 403 Forbidden The volume has no physical parent. (Since WSAPI 1.3) IN_USE 409 Conflict The resynchronization snapshot is in use. (Since WSAPI 1.
Promoting a Virtual Copy To promote the changes from a virtual copy back onto the base volume, thereby overwriting the base volume with the virtual copy, use the HTTP PUT method on the following URL: https://:8080/api/vi/volumes/ where is the name of the virtual copy to be promoted. The message body is a JSON object with members as described in Table 107 (page 117).
Table 108 Virtual Copy Promotion Error Codes (continued) API Error HTTP Code Description (Since WSAPI 1.3) VV_IS_BEING_REMOVED 403 Forbidden The volume is being removed. (Since WSAPI 1.3) VV_IN_STALE_STATE 403 Forbidden The volume is in a stale state. (Since WSAPI 1.3) INV_OPERATION_CANNOT_STOP_ONLINE_PROMOTE 403 Forbidden Invalid operation: The online promote cannot be stopped. Instead, use canceltask. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.
Table 108 Virtual Copy Promotion Error Codes (continued) API Error HTTP Code Description INV_OPERATION_PARAM_CONFLICT 409 Conflict Invalid Input: Parameters cannot be present at the same time. INV_OPERATION_VV_IS_BUSY 409 Conflict Invalid operation: Volume is currently busy. (Since WSAPI 1.3) INV_OPERATION_VV _PROMOTE_IN_PROGRESS 409 Conflict Invalid operation: Volume promotion is in progress. (Since WSAPI 1.
Table 109 VV-Set Snapshot Creation Error Codes (continued) API Error HTTP Code Description VV_LIMIT_REACHED 503 Service Unavailable Maximum number of volumes has been reached. (Since WSAPI 1.3) NON_EXISTENT_VOL 404 Not Found The storage volume does not exist. VV_IS_BEING_REMOVED 403 Forbidden The VV is being removed. (Since WSAPI 1.3) INV_OPERATION_VV_READONLY_TO_READONLY_SNAP 403 Forbidden Creating a read-only copy from a read-only volume is not permitted. (Since WSAPI 1.
Table 109 VV-Set Snapshot Creation Error Codes (continued) API Error HTTP Code Description INV_OPERATION_VV_CLEANUP_IN_PROGRESS 403 Forbidden Internal volume cleanup is in progress. (Since WSAPI 1.3) INV_OPERATION_VV_PEER_VOLUME Operation not allowed on peer volume. 403 Forbidden (Since WSAPI 1.2) Invalid operation. Online copy is in progress. INV_OPERATION_VV_ONLINE_COPY_IN_PROGRESS 409 Conflict (Since WSAPI 1.2) INV_OPERATION_VV_INTERNAL_VOLUME Operation not allowed on internal volume.
Table 110 parameters JSON Object Members for Creating a Physical Copy of a VV set (continued) Member JSON Type API Type Ignored Values Description The default is medium. (Since WSAPI 1.3) Physical Copy of VV Set Creation Success A successful operation returns the HTTP status code 201 Created.
Table 113 Message Body resyncPhysicalCopy JSON Object for Resynchronizing a Physical Copy to Its VV Set Member JSON Type API Type Ignored Values Description priority number TaskPriority Enum Zero and negative values. 1: high 2: medium The default is medium. 3: low (Since WSAPI 1.3) action number setAction Enum Zero and negative values. Action to perform. See Table 114 (page 123). This is required for resynchronizing or stopping a physical copy.
Errors for Resynchronizing a Physical Copy to Its VV Set, or Stopping a Physical Copy of a VV Set For possible errors following a request to synchronize a physical copy to its VV set, or for stopping the physical copy of a VV set, see “Physical Copy of VV set Creation Errors” (page 122).
VV Set Virtual Copy Promotion Errors Possible errors during the promotion of VV set virtual copies are shown in Table 116 (page 125). For generic API error codes, see Table 5 (page 22). Table 116 VV Set Virtual Copy Promotion Error Codes API Error HTTP Code Description VV_NOT_STARTED 403 Forbidden The volume is not started. (Since WSAPI 1.3) VV_IS_BEING_REMOVED 403 Forbidden The volume is being removed. (Since WSAPI 1.3) VV_IN_STALE_STATE 403 Forbidden The volume is in a stale state.
Table 116 VV Set Virtual Copy Promotion Error Codes (continued) API Error HTTP Code INV_OPERATION_PARENT_SIZE_HAS_INCREASED 409 Conflict Description Invalid operation: The parent volume size has increased. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) INV_OPERATION_PARAM_CONFLICT 409 Conflict Invalid Input: Parameters cannot be present at the same time. INV_OPERATION_VV_IS_BUSY 409 Conflict Invalid operation: Volume is currently busy. (Since WSAPI 1.
10 Working with System, Version, and Task Information This chapter describes how to get information about: • The storage system as a whole • System configuration • System version • Querying tasks • Modifying tasks Getting Storage System Information To query for storage system information, use the HTTP GET method in the URI, with no message body: https://:8080/api/v1/system NOTE: Getting system-wide storage-system information became available with WSAPI 1.2.
Table 117 JSON Objects for Storage-system Query Response (continued) Member JSON Type API Type Description owner string print511 Owner of the system. contact string print511 Contact of the system. comment string print511 Any comment about the system. timeZone string print511 Time zone where the system is located Storage-system Query Errors Possible error codes are shown in Table 118 (page 128). For generic API error codes, see Table 5 (page 22).
Getting WSAPI Configuration Information To query for WSAPI configuration information, use the HTTP GET method in the URI, with no message body: https://:8080/api/v1/wsapiconfiguration The systemResourceUsage member of wsapiconfiguration HTTP GET operation output represents the theoretical maximum of sessions the WSAPI server can handle at any given time.
Table 121 Message Body JSON Objects for WSAPI Configuration Query (continued) Member JSON Type Value Range Description sessions that the WSAPI server can handle, theoretically, at any given time. Example: 240 (Since WSAPI 1.3) The following sample response shows the SRU (systemResourceUsage) as 144 concurrent sessions: Response: { httpState: "Enabled" httpPort: 8008 httpsState: ”Enabled” httpsPort: 8080 version: ”1.3.
All-Tasks Status Query Errors For error codes following a single-task status query, see Table 127 (page 133). For generic API error codes, see Table 5 (page 22). Querying the Status of a Single Task To query the status of a single task, use the HTTP GET method on the following URI: https://:8080/api/v1/tasks/ where is the task ID.
Table 124 Message Body JSON Object Members for Copy Single-Task Status Query (continued) Member JSON Type API Type Description (Since WSAPI 1.3) User string string The user who initiated the task. (Since WSAPI 1.3) Enumeration for the taskTypeEnum JSON object is shown in Table 125 (page 132). Table 125 tasktypeEnum Enumeration for Single-Task Query Symbol Value Description VV_COPY 1 Track the physical copy operations. PHYS_COPY_RESYNC 2 Track physical copy resynchronization operations.
Table 125 tasktypeEnum Enumeration for Single-Task Query (continued) Symbol Value Description IMPORT_VV 17 Track tasks that migrate data to the local storage system. ONLINE_COPY 18 Track physical copy of VV while online. (createvvcopy -online command) 19 CONVERT_VV Track tasks that are converting a volume from an FPVV to a TPVV and vice-versa. Enumeration for the taskStatusEnum JSON object is shown in Table 126 (page 133).
Table 129 taskAction Enumeration for Canceling a Task Symbol Value Description CANCEL_TASK 1 Cancels the ongoing task. (Since WSAPI 1.3.1 with HP 3PAR OS 3.1.3 MU1) Task Cancellation Success Upon a successful request to cancel a task, the HTTP code 200 OK is returned. Task Cancellation Errors Possible error codes following a request to cancel a task are shown in Table 130 (page 134). For generic API error codes, see Table 5 (page 22).
11 Querying Available Space This chapter describes querying for information about overall available space on the system, and about querying available space based on CPG and LD layout. Querying Overall System Capacity Space information can be queried for the overall capacity, for a given CPG name, or for an LDLayout object.
Table 132 DeviceCapacity JSON Objects (continued) Member JSON Type API Type Description freeUninitializedMiB Number uint64 Free uninitialized capacity. (Since WSAPI 1.2) Number failedCapacityMiB uint64 Failed capacity in MiB. (Since WSAPI 1.2) unavailableCapacityMiB Number uint64 Unavailable Capacity. (Since WSAPI 1.2) AllocatedCapacity is a sub-object of the overall capacity object. Its JSON object members are shown in Table 133 (page 136).
Table 134 Volumes JSON Objects (continued) Member JSON Type Value Range Description CPGsMiB number uint64 Total capacity allocated to CPGs. (Since WSAPI 1.2) CPGUserMiB number uint64 User CPG space. (Since WSAPI 1.2) CPGUserUsedMiB number uint64 The CPG (TPVVs and CPVVs) allocated to user space that is in use. (Since WSAPI 1.2) CPGUserUnusedMiB number uint64 The CPG (TPVVs and CPVVs) allocated to user space that is not in use. (Since WSAPI 1.
Table 135 System JSON Objects Member JSON Type Value Range Description totalSystemMiB number uint64 System space capacity. (Since WSAPI 1.2) internalMiB number uint64 The system capacity allocated to internal resources. (Since WSAPI 1.2) spareMiB number uint64 Total spare capacity. (Since WSAPI 1.2) spareUsedMiB number uint64 The system capacity allocated to spare resources in use. (Since WSAPI 1.
In response to a query for space information for a given CPG or LDLayout object, the system will return a single JSON object. Members of the CPG query response for available space are shown in Table 137 (page 139). Table 137 JSON Objects for cpg Space Query Response Member JSON Type Value Range Description LDLayoutCapacity LDLayoutCapacity object See Table 139 (page 139). Capacity allocated to a layout associated with the CPG name. (Since WSAPI 1.
12 WSAPI Support for HP 3PAR Priority Optimization HP 3PAR Priority Optimization software uses quality-of-service rules to manage and control the I/O capacity of an HP 3PAR StoreServ Storage system across multiple workloads. Application of the rules enables co-location of the data from workloads of different types (such as sequential, random, and transactional, among others), with different I/O packet sizes on a single HP 3PAR storage system.
Table 141 Message Body JSON Object Members for QoS Rule Creation (continued) Member JSON Type API Type Ignored Values Description bwMaxLimitKB number uint64 Zero and negative values. Bandwidth rate maximum limit in kilobytes per second. Since WSAPI 1.3 ioMinGoal number uint32 Zero and negative values. I/O-per-second minimum goal. Since WSAPI 1.3 ioMaxLimit number uint32 Zero and negative values. I/O-per-second maximum limit. Since WSAPI 1.
Table 141 Message Body JSON Object Members for QoS Rule Creation (continued) Member JSON Type API Type Ignored Values Description value. Default is False. Since WSAPI 1.3 enable Boolean If True, enable the QoS rule for the target object. If False, disable the QoS rule for the target object. Since WSAPI 1.3 Enumeration for the ZeroNoneOperation JSON object is shown in Table 142 (page 142).
Table 143 QoS Rule Creation and Modification Error Codes (continued) API Code HTTP Code Description INV_INPUT_BW_MIN_GOAL_GRT_MAX_LIMIT 400 Bad Request The bandwidth maximum limit should be greater than the minimum goal. Since WSAPI 1.3 INV_INPUT_BELOW_RANGE 400 Bad Request I/O-per-second limit is below range. Bandwidth limit is below range. Since WSAPI 1.3 UNLICENSED_FEATURE 400 Bad Request This system is not licensed for QoS.
Table 144 Message Body JSON Object Members for QoS Rule Modification (continued) Member JSON Type API Type Ignored Values Description bwMaxLimitKB number uint64 Zero and negative values. Bandwidth rate maximum limit in kilobytes per second. Since WSAPI 1.3 ioMinGoal ioMaxLimit bwMinGoalOP number number number uint32 uint32 Zero and negative values. I/O-per-second minimum goal. Zero and negative values. I/O-per-second maximum limit. ZeroNoneOperation Zero and negative Enum values.
QoS Rules Modification Errors Possible error codes for QoS rule modification are shown in Table 143 (page 142). For generic API error codes, see Table 5 (page 22). Deleting QoS Rules Scheduling of the QoS rule can be turned off, and the setting can be cleared, by using the HTTP DELETE method. The URI is in the following format: https://:8080/api/v1/qos/targetType:{targetName} where: • targetType can be vvset or sys. • targetName is the name of the target.
Table 147 JSON Object Members for Members Object in All-QoS Rule Query Member JSON Type API Type Description id number uint32 ID of the QoS target. Since WSAPI 1.3 type number targetType Enum Type of QoS target. See Table 148 (page 146). Since WSAPI 1.3 name string Name27 Name of the target. Since WSAPI 1.3 domain string name31 Name of the domain. Since WSAPI 1.3 enabled Boolean QoS state of the target. Since WSAPI 1.3 priority number priority Enum QoS priority.
Table 149 QoS priority Enumeration Symbol Value Description LOW 1 The QoS priority is low. NORMAL 2 The QoS priority is normal. HIGH 3 The QoS priority is high. All-QoS Rule Query Errors For generic API error codes, see Table 5 (page 22). Querying a Single QoS Rule To query for information about a single QoS, use the HTTP GET method on the following URI: https://:8080/api/v1/qos/targetType:{targetName} where: • targetType can be vvset or sys.
13 Support and Other Resources Contacting HP For worldwide technical support information, see the HP support website: http://www.hp.
For information about: See: Migrating data from one HP 3PAR storage system to another HP 3PAR-to-3PAR Storage Peer Motion Guide Configuring the Secure Service Custodian server in order to monitor and control HP 3PAR storage systems HP 3PAR Secure Service Custodian Configuration Utility Reference Using the CLI to configure and manage HP 3PAR Remote Copy HP 3PAR Remote Copy Software User’s Guide Updating HP 3PAR operating systems HP 3PAR Upgrade Pre-Planning Guide Identifying storage system components
For information about: See: Planning for HP 3PAR storage system setup Hardware specifications, installation considerations, power requirements, networking options, and cabling information for HP 3PAR storage systems HP 3PAR 7200, 7400, and 7450 storage systems HP 3PAR StoreServ 7000 Storage Site Planning Manual HP 3PAR StoreServ 7450 Storage Site Planning Manual HP 3PAR 10000 storage systems HP 3PAR StoreServ 10000 Storage Physical Planning Manual HP 3PAR StoreServ 10000 Storage Third-Party Rack Physic
Typographic conventions Table 152 Document conventions Convention Element Bold text • Keys that you press • Text you typed into a GUI element, such as a text box • GUI elements that you click or select, such as menu items, buttons, and so on Monospace text • File and directory names • System output • Code • Commands, their arguments, and argument values • Code variables • Command variables Bold monospace text • Commands you enter into a command line interface • Syst
14 Documentation feedback HP is committed to providing documentation that meets your needs. To help us improve the documentation, send any errors, suggestions, or comments to Documentation Feedback (docsfeedback@hp.com). Include the document title and part number, version number, or the URL when submitting your feedback.
Index A Accept client HTTP header, 15, 16 Accept-Language client HTTP header, 16 accessing WSAPI, 14, 38 Action JSON object for promoting a virtual copy, 117 action JSON Object for resynchronizing physical copy to parent volume, 116 JSON object for creating a physical copy of a VV set, 121 for physical-copy of volume creation, 113 for promoting a VV set virtual copy, 124 for snapshot creation, 112 JSON object member for canceling a task, 133 for host-set or VV-set creation, 87 for resynchronizing or stoppin
for VLUN template creation, 102 available space querying, 135 B BACKGROUND_TASK enumeration for single-task status query, 132 BAD_CPG_PATTERN CPG creation and modification API error, 47 space query API error, 139 BAD_PORT_TYPE VLUN creation API error, 103 BASE enumeration for volume operations, 52 base volume creating, 55 baseId JSON object member for all-volumes query, 69 Boolean vs.
Accept, 16 Accept-Language, 16 Content-Length, 16 Content-Type, 16 example, 15 format, 15 X-HP3PAR-WSAPI-SessionKey, 16 CLOSING enumeration for volume operations, 53 CLRF in chunked all-VLUNs query responses, 106 clusterId JSON object member for host query, 83 clusterName JSON object member for host query, 83 clusterNodes JSON object member for storage-system query response, 127 clusters, 40 clusterSoftware JSON object member for host query, 83 clusterVersion JSON object member for host query, 83 CNA enumer
CPG modification error codes, 47, 49 success response, 48 CPG query error codes, 50 success response, 50 CPG removal error codes, 49 success response, 49 CPG_ALLOCATION_WARNING_REACHED VV-set snapshot creation API error, 120 cpg_create permissions for, 46 CPG_NOT_IN_SAME_DOMAIN CPG creation and modification API error, 47 creation, resynchronizing, or stopping physical copy of volumes API error, 114 volume modification API error, 60 volume tuning API error, 66 cpg_remove permissions for, 49 cpg_set permissio
JSON object for host query, 81 JSON object member, 74 for host modification, 76 for host query, 80 destCPG JSON object member for physical copy of volume creation, 113 destVolume JSON object member for creating a physical copy of a VV set, 121 for physical copy of volume creation, 113 DetailedState enumeration for CPG operations, 45 enumeration for volume operations, 53 device JSON object member for port query, 95 DeviceCapacity JSON object overall system capacity query response, 135 DHCP_IN_PROGRESS enumer
for volume operations, 52 taskPriorityEnum for creating physical copy of volumes, 113 tuneOperationEnum for tuning a volume, 65 VLUNtype for VLUN operations, 100 vvPhysicalCopyActionEnum for physical copy operations, 116 enumeration objects for CPGs, 42 epoch API type, 19 error codes all-QoS rule query, 147 all-VLUNs query, 108 CPG creation and modification, 47 CPG query, 50 CPG removal, 49 creating physical copy of volume, 114 FC-switch query, 99 for canceling a task, 134 for chunked encoding, 70 for query
enumeration for volume operations, 53 FAILED_OVER enumeration for port operations, 93 failedCapacityMB JSON object member for storage-system query response, 127 failedCapacityMiB JSON object member overall system capacity query response, 136 failedPathInterval JSON object member for all-VLUNs query response, 107 for single-VLUN query response, 110 failedPathPol enumeration for VLUN operations, 101 JSON object member for all-VLUNs query response, 107 for single-VLUN query response, 110 failedStates JSON obje
enumeration for growing volume, 61 growing volumes success response, 62 growthIncrementMiB JSON object for CPG creation, 46 growthLimitMiB JSON object for CPG creation, 46 H HA enumeration for CPG operations, 43 JSON object member for CPG operations, 42 hardAddr JSON object member for port-device query, 97 HAS_CHILD volume removal API error, 68 HAS_RO_CHILD volume removal API error, 68 Hex API type, 19 HIGH enumeration for creating physical copy of volume, 113 high-availability setting see HA HOST enumerat
HPUX enumeration for host modification, 77 HPUX_LEGACY enumeration for host modification, 77 HTTP error codes, 21, 38 requests and replies, 14 status codes, 21 HTTP client request example of bad request, 38 HTTP DELETE for QoS rule deletion, 145 for removing a CPG, 49 for removing a host, 79 for removing a host set, 88 for removing a session key, 41 for removing a storage volume, 67 for removing a VLUN, 104 for removing a VV set, 88 supported, 15 HTTP GET for filtering WWNs during volume query, 71 for query
for all-QoS rule query, 146 for all-volumes query, 68 for base-volume creation, 55 for querying all host sets or all VV sets, 89 for snapshot creation, 112 for storage-system query response, 127 IDLE_FOR_RESET enumeration for port operations, 92 igint32 API type, 19 IMPORT_VV enumeration for single-task status query, 133 IMPORTING enumeration for volume operations, 53 IN_USE CPG creation and modification API error, 47 CPG removal API error, 49 creation, resynchronizing, or stopping physical copy of volumes
single-CPG query API error, 51 single-VLUN query API error, 111 single-volume query API error, 71 volume tuning API error, 66 INV_INPUT_IO_MIN_GOAL_GRT_MAX_LIMIT QoS rule modification API error, 142 INV_INPUT_MATCHED_HOSTSET VLUN creation API error, 103 INV_INPUT_MISSING_REQUIRED CPG creation and modification API error, 47 generic API error, 23 host creation API error, 74 host modification API error, 78 single-VLUN query API error, 110 VLUN creation API error, 103 VLUN removal API error, 105 INV_INPUT_NO_RE
INV_OPERATION_VV_COPY_TO_SELF creation, resynchronizing, or stopping physical copy of volumes API error, 114 INV_OPERATION_VV_CPG_ON_SNAPSHOT volume modification API error, 61 INV_OPERATION_VV_EXPORTED creation, resynchronizing, or stopping physical copy of volumes API error, 114 virtual-copy promotion API error, 118 VV set virtual-copy promotion API error, 125 INV_OPERATION_VV_FAILED_ONLINE_COPY creation, resynchronizing, or stopping physical copy of volumes API error, 115 INV_OPERATION_VV_IN_REMOTE_COPY c
INV_URI generic API error, 24 INV_URL_PERCENT_ENCODING generic API error, 23 INV_USER_PASS generic API error, 22 INV_UTF generic API error, 24 INVALID enumeration for CPG operations, 46 enumeration for volume operations, 53 INVALID_INPUT_VV_PATTERN VV-set snapshot creation API error, 119 INVALID_OPERATION_VV_ONLINE_COPY_IN_PROGRESS volume modification API error, 60 INVALID_OPERATION_VV_SNAPSPACE_NOT_MOVED_TO_CPG volume modification API error, 60 INVALID_OPERATION_VV_VOLUME_CONV_IN_PROGRESS volume modificati
L label JSON object member for port query, 94 LAST enumeration for CPG operations, 43 latencyGoal JSON object for QoS rule creation, 141 for QoS rule modification, 144 JSON object member for all-QoS rule query, 146 LDLayout JSON object for CPG creation, 46 for CPG operations, 42 JSON object member for CPG operations, 45 for CPG space query, 139 LDLayout object space query, 138 LDLayout space query error codes, 139 LDLayoutCapacity JSON object member for CPG space query , 139 LDS_NOT_STARTED enumeration for
for single-VLUN query response, 109 for snapshot creation, 112 JSON object member for all-QoS rule query, 145 for all-VLUNs query response, 106 for FC-switches query, 98 for port-device query, 96 for querying all host sets or all VV sets, 89 for single-VLUN query response, 109 message body for modifying a host, 75 method HTTP, 15 minor JSON object member for storage-system version query response, 128 MISSING_VLUN_EXPORT_INFO VLUN creation API error, 103 mode JSON object member for port query, 94 model JSON
task modification API error, 134 NON_EXISTENT_CHAP host modification API error, 79 NON_EXISTENT_CPG CPG creation and modification API error, 48 CPG removal API error, 49 creation, resynchronizing, or stopping physical copy of volumes API error, 114 single-CPG query API error, 51 space query API error, 139 volume tuning API error, 66 NON_EXISTENT_DOMAIN CPG creation and modification API error, 48 generic API error, 23 host set or VV set creation API error, 86 NON_EXISTENT_HOST generic API error, 22 host modi
osVersion JSON object member for host query, 83 OTHER generic API error, 22 WSAPI configuration query API error, 130 overall available space query error codes, 139 overall capacity querying, 135 overall system capacity query success response, 135 overrideLowerPriority JSON object for VLUN template creation, 102 owner JSON object member for storage-system query response, 128 P parameters JSON object for creating a physical copy of a VV set, 122 for physical-copy of volume creation, 113 parent JSON object me
JSON object member for port-device query, 97 portlinkState enumeration for port operations, 91 portList JSON object member for CPG operations, 43 portMode enumeration for port operations, 91 portPos JSON object for host query, 82 for VLUN operations, 100 for VLUN template creation, 102 JSON object member for all-VLUNs query response, 107 for host query, 81, 82 for port query, 94 for single-VLUN query response, 110 portProtocol enumeration for port operations, 92 ports configuring, 91 enumeration objects for
all host sets, 89 all hosts, 80 all ports, 93 all QoS rules, 145 all VLUNs, 106 all volumes, 68 all VV sets, 89 all-tasks status, 130 by iSCSI name, 84 by WWN, 84 CPG available space, 138 FC switches, 20 host information, 84 host objects, 20 LDLayout object available space, 138 overall available space, 135 overall capacity, 135 port devices, 20 single-task status, 131 storage system information, 127 version information, 128 VV objects, 20 VV-set physical copy status, 126 with filters, 20 querying overall ca
retentionHours JSON object member for base-volume creation, 56 for snapshot creation, 112 for volume modification, 58 retentionTime8601 JSON object member for all-volumes query, 69 retentionTimeSec JSON object member for all-volumes query, 69 rmExpTime JSON object member for volume modification, 58 rmGrowthLimit JSON object for CPG creation, 47 JSON object member for modifying CPGs, 48 rmSsSpcAllocLimit JSON object member for volume modification, 59 rmSsSpcAllocWarning JSON object member for volume modifica
security session key, 40 Serial-attached SCSI see SAS serialNumber JSON object member for storage-system query response, 127 Server server HTTP header, 17 server WSAPI configuring, 11 starting, 11 server HTTP header Cache-Control, 17 Connection, 17 Content-Type, 17 Date, 17 format, 17 Location, 17 Pragma, 17 Server, 17 serviceParams JSON object member for port-device query, 97 session key creating, 39 deleting, 41 multiple, 40 security, 40 timed expiration of, 41 WSAPI, 38 session key creation example, 39 e
enumeration for volume operations, 52 SNP_CPG enumeration for changing the snap CPG of a volume, 65 software development kit see SDK space available querying, 135 space JSON objects for volume operations, 54 space query error codes, 139 success response, 138 spareMiB JSON object member overall system capacity query response, 138 spareUnusedMiB JSON object member overall system capacity query response, 138 spareUsedMiB JSON object member overall system capacity query response, 138 SSD enumeration for CPG ope
QoS rule creation, 142 QoS rule deletion, 145 QoS rule modification, 144 QoS rule query, 145 session key deletion, 41 session-key creation, 39 single QoS-rule query, 147 single-CPG query, 51 single-task status query, 131 single-volume query, 71 space query, 138 task cancellation, 134 tuning volumes, 65 VLUN creation, 102 VLUN removal, 105 volume creation, 56 volume query, 68 volume removal, 67 VV set modification, 87 VV set removal, 88 VV-set snapshot creation, 119 WSAPI configuration query, 129 WWN filter
totalMiB JSON object member for CPG operations, 45 overall system capacity query response, 135 totalNodes JSON object member for storage-system query response, 127 totalPhases JSON object member for single-task status query, 131 totalSteps JSON object member for single-task status query, 131 totalSystemMiB JSON object member overall system capacity query response, 138 totalVolumesMiB JSON object member overall system capacity query response, 136 TPVV, 42 enumeration for converting a volume to a TPVV, 65 enu
for querying single-task status, 131 for querying system information, 127 for querying version information, 128 for querying WSAPI configuration information, 129 for removing a CPG, 49 for removing a host, 79 for removing a storage volume, 67 for resynchronizing a physical copy to parent volume, 116 for resynchronizing a physical copy to parent VV set, 122 for session key creation, 38 for stopping a physical copy of a volume, 116 for stopping a physical copy of a VV set, 122 for successful CPG creation, 47
error codes, 103 example, 104 success response, 102 VLUN query success response, 109 VLUN removal error codes, 105 example, 105 success response, 105 VLUN template creating, 100 VLUN type enumeration for VLUN operations, 100 vlun_create permissions for, 101 vlun_remove permissions for, 104 VLUNs single-VLUN query error codes, 110 VMWARE enumeration for host modification, 77 volume configuration objects for, 52 enumeration objects for, 52 modifying, 57 removing, 67 space JSON objects, 54 volume creation, 55
VV-set snapshot creation API error, 120 VV_IS_BEING_REMOVED creation, resynchronizing, or stopping physical copy of volumes API error, 115 host or VV set modification API error, 88 virtual-copy promotion API error, 118 volume growth API error, 63 volume tuning API error, 66 VV set creation API error, 86 VV set virtual-copy promotion API error, 125 VV-set snapshot creation API error, 120 VV_LIMIT_REACHED VV-set snapshot creation API error, 120 VV_NEEDS_TO_BE_CHECKED volume tuning API error, 67 VV_NEW_SIZE_EX
