Vsan Upgrade System Query Vsan Upgrade Status

Vsan Upgrade System Query Vsan Upgrade Status

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

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

Required privileges: System.Read

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/VsanUpgradeSystem/{moId}/QueryVsanUpgradeStatus
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 VsanUpgradeSystem/{moId}.

string
release
Required

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

Request Body
QueryVsanUpgradeStatusRequestType of type(s) application/json
Required

Show optional properties

{
    "cluster": {}
}
{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
MoRefClusterComputeResource
cluster
Required

Reference to an instance of the ClusterComputeResource managed object.

Authentication
This operation uses the following authentication methods.
Responses
200

Status

Returns VsanUpgradeSystemUpgradeStatus of type(s) application/json
This response body class contains all of the following: DataObject 
{
    "_typeName": "string",
    "inProgress": false,
    "history": [
        {
            "_typeName": "string",
            "timestamp": "string",
            "host": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            },
            "message": "string",
            "task": {
                "_typeName": "string",
                "type": "string",
                "value": "string"
            }
        }
    ],
    "aborted": false,
    "completed": false,
    "progress": 0
}
boolean
inProgress
Required

True if there is an active upgrade process.

If true, other fields are guaranteed to be populated. If false, other fields may reflect a previous upgrade process run, or they may be unset.

array of VsanUpgradeSystemUpgradeHistoryItem
history
Optional

Log of a single upgrade task.

Lists all operations performed by the upgrade process in chronological order.

boolean
aborted
Optional

Set if the upgrade process was aborted.

boolean
completed
Optional

Set if the upgrade process has completed successfully.

integer As int32 As int32
progress
Optional

Progress in percent.


500

Failure

Returns VsanFault of type(s) application/json
This response body class contains all of the following: VimFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Virtual Infrastructure Operations
POST
Vsan Upgrade System Perform Vsan Upgrade Task
POST
Vsan Upgrade System Perform Vsan Upgrade Preflight Check
POST
Vsan Upgrade System Query Vsan Upgrade Status