openstack/deb-python-pyvmomi
Code Issues Proposed changes
Files
dbad63e88d06b08d4f1aac358ad3a7f953396ae1
deb-python-pyvmomi/docs/vim/scheduler/ScheduledTask.rst
Shawn Hartsock 15f7be9a52 pyVmomi reStructured Text Documentation 
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
2014-06-17 14:07:42 -04:00

1.9 KiB
Raw Blame History

vim.scheduler.ScheduledTask

The scheduled task object.

extends

vim.ExtensibleManagedObject

Attributes

info (vim.scheduler.ScheduledTaskInfo):

Information about the current scheduled task.

Methods

RemoveScheduledTask():

Removes the scheduled task.

Privilege:

ScheduledTask.Delete

Args:

Returns:

None

Raises:

vim.fault.InvalidState:

if the scheduled task is running.

ReconfigureScheduledTask(spec):

Reconfigures the scheduled task properties.

Privilege:

ScheduledTask.Edit

Args:
spec (vim.scheduler.ScheduledTaskSpec):

The new specification for the scheduled task.

Returns:

None

Raises:

vim.fault.InvalidState:

if the scheduled task is running.

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.

RunScheduledTask():

Runs the scheduled task immediately. The schedule for future runs remains in effect.

Privilege:

ScheduledTask.Run

Args:

Returns:

None

Raises:

vim.fault.InvalidState:

if the scheduled task is running already.