Scheduled Task Manager Get Description

Static descriptive strings used in scheduled tasks.

Required privileges: System.View

Request

URI

GET

https://{vcenter-host}/sdk/vim25/{release}/ScheduledTaskManager/{moId}/description

COPY

Path Parameters

string

moId

Required

The unique identifier for the managed object to which the property 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.3.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns ScheduledTaskDescription of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "action": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "schedulerInfo": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string",
            "frequency": "string"
        }
    ],
    "state": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "dayOfWeek": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ],
    "weekOfMonth": [
        {
            "_typeName": "string",
            "label": "string",
            "summary": "string",
            "key": "string"
        }
    ]
}

array of TypeDescription

action

Required

Action class descriptions for a scheduled task.

array of ScheduledTaskDetail

schedulerInfo

Required

Scheduler class description details.

array of ElementDescription

state

Required

TaskInfo State enum