Vsan Vc Cluster Health System Vsan Get Hcl Info For Eligible Disks

Fetch HCL information for all vSAN ESA eligible disks of the target object which can be a vSAN cluster or a list of hosts.

Check VsanHclQuerySpec for more details. Note that it only returns disk related HCL information, the fields of other hardware components like CPU, physical NIC will be unset.

Required privileges: System.Read

Request

URI

POST

https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanGetHclInfoForEligibleDisks

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.0.0.0 APIs.

Request Body

VsanGetHclInfoForEligibleDisksRequestType of type(s) application/json

Required

"VsanGetHclInfoForEligibleDisksRequestType Object"

querySpec

Required

Provide the capability to customize the query

Authentication

This operation uses the following authentication methods.

Session

Responses

200

The HCL information for the cluster

Returns VsanClusterHclInfo of type(s) application/json

"VsanClusterHclInfo Object"

string As date-time As date-time

hclDbLastUpdate

Optional

The time (UTC time) from when the currently used HCL DB was known to be the latest up-to-date version.

string

hclDbAgeHealth

Optional

The age health of the HCL DB.

If older than 90 days, state is yellow. If older than 180 days, it is red. If no age known, state is "unknown".

array of object

hostResults

Optional

HCL status of each host.

array of object

updateItems

Optional

List of things (firmwares, drivers, VIBs, etc.) recommended to be installed on the cluster.

Each item in the list applies to a specific host, as not all hosts are assumed to be at the same level. This field is only populated if explicitly requested.

boolean

hclDbAbsent

Optional

True indicates the vSAN HCL DB is absent so that the HCL validation is not able to be performed.

To resolve the issue, please check vSAN Skyline Health UI.

500

NotSupported: if run directly on an ESX Server host.

NotFound: If host could not be contacted to perform the operation.

VsanFault: If unexpected error happened during the query, such as the cluster HCL info is unable to be retrieved, etc.

NotSupported: The API on host level is not supported.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: InlineMethodFault0

"MethodFault Object"

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 '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanGetHclInfoForEligibleDisks

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

V San Service Api Operations