Vsan Cluster Health System Vsan Query Cluster Health System Versions

Queries vSAN health service version number string for each host and check if all of them are consistent.

Mark issueFound flag as True if they are not consistent.

As of vSphere API version 9.0, this API is deprecated and should not be used. There is no dedicated vSAN health service version as the vSAN health functionality is always part of vCenter Server and ESX host. The vSAN health version will always equal the vCenter Server or ESX host version, which can be queried directly from the vCenter Server or ESX host APIs. Use version from vCenter Server or the appropriate ESX host version API instead.

Required privileges: System.Read

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryClusterHealthSystemVersions

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

string

release

Required

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

Request Body

VsanQueryClusterHealthSystemVersionsRequestType of type(s) application/json

Required

Show optional properties

{
    "hosts": [
        {}
    ],
    "esxRootPassword": "string"
}

{
    "hosts": [
        "string"
    ],
    "esxRootPassword": "string"
}

array of string

hosts

Required

The vSAN hosts

string

esxRootPassword

Required

The root password for the host. The password should be the same for all of hosts in the vSAN cluster

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The vSAN cluster health service version result

Returns VsanClusterHealthSystemVersionResult of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "hostResults": [
        {
            "_typeName": "string",
            "hostname": "string",
            "version": "string",
            "error": {
                "_typeName": "string",
                "faultCause": {
                    "_typeName": "string",
                    "faultCause": "MethodFault Object",
                    "faultMessage": [
                        {
                            "_typeName": "string",
                            "key": "string",
                            "arg": [
                                {
                                    "_typeName": "string",
                                    "key": "string",
                                    "value": {
                                        "_typeName": "string"
                                    }
                                }
                            ],
                            "message": "string"
                        }
                    ]
                },
                "faultMessage": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "arg": [
                            {
                                "_typeName": "string",
                                "key": "string",
                                "value": {
                                    "_typeName": "string"
                                }
                            }
                        ],
                        "message": "string"
                    }
                ]
            },
            "build": "string"
        }
    ],
    "vcVersion": "string",
    "issueFound": false,
    "upgradePossible": false,
    "vcBuild": "string"
}

array of object

hostResults

Optional

The version information for all the hosts requested includes disconnected hosts and hosts without response.

string

vcVersion

Optional

Return vSAN health service version number string on vCenter Server side.

If the query is not requested from vCenter Server, it will be unset.

boolean

issueFound

Required

True if the vSAN health service versions are inconsistent or query fails on some host.

boolean

upgradePossible

Optional

True if the vSAN health service version can be upgraded on at least one host.

Takes into account which upgrade paths are supported, not just if the version is outdated.

string

vcBuild

Optional

Return the build number of VMware vCenter.

If the query is not requested from vCenter Server, it will be unset.

500

Failure

Returns NotFound 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"
        }
    ]
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hosts":["string"],"esxRootPassword":"string"}' https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanQueryClusterHealthSystemVersions

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations

POST

Vsan Cluster Health System Vsan Check Cluster Clomd Liveness