Dell metro node Owner's manual

Dell EMC Storage Systems

REST API for PowerStore and Unity XT metro

node feature

Version 7.0

Table of Contents

1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê1

1.1. Version information. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê1

1.2. Tags . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê1

2. Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê3

2.1. basicAuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê3

2.2. jwtAuth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê3

3. Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê4

3.1. Aggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê4

3.1.1. Groups the resources at the given URI by the values of the provided fields and returns

aggregated computations for each group

4

3.2. Amp . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê4

3.2.1. Register a new ArrayManagementProvider . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê4

3.2.2. Returns a list of registered AMPs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê5

3.2.3. Returns the details of an AMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê6

3.2.4. Unregisters an AMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê7

3.3. Bulk . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê7

3.3.1. Make a bulk request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê7

3.4. Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê8

3.4.1. Add the certificate to the keystore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê8

3.4.2. Fetch the certificate from the keystore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê9

3.4.3. Remove the certificate from the keystore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê10

3.4.4. Fetches the SSL Certificate of an external system. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê11

3.5. Cluster_witness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê11

3.5.1. Return the cluster witness wired to the system . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê11

3.5.2. Deletes the cluster witness configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê12

3.5.3. Update attributes of a cluster witness. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê12

3.6. Clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê13

3.6.1. Returns a list of the available clusters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê13

3.6.2. Return a Cluster matching the provided name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê14

3.6.3. Update attributes of a cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê15

3.7. Consistency_group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê16

3.7.1. Create a new ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê16

3.7.2. Returns a list of ConsistencyGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê17

3.7.3. Returns a single ConsistencyGroup object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê18

3.7.4. Deletes a single ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê19

3.7.5. Update attributes on a ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê19

3.8. Data_migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê20

3.8.1. Create a new DeviceMigration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê20

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê23

3.8.6. Create a new ExtentMigration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê24

3.8.7. Returns a list of extent migrations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê25

3.8.8. Returns a single ExtentMigration object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê26

3.8.9. Deletes a single canceled or committed ExtentMigration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê27

3.8.10. Update attributes on a ExtentMigration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê27

3.9. Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê28

3.9.1. Create a new Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê28

3.9.2. Returns a list of Device objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê30

3.9.3. Returns a single Device object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê31

3.9.4. Deletes a single Device. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê33

3.9.5. Update attributes of a local device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê33

3.10. Director. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê34

3.10.1. Returns a list of the available directors. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê34

3.10.2. Return a Director matching the provided name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê35

3.11. Director_ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê36

3.11.1. Returns a list of director ports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê36

3.11.2. Returns a single DirectorPort object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê37

3.11.3. Update attributes on a DirectorPort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê37

3.12. Distributed_storage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê38

3.12.1. Create a new distributed ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê38

3.12.2. Returns a list of distributed ConsistencyGroups. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê39

3.12.3. Returns a single distributed ConsistencyGroup object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê40

3.12.4. Deletes a single distributed ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê41

3.12.5. Update attributes on a distributed ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê41

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.

42

3.12.7. Create a new DistributedDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê43

3.12.8. Returns a list of DistributedDevices. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê44

3.12.9. Returns a single DistributedDevice object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê45

3.12.10. Deletes a single DistributedDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê46

3.12.11. Update attributes on a DistributedDevice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê47

3.12.12. Manually resume I/O to a distributed device that supports a distributed virtual-

volume.

48

3.12.13. Create a new distributed VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê49

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. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê52

3.12.18. Expand the capacity of a distributed VirtualVolume. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê53

3.12.19. Returns a list of RuleSets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê54

3.12.20. Returns a single RuleSet object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê55

3.13. Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê55

3.13.1. Returns a list of the available engines. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê56

3.13.2. Return a Engine matching the provided name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê56

3.14. Exports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê57

3.14.1. Registers an InitiatorPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê57

3.14.2. Returns a list of InitiatorPort objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê58

3.14.3. Rediscover initiator ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê59

3.14.4. Returns a single InitiatorPort object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê59

3.14.5. Unregister an InitiatorPort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê60

3.14.6. Update attributes on an InitiatorPort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê61

3.14.7. Returns a list of Port objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê62

3.14.8. Returns a single Port object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê62

3.14.9. Update attributes on a Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê63

3.14.10. Create a new StorageView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê64

3.14.11. Returns a list of StorageView objects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê66

3.14.12. Returns a single StorageView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê66

3.14.13. Deletes a single StorageView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê67

3.14.14. Update attributes on a StorageView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê68

3.15. Extent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê69

3.15.1. Create a new Extent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê69

3.15.2. Returns a list of Extent objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê70

3.15.3. Returns a single Extent object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê71

3.15.4. Delets a single Extent object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê72

3.15.5. Update attributes on a Extent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê73

3.16. Hardware_ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê74

3.16.1. Returns a list of hardware ports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê74

3.17. Health . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê75

3.17.1. Return local-COM health information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê75

3.17.2. Return WAN-COM health information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê76

3.18. Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê76

3.18.1. Create a VIAS provisioning job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê76

3.18.2. Get all the current VIAS provisioning jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê77

3.18.3. Get the status of a VIAS provisioning job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê78

3.18.4. Delete a VIAS provisioning jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê79

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê82

3.19.2. Returns a list of installed licenses on the setup. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê83

3.19.3. Deletes the licenses. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê83

3.19.4. Validate a license file . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê84

3.20. Logger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê84

3.20.1. Log information on the server. This endpoint is intended for internal system use only.Ê84

3.21. Logging_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê85

3.21.1. Creates a new Logging Volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê85

3.21.2. Returns a list of LoggingVolume objects. Supports paging. . . . . . . . . . . . . . . . . . . . . . . . . . . Ê86

3.21.3. Returns a single LoggingVolume by name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê87

3.21.4. Deletes a single LoggingVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê88

3.22. Logical_units . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê88

3.22.1. Returns a list of LogicalUnits . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê88

3.22.2. Forgets logicalUnits in an array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê89

3.22.3. Returns a single LogicalUnit by name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê90

3.23. Maps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê91

3.23.1. Get the parents and children for the passed element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê91

3.24. Meta_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê91

3.24.1. Create a new MetaVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê91

3.24.2. Returns a list of MetaVolume objects. Supports paging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê92

3.24.3. Returns a single MetaVolume by name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê93

3.24.4. Deletes a single MetaVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê94

3.24.5. Update attributes on a MetaVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê95

3.25. Metadata_backup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê96

3.25.1. Create List of configured MetaData Backups Volume with their scheduled time . . . . . . Ê96

3.25.2. List the configured MetaData Backup settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê97

3.25.3. Delete configured Metadata backup settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê97

3.26. Monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê98

3.26.1. Return the list of names of active performance monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê98

3.26.2. Return performance stats for the given perf monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê99

3.26.3. Return the list of names of active vvol monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê100

3.26.4. Return performance stats for the given vvol monitor. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê100

3.27. Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê101

3.27.1. Returns the Role-Based Authentication configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê101

3.27.2. Return the Role-Based Authentication configuration for one role. . . . . . . . . . . . . . . . . . . Ê102

3.27.3. Modify the Role-Based Authentication configuration for this role . . . . . . . . . . . . . . . . . . Ê103

3.28. Storage_array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê104

3.28.1. Returns a list of StorageArrays . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê104

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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê107

3.29.1. Return the list storage groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê107

3.29.2. Return details of a given storage group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê108

3.30. Storage_pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê109

3.30.1. Return the list storage pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê109

3.30.2. Return details of a given storage pool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê110

3.31. Storage_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê111

3.31.1. Returns a list of StorageVolume objects. Supports paging . . . . . . . . . . . . . . . . . . . . . . . . . . Ê111

3.31.2. Returns a single StorageVolume by name . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê112

3.31.3. Storage volume is not really missing it will reappear after being forgotten . . . . . . . . . . Ê114

3.31.4. Update attributes on a StorageVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê115

3.31.5. Claim a StorageVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê116

3.31.6. Unclaim a StorageVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê118

3.32. System_config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê120

3.32.1. Return the system configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê120

3.33. Token. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê121

3.33.1. URL to authenticate and get back access_token in case of success . . . . . . . . . . . . . . . . . . Ê121

3.33.2. Endpoint to logout and invalidate/delete the token. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê122

3.34. Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê122

3.34.1. Returns a list of versions of the metro node components . . . . . . . . . . . . . . . . . . . . . . . . . . . 122

3.35. Virtual_volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê123

3.35.1. Create a new virtual volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê123

3.35.2. Returns a list of virtual volumes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê124

3.35.3. Return a VirtualVolume matching the provided name. . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê126

3.35.4. Deletes a single VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê126

3.35.5. Update attributes on a VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê127

3.35.6. cache invalidate on virtual volume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê128

3.35.7. Expand the capacity of a VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê129

4. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê131

4.1. Aggregate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê131

4.2. Aggregates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê131

4.3. ArrayManagementProvider. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê131

4.4. BulkResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê131

4.5. BulkResponse_tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê132

4.6. Certificate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê132

4.7. Cluster . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê132

4.8. ClusterWitness . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê133

4.9. ClusterWitness_components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê133

4.10. ConsistencyGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê134

4.11. ConsistencyGroup_operational_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê134

4.12. Device . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê135

4.13. DeviceMigration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê136

4.14. Director. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê136

4.15. DirectorPort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê138

4.16. DistributedDevice. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê138

4.17. Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê139

4.18. Error . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê140

4.19. Extent . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê140

4.20. ExtentMigration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê141

4.21. HardwarePort . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê142

4.22. HardwarePorts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê142

4.23. InitiatorPort. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê142

4.24. JsonPatchOp. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê143

4.25. License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê143

4.26. LicenseArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê144

4.27. LocalComHealth . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê144

4.28. LoggingVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê144

4.29. LogicalUnit. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê145

4.30. LoginPayload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê145

4.31. LoginResponse . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê145

4.32. MetaVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê146

4.33. Monitors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê146

4.34. Permission . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê147

4.35. Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê147

4.36. Port_exports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê148

4.37. RuleSet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê148

4.38. StorageArray . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê148

4.39. StorageGroup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê149

4.40. StorageMap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê149

4.41. StoragePool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê149

4.42. StorageView. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê150

4.43. StorageView_virtual_volumes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê150

4.44. StorageVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê150

4.45. StorageVolume_itls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê152

4.46. SystemConfig. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê152

4.47. SystemConfig_branding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê152

4.48. Version . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê152

4.49. Versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê153

4.50. ViasJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê153

4.51. ViasJob_storage_pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê153

4.52. VirtualVolume . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê154

4.53. WanComHealth. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê155

4.54. admin_state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê155

4.55. amp_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê155

4.56. certificate_payload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê155

4.57. cg_resume_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê156

4.58. claim_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê156

4.59. com_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê156

4.60. communication_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê156

4.61. connectivity_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê156

4.62. consistency_group_payload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê156

4.63. device_migration_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê156

4.64. device_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê157

4.65. distributed_consistency_group_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê157

4.66. distributed_device_payload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê157

4.67. distributed_virtual_volume_expand_payload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê157

4.68. distributed_virtual_volume_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê158

4.69. extent_migration_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê158

4.70. extent_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê158

4.71. health_state . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê158

4.72. inline_response_200 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê158

4.73. inline_response_200_1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê159

4.74. inline_response_200_claimable_storage_volumes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê159

4.75. inline_response_201 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê159

4.76. jobs_storage_pools . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê159

4.77. license_payload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê160

4.78. logging_volume_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê160

4.79. meta_volume_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê160

4.80. metadata_backup_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê160

4.81. operational_status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê160

4.82. rediscover_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê160

4.83. register_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê161

4.84. role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê161

4.85. status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê161

4.86. storage_array_family. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê161

4.87. storage_view_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê161

4.88. unclaim_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê162

4.89. validate_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê162

4.90. vias_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê162

4.91. virtual_volume_expand_payload . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê162

4.92. virtual_volume_payload. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Ê163

Chapter 1. Overview

A definition for the next-gen metro node API

1.1. Version information

Version : 7.0

1.2. Tags

• aggregate

• amp

• bulk

• certificates

• cluster_witness

• clusters

• consistency_group

• data_migration

• devices

• director

• director_ports

• distributed_storage

• engine

• exports

• extent

• hardware_ports

• health

• jobs

• licenses

• logger

• logging_volume

• logical_units

• maps

• meta_volume

• metadata_backup

• monitors

1

• permissions

• storage_array

• storage_group

• storage_pool

• storage_volume

• system_config

• token

• version

• virtual_volume

2

Chapter 2. Security

2.1. basicAuth

Type : basic

2.2. jwtAuth

Type : apiKey

Name : Authorization

In : HEADER

3

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. Register a new ArrayManagementProvider

POST /clusters/{cluster_name}/array_management_providers

Parameters

Type Name Description Schema

Path

cluster_name

required

The name of the cluster string

Body

amp_payload

required

amp_payload

Responses

4

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

Example HTTP response

Response 201

{

Ê "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.2. Returns a list of registered AMPs

GET /clusters/{cluster_name}/array_management_providers

Parameters

Type Name Description Schema

Path

cluster_name

required

The name of the cluster string

Query

connectivity_s

tatus

optional

Filter results by connectivity_status. See

LexicalQueryExpression for details.

string

(LexicalQueryExpres

sion)

Query

fields

optional

Select which fields are included in the response.

'name' is always included. See

FieldSelectionExpression for details.

string

(FieldSelectionExpre

ssion)

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

specified.

integer (int32)

5

Type Name Description Schema

Query

sort_by

optional

Specify the field priority order and direction for

sorting. See SortingOrderExpression for details.

string

(SortingOrderExpres

sion)

Responses

HTTP

Code

Description Schema

200

A JSON array of registered AMPs

Headers :

X-Total-Count (integer) : The total number of entities in the result set

after filtering.

<

ArrayManagemen

tProvider > array

500 Internal server error Error

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.

'name' is always included. See

FieldSelectionExpression for details.

string

(FieldSelectionExpre

ssion)

Responses

HTTP

Code

Description Schema

200 A single AMP

ArrayManagemen

tProvider

Example HTTP response

Response 200

6

{

Ê "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. Unregisters an AMP

DELETE /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

Responses

HTTP

Code

Description Schema

204 Successfully unregistered the ArrayManagementProvider No Content

3.3. Bulk

3.3.1. Make a bulk request

POST /bulk/

Parameters

Type Name Schema

Body

request

required

< string, object > map

7

Responses

HTTP

Code

Description Schema

200

A summary of the results of the request. This response indicates that

the request was successfully processed, not necessarily that every

task succeeded. The caller should inspect the content of the response

to see which tasks failed.

BulkResponse

400

One of the specified objects requested was invalid. As a result, none

of the tasks were attempted.

No Content

Example HTTP response

Response 200

{

Ê "status" : "ok",

Ê "tasks" : [ {

Ê "status" : "ok",

Ê "object" : "/clusters/cluster-

2/storage_volumes/VPD83T3:600014400000001001f6383efd6c62c9"

Ê }, {

Ê "status" : "error",

Ê "object" : "/clusters/cluster-

2/storage_volumes/VPD83T3:600014400000001001f6383efd6c62cb",

Ê "reason" : {

Ê "code" : "7",

Ê "cmd" : "amf rename amf",

Ê "params" : {

Ê "newname" : "bulk_claim_2"

Ê }

Ê } ]

}

3.4. Certificates

3.4.1. Add the certificate to the keystore.

POST /external_certificates/trusted/{external_certificate}

Parameters

8

Type Name Description Schema

Path

external_certi

ficate

required

The IP:PORT of system associated with this

certificate.

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.com",

Ê "issued_by" : "CN=dsvef103.lss.emc.com-3KWZ7Q XMS Root CA",

Ê "issued_on" : "Mon Sep 18 07:09:29 UTC 2017",

Ê "expires_on" : "Fri Sep 18 07:09:29 UTC 2020",

Ê "SHA1" : "0d e0 ad 22 f2 de 35 25 9c dd 4d 6f 2d e2 25 e0 62 db 70 f6",

Ê "MD5" : "2d e3 a0 b8 54 77 6c",

Ê "encoded_certificate" : "Mkjhsdhnalka76e87dbnw8nk=="

}

3.4.2. Fetch the certificate from the keystore.

GET /external_certificates/trusted/{external_certificate}

Parameters

9

Type Name Description Schema

Path

external_certi

ficate

required

The IP:PORT of system associated with this

certificate.

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.com-3KWZ7Q XMS Root CA",

Ê "issued_on" : "Mon Sep 18 07:09:29 UTC 2017",

Ê "expires_on" : "Fri Sep 18 07:09:29 UTC 2020",

Ê "SHA1" : "0d e0 ad 22 f2 de 35 25 9c dd 4d 6f 2d e2 25 e0 62 db 70 f6",

Ê "MD5" : "2d e3 a0 b8 54 77 6c",

Ê "encoded_certificate" : "Mkjhsdhnalka76e87dbnw8nk=="

}

3.4.3. Remove the certificate from the keystore.

DELETE /external_certificates/trusted/{external_certificate}

Parameters

Type Name Description Schema

Path

external_certi

ficate

required

The IP:PORT of system associated with this

certificate.

string

Responses

HTTP

Code

Description Schema

204 Deleted the certificate from the keystore. No Content

10

3.4.4. Fetches the SSL Certificate of an external system

GET /external_certificates/untrusted/{external_certificate}

Parameters

Type Name Description Schema

Path

external_certi

ficate

required

The IP:PORT of system associated with this

certificate.

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.com",

Ê "issued_by" : "CN=dsvef103.lss.emc.com-3KWZ7Q XMS Root CA",

Ê "issued_on" : "Mon Sep 18 07:09:29 UTC 2017",

Ê "expires_on" : "Fri Sep 18 07:09:29 UTC 2020",

Ê "SHA1" : "0d e0 ad 22 f2 de 35 25 9c dd 4d 6f 2d e2 25 e0 62 db 70 f6",

Ê "MD5" : "2d e3 a0 b8 54 77 6c",

Ê "encoded_certificate" : "Mkjhsdhnalka76e87dbnw8nk=="

}

3.5. Cluster_witness

3.5.1. Return the cluster witness wired to the system

GET /cluster_witness

Responses

11

Page is loading ...

Dell metro node Owner's manual

Dell metro node Owner's manual

Related papers

Other documents