Vslm Task Vslm Cancel Task

Vslm Task Vslm Cancel Task

Cancel a running or queued task.

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

If a task is canceled, its runtime state will be set to error and the cancelled flag will be set to true.

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

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

string
release
Required

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

Authentication
This operation uses the following authentication methods.
Responses
204

No Content

Operation doesn't return any data structure

500

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}/vslm/VslmTask/{moId}/VslmCancelTask
On This Page
Storage Lifecycle Management Operations
POST
Vslm Task Vslm Cancel Task
POST
Vslm Task Vslm Query Info
POST
Vslm Task Vslm Query Task Result