Import Upstream version 1.2.2
[quagga-debian.git] / ospfd / OSPF-TRAP-MIB.txt
1 OSPF-TRAP-MIB DEFINITIONS ::= BEGIN
2
3     IMPORTS
4             MODULE-IDENTITY, OBJECT-TYPE, NOTIFICATION-TYPE, IpAddress
5                 FROM SNMPv2-SMI
6             MODULE-COMPLIANCE, OBJECT-GROUP
7                 FROM SNMPv2-CONF
8             ospfRouterId, ospfIfIpAddress, ospfAddressLessIf, ospfIfState,
9             ospfVirtIfAreaId, ospfVirtIfNeighbor, ospfVirtIfState,
10             ospfNbrIpAddr, ospfNbrAddressLessIndex, ospfNbrRtrId,
11             ospfNbrState, ospfVirtNbrArea, ospfVirtNbrRtrId, ospfVirtNbrState,
12             ospfLsdbType, ospfLsdbLsid, ospfLsdbRouterId, ospfLsdbAreaId,
13             ospfExtLsdbLimit, ospf
14                 FROM OSPF-MIB;
15
16     ospfTrap MODULE-IDENTITY
17            LAST-UPDATED "9501201225Z" -- Fri Jan 20 12:25:50 PST 1995
18            ORGANIZATION "IETF OSPF Working Group"
19            CONTACT-INFO
20            "                      Fred Baker
21            Postal:                Cisco Systems
22                                   519 Lado Drive
23                                   Santa Barbara, California 93111
24            Tel:                   +1 805 681 0115
25            E-Mail:                fred@cisco.com
26
27                                   Rob Coltun
28            Postal:                RainbowBridge Communications
29            Tel:                   (301) 340-9416
30            E-Mail:                rcoltun@rainbow-bridge.com"
31        DESCRIPTION
32           "The MIB module to describe traps for  the  OSPF
33           Version 2 Protocol."
34       ::= { ospf 16 }
35
36 -- Trap Support Objects
37
38 --         The following are support objects for the OSPF traps.
39
40 ospfTrapControl OBJECT IDENTIFIER ::= { ospfTrap 1 }
41 ospfTraps OBJECT IDENTIFIER ::= { ospfTrap 2 }
42
43     ospfSetTrap OBJECT-TYPE
44         SYNTAX   OCTET STRING (SIZE(4))
45         MAX-ACCESS   read-write
46         STATUS   current
47         DESCRIPTION
48            "A four-octet string serving as a bit  map  for
49            the trap events defined by the OSPF traps. This
50            object is used to enable and  disable  specific
51            OSPF   traps   where  a  1  in  the  bit  field
52            represents enabled.  The right-most bit  (least
53            significant) represents trap 0."
54        ::= { ospfTrapControl 1 }
55
56
57     ospfConfigErrorType OBJECT-TYPE
58         SYNTAX   INTEGER   {
59                     badVersion (1),
60                     areaMismatch (2),
61                     unknownNbmaNbr (3), -- Router is Dr eligible
62                     unknownVirtualNbr (4),
63                     authTypeMismatch(5),
64                     authFailure (6),
65                     netMaskMismatch (7),
66                     helloIntervalMismatch (8),
67                     deadIntervalMismatch (9),
68                     optionMismatch (10) }
69         MAX-ACCESS   read-only
70         STATUS   current
71         DESCRIPTION
72            "Potential types  of  configuration  conflicts.
73            Used  by the ospfConfigError and ospfConfigVir-
74            tError traps."
75    ::= { ospfTrapControl 2 }
76
77
78     ospfPacketType OBJECT-TYPE
79         SYNTAX   INTEGER   {
80                     hello (1),
81                     dbDescript (2),
82                     lsReq (3),
83                     lsUpdate (4),
84                     lsAck (5) }
85         MAX-ACCESS   read-only
86         STATUS   current
87         DESCRIPTION
88            "OSPF packet types."
89    ::= { ospfTrapControl 3 }
90
91
92     ospfPacketSrc OBJECT-TYPE
93         SYNTAX   IpAddress
94         MAX-ACCESS   read-only
95         STATUS   current
96         DESCRIPTION
97            "The IP address of an inbound packet that  can-
98            not be identified by a neighbor instance."
99        ::= { ospfTrapControl 4 }
100
101
102 -- Traps
103
104
105     ospfIfStateChange NOTIFICATION-TYPE
106         OBJECTS {
107                     ospfRouterId, -- The originator of the trap
108                     ospfIfIpAddress,
109                     ospfAddressLessIf,
110                     ospfIfState   -- The new state
111                   }
112         STATUS             current
113         DESCRIPTION
114            "An ospfIfStateChange trap signifies that there
115            has been a change in the state of a non-virtual
116            OSPF interface. This trap should  be  generated
117            when  the interface state regresses (e.g., goes
118            from Dr to Down) or progresses  to  a  terminal
119            state  (i.e.,  Point-to-Point, DR Other, Dr, or
120            Backup)."
121    ::= { ospfTraps 16 }
122
123
124     ospfVirtIfStateChange NOTIFICATION-TYPE
125         OBJECTS {
126                     ospfRouterId, -- The originator of the trap
127                     ospfVirtIfAreaId,
128                     ospfVirtIfNeighbor,
129                     ospfVirtIfState  -- The new state
130                   }
131         STATUS             current
132         DESCRIPTION
133            "An ospfIfStateChange trap signifies that there
134            has  been a change in the state of an OSPF vir-
135            tual interface.
136            This trap should be generated when  the  inter-
137            face  state  regresses  (e.g., goes from Point-
138            to-Point to Down) or progresses to  a  terminal
139            state (i.e., Point-to-Point)."
140    ::= { ospfTraps 1 }
141
142
143     ospfNbrStateChange NOTIFICATION-TYPE
144         OBJECTS {
145                     ospfRouterId, -- The originator of the trap
146                     ospfNbrIpAddr,
147                     ospfNbrAddressLessIndex,
148                     ospfNbrRtrId,
149                     ospfNbrState  -- The new state
150                   }
151         STATUS             current
152         DESCRIPTION
153            "An  ospfNbrStateChange  trap  signifies   that
154            there  has been a change in the state of a non-
155            virtual OSPF neighbor.   This  trap  should  be
156            generated  when  the  neighbor  state regresses
157            (e.g., goes from Attempt or Full  to  1-Way  or
158            Down)  or progresses to a terminal state (e.g.,
159            2-Way or Full).  When an  neighbor  transitions
160            from  or  to Full on non-broadcast multi-access
161            and broadcast networks, the trap should be gen-
162            erated  by the designated router.  A designated
163            router transitioning to Down will be  noted  by
164            ospfIfStateChange."
165    ::= { ospfTraps 2 }
166
167
168     ospfVirtNbrStateChange NOTIFICATION-TYPE
169         OBJECTS {
170                     ospfRouterId, -- The originator of the trap
171                     ospfVirtNbrArea,
172                     ospfVirtNbrRtrId,
173                     ospfVirtNbrState  -- The new state
174                   }
175         STATUS             current
176         DESCRIPTION
177            "An ospfIfStateChange trap signifies that there
178            has  been a change in the state of an OSPF vir-
179            tual neighbor.  This trap should  be  generated
180            when  the  neighbor state regresses (e.g., goes
181            from Attempt or  Full  to  1-Way  or  Down)  or
182            progresses to a terminal state (e.g., Full)."
183    ::= { ospfTraps 3 }
184     ospfIfConfigError NOTIFICATION-TYPE
185         OBJECTS {
186                     ospfRouterId, -- The originator of the trap
187                     ospfIfIpAddress,
188                     ospfAddressLessIf,
189                     ospfPacketSrc,  -- The source IP address
190                     ospfConfigErrorType, -- Type of error
191                     ospfPacketType
192                   }
193         STATUS             current
194         DESCRIPTION
195            "An ospfIfConfigError  trap  signifies  that  a
196            packet  has  been received on a non-virtual in-
197            terface  from  a  router  whose   configuration
198            parameters  conflict  with this router's confi-
199            guration parameters.  Note that the  event  op-
200            tionMismatch  should  cause  a  trap only if it
201            prevents an adjacency from forming."
202                   ::= { ospfTraps 4 }
203
204
205     ospfVirtIfConfigError NOTIFICATION-TYPE
206         OBJECTS {
207                     ospfRouterId, -- The originator of the trap
208                     ospfVirtIfAreaId,
209                     ospfVirtIfNeighbor,
210                     ospfConfigErrorType, -- Type of error
211                     ospfPacketType
212                   }
213         STATUS             current
214         DESCRIPTION
215            "An ospfConfigError trap signifies that a pack-
216            et  has  been  received  on a virtual interface
217            from a router  whose  configuration  parameters
218            conflict   with   this  router's  configuration
219            parameters.  Note that the event optionMismatch
220            should  cause a trap only if it prevents an ad-
221            jacency from forming."
222    ::= { ospfTraps 5 }
223
224
225     ospfIfAuthFailure NOTIFICATION-TYPE
226         OBJECTS {
227                     ospfRouterId, -- The originator of the trap
228                     ospfIfIpAddress,
229                     ospfAddressLessIf,
230                     ospfPacketSrc,  -- The source IP address
231                     ospfConfigErrorType, -- authTypeMismatch or
232                                          -- authFailure
233                     ospfPacketType
234                   }
235         STATUS             current
236         DESCRIPTION
237            "An ospfIfAuthFailure  trap  signifies  that  a
238            packet  has  been received on a non-virtual in-
239            terface from a router whose authentication  key
240            or  authentication  type  conflicts  with  this
241            router's authentication key  or  authentication
242            type."
243    ::= { ospfTraps 6 }
244
245
246     ospfVirtIfAuthFailure NOTIFICATION-TYPE
247         OBJECTS {
248                     ospfRouterId, -- The originator of the trap
249                     ospfVirtIfAreaId,
250                     ospfVirtIfNeighbor,
251                     ospfConfigErrorType, -- authTypeMismatch or
252                                          -- authFailure
253                     ospfPacketType
254                   }
255         STATUS             current
256         DESCRIPTION
257            "An ospfVirtIfAuthFailure trap signifies that a
258            packet has been received on a virtual interface
259            from a router whose authentication key  or  au-
260            thentication  type conflicts with this router's
261            authentication key or authentication type."
262    ::= { ospfTraps 7 }
263
264
265     ospfIfRxBadPacket NOTIFICATION-TYPE
266         OBJECTS {
267                     ospfRouterId, -- The originator of the trap
268                     ospfIfIpAddress,
269                     ospfAddressLessIf,
270                     ospfPacketSrc,  -- The source IP address
271                     ospfPacketType
272                   }
273         STATUS             current
274         DESCRIPTION
275            "An ospfIfRxBadPacket trap  signifies  that  an
276            OSPF  packet has been received on a non-virtual
277            interface that cannot be parsed."
278    ::= { ospfTraps 8 }
279
280     ospfVirtIfRxBadPacket NOTIFICATION-TYPE
281         OBJECTS {
282                     ospfRouterId, -- The originator of the trap
283                     ospfVirtIfAreaId,
284                     ospfVirtIfNeighbor,
285                     ospfPacketType
286                   }
287         STATUS             current
288         DESCRIPTION
289            "An ospfRxBadPacket trap signifies that an OSPF
290            packet has been received on a virtual interface
291            that cannot be parsed."
292    ::= { ospfTraps 9 }
293
294
295     ospfTxRetransmit NOTIFICATION-TYPE
296         OBJECTS {
297                     ospfRouterId, -- The originator of the trap
298                     ospfIfIpAddress,
299                     ospfAddressLessIf,
300                     ospfNbrRtrId, -- Destination
301                     ospfPacketType,
302                     ospfLsdbType,
303                     ospfLsdbLsid,
304                     ospfLsdbRouterId
305                   }
306         STATUS             current
307         DESCRIPTION
308            "An ospfTxRetransmit  trap  signifies  than  an
309            OSPF  packet  has  been retransmitted on a non-
310            virtual interface.  All packets that may be re-
311            transmitted  are associated with an LSDB entry.
312            The LS type, LS ID, and Router ID are  used  to
313            identify the LSDB entry."
314    ::= { ospfTraps 10 }
315
316
317     ospfVirtIfTxRetransmit NOTIFICATION-TYPE
318         OBJECTS {
319                     ospfRouterId, -- The originator of the trap
320                     ospfVirtIfAreaId,
321                     ospfVirtIfNeighbor,
322                     ospfPacketType,
323                     ospfLsdbType,
324                     ospfLsdbLsid,
325                     ospfLsdbRouterId
326                   }
327         STATUS             current
328         DESCRIPTION
329            "An ospfTxRetransmit  trap  signifies  than  an
330            OSPF packet has been retransmitted on a virtual
331            interface.  All packets that may be retransmit-
332            ted  are  associated with an LSDB entry. The LS
333            type, LS ID, and Router ID are used to identify
334            the LSDB entry."
335    ::= { ospfTraps 11 }
336
337
338     ospfOriginateLsa NOTIFICATION-TYPE
339         OBJECTS {
340                     ospfRouterId, -- The originator of the trap
341                     ospfLsdbAreaId,  -- 0.0.0.0 for AS Externals
342                     ospfLsdbType,
343                     ospfLsdbLsid,
344                     ospfLsdbRouterId
345                   }
346         STATUS             current
347         DESCRIPTION
348            "An ospfOriginateLsa trap signifies that a  new
349            LSA  has  been originated by this router.  This
350            trap should not be invoked for simple refreshes
351            of  LSAs  (which happesn every 30 minutes), but
352            instead will only be invoked  when  an  LSA  is
353            (re)originated due to a topology change.  Addi-
354            tionally, this trap does not include LSAs  that
355            are  being  flushed  because  they have reached
356            MaxAge."
357    ::= { ospfTraps 12 }
358
359
360     ospfMaxAgeLsa NOTIFICATION-TYPE
361         OBJECTS {
362                     ospfRouterId, -- The originator of the trap
363                     ospfLsdbAreaId,  -- 0.0.0.0 for AS Externals
364                     ospfLsdbType,
365                     ospfLsdbLsid,
366                     ospfLsdbRouterId
367                   }
368         STATUS             current
369         DESCRIPTION
370            "An ospfMaxAgeLsa trap signifies  that  one  of
371            the LSA in the router's link-state database has
372            aged to MaxAge."
373    ::= { ospfTraps 13 }
374
375
376     ospfLsdbOverflow NOTIFICATION-TYPE
377         OBJECTS {
378                     ospfRouterId, -- The originator of the trap
379                     ospfExtLsdbLimit
380                   }
381         STATUS             current
382         DESCRIPTION
383            "An ospfLsdbOverflow trap  signifies  that  the
384            number of LSAs in the router's link-state data-
385            base has exceeded ospfExtLsdbLimit."
386    ::= { ospfTraps 14 }
387
388
389     ospfLsdbApproachingOverflow NOTIFICATION-TYPE
390         OBJECTS {
391                     ospfRouterId, -- The originator of the trap
392                     ospfExtLsdbLimit
393                   }
394         STATUS             current
395         DESCRIPTION
396            "An ospfLsdbApproachingOverflow trap  signifies
397            that  the  number of LSAs in the router's link-
398            state database has exceeded ninety  percent  of
399            ospfExtLsdbLimit."
400    ::= { ospfTraps 15 }
401
402
403 -- conformance information
404
405 ospfTrapConformance OBJECT IDENTIFIER ::= { ospfTrap 3 }
406
407 ospfTrapGroups      OBJECT IDENTIFIER ::= { ospfTrapConformance 1 }
408 ospfTrapCompliances OBJECT IDENTIFIER ::= { ospfTrapConformance 2 }
409
410 -- compliance statements
411
412     ospfTrapCompliance MODULE-COMPLIANCE
413         STATUS  current
414         DESCRIPTION
415            "The compliance statement "
416        MODULE  -- this module
417        MANDATORY-GROUPS { ospfTrapControlGroup }
418
419
420         GROUP       ospfTrapControlGroup
421         DESCRIPTION
422            "This group is optional but recommended for all
423            OSPF systems"
424        ::= { ospfTrapCompliances 1 }
425
426
427 -- units of conformance
428
429     ospfTrapControlGroup    OBJECT-GROUP
430         OBJECTS {
431                            ospfSetTrap,
432                            ospfConfigErrorType,
433                            ospfPacketType,
434                            ospfPacketSrc
435         }
436         STATUS  current
437         DESCRIPTION
438            "These objects are required  to  control  traps
439            from OSPF systems."
440        ::= { ospfTrapGroups 1 }
441
442
443 END