List Hosts Compatibility Releases

Released in v7.0.0

Lists the locally available ESXi releases for a given host that can be used to generate a compatiblity report. Each host has its own list of supported releases depending on its current release. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.HardwareCompatibility.Read.

Request

URL

GET

https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-releases

Path Parameters

Required	Parameter Name	Type	Description
required	host	string	Contains the MoID identifying the ESXi host. The parameter must be an identifier for the resource type: HostSystem.

Header Parameters

Required	Parameter Name	Type	Description
required	vmware-api-session-id	string	Required session ID, obtained by first calling Create Session API

Response

Response Body

200 OK returns HclHostsCompatibilityReleasesEsxiCompatibilityReleases of type application/json

Available releases for compatibility for a specified host.

{
    "current_compatibility_release": "string",
    "newer_compatibility_releases": [
        "string"
    ],
    "notifications": {
        "errors": [
            {
                "id": "string",
                "time": "string"
            }
        ],
        "info": [
            {
                "id": "string",
                "time": "string"
            }
        ],
        "warnings": [
            {
                "id": "string",
                "time": "string"
            }
        ]
    }
}

Property Name	Type	Description
current_compatibility_release	string	The current release of the ESXi, which also can be checked for compatibility. The information for the release does not include patch information.
newer_compatibility_releases	array of string	The available ESXi releases, greater than the current one, than can be checked for compatibility.
notifications	HclNotifications	Notifications returned by the operation.

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/hcl/hosts/{host}/compatibility-releases

Errors

Code	Returns	Description
401	Error	com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated.
404	Error	com.vmware.vapi.std.errors.not_found : if no host with the given MoID can be found. \| com.vmware.vapi.std.errors.resource_inaccessible : if the vCenter this API is executed on is not part of the Customer Experience Improvement Program (CEIP). \| com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure.
405	Error	com.vmware.vapi.std.errors.unsupported : if the provided host is not supported.
409	Error	com.vmware.vapi.std.errors.not_allowed_in_current_state : if there is no compatibility data on the vCenter executing the operation.
500	Error	com.vmware.vapi.std.errors.internal_server_error : If there is some internal error. The accompanying error message will give more details about the failure.
default	Error	Not available