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