Managed Object - ScheduledTaskManager

Property of
ServiceContent
See also
ManagedEntity, ScheduledTask, ScheduledTaskDescription, ScheduledTaskSpec


Managed Object Description

Object manager for scheduled tasks.

Properties

Name Type Description
description PScheduledTaskDescription

Static descriptive strings used in scheduled tasks.
scheduledTask* PManagedObjectReference[]
to a ScheduledTask[]

All available scheduled tasks.
*May not be presentP Required privilege: System.View

Methods

Methods defined in this Managed Object
CreateScheduledTask, RetrieveEntityScheduledTask

CreateScheduledTask

Creates a scheduled task.
Required Privileges
None

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ScheduledTaskManager used to make the method call.
entity PManagedObjectReference
to a ManagedEntity

The managed entity (or entities) for which the scheduled task triggers an action. You can scheduled 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.
specScheduledTaskSpec

The specification for the new scheduled task.
P Required privilege: ScheduledTask.Create

Return Value

Type Description
ManagedObjectReference
to a ScheduledTask
The scheduled task created by the operation.

Faults

Type Description
DuplicateNameThrown if a scheduled task with the name already exists.
InvalidArgumentThrown if the specification is invalid.
InvalidNameThrown if the scheduled task name is empty or too long.
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition



RetrieveEntityScheduledTask

Available scheduled tasks defined on the entity.

Required Privileges
System.View

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ScheduledTaskManager used to make the method call.
entity*ManagedObjectReference
to a ManagedEntity

The entity. If null, all scheduled tasks are returned for visible entities.
*Need not be set

Return Value

Type Description
ManagedObjectReference[]
to a ScheduledTask[]
The scheduled tasks.

Faults

Type Description
RuntimeFaultThrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error.

Show WSDL type definition