Scripting Object - VcTaskManager

Scripting-object corresponding to
TaskManager
Attribute of
VcSdkConnection, VcServiceContent

Scripting Object Description

The TaskManager managed object provides an interface for creating and managing {@link vim.Task Task} managed objects. Many operations are non-blocking, returning a {@link vim.Task Task} managed object that can be monitored by a client application. {@link vim.Task Task} managed objects may also be accessed through the TaskManager.

Attributes

Name Type Description
descriptionVcTaskDescription

@since VI API 2.5
idString

@since Unknown
maxCollectorNumber

@since VI API 2.5
morefVcManagedObjectReference

returns the ManagedObjectReference of this ManagedObject @since Unknown
recentTaskVcTask []

@since VI API 2.5
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, createCollectorForTasks, createTask, createTaskWithEntityName, createTrigger

_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

createCollectorForTasks

Creates a {@link vim.TaskHistoryCollector TaskHistoryCollector}, a specialized {@link vim.HistoryCollector HistoryCollector} that gathers {@link vim.TaskInfo TaskInfo} data objects.

A {@link vim.TaskHistoryCollector TaskHistoryCollector} does not persist beyond the current client session. @since VI API 2.5

Parameters

NameTypeDescription
arg0VcTaskFilterSpec


Return Value

Type Description
VcTaskHistoryCollector

createTaskWithEntityName

Creates a new {@link vim.Task Task}, specifying the object with which the {@link vim.Task Task} is associated, the name of the object, the type of task, and whether the task is cancelable. Use this operation in conjunction with the {@link vim.ExtensionManager ExtensionManager}.

@since vSphere API 6.0

Parameters

NameTypeDescription
arg0VcManagedObject

arg1String

arg2String

arg3String

arg4Boolean

arg5String

arg6String


Return Value

Type Description
VcTaskInfo

createTask

Creates a new {@link vim.Task Task}, specifying the object with which the {@link vim.Task Task} is associated, the type of task, and whether the task is cancelable. Use this operation in conjunction with the {@link vim.ExtensionManager ExtensionManager}.

@since VI API 2.5

Parameters

NameTypeDescription
arg0VcManagedObject

arg1String

arg2String

arg3Boolean

arg4String

arg5String


Return Value

Type Description
VcTaskInfo