Package com.vmware.vim25.mo

Class IoFilterManager

java.lang.Object

com.vmware.vim25.mo.ManagedObject

com.vmware.vim25.mo.IoFilterManager

public class IoFilterManager
extends ManagedObject

Constructor Summary

Constructors

Constructor	Description
IoFilterManager(ServerConnection serverConnection, ManagedObjectReference mor)

Method Summary

Modifier and Type	Method	Description
Task	initiateTransitionToVLCM_Task(ClusterComputeResource cluster)
Task	installIoFilter_Task(String vibUrl, ComputeResource compRes)	Install an IO Filter on a compute resource.
VirtualDiskId[]	queryDisksUsingFilter(String filterId, ComputeResource compRes)	Queries and return the list of virtual disks that use an IO Filter installed on a compute resource.
ClusterIoFilterInfo[]	queryIoFilterInfo(ComputeResource compRes)	Queries and return the information for the IO Filters that are installed on the cluster.
IoFilterQueryIssueResult	queryIoFilterIssues(String filterId, ComputeResource compRes)	Return the issues that occured during the last installation/uninstallation/upgrade operation of an IO Filter on a compute resource
Task	resolveInstallationErrorsOnCluster_Task(String filterId, ClusterComputeResource cluster)	Resolve the errors occured during an installation/uninstallation/upgrade operation of an IO Filter on a cluster.
Task	resolveInstallationErrorsOnHost_Task(String filterId, HostSystem host)	Resolve the errors occured during an installation/uninstallation/upgrade operation of an IO Filter on a host.
Task	unInstallIoFilter_Task(String filterId, ComputeResource cluster)	Uninstall an IO Filter on a compute resource.
Task	upgradeIoFilter_Task(String filterId, ComputeResource cluster, String vibUrl)	Upgrade an IO Filter on a compute resource.

Methods inherited from class com.vmware.vim25.mo.ManagedObject

convertMors, getCurrentProperty, getDatastores, getFilter, getHosts, getManagedObject, getManagedObjects, getManagedObjects, getMOR, getNetworks, getPropertiesByPaths, getPropertyByPath, getResourcePools, getScheduledTasks, getServerConnection, getTasks, getViews, getVimService, getVms, retrieveObjectProperties, setCachedProperty, setMOR, setServerConnection, toString, waitForValues

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

IoFilterManager

public IoFilterManager(ServerConnection serverConnection,
 ManagedObjectReference mor)

Method Details

initiateTransitionToVLCM_Task

public Task initiateTransitionToVLCM_Task(ClusterComputeResource cluster)
                                   throws InvalidArgument,
RuntimeFault,
RemoteException

Throws:

InvalidArgument

RuntimeFault

RemoteException

installIoFilter_Task

public Task installIoFilter_Task(String vibUrl,
 ComputeResource compRes)
                          throws AlreadyExists,
InvalidArgument,
RuntimeFault,
RemoteException

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

Parameters:

vibUrl - - The URL that points to the IO Filter VIB package.

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

Returns:

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

Throws:

AlreadyExists - - Thrown if another VIB with the same name and vendor has been installed.

InvalidArgument - - Thrown if "compRes" is a standalone host.

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

RemoteException

queryDisksUsingFilter

public VirtualDiskId[] queryDisksUsingFilter(String filterId,
 ComputeResource compRes)
                                      throws RemoteException,
RuntimeFault

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

Parameters:

filterId - - ID of the filter.

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

Returns:

VirtualDiskId[] - An array of VirtualDiskId objects that use the given IO Filter installed on the compute resource Filters that are installed on the compute resource.

Throws:

RemoteException

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

queryIoFilterInfo

public ClusterIoFilterInfo[] queryIoFilterInfo(ComputeResource compRes)
                                        throws RemoteException,
RuntimeFault

Queries and return the information for the IO Filters that are installed on the cluster.

Parameters:

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

Returns:

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

Throws:

RemoteException

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

queryIoFilterIssues

public IoFilterQueryIssueResult queryIoFilterIssues(String filterId,
 ComputeResource compRes)
                                             throws RemoteException,
RuntimeFault

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

Parameters:

filterId - - ID of the filter.

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

Returns:

IoFilterQueryIssueResult - Result for QueryIoFilterIssues. Filters that are installed on the compute resource.

Throws:

RemoteException

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

resolveInstallationErrorsOnCluster_Task

public Task resolveInstallationErrorsOnCluster_Task(String filterId,
 ClusterComputeResource cluster)
                                             throws NotFound,
RuntimeFault,
RemoteException

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.

Parameters:

filterId - - ID of the filter.

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

Returns:

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

Throws:

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

NotFound

RemoteException

resolveInstallationErrorsOnHost_Task

public Task resolveInstallationErrorsOnHost_Task(String filterId,
 HostSystem host)
                                          throws NotFound,
RuntimeFault,
RemoteException

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.

Parameters:

filterId - - ID of the filter.

host - - The host to fix the issues on.

Returns:

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

Throws:

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

NotFound

RemoteException

unInstallIoFilter_Task

public Task unInstallIoFilter_Task(String filterId,
 ComputeResource cluster)
                            throws FilterInUse,
InvalidArgument,
InvalidState,
NotFound,
RuntimeFault,
RemoteException

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

Parameters:

filterId - - ID of the filter.

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

Returns:

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

Throws:

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. - Thrown if another VIB with the same name and vendor has been installed.

InvalidArgument - - Thrown if "compRes" is a standalone host.

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

RemoteException

upgradeIoFilter_Task

public Task upgradeIoFilter_Task(String filterId,
 ComputeResource cluster,
 String vibUrl)
                          throws InvalidArgument,
InvalidState,
NotFound,
RuntimeFault,
RemoteException

Upgrade an IO Filter on a compute resource.

Parameters:

filterId - - ID of the filter.

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

vibUrl - - The URL that points to the IO Filter VIB package.

Returns:

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

Throws:

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. - Thrown if another VIB with the same name and vendor has been installed.

InvalidArgument - - Thrown if "compRes" is a standalone host.

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

RemoteException