Host Vsan Health System Vsan Host Query File Service Health Summary

Host Vsan Health System Vsan Host Query File Service Health Summary

Query the file service health summary on the host.

It will include infra health at least.

Required privileges: System.Read

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

Authentication
This operation uses the following authentication methods.
Responses
200

The file service health summary result.

Returns VsanFileServiceHealthSummary of type(s) application/json 
"VsanFileServiceHealthSummary Object"
string
hostname
Optional

Hostname/IP of host which runs the file service health check.

string
overallHealth
Optional

Overall health state for vSAN file service configuration and runtime status for this host.

boolean
enabled
Optional

Enable state for the vSAN file service on this host.

vdfsdStatus
Optional

The health status of VDFS daemon for vSAN file service data service.

fsvmStatus
Optional

The health status of File Service VM.

rootFsStatus
Optional

The health status of Root File System.

array of object
fileServerHealth
Optional

The health status of file servers.

This health status includes liveness of file server IP addresses, accessibility of the root file system from file servers, etc.

array of object
fileShareHealth
Optional

The health status of file shares in this cluster.

balanceStatus
Optional

The health status of load balance of file servers in this cluster.

hostLoadStatus
Optional

The load status of shares on this host.

Note: If hostLoadStatus is overloaded along with file server load balance issues, please rebalance the file shares via the remediation on vSAN health UI. Otherwise, consider adding more ESXi hosts to the cluster. This field will only work in a vSAN ESA cluster.

Since: 8.0.0.4


500

Failure

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

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/vsan/HostVsanHealthSystem/{moId}/VsanHostQueryFileServiceHealthSummary
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