Managed Object - VsanSpaceReportSystem(vim.cluster.VsanSpaceReportSystem)

See also: ComputeResource, QueryVsanManagedStorageSpaceUsageSpec, VirtualMachineProfileSpec, VsanEntitySpaceUsage, VsanSpaceQuerySpec, VsanSpaceUsage, VsanSpaceUsageWithDatastoreType
Since: vSphere API Release 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
QueryVsanManagedStorageSpaceUsage, VsanQueryEntitySpaceUsage, VsanQuerySpaceUsage

QueryVsanManagedStorageSpaceUsage(queryVsanManagedStorageSpaceUsage)

Query the space usage including the space usage overview and the space usage breakdown based on different datastore types. The API can also be used to query physical capacity.

Required Privileges: System.Read
Since: vSAN API vSAN 7.0U1

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanSpaceReportSystem used to make the method call.

cluster

ManagedObjectReference
to a ComputeResource

vSAN cluster

Since vSAN API vSAN 7.0U1

querySpec

QueryVsanManagedStorageSpaceUsageSpec

The QueryVsanManagedStorageSpaceUsageSpec to specify more detailed query specification.

Since vSAN API vSAN 7.0U1

Return Value

Type	Description
VsanSpaceUsageWithDatastoreType[]	The space usage aggregated by different datastore type.

Faults

Type	Description
InvalidArgument	Exception for invalid input arguments, for example, if the querySpec contains invalid datastore type.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanManagedStorageSpaceUsage" type="vsan:QueryVsanManagedStorageSpaceUsageRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryVsanManagedStorageSpaceUsageResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanSpaceUsageWithDatastoreType" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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.

Required Privileges: None
Since: vSAN API 7.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanSpaceReportSystem used to make the method call.

cluster P

ManagedObjectReference
to a ComputeResource

The vSAN cluster

Since vSAN API 7.0

querySpec

VsanSpaceQuerySpec

The vSAN space usage query spec to specify the entity types like virtual machine and the entity UUIDs like the managed object ID for virtual machines.

Since vSAN API 7.0

P Required privilege: System.Read

Return Value

Type	Description
VsanEntitySpaceUsage[]	The vSAN space usage for the vSAN entity

Faults

Type	Description
InvalidArgument
NotSupported
RuntimeFault	Thrown 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

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryEntitySpaceUsage" type="vsan:VsanQueryEntitySpaceUsageRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQueryEntitySpaceUsageResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanEntitySpaceUsage" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

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.

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 Release 5.5
storagePolicies*	VirtualMachineProfileSpec[]	Storage policies specified to calculate what-if capacity of the cluster vSAN datastore. Default value is None *Since* vSphere API Release 5.5
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* vSphere API Release 5.5

*Need not be set P Required privilege: System.Read

Return Value

Type	Description
VsanSpaceUsage	The vSAN space usage and vSAN datastore capacities.

Faults

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

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQuerySpaceUsage" type="vsan:VsanQuerySpaceUsageRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="VsanQuerySpaceUsageResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanSpaceUsage"/>
                     </sequence>
                  </complexType>
               </element>