Vsan Io Insight Manager Stop Io Insight

Vsan Io Insight Manager Stop Io Insight

Stop ioinsight tool(s) running on the ESXi host(s) by given parameters passed-in.

The collected VMDKs I/O performance metrics will be persisted in vSAN datastore for further query by: VsanPerfQueryPerf. This API returns a task which is running background and performing actually ioinsight stop operation on each host. Please wait for the task to be completed, and retrieve the final result - one or more VsanHostIoInsightInfo from the corresponding task information.

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

string
release
Required

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


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

The cluster to which the target ESXi host(s) belong. This parameter is ignored while the API is called against host.

Required privileges: Global.Diagnostics

string
runName
Optional

The name of running ioinsight to be stopped. This parameter can be ingnored while being called against host.

array of object
hostsIoInsightInfos
Optional

One or multiple host ioinsight(s) information, which indicate the target ioinsight(s) to be stopped or the VMs to be unmonitored. If VsanIoInsightInfo.monitoredVMs are specified by the parameter, the API will try to unmonitor the VMs from running ioinsight(s), otherwise it will entirely stop the specified ioinsight(s) if no valid runName is provided. If neither this parameter nor runName is provided, the API will try to stop ioinsight(s) on each host in the cluster, and this case is only supported while being invoked against vCenter. If the API is called against host, this parameter is must to have and VsanHostIoInsightInfo.host should be exactly same as the target host.

Authentication
This operation uses the following authentication methods.
Responses
200

Task which is performing actually ioinsight stop operation in the background on each host.

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

500

InvalidArgument: If any argument passed to the function is not specified correctly.

NotFound: If no ESXi host could be contacted to perform the operation when this method is called against vCenter.

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/VsanIoInsightManager/{moId}/StopIoInsight