Vsan Vc Cluster Health System Vsan Vc Cluster Get Hcl Info

Vsan Vc Cluster Health System Vsan Vc Cluster Get Hcl Info

Fetch HCL information including the HCL DB status in general and all devices used by vSAN on all hosts in the cluster(if any).

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanVcClusterGetHclInfo
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
VsanVcClusterGetHclInfoRequestType of type(s) application/json
Required
"VsanVcClusterGetHclInfoRequestType Object"
cluster
Optional

The target vCenter cluster. Set to NULL if only intent to get the HCL DB status in general

Required privileges: System.Read

boolean
includeHostsResult
Optional

True to include the HCL information for each of host in the cluster.

boolean
includeVendorInfo
Optional

Include the vendor tool information in the result

string
esxRelease
Optional

The ESXi release version which HCL is computed against

object
querySpec
Optional

vSAN HCL query specification which defines the validation target and scope.

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

Authentication
This operation uses the following authentication methods.
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

Failure

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanVcClusterGetHclInfo
                
V San Service Api Operations
POST
Vsan Vc Cluster Health System Vsan Attach Vsan Support Bundle To Sr
POST
Vsan Vc Cluster Health System Vsan Download And Install Vendor Tool Task
Deprecated
POST
Vsan Vc Cluster Health System Vsan Download Hcl File Task
Deprecated
POST
Vsan Vc Cluster Health System Vsan Get Hcl Constraints
POST
Vsan Vc Cluster Health System Vsan Vc Cluster Get Hcl Info
POST
Vsan Vc Cluster Health System Vsan Get Release Recommendation
POST
Vsan Vc Cluster Health System Vsan Get Disk Hcl Constraints
POST
Vsan Vc Cluster Health System Vsan Get Hcl Info For Eligible Disks
POST
Vsan Vc Cluster Health System Vsan Health Get Vsan Cluster Silent Checks
POST
Vsan Vc Cluster Health System Vsan Health Is Rebalance Running
POST
Vsan Vc Cluster Health System Vsan Purge Hcl Files
Deprecated
POST
Vsan Vc Cluster Health System Vsan Query All Supported Health Checks
POST
Vsan Vc Cluster Health System Vsan Query Attach To Sr History
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Create Vm Health History Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Create Vm Health Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Health Summary
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Health Summary Task
POST
Vsan Vc Cluster Health System Vsan Query Cluster Historical Health
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Network Perf History Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Network Perf Task
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Network Perf Test
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Vmdk Load History Test
Deprecated
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Vmdk Workload Types
Deprecated
POST
Vsan Vc Cluster Health System Vsan Cluster Query File Service Health Summary
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Smart Stats Summary
POST
Vsan Vc Cluster Health System Vsan Vc Cluster Query Verify Health System Versions
POST
Vsan Vc Cluster Health System Vsan Health Query Vsan Cluster Health Check Interval
POST
Vsan Vc Cluster Health System Vsan Health Query Vsan Cluster Health Config
POST
Vsan Vc Cluster Health System Vsan Query Vc Cluster Obj Ext Attrs
POST
Vsan Vc Cluster Health System Vsan Health Query Vsan Proxy Config
POST
Vsan Vc Cluster Health System Vsan Rebalance Cluster
POST
Vsan Vc Cluster Health System Vsan Health Repair Cluster Objects Immediate
POST
Vsan Vc Cluster Health System Vsan Vc Cluster Run Vmdk Load Test
Deprecated
POST
Vsan Vc Cluster Health System Vsan Health Send Vsan Telemetry
POST
Vsan Vc Cluster Health System Vsan Health Set Log Level
POST
Vsan Vc Cluster Health System Vsan Health Set Vsan Cluster Health Check Interval
POST
Vsan Vc Cluster Health System Vsan Health Set Vsan Cluster Silent Checks
POST
Vsan Vc Cluster Health System Vsan Health Set Vsan Cluster Telemetry Config
POST
Vsan Vc Cluster Health System Set Vsan Vcg Mapping For Hw Devices
POST
Vsan Vc Cluster Health System Vsan Stop Rebalance Cluster
POST
Vsan Vc Cluster Health System Vsan Health Test Vsan Cluster Telemetry Proxy
POST
Vsan Vc Cluster Health System Vsan Health Update Default DS Policy Recommendation
POST
Vsan Vc Cluster Health System Vsan Vc Update Hcl Db From Web
POST
Vsan Vc Cluster Health System Vsan Vc Upload Hcl Db