[RFCs/IDs] [Plain Text] [Tracker] [WG] [Email] [Diff1] [Diff2] [Nits]
Versions: 00 01 02 03 04 05 06 07 08 09 10 11
12 13 14 RFC 4546
IP over Cable Data Network Working D. Raftus
Group ATI Technologies Inc.
Internet-Draft E. Cardona
Expires: April 26, 2006 CableLabs
October 23, 2005
Radio Frequency (RF) Interface Management Information Base for DOCSIS
2.0 compliant RF interfaces
draft-ietf-ipcdn-docs-rfmibv2-14
Status of this Memo
By submitting this Internet-Draft, each author represents that any
applicable patent or other IPR claims of which he or she is aware
have been or will be disclosed, and any of which he or she becomes
aware will be disclosed, in accordance with Section 6 of BCP 79.
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.
This Internet-Draft will expire on April 26, 2006.
Copyright Notice
Copyright (C) The Internet Society (2005).
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 set of managed objects for SNMP-based
management of the Radio Frequency (RF) interfaces for systems
compliant with the Data Over Cable Service Interface Specifications
(DOCSIS).
Raftus & Cardona Expires April 26, 2006 [Page 1]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
This document revises and obsoletes RFC 2670. Please see section 6
for a description of the changes from RFC 2670.
Note to RFC Editor (Remove this paragraph prior to publication) 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 . . . . . . . . . 4
2. Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.1. Baseline Privacy . . . . . . . . . . . . . . . . . . . . 5
2.2. CATV . . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.3. Channel . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.4. CM or Cable Modem . . . . . . . . . . . . . . . . . . . . 5
2.5. CMTS or Cable Modem Termination System . . . . . . . . . 5
2.6. Codeword . . . . . . . . . . . . . . . . . . . . . . . . 6
2.7. Data Packet . . . . . . . . . . . . . . . . . . . . . . . 6
2.8. dBmV . . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.9. DOCSIS . . . . . . . . . . . . . . . . . . . . . . . . . 6
2.9.1. DOCSIS 1.0 . . . . . . . . . . . . . . . . . . . . . 6
2.9.2. DOCSIS 1.1 . . . . . . . . . . . . . . . . . . . . . 6
2.9.3. DOCSIS 2.0 . . . . . . . . . . . . . . . . . . . . . 6
2.10. Downstream . . . . . . . . . . . . . . . . . . . . . . . 7
2.11. Euro-DOCSIS . . . . . . . . . . . . . . . . . . . . . . . 7
2.12. Head-end . . . . . . . . . . . . . . . . . . . . . . . . 7
2.13. MAC Packet . . . . . . . . . . . . . . . . . . . . . . . 7
2.14. MCNS . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.15. Mini-slot . . . . . . . . . . . . . . . . . . . . . . . . 7
2.16. QPSK Quadrature Phase Shift Keying . . . . . . . . . . 7
2.17. QAM Quadrature Amplitude Modulation . . . . . . . . . . 7
2.18. RF . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
2.19. Symbol-times . . . . . . . . . . . . . . . . . . . . . . 7
2.20. Upstream . . . . . . . . . . . . . . . . . . . . . . . . 8
3. Overview . . . . . . . . . . . . . . . . . . . . . . . . . . 9
3.1. Textual Conventions . . . . . . . . . . . . . . . . . . . 9
3.1.1. Textual Conventions in RFC 2670 . . . . . . . . . . . 9
3.1.2. Textual Conventions in RFC XXXX . . . . . . . . . . . 9
3.2. Structure of the MIB . . . . . . . . . . . . . . . . . . 9
3.2.1. docsIfBaseObjects . . . . . . . . . . . . . . . . . . 10
3.2.2. docsIfCmObjects . . . . . . . . . . . . . . . . . . . 10
3.2.3. docsIfCmtsObjects . . . . . . . . . . . . . . . . . . 10
3.2.4. Relationship to the Interfaces MIB module . . . . . . 11
3.2.5. Offline Upstream Parameters Handling . . . . . . . . 25
4. Definitions . . . . . . . . . . . . . . . . . . . . . . . . . 27
Raftus & Cardona Expires April 26, 2006 [Page 2]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
5. Revision History . . . . . . . . . . . . . . . . . . . . . . 137
5.1. Scope . . . . . . . . . . . . . . . . . . . . . . . . . . 137
5.2. Extension . . . . . . . . . . . . . . . . . . . . . . . . 137
5.3. Changes from RFC 2670 . . . . . . . . . . . . . . . . . . 137
6. Security Considerations . . . . . . . . . . . . . . . . . . . 140
7. IANA considerations . . . . . . . . . . . . . . . . . . . . . 142
8. Management Interoperability of DOCSIS 1.0, 1.1 and 2.0 . . . 143
9. References . . . . . . . . . . . . . . . . . . . . . . . . . 144
9.1. Normative References . . . . . . . . . . . . . . . . . . 144
9.2. Informative References . . . . . . . . . . . . . . . . . 145
Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . 147
Intellectual Property and Copyright Statements . . . . . . . . . 148
Raftus & Cardona Expires April 26, 2006 [Page 3]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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 [ Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005 Standard Management Framework"'>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].
Raftus & Cardona Expires April 26, 2006 [Page 4]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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. Baseline Privacy
Security interface specification designed for DOCSIS compliant cable
data systems that ensures device authentication data confidentiality
in the CATV plant. See [BPI] and [BPIPLUS].
2.2. 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.3. 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 downstream 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.
For European cable systems, upstream channels vary by country. The
upper edge of upstream channel allocations vary between 25 MHz to 65
MHz, and the lower edge of downstream channel allocations vary
between 47 MHz and 87.5 MHz. The typical broadcast channel width in
Europe is 8MHz. The actual parameters are of concern to systems
deploying Euro-DOCSIS technology.
The downstream channels conform to the requirements of ITU-T
Recommendation J.83 [ITU-T_J.83]
2.4. CM or Cable Modem
A CM acts as a "slave" station in a DOCSIS compliant cable data
system.
2.5. CMTS or 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
Raftus & Cardona Expires April 26, 2006 [Page 5]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
controls the scheduling of upstream transmissions by its associated
CMs.
2.6. Codeword
A characteristic of the Forward Error Correction scheme used above
the RF media layer.
See "Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812"
2.7. Data Packet
The payload portion of the MAC Packet.
2.8. dBmV
A measure of RF signal voltage amplitude, whose power level is
determined by the characteristic impedance. A zero dB signal power
is equivalent to 48.75 dBmV signal amplitude in a 75 Ohm system.
2.9. DOCSIS
"Data Over Cable Service Interface Specification". A term referring
to the ITU-T J112 [ITU-T_J.112] Annex B standard for cable modem
systems.
2.9.1. DOCSIS 1.0
Cable modem systems CM/CMTS compliant to requirements in [RFI1.0]. A
common reference to DOCSIS 1.0 in this document is the upstream
channel queuing mechanism known as Class of Service (COS).
2.9.2. DOCSIS 1.1
Cable modem systems CM/CMTS compliant to requirements in [ITU-
T_J.112]. DOCSIS 1.1 references in this document are in part
associated with the upstream and downstream Quality of Service (QOS).
The term DOCSIS 1.x is used in this document to refer both DOCSIS 1.0
and DOCSIS 1.1.
2.9.3. DOCSIS 2.0
Cable modem systems CM/CMTS compliant to requirements in [ITU-
T_J.122]. DOCSIS 2.0 corresponds to the second generation of radio-
frequency interface specifications of DOCSIS.
Raftus & Cardona Expires April 26, 2006 [Page 6]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
2.10. Downstream
The direction from the head-end towards the subscriber.
2.11. Euro-DOCSIS
Cable modem systems CM/CMTS conforming to the European spectrum
lineup and compliant to requirements of Annex F in [ITU-T_J.122].
2.12. Head-end
The origination point in most cable systems of the subscriber video
signals. Generally also the location of the CMTS equipment.
2.13. MAC Packet
A DOCSIS PDU.
2.14. MCNS
"Multimedia Cable Network System". Generally replaced in usage by
DOCSIS.
2.15. Mini-slot
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. See [ITU-
T_J.122]
2.16. QPSK Quadrature Phase Shift Keying
A particular modulation scheme on an RF medium. See [Proakis00].
2.17. QAM Quadrature Amplitude Modulation
A particular modulation scheme on RF medium. Usually expressed with
a number indicating the size of the modulation constellation (e.g. 16
QAM). See [Proakis00].
2.18. RF
Radio Frequency.
2.19. Symbol-times
A characteristic of the RF modulation scheme. See [ITU-T_J.122].
Raftus & Cardona Expires April 26, 2006 [Page 7]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
2.20. Upstream
The direction from the subscriber towards the head-end.
Raftus & Cardona Expires April 26, 2006 [Page 8]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
3. Overview
This MIB module provides a set of objects required for the management
of 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 [ITU-T_J.122].
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. Textual Conventions
This MIB module define new textual conventions for CMs and CMTSs
indication of DOCSIS 2.0 RFI capabilities, configuration, usage and
backward compatible modes of operation defined in [RFI2.0] With the
same purpose, there are some textual conventions that represent
capabilities and modes of operation of [RFI1.1] that are not covered
by RFC 2670, and are managed proprietarily in DOCSIS OSSI 1.1
specification [OSSI1.1].
3.1.1. Textual Conventions in RFC 2670
RFC 2670 defined two textual conventions: TenthdBmV and TenthdB which
are power measurement representations.
3.1.2. Textual Conventions in RFC XXXX
Note to RFC editor: RFC editor to replace XXXX with this RFC number,
then, delete note.
This MIB module defines the textual convention DocsisUpstreamType to
represent the DOCSIS 1.0 [RFI1.0] and DOCSIS 2.0 [RFI2.0] upstream
burst modulation profiles types.
This MIB module defines the textual conventions DocsisVersion and
DocsisQosVersion to represent the DOCSIS 1.0 [RFI1.0] and DOCSIS 1.1
[RFI1.1] COS/QOS capabilities and modes of operation.
3.2. Structure of the MIB
This MIB module is structured as three groups:
o Management information pertinent to both Cable Modem (CM) and
Cable Modem Termination System (CMTS) (docsIfBaseObjects).
o Management information pertinent to Cable Modem only
(docsIfCmObjects).
Raftus & Cardona Expires April 26, 2006 [Page 9]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
o Management information pertinent to Cable Modem Termination System
only (docsIfCmtsObjects).
Tables within each of these groups cover diferent functions - e.g.
upstream queue services, 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.2.1. docsIfBaseObjects
docsIfDownstreamChannelTable - This table describes the existing
downstream channels for a CMTS and the received downstream channel
for a CM.
docsIfUpstreamChannelTable - This table describes the existing
upstream channels for a CMTS and the current upstream transmission
channel for a CM.
docsIfQosProfileTable - This table describes the valid Quality of
Service profiles for the cable data system.
docsIfSignalQualityTable - This table is used to monitor RF signal
quality characteristics of received signals.
docsIfDocsisBaseCapability - This object is used to indicate the
highest level of DOCSIS version a cable device can support.
3.2.2. docsIfCmObjects
docsIfCmMacTable - This table is used to monitor the DOCSIS MAC
interface and can be considered an extension to the ifEntry.
docsIfCmStatusTable - This table maintains a number of status objects
and counters for cable modems. There is a comparable table at the
CMTS, docsIfCmtsCmStatusTable, which maintains similar counters from
the CMTS point of view.
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.2.3. docsIfCmtsObjects
docsIfCmtsMacTable - Describes the attributes of each CMTS MAC
Raftus & Cardona Expires April 26, 2006 [Page 10]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
interface.
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 (i.e. ranging, registered, and/or previously online)
cable modems on the system serviced by this CMTS.
docsIfCmtsServiceTable - 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.
docsIfCmtsChannelUtilizationTable - This table provides statistical
load usage data for attached upstream and downstream physical
channels.
docsIfCmtsDownChannelCounterTable - This table provides statistical
data for attached downstream channels, appropriate as input for load
usage calculations.
docsIfCmtsUpChannelCounterTable - This table provides statistical
data for attached upstream channels, appropriate as input for load
usage calculations.
3.2.4. Relationship to the Interfaces MIB module
This section clarifies the relationship of this MIB module to the
Interfaces MIB [RFC2863]. Several areas of correlation are addressed
in the following subsections. The implementer is referred to the
Interfaces MIB document in order to understand the general intent of
these areas.
3.2.4.1. Layering Model
An instance of ifEntry exists for each RF downstream interface, for
each RF upstream interface, for each upstream logical Channel and for
each RF MAC layer.
The ifStackTable [RFC2863] MUST be implemented to identify the
relationships among sub-interfaces.
Raftus & Cardona Expires April 26, 2006 [Page 11]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
The following example illustrates a CMTS MAC interface with one
downstream and two upstream interfaces.
| <== to network layer
+------------------ --+-------------------------------+
| RF MAC |
+--+------------------+------------------------+------+
| | |
+-------+-----+ +------+------+ +------+------+
| Downstream1 | | Upstream1 | | Upstream2 |
| | | | | |
+-------------+ ++-----------++ ++-----------++
| | | |
+----+----+ +----+----+ +----+----+ +----+----+
| Ch-1 | | Ch-2 | | Ch-1 | | Ch-2 |
|(A/TDMA) | |(S-CDMA) | |(A/TDMA) | |(S-CDMA) |
+---------+ +---------+ +---------+ +---------+
Figure 1
As can be seen from this example, the RF MAC interface is layered on
top of the downstream and upstream interfaces, and the RF upstream
interface is layered on top of an upstream logical channel.
In this example, the assignment of index values could be as follows:
ifIndex ifType Description
2 docsCableMaclayer(127) CATV MAC Layer
3 docsCableDownstream(128) CATV Downstream interface
4 docsCableUpstream(129) CATV Upstream interface
5 docsCableUpstream(129) CATV Upstream interface
6 docsCableUpstreamChannel(205) CATV Upstream Channel
7 docsCableUpstreamChannel(205) CATV Upstream Channel
8 docsCableUpstreamChannel(205) CATV Upstream Channel
9 docsCableUpstreamChannel(205) CATV Upstream Channel
Figure 2
The corresponding ifStack entries would then be:
Raftus & Cardona Expires April 26, 2006 [Page 12]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
| IfStackHigherLayer | ifStackLowerLayer |
| 0 | 2 |
| 2 | 3 |
| 2 | 4 |
| 2 | 5 |
| 4 | 6 |
| 4 | 7 |
| 5 | 8 |
| 5 | 9 |
| 3 | 0 |
| 6 | 0 |
| 7 | 0 |
| 8 | 0 |
| 9 | 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) management is outside the scope of
this document.
3.2.4.2. Virtual Circuits
This medium does not support virtual circuits and this area is not
applicable to this MIB module.
3.2.4.3. ifTestTable
The ifTestTable is optional for DOCSIS CM/CMTS implementations, but
is not specifically influenced by the RF MIB.
3.2.4.4. ifRcvAddressTable
The ifRcvAddressTable is optional for DOCSIS CM/CMTS implementations,
but is not specifically influenced by the RF MIB.
3.2.4.5. ifEntry
This section documents only the differences from the requirements
specified in the Interfaces MIB module. See that MIB module for
columns omitted from the descriptions below.
3.2.4.5.1. ifEntry for downstream interfaces
The ifEntry for downstream interfaces supports the
Raftus & Cardona Expires April 26, 2006 [Page 13]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifGeneralInformationGroup and the ifPacketGroup of the Interfaces MIB
module. 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.4.5.1.1. ifEntry for downstream interfaces in Cable Modem
Termination System
ifTable Comments
============== ===========================================
ifIndex Each CATV 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 is the raw bandwidth in bits/s
of this interface. This is the symbol rate
multiplied with the number of bits per symbol.
ifHighSpeed Return the speed of this downstream channel.
The returned value is the raw bandwidth in
megabits/s of this interface. This is the symbol
rate multiplied with the number of bits per
symbol.
ifPhysAddress Return the zero-length OCTET 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
ifHCInOctets Return zero.
ifInUcastPkts
ifHCInUcastPkts Return zero.
ifInMulticastPkts
ifHCInMulticastPkts
Return zero.
ifInBroadcastPkts
Raftus & Cardona Expires April 26, 2006 [Page 14]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifHCInBroadcastPkts
Return zero.
ifInDiscards Return zero.
ifInErrors Return zero.
ifInUnknownProtos Return zero.
ifOutOctets
ifHCOutOctets 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
ifHCOutUcastPkts The number of unicast packets transmitted on this
interface. This includes MAC packets as well as
data packets.
ifOutMulticastPkts
ifHCOutMulticastPkts
Return the number of multicast packets
transmitted on this interface.
This includes MAC packets as well as data
packets.
ifOutBroadcastPkts
ifHCOutBroadcastPkts
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.4.5.1.2. ifEntry for downstream interfaces in Cable Modem
ifTable Comments
============== ===========================================
ifIndex Each CATV Downstream interface is represented
by an ifEntry.
Raftus & Cardona Expires April 26, 2006 [Page 15]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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.
ifHighSpeed Return the speed of this downstream channel.
The returned value the raw bandwidth in megabits/s
of this interface. This is the symbol rate
multiplied with the number of bits per symbol.
ifPhysAddress Return the zero-length OCTET 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
ifHCInOctets The total number of octets received on this
interface. This includes data packets as well as
MAC packets, and includes the length of the
MAC header.
ifInUcastPkts
ifHCInUcastPkts The number of unicast packets received on this
interface. This includes data packets as well as
MAC packets.
ifInMulticastPkts
ifHCInMulticastPkts
Return the number of multicast packets received
on this interface. This includes data packets as
well as MAC packets.
ifInBroadcastPkts
ifHCInBroadcastPkts
Return the number of broadcast packets received
on this interface. This includes data packets
as well as MAC packets.
ifInDiscards The total number of received packets that have
been discarded.
The possible reasons are: buffer shortage.
Raftus & Cardona Expires April 26, 2006 [Page 16]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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.
ifHCOutOctets
ifOutUcastPkts Return zero.
ifHCOutUcastPkts
ifOutMulticastPkts
ifHCOutMulticastPkts
Return zero.
ifOutBroadcastPkts
ifHCOutBroadcastPkts
Return zero.
ifOutDiscards Return zero.
ifOutErrors Return zero.
ifPromiscuousMode Refer to the Interfaces MIB.
3.2.4.5.2. ifEntry for upstream interfaces
Each supported interface of the type docsCableUpstream(129) must have
a corresponding ifEntry. 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.4.5.2.1. ifEntry for upstream interfaces in Cable Modem Termination
System
ifTable Comments
============== ===========================================
ifIndex Each RF Cable Upstream interface is represented
by an ifEntry.
ifType The IANA value of docsCableUpstream (129).
Raftus & Cardona Expires April 26, 2006 [Page 17]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifSpeed Return the maximum channel throughput (not payload
throughput) supported by the interface.
The maximum throughput is calculated for the case
where upstream channels are configured to maximize
interface throughput.
ifHighSpeed Return the maximum channel throughput (not payload
throughput) supported by the interface.
The maximum throughput is calculated for the case
where upstream channels are configured to maximize
interface throughput. Units for this object are
(1/1 000 000) * IfSpeed.
ifPhysAddress Return the zero-length OCTET STRING.
ifAdminStatus The administrative status of this interface.
ifOperStatus The current operational status of this interface.
This reflects the total status of all the channels
under this interface. So if at least one channel
has a physical connection this interface has
connection.
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. This is the maximum of all the ifMtu of
all the channels under this interface.
ifInOctets
ifHCInOctets The total (sum) number of octets received on all
the upstream channels under this
interface. This includes data packets as well as
MAC packets, and includes the length of the
MAC header.
ifInUcastPkts
ifHCInUcastPkts The total number of unicast packets received on
all the upstream channels under this
interface. This includes data packets as well as
MAC packets.
ifInMulticastPkts
ifHCInMulticastPkts
Return the total number of multicast packets
received on all the upstream channels under this
interface. This includes data packets as well as
MAC layer packets.
Raftus & Cardona Expires April 26, 2006 [Page 18]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifInBroadcastPkts
ifHCInBroadcastPkts
Return the total number of broadcast packets
received on all the upstream channels under this
interface. This includes data packets as well as
MAC packets.
ifInDiscards The total number of received packets, which have
been discarded on all the upstream channels under
this interface.
The possible reasons are: buffer shortage.
ifInErrors The total number of inbound packets that contained
errors preventing them from being deliverable
to higher layers.
Possible reasons are: MAC FCS error.
ifInUnknownProtos The total number of frames with an unknown packet
type. These are MAC frames with an unknown packet
type.
ifOutOctets Return zero.
ifHCOutOctets
ifOutUcastPkts Return zero.
ifHCOutOctets
ifOutMulticastPkts
ifHCOutMulticastPkts
Return zero.
ifOutBroadcastPkts
ifHCOutBroadcastPkts
Return zero.
ifOutDiscards Return zero.
ifOutErrors Return zero.
3.2.4.5.2.2. ifEntry for upstream interfaces in Cable Modem
ifTable Comments
============== ===========================================
ifIndex Each RF Cable Upstream interface is represented
by an ifEntry.
ifType The IANA value of docsCableUpstream (129).
Raftus & Cardona Expires April 26, 2006 [Page 19]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifSpeed Return the speed of this upstream interface.
The returned value is the raw bandwidth
in bits/s of this interface.
ifHighSpeed Return the speed of this upstream interface.
The returned value is the raw bandwidth
in megabits/s of this interface.
ifPhysAddress Return the zero-length OCTET 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.
ifHCInOctets
ifInUcastPkts Return zero.
ifHCInUcastPkts
ifInMulticastPkts
ifHCInMulticastPkts
Return zero.
ifInBroadcastPkts
ifHCInBroadcastPkts
Return zero.
ifInDiscards Return zero.
ifInErrors Return zero.
ifInUnknownProtos Return zero.
ifOutOctets
ifHCOutOctets 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
ifHCOutUcastPkts The number of unicast packets transmitted on this
interface. This includes MAC packets as well as
Raftus & Cardona Expires April 26, 2006 [Page 20]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
data packets.
ifOutMulticastPkts
ifHCOutMulticastPkts
Return the number of multicast packets transmitted
on this interface.
This includes MAC packets as well as data packets.
ifOutBroadcastPkts
ifHCOutBroadcastPkts
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.4.5.3. ifEntry for upstream channels
Each supported channel of the type docsCableUpstreamChannel(205) must
have a corresponding ifEntry.
The ifEntry for upstream channels 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. DOCSIS CMs are not
required to support logical upstream channels.
3.2.4.5.3.1. ifEntry for upstream Channels in Cable Modem Termination
System
ifTable Comments
============== ===========================================
ifIndex Each RF Cable Upstream channel is represented
by an ifEntry.
ifType The IANA value of docsCableUpstreamChannel (205).
ifSpeed Return the speed of this upstream channel.
The returned value is the raw bandwidth
in bits/s of this channel.
Raftus & Cardona Expires April 26, 2006 [Page 21]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifHighSpeed Return the speed of this upstream channel.
The returned value is the raw bandwidth
in megabits/s of this channel.
ifPhysAddress Return the zero-length OCTET 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 packets, and includes the length of the
MAC header.
ifInUcastPkts
ifHCInUcastPkts
The number of unicast packets received on this
interface. This includes data packets as well as
MAC packets.
ifInMulticastPkts
ifHCInMulticastPkts
Return the number of multicast packets received
on this interface. This includes data packets as
well as MAC layer packets.
ifInBroadcastPkts
ifHCInBroadcastPkts
Return the number of broadcast packets received
on this interface. This includes data packets
as well as MAC packets.
ifInDiscards The total number of received packets that 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.
Raftus & Cardona Expires April 26, 2006 [Page 22]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifOutOctets Return zero.
ifHCOutOctets
ifOutUcastPkts Return zero.
ifHCOutUcastPkts
ifOutMulticastPkts
ifHCOutMulticastPkts
Return zero.
ifOutBroadcastPkts
ifHCOutBroadcastPkts
Return zero.
ifOutDiscards Return zero.
ifOutErrors Return zero.
3.2.4.5.4. 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
ifHCInOctets The total number of data octets received on this
interface, targeted for upper protocol layers.
Raftus & Cardona Expires April 26, 2006 [Page 23]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
ifInUcastPkts
ifHCInUcastPkts The number of unicast packets received on this
interface, targeted for upper protocol layers.
ifInMulticastPkts
ifHCInMulticastPkts
Return the number of multicast packets received
on this interface, targeted for upper protocol
layers.
ifInBroadcastPkts
ifHCInBroadcastPkts
Return the number of broadcast packets received
on this interface, targeted for upper protocol
layers.
ifInDiscards The total number of received packets that 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
ifHCOutOctets protocol layers and transmitted on this interface.
ifOutUcastPkts
ifHCOutUcastPkts The number of unicast packets, received from upper
protocol layers and transmitted on this interface.
ifOutMulticastPkts
ifHCOutMulticastPkts
Return the number of multicast packets received
from upper protocol layers and transmitted on this
interface.
ifOutBroadcastPkts
ifHCOutBroadcastPkts
Return the number of broadcast packets received
from upper protocol layers and transmitted on this
interface.
Raftus & Cardona Expires April 26, 2006 [Page 24]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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.
3.2.5. Offline Upstream Parameters Handling
3.2.5.1. Overview
This section describes the offline configuration of the DOCSIS 2.0
upstream logical interface parameters. The purpose of this feature
is to guarantee that upstream logical interface parameters such as
modulation profile, channel yype, mini-slot Size and SCDMA attributes
are consistent prior to commit changes to an active upstream logical
interface. This mechanism can reduce possible downtime of the
upstream interface by minimizing SNMP SET operations to in-service
upstream interfaces. This mechanism is supported by CMTSs and is not
applicable to CMs.
3.2.5.2. Operation
This mechanism uses three upstream channel MIB objects defined for
DOCSIS 2.0 CMTS implementations:
docsIfUpChannelStatus - The RowStatus object for the creation of
temporary interfaces in the upstream interface table. A temporary
entry is used to modify, validate and commit upstream parameters of a
physical interface. In the CMTS, a physical upstream interfaces
refers to an upstream logical channel interface.
docsIfUpChannelCloneFrom - This MIB object has the function to
associate a physical interface with a temporary interface for the
purpose of updating the upstream parameters of the physical
interface.
docsIfUpChannelUpdate - This MIB object is the commit object that
transfer the validated upstream parameters from the temporary
interface to the physical interface.
The offline upstream parameters handling operation is as follows:
o A temporary interface is create with docsIfUpChannelStatus set to
'createAndWait', which turns the new create entry status to
'notReady'.
Raftus & Cardona Expires April 26, 2006 [Page 25]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
o A SET to docsIfUpChannelCloneFrom in the temporary interface to
the physical interface ifIndex value performs two actions:
* Create the association of the physical interface to the
temporary interface.
* Copy the original upstream parameters from the physical
interface to the temporary interface which turns its status to
'notInService'.
o The operator modifies the temporary interface parameters to the
desired values.
o At this point, a SET to 'active' to the RowStatus of the temporary
interface is successful if all parameters in the temporary
interface are valid for the associated physical interface;
otherwise, the temporary entry remains with status 'notInservice'
and the SET returns error 'commitFailed'.
o When the temporary interface status is 'active' a SET to
docsIfUpChannelUpdate to 'true' transfer the temporary interface
parameters values to the physical interface.
o After completion of the update operations, the temporary interface
is destroyed setting the docsIfUpChannelStatus to 'destroy'.
3.2.5.3. Relation of docsIfUpChannelStatus and ifMib
The main purpose of docsIfUpChannelStatus is the creation of
temporary interfaces for offline handling of the configuration of
physical interfaces; It does not manage the creation or control of
physical interfaces. To maintain a consistent operation and status
report of interfaces, this object does not manage the administrative
and operational status of physical interfaces.
Raftus & Cardona Expires April 26, 2006 [Page 26]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
4. Definitions
DOCS-IF-MIB DEFINITIONS ::= BEGIN
IMPORTS
MODULE-IDENTITY,
OBJECT-TYPE,
Unsigned32,
Integer32,
Counter32,
Counter64,
TimeTicks,
IpAddress,
transmission
FROM SNMPv2-SMI -- [RFC2578]
TEXTUAL-CONVENTION,
MacAddress,
RowStatus,
TruthValue,
TimeInterval,
TimeStamp,
StorageType
FROM SNMPv2-TC -- [RFC2579]
OBJECT-GROUP,
MODULE-COMPLIANCE
FROM SNMPv2-CONF -- [RFC2580]
ifIndex, InterfaceIndexOrZero
FROM IF-MIB -- [RFC2863]
InetAddressType,
InetAddress
FROM INET-ADDRESS-MIB -- [RFC4001]
IANAifType
FROM IANAifType-MIB; -- [IANA]
docsIfMib MODULE-IDENTITY
LAST-UPDATED "200510240000Z" -- October 24, 2005
ORGANIZATION "IETF IPCDN Working Group"
CONTACT-INFO
" David Raftus
Postal: ATI Technologies Inc.
340 Terry Fox Drive, Suite 202
Ottawa Ontario
Canada
Phone: +1 613 592 1052 ext.222
E-mail: david.raftus@ati.com
Eduardo Cardona
Raftus & Cardona Expires April 26, 2006 [Page 27]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
Postal:
Cable Television Laboratories, Inc.
858 Coal Creek Circle
Louisville, CO 80027-9750
U.S.A.
Tel: +1 303 661 9100
Fax: +1 303 661 9199
E-mail: e.cardona@cablelabs.com;mibs@cablelabs.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
"This is the MIB Module for DOCSIS 2.0 compliant Radio
Frequency (RF) interfaces in Cable Modem and
Cable Modem Termination System.
Copyright (C) The Internet Society (2005). This
version of this MIB module is part of RFC XXXX; see
the RFC itself for full legal notices."
REVISION "200510240000Z"
DESCRIPTION
"Revision of the IETF RF MIB module for DOCSIS 2.0.
This version published as RFC XXXX.
This MIB module revision includes among others:
Usage of ifType (205)for upstream Logical channels
Addition of downstream and upstream utilization
counters.
Additional Statistics per upstream interface.
Upstream channel offline configuration mechanism.
Added MIB support for new DOCSIS 2.0 modulation
attributes.
Euro-DOCSIS downstream interleve values.
Adjustments to RFC 2670 definitions based on
the MIB review guidelines from the IETF
Operations and Management Area (OPS)."
-- Note to RFC editor:
-- RFC editor to replace XXXX with this RFC number
-- Delete this note
REVISION "199908190000Z"
DESCRIPTION
"Initial Version, published as RFC 2670.
Modified by Mike StJohns to fix problems identified by
Raftus & Cardona Expires April 26, 2006 [Page 28]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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
DocsisVersion ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Indicates the DOCSIS Radio Frequency specification being
referenced.
'docsis10' indicates DOCSIS 1.0,
'docsis11' indicates DOCSIS 1.1
'docsis20' indicates DOCSIS 2.0"
SYNTAX INTEGER {
docsis10 (1),
docsis11 (2),
docsis20 (3)
}
DocsisQosVersion ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Indicates the referenced quality of service
level.
'docsis10 refers to DOCSIS 1.0 Class of
Service queuing services, 'docsis11' refers
Raftus & Cardona Expires April 26, 2006 [Page 29]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
to DOCSIS 1.1 Quality of Service."
SYNTAX INTEGER {
docsis10 (1),
docsis11 (2)
}
DocsisUpstreamType ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Indicates the DOCSIS Upstream Channel Type.
'unknown' means not information available.
'tdma' is related to TDMA, Time Division
Multiple Access, 'atdma' is related to A-TDMA,
Advanced Time Division Multiple Access,
'scdma' is related to S-CDMA, Synchronous
Code Division Multiple Access
'tdmaAndAtdma is related to simultaneous support of
TDMA and A-TDMA modes."
SYNTAX INTEGER {
unknown(0),
tdma(1),
atdma(2),
scdma(3),
tdmaAndAtdma(4)
}
DocsEqualizerData ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This data type represents the equalizer data
as measured at the receiver interface.
The format of the equalizer follows the structure of the
Transmit Equalization Adjust RNG-RSP TLV of DOCSIS RFI
v2.0 :
1 byte Main tap location 1..(n + m)
1 byte Number of forward taps per symbol
1 byte Number of forward taps: n
1 byte Number of reverse taps: m
Following are the equalizer coefficients:
First forward taps coefficients :
2 bytes F1 (real), 2 bytes F1 (imag)
...
2 bytes Fn (real), 2 bytes Fn (imag)
Then reverse taps coefficients :
2 bytes D1 (real), 2 bytes D1 (imag)
...
Raftus & Cardona Expires April 26, 2006 [Page 30]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
2 bytes Dm (real), 2 bytes Dm (imag)
The equalizers coefficient are considered signed 16 bit
integers in the range -32768 (0x8000) to 32767 (0x7FFF).
DOCSIS specifications requires up to a maximum of
64 equalizer taps (n + m), therefore, this object size
can get up 260 bytes (4 + 4x64).
The minimum object size (other than zero) for a t-spaced
Tap with a minimum of 8 symbols will be 36 (4 + 4x8)."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Figure 8-23."
SYNTAX OCTET STRING(SIZE (0 | 36..260))
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
-- and the Cable Modem Termination System. This table is
-- read only for the CM.
--
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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Tables 6-16, and 6-17."
::= { docsIfBaseObjects 1 }
Raftus & Cardona Expires April 26, 2006 [Page 31]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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,
docsIfDownChannelAnnex INTEGER,
docsIfDownChannelStorageType StorageType
}
docsIfDownChannelId OBJECT-TYPE
SYNTAX Integer32 (0..255)
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The Cable Modem Termination System 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 frequency. See the associated
compliance object for a description of valid frequencies
that may be written to this object."
Raftus & Cardona Expires April 26, 2006 [Page 32]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 6.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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Table 6-17."
::= { 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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Table 6-17."
::= { docsIfDownstreamChannelEntry 4 }
docsIfDownChannelInterleave OBJECT-TYPE
SYNTAX INTEGER {
Raftus & Cardona Expires April 26, 2006 [Page 33]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
unknown(1),
other(2),
taps8Increment16(3),
taps16Increment8(4),
taps32Increment4(5),
taps64Increment2(6),
taps128Increment1(7),
taps12increment17(8)
}
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
taps12increment17(8): protection 18/14 usec,
latency 0.43/0.32 msec
The value 'taps12increment17' is supported by EuroDOCSIS
cable systems only and the others by DOCSIS cable systems.
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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Table 6-15."
::= { docsIfDownstreamChannelEntry 5 }
docsIfDownChannelPower OBJECT-TYPE
SYNTAX TenthdBmV
UNITS "dBmV"
Raftus & Cardona Expires April 26, 2006 [Page 34]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"At the CMTS, the operational transmit power. At the CM,
the received power level.
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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Tables 6-16, 6-17."
::= { docsIfDownstreamChannelEntry 6 }
docsIfDownChannelAnnex OBJECT-TYPE
SYNTAX INTEGER {
unknown(1),
other(2),
annexA(3),
annexB(4),
annexC(5)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The value of this object indicates the conformance of
the implementation to important regional cable standards.
annexA : Annex A from ITU-T J.83 is used
(equivalent to EN 300 429)
annexB : Annex B from ITU-T J.83 is used.
annexC : Annex C from ITU-T J.83 is used."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Sections 6.3.1, and H.3.1."
::= { docsIfDownstreamChannelEntry 7 }
docsIfDownChannelStorageType OBJECT-TYPE
SYNTAX StorageType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The storage type for this conceptual row.
Entries with this object set to permanent(4)
do not require write operations for read-write
objects."
Raftus & Cardona Expires April 26, 2006 [Page 35]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
::= { docsIfDownstreamChannelEntry 8 }
--
-- 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."
::= { docsIfBaseObjects 2 }
docsIfUpstreamChannelEntry OBJECT-TYPE
SYNTAX DocsIfUpstreamChannelEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"List of attributes for a single upstream channel. For
DOCSIS 2.0 CMTSs, an entry in this table exists for
each ifEntry with an ifType of docsCableUpstreamChannel
(205).
For DOCSIS 1.x CM/CMTSs and DOCSIS 2.0 CMs, an entry in
this table exists for each ifEntry with an ifType of
docsCableUpstream (129).
For DOCSIS 2.0 CMTSs two classes of interfaces can be
defined for this table:
o Upstream Physical Interfaces: The traditional DOCSIS
1.x CMTS upstream interface ifType 129 and the DOCSIS
2.0 ifType 205 that are functional. In other words,
interfaces that represents upstream receivers within
an RF MAC interface.
Entries of physical interfaces are exposed to the
management interface with their corresponding
ifStack hierarchy and are not administratively
created by this table.
o Upstream Temporary Interfaces: A fictitious
interface created with the purpose of manipulating
the parameters of a physical interface parameters
offline, then the parameters are validated prior to
update the target physical interface.
Raftus & Cardona Expires April 26, 2006 [Page 36]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
In case of a reinitialization of the managed system,
Physial interfaces values persist while the temporary
interfaces are not recreated.
This mechanism helps to minimize service disruption
originated in situations where a group of interface
parameters values need to be inconsistent each other
in SET operations. Instead, a temporary buffer
(temporary interface) is provided to allow the CMTS
to validate the parameters offline."
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,
docsIfUpChannelScdmaActiveCodes Unsigned32,
docsIfUpChannelScdmaCodesPerSlot Integer32,
docsIfUpChannelScdmaFrameSize Unsigned32,
docsIfUpChannelScdmaHoppingSeed Unsigned32,
docsIfUpChannelType DocsisUpstreamType,
docsIfUpChannelCloneFrom InterfaceIndexOrZero,
docsIfUpChannelUpdate TruthValue,
docsIfUpChannelStatus RowStatus,
docsIfUpChannelPreEqEnable TruthValue
}
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-create
STATUS current
Raftus & Cardona Expires April 26, 2006 [Page 37]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
DESCRIPTION
"The center of the frequency band associated with this
upstream interface. 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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Table 4-2."
::= { docsIfUpstreamChannelEntry 2 }
docsIfUpChannelWidth OBJECT-TYPE
SYNTAX Integer32 (0..64000000)
UNITS "hertz"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The bandwidth of this upstream interface. This object
returns 0 if the interface width is undefined or unknown.
Minimum permitted interface width is 200,000 Hz currently.
See the associated conformance object for write conditions
and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Table 6-5."
::= { docsIfUpstreamChannelEntry 3 }
docsIfUpChannelModulationProfile OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-create
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 (IUCs)which together fully describe
the channel modulation. This object returns 0 if the
docsIfCmtsModulationTable entry does not exist or is empty.
See the associated conformance object for write conditions
and limitations.
Setting this object returns an 'inconsistentValue' error
error if the following conditions are not satisfied:
1. All the IUC entries in the selected modulation profile
MUST have the same value of docsIfCmtsModChannelType.
Raftus & Cardona Expires April 26, 2006 [Page 38]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
2. All of the Modulation parameters in the selected
modulation profile MUST be consistent with the other
parameters in this docsIfUpstreamChannelEntry."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Table 8-19."
::= { docsIfUpstreamChannelEntry 4 }
docsIfUpChannelSlotSize OBJECT-TYPE
SYNTAX Unsigned32
UNITS "ticks"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable to TDMA and ATDMA channel types only.
The number of 6.25 microsecond ticks in each upstream
mini-slot. Returns zero if the value is undefined, unknown
or in case of an SCDMA channel.
See the associated conformance object for write
conditions and limitations."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 8.1.2.4."
::= { docsIfUpstreamChannelEntry 5 }
docsIfUpChannelTxTimingOffset OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"At the CM, a measure of the current round trip time
obtained from the ranging offset (initial ranging offset +
ranging offset adjustments).
At the CMTS, the maximum of timing offset, among all the
CMs that are/were present on the channel, taking into
account all ( initial + periodic ) timing offset
corrections that were sent for each of the CMs. Generally,
these measurements are positive, but if the measurements
are negative, the value of this object is zero. Used for
timing of CM upstream transmissions to ensure synchronized
arrivals at the CMTS.
Units are one 64th fraction of 6.25 microseconds."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 6.2.19."
Raftus & Cardona Expires April 26, 2006 [Page 39]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
::= { docsIfUpstreamChannelEntry 6 }
docsIfUpChannelRangingBackoffStart OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Sections 8.3.4, and 9.4."
::= { docsIfUpstreamChannelEntry 7 }
docsIfUpChannelRangingBackoffEnd OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 8.3.4, and 9.4."
::= { docsIfUpstreamChannelEntry 8 }
docsIfUpChannelTxBackoffStart OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 8.3.4, and 9.4."
Raftus & Cardona Expires April 26, 2006 [Page 40]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
::= { docsIfUpstreamChannelEntry 9 }
docsIfUpChannelTxBackoffEnd OBJECT-TYPE
SYNTAX Integer32 (0..16)
MAX-ACCESS read-create
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
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 8.3.4, and 9.4."
::= { docsIfUpstreamChannelEntry 10 }
docsIfUpChannelScdmaActiveCodes OBJECT-TYPE
SYNTAX Unsigned32 (0|64..66|68..70|72|74..78|80..82|84..88
|90..96|98..100|102|104..106|108
|110..112|114..126|128)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
Number of active codes. Returns zero for
Non-SCDMA channel types. Note that legal
values from 64..128 MUST be non-prime."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 6.2.11.2.1."
::= { docsIfUpstreamChannelEntry 11 }
docsIfUpChannelScdmaCodesPerSlot OBJECT-TYPE
SYNTAX Integer32(0 | 2..32)
UNITS "codesperMinislots"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
The number of SCDMA codes per mini-slot.
Returns zero if the value is undefined, unknown or in
case of a TDMA or ATDMA channel."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Raftus & Cardona Expires April 26, 2006 [Page 41]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
Section 6.2.11.2.1."
::= { docsIfUpstreamChannelEntry 12 }
docsIfUpChannelScdmaFrameSize OBJECT-TYPE
SYNTAX Unsigned32 (0..32)
UNITS "spreadIntervals"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
SCDMA Frame size in units of spreading intervals.
This value returns zero for non SCDMA Profiles."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 6.2.12."
::= { docsIfUpstreamChannelEntry 13 }
docsIfUpChannelScdmaHoppingSeed OBJECT-TYPE
SYNTAX Unsigned32 (0..32767)
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Applicable for SCDMA channel types only.
15 bit seed used for code hopping sequence initialization.
Returns zero for non-SCDMA channel types.
Setting this value to a value different than zero for
non-SCDMA channel types returns error 'wrongValue'."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 6.2.14.1."
::= { docsIfUpstreamChannelEntry 14 }
docsIfUpChannelType OBJECT-TYPE
SYNTAX DocsisUpstreamType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Reflects the Upstream channel type.
This object returns the value of docsIfCmtsModChannelType
for the modulation profile selected in
docsIfUpChannelModulationProfile for this row."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 6.2.1."
::= { docsIfUpstreamChannelEntry 15 }
Raftus & Cardona Expires April 26, 2006 [Page 42]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
docsIfUpChannelCloneFrom OBJECT-TYPE
SYNTAX InterfaceIndexOrZero
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object contains the ifIndex value of the physical
interface row entry whose parameters are to be adjusted.
Upon setting this object to the ifIndex value of a
physical interface, that interface objects values are
copied to this entry:
docsIfUpChannelFrequency,
docsIfUpChannelWidth,
docsIfUpChannelModulationProfile,
docsIfUpChannelSlotSize,
docsIfUpChannelRangingBackoffStart,
docsIfUpChannelRangingBackoffEnd,
docsIfUpChannelTxBackoffStart,
docsIfUpChannelTxBackoffEnd,
docsIfUpChannelScdmaActiveCodes,
docsIfUpChannelScdmaCodesPerSlot,
docsIfUpChannelScdmaFrameSize,
docsIfUpChannelScdmaHoppingSeed,
docsIfUpChannelType, and
docsIfUpChannelPreEqEnable
Setting this object to the value of a non-existent or
a temporary upstream interface returns error
'wrongValue'.
This object MUST contain a value of zero for physical
interfaces entries.
Setting this object in row entries that corresponds to
physical interfaces returns error 'wrongValue'."
::= { docsIfUpstreamChannelEntry 16 }
docsIfUpChannelUpdate OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"Used to perform the copy of adjusted parameters from the
temporary interface entry to the physical interface
indicated by the docsIfUpChannelCloneFrom object. The
transfer is initiated through an SNMP SET to 'true' of
this object.
A SET to 'true' fails and returns error 'commitFailed'
if docsIfUpChannelStatus value is 'notInService', which
means, the interface parameters values are not
compatible each other, or have not been validated yet.
Raftus & Cardona Expires April 26, 2006 [Page 43]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
Reading this object always returns 'false'."
::= { docsIfUpstreamChannelEntry 17 }
docsIfUpChannelStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object is only used for the creation of a temporary
upstream row with the purpose of updating the parameters
of a physical upstream channel entry.
The following restrictions apply to this object:
1. This object is not writable for physical interfaces.
2. Temporary interface entries are only created by SET
this object to createandWait(5).
3. ifAdminStatus from the Interface MIB RFC 2863 is used
to take a physical upstream channel offline, to be
consistent with DOCSIS 1.x operation indicated in
RFC 2670.
In addition,
o ifAdminStatus 'down' is reflected in this object
as 'notInService'.
o ifOperSatus 'down' while ifAdminStatus 'up' is
reflected in this object as 'notInservice'.
4. Temporary created rows MUST be set to 'active' with
the purpose of validate the upstream parameters
consistency prior to transfer the parameters to the
physical interface.
Below is a mandatory procedure for adjusting the values
of a physical interface :
1. Create a temporary interface entry through an SNMP SET
using 'createAndWait'. At this point, the RowStatus
reports 'notReady'.
The Manager entity uses an ifIndex value outside the
operational range of the physical interfaces for the
creation of a temporary interface.
2. Set the docsIfUpChannelCloneFrom object to the ifIndex
value of the physical row to update. Now
docsIfUpChannelStatus reports 'notInService'.
3. Change the upstream parameters to the desired values
into the temporary row.
4. Validate that all parameters are consistent by setting
docsIfUpChannelStatus to 'active'. A Failure to set the
RowStatus to 'active' returns error 'commitFailed' which
means the parameters are not compatible to be set to the
target physical interface.
Raftus & Cardona Expires April 26, 2006 [Page 44]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
5. With docsIfUpChannelStatus 'active'm trasfer the
parameters to the target physical interface by setting
the object docsIfUpChannelUpdate to 'true'.
6. Delete the temporary row by setting
docsIfUpChannelStatus to 'destroy'."
::= { docsIfUpstreamChannelEntry 18 }
docsIfUpChannelPreEqEnable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"At the CMTS, used to enable or disable pre-equalization on
the upstream channel represented by this table instance.
At the CM, this object is read-only and reflects the
status of pre-equalization as represented in the RNG-RSP.
Pre-equalization is considered enabled at the CM if a
RNG-RSP with pre-equalization data has been received at
least once since the last mac reinitialization."
DEFVAL {false}
::= { docsIfUpstreamChannelEntry 19 }
-- 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 docsIfCmServiceTable.
--
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.
Raftus & Cardona Expires April 26, 2006 [Page 45]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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 (for Cable Modem Termination System), or
based on information extracted from the TFTP option file
(for Cable Modem).
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, -- deprecated
docsIfQosProfBaselinePrivacy TruthValue,
docsIfQosProfStatus RowStatus,
docsIfQosProfMaxTransmitBurst Integer32,
docsIfQosProfStorageType StorageType
}
docsIfQosProfIndex OBJECT-TYPE
SYNTAX Integer32 (1..16383)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index value that uniquely identifies an entry
Raftus & Cardona Expires April 26, 2006 [Page 46]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Annex C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 2 }
docsIfQosProfMaxUpBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
UNITS "bits per second"
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."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Annex C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 3 }
docsIfQosProfGuarUpBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
UNITS "bits per second"
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."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Raftus & Cardona Expires April 26, 2006 [Page 47]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Annex C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 4 }
docsIfQosProfMaxDownBandwidth OBJECT-TYPE
SYNTAX Integer32 (0..100000000)
UNITS "bits per second"
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."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Annex C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 5 }
docsIfQosProfMaxTxBurst OBJECT-TYPE
SYNTAX Integer32 (0..255)
UNITS "mini-slots"
MAX-ACCESS read-create
STATUS deprecated
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.
This object has been deprecated and replaced by
docsIfQosProfMaxTransmitBurst, to fix a mismatch
of the units and value range with respect to the DOCSIS
Maximum Upstream Channel Transmit Burst Configuration
Setting."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 6 }
docsIfQosProfBaselinePrivacy OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
Raftus & Cardona Expires April 26, 2006 [Page 48]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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 }
docsIfQosProfMaxTransmitBurst OBJECT-TYPE
SYNTAX Integer32 (0..65535)
UNITS "bytes"
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"The maximum number of bytes that may be requested for a
single upstream transmission. A value of zero means there
is no limit. Note: This value does not include any
physical layer overhead.
MUST NOT be changed while this row is active."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Annex C.1.1.4."
DEFVAL { 0 }
::= { docsIfQosProfileEntry 9 }
docsIfQosProfStorageType OBJECT-TYPE
SYNTAX StorageType
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The storage type for this conceptual row.
Entries with this object set to permanent(4)
do not require write operations for writable
objects."
::= { docsIfQosProfileEntry 10 }
Raftus & Cardona Expires April 26, 2006 [Page 49]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
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 docsCableDownstream(128) for Cable Modem.
For DOCSIS 1.1 Cable Modem Termination System, an entry
exists for each ifEntry with an ifType of
docsCableUpstream (129).
For DOCSIS 2.0 Cable Modem Termination System, an entry
exists for each ifEntry with an ifType of
docsCableUpstreamChannel (205)."
INDEX { ifIndex }
::= { docsIfSignalQualityTable 1 }
DocsIfSignalQualityEntry ::= SEQUENCE {
docsIfSigQIncludesContention TruthValue,
docsIfSigQUnerroreds Counter32,
docsIfSigQCorrecteds Counter32,
docsIfSigQUncorrectables Counter32,
docsIfSigQSignalNoise TenthdB,
docsIfSigQMicroreflections Integer32,
docsIfSigQEqualizationData DocsEqualizerData,
docsIfSigQExtUnerroreds Counter64,
docsIfSigQExtCorrecteds Counter64,
docsIfSigQExtUncorrectables Counter64
}
docsIfSigQIncludesContention OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
Raftus & Cardona Expires April 26, 2006 [Page 50]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
"true(1) if this CMTS includes contention intervals in
the counters in this table. Always false(2) for CMs."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Section 9.4.1"
::= { docsIfSignalQualityEntry 1 }
docsIfSigQUnerroreds OBJECT-TYPE
SYNTAX Counter32
UNITS "codewords"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Codewords received on this channel without error.
This includes all codewords, whether or not they
were part of frames destined for this device.
Discontinuities in the value of this counter can occur
at reinitialization of the managed system, and at other
times as indicated by the value of
ifCounterDiscontinuityTime for the associated ifIndex."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Sections 6.2.4, and 6.3.6."
::= { docsIfSignalQualityEntry 2 }
docsIfSigQCorrecteds OBJECT-TYPE
SYNTAX Counter32
UNITS "codewords"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Codewords received on this channel with correctable
errors. This includes all codewords, whether or not
they were part of frames destined for this device.
Discontinuities in the value of this counter can occur
at reinitialization of the managed system, and at other
times as indicated by the value of
ifCounterDiscontinuityTime for the associated ifIndex."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Sections 6.2.4, and 6.3.6."
::= { docsIfSignalQualityEntry 3 }
docsIfSigQUncorrectables OBJECT-TYPE
SYNTAX Counter32
Raftus & Cardona Expires April 26, 2006 [Page 51]
Internet-Draft DOCSIS 2.0 Radio Frequency (RFI) MIB October 2005
UNITS "codewords"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Codewords received on this channel with uncorrectable
errors. This includes all codewords, whether or not
they were part of frames destined for this device.
Discontinuities in the value of this counter can occur
at reinitialization of the managed system, and at other
times as indicated by the value of
ifCounterDiscontinuityTime for the associated ifIndex."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv2.0-I09-050812,
Sections 6.2.4, and 6.3.6."
::= { docsIfSignalQualityEntry 4 }
docsIfSigQSignalNoise OBJECT-TYPE
SYNTAX TenthdB
UNITS "TenthdB"
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Signal/Noise ratio as perceived for this channel.
At the CM, describes the Signal/Noise of the downstream
channel. At the CMTS, describes the average Signal/Noise
of the upstream channel."
REFERENCE
"Data-Over-Cable Service Interface Specifications: Radio
Frequency Interface Specification SP-RFIv