home *** CD-ROM | disk | FTP | other *** search
/ Internet Core Protocols / Oreilly-InternetCoreProtocols.iso / RFCs / rfc2669.txt < prev    next >
Encoding:
Text File  |  1999-10-14  |  113.4 KB  |  3,084 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7. Network Working Group                                  M. St. Johns, Ed.
  8. Request for Comments: 2669                                 @Home Network
  9. Category: Proposed Standard                                  August 1999
  10.  
  11.  
  12.                         DOCSIS Cable Device MIB
  13.                 Cable Device Management Information Base
  14.                  for DOCSIS compliant Cable Modems and
  15.                     Cable Modem Termination Systems
  16.  
  17.  
  18. Status of this Memo
  19.  
  20.    This document specifies an Internet standards track protocol for the
  21.    Internet community, and requests discussion and suggestions for
  22.    improvements.  Please refer to the current edition of the "Internet
  23.    Official Protocol Standards" (STD 1) for the standardization state
  24.    and status of this protocol.  Distribution of this memo is unlimited.
  25.  
  26. Copyright Notice
  27.  
  28.    Copyright (C) The Internet Society (1999).  All Rights Reserved.
  29.  
  30. Abstract
  31.  
  32.    This memo defines a portion of the Management Information Base (MIB)
  33.    for use with network management protocols in the Internet community.
  34.    In particular, it defines a basic set of managed objects for SNMP-
  35.    based management of DOCSIS 1.0 compliant Cable Modems and Cable Modem
  36.    Termination Systems.
  37.  
  38.    This memo specifies a MIB module in a manner that is compliant to the
  39.    SNMP SMIv2 [5][6][7].  The set of objects is consistent with the SNMP
  40.    framework and existing SNMP standards.
  41.  
  42.    This memo is a product of the IPCDN working group within the Internet
  43.    Engineering Task Force.  Comments are solicited and should be
  44.    addressed to the working group's mailing list at ipcdn@terayon.com
  45.    and/or the author.
  46.  
  47. Table of Contents
  48.  
  49.    1 The SNMP Management Framework ................................... 2
  50.    2 Glossary ........................................................ 3
  51.    2.1 CATV .......................................................... 3
  52.    2.2 CM ............................................................ 3
  53.    2.3 CMTS .......................................................... 4
  54.    2.4 DOCSIS ........................................................ 4
  55.  
  56.  
  57.  
  58. St. Johns                      Standards                        [Page 1]
  59.  
  60. RFC 2669                DOCSIS Cable Device MIB              August 1999
  61.  
  62.  
  63.    2.5 Downstream .................................................... 4
  64.    2.6 Head-end ...................................................... 4
  65.    2.7 MAC Packet .................................................... 4
  66.    2.8 MCNS .......................................................... 4
  67.    2.9 RF ............................................................ 4
  68.    2.10 Upstream ..................................................... 4
  69.    3 Overview ........................................................ 4
  70.    3.1 Structure of the MIB .......................................... 5
  71.    3.2 Management requirements ....................................... 6
  72.    3.2.1 Handling of Software upgrades ............................... 6
  73.    3.2.2 Events and Traps ............................................ 6
  74.    3.2.3 Trap Throttling ............................................. 8
  75.    3.2.3.1 Trap rate throttling ...................................... 8
  76.    3.2.3.2 Limiting the trap rate .................................... 8
  77.    3.3 Protocol Filters .............................................. 9
  78.    3.3.1 Inbound LLC Filters - docsDevFilterLLCTable ................ 10
  79.    3.3.2 Special Filters ............................................ 10
  80.    3.3.2.1 IP Spoofing Filters - docsDevCpeTable .................... 10
  81.    3.3.2.2 SNMP Access Filters - docsDevNmAccessTable ............... 10
  82.    3.3.3 IP Filtering - docsDevIpFilterTable ........................ 11
  83.    3.3.4 Outbound LLC Filters ....................................... 13
  84.    4 Definitions .................................................... 13
  85.    5 Acknowledgments ................................................ 51
  86.    6 References ..................................................... 51
  87.    7 Security Considerations ........................................ 52
  88.    8 Intellectual Property .......................................... 54
  89.    9 Author's Address ............................................... 54
  90.    10 Full Copyright Statement ...................................... 55
  91.  
  92. 1.  The SNMP Management Framework
  93.  
  94.    The SNMP Management Framework presently consists of five major
  95.    components:
  96.  
  97.    o   An overall architecture, described in RFC 2571 [1].
  98.  
  99.    o   Mechanisms for describing and naming objects and events for the
  100.        purpose of management. The first version of this Structure of
  101.        Management Information (SMI) is called SMIv1 and described in STD
  102.        16, RFC 1155 [2], STD 16, RFC 1212 [3] and RFC 1215 [4].  The
  103.        second version, called SMIv2, is described in STD 58, RFC 2578
  104.        [5], STD 58, RFC 2579 [6] and STD 58, RFC 2580 [7].
  105.  
  106.    o   Message protocols for transferring management information. The
  107.        first version of the SNMP message protocol is called SNMPv1 and
  108.        described in STD 15, RFC 1157 [8]. A second version of the SNMP
  109.        message protocol, which is not an Internet standards track
  110.        protocol, is called SNMPv2c and described in RFC 1901 [9] and RFC
  111.  
  112.  
  113.  
  114. St. Johns                      Standards                        [Page 2]
  115.  
  116. RFC 2669                DOCSIS Cable Device MIB              August 1999
  117.  
  118.  
  119.        1906 [10].  The third version of the message protocol is called
  120.        SNMPv3 and described in RFC 1906 [10], RFC 2572 [11] and RFC 2574
  121.        [12].
  122.  
  123.    o   Protocol operations for accessing management information. The
  124.        first set of protocol operations and associated PDU formats is
  125.        described in STD 15, RFC 1157 [8]. A second set of protocol
  126.        operations and associated PDU formats is described in RFC 1905
  127.        [13].
  128.  
  129.    o   A set of fundamental applications described in RFC 2573 [14] and
  130.        the view-based access control mechanism described in RFC 2575
  131.        [15].
  132.  
  133.    Managed objects are accessed via a virtual information store, termed
  134.    the Management Information Base or MIB.  Objects in the MIB are
  135.    defined using the mechanisms defined in the SMI.
  136.  
  137.    This memo specifies a MIB module that is compliant to the SMIv2. A
  138.    MIB conforming to the SMIv1 can be produced through the appropriate
  139.    translations. The resulting translated MIB must be semantically
  140.    equivalent, except where objects or events are omitted because no
  141.    translation is possible (use of Counter64). Some machine readable
  142.    information in SMIv2 will be converted into textual descriptions in
  143.    SMIv1 during the translation process. However, this loss of machine
  144.    readable information is not considered to change the semantics of the
  145.    MIB.
  146.  
  147. 2.  Glossary
  148.  
  149.    The terms in this document are derived either from normal cable
  150.    system usage, or from the documents associated with the Data Over
  151.    Cable Service Interface Specification process.
  152.  
  153. 2.1.  CATV
  154.  
  155.    Originally "Community Antenna Television", now used to refer to any
  156.    cable or hybrid fiber and cable system used to deliver video signals
  157.    to a community.
  158.  
  159. 2.2.  CM   Cable Modem.
  160.  
  161.    A CM acts as a "slave" station in a DOCSIS compliant cable data
  162.    system.
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170. St. Johns                      Standards                        [Page 3]
  171.  
  172. RFC 2669                DOCSIS Cable Device MIB              August 1999
  173.  
  174.  
  175. 2.3.  CMTS   Cable Modem Termination System.
  176.  
  177.    A generic term covering a cable bridge or cable router in a head-end.
  178.    A CMTS acts as the master station in a DOCSIS compliant cable data
  179.    system.  It is the only station that transmits downstream, and it
  180.    controls the scheduling of upstream transmissions by its associated
  181.    CMs.
  182.  
  183. 2.4.  DOCSIS
  184.  
  185.    "Data Over Cable Interface Specification".  A term referring to the
  186.    ITU-T J.112 Annex B standard for cable modem systems [20].
  187.  
  188. 2.5.  Downstream
  189.  
  190.    The direction from the head-end towards the subscriber.
  191.  
  192. 2.6.  Head-end
  193.  
  194.    The origination point in most cable systems of the subscriber video
  195.    signals. Generally also the location of the CMTS equipment.
  196.  
  197. 2.7.  MAC Packet
  198.  
  199.    A DOCSIS PDU.
  200.  
  201. 2.8.  MCNS
  202.  
  203.    "Multimedia Cable Network System".  Generally replaced in usage by
  204.    DOCSIS.
  205.  
  206. 2.9.  RF
  207.  
  208.    Radio Frequency.
  209.  
  210. 2.10.  Upstream
  211.  
  212.    The direction from the subscriber towards the head-end.
  213.  
  214. 3.  Overview
  215.  
  216.    This MIB provides a set of objects required for the management of
  217.    DOCSIS compliant Cable Modems (CM) and Cable Modem Termination
  218.    Systems (CMTS).  The specification is derived from the DOCSIS Radio
  219.    Frequency Interface specification [16].   Please note that the DOCSIS
  220.    1.0 standard only requires Cable Modems to implement SNMPv1 and to
  221.  
  222.  
  223.  
  224.  
  225.  
  226. St. Johns                      Standards                        [Page 4]
  227.  
  228. RFC 2669                DOCSIS Cable Device MIB              August 1999
  229.  
  230.  
  231.    process IPv4 customer traffic. Design choices in this MIB reflect
  232.    those requirements.  Future versions of the DOCSIS standard are
  233.    expected to require support for SNMPv3 and IPv6 as well.
  234.  
  235.    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
  236.    "SHOULD", "SHOULD NOT", "RECOMMENDED",  "MAY", and "OPTIONAL" in this
  237.    document are to be interpreted as described in [19].
  238.  
  239. 3.1.  Structure of the MIB
  240.  
  241.    This MIB is structured into seven groups:
  242.  
  243.       o    The docsDevBase group extends the MIB-II 'system' group with
  244.            objects needed for cable device system management.
  245.  
  246.       o    The docsDevNmAccessGroup provides a minimum level of SNMP
  247.            access security (see Section 3 of [18]).
  248.  
  249.       o    The docsDevSoftware group provides information for network-
  250.            downloadable software upgrades.  See "Handling of Software
  251.            Upgrades" below..
  252.  
  253.       o    The docsDevServer group provides information about the
  254.            progress of the interaction between the CM or CMTS and
  255.            various provisioning servers.
  256.  
  257.       o    The docsDevEvent group provides control and logging for event
  258.            reporting.
  259.  
  260.       o    The docsDevFilter group configures filters at link layer and
  261.            IP layer for bridged data traffic.  This group consists of a
  262.            link-layer filter table, docsDevFilterLLCTable, which is used
  263.            to manage the processing and forwarding of non-IP traffic; an
  264.            IP packet classifier table, docsDevFilterIpTable, which is
  265.            used to map classes of packets to specific policy actions; a
  266.            policy table, docsDevFilterPolicyTable, which maps zero or
  267.            more policy actions onto a specific packet classification,
  268.            and one or more policy action tables.
  269.  
  270.            At this time, this MIB specifies only one policy action
  271.            table, docsDevFilterTosTable, which allows the manipulation
  272.            of the type of services bits in an IP packet based on
  273.            matching some criteria.  The working group may add additional
  274.            policy types and action tables in the future, for example to
  275.            allow QOS to modem service identifier assignment based on
  276.            destination.
  277.  
  278.  
  279.  
  280.  
  281.  
  282. St. Johns                      Standards                        [Page 5]
  283.  
  284. RFC 2669                DOCSIS Cable Device MIB              August 1999
  285.  
  286.  
  287.       o    The docsDevCpe group provides control over which IP addresses
  288.            may be used by customer premises equipment (e.g. PCs)
  289.            serviced by a given cable modem.  This provides anti-spoofing
  290.            control at the point of origin for a large cable modem
  291.            system.  This group is separate from docsDevFilter primarily
  292.            as this group is only implemented on the Cable Modem (CM) and
  293.            MUST NOT be implemented on the Cable Modem Termination System
  294.            (CMTS).
  295.  
  296. 3.2.  Management requirements
  297.  
  298. 3.2.1.  Handling of Software upgrades
  299.  
  300.    The Cable Modem software upgrade process is documented in [16].  From
  301.    a network management station, the operator:
  302.  
  303.       o    sets docsDevSwServer to the address of the TFTP server for
  304.            software upgrades
  305.  
  306.       o    sets docsDevSwFilename to the file pathname of the software
  307.            upgrade image
  308.  
  309.       o    sets docsDevSwAdminStatus to upgrade-from-mgt
  310.  
  311.    One reason for the SNMP-initiated upgrade is to allow loading of a
  312.    temporary software image (e.g., special diagnostic software) that
  313.    differs from the software normally used on that device without
  314.    changing the provisioning database.
  315.  
  316.    Note that software upgrades should not be accepted blindly by the
  317.    cable device. The cable device may refuse an upgrade if:
  318.  
  319.       o    The download is incomplete.
  320.  
  321.       o    The file contents are incomplete or damaged.
  322.  
  323.       o    The software is not intended for that hardware device (may
  324.            include the case of a feature set that has not been purchased
  325.            for this device).
  326.  
  327. 3.2.2.  Events and Traps
  328.  
  329.    This MIB provides control facilities for reporting events through
  330.    syslog, traps, and non-volatile logging.  If events are reported
  331.    through traps, the specified conventions must be followed.  Other
  332.    means of event reporting are outside the scope of this document.
  333.  
  334.  
  335.  
  336.  
  337.  
  338. St. Johns                      Standards                        [Page 6]
  339.  
  340. RFC 2669                DOCSIS Cable Device MIB              August 1999
  341.  
  342.  
  343.    The definition and coding of events is vendor-specific.  In deference
  344.    to the network operator who must troubleshoot multi-vendor networks,
  345.    the circumstances and meaning of each event should be reported as
  346.    human-readable text.  Vendors SHOULD provide time-of-day clocks in
  347.    CMs to provide useful timestamping of events.
  348.  
  349.    For each vendor-specific event that is reportable via TRAP, the
  350.    vendor must create an enterprise-specific trap definition.  Trap
  351.    definitions MUST include the event reason encoded as DisplayString
  352.    and should be defined as:
  353.  
  354.    trapName NOTIFICATION-TYPE
  355.            OBJECTS {
  356.                ifIndex,
  357.                eventReason,
  358.                other useful objects
  359.            }
  360.            STATUS      current
  361.            DESCRIPTION
  362.                "trap description"
  363.            ::= Object Id
  364.  
  365.    Note that ifIndex is only included if the event or trap is interface
  366.    related.
  367.  
  368.    An example (fake) vendor defined trap might be:
  369.  
  370.    xyzVendorModemDropout NOTIFICATION-TYPE
  371.            OBJECTS {
  372.                eventReason,
  373.                xyzModemHighWatermarkCount
  374.            }
  375.            STATUS  current
  376.            DESCRIPTION
  377.               "Sent by a CMTS when a configurable number of modems
  378.            (xyzModemHysteresis) de-register or become unreachable during
  379.            the sampling period (5 minutes).  Used to warn a management
  380.            station about a catastrophic cable plant outage."
  381.            ::= { xyzTraps 23 }
  382.  
  383.    In this example eventReason is  a DisplayString providing a human
  384.    readable error message, and xyzModemHighWatermarkCount is a Gauge32
  385.    which indicates the maximum number of modems during the epoch.
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393.  
  394. St. Johns                      Standards                        [Page 7]
  395.  
  396. RFC 2669                DOCSIS Cable Device MIB              August 1999
  397.  
  398.  
  399.    The last digit of the trap OID for enterprise-specific traps must
  400.    match docsDevEvId.  For SNMPv1-capable Network Management systems,
  401.    this is necessary to correlate the event type to the trap type.  Many
  402.    Network Management systems are only capable of trap filtering on an
  403.    enterprise and single-last-digit basis.
  404.  
  405. 3.2.3.  Trap Throttling
  406.  
  407.    The CM and CMTS MUST provide support for trap message throttling as
  408.    described below.  The network operator can employ message rate
  409.    throttling or trap limiting by manipulating the appropriate MIB
  410.    variables.
  411.  
  412. 3.2.3.1.  Trap rate throttling
  413.  
  414.    Network operators may employ either of two rate control methods.  In
  415.    the first method, the device ceases to send traps when the rate
  416.    exceeds the specified maximum message rate.  It resumes sending traps
  417.    only if reactivated by a network management station request.
  418.  
  419.    In the second method, the device resumes sending traps when the rate
  420.    falls below the specified maximum message rate.
  421.  
  422.    The network operator configures the specified maximum message rate by
  423.    setting the measurement interval (in seconds), and the maximum number
  424.    of traps to be transmitted within the measurement interval.  The
  425.    operator can query the operational throttling state (to determine
  426.    whether traps are enabled or blocked by throttling) of the device, as
  427.    well as query and set the administrative throttling state (to manage
  428.    the rate control method) of the device.
  429.  
  430. 3.2.3.2.  Limiting the trap rate
  431.  
  432.    Network operators may wish to limit the number of traps sent by a
  433.    device over a specified time period.  The device ceases to send traps
  434.    when the number of traps exceeds the specified threshold.  It resumes
  435.    sending traps only when the measurement interval has passed.
  436.  
  437.    The network operator defines the maximum number of traps he is
  438.    willing to handle and sets the measurement interval to a large number
  439.    (in hundredths of a second).  For this case, the administrative
  440.    throttling state is set to stop at threshold which is the maximum
  441.    number of traps.
  442.  
  443.    See "Techniques for Managing Asynchronously Generated Alerts" [17]
  444.    for further information.
  445.  
  446.  
  447.  
  448.  
  449.  
  450. St. Johns                      Standards                        [Page 8]
  451.  
  452. RFC 2669                DOCSIS Cable Device MIB              August 1999
  453.  
  454.  
  455. 3.3.  Protocol Filters
  456.  
  457.    The Cable Device MIB provides objects for both LLC and IP protocol
  458.    filters.  The LLC protocol filter entries can be used to limit CM
  459.    forwarding to a restricted set of network-layer protocols (such as
  460.    IP, IPX, NetBIOS, and Appletalk).
  461.  
  462.    The IP protocol filter entries can be used to restrict upstream or
  463.    downstream traffic based on source and destination IP addresses,
  464.    transport-layer protocols (such as TCP, UDP, and ICMP), and source
  465.    and destination TCP/UDP port numbers.
  466.  
  467.    In general, a cable modem applies filters (or more properly,
  468.    classifiers) in an order appropriate to the layering model.
  469.    Specifically, the inbound MAC (or LLC) layer filters are applied
  470.    first, then the "special" filters, then the IP layer inbound filters,
  471.    then the IP layer outbound filters, then any final LLC outbound
  472.    filters.  Since the cable modem does not generally do any IP
  473.    processing (other than that specified by the filters) the processing
  474.    of the IP in filters and IP out filters can usually be combined into
  475.    a single step.
  476.  
  477.                  ***************
  478.                  * LLC Filters *
  479.                  ***************
  480.                  |      |      |
  481.                  v      |      v
  482.            ************ |  ***************
  483.            * IP Spoof * |  * SNMP Access *
  484.            ************ |  ***************
  485.                  |      |      |
  486.                  v      v      v
  487.                 ****************
  488.                 * IP Filter In *
  489.                 ****************
  490.                         |
  491.                         v
  492.                 *****************
  493.                 * IP Filter Out *
  494.                 *****************
  495.                         |
  496.                         v
  497.                    ***********
  498.                    * LLC Out *
  499.                    ***********
  500.  
  501.  
  502.  
  503.  
  504.  
  505.  
  506. St. Johns                      Standards                        [Page 9]
  507.  
  508. RFC 2669                DOCSIS Cable Device MIB              August 1999
  509.  
  510.  
  511. 3.3.1.  Inbound LLC Filters - docsDevFilterLLCTable
  512.  
  513.    The inbound LLC (or MAC or level-2) filters are contained in the
  514.    docsDevFilterLLCTable and are applied to level-2 frames entering the
  515.    cable modem from either the RF MAC interface or from one of the CPE
  516.    (ethernet or other) interfaces.  These filters are used to prohibit
  517.    the processing and forwarding of certain types of level-2 traffic
  518.    that may be disruptive to the network.  The filters, as currently
  519.    specified, can be set to cause the modem to either drop frames which
  520.    match at least one filter, or to process a frame which matches at
  521.    least filter.  Some examples of possible configurations would be to
  522.    only permit IP (and ARP) traffic, or to drop NETBUEI traffic.
  523.  
  524. 3.3.2.  Special Filters
  525.  
  526.    Special filters are applied after the packet is accepted from the MAC
  527.    layer by the IP module, but before any other processing is done.
  528.    They are filters that apply only to a very specific class of traffic.
  529.  
  530. 3.3.2.1.  IP Spoofing Filters - docsDevCpeTable
  531.  
  532.    IP spoofing filters are applied to packets entering the modem from
  533.    one of the CPE interfaces and are intended to prevent a subscriber
  534.    from stealing or mis-using IP addresses that were not assigned to the
  535.    subscriber.  If the filters are active (enabled), the source address
  536.    of the IP packet must match at least one IP address in this table or
  537.    it is discarded without further processing.
  538.  
  539.    The table can be automatically populated where the first N different
  540.    IP addresses seen from the CPE side of the cable modem are used to
  541.    automatically populate the table.  The spoofing filters are specified
  542.    in the docsDevCpeTable and the policy for automatically creating
  543.    filters in that table is controlled by docsDevCpeEnroll and
  544.    docsDevCpeMax as well as the network management agent.
  545.  
  546. 3.3.2.2.  SNMP Access Filters - docsDevNmAccessTable
  547.  
  548.    The SNMP access filters are applied to SNMP packets entering from any
  549.    interface and destined for the cable modem.  If the packets enter
  550.    from a CPE interface, the SNMP filters are applied after the IP
  551.    spoofing filters.  The filters only apply to SNMPv1 or SNMPv2c
  552.    traffic, and are not consulted for SNMPv3 traffic (and need not be
  553.    implemented by a v3 only agent).  SNMPv3 access control is specified
  554.    in the User Security Model MIB in [12].
  555.  
  556.  
  557.  
  558.  
  559.  
  560.  
  561.  
  562. St. Johns                      Standards                       [Page 10]
  563.  
  564. RFC 2669                DOCSIS Cable Device MIB              August 1999
  565.  
  566.  
  567. 3.3.3.  IP Filtering - docsDevIpFilterTable
  568.  
  569.    The IP Filtering table acts as a classifier table.  Each row in the
  570.    table describes a template against which IP packets are compared.
  571.    The template includes source and destination addresses (and their
  572.    associated masks), upper level protocol (e.g. TCP, UDP), source and
  573.    destination port ranges, TOS and TOS mask. A row also contains
  574.    interface and traffic direction match values which have to be
  575.    considered in combination.  All columns of a particular row must
  576.    match the appropriate fields in the packet, and must match the
  577.    interface and direction items for the packet to result in a match to
  578.    the packet.
  579.  
  580.    When classifying a packet, the table is scanned beginning with the
  581.    lowest number filter.  If the agent finds a match, it applies the
  582.    group of policies specified.  If the matched filter has the continue
  583.    bit set, the agent continues the scan possibly matching additional
  584.    filters and applying additional policies.  This allows the agent to
  585.    take one set of actions for the 24.0.16/255.255.255.0 group and one
  586.    set of actions for telnet packets to/from 24.0.16.30 and these sets
  587.    of actions may not be mutually exclusive.
  588.  
  589.    Once a packet is matched, one of three actions happen based on the
  590.    setting of docsDevFilterIpControl in the row.  The packet may be
  591.    dropped, in which case no further processing is required.  The packet
  592.    may be accepted and processing of the packet continues.  Lastly, the
  593.    packet may have a set of policy actions applied to it.  If
  594.    docsDevFilterIpContinue is set to true, scanning of the table
  595.    continues and additional matches may result.
  596.  
  597.    When a packet matches, and docsDevFilterIpControl in the filter
  598.    matched is set to 'policy', the value of docsDevFilterIpPolicyId is
  599.    used as a selector into the docsDevFilterPolicyTable.  The first
  600.    level of indirection may result in zero or more actions being taken
  601.    based on the match.  The docsDevFilterPolicyTable is scanned in row
  602.    order and all rows where docsDevFilterPolicyId equals
  603.    docsDevFilterIpPolicyId have the action specified by
  604.    docsDevFilterPolicyValue 'executed'.  For example, a value pointing
  605.    to an entry in the docsDevFilterTosTable may result in the re-writing
  606.    of the TOS bits in the IP packet which was matched.  Another
  607.    possibility may be to assign an output packet to a specific output
  608.    upstream queue.  An even more complex action might be to re-write the
  609.    TOS value, assign the packet to an upstream service ID, and drop it
  610.    into a particular IPSEC tunnel.
  611.  
  612.  
  613.  
  614.  
  615.  
  616.  
  617.  
  618. St. Johns                      Standards                       [Page 11]
  619.  
  620. RFC 2669                DOCSIS Cable Device MIB              August 1999
  621.  
  622.  
  623.    Example:
  624.  
  625.    docsDevFilterIpTable
  626.  
  627.    #  Index,  SrcIP/Mask, DstIP/Mask,ULP, SrcPts,DstPts,Tos/Mask,
  628.    # Int/Dir,  Pgroup, [continue]
  629.    # drop any netbios traffic
  630.    10, 0/0, 0/0, TCP, any, 137-139, 0/0, any/any, drop
  631.  
  632.    # traffic to the proxy gets better service - other matches possible
  633.    20, 0/0, proxy/32, TCP, any,any, 0/0, cpe/in, 10, continue
  634.  
  635.    # Traffic from CPE 1 gets 'Gold' service, other matches possible
  636.    30, cpe1/32, 0/0, any, any,any, 0/0, cpe/in, 20, continue
  637.  
  638.    # Traffic from CPE2 to work goes, other traffic dropped
  639.    40, cpe2/32, workIPs/24, any, 0/0, cpe/in, accept
  640.    45, cpe2/32, 0/0, any, any,ayn, 0/0, cpe/in, drop
  641.  
  642.    # Traffic with TOS=4 gets queued on the "silver" queue.
  643.    50, 0/0, 0/0, any, any,any, 4/255, cpe/in, 30
  644.  
  645.    # Inbound "server" traffic to low numbered ports gets dropped.
  646.    60, 0/0, 0/0, TCP, any,1-1023, 0/0, cpe/out, drop
  647.    65, 0/0, 0/0, UDP, any,1-1023, 0/0, cpe/out, drop
  648.  
  649.    docsDevFilterIpPolicyTable
  650.  
  651.    #
  652.    # index, policy group, policy
  653.    10, 10, queueEntry.20   -- special queue for traffic to proxy
  654.  
  655.    15, 20, queueEntry.15   -- Gold Service queue
  656.    20, 20, docsDevFilterTosStatus.10 -- Mark this packet with TOS 5
  657.  
  658.    25, 30, queueEntry.10   -- Silver service queue
  659.  
  660.    This table describes some special processing for packets originating
  661.    from either the first or second CPE device which results in their
  662.    queuing on to special upstream traffic queues and for the "gold"
  663.    service results in having the packets marked with a TOS of 5.  The
  664.    10, 20, 60 and 65 entries are generic entries that would generally be
  665.    applied to all traffic to this CM.  The 30, 40 and 45 entries are
  666.    specific to a particular CPE's service assignments.  The ordering
  667.    here is a bit contrived, but is close to what may actually be
  668.    required by the operator to control various classes of customers.
  669.  
  670.  
  671.  
  672.  
  673.  
  674. St. Johns                      Standards                       [Page 12]
  675.  
  676. RFC 2669                DOCSIS Cable Device MIB              August 1999
  677.  
  678.  
  679. 3.3.4.  Outbound LLC Filters
  680.  
  681.    Lastly, any outbound LLC filters are applied to the packet just prior
  682.    to it being emitted on the appropriate interface.  This MIB does not
  683.    specify any outbound LLC filters, but it is anticipated that the QOS
  684.    additions to the DOCSIS standard may include some outbound LLC
  685.    filtering requirements.  If so, those filters would be applied as
  686.    described here.
  687.  
  688. 4.  Definitions
  689.  
  690. DOCS-CABLE-DEVICE-MIB DEFINITIONS ::= BEGIN
  691.  
  692. IMPORTS
  693.         MODULE-IDENTITY,
  694.         OBJECT-TYPE,
  695. -- do not import        BITS,
  696.         IpAddress,
  697.         Unsigned32,
  698.         Counter32,
  699.         Integer32,
  700.         zeroDotZero,
  701.         mib-2
  702.                 FROM SNMPv2-SMI
  703.         RowStatus,
  704.         RowPointer,
  705.         DateAndTime,
  706.         TruthValue
  707.                 FROM SNMPv2-TC
  708.         OBJECT-GROUP,
  709.         MODULE-COMPLIANCE
  710.                 FROM SNMPv2-CONF
  711.         SnmpAdminString
  712.                 FROM SNMP-FRAMEWORK-MIB
  713.         InterfaceIndexOrZero
  714.                 FROM IF-MIB;  -- RFC2233
  715.  
  716. docsDev MODULE-IDENTITY
  717.         LAST-UPDATED    "9908190000Z" -- August 19, 1999
  718.         ORGANIZATION    "IETF IPCDN Working Group"
  719.         CONTACT-INFO
  720.             "        Michael StJohns
  721.              Postal: @Home Network
  722.                      425 Broadway
  723.                      Redwood City, CA 94063
  724.                      U.S.A.
  725.              Phone:  +1 650 569 5368
  726.              E-mail: stjohns@corp.home.net"
  727.  
  728.  
  729.  
  730. St. Johns                      Standards                       [Page 13]
  731.  
  732. RFC 2669                DOCSIS Cable Device MIB              August 1999
  733.  
  734.  
  735.         DESCRIPTION
  736.             "This is the MIB Module for MCNS-compliant cable modems and
  737.              cable-modem termination systems."
  738.         REVISION "9908190000Z"
  739.         DESCRIPTION
  740.             "Initial Version, published as RFC 2669.
  741.              Modified by Mike StJohns to add/revise filtering, TOS
  742.              support, software version information objects."
  743.         ::= { mib-2 69 }
  744.  
  745. docsDevMIBObjects  OBJECT IDENTIFIER ::= { docsDev 1 }
  746. docsDevBase OBJECT IDENTIFIER ::= { docsDevMIBObjects 1 }
  747.  
  748. --
  749. -- For the following object, there is no concept in the
  750. -- RFI specification corresponding to a backup CMTS. The
  751. -- enumeration is provided here in case someone is able
  752. -- to define such a role or device.
  753. --
  754.  
  755. docsDevRole OBJECT-TYPE
  756.         SYNTAX INTEGER {
  757.             cm(1),
  758.             cmtsActive(2),
  759.             cmtsBackup(3)
  760.         }
  761.         MAX-ACCESS  read-only
  762.         STATUS      current
  763.         DESCRIPTION
  764.              "Defines the current role of this device.  cm (1) is
  765.              a Cable Modem, cmtsActive(2) is a Cable Modem Termination
  766.              System which is controlling the system of cable modems,
  767.              and cmtsBackup(3) is a CMTS which is currently connected,
  768.              but not controlling the system (not currently used).
  769.  
  770.              In general, if this device is a 'cm', its role will not
  771.              change during operation or between reboots.  If the
  772.              device is a 'cmts' it may change between cmtsActive and
  773.              cmtsBackup and back again during normal operation.  NB:
  774.              At this time, the DOCSIS standards do not support the
  775.              concept of a backup CMTS, cmtsBackup is included for
  776.              completeness."
  777.         ::= { docsDevBase 1 }
  778.  
  779. docsDevDateTime OBJECT-TYPE
  780.         SYNTAX      DateAndTime
  781.         MAX-ACCESS  read-write
  782.         STATUS      current
  783.  
  784.  
  785.  
  786. St. Johns                      Standards                       [Page 14]
  787.  
  788. RFC 2669                DOCSIS Cable Device MIB              August 1999
  789.  
  790.  
  791.         DESCRIPTION
  792.             "The date and time, with optional timezone
  793.              information."
  794.         ::= { docsDevBase 2 }
  795.  
  796. docsDevResetNow OBJECT-TYPE
  797.         SYNTAX      TruthValue
  798.         MAX-ACCESS  read-write
  799.         STATUS      current
  800.         DESCRIPTION
  801.             "Setting this object to true(1) causes the device to reset.
  802.              Reading this object always returns false(2)."
  803.         ::= { docsDevBase 3 }
  804.  
  805. docsDevSerialNumber OBJECT-TYPE
  806.         SYNTAX      SnmpAdminString
  807.         MAX-ACCESS  read-only
  808.         STATUS      current
  809.         DESCRIPTION
  810.             "The manufacturer's serial number for this device."
  811.         ::= { docsDevBase 4 }
  812.  
  813. docsDevSTPControl OBJECT-TYPE
  814.         SYNTAX INTEGER {
  815.             stEnabled(1),
  816.             noStFilterBpdu(2),
  817.             noStPassBpdu(3)
  818.         }
  819.         MAX-ACCESS  read-write
  820.         STATUS      current
  821.         DESCRIPTION
  822.             "This object controls operation of the spanning tree
  823.              protocol (as distinguished from transparent bridging).
  824.              If set to stEnabled(1) then the spanning tree protocol
  825.              is enabled, subject to bridging constraints. If
  826.              noStFilterBpdu(2), then spanning tree is not active,
  827.              and Bridge PDUs received are discarded.
  828.              If noStPassBpdu(3) then spanning tree is not active
  829.              and Bridge PDUs are transparently forwarded. Note that
  830.              a device need not implement all of these options,
  831.              but that noStFilterBpdu(2) is required."
  832.         ::= { docsDevBase 5 }
  833.  
  834. --
  835. -- The following table provides one level of security for access
  836. -- to the device by network management stations.
  837. -- Note that access is also constrained by the
  838. -- community strings and any vendor-specific security.
  839.  
  840.  
  841.  
  842. St. Johns                      Standards                       [Page 15]
  843.  
  844. RFC 2669                DOCSIS Cable Device MIB              August 1999
  845.  
  846.  
  847. --
  848.  
  849. docsDevNmAccessTable OBJECT-TYPE
  850.         SYNTAX      SEQUENCE OF DocsDevNmAccessEntry
  851.         MAX-ACCESS  not-accessible
  852.         STATUS      current
  853.         DESCRIPTION
  854.             "This table controls access to SNMP objects by network
  855.              management stations. If the table is empty, access
  856.              to SNMP objects is unrestricted.  This table exists only
  857.              on SNMPv1 or v2c agents and does not exist on SNMPv3
  858.              agents. See the conformance section for details.
  859.              Specifically, for v3 agents, the appropriate MIBs and
  860.              security models apply in lieu of this table."
  861.         ::= { docsDevMIBObjects 2 }
  862.  
  863. docsDevNmAccessEntry OBJECT-TYPE
  864.         SYNTAX      DocsDevNmAccessEntry
  865.         MAX-ACCESS  not-accessible
  866.         STATUS      current
  867.         DESCRIPTION
  868.             "An entry describing  access to SNMP objects by a
  869.              particular network management station. An entry in
  870.              this table is not readable unless the management station
  871.              has read-write permission (either implicit if the table
  872.              is empty, or explicit through an entry in this table.
  873.              Entries are ordered by docsDevNmAccessIndex.  The first
  874.              matching entry (e.g. matching IP address and community
  875.              string) is used to derive access."
  876.         INDEX { docsDevNmAccessIndex  }
  877.         ::= {  docsDevNmAccessTable 1 }
  878.  
  879. DocsDevNmAccessEntry ::= SEQUENCE {
  880.             docsDevNmAccessIndex         Integer32,
  881.             docsDevNmAccessIp            IpAddress,
  882.             docsDevNmAccessIpMask        IpAddress,
  883.             docsDevNmAccessCommunity     OCTET STRING,
  884.             docsDevNmAccessControl       INTEGER,
  885.             docsDevNmAccessInterfaces    OCTET STRING,
  886.             docsDevNmAccessStatus        RowStatus
  887.         }
  888.  
  889. docsDevNmAccessIndex OBJECT-TYPE
  890.         SYNTAX      Integer32 (1..2147483647)
  891.         MAX-ACCESS  not-accessible
  892.         STATUS      current
  893.         DESCRIPTION
  894.             "Index used to order the application of access
  895.  
  896.  
  897.  
  898. St. Johns                      Standards                       [Page 16]
  899.  
  900. RFC 2669                DOCSIS Cable Device MIB              August 1999
  901.  
  902.  
  903.              entries."
  904.         ::= { docsDevNmAccessEntry 1 }
  905.  
  906. docsDevNmAccessIp OBJECT-TYPE
  907.         SYNTAX      IpAddress
  908.         MAX-ACCESS  read-create
  909.         STATUS      current
  910.         DESCRIPTION
  911.             "The IP address (or subnet) of the network management
  912.              station. The address 255.255.255.255 is defined to mean
  913.              any NMS. If traps are enabled for this entry, then the
  914.              value must be the address of a specific device."
  915.         DEFVAL { 'ffffffff'h }
  916.         ::= { docsDevNmAccessEntry 2 }
  917.  
  918. docsDevNmAccessIpMask OBJECT-TYPE
  919.         SYNTAX      IpAddress
  920.         MAX-ACCESS  read-create
  921.         STATUS      current
  922.         DESCRIPTION
  923.             "The IP subnet mask of the network management stations.
  924.              If traps are enabled for this entry, then the value must
  925.              be 255.255.255.255."
  926.         DEFVAL { 'ffffffff'h }
  927.         ::= { docsDevNmAccessEntry 3 }
  928.  
  929. docsDevNmAccessCommunity OBJECT-TYPE
  930.         SYNTAX      OCTET STRING
  931.         MAX-ACCESS  read-create
  932.         STATUS      current
  933.         DESCRIPTION
  934.             "The community string to be matched for access by this
  935.              entry. If set to a zero length string then any community
  936.              string will match.  When read, this object SHOULD return
  937.              a zero length string."
  938.         DEFVAL { "public" }
  939.         ::= { docsDevNmAccessEntry 4 }
  940.  
  941. docsDevNmAccessControl OBJECT-TYPE
  942.         SYNTAX         INTEGER {
  943.             none(1),
  944.             read(2),
  945.             readWrite(3),
  946.             roWithTraps(4),
  947.             rwWithTraps(5),
  948.             trapsOnly(6)
  949.         }
  950.         MAX-ACCESS  read-create
  951.  
  952.  
  953.  
  954. St. Johns                      Standards                       [Page 17]
  955.  
  956. RFC 2669                DOCSIS Cable Device MIB              August 1999
  957.  
  958.  
  959.         STATUS      current
  960.         DESCRIPTION
  961.             "Specifies the type of access allowed to this NMS. Setting
  962.              this object to none(1) causes the table entry to be
  963.              destroyed. Read(2) allows access by 'get' and 'get-next'
  964.              PDUs. ReadWrite(3) allows access by 'set' as well.
  965.              RoWithtraps(4), rwWithTraps(5), and trapsOnly(6)
  966.              control distribution of Trap PDUs transmitted by this
  967.              device."
  968.         DEFVAL { read }
  969.         ::= { docsDevNmAccessEntry 5 }
  970.  
  971. -- The syntax of the following object was copied from RFC1493,
  972. -- dot1dStaticAllowedToGoTo.
  973.  
  974. docsDevNmAccessInterfaces OBJECT-TYPE
  975.         SYNTAX      OCTET STRING
  976.         MAX-ACCESS  read-create
  977.         STATUS      current
  978.         DESCRIPTION
  979.             "Specifies the set of interfaces from which requests from
  980.              this NMS will be accepted.
  981.              Each octet within the value of this object specifies a set
  982.              of eight interfaces, with the first octet specifying ports
  983.              1 through 8, the second octet specifying interfaces 9
  984.              through 16, etc.  Within each octet, the most significant
  985.              bit represents the lowest numbered interface, and the least
  986.              significant bit represents the highest numbered interface.
  987.              Thus, each interface is represented by a single bit within
  988.              the value of this object. If that bit has a value of '1'
  989.              then that interface is included in the set.
  990.  
  991.              Note that entries in this table apply only to link-layer
  992.              interfaces (e.g., Ethernet and CATV MAC). Upstream and
  993.              downstream channel interfaces must not be specified."
  994. --         DEFVAL is the bitmask corresponding to all interfaces
  995.         ::= { docsDevNmAccessEntry 6 }
  996.  
  997. docsDevNmAccessStatus OBJECT-TYPE
  998.         SYNTAX      RowStatus
  999.         MAX-ACCESS  read-create
  1000.         STATUS      current
  1001.         DESCRIPTION
  1002.             "Controls and reflects the status of rows in this
  1003.              table. Rows in this table may be created by either the
  1004.              create-and-go or create-and-wait paradigms.  There is no
  1005.              restriction on changing values in a row of this table while
  1006.              the row is active."
  1007.  
  1008.  
  1009.  
  1010. St. Johns                      Standards                       [Page 18]
  1011.  
  1012. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1013.  
  1014.  
  1015.         ::= { docsDevNmAccessEntry 7 }
  1016.  
  1017. --
  1018. --  Procedures for using the following group are described in section
  1019. --  3.2.1 of the DOCSIS Radio Frequence Interface Specification
  1020. --
  1021.  
  1022. docsDevSoftware OBJECT IDENTIFIER ::= { docsDevMIBObjects 3 }
  1023.  
  1024. docsDevSwServer OBJECT-TYPE
  1025.         SYNTAX      IpAddress
  1026.         MAX-ACCESS  read-write
  1027.         STATUS      current
  1028.         DESCRIPTION
  1029.             "The address of the TFTP server used for software upgrades.
  1030.              If the TFTP server is unknown, return 0.0.0.0."
  1031.         ::= { docsDevSoftware 1 }
  1032.  
  1033. docsDevSwFilename OBJECT-TYPE
  1034.         SYNTAX      SnmpAdminString (SIZE (0..64))
  1035.         MAX-ACCESS  read-write
  1036.         STATUS      current
  1037.         DESCRIPTION
  1038.             "The file name of the software image to be loaded into this
  1039.              device. Unless set via SNMP, this is the file name
  1040.              specified by the provisioning server that corresponds to
  1041.              the software version that is desired for this device.
  1042.              If unknown, the string '(unknown)' is returned."
  1043.         ::= { docsDevSoftware 2 }
  1044.  
  1045. docsDevSwAdminStatus OBJECT-TYPE
  1046.         SYNTAX INTEGER {
  1047.             upgradeFromMgt(1),
  1048.             allowProvisioningUpgrade(2),
  1049.             ignoreProvisioningUpgrade(3)
  1050.         }
  1051.         MAX-ACCESS  read-write
  1052.         STATUS      current
  1053.         DESCRIPTION
  1054.             "If set to upgradeFromMgt(1), the device will initiate a
  1055.              TFTP software image download using docsDevSwFilename.
  1056.              After successfully receiving an image, the device will
  1057.              set its state to ignoreProvisioningUpgrade(3) and reboot.
  1058.              If the download process is interrupted by a reset or
  1059.              power failure, the device will load the previous image
  1060.              and, after re-initialization, continue to attempt loading
  1061.              the image specified in docsDevSwFilename.
  1062.  
  1063.  
  1064.  
  1065.  
  1066. St. Johns                      Standards                       [Page 19]
  1067.  
  1068. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1069.  
  1070.  
  1071.              If set to allowProvisioningUpgrade(2), the device will
  1072.              use the software version information supplied by the
  1073.              provisioning server when next rebooting (this does not
  1074.              cause a reboot).
  1075.  
  1076.              When set to ignoreProvisioningUpgrade(3), the device
  1077.              will disregard software image upgrade information from the
  1078.              provisioning server.
  1079.  
  1080.              Note that reading this object can return upgradeFromMgt(1).
  1081.              This indicates that a software download is currently in
  1082.              progress, and that the device will reboot after
  1083.              successfully receiving an image.
  1084.  
  1085.              At initial startup, this object has the default value of
  1086.              allowProvisioningUpgrade(2)."
  1087.         ::= { docsDevSoftware 3 }
  1088.  
  1089. docsDevSwOperStatus OBJECT-TYPE
  1090.         SYNTAX INTEGER {
  1091.             inProgress(1),
  1092.             completeFromProvisioning(2),
  1093.             completeFromMgt(3),
  1094.             failed(4),
  1095.             other(5)
  1096.         }
  1097.         MAX-ACCESS  read-only
  1098.         STATUS      current
  1099.         DESCRIPTION
  1100.             "InProgress(1) indicates that a TFTP download is underway,
  1101.              either as a result of a version mismatch at provisioning
  1102.              or as a result of a upgradeFromMgt request.
  1103.              CompleteFromProvisioning(2) indicates that the last
  1104.              software upgrade was a result of version mismatch at
  1105.              provisioning. CompleteFromMgt(3) indicates that the last
  1106.              software upgrade was a result of setting
  1107.              docsDevSwAdminStatus to upgradeFromMgt.
  1108.              Failed(4) indicates that the last attempted download
  1109.              failed, ordinarily due to TFTP timeout."
  1110.         REFERENCE
  1111.              "DOCSIS Radio Frequency Interface Specification, Section
  1112.              8.2, Downloading Cable Modem Operating Software."
  1113.         ::= { docsDevSoftware 4 }
  1114.  
  1115. docsDevSwCurrentVers OBJECT-TYPE
  1116.     SYNTAX      SnmpAdminString
  1117.     MAX-ACCESS  read-only
  1118.     STATUS      current
  1119.  
  1120.  
  1121.  
  1122. St. Johns                      Standards                       [Page 20]
  1123.  
  1124. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1125.  
  1126.  
  1127.     DESCRIPTION
  1128.             "The software version currently operating in this device.
  1129.              This object should be in the syntax used by the individual
  1130.              vendor to identify software versions.  Any CM MUST return a
  1131.              string descriptive of the current software load.  For a
  1132.              CMTS, this object SHOULD contain either a human readable
  1133.              representation of the vendor specific designation of the
  1134.              software for the chassis, or of the software for the
  1135.              control processor. If neither of these is  applicable,
  1136.              this MUST contain an empty string."
  1137.     ::= { docsDevSoftware 5 }
  1138.  
  1139.  
  1140. --
  1141. -- The following group describes server access and parameters used for
  1142. -- initial provisioning and bootstrapping.
  1143. --
  1144.  
  1145. docsDevServer OBJECT IDENTIFIER ::= { docsDevMIBObjects 4 }
  1146.  
  1147. docsDevServerBootState OBJECT-TYPE
  1148.         SYNTAX INTEGER {
  1149.             operational(1),
  1150.             disabled(2),
  1151.             waitingForDhcpOffer(3),
  1152.             waitingForDhcpResponse(4),
  1153.             waitingForTimeServer(5),
  1154.             waitingForTftp(6),
  1155.             refusedByCmts(7),
  1156.             forwardingDenied(8),
  1157.             other(9),
  1158.             unknown(10)
  1159.         }
  1160.         MAX-ACCESS  read-only
  1161.         STATUS      current
  1162.         DESCRIPTION
  1163.             "If operational(1), the device has completed loading and
  1164.              processing of configuration parameters and the CMTS has
  1165.              completed the Registration exchange.
  1166.              If disabled(2) then the device was administratively
  1167.              disabled, possibly by being refused network access in the
  1168.              configuration file.
  1169.              If waitingForDhcpOffer(3) then a DHCP Discover has been
  1170.              transmitted and no offer has yet been received.
  1171.              If waitingForDhcpResponse(4) then a DHCP Request has been
  1172.              transmitted and no response has yet been received.
  1173.              If waitingForTimeServer(5) then a Time Request has been
  1174.              transmitted and no response has yet been received.
  1175.  
  1176.  
  1177.  
  1178. St. Johns                      Standards                       [Page 21]
  1179.  
  1180. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1181.  
  1182.  
  1183.              If waitingForTftp(6) then a request to the TFTP parameter
  1184.              server has been made and no response received.
  1185.              If refusedByCmts(7) then the Registration Request/Response
  1186.              exchange with the CMTS failed.
  1187.              If forwardingDenied(8) then the registration process
  1188.              completed, but the network access option in the received
  1189.              configuration file prohibits forwarding. "
  1190.         REFERENCE
  1191.              "DOCSIS Radio Frequency Interface Specification, Figure
  1192.              7-1, CM Initialization Overview."
  1193.         ::= { docsDevServer 1 }
  1194.  
  1195. docsDevServerDhcp OBJECT-TYPE
  1196.         SYNTAX      IpAddress
  1197.         MAX-ACCESS  read-only
  1198.         STATUS      current
  1199.         DESCRIPTION
  1200.             "The IP address of the DHCP server that assigned an IP
  1201.              address to this device. Returns 0.0.0.0 if DHCP was not
  1202.              used for IP address assignment."
  1203.         ::= { docsDevServer 2 }
  1204.  
  1205. docsDevServerTime OBJECT-TYPE
  1206.         SYNTAX      IpAddress
  1207.         MAX-ACCESS  read-only
  1208.         STATUS      current
  1209.         DESCRIPTION
  1210.             "The IP address of the Time server (RFC-868). Returns
  1211.              0.0.0.0 if the time server IP address is unknown."
  1212.         ::= { docsDevServer 3 }
  1213.  
  1214. docsDevServerTftp OBJECT-TYPE
  1215.         SYNTAX      IpAddress
  1216.         MAX-ACCESS  read-only
  1217.         STATUS      current
  1218.         DESCRIPTION
  1219.             "The IP address of the TFTP server responsible for
  1220.              downloading provisioning and configuration parameters
  1221.              to this device. Returns 0.0.0.0 if the TFTP server
  1222.              address is unknown."
  1223.         ::= { docsDevServer 4 }
  1224.  
  1225. docsDevServerConfigFile OBJECT-TYPE
  1226.         SYNTAX      SnmpAdminString
  1227.         MAX-ACCESS  read-only
  1228.         STATUS      current
  1229.         DESCRIPTION
  1230.             "The name of the device configuration file read from the
  1231.  
  1232.  
  1233.  
  1234. St. Johns                      Standards                       [Page 22]
  1235.  
  1236. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1237.  
  1238.  
  1239.              TFTP server. Returns an empty string if the configuration
  1240.              file name is unknown."
  1241.         ::= { docsDevServer 5 }
  1242.  
  1243. --
  1244. --  Event Reporting
  1245. --
  1246.  
  1247. docsDevEvent OBJECT IDENTIFIER ::= { docsDevMIBObjects 5 }
  1248.  
  1249. docsDevEvControl OBJECT-TYPE
  1250.         SYNTAX INTEGER {
  1251.             resetLog(1),
  1252.             useDefaultReporting(2)
  1253.         }
  1254.         MAX-ACCESS  read-write
  1255.         STATUS      current
  1256.         DESCRIPTION
  1257.             "Setting this object to resetLog(1) empties the event log.
  1258.              All data is deleted. Setting it to useDefaultReporting(2)
  1259.              returns all event priorities to their factory-default
  1260.              reporting. Reading this object always returns
  1261.              useDefaultReporting(2)."
  1262.         ::= { docsDevEvent 1 }
  1263.  
  1264. docsDevEvSyslog OBJECT-TYPE
  1265.         SYNTAX      IpAddress
  1266.         MAX-ACCESS  read-write
  1267.         STATUS      current
  1268.         DESCRIPTION
  1269.             "The IP address of the Syslog server. If 0.0.0.0, syslog
  1270.              transmission is inhibited."
  1271.         ::= { docsDevEvent 2 }
  1272.  
  1273. docsDevEvThrottleAdminStatus OBJECT-TYPE
  1274.         SYNTAX INTEGER {
  1275.             unconstrained(1),
  1276.             maintainBelowThreshold(2),
  1277.             stopAtThreshold(3),
  1278.             inhibited(4)
  1279.         }
  1280.         MAX-ACCESS  read-write
  1281.         STATUS      current
  1282.         DESCRIPTION
  1283.             "Controls the transmission of traps and syslog messages
  1284.              with respect to the trap pacing threshold.
  1285.              unconstrained(1) causes traps and syslog messages to be
  1286.              transmitted without regard to the threshold settings.
  1287.  
  1288.  
  1289.  
  1290. St. Johns                      Standards                       [Page 23]
  1291.  
  1292. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1293.  
  1294.  
  1295.              maintainBelowThreshold(2) causes trap transmission and
  1296.              syslog messages to be suppressed if the number of traps
  1297.              would otherwise exceed the threshold.
  1298.              stopAtThreshold(3) causes trap transmission to cease
  1299.              at the threshold, and not resume until directed to do so.
  1300.              inhibited(4) causes all trap transmission and syslog
  1301.              messages to be suppressed.
  1302.  
  1303.              A single event is always treated as a single event for
  1304.              threshold counting. That is, an event causing both a trap
  1305.              and a syslog message is still treated as a single event.
  1306.  
  1307.              Writing to this object resets the thresholding state.
  1308.  
  1309.              At initial startup, this object has a default value of
  1310.              unconstrained(1)."
  1311.         ::= { docsDevEvent 3 }
  1312.  
  1313. docsDevEvThrottleInhibited OBJECT-TYPE
  1314.         SYNTAX      TruthValue
  1315.         MAX-ACCESS  read-only
  1316.         STATUS      current
  1317.         DESCRIPTION
  1318.             "If true(1), trap and syslog transmission is currently
  1319.              inhibited due to thresholds and/or the current setting of
  1320.              docsDevEvThrottleAdminStatus. In addition, this is set to
  1321.              true(1) if transmission is inhibited due to no
  1322.              syslog (docsDevEvSyslog) or trap (docsDevNmAccessEntry)
  1323.              destinations having been set."
  1324.         ::= { docsDevEvent 4 }
  1325.  
  1326. docsDevEvThrottleThreshold OBJECT-TYPE
  1327.         SYNTAX      Unsigned32
  1328.         MAX-ACCESS  read-write
  1329.         STATUS      current
  1330.         DESCRIPTION
  1331.             "Number of trap/syslog events per docsDevEvThrottleInterval
  1332.              to be transmitted before throttling.
  1333.  
  1334.              A single event is always treated as a single event for
  1335.              threshold counting. That is, an event causing both a trap
  1336.              and a syslog message is still treated as a single event.
  1337.  
  1338.              At initial startup, this object returns 0."
  1339.         ::= { docsDevEvent 5 }
  1340.  
  1341. docsDevEvThrottleInterval OBJECT-TYPE
  1342.         SYNTAX      Integer32 (1..2147483647)
  1343.  
  1344.  
  1345.  
  1346. St. Johns                      Standards                       [Page 24]
  1347.  
  1348. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1349.  
  1350.  
  1351.         UNITS       "seconds"
  1352.         MAX-ACCESS  read-write
  1353.         STATUS      current
  1354.         DESCRIPTION
  1355.             "The interval over which the trap threshold applies.
  1356.              At initial startup, this object has a value of 1."
  1357.  
  1358.         ::= { docsDevEvent 6 }
  1359.  
  1360. --
  1361. -- The following table controls the reporting of the various classes of
  1362. -- events.
  1363. --
  1364.  
  1365. docsDevEvControlTable OBJECT-TYPE
  1366.         SYNTAX      SEQUENCE OF DocsDevEvControlEntry
  1367.         MAX-ACCESS  not-accessible
  1368.         STATUS      current
  1369.         DESCRIPTION
  1370.             "This table allows control of the reporting of event classes.
  1371.         For each event priority, a combination of logging and
  1372.         reporting mechanisms may be chosen. The mapping of event types
  1373.         to priorities is vendor-dependent. Vendors may also choose to
  1374.         allow the user to control that mapping through proprietary
  1375.         means."
  1376.         ::= {  docsDevEvent 7 }
  1377.  
  1378.  
  1379. docsDevEvControlEntry OBJECT-TYPE
  1380.         SYNTAX      DocsDevEvControlEntry
  1381.         MAX-ACCESS  not-accessible
  1382.         STATUS      current
  1383.         DESCRIPTION
  1384.             "Allows configuration of the reporting mechanisms for a
  1385.              particular event priority."
  1386.         INDEX { docsDevEvPriority }
  1387.         ::= { docsDevEvControlTable 1 }
  1388.  
  1389. DocsDevEvControlEntry ::= SEQUENCE {
  1390.             docsDevEvPriority        INTEGER,
  1391.             docsDevEvReporting       BITS
  1392.         }
  1393.  
  1394. docsDevEvPriority OBJECT-TYPE
  1395.         SYNTAX INTEGER {
  1396.             emergency(1),
  1397.             alert(2),
  1398.             critical(3),
  1399.  
  1400.  
  1401.  
  1402. St. Johns                      Standards                       [Page 25]
  1403.  
  1404. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1405.  
  1406.  
  1407.             error(4),
  1408.             warning(5),
  1409.             notice(6),
  1410.             information(7),
  1411.             debug(8)
  1412.         }
  1413.         MAX-ACCESS  not-accessible
  1414.         STATUS      current
  1415.         DESCRIPTION
  1416.             "The priority level that is controlled by this
  1417.              entry. These are ordered from most (emergency) to least
  1418.              (debug) critical.  Each event with a CM or CMTS has a
  1419.              particular priority level associated with it (as defined
  1420.              by the vendor). During normal operation no event more
  1421.              critical than notice(6) should be generated. Events between
  1422.              warning and emergency should be generated at appropriate
  1423.              levels of problems (e.g. emergency when the box is about to
  1424.              crash)."
  1425.         ::= { docsDevEvControlEntry 1 }
  1426.  
  1427. docsDevEvReporting OBJECT-TYPE
  1428.         SYNTAX BITS {
  1429.             local(0),
  1430.             traps(1),
  1431.             syslog(2)
  1432.         }
  1433.         MAX-ACCESS  read-write
  1434.         STATUS      current
  1435.         DESCRIPTION
  1436.             "Defines the action to be taken on occurrence of this
  1437.              event class. Implementations may not necessarily support
  1438.              all options for all event classes, but at minimum must
  1439.              allow traps and syslogging to be disabled. If the
  1440.              local(0) bit is set, then log to the internal log, if the
  1441.              traps(1) bit is set, then generate a trap, if the
  1442.              syslog(2) bit is set, then send a syslog message
  1443.              (assuming the syslog address is set)."
  1444.         ::= { docsDevEvControlEntry 2 }
  1445.  
  1446. docsDevEventTable OBJECT-TYPE
  1447.         SYNTAX      SEQUENCE OF DocsDevEventEntry
  1448.         MAX-ACCESS  not-accessible
  1449.         STATUS      current
  1450.         DESCRIPTION
  1451.             "Contains a log of network and device events that may be
  1452.              of interest in fault isolation and troubleshooting."
  1453.         ::= {  docsDevEvent 8 }
  1454.  
  1455.  
  1456.  
  1457.  
  1458. St. Johns                      Standards                       [Page 26]
  1459.  
  1460. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1461.  
  1462.  
  1463. docsDevEventEntry OBJECT-TYPE
  1464.         SYNTAX      DocsDevEventEntry
  1465.         MAX-ACCESS  not-accessible
  1466.         STATUS      current
  1467.         DESCRIPTION
  1468.             "Describes a network or device event that may be of
  1469.              interest in fault isolation and troubleshooting. Multiple
  1470.              sequential identical events are represented by
  1471.              incrementing docsDevEvCounts and setting
  1472.              docsDevEvLastTime to the current time rather than creating
  1473.              multiple rows.
  1474.  
  1475.              Entries are created with the first occurrance of an event.
  1476.              docsDevEvControl can be used to clear the table.
  1477.              Individual events can not be deleted."
  1478.         INDEX { docsDevEvIndex }
  1479.  
  1480.         ::= { docsDevEventTable 1 }
  1481.  
  1482. DocsDevEventEntry ::= SEQUENCE {
  1483.             docsDevEvIndex           Integer32,
  1484.             docsDevEvFirstTime       DateAndTime,
  1485.             docsDevEvLastTime        DateAndTime,
  1486.             docsDevEvCounts          Counter32,
  1487.             docsDevEvLevel           INTEGER,
  1488.             docsDevEvId              Unsigned32,
  1489.             docsDevEvText            SnmpAdminString
  1490.         }
  1491.  
  1492. docsDevEvIndex OBJECT-TYPE
  1493.         SYNTAX      Integer32 (1..2147483647)
  1494.         MAX-ACCESS  not-accessible
  1495.         STATUS      current
  1496.         DESCRIPTION
  1497.             "Provides relative ordering of the objects in the event
  1498.              log. This object will always increase except when
  1499.              (a) the log is reset via docsDevEvControl,
  1500.              (b) the device reboots and does not implement non-volatile
  1501.              storage for this log, or (c) it reaches the value 2^31.
  1502.              The next entry for all the above cases is 1."
  1503.         ::= { docsDevEventEntry 1 }
  1504.  
  1505. docsDevEvFirstTime OBJECT-TYPE
  1506.         SYNTAX      DateAndTime
  1507.         MAX-ACCESS  read-only
  1508.         STATUS      current
  1509.         DESCRIPTION
  1510.             "The time that this entry was created."
  1511.  
  1512.  
  1513.  
  1514. St. Johns                      Standards                       [Page 27]
  1515.  
  1516. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1517.  
  1518.  
  1519.         ::= { docsDevEventEntry 2 }
  1520.  
  1521. docsDevEvLastTime OBJECT-TYPE
  1522.         SYNTAX      DateAndTime
  1523.         MAX-ACCESS  read-only
  1524.         STATUS      current
  1525.         DESCRIPTION
  1526.             "If multiple events are reported via the same entry, the
  1527.              time that the last event for this entry occurred,
  1528.              otherwise this should have the same value as
  1529.              docsDevEvFirstTime. "
  1530.         ::= { docsDevEventEntry 3 }
  1531.  
  1532. -- This object was renamed from docsDevEvCount to meet naming
  1533. -- requirements for Counter32
  1534. docsDevEvCounts OBJECT-TYPE
  1535.         SYNTAX      Counter32
  1536.         MAX-ACCESS  read-only
  1537.         STATUS      current
  1538.         DESCRIPTION
  1539.             "The number of consecutive event instances reported by
  1540.              this entry.  This starts at 1 with the creation of this
  1541.              row and increments by 1 for each subsequent duplicate
  1542.              event."
  1543.         ::= { docsDevEventEntry 4 }
  1544.  
  1545. docsDevEvLevel OBJECT-TYPE
  1546.         SYNTAX INTEGER {
  1547.             emergency(1),
  1548.             alert(2),
  1549.             critical(3),
  1550.             error(4),
  1551.             warning(5),
  1552.             notice(6),
  1553.             information(7),
  1554.             debug(8)
  1555.         }
  1556.         MAX-ACCESS  read-only
  1557.         STATUS      current
  1558.         DESCRIPTION
  1559.             "The priority level of this event as defined by the
  1560.              vendor.  These are ordered from most serious (emergency)
  1561.              to least serious (debug)."
  1562.         ::= { docsDevEventEntry 5 }
  1563.  
  1564. --
  1565. -- Vendors will provide their own enumerations for the following.
  1566. -- The interpretation of the enumeration is unambiguous for a
  1567.  
  1568.  
  1569.  
  1570. St. Johns                      Standards                       [Page 28]
  1571.  
  1572. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1573.  
  1574.  
  1575. -- particular value of the vendor's enterprise number in sysObjectID.
  1576. --
  1577.  
  1578. docsDevEvId OBJECT-TYPE
  1579.         SYNTAX      Unsigned32
  1580.         MAX-ACCESS  read-only
  1581.         STATUS      current
  1582.         DESCRIPTION
  1583.             "For this product, uniquely identifies the type of event
  1584.              that is reported by this entry."
  1585.         ::= { docsDevEventEntry 6 }
  1586.  
  1587. docsDevEvText OBJECT-TYPE
  1588.         SYNTAX      SnmpAdminString
  1589.         MAX-ACCESS  read-only
  1590.         STATUS      current
  1591.         DESCRIPTION
  1592.             "Provides a human-readable description of the event,
  1593.              including all relevant context (interface numbers,
  1594.              etc.)."
  1595.         ::= { docsDevEventEntry 7 }
  1596.  
  1597. docsDevFilter OBJECT IDENTIFIER ::= { docsDevMIBObjects 6 }
  1598.  
  1599.  
  1600. --
  1601. -- Link Level Control Filtering
  1602. --
  1603.  
  1604. -- docsDevFilterLLCDefault renamed to docsDevFilterLLCUnmatchedAction
  1605.  
  1606. docsDevFilterLLCUnmatchedAction OBJECT-TYPE
  1607.         SYNTAX INTEGER {
  1608.             discard(1),
  1609.             accept(2)
  1610.         }
  1611.         MAX-ACCESS  read-write
  1612.         STATUS      current
  1613.         DESCRIPTION
  1614.             "LLC (Link Level Control) filters can be defined on an
  1615.              inclusive or exclusive basis: CMs can be configured to
  1616.              forward only packets matching a set of layer three
  1617.              protocols, or to drop packets matching a set of layer
  1618.              three protocols.  Typical use of these filters is to
  1619.              filter out possibly harmful (given the context of a large
  1620.              metropolitan LAN) protocols.
  1621.  
  1622.              If set to discard(1), any L2 packet which does not match at
  1623.  
  1624.  
  1625.  
  1626. St. Johns                      Standards                       [Page 29]
  1627.  
  1628. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1629.  
  1630.  
  1631.              least one filter in the docsDevFilterLLCTable will be
  1632.              discarded. If set to accept(2), any L2 packet which does not
  1633.              match at least one filter in the docsDevFilterLLCTable
  1634.              will be accepted for further processing (e.g., bridging).
  1635.              At initial system startup, this object returns accept(2)."
  1636.         ::= { docsDevFilter 1 }
  1637.  
  1638. docsDevFilterLLCTable OBJECT-TYPE
  1639.         SYNTAX      SEQUENCE OF DocsDevFilterLLCEntry
  1640.         MAX-ACCESS  not-accessible
  1641.         STATUS      current
  1642.         DESCRIPTION
  1643.             "A list of filters to apply to (bridged) LLC
  1644.              traffic. The filters in this table are applied to
  1645.              incoming traffic on the appropriate interface(s)  prior
  1646.              to any further processing (e.g. before handing the packet
  1647.              off for level 3 processing, or for bridging).  The
  1648.              specific action taken when no filter is matched is
  1649.              controlled by docsDevFilterLLCUnmatchedAction."
  1650.         ::= { docsDevFilter 2 }
  1651.  
  1652. docsDevFilterLLCEntry OBJECT-TYPE
  1653.         SYNTAX      DocsDevFilterLLCEntry
  1654.         MAX-ACCESS  not-accessible
  1655.         STATUS      current
  1656.         DESCRIPTION
  1657.             "Describes a single filter to apply to (bridged) LLC traffic
  1658.              received on a specified interface. "
  1659.         INDEX { docsDevFilterLLCIndex }
  1660.         ::= { docsDevFilterLLCTable 1 }
  1661.  
  1662. DocsDevFilterLLCEntry ::= SEQUENCE {
  1663.             docsDevFilterLLCIndex               Integer32,
  1664.             docsDevFilterLLCStatus              RowStatus,
  1665.             docsDevFilterLLCIfIndex             InterfaceIndexOrZero,
  1666.             docsDevFilterLLCProtocolType        INTEGER,
  1667.             docsDevFilterLLCProtocol            Integer32,
  1668.             docsDevFilterLLCMatches             Counter32
  1669.         }
  1670.  
  1671. docsDevFilterLLCIndex OBJECT-TYPE
  1672.         SYNTAX      Integer32 (1..2147483647)
  1673.         MAX-ACCESS  not-accessible
  1674.         STATUS      current
  1675.         DESCRIPTION
  1676.             "Index used for the identification of filters (note that LLC
  1677.              filter order is irrelevant)."
  1678.         ::= { docsDevFilterLLCEntry 1 }
  1679.  
  1680.  
  1681.  
  1682. St. Johns                      Standards                       [Page 30]
  1683.  
  1684. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1685.  
  1686.  
  1687. docsDevFilterLLCStatus OBJECT-TYPE
  1688.         SYNTAX      RowStatus
  1689.         MAX-ACCESS  read-create
  1690.         STATUS      current
  1691.         DESCRIPTION
  1692.             "Controls and reflects the status of rows in this
  1693.              table. There is no restriction on changing any of the
  1694.              associated columns for this row while this object is set
  1695.              to active."
  1696.  
  1697.         ::= { docsDevFilterLLCEntry 2}
  1698.  
  1699. docsDevFilterLLCIfIndex OBJECT-TYPE
  1700.         SYNTAX      InterfaceIndexOrZero
  1701.         MAX-ACCESS  read-create
  1702.         STATUS      current
  1703.         DESCRIPTION
  1704.             "The entry interface to which this filter applies.
  1705.              The value corresponds to ifIndex for either a CATV MAC
  1706.              or another network interface. If the value is zero, the
  1707.              filter applies to all interfaces. In Cable Modems, the
  1708.              default value is the customer side interface. In Cable
  1709.              Modem Termination Systems, this object has to be
  1710.              specified to create a row in this table."
  1711.         ::= { docsDevFilterLLCEntry 3 }
  1712.  
  1713. docsDevFilterLLCProtocolType OBJECT-TYPE
  1714.         SYNTAX INTEGER {
  1715.             ethertype(1),
  1716.             dsap(2)
  1717.         }
  1718.         MAX-ACCESS  read-create
  1719.         STATUS      current
  1720.         DESCRIPTION
  1721.             "The format of the value in docsDevFilterLLCProtocol:
  1722.              either a two-byte Ethernet Ethertype, or a one-byte
  1723.              802.2 SAP value. EtherType(1) also applies to SNAP-
  1724.              encapsulated frames."
  1725.         DEFVAL { ethertype }
  1726.         ::= { docsDevFilterLLCEntry 4 }
  1727.  
  1728. docsDevFilterLLCProtocol OBJECT-TYPE
  1729.         SYNTAX      Integer32 (0..65535)
  1730.         MAX-ACCESS  read-create
  1731.         STATUS      current
  1732.         DESCRIPTION
  1733.             "The layer three protocol for which this filter applies.
  1734.              The protocol value format depends on
  1735.  
  1736.  
  1737.  
  1738. St. Johns                      Standards                       [Page 31]
  1739.  
  1740. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1741.  
  1742.  
  1743.              docsDevFilterLLCProtocolType. Note that for SNAP frames,
  1744.              etherType filtering is performed rather than DSAP=0xAA."
  1745.         DEFVAL { 0 }
  1746.         ::= { docsDevFilterLLCEntry 5 }
  1747.  
  1748. docsDevFilterLLCMatches OBJECT-TYPE
  1749.         SYNTAX      Counter32
  1750.         MAX-ACCESS  read-only
  1751.         STATUS      current
  1752.         DESCRIPTION
  1753.             "Counts the number of times this filter was matched."
  1754.         ::= { docsDevFilterLLCEntry 6 }
  1755.  
  1756. -- The default behavior for (bridged) packets that do not match IP
  1757. -- filters is defined by
  1758. -- docsDevFilterIpDefault.
  1759.  
  1760. docsDevFilterIpDefault OBJECT-TYPE
  1761.         SYNTAX INTEGER {
  1762.             discard(1),
  1763.             accept(2)
  1764.         }
  1765.         MAX-ACCESS  read-write
  1766.         STATUS      current
  1767.         DESCRIPTION
  1768.             "If set to discard(1), all packets not matching an IP filter
  1769.              will be discarded. If set to accept(2), all packets not
  1770.              matching an IP filter will be accepted for further
  1771.              processing (e.g., bridging).
  1772.              At initial system startup, this object returns accept(2)."
  1773.         ::= { docsDevFilter 3 }
  1774.  
  1775. docsDevFilterIpTable OBJECT-TYPE
  1776.         SYNTAX      SEQUENCE OF DocsDevFilterIpEntry
  1777.         MAX-ACCESS  not-accessible
  1778.         STATUS      current
  1779.         DESCRIPTION
  1780.             "An ordered list of filters or classifiers to apply to
  1781.              IP traffic. Filter application is ordered by the filter
  1782.              index, rather than by a best match algorithm (Note that
  1783.              this implies that the filter table may have gaps in the
  1784.              index values). Packets which match no filters will have
  1785.              policy 0 in the docsDevFilterPolicyTable applied to them if
  1786.              it exists. Otherwise, Packets which match no filters
  1787.              are discarded or forwarded according to the setting of
  1788.              docsDevFilterIpDefault.
  1789.  
  1790.              Any IP packet can theoretically match multiple rows of
  1791.  
  1792.  
  1793.  
  1794. St. Johns                      Standards                       [Page 32]
  1795.  
  1796. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1797.  
  1798.  
  1799.              this table.  When considering a packet, the table is
  1800.              scanned in row index order (e.g. filter 10 is checked
  1801.              before filter 20).  If the packet matches that filter
  1802.              (which means that it matches ALL criteria for that row),
  1803.              actions appropriate to docsDevFilterIpControl and
  1804.              docsDevFilterPolicyId are taken.  If the packet was
  1805.              discarded processing is complete.  If
  1806.              docsDevFilterIpContinue is set to true, the filter
  1807.              comparison continues with the next row in the table
  1808.              looking for additional matches.
  1809.  
  1810.              If the packet matches no filter in the table, the packet
  1811.              is accepted or dropped for further processing based on
  1812.              the setting of docsDevFilterIpDefault. If the packet is
  1813.              accepted, the actions specified by policy group 0
  1814.              (e.g. the rows in docsDevFilterPolicyTable which have a
  1815.              value of 0 for docsDevFilterPolicyId) are taken if that
  1816.              policy group exists.
  1817.  
  1818.              Logically, this table is consulted twice during the
  1819.              processing of any IP packet - once upon its acceptance
  1820.              from the L2 entity, and once upon its transmission to the
  1821.              L2 entity.  In actuality, for cable modems, IP filtering
  1822.              is generally the only IP processing done for transit
  1823.              traffic.  This means that inbound and outbound filtering
  1824.              can generally be done at the same time with one pass
  1825.              through the filter table."
  1826.         ::= { docsDevFilter 4 }
  1827.  
  1828. docsDevFilterIpEntry OBJECT-TYPE
  1829.         SYNTAX      DocsDevFilterIpEntry
  1830.         MAX-ACCESS  not-accessible
  1831.         STATUS      current
  1832.         DESCRIPTION
  1833.             "Describes a filter to apply to IP traffic received on a
  1834.              specified interface.  All identity objects in this table
  1835.              (e.g. source and destination address/mask, protocol,
  1836.              source/dest port, TOS/mask, interface and direction) must
  1837.              match their respective fields in the packet for any given
  1838.              filter to match.
  1839.  
  1840.              To create an entry in this table, docsDevFilterIpIfIndex
  1841.              must be specified."
  1842.         INDEX { docsDevFilterIpIndex }
  1843.         ::= { docsDevFilterIpTable 1 }
  1844.  
  1845. DocsDevFilterIpEntry ::= SEQUENCE {
  1846.             docsDevFilterIpIndex             Integer32,
  1847.  
  1848.  
  1849.  
  1850. St. Johns                      Standards                       [Page 33]
  1851.  
  1852. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1853.  
  1854.  
  1855.             docsDevFilterIpStatus            RowStatus,
  1856.             docsDevFilterIpControl           INTEGER,
  1857.             docsDevFilterIpIfIndex           InterfaceIndexOrZero,
  1858.             docsDevFilterIpDirection         INTEGER,
  1859.             docsDevFilterIpBroadcast         TruthValue,
  1860.             docsDevFilterIpSaddr             IpAddress,
  1861.             docsDevFilterIpSmask             IpAddress,
  1862.             docsDevFilterIpDaddr             IpAddress,
  1863.             docsDevFilterIpDmask             IpAddress,
  1864.             docsDevFilterIpProtocol          Integer32,
  1865.             docsDevFilterIpSourcePortLow     Integer32,
  1866.             docsDevFilterIpSourcePortHigh    Integer32,
  1867.             docsDevFilterIpDestPortLow       Integer32,
  1868.             docsDevFilterIpDestPortHigh      Integer32,
  1869.             docsDevFilterIpMatches           Counter32,
  1870.             docsDevFilterIpTos               OCTET STRING,
  1871.             docsDevFilterIpTosMask           OCTET STRING,
  1872.             docsDevFilterIpContinue          TruthValue,
  1873.             docsDevFilterIpPolicyId          Integer32
  1874.         }
  1875.  
  1876. docsDevFilterIpIndex OBJECT-TYPE
  1877.         SYNTAX      Integer32 (1..2147483647)
  1878.         MAX-ACCESS  not-accessible
  1879.         STATUS      current
  1880.         DESCRIPTION
  1881.             "Index used to order the application of filters.
  1882.              The filter with the lowest index is always applied
  1883.              first."
  1884.         ::= { docsDevFilterIpEntry 1 }
  1885.  
  1886. docsDevFilterIpStatus OBJECT-TYPE
  1887.         SYNTAX      RowStatus
  1888.         MAX-ACCESS  read-create
  1889.         STATUS      current
  1890.         DESCRIPTION
  1891.             "Controls and reflects the status of rows in this
  1892.              table. Specifying only this object (with the appropriate
  1893.              index) on a CM is sufficient to create a filter row which
  1894.              matches all inbound packets on the ethernet interface,
  1895.              and results in the packets being
  1896.              discarded. docsDevFilterIpIfIndex (at least) must be
  1897.              specified on a CMTS to create a row.  Creation of the
  1898.              rows may be done via either create-and-wait or
  1899.              create-and-go, but the filter is not applied until this
  1900.              object is set to (or changes to) active. There is no
  1901.              restriction in changing any object in a row while this
  1902.              object is set to active."
  1903.  
  1904.  
  1905.  
  1906. St. Johns                      Standards                       [Page 34]
  1907.  
  1908. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1909.  
  1910.  
  1911.         ::= { docsDevFilterIpEntry 2 }
  1912.  
  1913. docsDevFilterIpControl OBJECT-TYPE
  1914.         SYNTAX INTEGER {
  1915.             discard(1),
  1916.             accept(2),
  1917.             policy(3)
  1918.         }
  1919.         MAX-ACCESS  read-create
  1920.         STATUS      current
  1921.         DESCRIPTION
  1922.             "If set to discard(1), all packets matching this filter
  1923.              will be discarded and scanning of the remainder of the
  1924.              filter list will be aborted. If set to accept(2), all
  1925.              packets matching this filter will be accepted for further
  1926.              processing (e.g., bridging). If docsDevFilterIpContinue
  1927.              is set to true, see if there are other matches, otherwise
  1928.              done. If set to policy (3), execute the policy entries
  1929.              matched by docsDevIpFilterPolicyId in
  1930.              docsDevIpFilterPolicyTable.
  1931.  
  1932.              If is docsDevFilterIpContinue is set to true, continue
  1933.              scanning the table for other matches, otherwise done."
  1934.         DEFVAL { discard }
  1935.         ::= { docsDevFilterIpEntry 3 }
  1936.  
  1937. docsDevFilterIpIfIndex OBJECT-TYPE
  1938.         SYNTAX      InterfaceIndexOrZero
  1939.         MAX-ACCESS  read-create
  1940.         STATUS      current
  1941.         DESCRIPTION
  1942.             "The entry interface to which this filter applies. The
  1943.              value corresponds to ifIndex for either a CATV MAC or
  1944.              another network interface. If the value is zero, the
  1945.              filter applies to all interfaces. Default value in Cable
  1946.              Modems is the index of the customer-side (e.g. ethernet)
  1947.              interface. In Cable Modem Termination Systems, this
  1948.              object MUST be specified to create a row in this table."
  1949.         ::= { docsDevFilterIpEntry 4 }
  1950.  
  1951. docsDevFilterIpDirection OBJECT-TYPE
  1952.         SYNTAX INTEGER {
  1953.             inbound(1),
  1954.             outbound(2),
  1955.             both(3)
  1956.         }
  1957.         MAX-ACCESS  read-create
  1958.         STATUS      current
  1959.  
  1960.  
  1961.  
  1962. St. Johns                      Standards                       [Page 35]
  1963.  
  1964. RFC 2669                DOCSIS Cable Device MIB              August 1999
  1965.  
  1966.  
  1967.         DESCRIPTION
  1968.             "Determines whether the filter is applied to inbound(1)
  1969.              traffic, outbound(2) traffic, or traffic in both(3)
  1970.              directions."
  1971.         DEFVAL { inbound }
  1972.         ::= { docsDevFilterIpEntry 5 }
  1973.  
  1974. docsDevFilterIpBroadcast OBJECT-TYPE
  1975.         SYNTAX      TruthValue
  1976.         MAX-ACCESS  read-create
  1977.         STATUS      current
  1978.         DESCRIPTION
  1979.             "If set to true(1), the filter only applies to multicast
  1980.              and broadcast traffic. If set to false(2), the filter
  1981.              applies to all traffic."
  1982.         DEFVAL { false }
  1983.         ::= { docsDevFilterIpEntry 6 }
  1984.  
  1985. docsDevFilterIpSaddr OBJECT-TYPE
  1986.         SYNTAX      IpAddress
  1987.         MAX-ACCESS  read-create
  1988.         STATUS      current
  1989.         DESCRIPTION
  1990.             "The source IP address, or portion thereof, that is to be
  1991.              matched for this filter.  The source address is first
  1992.              masked (and'ed) against docsDevFilterIpSmask before being
  1993.              compared  to this value.  A value of 0 for this object
  1994.              and 0 for the mask matches all IP addresses."
  1995.         DEFVAL { '00000000'h }
  1996.         ::= { docsDevFilterIpEntry 7 }
  1997.  
  1998. docsDevFilterIpSmask OBJECT-TYPE
  1999.         SYNTAX      IpAddress
  2000.         MAX-ACCESS  read-create
  2001.         STATUS      current
  2002.         DESCRIPTION
  2003.             "A bit mask that is to be applied to the source address
  2004.              prior to matching. This mask is not necessarily the same
  2005.              as a subnet mask, but 1's bits must be leftmost and
  2006.              contiguous."
  2007.         DEFVAL { '00000000'h }
  2008.         ::= { docsDevFilterIpEntry 8 }
  2009.  
  2010. docsDevFilterIpDaddr OBJECT-TYPE
  2011.         SYNTAX      IpAddress
  2012.         MAX-ACCESS  read-create
  2013.         STATUS      current
  2014.         DESCRIPTION
  2015.  
  2016.  
  2017.  
  2018. St. Johns                      Standards                       [Page 36]
  2019.  
  2020. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2021.  
  2022.  
  2023.             "The destination IP address, or portion thereof, that is
  2024.              to be matched for this filter. The destination address is
  2025.              first masked (and'ed) against docsDevFilterIpDmask before
  2026.              being compared  to this value.  A value of 0 for this
  2027.              object and 0 for the mask matches all IP addresses."
  2028.         DEFVAL { '00000000'h }
  2029.         ::= { docsDevFilterIpEntry 9 }
  2030.  
  2031. docsDevFilterIpDmask OBJECT-TYPE
  2032.         SYNTAX      IpAddress
  2033.         MAX-ACCESS  read-create
  2034.         STATUS      current
  2035.         DESCRIPTION
  2036.             "A bit mask that is to be applied to the destination
  2037.              address prior to matching. This mask is not necessarily
  2038.              the same as a subnet mask, but 1's bits must be leftmost
  2039.              and contiguous."
  2040.         DEFVAL { '00000000'h }
  2041.         ::= { docsDevFilterIpEntry 10 }
  2042.  
  2043. docsDevFilterIpProtocol OBJECT-TYPE
  2044.         SYNTAX Integer32 (0..256)
  2045.         MAX-ACCESS  read-create
  2046.         STATUS      current
  2047.         DESCRIPTION
  2048.             "The IP protocol value that is to be matched. For example:
  2049.              icmp is 1, tcp is 6, udp is 17. A value of 256 matches
  2050.              ANY protocol."
  2051.         DEFVAL { 256 }
  2052.         ::= { docsDevFilterIpEntry 11 }
  2053.  
  2054. docsDevFilterIpSourcePortLow OBJECT-TYPE
  2055.         SYNTAX      Integer32 (0..65535)
  2056.         MAX-ACCESS  read-create
  2057.         STATUS      current
  2058.         DESCRIPTION
  2059.             "If docsDevFilterIpProtocol is udp or tcp, this is the
  2060.              inclusive lower bound of the transport-layer source port
  2061.              range that is to be matched, otherwise it is ignored
  2062.              during matching."
  2063.         DEFVAL { 0 }
  2064.         ::= { docsDevFilterIpEntry 12 }
  2065.  
  2066. docsDevFilterIpSourcePortHigh OBJECT-TYPE
  2067.         SYNTAX      Integer32 (0..65535)
  2068.         MAX-ACCESS  read-create
  2069.         STATUS      current
  2070.         DESCRIPTION
  2071.  
  2072.  
  2073.  
  2074. St. Johns                      Standards                       [Page 37]
  2075.  
  2076. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2077.  
  2078.  
  2079.             "If docsDevFilterIpProtocol is udp or tcp, this is the
  2080.              inclusive upper bound of the transport-layer source port
  2081.              range that is to be matched, otherwise it is ignored
  2082.              during matching."
  2083.         DEFVAL { 65535 }
  2084.         ::= { docsDevFilterIpEntry 13 }
  2085.  
  2086. docsDevFilterIpDestPortLow OBJECT-TYPE
  2087.         SYNTAX      Integer32 (0..65535)
  2088.         MAX-ACCESS  read-create
  2089.         STATUS      current
  2090.         DESCRIPTION
  2091.             "If docsDevFilterIpProtocol is udp or tcp, this is the
  2092.              inclusive lower bound of the transport-layer destination
  2093.              port range that is to be matched, otherwise it is ignored
  2094.              during matching."
  2095.         DEFVAL { 0 }
  2096.         ::= { docsDevFilterIpEntry 14 }
  2097.  
  2098. docsDevFilterIpDestPortHigh OBJECT-TYPE
  2099.         SYNTAX      Integer32 (0..65535)
  2100.         MAX-ACCESS  read-create
  2101.         STATUS      current
  2102.         DESCRIPTION
  2103.             "If docsDevFilterIpProtocol is udp or tcp, this is the
  2104.              inclusive upper bound of the transport-layer destination
  2105.              port range that is to be matched, otherwise it is ignored
  2106.              during matching."
  2107.         DEFVAL { 65535 }
  2108.         ::= { docsDevFilterIpEntry 15 }
  2109.  
  2110. docsDevFilterIpMatches OBJECT-TYPE
  2111.         SYNTAX      Counter32
  2112.         MAX-ACCESS  read-only
  2113.         STATUS      current
  2114.         DESCRIPTION
  2115.             "Counts the number of times this filter was matched.
  2116.              This object is initialized to 0 at boot, or at row
  2117.              creation, and is reset only upon reboot."
  2118.         ::= { docsDevFilterIpEntry 16 }
  2119.  
  2120. docsDevFilterIpTos  OBJECT-TYPE
  2121.         SYNTAX      OCTET STRING ( SIZE (1))
  2122.         MAX-ACCESS  read-create
  2123.         STATUS      current
  2124.         DESCRIPTION
  2125.             "This is the value to be matched to the packet's
  2126.              TOS (Type of Service) value (after the TOS value
  2127.  
  2128.  
  2129.  
  2130. St. Johns                      Standards                       [Page 38]
  2131.  
  2132. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2133.  
  2134.  
  2135.              is AND'd with docsDevFilterIpTosMask).  A value for this
  2136.              object of 0 and a mask of 0 matches all TOS values."
  2137.         DEFVAL { '00'h }
  2138.         ::= { docsDevFilterIpEntry 17 }
  2139.  
  2140. docsDevFilterIpTosMask OBJECT-TYPE
  2141.         SYNTAX      OCTET STRING ( SIZE (1) )
  2142.         MAX-ACCESS  read-create
  2143.         STATUS      current
  2144.         DESCRIPTION
  2145.             "The mask to be applied to the packet's TOS value before
  2146.              matching."
  2147.         DEFVAL { '00'h }
  2148.         ::= { docsDevFilterIpEntry 18 }
  2149.  
  2150. docsDevFilterIpContinue OBJECT-TYPE
  2151.         SYNTAX      TruthValue
  2152.         MAX-ACCESS  read-create
  2153.         STATUS      current
  2154.         DESCRIPTION
  2155.             "If this value is set to true, and docsDevFilterIpControl
  2156.              is anything but discard (1), continue scanning and
  2157.              applying policies."
  2158.         DEFVAL { false }
  2159.         ::= { docsDevFilterIpEntry 19 }
  2160.  
  2161. docsDevFilterIpPolicyId OBJECT-TYPE
  2162.         SYNTAX      Integer32 (0..2147483647)
  2163.         MAX-ACCESS  read-create
  2164.         STATUS      current
  2165.         DESCRIPTION
  2166.             "This object points to an entry in docsDevFilterPolicyTable.
  2167.              If docsDevFilterIpControl is set to policy (3), execute
  2168.              all matching policies in docsDevFilterPolicyTable.
  2169.              If no matching policy exists, treat as if
  2170.              docsDevFilterIpControl were set to accept (1).
  2171.              If this object is set to the value of 0, there is no
  2172.              matching policy, and docsDevFilterPolicyTable MUST NOT be
  2173.              consulted."
  2174.         DEFVAL { 0 }
  2175.         ::= { docsDevFilterIpEntry 20 }
  2176.  
  2177. --
  2178. --
  2179.  
  2180. docsDevFilterPolicyTable OBJECT-TYPE
  2181.         SYNTAX      SEQUENCE OF DocsDevFilterPolicyEntry
  2182.         MAX-ACCESS  not-accessible
  2183.  
  2184.  
  2185.  
  2186. St. Johns                      Standards                       [Page 39]
  2187.  
  2188. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2189.  
  2190.  
  2191.         STATUS      current
  2192.         DESCRIPTION
  2193.             "A Table which maps between a policy group ID and a set of
  2194.              policies to be applied.  All rows with the same
  2195.              docsDevFilterPolicyId are part of the same policy group
  2196.              and are applied in the order in which they are in this
  2197.              table.
  2198.  
  2199.              docsDevFilterPolicyTable exists to allow multiple policy
  2200.              actions to be applied to any given classified packet. The
  2201.              policy actions are applied in index order For example:
  2202.  
  2203.              Index   ID    Type    Action
  2204.               1      1      TOS     1
  2205.               9      5      TOS     1
  2206.               12     1      IPSEC   3
  2207.  
  2208.              This says that a packet which matches a filter with
  2209.              policy id 1, first has TOS policy 1 applied (which might
  2210.              set the TOS bits to enable a higher priority), and next
  2211.              has the IPSEC policy 3 applied (which may result in the
  2212.              packet being dumped into a secure VPN to a remote
  2213.              encryptor).
  2214.  
  2215.              Policy ID 0 is reserved for default actions and is
  2216.              applied only to packets which match no filters in
  2217.              docsDevIpFilterTable."
  2218.         ::= { docsDevFilter 5 }
  2219.  
  2220. docsDevFilterPolicyEntry OBJECT-TYPE
  2221.         SYNTAX      DocsDevFilterPolicyEntry
  2222.         MAX-ACCESS  not-accessible
  2223.         STATUS      current
  2224.         DESCRIPTION
  2225.             "An entry in the docsDevFilterPolicyTable. Entries are
  2226.              created by Network Management. To create an entry,
  2227.              docsDevFilterPolicyId and docsDevFilterPolicyAction
  2228.              must be specified."
  2229.         INDEX { docsDevFilterPolicyIndex }
  2230.         ::= { docsDevFilterPolicyTable 1 }
  2231.  
  2232. DocsDevFilterPolicyEntry ::= SEQUENCE {
  2233.             docsDevFilterPolicyIndex   Integer32,
  2234.             docsDevFilterPolicyId      Integer32,
  2235. --            docsDevFilterPolicyType    INTEGER,
  2236. --            docsDevFilterPolicyAction  Integer32,
  2237.             docsDevFilterPolicyStatus  RowStatus,
  2238.             docsDevFilterPolicyPtr     RowPointer
  2239.  
  2240.  
  2241.  
  2242. St. Johns                      Standards                       [Page 40]
  2243.  
  2244. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2245.  
  2246.  
  2247.         }
  2248.  
  2249. docsDevFilterPolicyIndex OBJECT-TYPE
  2250.         SYNTAX      Integer32 (1..2147483647)
  2251.         MAX-ACCESS  not-accessible
  2252.         STATUS      current
  2253.         DESCRIPTION "Index value for the table."
  2254.         ::= { docsDevFilterPolicyEntry 1 }
  2255.  
  2256. docsDevFilterPolicyId OBJECT-TYPE
  2257.         SYNTAX      Integer32 (0..2147483647)
  2258.         MAX-ACCESS  read-create
  2259.         STATUS      current
  2260.         DESCRIPTION
  2261.              "Policy ID for this entry. A policy ID can apply to
  2262.               multiple rows of this table, all relevant policies are
  2263.               executed. Policy 0 (if populated) is applied to all
  2264.               packets which do not match any of the filters. N.B. If
  2265.               docsDevFilterIpPolicyId is set to 0, it DOES NOT match
  2266.               policy 0 of this table. "
  2267.         ::= { docsDevFilterPolicyEntry 2 }
  2268.  
  2269. -- docsDevFilterPolicyType ::= { docsDevFilterPolicyEntry 3} Removed
  2270. -- docsDevFilterPolicyAction ::= { docsDevFilterPolicyEntry 4 } removed
  2271.  
  2272. docsDevFilterPolicyStatus OBJECT-TYPE
  2273.         SYNTAX      RowStatus
  2274.         MAX-ACCESS  read-create
  2275.         STATUS      current
  2276.         DESCRIPTION
  2277.             "Object used to create an entry in this table."
  2278.         ::= { docsDevFilterPolicyEntry 5 }
  2279.  
  2280.  
  2281. docsDevFilterPolicyPtr OBJECT-TYPE
  2282.         SYNTAX      RowPointer
  2283.         MAX-ACCESS  read-create
  2284.         STATUS      current
  2285.         DESCRIPTION
  2286.             "This object points to a row in an applicable filter policy
  2287.              table.  Currently, the only standard policy table is
  2288.              docsDevFilterTosTable. Per the textual convention, this
  2289.              object points to the first accessible object in the row.
  2290.              E.g. to point to a row in docsDevFilterTosTable with an
  2291.              index of 21, the value of this object would be the object
  2292.              identifier docsDevTosStatus.21.
  2293.  
  2294.              Vendors must adhere to the same convention when adding
  2295.  
  2296.  
  2297.  
  2298. St. Johns                      Standards                       [Page 41]
  2299.  
  2300. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2301.  
  2302.  
  2303.              vendor specific policy table extensions.
  2304.  
  2305.              The default upon row creation is a null pointer which
  2306.              results in no policy action being taken."
  2307.         DEFVAL { zeroDotZero }
  2308.         ::= { docsDevFilterPolicyEntry 6 }
  2309.  
  2310. --
  2311. -- TOS Policy action table
  2312. --
  2313.  
  2314. docsDevFilterTosTable OBJECT-TYPE
  2315.         SYNTAX      SEQUENCE OF DocsDevFilterTosEntry
  2316.         MAX-ACCESS  not-accessible
  2317.         STATUS      current
  2318.         DESCRIPTION
  2319.              "Table used to describe Type of Service (TOS) bits
  2320.              processing.
  2321.  
  2322.              This table is an adjunct to the docsDevFilterIpTable, and
  2323.              the docsDevFilterPolicy table.  Entries in the latter
  2324.              table can point to specific rows in this (and other)
  2325.              tables and cause specific actions to be taken.  This table
  2326.              permits the manipulation of the value of the Type of
  2327.              Service bits in the IP header of the matched packet as
  2328.              follows:
  2329.              Set the tosBits of the packet to
  2330.                 (tosBits & docsDevFilterTosAndMask) |
  2331.                                                  docsDevFilterTosOrMask
  2332.  
  2333.              This construct allows you to do a clear and set of all
  2334.              the TOS bits in a flexible manner."
  2335.         ::= { docsDevFilter 6 }
  2336.  
  2337. docsDevFilterTosEntry OBJECT-TYPE
  2338.         SYNTAX      DocsDevFilterTosEntry
  2339.         MAX-ACCESS  not-accessible
  2340.         STATUS      current
  2341.         DESCRIPTION
  2342.              "A TOS policy entry."
  2343.         INDEX { docsDevFilterTosIndex }
  2344.         ::= { docsDevFilterTosTable 1 }
  2345.  
  2346. DocsDevFilterTosEntry ::= SEQUENCE {
  2347.             docsDevFilterTosIndex   Integer32,
  2348.             docsDevFilterTosStatus  RowStatus,
  2349.             docsDevFilterTosAndMask OCTET STRING (SIZE (1)),
  2350.             docsDevFilterTosOrMask  OCTET STRING (SIZE (1))
  2351.  
  2352.  
  2353.  
  2354. St. Johns                      Standards                       [Page 42]
  2355.  
  2356. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2357.  
  2358.  
  2359.         }
  2360.  
  2361. docsDevFilterTosIndex OBJECT-TYPE
  2362.         SYNTAX      Integer32 (1..2147483647)
  2363.         MAX-ACCESS  not-accessible
  2364.         STATUS      current
  2365.         DESCRIPTION
  2366.             "The unique index for this row.  There are no ordering
  2367.              requirements for this table and any valid index may be
  2368.              specified."
  2369.         ::= { docsDevFilterTosEntry 1 }
  2370.  
  2371. docsDevFilterTosStatus OBJECT-TYPE
  2372.         SYNTAX      RowStatus
  2373.         MAX-ACCESS  read-create
  2374.         STATUS      current
  2375.         DESCRIPTION
  2376.             "The object used to create and delete entries in this
  2377.              table. A row created by specifying just this object
  2378.              results in a row which specifies no change to the TOS
  2379.              bits.   A row may be created using either the create-and-go
  2380.              or create-and-wait paradigms. There is no restriction on
  2381.              the ability to change values in this row while the row is
  2382.              active."
  2383.         ::= { docsDevFilterTosEntry 2 }
  2384.  
  2385. docsDevFilterTosAndMask OBJECT-TYPE
  2386.         SYNTAX      OCTET STRING (SIZE (1))
  2387.         MAX-ACCESS  read-create
  2388.         STATUS      current
  2389.         DESCRIPTION
  2390.  
  2391.             "This value is bitwise AND'd with the matched  packet's
  2392.         TOS bits."
  2393.         DEFVAL { 'ff'h }
  2394.         ::= { docsDevFilterTosEntry 3 }
  2395.  
  2396. docsDevFilterTosOrMask OBJECT-TYPE
  2397.         SYNTAX      OCTET STRING (SIZE (1))
  2398.         MAX-ACCESS  read-create
  2399.         STATUS      current
  2400.         DESCRIPTION
  2401.             "After bitwise AND'ing with the above bits, the packet's
  2402.              TOS bits are bitwise OR'd with these bits."
  2403.         DEFVAL { '00'h }
  2404.         ::= { docsDevFilterTosEntry 4 }
  2405.  
  2406.  
  2407.  
  2408.  
  2409.  
  2410. St. Johns                      Standards                       [Page 43]
  2411.  
  2412. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2413.  
  2414.  
  2415. --
  2416. -- CPE IP Management and anti spoofing group.  Only implemented on
  2417. -- Cable Modems.
  2418. --
  2419.  
  2420. docsDevCpe OBJECT IDENTIFIER ::= { docsDevMIBObjects 7}
  2421.  
  2422. docsDevCpeEnroll OBJECT-TYPE
  2423.         SYNTAX      INTEGER {
  2424.             none(1),
  2425.             any(2)
  2426.         }
  2427.         MAX-ACCESS  read-write
  2428.         STATUS      current
  2429.         DESCRIPTION
  2430.             "This object controls the population of docsDevFilterCpeTable.
  2431.              If set to none, the filters must be set manually.
  2432.              If set to any, the CM wiretaps the packets originating
  2433.              from the ethernet and enrolls up to docsDevCpeIpMax
  2434.              addresses based on the source IP addresses of those
  2435.              packets. At initial system startup, default value for this
  2436.              object is any(2)."
  2437.         ::= { docsDevCpe 1 }
  2438.  
  2439. docsDevCpeIpMax OBJECT-TYPE
  2440.         SYNTAX      Integer32 (-1..2147483647)
  2441.         MAX-ACCESS  read-write
  2442.         STATUS      current
  2443.         DESCRIPTION
  2444.             "This object controls the maximum number of CPEs allowed to
  2445.              connect behind this device. If set to zero, any number of
  2446.              CPEs may connect up to the maximum permitted for the device.
  2447.              If set to -1, no filtering is done on CPE source addresses,
  2448.              and no entries are made in the docsDevFilterCpeTable. If an
  2449.              attempt is made to set this to a number greater than that
  2450.              permitted for the device, it is set to that maximum.
  2451.              At iniitial system startup, default value for this object
  2452.              is 1."
  2453.         ::= { docsDevCpe 2 }
  2454.  
  2455. docsDevCpeTable OBJECT-TYPE
  2456.         SYNTAX      SEQUENCE OF DocsDevCpeEntry
  2457.         MAX-ACCESS  not-accessible
  2458.         STATUS      current
  2459.         DESCRIPTION
  2460.             "This table lists the IP addresses seen (or permitted)  as
  2461.              source addresses in packets originating from the customer
  2462.              interface on this device. In addition, this table can be
  2463.  
  2464.  
  2465.  
  2466. St. Johns                      Standards                       [Page 44]
  2467.  
  2468. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2469.  
  2470.  
  2471.              provisioned with the specific addresses permitted for the
  2472.              CPEs via the normal row creation mechanisms."
  2473.         ::= { docsDevCpe 3 }
  2474.  
  2475. docsDevCpeEntry OBJECT-TYPE
  2476.         SYNTAX      DocsDevCpeEntry
  2477.         MAX-ACCESS  not-accessible
  2478.         STATUS      current
  2479.         DESCRIPTION
  2480.             "An entry in the docsDevFilterCpeTable. There is one entry
  2481.              for each IP CPE seen or provisioned. If docsDevCpeIpMax
  2482.              is set to -1, this table is ignored, otherwise: Upon receipt
  2483.              of an IP  packet from the customer interface of the CM, the
  2484.              source IP address is checked against this table. If the
  2485.              address is in the table, packet processing continues.
  2486.              If the address is not in the table, but docsDevCpeEnroll
  2487.              is set to any and the table size is less than
  2488.              docsDevCpeIpMax, the address is added to the table and
  2489.              packet processing continues. Otherwise, the packet is
  2490.              dropped.
  2491.  
  2492.              The filtering actions specified by this table occur after
  2493.              any LLC filtering (docsDevFilterLLCTable), but prior
  2494.              to any IP filtering (docsDevFilterIpTable,
  2495.              docsDevNmAccessTable)."
  2496.         INDEX   { docsDevCpeIp }
  2497.         ::= {docsDevCpeTable 1 }
  2498.  
  2499. DocsDevCpeEntry ::= SEQUENCE {
  2500.             docsDevCpeIp      IpAddress,
  2501.             docsDevCpeSource  INTEGER,
  2502.             docsDevCpeStatus  RowStatus
  2503.         }
  2504.  
  2505. docsDevCpeIp OBJECT-TYPE
  2506.         SYNTAX      IpAddress
  2507.         MAX-ACCESS  not-accessible
  2508.         STATUS      current
  2509.         DESCRIPTION
  2510.             "The IP address to which this entry applies."
  2511.         ::= { docsDevCpeEntry 1 }
  2512.  
  2513. docsDevCpeSource OBJECT-TYPE
  2514.         SYNTAX      INTEGER {
  2515.             other(1),
  2516.             manual(2),
  2517.             learned(3)
  2518.         }
  2519.  
  2520.  
  2521.  
  2522. St. Johns                      Standards                       [Page 45]
  2523.  
  2524. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2525.  
  2526.  
  2527.         MAX-ACCESS  read-only
  2528.         STATUS      current
  2529.         DESCRIPTION
  2530.             "This object describes how this entry was created. If the
  2531.              value is manual(2), this row was created by a network
  2532.              management action (either configuration, or SNMP set).
  2533.              If set to learned(3), then it was found via
  2534.              looking at the source IP address of a received packet."
  2535.         ::= { docsDevCpeEntry 2 }
  2536.  
  2537. docsDevCpeStatus OBJECT-TYPE
  2538.         SYNTAX  RowStatus
  2539.         MAX-ACCESS  read-create
  2540.         STATUS  current
  2541.         DESCRIPTION
  2542.             "Standard object to manipulate rows. To create a row in this
  2543.              table, you only need to specify this object. Management
  2544.              stations SHOULD use the create-and-go mechanism for
  2545.              creating rows in this table."
  2546.         ::= { docsDevCpeEntry 3 }
  2547.  
  2548. --
  2549. -- Placeholder for notifications/traps.
  2550. --
  2551. docsDevNotification OBJECT IDENTIFIER   ::= { docsDev 2 }
  2552.  
  2553.  
  2554. --
  2555. -- Conformance definitions
  2556. --
  2557. docsDevConformance  OBJECT IDENTIFIER   ::= { docsDev 3 }
  2558. docsDevGroups       OBJECT IDENTIFIER   ::= { docsDevConformance 1 }
  2559. docsDevCompliances  OBJECT IDENTIFIER   ::= { docsDevConformance 2 }
  2560.  
  2561. docsDevBasicCompliance MODULE-COMPLIANCE
  2562.         STATUS  current
  2563.         DESCRIPTION
  2564.             "The compliance statement for MCNS Cable Modems and
  2565.              Cable Modem Termination Systems."
  2566.  
  2567. MODULE  -- docsDev
  2568.  
  2569. -- conditionally mandatory groups
  2570.  
  2571. GROUP docsDevBaseGroup
  2572.         DESCRIPTION
  2573.             "Mandatory in Cable Modems, optional in Cable Modem
  2574.              Termination Systems."
  2575.  
  2576.  
  2577.  
  2578. St. Johns                      Standards                       [Page 46]
  2579.  
  2580. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2581.  
  2582.  
  2583. GROUP docsDevEventGroup
  2584.         DESCRIPTION
  2585.             "Mandatory in Cable Modems, optional in Cable Modem
  2586.              Termination Systems."
  2587.  
  2588. GROUP docsDevFilterGroup
  2589.         DESCRIPTION
  2590.             "Mandatory in Cable Modems, optional in Cable Modem
  2591.              Termination Systems."
  2592.  
  2593. GROUP docsDevNmAccessGroup
  2594.         DESCRIPTION
  2595.             "This group is only implemented in devices which do not
  2596.              implement SNMPv3 User Security Model.  It SHOULD NOT be
  2597.              implemented by SNMPv3 conformant devices.
  2598.  
  2599.              For devices which do not implement SNMPv3 or later, this
  2600.              group is Mandatory in Cable Modems and is optional
  2601.              in Cable Modem Termination Systems."
  2602.  
  2603. GROUP docsDevServerGroup
  2604.         DESCRIPTION
  2605.             "This group is implemented only in Cable Modems and is
  2606.              not implemented in Cable Modem Termination Systems."
  2607.  
  2608. GROUP docsDevSoftwareGroup
  2609.         DESCRIPTION
  2610.             "This group is Mandatory in Cable Modems and  optional in
  2611.              Cable Modem Termination Systems."
  2612.  
  2613. GROUP docsDevCpeGroup
  2614.         DESCRIPTION
  2615.             "This group is Mandatory in Cable Modems, and is
  2616.              not implemented in Cable Modem Termination Systems.  A
  2617.              similar capability for CMTS devices may be proposed later
  2618.              after study."
  2619.  
  2620. OBJECT docsDevSTPControl
  2621.         MIN-ACCESS read-only
  2622.         DESCRIPTION
  2623.             "It is compliant to implement this object as read-only.
  2624.              Devices need only support noStFilterBpdu(2)."
  2625.  
  2626. OBJECT docsDevEvReporting
  2627.          MIN-ACCESS read-only
  2628.          DESCRIPTION
  2629.              "It is compliant to implement this object as read-only.
  2630.               Devices need only support local(0)."
  2631.  
  2632.  
  2633.  
  2634. St. Johns                      Standards                       [Page 47]
  2635.  
  2636. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2637.  
  2638.  
  2639.          ::= { docsDevCompliances 1 }
  2640.  
  2641. docsDevBaseGroup OBJECT-GROUP
  2642.         OBJECTS {
  2643.              docsDevRole,
  2644.              docsDevDateTime,
  2645.              docsDevResetNow,
  2646.              docsDevSerialNumber,
  2647.              docsDevSTPControl
  2648.         }
  2649.         STATUS      current
  2650.         DESCRIPTION
  2651.             "A collection of objects providing device status and
  2652.              control."
  2653.         ::= { docsDevGroups 1 }
  2654.  
  2655. docsDevNmAccessGroup OBJECT-GROUP
  2656.         OBJECTS {
  2657.              docsDevNmAccessIp,
  2658.              docsDevNmAccessIpMask,
  2659.              docsDevNmAccessCommunity,
  2660.              docsDevNmAccessControl,
  2661.              docsDevNmAccessInterfaces,
  2662.              docsDevNmAccessStatus
  2663.         }
  2664.         STATUS      current
  2665.         DESCRIPTION
  2666.             "A collection of objects for controlling access to SNMP
  2667.              objects."
  2668.         ::= { docsDevGroups 2 }
  2669.  
  2670. docsDevSoftwareGroup OBJECT-GROUP
  2671.         OBJECTS {
  2672.             docsDevSwServer,
  2673.             docsDevSwFilename,
  2674.             docsDevSwAdminStatus,
  2675.             docsDevSwOperStatus,
  2676.             docsDevSwCurrentVers
  2677.         }
  2678.         STATUS      current
  2679.         DESCRIPTION
  2680.             "A collection of objects for controlling software
  2681.              downloads."
  2682.         ::= { docsDevGroups 3 }
  2683.  
  2684. docsDevServerGroup OBJECT-GROUP
  2685.         OBJECTS {
  2686.             docsDevServerBootState,
  2687.  
  2688.  
  2689.  
  2690. St. Johns                      Standards                       [Page 48]
  2691.  
  2692. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2693.  
  2694.  
  2695.             docsDevServerDhcp,
  2696.             docsDevServerTime,
  2697.             docsDevServerTftp,
  2698.             docsDevServerConfigFile
  2699.         }
  2700.         STATUS      current
  2701.         DESCRIPTION
  2702.             "A collection of objects providing status about server
  2703.              provisioning."
  2704.         ::= { docsDevGroups 4 }
  2705.  
  2706. docsDevEventGroup OBJECT-GROUP
  2707.         OBJECTS {
  2708.             docsDevEvControl,
  2709.             docsDevEvSyslog,
  2710.             docsDevEvThrottleAdminStatus,
  2711.             docsDevEvThrottleInhibited,
  2712.             docsDevEvThrottleThreshold,
  2713.             docsDevEvThrottleInterval,
  2714.             docsDevEvReporting,
  2715.             docsDevEvFirstTime,
  2716.             docsDevEvLastTime,
  2717.             docsDevEvCounts,
  2718.             docsDevEvLevel,
  2719.             docsDevEvId,
  2720.             docsDevEvText
  2721.         }
  2722.         STATUS      current
  2723.         DESCRIPTION
  2724.             "A collection of objects used to control and monitor
  2725.              events."
  2726.         ::= { docsDevGroups 5 }
  2727.  
  2728. docsDevFilterGroup OBJECT-GROUP
  2729.         OBJECTS {
  2730.             docsDevFilterLLCUnmatchedAction,
  2731.             docsDevFilterIpDefault,
  2732.             docsDevFilterLLCStatus,
  2733.             docsDevFilterLLCIfIndex,
  2734.             docsDevFilterLLCProtocolType,
  2735.             docsDevFilterLLCProtocol,
  2736.             docsDevFilterLLCMatches,
  2737.             docsDevFilterIpControl,
  2738.             docsDevFilterIpIfIndex,
  2739.             docsDevFilterIpStatus,
  2740.             docsDevFilterIpDirection,
  2741.             docsDevFilterIpBroadcast,
  2742.             docsDevFilterIpSaddr,
  2743.  
  2744.  
  2745.  
  2746. St. Johns                      Standards                       [Page 49]
  2747.  
  2748. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2749.  
  2750.  
  2751.             docsDevFilterIpSmask,
  2752.             docsDevFilterIpDaddr,
  2753.             docsDevFilterIpDmask,
  2754.             docsDevFilterIpProtocol,
  2755.             docsDevFilterIpSourcePortLow,
  2756.             docsDevFilterIpSourcePortHigh,
  2757.             docsDevFilterIpDestPortLow,
  2758.             docsDevFilterIpDestPortHigh,
  2759.             docsDevFilterIpMatches,
  2760.             docsDevFilterIpTos,
  2761.             docsDevFilterIpTosMask,
  2762.             docsDevFilterIpContinue,
  2763.             docsDevFilterIpPolicyId,
  2764.             docsDevFilterPolicyId,
  2765.             docsDevFilterPolicyStatus,
  2766.             docsDevFilterPolicyPtr,
  2767.             docsDevFilterTosStatus,
  2768.             docsDevFilterTosAndMask,
  2769.             docsDevFilterTosOrMask
  2770.         }
  2771.         STATUS      current
  2772.         DESCRIPTION
  2773.             "A collection of objects to specify filters at link layer
  2774.              and IP layer."
  2775.         ::= { docsDevGroups 6 }
  2776.  
  2777. docsDevCpeGroup OBJECT-GROUP
  2778.         OBJECTS {
  2779.            docsDevCpeEnroll,
  2780.            docsDevCpeIpMax,
  2781.            docsDevCpeSource,
  2782.            docsDevCpeStatus
  2783.         }
  2784.         STATUS      current
  2785.         DESCRIPTION
  2786.             "A collection of objects used to control the number
  2787.              and specific values of IP addresses allowed for
  2788.              associated Customer Premises Equipment (CPE)."
  2789.         ::= { docsDevGroups 7 }
  2790.  
  2791. END
  2792.  
  2793.  
  2794.  
  2795.  
  2796.  
  2797.  
  2798.  
  2799.  
  2800.  
  2801.  
  2802. St. Johns                      Standards                       [Page 50]
  2803.  
  2804. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2805.  
  2806.  
  2807. 5.  Acknowledgments
  2808.  
  2809.    This document was produced by the IPCDN Working Group.  It is based
  2810.    on a document written by Pam Anderson from CableLabs, Wilson Sawyer
  2811.    from BayNetworks, and Rich Woundy from Continental Cablevision.  The
  2812.    original working group editor, Guenter Roeck of cisco Systems, did
  2813.    much of the grunt work of putting the document into its current form.
  2814.  
  2815.    Special thanks is also due to Azlina Palmer, who helped a lot
  2816.    reviewing the document.
  2817.  
  2818. 6.  References
  2819.  
  2820.    [1]  Harrington, D., Presuhn, R. and B. Wijnen, "An Architecture for
  2821.         Describing SNMP Management Frameworks", RFC 2571, April 1999.
  2822.  
  2823.    [2]  Rose, M. and K. McCloghrie, "Structure and Identification of
  2824.         Management Information for TCP/IP-based Internets", STD 16, RFC
  2825.         1155, May 1990.
  2826.  
  2827.    [3]  Rose, M. and K. McCloghrie, "Concise MIB Definitions", STD 16,
  2828.         RFC 1212, March 1991.
  2829.  
  2830.    [4]  Rose, M., "A Convention for Defining Traps for use with the
  2831.         SNMP", RFC 1215, March 1991.
  2832.  
  2833.    [5]  McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Structure of
  2834.         Management Information for Version 2 (SMIv2)", STD 58, RFC 2578,
  2835.         April 1999.
  2836.  
  2837.    [6]  McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Textual
  2838.         Conventions for SMIv2", STD 58, RFC 2579, April 1999.
  2839.  
  2840.    [7]  McCloghrie, K., Perkins, D. and J. Schoenwaelder, "Conformance
  2841.         Statements for SMIv2", STD 58, RFC 2580, April 1999.
  2842.  
  2843.    [8]  Case, J., Fedor, M., Schoffstall, M. and J. Davin, "Simple
  2844.         Network Management Protocol", STD 15, RFC 1157, May 1990.
  2845.  
  2846.    [9]  Case, J., McCloghrie, K., Rose, M. and S. Waldbusser,
  2847.         "Introduction to Community-based SNMPv2", RFC 1901, January
  2848.         1996.
  2849.  
  2850.    [10] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Transport
  2851.         Mappings for Version 2 of the Simple Network Management Protocol
  2852.         (SNMPv2)", RFC 1906, January 1996.
  2853.  
  2854.  
  2855.  
  2856.  
  2857.  
  2858. St. Johns                      Standards                       [Page 51]
  2859.  
  2860. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2861.  
  2862.  
  2863.    [11] Case, J., Harrington D., Presuhn R. and B. Wijnen, "Message
  2864.         Processing and Dispatching for the Simple Network Management
  2865.         Protocol (SNMP)", RFC 2572, April 1999.
  2866.  
  2867.    [12] Blumenthal, U. and B. Wijnen, "User-based Security Model (USM)
  2868.         for version 3 of the Simple Network Management Protocol
  2869.         (SNMPv3)", RFC 2574, April 1999.
  2870.  
  2871.    [13] Case, J., McCloghrie, K., Rose, M. and S. Waldbusser, "Protocol
  2872.         Operations for Version 2 of the Simple Network Management
  2873.         Protocol (SNMPv2)", RFC 1905, January 1996.
  2874.  
  2875.    [14] Levi, D., Meyer, P. and B. Stewart, "SNMP Applications", RFC
  2876.         2573, April 1999.
  2877.  
  2878.    [15] Wijnen, B., Presuhn, R. and K. McCloghrie, "View-based Access
  2879.         Control Model (VACM) for the Simple Network Management Protocol
  2880.         (SNMP)", RFC 2575, April 1999.
  2881.  
  2882.    [16] "Data-Over-Cable Service Interface Specifications: Cable Modem
  2883.         Radio Frequency Interface Specification SP-RFI-I04-980724",
  2884.         DOCSIS, July 1998,
  2885.         http://www.cablemodem.com/public/pubtechspec/SP-RFI-I04-
  2886.         980724.pdf.
  2887.  
  2888.    [17] Steinberg, L., "Techniques for Managing Asynchronously Generated
  2889.         Alerts", RFC 1224, May 1991.
  2890.  
  2891.    [18] "Data-Over-Cable Service Interface Specifications: Operations
  2892.         Support System Interface Specification RF Interface SP-OSSI-RF-
  2893.         I02-980410", DOCSIS, April 1998,
  2894.         http://www.cablemodem.com/public/pubtechspec/ossi/sp-ossi.PDF.
  2895.  
  2896.    [19] Bradner, S., "Key words for use in RFCs to Indicate Requirement
  2897.         Levels", BCP 14, RFC 2119, March 1997.
  2898.  
  2899.    [20] "Data-Over-Cable Service Interface Specifications: Baseline
  2900.         Privacy Interface Specification SP-BPI-I01-970922", DOCSIS,
  2901.         September 1977,
  2902.         http://www.cablemodem.com/public/pubtechspec/ss/SP-BPI-I01-
  2903.         970922.pdf
  2904.  
  2905. 7.  Security Considerations
  2906.  
  2907.    This MIB relates to a system which will provide metropolitan public
  2908.    internet access.  As such, improper manipulation of the objects
  2909.    represented by this MIB may result in denial of service to a large
  2910.    number of end-users.  In addition, manipulation of the
  2911.  
  2912.  
  2913.  
  2914. St. Johns                      Standards                       [Page 52]
  2915.  
  2916. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2917.  
  2918.  
  2919.    docsDevNmAccessTable, docsDevFilterLLCTable, docsDevFilterIpTable and
  2920.    the elements of the docsDevCpe group may allow an end-user to
  2921.    increase their service levels, spoof their IP addresses, change the
  2922.    permitted management stations, or affect other end-users in either a
  2923.    positive or negative manner.
  2924.  
  2925.    There are a number of management objects defined in this MIB that
  2926.    have a MAX-ACCESS clause of read-write and/or read-create.  Such
  2927.    objects may be considered sensitive or vulnerable in some network
  2928.    environments.  The support for SET operations in a non-secure
  2929.    environment without proper protection can have a negative effect on
  2930.    network operations.  In addition to those mentioned above:
  2931.  
  2932.    o    The use of docsDevNmAccessTable to specify management stations
  2933.         is considered to be only limited protection and does not protect
  2934.         against attacks which spoof the management station's IP address.
  2935.         The use of stronger mechanisms such as SNMPv3 security should be
  2936.         considered where possible.  Specifically, SNMPv3 VACM and USM
  2937.         MUST be used with any v3 agent which implements this MIB.
  2938.         Administrators may also wish to consider whether even read
  2939.         access to docsDevNmAccessTable may be undesirable under certain
  2940.         circumstances.
  2941.  
  2942.    o    The CM may have its software changed by the actions of the
  2943.         management system.  An improper software load may result in
  2944.         substantial vulnerabilities and the loss of the ability of the
  2945.         management system to control the cable modem.
  2946.  
  2947.    o    The device may be reset by setting docsDevResetNow = true(1).
  2948.         This causes the device to reload its configuration files as well
  2949.         as eliminating all previous non-persistent network management
  2950.         settings. As such, this may provide a vector for attacking the
  2951.         system.
  2952.  
  2953.    o    Setting docsDevEvThrottleAdminStatus = unconstrained(1) (which
  2954.         is also the DEFVAL) may cause flooding of traps, which can
  2955.         disrupt network service.
  2956.  
  2957.    This MIB does not affect confidentiality of services on a cable modem
  2958.    system.  [20] specifies the implementation of the DOCSIS Baseline
  2959.    privacy mechanism.  The working group expects to issue a MIB for the
  2960.    management of this mechanism at a later time.
  2961.  
  2962.    SNMPv1 by itself is not a secure environment.  Even if the network
  2963.    itself is secure (for example by using IPSec), even then, there is no
  2964.    control as to who on the secure network is allowed to access and
  2965.    GET/SET (read/change/create/delete) the objects in this MIB.
  2966.  
  2967.  
  2968.  
  2969.  
  2970. St. Johns                      Standards                       [Page 53]
  2971.  
  2972. RFC 2669                DOCSIS Cable Device MIB              August 1999
  2973.  
  2974.  
  2975.    It is recommended that the implementers consider the security
  2976.    features as provided by the SNMPv3 framework.  Specifically, the use
  2977.    of the User-based Security Model [12]  and the View-based Access
  2978.    Control Model [15] is recommended.
  2979.  
  2980.    It is then a customer/user responsibility to ensure that the SNMP
  2981.    entity giving access to an instance of this MIB, is properly
  2982.    configured to give access to the objects only to those principals
  2983.    (users) that have legitimate rights to indeed GET or SET
  2984.    (change/create/delete) them.
  2985.  
  2986. 8.  Intellectual Property
  2987.  
  2988.    The IETF takes no position regarding the validity or scope of any
  2989.    intellectual property or other rights that might be claimed to
  2990.    pertain to the implementation or use of the technology described in
  2991.    this document or the extent to which any license under such rights
  2992.    might or might not be available; neither does it represent that it
  2993.    has made any effort to identify any such rights.  Information on the
  2994.    IETF's procedures with respect to rights in standards-track and
  2995.    standards-related documentation can be found in BCP-11.  Copies of
  2996.    claims of rights made available for publication and any assurances of
  2997.    licenses to be made available, or the result of an attempt made to
  2998.    obtain a general license or permission for the use of such
  2999.    proprietary rights by implementors or users of this specification can
  3000.    be obtained from the IETF Secretariat.
  3001.  
  3002.    The IETF invites any interested party to bring to its attention any
  3003.    copyrights, patents or patent applications, or other proprietary
  3004.    rights which may cover technology that may be required to practice
  3005.    this standard.  Please address the information to the IETF Executive
  3006.    Director.
  3007.  
  3008. 9.  Author's Address
  3009.  
  3010.    Michael StJohns
  3011.    @Home Network
  3012.    425 Broadway
  3013.    Redwood City, CA 94063
  3014.    U.S.A
  3015.  
  3016.    Phone: +1 650 569 5368
  3017.    EMail: stjohns@corp.home.net
  3018.  
  3019.  
  3020.  
  3021.  
  3022.  
  3023.  
  3024.  
  3025.  
  3026. St. Johns                      Standards                       [Page 54]
  3027.  
  3028. RFC 2669                DOCSIS Cable Device MIB              August 1999
  3029.  
  3030.  
  3031. 10.  Full Copyright Statement
  3032.  
  3033.    Copyright (C) The Internet Society (1999).  All Rights Reserved.
  3034.  
  3035.    This document and translations of it may be copied and furnished to
  3036.    others, and derivative works that comment on or otherwise explain it
  3037.    or assist in its implementation may be prepared, copied, published
  3038.    and distributed, in whole or in part, without restriction of any
  3039.    kind, provided that the above copyright notice and this paragraph are
  3040.    included on all such copies and derivative works.  However, this
  3041.    document itself may not be modified in any way, such as by removing
  3042.    the copyright notice or references to the Internet Society or other
  3043.    Internet organizations, except as needed for the purpose of
  3044.    developing Internet standards in which case the procedures for
  3045.    copyrights defined in the Internet Standards process must be
  3046.    followed, or as required to translate it into languages other than
  3047.    English.
  3048.  
  3049.    The limited permissions granted above are perpetual and will not be
  3050.    revoked by the Internet Society or its successors or assigns.
  3051.  
  3052.    This document and the information contained herein is provided on an
  3053.    "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
  3054.    TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
  3055.    BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
  3056.    HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
  3057.    MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
  3058.  
  3059. Acknowledgement
  3060.  
  3061.    Funding for the RFC Editor function is currently provided by the
  3062.    Internet Society.
  3063.  
  3064.  
  3065.  
  3066.  
  3067.  
  3068.  
  3069.  
  3070.  
  3071.  
  3072.  
  3073.  
  3074.  
  3075.  
  3076.  
  3077.  
  3078.  
  3079.  
  3080.  
  3081.  
  3082. St. Johns                      Standards                       [Page 55]
  3083.  
  3084.