Debian Codegraph @

rfc4639.html

raw
1 <pre>Network Working Group R. Woundy
2 Request for Comments: 4639 Comcast Cable
3 Obsoletes: <a href="./rfc2669">2669</a> K. Marez
4 Category: Standards Track Motorola
5 December 2006
6
7
8 <span class="h1">Cable Device Management Information Base for</span>
9 <span class="h1">Data-Over-Cable Service Interface Specification (DOCSIS)</span>
10 <span class="h1">Compliant Cable Modems and Cable Modem Termination Systems</span>
11
12 Status of This Memo
13
14 This document specifies an Internet standards track protocol for the
15 Internet community, and requests discussion and suggestions for
16 improvements. Please refer to the current edition of the "Internet
17 Official Protocol Standards" (STD 1) for the standardization state
18 and status of this protocol. Distribution of this memo is unlimited.
19
20 Copyright Notice
21
22 Copyright (C) The IETF Trust (2006).
23
24 Abstract
25
26 This memo defines a portion of the Management Information Base (MIB)
27 for use with network management protocols in the Internet community.
28 In particular, it defines a basic set of managed objects for Simple
29 Network Management Protocol (SNMP)-based management of Data Over
30 Cable Service Interface Specification (DOCSIS)-compliant Cable Modems
31 and Cable Modem Termination Systems.
32
33 This memo obsoletes <a href="./rfc2669">RFC 2669</a>.
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52 <span class="grey">Woundy &amp; Marez Standards Track [Page 1]</span></pre>
53 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
54 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
55
56
57 Table of Contents
58
59 <a href="#section-1">1</a>. The Internet-Standard Management Framework ......................<a href="#page-3">3</a>
60 <a href="#section-2">2</a>. Glossary ........................................................<a href="#page-3">3</a>
61 <a href="#section-2.1">2.1</a>. CATV .......................................................<a href="#page-3">3</a>
62 <a href="#section-2.2">2.2</a>. CM or Cable Modem ..........................................<a href="#page-3">3</a>
63 <a href="#section-2.3">2.3</a>. CMTS or Cable Modem Termination System .....................<a href="#page-3">3</a>
64 <a href="#section-2.4">2.4</a>. DOCSIS or Data-Over-Cable Service Interface Specification ..3
65 <a href="#section-2.5">2.5</a>. Downstream .................................................<a href="#page-4">4</a>
66 <a href="#section-2.6">2.6</a>. Head-End ...................................................<a href="#page-4">4</a>
67 <a href="#section-2.7">2.7</a>. Media Access Control (MAC) Packet ..........................<a href="#page-4">4</a>
68 <a href="#section-2.8">2.8</a>. RF .........................................................<a href="#page-4">4</a>
69 <a href="#section-2.9">2.9</a>. Simple Network Management Protocol (SNMP) ..................<a href="#page-4">4</a>
70 <a href="#section-2.10">2.10</a>. Upstream ..................................................<a href="#page-4">4</a>
71 <a href="#section-3">3</a>. Introduction ....................................................<a href="#page-4">4</a>
72 <a href="#section-3.1">3.1</a>. Structure of the MIB .......................................<a href="#page-5">5</a>
73 <a href="#section-3.1.1">3.1.1</a>. IMPORTed MIB Modules and REFERENCE Clauses ..........<a href="#page-6">6</a>
74 <a href="#section-3.1.2">3.1.2</a>. Persistence Model for Cable Modems ..................<a href="#page-6">6</a>
75 <a href="#section-3.1.3">3.1.3</a>. IPv4 Compliance .....................................<a href="#page-6">6</a>
76 <a href="#section-3.2">3.2</a>. Management Requirements ....................................<a href="#page-7">7</a>
77 <a href="#section-3.2.1">3.2.1</a>. Handling of Software Upgrades .......................<a href="#page-7">7</a>
78 <a href="#section-3.2.2">3.2.2</a>. Events and Notifications ............................<a href="#page-8">8</a>
79 <a href="#section-3.2.3">3.2.3</a>. Notification Throttling .............................<a href="#page-8">8</a>
80 <a href="#section-3.2.3.1">3.2.3.1</a>. Notification Rate Throttling ...............<a href="#page-8">8</a>
81 <a href="#section-3.2.3.2">3.2.3.2</a>. Limiting the Notification Rate .............<a href="#page-9">9</a>
82 <a href="#section-3.3">3.3</a>. Protocol Filters ...........................................<a href="#page-9">9</a>
83 <a href="#section-3.3.1">3.3.1</a>. Inbound LLC Filters: docsDevFilterLLCTable .........<a href="#page-10">10</a>
84 <a href="#section-3.3.2">3.3.2</a>. Special Filters ....................................<a href="#page-11">11</a>
85 3.3.2.1. IP Spoofing Filters:
86 docsDevCpeTable, docsDevCpeInetTable ......<a href="#page-11">11</a>
87 3.3.2.2. SNMP Access Filters:
88 docsDevNmAccessTable ......................<a href="#page-11">11</a>
89 <a href="#section-3.3.3">3.3.3</a>. IP Filtering: docsDevFilterIpTable .................<a href="#page-12">12</a>
90 <a href="#section-3.3.4">3.3.4</a>. Outbound LLC Filters ...............................<a href="#page-13">13</a>
91 <a href="#section-4">4</a>. Definitions ....................................................<a href="#page-13">13</a>
92 <a href="#section-5">5</a>. Acknowledgements ...............................................<a href="#page-78">78</a>
93 <a href="#section-5.1">5.1</a>. Revision Descriptions .....................................<a href="#page-78">78</a>
94 <a href="#section-6">6</a>. Security Considerations ........................................<a href="#page-79">79</a>
95 <a href="#section-7">7</a>. IANA Considerations ............................................<a href="#page-82">82</a>
96 <a href="#section-8">8</a>. References .....................................................<a href="#page-83">83</a>
97 <a href="#section-8.1">8.1</a>. Normative References ......................................<a href="#page-83">83</a>
98 <a href="#section-8.2">8.2</a>. Informative References ....................................<a href="#page-85">85</a>
99
100
101
102
103
104
105
106
107
108 <span class="grey">Woundy &amp; Marez Standards Track [Page 2]</span></pre>
109 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
110 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
111
112
113 <span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. The Internet-Standard Management Framework</span>
114
115 For a detailed overview of the documents that describe the current
116 Internet-Standard Management Framework, please refer to <a href="./rfc3410#section-7">section&nbsp;7 of
117 RFC 3410</a> [<a href="./rfc3410" title="&quot;Introduction and Applicability Statements for Internet-Standard Management Framework&quot;">RFC3410</a>].
118
119 Managed objects are accessed via a virtual information store, termed
120 the Management Information Base or MIB. MIB objects are generally
121 accessed through the Simple Network Management Protocol (SNMP).
122 Objects in the MIB are defined using the mechanisms defined in the
123 Structure of Management Information (SMI). This memo specifies a MIB
124 module that is compliant to the SMIv2, which is described in STD 58,
125 <a href="./rfc2578">RFC 2578</a> [<a href="./rfc2578" title="&quot;Structure of Management Information Version 2 (SMIv2)&quot;">RFC2578</a>], STD 58, <a href="./rfc2579">RFC 2579</a> [<a href="./rfc2579" title="&quot;Textual Conventions for SMIv2&quot;">RFC2579</a>] and STD 58, <a href="./rfc2580">RFC 2580</a>
126 [<a href="./rfc2580" title="&quot;Conformance Statements for SMIv2&quot;">RFC2580</a>].
127
128 <span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Glossary</span>
129
130 The terms in this document are derived either from normal cable
131 system usage, or from the documents associated with the Data-Over-
132 Cable Service Interface Specification (DOCSIS) process.
133
134 <span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. CATV</span>
135
136 Originally "Community Antenna Television", now used to refer to any
137 cable or hybrid fiber and cable system used to deliver video signals
138 to a community.
139
140 <span class="h3"><a class="selflink" id="section-2.2" href="#section-2.2">2.2</a>. CM or Cable Modem</span>
141
142 A CM acts as a "slave" station in a DOCSIS-compliant cable data
143 system.
144
145 <span class="h3"><a class="selflink" id="section-2.3" href="#section-2.3">2.3</a>. CMTS or Cable Modem Termination System</span>
146
147 A generic term covering a cable bridge or cable router in a head-end.
148 A CMTS acts as the master station in a DOCSIS-compliant cable data
149 system. It is the only station that transmits downstream, and it
150 controls the scheduling of upstream transmissions by its associated
151 CMs.
152
153 <span class="h3"><a class="selflink" id="section-2.4" href="#section-2.4">2.4</a>. DOCSIS or Data-Over-Cable Service Interface Specification</span>
154
155 A term referring to the ITU-T Recommendation J.112 [<a href="#ref-ITU-T_J.112" title="&quot;Transmission Systems for Interactive Cable Television Services, J.112, International Telecommunications Union&quot;">ITU-T_J.112</a>],
156 Annex B, standard for cable modem systems. [<a href="#ref-RFI1.0" title="&quot;Data-Over-Cable Service Interface Specifications: DOCSIS 1.0 Radio Frequency Interface Specification SCTE 22-1 2002&quot;">RFI1.0</a>] [<a href="#ref-RFI1.1" title="&quot;DOCSIS 1.1 Part 1: Radio Frequency Interface ANSI/SCTE 23-1 2005&quot;">RFI1.1</a>]
157 [<a href="#ref-RFI2.0" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFI2.0-I11-060602&quot;">RFI2.0</a>]
158
159
160
161
162
163
164 <span class="grey">Woundy &amp; Marez Standards Track [Page 3]</span></pre>
165 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
166 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
167
168
169 <span class="h3"><a class="selflink" id="section-2.5" href="#section-2.5">2.5</a>. Downstream</span>
170
171 The direction from the head-end towards the subscriber.
172
173 <span class="h3"><a class="selflink" id="section-2.6" href="#section-2.6">2.6</a>. Head-End</span>
174
175 The origination point in most cable systems of the subscriber video
176 signals. Generally, also the location of the CMTS equipment.
177
178 <span class="h3"><a class="selflink" id="section-2.7" href="#section-2.7">2.7</a>. Media Access Control (MAC) Packet</span>
179
180 A DOCSIS Packet Data Unit.
181
182 <span class="h3"><a class="selflink" id="section-2.8" href="#section-2.8">2.8</a>. RF</span>
183
184 Radio Frequency.
185
186 <span class="h3"><a class="selflink" id="section-2.9" href="#section-2.9">2.9</a>. Simple Network Management Protocol (SNMP)</span>
187
188 Protocol used for network access to Management Information Base (MIB)
189 objects. The three most commonly used versions are Version 1
190 (SNMPv1), Version 2 (SNMPv2c), and Version 3 (SNMPv3).
191
192 <span class="h3"><a class="selflink" id="section-2.10" href="#section-2.10">2.10</a>. Upstream</span>
193
194 The direction from the subscriber towards the head-end.
195
196 <span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Introduction</span>
197
198 This MIB module provides a set of objects required for the management
199 of DOCSIS-compliant Cable Modems (CM) and Cable Modem Termination
200 Systems (CMTS). The specification is derived from the DOCSIS Radio
201 Frequency Interface specification [<a href="#ref-RFI1.0" title="&quot;Data-Over-Cable Service Interface Specifications: DOCSIS 1.0 Radio Frequency Interface Specification SCTE 22-1 2002&quot;">RFI1.0</a>]. Please note that the
202 DOCSIS 1.0 standard only required that Cable Modems implement SNMPv1
203 and to process Internet Protocol Version 4 (IPv4) customer traffic.
204 Design choices in the original version of this MIB module reflected
205 those requirements. DOCSIS 1.1 [<a href="#ref-RFI1.1" title="&quot;DOCSIS 1.1 Part 1: Radio Frequency Interface ANSI/SCTE 23-1 2005&quot;">RFI1.1</a>] and DOCSIS 2.0 [<a href="#ref-RFI2.0" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFI2.0-I11-060602&quot;">RFI2.0</a>]
206 require support for SNMPv3, as well as for SNMPv1 and SNMPv2c, and
207 the changes in this MIB module over the previous proposed standard
208 version reflect those additional requirements.
209
210 Future versions of DOCSIS, starting with DOCSIS 3.0 [<a href="#ref-MULPI3.0" title="&quot;Data-Over-Cable Service Interface Specifications: DOCSIS 3.0 MAC and Upper Layer Protocols Interface Specification CM-SP-MULPIv3.0-I01- 060804&quot;">MULPI3.0</a>], are
211 expected to require support for the Internet Protocol Version 6
212 (IPv6) as both a Customer Premise Equipment (CPE) protocol and one
213 supported by the network elements of the DOCSIS CMTS/CM system.
214
215
216
217
218
219
220 <span class="grey">Woundy &amp; Marez Standards Track [Page 4]</span></pre>
221 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
222 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
223
224
225 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
226 "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
227 document are to be interpreted as described in [<a href="./rfc2119" title="&quot;Key words for use in RFCs to Indicate Requirement Levels&quot;">RFC2119</a>].
228
229 <span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. Structure of the MIB</span>
230
231 This MIB module is structured into seven components. A component
232 contains one or more MIB groups related by deprecation or logical
233 extension.
234
235 o The docsDevBaseGroup extends the MIB-II 'system' group of <a href="./rfc3418">RFC3418</a>
236 [<a href="./rfc3418" title="&quot;Management Information Base (MIB) for the Simple Network Management Protocol (SNMP)&quot;">RFC3418</a>] with objects needed for cable device system management.
237 Related to this group is the docsDevBaseIgmpGroup (enabling
238 Internet Group Management Protocol (IGMP) status and control) and
239 the docsDevBaseMaxCpeGroup (managing the maximum number of CPEs
240 permitted access through the cable modem).
241
242 o The docsDevNmAccessGroup and the docsDevNmAccessExtGroup provide a
243 minimum level of SNMP access security (see Section 2.7 of
244 [<a href="#ref-OSSI1.0" title="&quot;Data-Over-Cable Service Interface Specification: DOCSIS 1.0 Operations Support System Interface (OSSI), SCTE 22-3 2002&quot;">OSSI1.0</a>], Section 2 of [<a href="#ref-OSSI1.1" title="&quot;DOCSIS 1.1 Part 3: Operations Support System Interface ANSI/SCTE 23-3 2005&quot;">OSSI1.1</a>], and <a href="#section-5">Section 5</a> of [<a href="#ref-OSSI2.0" title="&quot;Data-Over-Cable Service Interface Specifications: Operations Support System Interface Specification SP-OSSIv2.0-I09-050812&quot;">OSSI2.0</a>]).
245 With the completion of the SNMP coexistence document, <a href="./rfc3584">RFC 3584</a>
246 [<a href="./rfc3584" title="&quot;Coexistence between Version 1, Version 2, and Version 3 of the Internet-standard Network Management Framework&quot;">RFC3584</a>], these groups have been deprecated in this version of
247 the MIB.
248
249 o The docsDevSoftwareGroup, updated by the docsDevSoftwareGroupV2,
250 provides information for network-downloadable software upgrades.
251 See "Handling of Software Upgrades", below.
252
253 o The docsDevServerGroup, updated by the docsDevServerGroupV2,
254 provides information about the progress of the interaction between
255 the CM or CMTS and various provisioning servers.
256
257 o The docsDevEventGroup, updated by the docsDevEventGroupV2,
258 provides control and logging for event reporting. With the
259 addition of the SNMP Notification MIB, <a href="./rfc3413">RFC 3413</a> [<a href="./rfc3413" title="&quot;Simple Network Management Protocol (SNMP) Applications&quot;">RFC3413</a>], and
260 Notification Log MIB, <a href="./rfc3014">RFC 3014</a> [<a href="./rfc3014" title="&quot;Notification Log MIB&quot;">RFC3014</a>], which cover event
261 reporting, the objects in this MIB module have been modified to
262 allow for the usage of these RFCs.
263
264 o The docsDevFilterGroup configures filters at the link layer and IP
265 layer for bridged data traffic. This group has been deprecated in
266 this version of the MIB in favor of the docsDevFilterLLCGroup, and
267 by groups from the Differentiated Services MIB [<a href="./rfc3289" title="&quot;Management Information Base for the Differentiated Services Architecture&quot;">RFC3289</a>] --
268 specifically, the groups representing the Data Path, Classifier,
269 and Actions tables from that MIB.
270
271
272
273
274
275
276 <span class="grey">Woundy &amp; Marez Standards Track [Page 5]</span></pre>
277 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
278 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
279
280
281 o The docsDevCpeGroup, updated by the docsDevInetCpeGroup, provides
282 control over which IP addresses may be used by CPEs (e.g., PCs)
283 serviced by a given cable modem. This provides anti-spoofing
284 control at the point of origin for a large cable modem system.
285 This group is separate from docsDevFilter, primarily as this group
286 is only implemented on the Cable Modem (CM) and MUST NOT be
287 implemented on the Cable Modem Termination System (CMTS).
288
289 <span class="h4"><a class="selflink" id="section-3.1.1" href="#section-3.1.1">3.1.1</a>. IMPORTed MIB Modules and REFERENCE Clauses</span>
290
291 This MIB module IMPORTs definitions normatively from the following
292 MIB modules, beyond [<a href="./rfc2578" title="&quot;Structure of Management Information Version 2 (SMIv2)&quot;">RFC2578</a>], [<a href="./rfc2579" title="&quot;Textual Conventions for SMIv2&quot;">RFC2579</a>], and [<a href="./rfc2580" title="&quot;Conformance Statements for SMIv2&quot;">RFC2580</a>]: INET-
293 ADDRESS-MIB [<a href="./rfc4001" title="&quot;Textual Conventions for Internet Network Addresses&quot;">RFC4001</a>], SNMP-FRAMEWORK-MIB [<a href="./rfc3411" title="&quot;An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks&quot;">RFC3411</a>], IF-MIB
294 [<a href="./rfc2863" title="&quot;The Interfaces Group MIB&quot;">RFC2863</a>], RMON2-MIB [<a href="./rfc4502" title="&quot;Remote Network Monitoring Management Information Base Version 2&quot;">RFC4502</a>], and DIFFSERV-MIB [<a href="./rfc3289" title="&quot;Management Information Base for the Differentiated Services Architecture&quot;">RFC3289</a>].
295
296 This MIB module also includes DESCRIPTION and REFERENCE clauses that
297 normatively refer to [<a href="./rfc868" title="&quot;Time Protocol&quot;">RFC868</a>], [<a href="./rfc3617" title="&quot;Uniform Resource Identifier (URI) Scheme and Applicbility Statement for the Trivial File Transfer Protocol (TFTP)&quot;">RFC3617</a>], [<a href="#ref-RFI1.0" title="&quot;Data-Over-Cable Service Interface Specifications: DOCSIS 1.0 Radio Frequency Interface Specification SCTE 22-1 2002&quot;">RFI1.0</a>], [<a href="#ref-RFI1.1" title="&quot;DOCSIS 1.1 Part 1: Radio Frequency Interface ANSI/SCTE 23-1 2005&quot;">RFI1.1</a>],
298 [<a href="#ref-RFI2.0" title="&quot;Data-Over-Cable Service Interface Specifications: Radio Frequency Interface Specification SP-RFI2.0-I11-060602&quot;">RFI2.0</a>], [<a href="#ref-OSSI1.1" title="&quot;DOCSIS 1.1 Part 3: Operations Support System Interface ANSI/SCTE 23-3 2005&quot;">OSSI1.1</a>], and [<a href="#ref-OSSI2.0" title="&quot;Data-Over-Cable Service Interface Specifications: Operations Support System Interface Specification SP-OSSIv2.0-I09-050812&quot;">OSSI2.0</a>].
299
300 <span class="h4"><a class="selflink" id="section-3.1.2" href="#section-3.1.2">3.1.2</a>. Persistence Model for Cable Modems</span>
301
302 Most of the tables in this MIB module (e.g., docsDevNmAccessTable,
303 docsDevFilterLLCTable) are specified not to let objects persist
304 across reboots.
305
306 The expectation (and current operational practice) is that upon
307 reboot, these tables are cleared and repopulated from the DOCSIS
308 configuration file supplied by the cable operator. This approach
309 enables a cable modem to adapt to the current cable operator's
310 environment, which in turn enables cable modem portability across
311 different cable operators.
312
313 A notable exception to the persistence model is docsDevEventTable,
314 since it is useful to maintain a record of events across reboots for
315 debugging purposes.
316
317 <span class="h4"><a class="selflink" id="section-3.1.3" href="#section-3.1.3">3.1.3</a>. IPv4 Compliance</span>
318
319 Please note that the compliance statements in this version of the MIB
320 module require support only for IPv4 addresses. That is because the
321 current versions of the DOCSIS protocols (1.0, 1.1, and 2.0) are not
322 IPv6 capable. Although support for IPv6 will require changes to the
323 DOCSIS protocols, it is expected that the only changes needed to the
324 MIB module itself will be the addition of new compliance statements
325 that mandate support for IPv6 addresses.
326
327
328
329
330
331
332 <span class="grey">Woundy &amp; Marez Standards Track [Page 6]</span></pre>
333 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
334 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
335
336
337 <span class="h3"><a class="selflink" id="section-3.2" href="#section-3.2">3.2</a>. Management Requirements</span>
338
339 <span class="h4"><a class="selflink" id="section-3.2.1" href="#section-3.2.1">3.2.1</a>. Handling of Software Upgrades</span>
340
341 The Cable Modem software upgrade process is documented in [<a href="#ref-RFI1.0" title="&quot;Data-Over-Cable Service Interface Specifications: DOCSIS 1.0 Radio Frequency Interface Specification SCTE 22-1 2002&quot;">RFI1.0</a>].
342 From a network management station, the operator
343
344 o sets docsDevSwServer to the address of the Trivial File Transfer
345 Protocol (TFTP) server for software upgrades;
346
347 o sets docsDevSwFilename to the file pathname of the software
348 upgrade image; and
349
350 o sets docsDevSwAdminStatus to upgrade-from-mgt.
351
352 Although DOCSIS only specifies the implementation of the TFTP
353 protocol [<a href="./rfc1350" title="&quot;The TFTP Protocol (Revision 2)&quot;">RFC1350</a>] for file transfers, other functional entities
354 embedded within the cable device (particularly a PacketCable
355 Multimedia Terminal Adapter [<a href="#ref-MTA-PROV" title="&quot;PacketCable(TM) 1.5 Specification: MTA Device Provisioning PKT-SP-PROV1.5-I02-050812&quot;">MTA-PROV</a>]) specify the optional
356 implementation of the Hyper Text Transfer Protocol (HTTP) [<a href="./rfc1945" title="&quot;Hypertext Traner Protocol -- HTTP/1.0&quot;">RFC1945</a>]
357 and [<a href="./rfc2616" title="&quot;Hypertext Transfer Protocol -- HTTP/1.1&quot;">RFC2616</a>] for file transfers. The value of the
358 docsDevSwServerTransportProtocol object determines which protocol is
359 used for SNMP-initiated software upgrade.
360
361 One reason for the SNMP-initiated upgrade is to allow loading of a
362 temporary software image (e.g., special diagnostic software) that
363 differs from the software normally used on that device without
364 changing the provisioning database.
365
366 Note that software upgrades should not be accepted blindly by the
367 cable device. The cable device may refuse an upgrade if
368
369 o the download is incomplete;
370
371 o the file contents are incomplete or damaged; or
372
373 o the software is not intended for that hardware device (this may
374 include the case of a feature set that has not been purchased for
375 this device).
376
377 A cable device that implements the code verification mechanisms of
378 [<a href="#ref-BPIPLUS" title="&quot;Data-Over-Cable Service Interface Specifications: Baseline Privacy Plus Interface Specification CM-SP-BPI+_I12-050812&quot;">BPIPLUS</a>] verifies the source and integrity of the downloaded image
379 by validating one or more Code Verification Signatures that are
380 bundled within the software upgrade.
381
382
383
384
385
386
387
388 <span class="grey">Woundy &amp; Marez Standards Track [Page 7]</span></pre>
389 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
390 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
391
392
393 <span class="h4"><a class="selflink" id="section-3.2.2" href="#section-3.2.2">3.2.2</a>. Events and Notifications</span>
394
395 This MIB module provides control facilities for reporting events
396 through syslog [<a href="./rfc3164" title="&quot;The BSD Syslog Protocol&quot;">RFC3164</a>], notifications (traps and informs), and
397 non-volatile logging. Additional controls allow the agent to use the
398 SNMP Notification MIB [<a href="./rfc3413" title="&quot;Simple Network Management Protocol (SNMP) Applications&quot;">RFC3413</a>] and Notification Log MIB [<a href="./rfc3014" title="&quot;Notification Log MIB&quot;">RFC3014</a>]
399 for event notification.
400
401 The conventions for event reporting are outside the scope of this
402 document. The definition and coding of common DOCSIS notifications
403 can be found in [<a href="./rfc4547" title="&quot;Event Notification Management Information Base for Data over Cable Service Interface Specifications (DOCSIS) Compliant Cable Modems and Cable Modem Termination Systems&quot;">RFC4547</a>].
404
405 <span class="h4"><a class="selflink" id="section-3.2.3" href="#section-3.2.3">3.2.3</a>. Notification Throttling</span>
406
407 The CM and CMTS MUST provide support for notification message
408 throttling as described below. The network operator can employ
409 notification rate throttling or notification limiting by manipulating
410 the appropriate MIB variables.
411
412 <span class="h5"><a class="selflink" id="section-3.2.3.1" href="#section-3.2.3.1">3.2.3.1</a>. Notification Rate Throttling</span>
413
414 Network operators may employ either of two rate control methods. In
415 the first method, the device ceases to send notifications when the
416 rate exceeds the specified maximum message rate. It resumes sending
417 notifications only if reactivated by a network management station
418 request.
419
420 In the second method, the device resumes sending notifications when
421 the rate falls below the specified maximum message rate.
422
423 The network operator configures the specified maximum message rate by
424 setting the measurement interval (in seconds), and the maximum number
425 of notifications to be transmitted within the measurement interval.
426 The operator can query the operational throttling state (to determine
427 whether notifications are enabled or blocked by throttling) of the
428 device, as well as query and set the administrative throttling state
429 (to manage the rate control method) of the device.
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444 <span class="grey">Woundy &amp; Marez Standards Track [Page 8]</span></pre>
445 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
446 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
447
448
449 <span class="h5"><a class="selflink" id="section-3.2.3.2" href="#section-3.2.3.2">3.2.3.2</a>. Limiting the Notification Rate</span>
450
451 Network operators may wish to limit the number of notifications sent
452 by a device over a specified time period. The device ceases to send
453 notifications when the number of notifications exceeds the specified
454 threshold. It resumes sending notifications only when the
455 measurement interval has passed.
456
457 The network operator defines the maximum number of notifications he
458 is willing to handle and sets the measurement interval to a large
459 number (in hundredths of a second). For this case, the
460 administrative throttling state is set to stop at a threshold that is
461 the maximum number of notifications.
462
463 See "Techniques for Managing Asynchronously Generated Alerts"
464 [<a href="./rfc1224" title="&quot;Techniques for managing asynchronously generated alerts&quot;">RFC1224</a>] for additional technical motivations.
465
466 <span class="h3"><a class="selflink" id="section-3.3" href="#section-3.3">3.3</a>. Protocol Filters</span>
467
468 The Cable Device MIB provides objects for both Link Layer Control
469 (LLC) and IP protocol filters. The LLC protocol filter entries can
470 be used to limit CM forwarding to a restricted set of network-layer
471 protocols (such as IP, Internetwork Packet Exchange (IPX), Network
472 Basic Input/Output System (NetBIOS), and Appletalk).
473
474 The IP protocol filter entries can be used to restrict upstream or
475 downstream traffic according to source and destination IP addresses,
476 transport-layer protocols (such as Transport Control Protocol (TCP),
477 User Datagram Protocol (UDP), and Internet Control Message Protocol
478 (ICMP)), and source and destination TCP/UDP port numbers.
479
480 In general, a cable modem applies filters (or, more properly,
481 classifiers) in an order appropriate to the layering model.
482 Specifically, the inbound MAC (or LLC) layer filters are applied
483 first, then the "special" filters, then the IP layer inbound filters,
484 then the IP layer outbound filters, and then any final LLC outbound
485 filters.
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500 <span class="grey">Woundy &amp; Marez Standards Track [Page 9]</span></pre>
501 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
502 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
503
504
505 *****************
506 * LLC Filter In *
507 *****************
508 |
509 v
510 *******************
511 * Special Filters *
512 * | *
513 * V *
514 * ************ *
515 * * IP Spoof * *
516 * ************ *
517 * | *
518 * v *
519 * *************** *
520 * * SNMP Access * *
521 * *************** *
522 * | *
523 *******************
524 |
525 v
526 ****************
527 * IP Filter In *
528 ****************
529 |
530 v
531 *****************
532 * IP Filter Out *
533 *****************
534 |
535 v
536 ******************
537 * LLC Filter Out *
538 ******************
539
540 <span class="h4"><a class="selflink" id="section-3.3.1" href="#section-3.3.1">3.3.1</a>. Inbound LLC Filters: docsDevFilterLLCTable</span>
541
542 The inbound LLC (or MAC or level-2) filters are contained in the
543 docsDevFilterLLCTable and are applied to level-2 frames entering the
544 cable modem from either the RF MAC interface or from one of the CPE
545 interfaces (physical or logical). These filters are used to prohibit
546 the processing and forwarding of certain types of level-2 traffic
547 that may be disruptive to the network. The filters, as currently
548 specified, can be set to cause the modem either to drop frames that
549 match at least one filter, or to process a frame that matches at
550 least one filter. Some examples of possible configurations would be
551 to permit only IP (and ARP) traffic, or to drop NetBIOS traffic.
552
553
554
555
556 <span class="grey">Woundy &amp; Marez Standards Track [Page 10]</span></pre>
557 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
558 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
559
560
561 <span class="h4"><a class="selflink" id="section-3.3.2" href="#section-3.3.2">3.3.2</a>. Special Filters</span>
562
563 Special filters are applied after the packet is accepted from the MAC
564 layer by the IP module, but before any other processing is done.
565 They are filters that apply only to a very specific class of traffic.
566
567 <span class="h5"><a class="selflink" id="section-3.3.2.1" href="#section-3.3.2.1">3.3.2.1</a>. IP Spoofing Filters: docsDevCpeTable, docsDevCpeInetTable</span>
568
569 IP spoofing filters are applied to packets entering the modem from
570 one of the CPE interfaces and are intended to prevent a subscriber
571 from stealing or misusing IP addresses that were not assigned to the
572 subscriber. If the filters are active (enabled), the source address
573 of the IP packet must match at least one IP address in one of these
574 two tables (docsDevCpeTable or docsDevCpeInetTable), or it is
575 discarded without further processing.
576
577 To prevent potential implementation ambiguity, the device consults
578 the docsDevCpeTable for the IP packet source address before
579 consulting the docsDevCpeInetTable.
580
581 The table can be automatically populated where the first N different
582 IP addresses seen from the CPE side of the cable modem are used to
583 populate the table automatically. The spoofing filters are specified
584 in the docsDevCpeTable and the docsDevCpeInetTable, and the policy
585 for automatically creating filters in those tables is controlled by
586 docsDevCpeEnroll and docsDevMaxCpe, as well as by the network
587 management agent.
588
589 Similar IP spoofing filter controls are defined for CMTS
590 implementation in the Subscriber Management MIB [<a href="./rfc4036" title="&quot;Management Information Base for Data Over Cable Service Interface Specification (DOCSIS) Cable Modem Termination Systems for Subscriber Management&quot;">RFC4036</a>].
591
592 <span class="h5"><a class="selflink" id="section-3.3.2.2" href="#section-3.3.2.2">3.3.2.2</a>. SNMP Access Filters: docsDevNmAccessTable</span>
593
594 The SNMP access filters are applied to SNMP packets entering from any
595 interface and destined for the cable modem. If the packets enter
596 from a CPE interface, the SNMP filters are applied after the IP
597 spoofing filters. The filters only apply to SNMPv1 or SNMPv2c
598 traffic and are not consulted for SNMPv3 traffic (and need not be
599 implemented by a v3-only agent). SNMPv3 access control is specified
600 in the User Security Model MIB, in [<a href="./rfc3414" title="&quot;User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)&quot;">RFC3414</a>].
601
602 With the completion of the SNMP coexistence document, <a href="./rfc3584">RFC 3584</a>
603 [<a href="./rfc3584" title="&quot;Coexistence between Version 1, Version 2, and Version 3 of the Internet-standard Network Management Framework&quot;">RFC3584</a>], docsDevNmAccess table has been deprecated in this version
604 of the MIB. See the body of the MIB for the description of how
605 agents should handle the interaction between <a href="./rfc3584">RFC 3584</a> MIBs and this
606 MIB.
607
608
609
610
611
612 <span class="grey">Woundy &amp; Marez Standards Track [Page 11]</span></pre>
613 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
614 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
615
616
617 <span class="h4"><a class="selflink" id="section-3.3.3" href="#section-3.3.3">3.3.3</a>. IP Filtering: docsDevFilterIpTable</span>
618
619 The IP Filtering table acts as a classifier table. Each row in the
620 table describes a template against which IP packets are compared.
621 The template includes source and destination addresses (and their
622 associated masks), upper level protocol (e.g., TCP, UDP), source and
623 destination port ranges, and Terms of Service (ToS) values. A row
624 also contains interface and traffic direction match values that have
625 to be considered in combination. All columns of a particular row
626 must match the appropriate fields in the packet and must match the
627 interface and direction items for the packet to result in a match to
628 the packet.
629
630 When classifying a packet, each table is scanned, beginning with the
631 lowest number filter. If the agent finds a match, it applies the
632 group of policies specified. If the matched filter has the continue
633 bit set, the agent continues the scan possibly matching additional
634 filters and applying additional policies. For example, this allows
635 the agent to take one set of actions for the 24.0.16/255.255.255.0
636 group and one set of actions for telnet packets to/from 24.0.16.30,
637 and these sets of actions may not be mutually exclusive.
638
639 Once a packet is matched, one of three actions happen according to
640 the setting of docsDevFilterIpControl in the row. The packet may be
641 dropped, in which case no further processing is required. The packet
642 may be accepted, and processing of the packet continues. Lastly, the
643 packet may have a set of policy actions applied to it. If
644 docsDevFilterIpContinue is set to true, scanning of the table
645 continues and additional matches may result.
646
647 When a packet matches and docsDevFilterIpControl in the filter
648 matched is set to 'policy', the value of docsDevFilterIpPolicyId is
649 used as a selector into the docsDevFilterPolicyTable. The first
650 level of indirection may result in zero or more actions being taken
651 according to the match. The docsDevFilterPolicyTable is scanned in
652 row order, and all rows where docsDevFilterPolicyId equals
653 docsDevFilterIpPolicyId have the action specified by the
654 docsDevFilterPolicyValue 'executed'.
655
656 For an example of the use of these IP Filtering MIB tables, see
657 [<a href="./rfc2669" title="&quot;DOCSIS Cable Device MIB Cable Device Management Information Base for DOCSIS compliant Cable Modems and Cable Modem Termination Systems&quot;">RFC2669</a>].
658
659 The IP Filtering table and related tables have been deprecated in
660 this version of the MIB in favor of the Data Path, Classifier, and
661 Action tables from the Differentiated Services MIB [<a href="./rfc3289" title="&quot;Management Information Base for the Differentiated Services Architecture&quot;">RFC3289</a>]. See
662 the body of the MIB for the description of how agents should handle
663 the interaction between <a href="./rfc3289">RFC 3289</a> MIBs and this MIB module.
664
665
666
667
668 <span class="grey">Woundy &amp; Marez Standards Track [Page 12]</span></pre>
669 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
670 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
671
672
673 <span class="h4"><a class="selflink" id="section-3.3.4" href="#section-3.3.4">3.3.4</a>. Outbound LLC Filters</span>
674
675 Lastly, any outbound LLC filters are applied to the packet just prior
676 to its being emitted on the appropriate interface. This MIB module
677 does not specify any outbound LLC filters, but <a href="#section-3">section 3</a> of the
678 DOCSIS Quality of Service (QoS) MIB, [<a href="./rfc4323" title="&quot;Data Over Cable System Interface Specification Quality of Service Management Information Base (DOCSIS-QoS MIB)&quot;">RFC4323</a>], includes outbound LLC
679 filtering requirements.
680
681 <span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Definitions</span>
682
683 DOCS-CABLE-DEVICE-MIB DEFINITIONS ::= BEGIN
684
685 IMPORTS
686 MODULE-IDENTITY,
687 OBJECT-TYPE,
688 IpAddress,
689 Unsigned32,
690 Counter32,
691 Integer32,
692 zeroDotZero,
693 mib-2
694 FROM SNMPv2-SMI -- <a href="./rfc2578">RFC 2578</a>
695 RowStatus,
696 RowPointer,
697 DateAndTime,
698 TruthValue,
699 StorageType
700 FROM SNMPv2-TC -- <a href="./rfc2579">RFC 2579</a>
701 InetAddressType,
702 InetAddress
703 FROM INET-ADDRESS-MIB -- <a href="./rfc4001">RFC 4001</a>
704 OBJECT-GROUP,
705 MODULE-COMPLIANCE
706 FROM SNMPv2-CONF -- <a href="./rfc2580">RFC 2580</a>
707 SnmpAdminString
708 FROM SNMP-FRAMEWORK-MIB -- <a href="./rfc3411">RFC 3411</a>
709 InterfaceIndexOrZero
710 FROM IF-MIB -- <a href="./rfc2863">RFC 2863</a>
711 ZeroBasedCounter32
712 FROM RMON2-MIB -- <a href="./rfc4502">RFC 4502</a>
713 diffServMIBDataPathGroup,
714 diffServMIBClfrGroup,
715 diffServMIBClfrElementGroup,
716 diffServMIBMultiFieldClfrGroup,
717 diffServMIBActionGroup,
718 diffServMIBDscpMarkActGroup,
719 diffServMIBCounterGroup,
720 diffServMIBAlgDropGroup,
721
722
723
724 <span class="grey">Woundy &amp; Marez Standards Track [Page 13]</span></pre>
725 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
726 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
727
728
729 diffServDataPathStatus,
730 diffServClfrStatus,
731 diffServClfrElementStatus,
732 diffServMultiFieldClfrAddrType,
733 diffServMultiFieldClfrSrcAddr,
734 diffServMultiFieldClfrDstAddr,
735 diffServAlgDropStatus,
736 diffServDataPathStorage,
737 diffServClfrStorage,
738 diffServClfrElementStorage,
739 diffServMultiFieldClfrStorage,
740 diffServActionStorage,
741 diffServCountActStorage,
742 diffServAlgDropStorage,
743 diffServAlgDropType
744 FROM DIFFSERV-MIB; -- <a href="./rfc3289">RFC 3289</a>
745
746
747 docsDev MODULE-IDENTITY
748 LAST-UPDATED "200612200000Z" -- December 20, 2006
749 ORGANIZATION "IETF IP over Cable Data Network
750 Working Group"
751 CONTACT-INFO
752 " Rich Woundy
753 Postal: Comcast Cable
754 27 Industrial Avenue
755 Chelmsford, MA 01824 U.S.A.
756 Phone: +1 978 244 4010
757 E-mail: [email protected]
758
759 Kevin Marez
760 Postal: Motorola Corporation
761 6450 Sequence Drive
762 San Diego, CA 92121 U.S.A.
763 Phone: +1 858 404 3785
764 E-mail: [email protected]
765
766 IETF IPCDN Working Group
767 General Discussion: [email protected]
768 Subscribe: <a href="http://www.ietf.org/mailman/listinfo/ipcdn">http://www.ietf.org/mailman/listinfo/ipcdn</a>
769 Archive: <a href="ftp://ftp.ietf.org/ietf-mail-archive/ipcdn">ftp://ftp.ietf.org/ietf-mail-archive/ipcdn</a>
770 Co-chairs: Richard Woundy,
771 [email protected]
772 Jean-Francois Mule,
773 [email protected]"
774
775 DESCRIPTION
776 "This is the MIB Module for DOCSIS-compliant cable modems
777
778
779
780 <span class="grey">Woundy &amp; Marez Standards Track [Page 14]</span></pre>
781 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
782 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
783
784
785 and cable-modem termination systems.
786
787 Copyright (C) The IETF Trust (2006). This version
788 of this MIB module was published in <a href="./rfc4639">RFC 4639</a>; for full
789 legal notices see the RFC itself."
790
791 REVISION "200612200000Z" -- December 20, 2006
792 DESCRIPTION
793 "Second version, published as <a href="./rfc4639">RFC 4639</a>.
794
795 Modifications to this MIB module since <a href="./rfc2669">RFC 2669</a> include:
796 - Deprecation of the docsDevFilter group in favor of the
797 DiffServ MIB groups, to enable support for IPv6
798 filtering and DiffServ Code Point (DSCP) marking.
799 - Deprecation of the docsDevCpeGroup in favor of the
800 docsDevCpeInetGroup, to enable support of IPv6.
801 - Addition of various InetAddress objects to enable
802 support of IPv6.
803 - Deprecation of docsDevNmAccessTable in favor of SNMP
804 Coexistence and SNMPv3 -- yet adding
805 docsDevNmAccessTrapVersion and clarifying
806 docsDevNmAccessIp for current use of this table,
807 - Addition of docsDevIgmpModeControl for management and
808 control of the IGMP mode of operation,
809 - Addition of docsDevMaxCpe for management of the
810 maxmium number of CPEs permitted access through a
811 cable modem,
812 - Addition of docsDevSwServerTransportProtocol, and
813 modifications to docsDevSoftware object DESCRIPTIONS,
814 to enable software downloads via either TFTP or HTTP,
815 - Replacement of docsDevEvThrottleInhibited with
816 docsDevEvThrottleThresholdExceeded to simplify
817 event threshold management,
818 - Modification of docsDevEvReporting to enable local
819 logging to the internal volatile log, and not to the
820 internal non-volatile log,
821 - Modification of the compliance statement to make the
822 docsDevCpe objects optional
823 - Created placeholders for two OIDs in the
824 docsDevFilterPolicyTable that were never used
825 - Modified the DESCRIPTION of
826 docsDevSwServerTransportProtocol and
827 docsDevSwServerAddressType to address the
828 dependence between each object
829 - Added a reference to docsDevServerConfigTftpAddress
830 - Clarified the scope of notifications that are covered
831 by docsDevEvThrottleThreshold
832 - Clarified an error condition that could occur when
833
834
835
836 <span class="grey">Woundy &amp; Marez Standards Track [Page 15]</span></pre>
837 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
838 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
839
840
841 doing a SET to docsDevEvReporting
842 - Defined each of the enumerated types for both
843 docsDevEvLevel and docsDevEvPriority
844 - Added UNITS clause to docsDevFilterLLCMatches,
845 docsDevFilterIpMatches, docsDevMaxCpe,
846 docsDevEvThrottleThreshold and docsDevEvCounts.
847 - Added REFERENCE clause to docsDevFilterIpProtocol
848 - Modified DESCRIPTION of docsDevCpeInetAddr to be
849 more protocol-neutral
850 - Removed the enumerated value (1) from both
851 docsDevCpeInetSource and docsDevCpeSource
852 - Covered additional read-write and read-create objects
853 in the Security Considerations section
854 - Modified the default value of docsDevNmAccessIpMask
855 to be consistent with OSSI specification
856 - Modified the SYNTAX of docsDevNmAccessCommunity and
857 docsDevNmAccessInterfaces in the Conformance
858 Statement section
859 - Added SYNTAX clause to docsDevEvReporting in the
860 Conformance Statement section
861 - Modified SYNTAX clause of docsDevEvReporting to
862 move new enumerated type to byte boundary
863 - Added references to DOCSIS 2.0 specifications to
864 multiple objects
865 - Clarified non-persistency across reboots for
866 all tables
867 - Clarified functionality of docsDevSw objects as
868 they relate to docsDevSwOperStatus
869 - Clarified enumerated types (9) and (10) for
870 docsDevServerBootState
871 - Defined the state of unknown(0) for the following
872 objects: docsDevServerDhcpAddressType,
873 docsDevServerTimeAddressType,
874 docsDevServerConfigTftpAddressType and
875 docsDevServerConfigTftpAddressType
876 - Modified the value in docsDevFilterIpDaddr to be
877 consistent with the SYNTAX
878 - Specified which rows could be modified in an
879 active row for docsDevFilterPolicyStatus
880 - Defined the term 'manually' in docsDevCpeEnroll
881 - Clarified the description for
882 docsDevFilterTosOrMask
883 - Covered the case of a non-existent row for
884 docsDevFilterPolicyPtr
885 - Added DEFVAL clauses for multiple objects
886 - Replaced docsDevNotification OBJECT IDENTIFIER
887 with docsDevNotifications to address possible
888 compatibility issues
889
890
891
892 <span class="grey">Woundy &amp; Marez Standards Track [Page 16]</span></pre>
893 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
894 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
895
896
897 - Added support for the usage of <a href="./rfc3413">RFC 3413</a> and <a href="./rfc3014">RFC 3014</a>
898 as event notification mechanisms
899 - Removed docsDevFilterPolicyObsoleteGroup
900 - Added stdInterface(9) type to docsDevEvReporting to
901 support the usage of <a href="./rfc3413">RFC3413</a> and <a href="./rfc3014">RFC3014</a>
902 - Modified DESCRIPTION for docsDevMaxCpe"
903
904 REVISION "199908190000Z"
905 DESCRIPTION
906 "Initial version, published as <a href="./rfc2669">RFC 2669</a>."
907
908 ::= { mib-2 69 }
909
910 docsDevMIBObjects OBJECT IDENTIFIER ::= { docsDev 1 }
911
912 docsDevBase OBJECT IDENTIFIER ::= { docsDevMIBObjects 1 }
913
914 --
915 -- For the following object, there is no concept in the
916 -- RFI specification corresponding to a backup CMTS. The
917 -- enumeration is provided here in case someone is able
918 -- to define such a role or device.
919 --
920
921 docsDevRole OBJECT-TYPE
922 SYNTAX INTEGER {
923 cm(1),
924 cmtsActive(2),
925 cmtsBackup(3)
926 }
927 MAX-ACCESS read-only
928 STATUS current
929 DESCRIPTION
930 "Defines the current role of this device. cm(1) is a
931 Cable Modem, cmtsActive(2) is a Cable Modem Termination
932 System that is controlling the system of cable modems,
933 and cmtsBackup(3) is a CMTS that is currently connected
934 but is not controlling the system (not currently used).
935
936 In general, if this device is a 'cm', its role will not
937 change during operation or between reboots. If the
938 device is a 'cmts' it may change between cmtsActive and
939 cmtsBackup and back again during normal operation. NB:
940 At this time, the DOCSIS standards do not support the
941 concept of a backup CMTS, but cmtsBackup is included for
942 completeness."
943 ::= { docsDevBase 1 }
944
945
946
947
948 <span class="grey">Woundy &amp; Marez Standards Track [Page 17]</span></pre>
949 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
950 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
951
952
953 docsDevDateTime OBJECT-TYPE
954 SYNTAX DateAndTime
955 MAX-ACCESS read-write
956 STATUS current
957 DESCRIPTION
958 "The current date and time, with time zone information
959 (if known).
960
961 If the real data and time cannot be determined, this
962 shall represent elapsed time from boot relative to
963 the standard epoch '1970-1-1,0:0:0.0'. In other
964 words, if this agent has been up for 3 minutes and
965 not been able to determine what the actual date and
966 time are, this object will return the value
967 '1970-1-1,0:03:0.0'."
968 ::= { docsDevBase 2 }
969
970 docsDevResetNow OBJECT-TYPE
971 SYNTAX TruthValue
972 MAX-ACCESS read-write
973 STATUS current
974 DESCRIPTION
975 "Setting this object to true(1) causes the device to
976 reset. Reading this object always returns false(2)."
977 ::= { docsDevBase 3 }
978
979 docsDevSerialNumber OBJECT-TYPE
980 SYNTAX SnmpAdminString
981 MAX-ACCESS read-only
982 STATUS current
983 DESCRIPTION
984 "The manufacturer's serial number for this device."
985 ::= { docsDevBase 4 }
986
987 docsDevSTPControl OBJECT-TYPE
988 SYNTAX INTEGER {
989 stEnabled(1),
990 noStFilterBpdu(2),
991 noStPassBpdu(3)
992 }
993 MAX-ACCESS read-write
994 STATUS current
995 DESCRIPTION
996 "This object controls operation of the spanning tree
997 protocol (as distinguished from transparent bridging).
998
999 If set to stEnabled(1), then the spanning tree protocol
1000 is enabled, subject to bridging constraints.
1001
1002
1003
1004 <span class="grey">Woundy &amp; Marez Standards Track [Page 18]</span></pre>
1005 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
1006 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1007
1008
1009 If noStFilterBpdu(2), then spanning tree is not active,
1010 and Bridge PDUs received are discarded.
1011
1012 If noStPassBpdu(3), then spanning tree is not active,
1013 and Bridge PDUs are transparently forwarded.
1014
1015 Note that a device need not implement all of these
1016 options, but that noStFilterBpdu(2) is required."
1017 DEFVAL { noStFilterBpdu }
1018 ::= { docsDevBase 5 }
1019
1020 docsDevIgmpModeControl OBJECT-TYPE
1021 SYNTAX INTEGER {
1022 passive(1),
1023 active(2)
1024 }
1025 MAX-ACCESS read-write
1026 STATUS current
1027 DESCRIPTION
1028 "This object controls the IGMP mode of operation for
1029 the CM or CMTS. In passive mode, the device forwards
1030 IGMP between interfaces as based on knowledge of
1031 Multicast Session activity on the subscriber side
1032 interface and the rules defined in the DOCSIS RFI
1033 specification. In active mode, the device terminates
1034 at and initiates IGMP through its interfaces as based
1035 on the knowledge of Multicast Session activity on the
1036 subscriber side interface."
1037 REFERENCE
1038 "DOCSIS RFI 1.1 Specification, <a href="#section-3.3.1">Section 3.3.1</a>. and
1039 DOCSIS RFI 2.0 Specification, <a href="#section-5.3.1">Section 5.3.1</a>."
1040 DEFVAL { passive }
1041 ::= { docsDevBase 6 }
1042
1043 docsDevMaxCpe OBJECT-TYPE
1044 SYNTAX Unsigned32 (0..255)
1045 UNITS "CPEs"
1046 MAX-ACCESS read-only
1047 STATUS current
1048 DESCRIPTION
1049 "The maximum number of CPEs that can be granted access
1050 through a CM during a CM epoch. This value can be
1051 obtained from the CM configuration file; however,
1052 it may be adjusted by the CM according to hardware or
1053 software limitations that have been imposed on the
1054 implementation."
1055 REFERENCE
1056 "DOCSIS RFI 1.0 Specification, <a href="#appendix-C.7.20">Appendix C.7.20</a>., and
1057
1058
1059
1060 <span class="grey">Woundy &amp; Marez Standards Track [Page 19]</span></pre>
1061 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
1062 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1063
1064
1065 DOCSIS RFI 1.1 Specification, <a href="#appendix-C.1.1.7">Appendix C.1.1.7</a>. and
1066 DOCSIS RFI 2.0 Specification, <a href="#appendix-C.1.1.7">Appendix C.1.1.7</a>."
1067 ::= { docsDevBase 7 }
1068
1069
1070 --
1071 -- The following table provides one level of security for access
1072 -- to the device by network management stations.
1073 -- Note that access is also constrained by the
1074 -- community strings and any vendor-specific security.
1075 --
1076
1077 docsDevNmAccessTable OBJECT-TYPE
1078 SYNTAX SEQUENCE OF DocsDevNmAccessEntry
1079 MAX-ACCESS not-accessible
1080 STATUS deprecated
1081 DESCRIPTION
1082 "This table controls access to SNMP objects by network
1083 management stations. If the table is empty, access to
1084 SNMP objects is unrestricted. The objects in this table
1085 MUST NOT persist across reboots. The objects in this
1086 table are only accessible from cable devices that are
1087 not capable of operating in SNMP Coexistence mode
1088 (<a href="./rfc3584">RFC 3584</a>) or in SNMPv3 mode (<a href="./rfc3410">RFC 3410</a>).
1089 See the conformance section for
1090 details. Note that some devices are required by other
1091 specifications (e.g., the DOCSIS OSSIv1.1 specification)
1092 to support the legacy SNMPv1/v2c docsDevNmAccess mode
1093 for backward compatibility.
1094
1095 This table is deprecated. Instead, use the SNMP
1096 coexistence MIBs from <a href="./rfc3584">RFC 3584</a>, the TARGET and
1097 NOTIFICATION MIBs from <a href="./rfc3413">RFC 3413</a>, and
1098 the View-Based Access Control Model (VACM) MIBs for
1099 all SNMP protocol versions from <a href="./rfc3415">RFC 3415</a>."
1100 ::= { docsDevMIBObjects 2 }
1101
1102 docsDevNmAccessEntry OBJECT-TYPE
1103 SYNTAX DocsDevNmAccessEntry
1104 MAX-ACCESS not-accessible
1105 STATUS deprecated
1106 DESCRIPTION
1107 "An entry describing access to SNMP objects by a
1108 particular network management station. An entry in
1109 this table is not readable unless the management station
1110 has read-write permission (either implicit if the table
1111 is empty, or explicit through an entry in this table).
1112 Entries are ordered by docsDevNmAccessIndex. The first
1113
1114
1115
1116 <span class="grey">Woundy &amp; Marez Standards Track [Page 20]</span></pre>
1117 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
1118 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1119
1120
1121 matching entry (e.g., matching IP address and community
1122 string) is used to derive access."
1123 INDEX { docsDevNmAccessIndex }
1124 ::= { docsDevNmAccessTable 1 }
1125
1126 DocsDevNmAccessEntry ::= SEQUENCE {
1127 docsDevNmAccessIndex Integer32,
1128 docsDevNmAccessIp IpAddress,
1129 docsDevNmAccessIpMask IpAddress,
1130 docsDevNmAccessCommunity OCTET STRING,
1131 docsDevNmAccessControl INTEGER,
1132 docsDevNmAccessInterfaces OCTET STRING,
1133 docsDevNmAccessStatus RowStatus,
1134 docsDevNmAccessTrapVersion INTEGER
1135 }
1136
1137 docsDevNmAccessIndex OBJECT-TYPE
1138 SYNTAX Integer32 (1..2147483647)
1139 MAX-ACCESS not-accessible
1140 STATUS deprecated
1141 DESCRIPTION
1142 "Index used to order the application of access
1143 entries."
1144 ::= { docsDevNmAccessEntry 1 }
1145
1146 docsDevNmAccessIp OBJECT-TYPE
1147 SYNTAX IpAddress
1148 MAX-ACCESS read-create
1149 STATUS deprecated
1150 DESCRIPTION
1151 "The IP address (or subnet) of the network management
1152 station. The address 0.0.0.0 is defined to mean
1153 any Network Management Station (NMS). If traps are
1154 enabled for this entry, then the value must be the
1155 address of a specific device. Implementations MAY
1156 recognize 255.255.255.255 as equivalent to 0.0.0.0."
1157 DEFVAL { '00000000'h }
1158 ::= { docsDevNmAccessEntry 2 }
1159
1160 docsDevNmAccessIpMask OBJECT-TYPE
1161 SYNTAX IpAddress
1162 MAX-ACCESS read-create
1163 STATUS deprecated
1164 DESCRIPTION
1165 "The IP subnet mask of the network management stations.
1166 If traps are enabled for this entry, then the value must
1167 be 0.0.0.0. Implementations MAY recognize
1168 255.255.255.255 as equivalent to 0.0.0.0."
1169
1170
1171
1172 <span class="grey">Woundy &amp; Marez Standards Track [Page 21]</span></pre>
1173 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
1174 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1175
1176
1177 DEFVAL { '00000000'h }
1178 ::= { docsDevNmAccessEntry 3 }
1179
1180 docsDevNmAccessCommunity OBJECT-TYPE
1181 SYNTAX OCTET STRING
1182 MAX-ACCESS read-create
1183 STATUS deprecated
1184 DESCRIPTION
1185 "The community string to be matched for access by this
1186 entry. If set to a zero-length string, then any
1187 community string will match. When read, this object
1188 SHOULD return a zero-length string."
1189 DEFVAL { "public" }
1190 ::= { docsDevNmAccessEntry 4 }
1191
1192 docsDevNmAccessControl OBJECT-TYPE
1193 SYNTAX INTEGER {
1194 none(1),
1195 read(2),
1196 readWrite(3),
1197 roWithTraps(4),
1198 rwWithTraps(5),
1199 trapsOnly(6)
1200 }
1201 MAX-ACCESS read-create
1202 STATUS deprecated
1203 DESCRIPTION
1204 "Specifies the type of access allowed to this NMS.
1205 Setting this object to none(1) causes the table entry
1206 to be destroyed. Read(2) allows access by 'get' and
1207 'get-next' PDUs. ReadWrite(3) allows access by 'set' as
1208 well. RoWithtraps(4), rwWithTraps(5), and trapsOnly(6)
1209 control distribution of Trap PDUs transmitted by this
1210 device."
1211 DEFVAL { read }
1212 ::= { docsDevNmAccessEntry 5 }
1213
1214 -- The syntax of the following object was copied from <a href="./rfc1493">RFC 1493</a>,
1215 -- dot1dStaticAllowedToGoTo.
1216
1217 docsDevNmAccessInterfaces OBJECT-TYPE
1218 SYNTAX OCTET STRING (SIZE (1..32))
1219 MAX-ACCESS read-create
1220 STATUS deprecated
1221 DESCRIPTION
1222 "Specifies the set of interfaces from which requests from
1223 this NMS will be accepted. Each octet within
1224 the value of this object specifies a set of eight
1225
1226
1227
1228 <span class="grey">Woundy &amp; Marez Standards Track [Page 22]</span></pre>
1229 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
1230 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1231
1232
1233 interfaces, the first octet specifying ports 1
1234 through 8, the second octet specifying interfaces 9
1235 through 16, etc. Within each octet, the most
1236 significant bit represents the lowest numbered
1237 interface, and the least significant bit represents the
1238 highest numbered interface. Thus, each interface is
1239 represented by a single bit within the value of this
1240 object. If that bit has a value of '1' then that
1241 interface is included in the set.
1242
1243 Note that entries in this table apply only to link-layer
1244 interfaces (e.g., Ethernet and CATV MAC). Bits
1245 representing upstream and downstream channel interfaces
1246 MUST NOT be set to '1'.
1247
1248 Note that if bits corresponding to non-existing
1249 interfaces are set, the result is implementation
1250 specific.
1251
1252 Note that according to the DOCSIS OSSIv1.1
1253 specification, when ifIndex '1' is included in the
1254 set, then this row applies to all CPE
1255 (customer-facing) interfaces.
1256
1257 The size of this object is the minimum required to
1258 represent all configured interfaces for this device."
1259 ::= { docsDevNmAccessEntry 6 }
1260
1261 docsDevNmAccessStatus OBJECT-TYPE
1262 SYNTAX RowStatus
1263 MAX-ACCESS read-create
1264 STATUS deprecated
1265 DESCRIPTION
1266 "Controls and reflects the status of rows in this
1267 table. Rows in this table may be created by either the
1268 create-and-go or create-and-wait paradigm. There is no
1269 restriction on changing values in a row of this table
1270 while the row is active.
1271
1272 The following objects MUST have valid values before this
1273 object can be set to active: docsDevNmAccessIp,
1274 docsDevNmAccessStatus, docsDevNmAccessIpMask,
1275 docsDevNmAccessCommunity, docsDevNmAccessControl, and
1276 docsDevNmAccessInterfaces."
1277 ::= { docsDevNmAccessEntry 7 }
1278
1279 docsDevNmAccessTrapVersion OBJECT-TYPE
1280 SYNTAX INTEGER {
1281
1282
1283
1284 <span class="grey">Woundy &amp; Marez Standards Track [Page 23]</span></pre>
1285 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
1286 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1287
1288
1289 disableSNMPv2trap(1),
1290 enableSNMPv2trap(2)
1291 }
1292 MAX-ACCESS read-create
1293 STATUS deprecated
1294 DESCRIPTION
1295 "Specifies the TRAP version that is sent to this NMS.
1296 Setting this object to disableSNMPv2trap (1) causes the
1297 trap in SNMPv1 format to be sent to a particular NMS.
1298 Setting this object to enableSNMPv2trap (2) causes the
1299 trap in SNMPv2 format be sent to a particular NMS."
1300 DEFVAL { disableSNMPv2trap }
1301 ::= { docsDevNmAccessEntry 8 }
1302
1303 --
1304 -- The following group describes control objects used for downloading
1305 -- firmware to a cable device. Procedures for software download are
1306 -- described in <a href="#section-3.2.1">Section 3.2.1</a> of the RFC containing this MIB module.
1307 --
1308
1309 docsDevSoftware OBJECT IDENTIFIER ::= { docsDevMIBObjects 3 }
1310
1311 docsDevSwServer OBJECT-TYPE
1312 SYNTAX IpAddress
1313 MAX-ACCESS read-write
1314 STATUS deprecated
1315 DESCRIPTION
1316 "The address of the TFTP server used for software
1317 upgrades. If the TFTP server is unknown or is a
1318 non-IPv4 address, return 0.0.0.0.
1319
1320 This object is deprecated. See docsDevSwServerAddress
1321 for its replacement. This object will have its value
1322 modified, given a valid SET to docsDevSwServerAddress."
1323 ::= { docsDevSoftware 1 }
1324
1325 docsDevSwFilename OBJECT-TYPE
1326 SYNTAX SnmpAdminString (SIZE (0..64))
1327 MAX-ACCESS read-write
1328 STATUS current
1329 DESCRIPTION
1330 "The filename of the software image to be downloaded via
1331 TFTP, or the abs_path (as defined in <a href="./rfc2616">RFC 2616</a>) of the
1332 software image to be downloaded via HTTP.
1333
1334 Unless set via SNMP, this is the filename or abs_path
1335 specified by the provisioning server during the boot
1336 process that corresponds to the software version that
1337
1338
1339
1340 <span class="grey">Woundy &amp; Marez Standards Track [Page 24]</span></pre>
1341 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
1342 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1343
1344
1345 is desired for this device.
1346
1347 If unknown, the value of this object is the zero-length
1348 string."
1349 ::= { docsDevSoftware 2 }
1350
1351 docsDevSwAdminStatus OBJECT-TYPE
1352 SYNTAX INTEGER {
1353 upgradeFromMgt(1),
1354 allowProvisioningUpgrade(2),
1355 ignoreProvisioningUpgrade(3)
1356 }
1357 MAX-ACCESS read-write
1358 STATUS current
1359 DESCRIPTION
1360 "If set to upgradeFromMgt(1), the device will initiate a
1361 TFTP or HTTP software image download. After
1362 successfully receiving an image, the device will set
1363 its state to ignoreProvisioningUpgrade(3) and reboot.
1364 If the download process is interrupted (e.g., by a reset
1365 or power failure), the device will load the previous
1366 image and, after re-initialization, continue to attempt
1367 loading the image specified in docsDevSwFilename.
1368
1369 If set to allowProvisioningUpgrade(2), the device will
1370 use the software version information supplied by the
1371 provisioning server when next rebooting (this does not
1372 cause a reboot).
1373
1374 When set to ignoreProvisioningUpgrade(3), the device
1375 will disregard software image upgrade information
1376 from the provisioning server.
1377
1378 Note that reading this object can return
1379 upgradeFromMgt(1). This indicates that a software
1380 download is currently in progress, and that the device
1381 will reboot after successfully receiving an image."
1382 DEFVAL { allowProvisioningUpgrade }
1383 ::= { docsDevSoftware 3 }
1384
1385 docsDevSwOperStatus OBJECT-TYPE
1386 SYNTAX INTEGER {
1387 inProgress(1),
1388 completeFromProvisioning(2),
1389 completeFromMgt(3),
1390 failed(4),
1391 other(5)
1392 }
1393
1394
1395
1396 <span class="grey">Woundy &amp; Marez Standards Track [Page 25]</span></pre>
1397 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
1398 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1399
1400
1401 MAX-ACCESS read-only
1402 STATUS current
1403 DESCRIPTION
1404 "InProgress(1) indicates that a TFTP or HTTP download is
1405 underway, either as a result of a version mismatch at
1406 provisioning or as a result of a upgradeFromMgt request.
1407 No other docsDevSw* objects can be modified in
1408 this state.
1409
1410 CompleteFromProvisioning(2) indicates that the last
1411 software upgrade was a result of version mismatch at
1412 provisioning.
1413
1414 CompleteFromMgt(3) indicates that the last software
1415 upgrade was a result of setting docsDevSwAdminStatus to
1416 upgradeFromMgt.
1417
1418 Failed(4) indicates that the last attempted download
1419 failed, ordinarily due to TFTP or HTTP timeout."
1420 REFERENCE
1421 "DOCSIS RFI 1.0 Specification, <a href="#section-8.2">Section 8.2</a>., and
1422 DOCSIS RFI 1.1 Specification, <a href="#section-10.1">Section 10.1</a>. and
1423 DOCSIS RFI 2.0 Specification, <a href="#section-12.1">Section 12.1</a>."
1424 ::= { docsDevSoftware 4 }
1425
1426 docsDevSwCurrentVers OBJECT-TYPE
1427 SYNTAX SnmpAdminString
1428 MAX-ACCESS read-only
1429 STATUS current
1430 DESCRIPTION
1431 "The software version currently operating in this device.
1432 This string's syntax is that used by the
1433 individual vendor to identify software versions.
1434 For a CM, this string will describe the current
1435 software load. For a CMTS, this object SHOULD contain
1436 a human-readable representation either of the vendor
1437 specific designation of the software for the chassis,
1438 or of the software for the control processor. If
1439 neither of these is applicable, the value MUST be a
1440 zero-length string."
1441 ::= { docsDevSoftware 5 }
1442
1443 docsDevSwServerAddressType OBJECT-TYPE
1444 SYNTAX InetAddressType
1445 MAX-ACCESS read-write
1446 STATUS current
1447 DESCRIPTION
1448 "The type of address of the TFTP or HTTP server used for
1449
1450
1451
1452 <span class="grey">Woundy &amp; Marez Standards Track [Page 26]</span></pre>
1453 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
1454 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1455
1456
1457 software upgrades.
1458
1459 If docsDevSwServerTransportProtocol is currently set to
1460 tftp(1), attempting to set this object to dns(16) MUST
1461 result in an error."
1462 ::= { docsDevSoftware 6 }
1463
1464 docsDevSwServerAddress OBJECT-TYPE
1465 SYNTAX InetAddress
1466 MAX-ACCESS read-write
1467 STATUS current
1468 DESCRIPTION
1469 "The address of the TFTP or HTTP server used for software
1470 upgrades.
1471
1472 If the TFTP/HTTP server is unknown, return the zero-
1473 length address string (see the TextualConvention).
1474
1475 If docsDevSwServer is also implemented in this agent,
1476 this object is tied to it. A set of this object to an
1477 IPv4 address will result in also setting the value of
1478 docsDevSwServer to that address. If this object is set
1479 to an IPv6 address, docsDevSwServer is set to 0.0.0.0.
1480 If docsDevSwServer is set, this object is also set to
1481 that value. Note that if both are set in the same
1482 action, the order of which one sets the other is
1483 undefined."
1484 ::= { docsDevSoftware 7 }
1485
1486 docsDevSwServerTransportProtocol OBJECT-TYPE
1487 SYNTAX INTEGER {
1488 tftp(1),
1489 http(2)
1490 }
1491 MAX-ACCESS read-write
1492 STATUS current
1493 DESCRIPTION
1494 "This object specifies the transport protocol (TFTP or
1495 HTTP) to be used for software upgrades.
1496
1497 If the value of this object is tftp(1), then the cable
1498 device uses TFTP (<a href="./rfc1350">RFC 1350</a>) read request packets to
1499 download the docsDevSwFilename from the
1500 docsDevSwServerAddress in octet mode.
1501
1502 If the value of this object is http(2), then the cable
1503 device uses HTTP 1.0 (<a href="./rfc1945">RFC 1945</a>) or HTTP 1.1 (<a href="./rfc2616">RFC 2616</a>)
1504 GET requests sent to host docsDevSwServerAddress to
1505
1506
1507
1508 <span class="grey">Woundy &amp; Marez Standards Track [Page 27]</span></pre>
1509 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
1510 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1511
1512
1513 download the software image from path docsDevSwFilename.
1514
1515 If docsDevSwServerAddressType is currently set to
1516 dns(16), attempting to set this object to tftp(1) MUST
1517 result in an error."
1518 DEFVAL { tftp }
1519 ::= { docsDevSoftware 8 }
1520
1521 --
1522 -- The following group describes server access and parameters used
1523 -- for initial provisioning and bootstrapping.
1524 --
1525
1526 docsDevServer OBJECT IDENTIFIER ::= { docsDevMIBObjects 4 }
1527
1528 docsDevServerBootState OBJECT-TYPE
1529 SYNTAX INTEGER {
1530 operational(1),
1531 disabled(2),
1532 waitingForDhcpOffer(3),
1533 waitingForDhcpResponse(4),
1534 waitingForTimeServer(5),
1535 waitingForTftp(6),
1536 refusedByCmts(7),
1537 forwardingDenied(8),
1538 other(9),
1539 unknown(10)
1540 }
1541 MAX-ACCESS read-only
1542 STATUS current
1543 DESCRIPTION
1544 "If operational(1), the device has completed loading and
1545 processing of configuration parameters, and the CMTS has
1546 completed the Registration exchange.
1547
1548 If disabled(2), then the device was administratively
1549 disabled, possibly by being refused network access in
1550 the configuration file.
1551
1552 If waitingForDhcpOffer(3), then a Dynamic Host
1553 Configuration Protocol (DHCP) Discover has been
1554 transmitted, and no offer has yet been received.
1555
1556 If waitingForDhcpResponse(4), then a DHCP Request has
1557 been transmitted, and no response has yet been received.
1558
1559 If waitingForTimeServer(5), then a Time Request has been
1560 transmitted, and no response has yet been received.
1561
1562
1563
1564 <span class="grey">Woundy &amp; Marez Standards Track [Page 28]</span></pre>
1565 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-29" ></span>
1566 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1567
1568
1569 If waitingForTftp(6), then a request to the TFTP
1570 parameter server has been made, and no response
1571 received.
1572
1573 If refusedByCmts(7), then the Registration
1574 Request/Response exchange with the CMTS failed.
1575
1576 If forwardingDenied(8), then the registration process
1577 was completed, but the network access option in the
1578 received configuration file prohibits forwarding.
1579
1580 If other(9), then the registration process reached a
1581 point that does not fall into one of the above
1582 categories.
1583
1584 If unknown(10), then the device has not yet begun the
1585 registration process or is in some other indeterminate
1586 state."
1587 REFERENCE
1588 "DOCSIS RFI 1.0 Specification, Figure 7-1, and
1589 DOCSIS RFI 1.1 Specification, Figure 9-1 and
1590 DOCSIS RFI 2.0 Specification, Figure 11-1."
1591 ::= { docsDevServer 1 }
1592
1593 docsDevServerDhcp OBJECT-TYPE
1594 SYNTAX IpAddress
1595 MAX-ACCESS read-only
1596 STATUS deprecated
1597 DESCRIPTION
1598 "The IP address of the DHCP server that assigned an IP
1599 address to this device. Returns 0.0.0.0 if DHCP is not
1600 used for IP address assignment, or if this agent is
1601 not assigned an IPv4 address.
1602
1603 This object is deprecated and is replaced by
1604 docsDevServerDhcpAddress."
1605 ::= { docsDevServer 2 }
1606
1607 docsDevServerTime OBJECT-TYPE
1608 SYNTAX IpAddress
1609 MAX-ACCESS read-only
1610 STATUS deprecated
1611 DESCRIPTION
1612 "The IP address of the Time server (<a href="./rfc0868">RFC 0868</a>). Returns
1613 0.0.0.0 if the time server IP address is unknown, or if
1614 the time server is not an IPv4 server.
1615
1616 This object is deprecated and is replaced by
1617
1618
1619
1620 <span class="grey">Woundy &amp; Marez Standards Track [Page 29]</span></pre>
1621 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-30" ></span>
1622 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1623
1624
1625 docsDevServerTimeAddress."
1626 ::= { docsDevServer 3 }
1627
1628 docsDevServerTftp OBJECT-TYPE
1629 SYNTAX IpAddress
1630 MAX-ACCESS read-only
1631 STATUS deprecated
1632 DESCRIPTION
1633 "The IP address of the TFTP server responsible for
1634 downloading provisioning and configuration parameters
1635 to this device. Returns 0.0.0.0 if the TFTP server
1636 address is unknown or is not an IPv4 address.
1637
1638 This object is deprecated and is replaced by
1639 docsDevServerConfigTftpAddress."
1640 ::= { docsDevServer 4 }
1641
1642 docsDevServerConfigFile OBJECT-TYPE
1643 SYNTAX SnmpAdminString
1644 MAX-ACCESS read-only
1645 STATUS current
1646 DESCRIPTION
1647 "The name of the device configuration file read from
1648 the TFTP server. Returns a zero-length string if
1649 the configuration file name is unknown."
1650 ::= { docsDevServer 5 }
1651
1652 docsDevServerDhcpAddressType OBJECT-TYPE
1653 SYNTAX InetAddressType
1654 MAX-ACCESS read-only
1655 STATUS current
1656 DESCRIPTION
1657 "The type of address of docsDevServerDhcpAddress. If
1658 DHCP was not used, this value should return
1659 unknown(0)."
1660 ::= { docsDevServer 6 }
1661
1662 docsDevServerDhcpAddress OBJECT-TYPE
1663 SYNTAX InetAddress
1664 MAX-ACCESS read-only
1665 STATUS current
1666 DESCRIPTION
1667 "The internet address of the DHCP server that assigned
1668 an IP address to this device. Returns the zero length
1669 octet string if DHCP was not used for IP address
1670 assignment."
1671 ::= { docsDevServer 7 }
1672
1673
1674
1675
1676 <span class="grey">Woundy &amp; Marez Standards Track [Page 30]</span></pre>
1677 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-31" ></span>
1678 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1679
1680
1681 docsDevServerTimeAddressType OBJECT-TYPE
1682 SYNTAX InetAddressType
1683 MAX-ACCESS read-only
1684 STATUS current
1685 DESCRIPTION
1686 "The type of address of docsDevServerTimeAddress. If
1687 no time server exists, this value should return
1688 unknown(0)."
1689 ::= { docsDevServer 8 }
1690
1691 docsDevServerTimeAddress OBJECT-TYPE
1692 SYNTAX InetAddress
1693 MAX-ACCESS read-only
1694 STATUS current
1695 DESCRIPTION
1696 "The Internet address of the <a href="./rfc868">RFC 868</a> Time server,
1697 as provided by DHCP option 4.
1698
1699 Note that if multiple values are provided to the
1700 CM in DHCP option 4, the value of this MIB object
1701 MUST be the Time server address from which the Time
1702 of Day reference was acquired as based on the DOCSIS
1703 RFI specification. During the period of time where
1704 the Time of Day have not been acquired, the Time
1705 server address reported by the CM may report the
1706 first address value in the DHCP option value or the
1707 last server address the CM attempted to get the Time
1708 of day value.
1709
1710 Returns the zero-length octet string if the time server
1711 IP address is not provisioned."
1712 REFERENCE
1713 "DOCSIS RFI 1.1 Specification, <a href="#section-9.2.7">Section 9.2.7</a>. and
1714 DOCSIS RFI 2.0 Specification, <a href="#section-11.2.7">Section 11.2.7</a>."
1715 ::= { docsDevServer 9 }
1716
1717 docsDevServerConfigTftpAddressType OBJECT-TYPE
1718 SYNTAX InetAddressType
1719 MAX-ACCESS read-only
1720 STATUS current
1721 DESCRIPTION
1722 "The type of address of docsDevServerConfigTftpAddress.
1723 If no TFTP server exists, this value should return
1724 unknown(0)."
1725 ::= { docsDevServer 10 }
1726
1727 docsDevServerConfigTftpAddress OBJECT-TYPE
1728 SYNTAX InetAddress
1729
1730
1731
1732 <span class="grey">Woundy &amp; Marez Standards Track [Page 31]</span></pre>
1733 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-32" ></span>
1734 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1735
1736
1737 MAX-ACCESS read-only
1738 STATUS current
1739 DESCRIPTION
1740 "The internet address of the TFTP server responsible for
1741 downloading provisioning and configuration parameters
1742 to this device. Returns the zero-length octet string if
1743 the config server address is unknown. There are certain
1744 security risks that are involved with using TFTP."
1745 REFERENCE
1746 "<a href="./rfc3617#section-5">RFC 3617, Section&nbsp;5</a>"
1747 ::= { docsDevServer 11 }
1748
1749
1750 --
1751 -- Event Reporting
1752 --
1753
1754 docsDevEvent OBJECT IDENTIFIER ::= { docsDevMIBObjects 5 }
1755
1756 docsDevEvControl OBJECT-TYPE
1757 SYNTAX INTEGER {
1758 resetLog(1),
1759 useDefaultReporting(2)
1760 }
1761 MAX-ACCESS read-write
1762 STATUS current
1763 DESCRIPTION
1764 "Setting this object to resetLog(1) empties the event
1765 log. All data is deleted. Setting it to
1766 useDefaultReporting(2) returns all event priorities to
1767 their factory-default reporting. Reading this object
1768 always returns useDefaultReporting(2)."
1769 ::= { docsDevEvent 1 }
1770
1771 docsDevEvSyslog OBJECT-TYPE
1772 SYNTAX IpAddress
1773 MAX-ACCESS read-write
1774 STATUS deprecated
1775 DESCRIPTION
1776 "The IP address of the Syslog server. If 0.0.0.0, either
1777 syslog transmission is inhibited, or the Syslog server
1778 address is not an IPv4 address.
1779
1780 This object is deprecated and is replaced by
1781 docsDevEvSyslogAddress."
1782 ::= { docsDevEvent 2 }
1783
1784 docsDevEvThrottleAdminStatus OBJECT-TYPE
1785
1786
1787
1788 <span class="grey">Woundy &amp; Marez Standards Track [Page 32]</span></pre>
1789 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-33" ></span>
1790 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1791
1792
1793 SYNTAX INTEGER {
1794 unconstrained(1),
1795 maintainBelowThreshold(2),
1796 stopAtThreshold(3),
1797 inhibited(4)
1798 }
1799 MAX-ACCESS read-write
1800 STATUS current
1801 DESCRIPTION
1802 "Controls the transmission of traps and syslog messages
1803 with respect to the trap pacing threshold.
1804
1805 unconstrained(1) causes traps and syslog messages to be
1806 transmitted without regard to the threshold settings.
1807
1808 maintainBelowThreshold(2) causes trap transmission and
1809 syslog messages to be suppressed if the number of traps
1810 would otherwise exceed the threshold.
1811
1812 stopAtThreshold(3) causes trap transmission to cease at
1813 the threshold and not to resume until directed to do so.
1814
1815 inhibited(4) causes all trap transmission and syslog
1816 messages to be suppressed.
1817
1818 A single event is always treated as a single event for
1819 threshold counting. That is, an event causing both a
1820 trap and a syslog message is still treated as a single
1821 event.
1822
1823 Writing to this object resets the thresholding state."
1824 DEFVAL { unconstrained }
1825 ::= { docsDevEvent 3 }
1826
1827 docsDevEvThrottleInhibited OBJECT-TYPE
1828 SYNTAX TruthValue
1829 MAX-ACCESS read-only
1830 STATUS deprecated
1831 DESCRIPTION
1832 "If true(1), trap and syslog transmission is currently
1833 inhibited due to thresholds and/or the current setting
1834 of docsDevEvThrottleAdminStatus. In addition, this is
1835 true(1) when transmission is inhibited because no
1836 syslog (docsDevEvSyslog) or trap (docsDevNmAccessEntry)
1837 destinations have been set.
1838
1839 This object is deprecated and is replaced by
1840 docsDevEvThrottleThresholdExceeded."
1841
1842
1843
1844 <span class="grey">Woundy &amp; Marez Standards Track [Page 33]</span></pre>
1845 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-34" ></span>
1846 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1847
1848
1849 ::= { docsDevEvent 4 }
1850
1851 docsDevEvThrottleThreshold OBJECT-TYPE
1852 SYNTAX Unsigned32
1853 UNITS "events"
1854 MAX-ACCESS read-write
1855 STATUS current
1856 DESCRIPTION
1857 "Number of events per docsDevEvThrottleInterval permitted
1858 before throttling is to occur.
1859
1860 A single event, whether the notification could result in
1861 messages transmitted using syslog, SNMP, or both
1862 protocols, and regardless of the number of destinations,
1863 (including zero) is always treated as a single event for
1864 threshold counting. For example, an event causing both
1865 a trap and a syslog message is still treated as a single
1866 event.
1867
1868 All system notifications that occur within the device
1869 should be taken into consideration when calculating
1870 and monitoring the threshold."
1871 DEFVAL { 0 }
1872 ::= { docsDevEvent 5 }
1873
1874 docsDevEvThrottleInterval OBJECT-TYPE
1875 SYNTAX Integer32 (1..2147483647)
1876 UNITS "seconds"
1877 MAX-ACCESS read-write
1878 STATUS current
1879 DESCRIPTION
1880 "The interval over which docsDevEvThrottleThreshold
1881 applies."
1882 DEFVAL { 1 }
1883 ::= { docsDevEvent 6 }
1884
1885 --
1886 -- The following table controls the reporting of the various classes
1887 -- of events.
1888 --
1889
1890 docsDevEvControlTable OBJECT-TYPE
1891 SYNTAX SEQUENCE OF DocsDevEvControlEntry
1892 MAX-ACCESS not-accessible
1893 STATUS current
1894 DESCRIPTION
1895 "This table allows control of the reporting of event
1896 classes. For each event priority, a combination of
1897
1898
1899
1900 <span class="grey">Woundy &amp; Marez Standards Track [Page 34]</span></pre>
1901 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-35" ></span>
1902 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1903
1904
1905 logging and reporting mechanisms may be chosen. The
1906 mapping of event types to priorities is
1907 vendor dependent. Vendors may also choose to allow
1908 the user to control that mapping through proprietary
1909 means. Table entries MUST persist across reboots for
1910 CMTS devices and MUST NOT persist across reboots for CM
1911 devices."
1912 ::= { docsDevEvent 7 }
1913
1914 docsDevEvControlEntry OBJECT-TYPE
1915 SYNTAX DocsDevEvControlEntry
1916 MAX-ACCESS not-accessible
1917 STATUS current
1918 DESCRIPTION
1919 "Allows configuration of the reporting mechanisms for a
1920 particular event priority."
1921 INDEX { docsDevEvPriority }
1922 ::= { docsDevEvControlTable 1 }
1923
1924 DocsDevEvControlEntry ::= SEQUENCE {
1925 docsDevEvPriority INTEGER,
1926 docsDevEvReporting BITS
1927 }
1928
1929 docsDevEvPriority OBJECT-TYPE
1930 SYNTAX INTEGER {
1931 emergency(1),
1932 alert(2),
1933 critical(3),
1934 error(4),
1935 warning(5),
1936 notice(6),
1937 information(7),
1938 debug(8)
1939 }
1940 MAX-ACCESS not-accessible
1941 STATUS current
1942 DESCRIPTION
1943 "The priority level that is controlled by this
1944 entry. These are ordered from most (emergency) to least
1945 (debug) critical. Each event with a CM or CMTS has a
1946 particular priority level associated with it (as defined
1947 by the vendor).
1948
1949 emergency(1) events indicate vendor-specific fatal
1950 hardware or software errors that prevent normal system
1951 operation.
1952
1953
1954
1955
1956 <span class="grey">Woundy &amp; Marez Standards Track [Page 35]</span></pre>
1957 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-36" ></span>
1958 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
1959
1960
1961 alert(2) events indicate a serious failure that causes
1962 the reporting system to reboot but is not caused by
1963 hardware or software malfunctioning.
1964
1965 critical(3) events indicate a serious failure that
1966 requires attention and prevents the device from
1967 transmitting data but that could be recovered without
1968 rebooting the system.
1969
1970 error(4) and warning(5) events indicate that a failure
1971 occurred that could interrupt the normal data flow but
1972 that does not cause the device to re-register.
1973
1974 notice(6) and information(7) events indicate a
1975 milestone or checkpoint in normal operation that could
1976 be of particular importance for troubleshooting.
1977
1978 debug(8) events are reserved for vendor-specific
1979 events.
1980
1981 During normal operation, no event more
1982 critical than notice(6) should be generated. Events
1983 between warning and emergency should be generated at
1984 appropriate levels of problems (e.g., emergency when the
1985 box is about to crash)."
1986 ::= { docsDevEvControlEntry 1 }
1987
1988 docsDevEvReporting OBJECT-TYPE
1989 SYNTAX BITS {
1990 local(0),
1991 traps(1),
1992 syslog(2),
1993 -- The following are extensions to the original set of
1994 -- labels. The extensions start at an octet boundary.
1995 -- So for bits 3 - 7, one MUST set them to zero on send
1996 -- and one MUST ignore them on receipt.
1997 localVolatile(8),
1998 stdInterface(9)
1999 }
2000 MAX-ACCESS read-write
2001 STATUS current
2002 DESCRIPTION
2003 "Defines the action to be taken on occurrence of this
2004 event class. Implementations may not necessarily
2005 support all options for all event classes but at
2006 minimum must allow traps and syslogging to be
2007 disabled.
2008
2009
2010
2011
2012 <span class="grey">Woundy &amp; Marez Standards Track [Page 36]</span></pre>
2013 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-37" ></span>
2014 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2015
2016
2017 If the local(0) bit is set, then log to the internal
2018 log and update non-volatile store, for backward
2019 compatibility with the original <a href="./rfc2669">RFC 2669</a> definition.
2020 If the traps(1) bit is set, then generate
2021 an SNMP trap; if the syslog(2) bit is set, then
2022 send a syslog message (assuming that the syslog address
2023 is set). If the localVolatile(8) bit is set, then
2024 log to the internal log without updating non-volatile
2025 store. If the stdInterface(9) bit is set, then the
2026 agent ignores all other bits except the local(0),
2027 syslog(2), and localVolatile(8) bits. Setting the
2028 stdInterface(9) bit indicates that <a href="./rfc3413">RFC3413</a> and
2029 <a href="./rfc3014">RFC3014</a> are being used to control event reporting
2030 mechanisms."
2031 ::= { docsDevEvControlEntry 2 }
2032
2033 docsDevEventTable OBJECT-TYPE
2034 SYNTAX SEQUENCE OF DocsDevEventEntry
2035 MAX-ACCESS not-accessible
2036 STATUS current
2037 DESCRIPTION
2038 "Contains a log of network and device events that may be
2039 of interest in fault isolation and troubleshooting.
2040 If the local(0) bit is set in docsDevEvReporting,
2041 entries in this table MUST persist across reboots."
2042 ::= { docsDevEvent 8 }
2043
2044 docsDevEventEntry OBJECT-TYPE
2045 SYNTAX DocsDevEventEntry
2046 MAX-ACCESS not-accessible
2047 STATUS current
2048 DESCRIPTION
2049 "Describes a network or device event that may be of
2050 interest in fault isolation and troubleshooting.
2051 Multiple sequential identical events are represented by
2052 incrementing docsDevEvCounts and setting
2053 docsDevEvLastTime to the current time rather than
2054 creating multiple rows.
2055
2056 Entries are created with the first occurrence of an
2057 event. docsDevEvControl can be used to clear the
2058 table. Individual events cannot be deleted."
2059 INDEX { docsDevEvIndex }
2060 ::= { docsDevEventTable 1 }
2061
2062 DocsDevEventEntry ::= SEQUENCE {
2063 docsDevEvIndex Integer32,
2064 docsDevEvFirstTime DateAndTime,
2065
2066
2067
2068 <span class="grey">Woundy &amp; Marez Standards Track [Page 37]</span></pre>
2069 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-38" ></span>
2070 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2071
2072
2073 docsDevEvLastTime DateAndTime,
2074 docsDevEvCounts Counter32,
2075 docsDevEvLevel INTEGER,
2076 docsDevEvId Unsigned32,
2077 docsDevEvText SnmpAdminString
2078 }
2079
2080 docsDevEvIndex OBJECT-TYPE
2081 SYNTAX Integer32 (1..2147483647)
2082 MAX-ACCESS not-accessible
2083 STATUS current
2084 DESCRIPTION
2085 "Provides relative ordering of the objects in the event
2086 log. This object will always increase except when
2087 (a) the log is reset via docsDevEvControl,
2088 (b) the device reboots and does not implement
2089 non-volatile storage for this log, or (c) it reaches
2090 the value 2^31. The next entry for all the above
2091 cases is 1."
2092 ::= { docsDevEventEntry 1 }
2093
2094 docsDevEvFirstTime OBJECT-TYPE
2095 SYNTAX DateAndTime
2096 MAX-ACCESS read-only
2097 STATUS current
2098 DESCRIPTION
2099 "The value of docsDevDateTime at the time this entry was
2100 created."
2101 ::= { docsDevEventEntry 2 }
2102
2103 docsDevEvLastTime OBJECT-TYPE
2104 SYNTAX DateAndTime
2105 MAX-ACCESS read-only
2106 STATUS current
2107 DESCRIPTION
2108 "When an entry reports only one event, this object will
2109 have the same value as the corresponding instance of
2110 docsDevEvFirstTime. When an entry reports multiple
2111 events, this object will record the value that
2112 docsDevDateTime had when the most recent event for this
2113 entry occurred."
2114 ::= { docsDevEventEntry 3 }
2115
2116 -- This object was renamed from docsDevEvCount to meet naming
2117 -- requirements for Counter32
2118 docsDevEvCounts OBJECT-TYPE
2119 SYNTAX Counter32
2120 UNITS "events"
2121
2122
2123
2124 <span class="grey">Woundy &amp; Marez Standards Track [Page 38]</span></pre>
2125 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-39" ></span>
2126 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2127
2128
2129 MAX-ACCESS read-only
2130 STATUS current
2131 DESCRIPTION
2132 "The number of consecutive event instances reported by
2133 this entry. This starts at 1 with the creation of this
2134 row and increments by 1 for each subsequent duplicate
2135 event."
2136 ::= { docsDevEventEntry 4 }
2137 docsDevEvLevel OBJECT-TYPE
2138 SYNTAX INTEGER {
2139 emergency(1),
2140 alert(2),
2141 critical(3),
2142 error(4),
2143 warning(5),
2144 notice(6),
2145 information(7),
2146 debug(8)
2147 }
2148 MAX-ACCESS read-only
2149 STATUS current
2150 DESCRIPTION
2151 "The priority level of this event, as defined by the
2152 vendor. These are ordered from most serious (emergency)
2153 to least serious (debug).
2154
2155 emergency(1) events indicate vendor-specific fatal
2156 hardware or software errors that prevent normal system
2157 operation.
2158
2159 alert(2) events indicate a serious failure that causes
2160 the reporting system to reboot but that is not caused by
2161 hardware or software malfunctioning.
2162
2163 critical(3) events indicate a serious failure that
2164 requires attention and prevents the device from
2165 transmitting data but that could be recovered without
2166 rebooting the system.
2167
2168 error(4) and warning(5) events indicate that a failure
2169 occurred that could interrupt the normal data flow but
2170 that does not cause the device to re-register.
2171
2172 notice(6) and information(7) events indicate a
2173 milestone or checkpoint in normal operation that could
2174 be of particular importance for troubleshooting.
2175
2176 debug(8) events are reserved for vendor-specific
2177
2178
2179
2180 <span class="grey">Woundy &amp; Marez Standards Track [Page 39]</span></pre>
2181 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-40" ></span>
2182 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2183
2184
2185 events.
2186
2187 During normal operation, no event more
2188 critical than notice(6) should be generated. Events
2189 between warning and emergency should be generated at
2190 appropriate levels of problems (e.g., emergency when the
2191 box is about to crash)."
2192 ::= { docsDevEventEntry 5 }
2193
2194 --
2195 -- It is strongly recommended that implementors follow the CableLabs
2196 -- enumerations for docsDevEvId, per the DOCSIS OSSIv1.1 spec
2197 -- and follow-on specifications.
2198 --
2199
2200 docsDevEvId OBJECT-TYPE
2201 SYNTAX Unsigned32
2202 MAX-ACCESS read-only
2203 STATUS current
2204 DESCRIPTION
2205 "For this product, uniquely identifies the type of event
2206 that is reported by this entry."
2207 REFERENCE
2208 "DOCSIS OSSI 1.1 Specification, <a href="#appendix-H">Appendix H</a> and
2209 DOCSIS OSSI 2.0 Specification, Annex D."
2210 ::= { docsDevEventEntry 6 }
2211
2212 docsDevEvText OBJECT-TYPE
2213 SYNTAX SnmpAdminString
2214 MAX-ACCESS read-only
2215 STATUS current
2216 DESCRIPTION
2217 "Provides a human-readable description of the event,
2218 including all relevant context (interface numbers,
2219 etc.)."
2220 ::= { docsDevEventEntry 7 }
2221
2222 docsDevEvSyslogAddressType OBJECT-TYPE
2223 SYNTAX InetAddressType
2224 MAX-ACCESS read-write
2225 STATUS current
2226 DESCRIPTION
2227 "The type of address of docsDevEvSyslogAddress. If
2228 no syslog server exists, this value should return
2229 unknown(0)."
2230 DEFVAL { unknown }
2231 ::= { docsDevEvent 9 }
2232
2233
2234
2235
2236 <span class="grey">Woundy &amp; Marez Standards Track [Page 40]</span></pre>
2237 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-41" ></span>
2238 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2239
2240
2241 docsDevEvSyslogAddress OBJECT-TYPE
2242 SYNTAX InetAddress
2243 MAX-ACCESS read-write
2244 STATUS current
2245 DESCRIPTION
2246 "The Internet address of the Syslog server, as provided
2247 by DHCP option 7 or set via SNMP management. If the
2248 address of the server is set to the zero-length
2249 string, the 0.0.0.0 IPv4 address, or the 0: IPv6
2250 address, Syslog transmission is inhibited.
2251
2252 Note that if multiple values are provided to the CM in
2253 DHCP option 7, the value of this MIB object MUST be the
2254 first Syslog server address received.
2255
2256 By default at agent boot, this object returns the zero
2257 length string."
2258 ::= { docsDevEvent 10 }
2259
2260 docsDevEvThrottleThresholdExceeded OBJECT-TYPE
2261 SYNTAX TruthValue
2262 MAX-ACCESS read-only
2263 STATUS current
2264 DESCRIPTION
2265 "If true(1), trap and syslog transmission is currently
2266 inhibited due to exceeding the trap/syslog event
2267 threshold in the current interval."
2268 ::= { docsDevEvent 11 }
2269
2270 --
2271 -- Link Level Control Filtering
2272 --
2273
2274 docsDevFilter OBJECT IDENTIFIER ::= { docsDevMIBObjects 6 }
2275
2276 docsDevFilterLLCUnmatchedAction OBJECT-TYPE
2277 SYNTAX INTEGER {
2278 discard(1),
2279 accept(2)
2280 }
2281 MAX-ACCESS read-write
2282 STATUS current
2283 DESCRIPTION
2284 "LLC (Link Level Control) filters can be defined on an
2285 inclusive or exclusive basis: CMs can be configured to
2286 forward only packets matching a set of layer three
2287 protocols, or to drop packets matching a set of layer
2288 three protocols. Typical use of these filters is to
2289
2290
2291
2292 <span class="grey">Woundy &amp; Marez Standards Track [Page 41]</span></pre>
2293 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-42" ></span>
2294 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2295
2296
2297 filter out possibly harmful (given the context of a
2298 large metropolitan LAN) protocols.
2299
2300 If set to discard(1), any L2 packet that does not match
2301 at least one filter in the docsDevFilterLLCTable will be
2302 discarded. If set to accept(2), any L2 packet that
2303 does not match at least one filter in the
2304 docsDevFilterLLCTable will be accepted for further
2305 processing (e.g., bridging). In other words, if the
2306 packet does not match an entry in the table, it takes
2307 this action; if it does match an entry in the table, it
2308 takes the opposite of this action."
2309 DEFVAL { accept }
2310 ::= { docsDevFilter 1 }
2311
2312 docsDevFilterLLCTable OBJECT-TYPE
2313 SYNTAX SEQUENCE OF DocsDevFilterLLCEntry
2314 MAX-ACCESS not-accessible
2315 STATUS current
2316 DESCRIPTION
2317 "A list of filters to apply to (bridged) LLC
2318 traffic. The filters in this table are applied to
2319 incoming traffic on the appropriate interface(s) prior
2320 to any further processing (e.g., before the packet
2321 is handed off for level 3 processing, or for bridging).
2322 The specific action taken when no filter is matched is
2323 controlled by docsDevFilterLLCUnmatchedAction. Table
2324 entries MUST NOT persist across reboots for any device."
2325 ::= { docsDevFilter 2 }
2326
2327 docsDevFilterLLCEntry OBJECT-TYPE
2328 SYNTAX DocsDevFilterLLCEntry
2329 MAX-ACCESS not-accessible
2330 STATUS current
2331 DESCRIPTION
2332 "Describes a single filter to apply to (bridged) LLC
2333 traffic received on a specified interface. "
2334 INDEX { docsDevFilterLLCIndex }
2335 ::= { docsDevFilterLLCTable 1 }
2336
2337 DocsDevFilterLLCEntry ::= SEQUENCE {
2338 docsDevFilterLLCIndex Integer32,
2339 docsDevFilterLLCStatus RowStatus,
2340 docsDevFilterLLCIfIndex InterfaceIndexOrZero,
2341 docsDevFilterLLCProtocolType INTEGER,
2342 docsDevFilterLLCProtocol Integer32,
2343 docsDevFilterLLCMatches Counter32
2344 }
2345
2346
2347
2348 <span class="grey">Woundy &amp; Marez Standards Track [Page 42]</span></pre>
2349 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-43" ></span>
2350 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2351
2352
2353 docsDevFilterLLCIndex OBJECT-TYPE
2354 SYNTAX Integer32 (1..2147483647)
2355 MAX-ACCESS not-accessible
2356 STATUS current
2357 DESCRIPTION
2358 "Index used for the identification of filters (note that
2359 LLC filter order is irrelevant)."
2360 ::= { docsDevFilterLLCEntry 1 }
2361 docsDevFilterLLCStatus OBJECT-TYPE
2362 SYNTAX RowStatus
2363 MAX-ACCESS read-create
2364 STATUS current
2365 DESCRIPTION
2366 "Controls and reflects the status of rows in this
2367 table. There is no restriction on changing any of the
2368 associated columns for this row while this object is set
2369 to active.
2370
2371 Specifying only this object (with the
2372 appropriate index) on a CM is sufficient to create a
2373 filter row that matches all inbound packets on the
2374 ethernet interface and results in the packets being
2375 discarded. docsDevFilterLLCIfIndex (at least) must be
2376 specified on a CMTS to create a row."
2377 ::= { docsDevFilterLLCEntry 2}
2378
2379 docsDevFilterLLCIfIndex OBJECT-TYPE
2380 SYNTAX InterfaceIndexOrZero
2381 MAX-ACCESS read-create
2382 STATUS current
2383 DESCRIPTION
2384 "The entry interface to which this filter applies. The
2385 value corresponds to ifIndex for either a CATV MAC or
2386 another network interface. If the value is zero, the
2387 filter applies to all interfaces. In Cable Modems, the
2388 default value is the customer side interface(s). In
2389 CMTSs, this object has to be specified to
2390 create a row in this table.
2391
2392 Note that according to the DOCSIS OSSIv1.1
2393 specification, ifIndex '1' in the CM means that this
2394 row applies to all Cable Modem-to-CPE Interfaces
2395 (CMCI)."
2396 REFERENCE
2397 "DOCSIS OSSI 1.1 Specification, <a href="#section-3.3.4.1">Section 3.3.4.1</a>. and
2398 DOCSIS OSSI 2.0 Specification, <a href="#section-6.3.4.1">Section 6.3.4.1</a>."
2399 ::= { docsDevFilterLLCEntry 3 }
2400
2401
2402
2403
2404 <span class="grey">Woundy &amp; Marez Standards Track [Page 43]</span></pre>
2405 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-44" ></span>
2406 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2407
2408
2409 docsDevFilterLLCProtocolType OBJECT-TYPE
2410 SYNTAX INTEGER {
2411 ethertype(1),
2412 dsap(2)
2413 }
2414 MAX-ACCESS read-create
2415 STATUS current
2416 DESCRIPTION
2417 "The format of the value in docsDevFilterLLCProtocol:
2418 either a two-byte Ethernet Ethertype, or a one-byte
2419 802.2 Service Access Point (SAP) value. ethertype(1)
2420 also applies to Standard Network Access Protocol
2421 (SNAP) encapsulated frames."
2422 DEFVAL { ethertype }
2423 ::= { docsDevFilterLLCEntry 4 }
2424
2425 docsDevFilterLLCProtocol OBJECT-TYPE
2426 SYNTAX Integer32 (0..65535)
2427 MAX-ACCESS read-create
2428 STATUS current
2429 DESCRIPTION
2430 "The layer-three protocol for which this filter applies.
2431 The protocol value format depends on
2432 docsDevFilterLLCProtocolType. Note that for SNAP
2433 frames, ethertype filtering is performed rather than
2434 Destination Service Access Point (DSAP) =0xAA."
2435 DEFVAL { 0 }
2436 ::= { docsDevFilterLLCEntry 5 }
2437
2438 docsDevFilterLLCMatches OBJECT-TYPE
2439 SYNTAX Counter32
2440 UNITS "matches"
2441 MAX-ACCESS read-only
2442 STATUS current
2443 DESCRIPTION
2444 "Counts the number of times this filter was matched."
2445 ::= { docsDevFilterLLCEntry 6 }
2446
2447 --
2448 -- IPv4 Filtering
2449 --
2450
2451 docsDevFilterIpDefault OBJECT-TYPE
2452 SYNTAX INTEGER {
2453 discard(1),
2454 accept(2)
2455 }
2456 MAX-ACCESS read-write
2457
2458
2459
2460 <span class="grey">Woundy &amp; Marez Standards Track [Page 44]</span></pre>
2461 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-45" ></span>
2462 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2463
2464
2465 STATUS deprecated
2466 DESCRIPTION
2467 "The default behavior for (bridged) packets that do not
2468 match IP filters (or Internet filters, if implemented)
2469 is defined by docsDevFilterIpDefault.
2470
2471 If set to discard(1), all packets not matching an IP
2472 filter in docsDevFilterIpTable will be discarded. If
2473 set to accept(2), all packets not matching an IP filter
2474 or an Internet filter will be accepted for further
2475 processing (e.g., bridging)."
2476 DEFVAL { accept }
2477 ::= { docsDevFilter 3 }
2478
2479 docsDevFilterIpTable OBJECT-TYPE
2480 SYNTAX SEQUENCE OF DocsDevFilterIpEntry
2481 MAX-ACCESS not-accessible
2482 STATUS deprecated
2483 DESCRIPTION
2484 "An ordered list of filters or classifiers to apply to
2485 IP traffic. Filter application is ordered by the filter
2486 index, rather than by a best match algorithm (note that
2487 this implies that the filter table may have gaps in the
2488 index values). Packets that match no filters will have
2489 policy 0 in the docsDevFilterPolicyTable applied to
2490 them, if it exists. Otherwise, Packets that match no
2491 filters are discarded or forwarded according to the
2492 setting of docsDevFilterIpDefault.
2493
2494 Any IP packet can theoretically match multiple rows of
2495 this table. When considering a packet, the table is
2496 scanned in row index order (e.g., filter 10 is checked
2497 before filter 20). If the packet matches that filter
2498 (which means that it matches ALL criteria for that row),
2499 actions appropriate to docsDevFilterIpControl and
2500 docsDevFilterPolicyId are taken. If the packet was
2501 discarded processing is complete. If
2502 docsDevFilterIpContinue is set to true, the filter
2503 comparison continues with the next row in the table,
2504 looking for additional matches.
2505
2506 If the packet matches no filter in the table, the packet
2507 is accepted or dropped for further processing
2508 according to the setting of docsDevFilterIpDefault.
2509 If the packet is accepted, the actions specified by
2510 policy group 0 (e.g., the rows in
2511 docsDevFilterPolicyTable that have a value of 0 for
2512 docsDevFilterPolicyId) are taken, if that policy
2513
2514
2515
2516 <span class="grey">Woundy &amp; Marez Standards Track [Page 45]</span></pre>
2517 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-46" ></span>
2518 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2519
2520
2521 group exists.
2522
2523 Logically, this table is consulted twice during the
2524 processing of any IP packet: once upon its acceptance
2525 from the L2 entity, and once upon its transmission to
2526 the L2 entity. In actuality, for cable modems, IP
2527 filtering is generally the only IP processing done for
2528 transit traffic. This means that inbound and outbound
2529 filtering can generally be done at the same time with
2530 one pass through the filter table.
2531
2532 The objects in this table are only accessible from cable
2533 devices that are not operating in DiffServ MIB mode
2534 (<a href="./rfc3289">RFC 3289</a>). See the conformance section for details.
2535
2536 Note that some devices are required by other
2537 specifications (e.g., the DOCSIS OSSIv1.1 specification)
2538 to support the legacy SNMPv1/v2c docsDevFilter mode
2539 for backward compatibility.
2540
2541 Table entries MUST NOT persist across reboots for any
2542 device.
2543
2544 This table is deprecated. Instead, use the DiffServ MIB
2545 from <a href="./rfc3289">RFC 3289</a>."
2546 ::= { docsDevFilter 4 }
2547
2548 docsDevFilterIpEntry OBJECT-TYPE
2549 SYNTAX DocsDevFilterIpEntry
2550 MAX-ACCESS not-accessible
2551 STATUS deprecated
2552 DESCRIPTION
2553 "Describes a filter to apply to IP traffic received on a
2554 specified interface. All identity objects in this table
2555 (e.g., source and destination address/mask, protocol,
2556 source/dest port, TOS/mask, interface and direction)
2557 must match their respective fields in the packet for
2558 any given filter to match.
2559
2560 To create an entry in this table, docsDevFilterIpIfIndex
2561 must be specified."
2562 INDEX { docsDevFilterIpIndex }
2563 ::= { docsDevFilterIpTable 1 }
2564
2565 DocsDevFilterIpEntry ::= SEQUENCE {
2566 docsDevFilterIpIndex Integer32,
2567 docsDevFilterIpStatus RowStatus,
2568 docsDevFilterIpControl INTEGER,
2569
2570
2571
2572 <span class="grey">Woundy &amp; Marez Standards Track [Page 46]</span></pre>
2573 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-47" ></span>
2574 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2575
2576
2577 docsDevFilterIpIfIndex InterfaceIndexOrZero,
2578 docsDevFilterIpDirection INTEGER,
2579 docsDevFilterIpBroadcast TruthValue,
2580 docsDevFilterIpSaddr IpAddress,
2581 docsDevFilterIpSmask IpAddress,
2582 docsDevFilterIpDaddr IpAddress,
2583 docsDevFilterIpDmask IpAddress,
2584 docsDevFilterIpProtocol Integer32,
2585 docsDevFilterIpSourcePortLow Integer32,
2586 docsDevFilterIpSourcePortHigh Integer32,
2587 docsDevFilterIpDestPortLow Integer32,
2588 docsDevFilterIpDestPortHigh Integer32,
2589 docsDevFilterIpMatches ZeroBasedCounter32,
2590 docsDevFilterIpTos OCTET STRING,
2591 docsDevFilterIpTosMask OCTET STRING,
2592 docsDevFilterIpContinue TruthValue,
2593 docsDevFilterIpPolicyId Integer32
2594 }
2595
2596 docsDevFilterIpIndex OBJECT-TYPE
2597 SYNTAX Integer32 (1..2147483647)
2598 MAX-ACCESS not-accessible
2599 STATUS deprecated
2600 DESCRIPTION
2601 "Index used to order the application of filters.
2602 The filter with the lowest index is always applied
2603 first."
2604 ::= { docsDevFilterIpEntry 1 }
2605
2606 docsDevFilterIpStatus OBJECT-TYPE
2607 SYNTAX RowStatus
2608 MAX-ACCESS read-create
2609 STATUS deprecated
2610 DESCRIPTION
2611 "Controls and reflects the status of rows in this
2612 table. Specifying only this object (with the
2613 appropriate index) on a CM is sufficient to create a
2614 filter row that matches all inbound packets on the
2615 ethernet interface and results in the packets being
2616 discarded. docsDevFilterIpIfIndex (at least) must be
2617 specified on a CMTS to create a row. Creation of the
2618 rows may be done via either create-and-wait or
2619 create-and-go, but the filter is not applied until this
2620 object is set to (or changes to) active. There is no
2621 restriction in changing any object in a row while this
2622 object is set to active."
2623 ::= { docsDevFilterIpEntry 2 }
2624
2625
2626
2627
2628 <span class="grey">Woundy &amp; Marez Standards Track [Page 47]</span></pre>
2629 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-48" ></span>
2630 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2631
2632
2633 docsDevFilterIpControl OBJECT-TYPE
2634 SYNTAX INTEGER {
2635 discard(1),
2636 accept(2),
2637 policy(3)
2638 }
2639 MAX-ACCESS read-create
2640 STATUS deprecated
2641 DESCRIPTION
2642 "If set to discard(1), all packets matching this filter
2643 will be discarded, and scanning of the remainder of the
2644 filter list will be aborted. If set to accept(2), all
2645 packets matching this filter will be accepted for
2646 further processing (e.g., bridging). If
2647 docsDevFilterIpContinue is set to true, see if there
2648 are other matches; otherwise, done. If set to
2649 policy (3), execute the policy entries
2650 matched by docsDevFilterIpPolicyId in
2651 docsDevFilterPolicyTable.
2652
2653 If docsDevFilterIpContinue is set to true, continue
2654 scanning the table for other matches; otherwise, done."
2655 DEFVAL { discard }
2656 ::= { docsDevFilterIpEntry 3 }
2657
2658 docsDevFilterIpIfIndex OBJECT-TYPE
2659 SYNTAX InterfaceIndexOrZero
2660 MAX-ACCESS read-create
2661 STATUS deprecated
2662 DESCRIPTION
2663 "The entry interface to which this filter applies. The
2664 value corresponds to ifIndex for either a CATV MAC or
2665 another interface. If the value is zero, the
2666 filter applies to all interfaces. Default value in CMs
2667 is the index of the customer-side (e.g., ethernet)
2668 interface(s). In CMTSes, this object MUST be
2669 specified to create a row in this table.
2670
2671 Note that according to the DOCSIS OSSIv1.1
2672 specification, ifIndex '1' in the Cable Modem means
2673 that this row applies to all CMCI (customer-facing)
2674 interfaces."
2675 REFERENCE
2676 "DOCSIS OSSI 1.1 Specification, <a href="#section-3.3.4.1">Section 3.3.4.1</a>. and
2677 DOCSIS OSSI 2.0 Specification, <a href="#section-6.3.4.1">Section 6.3.4.1</a>."
2678 ::= { docsDevFilterIpEntry 4 }
2679
2680 docsDevFilterIpDirection OBJECT-TYPE
2681
2682
2683
2684 <span class="grey">Woundy &amp; Marez Standards Track [Page 48]</span></pre>
2685 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-49" ></span>
2686 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2687
2688
2689 SYNTAX INTEGER {
2690 inbound(1),
2691 outbound(2),
2692 both(3)
2693 }
2694 MAX-ACCESS read-create
2695 STATUS deprecated
2696 DESCRIPTION
2697 "Determines whether the filter is applied to inbound(1)
2698 traffic, outbound(2) traffic, or traffic in both(3)
2699 directions."
2700 DEFVAL { inbound }
2701 ::= { docsDevFilterIpEntry 5 }
2702
2703 docsDevFilterIpBroadcast OBJECT-TYPE
2704 SYNTAX TruthValue
2705 MAX-ACCESS read-create
2706 STATUS deprecated
2707 DESCRIPTION
2708 "If set to true(1), the filter only applies to multicast
2709 and broadcast traffic. If set to false(2), the filter
2710 applies to all traffic."
2711 DEFVAL { false }
2712 ::= { docsDevFilterIpEntry 6 }
2713
2714 docsDevFilterIpSaddr OBJECT-TYPE
2715 SYNTAX IpAddress
2716 MAX-ACCESS read-create
2717 STATUS deprecated
2718 DESCRIPTION
2719 "The source IP address, or portion thereof, that is to be
2720 matched for this filter. The source address is first
2721 masked (ANDed) against docsDevFilterIpSmask before
2722 being compared to this value. A value of 0 for this
2723 object and 0 for the mask matches all IP addresses."
2724 DEFVAL { '00000000'h }
2725 ::= { docsDevFilterIpEntry 7 }
2726
2727 docsDevFilterIpSmask OBJECT-TYPE
2728 SYNTAX IpAddress
2729 MAX-ACCESS read-create
2730 STATUS deprecated
2731 DESCRIPTION
2732 "A bit mask that is to be applied to the source address
2733 prior to matching. This mask is not necessarily the
2734 same as a subnet mask, but 1s bits must be leftmost and
2735 contiguous."
2736 DEFVAL { '00000000'h }
2737
2738
2739
2740 <span class="grey">Woundy &amp; Marez Standards Track [Page 49]</span></pre>
2741 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-50" ></span>
2742 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2743
2744
2745 ::= { docsDevFilterIpEntry 8 }
2746
2747 docsDevFilterIpDaddr OBJECT-TYPE
2748 SYNTAX IpAddress
2749 MAX-ACCESS read-create
2750 STATUS deprecated
2751 DESCRIPTION
2752 "The destination IP address, or portion thereof, that is
2753 to be matched for this filter. The destination address
2754 is first masked (ANDed) against docsDevFilterIpDmask
2755 before being compared to this value. A value of
2756 00000000 for this object and 00000000 for the mask
2757 matches all IP addresses."
2758 DEFVAL { '00000000'h }
2759 ::= { docsDevFilterIpEntry 9 }
2760
2761 docsDevFilterIpDmask OBJECT-TYPE
2762 SYNTAX IpAddress
2763 MAX-ACCESS read-create
2764 STATUS deprecated
2765 DESCRIPTION
2766 "A bit mask that is to be applied to the destination
2767 address prior to matching. This mask is not necessarily
2768 the same as a subnet mask, but 1s bits MUST be leftmost
2769 and contiguous."
2770 DEFVAL { '00000000'h }
2771 ::= { docsDevFilterIpEntry 10 }
2772
2773 docsDevFilterIpProtocol OBJECT-TYPE
2774 SYNTAX Integer32 (0..256)
2775 MAX-ACCESS read-create
2776 STATUS deprecated
2777 DESCRIPTION
2778 "The IP protocol value that is to be matched. For
2779 example, icmp is 1, tcp is 6, and udp is 17. A value of
2780 256 matches ANY protocol."
2781 REFERENCE "www.iana.org/assignments/protocol-numbers"
2782 DEFVAL { 256 }
2783 ::= { docsDevFilterIpEntry 11 }
2784
2785 docsDevFilterIpSourcePortLow OBJECT-TYPE
2786 SYNTAX Integer32 (0..65535)
2787 MAX-ACCESS read-create
2788 STATUS deprecated
2789 DESCRIPTION
2790 "This is the inclusive lower bound of the transport-layer
2791 source port range that is to be matched. If the IP
2792 protocol of the packet is neither UDP nor TCP, this
2793
2794
2795
2796 <span class="grey">Woundy &amp; Marez Standards Track [Page 50]</span></pre>
2797 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-51" ></span>
2798 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2799
2800
2801 object is ignored during matching."
2802 REFERENCE "www.iana.org/assignments/port-numbers"
2803 DEFVAL { 0 }
2804 ::= { docsDevFilterIpEntry 12 }
2805
2806 docsDevFilterIpSourcePortHigh OBJECT-TYPE
2807 SYNTAX Integer32 (0..65535)
2808 MAX-ACCESS read-create
2809 STATUS deprecated
2810 DESCRIPTION
2811 "This is the inclusive upper bound of the transport-layer
2812 source port range that is to be matched. If the IP
2813 protocol of the packet is neither UDP nor TCP, this
2814 object is ignored during matching."
2815 REFERENCE "www.iana.org/assignments/port-numbers"
2816 DEFVAL { 65535 }
2817 ::= { docsDevFilterIpEntry 13 }
2818
2819 docsDevFilterIpDestPortLow OBJECT-TYPE
2820 SYNTAX Integer32 (0..65535)
2821 MAX-ACCESS read-create
2822 STATUS deprecated
2823 DESCRIPTION
2824 "This is the inclusive lower bound of the transport-layer
2825 destination port range that is to be matched. If the IP
2826 protocol of the packet is neither UDP nor TCP, this
2827 object is ignored during matching."
2828 REFERENCE "www.iana.org/assignments/port-numbers"
2829 DEFVAL { 0 }
2830 ::= { docsDevFilterIpEntry 14 }
2831
2832 docsDevFilterIpDestPortHigh OBJECT-TYPE
2833 SYNTAX Integer32 (0..65535)
2834 MAX-ACCESS read-create
2835 STATUS deprecated
2836 DESCRIPTION
2837 "This is the inclusive upper bound of the transport-layer
2838 destination port range that is to be matched. If the IP
2839 protocol of the packet is neither UDP nor TCP, this
2840 object is ignored during matching."
2841 REFERENCE "www.iana.org/assignments/port-numbers"
2842 DEFVAL { 65535 }
2843 ::= { docsDevFilterIpEntry 15 }
2844
2845 docsDevFilterIpMatches OBJECT-TYPE
2846 SYNTAX ZeroBasedCounter32
2847 UNITS "matches"
2848 MAX-ACCESS read-only
2849
2850
2851
2852 <span class="grey">Woundy &amp; Marez Standards Track [Page 51]</span></pre>
2853 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-52" ></span>
2854 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2855
2856
2857 STATUS deprecated
2858 DESCRIPTION
2859 "Counts the number of times this filter was matched.
2860 This object is initialized to 0 at boot, or at row
2861 creation, and is reset only upon reboot."
2862 ::= { docsDevFilterIpEntry 16 }
2863
2864 docsDevFilterIpTos OBJECT-TYPE
2865 SYNTAX OCTET STRING (SIZE (1))
2866 MAX-ACCESS read-create
2867 STATUS deprecated
2868 DESCRIPTION
2869 "This is the value to be matched to the packet's
2870 TOS (Type of Service) value (after the TOS value
2871 is ANDed with docsDevFilterIpTosMask). A value for this
2872 object of 0 and a mask of 0 matches all TOS values."
2873 DEFVAL { '00'h }
2874 ::= { docsDevFilterIpEntry 17 }
2875
2876 docsDevFilterIpTosMask OBJECT-TYPE
2877 SYNTAX OCTET STRING (SIZE (1))
2878 MAX-ACCESS read-create
2879 STATUS deprecated
2880 DESCRIPTION
2881 "The mask to be applied to the packet's TOS value before
2882 matching."
2883 DEFVAL { '00'h }
2884 ::= { docsDevFilterIpEntry 18 }
2885
2886 docsDevFilterIpContinue OBJECT-TYPE
2887 SYNTAX TruthValue
2888 MAX-ACCESS read-create
2889 STATUS deprecated
2890 DESCRIPTION
2891 "If this value is set to true and docsDevFilterIpControl
2892 is anything but discard (1), continue scanning and
2893 applying policies. See <a href="#section-3.3.3">Section 3.3.3</a> for more
2894 details."
2895 DEFVAL { false }
2896 ::= { docsDevFilterIpEntry 19 }
2897
2898 docsDevFilterIpPolicyId OBJECT-TYPE
2899 SYNTAX Integer32 (0..2147483647)
2900 MAX-ACCESS read-create
2901 STATUS deprecated
2902 DESCRIPTION
2903 "This object points to an entry in
2904 docsDevFilterPolicyTable. If docsDevFilterIpControl
2905
2906
2907
2908 <span class="grey">Woundy &amp; Marez Standards Track [Page 52]</span></pre>
2909 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-53" ></span>
2910 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2911
2912
2913 is set to policy (3), execute all matching policies
2914 in docsDevFilterPolicyTable. If no matching policy
2915 exists, treat as if docsDevFilterIpControl were set
2916 to accept (1). If this object is set to the value of
2917 0, there is no matching policy, and
2918 docsDevFilterPolicyTable MUST NOT be consulted."
2919 DEFVAL { 0 }
2920 ::= { docsDevFilterIpEntry 20 }
2921
2922 --
2923 -- Policy Mapping Table
2924 --
2925
2926 docsDevFilterPolicyTable OBJECT-TYPE
2927 SYNTAX SEQUENCE OF DocsDevFilterPolicyEntry
2928 MAX-ACCESS not-accessible
2929 STATUS deprecated
2930 DESCRIPTION
2931 "A Table that maps between a policy group ID and a set
2932 of pointers to policies to be applied. All rows with
2933 the same docsDevFilterPolicyId are part of the same
2934 group of policy pointers and are applied in the order
2935 in this table. docsDevFilterPolicyTable exists to
2936 allow multiple policy actions (referenced by policy
2937 pointers) to be applied to any given classified packet.
2938 The policy actions are applied in index order.
2939 For example:
2940
2941 Index ID Type Action
2942 1 1 TOS 1
2943 9 5 TOS 1
2944 12 1 IPSEC 3
2945
2946 This says that a packet that matches a filter with
2947 policy id 1 first has TOS policy 1 applied (which might
2948 set the TOS bits to enable a higher priority) and next
2949 has the IPSEC policy 3 applied (which may result in the
2950 packets being dumped into a secure VPN to a remote
2951 encryptor).
2952
2953 Policy ID 0 is reserved for default actions and is
2954 applied only to packets that match no filters in
2955 docsDevFilterIpTable.
2956
2957 Table entries MUST NOT persist across reboots for any
2958 device.
2959
2960 This table is deprecated. Instead, use the DiffServ MIB
2961
2962
2963
2964 <span class="grey">Woundy &amp; Marez Standards Track [Page 53]</span></pre>
2965 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-54" ></span>
2966 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
2967
2968
2969 from <a href="./rfc3289">RFC 3289</a>."
2970 ::= { docsDevFilter 5 }
2971
2972 docsDevFilterPolicyEntry OBJECT-TYPE
2973 SYNTAX DocsDevFilterPolicyEntry
2974 MAX-ACCESS not-accessible
2975 STATUS deprecated
2976 DESCRIPTION
2977 "An entry in the docsDevFilterPolicyTable. Entries are
2978 created by Network Management. To create an entry,
2979 docsDevFilterPolicyId MUST be specified."
2980 INDEX { docsDevFilterPolicyIndex }
2981 ::= { docsDevFilterPolicyTable 1 }
2982
2983 DocsDevFilterPolicyEntry ::= SEQUENCE {
2984 docsDevFilterPolicyIndex Integer32,
2985 docsDevFilterPolicyId Integer32,
2986 -- docsDevFilterPolicyType INTEGER,
2987 -- docsDevFilterPolicyAction Integer32,
2988 docsDevFilterPolicyStatus RowStatus,
2989 docsDevFilterPolicyPtr RowPointer
2990 }
2991
2992 docsDevFilterPolicyIndex OBJECT-TYPE
2993 SYNTAX Integer32 (1..2147483647)
2994 MAX-ACCESS not-accessible
2995 STATUS deprecated
2996 DESCRIPTION "Index value for the table."
2997 ::= { docsDevFilterPolicyEntry 1 }
2998
2999 docsDevFilterPolicyId OBJECT-TYPE
3000 SYNTAX Integer32 (0..2147483647)
3001 MAX-ACCESS read-create
3002 STATUS deprecated
3003 DESCRIPTION
3004 "Policy ID for this entry. If a policy ID can apply to
3005 multiple rows of this table, all relevant policies are
3006 executed. Policy 0 (if populated) is applied to all
3007 packets that do not match any of the filters. N.B. If
3008 docsDevFilterIpPolicyId is set to 0, it DOES NOT match
3009 policy 0 of this table."
3010 ::= { docsDevFilterPolicyEntry 2 }
3011
3012 -- The following two objects were removed and never used; however,
3013 -- to preserve OID numbering, they are simply commented out to
3014 -- to ensure that they are not used again.
3015 -- docsDevFilterPolicyType ::= { docsDevFilterPolicyEntry 3 }
3016 -- docsDevFilterPolicyAction ::= { docsDevFilterPolicyEntry 4 }
3017
3018
3019
3020 <span class="grey">Woundy &amp; Marez Standards Track [Page 54]</span></pre>
3021 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-55" ></span>
3022 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3023
3024
3025 docsDevFilterPolicyStatus OBJECT-TYPE
3026 SYNTAX RowStatus
3027 MAX-ACCESS read-create
3028 STATUS deprecated
3029 DESCRIPTION
3030 "Object used to create an entry in this table. There is
3031 no restriction in changing any object in a row while
3032 this object is set to active.
3033 The following object MUST have a valid value before this
3034 object can be set to active: docsDevFilterPolicyPtr."
3035 ::= { docsDevFilterPolicyEntry 5 }
3036
3037 docsDevFilterPolicyPtr OBJECT-TYPE
3038 SYNTAX RowPointer
3039 MAX-ACCESS read-create
3040 STATUS deprecated
3041 DESCRIPTION
3042 "This object points to a row in an applicable filter
3043 policy table. Currently, the only standard policy
3044 table is docsDevFilterTosTable.
3045
3046 Per the textual convention, this object points to the
3047 first accessible object in the row; e.g., to point to a
3048 row in docsDevFilterTosTable with an index of 21, the
3049 value of this object would be the object identifier
3050 docsDevTosStatus.21.
3051
3052 Vendors are recommended to adhere to the same convention
3053 when adding vendor-specific policy table extensions.
3054
3055 If this pointer references an empty or non-existent
3056 row, then no policy action is taken.
3057
3058 The default upon row creation is a null pointer that
3059 results in no policy action being taken."
3060 DEFVAL { zeroDotZero }
3061 ::= { docsDevFilterPolicyEntry 6 }
3062
3063 --
3064 -- TOS Policy action table
3065 --
3066
3067 docsDevFilterTosTable OBJECT-TYPE
3068 SYNTAX SEQUENCE OF DocsDevFilterTosEntry
3069 MAX-ACCESS not-accessible
3070 STATUS deprecated
3071 DESCRIPTION
3072 "Table used to describe Type of Service (TOS) bits
3073
3074
3075
3076 <span class="grey">Woundy &amp; Marez Standards Track [Page 55]</span></pre>
3077 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-56" ></span>
3078 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3079
3080
3081 processing.
3082
3083 This table is an adjunct to the docsDevFilterIpTable
3084 and the docsDevFilterPolicy table. Entries in the
3085 latter table can point to specific rows in this (and
3086 other) tables and cause specific actions to be taken.
3087 This table permits the manipulation of the value of the
3088 Type of Service bits in the IP header of the matched
3089 packet as follows:
3090
3091 Set the tosBits of the packet to
3092 (tosBits &amp; docsDevFilterTosAndMask) |
3093 docsDevFilterTosOrMask
3094
3095 This construct allows you to do a clear and set of all
3096 the TOS bits in a flexible manner.
3097
3098 Table entries MUST NOT persist across reboots for any
3099 device.
3100
3101 This table is deprecated. Instead, use the DiffServ MIB
3102 from <a href="./rfc3289">RFC 3289</a>."
3103 ::= { docsDevFilter 6 }
3104
3105 docsDevFilterTosEntry OBJECT-TYPE
3106 SYNTAX DocsDevFilterTosEntry
3107 MAX-ACCESS not-accessible
3108 STATUS deprecated
3109 DESCRIPTION
3110 "A TOS policy entry."
3111 INDEX { docsDevFilterTosIndex }
3112 ::= { docsDevFilterTosTable 1 }
3113
3114 DocsDevFilterTosEntry ::= SEQUENCE {
3115 docsDevFilterTosIndex Integer32,
3116 docsDevFilterTosStatus RowStatus,
3117 docsDevFilterTosAndMask OCTET STRING,
3118 docsDevFilterTosOrMask OCTET STRING
3119 }
3120
3121 docsDevFilterTosIndex OBJECT-TYPE
3122 SYNTAX Integer32 (1..2147483647)
3123 MAX-ACCESS not-accessible
3124 STATUS deprecated
3125 DESCRIPTION
3126 "The unique index for this row. There are no ordering
3127 requirements for this table, and any valid index may be
3128 specified."
3129
3130
3131
3132 <span class="grey">Woundy &amp; Marez Standards Track [Page 56]</span></pre>
3133 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-57" ></span>
3134 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3135
3136
3137 ::= { docsDevFilterTosEntry 1 }
3138
3139 docsDevFilterTosStatus OBJECT-TYPE
3140 SYNTAX RowStatus
3141 MAX-ACCESS read-create
3142 STATUS deprecated
3143 DESCRIPTION
3144 "The object used to create and delete entries in this
3145 table. A row created by specifying just this object
3146 results in a row that specifies no change to the TOS
3147 bits. A row may be created using either the
3148 create-and-go or create-and-wait paradigms. There is
3149 no restriction on the ability to change values in this
3150 row while the row is active."
3151 ::= { docsDevFilterTosEntry 2 }
3152
3153 docsDevFilterTosAndMask OBJECT-TYPE
3154 SYNTAX OCTET STRING (SIZE (1))
3155 MAX-ACCESS read-create
3156 STATUS deprecated
3157 DESCRIPTION
3158 "This value is bitwise ANDed with the matched packet's
3159 TOS bits."
3160 DEFVAL { 'ff'h }
3161 ::= { docsDevFilterTosEntry 3 }
3162
3163 docsDevFilterTosOrMask OBJECT-TYPE
3164 SYNTAX OCTET STRING (SIZE (1))
3165 MAX-ACCESS read-create
3166 STATUS deprecated
3167 DESCRIPTION
3168 "This value is bitwise ORed with the result from the
3169 AND procedure (tosBits &amp; docsDevFilterTosAndMask).
3170 The result then replaces the packet's TOS bits."
3171 DEFVAL { '00'h }
3172 ::= { docsDevFilterTosEntry 4 }
3173
3174 --
3175 -- CPE IP Management and anti-spoofing group. Only implemented on
3176 -- Cable Modems.
3177 --
3178
3179 docsDevCpe OBJECT IDENTIFIER ::= { docsDevMIBObjects 7 }
3180
3181 docsDevCpeEnroll OBJECT-TYPE
3182 SYNTAX INTEGER {
3183 none(1),
3184 any(2)
3185
3186
3187
3188 <span class="grey">Woundy &amp; Marez Standards Track [Page 57]</span></pre>
3189 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-58" ></span>
3190 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3191
3192
3193 }
3194 MAX-ACCESS read-write
3195 STATUS current
3196 DESCRIPTION
3197 "This object controls the population of
3198 docsDevFilterCpeTable.
3199 If set to none, the filters must be set manually
3200 by a network management action (either configuration
3201 or SNMP set).
3202 If set to any, the CM wiretaps the packets originating
3203 from the ethernet and enrolls up to docsDevCpeIpMax
3204 addresses as based on the source IPv4 or v6 addresses of
3205 those packets."
3206 DEFVAL { any }
3207 ::= { docsDevCpe 1 }
3208
3209 docsDevCpeIpMax OBJECT-TYPE
3210 SYNTAX Integer32 (-1..2147483647)
3211 MAX-ACCESS read-write
3212 STATUS current
3213 DESCRIPTION
3214 "This object controls the maximum number of CPEs allowed
3215 to be learned behind this device. If set to zero, any
3216 number of CPEs may connect up to the maximum permitted
3217 for the device.
3218 If set to -1, no filtering is done on CPE source
3219 addresses, and no entries are made in the
3220 docsDevFilterCpeTable via learning. If an attempt is
3221 made to set this to a number greater than that
3222 permitted for the device, it is set to that maximum."
3223 DEFVAL { -1 }
3224 ::= { docsDevCpe 2 }
3225
3226 docsDevCpeTable OBJECT-TYPE
3227 SYNTAX SEQUENCE OF DocsDevCpeEntry
3228 MAX-ACCESS not-accessible
3229 STATUS deprecated
3230 DESCRIPTION
3231 "This table lists the IPv4 addresses seen (or permitted)
3232 as source addresses in packets originating from the
3233 customer interface on this device. In addition, this
3234 table can be provisioned with the specific addresses
3235 permitted for the CPEs via the normal row creation
3236 mechanisms. Table entries MUST NOT persist across
3237 reboots for any device.
3238
3239 N.B. Management action can add entries in this table
3240 and in docsDevCpeIpTable past the value of
3241
3242
3243
3244 <span class="grey">Woundy &amp; Marez Standards Track [Page 58]</span></pre>
3245 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-59" ></span>
3246 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3247
3248
3249 docsDevCpeIpMax. docsDevCpeIpMax ONLY restricts the
3250 ability of the CM to add learned addresses
3251 automatically.
3252
3253 This table is deprecated and is replaced by
3254 docsDevCpeInetTable."
3255 ::= { docsDevCpe 3 }
3256
3257 docsDevCpeEntry OBJECT-TYPE
3258 SYNTAX DocsDevCpeEntry
3259 MAX-ACCESS not-accessible
3260 STATUS deprecated
3261 DESCRIPTION
3262 "An entry in the docsDevFilterCpeTable. There is one
3263 entry for each IPv4 CPE seen or provisioned. If
3264 docsDevCpeIpMax is set to -1, this table is ignored;
3265 otherwise, upon receipt of an IP packet from the
3266 customer interface of the CM, the source IP address is
3267 checked against this table. If the address is in the
3268 table, packet processing continues. If the address is
3269 not in the table but docsDevCpeEnroll is set to any
3270 and the sum of the table sizes of docsDevCpeTable and
3271 docsDevCpeInetTable is less than docsDevCpeIpMax, the
3272 address is added to the table, and packet processing
3273 continues. Otherwise, the packet is dropped.
3274
3275 The filtering actions specified by this table occur
3276 after any LLC filtering (docsDevFilterLLCTable), but
3277 prior to any IP filtering (docsDevFilterIpTable,
3278 docsDevNmAccessTable)."
3279 INDEX { docsDevCpeIp }
3280 ::= {docsDevCpeTable 1 }
3281
3282 DocsDevCpeEntry ::= SEQUENCE {
3283 docsDevCpeIp IpAddress,
3284 docsDevCpeSource INTEGER,
3285 docsDevCpeStatus RowStatus
3286 }
3287
3288 docsDevCpeIp OBJECT-TYPE
3289 SYNTAX IpAddress
3290 MAX-ACCESS not-accessible
3291 STATUS deprecated
3292 DESCRIPTION
3293 "The IPv4 address to which this entry applies.
3294
3295 N.B. Attempts to set all zeros or all ones address
3296 values MUST be rejected."
3297
3298
3299
3300 <span class="grey">Woundy &amp; Marez Standards Track [Page 59]</span></pre>
3301 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-60" ></span>
3302 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3303
3304
3305 ::= { docsDevCpeEntry 1 }
3306
3307 docsDevCpeSource OBJECT-TYPE
3308 SYNTAX INTEGER {
3309 other(1),
3310 manual(2),
3311 learned(3)
3312 }
3313
3314 MAX-ACCESS read-only
3315 STATUS deprecated
3316 DESCRIPTION
3317 "This object describes how this entry was created. If
3318 the value is manual(2), this row was created by a
3319 network management action (either configuration or
3320 SNMP set). If set to learned(3), then it was found via
3321 looking at the source IPv4 address of a received packet.
3322 The value other(1) is used for any entries that do not
3323 meet manual(2) or learned(3) criteria."
3324 ::= { docsDevCpeEntry 2 }
3325
3326 docsDevCpeStatus OBJECT-TYPE
3327 SYNTAX RowStatus
3328 MAX-ACCESS read-create
3329 STATUS deprecated
3330 DESCRIPTION
3331 "Standard object to manipulate rows. To create a row in
3332 this table, one only needs to specify this object.
3333 Management stations SHOULD use the create-and-go
3334 mechanism for creating rows in this table."
3335 ::= { docsDevCpeEntry 3 }
3336
3337 --
3338 -- Internet CPE Management and anti spoofing group, for support of
3339 -- non-IPv4 CPEs.
3340 --
3341
3342 docsDevCpeInetTable OBJECT-TYPE
3343 SYNTAX SEQUENCE OF DocsDevCpeInetEntry
3344 MAX-ACCESS not-accessible
3345 STATUS current
3346 DESCRIPTION
3347 "This table lists the IP addresses seen (or permitted) as
3348 source addresses in packets originating from the
3349 customer interface on this device. In addition, this
3350 table can be provisioned with the specific addresses
3351 permitted for the CPEs via the normal row creation
3352 mechanisms.
3353
3354
3355
3356 <span class="grey">Woundy &amp; Marez Standards Track [Page 60]</span></pre>
3357 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-61" ></span>
3358 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3359
3360
3361 N.B. Management action can add entries in this table
3362 and in docsDevCpeIpTable past the value of
3363 docsDevCpeIpMax. docsDevCpeIpMax ONLY restricts the
3364 ability of the CM to add learned addresses
3365 automatically.
3366
3367 Table entries MUST NOT persist across reboots for any
3368 device.
3369
3370 This table exactly mirrors docsDevCpeTable and applies
3371 to IPv4 and IPv6 addresses."
3372 ::= { docsDevCpe 4 }
3373
3374 docsDevCpeInetEntry OBJECT-TYPE
3375 SYNTAX DocsDevCpeInetEntry
3376 MAX-ACCESS not-accessible
3377 STATUS current
3378 DESCRIPTION
3379 "An entry in the docsDevFilterCpeInetTable. There is one
3380 entry for each IP CPE seen or provisioned. If
3381 docsDevCpeIpMax is set to -1, this table is ignored;
3382 otherwise, upon receipt of an IP packet from the
3383 customer interface of the CM, the source IP address is
3384 checked against this table. If the address is in the
3385 table, packet processing continues. If the address is
3386 not in the table but docsDevCpeEnroll is set to any and
3387 the sum of the table sizes for docsDevCpeTable and
3388 docsDevCpeInetTable is less than docsDevCpeIpMax, the
3389 address is added to the table, and packet processing
3390 continues. Otherwise, the packet is dropped.
3391
3392 The filtering actions specified by this table occur
3393 after any LLC filtering (docsDevFilterLLCTable), but
3394 prior to any IP filtering (docsDevFilterIpTable,
3395 docsDevNmAccessTable).
3396
3397 When an agent (cable modem) restarts, then all
3398 dynamically created rows are lost."
3399 INDEX { docsDevCpeInetType, docsDevCpeInetAddr }
3400 ::= { docsDevCpeInetTable 1 }
3401
3402 DocsDevCpeInetEntry ::= SEQUENCE {
3403 docsDevCpeInetType InetAddressType,
3404 docsDevCpeInetAddr InetAddress,
3405 docsDevCpeInetSource INTEGER,
3406 docsDevCpeInetRowStatus RowStatus
3407 }
3408
3409
3410
3411
3412 <span class="grey">Woundy &amp; Marez Standards Track [Page 61]</span></pre>
3413 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-62" ></span>
3414 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3415
3416
3417 docsDevCpeInetType OBJECT-TYPE
3418 SYNTAX InetAddressType
3419 MAX-ACCESS not-accessible
3420 STATUS current
3421 DESCRIPTION
3422 "The type of internet address of docsDevCpeInetAddr."
3423 ::= { docsDevCpeInetEntry 1 }
3424
3425 docsDevCpeInetAddr OBJECT-TYPE
3426 SYNTAX InetAddress
3427 MAX-ACCESS not-accessible
3428 STATUS current
3429 DESCRIPTION
3430 "The Internet address to which this entry applies.
3431
3432 Implementors need to be aware that if the size of
3433 docsDevCpeInetAddr exceeds 114 octets OIDs of
3434 instances of columns in this row will have more
3435 than 128 sub-identifiers and cannot be accessed
3436 using SNMPv1, SNMPv2c, or SNMPv3. Only unicast
3437 address are allowed for this object."
3438 ::= { docsDevCpeInetEntry 2 }
3439
3440 docsDevCpeInetSource OBJECT-TYPE
3441 SYNTAX INTEGER {
3442 manual(2),
3443 learned(3)
3444 }
3445 MAX-ACCESS read-only
3446 STATUS current
3447 DESCRIPTION
3448 "This object describes how this entry was created. If
3449 the value is manual(2), this row was created by a
3450 network management action (either configuration or
3451 SNMP set). If set to learned(3), then it was found
3452 via looking at the source IP address of a received
3453 packet."
3454 ::= { docsDevCpeInetEntry 3 }
3455
3456 docsDevCpeInetRowStatus OBJECT-TYPE
3457 SYNTAX RowStatus
3458 MAX-ACCESS read-create
3459 STATUS current
3460 DESCRIPTION
3461 "Standard object to manipulate rows. To create a row in
3462 this table, one only needs to specify this object.
3463 Management stations SHOULD use the create-and-go
3464 mechanism for creating rows in this table."
3465
3466
3467
3468 <span class="grey">Woundy &amp; Marez Standards Track [Page 62]</span></pre>
3469 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-63" ></span>
3470 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3471
3472
3473 ::= { docsDevCpeInetEntry 4 }
3474
3475
3476 --
3477 -- Placeholder for notifications/traps.
3478 --
3479
3480 -- erroneous, DO NOT USE docsDevNotification
3481 docsDevNotification OBJECT IDENTIFIER ::= { docsDev 2 }
3482 -- erroneous, DO NOT USE docsDevNotification
3483
3484 docsDevNotifications OBJECT IDENTIFIER ::= { docsDev 0 }
3485
3486
3487 --
3488 -- <a href="./rfc2669">RFC 2669</a> Conformance definitions
3489 --
3490
3491 docsDevConformance OBJECT IDENTIFIER ::= { docsDev 3 }
3492 docsDevGroups OBJECT IDENTIFIER ::= { docsDevConformance 1 }
3493 docsDevCompliances OBJECT IDENTIFIER ::= { docsDevConformance 2 }
3494
3495 docsDevBasicCompliance MODULE-COMPLIANCE
3496 STATUS deprecated
3497 DESCRIPTION
3498 "The <a href="./rfc2669">RFC 2669</a> compliance statement for MCNS/DOCSIS
3499 Cable Modems and Cable Modem Termination Systems."
3500
3501 MODULE -- docsDev
3502
3503 -- conditionally mandatory groups
3504
3505 GROUP docsDevBaseGroup
3506 DESCRIPTION
3507 "Mandatory in Cable Modems, optional in Cable Modem
3508 Termination Systems."
3509
3510 GROUP docsDevEventGroup
3511 DESCRIPTION
3512 "Mandatory in Cable Modems, optional in Cable Modem
3513 Termination Systems."
3514
3515 GROUP docsDevFilterGroup
3516 DESCRIPTION
3517 "Mandatory in Cable Modems, optional in Cable Modem
3518 Termination Systems."
3519
3520 GROUP docsDevNmAccessGroup
3521
3522
3523
3524 <span class="grey">Woundy &amp; Marez Standards Track [Page 63]</span></pre>
3525 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-64" ></span>
3526 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3527
3528
3529 DESCRIPTION
3530 "This group is only implemented in devices that do not
3531 implement the SNMPv3 User Security Model. It SHOULD NOT
3532 be implemented by devices that conform to SNMPv3.
3533
3534 For devices that do not implement SNMPv3 or later, this
3535 group is Mandatory in Cable Modems and is optional
3536 in Cable Modem Termination Systems."
3537
3538 GROUP docsDevServerGroup
3539 DESCRIPTION
3540 "This group is implemented only in Cable Modems, and is
3541 not implemented in Cable Modem Termination Systems."
3542
3543 GROUP docsDevSoftwareGroup
3544 DESCRIPTION
3545 "This group is Mandatory in Cable Modems and optional in
3546 Cable Modem Termination Systems."
3547
3548 GROUP docsDevCpeGroup
3549 DESCRIPTION
3550 "This group is Mandatory in Cable Modems, and is
3551 not implemented in Cable Modem Termination Systems."
3552
3553 OBJECT docsDevSTPControl
3554 MIN-ACCESS read-only
3555 DESCRIPTION
3556 "It is compliant to implement this object as read-only.
3557 Devices need only support noStFilterBpdu(2)."
3558
3559 OBJECT docsDevNmAccessIp
3560 DESCRIPTION
3561 "It is compliant to recognize the IP address
3562 255.255.255.255 as referring to any NMS."
3563
3564 OBJECT docsDevEvReporting
3565 MIN-ACCESS read-only
3566 DESCRIPTION
3567 "It is compliant to implement this object as read-only.
3568 Devices need only support local(0). An agent need not
3569 enforce that trap or syslog logging be accompanied
3570 by local(0) or localVolatile(3) logging."
3571 ::= { docsDevCompliances 1 }
3572
3573 docsDevBaseGroup OBJECT-GROUP
3574 OBJECTS {
3575 docsDevRole,
3576 docsDevDateTime,
3577
3578
3579
3580 <span class="grey">Woundy &amp; Marez Standards Track [Page 64]</span></pre>
3581 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-65" ></span>
3582 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3583
3584
3585 docsDevResetNow,
3586 docsDevSerialNumber,
3587 docsDevSTPControl
3588 }
3589 STATUS current
3590 DESCRIPTION
3591 "A collection of objects providing device status and
3592 control."
3593 ::= { docsDevGroups 1 }
3594
3595 docsDevNmAccessGroup OBJECT-GROUP
3596 OBJECTS {
3597 docsDevNmAccessIp,
3598 docsDevNmAccessIpMask,
3599 docsDevNmAccessCommunity,
3600 docsDevNmAccessControl,
3601 docsDevNmAccessInterfaces,
3602 docsDevNmAccessStatus
3603 }
3604 STATUS deprecated
3605 DESCRIPTION
3606 "A collection of objects for controlling access to SNMP
3607 objects on cable devices.
3608
3609 This group has been deprecated because all the
3610 objects have been deprecated in favor of SNMPv3 and
3611 Coexistence MIBs."
3612 ::= { docsDevGroups 2 }
3613
3614 docsDevSoftwareGroup OBJECT-GROUP
3615 OBJECTS {
3616 docsDevSwServer,
3617 docsDevSwFilename,
3618 docsDevSwAdminStatus,
3619 docsDevSwOperStatus,
3620 docsDevSwCurrentVers
3621 }
3622 STATUS deprecated
3623 DESCRIPTION
3624 "A collection of objects for controlling software
3625 downloads.
3626
3627 This group has been deprecated and replaced by
3628 docsDevSoftwareGroupV2. Object docsDevSwServer
3629 has been replaced by docsDevSwServerAddressType
3630 and docsDevSwServerAddress, and
3631 docsDevSwServerTransportProtocol has been added to
3632 support TFTP and HTTP firmware downloads."
3633
3634
3635
3636 <span class="grey">Woundy &amp; Marez Standards Track [Page 65]</span></pre>
3637 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-66" ></span>
3638 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3639
3640
3641 ::= { docsDevGroups 3 }
3642
3643 docsDevServerGroup OBJECT-GROUP
3644 OBJECTS {
3645 docsDevServerBootState,
3646 docsDevServerDhcp,
3647 docsDevServerTime,
3648 docsDevServerTftp,
3649 docsDevServerConfigFile
3650 }
3651 STATUS deprecated
3652 DESCRIPTION
3653 "A collection of objects providing status about server
3654 provisioning.
3655
3656 This group has been deprecated and replaced by
3657 docsDevServerGroupV2. The objects docsDevServerDhcp,
3658 docsDevServerTime, and docsDevServerTftp have
3659 been replaced by docsDevServerDhcpAddressType,
3660 docsDevServerDhcpAddress, docsDevServerTimeAddressType,
3661 docsDevServerTimeAddress,
3662 docsDevServerConfigTftpAddressType, and
3663 docsDevServerConfigTftpAddress."
3664 ::= { docsDevGroups 4 }
3665
3666 docsDevEventGroup OBJECT-GROUP
3667 OBJECTS {
3668 docsDevEvControl,
3669 docsDevEvSyslog,
3670 docsDevEvThrottleAdminStatus,
3671 docsDevEvThrottleInhibited,
3672 docsDevEvThrottleThreshold,
3673 docsDevEvThrottleInterval,
3674 docsDevEvReporting,
3675 docsDevEvFirstTime,
3676 docsDevEvLastTime,
3677 docsDevEvCounts,
3678 docsDevEvLevel,
3679 docsDevEvId,
3680 docsDevEvText
3681 }
3682 STATUS deprecated
3683 DESCRIPTION
3684 "A collection of objects used to control and monitor
3685 events.
3686
3687 This group has been deprecated and replaced by
3688 docsDevEventGroupV2. The object docsDevEvSyslog has
3689
3690
3691
3692 <span class="grey">Woundy &amp; Marez Standards Track [Page 66]</span></pre>
3693 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-67" ></span>
3694 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3695
3696
3697 been replaced by docsDevEvSyslogAddressType and
3698 docsDevEvSyslogAddress, and docsDevEvThrottleInhibited
3699 has been replaced by
3700 docsDevEvThrottleThresholdExceeded."
3701 ::= { docsDevGroups 5 }
3702
3703 docsDevFilterGroup OBJECT-GROUP
3704 OBJECTS {
3705 docsDevFilterLLCUnmatchedAction,
3706 docsDevFilterIpDefault,
3707 docsDevFilterLLCStatus,
3708 docsDevFilterLLCIfIndex,
3709 docsDevFilterLLCProtocolType,
3710 docsDevFilterLLCProtocol,
3711 docsDevFilterLLCMatches,
3712 docsDevFilterIpControl,
3713 docsDevFilterIpIfIndex,
3714 docsDevFilterIpStatus,
3715 docsDevFilterIpDirection,
3716 docsDevFilterIpBroadcast,
3717 docsDevFilterIpSaddr,
3718 docsDevFilterIpSmask,
3719 docsDevFilterIpDaddr,
3720 docsDevFilterIpDmask,
3721 docsDevFilterIpProtocol,
3722 docsDevFilterIpSourcePortLow,
3723 docsDevFilterIpSourcePortHigh,
3724 docsDevFilterIpDestPortLow,
3725 docsDevFilterIpDestPortHigh,
3726 docsDevFilterIpMatches,
3727 docsDevFilterIpTos,
3728 docsDevFilterIpTosMask,
3729 docsDevFilterIpContinue,
3730 docsDevFilterIpPolicyId,
3731 docsDevFilterPolicyId,
3732 docsDevFilterPolicyStatus,
3733 docsDevFilterPolicyPtr,
3734 docsDevFilterTosStatus,
3735 docsDevFilterTosAndMask,
3736 docsDevFilterTosOrMask
3737 }
3738 STATUS deprecated
3739 DESCRIPTION
3740 "A collection of objects to specify filters at the link
3741 layer and IPv4 layer.
3742
3743 This group has been deprecated and replaced by various
3744 groups from the DiffServ MIB."
3745
3746
3747
3748 <span class="grey">Woundy &amp; Marez Standards Track [Page 67]</span></pre>
3749 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-68" ></span>
3750 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3751
3752
3753 ::= { docsDevGroups 6 }
3754
3755 docsDevCpeGroup OBJECT-GROUP
3756 OBJECTS {
3757 docsDevCpeEnroll,
3758 docsDevCpeIpMax,
3759 docsDevCpeSource,
3760 docsDevCpeStatus
3761 }
3762 STATUS deprecated
3763 DESCRIPTION
3764 "A collection of objects used to control the number
3765 and specific values of IPv4 addresses allowed for
3766 associated Customer Premises Equipment (CPE).
3767
3768 This group has been deprecated and replaced by
3769 docsDevInetCpeGroup. The object docsDevCpeSource has
3770 been replaced by docsDevCpeInetSource, and
3771 docsDevCpeStatus has been replaced by
3772 docsDevCpeInetRowStatus."
3773 ::= { docsDevGroups 7 }
3774
3775 --
3776 -- <a href="./rfc4639">RFC 4639</a> Conformance definitions
3777 --
3778
3779 docsDevGroupsV2 OBJECT IDENTIFIER ::= { docsDevConformance 3 }
3780 docsDevCompliancesV2 OBJECT IDENTIFIER ::= { docsDevConformance 4 }
3781
3782 docsDevCmCompliance MODULE-COMPLIANCE
3783 STATUS current
3784 DESCRIPTION
3785 "The compliance statement for DOCSIS Cable Modems.
3786
3787 This compliance statement applies to implementations
3788 of DOCSIS versions that are not IPv6 capable."
3789
3790 MODULE DIFFSERV-MIB -- <a href="./rfc3289">RFC 3289</a>
3791
3792 MANDATORY-GROUPS {
3793 diffServMIBDataPathGroup,
3794 diffServMIBClfrGroup,
3795 diffServMIBClfrElementGroup,
3796 diffServMIBMultiFieldClfrGroup,
3797 diffServMIBActionGroup,
3798 diffServMIBDscpMarkActGroup,
3799 diffServMIBCounterGroup,
3800 diffServMIBAlgDropGroup
3801
3802
3803
3804 <span class="grey">Woundy &amp; Marez Standards Track [Page 68]</span></pre>
3805 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-69" ></span>
3806 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3807
3808
3809 }
3810
3811 OBJECT diffServDataPathStatus -- same as <a href="./rfc3289">RFC 3289</a>
3812 SYNTAX RowStatus { active(1) }
3813 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
3814 DESCRIPTION
3815 "Support for createAndWait and notInService is not
3816 required."
3817
3818 OBJECT diffServClfrStatus -- same as <a href="./rfc3289">RFC 3289</a>
3819 SYNTAX RowStatus { active(1) }
3820 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
3821 DESCRIPTION
3822 "Support for createAndWait and notInService is not
3823 required."
3824
3825 OBJECT diffServClfrElementStatus -- same as <a href="./rfc3289">RFC 3289</a>
3826 SYNTAX RowStatus { active(1) }
3827 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
3828 DESCRIPTION
3829 "Support for createAndWait and notInService is not
3830 required."
3831
3832 OBJECT diffServMultiFieldClfrAddrType
3833 SYNTAX InetAddressType { ipv4(1) }
3834 DESCRIPTION
3835 "An implementation is only required to support IPv4
3836 addresses."
3837
3838 OBJECT diffServMultiFieldClfrSrcAddr
3839 SYNTAX InetAddress (SIZE(4))
3840 DESCRIPTION
3841 "An implementation is only required to support IPv4
3842 addresses."
3843
3844 OBJECT diffServMultiFieldClfrDstAddr
3845 SYNTAX InetAddress (SIZE(4))
3846 DESCRIPTION
3847 "An implementation is only required to support IPv4
3848 addresses."
3849
3850 OBJECT diffServAlgDropStatus -- same as <a href="./rfc3289">RFC 3289</a>
3851 SYNTAX RowStatus { active(1) }
3852 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
3853 DESCRIPTION
3854 "Support for createAndWait and notInService is not
3855 required."
3856
3857
3858
3859
3860 <span class="grey">Woundy &amp; Marez Standards Track [Page 69]</span></pre>
3861 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-70" ></span>
3862 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3863
3864
3865 OBJECT diffServDataPathStorage
3866 SYNTAX StorageType { volatile(2) }
3867 DESCRIPTION
3868 "An implementation is only required to support
3869 volatile storage."
3870
3871 OBJECT diffServClfrStorage
3872 SYNTAX StorageType { volatile(2) }
3873 DESCRIPTION
3874 "An implementation is only required to support
3875 volatile storage."
3876
3877 OBJECT diffServClfrElementStorage
3878 SYNTAX StorageType { volatile(2) }
3879 DESCRIPTION
3880 "An implementation is only required to support
3881 volatile storage."
3882
3883 OBJECT diffServMultiFieldClfrStorage
3884 SYNTAX StorageType { volatile(2) }
3885 DESCRIPTION
3886 "An implementation is only required to support
3887 volatile storage."
3888
3889 OBJECT diffServActionStorage
3890 SYNTAX StorageType { volatile(2) }
3891 DESCRIPTION
3892 "An implementation is only required to support
3893 volatile storage."
3894
3895 OBJECT diffServCountActStorage
3896 SYNTAX StorageType { volatile(2) }
3897 DESCRIPTION
3898 "An implementation is only required to support
3899 volatile storage."
3900
3901 OBJECT diffServAlgDropStorage
3902 SYNTAX StorageType { volatile(2) }
3903 DESCRIPTION
3904 "An implementation is only required to support
3905 volatile storage."
3906
3907 OBJECT diffServAlgDropType
3908 SYNTAX INTEGER { alwaysDrop(5) }
3909 DESCRIPTION
3910 "This object is only used to provide packet
3911 filtering. Implementations need not support other
3912 values of this enumeration."
3913
3914
3915
3916 <span class="grey">Woundy &amp; Marez Standards Track [Page 70]</span></pre>
3917 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-71" ></span>
3918 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3919
3920
3921 MODULE -- docsDev
3922
3923 MANDATORY-GROUPS {
3924 docsDevBaseGroup,
3925 docsDevBaseIgmpGroup,
3926 docsDevBaseMaxCpeGroup,
3927 docsDevSoftwareGroupV2,
3928 docsDevServerGroupV2,
3929 docsDevEventGroupV2,
3930 docsDevFilterLLCGroup
3931 }
3932
3933 -- conditionally mandatory groups
3934
3935 GROUP docsDevInetCpeGroup
3936 DESCRIPTION
3937 "This group is optional in Cable Modems."
3938
3939 OBJECT docsDevDateTime
3940 MIN-ACCESS read-only
3941 DESCRIPTION
3942 "It is compliant to implement this object as read-only."
3943
3944 OBJECT docsDevSTPControl
3945 SYNTAX INTEGER { noStFilterBpdu(2) }
3946 MIN-ACCESS read-only
3947 DESCRIPTION
3948 "It is compliant to implement this object as read-only.
3949 Devices need only support noStFilterBpdu(2)."
3950
3951 OBJECT docsDevIgmpModeControl
3952 SYNTAX INTEGER { passive(1) }
3953 MIN-ACCESS read-only
3954 DESCRIPTION
3955 "It is compliant to implement this object as read-only.
3956 Devices need only support passive(1)."
3957
3958 OBJECT docsDevSwServerAddressType
3959 SYNTAX InetAddressType { ipv4(1) }
3960 DESCRIPTION
3961 "An implementation is only required to support IPv4
3962 addresses."
3963
3964 OBJECT docsDevSwServerAddress
3965 SYNTAX InetAddress (SIZE(4))
3966 DESCRIPTION
3967 "An implementation is only required to support IPv4
3968 addresses."
3969
3970
3971
3972 <span class="grey">Woundy &amp; Marez Standards Track [Page 71]</span></pre>
3973 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-72" ></span>
3974 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
3975
3976
3977 OBJECT docsDevServerDhcpAddressType
3978 SYNTAX InetAddressType { ipv4(1) }
3979 DESCRIPTION
3980 "An implementation is only required to support IPv4
3981 addresses."
3982
3983 OBJECT docsDevServerDhcpAddress
3984 SYNTAX InetAddress (SIZE(4))
3985 DESCRIPTION
3986 "An implementation is only required to support IPv4
3987 addresses."
3988
3989 OBJECT docsDevServerTimeAddressType
3990 SYNTAX InetAddressType { ipv4(1) }
3991 DESCRIPTION
3992 "An implementation is only required to support IPv4
3993 addresses."
3994
3995 OBJECT docsDevServerTimeAddress
3996 SYNTAX InetAddress (SIZE(4))
3997 DESCRIPTION
3998 "An implementation is only required to support IPv4
3999 addresses."
4000
4001 OBJECT docsDevServerConfigTftpAddressType
4002 SYNTAX InetAddressType { ipv4(1) }
4003 DESCRIPTION
4004 "An implementation is only required to support IPv4
4005 addresses."
4006
4007 OBJECT docsDevServerConfigTftpAddress
4008 SYNTAX InetAddress (SIZE(4))
4009 DESCRIPTION
4010 "An implementation is only required to support IPv4
4011 addresses."
4012
4013 OBJECT docsDevEvReporting
4014 MIN-ACCESS read-only
4015 DESCRIPTION
4016 "It is compliant to implement this object as read-only.
4017 Devices need only support local(0)."
4018
4019 OBJECT docsDevEvSyslogAddressType
4020 SYNTAX InetAddressType { ipv4(1) }
4021 DESCRIPTION
4022 "An implementation is only required to support IPv4
4023 addresses."
4024
4025
4026
4027
4028 <span class="grey">Woundy &amp; Marez Standards Track [Page 72]</span></pre>
4029 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-73" ></span>
4030 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4031
4032
4033 OBJECT docsDevEvSyslogAddress
4034 SYNTAX InetAddress (SIZE(4))
4035 DESCRIPTION
4036 "An implementation is only required to support IPv4
4037 addresses."
4038
4039 OBJECT docsDevSwServerTransportProtocol
4040 SYNTAX INTEGER { tftp(1) }
4041 DESCRIPTION
4042 "An implementation is only required to support TFTP
4043 software image downloads."
4044
4045 ::= { docsDevCompliancesV2 1 }
4046
4047 docsDevCmtsCompliance MODULE-COMPLIANCE
4048 STATUS current
4049 DESCRIPTION
4050 "The compliance statement for DOCSIS Cable Modem
4051 Termination Systems.
4052
4053 This compliance statement applies to implementations
4054 of DOCSIS versions that are not IPv6 capable."
4055
4056 MODULE -- docsDev
4057
4058 -- conditionally mandatory groups
4059
4060 GROUP docsDevBaseGroup
4061 DESCRIPTION
4062 "Optional in Cable Modem Termination Systems."
4063
4064 GROUP docsDevBaseIgmpGroup
4065 DESCRIPTION
4066 "Optional in Cable Modem Termination Systems."
4067
4068 GROUP docsDevBaseMaxCpeGroup
4069 DESCRIPTION
4070 "This group MUST NOT be implemented in Cable Modem
4071 Termination Systems."
4072
4073 GROUP docsDevSoftwareGroupV2
4074 DESCRIPTION
4075 "Optional in Cable Modem Termination Systems."
4076
4077 GROUP docsDevServerGroupV2
4078 DESCRIPTION
4079 "This group MUST NOT be implemented in Cable Modem
4080 Termination Systems."
4081
4082
4083
4084 <span class="grey">Woundy &amp; Marez Standards Track [Page 73]</span></pre>
4085 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-74" ></span>
4086 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4087
4088
4089 GROUP docsDevEventGroupV2
4090 DESCRIPTION
4091 "Optional in Cable Modem Termination Systems."
4092
4093 GROUP docsDevFilterLLCGroup
4094 DESCRIPTION
4095 "This group MUST NOT be implemented in Cable Modem
4096 Termination Systems. See the Subscriber Management
4097 MIB for similar CMTS capability."
4098
4099 GROUP docsDevInetCpeGroup
4100 DESCRIPTION
4101 "This group MUST NOT be implemented in Cable Modem
4102 Termination Systems. See the Subscriber Management
4103 MIB for similar CMTS capability."
4104
4105 OBJECT docsDevDateTime
4106 MIN-ACCESS read-only
4107 DESCRIPTION
4108 "It is compliant to implement this object as read-only."
4109
4110 OBJECT docsDevSTPControl
4111 SYNTAX INTEGER { noStFilterBpdu(2) }
4112 MIN-ACCESS read-only
4113 DESCRIPTION
4114 "It is compliant to implement this object as read-only.
4115 Devices need only support noStFilterBpdu(2)."
4116
4117 OBJECT docsDevIgmpModeControl
4118 SYNTAX INTEGER { passive(1) }
4119 MIN-ACCESS read-only
4120 DESCRIPTION
4121 "It is compliant to implement this object as read-only.
4122 Devices need only support passive(1)."
4123
4124 OBJECT docsDevSwServerAddressType
4125 SYNTAX InetAddressType { ipv4(1) }
4126 DESCRIPTION
4127 "An implementation is only required to support IPv4
4128 addresses."
4129
4130 OBJECT docsDevSwServerAddress
4131 SYNTAX InetAddress (SIZE(4))
4132 DESCRIPTION
4133 "An implementation is only required to support IPv4
4134 addresses."
4135
4136 OBJECT docsDevEvReporting
4137
4138
4139
4140 <span class="grey">Woundy &amp; Marez Standards Track [Page 74]</span></pre>
4141 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-75" ></span>
4142 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4143
4144
4145 MIN-ACCESS read-only
4146 DESCRIPTION
4147 "It is compliant to implement this object as read-only.
4148 Devices need only support local(0)."
4149
4150 OBJECT docsDevEvSyslogAddressType
4151 SYNTAX InetAddressType { ipv4(1) }
4152 DESCRIPTION
4153 "An implementation is only required to support IPv4
4154 addresses."
4155
4156 OBJECT docsDevEvSyslogAddress
4157 SYNTAX InetAddress (SIZE(4))
4158 DESCRIPTION
4159 "An implementation is only required to support IPv4
4160 addresses."
4161
4162 OBJECT docsDevSwServerTransportProtocol
4163 SYNTAX INTEGER { tftp(1) }
4164 DESCRIPTION
4165 "An implementation is only required to support TFTP
4166 software image downloads."
4167
4168 ::= { docsDevCompliancesV2 2 }
4169
4170 docsDevBaseIgmpGroup OBJECT-GROUP
4171 OBJECTS {
4172 docsDevIgmpModeControl
4173 }
4174 STATUS current
4175 DESCRIPTION
4176 "An object providing cable device IGMP status and
4177 control."
4178 ::= { docsDevGroupsV2 1 }
4179
4180 docsDevBaseMaxCpeGroup OBJECT-GROUP
4181 OBJECTS {
4182 docsDevMaxCpe
4183 }
4184 STATUS current
4185 DESCRIPTION
4186 "An object providing management of the maximum number of
4187 CPEs permitted access through a cable modem."
4188 ::= { docsDevGroupsV2 2 }
4189
4190 docsDevNmAccessExtGroup OBJECT-GROUP
4191 OBJECTS {
4192 docsDevNmAccessTrapVersion
4193
4194
4195
4196 <span class="grey">Woundy &amp; Marez Standards Track [Page 75]</span></pre>
4197 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-76" ></span>
4198 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4199
4200
4201 }
4202 STATUS deprecated
4203 DESCRIPTION
4204 "An object, in addition to the objects in
4205 docsDevNmAccessGroup, for controlling access to
4206 SNMP objects on cable devices.
4207
4208 This group is included in this MIB due to existing
4209 implementations of docsDevNmAccessTrapVersion in
4210 DOCSIS cable modems.
4211
4212 This group has been deprecated because the object has
4213 been deprecated in favor of SNMPv3 and Coexistence
4214 MIBs."
4215 ::= { docsDevGroupsV2 3 }
4216
4217 docsDevSoftwareGroupV2 OBJECT-GROUP
4218 OBJECTS {
4219 docsDevSwFilename,
4220 docsDevSwAdminStatus,
4221 docsDevSwOperStatus,
4222 docsDevSwCurrentVers,
4223 docsDevSwServerAddressType,
4224 docsDevSwServerAddress,
4225 docsDevSwServerTransportProtocol
4226 }
4227 STATUS current
4228 DESCRIPTION
4229 "A collection of objects for controlling software
4230 downloads. This group replaces docsDevSoftwareGroup."
4231 ::= { docsDevGroupsV2 4 }
4232
4233 docsDevServerGroupV2 OBJECT-GROUP
4234 OBJECTS {
4235 docsDevServerBootState,
4236 docsDevServerDhcpAddressType,
4237 docsDevServerDhcpAddress,
4238 docsDevServerTimeAddressType,
4239 docsDevServerTimeAddress,
4240 docsDevServerConfigTftpAddressType,
4241 docsDevServerConfigTftpAddress,
4242 docsDevServerConfigFile
4243 }
4244 STATUS current
4245 DESCRIPTION
4246 "A collection of objects providing status about server
4247 provisioning. This group replaces docsDevServerGroup."
4248 ::= { docsDevGroupsV2 5 }
4249
4250
4251
4252 <span class="grey">Woundy &amp; Marez Standards Track [Page 76]</span></pre>
4253 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-77" ></span>
4254 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4255
4256
4257 docsDevEventGroupV2 OBJECT-GROUP
4258 OBJECTS {
4259 docsDevEvControl,
4260 docsDevEvThrottleAdminStatus,
4261 docsDevEvThrottleThreshold,
4262 docsDevEvThrottleInterval,
4263 docsDevEvReporting,
4264 docsDevEvFirstTime,
4265 docsDevEvLastTime,
4266 docsDevEvCounts,
4267 docsDevEvLevel,
4268 docsDevEvId,
4269 docsDevEvText,
4270 docsDevEvSyslogAddressType,
4271 docsDevEvSyslogAddress,
4272 docsDevEvThrottleThresholdExceeded
4273 }
4274 STATUS current
4275 DESCRIPTION
4276 "A collection of objects used to control and monitor
4277 events. This group replaces docsDevEventGroup.
4278 The event reporting mechanism, and more specifically
4279 docsDevEvReporting, can be used to take advantage of
4280 the event reporting features of <a href="./rfc3413">RFC3413</a> and <a href="./rfc3014">RFC3014</a>."
4281 ::= { docsDevGroupsV2 6 }
4282
4283 docsDevFilterLLCGroup OBJECT-GROUP
4284 OBJECTS {
4285 docsDevFilterLLCUnmatchedAction,
4286 docsDevFilterLLCStatus,
4287 docsDevFilterLLCIfIndex,
4288 docsDevFilterLLCProtocolType,
4289 docsDevFilterLLCProtocol,
4290 docsDevFilterLLCMatches
4291 }
4292 STATUS current
4293 DESCRIPTION
4294 "A collection of objects to specify link layer filters."
4295 ::= { docsDevGroupsV2 7 }
4296
4297 docsDevInetCpeGroup OBJECT-GROUP
4298 OBJECTS {
4299 docsDevCpeEnroll,
4300 docsDevCpeIpMax,
4301 docsDevCpeInetSource,
4302 docsDevCpeInetRowStatus
4303 }
4304 STATUS current
4305
4306
4307
4308 <span class="grey">Woundy &amp; Marez Standards Track [Page 77]</span></pre>
4309 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-78" ></span>
4310 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4311
4312
4313 DESCRIPTION
4314 "A collection of objects used to control the number
4315 and specific values of Internet (e.g., IPv4 and IPv6)
4316 addresses allowed for associated Customer Premises
4317 Equipment (CPE)."
4318 ::= { docsDevGroupsV2 8 }
4319
4320 END
4321
4322 <span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. Acknowledgements</span>
4323
4324 This document is a production of the IPCDN Working Group and is a
4325 revision of <a href="./rfc2669">RFC 2669</a>, "Cable Device Management Information Base for
4326 DOCSIS-Compliant Cable Modems and Cable Modem Termination Systems"
4327 [<a href="./rfc2669" title="&quot;DOCSIS Cable Device MIB Cable Device Management Information Base for DOCSIS compliant Cable Modems and Cable Modem Termination Systems&quot;">RFC2669</a>]. Mike St. Johns and Guenter Roeck served well as the
4328 editors of previous versions of this MIB module.
4329
4330 The editor specifically wishes to thank Howard Abramson, Eduardo
4331 Cardona, Andre Lejeune, Kevin Marez, Jean-Francois Mule, Greg
4332 Nakanishi, Pak Siripunkaw, Boris Tsekinovski, Randy Presuhn, Bert
4333 Wijnen, and Bill Yost for their contributions to this document.
4334
4335 <span class="h3"><a class="selflink" id="section-5.1" href="#section-5.1">5.1</a>. Revision Descriptions</span>
4336
4337 This document contains the following revisions over <a href="./rfc2669">RFC 2669</a>:
4338
4339 o All IPv4 address objects were either deprecated and replaced or
4340 mirrored with IPv6 objects, where appropriate, following the
4341 guidelines of <a href="./rfc4001">RFC 4001</a> [<a href="./rfc4001" title="&quot;Textual Conventions for Internet Network Addresses&quot;">RFC4001</a>]. In particular,
4342 docsDevCpeInetTable was added, and the docsDevFilterGroup objects
4343 were deprecated in favor of the DiffServ MIB.
4344
4345 o Objects that were obviated by SNMPv3 and the SNMP Coexistence MIBs
4346 have been deprecated; e.g., docsDevNmAccessTable.
4347
4348 o A new object, docsDevIgmpModeControl, has been added to control
4349 passive versus active IGMP modem operation.
4350
4351 o A new object, docsDevMaxCpe, has been added to report the maximum
4352 number of CPEs granted network access across the CM.
4353
4354 o A new object, docsDevSwServerTransportProtocol, has been added to
4355 docsDevSoftware, and other object DESCRIPTIONs have been modified,
4356 to enable the use of either TFTP or HTTP for software downloads to
4357 the device.
4358
4359
4360
4361
4362
4363
4364 <span class="grey">Woundy &amp; Marez Standards Track [Page 78]</span></pre>
4365 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-79" ></span>
4366 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4367
4368
4369 o A new object, docsDevEvThrottleThresholdExceeded, has been added
4370 to replace docsDevEvThrottleInhibited for simplification of event
4371 threshold management.
4372
4373 o The docsDevEvReporting object has been modified to enable local
4374 logging to the internal volatile log, and not to the internal
4375 non-volatile log.
4376
4377 o Minor updates to the description text have been made to a number
4378 of objects to clarify their meaning.
4379
4380 o The compliance statements were updated to reflect current
4381 requirements (including making the docsDevCpe objects optional)
4382 and split between CM and CMTS devices.
4383
4384 o Text was added to indicate support of the SNMP Notification MIB
4385 [<a href="./rfc3413" title="&quot;Simple Network Management Protocol (SNMP) Applications&quot;">RFC3413</a>] and Notification Log MIB [<a href="./rfc3014" title="&quot;Notification Log MIB&quot;">RFC3014</a>] modules.
4386
4387 <span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span>
4388
4389 This MIB module relates to a system that will provide metropolitan
4390 public internet access. As such, improper manipulation of the
4391 objects represented by this MIB module may result in denial of
4392 service to a large number of end-users. In addition, manipulation of
4393 docsDevNmAccessTable, docsDevFilterLLCTable, docsDevFilterIpTable,
4394 docsDevFilterInetTable, and the elements of the docsDevCpe and
4395 docsDevCpeInetTable groups may allow an end-user to increase his or
4396 her service levels, spoof his or her IP addresses, change the
4397 permitted management stations, or affect other end-users in either a
4398 positive or negative manner.
4399
4400 It is recommended that the implementors prevent the "tiny fragment"
4401 and "overlapping fragment" attacks for the IP filtering tables in
4402 this MIB module, as discussed in [<a href="./rfc1858" title="&quot;Security Considerations r IP Fragment Filtering&quot;">RFC1858</a>] and [<a href="./rfc3128" title="&quot;Protection Against a Variant of the Tiny Fragment Attack (RFC 1858)&quot;">RFC3128</a>]. Prevention
4403 of these attacks can be implemented with the following rules, when
4404 TCP source and/or destination port filtering is enabled:
4405
4406 o Admit all packets with fragment offset &gt;= 2.
4407
4408 o Discard all packets with fragment offset = 1, or with fragment
4409 offset = 0 AND fragment payload length &lt; 16.
4410
4411 o Apply filtering rules to all packets with fragment offset = 0.
4412
4413 This MIB module does not affect confidentiality of services on a
4414 cable modem system. [<a href="#ref-BPI" title="&quot;Data-Over-Cable Service Interface Specifications: DOCSIS 1.0 Baseline Privacy Interface Specification SCTE 22-2 2002&quot;">BPI</a>] and [<a href="#ref-BPIPLUS" title="&quot;Data-Over-Cable Service Interface Specifications: Baseline Privacy Plus Interface Specification CM-SP-BPI+_I12-050812&quot;">BPIPLUS</a>] specify the implementation
4415 of the DOCSIS Baseline Privacy and Baseline Privacy Plus mechanisms
4416 for data transmission confidentiality.
4417
4418
4419
4420 <span class="grey">Woundy &amp; Marez Standards Track [Page 79]</span></pre>
4421 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-80" ></span>
4422 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4423
4424
4425 There are a number of management objects defined in this MIB module
4426 with a MAX-ACCESS clause of read-write and/or read-create. Such
4427 objects may be considered sensitive or vulnerable in some network
4428 environments. The support for SET operations in a non-secure
4429 environment without proper protection can have a negative effect on
4430 network operations. These are the tables and objects and their
4431 sensitivity/vulnerability:
4432
4433 o The use of docsDevNmAccessTable to specify management stations is
4434 considered only limited protection and does not protect against
4435 attacks that spoof the management station's IP address. The use
4436 of stronger mechanisms, such as SNMPv3 security, should be
4437 considered, where possible. Specifically, SNMPv3 USM [<a href="./rfc3414" title="&quot;User-based Security Model (USM) for version 3 of the Simple Network Management Protocol (SNMPv3)&quot;">RFC3414</a>]
4438 and VACM [<a href="./rfc3415" title="&quot;View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP)&quot;">RFC3415</a>] MUST be used with any v3 agent that implements
4439 this MIB module.
4440
4441 o The CM may have its software changed by the actions of the
4442 management system using a combination of the following objects:
4443 docsDevSwServer, docsDevSwFilename, docsDevSwAdminStatus,
4444 docsDevSwServerAddressType, docsDevSwServerAddress, and
4445 docsDevSwServerTransportProtocol. An improper software download
4446 may result in substantial vulnerabilities and the loss of the
4447 ability of the management system to control the cable modem. A
4448 cable device SHOULD implement the code verification mechanisms of
4449 [<a href="#ref-BPIPLUS" title="&quot;Data-Over-Cable Service Interface Specifications: Baseline Privacy Plus Interface Specification CM-SP-BPI+_I12-050812&quot;">BPIPLUS</a>] to verify the source and integrity of downloaded
4450 software images.
4451
4452 o The device may be reset by setting docsDevResetNow = true(1).
4453 This causes the device to reload its configuration files, as well
4454 as to eliminate all previous non-persistent network management
4455 settings. As such, this may provide a vector for attacking the
4456 system.
4457
4458 o Setting docsDevEvThrottleAdminStatus = unconstrained(1) (which is
4459 also the DEFVAL) may cause flooding of traps, which can disrupt
4460 network service. Additionally, docsDevThrottleThreshold and
4461 docsDevThrottleInterval could also be set to high values that may
4462 cause a disruption in service.
4463
4464 o Setting docsDevDateTime to an arbitrary (incorrect) value would
4465 merely cause the device to record incorrect timestamps on many
4466 events/actions that rely on this object for reporting.
4467
4468 o Setting docsDevEvControl to resetLog(1) will delete any event log
4469 history and could potentially impact debugging/troubleshooting
4470 efforts.
4471
4472 o Setting docsDevEvSyslog.
4473
4474
4475
4476 <span class="grey">Woundy &amp; Marez Standards Track [Page 80]</span></pre>
4477 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-81" ></span>
4478 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4479
4480
4481 o Setting docsDevEvReporting to enable syslog reporting, along with
4482 a redirect of the syslog server could allow access to sensitive
4483 information on network devices. Modifying docsDevEvSyslog,
4484 docsDevEvSyslogAddressType, or docsDevEvSyslogAddress could allow
4485 a redirect of sensitive information.
4486
4487 o Setting docsDevFilterLLCnmatchedAction or docsDevFilterIpDefault
4488 could cause significant changes to default traffic filtering on a
4489 device.
4490
4491 o Setting docsDevCpeEnroll to any(2) could cause the
4492 docsDevFilterCPETable to be populated, which may not be the
4493 intended functionality.
4494
4495 o Setting docsDevCpeIpMax to a value other than that intended by the
4496 MSO may allow a user to provision more devices than the MSO would
4497 like.
4498
4499 o Setting values in the docsDevNmAccess table can potentially
4500 introduce a mechanism for users to use a local NMS device and
4501 manipulate other settings in the CM or CMTS.
4502
4503 o Setting values in the docsDevFilterLLC and docsDevFilterIP tables
4504 can allow or deny access to certain devices that the MSO does not
4505 want.
4506
4507 o Setting docsDevCpeStatus and docsDevCpeInetRowStatus may allow
4508 users to provision more devices than were intended by the MSO, or
4509 to provision different ones.
4510
4511 Some of the readable objects in this MIB module (i.e., objects with a
4512 MAX-ACCESS other than not-accessible) may be considered sensitive or
4513 vulnerable in some network environments. It is thus important to
4514 control even GET access to these objects and possibly to even encrypt
4515 the values of these objects when sending them over the network via
4516 SNMP. These are the tables and objects and their
4517 sensitivity/vulnerability:
4518
4519 o Rows from docsDevNmAccessTable may provide sufficient information
4520 for attackers to spoof management stations that have management
4521 access to the device.
4522
4523 o The docsDevSwCurrentVers object may provide hints as to the
4524 software vulnerabilities of the cable device.
4525
4526 o The docsDevFilterLLCTable and docsDevFilterLLCTable may provide
4527 clues for attacking the cable device and other subscriber devices.
4528
4529
4530
4531
4532 <span class="grey">Woundy &amp; Marez Standards Track [Page 81]</span></pre>
4533 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-82" ></span>
4534 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4535
4536
4537 SNMP versions prior to SNMPv3 did not include adequate security.
4538 Even if the network itself is secure (for example by using IPsec),
4539 even then, there is no control as to who on the secure network is
4540 allowed to access and GET/SET (read/change/create/delete) the
4541 objects in this MIB module.
4542
4543 It is RECOMMENDED that implementers consider the security features
4544 as provided by the SNMPv3 framework (see <a href="./rfc3410#section-8">[RFC3410], section&nbsp;8</a>),
4545 including full support for the SNMPv3 cryptographic mechanisms
4546 (for authentication and privacy).
4547
4548 Further, deployment of SNMP versions prior to SNMPv3 is NOT
4549 RECOMMENDED. Instead, it is RECOMMENDED to deploy SNMPv3 and to
4550 enable cryptographic security. It is then a customer/operator
4551 responsibility to ensure that the SNMP entity giving access to an
4552 instance of this MIB module, is properly configured to give access
4553 to the objects only to those principals (users) that have
4554 legitimate rights to indeed GET or SET (change/create/delete)
4555 them.
4556
4557 <span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. IANA Considerations</span>
4558
4559 The MIB module defined in this document uses the following IANA-
4560 assigned OBJECT IDENTIFIER values, recorded in the SMI Numbers
4561 registry:
4562
4563 Descriptor OBJECT IDENTIFIER value
4564 ---------- -----------------------
4565 docsDevMIB { mib-2 69 }
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588 <span class="grey">Woundy &amp; Marez Standards Track [Page 82]</span></pre>
4589 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-83" ></span>
4590 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4591
4592
4593 <span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. References</span>
4594
4595 <span class="h3"><a class="selflink" id="section-8.1" href="#section-8.1">8.1</a>. Normative References</span>
4596
4597 [<a id="ref-BPI">BPI</a>] SCTE Data Standards Subcommittee, "Data-Over-Cable
4598 Service Interface Specifications: DOCSIS 1.0 Baseline
4599 Privacy Interface Specification SCTE 22-2 2002", 2002,
4600 &lt;<a href="http://www.scte.org/standards/">http://www.scte.org/standards/</a>&gt;.
4601
4602 [<a id="ref-BPIPLUS">BPIPLUS</a>] CableLabs, "Data-Over-Cable Service Interface
4603 Specifications: Baseline Privacy Plus Interface
4604 Specification CM-SP-BPI+_I12-050812", August 2005,
4605 &lt;<a href="http://www.cablemodem.com/specifications/">http://www.cablemodem.com/specifications/</a>&gt;,
4606 &lt;<a href="http://www.cablelabs.com/specifications/archives/">http://www.cablelabs.com/specifications/archives/</a>&gt;.
4607
4608 [<a id="ref-ITU-T_J.112">ITU-T_J.112</a>] ITU-T Recommendation J.112 (3/98), "Transmission
4609 Systems for Interactive Cable Television Services,
4610 J.112, International Telecommunications Union", March
4611 1998, &lt;<a href="http://www.itu.int/ITU-T/studygroups/com09/">http://www.itu.int/ITU-T/studygroups/com09/</a>&gt;.
4612
4613 [<a id="ref-MTA-PROV">MTA-PROV</a>] CableLabs, "PacketCable(TM) 1.5 Specification: MTA
4614 Device Provisioning PKT-SP-PROV1.5-I02-050812", August
4615 2005, &lt;<a href="http://www.packetcable.com/specifications/">http://www.packetcable.com/specifications/</a>&gt;,
4616 &lt;<a href="http://www.cablelabs.com/specifications/archives/">http://www.cablelabs.com/specifications/archives/</a>&gt;.
4617
4618 [<a id="ref-OSSI1.0">OSSI1.0</a>] SCTE Data Standards Subcommittee, "Data-Over-Cable
4619 Service Interface Specification: DOCSIS 1.0 Operations
4620 Support System Interface (OSSI), SCTE 22-3 2002", 2002,
4621 &lt;<a href="http://www.scte.org/standards/">http://www.scte.org/standards/</a>&gt;.
4622
4623 [<a id="ref-OSSI1.1">OSSI1.1</a>] SCTE Data Standards Subcommittee, "DOCSIS 1.1 Part 3:
4624 Operations Support System Interface ANSI/SCTE 23-3
4625 2005", 2005, &lt;<a href="http://www.scte.org/standards/">http://www.scte.org/standards/</a>&gt;.
4626
4627 [<a id="ref-OSSI2.0">OSSI2.0</a>] CableLabs, "Data-Over-Cable Service Interface
4628 Specifications: Operations Support System Interface
4629 Specification SP-OSSIv2.0-I09-050812", August 2005,
4630 &lt;<a href="http://www.cablemodem.com/specifications/">http://www.cablemodem.com/specifications/</a>&gt;,
4631 &lt;<a href="http://www.cablelabs.com/specifications/archives/">http://www.cablelabs.com/specifications/archives/</a>&gt;.
4632
4633 [<a id="ref-RFC1350">RFC1350</a>] Sollins, K., "The TFTP Protocol (Revision 2)", STD 33,
4634 <a href="./rfc1350">RFC 1350</a>, July 1992.
4635
4636 [<a id="ref-RFC4502">RFC4502</a>] Waldbusser, S., "Remote Network Monitoring Management
4637 Information Base Version 2", <a href="./rfc4502">RFC 4502</a>, May 2006.
4638
4639 [<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
4640 Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
4641
4642
4643
4644 <span class="grey">Woundy &amp; Marez Standards Track [Page 83]</span></pre>
4645 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-84" ></span>
4646 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4647
4648
4649 [<a id="ref-RFC2578">RFC2578</a>] McCloghrie, K., Perkins, D., Schoenwaelder J., Case,
4650 J., Rose, M. and S. Waldbusser, "Structure of
4651 Management Information Version 2 (SMIv2)", STD 58, <a href="./rfc2578">RFC</a>
4652 <a href="./rfc2578">2578</a>, April 1999.
4653
4654 [<a id="ref-RFC2579">RFC2579</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case,
4655 J., Rose, M. and S. Waldbusser , "Textual Conventions
4656 for SMIv2", STD 58, <a href="./rfc2579">RFC 2579</a>, April 1999.
4657
4658 [<a id="ref-RFC2580">RFC2580</a>] McCloghrie, K., Perkins, D., Schoenwaelder, J., Case,
4659 J., Rose, M. and S. Waldbusser, "Conformance Statements
4660 for SMIv2", STD 58, <a href="./rfc2580">RFC 2580</a>, April 1999.
4661
4662 [<a id="ref-RFC2616">RFC2616</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
4663 Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
4664 Transfer Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.
4665
4666 [<a id="ref-RFC2669">RFC2669</a>] St. Johns, M., "DOCSIS Cable Device MIB Cable Device
4667 Management Information Base for DOCSIS compliant Cable
4668 Modems and Cable Modem Termination Systems", <a href="./rfc2669">RFC 2669</a>,
4669 August 1999.
4670
4671 [<a id="ref-RFC2863">RFC2863</a>] McCloghrie, K. and F. Kastenholz, "The Interfaces Group
4672 MIB", <a href="./rfc2863">RFC 2863</a>, June 2000.
4673
4674 [<a id="ref-RFC3014">RFC3014</a>] Kavasseri, R., "Notification Log MIB", <a href="./rfc3014">RFC 3014</a>,
4675 November 2000.
4676
4677 [<a id="ref-RFC3289">RFC3289</a>] Baker, F., Chan, K., and A. Smith, "Management
4678 Information Base for the Differentiated Services
4679 Architecture", <a href="./rfc3289">RFC 3289</a>, May 2002.
4680
4681 [<a id="ref-RFC3411">RFC3411</a>] Harrington, D., Presuhn, R., and B. Wijnen, "An
4682 Architecture for Describing Simple Network Management
4683 Protocol (SNMP) Management Frameworks", STD 62, <a href="./rfc3411">RFC</a>
4684 <a href="./rfc3411">3411</a>, December 2002.
4685
4686 [<a id="ref-RFC3413">RFC3413</a>] Levi, D., Meyer, P., and B. Stewart, "Simple Network
4687 Management Protocol (SNMP) Applications", STD 62, <a href="./rfc3413">RFC</a>
4688 <a href="./rfc3413">3413</a>, December 2002.
4689
4690 [<a id="ref-RFC3414">RFC3414</a>] Blumenthal, U. and B. Wijnen, "User-based Security
4691 Model (USM) for version 3 of the Simple Network
4692 Management Protocol (SNMPv3)", STD 62, <a href="./rfc3414">RFC 3414</a>,
4693 December 2002.
4694
4695
4696
4697
4698
4699
4700 <span class="grey">Woundy &amp; Marez Standards Track [Page 84]</span></pre>
4701 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-85" ></span>
4702 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4703
4704
4705 [<a id="ref-RFC3415">RFC3415</a>] Wijnen, B., Presuhn, R., and K. McCloghrie, "View-based
4706 Access Control Model (VACM) for the Simple Network
4707 Management Protocol (SNMP)", STD 62, <a href="./rfc3415">RFC 3415</a>, December
4708 2002.
4709
4710 [<a id="ref-RFC3418">RFC3418</a>] Presuhn, R., "Management Information Base (MIB) for the
4711 Simple Network Management Protocol (SNMP)", STD 62, <a href="./rfc3418">RFC</a>
4712 <a href="./rfc3418">3418</a>, December 2002.
4713
4714 [<a id="ref-RFC3584">RFC3584</a>] Frye, R., Levi, D., Routhier, S., and B. Wijnen,
4715 "Coexistence between Version 1, Version 2, and Version
4716 3 of the Internet-standard Network Management
4717 Framework", <a href="https://www.rfc-editor.org/bcp/bcp74">BCP 74</a>, <a href="./rfc3584">RFC 3584</a>, August 2003.
4718
4719 [<a id="ref-RFC868">RFC868</a>] Postel, J. and K. Harrenstien, "Time Protocol", STD 26,
4720 <a href="./rfc868">RFC 868</a>, May 1983.
4721
4722 [<a id="ref-RFC4001">RFC4001</a>] Daniele, M., Haberman, B., Routhier, S., and J.
4723 Schoenwaelder, "Textual Conventions for Internet
4724 Network Addresses", <a href="./rfc4001">RFC 4001</a>, February 2005.
4725
4726 [<a id="ref-RFI1.0">RFI1.0</a>] SCTE Data Standards Subcommittee, "Data-Over-Cable
4727 Service Interface Specifications: DOCSIS 1.0 Radio
4728 Frequency Interface Specification SCTE 22-1 2002",
4729 2002, &lt;<a href="http://www.scte.org/standards/">http://www.scte.org/standards/</a>&gt;.
4730
4731 [<a id="ref-RFI1.1">RFI1.1</a>] SCTE Data Standards Subcommittee, "DOCSIS 1.1 Part 1:
4732 Radio Frequency Interface ANSI/SCTE 23-1 2005", 2005,
4733 &lt;<a href="http://www.scte.org/standards/">http://www.scte.org/standards/</a>&gt;.
4734
4735 [<a id="ref-RFI2.0">RFI2.0</a>] CableLabs, "Data-Over-Cable Service Interface
4736 Specifications: Radio Frequency Interface Specification
4737 SP-RFI2.0-I11-060602", June 2006,
4738 &lt;<a href="http://www.cablemodem.com/specifications/">http://www.cablemodem.com/specifications/</a>&gt;,
4739 &lt;<a href="http://www.cablelabs.com/specifications/archives/">http://www.cablelabs.com/specifications/archives/</a>&gt;.
4740
4741 <span class="h3"><a class="selflink" id="section-8.2" href="#section-8.2">8.2</a>. Informative References</span>
4742
4743 [<a id="ref-RFC1858">RFC1858</a>] Ziemba, G., Reed, D., and P. Traina, "Security
4744 Considerations r IP Fragment Filtering", <a href="./rfc1858">RFC 1858</a>,
4745 October 1995.
4746
4747 [<a id="ref-RFC1945">RFC1945</a>] Berners-Lee, T., Fielding, R., and H. Frystyk,
4748 "Hypertext Traner Protocol -- HTTP/1.0", <a href="./rfc1945">RFC 1945</a>, May
4749 1996.
4750
4751 [<a id="ref-RFC3128">RFC3128</a>] Miller, I., "Protection Against a Variant of the Tiny
4752 Fragment Attack (<a href="./rfc1858">RFC 1858</a>)", <a href="./rfc3128">RFC 3128</a>, June 2001.
4753
4754
4755
4756 <span class="grey">Woundy &amp; Marez Standards Track [Page 85]</span></pre>
4757 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-86" ></span>
4758 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4759
4760
4761 [<a id="ref-RFC3164">RFC3164</a>] Lonvick, C., "The BSD Syslog Protocol", <a href="./rfc3164">RFC 3164</a>,
4762 August 2001.
4763
4764 [<a id="ref-RFC3617">RFC3617</a>] Lear, E., "Uniform Resource Identifier (URI) Scheme and
4765 Applicbility Statement for the Trivial File Transfer
4766 Protocol (TFTP)", <a href="./rfc3617">RFC 3617</a>, October 2003.
4767
4768 [<a id="ref-RFC4547">RFC4547</a>] Ahmad, A. and G. Nakanishi, "Event Notification
4769 Management Information Base for Data over Cable Service
4770 Interface Specifications (DOCSIS) Compliant Cable
4771 Modems and Cable Modem Termination Systems", <a href="./rfc4547">RFC 4547</a>,
4772 June 2006.
4773
4774 [<a id="ref-RFC1224">RFC1224</a>] Steinberg, L., "Techniques for managing asynchronously
4775 generated alerts", <a href="./rfc1224">RFC 1224</a>, May 1991.
4776
4777 [<a id="ref-RFC3410">RFC3410</a>] Case, J., Mundy, R., Partain, D., and B. Stewart,
4778 "Introduction and Applicability Statements for
4779 Internet-Standard Management Framework", <a href="./rfc3410">RFC 3410</a>,
4780 December 2002.
4781
4782 [<a id="ref-RFC4036">RFC4036</a>] Sawyer, W., "Management Information Base for Data Over
4783 Cable Service Interface Specification (DOCSIS) Cable
4784 Modem Termination Systems for Subscriber Management",
4785 <a href="./rfc4036">RFC 4036</a>, April 2005.
4786
4787 [<a id="ref-RFC4323">RFC4323</a>] Patrick, M. and W. Murwin, "Data Over Cable System
4788 Interface Specification Quality of Service Management
4789 Information Base (DOCSIS-QoS MIB)", <a href="./rfc4323">RFC 4323</a>, January
4790 2006.
4791
4792 [<a id="ref-MULPI3.0">MULPI3.0</a>] CableLabs, "Data-Over-Cable Service Interface
4793 Specifications: DOCSIS 3.0 MAC and Upper Layer
4794 Protocols Interface Specification CM-SP-MULPIv3.0-I01-
4795 060804", August 2006,
4796 &lt;<a href="http://www.cablemodem.com/specifications/">http://www.cablemodem.com/specifications/</a>&gt;,
4797 &lt;<a href="http://www.cablelabs.com/specifications/archives/">http://www.cablelabs.com/specifications/archives/</a>&gt;.
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812 <span class="grey">Woundy &amp; Marez Standards Track [Page 86]</span></pre>
4813 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-87" ></span>
4814 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4815
4816
4817 Authors' Addresses
4818
4819 Richard Woundy
4820 Comcast Cable
4821 27 Industrial Avenue
4822 Chelmsford, MA 01824
4823 USA
4824
4825 Phone: +1 978 244 4010
4826 EMail: [email protected]
4827
4828
4829 Kevin Marez
4830 Motorola Corporation
4831 6450 Sequence Drive
4832 San Diego, CA 92121
4833 USA
4834
4835 Phone: +1 858 404 3785
4836 EMail: [email protected]
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868 <span class="grey">Woundy &amp; Marez Standards Track [Page 87]</span></pre>
4869 <hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-88" ></span>
4870 <span class="grey"><a href="./rfc4639">RFC 4639</a> DOCSIS Cable Device MIB December 2006</span>
4871
4872
4873 Full Copyright Statement
4874
4875 Copyright (C) The IETF Trust (2006).
4876
4877 This document is subject to the rights, licenses and restrictions
4878 contained in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a>, and except as set forth therein, the authors
4879 retain all their rights.
4880
4881 This document and the information contained herein are provided on an
4882 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
4883 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST,
4884 AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES,
4885 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT
4886 THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY
4887 IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
4888 PURPOSE.
4889
4890 Intellectual Property
4891
4892 The IETF takes no position regarding the validity or scope of any
4893 Intellectual Property Rights or other rights that might be claimed to
4894 pertain to the implementation or use of the technology described in
4895 this document or the extent to which any license under such rights
4896 might or might not be available; nor does it represent that it has
4897 made any independent effort to identify any such rights. Information
4898 on the procedures with respect to rights in RFC documents can be
4899 found in <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and <a href="https://www.rfc-editor.org/bcp/bcp79">BCP 79</a>.
4900
4901 Copies of IPR disclosures made to the IETF Secretariat and any
4902 assurances of licenses to be made available, or the result of an
4903 attempt made to obtain a general license or permission for the use of
4904 such proprietary rights by implementers or users of this
4905 specification can be obtained from the IETF on-line IPR repository at
4906 <a href="http://www.ietf.org/ipr">http://www.ietf.org/ipr</a>.
4907
4908 The IETF invites any interested party to bring to its attention any
4909 copyrights, patents or patent applications, or other proprietary
4910 rights that may cover technology that may be required to implement
4911 this standard. Please address the information to the IETF at
4912 [email protected].
4913
4914 Acknowledgement
4915
4916 Funding for the RFC Editor function is currently provided by the
4917 Internet Society.
4918
4919
4920
4921
4922
4923
4924 Woundy &amp; Marez Standards Track [Page 88]
4925 </pre>