Host Vsan System Evacuate Vsan Node Task

Host Vsan System Evacuate Vsan Node Task

Evacuate this host from VSAN cluster.

The task is cancellable.

Required privileges: Host.Config.Storage

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/HostVsanSystem/{moId}/EvacuateVsanNode_Task
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 HostVsanSystem/{moId}.

string
release
Required

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

Request Body
EvacuateVsanNodeRequestType of type(s) application/json
Required 
"EvacuateVsanNodeRequestType Object"
object
maintenanceSpec
Required

The HostMaintenanceSpec data object may be used to specify actions to be taken by a host upon entering maintenance mode.

If the HostMaintenanceSpec or any of its fields are omitted in a call to EnterMaintenanceMode_Task, default actions will be chosen as documented for each field's type.

See also EnterMaintenanceMode_Task, VsanHostDecommissionMode.

integer As int32 As int32
timeout
Required

Time to wait for the task to complete in seconds. If the value is less than or equal to zero, there is no timeout. The operation fails with a Timedout exception if it timed out.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation.

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

500

InvalidState: If the host is entering maintenance mode or evacuating data.

RequestCanceled: if the operation is canceled.

Timedout: if the operation timed out.

VsanFault: if operation fails with VSAN-specific error.

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

The base data object type for all the object model faults that an application might handle.

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}/HostVsanSystem/{moId}/EvacuateVsanNode_Task
On This Page
Host Vsan System Operations
POST
Host Vsan System Add Disks Task
POST
Host Vsan System Evacuate Vsan Node Task
POST
Host Vsan System Initialize Disks Task
POST
Host Vsan System Query Disks For Vsan
POST
Host Vsan System Query Host Status
POST
Host Vsan System Recommission Vsan Node Task
POST
Host Vsan System Remove Disk Task
POST
Host Vsan System Remove Disk Mapping Task
POST
Host Vsan System Unmount Disk Mapping Task
POST
Host Vsan System Update Vsan Task
GET
Host Vsan System Get Config