Host Patch Manager Install Host Patch V2 Task

Patch the host.

The operation is not cancelable. If the patch installation failed, an atomic rollback of the installation will be attempted. Manual rollback is required if the atomic rollback failed, see PatchInstallFailed for details.

Required privileges: Host.Config.Patch

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/HostPatchManager/{moId}/InstallHostPatchV2_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 HostPatchManager/{moId}.

string

release

Required

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

Request Body

InstallHostPatchV2RequestType of type(s) application/json

Required

{
    "metaUrls": [
        "string"
    ],
    "bundleUrls": [
        "string"
    ],
    "vibUrls": [
        "string"
    ],
    "spec": {
        "_typeName": "string",
        "proxy": "string",
        "port": 0,
        "userName": "string",
        "password": "string",
        "cmdOption": "string"
    }
}

array of string

metaUrls

Optional

A list of urls pointing to metadata.zip.

array of string

bundleUrls

Optional

a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later.

array of string

vibUrls

Optional

The urls of update binary files to be installed.

HostPatchManagerPatchManagerOperationSpec

spec

Optional

Optional parameters for hostd to pass to exupdate.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

This method returns a Task object with which to monitor the operation.

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

RequestCanceled: if the operation is canceled.

InvalidState: if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.

TaskInProgress: if there is already a patch installation in progress.

PlatformConfigFault: if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.

Returns MethodFault of type(s) application/json

This response body class contains all of the following: Any

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

MethodFault

faultCause

Optional

The base data object type for all the object model faults that an application might handle.

array of LocalizableMessage

faultMessage

Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.

On This Page

Description

Request

Path Parameters