Managed Object -
VsanSpaceReportSystem(vim.cluster.VsanSpaceReportSystem)
- See also
-
ComputeResource, VirtualMachineProfileSpec, VsanEntitySpaceUsage, VsanSpaceQuerySpec, VsanSpaceUsage
- Since
- vSphere API 5.5
Managed Object Description
This managed object type provides the service interface to report the
vSAN cluster space usage information including the space overview, the
space usage breakdown to various vSAN object types and the vSAN data
efficiency info after enabling vSAN deduplication.
The ManagedEntity can be accessed with MOID of 'vsan-cluster-space-report-system',
through vSAN service at vCenter server side.
Properties
|
Name
|
Type
|
Description
|
| None |
Methods
VsanQueryEntitySpaceUsage(queryEntitySpaceUsage)
Query the vSAN space usage for the given vSAN object entities which
contain a group of objects like the virtual machine with virtual disks
backed by vSAN objects. Note it can query maximum 100 entities' space
usage in one call for performance consideration.
Combined Privileges Required (on vSphere ManagedEntity):
| Privileges | Required on |
| System.Read | ClusterComputeResource |
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on
* The Required Privileges section below is not used, please ignore.
- Required Privileges
- None
- Since
- vSAN API 7.0
Parameters
P
Return Value
Faults
Events
Show WSDL type definition
VsanQuerySpaceUsage(querySpaceUsage)
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.
Combined Privileges Required (on vSphere ManagedEntity):
| Privileges | Required on |
| System.Read | ClusterComputeResource |
* The RootFolder entity in above table refers to the vCenter server itself in the vCenter UI
* The ClusterComputeResource entity in above table refers to the cluster which is being operated on
* The Required Privileges section below is not used, please ignore.
- Required Privileges
- None
Parameters
| Name | Type | Description |
| _this | ManagedObjectReference |
A reference to the
VsanSpaceReportSystem
used to make the method call.
|
| cluster P | ManagedObjectReference
to a
ComputeResource |
vSAN cluster
Since vSphere API 5.5
|
| storagePolicies P | VirtualMachineProfileSpec[] |
Storage policies specified to calculate what-if
capacity of the cluster vSAN datastore. Default
value is None
Since vSphere API 5.5
|
| whatifCapacityOnly P | xsd:boolean |
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.
Since vSphere API 5.5
|
P
Return Value
|
Type
|
Description
|
| VsanSpaceUsage | The vSAN space usage and vSAN datastore capacities. |
Faults
Events
Show WSDL type definition