Vsan Phone Home System Vsan Perform Online Health Check

Vsan Phone Home System Vsan Perform Online Health Check

An asynchronous API for performing vSAN online health checks.

This API generates a task to collect current vSAN environment settings and performance data driven by a manifest, and send the collected data to VMware for data streaming analysis. It then queries the analyzed results back to help customer have the best vSAN practices. This task usually takes about 1 minute for a typical 4 nodes vSAN cluster. However, this task can take more time based on the size of vSAN cluster, the size of queried data driven by manifest and the customer Internet speed.

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

string
release
Required

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

Request Body
VsanPerformOnlineHealthCheckRequestType of type(s) application/json
Required 
"VsanPerformOnlineHealthCheckRequestType Object"
cluster
Required

The target vSAN cluster

Required privileges: Host.Inventory.EditCluster

Authentication
This operation uses the following authentication methods.
Responses
200

task vCenter Task

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

500

Failure

Returns MethodFault of type(s) application/json
This response body class contains all of the following: InlineMethodFault0 
"MethodFault Object"
faultCause
Optional

Fault which is the cause of this fault.

array of object
faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanPhoneHomeSystem/{moId}/VsanPerformOnlineHealthCheck
On This Page
V San Service Api Operations
POST
Vsan Phone Home System Query Vsan Cloud Health Status
POST
Vsan Phone Home System Vsan Perform Online Health Check
POST
Vsan Phone Home System Vsan Query LSO Mwbsize
POST
Vsan Phone Home System Vsan Query Nvme Critical Warning Stats
POST
Vsan Phone Home System Vsan Query Object Snapshots Info
POST
Vsan Phone Home System Vsan Query Zdom Scrubber Data