Managed Object - HostPatchManager

Property of
HostConfigManager
See also
HostPatchManagerLocator, HostPatchManagerStatus
Since
VI API 2.5


Managed Object Description

This managed object is the interface for scanning and patching an ESX server. VMware publishes updates through its external website. A patch update is synonymous with a bulletin. An update may contain many individual patch binaries, but its installation and uninstallation are atomic.

Properties

Name Type Description
None

Methods

Methods defined in this Managed Object
InstallHostPatch_Task, ScanHostPatch_Task

InstallHostPatch_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

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
repositoryHostPatchManagerLocator

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.
updateIDxsd:string

The update to be installed on the host.
force*xsd:boolean

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 forcifully reinstalled, thus overwriting the already installed update.
*Need not be set

Return Value

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

Faults

Type Description
InvalidStateThrown if the host is not in maintenance mode but the patch install requires all virtual machines to be powered off.
NoDiskSpaceThrown if the update can not be installed because there is insufficent disk space for the installation, including temporary space used for rollback.
PatchBinariesNotFoundThrown if required update related binaries were not available.
PatchInstallFailedThrown if the installation failed, text has details of the failure. Automatic rollback might have succeeded or failed.
PatchMetadataInvalidThrown if the requried 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.
PatchNotApplicableThrown 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.
RebootRequiredThrown 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.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgressThrown if there is already a patch installation in progress

Show WSDL type definition



ScanHostPatch_Task

Scan the host for the patch status. The operation is cancelable through the returned Task object. Integrity checks are performed on the metadata only during the scan operation.
Required Privileges
System.Read

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
repositoryHostPatchManagerLocator

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 the full update metadata.
updateID*xsd:string[]

The updates to scan. Wildcards can be used to specify the update IDs. The wildcards will be expanded to include all updates whose IDs match the specified wildcard and whose metadata is available in the repository. Specifying no update is equivalent to a wildcard "*". In this case all updates available in the repository will be scanned.
*Need not be set

Return Value

Type Description
ManagedObjectReference
to a Task
This method returns a Task object with which to monitor the operation. The info.result property in the Task contains the vim.host.PatchManager.PatchStatus upon success.

Faults

Type Description
PatchMetadataInvalidThrown if query 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.
PlatformConfigFaultThrown if there is any error in the repository access, metadata download, repository level integrity check, or reading the metadata. See text for specific details.
RequestCanceledThrown if the operation is canceled.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition