Managed Object - Task

Property of
ClusterAttemptedVmInfo, ConverterTaskInfo, ManagedEntity, ScheduledTaskInfo, StoragePlacementResult, TaskInfo, TaskInProgress, TaskManager, VsanUpgradeSystemUpgradeHistoryItem
Extends
ExtensibleManagedObject
See also
LocalizableMessage, MethodFault, TaskInfo, TaskInfoState
Since
null


Managed Object Description

Properties

Name Type Description
infoTaskInfo


Properties inherited from ExtensibleManagedObject
availableField, value

Methods

Methods defined in this Managed Object
CancelTask, SetTaskDescription, SetTaskState, UpdateProgress
Methods inherited from ExtensibleManagedObject
setCustomValue

CancelTask

Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Task used to make the method call.

Return Value

Type Description
None

Faults

Type Description
InvalidState
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



SetTaskDescription

Required Privileges
Task.Update
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Task used to make the method call.
description PLocalizableMessage

Since vSphere API 4.0
P Required privilege: description

Return Value

Type Description
None

Faults

Type Description
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



SetTaskState

Required Privileges
Task.Update
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Task used to make the method call.
state PTaskInfoState

Since VI API 2.5
result* Pxsd:anyType

Since VI API 2.5
fault* PMethodFault

Since VI API 2.5
*Need not be set PRequired privilege - see tooltip for details

Return Value

Type Description
None

Faults

Type Description
InvalidState
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



UpdateProgress

Required Privileges
Task.Update
Since
VI API 2.5

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the Task used to make the method call.
percentDone Pxsd:int

Since VI API 2.5
P Required privilege: percentDone

Return Value

Type Description
None

Faults

Type Description
InvalidState
OutOfBounds
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