vSAN Management API


Managed Object - VsanSpaceReportSystem(vim.cluster.VsanSpaceReportSystem)

See also
ComputeResource, VirtualMachineProfileSpec, 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

Methods defined in this Managed Object
VsanQuerySpaceUsage

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
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the VsanSpaceReportSystem used to make the method call.
clusterManagedObjectReference
to a ComputeResource

vSAN cluster
storagePolicies*VirtualMachineProfileSpec[]

Storage policies specified to calculate what-if capacity of the cluster vSAN datastore. Default value is None

Since vSAN API vSAN 6.7U1
whatifCapacityOnly*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 vSAN API vSAN 6.7U1
*Need not be set

Return Value

Type Description
VsanSpaceUsageThe vSAN space usage and vSAN datastore capacities.

Faults

Type Description
InvalidArgument
NotSupported
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault

Events

Type
None

Show WSDL type definition