Io Filter Manager Upgrade Io Filter Task

Io Filter Manager Upgrade Io Filter Task

Upgrade an IO Filter on a compute resource.

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/IoFilterManager/{moId}/UpgradeIoFilter_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
UpgradeIoFilterRequestType of type(s) application/json
Required 
{
    "filterId": "string",
    "compRes": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "vibUrl": "string"
}
string
filterId
Required

The filter to be upgraded.

MoRefComputeResource
compRes
Required

Reference to an instance of the ComputeResource managed object.

string
vibUrl
Required

The URL that points to the new IO Filter VIB package.

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

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; or if the VIB package pointed by "vibUrl" is not an upgrade of the IO Filter specified by "filterId".

NotFound: if the filter specified by "filterId" is not installed on the cluster.

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"
        }
    ]
}

On This Page
Io Filter Manager Operations
POST
Io Filter Manager Install Io Filter Task
POST
Io Filter Manager Query Disks Using Filter
POST
Io Filter Manager Query Io Filter Info
POST
Io Filter Manager Query Io Filter Issues
POST
Io Filter Manager Resolve Installation Errors On Cluster Task
POST
Io Filter Manager Resolve Installation Errors On Host Task
POST
Io Filter Manager Uninstall Io Filter Task
POST
Io Filter Manager Upgrade Io Filter Task