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 8.0.3.0 APIs.
Show optional properties
{
"obj": {
"type": "string",
"value": "string"
},
"taskTypeId": "string",
"cancelable": false
}{
"obj": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"taskTypeId": "string",
"initiatedBy": "string",
"cancelable": false,
"parentTaskKey": "string",
"activationId": "string"
}The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.
Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.
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
{
"_typeName": "string",
"key": "string",
"task": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"description": {
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
},
"name": "string",
"descriptionId": "string",
"entity": {
"_typeName": "string",
"type": "string",
"value": "string"
},
"entityName": "string",
"locked": [
{
"_typeName": "string",
"type": "string",
"value": "string"
}
],
"state": "string",
"cancelled": false,
"cancelable": false,
"error": {
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
},
"result": {
"_typeName": "string"
},
"progress": 0,
"progressDetails": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"reason": {
"_typeName": "string"
},
"queueTime": "string",
"startTime": "string",
"completeTime": "string",
"eventChainId": 0,
"changeTag": "string",
"parentTaskKey": "string",
"rootTaskKey": "string",
"activationId": "string"
}The unique key for the task.
Message data which is intended to be displayed according to the locale of a client.
A LocalizableMessage contains both a formatted, localized version of the text and the data needed to perform localization in conjunction with localization catalogs.
Clients of the VIM API may use vim.SessionManager.setLocale() to cause the server to emit a localized message, or may perform client-side localization based on message catalogs provided by the server.
- If the substition variable is a string, no further lookup is required.
- If the substitution variable is an integer, value is a lookup key.
- If the variable contains '@', value is a label lookup in another catalog, where {name.@CATALOG.prefix} looks up prefix.arg[name].label in CATALOG.
- arg = [("field" = "queued")]
- CATALOG(locmsg, key) = "State is {field.@enum.TaskInfo.State}"
- CATALOG(enum, TaskInfo.State.queued.label) is "Queued"
- ==> message = "State is Queued"
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.
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.
List of possible states of a task.
Possible values:
queued: When there are too many tasks for threads to handle.running: When the busy thread is freed from its current task by finishing the task, it picks a queued task to run.Then the queued tasks are marked as running.
success: When a running task has completed.error: When a running task has encountered an error.
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.
The base data object type for all the object model faults that an application might handle.
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.
Base type for all task reasons.
Task reasons represent the kind of entity responsible for a task's creation.
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.