idnits 2.17.1 draft-ietf-ipcdn-docs-rfmibv2-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Looks like you're using RFC 2026 boilerplate. This must be updated to follow RFC 3978/3979, as updated by RFC 4748. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. ** There are 69 instances of too long lines in the document, the longest one being 7 characters in excess of 72. ** The abstract seems to contain references ([5], [6], [7]), which it shouldn't. Please replace those with straight textual mentions of the documents in question. ** The document seems to lack a both a reference to RFC 2119 and the recommended RFC 2119 boilerplate, even if it appears to use RFC 2119 keywords. RFC 2119 keyword, line 348: '... ifStackTable [17] MUST be implemented to identify relationships among...' RFC 2119 keyword, line 1341: '... MUST NOT be changed wh...' RFC 2119 keyword, line 1354: '... MUST NOT be changed wh...' RFC 2119 keyword, line 1365: '... MUST NOT be changed wh...' RFC 2119 keyword, line 1377: '... MUST NOT be changed wh...' (4 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 3616 has weird spacing: '...for the purpo...' -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- Couldn't find a document date in the document -- date freshness check skipped. Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) ** Obsolete normative reference: RFC 2571 (ref. '1') (Obsoleted by RFC 3411) ** Downref: Normative reference to an Informational RFC: RFC 1215 (ref. '4') ** Downref: Normative reference to an Historic RFC: RFC 1157 (ref. '8') ** Downref: Normative reference to an Historic RFC: RFC 1901 (ref. '9') ** Obsolete normative reference: RFC 1906 (ref. '10') (Obsoleted by RFC 3417) ** Obsolete normative reference: RFC 2572 (ref. '11') (Obsoleted by RFC 3412) ** Obsolete normative reference: RFC 2574 (ref. '12') (Obsoleted by RFC 3414) ** Obsolete normative reference: RFC 1905 (ref. '13') (Obsoleted by RFC 3416) ** Obsolete normative reference: RFC 2573 (ref. '14') (Obsoleted by RFC 3413) ** Obsolete normative reference: RFC 2575 (ref. '15') (Obsoleted by RFC 3415) -- Possible downref: Non-RFC (?) normative reference: ref. '16' ** Obsolete normative reference: RFC 2669 (ref. '18') (Obsoleted by RFC 4639) -- Possible downref: Non-RFC (?) normative reference: ref. '19' -- Possible downref: Non-RFC (?) normative reference: ref. '20' ** Obsolete normative reference: RFC 2570 (ref. '21') (Obsoleted by RFC 3410) ** Obsolete normative reference: RFC 2670 (ref. '22') (Obsoleted by RFC 4546) -- Possible downref: Non-RFC (?) normative reference: ref. '23' -- Possible downref: Non-RFC (?) normative reference: ref. '24' Summary: 19 errors (**), 0 flaws (~~), 3 warnings (==), 7 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Draft R. Woundy 3 IPCDN Working Group Cisco Systems 4 draft-ietf-ipcdn-docs-rfmibv2-00.txt Expires: August 2001 6 Radio Frequency (RF) Interface Management Information Base 7 for DOCSIS compliant RF interfaces 9 Status of this Memo 11 This document is an Internet-Draft and is in full conformance with 12 all provisions of Section 10 of RFC2026. 14 Internet-Drafts are working documents of the Internet Engineering 15 Task Force (IETF), its areas, and its working groups. Note that 16 other groups may also distribute working documents as Internet- 17 Drafts. 19 Internet-Drafts are draft documents valid for a maximum of six months 20 and may be updated, replaced, or obsoleted by other documents at any 21 time. It is inappropriate to use Internet-Drafts as reference 22 material or to cite them other than as "work in progress." 24 The list of current Internet-Drafts can be accessed at 25 http://www.ietf.org/ietf/1id-abstracts.txt 27 The list of Internet-Draft Shadow Directories can be accessed at 28 http://www.ietf.org/shadow.html. 30 Copyright Notice 32 Copyright (C) The Internet Society (2001). All Rights Reserved. 34 Abstract 36 This memo is a draft revision of the standards track RFC-2670. 37 Please see "Revision Descriptions" below for a description of 38 changes. This document or its successor will obsolete RFC-2670 when 39 accepted. 41 This memo defines a portion of the Management Information Base (MIB) 42 for use with network management protocols in the Internet community. 43 In particular, it defines a basic set of managed objects for SNMP- 44 based management of DOCSIS compliant Radio Frequency (RF) interfaces. 46 This memo specifies a MIB module in a manner that is compliant to the 47 SNMP SMIv2 [5][6][7]. The set of objects are consistent with the 48 SNMP framework and existing SNMP standards. 50 This memo is a product of the IPCDN working group within the Internet 51 Engineering Task Force. Comments are solicited and should be 52 addressed to the working group's mailing list at ipcdn@ietf.org 53 and/or the author. 55 Table of Contents 57 1 The SNMP Management Framework ................................... 3 58 2 Glossary ........................................................ 4 59 2.1 CATV .......................................................... 4 60 2.2 Channel ....................................................... 4 61 2.3 CM ............................................................ 4 62 2.4 CMTS .......................................................... 4 63 2.5 Codeword ...................................................... 4 64 2.6 Data Packet ................................................... 5 65 2.7 dBmV .......................................................... 5 66 2.8 DOCSIS ........................................................ 5 67 2.9 Downstream .................................................... 5 68 2.10 EuroDOCSIS ................................................... 5 69 2.11 Head-end ..................................................... 5 70 2.12 MAC Packet ................................................... 5 71 2.13 Mini-slot .................................................... 5 72 2.14 QPSK ......................................................... 5 73 2.15 QAM .......................................................... 5 74 2.16 RF ........................................................... 6 75 2.17 Symbol-times ................................................. 6 76 2.18 Upstream ..................................................... 6 77 3 Overview ........................................................ 6 78 3.1 Structure of the MIB .......................................... 6 79 3.1.1 docsIfBaseObjects ........................................... 6 80 3.1.2 docsIfCmObjects ............................................. 7 81 3.1.3 docsIfCmtsObjects ........................................... 7 82 3.2 Relationship to the Interfaces MIB ............................ 7 83 3.2.1 Layering Model .............................................. 7 84 3.2.2 Virtual Circuits ............................................ 9 85 3.2.3 ifTestTable ................................................. 9 86 3.2.4 ifRcvAddressTable ........................................... 9 87 3.2.5 ifEntry ..................................................... 9 88 3.2.5.1 ifEntry for Downstream interfaces ......................... 9 89 3.2.5.1.1 ifEntry for Downstream interfaces in Cable Modem 90 Termination Systems .......................................... 9 91 3.2.5.1.2 ifEntry for Downstream interfaces in Cable Modems ...... 11 92 3.2.5.2 ifEntry for Upstream interfaces .......................... 12 93 3.2.5.2.1 ifEntry for Upstream interfaces in Cable Modem 94 Termination Systems ......................................... 12 95 3.2.5.2.2 ifEntry for Upstream interfaces in Cable Modems ........ 14 96 3.2.5.3 ifEntry for the MAC Layer ................................ 15 97 4 Definitions .................................................... 17 98 5 Acknowledgments ................................................ 70 99 6 Revision Descriptions ...........................................70 100 7 References ..................................................... 71 101 8 Security Considerations ........................................ 74 102 9 Intellectual Property .......................................... 74 103 10 Author's Address .............................................. 75 104 11 Full Copyright Statement ...................................... 75 106 1. The SNMP Management Framework 108 The SNMP Management Framework presently consists of five major 109 components: 111 o An overall architecture, described in RFC 2571 [1]. 113 o Mechanisms for describing and naming objects and events for the 114 purpose of management. The first version of this Structure of 115 Management Information (SMI) is called SMIv1 and described in STD 116 16, RFC 1155 [2], STD 16, RFC 1212 [3] and RFC 1215 [4]. The 117 second version, called SMIv2, is described in STD 58, RFC 2578 118 [5], STD 58, RFC 2579 [6] and STD 58, RFC 2580 [7]. 120 o Message protocols for transferring management information. The 121 first version of the SNMP message protocol is called SNMPv1 and 122 described in STD 15, RFC 1157 [8]. A second version of the SNMP 123 message protocol, which is not an Internet standards track 124 protocol, is called SNMPv2c and described in RFC 1901 [9] and RFC 125 1906 [10]. The third version of the message protocol is called 126 SNMPv3 and described in RFC 1906 [10], RFC 2572 [11] and RFC 2574 127 [12]. 129 o Protocol operations for accessing management information. The 130 first set of protocol operations and associated PDU formats is 131 described in STD 15, RFC 1157 [8]. A second set of protocol 132 operations and associated PDU formats is described in RFC 1905 133 [13]. 135 o A set of fundamental applications described in RFC 2573 [14] and 136 the view-based access control mechanism described in RFC 2575 137 [15]. 139 A more detailed introduction to the current SNMP Management Framework 140 can be found in RFC 2570 [21]. 142 Managed objects are accessed via a virtual information store, termed 143 the Management Information Base or MIB. Objects in the MIB are 144 defined using the mechanisms defined in the SMI. 146 This memo specifies a MIB module that is compliant to the SMIv2. A 147 MIB conforming to the SMIv1 can be produced through the appropriate 148 translations. The resulting translated MIB must be semantically 149 equivalent, except where objects or events are omitted because no 150 translation is possible (use of Counter64). Some machine readable 151 information in SMIv2 will be converted into textual descriptions in 152 SMIv1 during the translation process. However, this loss of machine 153 readable information is not considered to change the semantics of the 154 MIB. 156 2. Glossary 158 The terms in this document are derived either from normal cable 159 system usage, or from the documents associated with the Data Over 160 Cable Service Interface Specification process. 162 2.1. CATV 164 Originally "Community Antenna Television", now used to refer to any 165 cable or hybrid fiber and cable system used to deliver video signals 166 to a community. 168 2.2. Channel 170 A specific frequency allocation with an RF medium, specified by 171 channel width in Hertz (cycles per second) and by center frequency. 172 Within the North American cable systems, upstream channels are 173 generally allocated from the 5-42MHz range while downstream channels 174 are generally allocated from the 50-750MHz range depending on the 175 capabilities of the given system. The typical broadcast channel 176 width in the US is 6MHz. Upstream channel widths for DOCSIS vary. 178 For European cable systems, upstream channels vary by country. The 179 upper edge of upstream channel allocations vary between 25 MHz to 65 180 MHz, and the lower edge of downstream channel allocations vary 181 between 47 MHz and 87.5 MHz. The typical broadcast channel width in 182 Europe is 8MHz. The actual parameters are of concern to systems 183 deploying EuroDOCSIS technology. 185 2.3. CM Cable Modem. 187 A CM acts as a "slave" station in a DOCSIS compliant cable data 188 system. 190 2.4. CMTS Cable Modem Termination System. 192 A generic term covering a cable bridge or cable router in a head-end. 193 A CMTS acts as the master station in a DOCSIS compliant cable data 194 system. It is the only station that transmits downstream, and it 195 controls the scheduling of upstream transmissions by its associated 196 CMs. 198 2.5. Codeword 200 See [16]. A characteristic of the Foward Error Correction scheme used 201 above the RF media layer. 203 2.6. Data Packet 205 The payload portion of the MAC Packet. 207 2.7. dBmV 209 Decibel relative to one milli-volt. A measure of RF power. 211 2.8. DOCSIS 213 "Data Over Cable Interface Specification". A term referring to the 214 ITU-T J.112 Annex B standard for cable modem systems [20]. 216 2.9. Downstream 218 The direction from the head-end towards the subscriber. 220 2.10. EuroDOCSIS 222 A variation of DOCSIS designed to operate in European cable 223 environments [24]. 225 2.11. Head-end 227 The origination point in most cable systems of the subscriber video 228 signals. 230 2.12. MAC Packet 232 A DOCSIS PDU. 234 2.13. Mini-slot 236 See [16]. In general, an interval of time which is allocated by the 237 CMTS to a given CM for that CM to transmit in an upstream direction. 239 2.14. QPSK Quadrature Phase Shift Keying. 241 A particular modulation scheme on an RF medium. See [19]. 243 2.15. QAM Quadrature Amplitude Modulation. 245 A particular modulation scheme on on RF medium. Usually expressed 246 with a number indicating the size of the modulation constellation 247 (e.g. 16 QAM). See [19], or any other book on digital communications 248 over RF for a complete explanation of this. 250 2.16. RF 252 Radio Frequency. 254 2.17. Symbol-times 256 See [16]. A characteristic of the RF modulation scheme. 258 2.18. Upstream 260 The direction from the subscriber towards the head-end. 262 3. Overview 264 This MIB provides a set of objects required for the management of 265 DOCSIS compliant Cable Modem (CM) and Cable Modem Termination System 266 (CMTS) RF interfaces. The specification is derived in part from the 267 parameters and protocols described in DOCSIS Radio Frequency 268 Interface Specification [16]. 270 3.1. Structure of the MIB 272 This MIB is structured as three groups: 274 o Management information pertinent to both Cable Modems (CM) and 275 Cable Modem Termination Systems (CMTS) (docsIfBaseObjects). 277 o Management information pertinent to Cable Modems only 278 (docsIfCmObjects). 280 o Management information pertinent to Cable Modem Termination 281 Systems only (docsIfCmtsObjects). 283 Tables within each of these groups group objects functionally - e.g. 284 Quality of Service, Channel characteristics, MAC layer management, 285 etc. Rows created automatically (e.g. by the device according to the 286 hardware configuration) may and generally will have a mixture of 287 configuration and status objects within them. Rows that are meant to 288 be created by the management station are generally restricted to 289 configuration (read-create) objects. 291 3.1.1. docsIfBaseObjects 293 docsIfDownstreamChannelTable - This table describes the active 294 downstream channels for a CMTS and the received downstream channel 295 for a CM. 297 docsIfUpstreamChannelTable - This table describes the active upstream 298 channels for a a CMTS and the current upstream transmission channel 299 for a CM. 301 docsIfQosProfileTable - This table describes the valid Quality of 302 Service service profiles for the cable data system. 304 docsIfSignalQualityTable - This table is used to monitor RF signal 305 quality characteristics of received signals. 307 3.1.2. docsIfCmObjects 309 docsIfCmMacTable - This table is used to monitor the DOCSIS MAC 310 interface and can be considered an extension to the ifEntry. 312 docsIfCmServiceTable - This table describes the upstream service 313 queues available at this CM. There is a comparable table at the 314 CMTS, docsIfCmtsServiceEntry, which describes the service queues from 315 the point of view of the CMTS. 317 3.1.3. docsIfCmtsObjects 319 docsIfCmtsStatusTable - This table provides a set of aggregated 320 counters which roll-up values and events that occur on the underlying 321 sub-interfaces. 323 docsIfCmtsCmStatusTable - This table is used to hold information 324 about known (i.e. ranging, registered, and/or previously online) 325 cable modems on the system serviced by this CMTS. 327 docsIfCmtsServiceEntry - This table provides access to the 328 information related to upstream service queues. 330 docsIfCmtsModulationTable - This table allows control over the 331 modulation profiles for RF channels associated with this CMTS. 333 docsIfCmtsMacToCmTable - This table allows fast access into the 334 docsIfCmtsCmTable via a MAC address (of the CM) interface. 336 3.2. Relationship to the Interfaces MIB 338 This section clarifies the relationship of this MIB to the Interfaces 339 MIB [17]. Several areas of correlation are addressed in the 340 following subsections. The implementor is referred to the Interfaces 341 MIB document in order to understand the general intent of these 342 areas. 344 3.2.1. Layering Model 346 An instance of ifEntry exists for each RF Downstream interface, for 347 each RF Upstream interface, and for each RF MAC layer. The 348 ifStackTable [17] MUST be implemented to identify relationships among 349 sub-interfaces. 351 The following example illustrates a MAC interface with one downstream 352 and two upstream channels. 354 | <== to network layer 355 +-------------+--------------+ 356 | RF MAC | 357 +----+---------+-----------+-+ 358 | | | 359 +---------+---+ +---+-------+ +-+---------+ 360 | Downstream1 | | Upstream1 | | Upstream2 | 361 +-------------+ +-----------+ +-----------+ 363 As can be seen from this example, the RF MAC interface is layered on 364 top of the downstream and upstream interfaces. 366 In this example, the assignment of index values could be as follows: 368 ifIndex ifType Description 370 1 docsCableMaclayer(127) CATV MAC Layer 371 2 docsCableDownstream(128) CATV Downstream interface 372 3 docsCableUpstream(129) CATV Upstream interface 373 4 docsCableUpstream(129) CATV Upstream interface 375 The corresponding ifStack entries would then be: 377 | IfStackHigherLayer | ifStackLowerLayer | 378 | 0 | 1 | 379 | 1 | 2 | 380 | 1 | 3 | 381 | 1 | 4 | 382 | 2 | 0 | 383 | 3 | 0 | 384 | 4 | 0 | 386 The same interface model can also be used in Telephony or Telco 387 Return systems. A pure Telco Return system (Cable Modem as well as 388 Cable Modem Termination System) would not have upstream, but only 389 downstream cable channels. Systems supporting both Telco Return and 390 cable upstream channels can use the above model without modification. 392 Telco Return Upstream channel(s) are handled by the appropriate MIBs, 393 such as PPP or Modem MIBs. 395 3.2.2. Virtual Circuits 397 This medium does not support virtual circuits and this area is not 398 applicable to this MIB. 400 3.2.3. ifTestTable 402 The ifTestTable is not supported by this MIB. 404 3.2.4. ifRcvAddressTable 406 The ifRcvAddressTable is not supported by this MIB. 408 3.2.5. ifEntry 410 This section documents only the differences from the requirements 411 specified in the Interfaces MIB. See that MIB for columns omitted 412 from the descriptions below. 414 3.2.5.1. ifEntry for Downstream interfaces 416 The ifEntry for Downstream interfaces supports the 417 ifGeneralInformationGroup and the ifPacketGroup of the Interfaces 418 MIB. This is an output only interface at the CMTS and all input 419 status counters - ifIn* - will return zero. This is an input only 420 interface at the CM and all output status counters - ifOut* - will 421 return zero. 423 3.2.5.1.1. ifEntry for Downstream interfaces in Cable Modem Termination 424 Systems 426 ifTable Comments 427 ============== =========================================== 428 ifIndex Each RF Cable Downstream interface is represented 429 by an ifEntry. 431 ifType The IANA value of docsCableDownstream(128). 433 ifSpeed Return the speed of this downstream channel. 434 The returned value the raw bandwidth in bits/s 435 of this interface. This is the symbol rate 436 multiplied with the number of bits per symbol. 438 ifPhysAddress Return an empty string. 440 ifAdminStatus The administrative status of this interface. 442 ifOperStatus The current operational status of this interface. 444 ifMtu The size of the largest frame which can be 445 sent on this interface, specified in octets. 446 The value includes the length of the MAC header. 448 ifInOctets Return zero. 450 ifInUcastPkts Return zero. 452 ifInMulticastPkts Return zero. 454 ifInBroadcastPkts Return zero. 456 ifInDiscards Return zero. 458 ifInErrors Return zero. 460 ifInUnknownProtos Return zero. 462 ifOutOctets The total number of octets transmitted on this 463 interface. This includes MAC packets as well as 464 data packets, and includes the length of the MAC 465 header. 467 ifOutUcastPkts The number of Unicast packets transmitted on this 468 interface. This includes MAC packets as well as 469 data packets. 471 ifOutMulticastPkts 472 Return the number of Multicast packets transmitted 473 on this interface. 474 This includes MAC packets as well as data packets. 476 ifOutBroadcastPkts 477 Return the number of broadcast packets transmitted 478 on this interface. 479 This includes MAC packets as well as data packets. 481 ifOutDiscards The total number of outbound packets which 482 were discarded. Possible reasons are: 484 buffer shortage. 486 ifOutErrors The number of packets which could not be 487 transmitted due to errors. 489 ifPromiscuousMode Return false. 491 3.2.5.1.2. ifEntry for Downstream interfaces in Cable Modems 493 ifTable Comments 494 ============== =========================================== 495 ifIndex Each RF Cable Downstream interface is represented 496 by an ifEntry. 498 ifType The IANA value of docsCableDownstream(128). 500 ifSpeed Return the speed of this downstream channel. 501 The returned value the raw bandwidth in bits/s 502 of this interface. This is the symbol rate 503 multiplied with the number of bits per symbol. 505 ifPhysAddress Return an empty string. 507 ifAdminStatus The administrative status of this interface. 509 ifOperStatus The current operational status of this interface. 511 ifMtu The size of the largest frame which can be 512 received from this interface, specified in octets. 513 The value includes the length of the MAC header. 515 ifInOctets The total number of octets received on this 516 interface. This includes data packets as well as 517 MAC layer packets, and includes the length of the 518 MAC header. 520 ifInUcastPkts The number of Unicast packets received on this 521 interface. This includes data packets as well as 522 MAC layer packets. 524 ifInMulticastPkts Return the number of Multicast packets received 525 on this interface. This includes data packets as 526 well as MAC layer packets. 528 ifInBroadcastPkts Return the number of Broadcast packets received 529 on this interface. This includes data packets 530 as well as MAC layer packets. 532 ifInDiscards The total number of received packets which have 533 been discarded. 534 The possible reasons are: buffer shortage. 536 ifInErrors The number of inbound packets that contained 537 errors preventing them from being deliverable 538 to higher layers. 539 Possible reasons are: MAC FCS error. 541 ifInUnknownProtos The number of frames with an unknown packet type. 542 These are MAC frames with an unknown packet type. 544 ifOutOctets Return zero. 546 ifOutUcastPkts Return zero. 548 ifOutMulticastPkts 549 Return zero. 551 ifOutBroadcastPkts 552 Return zero. 554 ifOutDiscards Return zero. 556 ifOutErrors Return zero. 558 ifPromiscuousMode Refer to the Interfaces MIB. 560 3.2.5.2. ifEntry for Upstream interfaces 562 The ifEntry for Upstream interfaces supports the 563 ifGeneralInformationGroup and the ifPacketGroup of the Interfaces 564 MIB. This is an input only interface at the CMTS and all output 565 status counters - ifOut* - will return zero. This is an output only 566 interface at the CM and all input status counters - ifIn* - will 567 return zero. 569 3.2.5.2.1. ifEntry for Upstream interfaces in Cable Modem Termination 570 Systems 572 ifTable Comments 573 ============== =========================================== 574 ifIndex Each RF Cable Upstream interface is represented 575 by an ifEntry. 577 ifType The IANA value of docsCableUpstream(129). 579 ifSpeed Return the speed of this upstream channel. 581 The returned value is the raw bandwidth 582 in bits/s of this interface, regarding the 583 highest speed modulation profile that is 584 defined. This is the symbol rate multiplied 585 with the number of bits per symbol for this 586 modulation profile. 588 ifPhysAddress Return an empty string. 590 ifAdminStatus The administrative status of this interface. 592 ifOperStatus The current operational status of this interface. 594 ifMtu The size of the largest frame which can be 595 received on this interface, specified in octets. 596 The value includes the length of the MAC header. 598 ifInOctets The total number of octets received on this 599 interface. This includes data packets as well as 600 MAC layer packets, and includes the length of the 601 MAC header. 603 ifInUcastPkts The number of Unicast packets received on this 604 interface. This includes data packets as well as 605 MAC layer packets. 607 ifInMulticastPkts Return the number of Multicast packets received 608 on this interface. This includes data packets as 609 well as MAC layer packets. 611 ifInBroadcastPkts Return the number of Broadcast packets received 612 on this interface. This includes data packets 613 as well as MAC layer packets. 615 ifInDiscards The total number of received packets which have 616 been discarded. 617 The possible reasons are: buffer shortage. 619 ifInErrors The number of inbound packets that contained 620 errors preventing them from being deliverable 621 to higher layers. 622 Possible reasons are: MAC FCS error. 624 ifInUnknownProtos The number of frames with an unknown packet type. 625 This are MAC frames with an unknown packet type. 627 ifOutOctets Return zero. 629 ifOutUcastPkts Return zero. 631 ifOutMulticastPkts 632 Return zero. 634 ifOutBroadcastPkts 635 Return zero. 637 ifOutDiscards Return zero. 639 ifOutErrors Return zero. 641 3.2.5.2.2. ifEntry for Upstream interfaces in Cable Modems 643 ifTable Comments 644 ============== =========================================== 645 ifIndex Each RF Cable Upstream interface is represented 646 by an ifEntry. 648 ifType The IANA value of docsCableUpstream(129). 650 ifSpeed Return the speed of this upstream channel. 651 The returned value is the raw bandwidth 652 in bits/s of this interface, regarding the 653 highest speed modulation profile that is 654 defined. This is the symbol rate multiplied 655 with the number of bits per symbol for this 656 modulation profile. 658 ifPhysAddress Return an empty string. 660 ifAdminStatus The administrative status of this interface. 662 ifOperStatus The current operational status of this interface. 664 ifMtu The size of the largest frame which can be 665 transmitted on this interface, specified in octets. 666 The value includes the length of the MAC header. 668 ifInOctets Return zero. 670 ifInUcastPkts Return zero. 672 ifInMulticastPkts Return zero. 674 ifInBroadcastPkts Return zero. 676 ifInDiscards Return zero. 678 ifInErrors Return zero. 680 ifInUnknownProtos Return zero. 682 ifOutOctets The total number of octets transmitted on this 683 interface. This includes MAC packets as well as 684 data packets, and includes the length of the MAC 685 header. 687 ifOutUcastPkts The number of Unicast packets transmitted on this 688 interface. This includes MAC packets as well as 689 data packets. 691 ifOutMulticastPkts 692 Return the number of Multicast packets transmitted 693 on this interface. 694 This includes MAC packets as well as data packets. 696 ifOutBroadcastPkts 697 Return the number of broadcast packets transmitted 698 on this interface. 699 This includes MAC packets as well as data packets. 701 ifOutDiscards The total number of outbound packets which 702 were discarded. Possible reasons are: 703 buffer shortage. 705 ifOutErrors The number of packets which could not be 706 transmitted due to errors. 708 ifPromiscuousMode Return false. 710 3.2.5.3. ifEntry for the MAC Layer 712 The ifEntry for the MAC Layer supports the ifGeneralInformationGroup 713 and the ifPacketGroup of the Interfaces MIB. This interface provides 714 an aggregate view of status for the lower level Downstream and 715 Upstream interfaces. 717 ifTable Comments 718 ============== =========================================== 719 ifIndex Each RF Cable MAC layer entity is represented 720 by an ifEntry. 722 ifType The IANA value of docsCableMaclayer(127). 724 ifSpeed Return zero. 726 ifPhysAddress Return the physical address of this interface. 728 ifAdminStatus The administrative status of this interface. 730 ifOperStatus The current operational status of the MAC 731 layer interface. 733 ifHighSpeed Return zero. 735 ifMtu Return 1500. 737 ifInOctets The total number of data octets received on this 738 interface, targeted for upper protocol layers. 740 ifInUcastPkts The number of Unicast packets received on this 741 interface, targeted for upper protocol layers. 743 ifInMulticastPkts Return the number of Multicast packets received 744 on this interface, targeted for upper protocol 745 layers. 747 ifInBroadcastPkts Return the number of Broadcast packets received 748 on this interface, targeted for upper protocol 749 layers. 751 ifInDiscards The total number of received packets which have 752 been discarded. 753 The possible reasons are: buffer shortage. 755 ifInErrors The number of inbound packets that contained 756 errors preventing them from being deliverable 757 to higher layers. 758 Possible reasons are: data packet FCS error, 759 invalid MAC header. 761 ifInUnknownProtos The number of frames with an unknown packet type. 762 This is the number of data packets targeted for 763 upper protocol layers with an unknown packet type. 765 ifOutOctets The total number of octets, received from upper 766 protocol layers and transmitted on this interface. 768 ifOutUcastPkts The number of Unicast packets, received from upper 769 protocol layers and transmitted on this interface. 771 ifOutMulticastPkts 772 Return the number of Multicast packets received 773 from upper protocol layers and transmitted on this 774 interface. 776 ifOutBroadcastPkts 777 Return the number of broadcast packets received 778 from upper protocol layers and transmitted on this 779 interface. 781 ifOutDiscards The total number of outbound packets which 782 were discarded. Possible reasons are: 783 buffer shortage. 785 ifOutErrors The number of packets which could not be 786 transmitted due to errors. 788 ifPromiscuousMode Refer to the Interfaces MIB. 790 4. Definitions 792 DOCS-IF-MIB DEFINITIONS ::= BEGIN 794 IMPORTS 795 MODULE-IDENTITY, 796 OBJECT-TYPE, 797 Unsigned32, 798 Integer32, 799 Counter32, 800 TimeTicks, 801 IpAddress, 802 transmission 803 FROM SNMPv2-SMI 804 TEXTUAL-CONVENTION, 805 MacAddress, 806 RowStatus, 807 TruthValue, 808 TimeInterval, 809 TimeStamp 810 FROM SNMPv2-TC 811 OBJECT-GROUP, 812 MODULE-COMPLIANCE 813 FROM SNMPv2-CONF 814 ifIndex, InterfaceIndexOrZero 815 FROM IF-MIB 816 InetAddressType, 817 InetAddress 818 FROM INET-ADDRESS-MIB; 820 docsIfMib MODULE-IDENTITY 821 LAST-UPDATED "200102230000Z" -- February 23, 2001 822 ORGANIZATION "IETF IPCDN Working Group" 823 CONTACT-INFO 824 " Rich Woundy 825 Postal: Cisco Systems 826 250 Apollo Drive 827 Chelmsford, MA 01824 U.S.A. 828 Phone: +1 978 244 8000 829 E-mail: rwoundy@cisco.com 831 IETF IPCDN Working Group 832 General Discussion: ipcdn@ietf.org 833 Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn 834 Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn 835 Co-chairs: Richard Woundy, rwoundy@cisco.com 836 Andrew Valentine, a.valentine@eu.hns.com" 837 DESCRIPTION 838 "This is the MIB Module for DOCSIS compliant Radio 839 Frequency (RF) interfaces in Cable Modems (CM) and 840 Cable Modem Termination Systems (CMTS)." 841 REVISION "200102230000Z" 842 DESCRIPTION 843 "Modified by Rich Woundy to use IPv6-friendly 844 address objects, to accommodate EuroDOCSIS, and 845 to correct the SYNTAX of various objects." 846 REVISION "9908190000Z" 847 DESCRIPTION 848 "Initial Version, published as RFC 2670. 849 Modified by Mike StJohns to fix problems identified by 850 the first pass of the MIB doctor. Of special note, 851 docsIfRangingResp and docsIfCmtsInsertionInterval were 852 obsoleted and replaced by other objects with the same 853 functionality, but more appropriate SYNTAX." 854 ::= { transmission 127 } 856 -- Textual Conventions 858 TenthdBmV ::= TEXTUAL-CONVENTION 859 DISPLAY-HINT "d-1" 860 STATUS current 861 DESCRIPTION 862 "This data type represents power levels that are normally 863 expressed in dBmV. Units are in tenths of a dBmV; 864 for example, 5.1 dBmV will be represented as 51." 865 SYNTAX Integer32 867 TenthdB ::= TEXTUAL-CONVENTION 868 DISPLAY-HINT "d-1" 869 STATUS current 870 DESCRIPTION 871 "This data type represents power levels that are normally 872 expressed in dB. Units are in tenths of a dB; 873 for example, 5.1 dB will be represented as 51." 874 SYNTAX Integer32 876 docsIfMibObjects OBJECT IDENTIFIER ::= { docsIfMib 1 } 877 docsIfBaseObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 1 } 878 docsIfCmObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 2 } 879 docsIfCmtsObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 3 } 881 -- 882 -- BASE GROUP 883 -- 885 -- 886 -- The following table is implemented on both the Cable Modem (CM) 887 -- and the Cable Modem Termination System (CMTS). 888 -- 890 docsIfDownstreamChannelTable OBJECT-TYPE 891 SYNTAX SEQUENCE OF DocsIfDownstreamChannelEntry 892 MAX-ACCESS not-accessible 893 STATUS current 894 DESCRIPTION 895 "This table describes the attributes of downstream 896 channels (frequency bands)." 897 REFERENCE 898 "DOCSIS Radio Frequency Interface Specification, 899 Table 4-12 and Table 4-13." 900 ::= { docsIfBaseObjects 1 } 902 docsIfDownstreamChannelEntry OBJECT-TYPE 903 SYNTAX DocsIfDownstreamChannelEntry 904 MAX-ACCESS not-accessible 905 STATUS current 906 DESCRIPTION 907 "An entry provides a list of attributes for a single 908 Downstream channel. 909 An entry in this table exists for each ifEntry with an 910 ifType of docsCableDownstream(128)." 911 INDEX { ifIndex } 912 ::= { docsIfDownstreamChannelTable 1 } 914 DocsIfDownstreamChannelEntry ::= SEQUENCE { 915 docsIfDownChannelId Integer32, 916 docsIfDownChannelFrequency Integer32, 917 docsIfDownChannelWidth Integer32, 918 docsIfDownChannelModulation INTEGER, 919 docsIfDownChannelInterleave INTEGER, 920 docsIfDownChannelPower TenthdBmV, 921 docsIfDownChannelAnnex INTEGER 922 } 924 docsIfDownChannelId OBJECT-TYPE 925 SYNTAX Integer32 (0..255) 926 MAX-ACCESS read-only 927 STATUS current 928 DESCRIPTION 929 "The Cable Modem Termination System (CMTS) identification 930 of the downstream channel within this particular MAC 931 interface. If the interface is down, the object returns 932 the most current value. If the downstream channel ID is 933 unknown, this object returns a value of 0." 934 ::= { docsIfDownstreamChannelEntry 1 } 936 docsIfDownChannelFrequency OBJECT-TYPE 937 SYNTAX Integer32 (0..1000000000) 938 UNITS "hertz" 939 MAX-ACCESS read-write 940 STATUS current 941 DESCRIPTION 942 "The center of the downstream frequency associated with 943 this channel. This object will return the current tuner 944 frequency. If a CMTS provides IF output, this object 945 will return 0, unless this CMTS is in control of the 946 final downstream RF frequency. See the associated 947 compliance object for a description of valid frequencies 948 that may be written to this object." 949 REFERENCE 950 "DOCSIS Radio Frequency Interface Specification, 951 Section 4.3.3." 952 ::= { docsIfDownstreamChannelEntry 2 } 954 docsIfDownChannelWidth OBJECT-TYPE 955 SYNTAX Integer32 (0..16000000) 956 UNITS "hertz" 957 MAX-ACCESS read-write 958 STATUS current 959 DESCRIPTION 960 "The bandwidth of this downstream channel. Most 961 implementations are expected to support a channel width 962 of 6 MHz (North America) and/or 8 MHz (Europe). See the 963 associated compliance object for a description of the 964 valid channel widths for this object." 965 REFERENCE 966 "DOCSIS Radio Frequency Interface Specification, 967 Table 4-12 and Table 4-13." 968 ::= { docsIfDownstreamChannelEntry 3 } 970 docsIfDownChannelModulation OBJECT-TYPE 971 SYNTAX INTEGER { 972 unknown(1), 973 other(2), 974 qam64(3), 975 qam256(4) 976 } 977 MAX-ACCESS read-write 978 STATUS current 979 DESCRIPTION 980 "The modulation type associated with this downstream 981 channel. If the interface is down, this object either 982 returns the configured value (CMTS), the most current 983 value (CM), or the value of unknown(1). See the 984 associated conformance object for write conditions and 985 limitations. See the reference for specifics on the 986 modulation profiles implied by qam64 and qam256." 987 REFERENCE 988 "DOCSIS Radio Frequency Interface Specification, 989 Section 3.6.2." 990 ::= { docsIfDownstreamChannelEntry 4 } 992 docsIfDownChannelInterleave OBJECT-TYPE 993 SYNTAX INTEGER { 994 unknown(1), 995 other(2), 996 taps8Increment16(3), 997 taps16Increment8(4), 998 taps32Increment4(5), 999 taps64Increment2(6), 1000 taps128Increment1(7), 1001 taps12increment17(8) 1002 } 1003 MAX-ACCESS read-write 1004 STATUS current 1005 DESCRIPTION 1006 "The Forward Error Correction (FEC) interleaving used 1007 for this downstream channel. 1008 Values are defined as follows: 1009 taps8Increment16(3): protection 5.9/4.1 usec, 1010 latency .22/.15 msec 1011 taps16Increment8(4): protection 12/8.2 usec, 1012 latency .48/.33 msec 1013 taps32Increment4(5): protection 24/16 usec, 1014 latency .98/.68 msec 1015 taps64Increment2(6): protection 47/33 usec, 1016 latency 2/1.4 msec 1017 taps128Increment1(7): protection 95/66 usec, 1018 latency 4/2.8 msec 1019 taps12increment17(8): protection 18/14 usec, 1020 latency 0.43/0.32 msec 1021 If the interface is down, this object either returns 1022 the configured value (CMTS), the most current value (CM), 1023 or the value of unknown(1). 1024 The value of other(2) is returned if the interleave 1025 is known but not defined in the above list. 1026 See the associated conformance object for write 1027 conditions and limitations. See the reference for the FEC 1028 configuration described by the setting of this object." 1029 REFERENCE 1030 "DOCSIS Radio Frequency Interface Specification, 1031 Section 4.3.2." 1032 ::= { docsIfDownstreamChannelEntry 5 } 1034 docsIfDownChannelPower OBJECT-TYPE 1035 SYNTAX TenthdBmV 1036 UNITS "dBmV" 1037 MAX-ACCESS read-write 1038 STATUS current 1039 DESCRIPTION 1040 "At the CMTS, the operational transmit power. At the CM, 1041 the received power level. May be set to zero at the CM 1042 if power level measurement is not supported. 1043 If the interface is down, this object either returns 1044 the configured value (CMTS), the most current value (CM) 1045 or the value of 0. See the associated conformance object 1046 for write conditions and limitations. See the reference 1047 for recommended and required power levels." 1048 REFERENCE 1049 "DOCSIS Radio Frequency Interface Specification, 1050 Table 4-12 and Table 4-13." 1051 ::= { docsIfDownstreamChannelEntry 6 } 1053 docsIfDownChannelAnnex OBJECT-TYPE 1054 SYNTAX INTEGER { 1055 unknown(1), 1056 other(2), 1057 annexA(3), 1058 annexB(4), 1059 annexC(5) 1060 } 1061 MAX-ACCESS read-only 1062 STATUS current 1063 DESCRIPTION 1064 "The value of this object indicates the conformance of 1065 the implementation to important regional cable standards. 1066 annexA : Annex A from ITU-J83 is used. 1067 annexB : Annex B from ITU-J83 is used. 1068 annexC : Annex C from ITU-J83 is used." 1069 ::= { docsIfDownstreamChannelEntry 7 } 1071 -- 1072 -- The following table is implemented on both the CM and the CMTS. 1073 -- For the CM, only attached channels appear in the table. For the 1074 -- CM, this table is read only as well. 1075 -- 1077 docsIfUpstreamChannelTable OBJECT-TYPE 1078 SYNTAX SEQUENCE OF DocsIfUpstreamChannelEntry 1079 MAX-ACCESS not-accessible 1080 STATUS current 1081 DESCRIPTION 1082 "This table describes the attributes of attached upstream 1083 channels (frequency bands)." 1084 ::= { docsIfBaseObjects 2 } 1086 docsIfUpstreamChannelEntry OBJECT-TYPE 1087 SYNTAX DocsIfUpstreamChannelEntry 1088 MAX-ACCESS not-accessible 1089 STATUS current 1090 DESCRIPTION 1091 "List of attributes for a single upstream channel. 1092 An entry in this table exists for each ifEntry with an 1093 ifType of docsCableUpstream(129)." 1094 INDEX { ifIndex } 1095 ::= { docsIfUpstreamChannelTable 1 } 1097 DocsIfUpstreamChannelEntry ::= SEQUENCE { 1098 docsIfUpChannelId Integer32, 1099 docsIfUpChannelFrequency Integer32, 1100 docsIfUpChannelWidth Integer32, 1101 docsIfUpChannelModulationProfile Unsigned32, 1102 docsIfUpChannelSlotSize Unsigned32, 1103 docsIfUpChannelTxTimingOffset Unsigned32, 1104 docsIfUpChannelRangingBackoffStart Integer32, 1105 docsIfUpChannelRangingBackoffEnd Integer32, 1106 docsIfUpChannelTxBackoffStart Integer32, 1107 docsIfUpChannelTxBackoffEnd Integer32 1108 } 1110 docsIfUpChannelId OBJECT-TYPE 1111 SYNTAX Integer32 (0..255) 1112 MAX-ACCESS read-only 1113 STATUS current 1114 DESCRIPTION 1115 "The CMTS identification of the upstream channel." 1116 ::= { docsIfUpstreamChannelEntry 1 } 1118 docsIfUpChannelFrequency OBJECT-TYPE 1119 SYNTAX Integer32 (0..1000000000) 1120 UNITS "hertz" 1121 MAX-ACCESS read-write 1122 STATUS current 1123 DESCRIPTION 1124 "The center of the frequency band associated with this 1125 upstream channel. This object returns 0 if the frequency 1126 is undefined or unknown. Minimum permitted upstream 1127 frequency is 5,000,000 Hz for current technology. See 1128 the associated conformance object for write conditions 1129 and limitations." 1130 REFERENCE 1131 "DOCSIS Radio Frequency Interface Specification, 1132 Table 2-2." 1133 ::= { docsIfUpstreamChannelEntry 2 } 1135 docsIfUpChannelWidth OBJECT-TYPE 1136 SYNTAX Integer32 (0..20000000) 1137 UNITS "hertz" 1138 MAX-ACCESS read-write 1139 STATUS current 1140 DESCRIPTION 1141 "The bandwidth of this upstream channel. This object 1142 returns 0 if the channel width is undefined or unknown. 1143 Minimum permitted channel width is 200,000 Hz currently. 1144 See the associated conformance object for write conditions 1145 and limitations." 1146 REFERENCE 1147 "DOCSIS Radio Frequency Interface Specification, 1148 Table 4-3." 1149 ::= { docsIfUpstreamChannelEntry 3 } 1151 docsIfUpChannelModulationProfile OBJECT-TYPE 1152 SYNTAX Unsigned32 1153 MAX-ACCESS read-write 1154 STATUS current 1155 DESCRIPTION 1156 "An entry identical to the docsIfModIndex in the 1157 docsIfCmtsModulationTable that describes this channel. 1159 This channel is further instantiated there by a grouping 1160 of interval usage codes which together fully describe the 1161 channel modulation. This object returns 0 if the 1162 docsIfCmtsModulationTable entry does not exist or 1163 docsIfCmtsModulationTable is empty. See 1164 the associated conformance object for write conditions 1165 and limitations." 1166 ::= { docsIfUpstreamChannelEntry 4 } 1168 docsIfUpChannelSlotSize OBJECT-TYPE 1169 SYNTAX Unsigned32 1170 MAX-ACCESS read-write 1171 STATUS current 1172 DESCRIPTION 1173 "The number of 6.25 microsecond ticks in each upstream mini- 1174 slot. Returns zero if the value is undefined or unknown. 1175 See the associated conformance object for write 1176 conditions and limitations." 1177 REFERENCE 1178 "DOCSIS Radio Frequency Interface Specification, 1179 Section 6.1.2.4." 1180 ::= { docsIfUpstreamChannelEntry 5 } 1182 docsIfUpChannelTxTimingOffset OBJECT-TYPE 1183 SYNTAX Unsigned32 1184 MAX-ACCESS read-only 1185 STATUS current 1186 DESCRIPTION 1187 "A measure of the current round trip time at the CM, or the 1188 maximum round trip time seen by the CMTS. Used for timing 1189 of CM upstream transmissions to ensure synchronized 1190 arrivals at the CMTS. Units are in terms of 1191 (6.25 microseconds/64)." 1192 REFERENCE 1193 "DOCSIS Radio Frequency Interface Specification, 1194 Section 6.5." 1195 ::= { docsIfUpstreamChannelEntry 6 } 1197 docsIfUpChannelRangingBackoffStart OBJECT-TYPE 1198 SYNTAX Integer32 (0..16) 1199 MAX-ACCESS read-write 1200 STATUS current 1201 DESCRIPTION 1202 "The initial random backoff window to use when retrying 1203 Ranging Requests. Expressed as a power of 2. A value of 16 1204 at the CMTS indicates that a proprietary adaptive retry 1205 mechanism is to be used. See the associated conformance 1206 object for write conditions and limitations." 1208 REFERENCE 1209 "DOCSIS Radio Frequency Interface Specification, 1210 Section 6.4.4." 1211 ::= { docsIfUpstreamChannelEntry 7 } 1213 docsIfUpChannelRangingBackoffEnd OBJECT-TYPE 1214 SYNTAX Integer32 (0..16) 1215 MAX-ACCESS read-write 1216 STATUS current 1217 DESCRIPTION 1218 "The final random backoff window to use when retrying 1219 Ranging Requests. Expressed as a power of 2. A value of 16 1220 at the CMTS indicates that a proprietary adaptive retry 1221 mechanism is to be used. See the associated conformance 1222 object for write conditions and limitations." 1223 REFERENCE 1224 "DOCSIS Radio Frequency Interface Specification, 1225 Section 6.4.4." 1226 ::= { docsIfUpstreamChannelEntry 8 } 1228 docsIfUpChannelTxBackoffStart OBJECT-TYPE 1229 SYNTAX Integer32 (0..16) 1230 MAX-ACCESS read-write 1231 STATUS current 1232 DESCRIPTION 1233 "The initial random backoff window to use when retrying 1234 transmissions. Expressed as a power of 2. A value of 16 1235 at the CMTS indicates that a proprietary adaptive retry 1236 mechanism is to be used. See the associated conformance 1237 object for write conditions and limitations." 1238 REFERENCE 1239 "DOCSIS Radio Frequency Interface Specification, 1240 Section 6.4.4." 1241 ::= { docsIfUpstreamChannelEntry 9 } 1243 docsIfUpChannelTxBackoffEnd OBJECT-TYPE 1244 SYNTAX Integer32 (0..16) 1245 MAX-ACCESS read-write 1246 STATUS current 1247 DESCRIPTION 1248 "The final random backoff window to use when retrying 1249 transmissions. Expressed as a power of 2. A value of 16 1250 at the CMTS indicates that a proprietary adaptive retry 1251 mechanism is to be used. See the associated conformance 1252 object for write conditions and limitations." 1253 REFERENCE 1254 "DOCSIS Radio Frequency Interface Specification, 1255 Section 6.4.4." 1257 ::= { docsIfUpstreamChannelEntry 10 } 1259 -- The following table describes the attributes of each class of 1260 -- service. The entries in this table are referenced from the 1261 -- docsIfServiceEntries. They exist as a separate table in order to 1262 -- reduce redundant information in docsIfServiceTable. 1263 -- 1264 -- This table is implemented at both the CM and the CMTS. 1265 -- The CM need only maintain entries for the classes of service 1266 -- referenced by its docsIfServiceTable. 1267 -- 1269 docsIfQosProfileTable OBJECT-TYPE 1270 SYNTAX SEQUENCE OF DocsIfQosProfileEntry 1271 MAX-ACCESS not-accessible 1272 STATUS current 1273 DESCRIPTION 1274 "Describes the attributes for each class of service." 1275 ::= { docsIfBaseObjects 3 } 1277 docsIfQosProfileEntry OBJECT-TYPE 1278 SYNTAX DocsIfQosProfileEntry 1279 MAX-ACCESS not-accessible 1280 STATUS current 1281 DESCRIPTION 1282 "Describes the attributes for a single class of service. 1284 If implemented as read-create in the Cable Modem 1285 Termination System, creation of entries in this table is 1286 controlled by the value of docsIfCmtsQosProfilePermissions. 1288 If implemented as read-only, entries are created based 1289 on information in REG-REQ MAC messages received from 1290 Cable Modems (Cable Modem Termination System 1291 implementation), or based on information extracted from 1292 the TFTP option file (Cable Modem implementation). 1293 In the Cable Modem Termination system, read-only entries 1294 are removed if no longer referenced by 1295 docsIfCmtsServiceTable. 1297 An entry in this table must not be removed while it is 1298 referenced by an entry in docsIfCmServiceTable (Cable Modem) 1299 or docsIfCmtsServiceTable (Cable Modem Termination System). 1301 An entry in this table should not be changeable while 1302 it is referenced by an entry in docsIfCmtsServiceTable. 1304 If this table is created automatically, there should only 1305 be a single entry for each Class of Service. Multiple 1306 entries with the same Class of Service parameters are not 1307 recommended." 1308 INDEX { docsIfQosProfIndex } 1309 ::= { docsIfQosProfileTable 1 } 1311 DocsIfQosProfileEntry ::= SEQUENCE { 1312 docsIfQosProfIndex Integer32, 1313 docsIfQosProfPriority Integer32, 1314 docsIfQosProfMaxUpBandwidth Integer32, 1315 docsIfQosProfGuarUpBandwidth Integer32, 1316 docsIfQosProfMaxDownBandwidth Integer32, 1317 docsIfQosProfMaxTxBurst Integer32, -- Deprecated 1318 docsIfQosProfBaselinePrivacy TruthValue, 1319 docsIfQosProfStatus RowStatus, 1320 docsIfQosProfMaxTransmitBurst Integer32 1321 } 1323 docsIfQosProfIndex OBJECT-TYPE 1324 SYNTAX Integer32 (1..16383) 1325 MAX-ACCESS not-accessible 1326 STATUS current 1327 DESCRIPTION 1328 "The index value which uniquely identifies an entry 1329 in the docsIfQosProfileTable." 1330 ::= { docsIfQosProfileEntry 1 } 1332 docsIfQosProfPriority OBJECT-TYPE 1333 SYNTAX Integer32 (0..7) 1334 MAX-ACCESS read-create 1335 STATUS current 1336 DESCRIPTION 1337 "A relative priority assigned to this service when 1338 allocating bandwidth. Zero indicates lowest priority; 1339 and seven indicates highest priority. 1340 Interpretation of priority is device-specific. 1341 MUST NOT be changed while this row is active." 1342 DEFVAL { 0 } 1343 ::= { docsIfQosProfileEntry 2 } 1345 docsIfQosProfMaxUpBandwidth OBJECT-TYPE 1346 SYNTAX Integer32 (0..100000000) 1347 MAX-ACCESS read-create 1348 STATUS current 1349 DESCRIPTION 1350 "The maximum upstream bandwidth, in bits per second, 1351 allowed for a service with this service class. 1352 Zero if there is no restriction of upstream bandwidth. 1354 MUST NOT be changed while this row is active." 1355 DEFVAL { 0 } 1356 ::= { docsIfQosProfileEntry 3 } 1358 docsIfQosProfGuarUpBandwidth OBJECT-TYPE 1359 SYNTAX Integer32 (0..100000000) 1360 MAX-ACCESS read-create 1361 STATUS current 1362 DESCRIPTION 1363 "Minimum guaranteed upstream bandwidth, in bits per second, 1364 allowed for a service with this service class. 1365 MUST NOT be changed while this row is active." 1366 DEFVAL { 0 } 1367 ::= { docsIfQosProfileEntry 4 } 1369 docsIfQosProfMaxDownBandwidth OBJECT-TYPE 1370 SYNTAX Integer32 (0..100000000) 1371 MAX-ACCESS read-create 1372 STATUS current 1373 DESCRIPTION 1374 "The maximum downstream bandwidth, in bits per second, 1375 allowed for a service with this service class. 1376 Zero if there is no restriction of downstream bandwidth. 1377 MUST NOT be changed while this row is active." 1378 DEFVAL { 0 } 1379 ::= { docsIfQosProfileEntry 5 } 1381 docsIfQosProfMaxTxBurst OBJECT-TYPE 1382 SYNTAX Integer32 (0..255) 1383 MAX-ACCESS read-create 1384 STATUS deprecated 1385 DESCRIPTION 1386 "The maximum number of mini-slots that may be requested 1387 for a single upstream transmission. 1388 A value of zero means there is no limit. 1389 MUST NOT be changed while this row is active. 1390 This object has been deprecated and replaced by 1391 docsIfQosProfMaxTransmitBurst, to fix a mismatch 1392 of the units and value range with respect to the DOCSIS 1393 Maximum Upstream Channel Transmit Burst Configuration 1394 Setting." 1395 DEFVAL { 0 } 1396 ::= { docsIfQosProfileEntry 6 } 1398 docsIfQosProfBaselinePrivacy OBJECT-TYPE 1399 SYNTAX TruthValue 1400 MAX-ACCESS read-create 1401 STATUS current 1402 DESCRIPTION 1403 "Indicates whether Baseline Privacy is enabled for this 1404 service class. 1405 MUST NOT be changed while this row is active." 1406 DEFVAL { false } 1407 ::= { docsIfQosProfileEntry 7 } 1409 docsIfQosProfStatus OBJECT-TYPE 1410 SYNTAX RowStatus 1411 MAX-ACCESS read-create 1412 STATUS current 1413 DESCRIPTION 1414 "This is object is to used to create or delete rows in 1415 this table. This object MUST NOT be changed from active 1416 while the row is referenced by the any entry in either 1417 docsIfCmServiceTable (on the CM), or the 1418 docsIfCmtsServiceTable (on the CMTS)." 1419 ::= { docsIfQosProfileEntry 8 } 1421 docsIfQosProfMaxTransmitBurst OBJECT-TYPE 1422 SYNTAX Integer32 (0..65535) 1423 MAX-ACCESS read-create 1424 STATUS current 1425 DESCRIPTION 1426 "The maximum number of bytes that may be requested for a 1427 single upstream transmission. A value of zero means there 1428 is no limit. Note: This value does not include any 1429 physical layer overhead. 1430 MUST NOT be changed while this row is active." 1431 DEFVAL { 0 } 1432 ::= { docsIfQosProfileEntry 9 } 1434 docsIfSignalQualityTable OBJECT-TYPE 1435 SYNTAX SEQUENCE OF DocsIfSignalQualityEntry 1436 MAX-ACCESS not-accessible 1437 STATUS current 1438 DESCRIPTION 1439 "At the CM, describes the PHY signal quality of downstream 1440 channels. At the CMTS, describes the PHY signal quality of 1441 upstream channels. At the CMTS, this table may exclude 1442 contention intervals." 1443 ::= { docsIfBaseObjects 4 } 1445 docsIfSignalQualityEntry OBJECT-TYPE 1446 SYNTAX DocsIfSignalQualityEntry 1447 MAX-ACCESS not-accessible 1448 STATUS current 1449 DESCRIPTION 1450 "At the CM, describes the PHY characteristics of a 1451 downstream channel. At the CMTS, describes the PHY signal 1452 quality of an upstream channel. 1453 An entry in this table exists for each ifEntry with an 1454 ifType of docsCableUpstream(129) for Cable Modem Termination 1455 Systems and docsCableDownstream(128) for Cable Modems." 1456 INDEX { ifIndex } 1457 ::= { docsIfSignalQualityTable 1 } 1459 DocsIfSignalQualityEntry ::= SEQUENCE { 1460 docsIfSigQIncludesContention TruthValue, 1461 docsIfSigQUnerroreds Counter32, 1462 docsIfSigQCorrecteds Counter32, 1463 docsIfSigQUncorrectables Counter32, 1464 docsIfSigQSignalNoise TenthdB, 1465 docsIfSigQMicroreflections Integer32, 1466 docsIfSigQEqualizationData OCTET STRING 1467 } 1469 docsIfSigQIncludesContention OBJECT-TYPE 1470 SYNTAX TruthValue 1471 MAX-ACCESS read-only 1472 STATUS current 1473 DESCRIPTION 1474 "true(1) if this CMTS includes contention intervals in 1475 the counters in this table. Always false(2) for CMs." 1476 REFERENCE 1477 "DOCSIS Radio Frequency Interface specification, 1478 Section 6.4.4" 1479 ::= { docsIfSignalQualityEntry 1 } 1481 docsIfSigQUnerroreds OBJECT-TYPE 1482 SYNTAX Counter32 1483 MAX-ACCESS read-only 1484 STATUS current 1485 DESCRIPTION 1486 "Codewords received on this channel without error. 1487 This includes all codewords, whether or not they 1488 were part of frames destined for this device." 1489 REFERENCE 1490 "DOCSIS Radio Frequency Interface specification, 1491 Section 4.2.3 and 4.3.6" 1492 ::= { docsIfSignalQualityEntry 2 } 1494 docsIfSigQCorrecteds OBJECT-TYPE 1495 SYNTAX Counter32 1496 MAX-ACCESS read-only 1497 STATUS current 1498 DESCRIPTION 1499 "Codewords received on this channel with correctable 1500 errors. This includes all codewords, whether or not 1501 they were part of frames destined for this device." 1502 REFERENCE 1503 "DOCSIS Radio Frequency Interface specification, 1504 Section 4.2.3 and 4.3.6" 1505 ::= { docsIfSignalQualityEntry 3 } 1507 docsIfSigQUncorrectables OBJECT-TYPE 1508 SYNTAX Counter32 1509 MAX-ACCESS read-only 1510 STATUS current 1511 DESCRIPTION 1512 "Codewords received on this channel with uncorrectable 1513 errors. This includes all codewords, whether or not 1514 they were part of frames destined for this device." 1515 REFERENCE 1516 "DOCSIS Radio Frequency Interface specification, 1517 Section 4.2.3 and 4.3.6" 1518 ::= { docsIfSignalQualityEntry 4 } 1520 docsIfSigQSignalNoise OBJECT-TYPE 1521 SYNTAX TenthdB 1522 UNITS "dB" 1523 MAX-ACCESS read-only 1524 STATUS current 1525 DESCRIPTION 1526 "Signal/Noise ratio as perceived for this channel. 1527 At the CM, describes the Signal/Noise of the downstream 1528 channel. At the CMTS, describes the average Signal/Noise 1529 of the upstream channel." 1530 REFERENCE 1531 "DOCSIS Radio Frequency Interface specification, 1532 Table 2-1 and 2-2" 1533 ::= { docsIfSignalQualityEntry 5 } 1535 docsIfSigQMicroreflections OBJECT-TYPE 1536 SYNTAX Integer32 (0..255) 1537 UNITS "dBc" 1538 MAX-ACCESS read-only 1539 STATUS current 1540 DESCRIPTION 1541 "Total microreflections including in-channel response 1542 as perceived on this interface, measured in dBc below 1543 the signal level. 1544 This object is not assumed to return an absolutely 1545 accurate value, but should give a rough indication 1546 of microreflections received on this interface. 1547 It is up to the implementor to provide information 1548 as accurate as possible." 1549 REFERENCE 1550 "DOCSIS Radio Frequency Interface specification, 1551 Table 2-1 and 2-2" 1552 ::= { docsIfSignalQualityEntry 6 } 1554 docsIfSigQEqualizationData OBJECT-TYPE 1555 SYNTAX OCTET STRING 1556 MAX-ACCESS read-only 1557 STATUS current 1558 DESCRIPTION 1559 "At the CM, returns the equalization data for the downstream 1560 channel. At the CMTS, returns the average equalization 1561 data for the upstream channel. Returns an empty string 1562 if the value is unknown or if there is no equalization 1563 data available or defined." 1564 REFERENCE 1565 "DOCSIS Radio Frequency Interface Specification, 1566 Figure 6-23." 1567 ::= { docsIfSignalQualityEntry 7 } 1569 -- 1570 -- CABLE MODEM GROUP 1571 -- 1573 -- 1574 -- The CM MAC Table 1575 -- 1577 docsIfCmMacTable OBJECT-TYPE 1578 SYNTAX SEQUENCE OF DocsIfCmMacEntry 1579 MAX-ACCESS not-accessible 1580 STATUS current 1581 DESCRIPTION 1582 "Describes the attributes of each CM MAC interface, 1583 extending the information available from ifEntry." 1584 ::= { docsIfCmObjects 1 } 1586 docsIfCmMacEntry OBJECT-TYPE 1587 SYNTAX DocsIfCmMacEntry 1588 MAX-ACCESS not-accessible 1589 STATUS current 1590 DESCRIPTION 1591 "An entry containing objects describing attributes of 1592 each MAC entry, extending the information in ifEntry. 1593 An entry in this table exists for each ifEntry with an 1594 ifType of docsCableMaclayer(127)." 1595 INDEX { ifIndex } 1596 ::= { docsIfCmMacTable 1 } 1598 DocsIfCmMacEntry ::= SEQUENCE { 1599 docsIfCmCmtsAddress MacAddress, 1600 docsIfCmCapabilities BITS, 1601 docsIfCmRangingRespTimeout TimeTicks, -- Obsolete 1602 docsIfCmRangingTimeout TimeInterval 1603 } 1605 docsIfCmCmtsAddress OBJECT-TYPE 1606 SYNTAX MacAddress 1607 MAX-ACCESS read-only 1608 STATUS current 1609 DESCRIPTION 1610 "Identifies the CMTS that is believed to control this MAC 1611 domain. At the CM, this will be the source address from 1612 SYNC, MAP, and other MAC-layer messages. If the CMTS is 1613 unknown, returns 00-00-00-00-00-00." 1614 ::= { docsIfCmMacEntry 1 } 1616 docsIfCmCapabilities OBJECT-TYPE 1617 SYNTAX BITS { 1618 atmCells(0), 1619 concatenation(1) 1620 } 1621 MAX-ACCESS read-only 1622 STATUS current 1623 DESCRIPTION 1624 "Identifies the capabilities of the MAC implementation 1625 at this interface. Note that packet transmission is 1626 always supported. Therefore, there is no specific bit 1627 required to explicitely indicate this capability. 1628 Note that BITS objects are encoded most significant bit 1629 first. For example, if bit 1 is set, the value of this 1630 object is the octet string '40'H." 1631 ::= { docsIfCmMacEntry 2 } 1633 docsIfCmRangingRespTimeout OBJECT-TYPE 1634 SYNTAX TimeTicks 1635 MAX-ACCESS read-write 1636 STATUS obsolete 1637 DESCRIPTION 1638 "Waiting time for a Ranging Response packet. 1639 This object has been obsoleted and replaced by 1640 docsIfCmRangingTimeout to correct the typing to 1641 TimeInterval. New implementations of the MIB should use 1642 docsIfCmRangingTimeout instead." 1643 REFERENCE 1644 "DOCSIS Radio Frequency Interface specification, 1645 Figure 7-6 and 7-7, timer T3." 1646 DEFVAL { 20 } 1647 ::= { docsIfCmMacEntry 3 } 1649 docsIfCmRangingTimeout OBJECT-TYPE 1650 SYNTAX TimeInterval 1651 MAX-ACCESS read-write 1652 STATUS current 1653 DESCRIPTION 1654 "Waiting time for a Ranging Response packet." 1655 REFERENCE 1656 "DOCSIS Radio Frequency Interface specification, 1657 Figure 7-6 and 7-7, timer T3." 1658 DEFVAL { 20 } 1659 ::= { docsIfCmMacEntry 4 } 1661 -- 1662 -- CM status table. 1663 -- This table is implemented only at the CM. 1664 -- 1666 docsIfCmStatusTable OBJECT-TYPE 1667 SYNTAX SEQUENCE OF DocsIfCmStatusEntry 1668 MAX-ACCESS not-accessible 1669 STATUS current 1670 DESCRIPTION 1671 "This table maintains a number of status objects 1672 and counters for Cable Modems." 1673 ::= { docsIfCmObjects 2 } 1675 docsIfCmStatusEntry OBJECT-TYPE 1676 SYNTAX DocsIfCmStatusEntry 1677 MAX-ACCESS not-accessible 1678 STATUS current 1679 DESCRIPTION 1680 "A set of status objects and counters for a single MAC 1681 layer instance in a Cable Modem. 1682 An entry in this table exists for each ifEntry with an 1683 ifType of docsCableMaclayer(127)." 1684 INDEX { ifIndex } 1685 ::= { docsIfCmStatusTable 1 } 1687 DocsIfCmStatusEntry ::= SEQUENCE { 1688 docsIfCmStatusValue INTEGER, 1689 docsIfCmStatusCode OCTET STRING, 1690 docsIfCmStatusTxPower TenthdBmV, 1691 docsIfCmStatusResets Counter32, 1692 docsIfCmStatusLostSyncs Counter32, 1693 docsIfCmStatusInvalidMaps Counter32, 1694 docsIfCmStatusInvalidUcds Counter32, 1695 docsIfCmStatusInvalidRangingResponses Counter32, 1696 docsIfCmStatusInvalidRegistrationResponses Counter32, 1697 docsIfCmStatusT1Timeouts Counter32, 1698 docsIfCmStatusT2Timeouts Counter32, 1699 docsIfCmStatusT3Timeouts Counter32, 1700 docsIfCmStatusT4Timeouts Counter32, 1701 docsIfCmStatusRangingAborteds Counter32 1702 } 1704 docsIfCmStatusValue OBJECT-TYPE 1705 SYNTAX INTEGER { 1706 other(1), 1707 notReady(2), 1708 notSynchronized(3), 1709 phySynchronized(4), 1710 usParametersAcquired(5), 1711 rangingComplete(6), 1712 ipComplete(7), 1713 todEstablished(8), 1714 securityEstablished(9), 1715 paramTransferComplete(10), 1716 registrationComplete(11), 1717 operational(12), 1718 accessDenied(13) 1719 } 1720 MAX-ACCESS read-only 1721 STATUS current 1722 DESCRIPTION 1723 "Current Cable Modem connectivity state, as specified 1724 in the RF Interface Specification." 1725 REFERENCE 1726 "DOCSIS Radio Frequency Interface Specification, 1727 Chapter 7.2." 1728 ::= { docsIfCmStatusEntry 1 } 1730 docsIfCmStatusCode OBJECT-TYPE 1731 SYNTAX OCTET STRING 1732 MAX-ACCESS read-only 1733 STATUS current 1734 DESCRIPTION 1735 "Status code for this Cable Modem as defined in the 1736 RF Interface Specification. The status code consists 1737 of a single character indicating error groups, followed 1738 by a two- or three-digit number indicating the status 1739 condition." 1740 REFERENCE 1741 "DOCSIS Radio Frequency Interface Specification, 1742 Cable Modem status codes." 1743 ::= { docsIfCmStatusEntry 2 } 1745 docsIfCmStatusTxPower OBJECT-TYPE 1746 SYNTAX TenthdBmV 1747 UNITS "dBmV" 1748 MAX-ACCESS read-only 1749 STATUS current 1750 DESCRIPTION 1751 "The operational transmit power for the attached upstream 1752 channel." 1753 REFERENCE 1754 "DOCSIS Radio Frequency Interface specification, 1755 Section 4.2.8." 1756 ::= { docsIfCmStatusEntry 3 } 1758 docsIfCmStatusResets OBJECT-TYPE 1759 SYNTAX Counter32 1760 MAX-ACCESS read-only 1761 STATUS current 1762 DESCRIPTION 1763 "Number of times the CM reset or initialized 1764 this interface." 1765 ::= { docsIfCmStatusEntry 4 } 1767 docsIfCmStatusLostSyncs OBJECT-TYPE 1768 SYNTAX Counter32 1769 MAX-ACCESS read-only 1770 STATUS current 1771 DESCRIPTION 1772 "Number of times the CM lost synchronization with 1773 the downstream channel." 1774 REFERENCE 1775 "DOCSIS Radio Frequency Interface specification, 1776 Section 6.5." 1777 ::= { docsIfCmStatusEntry 5 } 1779 docsIfCmStatusInvalidMaps OBJECT-TYPE 1780 SYNTAX Counter32 1781 MAX-ACCESS read-only 1782 STATUS current 1783 DESCRIPTION 1784 "Number of times the CM received invalid MAP messages." 1785 REFERENCE 1786 "DOCSIS Radio Frequency Interface specification, 1787 Section 6.3.2.3 and 6.4.2." 1788 ::= { docsIfCmStatusEntry 6 } 1790 docsIfCmStatusInvalidUcds OBJECT-TYPE 1791 SYNTAX Counter32 1792 MAX-ACCESS read-only 1793 STATUS current 1794 DESCRIPTION 1795 "Number of times the CM received invalid UCD messages." 1796 REFERENCE 1797 "DOCSIS Radio Frequency Interface specification, 1798 Section 6.3.2.2." 1799 ::= { docsIfCmStatusEntry 7 } 1801 docsIfCmStatusInvalidRangingResponses OBJECT-TYPE 1802 SYNTAX Counter32 1803 MAX-ACCESS read-only 1804 STATUS current 1805 DESCRIPTION 1806 "Number of times the CM received invalid ranging response 1807 messages." 1808 ::= { docsIfCmStatusEntry 8 } 1810 docsIfCmStatusInvalidRegistrationResponses OBJECT-TYPE 1811 SYNTAX Counter32 1812 MAX-ACCESS read-only 1813 STATUS current 1814 DESCRIPTION 1815 "Number of times the CM received invalid registration 1816 response messages." 1817 ::= { docsIfCmStatusEntry 9 } 1819 docsIfCmStatusT1Timeouts OBJECT-TYPE 1820 SYNTAX Counter32 1821 MAX-ACCESS read-only 1822 STATUS current 1823 DESCRIPTION 1824 "Number of times counter T1 expired in the CM." 1825 REFERENCE 1826 "DOCSIS Radio Frequency Interface specification, 1827 Figure 7-3." 1828 ::= { docsIfCmStatusEntry 10 } 1830 docsIfCmStatusT2Timeouts OBJECT-TYPE 1831 SYNTAX Counter32 1832 MAX-ACCESS read-only 1833 STATUS current 1834 DESCRIPTION 1835 "Number of times counter T2 expired in the CM." 1836 REFERENCE 1837 "DOCSIS Radio Frequency Interface specification, 1838 Figure 7-6." 1839 ::= { docsIfCmStatusEntry 11 } 1841 docsIfCmStatusT3Timeouts OBJECT-TYPE 1842 SYNTAX Counter32 1843 MAX-ACCESS read-only 1844 STATUS current 1845 DESCRIPTION 1846 "Number of times counter T3 expired in the CM." 1847 REFERENCE 1848 "DOCSIS Radio Frequency Interface specification, 1849 Figure 7-6 and 7-7." 1850 ::= { docsIfCmStatusEntry 12 } 1852 docsIfCmStatusT4Timeouts OBJECT-TYPE 1853 SYNTAX Counter32 1854 MAX-ACCESS read-only 1855 STATUS current 1856 DESCRIPTION 1857 "Number of times counter T4 expired in the CM." 1858 REFERENCE 1859 "DOCSIS Radio Frequency Interface specification, 1860 Figure 7-7." 1861 ::= { docsIfCmStatusEntry 13 } 1863 docsIfCmStatusRangingAborteds OBJECT-TYPE 1864 SYNTAX Counter32 1865 MAX-ACCESS read-only 1866 STATUS current 1867 DESCRIPTION 1868 "Number of times the ranging process was aborted 1869 by the CMTS." 1870 ::= { docsIfCmStatusEntry 14 } 1872 -- 1873 -- The Cable Modem Service Table 1874 -- 1876 docsIfCmServiceTable OBJECT-TYPE 1877 SYNTAX SEQUENCE OF DocsIfCmServiceEntry 1878 MAX-ACCESS not-accessible 1879 STATUS current 1880 DESCRIPTION 1881 "Describes the attributes of each upstream service queue 1882 on a CM." 1883 ::= { docsIfCmObjects 3 } 1885 docsIfCmServiceEntry OBJECT-TYPE 1886 SYNTAX DocsIfCmServiceEntry 1887 MAX-ACCESS not-accessible 1888 STATUS current 1889 DESCRIPTION 1890 "Describes the attributes of an upstream bandwidth service 1891 queue. 1892 An entry in this table exists for each Service ID. 1893 The primary index is an ifIndex with an ifType of 1894 docsCableMaclayer(127)." 1895 INDEX { ifIndex, docsIfCmServiceId } 1896 ::= { docsIfCmServiceTable 1 } 1898 DocsIfCmServiceEntry ::= SEQUENCE { 1899 docsIfCmServiceId Integer32, 1900 docsIfCmServiceQosProfile Integer32, 1901 docsIfCmServiceTxSlotsImmed Counter32, 1902 docsIfCmServiceTxSlotsDed Counter32, 1903 docsIfCmServiceTxRetries Counter32, 1904 docsIfCmServiceTxExceededs Counter32, 1905 docsIfCmServiceRqRetries Counter32, 1906 docsIfCmServiceRqExceededs Counter32 1907 } 1909 docsIfCmServiceId OBJECT-TYPE 1910 SYNTAX Integer32 (1..16383) 1911 MAX-ACCESS not-accessible 1912 STATUS current 1913 DESCRIPTION 1914 "Identifies a service queue for upstream bandwidth. The 1915 attributes of this service queue are shared between the 1916 CM and the CMTS. The CMTS allocates upstream bandwidth 1917 to this service queue based on requests from the CM and 1918 on the class of service associated with this queue." 1919 ::= { docsIfCmServiceEntry 1 } 1921 docsIfCmServiceQosProfile OBJECT-TYPE 1922 SYNTAX Integer32 (0..16383) 1923 MAX-ACCESS read-only 1924 STATUS current 1925 DESCRIPTION 1926 "The index in docsIfQosProfileTable describing the quality 1927 of service attributes associated with this particular 1928 service. If no associated entry in docsIfQosProfileTable 1929 exists, this object returns a value of zero." 1931 ::= { docsIfCmServiceEntry 2 } 1933 docsIfCmServiceTxSlotsImmed OBJECT-TYPE 1934 SYNTAX Counter32 1935 MAX-ACCESS read-only 1936 STATUS current 1937 DESCRIPTION 1938 "The number of upstream mini-slots which have been used to 1939 transmit data PDUs in immediate (contention) mode. This 1940 includes only those PDUs which are presumed to have 1941 arrived at the headend (i.e., those which were explicitly 1942 acknowledged.) It does not include retransmission attempts 1943 or mini-slots used by Requests." 1944 REFERENCE 1945 "DOCSIS Radio Frequency Interface specification, 1946 Section 6.4." 1947 ::= { docsIfCmServiceEntry 3 } 1949 docsIfCmServiceTxSlotsDed OBJECT-TYPE 1950 SYNTAX Counter32 1951 MAX-ACCESS read-only 1952 STATUS current 1953 DESCRIPTION 1954 "The number of upstream mini-slots which have been used to 1955 transmit data PDUs in dedicated mode (i.e., as a result 1956 of a unicast Data Grant)." 1957 REFERENCE 1958 "DOCSIS Radio Frequency Interface specification, 1959 Section 6.4." 1960 ::= { docsIfCmServiceEntry 4 } 1962 docsIfCmServiceTxRetries OBJECT-TYPE 1963 SYNTAX Counter32 1964 MAX-ACCESS read-only 1965 STATUS current 1966 DESCRIPTION 1967 "The number of attempts to transmit data PDUs containing 1968 requests for acknowledgment which did not result in 1969 acknowledgment." 1970 REFERENCE 1971 "DOCSIS Radio Frequency Interface specification, 1972 Section 6.4." 1973 ::= { docsIfCmServiceEntry 5 } 1975 docsIfCmServiceTxExceededs OBJECT-TYPE 1976 SYNTAX Counter32 1977 MAX-ACCESS read-only 1978 STATUS current 1979 DESCRIPTION 1980 "The number of data PDUs transmission failures due to 1981 excessive retries without acknowledgment." 1982 REFERENCE 1983 "DOCSIS Radio Frequency Interface specification, 1984 Section 6.4." 1985 ::= { docsIfCmServiceEntry 6 } 1987 docsIfCmServiceRqRetries OBJECT-TYPE 1988 SYNTAX Counter32 1989 MAX-ACCESS read-only 1990 STATUS current 1991 DESCRIPTION 1992 "The number of attempts to transmit bandwidth requests 1993 which did not result in acknowledgment." 1994 REFERENCE 1995 "DOCSIS Radio Frequency Interface specification, 1996 Section 6.4." 1997 ::= { docsIfCmServiceEntry 7 } 1999 docsIfCmServiceRqExceededs OBJECT-TYPE 2000 SYNTAX Counter32 2001 MAX-ACCESS read-only 2002 STATUS current 2003 DESCRIPTION 2004 "The number of requests for bandwidth which failed due to 2005 excessive retries without acknowledgment." 2006 REFERENCE 2007 "DOCSIS Radio Frequency Interface specification, 2008 Section 6.4." 2009 ::= { docsIfCmServiceEntry 8 } 2011 -- 2012 -- CMTS GROUP 2013 -- 2015 -- 2016 -- The CMTS MAC Table 2017 -- 2019 docsIfCmtsMacTable OBJECT-TYPE 2020 SYNTAX SEQUENCE OF DocsIfCmtsMacEntry 2021 MAX-ACCESS not-accessible 2022 STATUS current 2023 DESCRIPTION 2024 "Describes the attributes of each CMTS MAC interface, 2025 extending the information available from ifEntry. 2027 Mandatory for all CMTS devices." 2028 ::= { docsIfCmtsObjects 1 } 2030 docsIfCmtsMacEntry OBJECT-TYPE 2031 SYNTAX DocsIfCmtsMacEntry 2032 MAX-ACCESS not-accessible 2033 STATUS current 2034 DESCRIPTION 2035 "An entry containing objects describing attributes of each 2036 MAC entry, extending the information in ifEntry. 2037 An entry in this table exists for each ifEntry with an 2038 ifType of docsCableMaclayer(127)." 2039 INDEX { ifIndex } 2040 ::= { docsIfCmtsMacTable 1 } 2042 DocsIfCmtsMacEntry ::= SEQUENCE { 2043 docsIfCmtsCapabilities BITS, 2044 docsIfCmtsSyncInterval Integer32, 2045 docsIfCmtsUcdInterval Integer32, 2046 docsIfCmtsMaxServiceIds Integer32, 2047 docsIfCmtsInsertionInterval TimeTicks, -- Obsolete 2048 docsIfCmtsInvitedRangingAttempts Integer32, 2049 docsIfCmtsInsertInterval TimeInterval 2050 } 2052 docsIfCmtsCapabilities OBJECT-TYPE 2053 SYNTAX BITS { 2054 atmCells(0), 2055 concatenation(1) 2056 } 2057 MAX-ACCESS read-only 2058 STATUS current 2059 DESCRIPTION 2060 "Identifies the capabilities of the CMTS MAC 2061 implementation at this interface. Note that packet 2062 transmission is always supported. Therefore, there 2063 is no specific bit required to explicitely indicate 2064 this capability. 2065 Note that BITS objects are encoded most significant bit 2066 first. For example, if bit 1 is set, the value of this 2067 object is the octet string '40'H." 2068 REFERENCE 2069 "DOCSIS Radio Frequency Interface specification, 2070 Chapter 6." 2071 ::= { docsIfCmtsMacEntry 1 } 2073 docsIfCmtsSyncInterval OBJECT-TYPE 2074 SYNTAX Integer32 (1..200) 2075 UNITS "Milliseconds" 2076 MAX-ACCESS read-write 2077 STATUS current 2078 DESCRIPTION 2079 "The interval between CMTS transmission of successive SYNC 2080 messages at this interface." 2081 REFERENCE 2082 "DOCSIS Radio Frequency Interface Specification, 2083 Section 6.5 and Appendix B." 2084 ::= { docsIfCmtsMacEntry 2 } 2086 docsIfCmtsUcdInterval OBJECT-TYPE 2087 SYNTAX Integer32 (1..2000) 2088 UNITS "Milliseconds" 2089 MAX-ACCESS read-write 2090 STATUS current 2091 DESCRIPTION 2092 "The interval between CMTS transmission of successive 2093 Upstream Channel Descriptor messages for each upstream 2094 channel at this interface." 2095 REFERENCE 2096 "DOCSIS Radio Frequency Interface Specification, 2097 Section 6.5 and Appendix B." 2098 ::= { docsIfCmtsMacEntry 3 } 2100 docsIfCmtsMaxServiceIds OBJECT-TYPE 2101 SYNTAX Integer32 (1..16383) 2102 MAX-ACCESS read-only 2103 STATUS current 2104 DESCRIPTION 2105 "The maximum number of service IDs that may be 2106 simultaneously active." 2107 ::= { docsIfCmtsMacEntry 4 } 2109 docsIfCmtsInsertionInterval OBJECT-TYPE 2110 SYNTAX TimeTicks 2111 MAX-ACCESS read-write 2112 STATUS obsolete 2113 DESCRIPTION 2114 "The amount of time to elapse between each broadcast 2115 station maintenance grant. Broadcast station maintenance 2116 grants are used to allow new cable modems to join the 2117 network. Zero indicates that a vendor-specific algorithm 2118 is used instead of a fixed time. Maximum amount of time 2119 permitted by the specification is 2 seconds. 2120 This object has been obsoleted and replaced by 2121 docsIfCmtsInsertInterval to fix a SYNTAX typing problem. 2123 New implementations of this MIB should use that object 2124 instead." 2125 REFERENCE 2126 "DOCSIS Radio Frequency Interface Specification, 2127 Appendix B, Ranging Interval." 2128 ::= { docsIfCmtsMacEntry 5 } 2130 docsIfCmtsInvitedRangingAttempts OBJECT-TYPE 2131 SYNTAX Integer32 (0..1024) 2132 MAX-ACCESS read-write 2133 STATUS current 2134 DESCRIPTION 2135 "The maximum number of attempts to make on invitations 2136 for ranging requests. A value of zero means the system 2137 should attempt to range forever." 2138 REFERENCE 2139 "DOCSIS Radio Frequency Interface specification, 2140 Section 7.2.5 and Appendix B." 2141 ::= { docsIfCmtsMacEntry 6 } 2143 docsIfCmtsInsertInterval OBJECT-TYPE 2144 SYNTAX TimeInterval 2145 MAX-ACCESS read-write 2146 STATUS current 2147 DESCRIPTION 2148 "The amount of time to elapse between each broadcast 2149 station maintenance grant. Broadcast station maintenance 2150 grants are used to allow new cable modems to join the 2151 network. Zero indicates that a vendor-specific algorithm 2152 is used instead of a fixed time. Maximum amount of time 2153 permitted by the specification is 2 seconds." 2154 REFERENCE 2155 "DOCSIS Radio Frequency Interface Specification, 2156 Appendix B." 2157 ::= { docsIfCmtsMacEntry 7 } 2159 -- 2160 -- 2161 -- CMTS status table. 2162 -- 2164 docsIfCmtsStatusTable OBJECT-TYPE 2165 SYNTAX SEQUENCE OF DocsIfCmtsStatusEntry 2166 MAX-ACCESS not-accessible 2167 STATUS current 2168 DESCRIPTION 2169 "For the MAC layer, this group maintains a number of 2170 status objects and counters." 2172 ::= { docsIfCmtsObjects 2 } 2174 docsIfCmtsStatusEntry OBJECT-TYPE 2175 SYNTAX DocsIfCmtsStatusEntry 2176 MAX-ACCESS not-accessible 2177 STATUS current 2178 DESCRIPTION 2179 "Status entry for a single MAC layer. 2180 An entry in this table exists for each ifEntry with an 2181 ifType of docsCableMaclayer(127)." 2182 INDEX { ifIndex } 2183 ::= { docsIfCmtsStatusTable 1 } 2185 DocsIfCmtsStatusEntry ::= SEQUENCE { 2186 docsIfCmtsStatusInvalidRangeReqs Counter32, 2187 docsIfCmtsStatusRangingAborteds Counter32, 2188 docsIfCmtsStatusInvalidRegReqs Counter32, 2189 docsIfCmtsStatusFailedRegReqs Counter32, 2190 docsIfCmtsStatusInvalidDataReqs Counter32, 2191 docsIfCmtsStatusT5Timeouts Counter32 2192 } 2194 docsIfCmtsStatusInvalidRangeReqs OBJECT-TYPE 2195 SYNTAX Counter32 2196 MAX-ACCESS read-only 2197 STATUS current 2198 DESCRIPTION 2199 "This object counts invalid RNG-REQ messages received on 2200 this interface." 2201 ::= { docsIfCmtsStatusEntry 1 } 2203 docsIfCmtsStatusRangingAborteds OBJECT-TYPE 2204 SYNTAX Counter32 2205 MAX-ACCESS read-only 2206 STATUS current 2207 DESCRIPTION 2208 "This object counts ranging attempts that were explicitely 2209 aborted by the CMTS." 2210 ::= { docsIfCmtsStatusEntry 2 } 2212 docsIfCmtsStatusInvalidRegReqs OBJECT-TYPE 2213 SYNTAX Counter32 2214 MAX-ACCESS read-only 2215 STATUS current 2216 DESCRIPTION 2217 "This object counts invalid REG-REQ messages received on 2218 this interface." 2219 ::= { docsIfCmtsStatusEntry 3 } 2221 docsIfCmtsStatusFailedRegReqs OBJECT-TYPE 2222 SYNTAX Counter32 2223 MAX-ACCESS read-only 2224 STATUS current 2225 DESCRIPTION 2226 "This object counts failed registration attempts, i.e., 2227 authentication failures and class of service failures, 2228 on this interface." 2229 ::= { docsIfCmtsStatusEntry 4 } 2231 docsIfCmtsStatusInvalidDataReqs OBJECT-TYPE 2232 SYNTAX Counter32 2233 MAX-ACCESS read-only 2234 STATUS current 2235 DESCRIPTION 2236 "This object counts invalid data request messages 2237 received on this interface." 2238 ::= { docsIfCmtsStatusEntry 5 } 2240 docsIfCmtsStatusT5Timeouts OBJECT-TYPE 2241 SYNTAX Counter32 2242 MAX-ACCESS read-only 2243 STATUS current 2244 DESCRIPTION 2245 "This object counts the number of times counter T5 2246 expired on this interface." 2247 ::= { docsIfCmtsStatusEntry 6 } 2249 -- 2250 -- CM status table (within CMTS). 2251 -- This table is implemented only at the CMTS. 2252 -- It contains per CM status information available in the CMTS. 2253 -- 2255 docsIfCmtsCmStatusTable OBJECT-TYPE 2256 SYNTAX SEQUENCE OF DocsIfCmtsCmStatusEntry 2257 MAX-ACCESS not-accessible 2258 STATUS current 2259 DESCRIPTION 2260 "A set of objects in the CMTS, maintained for each 2261 Cable Modem connected to this CMTS." 2262 ::= { docsIfCmtsObjects 3 } 2264 docsIfCmtsCmStatusEntry OBJECT-TYPE 2265 SYNTAX DocsIfCmtsCmStatusEntry 2266 MAX-ACCESS not-accessible 2267 STATUS current 2268 DESCRIPTION 2269 "Status information for a single Cable Modem. 2270 An entry in this table exists for each Cable Modem 2271 that is connected to the CMTS implementing this table." 2272 INDEX { docsIfCmtsCmStatusIndex } 2273 ::= { docsIfCmtsCmStatusTable 1 } 2275 DocsIfCmtsCmStatusEntry ::= SEQUENCE { 2276 docsIfCmtsCmStatusIndex Integer32, 2277 docsIfCmtsCmStatusMacAddress MacAddress, 2278 docsIfCmtsCmStatusIpAddress IpAddress, -- Deprecated 2279 docsIfCmtsCmStatusDownChannelIfIndex InterfaceIndexOrZero, 2280 docsIfCmtsCmStatusUpChannelIfIndex InterfaceIndexOrZero, 2281 docsIfCmtsCmStatusRxPower TenthdBmV, 2282 docsIfCmtsCmStatusTimingOffset Unsigned32, 2283 docsIfCmtsCmStatusEqualizationData OCTET STRING, 2284 docsIfCmtsCmStatusValue INTEGER, 2285 docsIfCmtsCmStatusUnerroreds Counter32, 2286 docsIfCmtsCmStatusCorrecteds Counter32, 2287 docsIfCmtsCmStatusUncorrectables Counter32, 2288 docsIfCmtsCmStatusSignalNoise TenthdB, 2289 docsIfCmtsCmStatusMicroreflections Integer32, 2290 docsIfCmtsCmStatusInetAddressType InetAddressType, 2291 docsIfCmtsCmStatusInetAddress InetAddress 2292 } 2294 docsIfCmtsCmStatusIndex OBJECT-TYPE 2295 SYNTAX Integer32 (1..2147483647) 2296 MAX-ACCESS not-accessible 2297 STATUS current 2298 DESCRIPTION 2299 "Index value to uniquely identify an entry in this table. 2300 For an individual Cable Modem, this index value should 2301 not change during CMTS uptime." 2302 ::= { docsIfCmtsCmStatusEntry 1 } 2304 docsIfCmtsCmStatusMacAddress OBJECT-TYPE 2305 SYNTAX MacAddress 2306 MAX-ACCESS read-only 2307 STATUS current 2308 DESCRIPTION 2309 "MAC address of this Cable Modem. If the Cable Modem has 2310 multiple MAC addresses, this is the MAC address associated 2311 with the Cable interface." 2312 ::= { docsIfCmtsCmStatusEntry 2 } 2314 docsIfCmtsCmStatusIpAddress OBJECT-TYPE 2315 SYNTAX IpAddress 2316 MAX-ACCESS read-only 2317 STATUS deprecated 2318 DESCRIPTION 2319 "IP address of this Cable Modem. If the Cable Modem has no 2320 IP address assigned, or the IP address is unknown, this 2321 object returns a value of 0.0.0.0. If the Cable Modem has 2322 multiple IP addresses, this object returns the IP address 2323 associated with the Cable interface. 2324 This object has been deprecated and replaced by 2325 docsIfCmtsCmStatusInetAddressType and 2326 docsIfCmtsCmStatusInetAddress, to enable IPv6 addressing 2327 in the future." 2328 ::= { docsIfCmtsCmStatusEntry 3 } 2330 docsIfCmtsCmStatusDownChannelIfIndex OBJECT-TYPE 2331 SYNTAX InterfaceIndexOrZero 2332 MAX-ACCESS read-only 2333 STATUS current 2334 DESCRIPTION 2335 "IfIndex of the downstream channel this CM is connected 2336 to. If the downstream channel is unknown, this object 2337 returns a value of zero." 2338 ::= { docsIfCmtsCmStatusEntry 4 } 2340 docsIfCmtsCmStatusUpChannelIfIndex OBJECT-TYPE 2341 SYNTAX InterfaceIndexOrZero 2342 MAX-ACCESS read-only 2343 STATUS current 2344 DESCRIPTION 2345 "IfIndex of the upstream channel this CM is connected 2346 to. If the upstream channel is unknown, this object 2347 returns a value of zero." 2348 ::= { docsIfCmtsCmStatusEntry 5 } 2350 docsIfCmtsCmStatusRxPower OBJECT-TYPE 2351 SYNTAX TenthdBmV 2352 UNITS "dBmV" 2353 MAX-ACCESS read-only 2354 STATUS current 2355 DESCRIPTION 2356 "The receive power as percieved for upstream data from 2357 this Cable Modem. 2358 If the receive power is unknown, this object returns 2359 a value of zero." 2360 REFERENCE 2361 "DOCSIS Radio Frequency Interface Specification, 2362 Table 4-13." 2363 ::= { docsIfCmtsCmStatusEntry 6 } 2365 docsIfCmtsCmStatusTimingOffset OBJECT-TYPE 2366 SYNTAX Unsigned32 2367 MAX-ACCESS read-only 2368 STATUS current 2369 DESCRIPTION 2370 "A measure of the current round trip time for this CM. 2371 Used for timing of CM upstream transmissions to ensure 2372 synchronized arrivals at the CMTS. Units are in terms 2373 of (6.25 microseconds/64). Returns zero if the value 2374 is unknown." 2375 REFERENCE 2376 "DOCSIS Radio Frequency Interface Specification, 2377 Section 6.5." 2378 ::= { docsIfCmtsCmStatusEntry 7 } 2380 docsIfCmtsCmStatusEqualizationData OBJECT-TYPE 2381 SYNTAX OCTET STRING 2382 MAX-ACCESS read-only 2383 STATUS current 2384 DESCRIPTION 2385 "Equalization data for this CM. Returns an empty string 2386 if the value is unknown or if there is no equalization 2387 data available or defined." 2388 REFERENCE 2389 "DOCSIS Radio Frequency Interface Specification, 2390 Figure 6-23." 2391 ::= { docsIfCmtsCmStatusEntry 8 } 2393 docsIfCmtsCmStatusValue OBJECT-TYPE 2394 SYNTAX INTEGER { 2395 other(1), 2396 ranging(2), 2397 rangingAborted(3), 2398 rangingComplete(4), 2399 ipComplete(5), 2400 registrationComplete(6), 2401 accessDenied(7) 2402 } 2403 MAX-ACCESS read-only 2404 STATUS current 2405 DESCRIPTION 2406 "Current Cable Modem connectivity state, as specified 2407 in the RF Interface Specification. Returned status 2408 information is the CM status as assumed by the CMTS, 2409 and indicates the following events: 2410 other(1) 2411 Any state other than below. 2412 ranging(2) 2413 The CMTS has received an Initial Ranging Request 2414 message from the CM, and the ranging process is not 2415 yet complete. 2416 rangingAborted(3) 2417 The CMTS has sent a Ranging Abort message to the CM. 2418 rangingComplete(4) 2419 The CMTS has sent a Ranging Complete message to the CM. 2420 ipComplete(5) 2421 The CMTS has received a DHCP reply message and forwarded 2422 it to the CM. 2423 registrationComplete(6) 2424 The CMTS has sent a Registration Response mesage to 2425 the CM. 2426 accessDenied(7) 2427 The CMTS has sent a Registration Aborted message 2428 to the CM. 2429 The CMTS only needs to report states it is able to detect." 2430 REFERENCE 2431 "DOCSIS Radio Frequency Interface Specification, 2432 Chapter 7.2." 2433 ::= { docsIfCmtsCmStatusEntry 9 } 2435 docsIfCmtsCmStatusUnerroreds OBJECT-TYPE 2436 SYNTAX Counter32 2437 MAX-ACCESS read-only 2438 STATUS current 2439 DESCRIPTION 2440 "Codewords received without error from this Cable Modem." 2441 REFERENCE 2442 "DOCSIS Radio Frequency Interface specification, 2443 Section 4.2.3" 2444 ::= { docsIfCmtsCmStatusEntry 10 } 2446 docsIfCmtsCmStatusCorrecteds OBJECT-TYPE 2447 SYNTAX Counter32 2448 MAX-ACCESS read-only 2449 STATUS current 2450 DESCRIPTION 2451 "Codewords received with correctable errors from this 2452 Cable Modem." 2453 REFERENCE 2454 "DOCSIS Radio Frequency Interface specification, 2455 Section 4.2.3" 2456 ::= { docsIfCmtsCmStatusEntry 11 } 2458 docsIfCmtsCmStatusUncorrectables OBJECT-TYPE 2459 SYNTAX Counter32 2460 MAX-ACCESS read-only 2461 STATUS current 2462 DESCRIPTION 2463 "Codewords received with uncorrectable errors from this 2464 Cable Modem." 2465 REFERENCE 2466 "DOCSIS Radio Frequency Interface specification, 2467 Section 4.2.3" 2468 ::= { docsIfCmtsCmStatusEntry 12 } 2470 docsIfCmtsCmStatusSignalNoise OBJECT-TYPE 2471 SYNTAX TenthdB 2472 UNITS "dB" 2473 MAX-ACCESS read-only 2474 STATUS current 2475 DESCRIPTION 2476 "Signal/Noise ratio as perceived for upstream data from 2477 this Cable Modem. 2478 If the Signal/Noise is unknown, this object returns 2479 a value of zero." 2480 ::= { docsIfCmtsCmStatusEntry 13 } 2482 docsIfCmtsCmStatusMicroreflections OBJECT-TYPE 2483 SYNTAX Integer32 (0..255) 2484 UNITS "dBc" 2485 MAX-ACCESS read-only 2486 STATUS current 2487 DESCRIPTION 2488 "Total microreflections including in-channel response 2489 as perceived on this interface, measured in dBc below 2490 the signal level. 2491 This object is not assumed to return an absolutely 2492 accurate value, but should give a rough indication 2493 of microreflections received on this interface. 2494 It is up to the implementor to provide information 2495 as accurate as possible." 2496 REFERENCE 2497 "DOCSIS Radio Frequency Interface specification, 2498 Table 2-1 and 2-2" 2499 ::= { docsIfCmtsCmStatusEntry 14 } 2501 docsIfCmtsCmStatusInetAddressType OBJECT-TYPE 2502 SYNTAX InetAddressType 2503 MAX-ACCESS read-only 2504 STATUS current 2505 DESCRIPTION 2506 "The type of internet address of 2507 docsIfCmtsCmStatusInetAddress. If the cable modem 2508 Internet address is unassigned or unknown, then the 2509 value of this object is unknown(0)." 2510 ::= { docsIfCmtsCmStatusEntry 15 } 2512 docsIfCmtsCmStatusInetAddress OBJECT-TYPE 2513 SYNTAX InetAddress 2514 MAX-ACCESS read-only 2515 STATUS current 2516 DESCRIPTION 2517 "Internet address of this Cable Modem. If the Cable Modem 2518 has no Internet address assigned, or the Internet address 2519 is unknown, the value of this object is the empty string. 2520 If the Cable Modem has multiple Internet addresses, this 2521 object returns the Internet address associated with the 2522 Cable (i.e. RF MAC) interface." 2523 ::= { docsIfCmtsCmStatusEntry 16 } 2525 -- 2526 -- The CMTS Service Table. 2527 -- 2529 docsIfCmtsServiceTable OBJECT-TYPE 2530 SYNTAX SEQUENCE OF DocsIfCmtsServiceEntry 2531 MAX-ACCESS not-accessible 2532 STATUS current 2533 DESCRIPTION 2534 "Describes the attributes of upstream service queues 2535 in a Cable Modem Termination System." 2536 ::= { docsIfCmtsObjects 4 } 2538 docsIfCmtsServiceEntry OBJECT-TYPE 2539 SYNTAX DocsIfCmtsServiceEntry 2540 MAX-ACCESS not-accessible 2541 STATUS current 2542 DESCRIPTION 2543 "Describes the attributes of a single upstream bandwidth 2544 service queue. 2545 Entries in this table exist for each ifEntry with an 2546 ifType of docsCableMaclayer(127), and for each service 2547 queue (Service ID) within this MAC layer. 2548 Entries in this table are created with the creation of 2549 individual Service IDs by the MAC layer and removed 2550 when a Service ID is removed." 2551 INDEX { ifIndex, docsIfCmtsServiceId } 2552 ::= { docsIfCmtsServiceTable 1 } 2554 DocsIfCmtsServiceEntry ::= SEQUENCE { 2555 docsIfCmtsServiceId Integer32, 2556 docsIfCmtsServiceCmStatusIndex Integer32, -- Deprecated 2557 docsIfCmtsServiceAdminStatus INTEGER, 2558 docsIfCmtsServiceQosProfile Integer32, 2559 docsIfCmtsServiceCreateTime TimeStamp, 2560 docsIfCmtsServiceInOctets Counter32, 2561 docsIfCmtsServiceInPackets Counter32, 2562 docsIfCmtsServiceNewCmStatusIndex Integer32 2563 } 2565 docsIfCmtsServiceId OBJECT-TYPE 2566 SYNTAX Integer32 (1..16383) 2567 MAX-ACCESS not-accessible 2568 STATUS current 2569 DESCRIPTION 2570 "Identifies a service queue for upstream bandwidth. The 2571 attributes of this service queue are shared between the 2572 Cable Modem and the Cable Modem Termination System. 2573 The CMTS allocates upstream bandwidth to this service 2574 queue based on requests from the CM and on the class of 2575 service associated with this queue." 2576 ::= { docsIfCmtsServiceEntry 1 } 2578 docsIfCmtsServiceCmStatusIndex OBJECT-TYPE 2579 SYNTAX Integer32 (0..65535) 2580 MAX-ACCESS read-only 2581 STATUS deprecated 2582 DESCRIPTION 2583 "Pointer to an entry in docsIfCmtsCmStatusTable identifying 2584 the Cable Modem using this Service Queue. If multiple 2585 Cable Modems are using this Service Queue, the value of 2586 this object is zero. 2587 This object has been deprecated and replaced by 2588 docsIfCmtsServiceNewCmStatusIndex, to fix a mismatch 2589 of the value range with respect to docsIfCmtsCmStatusIndex 2590 (1..2147483647)." 2591 ::= { docsIfCmtsServiceEntry 2 } 2593 docsIfCmtsServiceAdminStatus OBJECT-TYPE 2594 SYNTAX INTEGER { 2595 enabled(1), 2596 disabled(2), 2597 destroyed(3) } 2598 MAX-ACCESS read-write 2599 STATUS current 2600 DESCRIPTION 2601 "Allows a service class for a particular modem to be 2602 suppressed, (re-)enabled, or deleted altogether." 2603 ::= { docsIfCmtsServiceEntry 3 } 2605 docsIfCmtsServiceQosProfile OBJECT-TYPE 2606 SYNTAX Integer32 (0..16383) 2607 MAX-ACCESS read-only 2608 STATUS current 2609 DESCRIPTION 2610 "The index in docsIfQosProfileTable describing the quality 2611 of service attributes associated with this particular 2612 service. If no associated docsIfQosProfileTable entry 2613 exists, this object returns a value of zero." 2614 ::= { docsIfCmtsServiceEntry 4 } 2616 docsIfCmtsServiceCreateTime OBJECT-TYPE 2617 SYNTAX TimeStamp 2618 MAX-ACCESS read-only 2619 STATUS current 2620 DESCRIPTION 2621 "The value of sysUpTime when this entry was created." 2622 ::= { docsIfCmtsServiceEntry 5 } 2624 docsIfCmtsServiceInOctets OBJECT-TYPE 2625 SYNTAX Counter32 2626 MAX-ACCESS read-only 2627 STATUS current 2628 DESCRIPTION 2629 "The cumulative number of Packet Data octets received 2630 on this Service ID. The count does not include the 2631 size of the Cable MAC header" 2632 ::= { docsIfCmtsServiceEntry 6 } 2634 docsIfCmtsServiceInPackets OBJECT-TYPE 2635 SYNTAX Counter32 2636 MAX-ACCESS read-only 2637 STATUS current 2638 DESCRIPTION 2639 "The cumulative number of Packet Data packets received 2640 on this Service ID." 2641 ::= { docsIfCmtsServiceEntry 7 } 2643 docsIfCmtsServiceNewCmStatusIndex OBJECT-TYPE 2644 SYNTAX Integer32 (0..2147483647) 2645 MAX-ACCESS read-only 2646 STATUS current 2647 DESCRIPTION 2648 "Pointer (via docsIfCmtsCmStatusIndex) to an entry in 2649 docsIfCmtsCmStatusTable identifying the Cable Modem 2650 using this Service Queue. If multiple Cable Modems are 2651 using this Service Queue, the value of this object is 2652 zero." 2654 ::= { docsIfCmtsServiceEntry 8 } 2656 -- 2657 -- The following table provides upstream channel modulation profiles. 2658 -- Entries in this table can be 2659 -- re-used by one or more upstream channels. An upstream channel will 2660 -- have a modulation profile 2661 -- for each value of docsIfModIntervalUsageCode. 2662 -- 2664 docsIfCmtsModulationTable OBJECT-TYPE 2665 SYNTAX SEQUENCE OF DocsIfCmtsModulationEntry 2666 MAX-ACCESS not-accessible 2667 STATUS current 2668 DESCRIPTION 2669 "Describes a modulation profile associated with one or more 2670 upstream channels." 2671 ::= { docsIfCmtsObjects 5 } 2673 docsIfCmtsModulationEntry OBJECT-TYPE 2674 SYNTAX DocsIfCmtsModulationEntry 2675 MAX-ACCESS not-accessible 2676 STATUS current 2677 DESCRIPTION 2678 "Describes a modulation profile for an Interval Usage Code 2679 for one or more upstream channels. 2680 Entries in this table are created by the operator. Initial 2681 default entries may be created at system initialization 2682 time. No individual objects have to be specified in order 2683 to create an entry in this table. 2684 Note that some objects do not have DEFVALs, but do have 2685 calculated defaults and need not be specified during row 2686 creation. 2687 There is no restriction on the changing of values in this 2688 table while their associated rows are active." 2689 INDEX { docsIfCmtsModIndex, docsIfCmtsModIntervalUsageCode } 2690 ::= { docsIfCmtsModulationTable 1 } 2692 DocsIfCmtsModulationEntry ::= SEQUENCE { 2693 docsIfCmtsModIndex Integer32, 2694 docsIfCmtsModIntervalUsageCode INTEGER, 2695 docsIfCmtsModControl RowStatus, 2696 docsIfCmtsModType INTEGER, 2697 docsIfCmtsModPreambleLen Integer32, 2698 docsIfCmtsModDifferentialEncoding TruthValue, 2699 docsIfCmtsModFECErrorCorrection Integer32, 2700 docsIfCmtsModFECCodewordLength Integer32, 2701 docsIfCmtsModScramblerSeed Integer32, 2702 docsIfCmtsModMaxBurstSize Integer32, 2703 docsIfCmtsModGuardTimeSize Unsigned32, 2704 docsIfCmtsModLastCodewordShortened TruthValue, 2705 docsIfCmtsModScrambler TruthValue 2706 } 2708 docsIfCmtsModIndex OBJECT-TYPE 2709 SYNTAX Integer32 (1..2147483647) 2710 MAX-ACCESS not-accessible 2711 STATUS current 2712 DESCRIPTION 2713 "An index into the Channel Modulation table representing 2714 a group of Interval Usage Codes, all associated with the 2715 same channel." 2716 ::= { docsIfCmtsModulationEntry 1 } 2718 docsIfCmtsModIntervalUsageCode OBJECT-TYPE 2719 SYNTAX INTEGER { 2720 request(1), 2721 requestData(2), 2722 initialRanging(3), 2723 periodicRanging(4), 2724 shortData(5), 2725 longData(6) 2726 } 2727 MAX-ACCESS not-accessible 2728 STATUS current 2729 DESCRIPTION 2730 "An index into the Channel Modulation table which, when 2731 grouped with other Interval Usage Codes, fully 2732 instantiate all modulation sets for a given upstream 2733 channel." 2734 REFERENCE 2735 "DOCSIS Radio Frequency Interface specification, 2736 Table 6-16." 2737 ::= { docsIfCmtsModulationEntry 2 } 2739 docsIfCmtsModControl OBJECT-TYPE 2740 SYNTAX RowStatus 2741 MAX-ACCESS read-create 2742 STATUS current 2743 DESCRIPTION 2744 "Controls and reflects the status of rows in this table." 2745 ::= { docsIfCmtsModulationEntry 3 } 2747 docsIfCmtsModType OBJECT-TYPE 2748 SYNTAX INTEGER { 2749 other(1), 2750 qpsk(2), 2751 qam16(3) 2752 } 2753 MAX-ACCESS read-create 2754 STATUS current 2755 DESCRIPTION 2756 "The modulation type used on this channel. Returns 2757 other(1) if the modulation type is neither qpsk or 2758 qam16. See the reference for the modulation profiles 2759 implied by qpsk or qam16. See the conformance object for 2760 write conditions and limitations." 2761 REFERENCE 2762 "DOCSIS Radio Frequency Interface specification, 2763 Section 4.2.2." 2764 DEFVAL { qpsk } 2765 ::= { docsIfCmtsModulationEntry 4 } 2767 docsIfCmtsModPreambleLen OBJECT-TYPE 2768 SYNTAX Integer32 (0..1024) 2769 MAX-ACCESS read-create 2770 STATUS current 2771 DESCRIPTION 2772 "The preamble length for this modulation profile in bits. 2773 Default value is the minimum needed by the implementation 2774 at the CMTS for the given modulation profile." 2775 REFERENCE 2776 "DOCSIS Radio Frequency Interface specification, 2777 Section 4.2.5." 2778 ::= { docsIfCmtsModulationEntry 5 } 2780 docsIfCmtsModDifferentialEncoding OBJECT-TYPE 2781 SYNTAX TruthValue 2782 MAX-ACCESS read-create 2783 STATUS current 2784 DESCRIPTION 2785 "Specifies whether or not differential encoding is used 2786 on this channel." 2787 DEFVAL { false } 2788 ::= { docsIfCmtsModulationEntry 6 } 2790 docsIfCmtsModFECErrorCorrection OBJECT-TYPE 2791 SYNTAX Integer32 (0..10) 2792 MAX-ACCESS read-create 2793 STATUS current 2794 DESCRIPTION 2795 "The number of correctable errored bytes (t) used in 2796 forward error correction code. The value of 0 indicates 2797 no correction is employed. The number of check bytes 2798 appended will be twice this value." 2799 REFERENCE 2800 "DOCSIS Radio Frequency Interface specification, 2801 Section 4.2.3." 2802 DEFVAL { 0 } 2803 ::= { docsIfCmtsModulationEntry 7 } 2805 docsIfCmtsModFECCodewordLength OBJECT-TYPE 2806 SYNTAX Integer32 (1..255) 2807 MAX-ACCESS read-create 2808 STATUS current 2809 DESCRIPTION 2810 "The number of data bytes (k) in the forward error 2811 correction codeword. 2812 This object is not used if docsIfCmtsModFECErrorCorrection 2813 is zero." 2814 REFERENCE 2815 "DOCSIS Radio Frequency Interface specification, 2816 Section 4.2.3." 2817 DEFVAL { 32 } 2818 ::= { docsIfCmtsModulationEntry 8 } 2820 docsIfCmtsModScramblerSeed OBJECT-TYPE 2821 SYNTAX Integer32 (0..32767) 2822 MAX-ACCESS read-create 2823 STATUS current 2824 DESCRIPTION 2825 "The 15 bit seed value for the scrambler polynomial." 2826 REFERENCE 2827 "DOCSIS Radio Frequency Interface specification, 2828 Section 4.2.4." 2829 DEFVAL { 0 } 2830 ::= { docsIfCmtsModulationEntry 9 } 2832 docsIfCmtsModMaxBurstSize OBJECT-TYPE 2833 SYNTAX Integer32 (0..255) 2834 MAX-ACCESS read-create 2835 STATUS current 2836 DESCRIPTION 2837 "The maximum number of mini-slots that can be transmitted 2838 during this channel's burst time. Returns zero if the 2839 burst length is bounded by the allocation MAP rather than 2840 this profile. 2841 Default value is 0 except for shortData, where it is 8." 2842 ::= { docsIfCmtsModulationEntry 10 } 2844 docsIfCmtsModGuardTimeSize OBJECT-TYPE 2845 SYNTAX Unsigned32 2846 MAX-ACCESS read-only 2847 STATUS current 2848 DESCRIPTION 2849 "The number of symbol-times which must follow the end of 2850 this channel's burst. Default value is the minimum time 2851 needed by the implementation for this modulation profile." 2852 REFERENCE 2853 "DOCSIS Radio Frequency Interface specification, 2854 Section 4.2.7." 2855 ::= { docsIfCmtsModulationEntry 11 } 2857 docsIfCmtsModLastCodewordShortened OBJECT-TYPE 2858 SYNTAX TruthValue 2859 MAX-ACCESS read-create 2860 STATUS current 2861 DESCRIPTION 2862 "Indicates if the last FEC codeword is truncated." 2863 REFERENCE 2864 "DOCSIS Radio Frequency Interface specification, 2865 Section 4.2.10." 2866 DEFVAL { true } 2867 ::= { docsIfCmtsModulationEntry 12 } 2869 docsIfCmtsModScrambler OBJECT-TYPE 2870 SYNTAX TruthValue 2871 MAX-ACCESS read-create 2872 STATUS current 2873 DESCRIPTION 2874 "Indicates if the scrambler is employed." 2875 REFERENCE 2876 "DOCSIS Radio Frequency Interface specification, 2877 Section 4.2.4." 2878 DEFVAL { false } 2879 ::= { docsIfCmtsModulationEntry 13 } 2881 docsIfCmtsQosProfilePermissions OBJECT-TYPE 2882 SYNTAX BITS { 2883 createByManagement(0), 2884 updateByManagement(1), 2885 createByModems(2) 2886 } 2887 MAX-ACCESS read-write 2888 STATUS current 2889 DESCRIPTION 2890 "This object specifies permitted methods of creating 2891 entries in docsIfQosProfileTable. 2892 CreateByManagement(0) is set if entries can be created 2893 using SNMP. UpdateByManagement(1) is set if updating 2894 entries using SNMP is permitted. CreateByModems(2) 2895 is set if entries can be created based on information 2896 in REG-REQ MAC messages received from Cable Modems. 2897 Information in this object is only applicable if 2898 docsIfQosProfileTable is implemented as read-create. 2899 Otherwise, this object is implemented as read-only 2900 and returns CreateByModems(2). 2901 Either CreateByManagement(0) or CreateByModems(1) 2902 must be set when writing to this object. 2903 Note that BITS objects are encoded most significant bit 2904 first. For example, if bit 2 is set, the value 2905 of this object is the octet string '20'H." 2906 ::= { docsIfCmtsObjects 6 } 2908 docsIfCmtsMacToCmTable OBJECT-TYPE 2909 SYNTAX SEQUENCE OF DocsIfCmtsMacToCmEntry 2910 MAX-ACCESS not-accessible 2911 STATUS current 2912 DESCRIPTION 2913 "This is a table to provide a quick access index into the 2914 docsIfCmtsCmStatusTable. There is exactly one row in this 2915 table for each row in the docsIfCmtsCmStatusTable. In 2916 general, the management station should use this table only 2917 to get a pointer into the docsIfCmtsCmStatusTable (which 2918 corresponds to the CM's RF interface MAC address), and 2919 should not iterate (e.g. GetNext through) this table." 2920 ::= { docsIfCmtsObjects 7 } 2922 docsIfCmtsMacToCmEntry OBJECT-TYPE 2923 SYNTAX DocsIfCmtsMacToCmEntry 2924 MAX-ACCESS not-accessible 2925 STATUS current 2926 DESCRIPTION 2927 "A row in the docsIfCmtsMacToCmTable. 2928 An entry in this table exists for each Cable Modem 2929 that is connected to the CMTS implementing this table." 2930 INDEX { docsIfCmtsCmMac } 2931 ::= {docsIfCmtsMacToCmTable 1 } 2933 DocsIfCmtsMacToCmEntry ::= SEQUENCE { 2934 docsIfCmtsCmMac MacAddress, 2935 docsIfCmtsCmPtr Integer32 2936 } 2938 docsIfCmtsCmMac OBJECT-TYPE 2939 SYNTAX MacAddress 2940 MAX-ACCESS not-accessible 2941 STATUS current 2942 DESCRIPTION 2943 "The RF side MAC address for the referenced CM. (E.g. the 2944 interface on the CM that has docsCableMacLayer(127) as 2945 its ifType." 2946 ::= { docsIfCmtsMacToCmEntry 1 } 2948 docsIfCmtsCmPtr OBJECT-TYPE 2949 SYNTAX Integer32 (1..2147483647) 2950 MAX-ACCESS read-only 2951 STATUS current 2952 DESCRIPTION 2953 "An row index into docsIfCmtsCmStatusTable. When queried 2954 with the correct instance value (e.g. a CM's MAC address), 2955 returns the index in docsIfCmtsCmStatusTable which 2956 represents that CM." 2957 ::= { docsIfCmtsMacToCmEntry 2 } 2959 -- 2960 -- notification group is for future extension. 2961 -- 2962 docsIfNotification OBJECT IDENTIFIER ::= { docsIfMib 2 } 2964 docsIfConformance OBJECT IDENTIFIER ::= { docsIfMib 3 } 2965 docsIfCompliances OBJECT IDENTIFIER ::= { docsIfConformance 1 } 2966 docsIfGroups OBJECT IDENTIFIER ::= { docsIfConformance 2 } 2968 -- compliance statements 2970 docsIfBasicCompliance MODULE-COMPLIANCE 2971 STATUS current 2972 DESCRIPTION 2973 "The compliance statement for devices that implement 2974 DOCSIS compliant Radio Frequency Interfaces." 2976 MODULE -- docsIfMib 2978 -- unconditionally mandatory groups 2979 MANDATORY-GROUPS { 2980 docsIfBasicGroup 2981 } 2983 -- conditionally mandatory group 2984 GROUP docsIfCmGroup 2985 DESCRIPTION 2986 "This group is implemented only in Cable Modems, not in 2987 Cable Modem Termination Systems." 2989 -- conditionally mandatory group 2990 GROUP docsIfCmtsGroup 2991 DESCRIPTION 2992 "This group is implemented only in Cable Modem Termination 2993 Systems, not in Cable Modems." 2995 OBJECT docsIfDownChannelFrequency 2996 WRITE-SYNTAX Integer32 (47000000..862000000) 2997 MIN-ACCESS read-only 2998 DESCRIPTION 2999 "Read-write in Cable Modem Termination Systems; 3000 read-only in Cable Modems. 3001 A range of 54MHz to 860MHz is appropriate for a cable 3002 plant using a North American Sub-Split channel plan. 3003 The spectrum range has been expanded to accommodate 3004 a lower edge of 47MHz and an upper edge of 862MHz 3005 for some European channel plans. 3006 If DOCSIS is extended to cover other types of channel 3007 plans (and frequency allocations) this object will be 3008 modified accordingly." 3010 OBJECT docsIfDownChannelWidth 3011 WRITE-SYNTAX Integer32 (6000000 | 8000000) 3012 MIN-ACCESS read-only 3013 DESCRIPTION 3014 "It is conformant to implement this object as read-only. 3015 In Cable Modems, this object is always implemented as 3016 read-only. The value of 6 MHz is appropriate for cable 3017 plants running under NTSC (National Television 3018 Standards Committee) standards. The value of 8 MHz is 3019 appropriate for cable plants running under ETSI 3020 standards. For other regional standards, this 3021 object will be modified accordingly." 3023 OBJECT docsIfDownChannelModulation 3024 WRITE-SYNTAX INTEGER { 3025 qam64 (3), 3026 qam256 (4) 3027 } 3028 MIN-ACCESS read-only 3029 DESCRIPTION 3030 "Read-write in Cable Modem Termination Systems; 3031 read-only in Cable Modems." 3033 OBJECT docsIfDownChannelInterleave 3034 WRITE-SYNTAX INTEGER { 3035 taps8Increment16(3), 3036 taps16Increment8(4), 3037 taps32Increment4(5), 3038 taps64Increment2(6), 3039 taps128Increment1(7), 3040 taps12increment17(8) 3041 } 3042 MIN-ACCESS read-only 3043 DESCRIPTION 3044 "Read-write in Cable Modem Termination Systems; 3045 read-only in Cable Modems." 3047 OBJECT docsIfDownChannelPower 3048 MIN-ACCESS read-only 3049 DESCRIPTION 3050 "Read-write in Cable Modem Termination Systems; 3051 read-only in Cable Modems." 3053 OBJECT docsIfUpChannelFrequency 3054 WRITE-SYNTAX Integer32 (5000000..65000000) 3055 MIN-ACCESS read-only 3056 DESCRIPTION 3057 "Read-write in Cable Modem Termination Systems; 3058 read-only in Cable Modems. 3059 A range of 5MHz to 42MHz is appropriate for a cable 3060 plant using a North American Sub-Split channel plan. 3061 The spectrum range has been expanded to accommodate 3062 an upper edge of 65MHz for some European channel plans. 3063 If DOCSIS is extended to cover other types of channel 3064 plans (and frequency allocations) this object will 3065 be modified accordingly." 3067 OBJECT docsIfUpChannelWidth 3068 WRITE-SYNTAX Integer32 (200000..3200000) 3069 MIN-ACCESS read-only 3070 DESCRIPTION 3071 "Read-write in Cable Modem Termination Systems; 3072 read-only in Cable Modems.The above value is appropriate 3073 for cable plants running under NTSC (National Television 3074 Standards Committee) standards. If DOCSIS is extended to 3075 work with other standard (e.g. European standards), this 3076 object will be modified accordingly." 3078 OBJECT docsIfUpChannelModulationProfile 3079 MIN-ACCESS read-only 3080 DESCRIPTION 3081 "Read-write in Cable Modem Termination Systems; 3082 read-only in Cable Modems." 3084 OBJECT docsIfUpChannelSlotSize 3085 MIN-ACCESS read-only 3086 DESCRIPTION 3087 "This object is always read-only in Cable Modems. 3088 It is compliant to implement this object as read-only 3089 in Cable Modem Termination Systems." 3091 OBJECT docsIfUpChannelRangingBackoffStart 3092 MIN-ACCESS read-only 3093 DESCRIPTION 3094 "Read-write in Cable Modem Termination Systems; 3095 read-only in Cable Modems." 3097 OBJECT docsIfUpChannelRangingBackoffEnd 3098 MIN-ACCESS read-only 3099 DESCRIPTION 3100 "Read-write in Cable Modem Termination Systems; 3101 read-only in Cable Modems." 3103 OBJECT docsIfUpChannelTxBackoffStart 3104 MIN-ACCESS read-only 3105 DESCRIPTION 3106 "Read-write in Cable Modem Termination Systems; 3107 read-only in Cable Modems." 3109 OBJECT docsIfUpChannelTxBackoffEnd 3110 MIN-ACCESS read-only 3111 DESCRIPTION 3112 "Read-write in Cable Modem Termination Systems; 3113 read-only in Cable Modems." 3115 OBJECT docsIfQosProfPriority 3116 MIN-ACCESS read-only 3117 DESCRIPTION 3118 "This object is always read-only in Cable Modems. 3119 It is compliant to implement this object as read-only 3120 in Cable Modem Termination Systems." 3122 OBJECT docsIfQosProfMaxUpBandwidth 3123 MIN-ACCESS read-only 3124 DESCRIPTION 3125 "This object is always read-only in Cable Modems. 3126 It is compliant to implement this object as read-only 3127 in Cable Modem Termination Systems." 3129 OBJECT docsIfQosProfGuarUpBandwidth 3130 MIN-ACCESS read-only 3131 DESCRIPTION 3132 "This object is always read-only in Cable Modems. 3133 It is compliant to implement this object as read-only 3134 in Cable Modem Termination Systems." 3136 OBJECT docsIfQosProfMaxDownBandwidth 3137 MIN-ACCESS read-only 3138 DESCRIPTION 3139 "This object is always read-only in Cable Modems. 3140 It is compliant to implement this object as read-only 3141 in Cable Modem Termination Systems." 3143 OBJECT docsIfQosProfBaselinePrivacy 3144 MIN-ACCESS read-only 3145 DESCRIPTION 3146 "This object is always read-only in Cable Modems. 3147 It is compliant to implement this object as read-only 3148 in Cable Modem Termination Systems." 3150 OBJECT docsIfQosProfStatus 3151 MIN-ACCESS read-only 3152 DESCRIPTION 3153 "This object is always read-only in Cable Modems. 3154 It is compliant to implement this object as read-only 3155 in Cable Modem Termination Systems." 3157 OBJECT docsIfQosProfMaxTransmitBurst 3158 MIN-ACCESS read-only 3159 DESCRIPTION 3160 "This object is always read-only in Cable Modems. 3161 It is compliant to implement this object as read-only 3162 in Cable Modem Termination Systems." 3164 OBJECT docsIfCmtsCmStatusInetAddressType 3165 SYNTAX InetAddressType { unknown(0), ipv4(1) } 3166 DESCRIPTION 3167 "An implementation is only required to support IPv4 3168 addresses (or no address)." 3170 OBJECT docsIfCmtsCmStatusInetAddress 3171 SYNTAX InetAddress (SIZE(0|4)) 3172 DESCRIPTION 3173 "An implementation is only required to support IPv4 3174 addresses (or no address)." 3176 OBJECT docsIfCmtsServiceAdminStatus 3177 MIN-ACCESS read-only 3178 DESCRIPTION 3179 "It is compliant to implement this object as read-only." 3181 OBJECT docsIfCmtsSyncInterval 3182 MIN-ACCESS read-only 3183 DESCRIPTION 3184 "It is compliant to implement this object as read-only." 3186 OBJECT docsIfCmtsUcdInterval 3187 MIN-ACCESS read-only 3188 DESCRIPTION 3189 "It is compliant to implement this object as read-only." 3191 OBJECT docsIfCmtsInsertInterval 3192 MIN-ACCESS read-only 3193 DESCRIPTION 3194 "It is compliant to implement this object as read-only." 3196 OBJECT docsIfCmtsInvitedRangingAttempts 3197 MIN-ACCESS read-only 3198 DESCRIPTION 3199 "It is compliant to implement this object as read-only." 3201 OBJECT docsIfCmtsQosProfilePermissions 3202 MIN-ACCESS read-only 3203 DESCRIPTION 3204 "It is compliant to implement this object as read-only." 3206 OBJECT docsIfCmtsModType 3207 WRITE-SYNTAX INTEGER { 3208 qpsk (2), 3209 qam16 (3) 3210 } 3211 DESCRIPTION 3212 "Management station may only set 16QAM or QPSK modulation, 3213 but others might be possible based on device configuration." 3215 ::= { docsIfCompliances 1 } 3217 docsIfBasicGroup OBJECT-GROUP 3218 OBJECTS { 3219 docsIfDownChannelId, 3220 docsIfDownChannelFrequency, 3221 docsIfDownChannelWidth, 3222 docsIfDownChannelModulation, 3223 docsIfDownChannelInterleave, 3224 docsIfDownChannelPower, 3225 docsIfDownChannelAnnex, 3226 docsIfUpChannelId, 3227 docsIfUpChannelFrequency, 3228 docsIfUpChannelWidth, 3229 docsIfUpChannelModulationProfile, 3230 docsIfUpChannelSlotSize, 3231 docsIfUpChannelTxTimingOffset, 3232 docsIfUpChannelRangingBackoffStart, 3233 docsIfUpChannelRangingBackoffEnd, 3234 docsIfUpChannelTxBackoffStart, 3235 docsIfUpChannelTxBackoffEnd, 3236 docsIfQosProfPriority, 3237 docsIfQosProfMaxUpBandwidth, 3238 docsIfQosProfGuarUpBandwidth, 3239 docsIfQosProfMaxDownBandwidth, 3240 docsIfQosProfBaselinePrivacy, 3241 docsIfQosProfStatus, 3242 docsIfQosProfMaxTransmitBurst, 3243 docsIfSigQIncludesContention, 3244 docsIfSigQUnerroreds, 3245 docsIfSigQCorrecteds, 3246 docsIfSigQUncorrectables, 3247 docsIfSigQSignalNoise, 3248 docsIfSigQMicroreflections, 3249 docsIfSigQEqualizationData 3250 } 3251 STATUS current 3252 DESCRIPTION 3253 "Group of objects implemented in both Cable Modems and 3254 Cable Modem Termination Systems." 3255 ::= { docsIfGroups 1 } 3257 docsIfCmGroup OBJECT-GROUP 3258 OBJECTS { 3259 docsIfCmCmtsAddress, 3260 docsIfCmCapabilities, 3261 docsIfCmRangingTimeout, 3262 docsIfCmStatusValue, 3263 docsIfCmStatusCode, 3264 docsIfCmStatusTxPower, 3265 docsIfCmStatusResets, 3266 docsIfCmStatusLostSyncs, 3267 docsIfCmStatusInvalidMaps, 3268 docsIfCmStatusInvalidUcds, 3269 docsIfCmStatusInvalidRangingResponses, 3270 docsIfCmStatusInvalidRegistrationResponses, 3271 docsIfCmStatusT1Timeouts, 3272 docsIfCmStatusT2Timeouts, 3273 docsIfCmStatusT3Timeouts, 3274 docsIfCmStatusT4Timeouts, 3275 docsIfCmStatusRangingAborteds, 3276 docsIfCmServiceQosProfile, 3277 docsIfCmServiceTxSlotsImmed, 3278 docsIfCmServiceTxSlotsDed, 3279 docsIfCmServiceTxRetries, 3280 docsIfCmServiceTxExceededs, 3281 docsIfCmServiceRqRetries, 3282 docsIfCmServiceRqExceededs 3283 } 3284 STATUS current 3285 DESCRIPTION 3286 "Group of objects implemented in Cable Modems." 3287 ::= { docsIfGroups 2 } 3289 docsIfCmtsGroup OBJECT-GROUP 3290 OBJECTS { 3291 docsIfCmtsCapabilities, 3292 docsIfCmtsSyncInterval, 3293 docsIfCmtsUcdInterval, 3294 docsIfCmtsMaxServiceIds, 3295 docsIfCmtsInvitedRangingAttempts, 3296 docsIfCmtsInsertInterval, 3297 docsIfCmtsStatusInvalidRangeReqs, 3298 docsIfCmtsStatusRangingAborteds, 3299 docsIfCmtsStatusInvalidRegReqs, 3300 docsIfCmtsStatusFailedRegReqs, 3301 docsIfCmtsStatusInvalidDataReqs, 3302 docsIfCmtsStatusT5Timeouts, 3303 docsIfCmtsCmStatusMacAddress, 3304 docsIfCmtsCmStatusDownChannelIfIndex, 3305 docsIfCmtsCmStatusUpChannelIfIndex, 3306 docsIfCmtsCmStatusRxPower, 3307 docsIfCmtsCmStatusTimingOffset, 3308 docsIfCmtsCmStatusEqualizationData, 3309 docsIfCmtsCmStatusValue, 3310 docsIfCmtsCmStatusUnerroreds, 3311 docsIfCmtsCmStatusCorrecteds, 3312 docsIfCmtsCmStatusUncorrectables, 3313 docsIfCmtsCmStatusSignalNoise, 3314 docsIfCmtsCmStatusMicroreflections, 3315 docsIfCmtsCmStatusInetAddressType, 3316 docsIfCmtsCmStatusInetAddress, 3317 docsIfCmtsServiceAdminStatus, 3318 docsIfCmtsServiceQosProfile, 3319 docsIfCmtsServiceCreateTime, 3320 docsIfCmtsServiceInOctets, 3321 docsIfCmtsServiceInPackets, 3322 docsIfCmtsServiceNewCmStatusIndex, 3323 docsIfCmtsModType, 3324 docsIfCmtsModControl, 3325 docsIfCmtsModPreambleLen, 3326 docsIfCmtsModDifferentialEncoding, 3327 docsIfCmtsModFECErrorCorrection, 3328 docsIfCmtsModFECCodewordLength, 3329 docsIfCmtsModScramblerSeed, 3330 docsIfCmtsModMaxBurstSize, 3331 docsIfCmtsModGuardTimeSize, 3332 docsIfCmtsModLastCodewordShortened, 3333 docsIfCmtsModScrambler, 3334 docsIfCmtsQosProfilePermissions, 3335 docsIfCmtsCmPtr 3336 } 3337 STATUS current 3338 DESCRIPTION 3339 "Group of objects implemented in Cable Modem Termination 3340 Systems." 3341 ::= { docsIfGroups 3 } 3343 docsIfObsoleteGroup OBJECT-GROUP 3344 OBJECTS { 3345 docsIfQosProfMaxTxBurst, 3346 docsIfCmRangingRespTimeout, 3347 docsIfCmtsInsertionInterval, 3348 docsIfCmtsCmStatusIpAddress, 3349 docsIfCmtsServiceCmStatusIndex 3350 } 3351 STATUS obsolete 3352 DESCRIPTION 3353 "Group of objects obsoleted or deprecated." 3354 ::= { docsIfGroups 4 } 3356 END 3358 5. Acknowledgments 3360 This document is a production of the IPCDN Working Group, and is a 3361 revision of RFC 2670, "Radio Frequency (RF) Interface Management 3362 Information Base for MCNS/DOCSIS compliant RF interfaces" [22]. Mike 3363 StJohns and Guenter Roeck served well as the editors of the previous 3364 version of this MIB. 3366 The editor specifically wishes to thank Azlina Ahmad, Minnie Lu, Greg 3367 Nakanishi, Brian Scully, and James Yee for their contributions to 3368 this document. 3370 6. Revision Descriptions 3372 [Note to RFC Editor - this section may be removed upon publication as 3373 an RFC.] This document contains the following revisions over 3374 RFC2670: 3376 o This MIB deprecates and replaces the object 3377 docsIfCmtsCmStatusIpAddress with 3378 docsIfCmtsCmStatusInetAddressType 3379 and docsIfCmtsCmStatusInetAddress, for future compatibility with 3380 IPv6. 3382 o This MIB adds an additional enumeration value to the object 3383 docsIfDownChannelInterleave, and adds the object 3384 docsIfDownChannelAnnex, to support EuroDOCSIS requirements [24]. 3386 o This MIB deprecates and replaces the object 3387 docsIfCmtsServiceCmStatusIndex with 3388 docsIfCmtsServiceNewCmStatusIndex, to fix a mismatch of the 3389 value 3390 range with respect to docsIfCmtsCmStatusIndex. 3392 o This MIB deprecates and replaces the object 3393 docsIfQosProfMaxTxBurst with docsIfQosProfMaxTransmitBurst, to 3394 fix 3395 a mismatch of the units (bytes) and value range (up to 65536 3396 bytes) 3397 with respect to the DOCSIS Maximum Upstream Channel Transmit 3398 Burst 3399 Configuration Setting." 3401 o Minor updates to the description text have been made to a number 3402 of 3403 objects to clarify their meaning. In particular, the BITS 3404 encoding 3405 is clarified in several objects. 3407 o The text in section 3.1.3 clarifies the meaning of "known 3408 modems". 3410 o The compliance statements were updated to reflect European 3411 cable plant requirements. 3413 Items that still need to be resolved or completed: 3415 o This MIB defines docsIfUpChannelTxTimingOffset as an unsigned 3416 integer that measures the round-trip time, whereas DOCSIS 3417 defines 3418 "TX timing offset adjustment" as a signed integer that measures 3419 one-way time from the CM to the CMTS. These values do not have 3421 to 3422 match, but it is unclear whether DOCSIS provides round-trip time 3423 measurement. 3425 o The editor needs to assess the impact on this MIB of using the 3426 RFC 2863 version of the Interfaces MIB, rather than RFC 2233. 3428 o The editor needs to augment the REFERENCEs with DOCSIS 1.0 [16] 3429 and 1.1 [23] sections. Some objects are still missing REFERENCE 3430 clauses. 3432 o The security section needs to be rewritten. 3434 7. References 3436 [1] Harrington, D., Presuhn, R. and B. Wijnen, "An Architecture 3437 for 3438 Describing SNMP Management Frameworks", RFC 2571, April 1999. 3440 [2] Rose, M. and K. McCloghrie, "Structure and Identification of 3441 Management Information for TCP/IP-based Internets", STD 16, 3442 RFC 3443 1155, May 1990. 3445 [3] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 3446 16, 3447 RFC 1212, March 1991. 3449 [4] Rose, M., "A Convention for Defining Traps for use with the 3450 SNMP", RFC 1215, March 1991. 3452 [5] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Structure 3453 of 3454 Management Information for Version 2 (SMIv2)", STD 58, RFC 3455 2578, 3456 April 1999. 3458 [6] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Textual 3459 Conventions for SMIv2", STD 58, RFC 2579, April 1999. 3461 [7] McCloghrie, K., Perkins, D. and J. Schoenwaelder, 3462 "Conformance 3463 Statements for SMIv2", STD 58, RFC 2580, April 1999. 3465 [8] Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple 3466 Management Protocol", STD 15, RFC 1157, May 1990. 3468 [9] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 3469 "Introduction to Community-based SNMPv2", RFC 1901, January 3470 1996. 3472 [10] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 3473 "Transport 3474 Mappings for Version 2 of the Simple Network Management 3475 Protocol 3476 (SNMPv2)", RFC 1906, January 1996. 3478 [11] Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message 3479 Processing and Dispatching for the Simple Network Management 3480 Protocol (SNMP)", RFC 2572, April 1999. 3482 [12] Blumenthal, U. and B. Wijnen, "User-based Security Model 3483 (USM) 3484 for version 3 of the Simple Network Management Protocol 3485 (SNMPv3)", RFC 2574, April 1999. 3487 [13] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 3488 "Protocol 3489 Operations for Version 2 of the Simple Network Management 3490 Protocol (SNMPv2)", RFC 1905, January 1996. 3492 [14] Levi, D., Meyer, P. and B. Stewart, "SNMP Applications", RFC 3493 2573, April 1999. 3495 [15] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access 3496 Control Model (VACM) for the Simple Network Management 3497 Protocol 3498 (SNMP)", RFC 2575, April 1999. 3500 [16] "Data-Over-Cable Service Interface Specifications: Cable 3501 Modem 3502 Radio Frequency Interface Specification SP-RFI-I05-991105", 3503 DOCSIS, November 1999, http://www.cablemodem.com/. 3505 [17] McCloghrie, K. and F. Kastenholz, "The Interfaces Group MIB", 3506 RFC 2863, June 2000. 3508 [18] StJohns, M. , "Cable Device Management Information Base for 3509 DOCSIS Compliant Cable Modems and Cable Modem Termination 3510 Systems", RFC2669, August 1999. 3512 [19] Proakis, John G., "Digital Communications, 3rd Edition", 3513 McGraw-Hill, New York, New York, 1995, ISBN 0-07-051726-6 3515 [20] "Transmission Systems for Interactive Cable Television 3516 Services, 3517 Annex B", J.112, International Telecommunications Union, 3518 March 3519 1998. 3521 [21] Case, J., Mundy, R., Partain, D., and B. Stewart, 3522 "Introduction to 3523 Version 3 of the Internet-standard Network Management 3524 Framework", 3525 RFC 2570, April 1999. 3527 [22] StJohns, M., "Radio Frequency (RF) Interface Management 3528 Information Base for MCNS/DOCSIS compliant RF interfaces", 3529 RFC 2670, August 1999. 3531 [23] "Data-Over-Cable Service Interface Specifications: Cable 3532 Modem 3533 Radio Frequency Interface Specification SP-RFIv1.1-I06- 3534 001215", 3535 DOCSIS, December 2000, http://www.cablemodem.com/. 3537 [24] "Document for the certification of EuroDOCSIS CMs and CMTSs, 3538 Version 3.3", EuroDOCSIS, February 2000. 3540 8. Security Considerations 3542 This MIB relates to a system which will provide metropolitan public 3543 internet access. As such, improper manipulation of the objects 3544 represented by this MIB may result in denial of service to a large 3545 number of end-users. In addition, manipulation of the 3546 docsIfCmServiceQosProfile, docsIfCmtsServerQosProfile, and the 3547 elements of docsIfQosProfileTable may allow an end-user to improve 3548 their service response or decrease other subscriber service response. 3550 This MIB specification contains a number of read-write objects, that 3551 should be protected from unauthorized modification to prevent denial 3552 of service and theft of service attacks: in particular, objects that 3553 reset state machines (ex. docsBpiCmAuthReset), change key lifetimes 3554 (ex. docsBpiCmtsDefaultAuthLifetime), change rekeying grace times 3555 (ex. docsBpiCmtsDefaultAuthGraceTime), and control multicast traffic 3556 (ex. most objects in the docsBpiMulticastControl group). 3558 The desired means to protect these objects from unwarranted access is 3559 to implement the security features as provided by the SNMPv3 3560 framework. Specifically, the use of the User-based Security Model 3561 [12] and the View-based Access Control Model [15] is recommended. 3563 This MIB does not affect confidentiality, authentication or 3564 authorization of services on a cable modem system. For 3565 authentication and authorization, please see the related document 3566 "Cable Device Management Information Base for DOCSIS compliant Cable 3567 Modems and Cable Modem Termination Systems" [18]. For 3568 confidentiality, the working group expects to issue a MIB which 3569 describes the management of the DOCSIS Baseline Privacy mechanism. 3571 9. Intellectual Property 3573 The IETF takes no position regarding the validity or scope of any 3574 intellectual property or other rights that might be claimed to 3575 pertain to the implementation or use of the technology described in 3576 this document or the extent to which any license under such rights 3577 might or might not be available; neither does it represent that it 3578 has made any effort to identify any such rights. Information on the 3579 IETF's procedures with respect to rights in standards-track and 3580 standards-related documentation can be found in BCP-11. Copies of 3581 claims of rights made available for publication and any assurances of 3582 licenses to be made available, or the result of an attempt made to 3583 obtain a general license or permission for the use of such 3584 proprietary rights by implementors or users of this specification can 3585 be obtained from the IETF Secretariat. 3587 The IETF invites any interested party to bring to its attention any 3588 copyrights, patents or patent applications, or other proprietary 3589 rights which may cover technology that may be required to practice 3590 this standard. Please address the information to the IETF Executive 3591 Director. 3593 10. Author's Address 3595 Richard Woundy 3596 Cisco Systems 3597 250 Apollo Drive 3598 Chelmsford, MA 01824 3599 U.S.A. 3601 Phone: +1 978 244 8000 3602 Email: rwoundy@cisco.com 3604 11. Full Copyright Statement 3606 Copyright (C) The Internet Society (2001). All Rights Reserved. 3608 This document and translations of it may be copied and furnished to 3609 others, and derivative works that comment on or otherwise explain it 3610 or assist in its implementation may be prepared, copied, published 3611 and distributed, in whole or in part, without restriction of any 3612 kind, provided that the above copyright notice and this paragraph are 3613 included on all such copies and derivative works. However, this 3614 document itself may not be modified in any way, such as by removing 3615 the copyright notice or references to the Internet Society or other 3616 Internet organizations, except as needed for the purpose of 3617 developing Internet standards in which case the procedures for 3618 copyrights defined in the Internet Standards process must be 3619 followed, or as required to translate it into languages other than 3620 English. 3622 The limited permissions granted above are perpetual and will not be 3623 revoked by the Internet Society or its successors or assigns. 3625 This document and the information contained herein is provided on an 3626 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 3627 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 3628 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 3629 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 3630 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 3632 Acknowledgement 3634 Funding for the RFC Editor function is currently provided by the 3635 Internet Society.