1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
|
.. _vim.Task: ../../vim/Task.rst
.. _vim.fault.InvalidName: ../../vim/fault/InvalidName.rst
.. _vim.fault.InvalidState: ../../vim/fault/InvalidState.rst
.. _vim.fault.DuplicateName: ../../vim/fault/DuplicateName.rst
.. _vmodl.fault.InvalidArgument: ../../vmodl/fault/InvalidArgument.rst
.. _vim.ExtensibleManagedObject: ../../vim/ExtensibleManagedObject.rst
.. _vim.scheduler.ScheduledTaskInfo: ../../vim/scheduler/ScheduledTaskInfo.rst
.. _vim.scheduler.ScheduledTaskSpec: ../../vim/scheduler/ScheduledTaskSpec.rst
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.
|
