Host Vsan Health System Vsan Get Hcl Info

Host Vsan Health System Vsan Get Hcl Info

Fetch HCL information about all devices in use by vSAN.

Currently covers SCSI controllers.

Required privileges: System.Read

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanGetHclInfo
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 HostVsanHealthSystem/{moId}.

string
release
Required

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

Request Body
VsanGetHclInfoRequestType of type(s) application/json
Required 
"VsanGetHclInfoRequestType Object"
boolean
includeVendorInfo
Optional

Include vendor tool controller raw info in the result

boolean
vsanEsaEligibleDisksOnly
Optional

True indicates the query is only for vSAN ESA eligible disks. Other details of physical NICs or compute resources will not be returned.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns VsanHostHclInfo of type(s) application/json 
"VsanHostHclInfo Object"
string
hostname
Required

Hostname of the host.

boolean
hclChecked
Required

Whether the returned data was checked against the HCL DB.

string
releaseName
Optional

Version of ESXi.

error
Optional

If error is set, it means that collection of HCL information failed for this host.

array of object
controllers
Optional

Information about all controllers in use by vSAN.

array of object
pnics
Optional

Information about all physical nics

host
Optional

Host system reference.

computeResource
Optional

Information about the host compute resource.

array of string
vsanHostCompatibility
Optional

vSAN compatibility status of the host.

It will check against all hardware components and aggregate the compatible statuses, like CPUs, memory, physical NICs and disks.

See also VsanConfigTypeEnum.


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/HostVsanHealthSystem/{moId}/VsanGetHclInfo
On This Page
V San Service Api Operations
POST
Host Vsan Health System Vsan Host Clomd Liveness
POST
Host Vsan Health System Vsan Host Cleanup Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Create Vm Health Test
POST
Host Vsan Health System Vsan Flash Scsi Controller Firmware Task
Deprecated
POST
Host Vsan Health System Vsan Get Hcl Info
POST
Host Vsan Health System Vsan Get Network Diagnostics Health Info
POST
Host Vsan Health System Vsan Get Proactive Rebalance Info
POST
Host Vsan Health System Vsan Host Prepare Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Host Query Adv Cfg
POST
Host Vsan Health System Vsan Host Query Check Limits
POST
Host Vsan Health System Vsan Host Query Encryption Health Summary
POST
Host Vsan Health System Vsan Host Query File Service Health Summary
POST
Host Vsan Health System Vsan Query Host EMM State
POST
Host Vsan Health System Vsan Host Query Host Info By Uuids
POST
Host Vsan Health System Vsan Host Query Object Health Summary
POST
Host Vsan Health System Vsan Host Query Physical Disk Health Summary
POST
Host Vsan Health System Vsan Host Query Run Iperf Client
POST
Host Vsan Health System Vsan Host Query Run Iperf Server
POST
Host Vsan Health System Vsan Host Query Smart Stats
POST
Host Vsan Health System Vsan Host Query Verify Network Settings
POST
Host Vsan Health System Vsan Host Query Health System Version
POST
Host Vsan Health System Vsan Host Repair Immediate Objects
POST
Host Vsan Health System Vsan Host Run Vmdk Load Test
Deprecated
POST
Host Vsan Health System Vsan Start Proactive Rebalance
POST
Host Vsan Health System Vsan Stop Proactive Rebalance
POST
Host Vsan Health System Vsan Wait For Vsan Health Generation Id Change