Debian Codegraph @

rfc4323.html

raw
1 <pre>Network Working Group M. Patrick
2 Request for Comments: 4323 W. Murwin
3 Category: Standards Track Motorola BCS
4 January 2006
5
6
7 <span class="h1">Data Over Cable System Interface Specification</span>
8 <span class="h1">Quality of Service</span>
9 <span class="h1">Management Information Base (DOCSIS-QoS MIB)</span>
10
11 Status of This Memo
12
13 This document specifies an Internet standards track protocol for the
14 Internet community, and requests discussion and suggestions for
15 improvements. Please refer to the current edition of the "Internet
16 Official Protocol Standards" (STD 1) for the standardization state
17 and status of this protocol. Distribution of this memo is unlimited.
18
19 Copyright Notice
20
21 Copyright (C) The Internet Society (2006).
22
23 Abstract
24
25 This document defines a basic set of managed objects for SNMP-based
26 management of extended QoS features of Cable Modems (CMs) and Cable
27 Modem Termination Systems (CMTSs) conforming to the Data over Cable
28 System (DOCSIS) specifications versions 1.1 and 2.0.
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52 <span class="grey">Patrick &amp; Murwin Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
55
56
57 Table of Contents
58
59 <a href="#section-1">1</a>. Introduction ....................................................<a href="#page-2">2</a>
60 <a href="#section-1.1">1.1</a>. The Internet-Standard Management Framework .................<a href="#page-2">2</a>
61 <a href="#section-1.2">1.2</a>. Glossary ...................................................<a href="#page-3">3</a>
62 <a href="#section-2">2</a>. Overview ........................................................<a href="#page-5">5</a>
63 <a href="#section-2.1">2.1</a>. Textual Conventions ........................................<a href="#page-5">5</a>
64 <a href="#section-2.2">2.2</a>. MIB Organization ...........................................<a href="#page-5">5</a>
65 <a href="#section-2.2.1">2.2.1</a>. docsIetfQosPktClassTable ............................<a href="#page-9">9</a>
66 <a href="#section-2.2.2">2.2.2</a>. docsIetfQosParamSetTable ...........................<a href="#page-10">10</a>
67 <a href="#section-2.2.2.1">2.2.2.1</a>. Interoperation with DOCSIS 1.0 ............<a href="#page-11">11</a>
68 <a href="#section-2.2.3">2.2.3</a>. docsIetfQosServiceFlowTable ........................<a href="#page-12">12</a>
69 <a href="#section-2.2.4">2.2.4</a>. docsIetfQosServiceFlowStatsTable ...................<a href="#page-13">13</a>
70 <a href="#section-2.2.5">2.2.5</a>. docsIetfQosUpstreamStatsTable ......................<a href="#page-14">14</a>
71 <a href="#section-2.2.6">2.2.6</a>. docsIetfQosDynamicServiceStatsTable ................<a href="#page-14">14</a>
72 <a href="#section-2.2.7">2.2.7</a>. docsIetfQosServiceFlowLogTable .....................<a href="#page-14">14</a>
73 <a href="#section-2.2.8">2.2.8</a>. docsIetfQosServiceClassTable .......................<a href="#page-15">15</a>
74 <a href="#section-2.2.9">2.2.9</a>. docsIetfQosServiceClassPolicyTable .................<a href="#page-15">15</a>
75 <a href="#section-2.2.10">2.2.10</a>. docsIetfQosPHSTable ...............................<a href="#page-16">16</a>
76 <a href="#section-2.2.11">2.2.11</a>. docsIetfQosCmtsMacToSrvFlowTable ..................<a href="#page-16">16</a>
77 <a href="#section-3">3</a>. Externally Administered Classification .........................<a href="#page-16">16</a>
78 <a href="#section-4">4</a>. DOCSIS and IPv4 Type-of-Service (ToS) Field ....................<a href="#page-19">19</a>
79 <a href="#section-5">5</a>. Definitions ....................................................<a href="#page-20">20</a>
80 <a href="#section-6">6</a>. Security Considerations ........................................<a href="#page-84">84</a>
81 <a href="#section-7">7</a>. IANA Considerations ............................................<a href="#page-86">86</a>
82 <a href="#section-8">8</a>. Acknowledgements ...............................................<a href="#page-86">86</a>
83 <a href="#section-9">9</a>. Normative References ...........................................<a href="#page-86">86</a>
84 <a href="#section-10">10</a>. Informative References ........................................<a href="#page-87">87</a>
85
86 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
87
88 This memo is a product of the IP over Cable Data Network (IPCDN)
89 working group within the Internet Engineering Task Force (IETF).
90
91 <span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. The Internet-Standard Management Framework</span>
92
93 For a detailed overview of the documents that describe the current
94 Internet-Standard Management Framework, please refer to <a href="./rfc3410#section-7">section&nbsp;7 of
95 RFC 3410</a> [<a href="#ref-15" title="&quot;Introduction and Applicability Statements for Internet-Standard Management Framework&quot;">15</a>].
96
97 Managed objects are accessed via a virtual information store, termed
98 the Management Information Base or MIB. MIB objects are generally
99 accessed through the Simple Network Management Protocol (SNMP).
100 Objects in the MIB are defined using the mechanisms defined in the
101 Structure of Management Information (SMI). This memo specifies a MIB
102 module that is compliant to the SMIv2, which is described in STD 58,
103 <a href="./rfc2578">RFC 2578</a> [<a href="#ref-1" title="&quot;Structure of Management Information Version 2 (SMIv2)&quot;">1</a>], STD 58, <a href="./rfc2579">RFC 2579</a> [<a href="#ref-2" title="&quot;Textual Conventions for SMIv2&quot;">2</a>] and STD 58, <a href="./rfc2580">RFC 2580</a> [<a href="#ref-3" title="&quot;Conformance Statements for SMIv2&quot;">3</a>].
104
105
106
107
108 <span class="grey">Patrick &amp; Murwin Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
111
112
113 <span class="h3"><a class="selflink" id="section-1.2" href="#section-1.2">1.2</a>. Glossary</span>
114
115 Active QPS Active QoS Parameter Set (QPS). The set of QoS
116 parameters that describe the current level of service
117 provided to a Service Flow (SF).
118
119 Active SF Active Service Flow. An SF with a non-empty Active
120 QPS.
121
122 Admitted QPS Admitted QoS Parameter Set. The set of QoS
123 parameters that describe a level of service that the
124 Service Flow is not currently using, but that it is
125 guaranteed to receive upon the SF's request to make
126 the set Active.
127
128 Admitted SF A Service Flow with a non-empty Admitted QPS.
129
130 CATV Cable Television.
131
132 CM Cable Modem. A modem connecting a subscriber's LAN
133 to the Cable Television (CATV) Radio Frequency (RF)
134 network. DOCSIS CMs operate as a MAC layer bridge
135 between the home LAN and the Cable Television (CATV)
136 Radio Frequency (RF) network.
137
138 CMTS Cable Modem Termination System. The "head-end"
139 device providing connectivity between the RF network
140 and the Internet.
141
142 Downstream The direction from the head-end towards the
143 subscriber.
144
145 DSA Dynamic Service Addition. A DOCSIS MAC management
146 message requesting the dynamic creation of a new
147 Service Flow. New SFs are created with a three-
148 message exchange of a DSA-REQ, DSA-RSP, and DSA-ACK.
149
150 DSC Dynamic Service Change. A DOCSIS MAC management
151 message requesting a change to the attributes of a
152 Service Flow. SFs are changed with a three-message
153 exchange of a DSC-REQ, DSC-RSP, and DSC-ACK.
154
155 DSD Dynamic Service Delete. A DOCSIS MAC management
156 message requesting the deletion of a Service Flow.
157 SFs are deleted with a two-message exchange of a
158 DSD-REQ and DSD-ACK.
159
160
161
162
163
164 <span class="grey">Patrick &amp; Murwin Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
167
168
169 Head-end The origination point in most cable systems of the
170 subscriber video signals. It is generally also the
171 location of the CMTS.
172
173 PHS Payload Header Suppression. A feature of DOCSIS 1.1
174 and 2.0 in which header bytes that are common in a
175 sequence of packets of a Service Flow are replaced by
176 a one-byte PHSI Index (PHSI) when transmitting the
177 packet on the RF network.
178
179 primary SF Primary Service Flow. All CMs have a Primary
180 Upstream Service Flow and a Primary Downstream
181 Service Flow. They provide a default path for
182 forwarded packets that are not classified to any
183 other Service Flow.
184
185 Provisioned QPS A QoS Parameter Set describing an envelope of service
186 within which a Service Flow is authorized to request
187 admission. All existing Service Flows must have a
188 non-empty Provisioned QPS; thus, all SFs are
189 considered to be "Provisioned".
190
191 RF Radio Frequency. In particular, this abbreviation
192 refers to the radio frequencies for Cable Television
193 (CATV).
194
195 SCN Service Class Name. A named set of QoS parameters.
196 A Service Flow may or may not be associated with a
197 single named Service Class. A Service Class has as
198 an attribute a QoS Parameter Set that is used as the
199 default set of values for all Service Flows belonging
200 to the Service Class.
201
202 SID Service ID. A 16-bit unsigned integer assigned by
203 the CMTS for an Upstream Service Flow with a non-
204 empty Active QoS Parameter Set.
205
206 SF Service Flow. A unidirectional stream of packets
207 between the CM and CMTS. SFs are characterized as
208 upstream or downstream. The SF is the fundamental
209 unit of service provided on a DOCSIS CATV network.
210
211 SFID Service Flow ID. A 32-bit unsigned integer assigned
212 by the CMTS to each Service Flow.
213
214 Upstream The direction from a subscriber CM to the head-end
215 CMTS.
216
217
218
219
220 <span class="grey">Patrick &amp; Murwin Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
223
224
225 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Overview</span>
226
227 This MIB module provides a set of objects required for the management
228 of DOCSIS 1.1 and 2.0 compliant Cable Modems (CM) and Cable Modem
229 Termination Systems (CMTS). The specification is derived from the
230 DOCSIS 2.0 Radio Frequency Interface specification [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>]. Please note
231 that the referenced DOCSIS specifications only requires Cable Modems
232 to process IPv4 customer traffic. Design choices in this MIB module
233 reflect those requirements. Future versions of the DOCSIS standard
234 are expected to require support for IPv6 as well.
235
236 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
237 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
238 document are to be interpreted as described in <a href="./rfc2119">RFC 2119</a> [<a href="#ref-5" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">5</a>].
239
240 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. Textual Conventions</span>
241
242 The textual convention "DocsIetfQosRfMacIfDirection" is defined to
243 indicate the direction of a packet classifier relative to an
244 interface. It takes the values of either downstream(1) or
245 upstream(2).
246
247 The textual convention "DocsIetfQosBitRate" corresponds to the bits
248 per second as defined for QoS Parameter Sets in DOCSIS 1.1 and 2.0.
249 This definition includes all bits of the Ethernet MAC frame as
250 transmitted on the RF network, starting with the Destination Address
251 and ending with the Ethernet Frame Check Sequence (FCS). It does NOT
252 includes bits in the DOCSIS MAC header.
253
254 <span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. MIB Organization</span>
255
256 The structure of the IPCDN QoS MIB module (DOCS-IETF-QOS-MIB) is
257 summarized below:
258
259 docsIetfQosMIB
260 docsIetfQosMIBObjects
261 docsIetfQosPktClassTable
262 docsIetfQosPktClassEntry
263 docsIetfQosPktClassId
264 docsIetfQosPktClassDirection
265 docsIetfQosPktClassPriority
266 docsIetfQosPktClassIpTosLow
267 docsIetfQosPktClassIpTosHigh
268 docsIetfQosPktClassIpTosMask
269 docsIetfQosPktClassIpProtocol
270 docsIetfQosPktClassInetAddressType
271 docsIetfQosPktClassInetSourceAddr
272 docsIetfQosPktClassInetSourceMask
273
274
275
276 <span class="grey">Patrick &amp; Murwin Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
279
280
281 docsIetfQosPktClassInetDestAddr
282 docsIetfQosPktClassInetDestMask
283 docsIetfQosPktClassSourcePortStart
284 docsIetfQosPktClassSourcePortEnd
285 docsIetfQosPktClassDestPortStart
286 docsIetfQosPktClassDestPortEnd
287 docsIetfQosPktClassDestMacAddr
288 docsIetfQosPktClassDestMacMask
289 docsIetfQosPktClassSourceMacAddr
290 docsIetfQosPktClassEnetProtocolType
291 docsIetfQosPktClassEnetProtocol
292 docsIetfQosPktClassUserPriLow
293 docsIetfQosPktClassUserPriHigh
294 docsIetfQosPktClassVlanId
295 docsIetfQosPktClassStateActive
296 docsIetfQosPktClassPkts
297 docsIetfQosPktClassBitMap
298 docsIetfQosParamSetTable
299 docsIetfQosParamSetEntry
300 docsIetfQosParamSetServiceClassName
301 docsIetfQosParamSetPriority
302 docsIetfQosParamSetMaxTrafficRate
303 docsIetfQosParamSetMaxTrafficBurst
304 docsIetfQosParamSetMinReservedRate
305 docsIetfQosParamSetMinReservedPkt
306 docsIetfQosParamSetActiveTimeout
307 docsIetfQosParamSetAdmittedTimeout
308 docsIetfQosParamSetMaxConcatBurst
309 docsIetfQosParamSetSchedulingType
310 docsIetfQosParamSetNomPollInterval
311 docsIetfQosParamSetTolPollJitter
312 docsIetfQosParamSetUnsolicitGrantSize
313 docsIetfQosParamSetNomGrantInterval
314 docsIetfQosParamSetTolGrantJitter
315 docsIetfQosParamSetGrantsPerInterval
316 docsIetfQosParamSetTosAndMask
317 docsIetfQosParamSetTosOrMask
318 docsIetfQosParamSetMaxLatency
319 docsIetfQosParamSetType
320 docsIetfQosParamSetRequestPolicyOct
321 docsIetfQosParamSetBitMap
322 docsIetfQosServiceFlowTable
323 docsIetfQosServiceFlowEntry
324 docsIetfQosServiceFlowId
325 docsIetfQosServiceFlowSID
326 docsIetfQosServiceFlowDirection
327 docsIetfQosServiceFlowPrimary
328 docsIetfQosServiceFlowStatsTable
329
330
331
332 <span class="grey">Patrick &amp; Murwin Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
335
336
337 docsIetfQosServiceFlowStatsEntry
338 docsIetfQosServiceFlowPkts
339 docsIetfQosServiceFlowOctets
340 docsIetfQosServiceFlowTimeCreated
341 docsIetfQosServiceFlowTimeActive
342 docsIetfQosServiceFlowPHSUnknowns
343 docsIetfQosServiceFlowPolicedDropPkts
344 docsIetfQosServiceFlowPolicedDelayPkts
345 docsIetfQosUpstreamStatsTable
346 docsIetfQosUpstreamStatsEntry
347 docsIetfQosSID
348 docsIetfQosUpstreamFragments
349 docsIetfQosUpstreamFragDiscards
350 docsIetfQosUpstreamConcatBursts
351 docsIetfQosDynamicServiceStatsTable
352 docsIetfQosDynamicServiceStatsEntry
353 docsIetfQosIfDirection
354 docsIetfQosDSAReqs
355 docsIetfQosDSARsps
356 docsIetfQosDSAAcks
357 docsIetfQosDSCReqs
358 docsIetfQosDSCRsps
359 docsIetfQosDSCAcks
360 docsIetfQosDSDReqs
361 docsIetfQosDSDRsps
362 docsIetfQosDynamicAdds
363 docsIetfQosDynamicAddFails
364 docsIetfQosDynamicChanges
365 docsIetfQosDynamicChangeFails
366 docsIetfQosDynamicDeletes
367 docsIetfQosDynamicDeleteFails
368 docsIetfQosDCCReqs
369 docsIetfQosDCCRsps
370 docsIetfQosDCCAcks
371 docsIetfQosDCCs
372 docsIetfQosDCCFails
373 docsIetfQosServiceFlowLogTable
374 docsIetfQosServiceFlowLogEntry
375 docsIetfQosServiceFlowLogIndex
376 docsIetfQosServiceFlowLogIfIndex
377 docsIetfQosServiceFlowLogSFID
378 docsIetfQosServiceFlowLogCmMac
379 docsIetfQosServiceFlowLogPkts
380 docsIetfQosServiceFlowLogOctets
381 docsIetfQosServiceFlowLogTimeDeleted
382 docsIetfQosServiceFlowLogTimeCreated
383 docsIetfQosServiceFlowLogTimeActive
384 docsIetfQosServiceFlowLogDirection
385
386
387
388 <span class="grey">Patrick &amp; Murwin Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
391
392
393 docsIetfQosServiceFlowLogPrimary
394 docsIetfQosServiceFlowLogServiceClassName
395 docsIetfQosServiceFlowLogPolicedDropPkts
396 docsIetfQosServiceFlowLogPolicedDelayPkts
397 docsIetfQosServiceFlowLogControl
398 docsIetfQosServiceClassTable
399 docsIetfQosServiceClassEntry
400 docsIetfQosServiceClassName
401 docsIetfQosServiceClassStatus
402 docsIetfQosServiceClassMaxTrafficRate
403 docsIetfQosServiceClassMaxTrafficBurst
404 docsIetfQosServiceClassMinReservedRate
405 docsIetfQosServiceClassMinReservedPkt
406 docsIetfQosServiceClassMaxConcatBurst
407 docsIetfQosServiceClassNomPollInterval
408 docsIetfQosServiceClassTolPollJitter
409 docsIetfQosServiceClassUnsolicitGrantSize
410 docsIetfQosServiceClassNomGrantInterval
411 docsIetfQosServiceClassTolGrantJitter
412 docsIetfQosServiceClassGrantsPerInterval
413 docsIetfQosServiceClassMaxLatency
414 docsIetfQosServiceClassActiveTimeout
415 docsIetfQosServiceClassAdmittedTimeout
416 docsIetfQosServiceClassSchedulingType
417 docsIetfQosServiceClassRequestPolicy
418 docsIetfQosServiceClassTosAndMask
419 docsIetfQosServiceClassTosOrMask
420 docsIetfQosServiceClassDirection
421 docsIetfQosServiceClassStorageType
422 docsIetfQosServiceClassDSCPOverwrite
423 docsIetfQosServiceClassPolicyTable
424 docsIetfQosServiceClassPolicyEntry
425 docsIetfQosServiceClassPolicyIndex
426 docsIetfQosServiceClassPolicyName
427 docsIetfQosServiceClassPolicyRulePriority
428 docsIetfQosServiceClassPolicyStatus
429 docsIetfQosServiceClassPolicyStorageType
430 docsIetfQosPHSTable
431 docsIetfQosPHSEntry
432 docsIetfQosPHSField
433 docsIetfQosPHSMask
434 docsIetfQosPHSSize
435 docsIetfQosPHSVerify
436 docsIetfQosPHSIndex
437 docsIetfQosCmtsMacToSrvFlowTable
438 docsIetfQosCmtsMacToSrvFlowEntry
439
440
441
442
443
444 <span class="grey">Patrick &amp; Murwin Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
447
448
449 docsIetfQosCmtsCmMac
450 docsIetfQosCmtsServiceFlowId
451 docsIetfQosCmtsIfIndex
452
453 This MIB module is organized as 11 tables. Most tables are
454 implemented in both the CM and CMTS; the
455 docsIetfQosUpstreamStatsTable and docsIetfQosServiceFlowLogTable are
456 implemented on the CMTS only.
457
458 <span class="h4"><a class="selflink" id="section-2.2.1" href="#section-2.2.1">2.2.1</a>. docsIetfQosPktClassTable</span>
459
460 The docsIetfQosPktClassTable reports the Service Flow Classifiers
461 implemented by the managed device. The table is indexed by the tuple
462 { ifIndex, docsIetfQosServiceFlowId, docsIetfQosPktClassId }. The
463 ifIndex corresponds to a CATV MAC interface. Each CATV MAC interface
464 has a set of Service Flows identified with a docsIetfQosServiceFlowId
465 value that is unique for that interface. Each Service Flow may have
466 a number of packet classifiers that map packets to the flow. The
467 ClassifierId for the classifier is unique only within a particular
468 Service Flow.
469
470 The semantics of packet classification are provided in [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>]. Briefly,
471 the DOCSIS MAC interface calls for matching packets based on values
472 within the 802.2 (LLC), 802.3, IP, and/or UDP/TCP headers. Packets
473 that map more than one classifier are prioritized according to their
474 docsIetfQosPktClassPriority values. The docsIetfQosServiceFlowId (an
475 index object) indicates to which Service Flow the packet is
476 classified.
477
478 The docsIetfQosPktClassTable is distinct from the
479 docsDevIpFilterTable of [<a href="#ref-6" title="&quot;Cable Device Management Information Base for DOCSIS compliant Cable Modems and Cable Modem Termination Systems&quot;">6</a>] in that docsIetfQosPktClassTable is
480 intended only to reflect the state of the Service Flow Classifiers.
481 Service Flow Classifiers may be created only via a CM configuration
482 file or from the Dynamic Service Addition (DSA) messages. For this
483 reason, docsIetfQosPktClassTable is read-only.
484
485 The docsDevIpFilterTable is intended for external policy-based
486 administration of packet classifiers. See the section "Externally
487 Administered Classification", below.
488
489
490
491
492
493
494
495
496
497
498
499
500 <span class="grey">Patrick &amp; Murwin Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
503
504
505 <span class="h4"><a class="selflink" id="section-2.2.2" href="#section-2.2.2">2.2.2</a>. docsIetfQosParamSetTable</span>
506
507 The docsIetfQosParamSetTable reports the values of QoS Parameter Set
508 as defined in Section C.2.2 of [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>].
509
510 In general, a Service Flow is associated with three different QoS
511 Parameter Sets (QPSs): an "active" QPS, an "admitted" QPS, and a
512 "provisioned" or "authorized" QPS. The relationship of these three
513 sets is represented below:
514
515 +---------------------+
516 | Provisioned |
517 | |
518 | +---------------+ |
519 | | Admitted | |
520 | | | |
521 | | +---------+ | |
522 | | | Active | | |
523 | | | | | |
524 | | +---------+ | |
525 | | | |
526 | +---------------+ |
527 | |
528 +---------------------+
529
530 Figure 1: QoS Parameter Sets
531
532 The Provisioned QPS describes the maximum service envelope for which
533 the SF is authorized. The Admitted QPS is the set of services for
534 which a Service Flow has requested admission to the DOCSIS RF
535 network, but which is not yet active. The Admitted QPS is used
536 during the two-phase process of IP Telephony/PacketCable Service Flow
537 admission to admit the bandwidth for a bidirectional voice call when
538 the far end is ringing. Because ringing may occur for up to four
539 minutes, this permits the bandwidth to be reserved but not actually
540 consumed during this interval. The Active QPS is the set of services
541 actually being used by the Service Flow. The DOCSIS v1.1
542 specification [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>] defines what it means for a QPS envelope to be
543 "within" another. In general, an inner QPS is considered "within" an
544 outer QPS when all QoS parameters represent demands of equal or fewer
545 resources of the network.
546
547 In addition to its use as an attribute of a Service Flow, a QPS is
548 also an attribute of a Service Class. A DOCSIS CM configuration file
549 or DSA message may request the creation of a new SF and give only the
550 Service Class Name. The CMTS "expands the macro" of a Service Class
551 Name creation by populating the Provisioned, Admitted, and/or Active
552 QPSs of the Service Flow with the QPS of the Service Class Name. All
553
554
555
556 <span class="grey">Patrick &amp; Murwin Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
559
560
561 the QPSs of a Service Flow must be expansions of the same Service
562 Class, and in this case the SF is said to "belong" to the Service
563 Class. Changing the contents of a Service Class' QPS does not affect
564 the QPS of any Service Flow earlier expanded from that Service Class
565 name. Only the CMTS implements docsIetfQosServiceClassTable.
566
567 See [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>], section 8, for a full description and the theory of
568 operation of DOCSIS 1.1 QoS operation.
569
570 The docsIetfQosParamSetTable sets are indexed by { ifIndex,
571 docsIetfQosServiceFlowId, docsIetfQosParamSetType}. ifIndex
572 indicates a particular "DOCSIS MAC Domain". docsIetfQosServiceFlowId
573 uniquely identifies a Service Flow on that MAC domain. The
574 docsIetfQosParamSetType indicates whether the row describes an
575 active, admitted, or provisioned QoS Parameter Set.
576
577 The docsIetfQosParamSetTable is read-only because it indicates the
578 QoS Parameter Set contents as defined by DOCSIS signaling. The
579 docsIetfQosServiceClassTable is read-create to permit managers to
580 define a template of QoS Parameters that can be referenced by DOCSIS
581 modems when creating their QoS Parameter Sets.
582
583 <span class="h5"><a class="selflink" id="section-2.2.2.1" href="#section-2.2.2.1">2.2.2.1</a>. Interoperation with DOCSIS 1.0</span>
584
585 The DOCS-IF-MIB [<a href="#ref-7" title="&quot;Radio Frequency (RF) Interface Management Information Base for MCNS/DOCSIS compliant RF interfaces&quot;">7</a>] specifies a docsIfQosProfileTable to describe the
586 set of Class Of Service (COS) parameters associated with a COS
587 "profile". The docsIfCmServiceTable, which contains one entry per
588 SID, references this table with a docsIfCmServiceQosProfile number.
589
590 The DOCSIS 1.1 and 2.0 CM registration process allows a modem to
591 register as operating with DOCSIS 1.0, DOCSIS 1.1, or DOCSIS 2.0
592 functionality. For ease of expression, we call a modem registering
593 with DOCSIS 1.0 functionality a "DOCSIS 1.0 modem", regardless of the
594 modem's capabilities.
595
596 A CMTS or CM supporting DOCSIS 1.0, as well as DOCSIS 1.1, and/or
597 DOCSIS 2.0 implements both the tables of [<a href="#ref-7" title="&quot;Radio Frequency (RF) Interface Management Information Base for MCNS/DOCSIS compliant RF interfaces&quot;">7</a>] and the tables of this
598 MIB module. The interoperation goal is that before modem
599 registration, the DOCSIS 1.0 MIB [<a href="#ref-7" title="&quot;Radio Frequency (RF) Interface Management Information Base for MCNS/DOCSIS compliant RF interfaces&quot;">7</a>] applies. After registration,
600 either the DOCSIS 1.0 or DOCSIS 1.1/2.0 MIB applies, depending on the
601 mode with which the modem registered. The specific interoperation
602 rules are:
603
604 1. When a CM initially ranges, the CM implements a row in the
605 DOCS-IF-MIB docsIfCmServiceTable, and the CMTS implements a row
606 in the DOCS-IF-MIB docsIfCmtsServiceTable corresponding to the
607 default upstream Service ID (SID) used for pre-registration
608
609
610
611
612 <span class="grey">Patrick &amp; Murwin Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
615
616
617 upstream traffic. For historical compatibility, a row may be
618 created for the docsIfQosProfileTable with default values,
619 which may be referenced by the docsIfCmServiceTable entries.
620
621 2. Both a CMTS and CM implementing this MIB MUST NOT implement
622 docsIetfQosParamSetTable or docsIetfQosServiceFlowTable rows
623 until after the CM registers with DOCSIS 1.1 or 2.0 modem
624 operation.
625
626 3. When a modem registers with the CMTS as a "DOCSIS 1.1" or
627 "DOCSIS 2.0" modem, any exclusively-referenced row in DOCS-IF-
628 MIB docsIfQosProfileTable representing the modem's upstream QoS
629 profile for pre-registration traffic MUST be removed.
630 Multiply-referenced rows may remain. The
631 docsIfCmServiceQosProfile object in the CM's row of
632
633 docsIfCmServiceTable MUST be set to zero. The
634 docsIfCmServiceTable row for the DOCSIS 1.1 or DOCSIS 2.0 modem
635 continues to exist, and the various statistic objects in that
636 row are incremented. The CMTS should retain a
637 docsIfCmtsServiceTable entry for the DOCSIS 1.1 or DOCSIS 2.0
638 CM.
639
640 4. When a DOCSIS 1.1 or DOCSIS 2.0 modem registers, both the CMTS
641 and CM represent all Service Flows described in the modem
642 configuration file in docsIetfQosParamSetTable and
643 docsIetfQosServiceFlowTable.
644
645 5. DOCSIS 1.0 modems do not have entries in the DOCS-IETF-QOS-MIB.
646
647 <span class="h4"><a class="selflink" id="section-2.2.3" href="#section-2.2.3">2.2.3</a>. docsIetfQosServiceFlowTable</span>
648
649 The docsIetfQosServiceFlowTable provides read-only information about
650 all the Service Flows known by the device. It is indexed by the
651 combination of { ifIndex, dosQosServiceFlowId }, where ifIndex
652 corresponds to a CATV MAC interface and docsIetfQosServiceFlowId is
653 the 32-bit integer assigned by the CMTS controlling the MAC domain.
654 A CM typically has only a single CATV MAC interface, whereas a CMTS
655 may have several. See [<a href="#ref-7" title="&quot;Radio Frequency (RF) Interface Management Information Base for MCNS/DOCSIS compliant RF interfaces&quot;">7</a>] for a description of the ifIndex numbering
656 for DOCSIS devices.
657
658 The table indicates whether a given SF is in the upstream or
659 downstream direction, and whether it is the "primary" SF in that
660 direction. The primary SF carries traffic that is not otherwise
661 classified to any other SF in that direction.
662
663
664
665
666
667
668 <span class="grey">Patrick &amp; Murwin Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
671
672
673 <span class="h4"><a class="selflink" id="section-2.2.4" href="#section-2.2.4">2.2.4</a>. docsIetfQosServiceFlowStatsTable</span>
674
675 The docsIetfQosServiceFlowStatsTable provides statistics for all
676 currently existing SFs known by the managed device. It provides
677 basic packet and octet counters, as well as certain other SF-specific
678 stats such as the time at which the flow was created and how many
679 seconds it has been active.
680
681 The table also provides objects that can be used to fine-tune
682 admission control decisions; namely, the number of packets dropped or
683 delayed due to QoS policing decisions enforced by the managed device.
684
685 The model of the Service Flows stats table is that there exists a
686 Service Flow Classification function followed by a Service Flow
687 maximum rate Policing function for packets transmitted onto the
688 DOCSIS RF network, as depicted below.
689
690 +----------+
691 +------------+ clsfy 1 -----+ | Per-SF | forwarded
692 Pkts | |-----------&gt; | | Maximum |-&gt; for DOCSIS
693 -----&gt;| Classify | clsfy 2 SF1 |--&gt; | Rate | RF Network
694 | Function |-----------&gt; | | Policing | transmission
695 | | -----+ | Function |
696 | | | |----+
697 | | | | |
698 | | +----------+ Dropped
699 +------------+ | ^
700 +----+ Delayed
701
702 Packets intended for transmission onto the DOCSIS RF network
703 (upstream or downstream) are first classified to a Service Flow by
704 matching one of several possible classifiers associated with that
705 Service Flow. The docsIetfQosPktClassPkts count includes the number
706 of packets that match the classifier, regardless of the eventual
707 disposition of the packet.
708
709 DOCSIS requires that each Service Flow be policed to maintain a
710 maximum rate of transmission. This is performed by either dropping
711 or delaying a packet on that Service Flow. The
712 docsIetfQosServiceFlowPolicedDropPkts object counts the number of
713 Service Flow packets dropped by the policing function. The
714 docsIetfQosServiceFlowPolicedDelayPkts counts the number of packets
715 delayed but still forwarded. The docsIetfQosServiceFlowPkts object
716 counts the total number of packets forwarded beyond the policing
717 function intended for eventual transmission onto the DOCSIS RF
718 network. Although packets may later be dropped by other functions
719 (e.g., a transmit queue overflow on a DOCSIS hardware transmitter),
720 the docsIetfQos MIB per service-flow counters are not affected.
721
722
723
724 <span class="grey">Patrick &amp; Murwin Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
727
728
729 <span class="h4"><a class="selflink" id="section-2.2.5" href="#section-2.2.5">2.2.5</a>. docsIetfQosUpstreamStatsTable</span>
730
731 This table provides statistics that are measured only at the CMTS in
732 the upstream direction. These include counts of fragmentation
733 headers received, fragments discarded, and concatenation headers
734 received.
735
736 <span class="h4"><a class="selflink" id="section-2.2.6" href="#section-2.2.6">2.2.6</a>. docsIetfQosDynamicServiceStatsTable</span>
737
738 This table provides read-only stats on the operation of the Dynamic
739 Service state machines as specified in section 9.4 of [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>]. It
740 provides a set of 14 counters in each direction for a DOCSIS MAC
741 layer interface. That is, each DOCSIS MAC layer interface has one
742 row for downstream stats and a second row for upstream stats.
743
744 Eight of the counters are DSx packet type counts, one counter for
745 each of the eight DSx packet types. For example, the
746 docsIetfQosDSAReqs object in the upstream row at the CMTS counts the
747 number of DSA-REQ messages received by the CMTS from that interface.
748 The docsIetfQosDSAReqs object in the downstream row at the CMTS
749 counts the number of DSA-REQ messages transmitted by the CMTS on that
750 interface.
751
752 The remaining six counters per (interface, direction) combination
753 count the number of successful and unsuccessful transactions that
754 were initiated on the interface and direction. For example, the
755 upstream docsIetfQosDynamicAdds on a CMTS is the number of
756 successfully completed CM-initiated dynamic additions, because at the
757 CMTS a CM-initiated DSA starts in the upstream direction. The
758 downstream docsIetfQosDynamicAdds at a CMTS is the number of
759 successful CMTS-initiated DSA transactions.
760
761 Dynamic service transactions can fail for a number of reasons, as
762 listed in the state machines of <a href="#section-9.4">section 9.4</a>. Rather than include
763 still more counters for each different failure reason, they are
764 grouped into a single count, e.g., docsIetfQosDynamicAddFails.
765 Again, this object exists in both directions, so that locally
766 originated and remotely originated transaction failures are counted
767 separately. Further troubleshooting of transaction failures will
768 require vendor-specific queries and operation.
769
770 <span class="h4"><a class="selflink" id="section-2.2.7" href="#section-2.2.7">2.2.7</a>. docsIetfQosServiceFlowLogTable</span>
771
772 This table contains a log of the Service Flows that no longer exist
773 in the docsIetfQosServiceFlowTable. It is intended to be
774 periodically polled by traffic monitoring and billing agents. It is
775 implemented only at the CMTS.
776
777
778
779
780 <span class="grey">Patrick &amp; Murwin Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
783
784
785 It contains a chronological log of SF session statistics, including a
786 total count of packets and octets transferred on the SF. It includes
787 time stamps of the SF creation and deletion time, and of its number
788 of active seconds. The active second count is the count of seconds
789 that the SF had a non-empty Active QoS Parameter Set, i.e., it was
790 eligible to pass data. For unicast SFs, it includes the CM MAC
791 address associated with the flow for billing reference purposes.
792
793 The maximum number of log records kept by a CMTS and the duration
794 that a log record is maintained in the table are vendor-specific. An
795 explicit control object is provided so that the monitoring
796 application can explicitly delete records it has read.
797
798 <span class="h4"><a class="selflink" id="section-2.2.8" href="#section-2.2.8">2.2.8</a>. docsIetfQosServiceClassTable</span>
799
800 This table defines the Service Class Name and references a QoS
801 Parameter Set for each Service Class defined in a CMTS. It is
802 indexed by the Service Class Name string itself. The table is read-
803 create on a CMTS, and is not implemented in a CM. Each entry of the
804 docsIetfQosServiceClassTable should define a template for flows in a
805 given direction (upstream or downstream). Some parameters of the
806 docsIetfQosServiceClassTable are specific to a particular direction,
807 and so their values are not applicable when used as a template for
808 flows in the other direction.
809
810 <span class="h4"><a class="selflink" id="section-2.2.9" href="#section-2.2.9">2.2.9</a>. docsIetfQosServiceClassPolicyTable</span>
811
812 The docsIetfQosServiceClassPolicyTable can be referenced by the
813 docsDevFilterPolicyTable of [<a href="#ref-6" title="&quot;Cable Device Management Information Base for DOCSIS compliant Cable Modems and Cable Modem Termination Systems&quot;">6</a>] in order to have a "policy" that
814 classifies packets to a named Service Class. This is one mechanism
815 by which "external" entities (such as an SNMP manager) may control
816 the classification of a packet for QoS purposes. Entries are indexed
817 by a small-integer docsIetfQosServiceClassPolicyIndex. They provide
818 a Service Class Name and a Rule Priority. A policy referencing a row
819 of this table intends the packet to be forwarded on a Service Flow
820 "belonging" to the named Service Class. See <a href="#section-3">section 3</a>, "Externally
821 Administered Classification", below.
822
823 This table is implemented on both the CM and CMTS, and is read-create
824 on both.
825
826
827
828
829
830
831
832
833
834
835
836 <span class="grey">Patrick &amp; Murwin Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
839
840
841 <span class="h4"><a class="selflink" id="section-2.2.10" href="#section-2.2.10">2.2.10</a>. docsIetfQosPHSTable</span>
842
843 The Payload Header Suppression (PHS) feature of DOCSIS 1.1 and 2.0
844 permits packets to replace the unchanging bytes of the Ethernet, IP,
845 and UDP headers with a one-byte index when transmitting on the cable
846 network. This is especially useful for IP Telephony packets, where
847 such suppression can result in almost twice the number of calls
848 supported within the same upstream channel.
849
850 Each entry of the table corresponds to a PHS Rule as described in
851 section 8.4 of [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>]. The rules are identified by their corresponding
852 Service Flow ID and docsIetfQosPktClassId. A PHS rule is associated
853 with exactly one classifier. The table is therefore indexed by the
854 tuple { ifIndex, docsIetfQosServiceFlowId, docsIetfQosPktClassId}.
855
856 This table is read-only, and MUST be implemented on both the CM and
857 CMTS when PHS is supported.
858
859 <span class="h4"><a class="selflink" id="section-2.2.11" href="#section-2.2.11">2.2.11</a> docsIetfQosCmtsMacToSrvFlowTable</span>
860
861 The docsIetfQosCmtsMacToSrvFlowTable describes the mapping of CM MAC
862 addresses to the Service Flow IDs that are uniquely identified with
863 that CM. External applications may collect statistics on all packets
864 flowing through a CM by determining the SFID of all of its flows, and
865 then collecting the statistics of packets and bytes for each flow.
866
867 Downstream multicast Service Flows are not indicated in the
868 docsIetfQosCmtsMacToSrvFlowTable because they are not associated with
869 only one CM.
870
871 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Externally Administered Classification</span>
872
873 DOCSIS 1.1 and 2.0 provide rich semantics for the classification of
874 packets to Service Flows with the Service Flow Classifier table.
875 Service Flow Classifiers may be created statically in the DOCSIS CM
876 configuration file, or may be created dynamically with Dynamic
877 Service Addition (DSA) and Dynamic Service Change (DSC) DOCSIS MAC
878 messages.
879
880 Several major issues arose with the concept of externally
881 administered classification; e.g., should an external SNMP manager be
882 permitted to create classification rows? One problem was the
883 coordination of classifier IDs because such an approach would require
884 either separate classifier ID number spaces or objects to coordinate
885 both internal and external classifier ID assignments. A more serious
886 problem, however, was that external creation of SF Classifiers would
887 require "knowledge" of the individual Service Flow ID for Service
888 Flows by external applications. It was strongly felt by the
889
890
891
892 <span class="grey">Patrick &amp; Murwin Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
895
896
897 committee that SFIDs should remain internal DOCSIS objects, and not
898 be transmitted as part of protocol flows, e.g., for IP packet
899 telephony signaling. DOCSIS 1.1 introduced the concept of named
900 Service Classes for ease of administration within a domain of CMs and
901 CMTSs. What was desired was to permit external classification of
902 packets to a Service Class, not to a particular Service Flow.
903
904 The DOCSIS committee therefore decided to use the already-defined IP
905 Packet Filter Table [<a href="#ref-6" title="&quot;Cable Device Management Information Base for DOCSIS compliant Cable Modems and Cable Modem Termination Systems&quot;">6</a>] for the external classification of packets
906 for QoS purposes. The docsDevIpPacketFilterTable defines similar
907 packet matching criteria as does docsIetfQosPktClassTable, but it
908 matches a packet to an arbitrary "policy set" instead of a particular
909 Service Flow. One of the policies in the policy set then selects the
910 Service Class of the SF on which to forward the packet. The
911 docsIetfQosServiceClassPolicyTable of this MIB module defines the
912 Service Class Name to which a packet is classified.
913
914 The interaction of external and internal packet classification is
915 depicted below.
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948 <span class="grey">Patrick &amp; Murwin Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
951
952
953 |
954 | Outbound Pkt
955 V
956 docsDevIpFilterTable------&gt; docsDevFilterPolicyTable
957 | |
958 | V
959 | docsIetfQosServiceClassPolicyTable
960 | |
961 Pkt | ServiceClassName,|
962 | ServiceClassPolicyRulePriority|
963 V V
964 +--------------------------------------------------------+
965 | | DOCSIS MAC LAYER ENTITY | |
966 | | | Select |
967 | V | any |
968 | docsIetfQosPktClassTable &lt;--------------| SFID Y |
969 | | | in SCN |
970 | | docsIetfQosPktClassPriority, | |
971 | | SFID X | |
972 | V V |
973 | +--------------------------------------------+ |
974 | | Select the SFID associated with the | |
975 | | higher of docsIetfQosPktClassPriority or | |
976 | | docsIetfQosServiceClassPolicyRulePriority | |
977 | +--------------------------------------------+ |
978 | | |
979 | V |
980 | | | | | |
981 | | | ... | | Service Flows |
982 | +----+ +----+ |
983 | SFID X SFID Y |
984 +--------------------------------------------------------+
985
986 Figure 2: DOCSIS Packet Classification
987
988 The processing of an outgoing packet proceeds as follows:
989
990 1. The packet is first checked for matches with rows of the
991 docsDevIpFilterTable. If it matches, the matching row provides
992 a docsDevFilterPolicyId integer.
993
994 2. The docsDevFilterPolicyId indexes into one (or more) rows of
995 docsDevFilterPolicyTable. Each row provides an arbitrary
996 RowPointer (docsDevFilterPolicyPtr), corresponding to a policy
997 to be applied to the packet.
998
999
1000
1001
1002
1003
1004 <span class="grey">Patrick &amp; Murwin Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1007
1008
1009 3. This MIB module defines a docsIetfQosServiceClassPolicyTable
1010 whose entries may be pointed to by docsDevFilterPolicyPtr in
1011 order to classify packets administratively to a named DOCSIS
1012 Service Class. The docsIetfQosServiceClassPolicyEntry provides
1013 a Service Class Name (SCN) as docsIetfQosServiceClassPolicyName
1014 and a classification rule priority as
1015 docsIetfQosServiceClassPolicyRulePriority. These are submitted
1016 to the device's DOCSIS MAC Layer entity as a special form of
1017 the MAC_DATA.request primitive, as described in Section E.2.1
1018 of [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>].
1019
1020 4. The MAC Layer selects an SFID ("Y") of an active Service Flow
1021 belonging to the named class, choosing an SF arbitrarily if
1022 there is more than one.
1023
1024 5. The packet is then classified according to the
1025 docsIetfQosPktClassTable, which may classify the packet to a
1026 different SFID "X". Associated with the classifier is a
1027 docsIetfQosPktClassPriority.
1028
1029 6. In the event of a conflict between the SCN-determined SFID and
1030 the classified SFID, the greater of docsIetfQosPktClassPriority
1031 and docsIetfQosServiceClassPolicyRulePriority determines which
1032 SFID is selected to forward the packet.
1033
1034 A packet that does not match a docsIetfQosServiceClassPolicyEntry is
1035 directly submitted to the DOCSIS MAC layer, where the
1036 docsIetfQosPktClassTable selects the SID on which it is to be
1037 forwarded.
1038
1039 By convention (in [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>]), the "internal" docsIetfQosPktClassPriority
1040 values should be in the range 64-191, while the "external" priorities
1041 may be either in the range 192-255 to override the internal
1042 classification or in the range 0-63 to be overridden by internal
1043 classification.
1044
1045 This classification mechanism applies both upstream from the CM and
1046 downstream from the CMTS.
1047
1048 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. DOCSIS and IPv4 Type-of-Service (ToS) Field</span>
1049
1050 The DOCSIS-IETF-QOS-MIB MIB module relies on the DOCSIS MAC layer
1051 protocols and uses objects that reflect the IPv4 Type-of-Service
1052 (ToS) octet as defined in [<a href="#ref-14" title="&quot;Internet Protocol&quot;">14</a>]. The applicability of these objects
1053 is limited to the DOCSIS access network. The past and current
1054 versions of the DOCSIS specifications for which this MIB module is
1055 defined do not reflect Differentiated Services [<a href="#ref-9" title="&quot;New Terminology and Clarifications for Diffserv&quot;">9</a>] on the DOCSIS
1056 access network. However, with proper selection of values for these
1057
1058
1059
1060 <span class="grey">Patrick &amp; Murwin Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1063
1064
1065 objects, the network operator can enforce Differentiated Services
1066 Per-hop Behaviors (PHBs) on the DOCSIS Access Network, and can
1067 configure the modification of the DSCP for certain packet flows as
1068 they enter the metro network from the access network. Essentially
1069 this makes the DOCSIS access network TOS marking compatible with the
1070 wider use of DSCP outside DOCSIS networks. Note that because the
1071 entire IPv4 TOS octet may be available for modification via the
1072 latter mechanism (due to the current MAC level DOCSIS protocols and
1073 CLI interface configuration), it is possible that the DOCSIS network
1074 could be configured to modify the Explicit Congestion Notification
1075 (ECN) bits [<a href="#ref-10" title="&quot;The Addition of Explicit Congestion Notification (ECN) to IP&quot;">10</a>] of certain packets. This modification of the ECN
1076 bits is prevented by the MIB module's design. The MIB module
1077 prohibits the modification of the TOS octet (read-only objects:
1078 docsIetfQosPktClassIpTosLow, docsIetfQosPktClassIpTosHigh
1079 docsIetfQosPktClassIpTosMask, docsIetfQosParamSetTosAndMask,
1080 docsIetfQosParamSetTosOrMask) and allows the DSCP field to be
1081 modified (read-create object: docsIetfQosServiceClassDSCPOverwrite).
1082
1083 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Definitions</span>
1084
1085 This MIB module refers to the SNMPv2-SMI [<a href="#ref-1" title="&quot;Structure of Management Information Version 2 (SMIv2)&quot;">1</a>] MIB module, SNMPv2-TC
1086 [<a href="#ref-2" title="&quot;Textual Conventions for SMIv2&quot;">2</a>] MIB module, SNMPv2-CONF [<a href="#ref-3" title="&quot;Conformance Statements for SMIv2&quot;">3</a>] MIB Module, DOCSIS RFI Specification
1087 SP-RFIv2.0-I06-040804 [<a href="#ref-4" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFIv2.0-I06-040804&quot;">4</a>], INET-ADDRESS-MIB [<a href="#ref-8" title="&quot;Textual Conventions for Internet Network Addresses&quot;">8</a>] MIB module, IF-MIB
1088 [<a href="#ref-11" title="&quot;The Interfaces Group MIB&quot;">11</a>] MIB module, SNMP-FRAMEWORK-MIB [<a href="#ref-12" title="&quot;An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks&quot;">12</a>] MIB module, and DIFFSERV-
1089 DSCP-TC [<a href="#ref-13" title="&quot;Management Information Base for the Differentiated Services Architecture&quot;">13</a>] MIB module.
1090
1091 DOCS-IETF-QOS-MIB DEFINITIONS ::= BEGIN
1092
1093 IMPORTS
1094 MODULE-IDENTITY,
1095 OBJECT-TYPE,
1096 Integer32,
1097 Counter32,
1098 Unsigned32,
1099 Counter64,
1100 mib-2
1101 FROM SNMPv2-SMI
1102
1103 TEXTUAL-CONVENTION,
1104 MacAddress,
1105 RowStatus,
1106 TruthValue,
1107 TimeStamp,
1108 StorageType
1109 FROM SNMPv2-TC
1110
1111 OBJECT-GROUP,
1112 MODULE-COMPLIANCE
1113
1114
1115
1116 <span class="grey">Patrick &amp; Murwin Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1119
1120
1121 FROM SNMPv2-CONF
1122
1123 ifIndex,
1124 InterfaceIndex
1125 FROM IF-MIB
1126
1127 InetAddressType,
1128 InetAddress,
1129 InetPortNumber
1130 FROM INET-ADDRESS-MIB
1131
1132 DscpOrAny
1133 FROM DIFFSERV-DSCP-TC
1134
1135 SnmpAdminString
1136 FROM SNMP-FRAMEWORK-MIB;
1137
1138 docsIetfQosMIB MODULE-IDENTITY
1139 LAST-UPDATED "200601230000Z" -- January 23, 2006
1140 ORGANIZATION "IETF IP over Cable Data Network (IPCDN)
1141 Working Group"
1142 CONTACT-INFO
1143 "
1144 Co-Author: Michael Patrick
1145 Postal: Motorola BCS
1146 111 Locke Drive
1147 Marlborough, MA 01752-7214
1148 U.S.A.
1149 Phone: +1 508 786 7563
1150 E-mail: [email protected]
1151
1152 Co-Author: William Murwin
1153 Postal: Motorola BCS
1154 111 Locke Drive
1155 Marlborough, MA 01752-7214
1156 U.S.A.
1157 Phone: +1 508 786 7594
1158 E-mail: [email protected]
1159
1160 IETF IPCDN Working Group
1161 General Discussion: [email protected]
1162 Subscribe: <a href="http://www.ietf.org/mailman/listinfo/ipcdn">http://www.ietf.org/mailman/listinfo/ipcdn</a>
1163 Archive: <a href="ftp://ftp.ietf.org/ietf-mail-archive/ipcdn">ftp://ftp.ietf.org/ietf-mail-archive/ipcdn</a>
1164 Co-chairs: Richard Woundy, [email protected]
1165 Jean-Francois Mule, [email protected]"
1166 DESCRIPTION
1167 "This is the management information for
1168 Quality Of Service (QOS) for DOCSIS 1.1 and 2.0.
1169
1170
1171
1172 <span class="grey">Patrick &amp; Murwin Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1175
1176
1177 Copyright (C) The Internet Society (2006). This version of
1178 this MIB module is part of <a href="./rfc4323">RFC 4323</a>; see the RFC itself for
1179 full legal notices."
1180
1181 REVISION "200601230000Z" -- January 23, 2006
1182 DESCRIPTION
1183 "Initial version, published as <a href="./rfc4323">RFC 4323</a>."
1184 ::= { mib-2 127 }
1185
1186 --
1187 -- Placeholder for notifications/traps.
1188 --
1189 docsIetfQosNotifications OBJECT IDENTIFIER ::= { docsIetfQosMIB 0 }
1190
1191 docsIetfQosMIBObjects OBJECT IDENTIFIER ::= { docsIetfQosMIB 1 }
1192
1193 -- Textual Conventions
1194 DocsIetfQosRfMacIfDirection ::= TEXTUAL-CONVENTION
1195 STATUS current
1196 DESCRIPTION "Indicates a direction on an RF MAC interface.
1197
1198 The value downstream(1) is from Cable Modem
1199 Termination System to Cable Modem.
1200
1201 The value upstream(2) is from Cable Modem to
1202 Cable Modem Termination System."
1203 SYNTAX INTEGER {
1204 downstream(1),
1205 upstream(2)
1206 }
1207
1208 DocsIetfQosBitRate ::= TEXTUAL-CONVENTION
1209 DISPLAY-HINT "d"
1210 STATUS current
1211 DESCRIPTION "The rate of traffic in unit of bits per second.
1212 Used to specify traffic rate for QOS."
1213 SYNTAX Unsigned32
1214
1215 DocsIetfQosSchedulingType ::= TEXTUAL-CONVENTION
1216 STATUS current
1217 DESCRIPTION "The scheduling service provided by a CMTS for an
1218 upstream Service Flow. If the parameter is omitted
1219 from an upstream QOS Parameter Set, this object
1220 takes the value of bestEffort (2). This parameter
1221 must be reported as undefined (1) for downstream
1222 QOS Parameter Sets."
1223 SYNTAX INTEGER {
1224 undefined (1),
1225
1226
1227
1228 <span class="grey">Patrick &amp; Murwin Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1231
1232
1233 bestEffort (2),
1234 nonRealTimePollingService(3),
1235 realTimePollingService(4),
1236 unsolictedGrantServiceWithAD(5),
1237 unsolictedGrantService(6)
1238 }
1239
1240 -----------------------------------------------------------------------
1241 --
1242 -- Packet Classifier Table
1243 --
1244 docsIetfQosPktClassTable OBJECT-TYPE
1245 SYNTAX SEQUENCE OF DocsIetfQosPktClassEntry
1246 MAX-ACCESS not-accessible
1247 STATUS current
1248 DESCRIPTION "This table describes the packet classification
1249 configured on the CM or CMTS.
1250 The model is that a packet either received
1251 as input from an interface or transmitted
1252 for output on an interface may be compared
1253 against an ordered list of rules pertaining to
1254 the packet contents. Each rule is a row of this
1255 table. A matching rule provides a Service Flow
1256 ID to which the packet is classified.
1257 All rules need to match for a packet to match
1258 a classifier.
1259
1260 The objects in this row correspond to a set of
1261 Classifier Encoding parameters in a DOCSIS
1262 MAC management message. The
1263 docsIetfQosPktClassBitMap indicates which
1264 particular parameters were present in the
1265 classifier as signaled in the DOCSIS message.
1266 If the referenced parameter was not present
1267 in the signaled DOCSIS 1.1 and 2.0 Classifier, the
1268 corresponding object in this row reports a
1269 value as specified in the DESCRIPTION section."
1270 ::= { docsIetfQosMIBObjects 1 }
1271
1272
1273 docsIetfQosPktClassEntry OBJECT-TYPE
1274 SYNTAX DocsIetfQosPktClassEntry
1275 MAX-ACCESS not-accessible
1276 STATUS current
1277 DESCRIPTION "An entry in this table provides a single packet
1278 classifier rule. The index ifIndex is an ifType
1279 of docsCableMaclayer(127)."
1280 INDEX {
1281
1282
1283
1284 <span class="grey">Patrick &amp; Murwin Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1287
1288
1289 ifIndex,
1290 docsIetfQosServiceFlowId,
1291 docsIetfQosPktClassId
1292 }
1293 ::= { docsIetfQosPktClassTable 1 }
1294
1295
1296
1297 DocsIetfQosPktClassEntry ::= SEQUENCE {
1298 docsIetfQosPktClassId Unsigned32,
1299 docsIetfQosPktClassDirection DocsIetfQosRfMacIfDirection,
1300 docsIetfQosPktClassPriority Integer32,
1301 docsIetfQosPktClassIpTosLow OCTET STRING,
1302 docsIetfQosPktClassIpTosHigh OCTET STRING,
1303 docsIetfQosPktClassIpTosMask OCTET STRING,
1304 docsIetfQosPktClassIpProtocol Integer32,
1305 docsIetfQosPktClassInetAddressType InetAddressType,
1306 docsIetfQosPktClassInetSourceAddr InetAddress,
1307 docsIetfQosPktClassInetSourceMask InetAddress,
1308 docsIetfQosPktClassInetDestAddr InetAddress,
1309 docsIetfQosPktClassInetDestMask InetAddress,
1310 docsIetfQosPktClassSourcePortStart InetPortNumber,
1311 docsIetfQosPktClassSourcePortEnd InetPortNumber,
1312 docsIetfQosPktClassDestPortStart InetPortNumber,
1313 docsIetfQosPktClassDestPortEnd InetPortNumber,
1314 docsIetfQosPktClassDestMacAddr MacAddress,
1315 docsIetfQosPktClassDestMacMask MacAddress,
1316 docsIetfQosPktClassSourceMacAddr MacAddress,
1317 docsIetfQosPktClassEnetProtocolType INTEGER,
1318 docsIetfQosPktClassEnetProtocol Integer32,
1319 docsIetfQosPktClassUserPriLow Integer32,
1320 docsIetfQosPktClassUserPriHigh Integer32,
1321 docsIetfQosPktClassVlanId Integer32,
1322 docsIetfQosPktClassStateActive TruthValue,
1323 docsIetfQosPktClassPkts Counter64,
1324 docsIetfQosPktClassBitMap BITS
1325 }
1326
1327 docsIetfQosPktClassId OBJECT-TYPE
1328 SYNTAX Unsigned32 (1..65535)
1329 MAX-ACCESS not-accessible
1330 STATUS current
1331 DESCRIPTION "Index assigned to packet classifier entry by
1332 the CMTS, which is unique per Service Flow."
1333 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.3.2">Appendix C.2.1.3.2</a>"
1334 ::= { docsIetfQosPktClassEntry 1 }
1335
1336 docsIetfQosPktClassDirection OBJECT-TYPE
1337
1338
1339
1340 <span class="grey">Patrick &amp; Murwin Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1343
1344
1345 SYNTAX DocsIetfQosRfMacIfDirection
1346 MAX-ACCESS read-only
1347 STATUS current
1348 DESCRIPTION "Indicates the direction to which the classifier
1349 is applied."
1350 ::= { docsIetfQosPktClassEntry 2 }
1351
1352 docsIetfQosPktClassPriority OBJECT-TYPE
1353 SYNTAX Integer32 (0..255)
1354 MAX-ACCESS read-only
1355 STATUS current
1356 DESCRIPTION "The value specifies the order of evaluation
1357 of the classifiers.
1358
1359 The higher the value, the higher the priority.
1360 The value of 0 is used as default in
1361 provisioned Service Flows Classifiers.
1362 The default value of 64 is used for dynamic
1363 Service Flow Classifiers.
1364
1365 If the referenced parameter is not present
1366 in a classifier, this object reports the default
1367 value as defined above."
1368 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.3.5">Appendix C.2.1.3.5</a>"
1369 ::= { docsIetfQosPktClassEntry 3 }
1370
1371 docsIetfQosPktClassIpTosLow OBJECT-TYPE
1372 SYNTAX OCTET STRING (SIZE(1))
1373 MAX-ACCESS read-only
1374 STATUS current
1375 DESCRIPTION "The low value of a range of TOS byte values.
1376 If the referenced parameter is not present
1377 in a classifier, this object reports the value
1378 of 0.
1379
1380 The IP TOS octet, as originally defined in <a href="./rfc791">RFC 791</a>,
1381 has been superseded by the 6-bit Differentiated
1382 Services Field (DSField, <a href="./rfc3260">RFC 3260</a>) and the 2-bit
1383 Explicit Congestion Notification Field (ECN field,
1384 <a href="./rfc3168">RFC 3168</a>). This object is defined as an 8-bit
1385 octet as per the DOCSIS Specification
1386 for packet classification."
1387 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.1">Appendix C.2.1.5.1</a>"
1388 ::= { docsIetfQosPktClassEntry 4 }
1389
1390 docsIetfQosPktClassIpTosHigh OBJECT-TYPE
1391 SYNTAX OCTET STRING (SIZE(1))
1392 MAX-ACCESS read-only
1393
1394
1395
1396 <span class="grey">Patrick &amp; Murwin Standards Track [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1399
1400
1401 STATUS current
1402 DESCRIPTION "The 8-bit high value of a range of TOS byte
1403 values.
1404
1405 If the referenced parameter is not present
1406 in a classifier, this object reports the
1407 value of 0.
1408
1409 The IP TOS octet as originally defined in <a href="./rfc791">RFC 791</a>
1410 has been superseded by the 6-bit Differentiated
1411 Services Field (DSField, <a href="./rfc3260">RFC 3260</a>) and the 2-bit
1412 Explicit Congestion Notification Field (ECN field,
1413 <a href="./rfc3168">RFC 3168</a>). This object is defined as an 8-bit
1414 octet as defined by the DOCSIS Specification
1415 for packet classification."
1416 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.1">Appendix C.2.1.5.1</a>"
1417 ::= { docsIetfQosPktClassEntry 5 }
1418
1419 docsIetfQosPktClassIpTosMask OBJECT-TYPE
1420 SYNTAX OCTET STRING (SIZE(1))
1421 MAX-ACCESS read-only
1422 STATUS current
1423 DESCRIPTION "The mask value is bitwise ANDed with TOS byte
1424 in an IP packet, and this value is used for
1425 range checking of TosLow and TosHigh.
1426
1427 If the referenced parameter is not present
1428 in a classifier, this object reports the value
1429 of 0.
1430
1431 The IP TOS octet as originally defined in <a href="./rfc791">RFC 791</a>
1432 has been superseded by the 6-bit Differentiated
1433 Services Field (DSField, <a href="./rfc3260">RFC 3260</a>) and the 2-bit
1434 Explicit Congestion Notification Field (ECN field,
1435 <a href="./rfc3168">RFC 3168</a>). This object is defined as an 8-bit
1436 octet per the DOCSIS Specification for packet
1437 classification."
1438 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.1">Appendix C.2.1.5.1</a>"
1439 ::= { docsIetfQosPktClassEntry 6 }
1440
1441 docsIetfQosPktClassIpProtocol OBJECT-TYPE
1442 SYNTAX Integer32 (0..258)
1443 MAX-ACCESS read-only
1444 STATUS current
1445 DESCRIPTION "This object indicates the value of the IP
1446 Protocol field required for IP packets to match
1447 this rule.
1448
1449
1450
1451
1452 <span class="grey">Patrick &amp; Murwin Standards Track [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1455
1456
1457 The value 256 matches traffic with any IP Protocol
1458 value. The value 257 by convention matches both TCP
1459 and UDP.
1460
1461 If the referenced parameter is not present
1462 in a classifier, this object reports the value
1463 of 258."
1464 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.2">Appendix C.2.1.5.2</a>"
1465 ::= { docsIetfQosPktClassEntry 7 }
1466
1467 docsIetfQosPktClassInetAddressType OBJECT-TYPE
1468 SYNTAX InetAddressType
1469 MAX-ACCESS read-only
1470 STATUS current
1471 DESCRIPTION "The type of the Internet address for
1472 docsIetfQosPktClassInetSourceAddr,
1473 docsIetfQosPktClassInetSourceMask,
1474 docsIetfQosPktClassInetDestAddr, and
1475 docsIetfQosPktClassInetDestMask.
1476
1477 If the referenced parameter is not present
1478 in a classifier, this object reports the value of
1479 ipv4(1)."
1480 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.3">Appendix C.2.1.5.3</a>"
1481 ::= { docsIetfQosPktClassEntry 8 }
1482
1483 docsIetfQosPktClassInetSourceAddr OBJECT-TYPE
1484 SYNTAX InetAddress
1485 MAX-ACCESS read-only
1486 STATUS current
1487 DESCRIPTION "This object specifies the value of the IP
1488 Source Address required for packets to match
1489 this rule.
1490
1491 An IP packet matches the rule when the packet
1492 IP Source Address bitwise ANDed with the
1493 docsIetfQosPktClassInetSourceMask value equals the
1494 docsIetfQosPktClassInetSourceAddr value.
1495
1496 The address type of this object is specified by
1497 docsIetfQosPktClassInetAddressType.
1498
1499 If the referenced parameter is not present
1500 in a classifier, this object reports the value of
1501 '00000000'H."
1502 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.3">Appendix C.2.1.5.3</a>"
1503 ::= { docsIetfQosPktClassEntry 9 }
1504
1505
1506
1507
1508 <span class="grey">Patrick &amp; Murwin Standards Track [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1511
1512
1513 docsIetfQosPktClassInetSourceMask OBJECT-TYPE
1514 SYNTAX InetAddress
1515 MAX-ACCESS read-only
1516 STATUS current
1517 DESCRIPTION "This object specifies which bits of a packet's
1518 IP Source Address are compared to match
1519 this rule.
1520
1521 An IP packet matches the rule when the packet
1522 source address bitwise ANDed with the
1523 docsIetfQosPktClassInetSourceMask value equals the
1524 docsIetfQosIpPktClassInetSourceAddr value.
1525
1526 The address type of this object is specified by
1527 docsIetfQosPktClassInetAddressType.
1528
1529 If the referenced parameter is not present
1530 in a classifier, this object reports the value of
1531 'FFFFFFFF'H."
1532 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.4">Appendix C.2.1.5.4</a>"
1533 ::= { docsIetfQosPktClassEntry 10 }
1534
1535 docsIetfQosPktClassInetDestAddr OBJECT-TYPE
1536 SYNTAX InetAddress
1537 MAX-ACCESS read-only
1538 STATUS current
1539 DESCRIPTION "This object specifies the value of the IP
1540 Destination Address required for packets to match
1541 this rule.
1542
1543 An IP packet matches the rule when the packet
1544 IP Destination Address bitwise ANDed with the
1545 docsIetfQosPktClassInetDestMask value
1546 equals the docsIetfQosPktClassInetDestAddr value.
1547
1548 The address type of this object is specified by
1549 docsIetfQosPktClassInetAddressType.
1550
1551 If the referenced parameter is not present
1552 in a classifier, this object reports the value of
1553 '00000000'H."
1554 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.5">Appendix C.2.1.5.5</a>"
1555 ::= { docsIetfQosPktClassEntry 11 }
1556
1557 docsIetfQosPktClassInetDestMask OBJECT-TYPE
1558 SYNTAX InetAddress
1559 MAX-ACCESS read-only
1560 STATUS current
1561
1562
1563
1564 <span class="grey">Patrick &amp; Murwin Standards Track [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1567
1568
1569 DESCRIPTION "This object specifies which bits of a packet's
1570 IP Destination Address are compared to
1571 match this rule.
1572
1573 An IP packet matches the rule when the packet
1574 destination address bitwise ANDed with the
1575 docsIetfQosPktClassInetDestMask value equals the
1576 docsIetfQosIpPktClassInetDestAddr value.
1577
1578 The address type of this object is specified by
1579 docsIetfQosPktClassInetAddressType.
1580
1581 If the referenced parameter is not present
1582 in a classifier, this object reports the value of
1583 'FFFFFFFF'H."
1584 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.6">Appendix C.2.1.5.6</a>"
1585 ::= { docsIetfQosPktClassEntry 12 }
1586
1587 docsIetfQosPktClassSourcePortStart OBJECT-TYPE
1588 SYNTAX InetPortNumber
1589 MAX-ACCESS read-only
1590 STATUS current
1591 DESCRIPTION "This object specifies the low-end inclusive
1592 range of TCP/UDP source port numbers to which
1593 a packet is compared. This object is irrelevant
1594 for non-TCP/UDP IP packets.
1595
1596 If the referenced parameter is not present
1597 in a classifier, this object reports the value
1598 of 0."
1599 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.7">Appendix C.2.1.5.7</a>"
1600 ::= { docsIetfQosPktClassEntry 13 }
1601
1602 docsIetfQosPktClassSourcePortEnd OBJECT-TYPE
1603 SYNTAX InetPortNumber
1604 MAX-ACCESS read-only
1605 STATUS current
1606 DESCRIPTION "This object specifies the high-end inclusive
1607 range of TCP/UDP source port numbers to which
1608 a packet is compared. This object is irrelevant
1609 for non-TCP/UDP IP packets.
1610
1611 If the referenced parameter is not present
1612 in a classifier, this object reports the value of
1613 65535."
1614 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.8">Appendix C.2.1.5.8</a>"
1615 ::= { docsIetfQosPktClassEntry 14 }
1616
1617
1618
1619
1620 <span class="grey">Patrick &amp; Murwin Standards Track [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1623
1624
1625 docsIetfQosPktClassDestPortStart OBJECT-TYPE
1626 SYNTAX InetPortNumber
1627 MAX-ACCESS read-only
1628 STATUS current
1629 DESCRIPTION "This object specifies the low-end inclusive
1630 range of TCP/UDP destination port numbers to
1631 which a packet is compared.
1632
1633 If the referenced parameter is not present
1634 in a classifier, this object reports the value
1635 of 0."
1636 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.9">Appendix C.2.1.5.9</a>"
1637 ::= { docsIetfQosPktClassEntry 15 }
1638
1639 docsIetfQosPktClassDestPortEnd OBJECT-TYPE
1640 SYNTAX InetPortNumber
1641 MAX-ACCESS read-only
1642 STATUS current
1643 DESCRIPTION "This object specifies the high-end inclusive
1644 range of TCP/UDP destination port numbers to which
1645 a packet is compared.
1646
1647 If the referenced parameter is not present
1648 in a classifier, this object reports the value of
1649 65535."
1650 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.5.10">Appendix C.2.1.5.10</a>"
1651 ::= { docsIetfQosPktClassEntry 16 }
1652
1653 docsIetfQosPktClassDestMacAddr OBJECT-TYPE
1654 SYNTAX MacAddress
1655 MAX-ACCESS read-only
1656 STATUS current
1657 DESCRIPTION "An Ethernet packet matches an entry when its
1658 destination MAC address bitwise ANDed with
1659 docsIetfQosPktClassDestMacMask equals the value of
1660 docsIetfQosPktClassDestMacAddr.
1661
1662
1663 If the referenced parameter is not present
1664 in a classifier, this object reports the value of
1665 '000000000000'H."
1666 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.6.1">Appendix C.2.1.6.1</a>"
1667 ::= { docsIetfQosPktClassEntry 17 }
1668
1669 docsIetfQosPktClassDestMacMask OBJECT-TYPE
1670 SYNTAX MacAddress
1671 MAX-ACCESS read-only
1672 STATUS current
1673
1674
1675
1676 <span class="grey">Patrick &amp; Murwin Standards Track [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1679
1680
1681 DESCRIPTION "An Ethernet packet matches an entry when its
1682 destination MAC address bitwise ANDed with
1683 docsIetfQosPktClassDestMacMask equals the value of
1684 docsIetfQosPktClassDestMacAddr.
1685
1686 If the referenced parameter is not present
1687 in a classifier, this object reports the value of
1688 '000000000000'H."
1689 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.6.1">Appendix C.2.1.6.1</a>"
1690 ::= { docsIetfQosPktClassEntry 18 }
1691
1692 docsIetfQosPktClassSourceMacAddr OBJECT-TYPE
1693 SYNTAX MacAddress
1694 MAX-ACCESS read-only
1695 STATUS current
1696 DESCRIPTION "An Ethernet packet matches this entry when its
1697 source MAC address equals the value of
1698 this object.
1699
1700 If the referenced parameter is not present
1701 in a classifier, this object reports the value of
1702 'FFFFFFFFFFFF'H."
1703 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.6.2">Appendix C.2.1.6.2</a>"
1704 ::= { docsIetfQosPktClassEntry 19 }
1705
1706 docsIetfQosPktClassEnetProtocolType OBJECT-TYPE
1707 SYNTAX INTEGER {
1708 none(0),
1709 ethertype(1),
1710 dsap(2),
1711 mac(3),
1712 all(4)
1713 }
1714 MAX-ACCESS read-only
1715 STATUS current
1716 DESCRIPTION "This object indicates the format of the layer 3
1717 protocol ID in the Ethernet packet. A value of
1718 none(0) means that the rule does not use the
1719 layer 3 protocol type as a matching criteria.
1720
1721 A value of ethertype(1) means that the rule
1722 applies only to frames that contain an
1723 EtherType value. Ethertype values are contained
1724 in packets using the Dec-Intel-Xerox (DIX)
1725 encapsulation or the <a href="./rfc1042">RFC1042</a> Sub-Network Access
1726 Protocol (SNAP) encapsulation formats.
1727
1728 A value of dsap(2) means that the rule applies
1729
1730
1731
1732 <span class="grey">Patrick &amp; Murwin Standards Track [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1735
1736
1737 only to frames using the IEEE802.3
1738 encapsulation format with a Destination Service
1739 Access Point (DSAP) other
1740 than 0xAA (which is reserved for SNAP).
1741
1742 A value of mac(3) means that the rule applies
1743 only to MAC management messages for MAC management
1744 messages.
1745
1746 A value of all(4) means that the rule matches
1747 all Ethernet packets.
1748
1749 If the Ethernet frame contains an 802.1P/Q Tag
1750 header (i.e., EtherType 0x8100), this object
1751 applies to the embedded EtherType field within
1752 the 802.1P/Q header.
1753
1754 If the referenced parameter is not present in a
1755 classifier, this object reports the value of 0."
1756 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.6.3">Appendix C.2.1.6.3</a>"
1757 ::= { docsIetfQosPktClassEntry 20 }
1758
1759 docsIetfQosPktClassEnetProtocol OBJECT-TYPE
1760 SYNTAX Integer32 (0..65535)
1761 MAX-ACCESS read-only
1762 STATUS current
1763 DESCRIPTION "If docsIetfQosEthPktClassProtocolType is none(0),
1764 this object is ignored when considering whether
1765 a packet matches the current rule.
1766
1767 If dosQosPktClassEnetProtocolType is ethertype(1),
1768 this object gives the 16-bit value of the
1769 EtherType that the packet must match in order to
1770 match the rule.
1771
1772 If docsIetfQosPktClassEnetProtocolType is dsap(2),
1773 the lower 8 bits of this object's value must match
1774 the DSAP byte of the packet in order to match the
1775 rule.
1776
1777 If docsIetfQosPktClassEnetProtocolType is mac(3),
1778 the lower 8 bits of this object's value represent a
1779 lower bound (inclusive) of MAC management message
1780 type codes matched, and the upper 8 bits represent
1781 the upper bound (inclusive) of matched MAC message
1782 type codes. Certain message type codes are
1783 excluded from matching, as specified in the
1784 reference.
1785
1786
1787
1788 <span class="grey">Patrick &amp; Murwin Standards Track [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1791
1792
1793 If the Ethernet frame contains an 802.1P/Q Tag
1794 header (i.e., EtherType 0x8100), this object applies
1795 to the embedded EtherType field within the 802.1P/Q
1796 header.
1797
1798 If the referenced parameter is not present in the
1799 classifier, the value of this object is reported
1800 as 0."
1801 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.6.3">Appendix C.2.1.6.3</a>"
1802 ::= { docsIetfQosPktClassEntry 21 }
1803
1804 docsIetfQosPktClassUserPriLow OBJECT-TYPE
1805 SYNTAX Integer32 (0..7)
1806 MAX-ACCESS read-only
1807 STATUS current
1808 DESCRIPTION "This object applies only to Ethernet frames
1809 using the 802.1P/Q tag header (indicated with
1810 EtherType 0x8100). Such frames include a 16-bit
1811 Tag that contains a 3-bit Priority field and
1812 a 12-bit VLAN number.
1813
1814 Tagged Ethernet packets must have a 3-bit
1815 Priority field within the range of
1816 docsIetfQosPktClassPriLow to
1817 docsIetfQosPktClassPriHigh in order to match this
1818 rule.
1819
1820 If the referenced parameter is not present in the
1821 classifier, the value of this object is reported
1822 as 0."
1823 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.7.1">Appendix C.2.1.7.1</a>"
1824 ::= { docsIetfQosPktClassEntry 22 }
1825
1826 docsIetfQosPktClassUserPriHigh OBJECT-TYPE
1827 SYNTAX Integer32 (0..7)
1828 MAX-ACCESS read-only
1829 STATUS current
1830 DESCRIPTION "This object applies only to Ethernet frames
1831 using the 802.1P/Qtag header (indicated with
1832 EtherType 0x8100). Such frames include a 16-bit
1833 Tag that contains a 3-bit Priority field and
1834 a 12-bit VLAN number.
1835
1836 Tagged Ethernet packets must have a 3-bit
1837 Priority field within the range of
1838 docsIetfQosPktClassPriLow to
1839 docsIetfQosPktClassPriHigh in order to match this
1840 rule.
1841
1842
1843
1844 <span class="grey">Patrick &amp; Murwin Standards Track [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1847
1848
1849 If the referenced parameter is not present in the
1850 classifier, the value of this object is reported
1851 as 7."
1852 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.7.1">Appendix C.2.1.7.1</a>"
1853 ::= { docsIetfQosPktClassEntry 23 }
1854
1855 docsIetfQosPktClassVlanId OBJECT-TYPE
1856 SYNTAX Integer32 (0 | 1..4094)
1857 MAX-ACCESS read-only
1858 STATUS current
1859 DESCRIPTION "This object applies only to Ethernet frames
1860 using the 802.1P/Q tag header.
1861
1862 Tagged packets must have a VLAN Identifier that
1863 matches the value in order to match the rule.
1864
1865 If the referenced parameter is not present in the
1866 classifier, the value of this object is reported
1867 as 0."
1868 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.7.2">Appendix C.2.1.7.2</a>"
1869 ::= { docsIetfQosPktClassEntry 24 }
1870
1871 docsIetfQosPktClassStateActive OBJECT-TYPE
1872 SYNTAX TruthValue
1873 MAX-ACCESS read-only
1874 STATUS current
1875 DESCRIPTION "This object indicates whether or not the classifier
1876 is enabled to classify packets to a Service Flow.
1877
1878 If the referenced parameter is not present in the
1879 classifier, the value of this object is reported
1880 as true(1)."
1881 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.3.6">Appendix C.2.1.3.6</a>"
1882 ::= { docsIetfQosPktClassEntry 25 }
1883
1884 docsIetfQosPktClassPkts OBJECT-TYPE
1885 SYNTAX Counter64
1886 MAX-ACCESS read-only
1887 STATUS current
1888 DESCRIPTION "This object counts the number of packets that have
1889 been classified using this entry. This
1890 includes all packets delivered to a Service Flow
1891 maximum rate policing function, whether or not that
1892 function drops the packets.
1893
1894 This counter's last discontinuity is the
1895 ifCounterDiscontinuityTime for the same ifIndex that
1896 indexes this object."
1897
1898
1899
1900 <span class="grey">Patrick &amp; Murwin Standards Track [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1903
1904
1905 ::= { docsIetfQosPktClassEntry 26 }
1906
1907
1908 docsIetfQosPktClassBitMap OBJECT-TYPE
1909 SYNTAX BITS { -- Reference SP-RFIv2.0-I06-040804
1910 rulePriority(0), -- <a href="#appendix-C.2.1.3.4">Appendix C.2.1.3.4</a>
1911 activationState(1), -- <a href="#appendix-C.2.1.3.6">Appendix C.2.1.3.6</a>
1912 ipTos(2), -- <a href="#appendix-C.2.1.5.1">Appendix C.2.1.5.1</a>
1913 ipProtocol(3), -- <a href="#appendix-C.2.1.5.2">Appendix C.2.1.5.2</a>
1914 ipSourceAddr(4), -- <a href="#appendix-C.2.1.5.3">Appendix C.2.1.5.3</a>
1915 ipSourceMask(5), -- <a href="#appendix-C.2.1.5.4">Appendix C.2.1.5.4</a>
1916 ipDestAddr(6), -- <a href="#appendix-C.2.1.5.5">Appendix C.2.1.5.5</a>
1917 ipDestMask(7), -- <a href="#appendix-C.2.1.5.6">Appendix C.2.1.5.6</a>
1918 sourcePortStart(8), -- <a href="#appendix-C.2.1.5.7">Appendix C.2.1.5.7</a>
1919 sourcePortEnd(9), -- <a href="#appendix-C.2.1.5.8">Appendix C.2.1.5.8</a>
1920 destPortStart(10), -- <a href="#appendix-C.2.1.5.9">Appendix C.2.1.5.9</a>
1921 destPortEnd(11), -- <a href="#appendix-C.2.1.5.10">Appendix C.2.1.5.10</a>
1922 destMac(12), -- <a href="#appendix-C.2.1.6.1">Appendix C.2.1.6.1</a>
1923 sourceMac(13), -- <a href="#appendix-C.2.1.6.2">Appendix C.2.1.6.2</a>
1924 ethertype(14), -- <a href="#appendix-C.2.1.6.3">Appendix C.2.1.6.3</a>
1925 userPri(15), -- <a href="#appendix-C.2.1.7.1">Appendix C.2.1.7.1</a>
1926 vlanId(16) -- <a href="#appendix-C.2.1.7.2">Appendix C.2.1.7.2</a>
1927 }
1928 MAX-ACCESS read-only
1929 STATUS current
1930 DESCRIPTION
1931 "This object indicates which parameter encodings
1932 were actually present in the DOCSIS packet
1933 classifier encoding signaled in the DOCSIS message
1934 that created or modified the classifier. Note that
1935 Dynamic Service Change messages have replace
1936 semantics, so that all non-default parameters must
1937 be present whether the classifier is being created
1938 or changed.
1939
1940 A bit of this object is set to 1 if the parameter
1941 indicated by the comment was present in the
1942 classifier encoding, and to 0 otherwise.
1943
1944 Note that BITS are encoded most significant bit
1945 first, so that if, for example, bits 6 and 7 are
1946 set, this object is encoded as the octet string
1947 '030000'H."
1948 ::= { docsIetfQosPktClassEntry 27 }
1949
1950 --
1951 -- QOS Parameter Set Table
1952 --
1953
1954
1955
1956 <span class="grey">Patrick &amp; Murwin Standards Track [Page 35]</span></pre>
1957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
1958 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
1959
1960
1961 docsIetfQosParamSetTable OBJECT-TYPE
1962 SYNTAX SEQUENCE OF DocsIetfQosParamSetEntry
1963 MAX-ACCESS not-accessible
1964 STATUS current
1965 DESCRIPTION "This table describes the set of DOCSIS 1.1 and 2.0
1966 QOS parameters defined in a managed device.
1967
1968 The ifIndex index specifies a DOCSIS MAC Domain.
1969 The docsIetfQosServiceFlowId index specifies a
1970 particular Service Flow.
1971 The docsIetfQosParamSetType index indicates whether
1972 the active, admitted, or provisioned QOS Parameter
1973 Set is being described by the row.
1974
1975 Only the QOS Parameter Sets of DOCSIS 1.1 and 2.0
1976 Service Flows are represented in this table.
1977
1978 DOCSIS 1.0 QOS service profiles are not
1979 represented in this table.
1980
1981 Each row corresponds to a DOCSIS QOS Parameter Set
1982 as signaled via DOCSIS MAC management messages.
1983 Each object in the row corresponds to one or
1984 part of one DOCSIS 1.1 Service Flow Encoding.
1985 The docsIetfQosParamSetBitMap object in the row
1986 indicates which particular parameters were signaled
1987 in the original registration or dynamic service
1988 request message that created the QOS Parameter Set.
1989
1990 In many cases, even if a QOS Parameter Set parameter
1991 was not signaled, the DOCSIS specification calls
1992 for a default value to be used. That default value
1993 is reported as the value of the corresponding object
1994 in this row.
1995
1996 Many objects are not applicable, depending on
1997 the Service Flow direction or upstream scheduling
1998 type. The object value reported in this case
1999 is specified in the DESCRIPTION clause."
2000 ::= { docsIetfQosMIBObjects 2 }
2001
2002 docsIetfQosParamSetEntry OBJECT-TYPE
2003 SYNTAX DocsIetfQosParamSetEntry
2004 MAX-ACCESS not-accessible
2005 STATUS current
2006 DESCRIPTION "A unique set of QOS parameters."
2007 INDEX {
2008 ifIndex, docsIetfQosServiceFlowId, docsIetfQosParamSetType
2009
2010
2011
2012 <span class="grey">Patrick &amp; Murwin Standards Track [Page 36]</span></pre>
2013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
2014 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2015
2016
2017 }
2018 ::= { docsIetfQosParamSetTable 1 }
2019
2020 DocsIetfQosParamSetEntry ::= SEQUENCE {
2021 docsIetfQosParamSetServiceClassName SnmpAdminString,
2022 docsIetfQosParamSetPriority Integer32,
2023 docsIetfQosParamSetMaxTrafficRate DocsIetfQosBitRate,
2024 docsIetfQosParamSetMaxTrafficBurst Unsigned32,
2025 docsIetfQosParamSetMinReservedRate DocsIetfQosBitRate,
2026 docsIetfQosParamSetMinReservedPkt Integer32,
2027 docsIetfQosParamSetActiveTimeout Integer32,
2028 docsIetfQosParamSetAdmittedTimeout Integer32,
2029 docsIetfQosParamSetMaxConcatBurst Integer32,
2030 docsIetfQosParamSetSchedulingType DocsIetfQosSchedulingType,
2031 docsIetfQosParamSetNomPollInterval Unsigned32,
2032 docsIetfQosParamSetTolPollJitter Unsigned32,
2033 docsIetfQosParamSetUnsolicitGrantSize Integer32,
2034 docsIetfQosParamSetNomGrantInterval Unsigned32,
2035 docsIetfQosParamSetTolGrantJitter Unsigned32,
2036 docsIetfQosParamSetGrantsPerInterval Integer32,
2037 docsIetfQosParamSetTosAndMask OCTET STRING,
2038 docsIetfQosParamSetTosOrMask OCTET STRING,
2039 docsIetfQosParamSetMaxLatency Unsigned32,
2040 docsIetfQosParamSetType INTEGER,
2041 docsIetfQosParamSetRequestPolicyOct OCTET STRING,
2042 docsIetfQosParamSetBitMap BITS
2043 }
2044
2045 docsIetfQosParamSetServiceClassName OBJECT-TYPE
2046 SYNTAX SnmpAdminString
2047 MAX-ACCESS read-only
2048 STATUS current
2049 DESCRIPTION "Refers to the Service Class Name from which the
2050 parameter set values were derived.
2051
2052 If the referenced parameter is not present in the
2053 corresponding DOCSIS QOS Parameter Set, the default
2054 value of this object is a zero-length string."
2055 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.3.4">Appendix C.2.2.3.4</a>"
2056 ::= { docsIetfQosParamSetEntry 1 }
2057
2058 docsIetfQosParamSetPriority OBJECT-TYPE
2059 SYNTAX Integer32 (0..7)
2060 MAX-ACCESS read-only
2061 STATUS current
2062 DESCRIPTION "The relative priority of a Service Flow.
2063 Higher numbers indicate higher priority.
2064 This priority should only be used to differentiate
2065
2066
2067
2068 <span class="grey">Patrick &amp; Murwin Standards Track [Page 37]</span></pre>
2069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
2070 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2071
2072
2073 Service Flow from identical parameter sets.
2074
2075 If the referenced parameter is not present in the
2076 corresponding DOCSIS QOS Parameter Set, the default
2077 value of this object is 0. If the parameter is
2078 not applicable, the reported value is 0."
2079 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.5.1">Appendix C.2.2.5.1</a>"
2080 ::= { docsIetfQosParamSetEntry 2 }
2081
2082 docsIetfQosParamSetMaxTrafficRate OBJECT-TYPE
2083 SYNTAX DocsIetfQosBitRate
2084 MAX-ACCESS read-only
2085 STATUS current
2086 DESCRIPTION "Maximum sustained traffic rate allowed for this
2087 Service Flow in bits/sec. Must count all MAC frame
2088 data PDU from the bytes following the MAC header
2089 HCS to the end of the CRC. The number of bytes
2090 forwarded is limited during any time interval.
2091 The value 0 means no maximum traffic rate is
2092 enforced. This object applies to both upstream and
2093 downstream Service Flows.
2094
2095 If the referenced parameter is not present in the
2096 corresponding DOCSIS QOS Parameter Set, the default
2097 value of this object is 0. If the parameter is
2098 not applicable, it is reported as 0."
2099 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.5.2">Appendix C.2.2.5.2</a>"
2100 ::= { docsIetfQosParamSetEntry 3 }
2101
2102 docsIetfQosParamSetMaxTrafficBurst OBJECT-TYPE
2103 SYNTAX Unsigned32
2104 MAX-ACCESS read-only
2105 STATUS current
2106 DESCRIPTION "Specifies the token bucket size in bytes
2107 for this parameter set. The value is calculated
2108 from the byte following the MAC header HCS to
2109 the end of the CRC. This object is applied in
2110 conjunction with docsIetfQosParamSetMaxTrafficRate
2111 to calculate maximum sustained traffic rate.
2112
2113 If the referenced parameter is not present in the
2114 corresponding DOCSIS QOS Parameter Set, the default
2115 value of this object for scheduling types
2116 bestEffort (2), nonRealTimePollingService(3),
2117 and realTimePollingService(4) is 3044.
2118
2119 If this parameter is not applicable, it is reported
2120 as 0.
2121
2122
2123
2124 <span class="grey">Patrick &amp; Murwin Standards Track [Page 38]</span></pre>
2125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
2126 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2127
2128
2129 "
2130 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.5.3">Appendix C.2.2.5.3</a>"
2131 ::= { docsIetfQosParamSetEntry 4 }
2132
2133 docsIetfQosParamSetMinReservedRate OBJECT-TYPE
2134 SYNTAX DocsIetfQosBitRate
2135 MAX-ACCESS read-only
2136 STATUS current
2137 DESCRIPTION "Specifies the guaranteed minimum rate in
2138 bits/sec for this parameter set. The value is
2139 calculated from the byte following the MAC
2140 header HCS to the end of the CRC. The default
2141 value of 0 means that no bandwidth is reserved.
2142
2143 If the referenced parameter is not present in the
2144 corresponding DOCSIS QOS Parameter Set, the default
2145 value of this object is 0. If the parameter
2146 is not applicable, it is reported as 0."
2147 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.5.4">Appendix C.2.2.5.4</a>"
2148 ::= { docsIetfQosParamSetEntry 5 }
2149
2150 docsIetfQosParamSetMinReservedPkt OBJECT-TYPE
2151 SYNTAX Integer32 (0..65535)
2152 MAX-ACCESS read-only
2153 STATUS current
2154 DESCRIPTION "Specifies an assumed minimum packet size in
2155 bytes for which the
2156 docsIetfQosParamSetMinReservedRate will be
2157 provided. The value is calculated from the byte
2158 following the MAC header HCS to the end of the
2159 CRC.
2160
2161 If the referenced parameter is omitted from a
2162 DOCSIS QOS parameter set, the default value is
2163 CMTS implementation dependent. In this case, the
2164 CMTS reports the default value it is using, and the
2165 CM reports a value of 0. If the referenced
2166 parameter is not applicable to the direction or
2167 scheduling type of the Service Flow, both CMTS and
2168 CM report this object's value as 0."
2169 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.5.5">Appendix C.2.2.5.5</a>"
2170 ::= { docsIetfQosParamSetEntry 6 }
2171
2172 docsIetfQosParamSetActiveTimeout OBJECT-TYPE
2173 SYNTAX Integer32 (0..65535)
2174 UNITS "seconds"
2175 MAX-ACCESS read-only
2176 STATUS current
2177
2178
2179
2180 <span class="grey">Patrick &amp; Murwin Standards Track [Page 39]</span></pre>
2181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
2182 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2183
2184
2185 DESCRIPTION "Specifies the maximum duration in seconds that
2186 resources remain unused on an active service
2187 flow before CMTS signals that both active and
2188 admitted parameters set are null. The default
2189 value of 0 signifies an infinite amount of time.
2190
2191 If the referenced parameter is not present in the
2192 corresponding DOCSIS QOS Parameter Set, the default
2193 value of this object is 0."
2194 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.5.6">Appendix C.2.2.5.6</a>"
2195 ::= { docsIetfQosParamSetEntry 7 }
2196
2197 docsIetfQosParamSetAdmittedTimeout OBJECT-TYPE
2198 SYNTAX Integer32 (0..65535)
2199 UNITS "seconds"
2200 MAX-ACCESS read-only
2201 STATUS current
2202 DESCRIPTION "Specifies the maximum duration in seconds that
2203 resources remain in admitted state before
2204 resources must be released.
2205
2206 The value of 0 signifies an infinite amount
2207 of time.
2208
2209 If the referenced parameter is not present in the
2210 corresponding DOCSIS QOS Parameter Set, the
2211 default value of this object is 200.
2212 "
2213
2214 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.5.7">Appendix C.2.2.5.7</a>"
2215 DEFVAL { 200 }
2216 ::= { docsIetfQosParamSetEntry 8 }
2217
2218 docsIetfQosParamSetMaxConcatBurst OBJECT-TYPE
2219 SYNTAX Integer32 (0..65535)
2220 MAX-ACCESS read-only
2221 STATUS current
2222 DESCRIPTION "Specifies the maximum concatenated burst in
2223 bytes that an upstream Service Flow is allowed.
2224 The value is calculated from the FC byte of the
2225 Concatenation MAC Header to the last CRC byte in
2226 of the last concatenated MAC frame, inclusive.
2227 The value of 0 specifies no maximum burst.
2228
2229 If the referenced parameter is not present in the
2230 corresponding DOCSIS QOS Parameter Set, the default
2231 value of this object for scheduling types
2232 bestEffort(2), nonRealTimePollingService(3), and
2233
2234
2235
2236 <span class="grey">Patrick &amp; Murwin Standards Track [Page 40]</span></pre>
2237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
2238 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2239
2240
2241 realTimePollingService(4) is 1522. If the parameter
2242 is not applicable, this object's value is reported
2243 as 0."
2244 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.1">Appendix C.2.2.6.1</a>"
2245 ::= { docsIetfQosParamSetEntry 9 }
2246
2247
2248 docsIetfQosParamSetSchedulingType OBJECT-TYPE
2249 SYNTAX DocsIetfQosSchedulingType
2250 MAX-ACCESS read-only
2251 STATUS current
2252 DESCRIPTION "Specifies the upstream scheduling service used for
2253 upstream Service Flow.
2254
2255 If the referenced parameter is not present in the
2256 corresponding DOCSIS QOS Parameter Set of an
2257 upstream Service Flow, the default value of this
2258 object is bestEffort(2). For QOS parameter sets of
2259 downstream Service Flows, this object's value is
2260 reported as undefined(1)."
2261 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.2">Appendix C.2.2.6.2</a>"
2262 ::= { docsIetfQosParamSetEntry 10 }
2263
2264 docsIetfQosParamSetNomPollInterval OBJECT-TYPE
2265 SYNTAX Unsigned32
2266 UNITS "microseconds"
2267 MAX-ACCESS read-only
2268 STATUS current
2269 DESCRIPTION "Specifies the nominal interval in microseconds
2270 between successive unicast request
2271 opportunities on an upstream Service Flow.
2272
2273 This object applies only to upstream Service Flows
2274 with DocsIetfQosSchedulingType of value
2275 nonRealTimePollingService(3),
2276 realTimePollingService(4), and
2277 unsolictedGrantServiceWithAD(5). The parameter is
2278 mandatory for realTimePollingService(4). If the
2279 parameter is omitted with
2280 nonRealTimePollingService(3), the CMTS uses an
2281 implementation-dependent value. If the parameter
2282 is omitted with unsolictedGrantServiceWithAD(5),
2283 the CMTS uses as a default value the value of the
2284 Nominal Grant Interval parameter. In all cases,
2285 the CMTS reports the value it is using when the
2286 parameter is applicable. The CM reports the
2287 signaled parameter value if it was signaled,
2288 and 0 otherwise.
2289
2290
2291
2292 <span class="grey">Patrick &amp; Murwin Standards Track [Page 41]</span></pre>
2293 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
2294 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2295
2296
2297 If the referenced parameter is not applicable to
2298 the direction or scheduling type of the
2299 corresponding DOCSIS QOS Parameter Set, both
2300 CMTS and CM report this object's value as 0."
2301 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.4">Appendix C.2.2.6.4</a>"
2302 ::= { docsIetfQosParamSetEntry 11 }
2303
2304 docsIetfQosParamSetTolPollJitter OBJECT-TYPE
2305 SYNTAX Unsigned32
2306 UNITS "microseconds"
2307 MAX-ACCESS read-only
2308 STATUS current
2309 DESCRIPTION "Specifies the maximum amount of time in
2310 microseconds that the unicast request interval
2311 may be delayed from the nominal periodic
2312 schedule on an upstream Service Flow.
2313
2314 This parameter is applicable only to upstream
2315 Service Flows with a DocsIetfQosSchedulingType of
2316 realTimePollingService(4) or
2317 unsolictedGrantServiceWithAD(5).
2318
2319 If the referenced parameter is applicable but not
2320 present in the corresponding DOCSIS QOS Parameter
2321 Set, the CMTS uses an implementation-dependent
2322 value and reports the value it is using.
2323 The CM reports a value of 0 in this case.
2324
2325 If the parameter is not applicable to the
2326 direction or upstream scheduling type of the
2327 Service Flow, both CMTS and CM report this
2328 object's value as 0."
2329 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.5">Appendix C.2.2.6.5</a>"
2330 ::= { docsIetfQosParamSetEntry 12 }
2331
2332 docsIetfQosParamSetUnsolicitGrantSize OBJECT-TYPE
2333 SYNTAX Integer32 (0..65535)
2334 MAX-ACCESS read-only
2335 STATUS current
2336 DESCRIPTION "Specifies the unsolicited grant size in bytes.
2337 The grant size includes the entire MAC frame
2338 data PDU from the Frame Control byte to the end
2339 of the MAC frame.
2340
2341 The referenced parameter is applicable only
2342 for upstream flows with a DocsIetfQosSchedulingType
2343 of unsolicitedGrantServicewithAD(5) or
2344 unsolicitedGrantService(6), and it is mandatory
2345
2346
2347
2348 <span class="grey">Patrick &amp; Murwin Standards Track [Page 42]</span></pre>
2349 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
2350 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2351
2352
2353 when applicable. Both CMTS and CM report
2354 the signaled value of the parameter in this
2355 case.
2356
2357 If the referenced parameter is not applicable to
2358 the direction or scheduling type of the
2359 corresponding DOCSIS QOS Parameter Set, both
2360 CMTS and CM report this object's value as 0."
2361 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.6">Appendix C.2.2.6.6</a>"
2362 ::= { docsIetfQosParamSetEntry 13 }
2363
2364 docsIetfQosParamSetNomGrantInterval OBJECT-TYPE
2365 SYNTAX Unsigned32
2366 UNITS "microseconds"
2367 MAX-ACCESS read-only
2368 STATUS current
2369 DESCRIPTION "Specifies the nominal interval in microseconds
2370 between successive data grant opportunities
2371 on an upstream Service Flow.
2372
2373 The referenced parameter is applicable only
2374 for upstream flows with a DocsIetfQosSchedulingType
2375 of unsolicitedGrantServicewithAD(5) or
2376 unsolicitedGrantService(6), and it is mandatory
2377 when applicable. Both CMTS and CM report the
2378 signaled value of the parameter in this case.
2379
2380 If the referenced parameter is not applicable to
2381 the direction or scheduling type of the
2382 corresponding DOCSIS QOS Parameter Set, both
2383 CMTS and CM report this object's value as 0."
2384 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.7">Appendix C.2.2.6.7</a>"
2385 ::= { docsIetfQosParamSetEntry 14 }
2386
2387 docsIetfQosParamSetTolGrantJitter OBJECT-TYPE
2388 SYNTAX Unsigned32
2389 UNITS "microseconds"
2390 MAX-ACCESS read-only
2391 STATUS current
2392 DESCRIPTION "Specifies the maximum amount of time in
2393 microseconds that the transmission opportunities
2394 may be delayed from the nominal periodic schedule.
2395
2396 The referenced parameter is applicable only
2397 for upstream flows with a DocsIetfQosSchedulingType
2398 of unsolicitedGrantServicewithAD(5) or
2399 unsolicitedGrantService(6), and it is mandatory
2400 when applicable. Both CMTS and CM report the
2401
2402
2403
2404 <span class="grey">Patrick &amp; Murwin Standards Track [Page 43]</span></pre>
2405 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
2406 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2407
2408
2409 signaled value of the parameter in this case.
2410
2411 If the referenced parameter is not applicable to
2412 the direction or scheduling type of the
2413 corresponding DOCSIS QOS Parameter Set, both
2414 CMTS and CM report this object's value as 0."
2415 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.8">Appendix C.2.2.6.8</a>"
2416 ::= { docsIetfQosParamSetEntry 15 }
2417
2418 docsIetfQosParamSetGrantsPerInterval OBJECT-TYPE
2419 SYNTAX Integer32 (0..127)
2420 MAX-ACCESS read-only
2421 STATUS current
2422 DESCRIPTION "Specifies the number of data grants per Nominal
2423 Grant Interval
2424 (docsIetfQosParamSetNomGrantInterval).
2425
2426 The referenced parameter is applicable only
2427 for upstream flows with a DocsIetfQosSchedulingType
2428 of unsolicitedGrantServicewithAD(5) or
2429 unsolicitedGrantService(6), and it is mandatory
2430 when applicable. Both CMTS and CM report the
2431 signaled value of the parameter in this case.
2432
2433 If the referenced parameter is not applicable to
2434 the direction or scheduling type of the
2435 corresponding DOCSIS QOS Parameter Set, both
2436 CMTS and CM report this object's value as 0."
2437 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.9">Appendix C.2.2.6.9</a>"
2438 ::= { docsIetfQosParamSetEntry 16 }
2439
2440 docsIetfQosParamSetTosAndMask OBJECT-TYPE
2441 SYNTAX OCTET STRING (SIZE(1))
2442 MAX-ACCESS read-only
2443 STATUS current
2444 DESCRIPTION "Specifies the AND mask for the IP TOS byte for
2445 overwriting IP packet's TOS value. The IP packet
2446 TOS byte is bitwise ANDed with
2447 docsIetfQosParamSetTosAndMask, and the result is
2448 bitwise ORed with docsIetfQosParamSetTosORMask and
2449 the result is written to the IP packet TOS byte.
2450 A value of 'FF'H for docsIetfQosParamSetTosAndMask
2451 and a value of '00'H for
2452 docsIetfQosParamSetTosOrMask means that the IP
2453 Packet TOS byte is not overwritten.
2454
2455 This combination is reported if the referenced
2456 parameter is not present in a QOS Parameter Set.
2457
2458
2459
2460 <span class="grey">Patrick &amp; Murwin Standards Track [Page 44]</span></pre>
2461 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
2462 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2463
2464
2465 The IP TOS octet as originally defined in <a href="./rfc791">RFC 791</a>
2466 has been superseded by the 6-bit Differentiated
2467 Services Field (DSField, <a href="./rfc3260">RFC 3260</a>) and the 2-bit
2468 Explicit Congestion Notification Field (ECN field,
2469 <a href="./rfc3168">RFC 3168</a>). Network operators SHOULD avoid
2470 specifying values of docsIetfQosParamSetTosAndMask
2471 and docsIetfQosParamSetTosORMask that would result
2472 in the modification of the ECN bits.
2473
2474 In particular, operators should not use values of
2475 docsIetfQosParamSetTosAndMask that have either of
2476 the least-significant two bits set to 0. Similarly,
2477 operators should not use values of
2478 docsIetfQosParamSetTosORMask that have either of
2479 the least-significant two bits set to 1.
2480
2481 Even though this object is only enforced by the
2482 Cable Modem Termination System (CMTS),
2483 Cable Modems MUST report the value as signaled in
2484 the referenced parameter."
2485 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.10">Appendix C.2.2.6.10</a>;
2486 <a href="./rfc3168">RFC 3168</a>, The Addition of Explicit Congestion
2487 Notification (ECN) to IP;
2488 <a href="./rfc3260">RFC 3260</a>, New Terminology and Clarifications for
2489 Diffserv."
2490 ::= { docsIetfQosParamSetEntry 17 }
2491
2492 docsIetfQosParamSetTosOrMask OBJECT-TYPE
2493 SYNTAX OCTET STRING (SIZE(1))
2494 MAX-ACCESS read-only
2495 STATUS current
2496 DESCRIPTION "Specifies the OR mask for the IP TOS byte.
2497
2498 See the description of docsIetfQosParamSetTosAndMask
2499 for further details.
2500
2501 The IP TOS octet as originally defined in <a href="./rfc791">RFC 791</a>
2502 has been superseded by the 6-bit Differentiated
2503 Services Field (DSField, <a href="./rfc3260">RFC 3260</a>) and the 2-bit
2504 Explicit Congestion Notification Field (ECN field,
2505 <a href="./rfc3168">RFC 3168</a>). Network operators SHOULD avoid
2506 specifying values of docsIetfQosParamSetTosAndMask
2507 and docsIetfQosParamSetTosORMask that would result
2508 in the modification of the ECN bits."
2509 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.10">Appendix C.2.2.6.10</a>;
2510 <a href="./rfc3168">RFC 3168</a>, The Addition of Explicit Congestion
2511 Notification (ECN) to IP;
2512 <a href="./rfc3260">RFC 3260</a>, New Terminology and Clarifications for
2513
2514
2515
2516 <span class="grey">Patrick &amp; Murwin Standards Track [Page 45]</span></pre>
2517 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
2518 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2519
2520
2521 Diffserv."
2522 ::= { docsIetfQosParamSetEntry 18 }
2523
2524 docsIetfQosParamSetMaxLatency OBJECT-TYPE
2525 SYNTAX Unsigned32
2526 UNITS "microseconds"
2527 MAX-ACCESS read-only
2528 STATUS current
2529 DESCRIPTION "Specifies the maximum latency between the
2530 reception of a packet by the CMTS on its NSI
2531 and the forwarding of the packet to the RF
2532 interface. A value of 0 signifies no maximum
2533 latency is enforced. This object only applies to
2534 downstream Service Flows.
2535
2536 If the referenced parameter is not present in the
2537 corresponding downstream DOCSIS QOS Parameter Set,
2538 the default value is 0. This parameter is
2539 not applicable to upstream DOCSIS QOS Parameter
2540 Sets, and its value is reported as 0 in this case."
2541 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.7.1">Appendix C.2.2.7.1</a>"
2542 ::= { docsIetfQosParamSetEntry 19 }
2543
2544
2545 docsIetfQosParamSetType OBJECT-TYPE
2546 SYNTAX INTEGER {
2547 active (1),
2548 admitted (2),
2549 provisioned (3)
2550 }
2551 MAX-ACCESS not-accessible
2552 STATUS current
2553 DESCRIPTION "Defines the type of the QOS parameter set defined
2554 by this row. active(1) indicates the Active QOS
2555 parameter set, describing the service currently
2556 being provided by the DOCSIS MAC domain to the
2557 Service Flow. admitted(2) indicates the Admitted
2558 QOS Parameter Set, describing services reserved by
2559 the DOCSIS MAC domain for use by the service
2560 flow. provisioned (3) describes the QOS Parameter
2561 Set defined in the DOCSIS CM Configuration file for
2562 the Service Flow."
2563 REFERENCE "SP-RFIv2.0-I06-040804, 8.1.5"
2564 ::= { docsIetfQosParamSetEntry 20 }
2565
2566 docsIetfQosParamSetRequestPolicyOct OBJECT-TYPE
2567 SYNTAX OCTET STRING (SIZE(4))
2568 -- A 32-bit mask represented most significant byte
2569
2570
2571
2572 <span class="grey">Patrick &amp; Murwin Standards Track [Page 46]</span></pre>
2573 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
2574 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2575
2576
2577 -- first. The 32-bit integer represented in this
2578 -- manner equals the binary value of the referenced
2579 -- integer parameter of the DOCSIS RFI
2580 -- specification.
2581 -- The BITS syntax is not used in order to avoid
2582 -- the confusion caused by different bit-numbering
2583 -- conventions.
2584 MAX-ACCESS read-only
2585 STATUS current
2586 DESCRIPTION "Specifies which transmit interval opportunities
2587 the CM omits for upstream transmission requests and
2588 packet transmissions. This object takes its
2589 default value for downstream Service Flows.
2590
2591 Unless otherwise indicated, a bit value of 1 means
2592 that a CM must not use that opportunity for
2593 upstream transmission.
2594
2595 If bit 0 is the least significant bit of the
2596 least significant (4th) octet, and if bit number
2597 is increased with significance, the bit definitions
2598 are defined as follows:
2599
2600 broadcastReqOpp(0):
2601 all CMs broadcast request opportunities
2602
2603 priorityReqMulticastReq(1):
2604 priority request multicast request
2605 opportunities
2606
2607 reqDataForReq(2):
2608 request/data opportunities for requests
2609
2610 reqDataForData(3):
2611 request/data opportunities for data
2612
2613 piggybackReqWithData(4):
2614 piggyback requests with data
2615
2616 concatenateData(5):
2617 concatenate data
2618
2619 fragmentData(6):
2620 fragment data
2621
2622 suppresspayloadheaders(7):
2623 suppress payload headers
2624
2625
2626
2627
2628 <span class="grey">Patrick &amp; Murwin Standards Track [Page 47]</span></pre>
2629 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
2630 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2631
2632
2633 dropPktsExceedUGSize(8):
2634 A value of 1 means that the Service Flow must
2635 drop packets that do not fit in the Unsolicited
2636 Grant size.
2637
2638 If the referenced parameter is not present in
2639 a QOS Parameter Set, the value of this object is
2640 reported as '00000000'H."
2641 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.3">Appendix C.2.2.6.3</a>"
2642 ::= { docsIetfQosParamSetEntry 21 }
2643
2644 docsIetfQosParamSetBitMap OBJECT-TYPE
2645 -- Each bit corresponds to a parameter
2646 -- from SP-RFI-v1.1-I10-037030,
2647 -- <a href="#appendix-C">Appendix C</a> in the indicated
2648 SYNTAX BITS { -- section number.
2649 trafficPriority(0), -- C.2.2.5.1
2650 maxTrafficRate(1), -- C.2.2.5.2
2651 maxTrafficBurst(2), -- C.2.2.5.3
2652 minReservedRate(3), -- C.2.2.5.4
2653 minReservedPkt(4), -- C.2.2.5.5
2654 activeTimeout(5), -- C.2.2.5.6
2655 admittedTimeout(6), -- C.2.2.5.7
2656 maxConcatBurst(7), -- C.2.2.6.1
2657 schedulingType(8), -- C.2.2.6.2
2658 requestPolicy(9), -- C.2.2.6.3
2659 nomPollInterval(10), -- C.2.2.6.4
2660 tolPollJitter(11), -- C.2.2.6.5
2661 unsolicitGrantSize(12), -- C.2.2.6.6
2662 nomGrantInterval(13), -- C.2.2.6.7
2663 tolGrantJitter(14), -- C.2.2.6.8
2664 grantsPerInterval(15), -- C.2.2.6.9
2665 tosOverwrite(16), -- C.2.2.6.10
2666 maxLatency(17) -- C.2.2.7.1
2667 }
2668 MAX-ACCESS read-only
2669 STATUS current
2670 DESCRIPTION "This object indicates the set of QOS Parameter
2671 Set parameters actually signaled in the
2672 DOCSIS registration or dynamic service request
2673 message that created or modified the QOS Parameter
2674 Set. A bit is set to 1 when the parameter described
2675 by the indicated reference section is present
2676 in the original request.
2677
2678 Note that when Service Class names are expanded,
2679 the registration or dynamic response message may
2680 contain parameters as expanded by the CMTS based
2681
2682
2683
2684 <span class="grey">Patrick &amp; Murwin Standards Track [Page 48]</span></pre>
2685 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
2686 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2687
2688
2689 on a stored service class. These expanded
2690 parameters are not indicated by a 1 bit in this
2691 object.
2692
2693 Note that even though some QOS Parameter Set
2694 parameters may not be signaled in a message
2695 (so that the paramater's bit in this object is 0),
2696 the DOCSIS specification requires that default
2697 values be used. These default values are reported
2698 as the corresponding object's value in the row.
2699
2700 Note that BITS objects are encoded most
2701 significant bit first. For example, if bits
2702 1 and 16 are set, the value of this object
2703 is the octet string '400080'H."
2704 ::= { docsIetfQosParamSetEntry 22 }
2705
2706 --
2707 -- Service Flow Table
2708 --
2709 docsIetfQosServiceFlowTable OBJECT-TYPE
2710 SYNTAX SEQUENCE OF DocsIetfQosServiceFlowEntry
2711 MAX-ACCESS not-accessible
2712 STATUS current
2713 DESCRIPTION "This table describes the set of DOCSIS-QOS
2714 Service Flows in a managed device."
2715 ::= { docsIetfQosMIBObjects 3 }
2716
2717 docsIetfQosServiceFlowEntry OBJECT-TYPE
2718 SYNTAX DocsIetfQosServiceFlowEntry
2719 MAX-ACCESS not-accessible
2720 STATUS current
2721 DESCRIPTION "Describes a Service Flow.
2722 An entry in the table exists for each
2723 Service Flow ID. The ifIndex is an
2724 ifType of docsCableMaclayer(127)."
2725 INDEX {
2726 ifIndex,
2727 docsIetfQosServiceFlowId
2728 }
2729 ::= { docsIetfQosServiceFlowTable 1 }
2730
2731 DocsIetfQosServiceFlowEntry ::= SEQUENCE {
2732 docsIetfQosServiceFlowId Unsigned32,
2733 docsIetfQosServiceFlowSID Unsigned32,
2734 docsIetfQosServiceFlowDirection DocsIetfQosRfMacIfDirection,
2735 docsIetfQosServiceFlowPrimary TruthValue
2736 }
2737
2738
2739
2740 <span class="grey">Patrick &amp; Murwin Standards Track [Page 49]</span></pre>
2741 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
2742 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2743
2744
2745 docsIetfQosServiceFlowId OBJECT-TYPE
2746 SYNTAX Unsigned32 (1..4294967295)
2747 MAX-ACCESS not-accessible
2748 STATUS current
2749 DESCRIPTION "An index assigned to a Service Flow by CMTS."
2750 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.3.2">Appendix C.2.2.3.2</a>"
2751 ::= { docsIetfQosServiceFlowEntry 1 }
2752
2753 docsIetfQosServiceFlowSID OBJECT-TYPE
2754 SYNTAX Unsigned32 (0..16383)
2755 MAX-ACCESS read-only
2756 STATUS current
2757 DESCRIPTION "Service Identifier (SID) assigned to an
2758 admitted or active Service Flow. This object
2759 reports a value of 0 if a Service ID is not
2760 associated with the Service Flow. Only active
2761 or admitted upstream Service Flows will have a
2762 Service ID (SID)."
2763 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.3.3">Appendix C.2.2.3.3</a>"
2764 ::= { docsIetfQosServiceFlowEntry 2 }
2765
2766 docsIetfQosServiceFlowDirection OBJECT-TYPE
2767 SYNTAX DocsIetfQosRfMacIfDirection
2768 MAX-ACCESS read-only
2769 STATUS current
2770 DESCRIPTION "The direction of the Service Flow."
2771 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.1">Appendix C.2.1.1</a>/2"
2772 ::= { docsIetfQosServiceFlowEntry 3 }
2773
2774 docsIetfQosServiceFlowPrimary OBJECT-TYPE
2775 SYNTAX TruthValue
2776 MAX-ACCESS read-only
2777 STATUS current
2778 DESCRIPTION "Object reflects whether Service Flow is the primary
2779 or a secondary Service Flow.
2780
2781 A primary Service Flow is the default Service Flow
2782 for otherwise unclassified traffic and all MAC
2783 messages."
2784 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#section-8.1">Section 8.1</a> "
2785 ::= { docsIetfQosServiceFlowEntry 4 }
2786
2787 --
2788 -- Service Flow Stats Table
2789 --
2790 docsIetfQosServiceFlowStatsTable OBJECT-TYPE
2791 SYNTAX SEQUENCE OF DocsIetfQosServiceFlowStatsEntry
2792 MAX-ACCESS not-accessible
2793
2794
2795
2796 <span class="grey">Patrick &amp; Murwin Standards Track [Page 50]</span></pre>
2797 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
2798 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2799
2800
2801 STATUS current
2802 DESCRIPTION "This table describes statistics associated with the
2803 Service Flows in a managed device."
2804 ::= { docsIetfQosMIBObjects 4 }
2805
2806 docsIetfQosServiceFlowStatsEntry OBJECT-TYPE
2807 SYNTAX DocsIetfQosServiceFlowStatsEntry
2808 MAX-ACCESS not-accessible
2809 STATUS current
2810 DESCRIPTION "Describes a set of Service Flow statistics.
2811 An entry in the table exists for each
2812 Service Flow ID. The ifIndex is an
2813 ifType of docsCableMaclayer(127)."
2814 INDEX {
2815 ifIndex,
2816 docsIetfQosServiceFlowId
2817 }
2818 ::= { docsIetfQosServiceFlowStatsTable 1 }
2819
2820 DocsIetfQosServiceFlowStatsEntry ::= SEQUENCE {
2821 docsIetfQosServiceFlowPkts Counter64,
2822 docsIetfQosServiceFlowOctets Counter64,
2823 docsIetfQosServiceFlowTimeCreated TimeStamp,
2824 docsIetfQosServiceFlowTimeActive Counter32,
2825 docsIetfQosServiceFlowPHSUnknowns Counter32,
2826 docsIetfQosServiceFlowPolicedDropPkts Counter32,
2827 docsIetfQosServiceFlowPolicedDelayPkts Counter32
2828 }
2829
2830 docsIetfQosServiceFlowPkts OBJECT-TYPE
2831 SYNTAX Counter64
2832 MAX-ACCESS read-only
2833 STATUS current
2834 DESCRIPTION "For outgoing Service Flows, this object counts the
2835 number of Packet Data PDUs forwarded to this
2836 Service Flow. For incoming upstream CMTS service
2837 flows, this object counts the number of Packet
2838 Data PDUs actually received on the Service Flow
2839 identified by the SID for which the packet was
2840 scheduled. CMs not classifying downstream packets
2841 may report this object's value as 0 for downstream
2842 Service Flows. This object does not count
2843 MAC-specific management messages.
2844
2845 Particularly for UGS flows, packets sent on the
2846 primary Service Flow in violation of the UGS grant
2847 size should be counted only by the instance of this
2848 object that is associated with the primary service
2849
2850
2851
2852 <span class="grey">Patrick &amp; Murwin Standards Track [Page 51]</span></pre>
2853 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
2854 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2855
2856
2857 flow.
2858
2859 Unclassified upstream user data packets (i.e., non-
2860 MAC-management) forwarded to the primary upstream
2861 Service Flow should be counted by the instance of
2862 this object that is associated with the primary
2863 service flow.
2864
2865 This object does include packets counted by
2866 docsIetfQosServiceFlowPolicedDelayPkts, but does not
2867 include packets counted by
2868 docsIetfQosServiceFlowPolicedDropPkts
2869 and docsIetfQosServiceFlowPHSUnknowns.
2870
2871 This counter's last discontinuity is the
2872 ifCounterDiscontinuityTime for the same ifIndex that
2873 indexes this object."
2874 ::= { docsIetfQosServiceFlowStatsEntry 1 }
2875
2876 docsIetfQosServiceFlowOctets OBJECT-TYPE
2877 SYNTAX Counter64
2878 MAX-ACCESS read-only
2879 STATUS current
2880 DESCRIPTION "The number of octets from the byte after the MAC
2881 header HCS to the end of the CRC for all packets
2882 counted in the docsIetfQosServiceFlowPkts object for
2883 this row. Note that this counts the octets after
2884 payload header suppression and before payload
2885 header expansion have been applied.
2886
2887 This counter's last discontinuity is the
2888 ifCounterDiscontinuityTime for the same ifIndex that
2889 indexes this object."
2890 ::= { docsIetfQosServiceFlowStatsEntry 2 }
2891
2892 docsIetfQosServiceFlowTimeCreated OBJECT-TYPE
2893 SYNTAX TimeStamp
2894 MAX-ACCESS read-only
2895 STATUS current
2896 DESCRIPTION "The value of sysUpTime when the service flow
2897 was created."
2898 ::= { docsIetfQosServiceFlowStatsEntry 3 }
2899
2900 docsIetfQosServiceFlowTimeActive OBJECT-TYPE
2901 SYNTAX Counter32
2902 UNITS "seconds"
2903 MAX-ACCESS read-only
2904 STATUS current
2905
2906
2907
2908 <span class="grey">Patrick &amp; Murwin Standards Track [Page 52]</span></pre>
2909 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
2910 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2911
2912
2913 DESCRIPTION "The number of seconds that the service flow
2914 has been active.
2915
2916 This counter's last discontinuity is the
2917 ifCounterDiscontinuityTime for the same ifIndex that
2918 indexes this object."
2919 ::= { docsIetfQosServiceFlowStatsEntry 4 }
2920
2921 docsIetfQosServiceFlowPHSUnknowns OBJECT-TYPE
2922 SYNTAX Counter32
2923 MAX-ACCESS read-only
2924 STATUS current
2925 DESCRIPTION "For incoming upstream CMTS service flows, this
2926 object counts the number of packets received
2927 with an unknown payload header suppression index.
2928 The service flow is identified by the SID for which
2929 the packet was scheduled.
2930
2931 On a CM, only this object's instance for the primary
2932 downstream service flow counts packets received with
2933 an unknown payload header suppression index. All
2934 other downstream service flows on CM report this
2935 objects value as 0.
2936
2937 All outgoing service flows report this object's
2938 value as 0.
2939
2940 This counter's last discontinuity is the
2941 ifCounterDiscontinuityTime for the same ifIndex that
2942 indexes this object."
2943 ::= { docsIetfQosServiceFlowStatsEntry 5 }
2944
2945 docsIetfQosServiceFlowPolicedDropPkts OBJECT-TYPE
2946 SYNTAX Counter32
2947 MAX-ACCESS read-only
2948 STATUS current
2949 DESCRIPTION "For outgoing service flows, this object counts the
2950 number of Packet Data PDUs classified to this
2951 service flow dropped due to:
2952 (1) implementation-dependent excessive delay
2953 while enforcing the Maximum Sustained
2954 Traffic Rate; or
2955 (2) UGS packets dropped due to exceeding the
2956 Unsolicited Grant Size with a
2957 Request/Transmission policy that requires
2958 such packets to be dropped.
2959
2960 Classified packets dropped due to other reasons
2961
2962
2963
2964 <span class="grey">Patrick &amp; Murwin Standards Track [Page 53]</span></pre>
2965 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
2966 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
2967
2968
2969 must be counted in ifOutDiscards for the interface
2970 of this service flow. This object reports 0 for
2971 incoming service flows.
2972
2973 This counter's last discontinuity is the
2974 ifCounterDiscontinuityTime for the same ifIndex that
2975 indexes this object."
2976 ::= { docsIetfQosServiceFlowStatsEntry 6 }
2977
2978 docsIetfQosServiceFlowPolicedDelayPkts OBJECT-TYPE
2979 SYNTAX Counter32
2980 MAX-ACCESS read-only
2981 STATUS current
2982 DESCRIPTION "This object counts only outgoing packets delayed in
2983 order to maintain the Maximum Sustained Traffic
2984 Rate. This object will always report a value of 0
2985 for UGS flows because the Maximum Sustained Traffic
2986 Rate does not apply. This object is 0 for incoming
2987 service flows.
2988
2989 This counter's last discontinuity is the
2990 ifCounterDiscontinuityTime for the same ifIndex that
2991 indexes this object."
2992 ::= { docsIetfQosServiceFlowStatsEntry 7 }
2993
2994 --
2995 -- Upstream Service Flow Stats Table (CMTS ONLY)
2996 --
2997 docsIetfQosUpstreamStatsTable OBJECT-TYPE
2998 SYNTAX SEQUENCE OF DocsIetfQosUpstreamStatsEntry
2999 MAX-ACCESS not-accessible
3000 STATUS current
3001 DESCRIPTION "This table describes statistics associated with
3002 upstream service flows. All counted frames must
3003 be received without a Frame Check Sequence (FCS)
3004 error."
3005 ::= { docsIetfQosMIBObjects 5 }
3006
3007 docsIetfQosUpstreamStatsEntry OBJECT-TYPE
3008 SYNTAX DocsIetfQosUpstreamStatsEntry
3009 MAX-ACCESS not-accessible
3010 STATUS current
3011 DESCRIPTION "Describes a set of upstream service flow
3012 statistics. An entry in the table exists for each
3013 upstream Service Flow in a managed device.
3014 The ifIndex is an ifType of
3015 docsCableMaclayer(127)."
3016 INDEX {
3017
3018
3019
3020 <span class="grey">Patrick &amp; Murwin Standards Track [Page 54]</span></pre>
3021 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
3022 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3023
3024
3025 ifIndex,
3026 docsIetfQosSID
3027 }
3028 ::= { docsIetfQosUpstreamStatsTable 1 }
3029
3030 DocsIetfQosUpstreamStatsEntry ::= SEQUENCE {
3031 docsIetfQosSID Unsigned32,
3032 docsIetfQosUpstreamFragments Counter32,
3033 docsIetfQosUpstreamFragDiscards Counter32,
3034 docsIetfQosUpstreamConcatBursts Counter32
3035 }
3036
3037 docsIetfQosSID OBJECT-TYPE
3038 SYNTAX Unsigned32 (1..16383)
3039 MAX-ACCESS not-accessible
3040 STATUS current
3041 DESCRIPTION "Identifies a service ID for an admitted or active
3042 upstream service flow."
3043 ::= { docsIetfQosUpstreamStatsEntry 1 }
3044
3045 docsIetfQosUpstreamFragments OBJECT-TYPE
3046 SYNTAX Counter32
3047 MAX-ACCESS read-only
3048 STATUS current
3049 DESCRIPTION "The number of fragmentation headers received on an
3050 upstream service flow, regardless of whether
3051 the fragment was correctly reassembled into a
3052 valid packet.
3053
3054 This counter's last discontinuity is the
3055 ifCounterDiscontinuityTime for the same ifIndex that
3056 indexes this object."
3057 ::= { docsIetfQosUpstreamStatsEntry 2 }
3058
3059 docsIetfQosUpstreamFragDiscards OBJECT-TYPE
3060 SYNTAX Counter32
3061 MAX-ACCESS read-only
3062 STATUS current
3063 DESCRIPTION "The number of upstream fragments discarded and not
3064 assembled into a valid upstream packet.
3065
3066 This counter's last discontinuity is the
3067 ifCounterDiscontinuityTime for the same ifIndex that
3068 indexes this object."
3069 ::= { docsIetfQosUpstreamStatsEntry 3 }
3070
3071 docsIetfQosUpstreamConcatBursts OBJECT-TYPE
3072 SYNTAX Counter32
3073
3074
3075
3076 <span class="grey">Patrick &amp; Murwin Standards Track [Page 55]</span></pre>
3077 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
3078 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3079
3080
3081 MAX-ACCESS read-only
3082 STATUS current
3083 DESCRIPTION "The number of concatenation headers received on an
3084 upstream service flow.
3085 This counter's last discontinuity is the
3086 ifCounterDiscontinuityTime for the same ifIndex that
3087 indexes this object."
3088 ::= { docsIetfQosUpstreamStatsEntry 4 }
3089
3090
3091 --
3092 -- Dynamic Service Stats Table
3093 --
3094 docsIetfQosDynamicServiceStatsTable OBJECT-TYPE
3095 SYNTAX SEQUENCE OF DocsIetfQosDynamicServiceStatsEntry
3096 MAX-ACCESS not-accessible
3097 STATUS current
3098 DESCRIPTION "This table describes statistics associated with the
3099 Dynamic Service Flows in a managed device."
3100 ::= { docsIetfQosMIBObjects 6 }
3101
3102 docsIetfQosDynamicServiceStatsEntry OBJECT-TYPE
3103 SYNTAX DocsIetfQosDynamicServiceStatsEntry
3104 MAX-ACCESS not-accessible
3105 STATUS current
3106 DESCRIPTION "Describes a set of dynamic service flow statistics.
3107 Two entries exist for each DOCSIS MAC layer
3108 interface for the upstream and downstream
3109 direction. On the CMTS, the downstream direction
3110 row indicates messages transmitted or transactions
3111 originated by the CMTS. The upstream direction row
3112 indicates messages received or transaction
3113 originated by the CM. On the CM, the downstream
3114 direction row indicates messages received or
3115 transactions originated by the CMTS. The upstream
3116 direction row indicates messages transmitted by
3117 the CM or transactions originated by the CM.
3118 The ifIndex is an ifType of
3119 docsCableMaclayer(127)."
3120 INDEX {
3121 ifIndex,
3122 docsIetfQosIfDirection
3123 }
3124 ::= { docsIetfQosDynamicServiceStatsTable 1 }
3125
3126 DocsIetfQosDynamicServiceStatsEntry ::= SEQUENCE {
3127 docsIetfQosIfDirection DocsIetfQosRfMacIfDirection,
3128 docsIetfQosDSAReqs Counter32,
3129
3130
3131
3132 <span class="grey">Patrick &amp; Murwin Standards Track [Page 56]</span></pre>
3133 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
3134 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3135
3136
3137 docsIetfQosDSARsps Counter32,
3138 docsIetfQosDSAAcks Counter32,
3139 docsIetfQosDSCReqs Counter32,
3140 docsIetfQosDSCRsps Counter32,
3141 docsIetfQosDSCAcks Counter32,
3142 docsIetfQosDSDReqs Counter32,
3143 docsIetfQosDSDRsps Counter32,
3144 docsIetfQosDynamicAdds Counter32,
3145 docsIetfQosDynamicAddFails Counter32,
3146 docsIetfQosDynamicChanges Counter32,
3147 docsIetfQosDynamicChangeFails Counter32,
3148 docsIetfQosDynamicDeletes Counter32,
3149 docsIetfQosDynamicDeleteFails Counter32,
3150 docsIetfQosDCCReqs Counter32,
3151 docsIetfQosDCCRsps Counter32,
3152 docsIetfQosDCCAcks Counter32,
3153 docsIetfQosDCCs Counter32,
3154 docsIetfQosDCCFails Counter32
3155 }
3156
3157 docsIetfQosIfDirection OBJECT-TYPE
3158 SYNTAX DocsIetfQosRfMacIfDirection
3159 MAX-ACCESS not-accessible
3160 STATUS current
3161 DESCRIPTION "The direction of interface."
3162 ::= { docsIetfQosDynamicServiceStatsEntry 1 }
3163
3164 docsIetfQosDSAReqs OBJECT-TYPE
3165 SYNTAX Counter32
3166 MAX-ACCESS read-only
3167 STATUS current
3168 DESCRIPTION "The number of Dynamic Service Addition Requests,
3169 including retries.
3170
3171 This counter's last discontinuity is the
3172 ifCounterDiscontinuityTime for the same ifIndex that
3173 indexes this object."
3174 ::= { docsIetfQosDynamicServiceStatsEntry 2 }
3175
3176 docsIetfQosDSARsps OBJECT-TYPE
3177 SYNTAX Counter32
3178 MAX-ACCESS read-only
3179 STATUS current
3180 DESCRIPTION "The number of Dynamic Service Addition Responses,
3181 including retries.
3182
3183 This counter's last discontinuity is the
3184 ifCounterDiscontinuityTime for the same ifIndex that
3185
3186
3187
3188 <span class="grey">Patrick &amp; Murwin Standards Track [Page 57]</span></pre>
3189 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
3190 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3191
3192
3193 indexes this object."
3194 ::= { docsIetfQosDynamicServiceStatsEntry 3 }
3195
3196 docsIetfQosDSAAcks OBJECT-TYPE
3197 SYNTAX Counter32
3198 MAX-ACCESS read-only
3199 STATUS current
3200 DESCRIPTION "The number of Dynamic Service Addition
3201 Acknowledgements, including retries.
3202
3203 This counter's last discontinuity is the
3204 ifCounterDiscontinuityTime for the same ifIndex that
3205 indexes this object."
3206 ::= { docsIetfQosDynamicServiceStatsEntry 4 }
3207
3208 docsIetfQosDSCReqs OBJECT-TYPE
3209 SYNTAX Counter32
3210 MAX-ACCESS read-only
3211 STATUS current
3212 DESCRIPTION "The number of Dynamic Service Change Requests,
3213 including retries.
3214
3215 This counter's last discontinuity is the
3216 ifCounterDiscontinuityTime for the same ifIndex that
3217 indexes this object."
3218 ::= { docsIetfQosDynamicServiceStatsEntry 5 }
3219
3220 docsIetfQosDSCRsps OBJECT-TYPE
3221 SYNTAX Counter32
3222 MAX-ACCESS read-only
3223 STATUS current
3224 DESCRIPTION "The number of Dynamic Service Change Responses,
3225 including retries.
3226
3227 This counter's last discontinuity is the
3228 ifCounterDiscontinuityTime for the same ifIndex that
3229 indexes this object."
3230 ::= { docsIetfQosDynamicServiceStatsEntry 6 }
3231
3232 docsIetfQosDSCAcks OBJECT-TYPE
3233 SYNTAX Counter32
3234 MAX-ACCESS read-only
3235 STATUS current
3236 DESCRIPTION "The number of Dynamic Service Change
3237 Acknowledgements, including retries.
3238
3239 This counter's last discontinuity is the
3240 ifCounterDiscontinuityTime for the same ifIndex that
3241
3242
3243
3244 <span class="grey">Patrick &amp; Murwin Standards Track [Page 58]</span></pre>
3245 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
3246 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3247
3248
3249 indexes this object."
3250 ::= { docsIetfQosDynamicServiceStatsEntry 7 }
3251
3252 docsIetfQosDSDReqs OBJECT-TYPE
3253 SYNTAX Counter32
3254 MAX-ACCESS read-only
3255 STATUS current
3256 DESCRIPTION "The number of Dynamic Service Delete Requests,
3257 including retries.
3258
3259 This counter's last discontinuity is the
3260 ifCounterDiscontinuityTime for the same ifIndex that
3261 indexes this object."
3262 ::= { docsIetfQosDynamicServiceStatsEntry 8 }
3263
3264 docsIetfQosDSDRsps OBJECT-TYPE
3265 SYNTAX Counter32
3266 MAX-ACCESS read-only
3267 STATUS current
3268 DESCRIPTION "The number of Dynamic Service Delete Responses,
3269 including retries.
3270
3271 This counter's last discontinuity is the
3272 ifCounterDiscontinuityTime for the same ifIndex that
3273 indexes this object."
3274 ::= { docsIetfQosDynamicServiceStatsEntry 9 }
3275
3276 docsIetfQosDynamicAdds OBJECT-TYPE
3277 SYNTAX Counter32
3278 MAX-ACCESS read-only
3279 STATUS current
3280 DESCRIPTION "The number of successful Dynamic Service Addition
3281 transactions.
3282
3283 This counter's last discontinuity is the
3284 ifCounterDiscontinuityTime for the same ifIndex that
3285 indexes this object."
3286 ::= { docsIetfQosDynamicServiceStatsEntry 10 }
3287
3288 docsIetfQosDynamicAddFails OBJECT-TYPE
3289 SYNTAX Counter32
3290 MAX-ACCESS read-only
3291 STATUS current
3292 DESCRIPTION "The number of failed Dynamic Service Addition
3293 transactions.
3294
3295 This counter's last discontinuity is the
3296 ifCounterDiscontinuityTime for the same ifIndex that
3297
3298
3299
3300 <span class="grey">Patrick &amp; Murwin Standards Track [Page 59]</span></pre>
3301 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
3302 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3303
3304
3305 indexes this object."
3306 ::= { docsIetfQosDynamicServiceStatsEntry 11 }
3307
3308 docsIetfQosDynamicChanges OBJECT-TYPE
3309 SYNTAX Counter32
3310 MAX-ACCESS read-only
3311 STATUS current
3312 DESCRIPTION "The number of successful Dynamic Service Change
3313 transactions.
3314
3315 This counter's last discontinuity is the
3316 ifCounterDiscontinuityTime for the same ifIndex that
3317 indexes this object."
3318 ::= { docsIetfQosDynamicServiceStatsEntry 12 }
3319
3320 docsIetfQosDynamicChangeFails OBJECT-TYPE
3321 SYNTAX Counter32
3322 MAX-ACCESS read-only
3323 STATUS current
3324 DESCRIPTION "The number of failed Dynamic Service Change
3325 transactions.
3326
3327 This counter's last discontinuity is the
3328 ifCounterDiscontinuityTime for the same ifIndex that
3329 indexes this object."
3330 ::= { docsIetfQosDynamicServiceStatsEntry 13 }
3331
3332 docsIetfQosDynamicDeletes OBJECT-TYPE
3333 SYNTAX Counter32
3334 MAX-ACCESS read-only
3335 STATUS current
3336 DESCRIPTION "The number of successful Dynamic Service Delete
3337 transactions.
3338
3339 This counter's last discontinuity is the
3340 ifCounterDiscontinuityTime for the same ifIndex that
3341 indexes this object."
3342 ::= { docsIetfQosDynamicServiceStatsEntry 14 }
3343
3344 docsIetfQosDynamicDeleteFails OBJECT-TYPE
3345 SYNTAX Counter32
3346 MAX-ACCESS read-only
3347 STATUS current
3348 DESCRIPTION "The number of failed Dynamic Service Delete
3349 transactions.
3350
3351 This counter's last discontinuity is the
3352 ifCounterDiscontinuityTime for the same ifIndex that
3353
3354
3355
3356 <span class="grey">Patrick &amp; Murwin Standards Track [Page 60]</span></pre>
3357 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
3358 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3359
3360
3361 indexes this object."
3362 ::= { docsIetfQosDynamicServiceStatsEntry 15 }
3363
3364
3365 docsIetfQosDCCReqs OBJECT-TYPE
3366 SYNTAX Counter32
3367 MAX-ACCESS read-only
3368 STATUS current
3369 DESCRIPTION "The number of Dynamic Channel Change Request
3370 messages traversing an interface. This count
3371 is nonzero only on downstream direction rows.
3372 This count should include the number of retries.
3373
3374 This counter's last discontinuity is the
3375 ifCounterDiscontinuityTime for the same ifIndex
3376 that indexes this object."
3377 ::= { docsIetfQosDynamicServiceStatsEntry 16 }
3378
3379 docsIetfQosDCCRsps OBJECT-TYPE
3380 SYNTAX Counter32
3381 MAX-ACCESS read-only
3382 STATUS current
3383 DESCRIPTION "The number of Dynamic Channel Change Response
3384 messages traversing an interface. This count is
3385 nonzero only on upstream direction rows. This count
3386 should include the number of retries.
3387
3388 This counter's last discontinuity is the
3389 ifCounterDiscontinuityTime for the same ifIndex that
3390 indexes this object."
3391 ::= { docsIetfQosDynamicServiceStatsEntry 17 }
3392
3393 docsIetfQosDCCAcks OBJECT-TYPE
3394 SYNTAX Counter32
3395 MAX-ACCESS read-only
3396 STATUS current
3397 DESCRIPTION "The number of Dynamic Channel Change Acknowledgement
3398 messages traversing an interface. This count
3399 is nonzero only on downstream direction rows.
3400 This count should include the number of retries.
3401
3402 This counter's last discontinuity is the
3403 ifCounterDiscontinuityTime for the same ifIndex that
3404 indexes this object."
3405 ::= { docsIetfQosDynamicServiceStatsEntry 18 }
3406
3407 docsIetfQosDCCs OBJECT-TYPE
3408 SYNTAX Counter32
3409
3410
3411
3412 <span class="grey">Patrick &amp; Murwin Standards Track [Page 61]</span></pre>
3413 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
3414 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3415
3416
3417 MAX-ACCESS read-only
3418 STATUS current
3419 DESCRIPTION "The number of successful Dynamic Channel Change
3420 transactions. This count is nonzero only on
3421 downstream direction rows.
3422
3423 This counter's last discontinuity is the
3424 ifCounterDiscontinuityTime for the same ifIndex that
3425 indexes this object."
3426 ::= { docsIetfQosDynamicServiceStatsEntry 19 }
3427
3428 docsIetfQosDCCFails OBJECT-TYPE
3429 SYNTAX Counter32
3430 MAX-ACCESS read-only
3431 STATUS current
3432 DESCRIPTION "The number of failed Dynamic Channel Change
3433 transactions. This count is nonzero only on
3434 downstream direction rows.
3435
3436 This counter's last discontinuity is the
3437 ifCounterDiscontinuityTime for the same ifIndex that
3438 indexes this object."
3439 ::= { docsIetfQosDynamicServiceStatsEntry 20 }
3440
3441
3442 --
3443 -- Service Flow Log Table (CMTS ONLY)
3444 --
3445 docsIetfQosServiceFlowLogTable OBJECT-TYPE
3446 SYNTAX SEQUENCE OF DocsIetfQosServiceFlowLogEntry
3447 MAX-ACCESS not-accessible
3448 STATUS current
3449 DESCRIPTION "This table contains a log of the disconnected
3450 Service Flows in a managed device."
3451 ::= { docsIetfQosMIBObjects 7 }
3452
3453 docsIetfQosServiceFlowLogEntry OBJECT-TYPE
3454 SYNTAX DocsIetfQosServiceFlowLogEntry
3455 MAX-ACCESS not-accessible
3456 STATUS current
3457 DESCRIPTION "The information regarding a single disconnected
3458 service flow."
3459 INDEX {
3460 docsIetfQosServiceFlowLogIndex
3461 }
3462 ::= { docsIetfQosServiceFlowLogTable 1 }
3463
3464 DocsIetfQosServiceFlowLogEntry ::= SEQUENCE {
3465
3466
3467
3468 <span class="grey">Patrick &amp; Murwin Standards Track [Page 62]</span></pre>
3469 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
3470 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3471
3472
3473 docsIetfQosServiceFlowLogIndex Unsigned32,
3474 docsIetfQosServiceFlowLogIfIndex InterfaceIndex,
3475 docsIetfQosServiceFlowLogSFID Unsigned32,
3476 docsIetfQosServiceFlowLogCmMac MacAddress,
3477 docsIetfQosServiceFlowLogPkts Counter64,
3478 docsIetfQosServiceFlowLogOctets Counter64,
3479 docsIetfQosServiceFlowLogTimeDeleted TimeStamp,
3480 docsIetfQosServiceFlowLogTimeCreated TimeStamp,
3481 docsIetfQosServiceFlowLogTimeActive Counter32,
3482 docsIetfQosServiceFlowLogDirection DocsIetfQosRfMacIfDirection,
3483 docsIetfQosServiceFlowLogPrimary TruthValue,
3484 docsIetfQosServiceFlowLogServiceClassName SnmpAdminString,
3485 docsIetfQosServiceFlowLogPolicedDropPkts Counter32,
3486 docsIetfQosServiceFlowLogPolicedDelayPkts Counter32,
3487 docsIetfQosServiceFlowLogControl INTEGER
3488 }
3489
3490 docsIetfQosServiceFlowLogIndex OBJECT-TYPE
3491 SYNTAX Unsigned32 (1..4294967295)
3492 MAX-ACCESS not-accessible
3493 STATUS current
3494 DESCRIPTION "Unique index for a logged service flow."
3495 ::= { docsIetfQosServiceFlowLogEntry 1 }
3496
3497 docsIetfQosServiceFlowLogIfIndex OBJECT-TYPE
3498 SYNTAX InterfaceIndex
3499 MAX-ACCESS read-only
3500 STATUS current
3501 DESCRIPTION "The ifIndex of ifType docsCableMaclayer(127)
3502 on the CMTS where the service flow was present."
3503 ::= { docsIetfQosServiceFlowLogEntry 2 }
3504
3505 docsIetfQosServiceFlowLogSFID OBJECT-TYPE
3506 SYNTAX Unsigned32 (1..4294967295)
3507 MAX-ACCESS read-only
3508 STATUS current
3509 DESCRIPTION "The index assigned to the service flow by the CMTS."
3510 ::= { docsIetfQosServiceFlowLogEntry 3 }
3511
3512 docsIetfQosServiceFlowLogCmMac OBJECT-TYPE
3513 SYNTAX MacAddress
3514 MAX-ACCESS read-only
3515 STATUS current
3516 DESCRIPTION "The MAC address for the cable modem associated with
3517 the service flow."
3518 ::= { docsIetfQosServiceFlowLogEntry 4 }
3519
3520 docsIetfQosServiceFlowLogPkts OBJECT-TYPE
3521
3522
3523
3524 <span class="grey">Patrick &amp; Murwin Standards Track [Page 63]</span></pre>
3525 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
3526 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3527
3528
3529 SYNTAX Counter64
3530 MAX-ACCESS read-only
3531 STATUS current
3532 DESCRIPTION "The number of packets counted on this service flow
3533 after payload header suppression."
3534 ::= { docsIetfQosServiceFlowLogEntry 5 }
3535
3536 docsIetfQosServiceFlowLogOctets OBJECT-TYPE
3537 SYNTAX Counter64
3538 MAX-ACCESS read-only
3539 STATUS current
3540 DESCRIPTION "The number of octets counted on this service flow
3541 after payload header suppression."
3542 ::= { docsIetfQosServiceFlowLogEntry 6 }
3543
3544 docsIetfQosServiceFlowLogTimeDeleted OBJECT-TYPE
3545 SYNTAX TimeStamp
3546 MAX-ACCESS read-only
3547 STATUS current
3548 DESCRIPTION "The value of sysUpTime when the service flow
3549 was deleted."
3550 ::= { docsIetfQosServiceFlowLogEntry 7 }
3551
3552 docsIetfQosServiceFlowLogTimeCreated OBJECT-TYPE
3553 SYNTAX TimeStamp
3554 MAX-ACCESS read-only
3555 STATUS current
3556 DESCRIPTION "The value of sysUpTime when the service flow
3557 was created."
3558 ::= { docsIetfQosServiceFlowLogEntry 8 }
3559
3560 docsIetfQosServiceFlowLogTimeActive OBJECT-TYPE
3561 SYNTAX Counter32
3562 UNITS "seconds"
3563 MAX-ACCESS read-only
3564 STATUS current
3565 DESCRIPTION "The total time that the service flow was active."
3566 ::= { docsIetfQosServiceFlowLogEntry 9 }
3567
3568 docsIetfQosServiceFlowLogDirection OBJECT-TYPE
3569 SYNTAX DocsIetfQosRfMacIfDirection
3570 MAX-ACCESS read-only
3571 STATUS current
3572 DESCRIPTION "The value of docsIetfQosServiceFlowDirection
3573 for the service flow."
3574 ::= { docsIetfQosServiceFlowLogEntry 10 }
3575
3576 docsIetfQosServiceFlowLogPrimary OBJECT-TYPE
3577
3578
3579
3580 <span class="grey">Patrick &amp; Murwin Standards Track [Page 64]</span></pre>
3581 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
3582 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3583
3584
3585 SYNTAX TruthValue
3586 MAX-ACCESS read-only
3587 STATUS current
3588 DESCRIPTION "The value of docsIetfQosServiceFlowPrimary for the
3589 service flow."
3590 ::= { docsIetfQosServiceFlowLogEntry 11 }
3591
3592 docsIetfQosServiceFlowLogServiceClassName OBJECT-TYPE
3593 SYNTAX SnmpAdminString
3594 MAX-ACCESS read-only
3595 STATUS current
3596 DESCRIPTION "The value of docsIetfQosParamSetServiceClassName for
3597 the provisioned QOS Parameter Set of the
3598 service flow."
3599 ::= { docsIetfQosServiceFlowLogEntry 12 }
3600
3601 docsIetfQosServiceFlowLogPolicedDropPkts OBJECT-TYPE
3602 SYNTAX Counter32
3603 MAX-ACCESS read-only
3604 STATUS current
3605 DESCRIPTION "The final value of
3606 docsIetfQosServiceFlowPolicedDropPkts for the
3607 service flow."
3608 ::= { docsIetfQosServiceFlowLogEntry 13 }
3609
3610 docsIetfQosServiceFlowLogPolicedDelayPkts OBJECT-TYPE
3611 SYNTAX Counter32
3612 MAX-ACCESS read-only
3613 STATUS current
3614 DESCRIPTION "The final value of
3615 docsIetfQosServiceFlowPolicedDelayPkts for the
3616 service flow."
3617 ::= { docsIetfQosServiceFlowLogEntry 14 }
3618
3619 docsIetfQosServiceFlowLogControl OBJECT-TYPE
3620 SYNTAX INTEGER {
3621 active(1),
3622 destroy(6)
3623 }
3624
3625 MAX-ACCESS read-write
3626 STATUS current
3627 DESCRIPTION "Setting this object to the value destroy(6) removes
3628 this entry from the table.
3629
3630 Reading this object returns the value active(1)."
3631 ::= { docsIetfQosServiceFlowLogEntry 15 }
3632
3633
3634
3635
3636 <span class="grey">Patrick &amp; Murwin Standards Track [Page 65]</span></pre>
3637 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
3638 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3639
3640
3641 --
3642 -- Service Class Table (CMTS ONLY)
3643 --
3644 docsIetfQosServiceClassTable OBJECT-TYPE
3645 SYNTAX SEQUENCE OF DocsIetfQosServiceClassEntry
3646 MAX-ACCESS not-accessible
3647 STATUS current
3648 DESCRIPTION "This table describes the set of DOCSIS-QOS
3649 Service Classes in a CMTS."
3650 ::= { docsIetfQosMIBObjects 8 }
3651
3652 docsIetfQosServiceClassEntry OBJECT-TYPE
3653 SYNTAX DocsIetfQosServiceClassEntry
3654 MAX-ACCESS not-accessible
3655 STATUS current
3656 DESCRIPTION "A provisioned service class on a CMTS.
3657 Each entry defines a template for certain
3658 DOCSIS QOS Parameter Set values. When a CM
3659 creates or modifies an Admitted QOS Parameter Set
3660 for a Service Flow, it may reference a Service Class
3661 Name instead of providing explicit QOS Parameter
3662 Set values. In this case, the CMTS populates
3663 the QOS Parameter Set with the applicable
3664 corresponding values from the named Service Class.
3665 Subsequent changes to a Service Class row do not
3666 affect the QOS Parameter Set values of any service
3667 flows already admitted.
3668
3669 A service class template applies to only
3670 a single direction, as indicated in the
3671 docsIetfQosServiceClassDirection object."
3672 INDEX {
3673 docsIetfQosServiceClassName
3674 }
3675 ::= { docsIetfQosServiceClassTable 1 }
3676
3677 DocsIetfQosServiceClassEntry ::= SEQUENCE {
3678 docsIetfQosServiceClassName SnmpAdminString,
3679 docsIetfQosServiceClassStatus RowStatus,
3680 docsIetfQosServiceClassPriority Integer32,
3681 docsIetfQosServiceClassMaxTrafficRate DocsIetfQosBitRate,
3682 docsIetfQosServiceClassMaxTrafficBurst Unsigned32,
3683 docsIetfQosServiceClassMinReservedRate DocsIetfQosBitRate,
3684 docsIetfQosServiceClassMinReservedPkt Integer32,
3685 docsIetfQosServiceClassMaxConcatBurst Integer32,
3686 docsIetfQosServiceClassNomPollInterval Unsigned32,
3687 docsIetfQosServiceClassTolPollJitter Unsigned32,
3688 docsIetfQosServiceClassUnsolicitGrantSize Integer32,
3689
3690
3691
3692 <span class="grey">Patrick &amp; Murwin Standards Track [Page 66]</span></pre>
3693 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
3694 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3695
3696
3697 docsIetfQosServiceClassNomGrantInterval Unsigned32,
3698 docsIetfQosServiceClassTolGrantJitter Unsigned32,
3699 docsIetfQosServiceClassGrantsPerInterval Integer32,
3700 docsIetfQosServiceClassMaxLatency Unsigned32,
3701 docsIetfQosServiceClassActiveTimeout Integer32,
3702 docsIetfQosServiceClassAdmittedTimeout Integer32,
3703 docsIetfQosServiceClassSchedulingType DocsIetfQosSchedulingType,
3704 docsIetfQosServiceClassRequestPolicy OCTET STRING,
3705 docsIetfQosServiceClassTosAndMask OCTET STRING,
3706 docsIetfQosServiceClassTosOrMask OCTET STRING,
3707 docsIetfQosServiceClassDirection DocsIetfQosRfMacIfDirection,
3708 docsIetfQosServiceClassStorageType StorageType,
3709 docsIetfQosServiceClassDSCPOverwrite DscpOrAny
3710 }
3711
3712 docsIetfQosServiceClassName OBJECT-TYPE
3713 SYNTAX SnmpAdminString (SIZE (1..15))
3714 MAX-ACCESS not-accessible
3715 STATUS current
3716 DESCRIPTION "Service Class Name. DOCSIS specifies that the
3717 maximum size is 16 ASCII characters including
3718 a terminating zero. The terminating zero is not
3719 represented in this SnmpAdminString syntax object."
3720 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.3.4">Appendix C.2.2.3.4</a>"
3721 ::= { docsIetfQosServiceClassEntry 1 }
3722
3723 docsIetfQosServiceClassStatus OBJECT-TYPE
3724 SYNTAX RowStatus
3725 MAX-ACCESS read-create
3726 STATUS current
3727 DESCRIPTION "Used to create or delete rows in this table.
3728 There is no restriction on the ability to change
3729 values in this row while the row is active.
3730 Inactive rows need not be timed out."
3731 ::= { docsIetfQosServiceClassEntry 2 }
3732
3733 docsIetfQosServiceClassPriority OBJECT-TYPE
3734 SYNTAX Integer32 (0..7)
3735 MAX-ACCESS read-create
3736 STATUS current
3737 DESCRIPTION "Template for docsIetfQosParamSetPriority."
3738 DEFVAL { 0 }
3739 ::= { docsIetfQosServiceClassEntry 3 }
3740
3741 docsIetfQosServiceClassMaxTrafficRate OBJECT-TYPE
3742 SYNTAX DocsIetfQosBitRate
3743 MAX-ACCESS read-create
3744 STATUS current
3745
3746
3747
3748 <span class="grey">Patrick &amp; Murwin Standards Track [Page 67]</span></pre>
3749 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
3750 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3751
3752
3753 DESCRIPTION "Template for docsIetfQosParamSetMaxTrafficRate."
3754 DEFVAL { 0 }
3755 ::= { docsIetfQosServiceClassEntry 4 }
3756
3757 docsIetfQosServiceClassMaxTrafficBurst OBJECT-TYPE
3758 SYNTAX Unsigned32
3759 MAX-ACCESS read-create
3760 STATUS current
3761 DESCRIPTION "Template for docsIetfQosParamSetMaxTrafficBurst."
3762 DEFVAL { 3044 }
3763 ::= { docsIetfQosServiceClassEntry 5 }
3764
3765 docsIetfQosServiceClassMinReservedRate OBJECT-TYPE
3766 SYNTAX DocsIetfQosBitRate
3767 MAX-ACCESS read-create
3768 STATUS current
3769 DESCRIPTION "Template for docsIetfQosParamSEtMinReservedRate."
3770 DEFVAL { 0 }
3771 ::= { docsIetfQosServiceClassEntry 6 }
3772
3773 docsIetfQosServiceClassMinReservedPkt OBJECT-TYPE
3774 SYNTAX Integer32 (0..65535)
3775 MAX-ACCESS read-create
3776 STATUS current
3777 DESCRIPTION "Template for docsIetfQosParamSetMinReservedPkt."
3778 ::= { docsIetfQosServiceClassEntry 7 }
3779
3780 docsIetfQosServiceClassMaxConcatBurst OBJECT-TYPE
3781 SYNTAX Integer32 (0..65535)
3782 MAX-ACCESS read-create
3783 STATUS current
3784 DESCRIPTION "Template for docsIetfQosParamSetMaxConcatBurst."
3785 DEFVAL { 1522 }
3786 ::= { docsIetfQosServiceClassEntry 8 }
3787
3788 docsIetfQosServiceClassNomPollInterval OBJECT-TYPE
3789 SYNTAX Unsigned32
3790 UNITS "microseconds"
3791 MAX-ACCESS read-create
3792 STATUS current
3793 DESCRIPTION "Template for docsIetfQosParamSetNomPollInterval."
3794 DEFVAL { 0 }
3795 ::= { docsIetfQosServiceClassEntry 9 }
3796
3797 docsIetfQosServiceClassTolPollJitter OBJECT-TYPE
3798 SYNTAX Unsigned32
3799 UNITS "microseconds"
3800 MAX-ACCESS read-create
3801
3802
3803
3804 <span class="grey">Patrick &amp; Murwin Standards Track [Page 68]</span></pre>
3805 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
3806 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3807
3808
3809 STATUS current
3810 DESCRIPTION "Template for docsIetfQosParamSetTolPollJitter."
3811 DEFVAL { 0 }
3812 ::= { docsIetfQosServiceClassEntry 10 }
3813
3814 docsIetfQosServiceClassUnsolicitGrantSize OBJECT-TYPE
3815 SYNTAX Integer32 (0..65535)
3816 MAX-ACCESS read-create
3817 STATUS current
3818 DESCRIPTION "Template for docsIetfQosParamSetUnsolicitGrantSize."
3819 DEFVAL { 0 }
3820 ::= { docsIetfQosServiceClassEntry 11 }
3821
3822 docsIetfQosServiceClassNomGrantInterval OBJECT-TYPE
3823 SYNTAX Unsigned32
3824 UNITS "microseconds"
3825 MAX-ACCESS read-create
3826 STATUS current
3827 DESCRIPTION "Template for docsIetfQosParamSetNomGrantInterval."
3828 DEFVAL { 0 }
3829 ::= { docsIetfQosServiceClassEntry 12 }
3830
3831 docsIetfQosServiceClassTolGrantJitter OBJECT-TYPE
3832 SYNTAX Unsigned32
3833 UNITS "microseconds"
3834 MAX-ACCESS read-create
3835 STATUS current
3836 DESCRIPTION "Template for docsIetfQosParamSetTolGrantJitter."
3837 DEFVAL { 0 }
3838 ::= { docsIetfQosServiceClassEntry 13 }
3839
3840 docsIetfQosServiceClassGrantsPerInterval OBJECT-TYPE
3841 SYNTAX Integer32 (0..127)
3842 MAX-ACCESS read-create
3843 STATUS current
3844 DESCRIPTION "Template for docsIetfQosParamSetGrantsPerInterval."
3845 DEFVAL { 0 }
3846 ::= { docsIetfQosServiceClassEntry 14 }
3847
3848 docsIetfQosServiceClassMaxLatency OBJECT-TYPE
3849 SYNTAX Unsigned32
3850 UNITS "microseconds"
3851 MAX-ACCESS read-create
3852 STATUS current
3853 DESCRIPTION "Template for docsIetfQosParamSetClassMaxLatency."
3854 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.7.1">Appendix C.2.2.7.1</a>"
3855 DEFVAL { 0 }
3856 ::= { docsIetfQosServiceClassEntry 15 }
3857
3858
3859
3860 <span class="grey">Patrick &amp; Murwin Standards Track [Page 69]</span></pre>
3861 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
3862 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3863
3864
3865 docsIetfQosServiceClassActiveTimeout OBJECT-TYPE
3866 SYNTAX Integer32 (0..65535)
3867 UNITS "seconds"
3868 MAX-ACCESS read-create
3869 STATUS current
3870 DESCRIPTION "Template for docsIetfQosParamSetActiveTimeout."
3871 DEFVAL { 0 }
3872 ::= { docsIetfQosServiceClassEntry 16 }
3873
3874 docsIetfQosServiceClassAdmittedTimeout OBJECT-TYPE
3875 SYNTAX Integer32 (0..65535)
3876 UNITS "seconds"
3877 MAX-ACCESS read-create
3878 STATUS current
3879 DESCRIPTION "Template for docsIetfQosParamSetAdmittedTimeout."
3880 DEFVAL { 200 }
3881 ::= { docsIetfQosServiceClassEntry 17 }
3882
3883 docsIetfQosServiceClassSchedulingType OBJECT-TYPE
3884 SYNTAX DocsIetfQosSchedulingType
3885 MAX-ACCESS read-create
3886 STATUS current
3887 DESCRIPTION "Template for docsIetfQosParamSetSchedulingType."
3888 DEFVAL { bestEffort }
3889 ::= { docsIetfQosServiceClassEntry 18 }
3890
3891 docsIetfQosServiceClassRequestPolicy OBJECT-TYPE
3892 SYNTAX OCTET STRING (SIZE(4))
3893 MAX-ACCESS read-create
3894 STATUS current
3895 DESCRIPTION "Template for docsIetfQosParamSetRequestPolicyOct."
3896 DEFVAL { '00000000'H } -- no bits are set
3897 ::= { docsIetfQosServiceClassEntry 19 }
3898
3899 docsIetfQosServiceClassTosAndMask OBJECT-TYPE
3900 SYNTAX OCTET STRING (SIZE(1))
3901 MAX-ACCESS read-only
3902 STATUS current
3903 DESCRIPTION "Template for docsIetfQosParamSetTosAndMask.
3904 The IP TOS octet as originally defined in <a href="./rfc791">RFC 791</a>
3905 has been superseded by the 6-bit Differentiated
3906 Services Field (DSField, <a href="./rfc3260">RFC 3260</a>) and the 2-bit
3907 Explicit Congestion Notification Field (ECN field,
3908 <a href="./rfc3168">RFC 3168</a>). Network operators SHOULD avoid
3909 specifying values of
3910 docsIetfQosServiceClassTosAndMask and
3911 docsIetfQosServiceClassTosOrMask that would result
3912 in the modification of the ECN bits.
3913
3914
3915
3916 <span class="grey">Patrick &amp; Murwin Standards Track [Page 70]</span></pre>
3917 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
3918 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3919
3920
3921 In particular, operators should not use values of
3922 docsIetfQosServiceClassTosAndMask that have either
3923 of the least-significant two bits set to 0.
3924 Similarly,operators should not use values of
3925 docsIetfQosServiceClassTosOrMask that have either
3926 of the least-significant two bits set to 1."
3927 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.10">Appendix C.2.2.6.10</a>;
3928 <a href="./rfc3168">RFC 3168</a>, The Addition of Explicit Congestion
3929 Notification (ECN) to IP;
3930 <a href="./rfc3260">RFC 3260</a>, New Terminology and Clarifications for
3931 Diffserv."
3932 ::= { docsIetfQosServiceClassEntry 20 }
3933
3934 docsIetfQosServiceClassTosOrMask OBJECT-TYPE
3935 SYNTAX OCTET STRING (SIZE(1))
3936 MAX-ACCESS read-only
3937 STATUS current
3938 DESCRIPTION "Template for docsIetfQosParamSetTosOrMask.
3939 The IP TOS octet as originally defined in <a href="./rfc791">RFC 791</a>
3940 has been superseded by the 6-bit Differentiated
3941 Services Field (DSField, <a href="./rfc3260">RFC 3260</a>) and the 2-bit
3942 Explicit Congestion Notification Field (ECN field,
3943 <a href="./rfc3168">RFC 3168</a>). Network operators SHOULD avoid
3944 specifying values of
3945 docsIetfQosServiceClassTosAndMask and
3946 docsIetfQosServiceClassTosOrMask that would result
3947 in the modification of the ECN bits.
3948
3949 In particular, operators should not use values of
3950 docsIetfQosServiceClassTosAndMask that have either
3951 of the least-significant two bits set to 0.
3952 Similarly, operators should not use values of
3953 docsIetfQosServiceClassTosOrMask that have either
3954 of the least-significant two bits set to 1."
3955 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.6.10">Appendix C.2.2.6.10</a>;
3956 <a href="./rfc3168">RFC 3168</a>, The Addition of Explicit Congestion
3957 Notification (ECN) to IP;
3958 <a href="./rfc3260">RFC 3260</a>, New Terminology and Clarifications for
3959 Diffserv."
3960 ::= { docsIetfQosServiceClassEntry 21 }
3961
3962 docsIetfQosServiceClassDirection OBJECT-TYPE
3963 SYNTAX DocsIetfQosRfMacIfDirection
3964 MAX-ACCESS read-create
3965 STATUS current
3966 DESCRIPTION "Specifies whether the service class template
3967 applies to upstream or downstream service flows."
3968 DEFVAL { upstream }
3969
3970
3971
3972 <span class="grey">Patrick &amp; Murwin Standards Track [Page 71]</span></pre>
3973 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
3974 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
3975
3976
3977 ::= { docsIetfQosServiceClassEntry 22 }
3978
3979 docsIetfQosServiceClassStorageType OBJECT-TYPE
3980 SYNTAX StorageType
3981 MAX-ACCESS read-create
3982 STATUS current
3983 DESCRIPTION "This object defines whether this row is kept in
3984 volatile storage and lost upon reboot or whether
3985 it is backed up by non-volatile or permanent
3986 storage. 'permanent' entries need not allow
3987 writable access to any object."
3988 DEFVAL { nonVolatile }
3989 ::= { docsIetfQosServiceClassEntry 23 }
3990
3991 docsIetfQosServiceClassDSCPOverwrite OBJECT-TYPE
3992 SYNTAX DscpOrAny
3993 MAX-ACCESS read-create
3994 STATUS current
3995 DESCRIPTION "This object allows the overwrite of the DSCP
3996 field per <a href="./rfc3260">RFC 3260</a>.
3997
3998 If this object is -1, then the corresponding entry's
3999 docsIetfQosServiceClassTosAndMask value MUST be
4000 'FF'H and docsIetfQosServiceClassTosOrMask MUST be
4001 '00'H. Otherwise, this object is in the range of
4002 0..63, and the corresponding entry's
4003 docsIetfQosServiceClassTosAndMask value MUST be
4004 '03'H and the docsIetfQosServiceClassTosOrMask MUST
4005 be this object's value shifted left by two bit
4006 positions."
4007 REFERENCE "<a href="./rfc3168">RFC 3168</a>, The Addition of Explicit Congestion
4008 Notification (ECN) to IP;
4009 <a href="./rfc3260">RFC 3260</a>, New Terminology and Clarifications for
4010 Diffserv."
4011 DEFVAL { -1 }
4012 ::= { docsIetfQosServiceClassEntry 24 }
4013
4014 --
4015 -- Service Class PolicyTable
4016 --
4017 docsIetfQosServiceClassPolicyTable OBJECT-TYPE
4018 SYNTAX SEQUENCE OF DocsIetfQosServiceClassPolicyEntry
4019 MAX-ACCESS not-accessible
4020 STATUS current
4021 DESCRIPTION "This table describes the set of DOCSIS-QOS
4022 Service Class Policies.
4023
4024 This table is an adjunct to the
4025
4026
4027
4028 <span class="grey">Patrick &amp; Murwin Standards Track [Page 72]</span></pre>
4029 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
4030 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4031
4032
4033 docsDevFilterPolicy table. Entries in the
4034 docsDevFilterPolicy table can point to
4035 specific rows in this table.
4036
4037 This table permits mapping a packet to a service
4038 class name of an active service flow so long as
4039 a classifier does not exist at a higher
4040 priority."
4041 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-E.2.1">Appendix E.2.1</a>"
4042 ::= { docsIetfQosMIBObjects 9 }
4043
4044 docsIetfQosServiceClassPolicyEntry OBJECT-TYPE
4045 SYNTAX DocsIetfQosServiceClassPolicyEntry
4046 MAX-ACCESS not-accessible
4047 STATUS current
4048 DESCRIPTION "A service class name policy entry."
4049 INDEX {
4050 docsIetfQosServiceClassPolicyIndex
4051 }
4052 ::= { docsIetfQosServiceClassPolicyTable 1 }
4053
4054 DocsIetfQosServiceClassPolicyEntry ::= SEQUENCE {
4055 docsIetfQosServiceClassPolicyIndex Unsigned32,
4056 docsIetfQosServiceClassPolicyName SnmpAdminString,
4057 docsIetfQosServiceClassPolicyRulePriority Integer32,
4058 docsIetfQosServiceClassPolicyStatus RowStatus,
4059 docsIetfQosServiceClassPolicyStorageType StorageType
4060 }
4061
4062 docsIetfQosServiceClassPolicyIndex OBJECT-TYPE
4063 SYNTAX Unsigned32 (1..2147483647)
4064 MAX-ACCESS not-accessible
4065 STATUS current
4066 DESCRIPTION "Index value to identify an entry in
4067 this table uniquely."
4068 ::= { docsIetfQosServiceClassPolicyEntry 1 }
4069
4070 docsIetfQosServiceClassPolicyName OBJECT-TYPE
4071 SYNTAX SnmpAdminString
4072 MAX-ACCESS read-create
4073 STATUS current
4074 DESCRIPTION "Service Class Name to identify the name of the
4075 service class flow to which the packet should be
4076 directed."
4077 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-E.2.1">Appendix E.2.1</a>"
4078 ::= { docsIetfQosServiceClassPolicyEntry 2 }
4079
4080 docsIetfQosServiceClassPolicyRulePriority OBJECT-TYPE
4081
4082
4083
4084 <span class="grey">Patrick &amp; Murwin Standards Track [Page 73]</span></pre>
4085 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
4086 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4087
4088
4089 SYNTAX Integer32 (0..255)
4090 MAX-ACCESS read-create
4091 STATUS current
4092 DESCRIPTION "Service Class Policy rule priority for the
4093 entry."
4094 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.1.3.5">Appendix C.2.1.3.5</a>"
4095 ::= { docsIetfQosServiceClassPolicyEntry 3 }
4096
4097 docsIetfQosServiceClassPolicyStatus OBJECT-TYPE
4098 SYNTAX RowStatus
4099 MAX-ACCESS read-create
4100 STATUS current
4101 DESCRIPTION "Used to create or delete rows in this table.
4102 This object should not be deleted if it is
4103 referenced by an entry in docsDevFilterPolicy.
4104 The reference should be deleted first.
4105 There is no restriction on the ability
4106 to change values in this row while the row is
4107 active. Inactive rows need not be timed out."
4108 ::= { docsIetfQosServiceClassPolicyEntry 4 }
4109
4110 docsIetfQosServiceClassPolicyStorageType OBJECT-TYPE
4111 SYNTAX StorageType
4112 MAX-ACCESS read-create
4113 STATUS current
4114 DESCRIPTION "This object defines whether this row is kept in
4115 volatile storage and lost upon reboot or whether
4116 it is backed up by non-volatile or permanent
4117 storage. 'permanent' entries need not allow
4118 writable access to any object."
4119 DEFVAL { nonVolatile }
4120 ::= { docsIetfQosServiceClassPolicyEntry 5 }
4121
4122 --
4123 -- Payload Header Suppression(PHS) Table
4124 --
4125 docsIetfQosPHSTable OBJECT-TYPE
4126 SYNTAX SEQUENCE OF DocsIetfQosPHSEntry
4127 MAX-ACCESS not-accessible
4128 STATUS current
4129 DESCRIPTION "This table describes the set of payload header
4130 suppression entries."
4131 ::= { docsIetfQosMIBObjects 10 }
4132
4133 docsIetfQosPHSEntry OBJECT-TYPE
4134 SYNTAX DocsIetfQosPHSEntry
4135 MAX-ACCESS not-accessible
4136 STATUS current
4137
4138
4139
4140 <span class="grey">Patrick &amp; Murwin Standards Track [Page 74]</span></pre>
4141 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
4142 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4143
4144
4145 DESCRIPTION "A payload header suppression entry.
4146
4147 The ifIndex is an ifType of docsCableMaclayer(127).
4148 The index docsIetfQosServiceFlowId selects one
4149 service flow from the cable MAC layer interface.
4150 The docsIetfQosPktClassId index matches an
4151 index of the docsIetfQosPktClassTable."
4152 INDEX {
4153 ifIndex,
4154 docsIetfQosServiceFlowId,
4155 docsIetfQosPktClassId
4156 }
4157 ::= { docsIetfQosPHSTable 1 }
4158
4159 DocsIetfQosPHSEntry ::= SEQUENCE {
4160 docsIetfQosPHSField OCTET STRING,
4161 docsIetfQosPHSMask OCTET STRING,
4162 docsIetfQosPHSSize Integer32,
4163 docsIetfQosPHSVerify TruthValue,
4164 docsIetfQosPHSIndex Integer32
4165 }
4166
4167 docsIetfQosPHSField OBJECT-TYPE
4168 SYNTAX OCTET STRING (SIZE(0..255))
4169 MAX-ACCESS read-only
4170 STATUS current
4171 DESCRIPTION "Payload header suppression field defines the
4172 bytes of the header that must be
4173 suppressed/restored by the sending/receiving
4174 device.
4175
4176 The number of octets in this object should be
4177 the same as the value of docsIetfQosPHSSize."
4178 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.10.1">Appendix C.2.2.10.1</a>"
4179 ::= { docsIetfQosPHSEntry 1 }
4180
4181 docsIetfQosPHSMask OBJECT-TYPE
4182 SYNTAX OCTET STRING(SIZE(0..32))
4183 MAX-ACCESS read-only
4184 STATUS current
4185 DESCRIPTION "Payload header suppression mask defines the
4186 bit mask that is used in combination with the
4187 docsIetfQosPHSField. It defines which bytes in
4188 the header must be suppressed/restored by the
4189 sending or receiving device.
4190
4191 Each bit of this bit mask corresponds to a byte
4192 in the docsIetfQosPHSField, with the least
4193
4194
4195
4196 <span class="grey">Patrick &amp; Murwin Standards Track [Page 75]</span></pre>
4197 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
4198 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4199
4200
4201 significant bit corresponding to the first byte
4202 of the docsIetfQosPHSField.
4203
4204 Each bit of the bit mask specifies whether
4205 the corresponding byte should be suppressed
4206 in the packet. A bit value of '1' indicates that
4207 the byte should be suppressed by the sending
4208 device and restored by the receiving device.
4209 A bit value of '0' indicates that
4210 the byte should not be suppressed by the sending
4211 device or restored by the receiving device.
4212
4213 If the bit mask does not contain a bit for each
4214 byte in the docsIetfQosPHSField, then the bit mask
4215 is extended with bit values of '1' to be the
4216 necessary length."
4217 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.10.3">Appendix C.2.2.10.3</a>"
4218 ::= { docsIetfQosPHSEntry 2 }
4219
4220 docsIetfQosPHSSize OBJECT-TYPE
4221 SYNTAX Integer32 (0..255)
4222 MAX-ACCESS read-only
4223 STATUS current
4224 DESCRIPTION "Payload header suppression size specifies the
4225 number of bytes in the header to be suppressed
4226 and restored.
4227
4228 The value of this object must match the number
4229 of bytes in the docsIetfQosPHSField."
4230 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.10.4">Appendix C.2.2.10.4</a>"
4231 ::= { docsIetfQosPHSEntry 3 }
4232
4233 docsIetfQosPHSVerify OBJECT-TYPE
4234 SYNTAX TruthValue
4235 MAX-ACCESS read-only
4236 STATUS current
4237 DESCRIPTION "Payload header suppression verification value. If
4238 'true', the sender must verify docsIetfQosPHSField
4239 is the same as what is contained in the packet
4240 to be suppressed."
4241 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.10.5">Appendix C.2.2.10.5</a>"
4242 ::= { docsIetfQosPHSEntry 4 }
4243
4244 docsIetfQosPHSIndex OBJECT-TYPE
4245 SYNTAX Integer32 (1..255)
4246 MAX-ACCESS read-only
4247 STATUS current
4248 DESCRIPTION "Payload header suppression index uniquely
4249
4250
4251
4252 <span class="grey">Patrick &amp; Murwin Standards Track [Page 76]</span></pre>
4253 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
4254 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4255
4256
4257 references the PHS rule for a given service flow."
4258 REFERENCE "SP-RFIv2.0-I06-040804, <a href="#appendix-C.2.2.10.2">Appendix C.2.2.10.2</a>"
4259 ::= { docsIetfQosPHSEntry 5 }
4260
4261
4262 --
4263 -- docsIetfQosCmtsMacToSrvFlowTable (CMTS Only)
4264 --
4265 docsIetfQosCmtsMacToSrvFlowTable OBJECT-TYPE
4266 SYNTAX SEQUENCE OF DocsIetfQosCmtsMacToSrvFlowEntry
4267 MAX-ACCESS not-accessible
4268 STATUS current
4269 DESCRIPTION "This table provides for referencing the service
4270 flows associated with a particular cable modem.
4271 This allows indexing into other docsIetfQos
4272 tables that are indexed by docsIetfQosServiceFlowId
4273 and ifIndex."
4274 ::= { docsIetfQosMIBObjects 11 }
4275
4276 docsIetfQosCmtsMacToSrvFlowEntry OBJECT-TYPE
4277 SYNTAX DocsIetfQosCmtsMacToSrvFlowEntry
4278 MAX-ACCESS not-accessible
4279 STATUS current
4280 DESCRIPTION "An entry is created by CMTS for each service flow
4281 connected to this CMTS."
4282 INDEX {
4283 docsIetfQosCmtsCmMac,
4284 docsIetfQosCmtsServiceFlowId
4285 }
4286 ::= { docsIetfQosCmtsMacToSrvFlowTable 1 }
4287
4288 DocsIetfQosCmtsMacToSrvFlowEntry ::= SEQUENCE {
4289 docsIetfQosCmtsCmMac MacAddress,
4290 docsIetfQosCmtsServiceFlowId Unsigned32,
4291 docsIetfQosCmtsIfIndex InterfaceIndex
4292 }
4293
4294 docsIetfQosCmtsCmMac OBJECT-TYPE
4295 SYNTAX MacAddress
4296 MAX-ACCESS not-accessible
4297 STATUS current
4298 DESCRIPTION "The MAC address for the referenced CM."
4299 ::= { docsIetfQosCmtsMacToSrvFlowEntry 1 }
4300
4301 docsIetfQosCmtsServiceFlowId OBJECT-TYPE
4302 SYNTAX Unsigned32 (1..4294967295)
4303 MAX-ACCESS not-accessible
4304 STATUS current
4305
4306
4307
4308 <span class="grey">Patrick &amp; Murwin Standards Track [Page 77]</span></pre>
4309 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
4310 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4311
4312
4313 DESCRIPTION "An index assigned to a service flow by CMTS."
4314 ::= { docsIetfQosCmtsMacToSrvFlowEntry 2 }
4315
4316 docsIetfQosCmtsIfIndex OBJECT-TYPE
4317 SYNTAX InterfaceIndex
4318 MAX-ACCESS read-only
4319 STATUS current
4320 DESCRIPTION "The ifIndex of ifType docsCableMacLayer(127)
4321 on the CMTS that is connected to the Cable Modem."
4322 ::= { docsIetfQosCmtsMacToSrvFlowEntry 3 }
4323
4324 --
4325 -- Conformance definitions
4326 --
4327 docsIetfQosConformance OBJECT IDENTIFIER
4328 ::= { docsIetfQosMIB 2 }
4329
4330 docsIetfQosGroups OBJECT IDENTIFIER
4331 ::= { docsIetfQosConformance 1 }
4332
4333 docsIetfQosCompliances OBJECT IDENTIFIER
4334 ::= { docsIetfQosConformance 2 }
4335
4336 docsIetfQosCompliance MODULE-COMPLIANCE
4337 STATUS current
4338 DESCRIPTION
4339 "The compliance statement for MCNS Cable Modems and
4340 Cable Modem Termination Systems that implement DOCSIS
4341 Service Flows."
4342
4343 MODULE -- docsIetfQosMIB
4344 MANDATORY-GROUPS { docsIetfQosBaseGroup }
4345
4346 GROUP docsIetfQosCmtsGroup
4347 DESCRIPTION
4348 "This group is mandatory for Cable Modem Termination
4349 Systems (CMTS) and is not implemented for Cable Modems
4350 (CM)."
4351
4352 GROUP docsIetfQosParamSetGroup
4353 DESCRIPTION
4354 "This group is mandatory for Cable Modem Termination
4355 Systems (CMTS) and Cable Modems. Cable modems only
4356 implement objects in this group as read-only."
4357
4358 GROUP docsIetfQosSrvClassPolicyGroup
4359 DESCRIPTION
4360 "This group is optional for Cable Modem Termination
4361
4362
4363
4364 <span class="grey">Patrick &amp; Murwin Standards Track [Page 78]</span></pre>
4365 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
4366 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4367
4368
4369 Systems (CMTS) and Cable Modems. This group is relevant
4370 if policy-based service flow classification
4371 is implemented. See docsDevPolicyTable in
4372 DOCS-CABLE-DEVICE-MIB for more details."
4373
4374 GROUP docsIetfQosServiceClassGroup
4375 DESCRIPTION
4376 "This group is mandatory for a Cable Modem Termination
4377 System (CMTS) that implements expansion of Service Class
4378 Names in a QOS Parameter Set. This group is
4379 not implemented on the Cable Modems."
4380
4381 OBJECT docsIetfQosPktClassPkts
4382 DESCRIPTION
4383 "This object only needs to be implemented in entries
4384 that are classifying packets and not policing packets."
4385
4386 OBJECT docsIetfQosPktClassInetAddressType
4387 SYNTAX InetAddressType { ipv4(1) }
4388 DESCRIPTION
4389 "An implementation is only required to support IPv4
4390 address."
4391
4392 OBJECT docsIetfQosPktClassInetSourceAddr
4393 SYNTAX InetAddress (SIZE(4))
4394 DESCRIPTION
4395 "An implementation is only required to support IPv4
4396 address."
4397
4398 OBJECT docsIetfQosPktClassInetSourceMask
4399 SYNTAX InetAddress (SIZE(4))
4400 DESCRIPTION
4401 "An implementation is only required to support IPv4
4402 address."
4403
4404 OBJECT docsIetfQosPktClassInetDestAddr
4405 SYNTAX InetAddress (SIZE(4))
4406 DESCRIPTION
4407 "An implementation is only required to support IPv4
4408 address."
4409
4410 OBJECT docsIetfQosPktClassInetDestMask
4411 SYNTAX InetAddress (SIZE(4))
4412 DESCRIPTION
4413 "An implementation is only required to support IPv4
4414 address."
4415
4416 OBJECT docsIetfQosServiceClassStorageType
4417
4418
4419
4420 <span class="grey">Patrick &amp; Murwin Standards Track [Page 79]</span></pre>
4421 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
4422 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4423
4424
4425 SYNTAX StorageType { nonVolatile(3) }
4426 DESCRIPTION
4427 "An implementation is only required to support nonvolatile
4428 storage."
4429
4430 OBJECT docsIetfQosServiceClassPolicyStorageType
4431 SYNTAX StorageType { nonVolatile(3) }
4432 DESCRIPTION
4433 "An implementation is only required to support nonvolatile
4434 storage."
4435
4436 ::= { docsIetfQosCompliances 1 }
4437
4438 docsIetfQosBaseGroup OBJECT-GROUP
4439 OBJECTS {
4440 docsIetfQosPktClassDirection,
4441 docsIetfQosPktClassPriority,
4442 docsIetfQosPktClassIpTosLow,
4443 docsIetfQosPktClassIpTosHigh,
4444 docsIetfQosPktClassIpTosMask,
4445 docsIetfQosPktClassIpProtocol,
4446 docsIetfQosPktClassSourcePortStart,
4447 docsIetfQosPktClassSourcePortEnd,
4448 docsIetfQosPktClassDestPortStart,
4449 docsIetfQosPktClassDestPortEnd,
4450 docsIetfQosPktClassDestMacAddr,
4451 docsIetfQosPktClassDestMacMask,
4452 docsIetfQosPktClassSourceMacAddr,
4453 docsIetfQosPktClassEnetProtocolType,
4454 docsIetfQosPktClassEnetProtocol,
4455 docsIetfQosPktClassUserPriLow,
4456 docsIetfQosPktClassUserPriHigh,
4457 docsIetfQosPktClassVlanId,
4458 docsIetfQosPktClassStateActive,
4459 docsIetfQosPktClassPkts,
4460 docsIetfQosPktClassBitMap,
4461 docsIetfQosPktClassInetAddressType,
4462 docsIetfQosPktClassInetSourceAddr,
4463 docsIetfQosPktClassInetSourceMask,
4464 docsIetfQosPktClassInetDestAddr,
4465 docsIetfQosPktClassInetDestMask,
4466
4467 docsIetfQosServiceFlowSID,
4468 docsIetfQosServiceFlowDirection,
4469 docsIetfQosServiceFlowPrimary,
4470
4471 docsIetfQosServiceFlowPkts,
4472 docsIetfQosServiceFlowOctets,
4473
4474
4475
4476 <span class="grey">Patrick &amp; Murwin Standards Track [Page 80]</span></pre>
4477 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
4478 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4479
4480
4481 docsIetfQosServiceFlowTimeCreated,
4482 docsIetfQosServiceFlowTimeActive,
4483 docsIetfQosServiceFlowPHSUnknowns,
4484 docsIetfQosServiceFlowPolicedDropPkts,
4485 docsIetfQosServiceFlowPolicedDelayPkts,
4486
4487 docsIetfQosDSAReqs,
4488 docsIetfQosDSARsps,
4489 docsIetfQosDSAAcks,
4490 docsIetfQosDSCReqs,
4491 docsIetfQosDSCRsps,
4492 docsIetfQosDSCAcks,
4493 docsIetfQosDSDReqs,
4494 docsIetfQosDSDRsps,
4495 docsIetfQosDynamicAdds,
4496 docsIetfQosDynamicAddFails,
4497 docsIetfQosDynamicChanges,
4498 docsIetfQosDynamicChangeFails,
4499 docsIetfQosDynamicDeletes,
4500 docsIetfQosDynamicDeleteFails,
4501 docsIetfQosDCCReqs,
4502 docsIetfQosDCCRsps,
4503 docsIetfQosDCCAcks,
4504 docsIetfQosDCCs,
4505 docsIetfQosDCCFails,
4506
4507 docsIetfQosPHSField,
4508 docsIetfQosPHSMask,
4509 docsIetfQosPHSSize,
4510 docsIetfQosPHSVerify,
4511 docsIetfQosPHSIndex
4512 }
4513 STATUS current
4514 DESCRIPTION
4515 "Group of objects implemented in both Cable Modems and
4516 Cable Modem Termination Systems."
4517 ::= { docsIetfQosGroups 1 }
4518
4519 docsIetfQosParamSetGroup OBJECT-GROUP
4520 OBJECTS {
4521 docsIetfQosParamSetServiceClassName,
4522 docsIetfQosParamSetPriority,
4523 docsIetfQosParamSetMaxTrafficRate,
4524 docsIetfQosParamSetMaxTrafficBurst,
4525 docsIetfQosParamSetMinReservedRate,
4526 docsIetfQosParamSetMinReservedPkt,
4527 docsIetfQosParamSetActiveTimeout,
4528 docsIetfQosParamSetAdmittedTimeout,
4529
4530
4531
4532 <span class="grey">Patrick &amp; Murwin Standards Track [Page 81]</span></pre>
4533 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-82" ></span>
4534 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4535
4536
4537 docsIetfQosParamSetMaxConcatBurst,
4538 docsIetfQosParamSetSchedulingType,
4539 docsIetfQosParamSetNomPollInterval,
4540 docsIetfQosParamSetTolPollJitter,
4541 docsIetfQosParamSetUnsolicitGrantSize,
4542 docsIetfQosParamSetNomGrantInterval,
4543 docsIetfQosParamSetTolGrantJitter,
4544 docsIetfQosParamSetGrantsPerInterval,
4545 docsIetfQosParamSetTosAndMask,
4546 docsIetfQosParamSetTosOrMask,
4547 docsIetfQosParamSetMaxLatency,
4548 docsIetfQosParamSetRequestPolicyOct,
4549 docsIetfQosParamSetBitMap
4550 }
4551 STATUS current
4552 DESCRIPTION
4553 "Group of objects implemented in both Cable Modems and
4554 Cable Modem Termination Systems for QOS Parameter Sets."
4555 ::= { docsIetfQosGroups 2 }
4556
4557
4558 docsIetfQosCmtsGroup OBJECT-GROUP
4559 OBJECTS {
4560
4561 docsIetfQosUpstreamFragments,
4562 docsIetfQosUpstreamFragDiscards,
4563 docsIetfQosUpstreamConcatBursts,
4564
4565 docsIetfQosServiceFlowLogIfIndex,
4566 docsIetfQosServiceFlowLogSFID,
4567 docsIetfQosServiceFlowLogCmMac,
4568 docsIetfQosServiceFlowLogPkts,
4569 docsIetfQosServiceFlowLogOctets,
4570 docsIetfQosServiceFlowLogTimeDeleted,
4571 docsIetfQosServiceFlowLogTimeCreated,
4572 docsIetfQosServiceFlowLogTimeActive,
4573 docsIetfQosServiceFlowLogDirection,
4574 docsIetfQosServiceFlowLogPrimary,
4575 docsIetfQosServiceFlowLogServiceClassName,
4576 docsIetfQosServiceFlowLogPolicedDropPkts,
4577 docsIetfQosServiceFlowLogPolicedDelayPkts,
4578 docsIetfQosServiceFlowLogControl,
4579
4580 docsIetfQosCmtsIfIndex -- docsIetfQosCmtsMacToSrvFlowTable required
4581
4582 }
4583 STATUS current
4584 DESCRIPTION
4585
4586
4587
4588 <span class="grey">Patrick &amp; Murwin Standards Track [Page 82]</span></pre>
4589 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-83" ></span>
4590 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4591
4592
4593 "Group of objects implemented only in the CMTS."
4594 ::= { docsIetfQosGroups 3 }
4595
4596 docsIetfQosSrvClassPolicyGroup OBJECT-GROUP
4597 OBJECTS {
4598 docsIetfQosServiceClassPolicyName,
4599 docsIetfQosServiceClassPolicyRulePriority,
4600 docsIetfQosServiceClassPolicyStatus,
4601 docsIetfQosServiceClassPolicyStorageType
4602 }
4603 STATUS current
4604 DESCRIPTION
4605 "Group of objects implemented in both Cable Modems and
4606 Cable Modem Termination Systems when supporting policy-based
4607 service flows."
4608 ::= { docsIetfQosGroups 4 }
4609
4610 docsIetfQosServiceClassGroup OBJECT-GROUP
4611 OBJECTS {
4612 docsIetfQosServiceClassStatus,
4613 docsIetfQosServiceClassPriority,
4614 docsIetfQosServiceClassMaxTrafficRate,
4615 docsIetfQosServiceClassMaxTrafficBurst,
4616 docsIetfQosServiceClassMinReservedRate,
4617 docsIetfQosServiceClassMinReservedPkt,
4618 docsIetfQosServiceClassMaxConcatBurst,
4619 docsIetfQosServiceClassNomPollInterval,
4620 docsIetfQosServiceClassTolPollJitter,
4621 docsIetfQosServiceClassUnsolicitGrantSize,
4622 docsIetfQosServiceClassNomGrantInterval,
4623 docsIetfQosServiceClassTolGrantJitter,
4624 docsIetfQosServiceClassGrantsPerInterval,
4625 docsIetfQosServiceClassMaxLatency,
4626 docsIetfQosServiceClassActiveTimeout,
4627 docsIetfQosServiceClassAdmittedTimeout,
4628 docsIetfQosServiceClassSchedulingType,
4629 docsIetfQosServiceClassRequestPolicy,
4630 docsIetfQosServiceClassTosAndMask,
4631 docsIetfQosServiceClassTosOrMask,
4632 docsIetfQosServiceClassDirection,
4633 docsIetfQosServiceClassStorageType,
4634 docsIetfQosServiceClassDSCPOverwrite
4635 }
4636 STATUS current
4637 DESCRIPTION
4638 "Group of objects implemented only in Cable Modem
4639 Termination Systems when supporting expansion of Service
4640 Class Names in a QOS Parameter Set"
4641
4642
4643
4644 <span class="grey">Patrick &amp; Murwin Standards Track [Page 83]</span></pre>
4645 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-84" ></span>
4646 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4647
4648
4649 ::= { docsIetfQosGroups 5 }
4650
4651 END
4652
4653 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span>
4654
4655 This MIB module relates to an agent that will provide metropolitan
4656 public Internet access. As such, improper manipulation of the
4657 objects represented by this MIB module may result in denial of
4658 service to a large number of end-users [<a href="#ref-6" title="&quot;Cable Device Management Information Base for DOCSIS compliant Cable Modems and Cable Modem Termination Systems&quot;">6</a>]. Manipulation of the
4659 docsIetfQosServiceClassTable and docsIetfQosServiceClassPolicyTable
4660 may allow an end-user to increase his or her service levels, or
4661 affect other end-users in either a positive or negative manner. In
4662 addition, manipulation of docsIetfQosServiceFlowLogControl could
4663 allow an attacker to remove logs of packet and byte counts forwarded
4664 on a Service Flow. If such logs were used for billing, the attacker
4665 would obtain free service.
4666
4667 There are a number of management objects defined in this MIB module
4668 with a MAX-ACCESS clause of read-write and/or read-create. Such
4669 objects may be considered sensitive or vulnerable in some network
4670 environments. The support for SET operations in a non-secure
4671 environment without proper protection can have a negative effect on
4672 network operations. These are the tables and objects and their
4673 sensitivity/vulnerability:
4674
4675 o The docsIetfQosServiceClassTable provides a template of QOS
4676 parameters such as maximum rate limits for a named service
4677 class. Changing these parameters would allow an attacker to
4678 obtain an unauthorized class of service.
4679
4680 o The docsIetfQosServiceClassPolicyTable applies CMTS vendor
4681 proprietary policies for packet forwarding, including
4682 dropping, scheduling, notification, or other policies.
4683 Changing this table could allow an attacker to deny service to
4684 all subscribers of the CMTS or could grant the attacker
4685 unauthorized forwarding policies.
4686
4687 o The docsIetfQosServiceFlowLogControl object controls the
4688 deletion of entries in the docsIetfQosServiceFlowLogTable,
4689 which acts as a historical "detail record" of DOCSIS Service
4690 Flow packets and bytes transmitted. Such records may be used
4691 for billing purposes, so the unauthorized deletion of the
4692 records can result in free service.
4693
4694 Some of the readable objects in this MIB module (i.e., objects with a
4695 MAX-ACCESS other than not-accessible) may be considered sensitive or
4696 vulnerable in some network environments. It is thus important to
4697
4698
4699
4700 <span class="grey">Patrick &amp; Murwin Standards Track [Page 84]</span></pre>
4701 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-85" ></span>
4702 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4703
4704
4705 control even GET access to these objects and possibly to even encrypt
4706 the values of these objects when sending them over the network via
4707 SNMP. These are the tables and objects and their
4708 sensitivity/vulnerability:
4709
4710 o Unauthorized SNMP GET access of the docsIetfQosPktClassTable
4711 or docsIetfQosPHSTable can allow an attacker to learn IP
4712 addresses permitted to have enhanced quality of service, for
4713 possible spoofing. This table typically contains the IP
4714 addresses involved in voice-over-IP sessions, for example.
4715
4716 o Unauthorized SNMP GET access of the docsIetfQosParamSetTable
4717 allows an attacker to learn the names of Service Classes that
4718 are permitted to have enhanced QoS service, and the values of
4719 that enhanced service. That name can be referenced in an
4720 unauthorized DOCSIS cable modem configuration file to obtain
4721 enhanced service.
4722
4723 o Unauthorized SNMP GET access of the
4724 docsIetfQosServiceFlowTable can tell an attacker when Service
4725 Flows are active, e.g., when a voice-over-IP call is in
4726 progress.
4727
4728 Unauthorized SNMP GET access of the
4729 docsIetfQosServiceFlowLogTable can expose private information
4730 about network usage.
4731
4732 o Unauthorized SNMP GET access of the
4733 docsIetfQosServiceFlowStatsTable,
4734 docsIetfQosUpstreamStatsTable,
4735 docsIetfQosDynamicServiceStatsTable,
4736 docsIetfQosServiceFlowLogTable, and
4737 docsIetfQosCmtsMacToSrvFlowTable can tell an attacker the
4738 volume of traffic to and from any Service Flow in the system,
4739 resulting in loss of privacy of the amount and direction of
4740 data transfer.
4741
4742 SNMP versions prior to SNMPv3 did not include adequate security.
4743 Even if the network itself is secure (for example by using IPSec),
4744 even then, there is no control as to who on the secure network is
4745 allowed to access and GET/SET (read/change/create/delete) the objects
4746 in this MIB module. It is RECOMMENDED that implementers consider the
4747 security features as provided by the SNMPv3 framework (see [<a href="#ref-15" title="&quot;Introduction and Applicability Statements for Internet-Standard Management Framework&quot;">15</a>],
4748 section 8), including full support for the SNMPv3 cryptographic
4749 mechanisms (for authentication and privacy). Further, deployment of
4750 SNMP versions prior to SNMPv3 is NOT RECOMMENDED. Instead, it is
4751 RECOMMENDED to deploy SNMPv3 and to enable cryptographic security.
4752 It is then a customer/operator responsibility to ensure that the SNMP
4753
4754
4755
4756 <span class="grey">Patrick &amp; Murwin Standards Track [Page 85]</span></pre>
4757 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-86" ></span>
4758 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4759
4760
4761 entity giving access to an instance of this MIB module, is properly
4762 configured to give access to the objects only to those principals
4763 (users) that have legitimate rights to indeed GET or SET
4764 (change/create/delete) them.
4765
4766 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. IANA Considerations</span>
4767
4768 The MIB module in this document uses the following IANA-assigned
4769 OBJECT IDENTIFIER values recorded in the SMI Numbers registry:
4770
4771 Descriptor OBJECT IDENTIFIER Value
4772 -------------- -----------------------
4773 docsIetfQosMIB { mib-2 127 }
4774
4775 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. Acknowledgements</span>
4776
4777 The authors gratefully acknowledge the comments and suggestions of
4778 the IP over Cable Data Network (IPCDN) Working Group (especially the
4779 co-chairs Richard Woundy and Jean-Francois Mule) as well as the
4780 contributions of the Operation and Management Area Director, Bert
4781 Wijnen.
4782
4783 <span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. Normative References</span>
4784
4785 [<a id="ref-1">1</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder, "Structure of
4786 Management Information Version 2 (SMIv2)", STD 58, <a href="./rfc2578">RFC 2578</a>,
4787 April 1999.
4788
4789 [<a id="ref-2">2</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder, "Textual
4790 Conventions for SMIv2", STD 58, <a href="./rfc2579">RFC 2579</a>, April 1999.
4791
4792 [<a id="ref-3">3</a>] McCloghrie, K., Perkins, D., and J. Schoenwaelder, "Conformance
4793 Statements for SMIv2", STD 58, <a href="./rfc2580">RFC 2580</a>, April 1999.
4794
4795 [<a id="ref-4">4</a>] "Data-Over-Cable Service Interface Specifications: Radio
4796 Frequency Interface Specification SP-RFIv2.0-I06-040804",
4797 DOCSIS, August 2004,
4798 <a href="http://www.cablelabs.com/specifications/archives/">http://www.cablelabs.com/specifications/archives/</a>.
4799
4800 [<a id="ref-5">5</a>] Bradner, S., "Key words for use in RFCs to Indicate Requirement
4801 Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
4802
4803 [<a id="ref-6">6</a>] St. Johns, M., "Cable Device Management Information Base for
4804 DOCSIS compliant Cable Modems and Cable Modem Termination
4805 Systems", <a href="./rfc2669">RFC 2669</a>, August 1999.
4806
4807
4808
4809
4810
4811
4812 <span class="grey">Patrick &amp; Murwin Standards Track [Page 86]</span></pre>
4813 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-87" ></span>
4814 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4815
4816
4817 [<a id="ref-7">7</a>] St. Johns, M., "Radio Frequency (RF) Interface Management
4818 Information Base for MCNS/DOCSIS compliant RF interfaces", <a href="./rfc2670">RFC</a>
4819 <a href="./rfc2670">2670</a>, August 1999.
4820
4821 [<a id="ref-8">8</a>] Daniele, M., Haberman, B., Routhier, S., and J. Schoenwaelder,
4822 "Textual Conventions for Internet Network Addresses", <a href="./rfc4001">RFC 4001</a>,
4823 February 2005.
4824
4825 [<a id="ref-9">9</a>] Grossman, D., "New Terminology and Clarifications for Diffserv",
4826 <a href="./rfc3260">RFC 3260</a>, April 2002.
4827
4828 [<a id="ref-10">10</a>] Ramakrishnan, K., Floyd, S., and D. Black, "The Addition of
4829 Explicit Congestion Notification (ECN) to IP", <a href="./rfc3168">RFC 3168</a>,
4830 September 2001.
4831
4832 [<a id="ref-11">11</a>] McCloghrie, K. and F. Kastenholz, "The Interfaces Group MIB",
4833 <a href="./rfc2863">RFC 2863</a>, June 2000.
4834
4835 [<a id="ref-12">12</a>] Harrington, D., Presuhn, R., and B. Wijnen, "An Architecture for
4836 Describing Simple Network Management Protocol (SNMP) Management
4837 Frameworks", STD 62, <a href="./rfc3411">RFC 3411</a>, December 2002.
4838
4839 [<a id="ref-13">13</a>] Baker, F., Chan, K., and A. Smith, "Management Information Base
4840 for the Differentiated Services Architecture", <a href="./rfc3289">RFC 3289</a>, May
4841 2002.
4842
4843 [<a id="ref-14">14</a>] Postel, J., "Internet Protocol", STD 5, <a href="./rfc791">RFC 791</a>, September 1981.
4844
4845 <span class="h2"><a class="selflink" id="section-10" href="#section-10">10</a>. Informative References</span>
4846
4847 [<a id="ref-15">15</a>] Case, J., Mundy, R., Partain, D., and B. Stewart, "Introduction
4848 and Applicability Statements for Internet-Standard Management
4849 Framework", <a href="./rfc3410">RFC 3410</a>, December 2002.
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868 <span class="grey">Patrick &amp; Murwin Standards Track [Page 87]</span></pre>
4869 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-88" ></span>
4870 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4871
4872
4873 Authors' Addresses
4874
4875 Michael Patrick
4876 Motorola Broadband Communications Sector
4877 111 Locke Drive
4878 Marlborough, MA 01752
4879
4880 Phone: (508) 786-7563
4881 EMail: [email protected]
4882
4883
4884 William Murwin
4885 Motorola Broadband Communications Sector
4886 111 Locke Drive
4887 Marlborough, MA 01752
4888
4889 Phone: (508) 786-7594
4890 EMail: [email protected]
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924 <span class="grey">Patrick &amp; Murwin Standards Track [Page 88]</span></pre>
4925 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-89" ></span>
4926 <span class="grey"><a href="./rfc4323">RFC 4323</a> IPCDN DOCSIS QoS MIB January 2006</span>
4927
4928
4929 Full Copyright Statement
4930
4931 Copyright (C) The Internet Society (2006).
4932
4933 This document is subject to the rights, licenses and restrictions
4934 contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, and except as set forth therein, the authors
4935 retain all their rights.
4936
4937 This document and the information contained herein are provided on an
4938 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
4939 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
4940 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
4941 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
4942 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
4943 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
4944
4945 Intellectual Property
4946
4947 The IETF takes no position regarding the validity or scope of any
4948 Intellectual Property Rights or other rights that might be claimed to
4949 pertain to the implementation or use of the technology described in
4950 this document or the extent to which any license under such rights
4951 might or might not be available; nor does it represent that it has
4952 made any independent effort to identify any such rights. Information
4953 on the procedures with respect to rights in RFC documents can be
4954 found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>.
4955
4956 Copies of IPR disclosures made to the IETF Secretariat and any
4957 assurances of licenses to be made available, or the result of an
4958 attempt made to obtain a general license or permission for the use of
4959 such proprietary rights by implementers or users of this
4960 specification can be obtained from the IETF on-line IPR repository at
4961 <a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>.
4962
4963 The IETF invites any interested party to bring to its attention any
4964 copyrights, patents or patent applications, or other proprietary
4965 rights that may cover technology that may be required to implement
4966 this standard. Please address the information to the IETF at
4967 [email protected].
4968
4969 Acknowledgement
4970
4971 Funding for the RFC Editor function is provided by the IETF
4972 Administrative Support Activity (IASA).
4973
4974
4975
4976
4977
4978
4979
4980 Patrick &amp; Murwin Standards Track [Page 89]
4981 </pre>