VslmTaskInfo

VslmTaskInfo
VslmTaskInfo

This data object type contains all information about a VSLM task.

A task represents an operation performed by VirtualCenter or ESX.

This structure may be used only with operations rendered under /vslm.

AllOf
This class requires all of the following:
JSON Example
{
    "_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,
    "reason": {
        "_typeName": "string"
    },
    "queueTime": "string",
    "startTime": "string",
    "completeTime": "string",
    "eventChainId": 0,
    "changeTag": "string",
    "parentTaskKey": "string",
    "rootTaskKey": "string",
    "activationId": "string"
}
string
key
Required

The unique key for the task.

task
Required

The managed object that represents this task.

description
Optional

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.

string
name
Optional

The name of the operation that created the task.

This is not set for internal tasks.

string
descriptionId
Required

An identifier for this operation.

This includes publicly visible internal tasks and is a lookup in the TaskDescription methodInfo data object.

entity
Optional

Managed entity to which the operation applies.

string
entityName
Optional

The name of the managed entity, locale-specific, retained for the history collector database.

array of MoRefManagedEntity
locked
Optional

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.

state
Required

Runtime status of the task.

boolean
cancelled
Required

Flag to indicate whether or not the client requested cancellation of the task.

boolean
cancelable
Required

Flag to indicate whether or not the cancel task operation is supported.

error
Optional

If the task state is "error", then this property contains the fault code.

result
Optional

If the task state is "success", then this property may be used to hold a return value.

integer As int32 As int32
progress
Optional

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.

reason
Required

Kind of entity responsible for creating this task.

string As date-time As date-time
queueTime
Required

Time stamp when the task was created.

string As date-time As date-time
startTime
Optional

Time stamp when the task started running.

string As date-time As date-time
completeTime
Optional

Time stamp when the task was completed (whether success or failure).

integer As int32 As int32
eventChainId
Required

Event chain ID that leads to the corresponding events.

string
changeTag
Optional

The user entered tag to identify the operations and their side effects

string
parentTaskKey
Optional

Tasks can be created by another task.

This shows VslmTaskInfo.key of the task spun off this task. This is to track causality between tasks.

string
rootTaskKey
Optional

Tasks can be created by another task and such creation can go on for multiple levels.

This is the VslmTaskInfo.key of the task that started the chain of tasks.

string
activationId
Optional

The activation Id is a client-provided token to link an API call with a task.

Property Of
Returned By