Request for Comments: 2670 @Home Network
Category: Proposed Standard August 1999
Radio Frequency (RF) Interface Management Information Base
for MCNS/DOCSIS compliant RF interfaces
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 (1999). 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 management of MCNS/DOCSIS compliant Radio Frequency (RF)
interfaces.
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.
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@terayon.com
and/or the author.
Table of Contents
1 The SNMP Management Framework ................................... 3
2 Glossary ........................................................ 4
2.1 CATV .......................................................... 4
2.2 Channel ....................................................... 4
2.3 CM ............................................................ 4
2.4 CMTS .......................................................... 4
2.5 Codeword ...................................................... 4
2.6 Data Packet ................................................... 4
2.7 dBmV .......................................................... 4
2.8 DOCSIS ........................................................ 5
2.9 Downstream .................................................... 5
2.10 Head-end ..................................................... 5
2.11 MAC Packet ................................................... 5
2.12 MCNS ......................................................... 5
2.13 Mini-slot .................................................... 5
2.14 QPSK ......................................................... 5
2.15 QAM .......................................................... 5
2.16 RF ........................................................... 5
2.17 Symbol-times ................................................. 5
2.18 Upstream ..................................................... 6
3 Overview ........................................................ 6
3.1 Structure of the MIB .......................................... 6
3.1.1 docsIfBaseObjects ........................................... 6
3.1.2 docsIfCmObjects ............................................. 7
3.1.3 docsIfCmtsObjects ........................................... 7
3.2 Relationship to the Interfaces MIB ............................ 7
3.2.1 Layering Model .............................................. 7
3.2.2 Virtual Circuits ............................................ 8
3.2.3 ifTestTable ................................................. 9
3.2.4 ifRcvAddressTable ........................................... 9
3.2.5 ifEntry ..................................................... 9
3.2.5.1 ifEntry for Downstream interfaces ......................... 9
3.2.5.1.1 ifEntry for Downstream interfaces in Cable Modem
Termination Systems .......................................... 9
3.2.5.1.2 ifEntry for Downstream interfaces in Cable Modems ...... 11
3.2.5.2 ifEntry for Upstream interfaces .......................... 12
3.2.5.2.1 ifEntry for Upstream interfaces in Cable Modem
Termination Systems ......................................... 12
3.2.5.2.2 ifEntry for Upstream interfaces in Cable Modems ........ 14
3.2.5.3 ifEntry for the MAC Layer ................................ 15
4 Definitions .................................................... 18
5 Acknowledgments ................................................ 69
6 References ..................................................... 69
7 Security Considerations ........................................ 70
8 Intellectual Property .......................................... 71
9 Author's Address ............................................... 71
10 Full Copyright Statement ...................................... 72
1. The SNMP Management Framework
The SNMP Management Framework presently consists of five major
components:
o An overall architecture, described in RFC2571 [1].
o Mechanisms for describing and naming objects and events for the
purpose of management. The first version of this Structure of
Management Information (SMI) is called SMIv1 and described in STD
16, RFC1155 [2], STD 16, RFC1212 [3] and RFC1215 [4]. The
second version, called SMIv2, is described in STD 58, RFC2578
[5], STD 58, RFC2579 [6] and STD 58, RFC2580 [7].
o Message protocols for transferring management information. The
first version of the SNMP message protocol is called SNMPv1 and
described in RFC1157 [8]. A second version of the SNMP message
protocol, which is not an Internet standards track protocol, is
called SNMPv2c and described in RFC1901 [9] and RFC1906 [10].
The third version of the message protocol is called SNMPv3 and
described in RFC1906 [10], RFC2572 [11] and RFC2574 [12].
o Protocol operations for accessing management information. The
first set of protocol operations and associated PDU formats is
described in STD 15, RFC1157 [8]. A second set of protocol
operations and associated PDU formats is described in RFC1905
[13].
o A set of fundamental applications described in RFC2573 [14] and
the view-based access control mechanism described in RFC2575
[15].
Managed objects are accessed via a virtual information store, termed
the Management Information Base or MIB. Objects in the MIB are
defined using the mechanisms defined in the SMI.
This memo specifies a MIB module that is compliant to the SMIv2. A
MIB conforming to the SMIv1 can be produced through the appropriate
translations. The resulting translated MIB MUST be semantically
equivalent, except where objects or events are omitted because no
translation is possible (use of Counter64). Some machine readable
information in SMIv2 will be converted into textual descriptions in
SMIv1 during the translation process. However, this loss of machine
readable information is not considered to change the semantics of the
MIB.
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. 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.2. Channel
A specific frequency allocation with an RF medium, specified by
channel width in Hertz (cycles per second) and by center frequency.
Within the US Cable Systems, upstream channels are generally
allocated from the 5-42MHz range while down stream channels are
generally allocated from the 50-750MHz range depending on the
capabilities of the given system. The typical broadcast channel
width in the US is 6MHz. Upstream channel widths for DOCSIS vary.
2.3. CM Cable Modem.
A CM acts as a "slave" station in a DOCSIS compliant cable data
system.
2.4. 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.5. Codeword
See [16]. A characteristic of the Foward Error Correction scheme used
above the RF media layer.
2.6. Data Packet
The payload portion of the MAC Packet.
2.7. dBmV
Decibel relative to one milli-volt. A measure of RF power.
2.8. DOCSIS
"Data Over Cable Interface Specification". A term referring to the
ITU-T J.112 Annex B standard for cable modem systems [20].
2.9. Downstream
The direction from the head-end towards the subscriber.
2.10. Head-end
The origination point in most cable systems of the subscriber video
signals.
2.11. MAC Packet
A DOCSIS PDU.
2.12. MCNS
"Multimedia Cable Network System". Generally replaced in usage by
DOCSIS.
2.13. Mini-slot
See [16]. In general, an interval of time which is allocated by the
CMTS to a given CM for that CM to transmit in an upstream direction.
2.14. QPSK Quadrature Phase Shift Keying.
A particular modulation scheme on an RF medium. See [19].
2.15. QAM Quadrature Amplitude Modulation.
A particular modulation scheme on on RF medium. Usually expressed
with a number indicating the size of the modulation constellation
(e.g. 16 QAM). See [19], or any other book on digital communications
over RF for a complete explanation of this.
2.16. RF
Radio Frequency.
2.17. Symbol-times
See [16]. A characteristic of the RF modulation scheme.
2.18. Upstream
The direction from the subscriber towards the head-end.
3. Overview
This MIB provides a set of objects required for the management of
MCNS/DOCSIS compliant Cable Modem (CM) and Cable Modem Termination
System (CMTS) RF interfaces. The specification is derived in part
from the parameters and protocols described in DOCSIS Radio Frequency
Interface Specification [16].
3.1. Structure of the MIB
This MIB is structured as three groups:
o Management information pertinent to both Cable Modems (CM) and
Cable Modem Termination Systems (CMTS) (docsIfBaseObjects).
o Management information pertinent to Cable Modems only
(docsIfCmObjects).
o Management information pertinent to Cable Modem Termination
Systems only (docsIfCmtsObjects).
Tables within each of these groups group objects functionally - e.g.
Quality of Service, Channel characteristics, MAC layer management,
etc. Rows created automatically (e.g. by the device according to the
hardware configuration) may and generally will have a mixture of
configuration and status objects within them. Rows that are meant to
be created by the management station are generally restricted to
configuration (read-create) objects.
3.1.1. docsIfBaseObjects
docsIfDownstreamChannelTable - This table describes the active
downstream channels for a CMTS and the received downstream channel
for a CM.
docsIfUpstreamChannelTable - This table describes the active upstream
channels for a a CMTS and the current upstream transmission channel
for a CM.
docsIfQosProfileTable - This table describes the valid Quality of
Service service profiles for the cable data system.
docsIfSignalQualityTable - This table is used to monitor RF signal
quality characteristics of received signals.
3.1.2. docsIfCmObjects
docsIfCmMacTable - This table is used to monitor the DOCSIS MAC
interface and can be considered an extension to the ifEntry.
docsIfCmServiceTable - This table describes the upstream service
queues available at this CM. There is a comparable table at the
CMTS, docsIfCmtsServiceEntry, which describes the service queues from
the point of view of the CMTS.
3.1.3. docsIfCmtsObjects
docsIfCmtsStatusTable - This table provides a set of aggregated
counters which roll-up values and events that occur on the underlying
sub-interfaces.
docsIfCmtsCmStatusTable - This table is used to hold information
about known (e.g. registered) cable modems on the system serviced by
this CMTS.
docsIfCmtsServiceEntry - This table provides access to the
information related to upstream service queues.
docsIfCmtsModulationTable - This table allows control over the
modulation profiles for RF channels associated with this CMTS.
docsIfCmtsMacToCmTable - This table allows fast access into the
docsIfCmtsCmTable via a MAC address (of the CM) interface.
3.2. Relationship to the Interfaces MIB
This section clarifies the relationship of this MIB to the Interfaces
MIB [17]. Several areas of correlation are addressed in the
following subsections. The implementor is referred to the Interfaces
MIB document in order to understand the general intent of these
areas.
3.2.1. Layering Model
An instance of ifEntry exists for each RF Downstream interface, for
each RF Upstream interface, and for each RF MAC layer. The
ifStackTable [17] MUST be implemented to identify relationships among
sub-interfaces.
The following example illustrates a MAC interface with one downstream
and two upstream channels.
| <== to network layer
+-------------+--------------+
| RF MAC |
+----+---------+-----------+-+
| | |
+---------+---+ +---+-------+ +-+---------+
| Downstream1 | | Upstream1 | | Upstream2 |
+-------------+ +-----------+ +-----------+
As can be seen from this example, the RF MAC interface is layered on
top of the downstream and upstream interfaces.
In this example, the assignment of index values could be as follows:
ifIndex ifType Description
1 docsCableMaclayer(127) CATV MAC Layer
2 docsCableDownstream(128) CATV Downstream interface
3 docsCableUpstream(129) CATV Upstream interface
4 docsCableUpstream(129) CATV Upstream interface
The corresponding ifStack entries would then be:
| IfStackHigherLayer | ifStackLowerLayer |
| 0 | 1 |
| 1 | 2 |
| 1 | 3 |
| 1 | 4 |
| 2 | 0 |
| 3 | 0 |
| 4 | 0 |
The same interface model can also be used in Telephony or Telco
Return systems. A pure Telco Return system (Cable Modem as well as
Cable Modem Termination System) would not have upstream, but only
downstream cable channels. Systems supporting both Telco Return and
cable upstream channels can use the above model without modification.
Telco Return Upstream channel(s) are handled by the appropriate MIBs,
such as PPP or Modem MIBs.
3.2.2. Virtual Circuits
This medium does not support virtual circuits and this area is not
applicable to this MIB.
3.2.3. ifTestTable
The ifTestTable is not supported by this MIB.
3.2.4. ifRcvAddressTable
The ifRcvAddressTable is not supported by this MIB.
3.2.5. ifEntry
This section documents only the differences from the requirements
specified in the Interfaces MIB. See that MIB for columns omitted
from the descriptions below.
3.2.5.1. ifEntry for Downstream interfaces
The ifEntry for Downstream interfaces supports the
ifGeneralInformationGroup and the ifPacketGroup of the Interfaces
MIB. This is an output only interface at the CMTS and all input
status counters - ifIn* - will return zero. This is an input only
interface at the CM and all output status counters - ifOut* - will
return zero.
3.2.5.1.1. ifEntry for Downstream interfaces in Cable Modem Termination
Systems
ifTable Comments
============== ===========================================
ifIndex Each RF Cable Downstream interface is represented
by an ifEntry.
ifType The IANA value of docsCableDownstream(128).
ifSpeed Return the speed of this downstream channel.
The returned value the raw bandwidth in bits/s
of this interface. This is the symbol rate
multiplied with the number of bits per symbol.
ifPhysAddress Return an empty string.
ifAdminStatus The administrative status of this interface.
ifOperStatus The current operational status of this interface.
ifMtu The size of the largest frame which can be
sent on this interface, specified in octets.
The value includes the length of the MAC header.
ifInOctets Return zero.
ifInUcastPkts Return zero.
ifInMulticastPkts Return zero.
ifInBroadcastPkts Return zero.
ifInDiscards Return zero.
ifInErrors Return zero.
ifInUnknownProtos Return zero.
ifOutOctets The total number of octets transmitted on this
interface. This includes MAC packets as well as
data packets, and includes the length of the MAC
header.
ifOutUcastPkts The number of Unicast packets transmitted on this
interface. This includes MAC packets as well as
data packets.
ifOutMulticastPkts
Return the number of Multicast packets transmitted
on this interface.
This includes MAC packets as well as data packets.
ifOutBroadcastPkts
Return the number of broadcast packets transmitted
on this interface.
This includes MAC packets as well as data packets.
ifOutDiscards The total number of outbound packets which
were discarded. Possible reasons are:
buffer shortage.
ifOutErrors The number of packets which could not be
transmitted due to errors.
ifPromiscuousMode Return false.
3.2.5.1.2. ifEntry for Downstream interfaces in Cable Modems
ifTable Comments
============== ===========================================
ifIndex Each RF Cable Downstream interface is represented
by an ifEntry.
ifType The IANA value of docsCableDownstream(128).
ifSpeed Return the speed of this downstream channel.
The returned value the raw bandwidth in bits/s
of this interface. This is the symbol rate
multiplied with the number of bits per symbol.
ifPhysAddress Return an empty string.
ifAdminStatus The administrative status of this interface.
ifOperStatus The current operational status of this interface.
ifMtu The size of the largest frame which can be
received from this interface, specified in octets.
The value includes the length of the MAC header.
ifInOctets The total number of octets received on this
interface. This includes data packets as well as
MAC layer packets, and includes the length of the
MAC header.
ifInUcastPkts The number of Unicast packets received on this
interface. This includes data packets as well as
MAC layer packets.
ifInMulticastPkts Return the number of Multicast packets received
on this interface. This includes data packets as
well as MAC layer packets.
ifInBroadcastPkts Return the number of Broadcast packets received
on this interface. This includes data packets
as well as MAC layer packets.
ifInDiscards The total number of received packets which have
been discarded.
The possible reasons are: buffer shortage.
ifInErrors The number of inbound packets that contained
errors preventing them from being deliverable
to higher layers.
Possible reasons are: MAC FCS error.
ifInUnknownProtos The number of frames with an unknown packet type.
These are MAC frames with an unknown packet type.
ifOutOctets Return zero.
ifOutUcastPkts Return zero.
ifOutMulticastPkts
Return zero.
ifOutBroadcastPkts
Return zero.
ifOutDiscards Return zero.
ifOutErrors Return zero.
ifPromiscuousMode Refer to the Interfaces MIB.
3.2.5.2. ifEntry for Upstream interfaces
The ifEntry for Upstream interfaces supports the
ifGeneralInformationGroup and the ifPacketGroup of the Interfaces
MIB. This is an input only interface at the CMTS and all output
status counters - ifOut* - will return zero. This is an output only
interface at the CM and all input status counters - ifIn* - will
return zero.
3.2.5.2.1. ifEntry for Upstream interfaces in Cable Modem Termination
Systems
ifTable Comments
============== ===========================================
ifIndex Each RF Cable Upstream interface is represented
by an ifEntry.
ifType The IANA value of docsCableUpstream(129).
ifSpeed Return the speed of this upstream channel.
The returned value is the raw bandwidth
in bits/s of this interface, regarding the
highest speed modulation profile that is
defined. This is the symbol rate multiplied
with the number of bits per symbol for this
modulation profile.
ifPhysAddress Return an empty string.
ifAdminStatus The administrative status of this interface.
ifOperStatus The current operational status of this interface.
ifMtu The size of the largest frame which can be
received on this interface, specified in octets.
The value includes the length of the MAC header.
ifInOctets The total number of octets received on this
interface. This includes data packets as well as
MAC layer packets, and includes the length of the
MAC header.
ifInUcastPkts The number of Unicast packets received on this
interface. This includes data packets as well as
MAC layer packets.
ifInMulticastPkts Return the number of Multicast packets received
on this interface. This includes data packets as
well as MAC layer packets.
ifInBroadcastPkts Return the number of Broadcast packets received
on this interface. This includes data packets
as well as MAC layer packets.
ifInDiscards The total number of received packets which have
been discarded.
The possible reasons are: buffer shortage.
ifInErrors The number of inbound packets that contained
errors preventing them from being deliverable
to higher layers.
Possible reasons are: MAC FCS error.
ifInUnknownProtos The number of frames with an unknown packet type.
This are MAC frames with an unknown packet type.
ifOutOctets Return zero.
ifOutUcastPkts Return zero.
ifOutMulticastPkts
Return zero.
ifOutBroadcastPkts
Return zero.
ifOutDiscards Return zero.
ifOutErrors Return zero.
3.2.5.2.2. ifEntry for Upstream interfaces in Cable Modems
ifTable Comments
============== ===========================================
ifIndex Each RF Cable Upstream interface is represented
by an ifEntry.
ifType The IANA value of docsCableUpstream(129).
ifSpeed Return the speed of this upstream channel.
The returned value is the raw bandwidth
in bits/s of this interface, regarding the
highest speed modulation profile that is
defined. This is the symbol rate multiplied
with the number of bits per symbol for this
modulation profile.
ifPhysAddress Return an empty string.
ifAdminStatus The administrative status of this interface.
ifOperStatus The current operational status of this interface.
ifMtu The size of the largest frame which can be
transmitted on this interface, specified in octets.
The value includes the length of the MAC header.
ifInOctets Return zero.
ifInUcastPkts Return zero.
ifInMulticastPkts Return zero.
ifInBroadcastPkts Return zero.
ifInDiscards Return zero.
ifInErrors Return zero.
ifInUnknownProtos Return zero.
ifOutOctets The total number of octets transmitted on this
interface. This includes MAC packets as well as
data packets, and includes the length of the MAC
header.
ifOutUcastPkts The number of Unicast packets transmitted on this
interface. This includes MAC packets as well as
data packets.
ifOutMulticastPkts
Return the number of Multicast packets transmitted
on this interface.
This includes MAC packets as well as data packets.
ifOutBroadcastPkts
Return the number of broadcast packets transmitted
on this interface.
This includes MAC packets as well as data packets.
ifOutDiscards The total number of outbound packets which
were discarded. Possible reasons are:
buffer shortage.
ifOutErrors The number of packets which could not be
transmitted due to errors.
ifPromiscuousMode Return false.
3.2.5.3. ifEntry for the MAC Layer
The ifEntry for the MAC Layer supports the ifGeneralInformationGroup
and the ifPacketGroup of the Interfaces MIB. This interface provides
an aggregate view of status for the lower level Downstream and
Upstream interfaces.
ifTable Comments
============== ===========================================
ifIndex Each RF Cable MAC layer entity is represented
by an ifEntry.
ifType The IANA value of docsCableMaclayer(127).
ifSpeed Return zero.
ifPhysAddress Return the physical address of this interface.
ifAdminStatus The administrative status of this interface.
ifOperStatus The current operational status of the MAC
layer interface.
ifHighSpeed Return zero.
ifMtu Return 1500.
ifInOctets The total number of data octets received on this
interface, targeted for upper protocol layers.
ifInUcastPkts The number of Unicast packets received on this
interface, targeted for upper protocol layers.
ifInMulticastPkts Return the number of Multicast packets received
on this interface, targeted for upper protocol
layers.
ifInBroadcastPkts Return the number of Broadcast packets received
on this interface, targeted for upper protocol
layers.
ifInDiscards The total number of received packets which have
been discarded.
The possible reasons are: buffer shortage.
ifInErrors The number of inbound packets that contained
errors preventing them from being deliverable
to higher layers.
Possible reasons are: data packet FCS error,
invalid MAC header.
ifInUnknownProtos The number of frames with an unknown packet type.
This is the number of data packets targeted for
upper protocol layers with an unknown packet type.
ifOutOctets The total number of octets, received from upper
protocol layers and transmitted on this interface.
ifOutUcastPkts The number of Unicast packets, received from upper
protocol layers and transmitted on this interface.
ifOutMulticastPkts
Return the number of Multicast packets received
from upper protocol layers and transmitted on this
interface.
ifOutBroadcastPkts
Return the number of broadcast packets received
from upper protocol layers and transmitted on this
interface.
ifOutDiscards The total number of outbound packets which
were discarded. Possible reasons are:
buffer shortage.
ifOutErrors The number of packets which could not be
transmitted due to errors.
ifPromiscuousMode Refer to the Interfaces MIB.
4. Definitions
DOCS-IF-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
-- do not import BITS,
Unsigned32,
Integer32,
Counter32,
TimeTicks,
IpAddress,
transmission
FROM SNMPv2-SMI
TEXTUAL-CONVENTION,
MacAddress,
RowStatus,
TruthValue,
TimeInterval,
TimeStamp
FROM SNMPv2-TC
OBJECT-GROUP,
MODULE-COMPLIANCE
FROM SNMPv2-CONF
ifIndex, InterfaceIndexOrZero
FROM IF-MIB;
docsIfMib MODULE-IDENTITY
LAST-UPDATED "9908190000Z" -- August 19, 1999
ORGANIZATION "IETF IPCDN Working Group"
CONTACT-INFO
" Michael StJohns
Postal: @Home Network
425 Broadway
Redwood City, CA
U.S.A.
Phone: +1 650 569 5368
E-mail: stjohns@corp.home.net"
DESCRIPTION
"This is the MIB Module for MCNS/DOCSIS compliant Radio
Frequency (RF) interfaces in Cable Modems (CM) and
Cable Modem Termination Systems (CMTS)."
REVISION "9908190000Z"
DESCRIPTION
"Initial Version, published as RFC2670.
Modified by Mike StJohns to fix problems identified by
the first pass of the MIB doctor. Of special note,
docsIfRangingResp and docsIfCmtsInsertionInterval were
obsoleted and replaced by other objects with the same
functionality, but more appropriate SYNTAX."
::= { transmission 127 }
-- Textual Conventions
TenthdBmV ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d-1"
STATUS current
DESCRIPTION
"This data type represents power levels that are normally
expressed in dBmV. Units are in tenths of a dBmV;
for example, 5.1 dBmV will be represented as 51."
SYNTAX Integer32
TenthdB ::= TEXTUAL-CONVENTION
DISPLAY-HINT "d-1"
STATUS current
DESCRIPTION
"This data type represents power levels that are normally
expressed in dB. Units are in tenths of a dB;
for example, 5.1 dB will be represented as 51."
SYNTAX Integer32
docsIfMibObjects OBJECT IDENTIFIER ::= { docsIfMib 1 }
docsIfBaseObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 1 }
docsIfCmObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 2 }
docsIfCmtsObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 3 }
--
-- BASE GROUP
--
--
-- The following table is implemented on both the Cable Modem (CM)
-- and the Cable Modem Termination System (CMTS).
--
docsIfDownstreamChannelTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIfDownstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table describes the attributes of downstream
channels (frequency bands)."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Table 4-12 and Table 4-13."
::= { docsIfBaseObjects 1 }
docsIfDownstreamChannelEntry OBJECT-TYPE
SYNTAX DocsIfDownstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry provides a list of attributes for a single
Downstream channel.
An entry in this table exists for each ifEntry with an
ifType of docsCableDownstream(128)."
INDEX { ifIndex }
::= { docsIfDownstreamChannelTable 1 }
DocsIfDownstreamChannelEntry ::= SEQUENCE {
docsIfDownChannelId Integer32,
docsIfDownChannelFrequency Integer32,
docsIfDownChannelWidth Integer32,
docsIfDownChannelModulation INTEGER,
docsIfDownChannelInterleave INTEGER,
docsIfDownChannelPower TenthdBmV
}
docsIfDownChannelId OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Cable Modem Termination System (CMTS) identification
of the downstream channel within this particular MAC
interface. If the interface is down, the object returns
the most current value. If the downstream channel ID is
unknown, this object returns a value of 0."
::= { docsIfDownstreamChannelEntry 1 }
docsIfDownChannelFrequency OBJECT-TYPE
SYNTAX Integer32 (0..1000000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The center of the downstream frequency associated with
this channel. This object will return the current tuner
frequency. If a CMTS provides IF output, this object
will return 0, unless this CMTS is in control of the
final downstream RF frequency. See the associated
compliance object for a description of valid frequencies
that may be written to this object."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 4.3.3."
::= { docsIfDownstreamChannelEntry 2 }
docsIfDownChannelWidth OBJECT-TYPE
SYNTAX Integer32 (0..16000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The bandwidth of this downstream channel. Most
implementations are expected to support a channel width
of 6 MHz (North America) and/or 8 MHz (Europe). See the
associated compliance object for a description of the
valid channel widths for this object."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Table 4-12 and Table 4-13."
::= { docsIfDownstreamChannelEntry 3 }
docsIfDownChannelModulation OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
other(2),
qam64(3),
qam256(4)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The modulation type associated with this downstream
channel. If the interface is down, this object either
returns the configured value (CMTS), the most current
value (CM), or the value of unknown(1). See the
associated conformance object for write conditions and
limitations. See the reference for specifics on the
modulation profiles implied by qam64 and qam256."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 3.6.2."
::= { docsIfDownstreamChannelEntry 4 }
docsIfDownChannelInterleave OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
other(2),
taps8Increment16(3),
taps16Increment8(4),
taps32Increment4(5),
taps64Increment2(6),
taps128Increment1(7)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The Forward Error Correction (FEC) interleaving used
for this downstream channel.
Values are defined as follows:
taps8Increment16(3): protection 5.9/4.1 usec,
latency .22/.15 msec
taps16Increment8(4): protection 12/8.2 usec,
latency .48/.33 msec
taps32Increment4(5): protection 24/16 usec,
latency .98/.68 msec
taps64Increment2(6): protection 47/33 usec,
latency 2/1.4 msec
taps128Increment1(7): protection 95/66 usec,
latency 4/2.8 msec
If the interface is down, this object either returns
the configured value (CMTS), the most current value (CM),
or the value of unknown(1).
The value of other(2) is returned if the interleave
is known but not defined in the above list.
See the associated conformance object for write
conditions and limitations. See the reference for the FEC
configuration described by the setting of this object."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 4.3.2."
::= { docsIfDownstreamChannelEntry 5 }
docsIfDownChannelPower OBJECT-TYPE
SYNTAX TenthdBmV
UNITS "dBmV"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"At the CMTS, the operational transmit power. At the CM,
the received power level. May be set to zero at the CM
if power level measurement is not supported.
If the interface is down, this object either returns
the configured value (CMTS), the most current value (CM)
or the value of 0. See the associated conformance object
for write conditions and limitations. See the reference
for recommended and required power levels."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Table 4-12 and Table 4-13."
::= { docsIfDownstreamChannelEntry 6 }
--
-- The following table is implemented on both the CM and the CMTS.
-- For the CM, only attached channels appear in the table. For the
-- CM, this table is read only as well.
--
docsIfUpstreamChannelTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIfUpstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This table describes the attributes of attached upstream
channels (frequency bands)."
::= { docsIfBaseObjects 2 }
docsIfUpstreamChannelEntry OBJECT-TYPE
SYNTAX DocsIfUpstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"List of attributes for a single upstream channel.
An entry in this table exists for each ifEntry with an
ifType of docsCableUpstream(129)."
INDEX { ifIndex }
::= { docsIfUpstreamChannelTable 1 }
DocsIfUpstreamChannelEntry ::= SEQUENCE {
docsIfUpChannelId Integer32,
docsIfUpChannelFrequency Integer32,
docsIfUpChannelWidth Integer32,
docsIfUpChannelModulationProfile Unsigned32,
docsIfUpChannelSlotSize Unsigned32,
docsIfUpChannelTxTimingOffset Unsigned32,
docsIfUpChannelRangingBackoffStart Integer32,
docsIfUpChannelRangingBackoffEnd Integer32,
docsIfUpChannelTxBackoffStart Integer32,
docsIfUpChannelTxBackoffEnd Integer32
}
docsIfUpChannelId OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The CMTS identification of the upstream channel."
::= { docsIfUpstreamChannelEntry 1 }
docsIfUpChannelFrequency OBJECT-TYPE
SYNTAX Integer32 (0..1000000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The center of the frequency band associated with this
upstream channel. This object returns 0 if the frequency
is undefined or unknown. Minimum permitted upstream
frequency is 5,000,000 Hz for current technology. See
the associated conformance object for write conditions
and limitations."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Table 2-2."
::= { docsIfUpstreamChannelEntry 2 }
docsIfUpChannelWidth OBJECT-TYPE
SYNTAX Integer32 (0..20000000)
UNITS "hertz"
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The bandwidth of this upstream channel. This object
returns 0 if the channel width is undefined or unknown.
Minimum permitted channel width is 200,000 Hz currently.
See the associated conformance object for write conditions
and limitations."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Table 4-3."
::= { docsIfUpstreamChannelEntry 3 }
docsIfUpChannelModulationProfile OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"An entry identical to the docsIfModIndex in the
docsIfCmtsModulationTable that describes this channel.
This channel is further instantiated there by a grouping
of interval usage codes which together fully describe the
channel modulation. This object returns 0 if the
docsIfCmtsModulationTable entry does not exist or
docsIfCmtsModulationTable is empty. See
the associated conformance object for write conditions
and limitations."
::= { docsIfUpstreamChannelEntry 4 }
docsIfUpChannelSlotSize OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The number of 6.25 microsecond ticks in each upstream mini-
slot. Returns zero if the value is undefined or unknown.
See the associated conformance object for write
conditions and limitations."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 6.1.2.4."
::= { docsIfUpstreamChannelEntry 5 }
docsIfUpChannelTxTimingOffset OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A measure of the current round trip time at the CM, or the
maximum round trip time seen by the CMTS. Used for timing
of CM upstream transmissions to ensure synchronized
arrivals at the CMTS. Units are in terms of
(6.25 microseconds/64)."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 6.5."
::= { docsIfUpstreamChannelEntry 6 }
docsIfUpChannelRangingBackoffStart OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The initial random backoff window to use when retrying
Ranging Requests. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 6.4.4."
::= { docsIfUpstreamChannelEntry 7 }
docsIfUpChannelRangingBackoffEnd OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The final random backoff window to use when retrying
Ranging Requests. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 6.4.4."
::= { docsIfUpstreamChannelEntry 8 }
docsIfUpChannelTxBackoffStart OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The initial random backoff window to use when retrying
transmissions. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 6.4.4."
::= { docsIfUpstreamChannelEntry 9 }
docsIfUpChannelTxBackoffEnd OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The final random backoff window to use when retrying
transmissions. Expressed as a power of 2. A value of 16
at the CMTS indicates that a proprietary adaptive retry
mechanism is to be used. See the associated conformance
object for write conditions and limitations."
REFERENCE
"DOCSIS Radio Frequency Interface Specification,
Section 6.4.4."
::= { docsIfUpstreamChannelEntry 10 }
-- The following table describes the attributes of each class of
-- service. The entries in this table are referenced from the
-- docsIfServiceEntries. They exist as a separate table in order to
-- reduce redundant information in docsIfServiceTable.
--
-- This table is implemented at both the CM and the CMTS.
-- The CM need only maintain entries for the classes of service
-- referenced by its docsIfServiceTable.
--
docsIfQosProfileTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIfQosProfileEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Describes the attributes for each class of service."
::= { docsIfBaseObjects 3 }
docsIfQosProfileEntry OBJECT-TYPE
SYNTAX DocsIfQosProfileEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Describes the attributes for a single class of service.
If implemented as read-create in the Cable Modem
Termination System, creation of entries in this table is
controlled by the value of docsIfCmtsQosProfilePermissions.
If implemented as read-only, entries are created based
on information in REG-REQ MAC messages received from
Cable Modems (Cable Modem Termination System
implementation), or based on information extracted from
the TFTP option file (Cable Modem implementation).
In the Cable Modem Termination system, read-only entries
are removed if no longer referenced by
docsIfCmtsServiceTable.
An entry in this table must not be removed while it is
referenced by an entry in docsIfCmServiceTable (Cable Modem)
or docsIfCmtsServiceTable (Cable Modem Termination System).
An entry in this table should not be changeable while
it is referenced by an entry in docsIfCmtsServiceTable.
If this table is created automatically, there should only
be a single entry for each Class of Service. Multiple
entries with the same Class of Service parameters are not
recommended."
INDEX { docsIfQosProfIndex }
::= { docsIfQosProfileTable 1 }
DocsIfQosProfileEntry ::= SEQUENCE {
docsIfQosProfIndex Integer32,
docsIfQosProfPriority Integer32,
docsIfQosProfMaxUpBandwidth Integer32,
docsIfQosProfGuarUpBandwidth Integer32,
docsIfQosProfMaxDownBandwidth Integer32,
docsIfQosProfMaxTxBurst Integer32,
docsIfQosProfBaselinePrivacy TruthValue,
docsIfQosProfStatus RowStatus
}
docsIfQosProfIndex OBJECT-TYPE
SYNTAX Integer32 (1..16383)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index value which uniquely identifies an entry
in the docsIfQosProfileTable."
::= { docsIfQosProfileEntry 1 }
docsIfQosProfPriority OBJECT-TYPE
SYNTAX Integer32 (0..7)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"A relative priority assigned to this service when
allocating bandwidth. Zero indicates lowest priority;
and seven indicates highest priority.
Interpretation of priority is device-specific.
MUST NOT be changed while this row is active."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 2 }
docsIfQosProfMaxUpBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The maximum upstream bandwidth, in bits per second,
allowed for a service with this service class.
Zero if there is no restriction of upstream bandwidth.
MUST NOT be changed while this row is active."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 3 }
docsIfQosProfGuarUpBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Minimum guaranteed upstream bandwidth, in bits per second,
allowed for a service with this service class.
MUST NOT be changed while this row is active."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 4 }
docsIfQosProfMaxDownBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The maximum downstream bandwidth, in bits per second,
allowed for a service with this service class.
Zero if there is no restriction of downstream bandwidth.
MUST NOT be changed while this row is active."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 5 }
docsIfQosProfMaxTxBurst OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The maximum number of mini-slots that may be requested
for a single upstream transmission.
A value of zero means there is no limit.
MUST NOT be changed while this row is active."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 6 }
docsIfQosProfBaselinePrivacy OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Indicates whether Baseline Privacy is enabled for this
service class.
MUST NOT be changed while this row is active."
DEFVAL { false }
::= { docsIfQosProfileEntry 7 }
docsIfQosProfStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This is object is to used to create or delete rows in
this table. This object MUST NOT be changed from active
while the row is referenced by the any entry in either
docsIfCmServiceTable (on the CM), or the
docsIfCmtsServiceTable (on the CMTS)."
::= { docsIfQosProfileEntry 8 }
docsIfSignalQualityTable OBJECT-TYPE
SYNTAX SEQUENCE OF DocsIfSignalQualityEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"At the CM, describes the PHY signal quality of downstream
channels. At the CMTS, describes the PHY signal quality of
upstream channels. At the CMTS, this table may exclude
contention intervals."
::= { docsIfBaseObjects 4 }
docsIfSignalQualityEntry OBJECT-TYPE
SYNTAX DocsIfSignalQualityEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"At the CM, describes the PHY characteristics of a
downstream channel. At the CMTS, describes the PHY signal
quality of an upstream channel.
An entry in this table exists for each ifEntry with an
ifType of docsCableUpstream(129) for Cable Modem Termination
Systems and docsCableDownstream(128) for Cable Modems."
INDEX { ifIndex }
::= { docsIfSignalQualityTable 1 }
DocsIfSignalQualityEntry ::= SEQUENCE {
docsIfSigQIncludesContention TruthValue,
docsIfSigQUnerroreds Counter32,
docsIfSigQCorrecteds Counter32,
docsIfSigQUncorrectables Counter32,
docsIfSigQSignalNoise TenthdB,
docsIfSigQMicroreflections Integer32,
docsIfSigQEqualizationData OCTET STRING
}
docsIfSigQIncludesContention OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"true(1) if this CMTS includes contention intervals in
the counters in this table. Always false(2) for CMs."
REFERENCE
"DOCSIS Radio Frequency Interface specification,
Section 6.4.4"
::= { docsIfSignalQualityEntry 1 }