1. Types
  2. cis
  3. task

cis task: info

The info structure contains information about a task. This structure was added in vSphere API 6.7.

Representation:

{
    "parent" : "obj-103",
    "cancelable" : true,
    "end_time" : "2015-01-01T22:13:05.651Z",
    "description" : {
        "args" : [
            "string",
            "string"
        ],
        "default_message" : "string",
        "localized" : "string",
        "id" : "string",
        "params" : {
            "<string>" : {
                "dt" : "2015-01-01T22:13:05.651Z",
                "s" : "string",
                "d" : 1.5,
                "precision" : 1,
                "format" : "SHORT_DATE",
                "i" : 1,
                "l" : {
                    "id" : "string",
                    "params" : {
                        "<string>" : {
                            "dt" : "2015-01-01T22:13:05.651Z",
                            "s" : "string",
                            "d" : 1.5,
                            "precision" : 1,
                            "format" : "SHORT_DATE",
                            "i" : 1,
                            "l" : {
                                "id" : "string",
                                "params" : {}
                            }
                        }
                    }
                }
            }
        }
    },
    "error" : {},
    "target" : {
        "id" : "obj-103",
        "type" : "string"
    },
    "result" : "opaque_string_value",
    "start_time" : "2015-01-01T22:13:05.651Z",
    "service" : "obj-103",
    "progress" : {
        "total" : 1,
        "completed" : 1,
        "message" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : {
                "<string>" : {
                    "dt" : "2015-01-01T22:13:05.651Z",
                    "s" : "string",
                    "d" : 1.5,
                    "precision" : 1,
                    "format" : "SHORT_DATE",
                    "i" : 1,
                    "l" : {
                        "id" : "string",
                        "params" : {
                            "<string>" : {
                                "dt" : "2015-01-01T22:13:05.651Z",
                                "s" : "string",
                                "d" : 1.5,
                                "precision" : 1,
                                "format" : "SHORT_DATE",
                                "i" : 1,
                                "l" : {
                                    "id" : "string",
                                    "params" : {}
                                }
                            }
                        }
                    }
                }
            }
        }
    },
    "operation" : "obj-103",
    "user" : "string",
    "status" : "PENDING"
}
{
    "parent" : "obj-103",
    "cancelable" : true,
    "end_time" : "2015-01-01T22:13:05.651Z",
    "description" : {
        "args" : [
            "string",
            "string"
        ],
        "default_message" : "string",
        "localized" : "string",
        "id" : "string",
        "params" : [
            {
                "value" : {
                    "dt" : "2015-01-01T22:13:05.651Z",
                    "s" : "string",
                    "d" : 1.5,
                    "precision" : 1,
                    "format" : "SHORT_DATE",
                    "i" : 1,
                    "l" : {
                        "id" : "string",
                        "params" : [
                            {
                                "value" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : [
                                            {
                                                "key" : "string"
                                            }
                                        ]
                                    }
                                },
                                "key" : "string"
                            }
                        ]
                    }
                },
                "key" : "string"
            }
        ]
    },
    "error" : {},
    "target" : {
        "id" : "obj-103",
        "type" : "string"
    },
    "result" : "opaque_string_value",
    "start_time" : "2015-01-01T22:13:05.651Z",
    "service" : "obj-103",
    "progress" : {
        "total" : 1,
        "completed" : 1,
        "message" : {
            "args" : [
                "string",
                "string"
            ],
            "default_message" : "string",
            "localized" : "string",
            "id" : "string",
            "params" : [
                {
                    "value" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : [
                                {
                                    "value" : {
                                        "dt" : "2015-01-01T22:13:05.651Z",
                                        "s" : "string",
                                        "d" : 1.5,
                                        "precision" : 1,
                                        "format" : "SHORT_DATE",
                                        "i" : 1,
                                        "l" : {
                                            "id" : "string",
                                            "params" : [
                                                {
                                                    "key" : "string"
                                                }
                                            ]
                                        }
                                    },
                                    "key" : "string"
                                }
                            ]
                        }
                    },
                    "key" : "string"
                }
            ]
        }
    },
    "operation" : "obj-103",
    "user" : "string",
    "status" : "PENDING"
}

Attributes:

Name Type Description
Required
-.progress.total long Total amount of the work for the operation. This attribute was added in vSphere API 6.7.
-.progress.completed long The amount of work completed for the operation. The value can only be incremented. This attribute was added in vSphere API 6.7.
-.progress.message localizable_message Message about the work progress. This attribute was added in vSphere API 6.7.
-.progress.message.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
-.progress.message.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
-.progress.message.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
-.description localizable_message Description of the operation associated with the task. This attribute was added in vSphere API 6.7.
-.description.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
-.description.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
-.description.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.
-.service string Identifier 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 Identifier 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.
-.target.type string The type of resource being identified (for example com.acme.Person).

Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.
-.target.id string The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.
-.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 Progress of the operation. 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.
-.progress.message.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
-.progress.message.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
-.result opaque Result of the operation. If an operation reports partial results before it completes, this field could be set before the cis.task.common_info.status has the value SUCCEEDED. The value could change as the operation progresses. 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 the operation does not return a result or if the result is not available at the current step of the operation.
-.description.params object Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
-.description.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.
-.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.