Vsan Resource Check System Vsan Perform Resource Check

Vsan Resource Check System Vsan Perform Resource Check

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.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanResourceCheckSystem/{moId}/VsanPerformResourceCheck
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VsanResourceCheckSystem/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.


Request Body
VsanPerformResourceCheckRequestType of type(s) application/json
Required
"VsanPerformResourceCheckRequestType Object"
resourceCheckSpec
Required

The specification of the resource check.

cluster
Optional

The cluster to run the resource check.

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

A task to monitor resource check progress. Results can be obtained with the API VsanGetResourceCheckStatus after the resource check finishes.

Returns MoRefTask of type(s) application/json
"MoRefTask Object"

500

NotSupported: if run directly on an ESX Server host.

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.

VsanFault: If any error happens during the resource check.

NotFound: Exception when the given entity in the spec cannot be found.

NotSupported: Exception if the resource check is not supported on the given entity. For example, it's not supported to run disk data evacuation resource check on an unmounted disk/disk-group.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0
"MethodFault Object"
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanResourceCheckSystem/{moId}/VsanPerformResourceCheck