Vsan System Ex Vsan Query What If Evacuation Result

Vsan System Ex Vsan Query What If Evacuation Result

Query what it takes for an entity(disk group or host) to be evacuated in various modes.

Only account for capacity usage when it determines if an entity can be evacuated in a given mode. Note that this means all other considerations such as fault domain, number of spindles or read cache are ignored and the API will only verify if the cluster has enough capacity to accommodate the affected objects in a specified mode.

Required privileges: System.Read

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

string
release
Required

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

Request Body
VsanQueryWhatIfEvacuationResultRequestType of type(s) application/json
Required 
"VsanQueryWhatIfEvacuationResultRequestType Object"
string
evacEntityUuid
Required

The entity UUID which will be evacuated. It can be an UUID of disk, disk group or host.

Authentication
This operation uses the following authentication methods.
Responses
200

WhatIfEvacResult which indicate whether the evacuation can be done in current cluster state and specified evacuation mode. If so, this API returns what objects would lose liveness or compliance. Or on the other hand, if the given entity cannot be evacuated, API returns many extra resources needed to satisfy this operation.

Returns VsanWhatIfEvacResult of type(s) application/json 
"VsanWhatIfEvacResult Object"
noAction
Required

Represents the impact and prediction if user choose "noAction" evacuation mode to evacuate given diskgroup or host.

ensureAccess
Required

Represents the impact and prediction if user choose "ensureObjectAccessibility" evacuation mode to evacuate given diskgroup or host.

evacAllData
Required

Represents the impact and prediction if user choose "evacuateAllData" evacuation mode to evacuate given diskgroup or host.


500

Failure

Returns RuntimeFault of type(s) application/json
This response body class contains all of the following: InlineRuntimeFault0 
"RuntimeFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanSystemEx/{moId}/VsanQueryWhatIfEvacuationResult
On This Page
V San Service Api Operations
POST
Vsan System Ex Vsan Host Abort Wipe Disk
POST
Vsan System Ex Vsan Get About Info Ex
POST
Vsan System Ex Vsan Host Get Runtime Stats
POST
Vsan System Ex Vsan Query Host Drs Stats
POST
Vsan System Ex Vsan Query Host Status Ex
POST
Vsan System Ex Vsan Query Syncing Vsan Objects
POST
Vsan System Ex Vsan Query What If Evacuation Result
POST
Vsan System Ex Vsan Host Query Wipe Disk
POST
Vsan System Ex Vsan Unmount Disk Mapping Ex
POST
Vsan System Ex Vsan Host Wipe Disk