ScheduledTaskInfo

ScheduledTaskInfo
ScheduledTaskInfo

The scheduled task details.

AllOf
This class requires all of the following:
JSON Example 
{
    "_typeName": "string",
    "name": "string",
    "description": "string",
    "enabled": false,
    "scheduler": {
        "_typeName": "string",
        "activeTime": "string",
        "expireTime": "string"
    },
    "action": {
        "_typeName": "string"
    },
    "notification": "string",
    "scheduledTask": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "entity": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "lastModifiedTime": "string",
    "lastModifiedUser": "string",
    "nextRunTime": "string",
    "prevRunTime": "string",
    "state": "string",
    "error": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "result": {
        "_typeName": "string"
    },
    "progress": 0,
    "activeTask": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "taskObject": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    }
}
MoRefScheduledTask
scheduledTask
Required

Reference to an instance of the ScheduledTask managed object.

MoRefManagedEntity
entity
Required

Reference to an instance of the ManagedEntity managed object.

string As date-time As date-time
lastModifiedTime
Required

The time the scheduled task is created or modified.

string
lastModifiedUser
Required

Last user that modified the scheduled task.

string As date-time As date-time
nextRunTime
Optional

The next time the scheduled task will run.

string As date-time As date-time
prevRunTime
Optional

The last time the scheduled task ran.

TaskInfoState_enum
state
Required

List of possible states of a task.

Possible values:

  • queued: When there are too many tasks for threads to handle.

  • running: When the busy thread is freed from its current task by finishing the task, it picks a queued task to run.

    Then the queued tasks are marked as running.

  • success: When a running task has completed.

  • error: When a running task has encountered an error.

Possible values are : queued, running, success, error,
MethodFault
error
Optional

The base data object type for all the object model faults that an application might handle.

Any
result
Optional

The base of all data types. Not to be used directly on the wire.

integer As int32 As int32
progress
Optional

The task progress when the scheduled task state is "running".

MoRefTask
activeTask
Optional

Reference to an instance of the Task managed object.

ManagedObjectReference
taskObject
Required

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

Property Of
Returned By