| Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |
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:
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 |
Top of page | Local Properties | ||
Managed Object Types | Data Object Types | All Properties | All Methods |