Managed Object - ScheduledTaskManager(vim.scheduler.ScheduledTaskManager)

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


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
CreateObjectScheduledTask, CreateScheduledTask, RetrieveEntityScheduledTask, RetrieveObjectScheduledTask

CreateObjectScheduledTask(createObjectScheduledTask)

Creates a scheduled task.
Required Privileges
None
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ScheduledTaskManager used to make the method call.
obj PManagedObjectReference

The managed object for which the scheduled task triggers an action. You can schedule tasks on any managed object.

Since vSphere API 4.0
spec PScheduledTaskSpec

The specification for the new scheduled task.

Since vSphere API 4.0
PRequired privilege - see tooltip for details

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

Events

Type
None

Show WSDL type definition



CreateScheduledTask(create)

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

Since 2.0
spec PScheduledTaskSpec

The specification for the new scheduled task.

Since 2.0
PRequired privilege - see tooltip for details

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

Events

Type
None

Show WSDL type definition



RetrieveEntityScheduledTask(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* PManagedObjectReference
to a ManagedEntity

The entity. If null, all scheduled tasks are returned for visible entities.

Since 2.0
*Need not be set P Required privilege: entity

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.

Events

Type
None

Show WSDL type definition



RetrieveObjectScheduledTask(retrieveObjectScheduledTask)

Available scheduled tasks defined on the object.

Required Privileges
System.View
Since
vSphere API 4.0

Parameters

NameTypeDescription
_thisManagedObjectReference A reference to the ScheduledTaskManager used to make the method call.
obj* PManagedObjectReference

The object. If not specified, all scheduled tasks are returned for visible entities and visible ManagedObjects.

Since vSphere API 4.0
*Need not be set P Required privilege: obj

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.

Events

Type
None

Show WSDL type definition