Managed Object - HostPatchManager

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


Managed Object Description

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

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
metaUrls* Pxsd:string[]

Since vSphere API 4.0
bundleUrls* Pxsd:string[]

Since vSphere API 4.0
spec* PHostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
PlatformConfigFault
RequestCanceled
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



InstallHostPatch_Task

Deprecated.

Required Privileges
Host.Config.Patch

Parameters

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

Since null
updateID Pxsd:string

Since null
force* Pxsd:boolean

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
NoDiskSpace
PatchBinariesNotFound
PatchInstallFailed
PatchMetadataInvalid
PatchNotApplicable
RebootRequired
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



InstallHostPatchV2_Task

Required Privileges
Host.Config.Patch
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
metaUrls* Pxsd:string[]

Since vSphere API 4.0
bundleUrls* Pxsd:string[]

Since vSphere API 4.0
vibUrls* Pxsd:string[]

Since vSphere API 4.0
spec* PHostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
PlatformConfigFault
RequestCanceled
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



QueryHostPatch_Task

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
spec* PHostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0
*Need not be set P Required privilege: spec

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
PlatformConfigFault
RequestCanceled
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



ScanHostPatch_Task

Deprecated.

Required Privileges
System.Read

Parameters

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

Since null
updateID* Pxsd:string[]

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

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
PatchMetadataInvalid
PlatformConfigFault
RequestCanceled
RuntimeFaultThrown 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

Required Privileges
System.Read
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
metaUrls* Pxsd:string[]

Since vSphere API 4.0
bundleUrls* Pxsd:string[]

Since vSphere API 4.0
spec* PHostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
PlatformConfigFault
RequestCanceled
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



StageHostPatch_Task

Required Privileges
Host.Config.Patch
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
metaUrls* Pxsd:string[]

Since vSphere API 4.0
bundleUrls* Pxsd:string[]

Since vSphere API 4.0
vibUrls* Pxsd:string[]

Since vSphere API 4.0
spec* PHostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
PlatformConfigFault
RequestCanceled
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None



UninstallHostPatch_Task

Required Privileges
Host.Config.Patch
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the HostPatchManager used to make the method call.
bulletinIds* Pxsd:string[]

Since vSphere API 4.0
spec* PHostPatchManagerPatchManagerOperationSpec

Since vSphere API 4.0
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
ManagedObjectReference
to a ConverterTask

Faults

Type Description
InvalidState
PlatformConfigFault
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.
TaskInProgress

Events

Type
None