Task Set Task Description

Task Set Task Description

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

Required privileges: Task.Update

Request
URI
POST
https://{api_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 9.0.0.0 APIs.

Request Body
SetTaskDescriptionRequestType of type(s) application/json
Required 
"SetTaskDescriptionRequestType Object"
description
Required

New description for task

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/Task/{moId}/SetTaskDescription
On This Page
Virtual Infrastructure Operations
POST
Task Set Task Description
POST
Task Update Progress
POST
Task Cancel Task
POST
Task Set Custom Value
POST
Task Set Task State
GET
Task Get Available Field
GET
Task Get Info
GET
Task Get Value