Managed Object - IoFilterManager(vim.IoFilterManager)

Property of: ServiceContent
See also: ClusterComputeResource, ClusterIoFilterInfo, ComputeResource, HostSystem, IoFilterQueryIssueResult, VirtualDiskId
Since: vSphere API 6.0

Managed Object Description

Interface to manage IO Filters installed on the ESXi hosts and IO Filter configurations on virtual disks. IO Filters are customized filters provided by third parties to process I/Os to virtual disks. They can be used to provide data services such as flash caching and replication. This interface is only supported on vCenter server.

Properties

Name	Type	Description
None

Methods

Methods defined in this Managed Object
InstallIoFilter_Task, QueryDisksUsingFilter, QueryIoFilterInfo, QueryIoFilterIssues, ResolveInstallationErrorsOnCluster_Task, ResolveInstallationErrorsOnHost_Task, UninstallIoFilter_Task, UpgradeIoFilter_Task

InstallIoFilter_Task(installIoFilter)

Install an IO Filter on a compute resource. IO Filters can only be installed on a cluster.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

vibUrl P

xsd:string

The URL that points to the IO Filter VIB package.

Since vSphere API 6.0

compRes P

ManagedObjectReference
to a ComputeResource

The compute resource to install the IO Filter on. "compRes" must be a cluster.

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The task is set to success if the filter is installed on all the hosts in the compute resource successfully. If the task fails, first check error to see the error. If the error indicates that installation has failed on the hosts, use QueryIoFilterIssues to get the detailed errors occurred during installation on each host. The dynamic privilege check ensures that the user must have Host.Config.Patch privilege for all the hosts in the compute resource.

Type

Description

ManagedObjectReference
to a Task

This method returns a Task object with which to monitor the operation. The task is set to success if the filter is installed on all the hosts in the compute resource successfully. If the task fails, first check error to see the error. If the error indicates that installation has failed on the hosts, use QueryIoFilterIssues to get the detailed errors occurred during installation on each host.

The dynamic privilege check ensures that the user must have Host.Config.Patch privilege for all the hosts in the compute resource.

Faults

Type	Description
AlreadyExists	Thrown if another VIB with the same name and vendor has been installed.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

QueryDisksUsingFilter(queryDisksUsingFilter)

Return the list of virtual disks that use an IO Filter installed on a compute resource.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

filterId P

xsd:string

ID of the filter.

Since vSphere API 6.0

compRes P

ManagedObjectReference
to a ComputeResource

The compute resource that the filter has been installed on. "compRes" must be a cluster.

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
VirtualDiskId[]	An array of VirtualDiskId objects that use the given IO Filter installed on the compute resource.

Faults

Type	Description
NotFound	Thrown if the filter specified by "filterId" is not installed on the cluster.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryDisksUsingFilter" type="vim25:QueryDisksUsingFilterRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryDisksUsingFilterResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:VirtualDiskId" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryIoFilterInfo(queryIoFilterInfo)

Return the information for the IO Filters that are installed on the cluster.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

compRes P

ManagedObjectReference
to a ComputeResource

The compute resource. "compRes" must be a cluster.

Since vSphere API 6.0

P Required privilege: compRes

Return Value

Type	Description
ClusterIoFilterInfo[]	An array of ClusterIoFilterInfo objects that contain the information for the IO Filters that are installed on the compute resource.

Faults

Type	Description
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryIoFilterInfo" type="vim25:QueryIoFilterInfoRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryIoFilterInfoResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:ClusterIoFilterInfo" minOccurs="0" maxOccurs="unbounded"/>
                     </sequence>
                  </complexType>
               </element>

QueryIoFilterIssues(queryIssue)

Return the issues that occurred during the last installation/uninstallation/upgrade operation of an IO Filter on a compute resource.

Required Privileges: System.View

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

filterId P

xsd:string

The filter.

Since vSphere API 6.0

compRes P

ManagedObjectReference
to a ComputeResource

The compute resource. "compRes" must be a cluster.

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
IoFilterQueryIssueResult	A IoFilterQueryIssueResult object.

Faults

Type	Description
NotFound	Thrown if the filter specified by "filterId" is not installed on the cluster.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

Show WSDL type definition

         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryIoFilterIssues" type="vim25:QueryIoFilterIssuesRequestType"/>
         <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vim25="urn:vim25" name="QueryIoFilterIssuesResponse">
                  <complexType>
                     <sequence>
                        <element name="returnval" type="vim25:IoFilterQueryIssueResult"/>
                     </sequence>
                  </complexType>
               </element>

ResolveInstallationErrorsOnCluster_Task(resolveInstallationErrorsOnCluster)

Resolve the errors occurred during an installation/uninstallation/upgrade operation of an IO Filter on a cluster.

Depending on the nature of the installation failure, vCenter will take the appropriate actions to resolve it. For example, retry or resume installation.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

filterId P

xsd:string

ID of the filter.

Since vSphere API 6.0

cluster P

ManagedObjectReference
to a ClusterComputeResource

The cluster.

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The task is set to success if all the errors related to the filter are resolved on the cluster. If the task fails, first check error to see the error. If the error indicates that issues persist on the cluster, use QueryIoFilterIssues to get the detailed errors on the hosts in the cluster. The dynamic privilege check will ensure that the appropriate privileges must be acquired for all the hosts in the cluster based on the remediation actions. For example, Host.Config.Maintenance privilege and Host.Config.Patch privileges must be required for upgrading a VIB.

Type

Description

ManagedObjectReference
to a Task

This method returns a Task object with which to monitor the operation. The task is set to success if all the errors related to the filter are resolved on the cluster. If the task fails, first check error to see the error. If the error indicates that issues persist on the cluster, use QueryIoFilterIssues to get the detailed errors on the hosts in the cluster.

The dynamic privilege check will ensure that the appropriate privileges must be acquired for all the hosts in the cluster based on the remediation actions. For example, Host.Config.Maintenance privilege and Host.Config.Patch privileges must be required for upgrading a VIB.

Faults

Type	Description
NotFound	Thrown if the filter specified by "filterId" is not installed on the cluster.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

ResolveInstallationErrorsOnHost_Task(resolveInstallationErrorsOnHost)

Resolve the errors occurred during an installation/uninstallation/upgrade operation of an IO Filter on a host.

Depending on the nature of the installation failure, vCenter will take the appropriate actions to resolve it. For example, retry or resume installation.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

filterId P

xsd:string

ID of the filter.

Since vSphere API 6.0

host P

ManagedObjectReference
to a HostSystem

The host.

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The task is set to success if all the errors related to the filter are resolved on the host. If the task fails, first check error to see the error. If the error indicates that issues persist on the host, use QueryIoFilterIssues to get the detailed errors on the host. The dynamic privilege check will ensure that the appropriate privileges are acquired based on the remediation actions. For example, Host.Config.Maintenance and Host.Config.Patch privilege must required for upgrading a VIB.

Type

Description

ManagedObjectReference
to a Task

This method returns a Task object with which to monitor the operation. The task is set to success if all the errors related to the filter are resolved on the host. If the task fails, first check error to see the error. If the error indicates that issues persist on the host, use QueryIoFilterIssues to get the detailed errors on the host.

The dynamic privilege check will ensure that the appropriate privileges are acquired based on the remediation actions. For example, Host.Config.Maintenance and Host.Config.Patch privilege must required for upgrading a VIB.

Faults

Type	Description
NotFound	Thrown if the filter specified by "filterId" is not installed on the cluster.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

UninstallIoFilter_Task(uninstallIoFilter)

Uninstall an IO Filter from a compute resource.

Required Privileges: None

Parameters

Name

Type

Description

_this

ManagedObjectReference

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

filterId P

xsd:string

ID of the filter.

Since vSphere API 6.0

compRes P

ManagedObjectReference
to a ComputeResource

The compute resource to uninstall the IO Filter from. "compRes" must be a cluster.

Since vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The task is set to success if the filter is uninstalled from all the hosts in the compute resource successfully. If the task fails, first check error to see the error. If the error indicates that uninstallation has failed on the hosts, use QueryIoFilterIssues to get the detailed errors occurred during uninstallation on each host. The dynamic privilege check ensures that the user must have Host.Config.Maintenance and Host.Config.Patch privilege for all the hosts in the compute resource.

Type

Description

ManagedObjectReference
to a Task

This method returns a Task object with which to monitor the operation. The task is set to success if the filter is uninstalled from all the hosts in the compute resource successfully. If the task fails, first check error to see the error. If the error indicates that uninstallation has failed on the hosts, use QueryIoFilterIssues to get the detailed errors occurred during uninstallation on each host.

The dynamic privilege check ensures that the user must have Host.Config.Maintenance and Host.Config.Patch privilege for all the hosts in the compute resource.

Faults

Type	Description
FilterInUse	Thrown if the filter to be uninstalled is being used by a virtual disk.
InvalidState	Thrown if "compRes" is a cluster and DRS is disabled on the cluster.
NotFound	Thrown if the filter is not installed on the cluster.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None

UpgradeIoFilter_Task(upgradeIoFilter)

Upgrade an IO Filter on a compute resource.

Required Privileges: None

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the IoFilterManager used to make the method call.
filterId P	xsd:string	The filter to be upgraded. *Since* vSphere API 6.0
compRes P	ManagedObjectReference to a ComputeResource	The compute resource that the filter is installed on. "compRes" must be a cluster. *Since* vSphere API 6.0
vibUrl P	xsd:string	The URL that points to the new IO Filter VIB package. *Since* vSphere API 6.0

PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The task is set to success if all the hosts in the compute resource are upgraded successfully. If the task fails, first check error to see the error. If the error indicates that upgrade has failed on the hosts, use QueryIoFilterIssues to get the detailed errors occurred during upgrade on each host. The dynamic privilege check ensures that the user must have Host.Config.Maintenance and Host.Config.Patch privileges for all the hosts in the compute resource.

Type

Description

ManagedObjectReference
to a Task

This method returns a Task object with which to monitor the operation. The task is set to success if all the hosts in the compute resource are upgraded successfully. If the task fails, first check error to see the error. If the error indicates that upgrade has failed on the hosts, use QueryIoFilterIssues to get the detailed errors occurred during upgrade on each host.

The dynamic privilege check ensures that the user must have Host.Config.Maintenance and Host.Config.Patch privileges for all the hosts in the compute resource.

Faults

Type	Description
InvalidState	Thrown if "compRes" is a cluster and DRS is disabled on the cluster.
NotFound	Thrown if the filter specified by "filterId" is not installed on the cluster.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Events

Type
None