vSAN Management API
|
| Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Managed Object - VsanResourceCheckSystem(vim.vsan.VsanResourceCheckSystem)
- See also
- ClusterComputeResource, Task, VsanResourceCheckSpec, VsanResourceCheckStatus
- Since
- vSAN API 6.8.7
Managed Object Description
This managed object type provides interfaces to perform resource check and query for various operations, e.g. host enter maintenance mode, disk upgrade. It can be accessed through MOID of 'vsan-cluster-resource-check-system', via vSAN service on vCenter at cluster level, or accessed through MOID of 'vsan-resource-check-system' on ESXi host.Properties
| Name | Type | Description |
|---|---|---|
| None | ||
Methods
| Methods defined in this Managed Object |
|---|
| VsanGetResourceCheckStatus, VsanHostCancelResourceCheck, VsanHostPerformResourceCheck, VsanPerformResourceCheck |
VsanGetResourceCheckStatus(getResourceCheckStatus)
Retrieve the status of the latest resource check. If a resource check task is running, its status will be returned. Otherwise the status of the last resource check will be returned.- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VsanResourceCheckSystem used to make the method call. |
| resourceCheckSpec* | VsanResourceCheckSpec |
The specification of the resource check to be queried.
If it is not specified, VsanResourceCheckStatus
will still be returned with VsanResourceCheckStatus#task
and/or VsanResourceCheckStatus#parentTask information
if such task is running in the specified cluster. However,
result will not be populated in this case.
Since vSAN API 6.8.7 |
| cluster* P | ManagedObjectReference
to a ClusterComputeResource |
The cluster to fetch the resource check status.
Since vSAN API 6.8.7 |
Return Value
| Type | Description |
|---|---|
| VsanResourceCheckStatus | The status of the specified resource check. The resource check may have not started yet, or be currently running, or have completed already. If a resource check has completed successfully, detailed resource check result will also be included. |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Exception when the given operation is not supported, some parameter is missing or incorrect in the spec. For example, for host enter maintenance mode operation, host vSAN UUID or maintenanceSpec is not provided, or data evacuation mode is not supported. |
| 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
VsanHostCancelResourceCheck(cancelResourceCheckOnHost)
- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VsanResourceCheckSystem used to make the method call. |
Return Value
| Type | Description |
|---|---|
| xsd:boolean |
Faults
| Type | Description |
|---|---|
| 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
VsanHostPerformResourceCheck(performResourceCheckOnHost)
- Required Privileges
- System.Read
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VsanResourceCheckSystem used to make the method call. |
| resourceCheckSpec | VsanResourceCheckSpec |
Since vSAN API 6.8.7 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task |
Faults
| Type | Description |
|---|---|
| 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
VsanPerformResourceCheck(performResourceCheck)
Perform a resource check for given spec. Given the operation type and parameter(s) for the operation, the resource check will run a point-in-time simulation based on the cluster state at the time of the resource check request. It will check whether current vSAN cluster has enough resource or any issue to perform the operation. For example, given the host enter maintenance mode operation, the host vSAN UUID and data evacuation mode, it will check whether there is enough fault domains, disk capacity, etc. or any inaccessible object which can prevent the host from entering maintenance mode. Only one resource check should be run in a vSAN cluster at a time.- Required Privileges
- None
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the VsanResourceCheckSystem used to make the method call. |
| resourceCheckSpec | VsanResourceCheckSpec |
The specification of the resource check.
Since vSAN API 6.8.7 |
| cluster* P | ManagedObjectReference
to a ClusterComputeResource |
The cluster to run the resource check.
Since vSAN API 6.8.7 |
Return Value
| Type | Description |
|---|---|
| ManagedObjectReference
to a Task | A task to monitor resource check progress. Results can be obtained with the API VsanResourceCheckSystem#GetResourceCheckStatus after the resource check finishes. |
Faults
| Type | Description |
|---|---|
| InvalidArgument | Exception when the given operation is not supported, some parameter is missing or incorrect in the spec. For example, for host enter maintenance mode operation, host vSAN UUID or maintenanceSpec is not provided, or data evacuation mode is not supported. |
| InvalidState | Exception when it is not qualified to run the resource check. For example, for host enter maintenance mode operation, if the given host is already in maintenance mode. |
| NotFound | Exception when the given entity in the spec cannot be found. |
| NotSupported | Thrown if run directly on an ESX Server host. |
| 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
| Top of page | Local Methods | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |