Managing data centers
The REST APIs under the datacenter category provide information about the clusters, nodes, aggregates, volumes, LUNs, fileshares, namespaces, and other elements in your data center. These APIs are available for querying, adding, deleting, or modifying the configuration in your data center.
Most of these APIs are GET calls that provide cross-cluster aggregation with filtering, sorting and pagination support. On running these APIs, they return data from the database. Therefore, the newly created-objects need to be discovered by the next acquisition cycle for appearing in the response.
curl -X GET "https://<hostname>/api/datacenter/cluster/clusters/4c6bf721-2e3f-11e9-a3e2-00a0985badbb" -H "accept: application/json" -H "Authorization: Basic <Base64EncodedCredentials>"
HTTP verb | Path | Description |
---|---|---|
GET | /datacenter/cluster/clusters /datacenter/cluster/clusters/{key} | You can use this method to view the details of the ONTAP clusters across the data center. The API returns information, such as the IPv4 or IPv6 address of the cluster, information about the node, such as node health, performance capacity, and High Availability (HA) pair, and indicates whether the cluster is All SAN Array. |
GET | /datacenter/cluster/nodes /datacenter/cluster/nodes/{key} | You can use this method to view the details of the nodes in the data center. You can view information about the cluster, node health, performance capacity, and High Availability (HA) pair for the node. |
GET | /datacenter/protocols/cifs/shares /datacenter/protocols/cifs/shares/{key} | You can use this method to view the details of the CIFS shares in the data center. Apart from cluster, SVM, and volume details, information about Access Control List (ACL) is also returned. |
GET | /datacenter/protocols/nfs/export-policies /datacenter/protocols/nfs/export-policies/{key} | You can use this method to view the details of the export policies for the supported NFS services. You can query the export policies for a cluster or storage VM and reuse the export policy key for provisioning NFS file shares. For more information about the assigning and reusing export policies on workloads, see |
GET | /datacenter/storage/aggregates /datacenter/storage/aggregates/{key} | You can use this method to view the collection of aggregates in the data center or a specific aggregate for provisioning workloads on them or monitoring. Information, such as cluster and node details, performance capacity used, available and used space, and storage efficiency is returned. |
GET | /datacenter/storage/luns /datacenter/storage/luns/{key} | You can use this method to view the collection of LUNs in the entire data center. You can view information about the LUN, such as cluster and SVM details, QoS policies, and igroups. |
GET | /datacenter/storage/qos/policies /datacenter/storage/qos/policies/{key} | You can use this method to view the details of all the QoS policies applicable for the storage objects in the data center. Information, such as the cluster and SVM details, the fixed or adaptive policy details,and number of objects applicable for that policy is returned. |
GET | /datacenter/storage/qtrees /datacenter/storage/qtrees/{key} | You can use this method to view the qtree details across the data center for all FlexVol volumes or FlexGroup volumes. Information, such as the cluster and SVM details, FlexVol volume, and export policy are returned. |
GET | /datacenter/storage/volumes /datacenter/storage/volumes/{key} | You can use this method to view the collection of volumes in the data center. Information about the volumes, such as SVM and cluster details, QoS and export policies, whether the volume is of type read-write, data-protection, or load-sharing, is returned. For FlexVol and FlexClone volumes, you can view the information about the respective aggregates. For a FlexGroup volume, the query returns the list of constituent aggregates. |
GET POST DELETE PATCH | /datacenter/protocols/san/igroups /datacenter/protocols/san/igroups/{key} | You can assign initiator groups (igroups) authorized to access particular LUN targets. If there is an existing igroup, you can assign it. You can also create igroups and assign them to the LUNs. You can use these methods to query, create, delete, and modify igroups respectively. Points to note:
|
GET POST DELETE PATCH | /datacenter/svm/svms /datacenter/svm/svms/{key} | You can use these methods to view, create, delete, and modify Storage Virtual Machines (storage VMs). Points to note:
|