idnits 2.17.1 draft-ietf-ipcdn-docs-rfmibv2-01.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 == The page length should not exceed 58 lines per page, but there was 81 longer pages, the longest (page 3) being 61 lines == It seems as if not all pages are separated by form feeds - found 0 form feeds but 83 pages 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 582 instances of too long lines in the document, the longest one being 19 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. == There are 4 instances of lines with non-RFC6890-compliant IPv4 addresses in the document. If these are example addresses, they should be changed. ** 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 143: '...ng translated MIB MUST be semantically...' RFC 2119 keyword, line 347: '... The ifStackTable [17] MUST be implemented to identify relationships among...' RFC 2119 keyword, line 1621: '... MUST NOT be changed w...' RFC 2119 keyword, line 1635: '... MUST NOT be changed w...' RFC 2119 keyword, line 1649: '... MUST NOT be changed w...' (5 more instances...) Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the RFC 3978 Section 5.4 Copyright Line does not match the current year == Line 495 has weird spacing: '...astPkts inter...' == Line 554 has weird spacing: '...astPkts inte...' == Line 662 has weird spacing: '...astPkts upst...' == Line 762 has weird spacing: '...astPkts inter...' == Line 830 has weird spacing: '...astPkts inte...' == (2 more instances...) -- The document seems to lack a disclaimer for pre-RFC5378 work, but may have content which was first submitted before 10 November 2008. If you have contacted all the original authors and they are all willing to grant the BCP78 rights to the IETF Trust, then this is fine, and you can ignore this comment. If not, you may need to add the pre-RFC5378 disclaimer. (See the Legal Provisions document at https://trustee.ietf.org/license-info for more information.) -- The document date (November 2001) is 8199 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Unused Reference: '16' is defined on line 3995, but no explicit reference was found in the text == Unused Reference: '18' is defined on line 4002, but no explicit reference was found in the text == Unused Reference: '23' is defined on line 4021, but no explicit reference was found in the text == Unused Reference: '24' is defined on line 4025, but no explicit reference was found in the text == Unused Reference: '27' is defined on line 4036, but no explicit reference was found in the text ** 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' -- Possible downref: Non-RFC (?) normative reference: ref. '25' -- Possible downref: Non-RFC (?) normative reference: ref. '26' ** Downref: Normative reference to an Informational RFC: RFC 3083 (ref. '27') -- Possible downref: Non-RFC (?) normative reference: ref. '28' Summary: 20 errors (**), 0 flaws (~~), 16 warnings (==), 10 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 Internet Draft Aviv Goren/David Raftus 3 draft-ietf-ipcdn-docs-rfmibv2-01.txt Terayon/Imedia 4 Expires: May 2002 November 2001 5 Obsoletes: RFC2670 7 Radio Frequency (RF) Interface Management Information Base 8 for DOCSIS 2.0 compliant RF interfaces 10 Status of this Memo 12 This document is an Internet-Draft and is in full conformance with 13 all provisions of Section 10 of RFC2026. 15 Internet-Drafts are working documents of the Internet Engineering 16 Task Force (IETF), its areas, and its working groups. Note that 17 other groups may also distribute working documents as Internet- 18 Drafts. 20 Internet-Drafts are draft documents valid for a maximum of six months 21 and may be updated, replaced, or obsoleted by other documents at any 22 time. It is inappropriate to use Internet-Drafts as reference 23 material or to cite them other than as "work in progress." 25 The list of current Internet-Drafts can be accessed at 26 http://www.ietf.org/ietf/1id-abstracts.txt 28 The list of Internet-Draft Shadow Directories can be accessed at 29 http://www.ietf.org/shadow.html. 31 Copyright Notice 33 Copyright (C) The Internet Society (2001). All Rights Reserved. 35 Abstract 37 This memo is a draft revision of the standards track RFC-2670. 38 Please see "Section 9 Changes from RFC2670" for a description of modifications. 39 This document or its successor will obsolete RFC-2670 when 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 Table of Contents 52 1 The SNMP Management Framework ................................... 3 53 2 Glossary ........................................................ 4 54 2.1 CATV .......................................................... 4 55 2.2 Channel ....................................................... 4 56 2.3 CM ............................................................ 4 57 2.4 CMTS .......................................................... 4 58 2.5 Codeword ...................................................... 4 59 2.6 Data Packet ................................................... 4 60 2.7 dBmV .......................................................... 4 61 2.8 DOCSIS ........................................................ 5 62 2.9 Downstream .................................................... 5 63 2.10 Head-end ..................................................... 5 64 2.11 MAC Packet ................................................... 5 65 2.12 MCNS ......................................................... 5 66 2.13 Mini-slot .................................................... 5 67 2.14 QPSK ......................................................... 5 68 2.15 QAM .......................................................... 5 69 2.16 RF ........................................................... 5 70 2.17 Symbol-times ................................................. 5 71 2.18 Upstream ..................................................... 6 72 3 Overview ........................................................ 6 73 3.1 Structure of the MIB .......................................... 6 74 3.1.1 docsIfBaseObjects ........................................... 6 75 3.1.2 docsIfCmObjects ............................................. 7 76 3.1.3 docsIfCmtsObjects ........................................... 7 77 3.2 Relationship to the Interfaces MIB ............................ 7 78 3.2.1 Layering Model .............................................. 7 79 3.2.2 Virtual Circuits ............................................ 8 80 3.2.3 ifTestTable ................................................. 9 81 3.2.4 ifRcvAddressTable ........................................... 9 82 3.2.5 ifEntry ..................................................... 9 83 3.2.5.1 ifEntry for Downstream interfaces ......................... 9 84 3.2.5.1.1 ifEntry for Downstream interfaces in Cable Modem 85 Termination Systems .......................................... 9 86 3.2.5.1.2 ifEntry for Downstream interfaces in Cable Modems ...... 11 87 3.2.5.2 ifEntry for Upstream interfaces .......................... 12 88 3.2.5.2.1 ifEntry for Upstream interfaces in Cable Modem 89 Termination Systems ......................................... 12 90 3.2.5.2.2 ifEntry for Upstream interfaces in Cable Modems ........ 14 91 3.2.5.3 ifEntry for the MAC Layer ................................ 15 92 4 Definitions .................................................... 18 93 5 Acknowledgments ................................................ 73 94 6 Revision Descriptions ...........................................73 95 7 References ..................................................... 73 96 8 Security Considerations ........................................ 75 97 9 Changes from RFC2670 ........................................... 75 98 10 Intellectual Property ..........................................76 99 11 Author's Address .............................................. 76 100 12 Full Copyright Statement ...................................... 76 102 1. The SNMP Management Framework 104 The SNMP Management Framework presently consists of five major 105 components: 107 o An overall architecture, described in RFC 2571 [1]. 109 o Mechanisms for describing and naming objects and events for the 110 purpose of management. The first version of this Structure of 111 Management Information (SMI) is called SMIv1 and described in STD 112 16, RFC 1155 [2], STD 16, RFC 1212 [3] and RFC 1215 [4]. The 113 second version, called SMIv2, is described in STD 58, RFC 2578 114 [5], STD 58, RFC 2579 [6] and STD 58, RFC 2580 [7]. 116 o Message protocols for transferring management information. The 117 first version of the SNMP message protocol is called SNMPv1 and 118 described in RFC 1157 [8]. A second version of the SNMP message 119 protocol, which is not an Internet standards track protocol, is 120 called SNMPv2c and described in RFC 1901 [9] and RFC 1906 [10]. 121 The third version of the message protocol is called SNMPv3 and 122 described in RFC 1906 [10], RFC 2572 [11] and RFC 2574 [12]. 124 o Protocol operations for accessing management information. The 125 first set of protocol operations and associated PDU formats is 126 described in STD 15, RFC 1157 [8]. A second set of protocol 127 operations and associated PDU formats is described in RFC 1905 128 [13]. 130 o A set of fundamental applications described in RFC 2573 [14] and 131 the view-based access control mechanism described in RFC 2575 132 [15]. 134 A more detailed introduction to the current SNMP Management Framework 135 can be found in RFC 2570 [21]. 137 Managed objects are accessed via a virtual information store, termed 138 the Management Information Base or MIB. Objects in the MIB are 139 defined using the mechanisms defined in the SMI. 141 This memo specifies a MIB module that is compliant to the SMIv2. A 142 MIB conforming to the SMIv1 can be produced through the appropriate 143 translations. The resulting translated MIB MUST be semantically 144 equivalent, except where objects or events are omitted because no 145 translation is possible (use of Counter64). Some machine readable 146 information in SMIv2 will be converted into textual descriptions in 147 SMIv1 during the translation process. However, this loss of machine 148 readable information is not considered to change the semantics of the 149 MIB. 151 2. Glossary 153 The terms in this document are derived either from normal cable 154 system usage, or from the documents associated with the Data Over 155 Cable Service Interface Specification process. 157 2.1. CATV 159 Originally "Community Antenna Television", now used to refer to any 160 cable or hybrid fiber and cable system used to deliver video signals 161 to a community. 163 2.2. Channel 165 A specific frequency allocation with an RF medium, specified by 166 channel width in Hertz (cycles per second) and by center frequency. 167 Within the US Cable Systems, upstream channels are generally 168 allocated from the 5-42MHz range while down stream channels are 169 generally allocated from the 50-750MHz range depending on the 170 capabilities of the given system. The typical broadcast channel 171 width in the US is 6MHz. Upstream channel widths for DOCSIS vary. 173 For European cable systems, upstream channels vary by country. The 174 upper edge of upstream channel allocations vary between 25 MHz to 65 175 MHz, and the lower edge of downstream channel allocations vary 176 between 47 MHz and 87.5 MHz. The typical broadcast channel width in 177 Europe is 8MHz. The actual parameters are of concern to systems 178 deploying EuroDOCSIS technology. 180 2.3. CM Cable Modem. 182 A CM acts as a "slave" station in a DOCSIS compliant cable data 183 system. 185 2.4. CMTS Cable Modem Termination System. 187 A generic term covering a cable bridge or cable router in a head-end. 188 A CMTS acts as the master station in a DOCSIS compliant cable data 189 system. It is the only station that transmits downstream, and it 190 controls the scheduling of upstream transmissions by its associated 191 CMs. 193 2.5. Codeword 195 See [25]. A characteristic of the Forward Error Correction scheme used 196 above the RF media layer. 198 2.6. Data Packet 200 The payload portion of the MAC Packet. 202 2.7. dBmV 204 Decibel relative to one milli-volt. A measure of RF power. 206 2.8. DOCSIS 208 "Data Over Cable Service Interface Specification". A term referring to the 209 ITU-T J.112 Annex B standard for cable modem systems [20]. 211 2.9. Downstream 213 The direction from the head-end towards the subscriber. 215 2.10. Head-end 217 The origination point in most cable systems of the subscriber video 218 signals. 220 2.11. MAC Packet 222 A DOCSIS PDU. 224 2.12. MCNS 226 "Multimedia Cable Network System". Generally replaced in usage by 227 DOCSIS. 229 2.13. Mini-slot 231 See [25]. In general, an interval of time which is allocated by the 232 CMTS to a given CM for that CM to transmit in an upstream direction. 234 2.14. QPSK Quadrature Phase Shift Keying. 236 A particular modulation scheme on an RF medium. See [19]. 238 2.15. QAM Quadrature Amplitude Modulation. 240 A particular modulation scheme on RF medium. Usually expressed 241 with a number indicating the size of the modulation constellation 242 (e.g. 16 QAM). See [19], or any other book on digital communications 243 over RF for a complete explanation of this. 245 2.16. RF 247 Radio Frequency. 249 2.17. Symbol-times 251 See [25]. A characteristic of the RF modulation scheme. 253 2.18. Upstream 255 The direction from the subscriber towards the head-end. 257 3. Overview 259 This MIB provides a set of objects required for the management of 260 MCNS/DOCSIS compliant Cable Modem (CM) and Cable Modem Termination 261 System (CMTS) RF interfaces. The specification is derived in part 262 from the parameters and protocols described in DOCSIS Radio Frequency 263 Interface Specification [25]. 265 3.1. Structure of the MIB 267 This MIB is structured as three groups: 269 o Management information pertinent to both Cable Modems (CM) and 270 Cable Modem Termination Systems (CMTS) (docsIfBaseObjects). 272 o Management information pertinent to Cable Modems only 273 (docsIfCmObjects). 275 o Management information pertinent to Cable Modem Termination 276 Systems only (docsIfCmtsObjects). 278 Tables within each of these groups group objects functionally - e.g. 279 Quality of Service, Channel characteristics, MAC layer management, 280 etc. Rows created automatically (e.g. by the device according to the 281 hardware configuration) may and generally will have a mixture of 282 configuration and status objects within them. Rows that are meant to 283 be created by the management station are generally restricted to 284 configuration (read-create) objects. 286 3.1.1. docsIfBaseObjects 288 docsIfDownstreamChannelTable - This table describes the active 289 downstream channels for a CMTS and the received downstream channel 290 for a CM. 292 docsIfUpstreamChannelTable - This table describes the active upstream 293 channels for a CMTS and the current upstream transmission channel 294 for a CM. 296 docsIfQosProfileTable - This table describes the valid Quality of 297 Service profiles for the cable data system. 299 docsIfSignalQualityTable - This table is used to monitor RF signal 300 quality characteristics of received signals. 302 docsIfDocsisBaseCapability - This object is used to indicate the highest level 303 of DOCSIS version a cable device can support. 305 3.1.2. docsIfCmObjects 307 docsIfCmMacTable - This table is used to monitor the DOCSIS MAC 308 interface and can be considered an extension to the ifEntry. 310 docsIfCmServiceTable - This table describes the upstream service 311 queues available at this CM. There is a comparable table at the 312 CMTS, docsIfCmtsServiceEntry, which describes the service queues from 313 the point of view of the CMTS. 315 3.1.3. docsIfCmtsObjects 317 docsIfCmtsStatusTable - This table provides a set of aggregated 318 counters which roll-up values and events that occur on the underlying 319 sub-interfaces. 321 docsIfCmtsCmStatusTable - This table is used to hold information 322 about known (i.e. ranging, registered, and/or previously online) 323 cable modems on the system serviced by this CMTS. 325 docsIfCmtsServiceEntry - This table provides access to the 326 information related to upstream service queues. 328 docsIfCmtsModulationTable - This table allows control over the 329 modulation profiles for RF channels associated with this CMTS. 331 docsIfCmtsMacToCmTable - This table allows fast access into the 332 docsIfCmtsCmTable via a MAC address (of the CM) interface. 334 3.2. Relationship to the Interfaces MIB 336 This section clarifies the relationship of this MIB to the Interfaces 337 MIB [17]. Several areas of correlation are addressed in the 338 following subsections. The implementer is referred to the Interfaces 339 MIB document in order to understand the general intent of these 340 areas. 342 3.2.1. Layering Model 344 An instance of ifEntry exists for each RF Downstream interface, for 345 each RF Upstream interface, for each Upstream logical Channel and for 346 each RF MAC layer. 347 The ifStackTable [17] MUST be implemented to identify relationships among 348 sub-interfaces. 350 The following example illustrates a CMTS MAC interface with one downstream 351 and two upstream interfaces. 353 | <== to network layer 354 +------------------ --+-------------------------------+ 355 | RF MAC | 356 +--+------------------+------------------------+------+ 357 | | | 358 +-------+-----+ +------+------+ +------+------+ 359 | Downstream1 | | Upstream1 | | Upstream2 | 360 | | | | | | 361 +-------------+ ++-----------++ ++-----------++ 362 | | | | 363 +----+----+ +----+----+ +----+----+ +----+----+ 364 | Ch-1 | | Ch-2 | | Ch-1 | | Ch-2 | 365 |(A/TDMA) | |(S-CDMA) | |(A/TDMA) | |(S-CDMA) | 366 +---------+ +---------+ +---------+ +---------+ 368 As can be seen from this example, the RF MAC interface is layered on 369 top of the downstream and upstream interfaces, and the RF Upstream interface 370 is layered on top of an Upstream Logical Channels. 372 In this example, the assignment of index values could be as follows: 374 ifIndex ifType Description 376 2 docsCableMaclayer(127) CATV MAC Layer 377 3 docsCableDownstream(128) CATV Downstream interface 378 4 docsCableUpstream(129) CATV Upstream interface 379 5 docsCableUpstream(129) CATV Upstream interface 380 6 docsCableUpstreamChannel(205) CATV Upstream Channel 381 7 docsCableUpstreamChannel(205) CATV Upstream Channel 382 8 docsCableUpstreamChannel(205) CATV Upstream Channel 383 9 docsCableUpstreamChannel(205) CATV Upstream Channel 385 The corresponding ifStack entries would then be: 387 | IfStackHigherLayer | ifStackLowerLayer | 388 | 0 | 2 | 389 | 2 | 3 | 390 | 2 | 4 | 391 | 2 | 5 | 392 | 4 | 6 | 393 | 4 | 7 | 394 | 5 | 8 | 395 | 5 | 9 | 396 | 3 | 0 | 397 | 6 | 0 | 398 | 7 | 0 | 399 | 8 | 0 | 400 | 9 | 0 | 402 The same interface model can also be used in Telephony or Telco 403 Return systems. A pure Telco Return system (Cable Modem as well as 404 Cable Modem Termination System) would not have upstream, but only 405 downstream cable channels. Systems supporting both Telco Return and 406 cable upstream channels can use the above model without modification. 408 Telco Return Upstream channel(s) are handled by the appropriate MIBs, 409 such as PPP or Modem MIBs. 411 3.2.2. Virtual Circuits 413 This medium does not support virtual circuits and this area is not 414 applicable to this MIB. 416 3.2.3. ifTestTable 418 The ifTestTable is optional for Docsis CM/CMTS implementations, but is 419 not specifically influenced by the RF mib. 421 3.2.4. ifRcvAddressTable 423 The ifRcvAddressTable is optional for Docsis CM/CMTS implementations, but is 424 not specifically influenced by the RF mib. 426 3.2.5. ifEntry 428 This section documents only the differences from the requirements 429 specified in the Interfaces MIB. See that MIB for columns omitted 430 from the descriptions below. 432 3.2.5.1. ifEntry for Downstream interfaces 434 The ifEntry for Downstream interfaces supports the 435 ifGeneralInformationGroup and the ifPacketGroup of the Interfaces 436 MIB. This is an output only interface at the CMTS and all input 437 status counters - ifIn* - will return zero. This is an input only 438 interface at the CM and all output status counters - ifOut* - will 439 return zero. 441 3.2.5.1.1. ifEntry for Downstream interfaces in Cable Modem Termination 442 Systems 444 ifTable Comments 445 ============== =========================================== 446 ifIndex Each RF Cable Downstream interface is represented 447 by an ifEntry. 449 ifType The IANA value of docsCableDownstream(128). 451 ifSpeed Return the speed of this downstream channel. 452 The returned value is the raw bandwidth in bits/s 453 of this interface. This is the symbol rate 454 multiplied with the number of bits per symbol. 456 ifHighSpeed Return the speed of this downstream channel. 457 The returned value is the raw bandwidth in megabits/s 458 of this interface. This is the symbol rate 459 multiplied with the number of bits per symbol. 461 ifPhysAddress Return an empty string. 463 ifAdminStatus The administrative status of this interface. 465 ifOperStatus The current operational status of this interface. 467 ifMtu The size of the largest frame which can be 468 sent on this interface, specified in octets. 469 The value includes the length of the MAC header. 471 ifInOctets Return zero. 472 ifHCInOctets 474 ifInUcastPkts Return zero. 475 ifHCInUcastPkts 477 ifInMulticastPkts Return zero. 478 ifHCInMulticastPkts 480 ifInBroadcastPkts Return zero. 481 ifHCInBroadcastPkts 483 ifInDiscards Return zero. 485 ifInErrors Return zero. 487 ifInUnknownProtos Return zero. 489 ifOutOctets The total number of octets transmitted on this 490 ifHCOutOctets interface. This includes MAC packets as well as 491 data packets, and includes the length of the MAC 492 header. 494 ifOutUcastPkts The number of Unicast packets transmitted on this 495 ifHCOutUcastPkts interface. This includes MAC packets as well as 496 data packets. 498 ifOutMulticastPkts 499 ifHCOutMulticastPkts 500 Return the number of Multicast packets transmitted 501 on this interface. 502 This includes MAC packets as well as data packets. 504 ifOutBroadcastPkts 505 ifHCOutBroadcastPkts 506 Return the number of broadcast packets transmitted 507 on this interface. 508 This includes MAC packets as well as data packets. 510 ifOutDiscards The total number of outbound packets which 511 were discarded. Possible reasons are: 512 buffer shortage. 514 ifOutErrors The number of packets which could not be 515 transmitted due to errors. 517 ifPromiscuousMode Return false. 519 3.2.5.1.2. ifEntry for Downstream interfaces in Cable Modems 521 ifTable Comments 522 ============== =========================================== 523 ifIndex Each RF Cable Downstream interface is represented 524 by an ifEntry. 526 ifType The IANA value of docsCableDownstream(128). 528 ifSpeed Return the speed of this downstream channel. 529 The returned value the raw bandwidth in bits/s 530 of this interface. This is the symbol rate 531 multiplied with the number of bits per symbol. 533 ifHighSpeed Return the speed of this downstream channel. 534 The returned value the raw bandwidth in megabits/s 535 of this interface. This is the symbol rate 536 multiplied with the number of bits per symbol. 538 ifPhysAddress Return an empty string. 540 ifAdminStatus The administrative status of this interface. 542 ifOperStatus The current operational status of this interface. 544 ifMtu The size of the largest frame which can be 545 received from this interface, specified in octets. 546 The value includes the length of the MAC header. 548 ifInOctets The total number of octets received on this 549 ifHCInOctets interface. This includes data packets as well as 550 MAC layer packets, and includes the length of the 551 MAC header. 553 ifInUcastPkts The number of Unicast packets received on this 554 ifHCInUcastPkts interface. This includes data packets as well as 555 MAC layer packets. 557 ifInMulticastPkts 558 ifHCInMulticastPkts 559 Return the number of Multicast packets received 560 on this interface. This includes data packets as 561 well as MAC layer packets. 563 ifInBroadcastPkts 564 ifHCInBroadcastPkts 565 Return the number of Broadcast packets received 566 on this interface. This includes data packets 567 as well as MAC layer packets. 569 ifInDiscards The total number of received packets that have 570 been discarded. 571 The possible reasons are: buffer shortage. 573 ifInErrors The number of inbound packets that contained 574 errors preventing them from being deliverable 575 to higher layers. 576 Possible reasons are: MAC FCS error. 578 ifInUnknownProtos The number of frames with an unknown packet type. 579 These are MAC frames with an unknown packet type. 581 ifOutOctets Return zero. 582 ifHCOutOctets 584 ifOutUcastPkts Return zero. 585 ifHCOutUcastPkts 587 ifOutMulticastPkts 588 ifHCOutMulticastPkts 589 Return zero. 591 ifOutBroadcastPkts 592 ifHCOutBroadcastPkts 593 Return zero. 595 ifOutDiscards Return zero. 597 ifOutErrors Return zero. 599 ifPromiscuousMode Refer to the Interfaces MIB. 601 3.2.5.2. ifEntry for Upstream interfaces 603 Each supported interface of the type docsCableUpstream(129) must have a 604 corresponding ifEntry. 605 The ifEntry for Upstream interfaces supports the 606 ifGeneralInformationGroup and the ifPacketGroup of the Interfaces 607 MIB. This is an input only interface at the CMTS and all output 608 status counters - ifOut* - will return zero. This is an output only 609 interface at the CM and all input status counters - ifIn* - will 610 return zero. 612 3.2.5.2.1. ifEntry for Upstream interfaces in Cable Modem Termination 613 Systems 615 ifTable Comments 616 ============== =========================================== 617 ifIndex Each RF Cable Upstream interface is represented 618 by an ifEntry. 620 ifType The IANA value of docsCableUpstream (129). 622 ifSpeed Return the maximum channel throughput (not payload 623 throughput) supported by the interface. 624 The maximum throughput is calculated for the case where 625 upstream channels are configured to maximize interface 626 throughput. 628 ifHighSpeed Return the maximum channel throughput (not payload 629 throughput) supported by the interface. 630 The maximum throughput is calculated for the case where 631 upstream channels are configured to maximize interface 632 throughput. Units for this object are (1/1 000 000) * 633 IfSpeed. 635 ifPhysAddress Return an empty string. 637 ifAdminStatus The administrative status of this interface. 638 This reflect the total status of all the channels 639 under this interface. So if at least one channel has a 640 physical connection this interface has connection. 641 Any SNMP SET on this interface will cause a SET to all the 642 channels under this interface. 644 ifOperStatus The current operational status of this interface. 645 This reflects the total status of all the channels 646 under this interface. So if at least one channel has a 647 physical connection this interface has connection. 649 ifMtu The size of the largest frame which can be 650 transmitted on this interface, specified in octets. 651 The value includes the length of the MAC header. 652 This is the maximum of all the ifMtu of all the channels 653 under this interface. 655 ifInOctets The total (sum) number of octets received on all 656 ifHCInOctets the Upstream channels under this 657 interface. This includes data packets as well as 658 MAC layer packets, and includes the length of the 659 MAC header. 661 ifInUcastPkts The total number of Unicast packets received on all the 662 ifHCInUcastPkts upstream channels under this 663 interface. This includes data packets as well as 664 MAC layer packets. 666 ifInMulticastPkts 667 ifHCInMulticastPkts 668 Return the total number of Multicast packets received 669 on all the Upstream channels under this interface. 670 This includes data packets as 671 well as MAC layer packets. 673 ifInBroadcastPkts 674 ifHCInBroadcastPkts 675 Return the total number of Broadcast packets received 676 on all the Upstream channels under this interface. 677 This includes data packets 678 as well as MAC layer packets. 680 ifInDiscards The total number of received packets, which have 681 been discarded on all the Upstream channels under this 682 interface. 683 The possible reasons are: buffer shortage. 685 ifInErrors The total number of inbound packets that contained 686 errors preventing them from being deliverable 687 to higher layers. 688 Possible reasons are: MAC FCS error. 690 ifInUnknownProtos The total number of frames with an unknown packet type. 691 These are MAC frames with an unknown packet type. 693 ifOutOctets Return zero. 694 ifHCOutOctets 696 ifOutUcastPkts Return zero. 697 ifHCOutOctets 699 ifOutMulticastPkts 700 ifHCOutMulticastPkts 701 Return zero. 703 ifOutBroadcastPkts 704 ifHCOutBroadcastPkts 705 Return zero. 707 ifOutDiscards Return zero. 709 ifOutErrors Return zero. 711 3.2.5.2.2. ifEntry for Upstream interfaces in Cable Modems 713 ifTable Comments 714 ============== =========================================== 715 ifIndex Each RF Cable Upstream interface is represented 716 by an ifEntry. 718 ifType The IANA value of docsCableUpstream (129). 720 ifSpeed Return the speed of this upstream interface. 721 The returned value is the raw bandwidth 722 in bits/s of this interface. 724 ifHighSpeed Return the speed of this upstream interface. 725 The returned value is the raw bandwidth 726 in megabits/s of this interface. 728 ifPhysAddress Return an empty string. 730 ifAdminStatus The administrative status of this interface. 732 ifOperStatus The current operational status of this interface. 734 ifMtu The size of the largest frame which can be 735 transmitted on this interface, specified in octets. 736 The value includes the length of the MAC header. 738 ifInOctets Return zero. 739 ifHCInOctets 741 ifInUcastPkts Return zero. 742 ifHCInUcastPkts 744 ifInMulticastPkts Return zero. 745 ifHCInMulticastPkts 747 ifInBroadcastPkts Return zero. 748 ifHCInBroadcastPkts 750 ifInDiscards Return zero. 752 ifInErrors Return zero. 754 ifInUnknownProtos Return zero. 756 ifOutOctets The total number of octets transmitted on this 757 ifHCOutOctets interface. This includes MAC packets as well as 758 data packets, and includes the length of the MAC 759 header. 761 ifOutUcastPkts The number of Unicast packets transmitted on this 762 ifHCOutUcastPkts interface. This includes MAC packets as well as 763 data packets. 765 ifOutMulticastPkts 766 ifHCOutMulticastPkts 767 Return the number of Multicast packets transmitted 768 on this interface. 769 This includes MAC packets as well as data packets. 771 ifOutBroadcastPkts 772 ifHCOutBroadcastPkts 773 Return the number of broadcast packets transmitted 774 on this interface. 775 This includes MAC packets as well as data packets. 777 ifOutDiscards The total number of outbound packets which 778 were discarded. Possible reasons are: 779 buffer shortage. 781 ifOutErrors The number of packets which could not be 782 transmitted due to errors. 784 ifPromiscuousMode Return false. 786 3.2.5.3. ifEntry for Upstream channels 788 Each supported channel of the type docsCableUpstreamChannel(205) must have a 789 corresponding ifEntry. 790 The ifEntry for Upstream channels supports the 791 ifGeneralInformationGroup and the ifPacketGroup of the Interfaces 792 MIB. This is an input only interface at the CMTS and all output 793 status counters - ifOut* - will return zero. At the time of this mib creation, 794 DOCSIS CMs are not required to support logical upstream channels. 796 3.2.5.3.1. ifEntry for Upstream Channels in Cable Modem Termination 797 Systems 799 ifTable Comments 800 ============== =========================================== 801 ifIndex Each RF Cable Upstream channel is represented 802 by an ifEntry. 804 ifType The IANA value of docsCableUpstreamChannel (205). 806 ifSpeed Return the speed of this upstream channel. 807 The returned value is the raw bandwidth 808 in bits/s of this channel. 810 ifHighSpeed Return the speed of this upstream channel. 811 The returned value is the raw bandwidth 812 in megabits/s of this channel. 814 ifPhysAddress Return an empty string. 816 ifAdminStatus The administrative status of this interface. 818 ifOperStatus The current operational status of this interface. 820 ifMtu The size of the largest frame which can be 821 received on this interface, specified in octets. 822 The value includes the length of the MAC header. 824 ifInOctets The total number of octets received on this 825 interface. This includes data packets as well as 826 MAC layer packets, and includes the length of the 827 MAC header. 829 ifInUcastPkts The number of Unicast packets received on this 830 ifHCInUcastPkts interface. This includes data packets as well as 831 MAC layer packets. 833 ifInMulticastPkts 834 ifHCInMulticastPkts 835 Return the number of Multicast packets received 836 on this interface. This includes data packets as 837 well as MAC layer packets. 839 ifInBroadcastPkts 840 ifHCInBroadcastPkts 841 Return the number of Broadcast packets received 842 on this interface. This includes data packets 843 as well as MAC layer packets. 845 ifInDiscards The total number of received packets that have 846 been discarded. 847 The possible reasons are: buffer shortage. 849 ifInErrors The number of inbound packets that contained 850 errors preventing them from being deliverable 851 to higher layers. 852 Possible reasons are: MAC FCS error. 854 ifInUnknownProtos The number of frames with an unknown packet type. 855 These are MAC frames with an unknown packet type. 857 ifOutOctets Return zero. 858 ifHCOutOctets 860 ifOutUcastPkts Return zero. 862 ifHCOutUcastPkts 864 ifOutMulticastPkts 865 ifHCOutMulticastPkts 866 Return zero. 868 ifOutBroadcastPkts 869 ifHCOutBroadcastPkts 870 Return zero. 872 ifOutDiscards Return zero. 874 ifOutErrors Return zero. 876 3.2.5.4. ifEntry for the MAC Layer 878 The ifEntry for the MAC Layer supports the ifGeneralInformationGroup 879 and the ifPacketGroup of the Interfaces MIB. This interface provides 880 an aggregate view of status for the lower level Downstream and 881 Upstream interfaces. 883 ifTable Comments 884 ============== =========================================== 885 ifIndex Each RF Cable MAC layer entity is represented 886 by an ifEntry. 888 ifType The IANA value of docsCableMaclayer(127). 890 ifSpeed Return zero. 892 ifPhysAddress Return the physical address of this interface. 894 ifAdminStatus The administrative status of this interface. 896 ifOperStatus The current operational status of the MAC 897 layer interface. 899 ifHighSpeed Return zero. 901 ifMtu Return 1500. 903 ifInOctets The total number of data octets received on this 904 ifHCInOctets interface, targeted for upper protocol layers. 906 ifInUcastPkts The number of Unicast packets received on this 907 ifHCInUcastPkts interface, targeted for upper protocol layers. 909 ifInMulticastPkts 910 ifHCInMulticastPkts 911 Return the number of Multicast packets received 912 on this interface, targeted for upper protocol 913 layers. 915 ifInBroadcastPkts 916 ifHCInBroadcastPkts 917 Return the number of Broadcast packets received 918 on this interface, targeted for upper protocol 919 layers. 921 ifInDiscards The total number of received packets that have 922 been discarded. 923 The possible reasons are: buffer shortage. 925 ifInErrors The number of inbound packets that contained 926 errors preventing them from being deliverable 927 to higher layers. 928 Possible reasons are: data packet FCS error, 929 invalid MAC header. 931 ifInUnknownProtos The number of frames with an unknown packet type. 932 This is the number of data packets targeted for 933 upper protocol layers with an unknown packet type. 935 ifOutOctets The total number of octets, received from upper 936 ifHCOutOctets protocol layers and transmitted on this interface. 938 ifOutUcastPkts The number of Unicast packets, received from upper 939 ifHCOutUcastPkts protocol layers and transmitted on this interface. 941 ifOutMulticastPkts 942 ifHCOutMulticastPkts 943 Return the number of Multicast packets received 944 from upper protocol layers and transmitted on this 945 interface. 947 ifOutBroadcastPkts 948 ifHCOutBroadcastPkts 949 Return the number of broadcast packets received 950 from upper protocol layers and transmitted on this 951 interface. 953 ifOutDiscards The total number of outbound packets which 954 were discarded. Possible reasons are: 955 buffer shortage. 957 ifOutErrors The number of packets which could not be 958 transmitted due to errors. 960 ifPromiscuousMode Refer to the Interfaces MIB. 962 4. Definitions 964 DOCS-IF-MIB DEFINITIONS ::= BEGIN 966 IMPORTS 967 MODULE-IDENTITY, 968 OBJECT-TYPE, 969 -- do not import BITS, 970 Unsigned32, 971 Integer32, 972 Counter32, 973 Counter64, 974 TimeTicks, 975 IpAddress, 976 transmission 977 FROM SNMPv2-SMI 978 TEXTUAL-CONVENTION, 979 MacAddress, 980 RowStatus, 981 TruthValue, 982 TimeInterval, 983 TimeStamp 984 FROM SNMPv2-TC 985 OBJECT-GROUP, 987 MODULE-COMPLIANCE 988 FROM SNMPv2-CONF 989 ifIndex, InterfaceIndexOrZero 990 FROM IF-MIB 991 InetAddressType, 992 InetAddress 993 FROM INET-ADDRESS-MIB; 995 docsIfMib MODULE-IDENTITY 996 LAST-UPDATED "0111200000Z" -- November 20, 2001 997 ORGANIZATION "IETF IPCDN Working Group" 998 CONTACT-INFO 999 " Aviv Goren 1000 Postal: Terayon 1001 2952 Bunker Hill Lane 1002 Santa Clara, CA 1003 U.S.A. 1004 Phone: +1 408 727 4400 1005 E-mail: aviv.goren@terayon.com 1007 David Raftus 1008 Postal: Imedia Semiconductor 1009 340 Terry Fox Drive, Suite 202 1010 Ottawa Ontario 1011 Canada 1013 Phone: +1 613 592 1052 1014 E-mail: david.raftus@imedia.com 1016 IETF IPCDN Working Group 1017 General Discussion: ipcdn@ietf.org 1018 Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn 1019 Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn 1020 Co-chairs: Richard Woundy, rwoundy@cisco.com 1021 Andrew Valentine, a.valentine@eu.hns.com" 1022 DESCRIPTION 1023 "This is the MIB Module for DOCSIS 2.0 compliant Radio 1024 Frequency (RF) interfaces in Cable Modems (CM) and 1025 Cable Modem Termination Systems (CMTS)." 1026 REVISION "0111200000Z" 1027 DESCRIPTION 1028 "Modified by Aviv Goren and David Raftus to accommodate 1029 Docsis 2.0 Advanced Phy capabilities, as well as to 1030 incorporate objects from the docsIfExt mib. " 1031 REVISION "0102230000Z" 1032 DESCRIPTION 1033 "Modified by Rich Woundy to use IPv6-friendly 1034 address objects, to accommodate EuroDOCSIS, and 1035 to correct the SYNTAX of various objects." 1036 REVISION "9908190000Z" 1037 DESCRIPTION 1038 "Initial Version, published as RFC 2670. 1039 Modified by Mike StJohns to fix problems identified by 1040 the first pass of the MIB doctor. Of special note, 1041 docsIfRangingResp and docsIfCmtsInsertionInterval were 1042 obsoleted and replaced by other objects with the same 1043 functionality, but more appropriate SYNTAX." 1044 ::= { transmission 127 } 1046 -- Textual Conventions 1048 TenthdBmV ::= TEXTUAL-CONVENTION 1049 DISPLAY-HINT "d-1" 1050 STATUS current 1051 DESCRIPTION 1052 "This data type represents power levels that are normally 1053 expressed in dBmV. Units are in tenths of a dBmV; 1054 for example, 5.1 dBmV will be represented as 51." 1055 SYNTAX Integer32 1057 TenthdB ::= TEXTUAL-CONVENTION 1058 DISPLAY-HINT "d-1" 1059 STATUS current 1060 DESCRIPTION 1061 "This data type represents power levels that are normally 1062 expressed in dB. Units are in tenths of a dB; 1063 for example, 5.1 dB will be represented as 51." 1064 SYNTAX Integer32 1066 DocsisVersion ::= TEXTUAL-CONVENTION 1067 STATUS current 1068 DESCRIPTION "Indicates the DOCSIS version number." 1069 SYNTAX INTEGER { 1070 docsis10 (1), 1071 docsis11 (2), 1072 docsis20 (3) 1073 } 1075 DocsisUpstreamType ::= TEXTUAL-CONVENTION 1076 STATUS current 1077 DESCRIPTION "Indicates the DOCSIS Upstream Channel Type." 1078 SYNTAX INTEGER { 1079 tdma (1), 1080 atdma (2), 1081 scdma (3), 1082 tdmaAndAtdma (4) 1083 } 1085 docsIfMibObjects OBJECT IDENTIFIER ::= { docsIfMib 1 } 1086 docsIfBaseObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 1 } 1087 docsIfCmObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 2 } 1088 docsIfCmtsObjects OBJECT IDENTIFIER ::= { docsIfMibObjects 3 } 1090 -- 1091 -- BASE GROUP 1092 -- 1094 -- 1095 -- The following table is implemented on both the Cable Modem (CM) 1096 -- and the Cable Modem Termination System (CMTS). This table is 1097 -- read only for the CM. 1098 -- 1100 docsIfDownstreamChannelTable OBJECT-TYPE 1101 SYNTAX SEQUENCE OF DocsIfDownstreamChannelEntry 1102 MAX-ACCESS not-accessible 1103 STATUS current 1104 DESCRIPTION 1105 "This table describes the attributes of downstream 1106 channels (frequency bands)." 1107 REFERENCE 1108 "Document [25] from References, Table 6-12 and Table 6-13." 1109 ::= { docsIfBaseObjects 1 } 1111 docsIfDownstreamChannelEntry OBJECT-TYPE 1112 SYNTAX DocsIfDownstreamChannelEntry 1113 MAX-ACCESS not-accessible 1114 STATUS current 1115 DESCRIPTION 1116 "An entry provides a list of attributes for a single 1117 Downstream channel. 1118 An entry in this table exists for each ifEntry with an 1119 ifType of docsCableDownstream(128)." 1120 INDEX { ifIndex } 1121 ::= { docsIfDownstreamChannelTable 1 } 1123 DocsIfDownstreamChannelEntry ::= SEQUENCE { 1124 docsIfDownChannelId Integer32, 1125 docsIfDownChannelFrequency Integer32, 1126 docsIfDownChannelWidth Integer32, 1127 docsIfDownChannelModulation INTEGER, 1128 docsIfDownChannelInterleave INTEGER, 1129 docsIfDownChannelPower TenthdBmV, 1130 docsIfDownChannelAnnex INTEGER 1131 } 1133 docsIfDownChannelId OBJECT-TYPE 1134 SYNTAX Integer32 (0..255) 1135 MAX-ACCESS read-only 1136 STATUS current 1137 DESCRIPTION 1138 "The Cable Modem Termination System (CMTS) identification 1139 of the downstream channel within this particular MAC 1140 interface. If the interface is down, the object returns 1141 the most current value. If the downstream channel ID is 1142 unknown, this object returns a value of 0." 1143 ::= { docsIfDownstreamChannelEntry 1 } 1145 docsIfDownChannelFrequency OBJECT-TYPE 1146 SYNTAX Integer32 (0..1000000000) 1147 UNITS "hertz" 1148 MAX-ACCESS read-write 1149 STATUS current 1150 DESCRIPTION 1151 "The center of the downstream frequency associated with 1152 this channel. This object will return the current tuner 1153 frequency. If a CMTS provides IF output, this object 1154 will return 0, unless this CMTS is in control of the 1155 final downstream RF frequency. See the associated 1156 compliance object for a description of valid frequencies 1157 that may be written to this object." 1158 REFERENCE 1159 "Document [25] from References, Tables 4-1, 6-14." 1160 ::= { docsIfDownstreamChannelEntry 2 } 1162 docsIfDownChannelWidth OBJECT-TYPE 1163 SYNTAX Integer32 (0..16000000) 1164 UNITS "hertz" 1165 MAX-ACCESS read-write 1166 STATUS current 1167 DESCRIPTION 1168 "The bandwidth of this downstream channel. Most 1169 implementations are expected to support a channel width 1170 of 6 MHz (North America) and/or 8 MHz (Europe). See the 1171 associated compliance object for a description of the 1172 valid channel widths for this object." 1173 REFERENCE 1174 "Document [25] from References, Table 6-14." 1175 ::= { docsIfDownstreamChannelEntry 3 } 1177 docsIfDownChannelModulation OBJECT-TYPE 1178 SYNTAX INTEGER { 1179 unknown(1), 1180 other(2), 1181 qam64(3), 1182 qam256(4) 1183 } 1184 MAX-ACCESS read-write 1185 STATUS current 1186 DESCRIPTION 1187 "The modulation type associated with this downstream 1188 channel. If the interface is down, this object either 1189 returns the configured value (CMTS), the most current 1190 value (CM), or the value of unknown(1). See the 1191 associated conformance object for write conditions and 1192 limitations. See the reference for specifics on the 1193 modulation profiles implied by qam64 and qam256." 1194 REFERENCE 1195 "Document [25] from References, Table 6-14." 1196 ::= { docsIfDownstreamChannelEntry 4 } 1198 docsIfDownChannelInterleave OBJECT-TYPE 1199 SYNTAX INTEGER { 1200 unknown(1), 1201 other(2), 1202 taps8Increment16(3), 1203 taps16Increment8(4), 1204 taps32Increment4(5), 1205 taps64Increment2(6), 1206 taps128Increment1(7), 1207 taps12increment17(8) 1208 } 1209 MAX-ACCESS read-write 1210 STATUS current 1211 DESCRIPTION 1212 "The Forward Error Correction (FEC) interleaving used 1213 for this downstream channel. 1214 Values are defined as follows: 1215 taps8Increment16(3): protection 5.9/4.1 usec, 1216 latency .22/.15 msec 1217 taps16Increment8(4): protection 12/8.2 usec, 1218 latency .48/.33 msec 1219 taps32Increment4(5): protection 24/16 usec, 1220 latency .98/.68 msec 1221 taps64Increment2(6): protection 47/33 usec, 1222 latency 2/1.4 msec 1223 taps128Increment1(7): protection 95/66 usec, 1224 latency 4/2.8 msec 1225 taps12increment17(8): protection 18/14 usec, 1226 latency 0.43/0.32 msec 1227 taps12increment17 is implemented in 1228 conformance with EuroDOCSIS document 1229 'Adapted MIB-definitions - and a 1230 clarification for MPEG-related issues - for 1231 EuroDOCSIS cable modem systems' by tComLabs 1232 and should only be used for a EuroDOCSIS MAC 1233 interface. 1235 If the interface is down, this object either returns 1236 the configured value (CMTS), the most current value (CM), 1237 or the value of unknown(1). 1238 The value of other(2) is returned if the interleave 1239 is known but not defined in the above list. 1240 See the associated conformance object for write 1241 conditions and limitations. See the reference for the FEC 1242 configuration described by the setting of this object." 1243 REFERENCE 1244 "Document [25] from References, Table 6-13." 1245 ::= { docsIfDownstreamChannelEntry 5 } 1247 docsIfDownChannelPower OBJECT-TYPE 1248 SYNTAX TenthdBmV 1249 UNITS "dBmV" 1250 MAX-ACCESS read-write 1251 STATUS current 1252 DESCRIPTION 1253 "At the CMTS, the operational transmit power. At the CM, 1254 the received power level. May be set to zero at the CM 1255 if power level measurement is not supported. 1256 If the interface is down, this object either returns 1257 the configured value (CMTS), the most current value (CM) 1258 or the value of 0. See the associated conformance object 1259 for write conditions and limitations. See the reference 1260 for recommended and required power levels." 1261 REFERENCE 1262 "Document [25] from References,Table 6-15." 1263 ::= { docsIfDownstreamChannelEntry 6 } 1265 docsIfDownChannelAnnex OBJECT-TYPE 1266 SYNTAX INTEGER { 1267 unknown(1), 1268 other(2), 1269 annexA(3), 1270 annexB(4), 1271 annexC(5) 1272 } 1273 MAX-ACCESS read-only 1274 STATUS current 1275 DESCRIPTION 1276 "The value of this object indicates the conformance of 1277 the implementation to important regional cable standards. 1278 annexA : Annex A from ITU-J83 is used. 1279 annexB : Annex B from ITU-J83 is used. 1280 annexC : Annex C from ITU-J83 is used. 1281 AnnexB is used for DOCSIS implementations" 1282 REFERENCE 1283 "Document [28] from References, Section 2.2" 1284 ::= { docsIfDownstreamChannelEntry 7 } 1286 -- 1287 -- The following table is implemented on both the CM and the CMTS. 1288 -- For the CM, only attached channels appear in the table. For the 1289 -- CM, this table is read only as well. 1290 -- 1292 docsIfUpstreamChannelTable OBJECT-TYPE 1293 SYNTAX SEQUENCE OF DocsIfUpstreamChannelEntry 1294 MAX-ACCESS not-accessible 1295 STATUS current 1296 DESCRIPTION 1297 "This table describes the attributes of attached upstream 1298 channels." 1299 ::= { docsIfBaseObjects 2 } 1301 docsIfUpstreamChannelEntry OBJECT-TYPE 1302 SYNTAX DocsIfUpstreamChannelEntry 1303 MAX-ACCESS not-accessible 1304 STATUS current 1305 DESCRIPTION 1306 "List of attributes for a single upstream channel. For 1307 Docsis 2.0 CMTSs, an entry in this table exists for 1308 each ifEntry with an ifType of docsCableUpstreamChannel (205). 1309 For Docsis 1.x CM/CMTSs and Docsis 2.0 CMs, an entry in this table exists 1310 for each ifEntry with an ifType of docsCableUpstreamInterface (129)." 1311 INDEX { ifIndex } 1312 ::= { docsIfUpstreamChannelTable 1 } 1314 DocsIfUpstreamChannelEntry ::= SEQUENCE { 1315 docsIfUpChannelId Integer32, 1316 docsIfUpChannelFrequency Integer32, 1317 docsIfUpChannelWidth Integer32, 1318 docsIfUpChannelModulationProfile Unsigned32, 1319 docsIfUpChannelSlotSize Unsigned32, 1320 docsIfUpChannelTxTimingOffset Unsigned32, 1321 docsIfUpChannelRangingBackoffStart Integer32, 1322 docsIfUpChannelRangingBackoffEnd Integer32, 1323 docsIfUpChannelTxBackoffStart Integer32, 1324 docsIfUpChannelTxBackoffEnd Integer32, 1325 docsIfUpChannelScdmaActiveCodes Unsigned32, 1326 docsIfUpChannelScdmaCodesPerSlot Integer32, 1327 docsIfUpChannelScdmaFrameSize Unsigned32, 1328 docsIfUpChannelScdmaHoppingSeed Unsigned32, 1329 docsIfUpChannelType DocsisUpstreamType 1330 } 1332 docsIfUpChannelId OBJECT-TYPE 1333 SYNTAX Integer32 (0..255) 1334 MAX-ACCESS read-only 1335 STATUS current 1336 DESCRIPTION 1337 "The CMTS identification of the upstream channel." 1338 ::= { docsIfUpstreamChannelEntry 1 } 1340 docsIfUpChannelFrequency OBJECT-TYPE 1341 SYNTAX Integer32 (0..1000000000) 1342 UNITS "hertz" 1343 MAX-ACCESS read-write 1344 STATUS current 1345 DESCRIPTION 1346 "The center of the frequency band associated with this 1347 upstream interface. This object returns 0 if the frequency 1348 is undefined or unknown. Minimum permitted upstream 1349 frequency is 5,000,000 Hz for current technology. See 1350 the associated conformance object for write conditions 1351 and limitations." 1352 REFERENCE 1353 "Document [25] from References, Table 4-2." 1354 ::= { docsIfUpstreamChannelEntry 2 } 1356 docsIfUpChannelWidth OBJECT-TYPE 1357 SYNTAX Integer32 (0..64000000) 1358 UNITS "hertz" 1359 MAX-ACCESS read-write 1360 STATUS current 1361 DESCRIPTION 1362 "The bandwidth of this upstream interface. This object 1363 returns 0 if the interface width is undefined or unknown. 1364 Minimum permitted interface width is 200,000 Hz currently. 1365 See the associated conformance object for write conditions 1366 and limitations." 1367 REFERENCE 1368 "Document [25] from References, Table 6-12." 1369 ::= { docsIfUpstreamChannelEntry 3 } 1371 docsIfUpChannelModulationProfile OBJECT-TYPE 1372 SYNTAX Unsigned32 1373 MAX-ACCESS read-write 1374 STATUS current 1375 DESCRIPTION 1376 "An entry identical to the docsIfModIndex in the 1377 docsIfCmtsModulationTable that describes this channel. 1378 This channel is further instantiated there by a grouping 1379 of interval usage codes which together fully describe the 1380 channel modulation. This object returns 0 if the 1381 docsIfCmtsModulationTable entry does not exist or 1382 docsIfCmtsModulationTable is empty. See 1383 the associated conformance object for write conditions 1384 and limitations." 1385 REFERENCE 1386 "Document [25] from References, Table 8-19." 1387 ::= { docsIfUpstreamChannelEntry 4 } 1389 docsIfUpChannelSlotSize OBJECT-TYPE 1390 SYNTAX Unsigned32 1391 MAX-ACCESS read-write 1392 STATUS current 1393 DESCRIPTION 1394 "Applicable to TDMA and ATDMA channel types only. 1395 The number of 6.25 microsecond ticks in each upstream mini- 1396 slot. Returns zero if the value is undefined, unknown or in 1397 case of an SCDMA channel. 1398 See the associated conformance object for write 1399 conditions and limitations. " 1400 REFERENCE 1401 "Document [25] from References, Section 8.1.2.4." 1402 ::= { docsIfUpstreamChannelEntry 5 } 1404 docsIfUpChannelTxTimingOffset OBJECT-TYPE 1405 SYNTAX Unsigned32 1406 MAX-ACCESS read-only 1407 STATUS current 1408 DESCRIPTION 1409 "At the CM, a measure of the current round trip time obtained from the 1410 ranging offset (initial ranging offset + ranging offset adjustments). 1411 At the CMTS, the maximum of timing offset, among all the CMs that 1412 are/were present on the channel, taking into account all ( initial + 1413 periodic )timing offset corrections that were sent for each of the CMs. 1414 Generally, these measurements are positive, but if the 1415 measurements are negative, the value of this object is zero. Used for 1416 timing of CM upstream transmissions to ensure synchronized arrivals at 1417 the CMTS. Units are in terms of (6.25 microseconds/64)." 1418 REFERENCE 1419 "Document [25] from References, Section 6.2.18." 1420 ::= { docsIfUpstreamChannelEntry 6 } 1422 docsIfUpChannelRangingBackoffStart OBJECT-TYPE 1423 SYNTAX Integer32 (0..16) 1424 MAX-ACCESS read-write 1425 STATUS current 1426 DESCRIPTION 1427 "The initial random backoff window to use when retrying 1428 Ranging Requests. Expressed as a power of 2. A value of 16 1429 at the CMTS indicates that a proprietary adaptive retry 1430 mechanism is to be used. See the associated conformance 1431 object for write conditions and limitations." 1432 REFERENCE 1433 "Document [25] from References, Section 8.3.4." 1434 ::= { docsIfUpstreamChannelEntry 7 } 1436 docsIfUpChannelRangingBackoffEnd OBJECT-TYPE 1437 SYNTAX Integer32 (0..16) 1438 MAX-ACCESS read-write 1439 STATUS current 1440 DESCRIPTION 1441 "The final random backoff window to use when retrying 1442 Ranging Requests. Expressed as a power of 2. A value of 16 1443 at the CMTS indicates that a proprietary adaptive retry 1444 mechanism is to be used. See the associated conformance 1445 object for write conditions and limitations." 1446 REFERENCE 1447 "Document [25] from References, Section 8.3.4." 1448 ::= { docsIfUpstreamChannelEntry 8 } 1450 docsIfUpChannelTxBackoffStart OBJECT-TYPE 1451 SYNTAX Integer32 (0..16) 1452 MAX-ACCESS read-write 1453 STATUS current 1454 DESCRIPTION 1455 "The initial random backoff window to use when retrying 1456 transmissions. Expressed as a power of 2. A value of 16 1457 at the CMTS indicates that a proprietary adaptive retry 1458 mechanism is to be used. See the associated conformance 1459 object for write conditions and limitations." 1460 REFERENCE 1461 "Document [25] from References, Section 8.3.4." 1462 ::= { docsIfUpstreamChannelEntry 9 } 1464 docsIfUpChannelTxBackoffEnd OBJECT-TYPE 1465 SYNTAX Integer32 (0..16) 1466 MAX-ACCESS read-write 1467 STATUS current 1468 DESCRIPTION 1469 "The final random backoff window to use when retrying 1470 transmissions. Expressed as a power of 2. A value of 16 1471 at the CMTS indicates that a proprietary adaptive retry 1472 mechanism is to be used. See the associated conformance 1473 object for write conditions and limitations." 1474 REFERENCE 1475 "Document [25] from References, Section 8.3.4." 1476 ::= { docsIfUpstreamChannelEntry 10 } 1478 docsIfUpChannelScdmaActiveCodes OBJECT-TYPE 1479 SYNTAX Unsigned32 (0 | 2..128) 1480 MAX-ACCESS read-write 1481 STATUS current 1482 DESCRIPTION 1483 "Applicable for SCDMA channel types only. 1484 Number of active codes. Returns zero for 1485 Non-SCDMA channel types." 1486 REFERENCE 1487 "Document [25] from References, Section 6.2.11.2.1." 1488 ::= { docsIfUpstreamChannelEntry 11 } 1490 docsIfUpChannelScdmaCodesPerSlot OBJECT-TYPE 1491 SYNTAX Integer32(0 | 2..32) 1492 MAX-ACCESS read-write 1493 STATUS current 1494 DESCRIPTION 1495 "Applicable for SCDMA channel types only. 1496 The number of SCDMA codes per mini-slot. 1497 Returns zero if the value is undefined, unknown or in 1498 case of a TDMA or ATDMA channel." 1499 REFERENCE 1500 "Document [25] from References, Section 6.2.11.2.1." 1501 ::= { docsIfUpstreamChannelEntry 12 } 1503 docsIfUpChannelScdmaFrameSize OBJECT-TYPE 1504 SYNTAX Unsigned32 (0..32) 1505 MAX-ACCESS read-write 1506 STATUS current 1507 DESCRIPTION 1508 "Applicable for SCDMA channel types only. 1509 SCDMA Frame size in units of spreading intervals. 1510 This value returns zero for non SCDMA Profiles." 1511 REFERENCE 1512 " Document [25] from References, Section 6.2.12." 1513 ::= { docsIfUpstreamChannelEntry 13 } 1515 docsIfUpChannelScdmaHoppingSeed OBJECT-TYPE 1516 SYNTAX Unsigned32 (0..32767) 1517 MAX-ACCESS read-write 1518 STATUS current 1519 DESCRIPTION 1520 "Applicable for SCDMA channel types only. 1521 15 bit seed used for code hopping sequence initialization. 1522 Returns zero for non-SCDMA channel types." 1523 REFERENCE 1524 "Document [25] from References, Section 6.2.14.1." 1525 ::= { docsIfUpstreamChannelEntry 14 } 1527 docsIfUpChannelType OBJECT-TYPE 1528 SYNTAX DocsisUpstreamType 1529 MAX-ACCESS read-write 1530 STATUS current 1531 DESCRIPTION 1532 "Defines the Upstream channel type. 1533 Given the channel type, other channel attributes can be checked 1534 for value validity at the time of entry creation and update." 1535 REFERENCE 1536 "Document [25] from References, Section 6.2.1." 1537 ::= { docsIfUpstreamChannelEntry 15 } 1539 -- The following table describes the attributes of each class of 1540 -- service. The entries in this table are referenced from the 1541 -- docsIfServiceEntries. They exist as a separate table in order to 1542 -- reduce redundant information in docsIfServiceTable. 1543 -- 1544 -- This table is implemented at both the CM and the CMTS. 1545 -- The CM need only maintain entries for the classes of service 1546 -- referenced by its docsIfServiceTable. 1547 -- 1549 docsIfQosProfileTable OBJECT-TYPE 1550 SYNTAX SEQUENCE OF DocsIfQosProfileEntry 1551 MAX-ACCESS not-accessible 1552 STATUS current 1553 DESCRIPTION 1554 "Describes the attributes for each class of service." 1555 ::= { docsIfBaseObjects 3 } 1557 docsIfQosProfileEntry OBJECT-TYPE 1558 SYNTAX DocsIfQosProfileEntry 1559 MAX-ACCESS not-accessible 1560 STATUS current 1561 DESCRIPTION 1562 "Describes the attributes for a single class of service. 1564 If implemented as read-create in the Cable Modem 1565 Termination System, creation of entries in this table is 1566 controlled by the value of docsIfCmtsQosProfilePermissions. 1568 If implemented as read-only, entries are created based 1569 on information in REG-REQ MAC messages received from 1570 Cable Modems (Cable Modem Termination System 1571 implementation), or based on information extracted from 1572 the TFTP option file (Cable Modem implementation). 1573 In the Cable Modem Termination system, read-only entries 1574 are removed if no longer referenced by 1575 docsIfCmtsServiceTable. 1577 An entry in this table must not be removed while it is 1578 referenced by an entry in docsIfCmServiceTable (Cable Modem) 1579 or docsIfCmtsServiceTable (Cable Modem Termination System). 1581 An entry in this table should not be changeable while 1582 it is referenced by an entry in docsIfCmtsServiceTable. 1584 If this table is created automatically, there should only 1585 be a single entry for each Class of Service. Multiple 1586 entries with the same Class of Service parameters are not 1587 recommended." 1588 INDEX { docsIfQosProfIndex } 1589 ::= { docsIfQosProfileTable 1 } 1591 DocsIfQosProfileEntry ::= SEQUENCE { 1592 docsIfQosProfIndex Integer32, 1593 docsIfQosProfPriority Integer32, 1594 docsIfQosProfMaxUpBandwidth Integer32, 1595 docsIfQosProfGuarUpBandwidth Integer32, 1596 docsIfQosProfMaxDownBandwidth Integer32, 1597 docsIfQosProfMaxTxBurst Integer32, -- Deprecated 1598 docsIfQosProfBaselinePrivacy TruthValue, 1599 docsIfQosProfStatus RowStatus, 1600 docsIfQosProfMaxTransmitBurst Integer32 1601 } 1603 docsIfQosProfIndex OBJECT-TYPE 1604 SYNTAX Integer32 (1..16383) 1605 MAX-ACCESS not-accessible 1606 STATUS current 1607 DESCRIPTION 1608 "The index value that uniquely identifies an entry 1609 in the docsIfQosProfileTable." 1610 ::= { docsIfQosProfileEntry 1 } 1612 docsIfQosProfPriority OBJECT-TYPE 1613 SYNTAX Integer32 (0..7) 1614 MAX-ACCESS read-create 1615 STATUS current 1616 DESCRIPTION 1617 "A relative priority assigned to this service when 1618 allocating bandwidth. Zero indicates lowest priority 1619 and seven indicates highest priority. 1620 Interpretation of priority is device-specific. 1621 MUST NOT be changed while this row is active." 1622 REFERENCE 1623 "Document [25] from References, Appendix C.1.1.4." 1624 DEFVAL { 0 } 1625 ::= { docsIfQosProfileEntry 2 } 1627 docsIfQosProfMaxUpBandwidth OBJECT-TYPE 1628 SYNTAX Integer32 (0..100000000) 1629 MAX-ACCESS read-create 1630 STATUS current 1631 DESCRIPTION 1632 "The maximum upstream bandwidth, in bits per second, 1633 allowed for a service with this service class. 1634 Zero if there is no restriction of upstream bandwidth. 1635 MUST NOT be changed while this row is active." 1636 REFERENCE 1637 "Document [25] from References, Appendix C.1.1.4." 1639 DEFVAL { 0 } 1640 ::= { docsIfQosProfileEntry 3 } 1642 docsIfQosProfGuarUpBandwidth OBJECT-TYPE 1643 SYNTAX Integer32 (0..100000000) 1644 MAX-ACCESS read-create 1645 STATUS current 1646 DESCRIPTION 1647 "Minimum guaranteed upstream bandwidth, in bits per second, 1648 allowed for a service with this service class. 1649 MUST NOT be changed while this row is active." 1650 REFERENCE 1651 "Document [25] from References, Appendix C.1.1.4." 1652 DEFVAL { 0 } 1653 ::= { docsIfQosProfileEntry 4 } 1655 docsIfQosProfMaxDownBandwidth OBJECT-TYPE 1656 SYNTAX Integer32 (0..100000000) 1657 MAX-ACCESS read-create 1658 STATUS current 1659 DESCRIPTION 1660 "The maximum downstream bandwidth, in bits per second, 1661 allowed for a service with this service class. 1662 Zero if there is no restriction of downstream bandwidth. 1663 MUST NOT be changed while this row is active." 1664 REFERENCE 1665 "Document [25] from References, Appendix C.1.1.4." 1667 DEFVAL { 0 } 1668 ::= { docsIfQosProfileEntry 5 } 1670 docsIfQosProfMaxTxBurst OBJECT-TYPE 1671 SYNTAX Integer32 (0..255) 1672 MAX-ACCESS read-create 1673 STATUS deprecated 1674 DESCRIPTION 1675 "The maximum number of mini-slots that may be requested 1676 for a single upstream transmission. 1677 A value of zero means there is no limit. 1678 MUST NOT be changed while this row is active. 1679 This object has been deprecated and replaced by 1680 docsIfQosProfMaxTransmitBurst, to fix a mismatch 1681 of the units and value range with respect to the DOCSIS 1682 Maximum Upstream Channel Transmit Burst Configuration 1683 Setting." 1684 REFERENCE 1685 "Document [25] from References, C.1.1.4." 1686 DEFVAL { 0 } 1687 ::= { docsIfQosProfileEntry 6 } 1689 docsIfQosProfBaselinePrivacy OBJECT-TYPE 1690 SYNTAX TruthValue 1691 MAX-ACCESS read-create 1692 STATUS current 1693 DESCRIPTION 1694 "Indicates whether Baseline Privacy is enabled for this 1695 service class. 1696 MUST NOT be changed while this row is active." 1697 DEFVAL { false } 1698 ::= { docsIfQosProfileEntry 7 } 1700 docsIfQosProfStatus OBJECT-TYPE 1701 SYNTAX RowStatus 1702 MAX-ACCESS read-create 1703 STATUS current 1704 DESCRIPTION 1705 "This is object is to used to create or delete rows in 1706 this table. This object MUST NOT be changed from active 1707 while the row is referenced by the any entry in either 1708 docsIfCmServiceTable (on the CM), or the 1709 docsIfCmtsServiceTable (on the CMTS)." 1710 ::= { docsIfQosProfileEntry 8 } 1712 docsIfQosProfMaxTransmitBurst OBJECT-TYPE 1713 SYNTAX Integer32 (0..1522) 1714 MAX-ACCESS read-create 1715 STATUS current 1716 DESCRIPTION 1717 "The maximum number of bytes that may be requested for a 1718 single upstream transmission. A value of zero means there 1719 is no limit. Note: This value does not include any 1720 physical layer overhead. 1721 MUST NOT be changed while this row is active." 1722 REFERENCE 1723 "Document [25] from References, Appendix C.1.1.4." 1724 DEFVAL { 0 } 1725 ::= { docsIfQosProfileEntry 9 } 1727 docsIfSignalQualityTable OBJECT-TYPE 1728 SYNTAX SEQUENCE OF DocsIfSignalQualityEntry 1729 MAX-ACCESS not-accessible 1730 STATUS current 1731 DESCRIPTION 1732 "At the CM, describes the PHY signal quality of downstream 1733 channels. At the CMTS, describes the PHY signal quality of 1734 upstream channels. At the CMTS, this table may exclude 1735 contention intervals." 1736 ::= { docsIfBaseObjects 4 } 1738 docsIfSignalQualityEntry OBJECT-TYPE 1739 SYNTAX DocsIfSignalQualityEntry 1740 MAX-ACCESS not-accessible 1741 STATUS current 1742 DESCRIPTION 1743 "At the CM, describes the PHY characteristics of a 1744 downstream channel. At the CMTS, describes the PHY signal 1745 quality of an upstream channel. 1746 An entry in this table exists for each ifEntry with an 1747 ifType of docsCableUpstream(129) for Cable Modem Termination 1748 Systems and docsCableDownstream(128) for Cable Modems." 1749 INDEX { ifIndex } 1750 ::= { docsIfSignalQualityTable 1 } 1752 DocsIfSignalQualityEntry ::= SEQUENCE { 1753 docsIfSigQIncludesContention TruthValue, 1754 docsIfSigQUnerroreds Counter32, 1755 docsIfSigQCorrecteds Counter32, 1756 docsIfSigQUncorrectables Counter32, 1757 docsIfSigQSignalNoise TenthdB, 1758 docsIfSigQMicroreflections Integer32, 1759 docsIfSigQEqualizationData OCTET STRING 1760 } 1762 docsIfSigQIncludesContention OBJECT-TYPE 1763 SYNTAX TruthValue 1764 MAX-ACCESS read-only 1765 STATUS current 1766 DESCRIPTION 1767 "true(1) if this CMTS includes contention intervals in 1768 the counters in this table. Always false(2) for CMs." 1769 REFERENCE 1770 "Document [25] from References, 1771 Section 9.4.1" 1772 ::= { docsIfSignalQualityEntry 1 } 1774 docsIfSigQUnerroreds OBJECT-TYPE 1775 SYNTAX Counter32 1776 MAX-ACCESS read-only 1777 STATUS current 1778 DESCRIPTION 1779 "Codewords received on this channel without error. 1780 This includes all codewords, whether or not they 1781 were part of frames destined for this device." 1782 REFERENCE 1783 "Document [25] from References, Section 6.2.5." 1784 ::= { docsIfSignalQualityEntry 2 } 1786 docsIfSigQCorrecteds OBJECT-TYPE 1787 SYNTAX Counter32 1788 MAX-ACCESS read-only 1789 STATUS current 1790 DESCRIPTION 1791 "Codewords received on this channel with correctable 1792 errors. This includes all codewords, whether or not 1793 they were part of frames destined for this device." 1794 REFERENCE 1795 "Document [25] from References, Section 6.2.5." 1796 ::= { docsIfSignalQualityEntry 3 } 1798 docsIfSigQUncorrectables OBJECT-TYPE 1799 SYNTAX Counter32 1800 MAX-ACCESS read-only 1801 STATUS current 1802 DESCRIPTION 1803 "Codewords received on this channel with uncorrectable 1804 errors. This includes all codewords, whether or not 1805 they were part of frames destined for this device." 1806 REFERENCE 1807 "Document [25] from References, Section 6.2.5." 1808 ::= { docsIfSignalQualityEntry 4 } 1810 docsIfSigQSignalNoise OBJECT-TYPE 1811 SYNTAX TenthdB 1812 UNITS "dB" 1813 MAX-ACCESS read-only 1814 STATUS current 1815 DESCRIPTION 1816 "Signal/Noise ratio as perceived for this channel. 1817 At the CM, describes the Signal/Noise of the downstream 1818 channel. At the CMTS, describes the average Signal/Noise 1819 of the upstream channel." 1820 REFERENCE 1821 "Document [25] from References, Tables 4-1 and 4-2" 1822 ::= { docsIfSignalQualityEntry 5 } 1824 docsIfSigQMicroreflections OBJECT-TYPE 1825 SYNTAX Integer32 (0..255) 1826 UNITS "dBc" 1827 MAX-ACCESS read-only 1828 STATUS current 1829 DESCRIPTION 1830 "Total microreflections including in-channel response 1831 as perceived on this interface, measured in dBc below 1832 the signal level. 1833 This object is not assumed to return an absolutely 1834 accurate value, but should give a rough indication 1835 of microreflections received on this interface. 1836 It is up to the implementer to provide information 1837 as accurate as possible." 1838 REFERENCE 1839 "Document [25] from References, Tables 4-1 and 4-2" 1840 ::= { docsIfSignalQualityEntry 6 } 1842 docsIfSigQEqualizationData OBJECT-TYPE 1843 SYNTAX OCTET STRING 1844 MAX-ACCESS read-only 1845 STATUS current 1846 DESCRIPTION 1847 "At the CM, returns the equalization data for the downstream 1848 channel. At the CMTS, returns the average equalization 1849 data for the upstream channel. Returns an empty string 1850 if the value is unknown or if there is no equalization 1851 data available or defined." 1852 REFERENCE 1853 "Document [25] from References, Table 8-21." 1854 ::= { docsIfSignalQualityEntry 7 } 1856 -- 1857 -- DOCSIS Version of the device 1858 -- 1860 docsIfDocsisBaseCapability OBJECT-TYPE 1861 SYNTAX DocsisVersion 1862 MAX-ACCESS read-only 1863 STATUS current 1864 DESCRIPTION 1865 "Indication of the DOCSIS capability of the device. 1866 This object mirrors docsIfDocsisCapability from the 1867 DocsIfExt mib." 1868 REFERENCE 1869 "Document [25] from References, Annex G." 1870 ::= { docsIfBaseObjects 5 } 1872 -- 1873 -- CABLE MODEM GROUP 1874 -- 1876 -- ####### 1878 -- 1879 -- The CM MAC Table 1880 -- 1882 docsIfCmMacTable OBJECT-TYPE 1883 SYNTAX SEQUENCE OF DocsIfCmMacEntry 1884 MAX-ACCESS not-accessible 1885 STATUS current 1886 DESCRIPTION 1887 "Describes the attributes of each CM MAC interface, 1888 extending the information available from ifEntry." 1889 ::= { docsIfCmObjects 1 } 1891 docsIfCmMacEntry OBJECT-TYPE 1892 SYNTAX DocsIfCmMacEntry 1893 MAX-ACCESS not-accessible 1894 STATUS current 1895 DESCRIPTION 1896 "An entry containing objects describing attributes of 1897 each MAC entry, extending the information in ifEntry. 1898 An entry in this table exists for each ifEntry with an 1899 ifType of docsCableMaclayer(127)." 1900 INDEX { ifIndex } 1901 ::= { docsIfCmMacTable 1 } 1903 DocsIfCmMacEntry ::= SEQUENCE { 1904 docsIfCmCmtsAddress MacAddress, 1905 docsIfCmCapabilities BITS, 1906 docsIfCmRangingRespTimeout TimeTicks, 1907 docsIfCmRangingTimeout TimeInterval 1908 } 1910 docsIfCmCmtsAddress OBJECT-TYPE 1911 SYNTAX MacAddress 1912 MAX-ACCESS read-only 1913 STATUS current 1914 DESCRIPTION 1915 "Identifies the CMTS that is believed to control this MAC 1916 domain. At the CM, this will be the source address from 1917 SYNC, MAP, and other MAC-layer messages. If the CMTS is 1918 unknown, returns 00-00-00-00-00-00." 1919 REFERENCE 1920 "Document [25] from References, Section 8.2.2." 1921 ::= { docsIfCmMacEntry 1 } 1923 docsIfCmCapabilities OBJECT-TYPE 1924 SYNTAX BITS { 1925 atmCells(0), 1926 concatenation(1) 1927 } 1928 MAX-ACCESS read-only 1929 STATUS current 1930 DESCRIPTION 1931 "Identifies the capabilities of the MAC implementation 1932 at this interface. Note that packet transmission is 1933 always supported. Therefore, there is no specific bit 1934 required to explicitly indicate this capability. 1935 Note that BITS objects are encoded most significant bit 1936 first. For example, if bit 1 is set, the value of this 1937 object is the octet string '40'H." 1938 ::= { docsIfCmMacEntry 2 } 1940 -- This object has been obsoleted and replaced by 1941 -- docsIfCmRangingTimeout to correct the typing to TimeInterval. New 1942 -- implementations of the MIB should use docsIfCmRangingTimeout instead. 1944 docsIfCmRangingRespTimeout OBJECT-TYPE 1945 SYNTAX TimeTicks 1946 MAX-ACCESS read-write 1947 STATUS obsolete 1948 DESCRIPTION 1949 "Waiting time for a Ranging Response packet." 1950 REFERENCE 1951 "Document [25] from References, Section 9.1.6." 1952 DEFVAL { 20 } 1953 ::= { docsIfCmMacEntry 3 } 1955 docsIfCmRangingTimeout OBJECT-TYPE 1956 SYNTAX TimeInterval 1957 MAX-ACCESS read-write 1958 STATUS current 1959 DESCRIPTION 1960 "Waiting time for a Ranging Response packet." 1961 REFERENCE 1962 "Document [25] from References, 1963 Section 9.1.6, timer T3." 1964 DEFVAL { 20 } 1965 ::= { docsIfCmMacEntry 4 } 1967 -- 1968 -- CM status table. 1969 -- This table is implemented only at the CM. 1970 -- 1972 docsIfCmStatusTable OBJECT-TYPE 1973 SYNTAX SEQUENCE OF DocsIfCmStatusEntry 1974 MAX-ACCESS not-accessible 1975 STATUS current 1976 DESCRIPTION 1977 "This table maintains a number of status objects 1978 and counters for Cable Modems." 1979 ::= { docsIfCmObjects 2 } 1981 docsIfCmStatusEntry OBJECT-TYPE 1982 SYNTAX DocsIfCmStatusEntry 1983 MAX-ACCESS not-accessible 1984 STATUS current 1985 DESCRIPTION 1986 "A set of status objects and counters for a single MAC 1987 layer instance in a Cable Modem. 1988 An entry in this table exists for each ifEntry with an 1989 ifType of docsCableMaclayer(127)." 1990 INDEX { ifIndex } 1991 ::= { docsIfCmStatusTable 1 } 1993 DocsIfCmStatusEntry ::= SEQUENCE { 1994 docsIfCmStatusValue INTEGER, 1995 docsIfCmStatusCode OCTET STRING, 1996 docsIfCmStatusTxPower TenthdBmV, 1997 docsIfCmStatusResets Counter32, 1998 docsIfCmStatusLostSyncs Counter32, 1999 docsIfCmStatusInvalidMaps Counter32, 2000 docsIfCmStatusInvalidUcds Counter32, 2001 docsIfCmStatusInvalidRangingResponses Counter32, 2002 docsIfCmStatusInvalidRegistrationResponses Counter32, 2003 docsIfCmStatusT1Timeouts Counter32, 2004 docsIfCmStatusT2Timeouts Counter32, 2005 docsIfCmStatusT3Timeouts Counter32, 2006 docsIfCmStatusT4Timeouts Counter32, 2007 docsIfCmStatusRangingAborteds Counter32, 2008 docsIfCmStatusDocsisOperMode DocsisVersion, 2009 docsIfCmStatusModulationType DocsisUpstreamType 2010 } 2012 docsIfCmStatusValue OBJECT-TYPE 2013 SYNTAX INTEGER { 2014 other(1), 2015 notReady(2), 2016 notSynchronized(3), 2017 phySynchronized(4), 2018 usParametersAcquired(5), 2019 rangingComplete(6), 2020 ipComplete(7), 2021 todEstablished(8), 2022 securityEstablished(9), 2023 paramTransferComplete(10), 2024 registrationComplete(11), 2025 operational(12), 2026 accessDenied(13) 2027 } 2028 MAX-ACCESS read-only 2029 STATUS current 2030 DESCRIPTION 2031 "Current Cable Modem connectivity state, as specified 2032 in the RF Interface Specification." 2033 REFERENCE 2034 "Document [25] from References, Section 11.2." 2035 ::= { docsIfCmStatusEntry 1 } 2037 docsIfCmStatusCode OBJECT-TYPE 2038 SYNTAX OCTET STRING 2039 MAX-ACCESS read-only 2040 STATUS current 2041 DESCRIPTION 2042 "Status code for this Cable Modem as defined in the 2043 RF Interface Specification. The status code consists 2044 of a single character indicating error groups, followed 2045 by a two- or three-digit number indicating the status 2046 condition." 2047 REFERENCE 2048 "Document [26] from References, Appendix F." 2049 ::= { docsIfCmStatusEntry 2 } 2051 docsIfCmStatusTxPower OBJECT-TYPE 2052 SYNTAX TenthdBmV 2053 UNITS "dBmV" 2054 MAX-ACCESS read-only 2055 STATUS current 2056 DESCRIPTION 2057 "The operational transmit power for the attached upstream 2058 channel." 2059 REFERENCE 2060 "Document [25] from References, Section 6.2.20." 2061 ::= { docsIfCmStatusEntry 3 } 2063 docsIfCmStatusResets OBJECT-TYPE 2064 SYNTAX Counter32 2065 MAX-ACCESS read-only 2066 STATUS current 2067 DESCRIPTION 2068 "Number of times the CM reset or initialized this interface." 2069 ::= { docsIfCmStatusEntry 4 } 2071 docsIfCmStatusLostSyncs OBJECT-TYPE 2072 SYNTAX Counter32 2073 MAX-ACCESS read-only 2074 STATUS current 2075 DESCRIPTION 2076 "Number of times the CM lost synchronization with 2077 the downstream channel." 2078 REFERENCE 2079 "Document [25] from References, Section 8.3.2." 2080 ::= { docsIfCmStatusEntry 5 } 2082 docsIfCmStatusInvalidMaps OBJECT-TYPE 2083 SYNTAX Counter32 2084 MAX-ACCESS read-only 2085 STATUS current 2086 DESCRIPTION 2087 "Number of times the CM received invalid MAP messages." 2088 REFERENCE 2089 "Document [25] from References, Section 8.3.4." 2090 ::= { docsIfCmStatusEntry 6 } 2092 docsIfCmStatusInvalidUcds OBJECT-TYPE 2093 SYNTAX Counter32 2094 MAX-ACCESS read-only 2095 STATUS current 2096 DESCRIPTION 2097 "Number of times the CM received invalid UCD messages." 2098 REFERENCE 2099 "Document [25] from References, Section 8.3.3." 2100 ::= { docsIfCmStatusEntry 7 } 2102 docsIfCmStatusInvalidRangingResponses OBJECT-TYPE 2103 SYNTAX Counter32 2104 MAX-ACCESS read-only 2105 STATUS current 2106 DESCRIPTION 2107 "Number of times the CM received invalid ranging response 2108 messages." 2109 REFERENCE 2110 "Document [25] from References, Section 8.3.6." 2111 ::= { docsIfCmStatusEntry 8 } 2113 docsIfCmStatusInvalidRegistrationResponses OBJECT-TYPE 2114 SYNTAX Counter32 2115 MAX-ACCESS read-only 2116 STATUS current 2117 DESCRIPTION 2118 "Number of times the CM received invalid registration 2119 response messages." 2120 REFERENCE 2121 "Document [25] from References, Section 8.3.8." 2122 ::= { docsIfCmStatusEntry 9 } 2124 docsIfCmStatusT1Timeouts OBJECT-TYPE 2125 SYNTAX Counter32 2126 MAX-ACCESS read-only 2127 STATUS current 2128 DESCRIPTION 2129 "Number of times counter T1 expired in the CM." 2130 REFERENCE 2131 "Document [25] from References, Figure 9-2." 2132 ::= { docsIfCmStatusEntry 10 } 2134 docsIfCmStatusT2Timeouts OBJECT-TYPE 2135 SYNTAX Counter32 2136 MAX-ACCESS read-only 2137 STATUS current 2138 DESCRIPTION 2139 "Number of times counter T2 expired in the CM." 2140 REFERENCE 2141 "Document [25] from References, Figure 9-2." 2142 ::= { docsIfCmStatusEntry 11 } 2144 docsIfCmStatusT3Timeouts OBJECT-TYPE 2145 SYNTAX Counter32 2146 MAX-ACCESS read-only 2147 STATUS current 2148 DESCRIPTION 2149 "Number of times counter T3 expired in the CM." 2150 REFERENCE 2151 "Document [25] from References, Figure 9-2." 2152 ::= { docsIfCmStatusEntry 12 } 2154 docsIfCmStatusT4Timeouts OBJECT-TYPE 2155 SYNTAX Counter32 2156 MAX-ACCESS read-only 2157 STATUS current 2158 DESCRIPTION 2159 "Number of times counter T4 expired in the CM." 2160 REFERENCE 2161 "Document [25] from References, Figure 9-2." 2162 ::= { docsIfCmStatusEntry 13 } 2164 docsIfCmStatusRangingAborteds OBJECT-TYPE 2165 SYNTAX Counter32 2166 MAX-ACCESS read-only 2167 STATUS current 2168 DESCRIPTION 2169 "Number of times the ranging process was aborted 2170 by the CMTS." 2171 REFERENCE 2172 "Document [25] from References, Section 9.3.3." 2173 ::= { docsIfCmStatusEntry 14 } 2175 docsIfCmStatusDocsisOperMode OBJECT-TYPE 2176 SYNTAX DocsisVersion 2177 MAX-ACCESS read-only 2178 STATUS current 2179 DESCRIPTION 2180 "Indication whether the device has registered as a 1.0, 1.1 or 2.0. 2181 For unregistered CM, it is always the same as 2182 docsIfDocsisBaseCapability. 2183 This object mirrors docsIfCmDocsisOperMode from the docsIfExt mib." 2184 REFERENCE 2185 "Document [25] from References, Annex G." 2186 ::= { docsIfCmStatusEntry 15 } 2188 docsIfCmStatusModulationType OBJECT-TYPE 2189 SYNTAX DocsisUpstreamType 2190 MAX-ACCESS read-only 2191 STATUS current 2192 DESCRIPTION 2193 "Indicates modulation type currently used by the CM." 2194 REFERENCE 2195 "Document [25] from References, Section 6.2.1." 2197 ::= { docsIfCmStatusEntry 16 } 2199 -- 2200 -- The Cable Modem Service Table 2201 -- 2203 docsIfCmServiceTable OBJECT-TYPE 2204 SYNTAX SEQUENCE OF DocsIfCmServiceEntry 2205 MAX-ACCESS not-accessible 2206 STATUS current 2207 DESCRIPTION 2208 "Describes the attributes of each upstream service queue 2209 on a CM." 2210 ::= { docsIfCmObjects 3 } 2212 docsIfCmServiceEntry OBJECT-TYPE 2213 SYNTAX DocsIfCmServiceEntry 2214 MAX-ACCESS not-accessible 2215 STATUS current 2216 DESCRIPTION 2217 "Describes the attributes of an upstream bandwidth service 2218 queue. 2219 An entry in this table exists for each Service ID. 2220 The primary index is an ifIndex with an ifType of 2221 docsCableMaclayer(127)." 2222 INDEX { ifIndex, docsIfCmServiceId } 2223 ::= { docsIfCmServiceTable 1 } 2225 DocsIfCmServiceEntry ::= SEQUENCE { 2226 docsIfCmServiceId Integer32, 2227 docsIfCmServiceQosProfile Integer32, 2228 docsIfCmServiceTxSlotsImmed Counter32, 2229 docsIfCmServiceTxSlotsDed Counter32, 2230 docsIfCmServiceTxRetries Counter32, 2231 docsIfCmServiceTxExceededs Counter32, 2232 docsIfCmServiceRqRetries Counter32, 2233 docsIfCmServiceRqExceededs Counter32, 2234 docsIfCmServiceExtTxSlotsImmed Counter64, 2235 docsIfCmServiceExtTxSlotsDed Counter64 2236 } 2238 docsIfCmServiceId OBJECT-TYPE 2239 SYNTAX Integer32 (1..16383) 2240 MAX-ACCESS not-accessible 2241 STATUS current 2242 DESCRIPTION 2243 "Identifies a service queue for upstream bandwidth. The 2244 attributes of this service queue are shared between the 2245 CM and the CMTS. The CMTS allocates upstream bandwidth 2246 to this service queue based on requests from the CM and 2247 on the class of service associated with this queue." 2248 ::= { docsIfCmServiceEntry 1 } 2250 docsIfCmServiceQosProfile OBJECT-TYPE 2251 SYNTAX Integer32 (0..16383) 2252 MAX-ACCESS read-only 2253 STATUS current 2254 DESCRIPTION 2255 "The index in docsIfQosProfileTable describing the quality 2256 of service attributes associated with this particular 2257 service. If no associated entry in docsIfQosProfileTable 2258 exists, this object returns a value of zero." 2259 ::= { docsIfCmServiceEntry 2 } 2261 docsIfCmServiceTxSlotsImmed OBJECT-TYPE 2262 SYNTAX Counter32 2263 MAX-ACCESS read-only 2264 STATUS current 2265 DESCRIPTION 2266 "The number of upstream mini-slots which have been used to 2267 transmit data PDUs in immediate (contention) mode. This 2268 includes only those PDUs that are presumed to have 2269 arrived at the headend (i.e., those which were explicitly 2270 acknowledged.) It does not include retransmission attempts 2271 or mini-slots used by Requests." 2272 REFERENCE 2273 "Document [25] from References, Section 9.4." 2274 ::= { docsIfCmServiceEntry 3 } 2276 docsIfCmServiceTxSlotsDed OBJECT-TYPE 2277 SYNTAX Counter32 2278 MAX-ACCESS read-only 2279 STATUS current 2280 DESCRIPTION 2281 "The number of upstream mini-slots which have been used to 2282 transmit data PDUs in dedicated mode (i.e., as a result 2283 of a unicast Data Grant)." 2284 REFERENCE 2285 "Document [25] from References, Section 9.4." 2286 ::= { docsIfCmServiceEntry 4 } 2288 docsIfCmServiceTxRetries OBJECT-TYPE 2289 SYNTAX Counter32 2290 MAX-ACCESS read-only 2291 STATUS current 2292 DESCRIPTION 2293 "The number of attempts to transmit data PDUs containing 2294 requests for acknowledgment that did not result in 2295 acknowledgment." 2296 REFERENCE 2297 "Document [25] from References, Section 9.4." 2298 ::= { docsIfCmServiceEntry 5 } 2300 docsIfCmServiceTxExceededs OBJECT-TYPE 2301 SYNTAX Counter32 2302 MAX-ACCESS read-only 2303 STATUS current 2304 DESCRIPTION 2305 "The number of data PDUs transmission failures due to 2306 excessive retries without acknowledgment." 2307 REFERENCE 2308 "Document [25] from References, Section 9.4." 2309 ::= { docsIfCmServiceEntry 6 } 2311 docsIfCmServiceRqRetries OBJECT-TYPE 2312 SYNTAX Counter32 2313 MAX-ACCESS read-only 2314 STATUS current 2315 DESCRIPTION 2316 "The number of attempts to transmit bandwidth requests 2317 which did not result in acknowledgment." 2318 REFERENCE 2319 "Document [25] from References, Section 9.4." 2320 ::= { docsIfCmServiceEntry 7 } 2322 docsIfCmServiceRqExceededs OBJECT-TYPE 2323 SYNTAX Counter32 2324 MAX-ACCESS read-only 2325 STATUS current 2326 DESCRIPTION 2327 "The number of requests for bandwidth which failed due to 2328 excessive retries without acknowledgment." 2329 REFERENCE 2330 "Document [25] from References, Section 9.4." 2331 ::= { docsIfCmServiceEntry 8 } 2333 docsIfCmServiceExtTxSlotsImmed OBJECT-TYPE 2334 SYNTAX Counter64 2335 MAX-ACCESS read-only 2336 STATUS current 2337 DESCRIPTION 2338 "The number of upstream mini-slots which have been used to 2339 transmit data PDUs in immediate (contention) mode. This 2340 includes only those PDUs that are presumed to have 2341 arrived at the headend (i.e., those which were explicitly 2342 acknowledged.) It does not include retransmission attempts 2343 or mini-slots used by Requests." 2344 REFERENCE 2345 "Document [25] from References, Section 9.4." 2346 ::= { docsIfCmServiceEntry 9 } 2348 docsIfCmServiceExtTxSlotsDed OBJECT-TYPE 2349 SYNTAX Counter64 2350 MAX-ACCESS read-only 2351 STATUS current 2352 DESCRIPTION 2353 "The number of upstream mini-slots which have been used to 2354 transmit data PDUs in dedicated mode (i.e., as a result 2355 of a unicast Data Grant)." 2356 REFERENCE 2357 "Document [25] from References, Section 9.4." 2358 ::= { docsIfCmServiceEntry 10 } 2360 -- 2361 -- CMTS GROUP 2362 -- 2364 -- 2365 -- The CMTS MAC Table 2366 -- 2368 docsIfCmtsMacTable OBJECT-TYPE 2369 SYNTAX SEQUENCE OF DocsIfCmtsMacEntry 2370 MAX-ACCESS not-accessible 2371 STATUS current 2372 DESCRIPTION 2373 "Describes the attributes of each CMTS MAC interface, 2374 extending the information available from ifEntry. 2375 Mandatory for all CMTS devices." 2376 ::= { docsIfCmtsObjects 1 } 2378 docsIfCmtsMacEntry OBJECT-TYPE 2379 SYNTAX DocsIfCmtsMacEntry 2380 MAX-ACCESS not-accessible 2381 STATUS current 2382 DESCRIPTION 2383 "An entry containing objects describing attributes of each 2384 MAC entry, extending the information in ifEntry. 2385 An entry in this table exists for each ifEntry with an 2386 ifType of docsCableMaclayer(127)." 2387 INDEX { ifIndex } 2388 ::= { docsIfCmtsMacTable 1 } 2390 DocsIfCmtsMacEntry ::= SEQUENCE { 2391 docsIfCmtsCapabilities BITS, 2392 docsIfCmtsSyncInterval Integer32, 2393 docsIfCmtsUcdInterval Integer32, 2394 docsIfCmtsMaxServiceIds Integer32, 2395 docsIfCmtsInsertionInterval TimeTicks, -- Obsolete 2396 docsIfCmtsInvitedRangingAttempts Integer32, 2397 docsIfCmtsInsertInterval TimeInterval 2398 } 2400 docsIfCmtsCapabilities OBJECT-TYPE 2401 SYNTAX BITS { 2402 atmCells(0), 2403 concatenation(1) 2404 } 2405 MAX-ACCESS read-only 2406 STATUS current 2407 DESCRIPTION 2408 "Identifies the capabilities of the CMTS MAC 2409 implementation at this interface. Note that packet 2410 transmission is always supported. Therefore, there 2411 is no specific bit required to explicitly indicate 2412 this capability. 2413 Note that BITS objects are encoded most significant bit 2414 first. For example, if bit 1 is set, the value of this 2415 object is the octet string '40'H." 2416 ::= { docsIfCmtsMacEntry 1 } 2418 docsIfCmtsSyncInterval OBJECT-TYPE 2419 SYNTAX Integer32 (1..200) 2420 UNITS "Milliseconds" 2421 MAX-ACCESS read-write 2422 STATUS current 2423 DESCRIPTION 2424 "The interval between CMTS transmission of successive SYNC 2425 messages at this interface." 2426 REFERENCE 2427 "Document [25] from References, Section 9.3." 2428 ::= { docsIfCmtsMacEntry 2 } 2430 docsIfCmtsUcdInterval OBJECT-TYPE 2431 SYNTAX Integer32 (1..2000) 2432 UNITS "Milliseconds" 2433 MAX-ACCESS read-write 2434 STATUS current 2435 DESCRIPTION 2436 "The interval between CMTS transmission of successive 2437 Upstream Channel Descriptor messages for each upstream 2438 channel at this interface." 2439 REFERENCE 2440 "Document [25] from References, Section 9.3" 2441 ::= { docsIfCmtsMacEntry 3 } 2443 docsIfCmtsMaxServiceIds OBJECT-TYPE 2444 SYNTAX Integer32 (1..16383) 2445 MAX-ACCESS read-only 2446 STATUS current 2447 DESCRIPTION 2448 "The maximum number of service IDs that may be 2449 simultaneously active." 2450 ::= { docsIfCmtsMacEntry 4 } 2452 -- This object has been obsoleted and replaced by 2453 -- docsIfCmtsInsertInterval to fix a SYNTAX typing problem. New 2454 -- implementations of this MIB should use that object instead. 2456 docsIfCmtsInsertionInterval OBJECT-TYPE 2457 SYNTAX TimeTicks 2458 MAX-ACCESS read-write 2459 STATUS obsolete 2460 DESCRIPTION 2461 "The amount of time to elapse between each broadcast 2462 station maintenance grant. Broadcast station maintenance 2463 grants are used to allow new cable modems to join the 2464 network. Zero indicates that a vendor-specific algorithm 2465 is used instead of a fixed time. Maximum amount of time 2466 permitted by the specification is 2 seconds." 2467 REFERENCE 2468 "Document [25] from References, Annex B." 2469 ::= { docsIfCmtsMacEntry 5 } 2471 docsIfCmtsInvitedRangingAttempts OBJECT-TYPE 2472 SYNTAX Integer32 (0..1024) 2473 MAX-ACCESS read-write 2474 STATUS current 2475 DESCRIPTION 2476 "The maximum number of attempts to make on invitations 2477 for ranging requests. A value of zero means the system 2478 should attempt to range forever." 2479 REFERENCE 2480 "Document [25] from References, Section 9.3.3 and Annex B." 2481 ::= { docsIfCmtsMacEntry 6 } 2483 docsIfCmtsInsertInterval OBJECT-TYPE 2484 SYNTAX TimeInterval 2485 MAX-ACCESS read-write 2486 STATUS current 2487 DESCRIPTION 2488 "The amount of time to elapse between each broadcast 2489 station maintenance grant. Broadcast station maintenance 2490 grants are used to allow new cable modems to join the 2491 network. Zero indicates that a vendor-specific algorithm 2492 is used instead of a fixed time. Maximum amount of time 2493 permitted by the specification is 2 seconds." 2494 REFERENCE 2495 "Document [25] from References, Annex B." 2496 ::= { docsIfCmtsMacEntry 7 } 2498 -- 2499 -- 2500 -- CMTS status table. 2501 -- 2503 docsIfCmtsStatusTable OBJECT-TYPE 2504 SYNTAX SEQUENCE OF DocsIfCmtsStatusEntry 2505 MAX-ACCESS not-accessible 2506 STATUS current 2507 DESCRIPTION 2508 "For the MAC layer, this group maintains a number of 2509 status objects and counters." 2510 ::= { docsIfCmtsObjects 2 } 2512 docsIfCmtsStatusEntry OBJECT-TYPE 2513 SYNTAX DocsIfCmtsStatusEntry 2514 MAX-ACCESS not-accessible 2515 STATUS current 2516 DESCRIPTION 2517 "Status entry for a single MAC layer. 2518 An entry in this table exists for each ifEntry with an 2519 ifType of docsCableMaclayer(127)." 2520 INDEX { ifIndex } 2521 ::= { docsIfCmtsStatusTable 1 } 2523 DocsIfCmtsStatusEntry ::= SEQUENCE { 2524 docsIfCmtsStatusInvalidRangeReqs Counter32, 2525 docsIfCmtsStatusRangingAborteds Counter32, 2526 docsIfCmtsStatusInvalidRegReqs Counter32, 2527 docsIfCmtsStatusFailedRegReqs Counter32, 2528 docsIfCmtsStatusInvalidDataReqs Counter32, 2529 docsIfCmtsStatusT5Timeouts Counter32 2530 } 2532 docsIfCmtsStatusInvalidRangeReqs OBJECT-TYPE 2533 SYNTAX Counter32 2534 MAX-ACCESS read-only 2535 STATUS current 2536 DESCRIPTION 2537 "This object counts invalid RNG-REQ messages received on 2538 this interface." 2539 REFERENCE 2540 "Document [25] from References, Section 8.3.5." 2542 ::= { docsIfCmtsStatusEntry 1 } 2544 docsIfCmtsStatusRangingAborteds OBJECT-TYPE 2545 SYNTAX Counter32 2546 MAX-ACCESS read-only 2547 STATUS current 2548 DESCRIPTION 2549 "This object counts ranging attempts that were explicitly 2550 aborted by the CMTS." 2551 REFERENCE 2552 "Document [25] from References, Section 8.3.6." 2553 ::= { docsIfCmtsStatusEntry 2 } 2555 docsIfCmtsStatusInvalidRegReqs OBJECT-TYPE 2556 SYNTAX Counter32 2557 MAX-ACCESS read-only 2558 STATUS current 2559 DESCRIPTION 2560 "This object counts invalid REG-REQ messages received on 2561 this interface." 2562 REFERENCE 2563 "Document [25] from References, Section 8.3.7." 2564 ::= { docsIfCmtsStatusEntry 3 } 2566 docsIfCmtsStatusFailedRegReqs OBJECT-TYPE 2567 SYNTAX Counter32 2568 MAX-ACCESS read-only 2569 STATUS current 2570 DESCRIPTION 2571 "This object counts failed registration attempts, i.e., 2572 authentication failures and class of service failures, 2573 on this interface." 2574 REFERENCE 2575 "Document [25] from References, Section 8.3.7." 2576 ::= { docsIfCmtsStatusEntry 4 } 2578 docsIfCmtsStatusInvalidDataReqs OBJECT-TYPE 2579 SYNTAX Counter32 2580 MAX-ACCESS read-only 2581 STATUS current 2582 DESCRIPTION 2583 "This object counts invalid data request messages 2584 received on this interface." 2585 ::= { docsIfCmtsStatusEntry 5 } 2587 docsIfCmtsStatusT5Timeouts OBJECT-TYPE 2588 SYNTAX Counter32 2589 MAX-ACCESS read-only 2590 STATUS current 2591 DESCRIPTION 2592 "This object counts the number of times counter T5 2593 expired on this interface." 2594 REFERENCE 2595 "Document [25] from References, Figure 9-2." 2596 ::= { docsIfCmtsStatusEntry 6 } 2598 -- 2599 -- CM status table (within CMTS). 2600 -- This table is implemented only at the CMTS. 2601 -- It contains per CM status information available in the CMTS. 2602 -- 2604 docsIfCmtsCmStatusTable OBJECT-TYPE 2605 SYNTAX SEQUENCE OF DocsIfCmtsCmStatusEntry 2606 MAX-ACCESS not-accessible 2607 STATUS current 2608 DESCRIPTION 2609 "A set of objects in the CMTS, maintained for each 2610 Cable Modem connected to this CMTS." 2611 ::= { docsIfCmtsObjects 3 } 2613 docsIfCmtsCmStatusEntry OBJECT-TYPE 2614 SYNTAX DocsIfCmtsCmStatusEntry 2615 MAX-ACCESS not-accessible 2616 STATUS current 2617 DESCRIPTION 2618 "Status information for a single Cable Modem. 2619 An entry in this table exists for each Cable Modem 2620 that is connected to the CMTS implementing this table." 2621 INDEX { docsIfCmtsCmStatusIndex } 2622 ::= { docsIfCmtsCmStatusTable 1 } 2624 DocsIfCmtsCmStatusEntry ::= SEQUENCE { 2625 docsIfCmtsCmStatusIndex Integer32, 2626 docsIfCmtsCmStatusMacAddress MacAddress, 2627 docsIfCmtsCmStatusIpAddress IpAddress, -- Deprecated 2628 docsIfCmtsCmStatusDownChannelIfIndex InterfaceIndexOrZero, 2629 docsIfCmtsCmStatusUpChannelIfIndex InterfaceIndexOrZero, 2630 docsIfCmtsCmStatusRxPower TenthdBmV, 2631 docsIfCmtsCmStatusTimingOffset Unsigned32, 2632 docsIfCmtsCmStatusEqualizationData OCTET STRING, 2633 docsIfCmtsCmStatusValue INTEGER, 2634 docsIfCmtsCmStatusUnerroreds Counter32, 2635 docsIfCmtsCmStatusCorrecteds Counter32, 2636 docsIfCmtsCmStatusUncorrectables Counter32, 2637 docsIfCmtsCmStatusSignalNoise TenthdB, 2638 docsIfCmtsCmStatusMicroreflections Integer32, 2639 docsIfCmtsCmStatusExtUnerroreds Counter64, 2640 docsIfCmtsCmStatusExtCorrecteds Counter64, 2641 docsIfCmtsCmStatusExtUncorrectables Counter64, 2642 docsIfCmtsCmStatusDocsisRegMode DocsisVersion, 2643 docsIfCmtsCmStatusModulationType DocsisUpstreamType, 2644 docsIfCmtsCmStatusInetAddressType InetAddressType, 2645 docsIfCmtsCmStatusInetAddress InetAddress 2646 } 2648 docsIfCmtsCmStatusIndex OBJECT-TYPE 2649 SYNTAX Integer32 (1..2147483647) 2650 MAX-ACCESS not-accessible 2651 STATUS current 2652 DESCRIPTION 2653 "Index value to uniquely identify an entry in this table. 2654 For an individual Cable Modem, this index value should 2655 not change during CMTS uptime." 2656 ::= { docsIfCmtsCmStatusEntry 1 } 2658 docsIfCmtsCmStatusMacAddress OBJECT-TYPE 2659 SYNTAX MacAddress 2660 MAX-ACCESS read-only 2661 STATUS current 2662 DESCRIPTION 2663 "MAC address of this Cable Modem. If the Cable Modem has 2664 multiple MAC addresses, this is the MAC address associated 2665 with the Cable interface." 2666 REFERENCE 2667 "Document [25] from References, Section 8.2.2." 2668 ::= { docsIfCmtsCmStatusEntry 2 } 2670 docsIfCmtsCmStatusIpAddress OBJECT-TYPE 2671 SYNTAX IpAddress 2672 MAX-ACCESS read-only 2673 STATUS deprecated 2674 DESCRIPTION 2675 "IP address of this Cable Modem. If the Cable Modem has no 2676 IP address assigned, or the IP address is unknown, this 2677 object returns a value of 0.0.0.0. If the Cable Modem has 2678 multiple IP addresses, this object returns the IP address 2679 associated with the Cable interface.n 2680 This object has been deprecated and replaced by 2681 docsIfCmtsCmStatusInetAddressType and 2682 docsIfCmtsCmStatusInetAddress, to enable IPv6 addressing 2683 in the future." 2684 ::= { docsIfCmtsCmStatusEntry 3 } 2686 docsIfCmtsCmStatusDownChannelIfIndex OBJECT-TYPE 2687 SYNTAX InterfaceIndexOrZero 2688 MAX-ACCESS read-only 2689 STATUS current 2690 DESCRIPTION 2691 "IfIndex of the downstream channel this CM is connected 2692 to. If the downstream channel is unknown, this object 2693 returns a value of zero." 2694 ::= { docsIfCmtsCmStatusEntry 4 } 2696 docsIfCmtsCmStatusUpChannelIfIndex OBJECT-TYPE 2697 SYNTAX InterfaceIndexOrZero 2698 MAX-ACCESS read-only 2699 STATUS current 2700 DESCRIPTION 2701 "IfIndex of the upstream channel this CM is connected 2702 to. If the upstream channel is unknown, this object 2703 returns a value of zero." 2704 ::= { docsIfCmtsCmStatusEntry 5 } 2706 docsIfCmtsCmStatusRxPower OBJECT-TYPE 2707 SYNTAX TenthdBmV 2708 UNITS "dBmV" 2709 MAX-ACCESS read-only 2710 STATUS current 2711 DESCRIPTION 2712 "The receive power as perceived for upstream data from 2713 this Cable Modem. 2715 If the receive power is unknown, this object returns 2716 a value of zero." 2717 REFERENCE 2718 "Document [25] from References, Table 6-11." 2719 ::= { docsIfCmtsCmStatusEntry 6 } 2721 docsIfCmtsCmStatusTimingOffset OBJECT-TYPE 2722 SYNTAX Unsigned32 2723 MAX-ACCESS read-only 2724 STATUS current 2725 DESCRIPTION 2726 "A measure of the current round trip time for this CM. 2727 Used for timing of CM upstream transmissions to ensure 2728 synchronized arrivals at the CMTS. Units are in terms 2729 of 6.25 microseconds/(64*256). Returns zero if the value 2730 is unknown." 2731 REFERENCE 2732 "Document [25] from References, Section 6.2.18." 2733 ::= { docsIfCmtsCmStatusEntry 7 } 2735 docsIfCmtsCmStatusEqualizationData OBJECT-TYPE 2736 SYNTAX OCTET STRING 2737 MAX-ACCESS read-only 2738 STATUS current 2739 DESCRIPTION 2740 "Equalization data for this CM. Returns an empty string 2741 if the value is unknown or if there is no equalization 2742 data available or defined." 2743 REFERENCE 2744 "Document [25] from References, Figure 8-23." 2745 ::= { docsIfCmtsCmStatusEntry 8 } 2747 docsIfCmtsCmStatusValue OBJECT-TYPE 2748 SYNTAX INTEGER { 2749 other(1), 2750 ranging(2), 2751 rangingAborted(3), 2752 rangingComplete(4), 2753 ipComplete(5), 2754 registrationComplete(6), 2755 accessDenied(7) 2756 } 2757 MAX-ACCESS read-only 2758 STATUS current 2759 DESCRIPTION 2760 "Current Cable Modem connectivity state, as specified 2761 in the RF Interface Specification. Returned status 2762 information is the CM status as assumed by the CMTS, 2763 and indicates the following events: 2764 other(1) 2765 Any state other than below. 2766 ranging(2) 2767 The CMTS has received an Initial Ranging Request 2768 message from the CM, and the ranging process is not 2769 yet complete. 2770 rangingAborted(3) 2771 The CMTS has sent a Ranging Abort message to the CM. 2772 rangingComplete(4) 2773 The CMTS has sent a Ranging Complete message to the CM. 2774 ipComplete(5) 2775 The CMTS has received a DHCP reply message and forwarded 2776 it to the CM. 2777 registrationComplete(6) 2778 The CMTS has sent a Registration Response message to 2779 the CM. 2780 accessDenied(7) 2781 The CMTS has sent a Registration Aborted message 2782 to the CM. 2783 The CMTS only needs to report states it is able to detect." 2784 REFERENCE 2785 "Document [25] from References, Section 11.2." 2786 ::= { docsIfCmtsCmStatusEntry 9 } 2788 docsIfCmtsCmStatusUnerroreds OBJECT-TYPE 2789 SYNTAX Counter32 2790 MAX-ACCESS read-only 2791 STATUS current 2792 DESCRIPTION 2793 "Codewords received without error from this Cable Modem." 2794 REFERENCE 2795 "Document [25] from References, Section 6.2.5." 2796 ::= { docsIfCmtsCmStatusEntry 10 } 2798 docsIfCmtsCmStatusCorrecteds OBJECT-TYPE 2799 SYNTAX Counter32 2800 MAX-ACCESS read-only 2801 STATUS current 2802 DESCRIPTION 2803 "Codewords received with correctable errors from this 2804 Cable Modem." 2805 REFERENCE 2806 "Document [25] from References, Section 6.2.5." 2807 ::= { docsIfCmtsCmStatusEntry 11 } 2809 docsIfCmtsCmStatusUncorrectables OBJECT-TYPE 2810 SYNTAX Counter32 2811 MAX-ACCESS read-only 2812 STATUS current 2813 DESCRIPTION 2814 "Codewords received with uncorrectable errors from this 2815 Cable Modem." 2816 REFERENCE 2817 "Document [25] from References, Section 6.2.5." 2818 ::= { docsIfCmtsCmStatusEntry 12 } 2820 docsIfCmtsCmStatusSignalNoise OBJECT-TYPE 2821 SYNTAX TenthdB 2822 UNITS "dB" 2823 MAX-ACCESS read-only 2824 STATUS current 2825 DESCRIPTION 2826 "Signal/Noise ratio as perceived for upstream data from 2827 this Cable Modem. 2828 If the Signal/Noise is unknown, this object returns 2829 a value of zero." 2830 REFERENCE 2831 "Document [25] from References, Tables 4-1 and 4-2." 2832 ::= { docsIfCmtsCmStatusEntry 13 } 2833 docsIfCmtsCmStatusMicroreflections OBJECT-TYPE 2834 SYNTAX Integer32 (0..255) 2835 UNITS "dBc" 2836 MAX-ACCESS read-only 2837 STATUS current 2838 DESCRIPTION 2839 "Total microreflections including in-channel response 2840 as perceived on this interface, measured in dBc below 2841 the signal level. 2842 This object is not assumed to return an absolutely 2843 accurate value, but should give a rough indication 2844 of microreflections received on this interface. 2845 It is up to the implementer to provide information 2846 as accurate as possible." 2847 REFERENCE 2848 "Document [25] from References, Tables 4-1 and 4-2" 2849 ::= { docsIfCmtsCmStatusEntry 14 } 2851 docsIfCmtsCmStatusExtUnerroreds OBJECT-TYPE 2852 SYNTAX Counter64 2853 MAX-ACCESS read-only 2854 STATUS current 2855 DESCRIPTION 2856 "Codewords received without error from this Cable Modem." 2857 REFERENCE 2858 "Document [25] from References, Section 6.2.5." 2859 ::= { docsIfCmtsCmStatusEntry 15 } 2861 docsIfCmtsCmStatusExtCorrecteds OBJECT-TYPE 2862 SYNTAX Counter64 2863 MAX-ACCESS read-only 2864 STATUS current 2865 DESCRIPTION 2866 "Codewords received with correctable errors from this 2867 Cable Modem." 2868 REFERENCE 2869 "Document [25] from References, Section 6.2.5." 2870 ::= { docsIfCmtsCmStatusEntry 16 } 2872 docsIfCmtsCmStatusExtUncorrectables OBJECT-TYPE 2873 SYNTAX Counter64 2874 MAX-ACCESS read-only 2875 STATUS current 2876 DESCRIPTION 2877 "Codewords received with uncorrectable errors from this 2878 Cable Modem." 2879 REFERENCE 2880 "Document [25] from References, Section 6.2.5." 2881 ::= { docsIfCmtsCmStatusEntry 17 } 2883 docsIfCmtsCmStatusDocsisRegMode OBJECT-TYPE 2884 SYNTAX DocsisVersion 2885 MAX-ACCESS read-only 2886 STATUS current 2887 DESCRIPTION 2888 "Indicates in which DOCSIS version the CM has registered. This 2889 object mirrors docsIfCmtsCmStatusDocsisMode from the docsIfExt mib." 2890 REFERENCE 2891 "Document [25] from References, Annex G." 2892 ::= { docsIfCmtsCmStatusEntry 18 } 2894 docsIfCmtsCmStatusModulationType OBJECT-TYPE 2895 SYNTAX DocsisUpstreamType 2896 MAX-ACCESS read-only 2897 STATUS current 2898 DESCRIPTION 2899 "Indicates modulation type currently used by the CM." 2900 REFERENCE 2901 "Document [25] from References, Table 8-19." 2902 ::= { docsIfCmtsCmStatusEntry 19 } 2904 docsIfCmtsCmStatusInetAddressType OBJECT-TYPE 2905 SYNTAX InetAddressType 2906 MAX-ACCESS read-only 2907 STATUS current 2908 DESCRIPTION 2909 "The type of internet address of 2910 docsIfCmtsCmStatusInetAddress. If the cable modem 2911 Internet address is unassigned or unknown, then the 2912 value of this object is unknown(0)." 2913 ::= { docsIfCmtsCmStatusEntry 20 } 2915 docsIfCmtsCmStatusInetAddress OBJECT-TYPE 2916 SYNTAX InetAddress 2917 MAX-ACCESS read-only 2918 STATUS current 2919 DESCRIPTION 2920 "Internet address of this Cable Modem. If the Cable Modem 2921 has no Internet address assigned, or the Internet address 2922 is unknown, the value of this object is the empty string. 2924 If the Cable Modem has multiple Internet addresses, this 2925 object returns the Internet address associated with the 2926 Cable (i.e. RF MAC) interface." 2927 ::= { docsIfCmtsCmStatusEntry 21 } 2929 -- 2930 -- The CMTS Service Table. 2931 -- 2933 docsIfCmtsServiceTable OBJECT-TYPE 2934 SYNTAX SEQUENCE OF DocsIfCmtsServiceEntry 2935 MAX-ACCESS not-accessible 2936 STATUS current 2937 DESCRIPTION 2938 "Describes the attributes of upstream service queues 2939 in a Cable Modem Termination System." 2940 ::= { docsIfCmtsObjects 4 } 2942 docsIfCmtsServiceEntry OBJECT-TYPE 2943 SYNTAX DocsIfCmtsServiceEntry 2944 MAX-ACCESS not-accessible 2945 STATUS current 2946 DESCRIPTION 2947 "Describes the attributes of a single upstream bandwidth 2948 service queue. 2950 Entries in this table exist for each ifEntry with an 2951 ifType of docsCableMaclayer(127), and for each service 2952 queue (Service ID) within this MAC layer. 2953 Entries in this table are created with the creation of 2954 individual Service IDs by the MAC layer and removed 2955 when a Service ID is removed." 2956 INDEX { ifIndex, docsIfCmtsServiceId } 2957 ::= { docsIfCmtsServiceTable 1 } 2959 DocsIfCmtsServiceEntry ::= SEQUENCE { 2960 docsIfCmtsServiceId Integer32, 2961 docsIfCmtsServiceCmStatusIndex Integer32, -- Deprecated 2962 docsIfCmtsServiceAdminStatus INTEGER, 2963 docsIfCmtsServiceQosProfile Integer32, 2964 docsIfCmtsServiceCreateTime TimeStamp, 2965 docsIfCmtsServiceInOctets Counter32, 2966 docsIfCmtsServiceInPackets Counter32, 2967 docsIfCmtsServiceNewCmStatusIndex Integer32 2969 } 2971 docsIfCmtsServiceId OBJECT-TYPE 2972 SYNTAX Integer32 (1..16383) 2973 MAX-ACCESS not-accessible 2974 STATUS current 2975 DESCRIPTION 2976 "Identifies a service queue for upstream bandwidth. The 2977 attributes of this service queue are shared between the 2978 Cable Modem and the Cable Modem Termination System. 2979 The CMTS allocates upstream bandwidth to this service 2980 queue based on requests from the CM and on the class of 2981 service associated with this queue." 2982 ::= { docsIfCmtsServiceEntry 1 } 2984 docsIfCmtsServiceCmStatusIndex OBJECT-TYPE 2985 SYNTAX Integer32 (0..65535) 2986 MAX-ACCESS read-only 2987 STATUS deprecated 2988 DESCRIPTION 2989 "Pointer to an entry in docsIfCmtsCmStatusTable identifying 2990 the Cable Modem using this Service Queue. If multiple 2991 Cable Modems are using this Service Queue, the value of 2992 this object is zero. 2993 This object has been deprecated and replaced by 2994 docsIfCmtsServiceNewCmStatusIndex, to fix a mismatch 2995 of the value range with respect to docsIfCmtsCmStatusIndex 2996 (1..2147483647)." 2997 ::= { docsIfCmtsServiceEntry 2 } 2999 docsIfCmtsServiceAdminStatus OBJECT-TYPE 3000 SYNTAX INTEGER { 3001 enabled(1), 3002 disabled(2), 3003 destroyed(3) } 3004 MAX-ACCESS read-write 3005 STATUS current 3006 DESCRIPTION 3007 "Allows a service class for a particular modem to be 3008 suppressed, (re-)enabled, or deleted altogether." 3009 ::= { docsIfCmtsServiceEntry 3 } 3011 docsIfCmtsServiceQosProfile OBJECT-TYPE 3012 SYNTAX Integer32 (0..16383) 3013 MAX-ACCESS read-only 3014 STATUS current 3015 DESCRIPTION 3016 "The index in docsIfQosProfileTable describing the quality 3017 of service attributes associated with this particular 3018 service. If no associated docsIfQosProfileTable entry 3019 exists, this object returns a value of zero." 3020 ::= { docsIfCmtsServiceEntry 4 } 3022 docsIfCmtsServiceCreateTime OBJECT-TYPE 3024 SYNTAX TimeStamp 3025 MAX-ACCESS read-only 3026 STATUS current 3027 DESCRIPTION 3028 "The value of sysUpTime when this entry was created." 3029 ::= { docsIfCmtsServiceEntry 5 } 3031 docsIfCmtsServiceInOctets OBJECT-TYPE 3032 SYNTAX Counter32 3033 MAX-ACCESS read-only 3034 STATUS current 3035 DESCRIPTION 3036 "The cumulative number of Packet Data octets received 3037 on this Service ID. The count does not include the 3038 size of the Cable MAC header" 3039 ::= { docsIfCmtsServiceEntry 6 } 3041 docsIfCmtsServiceInPackets OBJECT-TYPE 3042 SYNTAX Counter32 3043 MAX-ACCESS read-only 3044 STATUS current 3045 DESCRIPTION 3046 "The cumulative number of Packet Data packets received 3047 on this Service ID." 3048 ::= { docsIfCmtsServiceEntry 7 } 3050 docsIfCmtsServiceNewCmStatusIndex OBJECT-TYPE 3051 SYNTAX Integer32 (0..2147483647) 3052 MAX-ACCESS read-only 3053 STATUS current 3054 DESCRIPTION 3055 "Pointer (via docsIfCmtsCmStatusIndex) to an entry in 3056 docsIfCmtsCmStatusTable identifying the Cable Modem 3057 using this Service Queue. If multiple Cable Modems are 3058 using this Service Queue, the value of this object is 3059 zero." 3060 ::= { docsIfCmtsServiceEntry 8 } 3062 -- 3063 -- The following table provides upstream channel modulation profiles. 3064 -- Entries in this table can be 3065 -- re-used by one or more upstream channels. An upstream channel will 3066 -- have a modulation profile 3067 -- for each value of docsIfModIntervalUsageCode. 3068 -- 3070 docsIfCmtsModulationTable OBJECT-TYPE 3071 SYNTAX SEQUENCE OF DocsIfCmtsModulationEntry 3072 MAX-ACCESS not-accessible 3073 STATUS current 3074 DESCRIPTION 3075 "Describes a modulation profile associated with one or more 3076 upstream channels." 3077 ::= { docsIfCmtsObjects 5 } 3079 docsIfCmtsModulationEntry OBJECT-TYPE 3080 SYNTAX DocsIfCmtsModulationEntry 3081 MAX-ACCESS not-accessible 3082 STATUS current 3083 DESCRIPTION 3084 "Describes a modulation profile for an Interval Usage Code 3085 for one or more upstream channels. 3086 Entries in this table are created by the operator. Initial 3087 default entries may be created at system initialization 3088 time. No individual objects have to be specified in order 3089 to create an entry in this table. 3090 Note that some objects do not have DEFVALs, but do have 3091 calculated defaults and need not be specified during row 3092 creation. 3093 There is no restriction on the changing of values in this 3094 table while their associated rows are active." 3095 INDEX { docsIfCmtsModIndex, docsIfCmtsModIntervalUsageCode} 3096 ::= { docsIfCmtsModulationTable 1 } 3098 DocsIfCmtsModulationEntry ::= SEQUENCE { 3099 docsIfCmtsModIndex Integer32, 3100 docsIfCmtsModIntervalUsageCode INTEGER, 3101 docsIfCmtsModControl RowStatus, 3102 docsIfCmtsModType INTEGER, 3103 docsIfCmtsModPreambleLen Integer32, 3104 docsIfCmtsModDifferentialEncoding TruthValue, 3105 docsIfCmtsModFECErrorCorrection Integer32, 3106 docsIfCmtsModFECCodewordLength Integer32, 3107 docsIfCmtsModScramblerSeed Integer32, 3108 docsIfCmtsModMaxBurstSize Integer32, 3109 docsIfCmtsModGuardTimeSize Unsigned32, 3110 docsIfCmtsModLastCodewordShortened TruthValue, 3111 docsIfCmtsModScrambler TruthValue, 3112 docsIfCmtsModByteInterleaverDepth Unsigned32, 3113 docsIfCmtsModByteInterleaverBlockSize Unsigned32, 3114 docsIfCmtsModPreambleType INTEGER, 3115 docsIfCmtsModTcmErrorCorrectionOn TruthValue, 3116 docsIfCmtsModScdmaInterleaverStepSize Unsigned32, 3117 docsIfCmtsModScdmaSpreaderEnable TruthValue, 3118 docsIfCmtsModScdmaSubframeCodes Unsigned32, 3119 docsIfCmtsModChannelType DocsisUpstreamType 3120 } 3122 docsIfCmtsModIndex OBJECT-TYPE 3123 SYNTAX Integer32 (1..2147483647) 3124 MAX-ACCESS not-accessible 3125 STATUS current 3126 DESCRIPTION 3127 "An index into the Channel Modulation table representing 3128 a group of Interval Usage Codes, all associated with the 3129 same channel." 3130 ::= { docsIfCmtsModulationEntry 1 } 3132 docsIfCmtsModIntervalUsageCode OBJECT-TYPE 3133 SYNTAX INTEGER { 3134 request(1), 3135 requestData(2), 3136 initialRanging(3), 3137 periodicRanging(4), 3138 shortData(5), 3139 longData(6), 3140 advPhyShortData(9), 3141 advPhyLongData(10), 3142 ugs(11) 3143 } 3144 MAX-ACCESS not-accessible 3145 STATUS current 3146 DESCRIPTION 3147 "An index into the Channel Modulation table which, when 3148 grouped with other Interval Usage Codes, fully 3149 instantiate all modulation sets for a given upstream 3150 channel." 3151 REFERENCE 3152 "Document [25] from References, Table 8-20." 3153 ::= { docsIfCmtsModulationEntry 2 } 3155 docsIfCmtsModControl OBJECT-TYPE 3156 SYNTAX RowStatus 3157 MAX-ACCESS read-create 3158 STATUS current 3159 DESCRIPTION 3160 "Controls and reflects the status of rows in this table." 3161 ::= { docsIfCmtsModulationEntry 3 } 3163 docsIfCmtsModType OBJECT-TYPE 3164 SYNTAX INTEGER { 3165 other(1), 3166 qpsk(2), 3167 qam16(3), 3168 qam8(4), 3169 qam32(5), 3170 qam64(6), 3171 qam128(7) 3172 } 3173 MAX-ACCESS read-create 3174 STATUS current 3175 DESCRIPTION 3176 "The modulation type used on this channel. Returns 3177 other(1) if the modulation type is neither 3178 qpsk, qam16, qam8, qam32, qam64 or qam128. 3179 Type qam128 is used for SCDMA channels only. 3180 See the reference for the modulation profiles 3181 implied by different modulation types. 3182 See the conformance object for write conditions and limitations." 3183 REFERENCE 3184 "Document [25] from References, Table 8-19." 3185 DEFVAL { qpsk } 3186 ::= { docsIfCmtsModulationEntry 4 } 3188 docsIfCmtsModPreambleLen OBJECT-TYPE 3189 SYNTAX Integer32 (0..1536) 3190 MAX-ACCESS read-create 3191 STATUS current 3192 DESCRIPTION 3193 "The preamble length for this modulation profile in bits. 3194 Default value is the minimum needed by the implementation 3195 at the CMTS for the given modulation profile." 3196 REFERENCE 3197 "Document [25] from References, Table 8-19." 3198 ::= { docsIfCmtsModulationEntry 5 } 3200 docsIfCmtsModDifferentialEncoding OBJECT-TYPE 3201 SYNTAX TruthValue 3202 MAX-ACCESS read-create 3203 STATUS current 3204 DESCRIPTION 3205 "Specifies whether or not differential encoding is used 3206 on this channel." 3207 REFERENCE 3208 "Document [25] from References, Table 8-19." 3209 DEFVAL { false } 3210 ::= { docsIfCmtsModulationEntry 6 } 3212 docsIfCmtsModFECErrorCorrection OBJECT-TYPE 3213 SYNTAX Integer32 (0..16) 3214 MAX-ACCESS read-create 3215 STATUS current 3216 DESCRIPTION 3217 "The number of correctable errored bytes (t) used in 3218 forward error correction code. The value of 0 indicates 3219 no correction is employed. The number of check bytes 3220 appended will be twice this value." 3221 REFERENCE 3222 "Document [25] from References, Table 8-19." 3223 DEFVAL { 0 } 3224 ::= { docsIfCmtsModulationEntry 7 } 3226 docsIfCmtsModFECCodewordLength OBJECT-TYPE 3227 SYNTAX Integer32 (1..255) 3228 MAX-ACCESS read-create 3229 STATUS current 3230 DESCRIPTION 3231 "The number of data bytes (k) in the forward error 3232 correction codeword. 3233 This object is not used if docsIfCmtsModFECErrorCorrection 3234 is zero." 3235 REFERENCE 3236 "Document [25] from References, Table 8-19." 3237 DEFVAL { 32 } 3238 ::= { docsIfCmtsModulationEntry 8 } 3240 docsIfCmtsModScramblerSeed OBJECT-TYPE 3241 SYNTAX Integer32 (0..32767) 3242 MAX-ACCESS read-create 3243 STATUS current 3244 DESCRIPTION 3245 "The 15 bit seed value for the scrambler polynomial." 3246 REFERENCE 3247 "Document [25] from References, Table 8-19." 3248 DEFVAL { 0 } 3249 ::= { docsIfCmtsModulationEntry 9 } 3251 docsIfCmtsModMaxBurstSize OBJECT-TYPE 3252 SYNTAX Integer32 (0..255) 3253 MAX-ACCESS read-create 3254 STATUS current 3255 DESCRIPTION 3256 "The maximum number of mini-slots that can be transmitted 3257 during this channel's burst time. Returns zero if the 3258 burst length is bounded by the allocation MAP rather than 3259 this profile. 3260 Default value is 0 except for shortData, where it is 8." 3261 REFERENCE 3262 "Document [25] from References, Table 8-19." 3263 ::= { docsIfCmtsModulationEntry 10 } 3265 docsIfCmtsModGuardTimeSize OBJECT-TYPE 3266 SYNTAX Unsigned32 3267 MAX-ACCESS read-only 3268 STATUS current 3269 DESCRIPTION 3270 "The number of symbol-times which must follow the end of 3271 this channel's burst. Default value is the minimum time 3272 needed by the implementation for this modulation profile." 3273 REFERENCE 3274 "Document [25] from References, Table 8-19." 3275 ::= { docsIfCmtsModulationEntry 11 } 3277 docsIfCmtsModLastCodewordShortened OBJECT-TYPE 3278 SYNTAX TruthValue 3279 MAX-ACCESS read-create 3280 STATUS current 3281 DESCRIPTION 3282 "Indicates if the last FEC codeword is truncated." 3283 REFERENCE 3284 "Document [25] from References, Table 8-19." 3285 DEFVAL { true } 3286 ::= { docsIfCmtsModulationEntry 12 } 3288 docsIfCmtsModScrambler OBJECT-TYPE 3289 SYNTAX TruthValue 3290 MAX-ACCESS read-create 3291 STATUS current 3292 DESCRIPTION 3293 "Indicates if the scrambler is employed." 3294 REFERENCE 3295 "Document [25] from References, Table 8-19." 3296 DEFVAL { false } 3297 ::= { docsIfCmtsModulationEntry 13 } 3299 docsIfCmtsModByteInterleaverDepth OBJECT-TYPE 3300 SYNTAX Unsigned32 3301 MAX-ACCESS read-create 3302 STATUS current 3303 DESCRIPTION 3304 " ATDMA Byte Interleaver Depth (Ir). This object returns 1 for 3305 non ATDMA profiles. " 3306 REFERENCE 3307 "Document [25] from References, Table 8-19." 3308 DEFVAL { 1 } 3309 ::= { docsIfCmtsModulationEntry 14 } 3311 docsIfCmtsModByteInterleaverBlockSize OBJECT-TYPE 3312 SYNTAX Unsigned32 3313 MAX-ACCESS read-create 3314 STATUS current 3315 DESCRIPTION 3316 " ATDMA Byte Interleaver Block size (Br). This object returns 3317 zero for non ATDMA profiles " 3318 REFERENCE 3319 "Document [25] from References, Table 8-19." 3320 DEFVAL { 18 } 3321 ::= { docsIfCmtsModulationEntry 15 } 3323 docsIfCmtsModPreambleType OBJECT-TYPE 3324 SYNTAX INTEGER { 3325 qpsk0(1), 3326 qpsk1(2) 3327 } 3328 MAX-ACCESS read-create 3329 STATUS current 3330 DESCRIPTION 3331 "Preamble type for DOCSIS 2.0 bursts" 3333 REFERENCE 3334 "Document [25] from References, Table 8-19." 3335 DEFVAL { qpsk0 } 3336 ::= { docsIfCmtsModulationEntry 16 } 3338 docsIfCmtsModTcmErrorCorrectionOn OBJECT-TYPE 3339 SYNTAX TruthValue 3340 MAX-ACCESS read-create 3341 STATUS current 3342 DESCRIPTION 3343 " Trellis Code Modulation (TCM) On/Off. This value returns false for 3344 non S-CDMA profiles." 3345 REFERENCE 3346 "Document [25] from References, Table 8-19." 3347 DEFVAL { false } 3348 ::= { docsIfCmtsModulationEntry 17 } 3350 docsIfCmtsModScdmaInterleaverStepSize OBJECT-TYPE 3351 SYNTAX Unsigned32 (0 | 1..32) 3352 MAX-ACCESS read-create 3353 STATUS current 3354 DESCRIPTION 3355 " S-CDMA Interleaver step size. This value returns zero 3356 for non S-CDMA profiles." 3357 REFERENCE 3358 "Document [25] from References, Table 8-19." 3360 DEFVAL { 1 } 3361 ::= { docsIfCmtsModulationEntry 18 } 3363 docsIfCmtsModScdmaSpreaderEnable OBJECT-TYPE 3364 SYNTAX TruthValue 3365 MAX-ACCESS read-create 3366 STATUS current 3367 DESCRIPTION 3368 " S-CDMA spreader. This value returns false for non S-CDMA 3369 profiles. Default value for IUC 3 and 4 is OFF, for 3370 all other IUCs it is ON." 3371 REFERENCE 3372 "Document [25] from References, Table 8-19." 3373 ::= { docsIfCmtsModulationEntry 19 } 3375 docsIfCmtsModScdmaSubframeCodes OBJECT-TYPE 3376 SYNTAX Unsigned32 (0 | 1..128) 3377 MAX-ACCESS read-create 3378 STATUS current 3379 DESCRIPTION 3380 " S-CDMA sub-frame size. This value returns zero 3381 for non S-CDMA profiles." 3382 REFERENCE 3383 "Document [25] from References, Table 8-19." 3384 DEFVAL { 1 } 3385 ::= { docsIfCmtsModulationEntry 20 } 3387 docsIfCmtsModChannelType OBJECT-TYPE 3388 SYNTAX DocsisUpstreamType 3389 MAX-ACCESS read-create 3390 STATUS current 3391 DESCRIPTION 3392 "Describes the modulation channel type for this modulation entry." 3393 REFERENCE 3394 "Document [25] from References, Table 8-19." 3395 DEFVAL { tdma } 3396 ::= { docsIfCmtsModulationEntry 21 } 3398 docsIfCmtsQosProfilePermissions OBJECT-TYPE 3399 SYNTAX BITS { 3400 createByManagement(0), 3401 updateByManagement(1), 3402 createByModems(2) 3403 } 3404 MAX-ACCESS read-write 3405 STATUS current 3406 DESCRIPTION 3407 "This object specifies permitted methods of creating 3408 entries in docsIfQosProfileTable. 3409 CreateByManagement(0) is set if entries can be created 3410 using SNMP. UpdateByManagement(1) is set if updating 3411 entries using SNMP is permitted. CreateByModems(2) 3412 is set if entries can be created based on information 3413 in REG-REQ MAC messages received from Cable Modems. 3414 Information in this object is only applicable if 3415 docsIfQosProfileTable is implemented as read-create. 3416 Otherwise, this object is implemented as read-only 3417 and returns CreateByModems(2). 3418 Either CreateByManagement(0) or CreateByModems(1) 3419 must be set when writing to this object. 3420 Note that BITS objects are encoded most significant bit 3421 first. For example, if bit 2 is set, the value of this 3422 object is the octet string '20'H." 3423 ::= { docsIfCmtsObjects 6 } 3425 docsIfCmtsMacToCmTable OBJECT-TYPE 3426 SYNTAX SEQUENCE OF DocsIfCmtsMacToCmEntry 3427 MAX-ACCESS not-accessible 3428 STATUS current 3429 DESCRIPTION 3430 "This is a table to provide a quick access index into the 3431 docsIfCmtsCmStatusTable. There is exactly one row in this 3432 table for each row in the docsIfCmtsCmStatusTable. In 3433 general, the management station should use this table only 3434 to get a pointer into the docsIfCmtsCmStatusTable (which 3435 corresponds to the CM's RF interface MAC address), and 3436 should not iterate (e.g. GetNext through) this table." 3438 ::= { docsIfCmtsObjects 7 } 3440 docsIfCmtsMacToCmEntry OBJECT-TYPE 3441 SYNTAX DocsIfCmtsMacToCmEntry 3442 MAX-ACCESS not-accessible 3443 STATUS current 3444 DESCRIPTION 3445 "A row in the docsIfCmtsMacToCmTable. 3446 An entry in this table exists for each Cable Modem 3447 that is connected to the CMTS implementing this table." 3448 INDEX { docsIfCmtsCmMac } 3449 ::= {docsIfCmtsMacToCmTable 1 } 3451 DocsIfCmtsMacToCmEntry ::= SEQUENCE { 3452 docsIfCmtsCmMac MacAddress, 3453 docsIfCmtsCmPtr Integer32 3454 } 3456 docsIfCmtsCmMac OBJECT-TYPE 3457 SYNTAX MacAddress 3458 MAX-ACCESS not-accessible 3459 STATUS current 3460 DESCRIPTION 3461 "The RF side MAC address for the referenced CM. (E.g. the 3462 interface on the CM that has docsCableMacLayer(127) as 3463 its ifType." 3464 ::= { docsIfCmtsMacToCmEntry 1 } 3466 docsIfCmtsCmPtr OBJECT-TYPE 3467 SYNTAX Integer32 (1..2147483647) 3468 MAX-ACCESS read-only 3469 STATUS current 3470 DESCRIPTION 3471 "An row index into docsIfCmtsCmStatusTable. When queried 3472 with the correct instance value (e.g. a CM's MAC address), 3473 returns the index in docsIfCmtsCmStatusTable which 3474 represents that CM." 3475 ::= { docsIfCmtsMacToCmEntry 2 } 3477 -- 3478 -- notification group is for future extension. 3479 -- 3481 docsIfNotification OBJECT IDENTIFIER ::= { docsIfMib 2 } 3483 docsIfConformance OBJECT IDENTIFIER ::= { docsIfMib 3 } 3484 docsIfCompliances OBJECT IDENTIFIER ::= { docsIfConformance 1 } 3485 docsIfGroups OBJECT IDENTIFIER ::= { docsIfConformance 2 } 3487 -- compliance statements 3488 docsIfBasicCompliance MODULE-COMPLIANCE 3489 STATUS current 3490 DESCRIPTION 3491 "The compliance statement for devices that implement 3492 MCNS/DOCSIS compliant Radio Frequency Interfaces." 3494 MODULE -- docsIfMib 3496 -- unconditionally mandatory groups 3497 MANDATORY-GROUPS { 3498 docsIfBasicGroup 3499 } 3501 -- conditionally mandatory group 3502 GROUP docsIfCmGroup 3503 DESCRIPTION 3504 "This group is implemented only in Cable Modems, not in 3505 Cable Modem Termination Systems." 3506 -- conditionally mandatory group 3507 GROUP docsIfCmtsGroup 3508 DESCRIPTION 3509 "This group is implemented only in Cable Modem Termination 3510 Systems, not in Cable Modems." 3512 OBJECT docsIfDownChannelFrequency 3513 WRITE-SYNTAX Integer32 (47000000..862000000) 3514 MIN-ACCESS read-only 3515 DESCRIPTION 3516 "Read-write in Cable Modem Termination Systems; 3517 read-only in Cable Modems. 3518 A range of 54MHz to 860MHz is appropriate for a cable 3519 plant using a North American Sub-Split channel plan. 3520 The spectrum range has been expanded to accommodate 3521 a lower edge of 47MHz and an upper edge of 862MHz 3522 for some European channel plans. 3523 If DOCSIS is extended to cover other types of channel 3524 plans (and frequency allocations) this object will be 3525 modified accordingly." 3527 OBJECT docsIfDownChannelWidth 3528 WRITE-SYNTAX Integer32 (6000000 | 8000000) 3529 MIN-ACCESS read-only 3530 DESCRIPTION 3531 "It is conformant to implement this object as read-only. 3532 In Cable Modems, this object is always implemented as 3533 read-only. The value of 6 MHz is appropriate for cable 3534 plants running under NTSC (National Television 3535 Standards Committee) standards. The value of 8 MHz is 3536 appropriate for cable plants running under ETSI 3537 standards. For other regional standards, this 3538 object will be modified accordingly." 3540 OBJECT docsIfDownChannelModulation 3541 WRITE-SYNTAX INTEGER { 3542 qam64 (3), 3543 qam256 (4) 3544 } 3545 MIN-ACCESS read-only 3546 DESCRIPTION 3547 "Read-write in Cable Modem Termination Systems; 3548 read-only in Cable Modems." 3550 OBJECT docsIfDownChannelInterleave 3551 WRITE-SYNTAX INTEGER { 3552 taps8Increment16(3), 3553 taps16Increment8(4), 3554 taps32Increment4(5), 3555 taps64Increment2(6), 3556 taps128Increment1(7), 3557 taps12increment17(8) 3558 } 3559 MIN-ACCESS read-only 3560 DESCRIPTION 3561 "Read-write in Cable Modem Termination Systems; 3562 read-only in Cable Modems." 3564 OBJECT docsIfDownChannelPower 3565 MIN-ACCESS read-only 3566 DESCRIPTION 3567 "Read-write in Cable Modem Termination Systems; 3568 read-only in Cable Modems." 3570 OBJECT docsIfUpChannelFrequency 3571 WRITE-SYNTAX Integer32 (5000000..65000000) 3572 MIN-ACCESS read-only 3573 DESCRIPTION 3574 "Read-write in Cable Modem Termination Systems; 3575 read-only in Cable Modems. 3576 A range of 5MHz to 42MHz is appropriate for a cable 3577 plant using a North American Sub-Split channel plan. 3578 The spectrum range has been expanded to accommodate 3579 an upper edge of 65MHz for some European channel plans. 3580 If DOCSIS is extended to cover other types of channel 3581 plans (and frequency allocations) this object will 3582 be modified accordingly." 3584 OBJECT docsIfUpChannelWidth 3585 WRITE-SYNTAX Integer32 (200000..3200000) 3586 MIN-ACCESS read-only 3587 DESCRIPTION 3588 "Read-write in Cable Modem Termination Systems; 3589 read-only in Cable Modems. The above value is appropriate 3590 for cable plants running under NTSC (National Television 3591 Standards Committee) standards. If DOCSIS is extended to 3592 work with other standard (e.g. European standards), this 3593 object will be modified accordingly." 3595 OBJECT docsIfUpChannelModulationProfile 3596 MIN-ACCESS read-only 3597 DESCRIPTION 3598 "Read-write in Cable Modem Termination Systems; 3599 read-only in Cable Modems." 3601 OBJECT docsIfUpChannelSlotSize 3602 MIN-ACCESS read-only 3603 DESCRIPTION 3604 "This object is always read-only in Cable Modems. 3605 It is compliant to implement this object as read-only 3606 in Cable Modem Termination Systems." 3608 OBJECT docsIfUpChannelRangingBackoffStart 3609 MIN-ACCESS read-only 3610 DESCRIPTION 3611 "Read-write in Cable Modem Termination Systems; 3612 read-only in Cable Modems." 3614 OBJECT docsIfUpChannelRangingBackoffEnd 3615 MIN-ACCESS read-only 3616 DESCRIPTION 3617 "Read-write in Cable Modem Termination Systems; 3618 read-only in Cable Modems." 3620 OBJECT docsIfUpChannelTxBackoffStart 3621 MIN-ACCESS read-only 3622 DESCRIPTION 3623 "Read-write in Cable Modem Termination Systems; 3624 read-only in Cable Modems." 3626 OBJECT docsIfUpChannelTxBackoffEnd 3627 MIN-ACCESS read-only 3628 DESCRIPTION 3629 "Read-write in Cable Modem Termination Systems; 3630 read-only in Cable Modems." 3632 OBJECT docsIfUpChannelScdmaActiveCodes 3633 MIN-ACCESS read-only 3634 DESCRIPTION 3635 "This object is always read-only in Cable Modems." 3637 OBJECT docsIfUpChannelScdmaCodesPerSlot 3638 MIN-ACCESS read-only 3639 DESCRIPTION 3640 "Read-write in Cable Modem Termination Systems; 3641 read-only in Cable Modems." 3643 OBJECT docsIfUpChannelScdmaFrameSize 3644 MIN-ACCESS read-only 3645 DESCRIPTION 3646 "Read-write in Cable Modem Termination Systems; 3647 read-only in Cable Modems." 3649 OBJECT docsIfUpChannelScdmaHoppingSeed 3650 MIN-ACCESS read-only 3651 DESCRIPTION 3652 "This object is always read-only in Cable Modems." 3654 OBJECT docsIfUpChannelType 3655 MIN-ACCESS read-only 3656 DESCRIPTION 3657 "Read-write in Cable Modem Termination Systems; 3658 read-only in Cable Modems." 3660 OBJECT docsIfQosProfPriority 3661 MIN-ACCESS read-only 3662 DESCRIPTION 3663 "This object is always read-only in Cable Modems. 3664 It is compliant to implement this object as read-only 3665 in Cable Modem Termination Systems." 3667 OBJECT docsIfQosProfMaxUpBandwidth 3668 MIN-ACCESS read-only 3669 DESCRIPTION 3670 "This object is always read-only in Cable Modems. 3671 It is compliant to implement this object as read-only 3672 in Cable Modem Termination Systems." 3674 OBJECT docsIfQosProfGuarUpBandwidth 3675 MIN-ACCESS read-only 3676 DESCRIPTION 3677 "This object is always read-only in Cable Modems. 3678 It is compliant to implement this object as read-only 3679 in Cable Modem Termination Systems." 3681 OBJECT docsIfQosProfMaxDownBandwidth 3682 MIN-ACCESS read-only 3683 DESCRIPTION 3684 "This object is always read-only in Cable Modems. 3685 It is compliant to implement this object as read-only 3686 in Cable Modem Termination Systems." 3688 OBJECT docsIfQosProfBaselinePrivacy 3689 MIN-ACCESS read-only 3690 DESCRIPTION 3691 "This object is always read-only in Cable Modems. 3692 It is compliant to implement this object as read-only 3693 in Cable Modem Termination Systems." 3695 OBJECT docsIfQosProfStatus 3696 MIN-ACCESS read-only 3697 DESCRIPTION 3698 "This object is always read-only in Cable Modems. 3699 It is compliant to implement this object as read-only 3700 in Cable Modem Termination Systems." 3702 OBJECT docsIfQosProfMaxTransmitBurst 3703 MIN-ACCESS read-only 3704 DESCRIPTION 3705 "This object is always read-only in Cable Modems. 3706 It is compliant to implement this object as read-only 3707 in Cable Modem Termination Systems." 3709 OBJECT docsIfCmtsServiceAdminStatus 3710 MIN-ACCESS read-only 3711 DESCRIPTION 3712 "It is compliant to implement this object as read-only." 3714 OBJECT docsIfCmtsSyncInterval 3715 MIN-ACCESS read-only 3716 DESCRIPTION 3717 "It is compliant to implement this object as read-only." 3719 OBJECT docsIfCmtsUcdInterval 3720 MIN-ACCESS read-only 3721 DESCRIPTION 3722 "It is compliant to implement this object as read-only." 3724 OBJECT docsIfCmtsInsertInterval 3725 MIN-ACCESS read-only 3726 DESCRIPTION 3727 "It is compliant to implement this object as read-only." 3729 OBJECT docsIfCmtsInvitedRangingAttempts 3730 MIN-ACCESS read-only 3731 DESCRIPTION 3732 "It is compliant to implement this object as read-only." 3734 OBJECT docsIfCmtsQosProfilePermissions 3735 MIN-ACCESS read-only 3736 DESCRIPTION 3737 "It is compliant to implement this object as read-only." 3739 ::= { docsIfCompliances 1 } 3741 docsIfBasicGroup OBJECT-GROUP 3742 OBJECTS { 3743 docsIfDownChannelId, 3744 docsIfDownChannelFrequency, 3745 docsIfDownChannelWidth, 3746 docsIfDownChannelModulation, 3747 docsIfDownChannelInterleave, 3748 docsIfDownChannelPower, 3749 docsIfDownChannelAnnex, 3750 docsIfUpChannelId, 3751 docsIfUpChannelFrequency, 3752 docsIfUpChannelWidth, 3753 docsIfUpChannelModulationProfile, 3754 docsIfUpChannelSlotSize, 3755 docsIfUpChannelTxTimingOffset, 3756 docsIfUpChannelRangingBackoffStart, 3757 docsIfUpChannelRangingBackoffEnd, 3758 docsIfUpChannelTxBackoffStart, 3759 docsIfUpChannelTxBackoffEnd, 3760 docsIfUpChannelScdmaActiveCodes, 3761 docsIfUpChannelScdmaCodesPerSlot, 3762 docsIfUpChannelScdmaFrameSize, 3763 docsIfUpChannelScdmaHoppingSeed, 3764 docsIfUpChannelType, 3765 docsIfQosProfPriority, 3766 docsIfQosProfMaxUpBandwidth, 3767 docsIfQosProfGuarUpBandwidth, 3768 docsIfQosProfMaxDownBandwidth, 3769 docsIfQosProfBaselinePrivacy, 3770 docsIfQosProfStatus, 3771 docsIfQosProfMaxTransmitBurst, 3772 docsIfSigQIncludesContention, 3773 docsIfSigQUnerroreds, 3774 docsIfSigQCorrecteds, 3775 docsIfSigQUncorrectables, 3776 docsIfSigQSignalNoise, 3777 docsIfSigQMicroreflections, 3778 docsIfSigQEqualizationData, 3779 docsIfDocsisBaseCapability 3780 } 3781 STATUS current 3782 DESCRIPTION 3783 "Group of objects implemented in both Cable Modems and 3784 Cable Modem Termination Systems." 3785 ::= { docsIfGroups 1 } 3787 docsIfCmGroup OBJECT-GROUP 3788 OBJECTS { 3789 docsIfCmCmtsAddress, 3790 docsIfCmCapabilities, 3791 docsIfCmRangingTimeout, 3792 -- docsIfCmRangingRespTimeout, 3793 docsIfCmStatusValue, 3794 docsIfCmStatusCode, 3795 docsIfCmStatusTxPower, 3796 docsIfCmStatusResets, 3797 docsIfCmStatusLostSyncs, 3798 docsIfCmStatusInvalidMaps, 3799 docsIfCmStatusInvalidUcds, 3800 docsIfCmStatusInvalidRangingResponses, 3801 docsIfCmStatusInvalidRegistrationResponses, 3802 docsIfCmStatusT1Timeouts, 3803 docsIfCmStatusT2Timeouts, 3804 docsIfCmStatusT3Timeouts, 3805 docsIfCmStatusT4Timeouts, 3806 docsIfCmStatusRangingAborteds, 3807 docsIfCmStatusDocsisOperMode, 3808 docsIfCmStatusModulationType, 3809 docsIfCmServiceQosProfile, 3810 docsIfCmServiceTxSlotsImmed, 3811 docsIfCmServiceTxSlotsDed, 3812 docsIfCmServiceTxRetries, 3813 docsIfCmServiceTxExceededs, 3814 docsIfCmServiceRqRetries, 3815 docsIfCmServiceRqExceededs, 3816 docsIfCmServiceExtTxSlotsImmed, 3817 docsIfCmServiceExtTxSlotsDed 3819 } 3820 STATUS current 3821 DESCRIPTION 3822 "Group of objects implemented in Cable Modems." 3823 ::= { docsIfGroups 2 } 3825 docsIfCmtsGroup OBJECT-GROUP 3826 OBJECTS { 3827 docsIfCmtsCapabilities, 3828 docsIfCmtsSyncInterval, 3829 docsIfCmtsUcdInterval, 3830 docsIfCmtsMaxServiceIds, 3831 -- docsIfCmtsInsertionInterval, 3832 docsIfCmtsInvitedRangingAttempts, 3833 docsIfCmtsInsertInterval, 3834 docsIfCmtsStatusInvalidRangeReqs, 3835 docsIfCmtsStatusRangingAborteds, 3836 docsIfCmtsStatusInvalidRegReqs, 3837 docsIfCmtsStatusFailedRegReqs, 3838 docsIfCmtsStatusInvalidDataReqs, 3839 docsIfCmtsStatusT5Timeouts, 3840 docsIfCmtsCmStatusMacAddress, 3841 docsIfCmtsCmStatusDownChannelIfIndex, 3842 docsIfCmtsCmStatusUpChannelIfIndex, 3843 docsIfCmtsCmStatusRxPower, 3844 docsIfCmtsCmStatusTimingOffset, 3845 docsIfCmtsCmStatusEqualizationData, 3846 docsIfCmtsCmStatusValue, 3847 docsIfCmtsCmStatusUnerroreds, 3848 docsIfCmtsCmStatusCorrecteds, 3849 docsIfCmtsCmStatusUncorrectables, 3850 docsIfCmtsCmStatusSignalNoise, 3851 docsIfCmtsCmStatusMicroreflections, 3852 docsIfCmtsCmStatusExtUnerroreds, 3853 docsIfCmtsCmStatusExtCorrecteds, 3854 docsIfCmtsCmStatusExtUncorrectables, 3855 docsIfCmtsCmStatusDocsisRegMode, 3856 docsIfCmtsCmStatusModulationType, 3857 docsIfCmtsCmStatusInetAddressType, 3858 docsIfCmtsCmStatusInetAddress, 3859 docsIfCmtsServiceAdminStatus, 3860 docsIfCmtsServiceQosProfile, 3861 docsIfCmtsServiceCreateTime, 3862 docsIfCmtsServiceInOctets, 3863 docsIfCmtsServiceInPackets, 3864 docsIfCmtsServiceNewCmStatusIndex, 3865 docsIfCmtsModType, 3866 docsIfCmtsModControl, 3867 docsIfCmtsModPreambleLen, 3868 docsIfCmtsModDifferentialEncoding, 3869 docsIfCmtsModFECErrorCorrection, 3870 docsIfCmtsModFECCodewordLength, 3871 docsIfCmtsModScramblerSeed, 3872 docsIfCmtsModMaxBurstSize, 3873 docsIfCmtsModGuardTimeSize, 3874 docsIfCmtsModLastCodewordShortened, 3875 docsIfCmtsModScrambler, 3876 docsIfCmtsModByteInterleaverDepth, 3877 docsIfCmtsModByteInterleaverBlockSize, 3878 docsIfCmtsModPreambleType, 3879 docsIfCmtsModTcmErrorCorrectionOn, 3880 docsIfCmtsModScdmaInterleaverStepSize, 3881 docsIfCmtsModScdmaSpreaderEnable, 3882 docsIfCmtsModScdmaSubframeCodes, 3883 docsIfCmtsModChannelType, 3884 docsIfCmtsQosProfilePermissions, 3885 docsIfCmtsCmPtr 3886 } 3887 STATUS current 3888 DESCRIPTION 3889 "Group of objects implemented in Cable Modem Termination 3890 Systems." 3891 ::= { docsIfGroups 3 } 3893 docsIfObsoleteGroup OBJECT-GROUP 3894 OBJECTS { 3895 docsIfCmRangingRespTimeout, 3896 docsIfCmtsInsertionInterval 3897 } 3898 STATUS obsolete 3899 DESCRIPTION 3900 "Group of objects obsoleted." 3901 ::= { docsIfGroups 4 } 3903 docsIfDeprecatedGroup OBJECT-GROUP 3904 OBJECTS { 3905 docsIfQosProfMaxTxBurst, 3906 docsIfCmtsCmStatusIpAddress, 3907 docsIfCmtsServiceCmStatusIndex 3908 } 3909 STATUS deprecated 3910 DESCRIPTION 3911 "Group of objects deprecated." 3912 ::= { docsIfGroups 5 } 3914 END 3916 5. Acknowledgments 3917 This document is a production of the Docsis 2.0 OSS Working Group. 3918 It is a revision based on RFC2670, "Radio Frequency (RF) Interface 3919 Management Information Base for DOCSIS compliant RF interfaces" [22]. 3921 The current editors wish to express gratitude to Rich Prodan, Greg 3922 Nakanishi, Rich Woundy, Eduardo Cardona, and Adi Shaliv for their 3923 valued advice and opinions. 3925 6. Revision History 3927 6.1. Scope 3929 This MIB in this document has been developed to accommodate DOCSIS 2.0 devices 3930 and their system capabilities. The MIB is an update to RFC2670 with the 3931 additional incorporation of EuroDocsis specific items and the DOCS_IF_EXT mib. 3933 6.2. Extension 3935 We have maintained the MIB objects as defined in RFC 2670. In some cases new mib 3936 objects have been created with identical functionality but greater capacity (ie 3937 32 to 64 bits). In these situations, both the original 32 bit objects and the new 3938 64 bit objects must be implemented. 3940 7. References 3942 [1] Harrington, D., Presuhn, R. and B. Wijnen, "An Architecture for 3943 Describing SNMP Management Frameworks", RFC 2571, April 1999. 3945 [2] Rose, M. and K. McCloghrie, "Structure and Identification of 3946 Management Information for TCP/IP-based Internets", STD 16, RFC 3947 1155, May 1990. 3949 [3] Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16, 3950 RFC 1212, March 1991. 3952 [4] Rose, M., "A Convention for Defining Traps for use with the 3953 SNMP", RFC 1215, March 1991. 3955 [5] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Structure of 3956 Management Information for Version 2 (SMIv2)", STD 58, RFC 2578, 3957 April 1999. 3959 [6] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Textual 3960 Conventions for SMIv2", STD 58, RFC 2579, April 1999. 3962 [7] McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Conformance 3963 Statements for SMIv2", STD 58, RFC 2580, April 1999. 3965 [8] Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple 3966 Management Protocol", STD 15, RFC 1157, May 1990. 3968 [9] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, 3969 "Introduction to Community-based SNMPv2", RFC 1901, January 3970 1996. 3972 [10] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Transport 3973 Mappings for Version 2 of the Simple Network Management Protocol 3974 (SNMPv2)", RFC 1906, January 1996. 3976 [11] Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message 3977 Processing and Dispatching for the Simple Network Management 3978 Protocol (SNMP)", RFC 2572, April 1999. 3980 [12] Blumenthal, U. and B. Wijnen, "User-based Security Model (USM) 3981 for version 3 of the Simple Network Management Protocol 3982 (SNMPv3)", RFC 2574, April 1999. 3984 [13] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Protocol 3985 Operations for Version 2 of the Simple Network Management 3986 Protocol (SNMPv2)", RFC 1905, January 1996. 3988 [14] Levi, D., Meyer, P. and B. Stewart, "SNMP Applications", RFC 3989 2573, April 1999. 3991 [15] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access 3992 Control Model (VACM) for the Simple Network Management Protocol 3993 (SNMP)", RFC 2575, April 1999. 3995 [16] "Data-Over-Cable Service Interface Specifications: Cable 3996 Modem Radio Frequency Interface Specification SP-RFI-I05-991105", 3997 DOCSIS, November 1999, http://www.cablemodem.com/. 3999 [17] McCloghrie, K. and F. Kastenholz, "The Interfaces Group MIB 4000 using SMIv2", RFC 2863, June 2000. 4002 [18] StJohns, M. , "Cable Device Management Information Base for 4003 DOCSIS Compliant Cable Modems and Cable Modem Termination 4004 Systems", RFC2669, August 1999. 4006 [19] Proakis, John G., "Digital Communications, 3rd Edition", 4007 McGraw-Hill, New York, New York, 1995, ISBN 0-07-051726-6 4009 [20] "Transmission Systems for Interactive Cable Television Services, 4010 Annex B", J.112, International Telecommunications Union, March 4011 1998. 4013 [21] Case, J., Mundy, R., Partain, D., and B. Stewart, 4014 "Introduction to Version 3 of the Internet-standard Network Management 4015 Framework", RFC 2570, April 1999. 4017 [22] StJohns, M., "Radio Frequency (RF) Interface Management 4018 Information Base for MCNS/DOCSIS compliant RF interfaces", 4019 RFC 2670, August 1999. 4021 [23] "Data-Over-Cable Service Interface Specifications: Cable 4022 Modem Radio Frequency Interface Specification SP-RFIv1.1-I06- 4023 001215", DOCSIS, December 2000, http://www.cablemodem.com/. 4025 [24] "Document for the certification of EuroDOCSIS CMs and CMTSs, 4026 Version 3.3", EuroDOCSIS, February 2000. 4028 [25] "Data-Over-Cable Service Interface Specifications: Radio Frequency 4029 Interface Specification SP-RFIv2.0-W04-011119", DOCSIS 2.0 4030 November 2001. 4032 [26] "Data-Over-Cable Service Interface Specifications: Operations 4033 Support System Interface Specification SP-OSSIv2.0-W01-011119", 4034 DOCSIS 2.0 November 2001. 4036 [27] Woundy, R., "Baseline Privacy Interface Management 4037 Information Base for DOCSIS Compliant Cable Modems 4038 and Cable Modem Termination Systems", RFC3083, March 2001. 4040 [28] "Adapted MIB-definitions and a clarification for MPEG-related 4041 issues for EuroDOCSIS cable modem systems v1.01", tComLabs, 4042 May 2000. 4044 8. Security Considerations 4046 This MIB relates to a system which will provide metropolitan public 4047 internet access. As such, improper manipulation of the objects 4048 represented by this MIB may result in denial of service to a large 4049 number of end-users. In addition, manipulation of the 4050 docsIfCmServiceQosProfile, docsIfCmtsServerQosProfile, and the 4051 elements of docsIfQosProfileTable and docsIfCmtsModulationTable may 4052 allow an end-user to improve their service response or diminish other 4053 subscriber's service response. 4055 There are a number of management objects defined in this MIB that 4056 have a MAX-ACCESS clause of read-write and/or read-create. Such 4057 objects may be considered sensitive or vulnerable in some network 4058 environments. The support for SET operations in a non-secure 4059 environment without proper protection can have a negative effect on 4060 network operations. 4062 SNMPv1 by itself is not a secure environment. Even if the network 4063 itself is secure (for example by using IPSec), even then, there is no 4064 control as to who on the secure network is allowed to access and 4065 GET/SET (read/change/create/delete) the objects in this MIB. 4067 It is recommended that the implementers consider the security 4068 features as provided by the SNMPv3 framework. Specifically, the use 4069 of the User-based Security Model RFC 2574 [12] and the View- based 4070 Access Control Model RFC 2575 [15] is recommended. 4072 It is then a customer/user responsibility to ensure that the SNMP 4073 entity giving access to an instance of this MIB, is properly 4074 configured to give access to the objects only to those principals 4075 (users) that have legitimate rights to indeed GET or SET 4076 (change/create/delete) them. 4078 9. Changes from RFC2670 4080 Upstream now separated into 'physical interfaces' and 'logical channels'. An 4081 instance of the docsIfUpstreamChannelTable exists for each 'logical channel'. 4082 The IANA ifType for 'logical channels' is 205. The IANA ifType for 'physical 4083 interfaces' remains at 129. 4085 Object docsIfDownChannelAnnex added to docsIfDownstreamChannelTable. This object 4086 originated in the EuroDocsis specifications. 4088 Five new objects added to the docsIfUpstreamChannelTable. One describes the 4089 channel type in use, while four are specific S-CDMA parameters. 4091 Object docsIfQosProfMaxTransmitBurst has been added to the docsIfQosProfileTable 4092 to replace deprecated object docsIfQosProfMaxTxBurst. This fixes a range error 4093 caused by switch to recording as bytes instead of minislots. 4095 A new base object docsIfDocsisBaseCapability has been added which mirrors the 4096 functionality of the docsifExt mib object docsIfDocsisCapability, extended to 4097 include Docsis 2.0. 4099 Two new objects added to the docsIfCmStatusTable. One indicates the current 4100 modulation type, while the other mirrors the functionality of the docsIfExt 4101 object docsIfDocsisOperMode. 4103 Two new 64 bit counters added to the docsIfCmServiceTable to extend the capacity 4104 of existing 32 bit counters. 4106 Seven new objects added to the docsIfCmtsCmStatusTable. Three are 64 bit 4107 counters, two add ipv6 capability, one mirrors a docsIfExt object (extended to 4108 include Docsis 2.0), and one indicates the CM modulation type in use. 4110 One object added to the docsIfCmtsServiceTable to fix a range error in an 4111 existing object, that has been deprecated. 4113 Eight new objects added to the docsIfCmtsModulationTable. Seven of these 4114 describe ATDMA/S-CDMA channel parameters, while the other describes modulation 4115 attributes common to all modulation types. 4117 Enumerated values for object docsIfDownChannelInterleave have been expanded to 4118 include a EuroDocsis value. 4120 Enumerated values for object docsIfCmtsModIntervalUsageCode have been expanded 4121 to include new Docsis 2.0 values. 4123 Enumerated values for object docsIfCmtsModType have been expanded to include new 4124 Docsis 2.0 values. 4126 Compliance statements have been updated to reflect new objects and to describe 4127 EuroDocsis specific implementation features. 4129 10. Intellectual Property 4131 The IETF takes no position regarding the validity or scope of any 4132 intellectual property or other rights that might be claimed to 4133 pertain to the implementation or use of the technology described in 4134 this document or the extent to which any license under such rights 4135 might or might not be available; neither does it represent that it 4136 has made any effort to identify any such rights. Information on the 4137 IETF's procedures with respect to rights in standards-track and 4138 standards-related documentation can be found in BCP-11. Copies of 4139 claims of rights made available for publication and any assurances of 4140 licenses to be made available, or the result of an attempt made to 4141 obtain a general license or permission for the use of such 4142 proprietary rights by implementers or users of this specification can 4143 be obtained from the IETF Secretariat. 4145 The IETF invites any interested party to bring to its attention any 4146 copyrights, patents or patent applications, or other proprietary 4147 rights that may cover technology that may be required to practice 4148 this standard. Please address the information to the IETF Executive 4149 Director. 4151 11. Authors' Addresses 4153 Aviv Goren 4154 Terayon 4155 2952 Bunker Hill Lane 4156 Santa Clara, CA 4157 U.S.A. 4158 Phone: +1 408 727 4400 4159 E-mail: aviv.goren@terayon.com 4161 David Raftus 4162 Imedia Semiconductor 4163 340 Terry Fox Drive, Suite 202 4164 Ottawa Ontario 4165 Canada 4166 Phone: +1 613 592 1052 4167 E-mail: david.raftus@imedia.com 4169 12. Full Copyright Statement 4171 Copyright (C) The Internet Society (2001). All Rights Reserved. 4173 This document and translations of it may be copied and furnished to 4174 others, and derivative works that comment on or otherwise explain it 4175 or assist in its implementation may be prepared, copied, published 4176 and distributed, in whole or in part, without restriction of any 4177 kind, provided that the above copyright notice and this paragraph are 4178 included on all such copies and derivative works. However, this 4179 document itself may not be modified in any way, such as by removing 4180 the copyright notice or references to the Internet Society or other 4181 Internet organizations, except as needed for the purpose of 4182 developing Internet standards in which case the procedures for 4183 copyrights defined in the Internet Standards process must be 4184 followed, or as required to translate it into languages other than 4185 English. 4187 The limited permissions granted above are perpetual and will not be 4188 revoked by the Internet Society or its successors or assigns. 4190 This document and the information contained herein is provided on an 4191 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING 4192 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING 4193 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION 4194 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF 4195 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. 4197 Acknowledgement 4199 Funding for the RFC Editor function is currently provided by the 4200 Internet Society.