smilint output for ./PKTC-IETF-EVENT-MIB
| Message Severities |
|---|
| Severity | Count |
|---|
| error | 2 |
| Message Types |
|---|
| Type | Count |
|---|
| bad-identifier-case (error) | 1 |
| object-identifier-not-prefix (error) | 1 |
Messages:
PKTC-IETF-EVENT-MIB
1: -- extracted from draft-ietf-ipcdn-pktc-eventmess-11.txt
2: -- at Fri Oct 26 06:11:33 2007
3:
4: PKTC-IETF-EVENT-MIB DEFINITIONS ::= BEGIN
5:
6: IMPORTS
7: MODULE-IDENTITY,
8: OBJECT-TYPE,
9: Unsigned32,
10: NOTIFICATION-TYPE,
11: mib-2 FROM SNMPv2-SMI
12: TruthValue,
13: DateAndTime, TEXTUAL-CONVENTION
14: FROM SNMPv2-TC
15: SnmpAdminString FROM SNMP-FRAMEWORK-MIB
16: OBJECT-GROUP,
17: MODULE-COMPLIANCE,
18: NOTIFICATION-GROUP FROM SNMPv2-CONF
19: ifPhysAddress FROM IF-MIB
20: InetAddressType,
21: InetAddress,
22: InetPortNumber FROM INET-ADDRESS-MIB
23: snmpTargetBasicGroup, snmpTargetResponseGroup
24: FROM SNMP-TARGET-MIB
25: snmpNotifyGroup, snmpNotifyFilterGroup
26: FROM SNMP-NOTIFICATION-MIB
27: SyslogSeverity, SyslogFacility FROM SYSLOG-TC-MIB;
28:
29: pktcIetfEventMib MODULE-IDENTITY
30: LAST-UPDATED "200709300000Z" -- September 30, 2007
31: ORGANIZATION "IETF IP over Cable Data Network Working Group"
32: CONTACT-INFO
33: "Sumanth Channabasappa
34: Cable Television Laboratories, Inc.
35: 858 Coal Creek Circle,
36: Louisville, CO 80027, USA
37: +1 303-661-3307
38: Sumanth@cablelabs.com
39:
40: Wim De Ketelaere
41: tComLabs
42: Gildestraat 8
43: 9000 Gent, Belgium
44: +32 9 269 22 90
45: deketelaere@tComLabs.com
46:
47: Eugene Nechamkin
48: Broadcom Corporation
49: 200 - 13711 International Place
50: Richmond, BC, V6V 2Z8, Canada
51: +1 604 233 8500
52: enechamkin@broadcom.com
53:
54: IETF IPCDN Working Group
55: General Discussion: ipcdn@ietf.org
56: Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn
57: Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn
58: Co-Chair: Jean-Francois Mule, jf.mule@cablelabs.com
59: Co-Chair: Richard Woundy, Richard_Woundy@cable.comcast.com"
60:
61: DESCRIPTION
62: "This MIB module specifies the basic management objects
63: for managing events generated by the Multimedia
64: Terminal Adapter devices compliant with the PacketCable
65: and IPCablecom requirements.
66:
67: Copyright (C) The IETF Trust (2007). This version
68: of this MIB module is part of RFC nnnn; see the RFC
69: itself for full legal notices."
70: -- RFC Ed: replace nnnn with actual RFC number and remove this note.
71:
72: REVISION "200709300000Z" -- September 30, 2007
73:
74: DESCRIPTION
75: "Initial version, published as RFC yyyy."
76: -- RFC Ed: replace yyyy with actual RFC number and remove this note
77:
78: ::= { mib-2 XXX }
78: error -
`XXX' should start with a lower case letter
78: error -
Object identifier element `XXX' name only allowed as first element
79: -- RFC Ed: replace XXX with IANA-assigned number and remove this
80: -- note
81:
82:
83:
84: SyslogSeverityMask ::= TEXTUAL-CONVENTION
85: STATUS current
86: DESCRIPTION
87: "This textual convention represents a bit mask representing
88: the severity of the syslog events that can be generated.
89: It corresponds to the various severity levels associated
90: with syslog messages, as specified in The syslog Protocol,
91: [RFCAAA].
92:
93: emergency(0) - A condition that makes the system
94: unusable.
95: alert(1) - A service-affecting condition for which
96: immediate action must be taken.
97: critical(2) - A service-affecting critical condition.
98: error(3) - An error condition.
99: warning(4) - A warning condition.
100: notice(5) - A normal but significant condition.
101: info(6) - An informational message.
102: debug(7) - A debug message."
103:
104: SYNTAX BITS {
105: emergency(0),
106: alert(1),
107: critical(2),
108: error(3),
109: warning(4),
110: notice(5),
111: info(6),
112: debug(7)
113: }
114:
115: --
116: --
117: pktcEventNotifications OBJECT IDENTIFIER ::= { pktcIetfEventMib 0 }
118: pktcEventMibObjects OBJECT IDENTIFIER ::= { pktcIetfEventMib 1 }
119: pktcEventConformance OBJECT IDENTIFIER ::= { pktcIetfEventMib 2 }
120: --
121: --
122: pktcEventControl OBJECT IDENTIFIER ::= { pktcEventMibObjects 1 }
123: pktcEventThrottle OBJECT IDENTIFIER ::= { pktcEventMibObjects 2 }
124: pktcEventStatus OBJECT IDENTIFIER ::= { pktcEventMibObjects 3 }
125: pktcEvents OBJECT IDENTIFIER ::= { pktcEventMibObjects 4 }
126: pktcEventLog OBJECT IDENTIFIER ::= { pktcEventMibObjects 5 }
127:
128:
129: ---
130: -- Event Reporting control objects
131: ---
132: pktcEventReset OBJECT-TYPE
133: SYNTAX BITS {
134: resetEvLogTable(0),
135: resetEvDescrTable(1)
136: }
137: MAX-ACCESS read-write
138: STATUS current
139: DESCRIPTION
140: "This MIB object allows a management station to
141: clear the local log of generated events, reset the
142: management event descriptions, or both.
143:
144: MTAs generate management events. These events are stored
145: in the MIB table 'pktcEventLogTable'. If a management
146: station needs to clear all the current entries (e.g.,
147: after a troubleshooting operation is complete), it can
148: do so by setting the resetEvLogTable(0) bit to a value
149: of '1'.
150:
151: The MTA is pre-configured with the events that it can
152: generate. This is stored in the MIB table
153: 'pktcEventTable'. This table also contains the
154: descriptions associated with these events. These
155: descriptions can be modified by a management station.
156: However, if the management station wishes to reset the
157: descriptions, to factory defaults, it can do so by
158: setting the resetEvDescrTable(1) bit to a value of '1'.
159: The MTA actions are summarized below:
160:
161: Bit resetEvLogTable(0) set to a value of '1'
162: - delete all entries in pktcEventLogTable;
163: - reset the value of pktcEventLogIndex to '0'.
164:
165: Bit resetEvDescrTable(1) set to a value of '1'
166: - reset the pktcEventTable to the
167: factory default values.
168:
169: Bits resetEvLogTable(0) and resetEvDescrTable(1)
170: set to a value of '1'
171: - perform the above actions as though they were
172: performed individually (in any order).
173:
174: Setting a reset bit to a value of '0' MUST NOT
175: result in any action.
176:
177: The MTA MUST perform the above actions regardless of
178: persistence (i.e. storage in non-volatile memory).
179:
180: The MTA MUST always return a value of '00' when
181: this MIB object is read.
182:
183: It is to be noted that the presence of multiple
184: SNMP managers managing the same MTA can result in
185: multi-manager contentions for this MIB object that
186: are not addressed."
187: ::= { pktcEventControl 1 }
188:
189:
190:
191: ---
192: -- syslog-specific MIB objects
193: ---
194: pktcEventSyslog OBJECT IDENTIFIER ::= { pktcEventControl 2 }
195:
196: pktcEventSyslogCapabilities OBJECT-TYPE
197: SYNTAX BITS {
198: formatBSDSyslog(0),
199: formatSyslogProtocol(1),
200: transportUDP(2),
201: transportTLS(3),
202: transportBEEP(4)
203: }
204: MAX-ACCESS read-only
205: STATUS current
206: DESCRIPTION
207: "This MIB object contains the MTA capabilities
208: for supporting the Syslog protocol, specifically
209: the message formats and the transport protocols.
210:
211: The BSD syslog message format is specified
212: in [RFC3164] (formatBSDSyslog), and the IETF
213: syslog protocol is specified in [RFCAAA]
214: (formatSyslogProtocol).
215:
216: The MTA MUST set the appropriate protocol and
217: transport bits, based on implementation."
218: REFERENCE
219: "The BSD syslog Protocol, [RFC3164];
220: The syslog Protocol, [RFCAAA];
221: Transmission of syslog messages over UDP, [RFCBBB];
222: TLS Transport Mapping for Syslog, [RFCCCC]."
223: ::= { pktcEventSyslog 1 }
224:
225:
226: pktcEventSyslogAddressType OBJECT-TYPE
227: SYNTAX InetAddressType
228: MAX-ACCESS read-write
229: STATUS current
230: DESCRIPTION
231: "This MIB object defines the Internet address type of
232: the syslog server specified by the MIB object
233: 'pktcEventSyslogAddress' ."
234: REFERENCE
235: "PacketCable MTA Device Provisioning Specification,
236: [PKT-SP-PROV]."
237: DEFVAL { ipv4 }
238: ::= { pktcEventSyslog 2 }
239:
240: pktcEventSyslogAddress OBJECT-TYPE
241: SYNTAX InetAddress
242: MAX-ACCESS read-write
243: STATUS current
244: DESCRIPTION
245: "This MIB object contains the IP address of the
246: syslog server to which the MTA can transmit a syslog
247: message upon the generation of a management event.
248: The type of address this object represents is defined
249: by the MIB object pktDevEventSyslogAddressType.
250:
251: The use of FQDNs is syntactically allowed, but
252: not recommended since a failure to resolve them in a
253: timely manner may leave the device without access to
254: the syslog service during critical network events.
255: The MTA SHOULD NOT attempt to route to a non-routable
256: syslog IP address.
257:
258: The format of the syslog message is specified by the
259: MIB object 'pktcEventSyslogMessageFormat'."
260: REFERENCE
261: "PacketCable MTA Device Provisioning Specification,
262: [PKT-SP-PROV];
263: PacketCable Management Event Mechanism Specification,
264: [PKT-SP-MEM1.5];"
265: DEFVAL { "0.0.0.0" }
266: ::= { pktcEventSyslog 3 }
267:
268: pktcEventSyslogMessageFormat OBJECT-TYPE
269: SYNTAX INTEGER {
270: formatBSDSyslog(1), -- The BSD syslog Protocol
271: formatSyslogProtocol(2) -- The syslog Protocol
272: }
273: MAX-ACCESS read-write
274: STATUS current
275: DESCRIPTION
276: "This MIB object contains the syslog message format to
277: be used for transmitting syslog messages to the server
278: contained in the MIB object 'pktcEventSyslogServer'."
279: REFERENCE
280: "The BSD syslog Protocol, [RFC3164];
281: The syslog Protocol, [RFCAAA]."
282: DEFVAL { formatBSDSyslog }
283: ::= { pktcEventSyslog 4 }
284:
285: pktcEventSyslogTransport OBJECT-TYPE
286: SYNTAX INTEGER {
287: udp(1),-- Transmission of syslog messages over UDP
288: tls(2),-- TLS Transport Mapping for Syslog
289: beep(3)-- BEEP Transport Mapping for Syslog
290: }
291: MAX-ACCESS read-write
292: STATUS current
293: DESCRIPTION
294: "This MIB object specifies the transport to be
295: used to transmit syslog messages to the syslog
296: server contained in the MIB object
297: 'pktcEventSyslogAddress'.
298:
299: If the MTA does not support the transport
300: specified in a SET operation, then the
301: MTA MUST return an appropriate error
302: response, such as 'inconsistentValue'."
303: REFERENCE
304: "Transmission of syslog messages over UDP, [RFCBBB];
305: TLS Transport Mapping for Syslog, [RFCCCC]."
306: DEFVAL {udp}
307: ::= { pktcEventSyslog 5 }
308:
309:
310: pktcEventSyslogPort OBJECT-TYPE
311: SYNTAX InetPortNumber
312: MAX-ACCESS read-write
313: STATUS current
314: DESCRIPTION
315: "This MIB object contains the port number of the
316: syslog Server to which the syslog messages are to
317: be transmitted."
318: REFERENCE
319: "Transmission of syslog messages over UDP, [RFCBBB];
320: TLS Transport Mapping for Syslog, [RFCCCC]."
321: DEFVAL { 514 }
322: ::= { pktcEventSyslog 6 }
323:
324:
325: ---
326: -- Event classes
327: ---
328:
329:
330: pktcEventClassTable OBJECT-TYPE
331: SYNTAX SEQUENCE OF PktcEventClassEntry
332: MAX-ACCESS not-accessible
333: STATUS current
334: DESCRIPTION
335: "This MIB table allows for management events that can be
336: generated by an MTA to be classified into categories,
337: or 'event classes'. For example, all the configuration
338: related events can be associated with an event class
339: titled 'configuration'. Such as a classification allows
340: for a management station to affect changes on a common
341: group of events, at once. Two operations are specified
342: on an event class: enabling or disabling of all the
343: events in an event class, and selective enabling or
344: disabling based on the severity level."
345: ::= { pktcEventControl 3 }
346:
347: pktcEventClassEntry OBJECT-TYPE
348: SYNTAX PktcEventClassEntry
349: MAX-ACCESS not-accessible
350: STATUS current
351: DESCRIPTION
352: "Each entry in this table specifies an event class, a
353: grouping of events, as identified by the MTA
354: manufacturer. Any event associated with an event class
355: in this table MUST be specified in the
356: pktcEventTable.
357:
358: The MTA MUST create one entry (index=100) for the event
359: class titled 'generic'. This event class MUST contain
360: all the events that are not contained in any other
361: vendor specified event class.
362:
363: An event can belong to multiple event classes. In such
364: a case, the event class with the lowest index takes
365: precedence.
366:
367: The event table (pktcEventTable) provides the event
368: class that affects the event. Whenever an event is
369: generated, the MTA MUST verify the corresponding
370: event class entries to take any specified actions.
371:
372: Entries in this table persist across resets and
373: reboots."
374: INDEX { pktcEventClassIndex }
375: ::= { pktcEventClassTable 1 }
376:
377: PktcEventClassEntry::= SEQUENCE {
378: pktcEventClassIndex Unsigned32,
379: pktcEventClassName SnmpAdminString,
380: pktcEventClassStatus TruthValue,
381: pktcEventClassSeverity SyslogSeverityMask
382: }
383:
384: pktcEventClassIndex OBJECT-TYPE
385: SYNTAX Unsigned32 (1..100)
386: MAX-ACCESS not-accessible
387: STATUS current
388: DESCRIPTION
389: "This MIB object is an index into the event
390: class table. It is a locally-meaningful
391: value, and needs to remain consistent across
392: MTA resets and reboots."
393: ::= { pktcEventClassEntry 1 }
394:
395:
396: pktcEventClassName OBJECT-TYPE
397: SYNTAX SnmpAdminString (SIZE (1..100))
398: MAX-ACCESS read-only
399: STATUS current
400: DESCRIPTION
401: "This MIB object contains the name of the
402: event class.
403:
404: Vendors MAY define different event classes
405: (e.g. DHCP, SNMP, DEBUG) to group together
406: management events of a particular category.
407:
408: Event class names need to take into
409: consideration the SnmpAdminString definition
410: requirements such as the use of control code
411: sequence CR LF to represent a newline."
412: ::= { pktcEventClassEntry 2 }
413:
414: pktcEventClassStatus OBJECT-TYPE
415: SYNTAX TruthValue
416: MAX-ACCESS read-write
417: STATUS current
418: DESCRIPTION
419: "This MIB object indicates if events belonging
420: to the corresponding event class are enabled
421: or disabled, for event reporting.
422:
423: Setting this object to a value of 'true' enables
424: reporting of all the events in the event class.
425:
426: When enabled, the means of reporting events is
427: specified by the MIB object 'pktcEventReporting'.
428:
429: Setting this object to a value of 'false' disables
430: any event reporting, irrespective of the value of the
431: MIB object 'pktcEventReporting' for a specific
432: event.
433:
434: The default value of this MIB object is vendor
435: specific. However, the vendor SHOULD enable all
436: event categories defined by PacketCable or
437: IPCableCom, by default."
438: ::= { pktcEventClassEntry 3 }
439:
440: pktcEventClassSeverity OBJECT-TYPE
441: SYNTAX SyslogSeverityMask
442: MAX-ACCESS read-write
443: STATUS current
444: DESCRIPTION
445: "This MIB object defines the severity level
446: of events belonging to a specific event class
447: that are enabled for event reporting.
448:
449: This MIB object has no effect on the event
450: reporting unless the MIB object
451: 'pktcEventClassStatus' is set to a value
452: of 'true' (enabled), for the corresponding
453: event class.
454:
455: Setting a bit within the mask to a value of '1'
456: implies that events corresponding to that
457: severity level MUST be reported as defined by
458: the corresponding value of 'pktcEventReporting'
459: for events in the event class.
460:
461: Setting a bit to a value of '0' implies that
462: events corresponding to that level MUST NOT be
463: reported, irrespective of the corresponding
464: value of 'pktcEventReporting' for events
465: in the event class.
466:
467: It is recommended that the bits corresponding
468: to emergency(0), alert(1), critical(2) and error(3)
469: be set to a value of '1' to ensure reporting of
470: events requiring immediate attention."
471: REFERENCE
472: "The syslog Protocol, [RFCAAA];
473: Syslog Management Information Base, [RFCABC]."
474: ::= { pktcEventClassEntry 4 }
475:
476: ---
477: -- Event throttling control
478: ---
479:
480: pktcEventThrottleAdminStatus OBJECT-TYPE
481: SYNTAX INTEGER {
482: unconstrained(1),
483: maintainBelowThreshold(2),
484: stopAtThreshold(3),
485: inhibited(4)
486: }
487: MAX-ACCESS read-write
488: STATUS current
489: DESCRIPTION
490: "This MIB object controls the throttling of the
491: transmitted messages upon generation of an event
492: (SNMP/syslog). It does not affect local logging
493: of events.
494:
495: A value of unconstrained(1) causes event messages
496: to be transmitted without regard to the threshold
497: settings.
498:
499: A value of maintainBelowThreshold(2) causes event
500: messages to be suppressed if the number of
501: transmissions would otherwise exceed the threshold
502: specified by pktcEventThrottleThreshold over the
503: interval specified by pktcEventThrottleInterval.
504:
505: A value of stopAtThreshold(3) causes event message
506: transmission to cease once the threshold specified
507: by pktcEventThrottleThreshold (over the interval
508: specified by pktcEventThrottleInterval) is reached.
509: Event generation is resumed when the value of this
510: MIB object is modified by a Management Station, or
511: the device resets or reboots.
512:
513: A value of inhibited(4) causes all event message
514: transmission to be suppressed.
515:
516: An event causing both an SNMP and a syslog message
517: is still treated as a single event.
518:
519: Refer to MIB objects pktcEventThrottleThreshold and
520: pktcEventThrottleInterval for information on
521: throttling."
522: DEFVAL { unconstrained }
523: ::= { pktcEventThrottle 1 }
524:
525:
526: pktcEventThrottleThreshold OBJECT-TYPE
527: SYNTAX Unsigned32(0..1024)
528: MAX-ACCESS read-write
529: STATUS current
530: DESCRIPTION
531: "This MIB object contains the number of events per
532: pktcEventThrottleInterval to be transmitted before
533: throttling.
534:
535: An event resulting in multiple actions (e.g., SNMP
536: and syslog) is still treated as a single event."
537: DEFVAL { 2 }
538: ::= { pktcEventThrottle 2 }
539:
540: pktcEventThrottleInterval OBJECT-TYPE
541: SYNTAX Unsigned32(0..604800)
542: UNITS "seconds"
543: MAX-ACCESS read-write
544: STATUS current
545: DESCRIPTION
546:
547: "This MIB object contains the interval over which
548: the throttle threshold applies."
549:
550: DEFVAL { 1 }
551: ::= { pktcEventThrottle 3 }
552:
553:
554: ---
555: -- Reporting of transmission status
556: ---
557:
558: pktcEventTransmissionStatus OBJECT-TYPE
559: SYNTAX BITS {
560: syslogThrottled(0),
561: snmpThrottled(1),
562: validsyslogServerAbsent(2),
563: validSnmpManagerAbsent(3),
564: syslogTransmitError(4),
565: snmpTransmitError(5)
566: }
567: MAX-ACCESS read-only
568: STATUS current
569: DESCRIPTION
570: "This MIB object reflects the status of the event
571: transmissions.
572:
573: If a bit corresponding to a state is set to a value
574: of:
575: '1', it indicates that the state is true
576: '0', it indicates that the state is false
577:
578: 'Event throttling' is based on thresholds and the
579: current setting of pktcEventThrottleAdminStatus.
580:
581: 'Server/Manager' indicators is based on the
582: availability of valid syslog server/SNMP managers.
583:
584: 'Transmit Errors' is only used in cases where the
585: MTA can identify such scenarios.
586:
587: It is to be noted that not all the conditions that are
588: indicated by this MIB object are detectable by all
589: devices, and when detected may not be accurate. It is
590: meant to provide a report of the status as determined
591: by the device during event transmissions."
592: ::= { pktcEventStatus 1 }
593:
594:
595:
596: ---
597: -- Description of events
598: ---
599: pktcEventTable OBJECT-TYPE
600: SYNTAX SEQUENCE OF PktcEventEntry
601: MAX-ACCESS not-accessible
602: STATUS current
603: DESCRIPTION
604: "This MIB table contains all possible management events
605: that can be generated by the device. This includes
606: both PacketCable and IPCableCom defined, and
607: vendor-specific events."
608: ::= { pktcEvents 1 }
609:
610: pktcEventEntry OBJECT-TYPE
611: SYNTAX PktcEventEntry
612: MAX-ACCESS not-accessible
613: STATUS current
614: DESCRIPTION
615: "An entry in this table is created for each
616: event the MTA implementing this MIB is
617: capable of reporting. Entries in this table
618: are persisted across resets and reboots."
619: INDEX { pktcEventOrg, pktcEventId }
620: ::= { pktcEventTable 1 }
621:
622: PktcEventEntry::= SEQUENCE {
623: pktcEventOrg Unsigned32,
624: pktcEventId Unsigned32,
625: pktcEventFacility INTEGER,
626: pktcEventSeverityLevel SyslogSeverity,
627: pktcEventReporting BITS,
628: pktcEventText SnmpAdminString,
629: pktcEventClass SnmpAdminString
630: }
631:
632: pktcEventOrg OBJECT-TYPE
633: SYNTAX Unsigned32(1..4294967295)
634: MAX-ACCESS not-accessible
635: STATUS current
636: DESCRIPTION
637: "This MIB object provides the IANA enterprise number of
638: the Organization defining the event. Thus, all
639: PacketCable or IPCableCom defined events will contain
640: the PacketCable or IPCableCom IANA enterprise
641: number and for vendor-specific events it will contain
642: the IANA enterprise number of the defining
643: organization."
644: REFERENCE "IANA Enterprise ID assignment, [IANA-ENTERPRISE]."
645: ::= { pktcEventEntry 1 }
646:
647: pktcEventId OBJECT-TYPE
648: SYNTAX Unsigned32(1..4294967295)
649: MAX-ACCESS not-accessible
650: STATUS current
651: DESCRIPTION
652: "This MIB object contains the event identifier for the
653: corresponding event."
654: REFERENCE
655: "PacketCable Management Event Mechanism Specification,
656: [PKT-SP-MEM1.5];
657: PacketCable MTA Device Provisioning Specification,
658: [PKT-SP-PROV]."
659: ::= { pktcEventEntry 2 }
660:
661: pktcEventFacility OBJECT-TYPE
662: SYNTAX SyslogFacility
663: MAX-ACCESS read-only
664: STATUS current
665: DESCRIPTION
666: "This MIB object contains the facility
667: for the event.
668: For PacketCable, IPCableCom or ETSI events
669: this MUST be set to a value of local0(16)."
670: REFERENCE
671: "The syslog Protocol, [RFCAAA];
672: Textual Conventions for Syslog Management,
673: [RFCDDD]."
674: ::= { pktcEventEntry 3 }
675:
676: pktcEventSeverityLevel OBJECT-TYPE
677: SYNTAX SyslogSeverity
678: MAX-ACCESS read-write
679: STATUS current
680: DESCRIPTION
681: "This MIB object contains the severity level that
682: is applicable to the specified event."
683: REFERENCE
684: "The syslog Protocol, [RFCAAA];
685: Textual Conventions for Syslog Management,
686: [RFCDDD]."
687: ::= { pktcEventEntry 4 }
688:
689: pktcEventReporting OBJECT-TYPE
690: SYNTAX BITS {
691: local(0),
692: syslog(1),
693: snmpTrap(2),
694: snmpInform(3)
695: }
696:
697: MAX-ACCESS read-write
698: STATUS current
699: DESCRIPTION
700: "This MIB object defines the action to be taken on
701: occurrence of this event. Bit local(0) refers to local
702: logging of events, bit sylog(1) refers to the
703: transmission of events using syslog, bit snmpTrap(2)
704: refers to the transmission of events using SNMP Traps
705: (SNMPv2-Trap-PDU) and bit snmpInform(3)refers to the
706: transmission of events using SNMP INFORMs.
707:
708: Setting a bit to a value of '1' indicates that the
709: corresponding action will be taken upon occurrence of
710: this event. If none of the bits are set then no action
711: is taken upon occurrence of the event. The success of
712: transmission using syslog and SNMP depends on the
713: MTA configuration. For example, a valid syslog server
714: address is required for syslog message transmission.
715:
716: Specification of a management event does not necessarily
717: include the actions to be taken upon its generation,
718: i.e., it does not need to specify if a generated event
719: needs to be transmitted via SNMP, syslog or stored
720: locally. Thus, certain default values are specified,
721: based on the event's severity level specified by the
722: MIB object 'pktcEventSeverityLevel', as follows:
723: - If the severity level of an event is emergency(0),
724: alert(1), critical(2) or error(3), set the bits for
725: local(0), syslog(1) and snmpInform(3) to a value
726: of '1', and the remaining bits to a value of '0'.
727: - For an event with any other severity level set
728: the bits for local(0) and syslog(1) to a value of
729: of '1', and the rest of the bits to a value of '0'.
730: "
731: ::= { pktcEventEntry 5 }
732:
733:
734: pktcEventText OBJECT-TYPE
735: SYNTAX SnmpAdminString (SIZE (0..127))
736: MAX-ACCESS read-write
737: STATUS current
738: DESCRIPTION
739: "This MIB object provides a human-readable
740: description of the event. Descriptions need
741: to take into consideration the SnmpAdminString
742: definition requirements such as the use of
743: control code sequence CR LF to represent a
744: newline."
745: ::= { pktcEventEntry 6 }
746:
747: pktcEventClass OBJECT-TYPE
748: SYNTAX SnmpAdminString (SIZE (0..100))
749: MAX-ACCESS read-only
750: STATUS current
751: DESCRIPTION
752: "This MIB object represents the event class
753: that affects the event. If an event is associated
754: with only one event class, then its name
755: (pktcEventClassName) is reported. If an event
756: is associated with more than one event class,
757: then the name of the event class with the
758: lowest index in the event class table
759: (pktcEventClassTable) is reported.
760:
761: See the MIB table 'pktcEventClassTable'
762: for a description of event classes and usage.
763:
764: Descriptions need to take into consideration the
765: SnmpAdminString definition requirements such as
766: the use of control code sequence CR LF to
767: represent a newline."
768: ::= { pktcEventEntry 7 }
769:
770: ---
771: -- Log of generated events
772: ---
773: pktcEventLogTable OBJECT-TYPE
774: SYNTAX SEQUENCE OF PktcEventLogEntry
775: MAX-ACCESS not-accessible
776: STATUS current
777: DESCRIPTION
778: "This MIB table contains a log of the events
779: generated by the MTA.
780:
781: A description of all the events that can be
782: generated by the device can be obtained from the
783: MIB table 'pktcEventTable'.
784:
785: An MTA is not required to persist the contents of this
786: table across resets. In such cases, the log of events
787: is preserved across resets and reboots. If not, the
788: log of events is lost across resets and reboots."
789: ::= { pktcEventLog 1 }
790:
791: pktcEventLogEntry OBJECT-TYPE
792: SYNTAX PktcEventLogEntry
793: MAX-ACCESS not-accessible
794: STATUS current
795: DESCRIPTION
796: "Each entry in this table describes an event that
797: has occurred, indexed in the chronological order of
798: generation. The details of the event are borrowed
799: from the parameters associated with the corresponding
800: event entry in 'pktcEventTable', at the
801: time of the event generation.
802: While all entries created as such can be cleared using
803: the MIB object pktcEventReset, the Event entries
804: themselves cannot be individually deleted."
805:
806: INDEX { pktcEventLogIndex }
807: ::= { pktcEventLogTable 1 }
808:
809: PktcEventLogEntry ::= SEQUENCE {
810: pktcEventLogIndex Unsigned32,
811: pktcEventLogTime DateAndTime,
812: pktcEventLogOrganization Unsigned32,
813: pktcEventLogIdentifier Unsigned32,
814: pktcEventLogText SnmpAdminString,
815: pktcEventLogEndpointName SnmpAdminString,
816: pktcEventLogType BITS,
817: pktcEventLogTargetInfo SnmpAdminString,
818: pktcEventLogCorrelationId Unsigned32,
819: pktcEventLogAdditionalInfo SnmpAdminString
820: }
821:
822: pktcEventLogIndex OBJECT-TYPE
823: SYNTAX Unsigned32(1..4294967295)
824: MAX-ACCESS not-accessible
825: STATUS current
826: DESCRIPTION
827: "This MIB object provides relative ordering of the
828: objects in the event log.
829:
830: If the MTA implements non-volatile storage,
831: then this object will always increase except when
832: it reaches the value of 2^31.
833:
834: If the MTA does not implement non-volatile storage,
835: then this object will always increase except when
836: it reaches the value of 2^31 or the MTA is reset.
837:
838: When the value reaches 2^31 or is reset, newer events
839: will be stored starting with an index value of '1'
840: (cyclic rotation)."
841: ::= { pktcEventLogEntry 1 }
842:
843: pktcEventLogTime OBJECT-TYPE
844: SYNTAX DateAndTime
845: MAX-ACCESS read-only
846: STATUS current
847: DESCRIPTION
848: "This MIB object provides a human-readable description
849: of the time at which the event occurred. The time used
850: SHOULD comply with the specified syslog format
851: (see pktcEventSyslogMessageFormat)."
852: REFERENCE
853: "The BSD syslog Protocol, [RFC3164];
854: The syslog Protocol, [RFCAAA]."
855: ::= { pktcEventLogEntry 2 }
856:
857:
858: pktcEventLogOrganization OBJECT-TYPE
859: SYNTAX Unsigned32(1..4294967295)
860: MAX-ACCESS read-only
861: STATUS current
862: DESCRIPTION
863: "This MIB object provides the IANA enterprise number of
864: the Organization defining the event. Thus, all
865: PacketCable or IPCableCom defined events will contain
866: the CableLabs or IPCableCom IANA enterprise number and
867: for vendor-specific events it will contain the IANA
868: enterprise number of the defining organization."
869: ::= { pktcEventLogEntry 3 }
870:
871: pktcEventLogIdentifier OBJECT-TYPE
872: SYNTAX Unsigned32
873: MAX-ACCESS read-only
874: STATUS current
875: DESCRIPTION
876: "This MIB object contains the event identifier for the
877: corresponding event."
878: ::= { pktcEventLogEntry 4 }
879:
880: pktcEventLogText OBJECT-TYPE
881: SYNTAX SnmpAdminString (SIZE (0..127))
882: MAX-ACCESS read-only
883: STATUS current
884: DESCRIPTION
885: "This MIB object contains the contents of
886: the MIB object 'pktcEventText', corresponding
887: to the event, at the moment of generation."
888: ::= { pktcEventLogEntry 5 }
889:
890:
891: pktcEventLogEndpointName OBJECT-TYPE
892: SYNTAX SnmpAdminString (SIZE (0..255))
893: MAX-ACCESS read-only
894: STATUS current
895: DESCRIPTION
896: "This MIB object provides the endpoint identifier
897: followed by the PacketCable MTA's Fully Qualified
898: Domain Name (FQDN) and the IP Address (IP)
899: of the PacketCable MTA device.
900:
901: This will be denoted as follows:
902: aaln/n:<FQDN>/<IP>, where 'n' is the Endpoint number.
903: or
904: <FQDN>/<IP> if it is not specific to an endpoint.
905:
906: Endpoint identifiers need to observe the
907: SnmpAdminString definition requirements."
908: ::= { pktcEventLogEntry 6 }
909:
910: pktcEventLogType OBJECT-TYPE
911: SYNTAX BITS {
912: local(0),
913: syslog(1),
914: trap(2),
915: inform(3)
916: }
917: MAX-ACCESS read-only
918: STATUS current
919: DESCRIPTION
920: "This MIB object contains the type of actions taken by
921: the MTA, when the event indicated by the MIB object
922: 'pktcEventLogIdentifier' occurred.
923:
924: A bit with a value of '1' indicates the corresponding
925: action was taken. Setting it to a value of '0'
926: indicates that the corresponding action was not taken.
927:
928: An event may trigger one or more actions (e.g.: syslog
929: and SNMP), or result only in a local log. An action may
930: also be prevented due to throttling in which case it is
931: not reported by this MIB object."
932: ::= { pktcEventLogEntry 7 }
933:
934: pktcEventLogTargetInfo OBJECT-TYPE
935: SYNTAX SnmpAdminString (SIZE (0..255))
936: MAX-ACCESS read-only
937: STATUS current
938: DESCRIPTION
939: "This MIB object contains a comma separated list of the
940: actions taken for external notifications, along with the
941: target IP address for the generated events. Locally
942: stored events MUST NOT be recorded in this MIB object.
943:
944: The syntax is as:
945: <action-1/IP>,<action-2/IP>,<action-3/IP>
946:
947: Where <action-n/IP> is to be denoted as follows:
948: For syslog events:
949: syslog/<IP address of the syslog Server>
950: For SNMP traps:
951: snmpTrap/<IP address of the SNMP Server>
952: For SNMP INFORMS:
953: snmpInform/<IP address of the SNMP Server>
954:
955: If there are multiple targets for the same type (SNMP
956: Traps sent to multiple IP addresses) or if there are
957: multiple message types sent to the same IP (syslog and
958: SNMP sent to the same IP address) they need to be
959: reported individually.
960:
961: It is to be noted that this MIB object may not be able
962: to store all the data in some cases (e.g., multiple
963: IPv6 addresses) in which case some actions may not be
964: reported. In such cases, the MTA MUST present a value
965: of '...' at the end of the value.
966:
967: Values contained by this MIB object need to observe the
968: SnmpAdminString definition requirements."
969: ::= { pktcEventLogEntry 8 }
970:
971:
972: pktcEventLogCorrelationId OBJECT-TYPE
973: SYNTAX Unsigned32
974: MAX-ACCESS read-only
975: STATUS current
976: DESCRIPTION
977: "This MIB object contains the correlation ID
978: generated by the MTA during the initiation of the
979: last provisioning flow, within or following which
980: the event occurred.
981:
982: Although a Correlation-ID, once generated after MTA
983: reset, does not change until next MTA reset, the
984: value of this object will differ for the events
985: preserved across MTA resets in case of a persistent
986: pktcEventLogTable.
987:
988: For more information on the generation of correlation
989: ids, refer to the corresponding PacketCable/IPCableCom
990: Device Provisioning specifications."
991: REFERENCE
992: "PacketCable MTA Device Provisioning Specification,
993: [PKT-SP-PROV]."
994: ::= { pktcEventLogEntry 9 }
995:
996: pktcEventLogAdditionalInfo OBJECT-TYPE
997: SYNTAX SnmpAdminString (SIZE (0..255))
998: MAX-ACCESS read-only
999: STATUS current
1000: DESCRIPTION
1001: "This MIB object contains additional, useful
1002: information in relation to the corresponding event that
1003: an MTA might wish to report such as parameterized
1004: data or debugging information. The format is
1005: vendor-specific.
1006: If MTA cannot provide any additional information for
1007: the particular event generated, it MUST populate this
1008: MIB object with a zero-length OCTET-STRING. Vendors
1009: providing this information need to observe the
1010: SnmpAdminString definition requirements such as the
1011: use of control code sequence CR LF for newline."
1012: ::= { pktcEventLogEntry 10 }
1013:
1014:
1015: ---
1016: -- Notifications
1017: ---
1018:
1019: pktcEventNotification NOTIFICATION-TYPE
1020: OBJECTS {
1021: pktcEventLogTime,
1022: pktcEventLogOrganization,
1023: pktcEventLogIdentifier,
1024: pktcEventLogEndpointName,
1025: pktcEventLogCorrelationId,
1026: ifPhysAddress
1027: }
1028: STATUS current
1029: DESCRIPTION
1030: "This Notification MIB object contains the contents for
1031: event reporting.
1032:
1033: It contains the event log time, the organization
1034: ID, the event identifier, the endpoint identifier, the
1035: correlation id, and the MTA's MAC address."
1036: ::= { pktcEventNotifications 1 }
1037:
1038: ---
1039: -- Conformance/Compliance
1040: ---
1041:
1042:
1043: pktcEventCompliances OBJECT IDENTIFIER ::=
1044: { pktcEventConformance 1 }
1045: pktcEventGroups OBJECT IDENTIFIER ::=
1046: { pktcEventConformance 2 }
1047:
1048:
1049: pktcEventBasicCompliance MODULE-COMPLIANCE
1050: STATUS current
1051: DESCRIPTION
1052: "The compliance statement for devices that implement
1053: Event reporting feature."
1054: MODULE --pktcIetfEventMib
1055:
1056:
1057: MANDATORY-GROUPS {
1058: pktcEventGroup,
1059: pktcEventNotificationGroup
1060: }
1061:
1062: MODULE SNMP-TARGET-MIB
1063: MANDATORY-GROUPS {
1064: snmpTargetBasicGroup,
1065: snmpTargetResponseGroup
1066: }
1067:
1068: MODULE SNMP-NOTIFICATION-MIB
1069: MANDATORY-GROUPS {
1070: snmpNotifyGroup,
1071: snmpNotifyFilterGroup
1072: }
1073:
1074: ::= { pktcEventCompliances 3 }
1075:
1076: pktcEventGroup OBJECT-GROUP
1077: OBJECTS {
1078: pktcEventReset,
1079: pktcEventSyslogCapabilities,
1080: pktcEventSyslogAddressType,
1081: pktcEventSyslogAddress,
1082: pktcEventSyslogTransport,
1083: pktcEventSyslogPort,
1084: pktcEventSyslogMessageFormat,
1085: pktcEventThrottleAdminStatus,
1086: pktcEventThrottleThreshold,
1087: pktcEventThrottleInterval,
1088: pktcEventTransmissionStatus,
1089: pktcEventFacility,
1090: pktcEventSeverityLevel,
1091: pktcEventReporting,
1092: pktcEventText,
1093: pktcEventLogTime,
1094: pktcEventLogOrganization,
1095: pktcEventLogIdentifier,
1096: pktcEventLogText,
1097: pktcEventLogEndpointName,
1098: pktcEventLogType,
1099: pktcEventLogTargetInfo,
1100: pktcEventLogCorrelationId,
1101: pktcEventLogAdditionalInfo,
1102: pktcEventClass,
1103: pktcEventClassName,
1104: pktcEventClassStatus,
1105: pktcEventClassSeverity
1106: }
1107:
1108: STATUS current
1109: DESCRIPTION
1110: "Group of MIB objects for PacketCable Management Event
1111: MIB."
1112: ::= { pktcEventGroups 1 }
1113:
1114:
1115: pktcEventNotificationGroup NOTIFICATION-GROUP
1116: NOTIFICATIONS { pktcEventNotification }
1117: STATUS current
1118: DESCRIPTION
1119: "Group of MIB objects for notifications related to
1120: change in status of the MTA Device."
1121: ::= { pktcEventGroups 2 }
1122: END
1123:
1124: --
1125: -- Copyright (C) The IETF Trust (2007).
1126: --
1127: -- This document is subject to the rights, licenses and restrictions
1128: -- contained in BCP 78, and except as set forth therein, the authors
1129: -- retain all their rights.
1130: --
1131: -- This document and the information contained herein are provided on
1132: -- an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE
1133: -- REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE
1134: -- IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL
1135: -- WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY
1136: -- WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE
1137: -- ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS
1138: -- FOR A PARTICULAR PURPOSE.
1139: --
1140: -- Intellectual Property
1141: --
1142: -- The IETF takes no position regarding the validity or scope of any
1143: -- Intellectual Property Rights or other rights that might be claimed
1144: -- to pertain to the implementation or use of the technology described
1145: -- in this document or the extent to which any license under such
1146: -- rights might or might not be available; nor does it represent that
1147: -- it has made any independent effort to identify any such rights.
1148: -- Information on the procedures with respect to rights in RFC
1149: -- documents can be found in BCP 78 and BCP 79.
1150: --
1151: -- Copies of IPR disclosures made to the IETF Secretariat and any
1152: -- assurances of licenses to be made available, or the result of an
1153: -- attempt made to obtain a general license or permission for the use
1154: -- of such proprietary rights by implementers or users of this
1155: -- specification can be obtained from the IETF on-line IPR repository
1156: -- at http://www.ietf.org/ipr.
1157: --
1158: -- The IETF invites any interested party to bring to its attention any
1159: -- copyrights, patents or patent applications, or other proprietary
1160: -- rights that may cover technology that may be required to implement
1161: -- this standard. Please address the information to the IETF at ietf-
1162: -- ipr@ietf.org.
1163: --
1164: