mibs/ietf/DOCS-IETF-QOS-MIB

   1 DOCS-IETF-QOS-MIB DEFINITIONS ::= BEGIN
   2
   3 IMPORTS
   4     MODULE-IDENTITY,
   5     OBJECT-TYPE,
   6     Integer32,
   7     Counter32,
   8     Unsigned32,
   9     Counter64,
  10     mib-2
  11       FROM SNMPv2-SMI
  12
  13     TEXTUAL-CONVENTION,
  14     MacAddress,
  15     RowStatus,
  16     TruthValue,
  17     TimeStamp,
  18     StorageType
  19       FROM SNMPv2-TC
  20
  21     OBJECT-GROUP,
  22     MODULE-COMPLIANCE
  23
  24
  25
  26       FROM SNMPv2-CONF
  27
  28     ifIndex,
  29     InterfaceIndex
  30       FROM IF-MIB
  31
  32     InetAddressType,
  33     InetAddress,
  34     InetPortNumber
  35       FROM INET-ADDRESS-MIB
  36
  37     DscpOrAny
  38       FROM DIFFSERV-DSCP-TC
  39
  40     SnmpAdminString
  41         FROM SNMP-FRAMEWORK-MIB;
  42
  43 docsIetfQosMIB   MODULE-IDENTITY
  44     LAST-UPDATED    "200601230000Z" -- January 23, 2006
  45     ORGANIZATION    "IETF IP over Cable Data Network (IPCDN)
  46                      Working Group"
  47     CONTACT-INFO
  48         "
  49          Co-Author: Michael Patrick
  50          Postal:    Motorola BCS
  51                     111 Locke Drive
  52                     Marlborough, MA 01752-7214
  53                     U.S.A.
  54          Phone:     +1 508 786 7563
  55          E-mail:    michael.patrick@motorola.com
  56
  57          Co-Author: William Murwin
  58          Postal:    Motorola BCS
  59                     111 Locke Drive
  60                     Marlborough, MA 01752-7214
  61                     U.S.A.
  62          Phone:     +1 508 786 7594
  63          E-mail:    w.murwin@motorola.com
  64
  65          IETF IPCDN Working Group
  66          General Discussion: ipcdn@ietf.org
  67          Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn
  68          Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn
  69          Co-chairs: Richard Woundy, Richard_Woundy@cable.comcast.com
  70                     Jean-Francois Mule, jfm@cablelabs.com"
  71     DESCRIPTION
  72         "This is the management information for
  73          Quality Of Service (QOS) for DOCSIS 1.1 and 2.0.
  74
  75
  76
  77          Copyright (C) The Internet Society (2006).  This version of
  78          this MIB module is part of RFC 4323; see the RFC itself for
  79          full legal notices."
  80
  81     REVISION        "200601230000Z" -- January 23, 2006
  82     DESCRIPTION
  83         "Initial version, published as RFC 4323."
  84     ::= { mib-2 127 }
  85
  86 --
  87 -- Placeholder for notifications/traps.
  88 --
  89 docsIetfQosNotifications OBJECT IDENTIFIER  ::= { docsIetfQosMIB 0 }
  90
  91 docsIetfQosMIBObjects  OBJECT IDENTIFIER ::= { docsIetfQosMIB 1 }
  92
  93 -- Textual Conventions
  94 DocsIetfQosRfMacIfDirection ::= TEXTUAL-CONVENTION
  95     STATUS          current
  96     DESCRIPTION    "Indicates a direction on an RF MAC interface.
  97
  98                     The value downstream(1) is from Cable Modem
  99                     Termination System to Cable Modem.
 100
 101                     The value upstream(2) is from Cable Modem to
 102                     Cable Modem Termination System."
 103     SYNTAX          INTEGER {
 104                        downstream(1),
 105                        upstream(2)
 106                     }
 107
 108 DocsIetfQosBitRate ::= TEXTUAL-CONVENTION
 109     DISPLAY-HINT    "d"
 110     STATUS          current
 111     DESCRIPTION    "The rate of traffic in unit of bits per second.
 112                     Used to specify traffic rate for QOS."
 113     SYNTAX          Unsigned32
 114
 115 DocsIetfQosSchedulingType ::= TEXTUAL-CONVENTION
 116     STATUS          current
 117     DESCRIPTION    "The scheduling service provided by a CMTS for an
 118                     upstream Service Flow.  If the parameter is omitted
 119                     from an upstream QOS Parameter Set, this object
 120                     takes the value of bestEffort (2).  This parameter
 121                     must be reported as undefined (1) for downstream
 122                     QOS Parameter Sets."
 123     SYNTAX          INTEGER {
 124                       undefined (1),
 125
 126
 127
 128                       bestEffort (2),
 129                       nonRealTimePollingService(3),
 130                       realTimePollingService(4),
 131                       unsolictedGrantServiceWithAD(5),
 132                       unsolictedGrantService(6)
 133                     }
 134
 135 -----------------------------------------------------------------------
 136 --
 137 -- Packet Classifier Table
 138 --
 139 docsIetfQosPktClassTable OBJECT-TYPE
 140     SYNTAX          SEQUENCE OF DocsIetfQosPktClassEntry
 141     MAX-ACCESS      not-accessible
 142     STATUS          current
 143     DESCRIPTION    "This table describes the packet classification
 144                     configured on the CM or CMTS.
 145                     The model is that a packet either received
 146                     as input from an interface or transmitted
 147                     for output on an interface may be compared
 148                     against an ordered list of rules pertaining to
 149                     the packet contents.  Each rule is a row of this
 150                     table.  A matching rule provides a Service Flow
 151                     ID to which the packet is classified.
 152                     All rules need to match for a packet to match
 153                     a classifier.
 154
 155                     The objects in this row correspond to a set of
 156                     Classifier Encoding parameters in a DOCSIS
 157                     MAC management message.  The
 158                     docsIetfQosPktClassBitMap indicates which
 159                     particular parameters were present in the
 160                     classifier as signaled in the DOCSIS message.
 161                     If the referenced parameter was not present
 162                     in the signaled DOCSIS 1.1 and 2.0 Classifier, the
 163                     corresponding object in this row reports a
 164                     value as specified in the DESCRIPTION section."
 165     ::= { docsIetfQosMIBObjects 1 }
 166
 167
 168 docsIetfQosPktClassEntry OBJECT-TYPE
 169     SYNTAX          DocsIetfQosPktClassEntry
 170     MAX-ACCESS      not-accessible
 171     STATUS          current
 172     DESCRIPTION    "An entry in this table provides a single packet
 173                     classifier rule.  The index ifIndex is an ifType
 174                     of docsCableMaclayer(127)."
 175     INDEX {
 176
 177
 178
 179             ifIndex,
 180             docsIetfQosServiceFlowId,
 181             docsIetfQosPktClassId
 182           }
 183     ::= { docsIetfQosPktClassTable 1 }
 184
 185
 186
 187 DocsIetfQosPktClassEntry ::= SEQUENCE {
 188     docsIetfQosPktClassId                  Unsigned32,
 189     docsIetfQosPktClassDirection           DocsIetfQosRfMacIfDirection,
 190     docsIetfQosPktClassPriority            Integer32,
 191     docsIetfQosPktClassIpTosLow            OCTET STRING,
 192     docsIetfQosPktClassIpTosHigh           OCTET STRING,
 193     docsIetfQosPktClassIpTosMask           OCTET STRING,
 194     docsIetfQosPktClassIpProtocol          Integer32,
 195     docsIetfQosPktClassInetAddressType     InetAddressType,
 196     docsIetfQosPktClassInetSourceAddr      InetAddress,
 197     docsIetfQosPktClassInetSourceMask      InetAddress,
 198     docsIetfQosPktClassInetDestAddr        InetAddress,
 199     docsIetfQosPktClassInetDestMask        InetAddress,
 200     docsIetfQosPktClassSourcePortStart     InetPortNumber,
 201     docsIetfQosPktClassSourcePortEnd       InetPortNumber,
 202     docsIetfQosPktClassDestPortStart       InetPortNumber,
 203     docsIetfQosPktClassDestPortEnd         InetPortNumber,
 204     docsIetfQosPktClassDestMacAddr         MacAddress,
 205     docsIetfQosPktClassDestMacMask         MacAddress,
 206     docsIetfQosPktClassSourceMacAddr       MacAddress,
 207     docsIetfQosPktClassEnetProtocolType    INTEGER,
 208     docsIetfQosPktClassEnetProtocol        Integer32,
 209     docsIetfQosPktClassUserPriLow          Integer32,
 210     docsIetfQosPktClassUserPriHigh         Integer32,
 211     docsIetfQosPktClassVlanId              Integer32,
 212     docsIetfQosPktClassStateActive         TruthValue,
 213     docsIetfQosPktClassPkts                Counter64,
 214     docsIetfQosPktClassBitMap              BITS
 215   }
 216
 217 docsIetfQosPktClassId       OBJECT-TYPE
 218     SYNTAX          Unsigned32 (1..65535)
 219     MAX-ACCESS      not-accessible
 220     STATUS          current
 221     DESCRIPTION    "Index assigned to packet classifier entry by
 222                     the CMTS, which is unique per Service Flow."
 223     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.2"
 224     ::= { docsIetfQosPktClassEntry 1 }
 225
 226 docsIetfQosPktClassDirection OBJECT-TYPE
 227
 228
 229
 230     SYNTAX          DocsIetfQosRfMacIfDirection
 231     MAX-ACCESS      read-only
 232     STATUS          current
 233     DESCRIPTION    "Indicates the direction to which the classifier
 234                     is applied."
 235     ::= { docsIetfQosPktClassEntry 2 }
 236
 237 docsIetfQosPktClassPriority OBJECT-TYPE
 238     SYNTAX          Integer32 (0..255)
 239     MAX-ACCESS      read-only
 240     STATUS          current
 241     DESCRIPTION    "The value specifies the order of evaluation
 242                     of the classifiers.
 243
 244                     The higher the value, the higher the priority.
 245                     The value of 0 is used as default in
 246                     provisioned Service Flows Classifiers.
 247                     The default value of 64 is used for dynamic
 248                     Service Flow Classifiers.
 249
 250                     If the referenced parameter is not present
 251                     in a classifier, this object reports the default
 252                     value as defined above."
 253     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.5"
 254     ::= { docsIetfQosPktClassEntry 3 }
 255
 256 docsIetfQosPktClassIpTosLow OBJECT-TYPE
 257     SYNTAX          OCTET STRING (SIZE(1))
 258     MAX-ACCESS      read-only
 259     STATUS          current
 260     DESCRIPTION    "The low value of a range of TOS byte values.
 261                     If the referenced parameter is not present
 262                     in a classifier, this object reports the value
 263                     of 0.
 264
 265                     The IP TOS octet, as originally defined in RFC 791,
 266                     has been superseded by the 6-bit Differentiated
 267                     Services Field (DSField, RFC 3260) and the 2-bit
 268                     Explicit Congestion Notification Field (ECN field,
 269                     RFC 3168).  This object is defined as an 8-bit
 270                     octet as per the DOCSIS Specification
 271                     for packet classification."
 272     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.1"
 273     ::= { docsIetfQosPktClassEntry 4 }
 274
 275 docsIetfQosPktClassIpTosHigh OBJECT-TYPE
 276     SYNTAX          OCTET STRING (SIZE(1))
 277     MAX-ACCESS      read-only
 278
 279
 280
 281     STATUS          current
 282     DESCRIPTION    "The 8-bit high value of a range of TOS byte
 283                     values.
 284
 285                     If the referenced parameter is not present
 286                     in a classifier, this object reports the
 287                     value of 0.
 288
 289                     The IP TOS octet as originally defined in RFC 791
 290                     has been superseded by the 6-bit Differentiated
 291                     Services Field (DSField, RFC 3260) and the 2-bit
 292                     Explicit Congestion Notification Field (ECN field,
 293                     RFC 3168).  This object is defined as an 8-bit
 294                     octet as defined by the DOCSIS Specification
 295                     for packet classification."
 296     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.1"
 297     ::= { docsIetfQosPktClassEntry 5 }
 298
 299 docsIetfQosPktClassIpTosMask OBJECT-TYPE
 300     SYNTAX          OCTET STRING (SIZE(1))
 301     MAX-ACCESS      read-only
 302     STATUS          current
 303     DESCRIPTION    "The mask value is bitwise ANDed with TOS byte
 304                     in an IP packet, and this value is used for
 305                     range checking of TosLow and TosHigh.
 306
 307                     If the referenced parameter is not present
 308                     in a classifier, this object reports the value
 309                     of 0.
 310
 311                     The IP TOS octet as originally defined in RFC 791
 312                     has been superseded by the 6-bit Differentiated
 313                     Services Field (DSField, RFC 3260) and the 2-bit
 314                     Explicit Congestion Notification Field (ECN field,
 315                     RFC 3168).  This object is defined as an 8-bit
 316                     octet per the DOCSIS Specification for packet
 317                     classification."
 318     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.1"
 319     ::= { docsIetfQosPktClassEntry 6 }
 320
 321 docsIetfQosPktClassIpProtocol OBJECT-TYPE
 322     SYNTAX          Integer32 (0..258)
 323     MAX-ACCESS      read-only
 324     STATUS          current
 325     DESCRIPTION    "This object indicates the value of the IP
 326                     Protocol field required for IP packets to match
 327                     this rule.
 328
 329
 330
 331
 332                     The value 256 matches traffic with any IP Protocol
 333                     value.  The value 257 by convention matches both TCP
 334                     and UDP.
 335
 336                     If the referenced parameter is not present
 337                     in a classifier, this object reports the value
 338                     of 258."
 339     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.2"
 340     ::= { docsIetfQosPktClassEntry 7 }
 341
 342 docsIetfQosPktClassInetAddressType OBJECT-TYPE
 343     SYNTAX          InetAddressType
 344     MAX-ACCESS      read-only
 345     STATUS          current
 346     DESCRIPTION    "The type of the Internet address for
 347                     docsIetfQosPktClassInetSourceAddr,
 348                     docsIetfQosPktClassInetSourceMask,
 349                     docsIetfQosPktClassInetDestAddr, and
 350                     docsIetfQosPktClassInetDestMask.
 351
 352                     If the referenced parameter is not present
 353                     in a classifier, this object reports the value of
 354                     ipv4(1)."
 355     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.3"
 356     ::= { docsIetfQosPktClassEntry 8 }
 357
 358 docsIetfQosPktClassInetSourceAddr OBJECT-TYPE
 359     SYNTAX          InetAddress
 360     MAX-ACCESS      read-only
 361     STATUS          current
 362     DESCRIPTION    "This object specifies the value of the IP
 363                     Source Address required for packets to match
 364                     this rule.
 365
 366                     An IP packet matches the rule when the packet
 367                     IP Source Address bitwise ANDed with the
 368                     docsIetfQosPktClassInetSourceMask value equals the
 369                     docsIetfQosPktClassInetSourceAddr value.
 370
 371                     The address type of this object is specified by
 372                     docsIetfQosPktClassInetAddressType.
 373
 374                     If the referenced parameter is not present
 375                     in a classifier, this object reports the value of
 376                     '00000000'H."
 377     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.3"
 378     ::= { docsIetfQosPktClassEntry 9 }
 379
 380
 381
 382
 383 docsIetfQosPktClassInetSourceMask OBJECT-TYPE
 384     SYNTAX          InetAddress
 385     MAX-ACCESS      read-only
 386     STATUS          current
 387     DESCRIPTION    "This object specifies which bits of a packet's
 388                     IP Source Address are compared to match
 389                     this rule.
 390
 391                     An IP packet matches the rule when the packet
 392                     source address bitwise ANDed with the
 393                     docsIetfQosPktClassInetSourceMask value equals the
 394                     docsIetfQosIpPktClassInetSourceAddr value.
 395
 396                     The address type of this object is specified by
 397                     docsIetfQosPktClassInetAddressType.
 398
 399                     If the referenced parameter is not present
 400                     in a classifier, this object reports the value of
 401                     'FFFFFFFF'H."
 402     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.4"
 403     ::= { docsIetfQosPktClassEntry 10 }
 404
 405 docsIetfQosPktClassInetDestAddr OBJECT-TYPE
 406     SYNTAX          InetAddress
 407     MAX-ACCESS      read-only
 408     STATUS          current
 409     DESCRIPTION    "This object specifies the value of the IP
 410                     Destination Address required for packets to match
 411                     this rule.
 412
 413                     An IP packet matches the rule when the packet
 414                     IP Destination Address bitwise ANDed with the
 415                     docsIetfQosPktClassInetDestMask value
 416                     equals the docsIetfQosPktClassInetDestAddr value.
 417
 418                     The address type of this object is specified by
 419                     docsIetfQosPktClassInetAddressType.
 420
 421                     If the referenced parameter is not present
 422                     in a classifier, this object reports the value of
 423                     '00000000'H."
 424     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.5"
 425     ::= { docsIetfQosPktClassEntry 11 }
 426
 427 docsIetfQosPktClassInetDestMask OBJECT-TYPE
 428     SYNTAX          InetAddress
 429     MAX-ACCESS      read-only
 430     STATUS          current
 431
 432
 433
 434     DESCRIPTION    "This object specifies which bits of a packet's
 435                     IP Destination Address are compared to
 436                     match this rule.
 437
 438                     An IP packet matches the rule when the packet
 439                     destination address bitwise ANDed with the
 440                     docsIetfQosPktClassInetDestMask value equals the
 441                     docsIetfQosIpPktClassInetDestAddr value.
 442
 443                     The address type of this object is specified by
 444                     docsIetfQosPktClassInetAddressType.
 445
 446                     If the referenced parameter is not present
 447                     in a classifier, this object reports the value of
 448                     'FFFFFFFF'H."
 449     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.6"
 450     ::= { docsIetfQosPktClassEntry 12 }
 451
 452 docsIetfQosPktClassSourcePortStart OBJECT-TYPE
 453     SYNTAX          InetPortNumber
 454     MAX-ACCESS      read-only
 455     STATUS          current
 456     DESCRIPTION    "This object specifies the low-end inclusive
 457                     range of TCP/UDP source port numbers to which
 458                     a packet is compared.  This object is irrelevant
 459                     for non-TCP/UDP IP packets.
 460
 461                     If the referenced parameter is not present
 462                     in a classifier, this object reports the value
 463                     of 0."
 464     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.7"
 465     ::= { docsIetfQosPktClassEntry 13 }
 466
 467 docsIetfQosPktClassSourcePortEnd OBJECT-TYPE
 468     SYNTAX          InetPortNumber
 469     MAX-ACCESS      read-only
 470     STATUS          current
 471     DESCRIPTION    "This object specifies the high-end inclusive
 472                     range of TCP/UDP source port numbers to which
 473                     a packet is compared.  This object is irrelevant
 474                     for non-TCP/UDP IP packets.
 475
 476                     If the referenced parameter is not present
 477                     in a classifier, this object reports the value of
 478                     65535."
 479     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.8"
 480     ::= { docsIetfQosPktClassEntry 14 }
 481
 482
 483
 484
 485 docsIetfQosPktClassDestPortStart OBJECT-TYPE
 486     SYNTAX          InetPortNumber
 487     MAX-ACCESS      read-only
 488     STATUS          current
 489     DESCRIPTION     "This object specifies the low-end inclusive
 490                      range of TCP/UDP destination port numbers to
 491                      which a packet is compared.
 492
 493                      If the referenced parameter is not present
 494                      in a classifier, this object reports the value
 495                      of 0."
 496     REFERENCE       "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.9"
 497     ::= { docsIetfQosPktClassEntry 15 }
 498
 499 docsIetfQosPktClassDestPortEnd OBJECT-TYPE
 500     SYNTAX          InetPortNumber
 501     MAX-ACCESS      read-only
 502     STATUS          current
 503     DESCRIPTION    "This object specifies the high-end inclusive
 504                     range of TCP/UDP destination port numbers to which
 505                     a packet is compared.
 506
 507                     If the referenced parameter is not present
 508                     in a classifier, this object reports the value of
 509                     65535."
 510     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.10"
 511     ::= { docsIetfQosPktClassEntry 16 }
 512
 513 docsIetfQosPktClassDestMacAddr OBJECT-TYPE
 514     SYNTAX          MacAddress
 515     MAX-ACCESS      read-only
 516     STATUS          current
 517     DESCRIPTION    "An Ethernet packet matches an entry when its
 518                     destination MAC address bitwise ANDed with
 519                     docsIetfQosPktClassDestMacMask equals the value of
 520                     docsIetfQosPktClassDestMacAddr.
 521
 522
 523                     If the referenced parameter is not present
 524                     in a classifier, this object reports the value of
 525                     '000000000000'H."
 526     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.1"
 527     ::= { docsIetfQosPktClassEntry 17 }
 528
 529 docsIetfQosPktClassDestMacMask OBJECT-TYPE
 530     SYNTAX          MacAddress
 531     MAX-ACCESS      read-only
 532     STATUS          current
 533
 534
 535
 536     DESCRIPTION    "An Ethernet packet matches an entry when its
 537                     destination MAC address bitwise ANDed with
 538                     docsIetfQosPktClassDestMacMask equals the value of
 539                     docsIetfQosPktClassDestMacAddr.
 540
 541                     If the referenced parameter is not present
 542                     in a classifier, this object reports the value of
 543                     '000000000000'H."
 544     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.1"
 545     ::= { docsIetfQosPktClassEntry 18 }
 546
 547 docsIetfQosPktClassSourceMacAddr OBJECT-TYPE
 548     SYNTAX          MacAddress
 549     MAX-ACCESS      read-only
 550     STATUS          current
 551     DESCRIPTION    "An Ethernet packet matches this entry when its
 552                     source MAC address equals the value of
 553                     this object.
 554
 555                     If the referenced parameter is not present
 556                     in a classifier, this object reports the value of
 557                     'FFFFFFFFFFFF'H."
 558     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.2"
 559     ::= { docsIetfQosPktClassEntry 19 }
 560
 561 docsIetfQosPktClassEnetProtocolType OBJECT-TYPE
 562     SYNTAX          INTEGER {
 563                       none(0),
 564                       ethertype(1),
 565                       dsap(2),
 566                       mac(3),
 567                       all(4)
 568                     }
 569     MAX-ACCESS      read-only
 570     STATUS          current
 571     DESCRIPTION    "This object indicates the format of the layer 3
 572                     protocol ID in the Ethernet packet.  A value of
 573                     none(0) means that the rule does not use the
 574                     layer 3 protocol type as a matching criteria.
 575
 576                     A value of ethertype(1) means that the rule
 577                     applies only to frames that contain an
 578                     EtherType value.  Ethertype values are contained
 579                     in packets using the Dec-Intel-Xerox (DIX)
 580                     encapsulation or the RFC1042 Sub-Network Access
 581                     Protocol (SNAP) encapsulation formats.
 582
 583                     A value of dsap(2) means that the rule applies
 584
 585
 586
 587                     only to frames using the IEEE802.3
 588                     encapsulation format with a Destination Service
 589                     Access Point (DSAP) other
 590                     than 0xAA (which is reserved for SNAP).
 591
 592                     A value of mac(3) means that the rule applies
 593                     only to MAC management messages for MAC management
 594                     messages.
 595
 596                     A value of all(4) means that the rule matches
 597                     all Ethernet packets.
 598
 599                     If the Ethernet frame contains an 802.1P/Q Tag
 600                     header (i.e., EtherType 0x8100), this object
 601                     applies to the embedded EtherType field within
 602                     the 802.1P/Q header.
 603
 604                     If the referenced parameter is not present in a
 605                     classifier, this object reports the value of 0."
 606     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.3"
 607     ::= { docsIetfQosPktClassEntry 20 }
 608
 609 docsIetfQosPktClassEnetProtocol OBJECT-TYPE
 610     SYNTAX          Integer32 (0..65535)
 611     MAX-ACCESS      read-only
 612     STATUS          current
 613     DESCRIPTION    "If docsIetfQosEthPktClassProtocolType is none(0),
 614                     this object is ignored when considering whether
 615                     a packet matches the current rule.
 616
 617                     If dosQosPktClassEnetProtocolType is ethertype(1),
 618                     this object gives the 16-bit value of the
 619                     EtherType that the packet must match in order to
 620                     match the rule.
 621
 622                     If docsIetfQosPktClassEnetProtocolType is dsap(2),
 623                     the lower 8 bits of this object's value must match
 624                     the DSAP byte of the packet in order to match the
 625                     rule.
 626
 627                     If docsIetfQosPktClassEnetProtocolType is mac(3),
 628                     the lower 8 bits of this object's value represent a
 629                     lower bound (inclusive) of MAC management message
 630                     type codes matched, and the upper 8 bits represent
 631                     the upper bound (inclusive) of matched MAC message
 632                     type codes.  Certain message type codes are
 633                     excluded from matching, as specified in the
 634                     reference.
 635
 636
 637
 638                     If the Ethernet frame contains an 802.1P/Q Tag
 639                     header (i.e., EtherType 0x8100), this object applies
 640                     to the embedded EtherType field within the 802.1P/Q
 641                     header.
 642
 643                     If the referenced parameter is not present in the
 644                     classifier, the value of this object is reported
 645                     as 0."
 646     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.3"
 647     ::= { docsIetfQosPktClassEntry 21 }
 648
 649 docsIetfQosPktClassUserPriLow OBJECT-TYPE
 650     SYNTAX          Integer32 (0..7)
 651     MAX-ACCESS      read-only
 652     STATUS          current
 653     DESCRIPTION    "This object applies only to Ethernet frames
 654                     using the 802.1P/Q tag header (indicated with
 655                     EtherType 0x8100).  Such frames include a 16-bit
 656                     Tag that contains a 3-bit Priority field and
 657                     a 12-bit VLAN number.
 658
 659                     Tagged Ethernet packets must have a 3-bit
 660                     Priority field within the range of
 661                     docsIetfQosPktClassPriLow to
 662                     docsIetfQosPktClassPriHigh in order to match this
 663                     rule.
 664
 665                     If the referenced parameter is not present in the
 666                     classifier, the value of this object is reported
 667                     as 0."
 668     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.7.1"
 669     ::= { docsIetfQosPktClassEntry 22 }
 670
 671 docsIetfQosPktClassUserPriHigh OBJECT-TYPE
 672     SYNTAX          Integer32 (0..7)
 673     MAX-ACCESS      read-only
 674     STATUS          current
 675     DESCRIPTION    "This object applies only to Ethernet frames
 676                     using the 802.1P/Qtag header (indicated with
 677                     EtherType 0x8100).  Such frames include a 16-bit
 678                     Tag that contains a 3-bit Priority field and
 679                     a 12-bit VLAN number.
 680
 681                     Tagged Ethernet packets must have a 3-bit
 682                     Priority field within the range of
 683                     docsIetfQosPktClassPriLow to
 684                     docsIetfQosPktClassPriHigh in order to match this
 685                     rule.
 686
 687
 688
 689                     If the referenced parameter is not present in the
 690                     classifier, the value of this object is reported
 691                     as 7."
 692     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.7.1"
 693     ::= { docsIetfQosPktClassEntry 23 }
 694
 695 docsIetfQosPktClassVlanId OBJECT-TYPE
 696     SYNTAX          Integer32 (0 | 1..4094)
 697     MAX-ACCESS      read-only
 698     STATUS          current
 699     DESCRIPTION    "This object applies only to Ethernet frames
 700                     using the 802.1P/Q tag header.
 701
 702                     Tagged packets must have a VLAN Identifier that
 703                     matches the value in order to match the rule.
 704
 705                     If the referenced parameter is not present in the
 706                     classifier, the value of this object is reported
 707                     as 0."
 708     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.7.2"
 709     ::= { docsIetfQosPktClassEntry 24 }
 710
 711 docsIetfQosPktClassStateActive OBJECT-TYPE
 712     SYNTAX          TruthValue
 713     MAX-ACCESS      read-only
 714     STATUS          current
 715     DESCRIPTION    "This object indicates whether or not the classifier
 716                     is enabled to classify packets to a Service Flow.
 717
 718                     If the referenced parameter is not present in the
 719                     classifier, the value of this object is reported
 720                     as true(1)."
 721     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.6"
 722     ::= { docsIetfQosPktClassEntry 25 }
 723
 724 docsIetfQosPktClassPkts OBJECT-TYPE
 725     SYNTAX          Counter64
 726     MAX-ACCESS      read-only
 727     STATUS          current
 728     DESCRIPTION    "This object counts the number of packets that have
 729                     been classified using this entry.  This
 730                     includes all packets delivered to a Service Flow
 731                     maximum rate policing function, whether or not that
 732                     function drops the packets.
 733
 734                     This counter's last discontinuity is the
 735                     ifCounterDiscontinuityTime for the same ifIndex that
 736                     indexes this object."
 737
 738
 739
 740     ::= { docsIetfQosPktClassEntry 26 }
 741
 742
 743 docsIetfQosPktClassBitMap OBJECT-TYPE
 744     SYNTAX          BITS {          -- Reference SP-RFIv2.0-I06-040804
 745                         rulePriority(0),     -- Appendix C.2.1.3.4
 746                         activationState(1),  -- Appendix C.2.1.3.6
 747                         ipTos(2),            -- Appendix C.2.1.5.1
 748                         ipProtocol(3),       -- Appendix C.2.1.5.2
 749                         ipSourceAddr(4),     -- Appendix C.2.1.5.3
 750                         ipSourceMask(5),     -- Appendix C.2.1.5.4
 751                         ipDestAddr(6),       -- Appendix C.2.1.5.5
 752                         ipDestMask(7),       -- Appendix C.2.1.5.6
 753                         sourcePortStart(8),  -- Appendix C.2.1.5.7
 754                         sourcePortEnd(9),    -- Appendix C.2.1.5.8
 755                         destPortStart(10),   -- Appendix C.2.1.5.9
 756                         destPortEnd(11),     -- Appendix C.2.1.5.10
 757                         destMac(12),         -- Appendix C.2.1.6.1
 758                         sourceMac(13),       -- Appendix C.2.1.6.2
 759                         ethertype(14),       -- Appendix C.2.1.6.3
 760                         userPri(15),         -- Appendix C.2.1.7.1
 761                         vlanId(16)           -- Appendix C.2.1.7.2
 762                     }
 763     MAX-ACCESS      read-only
 764     STATUS          current
 765     DESCRIPTION
 766                     "This object indicates which parameter encodings
 767                     were actually present in the DOCSIS packet
 768                     classifier encoding signaled in the DOCSIS message
 769                     that created or modified the classifier.  Note that
 770                     Dynamic Service Change messages have replace
 771                     semantics, so that all non-default parameters must
 772                     be present whether the classifier is being created
 773                     or changed.
 774
 775                     A bit of this object is set to 1 if the parameter
 776                     indicated by the comment was present in the
 777                     classifier encoding, and to 0 otherwise.
 778
 779                     Note that BITS are encoded most significant bit
 780                     first, so that if, for example, bits 6 and 7 are
 781                     set, this object is encoded as the octet string
 782                     '030000'H."
 783     ::= { docsIetfQosPktClassEntry 27 }
 784
 785 --
 786 -- QOS Parameter Set Table
 787 --
 788
 789
 790
 791 docsIetfQosParamSetTable OBJECT-TYPE
 792     SYNTAX          SEQUENCE OF DocsIetfQosParamSetEntry
 793     MAX-ACCESS      not-accessible
 794     STATUS          current
 795     DESCRIPTION    "This table describes the set of DOCSIS 1.1 and 2.0
 796                     QOS parameters defined in a managed device.
 797
 798                     The ifIndex index specifies a DOCSIS MAC Domain.
 799                     The docsIetfQosServiceFlowId index specifies a
 800                     particular Service Flow.
 801                     The docsIetfQosParamSetType index indicates whether
 802                     the active, admitted, or provisioned QOS Parameter
 803                     Set is being described by the row.
 804
 805                     Only the QOS Parameter Sets of DOCSIS 1.1 and 2.0
 806                     Service Flows are represented in this table.
 807
 808                     DOCSIS 1.0 QOS service profiles are not
 809                     represented in this table.
 810
 811                     Each row corresponds to a DOCSIS QOS Parameter Set
 812                     as signaled via DOCSIS MAC management messages.
 813                     Each object in the row corresponds to one or
 814                     part of one DOCSIS 1.1 Service Flow Encoding.
 815                     The docsIetfQosParamSetBitMap object in the row
 816                     indicates which particular parameters were signaled
 817                     in the original registration or dynamic service
 818                     request message that created the QOS Parameter Set.
 819
 820                     In many cases, even if a QOS Parameter Set parameter
 821                     was not signaled, the DOCSIS specification calls
 822                     for a default value to be used.  That default value
 823                     is reported as the value of the corresponding object
 824                     in this row.
 825
 826                     Many objects are not applicable, depending on
 827                     the Service Flow direction or upstream scheduling
 828                     type.  The object value reported in this case
 829                     is specified in the DESCRIPTION clause."
 830     ::= { docsIetfQosMIBObjects 2 }
 831
 832 docsIetfQosParamSetEntry OBJECT-TYPE
 833     SYNTAX          DocsIetfQosParamSetEntry
 834     MAX-ACCESS      not-accessible
 835     STATUS          current
 836     DESCRIPTION    "A unique set of QOS parameters."
 837     INDEX {
 838         ifIndex, docsIetfQosServiceFlowId, docsIetfQosParamSetType
 839
 840
 841
 842           }
 843     ::= { docsIetfQosParamSetTable 1 }
 844
 845 DocsIetfQosParamSetEntry ::= SEQUENCE {
 846     docsIetfQosParamSetServiceClassName   SnmpAdminString,
 847     docsIetfQosParamSetPriority           Integer32,
 848     docsIetfQosParamSetMaxTrafficRate     DocsIetfQosBitRate,
 849     docsIetfQosParamSetMaxTrafficBurst    Unsigned32,
 850     docsIetfQosParamSetMinReservedRate    DocsIetfQosBitRate,
 851     docsIetfQosParamSetMinReservedPkt     Integer32,
 852     docsIetfQosParamSetActiveTimeout      Integer32,
 853     docsIetfQosParamSetAdmittedTimeout    Integer32,
 854     docsIetfQosParamSetMaxConcatBurst     Integer32,
 855     docsIetfQosParamSetSchedulingType     DocsIetfQosSchedulingType,
 856     docsIetfQosParamSetNomPollInterval    Unsigned32,
 857     docsIetfQosParamSetTolPollJitter      Unsigned32,
 858     docsIetfQosParamSetUnsolicitGrantSize Integer32,
 859     docsIetfQosParamSetNomGrantInterval   Unsigned32,
 860     docsIetfQosParamSetTolGrantJitter     Unsigned32,
 861     docsIetfQosParamSetGrantsPerInterval  Integer32,
 862     docsIetfQosParamSetTosAndMask         OCTET STRING,
 863     docsIetfQosParamSetTosOrMask          OCTET STRING,
 864     docsIetfQosParamSetMaxLatency         Unsigned32,
 865     docsIetfQosParamSetType               INTEGER,
 866     docsIetfQosParamSetRequestPolicyOct   OCTET STRING,
 867     docsIetfQosParamSetBitMap             BITS
 868     }
 869
 870 docsIetfQosParamSetServiceClassName OBJECT-TYPE
 871     SYNTAX          SnmpAdminString
 872     MAX-ACCESS      read-only
 873     STATUS          current
 874     DESCRIPTION    "Refers to the Service Class Name from which the
 875                     parameter set values were derived.
 876
 877                     If the referenced parameter is not present in the
 878                     corresponding DOCSIS QOS Parameter Set, the default
 879                     value of this object is a zero-length string."
 880     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.4"
 881     ::= { docsIetfQosParamSetEntry 1 }
 882
 883 docsIetfQosParamSetPriority OBJECT-TYPE
 884     SYNTAX          Integer32 (0..7)
 885     MAX-ACCESS      read-only
 886     STATUS          current
 887     DESCRIPTION    "The relative priority of a Service Flow.
 888                     Higher numbers indicate higher priority.
 889                     This priority should only be used to differentiate
 890
 891
 892
 893                     Service Flow from identical parameter sets.
 894
 895                     If the referenced parameter is not present in the
 896                     corresponding DOCSIS QOS Parameter Set, the default
 897                     value of this object is 0.  If the parameter is
 898                     not applicable, the reported value is 0."
 899     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.1"
 900     ::= { docsIetfQosParamSetEntry 2 }
 901
 902 docsIetfQosParamSetMaxTrafficRate OBJECT-TYPE
 903     SYNTAX          DocsIetfQosBitRate
 904     MAX-ACCESS      read-only
 905     STATUS          current
 906     DESCRIPTION    "Maximum sustained traffic rate allowed for this
 907                     Service Flow in bits/sec.  Must count all MAC frame
 908                     data PDU from the bytes following the MAC header
 909                     HCS to the end of the CRC.  The number of bytes
 910                     forwarded is limited during any time interval.
 911                     The value 0 means no maximum traffic rate is
 912                     enforced.  This object applies to both upstream and
 913                     downstream Service Flows.
 914
 915                     If the referenced parameter is not present in the
 916                     corresponding DOCSIS QOS Parameter Set, the default
 917                     value of this object is 0.  If the parameter is
 918                     not applicable, it is reported as 0."
 919     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.2"
 920     ::= { docsIetfQosParamSetEntry 3 }
 921
 922 docsIetfQosParamSetMaxTrafficBurst OBJECT-TYPE
 923     SYNTAX          Unsigned32
 924     MAX-ACCESS      read-only
 925     STATUS          current
 926     DESCRIPTION    "Specifies the token bucket size in bytes
 927                     for this parameter set.  The value is calculated
 928                     from the byte following the MAC header HCS to
 929                     the end of the CRC.  This object is applied in
 930                     conjunction with docsIetfQosParamSetMaxTrafficRate
 931                     to calculate maximum sustained traffic rate.
 932
 933                     If the referenced parameter is not present in the
 934                     corresponding DOCSIS QOS Parameter Set, the default
 935                     value of this object for scheduling types
 936                     bestEffort (2), nonRealTimePollingService(3),
 937                     and realTimePollingService(4) is 3044.
 938
 939                     If this parameter is not applicable, it is reported
 940                     as 0.
 941
 942
 943
 944                    "
 945     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.3"
 946     ::= { docsIetfQosParamSetEntry 4 }
 947
 948 docsIetfQosParamSetMinReservedRate OBJECT-TYPE
 949     SYNTAX          DocsIetfQosBitRate
 950     MAX-ACCESS      read-only
 951     STATUS          current
 952     DESCRIPTION    "Specifies the guaranteed minimum rate in
 953                     bits/sec for this parameter set.  The value is
 954                     calculated from the byte following the MAC
 955                     header HCS to the end of the CRC.  The default
 956                     value of 0 means that no bandwidth is reserved.
 957
 958                     If the referenced parameter is not present in the
 959                     corresponding DOCSIS QOS Parameter Set, the default
 960                     value of this object is 0.  If the parameter
 961                     is not applicable, it is reported as 0."
 962     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.4"
 963     ::= { docsIetfQosParamSetEntry 5 }
 964
 965 docsIetfQosParamSetMinReservedPkt OBJECT-TYPE
 966     SYNTAX          Integer32 (0..65535)
 967     MAX-ACCESS      read-only
 968     STATUS          current
 969     DESCRIPTION    "Specifies an assumed minimum packet size in
 970                     bytes for which the
 971                     docsIetfQosParamSetMinReservedRate will be
 972                     provided.  The value is calculated from the byte
 973                     following the MAC header HCS to the end of the
 974                     CRC.
 975
 976                     If the referenced parameter is omitted from a
 977                     DOCSIS QOS parameter set, the default value is
 978                     CMTS implementation dependent.  In this case, the
 979                     CMTS reports the default value it is using, and the
 980                     CM reports a value of 0.  If the referenced
 981                     parameter is not applicable to the direction or
 982                     scheduling type of the Service Flow, both CMTS and
 983                     CM report this object's value as 0."
 984     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.5"
 985     ::= { docsIetfQosParamSetEntry 6 }
 986
 987 docsIetfQosParamSetActiveTimeout OBJECT-TYPE
 988     SYNTAX          Integer32 (0..65535)
 989     UNITS           "seconds"
 990     MAX-ACCESS      read-only
 991     STATUS          current
 992
 993
 994
 995     DESCRIPTION    "Specifies the maximum duration in seconds that
 996                     resources remain unused on an active service
 997                     flow before CMTS signals that both active and
 998                     admitted parameters set are null.  The default
 999                     value of 0 signifies an infinite amount of time.
1000
1001                     If the referenced parameter is not present in the
1002                     corresponding DOCSIS QOS Parameter Set, the default
1003                     value of this object is 0."
1004     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.6"
1005     ::= { docsIetfQosParamSetEntry 7 }
1006
1007 docsIetfQosParamSetAdmittedTimeout OBJECT-TYPE
1008     SYNTAX          Integer32 (0..65535)
1009     UNITS           "seconds"
1010     MAX-ACCESS      read-only
1011     STATUS          current
1012     DESCRIPTION    "Specifies the maximum duration in seconds that
1013                     resources remain in admitted state before
1014                     resources must be released.
1015
1016                     The value of 0 signifies an infinite amount
1017                     of time.
1018
1019                     If the referenced parameter is not present in the
1020                     corresponding DOCSIS QOS Parameter Set, the
1021                     default value of this object is 200.
1022                    "
1023
1024     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.7"
1025     DEFVAL          { 200 }
1026     ::= { docsIetfQosParamSetEntry 8 }
1027
1028 docsIetfQosParamSetMaxConcatBurst OBJECT-TYPE
1029     SYNTAX          Integer32 (0..65535)
1030     MAX-ACCESS      read-only
1031     STATUS          current
1032     DESCRIPTION    "Specifies the maximum concatenated burst in
1033                     bytes that an upstream Service Flow is allowed.
1034                     The value is calculated from the FC byte of the
1035                     Concatenation MAC Header to the last CRC byte in
1036                     of the last concatenated MAC frame, inclusive.
1037                     The value of 0 specifies no maximum burst.
1038
1039                     If the referenced parameter is not present in the
1040                     corresponding DOCSIS QOS Parameter Set, the default
1041                     value of this object for scheduling types
1042                     bestEffort(2), nonRealTimePollingService(3), and
1043
1044
1045
1046                     realTimePollingService(4) is 1522.  If the parameter
1047                     is not applicable, this object's value is reported
1048                     as 0."
1049     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.1"
1050     ::= { docsIetfQosParamSetEntry 9 }
1051
1052
1053 docsIetfQosParamSetSchedulingType OBJECT-TYPE
1054     SYNTAX          DocsIetfQosSchedulingType
1055     MAX-ACCESS      read-only
1056     STATUS          current
1057     DESCRIPTION    "Specifies the upstream scheduling service used for
1058                     upstream Service Flow.
1059
1060                     If the referenced parameter is not present in the
1061                     corresponding DOCSIS QOS Parameter Set of an
1062                     upstream Service Flow, the default value of this
1063                     object is bestEffort(2).  For QOS parameter sets of
1064                     downstream Service Flows, this object's value is
1065                     reported as undefined(1)."
1066     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.2"
1067     ::= { docsIetfQosParamSetEntry 10 }
1068
1069 docsIetfQosParamSetNomPollInterval OBJECT-TYPE
1070     SYNTAX          Unsigned32
1071     UNITS           "microseconds"
1072     MAX-ACCESS      read-only
1073     STATUS          current
1074     DESCRIPTION    "Specifies the nominal interval in microseconds
1075                     between successive unicast request
1076                     opportunities on an upstream Service Flow.
1077
1078                     This object applies only to upstream Service Flows
1079                     with DocsIetfQosSchedulingType of value
1080                     nonRealTimePollingService(3),
1081                     realTimePollingService(4), and
1082                     unsolictedGrantServiceWithAD(5).  The parameter is
1083                     mandatory for realTimePollingService(4).  If the
1084                     parameter is omitted with
1085                     nonRealTimePollingService(3), the CMTS uses an
1086                     implementation-dependent value.  If the parameter
1087                     is omitted with unsolictedGrantServiceWithAD(5),
1088                     the CMTS uses as a default value the value of the
1089                     Nominal Grant Interval parameter.  In all cases,
1090                     the CMTS reports the value it is using when the
1091                     parameter is applicable.  The CM reports the
1092                     signaled parameter value if it was signaled,
1093                     and 0 otherwise.
1094
1095
1096
1097                     If the referenced parameter is not applicable to
1098                     the direction or scheduling type of the
1099                     corresponding DOCSIS QOS Parameter Set, both
1100                     CMTS and CM report this object's value as 0."
1101     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.4"
1102     ::= { docsIetfQosParamSetEntry 11 }
1103
1104 docsIetfQosParamSetTolPollJitter OBJECT-TYPE
1105     SYNTAX          Unsigned32
1106     UNITS           "microseconds"
1107     MAX-ACCESS      read-only
1108     STATUS          current
1109     DESCRIPTION    "Specifies the maximum amount of time in
1110                     microseconds that the unicast request interval
1111                     may be delayed from the nominal periodic
1112                     schedule on an upstream Service Flow.
1113
1114                     This parameter is applicable only to upstream
1115                     Service Flows with a DocsIetfQosSchedulingType of
1116                     realTimePollingService(4) or
1117                     unsolictedGrantServiceWithAD(5).
1118
1119                     If the referenced parameter is applicable but not
1120                     present in the corresponding DOCSIS QOS Parameter
1121                     Set, the CMTS uses an implementation-dependent
1122                     value and reports the value it is using.
1123                     The CM reports a value of 0 in this case.
1124
1125                     If the parameter is not applicable to the
1126                     direction or upstream scheduling type of the
1127                     Service Flow, both CMTS and CM report this
1128                     object's value as 0."
1129     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.5"
1130     ::= { docsIetfQosParamSetEntry 12 }
1131
1132 docsIetfQosParamSetUnsolicitGrantSize OBJECT-TYPE
1133     SYNTAX          Integer32 (0..65535)
1134     MAX-ACCESS      read-only
1135     STATUS          current
1136     DESCRIPTION    "Specifies the unsolicited grant size in bytes.
1137                     The grant size includes the entire MAC frame
1138                     data PDU from the Frame Control byte to the end
1139                     of the MAC frame.
1140
1141                     The referenced parameter is applicable only
1142                     for upstream flows with a DocsIetfQosSchedulingType
1143                     of unsolicitedGrantServicewithAD(5) or
1144                     unsolicitedGrantService(6), and it is mandatory
1145
1146
1147
1148                     when applicable.  Both CMTS and CM report
1149                     the signaled value of the parameter in this
1150                     case.
1151
1152                     If the referenced parameter is not applicable to
1153                     the direction or scheduling type of the
1154                     corresponding DOCSIS QOS Parameter Set, both
1155                     CMTS and CM report this object's value as 0."
1156     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.6"
1157     ::= { docsIetfQosParamSetEntry 13 }
1158
1159 docsIetfQosParamSetNomGrantInterval OBJECT-TYPE
1160     SYNTAX          Unsigned32
1161     UNITS           "microseconds"
1162     MAX-ACCESS      read-only
1163     STATUS          current
1164     DESCRIPTION    "Specifies the nominal interval in microseconds
1165                     between successive data grant opportunities
1166                     on an upstream Service Flow.
1167
1168                     The referenced parameter is applicable only
1169                     for upstream flows with a DocsIetfQosSchedulingType
1170                     of unsolicitedGrantServicewithAD(5) or
1171                     unsolicitedGrantService(6), and it is mandatory
1172                     when applicable.  Both CMTS and CM report the
1173                     signaled value of the parameter in this case.
1174
1175                     If the referenced parameter is not applicable to
1176                     the direction or scheduling type of the
1177                     corresponding DOCSIS QOS Parameter Set, both
1178                     CMTS and CM report this object's value as 0."
1179     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.7"
1180     ::= { docsIetfQosParamSetEntry 14 }
1181
1182 docsIetfQosParamSetTolGrantJitter OBJECT-TYPE
1183     SYNTAX          Unsigned32
1184     UNITS           "microseconds"
1185     MAX-ACCESS      read-only
1186     STATUS          current
1187     DESCRIPTION    "Specifies the maximum amount of time in
1188                     microseconds that the transmission opportunities
1189                     may be delayed from the nominal periodic schedule.
1190
1191                     The referenced parameter is applicable only
1192                     for upstream flows with a DocsIetfQosSchedulingType
1193                     of unsolicitedGrantServicewithAD(5) or
1194                     unsolicitedGrantService(6), and it is mandatory
1195                     when applicable.  Both CMTS and CM report the
1196
1197
1198
1199                     signaled value of the parameter in this case.
1200
1201                     If the referenced parameter is not applicable to
1202                     the direction or scheduling type of the
1203                     corresponding DOCSIS QOS Parameter Set, both
1204                     CMTS and CM report this object's value as 0."
1205     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.8"
1206     ::= { docsIetfQosParamSetEntry 15 }
1207
1208 docsIetfQosParamSetGrantsPerInterval OBJECT-TYPE
1209     SYNTAX          Integer32 (0..127)
1210     MAX-ACCESS      read-only
1211     STATUS          current
1212     DESCRIPTION    "Specifies the number of data grants per Nominal
1213                     Grant Interval
1214                     (docsIetfQosParamSetNomGrantInterval).
1215
1216                     The referenced parameter is applicable only
1217                     for upstream flows with a DocsIetfQosSchedulingType
1218                     of unsolicitedGrantServicewithAD(5) or
1219                     unsolicitedGrantService(6), and it is mandatory
1220                     when applicable.  Both CMTS and CM report the
1221                     signaled value of the parameter in this case.
1222
1223                     If the referenced parameter is not applicable to
1224                     the direction or scheduling type of the
1225                     corresponding DOCSIS QOS Parameter Set, both
1226                     CMTS and CM report this object's value as 0."
1227     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.9"
1228     ::= { docsIetfQosParamSetEntry 16 }
1229
1230 docsIetfQosParamSetTosAndMask OBJECT-TYPE
1231     SYNTAX          OCTET STRING (SIZE(1))
1232     MAX-ACCESS      read-only
1233     STATUS          current
1234     DESCRIPTION    "Specifies the AND mask for the IP TOS byte for
1235                     overwriting IP packet's TOS value.  The IP packet
1236                     TOS byte is bitwise ANDed with
1237                     docsIetfQosParamSetTosAndMask, and the result is
1238                     bitwise ORed with docsIetfQosParamSetTosORMask and
1239                     the result is written to the IP packet TOS byte.
1240                     A value of 'FF'H for docsIetfQosParamSetTosAndMask
1241                     and a value of '00'H for
1242                     docsIetfQosParamSetTosOrMask means that the IP
1243                     Packet TOS byte is not overwritten.
1244
1245                     This combination is reported if the referenced
1246                     parameter is not present in a QOS Parameter Set.
1247
1248
1249
1250                     The IP TOS octet as originally defined in RFC 791
1251                     has been superseded by the 6-bit Differentiated
1252                     Services Field (DSField, RFC 3260) and the 2-bit
1253                     Explicit Congestion Notification Field (ECN field,
1254                     RFC 3168).  Network operators SHOULD avoid
1255                     specifying values of docsIetfQosParamSetTosAndMask
1256                     and docsIetfQosParamSetTosORMask that would result
1257                     in the modification of the ECN bits.
1258
1259                     In particular, operators should not use values of
1260                     docsIetfQosParamSetTosAndMask that have either of
1261                     the least-significant two bits set to 0.  Similarly,
1262                     operators should not use values of
1263                     docsIetfQosParamSetTosORMask that have either of
1264                     the least-significant two bits set to 1.
1265
1266                     Even though this object is only enforced by the
1267                     Cable Modem Termination System (CMTS),
1268                     Cable Modems MUST report the value as signaled in
1269                     the referenced parameter."
1270     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10;
1271                     RFC 3168, The Addition of Explicit Congestion
1272                     Notification (ECN) to IP;
1273                     RFC 3260, New Terminology and Clarifications for
1274                     Diffserv."
1275     ::= { docsIetfQosParamSetEntry 17 }
1276
1277 docsIetfQosParamSetTosOrMask OBJECT-TYPE
1278     SYNTAX          OCTET STRING (SIZE(1))
1279     MAX-ACCESS      read-only
1280     STATUS          current
1281     DESCRIPTION    "Specifies the OR mask for the IP TOS byte.
1282
1283                     See the description of docsIetfQosParamSetTosAndMask
1284                     for further details.
1285
1286                     The IP TOS octet as originally defined in RFC 791
1287                     has been superseded by the 6-bit Differentiated
1288                     Services Field (DSField, RFC 3260) and the 2-bit
1289                     Explicit Congestion Notification Field (ECN field,
1290                     RFC 3168).  Network operators SHOULD avoid
1291                     specifying values of docsIetfQosParamSetTosAndMask
1292                     and docsIetfQosParamSetTosORMask that would result
1293                     in the modification of the ECN bits."
1294     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10;
1295                     RFC 3168, The Addition of Explicit Congestion
1296                     Notification (ECN) to IP;
1297                     RFC 3260, New Terminology and Clarifications for
1298
1299
1300
1301                     Diffserv."
1302     ::= { docsIetfQosParamSetEntry 18 }
1303
1304 docsIetfQosParamSetMaxLatency OBJECT-TYPE
1305     SYNTAX          Unsigned32
1306     UNITS           "microseconds"
1307     MAX-ACCESS      read-only
1308     STATUS          current
1309     DESCRIPTION    "Specifies the maximum latency between the
1310                     reception of a packet by the CMTS on its NSI
1311                     and the forwarding of the packet to the RF
1312                     interface.  A value of 0 signifies no maximum
1313                     latency is enforced.  This object only applies to
1314                     downstream Service Flows.
1315
1316                     If the referenced parameter is not present in the
1317                     corresponding downstream DOCSIS QOS Parameter Set,
1318                     the default value is 0.  This parameter is
1319                     not applicable to upstream DOCSIS QOS Parameter
1320                     Sets, and its value is reported as 0 in this case."
1321     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.7.1"
1322     ::= { docsIetfQosParamSetEntry 19 }
1323
1324
1325 docsIetfQosParamSetType     OBJECT-TYPE
1326     SYNTAX          INTEGER {
1327                        active (1),
1328                        admitted (2),
1329                        provisioned (3)
1330                     }
1331     MAX-ACCESS      not-accessible
1332     STATUS          current
1333     DESCRIPTION    "Defines the type of the QOS parameter set defined
1334                     by this row.  active(1) indicates the Active QOS
1335                     parameter set, describing the service currently
1336                     being provided by the DOCSIS MAC domain to the
1337                     Service Flow.  admitted(2) indicates the Admitted
1338                     QOS Parameter Set, describing services reserved by
1339                     the DOCSIS MAC domain for use by the service
1340                     flow.  provisioned (3) describes the QOS Parameter
1341                     Set defined in the DOCSIS CM Configuration file for
1342                     the Service Flow."
1343     REFERENCE      "SP-RFIv2.0-I06-040804, 8.1.5"
1344     ::= { docsIetfQosParamSetEntry 20 }
1345
1346 docsIetfQosParamSetRequestPolicyOct OBJECT-TYPE
1347     SYNTAX          OCTET STRING (SIZE(4))
1348                     -- A 32-bit mask represented most significant byte
1349
1350
1351
1352                     -- first.  The 32-bit integer represented in this
1353                     -- manner equals the binary value of the referenced
1354                     -- integer parameter of the DOCSIS RFI
1355                     -- specification.
1356                     -- The BITS syntax is not used in order to avoid
1357                     -- the confusion caused by different bit-numbering
1358                     -- conventions.
1359     MAX-ACCESS      read-only
1360     STATUS          current
1361     DESCRIPTION    "Specifies which transmit interval opportunities
1362                     the CM omits for upstream transmission requests and
1363                     packet transmissions.  This object takes its
1364                     default value for downstream Service Flows.
1365
1366                     Unless otherwise indicated, a bit value of 1 means
1367                     that a CM must not use that opportunity for
1368                     upstream transmission.
1369
1370                     If bit 0 is the least significant bit of the
1371                     least significant (4th) octet, and if bit number
1372                     is increased with significance, the bit definitions
1373                     are defined as follows:
1374
1375                     broadcastReqOpp(0):
1376                          all CMs broadcast request opportunities
1377
1378                     priorityReqMulticastReq(1):
1379                          priority request multicast request
1380                          opportunities
1381
1382                     reqDataForReq(2):
1383                          request/data opportunities for requests
1384
1385                     reqDataForData(3):
1386                          request/data opportunities for data
1387
1388                     piggybackReqWithData(4):
1389                          piggyback requests with data
1390
1391                     concatenateData(5):
1392                          concatenate data
1393
1394                     fragmentData(6):
1395                          fragment data
1396
1397                     suppresspayloadheaders(7):
1398                          suppress payload headers
1399
1400
1401
1402
1403                     dropPktsExceedUGSize(8):
1404                          A value of 1 means that the Service Flow must
1405                          drop packets that do not fit in the Unsolicited
1406                          Grant size.
1407
1408                     If the referenced parameter is not present in
1409                     a QOS Parameter Set, the value of this object is
1410                     reported as '00000000'H."
1411     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.3"
1412     ::= { docsIetfQosParamSetEntry 21 }
1413
1414 docsIetfQosParamSetBitMap OBJECT-TYPE
1415                                 -- Each bit corresponds to a parameter
1416                                 -- from SP-RFI-v1.1-I10-037030,
1417                                 -- Appendix C in the indicated
1418     SYNTAX          BITS {      -- section number.
1419                         trafficPriority(0),     -- C.2.2.5.1
1420                         maxTrafficRate(1),      -- C.2.2.5.2
1421                         maxTrafficBurst(2),     -- C.2.2.5.3
1422                         minReservedRate(3),     -- C.2.2.5.4
1423                         minReservedPkt(4),      -- C.2.2.5.5
1424                         activeTimeout(5),       -- C.2.2.5.6
1425                         admittedTimeout(6),     -- C.2.2.5.7
1426                         maxConcatBurst(7),      -- C.2.2.6.1
1427                         schedulingType(8),      -- C.2.2.6.2
1428                         requestPolicy(9),       -- C.2.2.6.3
1429                         nomPollInterval(10),    -- C.2.2.6.4
1430                         tolPollJitter(11),      -- C.2.2.6.5
1431                         unsolicitGrantSize(12), -- C.2.2.6.6
1432                         nomGrantInterval(13),   -- C.2.2.6.7
1433                         tolGrantJitter(14),     -- C.2.2.6.8
1434                         grantsPerInterval(15),  -- C.2.2.6.9
1435                         tosOverwrite(16),       -- C.2.2.6.10
1436                         maxLatency(17)          -- C.2.2.7.1
1437                     }
1438     MAX-ACCESS      read-only
1439     STATUS          current
1440     DESCRIPTION    "This object indicates the set of QOS Parameter
1441                     Set parameters actually signaled in the
1442                     DOCSIS registration or dynamic service request
1443                     message that created or modified the QOS Parameter
1444                     Set.  A bit is set to 1 when the parameter described
1445                     by the indicated reference section is present
1446                     in the original request.
1447
1448                     Note that when Service Class names are expanded,
1449                     the registration or dynamic response message may
1450                     contain parameters as expanded by the CMTS based
1451
1452
1453
1454                     on a stored service class.  These expanded
1455                     parameters are not indicated by a 1 bit in this
1456                     object.
1457
1458                     Note that even though some QOS Parameter Set
1459                     parameters may not be signaled in a message
1460                     (so that the paramater's bit in this object is 0),
1461                     the DOCSIS specification requires that default
1462                     values be used.  These default values are reported
1463                     as the corresponding object's value in the row.
1464
1465                     Note that BITS objects are encoded most
1466                     significant bit first.  For example, if bits
1467                     1 and 16 are set, the value of this object
1468                     is the octet string '400080'H."
1469     ::= { docsIetfQosParamSetEntry 22 }
1470
1471 --
1472 --  Service Flow Table
1473 --
1474 docsIetfQosServiceFlowTable OBJECT-TYPE
1475     SYNTAX          SEQUENCE OF DocsIetfQosServiceFlowEntry
1476     MAX-ACCESS      not-accessible
1477     STATUS          current
1478     DESCRIPTION    "This table describes the set of DOCSIS-QOS
1479                     Service Flows in a managed device."
1480     ::= { docsIetfQosMIBObjects 3 }
1481
1482 docsIetfQosServiceFlowEntry OBJECT-TYPE
1483     SYNTAX          DocsIetfQosServiceFlowEntry
1484     MAX-ACCESS      not-accessible
1485     STATUS          current
1486     DESCRIPTION    "Describes a Service Flow.
1487                     An entry in the table exists for each
1488                     Service Flow ID.  The ifIndex is an
1489                     ifType of docsCableMaclayer(127)."
1490     INDEX {
1491             ifIndex,
1492             docsIetfQosServiceFlowId
1493           }
1494     ::= { docsIetfQosServiceFlowTable 1 }
1495
1496 DocsIetfQosServiceFlowEntry ::= SEQUENCE {
1497     docsIetfQosServiceFlowId               Unsigned32,
1498     docsIetfQosServiceFlowSID              Unsigned32,
1499     docsIetfQosServiceFlowDirection        DocsIetfQosRfMacIfDirection,
1500     docsIetfQosServiceFlowPrimary          TruthValue
1501     }
1502
1503
1504
1505 docsIetfQosServiceFlowId    OBJECT-TYPE
1506     SYNTAX          Unsigned32 (1..4294967295)
1507     MAX-ACCESS      not-accessible
1508     STATUS          current
1509     DESCRIPTION    "An index assigned to a Service Flow by CMTS."
1510     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.2"
1511     ::= { docsIetfQosServiceFlowEntry 1 }
1512
1513 docsIetfQosServiceFlowSID  OBJECT-TYPE
1514     SYNTAX          Unsigned32 (0..16383)
1515     MAX-ACCESS      read-only
1516     STATUS          current
1517     DESCRIPTION    "Service Identifier (SID) assigned to an
1518                     admitted or active Service Flow.  This object
1519                     reports a value of 0 if a Service ID is not
1520                     associated with the Service Flow.  Only active
1521                     or admitted upstream Service Flows will have a
1522                     Service ID (SID)."
1523     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.3"
1524     ::= { docsIetfQosServiceFlowEntry 2 }
1525
1526 docsIetfQosServiceFlowDirection OBJECT-TYPE
1527     SYNTAX          DocsIetfQosRfMacIfDirection
1528     MAX-ACCESS      read-only
1529     STATUS          current
1530     DESCRIPTION    "The direction of the Service Flow."
1531     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.1/2"
1532     ::= { docsIetfQosServiceFlowEntry 3 }
1533
1534 docsIetfQosServiceFlowPrimary OBJECT-TYPE
1535     SYNTAX          TruthValue
1536     MAX-ACCESS      read-only
1537     STATUS          current
1538     DESCRIPTION    "Object reflects whether Service Flow is the primary
1539                     or a secondary Service Flow.
1540
1541                     A primary Service Flow is the default Service Flow
1542                     for otherwise unclassified traffic and all MAC
1543                     messages."
1544     REFERENCE      "SP-RFIv2.0-I06-040804, Section 8.1 "
1545     ::= { docsIetfQosServiceFlowEntry 4 }
1546
1547 --
1548 --  Service Flow Stats Table
1549 --
1550 docsIetfQosServiceFlowStatsTable OBJECT-TYPE
1551     SYNTAX          SEQUENCE OF DocsIetfQosServiceFlowStatsEntry
1552     MAX-ACCESS      not-accessible
1553
1554
1555
1556     STATUS          current
1557     DESCRIPTION     "This table describes statistics associated with the
1558                      Service Flows in a managed device."
1559     ::= { docsIetfQosMIBObjects 4 }
1560
1561 docsIetfQosServiceFlowStatsEntry OBJECT-TYPE
1562     SYNTAX          DocsIetfQosServiceFlowStatsEntry
1563     MAX-ACCESS      not-accessible
1564     STATUS          current
1565     DESCRIPTION    "Describes a set of Service Flow statistics.
1566                     An entry in the table exists for each
1567                     Service Flow ID.  The ifIndex is an
1568                     ifType of docsCableMaclayer(127)."
1569     INDEX {
1570             ifIndex,
1571             docsIetfQosServiceFlowId
1572           }
1573     ::= { docsIetfQosServiceFlowStatsTable 1 }
1574
1575 DocsIetfQosServiceFlowStatsEntry ::= SEQUENCE {
1576     docsIetfQosServiceFlowPkts                     Counter64,
1577     docsIetfQosServiceFlowOctets                   Counter64,
1578     docsIetfQosServiceFlowTimeCreated              TimeStamp,
1579     docsIetfQosServiceFlowTimeActive               Counter32,
1580     docsIetfQosServiceFlowPHSUnknowns              Counter32,
1581     docsIetfQosServiceFlowPolicedDropPkts          Counter32,
1582     docsIetfQosServiceFlowPolicedDelayPkts         Counter32
1583     }
1584
1585 docsIetfQosServiceFlowPkts OBJECT-TYPE
1586     SYNTAX          Counter64
1587     MAX-ACCESS      read-only
1588     STATUS          current
1589     DESCRIPTION    "For outgoing Service Flows, this object counts the
1590                     number of Packet Data PDUs forwarded to this
1591                     Service Flow.  For incoming upstream CMTS service
1592                     flows, this object counts the number of Packet
1593                     Data PDUs actually received on the Service Flow
1594                     identified by the SID for which the packet was
1595                     scheduled.  CMs not classifying downstream packets
1596                     may report this object's value as 0 for downstream
1597                     Service Flows.  This object does not count
1598                     MAC-specific management messages.
1599
1600                     Particularly for UGS flows, packets sent on the
1601                     primary Service Flow in violation of the UGS grant
1602                     size should be counted only by the instance of this
1603                     object that is associated with the primary service
1604
1605
1606
1607                     flow.
1608
1609                     Unclassified upstream user data packets (i.e., non-
1610                     MAC-management) forwarded to the primary upstream
1611                     Service Flow should be counted by the instance of
1612                     this object that is associated with the primary
1613                     service flow.
1614
1615                     This object does include packets counted by
1616                     docsIetfQosServiceFlowPolicedDelayPkts, but does not
1617                     include packets counted by
1618                     docsIetfQosServiceFlowPolicedDropPkts
1619                     and docsIetfQosServiceFlowPHSUnknowns.
1620
1621                     This counter's last discontinuity is the
1622                     ifCounterDiscontinuityTime for the same ifIndex that
1623                     indexes this object."
1624     ::= { docsIetfQosServiceFlowStatsEntry 1 }
1625
1626 docsIetfQosServiceFlowOctets OBJECT-TYPE
1627     SYNTAX          Counter64
1628     MAX-ACCESS      read-only
1629     STATUS          current
1630     DESCRIPTION    "The number of octets from the byte after the MAC
1631                     header HCS to the end of the CRC for all packets
1632                     counted in the docsIetfQosServiceFlowPkts object for
1633                     this row.  Note that this counts the octets after
1634                     payload header suppression and before payload
1635                     header expansion have been applied.
1636
1637                     This counter's last discontinuity is the
1638                     ifCounterDiscontinuityTime for the same ifIndex that
1639                     indexes this object."
1640     ::= { docsIetfQosServiceFlowStatsEntry 2 }
1641
1642 docsIetfQosServiceFlowTimeCreated OBJECT-TYPE
1643     SYNTAX          TimeStamp
1644     MAX-ACCESS      read-only
1645     STATUS          current
1646     DESCRIPTION    "The value of sysUpTime when the service flow
1647                     was created."
1648     ::= { docsIetfQosServiceFlowStatsEntry 3 }
1649
1650 docsIetfQosServiceFlowTimeActive OBJECT-TYPE
1651     SYNTAX          Counter32
1652     UNITS           "seconds"
1653     MAX-ACCESS      read-only
1654     STATUS          current
1655
1656
1657
1658     DESCRIPTION    "The number of seconds that the service flow
1659                     has been active.
1660
1661                     This counter's last discontinuity is the
1662                     ifCounterDiscontinuityTime for the same ifIndex that
1663                     indexes this object."
1664     ::= { docsIetfQosServiceFlowStatsEntry 4 }
1665
1666 docsIetfQosServiceFlowPHSUnknowns OBJECT-TYPE
1667     SYNTAX          Counter32
1668     MAX-ACCESS      read-only
1669     STATUS          current
1670     DESCRIPTION    "For incoming upstream CMTS service flows, this
1671                     object counts the number of packets received
1672                     with an unknown payload header suppression index.
1673                     The service flow is identified by the SID for which
1674                     the packet was scheduled.
1675
1676                     On a CM, only this object's instance for the primary
1677                     downstream service flow counts packets received with
1678                     an unknown payload header suppression index.  All
1679                     other downstream service flows on CM report this
1680                     objects value as 0.
1681
1682                     All outgoing service flows report this object's
1683                     value as 0.
1684
1685                     This counter's last discontinuity is the
1686                     ifCounterDiscontinuityTime for the same ifIndex that
1687                     indexes this object."
1688     ::= { docsIetfQosServiceFlowStatsEntry 5 }
1689
1690 docsIetfQosServiceFlowPolicedDropPkts OBJECT-TYPE
1691     SYNTAX          Counter32
1692     MAX-ACCESS      read-only
1693     STATUS          current
1694     DESCRIPTION    "For outgoing service flows, this object counts the
1695                     number of Packet Data PDUs classified to this
1696                     service flow dropped due to:
1697                        (1) implementation-dependent excessive delay
1698                            while enforcing the Maximum Sustained
1699                            Traffic Rate; or
1700                        (2) UGS packets dropped due to exceeding the
1701                            Unsolicited Grant Size with a
1702                            Request/Transmission policy that requires
1703                            such packets to be dropped.
1704
1705                     Classified packets dropped due to other reasons
1706
1707
1708
1709                     must be counted in ifOutDiscards for the interface
1710                     of this service flow.  This object reports 0 for
1711                     incoming service flows.
1712
1713                     This counter's last discontinuity is the
1714                     ifCounterDiscontinuityTime for the same ifIndex that
1715                     indexes this object."
1716     ::= { docsIetfQosServiceFlowStatsEntry 6 }
1717
1718 docsIetfQosServiceFlowPolicedDelayPkts OBJECT-TYPE
1719     SYNTAX          Counter32
1720     MAX-ACCESS      read-only
1721     STATUS          current
1722     DESCRIPTION    "This object counts only outgoing packets delayed in
1723                     order to maintain the Maximum Sustained Traffic
1724                     Rate.  This object will always report a value of 0
1725                     for UGS flows because the Maximum Sustained Traffic
1726                     Rate does not apply.  This object is 0 for incoming
1727                     service flows.
1728
1729                     This counter's last discontinuity is the
1730                     ifCounterDiscontinuityTime for the same ifIndex that
1731                     indexes this object."
1732     ::= { docsIetfQosServiceFlowStatsEntry 7 }
1733
1734 --
1735 --  Upstream Service Flow Stats Table (CMTS ONLY)
1736 --
1737 docsIetfQosUpstreamStatsTable OBJECT-TYPE
1738     SYNTAX          SEQUENCE OF DocsIetfQosUpstreamStatsEntry
1739     MAX-ACCESS      not-accessible
1740     STATUS          current
1741     DESCRIPTION    "This table describes statistics associated with
1742                     upstream service flows.  All counted frames must
1743                     be received without a Frame Check Sequence (FCS)
1744                     error."
1745     ::= { docsIetfQosMIBObjects 5 }
1746
1747 docsIetfQosUpstreamStatsEntry OBJECT-TYPE
1748     SYNTAX          DocsIetfQosUpstreamStatsEntry
1749     MAX-ACCESS      not-accessible
1750     STATUS          current
1751     DESCRIPTION    "Describes a set of upstream service flow
1752                     statistics.  An entry in the table exists for each
1753                     upstream Service Flow in a managed device.
1754                     The ifIndex is an ifType of
1755                     docsCableMaclayer(127)."
1756     INDEX {
1757
1758
1759
1760             ifIndex,
1761             docsIetfQosSID
1762           }
1763     ::= { docsIetfQosUpstreamStatsTable 1 }
1764
1765 DocsIetfQosUpstreamStatsEntry ::= SEQUENCE {
1766     docsIetfQosSID                            Unsigned32,
1767     docsIetfQosUpstreamFragments              Counter32,
1768     docsIetfQosUpstreamFragDiscards           Counter32,
1769     docsIetfQosUpstreamConcatBursts           Counter32
1770     }
1771
1772 docsIetfQosSID OBJECT-TYPE
1773     SYNTAX          Unsigned32 (1..16383)
1774     MAX-ACCESS      not-accessible
1775     STATUS          current
1776     DESCRIPTION    "Identifies a service ID for an admitted or active
1777                     upstream service flow."
1778     ::= { docsIetfQosUpstreamStatsEntry 1 }
1779
1780 docsIetfQosUpstreamFragments OBJECT-TYPE
1781     SYNTAX          Counter32
1782     MAX-ACCESS      read-only
1783     STATUS          current
1784     DESCRIPTION    "The number of fragmentation headers received on an
1785                     upstream service flow, regardless of whether
1786                     the fragment was correctly reassembled into a
1787                     valid packet.
1788
1789                     This counter's last discontinuity is the
1790                     ifCounterDiscontinuityTime for the same ifIndex that
1791                     indexes this object."
1792     ::= { docsIetfQosUpstreamStatsEntry 2 }
1793
1794 docsIetfQosUpstreamFragDiscards OBJECT-TYPE
1795     SYNTAX          Counter32
1796     MAX-ACCESS      read-only
1797     STATUS          current
1798     DESCRIPTION    "The number of upstream fragments discarded and not
1799                     assembled into a valid upstream packet.
1800
1801                     This counter's last discontinuity is the
1802                     ifCounterDiscontinuityTime for the same ifIndex that
1803                     indexes this object."
1804     ::= { docsIetfQosUpstreamStatsEntry 3 }
1805
1806 docsIetfQosUpstreamConcatBursts OBJECT-TYPE
1807     SYNTAX          Counter32
1808
1809
1810
1811     MAX-ACCESS      read-only
1812     STATUS          current
1813     DESCRIPTION    "The number of concatenation headers received on an
1814                     upstream service flow.
1815                     This counter's last discontinuity is the
1816                     ifCounterDiscontinuityTime for the same ifIndex that
1817                     indexes this object."
1818     ::= { docsIetfQosUpstreamStatsEntry 4 }
1819
1820
1821 --
1822 --  Dynamic Service Stats Table
1823 --
1824 docsIetfQosDynamicServiceStatsTable OBJECT-TYPE
1825     SYNTAX          SEQUENCE OF DocsIetfQosDynamicServiceStatsEntry
1826     MAX-ACCESS      not-accessible
1827     STATUS          current
1828     DESCRIPTION    "This table describes statistics associated with the
1829                     Dynamic Service Flows in a managed device."
1830     ::= { docsIetfQosMIBObjects 6 }
1831
1832 docsIetfQosDynamicServiceStatsEntry OBJECT-TYPE
1833     SYNTAX          DocsIetfQosDynamicServiceStatsEntry
1834     MAX-ACCESS      not-accessible
1835     STATUS          current
1836     DESCRIPTION    "Describes a set of dynamic service flow statistics.
1837                     Two entries exist for each DOCSIS MAC layer
1838                     interface for the upstream and downstream
1839                     direction.  On the CMTS, the downstream direction
1840                     row indicates messages transmitted or transactions
1841                     originated by the CMTS.  The upstream direction row
1842                     indicates messages received or transaction
1843                     originated by the CM.  On the CM, the downstream
1844                     direction row indicates messages received or
1845                     transactions originated by the CMTS.  The upstream
1846                     direction row indicates messages transmitted by
1847                     the CM or transactions originated by the CM.
1848                     The ifIndex is an ifType of
1849                     docsCableMaclayer(127)."
1850     INDEX {
1851             ifIndex,
1852             docsIetfQosIfDirection
1853           }
1854     ::= { docsIetfQosDynamicServiceStatsTable 1 }
1855
1856 DocsIetfQosDynamicServiceStatsEntry ::= SEQUENCE {
1857     docsIetfQosIfDirection                DocsIetfQosRfMacIfDirection,
1858     docsIetfQosDSAReqs                    Counter32,
1859
1860
1861
1862     docsIetfQosDSARsps                    Counter32,
1863     docsIetfQosDSAAcks                    Counter32,
1864     docsIetfQosDSCReqs                    Counter32,
1865     docsIetfQosDSCRsps                    Counter32,
1866     docsIetfQosDSCAcks                    Counter32,
1867     docsIetfQosDSDReqs                    Counter32,
1868     docsIetfQosDSDRsps                    Counter32,
1869     docsIetfQosDynamicAdds                Counter32,
1870     docsIetfQosDynamicAddFails            Counter32,
1871     docsIetfQosDynamicChanges             Counter32,
1872     docsIetfQosDynamicChangeFails         Counter32,
1873     docsIetfQosDynamicDeletes             Counter32,
1874     docsIetfQosDynamicDeleteFails         Counter32,
1875     docsIetfQosDCCReqs                    Counter32,
1876     docsIetfQosDCCRsps                    Counter32,
1877     docsIetfQosDCCAcks                    Counter32,
1878     docsIetfQosDCCs                       Counter32,
1879     docsIetfQosDCCFails                   Counter32
1880    }
1881
1882 docsIetfQosIfDirection OBJECT-TYPE
1883     SYNTAX          DocsIetfQosRfMacIfDirection
1884     MAX-ACCESS      not-accessible
1885     STATUS          current
1886     DESCRIPTION    "The direction of interface."
1887     ::= { docsIetfQosDynamicServiceStatsEntry 1 }
1888
1889 docsIetfQosDSAReqs OBJECT-TYPE
1890     SYNTAX          Counter32
1891     MAX-ACCESS      read-only
1892     STATUS          current
1893     DESCRIPTION    "The number of Dynamic Service Addition Requests,
1894                     including retries.
1895
1896                     This counter's last discontinuity is the
1897                     ifCounterDiscontinuityTime for the same ifIndex that
1898                     indexes this object."
1899     ::= { docsIetfQosDynamicServiceStatsEntry 2 }
1900
1901 docsIetfQosDSARsps OBJECT-TYPE
1902     SYNTAX          Counter32
1903     MAX-ACCESS      read-only
1904     STATUS          current
1905     DESCRIPTION    "The number of Dynamic Service Addition Responses,
1906                     including retries.
1907
1908                     This counter's last discontinuity is the
1909                     ifCounterDiscontinuityTime for the same ifIndex that
1910
1911
1912
1913                     indexes this object."
1914     ::= { docsIetfQosDynamicServiceStatsEntry 3 }
1915
1916 docsIetfQosDSAAcks OBJECT-TYPE
1917     SYNTAX          Counter32
1918     MAX-ACCESS      read-only
1919     STATUS          current
1920     DESCRIPTION    "The number of Dynamic Service Addition
1921                     Acknowledgements, including retries.
1922
1923                     This counter's last discontinuity is the
1924                     ifCounterDiscontinuityTime for the same ifIndex that
1925                     indexes this object."
1926     ::= { docsIetfQosDynamicServiceStatsEntry 4 }
1927
1928 docsIetfQosDSCReqs OBJECT-TYPE
1929     SYNTAX          Counter32
1930     MAX-ACCESS      read-only
1931     STATUS          current
1932     DESCRIPTION    "The number of Dynamic Service Change Requests,
1933                     including retries.
1934
1935                     This counter's last discontinuity is the
1936                     ifCounterDiscontinuityTime for the same ifIndex that
1937                     indexes this object."
1938     ::= { docsIetfQosDynamicServiceStatsEntry 5 }
1939
1940 docsIetfQosDSCRsps OBJECT-TYPE
1941     SYNTAX          Counter32
1942     MAX-ACCESS      read-only
1943     STATUS          current
1944     DESCRIPTION    "The number of Dynamic Service Change Responses,
1945                     including retries.
1946
1947                     This counter's last discontinuity is the
1948                     ifCounterDiscontinuityTime for the same ifIndex that
1949                     indexes this object."
1950     ::= { docsIetfQosDynamicServiceStatsEntry 6 }
1951
1952 docsIetfQosDSCAcks OBJECT-TYPE
1953     SYNTAX          Counter32
1954     MAX-ACCESS      read-only
1955     STATUS          current
1956     DESCRIPTION    "The number of Dynamic Service Change
1957                     Acknowledgements, including retries.
1958
1959                     This counter's last discontinuity is the
1960                     ifCounterDiscontinuityTime for the same ifIndex that
1961
1962
1963
1964                     indexes this object."
1965     ::= { docsIetfQosDynamicServiceStatsEntry 7 }
1966
1967 docsIetfQosDSDReqs OBJECT-TYPE
1968     SYNTAX          Counter32
1969     MAX-ACCESS      read-only
1970     STATUS          current
1971     DESCRIPTION    "The number of Dynamic Service Delete Requests,
1972                     including retries.
1973
1974                     This counter's last discontinuity is the
1975                     ifCounterDiscontinuityTime for the same ifIndex that
1976                     indexes this object."
1977     ::= { docsIetfQosDynamicServiceStatsEntry 8 }
1978
1979 docsIetfQosDSDRsps OBJECT-TYPE
1980     SYNTAX          Counter32
1981     MAX-ACCESS      read-only
1982     STATUS          current
1983     DESCRIPTION    "The number of Dynamic Service Delete Responses,
1984                     including retries.
1985
1986                     This counter's last discontinuity is the
1987                     ifCounterDiscontinuityTime for the same ifIndex that
1988                     indexes this object."
1989     ::= { docsIetfQosDynamicServiceStatsEntry 9 }
1990
1991 docsIetfQosDynamicAdds OBJECT-TYPE
1992     SYNTAX          Counter32
1993     MAX-ACCESS      read-only
1994     STATUS          current
1995     DESCRIPTION    "The number of successful Dynamic Service Addition
1996                     transactions.
1997
1998                     This counter's last discontinuity is the
1999                     ifCounterDiscontinuityTime for the same ifIndex that
2000                     indexes this object."
2001     ::= { docsIetfQosDynamicServiceStatsEntry 10 }
2002
2003 docsIetfQosDynamicAddFails OBJECT-TYPE
2004     SYNTAX          Counter32
2005     MAX-ACCESS      read-only
2006     STATUS          current
2007     DESCRIPTION    "The number of failed Dynamic Service Addition
2008                     transactions.
2009
2010                     This counter's last discontinuity is the
2011                     ifCounterDiscontinuityTime for the same ifIndex that
2012
2013
2014
2015                     indexes this object."
2016     ::= { docsIetfQosDynamicServiceStatsEntry 11 }
2017
2018 docsIetfQosDynamicChanges OBJECT-TYPE
2019     SYNTAX          Counter32
2020     MAX-ACCESS      read-only
2021     STATUS          current
2022     DESCRIPTION    "The number of successful Dynamic Service Change
2023                     transactions.
2024
2025                     This counter's last discontinuity is the
2026                     ifCounterDiscontinuityTime for the same ifIndex that
2027                     indexes this object."
2028     ::= { docsIetfQosDynamicServiceStatsEntry 12 }
2029
2030 docsIetfQosDynamicChangeFails OBJECT-TYPE
2031     SYNTAX          Counter32
2032     MAX-ACCESS      read-only
2033     STATUS          current
2034     DESCRIPTION    "The number of failed Dynamic Service Change
2035                     transactions.
2036
2037                     This counter's last discontinuity is the
2038                     ifCounterDiscontinuityTime for the same ifIndex that
2039                     indexes this object."
2040     ::= { docsIetfQosDynamicServiceStatsEntry 13 }
2041
2042 docsIetfQosDynamicDeletes OBJECT-TYPE
2043     SYNTAX          Counter32
2044     MAX-ACCESS      read-only
2045     STATUS          current
2046     DESCRIPTION    "The number of successful Dynamic Service Delete
2047                     transactions.
2048
2049                     This counter's last discontinuity is the
2050                     ifCounterDiscontinuityTime for the same ifIndex that
2051                     indexes this object."
2052     ::= { docsIetfQosDynamicServiceStatsEntry 14 }
2053
2054 docsIetfQosDynamicDeleteFails OBJECT-TYPE
2055     SYNTAX          Counter32
2056     MAX-ACCESS      read-only
2057     STATUS          current
2058     DESCRIPTION    "The number of failed Dynamic Service Delete
2059                     transactions.
2060
2061                     This counter's last discontinuity is the
2062                     ifCounterDiscontinuityTime for the same ifIndex that
2063
2064
2065
2066                     indexes this object."
2067     ::= { docsIetfQosDynamicServiceStatsEntry 15 }
2068
2069
2070 docsIetfQosDCCReqs OBJECT-TYPE
2071     SYNTAX          Counter32
2072     MAX-ACCESS      read-only
2073     STATUS          current
2074     DESCRIPTION    "The number of Dynamic Channel Change Request
2075                     messages traversing an interface.  This count
2076                     is nonzero only on downstream direction rows.
2077                     This count should include the number of retries.
2078
2079                     This counter's last discontinuity is the
2080                     ifCounterDiscontinuityTime for the same ifIndex
2081                     that indexes this object."
2082     ::= { docsIetfQosDynamicServiceStatsEntry 16 }
2083
2084 docsIetfQosDCCRsps OBJECT-TYPE
2085     SYNTAX          Counter32
2086     MAX-ACCESS      read-only
2087     STATUS          current
2088     DESCRIPTION    "The number of Dynamic Channel Change Response
2089                     messages traversing an interface.  This count is
2090                     nonzero only on upstream direction rows.  This count
2091                     should include the number of retries.
2092
2093                     This counter's last discontinuity is the
2094                     ifCounterDiscontinuityTime for the same ifIndex that
2095                     indexes this object."
2096     ::= { docsIetfQosDynamicServiceStatsEntry 17 }
2097
2098 docsIetfQosDCCAcks OBJECT-TYPE
2099     SYNTAX          Counter32
2100     MAX-ACCESS      read-only
2101     STATUS          current
2102     DESCRIPTION    "The number of Dynamic Channel Change Acknowledgement
2103                     messages traversing an interface.  This count
2104                     is nonzero only on downstream direction rows.
2105                     This count should include the number of retries.
2106
2107                     This counter's last discontinuity is the
2108                     ifCounterDiscontinuityTime for the same ifIndex that
2109                     indexes this object."
2110     ::= { docsIetfQosDynamicServiceStatsEntry 18 }
2111
2112 docsIetfQosDCCs OBJECT-TYPE
2113     SYNTAX          Counter32
2114
2115
2116
2117     MAX-ACCESS      read-only
2118     STATUS          current
2119     DESCRIPTION    "The number of successful Dynamic Channel Change
2120                     transactions.  This count is nonzero only on
2121                     downstream direction rows.
2122
2123                     This counter's last discontinuity is the
2124                     ifCounterDiscontinuityTime for the same ifIndex that
2125                     indexes this object."
2126     ::= { docsIetfQosDynamicServiceStatsEntry 19 }
2127
2128 docsIetfQosDCCFails OBJECT-TYPE
2129     SYNTAX          Counter32
2130     MAX-ACCESS      read-only
2131     STATUS          current
2132     DESCRIPTION    "The number of failed Dynamic Channel Change
2133                     transactions.  This count is nonzero only on
2134                     downstream direction rows.
2135
2136                     This counter's last discontinuity is the
2137                     ifCounterDiscontinuityTime for the same ifIndex that
2138                     indexes this object."
2139     ::= { docsIetfQosDynamicServiceStatsEntry 20 }
2140
2141
2142 --
2143 --  Service Flow Log Table (CMTS ONLY)
2144 --
2145 docsIetfQosServiceFlowLogTable OBJECT-TYPE
2146     SYNTAX          SEQUENCE OF DocsIetfQosServiceFlowLogEntry
2147     MAX-ACCESS      not-accessible
2148     STATUS          current
2149     DESCRIPTION    "This table contains a log of the disconnected
2150                     Service Flows in a managed device."
2151     ::= { docsIetfQosMIBObjects 7 }
2152
2153 docsIetfQosServiceFlowLogEntry OBJECT-TYPE
2154     SYNTAX          DocsIetfQosServiceFlowLogEntry
2155     MAX-ACCESS      not-accessible
2156     STATUS          current
2157     DESCRIPTION    "The information regarding a single disconnected
2158                     service flow."
2159     INDEX {
2160             docsIetfQosServiceFlowLogIndex
2161           }
2162     ::= { docsIetfQosServiceFlowLogTable 1 }
2163
2164 DocsIetfQosServiceFlowLogEntry ::= SEQUENCE {
2165
2166
2167
2168     docsIetfQosServiceFlowLogIndex                 Unsigned32,
2169     docsIetfQosServiceFlowLogIfIndex               InterfaceIndex,
2170     docsIetfQosServiceFlowLogSFID                  Unsigned32,
2171     docsIetfQosServiceFlowLogCmMac                 MacAddress,
2172     docsIetfQosServiceFlowLogPkts                  Counter64,
2173     docsIetfQosServiceFlowLogOctets                Counter64,
2174     docsIetfQosServiceFlowLogTimeDeleted           TimeStamp,
2175     docsIetfQosServiceFlowLogTimeCreated           TimeStamp,
2176     docsIetfQosServiceFlowLogTimeActive            Counter32,
2177     docsIetfQosServiceFlowLogDirection    DocsIetfQosRfMacIfDirection,
2178     docsIetfQosServiceFlowLogPrimary               TruthValue,
2179     docsIetfQosServiceFlowLogServiceClassName      SnmpAdminString,
2180     docsIetfQosServiceFlowLogPolicedDropPkts       Counter32,
2181     docsIetfQosServiceFlowLogPolicedDelayPkts      Counter32,
2182     docsIetfQosServiceFlowLogControl               INTEGER
2183     }
2184
2185 docsIetfQosServiceFlowLogIndex OBJECT-TYPE
2186     SYNTAX          Unsigned32 (1..4294967295)
2187     MAX-ACCESS      not-accessible
2188     STATUS          current
2189     DESCRIPTION    "Unique index for a logged service flow."
2190     ::= { docsIetfQosServiceFlowLogEntry 1 }
2191
2192 docsIetfQosServiceFlowLogIfIndex OBJECT-TYPE
2193     SYNTAX          InterfaceIndex
2194     MAX-ACCESS      read-only
2195     STATUS          current
2196     DESCRIPTION    "The ifIndex of ifType docsCableMaclayer(127)
2197                     on the CMTS where the service flow was present."
2198     ::= {  docsIetfQosServiceFlowLogEntry 2 }
2199
2200 docsIetfQosServiceFlowLogSFID    OBJECT-TYPE
2201     SYNTAX          Unsigned32 (1..4294967295)
2202     MAX-ACCESS      read-only
2203     STATUS          current
2204     DESCRIPTION    "The index assigned to the service flow by the CMTS."
2205     ::= {  docsIetfQosServiceFlowLogEntry 3 }
2206
2207 docsIetfQosServiceFlowLogCmMac OBJECT-TYPE
2208     SYNTAX          MacAddress
2209     MAX-ACCESS      read-only
2210     STATUS          current
2211     DESCRIPTION    "The MAC address for the cable modem associated with
2212                     the service flow."
2213     ::= { docsIetfQosServiceFlowLogEntry 4 }
2214
2215 docsIetfQosServiceFlowLogPkts OBJECT-TYPE
2216
2217
2218
2219     SYNTAX          Counter64
2220     MAX-ACCESS      read-only
2221     STATUS          current
2222     DESCRIPTION    "The number of packets counted on this service flow
2223                     after payload header suppression."
2224     ::= { docsIetfQosServiceFlowLogEntry 5 }
2225
2226 docsIetfQosServiceFlowLogOctets OBJECT-TYPE
2227     SYNTAX          Counter64
2228     MAX-ACCESS      read-only
2229     STATUS          current
2230     DESCRIPTION    "The number of octets counted on this service flow
2231                     after payload header suppression."
2232     ::= { docsIetfQosServiceFlowLogEntry 6 }
2233
2234 docsIetfQosServiceFlowLogTimeDeleted OBJECT-TYPE
2235     SYNTAX          TimeStamp
2236     MAX-ACCESS      read-only
2237     STATUS          current
2238     DESCRIPTION    "The value of sysUpTime when the service flow
2239                     was deleted."
2240     ::= { docsIetfQosServiceFlowLogEntry 7 }
2241
2242 docsIetfQosServiceFlowLogTimeCreated OBJECT-TYPE
2243     SYNTAX          TimeStamp
2244     MAX-ACCESS      read-only
2245     STATUS          current
2246     DESCRIPTION    "The value of sysUpTime when the service flow
2247                     was created."
2248     ::= { docsIetfQosServiceFlowLogEntry 8 }
2249
2250 docsIetfQosServiceFlowLogTimeActive OBJECT-TYPE
2251     SYNTAX          Counter32
2252     UNITS           "seconds"
2253     MAX-ACCESS      read-only
2254     STATUS          current
2255     DESCRIPTION    "The total time that the service flow was active."
2256     ::= { docsIetfQosServiceFlowLogEntry 9 }
2257
2258 docsIetfQosServiceFlowLogDirection OBJECT-TYPE
2259     SYNTAX          DocsIetfQosRfMacIfDirection
2260     MAX-ACCESS      read-only
2261     STATUS          current
2262     DESCRIPTION    "The value of docsIetfQosServiceFlowDirection
2263                     for the service flow."
2264     ::= { docsIetfQosServiceFlowLogEntry  10 }
2265
2266 docsIetfQosServiceFlowLogPrimary OBJECT-TYPE
2267
2268
2269
2270     SYNTAX          TruthValue
2271     MAX-ACCESS      read-only
2272     STATUS          current
2273     DESCRIPTION    "The value of docsIetfQosServiceFlowPrimary for the
2274                     service flow."
2275     ::= { docsIetfQosServiceFlowLogEntry 11 }
2276
2277 docsIetfQosServiceFlowLogServiceClassName OBJECT-TYPE
2278     SYNTAX          SnmpAdminString
2279     MAX-ACCESS      read-only
2280     STATUS          current
2281     DESCRIPTION    "The value of docsIetfQosParamSetServiceClassName for
2282                     the provisioned QOS Parameter Set of the
2283                     service flow."
2284     ::= { docsIetfQosServiceFlowLogEntry  12 }
2285
2286 docsIetfQosServiceFlowLogPolicedDropPkts OBJECT-TYPE
2287     SYNTAX          Counter32
2288     MAX-ACCESS      read-only
2289     STATUS          current
2290     DESCRIPTION    "The final value of
2291                     docsIetfQosServiceFlowPolicedDropPkts for the
2292                     service flow."
2293     ::= { docsIetfQosServiceFlowLogEntry  13 }
2294
2295 docsIetfQosServiceFlowLogPolicedDelayPkts OBJECT-TYPE
2296     SYNTAX          Counter32
2297     MAX-ACCESS      read-only
2298     STATUS          current
2299     DESCRIPTION    "The final value of
2300                     docsIetfQosServiceFlowPolicedDelayPkts for the
2301                     service flow."
2302     ::= { docsIetfQosServiceFlowLogEntry  14 }
2303
2304 docsIetfQosServiceFlowLogControl OBJECT-TYPE
2305     SYNTAX          INTEGER {
2306                      active(1),
2307                      destroy(6)
2308                     }
2309
2310     MAX-ACCESS      read-write
2311     STATUS          current
2312     DESCRIPTION    "Setting this object to the value destroy(6) removes
2313                     this entry from the table.
2314
2315                     Reading this object returns the value active(1)."
2316     ::= { docsIetfQosServiceFlowLogEntry 15 }
2317
2318
2319
2320
2321 --
2322 -- Service Class Table (CMTS ONLY)
2323 --
2324 docsIetfQosServiceClassTable OBJECT-TYPE
2325     SYNTAX          SEQUENCE OF DocsIetfQosServiceClassEntry
2326     MAX-ACCESS      not-accessible
2327     STATUS          current
2328     DESCRIPTION    "This table describes the set of DOCSIS-QOS
2329                     Service Classes in a CMTS."
2330     ::= { docsIetfQosMIBObjects 8 }
2331
2332 docsIetfQosServiceClassEntry OBJECT-TYPE
2333     SYNTAX          DocsIetfQosServiceClassEntry
2334     MAX-ACCESS      not-accessible
2335     STATUS          current
2336     DESCRIPTION    "A provisioned service class on a CMTS.
2337                     Each entry defines a template for certain
2338                     DOCSIS QOS Parameter Set values.  When a CM
2339                     creates or modifies an Admitted QOS Parameter Set
2340                     for a Service Flow, it may reference a Service Class
2341                     Name instead of providing explicit QOS Parameter
2342                     Set values.  In this case, the CMTS populates
2343                     the QOS Parameter Set with the applicable
2344                     corresponding values from the named Service Class.
2345                     Subsequent changes to a Service Class row do not
2346                     affect the QOS Parameter Set values of any service
2347                     flows already admitted.
2348
2349                     A service class template applies to only
2350                     a single direction, as indicated in the
2351                     docsIetfQosServiceClassDirection object."
2352     INDEX {
2353              docsIetfQosServiceClassName
2354           }
2355     ::= { docsIetfQosServiceClassTable 1 }
2356
2357 DocsIetfQosServiceClassEntry ::= SEQUENCE {
2358     docsIetfQosServiceClassName               SnmpAdminString,
2359     docsIetfQosServiceClassStatus             RowStatus,
2360     docsIetfQosServiceClassPriority           Integer32,
2361     docsIetfQosServiceClassMaxTrafficRate     DocsIetfQosBitRate,
2362     docsIetfQosServiceClassMaxTrafficBurst    Unsigned32,
2363     docsIetfQosServiceClassMinReservedRate    DocsIetfQosBitRate,
2364     docsIetfQosServiceClassMinReservedPkt     Integer32,
2365     docsIetfQosServiceClassMaxConcatBurst     Integer32,
2366     docsIetfQosServiceClassNomPollInterval    Unsigned32,
2367     docsIetfQosServiceClassTolPollJitter      Unsigned32,
2368     docsIetfQosServiceClassUnsolicitGrantSize Integer32,
2369
2370
2371
2372     docsIetfQosServiceClassNomGrantInterval   Unsigned32,
2373     docsIetfQosServiceClassTolGrantJitter     Unsigned32,
2374     docsIetfQosServiceClassGrantsPerInterval  Integer32,
2375     docsIetfQosServiceClassMaxLatency         Unsigned32,
2376     docsIetfQosServiceClassActiveTimeout      Integer32,
2377     docsIetfQosServiceClassAdmittedTimeout    Integer32,
2378     docsIetfQosServiceClassSchedulingType     DocsIetfQosSchedulingType,
2379     docsIetfQosServiceClassRequestPolicy      OCTET STRING,
2380     docsIetfQosServiceClassTosAndMask         OCTET STRING,
2381     docsIetfQosServiceClassTosOrMask          OCTET STRING,
2382     docsIetfQosServiceClassDirection        DocsIetfQosRfMacIfDirection,
2383     docsIetfQosServiceClassStorageType        StorageType,
2384     docsIetfQosServiceClassDSCPOverwrite      DscpOrAny
2385     }
2386
2387 docsIetfQosServiceClassName OBJECT-TYPE
2388     SYNTAX          SnmpAdminString (SIZE (1..15))
2389     MAX-ACCESS      not-accessible
2390     STATUS          current
2391     DESCRIPTION    "Service Class Name.  DOCSIS specifies that the
2392                     maximum size is 16 ASCII characters including
2393                     a terminating zero.  The terminating zero is not
2394                     represented in this SnmpAdminString syntax object."
2395     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.4"
2396     ::= { docsIetfQosServiceClassEntry 1 }
2397
2398 docsIetfQosServiceClassStatus OBJECT-TYPE
2399     SYNTAX          RowStatus
2400     MAX-ACCESS      read-create
2401     STATUS          current
2402     DESCRIPTION    "Used to create or delete rows in this table.
2403                     There is no restriction on the ability to change
2404                     values in this row while the row is active.
2405                     Inactive rows need not be timed out."
2406     ::= { docsIetfQosServiceClassEntry 2 }
2407
2408 docsIetfQosServiceClassPriority OBJECT-TYPE
2409     SYNTAX          Integer32 (0..7)
2410     MAX-ACCESS      read-create
2411     STATUS          current
2412     DESCRIPTION    "Template for docsIetfQosParamSetPriority."
2413     DEFVAL          { 0 }
2414     ::= { docsIetfQosServiceClassEntry 3 }
2415
2416 docsIetfQosServiceClassMaxTrafficRate OBJECT-TYPE
2417     SYNTAX          DocsIetfQosBitRate
2418     MAX-ACCESS      read-create
2419     STATUS          current
2420
2421
2422
2423     DESCRIPTION    "Template for docsIetfQosParamSetMaxTrafficRate."
2424     DEFVAL          { 0 }
2425     ::= { docsIetfQosServiceClassEntry 4 }
2426
2427 docsIetfQosServiceClassMaxTrafficBurst OBJECT-TYPE
2428     SYNTAX          Unsigned32
2429     MAX-ACCESS      read-create
2430     STATUS          current
2431     DESCRIPTION    "Template for docsIetfQosParamSetMaxTrafficBurst."
2432     DEFVAL          { 3044 }
2433     ::= { docsIetfQosServiceClassEntry 5 }
2434
2435 docsIetfQosServiceClassMinReservedRate OBJECT-TYPE
2436     SYNTAX          DocsIetfQosBitRate
2437     MAX-ACCESS      read-create
2438     STATUS          current
2439     DESCRIPTION    "Template for docsIetfQosParamSEtMinReservedRate."
2440     DEFVAL          { 0 }
2441     ::= { docsIetfQosServiceClassEntry 6 }
2442
2443 docsIetfQosServiceClassMinReservedPkt OBJECT-TYPE
2444     SYNTAX          Integer32 (0..65535)
2445     MAX-ACCESS      read-create
2446     STATUS          current
2447     DESCRIPTION    "Template for docsIetfQosParamSetMinReservedPkt."
2448     ::= { docsIetfQosServiceClassEntry 7 }
2449
2450 docsIetfQosServiceClassMaxConcatBurst OBJECT-TYPE
2451     SYNTAX          Integer32 (0..65535)
2452     MAX-ACCESS      read-create
2453     STATUS          current
2454     DESCRIPTION    "Template for docsIetfQosParamSetMaxConcatBurst."
2455     DEFVAL          { 1522 }
2456     ::= { docsIetfQosServiceClassEntry 8 }
2457
2458 docsIetfQosServiceClassNomPollInterval OBJECT-TYPE
2459     SYNTAX          Unsigned32
2460     UNITS           "microseconds"
2461     MAX-ACCESS      read-create
2462     STATUS          current
2463     DESCRIPTION    "Template for docsIetfQosParamSetNomPollInterval."
2464     DEFVAL          { 0 }
2465     ::= { docsIetfQosServiceClassEntry 9 }
2466
2467 docsIetfQosServiceClassTolPollJitter OBJECT-TYPE
2468     SYNTAX          Unsigned32
2469     UNITS           "microseconds"
2470     MAX-ACCESS      read-create
2471
2472
2473
2474     STATUS          current
2475     DESCRIPTION    "Template for docsIetfQosParamSetTolPollJitter."
2476     DEFVAL          { 0 }
2477     ::= { docsIetfQosServiceClassEntry 10 }
2478
2479 docsIetfQosServiceClassUnsolicitGrantSize OBJECT-TYPE
2480     SYNTAX          Integer32 (0..65535)
2481     MAX-ACCESS      read-create
2482     STATUS          current
2483     DESCRIPTION    "Template for docsIetfQosParamSetUnsolicitGrantSize."
2484     DEFVAL          { 0 }
2485     ::= { docsIetfQosServiceClassEntry 11 }
2486
2487 docsIetfQosServiceClassNomGrantInterval OBJECT-TYPE
2488     SYNTAX          Unsigned32
2489     UNITS           "microseconds"
2490     MAX-ACCESS      read-create
2491     STATUS          current
2492     DESCRIPTION    "Template for docsIetfQosParamSetNomGrantInterval."
2493     DEFVAL          { 0 }
2494     ::= { docsIetfQosServiceClassEntry 12 }
2495
2496 docsIetfQosServiceClassTolGrantJitter OBJECT-TYPE
2497     SYNTAX          Unsigned32
2498     UNITS           "microseconds"
2499     MAX-ACCESS      read-create
2500     STATUS          current
2501     DESCRIPTION    "Template for docsIetfQosParamSetTolGrantJitter."
2502     DEFVAL          { 0 }
2503     ::= { docsIetfQosServiceClassEntry 13 }
2504
2505 docsIetfQosServiceClassGrantsPerInterval OBJECT-TYPE
2506     SYNTAX          Integer32 (0..127)
2507     MAX-ACCESS      read-create
2508     STATUS          current
2509     DESCRIPTION    "Template for docsIetfQosParamSetGrantsPerInterval."
2510     DEFVAL          { 0 }
2511     ::= { docsIetfQosServiceClassEntry 14 }
2512
2513 docsIetfQosServiceClassMaxLatency OBJECT-TYPE
2514     SYNTAX          Unsigned32
2515     UNITS           "microseconds"
2516     MAX-ACCESS      read-create
2517     STATUS          current
2518     DESCRIPTION    "Template for docsIetfQosParamSetClassMaxLatency."
2519     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.7.1"
2520     DEFVAL          { 0 }
2521     ::= { docsIetfQosServiceClassEntry 15 }
2522
2523
2524
2525 docsIetfQosServiceClassActiveTimeout OBJECT-TYPE
2526     SYNTAX          Integer32 (0..65535)
2527     UNITS           "seconds"
2528     MAX-ACCESS      read-create
2529     STATUS          current
2530     DESCRIPTION    "Template for docsIetfQosParamSetActiveTimeout."
2531     DEFVAL          { 0 }
2532     ::= { docsIetfQosServiceClassEntry 16 }
2533
2534 docsIetfQosServiceClassAdmittedTimeout OBJECT-TYPE
2535     SYNTAX          Integer32 (0..65535)
2536     UNITS           "seconds"
2537     MAX-ACCESS      read-create
2538     STATUS          current
2539     DESCRIPTION    "Template for docsIetfQosParamSetAdmittedTimeout."
2540     DEFVAL          { 200 }
2541     ::= { docsIetfQosServiceClassEntry 17 }
2542
2543 docsIetfQosServiceClassSchedulingType OBJECT-TYPE
2544     SYNTAX          DocsIetfQosSchedulingType
2545     MAX-ACCESS      read-create
2546     STATUS          current
2547     DESCRIPTION    "Template for docsIetfQosParamSetSchedulingType."
2548     DEFVAL          { bestEffort }
2549     ::= { docsIetfQosServiceClassEntry 18 }
2550
2551 docsIetfQosServiceClassRequestPolicy OBJECT-TYPE
2552     SYNTAX          OCTET STRING (SIZE(4))
2553     MAX-ACCESS      read-create
2554     STATUS          current
2555     DESCRIPTION    "Template for docsIetfQosParamSetRequestPolicyOct."
2556     DEFVAL          { '00000000'H } -- no bits are set
2557     ::= { docsIetfQosServiceClassEntry 19 }
2558
2559 docsIetfQosServiceClassTosAndMask OBJECT-TYPE
2560     SYNTAX          OCTET STRING (SIZE(1))
2561     MAX-ACCESS      read-only
2562     STATUS          current
2563     DESCRIPTION    "Template for docsIetfQosParamSetTosAndMask.
2564                     The IP TOS octet as originally defined in RFC 791
2565                     has been superseded by the 6-bit Differentiated
2566                     Services Field (DSField, RFC 3260) and the 2-bit
2567                     Explicit Congestion Notification Field (ECN field,
2568                     RFC 3168).  Network operators SHOULD avoid
2569                     specifying values of
2570                     docsIetfQosServiceClassTosAndMask and
2571                     docsIetfQosServiceClassTosOrMask that would result
2572                     in the modification of the ECN bits.
2573
2574
2575
2576                     In particular, operators should not use values of
2577                     docsIetfQosServiceClassTosAndMask that have either
2578                     of the least-significant two bits set to 0.
2579                     Similarly,operators should not use values of
2580                     docsIetfQosServiceClassTosOrMask that have either
2581                     of the least-significant two bits set to 1."
2582     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10;
2583                     RFC 3168, The Addition of Explicit Congestion
2584                     Notification (ECN) to IP;
2585                     RFC 3260, New Terminology and Clarifications for
2586                     Diffserv."
2587     ::= { docsIetfQosServiceClassEntry 20 }
2588
2589 docsIetfQosServiceClassTosOrMask OBJECT-TYPE
2590     SYNTAX          OCTET STRING (SIZE(1))
2591     MAX-ACCESS      read-only
2592     STATUS          current
2593     DESCRIPTION    "Template for docsIetfQosParamSetTosOrMask.
2594                     The IP TOS octet as originally defined in RFC 791
2595                     has been superseded by the 6-bit Differentiated
2596                     Services Field (DSField, RFC 3260) and the 2-bit
2597                     Explicit Congestion Notification Field (ECN field,
2598                     RFC 3168).  Network operators SHOULD avoid
2599                     specifying values of
2600                     docsIetfQosServiceClassTosAndMask and
2601                     docsIetfQosServiceClassTosOrMask that would result
2602                     in the modification of the ECN bits.
2603
2604                     In particular, operators should not use values of
2605                     docsIetfQosServiceClassTosAndMask that have either
2606                     of the least-significant two bits set to 0.
2607                     Similarly, operators should not use values of
2608                     docsIetfQosServiceClassTosOrMask that have either
2609                     of the least-significant two bits set to 1."
2610     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10;
2611                     RFC 3168, The Addition of Explicit Congestion
2612                     Notification (ECN) to IP;
2613                     RFC 3260, New Terminology and Clarifications for
2614                     Diffserv."
2615     ::= { docsIetfQosServiceClassEntry 21 }
2616
2617 docsIetfQosServiceClassDirection OBJECT-TYPE
2618     SYNTAX          DocsIetfQosRfMacIfDirection
2619     MAX-ACCESS      read-create
2620     STATUS          current
2621     DESCRIPTION    "Specifies whether the service class template
2622                     applies to upstream or downstream service flows."
2623     DEFVAL          { upstream }
2624
2625
2626
2627     ::= { docsIetfQosServiceClassEntry 22 }
2628
2629 docsIetfQosServiceClassStorageType OBJECT-TYPE
2630     SYNTAX          StorageType
2631     MAX-ACCESS      read-create
2632     STATUS          current
2633     DESCRIPTION    "This object defines whether this row is kept in
2634                     volatile storage and lost upon reboot or whether
2635                     it is backed up by non-volatile or permanent
2636                     storage.  'permanent' entries need not allow
2637                     writable access to any object."
2638     DEFVAL { nonVolatile }
2639     ::= { docsIetfQosServiceClassEntry 23 }
2640
2641 docsIetfQosServiceClassDSCPOverwrite OBJECT-TYPE
2642     SYNTAX          DscpOrAny
2643     MAX-ACCESS      read-create
2644     STATUS          current
2645     DESCRIPTION    "This object allows the overwrite of the DSCP
2646                     field per RFC 3260.
2647
2648                     If this object is -1, then the corresponding entry's
2649                     docsIetfQosServiceClassTosAndMask value MUST be
2650                     'FF'H and docsIetfQosServiceClassTosOrMask MUST be
2651                     '00'H.  Otherwise, this object is in the range of
2652                     0..63, and the corresponding entry's
2653                     docsIetfQosServiceClassTosAndMask value MUST be
2654                     '03'H and the docsIetfQosServiceClassTosOrMask MUST
2655                     be this object's value shifted left by two bit
2656                     positions."
2657     REFERENCE      "RFC 3168, The Addition of Explicit Congestion
2658                     Notification (ECN) to IP;
2659                     RFC 3260, New Terminology and Clarifications for
2660                     Diffserv."
2661     DEFVAL          { -1 }
2662     ::= { docsIetfQosServiceClassEntry 24 }
2663
2664 --
2665 -- Service Class PolicyTable
2666 --
2667 docsIetfQosServiceClassPolicyTable OBJECT-TYPE
2668     SYNTAX          SEQUENCE OF DocsIetfQosServiceClassPolicyEntry
2669     MAX-ACCESS      not-accessible
2670     STATUS          current
2671     DESCRIPTION    "This table describes the set of DOCSIS-QOS
2672                     Service Class Policies.
2673
2674                     This table is an adjunct to the
2675
2676
2677
2678                     docsDevFilterPolicy table.   Entries in the
2679                     docsDevFilterPolicy table can point to
2680                     specific rows in this table.
2681
2682                     This table permits mapping a packet to a service
2683                     class name of an active service flow so long as
2684                     a classifier does not exist at a higher
2685                     priority."
2686     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix E.2.1"
2687     ::= { docsIetfQosMIBObjects 9 }
2688
2689 docsIetfQosServiceClassPolicyEntry OBJECT-TYPE
2690     SYNTAX          DocsIetfQosServiceClassPolicyEntry
2691     MAX-ACCESS      not-accessible
2692     STATUS          current
2693     DESCRIPTION    "A service class name policy entry."
2694     INDEX {
2695             docsIetfQosServiceClassPolicyIndex
2696           }
2697     ::= { docsIetfQosServiceClassPolicyTable 1 }
2698
2699 DocsIetfQosServiceClassPolicyEntry ::= SEQUENCE {
2700     docsIetfQosServiceClassPolicyIndex        Unsigned32,
2701     docsIetfQosServiceClassPolicyName         SnmpAdminString,
2702     docsIetfQosServiceClassPolicyRulePriority Integer32,
2703     docsIetfQosServiceClassPolicyStatus       RowStatus,
2704     docsIetfQosServiceClassPolicyStorageType  StorageType
2705     }
2706
2707 docsIetfQosServiceClassPolicyIndex OBJECT-TYPE
2708     SYNTAX          Unsigned32 (1..2147483647)
2709     MAX-ACCESS      not-accessible
2710     STATUS          current
2711     DESCRIPTION    "Index value to identify an entry in
2712                     this table uniquely."
2713     ::= { docsIetfQosServiceClassPolicyEntry 1 }
2714
2715 docsIetfQosServiceClassPolicyName OBJECT-TYPE
2716     SYNTAX          SnmpAdminString
2717     MAX-ACCESS      read-create
2718     STATUS          current
2719     DESCRIPTION    "Service Class Name to identify the name of the
2720                     service class flow to which the packet should be
2721                     directed."
2722     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix E.2.1"
2723     ::= { docsIetfQosServiceClassPolicyEntry 2 }
2724
2725 docsIetfQosServiceClassPolicyRulePriority OBJECT-TYPE
2726
2727
2728
2729     SYNTAX          Integer32 (0..255)
2730     MAX-ACCESS      read-create
2731     STATUS          current
2732     DESCRIPTION    "Service Class Policy rule priority for the
2733                     entry."
2734     REFERENCE      "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.5"
2735     ::= { docsIetfQosServiceClassPolicyEntry 3 }
2736
2737 docsIetfQosServiceClassPolicyStatus OBJECT-TYPE
2738     SYNTAX          RowStatus
2739     MAX-ACCESS      read-create
2740     STATUS          current
2741     DESCRIPTION    "Used to create or delete rows in this table.
2742                     This object should not be deleted if it is
2743                     referenced by an entry in docsDevFilterPolicy.
2744                     The reference should be deleted first.
2745                     There is no restriction on the ability
2746                     to change values in this row while the row is
2747                     active.  Inactive rows need not be timed out."
2748     ::= { docsIetfQosServiceClassPolicyEntry 4 }
2749
2750 docsIetfQosServiceClassPolicyStorageType OBJECT-TYPE
2751     SYNTAX          StorageType
2752     MAX-ACCESS      read-create
2753     STATUS          current
2754     DESCRIPTION    "This object defines whether this row is kept in
2755                     volatile storage and lost upon reboot or whether
2756                     it is backed up by non-volatile or permanent
2757                     storage.  'permanent' entries need not allow
2758                     writable access to any object."
2759     DEFVAL { nonVolatile }
2760     ::= { docsIetfQosServiceClassPolicyEntry 5 }
2761
2762 --
2763 -- Payload Header Suppression(PHS) Table
2764 --
2765 docsIetfQosPHSTable OBJECT-TYPE
2766     SYNTAX          SEQUENCE OF DocsIetfQosPHSEntry
2767     MAX-ACCESS      not-accessible
2768     STATUS          current
2769     DESCRIPTION    "This table describes the set of payload header
2770                     suppression entries."
2771     ::= { docsIetfQosMIBObjects 10 }
2772
2773 docsIetfQosPHSEntry OBJECT-TYPE
2774     SYNTAX          DocsIetfQosPHSEntry
2775     MAX-ACCESS      not-accessible
2776     STATUS          current
2777
2778
2779
2780     DESCRIPTION    "A payload header suppression entry.
2781
2782                     The ifIndex is an ifType of docsCableMaclayer(127).
2783                     The index docsIetfQosServiceFlowId selects one
2784                     service flow from the cable MAC layer interface.
2785                     The docsIetfQosPktClassId index matches an
2786                     index of the docsIetfQosPktClassTable."
2787     INDEX {
2788             ifIndex,
2789             docsIetfQosServiceFlowId,
2790             docsIetfQosPktClassId
2791           }
2792     ::= { docsIetfQosPHSTable 1 }
2793
2794 DocsIetfQosPHSEntry ::= SEQUENCE {
2795     docsIetfQosPHSField            OCTET STRING,
2796     docsIetfQosPHSMask             OCTET STRING,
2797     docsIetfQosPHSSize             Integer32,
2798     docsIetfQosPHSVerify           TruthValue,
2799     docsIetfQosPHSIndex            Integer32
2800     }
2801
2802 docsIetfQosPHSField         OBJECT-TYPE
2803     SYNTAX          OCTET STRING (SIZE(0..255))
2804     MAX-ACCESS      read-only
2805     STATUS          current
2806     DESCRIPTION    "Payload header suppression field defines the
2807                     bytes of the header that must be
2808                     suppressed/restored by the sending/receiving
2809                     device.
2810
2811                     The number of octets in this object should be
2812                     the same as the value of docsIetfQosPHSSize."
2813     REFERENCE       "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.1"
2814     ::= { docsIetfQosPHSEntry 1 }
2815
2816 docsIetfQosPHSMask          OBJECT-TYPE
2817     SYNTAX          OCTET STRING(SIZE(0..32))
2818     MAX-ACCESS      read-only
2819     STATUS          current
2820     DESCRIPTION    "Payload header suppression mask defines the
2821                     bit mask that is used in combination with the
2822                     docsIetfQosPHSField.  It defines which bytes in
2823                     the header must be suppressed/restored by the
2824                     sending or receiving device.
2825
2826                     Each bit of this bit mask corresponds to a byte
2827                     in the docsIetfQosPHSField, with the least
2828
2829
2830
2831                     significant bit corresponding to the first byte
2832                     of the docsIetfQosPHSField.
2833
2834                     Each bit of the bit mask specifies whether
2835                     the corresponding byte should be suppressed
2836                     in the packet.  A bit value of '1' indicates that
2837                     the byte should be suppressed by the sending
2838                     device and restored by the receiving device.
2839                     A bit value of '0' indicates that
2840                     the byte should not be suppressed by the sending
2841                     device or restored by the receiving device.
2842
2843                     If the bit mask does not contain a bit for each
2844                     byte in the docsIetfQosPHSField, then the bit mask
2845                     is extended with bit values of '1' to be the
2846                     necessary length."
2847     REFERENCE       "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.3"
2848     ::= { docsIetfQosPHSEntry 2 }
2849
2850 docsIetfQosPHSSize          OBJECT-TYPE
2851     SYNTAX          Integer32 (0..255)
2852     MAX-ACCESS      read-only
2853     STATUS          current
2854     DESCRIPTION    "Payload header suppression size specifies the
2855                     number of bytes in the header to be suppressed
2856                     and restored.
2857
2858                     The value of this object must match the number
2859                     of bytes in the docsIetfQosPHSField."
2860     REFERENCE       "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.4"
2861     ::= { docsIetfQosPHSEntry 3 }
2862
2863 docsIetfQosPHSVerify       OBJECT-TYPE
2864     SYNTAX          TruthValue
2865     MAX-ACCESS      read-only
2866     STATUS          current
2867     DESCRIPTION    "Payload header suppression verification value.  If
2868                     'true', the sender must verify docsIetfQosPHSField
2869                     is the same as what is contained in the packet
2870                     to be suppressed."
2871     REFERENCE       "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.5"
2872     ::= { docsIetfQosPHSEntry 4 }
2873
2874 docsIetfQosPHSIndex         OBJECT-TYPE
2875     SYNTAX          Integer32 (1..255)
2876     MAX-ACCESS      read-only
2877     STATUS          current
2878     DESCRIPTION    "Payload header suppression index uniquely
2879
2880
2881
2882                     references the PHS rule for a given service flow."
2883     REFERENCE       "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.2"
2884     ::= { docsIetfQosPHSEntry 5 }
2885
2886
2887 --
2888 -- docsIetfQosCmtsMacToSrvFlowTable (CMTS Only)
2889 --
2890 docsIetfQosCmtsMacToSrvFlowTable OBJECT-TYPE
2891     SYNTAX          SEQUENCE OF DocsIetfQosCmtsMacToSrvFlowEntry
2892     MAX-ACCESS      not-accessible
2893     STATUS          current
2894     DESCRIPTION    "This table provides for referencing the service
2895                     flows associated with a particular cable modem.
2896                     This allows indexing into other docsIetfQos
2897                     tables that are indexed by docsIetfQosServiceFlowId
2898                     and ifIndex."
2899     ::= { docsIetfQosMIBObjects 11 }
2900
2901 docsIetfQosCmtsMacToSrvFlowEntry OBJECT-TYPE
2902     SYNTAX          DocsIetfQosCmtsMacToSrvFlowEntry
2903     MAX-ACCESS      not-accessible
2904     STATUS          current
2905     DESCRIPTION    "An entry is created by CMTS for each service flow
2906                     connected to this CMTS."
2907     INDEX {
2908             docsIetfQosCmtsCmMac,
2909             docsIetfQosCmtsServiceFlowId
2910           }
2911     ::= { docsIetfQosCmtsMacToSrvFlowTable 1 }
2912
2913 DocsIetfQosCmtsMacToSrvFlowEntry ::= SEQUENCE {
2914     docsIetfQosCmtsCmMac                MacAddress,
2915     docsIetfQosCmtsServiceFlowId        Unsigned32,
2916     docsIetfQosCmtsIfIndex              InterfaceIndex
2917     }
2918
2919 docsIetfQosCmtsCmMac OBJECT-TYPE
2920     SYNTAX          MacAddress
2921     MAX-ACCESS      not-accessible
2922     STATUS          current
2923     DESCRIPTION    "The MAC address for the referenced CM."
2924     ::= { docsIetfQosCmtsMacToSrvFlowEntry 1 }
2925
2926 docsIetfQosCmtsServiceFlowId OBJECT-TYPE
2927     SYNTAX          Unsigned32 (1..4294967295)
2928     MAX-ACCESS      not-accessible
2929     STATUS          current
2930
2931
2932
2933     DESCRIPTION    "An index assigned to a service flow by CMTS."
2934     ::= { docsIetfQosCmtsMacToSrvFlowEntry 2 }
2935
2936 docsIetfQosCmtsIfIndex OBJECT-TYPE
2937     SYNTAX          InterfaceIndex
2938     MAX-ACCESS      read-only
2939     STATUS          current
2940     DESCRIPTION    "The ifIndex of ifType docsCableMacLayer(127)
2941                     on the CMTS that is connected to the Cable Modem."
2942     ::= { docsIetfQosCmtsMacToSrvFlowEntry 3 }
2943
2944 --
2945 -- Conformance definitions
2946 --
2947 docsIetfQosConformance  OBJECT IDENTIFIER
2948         ::= { docsIetfQosMIB 2 }
2949
2950 docsIetfQosGroups       OBJECT IDENTIFIER
2951         ::= { docsIetfQosConformance 1 }
2952
2953 docsIetfQosCompliances  OBJECT IDENTIFIER
2954         ::= { docsIetfQosConformance 2 }
2955
2956 docsIetfQosCompliance MODULE-COMPLIANCE
2957     STATUS  current
2958     DESCRIPTION
2959         "The compliance statement for MCNS Cable Modems and
2960          Cable Modem Termination Systems that implement DOCSIS
2961          Service Flows."
2962
2963     MODULE  -- docsIetfQosMIB
2964         MANDATORY-GROUPS { docsIetfQosBaseGroup }
2965
2966         GROUP docsIetfQosCmtsGroup
2967         DESCRIPTION
2968             "This group is mandatory for Cable Modem Termination
2969              Systems (CMTS) and is not implemented for Cable Modems
2970              (CM)."
2971
2972         GROUP docsIetfQosParamSetGroup
2973         DESCRIPTION
2974             "This group is mandatory for Cable Modem Termination
2975              Systems (CMTS) and Cable Modems.  Cable modems only
2976              implement objects in this group as read-only."
2977
2978         GROUP docsIetfQosSrvClassPolicyGroup
2979         DESCRIPTION
2980             "This group is optional for Cable Modem Termination
2981
2982
2983
2984              Systems (CMTS) and Cable Modems.  This group is relevant
2985              if policy-based service flow classification
2986              is implemented.  See docsDevPolicyTable in
2987              DOCS-CABLE-DEVICE-MIB for more details."
2988
2989         GROUP docsIetfQosServiceClassGroup
2990         DESCRIPTION
2991             "This group is mandatory for a Cable Modem Termination
2992              System (CMTS) that implements expansion of Service Class
2993              Names in a QOS Parameter Set.  This group is
2994              not implemented on the Cable Modems."
2995
2996         OBJECT  docsIetfQosPktClassPkts
2997         DESCRIPTION
2998             "This object only needs to be implemented in entries
2999              that are classifying packets and not policing packets."
3000
3001         OBJECT  docsIetfQosPktClassInetAddressType
3002         SYNTAX InetAddressType { ipv4(1) }
3003         DESCRIPTION
3004             "An implementation is only required to support IPv4
3005              address."
3006
3007         OBJECT  docsIetfQosPktClassInetSourceAddr
3008         SYNTAX InetAddress (SIZE(4))
3009         DESCRIPTION
3010             "An implementation is only required to support IPv4
3011              address."
3012
3013         OBJECT  docsIetfQosPktClassInetSourceMask
3014         SYNTAX InetAddress (SIZE(4))
3015         DESCRIPTION
3016             "An implementation is only required to support IPv4
3017              address."
3018
3019         OBJECT  docsIetfQosPktClassInetDestAddr
3020         SYNTAX InetAddress (SIZE(4))
3021         DESCRIPTION
3022             "An implementation is only required to support IPv4
3023              address."
3024
3025         OBJECT  docsIetfQosPktClassInetDestMask
3026         SYNTAX InetAddress (SIZE(4))
3027         DESCRIPTION
3028             "An implementation is only required to support IPv4
3029              address."
3030
3031         OBJECT  docsIetfQosServiceClassStorageType
3032
3033
3034
3035         SYNTAX StorageType { nonVolatile(3) }
3036         DESCRIPTION
3037             "An implementation is only required to support nonvolatile
3038              storage."
3039
3040         OBJECT  docsIetfQosServiceClassPolicyStorageType
3041         SYNTAX StorageType { nonVolatile(3) }
3042         DESCRIPTION
3043             "An implementation is only required to support nonvolatile
3044              storage."
3045
3046     ::= { docsIetfQosCompliances 1 }
3047
3048 docsIetfQosBaseGroup OBJECT-GROUP
3049     OBJECTS {
3050     docsIetfQosPktClassDirection,
3051     docsIetfQosPktClassPriority,
3052     docsIetfQosPktClassIpTosLow,
3053     docsIetfQosPktClassIpTosHigh,
3054     docsIetfQosPktClassIpTosMask,
3055     docsIetfQosPktClassIpProtocol,
3056     docsIetfQosPktClassSourcePortStart,
3057     docsIetfQosPktClassSourcePortEnd,
3058     docsIetfQosPktClassDestPortStart,
3059     docsIetfQosPktClassDestPortEnd,
3060     docsIetfQosPktClassDestMacAddr,
3061     docsIetfQosPktClassDestMacMask,
3062     docsIetfQosPktClassSourceMacAddr,
3063     docsIetfQosPktClassEnetProtocolType,
3064     docsIetfQosPktClassEnetProtocol,
3065     docsIetfQosPktClassUserPriLow,
3066     docsIetfQosPktClassUserPriHigh,
3067     docsIetfQosPktClassVlanId,
3068     docsIetfQosPktClassStateActive,
3069     docsIetfQosPktClassPkts,
3070     docsIetfQosPktClassBitMap,
3071     docsIetfQosPktClassInetAddressType,
3072     docsIetfQosPktClassInetSourceAddr,
3073     docsIetfQosPktClassInetSourceMask,
3074     docsIetfQosPktClassInetDestAddr,
3075     docsIetfQosPktClassInetDestMask,
3076
3077     docsIetfQosServiceFlowSID,
3078     docsIetfQosServiceFlowDirection,
3079     docsIetfQosServiceFlowPrimary,
3080
3081     docsIetfQosServiceFlowPkts,
3082     docsIetfQosServiceFlowOctets,
3083
3084
3085
3086     docsIetfQosServiceFlowTimeCreated,
3087     docsIetfQosServiceFlowTimeActive,
3088     docsIetfQosServiceFlowPHSUnknowns,
3089     docsIetfQosServiceFlowPolicedDropPkts,
3090     docsIetfQosServiceFlowPolicedDelayPkts,
3091
3092     docsIetfQosDSAReqs,
3093     docsIetfQosDSARsps,
3094     docsIetfQosDSAAcks,
3095     docsIetfQosDSCReqs,
3096     docsIetfQosDSCRsps,
3097     docsIetfQosDSCAcks,
3098     docsIetfQosDSDReqs,
3099     docsIetfQosDSDRsps,
3100     docsIetfQosDynamicAdds,
3101     docsIetfQosDynamicAddFails,
3102     docsIetfQosDynamicChanges,
3103     docsIetfQosDynamicChangeFails,
3104     docsIetfQosDynamicDeletes,
3105     docsIetfQosDynamicDeleteFails,
3106     docsIetfQosDCCReqs,
3107     docsIetfQosDCCRsps,
3108     docsIetfQosDCCAcks,
3109     docsIetfQosDCCs,
3110     docsIetfQosDCCFails,
3111
3112     docsIetfQosPHSField,
3113     docsIetfQosPHSMask,
3114     docsIetfQosPHSSize,
3115     docsIetfQosPHSVerify,
3116     docsIetfQosPHSIndex
3117     }
3118     STATUS  current
3119     DESCRIPTION
3120         "Group of objects implemented in both Cable Modems and
3121          Cable Modem Termination Systems."
3122     ::= { docsIetfQosGroups 1 }
3123
3124 docsIetfQosParamSetGroup OBJECT-GROUP
3125     OBJECTS {
3126     docsIetfQosParamSetServiceClassName,
3127     docsIetfQosParamSetPriority,
3128     docsIetfQosParamSetMaxTrafficRate,
3129     docsIetfQosParamSetMaxTrafficBurst,
3130     docsIetfQosParamSetMinReservedRate,
3131     docsIetfQosParamSetMinReservedPkt,
3132     docsIetfQosParamSetActiveTimeout,
3133     docsIetfQosParamSetAdmittedTimeout,
3134
3135
3136
3137     docsIetfQosParamSetMaxConcatBurst,
3138     docsIetfQosParamSetSchedulingType,
3139     docsIetfQosParamSetNomPollInterval,
3140     docsIetfQosParamSetTolPollJitter,
3141     docsIetfQosParamSetUnsolicitGrantSize,
3142     docsIetfQosParamSetNomGrantInterval,
3143     docsIetfQosParamSetTolGrantJitter,
3144     docsIetfQosParamSetGrantsPerInterval,
3145     docsIetfQosParamSetTosAndMask,
3146     docsIetfQosParamSetTosOrMask,
3147     docsIetfQosParamSetMaxLatency,
3148     docsIetfQosParamSetRequestPolicyOct,
3149     docsIetfQosParamSetBitMap
3150     }
3151     STATUS  current
3152     DESCRIPTION
3153         "Group of objects implemented in both Cable Modems and
3154          Cable Modem Termination Systems for QOS Parameter Sets."
3155     ::= { docsIetfQosGroups 2 }
3156
3157
3158 docsIetfQosCmtsGroup OBJECT-GROUP
3159     OBJECTS {
3160
3161     docsIetfQosUpstreamFragments,
3162     docsIetfQosUpstreamFragDiscards,
3163     docsIetfQosUpstreamConcatBursts,
3164
3165     docsIetfQosServiceFlowLogIfIndex,
3166     docsIetfQosServiceFlowLogSFID,
3167     docsIetfQosServiceFlowLogCmMac,
3168     docsIetfQosServiceFlowLogPkts,
3169     docsIetfQosServiceFlowLogOctets,
3170     docsIetfQosServiceFlowLogTimeDeleted,
3171     docsIetfQosServiceFlowLogTimeCreated,
3172     docsIetfQosServiceFlowLogTimeActive,
3173     docsIetfQosServiceFlowLogDirection,
3174     docsIetfQosServiceFlowLogPrimary,
3175     docsIetfQosServiceFlowLogServiceClassName,
3176     docsIetfQosServiceFlowLogPolicedDropPkts,
3177     docsIetfQosServiceFlowLogPolicedDelayPkts,
3178     docsIetfQosServiceFlowLogControl,
3179
3180     docsIetfQosCmtsIfIndex -- docsIetfQosCmtsMacToSrvFlowTable required
3181
3182     }
3183     STATUS  current
3184     DESCRIPTION
3185
3186
3187
3188         "Group of objects implemented only in the CMTS."
3189     ::= { docsIetfQosGroups 3 }
3190
3191 docsIetfQosSrvClassPolicyGroup OBJECT-GROUP
3192     OBJECTS {
3193     docsIetfQosServiceClassPolicyName,
3194     docsIetfQosServiceClassPolicyRulePriority,
3195     docsIetfQosServiceClassPolicyStatus,
3196     docsIetfQosServiceClassPolicyStorageType
3197     }
3198     STATUS  current
3199     DESCRIPTION
3200         "Group of objects implemented in both Cable Modems and
3201          Cable Modem Termination Systems when supporting policy-based
3202          service flows."
3203     ::= { docsIetfQosGroups 4 }
3204
3205 docsIetfQosServiceClassGroup OBJECT-GROUP
3206     OBJECTS {
3207     docsIetfQosServiceClassStatus,
3208     docsIetfQosServiceClassPriority,
3209     docsIetfQosServiceClassMaxTrafficRate,
3210     docsIetfQosServiceClassMaxTrafficBurst,
3211     docsIetfQosServiceClassMinReservedRate,
3212     docsIetfQosServiceClassMinReservedPkt,
3213     docsIetfQosServiceClassMaxConcatBurst,
3214     docsIetfQosServiceClassNomPollInterval,
3215     docsIetfQosServiceClassTolPollJitter,
3216     docsIetfQosServiceClassUnsolicitGrantSize,
3217     docsIetfQosServiceClassNomGrantInterval,
3218     docsIetfQosServiceClassTolGrantJitter,
3219     docsIetfQosServiceClassGrantsPerInterval,
3220     docsIetfQosServiceClassMaxLatency,
3221     docsIetfQosServiceClassActiveTimeout,
3222     docsIetfQosServiceClassAdmittedTimeout,
3223     docsIetfQosServiceClassSchedulingType,
3224     docsIetfQosServiceClassRequestPolicy,
3225     docsIetfQosServiceClassTosAndMask,
3226     docsIetfQosServiceClassTosOrMask,
3227     docsIetfQosServiceClassDirection,
3228     docsIetfQosServiceClassStorageType,
3229     docsIetfQosServiceClassDSCPOverwrite
3230     }
3231     STATUS  current
3232     DESCRIPTION
3233         "Group of objects implemented only in Cable Modem
3234          Termination Systems when supporting expansion of Service
3235          Class Names in a QOS Parameter Set"
3236
3237
3238
3239     ::= { docsIetfQosGroups 5 }
3240
3241 END