API Guide
Table Of Contents
- VPlex REST API
- Table of Contents
- Chapter 1. Overview
- Chapter 2. Security
- Chapter 3. Resources
- 3.1. Aggregate
- 3.2. Amp
- 3.3. Bulk
- 3.4. Certificates
- 3.5. Cluster_witness
- 3.6. Clusters
- 3.7. Consistency_group
- 3.8. Data_migration
- 3.8.1. Create a new DeviceMigration
- 3.8.2. Returns a list of device migrations
- 3.8.3. Returns a single DeviceMigration object
- 3.8.4. Deletes a single canceled or committed DeviceMigration
- 3.8.5. Update attributes on a DeviceMigration
- 3.8.6. Create a new ExtentMigration
- 3.8.7. Returns a list of extent migrations
- 3.8.8. Returns a single ExtentMigration object
- 3.8.9. Deletes a single canceled or committed ExtentMigration
- 3.8.10. Update attributes on a ExtentMigration
- 3.9. Devices
- 3.10. Director
- 3.11. Director_ports
- 3.12. Distributed_storage
- 3.12.1. Create a new distributed ConsistencyGroup
- 3.12.2. Returns a list of distributed ConsistencyGroups
- 3.12.3. Returns a single distributed ConsistencyGroup object
- 3.12.4. Deletes a single distributed ConsistencyGroup
- 3.12.5. Update attributes on a distributed ConsistencyGroup
- 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.
- 3.12.7. Create a new DistributedDevice
- 3.12.8. Returns a list of DistributedDevices
- 3.12.9. Returns a single DistributedDevice object
- 3.12.10. Deletes a single DistributedDevice
- 3.12.11. Update attributes on a DistributedDevice
- 3.12.12. Manually resume I/O to a distributed device that supports a distributed virtual-volume.
- 3.12.13. Create a new distributed VirtualVolume
- 3.12.14. Returns a list of distributed VirtualVolumes
- 3.12.15. Returns a single distributed VirtualVolume object
- 3.12.16. Deletes a single distributed VirtualVolume
- 3.12.17. Update attributes on a distributed VirtualVolume
- 3.12.18. Expand the capacity of a distributed VirtualVolume
- 3.12.19. Returns a list of RuleSets
- 3.12.20. Returns a single RuleSet object
- 3.13. Engine
- 3.14. Exports
- 3.14.1. Registers an InitiatorPort
- 3.14.2. Returns a list of InitiatorPort objects
- 3.14.3. Rediscover initiator ports
- 3.14.4. Returns a single InitiatorPort object
- 3.14.5. Unregister an InitiatorPort
- 3.14.6. Update attributes on an InitiatorPort
- 3.14.7. Returns a list of Port objects
- 3.14.8. Returns a single Port object
- 3.14.9. Update attributes on a Port
- 3.14.10. Create a new StorageView
- 3.14.11. Returns a list of StorageView objects
- 3.14.12. Returns a single StorageView
- 3.14.13. Deletes a single StorageView
- 3.14.14. Update attributes on a StorageView
- 3.15. Extent
- 3.16. Hardware_ports
- 3.17. Health
- 3.18. Jobs
- 3.19. Licenses
- 3.20. Logger
- 3.21. Logging_volume
- 3.22. Logical_units
- 3.23. Maps
- 3.24. Meta_volume
- 3.25. Metadata_backup
- 3.26. Monitors
- 3.27. Permissions
- 3.28. Recoverpoint
- 3.29. Storage_array
- 3.30. Storage_group
- 3.31. Storage_pool
- 3.32. Storage_volume
- 3.33. System_config
- 3.34. Token
- 3.35. Version
- 3.36. Virtual_volume
- 3.36.1. Create a new virtual volume
- 3.36.2. Returns a list of virtual volumes
- 3.36.3. Return a VirtualVolume matching the provided name
- 3.36.4. Deletes a single VirtualVolume
- 3.36.5. Update attributes on a VirtualVolume
- 3.36.6. cache invalidate on virtual volume
- 3.36.7. Expand the capacity of a VirtualVolume
- Chapter 4. Definitions
- 4.1. Aggregate
- 4.2. Aggregates
- 4.3. ArrayManagementProvider
- 4.4. BulkResponse
- 4.5. BulkResponse_tasks
- 4.6. Certificate
- 4.7. Cluster
- 4.8. ClusterWitness
- 4.9. ClusterWitness_components
- 4.10. ConsistencyGroup
- 4.11. ConsistencyGroup_operational_status
- 4.12. Device
- 4.13. DeviceMigration
- 4.14. Director
- 4.15. DirectorPort
- 4.16. DistributedDevice
- 4.17. Engine
- 4.18. Error
- 4.19. Extent
- 4.20. ExtentMigration
- 4.21. HardwarePort
- 4.22. HardwarePorts
- 4.23. InitiatorPort
- 4.24. JsonPatchOp
- 4.25. License
- 4.26. LicenseArray
- 4.27. LocalComHealth
- 4.28. LoggingVolume
- 4.29. LogicalUnit
- 4.30. LoginPayload
- 4.31. LoginResponse
- 4.32. MetaVolume
- 4.33. Monitors
- 4.34. Permission
- 4.35. Port
- 4.36. Port_exports
- 4.37. RPACluster
- 4.38. RuleSet
- 4.39. StorageArray
- 4.40. StorageGroup
- 4.41. StorageMap
- 4.42. StoragePool
- 4.43. StorageView
- 4.44. StorageView_virtual_volumes
- 4.45. StorageVolume
- 4.46. StorageVolume_itls
- 4.47. SystemConfig
- 4.48. Version
- 4.49. Versions
- 4.50. ViasJob
- 4.51. ViasJob_storage_pools
- 4.52. VirtualVolume
- 4.53. WanComHealth
- 4.54. admin_state
- 4.55. amp_payload
- 4.56. certificate_payload
- 4.57. cg_resume_payload
- 4.58. claim_payload
- 4.59. com_status
- 4.60. communication_status
- 4.61. connectivity_status
- 4.62. consistency_group_payload
- 4.63. device_migration_payload
- 4.64. device_payload
- 4.65. distributed_consistency_group_payload
- 4.66. distributed_device_payload
- 4.67. distributed_virtual_volume_expand_payload
- 4.68. distributed_virtual_volume_payload
- 4.69. extent_migration_payload
- 4.70. extent_payload
- 4.71. health_state
- 4.72. inline_response_200
- 4.73. inline_response_200_1
- 4.74. inline_response_200_claimable_storage_volumes
- 4.75. inline_response_201
- 4.76. jobs_storage_pools
- 4.77. license_payload
- 4.78. logging_volume_payload
- 4.79. meta_volume_payload
- 4.80. metadata_backup_payload
- 4.81. operational_status
- 4.82. rediscover_payload
- 4.83. register_payload
- 4.84. role
- 4.85. status
- 4.86. storage_array_family
- 4.87. storage_view_payload
- 4.88. unclaim_payload
- 4.89. validate_payload
- 4.90. vias_payload
- 4.91. virtual_volume_expand_payload
- 4.92. virtual_volume_payload
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. unclaim_payload
Name Description Schema
vias_return_to
_pool
optional
For VIAS-based storage-volumes, this will return the storage
capacity of each VIAS-based volume to the pool on the
corresponding storage-array.
boolean
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
146