idnits 2.17.1 draft-ietf-ipcdn-cable-device-mib-03.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- ** Cannot find the required boilerplate sections (Copyright, IPR, etc.) in this document. Expected boilerplate is as follows today (2024-04-18) according to https://trustee.ietf.org/license-info : IETF Trust Legal Provisions of 28-dec-2009, Section 6.a: This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 2: Copyright (c) 2024 IETF Trust and the persons identified as the document authors. All rights reserved. IETF Trust Legal Provisions of 28-dec-2009, Section 6.b(i), paragraph 3: This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (https://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- ** Missing document type: Expected "INTERNET-DRAFT" in the upper left hand corner of the first page ** Missing expiration date. The document expiration date should appear on the first and last page. ** The document seems to lack a 1id_guidelines paragraph about Internet-Drafts being working documents. ** The document seems to lack a 1id_guidelines paragraph about 6 months document validity -- however, there's a paragraph with a matching beginning. Boilerplate error? ** The document seems to lack a 1id_guidelines paragraph about the list of current Internet-Drafts. ** The document seems to lack a 1id_guidelines paragraph about the list of Shadow Directories. == No 'Intended status' indicated for this document; assuming Proposed Standard Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- ** The document seems to lack an IANA Considerations section. (See Section 2.2 of https://www.ietf.org/id-info/checklist for how to handle the case when there are no actions for IANA.) ** The document seems to lack separate sections for Informative/Normative References. All references will be assumed normative when checking for downward references. ** 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 165: '...e text. Vendors SHOULD provide time-o...' RFC 2119 keyword, line 195: '...The CM and CMTS MUST provide support f...' Miscellaneous warnings: ---------------------------------------------------------------------------- -- 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 () is 739376 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: '5' is defined on line 1510, but no explicit reference was found in the text ** Obsolete normative reference: RFC 1902 (ref. '1') (Obsoleted by RFC 2578) ** Downref: Normative reference to an Historic RFC: RFC 1157 (ref. '3') ** Obsolete normative reference: RFC 1905 (ref. '4') (Obsoleted by RFC 3416) ** Obsolete normative reference: RFC 1573 (ref. '5') (Obsoleted by RFC 2233) -- Possible downref: Non-RFC (?) normative reference: ref. '6' ** Downref: Normative reference to an Experimental RFC: RFC 1224 (ref. '7') -- Possible downref: Non-RFC (?) normative reference: ref. '8' Summary: 15 errors (**), 0 flaws (~~), 2 warnings (==), 4 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Cable Device Management Information Base 2 for MCNS compliant Cable Modems and 3 Cable Modem Termination Systems 4 draft-ietf-ipcdn-cable-device-mib-03.txt 6 Tue Mar 3 15:28:46 PST 1998 8 Guenter Roeck (editor) 9 cisco Systems 10 groeck@cisco.com 12 Status of this Memo 14 This document is an Internet-Draft. Internet-Drafts are working 15 documents of the Internet Engineering Task Force (IETF), its Areas, and 16 its Working Groups. Note that other groups may also distribute working 17 documents as Internet-Drafts. 19 Internet-Drafts are draft documents valid for a maximum of six months 20 and may be updated, replaced, or obsoleted by other documents at any 21 time. It is inappropriate to use Internet-Drafts as reference material 22 or to cite them other than as a "work in progress". 24 To view the entire list of current Internet-Drafts, please check the 25 "1id-abstracts.txt" listing contained in the Internet-Drafts Shadow 26 Directories on ftp.is.co.za (Africa), ftp.nordu.net (Europe), 27 munnari.oz.au (Pacific Rim), ds.internic.net (US East Coast), or 28 ftp.isi.edu (US West Coast). 30 Abstract 32 This memo defines an experimental portion of the Management Information 33 Base (MIB) for use with network management protocols in the Internet 34 community. In particular, it defines a basic set of managed objects for 35 SNMP-based management of MCNS compliant Cable Modems and Cable Modem 36 Termination Systems. 38 This memo specifies a MIB module in a manner that is compliant to the 39 SNMPv2 SMI. The set of objects is consistent with the SNMP framework 40 and existing SNMP standards. 42 This memo does not specify a standard for the Internet community. 44 This memo is a product of the IPCDN working group within the Internet 45 Engineering Task Force. Comments are solicited and should be addressed 46 to the working group's mailing list at ipcdn@terayon.com and/or the 47 author. 49 Table of Contents 51 1 The SNMPv2 Network Management Framework ......................... 3 52 2 Object Definitions .............................................. 3 53 3 Overview ........................................................ 4 54 3.1 Structure of the MIB .......................................... 4 55 3.2 Management requirements ....................................... 4 56 3.2.1 Handling of Software upgrades ............................... 4 57 3.2.2 Events and Traps ............................................ 5 58 3.2.3 Trap Throttling ............................................. 6 59 3.2.3.1 Trap rate throttling ...................................... 6 60 3.2.3.2 Limiting the trap rate .................................... 6 61 3.3 Protocol Filters .............................................. 6 62 4 Definitions ..................................................... 7 63 5 Acknowledgments ................................................. 31 64 6 References ...................................................... 31 65 7 Security Considerations ......................................... 31 66 8 Author's Address ................................................ 32 67 1. The SNMPv2 Network Management Framework 69 The SNMPv2 Network Management Framework presently consists of three 70 major components. They are: 72 o the SMI, described in RFC 1902 [1] - the mechanisms used for 73 describing and naming objects for the purpose of management. 75 o the MIB-II, STD 17, RFC 1213 [2] - the core set of managed objects 76 for the Internet suite of protocols. 78 o the protocol, RFC 1157 [3] and/or RFC 1905 [4], - the protocol for 79 accessing managed objects. 81 The Framework permits new objects to be defined for the purpose of 82 experimentation and evaluation. 84 2. Object Definitions 86 Managed objects are accessed via a virtual information store, termed the 87 Management Information Base or MIB. Objects in the MIB are defined 88 using the subset of Abstract Syntax Notation One (ASN.1) defined in the 89 SMI. In particular, each object type is named by an OBJECT IDENTIFIER, 90 an administratively assigned name. The object type together with an 91 object instance serves to uniquely identify a specific instantiation of 92 the object. For human convenience, we often use a textual string, 93 termed the descriptor, to refer to the object type. 95 3. Overview 97 This MIB provides a set of objects required for the management of MCNS 98 compliant Cable Modems (CM) and Cable Modem Termination Systems (CMTS). 99 The specification is derived from the MCNS Radio Frequency Interface 100 specification [6]. 102 3.1. Structure of the MIB 104 This MIB is structured in six groups: 106 o The docsDevBase group extends the MIB-II 'system' group with 107 objects needed for cable device system management. 109 o The docsDevNmAccessGroup provides a minimum level of SNMP access 110 security (see Section 3 of [8]). 112 o The docsDevSoftware group provides information for network- 113 downloadable software upgrades. 115 o The docsDevServer group provides information about the progress of 116 the interaction with various provisioning servers. 118 o The docsDevEvent group provides control and logging for event 119 reporting 121 o The docsDevFilter group configures filters at link layer and IP 122 layer for bridged data traffic. 124 3.2. Management requirements 126 3.2.1. Handling of Software upgrades 128 The Cable Modem software upgrade process is documented in [6]. From a 129 network management station, the operator: 131 o sets docsDevSwServer to the address of the TFTP server for software 132 upgrades 134 o sets docsDevSwFilename to the file pathname of the software upgrade 135 image 137 o sets docsDevSwAdminStatus to upgrade-from-mgt 139 One reason for the SNMP-initiated upgrade is to allow loading of a 140 temporary software image (e.g., special diagnostic software) that 141 differs from the software normally used on that device without changing 142 the provisioning database. 144 Note that software upgrades should not be accepted blindly by the cable 145 device. The cable device may refuse an upgrade if: 147 o The download is incomplete. 149 o The file contents are incomplete or damaged. 151 o The software is not intended for that hardware device (may include 152 the case of a feature set that has not been purchased for this 153 device). 155 3.2.2. Events and Traps 157 This MIB provides control facilities for reporting events through 158 syslog, traps, and nonvolatile logging. If events are reported through 159 traps, the specified conventions must be followed. Other means of event 160 reporting are outside the scope of this document. 162 The definition and coding of events is vendor-specific. In deference to 163 the network operator who must troubleshoot multi-vendor networks, the 164 circumstances and meaning of each event should be reported as human- 165 readable text. Vendors SHOULD provide time-of-day clocks in CMs to 166 provide useful timestamping of events. 168 For each vendor-specific event that is reportable via TRAP, the vendor 169 must create an enterprise-specific trap definition. Trap definitions 170 MUST include the event reason encoded as DisplayString and should be 171 defined as: 173 trapName NOTIFICATION-TYPE 174 OBJECTS { 175 ifIndex, 176 eventReason, 177 other useful objects 178 } 179 STATUS current 180 DESCRIPTION 181 "trap description" 182 ::= Object Id 184 Note that ifIndex is only included if the event or trap is interface 185 related. 187 The last digit of the trap OID for enterprise-specific traps must match 188 docsDevEvId. For SNMPv1-capable Network Management systems, this is 189 necessary to correlate the event type to the trap type. Many Network 190 Management systems are only capable of trap filtering on an enterprise 191 and single-last-digit basis. 193 3.2.3. Trap Throttling 195 The CM and CMTS MUST provide support for trap message throttling as 196 described below. The network operator can employ message rate 197 throttling or trap limiting by manipulating the appropriate MIB 198 variables. 200 3.2.3.1. Trap rate throttling 202 Network operators may employ either of two rate control methods. In the 203 first method, the device ceases to send traps when the rate exceeds the 204 specified maximum message rate. It resumes sending traps only if 205 reactivated by a network management station request. 207 In the second method, the device resumes sending traps when the rate 208 falls below the specified maximum message rate. 210 The network operator configures the specified maximum message rate by 211 setting the measurement interval (in seconds), and the maximum number of 212 traps to be transmitted within the measurement interval. The operator 213 can query the operational throttling state (to determine whether traps 214 are enabled or blocked by throttling) of the device, as well as query 215 and set the administrative throttling state (to manage the rate control 216 method) of the device. 218 3.2.3.2. Limiting the trap rate 220 Network operators may wish to limit the number of traps sent by a device 221 over a specified time period. The device ceases to send traps when the 222 number of traps exceeds the specified threshold. It resumes sending 223 traps only when the measurement interval has passed. 225 The network operator defines the maximum number of traps he is willing 226 to handle and sets the measurement interval to a large number (in 227 hundredths of a second). For this case, the administrative throttling 228 state is set to stop at threshold which is the maximum number of traps. 230 See "Techniques for Managing Asynchronously Generated Alerts" [7] for 231 further information. 233 3.3. Protocol Filters 235 The Cable Device MIB provides objects for both LLC and IP protocol 236 filters. The LLC protocol filter entries can be used to limit CM 237 forwarding to a restricted set of network-layer protocols (such as IP, 238 IPX, NetBIOS, and Appletalk). The IP protocol filter entries can be 239 used to restrict upstream or downstream traffic based on source and 240 destination IP addresses, transport-layer protocols (such as TCP, UDP, 241 and ICMP), and source and destination TCP/UDP port numbers. 243 4. Definitions 245 DOCS-CABLE-DEVICE-MIB DEFINITIONS ::= BEGIN 247 IMPORTS 248 MODULE-IDENTITY, 249 OBJECT-TYPE, 250 BITS, 251 IpAddress, 252 Unsigned32, 253 Integer32, 254 Counter32, 255 experimental 256 FROM SNMPv2-SMI 257 DisplayString, 258 RowStatus, 259 DateAndTime, 260 TruthValue, 261 TEXTUAL-CONVENTION 262 FROM SNMPv2-TC 263 OBJECT-GROUP, 264 MODULE-COMPLIANCE 265 FROM SNMPv2-CONF; 266 -- InterfaceIndexOrZero 267 -- FROM IF-MIB; 269 docsDevMIB MODULE-IDENTITY 270 LAST-UPDATED "9803031546Z" -- Mar 03, 1998 271 ORGANIZATION "IETF IPCDN Working Group" 272 CONTACT-INFO 273 " Guenter Roeck 274 Postal: cisco Systems 275 170 West Tasman Drive 276 San Jose, CA 95134 277 U.S.A. 278 Phone: +1 408 527 3143 279 E-mail: groeck@cisco.com" 280 DESCRIPTION 281 "This is the MIB Module for MCNS-compliant cable modems and 282 cable-modem termination systems." 283 ::= { experimental 999 } 284 -- Editor's note: This is not a valid assignment. Final value is TBD. 286 -- The following textual convention is from the 287 -- Interfaces MIB draft. It should go away once this 288 -- draft has been published as RFC. 290 InterfaceIndexOrZero ::= TEXTUAL-CONVENTION 291 DISPLAY-HINT "d" 292 STATUS current 293 DESCRIPTION 294 "This textual convention is an extension of the 295 InterfaceIndex convention. The latter defines a 296 greater than zero value used to identify an interface 297 or interface sub-layer in the managed system. This 298 extension permits the additional value of zero. the 299 value zero is object-specific and must therefore be 300 defined as part of the description of any object which 301 uses this syntax. Examples of the usage of zero might 302 include situations where interface was unknown, or 303 when none or all interfaces need to be referenced." 304 SYNTAX Integer32 (0..2147483647) 306 docsDevMIBObjects OBJECT IDENTIFIER ::= { docsDevMIB 1 } 307 docsDevBase OBJECT IDENTIFIER ::= { docsDevMIBObjects 1 } 309 -- 310 -- For the following object, there is no concept in the 311 -- RFI specification corresponding to a backup CMTS. The 312 -- enumeration is provided here in case someone is able 313 -- to define such a role or device. 314 -- 316 docsDevRole OBJECT-TYPE 317 SYNTAX INTEGER { 318 cm(1), 319 cmtsActive(2), 320 cmtsBackup(3) 321 } 322 MAX-ACCESS read-only 323 STATUS current 324 DESCRIPTION 325 "Defines the current role of this device." 326 ::= { docsDevBase 1 } 328 docsDevDateTime OBJECT-TYPE 329 SYNTAX DateAndTime 330 MAX-ACCESS read-write 331 STATUS current 332 DESCRIPTION 333 "The date and time, with optional timezone information." 334 ::= { docsDevBase 2 } 336 docsDevResetNow OBJECT-TYPE 337 SYNTAX TruthValue 338 MAX-ACCESS read-write 339 STATUS current 340 DESCRIPTION 341 "Setting this object to true(1) causes the device to reset. 342 Reading this object always returns false(2)." 343 ::= { docsDevBase 3 } 345 docsDevSerialNumber OBJECT-TYPE 346 SYNTAX DisplayString 347 MAX-ACCESS read-only 348 STATUS current 349 DESCRIPTION 350 "The manufacturer's serial number for this device." 351 ::= { docsDevBase 4 } 353 docsDevSTPControl OBJECT-TYPE 354 SYNTAX INTEGER { 355 stEnabled(1), 356 noStFilterBpdu(2), 357 noStPassBpdu(3) 358 } 359 MAX-ACCESS read-write 360 STATUS current 361 DESCRIPTION 362 "This object controls operation of the spanning tree 363 protocol (as distinguished from transparent bridging). 364 If set to stEnabled(1) then the spanning tree protocol 365 is enabled, subject to bridging constraints. If 366 noStFilterBpdu(2), then spanning tree is not active, 367 and Bridge PDUs received are discarded. 368 If noStPassBpdu(3) then spanning tree is not active 369 and Bridge PDUs are transparently forwarded. Note that 370 a device need not implement all of these options, 371 but that noStFilterBpdu(2) is required." 372 ::= { docsDevBase 5 } 374 -- 375 -- The following table provides one level of security for access 376 -- to the device by network management stations. 377 -- Note that access is also constrained by the 378 -- community strings and any vendor-specific security. 379 -- 381 docsDevNmAccessTable OBJECT-TYPE 382 SYNTAX SEQUENCE OF DocsDevNmAccessEntry 383 MAX-ACCESS not-accessible 384 STATUS current 385 DESCRIPTION 386 "This table controls access to SNMP objects by network 387 management stations. If the table is empty, access 388 to SNMP objects is unrestricted." 389 ::= { docsDevMIBObjects 2 } 391 docsDevNmAccessEntry OBJECT-TYPE 392 SYNTAX DocsDevNmAccessEntry 393 MAX-ACCESS not-accessible 394 STATUS current 395 DESCRIPTION 396 "Controls access to SNMP objects by a particular network 397 management station. For each entry in this table, the 398 contents are not readable unless the management station 399 has read-write permission." 400 INDEX { docsDevNmAccessIndex } 401 ::= { docsDevNmAccessTable 1 } 403 DocsDevNmAccessEntry ::= SEQUENCE { 404 docsDevNmAccessIndex INTEGER, 405 docsDevNmAccessIp IpAddress, 406 docsDevNmAccessIpMask IpAddress, 407 docsDevNmAccessCommunity DisplayString, 408 docsDevNmAccessControl INTEGER, 409 docsDevNmAccessInterfaces OCTET STRING, 410 docsDevNmAccessStatus RowStatus 411 } 413 docsDevNmAccessIndex OBJECT-TYPE 414 SYNTAX INTEGER (1..2147483647) 415 MAX-ACCESS not-accessible 416 STATUS current 417 DESCRIPTION 418 "Index used to order the application of access entries." 419 ::= { docsDevNmAccessEntry 1 } 421 docsDevNmAccessIp OBJECT-TYPE 422 SYNTAX IpAddress 423 MAX-ACCESS read-create 424 STATUS current 425 DESCRIPTION 426 "The IP address (or subnet) of the network management 427 station. The address 255.255.255.255 is defined to mean 428 any NMS. If traps are enabled for this entry, then the 429 value must be the address of a specific device." 430 DEFVAL { 'ffffffff'h } 431 ::= { docsDevNmAccessEntry 2 } 433 docsDevNmAccessIpMask OBJECT-TYPE 434 SYNTAX IpAddress 435 MAX-ACCESS read-create 436 STATUS current 437 DESCRIPTION 438 "The IP subnet mask of the network management stations. 439 If traps are enabled for this entry, then the value must 440 be 255.255.255.255." 441 DEFVAL { 'ffffffff'h } 442 ::= { docsDevNmAccessEntry 3 } 444 docsDevNmAccessCommunity OBJECT-TYPE 445 SYNTAX DisplayString 446 MAX-ACCESS read-create 447 STATUS current 448 DESCRIPTION 449 "The community string to be matched for access by this 450 entry. If set to the null string then any community string 451 will match." 452 DEFVAL { "public" } 453 ::= { docsDevNmAccessEntry 4 } 455 docsDevNmAccessControl OBJECT-TYPE 456 SYNTAX INTEGER { 457 none(1), 458 read(2), 459 readWrite(3), 460 roWithTraps(4), 461 rwWithTraps(5), 462 trapsOnly(6) 463 } 464 MAX-ACCESS read-create 465 STATUS current 466 DESCRIPTION 467 "Specifies the type of access allowed to this NMS. Setting 468 this object to none(1) causes the table entry to be 469 destroyed. Read(2) allows access by 'get' and 'get-next' 470 PDUs. ReadWrite(3) allows access by 'set' as well. 471 RoWithtraps(4), rwWithTraps(5), and trapsOnly(6) 472 control distribution of Trap PDUs transmitted by this 473 device." 474 DEFVAL { read } 475 ::= { docsDevNmAccessEntry 5 } 477 -- The syntax of the following object was copied from RFC1493, 478 -- dot1dStaticAllowedToGoTo. 480 docsDevNmAccessInterfaces OBJECT-TYPE 481 SYNTAX OCTET STRING 482 MAX-ACCESS read-create 483 STATUS current 484 DESCRIPTION 485 "Specifies the set of interfaces from which requests from 486 this NMS will be accepted. 487 Each octet within the value of this object specifies a set 488 of eight interfaces, with the first octet specifying ports 489 1 through 8, the second octet specifying interfaces 9 490 through 16, etc. Within each octet, the most significant 491 bit represents the lowest numbered interface, and the least 492 significant bit represents the highest numbered interface. 493 Thus, each interface is represented by a single bit within 494 the value of this object. If that bit has a value of '1' 495 then that interface is included in the set. 497 Note that entries in this table apply only to link-layer 498 interfaces (e.g., Ethernet and CATV MAC). Upstream and 499 downstream channel interfaces must not be specified." 500 -- DEFVAL is the bitmask corresponding to all interfaces 501 ::= { docsDevNmAccessEntry 6 } 503 docsDevNmAccessStatus OBJECT-TYPE 504 SYNTAX RowStatus 505 MAX-ACCESS read-create 506 STATUS current 507 DESCRIPTION 508 "Controls and reflects the status of rows in this table." 509 ::= { docsDevNmAccessEntry 7 } 511 -- 512 -- Procedures for using the following group are described in section 513 -- 3.2.1 514 -- 516 docsDevSoftware OBJECT IDENTIFIER ::= { docsDevMIBObjects 3 } 518 docsDevSwServer OBJECT-TYPE 519 SYNTAX IpAddress 520 MAX-ACCESS read-write 521 STATUS current 522 DESCRIPTION 523 "The address of the TFTP server used for software upgrades." 524 ::= { docsDevSoftware 1 } 526 docsDevSwFilename OBJECT-TYPE 527 SYNTAX DisplayString (SIZE (0..32)) 528 MAX-ACCESS read-write 529 STATUS current 530 DESCRIPTION 531 "The file name of the software image to be loaded into this 532 device. Unless set via SNMP, this is the file name 533 specified by the provisioning server that corresponds to 534 the software version that is desired for this device. 535 If unknown, the string '(unknown)' is returned." 536 ::= { docsDevSoftware 2 } 538 docsDevSwAdminStatus OBJECT-TYPE 539 SYNTAX INTEGER { 540 upgradeFromMgt(1), 541 allowProvisioningUpgrade(2), 542 ignoreProvisioningUpgrade(3) 543 } 544 MAX-ACCESS read-write 545 STATUS current 546 DESCRIPTION 547 "If set to upgradeFromMgt(1), the device will initiate a 548 TFTP software image download using docsDevSwFilename. 549 After successfully receiving an image, the device will 550 set its state to ignoreProvisioningUpgrade(3) and reboot. 551 If the download process is interrupted by a reset or 552 power failure, the device will load the previous image 553 and, after re-initialization, continue to attempt loading 554 the image specified in docsDevSwFilename. 556 If set to allowProvisioningUpgrade(2), the device will 557 use the software version information supplied by the 558 provisioning server when next rebooting (this does not 559 cause a reboot). 561 When set to ignoreProvisioningUpgrade(3), the device 562 will disregard software image upgrade information from the 563 provisioning server. 565 Note that reading this object can return upgradeFromMgt(1). 566 This indicates that a software download is currently in 567 progress, and that the device will reboot after 568 successfully receiving an image." 569 ::= { docsDevSoftware 3 } 571 docsDevSwOperStatus OBJECT-TYPE 572 SYNTAX INTEGER { 573 inProgress(1), 574 completeFromProvisioning(2), 575 completeFromMgt(3), 576 failed(4), 577 other(5) 578 } 579 MAX-ACCESS read-only 580 STATUS current 581 DESCRIPTION 582 "InProgress(1) indicates that a TFTP download is underway, 583 either as a result of a version mismatch at provisioning 584 or as a result of a upgradeFromMgt request. 585 CompleteFromProvisioning(2) indicates that the last 586 software upgrade was a result of version mismatch at 587 provisioning. CompleteFromMgt(3) indicates that the last 588 software upgrade was a result of setting 589 docsDevSwAdminStatus to upgradeFromMgt. 590 Failed(4) indicates that the last attempted download 591 failed, ordinarily due to TFTP timeout." 592 ::= { docsDevSoftware 4 } 594 -- 595 -- The following group describes server access and parameters used for 596 -- initial provisioning and bootstrapping. 597 -- 599 docsDevServer OBJECT IDENTIFIER ::= { docsDevMIBObjects 4 } 601 docsDevServerBootState OBJECT-TYPE 602 SYNTAX INTEGER { 603 operational(1), 604 disabled(2), 605 waitingForDhcpOffer(3), 606 waitingForDhcpResponse(4), 607 waitingForTimeServer(5), 608 waitingForTftp(6), 609 refusedByCmts(7), 610 forwardingDenied(8), 611 other(9), 612 unknown(10) 613 } 614 MAX-ACCESS read-only 615 STATUS current 616 DESCRIPTION 617 "If operational(1), the device has completed loading and 618 processing of configuration parameters and the CMTS has 619 completed the Registration exchange. 620 If disabled(2) then the device was administratively 621 disabled, possibly by being refused network access in the 622 configuration file. 623 If waitingForDhcpOffer(3) then a DHCP Discover has been 624 transmitted and no offer has yet been received. 625 If waitingForDhcpResponse(4) then a DHCP Request has been 626 transmitted and no response has yet been received. 627 If waitingForTimeServer(5) then a Time Request has been 628 transmitted and no response has yet been received. 629 If waitingForTftp(6) then a request to the TFTP parameter 630 server has been made and no response received. 631 If refusedByCmts(7) then the Registration Request/Response 632 exchange with the CMTS failed. 633 If forwardingDenied(8) then the registration process 634 completed, but the network access option in the received 635 configuration file prohibits forwarding. " 636 ::= { docsDevServer 1 } 638 docsDevServerDhcp OBJECT-TYPE 639 SYNTAX IpAddress 640 MAX-ACCESS read-only 641 STATUS current 642 DESCRIPTION 643 "The IP address of the DHCP server that assigned an IP 644 address to this device. Returns 0.0.0.0 if DHCP was not 645 used for IP address assignment." 646 ::= { docsDevServer 2 } 648 docsDevServerTime OBJECT-TYPE 649 SYNTAX IpAddress 650 MAX-ACCESS read-only 651 STATUS current 652 DESCRIPTION 653 "The IP address of the Time server (RFC-868)." 654 ::= { docsDevServer 3 } 656 docsDevServerTftp OBJECT-TYPE 657 SYNTAX IpAddress 658 MAX-ACCESS read-only 659 STATUS current 660 DESCRIPTION 661 "The IP address of the TFTP server responsible for 662 downloading provisioning and configuration parameters 663 to this device." 664 ::= { docsDevServer 4 } 666 docsDevServerConfigFile OBJECT-TYPE 667 SYNTAX DisplayString 668 MAX-ACCESS read-only 669 STATUS current 670 DESCRIPTION 671 "The name of the device configuration file read from the 672 TFTP server." 673 ::= { docsDevServer 5 } 675 -- 676 -- Event Reporting 677 -- 679 docsDevEvent OBJECT IDENTIFIER ::= { docsDevMIBObjects 5 } 681 docsDevEvControl OBJECT-TYPE 682 SYNTAX INTEGER { 683 resetLog(1), 684 useDefaultReporting(2) 685 } 686 MAX-ACCESS read-write 687 STATUS current 688 DESCRIPTION 689 "Setting this object to resetLog(1) empties the event log. 690 All data is deleted. Setting it to useDefaultReporting(2) 691 returns all event priorities to their factory-default 692 reporting. Reading this object always returns 693 useDefaultReporting(2)." 694 ::= { docsDevEvent 1 } 696 docsDevEvSyslog OBJECT-TYPE 697 SYNTAX IpAddress 698 MAX-ACCESS read-write 699 STATUS current 700 DESCRIPTION 701 "The IP address of the Syslog server. If 0.0.0.0, syslog 702 transmission is inhibited." 703 ::= { docsDevEvent 2 } 705 docsDevEvThrottleAdminStatus OBJECT-TYPE 706 SYNTAX INTEGER { 707 unconstrained(1), 708 maintainBelowThreshold(2), 709 stopAtThreshold(3), 710 inhibited(4) 712 } 713 MAX-ACCESS read-write 714 STATUS current 715 DESCRIPTION 716 "Controls the transmission of traps and syslog messages 717 with respect to the trap pacing threshold. 718 unconstrained(1) causes traps and syslog messages to be 719 transmitted without regard to the threshold settings. 720 maintainBelowThreshold(2) causes trap transmission and 721 syslog messages to be suppressed if the number of traps 722 would otherwise exceed the threshold. 723 stopAtThreshold(3) causes trap transmission to cease 724 at the threshold, and not resume until directed to do so. 725 inhibited(4) causes all trap transmission and syslog 726 messages to be suppressed. 728 A single event is always treated as a single event for 729 threshold counting. That is, an event causing both a trap 730 and a syslog message is still treated as a single event. 732 Writing to this object resets the thresholding state." 733 ::= { docsDevEvent 3 } 735 docsDevEvThrottleInhibited OBJECT-TYPE 736 SYNTAX TruthValue 737 MAX-ACCESS read-only 738 STATUS current 739 DESCRIPTION 740 "If true(1), trap and syslog transmission is currently 741 inhibited due to thresholds and/or the current setting of 742 docsDevEvThrottleAdminStatus." 743 ::= { docsDevEvent 4 } 745 docsDevEvThrottleThreshold OBJECT-TYPE 746 SYNTAX Unsigned32 747 MAX-ACCESS read-write 748 STATUS current 749 DESCRIPTION 750 "Number of trap/syslog events per docsDevEvThrottleInterval 751 to be transmitted before throttling. 753 A single event is always treated as a single event for 754 threshold counting. That is, an event causing both a trap 755 and a syslog message is still treated as a single event." 756 ::= { docsDevEvent 5 } 758 docsDevEvThrottleInterval OBJECT-TYPE 759 SYNTAX INTEGER(1..2147483647) 760 UNITS "seconds" 761 MAX-ACCESS read-write 762 STATUS current 763 DESCRIPTION 764 "The interval over which the trap threshold applies." 765 ::= { docsDevEvent 6 } 767 -- 768 -- The following table controls the reporting of the various classes of 769 -- events. For each event priority, 770 -- a combination of logging and reporting mechanisms may be chosen. The 771 -- mapping of event types 772 -- to priorities is vendor-dependent. Vendors may also choose to allow 773 -- the user to control that mapping 774 -- through proprietary means. 776 docsDevEvControlTable OBJECT-TYPE 777 SYNTAX SEQUENCE OF DocsDevEvControlEntry 778 MAX-ACCESS not-accessible 779 STATUS current 780 DESCRIPTION 781 "Allows control of the reporting of event classes." 782 ::= { docsDevEvent 7 } 784 docsDevEvControlEntry OBJECT-TYPE 785 SYNTAX DocsDevEvControlEntry 786 MAX-ACCESS not-accessible 787 STATUS current 788 DESCRIPTION 789 "Allows configuration of the reporting mechanisms for a 790 particular event priority." 791 INDEX { docsDevEvPriority } 792 ::= { docsDevEvControlTable 1 } 794 DocsDevEvControlEntry ::= SEQUENCE { 795 docsDevEvPriority INTEGER, 796 docsDevEvReporting BITS 797 } 799 docsDevEvPriority OBJECT-TYPE 800 SYNTAX INTEGER { 801 emergency(1), 802 alert(2), 803 critical(3), 804 error(4), 805 warning(5), 806 notice(6), 807 information(7), 808 debug(8) 809 } 810 MAX-ACCESS not-accessible 811 STATUS current 812 DESCRIPTION 813 "The priority level that is controlled by this entry." 814 ::= { docsDevEvControlEntry 1 } 816 docsDevEvReporting OBJECT-TYPE 817 SYNTAX BITS { 818 local(0), 819 traps(1), 820 syslog(2) 821 } 822 MAX-ACCESS read-write 823 STATUS current 824 DESCRIPTION 825 "Defines the action to be taken on occurrence of this 826 event class. Implementations may not necessarily support 827 all options for all event classes, but at minimum must 828 allow traps and syslogging to be disabled." 829 ::= { docsDevEvControlEntry 2 } 831 docsDevEventTable OBJECT-TYPE 832 SYNTAX SEQUENCE OF DocsDevEventEntry 833 MAX-ACCESS not-accessible 834 STATUS current 835 DESCRIPTION 836 "Contains a log of network and device events that may be 837 of interest in fault isolation and troubleshooting." 838 ::= { docsDevEvent 8 } 840 docsDevEventEntry OBJECT-TYPE 841 SYNTAX DocsDevEventEntry 842 MAX-ACCESS not-accessible 843 STATUS current 844 DESCRIPTION 845 "Describes a network or device event that may be of 846 interest in fault isolation and troubleshooting." 847 INDEX { docsDevEvIndex } 848 ::= { docsDevEventTable 1 } 850 DocsDevEventEntry ::= SEQUENCE { 851 docsDevEvIndex INTEGER, 852 docsDevEvFirstTime DateAndTime, 853 docsDevEvLastTime DateAndTime, 854 docsDevEvCount Counter32, 855 docsDevEvLevel INTEGER, 856 docsDevEvId Unsigned32, 857 docsDevEvText DisplayString 858 } 860 docsDevEvIndex OBJECT-TYPE 861 SYNTAX INTEGER (1..2147483647) 862 MAX-ACCESS not-accessible 863 STATUS current 864 DESCRIPTION 865 "Provides relative ordering of the objects in the event 866 log. This object will always increase except when 867 (a) the log is reset via docsDevEvControl, 868 (b) the device reboots and does not implement nonvolatile 869 storage for this log, or (c) it reaches the value 2^31. 870 The next entry for all the above cases is 1." 871 ::= { docsDevEventEntry 1 } 873 docsDevEvFirstTime OBJECT-TYPE 874 SYNTAX DateAndTime 875 MAX-ACCESS read-only 876 STATUS current 877 DESCRIPTION 878 "The time that this entry was created." 879 ::= { docsDevEventEntry 2 } 881 docsDevEvLastTime OBJECT-TYPE 882 SYNTAX DateAndTime 883 MAX-ACCESS read-only 884 STATUS current 885 DESCRIPTION 886 "If multiple events are reported via the same entry, the 887 time that the last event for this entry occurred." 888 ::= { docsDevEventEntry 3 } 890 docsDevEvCount OBJECT-TYPE 891 SYNTAX Counter32 892 MAX-ACCESS read-only 893 STATUS current 894 DESCRIPTION 895 "The number of consecutive event instances reported by 896 this entry." 897 ::= { docsDevEventEntry 4 } 899 docsDevEvLevel OBJECT-TYPE 900 SYNTAX INTEGER { 901 emergency(1), 902 alert(2), 903 critical(3), 904 error(4), 905 warning(5), 906 notice(6), 907 information(7), 908 debug(8) 909 } 910 MAX-ACCESS read-only 911 STATUS current 912 DESCRIPTION 913 "The priority level of this event." 914 ::= { docsDevEventEntry 5 } 916 -- 917 -- Vendors will provide their own enumerations for the following. 918 -- The interpretation of the enumeration is unambiguous for a 919 -- particular value of the vendor's enterprise number in sysObjectID. 921 -- 923 docsDevEvId OBJECT-TYPE 924 SYNTAX Unsigned32 925 MAX-ACCESS read-only 926 STATUS current 927 DESCRIPTION 928 "For this product, uniquely identifies the type of event 929 that is reported by this entry." 930 ::= { docsDevEventEntry 6 } 932 docsDevEvText OBJECT-TYPE 933 SYNTAX DisplayString 934 MAX-ACCESS read-only 935 STATUS current 936 DESCRIPTION 937 "Provides a human-readable description of the event, 938 including all relevant context (interface numbers, 939 etc.)." 940 ::= { docsDevEventEntry 7 } 942 docsDevFilter OBJECT IDENTIFIER ::= { docsDevMIBObjects 6 } 944 -- LLC filters can be defined on an inclusive or exclusive basis: CMs 945 -- can be configured to forward only packets matching a set of layer 946 -- three protocols, or to drop packets matching a set of layer three 947 -- protocols. 949 docsDevFilterLLCDefault OBJECT-TYPE 950 SYNTAX INTEGER { 951 discard(1), 952 accept(2) 953 } 954 MAX-ACCESS read-write 955 STATUS current 956 DESCRIPTION 957 "If set to discard(1), all packets not matching an LLC 958 filter will be discarded. If set to accept(2), all 959 packets not matching an LLC filter will be accepted for 960 further processing (e.g., bridging)." 961 ::= { docsDevFilter 1 } 963 docsDevFilterLLCTable OBJECT-TYPE 964 SYNTAX SEQUENCE OF DocsDevFilterLLCEntry 965 MAX-ACCESS not-accessible 966 STATUS current 967 DESCRIPTION 968 "A list of filters to apply to (bridged) LLC traffic, which 969 forwards or drops packets on the basis of the layer three 970 protocol type." 971 ::= { docsDevFilter 2 } 973 docsDevFilterLLCEntry OBJECT-TYPE 974 SYNTAX DocsDevFilterLLCEntry 975 MAX-ACCESS not-accessible 976 STATUS current 977 DESCRIPTION 978 "Describes a single filter to apply to (bridged) LLC traffic 979 received on a specified interface. " 980 INDEX { docsDevFilterLLCIndex } 981 ::= { docsDevFilterLLCTable 1 } 983 DocsDevFilterLLCEntry ::= SEQUENCE { 984 docsDevFilterLLCIndex INTEGER, 985 docsDevFilterLLCStatus RowStatus, 986 docsDevFilterLLCIfIndex InterfaceIndexOrZero, 987 docsDevFilterLLCProtocolType INTEGER, 988 docsDevFilterLLCProtocol INTEGER, 989 docsDevFilterLLCMatches Counter32 990 } 992 docsDevFilterLLCIndex OBJECT-TYPE 993 SYNTAX INTEGER (1..2147483647) 994 MAX-ACCESS not-accessible 995 STATUS current 996 DESCRIPTION 997 "Index used for the identification of filters (note that LLC 998 filter order is irrelevant)." 999 ::= { docsDevFilterLLCEntry 1 } 1001 docsDevFilterLLCStatus OBJECT-TYPE 1002 SYNTAX RowStatus 1003 MAX-ACCESS read-create 1004 STATUS current 1005 DESCRIPTION 1006 "Controls and reflects the status of rows in this table." 1007 ::= { docsDevFilterLLCEntry 2} 1009 docsDevFilterLLCIfIndex OBJECT-TYPE 1010 SYNTAX InterfaceIndexOrZero 1011 MAX-ACCESS read-create 1012 STATUS current 1013 DESCRIPTION 1014 "The entry interface to which this filter applies. 1015 The value corresponds to ifIndex for either a CATV MAC 1016 or another network interface. If the value is zero, the 1017 filter applies to all interfaces. In Cable Modems, the 1018 default value is the customer side interface. In Cable 1019 Modem Termination Systems, this object has to be 1020 specified to create a row in this table." 1021 ::= { docsDevFilterLLCEntry 3 } 1023 docsDevFilterLLCProtocolType OBJECT-TYPE 1024 SYNTAX INTEGER { 1025 ethertype(1), 1026 dsap(2) 1027 } 1028 MAX-ACCESS read-create 1029 STATUS current 1030 DESCRIPTION 1031 "The format of the value in docsDevFilterLLCProtocol: 1032 either a two-byte Ethernet Ethertype, or a one-byte 1033 802.2 SAP value. EtherType(1) also applies to SNAP- 1034 encapsulated frames." 1035 DEFVAL { ethertype } 1036 ::= { docsDevFilterLLCEntry 4 } 1038 docsDevFilterLLCProtocol OBJECT-TYPE 1039 SYNTAX INTEGER (0..65535) 1040 MAX-ACCESS read-create 1041 STATUS current 1042 DESCRIPTION 1043 "The layer three protocol for which this filter applies. 1044 The protocol value format depends on 1045 docsDevFilterLLCProtocolType. Note that for SNAP frames, 1046 etherType filtering is performed rather than DSAP=0xAA." 1047 DEFVAL { 0 } 1048 ::= { docsDevFilterLLCEntry 5 } 1050 docsDevFilterLLCMatches OBJECT-TYPE 1051 SYNTAX Counter32 1052 MAX-ACCESS read-only 1053 STATUS current 1054 DESCRIPTION 1055 "Counts the number of times this filter was matched." 1056 ::= { docsDevFilterLLCEntry 6 } 1058 -- The default behavior for (bridged) packets that do not match IP 1059 -- filters is defined by 1060 -- docsDevFilterIpDefault. 1062 docsDevFilterIpDefault OBJECT-TYPE 1063 SYNTAX INTEGER { 1064 discard(1), 1065 accept(2) 1066 } 1067 MAX-ACCESS read-write 1068 STATUS current 1069 DESCRIPTION 1070 "If set to discard(1), all packets not matching an IP filter 1071 will be discarded. If set to accept(2), all packets not 1072 matching an IP filter will be accepted for further 1073 processing (e.g., bridging)." 1074 ::= { docsDevFilter 3 } 1076 docsDevFilterIpTable OBJECT-TYPE 1077 SYNTAX SEQUENCE OF DocsDevFilterIpEntry 1078 MAX-ACCESS not-accessible 1079 STATUS current 1080 DESCRIPTION 1081 "An ordered list of filters to apply to IP traffic. Filter 1082 application is ordered by the filter index, rather than 1083 by a best match algorithm. Packets which match no filters 1084 are discarded or forwarded according to the setting of 1085 docsDevFilterIpDefault." 1086 ::= { docsDevFilter 4 } 1088 docsDevFilterIpEntry OBJECT-TYPE 1089 SYNTAX DocsDevFilterIpEntry 1090 MAX-ACCESS not-accessible 1091 STATUS current 1092 DESCRIPTION 1093 "Describes a filter to apply to IP traffic received on a 1094 specified interface. Both source and destination addresses 1095 must match for the filter to apply." 1096 INDEX { docsDevFilterIpIndex } 1097 ::= { docsDevFilterIpTable 1 } 1099 DocsDevFilterIpEntry ::= SEQUENCE { 1100 docsDevFilterIpIndex INTEGER, 1101 docsDevFilterIpStatus RowStatus, 1102 docsDevFilterIpControl INTEGER, 1103 docsDevFilterIpIfIndex InterfaceIndexOrZero, 1104 docsDevFilterIpDirection INTEGER, 1105 docsDevFilterIpBroadcast TruthValue, 1106 docsDevFilterIpSaddr IpAddress, 1107 docsDevFilterIpSmask IpAddress, 1108 docsDevFilterIpDaddr IpAddress, 1109 docsDevFilterIpDmask IpAddress, 1110 docsDevFilterIpProtocol INTEGER, 1111 docsDevFilterIpSourcePortLow INTEGER, 1112 docsDevFilterIpSourcePortHigh INTEGER, 1113 docsDevFilterIpDestPortLow INTEGER, 1114 docsDevFilterIpDestPortHigh INTEGER, 1115 docsDevFilterIpMatches Counter32 1116 } 1118 docsDevFilterIpIndex OBJECT-TYPE 1119 SYNTAX INTEGER (1..2147483647) 1120 MAX-ACCESS not-accessible 1121 STATUS current 1122 DESCRIPTION 1123 "Index used to order the application of filters. 1124 The filter with the lowest index is always applied 1125 first." 1126 ::= { docsDevFilterIpEntry 1 } 1128 docsDevFilterIpStatus OBJECT-TYPE 1129 SYNTAX RowStatus 1130 MAX-ACCESS read-create 1131 STATUS current 1132 DESCRIPTION 1133 "Controls and reflects the status of rows in this table." 1134 ::= { docsDevFilterIpEntry 2 } 1136 docsDevFilterIpControl OBJECT-TYPE 1137 SYNTAX INTEGER { 1138 discard(1), 1139 accept(2) 1140 } 1141 MAX-ACCESS read-create 1142 STATUS current 1143 DESCRIPTION 1144 "If set to discard(1), all packets matching this filter 1145 will be discarded and scanning of the remainder of the 1146 filter list will be aborted. If set to accept(2), all 1147 packets matching this filter will be accepted for further 1148 processing (e.g., bridging) and scanning of the remainder 1149 of the filter list will be aborted. " 1150 DEFVAL { discard } 1151 ::= { docsDevFilterIpEntry 3 } 1153 docsDevFilterIpIfIndex OBJECT-TYPE 1154 SYNTAX InterfaceIndexOrZero 1155 MAX-ACCESS read-create 1156 STATUS current 1157 DESCRIPTION 1158 "The entry interface to which this filter applies. The 1159 value corresponds to ifIndex for either a CATV MAC or 1160 another network interface. If the value is zero, the 1161 filter applies to all interfaces. Default value in Cable 1162 Modems is the customer-side interface. In Cable Modem 1163 Termination Systems, this object has to be specified to 1164 create a row in this table." 1165 ::= { docsDevFilterIpEntry 4 } 1167 docsDevFilterIpDirection OBJECT-TYPE 1168 SYNTAX INTEGER { 1169 inbound(1), 1170 outbound(2), 1171 both(3) 1172 } 1173 MAX-ACCESS read-create 1174 STATUS current 1175 DESCRIPTION 1176 "Determines whether the filter is applied to inbound(1) 1177 traffic, outbound(2) traffic, or traffic in both(3) 1178 directions." 1179 DEFVAL { inbound } 1180 ::= { docsDevFilterIpEntry 5 } 1182 docsDevFilterIpBroadcast OBJECT-TYPE 1183 SYNTAX TruthValue 1184 MAX-ACCESS read-create 1185 STATUS current 1186 DESCRIPTION 1187 "If set to true(1), the filter only applies to multicast 1188 and broadcast traffic. If set to false(2), the filter 1189 applies to all traffic." 1190 DEFVAL { false } 1191 ::= { docsDevFilterIpEntry 6 } 1193 docsDevFilterIpSaddr OBJECT-TYPE 1194 SYNTAX IpAddress 1195 MAX-ACCESS read-create 1196 STATUS current 1197 DESCRIPTION 1198 "The source IP address, or portion thereof, that is to be 1199 matched for this filter." 1200 DEFVAL { '00000000'h } 1201 ::= { docsDevFilterIpEntry 7 } 1203 docsDevFilterIpSmask OBJECT-TYPE 1204 SYNTAX IpAddress 1205 MAX-ACCESS read-create 1206 STATUS current 1207 DESCRIPTION 1208 "A bit mask that is to be applied to the source address 1209 prior to matching. This mask is not necessarily the same 1210 as a subnet mask, but 1's bits must be leftmost and 1211 contiguous." 1212 DEFVAL { '00000000'h } 1213 ::= { docsDevFilterIpEntry 8 } 1215 docsDevFilterIpDaddr OBJECT-TYPE 1216 SYNTAX IpAddress 1217 MAX-ACCESS read-create 1218 STATUS current 1219 DESCRIPTION 1220 "The destination IP address, or portion thereof, that is 1221 to be matched for this filter " 1222 DEFVAL { '00000000'h } 1223 ::= { docsDevFilterIpEntry 9 } 1225 docsDevFilterIpDmask OBJECT-TYPE 1226 SYNTAX IpAddress 1227 MAX-ACCESS read-create 1228 STATUS current 1229 DESCRIPTION 1230 "A bit mask that is to be applied to the destination 1231 address prior to matching. This mask is not necessarily 1232 the same as a subnet mask, but 1's bits must be leftmost 1233 and contiguous " 1235 DEFVAL { '00000000'h } 1236 ::= { docsDevFilterIpEntry 10 } 1238 docsDevFilterIpProtocol OBJECT-TYPE 1239 SYNTAX INTEGER { 1240 icmp(1), 1241 tcp(6), 1242 udp(17), 1243 any(256) 1244 } 1245 MAX-ACCESS read-create 1246 STATUS current 1247 DESCRIPTION 1248 "The IP protocol value that is to be matched." 1249 DEFVAL { any } 1250 ::= { docsDevFilterIpEntry 11 } 1252 docsDevFilterIpSourcePortLow OBJECT-TYPE 1253 SYNTAX INTEGER (0..65535) 1254 MAX-ACCESS read-create 1255 STATUS current 1256 DESCRIPTION 1257 "If docsDevFilterIpProtocol is udp or tcp, this is the 1258 inclusive lower bound of the transport-layer source port 1259 range that is to be matched." 1260 DEFVAL { 0 } 1261 ::= { docsDevFilterIpEntry 12 } 1263 docsDevFilterIpSourcePortHigh OBJECT-TYPE 1264 SYNTAX INTEGER (0..65535) 1265 MAX-ACCESS read-create 1266 STATUS current 1267 DESCRIPTION 1268 "If docsDevFilterIpProtocol is udp or tcp, this is the 1269 inclusive upper bound of the transport-layer source port 1270 range that is to be matched." 1271 DEFVAL { 65535 } 1272 ::= { docsDevFilterIpEntry 13 } 1274 docsDevFilterIpDestPortLow OBJECT-TYPE 1275 SYNTAX INTEGER (0..65535) 1276 MAX-ACCESS read-create 1277 STATUS current 1278 DESCRIPTION 1279 "If docsDevFilterIpProtocol is udp or tcp, this is the 1280 inclusive lower bound of the transport-layer destination 1281 port range that is to be matched." 1282 DEFVAL { 0 } 1283 ::= { docsDevFilterIpEntry 14 } 1285 docsDevFilterIpDestPortHigh OBJECT-TYPE 1286 SYNTAX INTEGER (0..65535) 1287 MAX-ACCESS read-create 1288 STATUS current 1289 DESCRIPTION 1290 "If docsDevFilterIpProtocol is udp or tcp, this is the 1291 inclusive upper bound of the transport-layer destination 1292 port range that is to be matched." 1293 DEFVAL { 65535 } 1294 ::= { docsDevFilterIpEntry 15 } 1296 docsDevFilterIpMatches OBJECT-TYPE 1297 SYNTAX Counter32 1298 MAX-ACCESS read-only 1299 STATUS current 1300 DESCRIPTION 1301 "Counts the number of times this filter was matched." 1302 ::= { docsDevFilterIpEntry 16 } 1304 -- 1305 -- Placeholder for notifications/traps. 1306 -- 1307 docsDevNotification OBJECT IDENTIFIER ::= { docsDevMIB 2 } 1309 -- 1310 -- Conformance definitions 1311 -- 1312 docsDevConformance OBJECT IDENTIFIER ::= { docsDevMIB 3 } 1313 docsDevGroups OBJECT IDENTIFIER ::= { docsDevConformance 1 } 1314 docsDevCompliances OBJECT IDENTIFIER ::= { docsDevConformance 2 } 1316 docsDevBasicCompliance MODULE-COMPLIANCE 1317 STATUS current 1318 DESCRIPTION 1319 "The compliance statement for MCNS Cable Modems and 1320 Cable Modem Termination Systems." 1322 MODULE -- docsDevMIB 1324 -- conditionally mandatory groups 1326 GROUP docsDevBaseGroup 1327 DESCRIPTION 1328 "Mandatory in Cable Modems, optional in Cable Modem 1329 Termination Systems." 1331 GROUP docsDevEventGroup 1332 DESCRIPTION 1333 "Mandatory in Cable Modems, optional in Cable Modem 1334 Termination Systems." 1336 GROUP docsDevFilterGroup 1337 DESCRIPTION 1338 "Mandatory in Cable Modems, optional in Cable Modem 1339 Termination Systems." 1341 GROUP docsDevNmAccessGroup 1342 DESCRIPTION 1343 "Mandatory in Cable Modems, optional in Cable Modem 1344 Termination Systems." 1346 GROUP docsDevServerGroup 1347 DESCRIPTION 1348 "This group is implemented only in Cable Modems, 1349 not in Cable Modem Termination Systems." 1351 GROUP docsDevSoftwareGroup 1352 DESCRIPTION 1353 "Mandatory in Cable Modems, optional in Cable Modem 1354 Termination Systems." 1356 OBJECT docsDevSTPControl 1357 MIN-ACCESS read-only 1358 DESCRIPTION 1359 "It is compliant to implement this object as read-only. 1360 Devices need only support noStFilterBpdu(2)." 1362 OBJECT docsDevEvReporting 1363 MIN-ACCESS read-only 1364 DESCRIPTION 1365 "It is compliant to implement this object as read-only. 1366 Devices need only support local(1)." 1368 ::= { docsDevCompliances 1 } 1370 docsDevBaseGroup OBJECT-GROUP 1371 OBJECTS { 1372 docsDevRole, 1373 docsDevDateTime, 1374 docsDevResetNow, 1375 docsDevSerialNumber, 1376 docsDevSTPControl 1377 } 1378 STATUS current 1379 DESCRIPTION 1380 "A collection of objects providing device status and 1381 control." 1382 ::= { docsDevGroups 1 } 1384 docsDevNmAccessGroup OBJECT-GROUP 1385 OBJECTS { 1386 docsDevNmAccessIp, 1387 docsDevNmAccessIpMask, 1388 docsDevNmAccessCommunity, 1389 docsDevNmAccessControl, 1390 docsDevNmAccessInterfaces, 1391 docsDevNmAccessStatus 1392 } 1393 STATUS current 1394 DESCRIPTION 1395 "A collection of objects for controlling access to SNMP 1396 objects." 1397 ::= { docsDevGroups 2 } 1399 docsDevSoftwareGroup OBJECT-GROUP 1400 OBJECTS { 1401 docsDevSwServer, 1402 docsDevSwFilename, 1403 docsDevSwAdminStatus, 1404 docsDevSwOperStatus 1405 } 1406 STATUS current 1407 DESCRIPTION 1408 "A collection of objects for controlling software 1409 downloads." 1410 ::= { docsDevGroups 3 } 1412 docsDevServerGroup OBJECT-GROUP 1413 OBJECTS { 1414 docsDevServerBootState, 1415 docsDevServerDhcp, 1416 docsDevServerTime, 1417 docsDevServerTftp, 1418 docsDevServerConfigFile 1419 } 1420 STATUS current 1421 DESCRIPTION 1422 "A collection of objects providing status about server 1423 provisioning." 1424 ::= { docsDevGroups 4 } 1426 docsDevEventGroup OBJECT-GROUP 1427 OBJECTS { 1428 docsDevEvControl, 1429 docsDevEvSyslog, 1430 docsDevEvThrottleAdminStatus, 1431 docsDevEvThrottleInhibited, 1432 docsDevEvThrottleThreshold, 1433 docsDevEvThrottleInterval, 1434 docsDevEvReporting, 1435 docsDevEvFirstTime, 1436 docsDevEvLastTime, 1437 docsDevEvCount, 1438 docsDevEvLevel, 1439 docsDevEvId, 1440 docsDevEvText 1441 } 1442 STATUS current 1443 DESCRIPTION 1444 "A collection of objects used to control and monitor 1445 events." 1446 ::= { docsDevGroups 5 } 1448 docsDevFilterGroup OBJECT-GROUP 1449 OBJECTS { 1450 docsDevFilterLLCDefault, 1451 docsDevFilterIpDefault, 1452 docsDevFilterLLCStatus, 1453 docsDevFilterLLCIfIndex, 1454 docsDevFilterLLCProtocolType, 1455 docsDevFilterLLCProtocol, 1456 docsDevFilterLLCMatches, 1457 docsDevFilterIpControl, 1458 docsDevFilterIpIfIndex, 1459 docsDevFilterIpStatus, 1460 docsDevFilterIpDirection, 1461 docsDevFilterIpBroadcast, 1462 docsDevFilterIpSaddr, 1463 docsDevFilterIpSmask, 1464 docsDevFilterIpDaddr, 1465 docsDevFilterIpDmask, 1466 docsDevFilterIpProtocol, 1467 docsDevFilterIpSourcePortLow, 1468 docsDevFilterIpSourcePortHigh, 1469 docsDevFilterIpDestPortLow, 1470 docsDevFilterIpDestPortHigh, 1471 docsDevFilterIpMatches 1472 } 1473 STATUS current 1474 DESCRIPTION 1475 "A collection of objects to specify filters at link layer 1476 and IP layer." 1477 ::= { docsDevGroups 6 } 1479 END 1480 5. Acknowledgments 1482 This document was produced by the IPCDN Working Group. It is based on a 1483 document written by Pam Anderson from CableLabs, Wilson Sawyer from 1484 BayNetworks, and Rich Woundy from Continental Cablevision. 1486 Special thanks is also due to Azlina Palmer, who helped a lot reviewing 1487 the document. 1489 6. References 1491 [1] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and 1492 S. Waldbusser, "Structure of Management Information for Version 2 1493 of the Simple Network Management Protocol (SNMPv2)", RFC 1902, 1494 January 1996. 1496 [2] McCloghrie, K., and M. Rose, Editors, "Management Information Base 1497 for Network Management of TCP/IP-based internets: MIB-II", STD 17, 1498 RFC 1213, Hughes LAN Systems, Performance Systems International, 1499 March 1991. 1501 [3] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "A Simple 1502 Network Management Protocol (SNMP)", STD 15, RFC 1157, SNMP 1503 Research, Performance Systems International, MIT Lab for Computer 1504 Science, May 1990. 1506 [4] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M. and 1507 S. Waldbusser, "Protocol Operations for Version 2 of the Simple 1508 Network Management Protocol (SNMPv2)", RFC 1905, January 1996. 1510 [5] McCloghrie, K. and F. Kastenholz, "Evolution of the Interfaces 1511 Group of MIB-II", RFC 1573, Hughes LAN Systems, FTP Software, 1512 January 1994. 1514 [6] "MCNS Data Over Cable Services Cable Modem Radio Frequency 1515 Interface Specification SP-RFID01-970326", MCNS, March 1997. 1517 [7] L. Steinberg, "Techniques for Managing Asynchronously Generated 1518 Alerts", RFC 1224, May 1991. 1520 [8] "MCNS Data Over Cable Services Operations Support System Interface 1521 Specification SP-OSSII01-970403", MCNS, March 1997. 1523 7. Security Considerations 1525 The docsDevNmAccessTable limits network management station access to 1526 devices implementing this MIB, thus providing protection against 1527 configuration changes imposed by unauthorized network management 1528 stations. 1530 It should be noted, however, that this protextion does not prevent 1531 unauthorized access by using wrong IP source address information. Also, 1532 it should be noted that depending of the SNMP version in use the SNMP 1533 data packets may be transmitted unencrypted. Dealing with this kind of 1534 security problems is outside the scope of this specification. 1536 8. Author's Address 1538 Guenter Roeck 1539 cisco Systems 1540 170 West Tasman Drive 1541 San Jose, CA 95134 1542 U.S.A. 1544 Phone: +1 408 527 3143 1545 Email: groeck@cisco.com