Internet Draft W. De Ketelaere draft-ietf-ipcdn-pktc-eventmess-01.txt tComLabs E. Nechamkin Broadcom Expires: July 20, 2003 January 20, 2002 Management Event MIB for PacketCable/IPCablecom MTAs Status of this Memo This document is an Internet-Draft and is in full conformance with all provisions of Section 10 of RFC2026. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet- Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. Copyright Notice Copyright (C) The Internet Society (2002). All Rights Reserved. Abstract This memo defines a portion of the Management Information Base (MIB) for use with network management protocols in the Internet community. In particular, it provides a common data and format definition for events and specifies by what means events are transmitted for PacketCable/IPCablecom compliant Multimedia Terminal Adapter devices. This memo specifies a MIB module in a manner that is compliant to the SNMP SMIv2 [5][6][7]. The set of objects are consistent with the SNMP framework and existing SNMP standards. De Ketelaere/Nechamkin [Page 1] Internet Draft PacketCable event management MTA MIB January 2003 Table of Contents 1 The Internet-Standard Management Framework ...................... 2 2 Glossary ........................................................ 2 3 Overview ........................................................ 7 3.1 Structure of the MIB .......................................... 7 4 Definitions ..................................................... 8 5 Acknowledgments .................................................24 6 Normative References ............................................24 7 Informative references...........................................25 8 Security Considerations ........................................ 25 9 Intellectual Property .......................................... 26 10 Authors' Addresses ............................................ 27 11 Full Copyright Statement ...................................... 27 1. The Internet-Standard Management Framework For a detailed overview of the documents that describe the current Internet-Standard Management Framework, please refer to section 7 of RFC 3410 [RFC3410]. Managed objects are accessed via a virtual information store, termed the Management Information Base or MIB. MIB objects are generally accessed through the Simple Network Management Protocol (SNMP). Objects in the MIB are defined using the mechanisms defined in the Structure of Management Information (SMI). This memo specifies a MIB module that is compliant to the SMIv2, which is described in STD 58, RFC 2578 [RFC2578], STD 58, RFC 2579 [RFC2579] and STD 58, RFC 2580 [RFC2580]. 2. Glossary The terms in this document are derived either from normal cable system usage, or from the documents associated with the IPcablecom/PacketCable Specification process. BPI+ ---- Baseline Privacy Plus Interface Specification. The security portion of the DOCSIS 1.1 standard that runs on the MAC layer. CA -- 1. Certification Authority. A trusted organization that accepts certificate applications from entities, authenticates applications, issues certificates and maintains status information about certificates. De Ketelaere/Nechamkin Expires July 2003 [Page 2] Internet Draft PacketCable event management MTA MIB January 2003 2. Call Agent. The part of the CMS that maintains the communication state, and controls the line side of the communication. CM -- DOCSIS Cable Modem CMS --- Call Management Server. Controls the audio connections. Also called a Call Agent in MGCP/SGCP terminology. This is one example of an Application Server. CMTS ---- Cable Modem Termination System. The device at a cable head-end which implements the DOCSIS RFI MAC protocol and connects to CMs over an HFC network. CMSS ---- CMS-to-CMS Signaling Codec ----- COder-DECoder DCS --- Distributed Call Signaling. DHCP ---- Dynamic Host Configuration Protocol DNS --- Domain Name Service DOCSIS ------ Data-Over-Cable Service Interface Specifications DQoS ---- Dynamic Quality-of-Service. Assigned on the fly for each communication depending on the QoS requested. De Ketelaere/Nechamkin Expires July 2003 [Page 3] Internet Draft PacketCable event management MTA MIB January 2003 DS -- Downstream. The direction for packet transport from CMTS to CM. E-MTA ----- Embedded MTA. A single node that contains both an MTA and a cable modem. FQDN ---- Fully Qualified Domain Name. Refer to IETF RFC 821 and RFC 1034 for details. GC -- Gate Controller. A logical entity within the CMS that controls the gates on the CMTS. HFC --- Hybrid Fiber/Coax coaxial able). An HFC system is a broadband bi- directional shared media transmission system using fiber trunks between the head-end and the fiber nodes, and coaxial distribution from the fiber nodes to the customer locations. IANA ---- Internet Assigned Numbered Authority. See www.ietf.org for details. IETF ---- Internet Engineering Task Force. A body responsible, among other things, for developing standards used on the Internet. See www.ietf.org for details IP -- Internet Protocol. An Internet network-layer protocol. KDC --- Key Distribution Center MIB --- Management Information Base MSO --- Multi-System Operator. A cable company that operates many head-end locations in several cities. De Ketelaere/Nechamkin Expires July 2003 [Page 4] Internet Draft PacketCable event management MTA MIB January 2003 MTA --- Multimedia Terminal Adapter. Contains the interface to a physical voice device, a network interface, CODECs, and all signaling and encapsulation functions required for VoIP transport, class features signaling, and QoS signaling. MWD --- Maximum Wating Delay. NCS --- Network Call Signaling OID --- Object Identifier OSS --- Operations Systems Support. The back-office software used for configuration, performance, fault, accounting, and security management. QoS --- Quality of Service. Guarantees network bandwidth and availability for applications. RFC ---- Request for Comments. Technical policy documents approved by the IETF which are available on the World Wide Web at http://www.ietf.cnri.reston.va.us/rfc.html RFI --- The DOCSIS Radio Frequency Interface specification. RKS --- Record Keeping Server. The device, which collects and correlates the various Event Messages. RSIP ---- Restart in Progress. An NCS message that is send by a node when it is restarting. RTP --- Real-Time Transport Protocol. Protocol used to transport media stream De Ketelaere/Nechamkin Expires July 2003 [Page 5] Internet Draft PacketCable event management MTA MIB January 2003 defined in RFC1889 [Reference]. SG -- Signaling Gateway. An SG is a signaling agent that receives/sends SCN native signaling at the edge of the IP network. In particular, the SS7 SG function translates variant ISUP and TCAP in an SS7-Internet Gateway to a common version of ISUP and TCAP. SF -- Service Flow. A unidirectional flow of packets on the RF interface of a DOCSIS system. S-MTA ----- Standalone MTA. A single node that contains an MTA and a non-DOCSIS MAC (e.g., ethernet). SNMP ---- Simple Network Management Protocol TFTP ---- Trivial File Transfer Protocol TLV --- Type-Length-Value. A tuple within a DOCSIS or Packetcable configuration file. ToD --- Time-of-Day Server ToS --- Type of Service. An 8-bit field of every IP version 4 packet. In a DiffServ domain, the ToS byte is treated as the DiffServ Code Point, or DSCP. UDP --- User Datagram Protocol. A connectionless protocol built upon Internet Protocol (IP). US -- Upstream. The direction for packet transport from CM to CMTS. De Ketelaere/Nechamkin Expires July 2003 [Page 6] Internet Draft PacketCable event management MTA MIB January 2003 VoIP ---- Voice over IP 3. Overview This MIB provides a set of objects required for the management of PacketCable/IPCablecom compliant MultiMedia Terminal Adapter (MTA) devices. The mechanisms to control the event reporting are defined in this document. 3.1. Structure of the MIB This MIB is structured as six groups: o Management information that controls the event reporting (pktcDevEventControl). o Management information that configures the reporting of the various programmable events (pktcDevEventConfig). o Management information that configures the event throttling control (pktcDevEventThrottle). o Management information that configures that allows the retrieval of events via SNMP (pktcDevEventLocal). o Management information that specifies the information sent in traps and informs (pktcDevEventNotify). o Management information that defines the trap and inform messages (pktcDevEventNotification). Tables within each of these groups group objects functionally. 3.1.1. pktcDevEventControl The objects in the pkctDevEventControl group control to where the syslog messages will be send to and the clearing of the event log. pkctDevEvControl - - this object is used to reset the event log and restore the default event reporting settings. pkctDevEvSyslogAddressType - - the type of internet address for the syslog server, it is not necessary to support all types. pktcDevEvSyslogAddress - - the IP-address of the syslog server, this can also be a FQDN, although the use of FQDN is discouraged. De Ketelaere/Nechamkin Expires July 2003 [Page 7] Internet Draft PacketCable event management MTA MIB January 2003 pkctDevEvSyslogUdpPort - - this object specifies the UDP-port to which the syslog messages need to be send. 3.1.2. pktcDevEventConfig pktcDevEvProgrammableTable - This table configures the reporting of various programmable events. By the use of this table it is possible to configure specific events to have a specific priority or report a specific event message. Additionaly the way of reporting (e.g. local, syslog, .. ) can be controlled. pktcDevEvFixedTable - This table configures the reporting of fixed events. By the use of this table it is possible to configure specific events to have a specific priority or report a specific event message. Additionaly the way of reporting (e.g. local, syslog, .. ) can be controlled. 3.1.3. pktcDevEventThrottle This group of objects controls the throttling of reporting events. 3.1.4. pktcDevEventLocal pktcDevEventTable - - this tables contains a log of network and device events that can be retrieved by SNMP. The table can be cleared by using pkctDevEvControl. 3.1.5 pktcDevEventNotify This group specifies the event data for Traps and Informs. 3.1.6 pktcDevEvNotification The structure for the traps and informs is defined in this group. 4. Definitions PKTC-EVENT-MIB DEFINITIONS ::= BEGIN IMPORTS MODULE-IDENTITY, OBJECT-TYPE, Integer32, Unsigned32, NOTIFICATION-TYPE, mib-2 FROM SNMPv2-SMI TruthValue, DateAndTime FROM SNMPv2-TC De Ketelaere/Nechamkin Expires July 2003 [Page 8] Internet Draft PacketCable event management MTA MIB January 2003 SnmpAdminString FROM SNMP-FRAMEWORK-MIB OBJECT-GROUP, MODULE-COMPLIANCE, NOTIFICATION-GROUP FROM SNMPv2-CONF InetAddressType, InetAddress, InetPortNumber FROM INET-ADDRESS-MIB ; pktcEventMib MODULE-IDENTITY LAST-UPDATED "200301200000Z" -- 01/17/03 ORGANIZATION "PacketCable Provisioning/OSS Group" CONTACT-INFO " Wim De Ketelaere Postal: tComLabs Stapelplein 70/4 9000 Gent Belgium Phone: +32 9 269 22 90 E-mail: deketelaere@tComLabs.com Eugene Nechamkin Postal: Broadcom Corporation, 200-13711 Internationial Place, Richmond, BC, V6V 2Z8 Canada Phone: +1 604 233 8500 E-mail: enechamkin@broadcom.com IETF IPCDN Working Group General Discussion: ipcdn@ietf.org Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn Co-Chair: Richard Woundy, rwoundy@broadband.att.com Co-Chair: Jean-Francois Mule, jf.mule@CableLabs.com " DESCRIPTION "This MIB module supplies the basic management objects for event reporting in the PacketCable Architecture" REVISION "200301200000Z" DESCRIPTION "Initial Introduction of the draft of the document." ::= { mib-2 99993 } -- to be assigned by IANA De Ketelaere/Nechamkin Expires July 2003 [Page 9] Internet Draft PacketCable event management MTA MIB January 2003 -- -- pktcDevEventControl OBJECT IDENTIFIER ::= { pktcEventMib 1 } pktcDevEventConfig OBJECT IDENTIFIER ::= { pktcEventMib 2 } pktcDevEventThrottle OBJECT IDENTIFIER ::= { pktcEventMib 3 } pktcDevEventLocal OBJECT IDENTIFIER ::= { pktcEventMib 4 } pktcDevEventNotify OBJECT IDENTIFIER ::= { pktcEventMib 5 } pktcDevEvNotification OBJECT IDENTIFIER ::= { pktcEventMib 6 } pktcDevEvNotificationIndex OBJECT IDENTIFIER ::= { pktcDevEvNotification 0 } -- -- Event Reporting -- -- -- Event reporting control -- pktcDevEvControl OBJECT-TYPE SYNTAX INTEGER { resetLog(1), useDefaultReporting(2) } MAX-ACCESS read-write STATUS current DESCRIPTION "This object defines actions related to the event log configuration. Setting this object to resetLog(1) empties the event log. All event log data is deleted. Setting it to useDefaultReporting(2) resets the tables pktcDevEvProgrammableTable and pktcDevEvFixedTable to their factory default values. Reading this object always returns useDefaultReporting(2)" ::= { pktcDevEventControl 1 } pktcDevEvSyslogAddressType OBJECT-TYPE SYNTAX InetAddressType MAX-ACCESS read-write STATUS current DESCRIPTION "The type of Internet address of the Syslog server. Not all address types may be supported." ::= { pktcDevEventControl 2 } pktcDevEvSyslogAddress OBJECT-TYPE SYNTAX InetAddress MAX-ACCESS read-write De Ketelaere/Nechamkin Expires July 2003 [Page 10] Internet Draft PacketCable event management MTA MIB January 2003 STATUS current DESCRIPTION "The IP address of the Syslog server. If 0.0.0.0, syslog transmission is inhibited. The use of FQDNs is syntactically allowed but it is discouraged for syslog servers since not resolving them in a timely manner may leave the device without access to the Syslog daemon during critical network events." ::= { pktcDevEventControl 3 } pktcDevEvSyslogUdpPort OBJECT-TYPE SYNTAX InetPortNumber MAX-ACCESS read-write STATUS current DESCRIPTION "The UDP port number the syslog device is using to send requests to the syslog server." DEFVAL {514} ::= { pktcDevEventControl 4 } -- -- Event throttling control -- pktcDevEvThrottleAdminStatus OBJECT-TYPE SYNTAX INTEGER { throttlingInhibited(1), dynamicThresholding(2), manualThresholding(3), eventsInhibited(4) } MAX-ACCESS read-write STATUS current DESCRIPTION "Controls the transmission of traps and syslog messages with respect to the trap pacing threshold. throttlingInhibited(1) causes traps and syslog messages to be transmitted without regard to the threshold settings. dynamicThresholding(2) causes trap transmission and syslog messages to be suppressed if the number of traps would otherwise exceed the threshold. manualThresholding(3) causes trap transmission to cease at the threshold, and not resume until directed to do so. eventsInhibited(4) causes all trap transmission and syslog messages to be suppressed. A single event is always treated as a single event for threshold counting. That is, an event causing both a trap and a syslog message is still treated as a single event. De Ketelaere/Nechamkin Expires July 2003 [Page 11] Internet Draft PacketCable event management MTA MIB January 2003 Writing to this object resets the thresholding state. At initial startup, this object has a default value of throttlingInhibited(1)." DEFVAL { throttlingInhibited } ::= { pktcDevEventThrottle 1 } pktcDevEvThrottleInhibited OBJECT-TYPE SYNTAX TruthValue MAX-ACCESS read-only STATUS current DESCRIPTION "If true(1), trap/inform and syslog transmission is currently inhibited due to thresholds and/or the current setting of pktcDevEvThrottleAdminStatus. In addition, this is set to true(1) if transmission is inhibited due to no syslog (pktcDevEvSyslogAddress) or trap/inform (pktcMtaDevSnmpEntity) destinations having been set." ::= { pktcDevEventThrottle 2 } pktcDevEvThrottleThreshold OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-write STATUS current DESCRIPTION "Number of trap/syslog events per pktcDevEvThrottleInterval to be transmitted before throttling. A single event is always treated as a single event for Threshold counting. That is, an event causing both a trap/inform and a syslog message is still treated as a single event. At initial startup, this object returns 2." DEFVAL { 2 } ::= { pktcDevEventThrottle 3 } pktcDevEvThrottleInterval OBJECT-TYPE SYNTAX Integer32 (1..2147483647) UNITS "seconds" MAX-ACCESS read-write STATUS current DESCRIPTION "The interval over which the throttle threshold applies. At initial startup, this object has a value of 1." DEFVAL { 1 } ::= { pktcDevEventThrottle 4 } De Ketelaere/Nechamkin Expires July 2003 [Page 12] Internet Draft PacketCable event management MTA MIB January 2003 -- -- Event configuration -- -- -- The following table configures the reporting of the various programmable -- events. -- pktcDevEvProgrammableTable OBJECT-TYPE SYNTAX SEQUENCE OF PktcDevEvProgrammableEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table allows control of the reporting of event classes. For each event priority, a combination of logging and reporting mechanisms may be chosen. The mapping of event types to priorities is vendor-dependent. Vendors may also choose to allow the user to control that mapping through proprietary means." ::= { pktcDevEventConfig 1 } pktcDevEvProgrammableEntry OBJECT-TYPE SYNTAX PktcDevEvProgrammableEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Allows configuration of the reporting mechanisms for a programmable event, including level, report type, and text." INDEX { pktcDevEvProgrammableId, pktcDevEvProgrammableEnterprise } ::= { pktcDevEvProgrammableTable 1 } PktcDevEvProgrammableEntry ::= SEQUENCE { pktcDevEvProgrammableId Integer32, pktcDevEvProgrammableEnterprise Integer32, pktcDevEvProgrammableLevel INTEGER, pktcDevEvProgrammableReporting BITS, pktcDevEvProgrammableText SnmpAdminString } pktcDevEvProgrammableId OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "ID for a specific programmable event to which the priority and display string are matched. These Event Ids are vendor specific or in the case of PacketCable events defined in pkt-tr-memevent-id-v01-001128." ::= { pktcDevEvProgrammableEntry 1 } De Ketelaere/Nechamkin Expires July 2003 [Page 13] Internet Draft PacketCable event management MTA MIB January 2003 pktcDevEvProgrammableEnterprise OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION "Provides the IANA enterprise number of the device manufacturer for proprietary events, and the CableLabs IANA enterprise number for PacketCable specified events." ::= { pktcDevEvProgrammableEntry 2 } pktcDevEvProgrammableLevel OBJECT-TYPE SYNTAX INTEGER { critical(1), major(2), minor(3), warning(4), information(5) } MAX-ACCESS read-write STATUS current DESCRIPTION "The priority level that is controlled by this entry. These are ordered from most (critical) to least (information) critical. Each event has a particular priority level associated with it (as defined by the vendor). The levels are described as: critical(1) - A service-affecting condition that requires immediate corrective action. major(2) - A service-affecting condition that requires urgent corrective action. minor(3) - A non-service-affecting fault condition which warrants corrective action in order to avoid a more serious fault. warning(4) - A potential or impending condition which can lead to a fault; diagnostic action is suggested. information(5) - Normal event meant to convey information." ::= { pktcDevEvProgrammableEntry 3 } pktcDevEvProgrammableReporting OBJECT-TYPE SYNTAX BITS { local(0), traps(1), syslog(2), inform(3), none(4) De Ketelaere/Nechamkin Expires July 2003 [Page 14] Internet Draft PacketCable event management MTA MIB January 2003 } MAX-ACCESS read-write STATUS current DESCRIPTION "Defines the action to be taken on occurrence of this event class. Implementations may not necessarily support all options for all event classes, but at minimum must allow traps and syslogging to be disabled. If the local(0) bit is set, then log to the internal log, if the traps(1) bit is set, then generate a trap, if the syslog(2) bit is set, then send a syslog message (assuming the syslog address is set) inform(3) bit is set, then generate an inform, if the none(4) bit is set, then this event is not generated." -- DEFVAL { local } ::= { pktcDevEvProgrammableEntry 4 } pktcDevEvProgrammableText OBJECT-TYPE SYNTAX SnmpAdminString(SIZE (127)) MAX-ACCESS read-write STATUS current DESCRIPTION "Programmable event display string providing a human-readable description of the event." ::= { pktcDevEvProgrammableEntry 5 } -- The following table configures the reporting of the various fixed -- events. -- pktcDevEvFixedTable OBJECT-TYPE SYNTAX SEQUENCE OF PktcDevEvFixedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "This table allows control of the reporting of event classes. For each event priority, a combination of logging and reporting mechanisms may be chosen. The mapping of event types to priorities is vendor-dependent. Vendors may also choose to allow the user to control that mapping through proprietary means." ::= { pktcDevEventConfig 2 } pktcDevEvFixedEntry OBJECT-TYPE SYNTAX PktcDevEvFixedEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Allows configuration of the reporting mechanisms for a De Ketelaere/Nechamkin Expires July 2003 [Page 15] Internet Draft PacketCable event management MTA MIB January 2003 fixed event, including level, and report type." INDEX { pktcDevEvFixedId, pktcDevEvFixedEnterprise } ::= { pktcDevEvFixedTable 1 } PktcDevEvFixedEntry ::= SEQUENCE { pktcDevEvFixedId Integer32, pktcDevEvFixedEnterprise Integer32, pktcDevEvFixedLevel INTEGER, pktcDevEvFixedReporting BITS, pktcDevEvFixedText SnmpAdminString } pktcDevEvFixedId OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS not-accessible STATUS current DESCRIPTION "ID for a specific fixed event to which the priority and display string are matched. These Event Ids are vendor specific or in the case of PacketCable events defined in pkt-tr-memevent-id-v01-001128." ::= { pktcDevEvFixedEntry 1 } pktcDevEvFixedEnterprise OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION "Provides the IANA enterprise number of the device manufacturer for proprietary events, and the CableLabs IANA enterprise number for PacketCable specified events." ::= { pktcDevEvFixedEntry 2 } pktcDevEvFixedLevel OBJECT-TYPE SYNTAX INTEGER { critical(1), major(2), minor(3), warning(4), information(5) } MAX-ACCESS read-write STATUS current DESCRIPTION "The priority level that is controlled by this entry. These are ordered from most (critical) to least (information) critical. Each event has a particular priority level associated with it (as De Ketelaere/Nechamkin Expires July 2003 [Page 16] Internet Draft PacketCable event management MTA MIB January 2003 defined by the vendor). The levels are described as: critical(1) - A service-affecting condition that requires immediate corrective action. major(2) - A service-affecting condition that requires urgent corrective action. minor(3) - A non-service-affecting fault condition which warrants corrective action in order to avoid a more serious fault. warning(4) - A potential or impending condition which can lead to a fault; diagnostic action is suggested. information(5) - Normal event meant to convey information." ::= { pktcDevEvFixedEntry 3 } pktcDevEvFixedReporting OBJECT-TYPE SYNTAX BITS { local(0), traps(1), syslog(2), inform(3), none(4) } MAX-ACCESS read-write STATUS current DESCRIPTION "Defines the action to be taken on occurrence of this event class. Implementations may not necessarily support all options for all event classes, but at minimum must allow traps and syslogging to be disabled. If the local(0) bit is set, then log to the internal log, if the traps(1) bit is set, then generate a trap, if the syslog(2) bit is set, then send a syslog message (assuming the syslog address is set) inform(3) bit is set, then generate an inform, if the none(4) bit is set, then this event is not generated." -- DEFVAL { local } ::= { pktcDevEvFixedEntry 4 } pktcDevEvFixedText OBJECT-TYPE SYNTAX SnmpAdminString(SIZE (127)) MAX-ACCESS read-only STATUS current DESCRIPTION "Fixed event display string providing a human-readable description of the event." ::= { pktcDevEvFixedEntry 5 } -- De Ketelaere/Nechamkin Expires July 2003 [Page 17] Internet Draft PacketCable event management MTA MIB January 2003 -- Local event table - for retrieval of events via SNMP -- pktcDevEventTable OBJECT-TYPE SYNTAX SEQUENCE OF PktcDevEventEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Contains a log of network and device events that may be of interest in fault isolation and troubleshooting." ::= { pktcDevEventLocal 1 } pktcDevEventEntry OBJECT-TYPE SYNTAX PktcDevEventEntry MAX-ACCESS not-accessible STATUS current DESCRIPTION "Describes a network or device event that may be of interest in fault isolation and troubleshooting. Entries are created with the first occurrence of an event. pktcDevEvControl can be used to clear the table. Individual events can not be deleted." INDEX { pktcDevEvIndex } ::= { pktcDevEventTable 1 } PktcDevEventEntry ::= SEQUENCE { pktcDevEvIndex INTEGER, pktcDevEvTime DateAndTime, pktcDevEvLevel INTEGER, pktcDevEvEnterprise Integer32, pktcDevEvId Unsigned32, pktcDevEvText SnmpAdminString, pktcDevEvMacAddress OCTET STRING, pktcDevEvEndpointName SnmpAdminString } pktcDevEvIndex OBJECT-TYPE SYNTAX INTEGER (1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION "Provides relative ordering of the objects in the event log. This object will always increase except when (a) the log is reset via pktcDevEvControl, (b) the device reboots and does not implement non-volatile storage for this log, or (c) it reaches the value 2^31. The next entry for all the above cases is 1. This also serves as De Ketelaere/Nechamkin Expires July 2003 [Page 18] Internet Draft PacketCable event management MTA MIB January 2003 a indicator of event sequence." ::= { pktcDevEventEntry 1 } pktcDevEvTime OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current DESCRIPTION "Provides a human-readable description of the time at which the event occurred." ::= { pktcDevEventEntry 2 } pktcDevEvLevel OBJECT-TYPE SYNTAX INTEGER { critical(1), major(2), minor(3), warning(4), information(5) } MAX-ACCESS read-only STATUS current DESCRIPTION "The priority level of this event as defined by the vendor. These are ordered from most serious (critical) to least serious (debug)." ::= { pktcDevEventEntry 3 } pktcDevEvEnterprise OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "Provides the IANA enterprise number of the device manufacturer for proprietary events, and the CableLabs IANA enterprise number for PacketCable specified events." ::= { pktcDevEventEntry 4 } pktcDevEvId OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "ID for a specific event to which the priority and display string are matched. These Event Ids are vendor specific or in the case of PacketCable events defined in pkt-tr-memevent-id-v01-001128." De Ketelaere/Nechamkin Expires July 2003 [Page 19] Internet Draft PacketCable event management MTA MIB January 2003 ::= { pktcDevEventEntry 5 } pktcDevEvText OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "Provides a human-readable description of the event, including all relevant context (interface numbers, etc.)." ::= { pktcDevEventEntry 6 } pktcDevEvMacAddress OBJECT-TYPE SYNTAX OCTET STRING (SIZE (6)) MAX-ACCESS read-only STATUS current DESCRIPTION "Provides the MAC address of the device generating the event." ::= { pktcDevEventEntry 7 } pktcDevEvEndpointName OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This is the endpoint identifier followed by the FQDN/IP Address of the device. This is in the form - AALN/X:FQDN/IP Address. If the event is not specific to an endpoint, then the contents is just the FQDN/IP address." ::= { pktcDevEventEntry 8 } -- -- Event Data for Traps - Informs -- pktcDevEvReportIndex OBJECT-TYPE SYNTAX Integer32 (1..2147483647) MAX-ACCESS read-only STATUS current DESCRIPTION "Integer value starting at one that increases by one for each event generated. Used for sequencing of events." ::= { pktcDevEventNotify 1 } pktcDevEvReportTime OBJECT-TYPE SYNTAX DateAndTime MAX-ACCESS read-only STATUS current De Ketelaere/Nechamkin Expires July 2003 [Page 20] Internet Draft PacketCable event management MTA MIB January 2003 DESCRIPTION "Provides a human-readable description of the time at which the event occurred." ::= { pktcDevEventNotify 2 } pktcDevEvReportLevel OBJECT-TYPE SYNTAX INTEGER { critical(1), major(2), minor(3), warning(4), information(5) } MAX-ACCESS read-only STATUS current DESCRIPTION "The priority level of this event as defined by the vendor. These are ordered from most serious (critical) to least serious (debug)." ::= { pktcDevEventNotify 3 } pktcDevEvReportEnterprise OBJECT-TYPE SYNTAX Integer32 MAX-ACCESS read-only STATUS current DESCRIPTION "Provides the IANA enterprise number of the device manufacturer for proprietary events, and the CableLabs IANA enterprise number for PacketCable specified events." ::= { pktcDevEventNotify 4 } pktcDevEvReportId OBJECT-TYPE SYNTAX Unsigned32 MAX-ACCESS read-only STATUS current DESCRIPTION "ID for a specific event to which the priority and display string are matched. These Event Ids are vendor specific or in the case of PacketCable events defined in pkt-tr-memevent-id-v01-001128." ::= { pktcDevEventNotify 5 } pktcDevEvReportText OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION De Ketelaere/Nechamkin Expires July 2003 [Page 21] Internet Draft PacketCable event management MTA MIB January 2003 "Provides a human-readable description of the event, including all relevant context (interface numbers, etc.)." ::= { pktcDevEventNotify 6 } pktcDevEvReportMacAddress OBJECT-TYPE SYNTAX OCTET STRING (SIZE (6)) MAX-ACCESS read-only STATUS current DESCRIPTION "Provides the MAC address of the device generating the event." ::= { pktcDevEventNotify 7 } pktcDevEvReportEndpointName OBJECT-TYPE SYNTAX SnmpAdminString MAX-ACCESS read-only STATUS current DESCRIPTION "This is the endpoint identifier followed by the FQDN/IP Address of the device. This is in the form - AALN/X:FQDN/IP Address. If the event is not specific to an endpoint, then the contents is just the FQDN/IP address" ::= { pktcDevEventNotify 8 } pktcDevEvInform NOTIFICATION-TYPE OBJECTS { pktcDevEvReportIndex, pktcDevEvReportTime,pktcDevEvReportLevel, pktcDevEvReportEnterprise,pktcDevEvReportId,pktcDevEvReportText, pktcDevEvReportMacAddress,pktcDevEvReportEndpointName } STATUS current DESCRIPTION "Inform for event reporting " ::= { pktcDevEvNotificationIndex 1 } pktcDevEvTrap NOTIFICATION-TYPE OBJECTS { pktcDevEvReportIndex, pktcDevEvReportTime,pktcDevEvReportLevel, pktcDevEvReportEnterprise,pktcDevEvReportId,pktcDevEvReportText, pktcDevEvReportMacAddress,pktcDevEvReportEndpointName } STATUS current DESCRIPTION " Trap for event reporting " ::= { pktcDevEvNotificationIndex 2 } pktcEventConformance OBJECT IDENTIFIER ::= { pktcEventMib 7 } pktcEventCompliances OBJECT IDENTIFIER ::= { pktcEventConformance 1 } pktcEventGroups OBJECT IDENTIFIER ::= { pktcEventConformance 2 } -- compliance statements De Ketelaere/Nechamkin Expires July 2003 [Page 22] Internet Draft PacketCable event management MTA MIB January 2003 pktcEventBasicCompliance MODULE-COMPLIANCE STATUS current DESCRIPTION "The compliance statement for devices that implement Event reporting feature." MODULE --pktcEventMib -- unconditionally mandatory groups MANDATORY-GROUPS { pktcEventGroup, pktcEventNotificationGroup } -- units of conformance ::= { pktcEventCompliances 3 } pktcEventGroup OBJECT-GROUP OBJECTS { pktcDevEvControl, pktcDevEvSyslogAddressType, pktcDevEvSyslogAddress, pktcDevEvSyslogUdpPort, pktcDevEvThrottleAdminStatus, pktcDevEvThrottleInhibited, pktcDevEvThrottleThreshold, pktcDevEvThrottleInterval, pktcDevEvProgrammableEnterprise, pktcDevEvProgrammableLevel, pktcDevEvProgrammableReporting, pktcDevEvProgrammableText, pktcDevEvFixedEnterprise, pktcDevEvFixedLevel, pktcDevEvFixedReporting, pktcDevEvFixedText, pktcDevEvIndex, pktcDevEvTime, pktcDevEvLevel, pktcDevEvEnterprise, pktcDevEvId, pktcDevEvText, pktcDevEvMacAddress, pktcDevEvEndpointName, pktcDevEvReportIndex, pktcDevEvReportTime, pktcDevEvReportLevel, pktcDevEvReportEnterprise, pktcDevEvReportId, pktcDevEvReportText, De Ketelaere/Nechamkin Expires July 2003 [Page 23] Internet Draft PacketCable event management MTA MIB January 2003 pktcDevEvReportMacAddress, pktcDevEvReportEndpointName } STATUS current DESCRIPTION "Group of objects for PacketCable Event MIB." ::= { pktcEventGroups 1 } -- Notification Group Added pktcEventNotificationGroup NOTIFICATION-GROUP NOTIFICATIONS { pktcDevEvInform, pktcDevEvTrap } STATUS current DESCRIPTION "These notifications deal with change in status of MTA Device." ::= { pktcEventGroups 2 } END 5. Acknowledgments The authors would like to thank the PacketCable Provisioning focus team at CableLabs and its participating member companies for initiating this work. The following individuals should be thanked for their contributions: Sumanth Channabasappa (Alopa); Angela Lyda and Rodney Osborne (Arris Interactive); Matt Osman and Jean-Francois Mule (CableLabs); Sandeep Asija and Paul Duffy (Cisco Systems); Rick Vetter (General Instrument/Motorola); Burcak Beser (Pacific Broadband); Peter Bates (Telcordia); Satish Kumar and Roy Spitzer (TI). A special thanks is due to Rick Vetter (Motorola) and Roy Spitzer (TI) who worked tirelessly in a challenging multi-vendor environment to build this specification. 6. Normative References [RFC1034] P.V. Mockapetris, "Domain names - concepts and facilities", RFC1034, November 1987 [RFC1889] H. Schulzrinne, S. Casner, R. Frederick, V. Jacobson, "RTP: A Transport Protocol for Real-Time Applications", RFC1889, January 1996. [RFC2578] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Structure of Management Information Version 2 (SMIv2)", STD 58, RFC 2578, April 1999. [RFC2579] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Textual Conventions for SMIv2", STD 58, RFC 2579, April 1999. De Ketelaere/Nechamkin Expires July 2003 [Page 24] Internet Draft PacketCable event management MTA MIB January 2003 [RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J., Rose, M. and S. Waldbusser, "Conformance Statements for SMIv2", STD 58, RFC 2580, April 1999. 7. Informative References [RFC821] J. Postel, "Simple Mail Transfer Protocol", RFC821, August 1982. [RFC2026] S. Bradner., "The Internet Standards Process -- Revision 3", RFC2026, October 1996. [RFC3410] Case, J., Mundy, R., Partain, D. and B. Stewart, "Introduction and Applicability Statements for Internet- Standard Management Framework", RFC 3410, December 2002. 8. Security Considerations There are a number of management objects defined in this MIB module with a MAX-ACCESS clause of read-write and/or read-create. Such objects may be considered sensitive or vulnerable in some network environments. The support for SET operations in a non-secure environment without proper protection can have a negative effect on network operations. These are the tables and objects and their sensitivity/vulnerability: pktcDevEventControl: This table controls to where events will be sent. Network operations can be impacted if insufficient security is provided pktcDevEventConfig: This table configures the type of events that will be reported, as such it has an influence on the number of messages that will be transmitted on the network. If not configured properly the network might get flooded with messages. pktcDevEventThrottle: This table controls the rate at which events can be generated, if not configured properly, the network load caused by event event messaging might severely impact network performance. Some of the readable objects in this MIB module (i.e., objects with a MAX-ACCESS other than not-accessible) may be considered sensitive or vulnerable in some network environments. It is thus important to control even GET access to these objects and possibly to even encrypt the values of these objects when sending them over the network via SNMP. These are the tables and objects and their sensitivity/vulnerability: De Ketelaere/Nechamkin Expires July 2003 [Page 25] Internet Draft PacketCable event management MTA MIB January 2003 pktcDevEventLocal: This table contains the log of event messages. Read access to this table might reveal some specific information that should be kept confidential. SNMP versions prior to SNMPv3 did not include adequate security. Even if the network itself is secure (for example by using IPSec), even then, there is no control as to who on the secure network is allowed to access and GET/SET (read/change/create/delete) the objects in this MIB module. It is RECOMMENDED that implementers consider the security features as provided by the SNMPv3 framework (see [RFC3410], section 8), including full support for the SNMPv3 cryptographic mechanisms (for authentication and privacy). Further, deployment of SNMP versions prior to SNMPv3 is NOT RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to enable cryptographic security. It is then a customer/operator responsibility to ensure that the SNMP entity giving access to an instance of this MIB module, is properly configured to give access to the objects only to those principals (users) that have legitimate rights to indeed GET or SET (change/create/delete) them. 9. Intellectual Property The IETF takes no position regarding the validity or scope of any intellectual property or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on the IETF's procedures with respect to rights in standards-track and standards-related documentation can be found in BCP-11. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF Secretariat. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to practice this standard. Please address the information to the IETF Executive Director. De Ketelaere/Nechamkin Expires July 2003 [Page 26] Internet Draft PacketCable event management MTA MIB January 2003 10. Authors' Addresses Wim De Ketelaere tComLabs Stapelplein 70/4 9000 Gent Belgium deketelaere@tComLabs.com +32 9 269 22 90 Eugene Nechamkin Broadcom Corporation 200 - - 13711 International Place Richmond, BC, V6V 2Z8 CANADA Phone: +1 604 233 8500 E-mail: enechamkin@broadcom.com 11. Full Copyright Statement Copyright (C) The Internet Society (2002). All Rights Reserved. This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the Internet Society or other Internet organizations, except as needed for the purpose of developing Internet standards in which case the procedures for copyrights defined in the Internet Standards process must be followed, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the Internet Society or its successors or assigns. This document and the information contained herein is provided on an "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Acknowledgement Funding for the RFC Editor function is currently provided by the Internet Society. De Ketelaere/Nechamkin Expires July 2003 [Page 27] De Ketelaere/Nechamkin Expires July 2003 [Page 29]