vSphere Web Services API
|
| Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |
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
| Name | Type | Description |
|---|---|---|
| info | ScheduledTaskInfo |
Information about the current scheduled task.
|
| Properties inherited from ExtensibleManagedObject | ||
| availableField, value | ||
Methods
| Methods defined in this Managed Object |
|---|
| ReconfigureScheduledTask, RemoveScheduledTask, RunScheduledTask |
| Methods inherited from ExtensibleManagedObject |
| setCustomValue |
ReconfigureScheduledTask(reconfigure)
Reconfigures the scheduled task properties.- Required Privileges
- ScheduledTask.Edit
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ScheduledTask used to make the method call. |
| spec | ScheduledTaskSpec |
The new specification for the scheduled task.
Since 2.0 |
Return Value
| Type | Description |
|---|---|
| None | |
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
| Type | |
|---|---|
| None | |
Show WSDL type definition
RemoveScheduledTask(remove)
Removes the scheduled task.- Required Privileges
- ScheduledTask.Delete
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ScheduledTask used to make the method call. |
Return Value
| Type | Description |
|---|---|
| None | |
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
| Type | |
|---|---|
| None | |
Show WSDL type definition
RunScheduledTask(run)
Runs the scheduled task immediately. The schedule for future runs remains in effect.- Required Privileges
- ScheduledTask.Run
Parameters
| Name | Type | Description |
|---|---|---|
| _this | ManagedObjectReference | A reference to the ScheduledTask used to make the method call. |
Return Value
| Type | Description |
|---|---|
| None | |
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
| Type | |
|---|---|
| None | |
Show WSDL type definition
| Top of page | Local Properties | Local Methods | |
| Managed Object Types | Data Object Types | All Properties | All Methods |