15f7be9a52
This external documentation for pyVmomi was generated using Googly Docs (aka Google Standard Documentation) which renders very cleanly in GitHub. Internal documentation for a class should be done in Sphinx format because tools like pyCharm and Eclipse can use that documentation as a hint for code completion. Note: External docs as Googly Docs, internal docs as Sphinx. Closes bug#15
3.6 KiB
vim.scheduler.ScheduledTaskManager
Object manager for scheduled tasks.
Attributes
- scheduledTask (vim.scheduler.ScheduledTask):
- privilege: System.View
All available scheduled tasks.
- description (vim.scheduler.ScheduledTaskDescription):
- privilege: System.View
Static descriptive strings used in scheduled tasks.
Methods
- CreateScheduledTask(entity, spec):
-
Creates a scheduled task.
Privilege:
- Args:
-
- entity (vim.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.
- spec (vim.scheduler.ScheduledTaskSpec):
-
The specification for the new scheduled task.
- Returns:
-
- vim.scheduler.ScheduledTask:
-
The scheduled task created by the operation.
Raises:
- vim.fault.InvalidName:
-
if the scheduled task name is empty or too long.
- vim.fault.DuplicateName:
-
if a scheduled task with the name already exists.
- vmodl.fault.InvalidArgument:
-
if the specification is invalid.
- RetrieveEntityScheduledTask(entity):
-
Available scheduled tasks defined on the entity.
- Privilege:
-
System.View
- Args:
-
- entity (vim.ManagedEntity, optional):
-
The entity. If null, all scheduled tasks are returned for visible entities.
- Returns:
-
- vim.scheduler.ScheduledTask:
-
The scheduled tasks.
- CreateObjectScheduledTask(obj, spec):
-
Creates a scheduled task. since: vSphere API 4.0
Privilege:
- Args:
-
- obj (vmodl.ManagedObject):
-
The managed object for which the scheduled task triggers an action. You can schedule tasks on any managed object.
- spec (vim.scheduler.ScheduledTaskSpec):
-
The specification for the new scheduled task.
- Returns:
-
- vim.scheduler.ScheduledTask:
-
The scheduled task created by the operation.
Raises:
- vim.fault.InvalidName:
-
if the scheduled task name is empty or too long.
- vim.fault.DuplicateName:
-
if a scheduled task with the name already exists.
- vmodl.fault.InvalidArgument:
-
if the specification is invalid.
- RetrieveObjectScheduledTask(obj):
-
Available scheduled tasks defined on the object. since: vSphere API 4.0
- Privilege:
-
System.View
- Args:
-
- obj (vmodl.ManagedObject, optional):
-
The object. If not specified, all scheduled tasks are returned for visible entities and visible ManagedObjects.
- Returns:
-
- vim.scheduler.ScheduledTask:
-
The scheduled tasks.