Scripting Object - VcIoFilterManager

Scripting-object corresponding to
IoFilterManager
Attribute of
VcServiceContent

Scripting 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.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, createTrigger, installIoFilter_Task, queryDisksUsingFilter, queryIoFilterInfo, queryIoFilterIssues, resolveInstallationErrorsOnCluster_Task, resolveInstallationErrorsOnHost_Task, uninstallIoFilter_Task, updateIoFilterPolicy, upgradeIoFilter_Task

installIoFilter_Task

Install an IO Filter on a compute resource. IO Filters can only be installed on a cluster. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcComputeResource


Return Value

Type Description
VcTask

resolveInstallationErrorsOnCluster_Task

Resolve the errors occured 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.

@since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcClusterComputeResource


Return Value

Type Description
VcTask

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

upgradeIoFilter_Task

Upgrade an IO Filter on a compute resource. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcComputeResource

arg2String


Return Value

Type Description
VcTask

updateIoFilterPolicy

Update the policy ID to IO Filter list mapping in vCenter server. This is an internal API that SPBM calls vCenter when an IO Filter related policy changes. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcSpbmIoFilterInfo []


Return Value

Type Description
None

queryIoFilterInfo

Return the information for the IO Filters that are installed on the cluster. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcComputeResource


Return Value

Type Description
VcClusterIoFilterInfo []

queryIoFilterIssues

Return the issues that occured during the last installation/uninstallation/upgrade operation of an IO Filter on a compute resource. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcComputeResource


Return Value

Type Description
VcIoFilterQueryIssueResult

queryDisksUsingFilter

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

@since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcComputeResource


Return Value

Type Description
VcVirtualDiskId []

uninstallIoFilter_Task

Uninstall an IO Filter from a compute resource.

@since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcComputeResource


Return Value

Type Description
VcTask

resolveInstallationErrorsOnHost_Task

Resolve the errors occured 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.

@since vSphere API 6.0

Parameters

NameTypeDescription
arg0String

arg1VcHostSystem


Return Value

Type Description
VcTask