IPCDN  Working Group                                   Michael Patrick
<draft-ietf-ipcdn-qos-mib-08.txt>                      William Murwin
                                                       Motorola BCS



             Data Over Cable System Interface Specification
                           Quality of Service
              Management Information Base (DOCSIS-QOS MIB)

                             March 1, 2003







Status of this Memo

   This document is an Internet-Draft and is in full conformance with
   all the provisions of Section 10 of RFC2026.  Internet-Drafts are
   working documents of the Internet Engineering Task Force (IETF), its
   Areas, and its Working Groups.  Note that other groups may also
   distribute working documents as Internet-Drafts.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as a "work in progress".

   The list of current Internet-Drafts can be accessed at
   http://www.ietf.org/ietf/1id-abstracts.txt

   The list of Internet-Draft Shadow Directories can be accessed at
   http://www.ietf.org/shadow.html.


   Copyright (c) The Internet Society 2003.  All Rights Reserved.


Abstract

   This document defines a basic set of managed objects for SNMP-based
   management of extended QOS features of Cable Modems (CMs) and Cable
   Modem Termination Systems (CMTSs) conforming to the Data over Cable
   System (DOCSIS) standard version 1.1 and 2.0.






Expires September 2003                              [Page 1]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



Table of Contents


       Status of this Memo...............................   1
       Abstract..........................................   1

   1.  Introduction......................................   3
       1.1  The Internet-Standard Management Framework...   3
       1.2  Glossary.....................................   3

   2.  Overview..........................................   5
       2.1  Textual Conventions..........................   5
       2.2  MIB  Organization............................   5
            2.2.1   docsQosPktClassTable.................   9
            2.2.2   docsQosParamSetTable.................   9
            2.2.2.1 Interoperation with DOCSIS 1.0.......  11
            2.2.3   docsQosServiceFlowTable..............  12
            2.2.4   docsQosServiceFlowStatsTable.........  13
            2.2.5   docsQosUpstreamStatsTable............  14
            2.2.6   docsQosDynamicServiceStatsTable......  14
            2.2.7   docsQosServiceFlowLogTable...........  14
            2.2.8   docsQosServiceClassTable.............  15
            2.2.9   docsQosServiceClassPolicyTable.......  15
            2.2.10  docsQosPHSTable......................  15
            2.2.11  docsQosCmtsMacToSrvFlowTable.........  16

   3.  Externally Administered Classification............  16

   4.  Definitions.......................................  20

   5.  Security Considerations...........................  78

   6.  Intellectual Property.............................  79

   7.  Acknowledgement...................................  80

   8.  Normative References..............................  80

   9.  Informative References............................  81

   10. Author's Address..................................  81

   11. Full Copyright Statement..........................  82











Expires September 2003                              [Page 2]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



1.  Introduction

   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.


1.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 [13].

   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 [1], STD 58, RFC 2579 [2] and STD 58, RFC 2580 [3].

1.2  Glossary



   Active QPS     Active Qos Parameter Set.  The set of QOS parameters
                  that describe the current level service provided to a
                  Service Flow.

   Active SF      Active Service Flow. An SF with a non-empty Active
                  QPS.

   Admitted QPS   Admitted Qos Parameter Set. The set of QOS parameters
                  that describe a level of service which the Service
                  Flow is not currently using, but which it is
                  guaranteed to receive upon the SF's request to make
                  the set Active.

   Admitted SF    A Service Flow with a non-empty Admitted QPS.

   CATV           Cable TV

   CM             Cable Modem, a modem connecting a subscriber's LAN the
                  CATF RF network. DOCSIS CMs operate as a MAC layer
                  bridge between the home LAN and the RF network.

   CMTS           Cable Modem Termination System, the "head-end" device
                  providing connectivity between the RF network and the
                  Internet.




Expires September 2003                              [Page 3]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   Downstream     The direction from the head end towards the
                  subscriber.

   DSA            Dynamic Service Addition, a DOCSIS MAC management
                  message requesting the dynamic creation of a new
                  Service Flow.  New SFs are created with a three-
                  message exchange of a DSA-REQ, DSA-RSP, and DSA-ACK.

   DSC            Dynamic Service Change, a DOCSIS MAC management
                  message requesting a change to the attributes of a
                  Service Flow.  SFs are changed with a three-message
                  exchange of a DSC-REQ, DSC-RSP, and DSC-ACK.

   DSD            Dynamic Service Delete, a DOCSIS MAC management
                  message requesting the deletion of a Service Flow. SFs
                  are deleted with a two-message exchange of a DSD-REQ
                  and DSD-ACK.

   Head-end       The origination point in most cable systems of the
                  subsriber video signals. It is generally also the
                  location of the CMTS.

   PHS            Payload Header Suppression, a feature of DOCSIS 1.1
                  and 2.0 in which header bytes that are common in a
                  sequence of packets of a Service Flow are replaced by
                  a one-byte PHSI Index (PHSI) when transmitting the
                  packet on the RF network.

   Provisioned QPS A QOS Parameter Set describing an envelope of service
                  within which a Service Flow is authorized to request
                  admission.  All existing service flows must have a
                  non-empty Provisioned QPS, hence all SFs are
                  considered to be "Provisioned".

   SCN            Service Class Name -- a named set of QOS parameters.
                  A Service Flow may or may not be associated with a
                  single named Service Class.  A Service Class has as an
                  attribute a Qos Parameter Set that is used as the
                  default set of values for all Service Flows belonging
                  to the Service Class.

   SID            Service ID. A 16-bit integer assigned by the CMTS for
                  an Upstream Service Flow with a non-empty Active QOS
                  Parameter Set.

   SF             Service Flow. A unidirectional stream of packets
                  between the CM and CMTS. SFs are characterized as
                  upstream or downstream.  The SF is the fundamental
                  unit of service provided on a DOCSIS CATV network.





Expires September 2003                              [Page 4]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   SFID           Service Flow ID.  A 32-bit unsigned integer assigned
                  by the CMTS to each Service Flows

   Upstream       The direction from a subscriber CM to the head-end
                  CMTS.




2.  Overview

   This MIB provides a set of objects required for the management of
   DOCSIS 1.1 and 2.0 compliant Cable Modems (CM) and Cable Modem
   Termination Systems (CMTS). The specification is derived from the
   DOCSIS 1.1 Radio Frequency Interface specification [4]. Please note
   that the referenced DOCSIS standard only requires Cable Modems to
   process IPv4 customer traffic. Design choices in this MIB reflect
   those requirements.  Future versions of the DOCSIS standard are
   expected to require support for IPv6 as well.

   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 [7].


2.1  Textual Conventions

   The textual convention "DocsRfMacIfDirection" is defined to indicate
   the direction of a packet classifier relative to an interface. It
   takes the values of either downstream(1) or upstream(2).

   The textual convention "DocsBitRate" corresponds to the bits per
   second as defined for QOS Parameter Sets in DOCSIS 1.1 and 2.0. This
   definition includes all bits of the Ethernet MAC frame as transmitted
   on the RF network, starting with the Destination Address and ending
   with the Ethernet FCS. It does NOT includes bits in the DOCSIS MAC
   header.





2.2  MIB Organization


   The structure of the MIB is summarized below:








Expires September 2003                              [Page 5]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   docsQosMIB
     docsQosMIBObjects
       docsQosPktClassTable
         docsQosPktClassEntry
           docsQosPktClassId
           docsQosPktClassDirection
           docsQosPktClassPriority
           docsQosPktClassIpTosLow
           docsQosPktClassIpTosHigh
           docsQosPktClassIpTosMask
           docsQosPktClassIpProtocol
           docsQosPktClassInetAddressType
           docsQosPktClassInetSourceAddr
           docsQosPktClassInetSourceMask
           docsQosPktClassInetDestAddr
           docsQosPktClassInetDestMask
           docsQosPktClassSourcePortStart
           docsQosPktClassSourcePortEnd
           docsQosPktClassDestPortStart
           docsQosPktClassDestPortEnd
           docsQosPktClassDestMacAddr
           docsQosPktClassDestMacMask
           docsQosPktClassSourceMacAddr
           docsQosPktClassEnetProtocolType
           docsQosPktClassEnetProtocol
           docsQosPktClassUserPriLow
           docsQosPktClassUserPriHigh
           docsQosPktClassVlanId
           docsQosPktClassStateActive
           docsQosPktClassPkts
           docsQosPktClassBitMap
       docsQosParamSetTable
         docsQosParamSetEntry
           docsQosParamSetServiceClassName
           docsQosParamSetPriority
           docsQosParamSetMaxTrafficRate
           docsQosParamSetMaxTrafficBurst
           docsQosParamSetMinReservedRate
           docsQosParamSetMinReservedPkt
           docsQosParamSetActiveTimeout
           docsQosParamSetAdmittedTimeout
           docsQosParamSetMaxConcatBurst
           docsQosParamSetSchedulingType
           docsQosParamSetNomPollInterval
           docsQosParamSetTolPollJitter
           docsQosParamSetUnsolicitGrantSize
           docsQosParamSetNomGrantInterval
           docsQosParamSetTolGrantJitter
           docsQosParamSetGrantsPerInterval
           docsQosParamSetTosAndMask
           docsQosParamSetTosOrMask



Expires September 2003                              [Page 6]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



           docsQosParamSetMaxLatency
           docsQosParamSetType
           docsQosParamSetRequestPolicyOct
           docsQosParamSetBitMap
       docsQosServiceFlowTable
         docsQosServiceFlowEntry
           docsQosServiceFlowId
           docsQosServiceFlowSID
           docsQosServiceFlowDirection
           docsQosServiceFlowPrimary
       docsQosServiceFlowStatsTable
         docsQosServiceFlowStatsEntry
           docsQosServiceFlowPkts
           docsQosServiceFlowOctets
           docsQosServiceFlowTimeCreated
           docsQosServiceFlowTimeActive
           docsQosServiceFlowPHSUnknowns
           docsQosServiceFlowPolicedDropPkts
           docsQosServiceFlowPolicedDelayPkts
       docsQosUpstreamStatsTable
         docsQosUpstreamStatsEntry
           docsQosSID
           docsQosUpstreamFragments
           docsQosUpstreamFragDiscards
           docsQosUpstreamConcatBursts
       docsQosDynamicServiceStatsTable
         docsQosDynamicServiceStatsEntry
           docsQosIfDirection
           docsQosDSAReqs
           docsQosDSARsps
           docsQosDSAAcks
           docsQosDSCReqs
           docsQosDSCRsps
           docsQosDSCAcks
           docsQosDSDReqs
           docsQosDSDRsps
           docsQosDynamicAdds
           docsQosDynamicAddFails
           docsQosDynamicChanges
           docsQosDynamicChangeFails
           docsQosDynamicDeletes
           docsQosDynamicDeleteFails
           docsQosDCCReqs
           docsQosDCCRsps
           docsQosDCCAcks
           docsQosDCCs
           docsQosDCCFails
       docsQosServiceFlowLogTable
         docsQosServiceFlowLogEntry
           docsQosServiceFlowLogIndex
           docsQosServiceFlowLogIfIndex



Expires September 2003                              [Page 7]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



           docsQosServiceFlowLogSFID
           docsQosServiceFlowLogCmMac
           docsQosServiceFlowLogPkts
           docsQosServiceFlowLogOctets
           docsQosServiceFlowLogTimeDeleted
           docsQosServiceFlowLogTimeCreated
           docsQosServiceFlowLogTimeActive
           docsQosServiceFlowLogDirection
           docsQosServiceFlowLogPrimary
           docsQosServiceFlowLogServiceClassName
           docsQosServiceFlowLogPolicedDropPkts
           docsQosServiceFlowLogPolicedDelayPkts
           docsQosServiceFlowLogControl
       docsQosServiceClassTable
         docsQosServiceClassEntry
           docsQosServiceClassName
           docsQosServiceClassStatus
           docsQosServiceClassMaxTrafficRate
           docsQosServiceClassMaxTrafficBurst
           docsQosServiceClassMinReservedRate
           docsQosServiceClassMinReservedPkt
           docsQosServiceClassMaxConcatBurst
           docsQosServiceClassNomPollInterval
           docsQosServiceClassTolPollJitter
           docsQosServiceClassUnsolicitGrantSize
           docsQosServiceClassNomGrantInterval
           docsQosServiceClassTolGrantJitter
           docsQosServiceClassGrantsPerInterval
           docsQosServiceClassMaxLatency
           docsQosServiceClassActiveTimeout
           docsQosServiceClassAdmittedTimeout
           docsQosServiceClassSchedulingType
           docsQosServiceClassRequestPolicy
           docsQosServiceClassTosAndMask
           docsQosServiceClassTosOrMask
           docsQosServiceClassDirection
           docsQosServiceClassStorageType
       docsQosServiceClassPolicyTable
         docsQosServiceClassPolicyEntry
           docsQosServiceClassPolicyIndex
           docsQosServiceClassPolicyName
           docsQosServiceClassPolicyRulePriority
           docsQosServiceClassPolicyStatus
           docsQosServiceClassPolicyStorageType
       docsQosPHSTable
         docsQosPHSEntry
           docsQosPHSField
           docsQosPHSMask
           docsQosPHSSize
           docsQosPHSVerify
           docsQosPHSIndex



Expires September 2003                              [Page 8]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



       docsQosCmtsMacToSrvFlowTable
         docsQosCmtsMacToSrvFlowEntry
           docsQosCmtsCmMac
           docsQosCmtsServiceFlowId
           docsQosCmtsIfIndex



   The MIB is organized as 11 tables. Most tables are implemented in
   both the CM and CMTS; the docsQosUpstreamStatsTable and
   docsQosServiceFlowLogTable are implemented on the CMTS only.


2.2.1  docsQosPktClassTable

   The docsQosPktClassTable reports the Service Flow Classifiers
   implemented by the managed device. The table is indexed by the tuple
   { ifIndex, docsQosServiceFlowId, docsQosPktClassId }.  The ifIndex
   corresponds to an CATV MAC interface.  Each CATV MAC interfaces has a
   set of Service Flows, identified with a docsQosServiceFlowId value
   that is unique for that interface. Each service flow may have a
   number of packet classifiers that map packets to the flow. The
   ClassifierId for the classifier is unique only within a particular
   service flow.

   The semantics of packet classification are provided in [4]. Briefly,
   the DOCSIS MAC interface calls for matching packets based on values
   within the 802.2 (LLC), 802.3, IP, and/or  UDP/TCP headers.  Packets
   which map more than one classifier are prioritized according to their
   docsQosPktClassPriority value. The docsQosServiceFlowId (an index
   object) indicates to which service flow the packet is classified.

   The docsQosPktClassTable is distinct from the docsDevIpFilterTable of
   [9] in that docsQosPktClassTable is intended only to reflect the
   state of the Service Flow Classifiers. Service Flow Classifiers may
   be created only via a CM configuration file or from the Dynamic
   Service Addition (DSA) messages.  For this reason,
   docsQosPktClassTable is read-only.

   The docsDevIpFilterTable is intended for external policy-based
   administration of packet classifiers.  See the section "Externally
   Administered Classification", below.


2.2.2  docsQosParamSetTable

   The docsQosParamSetTable reports the values of Qos Parameter Set as
   defined in Section C.2.2 of [4].

   In general, a Service Flow is associated with three different Qos
   Parameter Sets (QPSs): an "active" QPS, an "admitted" QPS, and a



Expires September 2003                              [Page 9]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   "provisioned" or "authorized" QPS.  The relationship of these three
   sets is represented below:





                         +---------------------+
                         | Provisioned         |
                         |                     |
                         |  +---------------+  |
                         |  |  Admitted     |  |
                         |  |               |  |
                         |  |  +---------+  |  |
                         |  |  |  Active |  |  |
                         |  |  |         |  |  |
                         |  |  +---------+  |  |
                         |  |               |  |
                         |  +---------------+  |
                         |                     |
                         +---------------------+

                       Figure 1: Qos Parameter Sets



   The Provisioned QPS describes the maximum service envelope for which
   the SF is authorized. The Admitted QPS is the set of services for
   which a service flow has requested admission to the DOCSIS RF
   network, but which is not yet active. The Admitted QPS is used during
   the two-phase process of IP Telephony service flow admission to admit
   the bandwidth for a bidirectional voice call when the far end is
   ringing.  Since ringing may occur for up to four minutes, this
   permits the bandwidth to be reserved but not actually consumed during
   this interval.  The Active QPS is the set of services actually being
   used by the Service Flow. The DOCSIS v1.1 specification [4] defines
   what it means for a QPS envelope to be "within" another.  In general,
   an inner QPS is considered to be "within" an outer QPS when all QOS
   parameters represent demands of equal or fewer resources of the
   network.

   In addition to their use as attributes of a Service Flow, a QPS is
   also an attribute of a Service Class.  A DOCSIS CM configuration file
   or DSA message may request the creation of a new SF and give only the
   Service Class Name. The CMTS "expands the macro" of a Service Class
   Name creation by populating the Provisioned, Admitted, and/or Active
   QPSs of the Service Flow with the QPS of the Service Class Name. All
   of the QPSs of a Service Flow must be expansions of the same Service
   Class, and in this case the SF is said to "belong" to the Service
   Class.  Changing the contents of a Service Class' QPS does not affect
   the QPS of any Service Flow earlier expanded from that Service Class



Expires September 2003                             [Page 10]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   name. Only the CMTS implements docsQosServiceClassTable.

   See [4] section 8 for a full description and the theory of operation
   of Docsis 1.1 QOS operation.



   The docsQosParamSetTable sets are indexed by { ifIndex,
   docsQosServiceFlowId, docsQosParamSetType}. ifIndex indicates a
   particular "DOCSIS MAC Domain". docsQosServiceFlowId uniquely
   identifies a service flow on that MAC domain.  The
   docsQosParamSetType indicates whether the row describes an active,
   admitted, or provisioned Qos Parameter Set.

   The docsQosParamSetTable is read-only, because it indicates the Qos
   Parameter Set contents as defined by DOCSIS signaling. The
   docsQosServiceClassTable is read-create to permit managers to define
   a template of Qos Parameters that can be referenced by DOCSIS modems
   when creating their Qos Parameter Sets.


2.2.2.1  Interoperation with DOCSIS 1.0

   The DOCSIS 1.0 DOCS-IF-MIB [10] specifies a docsIfQosProfileTable to
   describe the set of Class Of Service (COS) parameters associated with
   a COS "profile". The docsIfCmServiceTable, which contains one entry
   per SID, references this table with a  docsIfCmServiceQosProfile
   number.

   The DOCSIS 1.1 and 2.0 CM registration process allows a modem to
   register as operating either with DOCSIS 1.0, DOCSIS 1.1, or DOCSIS
   2.0 functionality. For ease of expression, we call a modem
   registering with DOCSIS 1.0 functionality a "DOCSIS 1.0 modem",
   regardless of the modem's capabilities.

   A CMTS or CM supporting both DOCSIS 1.0, DOCSIS 1.1, and DOCSIS 2.0
   implements both the tables of [10] and the tables of this MIB. The
   interoperation goal is that before modem registration, the DOCSIS 1.0
   MIB [10] applies. After registration, either the DOCSIS 1.0 or DOCSIS
   1.1/2.0 MIB applies, depending on the mode with which the modem
   registered. The specific interoperation rules are:


     1.  When a CM initially ranges, the CM implements a row in the
         DOCS-IF-MIB docsIfCmServiceTable and the CMTS implements a row
         in the DOCS-IF-MIB docsIfCmtsServiceTable corresponding to the
         default upstream Service ID  (SID) used for  pre-registration
         upstream traffic. For historical compatibility a row may be
         created for the docsIfQosProfileTable with default values,
         which may be referenced by the docsIfCmServiceTable entries.




Expires September 2003                             [Page 11]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



     2.  Both a CMTS and CM implementing this MIB MUST NOT implement
         docsQosParamSetTable or docsQosServiceFlowTable rows until
         after the CM registers with DOCSIS 1.1 or 2.0 modem operation.


     3.  When a modem registers with the CMTS as a "DOCSIS 1.1" or
         "DOCSIS 2.0" modem, any exclusively-referenced row in DOCS-IF-
         MIB docsQosProfileTable representing the modems upstream Qos
         profile for pre-registration traffic MUST be removed.
         Multiply-referenced rows may remain. The
         docsQosIfCmServiceQosProfile object in the CM's row of
         docsIfCmServiceTable MUST be set to zero. The
         docsIfCmServiceTable row for the DOCSIS 1.1 or DOCSIS 2.0 modem
         continues to exist, and the various statistic objects in that
         row are incremented. The CMTS should retain the
         docsIfCmtsServiceTable entry for the DOCSIS 1.1 or DOCSIS 2.0
         CM.


     4.  When a DOCSIS 1.1 or DOCSIS 2.0 modem registers, both the CMTS
         and CM represent all service flows described in the modem
         configuration file in docsQosParamSetTable and
         docsQosServiceFlowTable.


     5.  At the CMTS, the Docsis 1.0 MIB objects
         docsIfCmtsServiceInPackets and docsIfCmtsServiceInOctets for a
         SID assigned to a Docsis 1.1 or Docsis 2.0 modem count only the
         pre-registration packets/bytes of those modems.


     6.  DOCSIS 1.0 modems do not have entries in the DOCS-IETF-QOS-MIB.



2.2.3  docsQosServiceFlowTable

   The docsQosServiceFlowTable provides read-only information about all
   of the service flows known by the device. It is indexed by the
   combination of { ifIndex, dosQosServiceFlowId }, where ifIndex
   corresponds to a CATV MAC interface and docsQosServiceFlowId is the
   32- bit integer assigned by the CMTS controlling the MAC domain.  A
   CM typically has only a single CATV MAC interface, while a CMTS may
   have several. See  [10] for a description of the ifIndex numbering
   for DOCSIS devices.

   The table indicates whether a given SF is in the upstream or
   downstream direction, and whether it is the "primary" SF in that
   direction.  The primary SF carries traffic that is not otherwise
   classified to any other SF in that direction.




Expires September 2003                             [Page 12]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



2.2.4  docsQosServiceFlowStatsTable

   The docsQosServiceFlowStatsTable provides statistics for all
   currently existing SFs known by the managed device.  It provides
   basic packet and octet counters, as well as certain other SF-specific
   stats such as the time at which the flow was created and how many
   seconds it has been active.

   The table also provides objects which can be used to fine-tune
   admission control decisions, namely the number of packets dropped or
   delayed due to QOS policing decisions enforced by the managed device.

   The model of the service flows stats table is that there exists a
   service flow Classification function followed by a service flow
   maximum rate Policing function for packets transmitted onto the
   Docsis RF network, as depicted below


                                               +----------+
          +------------+  clsfy 1    -----+    | Per-SF   |     forwarded
    Pkts  |            |----------->      |    | Maximum  |---> for Docsis
    ----->|  Classify  |  clsfy 2     SF1 |--> | Rate     |     RF Network
          |  Function  |----------->      |    | Policing |     transmission
          |            |             -----+    | Function |
          |            |                       |          |----+
          |            |                       |          |    |
          |            |                       +----------+   Dropped
          +------------+                         |    ^
                                                 +----+  Delayed

   Packets intended for transmission onto the Docsis RF network
   (upstream or downstream) are first classified to a service flow by
   matching one of several possible classifiers associated with that
   service flow.  The docsQosPktClassPkts count includes the number of
   packets that match the classifier, regardless of the eventual
   disposition of the packet.

   DOCSIS requires that each service flow be policed to maintain a
   maximum rate of transmission. This is performed by either dropping or
   delaying a packet on that service flow.  The
   docsQosServiceFlowPolicedDropPkts object counts the number of service
   flow packets dropped by the policing function.  The
   docsQosServiceFlowPolicedDelayPkts counts the number of packet
   delayed but still forwarded.  The docsQosServiceFlowPkts object
   counts the total number of packets forwarded beyond the policing
   function intended for eventual transmission onto the DOCSIS RF
   network. Although packets may be latter dropped by other functions
   (e.g. a transmit queue overflow on a DOCSIS hardware transmitter),
   the docsQos MIB per service-flow counters are not affected in this
   case.




Expires September 2003                             [Page 13]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



2.2.5  docsQosUpstreamStatsTable

   This table provides statistics that are measured only at the CMTS in
   the upstream direction. These include a count of the number of
   fragmentation headers received, fragments discarded, and the number
   of concatenation headers received.


2.2.6  docsQosDynamicServiceStatsTable

   This table provides read-only stats on the operation of the Dynamic
   Service state machines as specified in section 9.4 of [4]. It
   provides a set of 14 counters *in each direction* for a Docsis MAC
   layer interface. That is, each Docsis MAC layer interface has one row
   for downstream stats, and a second row for upstream stats.

   Eight of the counters are DSx packet type counts, one counter for
   each of the eight DSx packet types. For example, the docsQosDSAReqs
   object in the upstream row at the CMTS counts the number of DSA-REQ
   messages received by the CMTS from that interface.  The
   docsQosDSAReqs object in the downstream row at the CMTS counts the
   number of DSA-REQ messages transmitted by the CMTS on that interface.

   The remaining six counters per (interface, direction) combination
   count the number of successful and unsuccessful *transactions* that
   were initiated on the interface and direction. For example, the
   upstream docsQosDynamicAdds on a CMTS is the number of successfully
   completed CM-initiated dynamic additions, because at the CMTS a CM-
   initiated DSA starts in the upstream direction.  The downstream
   docsQosDynamicAdds at a CMTS is the number of successful CMTS-
   initiated DSA transactions.

   Dynamic service transactions can fail for a number of reasons, as
   listed in the state machines of section 9.4. Rather than include
   still more counters for each different failure reason, they are
   grouped into a single count, e.g docsQosDynamicAddFails.  Again, this
   object exists in both directions, so that locally originated vs
   remotely originated transaction failures are counted separately.
   Further troubleshooting of transaction failures will require vendor-
   specific queries and operation.


2.2.7  docsQosServiceFlowLogTable

   This table contains a log of the Service Flows no longer existing in
   the docsQosServiceFlowTable. It is intended to be periodically polled
   by traffic monitoring and billing agents. It is implemented only at
   the CMTS.

   It contains a chronological log of SF session statistics, including a
   total count of packets and octets transferred on the SF.  It includes



Expires September 2003                             [Page 14]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   time stamps of the SF creation and deletion time, as well as its
   number of active seconds. The active second count is the count of
   seconds that the SF had a non-empty Active Qos Parameter Set, i.e. it
   was eligible to pass data.  For unicast SFs, it includes the CM MAC
   address associated with the flow for billing reference purposes.

   The maximum number of log records kept by a CMTS, and the duration
   that a log record is maintained in the table is vendor-specific.  An
   explicit control object is provided so that the monitoring
   application can explicitly delete records it has read.


2.2.8  docsQosServiceClassTable

   This table defines the Service Class Name and references a Qos
   Parameter Set for each Service Class defined in a CMTS.  It is
   indexed by the Service Class Name string itself.  The table is read-
   create on a CMTS, and is not implemented in a CM.  Each entry of the
   docsQosServiceClassTable should define a template for flows in a
   given direction (upstream or downstream). Some parameters of the
   docsQosServiceClassTable are specific to a particular direction, and
   so their values are not-applicable when used as a template for flows
   in the other direction.



2.2.9  docsQosServiceClassPolicyTable


   The docsQosServiceClassPolicyTable can be referenced by the
   docsDevFilterPolicyTable of [9] in order to have a "policy" that
   classifies packets to a named Service Class. This is one mechanism by
   which "external" entities (like an SNMP manager) may control the
   classification of packet for QOS purposes. Entries are indexed by a
   small integer docsQosServiceClassPolicyIndex.  They provide a Service
   Class Name and a Rule Priority.  A policy referencing a row of this
   table intends the packet to be forwarded on a Service Flow
   "belonging" to the named Service Class. See the section "Externally
   Administered Classification", below.

   This table is implemented on both the CM and CMTS, and is read-create
   on both.


2.2.10  docsQosPHSTable

   The Payload Header Suppression (PHS) feature of DOCSIS 1.1 and 2.0
   permits packets to replace the unchanging bytes of the Ethernet, IP,
   and UDP headers with a one-byte index when transmitting on the cable
   network.  This is especially useful for IP Telephony packets, where
   such suppression can result in almost twice the number of calls



Expires September 2003                             [Page 15]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   supported within the same upstream channel.

   Each entry of the table corresponds to a PHS Rule as described in
   section 8.4 of [4].  The rules are identified by their corresponding
   service flow ID and docsQosPktClassId. A PHS rule is associated with
   exactly one classifier.  The table is therefore indexed by the tuple
   { ifIndex, docsQosServiceFlowId, docsQosPktClassId}.

   This table is read-only, and MUST be implemented on both the CM and
   CMTS when PHS is supported.


2.2.11  docsQosCmtsMacToSrvFlowTable

   The docsQosCmtsMacToSrvFlowTable provides describes the mapping of CM
   mac addresses to the  Service Flow Ids that are uniquely identified
   with that CM.  External applications may collect statistics on all
   packets flowing through a CM by determining the SFID of all of its
   flows, and then collecting the statistics of packets and bytes for
   each flow.

   Downstream multicast service flows are not indicated in the
   docsQosCmtsMacToSrvFlowTable because they are not associated with
   only one CM.




3.  Externally Administered Classification

   Docsis 1.1 and 2.0 provides rich semantics for the classification of
   packets to service flows with it Service Flow Classifier table.
   Service Flow Classifiers may be created statically in the DOCSIS CM
   configuration file, or may be created dynamically with Dynamic
   Service Addition (DSA) and Dynamic Service Change (DSC) DOCSIS MAC
   messages.

   Several major issues arose with the concept of externally
   administered classification, i.e. should an external SNMP manager be
   permitted to create classification rows? One problem was the co-
   ordination of classifier IDs, since such an approach would require
   either separate classifier ID number spaces or objects to co-ordinate
   both internal and external classifier ID assignments.  A more serious
   problem, however, was the requirement that external creation of SF
   Classifiers would require "knowledge" of the individual Service Flow
   ID for service flows by external applications.  It was strongly felt
   by the committee that SFIDs should remain an internal Docsis object,
   and not be transmitted as part of protocol flows, e.g. for IP packet
   telephony signaling.  Docsis 1.1 introduced the concept of named
   Service Classes for ease of administration within a domain of CMs and
   CMTSs.  What was desired was to permit external classification of



Expires September 2003                             [Page 16]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   packets to a Service Class, not a particular Service Flow.

   The DOCSIS committee therefore decided to use the already-defined IP
   Packet Filter Table [9] for the external classification of packets
   for QOS purposes.  The docsDevIpPacketFilterTable defines similar
   packet matching criteria as docsQosPktClassTable, but it matches a
   packet to an arbitrary "policy set" instead of a particular Service
   Flow. One of the policies in the policy set then selects the Service
   Class of the SF on which to forward the packet.  The
   docsQosServiceClassPolicyTable of this MIB defines the Service Class
   Name to which a packet is classified.

   The interaction of external and internal packet classification is
   depicted below.








































Expires September 2003                             [Page 17]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003





              |
              |  Outbound Pkt
              V
          docsDevIpFilterTable------> docsDevFilterPolicyTable
              |                                |
              |                                V
              |                      docsQosServiceClassPolicyTable
              |                                |
              | Pkt                            | ServiceClassName,
              |                                | ServiceClassPolicyRulePriority
              V                                V
     +--------------------------------------------------------+
     |        |   DOCSIS MAC LAYER ENTITY      |              |
     |        |                                | Select any   |
     |        V                                | SFID Y in SCN|
     |    docsQosPktClassTable <---------------|              |
     |        |                                |              |
     |        | docsQosPktClassPriority,       |              |
     |        | SFID X                         |              |
     |        V                                V              |
     |      ----------------------------------------+         |
     |      | Select the SFID associated with the   |         |
     |      | higher of docsQosPktClassPriority or  |         |
     |      | docsQosServiceClassPolicyRulePriority |         |
     |      +---------------------------------------+         |
     |                             |                          |
     |                             V                          |
     |           |    |          |    |                       |
     |           |    |    ...   |    |  Service Flows        |
     |           +----+          +----+                       |
     |           SFID X          SFID Y                       |
     +--------------------------------------------------------+

          Figure 2: Docsis Packet Classification


   The processing of an outgoing packet proceeds as follows:

          1.  The packet is first checked for matches with rows of the
              docsDevIpFilterTable. If it matches, the matching row
              provides a docsDevFilterPolicyId integer.

          2.  The docsDevFilterPolicyId indexes into one (or more) rows
              of docsDevFilterPolicyTable. Each row provides an
              arbitrary RowPointer (docsDevFilterPolicyPtr),
              corresponding to a policy to be applied to the packet.

          3.  This MIB defines a docsQosServiceClassPolicyTable whose
              entries may be pointed to by docsDevFilterPolicyPtr in



Expires September 2003                             [Page 18]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



              order to administratively classify packets to a named
              DOCSIS Service Class.  The docsQosServiceClassPolicyEntry
              provides a Service Class Name (SCN) as
              docsQosServiceClassPolicyName and a classification rule
              priority as docsQosServiceClassPolicyRulePriority. These
              are submitted to the device's Docsis MAC Layer entity as a
              special form of the MAC_DATA.request primitive, as
              described in Section E.2.1 of [4].

          4.  The MAC Layer selects an SFID ("Y") of an active Service
              Flow belonging to the named class, choosing an SF
              arbitrarily if there is more than one.

          5.  The packet is then classified according to the
              docsQosPktClassTable, which may classify the packet to a
              different SFID "X".  Associated with the classifier is a
              docsQosPktClassPriority.

          6.  In the event of a conflict between the SCN-determined SFID
              and the classified SFID, the greater of
              docsQosPktClassPriority and
              docsQosServiceClassPolicyRulePriority determines which
              SFID is selected to forward the packet.

        A packet which does not match a docsQosServiceClassPolicyEntry
        is directly submitted to the Docsis MAC layer, where the
        docsQosPktClassTable selects the SID on which it is to be
        forwarded.

        By convention (in [4]), the "internal" docsQosPktClassPriority
        values should be in the range of 64-191, while the "external"
        priorities may be either in the range 192-255 to override the
        internal classification or the range 0-63 to be overridden by
        internal classification.

        This classification mechanism applies both upstream from the CM
        and downstream from the CMTS.

















Expires September 2003                             [Page 19]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



4.  Definitions

--
-- Docsis QOS Extensions MIB
--

DOCS-IETF-QOS-MIB DEFINITIONS ::= BEGIN

IMPORTS
    MODULE-IDENTITY,
    OBJECT-TYPE,
    Integer32,
    Counter32,
    Unsigned32,
    Counter64
      FROM SNMPv2-SMI

    TEXTUAL-CONVENTION,
    MacAddress,
    RowStatus,
    TruthValue,
    DisplayString,
    TimeStamp,
    StorageType
      FROM SNMPv2-TC

    OBJECT-GROUP,
    MODULE-COMPLIANCE
      FROM SNMPv2-CONF

    ifIndex,
    InterfaceIndex
      FROM IF-MIB

    docsIfMib
      FROM DOCS-IF-MIB

    InetAddressType,
    InetAddress,
    InetPortNumber
      FROM INET-ADDRESS-MIB;

docsQosMIB   MODULE-IDENTITY
    LAST-UPDATED    "200303010000Z" -- March 1, 2003
    ORGANIZATION    "IETF IPCDN Working Group"
    CONTACT-INFO
        "
         Co-Author: Michael Patrick
         Postal:    Motorola BCS
                    20 Cabot Blvd, MS M2-330
                    Mansfield, MA 02048-1193



Expires September 2003                             [Page 20]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    U.S.A.
         Phone:     +1 508 851 8402
         E-mail:    michael.patrick@motorola.com

         Co-Author: William Murwin
         Postal:    Motorola BCS
                    20 Cabot Blvd, MS M2-330
                    Mansfield, MA 02048-1193
                    U.S.A.
         Phone:     +1 508 851 8385
         E-mail:    w.murwin@motorola.com"

    DESCRIPTION
        "This is the management information for
         Quality Of Service (QOS) for DOCSIS 1.1 and 2.0."

    REVISION        "200303010000Z" -- March 1, 2003
    DESCRIPTION
        "Initial version, published as RFC xxxx."
    ::= { docsIfMib xx }  -- xx to be assignrd by IANA

docsQosMIBObjects  OBJECT IDENTIFIER ::= { docsQosMIB 1 }

-- Textual Conventions
DocsQosRfMacIfDirection ::= TEXTUAL-CONVENTION
    STATUS          current
    DESCRIPTION     "Indicates a direction on an RF MAC interface.

                     The value downstream(1) is from Cable Modem
                     Termination System to Cable Modem.

                     The value upstream(2) is from Cable Modem to
                     Cable Modem Termination System."
    SYNTAX          INTEGER {
                       downstream(1),
                       upstream(2)
                    }

DocsQosBitRate ::= TEXTUAL-CONVENTION
    DISPLAY-HINT    "d"
    STATUS          current
    DESCRIPTION     "The rate of traffic in unit of bits per second.
                     Used to specify traffic rate for QOS."
    SYNTAX          Unsigned32

DocsQosSchedulingType ::= TEXTUAL-CONVENTION
    STATUS          current
    DESCRIPTION     "The scheduling service provided by a CMTS for an
                    upstream service flow. If the parameter is omitted
                    from an upstream QOS Parameter Set, this object takes
                    the value of bestEffort (2). This parameter must be



Expires September 2003                             [Page 21]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    reported as undefined (1) for downstream QOS Parameter
                    Sets."
    SYNTAX          INTEGER {
                      undefined (1),
                      bestEffort (2),
                      nonRealTimePollingService(3),
                      realTimePollingService(4),
                      unsolictedGrantServiceWithAD(5),
                      unsolictedGrantService(6)
                    }

-----------------------------------------------------------------------
--
-- Packet Classifier Table
--
docsQosPktClassTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosPktClassEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "This table describes the packet classification
                    configured on the CM or CMTS.
                    The model is that a packet either received
                    as input from an interface or transmitted
                    for output on an interface may be compared
                    against an ordered list of rules pertaining to
                    the packet contents. Each rule is a row of this
                    table. A matching rule provides a service flow
                    id to to which the packet is classified.
                    All rules need to match for a packet to match
                    a classifier.

                    The objects in this row correspond to a set of
                    Classifier Encoding parameters in a DOCSIS
                    MAC management message. The docsQosPktClassBitMap
                    indicates which particular parameters were present
                    in the classifier as signaled in the DOCSIS message.
                    If the referenced parameter was not present
                    in the signaled DOCSIS 1.1 and 2.0 Classifier, the
                    corresponding object in this row reports a
                    value as specified in the DESCRIPTION section.
                    "
    ::= { docsQosMIBObjects 1 }


docsQosPktClassEntry OBJECT-TYPE
    SYNTAX          DocsQosPktClassEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "An entry in this table provides a single packet
                     classifier rule. The index ifIndex is an ifType
                     of docsCableMaclayer(127)."



Expires September 2003                             [Page 22]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    INDEX {
            ifIndex,
            docsQosServiceFlowId,
            docsQosPktClassId
          }
    ::= { docsQosPktClassTable 1 }



DocsQosPktClassEntry ::= SEQUENCE {
    docsQosPktClassId                  Unsigned32,
    docsQosPktClassDirection           DocsQosRfMacIfDirection,
    docsQosPktClassPriority            Integer32,
    docsQosPktClassIpTosLow            OCTET STRING,
    docsQosPktClassIpTosHigh           OCTET STRING,
    docsQosPktClassIpTosMask           OCTET STRING,
    docsQosPktClassIpProtocol          Integer32,
    docsQosPktClassInetAddressType     InetAddressType,
    docsQosPktClassInetSourceAddr      InetAddress,
    docsQosPktClassInetSourceMask      InetAddress,
    docsQosPktClassInetDestAddr        InetAddress,
    docsQosPktClassInetDestMask        InetAddress,
    docsQosPktClassSourcePortStart     InetPortNumber,
    docsQosPktClassSourcePortEnd       InetPortNumber,
    docsQosPktClassDestPortStart       InetPortNumber,
    docsQosPktClassDestPortEnd         InetPortNumber,
    docsQosPktClassDestMacAddr         MacAddress,
    docsQosPktClassDestMacMask         MacAddress,
    docsQosPktClassSourceMacAddr       MacAddress,
    docsQosPktClassEnetProtocolType    INTEGER,
    docsQosPktClassEnetProtocol        Integer32,
    docsQosPktClassUserPriLow          Integer32,
    docsQosPktClassUserPriHigh         Integer32,
    docsQosPktClassVlanId              Integer32,
    docsQosPktClassStateActive         TruthValue,
    docsQosPktClassPkts                Counter64,
    docsQosPktClassBitMap              BITS
  }

docsQosPktClassId       OBJECT-TYPE
    SYNTAX          Unsigned32 (1..65535)
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "Index assigned to packet classifier entry by
                     the CMTS which is unique per service flow."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.1.3.2"
    ::= { docsQosPktClassEntry 1 }

docsQosPktClassDirection OBJECT-TYPE
    SYNTAX          DocsQosRfMacIfDirection
    MAX-ACCESS      read-only



Expires September 2003                             [Page 23]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    STATUS          current
    DESCRIPTION     "Indicates the direction to which the classifier
                     is applied."
    ::= { docsQosPktClassEntry 2 }

docsQosPktClassPriority OBJECT-TYPE
    SYNTAX          Integer32 (0..255)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The value specifies the order of evaluation
                     of the classifiers.
                     The higher the value the higher the priority.
                     The value of 0 is used as default in
                     provisioned service flows classifiers.
                     The default value of 64 is used for dynamic
                     service flow classifiers.
                     If the referenced parameter is not present
                     in a classifier, this object reports the default value
                     as defined above."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.1.3.5"
    ::= { docsQosPktClassEntry 3 }

docsQosPktClassIpTosLow OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(1))
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The low value of a range of TOS byte values.
                     If the referenced parameter is not present
                     in a classifier, this object reports the value of 0.

                     RFC 3260 refers to a TOS byte as the textual
                     convention of 'Dscp' of 6-bits however the
                     DOCSIS Specification calls for this object to
                     be 1 byte."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.1"
    ::= { docsQosPktClassEntry 4 }

docsQosPktClassIpTosHigh OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(1))
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The 8-bit high value of a range of TOS byte
                     values.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of 0.

                     RFC 3260 refers to a TOS byte as the textual
                     convention of 'Dscp' of 6-bits however the
                     DOCSIS Specification calls for this object to
                     be 1 byte."



Expires September 2003                             [Page 24]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    REFERENCE       "SP-RFIv1.1-I07-010829, Appendix C.2.1.5.1"
    ::= { docsQosPktClassEntry 5 }

docsQosPktClassIpTosMask OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(1))
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The mask value is bitwise ANDed with TOS byte
                     in an IP packet and this value is used check
                     range checking of TosLow and TosHigh.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of 0.

                     RFC 3260 refers to a TOS byte as the textual
                     convention of 'Dscp' of 6-bits however the
                     DOCSIS Specification calls for this object to
                     be 1 byte."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.1"
    ::= { docsQosPktClassEntry 6 }

docsQosPktClassIpProtocol OBJECT-TYPE
    SYNTAX          Integer32 (0..258)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object indicates the value of the IP
                    Protocol field required for IP packets to match
                    this rule.

                    The value 256 matches traffic with any IP Protocol
                    value. The value 257 by convention matches both TCP
                    and UDP.

                    If the referenced parameter is not present
                    in a classifier, this object reports the value of 258."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.2"
    ::= { docsQosPktClassEntry 7 }

docsQosPktClassInetAddressType OBJECT-TYPE
    SYNTAX          InetAddressType
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The type of the internet address for
                     docsQosPktClassInetSourceAddr,
                     docsQosPktClassInetSourceMask,
                     docsQosPktClassInetDestAddr, and
                     docsQosPktClassInetDestMask.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of
                     ipv4(1)."



Expires September 2003                             [Page 25]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.3"
    ::= { docsQosPktClassEntry 8 }

docsQosPktClassInetSourceAddr OBJECT-TYPE
    SYNTAX          InetAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "This object specifies the value of the IP
                     Source Address required for packets to match
                     this rule. An IP packet matches the rule when
                     the packet ip source address bitwise ANDed
                     with the docsQosPktClassInetSourceMask value
                     equals the docsQosPktClassInetSourceAddr value.

                     The address type of this object is specified by
                     docsQosPktClassInetAddressType.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of
                     '00000000'H."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.3"
    ::= { docsQosPktClassEntry 9 }

docsQosPktClassInetSourceMask OBJECT-TYPE
    SYNTAX          InetAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object specifies which bits of a packet's
                    IP Source Address that are compared to match
                    this rule.
                    An IP packet matches the rule when the packet
                    source address bitwise ANDed with the
                    docsQosPktClassInetSourceMask value equals the
                    docsQosIpPktClassInetSourceAddr value.

                    The address type of this object is specified by
                    docsQosPktClassInetAddressType.

                    If the referenced parameter is not present
                    in a classifier, this object reports the value of
                    'FFFFFFFF'H."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.4"
    ::= { docsQosPktClassEntry 10 }

docsQosPktClassInetDestAddr OBJECT-TYPE
    SYNTAX          InetAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "This object specifies the value of the IP
                     Destination Address required for packets to match
                     this rule. An IP packet matches the rule when



Expires September 2003                             [Page 26]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                     the packet ip destination address
                     bitwise ANDed with the
                     docsQosPktClassInetDestMask value
                     equals the docsQosPktClassInetDestAddr value.

                     The address type of this object is specified by
                     docsQosPktClassInetAddressType.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of
                     '00000000'H."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.5"
    ::= { docsQosPktClassEntry 11 }

docsQosPktClassInetDestMask OBJECT-TYPE
    SYNTAX          InetAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object specifies which bits of a packet's
                    IP Destination Address that are compared to
                    match this rule.
                    An IP packet matches the rule when the packet
                    destination address bitwise ANDed with the
                    docsQosPktClassInetDestMask value equals the
                    docsQosIpPktClassInetDestAddr value.

                    The address type of this object is specified by
                    docsQosPktClassInetAddressType.

                    If the referenced parameter is not present
                    in a classifier, this object reports the value of
                    'FFFFFFFF'H."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.6"
    ::= { docsQosPktClassEntry 12 }

docsQosPktClassSourcePortStart OBJECT-TYPE
    SYNTAX          InetPortNumber
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "This object specifies the low end inclusive
                     range of TCP/UDP source port numbers to which
                     a packet is compared. This object is irrelevant
                     for non-TCP/UDP IP packets.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of 0."
    REFERENCE        "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.7"
    ::= { docsQosPktClassEntry 13 }

docsQosPktClassSourcePortEnd OBJECT-TYPE
    SYNTAX          InetPortNumber



Expires September 2003                             [Page 27]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "This object specifies the high end inclusive
                     range of TCP/UDP source port numbers to which
                     a packet is compared. This object is irrelevant
                     for non-TCP/UDP IP packets.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of
                     65535."
    REFERENCE        "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.8"
    ::= { docsQosPktClassEntry 14 }

docsQosPktClassDestPortStart OBJECT-TYPE
    SYNTAX          InetPortNumber
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "This object specifies the low end inclusive
                     range of TCP/UDP destination port numbers to
                     which a packet is compared.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of 0."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.9"
    ::= { docsQosPktClassEntry 15 }

docsQosPktClassDestPortEnd OBJECT-TYPE
    SYNTAX          InetPortNumber
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "This object specifies the high end inclusive
                     range of TCP/UDP destination port numbers to which
                     a packet is compared.

                     If the referenced parameter is not present
                     in a classifier, this object reports the value of
                     65535."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.5.10"
    ::= { docsQosPktClassEntry 16 }

docsQosPktClassDestMacAddr OBJECT-TYPE
    SYNTAX          MacAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "An Ethernet packet matches an entry when its
                    destination MAC address bitwise ANDed with
                    docsQosPktClassDestMacMask equals the value of
                    docsQosPktClassDestMacAddr.


                    If the referenced parameter is not present



Expires September 2003                             [Page 28]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    in a classifier, this object reports the value of
                    '000000000000'H.
                    "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.6.1"
    ::= { docsQosPktClassEntry 17 }

docsQosPktClassDestMacMask OBJECT-TYPE
    SYNTAX          MacAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "An Ethernet packet matches an entry when its
                    destination MAC address bitwise ANDed with
                    docsQosPktClassDestMacMask equals the value of
                    docsQosPktClassDestMacAddr.

                    If the referenced parameter is not present
                    in a classifier, this object reports the value of
                    '000000000000'H.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.6.1"
    ::= { docsQosPktClassEntry 18 }

docsQosPktClassSourceMacAddr OBJECT-TYPE
    SYNTAX          MacAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "An Ethernet packet matches this entry when its
                    source MAC address equals the value of
                    this object.

                    If the referenced parameter is not present
                    in a classifier, this object reports the value of
                    'FFFFFFFFFFFF'H.
                    "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.6.2"
    ::= { docsQosPktClassEntry 19 }

docsQosPktClassEnetProtocolType OBJECT-TYPE
    SYNTAX          INTEGER {
                      none(0),
                      ethertype(1),
                      dsap(2),
                      mac(3),
                      all(4)
                    }
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object indicates the format of the layer 3
                    protocol id in the Ethernet packet. A value of
                    none(0) means that the rule does not use the
                    layer 3 protocol type as a matching criteria.



Expires September 2003                             [Page 29]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    A value of ethertype(1) means that the rule
                    applies only to frames which contains an
                    EtherType value. Ethertype values are contained
                    in packets using the Dec-Intel-Xerox (DIX)
                    encapsulation or the RFC1042 Sub-Network Access
                    Protocol (SNAP) encapsulation formats.

                    A value of dsap(2) means that the rule applies
                    only to frames using the IEEE802.3
                    encapsulation format with a Destination Service
                    Access Point (DSAP) other
                    than 0xAA (which is reserved for SNAP).

                    A value of mac(3) means that the rule applies
                    only to MAC management messages for MAC management
                    messages.

                    A value of all(4) means that the rule matches
                    all Ethernet packets.

                    If the Ethernet frame contains an 802.1P/Q Tag
                    header (i.e. EtherType 0x8100), this object
                    applies to the embedded EtherType field within
                    the 802.1P/Q header.

                    If the referenced parameter is not present
                    in a classifier, this object reports the value of 0.

                    "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.6.3"
    ::= { docsQosPktClassEntry 20 }

docsQosPktClassEnetProtocol OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "If docsQosEthPktClassProtocolType is none(0),
                    this object is ignored when considering whether
                    a packet matches the current rule.

                    If dosQosPktClassEnetProtocolType is ethertype(1),
                    this object gives the 16-bit value of the
                    EtherType that the packet must match in order to
                    match the rule.

                    If docsQosPktClassEnetProtocolType is dsap(2), the
                    lower 8 bits of this object's value must match the
                    DSAP byte of the packet in order to match the
                    rule.

                    If docsQosPktClassEnetProtocolType is mac(3), the



Expires September 2003                             [Page 30]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    lower 8 bits of this object value represent a
                    lower bound (inclusive) of MAC management message
                    type codes matched, and the upper 8 bits of this
                    object value represent the upper bound (inclusive)
                    of matched MAC message type codes.  Certain
                    message type codes are excluded from matching, as
                    specified in the reference.

                    If the Ethernet frame contains an 802.1P/Q Tag header
                    (i.e. EtherType 0x8100), this object applies to the
                    embedded EtherType field within the 802.1P/Q header.

                    If the referenced parameter is not present in the
                    classifier, the value of this object is reported as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.6.3"
    ::= { docsQosPktClassEntry 21 }

docsQosPktClassUserPriLow OBJECT-TYPE
    SYNTAX          Integer32 (0..7)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object applies only to Ethernet frames
                    using the 802.1P/Q tag header (indicated with
                    EtherType 0x8100). Such frames include a 16-bit
                    Tag that contains a 3 bit Priority field and
                    a 12 bit VLAN number.

                    Tagged Ethernet packets must have a 3-bit
                    Priority field within the range of
                    docsQosPktClassPriLow and docsQosPktClassPriHigh in
                    order to match this rule.

                    If the referenced parameter is not present in the
                    classifier, the value of this object is reported as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.7.1"
    ::= { docsQosPktClassEntry 22 }

docsQosPktClassUserPriHigh OBJECT-TYPE
    SYNTAX          Integer32 (0..7)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object applies only to Ethernet frames
                    using the 802.1P/Qtag header (indicated with
                    EtherType 0x8100). Such frames include a 16-bit
                    Tag that contains a 3 bit Priority field and
                    a 12 bit VLAN number.

                    Tagged Ethernet packets must have a 3-bit
                    Priority field within the range of



Expires September 2003                             [Page 31]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    docsQosPktClassPriLow and
                    docsQosPktClassPriHigh in order to match this
                    rule.

                    If the referenced parameter is not present in the
                    classifier, the value of this object is reported
                    as 7.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.7.1"
    ::= { docsQosPktClassEntry 23 }

docsQosPktClassVlanId OBJECT-TYPE
    SYNTAX          Integer32 (0..4095)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object applies only to Ethernet frames
                    using the 802.1P/Q tag header.

                    If this object's value is nonzero, tagged
                    packets must have a VLAN Identifier that matches
                    the value in order to match the rule.

                    Only the least significant 12 bits of this object's
                    value are valid.

                    If the referenced parameter is not present in the
                    classifier, the value of this object is reported
                    as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.7.2"
    ::= { docsQosPktClassEntry 24 }

docsQosPktClassStateActive OBJECT-TYPE
    SYNTAX          TruthValue
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object indicates whether or not the classifier
                    is enabled to classify packets to a Service Flow.

                    If the referenced parameter is not present in the
                    classifier, the value of this object is reported
                    as true(1)."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.3.6"
    ::= { docsQosPktClassEntry 25 }

docsQosPktClassPkts OBJECT-TYPE
    SYNTAX          Counter64
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object counts the number of packets that have
                    been classified using this entry. This



Expires September 2003                             [Page 32]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    includes all packets delivered to a service flow
                    maximum rate policing function, whether or not that
                    function drops the packets.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosPktClassEntry 26 }


docsQosPktClassBitMap OBJECT-TYPE
    SYNTAX          BITS {              -- Reference SP-RFIv1.1-I09-020830
                        rulePriority(0),     -- Appendix C.2.1.3.4
                        activationState(1),  -- Appendix C.2.1.3.6
                        ipTos(2),            -- Appendix C.2.1.5.1
                        ipProtocol(3),       -- Appendix C.2.1.5.2
                        ipSourceAddr(4),     -- Appendix C.2.1.5.3
                        ipSourceMask(5),     -- Appendix C.2.1.5.4
                        ipDestAddr(6),       -- Appendix C.2.1.5.5
                        ipDestMask(7),       -- Appendix C.2.1.5.6
                        sourcePortStart(8),  -- Appendix C.2.1.5.7
                        sourcePortEnd(9),    -- Appendix C.2.1.5.8
                        destPortStart(10),   -- Appendix C.2.1.5.9
                        destPortEnd(11),     -- Appendix C.2.1.5.10
                        destMac(12),         -- Appendix C.2.1.6.1
                        sourceMac(13),       -- Appendix C.2.1.6.2
                        ethertype(14),       -- Appendix C.2.1.6.3
                        userPri(15),         -- Appendix C.2.1.7.1
                        vlanId(16)           -- Appendix C.2.1.7.2
                    }
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION
                    "This object indicates which parameter encodings were
                    actually present in the DOCSIS packet classifier
                    encoding signaled in the DOCSIS message that
                    created or modified the classifier. Note that
                    Dynamic Service Change messages have replace
                    semantics, so that all non-default parameters must
                    be present whether the classifier is being created
                    or changed.

                    A bit of of this object is set to 1 if the parameter
                    indicated by the comment was present in the classifier
                    encoding, and 0 otherwise.

                    Note that BITS are encoded most significant bit
                    first, so that if e.g. bits 6 and 7 are set, this object
                    is encoded as the octet string '030000'H.
                   "
    ::= { docsQosPktClassEntry 27 }



Expires September 2003                             [Page 33]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003




--
-- QOS Parameter Set Table
--
docsQosParamSetTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosParamSetEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "This table describes the set of DOCSIS 1.1 and 2.0
                    QOS parameters defined in a managed device.

                    The ifIndex index specifies a DOCSIS MAC Domain.
                    The docsQosServiceFlowId index specifies a particular
                    Service Flow.
                    The docsQosParamSetType index indicates whether
                    the active, admitted, or provisioned QOS Parameter
                    Set is being described by the row.

                    Only the QOS Parameter Sets of Docsis 1.1 and 2.0
                    service flows are represented in this table.
                    Docsis 1.0 QOS service profiles are not
                    represented in this table.

                    Each row corresponds to a DOCSIS QOS Parameter Set
                    as signaled via DOCSIS MAC management messages.
                    Each object in the row corresponds to one or
                    part of one DOCSIS 1.1 Service Flow Encoding.
                    The docsQosParamSetBitMap object in the row indicates
                    which particular parameters were signaled in
                    the original registration or dynamic service
                    request message that created the QOS Parameter Set.

                    In many cases, even if a QOS Parameter Set parameter
                    was not signaled, the DOCSIS specification calls
                    for a default value to be used. That default value
                    is reported as the value of the corresponding object
                    in this row.

                    Many objects are not applicable depending on
                    the service flow direction or upstream scheduling
                    type.  The object value reported in this case
                    is specified in the DESCRIPTION clause.
                    "
    ::= { docsQosMIBObjects 2 }

-- docsQosParamSetEntry { docsQosParamSetTable 1 } was
-- removed in an initial and unimplemented version of this mib.

docsQosParamSetEntry OBJECT-TYPE
    SYNTAX          DocsQosParamSetEntry
    MAX-ACCESS      not-accessible



Expires September 2003                             [Page 34]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    STATUS          current
    DESCRIPTION
    "A unique set of QOS parameters."
    INDEX {
        ifIndex, docsQosServiceFlowId, docsQosParamSetType
          }
    ::= { docsQosParamSetTable 1 }

DocsQosParamSetEntry ::= SEQUENCE {
    docsQosParamSetServiceClassName   DisplayString,
    docsQosParamSetPriority           Integer32,
    docsQosParamSetMaxTrafficRate     DocsQosBitRate,
    docsQosParamSetMaxTrafficBurst    Unsigned32,
    docsQosParamSetMinReservedRate    DocsQosBitRate,
    docsQosParamSetMinReservedPkt     Integer32,
    docsQosParamSetActiveTimeout      Integer32,
    docsQosParamSetAdmittedTimeout    Integer32,
    docsQosParamSetMaxConcatBurst     Integer32,
    docsQosParamSetSchedulingType     DocsQosSchedulingType,
    docsQosParamSetNomPollInterval    Unsigned32,
    docsQosParamSetTolPollJitter      Unsigned32,
    docsQosParamSetUnsolicitGrantSize Integer32,
    docsQosParamSetNomGrantInterval   Unsigned32,
    docsQosParamSetTolGrantJitter     Unsigned32,
    docsQosParamSetGrantsPerInterval  Integer32,
    docsQosParamSetTosAndMask         OCTET STRING,
    docsQosParamSetTosOrMask          OCTET STRING,
    docsQosParamSetMaxLatency         Unsigned32,
    docsQosParamSetType               INTEGER,
    docsQosParamSetRequestPolicyOct   OCTET STRING,
    docsQosParamSetBitMap             BITS
    }

docsQosParamSetServiceClassName OBJECT-TYPE
    SYNTAX          DisplayString
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Refers to the Service Class Name that the
                    parameter set values were derived.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the default
                    value of this object is a zero length string.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.3.4"
    ::= { docsQosParamSetEntry 4 }

docsQosParamSetPriority OBJECT-TYPE
    SYNTAX          Integer32 (0..7)
    MAX-ACCESS      read-only
    STATUS          current



Expires September 2003                             [Page 35]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    DESCRIPTION    "The relative priority of a service flow.
                    Higher numbers indicate higher priority.
                    This priority should only be used to differentiate
                    service flow with identical parameter sets.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the default
                    value of this object is 0.  If the parameter is
                    not applicable, the reported value is 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.5.1"
    ::= { docsQosParamSetEntry 5 }

docsQosParamSetMaxTrafficRate OBJECT-TYPE
    SYNTAX          DocsQosBitRate
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Maximum sustained traffic rate allowed for this
                    service flow in bits/sec. Must count all MAC frame
                    data PDU from the bytes following the MAC header HCS to
                    the end of the CRC. The number of bytes
                    forwarded is limited during any time interval.
                    The value 0 means no maximum traffic rate is
                    enforced. This object applies to both upstream and
                    downstream service flows.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the default
                    value of this object is 0. If the parameter is
                    not applicable, it is reported as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.5.2"
    ::= { docsQosParamSetEntry 6 }

docsQosParamSetMaxTrafficBurst OBJECT-TYPE
    SYNTAX          Unsigned32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the token bucket size in bytes
                    for this parameter set. The value is calculated
                    from the byte following the MAC header HCS to
                    the end of the CRC. This object is applied in
                    conjunction with docsQosParamSetMaxTrafficRate to
                    calculate maximum sustained traffic rate.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the default
                    value of this object for scheduling types
                    bestEffort (2), nonRealTimePollingService(3),
                    and realTimePollingService(4) is 3044.




Expires September 2003                             [Page 36]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    If this parameter is not applicable, it is reported
                    as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.5.3"
    ::= { docsQosParamSetEntry 7 }

docsQosParamSetMinReservedRate OBJECT-TYPE
    SYNTAX          DocsQosBitRate
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the guaranteed minimum rate in
                    bits/sec for this parameter set. The value is
                    calculated from the byte following the MAC
                    header HCS to the end of the CRC. The default
                    value of 0 has the meaning that no bandwidth
                    is reserved.
                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the default
                    value of this object is 0. If the parameter
                    is not applicable, it is reported as 0.
                    "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.5.4"
    ::= { docsQosParamSetEntry 8 }

docsQosParamSetMinReservedPkt OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies an assumed minimum packet size in
                    bytes for which the docsQosParamSetMinReservedRate
                    will be provided. The value is calculated from
                    the byte following the MAC header HCS to the
                    end of the CRC.

                    If the referenced parameter is omitted from a
                    DOCSIS QOS parameter set, the default value is
                    CMTS implementation dependent. In this case, the
                    CMTS reports the default value it is using and the
                    CM reports a value of 0. If the referenced
                    parameter is not applicable to the direction or
                    scheduling type of the service flow, both CMTS and
                    CM report this object's value as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.5.5"
    ::= { docsQosParamSetEntry 9 }

docsQosParamSetActiveTimeout OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    UNITS           "seconds"
    MAX-ACCESS      read-only
    STATUS          current



Expires September 2003                             [Page 37]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    DESCRIPTION    "Specifies the maximum duration in seconds that
                    resources remain unused on an active service
                    flow before CMTS signals that both active and
                    admitted parameters set are null.
                    The default value of 0 signifies an
                    infinite amount of time.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the default
                    value of this object is 0.
                   "

    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.5.6"
    ::= { docsQosParamSetEntry 10 }

docsQosParamSetAdmittedTimeout OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    UNITS           "seconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the maximum duration in seconds that
                    resources remain in admitted state before
                    resources must be released.
                    The value of 0 signifies an infinite amount
                    of time.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the
                    default value of this object is 200.
                   "

    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.5.7"
    DEFVAL          { 200 }
    ::= { docsQosParamSetEntry 11 }

docsQosParamSetMaxConcatBurst OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the maximum concatenated burst in
                    bytes which an upstream  service flow is allowed.
                    The value is calculated from the FC byte of the
                    Concatenation MAC Header to the last CRC byte in
                    of the last concatenated MAC frame, inclusive.
                    The value of 0 specifies no maximum burst.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set, the default
                    value of this object for scheduling types
                    bestEffort(2), nonRealTimePollingService(3), and
                    realTimePollingService(4) is 1522. If the parameter



Expires September 2003                             [Page 38]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    is not applicable, this object's value is reported
                    as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.1"
    ::= { docsQosParamSetEntry 12 }


docsQosParamSetSchedulingType OBJECT-TYPE
    SYNTAX          DocsQosSchedulingType
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the upstream scheduling service used for
                    upstream service flow.

                    If the referenced parameter is not present in the
                    corresponding DOCSIS QOS Parameter Set of an
                    upstream service flow, the default value of this
                    object is bestEffort(2). For QOS parameter sets of
                    downstream service flows, this object's value is
                    reported as undefined(1).
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.2"
    ::= { docsQosParamSetEntry 13 }

docsQosParamSetNomPollInterval OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the nominal interval in microseconds
                    between successive unicast request
                    opportunities on an upstream service flow.

                    This object applies only to upstream service flows
                    with DocsQosSchedulingType of value
                    nonRealTimePollingService(3),
                    realTimePollingService(4), and
                    unsolictedGrantServiceWithAD(5).  The parameter is
                    mandatory for realTimePollingService(4).  If the
                    parameter is omitted with
                    nonRealTimePollingService(3), the CMTS uses an
                    implementation dependent value.  If the parameter
                    is omitted with unsolictedGrantServiceWithAD(5),
                    the CMTS uses as a default value the value of the
                    Nominal Grant Interval parameter.  In all cases,
                    the CMTS reports the value it is using when the
                    parameter is applicable.  The CM reports the
                    signaled parameter value if it was signaled,
                    and 0 otherwise.

                    If the referenced parameter is not applicable to



Expires September 2003                             [Page 39]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    the direction or scheduling type of the
                    corresponding DOCSIS QOS Parameter Set, both
                    CMTS and CM report this object's value as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.4"
    ::= { docsQosParamSetEntry 15 }

docsQosParamSetTolPollJitter OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the maximum amount of time in
                    microseconds that the unicast request interval
                    may be delayed from the nominal periodic
                    schedule on an upstream service flow.

                    This parameter is applicable only to upstream
                    service flows with a DocsQosSchedulingType of
                    realTimePollingService(4) or
                    unsolictedGrantServiceWithAD(5).

                    If the referenced parameter is applicable but not
                    present in the corresponding DOCSIS QOS Parameter
                    Set, the CMTS uses an implementation dependent
                    value and reports the value it is using.
                    The CM reports a value of 0 in this case.

                    If the parameter is not applicable to the
                    direction or upstream scheduling type of the
                    service flow, both CMTS and CM report this
                    object's value as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.5"
    ::= { docsQosParamSetEntry 16 }

docsQosParamSetUnsolicitGrantSize OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the unsolicited grant size in bytes.
                    The grant size includes the entire MAC frame
                    data PDU from the Frame Control byte to end of
                    the MAC frame.

                    The referenced parameter is applicable only
                    for upstream flows with a DocsQosSchedulingType of
                    of unsolicitedGrantServicewithAD(5) or
                    unsolicitedGrantService(6), and is mandatory
                    when applicable. Both CMTS and CM report
                    the signaled value of the parameter in this



Expires September 2003                             [Page 40]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    case.

                    If the referenced parameter is not applicable to
                    the direction or scheduling type of the
                    corresponding DOCSIS QOS Parameter Set, both
                    CMTS and CM report this object's value as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.6"
    ::= { docsQosParamSetEntry 17 }

docsQosParamSetNomGrantInterval OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the nominal interval in microseconds
                    between successive data grant opportunities
                    on an upstream service flow.

                    The referenced parameter is applicable only
                    for upstream flows with a DocsQosSchedulingType of
                    of unsolicitedGrantServicewithAD(5) or
                    unsolicitedGrantService(6), and is mandatory
                    when applicable. Both CMTS and CM report the
                    signaled value of the parameter in this case.

                    If the referenced parameter is not applicable to
                    the direction or scheduling type of the
                    corresponding DOCSIS QOS Parameter Set, both
                    CMTS and CM report this object's value as 0.
                   "

    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.7"
    ::= { docsQosParamSetEntry 18 }

docsQosParamSetTolGrantJitter OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the maximum amount of time in
                    microseconds that the transmission opportunities
                    may be delayed from the nominal periodic schedule.

                    The referenced parameter is applicable only
                    for upstream flows with a DocsQosSchedulingType of
                    of unsolicitedGrantServicewithAD(5) or
                    unsolicitedGrantService(6), and is mandatory
                    when applicable. Both CMTS and CM report the
                    signaled value of the parameter in this case.




Expires September 2003                             [Page 41]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    If the referenced parameter is not applicable to
                    the direction or scheduling type of the
                    corresponding DOCSIS QOS Parameter Set, both
                    CMTS and CM report this object's value as 0.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.8"
    ::= { docsQosParamSetEntry 19 }

docsQosParamSetGrantsPerInterval OBJECT-TYPE
    SYNTAX          Integer32 (0..127)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the number of data grants per Nominal
                    Grant Interval
                    (docsQosParamSetNomGrantInterval).

                    The referenced parameter is applicable only
                    for upstream flows with a DocsQosSchedulingType of
                    of unsolicitedGrantServicewithAD(5) or
                    unsolicitedGrantService(6), and is mandatory
                    when applicable. Both CMTS and CM report the
                    signaled value of the parameter in this case.

                    If the referenced parameter is not applicable to
                    the direction or scheduling type of the
                    corresponding DOCSIS QOS Parameter Set, both
                    CMTS and CM report this object's value as 0.
                   "

    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.9"
    ::= { docsQosParamSetEntry 20 }

docsQosParamSetTosAndMask OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(1))
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the AND mask for IP TOS byte for overwriting
                    IP packets TOS value.  The IP packets TOS byte is
                    bitwise ANDed with docsQosParamSetTosAndMask and
                    result is bitwise ORed with docsQosParamSetTosORMask
                    and result is written to IP packet TOS byte.
                    A value of 'FF'H for docsQosParamSetTosAndMask and
                    a value of '00'H for docsQosParamSetTosOrMask means
                    that IP Packet TOS byte is not overwritten.

                    This combination is reported if the referenced
                    parameter is not present in a QOS Parameter Set.

                    Even though the this object is only enforced by the
                    Cable Modem Termination System (CMTS),
                    Cable Modems must report the value as signaled in



Expires September 2003                             [Page 42]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    the referenced parameter."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.10"
    ::= { docsQosParamSetEntry 21 }

docsQosParamSetTosOrMask OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(1))
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the OR mask for IP TOS byte.
                    See the description of docsQosParamSetTosAndMask
                    for further details."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.10"
    ::= { docsQosParamSetEntry 22 }

docsQosParamSetMaxLatency OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies the maximum latency between the
                    reception of a packet by the CMTS on its NSI
                    and the forwarding of the packet to the RF
                    interface. A value of 0 signifies no maximum
                    latency enforced. This object only applies to
                    downstream service flows.

                    If the referenced parameter is not present in the
                    corresponding downstream DOCSIS QOS Parameter Set,
                    the default value is 0. This parameter is
                    not applicable to upstream DOCSIS QOS Parameter Sets,
                    and its value is reported as 0 in this case.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.7.1"
    ::= { docsQosParamSetEntry 23 }


docsQosParamSetType     OBJECT-TYPE
    SYNTAX          INTEGER {
                       active (1),
                       admitted (2),
                       provisioned (3)
                    }
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "Defines the type of the QOS parameter set defined
                    by this row. active(1) indicates the Active QOS
                    parameter set, describing the service currently
                    being provided by the Docsis MAC domain to the
                    service flow. admitted(2) indicates the Admitted
                    QOS Parameter Set, describing services reserved by
                    by the Docsis MAC domain for use by the service flow.



Expires September 2003                             [Page 43]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    provisioned (3) describes the QOS Parameter Set
                    defined in the DOCSIS CM Configuration file for
                    the service flow."
    REFERENCE      "SP-RFIv1.1-I09-020830, 8.1.5"
    ::= { docsQosParamSetEntry 24 }

docsQosParamSetRequestPolicyOct OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(4))
                    -- A 32-bit mask represented most significant byte
                    -- first. The 32 bit integer represented in this manner
                    -- equals the binary value of the referenced integer
                    -- parameter of the DOCSIS RFI specification.
                    -- The BITS syntax is not used in order to avoid
                    -- the confusion caused by different bit numbering
                    -- conventions.
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Specifies which transmit interval opportunities
                    the CM omits for upstream transmission requests and
                    packet transmissions. This object takes its
                    default value for downstream service flows.

                    Unless otherwise indicated, a bit value of 1 means
                    that a CM must *not* use that opportunity for
                    upstream transmission.

                    Calling bit 0 the least significant bit of the
                    least significant (4th) octet, and increasing
                    bit number with significance, the bit definitions
                    are as defined below:

                    broadcastReqOpp(0):
                         all CMs broadcast request opportunities

                    priorityReqMulticastReq(1):
                         priority request multicast request opportunities

                    reqDataForReq(2):
                         request/data opportunities for requests

                    reqDataForData(3):
                         request/data opportunities for data

                    piggybackReqWithData(4):
                         piggyback requests with data

                    concatenateData(5):
                         concatenate data

                    fragmentData(6):
                         fragment data



Expires September 2003                             [Page 44]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    suppresspayloadheaders(7):
                         suppress payload headers

                    dropPktsExceedUGSize(8):
                         A value of 1 mean that service flow must drop
                         packet that do not fit in the Unsolicited
                         Grant size

                    If the referenced parameter is not present in
                    a QOS Parameter Set, the value of this object is
                    reported as '00000000'H.
                    "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.6.3"
    ::= { docsQosParamSetEntry 25 }

docsQosParamSetBitMap OBJECT-TYPE
                                -- Each bit corresponds to a parameter
                                -- from SP-RFI-v1.1-I07-010829, Appendix C
    SYNTAX          BITS {      -- in the indicated section number.
                        trafficPriority(0),     -- C.2.2.5.1
                        maxTrafficRate(1),      -- C.2.2.5.2
                        maxTrafficBurst(2),     -- C.2.2.5.3
                        minReservedRate(3),     -- C.2.2.5.4
                        minReservedPkt(4),      -- C.2.2.5.5
                        activeTimeout(5),       -- C.2.2.5.6
                        admittedTimeout(6),     -- C.2.2.5.7
                        maxConcatBurst(7),      -- C.2.2.6.1
                        schedulingType(8),      -- C.2.2.6.2
                        requestPolicy(9),       -- C.2.2.6.3
                        nomPollInterval(10),    -- C.2.2.6.4
                        tolPollJitter(11),      -- C.2.2.6.5
                        unsolicitGrantSize(12), -- C.2.2.6.6
                        nomGrantInterval(13),   -- C.2.2.6.7
                        tolGrantJitter(14),     -- C.2.2.6.8
                        grantsPerInterval(15),  -- C.2.2.6.9
                        tosOverwrite(16),       -- C.2.2.6.10
                        maxLatency(17)          -- C.2.2.7.1
                    }
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object indicates the set of QOS Parameter
                    Set parameters actually signaled in the
                    DOCSIS registration or dynamic service request
                    message that created or modified the QOS Parameter Set.
                    A bit is set to 1 when the parameter described
                    by the indicated reference section is present
                    in the original request.

                    Note that when Service Class names are expanded,
                    the registration or dynamic response message may
                    contain parameters as expanded by the CMTS based



Expires September 2003                             [Page 45]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    on a stored service class. These expanded
                    parameters are *not* indicated by a 1 bit in this
                    object.

                    Note that even though some QOS Parameter Set
                    parameters may not be signaled in a message
                    (so that the paramater's bit in this object is 0)
                    the DOCSIS specification calls for default
                    values to be used. These default values are
                    reported as the corresponding object's value in
                    the row.

                    Note that BITS objects are encoded most
                    significant bit first. For example, if bits
                    1 and 16 are set, the value of this object
                    is the octet string '400080'H.

                   "
::= { docsQosParamSetEntry 26 }

--
--  Service Flow Table
--
docsQosServiceFlowTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosServiceFlowEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table describes the set of Docsis-QOS
                     Service Flows in a managed device. "
    ::= { docsQosMIBObjects 3 }

docsQosServiceFlowEntry OBJECT-TYPE
    SYNTAX          DocsQosServiceFlowEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "Describes a service flow.
                     An entry in the table exists for each
                     Service Flow ID. The ifIndex is an
                     ifType of docsCableMaclayer(127)."
    INDEX {
            ifIndex,
            docsQosServiceFlowId
          }
    ::= { docsQosServiceFlowTable 1 }

DocsQosServiceFlowEntry ::= SEQUENCE {
    docsQosServiceFlowId                       Unsigned32,
    docsQosServiceFlowSID                      Unsigned32,
    docsQosServiceFlowDirection                DocsQosRfMacIfDirection,
    docsQosServiceFlowPrimary                  TruthValue
    }



Expires September 2003                             [Page 46]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



docsQosServiceFlowId    OBJECT-TYPE
    SYNTAX          Unsigned32 (1..4294967295)
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "An index assigned to a service flow by CMTS."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.3.2"
    ::= { docsQosServiceFlowEntry 1 }

docsQosServiceFlowSID  OBJECT-TYPE
    SYNTAX          Unsigned32 (0..16383)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Service Identifier (SID) assigned to an
                    admitted or active service flow. This object
                    reports a value of 0 if a Service Id is not
                    associated with the service flow. Only active
                    or admitted upstream service flows will have a
                    Service Id (SID)."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.3.3"
    ::= { docsQosServiceFlowEntry 2 }

docsQosServiceFlowDirection OBJECT-TYPE
    SYNTAX          DocsQosRfMacIfDirection
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The direction of the service flow."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.1/2"
    ::= { docsQosServiceFlowEntry 3 }

docsQosServiceFlowPrimary OBJECT-TYPE
    SYNTAX          TruthValue
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Object reflects whether service flow is the primary
                    or a secondary service flow.

                    A primary service flow is the default service flow
                    for otherwise unclassified traffic and all MAC
                    messages."
    REFERENCE      "SP-RFIv1.1-I09-020830, Section 8.1 "
    ::= { docsQosServiceFlowEntry 4 }

--
--  Service Flow Stats Table
--
docsQosServiceFlowStatsTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosServiceFlowStatsEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table describes statistics associated with the
                     Service Flows in a managed device. "



Expires September 2003                             [Page 47]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    ::= { docsQosMIBObjects 4 }

docsQosServiceFlowStatsEntry OBJECT-TYPE
    SYNTAX          DocsQosServiceFlowStatsEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "Describes a set of service flow statistics.
                     An entry in the table exists for each
                     Service Flow ID. The ifIndex is an
                     ifType of docsCableMaclayer(127)."
    INDEX {
            ifIndex,
            docsQosServiceFlowId
          }
    ::= { docsQosServiceFlowStatsTable 1 }

DocsQosServiceFlowStatsEntry ::= SEQUENCE {
    docsQosServiceFlowPkts                     Counter64,
    docsQosServiceFlowOctets                   Counter64,
    docsQosServiceFlowTimeCreated              TimeStamp,
    docsQosServiceFlowTimeActive               Counter32,
    docsQosServiceFlowPHSUnknowns              Counter32,
    docsQosServiceFlowPolicedDropPkts          Counter32,
    docsQosServiceFlowPolicedDelayPkts         Counter32
    }

docsQosServiceFlowPkts OBJECT-TYPE
    SYNTAX          Counter64
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Packet Data PDUs classified to this
                    service flow and forwarded beyond a service flow
                    maximum rate policing function.
                    This object does not count MAC-specific
                    management messages.
                    CMs not classifying downstream packets may report
                    this object's value as 0.

                    Particularly for UGS flows, packets sent on the
                    primary service flow in violation of the UGS grant
                    size should be counted only on the primary service
                    flow's counters.

                    Unclassified upstream user data packets (i.e. non
                    MAC-management) forwarded to the default upstream
                    service flow should be incremented for this object.

                    This object does include packets counted by
                    docsQosServiceFlowPolicedDelayPkts, but does not include
                    packets counted by docsQosServiceFlowPolicedDropPkts.




Expires September 2003                             [Page 48]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosServiceFlowStatsEntry 1 }

docsQosServiceFlowOctets OBJECT-TYPE
    SYNTAX          Counter64
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of octets from the byte after the MAC
                    header HCS to the end of the CRC for all packets counted
                    in the docsQosServiceFlowPkts object for this row.
                    Note that this counts the octets after payload header
                    suppression has been applied. CMs not classifying to a
                    downstream service flow may report this object's
                    value as 0 for that flow.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosServiceFlowStatsEntry 2 }

docsQosServiceFlowTimeCreated OBJECT-TYPE
    SYNTAX          TimeStamp
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The value of sysUpTime when the service flow
                    was created."
    ::= { docsQosServiceFlowStatsEntry 3 }

docsQosServiceFlowTimeActive OBJECT-TYPE
    SYNTAX          Counter32
    UNITS           "seconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of seconds that the service flow
                    has been active.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosServiceFlowStatsEntry 4 }

docsQosServiceFlowPHSUnknowns OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of packets received on the service flow
                    with an unknown payload header suppression index.

                    This counter's last discontinuity is the



Expires September 2003                             [Page 49]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosServiceFlowStatsEntry 5 }

docsQosServiceFlowPolicedDropPkts OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Packet Data PDUs classified to this
                    service flow dropped due to:
                       (1) implementation-dependent excessive delay while
                           enforcing the Maximum Sustained Traffic Rate; or
                       (2) UGS packets dropped due to exceeding the
                           Unsolicited Grant Size with a
                           Request/Transmission policy that requires such
                           packets to be dropped.
                    Classified packets dropped due to other reasons must be
                    counted in ifOutDiscards for interface of this
                    service flow.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosServiceFlowStatsEntry 6 }

docsQosServiceFlowPolicedDelayPkts OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "This object counts only packets delayed in order to
                    maintain the Maximum Sustained Traffic Rate. This object
                    will always report a value of 0 for UGS flows because the
                    Maximum Sustained Traffic Rate does not apply.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosServiceFlowStatsEntry 7 }

--
--  Upstream Service Flow Stats Table (CMTS ONLY)
--
docsQosUpstreamStatsTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosUpstreamStatsEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table describes statistics associated with
                     upstream service flows. All counted frames must
                     be received without an FCS error."
    ::= { docsQosMIBObjects 5 }




Expires September 2003                             [Page 50]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



docsQosUpstreamStatsEntry OBJECT-TYPE
    SYNTAX          DocsQosUpstreamStatsEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "Describes a set of upstream service flow statistics.
                     An entry in the table exists for each
                     upstream Service Flow in a managed device.
                     The ifIndex is an ifType of docsCableMaclayer(127)."
    INDEX {
            ifIndex,
            docsQosSID
          }
    ::= { docsQosUpstreamStatsTable 1 }

DocsQosUpstreamStatsEntry ::= SEQUENCE {
    docsQosSID                            Unsigned32,
    docsQosUpstreamFragments              Counter32,
    docsQosUpstreamFragDiscards           Counter32,
    docsQosUpstreamConcatBursts           Counter32
    }

docsQosSID OBJECT-TYPE
    SYNTAX          Unsigned32 (1..16383)
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "Identifies a service id for an admitted or active
                    upstream service flow."
    ::= { docsQosUpstreamStatsEntry 1 }

docsQosUpstreamFragments OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of fragmentation headers received on an
                    upstream  service flow, regardless of whether
                    the fragment was correctly reassembled into a
                    valid packet.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosUpstreamStatsEntry 2 }

docsQosUpstreamFragDiscards OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of upstream fragments discarded and not
                    assembled into a valid upstream packet.

                    This counter's last discontinuity is the



Expires September 2003                             [Page 51]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosUpstreamStatsEntry 3 }

docsQosUpstreamConcatBursts OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of concatenation headers received on an
                    upstream service flow.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosUpstreamStatsEntry 4 }


--
--  Dynamic Service Stats Table
--
docsQosDynamicServiceStatsTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosDynamicServiceStatsEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table describes statistics associated with the
                     Dynamic Service Flows in a managed device. "
    ::= { docsQosMIBObjects 6 }

docsQosDynamicServiceStatsEntry OBJECT-TYPE
    SYNTAX          DocsQosDynamicServiceStatsEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "Describes a set of dynamic service flow statistics.
                     Two entries exist for each Docsis mac layer
                     interface for the upstream and downstream direction.
                     On the CMTS, the downstream direction row indicates
                     messages transmitted or transactions originated
                     by the CMTS. The upstream direction row indicates
                     messages received or transaction originated by the
                     CM. On the CM, the downstream direction row
                     indicates messages received or transactions
                     originated by the CMTS. The upstream direction
                     row indicates messages transmitted by the CM or
                     transactions originated by the CM.
                     The ifIndex is an ifType of docsCableMaclayer(127)."
    INDEX {
            ifIndex,
            docsQosIfDirection
          }
    ::= { docsQosDynamicServiceStatsTable 1 }




Expires September 2003                             [Page 52]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



DocsQosDynamicServiceStatsEntry ::= SEQUENCE {
    docsQosIfDirection                         DocsQosRfMacIfDirection,
    docsQosDSAReqs                             Counter32,
    docsQosDSARsps                             Counter32,
    docsQosDSAAcks                             Counter32,
    docsQosDSCReqs                             Counter32,
    docsQosDSCRsps                             Counter32,
    docsQosDSCAcks                             Counter32,
    docsQosDSDReqs                             Counter32,
    docsQosDSDRsps                             Counter32,
    docsQosDynamicAdds                         Counter32,
    docsQosDynamicAddFails                     Counter32,
    docsQosDynamicChanges                      Counter32,
    docsQosDynamicChangeFails                  Counter32,
    docsQosDynamicDeletes                      Counter32,
    docsQosDynamicDeleteFails                  Counter32,
    docsQosDCCReqs                             Counter32,
    docsQosDCCRsps                             Counter32,
    docsQosDCCAcks                             Counter32,
    docsQosDCCs                                Counter32,
    docsQosDCCFails                            Counter32
   }

docsQosIfDirection OBJECT-TYPE
    SYNTAX          DocsQosRfMacIfDirection
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "The direction of interface."
    ::= { docsQosDynamicServiceStatsEntry 1 }

docsQosDSAReqs OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Addition Requests,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 2 }

docsQosDSARsps OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Addition Responses,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that



Expires September 2003                             [Page 53]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 3 }

docsQosDSAAcks OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Addition Acknowledgements,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 4 }

docsQosDSCReqs OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Change Requests,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 5 }

docsQosDSCRsps OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Change Responses,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 6 }

docsQosDSCAcks OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Change Acknowledgements,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 7 }




Expires September 2003                             [Page 54]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



docsQosDSDReqs OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Delete Requests,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 8 }

docsQosDSDRsps OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Service Delete Responses,
                    including retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 9 }

docsQosDynamicAdds OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of successful Dynamic Service Addition
                    transactions.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 10 }

docsQosDynamicAddFails OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of failed Dynamic Service Addition
                    transactions.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 11 }

docsQosDynamicChanges OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only



Expires September 2003                             [Page 55]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    STATUS          current
    DESCRIPTION    "The number of successful Dynamic Service Change
                    transactions.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 12 }

docsQosDynamicChangeFails OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of failed Dynamic Service Change
                    transactions.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 13 }

docsQosDynamicDeletes OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of successful Dynamic Service Delete
                    transactions.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 14 }

docsQosDynamicDeleteFails OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of failed Dynamic Service Delete
                    transactions.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 15 }


docsQosDCCReqs OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Channel Change Request messages



Expires September 2003                             [Page 56]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    traversing an interface. This count is nonzero only on
                    downstream direction rows. This count should
                    include number of retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 16 }

docsQosDCCRsps OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Channel Change Response messages
                    traversing an interface. This count is nonzero
                    only on upstream direction rows. This count should
                    include number of retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 17 }

docsQosDCCAcks OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of Dynamic Channel Change Acknowledgement
                    messages traversing an interface. This count
                    is nonzero only on downstream direction rows.
                    This count should include number of retries.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 18 }

docsQosDCCs OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of successful Dynamic Channel Change
                    transactions. This count is nonzero only on downstream
                    direction rows.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 19 }

docsQosDCCFails OBJECT-TYPE



Expires September 2003                             [Page 57]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of failed Dynamic Channel Change
                    transactions. This count is nonzero only on
                    downstream direction rows.

                    This counter's last discontinuity is the
                    ifCounterDiscontinuityTime for same ifIndex that
                    indexes this object."
    ::= { docsQosDynamicServiceStatsEntry 20 }


--
--  Service Flow Log Table (CMTS ONLY)
--
docsQosServiceFlowLogTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosServiceFlowLogEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table contains a log of the disconnected
                     Service Flows in a managed device."
    ::= { docsQosMIBObjects 7 }

docsQosServiceFlowLogEntry OBJECT-TYPE
    SYNTAX          DocsQosServiceFlowLogEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "The information regarding a single disconnected
                     service flow."
    INDEX {
            docsQosServiceFlowLogIndex
          }
    ::= { docsQosServiceFlowLogTable 1 }

DocsQosServiceFlowLogEntry ::= SEQUENCE {
    docsQosServiceFlowLogIndex                 Unsigned32,
    docsQosServiceFlowLogIfIndex               InterfaceIndex,
    docsQosServiceFlowLogSFID                  Unsigned32,
    docsQosServiceFlowLogCmMac                 MacAddress,
    docsQosServiceFlowLogPkts                  Counter64,
    docsQosServiceFlowLogOctets                Counter64,
    docsQosServiceFlowLogTimeDeleted           TimeStamp,
    docsQosServiceFlowLogTimeCreated           TimeStamp,
    docsQosServiceFlowLogTimeActive            Counter32,
    docsQosServiceFlowLogDirection             DocsQosRfMacIfDirection,
    docsQosServiceFlowLogPrimary               TruthValue,
    docsQosServiceFlowLogServiceClassName      DisplayString,
    docsQosServiceFlowLogPolicedDropPkts       Counter32,
    docsQosServiceFlowLogPolicedDelayPkts      Counter32,
    docsQosServiceFlowLogControl               INTEGER



Expires September 2003                             [Page 58]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    }

docsQosServiceFlowLogIndex OBJECT-TYPE
    SYNTAX          Unsigned32 (1..4294967295)
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "Unique index for a logged service flow."
    ::= { docsQosServiceFlowLogEntry 1 }

docsQosServiceFlowLogIfIndex OBJECT-TYPE
    SYNTAX          InterfaceIndex
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The ifIndex of ifType docsCableMaclayer(127)
                     on the CMTS where the service flow was present."
    ::= {  docsQosServiceFlowLogEntry 2 }

docsQosServiceFlowLogSFID    OBJECT-TYPE
    SYNTAX          Unsigned32 (1..4294967295)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The index assigned to the service flow by the CMTS."
    ::= {  docsQosServiceFlowLogEntry 3 }

docsQosServiceFlowLogCmMac OBJECT-TYPE
    SYNTAX          MacAddress
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The MAC address for the cable modem associated with
                     the service flow."
    ::= { docsQosServiceFlowLogEntry 4 }

docsQosServiceFlowLogPkts OBJECT-TYPE
    SYNTAX          Counter64
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of packets counted on this service flow
                    after payload header suppression."
    ::= { docsQosServiceFlowLogEntry 5 }

docsQosServiceFlowLogOctets OBJECT-TYPE
    SYNTAX          Counter64
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The number of octets counted on this service flow
                    after payload header suppression."
    ::= { docsQosServiceFlowLogEntry 6 }

docsQosServiceFlowLogTimeDeleted OBJECT-TYPE
    SYNTAX          TimeStamp
    MAX-ACCESS      read-only



Expires September 2003                             [Page 59]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    STATUS          current
    DESCRIPTION    "The value of sysUpTime when the service flow
                    was deleted."
    ::= { docsQosServiceFlowLogEntry 7 }

docsQosServiceFlowLogTimeCreated OBJECT-TYPE
    SYNTAX          TimeStamp
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The value of sysUpTime when the service flow
                    was created."
    ::= { docsQosServiceFlowLogEntry 8 }

docsQosServiceFlowLogTimeActive OBJECT-TYPE
    SYNTAX          Counter32
    UNITS           "seconds"
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The total time that service flow was active."
    ::= { docsQosServiceFlowLogEntry 9 }

docsQosServiceFlowLogDirection OBJECT-TYPE
    SYNTAX          DocsQosRfMacIfDirection
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The value of docsQosServiceFlowDirection
                    for the service flow."
    ::= { docsQosServiceFlowLogEntry  10 }

docsQosServiceFlowLogPrimary OBJECT-TYPE
    SYNTAX          TruthValue
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The value of docsQosServiceFlowPrimary for the
                    service flow."
    ::= { docsQosServiceFlowLogEntry 11 }

docsQosServiceFlowLogServiceClassName OBJECT-TYPE
    SYNTAX          DisplayString
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The value of docsQosParamSetServiceClassName for
                    the provisioned QOS Parameter Set of the
                    service flow."
    ::= { docsQosServiceFlowLogEntry  12 }

docsQosServiceFlowLogPolicedDropPkts OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The final value of docsQosServiceFlowPolicedDropPkts



Expires September 2003                             [Page 60]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    for the service flow."
    ::= { docsQosServiceFlowLogEntry  13 }

docsQosServiceFlowLogPolicedDelayPkts OBJECT-TYPE
    SYNTAX          Counter32
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "The final value of docsQosServiceFlowPolicedDelayPkts
                    for the service flow."
    ::= { docsQosServiceFlowLogEntry  14 }

docsQosServiceFlowLogControl OBJECT-TYPE
    SYNTAX          INTEGER {
                     active(1),
                     destroy(6)
                    }

    MAX-ACCESS      read-write
    STATUS          current
    DESCRIPTION    "Setting this object to the value destroy(6) removes
                    this entry from the table.
                    Reading this object return the value active(1)."
    ::= { docsQosServiceFlowLogEntry 15 }

--
-- Service Class Table (CMTS ONLY)
--
docsQosServiceClassTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosServiceClassEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table describes the set of Docsis-QOS
                     Service Classes in a CMTS. "
    ::= { docsQosMIBObjects 8 }

docsQosServiceClassEntry OBJECT-TYPE
    SYNTAX          DocsQosServiceClassEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "A provisioned service class on a CMTS.
                Each entry defines a template for certain
                DOCSIS QOS Parameter Set values. When a CM
                creates or modifies an Admitted QOS Parameter Set for a
                Service Flow, it may reference a Service Class
                Name instead of providing explicit QOS Parameter
                Set values. In this case, the CMTS populates
                the QOS Parameter Set with the applicable
                corresponding values from the named Service Class.
                Subsequent changes to a Service Class row do *not*
                affect the QOS Parameter Set values of any service flows
                already admitted.



Expires September 2003                             [Page 61]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003




                A service class template applies to only
                a single direction, as indicated in the
                docsQosServiceClassDirection object.
                "
    INDEX {
             docsQosServiceClassName
          }
    ::= { docsQosServiceClassTable 1 }

DocsQosServiceClassEntry ::= SEQUENCE {
    docsQosServiceClassName               DisplayString,
    docsQosServiceClassStatus             RowStatus,
    docsQosServiceClassPriority           Integer32,
    docsQosServiceClassMaxTrafficRate     DocsQosBitRate,
    docsQosServiceClassMaxTrafficBurst    Unsigned32,
    docsQosServiceClassMinReservedRate    DocsQosBitRate,
    docsQosServiceClassMinReservedPkt     Integer32,
    docsQosServiceClassMaxConcatBurst     Integer32,
    docsQosServiceClassNomPollInterval    Unsigned32,
    docsQosServiceClassTolPollJitter      Unsigned32,
    docsQosServiceClassUnsolicitGrantSize Integer32,
    docsQosServiceClassNomGrantInterval   Unsigned32,
    docsQosServiceClassTolGrantJitter     Unsigned32,
    docsQosServiceClassGrantsPerInterval  Integer32,
    docsQosServiceClassMaxLatency         Unsigned32,
    docsQosServiceClassActiveTimeout      Integer32,
    docsQosServiceClassAdmittedTimeout    Integer32,
    docsQosServiceClassSchedulingType     DocsQosSchedulingType,
    docsQosServiceClassRequestPolicy      OCTET STRING,
    docsQosServiceClassTosAndMask         OCTET STRING,
    docsQosServiceClassTosOrMask          OCTET STRING,
    docsQosServiceClassDirection          DocsQosRfMacIfDirection,
    docsQosServiceClassStorageType        StorageType
    }

docsQosServiceClassName OBJECT-TYPE
    SYNTAX          DisplayString (SIZE(2..15))
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "Service Class Name. DOCSIS specifies that the
                    maximum size is 16 ASCII characters including
                    a terminating zero. The terminating zero is not
                    represented in this DisplayString syntax object.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.3.4"
    ::= { docsQosServiceClassEntry 1 }

docsQosServiceClassStatus OBJECT-TYPE
    SYNTAX          RowStatus
    MAX-ACCESS      read-create



Expires September 2003                             [Page 62]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    STATUS          current
    DESCRIPTION    "Used to create or delete rows in this table.
                   There is no restriction on the ability
                   to change values in this row while the row is active.
                   Inactive rows need not be timed out."
    ::= { docsQosServiceClassEntry 2 }

docsQosServiceClassPriority OBJECT-TYPE
    SYNTAX          Integer32 (0..7)
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetPriority."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 3 }

docsQosServiceClassMaxTrafficRate OBJECT-TYPE
    SYNTAX          DocsQosBitRate
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetMaxTrafficRate."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 4 }

docsQosServiceClassMaxTrafficBurst OBJECT-TYPE
    SYNTAX          Unsigned32
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetMaxTrafficBurst."
    DEFVAL          { 3044 }
    ::= { docsQosServiceClassEntry 5 }

docsQosServiceClassMinReservedRate OBJECT-TYPE
    SYNTAX          DocsQosBitRate
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSEtMinReservedRate."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 6 }

docsQosServiceClassMinReservedPkt OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetMinReservedPkt."
    ::= { docsQosServiceClassEntry 7 }

docsQosServiceClassMaxConcatBurst OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetMaxConcatBurst."



Expires September 2003                             [Page 63]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    DEFVAL          { 1522 }
    ::= { docsQosServiceClassEntry 8 }

docsQosServiceClassNomPollInterval OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetNomPollInterval."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 9 }

docsQosServiceClassTolPollJitter OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetTolPollJitter."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 10 }

docsQosServiceClassUnsolicitGrantSize OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetUnsolicitGrantSize."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 11 }

docsQosServiceClassNomGrantInterval OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetNomGrantInterval."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 12 }

docsQosServiceClassTolGrantJitter OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetTolGrantJitter."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 13 }

docsQosServiceClassGrantsPerInterval OBJECT-TYPE
    SYNTAX          Integer32 (0..127)
    MAX-ACCESS      read-create
    STATUS          current



Expires September 2003                             [Page 64]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    DESCRIPTION    "Template for docsQosParamSetGrantsPerInterval."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 14 }

docsQosServiceClassMaxLatency OBJECT-TYPE
    SYNTAX          Unsigned32
    UNITS           "microseconds"
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetClassMaxLatency."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.2.7.1"
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 15 }

docsQosServiceClassActiveTimeout OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    UNITS           "seconds"
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetActiveTimeout."
    DEFVAL          { 0 }
    ::= { docsQosServiceClassEntry 16 }

docsQosServiceClassAdmittedTimeout OBJECT-TYPE
    SYNTAX          Integer32 (0..65535)
    UNITS           "seconds"
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetAdmittedTimeout."
    DEFVAL          { 200 }
    ::= { docsQosServiceClassEntry 17 }

docsQosServiceClassSchedulingType OBJECT-TYPE
    SYNTAX          DocsQosSchedulingType
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetSchedulingType."
    DEFVAL          { bestEffort }
    ::= { docsQosServiceClassEntry 18 }

docsQosServiceClassRequestPolicy OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(4))
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetRequestPolicyOct."
    DEFVAL          { '00000000'H } -- no bits are set
    ::= { docsQosServiceClassEntry 19 }

docsQosServiceClassTosAndMask OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(1))
    MAX-ACCESS      read-create



Expires September 2003                             [Page 65]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetTosAndMask."
    DEFVAL          { 'FF'H }
    ::= { docsQosServiceClassEntry 20 }

docsQosServiceClassTosOrMask OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(1))
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Template for docsQosParamSetTosOrMask."
    DEFVAL          { '00'H }
    ::= { docsQosServiceClassEntry 21 }

docsQosServiceClassDirection OBJECT-TYPE
    SYNTAX          DocsQosRfMacIfDirection
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Specifies whether the service class template
                    applies to upstream or downstream service flows."
    DEFVAL          { upstream }
    ::= { docsQosServiceClassEntry 22 }

docsQosServiceClassStorageType OBJECT-TYPE
    SYNTAX          StorageType
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "This object defines whether this row is kept in
                    volatile storage and lost upon reboot or if this
                    row is backed up by non-volatile or permanent
                    storage. 'permanent' entries need not allow
                    writable access to any object."
    DEFVAL { nonVolatile }
    ::= { docsQosServiceClassEntry 23 }

--
-- Service Class PolicyTable
--
docsQosServiceClassPolicyTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosServiceClassPolicyEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "This table describes the set of Docsis-QOS
                    Service Class Policies.

                    This table is an adjunct to the
                    docsDevFilterPolicy table.  Entries in
                    docsDevFilterPolicy table can  point to
                    specific rows in this table.

                    This table permits mapping a packet to a service
                    class name of an active service flow so long as



Expires September 2003                             [Page 66]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    a classifier does not exist at a higher
                    priority.
                   "
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix E.2.1"
    ::= { docsQosMIBObjects 9 }

docsQosServiceClassPolicyEntry OBJECT-TYPE
    SYNTAX          DocsQosServiceClassPolicyEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "A service class name policy entry."
    INDEX {
            docsQosServiceClassPolicyIndex
          }
    ::= { docsQosServiceClassPolicyTable 1 }

DocsQosServiceClassPolicyEntry ::= SEQUENCE {
    docsQosServiceClassPolicyIndex        Unsigned32,
    docsQosServiceClassPolicyName         DisplayString,
    docsQosServiceClassPolicyRulePriority Integer32,
    docsQosServiceClassPolicyStatus       RowStatus,
    docsQosServiceClassPolicyStorageType  StorageType
    }

docsQosServiceClassPolicyIndex OBJECT-TYPE
    SYNTAX          Unsigned32 (1..2147483647)
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "Index value to uniquely identify an entry in
                    this table."
    ::= { docsQosServiceClassPolicyEntry 1 }

docsQosServiceClassPolicyName OBJECT-TYPE
    SYNTAX          DisplayString
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Service Class Name to identify the name of the
                    service class flow to which the packet should be
                    directed."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix E.2.1"
    ::= { docsQosServiceClassPolicyEntry 2 }

docsQosServiceClassPolicyRulePriority OBJECT-TYPE
    SYNTAX          Integer32 (0..255)
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Service Class Policy rule priority for the
                    entry."
    REFERENCE      "SP-RFIv1.1-I09-020830, Appendix C.2.1.3.5"
    ::= { docsQosServiceClassPolicyEntry 3 }




Expires September 2003                             [Page 67]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



docsQosServiceClassPolicyStatus OBJECT-TYPE
    SYNTAX          RowStatus
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "Used to create or delete rows in this table.
                    This object should not be deleted if it is
                    reference by an entry in docsDevFilterPolicy.
                    The reference should be deleted first.
                    There is no restriction on the ability
                    to change values in this row while the row is active.
                    Inactive rows need not be timed out."
    ::= { docsQosServiceClassPolicyEntry 4 }

docsQosServiceClassPolicyStorageType OBJECT-TYPE
    SYNTAX          StorageType
    MAX-ACCESS      read-create
    STATUS          current
    DESCRIPTION    "This object defines whether this row is kept in
                    volatile storage and lost upon reboot or if this
                    row is backed up by non-volatile or permanent
                    storage. 'permanent' entries need not allow
                    writable access to any object."
    DEFVAL { nonVolatile }
    ::= { docsQosServiceClassPolicyEntry 5 }

--
-- Payload Header Suppression(PHS) Table
--
docsQosPHSTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosPHSEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table describes set of payload header
                     suppression entries."
    ::= { docsQosMIBObjects 10 }

docsQosPHSEntry OBJECT-TYPE
    SYNTAX          DocsQosPHSEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "A payload header suppression entry.
                     The ifIndex is an ifType of docsCableMaclayer(127).
                     The index docsQosServiceFlowId selects one
                     service flow from the cable MAC layer interface.
                     The docsQosPktClassId index matches an
                     index of the docsQosPktClassTable.
                    "
    INDEX {
            ifIndex,
            docsQosServiceFlowId,
            docsQosPktClassId



Expires September 2003                             [Page 68]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



          }
    ::= { docsQosPHSTable 1 }

DocsQosPHSEntry ::= SEQUENCE {
    docsQosPHSField            OCTET STRING,
    docsQosPHSMask             OCTET STRING,
    docsQosPHSSize             Integer32,
    docsQosPHSVerify           TruthValue,
    docsQosPHSIndex            Integer32
    }

-- docsQosPHSIndex {  docsQosPHSEntry 1 } was
-- moved to  docsQosPHSIndex {  docsQosPHSEntry 7 }
-- in an ealier revisions of the mib.

docsQosPHSField         OBJECT-TYPE
    SYNTAX          OCTET STRING (SIZE(0..255))
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Payload header suppression field defines the
                    bytes of the header which must be
                    suppressed/restored by the sending/receiving
                    device.

                    The number of octets in this object should be
                    the same as the value of docsQosPHSSize."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.2.10.1"
    ::= { docsQosPHSEntry 2 }

docsQosPHSMask          OBJECT-TYPE
    SYNTAX          OCTET STRING(SIZE(0..32))
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Payload header suppression mask defines the
                    bit mask which used in combination with the
                    docsQosPHSField defines which bytes in header
                    must be suppressed/restored by the sending or
                    receiving device.

                    Each bit of this bit mask corresponds to a byte
                    in the docsQosPHSField, with the least
                    significant  bit corresponding to first byte of
                    the docsQosPHSField.

                    Each bit of the bit mask specifies whether of
                    not the corresponding byte should be suppressed
                    in the packet. A bit value of '1' indicates that
                    the byte should be suppressed by the sending
                    device and restored by the receiving device.
                    A bit value of '0' indicates that
                    the byte should not be suppressed by the sending



Expires September 2003                             [Page 69]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                    device or restored by the receiving device.

                    If the bit mask does not contain a bit for each
                    byte in the docsQosPHSField then the bit mask is
                    extended with bit values of '1' to be the
                    necessary length."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.2.10.3"
    ::= { docsQosPHSEntry 3 }

docsQosPHSSize          OBJECT-TYPE
    SYNTAX          Integer32 (0..255)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Payload header suppression size specifies the
                    number of bytes in the header to be suppressed
                    and restored.

                    The value of this object must match the number
                    of bytes in the docsQosPHSField."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.2.10.4"
    ::= { docsQosPHSEntry 4 }

docsQosPHSVerify       OBJECT-TYPE
    SYNTAX          TruthValue
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Payload header suppression verification value of
                    'true' the sender must verify docsQosPHSField
                    is the same as what is contained in the packet
                    to be suppressed."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.2.10.5"
    ::= { docsQosPHSEntry 5 }

docsQosPHSIndex         OBJECT-TYPE
    SYNTAX          Integer32 (1..255)
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION    "Payload header suppression index uniquely
                    references the PHS rule for a given service flow."
    REFERENCE       "SP-RFIv1.1-I09-020830, Appendix C.2.2.10.2"
    ::= { docsQosPHSEntry 6 }


--
-- docsQosCmtsMacToSrvFlowTable (CMTS Only)
--
docsQosCmtsMacToSrvFlowTable OBJECT-TYPE
    SYNTAX          SEQUENCE OF DocsQosCmtsMacToSrvFlowEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "This table provide for referencing the service flows



Expires September 2003                             [Page 70]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



                     associated with a particular cable modem. This allows
                     for indexing into other docsQos tables that are
                     indexed by docsQosServiceFlowId and ifIndex."
    ::= { docsQosMIBObjects 11 }

docsQosCmtsMacToSrvFlowEntry OBJECT-TYPE
    SYNTAX          DocsQosCmtsMacToSrvFlowEntry
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "An entry is created by CMTS for each service flow
                     connected to this CMTS."
    INDEX {
            docsQosCmtsCmMac,
            docsQosCmtsServiceFlowId
          }
    ::= { docsQosCmtsMacToSrvFlowTable 1 }

DocsQosCmtsMacToSrvFlowEntry ::= SEQUENCE {
    docsQosCmtsCmMac                MacAddress,
    docsQosCmtsServiceFlowId        Unsigned32,
    docsQosCmtsIfIndex              InterfaceIndex
    }

docsQosCmtsCmMac OBJECT-TYPE
    SYNTAX          MacAddress
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION     "The MAC address for the referenced CM."
    ::= { docsQosCmtsMacToSrvFlowEntry 1 }

docsQosCmtsServiceFlowId OBJECT-TYPE
    SYNTAX          Unsigned32 (1..4294967295)
    MAX-ACCESS      not-accessible
    STATUS          current
    DESCRIPTION    "An index assigned to a service flow by CMTS."
    ::= { docsQosCmtsMacToSrvFlowEntry 2 }

docsQosCmtsIfIndex OBJECT-TYPE
    SYNTAX          InterfaceIndex
    MAX-ACCESS      read-only
    STATUS          current
    DESCRIPTION     "The ifIndex of ifType docsCableMacLayter(127)
                     on the CMTS that is connected to the Cable Modem."
    ::= { docsQosCmtsMacToSrvFlowEntry 3 }


--
-- Placeholder for notifications/traps.
--
docsQosNotification OBJECT IDENTIFIER   ::= { docsQosMIB 2 }




Expires September 2003                             [Page 71]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



--
-- Conformance definitions
--
docsQosConformance  OBJECT IDENTIFIER   ::= { docsQosMIB 3 }
docsQosGroups       OBJECT IDENTIFIER   ::= { docsQosConformance 1 }
docsQosCompliances  OBJECT IDENTIFIER   ::= { docsQosConformance 2 }

docsQosCompliance MODULE-COMPLIANCE
    STATUS  current
    DESCRIPTION
        "The compliance statement for MCNS Cable Modems and
         Cable Modem Termination Systems that implement DOCSIS
         Service Flows."

    MODULE  -- docsQosMIB
        MANDATORY-GROUPS { docsQosBaseGroup }

        GROUP docsQosCmtsGroup
        DESCRIPTION
            "This group is mandatory for only Cable Modem Termination
             Systems (CMTS) and not implemented for Cable Modems."

        GROUP docsQosParamSetGroup
        DESCRIPTION
            "This group is mandatory for Cable Modem Termination
             Systems (CMTS) and Cable Modems. Cable modems only implement
             objects in this group as read-only."

        GROUP docsQosSrvClassPolicyGroup
        DESCRIPTION
            "This group is optional for Cable Modem Termination
             Systems (CMTS) and Cable Modems. This group only needs to
             be implement if policy based service flow classification
             is implemented. See docsDevPolicyTable in
             DOCS-CABLE-DEVICE-MIB for more details. "

        GROUP docsQosServiceClassGroup
        DESCRIPTION
            "The docsQosServiceClassTable group of objects."

        OBJECT  docsQosPktClassPkts
        DESCRIPTION
            "This object only needs to be implemented in entries
             that are classifying packets and not policing packets."

        OBJECT  docsQosPktClassInetAddressType
        SYNTAX InetAddressType { ipv4(1) }
        DESCRIPTION
            "An implementation is only required to support IPv4
             address."




Expires September 2003                             [Page 72]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



        OBJECT  docsQosPktClassInetSourceAddr
        SYNTAX InetAddress (SIZE(4))
        DESCRIPTION
            "An implementation is only required to support IPv4
             address."

        OBJECT  docsQosPktClassInetSourceMask
        SYNTAX InetAddress (SIZE(4))
        DESCRIPTION
            "An implementation is only required to support IPv4
             address."

        OBJECT  docsQosPktClassInetDestAddr
        SYNTAX InetAddress (SIZE(4))
        DESCRIPTION
            "An implementation is only required to support IPv4
             address."

        OBJECT  docsQosPktClassInetDestMask
        SYNTAX InetAddress (SIZE(4))
        DESCRIPTION
            "An implementation is only required to support IPv4
             address."

        OBJECT  docsQosServiceClassStorageType
        SYNTAX StorageType { nonVolatile(3) }
        DESCRIPTION
            "An implementation is only required to support nonvolatile
             storage."

        OBJECT  docsQosServiceClassPolicyStorageType
        SYNTAX StorageType { nonVolatile(3) }
        DESCRIPTION
            "An implementation is only required to support nonvolatile
             storage."

    ::= { docsQosCompliances 1 }

docsQosBaseGroup OBJECT-GROUP
    OBJECTS {
    docsQosPktClassDirection,
    docsQosPktClassPriority,
    docsQosPktClassIpTosLow,
    docsQosPktClassIpTosHigh,
    docsQosPktClassIpTosMask,
    docsQosPktClassIpProtocol,
    docsQosPktClassSourcePortStart,
    docsQosPktClassSourcePortEnd,
    docsQosPktClassDestPortStart,
    docsQosPktClassDestPortEnd,
    docsQosPktClassDestMacAddr,



Expires September 2003                             [Page 73]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    docsQosPktClassDestMacMask,
    docsQosPktClassSourceMacAddr,
    docsQosPktClassEnetProtocolType,
    docsQosPktClassEnetProtocol,
    docsQosPktClassUserPriLow,
    docsQosPktClassUserPriHigh,
    docsQosPktClassVlanId,
    docsQosPktClassStateActive,
    docsQosPktClassPkts,
    docsQosPktClassBitMap,
    docsQosPktClassInetAddressType,
    docsQosPktClassInetSourceAddr,
    docsQosPktClassInetSourceMask,
    docsQosPktClassInetDestAddr,
    docsQosPktClassInetDestMask,

    docsQosServiceFlowSID,
    docsQosServiceFlowDirection,
    docsQosServiceFlowPrimary,

    docsQosServiceFlowPkts,   -- not sure if CM should implement
    docsQosServiceFlowOctets,
    docsQosServiceFlowTimeCreated,
    docsQosServiceFlowTimeActive,
    docsQosServiceFlowPHSUnknowns,
    docsQosServiceFlowPolicedDropPkts,
    docsQosServiceFlowPolicedDelayPkts,

    docsQosDSAReqs,
    docsQosDSARsps,
    docsQosDSAAcks,
    docsQosDSCReqs,
    docsQosDSCRsps,
    docsQosDSCAcks,
    docsQosDSDReqs,
    docsQosDSDRsps,
    docsQosDynamicAdds,
    docsQosDynamicAddFails,
    docsQosDynamicChanges,
    docsQosDynamicChangeFails,
    docsQosDynamicDeletes,
    docsQosDynamicDeleteFails,
    docsQosDCCReqs,
    docsQosDCCRsps,
    docsQosDCCAcks,
    docsQosDCCs,
    docsQosDCCFails,

    docsQosPHSField,
    docsQosPHSMask,
    docsQosPHSSize,



Expires September 2003                             [Page 74]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    docsQosPHSVerify,
    docsQosPHSIndex
    }
    STATUS  current
    DESCRIPTION
        "Group of objects implemented in both Cable Modems and
         Cable Modem Termination Systems."
    ::= { docsQosGroups 1 }

docsQosParamSetGroup OBJECT-GROUP
    OBJECTS {
    docsQosParamSetServiceClassName,
    docsQosParamSetPriority,
    docsQosParamSetMaxTrafficRate,
    docsQosParamSetMaxTrafficBurst,
    docsQosParamSetMinReservedRate,
    docsQosParamSetMinReservedPkt,
    docsQosParamSetActiveTimeout,
    docsQosParamSetAdmittedTimeout,
    docsQosParamSetMaxConcatBurst,
    docsQosParamSetSchedulingType,
    docsQosParamSetNomPollInterval,
    docsQosParamSetTolPollJitter,
    docsQosParamSetUnsolicitGrantSize,
    docsQosParamSetNomGrantInterval,
    docsQosParamSetTolGrantJitter,
    docsQosParamSetGrantsPerInterval,
    docsQosParamSetTosAndMask,
    docsQosParamSetTosOrMask,
    docsQosParamSetMaxLatency,
    docsQosParamSetRequestPolicyOct,
    docsQosParamSetBitMap
    }
    STATUS  current
    DESCRIPTION
        "Group of objects implemenented in both Cable Modems and
         Cable Modem Termination Systems for QOS parameter sets."
    ::= { docsQosGroups 2 }


docsQosCmtsGroup OBJECT-GROUP
    OBJECTS {

    docsQosUpstreamFragments,
    docsQosUpstreamFragDiscards,
    docsQosUpstreamConcatBursts,

    docsQosServiceFlowLogIfIndex,
    docsQosServiceFlowLogSFID,
    docsQosServiceFlowLogCmMac,
    docsQosServiceFlowLogPkts,



Expires September 2003                             [Page 75]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    docsQosServiceFlowLogOctets,
    docsQosServiceFlowLogTimeDeleted,
    docsQosServiceFlowLogTimeCreated,
    docsQosServiceFlowLogTimeActive,
    docsQosServiceFlowLogDirection,
    docsQosServiceFlowLogPrimary,
    docsQosServiceFlowLogServiceClassName,
    docsQosServiceFlowLogPolicedDropPkts,
    docsQosServiceFlowLogPolicedDelayPkts,
    docsQosServiceFlowLogControl,

    docsQosCmtsIfIndex        -- docsQosCmtsMacToSrvFlowTable required

    }
    STATUS  current
    DESCRIPTION
        "Mandatory group of objects implemented only in the CMTS."
    ::= { docsQosGroups 3 }

docsQosSrvClassPolicyGroup OBJECT-GROUP
    OBJECTS {
    docsQosServiceClassPolicyName,
    docsQosServiceClassPolicyRulePriority,
    docsQosServiceClassPolicyStatus,
    docsQosServiceClassPolicyStorageType
    }
    STATUS  current
    DESCRIPTION
        "Group of objects implemented in both Cable Modems and
         Cable Modem Termination Systems when supporting policy based
         service flows."
    ::= { docsQosGroups 4 }

docsQosServiceClassGroup OBJECT-GROUP
    OBJECTS {
    docsQosServiceClassStatus,
    docsQosServiceClassPriority,
    docsQosServiceClassMaxTrafficRate,
    docsQosServiceClassMaxTrafficBurst,
    docsQosServiceClassMinReservedRate,
    docsQosServiceClassMinReservedPkt,
    docsQosServiceClassMaxConcatBurst,
    docsQosServiceClassNomPollInterval,
    docsQosServiceClassTolPollJitter,
    docsQosServiceClassUnsolicitGrantSize,
    docsQosServiceClassNomGrantInterval,
    docsQosServiceClassTolGrantJitter,
    docsQosServiceClassGrantsPerInterval,
    docsQosServiceClassMaxLatency,
    docsQosServiceClassActiveTimeout,
    docsQosServiceClassAdmittedTimeout,



Expires September 2003                             [Page 76]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



    docsQosServiceClassSchedulingType,
    docsQosServiceClassRequestPolicy,
    docsQosServiceClassTosAndMask,
    docsQosServiceClassTosOrMask,
    docsQosServiceClassDirection,
    docsQosServiceClassStorageType
    }
    STATUS  current
    DESCRIPTION
        "The docsQosServiceClassTable objects. If a CMTS implements
         expansion of Service Class Names in a QOS Parameter Set,
         this group is mandatory on the CMTS. If the CMTS does not
         support Service Class Names, this group may be unimplemented
         in the CMTS. This group is not implemented on the CM.
        "
    ::= { docsQosGroups 5 }

END




































Expires September 2003                             [Page 77]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



5.  Security Considerations


   This MIB relates to a agent which will provide metropolitan public
   internet access.  As such, improper manipulation of the objects
   represented by this MIB may result in denial of service to a large
   number of end-users [9].  Manipulation of the
   docsQosServiceClassTable and docsQosServiceClassPolicyTable may allow
   an end-user to increase their service levels, or affect other end-
   users in either a positive or negative manner.  In addition,
   manipulation of docsQosServiceFlowLogControl could allow an attacker
   to remove logs of packet and byte counts forwarded on a service flow.
   If such logs were used for billing, the attacker would obtain free
   service.

   There are a number of management objects defined in this MIB module
   with a MAX-ACCESS clause of read-write and/or read-create.  Such
   objects may be considered sensitive or vulnerable in some network
   environments.  The support for SET operations in a non-secure
   environment without proper protection can have a negative effect on
   network operations.  These are the tables and objects and their
   sensitivity/vulnerability:

     o    The docsQosServiceClassTable provides a template of QOS
          parameters such as maximum rate limits for a named service
          class. Changing these parameters would allow an attacker to
          obtain unauthorized class of service.

     o    The docsQosServiceClassPolicyTable applies CMTS vendor
          proprietary policies for packet forwarding, including
          dropping, scheduling, notification, or other policies.
          Changing this table could  allow an attacker to deny service
          to all subscribers of the CMTS or grant the attacker
          unauthorized forwarding policies.

     o    The docsQosServiceFlowLogControl object controls the deletion
          of entries in the docsQosServiceFlowLogTable, which acts as a
          historical "detail record" of DOCSIS service flow packets and
          bytes transmitted. Such records may be used for billing
          purposes, so the unauthorized deletion of the records can
          result in free service.

   Some of the readable objects in this MIB module (i.e., objects with a
   MAX-ACCESS other than not-accessible) may be considered sensitive or
   vulnerable in some network environments.  It is thus important to
   control even GET access to these objects and possibly to even encrypt
   the values of these objects when sending them over the network via
   SNMP.  These are the tables and objects and their
   sensitivity/vulnerability:

     o    Unauthorized SNMP GET access of the docsQosPktClassTable or



Expires September 2003                             [Page 78]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



          docsQosPHSTable can allow an attacker to learn IP addresses
          permitted to have enhanced quality of service, for possible
          spoofing.  This table typically contains the IP addresses
          involved in voice-over-IP sessions, for example.

     o    Unauthorized SNMP GET access of the docsQosParamSetTable
          allows an attacker to learn the names of service classes
          which are permitted to have enhanced QOS service, and the
          values of that enhanced service. That name can be referenced
          in an unauthorized DOCSIS cable modem configuration file to
          obtain enhanced service.

     o    Unauthorized SNMP GET access of the docsQosServiceFlowTable
          can tell an attacker when service flows are active, e.g.
          when a voice-over-IP call is in progress.

     o    Unauthorized SNMP GET access of the
          docsQosServiceFlowStatsTable, docsQosUpstreamStatsTable,
          docsQosDynamicServiceStatsTable, docsQosServiceFlogLogTable,
          and docsQosCmtsMacToSrvFlowTable can tell an attacker the
          volume of traffic to and from any service flow in the system,
          resulting in loss of privacy of the amount and direction of
          data transfer.

   SNMP versions prior to SNMPv3 did not include adequate security.
   Even if the network itself is secure (for example by using IPSec),
   even then, there is no control as to who on the secure network is
   allowed to access and GET/SET (read/change/create/delete) the objects
   in this MIB module.  It is RECOMMENDED that implementers consider the
   security features as provided by the SNMPv3 framework (see [13],
   section 8), including full support for the SNMPv3 cryptographic
   mechanisms (for authentication and privacy).  Further, deployment of
   SNMP versions prior to SNMPv3 is NOT RECOMMENDED. Instead, it is
   RECOMMENDED to deploy SNMPv3 and to enable cryptographic security.
   It is then a customer/operator responsibility to ensure that the SNMP
   entity giving access to an instance of this MIB module, is properly
   configured to give access to the objects only to those principals
   (users) that have legitimate rights to indeed GET or SET
   (change/create/delete) them.



6.  Intellectual Property

   The IETF takes no position regarding the validity or scope of any
   intellectual property or other rights that might be claimed to
   pertain to the implementation or use of the technology described in
   this document or the extent to which any license under such rights
   might or might not be available; neither does it represent that it
   has made any effort to identify any such rights.  Information on the
   IETF's procedures with respect to rights in standards-track and



Expires September 2003                             [Page 79]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   standards-related documentation can be found in BCP-11.  Copies of
   claims of rights made available for publication and any assurances of
   licenses to be made available, or the result of an attempt made to
   obtain a general license or permission for the use of such
   proprietary rights by implementers or users of this specification can
   be obtained from the IETF Secretariat.

   The IETF invites any interested party to bring to its attention any
   copyrights, patents or patent applications, or other proprietary
   rights which may cover technology that may be required to practice
   this standard.  Please address the information to the IETF Executive
   Director.



7.  Acknowledgement

   Funding for the RFC Editor function is currently provided by the
   Internet Society.



8.  Normative References

   [1]  McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Structure of
        Management Information for Version 2 (SMIv2)",  STD 58,
        RFC 2578, April 1999.

   [2]  McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Textual
        Conventions for SMIv2", STD 58, RFC 2579, April 1999.

   [3]  McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Conformance
        Statements for SMIv2", STD 58, RFC 2580, April 1999.

   [4] "Data-Over-Cable Service Interface Specifications:
       Radio Frequency Interface Specification SP-RFIv1.1-I09-020830",
       DOCSIS, August 2002, http://www.cablemodem.com/.

   [5] L. Steinberg, "Techniques for Managing Asynchronously Generated
       Alerts", RFC 1224, May 1991.

   [6] "Data-Over-Cable Service Interface Specifications: Operations
       Support System Interface Specification SP-OSSIv1.1-I06-020830",
       DOCSIS, August 2002, http://www.cablemodem.com/.

   [7] Bradner, S., "Key words for use in RFCs to Indicate Requirement
       Levels", RFC2119, March 1997.

   [8] "Data-Over-Cable Service Interface Specifications: Baseline
       Privacy Plus Interface Specification SP-BPI+-I07-020830",
       DOCSIS,  August 2002, http://www.cablemodem.com/.



Expires September 2003                             [Page 80]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



   [9] St. Johns, M., "Cable Device Management Information Base for
       DOCSIS compliant Cable Modems and Cable Modem Termination
       Systems", RFC 2669, August 1999.

   [10] St. Johns, M., "Radio Frequency (RF) Interface Management
        Information Base for MCNS/DOCSIS compliant RF interfaces",
        RFC 2670, August 1999.

   [11] Daniele, M. et. al.,"Textual Conventions for Internet Network
        Addresses", RFC 2851, June 2000.

   [12] "Data-Over-Cable Service Interface Specifications:
        Radio Frequency Interface Specification SP-RFIv2.0-I03-021218",
        DOCSIS, December 2002, http://www.cablemodem.com/.



9.  Informative References

   [13] Case, J., Mundy, R., Partain, D. and B. Stewart,
        "Introduction and Applicability Statements for Internet-
        Standard Management Framework", RFC 3410, December 2002.



10.  Author's Address

   Michael Patrick
   Motorola Broadband Communications Sector
   20 Cabot Blvd., MS M2-330
   Mansfield, MA 02048
   Phone: (508) 851-8402
   Email: michael.patrick@motorola.com

   William Murwin
   Motorola Broadband Communications Sector
   20 Cabot Blvd., MS M2-330
   Mansfield, MA 02048
   Phone: (508) 851-8385
   Email: w.murwin@motorola.com














Expires September 2003                             [Page 81]


INTERNET-DRAFT<draft-ietf-ipcdn-qos-mib-08.txt>   March 2003



11.  Full Copyright Statement

   Copyright (C) The Internet Society (2003). All Rights Reserved.

   This document and translations of it may be copied and furnished to
   others, and derivative works that comment on or otherwise explain it
   or assist in its implementation may be prepared, copied, published
   and distributed, in whole or in part, without restriction of any
   kind, provided that the above copyright notice and this paragraph are
   included on all such copies and derivative works.  However, this
   document itself may not be modified in any way, such as by removing
   the copyright notice or references to the Internet Society or other
   Internet organizations, except as needed for the  purpose of
   developing Internet standards in which case the procedures for
   copyrights defined in the Internet Standards process must be
   followed, or as required to translate it into languages other than
   English.

   The limited permissions granted above are perpetual and will not be
   revoked by the Internet Society or its successors or assigns.

   This document and the information contained herein is provided on an
   "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
   TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
   BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
   HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
   MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.



























Expires September 2003                             [Page 82]