# Data Object - EventFilterSpec(vim.event.EventFilterSpec)

Parameter to
  CreateCollectorForEvents, QueryEvents
Extends
  DynamicData
See also
  Alarm, EventFilterSpecByEntity, EventFilterSpecByTime, EventFilterSpecByUsername, ScheduledTask
Since
  2.0

## Data Object Description

Event filter used to query events in the history collector database. The client creates an event history collector with a filter specification, then retrieves the events from the event history collector.

Properties

Name | Type | Description
--- | --- | ---
alarm* | ManagedObjectReference to a Alarm | This property, if set, limits the set of collected events to those associated with the specified alarm. If the property is not set, events are collected regardless of their association with alarms.
category* | xsd:string[] | This property, if set, limits the set of collected events to those associated with the specified category. If the property is not set, events are collected regardless of their association with any category. "category" here is the same as Event.severity.
disableFullMessage* | xsd:boolean | Flag to specify whether or not to prepare the full formatted message for each event. If the property is not set, the collected events do not include the full formatted message.
entity* | EventFilterSpecByEntity | The filter specification for retrieving events by managed entity. If the property is not set, then events attached to all managed entities are collected.
eventChainId* | xsd:int | The filter specification for retrieving events by chain ID. If the property is not set, events with any chain ID are collected.
eventTypeId* | xsd:string[] | This property, if set, limits the set of collected events to those specified types. Note: if both eventTypeId and type are specified, an exception may be thrown by CreateCollectorForEvents. The semantics of how eventTypeId matching is done is as follows: If the event being collected is of type EventEx or ExtendedEvent, then we match against the `eventTypeId` (for `EventEx`) or `eventId` (for `ExtendedEvent`) member of the Event. Otherwise, we match against the type of the Event itself. If neither this property, nor `type`, is set, events are collected regardless of their types. Since vSphere API 4.0
maxCount* | xsd:int | This property, if set, specifies the maximum number of returned events. If unset, the default maximum number will be used. Using this property with CreateCollectorForEvents is more efficient than a call to SetCollectorPageSize. Since vSphere API 6.5
scheduledTask* | ManagedObjectReference to a ScheduledTask | This property, if set, limits the set of collected events to those associated with the specified scheduled task. If the property is not set, events are collected regardless of their association with any scheduled task.
tag* | xsd:string[] | This property, if set, limits the set of filtered events to those that have it. If not set, or the size of it 0, the tag of an event is disregarded. A blank string indicates events without tags. Since vSphere API 4.0
time* | EventFilterSpecByTime | The filter specification for retrieving tasks by time. If the property is not set, then events with any time stamp are collected.
type* | xsd:string[] | Deprecated. As of vSphere API 4.0, use eventTypeId instead. This property, if set, limits the set of collected events to those specified types. If the property is not set, events are collected regardless of their types.
userName* | EventFilterSpecByUsername | The filter specification for retrieving events by username. If the property is not set, then events belonging to any user are collected.
Properties inherited from DynamicData
None

*Need not be set
Show WSDL type definition
<complexType xmlns="http://www.w3.org/2001/XMLSchema" xmlns:sms="urn:sms" name="EventFilterSpec"> <complexContent> <extension base="sms:DynamicData"> <sequence> <element name="entity" type="sms:EventFilterSpecByEntity" minOccurs="0"/> <element name="time" type="sms:EventFilterSpecByTime" minOccurs="0"/> <element name="userName" type="sms:EventFilterSpecByUsername" minOccurs="0"/> <element name="eventChainId" type="xsd:int" minOccurs="0"/> <element name="alarm" type="sms:ManagedObjectReference" minOccurs="0"/> <element name="scheduledTask" type="sms:ManagedObjectReference" minOccurs="0"/> <element name="disableFullMessage" type="xsd:boolean" minOccurs="0"/> <element name="category" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <element name="type" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <element name="tag" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <element name="eventTypeId" type="xsd:string" minOccurs="0" maxOccurs="unbounded"/> <element name="maxCount" type="xsd:int" minOccurs="0"/> </sequence> </extension> </complexContent> </complexType>