API Guide

ManualsBrandsDell ManualsAtmosmetro node

Table Of Contents

Dell EMC Storage Systems

REST API for PowerStore and Unity XT metro

node feature

Version 7.0

Summary of content (172 pages)

PAGE 1
Dell EMC Storage Systems REST API for PowerStore and Unity XT metro node feature 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 3.8.3. Returns a single DeviceMigration object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 3.8.4. Deletes a single canceled or committed DeviceMigration . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 3.8.5. Update attributes on a DeviceMigration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 4
3.12.14. Returns a list of distributed VirtualVolumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 3.12.15. Returns a single distributed VirtualVolume object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 3.12.16. Deletes a single distributed VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 3.12.17. Update attributes on a distributed VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 5
3.18.5. Cancel a vias provisioning job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80 3.18.6. Resubmit a vias provisioning job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 81 3.19. Licenses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 3.19.1. Install a new license file . . . . . . . . . .
PAGE 6
3.28.2. Returns a single StorageArray by name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104 3.28.3. Get the default name mapping for claimable volumes on this array . . . . . . . . . . . . . . . . 105 3.28.4. Rediscover LUNs on the array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106 3.29. Storage_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 7
4.10. ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 4.11. ConsistencyGroup_operational_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134 4.12. Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135 4.13. DeviceMigration . . . . . . . . . . . .
PAGE 8
4.51. ViasJob_storage_pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153 4.52. VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154 4.53. WanComHealth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155 4.54. admin_state . . . . . . . . .
PAGE 9
4.92. virtual_volume_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
PAGE 10
Chapter 1. Overview A definition for the next-gen metro node API 1.1. Version information Version : 7.0 • aggregate 1.2.
PAGE 11
• permissions • 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.
PAGE 15
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 registered AMPs < Headers : ArrayManagemen X-Total-Count (integer) : The total number of entities in the result set tProvider > array after filtering. 500 Internal server error Schema Error 3.2.3.
PAGE 16
{ "provider_type" : "SMI-S", "connectivity" : "connected", "port" : "port", "user_name" : "user_name", "use_ssl" : true, "name" : "name", "ip_address" : "ip_address", "managed_arrays" : [ "managed_arrays", "managed_arrays" ] } 3.2.4.
PAGE 17
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 18
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. Certificate 500 Unable to add the certificate Error Consumes • application/json Produces • application/json Example HTTP response Response 201 { "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 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.com", "issued_by" : "CN=dsvef103.lss.emc.
PAGE 20
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. required Schema string Responses HTTP Code Description Schema 200 A JSON Object with all the certificate details Certificate Produces • application/json Example HTTP response Response 200 { "ip_address" : "10.228.69.183", "issued_to" : "CN=dsvef103.lss.emc.
PAGE 21
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. DELETE /cluster_witness Description Cluster witness can’t be deleted if its currently enabled. Responses HTTP Code Description Schema 204 Cluster witness configuration deleted. No Content 3.
PAGE 22
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. Returns a list of the available clusters GET /clusters/ Parameters Type Name Description Schema Query cluster_id optional Filter results by cluster_id. integer Query fields optional Select which fields are included in the response.
PAGE 23
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. Return a Cluster matching the provided name GET /clusters/{cluster_name} 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.
PAGE 24
3.6.3.
PAGE 25
3.7. Consistency_group 3.7.1. Create a new ConsistencyGroup POST /clusters/{cluster_name}/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. This header is useful because refreshing the newly created object is usually the slowest part of a POST operation.
PAGE 26
{ "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 27
HTTP Code Description 200 A JSON array of consistency groups < Headers : ConsistencyGroup X-Total-Count (integer) : The total number of entities in the result set > array after filtering. Schema Produces • application/json 3.7.3.
PAGE 28
{ "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 29
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" : "/vplex/v2/clusters/cluster-1", "summary" : "ok", "details" : [
PAGE 30
Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created DeviceMigration.
PAGE 31
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 32
{ "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 33
Type Name Description Body device_migrat ion_patch_pay load required Schema < 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 2018", "status" : "in-progress", "target" : "/vplex/v2/clusters/cluster-1/devices/
PAGE 34
HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created DeviceMigration.
PAGE 35
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 36
{ "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 37
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 38
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 39
{ "rebuild_progress" : "rebuild_progress", "operational_status" : "operational_status", "virtual_volume" : "virtual_volume", "top_level" : true, "stripe_depth" : "stripe_depth", "capacity" : 1.4658129805029452, "application_consistent" : true, "rebuild_type" : "rebuild_type", "rebuild_allowed" : true, "block_count" : 0.8008281904610115, "block_size" : 6.027456183070403, "transfer_size" : 5.
PAGE 40
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 41
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 42
3.9.4. Deletes a single Device DELETE /clusters/{cluster_name}/devices/{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 204 Deleted No Content 3.9.5.
PAGE 43
Responses HTTP Code Description Schema 200 The updated local device Device Example HTTP response Response 200 { "rebuild_progress" : "rebuild_progress", "operational_status" : "operational_status", "virtual_volume" : "virtual_volume", "top_level" : true, "stripe_depth" : "stripe_depth", "capacity" : 1.4658129805029452, "application_consistent" : true, "rebuild_type" : "rebuild_type", "rebuild_allowed" : true, "block_count" : 0.8008281904610115, "block_size" : 6.027456183070403, "transfer_size" : 5.
PAGE 44
Type Name Description Schema Query cluster_id optional Filter results by cluster_id. integer 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.
PAGE 45
Responses HTTP Code Description Schema 200 A single Director Director Example HTTP response Response 200 { "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 46
Responses HTTP Code Description 200 A JSON array of director ports Headers : < DirectorPort > X-Total-Count (integer) : The total number of entities in the result set array after filtering. Schema 3.11.2.
PAGE 47
Description Settable attribute is 'enabled' Parameters Type Name Description Path director_name The name of the director required string Path name required string Body port_patch_pa yload required The name of a specific instance of the resource Schema < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated DirectorPort DirectorPort Example HTTP response Response 200 { "address" : "address", "operational_status" : { }, "role" : { }, "name" : "name", "enabled" : true,
PAGE 48
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 49
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 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 50
Example HTTP response 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.12.4.
PAGE 51
Type Name Description Schema Path name required The name of a specific instance of the resource string Body distributed_co nsistency_gro up_patch_payl oad required < JsonPatchOp > array Responses HTTP Code Description Schema 200 The updated distributed ConsistencyGroup ConsistencyGroup Example HTTP response Response 200 { "name" : "Test_CG", "operational_status" : [ { "cluster" : "/vplex/v2/clusters/cluster-1", "summary" : "ok", "details" : [ ] } ], "read_only" : false, "virtual_volumes" :
PAGE 52
Type Name Body cg_resume_pa yload required Description Schema cg_resume_payload Responses HTTP Code Description Schema 200 A JSON array of distributed consistency groups ConsistencyGroup Produces • application/json Example HTTP response 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_vo
PAGE 53
Type Name Body distributed_de vice_payload required Description Schema distributed_device_p ayload Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created DistributedDevice. DistributedDevice 204 Created Headers : Location (string) : URI of created DistributedDevice.
PAGE 54
Type Name Description Schema 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 health_state optional Filter results by health_state. See LexicalQueryExpression for details.
PAGE 55
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. See (FieldSelectionExpre FieldSelectionExpression for details.
PAGE 56
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 57
{ "rebuild_progress" : 1, "health_state" : "health_state", "operational_status" : "operational_status", "thin_capable" : true, "virtual_volume" : "virtual_volume", "rule_set_name" : "rule_set_name", "health_indications" : [ "health_indications", "health_indications" ], "capacity" : 0, "rebuild_type" : "rebuild_type", "storage_array_family" : { }, "rebuild_allowed" : true, "name" : "name", "service_status" : "service_status", "geometry" : "geometry", "rebuild_eta" : 6, "rebuild_status" : "rebuild_status" }
PAGE 58
{ "rebuild_progress" : 1, "health_state" : "health_state", "operational_status" : "operational_status", "thin_capable" : true, "virtual_volume" : "virtual_volume", "rule_set_name" : "rule_set_name", "health_indications" : [ "health_indications", "health_indications" ], "capacity" : 0, "rebuild_type" : "rebuild_type", "storage_array_family" : { }, "rebuild_allowed" : true, "name" : "name", "service_status" : "service_status", "geometry" : "geometry", "rebuild_eta" : 6, "rebuild_status" : "rebuild_status" }
PAGE 59
HTTP Code Description Schema 204 Created Headers : Location (string) : URI of created distributed VirtualVolume.
PAGE 60
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 61
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" } 3.12.16.
PAGE 62
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" : "ok", "service_status" : "running", "block_count" : 524288, "block_size" : 4096, "capacity" : 2147483
PAGE 63
Type Name Body distributed_vi rtual_volume_ expand_paylo ad required Description Schema 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", "service_status" : "running", "block_count" : 524288, "block_size" : 4096, "capacity" : 2147483648, "locality" : "local", "expandable" : true, "vpd_id" : "VPD83T3:60
PAGE 64
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. Responses HTTP Code Description Schema 200 A JSON array of rule sets < RuleSet > array Produces • application/json 3.12.20.
PAGE 65
3.13.1. Returns a list of the available engines GET /engines/ 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.
PAGE 66
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 67
Type Name Body register_paylo ad required Description Schema register_payload Responses HTTP Code Description Schema 201 The registration was successful, return registered InitiatorPort InitiatorPort Example HTTP response Response 201 { "iscsi_name" : "iscsi_name", "node_wwn" : "node_wwn", "name" : "name", "type" : "type", "target_ports" : [ "target_ports", "target_ports" ], "iops_limit" : 0, "bandwidth_limit" : "bandwidth_limit", "port_wwn" : "port_wwn" } 3.14.2.
PAGE 68
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 type optional Filter results by type. See LexicalQueryExpression for details.
PAGE 69
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 70
Responses HTTP Code Description Schema 204 The un-registration was successful No Content 3.14.6.
PAGE 71
3.14.7. Returns a list of Port objects GET /clusters/{cluster_name}/exports/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. ssion) Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified.
PAGE 72
Responses HTTP Code Description Schema 200 A single Port Port Example HTTP response Response 200 { "export_status" : "export_status", "iscsi_name" : "iscsi_name", "node_wwn" : "node_wwn", "director" : "director", "exports" : [ { "volume" : "volume", "view" : "view", "lun" : "lun", "status" : "status" }, { "volume" : "volume", "view" : "view", "lun" : "lun", "status" : "status" } ], "name" : "name", "discovered_initiators" : [ "discovered_initiators", "discovered_initiators" ], "enabled" : true, "port
PAGE 73
Type Name Description Schema 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 Example HTTP response Response 200 { "export_status" : "export_status", "iscsi_name" : "iscsi_name", "node_wwn" : "node_wwn", "director" : "director", "exports" : [ { "volume" : "volume", "view" : "view", "lun" : "lun", "status" : "status" }, { "volume" : "volume", "vie
PAGE 74
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 75
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. 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.
PAGE 76
Type Name Description Schema Path name required The name of a specific instance of the resource string Responses HTTP Code Description Schema 200 A single StorageView StorageView Example HTTP response Response 200 { "operational_status" : "operational_status", "name" : "name", "virtual_volumes" : [ { "lun" : 6, "vpd_id" : "vpd_id", "uri" : "uri", "capacity" : 0 }, { "lun" : 6, "vpd_id" : "vpd_id", "uri" : "uri", "capacity" : 0 } ], "initiators" : [ "initiators", "initiators" ], "ports" : [ "p
PAGE 77
Responses HTTP Code Description Schema 204 Deleted No Content 3.14.14.
PAGE 78
{ "operational_status" : "operational_status", "name" : "name", "virtual_volumes" : [ { "lun" : 6, "vpd_id" : "vpd_id", "uri" : "uri", "capacity" : 0 }, { "lun" : 6, "vpd_id" : "vpd_id", "uri" : "uri", "capacity" : 0 } ], "initiators" : [ "initiators", "initiators" ], "ports" : [ "ports", "ports" ] } 3.15. Extent 3.15.1.
PAGE 79
HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created Extent. Extent 204 Created Headers : Location (string) : URI of created Extent.
PAGE 80
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 81
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 82
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 83
{ "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 84
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 85
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 86
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.
PAGE 87
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 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 88
Responses HTTP Code Description Schema 200 The current status information of the job.
PAGE 89
Responses HTTP Code Description Schema 204 Successfully deleted. No Content 3.18.5.
PAGE 90
{ "base_name" : "base_name", "last_updated" : "last_updated", "number_of_volumes" : 6, "storage_pools" : [ { "array" : "array", "pool" : "pool", "group" : "group" }, { "array" : "array", "pool" : "pool", "group" : "group" } ], "date_created" : "date_created", "target_cluster" : "target_cluster", "description" : "description", "storage_views" : [ "storage_views", "storage_views" ], "capacity" : 0, "thin" : true, "consistency_group" : "consistency_group", "name" : "name", "status_details" : "status_details",
PAGE 91
{ "base_name" : "base_name", "last_updated" : "last_updated", "number_of_volumes" : 6, "storage_pools" : [ { "array" : "array", "pool" : "pool", "group" : "group" }, { "array" : "array", "pool" : "pool", "group" : "group" } ], "date_created" : "date_created", "target_cluster" : "target_cluster", "description" : "description", "storage_views" : [ "storage_views", "storage_views" ], "capacity" : 0, "thin" : true, "consistency_group" : "consistency_group", "name" : "name", "status_details" : "status_details",
PAGE 92
HTTP Code Description Schema 201 Created No Content 500 Invalid license file Error Consumes • application/json 3.19.2. Returns a list of installed licenses on the setup GET /clusters/{cluster_name}/licenses 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 93
Parameters Type Name Description Schema Path cluster_name required The name of the cluster string Responses HTTP Code Description Schema 202 Deletion of license completed No Content 404 The specified resource was not found Error 3.19.4.
PAGE 94
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. Logging_volume 3.21.1.
PAGE 95
Example HTTP response Response 201 { "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.2. Returns a list of LoggingVolume objects.
PAGE 96
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 list of LoggingVolume objects Headers : < LoggingVolume X-Total-Count (integer) : The total number of entities in the result set > array after filtering. Schema 3.21.3.
PAGE 97
{ "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 98
Type Name Description Schema 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. 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 99
Responses HTTP Code Description Schema 204 LogicalUnits are forgotten No Content 3.22.3.
PAGE 100
3.23. Maps 3.23.1. Get the parents and children for the passed element GET /map 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.
PAGE 101
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 102
GET /clusters/{cluster_name}/meta_volumes 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 health_state optional Filter results by health_state. See LexicalQueryExpression for details.
PAGE 103
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 104
Responses HTTP Code Description Schema 204 Deleted No Content 3.24.5. Update attributes on a MetaVolume PATCH /clusters/{cluster_name}/meta_volumes/{name} Description Settable attributes: 'active' .
PAGE 105
{ "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", "volume_uuid" : 1154279114901807020 } 3.25. Metadata_backup 3.25.1.
PAGE 106
Example HTTP response Response 201 { "hours" : 0, "backup_volumes" : [ "backup_volumes", "backup_volumes" ], "minutes" : 6 } 3.25.2.
PAGE 107
Type Name Description Schema Path cluster_name required The name of the cluster string Responses HTTP Code Description Schema 204 Deleted No Content 3.26. Monitors 3.26.1. Return the list of names of active performance monitors GET /clusters/{cluster_name}/system_monitors 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.
PAGE 108
Example HTTP response Response 200 [ "director-1-1-A_PERPETUAL_vplex_sys_perf_mon_v31", "director-1-1B_PERPETUAL_vplex_sys_perf_mon_v31" ] 3.26.2. Return performance stats for the given perf monitor. GET /clusters/{cluster_name}/system_monitors/{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.
PAGE 109
{ "average_period" : 6.027456183070403, "bucket_min" : 5.962133916683182, "period" : 0.8008281904610115, "firmware_id" : 9.301444243932576, "collecting_data" : true, "targets" : [ "targets", "targets" ], "version" : "version", "idle_for" : 1.4658129805029452, "bucket_count" : 7.061401241503109, "bucket_max" : 5.637376656633329, "ownership" : true, "name" : "name", "bucket_width" : 2.3021358869347655, "statistics" : "{}", "timestamp" : "timestamp" } 3.26.3.
PAGE 110
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 The stats for the given vvol monitor Monitors Example HTTP response Response 200 { "average_period" : 6.027456183070403, "bucket_min" : 5.962133916683182, "period" : 0.8008281904610115, "firmware_id" : 9.
PAGE 111
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 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.
'limit' must also be integer (int32) specified.
PAGE 112
Response 200 { "/a/path/to/endpoint1" : [ "GET" ], "/a/path/to/endpoint2" : [ "PATCH", "POST" ], ".*" : [ "GET", "POST", "PATCH", "DELETE" ] } 3.27.3. Modify the Role-Based Authentication configuration for this role PATCH /permissions/{rbac_role} Description To add/remove a path pattern rule, use an add/remove patch with path "/" and value "/path/pattern". A new path pattern rule is created with all verbs forbidden.
PAGE 113
3.28. Storage_array 3.28.1. Returns a list of StorageArrays GET /clusters/{cluster_name}/storage_arrays 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.
PAGE 114
GET /clusters/{cluster_name}/storage_arrays/{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 115
Responses HTTP Code Description Schema 200 Returns the list of unclaimed storage volumes and their default names inline_response_2 00 Example HTTP response Response 200 { "claimable_storage_volumes" : [ { "storage_volume_name" : "storage_volume_name", "storage_volume_path" : "storage_volume_path" }, { "storage_volume_name" : "storage_volume_name", "storage_volume_path" : "storage_volume_path" } ], "storage_array" : "storage_array", "unclaimed_storage_volumes" : 0 } 3.28.4.
PAGE 116
Response 200 { "name" : "EMC-SYMMETRIX-196801161", "controllers" : [ 196801161 ], "connectivity_status" : "ok", "ports" : [ 5764617914037707864, 5764617914037707868 ], "logical_unit_count" : 502 } 3.29. Storage_group 3.29.1.
PAGE 117
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 Schema 200 The list of names of storage groups < StorageGroup > array 404 When no storage groups are found Error 3.29.2.
PAGE 118
{ "SRP" : "SRP", "number_of_volumes" : "number_of_volumes", "parent_storage_group" : "parent_storage_group", "name" : "name", "masking_views" : [ "masking_views", "masking_views" ], "policy" : "policy" } 3.30. Storage_pool 3.30.1.
PAGE 119
Responses HTTP Code Description Schema 200 The list of names of storage pools < StoragePool > array 404 When no storage pools are found Error 3.30.2.
PAGE 120
{ "total_free_space" : 0.8008281904610115, "total_used_space" : 6.027456183070403, "name" : "name", "total_space" : 1.4658129805029452, "policies" : "policies", "pool_types" : "pool_types", "last_refreshed" : "last_refreshed" } 3.31. Storage_volume 3.31.1. Returns a list of StorageVolume objects.
PAGE 121
Type Name Description Schema Query operational_st Filter results by operational_status. See atus LexicalQueryExpression for details. optional string (LexicalQueryExpres sion) Query provision_typ Filter results by provision_type. See e LexicalQueryExpression for details. optional string (LexicalQueryExpres sion) Query sort_by optional Query storage_array Filter results by storage_array_name. See _name LexicalQueryExpression for details.
PAGE 122
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 123
{ "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 124
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.31.4.
PAGE 125
{ "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 126
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 117
PAGE 127
{ "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 128
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 129
{ "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 130
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.33. Token 3.33.1.
PAGE 131
Example HTTP request Request body { "expiry" : "expiry" } Example HTTP response Response 200 { "token_type" : "token_type", "expires_in" : "expires_in", "token" : "token" } 3.33.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.34. Version 3.34.1.
PAGE 132
Type Name Description Schema Query limit optional
Maximum number of elements to include in paginated results.
'offset' must also be specified. integer (int32) 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.
PAGE 133
Responses HTTP Code Description Schema 201 Created Headers : Location (string) : URI of created VirtualVolume. VirtualVolume 204 Created Headers : Location (string) : URI of created VirtualVolume.
PAGE 134
Type Name Description Schema Query consistency_gr Filter results by consistency_group. See oup 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 health_state optional Filter results by health_state. See LexicalQueryExpression for details.
PAGE 135
3.35.3. Return a VirtualVolume matching the provided name GET /clusters/{cluster_name}/virtual_volumes/{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 136
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.35.5.
PAGE 137
{ "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.35.6.
PAGE 138
{ "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.35.7.
PAGE 139
{ "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" } 130
PAGE 140
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 141
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 142
Name Schema health_indications optional < string > array health_state optional string ip_address optional string is_local optional boolean island_id optional integer (int32) 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 143
Name Schema management_connectivity optional string name optional string operational_state optional string 4.10.
PAGE 144
4.12.
PAGE 145
Name Schema thin_capable optional boolean top_level optional boolean transfer_size optional number virtual_volume optional string (URI) visibility optional string 4.13.
PAGE 146
Name Schema auto_boot optional boolean auto_restart optional boolean cluster_id optional integer communication_status optional communication_status director_count optional integer director_family optional string director_id optional string director_type optional string engine_id optional string failover_hostname optional string firmware_uptime optional integer health_indications optional < string > array health_state optional health_state hostname optional string name optional
PAGE 147
Name Schema temperature_threshold_exceeded optional boolean voltage_threshold_exceeded optional boolean 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 148
Name Schema 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 149
Name Schema 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 150
Name Schema 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 151
Name Schema 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 152
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'. Operations are applied in a consistent order, by type: enum (add, remove, 1.
PAGE 153
Name Description Schema 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. LocalComHealth Name Schema details optional < string > array status optional com_status 4.28.
PAGE 154
Name Schema storage_array_family optional storage_array_family system_id optional string 4.29.
PAGE 155
Name Description Schema token_type optional Bearer token string 4.32. MetaVolume Name Schema active optional boolean application_consistent optional boolean block_count optional integer block_size optional integer capacity optional integer health_indications optional < string > array health_state optional string name optional string operational_status optional string storage_array_family optional storage_array_family system_id optional string volume_uuid optional string 4.33.
PAGE 156
Name Schema 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 157
Name Schema iscsi_name optional string name optional string node_wwn 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. RuleSet Name Schema name optional string 4.38.
PAGE 158
Name Schema product_revision optional string storage_array_family optional storage_array_family storage_groups optional string (URI) storage_pools optional string (URI) 4.39. StorageGroup Name Schema SRP optional string masking_views optional < string > array name optional string number_of_volumes optional string parent_storage_group optional string policy optional string 4.40.
PAGE 159
Name Schema policies optional string pool_types optional string total_free_space optional number total_space optional number total_used_space optional number 4.42. StorageView Name Schema initiators optional < string (URI) > array name optional string operational_status optional string ports optional < string (URI) > array virtual_volumes optional < StorageView_virtual_volumes > array 4.43.
PAGE 160
Name Schema block_count optional integer block_size optional integer capacity optional integer health_indications optional < string > array health_state optional string io_status optional string itls optional < StorageVolume_itls > array largest_free_chunk optional integer name optional string operational_status optional string provision_type optional string storage_array_family optional storage_array_family storage_array_name optional string (URI) storage_volumetype optional st
PAGE 161
4.45. StorageVolume_itls Name Schema initiator optional string lun optional string target optional string 4.46. SystemConfig Name Schema branding optional SystemConfig_branding hardware_type optional string limits optional object product_type optional enum (local, metro, unknown) wan_type optional enum (FC, IP, unknown) 4.47. SystemConfig_branding Name Schema platform optional enum (UNKNOWN, GENERIC, VS2, VS6) product_name optional string 4.48.
PAGE 162
4.49. Versions Type : < Version > array 4.50.
PAGE 163
Name Schema pool optional string (URI) 4.52.
PAGE 164
Name Schema 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. admin_state Type : enum (disabled, enabled, inconsistent, unknown) 4.55.
PAGE 165
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 Schema application_co nsistent Set to mark the volume as application consistent optional boolean 4.59. com_status Type : enum (not-applicable, full, partial, none) 4.60. communication_status Type : enum (unknown, ok, busy, no_contact, lost-communication) 4.61.
PAGE 166
Name Description Schema transfer_size optional Number in Byte. Must be a multiple of 4K. Range: 40KB 128M. Default: 128KB(131072). integer 4.64. device_payload Name Schema name required string primary_leg required string (URI) secondary_legs optional < string (URI) > array 4.65. distributed_consistency_group_payload Name Schema name optional string 4.66.
PAGE 167
4.68. distributed_virtual_volume_payload Name Schema device optional string (URI) init optional boolean thin optional boolean tier optional string 4.69. extent_migration_payload Name Description Schema name optional string paused optional boolean 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.
PAGE 168
Name Schema storage_array optional string unclaimed_storage_volumes optional integer 4.73. inline_response_200_1 Name Schema backup_volumes optional < string (URI) > array hours optional integer minutes optional integer 4.74. inline_response_200_claimable_storage_volumes Name Schema storage_volume_name optional string storage_volume_path optional string 4.75.
PAGE 169
4.77. license_payload Name Description Schema file_data required Provide base64 encoded license file content. string (byte) 4.78. logging_volume_payload Name Description Schema name required string storage_volum The storage volumes to use in creating the logging volume. es These storage volumes must be at the same cluster as the required logging volume. < string (URI) > array 4.79. meta_volume_payload Name Schema name required string storage_volumes required < string (URI) > array 4.80.
PAGE 170
Name Description Schema timeout optional Time to allow the discovery process to take integer wait optional Time to wait the discovery process before returning regardless of outcome integer 4.83. register_payload Name Description Schema iscsi_name optional ISCSI name of the port to register. Either port_wwn or iscsi_name should be provided. string node_wwn optional Provide node wwn for registering the port.
PAGE 171
4.88. unclaim_payload Name Description Schema vias_return_to For VIAS-based storage-volumes, this will return the storage _pool capacity of each VIAS-based volume to the pool on the boolean optional corresponding storage-array. 4.89. validate_payload Name Schema file_data optional string (byte) 4.90. vias_payload Name Description Schema base_name required The prefix to use when naming each virtual volume. string capacity required The capacity of each virtual volume, in bytes.
PAGE 172
Name Description Schema Specifies the target device or extent that will be spare_storage concatenated to the supporting storage. It shouldn’t have a optional virtual-volume on top of it. string (URI) 4.92.