Vsan Update Manager Vsan Vib Install Preflight Check

Vsan Update Manager Vsan Vib Install Preflight Check

Performs pre-flight checks for a VIB install.

Details of checks performed are documented in the result structure.

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

string
release
Required

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


Request Body
VsanVibInstallPreflightCheckRequestType of type(s) application/json
Required
"VsanVibInstallPreflightCheckRequestType Object"
cluster
Optional

Cluster for which to perform preflight check

Required privileges: System.Read

Authentication
This operation uses the following authentication methods.
Responses
200

Preflight check results

Returns VsanVibInstallPreflightStatus of type(s) application/json
"VsanVibInstallPreflightStatus Object"
boolean
manualVmotionRequired
Required

True if DRS is not configured/enabled in a way that would automatically move VMs when performing EnterMaintenanceMode_Task().

In such cases vSAN will issue the EnterMaintenanceMode_Task() call, but users need to assist in vMotion of any VMs on that host, either by using DRS manual recommendation application, or by fully manual vMotion.

boolean
rollingRequired
Required

True if there are powered on VMs on the cluster which prevent a all-at-once install of VIBs across the cluster.

Only relevant when the VIBs that need to installed require maintenance mode.


500

Failure

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

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