Previous page

Next page

Locate page in Contents

Print this page

eventType

Summary:

Contains a system event information.

Type specification:

Name

Min/Max

Type

Description

eid

1..1

eid_type

The ID of the server that generated the event.

time

1..1

datetime_type

The time at which the event was generated.

source

1..1

string

The name of the event source -- a plug-in or an operator name.

category

1..1

string

The category of the event.

sid

0..1

sidType

The user SID (security ID). Identifies the active user at the time the event was generated.

count

1..1

int

Message counter. Counts messages received from the same source from the last server restart.

id

1..1

guid_type

A universally unique message ID.

info

1..1

infoType

Event description.

data

0..1

 

Event type-specific data.

{

 

 

 

event data

1..1

event_dataType

 

event_data

1..1

event_dataType

Depending on the event type, the actual data type returned will be one of the descendants of event_dataType. The data type can be determined by comparing the value of the category element (above) and the event category described in the descendants of event_dataType.

}

 

 

 

Description:

This structure is returned by the calls that provide information about system events and alerts. The elements in the beginning of the structure are common to all event types and provide the basic event information. The data element contains the event or alert type-specific data. Depending on the type of the event or alert, the data type of the event_data element will be one of the descendants of event_dataType. Since you might not know in advance the type of the event, you will have to determine the data type before you can parse the message and handle it properly. Consider the following example.

Let's say that your client program receives an eventType structure from Agent as a result of subscription or an on-demand request. Let's also say that the category element contains the "env_status" value. If you look at the event type definitions, you'll see that "env_status" is the category of the env_status_event_dataType (note the env_status entry in the Event type subsection). What this means is that in this particular XML response, the data type of the event_data element (see table above) is env_status_event_dataType, not the base event_dataType as shown in the table above.

Please send us your feedback on this help page