HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 4
... CopyType Enumeration Types 38 Volume state Enumeration Types 38 Volume DetailedState Enumeration Types 39 Volume policies Configuration Object 40 Volume Space Objects...40 Creating a Storage Volume...41 Creating Base Volumes...41 Creating Snapshot Volumes 42 Volume Creation Success...43 Volume Creation Errors...43 Modifying a Virtual Volume...44 Volume Modification Success 46 Volume...
... CopyType Enumeration Types 38 Volume state Enumeration Types 38 Volume DetailedState Enumeration Types 39 Volume policies Configuration Object 40 Volume Space Objects...40 Creating a Storage Volume...41 Creating Base Volumes...41 Creating Snapshot Volumes 42 Volume Creation Success...43 Volume Creation Errors...43 Modifying a Virtual Volume...44 Volume Modification Success 46 Volume...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 7
Tables 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests 12 2 Server HTTP Headers in the WSAPI 13 3 Session Key Message Body Member JSON Objects 14 4 Message Body JSON Objects for Session ... Message Body parameters JSON Object Members for Snapshot-volume Creation 43 33 Base-volume and Snapshot-volume Creation Error Codes 43 34 Message Body JSON Objects for Volume Modification Request 44 35 Volume Modification Request Error Codes 46 36 Storage Volume Removal Error Codes 48 37 Message Body JSON Objects for Volume...
Tables 1 Client HTTP Headers Supported by the HP 3PAR WSAPI for Requests 12 2 Server HTTP Headers in the WSAPI 13 3 Session Key Message Body Member JSON Objects 14 4 Message Body JSON Objects for Session ... Message Body parameters JSON Object Members for Snapshot-volume Creation 43 33 Base-volume and Snapshot-volume Creation Error Codes 43 34 Message Body JSON Objects for Volume Modification Request 44 35 Volume Modification Request Error Codes 46 36 Storage Volume Removal Error Codes 48 37 Message Body JSON Objects for Volume...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 10
These examples rely on the accessor and base packages. Perl SDK The Perl SDK includes: • A module with methods for creating objects. • An example client interface which demonstrates the ...that demonstrates creation, querying, and deleting of base entities. Java SDK The Java SDK includes: • Core "storage-entity" classes representing the attributes of HP 3PAR storage system objects (hosts, ports, CPGs, volumes, VLUNs, etc.) and input parameters (members) for accessing the HP 3PAR storage system. • Modules with the base classes. • Example programs to illustrate...
These examples rely on the accessor and base packages. Perl SDK The Perl SDK includes: • A module with methods for creating objects. • An example client interface which demonstrates the ...that demonstrates creation, querying, and deleting of base entities. Java SDK The Java SDK includes: • Core "storage-entity" classes representing the attributes of HP 3PAR storage system objects (hosts, ports, CPGs, volumes, VLUNs, etc.) and input parameters (members) for accessing the HP 3PAR storage system. • Modules with the base classes. • Example programs to illustrate...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 16
...HTTP Status and Error Codes When an operation is successful, the system returns one of several HTTP status codes is subject to change behavior based on errors, only the code member should delete the session keys it created. The JSON object contains the following HTTP status codes: ...Key When a client is not part of reading documentation, a symbol is defined for each numeric code, but the symbol is finished making requests to the HP 3PAR WSAPI. The numeric value is a JSON numeric type. Only codes that problem, the WSAPI provides a reliable code for an error. Host: InServ1:8008 ...
...HTTP Status and Error Codes When an operation is successful, the system returns one of several HTTP status codes is subject to change behavior based on errors, only the code member should delete the session keys it created. The JSON object contains the following HTTP status codes: ...Key When a client is not part of reading documentation, a symbol is defined for each numeric code, but the symbol is finished making requests to the HP 3PAR WSAPI. The numeric value is a JSON numeric type. Only codes that problem, the WSAPI provides a reliable code for an error. Host: InServ1:8008 ...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 20
...has a read-only child. 26 409 Conflict The VLUN is available for the requested LD layout are required for the operation. This varies based on the following circumstances: • In volume creation, when the CPG contains insufficient space 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 in the process of...
...has a read-only child. 26 409 Conflict The VLUN is available for the requested LD layout are required for the operation. This varies based on the following circumstances: • In volume creation, when the CPG contains insufficient space 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 in the process of...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 38
... Physical copy (full copy). Table 26 Volume CopyType Enumeration Symbol BASE PHYSICAL_COPY VIRTUAL_COPY Value 1 2 3 Description Base volume (not a copy). Volume provisioningType Enumeration Types Enumeration for the base volume allocated from the base volume's snapshot space. 4 Remote volume admitted into the local storage system. 5 Unknown. 4 Working with Storage Volumes This chapter describes how to creation, modification, and...
... Physical copy (full copy). Table 26 Volume CopyType Enumeration Symbol BASE PHYSICAL_COPY VIRTUAL_COPY Value 1 2 3 Description Base volume (not a copy). Volume provisioningType Enumeration Types Enumeration for the base volume allocated from the base volume's snapshot space. 4 Remote volume admitted into the local storage system. 5 Unknown. 4 Working with Storage Volumes This chapter describes how to creation, modification, and...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 41
... object with the actual storage system's host name or IP address. None Negative values Description Specifies a VV name up to 31 characters in MiB. The volume size is chosen. Specifies any role granted the vv_create right (for base volumes) or sv_create (for snapshot volumes), can be found in the HP 3PAR Command Line Interface...
... object with the actual storage system's host name or IP address. None Negative values Description Specifies a VV name up to 31 characters in MiB. The volume size is chosen. Specifies any role granted the vv_create right (for base volumes) or sv_create (for snapshot volumes), can be found in the HP 3PAR Command Line Interface...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 42
...time that the value will expire. The snapshot space of the virtual volume size. Table 31 Message Body JSON Objects for Base-volume Creation (continued) Member JSON Type API Type ssSpcAllocLimitPct number igint32 tpvv Boolean Boolean Ignored Values Negative values None Description warning.... Specifies the relative time from growing beyond the indicated percentage of the virtual volume is a positive integer with Storage Volumes Sets a snapshot space allocation limit. After this size is generated when the reserved snapshot space of the virtual volume ...
...time that the value will expire. The snapshot space of the virtual volume size. Table 31 Message Body JSON Objects for Base-volume Creation (continued) Member JSON Type API Type ssSpcAllocLimitPct number igint32 tpvv Boolean Boolean Ignored Values Negative values None Description warning.... Specifies the relative time from growing beyond the indicated percentage of the virtual volume is a positive integer with Storage Volumes Sets a snapshot space allocation limit. After this size is generated when the reserved snapshot space of the virtual volume ...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 43
... true and name and copyofName are required. Volume Creation Success A successful operation returns the HTTP status code 200 OK. Table 33 Base-volume and Snapshot-volume Creation Error Codes API Error INV_INPUT EXISTENT_VOL HTTP Code 400 Bad Request 409 Conflict Description Invalid parameter or JSON ... 32 Message Body parameters JSON Object Members for the volume. false: (default) The volume is chosen. The volume already exists. Creating a Storage Volume 43 The action member is a string with the value createSnapshot and the parameters member is the name of 1-43,800 hours, or 1825...
... true and name and copyofName are required. Volume Creation Success A successful operation returns the HTTP status code 200 OK. Table 33 Base-volume and Snapshot-volume Creation Error Codes API Error INV_INPUT EXISTENT_VOL HTTP Code 400 Bad Request 409 Conflict Description Invalid parameter or JSON ... 32 Message Body parameters JSON Object Members for the volume. false: (default) The volume is chosen. The volume already exists. Creating a Storage Volume 43 The action member is a string with the value createSnapshot and the parameters member is the name of 1-43,800 hours, or 1825...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 44
... or update a volume, use the HTTP PUT method in the URI: https://:8080/api/v1/volumes/ where is a JSON object with Storage Volumes The message body is the name of the volume. (Since WSAPI 1.2) comment string print511 None Comment about the volume. (Since WSAPI...(Since WSAPI 1.2) ssSpcAllocLimitPct number igint32 Zero and negative values Snap space allocation limit percent. 44 Working with members. Table 33 Base-volume and Snapshot-volume Creation Error Codes (continued) API Error HTTP Code Description INV_INPUT_WARN_GT_LIMIT 400 Bad Request Allocation warning level is ...
... or update a volume, use the HTTP PUT method in the URI: https://:8080/api/v1/volumes/ where is a JSON object with Storage Volumes The message body is the name of the volume. (Since WSAPI 1.2) comment string print511 None Comment about the volume. (Since WSAPI...(Since WSAPI 1.2) ssSpcAllocLimitPct number igint32 Zero and negative values Snap space allocation limit percent. 44 Working with members. Table 33 Base-volume and Snapshot-volume Creation Error Codes (continued) API Error HTTP Code Description INV_INPUT_WARN_GT_LIMIT 400 Bad Request Allocation warning level is ...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 81
... be queried for the overall capacity, for a given CPG name, or for information about overall available space on the system, and about querying available space based on CPG and LD layout. To query overall system capacity, use the HTTP GET method in the URI, with no message body: https://:8080/api...
... be queried for the overall capacity, for a given CPG name, or for information about overall available space on the system, and about querying available space based on CPG and LD layout. To query overall system capacity, use the HTTP GET method in the URI, with no message body: https://:8080/api...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 84
... cpg JSON Type string API Type name31 Description The CPG name. (Since WSAPI 1.2) LDLayout Object Space Query Members The members required to query space information based on the following URI: https://:8080/api/v1/spacereporter The members required to query the space information given a CPG are shown in Table 88 (page...
... cpg JSON Type string API Type name31 Description The CPG name. (Since WSAPI 1.2) LDLayout Object Space Query Members The members required to query space information based on the following URI: https://:8080/api/v1/spacereporter The members required to query the space information given a CPG are shown in Table 88 (page...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 89
... such as a text box • GUI elements that a procedure must be followed as directed in order to achieve a functional and supported implementation based on Monospace text • File and directory names • System output • Code • Commands, their arguments, and argument values •... previously referred to as the "InServ" is now referred to as the "HP 3PAR StoreServ Storage system." • The operating system previously referred to as the "InForm OS" is now referred to as the "HP 3PAR OS." • The user interface previously referred to as the "InForm Management...
... such as a text box • GUI elements that a procedure must be followed as directed in order to achieve a functional and supported implementation based on Monospace text • File and directory names • System output • Code • Commands, their arguments, and argument values •... previously referred to as the "InServ" is now referred to as the "HP 3PAR StoreServ Storage system." • The operating system previously referred to as the "InForm OS" is now referred to as the "HP 3PAR OS." • The user interface previously referred to as the "InForm Management...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 91
...base volume creating, 41 baseId JSON object member for all -volume query success response, 48 allCapacity JSON object member overall system capacity query response, 81 allocated JSON object member overall system capacity query response, 81 AllocatedCapacity JSON object overall system capacity query response, 82 allocatedCapacityMB JSON object member for storage... JSON object member for host query, 61 attributes Boolean vs. boolean attributes, 26 build JSON object member for storage-system version query response, 80 C Cache-Control server HTTP header, 13 91 boolean, 26 Integer vs. Index...
...base volume creating, 41 baseId JSON object member for all -volume query success response, 48 allCapacity JSON object member overall system capacity query response, 81 allocated JSON object member overall system capacity query response, 81 AllocatedCapacity JSON object overall system capacity query response, 82 allocatedCapacityMB JSON object member for storage... JSON object member for host query, 61 attributes Boolean vs. boolean attributes, 26 build JSON object member for storage-system version query response, 80 C Cache-Control server HTTP header, 13 91 boolean, 26 Integer vs. Index...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 92
...clusterId JSON object member for host query, 62 clusterName JSON object member 92 Index for host query, 62 clusterNodes JSON object member for storage-system query response, 79 clusterSoftware JSON object member for host query, 62 clusterVersion JSON object member for host query, 62 CNA enumeration ...member error codes, 16 command line interface see CLI comment JSON object member for all-volumes query, 50 for base-volume creation, 41 for host query, 60 for storage-system query response, 80 for volume modification, 44 common provisioning group see CPG CONFIG_WAIT enumeration for port operations,...
...clusterId JSON object member for host query, 62 clusterName JSON object member 92 Index for host query, 62 clusterNodes JSON object member for storage-system query response, 79 clusterSoftware JSON object member for host query, 62 clusterVersion JSON object member for host query, 62 CNA enumeration ...member error codes, 16 command line interface see CLI comment JSON object member for all-volumes query, 50 for base-volume creation, 41 for host query, 60 for storage-system query response, 80 for volume modification, 44 common provisioning group see CPG CONFIG_WAIT enumeration for port operations,...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 93
... 29 modifying, 34 removing, 35 single-CPG query, 37 space query, 84 with FPVVs, 29 with TPVVs, 29 cpg JSON object member for base-volume creation, 41 for CPG space query, 84 CPG creation success response, 33 CPG modification error codes, 34, 35 success response, 35 CPG query... JSON object for snapshot-volume creation, 43 createvv CLI command, 41 CREATING enumeration for volume operations, 39 creating a CPG, 33 a host, 52 a storage volume, 41 a VLUN, 69 creationTime8601 JSON object member for all-volumes query, 49 creationTimeSec JSON object member for all-volumes query, 49 cURL command-line...
... 29 modifying, 34 removing, 35 single-CPG query, 37 space query, 84 with FPVVs, 29 with TPVVs, 29 cpg JSON object member for base-volume creation, 41 for CPG space query, 84 CPG creation success response, 33 CPG modification error codes, 34, 35 success response, 35 CPG query... JSON object for snapshot-volume creation, 43 createvv CLI command, 41 CREATING enumeration for volume operations, 39 creating a CPG, 33 a host, 52 a storage volume, 41 a VLUN, 69 creationTime8601 JSON object member for all-volumes query, 49 creationTimeSec JSON object member for all-volumes query, 49 cURL command-line...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 95
...creation API error, 53 host modification API error, 57 EXISTENT_VOL volume creation API error, 43 expirationHours JSON object member for base-volume creation, 42 for volume modification, 44 expirationHourse JSON object member for snapshot-volume creation, 43 expirationTime8601 JSON object member..., 54 forceTearDown JSON object member, 52 FPVV, 29 FREE enumeration for port operations, 64 freeCapacityMB JSON object member for storage-system query response, 79 freeChunkletsGreaterThan JSON object member for CPG operations, 31 freeChunkletsLessThan JSON object member for CPG operations, 31...
...creation API error, 53 host modification API error, 57 EXISTENT_VOL volume creation API error, 43 expirationHours JSON object member for base-volume creation, 42 for volume modification, 44 expirationHourse JSON object member for snapshot-volume creation, 43 expirationTime8601 JSON object member..., 54 forceTearDown JSON object member, 52 FPVV, 29 FREE enumeration for port operations, 64 freeCapacityMB JSON object member for storage-system query response, 79 freeChunkletsGreaterThan JSON object member for CPG operations, 31 freeChunkletsLessThan JSON object member for CPG operations, 31...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 96
... modification, 55 hosts creating, 52 modifying, 54 querying, 58 removing, 58 hostSpeed JSON object member for host query, 60, 61 HP 3PAR Command Line Interface see CLI HP 3PAR Management Console see MC HP 3PAR storage system hostname, 14 HPUX_LEGACY enumeration for host modification, 55 HTTP error codes, 25 requests and replies, 11 HTTP client request example... method DELETE, 14 GET, 14 POST, 14 PUT, 14 HTTP POST for creating a CPG, 33 for creating a host, 52 for creating a VLUN, 69 for creating base volumes, 41 for creating snapshot volumes, 42 for modifying a host, 54
... modification, 55 hosts creating, 52 modifying, 54 querying, 58 removing, 58 hostSpeed JSON object member for host query, 60, 61 HP 3PAR Command Line Interface see CLI HP 3PAR Management Console see MC HP 3PAR storage system hostname, 14 HPUX_LEGACY enumeration for host modification, 55 HTTP error codes, 25 requests and replies, 11 HTTP client request example... method DELETE, 14 GET, 14 POST, 14 PUT, 14 HTTP POST for creating a CPG, 33 for creating a host, 52 for creating a VLUN, 69 for creating base volumes, 41 for creating snapshot volumes, 42 for modifying a host, 54
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 98
... query, 59, 60, 61 for port query, 67 IPORT enumeration for port operations, 64 IPv4Addr JSON object member for storage-system query response, 79 IPv6Addr JSON object member for storage-system query response, 79 isCopy JSON object for snapshot-volume creation, 43 ISCSI enumeration for port operations, 64 iSCSI enumeration ...code, 16 defined, 10 desc, 24 null members, 26 optional members for input, 25 ref, 25 required members for input, 25 JSON objects for base-volume creation, 42 for CPG creation, 33 for CPG growth objects, 32 for CPG modification, 35 for CPG query, 37 for CPG space usage, 32...
... query, 59, 60, 61 for port query, 67 IPORT enumeration for port operations, 64 IPv4Addr JSON object member for storage-system query response, 79 IPv6Addr JSON object member for storage-system query response, 79 isCopy JSON object for snapshot-volume creation, 43 ISCSI enumeration for port operations, 64 iSCSI enumeration ...code, 16 defined, 10 desc, 24 null members, 26 optional members for input, 25 ref, 25 required members for input, 25 JSON objects for base-volume creation, 42 for CPG creation, 33 for CPG growth objects, 32 for CPG modification, 35 for CPG query, 37 for CPG space usage, 32...
HP 3PAR Web Service API 1.2 Developer's Guide (QR482-96192, June 2013)
Page 100
... for CPG query, 36 JSON object member, 52 for all-volumes query, 48 for base-volume creation, 41 for host query, 58, 60 for snapshot volume creation, 43 for snapshot-volume creation, 43 for storage-system query response, 79 name31 API type, 27 NEEDS_CHECK enumeration for volume operations, 39 NEEDS_MAINT_CHECK...43 NO_SPACE CPG creation and modification API error, 34 host creation API error, 53 space query API error, 85 volume creation API error, 43 node JSON object member for host query, 61 for VLUN operations, 68 nodeList JSON object member for CPG operations, 30 nodeWWN JSON object member for ...
... for CPG query, 36 JSON object member, 52 for all-volumes query, 48 for base-volume creation, 41 for host query, 58, 60 for snapshot volume creation, 43 for snapshot-volume creation, 43 for storage-system query response, 79 name31 API type, 27 NEEDS_CHECK enumeration for volume operations, 39 NEEDS_MAINT_CHECK...43 NO_SPACE CPG creation and modification API error, 34 host creation API error, 53 space query API error, 85 volume creation API error, 43 node JSON object member for host query, 61 for VLUN operations, 68 nodeList JSON object member for CPG operations, 30 nodeWWN JSON object member for ...