| Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
None |
Methods
Methods defined in this Managed Object |
---|
DeleteIoInsightInstance, QueryIoInsightInstances, RenameIoInsightInstance, StartIoInsight, StopIoInsight |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanIoInsightManager used to make the method call. |
runName P | 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 |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanIoInsightManager used to make the method call. |
querySpec P | 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 |
Return Value
Type | Description |
---|---|
VsanIoInsightInstance[] |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if any argument passed to the function is not specified correctly. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the VsanIoInsightManager used to make the method call. |
oldRunName P | xsd:string |
The current run name of an completed ioinsight instance.
Since vSAN API 7.2 |
newRunName P | 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 |
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 |
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* P | 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* P | 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* P | 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* P | 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 |
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 |
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* P | 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* P | 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 |
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 |
Top of page | Local Methods | ||
Managed Object Types | Data Object Types | All Properties | All Methods |