Host Patch Manager Install Host Patch Task

Host Patch Manager Install Host Patch Task

Deprecated method is deprecated, use InstallHostPatchV2_Task instead.

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}/InstallHostPatch_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
InstallHostPatchRequestType of type(s) application/json
Required
{
    "repository": {
        "url": "string",
        "proxy": "string"
    },
    "updateID": "string",
    "force": false
}
repository
Required

Location of the repository that contains the bulletin depot. The depot must be organized as a flat collection of bulletins with each one being a folder named after the bulletin ID. Each folder must contain both update metadata and required binaries.

string
updateID
Required

The update to be installed on the host.

boolean
force
Optional

Specify whether to force reinstall an update. By default, installing an already-installed update would fail with the PatchAlreadyInstalled fault. If force is set to true, the update will be forcefully reinstalled, thus overwriting the already installed update.

Authentication
This operation uses the following authentication methods.
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

PatchMetadataInvalid: if the required metadata is invalid - for example, it is not found in the repository, is corrupted and so on. Typically a more specific subclass of PatchMetadataInvalid is thrown.

PatchBinariesNotFound: if required update related binaries were not available.

PatchNotApplicable: if the patch is not applicable. Typically a more specific subclass of PatchNotApplicable is thrown to indicate a specific problem - for example, PatchSuperseded if the patch is superseded, MissingDependency if required patch or libraries are not installed, AlreadyInstalled if the patch is already installed.

NoDiskSpace: if the update can not be installed because there is insufficient disk space for the installation, including temporary space used for rollback.

PatchInstallFailed: if the installation failed, text has details of the failure. Automatic rollback might have succeeded or failed.

RebootRequired: if the update cannot be installed without restarting the host. This might occur on account of a prior update installation which needed to be installed separately from other updates.

InvalidState: if the host is not in maintenance mode but the patch install requires all virtual machines to be powered off.

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

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