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