Vsan Diagnostics System Start IO Diagnostics Task

Vsan Diagnostics System Start IO Diagnostics Task

Start IO diagnostics task against the given targets running on vSAN datastore.

It's not supported to run multiple diagnostics tasks at the same time. You need either cancel the running task or wait until it completes before starting a new diagnostics task.

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

string
release
Required

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

Request Body
StartIODiagnosticsTaskRequestType of type(s) application/json
Required 
"StartIODiagnosticsTaskRequestType Object"
array of object
targets
Required

The targets to run the diagnostics.

cluster
Optional

The cluster where the targets belong to, ignored when calling against ESXi hosts.

Required privileges: Global.Diagnostics

integer As int64 As int64
duration
Optional

The duration time in seconds to run diagnostics. The valid range is [300, 3600], default is 300.

Authentication
This operation uses the following authentication methods.
Responses
200

The task that runs the diagnostics.

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

500

InvalidArgument: if the targets are not valid.

NotSupported: if there's already a running diagnostics task.

VsanFault: if the caller doesn't have the required privilege or if the pre-check tests failed.

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/VsanDiagnosticsSystem/{moId}/StartIODiagnosticsTask
On This Page
V San Service Api Operations
POST
Vsan Diagnostics System Create IO Trip Analyzer Recurrences
POST
Vsan Diagnostics System Edit IO Trip Analyzer Recurrences
POST
Vsan Diagnostics System Get IO Trip Analyzer Scheduler Config
POST
Vsan Diagnostics System Vsan Get Thresholds
POST
Vsan Diagnostics System Query IO Diagnostics Instances
POST
Vsan Diagnostics System Query IO Diagnostics Stats
POST
Vsan Diagnostics System Vsan Query Network Diagnostics
POST
Vsan Diagnostics System Remove IO Trip Analyzer Recurrences
POST
Vsan Diagnostics System Vsan Set Thresholds
POST
Vsan Diagnostics System Vsan Set Trace Object Policy
POST
Vsan Diagnostics System Start IO Diagnostics Task