Vsan Vc Cluster Health System Vsan Cluster Query File Service Health Summary

Vsan Vc Cluster Health System Vsan Cluster Query File Service Health Summary

Query the vSAN file service health on all the hosts in the specified cluster.

Use filter fields to determine whether to include infra health or container health. It will include infra health at least.

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

The target cluster.

Required privileges: System.Read

boolean
includeFileServerHealth
Optional

Whether to retrieve file server health, default value is True.

boolean
includeFileShareHealth
Optional

Whether to retrieve file share health, default value is True.

Authentication
This operation uses the following authentication methods.
Responses
200

The file service health summary. Return None if the file service is not enabled.

This response body class contains all of the following: VsanClusterFileServiceHealthSummary 
{
    "0": "V",
    "1": "s",
    "2": "a",
    "3": "n",
    "4": "C",
    "5": "l",
    "6": "u",
    "7": "s",
    "8": "t",
    "9": "e",
    "10": "r",
    "11": "F",
    "12": "i",
    "13": "l",
    "14": "e",
    "15": "S",
    "16": "e",
    "17": "r",
    "18": "v",
    "19": "i",
    "20": "c",
    "21": "e",
    "22": "H",
    "23": "e",
    "24": "a",
    "25": "l",
    "26": "t",
    "27": "h",
    "28": "S",
    "29": "u",
    "30": "m",
    "31": "m",
    "32": "a",
    "33": "r",
    "34": "y",
    "35": " ",
    "36": "O",
    "37": "b",
    "38": "j",
    "39": "e",
    "40": "c",
    "41": "t"
}

500

InvalidArgument: Exception for invalid input arguments, for example, if the cluster is not found.

Returns InvalidArgument of type(s) application/json 
"InvalidArgument Object"
string
invalidProperty
Optional

Optional name of the invalid property.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanVcClusterHealthSystem/{moId}/VsanClusterQueryFileServiceHealthSummary
On This Page
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