Scripting Object - VcHostOperationCleanupManager

Scripting-object corresponding to
HostOperationCleanupManager

Scripting Object Description

Managed object that is responsible for tracking in-progress operations and handling any necessary post-operation cleanup. It serves as a central authority such cleanup, eliminating the need to have multiple layers attempt to indepedently cleanup different sets of files for a single operation. It also handles persisting state to disk, as well as exposing query functionality, greatly simplifying state cleanup after host disconnect, reboot, or crash. The Operation Cleanup Manager interface is exported by hostd (used by vpxa) and by vpxa (used by vpxd). The Operation Cleanup Manager's flow works as follows:

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, createEntry, createTrigger, queryEntry, updateEntry

_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

updateEntry

Updates an Operation Cleanup Manager operation entry's state. If invoked with a success or failure opState, will trigger the appropriate item cleanup. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcHostOperationCleanupManagerOperationEntry


Return Value

Type Description
None

createEntry

Creates an Operation Cleanup Manager operation entry. Upon creation success, OCM guarantees that state has been persisted to disk, and can be recovered upon host crash or disconnect. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcHostOperationCleanupManagerOperationEntry


Return Value

Type Description
None

queryEntry

Queries the state of an Operation Cleanup Manager operation entry, looking up the state from disk. @since vSphere API 6.0

Parameters

NameTypeDescription
arg0String


Return Value

Type Description
VcHostOperationCleanupManagerOperationEntry