Vsan Cluster Health System Vsan Cluster Get Hcl Info

Vsan Cluster Health System Vsan Cluster Get Hcl Info

Fetch HCL information about all devices in use by vSAN on all hosts.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanClusterGetHclInfo
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.0.0.0 APIs.

Request Body
VsanClusterGetHclInfoRequestType of type(s) application/json
Required 
"VsanClusterGetHclInfoRequestType Object"
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.
Responses
200

The vSAN cluster HCL information

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

Failure

Returns NotFound of type(s) application/json 
"NotFound Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanClusterHealthSystem/{moId}/VsanClusterGetHclInfo
On This Page
V San Service Api Operations
POST
Vsan Cluster Health System Vsan Check Cluster Clomd Liveness
POST
Vsan Cluster Health System Vsan Cluster Get Hcl Info
POST
Vsan Cluster Health System Vsan Query Cluster Adv Cfg Sync
POST
Vsan Cluster Health System Vsan Query Cluster Capture Vsan Pcap
POST
Vsan Cluster Health System Vsan Query Cluster Check Limits
POST
Vsan Cluster Health System Vsan Query Cluster Create Vm Health Test
POST
Vsan Cluster Health System Vsan Query Cluster Health System Versions
POST
Vsan Cluster Health System Vsan Query Cluster Network Perf Test
POST
Vsan Cluster Health System Vsan Query Cluster Physical Disk Health Summary
POST
Vsan Cluster Health System Vsan Query Verify Cluster Network Settings
POST
Vsan Cluster Health System Vsan Repair Cluster Immediate Objects