Vsan Space Report System Vsan Query Space Usage
Query the vSAN space usage including the space usage overview and the space usage breakdown according to vSAN object type.
This API will take less than one or tens seconds to return according to the number of node and object in the vSAN cluster. The API can also be used to query vSAN datastore physical capacity and what-if capacity under specified storage policies.
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanSpaceReportSystem/{moId}.
The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.
"VsanQuerySpaceUsageRequestType Object"vSAN cluster
Required privileges: System.Read
Storage policies specified to calculate what-if capacity of the cluster vSAN datastore. Default value is None
Flag indicates if the API is called only for getting vSAN datastore physical capacity and what-if capacity. Default value is False, which returns the vSAN space usage including the space usage overview and the space usage breakdown according to vSAN object type. When it is True, the API only returns the vSAN datastore physical capacity and what-if capacity under given storage policies.
the vSAN space usage and vSAN datastore capacities.
"VsanSpaceUsage Object"The total vSAN capacity in byte, which is the total used and free capacity combined.
It's the total of physical space which can be use for writing data including any of user data, metadata and the overhead data.
The free vSAN capacity in byte.
It's the total of free vSAN physical space which can be used for writing data including any of user data, metadata and the overhead data.
The vSAN space usage overview including the vSAN physically written capacity, the reserved and over-reserved capacity and the total used capacity.
It shares the same data structure as the per vSAN object type space usage summary VsanObjectSpaceSummary without setting the object type.
The vSAN space usage detail by breakdown the usage into different vSAN object type.
The vSAN efficient capacity breakdown details when the vSAN cluster enables data efficiency.
The vSAN capacity details if all objects are stored with the specified storage policy.
Total additional storage space, in bytes, potentially used by all vSAN objects except for the virtual machine swap objects and namespace objects on this vSAN datastore.
It can be retrieved through VsanSpaceReportSystem.VsanQuerySpaceUsage by specifying whatifCapacityOnly as False.
Indicates the yellow or red threshold, in bytes, for capacity usage based on current cluster capacityReservationInfo.
Indicates the vSAN space efficiency ratio, it exists only when vSAN efficiency feature is enabled, including dedup and compression.
Since: 8.0.0.4
Failure
"RuntimeFault Object" curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanSpaceReportSystem/{moId}/VsanQuerySpaceUsage