idnits 2.17.1 draft-ietf-ipcdn-pktc-eventmess-14.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3978, Section 5.1 on line 17. -- Found old boilerplate from RFC 3978, Section 5.5, updated by RFC 4748 on line 1800. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 1811. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 1818. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 1826. ** The document seems to lack an RFC 3978 Section 5.4 (updated by RFC 4748) Copyright Line. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (August 15, 2008) is 5732 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Possible downref: Non-RFC (?) normative reference: ref. 'PKT-SP-PROV' -- Possible downref: Non-RFC (?) normative reference: ref. 'RFCABC' -- Possible downref: Non-RFC (?) normative reference: ref. 'RFCAAA' -- Possible downref: Non-RFC (?) normative reference: ref. 'RFCBBB' -- Possible downref: Non-RFC (?) normative reference: ref. 'RFCCCC' -- Possible downref: Non-RFC (?) normative reference: ref. 'RFCDDD' -- Possible downref: Non-RFC (?) normative reference: ref. 'RFCEEE' -- Possible downref: Non-RFC (?) normative reference: ref. 'ITU-T-J176' -- Possible downref: Non-RFC (?) normative reference: ref. 'ETSITS101909-22' -- Possible downref: Non-RFC (?) normative reference: ref. 'IANA-ENTERPRISE' -- Obsolete informational reference (is this intentional?): RFC 3164 (Obsoleted by RFC 5424) Summary: 2 errors (**), 0 flaws (~~), 1 warning (==), 18 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 IPCDN Working Group Wim De Ketelaere 2 INTERNET-DRAFT tComLabs 3 draft-ietf-ipcdn-pktc-eventmess-14 Eugene Nechamkin 4 Category: Standards Track Broadcom Corp. 5 Sumanth Channabasappa 6 CableLabs 7 Expires: February 14, 2009 August 15, 2008 9 Management Event Management Information Base (MIB) 10 for PacketCable- and IPCablecom-Compliant Devices 12 Status of this Memo 14 By submitting this Internet-Draft, each author represents that any 15 applicable patent or other IPR claims of which he or she is aware 16 have been or will be disclosed, and any of which he or she becomes 17 aware will be disclosed, in accordance with Section 6 of BCP 79. 19 Internet-Drafts are working documents of the Internet Engineering 20 Task Force (IETF), its areas, and its working groups. Note that 21 other groups may also distribute working documents as Internet- 22 Drafts. 24 Internet-Drafts are draft documents valid for a maximum of six 25 months and may be updated, replaced, or obsoleted by other documents 26 at any time. It is inappropriate to use Internet-Drafts as 27 reference material or to cite them other than as "work in progress." 29 The list of current Internet-Drafts can be accessed at 30 http://www.ietf.org/ietf/1id-abstracts.html 32 The list of Internet-Draft Shadow Directories can be accessed at 33 http://www.ietf.org/shadow.html 35 Abstract 37 This memo defines a portion of the Management Information Base (MIB) 38 for use with network management protocols in the Internet community. 39 In particular, it defines a basic set of managed objects for Simple 40 Network Management Protocol (SNMP)-based management of events that 41 can be generated by PacketCable- and IPCablecom-compliant Multimedia 42 Terminal Adapter devices. 44 PacketCable/IPCablecom Event management MTA MIB August 2008 46 Table of Contents 47 1. The Internet-Standard Management Framework....................2 48 2. Introduction..................................................2 49 3. Terminology...................................................3 50 3.1 PacketCable...............................................3 51 3.2 IPCableCom................................................3 52 3.3 MTA.......................................................4 53 3.4 Endpoint..................................................4 54 3.5 MSO.......................................................4 55 3.6 UDP.......................................................4 56 4. Overview......................................................4 57 4.1 Structure of the MIB......................................5 58 4.2 pktcEventControl..........................................6 59 4.3 pktcEventThrottle.........................................6 60 4.4 pktcEventStatus...........................................7 61 4.5 pktcEvent.................................................7 62 4.6 pktcEventLog..............................................7 63 4.7 pktcEventNotifications....................................7 64 5. Relationship to Other MIB Modules.............................7 65 5.1 MIB modules required for IMPORTS..........................7 66 6. Definitions...................................................7 67 7. Acknowledgments..............................................31 68 8. Normative References.........................................31 69 9. Informative References.......................................34 70 10. IANA Considerations.........................................34 71 11. Security Considerations.....................................34 72 12. Authors' Addresses..........................................36 73 Full Copyright Statement........................................37 74 Intellectual Property...........................................37 76 1. The Internet-Standard Management Framework 78 For a detailed overview of the documents that describe the current 79 Internet-Standard Management Framework, please refer to section 7 of 80 RFC 3410 [RFC3410]. 82 Managed objects are accessed via a virtual information store, termed 83 the Management Information Base or MIB. MIB objects are generally 84 accessed through the Simple Network Management Protocol (SNMP). 85 Objects in the MIB are defined using the mechanisms defined in the 86 Structure of Management Information (SMI). This memo specifies a 87 MIB module that is compliant to the SMIv2, which is described in STD 88 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 89 2580 [RFC2580]. 91 2. Introduction 92 PacketCable/IPCablecom Event management MTA MIB August 2008 94 A multimedia terminal adapter (MTA) is used to deliver broadband 95 Internet, data, and/or voice access jointly with telephony service 96 to a subscriber's or customer's premises using a cable network 97 infrastructure. A MTA is normally installed at the customer's or 98 subscriber's premises, and it is coupled to a multiple system 99 operator (MSO) using a hybrid fiber coax (HFC) access network. 101 A MTA is provisioned by the MSO for broadband Internet, data, and/or 102 voice service. For more information on MTA provisioning refer to 103 [PKT-SP-PROV] and [RFC4682]. MTA devices include one or more 104 endpoints (e.g., telephone ports) which receive call signaling 105 information to establish ring cadence, and codecs used for providing 106 telephony service. 108 For more information on call signaling refer to [PKT-SP-MGCP] and 109 [RFC3435]. 111 For more information on codecs refer to [PKT-SP-CODEC]. 113 Given the complexity of such systems it is important that a suitable 114 event management mechanism be defined to allow for effective 115 management. This MIB module provides objects suitable for generation 116 and management of events on the MTA. 118 3. Terminology 120 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 121 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 122 document are to be interpreted as described in RFC 2119 [RFC2119]. 124 The terms "MIB module" and "information module" are used 125 interchangeably in this memo. As used here, both terms refer to any 126 of the three types of information modules defined in Section 3 of 127 RFC 2578 [RFC2578]. Some of the terms used in this memo are defined 128 below. Some additional terms are also defined in the 129 PacketCable(TM) 130 Management Event Mechanism Specification [PKT-SP-MEM1.5] and the 131 PacketCable MTA Device Provisioning Specification [PKT-SP-PROV]. 133 3.1 PacketCable 134 PacketCable is a CableLabs-led initiative that is aimed at 135 developing interoperable interface specifications for delivering 136 advanced, real-time multimedia services over two-way cable plants. 138 3.2 IPCableCom 139 IPCableCom is an ITU Telecommunication Standardization Sector 140 (ITU-T) project that includes architecture and a series of 141 recommendations that enable the delivery of real time services over 142 the cable television networks using cable modems. 144 PacketCable/IPCablecom Event management MTA MIB August 2008 146 3.3 MTA 148 A Multimedia Terminal Adapter (MTA) is a PacketCable or IPCablecom 149 compliant device providing telephony services over a cable or hybrid 150 system used to deliver video signals to a community. It contains an 151 interface to endpoints, a network interface, codecs, and all 152 signaling and encapsulation functions required for Voice over IP 153 transport, call signaling, and Quality of Service signaling. A MTA 154 can be an embedded or a standalone device. An Embedded MTA (E-MTA) 155 is a MTA device containing an embedded Data Over Cable Service 156 Interface Specifications (DOCSIS) Cable Modem. A Standalone MTA 157 (S-MTA) is a MTA device separated from the DOCSIS Cable Modem by 158 non-DOCSIS MAC interface (e.g., Ethernet, USB). 160 3.4 Endpoint 161 An endpoint or MTA endpoint is a standard RJ-11 telephony physical 162 port located on the MTA and used for attaching the telephone device 163 to the MTA. 165 3.5 MSO 166 Multi-System Operator. A cable company that operates many head-end 167 locations in several cities. 169 3.6 UDP 170 User Datagram Protocol. A connectionless protocol built upon 171 Internet Protocol (IP), as per RFC 768 [RFC768]. 173 4. Overview 175 PacketCable, European Telecommunications Standards Institute (ETSI), 176 and International Telecommunication Union Telecommunication 177 Standardization Sector (ITU-T) IPCablecom compliant 178 Multimedia Terminal Adaptors (MTAs) are required to generate 179 management events upon the occurrence of certain operational 180 conditions. For instance, "AC power failure, MTA operational on 181 battery power". The complete set of conditions and the corresponding 182 management events to be generated are specified in [PKT-SP-MEM1.5], 183 [ETSITS101909-22] and [ITU-T-J176], respectively. In addition, the 184 MTA manufacturer is allowed to specify vendor-specific management 185 events. For example, vendor XYZ can specify "Memory read error, 186 terminating process, code: XYZ123". 188 When management events are generated, they can either be stored in a 189 local log on the MTA, or transmitted using two possible mechanisms: 190 SNMP and syslog. This is required to be configurable and manageable 191 PacketCable/IPCablecom Event management MTA MIB August 2008 193 by the management station for each management event (default values 194 can be provided when the events are defined). This Internet-Draft 195 proposes a MIB that can provide for configuration and management of 196 such management events. A means to log the events is provided within 197 the specified MIB module. For syslog as a transport, the necessary 198 information (format, transport etc.) is also specified. For SNMP as 199 a transport, the MIB objects specified in the SNMP-TARGET-MIB and 200 SNMP-NOTIFICATION-MIB as utilized, as specified in [RFC3413]. 202 Further, each management event can be uniquely identified using the 203 'Organization ID' and an 'Event ID'. The 'Organization ID' is the 204 enterprise ID of the organization specifying the event (e.g., 4491 205 for CableLabs) and a unique identifier that identifies the event. 206 The 'Event ID' is an identifier that uniquely identifies the event 207 within the 'Organization ID' space. This Internet-Draft does not 208 specify any management events. It only provides a mechanism to 209 manage the storage and transmission of events. 211 The EVENT MIB module specified in this document is intended to 212 update the EVENT MIB modules from which it is partly derived: 213 - the PacketCable 1.5 Management Event MIB Specification 214 [PKT-SP-EVEMIB1.5], 215 - the ITU-T IPCablecom management event mechanism MIB requirements 216 [ITU-T-J176] 218 Several normative and informative references are used to help define 219 Management Event MIB objects. As a convention, wherever the 220 requirements are equivalent at the time of the writing, the 221 PacketCable reference is used. However, MTA implementations MUST 222 refer to the corresponding specifications to ensure compliance. 224 4.1 Structure of the MIB 226 The Management Event MIB module is identified by pktcIetfEventMib 227 and is structured into the following sub-trees: 229 - pktcEventControl specifies the management information pertinent to 230 control of the device's event generation capabilities. 232 - pktcEventThrottle specifies the management information pertinent 233 to throttling the transmission of management events using syslog or 234 SNMP. 236 - pktcEventStatus specifies the management information for the 237 device to report status information related to the generated events. 239 - pktcEvents specifies the management information for the device to 240 list all the events it is capable of generating. 242 PacketCable/IPCablecom Event management MTA MIB August 2008 244 - pktcEventLog specifies the management information for the device 245 to store the generated events. 247 - pktcEventNotifications specifies the management information that 248 defines the SNMP trap and inform messages. 250 4.2 pktcEventControl 251 The group of objects in this sub-tree provide for three important 252 controls: ability to reset the event logs and event descriptions, 253 syslog configuration and event classes. 255 Some highlights are as follows: 257 pktcEventReset - this MIB object allows a management station to 258 reset the event logs, the event descriptions, or both. 260 pktcEventSyslog - this group of MIB objects allow the management 261 station to provide information for transmission of events to a 262 syslog server, such as message formats and transport protocols. 264 pktcEventClassTable - this MIB table allows for MTAs to classify the 265 management events into different categories, termed 'event classes'. 266 It then allows for common operations to be affected across all the 267 events pertaining to a specific event class. 269 4.3 pktcEventThrottle 270 As indicated earlier, the generated events can be stored locally, or 271 transmitted using SNMP, Syslog, or both. However, the management 272 stations receiving such events may wish to control the rate of 273 transmission of such events. This event throttling behavior is 274 provided by the MIB objects in this sub-tree. 276 Some highlights are as follows: 278 pktcEventThrottleAdminStatus - this MIB object allows for 279 transmissions to be unconstrained, maintained below threshold, 280 stopped at the threshold or inhibited. 282 pktcEventThrottleThreshold - this MIB object specifies the throttle, 283 i.e., the number of events over an interval that is considered to be 284 the threshold. 286 pktcEventThrottleInterval - this MIB object specifies the interval 287 over which the threshold is calculated. 289 PacketCable/IPCablecom Event management MTA MIB August 2008 291 4.4 pktcEventStatus 292 This sub-tree is designed to provide status information related to 293 event transmissions. It currently contains one MIB object, 294 pktcEventTransmissionStatus, that allows a client to report the 295 status of event transmissions. 297 4.5 pktcEvent 298 This sub-tree is designed to provide a list of all the events that 299 can be generated by an MTA and its associated descriptions. The MIB 300 objects are grouped under the MIB table pktcEventTable. 302 4.6 pktcEventLog 303 This sub-tree is designed to allow the MTA to store all the events 304 that are generated during its operation. The events are stored with 305 information such as the time of the event, its description and 306 related characteristics like severity levels. 308 4.7 pktcEventNotifications 309 This sub-tree specifies the notification information, when MTAs 310 transmit messages using SNMP traps and informs. SNMP traps refer to 311 the SNMPv2-Trap-PDU. SNMPv1 traps are disallowed. 313 5. Relationship to Other MIB Modules 314 Some management objects defined in other MIB modules are applicable 315 to an entity implementing this MIB. In particular, it is assumed 316 that an entity implementing the PKTC-IETF-EVENT-MIB module will also 317 implement the 'interfaces' group of the IF-MIB [RFC2863]. 319 5.1 MIB modules required for IMPORTS 320 The PKTC-IETF-EVENT-MIB MIB module IMPORTS objects from SNMPv2-SMI 321 [RFC2578], SNMPv2-TC [RFC2579], SNMP-FRAMEWORK-MIB [RFC3411], 322 SNMPv2-CONF [RFC2580], IF-MIB [RFC2863], INET-ADDRESS-MIB [RFC4001], 323 SNMP-TARGET-MIB [RFC3413], SNMP-NOTIFICATION-MIB [RFC3413] and the 324 SYSLOG-TC-MIB [RFCDDD]. 326 6. Definitions 328 PKTC-IETF-EVENT-MIB DEFINITIONS ::= BEGIN 330 IMPORTS 331 MODULE-IDENTITY, 332 OBJECT-TYPE, 333 Unsigned32, 334 NOTIFICATION-TYPE, 335 mib-2 FROM SNMPv2-SMI 336 PacketCable/IPCablecom Event management MTA MIB August 2008 338 TruthValue, 339 DateAndTime, TEXTUAL-CONVENTION 340 FROM SNMPv2-TC 341 SnmpAdminString FROM SNMP-FRAMEWORK-MIB 342 OBJECT-GROUP, 343 MODULE-COMPLIANCE, 344 NOTIFICATION-GROUP FROM SNMPv2-CONF 345 ifPhysAddress FROM IF-MIB 346 InetAddressType, 347 InetAddress, 348 InetPortNumber FROM INET-ADDRESS-MIB 349 snmpTargetBasicGroup, snmpTargetResponseGroup 350 FROM SNMP-TARGET-MIB 351 snmpNotifyGroup, snmpNotifyFilterGroup 352 FROM SNMP-NOTIFICATION-MIB 353 SyslogSeverity, SyslogFacility FROM SYSLOG-TC-MIB; 355 pktcIetfEventMib MODULE-IDENTITY 356 LAST-UPDATED "200808150000Z" -- August 15, 2008 357 ORGANIZATION "IETF IP over Cable Data Network Working Group" 358 CONTACT-INFO 359 "Sumanth Channabasappa 360 Cable Television Laboratories, Inc. 361 858 Coal Creek Circle, 362 Louisville, CO 80027, USA 363 +1 303-661-3307 364 Sumanth@cablelabs.com 366 Wim De Ketelaere 367 tComLabs 368 Gildestraat 8 369 9000 Gent, Belgium 370 +32 9 269 22 90 371 deketelaere@tComLabs.com 373 Eugene Nechamkin 374 Broadcom Corporation 375 200 - 13711 International Place 376 Richmond, BC, V6V 2Z8, Canada 377 +1 604 233 8500 378 enechamkin@broadcom.com 380 IETF IPCDN Working Group 381 General Discussion: ipcdn@ietf.org 382 Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn 383 Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn 384 Co-Chair: Jean-Francois Mule, jf.mule@cablelabs.com 385 Co-Chair: Richard Woundy, Richard_Woundy@cable.comcast.com" 386 PacketCable/IPCablecom Event management MTA MIB August 2008 388 DESCRIPTION 389 "This MIB module specifies the basic management objects 390 for managing events generated by the Multimedia 391 Terminal Adapter devices compliant with the PacketCable 392 and IPCablecom requirements. 394 Copyright (C) The IETF Trust (2008). This version 395 of this MIB module is part of RFC nnnn; see the RFC 396 itself for full legal notices." 397 -- RFC Ed: replace nnnn with actual RFC number and remove this note. 399 REVISION "200808150000Z" -- August 15, 2008 401 DESCRIPTION 402 "Initial version, published as RFC yyyy." 403 -- RFC Ed: replace yyyy with actual RFC number and remove this note 405 ::= { mib-2 XXX } 406 -- RFC Ed: replace XXX with IANA-assigned number and remove this 407 -- note 409 SyslogSeverityMask ::= TEXTUAL-CONVENTION 410 STATUS current 411 DESCRIPTION 412 "This textual convention represents a bit mask representing 413 the severity of the syslog events that can be generated. 414 It corresponds to the various severity levels associated 415 with syslog messages, as specified in The syslog Protocol, 416 [RFCAAA]. 418 emerg (0), - emergency; system is unusable 419 alert (1), - action must be taken immediately 420 crit (2), - critical condition 421 err (3), - error condition 422 warning (4), - warning condition 423 notice (5), - normal but significant condition 424 info (6), - informational message 425 debug (7) - debug-level messages" 427 SYNTAX BITS { 428 emerg(0), 429 alert(1), 430 crit(2), 431 err(3), 432 warning(4), 433 notice(5), 434 PacketCable/IPCablecom Event management MTA MIB August 2008 436 info(6), 437 debug(7) 438 } 440 -- 441 -- 442 pktcEventNotifications OBJECT IDENTIFIER ::= { pktcIetfEventMib 0 } 443 pktcEventMibObjects OBJECT IDENTIFIER ::= { pktcIetfEventMib 1 } 444 pktcEventConformance OBJECT IDENTIFIER ::= { pktcIetfEventMib 2 } 445 -- 446 -- 447 pktcEventControl OBJECT IDENTIFIER ::= { pktcEventMibObjects 1 } 448 pktcEventThrottle OBJECT IDENTIFIER ::= { pktcEventMibObjects 2 } 449 pktcEventStatus OBJECT IDENTIFIER ::= { pktcEventMibObjects 3 } 450 pktcEvents OBJECT IDENTIFIER ::= { pktcEventMibObjects 4 } 451 pktcEventLog OBJECT IDENTIFIER ::= { pktcEventMibObjects 5 } 453 --- 454 -- Event Reporting control objects 455 --- 456 pktcEventReset OBJECT-TYPE 457 SYNTAX BITS { 458 resetEventLogTable(0), 459 resetEventTable(1) 460 } 461 MAX-ACCESS read-write 462 STATUS current 463 DESCRIPTION 464 "This MIB object allows a management station to 465 clear the local log of generated events, reset the 466 management event descriptions, or both. 468 MTAs generate management events. These events are stored 469 in the MIB table 'pktcEventLogTable'. If a management 470 station needs to clear all the current entries (e.g., 471 after a troubleshooting operation is complete), it can 472 do so by setting the resetEventLogTable(0) bit to a 473 value of '1'. 475 The MTA is pre-configured with the events that it can 476 generate. This is stored in the MIB table 477 'pktcEventTable'. This table also contains the 478 descriptions associated with these events. These 479 descriptions can be modified by a management station. 480 However, if the management station wishes to reset the 481 descriptions, to factory defaults, it can do so by 482 setting the resetEventTable(1) bit to a value of '1'. 484 PacketCable/IPCablecom Event management MTA MIB August 2008 486 The MTA actions are summarized below: 488 Bit resetEventLogTable(0) set to a value of '1' 489 - delete all entries in pktcEventLogTable; 490 - reset the value of pktcEventLogIndex to '0'. 492 Bit resetEventTable(1) set to a value of '1' 493 - reset the pktcEventTable to the 494 factory default values. 496 Bits resetEventLogTable(0) and resetEventTable(1) 497 set to a value of '1' 498 - perform the above actions as though they were 499 performed individually (in any order). 501 Setting a reset bit to a value of '0' MUST NOT 502 result in any action. 504 The MTA MUST perform the above actions regardless of 505 persistence (i.e. storage in non-volatile memory). 507 The MTA MUST always return a value of '00' when 508 this MIB object is read. 510 A management station that resets tables using this MIB 511 Object needs to be careful about the impacts to other 512 management stations that may be reliant on the 513 information contained in the table(s) being reset. For 514 example, say management station A creates a specific set 515 of event descriptions in the event table 516 (pktcEventTable) for debugging purposes and expects any 517 generated events to report the modified descriptions. In 518 such a case, if another management station resets the 519 event table to factory defaults, any subsequent events 520 will not contain the modified descriptions expected by 521 management station A. Such multi-manager contentions are 522 not addressed within this MIB module. Thus, management 523 stations are RECOMMENDED to use this MIB object with 524 care and caution, and only when absolutely required." 525 ::= { pktcEventControl 1 } 527 --- 528 -- syslog-specific MIB objects 529 --- 530 pktcEventSyslog OBJECT IDENTIFIER ::= { pktcEventControl 2 } 532 pktcEventSyslogCapabilities OBJECT-TYPE 533 PacketCable/IPCablecom Event management MTA MIB August 2008 535 SYNTAX BITS { 536 formatBSDSyslog(0), 537 formatSyslogProtocol(1), 538 transportUDP(2), 539 transportTLS(3), 540 transportBEEP(4) 541 } 542 MAX-ACCESS read-only 543 STATUS current 544 DESCRIPTION 545 "This MIB object contains the MTA capabilities 546 for supporting the Syslog protocol, specifically 547 the message formats and the transport protocols. 549 The BSD syslog message format is specified 550 in [RFC3164] (formatBSDSyslog), and the IETF 551 syslog protocol is specified in [RFCAAA] 552 (formatSyslogProtocol). 554 The MTA MUST set the appropriate protocol and 555 transport bits, based on implementation." 556 REFERENCE 557 "The BSD syslog Protocol, [RFC3164]; 558 The syslog Protocol, [RFCAAA]; 559 Transmission of syslog messages over UDP, [RFCBBB]; 560 TLS Transport Mapping for Syslog, [RFCCCC]; 561 Reliable Delivery for syslog, [RFCEEE]." 562 ::= { pktcEventSyslog 1 } 564 pktcEventSyslogAddressType OBJECT-TYPE 565 SYNTAX InetAddressType 566 MAX-ACCESS read-write 567 STATUS current 568 DESCRIPTION 569 "This MIB object defines the Internet address type of 570 the syslog server specified by the MIB object 571 'pktcEventSyslogAddress' . A value of dns(16) is 572 disallowed since a non-resolvable DNS domain name 573 will leave the device without a syslog server to 574 which it can report events." 575 REFERENCE 576 "PacketCable MTA Device Provisioning Specification, 577 [PKT-SP-PROV]." 578 DEFVAL { ipv4 } 579 ::= { pktcEventSyslog 2 } 581 pktcEventSyslogAddress OBJECT-TYPE 582 SYNTAX InetAddress 583 PacketCable/IPCablecom Event management MTA MIB August 2008 585 MAX-ACCESS read-write 586 STATUS current 587 DESCRIPTION 588 "This MIB object contains the IP address of the 589 syslog server to which the MTA can transmit a syslog 590 message upon the generation of a management event. 591 The type of address this object represents is defined 592 by the MIB object pktDevEventSyslogAddressType. 594 The format of the syslog message is specified by the 595 MIB object 'pktcEventSyslogMessageFormat'." 596 REFERENCE 597 "PacketCable MTA Device Provisioning Specification, 598 [PKT-SP-PROV]; 599 PacketCable Management Event Mechanism Specification, 600 [PKT-SP-MEM1.5];" 601 DEFVAL { "0.0.0.0" } 602 ::= { pktcEventSyslog 3 } 604 pktcEventSyslogMessageFormat OBJECT-TYPE 605 SYNTAX INTEGER { 606 formatBSDSyslog(1), -- The BSD syslog Protocol 607 formatSyslogProtocol(2) -- The syslog Protocol 608 } 609 MAX-ACCESS read-write 610 STATUS current 611 DESCRIPTION 612 "This MIB object contains the syslog message format to 613 be used for transmitting syslog messages to the server 614 contained in the MIB object 'pktcEventSyslogServer'." 615 REFERENCE 616 "The BSD syslog Protocol, [RFC3164]; 617 The syslog Protocol, [RFCAAA]." 618 DEFVAL { formatSyslogProtocol } 619 ::= { pktcEventSyslog 4 } 621 pktcEventSyslogTransport OBJECT-TYPE 622 SYNTAX INTEGER { 623 udp(1),-- Transmission of syslog messages over UDP 624 tls(2),-- TLS Transport Mapping for Syslog 625 beep(3)-- BEEP Transport Mapping for Syslog 626 } 627 MAX-ACCESS read-write 628 STATUS current 629 DESCRIPTION 630 "This MIB object specifies the transport to be 631 used to transmit syslog messages to the syslog 632 server contained in the MIB object 633 'pktcEventSyslogAddress'. 635 PacketCable/IPCablecom Event management MTA MIB August 2008 637 If the MTA does not support the transport 638 specified in a SET operation, then the 639 MTA MUST return an appropriate error 640 response, such as 'inconsistentValue'." 641 REFERENCE 642 "Transmission of syslog messages over UDP, [RFCBBB]; 643 TLS Transport Mapping for Syslog, [RFCCCC]." 644 DEFVAL {tls} 645 ::= { pktcEventSyslog 5 } 647 pktcEventSyslogPort OBJECT-TYPE 648 SYNTAX InetPortNumber 649 MAX-ACCESS read-write 650 STATUS current 651 DESCRIPTION 652 "This MIB object contains the port number of the 653 syslog Server to which the syslog messages are to 654 be transmitted." 655 REFERENCE 656 "Transmission of syslog messages over UDP, [RFCBBB]; 657 TLS Transport Mapping for Syslog, [RFCCCC]." 658 DEFVAL { syslogs } 660 -- RFC Editor: Please replace syslogs with the IANA-assigned 661 -- SYSLOG over TLS port in [RFCCCC] and remove this note. 663 ::= { pktcEventSyslog 6 } 665 --- 666 -- Event classes 667 --- 669 pktcEventClassTable OBJECT-TYPE 670 SYNTAX SEQUENCE OF PktcEventClassEntry 671 MAX-ACCESS not-accessible 672 STATUS current 673 DESCRIPTION 674 "This MIB table allows for management events that can be 675 generated by an MTA to be classified into categories, 676 or 'event classes'. For example, all the configuration 677 related events can be associated with an event class 678 titled 'configuration'. Such as a classification allows 679 for a management station to affect changes on a common 680 group of events, at once. Two operations are specified 681 on an event class: enabling or disabling of all the 682 PacketCable/IPCablecom Event management MTA MIB August 2008 684 events in an event class, and selective enabling or 685 disabling based on the severity level." 686 ::= { pktcEventControl 3 } 688 pktcEventClassEntry OBJECT-TYPE 689 SYNTAX PktcEventClassEntry 690 MAX-ACCESS not-accessible 691 STATUS current 692 DESCRIPTION 693 "Each entry in this table specifies an event class, a 694 grouping of events, as identified by the MTA 695 manufacturer. Any event associated with an event class 696 in this table MUST be specified in the 697 pktcEventTable. 699 The MTA MUST create one entry (index=100) for the event 700 class titled 'generic'. This event class MUST contain 701 all the events that are not contained in any other 702 vendor specified event classes. 704 A management station SHOULD NOT associate an event 705 with multiple event classes. However, if an event is 706 associated with multiple event classes, the MTA 707 MUST give precedence to the event class with the 708 lowest index. Thus, at a given point in time, 709 only one event class is applicable for an event. 711 The event table (pktcEventTable) provides the event 712 class that affects the event. Whenever an event is 713 generated, the MTA MUST verify the applicable 714 event class entry to take any specified actions. 716 Entries in this table persist across resets and 717 reboots." 718 INDEX { pktcEventClassIndex } 719 ::= { pktcEventClassTable 1 } 721 PktcEventClassEntry::= SEQUENCE { 722 pktcEventClassIndex Unsigned32, 723 pktcEventClassName SnmpAdminString, 724 pktcEventClassStatus TruthValue, 725 pktcEventClassSeverity SyslogSeverityMask 726 } 728 pktcEventClassIndex OBJECT-TYPE 729 SYNTAX Unsigned32 (1..100) 730 MAX-ACCESS not-accessible 731 STATUS current 732 DESCRIPTION 733 PacketCable/IPCablecom Event management MTA MIB August 2008 735 "This MIB object is an index into the event 736 class table. It is a locally-meaningful 737 value." 738 ::= { pktcEventClassEntry 1 } 740 pktcEventClassName OBJECT-TYPE 741 SYNTAX SnmpAdminString (SIZE (1..100)) 742 MAX-ACCESS read-only 743 STATUS current 744 DESCRIPTION 745 "This MIB object contains the name of the 746 event class. 748 Vendors MAY define different event classes 749 (e.g. DHCP, SNMP, DEBUG) to group together 750 management events of a particular category. 752 Event class names need to take into 753 consideration the SnmpAdminString definition 754 requirements such as the use of control code 755 sequence CR LF to represent a newline." 756 ::= { pktcEventClassEntry 2 } 758 pktcEventClassStatus OBJECT-TYPE 759 SYNTAX TruthValue 760 MAX-ACCESS read-write 761 STATUS current 762 DESCRIPTION 763 "This MIB object indicates if events belonging 764 to the corresponding event class are enabled 765 or disabled, for event reporting. 767 Setting this object to a value of 'true' enables 768 reporting of all the events in the event class. 770 When enabled, the means of reporting events is 771 specified by the MIB object 'pktcEventReporting'. 773 Setting this object to a value of 'false' disables 774 any event reporting, irrespective of the value of the 775 MIB object 'pktcEventReporting' for a specific 776 event. 778 The default value of this MIB object is vendor 779 specific. However, the vendor SHOULD enable all 780 event categories defined by PacketCable or 781 IPCableCom, by default." 782 ::= { pktcEventClassEntry 3 } 783 PacketCable/IPCablecom Event management MTA MIB August 2008 785 pktcEventClassSeverity OBJECT-TYPE 786 SYNTAX SyslogSeverityMask 787 MAX-ACCESS read-write 788 STATUS current 789 DESCRIPTION 790 "This MIB object defines the severity level 791 of events belonging to a specific event class 792 that are enabled for event reporting. 794 This MIB object has no effect on the event 795 reporting unless the MIB object 796 'pktcEventClassStatus' is set to a value 797 of 'true' (enabled), for the corresponding 798 event class. 800 Setting a bit within the mask to a value of '1' 801 implies that events corresponding to that 802 severity level MUST be reported as defined by 803 the corresponding value of 'pktcEventReporting' 804 for events in the event class. 806 Setting a bit to a value of '0' implies that 807 events corresponding to that level MUST NOT be 808 reported, irrespective of the corresponding 809 value of 'pktcEventReporting' for events 810 in the event class. 812 It is recommended that the bits corresponding 813 to emerg(0), alert(1), crit(2) and err(3) 814 be set to a value of '1' to ensure reporting of 815 events requiring immediate attention." 816 REFERENCE 817 "The syslog Protocol, [RFCAAA]; 818 Syslog Management Information Base, [RFCABC]." 819 ::= { pktcEventClassEntry 4 } 821 --- 822 -- Event throttling control 823 --- 825 pktcEventThrottleAdminStatus OBJECT-TYPE 826 SYNTAX INTEGER { 827 unconstrained(1), 828 maintainBelowThreshold(2), 829 stopAtThreshold(3), 830 inhibited(4) 831 } 832 MAX-ACCESS read-write 833 PacketCable/IPCablecom Event management MTA MIB August 2008 835 STATUS current 836 DESCRIPTION 837 "This MIB object controls the throttling of the 838 transmitted messages upon generation of an event 839 (SNMP/syslog). It does not affect local logging 840 of events. 842 A value of unconstrained(1) causes event messages 843 to be transmitted without regard to the threshold 844 settings. 846 A value of maintainBelowThreshold(2) causes event 847 messages to be suppressed if the number of 848 transmissions would otherwise exceed the threshold 849 specified by pktcEventThrottleThreshold over the 850 interval specified by pktcEventThrottleInterval. 852 A value of stopAtThreshold(3) causes event message 853 transmission to cease once the threshold specified 854 by pktcEventThrottleThreshold (over the interval 855 specified by pktcEventThrottleInterval) is reached. 856 Event generation is resumed when the value of this 857 MIB object is modified by a Management Station, or 858 the device resets or reboots. 860 A value of inhibited(4) causes all event message 861 transmission to be suppressed. 863 An event causing both an SNMP and a syslog message 864 is still treated as a single event. 866 Refer to MIB objects pktcEventThrottleThreshold and 867 pktcEventThrottleInterval for information on 868 throttling." 869 DEFVAL { unconstrained } 870 ::= { pktcEventThrottle 1 } 872 pktcEventThrottleThreshold OBJECT-TYPE 873 SYNTAX Unsigned32(0..1024) 874 MAX-ACCESS read-write 875 STATUS current 876 DESCRIPTION 877 "This MIB object contains the number of events per 878 pktcEventThrottleInterval to be transmitted before 879 throttling. 881 An event resulting in multiple actions (e.g., SNMP 882 and syslog) is still treated as a single event." 883 PacketCable/IPCablecom Event management MTA MIB August 2008 885 DEFVAL { 2 } 886 ::= { pktcEventThrottle 2 } 888 pktcEventThrottleInterval OBJECT-TYPE 889 SYNTAX Unsigned32(0..604800) 890 UNITS "seconds" 891 MAX-ACCESS read-write 892 STATUS current 893 DESCRIPTION 895 "This MIB object contains the interval over which 896 the throttle threshold applies." 897 DEFVAL { 1 } 898 ::= { pktcEventThrottle 3 } 900 --- 901 -- Reporting of transmission status 902 --- 904 pktcEventTransmissionStatus OBJECT-TYPE 905 SYNTAX BITS { 906 syslogThrottled(0), 907 snmpThrottled(1), 908 validsyslogServerAbsent(2), 909 validSnmpManagerAbsent(3), 910 syslogTransmitError(4), 911 snmpTransmitError(5) 912 } 913 MAX-ACCESS read-only 914 STATUS current 915 DESCRIPTION 916 "This MIB object reflects the status of the event 917 transmissions using syslog, SNMP or both. 919 If a bit corresponding to a state is set to a value 920 of: 921 '1', it indicates that the state is true 922 '0', it indicates that the state is false 924 If the MTA is not configured with a syslog server 925 or an SNMP Manager, the corresponding 'throttling' 926 and 'transmit error' bits MUST be set to a value of 927 '0'. For example, if an SNMP Manager is not 928 configured on the MTA, the bit corresponding to 929 validSnmpManagerAbsent(3) is set to a value of '1', 930 and the values of the bits corresponding to 931 snmpThrottled(1) and snmpTransmitError(5) are set 932 to a value of '0'. 934 PacketCable/IPCablecom Event management MTA MIB August 2008 936 'Event throttling' is based on thresholds and the 937 current setting of the MIB object 938 pktcEventThrottleAdminStatus. 940 'Server/Manager' indicators are based on the 941 availability of valid syslog server/SNMP managers. 943 Transmit Errors are reported when detected. If an 944 MTA cannot detect an error situation, the value of 945 the BIT will be set to a value of '0'. 947 It is to be noted that not all the conditions that are 948 indicated by this MIB object are detectable by all 949 devices, and when detected may not be accurate. It is 950 meant to provide a report of the status as determined 951 by the device during event transmissions." 952 ::= { pktcEventStatus 1 } 954 --- 955 -- Description of events 956 --- 958 pktcEventTable OBJECT-TYPE 959 SYNTAX SEQUENCE OF PktcEventEntry 960 MAX-ACCESS not-accessible 961 STATUS current 962 DESCRIPTION 963 "This MIB table contains all possible management events 964 that can be generated by the device. This includes 965 both PacketCable and IPCableCom defined, and 966 vendor-specific events." 967 ::= { pktcEvents 1 } 969 pktcEventEntry OBJECT-TYPE 970 SYNTAX PktcEventEntry 971 MAX-ACCESS not-accessible 972 STATUS current 973 DESCRIPTION 974 "An entry in this table is created for each 975 event the MTA implementing this MIB is 976 capable of reporting. Entries in this table 977 are persisted across resets and reboots." 978 INDEX { pktcEventOrganization, pktcEventIdentifier } 979 ::= { pktcEventTable 1 } 981 PktcEventEntry::= SEQUENCE { 982 PacketCable/IPCablecom Event management MTA MIB August 2008 984 pktcEventOrganization Unsigned32, 985 pktcEventIdentifier Unsigned32, 986 pktcEventFacility SyslogFacility, 987 pktcEventSeverityLevel SyslogSeverity, 988 pktcEventReporting BITS, 989 pktcEventText SnmpAdminString, 990 pktcEventClass SnmpAdminString 991 } 993 pktcEventOrganization OBJECT-TYPE 994 SYNTAX Unsigned32(1..4294967295) 995 MAX-ACCESS not-accessible 996 STATUS current 997 DESCRIPTION 998 "This MIB object provides the IANA enterprise number of 999 the Organization defining the event. Thus, all 1000 PacketCable or IPCableCom defined events will contain 1001 the PacketCable or IPCableCom IANA enterprise 1002 number and for vendor-specific events it will contain 1003 the IANA enterprise number of the defining 1004 organization." 1005 REFERENCE "IANA Enterprise ID assignment, [IANA-ENTERPRISE]." 1006 ::= { pktcEventEntry 1 } 1008 pktcEventIdentifier OBJECT-TYPE 1009 SYNTAX Unsigned32(1..4294967295) 1010 MAX-ACCESS not-accessible 1011 STATUS current 1012 DESCRIPTION 1013 "This MIB object contains the event identifier for the 1014 corresponding event." 1015 REFERENCE 1016 "PacketCable Management Event Mechanism Specification, 1017 [PKT-SP-MEM1.5]; 1018 PacketCable MTA Device Provisioning Specification, 1019 [PKT-SP-PROV]." 1020 ::= { pktcEventEntry 2 } 1022 pktcEventFacility OBJECT-TYPE 1023 SYNTAX SyslogFacility 1024 MAX-ACCESS read-only 1025 STATUS current 1026 DESCRIPTION 1027 "This MIB object contains the facility 1028 for the event. 1029 For PacketCable, IPCableCom or ETSI events 1030 this MUST be set to a value of local0(16)." 1031 REFERENCE 1032 "The syslog Protocol, [RFCAAA]; 1033 PacketCable/IPCablecom Event management MTA MIB August 2008 1035 Textual Conventions for Syslog Management, 1036 [RFCDDD]." 1037 ::= { pktcEventEntry 3 } 1039 pktcEventSeverityLevel OBJECT-TYPE 1040 SYNTAX SyslogSeverity 1041 MAX-ACCESS read-write 1042 STATUS current 1043 DESCRIPTION 1044 "This MIB object contains the severity level that 1045 is applicable to the specified event." 1046 REFERENCE 1047 "The syslog Protocol, [RFCAAA]; 1048 Textual Conventions for Syslog Management, 1049 [RFCDDD]." 1050 ::= { pktcEventEntry 4 } 1052 pktcEventReporting OBJECT-TYPE 1053 SYNTAX BITS { 1054 local(0), 1055 syslog(1), 1056 snmpTrap(2), 1057 snmpInform(3) 1058 } 1059 MAX-ACCESS read-write 1060 STATUS current 1061 DESCRIPTION 1062 "This MIB object defines the action to be taken on 1063 occurrence of this event. Bit local(0) refers to local 1064 logging of events, bit sylog(1) refers to the 1065 transmission of events using syslog, bit snmpTrap(2) 1066 refers to the transmission of events using SNMP Traps 1067 (SNMPv2-Trap-PDU) and bit snmpInform(3)refers to the 1068 transmission of events using SNMP INFORMs. 1070 Setting a bit to a value of '1' indicates that the 1071 corresponding action will be taken upon occurrence of 1072 this event. If none of the bits are set then no action 1073 is taken upon occurrence of the event. The success of 1074 transmission using syslog and SNMP depends on the 1075 MTA configuration. For example, a valid syslog server 1076 address is required for syslog message transmission. 1078 Specification of a management event does not necessarily 1079 include the actions to be taken upon its generation, 1080 i.e., it does not need to specify if a generated event 1081 needs to be transmitted via SNMP, syslog or stored 1082 locally. Thus, certain default values are specified, 1083 based on the event's severity level specified by the 1084 PacketCable/IPCablecom Event management MTA MIB August 2008 1086 MIB object 'pktcEventSeverityLevel', as follows: 1087 - If the severity level of an event is emerg(0), 1088 alert(1), crit(2) or err(3), set the bits for 1089 local(0), syslog(1) and snmpInform(3) to a value 1090 of '1', and the remaining bits to a value of '0'. 1091 - For an event with any other severity level set 1092 the bits for local(0) and syslog(1) to a value of 1093 of '1', and the rest of the bits to a value of '0'. 1094 " 1095 ::= { pktcEventEntry 5 } 1097 pktcEventText OBJECT-TYPE 1098 SYNTAX SnmpAdminString (SIZE (0..127)) 1099 MAX-ACCESS read-write 1100 STATUS current 1101 DESCRIPTION 1102 "This MIB object provides a human-readable 1103 description of the event. Descriptions need 1104 to take into consideration the SnmpAdminString 1105 definition requirements such as the use of 1106 control code sequence CR LF to represent a 1107 newline." 1108 ::= { pktcEventEntry 6 } 1110 pktcEventClass OBJECT-TYPE 1111 SYNTAX SnmpAdminString (SIZE (0..100)) 1112 MAX-ACCESS read-only 1113 STATUS current 1114 DESCRIPTION 1115 "This MIB object represents the event class 1116 that affects the event. If an event is associated 1117 with only one event class, then its name 1118 (pktcEventClassName) is reported. If an event 1119 is associated with more than one event class, 1120 then the name of the event class with the 1121 lowest index in the event class table 1122 (pktcEventClassTable) is reported. 1124 See the MIB table 'pktcEventClassTable' 1125 for a description of event classes and usage. 1127 Descriptions need to take into consideration the 1128 SnmpAdminString definition requirements such as 1129 the use of control code sequence CR LF to 1130 represent a newline." 1131 ::= { pktcEventEntry 7 } 1133 --- 1134 PacketCable/IPCablecom Event management MTA MIB August 2008 1136 -- Log of generated events 1137 --- 1138 pktcEventLogTable OBJECT-TYPE 1139 SYNTAX SEQUENCE OF PktcEventLogEntry 1140 MAX-ACCESS not-accessible 1141 STATUS current 1142 DESCRIPTION 1143 "This MIB table contains a log of the events 1144 generated by the MTA. 1146 A description of all the events that can be 1147 generated by the device can be obtained from the 1148 MIB table 'pktcEventTable'. 1150 An MTA is not required to persist the contents of this 1151 table across resets." 1152 ::= { pktcEventLog 1 } 1154 pktcEventLogEntry OBJECT-TYPE 1155 SYNTAX PktcEventLogEntry 1156 MAX-ACCESS not-accessible 1157 STATUS current 1158 DESCRIPTION 1159 "Each entry in this table describes an event that 1160 has occurred, indexed in the chronological order of 1161 generation. The details of the event are borrowed 1162 from the parameters associated with the corresponding 1163 event entry in 'pktcEventTable', at the 1164 time of the event generation. 1165 While all entries created as such can be cleared using 1166 the MIB object pktcEventReset, the Event entries 1167 themselves cannot be individually deleted." 1169 INDEX { pktcEventLogIndex } 1170 ::= { pktcEventLogTable 1 } 1172 PktcEventLogEntry ::= SEQUENCE { 1173 pktcEventLogIndex Unsigned32, 1174 pktcEventLogTime DateAndTime, 1175 pktcEventLogOrganization Unsigned32, 1176 pktcEventLogIdentifier Unsigned32, 1177 pktcEventLogText SnmpAdminString, 1178 pktcEventLogEndpointName SnmpAdminString, 1179 pktcEventLogType BITS, 1180 pktcEventLogTargetInfo SnmpAdminString, 1181 pktcEventLogCorrelationId Unsigned32, 1182 pktcEventLogAdditionalInfo SnmpAdminString 1183 } 1184 PacketCable/IPCablecom Event management MTA MIB August 2008 1186 pktcEventLogIndex OBJECT-TYPE 1187 SYNTAX Unsigned32(1..4294967295) 1188 MAX-ACCESS not-accessible 1189 STATUS current 1190 DESCRIPTION 1191 "This MIB object provides relative ordering of the 1192 objects in the event log. 1194 If the MTA implements non-volatile storage, 1195 then this object will always increase except when 1196 the MIB object reaches a value of 2^32-1. 1198 If the MTA does not implement non-volatile storage, 1199 then this object will always increase except when 1200 the MIB object reaches a value of 2^32-1 or the MTA 1201 is reset. 1203 When the value reaches 2^32-1, or an MTA that does 1204 not implement non-volatile storage is reset, 1205 newer events will be stored starting with an index 1206 value of '1' (cyclic rotation)." 1207 ::= { pktcEventLogEntry 1 } 1209 pktcEventLogTime OBJECT-TYPE 1210 SYNTAX DateAndTime 1211 MAX-ACCESS read-only 1212 STATUS current 1213 DESCRIPTION 1214 "This MIB object provides a human-readable description 1215 of the date and time at which the event occurred. 1216 The value of the date and time contained in this MIB 1217 Object SHOULD reflect the date and time used in the 1218 syslog message resulting from the associated event, 1219 if such a syslog message was transmitted." 1220 ::= { pktcEventLogEntry 2 } 1222 pktcEventLogOrganization OBJECT-TYPE 1223 SYNTAX Unsigned32(1..4294967295) 1224 MAX-ACCESS read-only 1225 STATUS current 1226 DESCRIPTION 1227 "This MIB object provides the IANA enterprise number of 1228 the Organization defining the event. Thus, all 1229 PacketCable or IPCableCom defined events will contain 1230 the CableLabs or IPCableCom IANA enterprise number and 1231 for vendor-specific events it will contain the IANA 1232 enterprise number of the defining organization." 1233 PacketCable/IPCablecom Event management MTA MIB August 2008 1235 ::= { pktcEventLogEntry 3 } 1237 pktcEventLogIdentifier OBJECT-TYPE 1238 SYNTAX Unsigned32 1239 MAX-ACCESS read-only 1240 STATUS current 1241 DESCRIPTION 1242 "This MIB object contains the event identifier for the 1243 corresponding event." 1244 ::= { pktcEventLogEntry 4 } 1246 pktcEventLogText OBJECT-TYPE 1247 SYNTAX SnmpAdminString (SIZE (0..127)) 1248 MAX-ACCESS read-only 1249 STATUS current 1250 DESCRIPTION 1251 "This MIB object contains the contents of 1252 the MIB object 'pktcEventText', corresponding 1253 to the event, at the moment of generation." 1254 ::= { pktcEventLogEntry 5 } 1256 pktcEventLogEndpointName OBJECT-TYPE 1257 SYNTAX SnmpAdminString (SIZE (0..255)) 1258 MAX-ACCESS read-only 1259 STATUS current 1260 DESCRIPTION 1261 "This MIB object contains the unique identifier of the 1262 MTA endpoint that generated the corresponding event. 1263 If the generated event was not associated with 1264 any specific endpoint on the MTA, then this MIB object 1265 contains the MTA identifier. 1267 An MTA endpoint can be uniquely identified using a 1268 combination of the MTA identifier and the endpoint 1269 number. The MTA is identified via its FQDN and the 1270 associated IP address at the given point in time. 1272 The format of the value contained by this MIB object 1273 is as follows: 1275 aaln/n:/, when it identifies an endpoint, 1276 'n' being the Endpoint number; 1277 or, 1278 /, when it identifies an MTA. 1280 The value contained by this MIB object needs to observe 1281 the SnmpAdminString definition requirements." 1282 ::= { pktcEventLogEntry 6 } 1283 PacketCable/IPCablecom Event management MTA MIB August 2008 1285 pktcEventLogType OBJECT-TYPE 1286 SYNTAX BITS { 1287 local(0), 1288 syslog(1), 1289 snmpTrap(2), 1290 snmpInform(3) 1291 } 1292 MAX-ACCESS read-only 1293 STATUS current 1294 DESCRIPTION 1295 "This MIB object contains the type of actions taken by 1296 the MTA, when the event indicated by the MIB object 1297 'pktcEventLogIdentifier' occurred. 1299 A bit with a value of '1' indicates the corresponding 1300 action was taken. Setting it to a value of '0' 1301 indicates that the corresponding action was not taken. 1303 An event may trigger one or more actions (e.g.: syslog 1304 and SNMP), or result only in a local log. An action may 1305 also be prevented due to throttling in which case it is 1306 not reported by this MIB object." 1307 ::= { pktcEventLogEntry 7 } 1309 pktcEventLogTargetInfo OBJECT-TYPE 1310 SYNTAX SnmpAdminString (SIZE (0..255)) 1311 MAX-ACCESS read-only 1312 STATUS current 1313 DESCRIPTION 1314 "This MIB object contains a comma separated list of the 1315 actions taken for external notifications, along with the 1316 target IP address for the generated events. Locally 1317 stored events MUST NOT be recorded in this MIB object. 1319 The syntax is as: 1320 ,, 1322 Where is to be denoted as follows: 1323 For syslog events: 1324 syslog/ 1325 For SNMP traps: 1326 snmpTrap/ 1327 For SNMP INFORMS: 1328 snmpInform/ 1330 If there are multiple targets for the same type (SNMP 1331 Traps sent to multiple IP addresses) or if there are 1332 multiple message types sent to the same IP (syslog and 1333 PacketCable/IPCablecom Event management MTA MIB August 2008 1335 SNMP sent to the same IP address) they need to be 1336 reported individually. 1338 It is to be noted that this MIB object may not be able 1339 to store all the data in some cases (e.g., multiple 1340 IPv6 addresses) in which case some actions may not be 1341 reported. In such cases, the MTA MUST present a value 1342 of '...' at the end of the value. 1344 Values contained by this MIB object need to observe the 1345 SnmpAdminString definition requirements." 1346 ::= { pktcEventLogEntry 8 } 1348 pktcEventLogCorrelationId OBJECT-TYPE 1349 SYNTAX Unsigned32 1350 MAX-ACCESS read-only 1351 STATUS current 1352 DESCRIPTION 1353 "This MIB object contains the correlation ID 1354 generated by the MTA during the initiation of the 1355 last provisioning flow, within or following which 1356 the event occurred. 1358 Although a Correlation-ID, once generated after MTA 1359 reset, does not change until next MTA reset, the 1360 value of this object will differ for the events 1361 preserved across MTA resets in case of a persistent 1362 pktcEventLogTable. 1364 For more information on the generation of correlation 1365 ids, refer to the corresponding PacketCable/IPCableCom 1366 Device Provisioning specifications." 1367 REFERENCE 1368 "PacketCable MTA Device Provisioning Specification, 1369 [PKT-SP-PROV]." 1370 ::= { pktcEventLogEntry 9 } 1372 pktcEventLogAdditionalInfo OBJECT-TYPE 1373 SYNTAX SnmpAdminString (SIZE (0..255)) 1374 MAX-ACCESS read-only 1375 STATUS current 1376 DESCRIPTION 1377 "This MIB object contains additional, useful 1378 information in relation to the corresponding event that 1379 an MTA might wish to report such as parameterized 1380 data or debugging information. The format is 1381 vendor-specific. 1382 If MTA cannot provide any additional information for 1383 PacketCable/IPCablecom Event management MTA MIB August 2008 1385 the particular event generated, it MUST populate this 1386 MIB object with a zero-length OCTET-STRING. Vendors 1387 providing this information need to observe the 1388 SnmpAdminString definition requirements such as the 1389 use of control code sequence CR LF for newline." 1390 ::= { pktcEventLogEntry 10 } 1392 --- 1393 -- Notifications 1394 --- 1396 pktcEventNotification NOTIFICATION-TYPE 1397 OBJECTS { 1398 pktcEventLogTime, 1399 pktcEventLogOrganization, 1400 pktcEventLogIdentifier, 1401 pktcEventLogEndpointName, 1402 pktcEventLogCorrelationId, 1403 ifPhysAddress 1404 } 1405 STATUS current 1406 DESCRIPTION 1407 "This Notification MIB object contains the contents for 1408 event reporting. 1410 It contains the event log time, the organization 1411 ID, the event identifier, the endpoint identifier, the 1412 correlation id, and the MTA's MAC address." 1413 ::= { pktcEventNotifications 1 } 1415 --- 1416 -- Conformance/Compliance 1417 --- 1419 pktcEventCompliances OBJECT IDENTIFIER ::= 1420 { pktcEventConformance 1 } 1421 pktcEventGroups OBJECT IDENTIFIER ::= 1422 { pktcEventConformance 2 } 1424 pktcEventBasicCompliance MODULE-COMPLIANCE 1425 STATUS current 1426 DESCRIPTION 1427 "The compliance statement for devices that implement 1428 Event reporting feature." 1429 PacketCable/IPCablecom Event management MTA MIB August 2008 1431 MODULE --pktcIetfEventMib 1433 MANDATORY-GROUPS { 1434 pktcEventGroup, 1435 pktcEventNotificationGroup 1436 } 1438 MODULE SNMP-TARGET-MIB 1439 MANDATORY-GROUPS { 1440 snmpTargetBasicGroup, 1441 snmpTargetResponseGroup 1442 } 1444 MODULE SNMP-NOTIFICATION-MIB 1445 MANDATORY-GROUPS { 1446 snmpNotifyGroup, 1447 snmpNotifyFilterGroup 1448 } 1450 ::= { pktcEventCompliances 3 } 1452 pktcEventGroup OBJECT-GROUP 1453 OBJECTS { 1454 pktcEventReset, 1455 pktcEventSyslogCapabilities, 1456 pktcEventSyslogAddressType, 1457 pktcEventSyslogAddress, 1458 pktcEventSyslogTransport, 1459 pktcEventSyslogPort, 1460 pktcEventSyslogMessageFormat, 1461 pktcEventThrottleAdminStatus, 1462 pktcEventThrottleThreshold, 1463 pktcEventThrottleInterval, 1464 pktcEventTransmissionStatus, 1465 pktcEventFacility, 1466 pktcEventSeverityLevel, 1467 pktcEventReporting, 1468 pktcEventText, 1469 pktcEventLogTime, 1470 pktcEventLogOrganization, 1471 pktcEventLogIdentifier, 1472 pktcEventLogText, 1473 pktcEventLogEndpointName, 1474 pktcEventLogType, 1475 pktcEventLogTargetInfo, 1476 pktcEventLogCorrelationId, 1477 pktcEventLogAdditionalInfo, 1478 pktcEventClass, 1479 PacketCable/IPCablecom Event management MTA MIB August 2008 1481 pktcEventClassName, 1482 pktcEventClassStatus, 1483 pktcEventClassSeverity 1484 } 1486 STATUS current 1487 DESCRIPTION 1488 "Group of MIB objects for PacketCable Management Event 1489 MIB." 1490 ::= { pktcEventGroups 1 } 1492 pktcEventNotificationGroup NOTIFICATION-GROUP 1493 NOTIFICATIONS { pktcEventNotification } 1494 STATUS current 1495 DESCRIPTION 1496 "Group of MIB objects for notifications related to 1497 change in status of the MTA Device." 1498 ::= { pktcEventGroups 2 } 1499 END 1501 7. Acknowledgments 1503 The authors would like to thank the members of the IETF 1504 IPCDN working group and the CableLabs PacketCable Provisioning focus 1505 team for their contributions, comments and suggestions. 1507 Special appreciation is extended to the following individuals (in 1508 alphabetical order): Dan Romascanu, David Harrington, Greg 1509 Nakanishi, Jean-Francois Mule, John Berg, Kevin Marez, Paul Duffy, 1510 Peter Bates, Randy Presuhn, Rich Woundy, Rick Vetter, Roy Spitzer, 1511 and Satish Kumar. 1513 The primary editor (Sumanth) wishes to acknowledge the MIB doctors 1514 David Harrington and Dan Romascanu, Lars Eggert and Pasi Eronen, as 1515 well as Rich Woundy for expert feedback and numerous suggestions to 1516 improve this document. 1518 8. Normative References 1519 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 1520 Requirement Levels", BCP 14, RFC 2119, March 1997. 1522 [PKT-SP-PROV] Packetcable MTA Device Provisioning Specification 1523 PKT-SP-PROV-I11-050812. 1525 [RFC3413] D. Levi et al, "Simple Network Management Protocol (SNMP) 1526 Applications", STD 62, RFC 3413, December 2002. 1528 PacketCable/IPCablecom Event management MTA MIB August 2008 1530 [RFCABC] Glenn Mansfield Keeni, "Syslog Management Information 1531 Base", RFCABC, 1533 Editor's Note (to be removed prior to publication): This is the 1534 reference to ' draft-ietf-syslog-device-mib'. 1535 When the draft is accepted, the RFC Editor is requested to 1536 replace ABC (and in the reference earlier) with the assigned 1537 value and to remove this note. 1539 [RFCAAA] R. Gerhards, "The syslog Protocol", RFCAAA, 1541 Editor's Note (to be removed prior to publication): This is the 1542 reference to 'draft-ietf-syslog-protocol'. 1543 When the draft is accepted, the RFC Editor is requested to 1544 replace AAA (and in the reference earlier) with the assigned 1545 value and to remove this note. 1547 [RFCBBB] A. Okmianski, "Transmission of syslog messages over UDP", 1548 RFCBBB, 1550 Editor's Note (to be removed prior to publication): This is the 1551 reference to 'draft-ietf-syslog-transport-udp'. 1552 When the draft is accepted, the RFC Editor is requested to 1553 replace BBB (and in the reference earlier) with the assigned 1554 value and to remove this note. 1556 [RFCCCC] F. Miao, M. Yuzhi, "TLS Transport Mapping for Syslog", 1557 RFCCCC, 1559 Editor's Note (to be removed prior to publication): This is the 1560 reference to 'draft-ietf-syslog-transport-tls'. 1561 When the draft is accepted, the RFC Editor is requested to 1562 replace CCC(and in the reference earlier) with the assigned 1563 value and to remove this note. 1565 [RFCDDD] G. Keeni, "Textual Conventions for Syslog Management", 1566 RFCDDD, 1568 Editor's Note (to be removed prior to publication): This is the 1569 reference to 'draft-ietf-syslog-tc-mib'. 1570 When the draft is accepted, the RFC Editor is requested to 1571 replace DDD (and in the reference earlier) with the assigned 1572 value and to remove this note. 1574 [RFCEEE] D. New, M. Rose, E. Lear, "Reliable Delivery for syslog", 1575 RFCEEE, 1576 PacketCable/IPCablecom Event management MTA MIB August 2008 1578 Editor's Note (to be removed prior to publication): This is the 1579 reference to 'draft-ietf-syslog-rfc3195bis'. 1580 When the draft is accepted, the RFC Editor is requested to 1581 replace EEE(and in the reference earlier) with the assigned 1582 value and to remove this note. 1584 [ITU-T-J176] IPCablecom management event mechanism MIB, J.176, ITU- 1585 T, August 2002. 1587 [PKT-SP-EVEMIB1.5] PacketCable(TM) Management Event MIB 1588 Specification, PKT-SP-EVEMIB1.5-I02-050812, August, 2005. 1590 [PKT-SP-MEM1.5] PacketCable(TM) Management Event Mechanism 1591 Specification, PKT-SP-MEM1.5-I02-050812, August, 2005. 1593 [ETSITS101909-22] ETSI TS 101 909-22: "Digital Broadband Cable 1594 Access to the Public Telecommunications Network; IP 1595 Multimedia Time Critical Services; Part 22: Management Event 1596 Messages". 1598 [RFC768] J. Postel, "User Datagram Protocol", STD0006, RFC 768, 1599 August, 1980. 1601 [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1602 Rose, M. and S. Waldbusser, "Structure of Management 1603 Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1604 1999. 1606 [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1607 Rose, M. and S. Waldbusser, "Textual Conventions for 1608 SMIv2", STD 58, RFC 2579, April 1999. 1610 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., 1611 Rose, M. and S. Waldbusser, "Conformance Statements for 1612 SMIv2", STD 58, RFC 2580, April 1999. 1614 [RFC2863] McCloghrie, K. and F. Kastenholz, "The Interfaces Group 1615 MIB", RFC 2863, June 2000. 1617 [RFC3411] Harrington, D., Presuhn, R. and B. Wijnen, "An 1618 Architecture for Describing Simple Network Management Protocol 1619 (SNMP) Management Frameworks", RFC 3411, December 2002. 1621 [RFC4001] Daniele, M., Haberman, B., Routhier, S., Schoenwaelder, 1622 J., "Textual Conventions for Internet Network Addresses", RFC 4001, 1623 February 2005. 1625 PacketCable/IPCablecom Event management MTA MIB August 2008 1627 [IANA-ENTERPRISE] "IANA Private Enterprise Numbers", 1628 http://www.iana.org/assignments/enterprise-numbers 1630 9. Informative References 1631 [RFC3164] C. Lonvick, "The BSD syslog Protocol", RFC 3164, August 1632 2001. 1634 [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, 1635 "Introduction and Applicability Statements for Internet - 1636 Standard Management Framework", RFC 3410, December 2002. 1638 [PKT-SP-MGCP] Packetcable Network-Based Call Signaling Protocol 1639 Specification PKT-SP-EC-MGCP-I11-050812. 1641 [RFC3435] Andreasen, F., and B. Foster, "Media Gateway Control 1642 Protocol (MGCP)", RFC 3435, January 2003. 1644 [RFC4682] Nechamkin, E., and Mule J., "Multimedia Terminal Adapter 1645 (MTA) Management Information Base for PacketCable and IPCablecom 1646 compliant devices", RFC4682, December 2006. 1648 [PKT-SP-CODEC] Packetcable Audio/Video Codecs Specification 1649 PKT-SP-CODEC-I06-050812. 1651 10. IANA Considerations 1653 The MIB module in this document uses the following IANA-assigned 1654 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 1656 Descriptor OBJECT IDENTIFIER Value 1657 ---------- ----------------------- 1658 pktcIetfEventMib { mib-2 XXX } 1660 Editor's Note (to be removed prior to publication): the IANA is 1661 requested to assign a value for XXX under the mib-2 subtree and to 1662 record the assignment in the SMI Numbers registry. When the 1663 assignment has been made, the RFC Editor is asked to replace XXX 1664 (here and in the MIB module) with the assigned value and to remove 1665 this note. 1667 11. Security Considerations 1669 There are a number of management objects defined in this MIB module 1670 with a MAX-ACCESS clause of read-write. Such 1671 objects may be considered sensitive or vulnerable in some network 1672 PacketCable/IPCablecom Event management MTA MIB August 2008 1674 environments. The support for SET operations in a non-secure 1675 environment without proper protection can have a negative effect on 1676 network operations. Security threats include events unreported on 1677 errors, redirection of events (deliberately or otherwise) or 1678 minimized reporting of errors. Such threats can mask certain 1679 misconfiguration attempts and denial of service attacks that can be 1680 recognized and thwarted via event reporting. 1682 MIB objects of significance include: 1683 - those that control the event generation, the target syslog address 1684 for events and the reporting status, i.e.: 1685 pktcEventReset 1686 pktcEventSyslogAddressType 1687 pktcEventSyslogAddress 1688 pktcEventSyslogPort 1689 pktcEventSyslogMessageFormat 1690 pktcEventSyslogTransport 1691 pktcEventClassStatus 1693 - those related to event classes, i.e.: 1694 pktcEventClassSeverity 1696 - those related to throttling, i.e.: 1697 pktcEventThrottleAdminStatus 1698 pktcEventThrottleThreshold 1699 pktcEventThrottleInterval 1701 - those related to the event reporting capabilities of an MTA, i.e: 1702 pktcEventSeverityLevel 1703 pktcEventReporting 1704 pktcEventText 1706 The MIB object pktcEventReset deserves special mention since access 1707 to this MIB object can be used to disrupt event collection by 1708 management stations. For example, consider a management station that 1709 modifies the descriptions in the event table pktcEventTable. It 1710 would then expect management events generated by the MTA to reflect 1711 the modified values. A rogue management station that has access to 1712 the pktcEventReset can reset the event table resulting in the 1713 management station not receiving events with the expected 1714 descriptions. Further, a rogue management station with access to 1715 pktcEventReset can also clear local logs, eliminating local logs of 1716 generated events for management stations that are not configured to 1717 receive syslog or SNMP messages. The same concerns apply when 1718 allowed management stations performing such operations are unaware 1719 of other management stations that may be reliant on the event table 1720 or the event log table for management or monitoring. This MIB module 1721 does not address such multi-manager contentions, and recommends that 1722 the MIB object pktcEventReset be used with caution. 1724 PacketCable/IPCablecom Event management MTA MIB August 2008 1726 Some of the readable objects in this MIB module (i.e., objects 1727 with a MAX-ACCESS other than not-accessible) may be considered 1728 sensitive or vulnerable in some network environments. It is thus 1729 important to control even GET and/or NOTIFY access to these objects 1730 and possibly to even encrypt the values of these objects when 1731 sending them over the network via SNMP. These are the tables and 1732 objects and their sensitivity/vulnerability: 1734 pktcEventLogTable: This table contains the log of generated event 1735 messages. Read access to this table might reveal some specific 1736 information that should be kept confidential. 1738 pktcEventTransmissionStatus: This MIB object reveals the status of 1739 event transmission and MAY be sensitive in some environments. 1741 SNMP versions prior to SNMPv3 did not include adequate security. 1742 Even if the network itself is secure (for example by using IPsec), 1743 even then, there is no control as to who on the secure network 1744 is allowed to access and GET/SET (read/change/create/delete) the 1745 objects in this MIB module. 1747 It is RECOMMENDED that implementers consider the security features 1748 as provided by the SNMPv3 framework (see [RFC3410], section 8), 1749 including full support for the SNMPv3 cryptographic mechanisms 1750 (for authentication and privacy). 1752 Further, deployment of SNMP versions prior to SNMPv3 is NOT 1753 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to 1754 enable cryptographic security. It is then a customer/operator 1755 responsibility to ensure that the SNMP entity giving access to 1756 an instance of this MIB module, is properly configured to give 1757 access to the objects only to those principals (users) that have 1758 legitimate rights to perform GET or SET (change/create/delete) 1759 operations. 1761 12. Authors' Addresses 1762 Sumanth Channabasappa 1763 Cable Television Laboratories, Inc. 1764 858 Coal Creek Circle, 1765 Louisville, CO 80027, USA 1766 +1 303-661-3307 1767 Sumanth@cablelabs.com 1769 Wim De Ketelaere 1770 tComLabs 1771 Gildestraat 8 1772 9000 Gent, Belgium 1773 PacketCable/IPCablecom Event management MTA MIB August 2008 1775 +32 9 269 22 90 1776 deketelaere@tComLabs.com 1778 Eugene Nechamkin 1779 Broadcom Corporation 1780 200 - 13711 International Place 1781 Richmond, BC, V6V 2Z8, Canada 1782 +1 604 233 8500 1783 enechamkin@broadcom.com 1785 Full Copyright Statement 1787 Copyright (C) The IETF Trust (2008). 1789 This document is subject to the rights, licenses and restrictions 1790 contained in BCP 78, and except as set forth therein, the authors 1791 retain all their rights. 1793 This document and the information contained herein are provided on 1794 an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE 1795 REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE 1796 IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL 1797 WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY 1798 WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE 1799 ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS 1800 FOR A PARTICULAR PURPOSE. 1802 Intellectual Property 1804 The IETF takes no position regarding the validity or scope of any 1805 Intellectual Property Rights or other rights that might be claimed 1806 to pertain to the implementation or use of the technology described 1807 in this document or the extent to which any license under such 1808 rights might or might not be available; nor does it represent that 1809 it has made any independent effort to identify any such rights. 1810 Information on the procedures with respect to rights in RFC 1811 documents can be found in BCP 78 and BCP 79. 1813 Copies of IPR disclosures made to the IETF Secretariat and any 1814 assurances of licenses to be made available, or the result of an 1815 attempt made to obtain a general license or permission for the use 1816 of such proprietary rights by implementers or users of this 1817 specification can be obtained from the IETF on-line IPR repository 1818 at http://www.ietf.org/ipr. 1820 PacketCable/IPCablecom Event management MTA MIB August 2008 1822 The IETF invites any interested party to bring to its attention any 1823 copyrights, patents or patent applications, or other proprietary 1824 rights that may cover technology that may be required to implement 1825 this standard. Please address the information to the IETF at ietf- 1826 ipr@ietf.org. 1828 Acknowledgement 1830 Funding for the RFC Editor function is provided by the IETF 1831 Administrative Support Activity (IASA).