Task Set Task Description

Updates task description to describe the current phase of the task.

Required privileges: Task.Update

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/Task/{moId}/SetTaskDescription

COPY

Path Parameters

string

moId

Required

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 Task/{moId}.

string

release

Required

The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.

Request Body

SetTaskDescriptionRequestType of type(s) application/json

Required

Show optional properties

{
    "description": {
        "key": "string"
    }
}

{
    "description": {
        "_typeName": "string",
        "key": "string",
        "arg": [
            {
                "_typeName": "string",
                "key": "string",
                "value": {
                    "_typeName": "string"
                }
            }
        ],
        "message": "string"
    }
}

LocalizableMessage

description

Required

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.
- arg = [("address" = "127.0.0.1")]
- CATALOG(locmsg, key) = "IP address is {address}"
- ==> message = "IP address is 127.0.0.1"
If the substitution variable is an integer, value is a lookup key.
- arg = [("1" = "button.cancel"), ("2" = "msg.revert")]
- CATALOG(locmsg, key) = "Select '{1}' to {2}"
- CATALOG(locmsg, button.cancel) = "Cancel"
- CATALOG(locmsg, msg.revert) = "revert"
- ==> message = "Select 'Cancel' to revert"
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"