vSphere Web Services API
|
| Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |
Data Object - TaskFilterSpec(vim.TaskFilterSpec)
- Parameter to
- CreateCollectorForTasks, CreateCollectorWithInfoFilterForTasks
- Extends
- DynamicData
- See also
- Alarm, ScheduledTask, TaskFilterSpecByEntity, TaskFilterSpecByTime, TaskFilterSpecByUsername, TaskInfoState
- Since
- 2.0
Data Object Description
This data object type defines the specification for the task filter used to query tasks in the history collector database. The client creates a task history collector with a filter specification, then retrieves the tasks from the task history collector.Properties
| Name | Type | Description |
|---|---|---|
| activationId* | xsd:string[] |
This property, if provided, limits the set of collected tasks to those
associated with the specified activation Ids.
Since vSphere API Release 6.0 |
| alarm* | ManagedObjectReference
to a Alarm |
This property, if provided, limits the set of collected tasks to those
associated with the specified alarm.
If not provided, tasks are collected regardless of their association with alarms.
|
| entity* | TaskFilterSpecByEntity |
The filter specification for retrieving tasks by managed entity.
If not provided, then the tasks attached to all managed entities are
collected.
|
| eventChainId* | xsd:int[] |
The filter specification for retrieving tasks by chain ID. If it is set,
tasks not with the given eventChainId will be
filtered out. If the property is not set, tasks' chain ID is disregarded
for filtering purposes.
Since vSphere API Release 4.0 |
| parentTaskKey* | xsd:string[] |
The filter specification for retrieving tasks by
parentTaskKey. If it is set, tasks not with the
given parentTaskKey(s) will be filtered out. If the property is not set,
tasks' parentTaskKey is disregarded for filtering purposes.
Since vSphere API Release 4.0 |
| rootTaskKey* | xsd:string[] |
The filter specification for retrieving tasks by
rootTaskKey. If it is set, tasks not with the
given rootTaskKey(s) will be filtered out. If the property is not set,
tasks' rootTaskKey is disregarded for filtering purposes.
Since vSphere API Release 4.0 |
| scheduledTask* | ManagedObjectReference
to a ScheduledTask |
This property, if provided, limits the set of collected tasks to those
associated with the specified scheduled task.
If not provided, tasks are collected regardless of their association with any
scheduled task.
|
| state* | TaskInfoState[] |
This property, if provided, limits the set of collected tasks by their states.
Task states are enumerated in state.
If not provided, tasks are collected regardless of their state.
|
| tag* | xsd:string[] |
The filter specification for retrieving tasks by
changeTag. If it is set, tasks not with the given tag(s)
will be filtered out. If the property is not set, tasks' tag is disregarded for
filtering purposes. If it is set, and includes an empty string, tasks without a
tag will be returned.
Since vSphere API Release 4.0 |
| time* | TaskFilterSpecByTime |
The filter specification for retrieving tasks by time.
If not provided, then the tasks with any time stamp are collected.
|
| userName* | TaskFilterSpecByUsername |
The filter specification for retrieving tasks by user name.
If not provided, then the tasks belonging to any user are collected.
|
| Properties inherited from DynamicData | ||
| None | ||
Show WSDL type definition
| Top of page | Local Properties | ||
| Managed Object Types | Data Object Types | All Properties | All Methods |