idnits 2.17.1 draft-ietf-ipcdn-qos-mib-12.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** It looks like you're using RFC 3978 boilerplate. You should update this to the boilerplate described in the IETF Trust License Policy document (see https://trustee.ietf.org/license-info), which is required now. -- Found old boilerplate from RFC 3667, Section 5.1 on line 18. -- Found old boilerplate from RFC 3978, Section 5.5 on line 4434. -- Found old boilerplate from RFC 3979, Section 5, paragraph 1 on line 4445. -- Found old boilerplate from RFC 3979, Section 5, paragraph 2 on line 4452. -- Found old boilerplate from RFC 3979, Section 5, paragraph 3 on line 4458. ** The document seems to lack an RFC 3978 Section 5.1 IPR Disclosure Acknowledgement -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack an RFC 3978 Section 5.4 (updated by RFC 4748) Copyright Line. ** The document seems to lack an RFC 3978 Section 5.4 Reference to BCP 78. ** This document has an original RFC 3978 Section 5.5 Disclaimer, instead of the newer disclaimer which includes the IETF Trust according to RFC 4748. ** The document uses RFC 3667 boilerplate or RFC 3978-like boilerplate instead of verbatim RFC 3978 boilerplate. After 6 May 2005, submission of drafts without verbatim RFC 3978 boilerplate is not accepted. The following non-3978 patterns matched text found in the document. That text should be removed or replaced: By submitting this Internet-Draft, I certify that any applicable patent or other IPR claims of which I am aware have been disclosed, or will be disclosed, and any of which I become aware will be disclosed, in accordance with RFC 3668. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard == The page length should not exceed 58 lines per page, but there was 88 longer pages, the longest (page 2) being 62 lines Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The document seems to use 'NOT RECOMMENDED' as an RFC 2119 keyword, but does not include the phrase in its RFC 2119 key words list. -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (February 2005) is 7004 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) -- Possible downref: Non-RFC (?) normative reference: ref. '4' ** Obsolete normative reference: RFC 2669 (ref. '6') (Obsoleted by RFC 4639) ** Obsolete normative reference: RFC 2670 (ref. '7') (Obsoleted by RFC 4546) ** Obsolete normative reference: RFC 3291 (ref. '8') (Obsoleted by RFC 4001) ** Downref: Normative reference to an Informational RFC: RFC 3260 (ref. '9') Summary: 10 errors (**), 0 flaws (~~), 3 warnings (==), 8 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 INTERNET-DRAFT 3 IPCDN Working Group Michael Patrick 4 William Murwin 5 Motorola BCS 7 Expires: August 2005 February 2005 9 Data Over Cable System Interface Specification 10 Quality of Service 11 Management Information Base (DOCSIS-QOS MIB) 13 Status of this Memo 15 By submitting this Internet-Draft, we certify that any applicable 16 patent or other IPR claims of which we are aware have been disclosed, 17 or will be disclosed, and any of which we become aware will be 18 disclosed, in accordance with RFC 3668. 20 Internet-Drafts are working documents of the Internet Engineering 21 Task Force (IETF), its areas, and its working groups. Note that 22 other groups may also distribute working documents as Internet- 23 Drafts. 25 Internet-Drafts are draft documents valid for a maximum of six months 26 and may be updated, replaced, or obsoleted by other documents at any 27 time. It is inappropriate to use Internet-Drafts as reference 28 material or to cite them other than as "work in progress." 30 The list of current Internet-Drafts can be accessed at 31 http://www.ietf.org/ietf/1id-abstracts.txt. The list of 32 Internet-Draft Shadow Directories can be accessed at 33 http://www.ietf.org/shadow.html. 35 Abstract 37 This document defines a basic set of managed objects for SNMP-based 38 management of extended QOS features of Cable Modems (CMs) and Cable 39 Modem Termination Systems (CMTSs) conforming to the Data over Cable 40 System (DOCSIS) specifications version 1.1 and 2.0. 42 IPCDN DOCSIS QoS MIB February 2005 44 Table of Contents 46 Status of this Memo............................... 1 47 Abstract.......................................... 1 49 1. Introduction...................................... 3 50 1.1 The Internet-Standard Management Framework... 3 51 1.2 Glossary..................................... 3 53 2. Overview.......................................... 5 54 2.1 Textual Conventions.......................... 5 55 2.2 MIB Organization............................ 5 56 2.2.1 docsIetfQosPktClassTable............. 9 57 2.2.2 docsIetfQosParamSetTable............. 9 58 2.2.2.1 Interoperation with DOCSIS 1.0....... 11 59 2.2.3 docsIetfQosServiceFlowTable.......... 12 60 2.2.4 docsIetfQosServiceFlowStatsTable..... 13 61 2.2.5 docsIetfQosUpstreamStatsTable........ 14 62 2.2.6 docsIetfQosDynamicServiceStatsTable.. 14 63 2.2.7 docsIetfQosServiceFlowLogTable....... 14 64 2.2.8 docsIetfQosServiceClassTable......... 15 65 2.2.9 docsIetfQosServiceClassPolicyTable... 15 66 2.2.10 docsIetfQosPHSTable.................. 15 67 2.2.11 docsIetfQosCmtsMacToSrvFlowTable..... 16 69 3. Externally Administered Classification............ 16 71 4. DOCSIS and IPv4 Type-of-Service(ToS) Field........ 19 73 5. Definitions....................................... 21 75 6. Security Considerations........................... 82 77 7. IANA Considerations............................... 84 79 8. Acknowledgement................................... 84 81 9. Normative References.............................. 84 83 10. Informative References............................ 86 85 11. Author's Address.................................. 87 87 12. Disclaimer of Validity............................ 88 89 13. Intellectual Property............................. 88 91 14. Copyright Statement............................... 88 93 IPCDN DOCSIS QoS MIB February 2005 95 1. Introduction 97 This memo is a product of the IP over Cable Data Network (IPCDN) 98 working group within the Internet Engineering Task Force (IETF). 100 1.1 The Internet-Standard Management Framework 102 For a detailed overview of the documents that describe the current 103 Internet-Standard Management Framework, please refer to section 7 of 104 RFC 3410 [15]. 106 Managed objects are accessed via a virtual information store, termed 107 the Management Information Base or MIB. MIB objects are generally 108 accessed through the Simple Network Management Protocol (SNMP). 109 Objects in the MIB are defined using the mechanisms defined in the 110 Structure of Management Information (SMI). This memo specifies a MIB 111 module that is compliant to the SMIv2, which is described in STD 58, 112 RFC 2578 [1], STD 58, RFC 2579 [2] and STD 58, RFC 2580 [3]. 114 1.2 Glossary 116 Active QPS Active QoS Parameter Set (QPS). The set of QoS 117 parameters that describe the current level service 118 provided to a Service Flow (SF). 120 Active SF Active Service Flow. An SF with a non-empty Active 121 QPS. 123 Admitted QPS Admitted QoS Parameter Set. The set of QoS parameters 124 that describe a level of service which the Service 125 Flow is not currently using, but which it is 126 guaranteed to receive upon the SF's request to make 127 the set Active. 129 Admitted SF A Service Flow with a non-empty Admitted QPS. 131 CATV Cable Television 133 CM Cable Modem, a modem connecting a subscriber's LAN to 134 the Cable Televison(CATV) Radio Frequency(RF) network. 135 DOCSIS CMs operate as a MAC layer bridge between the 136 home LAN and the Cable Television(CATV) Radio 137 Frequency(RF) network. 139 CMTS Cable Modem Termination System, the "head-end" device 140 providing connectivity between the RF network and the 141 Internet. 143 IPCDN DOCSIS QoS MIB February 2005 145 Downstream The direction from the head-end towards the 146 subscriber. 148 DSA Dynamic Service Addition, a DOCSIS MAC management 149 message requesting the dynamic creation of a new 150 Service Flow. New SFs are created with a three-message 151 exchange of a DSA-REQ, DSA-RSP, and DSA-ACK. 153 DSC Dynamic Service Change, a DOCSIS MAC management 154 message requesting a change to the attributes of a 155 Service Flow. SFs are changed with a three-message 156 exchange of a DSC-REQ, DSC-RSP, and DSC-ACK. 158 DSD Dynamic Service Delete, a DOCSIS MAC management 159 message requesting the deletion of a Service Flow. SFs 160 are deleted with a two-message exchange of a DSD-REQ 161 and DSD-ACK. 163 Head-end The origination point in most cable systems of the 164 subsriber video signals. It is generally also the 165 location of the CMTS. 167 PHS Payload Header Suppression, a feature of DOCSIS 1.1 168 and 2.0 in which header bytes that are common in a 169 sequence of packets of a Service Flow are replaced by 170 a one-byte PHSI Index (PHSI) when transmitting the 171 packet on the RF network. 173 primary SF Primary Service Flow. All CMs have a Primary Upstream 174 Service Flow and a Primary Downstream Service Flow. 175 They provide a default path for fowarded packets that 176 are not classified to any other Service Flow. 178 Provisioned QPS A QoS Parameter Set describing an envelope of service 179 within which a Service Flow is authorized to request 180 admission. All existing Service Flows must have a 181 non-empty Provisioned QPS, hence all SFs are 182 considered to be "Provisioned". 184 RF Radio Frequency. In particular, this abbreviation 185 refers to the radio frequencies for Cable Television 186 (CATV). 188 SCN Service Class Name -- a named set of QoS parameters. 189 A Service Flow may or may not be associated with a 190 single named Service Class. A Service Class has as an 191 attribute a QoS Parameter Set that is used as the 192 default set of values for all Service Flows belonging 193 to the Service Class. 195 IPCDN DOCSIS QoS MIB February 2005 197 SID Service ID. A 16-bit unsigned integer assigned by the 198 CMTS for an Upstream Service Flow with a non-empty 199 Active QoS Parameter Set. 201 SF Service Flow. A unidirectional stream of packets 202 between the CM and CMTS. SFs are characterized as 203 upstream or downstream. The SF is the fundamental 204 unit of service provided on a DOCSIS CATV network. 206 SFID Service Flow ID. A 32-bit unsigned integer assigned 207 by the CMTS to each Service Flows 209 Upstream The direction from a subscriber CM to the head-end 210 CMTS. 212 2. Overview 214 This MIB module provides a set of objects required for the management 215 of DOCSIS 1.1 and 2.0 compliant Cable Modems (CM) and Cable Modem 216 Termination Systems (CMTS). The specification is derived from the 217 DOCSIS 2.0 Radio Frequency Interface specification [4]. Please note 218 that the referenced DOCSIS specifications only requires Cable Modems 219 to process IPv4 customer traffic. Design choices in this MIB module 220 reflect those requirements. Future versions of the DOCSIS standard 221 are expected to require support for IPv6 as well. 223 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", 224 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this 225 document are to be interpreted as described in RFC 2119 [5]. 227 2.1 Textual Conventions 229 The textual convention "DocsIetfQosRfMacIfDirection" is defined to 230 indicate the direction of a packet classifier relative to an 231 interface. It takes the values of either downstream(1) or 232 upstream(2). 234 The textual convention "DocsIetfQosBitRate" corresponds to the bits 235 per second as defined for QoS Parameter Sets in DOCSIS 1.1 and 2.0. 236 This definition includes all bits of the Ethernet MAC frame as 237 transmitted on the RF network, starting with the Destination Address 238 and ending with the Ethernet Frame Check Sequence (FCS). It does NOT 239 includes bits in the DOCSIS MAC header. 241 IPCDN DOCSIS QoS MIB February 2005 243 2.2 MIB Organization 245 The structure of the IPCDN QoS MIB module (DOCS-IETF-QOS-MIB) is 246 summarized below: 248 docsIetfQosMIB 249 docsIetfQosMIBObjects 250 docsIetfQosPktClassTable 251 docsIetfQosPktClassEntry 252 docsIetfQosPktClassId 253 docsIetfQosPktClassDirection 254 docsIetfQosPktClassPriority 255 docsIetfQosPktClassIpTosLow 256 docsIetfQosPktClassIpTosHigh 257 docsIetfQosPktClassIpTosMask 258 docsIetfQosPktClassIpProtocol 259 docsIetfQosPktClassInetAddressType 260 docsIetfQosPktClassInetSourceAddr 261 docsIetfQosPktClassInetSourceMask 262 docsIetfQosPktClassInetDestAddr 263 docsIetfQosPktClassInetDestMask 264 docsIetfQosPktClassSourcePortStart 265 docsIetfQosPktClassSourcePortEnd 266 docsIetfQosPktClassDestPortStart 267 docsIetfQosPktClassDestPortEnd 268 docsIetfQosPktClassDestMacAddr 269 docsIetfQosPktClassDestMacMask 270 docsIetfQosPktClassSourceMacAddr 271 docsIetfQosPktClassEnetProtocolType 272 docsIetfQosPktClassEnetProtocol 273 docsIetfQosPktClassUserPriLow 274 docsIetfQosPktClassUserPriHigh 275 docsIetfQosPktClassVlanId 276 docsIetfQosPktClassStateActive 277 docsIetfQosPktClassPkts 278 docsIetfQosPktClassBitMap 279 docsIetfQosParamSetTable 280 docsIetfQosParamSetEntry 281 docsIetfQosParamSetServiceClassName 282 docsIetfQosParamSetPriority 283 docsIetfQosParamSetMaxTrafficRate 284 docsIetfQosParamSetMaxTrafficBurst 285 docsIetfQosParamSetMinReservedRate 286 docsIetfQosParamSetMinReservedPkt 287 docsIetfQosParamSetActiveTimeout 288 docsIetfQosParamSetAdmittedTimeout 289 docsIetfQosParamSetMaxConcatBurst 290 docsIetfQosParamSetSchedulingType 291 docsIetfQosParamSetNomPollInterval 293 IPCDN DOCSIS QoS MIB February 2005 295 docsIetfQosParamSetTolPollJitter 296 docsIetfQosParamSetUnsolicitGrantSize 297 docsIetfQosParamSetNomGrantInterval 298 docsIetfQosParamSetTolGrantJitter 299 docsIetfQosParamSetGrantsPerInterval 300 docsIetfQosParamSetTosAndMask 301 docsIetfQosParamSetTosOrMask 302 docsIetfQosParamSetMaxLatency 303 docsIetfQosParamSetType 304 docsIetfQosParamSetRequestPolicyOct 305 docsIetfQosParamSetBitMap 306 docsIetfQosServiceFlowTable 307 docsIetfQosServiceFlowEntry 308 docsIetfQosServiceFlowId 309 docsIetfQosServiceFlowSID 310 docsIetfQosServiceFlowDirection 311 docsIetfQosServiceFlowPrimary 312 docsIetfQosServiceFlowStatsTable 313 docsIetfQosServiceFlowStatsEntry 314 docsIetfQosServiceFlowPkts 315 docsIetfQosServiceFlowOctets 316 docsIetfQosServiceFlowTimeCreated 317 docsIetfQosServiceFlowTimeActive 318 docsIetfQosServiceFlowPHSUnknowns 319 docsIetfQosServiceFlowPolicedDropPkts 320 docsIetfQosServiceFlowPolicedDelayPkts 321 docsIetfQosUpstreamStatsTable 322 docsIetfQosUpstreamStatsEntry 323 docsIetfQosSID 324 docsIetfQosUpstreamFragments 325 docsIetfQosUpstreamFragDiscards 326 docsIetfQosUpstreamConcatBursts 327 docsIetfQosDynamicServiceStatsTable 328 docsIetfQosDynamicServiceStatsEntry 329 docsIetfQosIfDirection 330 docsIetfQosDSAReqs 331 docsIetfQosDSARsps 332 docsIetfQosDSAAcks 333 docsIetfQosDSCReqs 334 docsIetfQosDSCRsps 335 docsIetfQosDSCAcks 336 docsIetfQosDSDReqs 337 docsIetfQosDSDRsps 338 docsIetfQosDynamicAdds 339 docsIetfQosDynamicAddFails 340 docsIetfQosDynamicChanges 341 docsIetfQosDynamicChangeFails 342 docsIetfQosDynamicDeletes 343 docsIetfQosDynamicDeleteFails 344 docsIetfQosDCCReqs 345 docsIetfQosDCCRsps 347 IPCDN DOCSIS QoS MIB February 2005 349 docsIetfQosDCCAcks 350 docsIetfQosDCCs 351 docsIetfQosDCCFails 352 docsIetfQosServiceFlowLogTable 353 docsIetfQosServiceFlowLogEntry 354 docsIetfQosServiceFlowLogIndex 355 docsIetfQosServiceFlowLogIfIndex 356 docsIetfQosServiceFlowLogSFID 357 docsIetfQosServiceFlowLogCmMac 358 docsIetfQosServiceFlowLogPkts 359 docsIetfQosServiceFlowLogOctets 360 docsIetfQosServiceFlowLogTimeDeleted 361 docsIetfQosServiceFlowLogTimeCreated 362 docsIetfQosServiceFlowLogTimeActive 363 docsIetfQosServiceFlowLogDirection 364 docsIetfQosServiceFlowLogPrimary 365 docsIetfQosServiceFlowLogServiceClassName 366 docsIetfQosServiceFlowLogPolicedDropPkts 367 docsIetfQosServiceFlowLogPolicedDelayPkts 368 docsIetfQosServiceFlowLogControl 369 docsIetfQosServiceClassTable 370 docsIetfQosServiceClassEntry 371 docsIetfQosServiceClassName 372 docsIetfQosServiceClassStatus 373 docsIetfQosServiceClassMaxTrafficRate 374 docsIetfQosServiceClassMaxTrafficBurst 375 docsIetfQosServiceClassMinReservedRate 376 docsIetfQosServiceClassMinReservedPkt 377 docsIetfQosServiceClassMaxConcatBurst 378 docsIetfQosServiceClassNomPollInterval 379 docsIetfQosServiceClassTolPollJitter 380 docsIetfQosServiceClassUnsolicitGrantSize 381 docsIetfQosServiceClassNomGrantInterval 382 docsIetfQosServiceClassTolGrantJitter 383 docsIetfQosServiceClassGrantsPerInterval 384 docsIetfQosServiceClassMaxLatency 385 docsIetfQosServiceClassActiveTimeout 386 docsIetfQosServiceClassAdmittedTimeout 387 docsIetfQosServiceClassSchedulingType 388 docsIetfQosServiceClassRequestPolicy 389 docsIetfQosServiceClassTosAndMask 390 docsIetfQosServiceClassTosOrMask 391 docsIetfQosServiceClassDirection 392 docsIetfQosServiceClassStorageType 393 docsIetfQosServiceClassDSCPOverwrite 394 docsIetfQosServiceClassPolicyTable 395 docsIetfQosServiceClassPolicyEntry 396 docsIetfQosServiceClassPolicyIndex 397 docsIetfQosServiceClassPolicyName 398 docsIetfQosServiceClassPolicyRulePriority 399 docsIetfQosServiceClassPolicyStatus 401 IPCDN DOCSIS QoS MIB February 2005 403 docsIetfQosServiceClassPolicyStorageType 404 docsIetfQosPHSTable 405 docsIetfQosPHSEntry 406 docsIetfQosPHSField 407 docsIetfQosPHSMask 408 docsIetfQosPHSSize 409 docsIetfQosPHSVerify 410 docsIetfQosPHSIndex 411 docsIetfQosCmtsMacToSrvFlowTable 412 docsIetfQosCmtsMacToSrvFlowEntry 413 docsIetfQosCmtsCmMac 414 docsIetfQosCmtsServiceFlowId 415 docsIetfQosCmtsIfIndex 417 This MIB module is organized as 11 tables. Most tables are 418 implemented in both the CM and CMTS; the 419 docsIetfQosUpstreamStatsTable and docsIetfQosServiceFlowLogTable are 420 implemented on the CMTS only. 422 2.2.1 docsIetfQosPktClassTable 424 The docsIetfQosPktClassTable reports the Service Flow Classifiers 425 implemented by the managed device. The table is indexed by the tuple 426 { ifIndex, docsIetfQosServiceFlowId, docsIetfQosPktClassId }. The 427 ifIndex corresponds to a CATV MAC interface. Each CATV MAC interface 428 has a set of Service Flows, identified with a 429 docsIetfQosServiceFlowId value that is unique for that interface. 430 Each Service Flow may have a number of packet classifiers that map 431 packets to the flow. The ClassifierId for the classifier is unique 432 only within a particular Service Flow. 434 The semantics of packet classification are provided in [4]. Briefly, 435 the DOCSIS MAC interface calls for matching packets based on values 436 within the 802.2 (LLC), 802.3, IP, and/or UDP/TCP headers. Packets 437 which map more than one classifier are prioritized according to their 438 docsIetfQosPktClassPriority value. The docsIetfQosServiceFlowId (an 439 index object) indicates to which Service Flow the packet is 440 classified. 442 The docsIetfQosPktClassTable is distinct from the 443 docsDevIpFilterTable of [6] in that docsIetfQosPktClassTable is 444 intended only to reflect the state of the Service Flow Classifiers. 445 Service Flow Classifiers may be created only via a CM configuration 446 file or from the Dynamic Service Addition (DSA) messages. For this 447 reason, docsIetfQosPktClassTable is read-only. 449 The docsDevIpFilterTable is intended for external policy-based 450 administration of packet classifiers. See the section "Externally 452 IPCDN DOCSIS QoS MIB February 2005 454 Administered Classification", below. 456 2.2.2 docsIetfQosParamSetTable 458 The docsIetfQosParamSetTable reports the values of Qos Parameter Set 459 as defined in Section C.2.2 of [4]. 461 In general, a Service Flow is associated with three different QoS 462 Parameter Sets (QPSs): an "active" QPS, an "admitted" QPS, and a 463 "provisioned" or "authorized" QPS. The relationship of these three 464 sets is represented below: 466 +---------------------+ 467 | Provisioned | 468 | | 469 | +---------------+ | 470 | | Admitted | | 471 | | | | 472 | | +---------+ | | 473 | | | Active | | | 474 | | | | | | 475 | | +---------+ | | 476 | | | | 477 | +---------------+ | 478 | | 479 +---------------------+ 481 Figure 1: QoS Parameter Sets 483 The Provisioned QPS describes the maximum service envelope for which 484 the SF is authorized. The Admitted QPS is the set of services for 485 which a Service Flow has requested admission to the DOCSIS RF 486 network, but which is not yet active. The Admitted QPS is used during 487 the two-phase process of IP Telephony/PacketCable Service Flow 488 admission to admit the bandwidth for a bidirectional voice call when 489 the far end is ringing. Since ringing may occur for up to four 490 minutes, this permits the bandwidth to be reserved but not actually 491 consumed during this interval. The Active QPS is the set of services 492 actually being used by the Service Flow. The DOCSIS v1.1 493 specification [4] defines what it means for a QPS envelope to be 494 "within" another. In general, an inner QPS is considered to be 495 "within" an outer QPS when all QoS parameters represent demands of 496 equal or fewer resources of the network. 498 IPCDN DOCSIS QoS MIB February 2005 500 In addition to their use as attributes of a Service Flow, a QPS is 501 also an attribute of a Service Class. A DOCSIS CM configuration file 502 or DSA message may request the creation of a new SF and give only the 503 Service Class Name. The CMTS "expands the macro" of a Service Class 504 Name creation by populating the Provisioned, Admitted, and/or Active 505 QPSs of the Service Flow with the QPS of the Service Class Name. All 506 of the QPSs of a Service Flow must be expansions of the same Service 507 Class, and in this case the SF is said to "belong" to the Service 508 Class. Changing the contents of a Service Class' QPS does not affect 509 the QPS of any Service Flow earlier expanded from that Service Class 510 name. Only the CMTS implements docsIetfQosServiceClassTable. 512 See [4] section 8 for a full description and the theory of operation 513 of DOCSIS 1.1 QoS operation. 515 The docsIetfQosParamSetTable sets are indexed by { ifIndex, 516 docsIetfQosServiceFlowId, docsIetfQosParamSetType}. ifIndex indicates 517 a particular "DOCSIS MAC Domain". docsIetfQosServiceFlowId uniquely 518 identifies a Service Flow on that MAC domain. The 519 docsIetfQosParamSetType indicates whether the row describes an 520 active, admitted, or provisioned QoS Parameter Set. 522 The docsIetfQosParamSetTable is read-only, because it indicates the 523 QoS Parameter Set contents as defined by DOCSIS signaling. The 524 docsIetfQosServiceClassTable is read-create to permit managers to 525 define a template of Qos Parameters that can be referenced by DOCSIS 526 modems when creating their QoS Parameter Sets. 528 2.2.2.1 Interoperation with DOCSIS 1.0 530 The DOCS-IF-MIB [7] specifies a docsIfQosProfileTable to describe the 531 set of Class Of Service (COS) parameters associated with a COS 532 "profile". The docsIfCmServiceTable, which contains one entry per 533 SID, references this table with a docsIfCmServiceQosProfile number. 535 The DOCSIS 1.1 and 2.0 CM registration process allows a modem to 536 register as operating either with DOCSIS 1.0, DOCSIS 1.1, or DOCSIS 537 2.0 functionality. For ease of expression, we call a modem 538 registering with DOCSIS 1.0 functionality a "DOCSIS 1.0 modem", 539 regardless of the modem's capabilities. 541 A CMTS or CM supporting DOCSIS 1.0, as well as DOCSIS 1.1 and/or 542 DOCSIS 2.0 implements both the tables of [7] and the tables of this 543 MIB module. The interoperation goal is that before modem 544 registration, the DOCSIS 1.0 MIB [7] applies. After registration, 545 either the DOCSIS 1.0 or DOCSIS 1.1/2.0 MIB applies, depending on the 546 mode with which the modem registered. The specific interoperation 547 rules are: 549 IPCDN DOCSIS QoS MIB February 2005 551 1. When a CM initially ranges, the CM implements a row in the 552 DOCS-IF-MIB docsIfCmServiceTable and the CMTS implements a row 553 in the DOCS-IF-MIB docsIfCmtsServiceTable corresponding to the 554 default upstream Service ID (SID) used for pre-registration 555 upstream traffic. For historical compatibility a row may be 556 created for the docsIfQosProfileTable with default values, 557 which may be referenced by the docsIfCmServiceTable entries. 559 2. Both a CMTS and CM implementing this MIB MUST NOT implement 560 docsIetfQosParamSetTable or docsIetfQosServiceFlowTable rows 561 until after the CM registers with DOCSIS 1.1 or 2.0 modem 562 operation. 564 3. When a modem registers with the CMTS as a "DOCSIS 1.1" or 565 "DOCSIS 2.0" modem, any exclusively-referenced row in DOCS-IF- 566 MIB docsIfQosProfileTable representing the modems upstream QoS 567 profile for pre-registration traffic MUST be removed. 568 Multiply-referenced rows may remain. The 569 docsIfCmServiceQosProfile object in the CM's row of 570 docsIfCmServiceTable MUST be set to zero. The 571 docsIfCmServiceTable row for the DOCSIS 1.1 or DOCSIS 2.0 modem 572 continues to exist, and the various statistic objects in that 573 row are incremented. The CMTS should retain a 574 docsIfCmtsServiceTable entry for the DOCSIS 1.1 or DOCSIS 2.0 575 CM. 577 4. When a DOCSIS 1.1 or DOCSIS 2.0 modem registers, both the CMTS 578 and CM represent all Service Flows described in the modem 579 configuration file in docsIetfQosParamSetTable and 580 docsIetfQosServiceFlowTable. 582 5. DOCSIS 1.0 modems do not have entries in the DOCS-IETF-QOS-MIB. 584 2.2.3 docsIetfQosServiceFlowTable 586 The docsIetfQosServiceFlowTable provides read-only information about 587 all of the Service Flows known by the device. It is indexed by the 588 combination of { ifIndex, dosQosServiceFlowId }, where ifIndex 589 corresponds to a CATV MAC interface and docsIetfQosServiceFlowId is 590 the 32- bit integer assigned by the CMTS controlling the MAC domain. 591 A CM typically has only a single CATV MAC interface, while a CMTS may 592 have several. See [7] for a description of the ifIndex numbering for 593 DOCSIS devices. 595 The table indicates whether a given SF is in the upstream or 597 IPCDN DOCSIS QoS MIB February 2005 599 downstream direction, and whether it is the "primary" SF in that 600 direction. The primary SF carries traffic that is not otherwise 601 classified to any other SF in that direction. 603 2.2.4 docsIetfQosServiceFlowStatsTable 605 The docsIetfQosServiceFlowStatsTable provides statistics for all 606 currently existing SFs known by the managed device. It provides 607 basic packet and octet counters, as well as certain other SF-specific 608 stats such as the time at which the flow was created and how many 609 seconds it has been active. 611 The table also provides objects which can be used to fine-tune 612 admission control decisions, namely the number of packets dropped or 613 delayed due to QoS policing decisions enforced by the managed device. 615 The model of the Service Flows stats table is that there exists a 616 Service Flow Classification function followed by a Service Flow 617 maximum rate Policing function for packets transmitted onto the 618 DOCSIS RF network, as depicted below 620 +----------+ 621 +------------+ clsfy 1 -----+ | Per-SF | forwarded 622 Pkts | |-----------> | | Maximum |-> for DOCSIS 623 ----->| Classify | clsfy 2 SF1 |--> | Rate | RF Network 624 | Function |-----------> | | Policing | transmission 625 | | -----+ | Function | 626 | | | |----+ 627 | | | | | 628 | | +----------+ Dropped 629 +------------+ | ^ 630 +----+ Delayed 632 Packets intended for transmission onto the DOCSIS RF network 633 (upstream or downstream) are first classified to a Service Flow by 634 matching one of several possible classifiers associated with that 635 Service Flow. The docsIetfQosPktClassPkts count includes the number 636 of packets that match the classifier, regardless of the eventual 637 disposition of the packet. 639 DOCSIS requires that each Service Flow be policed to maintain a 640 maximum rate of transmission. This is performed by either dropping or 641 delaying a packet on that Service Flow. The 642 docsIetfQosServiceFlowPolicedDropPkts object counts the number of 643 Service Flow packets dropped by the policing function. The 644 docsIetfQosServiceFlowPolicedDelayPkts counts the number of packets 645 delayed but still forwarded. The docsIetfQosServiceFlowPkts object 646 counts the total number of packets forwarded beyond the policing 647 function intended for eventual transmission onto the DOCSIS RF 649 IPCDN DOCSIS QoS MIB February 2005 651 network. Although packets may be latter dropped by other functions 652 (e.g. a transmit queue overflow on a DOCSIS hardware transmitter), 653 the docsIetfQos MIB per service-flow counters are not affected in 654 this case. 656 2.2.5 docsIetfQosUpstreamStatsTable 658 This table provides statistics that are measured only at the CMTS in 659 the upstream direction. These include a count of the number of 660 fragmentation headers received, fragments discarded, and the number 661 of concatenation headers received. 663 2.2.6 docsIetfQosDynamicServiceStatsTable 665 This table provides read-only stats on the operation of the Dynamic 666 Service state machines as specified in section 9.4 of [4]. It 667 provides a set of 14 counters *in each direction* for a DOCSIS MAC 668 layer interface. That is, each DOCSIS MAC layer interface has one row 669 for downstream stats, and a second row for upstream stats. 671 Eight of the counters are DSx packet type counts, one counter for 672 each of the eight DSx packet types. For example, the 673 docsIetfQosDSAReqs object in the upstream row at the CMTS counts the 674 number of DSA-REQ messages received by the CMTS from that interface. 675 The docsIetfQosDSAReqs object in the downstream row at the CMTS 676 counts the number of DSA-REQ messages transmitted by the CMTS on that 677 interface. 679 The remaining six counters per (interface, direction) combination 680 count the number of successful and unsuccessful *transactions* that 681 were initiated on the interface and direction. For example, the 682 upstream docsIetfQosDynamicAdds on a CMTS is the number of 683 successfully completed CM-initiated dynamic additions, because at the 684 CMTS a CM-initiated DSA starts in the upstream direction. The 685 downstream docsIetfQosDynamicAdds at a CMTS is the number of 686 successful CMTS-initiated DSA transactions. 688 Dynamic service transactions can fail for a number of reasons, as 689 listed in the state machines of section 9.4. Rather than include 690 still more counters for each different failure reason, they are 691 grouped into a single count, e.g docsIetfQosDynamicAddFails. Again, 692 this object exists in both directions, so that locally originated vs 693 remotely originated transaction failures are counted separately. 694 Further troubleshooting of transaction failures will require 695 vendor-specific queries and operation. 697 IPCDN DOCSIS QoS MIB February 2005 699 2.2.7 docsIetfQosServiceFlowLogTable 701 This table contains a log of the Service Flows no longer existing in 702 the docsIetfQosServiceFlowTable. It is intended to be periodically 703 polled by traffic monitoring and billing agents. It is implemented 704 only at the CMTS. 706 It contains a chronological log of SF session statistics, including a 707 total count of packets and octets transferred on the SF. It includes 708 time stamps of the SF creation and deletion time, as well as its 709 number of active seconds. The active second count is the count of 710 seconds that the SF had a non-empty Active QoS Parameter Set, i.e. it 711 was eligible to pass data. For unicast SFs, it includes the CM MAC 712 address associated with the flow for billing reference purposes. 714 The maximum number of log records kept by a CMTS, and the duration 715 that a log record is maintained in the table is vendor-specific. An 716 explicit control object is provided so that the monitoring 717 application can explicitly delete records it has read. 719 2.2.8 docsIetfQosServiceClassTable 721 This table defines the Service Class Name and references a QoS 722 Parameter Set for each Service Class defined in a CMTS. It is 723 indexed by the Service Class Name string itself. The table is 724 read-create on a CMTS, and is not implemented in a CM. Each entry of 725 the docsIetfQosServiceClassTable should define a template for flows 726 in a given direction (upstream or downstream). Some parameters of the 727 docsIetfQosServiceClassTable are specific to a particular direction, 728 and so their values are not-applicable when used as a template for 729 flows in the other direction. 731 2.2.9 docsIetfQosServiceClassPolicyTable 733 The docsIetfQosServiceClassPolicyTable can be referenced by the 734 docsDevFilterPolicyTable of [6] in order to have a "policy" that 735 classifies packets to a named Service Class. This is one mechanism by 736 which "external" entities (like an SNMP manager) may control the 737 classification of packet for QoS purposes. Entries are indexed by a 738 small integer docsIetfQosServiceClassPolicyIndex. They provide a 739 Service Class Name and a Rule Priority. A policy referencing a row 740 of this table intends the packet to be forwarded on a Service Flow 741 "belonging" to the named Service Class. See the section "Externally 742 Administered Classification", below. 744 This table is implemented on both the CM and CMTS, and is read-create 745 on both. 747 IPCDN DOCSIS QoS MIB February 2005 749 2.2.10 docsIetfQosPHSTable 751 The Payload Header Suppression (PHS) feature of DOCSIS 1.1 and 2.0 752 permits packets to replace the unchanging bytes of the Ethernet, IP, 753 and UDP headers with a one-byte index when transmitting on the cable 754 network. This is especially useful for IP Telephony packets, where 755 such suppression can result in almost twice the number of calls 756 supported within the same upstream channel. 758 Each entry of the table corresponds to a PHS Rule as described in 759 section 8.4 of [4]. The rules are identified by their corresponding 760 Service Flow ID and docsIetfQosPktClassId. A PHS rule is associated 761 with exactly one classifier. The table is therefore indexed by the 762 tuple { ifIndex, docsIetfQosServiceFlowId, docsIetfQosPktClassId}. 764 This table is read-only, and MUST be implemented on both the CM and 765 CMTS when PHS is supported. 767 2.2.11 docsIetfQosCmtsMacToSrvFlowTable 769 The docsIetfQosCmtsMacToSrvFlowTable describes the mapping of CM MAC 770 addresses to the Service Flow Ids that are uniquely identified with 771 that CM. External applications may collect statistics on all packets 772 flowing through a CM by determining the SFID of all of its flows, and 773 then collecting the statistics of packets and bytes for each flow. 775 Downstream multicast Service Flows are not indicated in the 776 docsIetfQosCmtsMacToSrvFlowTable because they are not associated with 777 only one CM. 779 3. Externally Administered Classification 781 DOCSIS 1.1 and 2.0 provide rich semantics for the classification of 782 packets to Service Flows with its Service Flow Classifier table. 783 Service Flow Classifiers may be created statically in the DOCSIS CM 784 configuration file, or may be created dynamically with Dynamic 785 Service Addition (DSA) and Dynamic Service Change (DSC) DOCSIS MAC 786 messages. 788 Several major issues arose with the concept of externally 789 administered classification, i.e. should an external SNMP manager be 790 permitted to create classification rows? One problem was the 791 coordination of classifier IDs, since such an approach would require 792 either separate classifier ID number spaces or objects to coordinate 793 both internal and external classifier ID assignments. A more serious 794 problem, however, was the requirement that external creation of SF 795 Classifiers would require "knowledge" of the individual Service Flow 797 IPCDN DOCSIS QoS MIB February 2005 799 ID for Service Flows by external applications. It was strongly felt 800 by the committee that SFIDs should remain an internal DOCSIS object, 801 and not be transmitted as part of protocol flows, e.g. for IP packet 802 telephony signaling. DOCSIS 1.1 introduced the concept of named 803 Service Classes for ease of administration within a domain of CMs and 804 CMTSs. What was desired was to permit external classification of 805 packets to a Service Class, not a particular Service Flow. 807 The DOCSIS committee therefore decided to use the already-defined IP 808 Packet Filter Table [6] for the external classification of packets 809 for QoS purposes. The docsDevIpPacketFilterTable defines similar 810 packet matching criteria as docsIetfQosPktClassTable, but it matches 811 a packet to an arbitrary "policy set" instead of a particular Service 812 Flow. One of the policies in the policy set then selects the Service 813 Class of the SF on which to forward the packet. The 814 docsIetfQosServiceClassPolicyTable of this MIB module defines the 815 Service Class Name to which a packet is classified. 817 The interaction of external and internal packet classification is 818 depicted below. 820 IPCDN DOCSIS QoS MIB February 2005 822 | 823 | Outbound Pkt 824 V 825 docsDevIpFilterTable------> docsDevFilterPolicyTable 826 | | 827 | V 828 | docsIetfQosServiceClassPolicyTable 829 | | 830 Pkt | ServiceClassName,| 831 | ServiceClassPolicyRulePriority| 832 V V 833 +--------------------------------------------------------+ 834 | | DOCSIS MAC LAYER ENTITY | | 835 | | | Select | 836 | V | any | 837 | docsIetfQosPktClassTable <--------------| SFID Y | 838 | | | in SCN | 839 | | docsIetfQosPktClassPriority, | | 840 | | SFID X | | 841 | V V | 842 | +--------------------------------------------+ | 843 | | Select the SFID associated with the | | 844 | | higher of docsIetfQosPktClassPriority or | | 845 | | docsIetfQosServiceClassPolicyRulePriority | | 846 | +--------------------------------------------+ | 847 | | | 848 | V | 849 | | | | | | 850 | | | ... | | Service Flows | 851 | +----+ +----+ | 852 | SFID X SFID Y | 853 +--------------------------------------------------------+ 855 Figure 2: DOCSIS Packet Classification 857 The processing of an outgoing packet proceeds as follows: 859 1. The packet is first checked for matches with rows of the 860 docsDevIpFilterTable. If it matches, the matching row 861 provides a docsDevFilterPolicyId integer. 863 2. The docsDevFilterPolicyId indexes into one (or more) rows 864 of docsDevFilterPolicyTable. Each row provides an 865 arbitrary RowPointer (docsDevFilterPolicyPtr), 866 corresponding to a policy to be applied to the packet. 868 3. This MIB module defines a 869 docsIetfQosServiceClassPolicyTable whose entries may be 871 IPCDN DOCSIS QoS MIB February 2005 873 pointed to by docsDevFilterPolicyPtr in order to 874 administratively classify packets to a named DOCSIS 875 Service Class. The docsIetfQosServiceClassPolicyEntry 876 provides a Service Class Name (SCN) as 877 docsIetfQosServiceClassPolicyName and a classification 878 rule priority as 879 docsIetfQosServiceClassPolicyRulePriority. These are 880 submitted to the device's DOCSIS MAC Layer entity as a 881 special form of the MAC_DATA.request primitive, as 882 described in Section E.2.1 of [4]. 884 4. The MAC Layer selects an SFID ("Y") of an active Service 885 Flow belonging to the named class, choosing an SF 886 arbitrarily if there is more than one. 888 5. The packet is then classified according to the 889 docsIetfQosPktClassTable, which may classify the packet to 890 a different SFID "X". Associated with the classifier is a 891 docsIetfQosPktClassPriority. 893 6. In the event of a conflict between the SCN-determined SFID 894 and the classified SFID, the greater of 895 docsIetfQosPktClassPriority and 896 docsIetfQosServiceClassPolicyRulePriority determines which 897 SFID is selected to forward the packet. 899 A packet which does not match a 900 docsIetfQosServiceClassPolicyEntry is directly submitted to the 901 DOCSIS MAC layer, where the docsIetfQosPktClassTable selects the 902 SID on which it is to be forwarded. 904 By convention (in [4]), the "internal" 905 docsIetfQosPktClassPriority values should be in the range of 906 64-191, while the "external" priorities may be either in the 907 range 192-255 to override the internal classification or the 908 range 0-63 to be overridden by internal classification. 910 This classification mechanism applies both upstream from the CM 911 and downstream from the CMTS. 913 4. DOCSIS and IPv4 Type-of-Service(ToS) Field 915 The DOCSIS-IETF-QOS-MIB MIB module relies on the DOCSIS MAC layer 916 protocols and uses objects that reflect the IPv4 Type-of-Service 917 (ToS) octet as defined in [14]. The applicability of these objects is 918 limited to the DOCSIS access network. The past and current versions 919 of the DOCSIS specifications for which this MIB module is defined do 920 not reflect Differentiated Services [9] on the DOCSIS access network. 921 However, with proper selection of values for these objects, the 923 IPCDN DOCSIS QoS MIB February 2005 925 network operator can enforce Differentiated Services Per-hop 926 Behaviors (PHBs) on the DOCSIS Access Network, and can configure the 927 modification of the DSCP for certain packet flows as they enter the 928 metro network from the access network, essentially making the DOCSIS 929 access network TOS marking compatible with the wider use of DSCP 930 outside DOCSIS networks. It should be noted that because the entire 931 IPv4 TOS octet may be available for modification via the latter 932 mechanism (due to the current MAC level DOCSIS protocols and CLI 933 interface configuration), there is the possibility that the DOCSIS 934 network could be configured to modify the Explicit Congestion 935 Notification (ECN) bits [10] of certain packets. This modification of 936 the ECN bits is prevented by the MIB module's design. The MIB module 937 prohibits the modification of the TOS octet (read-only objects: 938 docsIetfQosPktClassIpTosLow, docsIetfQosPktClassIpTosHigh 939 docsIetfQosPktClassIpTosMask, docsIetfQosParamSetTosAndMask, 940 docsIetfQosParamSetTosOrMask) and allows the DSCP field to be 941 modified (read-create object: docsIetfQosServiceClassDSCPOverwrite). 943 IPCDN DOCSIS QoS MIB February 2005 945 5. Definitions 947 This MIB module refers to the SNMPv2-SMI [1] MIB module, SNMPv2-TC 948 [2] MIB module, SNMPv2-CONF [3] MIB Module, the DOCSIS RFI 949 Specification SP-RFIv2.0-I06-040804 [4], INET-ADDRESS-MIB [8] MIB 950 module, IF-MIB [11] MIB module, SNMP-FRAMEWORK-MIB [12] MIB module, 951 and the DIFFSERV-DSCP-TC [13] MIB module. 953 DOCS-IETF-QOS-MIB DEFINITIONS ::= BEGIN 955 IMPORTS 956 MODULE-IDENTITY, 957 OBJECT-TYPE, 958 Integer32, 959 Counter32, 960 Unsigned32, 961 Counter64, 962 mib-2 963 FROM SNMPv2-SMI 965 TEXTUAL-CONVENTION, 966 MacAddress, 967 RowStatus, 968 TruthValue, 969 TimeStamp, 970 StorageType 971 FROM SNMPv2-TC 973 OBJECT-GROUP, 974 MODULE-COMPLIANCE 975 FROM SNMPv2-CONF 977 ifIndex, 978 InterfaceIndex 979 FROM IF-MIB 981 InetAddressType, 982 InetAddress, 983 InetPortNumber 984 FROM INET-ADDRESS-MIB 986 DscpOrAny 987 FROM DIFFSERV-DSCP-TC 989 SnmpAdminString 990 FROM SNMP-FRAMEWORK-MIB; 992 docsIetfQosMIB MODULE-IDENTITY 993 LAST-UPDATED "200502070000Z" -- February 7, 2005 994 ORGANIZATION "IETF IP over Cable Data Network (IPCDN) 995 Working Group" 997 IPCDN DOCSIS QoS MIB February 2005 999 CONTACT-INFO 1000 " 1001 Co-Author: Michael Patrick 1002 Postal: Motorola BCS 1003 111 Locke Drive 1004 Marlborough, MA 01752-7214 1005 U.S.A. 1006 Phone: +1 508 786 7563 1007 E-mail: michael.patrick@motorola.com 1009 Co-Author: William Murwin 1010 Postal: Motorola BCS 1011 111 Locke Drive 1012 Marlborough, MA 01752-7214 1013 U.S.A. 1014 Phone: +1 508 786 7594 1015 E-mail: w.murwin@motorola.com 1017 IETF IPCDN Working Group 1018 General Discussion: ipcdn@ietf.org 1019 Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn 1020 Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn 1021 Co-chairs: Richard Woundy, Richard_Woundy@cable.comcast.com 1022 Jean-Francois Mule, jfm@cablelabs.com" 1023 DESCRIPTION 1024 "This is the management information for 1025 Quality Of Service (QOS) for DOCSIS 1.1 and 2.0." 1027 REVISION "200502070000Z" -- February 7, 2005 1028 DESCRIPTION 1029 "Initial version, published as RFC xxxx." 1030 ::= { mib-2 xx } -- xx to be assigned by IANA 1032 -- 1033 -- Placeholder for notifications/traps. 1034 -- 1035 docsIetfQosNotifications OBJECT IDENTIFIER ::= { docsIetfQosMIB 0 } 1037 docsIetfQosMIBObjects OBJECT IDENTIFIER ::= { docsIetfQosMIB 1 } 1039 -- Textual Conventions 1040 DocsIetfQosRfMacIfDirection ::= TEXTUAL-CONVENTION 1041 STATUS current 1042 DESCRIPTION "Indicates a direction on an RF MAC interface. 1044 The value downstream(1) is from Cable Modem 1045 Termination System to Cable Modem. 1047 The value upstream(2) is from Cable Modem to 1048 Cable Modem Termination System." 1049 SYNTAX INTEGER { 1051 IPCDN DOCSIS QoS MIB February 2005 1053 downstream(1), 1054 upstream(2) 1055 } 1057 DocsIetfQosBitRate ::= TEXTUAL-CONVENTION 1058 DISPLAY-HINT "d" 1059 STATUS current 1060 DESCRIPTION "The rate of traffic in unit of bits per second. 1061 Used to specify traffic rate for QOS." 1062 SYNTAX Unsigned32 1064 DocsIetfQosSchedulingType ::= TEXTUAL-CONVENTION 1065 STATUS current 1066 DESCRIPTION "The scheduling service provided by a CMTS for an 1067 upstream Service Flow. If the parameter is omitted 1068 from an upstream QOS Parameter Set, this object 1069 takes the value of bestEffort (2). This parameter 1070 must be reported as undefined (1) for downstream 1071 QOS Parameter Sets." 1072 SYNTAX INTEGER { 1073 undefined (1), 1074 bestEffort (2), 1075 nonRealTimePollingService(3), 1076 realTimePollingService(4), 1077 unsolictedGrantServiceWithAD(5), 1078 unsolictedGrantService(6) 1079 } 1081 ----------------------------------------------------------------------- 1082 -- 1083 -- Packet Classifier Table 1084 -- 1085 docsIetfQosPktClassTable OBJECT-TYPE 1086 SYNTAX SEQUENCE OF DocsIetfQosPktClassEntry 1087 MAX-ACCESS not-accessible 1088 STATUS current 1089 DESCRIPTION "This table describes the packet classification 1090 configured on the CM or CMTS. 1091 The model is that a packet either received 1092 as input from an interface or transmitted 1093 for output on an interface may be compared 1094 against an ordered list of rules pertaining to 1095 the packet contents. Each rule is a row of this 1096 table. A matching rule provides a Service Flow 1097 id to to which the packet is classified. 1098 All rules need to match for a packet to match 1099 a classifier. 1101 The objects in this row correspond to a set of 1102 Classifier Encoding parameters in a DOCSIS 1103 MAC management message. The 1105 IPCDN DOCSIS QoS MIB February 2005 1107 docsIetfQosPktClassBitMap indicates which 1108 particular parameters were present in the 1109 classifier as signaled in the DOCSIS message. 1110 If the referenced parameter was not present 1111 in the signaled DOCSIS 1.1 and 2.0 Classifier, the 1112 corresponding object in this row reports a 1113 value as specified in the DESCRIPTION section. 1114 " 1115 ::= { docsIetfQosMIBObjects 1 } 1117 docsIetfQosPktClassEntry OBJECT-TYPE 1118 SYNTAX DocsIetfQosPktClassEntry 1119 MAX-ACCESS not-accessible 1120 STATUS current 1121 DESCRIPTION "An entry in this table provides a single packet 1122 classifier rule. The index ifIndex is an ifType 1123 of docsCableMaclayer(127)." 1124 INDEX { 1125 ifIndex, 1126 docsIetfQosServiceFlowId, 1127 docsIetfQosPktClassId 1128 } 1129 ::= { docsIetfQosPktClassTable 1 } 1131 DocsIetfQosPktClassEntry ::= SEQUENCE { 1132 docsIetfQosPktClassId Unsigned32, 1133 docsIetfQosPktClassDirection DocsIetfQosRfMacIfDirection, 1134 docsIetfQosPktClassPriority Integer32, 1135 docsIetfQosPktClassIpTosLow OCTET STRING, 1136 docsIetfQosPktClassIpTosHigh OCTET STRING, 1137 docsIetfQosPktClassIpTosMask OCTET STRING, 1138 docsIetfQosPktClassIpProtocol Integer32, 1139 docsIetfQosPktClassInetAddressType InetAddressType, 1140 docsIetfQosPktClassInetSourceAddr InetAddress, 1141 docsIetfQosPktClassInetSourceMask InetAddress, 1142 docsIetfQosPktClassInetDestAddr InetAddress, 1143 docsIetfQosPktClassInetDestMask InetAddress, 1144 docsIetfQosPktClassSourcePortStart InetPortNumber, 1145 docsIetfQosPktClassSourcePortEnd InetPortNumber, 1146 docsIetfQosPktClassDestPortStart InetPortNumber, 1147 docsIetfQosPktClassDestPortEnd InetPortNumber, 1148 docsIetfQosPktClassDestMacAddr MacAddress, 1149 docsIetfQosPktClassDestMacMask MacAddress, 1150 docsIetfQosPktClassSourceMacAddr MacAddress, 1151 docsIetfQosPktClassEnetProtocolType INTEGER, 1152 docsIetfQosPktClassEnetProtocol Integer32, 1153 docsIetfQosPktClassUserPriLow Integer32, 1154 docsIetfQosPktClassUserPriHigh Integer32, 1156 IPCDN DOCSIS QoS MIB February 2005 1158 docsIetfQosPktClassVlanId Integer32, 1159 docsIetfQosPktClassStateActive TruthValue, 1160 docsIetfQosPktClassPkts Counter64, 1161 docsIetfQosPktClassBitMap BITS 1162 } 1164 docsIetfQosPktClassId OBJECT-TYPE 1165 SYNTAX Unsigned32 (1..65535) 1166 MAX-ACCESS not-accessible 1167 STATUS current 1168 DESCRIPTION "Index assigned to packet classifier entry by 1169 the CMTS which is unique per Service Flow." 1170 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.2" 1171 ::= { docsIetfQosPktClassEntry 1 } 1173 docsIetfQosPktClassDirection OBJECT-TYPE 1174 SYNTAX DocsIetfQosRfMacIfDirection 1175 MAX-ACCESS read-only 1176 STATUS current 1177 DESCRIPTION "Indicates the direction to which the classifier 1178 is applied." 1179 ::= { docsIetfQosPktClassEntry 2 } 1181 docsIetfQosPktClassPriority OBJECT-TYPE 1182 SYNTAX Integer32 (0..255) 1183 MAX-ACCESS read-only 1184 STATUS current 1185 DESCRIPTION "The value specifies the order of evaluation 1186 of the classifiers. 1187 The higher the value the higher the priority. 1188 The value of 0 is used as default in 1189 provisioned Service Flows Classifiers. 1190 The default value of 64 is used for dynamic 1191 Service Flow Classifiers. 1192 If the referenced parameter is not present 1193 in a classifier, this object reports the default 1194 value as defined above." 1195 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.5" 1196 ::= { docsIetfQosPktClassEntry 3 } 1198 docsIetfQosPktClassIpTosLow OBJECT-TYPE 1199 SYNTAX OCTET STRING (SIZE(1)) 1200 MAX-ACCESS read-only 1201 STATUS current 1202 DESCRIPTION "The low value of a range of TOS byte values. 1203 If the referenced parameter is not present 1204 in a classifier, this object reports the value 1205 of 0. 1207 The IP TOS octet as originally defined in RFC 791 1208 has been superseded by the 6 bit Differentiated 1210 IPCDN DOCSIS QoS MIB February 2005 1212 Services Field (DSField, RFC 3260) and the 2 bit 1213 Explicit Congestion Notification Field (ECN field, 1214 RFC 3168). This object is defined as a 8 bit 1215 octet as defined by the DOCSIS Specification 1216 for packet classification." 1217 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.1" 1218 ::= { docsIetfQosPktClassEntry 4 } 1220 docsIetfQosPktClassIpTosHigh OBJECT-TYPE 1221 SYNTAX OCTET STRING (SIZE(1)) 1222 MAX-ACCESS read-only 1223 STATUS current 1224 DESCRIPTION "The 8-bit high value of a range of TOS byte 1225 values. 1227 If the referenced parameter is not present 1228 in a classifier, this object reports the 1229 value of 0. 1231 The IP TOS octet as originally defined in RFC 791 1232 has been superseded by the 6 bit Differentiated 1233 Services Field (DSField, RFC 3260) and the 2 bit 1234 Explicit Congestion Notification Field (ECN field, 1235 RFC 3168). This object is defined as a 8 bit 1236 octet as defined by the DOCSIS Specification 1237 for packet classification." 1238 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.1" 1239 ::= { docsIetfQosPktClassEntry 5 } 1241 docsIetfQosPktClassIpTosMask OBJECT-TYPE 1242 SYNTAX OCTET STRING (SIZE(1)) 1243 MAX-ACCESS read-only 1244 STATUS current 1245 DESCRIPTION "The mask value is bitwise ANDed with TOS byte 1246 in an IP packet and this value is used check 1247 range checking of TosLow and TosHigh. 1249 If the referenced parameter is not present 1250 in a classifier, this object reports the value 1251 of 0. 1253 The IP TOS octet as originally defined in RFC 791 1254 has been superseded by the 6 bit Differentiated 1255 Services Field (DSField, RFC 3260) and the 2 bit 1256 Explicit Congestion Notification Field (ECN field, 1257 RFC 3168). This object is defined as a 8 bit 1258 octet as defined by the DOCSIS Specification 1259 for packet classification." 1260 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.1" 1261 ::= { docsIetfQosPktClassEntry 6 } 1263 IPCDN DOCSIS QoS MIB February 2005 1265 docsIetfQosPktClassIpProtocol OBJECT-TYPE 1266 SYNTAX Integer32 (0..258) 1267 MAX-ACCESS read-only 1268 STATUS current 1269 DESCRIPTION "This object indicates the value of the IP 1270 Protocol field required for IP packets to match 1271 this rule. 1273 The value 256 matches traffic with any IP Protocol 1274 value. The value 257 by convention matches both TCP 1275 and UDP. 1277 If the referenced parameter is not present 1278 in a classifier, this object reports the value 1279 of 258." 1280 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.2" 1281 ::= { docsIetfQosPktClassEntry 7 } 1283 docsIetfQosPktClassInetAddressType OBJECT-TYPE 1284 SYNTAX InetAddressType 1285 MAX-ACCESS read-only 1286 STATUS current 1287 DESCRIPTION "The type of the internet address for 1288 docsIetfQosPktClassInetSourceAddr, 1289 docsIetfQosPktClassInetSourceMask, 1290 docsIetfQosPktClassInetDestAddr, and 1291 docsIetfQosPktClassInetDestMask. 1293 If the referenced parameter is not present 1294 in a classifier, this object reports the value of 1295 ipv4(1)." 1296 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.3" 1297 ::= { docsIetfQosPktClassEntry 8 } 1299 docsIetfQosPktClassInetSourceAddr OBJECT-TYPE 1300 SYNTAX InetAddress 1301 MAX-ACCESS read-only 1302 STATUS current 1303 DESCRIPTION "This object specifies the value of the IP 1304 Source Address required for packets to match 1305 this rule. An IP packet matches the rule when 1306 the packet ip source address bitwise ANDed 1307 with the docsIetfQosPktClassInetSourceMask value 1308 equals the docsIetfQosPktClassInetSourceAddr value. 1310 The address type of this object is specified by 1311 docsIetfQosPktClassInetAddressType. 1313 If the referenced parameter is not present 1314 in a classifier, this object reports the value of 1315 '00000000'H." 1317 IPCDN DOCSIS QoS MIB February 2005 1319 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.3" 1320 ::= { docsIetfQosPktClassEntry 9 } 1322 docsIetfQosPktClassInetSourceMask OBJECT-TYPE 1323 SYNTAX InetAddress 1324 MAX-ACCESS read-only 1325 STATUS current 1326 DESCRIPTION "This object specifies which bits of a packet's 1327 IP Source Address that are compared to match 1328 this rule. 1329 An IP packet matches the rule when the packet 1330 source address bitwise ANDed with the 1331 docsIetfQosPktClassInetSourceMask value equals the 1332 docsIetfQosIpPktClassInetSourceAddr value. 1334 The address type of this object is specified by 1335 docsIetfQosPktClassInetAddressType. 1337 If the referenced parameter is not present 1338 in a classifier, this object reports the value of 1339 'FFFFFFFF'H." 1340 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.4" 1341 ::= { docsIetfQosPktClassEntry 10 } 1343 docsIetfQosPktClassInetDestAddr OBJECT-TYPE 1344 SYNTAX InetAddress 1345 MAX-ACCESS read-only 1346 STATUS current 1347 DESCRIPTION "This object specifies the value of the IP 1348 Destination Address required for packets to match 1349 this rule. An IP packet matches the rule when 1350 the packet ip destination address 1351 bitwise ANDed with the 1352 docsIetfQosPktClassInetDestMask value 1353 equals the docsIetfQosPktClassInetDestAddr value. 1355 The address type of this object is specified by 1356 docsIetfQosPktClassInetAddressType. 1358 If the referenced parameter is not present 1359 in a classifier, this object reports the value of 1360 '00000000'H." 1361 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.5" 1362 ::= { docsIetfQosPktClassEntry 11 } 1364 docsIetfQosPktClassInetDestMask OBJECT-TYPE 1365 SYNTAX InetAddress 1366 MAX-ACCESS read-only 1367 STATUS current 1368 DESCRIPTION "This object specifies which bits of a packet's 1369 IP Destination Address that are compared to 1371 IPCDN DOCSIS QoS MIB February 2005 1373 match this rule. 1374 An IP packet matches the rule when the packet 1375 destination address bitwise ANDed with the 1376 docsIetfQosPktClassInetDestMask value equals the 1377 docsIetfQosIpPktClassInetDestAddr value. 1379 The address type of this object is specified by 1380 docsIetfQosPktClassInetAddressType. 1382 If the referenced parameter is not present 1383 in a classifier, this object reports the value of 1384 'FFFFFFFF'H." 1385 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.6" 1386 ::= { docsIetfQosPktClassEntry 12 } 1388 docsIetfQosPktClassSourcePortStart OBJECT-TYPE 1389 SYNTAX InetPortNumber 1390 MAX-ACCESS read-only 1391 STATUS current 1392 DESCRIPTION "This object specifies the low end inclusive 1393 range of TCP/UDP source port numbers to which 1394 a packet is compared. This object is irrelevant 1395 for non-TCP/UDP IP packets. 1397 If the referenced parameter is not present 1398 in a classifier, this object reports the value 1399 of 0." 1400 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.7" 1401 ::= { docsIetfQosPktClassEntry 13 } 1403 docsIetfQosPktClassSourcePortEnd OBJECT-TYPE 1404 SYNTAX InetPortNumber 1405 MAX-ACCESS read-only 1406 STATUS current 1407 DESCRIPTION "This object specifies the high end inclusive 1408 range of TCP/UDP source port numbers to which 1409 a packet is compared. This object is irrelevant 1410 for non-TCP/UDP IP packets. 1412 If the referenced parameter is not present 1413 in a classifier, this object reports the value of 1414 65535." 1415 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.8" 1416 ::= { docsIetfQosPktClassEntry 14 } 1418 docsIetfQosPktClassDestPortStart OBJECT-TYPE 1419 SYNTAX InetPortNumber 1420 MAX-ACCESS read-only 1421 STATUS current 1422 DESCRIPTION "This object specifies the low end inclusive 1423 range of TCP/UDP destination port numbers to 1425 IPCDN DOCSIS QoS MIB February 2005 1427 which a packet is compared. 1429 If the referenced parameter is not present 1430 in a classifier, this object reports the value 1431 of 0." 1432 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.9" 1433 ::= { docsIetfQosPktClassEntry 15 } 1435 docsIetfQosPktClassDestPortEnd OBJECT-TYPE 1436 SYNTAX InetPortNumber 1437 MAX-ACCESS read-only 1438 STATUS current 1439 DESCRIPTION "This object specifies the high end inclusive 1440 range of TCP/UDP destination port numbers to which 1441 a packet is compared. 1443 If the referenced parameter is not present 1444 in a classifier, this object reports the value of 1445 65535." 1446 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.5.10" 1447 ::= { docsIetfQosPktClassEntry 16 } 1449 docsIetfQosPktClassDestMacAddr OBJECT-TYPE 1450 SYNTAX MacAddress 1451 MAX-ACCESS read-only 1452 STATUS current 1453 DESCRIPTION "An Ethernet packet matches an entry when its 1454 destination MAC address bitwise ANDed with 1455 docsIetfQosPktClassDestMacMask equals the value of 1456 docsIetfQosPktClassDestMacAddr. 1458 If the referenced parameter is not present 1459 in a classifier, this object reports the value of 1460 '000000000000'H. 1461 " 1462 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.1" 1463 ::= { docsIetfQosPktClassEntry 17 } 1465 docsIetfQosPktClassDestMacMask OBJECT-TYPE 1466 SYNTAX MacAddress 1467 MAX-ACCESS read-only 1468 STATUS current 1469 DESCRIPTION "An Ethernet packet matches an entry when its 1470 destination MAC address bitwise ANDed with 1471 docsIetfQosPktClassDestMacMask equals the value of 1472 docsIetfQosPktClassDestMacAddr. 1474 If the referenced parameter is not present 1475 in a classifier, this object reports the value of 1476 '000000000000'H. 1478 IPCDN DOCSIS QoS MIB February 2005 1480 " 1481 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.1" 1482 ::= { docsIetfQosPktClassEntry 18 } 1484 docsIetfQosPktClassSourceMacAddr OBJECT-TYPE 1485 SYNTAX MacAddress 1486 MAX-ACCESS read-only 1487 STATUS current 1488 DESCRIPTION "An Ethernet packet matches this entry when its 1489 source MAC address equals the value of 1490 this object. 1492 If the referenced parameter is not present 1493 in a classifier, this object reports the value of 1494 'FFFFFFFFFFFF'H. 1495 " 1496 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.2" 1497 ::= { docsIetfQosPktClassEntry 19 } 1499 docsIetfQosPktClassEnetProtocolType OBJECT-TYPE 1500 SYNTAX INTEGER { 1501 none(0), 1502 ethertype(1), 1503 dsap(2), 1504 mac(3), 1505 all(4) 1506 } 1507 MAX-ACCESS read-only 1508 STATUS current 1509 DESCRIPTION "This object indicates the format of the layer 3 1510 protocol id in the Ethernet packet. A value of 1511 none(0) means that the rule does not use the 1512 layer 3 protocol type as a matching criteria. 1514 A value of ethertype(1) means that the rule 1515 applies only to frames which contains an 1516 EtherType value. Ethertype values are contained 1517 in packets using the Dec-Intel-Xerox (DIX) 1518 encapsulation or the RFC1042 Sub-Network Access 1519 Protocol (SNAP) encapsulation formats. 1521 A value of dsap(2) means that the rule applies 1522 only to frames using the IEEE802.3 1523 encapsulation format with a Destination Service 1524 Access Point (DSAP) other 1525 than 0xAA (which is reserved for SNAP). 1527 A value of mac(3) means that the rule applies 1528 only to MAC management messages for MAC management 1529 messages. 1531 IPCDN DOCSIS QoS MIB February 2005 1533 A value of all(4) means that the rule matches 1534 all Ethernet packets. 1536 If the Ethernet frame contains an 802.1P/Q Tag 1537 header (i.e. EtherType 0x8100), this object 1538 applies to the embedded EtherType field within 1539 the 802.1P/Q header. 1541 If the referenced parameter is not present 1542 in a classifier, this object reports the value of 0. 1544 " 1545 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.3" 1546 ::= { docsIetfQosPktClassEntry 20 } 1548 docsIetfQosPktClassEnetProtocol OBJECT-TYPE 1549 SYNTAX Integer32 (0..65535) 1550 MAX-ACCESS read-only 1551 STATUS current 1552 DESCRIPTION "If docsIetfQosEthPktClassProtocolType is none(0), 1553 this object is ignored when considering whether 1554 a packet matches the current rule. 1556 If dosQosPktClassEnetProtocolType is ethertype(1), 1557 this object gives the 16-bit value of the 1558 EtherType that the packet must match in order to 1559 match the rule. 1561 If docsIetfQosPktClassEnetProtocolType is dsap(2), 1562 the lower 8 bits of this object's value must match 1563 the DSAP byte of the packet in order to match the 1564 rule. 1566 If docsIetfQosPktClassEnetProtocolType is mac(3), 1567 the lower 8 bits of this object value represent a 1568 lower bound (inclusive) of MAC management message 1569 type codes matched, and the upper 8 bits of this 1570 object value represent the upper bound (inclusive) 1571 of matched MAC message type codes. Certain 1572 message type codes are excluded from matching, as 1573 specified in the reference. 1575 If the Ethernet frame contains an 802.1P/Q Tag 1576 header (i.e. EtherType 0x8100), this object applies 1577 to the embedded EtherType field within the 802.1P/Q 1578 header. 1580 If the referenced parameter is not present in the 1581 classifier, the value of this object is reported 1582 as 0." 1583 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.6.3" 1585 IPCDN DOCSIS QoS MIB February 2005 1587 ::= { docsIetfQosPktClassEntry 21 } 1589 docsIetfQosPktClassUserPriLow OBJECT-TYPE 1590 SYNTAX Integer32 (0..7) 1591 MAX-ACCESS read-only 1592 STATUS current 1593 DESCRIPTION "This object applies only to Ethernet frames 1594 using the 802.1P/Q tag header (indicated with 1595 EtherType 0x8100). Such frames include a 16-bit 1596 Tag that contains a 3 bit Priority field and 1597 a 12 bit VLAN number. 1599 Tagged Ethernet packets must have a 3-bit 1600 Priority field within the range of 1601 docsIetfQosPktClassPriLow and 1602 docsIetfQosPktClassPriHigh in order to match this 1603 rule. 1605 If the referenced parameter is not present in the 1606 classifier, the value of this object is reported 1607 as 0." 1608 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.7.1" 1609 ::= { docsIetfQosPktClassEntry 22 } 1611 docsIetfQosPktClassUserPriHigh OBJECT-TYPE 1612 SYNTAX Integer32 (0..7) 1613 MAX-ACCESS read-only 1614 STATUS current 1615 DESCRIPTION "This object applies only to Ethernet frames 1616 using the 802.1P/Qtag header (indicated with 1617 EtherType 0x8100). Such frames include a 16-bit 1618 Tag that contains a 3 bit Priority field and 1619 a 12 bit VLAN number. 1621 Tagged Ethernet packets must have a 3-bit 1622 Priority field within the range of 1623 docsIetfQosPktClassPriLow and 1624 docsIetfQosPktClassPriHigh in order to match this 1625 rule. 1627 If the referenced parameter is not present in the 1628 classifier, the value of this object is reported 1629 as 7. 1630 " 1631 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.7.1" 1632 ::= { docsIetfQosPktClassEntry 23 } 1634 docsIetfQosPktClassVlanId OBJECT-TYPE 1635 SYNTAX Integer32 (0 | 1..4094) 1636 MAX-ACCESS read-only 1637 STATUS current 1639 IPCDN DOCSIS QoS MIB February 2005 1641 DESCRIPTION "This object applies only to Ethernet frames 1642 using the 802.1P/Q tag header. 1644 Tagged packets must have a VLAN Identifier that 1645 matches the value in order to match the rule. 1647 If the referenced parameter is not present in the 1648 classifier, the value of this object is reported 1649 as 0. 1650 " 1651 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.7.2" 1652 ::= { docsIetfQosPktClassEntry 24 } 1654 docsIetfQosPktClassStateActive OBJECT-TYPE 1655 SYNTAX TruthValue 1656 MAX-ACCESS read-only 1657 STATUS current 1658 DESCRIPTION "This object indicates whether or not the classifier 1659 is enabled to classify packets to a Service Flow. 1661 If the referenced parameter is not present in the 1662 classifier, the value of this object is reported 1663 as true(1)." 1664 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.6" 1665 ::= { docsIetfQosPktClassEntry 25 } 1667 docsIetfQosPktClassPkts OBJECT-TYPE 1668 SYNTAX Counter64 1669 MAX-ACCESS read-only 1670 STATUS current 1671 DESCRIPTION "This object counts the number of packets that have 1672 been classified using this entry. This 1673 includes all packets delivered to a Service Flow 1674 maximum rate policing function, whether or not that 1675 function drops the packets. 1677 This counter's last discontinuity is the 1678 ifCounterDiscontinuityTime for same ifIndex that 1679 indexes this object." 1680 ::= { docsIetfQosPktClassEntry 26 } 1682 docsIetfQosPktClassBitMap OBJECT-TYPE 1683 SYNTAX BITS { -- Reference SP-RFIv2.0-I06-040804 1684 rulePriority(0), -- Appendix C.2.1.3.4 1685 activationState(1), -- Appendix C.2.1.3.6 1686 ipTos(2), -- Appendix C.2.1.5.1 1687 ipProtocol(3), -- Appendix C.2.1.5.2 1688 ipSourceAddr(4), -- Appendix C.2.1.5.3 1689 ipSourceMask(5), -- Appendix C.2.1.5.4 1690 ipDestAddr(6), -- Appendix C.2.1.5.5 1692 IPCDN DOCSIS QoS MIB February 2005 1694 ipDestMask(7), -- Appendix C.2.1.5.6 1695 sourcePortStart(8), -- Appendix C.2.1.5.7 1696 sourcePortEnd(9), -- Appendix C.2.1.5.8 1697 destPortStart(10), -- Appendix C.2.1.5.9 1698 destPortEnd(11), -- Appendix C.2.1.5.10 1699 destMac(12), -- Appendix C.2.1.6.1 1700 sourceMac(13), -- Appendix C.2.1.6.2 1701 ethertype(14), -- Appendix C.2.1.6.3 1702 userPri(15), -- Appendix C.2.1.7.1 1703 vlanId(16) -- Appendix C.2.1.7.2 1704 } 1705 MAX-ACCESS read-only 1706 STATUS current 1707 DESCRIPTION 1708 "This object indicates which parameter encodings 1709 were actually present in the DOCSIS packet 1710 classifier encoding signaled in the DOCSIS message 1711 that created or modified the classifier. Note that 1712 Dynamic Service Change messages have replace 1713 semantics, so that all non-default parameters must 1714 be present whether the classifier is being created 1715 or changed. 1717 A bit of this object is set to 1 if the parameter 1718 indicated by the comment was present in the 1719 classifier encoding, and 0 otherwise. 1721 Note that BITS are encoded most significant bit 1722 first, so that if e.g. bits 6 and 7 are set, this 1723 object is encoded as the octet string '030000'H." 1724 ::= { docsIetfQosPktClassEntry 27 } 1726 -- 1727 -- QOS Parameter Set Table 1728 -- 1729 docsIetfQosParamSetTable OBJECT-TYPE 1730 SYNTAX SEQUENCE OF DocsIetfQosParamSetEntry 1731 MAX-ACCESS not-accessible 1732 STATUS current 1733 DESCRIPTION "This table describes the set of DOCSIS 1.1 and 2.0 1734 QOS parameters defined in a managed device. 1736 The ifIndex index specifies a DOCSIS MAC Domain. 1737 The docsIetfQosServiceFlowId index specifies a 1738 particular Service Flow. 1739 The docsIetfQosParamSetType index indicates whether 1740 the active, admitted, or provisioned QOS Parameter 1741 Set is being described by the row. 1743 Only the QOS Parameter Sets of DOCSIS 1.1 and 2.0 1744 Service Flows are represented in this table. 1746 IPCDN DOCSIS QoS MIB February 2005 1748 DOCSIS 1.0 QOS service profiles are not 1749 represented in this table. 1751 Each row corresponds to a DOCSIS QOS Parameter Set 1752 as signaled via DOCSIS MAC management messages. 1753 Each object in the row corresponds to one or 1754 part of one DOCSIS 1.1 Service Flow Encoding. 1755 The docsIetfQosParamSetBitMap object in the row 1756 indicates which particular parameters were signaled 1757 in the original registration or dynamic service 1758 request message that created the QOS Parameter Set. 1760 In many cases, even if a QOS Parameter Set parameter 1761 was not signaled, the DOCSIS specification calls 1762 for a default value to be used. That default value 1763 is reported as the value of the corresponding object 1764 in this row. 1766 Many objects are not applicable depending on 1767 the Service Flow direction or upstream scheduling 1768 type. The object value reported in this case 1769 is specified in the DESCRIPTION clause. 1770 " 1771 ::= { docsIetfQosMIBObjects 2 } 1773 docsIetfQosParamSetEntry OBJECT-TYPE 1774 SYNTAX DocsIetfQosParamSetEntry 1775 MAX-ACCESS not-accessible 1776 STATUS current 1777 DESCRIPTION 1778 "A unique set of QOS parameters." 1779 INDEX { 1780 ifIndex, docsIetfQosServiceFlowId, docsIetfQosParamSetType 1781 } 1782 ::= { docsIetfQosParamSetTable 1 } 1784 DocsIetfQosParamSetEntry ::= SEQUENCE { 1785 docsIetfQosParamSetServiceClassName SnmpAdminString, 1786 docsIetfQosParamSetPriority Integer32, 1787 docsIetfQosParamSetMaxTrafficRate DocsIetfQosBitRate, 1788 docsIetfQosParamSetMaxTrafficBurst Unsigned32, 1789 docsIetfQosParamSetMinReservedRate DocsIetfQosBitRate, 1790 docsIetfQosParamSetMinReservedPkt Integer32, 1791 docsIetfQosParamSetActiveTimeout Integer32, 1792 docsIetfQosParamSetAdmittedTimeout Integer32, 1793 docsIetfQosParamSetMaxConcatBurst Integer32, 1794 docsIetfQosParamSetSchedulingType DocsIetfQosSchedulingType, 1795 docsIetfQosParamSetNomPollInterval Unsigned32, 1796 docsIetfQosParamSetTolPollJitter Unsigned32, 1797 docsIetfQosParamSetUnsolicitGrantSize Integer32, 1798 docsIetfQosParamSetNomGrantInterval Unsigned32, 1800 IPCDN DOCSIS QoS MIB February 2005 1802 docsIetfQosParamSetTolGrantJitter Unsigned32, 1803 docsIetfQosParamSetGrantsPerInterval Integer32, 1804 docsIetfQosParamSetTosAndMask OCTET STRING, 1805 docsIetfQosParamSetTosOrMask OCTET STRING, 1806 docsIetfQosParamSetMaxLatency Unsigned32, 1807 docsIetfQosParamSetType INTEGER, 1808 docsIetfQosParamSetRequestPolicyOct OCTET STRING, 1809 docsIetfQosParamSetBitMap BITS 1810 } 1812 docsIetfQosParamSetServiceClassName OBJECT-TYPE 1813 SYNTAX SnmpAdminString 1814 MAX-ACCESS read-only 1815 STATUS current 1816 DESCRIPTION "Refers to the Service Class Name that the 1817 parameter set values were derived. 1819 If the referenced parameter is not present in the 1820 corresponding DOCSIS QOS Parameter Set, the default 1821 value of this object is a zero length string. 1822 " 1823 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.4" 1824 ::= { docsIetfQosParamSetEntry 1 } 1826 docsIetfQosParamSetPriority OBJECT-TYPE 1827 SYNTAX Integer32 (0..7) 1828 MAX-ACCESS read-only 1829 STATUS current 1830 DESCRIPTION "The relative priority of a Service Flow. 1831 Higher numbers indicate higher priority. 1832 This priority should only be used to differentiate 1833 Service Flow with identical parameter sets. 1835 If the referenced parameter is not present in the 1836 corresponding DOCSIS QOS Parameter Set, the default 1837 value of this object is 0. If the parameter is 1838 not applicable, the reported value is 0. 1839 " 1840 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.1" 1841 ::= { docsIetfQosParamSetEntry 2 } 1843 docsIetfQosParamSetMaxTrafficRate OBJECT-TYPE 1844 SYNTAX DocsIetfQosBitRate 1845 MAX-ACCESS read-only 1846 STATUS current 1847 DESCRIPTION "Maximum sustained traffic rate allowed for this 1848 Service Flow in bits/sec. Must count all MAC frame 1849 data PDU from the bytes following the MAC header 1850 HCS to the end of the CRC. The number of bytes 1851 forwarded is limited during any time interval. 1852 The value 0 means no maximum traffic rate is 1854 IPCDN DOCSIS QoS MIB February 2005 1856 enforced. This object applies to both upstream and 1857 downstream Service Flows. 1859 If the referenced parameter is not present in the 1860 corresponding DOCSIS QOS Parameter Set, the default 1861 value of this object is 0. If the parameter is 1862 not applicable, it is reported as 0. 1863 " 1864 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.2" 1865 ::= { docsIetfQosParamSetEntry 3 } 1867 docsIetfQosParamSetMaxTrafficBurst OBJECT-TYPE 1868 SYNTAX Unsigned32 1869 MAX-ACCESS read-only 1870 STATUS current 1871 DESCRIPTION "Specifies the token bucket size in bytes 1872 for this parameter set. The value is calculated 1873 from the byte following the MAC header HCS to 1874 the end of the CRC. This object is applied in 1875 conjunction with docsIetfQosParamSetMaxTrafficRate 1876 to calculate maximum sustained traffic rate. 1878 If the referenced parameter is not present in the 1879 corresponding DOCSIS QOS Parameter Set, the default 1880 value of this object for scheduling types 1881 bestEffort (2), nonRealTimePollingService(3), 1882 and realTimePollingService(4) is 3044. 1884 If this parameter is not applicable, it is reported 1885 as 0. 1886 " 1887 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.3" 1888 ::= { docsIetfQosParamSetEntry 4 } 1890 docsIetfQosParamSetMinReservedRate OBJECT-TYPE 1891 SYNTAX DocsIetfQosBitRate 1892 MAX-ACCESS read-only 1893 STATUS current 1894 DESCRIPTION "Specifies the guaranteed minimum rate in 1895 bits/sec for this parameter set. The value is 1896 calculated from the byte following the MAC 1897 header HCS to the end of the CRC. The default 1898 value of 0 has the meaning that no bandwidth 1899 is reserved. 1900 If the referenced parameter is not present in the 1901 corresponding DOCSIS QOS Parameter Set, the default 1902 value of this object is 0. If the parameter 1903 is not applicable, it is reported as 0. 1904 " 1905 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.4" 1906 ::= { docsIetfQosParamSetEntry 5 } 1908 IPCDN DOCSIS QoS MIB February 2005 1910 docsIetfQosParamSetMinReservedPkt OBJECT-TYPE 1911 SYNTAX Integer32 (0..65535) 1912 MAX-ACCESS read-only 1913 STATUS current 1914 DESCRIPTION "Specifies an assumed minimum packet size in 1915 bytes for which the 1916 docsIetfQosParamSetMinReservedRate will be 1917 provided. The value is calculated from the byte 1918 following the MAC header HCS to the end of the 1919 CRC. 1921 If the referenced parameter is omitted from a 1922 DOCSIS QOS parameter set, the default value is 1923 CMTS implementation dependent. In this case, the 1924 CMTS reports the default value it is using and the 1925 CM reports a value of 0. If the referenced 1926 parameter is not applicable to the direction or 1927 scheduling type of the Service Flow, both CMTS and 1928 CM report this object's value as 0. 1929 " 1930 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.5" 1931 ::= { docsIetfQosParamSetEntry 6 } 1933 docsIetfQosParamSetActiveTimeout OBJECT-TYPE 1934 SYNTAX Integer32 (0..65535) 1935 UNITS "seconds" 1936 MAX-ACCESS read-only 1937 STATUS current 1938 DESCRIPTION "Specifies the maximum duration in seconds that 1939 resources remain unused on an active service 1940 flow before CMTS signals that both active and 1941 admitted parameters set are null. 1942 The default value of 0 signifies an 1943 infinite amount of time. 1945 If the referenced parameter is not present in the 1946 corresponding DOCSIS QOS Parameter Set, the default 1947 value of this object is 0. 1948 " 1950 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.6" 1951 ::= { docsIetfQosParamSetEntry 7 } 1953 docsIetfQosParamSetAdmittedTimeout OBJECT-TYPE 1954 SYNTAX Integer32 (0..65535) 1955 UNITS "seconds" 1956 MAX-ACCESS read-only 1957 STATUS current 1958 DESCRIPTION "Specifies the maximum duration in seconds that 1959 resources remain in admitted state before 1960 resources must be released. 1962 IPCDN DOCSIS QoS MIB February 2005 1964 The value of 0 signifies an infinite amount 1965 of time. 1967 If the referenced parameter is not present in the 1968 corresponding DOCSIS QOS Parameter Set, the 1969 default value of this object is 200. 1970 " 1972 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.5.7" 1973 DEFVAL { 200 } 1974 ::= { docsIetfQosParamSetEntry 8 } 1976 docsIetfQosParamSetMaxConcatBurst OBJECT-TYPE 1977 SYNTAX Integer32 (0..65535) 1978 MAX-ACCESS read-only 1979 STATUS current 1980 DESCRIPTION "Specifies the maximum concatenated burst in 1981 bytes which an upstream Service Flow is allowed. 1982 The value is calculated from the FC byte of the 1983 Concatenation MAC Header to the last CRC byte in 1984 of the last concatenated MAC frame, inclusive. 1985 The value of 0 specifies no maximum burst. 1987 If the referenced parameter is not present in the 1988 corresponding DOCSIS QOS Parameter Set, the default 1989 value of this object for scheduling types 1990 bestEffort(2), nonRealTimePollingService(3), and 1991 realTimePollingService(4) is 1522. If the parameter 1992 is not applicable, this object's value is reported 1993 as 0. 1994 " 1995 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.1" 1996 ::= { docsIetfQosParamSetEntry 9 } 1998 docsIetfQosParamSetSchedulingType OBJECT-TYPE 1999 SYNTAX DocsIetfQosSchedulingType 2000 MAX-ACCESS read-only 2001 STATUS current 2002 DESCRIPTION "Specifies the upstream scheduling service used for 2003 upstream Service Flow. 2005 If the referenced parameter is not present in the 2006 corresponding DOCSIS QOS Parameter Set of an 2007 upstream Service Flow, the default value of this 2008 object is bestEffort(2). For QOS parameter sets of 2009 downstream Service Flows, this object's value is 2010 reported as undefined(1). 2011 " 2012 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.2" 2013 ::= { docsIetfQosParamSetEntry 10 } 2015 IPCDN DOCSIS QoS MIB February 2005 2017 docsIetfQosParamSetNomPollInterval OBJECT-TYPE 2018 SYNTAX Unsigned32 2019 UNITS "microseconds" 2020 MAX-ACCESS read-only 2021 STATUS current 2022 DESCRIPTION "Specifies the nominal interval in microseconds 2023 between successive unicast request 2024 opportunities on an upstream Service Flow. 2026 This object applies only to upstream Service Flows 2027 with DocsIetfQosSchedulingType of value 2028 nonRealTimePollingService(3), 2029 realTimePollingService(4), and 2030 unsolictedGrantServiceWithAD(5). The parameter is 2031 mandatory for realTimePollingService(4). If the 2032 parameter is omitted with 2033 nonRealTimePollingService(3), the CMTS uses an 2034 implementation dependent value. If the parameter 2035 is omitted with unsolictedGrantServiceWithAD(5), 2036 the CMTS uses as a default value the value of the 2037 Nominal Grant Interval parameter. In all cases, 2038 the CMTS reports the value it is using when the 2039 parameter is applicable. The CM reports the 2040 signaled parameter value if it was signaled, 2041 and 0 otherwise. 2043 If the referenced parameter is not applicable to 2044 the direction or scheduling type of the 2045 corresponding DOCSIS QOS Parameter Set, both 2046 CMTS and CM report this object's value as 0. 2047 " 2048 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.4" 2049 ::= { docsIetfQosParamSetEntry 11 } 2051 docsIetfQosParamSetTolPollJitter OBJECT-TYPE 2052 SYNTAX Unsigned32 2053 UNITS "microseconds" 2054 MAX-ACCESS read-only 2055 STATUS current 2056 DESCRIPTION "Specifies the maximum amount of time in 2057 microseconds that the unicast request interval 2058 may be delayed from the nominal periodic 2059 schedule on an upstream Service Flow. 2061 This parameter is applicable only to upstream 2062 Service Flows with a DocsIetfQosSchedulingType of 2063 realTimePollingService(4) or 2064 unsolictedGrantServiceWithAD(5). 2066 If the referenced parameter is applicable but not 2067 present in the corresponding DOCSIS QOS Parameter 2069 IPCDN DOCSIS QoS MIB February 2005 2071 Set, the CMTS uses an implementation dependent 2072 value and reports the value it is using. 2073 The CM reports a value of 0 in this case. 2075 If the parameter is not applicable to the 2076 direction or upstream scheduling type of the 2077 Service Flow, both CMTS and CM report this 2078 object's value as 0. 2079 " 2080 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.5" 2081 ::= { docsIetfQosParamSetEntry 12 } 2083 docsIetfQosParamSetUnsolicitGrantSize OBJECT-TYPE 2084 SYNTAX Integer32 (0..65535) 2085 MAX-ACCESS read-only 2086 STATUS current 2087 DESCRIPTION "Specifies the unsolicited grant size in bytes. 2088 The grant size includes the entire MAC frame 2089 data PDU from the Frame Control byte to end of 2090 the MAC frame. 2092 The referenced parameter is applicable only 2093 for upstream flows with a DocsIetfQosSchedulingType 2094 of unsolicitedGrantServicewithAD(5) or 2095 unsolicitedGrantService(6), and is mandatory 2096 when applicable. Both CMTS and CM report 2097 the signaled value of the parameter in this 2098 case. 2100 If the referenced parameter is not applicable to 2101 the direction or scheduling type of the 2102 corresponding DOCSIS QOS Parameter Set, both 2103 CMTS and CM report this object's value as 0. 2104 " 2105 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.6" 2106 ::= { docsIetfQosParamSetEntry 13 } 2108 docsIetfQosParamSetNomGrantInterval OBJECT-TYPE 2109 SYNTAX Unsigned32 2110 UNITS "microseconds" 2111 MAX-ACCESS read-only 2112 STATUS current 2113 DESCRIPTION "Specifies the nominal interval in microseconds 2114 between successive data grant opportunities 2115 on an upstream Service Flow. 2117 The referenced parameter is applicable only 2118 for upstream flows with a DocsIetfQosSchedulingType 2119 of unsolicitedGrantServicewithAD(5) or 2120 unsolicitedGrantService(6), and is mandatory 2121 when applicable. Both CMTS and CM report the 2123 IPCDN DOCSIS QoS MIB February 2005 2125 signaled value of the parameter in this case. 2127 If the referenced parameter is not applicable to 2128 the direction or scheduling type of the 2129 corresponding DOCSIS QOS Parameter Set, both 2130 CMTS and CM report this object's value as 0. 2131 " 2133 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.7" 2134 ::= { docsIetfQosParamSetEntry 14 } 2136 docsIetfQosParamSetTolGrantJitter OBJECT-TYPE 2137 SYNTAX Unsigned32 2138 UNITS "microseconds" 2139 MAX-ACCESS read-only 2140 STATUS current 2141 DESCRIPTION "Specifies the maximum amount of time in 2142 microseconds that the transmission opportunities 2143 may be delayed from the nominal periodic schedule. 2145 The referenced parameter is applicable only 2146 for upstream flows with a DocsIetfQosSchedulingType 2147 of unsolicitedGrantServicewithAD(5) or 2148 unsolicitedGrantService(6), and is mandatory 2149 when applicable. Both CMTS and CM report the 2150 signaled value of the parameter in this case. 2152 If the referenced parameter is not applicable to 2153 the direction or scheduling type of the 2154 corresponding DOCSIS QOS Parameter Set, both 2155 CMTS and CM report this object's value as 0. 2156 " 2157 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.8" 2158 ::= { docsIetfQosParamSetEntry 15 } 2160 docsIetfQosParamSetGrantsPerInterval OBJECT-TYPE 2161 SYNTAX Integer32 (0..127) 2162 MAX-ACCESS read-only 2163 STATUS current 2164 DESCRIPTION "Specifies the number of data grants per Nominal 2165 Grant Interval 2166 (docsIetfQosParamSetNomGrantInterval). 2168 The referenced parameter is applicable only 2169 for upstream flows with a DocsIetfQosSchedulingType 2170 of unsolicitedGrantServicewithAD(5) or 2171 unsolicitedGrantService(6), and is mandatory 2172 when applicable. Both CMTS and CM report the 2173 signaled value of the parameter in this case. 2175 If the referenced parameter is not applicable to 2177 IPCDN DOCSIS QoS MIB February 2005 2179 the direction or scheduling type of the 2180 corresponding DOCSIS QOS Parameter Set, both 2181 CMTS and CM report this object's value as 0. 2182 " 2184 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.9" 2185 ::= { docsIetfQosParamSetEntry 16 } 2187 docsIetfQosParamSetTosAndMask OBJECT-TYPE 2188 SYNTAX OCTET STRING (SIZE(1)) 2189 MAX-ACCESS read-only 2190 STATUS current 2191 DESCRIPTION "Specifies the AND mask for IP TOS byte for 2192 overwriting IP packets TOS value. The IP packets 2193 TOS byte is bitwise ANDed with 2194 docsIetfQosParamSetTosAndMask and result is 2195 bitwise ORed with docsIetfQosParamSetTosORMask and 2196 result is written to IP packet TOS byte. 2197 A value of 'FF'H for docsIetfQosParamSetTosAndMask 2198 and a value of '00'H for 2199 docsIetfQosParamSetTosOrMask means that IP Packet 2200 TOS byte is not overwritten. 2202 This combination is reported if the referenced 2203 parameter is not present in a QOS Parameter Set. 2205 The IP TOS octet as originally defined in RFC 791 2206 has been superseded by the 6 bit Differentiated 2207 Services Field (DSField, RFC 3260) and the 2 bit 2208 Explicit Congestion Notification Field (ECN field, 2209 RFC 3168). Network operators SHOULD avoid specifying 2210 values of docsIetfQosParamSetTosAndMask and 2211 docsIetfQosParamSetTosORMask which would result in 2212 the modification of the ECN bits. 2214 In particular, operators should not use values of 2215 docsIetfQosParamSetTosAndMask which have either of 2216 the least-significant two bits set to 0. Similarly, 2217 operators should not use values of 2218 docsIetfQosParamSetTosORMask which have either of 2219 the least-significant two bits set to 1. 2221 Even though this object is only enforced by the 2222 Cable Modem Termination System (CMTS), 2223 Cable Modems MUST report the value as signaled in 2224 the referenced parameter." 2225 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10; 2226 RFC 3168, The Addition of Explicit Congestion 2227 Notification (ECN) to IP; 2228 RFC 3260, New Terminology and Clarifications for 2229 Diffserv." 2231 IPCDN DOCSIS QoS MIB February 2005 2233 ::= { docsIetfQosParamSetEntry 17 } 2235 docsIetfQosParamSetTosOrMask OBJECT-TYPE 2236 SYNTAX OCTET STRING (SIZE(1)) 2237 MAX-ACCESS read-only 2238 STATUS current 2239 DESCRIPTION "Specifies the OR mask for IP TOS byte. 2241 See the description of docsIetfQosParamSetTosAndMask 2242 for further details. 2244 The IP TOS octet as originally defined in RFC 791 2245 has been superseded by the 6 bit Differentiated 2246 Services Field (DSField, RFC 3260) and the 2 bit 2247 Explicit Congestion Notification Field (ECN field, 2248 RFC 3168). Network operators SHOULD avoid specifying 2249 values of docsIetfQosParamSetTosAndMask and 2250 docsIetfQosParamSetTosORMask which would result in 2251 the modification of the ECN bits." 2252 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10; 2253 RFC 3168, The Addition of Explicit Congestion 2254 Notification (ECN) to IP; 2255 RFC 3260, New Terminology and Clarifications for 2256 Diffserv." 2257 ::= { docsIetfQosParamSetEntry 18 } 2259 docsIetfQosParamSetMaxLatency OBJECT-TYPE 2260 SYNTAX Unsigned32 2261 UNITS "microseconds" 2262 MAX-ACCESS read-only 2263 STATUS current 2264 DESCRIPTION "Specifies the maximum latency between the 2265 reception of a packet by the CMTS on its NSI 2266 and the forwarding of the packet to the RF 2267 interface. A value of 0 signifies no maximum 2268 latency enforced. This object only applies to 2269 downstream Service Flows. 2271 If the referenced parameter is not present in the 2272 corresponding downstream DOCSIS QOS Parameter Set, 2273 the default value is 0. This parameter is 2274 not applicable to upstream DOCSIS QOS Parameter 2275 Sets, and its value is reported as 0 in this case." 2276 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.7.1" 2277 ::= { docsIetfQosParamSetEntry 19 } 2279 docsIetfQosParamSetType OBJECT-TYPE 2280 SYNTAX INTEGER { 2281 active (1), 2282 admitted (2), 2284 IPCDN DOCSIS QoS MIB February 2005 2286 provisioned (3) 2287 } 2288 MAX-ACCESS not-accessible 2289 STATUS current 2290 DESCRIPTION "Defines the type of the QOS parameter set defined 2291 by this row. active(1) indicates the Active QOS 2292 parameter set, describing the service currently 2293 being provided by the DOCSIS MAC domain to the 2294 Service Flow. admitted(2) indicates the Admitted 2295 QOS Parameter Set, describing services reserved by 2296 the DOCSIS MAC domain for use by the service 2297 flow. provisioned (3) describes the QOS Parameter 2298 Set defined in the DOCSIS CM Configuration file for 2299 the Service Flow." 2300 REFERENCE "SP-RFIv2.0-I06-040804, 8.1.5" 2301 ::= { docsIetfQosParamSetEntry 20 } 2303 docsIetfQosParamSetRequestPolicyOct OBJECT-TYPE 2304 SYNTAX OCTET STRING (SIZE(4)) 2305 -- A 32-bit mask represented most significant byte 2306 -- first. The 32 bit integer represented in this 2307 -- manner equals the binary value of the referenced 2308 -- integer parameter of the DOCSIS RFI 2309 -- specification. 2310 -- The BITS syntax is not used in order to avoid 2311 -- the confusion caused by different bit numbering 2312 -- conventions. 2313 MAX-ACCESS read-only 2314 STATUS current 2315 DESCRIPTION "Specifies which transmit interval opportunities 2316 the CM omits for upstream transmission requests and 2317 packet transmissions. This object takes its 2318 default value for downstream Service Flows. 2320 Unless otherwise indicated, a bit value of 1 means 2321 that a CM must *not* use that opportunity for 2322 upstream transmission. 2324 Calling bit 0 the least significant bit of the 2325 least significant (4th) octet, and increasing 2326 bit number with significance, the bit definitions 2327 are as defined below: 2329 broadcastReqOpp(0): 2330 all CMs broadcast request opportunities 2332 priorityReqMulticastReq(1): 2333 priority request multicast request 2334 opportunities 2336 reqDataForReq(2): 2338 IPCDN DOCSIS QoS MIB February 2005 2340 request/data opportunities for requests 2342 reqDataForData(3): 2343 request/data opportunities for data 2345 piggybackReqWithData(4): 2346 piggyback requests with data 2348 concatenateData(5): 2349 concatenate data 2351 fragmentData(6): 2352 fragment data 2354 suppresspayloadheaders(7): 2355 suppress payload headers 2357 dropPktsExceedUGSize(8): 2358 A value of 1 mean that Service Flow must drop 2359 packet that do not fit in the Unsolicited 2360 Grant size 2362 If the referenced parameter is not present in 2363 a QOS Parameter Set, the value of this object is 2364 reported as '00000000'H. 2365 " 2366 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.3" 2367 ::= { docsIetfQosParamSetEntry 21 } 2369 docsIetfQosParamSetBitMap OBJECT-TYPE 2370 -- Each bit corresponds to a parameter 2371 -- from SP-RFI-v1.1-I10-037030, 2372 -- Appendix C in the indicated 2373 SYNTAX BITS { -- section number. 2374 trafficPriority(0), -- C.2.2.5.1 2375 maxTrafficRate(1), -- C.2.2.5.2 2376 maxTrafficBurst(2), -- C.2.2.5.3 2377 minReservedRate(3), -- C.2.2.5.4 2378 minReservedPkt(4), -- C.2.2.5.5 2379 activeTimeout(5), -- C.2.2.5.6 2380 admittedTimeout(6), -- C.2.2.5.7 2381 maxConcatBurst(7), -- C.2.2.6.1 2382 schedulingType(8), -- C.2.2.6.2 2383 requestPolicy(9), -- C.2.2.6.3 2384 nomPollInterval(10), -- C.2.2.6.4 2385 tolPollJitter(11), -- C.2.2.6.5 2386 unsolicitGrantSize(12), -- C.2.2.6.6 2387 nomGrantInterval(13), -- C.2.2.6.7 2388 tolGrantJitter(14), -- C.2.2.6.8 2389 grantsPerInterval(15), -- C.2.2.6.9 2390 tosOverwrite(16), -- C.2.2.6.10 2392 IPCDN DOCSIS QoS MIB February 2005 2394 maxLatency(17) -- C.2.2.7.1 2395 } 2396 MAX-ACCESS read-only 2397 STATUS current 2398 DESCRIPTION "This object indicates the set of QOS Parameter 2399 Set parameters actually signaled in the 2400 DOCSIS registration or dynamic service request 2401 message that created or modified the QOS Parameter 2402 Set. A bit is set to 1 when the parameter described 2403 by the indicated reference section is present 2404 in the original request. 2406 Note that when Service Class names are expanded, 2407 the registration or dynamic response message may 2408 contain parameters as expanded by the CMTS based 2409 on a stored service class. These expanded 2410 parameters are *not* indicated by a 1 bit in this 2411 object. 2413 Note that even though some QOS Parameter Set 2414 parameters may not be signaled in a message 2415 (so that the paramater's bit in this object is 0) 2416 the DOCSIS specification calls for default 2417 values to be used. These default values are 2418 reported as the corresponding object's value in 2419 the row. 2421 Note that BITS objects are encoded most 2422 significant bit first. For example, if bits 2423 1 and 16 are set, the value of this object 2424 is the octet string '400080'H. 2426 " 2427 ::= { docsIetfQosParamSetEntry 22 } 2429 -- 2430 -- Service Flow Table 2431 -- 2432 docsIetfQosServiceFlowTable OBJECT-TYPE 2433 SYNTAX SEQUENCE OF DocsIetfQosServiceFlowEntry 2434 MAX-ACCESS not-accessible 2435 STATUS current 2436 DESCRIPTION "This table describes the set of DOCSIS-QOS 2437 Service Flows in a managed device. " 2438 ::= { docsIetfQosMIBObjects 3 } 2440 docsIetfQosServiceFlowEntry OBJECT-TYPE 2441 SYNTAX DocsIetfQosServiceFlowEntry 2442 MAX-ACCESS not-accessible 2443 STATUS current 2444 DESCRIPTION "Describes a Service Flow. 2446 IPCDN DOCSIS QoS MIB February 2005 2448 An entry in the table exists for each 2449 Service Flow ID. The ifIndex is an 2450 ifType of docsCableMaclayer(127)." 2451 INDEX { 2452 ifIndex, 2453 docsIetfQosServiceFlowId 2454 } 2455 ::= { docsIetfQosServiceFlowTable 1 } 2457 DocsIetfQosServiceFlowEntry ::= SEQUENCE { 2458 docsIetfQosServiceFlowId Unsigned32, 2459 docsIetfQosServiceFlowSID Unsigned32, 2460 docsIetfQosServiceFlowDirection DocsIetfQosRfMacIfDirection, 2461 docsIetfQosServiceFlowPrimary TruthValue 2462 } 2463 docsIetfQosServiceFlowId OBJECT-TYPE 2464 SYNTAX Unsigned32 (1..4294967295) 2465 MAX-ACCESS not-accessible 2466 STATUS current 2467 DESCRIPTION "An index assigned to a Service Flow by CMTS." 2468 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.2" 2469 ::= { docsIetfQosServiceFlowEntry 1 } 2471 docsIetfQosServiceFlowSID OBJECT-TYPE 2472 SYNTAX Unsigned32 (0..16383) 2473 MAX-ACCESS read-only 2474 STATUS current 2475 DESCRIPTION "Service Identifier (SID) assigned to an 2476 admitted or active Service Flow. This object 2477 reports a value of 0 if a Service Id is not 2478 associated with the Service Flow. Only active 2479 or admitted upstream Service Flows will have a 2480 Service Id (SID)." 2481 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.3" 2482 ::= { docsIetfQosServiceFlowEntry 2 } 2484 docsIetfQosServiceFlowDirection OBJECT-TYPE 2485 SYNTAX DocsIetfQosRfMacIfDirection 2486 MAX-ACCESS read-only 2487 STATUS current 2488 DESCRIPTION "The direction of the Service Flow." 2489 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.1/2" 2490 ::= { docsIetfQosServiceFlowEntry 3 } 2492 docsIetfQosServiceFlowPrimary OBJECT-TYPE 2493 SYNTAX TruthValue 2494 MAX-ACCESS read-only 2495 STATUS current 2496 DESCRIPTION "Object reflects whether Service Flow is the primary 2497 or a secondary Service Flow. 2499 IPCDN DOCSIS QoS MIB February 2005 2501 A primary Service Flow is the default Service Flow 2502 for otherwise unclassified traffic and all MAC 2503 messages." 2504 REFERENCE "SP-RFIv2.0-I06-040804, Section 8.1 " 2505 ::= { docsIetfQosServiceFlowEntry 4 } 2507 -- 2508 -- Service Flow Stats Table 2509 -- 2510 docsIetfQosServiceFlowStatsTable OBJECT-TYPE 2511 SYNTAX SEQUENCE OF DocsIetfQosServiceFlowStatsEntry 2512 MAX-ACCESS not-accessible 2513 STATUS current 2514 DESCRIPTION "This table describes statistics associated with the 2515 Service Flows in a managed device. " 2516 ::= { docsIetfQosMIBObjects 4 } 2518 docsIetfQosServiceFlowStatsEntry OBJECT-TYPE 2519 SYNTAX DocsIetfQosServiceFlowStatsEntry 2520 MAX-ACCESS not-accessible 2521 STATUS current 2522 DESCRIPTION "Describes a set of Service Flow statistics. 2523 An entry in the table exists for each 2524 Service Flow ID. The ifIndex is an 2525 ifType of docsCableMaclayer(127)." 2526 INDEX { 2527 ifIndex, 2528 docsIetfQosServiceFlowId 2529 } 2530 ::= { docsIetfQosServiceFlowStatsTable 1 } 2532 DocsIetfQosServiceFlowStatsEntry ::= SEQUENCE { 2533 docsIetfQosServiceFlowPkts Counter64, 2534 docsIetfQosServiceFlowOctets Counter64, 2535 docsIetfQosServiceFlowTimeCreated TimeStamp, 2536 docsIetfQosServiceFlowTimeActive Counter32, 2537 docsIetfQosServiceFlowPHSUnknowns Counter32, 2538 docsIetfQosServiceFlowPolicedDropPkts Counter32, 2539 docsIetfQosServiceFlowPolicedDelayPkts Counter32 2540 } 2542 docsIetfQosServiceFlowPkts OBJECT-TYPE 2543 SYNTAX Counter64 2544 MAX-ACCESS read-only 2545 STATUS current 2546 DESCRIPTION "For outgoing Service Flows, this object counts the 2547 number of Packet Data PDUs forwarded to this 2548 Service Flow. For CMTS incoming upstream service 2549 flows, this object counts the number of Packets 2550 Data PDUs actually received on the Service Flow 2551 identified by the SID for which the packet was 2553 IPCDN DOCSIS QoS MIB February 2005 2555 scheduled. CMs not classifying downstream packets 2556 may report this object's value as 0 for downstream 2557 Service Flows. This object does not count 2558 MAC-specific management messages. 2560 Particularly for UGS flows, packets sent on the 2561 primary Service Flow in violation of the UGS grant 2562 size should be counted only by the instance of this 2563 object that is associated with the primary service 2564 flow. 2566 Unclassified upstream user data packets (i.e. non 2567 MAC-management) forwarded to the primary upstream 2568 Service Flow should be counted by the instance of 2569 this object that is associated with the primary 2570 service flow. 2572 This object does include packets counted by 2573 docsIetfQosServiceFlowPolicedDelayPkts, but does not 2574 include packets counted by 2575 docsIetfQosServiceFlowPolicedDropPkts 2576 and docsIetfQosServiceFlowPHSUnknowns. 2578 This counter's last discontinuity is the 2579 ifCounterDiscontinuityTime for same ifIndex that 2580 indexes this object." 2581 ::= { docsIetfQosServiceFlowStatsEntry 1 } 2583 docsIetfQosServiceFlowOctets OBJECT-TYPE 2584 SYNTAX Counter64 2585 MAX-ACCESS read-only 2586 STATUS current 2587 DESCRIPTION "The number of octets from the byte after the MAC 2588 header HCS to the end of the CRC for all packets 2589 counted in the docsIetfQosServiceFlowPkts object for 2590 this row. Note that this counts the octets after 2591 payload header suppression and before payload 2592 header expansion has been applied. 2594 This counter's last discontinuity is the 2595 ifCounterDiscontinuityTime for same ifIndex that 2596 indexes this object." 2597 ::= { docsIetfQosServiceFlowStatsEntry 2 } 2599 docsIetfQosServiceFlowTimeCreated OBJECT-TYPE 2600 SYNTAX TimeStamp 2601 MAX-ACCESS read-only 2602 STATUS current 2603 DESCRIPTION "The value of sysUpTime when the service flow 2604 was created." 2605 ::= { docsIetfQosServiceFlowStatsEntry 3 } 2607 IPCDN DOCSIS QoS MIB February 2005 2609 docsIetfQosServiceFlowTimeActive OBJECT-TYPE 2610 SYNTAX Counter32 2611 UNITS "seconds" 2612 MAX-ACCESS read-only 2613 STATUS current 2614 DESCRIPTION "The number of seconds that the service flow 2615 has been active. 2617 This counter's last discontinuity is the 2618 ifCounterDiscontinuityTime for same ifIndex that 2619 indexes this object." 2620 ::= { docsIetfQosServiceFlowStatsEntry 4 } 2622 docsIetfQosServiceFlowPHSUnknowns OBJECT-TYPE 2623 SYNTAX Counter32 2624 MAX-ACCESS read-only 2625 STATUS current 2626 DESCRIPTION "For CMTS incoming upstream service flows, this 2627 object counts the number of packets received 2628 with an unknown payload header suppression index. 2629 The service flow is identified by the SID for which 2630 the packet was scheduled. 2632 On a CM, only this object's instance for the primary 2633 downstream service flow count packets received with 2634 an unknown payload header suppression index. All 2635 other downstream service flows on CM report this 2636 objects value as 0. 2638 All outgoing service flows report this object's 2639 value as 0. 2641 This counter's last discontinuity is the 2642 ifCounterDiscontinuityTime for same ifIndex that 2643 indexes this object." 2644 ::= { docsIetfQosServiceFlowStatsEntry 5 } 2646 docsIetfQosServiceFlowPolicedDropPkts OBJECT-TYPE 2647 SYNTAX Counter32 2648 MAX-ACCESS read-only 2649 STATUS current 2650 DESCRIPTION "For outgoing service flows, this object counts the 2651 number of Packet Data PDUs classified to this 2652 service flow dropped due to: 2653 (1) implementation-dependent excessive delay 2654 while enforcing the Maximum Sustained 2655 Traffic Rate; or 2656 (2) UGS packets dropped due to exceeding the 2657 Unsolicited Grant Size with a 2658 Request/Transmission policy that requires 2659 such packets to be dropped. 2661 IPCDN DOCSIS QoS MIB February 2005 2663 Classified packets dropped due to other reasons 2664 must be counted in ifOutDiscards for interface of 2665 this service flow. This object reports 0 for 2666 incoming service flows. 2668 This counter's last discontinuity is the 2669 ifCounterDiscontinuityTime for same ifIndex that 2670 indexes this object." 2671 ::= { docsIetfQosServiceFlowStatsEntry 6 } 2673 docsIetfQosServiceFlowPolicedDelayPkts OBJECT-TYPE 2674 SYNTAX Counter32 2675 MAX-ACCESS read-only 2676 STATUS current 2677 DESCRIPTION "This object counts only outgoing packets delayed in 2678 order to maintain the Maximum Sustained Traffic 2679 Rate. This object will always report a value of 0 2680 for UGS flows because the Maximum Sustained Traffic 2681 Rate does not apply. This object is 0 for incoming 2682 service flows. 2684 This counter's last discontinuity is the 2685 ifCounterDiscontinuityTime for same ifIndex that 2686 indexes this object." 2687 ::= { docsIetfQosServiceFlowStatsEntry 7 } 2689 -- 2690 -- Upstream Service Flow Stats Table (CMTS ONLY) 2691 -- 2692 docsIetfQosUpstreamStatsTable OBJECT-TYPE 2693 SYNTAX SEQUENCE OF DocsIetfQosUpstreamStatsEntry 2694 MAX-ACCESS not-accessible 2695 STATUS current 2696 DESCRIPTION "This table describes statistics associated with 2697 upstream service flows. All counted frames must 2698 be received without an Frame Check Squence (FCS) 2699 error." 2700 ::= { docsIetfQosMIBObjects 5 } 2702 docsIetfQosUpstreamStatsEntry OBJECT-TYPE 2703 SYNTAX DocsIetfQosUpstreamStatsEntry 2704 MAX-ACCESS not-accessible 2705 STATUS current 2706 DESCRIPTION "Describes a set of upstream service flow 2707 statistics. An entry in the table exists for each 2708 upstream Service Flow in a managed device. 2709 The ifIndex is an ifType of 2710 docsCableMaclayer(127)." 2711 INDEX { 2712 ifIndex, 2714 IPCDN DOCSIS QoS MIB February 2005 2716 docsIetfQosSID 2717 } 2718 ::= { docsIetfQosUpstreamStatsTable 1 } 2720 DocsIetfQosUpstreamStatsEntry ::= SEQUENCE { 2721 docsIetfQosSID Unsigned32, 2722 docsIetfQosUpstreamFragments Counter32, 2723 docsIetfQosUpstreamFragDiscards Counter32, 2724 docsIetfQosUpstreamConcatBursts Counter32 2725 } 2727 docsIetfQosSID OBJECT-TYPE 2728 SYNTAX Unsigned32 (1..16383) 2729 MAX-ACCESS not-accessible 2730 STATUS current 2731 DESCRIPTION "Identifies a service id for an admitted or active 2732 upstream service flow." 2733 ::= { docsIetfQosUpstreamStatsEntry 1 } 2735 docsIetfQosUpstreamFragments OBJECT-TYPE 2736 SYNTAX Counter32 2737 MAX-ACCESS read-only 2738 STATUS current 2739 DESCRIPTION "The number of fragmentation headers received on an 2740 upstream service flow, regardless of whether 2741 the fragment was correctly reassembled into a 2742 valid packet. 2744 This counter's last discontinuity is the 2745 ifCounterDiscontinuityTime for same ifIndex that 2746 indexes this object." 2747 ::= { docsIetfQosUpstreamStatsEntry 2 } 2749 docsIetfQosUpstreamFragDiscards OBJECT-TYPE 2750 SYNTAX Counter32 2751 MAX-ACCESS read-only 2752 STATUS current 2753 DESCRIPTION "The number of upstream fragments discarded and not 2754 assembled into a valid upstream packet. 2756 This counter's last discontinuity is the 2757 ifCounterDiscontinuityTime for same ifIndex that 2758 indexes this object." 2759 ::= { docsIetfQosUpstreamStatsEntry 3 } 2761 docsIetfQosUpstreamConcatBursts OBJECT-TYPE 2762 SYNTAX Counter32 2763 MAX-ACCESS read-only 2764 STATUS current 2765 DESCRIPTION "The number of concatenation headers received on an 2766 upstream service flow. 2768 IPCDN DOCSIS QoS MIB February 2005 2770 This counter's last discontinuity is the 2771 ifCounterDiscontinuityTime for same ifIndex that 2772 indexes this object." 2773 ::= { docsIetfQosUpstreamStatsEntry 4 } 2775 -- 2776 -- Dynamic Service Stats Table 2777 -- 2778 docsIetfQosDynamicServiceStatsTable OBJECT-TYPE 2779 SYNTAX SEQUENCE OF DocsIetfQosDynamicServiceStatsEntry 2780 MAX-ACCESS not-accessible 2781 STATUS current 2782 DESCRIPTION "This table describes statistics associated with the 2783 Dynamic Service Flows in a managed device. " 2784 ::= { docsIetfQosMIBObjects 6 } 2786 docsIetfQosDynamicServiceStatsEntry OBJECT-TYPE 2787 SYNTAX DocsIetfQosDynamicServiceStatsEntry 2788 MAX-ACCESS not-accessible 2789 STATUS current 2790 DESCRIPTION "Describes a set of dynamic service flow statistics. 2791 Two entries exist for each DOCSIS mac layer 2792 interface for the upstream and downstream 2793 direction. On the CMTS, the downstream direction 2794 row indicates messages transmitted or transactions 2795 originated by the CMTS. The upstream direction row 2796 indicates messages received or transaction 2797 originated by the CM. On the CM, the downstream 2798 direction row indicates messages received or 2799 transactions originated by the CMTS. The upstream 2800 direction row indicates messages transmitted by 2801 the CM or transactions originated by the CM. 2802 The ifIndex is an ifType of 2803 docsCableMaclayer(127)." 2804 INDEX { 2805 ifIndex, 2806 docsIetfQosIfDirection 2807 } 2808 ::= { docsIetfQosDynamicServiceStatsTable 1 } 2810 DocsIetfQosDynamicServiceStatsEntry ::= SEQUENCE { 2811 docsIetfQosIfDirection DocsIetfQosRfMacIfDirection, 2812 docsIetfQosDSAReqs Counter32, 2813 docsIetfQosDSARsps Counter32, 2814 docsIetfQosDSAAcks Counter32, 2815 docsIetfQosDSCReqs Counter32, 2816 docsIetfQosDSCRsps Counter32, 2817 docsIetfQosDSCAcks Counter32, 2818 docsIetfQosDSDReqs Counter32, 2820 IPCDN DOCSIS QoS MIB February 2005 2822 docsIetfQosDSDRsps Counter32, 2823 docsIetfQosDynamicAdds Counter32, 2824 docsIetfQosDynamicAddFails Counter32, 2825 docsIetfQosDynamicChanges Counter32, 2826 docsIetfQosDynamicChangeFails Counter32, 2827 docsIetfQosDynamicDeletes Counter32, 2828 docsIetfQosDynamicDeleteFails Counter32, 2829 docsIetfQosDCCReqs Counter32, 2830 docsIetfQosDCCRsps Counter32, 2831 docsIetfQosDCCAcks Counter32, 2832 docsIetfQosDCCs Counter32, 2833 docsIetfQosDCCFails Counter32 2834 } 2836 docsIetfQosIfDirection OBJECT-TYPE 2837 SYNTAX DocsIetfQosRfMacIfDirection 2838 MAX-ACCESS not-accessible 2839 STATUS current 2840 DESCRIPTION "The direction of interface." 2841 ::= { docsIetfQosDynamicServiceStatsEntry 1 } 2843 docsIetfQosDSAReqs OBJECT-TYPE 2844 SYNTAX Counter32 2845 MAX-ACCESS read-only 2846 STATUS current 2847 DESCRIPTION "The number of Dynamic Service Addition Requests, 2848 including retries. 2850 This counter's last discontinuity is the 2851 ifCounterDiscontinuityTime for same ifIndex that 2852 indexes this object." 2853 ::= { docsIetfQosDynamicServiceStatsEntry 2 } 2855 docsIetfQosDSARsps OBJECT-TYPE 2856 SYNTAX Counter32 2857 MAX-ACCESS read-only 2858 STATUS current 2859 DESCRIPTION "The number of Dynamic Service Addition Responses, 2860 including retries. 2862 This counter's last discontinuity is the 2863 ifCounterDiscontinuityTime for same ifIndex that 2864 indexes this object." 2865 ::= { docsIetfQosDynamicServiceStatsEntry 3 } 2867 docsIetfQosDSAAcks OBJECT-TYPE 2868 SYNTAX Counter32 2869 MAX-ACCESS read-only 2870 STATUS current 2871 DESCRIPTION "The number of Dynamic Service Addition 2872 Acknowledgements, including retries. 2874 IPCDN DOCSIS QoS MIB February 2005 2876 This counter's last discontinuity is the 2877 ifCounterDiscontinuityTime for same ifIndex that 2878 indexes this object." 2879 ::= { docsIetfQosDynamicServiceStatsEntry 4 } 2881 docsIetfQosDSCReqs OBJECT-TYPE 2882 SYNTAX Counter32 2883 MAX-ACCESS read-only 2884 STATUS current 2885 DESCRIPTION "The number of Dynamic Service Change Requests, 2886 including retries. 2888 This counter's last discontinuity is the 2889 ifCounterDiscontinuityTime for same ifIndex that 2890 indexes this object." 2891 ::= { docsIetfQosDynamicServiceStatsEntry 5 } 2893 docsIetfQosDSCRsps OBJECT-TYPE 2894 SYNTAX Counter32 2895 MAX-ACCESS read-only 2896 STATUS current 2897 DESCRIPTION "The number of Dynamic Service Change Responses, 2898 including retries. 2900 This counter's last discontinuity is the 2901 ifCounterDiscontinuityTime for same ifIndex that 2902 indexes this object." 2903 ::= { docsIetfQosDynamicServiceStatsEntry 6 } 2905 docsIetfQosDSCAcks OBJECT-TYPE 2906 SYNTAX Counter32 2907 MAX-ACCESS read-only 2908 STATUS current 2909 DESCRIPTION "The number of Dynamic Service Change 2910 Acknowledgements, including retries. 2912 This counter's last discontinuity is the 2913 ifCounterDiscontinuityTime for same ifIndex that 2914 indexes this object." 2915 ::= { docsIetfQosDynamicServiceStatsEntry 7 } 2917 docsIetfQosDSDReqs OBJECT-TYPE 2918 SYNTAX Counter32 2919 MAX-ACCESS read-only 2920 STATUS current 2921 DESCRIPTION "The number of Dynamic Service Delete Requests, 2922 including retries. 2924 This counter's last discontinuity is the 2925 ifCounterDiscontinuityTime for same ifIndex that 2926 indexes this object." 2928 IPCDN DOCSIS QoS MIB February 2005 2930 ::= { docsIetfQosDynamicServiceStatsEntry 8 } 2932 docsIetfQosDSDRsps OBJECT-TYPE 2933 SYNTAX Counter32 2934 MAX-ACCESS read-only 2935 STATUS current 2936 DESCRIPTION "The number of Dynamic Service Delete Responses, 2937 including retries. 2939 This counter's last discontinuity is the 2940 ifCounterDiscontinuityTime for same ifIndex that 2941 indexes this object." 2942 ::= { docsIetfQosDynamicServiceStatsEntry 9 } 2944 docsIetfQosDynamicAdds OBJECT-TYPE 2945 SYNTAX Counter32 2946 MAX-ACCESS read-only 2947 STATUS current 2948 DESCRIPTION "The number of successful Dynamic Service Addition 2949 transactions. 2951 This counter's last discontinuity is the 2952 ifCounterDiscontinuityTime for same ifIndex that 2953 indexes this object." 2954 ::= { docsIetfQosDynamicServiceStatsEntry 10 } 2956 docsIetfQosDynamicAddFails OBJECT-TYPE 2957 SYNTAX Counter32 2958 MAX-ACCESS read-only 2959 STATUS current 2960 DESCRIPTION "The number of failed Dynamic Service Addition 2961 transactions. 2963 This counter's last discontinuity is the 2964 ifCounterDiscontinuityTime for same ifIndex that 2965 indexes this object." 2966 ::= { docsIetfQosDynamicServiceStatsEntry 11 } 2968 docsIetfQosDynamicChanges OBJECT-TYPE 2969 SYNTAX Counter32 2970 MAX-ACCESS read-only 2971 STATUS current 2972 DESCRIPTION "The number of successful Dynamic Service Change 2973 transactions. 2975 This counter's last discontinuity is the 2976 ifCounterDiscontinuityTime for same ifIndex that 2977 indexes this object." 2978 ::= { docsIetfQosDynamicServiceStatsEntry 12 } 2980 docsIetfQosDynamicChangeFails OBJECT-TYPE 2981 IPCDN DOCSIS QoS MIB February 2005 2983 SYNTAX Counter32 2984 MAX-ACCESS read-only 2985 STATUS current 2986 DESCRIPTION "The number of failed Dynamic Service Change 2987 transactions. 2989 This counter's last discontinuity is the 2990 ifCounterDiscontinuityTime for same ifIndex that 2991 indexes this object." 2992 ::= { docsIetfQosDynamicServiceStatsEntry 13 } 2994 docsIetfQosDynamicDeletes OBJECT-TYPE 2995 SYNTAX Counter32 2996 MAX-ACCESS read-only 2997 STATUS current 2998 DESCRIPTION "The number of successful Dynamic Service Delete 2999 transactions. 3001 This counter's last discontinuity is the 3002 ifCounterDiscontinuityTime for same ifIndex that 3003 indexes this object." 3004 ::= { docsIetfQosDynamicServiceStatsEntry 14 } 3006 docsIetfQosDynamicDeleteFails OBJECT-TYPE 3007 SYNTAX Counter32 3008 MAX-ACCESS read-only 3009 STATUS current 3010 DESCRIPTION "The number of failed Dynamic Service Delete 3011 transactions. 3013 This counter's last discontinuity is the 3014 ifCounterDiscontinuityTime for same ifIndex that 3015 indexes this object." 3016 ::= { docsIetfQosDynamicServiceStatsEntry 15 } 3018 docsIetfQosDCCReqs OBJECT-TYPE 3019 SYNTAX Counter32 3020 MAX-ACCESS read-only 3021 STATUS current 3022 DESCRIPTION "The number of Dynamic Channel Change Request 3023 messages traversing an interface. This count 3024 is nonzero only on downstream direction rows. 3025 This count should include number of retries. 3027 This counter's last discontinuity is the 3028 ifCounterDiscontinuityTime for same ifIndex 3029 that indexes this object." 3030 ::= { docsIetfQosDynamicServiceStatsEntry 16 } 3032 docsIetfQosDCCRsps OBJECT-TYPE 3033 IPCDN DOCSIS QoS MIB February 2005 3035 SYNTAX Counter32 3036 MAX-ACCESS read-only 3037 STATUS current 3038 DESCRIPTION "The number of Dynamic Channel Change Response 3039 messages traversing an interface. This count is 3040 nonzero only on upstream direction rows. This count 3041 should include number of retries. 3043 This counter's last discontinuity is the 3044 ifCounterDiscontinuityTime for same ifIndex that 3045 indexes this object." 3046 ::= { docsIetfQosDynamicServiceStatsEntry 17 } 3048 docsIetfQosDCCAcks OBJECT-TYPE 3049 SYNTAX Counter32 3050 MAX-ACCESS read-only 3051 STATUS current 3052 DESCRIPTION "The number of Dynamic Channel Change Acknowledgement 3053 messages traversing an interface. This count 3054 is nonzero only on downstream direction rows. 3055 This count should include number of retries. 3057 This counter's last discontinuity is the 3058 ifCounterDiscontinuityTime for same ifIndex that 3059 indexes this object." 3060 ::= { docsIetfQosDynamicServiceStatsEntry 18 } 3062 docsIetfQosDCCs OBJECT-TYPE 3063 SYNTAX Counter32 3064 MAX-ACCESS read-only 3065 STATUS current 3066 DESCRIPTION "The number of successful Dynamic Channel Change 3067 transactions. This count is nonzero only on 3068 downstream direction rows. 3070 This counter's last discontinuity is the 3071 ifCounterDiscontinuityTime for same ifIndex that 3072 indexes this object." 3073 ::= { docsIetfQosDynamicServiceStatsEntry 19 } 3075 docsIetfQosDCCFails OBJECT-TYPE 3076 SYNTAX Counter32 3077 MAX-ACCESS read-only 3078 STATUS current 3079 DESCRIPTION "The number of failed Dynamic Channel Change 3080 transactions. This count is nonzero only on 3081 downstream direction rows. 3083 This counter's last discontinuity is the 3084 ifCounterDiscontinuityTime for same ifIndex that 3085 indexes this object." 3087 IPCDN DOCSIS QoS MIB February 2005 3089 ::= { docsIetfQosDynamicServiceStatsEntry 20 } 3091 -- 3092 -- Service Flow Log Table (CMTS ONLY) 3093 -- 3094 docsIetfQosServiceFlowLogTable OBJECT-TYPE 3095 SYNTAX SEQUENCE OF DocsIetfQosServiceFlowLogEntry 3096 MAX-ACCESS not-accessible 3097 STATUS current 3098 DESCRIPTION "This table contains a log of the disconnected 3099 Service Flows in a managed device." 3100 ::= { docsIetfQosMIBObjects 7 } 3102 docsIetfQosServiceFlowLogEntry OBJECT-TYPE 3103 SYNTAX DocsIetfQosServiceFlowLogEntry 3104 MAX-ACCESS not-accessible 3105 STATUS current 3106 DESCRIPTION "The information regarding a single disconnected 3107 service flow." 3108 INDEX { 3109 docsIetfQosServiceFlowLogIndex 3110 } 3111 ::= { docsIetfQosServiceFlowLogTable 1 } 3113 DocsIetfQosServiceFlowLogEntry ::= SEQUENCE { 3114 docsIetfQosServiceFlowLogIndex Unsigned32, 3115 docsIetfQosServiceFlowLogIfIndex InterfaceIndex, 3116 docsIetfQosServiceFlowLogSFID Unsigned32, 3117 docsIetfQosServiceFlowLogCmMac MacAddress, 3118 docsIetfQosServiceFlowLogPkts Counter64, 3119 docsIetfQosServiceFlowLogOctets Counter64, 3120 docsIetfQosServiceFlowLogTimeDeleted TimeStamp, 3121 docsIetfQosServiceFlowLogTimeCreated TimeStamp, 3122 docsIetfQosServiceFlowLogTimeActive Counter32, 3123 docsIetfQosServiceFlowLogDirection DocsIetfQosRfMacIfDirection, 3124 docsIetfQosServiceFlowLogPrimary TruthValue, 3125 docsIetfQosServiceFlowLogServiceClassName SnmpAdminString, 3126 docsIetfQosServiceFlowLogPolicedDropPkts Counter32, 3127 docsIetfQosServiceFlowLogPolicedDelayPkts Counter32, 3128 docsIetfQosServiceFlowLogControl INTEGER 3129 } 3131 docsIetfQosServiceFlowLogIndex OBJECT-TYPE 3132 SYNTAX Unsigned32 (1..4294967295) 3133 MAX-ACCESS not-accessible 3134 STATUS current 3135 DESCRIPTION "Unique index for a logged service flow." 3136 ::= { docsIetfQosServiceFlowLogEntry 1 } 3138 docsIetfQosServiceFlowLogIfIndex OBJECT-TYPE 3139 IPCDN DOCSIS QoS MIB February 2005 3141 SYNTAX InterfaceIndex 3142 MAX-ACCESS read-only 3143 STATUS current 3144 DESCRIPTION "The ifIndex of ifType docsCableMaclayer(127) 3145 on the CMTS where the service flow was present." 3146 ::= { docsIetfQosServiceFlowLogEntry 2 } 3148 docsIetfQosServiceFlowLogSFID OBJECT-TYPE 3149 SYNTAX Unsigned32 (1..4294967295) 3150 MAX-ACCESS read-only 3151 STATUS current 3152 DESCRIPTION "The index assigned to the service flow by the CMTS." 3153 ::= { docsIetfQosServiceFlowLogEntry 3 } 3155 docsIetfQosServiceFlowLogCmMac OBJECT-TYPE 3156 SYNTAX MacAddress 3157 MAX-ACCESS read-only 3158 STATUS current 3159 DESCRIPTION "The MAC address for the cable modem associated with 3160 the service flow." 3161 ::= { docsIetfQosServiceFlowLogEntry 4 } 3163 docsIetfQosServiceFlowLogPkts OBJECT-TYPE 3164 SYNTAX Counter64 3165 MAX-ACCESS read-only 3166 STATUS current 3167 DESCRIPTION "The number of packets counted on this service flow 3168 after payload header suppression." 3169 ::= { docsIetfQosServiceFlowLogEntry 5 } 3171 docsIetfQosServiceFlowLogOctets OBJECT-TYPE 3172 SYNTAX Counter64 3173 MAX-ACCESS read-only 3174 STATUS current 3175 DESCRIPTION "The number of octets counted on this service flow 3176 after payload header suppression." 3177 ::= { docsIetfQosServiceFlowLogEntry 6 } 3179 docsIetfQosServiceFlowLogTimeDeleted OBJECT-TYPE 3180 SYNTAX TimeStamp 3181 MAX-ACCESS read-only 3182 STATUS current 3183 DESCRIPTION "The value of sysUpTime when the service flow 3184 was deleted." 3185 ::= { docsIetfQosServiceFlowLogEntry 7 } 3187 docsIetfQosServiceFlowLogTimeCreated OBJECT-TYPE 3188 SYNTAX TimeStamp 3189 MAX-ACCESS read-only 3190 STATUS current 3191 DESCRIPTION "The value of sysUpTime when the service flow 3193 IPCDN DOCSIS QoS MIB February 2005 3195 was created." 3196 ::= { docsIetfQosServiceFlowLogEntry 8 } 3198 docsIetfQosServiceFlowLogTimeActive OBJECT-TYPE 3199 SYNTAX Counter32 3200 UNITS "seconds" 3201 MAX-ACCESS read-only 3202 STATUS current 3203 DESCRIPTION "The total time that service flow was active." 3204 ::= { docsIetfQosServiceFlowLogEntry 9 } 3206 docsIetfQosServiceFlowLogDirection OBJECT-TYPE 3207 SYNTAX DocsIetfQosRfMacIfDirection 3208 MAX-ACCESS read-only 3209 STATUS current 3210 DESCRIPTION "The value of docsIetfQosServiceFlowDirection 3211 for the service flow." 3212 ::= { docsIetfQosServiceFlowLogEntry 10 } 3214 docsIetfQosServiceFlowLogPrimary OBJECT-TYPE 3215 SYNTAX TruthValue 3216 MAX-ACCESS read-only 3217 STATUS current 3218 DESCRIPTION "The value of docsIetfQosServiceFlowPrimary for the 3219 service flow." 3220 ::= { docsIetfQosServiceFlowLogEntry 11 } 3222 docsIetfQosServiceFlowLogServiceClassName OBJECT-TYPE 3223 SYNTAX SnmpAdminString 3224 MAX-ACCESS read-only 3225 STATUS current 3226 DESCRIPTION "The value of docsIetfQosParamSetServiceClassName for 3227 the provisioned QOS Parameter Set of the 3228 service flow." 3229 ::= { docsIetfQosServiceFlowLogEntry 12 } 3231 docsIetfQosServiceFlowLogPolicedDropPkts OBJECT-TYPE 3232 SYNTAX Counter32 3233 MAX-ACCESS read-only 3234 STATUS current 3235 DESCRIPTION "The final value of 3236 docsIetfQosServiceFlowPolicedDropPkts for the 3237 service flow." 3238 ::= { docsIetfQosServiceFlowLogEntry 13 } 3240 docsIetfQosServiceFlowLogPolicedDelayPkts OBJECT-TYPE 3241 SYNTAX Counter32 3242 MAX-ACCESS read-only 3243 STATUS current 3244 DESCRIPTION "The final value of 3245 docsIetfQosServiceFlowPolicedDelayPkts for the 3247 IPCDN DOCSIS QoS MIB February 2005 3249 service flow." 3250 ::= { docsIetfQosServiceFlowLogEntry 14 } 3252 docsIetfQosServiceFlowLogControl OBJECT-TYPE 3253 SYNTAX INTEGER { 3254 active(1), 3255 destroy(6) 3256 } 3258 MAX-ACCESS read-write 3259 STATUS current 3260 DESCRIPTION "Setting this object to the value destroy(6) removes 3261 this entry from the table. 3262 Reading this object return the value active(1)." 3263 ::= { docsIetfQosServiceFlowLogEntry 15 } 3265 -- 3266 -- Service Class Table (CMTS ONLY) 3267 -- 3268 docsIetfQosServiceClassTable OBJECT-TYPE 3269 SYNTAX SEQUENCE OF DocsIetfQosServiceClassEntry 3270 MAX-ACCESS not-accessible 3271 STATUS current 3272 DESCRIPTION "This table describes the set of DOCSIS-QOS 3273 Service Classes in a CMTS. " 3274 ::= { docsIetfQosMIBObjects 8 } 3276 docsIetfQosServiceClassEntry OBJECT-TYPE 3277 SYNTAX DocsIetfQosServiceClassEntry 3278 MAX-ACCESS not-accessible 3279 STATUS current 3280 DESCRIPTION "A provisioned service class on a CMTS. 3281 Each entry defines a template for certain 3282 DOCSIS QOS Parameter Set values. When a CM 3283 creates or modifies an Admitted QOS Parameter Set for a 3284 Service Flow, it may reference a Service Class 3285 Name instead of providing explicit QOS Parameter 3286 Set values. In this case, the CMTS populates 3287 the QOS Parameter Set with the applicable 3288 corresponding values from the named Service Class. 3289 Subsequent changes to a Service Class row do *not* 3290 affect the QOS Parameter Set values of any service flows 3291 already admitted. 3293 A service class template applies to only 3294 a single direction, as indicated in the 3295 docsIetfQosServiceClassDirection object. 3296 " 3297 INDEX { 3298 docsIetfQosServiceClassName 3299 } 3301 IPCDN DOCSIS QoS MIB February 2005 3303 ::= { docsIetfQosServiceClassTable 1 } 3305 DocsIetfQosServiceClassEntry ::= SEQUENCE { 3306 docsIetfQosServiceClassName SnmpAdminString, 3307 docsIetfQosServiceClassStatus RowStatus, 3308 docsIetfQosServiceClassPriority Integer32, 3309 docsIetfQosServiceClassMaxTrafficRate DocsIetfQosBitRate, 3310 docsIetfQosServiceClassMaxTrafficBurst Unsigned32, 3311 docsIetfQosServiceClassMinReservedRate DocsIetfQosBitRate, 3312 docsIetfQosServiceClassMinReservedPkt Integer32, 3313 docsIetfQosServiceClassMaxConcatBurst Integer32, 3314 docsIetfQosServiceClassNomPollInterval Unsigned32, 3315 docsIetfQosServiceClassTolPollJitter Unsigned32, 3316 docsIetfQosServiceClassUnsolicitGrantSize Integer32, 3317 docsIetfQosServiceClassNomGrantInterval Unsigned32, 3318 docsIetfQosServiceClassTolGrantJitter Unsigned32, 3319 docsIetfQosServiceClassGrantsPerInterval Integer32, 3320 docsIetfQosServiceClassMaxLatency Unsigned32, 3321 docsIetfQosServiceClassActiveTimeout Integer32, 3322 docsIetfQosServiceClassAdmittedTimeout Integer32, 3323 docsIetfQosServiceClassSchedulingType DocsIetfQosSchedulingType, 3324 docsIetfQosServiceClassRequestPolicy OCTET STRING, 3325 docsIetfQosServiceClassTosAndMask OCTET STRING, 3326 docsIetfQosServiceClassTosOrMask OCTET STRING, 3327 docsIetfQosServiceClassDirection DocsIetfQosRfMacIfDirection, 3328 docsIetfQosServiceClassStorageType StorageType, 3329 docsIetfQosServiceClassDSCPOverwrite DscpOrAny 3330 } 3332 docsIetfQosServiceClassName OBJECT-TYPE 3333 SYNTAX SnmpAdminString (SIZE (1..15)) 3334 MAX-ACCESS not-accessible 3335 STATUS current 3336 DESCRIPTION "Service Class Name. DOCSIS specifies that the 3337 maximum size is 16 ASCII characters including 3338 a terminating zero. The terminating zero is not 3339 represented in this SnmpAdminString syntax object. 3340 " 3341 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.3.4" 3342 ::= { docsIetfQosServiceClassEntry 1 } 3344 docsIetfQosServiceClassStatus OBJECT-TYPE 3345 SYNTAX RowStatus 3346 MAX-ACCESS read-create 3347 STATUS current 3348 DESCRIPTION "Used to create or delete rows in this table. 3349 There is no restriction on the ability 3350 to change values in this row while the row is active. 3351 Inactive rows need not be timed out." 3352 ::= { docsIetfQosServiceClassEntry 2 } 3354 IPCDN DOCSIS QoS MIB February 2005 3356 docsIetfQosServiceClassPriority OBJECT-TYPE 3357 SYNTAX Integer32 (0..7) 3358 MAX-ACCESS read-create 3359 STATUS current 3360 DESCRIPTION "Template for docsIetfQosParamSetPriority." 3361 DEFVAL { 0 } 3362 ::= { docsIetfQosServiceClassEntry 3 } 3364 docsIetfQosServiceClassMaxTrafficRate OBJECT-TYPE 3365 SYNTAX DocsIetfQosBitRate 3366 MAX-ACCESS read-create 3367 STATUS current 3368 DESCRIPTION "Template for docsIetfQosParamSetMaxTrafficRate." 3369 DEFVAL { 0 } 3370 ::= { docsIetfQosServiceClassEntry 4 } 3372 docsIetfQosServiceClassMaxTrafficBurst OBJECT-TYPE 3373 SYNTAX Unsigned32 3374 MAX-ACCESS read-create 3375 STATUS current 3376 DESCRIPTION "Template for docsIetfQosParamSetMaxTrafficBurst." 3377 DEFVAL { 3044 } 3378 ::= { docsIetfQosServiceClassEntry 5 } 3380 docsIetfQosServiceClassMinReservedRate OBJECT-TYPE 3381 SYNTAX DocsIetfQosBitRate 3382 MAX-ACCESS read-create 3383 STATUS current 3384 DESCRIPTION "Template for docsIetfQosParamSEtMinReservedRate." 3385 DEFVAL { 0 } 3386 ::= { docsIetfQosServiceClassEntry 6 } 3388 docsIetfQosServiceClassMinReservedPkt OBJECT-TYPE 3389 SYNTAX Integer32 (0..65535) 3390 MAX-ACCESS read-create 3391 STATUS current 3392 DESCRIPTION "Template for docsIetfQosParamSetMinReservedPkt." 3393 ::= { docsIetfQosServiceClassEntry 7 } 3395 docsIetfQosServiceClassMaxConcatBurst OBJECT-TYPE 3396 SYNTAX Integer32 (0..65535) 3397 MAX-ACCESS read-create 3398 STATUS current 3399 DESCRIPTION "Template for docsIetfQosParamSetMaxConcatBurst." 3400 DEFVAL { 1522 } 3401 ::= { docsIetfQosServiceClassEntry 8 } 3403 docsIetfQosServiceClassNomPollInterval OBJECT-TYPE 3404 SYNTAX Unsigned32 3405 UNITS "microseconds" 3406 MAX-ACCESS read-create 3408 IPCDN DOCSIS QoS MIB February 2005 3410 STATUS current 3411 DESCRIPTION "Template for docsIetfQosParamSetNomPollInterval." 3412 DEFVAL { 0 } 3413 ::= { docsIetfQosServiceClassEntry 9 } 3415 docsIetfQosServiceClassTolPollJitter OBJECT-TYPE 3416 SYNTAX Unsigned32 3417 UNITS "microseconds" 3418 MAX-ACCESS read-create 3419 STATUS current 3420 DESCRIPTION "Template for docsIetfQosParamSetTolPollJitter." 3421 DEFVAL { 0 } 3422 ::= { docsIetfQosServiceClassEntry 10 } 3424 docsIetfQosServiceClassUnsolicitGrantSize OBJECT-TYPE 3425 SYNTAX Integer32 (0..65535) 3426 MAX-ACCESS read-create 3427 STATUS current 3428 DESCRIPTION "Template for docsIetfQosParamSetUnsolicitGrantSize." 3429 DEFVAL { 0 } 3430 ::= { docsIetfQosServiceClassEntry 11 } 3432 docsIetfQosServiceClassNomGrantInterval OBJECT-TYPE 3433 SYNTAX Unsigned32 3434 UNITS "microseconds" 3435 MAX-ACCESS read-create 3436 STATUS current 3437 DESCRIPTION "Template for docsIetfQosParamSetNomGrantInterval." 3438 DEFVAL { 0 } 3439 ::= { docsIetfQosServiceClassEntry 12 } 3441 docsIetfQosServiceClassTolGrantJitter OBJECT-TYPE 3442 SYNTAX Unsigned32 3443 UNITS "microseconds" 3444 MAX-ACCESS read-create 3445 STATUS current 3446 DESCRIPTION "Template for docsIetfQosParamSetTolGrantJitter." 3447 DEFVAL { 0 } 3448 ::= { docsIetfQosServiceClassEntry 13 } 3450 docsIetfQosServiceClassGrantsPerInterval OBJECT-TYPE 3451 SYNTAX Integer32 (0..127) 3452 MAX-ACCESS read-create 3453 STATUS current 3454 DESCRIPTION "Template for docsIetfQosParamSetGrantsPerInterval." 3455 DEFVAL { 0 } 3456 ::= { docsIetfQosServiceClassEntry 14 } 3458 docsIetfQosServiceClassMaxLatency OBJECT-TYPE 3459 SYNTAX Unsigned32 3460 UNITS "microseconds" 3462 IPCDN DOCSIS QoS MIB February 2005 3464 MAX-ACCESS read-create 3465 STATUS current 3466 DESCRIPTION "Template for docsIetfQosParamSetClassMaxLatency." 3467 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.7.1" 3468 DEFVAL { 0 } 3469 ::= { docsIetfQosServiceClassEntry 15 } 3471 docsIetfQosServiceClassActiveTimeout OBJECT-TYPE 3472 SYNTAX Integer32 (0..65535) 3473 UNITS "seconds" 3474 MAX-ACCESS read-create 3475 STATUS current 3476 DESCRIPTION "Template for docsIetfQosParamSetActiveTimeout." 3477 DEFVAL { 0 } 3478 ::= { docsIetfQosServiceClassEntry 16 } 3480 docsIetfQosServiceClassAdmittedTimeout OBJECT-TYPE 3481 SYNTAX Integer32 (0..65535) 3482 UNITS "seconds" 3483 MAX-ACCESS read-create 3484 STATUS current 3485 DESCRIPTION "Template for docsIetfQosParamSetAdmittedTimeout." 3486 DEFVAL { 200 } 3487 ::= { docsIetfQosServiceClassEntry 17 } 3489 docsIetfQosServiceClassSchedulingType OBJECT-TYPE 3490 SYNTAX DocsIetfQosSchedulingType 3491 MAX-ACCESS read-create 3492 STATUS current 3493 DESCRIPTION "Template for docsIetfQosParamSetSchedulingType." 3494 DEFVAL { bestEffort } 3495 ::= { docsIetfQosServiceClassEntry 18 } 3497 docsIetfQosServiceClassRequestPolicy OBJECT-TYPE 3498 SYNTAX OCTET STRING (SIZE(4)) 3499 MAX-ACCESS read-create 3500 STATUS current 3501 DESCRIPTION "Template for docsIetfQosParamSetRequestPolicyOct." 3502 DEFVAL { '00000000'H } -- no bits are set 3503 ::= { docsIetfQosServiceClassEntry 19 } 3505 docsIetfQosServiceClassTosAndMask OBJECT-TYPE 3506 SYNTAX OCTET STRING (SIZE(1)) 3507 MAX-ACCESS read-only 3508 STATUS current 3509 DESCRIPTION "Template for docsIetfQosParamSetTosAndMask. 3510 The IP TOS octet as originally defined in RFC 791 3511 has been superseded by the 6 bit Differentiated 3512 Services Field (DSField, RFC 3260) and the 2 bit 3513 Explicit Congestion Notification Field (ECN field, 3514 RFC 3168). Network operators SHOULD avoid specifying 3516 IPCDN DOCSIS QoS MIB February 2005 3518 values of docsIetfQosServiceClassTosAndMask and 3519 docsIetfQosServiceClassTosOrMask which would result 3520 in the modification of the ECN bits. 3522 In particular, operators should not use values of 3523 docsIetfQosServiceClassTosAndMask which have either 3524 of the least-significant two bits set to 0. 3525 Similarly,operators should not use values of 3526 docsIetfQosServiceClassTosOrMask which have either 3527 of the least-significant two bits set to 1." 3528 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10; 3529 RFC 3168, The Addition of Explicit Congestion 3530 Notification (ECN) to IP; 3531 RFC 3260, New Terminology and Clarifications for 3532 Diffserv." 3533 ::= { docsIetfQosServiceClassEntry 20 } 3535 docsIetfQosServiceClassTosOrMask OBJECT-TYPE 3536 SYNTAX OCTET STRING (SIZE(1)) 3537 MAX-ACCESS read-only 3538 STATUS current 3539 DESCRIPTION "Template for docsIetfQosParamSetTosOrMask. 3540 The IP TOS octet as originally defined in RFC 791 3541 has been superseded by the 6 bit Differentiated 3542 Services Field (DSField, RFC 3260) and the 2 bit 3543 Explicit Congestion Notification Field (ECN field, 3544 RFC 3168). Network operators SHOULD avoid specifying 3545 values of docsIetfQosServiceClassTosAndMask and 3546 docsIetfQosServiceClassTosOrMask which would result 3547 in the modification of the ECN bits. 3549 In particular, operators should not use values of 3550 docsIetfQosServiceClassTosAndMask which have either 3551 of the least-significant two bits set to 0. 3552 Similarly, operators should not use values of 3553 docsIetfQosServiceClassTosOrMask which have either 3554 of the least-significant two bits set to 1." 3555 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.6.10; 3556 RFC 3168, The Addition of Explicit Congestion 3557 Notification (ECN) to IP; 3558 RFC 3260, New Terminology and Clarifications for 3559 Diffserv." 3560 ::= { docsIetfQosServiceClassEntry 21 } 3562 docsIetfQosServiceClassDirection OBJECT-TYPE 3563 SYNTAX DocsIetfQosRfMacIfDirection 3564 MAX-ACCESS read-create 3565 STATUS current 3566 DESCRIPTION "Specifies whether the service class template 3567 applies to upstream or downstream service flows." 3568 DEFVAL { upstream } 3570 IPCDN DOCSIS QoS MIB February 2005 3572 ::= { docsIetfQosServiceClassEntry 22 } 3574 docsIetfQosServiceClassStorageType OBJECT-TYPE 3575 SYNTAX StorageType 3576 MAX-ACCESS read-create 3577 STATUS current 3578 DESCRIPTION "This object defines whether this row is kept in 3579 volatile storage and lost upon reboot or if this 3580 row is backed up by non-volatile or permanent 3581 storage. 'permanent' entries need not allow 3582 writable access to any object." 3583 DEFVAL { nonVolatile } 3584 ::= { docsIetfQosServiceClassEntry 23 } 3586 docsIetfQosServiceClassDSCPOverwrite OBJECT-TYPE 3587 SYNTAX DscpOrAny 3588 MAX-ACCESS read-create 3589 STATUS current 3590 DESCRIPTION "This object allows the overwrite of the DSCP 3591 field per RFC 3260. 3593 If this object is -1 than the corresponding entry's 3594 docsIetfQosServiceClassTosAndMask value MUST be 3595 'FF'H and docsIetfQosServiceClassTosOrMask MUST be 3596 '00'H. Otherwise, this object is in the range of 3597 0..63 and the corresponding entry's 3598 docsIetfQosServiceClassTosAndMask value MUST be 3599 '03'H and the docsIetfQosServiceClassTosOrMask MUST 3600 be this object's value shifted left by two bit 3601 positions." 3602 REFERENCE "RFC 3168, The Addition of Explicit Congestion 3603 Notification (ECN) to IP; 3604 RFC 3260, New Terminology and Clarifications for 3605 Diffserv." 3606 DEFVAL { -1 } 3607 ::= { docsIetfQosServiceClassEntry 24 } 3609 -- 3610 -- Service Class PolicyTable 3611 -- 3612 docsIetfQosServiceClassPolicyTable OBJECT-TYPE 3613 SYNTAX SEQUENCE OF DocsIetfQosServiceClassPolicyEntry 3614 MAX-ACCESS not-accessible 3615 STATUS current 3616 DESCRIPTION "This table describes the set of DOCSIS-QOS 3617 Service Class Policies. 3619 This table is an adjunct to the 3620 docsDevFilterPolicy table. Entries in 3621 docsDevFilterPolicy table can point to 3622 specific rows in this table. 3624 IPCDN DOCSIS QoS MIB February 2005 3626 This table permits mapping a packet to a service 3627 class name of an active service flow so long as 3628 a classifier does not exist at a higher 3629 priority. 3630 " 3631 REFERENCE "SP-RFIv2.0-I06-040804, Appendix E.2.1" 3632 ::= { docsIetfQosMIBObjects 9 } 3634 docsIetfQosServiceClassPolicyEntry OBJECT-TYPE 3635 SYNTAX DocsIetfQosServiceClassPolicyEntry 3636 MAX-ACCESS not-accessible 3637 STATUS current 3638 DESCRIPTION "A service class name policy entry." 3639 INDEX { 3640 docsIetfQosServiceClassPolicyIndex 3641 } 3642 ::= { docsIetfQosServiceClassPolicyTable 1 } 3644 DocsIetfQosServiceClassPolicyEntry ::= SEQUENCE { 3645 docsIetfQosServiceClassPolicyIndex Unsigned32, 3646 docsIetfQosServiceClassPolicyName SnmpAdminString, 3647 docsIetfQosServiceClassPolicyRulePriority Integer32, 3648 docsIetfQosServiceClassPolicyStatus RowStatus, 3649 docsIetfQosServiceClassPolicyStorageType StorageType 3650 } 3652 docsIetfQosServiceClassPolicyIndex OBJECT-TYPE 3653 SYNTAX Unsigned32 (1..2147483647) 3654 MAX-ACCESS not-accessible 3655 STATUS current 3656 DESCRIPTION "Index value to uniquely identify an entry in 3657 this table." 3658 ::= { docsIetfQosServiceClassPolicyEntry 1 } 3660 docsIetfQosServiceClassPolicyName OBJECT-TYPE 3661 SYNTAX SnmpAdminString 3662 MAX-ACCESS read-create 3663 STATUS current 3664 DESCRIPTION "Service Class Name to identify the name of the 3665 service class flow to which the packet should be 3666 directed." 3667 REFERENCE "SP-RFIv2.0-I06-040804, Appendix E.2.1" 3668 ::= { docsIetfQosServiceClassPolicyEntry 2 } 3670 docsIetfQosServiceClassPolicyRulePriority OBJECT-TYPE 3671 SYNTAX Integer32 (0..255) 3672 MAX-ACCESS read-create 3673 STATUS current 3674 DESCRIPTION "Service Class Policy rule priority for the 3675 entry." 3676 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.1.3.5" 3678 IPCDN DOCSIS QoS MIB February 2005 3680 ::= { docsIetfQosServiceClassPolicyEntry 3 } 3682 docsIetfQosServiceClassPolicyStatus OBJECT-TYPE 3683 SYNTAX RowStatus 3684 MAX-ACCESS read-create 3685 STATUS current 3686 DESCRIPTION "Used to create or delete rows in this table. 3687 This object should not be deleted if it is 3688 referenced by an entry in docsDevFilterPolicy. 3689 The reference should be deleted first. 3690 There is no restriction on the ability 3691 to change values in this row while the row is 3692 active. Inactive rows need not be timed out." 3693 ::= { docsIetfQosServiceClassPolicyEntry 4 } 3695 docsIetfQosServiceClassPolicyStorageType OBJECT-TYPE 3696 SYNTAX StorageType 3697 MAX-ACCESS read-create 3698 STATUS current 3699 DESCRIPTION "This object defines whether this row is kept in 3700 volatile storage and lost upon reboot or if this 3701 row is backed up by non-volatile or permanent 3702 storage. 'permanent' entries need not allow 3703 writable access to any object." 3704 DEFVAL { nonVolatile } 3705 ::= { docsIetfQosServiceClassPolicyEntry 5 } 3707 -- 3708 -- Payload Header Suppression(PHS) Table 3709 -- 3710 docsIetfQosPHSTable OBJECT-TYPE 3711 SYNTAX SEQUENCE OF DocsIetfQosPHSEntry 3712 MAX-ACCESS not-accessible 3713 STATUS current 3714 DESCRIPTION "This table describes the set of payload header 3715 suppression entries." 3716 ::= { docsIetfQosMIBObjects 10 } 3718 docsIetfQosPHSEntry OBJECT-TYPE 3719 SYNTAX DocsIetfQosPHSEntry 3720 MAX-ACCESS not-accessible 3721 STATUS current 3722 DESCRIPTION "A payload header suppression entry. 3723 The ifIndex is an ifType of docsCableMaclayer(127). 3724 The index docsIetfQosServiceFlowId selects one 3725 service flow from the cable MAC layer interface. 3726 The docsIetfQosPktClassId index matches an 3727 index of the docsIetfQosPktClassTable. 3728 " 3729 INDEX { 3730 ifIndex, 3732 IPCDN DOCSIS QoS MIB February 2005 3734 docsIetfQosServiceFlowId, 3735 docsIetfQosPktClassId 3736 } 3737 ::= { docsIetfQosPHSTable 1 } 3739 DocsIetfQosPHSEntry ::= SEQUENCE { 3740 docsIetfQosPHSField OCTET STRING, 3741 docsIetfQosPHSMask OCTET STRING, 3742 docsIetfQosPHSSize Integer32, 3743 docsIetfQosPHSVerify TruthValue, 3744 docsIetfQosPHSIndex Integer32 3745 } 3747 docsIetfQosPHSField OBJECT-TYPE 3748 SYNTAX OCTET STRING (SIZE(0..255)) 3749 MAX-ACCESS read-only 3750 STATUS current 3751 DESCRIPTION "Payload header suppression field defines the 3752 bytes of the header which must be 3753 suppressed/restored by the sending/receiving 3754 device. 3756 The number of octets in this object should be 3757 the same as the value of docsIetfQosPHSSize." 3758 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.1" 3759 ::= { docsIetfQosPHSEntry 1 } 3761 docsIetfQosPHSMask OBJECT-TYPE 3762 SYNTAX OCTET STRING(SIZE(0..32)) 3763 MAX-ACCESS read-only 3764 STATUS current 3765 DESCRIPTION "Payload header suppression mask defines the 3766 bit mask which is used in combination with the 3767 docsIetfQosPHSField defines which bytes in header 3768 must be suppressed/restored by the sending or 3769 receiving device. 3771 Each bit of this bit mask corresponds to a byte 3772 in the docsIetfQosPHSField, with the least 3773 significant bit corresponding to the first byte 3774 of the docsIetfQosPHSField. 3776 Each bit of the bit mask specifies whether or 3777 not the corresponding byte should be suppressed 3778 in the packet. A bit value of '1' indicates that 3779 the byte should be suppressed by the sending 3780 device and restored by the receiving device. 3781 A bit value of '0' indicates that 3782 the byte should not be suppressed by the sending 3783 device or restored by the receiving device. 3785 IPCDN DOCSIS QoS MIB February 2005 3787 If the bit mask does not contain a bit for each 3788 byte in the docsIetfQosPHSField then the bit mask is 3789 extended with bit values of '1' to be the 3790 necessary length." 3791 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.3" 3792 ::= { docsIetfQosPHSEntry 2 } 3794 docsIetfQosPHSSize OBJECT-TYPE 3795 SYNTAX Integer32 (0..255) 3796 MAX-ACCESS read-only 3797 STATUS current 3798 DESCRIPTION "Payload header suppression size specifies the 3799 number of bytes in the header to be suppressed 3800 and restored. 3802 The value of this object must match the number 3803 of bytes in the docsIetfQosPHSField." 3804 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.4" 3805 ::= { docsIetfQosPHSEntry 3 } 3807 docsIetfQosPHSVerify OBJECT-TYPE 3808 SYNTAX TruthValue 3809 MAX-ACCESS read-only 3810 STATUS current 3811 DESCRIPTION "Payload header suppression verification value of 3812 'true' the sender must verify docsIetfQosPHSField 3813 is the same as what is contained in the packet 3814 to be suppressed." 3815 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.5" 3816 ::= { docsIetfQosPHSEntry 4 } 3818 docsIetfQosPHSIndex OBJECT-TYPE 3819 SYNTAX Integer32 (1..255) 3820 MAX-ACCESS read-only 3821 STATUS current 3822 DESCRIPTION "Payload header suppression index uniquely 3823 references the PHS rule for a given service flow." 3824 REFERENCE "SP-RFIv2.0-I06-040804, Appendix C.2.2.10.2" 3825 ::= { docsIetfQosPHSEntry 5 } 3827 -- 3828 -- docsIetfQosCmtsMacToSrvFlowTable (CMTS Only) 3829 -- 3830 docsIetfQosCmtsMacToSrvFlowTable OBJECT-TYPE 3831 SYNTAX SEQUENCE OF DocsIetfQosCmtsMacToSrvFlowEntry 3832 MAX-ACCESS not-accessible 3833 STATUS current 3834 DESCRIPTION "This table provides for referencing the service 3835 flows associated with a particular cable modem. 3836 This allows for indexing into other docsIetfQos 3838 IPCDN DOCSIS QoS MIB February 2005 3840 tables that are indexed by docsIetfQosServiceFlowId 3841 and ifIndex." 3842 ::= { docsIetfQosMIBObjects 11 } 3844 docsIetfQosCmtsMacToSrvFlowEntry OBJECT-TYPE 3845 SYNTAX DocsIetfQosCmtsMacToSrvFlowEntry 3846 MAX-ACCESS not-accessible 3847 STATUS current 3848 DESCRIPTION "An entry is created by CMTS for each service flow 3849 connected to this CMTS." 3850 INDEX { 3851 docsIetfQosCmtsCmMac, 3852 docsIetfQosCmtsServiceFlowId 3853 } 3854 ::= { docsIetfQosCmtsMacToSrvFlowTable 1 } 3856 DocsIetfQosCmtsMacToSrvFlowEntry ::= SEQUENCE { 3857 docsIetfQosCmtsCmMac MacAddress, 3858 docsIetfQosCmtsServiceFlowId Unsigned32, 3859 docsIetfQosCmtsIfIndex InterfaceIndex 3860 } 3862 docsIetfQosCmtsCmMac OBJECT-TYPE 3863 SYNTAX MacAddress 3864 MAX-ACCESS not-accessible 3865 STATUS current 3866 DESCRIPTION "The MAC address for the referenced CM." 3867 ::= { docsIetfQosCmtsMacToSrvFlowEntry 1 } 3869 docsIetfQosCmtsServiceFlowId OBJECT-TYPE 3870 SYNTAX Unsigned32 (1..4294967295) 3871 MAX-ACCESS not-accessible 3872 STATUS current 3873 DESCRIPTION "An index assigned to a service flow by CMTS." 3874 ::= { docsIetfQosCmtsMacToSrvFlowEntry 2 } 3876 docsIetfQosCmtsIfIndex OBJECT-TYPE 3877 SYNTAX InterfaceIndex 3878 MAX-ACCESS read-only 3879 STATUS current 3880 DESCRIPTION "The ifIndex of ifType docsCableMacLayer(127) 3881 on the CMTS that is connected to the Cable Modem." 3882 ::= { docsIetfQosCmtsMacToSrvFlowEntry 3 } 3884 -- 3885 -- Conformance definitions 3886 -- 3887 docsIetfQosConformance OBJECT IDENTIFIER 3888 ::= { docsIetfQosMIB 2 } 3890 docsIetfQosGroups OBJECT IDENTIFIER 3891 IPCDN DOCSIS QoS MIB February 2005 3893 ::= { docsIetfQosConformance 1 } 3895 docsIetfQosCompliances OBJECT IDENTIFIER 3896 ::= { docsIetfQosConformance 2 } 3898 docsIetfQosCompliance MODULE-COMPLIANCE 3899 STATUS current 3900 DESCRIPTION 3901 "The compliance statement for MCNS Cable Modems and 3902 Cable Modem Termination Systems that implement DOCSIS 3903 Service Flows." 3905 MODULE -- docsIetfQosMIB 3906 MANDATORY-GROUPS { docsIetfQosBaseGroup } 3908 GROUP docsIetfQosCmtsGroup 3909 DESCRIPTION 3910 "This group is mandatory for Cable Modem Termination 3911 Systems (CMTS) and not implemented for Cable Modems 3912 (CM)." 3914 GROUP docsIetfQosParamSetGroup 3915 DESCRIPTION 3916 "This group is mandatory for Cable Modem Termination 3917 Systems (CMTS) and Cable Modems. Cable modems only 3918 implement objects in this group as read-only." 3920 GROUP docsIetfQosSrvClassPolicyGroup 3921 DESCRIPTION 3922 "This group is optional for Cable Modem Termination 3923 Systems (CMTS) and Cable Modems. This group is relevant 3924 if policy based service flow classification 3925 is implemented. See docsDevPolicyTable in 3926 DOCS-CABLE-DEVICE-MIB for more details. " 3928 GROUP docsIetfQosServiceClassGroup 3929 DESCRIPTION 3930 "The is group is mandatory for a Cable Modem Termination 3931 System (CMTS) that implement expansion of Service Class 3932 Names in a QOS Parameter Set. This group is 3933 not implemented on the Cable Modems." 3935 OBJECT docsIetfQosPktClassPkts 3936 DESCRIPTION 3937 "This object only needs to be implemented in entries 3938 that are classifying packets and not policing packets." 3940 OBJECT docsIetfQosPktClassInetAddressType 3941 SYNTAX InetAddressType { ipv4(1) } 3942 DESCRIPTION 3943 "An implementation is only required to support IPv4 3945 IPCDN DOCSIS QoS MIB February 2005 3947 address." 3949 OBJECT docsIetfQosPktClassInetSourceAddr 3950 SYNTAX InetAddress (SIZE(4)) 3951 DESCRIPTION 3952 "An implementation is only required to support IPv4 3953 address." 3955 OBJECT docsIetfQosPktClassInetSourceMask 3956 SYNTAX InetAddress (SIZE(4)) 3957 DESCRIPTION 3958 "An implementation is only required to support IPv4 3959 address." 3961 OBJECT docsIetfQosPktClassInetDestAddr 3962 SYNTAX InetAddress (SIZE(4)) 3963 DESCRIPTION 3964 "An implementation is only required to support IPv4 3965 address." 3967 OBJECT docsIetfQosPktClassInetDestMask 3968 SYNTAX InetAddress (SIZE(4)) 3969 DESCRIPTION 3970 "An implementation is only required to support IPv4 3971 address." 3973 OBJECT docsIetfQosServiceClassStorageType 3974 SYNTAX StorageType { nonVolatile(3) } 3975 DESCRIPTION 3976 "An implementation is only required to support nonvolatile 3977 storage." 3979 OBJECT docsIetfQosServiceClassPolicyStorageType 3980 SYNTAX StorageType { nonVolatile(3) } 3981 DESCRIPTION 3982 "An implementation is only required to support nonvolatile 3983 storage." 3985 ::= { docsIetfQosCompliances 1 } 3987 docsIetfQosBaseGroup OBJECT-GROUP 3988 OBJECTS { 3989 docsIetfQosPktClassDirection, 3990 docsIetfQosPktClassPriority, 3991 docsIetfQosPktClassIpTosLow, 3992 docsIetfQosPktClassIpTosHigh, 3993 docsIetfQosPktClassIpTosMask, 3994 docsIetfQosPktClassIpProtocol, 3995 docsIetfQosPktClassSourcePortStart, 3996 docsIetfQosPktClassSourcePortEnd, 3997 docsIetfQosPktClassDestPortStart, 3999 IPCDN DOCSIS QoS MIB February 2005 4001 docsIetfQosPktClassDestPortEnd, 4002 docsIetfQosPktClassDestMacAddr, 4003 docsIetfQosPktClassDestMacMask, 4004 docsIetfQosPktClassSourceMacAddr, 4005 docsIetfQosPktClassEnetProtocolType, 4006 docsIetfQosPktClassEnetProtocol, 4007 docsIetfQosPktClassUserPriLow, 4008 docsIetfQosPktClassUserPriHigh, 4009 docsIetfQosPktClassVlanId, 4010 docsIetfQosPktClassStateActive, 4011 docsIetfQosPktClassPkts, 4012 docsIetfQosPktClassBitMap, 4013 docsIetfQosPktClassInetAddressType, 4014 docsIetfQosPktClassInetSourceAddr, 4015 docsIetfQosPktClassInetSourceMask, 4016 docsIetfQosPktClassInetDestAddr, 4017 docsIetfQosPktClassInetDestMask, 4019 docsIetfQosServiceFlowSID, 4020 docsIetfQosServiceFlowDirection, 4021 docsIetfQosServiceFlowPrimary, 4023 docsIetfQosServiceFlowPkts, 4024 docsIetfQosServiceFlowOctets, 4025 docsIetfQosServiceFlowTimeCreated, 4026 docsIetfQosServiceFlowTimeActive, 4027 docsIetfQosServiceFlowPHSUnknowns, 4028 docsIetfQosServiceFlowPolicedDropPkts, 4029 docsIetfQosServiceFlowPolicedDelayPkts, 4031 docsIetfQosDSAReqs, 4032 docsIetfQosDSARsps, 4033 docsIetfQosDSAAcks, 4034 docsIetfQosDSCReqs, 4035 docsIetfQosDSCRsps, 4036 docsIetfQosDSCAcks, 4037 docsIetfQosDSDReqs, 4038 docsIetfQosDSDRsps, 4039 docsIetfQosDynamicAdds, 4040 docsIetfQosDynamicAddFails, 4041 docsIetfQosDynamicChanges, 4042 docsIetfQosDynamicChangeFails, 4043 docsIetfQosDynamicDeletes, 4044 docsIetfQosDynamicDeleteFails, 4045 docsIetfQosDCCReqs, 4046 docsIetfQosDCCRsps, 4047 docsIetfQosDCCAcks, 4048 docsIetfQosDCCs, 4049 docsIetfQosDCCFails, 4051 docsIetfQosPHSField, 4053 IPCDN DOCSIS QoS MIB February 2005 4055 docsIetfQosPHSMask, 4056 docsIetfQosPHSSize, 4057 docsIetfQosPHSVerify, 4058 docsIetfQosPHSIndex 4059 } 4060 STATUS current 4061 DESCRIPTION 4062 "Group of objects implemented in both Cable Modems and 4063 Cable Modem Termination Systems." 4064 ::= { docsIetfQosGroups 1 } 4066 docsIetfQosParamSetGroup OBJECT-GROUP 4067 OBJECTS { 4068 docsIetfQosParamSetServiceClassName, 4069 docsIetfQosParamSetPriority, 4070 docsIetfQosParamSetMaxTrafficRate, 4071 docsIetfQosParamSetMaxTrafficBurst, 4072 docsIetfQosParamSetMinReservedRate, 4073 docsIetfQosParamSetMinReservedPkt, 4074 docsIetfQosParamSetActiveTimeout, 4075 docsIetfQosParamSetAdmittedTimeout, 4076 docsIetfQosParamSetMaxConcatBurst, 4077 docsIetfQosParamSetSchedulingType, 4078 docsIetfQosParamSetNomPollInterval, 4079 docsIetfQosParamSetTolPollJitter, 4080 docsIetfQosParamSetUnsolicitGrantSize, 4081 docsIetfQosParamSetNomGrantInterval, 4082 docsIetfQosParamSetTolGrantJitter, 4083 docsIetfQosParamSetGrantsPerInterval, 4084 docsIetfQosParamSetTosAndMask, 4085 docsIetfQosParamSetTosOrMask, 4086 docsIetfQosParamSetMaxLatency, 4087 docsIetfQosParamSetRequestPolicyOct, 4088 docsIetfQosParamSetBitMap 4089 } 4090 STATUS current 4091 DESCRIPTION 4092 "Group of objects implemenented in both Cable Modems and 4093 Cable Modem Termination Systems for QOS parameter sets." 4094 ::= { docsIetfQosGroups 2 } 4096 docsIetfQosCmtsGroup OBJECT-GROUP 4097 OBJECTS { 4099 docsIetfQosUpstreamFragments, 4100 docsIetfQosUpstreamFragDiscards, 4101 docsIetfQosUpstreamConcatBursts, 4103 docsIetfQosServiceFlowLogIfIndex, 4104 docsIetfQosServiceFlowLogSFID, 4106 IPCDN DOCSIS QoS MIB February 2005 4108 docsIetfQosServiceFlowLogCmMac, 4109 docsIetfQosServiceFlowLogPkts, 4110 docsIetfQosServiceFlowLogOctets, 4111 docsIetfQosServiceFlowLogTimeDeleted, 4112 docsIetfQosServiceFlowLogTimeCreated, 4113 docsIetfQosServiceFlowLogTimeActive, 4114 docsIetfQosServiceFlowLogDirection, 4115 docsIetfQosServiceFlowLogPrimary, 4116 docsIetfQosServiceFlowLogServiceClassName, 4117 docsIetfQosServiceFlowLogPolicedDropPkts, 4118 docsIetfQosServiceFlowLogPolicedDelayPkts, 4119 docsIetfQosServiceFlowLogControl, 4121 docsIetfQosCmtsIfIndex -- docsIetfQosCmtsMacToSrvFlowTable required 4123 } 4124 STATUS current 4125 DESCRIPTION 4126 "Group of objects implemented only in the CMTS." 4127 ::= { docsIetfQosGroups 3 } 4129 docsIetfQosSrvClassPolicyGroup OBJECT-GROUP 4130 OBJECTS { 4131 docsIetfQosServiceClassPolicyName, 4132 docsIetfQosServiceClassPolicyRulePriority, 4133 docsIetfQosServiceClassPolicyStatus, 4134 docsIetfQosServiceClassPolicyStorageType 4135 } 4136 STATUS current 4137 DESCRIPTION 4138 "Group of objects implemented in both Cable Modems and 4139 Cable Modem Termination Systems when supporting policy based 4140 service flows." 4141 ::= { docsIetfQosGroups 4 } 4143 docsIetfQosServiceClassGroup OBJECT-GROUP 4144 OBJECTS { 4145 docsIetfQosServiceClassStatus, 4146 docsIetfQosServiceClassPriority, 4147 docsIetfQosServiceClassMaxTrafficRate, 4148 docsIetfQosServiceClassMaxTrafficBurst, 4149 docsIetfQosServiceClassMinReservedRate, 4150 docsIetfQosServiceClassMinReservedPkt, 4151 docsIetfQosServiceClassMaxConcatBurst, 4152 docsIetfQosServiceClassNomPollInterval, 4153 docsIetfQosServiceClassTolPollJitter, 4154 docsIetfQosServiceClassUnsolicitGrantSize, 4155 docsIetfQosServiceClassNomGrantInterval, 4156 docsIetfQosServiceClassTolGrantJitter, 4157 docsIetfQosServiceClassGrantsPerInterval, 4158 docsIetfQosServiceClassMaxLatency, 4160 IPCDN DOCSIS QoS MIB February 2005 4162 docsIetfQosServiceClassActiveTimeout, 4163 docsIetfQosServiceClassAdmittedTimeout, 4164 docsIetfQosServiceClassSchedulingType, 4165 docsIetfQosServiceClassRequestPolicy, 4166 docsIetfQosServiceClassTosAndMask, 4167 docsIetfQosServiceClassTosOrMask, 4168 docsIetfQosServiceClassDirection, 4169 docsIetfQosServiceClassStorageType, 4170 docsIetfQosServiceClassDSCPOverwrite 4171 } 4172 STATUS current 4173 DESCRIPTION 4174 "Group of object implemented only in Cable Modem 4175 Termination Systems when supporting expansion of Service 4176 Class Names in a QOS Parameter Set" 4177 ::= { docsIetfQosGroups 5 } 4179 END 4180 IPCDN DOCSIS QoS MIB February 2005 4182 6. Security Considerations 4184 This MIB module relates to an agent which will provide metropolitan 4185 public internet access. As such, improper manipulation of the 4186 objects represented by this MIB module may result in denial of 4187 service to a large number of end-users [6]. Manipulation of the 4188 docsIetfQosServiceClassTable and docsIetfQosServiceClassPolicyTable 4189 may allow an end-user to increase their service levels, or affect 4190 other end-users in either a positive or negative manner. In 4191 addition, manipulation of docsIetfQosServiceFlowLogControl could 4192 allow an attacker to remove logs of packet and byte counts forwarded 4193 on a Service Flow. If such logs were used for billing, the attacker 4194 would obtain free service. 4196 There are a number of management objects defined in this MIB module 4197 with a MAX-ACCESS clause of read-write and/or read-create. Such 4198 objects may be considered sensitive or vulnerable in some network 4199 environments. The support for SET operations in a non-secure 4200 environment without proper protection can have a negative effect on 4201 network operations. These are the tables and objects and their 4202 sensitivity/vulnerability: 4204 o The docsIetfQosServiceClassTable provides a template of QOS 4205 parameters such as maximum rate limits for a named service 4206 class. Changing these parameters would allow an attacker to 4207 obtain unauthorized class of service. 4209 o The docsIetfQosServiceClassPolicyTable applies CMTS vendor 4210 proprietary policies for packet forwarding, including 4211 dropping, scheduling, notification, or other policies. 4212 Changing this table could allow an attacker to deny service 4213 to all subscribers of the CMTS or grant the attacker 4214 unauthorized forwarding policies. 4216 o The docsIetfQosServiceFlowLogControl object controls the 4217 deletion of entries in the docsIetfQosServiceFlowLogTable, 4218 which acts as a historical "detail record" of DOCSIS Service 4219 Flow packets and bytes transmitted. Such records may be used 4220 for billing purposes, so the unauthorized deletion of the 4221 records can result in free service. 4223 Some of the readable objects in this MIB module (i.e., objects with a 4224 MAX-ACCESS other than not-accessible) may be considered sensitive or 4225 vulnerable in some network environments. It is thus important to 4226 control even GET access to these objects and possibly to even encrypt 4227 the values of these objects when sending them over the network via 4228 SNMP. These are the tables and objects and their 4229 sensitivity/vulnerability: 4231 o Unauthorized SNMP GET access of the docsIetfQosPktClassTable 4233 IPCDN DOCSIS QoS MIB February 2005 4235 or docsIetfQosPHSTable can allow an attacker to learn IP 4236 addresses permitted to have enhanced quality of service, for 4237 possible spoofing. This table typically contains the IP 4238 addresses involved in voice-over-IP sessions, for example. 4240 o Unauthorized SNMP GET access of the docsIetfQosParamSetTable 4241 allows an attacker to learn the names of Service Classes 4242 which are permitted to have enhanced QoS service, and the 4243 values of that enhanced service. That name can be referenced 4244 in an unauthorized DOCSIS cable modem configuration file to 4245 obtain enhanced service. 4247 o Unauthorized SNMP GET access of the 4248 docsIetfQosServiceFlowTable can tell an attacker when 4249 Service Flows are active, e.g. when a voice-over-IP call is 4250 in progress. 4252 Unauthorized SNMP GET access of the 4253 docsIetfQosServiceFlowLogTable can expose private information 4254 about network usage. 4256 o Unauthorized SNMP GET access of the 4257 docsIetfQosServiceFlowStatsTable, 4258 docsIetfQosUpstreamStatsTable, 4259 docsIetfQosDynamicServiceStatsTable, 4260 docsIetfQosServiceFlowLogTable, 4261 and docsIetfQosCmtsMacToSrvFlowTable can tell an attacker the 4262 volume of traffic to and from any Service Flow in the system, 4263 resulting in loss of privacy of the amount and direction of 4264 data transfer. 4266 SNMP versions prior to SNMPv3 did not include adequate security. 4267 Even if the network itself is secure (for example by using IPSec), 4268 even then, there is no control as to who on the secure network is 4269 allowed to access and GET/SET (read/change/create/delete) the objects 4270 in this MIB module. It is RECOMMENDED that implementers consider the 4271 security features as provided by the SNMPv3 framework (see [15], 4272 section 8), including full support for the SNMPv3 cryptographic 4273 mechanisms (for authentication and privacy). Further, deployment of 4274 SNMP versions prior to SNMPv3 is NOT RECOMMENDED. Instead, it is 4275 RECOMMENDED to deploy SNMPv3 and to enable cryptographic security. 4276 It is then a customer/operator responsibility to ensure that the SNMP 4277 entity giving access to an instance of this MIB module, is properly 4278 configured to give access to the objects only to those principals 4279 (users) that have legitimate rights to indeed GET or SET 4280 (change/create/delete) them. 4282 IPCDN DOCSIS QoS MIB February 2005 4284 7. IANA Considerations 4286 The MIB module in this document uses the following IANA-assigned 4287 OBJECT IDENTIFIER values recorded in the SMI Numbers registry: 4289 Descriptor OBJECT IDENTIFIER Value 4290 -------------- ----------------------- 4291 docsIetfQosMIB { mib-2 xx } 4293 Editor's Note (to be removed prior to publication): the IANA is 4294 requested to assign a value for xx under the mib-2 subtree and to 4295 record the assignment in the SMI Numbers registry. When the 4296 assignment has been made, the RFC Editor is asked to replace xx (here 4297 and in the MIB module) with the assigned value and to remove this 4298 note. 4300 8. Acknowledgement 4302 Funding for the RFC Editor function is currently provided by the 4303 Internet Society. 4305 The authors gratefully acknowledge the comments and suggestions of 4306 the IP over Cable Data Network (IPCDN) Working Group (especially the 4307 co-chairs Richard Woundy & Jean-Francois Mule) as well as the 4308 contributions of the Operation and Management Area Director, Bert 4309 Wijnen. 4311 9. Normative References 4313 [1] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Structure of 4314 Management Information for Version 2 (SMIv2)", STD 58, 4315 RFC 2578, April 1999. 4317 [2] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Textual 4318 Conventions for SMIv2", STD 58, RFC 2579, April 1999. 4320 [3] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Conformance 4321 Statements for SMIv2", STD 58, RFC 2580, April 1999. 4323 [4] "Data-Over-Cable Service Interface Specifications: 4324 Radio Frequency Interface Specification SP-RFIv2.0-I06-040804", 4325 DOCSIS, August 2004, 4326 http://www.cablelabs.com/specifications/archives/. 4328 [5] Bradner, S., "Key words for use in RFCs to Indicate Requirement 4329 Levels", RFC2119, March 1997. 4331 IPCDN DOCSIS QoS MIB February 2005 4333 [6] St. Johns, M., "Cable Device Management Information Base for 4334 DOCSIS compliant Cable Modems and Cable Modem Termination 4335 Systems", RFC 2669, August 1999. 4337 ************************************************************ 4338 * NOTES TO RFC Editor (to be removed prior to publication) * 4339 * * 4340 * The I-D (or a * 4341 * successor) is expected to eventually replace RFC 2669. * 4342 * If that draft (or a successor) is published as an RFC * 4343 * prior to or concurrently with this document, then the * 4344 * normative reference [6] should be updated to * 4345 * point to the replacement RFC. * 4346 ************************************************************ 4348 [7] St. Johns, M., "Radio Frequency (RF) Interface Management 4349 Information Base for MCNS/DOCSIS compliant RF interfaces", 4350 RFC 2670, August 1999. 4352 ************************************************************ 4353 * NOTES TO RFC Editor (to be removed prior to publication) * 4354 * * 4355 * The I-D (or a * 4356 * successor) is expected to eventually replace RFC 2670. * 4357 * If that draft (or a successor) is published as an RFC * 4358 * prior to or concurrently with this document, then the * 4359 * normative reference [7] should be updated to * 4360 * point to the replacement RFC. * 4361 ************************************************************ 4363 [8] Daniele, M. et. al.,"Textual Conventions for Internet Network 4364 Addresses", RFC 3291, May 2002. 4366 ************************************************************ 4367 * NOTES TO RFC Editor (to be removed prior to publication) * 4368 * * 4369 * The I-D (or a * 4370 * successor) is expected to eventually replace RFC 3291. * 4371 * If that draft (or a successor) is published as an RFC * 4372 * prior to or concurrently with this document, then the * 4373 * normative reference [8] should be updated to * 4374 * point to the replacement RFC. * 4375 ************************************************************ 4377 [9] D. Grossman, "New Terminology and Clarifications for Diffserv", 4378 RFC 3260, April 2002. 4380 [10] Ramakrishnan, K., Floyd, S. and D. Black, "The Addition of 4381 Explicit Congestion Notification (ECN) to IP", RFC 3168, 4382 September 2001. 4384 IPCDN DOCSIS QoS MIB February 2005 4386 [11] McCloghrie, K., and F. Kastenholz, "The Interfaces Group MIB", 4387 RFC 2863, June 2000. 4389 [12] Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture 4390 for Describing Simple Network Management Protocol (SNMP) 4391 Management Frameworks", STD 62, RFC 3411, December 2002. 4393 [13] Baker, F., Chan, K., and A. Smith, "Management Information Base 4394 for the Differentiated Services Architecture", RFC 3289, 4395 May 2002. 4397 [14] Postel, J., "Internet Protocol", RFC 791, DARPA, September 1981. 4399 10. Informative References 4401 [15] Case, J., Mundy, R., Partain, D. and B. Stewart, 4402 "Introduction and Applicability Statements for 4403 Internet-Standard Management Framework", RFC 3410, 4404 December 2002. 4406 IPCDN DOCSIS QoS MIB February 2005 4408 11. Author's Address 4410 Michael Patrick 4411 Motorola Broadband Communications Sector 4412 111 Locke Drive 4413 Marlborough, MA 01752 4414 Phone: (508) 786-7563 4415 Email: michael.patrick@motorola.com 4417 William Murwin 4418 Motorola Broadband Communications Sector 4419 111 Locke Drive 4420 Marlborough, MA 01752 4421 Phone: (508) 786-7594 4422 Email: w.murwin@motorola.com 4424 IPCDN DOCSIS QoS MIB February 2005 4426 12. Disclaimer of Validity 4428 This document and the information contained herein are provided on an 4429 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS 4430 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET 4431 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, 4432 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE 4433 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED 4434 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 4436 13. Intellectual Property 4438 The IETF takes no position regarding the validity or scope of any 4439 Intellectual Property Rights or other rights that might be claimed to 4440 pertain to the implementation or use of the technology described in 4441 this document or the extent to which any license under such rights 4442 might or might not be available; nor does it represent that it has 4443 made any independent effort to identify any such rights. Information 4444 on the procedures with respect to rights in RFC documents can be 4445 found in BCP 78 and BCP 79. 4447 Copies of IPR disclosures made to the IETF Secretariat and any 4448 assurances of licenses to be made available, or the result of an 4449 attempt made to obtain a general license or permission for the use of 4450 such proprietary rights by implementers or users of this 4451 specification can be obtained from the IETF on-line IPR repository at 4452 http://www.ietf.org/ipr. 4454 The IETF invites any interested party to bring to its attention any 4455 copyrights, patents or patent applications, or other proprietary 4456 rights that may cover technology that may be required to implement 4457 this standard. Please address the information to the IETF at ietf- 4458 ipr@ietf.org. 4460 14. Copyright Statement 4462 Copyright (C) The Internet Society (2005). This document is subject 4463 to the rights, licenses and restrictions contained in BCP 78, and 4464 except as set forth therein, the authors retain all their rights.