# 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 P | ScheduledTaskDescription | Static descriptive strings used in scheduled tasks.
scheduledTask* P | ManagedObjectReference[] to a ScheduledTask[] | All available scheduled tasks.

*May not be present P 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

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call.
obj P | ManagedObjectReference | 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 P | ScheduledTaskSpec | The specification for the new scheduled task. Since vSphere API 4.0

P Required privilege - see tooltip for details

Return Value

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

Faults

Type | Description
--- | ---
DuplicateName | Thrown if a scheduled task with the name already exists.
InvalidName | Thrown if the scheduled task name is empty or too long.
RuntimeFault | Thrown 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="CreateObjectScheduledTask" type="vslm:CreateObjectScheduledTaskRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="CreateObjectScheduledTaskResponse"> <complexType> <sequence> <element name="returnval" type="vslm:ManagedObjectReference"/> </sequence> </complexType> </element>

# CreateScheduledTask(create)

Creates a scheduled task.

Required Privileges
  None

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call.
entity P | ManagedObjectReference 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 P | ScheduledTaskSpec | The specification for the new scheduled task. Since 2.0

P Required privilege - see tooltip for details

Return Value

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

Faults

Type | Description
--- | ---
DuplicateName | Thrown if a scheduled task with the name already exists.
InvalidName | Thrown if the scheduled task name is empty or too long.
RuntimeFault | Thrown 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="CreateScheduledTask" type="vslm:CreateScheduledTaskRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="CreateScheduledTaskResponse"> <complexType> <sequence> <element name="returnval" type="vslm:ManagedObjectReference"/> </sequence> </complexType> </element>

# RetrieveEntityScheduledTask(retrieveEntityScheduledTask)

Available scheduled tasks defined on the entity.

Required Privileges
  System.View

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call.
entity* P | ManagedObjectReference 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
--- | ---
RuntimeFault | Thrown 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="RetrieveEntityScheduledTask" type="vslm:RetrieveEntityScheduledTaskRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="RetrieveEntityScheduledTaskResponse"> <complexType> <sequence> <element name="returnval" type="vslm:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>

# RetrieveObjectScheduledTask(retrieveObjectScheduledTask)

Available scheduled tasks defined on the object.

Required Privileges
  System.View
Since
  vSphere API 4.0

Parameters

Name | Type | Description
--- | --- | ---
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call.
obj* P | ManagedObjectReference | 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
--- | ---
RuntimeFault | Thrown 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
<element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="RetrieveObjectScheduledTask" type="vslm:RetrieveObjectScheduledTaskRequestType"/> <element xmlns="http://www.w3.org/2001/XMLSchema" xmlns:vslm="urn:vslm" name="RetrieveObjectScheduledTaskResponse"> <complexType> <sequence> <element name="returnval" type="vslm:ManagedObjectReference" minOccurs="0" maxOccurs="unbounded"/> </sequence> </complexType> </element>