Network Manager event data fields
When events are generated in Network Manager, the event data is inserted into a number of fields (or columns) in the Network Manager tables. Although each event uses only a subset of the possible fields, a number of fields are common to all event types.
The following table lists all the Network Manager field names that are available for use in the probe rules file, and describes the event data stored in each field. The table also identifies which of the Network Manager fields are common to all events, and therefore always available in the rules file.
| Network Manager field name | Field content | Always available? |
|---|---|---|
| Description | A brief description of the event. | Yes |
| Domain | The current domain. If Network Manager is configured for failover mode, this will be the primary domain. |
Yes (provided the map file is not modified) |
| EntityName | For network events, this is the entityName field
from the NCIM entityData table for the entity against which the event
is raised. For status events, this is always the name of the domain about which the event is generated. |
Yes |
| EventName | The event identifier. For example, ItnmDiscoPhase. | Yes |
| ExtraInfo_ACCESSIPADDRESS | If the main node or interface entity identified by the EntityName input field has a directly-accessible IP address (the accessIPAddress field from the NCIM interface or chassis tables), then it is supplied here. Applicable to network events only. | No |
| ExtraInfo_AGENT | The agent responsible for a discovery agent (ItnmDiscoAgentStatus) event. | Yes (for ItnmDiscoAgentStatus events) |
| ExtraInfo_ALERTGROUP | The alert group of the event. For Network Manager status events, the alert group is ITNM Status, and for network events, the value is ITNM Monitor. | Yes |
| ExtraInfo_ENTITYCLASS | The name of class assigned to the entity, as identified the NCIM entityClass and classMembers tables. | Yes (for network and ItnmEntityCreation events) |
| ExtraInfo_ENTITYTYPE | The type of the entity, as defined in the NCIM entityType table. | Yes (for network events) |
| ExtraInfo_LocalPriObj | Provides a value for the LocalPriObj field in the alerts.status record. This field has the same value as the deprecated ExtraInfo_EventSnmpIndex field, except that it is prefixed by an identifier for the MIB entity being polled; for example ifEntry, bgpPeerEntry. | Yes (for network events) |
| ExtraInfo_EVENTTYPE | The type of the event raised by Network Manager.
The values are as follows:
|
Yes |
| ExtraInfo_FINDER | The finder responsible for a discovery finder (ItnmDiscoFinderStatus) event. | Yes (for ItnmDiscoFinderStatus events) |
| ExtraInfo_ifIndex | For events raised against an interface with an ifIndex value in the NCIM interface table, that value is given here. Applicable only to network events against interfaces. | No |
| ExtraInfo_IFALIAS | For events raised against interfaces, this field contains the ifAlias value, if known. Applicable only to network interface polls. | No |
| ExtraInfo_IFDESCR | For events raised against interfaces, this field contains the ifDescr value, if known. Applicable only to network interface polls. | No |
| ExtraInfo_IFNAME | For events raised against interfaces, this field contains the ifName value, if known. Applicable only to network interface polls. | No |
| ExtraInfo_IFTYPESTRING | For events raised against interfaces, this field contains the string representation of the ifType value. Applicable only to network interface polls. | No |
| ExtraInfo_MAINNODEADDRESS | The management interface of the main node containing the entity, as identified by the accessIPAddress field of the NCIM chassis table. Applicable only to network and ItnmEntityCreation events. | Yes (for network events) |
| ExtraInfo_MAINNODEENTITYID | The entityId field from the NCIM entityData table for the main node, as identified by the accessIPAddress field of the NCIM chassis table. Applicable only to network events. | Yes (for network events) |
| ExtraInfo_MAINNODEENTITYNAME | The entityName field from the NCIM entityData table for the main node, as identified in NCIM. Applicable only to network events. | Yes (for network events) |
| ExtraInfo_MONITOREDENTITYID | The entityId field from the NCIM entityData table for the entity against which the event is raised. Applicable only to network and ItnmEntityCreation events. | No |
| ExtraInfo_MONITOREDINSTID | A record in the ncpolldata.monitoredInstance table. | No |
| ExtraInfo_NEWPHASE | The discovery phase that has started. Applicable only to discovery phase (ItnmDiscoPhase) events. | Yes (for discovery phase events) |
| ExtraInfo_OLDPHASE | The discovery phase that has completed. Applicable only to discovery phase (ItnmDiscoPhase) events. | Yes (for discovery phase events) |
| ExtraInfo_POLICYNAME | The name of the polling policy that resulted in the event. | Yes (for network events) |
| ExtraInfo_PID | The process ID of the affected Network Manager service. Applicable only to ItnmServiceState events. | Yes (for service state events) |
| ExtraInfo_REMOTEDOMAIN | The name of the remote domain. Applicable only to ItnmFailoverConnection events. | Yes (for failover connection events) |
| ExtraInfo_sysContact | If available, the sysContact value is given for ItnmEntityCreation events only. | No |
| ExtraInfo_sysLocation | If available, the sysLocation value is given for ItnmEntityCreation events only | No |
| ExtraInfo_sysObjectId | If available, the sysObjectId value is given for ItnmEntityCreation events only | No |
| ExtraInfo_SERVICE | The name of the affected Network Manager service. Applicable only to ItnmServiceState events. | Yes (for service state events) |
| ExtraInfo_SNMPSTATUS | A numerical SNMP status code. | Yes (for NmosSnmpPollFail events) |
| ExtraInfo_SNMPSTATUSSTRING | A human-readable indication of the SNMP failure state. | Yes (for NmosSnmpPollFail events) |
| ExtraInfo_SOURCE | The name of the process from which the event originated. | Yes |
| ExtraInfo_STITCHER | The stitcher responsible for a discovery stitcher (ItnmDiscoStitcherStatus) event. | Yes (for ItnmDiscoStitcherStatus events) |
| Severity | The severity level of the event. The severity is a non-zero value. | Yes |