Request for Comments: 4547 Cisco Systems Inc.
Category: Standards Track G. Nakanishi
Motorola
June 2006
Event Notification Management Information Base for
Data over Cable Service Interface Specifications (DOCSIS)-Compliant
Cable Modems and Cable Modem Termination Systems
Status of This Memo
This document specifies an Internet standards track protocol for the
Internet community, and requests discussion and suggestions for
improvements. Please refer to the current edition of the "Internet
Official Protocol Standards" (STD 1) for the standardization state
and status of this protocol. Distribution of this memo is unlimited.
Copyright Notice
Copyright (C) The Internet Society (2006).
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 defines a basic set of managed objects for Simple
Network Management Protocol (SNMP) based event notification
management of Data Over Cable Service Interface Specification
(DOCSIS) compliant Cable Modems and Cable Modem Termination Systems.
This MIB is defined as an extension to the DOCSIS Cable Device MIB.
This memo specifies a MIB module in a manner that is compliant to the
Structure of Management Information Version 2 (SMIv2). The set of
objects is consistent with the SNMP framework and existing SNMP
standards.
Table of Contents
1. The Internet-Standard Management Framework ......................2
2. Glossary ........................................................2
2.1. BPI - Baseline Privacy Interface ...........................3
2.2. BPI - Baseline Privacy Plus Interface ......................3
2.3. CATV .......................................................3
2.4. CM - Cable Modem ...........................................3
2.5. CMTS - Cable Modem Termination System ......................3
2.6. DOCSIS .....................................................3
2.7. Downstream .................................................4
2.8. Head-end ...................................................4
2.9. MAC Packet .................................................4
2.10. RF ........................................................4
2.11. SID .......................................................4
2.12. TLV .......................................................4
2.13. Upstream ..................................................4
3. Overview ........................................................4
3.1. Structure of the MIB .......................................5
4. Definitions .....................................................5
5. Contributors ...................................................35
6. Acknowledgements ...............................................36
7. Security Considerations ........................................36
8. IANA Considerations ............................................37
9. References .....................................................37
9.1. Normative References ......................................37
9.2. Informative References ....................................38
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 [16].
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 [2], STD 58, RFC 2579 [3] and STD 58, RFC 2580 [4].
2. Glossary
The terms in this document are derived either from normal cable
system usage, or from the documents associated with the Data Over
Cable Service Interface Specification (DOCSIS) process.
2.1. BPI - Baseline Privacy Interface
A mechanism for providing data privacy over the HFC network in DOCSIS
1.0 systems [8].
2.2. BPI - Baseline Privacy Plus Interface
A mechanism that extends the Baseline Privacy Interface with the
addition of CM authentication over the HFC network in DOCSIS 1.1/2.0
systems and beyond [9].
2.3. CATV
Originally "Community Antenna Television", now used to refer to any
cable or hybrid fiber and cable system used to deliver video signals
to a community.
2.4. CM - Cable Modem
A CM acts as a "slave" station in a DOCSIS-compliant cable data
system.
2.5. CMTS - Cable Modem Termination System
A generic term covering a cable bridge or cable router in a head-end.
A CMTS acts as the master station in a DOCSIS-compliant cable data
system. It is the only station that transmits downstream, and it
controls the scheduling of upstream transmissions by its associated
CMs.
2.6. DOCSIS
DOCSIS stands for "Data-over-Cable Service Interface Specifications"
and refers to the ITU-T J.112 Annex B standard for cable modem
systems [10], [13] commonly known as DOCSIS 1.0. The DOCSIS 1.1
specification is an extension of DOCSIS 1.0, with new features to
support quality of service, fragmentation, and requirements for
European cable plants [14].
DOCSIS 2.0 [15] builds upon DOCSIS 1.1 and provides all of the
features and functionality that DOCSIS 1.1 provides. In addition, it
provides some significant enhancements in upstream capacity over
DOCSIS 1.1, such as 30.72 Mbps maximum upstream channel capacity,
Synchronous-Code Division Multiple Access (CDMA) operation, increased
robustness to upstream noise and channel impairments, Enhanced Reed-
Solomon error correction, and Trellis Coded Modulation.
2.7. Downstream
The direction from the CMTS to the CM.
2.8. Head-end
The origination point in most cable systems of the subscriber video
signals. Generally also the location of the CMTS equipment.
2.9. MAC Packet
A term referring to DOCSIS Protocol Data Unit (PDU).
2.10. RF
A term referring to Radio Frequency.
2.11. SID
A term referring to DOCSIS Service ID. The SID identifies a
particular upstream bandwidth allocation and class-of-service
management for DOCSIS, and identifies a particular bidirectional
security association for BPI.
2.12. TLV
TLV stands for Type/Length/Value. TLV is an encoding method
consisting of three fields. The first field indicates the type of
element, the second field indicates the length of the element, and
the third field contains the element’s value.
2.13. Upstream
The direction from the CM to the CMTS.
3. Overview
Offering High Speed Internet Service in the cable industry has become
extremely successful. DOCSIS devices are being deployed at a rate of
multiple thousands per day. Although operators are enjoying
successful deployment, they are also facing the challenge of properly
managing deployed devices. Operators are using Simple Network
Management Protocol, a set of Management Information Base (MIB)
required by DOCSIS, and SNMP Notifications to manage deployed DOCSIS
devices. The usage of SNMP Notification for event reporting is
becoming more popular as an effective and efficient method for
network monitoring.
Unfortunately, only a minimal set of SNMP Notifications is currently
available. This notification MIB, in conjunction with [11] and [12],
provides a minimum set of standard DOCSIS Notifications that DOCSIS
devices SHOULD support to enable successful management of DOCSIS
devices and networks.
This document defines a set of objects required for the event
notification management of DOCSIS-compliant Cable Modems (CMs) and
Cable Modem Termination Systems (CMTSs). The MIB module is derived
from the DOCSIS [11] and [12].
Appendix H of [11] defines all DOCSIS 1.1 required events, and
Appendix D of [12] does that for DOCSIS 2.0. The notifications
specified in this document are used to notify these events via SNMP.
In this document, the key words "MUST", "MUST NOT", "REQUIRED",
"SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" are to be interpreted as described in RFC 2119 [1].
3.1. Structure of the MIB
This DOCS-IETF-CABLE-DEVICE-NOTIFICATION-MIB was designed to extend
the RFC2669 [5] notification module.
Two groups of SNMP notification objects are defined in this document.
One group defines notifications for cable modem events, and the other
group defines notifications for cable modem termination system
events.
DOCSIS defines numerous events, and each event is assigned to a
functional category. This MIB defines a notification object for each
functional category. The varbinding list of each notification
includes information about the event that occurred on the device.
4. Definitions
The MIB module defined here IMPORTs from SNMPv2-SMI [2], SNMPv2-CONF
[3], DOCS-CABLE-DEVICE-MIB [5], DOCS-IF-MIB [6], and IF-MIB [7].
DOCS-IETF-CABLE-DEVICE-NOTIFICATION-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
NOTIFICATION-TYPE,
mib-2
FROM SNMPv2-SMI -- RFC 2578
MODULE-COMPLIANCE,
OBJECT-GROUP,
NOTIFICATION-GROUP
FROM SNMPv2-CONF -- RFC 2580
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsDevSwFilename,
docsDevSwServer,
docsDevServerDhcp,
docsDevServerTime
FROM DOCS-CABLE-DEVICE-MIB -- RFC 2669
docsIfCmCmtsAddress,
docsIfCmtsCmStatusMacAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType,
docsIfCmtsCmStatusDocsisRegMode,
docsIfCmtsCmStatusModulationType
FROM DOCS-IF-MIB -- RFC 4546
ifPhysAddress
FROM IF-MIB; -- RFC 2863
docsDevNotifMIB MODULE-IDENTITY
LAST-UPDATED "200605240000Z" -- May 24, 2006
ORGANIZATION "IETF IP over Cable Data Network
Working Group"
CONTACT-INFO
" Azlina Ahmad
Postal: Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134, U.S.A.
Phone: 408 853 7927
E-mail: azlina@cisco.com
Greg Nakanishi
Postal: Motorola
6450 Sequence Drive
San Diego, CA 92121, U.S.A.
Phone: 858 404 2366
E-mail: gnakanishi@motorola.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-chairs: Richard Woundy,
richard_woundy@cable.comcast.com
Jean-Francois Mule, jf.mule@cablelabs.com"
DESCRIPTION
"The Event Notification MIB is an extension of the
CABLE DEVICE MIB. It defines various notification
objects for both cable modem and cable modem termination
systems. Two groups of SNMP notification objects are
defined. One group is for notifying cable modem events,
and one group is for notifying cable modem termination
system events.
DOCSIS defines numerous events, and each event is
assigned to a functional category. This MIB defines
a notification object for each functional category.
The varbinding list of each notification includes
information about the event that occurred on the
device.
Copyright (C) The Internet Society (2006). This version
of this MIB module is part of RFC 4547; see the RFC
itself for full legal notices."
REVISION "200605240000Z" -- May 24, 2006
DESCRIPTION
"Initial version, published as RFC 4547."
::= { mib-2 132 }
docsDevNotifControl OBJECT IDENTIFIER ::= { docsDevNotifMIB 1}
docsDevCmNotifs OBJECT IDENTIFIER ::= { docsDevNotifMIB 2 0 }
docsDevCmtsNotifs OBJECT IDENTIFIER ::= { docsDevNotifMIB 3 0 }
docsDevCmNotifControl OBJECT-TYPE
SYNTAX BITS {
cmInitTLVUnknownNotif( 0),
cmDynServReqFailNotif( 1),
cmDynServRspFailNotif( 2),
cmDynServAckFailNotif( 3),
cmBpiInitNotif( 4),
cmBPKMNotif( 5),
cmDynamicSANotif( 6),
cmDHCPFailNotif( 7),
cmSwUpgradeInitNotif( 8),
cmSwUpgradeFailNotif( 9),
cmSwUpgradeSuccessNotif( 10),
cmSwUpgradeCVCNotif( 11),
cmTODFailNotif( 12),
cmDCCReqFailNotif( 13),
cmDCCRspFailNotif( 14),
cmDCCAckFailNotif( 15)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The object is used to enable specific CM notifications.
For example, if the first bit is set, then
docsDevCmInitTLVUnknownNotif is enabled. If it is not set,
the notification is disabled. Note that notifications are
also under the control of the MIB modules defined in
RFC3413.
If the device is rebooted,the value of this object SHOULD
revert to the default value.
"
DEFVAL { {} }
::= { docsDevNotifControl 1 }
docsDevCmtsNotifControl OBJECT-TYPE
SYNTAX BITS {
cmtsInitRegReqFailNotif( 0),
cmtsInitRegRspFailNotif( 1),
cmtsInitRegAckFailNotif( 2),
cmtsDynServReqFailNotif( 3),
cmtsDynServRspFailNotif( 4),
cmtsDynServAckFailNotif( 5),
cmtsBpiInitNotif( 6),
cmtsBPKMNotif( 7),
cmtsDynamicSANotif( 8),
cmtsDCCReqFailNotif( 9),
cmtsDCCRspFailNotif( 10),
cmtsDCCAckFailNotif( 11)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The object is used to enable specific CMTS notifications.
For example, if the first bit is set, then
docsDevCmtsInitRegRspFailNotif is enabled. If it is not set,
the notification is disabled. Note that notifications are
also under the control of the MIB modules defined in
RFC3413.
If the device is rebooted,the value of this object SHOULD
revert to the default value.
"
DEFVAL { {} }
::= { docsDevNotifControl 2 }
docsDevCmInitTLVUnknownNotif NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"Notification to indicate that an unknown TLV was
encountered during the TLV parsing process.
This notification sends additional information about
the event by including the following objects in its
varbinding list.
- docsDevEvLevel: the priority level associated with the
event.
- docsDevEvId: the unique identifier of the event that
occurred.
- docsDevEvText: a textual description of the event.
- ifPhysAddress: the MAC address of the cable
interface of this cable modem.
- docsIfCmCmtsAddress: the MAC address of the CMTS
to which the CM is connected (if there is a cable
card/interface in the CMTS, then it is actually the
MAC address of the cable interface to which it is
connected).
- docsIfDocsisBaseCapability: the highest
version of the DOCSIS specification (1.0, 1.1, 2.0)
that the device is capable of supporting.
- docsIfCmStatusDocsisOperMode: the QOS level (1.0, 1.1)
that the CM is operating in.
- docsIfCmStatusModulationType: the upstream modulation
methodology used by the CM.
"
::= { docsDevCmNotifs 1 }
docsDevCmDynServReqFailNotif NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"A notification to report the failure of a dynamic service
request during the dynamic services process.
This notification sends additional information about
the event by including the following objects in its
varbinding list.
- docsDevEvLevel: the priority level associated with the
event.
- docsDevEvId: the unique identifier of the event that
occurred.
- docsDevEvText: a textual description of the event.
- ifPhysAddress: the MAC address of the cable
interface of this cable modem.
- docsIfCmCmtsAddress: the MAC address of the CMTS
to which the CM is connected to (if there is a cable
card/interface in the CMTS, then it is actually the
MAC address of the cable interface to which it is
connected).
- docsIfDocsisBaseCapability: the highest
version of the DOCSIS specification (1.0, 1.1, 2.0)
that the device is capable of supporting.
- docsIfCmStatusDocsisOperMode: the QOS level (1.0, 1.1)
that the CM is operating in.
- docsIfCmStatusModulationType: the upstream modulation
methodology used by the CM.
"
::= { docsDevCmNotifs 2 }
docsDevCmDynServRspFailNotif NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
" A notification to report the failure of a dynamic service
response during the dynamic services process.
This notification sends additional information about
the event by including the following objects in its
varbinding list.
- docsDevEvLevel: the priority level associated with the
event.
- docsDevEvId: the unique identifier of the event that
occurred.
- docsDevEvText: a textual description of the event.
- ifPhysAddress: the MAC address of the cable
interface of this cable modem.
- docsIfCmCmtsAddress: the MAC address of the CMTS
to which the CM is connected (if there is a cable
card/interface in the CMTS, then it is actually the
MAC address of the cable interface to which it is
connected).
- docsIfDocsisBaseCapability: the highest
version of the DOCSIS specification (1.0, 1.1, 2.0)
that the device is capable of supporting.
- docsIfCmStatusDocsisOperMode: the QOS level (1.0, 1.1)
that the CM is operating in.
- docsIfCmStatusModulationType: the upstream modulation
methodology used by the CM.
"
::= { docsDevCmNotifs 3}
docsDevCmDynServAckFailNotif NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,