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 9.1.0.0 APIs.

Request Body

CreateScheduledTaskRequestType of type(s) application/json

Required

Show optional properties

{
    "entity": {},
    "spec": {}
}

{
    "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"
    }
}

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.

Session

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"entity":"{}","spec":"{}"}' https://{api_host}/sdk/vim25/{release}/ScheduledTaskManager/{moId}/CreateScheduledTask

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Infrastructure Operations

POST

Scheduled Task Manager Create Scheduled Task