| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
description P | ScheduledTaskDescription |
Static descriptive strings used in scheduled tasks.
|
scheduledTask* P | ManagedObjectReference[]
to a ScheduledTask[] |
All available scheduled tasks.
|
Methods
Methods defined in this Managed Object |
---|
CreateObjectScheduledTask, CreateScheduledTask, RetrieveEntityScheduledTask, RetrieveObjectScheduledTask |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call. |
obj P | ManagedObjectReference |
The managed object for which the
scheduled task triggers an action. You can
schedule tasks on any managed object.
Since vSphere API 4.0 |
spec P | ScheduledTaskSpec |
The specification for the new scheduled task.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ScheduledTask | The scheduled task created by the operation. |
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. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call. |
entity P | ManagedObjectReference
to a 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.
Since 2.0 |
spec P | ScheduledTaskSpec |
The specification for the new scheduled task.
Since 2.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a ScheduledTask | The scheduled task created by the operation. |
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. |
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call. |
entity* P | ManagedObjectReference
to a ManagedEntity |
The entity. If null, all scheduled tasks are returned
for visible entities.
Since 2.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ScheduledTask[] | The scheduled tasks. |
Faults
Type | Description |
---|---|
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 |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the ScheduledTaskManager used to make the method call. |
obj* P | ManagedObjectReference |
The object. If not specified, all scheduled tasks are returned
for visible entities and visible ManagedObjects.
Since vSphere API 4.0 |
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a ScheduledTask[] | The scheduled tasks. |
Faults
Type | Description |
---|---|
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 |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |