idnits 2.17.1 draft-ietf-ipcdn-cable-device-mib-01.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-19) 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 166: '...e text. Vendors SHOULD provide time-o...' RFC 2119 keyword, line 196: '...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 (September 1997) is 9713 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 1463, 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 September 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-01.txt 8 Wed Sep 3 13:35:36 PDT 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 ................................................. 30 66 6 References ...................................................... 30 67 7 Security Considerations ......................................... 30 68 8 Author's Address ................................................ 31 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 Any system implementing this MIB must support reporting events using 160 SNMP traps. Other means of event reporting are outside the scope of this 161 document. 163 The definition and coding of events is vendor-specific. In deference to 164 the network operator who must troubleshoot multi-vendor networks, the 165 circumstances and meaning of each event should be reported as human- 166 readable text. Vendors SHOULD provide time-of-day clocks in CMs to 167 provide useful timestamping of events. 169 For each vendor-specific event that is reportable via TRAP, the vendor 170 must create an enterprise-specific trap definition. Trap definitions 171 MUST include the event reason encoded as DisplayString and should be 172 defined as: 174 trapName NOTIFICATION-TYPE 175 OBJECTS { 176 ifIndex, 177 eventReason, 178 other useful objects 179 } 180 STATUS current 181 DESCRIPTION 182 "trap description" 183 ::= Object Id 185 Note that ifIndex is only included if the event or trap is interface 186 related. 188 The last digit of the trap OID for enterprise-specific traps must match 189 docsDevEvId. For SNMPv1-capable Network Management systems, this is 190 necessary to correlate the event type to the trap type. Many Network 191 Management systems are only capable of trap filtering on an enterprise 192 and single-last-digit basis. 194 3.2.3. Trap Throttling 196 The CM and CMTS MUST provide support for trap message throttling as 197 described below. The network operator can employ message rate 198 throttling or trap limiting by manipulating the appropriate MIB 199 variables. 201 3.2.3.1. Trap rate throttling 203 Network operators may employ either of two rate control methods. In the 204 first method, the device ceases to send traps when the rate exceeds the 205 specified maximum message rate. It resumes sending traps only if 206 reactivated by a network management station request. 208 In the second method, the device resumes sending traps when the rate 209 falls below the specified maximum message rate. 211 The network operator configures the specified maximum message rate by 212 setting the measurement interval (in seconds), and the maximum number of 213 traps to be transmitted within the measurement interval. The operator 214 can query the operational throttling state (to determine whether traps 215 are enabled or blocked by throttling) of the device, as well as query 216 and set the administrative throttling state (to manage the rate control 217 method) of the device. 219 3.2.3.2. Limiting the trap rate 221 Network operators may wish to limit the number of traps sent by a device 222 over a specified time period. The device ceases to send traps when the 223 number of traps exceeds the specified threshold. It resumes sending 224 traps only when the measurement interval has passed. 226 The network operator defines the maximum number of traps he is willing 227 to handle and sets the measurement interval to a large number (in 228 hundredths of a second). For this case, the administrative throttling 229 state is set to stop at threshold which is the maximum number of traps. 231 See "Techniques for Managing Asynchronously Generated Alerts" [7] for 232 further information. 234 3.3. Protocol Filters 236 The Cable Device MIB provides objects for both LLC and IP protocol 237 filters. The LLC protocol filter entries can be used to limit CM 238 forwarding to a restricted set of network-layer protocols (such as IP, 239 IPX, NetBIOS, and Appletalk). The IP protocol filter entries can be 240 used to restrict upstream or downstream traffic based on source and 241 destination IP addresses, transport-layer protocols (such as TCP, UDP, 242 and ICMP), and source and destination TCP/UDP port numbers. 244 4. Definitions 246 DOCS-CABLE-DEVICE-MIB DEFINITIONS ::= BEGIN 248 IMPORTS 249 MODULE-IDENTITY, OBJECT-TYPE, BITS, 250 IpAddress, Unsigned32, Counter32, experimental 251 FROM SNMPv2-SMI 252 DisplayString, RowStatus, DateAndTime, TruthValue 253 FROM SNMPv2-TC 254 OBJECT-GROUP, MODULE-COMPLIANCE 255 FROM SNMPv2-CONF 256 InterfaceIndexOrZero 257 FROM IF-MIB; 259 docsDevMIB MODULE-IDENTITY 260 LAST-UPDATED "9709031338Z" -- Sep 03, 1997 261 ORGANIZATION "IETF IPCDN Working Group" 262 CONTACT-INFO 263 " Guenter Roeck 264 Postal: cisco Systems 265 170 West Tasman Drive 266 San Jose, CA 95134 267 U.S.A. 268 Phone: +1 408 527 3143 269 E-mail: groeck@cisco.com" 270 DESCRIPTION 271 "This is the MIB Module for MCNS-compliant cable modems and 272 cable-modem termination systems." 273 ::= { experimental 999 } 274 -- Editor's note: This is not a valid assignment. Final value is TBD. 276 docsDevMIBObjects OBJECT IDENTIFIER ::= { docsDevMIB 1 } 277 docsDevBase OBJECT IDENTIFIER ::= { docsDevMIBObjects 1 } 279 -- 280 -- For the following object, there is no concept in the 281 -- RFI specification corresponding to a backup CMTS. The 282 -- enumeration is provided here in case someone is able 283 -- to define such a role or device. 284 -- 286 docsDevRole OBJECT-TYPE 287 SYNTAX INTEGER { 288 cm(1), 289 cmtsActive(2), 290 cmtsBackup(3) 291 } 292 MAX-ACCESS read-only 293 STATUS current 294 DESCRIPTION 295 "Defines the current role of this device." 296 ::= { docsDevBase 1 } 298 docsDevDateTime OBJECT-TYPE 299 SYNTAX DateAndTime 300 MAX-ACCESS read-write 301 STATUS current 302 DESCRIPTION 303 "The date and time, with optional timezone information." 304 ::= { docsDevBase 2 } 306 docsDevResetNow OBJECT-TYPE 307 SYNTAX TruthValue 308 MAX-ACCESS read-write 309 STATUS current 310 DESCRIPTION 311 "Setting this object to true(1) causes the device to reset. 312 Reading this object always returns false(2)." 313 ::= { docsDevBase 3 } 315 docsDevSerialNumber OBJECT-TYPE 316 SYNTAX DisplayString 317 MAX-ACCESS read-only 318 STATUS current 319 DESCRIPTION 320 "The manufacturer's serial number for this device." 321 ::= { docsDevBase 4 } 323 docsDevSTPControl OBJECT-TYPE 324 SYNTAX INTEGER { 325 stEnabled(1), 326 noStFilterBpdu(2), 327 noStPassBpdu(3) 328 } 329 MAX-ACCESS read-write 330 STATUS current 331 DESCRIPTION 332 "This object controls operation of the spanning tree 333 protocol (as distinguished from transparent bridging). 334 If set to stEnabled(1) then the spanning tree protocol 335 is enabled, subject to bridging constraints. If 336 noStFilterBpdu(2), then spanning tree is not active, 337 and Bridge PDUs received are discarded. 338 If noStPassBpdu(3) then spanning tree is not active 339 and Bridge PDUs are transparently forwarded. Note that 340 a device need not implement all of these options, 341 but that noStFilterBpdu(2) is required." 342 ::= { docsDevBase 5 } 344 -- 345 -- The following table provides one level of security for access 346 -- to the device by network management stations. 348 -- Note that access is also constrained by the 349 -- community strings and any vendor-specific security. 350 -- 352 docsDevNmAccessTable OBJECT-TYPE 353 SYNTAX SEQUENCE OF DocsDevNmAccessEntry 354 MAX-ACCESS not-accessible 355 STATUS current 356 DESCRIPTION 357 "This table controls access to SNMP objects by network 358 management stations." 359 ::= { docsDevMIBObjects 2 } 361 docsDevNmAccessEntry OBJECT-TYPE 362 SYNTAX DocsDevNmAccessEntry 363 MAX-ACCESS not-accessible 364 STATUS current 365 DESCRIPTION 366 "Controls access to SNMP objects by a particular network 367 management station. For each entry in this table, the 368 contents are not readable unless the management station 369 has read-write permission." 370 INDEX { docsDevNmAccessIndex } 371 ::= { docsDevNmAccessTable 1 } 373 DocsDevNmAccessEntry ::= SEQUENCE { 374 docsDevNmAccessIndex INTEGER, 375 docsDevNmAccessIp IpAddress, 376 docsDevNmAccessIpMask IpAddress, 377 docsDevNmAccessCommunity DisplayString, 378 docsDevNmAccessControl INTEGER, 379 docsDevNmAccessInterfaces OCTET STRING, 380 docsDevNmAccessStatus RowStatus 381 } 383 docsDevNmAccessIndex OBJECT-TYPE 384 SYNTAX INTEGER (1..2147483647) 385 MAX-ACCESS not-accessible 386 STATUS current 387 DESCRIPTION 388 "Index used to order the application of access entries." 389 ::= { docsDevNmAccessEntry 1 } 391 docsDevNmAccessIp OBJECT-TYPE 392 SYNTAX IpAddress 393 MAX-ACCESS read-create 394 STATUS current 395 DESCRIPTION 396 "The IP address (or subnet) of the network management 397 station. The address 255.255.255.255 is defined to mean 398 any NMS. If traps are enabled for this entry, then the 399 value must be the address of a specific device." 401 DEFVAL { 'ffffffff'h } 402 ::= { docsDevNmAccessEntry 2 } 404 docsDevNmAccessIpMask OBJECT-TYPE 405 SYNTAX IpAddress 406 MAX-ACCESS read-create 407 STATUS current 408 DESCRIPTION 409 "The IP subnet mask of the network management stations. 410 If traps are enabled for this entry, then the value must 411 be 255.255.255.255." 412 DEFVAL { 'ffffffff'h } 413 ::= { docsDevNmAccessEntry 3 } 415 docsDevNmAccessCommunity OBJECT-TYPE 416 SYNTAX DisplayString 417 MAX-ACCESS read-create 418 STATUS current 419 DESCRIPTION 420 "The community string to be matched for access by this 421 entry. If set to the null string then any community string 422 will match." 423 DEFVAL { "public" } 424 ::= { docsDevNmAccessEntry 4 } 426 docsDevNmAccessControl OBJECT-TYPE 427 SYNTAX INTEGER { 428 none(1), 429 read(2), 430 readWrite(3), 431 roWithTraps(4), 432 rwWithTraps(5), 433 trapsOnly(6) 434 } 435 MAX-ACCESS read-create 436 STATUS current 437 DESCRIPTION 438 "Specifies the type of access allowed to this NMS. Setting 439 this object to none(1) causes the table entry to be 440 destroyed. Read(2) allows access by 'get' and 'get-next' 441 PDUs. ReadWrite(3) allows access by 'set' as well. 442 RoWithtraps(4), rwWithTraps(5), and trapsOnly(6) 443 control distribution of Trap PDUs transmitted by this 444 device." 445 DEFVAL { read } 446 ::= { docsDevNmAccessEntry 5 } 448 -- The syntax of the following object was copied from RFC1493, 449 -- dot1dStaticAllowedToGoTo. 451 docsDevNmAccessInterfaces OBJECT-TYPE 452 SYNTAX OCTET STRING 453 MAX-ACCESS read-create 454 STATUS current 455 DESCRIPTION 456 "Specifies the set of interfaces from which requests from 457 this NMS will be accepted. 458 Each octet within the value of this object specifies a set 459 of eight interfaces, with the first octet specifying ports 460 1 through 8, the second octet specifying interfaces 9 461 through 16, etc. Within each octet, the most significant 462 bit represents the lowest numbered interface, and the least 463 significant bit represents the highest numbered interface. 464 Thus, each interface is represented by a single bit within 465 the value of this object. If that bit has a value of '1' 466 then that interface is included in the set. 468 Note that entries in this table apply only to link-layer 469 interfaces (e.g., Ethernet and CATV MAC). Upstream and 470 downstream channel interfaces must not be specified." 471 -- DEFVAL is the bitmask corresponding to all interfaces 472 ::= { docsDevNmAccessEntry 6 } 474 docsDevNmAccessStatus OBJECT-TYPE 475 SYNTAX RowStatus 476 MAX-ACCESS read-create 477 STATUS current 478 DESCRIPTION 479 "Controls and reflects the status of rows in this table." 480 ::= { docsDevNmAccessEntry 7 } 482 -- 483 -- Procedures for using the following group are described in section 484 -- 3.2.1 485 -- 487 docsDevSoftware OBJECT IDENTIFIER ::= { docsDevMIBObjects 3 } 489 docsDevSwServer OBJECT-TYPE 490 SYNTAX IpAddress 491 MAX-ACCESS read-write 492 STATUS current 493 DESCRIPTION 494 "The address of the TFTP server used for software upgrades." 495 ::= { docsDevSoftware 1 } 497 docsDevSwFilename OBJECT-TYPE 498 SYNTAX DisplayString (SIZE (0..32)) 499 MAX-ACCESS read-write 500 STATUS current 501 DESCRIPTION 502 "The file name of the software image to be loaded into this 503 device. Unless set via SNMP, this is the file name 504 specified by the provisioning server that corresponds to 505 the software version that is desired for this device. 506 If unknown, the string '(unknown)' is returned." 507 ::= { docsDevSoftware 2 } 509 docsDevSwAdminStatus OBJECT-TYPE 510 SYNTAX INTEGER { 511 upgradeFromMgt(1), 512 allowProvisioningUpgrade(2) 513 } 514 MAX-ACCESS read-write 515 STATUS current 516 DESCRIPTION 517 "If set to upgradeFromMgt(1), the device initiates a TFTP 518 download using docsDevSwFilename. On successfully 519 receiving an image, the device will re-boot. On reboots, 520 the device will disregard software information from the 521 provisioning server. If set to allowProvisioningUpgrade(2), 522 the device will use the software version information 523 supplied by the provisioning server when next rebooting 524 (this does not cause a re-boot)." 525 ::= { docsDevSoftware 3 } 527 docsDevSwOperStatus OBJECT-TYPE 528 SYNTAX INTEGER { 529 inProgress(1), 530 completeFromProvisioning(2), 531 completeFromMgt(3), 532 failed(4), 533 other(5) 534 } 535 MAX-ACCESS read-only 536 STATUS current 537 DESCRIPTION 538 "InProgress(1) indicates that a TFTP download is underway, 539 either as a result of a version mismatch at provisioning 540 or as a result of a upgradeFromMgt request. 541 CompleteFromProvisioning(2) indicates that the last 542 software upgrade was a result of version mismatch at 543 provisioning. CompleteFromMgt(3) indicates that the last 544 software upgrade was a result of setting 545 docsDevSwAdminStatus to upgradeFromMgt. 546 Failed(4) indicates that the last attempted download 547 failed, ordinarily due to TFTP timeout." 548 ::= { docsDevSoftware 4 } 550 -- 551 -- The following group describes server access and parameters used for 552 -- initial provisioning and bootstrapping. 553 -- 555 docsDevServer OBJECT IDENTIFIER ::= { docsDevMIBObjects 4 } 556 docsDevServerBootState OBJECT-TYPE 557 SYNTAX INTEGER { 558 operational(1), 559 disabled(2), 560 waitingForDhcpOffer(3), 561 waitingForDhcpResponse(4), 562 waitingForTimeServer(5), 563 waitingForTftp(6), 564 refusedByCmts(7), 565 forwardingDenied(8), 566 other(9), 567 unknown(10) 568 } 569 MAX-ACCESS read-only 570 STATUS current 571 DESCRIPTION 572 "If operational(1), the device has completed loading and 573 processing of configuration parameters and the CMTS has 574 completed the Registration exchange. 575 If disabled(2) then the device was administratively 576 disabled, possibly by being refused network access in the 577 configuration file. 578 If waitingForDhcpOffer(3) then a DHCP Discover has been 579 transmitted and no offer has yet been received. 580 If waitingForDhcpResponse(4) then a DHCP Request has been 581 transmitted and no response has yet been received. 582 If waitingForTimeServer(5) then a Time Request has been 583 transmitted and no response has yet been received. 584 If waitingForTftp(6) then a request to the TFTP parameter 585 server has been made and no response received. 586 If refusedByCmts(7) then the Registration Request/Response 587 exchange with the CMTS failed. 588 If forwardingDenied(8) then the registration process 589 completed, but the network access option in the received 590 configuration file prohibits forwarding. " 591 ::= { docsDevServer 1 } 593 docsDevServerDhcp OBJECT-TYPE 594 SYNTAX IpAddress 595 MAX-ACCESS read-only 596 STATUS current 597 DESCRIPTION 598 "The IP address of the DHCP server that assigned an IP 599 address to this device. Returns 0.0.0.0 if DHCP was not 600 used for IP address assignment." 601 ::= { docsDevServer 2 } 603 docsDevServerTime OBJECT-TYPE 604 SYNTAX IpAddress 605 MAX-ACCESS read-only 606 STATUS current 607 DESCRIPTION 608 "The IP address of the Time server (RFC-868)." 609 ::= { docsDevServer 3 } 611 docsDevServerTftp OBJECT-TYPE 612 SYNTAX IpAddress 613 MAX-ACCESS read-only 614 STATUS current 615 DESCRIPTION 616 "The IP address of the TFTP server responsible for 617 downloading provisioning and configuration parameters 618 to this device." 619 ::= { docsDevServer 4 } 621 docsDevServerConfigFile OBJECT-TYPE 622 SYNTAX DisplayString 623 MAX-ACCESS read-only 624 STATUS current 625 DESCRIPTION 626 "The name of the device configuration file read from the 627 TFTP server." 628 ::= { docsDevServer 5 } 630 -- 631 -- Event Reporting 632 -- 634 docsDevEvent OBJECT IDENTIFIER ::= { docsDevMIBObjects 5 } 636 docsDevEvControl OBJECT-TYPE 637 SYNTAX INTEGER { 638 resetLog(1), 639 useDefaultReporting(2) 640 } 641 MAX-ACCESS read-write 642 STATUS current 643 DESCRIPTION 644 "Setting this object to resetLog(1) empties the event log. 645 All data is deleted. Setting it to useDefaultReporting(2) 646 returns all event priorities to their factory-default 647 reporting. Reading this object always returns 648 useDefaultReporting(2)." 649 ::= { docsDevEvent 1 } 651 docsDevEvSyslog OBJECT-TYPE 652 SYNTAX IpAddress 653 MAX-ACCESS read-write 654 STATUS current 655 DESCRIPTION 656 "The IP address of the Syslog server. If 0.0.0.0, syslog 657 transmission is inhibited." 658 ::= { docsDevEvent 2 } 660 docsDevEvThrottleAdminStatus OBJECT-TYPE 661 SYNTAX INTEGER { 662 unconstrained(1), 663 maintainBelowThreshold(2), 664 stopAtThreshold(3), 665 inhibited(4) 666 } 667 MAX-ACCESS read-write 668 STATUS current 669 DESCRIPTION 670 "Controls the transmission of traps and syslog messages 671 with respect to the trap pacing threshold. 672 unconstrained(1) causes traps and syslog messages to be 673 transmitted without regard to the threshold settings. 674 maintainBelowThreshold(2) causes trap transmission and 675 syslog messages to be suppressed if the number of traps 676 would otherwise exceed the threshold. 677 stopAtThreshold(3) causes trap transmission to cease 678 at the threshold, and not resume until directed to do so. 679 inhibited(4) causes all trap transmission and syslog 680 messages to be suppressed. 682 A single event is always treated as a single event for 683 threshold counting. That is, an event causing both a trap 684 and a syslog message is still treated as a single event. 686 Writing to this object resets the thresholding state." 687 ::= { docsDevEvent 3 } 689 docsDevEvThrottleInhibited OBJECT-TYPE 690 SYNTAX TruthValue 691 MAX-ACCESS read-only 692 STATUS current 693 DESCRIPTION 694 "If true(1), trap and syslog transmission is currently 695 inhibited due to thresholds and/or the current setting of 696 docsDevEvThrottleAdminStatus." 697 ::= { docsDevEvent 4 } 699 docsDevEvThrottleThreshold OBJECT-TYPE 700 SYNTAX Unsigned32 701 MAX-ACCESS read-write 702 STATUS current 703 DESCRIPTION 704 "Number of trap/syslog events per docsDevEvThrottleInterval 705 to be transmitted before throttling. 707 A single event is always treated as a single event for 708 threshold counting. That is, an event causing both a trap 709 and a syslog message is still treated as a single event." 710 ::= { docsDevEvent 5 } 712 docsDevEvThrottleInterval OBJECT-TYPE 713 SYNTAX INTEGER(1..2147483647) 714 UNITS "seconds" 715 MAX-ACCESS read-write 716 STATUS current 717 DESCRIPTION 718 "The interval over which the trap threshold applies." 719 ::= { docsDevEvent 6 } 721 -- 722 -- The following table controls the reporting of the various classes of 723 -- events. For each event priority, 724 -- a combination of logging and reporting mechanisms may be chosen. The 725 -- mapping of event types 726 -- to priorities is vendor-dependent. Vendors may also choose to allow 727 -- the user to control that mapping 728 -- through proprietary means. 730 docsDevEvControlTable OBJECT-TYPE 731 SYNTAX SEQUENCE OF DocsDevEvControlEntry 732 MAX-ACCESS not-accessible 733 STATUS current 734 DESCRIPTION 735 "Allows control of the reporting of event classes." 736 ::= { docsDevEvent 7 } 738 docsDevEvControlEntry OBJECT-TYPE 739 SYNTAX DocsDevEvControlEntry 740 MAX-ACCESS not-accessible 741 STATUS current 742 DESCRIPTION 743 "Allows configuration of the reporting mechanisms for a 744 particular event priority." 745 INDEX { docsDevEvPriority } 746 ::= { docsDevEvControlTable 1 } 748 DocsDevEvControlEntry ::= SEQUENCE { 749 docsDevEvPriority INTEGER, 750 docsDevEvReporting BITS 751 } 753 docsDevEvPriority OBJECT-TYPE 754 SYNTAX INTEGER { 755 emergency(1), 756 alert(2), 757 critical(3), 758 error(4), 759 warning(5), 760 notice(6), 761 information(7), 762 debug(8) 764 } 765 MAX-ACCESS not-accessible 766 STATUS current 767 DESCRIPTION 768 "The priority level that is controlled by this entry." 769 ::= { docsDevEvControlEntry 1 } 771 docsDevEvReporting OBJECT-TYPE 772 SYNTAX BITS { 773 local(0), 774 traps(1), 775 syslog(2) 776 } 777 MAX-ACCESS read-write 778 STATUS current 779 DESCRIPTION 780 "Defines the action to be taken on occurrence of this 781 event class. Implementations may not necessarily support 782 all options for all event classes, but at minimum must 783 allow traps and syslogging to be disabled." 784 ::= { docsDevEvControlEntry 2 } 786 docsDevEventTable OBJECT-TYPE 787 SYNTAX SEQUENCE OF DocsDevEventEntry 788 MAX-ACCESS not-accessible 789 STATUS current 790 DESCRIPTION 791 "Contains a log of network and device events that may be 792 of interest in fault isolation and troubleshooting." 793 ::= { docsDevEvent 8 } 795 docsDevEventEntry OBJECT-TYPE 796 SYNTAX DocsDevEventEntry 797 MAX-ACCESS not-accessible 798 STATUS current 799 DESCRIPTION 800 "Describes a network or device event that may be of 801 interest in fault isolation and troubleshooting." 802 INDEX { docsDevEvIndex } 803 ::= { docsDevEventTable 1 } 805 DocsDevEventEntry ::= SEQUENCE { 806 docsDevEvIndex INTEGER, 807 docsDevEvFirstTime DateAndTime, 808 docsDevEvLastTime DateAndTime, 809 docsDevEvCount Counter32, 810 docsDevEvLevel INTEGER, 811 docsDevEvId Unsigned32, 812 docsDevEvText DisplayString 813 } 815 docsDevEvIndex OBJECT-TYPE 816 SYNTAX INTEGER (1..2147483647) 817 MAX-ACCESS not-accessible 818 STATUS current 819 DESCRIPTION 820 "Provides relative ordering of the objects in the event 821 log. This object will always increase except when 822 (a) the log is reset via docsDevEvControl, 823 (b) the device reboots and does not implement nonvolatile 824 storage for this log, or (c) it reaches the value 2^31. 825 The next entry for all the above cases is 1." 826 ::= { docsDevEventEntry 1 } 828 docsDevEvFirstTime OBJECT-TYPE 829 SYNTAX DateAndTime 830 MAX-ACCESS read-only 831 STATUS current 832 DESCRIPTION 833 "The time that this entry was created." 834 ::= { docsDevEventEntry 2 } 836 docsDevEvLastTime OBJECT-TYPE 837 SYNTAX DateAndTime 838 MAX-ACCESS read-only 839 STATUS current 840 DESCRIPTION 841 "If multiple events are reported via the same entry, the 842 time that the last event for this entry occurred." 843 ::= { docsDevEventEntry 3 } 845 docsDevEvCount OBJECT-TYPE 846 SYNTAX Counter32 847 MAX-ACCESS read-only 848 STATUS current 849 DESCRIPTION 850 "The number of consecutive event instances reported by 851 this entry." 852 ::= { docsDevEventEntry 4 } 854 docsDevEvLevel OBJECT-TYPE 855 SYNTAX INTEGER { 856 emergency(1), 857 alert(2), 858 critical(3), 859 error(4), 860 warning(5), 861 notice(6), 862 information(7), 863 debug(8) 864 } 865 MAX-ACCESS read-only 866 STATUS current 867 DESCRIPTION 868 "The priority level of this event." 869 ::= { docsDevEventEntry 5 } 871 -- 872 -- Vendors will provide their own enumerations for the following. 873 -- The interpretation of the enumeration is unambiguous for a 874 -- particular value of the vendor's enterprise number in sysObjectID. 875 -- 877 docsDevEvId OBJECT-TYPE 878 SYNTAX Unsigned32 879 MAX-ACCESS read-only 880 STATUS current 881 DESCRIPTION 882 "For this product, uniquely identifies the type of event 883 that is reported by this entry." 884 ::= { docsDevEventEntry 6 } 886 docsDevEvText OBJECT-TYPE 887 SYNTAX DisplayString 888 MAX-ACCESS read-only 889 STATUS current 890 DESCRIPTION 891 "Provides a human-readable description of the event, 892 including all relevant context (interface numbers, 893 etc.)." 894 ::= { docsDevEventEntry 7 } 896 docsDevFilter OBJECT IDENTIFIER ::= { docsDevMIBObjects 6 } 898 -- LLC filters can be defined on an inclusive or exclusive basis: CMs 899 -- can be configured to forward only packets matching a set of layer 900 -- three protocols, or to drop packets matching a set of layer three 901 -- protocols. 903 docsDevFilterLLCDefault OBJECT-TYPE 904 SYNTAX INTEGER { 905 discard(1), 906 accept(2) 907 } 908 MAX-ACCESS read-write 909 STATUS current 910 DESCRIPTION 911 "If set to discard(1), all packets matching an LLC filter 912 will be discarded. If set to accept(2), only packets 913 matching an LLC filter will be accepted for further 914 processing (e.g., bridging)." 915 ::= { docsDevFilter 1 } 917 docsDevFilterLLCTable OBJECT-TYPE 918 SYNTAX SEQUENCE OF DocsDevFilterLLCEntry 919 MAX-ACCESS not-accessible 920 STATUS current 921 DESCRIPTION 922 "A list of filters to apply to (bridged) LLC traffic, which 923 forwards or drops packets on the basis of the layer three 924 protocol type." 925 ::= { docsDevFilter 2 } 927 docsDevFilterLLCEntry OBJECT-TYPE 928 SYNTAX DocsDevFilterLLCEntry 929 MAX-ACCESS not-accessible 930 STATUS current 931 DESCRIPTION 932 "Describes a single filter to apply to (bridged) LLC traffic 933 received on a specified interface. " 934 INDEX { docsDevFilterLLCIndex } 935 ::= { docsDevFilterLLCTable 1 } 937 DocsDevFilterLLCEntry ::= SEQUENCE { 938 docsDevFilterLLCIndex INTEGER, 939 docsDevFilterLLCStatus RowStatus, 940 docsDevFilterLLCIfIndex InterfaceIndexOrZero, 941 docsDevFilterLLCProtocolType INTEGER, 942 docsDevFilterLLCProtocol INTEGER, 943 docsDevFilterLLCMatches Counter32 944 } 946 docsDevFilterLLCIndex OBJECT-TYPE 947 SYNTAX INTEGER (1..2147483647) 948 MAX-ACCESS not-accessible 949 STATUS current 950 DESCRIPTION 951 "Index used for the identification of filters (note that LLC 952 filter order is irrelevant)." 953 ::= { docsDevFilterLLCEntry 1 } 955 docsDevFilterLLCStatus OBJECT-TYPE 956 SYNTAX RowStatus 957 MAX-ACCESS read-create 958 STATUS current 959 DESCRIPTION 960 "Controls and reflects the status of rows in this table." 961 ::= { docsDevFilterLLCEntry 2} 963 docsDevFilterLLCIfIndex OBJECT-TYPE 964 SYNTAX InterfaceIndexOrZero 965 MAX-ACCESS read-create 966 STATUS current 967 DESCRIPTION 968 "The entry interface to which this filter applies. 969 The value corresponds to ifIndex for either a CATV MAC 970 or another network interface. If the value is zero, the 971 filter applies to all interfaces. In Cable Modems, the 972 default value is the customer side interface. In Cable 973 Modem Termination Systems, this object has to be 974 specified to create a row in this table." 975 ::= { docsDevFilterLLCEntry 3 } 977 docsDevFilterLLCProtocolType OBJECT-TYPE 978 SYNTAX INTEGER { 979 ethertype(1), 980 dsap(2) 981 } 982 MAX-ACCESS read-create 983 STATUS current 984 DESCRIPTION 985 "The format of the value in docsDevFilterLLCProtocol: 986 either a two-byte Ethernet Ethertype, or a one-byte 987 802.2 SAP value. EtherType(1) also applies to SNAP- 988 encapsulated frames." 989 DEFVAL { ethertype } 990 ::= { docsDevFilterLLCEntry 4 } 992 docsDevFilterLLCProtocol OBJECT-TYPE 993 SYNTAX INTEGER (0..65535) 994 MAX-ACCESS read-create 995 STATUS current 996 DESCRIPTION 997 "The layer three protocol for which this filter applies. 998 The protocol value format depends on 999 docsDevFilterLLCProtocolType. Note that for SNAP frames, 1000 etherType filtering is performed rather than DSAP=0xAA." 1001 DEFVAL { 0 } 1002 ::= { docsDevFilterLLCEntry 5 } 1004 docsDevFilterLLCMatches OBJECT-TYPE 1005 SYNTAX Counter32 1006 MAX-ACCESS read-only 1007 STATUS current 1008 DESCRIPTION 1009 "Counts the number of times this filter was matched." 1010 ::= { docsDevFilterLLCEntry 6 } 1012 -- The default behavior for (bridged) packets that do not match IP 1013 -- filters is defined by 1014 -- docsDevFilterIpDefault. 1016 docsDevFilterIpDefault OBJECT-TYPE 1017 SYNTAX INTEGER { 1018 discard(1), 1019 accept(2) 1020 } 1021 MAX-ACCESS read-write 1022 STATUS current 1023 DESCRIPTION 1024 "If set to discard(1), all packets not matching an IP filter 1025 will be discarded. If set to accept(2), all packets not 1026 matching an IP filter will be accepted for further 1027 processing (e.g., bridging)." 1028 ::= { docsDevFilter 3 } 1030 docsDevFilterIpTable OBJECT-TYPE 1031 SYNTAX SEQUENCE OF DocsDevFilterIpEntry 1032 MAX-ACCESS not-accessible 1033 STATUS current 1034 DESCRIPTION 1035 "An ordered list of filters to apply to IP traffic. Filter 1036 application is ordered by the filter index, rather than 1037 by a best match algorithm. Packets which match no filters 1038 are discarded or forwarded according to the setting of 1039 docsDevFilterIpDefault." 1040 ::= { docsDevFilter 4 } 1042 docsDevFilterIpEntry OBJECT-TYPE 1043 SYNTAX DocsDevFilterIpEntry 1044 MAX-ACCESS not-accessible 1045 STATUS current 1046 DESCRIPTION 1047 "Describes a filter to apply to IP traffic received on a 1048 specified interface. Both source and destination addresses 1049 must match for the filter to apply." 1050 INDEX { docsDevFilterIpIndex } 1051 ::= { docsDevFilterIpTable 1 } 1053 DocsDevFilterIpEntry ::= SEQUENCE { 1054 docsDevFilterIpIndex INTEGER, 1055 docsDevFilterIpStatus RowStatus, 1056 docsDevFilterIpControl INTEGER, 1057 docsDevFilterIpIfIndex InterfaceIndexOrZero, 1058 docsDevFilterIpDirection INTEGER, 1059 docsDevFilterIpBroadcast TruthValue, 1060 docsDevFilterIpSaddr IpAddress, 1061 docsDevFilterIpSmask IpAddress, 1062 docsDevFilterIpDaddr IpAddress, 1063 docsDevFilterIpDmask IpAddress, 1064 docsDevFilterIpProtocol INTEGER, 1065 docsDevFilterIpSourcePortLow INTEGER, 1066 docsDevFilterIpSourcePortHigh INTEGER, 1067 docsDevFilterIpDestPortLow INTEGER, 1068 docsDevFilterIpDestPortHigh INTEGER, 1069 docsDevFilterIpMatches Counter32 1070 } 1072 docsDevFilterIpIndex OBJECT-TYPE 1073 SYNTAX INTEGER (1..2147483647) 1074 MAX-ACCESS not-accessible 1075 STATUS current 1076 DESCRIPTION 1077 "Index used to order the application of filters. 1078 The filter with the lowest index is always applied 1079 first." 1080 ::= { docsDevFilterIpEntry 1 } 1082 docsDevFilterIpStatus OBJECT-TYPE 1083 SYNTAX RowStatus 1084 MAX-ACCESS read-create 1085 STATUS current 1086 DESCRIPTION 1087 "Controls and reflects the status of rows in this table." 1088 ::= { docsDevFilterIpEntry 2 } 1090 docsDevFilterIpControl OBJECT-TYPE 1091 SYNTAX INTEGER { 1092 discard(1), 1093 accept(2) 1094 } 1095 MAX-ACCESS read-create 1096 STATUS current 1097 DESCRIPTION 1098 "If set to discard(1), all packets matching this filter 1099 will be discarded and scanning of the remainder of the 1100 filter list will be aborted. If set to accept(2), all 1101 packets matching this filter will be accepted for further 1102 processing (e.g., bridging) and scanning of the remainder 1103 of the filter list will be aborted. " 1104 DEFVAL { discard } 1105 ::= { docsDevFilterIpEntry 3 } 1107 docsDevFilterIpIfIndex OBJECT-TYPE 1108 SYNTAX InterfaceIndexOrZero 1109 MAX-ACCESS read-create 1110 STATUS current 1111 DESCRIPTION 1112 "The entry interface to which this filter applies. The 1113 value corresponds to ifIndex for either a CATV MAC or 1114 another network interface. If the value is zero, the 1115 filter applies to all interfaces. Default value in Cable 1116 Modems is the customer-side interface. In Cable Modem 1117 Termination Systems, this object has to be specified to 1118 create a row in this table." 1119 ::= { docsDevFilterIpEntry 4 } 1121 docsDevFilterIpDirection OBJECT-TYPE 1122 SYNTAX INTEGER { 1123 inbound(1), 1124 outbound(2), 1125 both(3) 1126 } 1127 MAX-ACCESS read-create 1128 STATUS current 1129 DESCRIPTION 1130 "Determines whether the filter is applied to inbound(1) 1131 traffic, outbound(2) traffic, or traffic in both(3) 1132 directions." 1133 DEFVAL { inbound } 1134 ::= { docsDevFilterIpEntry 5 } 1136 docsDevFilterIpBroadcast OBJECT-TYPE 1137 SYNTAX TruthValue 1138 MAX-ACCESS read-create 1139 STATUS current 1140 DESCRIPTION 1141 "If set to true(1), the filter only applies to multicast 1142 and broadcast traffic. If set to false(2), the filter 1143 applies to all traffic." 1144 DEFVAL { false } 1145 ::= { docsDevFilterIpEntry 6 } 1147 docsDevFilterIpSaddr OBJECT-TYPE 1148 SYNTAX IpAddress 1149 MAX-ACCESS read-create 1150 STATUS current 1151 DESCRIPTION 1152 "The source IP address, or portion thereof, that is to be 1153 matched for this filter." 1154 DEFVAL { '00000000'h } 1155 ::= { docsDevFilterIpEntry 7 } 1157 docsDevFilterIpSmask OBJECT-TYPE 1158 SYNTAX IpAddress 1159 MAX-ACCESS read-create 1160 STATUS current 1161 DESCRIPTION 1162 "A bit mask that is to be applied to the source address 1163 prior to matching. This mask is not necessarily the same 1164 as a subnet mask, but 1's bits must be leftmost and 1165 contiguous." 1166 DEFVAL { '00000000'h } 1167 ::= { docsDevFilterIpEntry 8 } 1169 docsDevFilterIpDaddr OBJECT-TYPE 1170 SYNTAX IpAddress 1171 MAX-ACCESS read-create 1172 STATUS current 1173 DESCRIPTION 1174 "The destination IP address, or portion thereof, that is 1175 to be matched for this filter " 1176 DEFVAL { '00000000'h } 1177 ::= { docsDevFilterIpEntry 9 } 1179 docsDevFilterIpDmask OBJECT-TYPE 1180 SYNTAX IpAddress 1181 MAX-ACCESS read-create 1182 STATUS current 1183 DESCRIPTION 1184 "A bit mask that is to be applied to the destination 1185 address prior to matching. This mask is not necessarily 1186 the same as a subnet mask, but 1's bits must be leftmost 1187 and contiguous " 1188 DEFVAL { '00000000'h } 1189 ::= { docsDevFilterIpEntry 10 } 1191 docsDevFilterIpProtocol OBJECT-TYPE 1192 SYNTAX INTEGER { 1193 icmp(1), 1194 tcp(6), 1195 udp(17), 1196 any(256) 1197 } 1198 MAX-ACCESS read-create 1199 STATUS current 1200 DESCRIPTION 1201 "The IP protocol value that is to be matched." 1202 DEFVAL { any } 1203 ::= { docsDevFilterIpEntry 11 } 1205 docsDevFilterIpSourcePortLow OBJECT-TYPE 1206 SYNTAX INTEGER (0..65535) 1207 MAX-ACCESS read-create 1208 STATUS current 1209 DESCRIPTION 1210 "If docsDevFilterIpProtocol is udp or tcp, this is the 1211 inclusive lower bound of the transport-layer source port 1212 range that is to be matched." 1213 DEFVAL { 0 } 1214 ::= { docsDevFilterIpEntry 12 } 1216 docsDevFilterIpSourcePortHigh OBJECT-TYPE 1217 SYNTAX INTEGER (0..65535) 1218 MAX-ACCESS read-create 1219 STATUS current 1220 DESCRIPTION 1221 "If docsDevFilterIpProtocol is udp or tcp, this is the 1222 inclusive upper bound of the transport-layer source port 1223 range that is to be matched." 1224 DEFVAL { 65535 } 1225 ::= { docsDevFilterIpEntry 13 } 1227 docsDevFilterIpDestPortLow OBJECT-TYPE 1228 SYNTAX INTEGER (0..65535) 1229 MAX-ACCESS read-create 1230 STATUS current 1231 DESCRIPTION 1232 "If docsDevFilterIpProtocol is udp or tcp, this is the 1233 inclusive lower bound of the transport-layer destination 1234 port range that is to be matched." 1235 DEFVAL { 0 } 1236 ::= { docsDevFilterIpEntry 14 } 1238 docsDevFilterIpDestPortHigh OBJECT-TYPE 1239 SYNTAX INTEGER (0..65535) 1240 MAX-ACCESS read-create 1241 STATUS current 1242 DESCRIPTION 1243 "If docsDevFilterIpProtocol is udp or tcp, this is the 1244 inclusive upper bound of the transport-layer destination 1245 port range that is to be matched." 1246 DEFVAL { 65535 } 1247 ::= { docsDevFilterIpEntry 15 } 1249 docsDevFilterIpMatches OBJECT-TYPE 1250 SYNTAX Counter32 1251 MAX-ACCESS read-only 1252 STATUS current 1253 DESCRIPTION 1254 "Counts the number of times this filter was matched." 1255 ::= { docsDevFilterIpEntry 16 } 1257 -- 1258 -- Placeholder for notifications/traps. 1259 -- 1260 docsDevNotification OBJECT IDENTIFIER ::= { docsDevMIB 2 } 1262 -- 1263 -- Conformance definitions 1264 -- 1265 docsDevConformance OBJECT IDENTIFIER ::= { docsDevMIB 3 } 1266 docsDevGroups OBJECT IDENTIFIER ::= { docsDevConformance 1 } 1267 docsDevCompliances OBJECT IDENTIFIER ::= { docsDevConformance 2 } 1269 docsDevBasicCompliance MODULE-COMPLIANCE 1270 STATUS current 1271 DESCRIPTION 1272 "The compliance statement for MCNS Cable Modems and 1273 Cable Modem Termination Systems." 1275 MODULE -- docsDevMIB 1277 -- conditionally mandatory groups 1279 GROUP docsDevBaseGroup 1280 DESCRIPTION 1281 "Mandatory in Cable Modems, optional in Cable Modem 1282 Termination Systems." 1284 GROUP docsDevEventGroup 1285 DESCRIPTION 1286 "Mandatory in Cable Modems, optional in Cable Modem 1287 Termination Systems." 1289 GROUP docsDevFilterGroup 1290 DESCRIPTION 1291 "Mandatory in Cable Modems, optional in Cable Modem 1292 Termination Systems." 1294 GROUP docsDevNmAccessGroup 1295 DESCRIPTION 1296 "Mandatory in Cable Modems, optional in Cable Modem 1297 Termination Systems." 1299 GROUP docsDevServerGroup 1300 DESCRIPTION 1301 "This group is implemented only in Cable Modems, 1302 not in Cable Modem Termination Systems." 1304 GROUP docsDevSoftwareGroup 1305 DESCRIPTION 1306 "Mandatory in Cable Modems, optional in Cable Modem 1307 Termination Systems." 1309 OBJECT docsDevSTPControl 1310 MIN-ACCESS read-only 1311 DESCRIPTION 1312 "It is compliant to implement this object as read-only. 1313 Devices need only support noStFilterBpdu(2)." 1315 OBJECT docsDevEvReporting 1316 MIN-ACCESS read-only 1317 DESCRIPTION 1318 "It is compliant to implement this object as read-only. 1319 Devices need only support local(1)." 1321 ::= { docsDevCompliances 1 } 1323 docsDevBaseGroup OBJECT-GROUP 1324 OBJECTS { 1325 docsDevRole, 1326 docsDevDateTime, 1327 docsDevResetNow, 1328 docsDevSerialNumber, 1329 docsDevSTPControl 1330 } 1331 STATUS current 1332 DESCRIPTION 1333 "A collection of objects providing device status and 1334 control." 1335 ::= { docsDevGroups 1 } 1337 docsDevNmAccessGroup OBJECT-GROUP 1338 OBJECTS { 1339 docsDevNmAccessIp, 1340 docsDevNmAccessIpMask, 1341 docsDevNmAccessCommunity, 1342 docsDevNmAccessControl, 1343 docsDevNmAccessInterfaces, 1344 docsDevNmAccessStatus 1345 } 1346 STATUS current 1347 DESCRIPTION 1348 "A collection of objects for controlling access to SNMP 1349 objects." 1350 ::= { docsDevGroups 2 } 1352 docsDevSoftwareGroup OBJECT-GROUP 1353 OBJECTS { 1354 docsDevSwServer, 1355 docsDevSwFilename, 1356 docsDevSwAdminStatus, 1357 docsDevSwOperStatus 1358 } 1359 STATUS current 1360 DESCRIPTION 1361 "A collection of objects for controlling software 1362 downloads." 1363 ::= { docsDevGroups 3 } 1365 docsDevServerGroup OBJECT-GROUP 1366 OBJECTS { 1367 docsDevServerBootState, 1368 docsDevServerDhcp, 1369 docsDevServerTime, 1370 docsDevServerTftp, 1371 docsDevServerConfigFile 1372 } 1373 STATUS current 1374 DESCRIPTION 1375 "A collection of objects providing status about server 1376 provisioning." 1377 ::= { docsDevGroups 4 } 1379 docsDevEventGroup OBJECT-GROUP 1380 OBJECTS { 1381 docsDevEvControl, 1382 docsDevEvSyslog, 1383 docsDevEvThrottleAdminStatus, 1384 docsDevEvThrottleInhibited, 1385 docsDevEvThrottleThreshold, 1386 docsDevEvThrottleInterval, 1387 docsDevEvReporting, 1388 docsDevEvFirstTime, 1389 docsDevEvLastTime, 1390 docsDevEvCount, 1391 docsDevEvLevel, 1392 docsDevEvId, 1393 docsDevEvText 1394 } 1395 STATUS current 1396 DESCRIPTION 1397 "A collection of objects used to control and monitor 1398 events." 1399 ::= { docsDevGroups 5 } 1401 docsDevFilterGroup OBJECT-GROUP 1402 OBJECTS { 1403 docsDevFilterLLCDefault, 1404 docsDevFilterIpDefault, 1405 docsDevFilterLLCStatus, 1406 docsDevFilterLLCIfIndex, 1407 docsDevFilterLLCProtocolType, 1408 docsDevFilterLLCProtocol, 1409 docsDevFilterLLCMatches, 1410 docsDevFilterIpControl, 1411 docsDevFilterIpIfIndex, 1412 docsDevFilterIpStatus, 1413 docsDevFilterIpDirection, 1414 docsDevFilterIpBroadcast, 1415 docsDevFilterIpSaddr, 1416 docsDevFilterIpSmask, 1417 docsDevFilterIpDaddr, 1418 docsDevFilterIpDmask, 1419 docsDevFilterIpProtocol, 1420 docsDevFilterIpSourcePortLow, 1421 docsDevFilterIpSourcePortHigh, 1422 docsDevFilterIpDestPortLow, 1423 docsDevFilterIpDestPortHigh, 1424 docsDevFilterIpMatches 1425 } 1426 STATUS current 1427 DESCRIPTION 1428 "A collection of objects to specify filters at link layer 1429 and IP layer." 1430 ::= { docsDevGroups 6 } 1432 END 1433 5. Acknowledgments 1435 This document was produced by the IPCDN Working Group. It is based on a 1436 document written by Pam Anderson from CableLabs, Wilson Sawyer from 1437 BayNetworks, and Rich Woundy from Continental Cablevision. 1439 Special thanks is also due to Azlina Palmer, who helped a lot reviewing 1440 the document. 1442 6. References 1444 [1] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M., and 1445 S. Waldbusser, "Structure of Management Information for Version 2 1446 of the Simple Network Management Protocol (SNMPv2)", RFC 1902, 1447 January 1996. 1449 [2] McCloghrie, K., and M. Rose, Editors, "Management Information Base 1450 for Network Management of TCP/IP-based internets: MIB-II", STD 17, 1451 RFC 1213, Hughes LAN Systems, Performance Systems International, 1452 March 1991. 1454 [3] Case, J., Fedor, M., Schoffstall, M., and J. Davin, "A Simple 1455 Network Management Protocol (SNMP)", STD 15, RFC 1157, SNMP 1456 Research, Performance Systems International, MIT Lab for Computer 1457 Science, May 1990. 1459 [4] SNMPv2 Working Group, Case, J., McCloghrie, K., Rose, M. and 1460 S. Waldbusser, "Protocol Operations for Version 2 of the Simple 1461 Network Management Protocol (SNMPv2)", RFC 1905, January 1996. 1463 [5] McCloghrie, K. and F. Kastenholz, "Evolution of the Interfaces 1464 Group of MIB-II", RFC 1573, Hughes LAN Systems, FTP Software, 1465 January 1994. 1467 [6] "MCNS Data Over Cable Services Cable Modem Radio Frequency 1468 Interface Specification SP-RFID01-970326", MCNS, March 1997. 1470 [7] L. Steinberg, "Techniques for Managing Asynchronously Generated 1471 Alerts", RFC 1224, May 1991. 1473 [8] "MCNS Data Over Cable Services Operations Support System Interface 1474 Specification SP-OSSII01-970403", MCNS, March 1997. 1476 7. Security Considerations 1478 The docsDevNmAccessTable limits network management station access to 1479 devices implementing this MIB, thus providing protection against 1480 configuration changes imposed by unauthorized network management 1481 stations. 1483 It should be noted, however, that this protextion does not prevent 1484 unauthorized access by using wrong IP source address information. Also, 1485 it should be noted that depending of the SNMP version in use the SNMP 1486 data packets may be transmitted unencrypted. Dealing with this kind of 1487 security problems is outside the scope of this specification. 1489 8. Author's Address 1491 Guenter Roeck 1492 cisco Systems 1493 170 West Tasman Drive 1494 San Jose, CA 95134 1495 U.S.A. 1497 Phone: +1 408 527 3143 1498 Email: groeck@cisco.com