Scheduled Task Manager Create Scheduled Task

Scheduled Task Manager Create Scheduled Task

Creates a scheduled task.

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

string
release
Required

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


Request Body
CreateScheduledTaskRequestType of type(s) application/json
Required
"CreateScheduledTaskRequestType Object"
entity
Required

The managed entity (or entities) for which the scheduled task triggers an action. You can schedule tasks on any managed entity. If the scheduled task is associated with a leaf node in the inventory tree, it applies only to a single entity (virtual machine or host). If the task is associated with a folder, a datacenter, a compute resource, or a resource pool, it applies to the virtual machine or host descendants of the entity.

Required privileges: ScheduledTask.Create

spec
Required

The specification for the new scheduled task.

Authentication
This operation uses the following authentication methods.
Responses
200

The scheduled task created by the operation.

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

500

InvalidName: if the scheduled task name is empty or too long.

DuplicateName: if a scheduled task with the name already exists.

InvalidArgument: if the specification is invalid.

Returns VimFault of type(s) application/json
This response body class contains all of the following: InlineVimFault0
"VimFault Object"

Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/sdk/vim25/{release}/ScheduledTaskManager/{moId}/CreateScheduledTask