Internet Draft J. Gao
IPCDN Working Group Cisco Systems
draft-ietf-ipcdn-docsisevent-mib-02.txt P. Siripunkaw
Comcast
D. Raftus
Imedia Semiconductor
Expires: July 2003
Event Notification Management Information Base
for DOCSIS Compliant Cable Modems and Cable Modem Termination Systems
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 (2003). 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 defines a basic set of managed objects for SNMP-
based event notification management of DOCSIS compliant Cable Modems
and Cable Modem Termination Systems. This MIB is defined as an
extension to the DOCSIS Cable Device MIB, RFC 2669.
This memo specifies a MIB module in a manner that is compliant to the
SMIv2. The set of objects is consistent with the SNMP framework and
Expires July 2003 [Page 1]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
existing SNMP standards.
This memo is a product of the IPCDN working group within the Internet
Engineering Task Force. Comments are solicited and should be
addressed to the working group's mailing list at ipcdn@ietf.org
and/or the author.
Table of Contents
1 The Internet-Standard Management Framework ...................... 2
2 Glossary ........................................................ 3
3 Overview ........................................................ 5
3.1 Structure of the MIB .......................................... 5
3.2 Event Throttling .............................................. 5
4 Definitions ..................................................... 5
5 Acknowledgments ................................................ 17
6 Normative References ........................................... 17
7 Informative References ......................................... 17
8 Security Considerations ........................................ 19
9 Intellectual Property .......................................... 20
10 Authors' Addresses ............................................ 20
11 Full Copyright Statement ...................................... 21
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 Data Over
Cable Service Interface Specification process.
2.1. BPI - Baseline Privacy Interface
A term referring to the DOCSIS specification [BPI] for enabling
simple data privacy in the DOCSIS 1.0 system.
Expires July 2003 [Page 2]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
2.2. BPI+ - Baseline Privacy Plus Interface
A term referring to the DOCSIS specification [BPI+] for enabling CM
authentication and data privacy in the DOCSIS 1.1 system.
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
"Data-Over-Cable Service Interface Specifications". A term referring
to the ITU-T J.112 Annex B standard for cable modem systems [RFI1.0],
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
[RFI1.1].
DOCSIS 2.0 [RFI2.0] 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- 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 head-end towards the subscriber.
2.8. Head-end
The origination point in most cable systems of the subscriber video
Expires July 2003 [Page 3]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
signals. Generally also the location of the CMTS equipment.
2.9. MAC Packet
A DOCSIS PDU.
2.10. RF
Radio Frequency.
2.11 SID
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. Upstream
The direction from the subscriber towards the head-end.
3. Overview
High Speed Internet Service offering in cable industry has become
extremely successful. DOCSIS devices including CM and CMTS are being
deployed at a rate of multiple thousands per day. Although operators
are enjoyinging successful deployment, they are also facing a
challenge to properly manage deployed devices. Operators are using
Simple Network Management Protocol, a set of Management Information
Base (MIB) required by DOCSIS, and SNMP Traps to manage deployed
DOCSIS devices. The usage of SNMP Trap for event reporting is
becoming more popular as an effective and efficient method for
network monitoring.
Unfortunately, only a minimal set of SNMP Traps is currently
available. This notification MIB in conjunction with [OSS1.1] /
[OSS2.0] provide a minimum set of standard DOCSIS Traps that DOCSIS
devices will support to enable successful management of DOCSIS
devices and network.
This document definess a set of objects required for the event
notification management of DOCSIS compliant Cable Modems (CMs) and
Cable Modem Termination Systems (CMTSs). The specification is derived
from the DOCSIS Operations Support System Interface Specification
[OSS1.1] and [OSS2.0].
The Appendix H of [OSS1.1] defines all DOCSIS 1.1 required events and
the Appendix D of [OSS2.0] does that for DOCSIS 2.0. The
notifications specified in this document are used to notify these
Expires July 2003 [Page 4]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
events via SNMP.
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119].
3.1. Structure of the MIB
The notification part of DOCS-CABLE-DEVICE-MIB of RFC 2669 [RFC2669]
was left empty for further enhancement. The DOCS-CABLE-DEVICE-TRAP-
MIB was designed to fulfill this role and therefore completes RFC
2669 in this regard.
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.
Common to all CM notification objects (traps) is that in their
OBJECTS statements, a CM trap contains information about the event
priority, the event Id, the event message body, the CM DOCSIS
capability, the CM DOCSIS register status, the cable interface MAC
address of the cable modem and the CMTS cable card MAC address to
which the cable modem is connected to.
Common to all CMTS notification objects (traps) is that in their
OBJECTS statements, a CMTS trap contains information about the event
priority, the event Id, the event message body, the connected CM
DOCSIS register status, the CM cable interface MAC address, the CMTS
DOCSIS register status and the CMTS cable card MAC address.
3.2. Event Throttling
SNMP event throttling is controlled as described in RFC 2669
[RFC2669].
4. Definitions
DOCS-CABLE-DEVICE-TRAP-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
NOTIFICATION-TYPE,
mib-2
FROM SNMPv2-SMI
Expires July 2003 [Page 5]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
MODULE-COMPLIANCE,
OBJECT-GROUP,
NOTIFICATION-GROUP
FROM SNMPv2-CONF
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsDevSwFilename,
docsDevSwServer,
docsDevServerDhcp,
docsDevServerTime
FROM DOCS-CABLE-DEVICE-MIB --RFC2669
docsIfCmCmtsAddress,
docsIfCmtsCmStatusMacAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType,
docsIfCmtsCmStatusDocsisRegMode,
docsIfCmtsCmStatusModulationType
FROM DOCS-IF-MIB
ifPhysAddress
FROM IF-MIB;
docsDevTrapMIB MODULE-IDENTITY
LAST-UPDATED "200301270000Z" -- January 27, 2003
ORGANIZATION "IETF IPCDN Working Group"
CONTACT-INFO
" Junming Gao
Postal: Cisco Systems
250 Apollo Drive
Chelmsford, MA 01824 U.S.A.
Phone: +1 978 497 4000
E-mail: jgao@cisco.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 CABLE DEVICE TRAP MIB is an extension of the
CABLE DEVICE MIB defined in RFC2669. It defines various
trap objects for both cable modem and cable modem
termination systems. Two groups of SNMP notification
Expires July 2003 [Page 6]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
objects are defined. One group is for notifying cable
modem events and one group for notifying cable modem
termination system events. Common to all CM
notification objects (traps) is that their OBJECTS
statements contain information about the event priority,
the event Id, the event message body, the CM DOCSIS
capability, the CM DOCSIS QOS level, the CM DOCSIS
upstream modulation type, the cable interface MAC
address of the cable modem and the cable card MAC address
of the CMTS to which the modem is connectede.
These objects are docsDevEvLevel, docsDevId,
docsDevEvText, docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode, docsIfCmStatusModulationType
ifPhysAddress and docsIfCmCmtsAddress. The values of
docsDevEvLevel, docsDevId, and docsDevEvText are from the
entry which logs this event in the docsDevEventTable, which
is defined in DOCS-CABLE-DEVICE-MIB of RFC2669. The
docsIfDocsisBaseCapability, docsIfCmStatusDocsisOperMode,
and docsIfCmStatusModulationType are defined in the DOCS-IF-MIB.
The ifPhysAddress value is the MAC address of the cable
interface of this cable modem. The docsIfCmCmtsAddress
specifies the MAC address of the CMTS (if there is a cable
card/ interface in the CMTS, then it is actually the
cable interface interface MAC address to which the CM is
connected). Individual CM trap may contain additional
objects to provide necessary information.
Common to all CMTS notification objects (traps) is that
their OBJECTS statements contain information about the
event priority, the event Id, the event message body,
the connected CM DOCSIS QOS status, the connected CM DOCSIS
modulation type, the CM cable interface MAC address, the
CMTS DOCSIS capability, and the CMTS MAC address.
These objects are docsDevEvLevel, docsDevId, docsDevEvText,
docsIfCmtsCmStatusDocsisRegMode,
docsIfCmtsCmStatusModulationType,
docsIfCmtsCmStatusMacAddress, docsIfDocsisBaseCapability, and
ifPhysAddress. The values of docsDevEvLevel, docsDevId, and
docsDevEvText are similar to those in CM traps. The values of
docsIfCmtsCmStatusDocsisRegMode,
docsIfCmtsCmStatusModulationType, and
docsIfCmtsCmStatusMacAddress are from the
docsIfCmtsCmStatusEntry (defined in DOCS-IF-MIB) corresponding
to a connected CM. The docsIfDocsisBaseCapability indicates the
CMTS DOCSIS capability. The ifPhysAddress value is the CMTS MAC
address (if there is a cable card/ interface in the CMTS, then
Expires July 2003 [Page 7]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
it is actually the MAC address of the cable interface which
connected to the CM).
Copyright (C) The Internet Society (2003). This version
of this MIB module is part of RFC xxxx; see the RFC
itself for full legal notices."
REVISION "200301270000Z" -- January 27, 2003
DESCRIPTION
"Modified by David Raftus (david.raftus@imedia.com) to
deprecate trap definition objects originating from
the docsIfExt MIB. Corresponding objects from the
Docsis 2.0 RF MIB draft were added to the trap
definitions."
::= { mib-2 xx } -- xx to be assigned by IANA
docsDevTraps OBJECT IDENTIFIER ::= { docsDevTrapMIB 1 }
docsDevTrapControl OBJECT IDENTIFIER ::= { docsDevTraps 1}
docsDevCmTraps OBJECT IDENTIFIER ::= { docsDevTraps 2 0 }
docsDevCmtsTraps OBJECT IDENTIFIER ::= { docsDevTraps 3 0 }
docsDevCmTrapControl OBJECT-TYPE
SYNTAX BITS {
cmInitTLVUnknownTrap( 0),
cmDynServReqFailTrap( 1),
cmDynServRspFailTrap( 2),
cmDynServAckFailTrap( 3),
cmBpiInitTrap( 4),
cmBPKMTrap( 5),
cmDynamicSATrap( 6),
cmDHCPFailTrap( 7),
cmSwUpgradeInitTrap( 8),
cmSwUpgradeFailTrap( 9),
cmSwUpgradeSuccessTrap( 10),
cmSwUpgradeCVCTrap( 11),
cmTODFailTrap( 12),
cmDCCReqFailTrap( 13),
cmDCCRspFailTrap( 14),
cmDCCAckFailTrap( 15)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The object is used to enable CM traps. From left to right,
the set bit indicates the corresponding CM trap is enabled.
For example, if the first bit is set, then
docsDevCmInitTLVUnknownTrap is enabled. If it is zero,
the trap is disabled.
Expires July 2003 [Page 8]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
"
DEFVAL { {} }
::= { docsDevTrapControl 1 }
docsDevCmtsTrapControl OBJECT-TYPE
SYNTAX BITS {
cmtsInitRegReqFailTrap( 0),
cmtsInitRegRspFailTrap( 1),
cmtsInitRegAckFailTrap( 2),
cmtsDynServReqFailTrap( 3),
cmtsDynServRspFailTrap( 4),
cmtsDynServAckFailTrap( 5),
cmtsBpiInitTrap( 6),
cmtsBPKMTrap( 7),
cmtsDynamicSATrap( 8),
cmtsDCCReqFailTrap( 9),
cmtsDCCRspFailTrap( 10),
cmtsDCCAckFailTrap( 11)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The object is used to enable CMTS traps. From left to right,
the set bit indicates the corresponding CMTS trap is enabled.
For example, if the first bit is set, then
docsDevCmtsInitRegRspFailTrap is enabled. If it is zero,
the trap is disabled.
"
DEFVAL { {} }
::= { docsDevTrapControl 2 }
docsDevCmInitTLVUnknownTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"Event due to detection of unknown TLV during
the TLV parsing process.
Expires July 2003 [Page 9]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
The values of docsDevEvLevel, docsDevId, and
docsDevEvText are from the entry which logs this event
in the docsDevEventTable. The docsIfDocsisBaseCapability
indicates the DOCSIS version information. The
docsIfCmStatusDocsisOperMode indicates the QOS level of
the CM, while the docsIfCmStatusModulationType indicates
the upstream modulation methodology used by the CM.
The ifPhysAddress value is the MAC address of the cable
interface of this cable modem.
The docsIfCmCmtsAddress specifies 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 which connected to the CM).
This part of information is uniformed across all CM traps.
"
::= { docsDevCmTraps 1 }
docsDevCmDynServReqFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic service
request happened during the dynamic services process.
"
::= { docsDevCmTraps 2 }
docsDevCmDynServRspFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
Expires July 2003 [Page 10]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic service
response happened during the dynamic services process.
"
::= { docsDevCmTraps 3}
docsDevCmDynServAckFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic service
acknowledgement happened during the dynamic services process.
"
::= { docsDevCmTraps 4}
docsDevCmBpiInitTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a BPI initialization
attempt happened during the registration process.
"
::= { docsDevCmTraps 5 }
docsDevCmBPKMTrap NOTIFICATION-TYPE
OBJECTS {
Expires July 2003 [Page 11]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a BPKM operation.
"
::= { docsDevCmTraps 6 }
docsDevCmDynamicSATrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic security
association operation.
"
::= { docsDevCmTraps 7 }
docsDevCmDHCPFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsDevServerDhcp,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
Expires July 2003 [Page 12]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
DESCRIPTION
"An event to report the failure of a DHCP server.
The value of docsDevServerDhcp is the IP address
of the DHCP server.
"
::= { docsDevCmTraps 8 }
docsDevCmSwUpgradeInitTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsDevSwFilename,
docsDevSwServer,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report a software upgrade initiated
event. The values of docsDevSwFilename, and
docsDevSwServer indicate the software image name
and the server IP address the image is from.
"
::= { docsDevCmTraps 9 }
docsDevCmSwUpgradeFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsDevSwFilename,
docsDevSwServer,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a software upgrade
attempt. The values of docsDevSwFilename, and
Expires July 2003 [Page 13]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
docsDevSwServer indicate the software image name
and the server IP address the image is from.
"
::= { docsDevCmTraps 10 }
docsDevCmSwUpgradeSuccessTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsDevSwFilename,
docsDevSwServer,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the Software upgrade success event.
The values of docsDevSwFilename, and
docsDevSwServer indicate the software image name
and the server IP address the image is from.
"
::= { docsDevCmTraps 11 }
docsDevCmSwUpgradeCVCFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of the verification
of code file happened during a secure software upgrade
attempt.
"
::= { docsDevCmTraps 12 }
Expires July 2003 [Page 14]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
docsDevCmTODFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsDevServerTime,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a time of day server.
The value of docsDevServerTime indicates the server IP
address.
"
::= { docsDevCmTraps 13 }
docsDevCmDCCReqFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic channel
change request happened during the dynamic channel
change process in the CM side.
"
::= { docsDevCmTraps 14 }
docsDevCmDCCRspFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
Expires July 2003 [Page 15]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic channel
change response happened during the dynamic channel
change process in the CM side.
"
::= { docsDevCmTraps 15 }
docsDevCmDCCAckFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
ifPhysAddress,
docsIfCmCmtsAddress,
docsIfDocsisBaseCapability,
docsIfCmStatusDocsisOperMode,
docsIfCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic channel
change acknowledgement happened during the dynamic channel
change process in the CM side.
"
::= { docsDevCmTraps 16}
docsDevCmtsInitRegReqFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a registration
request from CM happening during the CM initialization
Expires July 2003 [Page 16]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
process and detected on the CMTS side. The values of
docsDevEvLevel, docsDevId, and docsDevEvText are from
the entry which logs this event in the
docsDevEventTable. The docsIfCmtsCmStatusDocsisRegMode
and docsIfCmtsCmStatusMacAddress indicate the docsis
QOS version and the MAC address of the requesting CM.
The docsIfCmtsCmModulationType indicates the upstream
modulation methodology used by the connected CM.
The docsIfDocsisBaseCapability and ifPhysAddress
indicate the docsis version of the CMTS and the MAC
address of the CMTS (if there is a cable card/ interface
in the CMTS, then it is actually the MAC address of the
cable interface which connected to the CM) cable card
connected to the CM. This part of information is
uniformed across all CMTS traps.
"
::= { docsDevCmtsTraps 1 }
docsDevCmtsInitRegRspFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a registration
response happened during the CM initialization
process and detected in the CMTS side.
"
::= { docsDevCmtsTraps 2 }
docsDevCmtsInitRegAckFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
Expires July 2003 [Page 17]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a registration
acknowledgement from CM happened during the CM
initialization process and detected in the CMTS side.
"
::= { docsDevCmtsTraps 3 }
docsDevCmtsDynServReqFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic service
request happened during the dynamic services process
and detected in the CMTS side.
"
::= { docsDevCmtsTraps 4 }
docsDevCmtsDynServRspFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic service
response happened during the dynamic services process
and detected in the CMTS side.
"
Expires July 2003 [Page 18]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
::= { docsDevCmtsTraps 5 }
docsDevCmtsDynServAckFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic service
acknowledgement happened during the dynamic services
process and detected in the CMTS side.
"
::= { docsDevCmtsTraps 6 }
docsDevCmtsBpiInitTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a BPI initialization
attempt happened during the CM registration process
and detected in the CMTS side.
"
::= { docsDevCmtsTraps 7 }
docsDevCmtsBPKMTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
Expires July 2003 [Page 19]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a BPKM operation
which is detected in the CMTS side.
"
::= { docsDevCmtsTraps 8 }
docsDevCmtsDynamicSATrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic security
association operation which is detected in the CMTS side.
"
::= { docsDevCmtsTraps 9 }
docsDevCmtsDCCReqFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic channel
change request happened during the dynamic channel
Expires July 2003 [Page 20]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
change process in the CM side and detected in the
CMTS side.
"
::= { docsDevCmtsTraps 10 }
docsDevCmtsDCCRspFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic channel
change response happened during the dynamic channel
change process in the CMTS side.
"
::= { docsDevCmtsTraps 11 }
docsDevCmtsDCCAckFailTrap NOTIFICATION-TYPE
OBJECTS {
docsDevEvLevel,
docsDevEvId,
docsDevEvText,
docsIfCmtsCmStatusMacAddress,
ifPhysAddress,
docsIfCmtsCmStatusDocsisRegMode,
docsIfDocsisBaseCapability,
docsIfCmtsCmStatusModulationType
}
STATUS current
DESCRIPTION
"An event to report the failure of a dynamic channel
change acknowledgement happened during the dynamic channel
change process in the CMTS side.
"
::= { docsDevCmtsTraps 12}
--
--Conformance definitions
--
Expires July 2003 [Page 21]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
docsDevTrapConformance OBJECT IDENTIFIER ::= { docsDevTraps 4 }
docsDevTrapGroups OBJECT IDENTIFIER ::= { docsDevTrapConformance 1 }
docsDevTrapCompliances OBJECT IDENTIFIER ::= { docsDevTrapConformance 2 }
docsDevCmTrapCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for Cable Modem Traps and Control"
MODULE --docsDevTrap
--mandatory groups
GROUP docsDevCmTrapControlGroup
DESCRIPTION
"Mandatory in CM."
GROUP docsDevCmNotificationGroup
DESCRIPTION
"Mandatory in Cable Modem."
::= { docsDevTrapCompliances 1 }
docsDevCmTrapControlGroup OBJECT-GROUP
OBJECTS {
docsDevCmTrapControl
}
STATUS current
DESCRIPTION
"CM must support docsDevCmTrapControl."
::= { docsDevTrapGroups 1 }
docsDevCmNotificationGroup NOTIFICATION-GROUP
NOTIFICATIONS {
docsDevCmInitTLVUnknownTrap,
docsDevCmDynServReqFailTrap,
docsDevCmDynServRspFailTrap,
docsDevCmDynServAckFailTrap,
docsDevCmBpiInitTrap,
docsDevCmBPKMTrap,
docsDevCmDynamicSATrap,
docsDevCmDHCPFailTrap,
docsDevCmSwUpgradeInitTrap,
docsDevCmSwUpgradeFailTrap,
docsDevCmSwUpgradeSuccessTrap,
docsDevCmSwUpgradeCVCFailTrap,
docsDevCmTODFailTrap,
docsDevCmDCCReqFailTrap,
docsDevCmDCCRspFailTrap,
docsDevCmDCCAckFailTrap
Expires July 2003 [Page 22]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
}
STATUS current
DESCRIPTION
"A collection of CM notifications providing device status and
control."
::= { docsDevTrapGroups 2 }
docsDevCmtsTrapCompliance MODULE-COMPLIANCE
STATUS current
DESCRIPTION
"The compliance statement for MCNS Cable Modems and
Cable Modem Termination Systems."
MODULE --docsDevTrap
--mandatory groups
GROUP docsDevCmtsTrapControlGroup
DESCRIPTION
"Mandatory in CMTS."
GROUP docsDevCmtsNotificationGroup
DESCRIPTION
"Mandatory in Cable Modem Termination Systems."
::= { docsDevTrapCompliances 2 }
docsDevCmtsTrapControlGroup OBJECT-GROUP
OBJECTS {
docsDevCmtsTrapControl
}
STATUS current
DESCRIPTION
"CMTS must support docsDevCmtsTrapControl."
::= { docsDevTrapGroups 3 }
docsDevCmtsNotificationGroup NOTIFICATION-GROUP
NOTIFICATIONS {
docsDevCmtsInitRegReqFailTrap,
docsDevCmtsInitRegRspFailTrap,
docsDevCmtsInitRegAckFailTrap ,
docsDevCmtsDynServReqFailTrap,
docsDevCmtsDynServRspFailTrap,
docsDevCmtsDynServAckFailTrap,
docsDevCmtsBpiInitTrap,
docsDevCmtsBPKMTrap,
docsDevCmtsDynamicSATrap,
docsDevCmtsDCCReqFailTrap,
docsDevCmtsDCCRspFailTrap,
docsDevCmtsDCCAckFailTrap
Expires July 2003 [Page 23]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
}
STATUS current
DESCRIPTION
"A collection of CMTS notifications providing device status and
control."
::= { docsDevTrapGroups 4 }
END
5. Acknowledgments
This document was produced by the IPCDN Working Group.
Special thanks to Rich Woundy, who made several valuable suggestions
to improve the traps.
6. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC2669] St. Johns, M., editor, "DOCSIS Cable Device MIB, Cable
Device Management Information Base for DOCSIS compliant
Cable Modems and Cable Modem Termination Systems", RFC
2669, August 1999.
[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.
[RFC2580] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case, J.,
Rose, M. and S. Waldbusser, "Conformance Statements for
SMIv2", STD 58, RFC 2580, April 1999.
[BPI] "Data-Over-Cable Service Interface Specifications: DOCSIS
1.0 Baseline Privacy Interface Specification SCTE 22-2
2002", SCTE Data Standards Subcommittee, 2002,
http://www.scte.org/standards/.
[BPI+] "Data-Over-Cable Service Interface Specifications:
Baseline Privacy Plus Interface Specification
SP-BPI+-I09-020830", CableLabs, August 2002,
http://www.cablemodem.com/specifications/.
Expires July 2003 [Page 24]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
[OSS1.0] "Data-Over-Cable Service Interface Specifications:
DOCSIS 1.0 Operations Support System Interface
Specification Radio Frequency Interface SCTE 22-3
2002", SCTE Data Standards Subcommittee, 2002,
http://www.scte.org/standards/.
[OSS1.1] "Data-Over-Cable Service Interface Specifications:
Operations Support System Interface Specification
SP-OSSIv1.1-I06-020830", CableLabs, August 2002,
http://www.cablemodem.com/specifications/.
[OSS2.0] "Data-Over-Cable Service Interface Specifications:
Operations Support System Interface Specification
SP-OSSIv2.0-I03-021218", CableLabs, December 2002,
http://www.cablemodem.com/specifications/.
[RFI1.0] "Data-Over-Cable Service Interface Specifications:
DOCSIS 1.0 Radio Frequency Interface Specification SCTE
22-1 2002", SCTE Data Standards Subcommittee, 2002,
http://www.scte.org/standards/.
[RFI1.1] "Data-Over-Cable Service Interface Specifications:
Radio Frequency Interface Specification
SP-RFIv1.1-I09-020830", CableLabs, August 2002,
http://www.cablemodem.com/specifications/.
[RFI2.0] "Data-Over-Cable Service Interface Specifications:
Radio Frequency Interface Specification
SP-RFIv2.0-I03-021218", CableLabs, December 2002,
http://www.cablemodem.com/specifications/.
7. Informative References
[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:
o Setting docsDevCmTrapControl or docsDevCmtsTrapControl may
Expires July 2003 [Page 25]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
cause flooding of traps, which can disrupt network service.
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 implementors 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 which may cover technology that may be required to practice
this standard. Please address the information to the IETF Executive
Director.
10. Authors' Addresses
Junming Gao
Cisco Systems
250 Apollo Drive
Expires July 2003 [Page 26]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
Chelmsford, MA 01824 U.S.A.
Phone: +1 978 244 8000
Email: jgao@cisco.com
Pak Siripunkaw
Comcast
3 Executive Campus
Cherry Hill, NJ 08002 U.S.A.
Phone: +1 856 317 7200
Email: Pak_Siripunkaw2@Cable.Comcast.com
David Raftus
Imedia Semiconductor
340 Terry Fox Drive, Suite 202
Ottawa Ontario Canada
Phone: +1 613 592 1052 ext 222
E-mail: david.raftus@imedia.com
11. Full Copyright Statement
Copyright (C) The Internet Society (2003). 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
Expires July 2003 [Page 27]
INTERNET-DRAFT DOCSIS Event Notification MIB January 2003
Funding for the RFC Editor function is currently provided by the
Internet Society.
Expires July 2003 [Page 28]