API Guide

ManualsBrandsDell ManualsAtmosmetro node

Table Of Contents

Dell EMC Storage Systems

REST API for the metro node appliance

Version 7.0 Service Pack 1

Summary of content (156 pages)

PAGE 1
Dell EMC Storage Systems REST API for the metro node appliance Version 7.
PAGE 2
Table of Contents 1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.1. Version information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 3
.8.2. Returns a list of device migrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 3.8.3. Returns a single DeviceMigration object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 3.8.4. Deletes a single canceled or committed DeviceMigration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 3.8.5. Update attributes on a DeviceMigration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 4
3.12.14. Returns a list of distributed VirtualVolumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 3.12.15. Returns a single distributed VirtualVolume object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 3.12.16. Deletes a single distributed VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 3.12.17. Update attributes on a distributed VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 5
3.18.5. Cancel a vias provisioning job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 3.18.6. Resubmit a vias provisioning job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 3.19. Licenses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 3.19.1. Install a new license file . . . . . . . . . .
PAGE 6
3.28.2. Returns a single RPACluster by name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 3.29. Storage_array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 3.29.1. Returns a list of StorageArrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 3.29.2. Returns a single StorageArray by name . . . . . . . . . . .
PAGE 7
4.7. Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 4.8. ClusterWitness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 4.9. ClusterWitness_components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117 4.10. ConsistencyGroup . . . .
PAGE 8
4.48. Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 4.49. Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 4.50. ViasJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137 4.51.
PAGE 9
4.89. validate_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 4.90. vias_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146 4.91. virtual_volume_expand_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147 4.92. virtual_volume_payload . . . . . . . . .
PAGE 10
Chapter 1. Overview A defnition for the next-gen VPlex API 1.1. Version information Version : 7.0 Service Pack 1 1.2.
PAGE 11
• permissions • recoverpoint • storage_array • storage_group • storage_pool • storage_volume • system_config • token • version • virtual_volume 2
PAGE 12
Chapter 2. Security 2.1. basicAuth Type : basic 2.2.
PAGE 13
Chapter 3. Resources 3.1. Aggregate 3.1.1. Groups the resources at the given URI by the values of the provided fields and returns aggregated computations for each group GET /aggregates Parameters Type Name Description Schema Query group_by required Comma-separated list of fields to aggregate on string Query uri required URI of collection to aggregate string Responses HTTP Code Description Schema 200 A JSON array of aggregates Aggregates 3.2. Amp 3.2.1.
PAGE 14
HTTP Code Description Schema 201 Successfully registered the ArrayManagementProvider Headers : Location (string) : URI of registered AMP. ArrayManagemen tProvider 400 Bad request, for incorrect IP address Error 401 Unauthorzied error, in case of invalid username or password Error 3.2.2.
PAGE 15
3.2.3. Returns the details of an AMP GET /clusters/{cluster_name}/array_management_providers/{name} Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 16
3.3.1. Make a bulk request POST /bulk/ Parameters Type Name Schema Body request required < string, object > map Responses HTTP Code Description 200 A summary of the results of the request. This response indicates that the request was successfully processed, not necessarily that every BulkResponse task succeeded. The caller should inspect the content of the response to see which tasks failed. 400 One of the specified objects requested was invalid. As a result, none of the tasks were attempted.
PAGE 17
3.4. Certificates 3.4.1. Add the certificate to the keystore. POST /external_certificates/trusted/{external_certificate} Parameters Type Name Description Schema Path external_certi The IP:PORT of system associated with this ficate certificate. required string Body certificate_pa yload required certificate_payload Responses HTTP Code Description Schema 201 Added the certificate to the keystore.
PAGE 18
3.4.2. Fetch the certificate from the keystore. GET /external_certificates/trusted/{external_certificate} Parameters Type Name Description Path external_certi The IP:PORT of system associated with this ficate certificate. required Schema string Responses HTTP Code Description Schema 200 Added the certificate to the keystore. Certificate Produces • application/json Example HTTP response Response 200 { "ip_address" : "10.228.69.183", "issued_to" : "CN=dsvef103.lss.emc.
PAGE 19
Type Name Description Path external_certi The IP:PORT of system associated with this ficate certificate. required Schema string Responses HTTP Code Description Schema 204 Deleted the certificate from the keystore. No Content 3.4.4. Fetches the SSL Certificate of an external system GET /external_certificates/untrusted/{external_certificate} Parameters Type Name Description Path external_certi The IP:PORT of system associated with this ficate certificate.
PAGE 20
3.5. Cluster_witness 3.5.1. Return the cluster witness wired to the system GET /cluster_witness Responses HTTP Code Description Schema 200 The cluster witness ClusterWitness 404 When no cluster witness is found Error Example HTTP response Response 200 { "admin_state" : "enabled", "private_ip_address" : "128.221.254.3", "public_ip_address" : "10.226.27.3" } 3.5.2. Deletes the cluster witness configuration.
PAGE 21
Description Settable attributes are 'admin state' Parameters Type Name Schema Body clusterwitness_patch_payload < JsonPatchOp > array required Responses HTTP Code Description Schema 200 The updated cluster-witness. ClusterWitness Example HTTP response Response 200 { "admin_state" : "enabled", "private_ip_address" : "128.221.254.3", "public_ip_address" : "10.226.27.3" } 3.6. Clusters 3.6.1.
PAGE 22
Type Name Description Schema Query sort_by optional string Specify the field priority order and direction for (SortingOrderExpres sorting. See SortingOrderExpression for details. sion) Responses HTTP Code Description 200 A JSON array of clusters Headers : < Cluster > array X-Total-Count (integer) : The total number of entities in the result set after filtering. Schema 3.6.2.
PAGE 23
{ "name" : "cluster-1", "cluster_id" : 1, "island_id" : 1, "allow_auto_join" : true, "connected" : true, "top_level_assembly" : "FNM00123456789", "operational_status" : "ok", "transition_indications" : [ ], "transition_progress" : [ ], "health_state" : "ok", "health_indications" : [ ], "system_time" : "Mon Nov 19 22:59:37 UTC 2018", "ip_address" : "10.6.209.205", "is_local" : true } 3.6.3.
PAGE 24
{ "name" : "cluster-1", "cluster_id" : 1, "island_id" : 1, "allow_auto_join" : true, "connected" : true, "top_level_assembly" : "FNM00123456789", "operational_status" : "ok", "transition_indications" : [ ], "transition_progress" : [ ], "health_state" : "ok", "health_indications" : [ ], "system_time" : "Mon Nov 19 22:59:37 UTC 2018", "ip_address" : "10.6.209.205", "is_local" : true } 3.7. Consistency_group 3.7.1.
PAGE 25
HTTP Code Description Schema 204 Created Headers : Location (string) : URI of created ConsistencyGroup. No Content Example HTTP response Response 201 { "name" : "Test_CG", "operational_status" : [ { "cluster" : "/vplex/v2/clusters/cluster-1", "summary" : "ok", "details" : [ ] } ], "read_only" : false, "virtual_volumes" : [ "/vplex/v2/clusters/virtual_volumes/vvol1", "/vplex/v2/clusters/virtual_volumes/vvol2" ] } 3.7.2.
PAGE 26
Type Name Description Query operational_st Filter results by operational_status. See atus LexicalQueryExpression for details. optional Query sort_by optional Schema string (LexicalQueryExpres sion) string Specify the field priority order and direction for (SortingOrderExpres sorting. See SortingOrderExpression for details.
PAGE 27
Response 200 { "name" : "Test_CG", "operational_status" : [ { "cluster" : "/vplex/v2/clusters/cluster-1", "summary" : "ok", "details" : [ ] } ], "read_only" : false, "virtual_volumes" : [ "/vplex/v2/clusters/virtual_volumes/vvol1", "/vplex/v2/clusters/virtual_volumes/vvol2" ] } 3.7.4.
PAGE 28
* virtual_volumes (add/remove) * visibility (add/remove) Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Body consistency_gr oup_patch_pa yload required < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated ConsistencyGroup ConsistencyGroup Example HTTP response Response 200 { "name" : "Test_CG", "operational_status" : [ { "cluster" : "/vple
PAGE 29
Parameters Type Name Schema Body device_migration_payload required device_migration_payload Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created DeviceMigration.
PAGE 30
Type Name Description Schema Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified.
PAGE 31
Example HTTP response Response 200 { "name" : "D_dev_1_dev_2", "from_cluster" : "/vplex/v2/clusters/cluster-1", "percentage_done" : 3, "source" : "/vplex/v2/clusters/cluster-1/devices/dev_1", "start_time" : "Thu Oct 25 22:03:46 UTC 2018", "status" : "in-progress", "target" : "/vplex/v2/clusters/cluster-1/devices/dev_2", "to_cluster" : "/vplex/v2/clusters/cluster-1", "transfer_size" : 131072, "type" : "full", "source_exported" : false, "target_exported" : false } 3.8.4.
PAGE 32
Type Name Description Schema Path name required The name of a specific instance of the resource string Body device_migrat ion_patch_pay load required < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated DeviceMigration DeviceMigration Example HTTP response Response 200 { "name" : "D_dev_1_dev_2", "from_cluster" : "/vplex/v2/clusters/cluster-1", "percentage_done" : 3, "source" : "/vplex/v2/clusters/cluster-1/devices/dev_1", "start_time" : "Thu Oct 25 22:03:46 UTC 201
PAGE 33
HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created DeviceMigration.
PAGE 34
Type Name Description Schema Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified. Query sort_by optional string Specify the field priority order and direction for (SortingOrderExpres sorting. See SortingOrderExpression for details. sion) Query to_cluster optional Filter results by to_cluster. See LexicalQueryExpression for details.
PAGE 35
{ "name" : "E_6bb8a76_1_6bb8a6a_1", "from_cluster" : "/vplex/v2/clusters/cluster-1", "percentage_done" : 15, "source" : "/vplex/v2/clusters/cluster1/extents/extent_VPD83T3_600014400000001001d1794456bb8a76_1", "start_time" : "Mon Jan 21 23:25:35 UTC 2019", "status" : "in-progress", "target" : "/vplex/v2/clusters/cluster1/extents/extent_VPD83T3_600014400000001001d1794456bb8a6a_1", "to_cluster" : "/vplex/v2/clusters/cluster-1", "transfer_size" : 131072, "type" : "full" } 3.8.9.
PAGE 36
Type Name Body extent_migrat ion_patch_pay load required Description Schema < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated ExtentMigration ExtentMigration Example HTTP response Response 200 { "name" : "E_6bb8a76_1_6bb8a6a_1", "from_cluster" : "/vplex/v2/clusters/cluster-1", "percentage_done" : 15, "source" : "/vplex/v2/clusters/cluster1/extents/extent_VPD83T3_600014400000001001d1794456bb8a76_1", "start_time" : "Mon Jan 21 23:25:35 UTC 2019", "status" : "in-progress
PAGE 37
Type Name Description Schema Header X-IncludeObject optional When passed as part of a POST request, controls whether the representation of the newly created object is included in the response. Defaults to 'true' which will include the object in the string response. This header is useful because refreshing the newly created object is usually the slowest part of a POST operation.
PAGE 38
Type Name Description Schema Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified. Query operational_st Filter results by operational_status.
PAGE 39
Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details. ssion) Responses HTTP Code Description Schema 200 A single Device object Device 3.9.4.
PAGE 40
* {"op": "add", "path": "/legs", "value": } * detach_operation_payload * {"op": "remove", "path": "/legs", "value": } * {"op": "remove", "path": "/legs", "value": } Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required string Body local_device_p atch_payload required < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated local device Device 3.10. Director 3.10.1.
PAGE 41
Type Name Description Query operational_st Filter results by operational_status. See atus LexicalQueryExpression for details. optional Query sort_by optional Schema string (LexicalQueryExpres sion) string Specify the field priority order and direction for (SortingOrderExpres sorting. See SortingOrderExpression for details.
PAGE 42
{ "auto_boot" : true, "auto_restart" : true, "cluster_id" : 1, "communication_status" : "ok", "director_count" : 2, "director_id" : 16857344, "director_type" : "VPlex", "engine_id" : "1-1", "firmware_uptime" : 1220711, "health_indications" : [ ], "health_state" : "ok", "hostname" : "128.221.252.
PAGE 43
3.11.2. Returns a single DirectorPort object GET /directors/{director_name}/ports/{name} Parameters Type Name Description Path director_name The name of the director required string Path name required string The name of a specific instance of the resource Schema Responses HTTP Code Description Schema 200 A single DirectorPort DirectorPort 500 Failed to get DirectorPort Error 3.11.3.
PAGE 44
3.12. Distributed_storage 3.12.1. Create a new distributed ConsistencyGroup POST /distributed_storage/distributed_consistency_groups Parameters Type Name Description Schema Header X-IncludeObject optional When passed as part of a POST request, controls whether the representation of the newly created object is included in the response. Defaults to 'true' which will include the object in the string response.
PAGE 45
{ "name" : "Test_CG", "operational_status" : [ { "cluster" : "/vplex/v2/clusters/cluster-1", "summary" : "ok", "details" : [ ] } ], "read_only" : false, "virtual_volumes" : [ "/vplex/v2/clusters/virtual_volumes/vvol1", "/vplex/v2/clusters/virtual_volumes/vvol2" ] } 3.12.2. Returns a list of distributed ConsistencyGroups GET /distributed_storage/distributed_consistency_groups Parameters Type Name Description Schema Query fields optional Select which fields are included in the response.
PAGE 46
3.12.3.
PAGE 47
HTTP Code Description Schema 204 Deleted No Content 3.12.5.
PAGE 48
3.12.6. Manually resume I/O to the virtual-volumes in a distributed consistency group. In a cluster-partition scenario where the ruleset does not indicate an automatic winner, this endpoint will select the winning cluster where I/O should continue. After a cluster-partition is resolved, in the case that auto-resume-at-loser is set to false, this endpoint will resume I/O on the losing cluster.
PAGE 49
3.12.7. Create a new DistributedDevice POST /distributed_storage/distributed_devices Parameters Type Name Description Schema Header X-IncludeObject optional When passed as part of a POST request, controls whether the representation of the newly created object is included in the response. Defaults to 'true' which will include the object in the string response. This header is useful because refreshing the newly created object is usually the slowest part of a POST operation.
PAGE 50
Type Name Description Schema Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified. Query operational_st Filter results by operational_status.
PAGE 51
Responses HTTP Code Description Schema 200 A single DistributedDevice DistributedDevice 3.12.10. Deletes a single DistributedDevice DELETE /distributed_storage/distributed_devices/{name} Parameters Type Name Description Schema Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 204 Deleted No Content 3.12.11.
PAGE 52
3.12.12. Manually resume I/O to a distributed device that supports a distributed virtual-volume. POST /distributed_storage/distributed_devices/{name}/resume Parameters Type Name Description Schema Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 200 A distributed device object DistributedDevice Produces • application/json 3.12.13.
PAGE 53
HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created distributed VirtualVolume. VirtualVolume 204 Created Headers : Location (string) : URI of created distributed VirtualVolume.
PAGE 54
Type Name Description Schema Query health_state optional Filter results by health_state. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details.
PAGE 55
Responses HTTP Code Description Schema 200 A single distributed VirtualVolume VirtualVolume Example HTTP response Response 200 { "name" : "TEST_vvol", "operational_status" : "ok", "health_state" : "ok", "service_status" : "running", "block_count" : 524288, "block_size" : 4096, "capacity" : 2147483648, "locality" : "local", "expandable" : true, "vpd_id" : "VPD83T3:6000144000000010016d5f9474ade8e0", "thin_enabled" : "disabled", "storage_array_family" : "unknown", "supporting_device" : "TEST", "visibili
PAGE 56
PATCH /distributed_storage/distributed_virtual_volumes/{name} Description Settable attributes: 'name' Parameters Type Name Description Schema Path name required The name of a specific instance of the resource string Body distributed_vi rtual_volume_ patch_payload required < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated distributed VirtualVolume VirtualVolume Example HTTP response Response 200 { "name" : "TEST_vvol", "operational_status" : "ok", "health_state"
PAGE 57
POST /distributed_storage/distributed_virtual_volumes/{name}/expand Parameters Type Name Description Schema Path name required The name of a specific instance of the resource string Body distributed_vi rtual_volume_ expand_paylo ad required distributed_virtual_v olume_expand_payl oad Responses HTTP Code Description Schema 200 Updated distributed VirtualVolume VirtualVolume Example HTTP response Response 200 { "name" : "TEST_vvol", "operational_status" : "ok", "health_state" : "ok", "servi
PAGE 58
Parameters Type Name Description Schema Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified.
PAGE 59
Parameters Type Name Description Schema Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details. ssion) Query health_state optional Filter results by health_state. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified.
PAGE 60
Responses HTTP Code Description Schema 200 A single Engine Engine Example HTTP response Response 200 { "cluster_ip_seed" : 1, "enclosure_id" : 1, "engine_id" : "1-1", "engine_family" : "VPL", "health_indications" : [ ], "health_state" : "major-failure", "marker_led" : false, "operational_status" : "online", "part_number" : "303-094-001B", "revision_number" : "B01", "serial_number" : "CF2G6110200066", "top_level_assembly" : "FNM00111600426", "wwn_seed" : "46e03e04", "name" : "engine-1-1" } 3.14.
PAGE 61
HTTP Code Description Schema 201 The registration was successful, return registered InitiatorPort InitiatorPort 3.14.2. Returns a list of InitiatorPort objects GET /clusters/{cluster_name}/exports/initiator_ports Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 62
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Body rediscover_pa yload optional rediscover_payload Responses HTTP Code Description Schema 200 A list of InitiatorPort objects < InitiatorPort > array 3.14.4.
PAGE 63
Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 204 The un-registration was successful No Content 3.14.6.
PAGE 64
Type Name Description Schema Path cluster_name required The name of the cluster string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details. ssion) Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details.
PAGE 65
3.14.9. Update attributes on a Port PATCH /clusters/{cluster_name}/exports/ports/{name} Description Settable attributes are 'name' and 'enabled' Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Body port_patch_pa yload required < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated Port Port 3.14.10.
PAGE 66
Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created StorageView. StorageView 204 Created Headers : Location (string) : URI of created StorageView. No Content 3.14.11. Returns a list of StorageView objects GET /clusters/{cluster_name}/exports/storage_views Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Query fields optional Select which fields are included in the response.
PAGE 67
3.14.12. Returns a single StorageView GET /clusters/{cluster_name}/exports/storage_views/{name} Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 200 A single StorageView StorageView 3.14.13.
PAGE 68
'ports'(add/remove) Parameters Type Name Description Schema Header allow_multi_f ail optional Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Body storage_view_ patch_payload required boolean < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated StorageView StorageView 3.15. Extent 3.15.1.
PAGE 69
Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created Extent. Extent 204 Created Headers : Location (string) : URI of created Extent.
PAGE 70
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Query capacity optional Filter results by capacity. See NumericQueryExpression for details. string (NumericQueryExpr ession) Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details. ssion) Query limit optional
Maximum number of elements to include in paginated results.
PAGE 71
Type Name Description Schema Path name required The name of a specific instance of the resource string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 72
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 204 Deleted No Content 3.15.5.
PAGE 73
{ "application-consistent" : false, "block-count" : 38656, "block-offset" : 0, "block-size" : "4K", "capacity" : "151M", "health-indications" : [ ], "health-state" : "ok", "io-status" : "alive", "itls" : [ "0x500014426012c510/0x5006016447e002c5/0x01a7", "0x500014426012c510/0x5006016547e002c5/0x01a7", "0x500014426012c511/0x5006016447e002c5/0x01a7", "0x500014426012c511/0x5006016547e002c5/0x01a7" ], "locality" : "test_local", "operational-status" : "ok", "storage-array-family" : "xtremio", "storage-volume" : "
PAGE 74
Type Name Description Schema Query name optional Filter results by name. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified. Query role optional Filter results by role. See LexicalQueryExpression for details. Query sort_by optional string Specify the field priority order and direction for (SortingOrderExpres sorting.
PAGE 75
HTTP Code Description Schema 500 When health information cannot be obtained Error Example HTTP response Response 200 { "status" : "full,", "details" : [ "ip-port-group-0 - OK - All expected connectivity is present.", "ipport-group-1 - OK - All expected connectivity is present." ] } 3.17.2.
PAGE 76
Parameters Type Name Schema Body vias_payload required vias_payload Responses HTTP Code Description Schema 201 VIAS provisioning job created Headers : Location (string) : The uri of the created job. ViasJob 3.18.2. Get all the current VIAS provisioning jobs GET /jobs Parameters Type Name Description Schema Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 77
HTTP Code Description 200 A JSON array of VIAS jobs Headers : < ViasJob > array X-Total-Count (integer) : The total number of entities in the result set after filtering. Schema 3.18.3. Get the status of a VIAS provisioning job GET /jobs/{name} Parameters Type Name Description Schema Path name required The name of a specific instance of the resource string Query fields optional Select which fields are included in the response. string 'name' is always included.
PAGE 78
3.18.5. Cancel a vias provisioning job POST /jobs/{name}/cancel Parameters Type Name Description Schema Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 200 VIAS job was cancelled successfully, return updated ViasJob ViasJob 3.18.6.
PAGE 79
Type Name Description Schema Query validate optional boolean Body license_payloa d required license_payload Responses HTTP Code Description Schema 201 Created No Content 500 Invalid license file Error Consumes • application/json 3.19.2.
PAGE 80
HTTP Code Description 200 A JSON array of licenses Headers : LicenseArray X-Total-Count (integer) : The total number of entities in the result set after filtering. 500 License file could not be retrieved from lockbox Schema Error 3.19.3.
PAGE 81
HTTP Code Description Schema 500 Invalid license file. No Content 3.20. Logger 3.20.1. Log information on the server. This endpoint is intended for internal system use only. POST /logger/ Parameters Type Name Schema Body request required < string, object > map Responses HTTP Code Description Schema 204 The information was successfully logged No Content 400 The request format is not recognized by the server. Currently, only JSNLog requests are supported. No Content 3.21.
PAGE 82
Type Name Body logging_volum e_payload required Description Schema logging_volume_payl oad Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created LoggingVolume. LoggingVolume 204 Created Headers : Location (string) : URI of created LoggingVolume.
PAGE 83
Type Name Description Schema Query health_state optional Filter results by health_state. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details.
PAGE 84
Responses HTTP Code Description Schema 200 A single LoggingVolume LoggingVolume Example HTTP response Response 200 { "application_consistent" : false, "block_count" : 5242880, "block_size" : 4096, "capacity" : 21474574336, "health_indications" : [ ], "health_state" : "ok", "name" : "logging_c1", "operational_status" : "ok", "storage_array_family" : "unknown", "system_id" : "logging_c1" } 3.21.4.
PAGE 85
3.22.1. Returns a list of LogicalUnits GET /clusters/{cluster_name}/storage_arrays/{storagearray_name}/logical_units Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path storagearray_ name The name of the storage array required Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 86
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path storagearray_ name The name of the storage array required string Responses HTTP Code Description Schema 204 LogicalUnits are forgotten No Content 3.22.3.
PAGE 87
Parameters Type Name Schema Query uri required string Responses HTTP Code Description 200 A description of the parents and children of the given element. To get the complete hierarchy, make subsequent requests for the parent and children elements. This ensures that large volumes of unwanted StorageMap data aren’t fetched from the server, for example when viewing a large storage view, we don’t want to get the complete hierarchy of every virtual volume in that view.
PAGE 88
Type Name Body meta_volume_ payload required Description Schema meta_volume_payloa d Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created MetaVolume. MetaVolume 204 Created Headers : Location (string) : URI of created MetaVolume.
PAGE 89
Type Name Description Schema Query health_state optional Filter results by health_state. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) Query name optional Filter results by name. See LexicalQueryExpression for details.
PAGE 90
Responses HTTP Code Description Schema 200 A single MetaVolume MetaVolume Example HTTP response Response 200 { "active" : true, "application_consistent" : false, "block_count" : 20971264, "block_size" : 4096, "capacity" : 85898297344, "health_indications" : [ ], "health_state" : "ok", "name" : "meta_c1", "operational_status" : "ok", "storage_array_family" : "unknown", "system_id" : "meta_c1" } 3.24.4.
PAGE 91
Description Settable attributes: 'active' .
PAGE 92
3.25.1. Create List of configured MetaData Backups Volume with their scheduled time POST /clusters/{cluster_name}/metadata_backups Parameters Type Name Description Schema Header X-IncludeObject optional When passed as part of a POST request, controls whether the representation of the newly created object is included in the response. Defaults to 'true' which will include the object in the string response.
PAGE 93
Type Name Description Schema Path cluster_name required The name of the cluster string Responses HTTP Code Description Schema 200 A List of MetaData Backup settings Response 200 Response 200 Name Schema backup_volumes optional < string (URI) > array hours optional integer minutes optional integer 3.25.3.
PAGE 94
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details. ssion) Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. Query offset optional Index of the first element to include in paginated results.
PAGE 95
Type Name Description Schema Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details. ssion) Responses HTTP Code Description Schema 200 The stats for the given monitor Monitors 3.26.3.
PAGE 96
Type Name Description Schema Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 200 The stats for the given vvol monitor Monitors 3.27. Permissions 3.27.1. Returns the Role-Based Authentication configuration GET /permissions/ Parameters Type Name Description Schema Query fields optional Select which fields are included in the response. string 'name' is always included.
PAGE 97
Parameters Type Name Description Schema Path rbac_role required The name of the role string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 98
Responses HTTP Code Description Schema 200 The updated permissions Permission Example HTTP response Response 200 { "/a/path/to/endpoint1" : [ "GET" ], "/a/path/to/endpoint2" : [ "PATCH", "POST" ], ".*" : [ "GET", "POST", "PATCH", "DELETE" ] } 3.28. Recoverpoint 3.28.1. Returns a list of RPACluster objects. Supports paging GET /rpa_clusters/ Parameters Type Name Description Schema Query fields optional Select which fields are included in the response. string 'name' is always included.
PAGE 99
HTTP Code Description 200 A list of RPACluster objects Headers : < RPACluster > X-Total-Count (integer) : The total number of entities in the result set array after filtering. Schema 3.28.2. Returns a single RPACluster by name GET /rpa_clusters/{rpa_cluster_name} Parameters Type Name Description Schema Path rpa_cluster_n ame required The name of the RPA cluster string Query fields optional Select which fields are included in the response. string 'name' is always included.
PAGE 100
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Query connectivity_s Filter results by connectivity_status. See tatus LexicalQueryExpression for details. optional Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details. ssion) Query limit optional
Maximum number of elements to include in paginated results.
PAGE 101
Type Name Description Schema Path name required The name of a specific instance of the resource string Query fields optional Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 102
Name Schema claimable_storage_volumes optional < inline_response_200_claimable_storage_volumes > array storage_array optional string unclaimed_storage_volumes optional integer 3.29.4.
PAGE 103
GET /clusters/{cluster_name}/storage_arrays/{storagearray_name}/storage_groups Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path storagearray_ name The name of the storage array required Query SRP optional Filter storage groups based on storage pools they string belong to. See LexicalQueryExpression for (LexicalQueryExpres details. sion) Query fields optional Select which fields are included in the response.
PAGE 104
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Path storagearray_ name The name of the storage array required Query fields optional string Select which fields are included in the response. string 'name' is always included. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 105
Type Name Description Schema Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified. Query policies optional Filter storage pools by policies. See LexicalQueryExpression for details. Query sort_by optional string Specify the field priority order and direction for (SortingOrderExpres sorting. See SortingOrderExpression for details.
PAGE 106
3.32. Storage_volume 3.32.1. Returns a list of StorageVolume objects. Supports paging GET /clusters/{cluster_name}/storage_volumes Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Query capacity optional Filter results by capacity. See NumericQueryExpression for details. string (NumericQueryExpr ession) Query fields optional Select which fields are included in the response. string 'name' is always included.
PAGE 107
Type Name Description Schema Query thin_capable optional Filter results by thin_capable. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query thin_rebuild optional Filter results by thin_rebuild. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query use optional Filter results by use. See LexicalQueryExpression for details. string (LexicalQueryExpres sion) Query vendor_specifi Filter results by vendor_specific_name.
PAGE 108
Example HTTP response Response 200 { "name" : "Test_svol", "application_consistent" : false, "block_count" : 262144, "block_size" : 4096, "capacity" : 1073741824, "health_indications" : [ ], "health_state" : "ok", "operational_status" : "ok", "io_status" : "alive", "itls" : [ { "initiator" : 5764629798346474768, "target" : 5766297903108719301, "lun" : 423 }, { "initiator" : 5764629798346474768, "target" : 5766297907403686597, "lun" : 423 }, { "initiator" : 5764629798346474769, "target" : 576629790310871930
PAGE 109
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 204 Storage Volume is forgotten No Content 3.32.4.
PAGE 110
{ "name" : "Test_svol", "application_consistent" : false, "block_count" : 262144, "block_size" : 4096, "capacity" : 1073741824, "health_indications" : [ ], "health_state" : "ok", "operational_status" : "ok", "io_status" : "alive", "itls" : [ { "initiator" : 5764629798346474768, "target" : 5766297903108719301, "lun" : 423 }, { "initiator" : 5764629798346474768, "target" : 5766297907403686597, "lun" : 423 }, { "initiator" : 5764629798346474769, "target" : 5766297903108719301, "lun" : 423 }, { "initiator" : 57
PAGE 111
Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Body claim_payload required claim_payload Responses HTTP Code Description Schema 200 The update was successful, return updated StorageVolume StorageVolume 204 The update was successful, no response content No Content Example HTTP response Response 200 102
PAGE 112
{ "name" : "Test_svol", "application_consistent" : false, "block_count" : 262144, "block_size" : 4096, "capacity" : 1073741824, "health_indications" : [ ], "health_state" : "ok", "operational_status" : "ok", "io_status" : "alive", "itls" : [ { "initiator" : 5764629798346474768, "target" : 5766297903108719301, "lun" : 423 }, { "initiator" : 5764629798346474768, "target" : 5766297907403686597, "lun" : 423 }, { "initiator" : 5764629798346474769, "target" : 5766297903108719301, "lun" : 423 }, { "initiator" : 57
PAGE 113
Type Name Description Schema Header X-IncludeObject optional When passed as part of a POST request, controls whether the representation of the newly created object is included in the response. Defaults to 'true' which will include the object in the string response. This header is useful because refreshing the newly created object is usually the slowest part of a POST operation.
PAGE 114
{ "name" : "Test_svol", "application_consistent" : false, "block_count" : 262144, "block_size" : 4096, "capacity" : 1073741824, "health_indications" : [ ], "health_state" : "ok", "operational_status" : "ok", "io_status" : "alive", "itls" : [ { "initiator" : 5764629798346474768, "target" : 5766297903108719301, "lun" : 423 }, { "initiator" : 5764629798346474768, "target" : 5766297907403686597, "lun" : 423 }, { "initiator" : 5764629798346474769, "target" : 5766297903108719301, "lun" : 423 }, { "initiator" : 57
PAGE 115
Responses HTTP Code Description Schema 200 The configuration object SystemConfig 500 When configuration cannot be obtained Error Example HTTP response Response 200 { "platform" : "VS2", "product_type" : "metro", "wan_type" : "FC", "limits" : { "storage_volume_size" : 70368744177664 } } 3.34. Token 3.34.1.
PAGE 116
3.34.2. Endpoint to logout and invalidate/delete the token DELETE /token Responses HTTP Code Description Schema 204 User successfully logged out No Content 401 User not authorized Error 500 Internal server error Error 3.35. Version 3.35.1. Returns a list of versions of the VPLEX components GET /versions Parameters Type Name Description Schema Query fields optional Select which fields are included in the response. string 'name' is always included.
PAGE 117
3.36. Virtual_volume 3.36.1. Create a new virtual volume POST /clusters/{cluster_name}/virtual_volumes Parameters Type Name Description Schema Header X-IncludeObject optional When passed as part of a POST request, controls whether the representation of the newly created object is included in the response. Defaults to 'true' which will include the object in the string response. This header is useful because refreshing the newly created object is usually the slowest part of a POST operation.
PAGE 118
{ "name" : "TEST_vvol", "operational_status" : "ok", "health_state" : "ok", "service_status" : "running", "block_count" : 524288, "block_size" : 4096, "capacity" : 2147483648, "locality" : "local", "expandable" : true, "vpd_id" : "VPD83T3:6000144000000010016d5f9474ade8e0", "thin_enabled" : "disabled", "storage_array_family" : "unknown", "supporting_device" : "TEST", "visibility" : "local" } 3.36.2.
PAGE 119
Type Name Description Schema Query offset optional Index of the first element to include in paginated results.
'limit' must also be integer (int32) specified. Query operational_st Filter results by operational_status. See atus LexicalQueryExpression for details. optional string (LexicalQueryExpres sion) Query service_status Filter results by service_status. See optional LexicalQueryExpression for details.
PAGE 120
Responses HTTP Code Description Schema 200 A single VirtualVolume VirtualVolume Example HTTP response Response 200 { "name" : "TEST_vvol", "operational_status" : "ok", "health_state" : "ok", "service_status" : "running", "block_count" : 524288, "block_size" : 4096, "capacity" : 2147483648, "locality" : "local", "expandable" : true, "vpd_id" : "VPD83T3:6000144000000010016d5f9474ade8e0", "thin_enabled" : "disabled", "storage_array_family" : "unknown", "supporting_device" : "TEST", "visibility" : "local
PAGE 121
3.36.5.
PAGE 122
3.36.6.
PAGE 123
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Path name required The name of a specific instance of the resource string Body virtual_volum e_expand_payl oad required virtual_volume_expa nd_payload Responses HTTP Code Description Schema 200 The updated VirtualVolume VirtualVolume Example HTTP response Response 200 { "name" : "TEST_vvol", "operational_status" : "ok", "health_state" : "ok", "service_status" : "running", "block_count" : 5
PAGE 124
Chapter 4. Definitions 4.1. Aggregate Name Schema count optional integer group optional < string > array 4.2. Aggregates Type : < Aggregate > array 4.3. ArrayManagementProvider Name Schema connectivity optional enum (connected, unreachable) ip_address optional string managed_arrays optional < string (URI) > array name optional string port optional string provider_type optional enum (SMI-S, REST) use_ssl optional boolean user_name optional string 4.4.
PAGE 125
4.5. BulkResponse_tasks Name Schema additionalProperties optional object object optional string reason optional object status optional string 4.6. Certificate Name Schema MD5 optional string SHA1 optional string encoded_certificate optional string expires_on optional string (date-time) ip_address optional string issued_by optional string issued_on optional string (date-time) issued_to optional string 4.7.
PAGE 126
Name Schema health_indications optional < string > array health_state optional string ip_address optional string is_local optional boolean island_id optional number name required string operational_status optional string system_time optional string top_level_assembly optional string transition_indications optional < string > array transition_progress optional < string > array 4.8.
PAGE 127
Name Schema management_connectivity optional string name optional string operational_state optional string 4.10.
PAGE 128
Name Schema details optional < string > array summary optional string 4.12.
PAGE 129
Name Schema storage_array_family optional string stripe_depth optional string system_id optional string thin_capable optional boolean top_level optional boolean transfer_size optional number virtual_volume optional string (URI) visibility optional string 4.13.
PAGE 130
Name Schema type optional string 4.14.
PAGE 131
Name Schema system_time optional string temperature_threshold_exceeded optional boolean voltage_threshold_exceeded optional boolean vplex_kdriver_status optional string 4.15. DirectorPort Name Schema address optional string enabled optional boolean name optional string operational_status optional operational_status role optional role status optional status 4.16.
PAGE 132
Name Schema rebuild_eta optional integer rebuild_progress optional integer rebuild_status optional string rebuild_type optional string rule_set_name optional string (URI) service_status optional string storage_array_family optional storage_array_family thin_capable optional boolean virtual_volume optional string (URI) 4.17.
PAGE 133
Name Schema revision_number optional string serial_number optional string top_level_assembly optional string wwn_seed optional string 4.18. Error A wrapper for an error message Name Schema cause optional string error_code optional string message required string 4.19.
PAGE 134
Name Schema locality optional string name optional string operational_status optional string storage_array_family optional string storage_volume optional string (URI) storage_volumetype optional string system_id optional string thin-capable optional boolean underlying_storage_block_size optional number use optional string used_by optional < string (URI) > array vendor_specific_name optional string 4.20.
PAGE 135
Name Schema to_cluster optional string (URI) transfer_size optional integer type optional string 4.21. HardwarePort Name Schema address optional string director optional string name optional string role optional role status optional status 4.22. HardwarePorts Type : < HardwarePort > array 4.23.
PAGE 136
Name Schema type optional string 4.24. JsonPatchOp A JsonPatch operation Name op required Description Schema The body of an HTTP PATCH is a Json array of JsonPatchOp objects. These patch operations are applied sequentially to the resource to which the PATCH was sent. If any operation results in a failure, execution of any subsequent operations is aborted, but no roll-back is performed. The field the operation acts on is specified by 'path'.
PAGE 137
Name Description Schema notification optional Notification for the license. Only applicable to capacitybased license. string platform optional string plc optional string product_line optional string uom_code optional string uom_name optional string usage optional usage of the license. Only applicable to capacity-based license. valid optional string 4.26. LicenseArray Type : < License > array 4.27.
PAGE 138
Name Schema health_state optional string name optional string operational_status optional string storage_array_family optional storage_array_family system_id optional string 4.29.
PAGE 139
4.31. LoginResponse Name Description Schema expires_in optional Expiry time string token optional JWT token string token_type optional Bearer token string 4.32.
PAGE 140
Name Schema bucket_max optional number bucket_min optional number bucket_width optional number collecting_data optional boolean firmware_id optional number idle_for optional number name optional string ownership optional boolean period optional number statistics optional object targets optional < string > array timestamp optional string version optional string 4.34. Permission Type : object 4.35.
PAGE 141
Name Schema export_status optional string exports optional < Port_exports > array iscsi_name optional string name optional string node_wwn optional string port_name optional string port_wwn optional string 4.36. Port_exports Name Schema lun optional string status optional string view optional string (URI) volume optional string (URI) 4.37.
PAGE 142
4.38. RuleSet Name Schema name optional string 4.39. StorageArray Name Schema auto_switch optional boolean connectivity_status optional connectivity_status controllers optional < string > array logical_unit_count optional integer name required string ports optional < string > array product_revision optional string storage_array_family optional storage_array_family storage_groups optional string (URI) storage_pools optional string (URI) 4.40.
PAGE 143
Name Schema policy optional string 4.41. StorageMap Name Schema children optional < string (URI) > array parents optional < string (URI) > array uri optional string (URI) 4.42. StoragePool Name Schema last_refreshed optional string (date_time) name optional string policies optional string pool_types optional string total_free_space optional number total_space optional number total_used_space optional number 4.43.
PAGE 144
Name Schema virtual_volumes optional < StorageView_virtual_volumes > array 4.44. StorageView_virtual_volumes Name Schema capacity optional integer lun optional integer uri optional string (URI) vpd_id optional string 4.45.
PAGE 145
Name Schema storage_array_family optional storage_array_family storage_array_name optional string (URI) storage_volumetype optional string system_id optional string thin_capable optional boolean thin_rebuild optional boolean use optional string used_by optional < string (URI) > array vendor_specific_name optional string 4.46. StorageVolume_itls Name Schema initiator optional string lun optional string target optional string 4.47.
PAGE 146
4.48. Version Name Schema info optional string name optional string version optional string 4.49. Versions Type : < Version > array 4.50.
PAGE 147
Name Schema thin optional boolean 4.51. ViasJob_storage_pools Name Schema array optional string (URI) group optional string (URI) pool optional string (URI) 4.52.
PAGE 148
Name Schema operational_status optional string recoverpoint_protection_at optional < string > array recoverpoint_usage optional string service_status optional string storage_array_family optional string supporting_device optional string (URI) system_id optional string thin_enabled optional string visibility optional string vpd_id optional string 4.53. WanComHealth Name Schema details optional < string > array status optional com_status 4.54.
PAGE 149
Name Schema provider_name required string provider_type required string use_ssl required boolean user_name required string 4.56. certificate_payload Name Schema ssl_certificate required string 4.57. cg_resume_payload Name Description Schema resume_at optional The cluster where I/O should be resumed. string (URI) 4.58. claim_payload Name Description application_co nsistent Set to mark the volume as application consistent optional 4.59.
PAGE 150
4.62. consistency_group_payload Name Schema name required string 4.63. device_migration_payload Name Description Schema name required string paused optional boolean source required string (URI) target required string (URI) transfer_size optional Number in Byte. Must be a multiple of 4K. Range: 40KB 128M. Default: 128KB(131072). integer 4.64. device_payload Name Description Schema geometry required Geometry for the new device. Valid values are raid-0, raid-1, string or raid-c.
PAGE 151
4.66. distributed_device_payload Name Schema name required string primary_leg required string (URI) rule_set optional string secondary_leg required string (URI) sync optional boolean 4.67. distributed_virtual_volume_expand_payload Name Description Schema skip_init optional If skip_init is true the blocks of the expanded space will NOT be initialized to ensure single-disk semantics.
PAGE 152
Name Description Schema source optional string (URI) target optional string (URI) transfer_size optional Number in Byte. Must be a multiple of 4K. Range: 40KB 128M. Default: 128KB(131072). integer 4.70. extent_payload Name Schema storage_volume required string (URI) 4.71. health_state Type : enum (unknown, ok, degraded, minor-failure, major-failure, critical_failure, nonrecoverable-error, isolated) 4.72.
PAGE 153
Name Schema storage_volume_name optional string storage_volume_path optional string 4.75. inline_response_201 Name Schema backup_volumes optional < string (URI) > array hours optional integer minutes optional integer 4.76. jobs_storage_pools Name Description Schema storage_group Which storage group to use. If omitted, storage group is optional assigned automatically. string (URI) storage_pool optional string (URI) Which pool to provision the underlying storage from. 4.77.
PAGE 154
Name Schema name required string storage_volumes required < string (URI) > array 4.80. metadata_backup_payload Name Schema backup_volumes optional < string (URI) > array hours required integer minutes required integer 4.81.
PAGE 155
Name Description Schema type optional Provide host type for registering the port. Example : "host_type" string 4.84. role Type : enum (front-end, back-end, local-com, wan-com, management, inter-director- communication) 4.85. status Type : enum (up, down, no-link) 4.86. storage_array_family Type : enum (unknown, internal, other, mixed, symmetrix, clariion, xtremio) 4.87. storage_view_payload Name Schema name required string ports required < string (URI) > array 4.88.
PAGE 156
Name Description Schema capacity required The capacity of each virtual volume, in bytes. number consistency_gr Which consistency group the virtual volumes will be added oup string (URI) to. optional job_name optional The name for the provisioning job. If omitted a random name is generated. string number_of_vo lumes The number of virtual volumes to provision.