Managed Object -
Task
- Property of
-
HostVMotionManagerDestinationState, ManagedEntity, ScheduledTaskInfo, TaskInfo, TaskInProgress, TaskManager
- Returned by
-
AddHost_Task, AddStandaloneHost_Task, CloneVM_Task, CreateSnapshot_Task, CreateVM_Task, CustomizeVM_Task, Destroy_Task, DisconnectHost_Task, EnterMaintenanceMode_Task, ExitMaintenanceMode_Task, GenerateLogBundles_Task, MigrateVM_Task, MoveHostInto_Task, MoveInto_Task, MoveIntoFolder_Task, PowerOffVM_Task, PowerOnVM_Task, RebootHost_Task, ReconfigureCluster_Task, ReconfigureHostForDAS_Task, ReconfigVM_Task, ReconnectHost_Task, RegisterVM_Task, RelocateVM_Task, RemoveAllSnapshots_Task, RemoveSnapshot_Task, Rename_Task, ResetVM_Task, RevertToCurrentSnapshot_Task, RevertToSnapshot_Task, SearchDatastore_Task, SearchDatastoreSubFolders_Task, ShutdownHost_Task, SuspendVM_Task, UnregisterAndDestroy_Task, UpgradeTools_Task, UpgradeVM_Task
- See also
-
TaskInfo
Managed Object Description
A task is used to monitor and potentially cancel long
running operations.
Properties
|
Name
|
Type
|
Description
|
| info | TaskInfo |
Detailed information about this task.
|
Methods
CancelTask
Cancels a running or queued task. A task may only be canceled if it is
cancelable. Multiple cancel requests will be treated as a single
cancelation request. Canceling a completed or already canceled task
will have no effect on the task.
If a task is canceled, its runtime state will be set to error and its
error state will be set to RequestCanceled.
A cancel operation is asynchronous. The operation may return before
the task is canceled.
- Required Privileges
- Global.CancelTask
Parameters
Return Value
Faults
|
Type
|
Description
|
| NotSupported | Thrown if the task is not cancelable. |
| RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Show WSDL type definition