Vsan Vc Cluster Health System Vsan Get Release Recommendation

Get the vSAN recommendation of ESXi releases to update for a cluster, and the associated HCL device constraints to comply for those releases.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanGetReleaseRecommendation

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

string

release

Required

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

Request Body

VsanGetReleaseRecommendationRequestType of type(s) application/json

Required

Show optional properties

{
    "cluster": {},
    "minor": [
        {}
    ],
    "major": [
        {}
    ]
}

{
    "cluster": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "minor": [
        "string"
    ],
    "major": [
        "string"
    ]
}

cluster

Required

The target vSAN cluster

Required privileges: System.Read

array of string

minor

Required

A list of minor update releases. E.g., ['ESXi 6.7 U2']

array of string

major

Required

A list of major update releases. E.g., ['ESXi 6.8', 'ESXi 7.0']

Authentication

This operation uses the following authentication methods.

Session

Responses

200

A list of VsanHclReleaseConstraint consists of: Hcl Constraints for one recommended minor release(if applicable) and Hcl Constraints for one recommended major release(if applicable). If none of the minor or major releases are preferred by vSAN, an empty list will be returned.

[
    {
        "_typeName": "string",
        "cluster": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "release": "string",
        "hostDevices": [
            {
                "_typeName": "string",
                "hostname": "string",
                "devices": [
                    {
                        "_typeName": "string",
                        "deviceName": "string",
                        "pciId": "string",
                        "fwVersion": "string",
                        "features": [
                            "string"
                        ]
                    }
                ]
            }
        ],
        "constraints": [
            {
                "_typeName": "string",
                "pciId": "string",
                "vcgLink": "string",
                "similarVcgLinks": [
                    "string"
                ],
                "compliantFirmwares": [
                    {
                        "_typeName": "string",
                        "firmwareVersion": "string",
                        "compliantDrivers": [
                            {
                                "_typeName": "string",
                                "driverName": "string",
                                "driverVersion": "string",
                                "supportedFeatures": [
                                    "string"
                                ]
                            }
                        ]
                    }
                ],
                "vcgId": 0,
                "model": "string",
                "partner": "string",
                "partNumber": "string",
                "release": "string"
            }
        ]
    }
]

array of object

Optional

Information about the device HCL constraints for a particular release.

This structure may be used only with operations rendered under /vsan.

500

NotSupported: if run directly on an ESX Server host.

NotFound:

VsanFault: If unexpected error happened during the query, such as the releases to query is not recognized or supported by vSAN, or vSAN is not able to retrieve the HCL info from the cluster, etc.

NotSupported:

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

{
    "_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"
        }
    ]
}

faultCause

Optional

Fault which is the cause of this fault.

array of object

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cluster":"{}","minor":["string"],"major":["string"]}' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanGetReleaseRecommendation

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations