Vsan Upgrade System Ex Vsan Query Upgrade Status Ex

Retrieve the latest status of a running, or the previously completed, upgrade or precheck process.

Information about previous upgrade runs are not always, e.g. when vCenter gets restarted.

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanUpgradeSystemEx/{moId}/VsanQueryUpgradeStatusEx

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 VsanUpgradeSystemEx/{moId}.

string

release

Required

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

Request Body

VsanQueryUpgradeStatusExRequestType of type(s) application/json

Required

"VsanQueryUpgradeStatusExRequestType Object"

cluster

Required

The cluster for which to retrieve the upgrade status.

Required privileges: System.Read

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Status

Returns VsanUpgradeStatusEx of type(s) application/json

This response body class contains all of the following: InlineVsanUpgradeStatusEx0

"VsanUpgradeStatusEx Object"

boolean

isPrecheck

Optional

Is or was this a precheck call, instead of a full upgrade.

precheckResult

Optional

If this was a precheck that completed, then the result will be in this field.

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

V San Service Api Operations

POST

Vsan Upgrade System Ex Perform Vsan Upgrade Ex

POST