Scheduled Task Run Scheduled Task

Runs the scheduled task immediately.

The schedule for future runs remains in effect.

Required privileges: ScheduledTask.Run

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/ScheduledTask/{moId}/RunScheduledTask

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 ScheduledTask/{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.

Session

Responses

204

No Content

Operation doesn't return any data structure

500

InvalidState: if the scheduled task is running already.

Returns InvalidState of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Authentication

Response

204 Response Body

Errors

Scheduled Task Operations

GET

Scheduled Task Get Available Field

GET