Io Filter Manager Install Io Filter Task

Install an IO Filter on a compute resource.

IO Filters can only be installed on a cluster.

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/IoFilterManager/{moId}/InstallIoFilter_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

InstallIoFilterRequestType of type(s) application/json

Required

{
    "vibUrl": "string",
    "compRes": {
        "type": "string",
        "value": "string"
    }
}

string

vibUrl

Required

The URL that points to the IO Filter VIB package.

MoRefComputeResource

compRes

Required

Reference to an instance of the ComputeResource managed object.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

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.

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.

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

Returns AlreadyExists of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ],
    "name": "string"
}

string

name

Optional

name

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body