Managed Object -
ScheduledTask(vim.scheduler.ScheduledTask)
- Property of
-
EventFilterSpec, ScheduledTaskEventArgument, ScheduledTaskInfo, ScheduledTaskManager, TaskFilterSpec, TaskReasonSchedule
- Returned by
-
CreateObjectScheduledTask, CreateScheduledTask, RetrieveEntityScheduledTask, RetrieveObjectScheduledTask
- Extends
-
ExtensibleManagedObject
- See also
-
ScheduledTaskInfo, ScheduledTaskSpec
- Since
- 2.0
Managed Object Description
The scheduled task object.
Properties
Methods
ReconfigureScheduledTask(reconfigure)
Reconfigures the scheduled task properties.
- Required Privileges
- ScheduledTask.Edit
Parameters
P
Return Value
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. |
InvalidState | Thrown if the scheduled task is running. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
RemoveScheduledTask(remove)
Removes the scheduled task.
- Required Privileges
- ScheduledTask.Delete
Parameters
Return Value
Faults
Type
|
Description
|
InvalidState | Thrown if the scheduled task is running. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
RunScheduledTask(run)
Runs the scheduled task immediately.
The schedule for future runs remains in effect.
- Required Privileges
- ScheduledTask.Run
Parameters
Return Value
Faults
Type
|
Description
|
InvalidState | Thrown if the scheduled task is running already. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Show WSDL type definition
© 2006-2021 VMware, Inc. All rights reserved.
Revision 2 AUG 2021 | Version 7.0U3