Task Update Progress
Sets percentage done for this task and recalculates overall percentage done.
If a percentDone value of less than zero or greater than 100 is specified, a value of zero or 100 respectively is used.
Required privileges: Task.Update
Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/Task/{moId}/UpdateProgress
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.2.0 APIs.
Request Body
UpdateProgressRequestType of type(s) application/json
Required
{
"percentDone": 0
}integer As int32 As int32
percentDone
Required
Percentage to set for this task
Responses
204
No Content
Operation doesn't return any data structure
500
InvalidState: If task is not running
OutOfBounds: VirtualCenter 2.x servers throw this fault if percentDone is less than 0 or greater than 100. Newer versions behave as described above, and never throw this fault.
Returns VimFault of type(s) application/json
This response body class contains all of the following: MethodFault
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}