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