Scheduled Task Manager Create Scheduled Task

Scheduled Task Manager Create Scheduled Task

Creates a scheduled task.

Request
URI
POST
https://{vcenter-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 8.0.2.0 APIs.

Request Body
CreateScheduledTaskRequestType of type(s) application/json
Required 
{
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "spec": {
        "_typeName": "string",
        "name": "string",
        "description": "string",
        "enabled": false,
        "scheduler": {
            "_typeName": "string",
            "activeTime": "string",
            "expireTime": "string"
        },
        "action": {
            "_typeName": "string"
        },
        "notification": "string"
    }
}
MoRefManagedEntity
entity
Required

Reference to an instance of the ManagedEntity managed object.

ScheduledTaskSpec
spec
Required

Parameters for scheduled task creation.

Authentication
This operation uses the following authentication methods.
Responses
200

The scheduled task created by the operation.

Returns MoRefScheduledTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject 
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

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: MethodFault 
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page
Scheduled Task Manager Operations
POST
Scheduled Task Manager Create Object Scheduled Task
POST
Scheduled Task Manager Create Scheduled Task
GET
Scheduled Task Manager Get Description
GET
Scheduled Task Manager Get Scheduled Task
POST
Scheduled Task Manager Retrieve Entity Scheduled Task
POST
Scheduled Task Manager Retrieve Object Scheduled Task