Vsan Io Insight Manager Start Io Insight
Start ioinsight tool(s) running on the whole vSAN cluster or on the specified ESXi host(s) for VMs virtual disks I/O performance metrics monitor.
Given the parameters passed-in, ioinsight tool(s) will be started on the ESXi host(s) to monitor and collect VMDKs I/O performance metrics of the specified VMs. Once the specified run duration has expired, ioinsight will stop running automatically. The collected performance metrics will be persisted in vSAN datastore. This API returns a task which is running background and performing actually ioinsight start 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.
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}.
The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.
"StartIoInsightRequestType Object"The cluster to which the ESXi host(s) belong. This parameter is ignored while the API is called against host.
Required privileges: Global.Diagnostics
Caller can specify a meaningful name for ioinsight one time execution, and use that name for ioinsight metrics query in the future. This parameter can be ignored while the API is called against host.
Duration in seconds for ioinsight execution. Once duration has expired ioinsight will stop on it's own. The valid range of duration is between from 60 second to 86400 seconds (24 hours). If this parameter is not provided, the API will try to append targetVMs to the ioinsight(s) running on targetHosts as new monitor targets.
One or multiple ESXi hosts on which ioinsight is installed and going to be started. If this parameter is not provided, all hosts of the cluster will be treated as targets, 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 should be exactly same as the target host.
One or multiple target VMs will be monitored by ioinsight. If this parameter is not provided, all VMs on the host will be treated as targets.
Task which is performing actually ioinsight start operation in the background.
"MoRefTask Object"InvalidArgument: If any argument passed to the API is not specified correctly.
NotFound: if no ESXi host could be contacted to perform the operation when this method is called against vCenter, or ioinsight cannot be found on host.
VsanFault: If any other unexpected failure happened during starting ioinsight.
"MethodFault Object"Fault which is the cause of this fault.
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.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/vsan/VsanIoInsightManager/{moId}/StartIoInsight