StartIoInsightRequestType
The parameters of StartIoInsight.
This structure may be used only with operations rendered under /vsan
.
{
"cluster": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"runName": "string",
"durationSec": 0,
"targetHosts": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"targetVMs": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
]
}
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.