REST API - task

vcenter deployment: task

The task structure contains fields to describe a particular deployment task. This structure was added in vSphere API 6.7

Representation:

JSON

{
    "cancelable": true,
    "description": {
        "args": [
            "string",
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "end_time": "2015-01-01T22:13:05.651Z",
    "error": {},
    "operation": "obj-103",
    "parent": "obj-103",
    "progress": {
        "completed": 1,
        "message": {
            "args": [
                "string",
                "string"
            ],
            "default_message": "string",
            "id": "string"
        },
        "total": 1
    },
    "result": {
        "errors": [
            {
                "id": "string",
                "message": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "resolution": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "time": "2015-01-01T22:13:05.651Z"
            },
            {
                "id": "string",
                "message": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "resolution": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "time": "2015-01-01T22:13:05.651Z"
            }
        ],
        "info": [
            {
                "id": "string",
                "message": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "resolution": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "time": "2015-01-01T22:13:05.651Z"
            },
            {
                "id": "string",
                "message": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "resolution": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "time": "2015-01-01T22:13:05.651Z"
            }
        ],
        "warnings": [
            {
                "id": "string",
                "message": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "resolution": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "time": "2015-01-01T22:13:05.651Z"
            },
            {
                "id": "string",
                "message": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "resolution": {
                    "args": [
                        "string",
                        "string"
                    ],
                    "default_message": "string",
                    "id": "string"
                },
                "time": "2015-01-01T22:13:05.651Z"
            }
        ]
    },
    "service": "obj-103",
    "start_time": "2015-01-01T22:13:05.651Z",
    "status": "PENDING",
    "target": {
        "id": "obj-103",
        "type": "string"
    },
    "user": "string"
}

Attributes:

Name	Type	Description
Required
description	localizable_message	Description of the operation associated with the task. This attribute was added in vSphere API 6.7
service	string	Name of the service containing the operation. This attribute was added in vSphere API 6.7 When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vapi.service`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vapi.service`.
operation	string	Name of the operation associated with the task. This attribute was added in vSphere API 6.7 When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.vapi.operation`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.vapi.operation`.
status	string	Status of the operation associated with the task. This attribute was added in vSphere API 6.7 Defines the status values that can be reported for an operation. This enumeration was added in vSphere API 6.7 Value is one of: PENDING: The operation is in pending state. This constant was added in vSphere API 6.7 RUNNING: The operation is in progress. This constant was added in vSphere API 6.7 BLOCKED: The operation is blocked. This constant was added in vSphere API 6.7 SUCCEEDED: The operation completed successfully. This constant was added in vSphere API 6.7 FAILED: The operation failed. This constant was added in vSphere API 6.7
cancelable	boolean	Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This attribute was added in vSphere API 6.7
Optional
progress	progress	The progress info of this deployment task. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `#status` is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.
result	notifications	Result of the task. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field will be unset if result is not available at the current step of the task.
parent	string	Parent of the current task. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the task has no parent.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: `com.vmware.cis.task`. When operations return a value of this structure as a result, the field will be an identifier for the resource type: `com.vmware.cis.task`.
target	dynamic_ID	Identifier of the target created by the operation or an existing one the operation performed on. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation has no target or multiple targets.
error	exception	Description of the error if the operation status is "FAILED". This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see cis.task.info.result).
start_time	date_time	Time when the operation is started. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `status` is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.
end_time	date_time	Time when the operation is completed. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of `status` is one of SUCCEEDED or FAILED.
user	string	Name of the user who performed the operation. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation is performed by the system.