Managed Object - VsanIoInsightManager(vim.cluster.VsanIoInsightManager)

See also: ClusterComputeResource, HostSystem, Task, VirtualMachine, VsanHostIoInsightInfo, VsanIoInsightInstance, VsanIoInsightInstanceQuerySpec
Since: vSAN API 7.2

Managed Object Description

This managed object is designed to provide service interfaces to manage ioinsight(s) for VMs virtual disks I/O performance metrics monitor and collection on the target hosts. It can be accessed through MOID of 'vsan-cluster-ioinsight-manager' via vSAN service on vCenter, or accessed through MOID of 'vsan-ioinsight-manager' on ESXi host.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
DeleteIoInsightInstance, QueryIoInsightInstances, RenameIoInsightInstance, StartIoInsight, StopIoInsight

DeleteIoInsightInstance(deleteIoInsightInstance)

Delete information of a completed ioinsight instance specified by the passed-in runName.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanIoInsightManager used to make the method call.

runName

xsd:string

Run name of the ioinsight instance.

Since vSAN API 7.2

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster where the ioinsight instance belongs to. This parameter is ignored while the API is called against host.

Since vSAN API 7.2

*Need not be set P Required privilege: Global.Diagnostics

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if any argument passed to the function is not specified correctly.
NotFound	Thrown if the specified ioinsight instance is not found.
NotSupported	Thrown if the API is not supported by the called host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Thrown if any other unexpected fault is encountered.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="DeleteIoInsightInstance" type="vsan:DeleteIoInsightInstanceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="DeleteIoInsightInstanceResponse">
                  <complexType/>
               </element>

QueryIoInsightInstances(queryIoInsightInstances)

Retrieve all ioinsight instances VsanIoInsightInstance according to the passed in parameters.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the VsanIoInsightManager used to make the method call.

querySpec

VsanIoInsightInstanceQuerySpec

Describe specifications for the query operation.

Since vSAN API 7.2

cluster* P

ManagedObjectReference
to a ClusterComputeResource

The target cluster where the ioinsight instances belong to. This parameter is ignored while the API is called against host.

Since vSAN API 7.2

*Need not be set P Required privilege: Global.Diagnostics

Return Value

Type	Description
VsanIoInsightInstance[]

Faults

Type	Description
InvalidArgument	Thrown if any argument passed to the function is not specified correctly.
NotFound	Thrown if the stats primary node is not found in target cluster.
NotSupported	Thrown if the API is not supported by the called host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Thrown if any other unexpected fault is encountered.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryIoInsightInstances" type="vsan:QueryIoInsightInstancesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="QueryIoInsightInstancesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:VsanIoInsightInstance" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

RenameIoInsightInstance(renameIoInsightInstance)

Rename an ioinsight instance which is completed already (see VsanIoInsightInstanceState).

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIoInsightManager used to make the method call.
oldRunName	xsd:string	The current run name of an completed ioinsight instance. *Since* vSAN API 7.2
newRunName	xsd:string	New run name for the completed ioinsight instance. *Since* vSAN API 7.2
cluster* P	ManagedObjectReference to a ClusterComputeResource	The target cluster where the ioinsight instance belongs to. This parameter is ignored while the API is called against host. *Since* vSAN API 7.2

*Need not be set P Required privilege: Global.Diagnostics

Return Value

Type	Description
None

Faults

Type	Description
InvalidArgument	Thrown if any argument passed to the function is not specified correctly.
NotFound	Thrown if the specified ioinsight instance is not found.
NotSupported	Thrown if the API is not supported by the called host.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Thrown if any other unexpected fault is encountered.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RenameIoInsightInstance" type="vsan:RenameIoInsightInstanceRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="RenameIoInsightInstanceResponse">
                  <complexType/>
               </element>

StartIoInsight(startIoInsight)

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.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIoInsightManager used to make the method call.
cluster* P	ManagedObjectReference to a ClusterComputeResource	The cluster to which the ESXi host(s) belong. This parameter is ignored while the API is called against host. *Since* vSAN API 7.2
runName*	xsd:string	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. *Since* vSAN API 7.2
durationSec*	xsd:long	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. *Since* vSAN API 7.2
targetHosts*	ManagedObjectReference[] to a HostSystem[]	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. *Since* vSAN API 7.2
targetVMs*	ManagedObjectReference[] to a VirtualMachine[]	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. *Since* vSAN API 7.2

*Need not be set P Required privilege: Global.Diagnostics

Return Value

Type	Description
ManagedObjectReference to a Task	Task which is performing actually ioinsight start operation in the background.

Faults

Type	Description
InvalidArgument	Thrown if any argument passed to the API is not specified correctly.
NotFound	Thrown 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.
NotSupported
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Thrown if any other unexpected failure happened during starting ioinsight.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="StartIoInsight" type="vsan:StartIoInsightRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="StartIoInsightResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

StopIoInsight(stopIoInsight)

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: vim.cluster.VsanPerformanceManager#QueryVsanPerf. 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.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the VsanIoInsightManager used to make the method call.
cluster* P	ManagedObjectReference to a ClusterComputeResource	The cluster to which the target ESXi host(s) belong. This parameter is ignored while the API is called against host. *Since* vSAN API 7.2
runName*	xsd:string	The name of running ioinsight to be stopped. This parameter can be ingnored while being called against host. *Since* vSAN API 7.2
hostsIoInsightInfos*	VsanHostIoInsightInfo[]	One or multiple host ioinsight(s) information, which indicate the target ioinsight(s) to be stopped or the VMs to be unmonitored. If 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 host should be exactly same as the target host. *Since* vSAN API 7.2

*Need not be set P Required privilege: Global.Diagnostics

Return Value

Type	Description
ManagedObjectReference to a Task	Task which is performing actually ioinsight stop operation in the background on each host.

Faults

Type	Description
InvalidArgument	Thrown if any argument passed to the function is not specified correctly.
NotFound	Thrown if no ESXi host could be contacted to perform the operation when this method is called against vCenter.
NotSupported
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
VsanFault	Thrown if the caller doesn't have the required privilege, or the cluster has no hosts.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="StopIoInsight" type="vsan:StopIoInsightRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vsan="urn:vsan" name="StopIoInsightResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vsan:ManagedObjectReference"/>
                     </sequence>
                  </complexType>
               </element>

vSAN Management API

Managed Object - VsanIoInsightManager(vim.cluster.VsanIoInsightManager)

Managed Object Description

DeleteIoInsightInstance(deleteIoInsightInstance)

QueryIoInsightInstances(queryIoInsightInstances)

RenameIoInsightInstance(renameIoInsightInstance)

StartIoInsight(startIoInsight)

StopIoInsight(stopIoInsight)