EventFilterSpec

EventFilterSpec

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.

AllOf

This class requires all of the following:

DataObject

JSON Example

{
    "_typeName": "string",
    "entity": {
        "_typeName": "string",
        "entity": {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        },
        "recursion": "string"
    },
    "time": {
        "_typeName": "string",
        "beginTime": "string",
        "endTime": "string"
    },
    "userName": {
        "_typeName": "string",
        "systemUser": false,
        "userList": [
            "string"
        ]
    },
    "eventChainId": 0,
    "alarm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "scheduledTask": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "disableFullMessage": false,
    "category": [
        "string"
    ],
    "type": [
        "string"
    ],
    "tag": [
        "string"
    ],
    "eventTypeId": [
        "string"
    ],
    "maxCount": 0,
    "delayedInit": false
}

entity

Optional

The filter specification for retrieving events by managed entity.

If the property is not set, then events attached to all managed entities are collected.

time

Optional

The filter specification for retrieving tasks by time.

If the property is not set, then events with any time stamp are collected.

userName

Optional

The filter specification for retrieving events by username.

If the property is not set, then events belonging to any user are collected.

integer As int32 As int32

eventChainId

Optional

The filter specification for retrieving events by chain ID.

If the property is not set, events with any chain ID are collected.

alarm

Optional

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.

scheduledTask

Optional

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.

boolean

disableFullMessage

Optional

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.

array of string

category

Optional

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.

array of string

type

Optional

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.

array of string

tag

Optional

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.

array of string

eventTypeId

Optional

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.

integer As int32 As int32

maxCount

Optional

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.

boolean

delayedInit

Optional

This property, if set, specifies whether latest page should be populated on Collector creation.

True for delayed population and false for immediate. If unset, the latest page is populated immediately.

Since: vSphere API Release 8.0.3.0

Property Of

ArrayOfEventFilterSpec