Task Cancel Task

Task Cancel Task

Cancels a running or queued task.

A task may only be canceled if it is cancelable. Multiple cancel requests will be treated as a single cancelation request. Canceling a completed or already canceled task will throw an InvalidState exception.

If a task is canceled, its runtime state will be set to error and its error state will be set to RequestCanceled.

A cancel operation is asynchronous. The operation may return before the task is canceled.

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/Task/{moId}/CancelTask
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.

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

NotSupported: If the task is not cancelable.

InvalidState: If the task is already canceled or completed.

Returns InvalidState of type(s) application/json 
"InvalidState Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/Task/{moId}/CancelTask
On This Page
Task 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