Imported Upstream version 0.4.8
[platform/upstream/libsmi.git] / mibs / ietf / APPN-TRAP-MIB
1 APPN-TRAP-MIB DEFINITIONS ::= BEGIN
2
3 IMPORTS
4
5         Counter32, OBJECT-TYPE, MODULE-IDENTITY,
6         NOTIFICATION-TYPE
7                 FROM SNMPv2-SMI
8
9         MODULE-COMPLIANCE, OBJECT-GROUP, NOTIFICATION-GROUP
10                 FROM SNMPv2-CONF
11
12         appnMIB, appnIsInP2SFmdPius, appnIsInS2PFmdPius,
13         appnIsInP2SNonFmdPius, appnIsInS2PNonFmdPius,
14         appnIsInP2SFmdBytes, appnIsInS2PFmdBytes,
15         appnIsInP2SNonFmdBytes, appnIsInS2PNonFmdBytes,
16         appnIsInSessUpTime, appnObjects,
17         appnLocalTgOperational, appnLocalTgCpCpSession,
18         appnPortOperState, appnLsOperState,
19         appnCompliances, appnGroups
20                  FROM APPN-MIB
21
22         dlurDlusSessnStatus
23                  FROM APPN-DLUR-MIB;
24
25 appnTrapMIB MODULE-IDENTITY
26         LAST-UPDATED  "9808310000Z" -- August 31, 1998
27         ORGANIZATION  "IETF SNA NAU MIB WG / AIW APPN MIBs SIG"
28         CONTACT-INFO
29
30                 "
31                         Bob Clouston
32                         Cisco Systems
33                         7025 Kit Creek Road
34                         P.O. Box 14987
35                         Research Triangle Park, NC 27709, USA
36                         Tel:    1 919 472 2333
37                         E-mail: clouston@cisco.com
38
39                         Bob Moore
40                         IBM Corporation
41                         4205 S. Miami Boulevard
42                         BRQA/501
43                         P.O. Box 12195
44                         Research Triangle Park, NC 27709, USA
45                         Tel:    1 919 254 4436
46                         E-mail: remoore@us.ibm.com
47                 "
48       DESCRIPTION
49                 "This MIB module defines notifications to be generated by
50                 network devices with APPN capabilities.  It presupposes
51                 support for the APPN MIB.  It also presupposes
52                 support for the DLUR MIB for implementations
53                 that support the DLUR-related groups."
54 ::= { appnMIB 0 }
55
56 -- *********************************************************************
57 -- Notifications
58 -- *********************************************************************
59
60 appnIsrAccountingDataTrap NOTIFICATION-TYPE
61       OBJECTS  {
62                 appnIsInP2SFmdPius,
63                 appnIsInS2PFmdPius,
64                 appnIsInP2SNonFmdPius,
65                 appnIsInS2PNonFmdPius,
66                 appnIsInP2SFmdBytes,
67                 appnIsInS2PFmdBytes,
68                 appnIsInP2SNonFmdBytes,
69                 appnIsInS2PNonFmdBytes,
70                 appnIsInSessUpTime
71                }
72       STATUS current
73       DESCRIPTION
74           "When it has been enabled, this notification is generated by an
75           APPN node whenever an ISR session passing through the node is
76           taken down, regardless of whether the session went down
77           normally or abnormally.  Its purpose is to allow a management
78           application (primarily an accounting application) that is
79           monitoring the ISR counts to receive the final values of these
80           counts, so that the application can properly account for the
81           amounts the counts were incremented since the last time the
82           application polled them.  The appnIsInSessUpTime object
83           provides the total amount of time that the session was active.
84
85           This notification is not a substitute for polling the ISR
86           counts.  In particular, the count values reported in this
87           notification cannot be assumed to be the complete totals for
88           the life of the session, since they may have wrapped while the
89           session was up.
90
91           The session to which the objects in this notification apply is
92           identified by the fully qualified CP name and PCID that make up
93           the table index.  An instance of this notification will contain
94           exactly one instance of each of its objects, and these objects
95           will all belong to the same conceptual row of the
96           appnIsInTable.
97
98           Generation of this notification is controlled by the same
99           object in the APPN MIB, appnIsInGlobeCtrAdminStatus, that
100           controls whether the count objects themselves are being
101           incremented."
102       ::= { appnTrapMIB 1 }
103
104 appnLocalTgOperStateChangeTrap NOTIFICATION-TYPE
105       OBJECTS  {
106                 appnLocalTgTableChanges,
107                 appnLocalTgOperational
108                }
109       STATUS current
110       DESCRIPTION
111           "When it has been enabled, this notification makes it possible
112           for an APPN topology application to get asynchronous
113           notifications of local TG operational state changes,
114           and thus to reduce the frequency with which it polls
115           for these changes.
116
117           This notification is sent whenever there is a change to
118           the appnLocalTgOperational object in a row of the
119           appnLocalTgTable.  This notification is only sent for row
120           creation if the row is created with a value of 'true' for
121           appnLocalTgOperational.  This notification is only sent for
122           row deletion if the last value of appnLocalTgOperational was
123           'true'.  In this case, the value of appnLocalTgOperational
124           in the notification shall be 'false', since the deletion of
125           a row indicates that the TG is no longer operational.
126
127           The notification is more than a simple 'poll me now' indication.
128           It carries both a count of local TG topology changes, and the
129           current operational state itself.  The count of changes allows an
130           application to detect lost notifications, either when polling
131           or upon receiving a subsequent notification, at which point it
132           knows it must retrieve the entire appnLocalTgTable again.
133           This is the same count as used in the appnLocalCpCpStateChangeTrap.
134           A lost notification could indicate a local TG CP-CP session state
135           change or an operational state change.
136
137           Generation of this notification is controlled by the
138           appnTrapControl object."
139
140       ::= { appnTrapMIB 2 }
141
142 appnLocalTgCpCpChangeTrap NOTIFICATION-TYPE
143       OBJECTS  {
144                 appnLocalTgTableChanges,
145                 appnLocalTgCpCpSession
146                }
147       STATUS current
148       DESCRIPTION
149           "When it has been enabled, this notification makes it possible
150           for an APPN topology application to get asynchronous
151           notifications of local TG control-point to control-point (CP-CP)
152           session state changes, and thus to reduce the
153           frequency with which it polls for these changes.
154
155           This notification is sent whenever there is a change to
156           the appnLocalTgCpCpSession object but NOT the
157           appnLocalTgOperational object in a row of the appnLocalTgTable.
158           This notification is never sent for appnLocalTgTable row
159           creation or deletion.
160
161           The notification is more than a simple 'poll me now' indication.
162           It carries both a count of local TG topology changes, and the
163           current CP-CP session state itself.  The count of changes allows
164           an application to detect lost notifications, either when polling
165           or upon receiving a subsequent notification, at which point it
166           knows it must retrieve the entire appnLocalTgTable again.  This
167           is the same count as used in the appnLocalTgOperStateChangeTrap.
168           A lost notification could indicate a local TG CP-CP session
169           state change or an operational state change.
170
171           Generation of this notification is controlled by the
172           appnTrapControl object."
173
174       ::= { appnTrapMIB 3 }
175
176 appnPortOperStateChangeTrap NOTIFICATION-TYPE
177       OBJECTS  {
178                 appnPortTableChanges,
179                 appnPortOperState
180                }
181
182       STATUS current
183       DESCRIPTION
184           "When it has been enabled, this notification makes it possible
185           for an APPN topology application to get asynchronous
186           notifications of port operational state changes, and thus to
187           reduce the frequency with which it polls for these changes.
188           This notification is only sent when a appnPortOperState has
189           transitioned to a value of 'active' or 'inactive'.
190
191           This notification is sent whenever there is a appnPortOperState
192           object transition to 'inactive' or 'active' state in the
193           appnPortTable.  This notification is only sent for row creation
194           if the row is created with a value of 'active' for
195           appnPortOperState.  This notification is only sent for
196           row deletion if the last value of appnPortOperState was
197           'active'.  In this case, the value of appnPortOperState
198           in the notification shall be 'inactive', since the deletion of
199           a row indicates that the port is no longer active.
200
201           The notification is more than a simple 'poll me now' indication.
202           It carries both a count of port table changes, and the
203           operational state itself.  The count of changes allows an
204           application to detect lost notifications, either when polling
205           or upon receiving a subsequent notification, at which point
206           it knows it must retrieve the entire appnPortTable again.
207
208           Generation of this notification is controlled by the
209           appnTrapControl object."
210
211       ::= { appnTrapMIB 4 }
212
213 appnLsOperStateChangeTrap NOTIFICATION-TYPE
214       OBJECTS  {
215                 appnLsTableChanges,
216                 appnLsOperState
217                }
218       STATUS current
219       DESCRIPTION
220           "When it has been enabled, this notification makes it possible
221           for an APPN topology application to get asynchronous
222           notifications of link station operational state changes, and
223           thus to reduce the frequency with which it polls for these
224           changes.  This notification is only sent when a appnLsOperState
225           has transitioned to a value of 'active' or 'inactive'.
226
227           This notification is sent whenever there is a appnLsOperState
228           object transition to 'inactive' or 'active' state in the
229           appnLsTable.  This notification is only sent for row creation
230           if the row is created with a value of 'active' for
231           appnLsOperState.  This notification is only sent for
232           row deletion if the last value of appnLsOperState was
233           'active'.  In this case, the value of appnLsOperState
234           in the notification shall be 'inactive', since the deletion of
235           a row indicates that the link station is no longer active.
236
237           The notification is more than a simple 'poll me now' indication.
238           It carries both a count of link station table changes, and the
239           operational state itself.  The count of changes allows an
240           application to detect lost notifications, either when polling
241           or upon receiving a subsequent notification, at which point it
242           knows it must retrieve the entire appnLsTable again.
243
244           Generation of this notification is controlled by the
245           appnTrapControl object."
246       ::= { appnTrapMIB 5 }
247
248 dlurDlusStateChangeTrap NOTIFICATION-TYPE
249       OBJECTS  {
250                 dlurDlusTableChanges,
251                 dlurDlusSessnStatus
252                }
253       STATUS current
254       DESCRIPTION
255           "When it has been enabled, this notification makes it possible
256           for an APPN topology application to get asynchronous
257           notifications of DLUR-DLUS session changes, and thus to reduce
258           the frequency with which it polls for these changes.
259
260           This notification is sent whenever there is a dlurDlusSessnStatus
261           object transition to 'inactive' or 'active' state in the
262           dlurDlusTable.  This notification is only sent for row creation
263           if the row is created with a value of 'active' for
264           dlurDlusSessnStatus.  This notification is only sent for
265           row deletion if the last value of dlurDlusSessnStatus was
266           'active'.  In this case, the value of dlurDlusSessnStatus
267           in the notification shall be 'inactive', since the deletion of
268           a row indicates that the session is no longer active.
269
270           The notification is more than a simple 'poll me now' indication.
271           It carries both a count of DLUR-DLUS table changes, and the
272           session status itself.  The count of changes allows an
273           application to detect lost notifications, either when polling
274           or upon receiving a subsequent notification, at which point it
275           knows it must retrieve the entire dlurDlusTable again.
276
277           Generation of this notification is controlled by the
278           appnTrapControl object."
279
280       ::= { appnTrapMIB 6 }
281
282 -- *********************************************************************
283 -- Supporting Objects
284 -- *********************************************************************
285
286 appnTrapObjects              OBJECT IDENTIFIER ::= { appnObjects 7 }
287
288 appnTrapControl OBJECT-TYPE
289
290       SYNTAX BITS {
291                    appnLocalTgOperStateChangeTrap(0),
292                    appnLocalTgCpCpChangeTrap(1),
293                    appnPortOperStateChangeTrap(2),
294                    appnLsOperStateChangeTrap(3),
295                    dlurDlusStateChangeTrap(4)
296                    -- add other notification types here
297                   }
298       MAX-ACCESS read-write
299       STATUS current
300       DESCRIPTION
301           "An object to turn APPN notification generation on and off.
302           Setting a notification type's bit to 1 enables generation of
303           notifications of that type, subject to further filtering
304           resulting from entries in the snmpNotificationMIB.  Setting
305           this bit to 0 disables generation of notifications of that
306           type.
307
308           Note that generation of the appnIsrAccountingDataTrap is
309           controlled by the appnIsInGlobeCtrAdminStatus object in
310           the APPN MIB:  if counts of intermediate session traffic
311           are being kept at all, then the notification is also enabled."
312
313       ::= { appnTrapObjects 1 }
314
315 appnLocalTgTableChanges OBJECT-TYPE
316       SYNTAX Counter32
317       MAX-ACCESS read-only
318       STATUS current
319       DESCRIPTION
320           "A count of the number of times a row in the appnLocalTgTable
321           has changed status since the APPN node was last reinitialized.
322           This counter is incremented whenever a condition is detected
323           that would cause a appnLocalTgOperStateChangeTrap or
324           appnLocalTgCpCpChangeTrap notification to be sent, whether
325           or not those notifications are enabled."
326
327       ::= { appnTrapObjects 2 }
328
329 appnPortTableChanges OBJECT-TYPE
330       SYNTAX Counter32
331       MAX-ACCESS read-only
332       STATUS current
333       DESCRIPTION
334           "A count of the number of times a row in the appnPortTable
335           has changed status since the APPN node was last reinitialized.
336           This counter is incremented whenever a condition is detected
337           that would cause a appnPortOperStateChangeTrap notification
338           to be sent, whether or not this notification is enabled."
339
340       ::= { appnTrapObjects 3 }
341
342 appnLsTableChanges OBJECT-TYPE
343       SYNTAX Counter32
344       MAX-ACCESS read-only
345       STATUS current
346       DESCRIPTION
347           "A count of the number of times a row in the appnLsTable
348           has changed status since the APPN node was last reinitialized.
349           This counter is incremented whenever a condition is detected
350           that would cause a appnLsOperStateChangeTrap notification
351           to be sent, whether or not this notification is enabled."
352
353       ::= { appnTrapObjects 4 }
354
355 dlurDlusTableChanges OBJECT-TYPE
356       SYNTAX Counter32
357       MAX-ACCESS read-only
358       STATUS current
359       DESCRIPTION
360           "A count of the number of times a row in the dlurDlusTable
361           has changed status since the APPN node was last reinitialized.
362           This counter is incremented whenever a condition is detected
363           that would cause a dlurDlusStateChangeTrap notification
364           to be sent, whether or not this notification is enabled."
365
366       ::= { appnTrapObjects 5 }
367
368 -- *********************************************************************
369 -- Conformance information
370 -- *********************************************************************
371
372 -- Tie into the conformance structure in the APPN MIB:
373 -- appnConformance       OBJECT IDENTIFIER ::= {appnMIB 3 }
374 --
375 -- appnCompliances       OBJECT IDENTIFIER ::= {appnConformance 1 }
376 -- appnGroups            OBJECT IDENTIFIER ::= {appnConformance 2 }
377
378 -- Compliance statement
379 appnTrapMibCompliance  MODULE-COMPLIANCE
380        STATUS  current
381        DESCRIPTION
382            "The compliance statement for the SNMP entities that
383            implement the APPN-TRAP-MIB."
384
385        MODULE  -- this module
386
387 --     Conditionally mandatory groups
388            GROUP appnTrapMibIsrNotifGroup
389            DESCRIPTION
390                "This group is mandatory for APPN nodes supporting
391                reporting of final ISR counter values via notifications."
392
393            GROUP appnTrapMibTopoConfGroup
394            DESCRIPTION
395                "This group is mandatory for APPN nodes supporting
396                polling reduction for local topology."
397
398            GROUP appnTrapMibTopoNotifGroup
399            DESCRIPTION
400                "This group is mandatory for APPN nodes supporting
401                polling reduction for local topology."
402
403            GROUP appnTrapMibDlurConfGroup
404            DESCRIPTION
405                "This group is mandatory for APPN nodes supporting
406                polling reduction for the dlurDlusTable."
407
408            GROUP appnTrapMibDlurNotifGroup
409            DESCRIPTION
410                "This group is mandatory for APPN nodes supporting
411                polling reduction for the dlurDlusTable."
412
413            OBJECT appnTrapControl
414                MIN-ACCESS  read-only
415                DESCRIPTION
416                    "An agent is not required to support a set to
417                    this object."
418
419        ::= {appnCompliances 2 }
420
421 -- Units of conformance
422 appnTrapMibIsrNotifGroup    NOTIFICATION-GROUP
423         NOTIFICATIONS {
424                        appnIsrAccountingDataTrap
425                       }
426         STATUS  current
427         DESCRIPTION
428             "A notification for reporting the final values of the
429             APPN MIB's ISR counters."
430
431         ::= { appnGroups 21 }
432
433 appnTrapMibTopoConfGroup  OBJECT-GROUP
434         OBJECTS  {
435                   appnTrapControl,
436                   appnLocalTgTableChanges,
437                   appnPortTableChanges,
438                   appnLsTableChanges
439                  }
440         STATUS  current
441         DESCRIPTION
442             "A collection of objects for reducing the polling
443             associated with the local topology tables in the
444             APPN MIB.  Nodes that implement this group SHALL
445             also implement the appnTrapMibTopoNotifGroup."
446
447         ::= { appnGroups 22 }
448
449 appnTrapMibTopoNotifGroup    NOTIFICATION-GROUP
450         NOTIFICATIONS {
451                        appnLocalTgOperStateChangeTrap,
452                        appnLocalTgCpCpChangeTrap,
453                        appnPortOperStateChangeTrap,
454                        appnLsOperStateChangeTrap
455
456                       }
457         STATUS  current
458         DESCRIPTION
459             "A collection of notifications for reducing the polling
460             associated with the local topology tables in the
461             APPN MIB.  Nodes that implement this group SHALL
462             also implement the appnTrapMibTopoConfGroup."
463
464         ::= { appnGroups 23 }
465
466 appnTrapMibDlurConfGroup  OBJECT-GROUP
467         OBJECTS  {
468                   appnTrapControl,
469                   dlurDlusTableChanges
470                  }
471         STATUS  current
472         DESCRIPTION
473             "A collection of objects for reducing the polling
474             associated with the dlurDlusTable in the DLUR
475             MIB.  Nodes that implement this group SHALL also
476             implement the appnTrapMibDlurNotifGroup."
477
478         ::= { appnGroups 24 }
479
480 appnTrapMibDlurNotifGroup    NOTIFICATION-GROUP
481         NOTIFICATIONS {
482                        dlurDlusStateChangeTrap
483                       }
484         STATUS  current
485         DESCRIPTION
486             "A notification for reducing the polling associated
487             with the dlurDlusTable in the DLUR MIB.  Nodes that
488             implement this group SHALL also implement the
489             appnTrapMibDlurConfGroup."
490
491         ::= { appnGroups 25 }
492
493 END