Name |
Type |
Description |
alarm
|
VcAlarm
|
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
|
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
|
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
|
VcEventFilterSpecByEntity
|
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
|
Number
|
The filter specification for retrieving events by chain ID.
If the property is not set, events with any chain ID are collected. |
eventTypeId
|
String[]
|
This property, if set, limits the set of collected events to those
specified types.
<p>
Note: if both <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcEventFilterSpec.html#type">VcEventFilterSpec</a> are specified, an
exception may be thrown by <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcEventFilterSpec.html#type">VcEventManager</a>.
<p>
The semantics of how eventTypeId matching is done is as follows:
<ul>
<li>If the event being collected is of type <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcEventFilterSpec.html#type">VcEventEx</a>
or <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcEventFilterSpec.html#type">VcExtendedEvent</a>, then we match against the
<code>eventTypeId</code> (for <code>EventEx</code>) or
<code>eventId</code> (for <code>ExtendedEvent</code>) member of the Event.
<li>Otherwise, we match against the type of the Event itself.
</ul>
If neither this property, nor <code>type</code>, is set, events are
collected regardless of their types. |
scheduledTask
|
VcScheduledTask
|
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
|
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. |
time
|
VcEventFilterSpecByTime
|
The filter specification for retrieving tasks by time.
If the property is not set, then events with any time stamp are collected. |
type
|
String[]
|
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.
<br/><i>As of vSphere API 4.0, use <a target="_blank" href="https://www.vmware.com/support/orchestrator/doc/vro-vsphere60-api/html/VcEventFilterSpec.html#eventTypeId">VcEventFilterSpec</a> instead.</i> |
userName
|
VcEventFilterSpecByUsername
|
The filter specification for retrieving events by username.
If the property is not set, then events belonging to any user are collected. |