Which REST API or CLI is equivalent to Capacity in ONTAP System Manager Dashboard?

Applies to

ONTAP System Manager 9.7 or later

Answer

Capacity in ONTAP System Manager Dashboard shows sizes of USED and AVAILABLE.

REST API and CLI to obtain these values are:

• REST API for USED

[<CLUSTER>/api/storage/cluster?fields=*]

• CLI for USED

::*> storage aggregate show-efficiency -aggregate <AGGREGATE> -fields aggregate,total-logical-used,total-physical-used,aggr-logical-used,aggr-physical-used,total-storage-efficiency-ratio

Note: Advanced privilege is required.

• REST API for AVAILABLE

[<CLUSTER>/api/storage/aggregates?fields=space,space.block_storage.inactive_user_data,*]

• CLI for AVAILABLE

::> df -A

 

Example:

Results of REST API and CLI corresponding to the above screenshot(USED is 7.32 MB, AVAILABLE is 28.32 GB).

• REST API for USED

[cluster2/api/storage/cluster?fields=*]

<snip>
{
"efficiency": {
    "savings": 0,
    "ratio": 1,
    "logical_used": 7671808
},
</snip>

Logical_used: 7671808 == 7671808/1024/1024 == 7.32 MB

• CLI for USED

::*> storage aggregate show-efficiency -aggregate aggr1_cluster2_01 -fields aggregate,total-logical-used,total-physical-used,aggr-logical-used,aggr-physical-used,total-storage-efficiency-ratio

aggregate                 total-logical-used     total-physical-used     total-storage-efficiency-ratio     aggr-logical-used     aggr-physical-used
-----------------             ------------------             -------------------             ------------------------------             -----------------             ------------------
aggr1_cluster2_01     7.32MB                     13.83MB                     1.00:1                                         13.83MB                   13.83MB

total-logical-used = 7.32 MB

• REST API for AVAILABLE

[cluster2/api/storage/aggregates?fields=space,space.block_storage.inactive_user_data,*]

Only Data Aggregates (No Root Aggregate):

<snip>
"space": {
"footprint": 25886720,
"block_storage": {
    "size": 30439669760,
    "available": 30404370432,
    "used": 35299328,
    "full_threshold_percent": 98
},
</snip>

Available Space: 30404370432/1024/1024/1024 == 28.32 GB

• CLI for AVAILABLE

::> df -A
Aggregate                           kbytes               used          avail         capacity
aggr1_cluster2_01             29726240     34332       29691908       0%
aggr1_cluster2_01/.snapshot  0                  0              0                   0%

Available Space: 29691908 == 29691908/1024/1024 == 28.32 GB 

Additional Information

additionalInformation_text