| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
QueryVsanManagedStorageSpaceUsage, VsanQueryEntitySpaceUsage, VsanQuerySpaceUsage |
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 vSAN API vSAN 7.0U1 |
querySpec P | 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 |
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 P | 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 |
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 |
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 |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |