Vsan Performance Manager Vsan Perf Diagnose Task

Vsan Performance Manager Vsan Perf Diagnose Task

Runs a diagnostic query to determine performance issues in a vSAN cluster.

This API call investigates the state of the vSAN cluster during the chosen period of time, and returns any issues (list of VsanPerfDiagnosticResult) that may be limiting the performance of the vSAN cluster. This API is available from only the vCenter, it is not available at the end-host. Processing is performed in the background, and a task is returned. Please wait for the task to finish, and then call GetVsanPerfDiagnosisResult to retrieve results.

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

string
release
Required

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

Request Body
VsanPerfDiagnoseTaskRequestType of type(s) application/json
Required 
"VsanPerfDiagnoseTaskRequestType Object"
perfDiagnoseQuery
Required

The query describing details of diagnosis required, such as the period of diagnosis and the query type.

cluster
Optional

vSAN cluster. Ignored if called against host.

Required privileges: Global.Diagnostics

Authentication
This operation uses the following authentication methods.
Responses
200

A task doing the asynchronous work.

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

500

InvalidArgument: if the set of arguments passed to the function is not specified correctly.

NotFound: if no ESXi host could be contacted to perform the operation when called against vCenter or if the API was not invoked on vCenter or if CEIP is not enabled

VsanFault: if the caller doesn't have the required privilege, or the cluster has no hosts.

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/VsanPerformanceManager/{moId}/VsanPerfDiagnoseTask
On This Page
V San Service Api Operations
POST
Vsan Performance Manager Vsan Perf Create Stats Object
POST
Vsan Performance Manager Vsan Perf Create Stats Object Task
POST
Vsan Performance Manager Vsan Perf Delete Stats Object
POST
Vsan Performance Manager Vsan Perf Delete Stats Object Task
POST
Vsan Performance Manager Vsan Perf Delete Time Range
POST
Vsan Performance Manager Vsan Perf Get Aggregated Entity Types
POST
Vsan Performance Manager Vsan Perf Get Supported Diagnostic Exceptions
POST
Vsan Performance Manager Vsan Perf Get Supported Entity Types
POST
Vsan Performance Manager Get Vsan Perf Diagnosis Result
POST
Vsan Performance Manager Vsan Perf Query Cluster Health
POST
Vsan Performance Manager Vsan Perf Query Node Information
POST
Vsan Performance Manager Query Remote Server Clusters
POST
Vsan Performance Manager Vsan Perf Query Stats Object Information
POST
Vsan Performance Manager Vsan Perf Query Time Ranges
POST
Vsan Performance Manager Vsan Perf Query Perf
POST
Vsan Performance Manager Query Vsan Perf Hotspot Entities
POST
Vsan Performance Manager Query Vsan Perf Top Entities
POST
Vsan Performance Manager Vsan Perf Save Time Ranges
POST
Vsan Performance Manager Vsan Perf Set Stats Object Policy
POST
Vsan Performance Manager Vsan Perf Toggle Verbose Mode
POST
Vsan Performance Manager Vsan Perf Diagnose
Deprecated
POST
Vsan Performance Manager Vsan Perf Diagnose Task