Managed Object - HostPatchManager(vim.host.PatchManager)

Property of: HostConfigManager
See also: HostPatchManagerLocator, HostPatchManagerPatchManagerOperationSpec, HostPatchManagerResult, 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
CheckHostPatch_Task, InstallHostPatch_Task, InstallHostPatchV2_Task, QueryHostPatch_Task, ScanHostPatch_Task, ScanHostPatchV2_Task, StageHostPatch_Task, UninstallHostPatch_Task

CheckHostPatch_Task(Check)

Check the list of metadata and returns the dependency, obsolete and conflict information The operation is cancelable through the returned Task object. No integrity checks are performed on the metadata.

Required Privileges: System.Read
Since: vSphere API 4.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostPatchManager used to make the method call.
metaUrls* P	xsd:string[]	a list of urls pointing to metadata.zip. *Since* vSphere API 4.0
bundleUrls* P	xsd:string[]	a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later. *Since* vSphere API 4.0
spec* P	HostPatchManagerPatchManagerOperationSpec	*Since* vSphere API 4.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The result property in the Task contains the HostPatchManagerStatus upon success.

Faults

Type	Description
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
PlatformConfigFault	Thrown if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.
RequestCanceled	Thrown if the operation is canceled.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is already a patch installation in progress.

Events

Type
None

InstallHostPatch_Task(Install)

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

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostPatchManager used to make the method call.
repository P	HostPatchManagerLocator	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. *Since* 2.0
updateID P	xsd:string	The update to be installed on the host. *Since* 2.0
force* P	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 forcefully reinstalled, thus overwriting the already installed update. *Since* 2.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
InvalidState	Thrown if the host is not in maintenance mode but the patch install requires all virtual machines to be powered off.
NoDiskSpace	Thrown if the update can not be installed because there is insufficient disk space for the installation, including temporary space used for rollback.
PatchBinariesNotFound	Thrown if required update related binaries were not available.
PatchInstallFailed	Thrown if the installation failed, text has details of the failure. Automatic rollback might have succeeded or failed.
PatchMetadataInvalid	Thrown 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.
PatchNotApplicable	Thrown 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.
RebootRequired	Thrown 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.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is already a patch installation in progress.

Events

Type
None

InstallHostPatchV2_Task(InstallV2)

Required Privileges: Host.Config.Patch
Since: vSphere API 4.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostPatchManager used to make the method call.
metaUrls* P	xsd:string[]	A list of urls pointing to metadata.zip. *Since* vSphere API 4.0
bundleUrls* P	xsd:string[]	a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later. *Since* vSphere API 4.0
vibUrls* P	xsd:string[]	The urls of update binary files to be installed. *Since* vSphere API 4.0
spec* P	HostPatchManagerPatchManagerOperationSpec	*Since* vSphere API 4.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
PlatformConfigFault	Thrown if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.
RequestCanceled	Thrown if the operation is canceled.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is already a patch installation in progress.

Events

Type
None

QueryHostPatch_Task(Query)

Query the host for installed bulletins.

Required Privileges: System.Read
Since: vSphere API 4.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostPatchManager used to make the method call.

spec* P

HostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0

*Need not be set P Required privilege: spec

Return Value

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

Faults

Type	Description
InvalidState	Thrown if the bulletin ID did not exist.
PlatformConfigFault	Thrown if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.
RequestCanceled	Thrown if the operation is canceled.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is already a patch installation in progress.

Events

Type
None

ScanHostPatch_Task(Scan)

Deprecated. As of VI API 4.0, use ScanHostPatchV2_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

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostPatchManager used to make the method call.

repository P

HostPatchManagerLocator

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.

Since 2.0

updateID* P

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.

Since 2.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The result property in the Task contains the HostPatchManagerStatus upon success.

Faults

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

Events

Type
None

ScanHostPatchV2_Task(ScanV2)

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
Since: vSphere API 4.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostPatchManager used to make the method call.
metaUrls* P	xsd:string[]	a list of urls pointing to metadata.zip. *Since* vSphere API 4.0
bundleUrls* P	xsd:string[]	a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later. *Since* vSphere API 4.0
spec* P	HostPatchManagerPatchManagerOperationSpec	*Since* vSphere API 4.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The result property in the Task contains the HostPatchManagerStatus upon success.

Faults

Type	Description
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
PlatformConfigFault	Thrown if there is any error in the repository access, metadata download, repository level integrity check, or reading the metadata. See text for specific details.
RequestCanceled	Thrown if the operation is canceled.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is already a patch installation in progress.

Events

Type
None

StageHostPatch_Task(Stage)

Stage the vib files to esx local location and possibly do some run time check.

Required Privileges: Host.Config.Patch
Since: vSphere API 4.0

Parameters

Name	Type	Description
_this	ManagedObjectReference	A reference to the HostPatchManager used to make the method call.
metaUrls* P	xsd:string[]	A list of urls pointing to metadata.zip. *Since* vSphere API 4.0
bundleUrls* P	xsd:string[]	a list of urls pointing to an "offline" bundle. It is not supported in 5.0 or later. *Since* vSphere API 4.0
vibUrls* P	xsd:string[]	The urls of update binary files to be staged. *Since* vSphere API 4.0
spec* P	HostPatchManagerPatchManagerOperationSpec	*Since* vSphere API 4.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

Type	Description
ManagedObjectReference to a Task	This method returns a Task object with which to monitor the operation. The result property in the Task contains the HostPatchManagerStatus upon success.

Faults

Type	Description
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
PlatformConfigFault	Thrown if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.
RequestCanceled	Thrown if the operation is canceled.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is already a patch installation in progress.

Events

Type
None

UninstallHostPatch_Task(Uninstall)

Uninstall patch from the host. The operation is not cancelable.

Required Privileges: Host.Config.Patch
Since: vSphere API 4.0

Parameters

Name

Type

Description

_this

ManagedObjectReference

A reference to the HostPatchManager used to make the method call.

bulletinIds* P

xsd:string[]

A list of bulletin IDs to be removed.

Since vSphere API 4.0

spec* P

HostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0

*Need not be set PRequired privilege - see tooltip for details

Return Value

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

Faults

Type	Description
InvalidState	Thrown if the feature cannot be supported on the platform, potentially because the hardware configuration does not support it.
PlatformConfigFault	Thrown if any error occurs during the operation. More detailed information will be returned within the payload of the exception as xml string.
RuntimeFault	Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress	Thrown if there is already a patch installation in progress.

Events

Type
None