MODULE-IDENTITY, OBJECT-TYPE, OBJECT-IDENTITY, Unsigned32,
NOTIFICATION-TYPE
                                                    FROM SNMPv2-SMI
                                                      -- RFC 2578
RowStatus, StorageType, TimeStamp, TruthValue, VariablePointer
                                                    FROM SNMPv2-TC
                                                      -- RFC 2579
MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
                                                    FROM SNMPv2-CONF
                                                      -- RFC 2580
SnmpAdminString, SnmpSecurityLevel, SnmpSecurityModel
                                                    FROM SNMP-FRAMEWORK-MIB
                                                      -- RFC 3411
ITSCounter32, ITSOerString, ITSPositive8, ITSPositive16, ITSRelativeRowPointer, 
ITSUnsigned8, ITSUnsigned16
                                                    FROM ISO26048-1-FieldDevice
fdGlobalMIB, fdAdminGlobal, fdGlobalConformance
                                                    FROM ISO26048-1-Global
fdOwnerEntry, fdOwnerIndex
                                                    FROM ISO26048-1-Owner
  

This MIB defines a mechanism by which a field device can be configured to manage the transmission of notifications to one or more managers in an efficient manner. Copyright (C) International Organization for Standardization (ISO). This MIB module is part of ISO 26048-1; see ISO 26048-1 for full legal notices.

A node defining management information related to the administration of the notification feature.

An indication of whether the filed device is allowed to generate Notification Events and send Notification Packets. Changing the value to false shall result in all queued Notification Packets on all channels to be cleared, all buffered Notification Events on all channels to be cleared, and will prevent the generation of any new Notification Events from any Notification Factory.

The number of Notification Events generated by this context since the last initialization (i.e., reboot).

The number of Notification Packets generated by this context since the last initialization (i.e., reboot).

The number of Notification Packets generated by any Notification Channel that have been dropped prior to transmission for any reason since the last initialization (i.e., reboot).

The number of times any notification channel has transmitted an inform packet and has not received an acknowledgement in a timely fashion since the last initialization (i.e., reboot).

A table containing configuration rights for the notification-realted tables for specific owners.

A row in the fdOwnerNotifyTable.

The maximum number of rows that this owner is allowed to manage within the fdNotifyFactoryTable at any point in time.

The maximum number of rows that this owner is allowed to manage within the fdNotifyChannelTable at any point in time.

The number of times any notification factory associated with this owner has generated a notification event since the last discontinuity for this owner. The last discontinuity is indicated by fdOwnerTimeStamp.

The number of times any notification channel associated with this owner has transmitted a notification packet since the last discontinuity for this owner. The last discontinuity is indicated by fdOwnerTimeStamp.

The number of Notification Packets generated by any Notification Channel associated with this owner that have been dropped prior to transmission for any reason since the last discontinuity for this owner. The last discontinuity is indicated by the fdOwnerTimeStamp.

The number of times any notification channel associated with this owner has transmitted an inform packet and has not received an acknowledgement in a timely fashion since the last discontinuity for this owner. The last discontinuity is indicated by fdOwnerTimeStamp.

An indication of the notification features that the field device supports.

The maximum size, in octets, that the field device supports for a notification.

A table of notification factories that define how notifications are to be generated and sent.

The definition of a notification factory.

The index of this notification factory within the scope of fdOwnerIndex. The fdOwnerIndex and this value are transmitted as a part of the Notification Event to identify the notification factory used to generate the notification. NOTE: If desired, multiple notification factories can be configured exactly the same with the different values for fdOwnerIndex and fdNotifyFactoryIndex serving as an indicator of what event initiated the notification. For example, two different conditional triggers might be defined, each calling a different action group, which call different notification factories. The resulting notifications would be transmitted with different index values even if the configuration of the two factories were identical. It is the responsibility of the SNMP Target to understand the configuration of the notification factory, including the value of fdNotifyFactoryObjectID so that it can successfully decode the associated dataValue field of the received notification.

A textual description of this notification factory.

The management context from which to obtain fdNotifyFactoryObjectID.

The object identifier of the object instance who's value is to be included in the Notification Event. When creating a Notification Event, the value shall be obtained using the security credentials of the SNMP Target to which this Notification Event is to be sent. If the object instance does not exist within the defined MIB view, an SNMP NULL shall be returned instead.

The maximum number of Notification Events in the notification channel buffer that shall cause the notification channel to group all Notification Events in the buffer and immediately send to the fdNotifyChannelEntry notify process. If the value of this object is equal to one (1), the Notification Event shall be immediately sent to the fdNotifyChannelEntry notify process as an independent Notification (i.e., without impacting the trap or inform buffer). If the value of this object is greater than one (1), the Notification Event shall be immediately sent to one of the two buffers associated with the Notification Channel. If fdNotifyFactoryAckEnabled is true, the Notification Event shall be sent to the inform buffer; if fdNotifyFactoryAckEnabled is false, the Notification Event shall be sent to the trap buffer. NOTE: This size will be exceeded if the Notification Event is added to a buffer that already has the indicated number of Notification Events

The maximum time, in seconds, that a Notification Event generated by this notification factory may be held within its aggregation buffer prior to initiating the fdNotifyChannelEntry notify process. If the value of fdNotifyFactoryAggMaxEvents is one (1), the value of this object is ignored; otherwise, the Notification Event shall be added to the appropriate notification buffer (as defined by fdNotifyFactoryAggMaxEvents). When the Notification Event is added to the buffer, a countdown timer shall start for the nunber of seconds defined by this object. If the countdown timer reaches zero, all Notification Events in the buffer shall be grouped immediately into a single, aggregated Notification and immediately sent to the fdNotifyChannelEntry notify process. Once all Notification Events in the buffer have been grouped together, all countdown timers for the buffer shall be deleted. If the value of this object is zero (0), the above notification process shall start immediately.

An indication of whether the Notification Channel should queue the independent Notification if the channel is in anti-streaming mode when the Notification is generated. When adding a message to a notification queue, the notification channel shall determine the number of messages in the queue and if the number of messages in the queue is equal to or exceeds the configured maximum queue depth, the Notification Channel shall: b) delete the oldest notifications in the queue until the number remaining in the queue is less than the maximum queue depth; c) add the new notification message to the end of the notification queue; d) at the top of every minute, determine if there are any notifications in the notification queue. If so, it shall transmit each notification in the queue, in order from oldest to newest, until either the queue is empty or the anti-streaming rate has been met.

An indication of whether the SNMP Target will be requested to acknowledge the notification. If the value of this object is true and the value of the value of fdNotifyFactoryAggMaxEvents is one, the independent Notification Event shall be sent as an SNMP inform message. If the value of this object is true and the value of the value of fdNotifyFactoryAggMaxEvents greater than one, the Notification Event shall be be added to the inform buffer. If the value of this object is false and the value of the value of fdNotifyFactoryAggMaxEvents is one, the independent Notification Event shall be sent as an SNMP trap message. If the value of this object is false and the value of the value of fdNotifyFactoryAggMaxEvents greater than one, the Notification Event shall be be added to the trap buffer.

A pointer to the fdNotifyChannelEntry that identifies the notification channel to which Notification Events created by this Notification Factory are to be sent. The RELATIVE OID has a root of fdNotifyChannelTarget. It is expected that the fdOwnerIndex of the notification channel will typically be the same as that for the notification factory, but the design allows for a more complex relationship. For example, a manager might want to define more than 255 notification factories while assigning them to a common set of notification channels. In this case, the one manager might be associated with two fdOwnerIndex values but some of the notification factories using the second fdOwnerIndex might be configured to send notifications to a notification channel using the first fdOwnerIndex. As long as the permissions are properly configured, this is allowed.

The number of Notifications Events generated by this entry in the table since the last discontinuity. The last discontinuity is indicated by the fdNotifyFactoryTimeStamp.

The value of sysUpTime at the last discontinuity of any of the counters associated with this row of the fdNotifyFactoryTable. Discontinuities occur when the row is created.

The security model used to activate this row of the fdNotifyFactoryTable and to access the object referenced by fdNotifyFactoryObjectID.

The security level used to activate this row of the fdNotifyFactoryTable and to access the object referenced by fdNotifyFactoryObjectID.

The security name used to activate this row of the fdNotifyFactoryTable and to access the object referenced by fdNotifyFactoryObjectID.

The type of memory used to store this entry in the table.

The status of this conceptual row. Any attempt to modify any other read- create object within this conceptual row while the value of this object is active (1) shall result in an inconsistentValue error. This object shall indicate notReady when fdNotifyFactoryAggMaxEvents is greater than one and fdNotifyFactoryQueueEnabled is true. This object shall indicate notReady when fdNotifyFactoryAggMaxEvents is greater than fdNotifyChannelMaxSize for its assigned notification channel.

A table containing information on how to generate, manage, and send notification packets to a specified SNMP Target.

One row in the fdNotifyChannelTable. In addition to the columns defined by FdNotifyChannelEntry, each row is associated with an inform buffer, a trap buffer, a size limit for each buffer, and a shared queue (shared by informs and traps). This additional information is not accessible via SNMP and therefore is not associated with any OBJECT-TYPE definitions. Implementations are allowed to modify the internal design as long as they conform to the observable specifications defined in this MIB. Inputs Notification Events shall be received from a fdNotifyFactory either as an independent Notification (not impacting either buffer) or as an event to be added to either the channel's inform buffer or the trap buffer. When a Notification is added to a buffer, a new countdown timer shall be created for the buffer with an initial time of fdNotifyFactoryAggregationTime and the buffer's size limit will be set to the smaller of its current size limit and that identified by the fdNotifyFactoryAggMaxEvents for the newly added event. Independent Notifications shall be immediately sent; buffered events shall be grouped into an aggregate notification and sent the earlier of when: a) one of the buffer's aggregation timers expire; or b) the buffer's size limit is reached or exceeded Once the events in a buffer are aggregated into a Notification, the buffer is cleared, the buffer size limit is reset to its maximum value, and all countdown timers for the buffer are deleted. Notify Process When a new Notification is to be sent, the Notification Channel shall: a) increment the notification counter; b) finalize the serialization of the Notification; c) determine the number of notification messages (traps and informs) sent during this minute and: i) if the number of notification messages sent during the minute is less than the anti-streaming rate defined for the notification channel, the serialized notification message shall be sent to the SNMP target using its defined parameters. ii) the newly serialized notification shall be placed into the notification queue for the channel if - the number of notification messages sent during the minute is equal to or exceeds the anti-streaming rate defined for the notification channel, - the Notification is an independent Notification, and - the value of its fdNotifyFactoryQueueEnabled is true; or iii) otherwise, the newly serialized notification shall be dropped and the counter of lost notifications shall be incremented by one.

A numeric index that identifies a unique notification channel for the specified fdOwnerIndex. The fdOwnerIndex and this value are transitted with the notification to allow the receiving SNMP Target (manager) to determine which notification channel sent the notification.

A textual description of this notification channel.

The unique identifier associated with the snmpTargetAddrEntry to which the notification should be sent.

The number of Notification Packets that the Notification Channel will allow within the queue (i.e., when the anti-streaming rate has been exceeded).

The maximum number of notification Packets that this Notification Channel will send within any minute (from local top of minute to next top of minute). Notification Packets received for transmission after this number has been reached shall be queued or dropped according to the rules defined in ISO/TS 20684-4, Section 6.2.4.2 and 6.2.4.3.

The maximum size of any notification allowed to be sent on this channel. This value should normally be set to the same value as fdNotifiesMaxSize, unless the target to which the notifications are to be sent supports a lower threshold.

The number of Notification Packets generated by this Notification Channel since the last discontinuity. The last discontinuity is indicated by the fdNotifyChannelTimeStamp. The fdNotifyChannelSeqNum encoded into the FdNotificationPacket message (see fdNotifyData) shall equal the lower two octets of this value once it is incremented for the new notification.

The number of Notification Packets generated by this Notification Channel that have been dropped prior to transmission for any reason since the last discontinuity for this channel. The last discontinuity is indicated by the fdNotifyChannelTimeStamp.

The number of times this notification channel has transmitted an inform packet and has not received an acknowledgement in a timely fashion since the last discontinuity for this channel. The last discontinuity is indicated by the fdNotifyChannelTimeStamp.

The value sysUpTime at the last discontinuity of the counters associated with this row of the fdNotifyChannelTable. Discontinuities occur when the row is created.

A command that, when set to true, will clear the anti-streaming queue of notifications that are awaiting transmission. The fdNotifyChannelDroppedCount shall be incremented for each notification cleared from the buffer when this occurs. Clearing the queue will not affect the buffers managed by the Notification Aggregator.

The storage type used to store the definition of this Notification Channel.

The status of this conceptual row. Any attempt to modify any read-create object within this conceptual row, other than this object and fdNotifyChannelClearQueue, while the value of this object is active (1) shall result in an inconsistentValue error.

The data contained in the most recent notification generated by any Notification Channel. This object packages data related to (potentially) multiple events into a single compact structure. The contents of this object shall be defined by the following ASN.1 structure encoded with the Octet Encoding Rules (OER). FdNotificationPacket ::= SEQUENCE { fdNotifyChannelIndex INTEGER (0..255), fdNotifyChannelSeqNum INTEGER (0..255), fdNotifyEvents FdNotifyEvents } FdNotifyEvents ::= SEQUENCE OF FdNotifyEvent FdNotifyEvent ::= SEQUENCE { fdOwnerIndex INTEGER (0..255), -- for NotifyFactory fdNotifyFactoryIndex INTEGER (0..65535), eventTimestamp ITSDailyTimestamp, logarithmicLatency ITSUnsigned8, data FdNotifyData } FdNotifyData ::= CHOICE { dataValue ITSOerString, dataError ITSPduErrorStatus (-128..127)} The fields starting with 'fd' represent the object types with the corresponding names; the object instances are those related to the most recent notification generated. The value of fdNotifySeqNum shall be the value of the object after the new notification packet is generated. fdOwnerIndex refers to the instance associated with the fdNotifyFactoryIndex; any ambiguity in the meaning of fdNotifyChannelIndex (i.e., in isolation of its associated fdOwnerIndex) can be resolved by determining the value of: fdNotifyFactoryChannel.fdOwnerIndex.fdNotifyFactoryIndex Such ambiguities will only arise in configurations that have factories that reference channels with different owners, and even then it is expected that most such ambiguities can be avoided with reasonable planning of index assignments. Strictly speaking, the packet does not need to contain the channel index, but its inclusion early in the packet might assist implementations in prioritizing the processing of notifications. The eventTimestamp represents the UTC time-of-day at which the trigger that initiated the notification event was fired. The notificationLatency represents the base 2 logarithm of the number of milliseconds that elapsed between the eventTimeStamp and the time at which the collection of data finished, multiplied by 10 and rounded to the nearest integer value. For example, if exactly one second (1000 ms) elapsed between the detection of the event and the collection of the notification data, the notification latency value would be round(log2(1000) * 10) = round(9.966 * 10) = round(99.66) = 100. A latency value of 255 represents a latency in excess of 12.7 hours. The dataValue represents the OER encoded value of the object referenced by fdNotifyFactoryObjectID as obtained using the fdNotifyFactoryObjectContext and the security details associated with the SNMP Target of the Notification Channel identified by fdNotifyChannelOwner and fdNotifyChannelName. If the request for this data fails using this security information, the data field shall contain the dataError value instead to indicate the type of failure.

A node defining notifications for the fdNotifyMIB.

The notification used by each Notification Channel. The fdNotificationData object shall be populated with the data to be sent with the notification immediately prior to generating the notification.

A node containing conformance statements related to the fdNotifyMIB, as defined in ISO/TS 26048-1.

A node for compliance statements for the fdNotifyMIB.

A node for group definitions related to fdNotifyMIB.

The conformance statement for the field device notification MIB.

Management information for the administration of the entire notification feature.

Management information for the notification factory.

Management information for the notification channel.

Management information that defines the data contained within a notification.