Task Manager Create Task
Creates a new Task, specifying the object with which the Task is associated, the type of task, and whether the task is cancelable.
Use this operation in conjunction with the ExtensionManager.
Required privileges: Task.Create
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case TaskManager/{moId}.
The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.
"CreateTaskRequestType Object"ManagedObject with which Task will be associated
Extension registered task type identifier for type of task being created
The name of the user on whose behalf the Extension is creating the task
True if the task should be cancelable, false otherwise
Key of the task that is the parent of this task
Activation Id is a client-provided token to link an API call with a task. When provided, the activationId is added to the TaskInfo
TaskInfo data object describing the new task
"TaskInfo Object"The unique key for the task.
The managed object that represents this task.
The description field of the task describes the current phase of operation of the task.
For a task that does a single monolithic activity, this will be fixed and unchanging. For tasks that have various substeps, this field will change as the task progresses from one phase to another.
The name of the operation that created the task.
This is not set for internal tasks.
An identifier for this operation.
This includes publicly visible internal tasks and is a lookup in the TaskDescription methodInfo data object.
Managed entity to which the operation applies.
The name of the managed entity, locale-specific, retained for the history collector database.
If the state of the task is "running", then this property is a list of managed entities that the operation has locked, with a shared lock.
Runtime status of the task.
Flag to indicate whether or not the client requested cancellation of the task.
Flag to indicate whether or not the cancel task operation is supported.
If the task state is "error", then this property contains the fault code.
If the task state is "success", then this property may be used to hold a return value.
If the task state is "running", then this property contains a progress measurement, expressed as percentage completed, from 0 to 100.
If this property is not set, then the command does not report progress.
Since: vSphere API Release 8.0.1.0
Kind of entity responsible for creating this task.
Time stamp when the task was created.
Time stamp when the task started running.
Time stamp when the task was completed (whether success or failure).
Event chain ID that leads to the corresponding events.
The user entered tag to identify the operations and their side effects
Tasks can be created by another task.
This shows TaskInfo.key of the task spun off this task. This is to track causality between tasks.
Tasks can be created by another task and such creation can go on for multiple levels.
This is the TaskInfo.key of the task that started the chain of tasks.
The activation Id is a client-provided token to link an API call with a task.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/TaskManager/{moId}/CreateTask