Scripting Object - VcHostPatchManager

Scripting-object corresponding to
HostPatchManager
Attribute of
VcHostConfigManager
Returned by
retrievePatchManager

Scripting 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.

Attributes

Name Type Description
idString

@since Unknown
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
sdkConnectionVcSdkConnection

@since Unknown
sdkIdString

@since Unknown
typeStringDeprecated.

Returns the name for the this managed object's vim type @since Unknown
vimHostVcSdkConnection

@since Unknown
vimIdString

@since Unknown
vimTypeString

@since Unknown

Methods

Methods defined in this Scripting Object
_getRef, checkHostPatch_Task, createTrigger, installHostPatch_Task, installHostPatchV2_Task, queryHostPatch_Task, scanHostPatch_Task, scanHostPatchV2_Task, stageHostPatch_Task, uninstallHostPatch_Task

installHostPatchV2_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 {@link vim.fault.PatchInstallFailed} for details. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String []

arg1String []

arg2String []

arg3VcHostPatchManagerPatchManagerOperationSpec


Return Value

Type Description
VcTask

_getRef

@since Unknown

Parameters

NameTypeDescription
None

Return Value

Type Description
VcManagedObjectReference

createTrigger

@since Unknown

Parameters

NameTypeDescription
timeoutNumber

filterString

conditionString

filterToSyncString


Return Value

Type Description
Trigger

stageHostPatch_Task

Stage the vib files to esx local location and possibly do some run time check. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String []

arg1String []

arg2String []

arg3VcHostPatchManagerPatchManagerOperationSpec


Return Value

Type Description
VcTask

scanHostPatch_Task

Scan the host for the patch status. The operation is cancelable through the returned {@link vim.Task} object. Integrity checks are performed on the metadata only during the scan operation. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostPatchManagerLocator

arg1String []


Return Value

Type Description
VcTask

queryHostPatch_Task

Query the host for installed bulletins. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0VcHostPatchManagerPatchManagerOperationSpec


Return Value

Type Description
VcTask

uninstallHostPatch_Task

Uninstall patch from the host. The operation is not cancelable. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String []

arg1VcHostPatchManagerPatchManagerOperationSpec


Return Value

Type Description
VcTask

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 {@link vim.fault.PatchInstallFailed} for details. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcHostPatchManagerLocator

arg1String

arg2Boolean


Return Value

Type Description
VcTask

scanHostPatchV2_Task

Scan the host for the patch status. The operation is cancelable through the returned {@link vim.Task} object. Integrity checks are performed on the metadata only during the scan operation. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String []

arg1String []

arg2VcHostPatchManagerPatchManagerOperationSpec


Return Value

Type Description
VcTask

checkHostPatch_Task

Check the list of metadata and returns the dependency, obsolete and conflict information The operation is cancelable through the returned {@link vim.Task} object. No integrity checks are performed on the metadata. @since vSphere API 4.0

Parameters

NameTypeDescription
arg0String []

arg1String []

arg2VcHostPatchManagerPatchManagerOperationSpec


Return Value

Type Description
VcTask