Io Filter Manager Uninstall Io Filter Task

Io Filter Manager Uninstall Io Filter Task

Uninstall an IO Filter from a compute resource.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/IoFilterManager/{moId}/UninstallIoFilter_Task
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case IoFilterManager/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Request Body
UninstallIoFilterRequestType of type(s) application/json
Required
{
    "filterId": "string",
    "compRes": {
        "type": "string",
        "value": "string"
    }
}
string
filterId
Required

ID of the filter.

compRes
Required

Reference to an instance of the ComputeResource managed object.

Authentication
This operation uses the following authentication methods.
Responses
200

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.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

InvalidArgument: if "compRes" is a standalone host.

NotFound: if the filter is not installed on the cluster.

FilterInUse: if the filter to be uninstalled is being used by a virtual disk.

InvalidState: if "compRes" is a cluster and DRS is disabled on the cluster.

Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}