1 DOCS-IETF-SUBMGT-MIB DEFINITIONS ::= BEGIN
20 docsIfCmtsCmStatusIndex,
21 docsIfCmtsCmStatusEntry
22 FROM DOCS-IF-MIB -- RFC2670
23 diffServMIBDataPathGroup,
25 diffServMIBClfrElementGroup,
26 diffServMIBMultiFieldClfrGroup,
30 diffServMIBActionGroup,
31 diffServMIBAlgDropGroup,
32 diffServMIBCounterGroup,
33 diffServDataPathStatus,
35 diffServClfrElementStatus,
36 diffServMultiFieldClfrAddrType,
37 diffServMultiFieldClfrSrcAddr,
38 diffServMultiFieldClfrDstAddr,
39 diffServAlgDropStatus,
40 diffServDataPathStorage,
42 diffServClfrElementStorage,
43 diffServMultiFieldClfrStorage,
44 diffServActionStorage,
45 diffServCountActStorage,
46 diffServAlgDropStorage,
48 FROM DIFFSERV-MIB -- RFC3289
51 docsSubMgt MODULE-IDENTITY
52 LAST-UPDATED "200503290000Z" -- March 29, 2005
53 ORGANIZATION "IETF IP over Cable Data Network (IPCDN) Working
57 Postal: 50 Kelly Brook Lane
58 East Hampstead, NH 03826
61 Phone: +1 603 382 7080
62 E-mail: wsawyer@ieee.org
64 IETF IPCDN Working Group
65 General Discussion: ipcdn@ietf.org
66 Subscribe: http://www.ietf.org/mailman/listinfo/ipcdn
67 Archive: ftp://ftp.ietf.org/ietf-mail-archive/ipcdn
68 Co-chairs: Richard Woundy, Richard_Woundy@cable.comcast.com
69 Jean-Francois Mule, jf.mule@cablelabs.com"
71 "This is the CMTS centric subscriber management MIB for
72 DOCSIS-compliant CMTS. It provides the objects to allow a Cable
73 Modem Termination operator to control the IP addresses and
74 protocols associated with subscribers' cable modems.
81 Copyright (C) The Internet Society (2005). This version of this
82 MIB module is part of RFC 4036; see the RFC itself for full legal
84 REVISION "200503290000Z" -- March 29, 2005
86 "Initial version, published as RFC 4036. Note that the
87 compliance statements in this version apply only to
88 implementations that support DOCSIS 1.0/1.1/2.0, which
89 are not IPv6-capable."
92 docsSubMgtObjects OBJECT IDENTIFIER ::= { docsSubMgt 1 }
94 docsSubMgtCpeControlTable OBJECT-TYPE
95 SYNTAX SEQUENCE OF DocsSubMgtCpeControlEntry
96 MAX-ACCESS not-accessible
99 "This table AUGMENTs the docsIfCmtsCmStatusTable, adding
100 four WRITEable objects, as well as a read-only object, all of
101 which reflect the state of subscriber management on a particular
103 ::= { docsSubMgtObjects 1 }
105 docsSubMgtCpeControlEntry OBJECT-TYPE
106 SYNTAX DocsSubMgtCpeControlEntry
107 MAX-ACCESS not-accessible
110 "A row in the docsSubMgtCpeControlTable. All values are set
111 at successful modem registration, either from the system default,
112 or from objects included in the DOCSIS registration request sent
113 upstream to the CMTS from the CM. The contents of this entry are
114 meaningless unless the corresponding docsIfCmtsCmStatusValue (see
115 reference) is registrationComplete(6). The persistence of this
116 row is determined solely by the lifespan of the corresponding
117 docsIfCmtsCmStatusEntry (normally StorageType=volatile)."
121 AUGMENTS { docsIfCmtsCmStatusEntry }
122 ::= {docsSubMgtCpeControlTable 1 }
124 DocsSubMgtCpeControlEntry ::= SEQUENCE
126 docsSubMgtCpeControlMaxCpeIp Integer32,
127 docsSubMgtCpeControlActive TruthValue,
128 docsSubMgtCpeControlLearnable TruthValue,
132 docsSubMgtCpeControlReset TruthValue,
133 docsSubMgtCpeControlLastReset TimeStamp
136 docsSubMgtCpeControlMaxCpeIp OBJECT-TYPE
137 SYNTAX Integer32(0..2147483647)
138 MAX-ACCESS read-write
141 "The number of simultaneous IP addresses permitted behind
142 the CM. If this is set to zero, all CPE traffic from the CM is
143 dropped. If the provisioning object corresponding to
144 docsSubMgtCpeIpTable includes more CPE IP address entries for
145 this modem than the value of this object, then this object is
146 set to the count of the number of rows in docsSubMgtCpeIpTable
147 that have the same docsIfCmtsCmStatusIndex value. (For example,
148 if the CM has 5 IP addresses specified for it, this value is 5.)
149 This limit applies to learned and DOCSIS-provisioned entries
150 but not to entries added through some administrative
151 process at the CMTS. If not set through DOCSIS provisioning,
152 this object defaults to docsSubMgtCpeMaxIpDefault. Note that
153 this object is only meaningful if docsSubMgtCpeControlActive
155 ::= { docsSubMgtCpeControlEntry 1 }
157 docsSubMgtCpeControlActive OBJECT-TYPE
159 MAX-ACCESS read-write
162 "Controls the application of subscriber management to
163 this cable modem. If this is set to true, CMTS-based CPE
164 control is active, and all the actions required by the various
165 filter tables and controls apply at the CMTS. If this is set
166 to false, no subscriber management filtering is done at the
167 CMTS (but other filters may apply). If not set through DOCSIS
168 provisioning, this object defaults to
169 docsSubMgtCpeActiveDefault."
170 ::= { docsSubMgtCpeControlEntry 2 }
172 docsSubMgtCpeControlLearnable OBJECT-TYPE
174 MAX-ACCESS read-write
177 "Controls whether the CMTS may learn (and pass traffic
178 for) CPE IP addresses associated with a cable modem. If this is
179 set to true, the CMTS may learn up to docsSubMgtMaxCpeIp
183 addresses (less any DOCSIS-provisioned entries) related to this
184 CM. Those IP addresses are added (by internal process) to the
185 docsSubMgtCpeIpTable. The nature of the learning mechanism is
188 If not set through DOCSIS provisioning, this object defaults to
189 docsSubMgtCpeLearnableDefault. Note that this object is only
190 meaningful if docsSubMgtCpeControlActive is true."
191 ::= { docsSubMgtCpeControlEntry 3 }
193 docsSubMgtCpeControlReset OBJECT-TYPE
195 MAX-ACCESS read-write
198 "This object always returns false on read. If this object is
199 set to true, the rows with 'learned' addresses in
200 docsSubMgtCpeIpTable for this CM are deleted from that table."
201 ::= { docsSubMgtCpeControlEntry 4 }
203 docsSubMgtCpeControlLastReset OBJECT-TYPE
208 "The value of sysUpTime when docsSubMgtCpeControlReset was
209 last set true. Zero if never reset."
211 ::= { docsSubMgtCpeControlEntry 5 }
213 docsSubMgtCpeMaxIpDefault OBJECT-TYPE
214 SYNTAX Integer32(0..2147483647)
215 MAX-ACCESS read-write
218 "The default value for docsSubMgtCpeControlMaxCpeIp if not
219 signaled in the DOCSIS Registration request. This value should
220 be treated as nonvolatile; if set, its value should persist
221 across device resets."
223 ::= { docsSubMgtObjects 2 }
225 docsSubMgtCpeActiveDefault OBJECT-TYPE
227 MAX-ACCESS read-write
230 "The default value for docsSubMgtCpeControlActive if not
234 signaled in the DOCSIS Registration request. This value should
235 be treated as nonvolatile; if set, its value should persist
236 across device resets."
238 ::= { docsSubMgtObjects 3 }
240 docsSubMgtCpeLearnableDefault OBJECT-TYPE
242 MAX-ACCESS read-write
245 "The default value for docsSubMgtCpeControlLearnable if not
246 signaled in the DOCSIS Registration request. This value should
247 be treated as nonvolatile; if set, its value should persist
248 across device resets."
250 ::= { docsSubMgtObjects 4 }
252 docsSubMgtCpeIpTable OBJECT-TYPE
253 SYNTAX SEQUENCE OF DocsSubMgtCpeIpEntry
254 MAX-ACCESS not-accessible
257 "A table of CPE IP addresses known on a per-CM basis."
258 ::= { docsSubMgtObjects 5 }
260 docsSubMgtCpeIpEntry OBJECT-TYPE
261 SYNTAX DocsSubMgtCpeIpEntry
262 MAX-ACCESS not-accessible
265 "An entry in the docsSubMgtCpeIpTable. The first index is
266 the specific modem we're referring to, and the second index is
267 the specific CPE IP entry."
268 INDEX { docsIfCmtsCmStatusIndex,
269 docsSubMgtCpeIpIndex }
270 ::= {docsSubMgtCpeIpTable 1 }
272 DocsSubMgtCpeIpEntry ::= SEQUENCE
274 docsSubMgtCpeIpIndex Integer32,
275 docsSubMgtCpeIpAddressType InetAddressType,
276 docsSubMgtCpeIpAddr InetAddress,
277 docsSubMgtCpeIpLearned TruthValue
280 docsSubMgtCpeIpIndex OBJECT-TYPE
281 SYNTAX Integer32(1..2147483647)
285 MAX-ACCESS not-accessible
288 "The index of this CPE IP address relative to the indexed CM.
289 An entry is created either through the included CPE IP addresses
290 in the provisioning object, or via learning.
292 If docsSubMgtCpeControlActive is true and a CMTS receives
293 an IP packet from a CM that contains a source IP address that
294 does not match one of the docsSubMgtCpeIpAddr entries for this
295 CM, one of two things occurs. If the number of entries is less
296 than docsSubMgtCpeControlMaxCpeIp, the source address is added to
297 the table and the packet is forwarded. If the number of entries
298 equals the docsSubMgtCpeControlMaxCpeIp, then the packet is
300 ::= { docsSubMgtCpeIpEntry 1 }
302 docsSubMgtCpeIpAddressType OBJECT-TYPE
303 SYNTAX InetAddressType
307 "The type of internet address of docsSubMgtCpeIpAddr."
308 ::= { docsSubMgtCpeIpEntry 2 }
310 docsSubMgtCpeIpAddr OBJECT-TYPE
315 "The IP address either set from provisioning or learned via
316 address gleaning or other forwarding means. See
317 docsSubMgtCpeIpIndex for the mechanism.
319 The type of this address is determined by the value of
320 docsSubMgtCpeIpAddressType."
321 ::= { docsSubMgtCpeIpEntry 3 }
323 docsSubMgtCpeIpLearned OBJECT-TYPE
328 "If true, this entry was learned from IP packets sent
329 upstream rather than from the provisioning objects."
330 ::= { docsSubMgtCpeIpEntry 4 }
332 docsSubMgtCmFilterTable OBJECT-TYPE
336 SYNTAX SEQUENCE OF DocsSubMgtCmFilterEntry
337 MAX-ACCESS not-accessible
340 "Binds filter groups to modems, identifying for each modem
341 the upstream and downstream filter groups that apply to packets
342 for that modem. Normally, this table reflects the filter group
343 values signaled by DOCSIS Registration, although values may be
344 overridden by management action.
346 For each of the columns in this table, zero is a distinguished
347 value, indicating that the default filtering action is to be
348 taken rather than that associated with a filter group number.
349 Zero is used if the filter group is not signaled by DOCSIS
351 ::= { docsSubMgtObjects 6 }
353 docsSubMgtCmFilterEntry OBJECT-TYPE
354 SYNTAX DocsSubMgtCmFilterEntry
355 MAX-ACCESS not-accessible
358 "Binds a filter group to each direction of traffic for a
359 modem. The filters in this entry apply if
360 docsSubMgtCpeControlActive is true.
362 The contents of this entry are meaningless unless the
363 corresponding docsIfCmtsCmStatusValue (see reference) is
364 registrationComplete(6). The persistence of this row is
365 determined solely by the lifespan of the corresponding
366 docsIfCmtsCmStatusEntry (normally StorageType=volatile)."
369 AUGMENTS { docsIfCmtsCmStatusEntry }
370 ::= {docsSubMgtCmFilterTable 1 }
372 DocsSubMgtCmFilterEntry ::= SEQUENCE
374 docsSubMgtCmFilterSubDownstream Integer32,
375 docsSubMgtCmFilterSubUpstream Integer32,
376 docsSubMgtCmFilterCmDownstream Integer32,
377 docsSubMgtCmFilterCmUpstream Integer32
380 docsSubMgtCmFilterSubDownstream OBJECT-TYPE
381 SYNTAX Integer32(0..65535)
382 MAX-ACCESS read-write
388 "The filter group applied to traffic destined for subscribers
389 attached to the referenced CM. Upon row creation, this is set
390 either to zero (use default classification, the
391 diffServClfrElementSpecific=zeroDotZero row of
392 diffServClfrElementTable) or to the value in the provisioning
393 object sent upstream from the CM to the CMTS during registration.
394 The value of this object is the same as that of the filter group
395 index appearing as docsSubMgtFilterGroupIndex."
396 ::= { docsSubMgtCmFilterEntry 1 }
398 docsSubMgtCmFilterSubUpstream OBJECT-TYPE
399 SYNTAX Integer32(0..65535)
400 MAX-ACCESS read-write
403 "The filter group applied to traffic originating from
404 subscribers attached to the referenced CM. Upon row creation
405 this is set to either zero (use default classification, the
406 diffServClfrElementSpecific=zeroDotZero row of
407 diffServClfrElementTable), or to the value in the provisioning
408 object sent upstream from the CM to the CMTS. The value of this
409 object is the same as that of the filter group index appearing as
410 docsSubMgtFilterGroupIndex."
411 ::= { docsSubMgtCmFilterEntry 2 }
413 docsSubMgtCmFilterCmDownstream OBJECT-TYPE
414 SYNTAX Integer32(0..65535)
415 MAX-ACCESS read-write
418 "The filter group applied to traffic destined for the
419 referenced CM itself. Upon row creation this is set either to
420 zero (use default classification, the
421 diffServClfrElementSpecific=zeroDotZero row of
422 diffServClfrElementTable), or to the value in the provisioning
423 object sent upstream from the CM to the CMTS during registration.
424 The value of this object is the same as that of the filter group
425 index appearing as docsSubMgtFilterGroupIndex."
426 ::= { docsSubMgtCmFilterEntry 3 }
428 docsSubMgtCmFilterCmUpstream OBJECT-TYPE
429 SYNTAX Integer32(0..65535)
430 MAX-ACCESS read-write
433 "The filter group applied to traffic originating from the
434 referenced CM itself. This is set upon row creation to either
438 zero (use default classification, the
439 diffServClfrElementSpecific=zeroDotZero row of
440 diffServClfrElementTable), or to the value in the provisioning
441 object sent upstream from the CM to the CMTS during registration.
442 The value of this object is the same as the filter group index
443 appearing as docsSubMgtFilterGroupIndex."
444 ::= { docsSubMgtCmFilterEntry 4 }
446 docsSubMgtFilterGroupTable OBJECT-TYPE
447 SYNTAX SEQUENCE OF DocsSubMgtFilterGroupEntry
448 MAX-ACCESS not-accessible
451 "Provides a collection of referenceable entries to which
452 diffServClfrElementSpecific refers. This table provides filter
453 group indices that can be compared with those signaled during
454 DOCSIS registration. A packet matches an entry from this table
455 if the packet originated from or is destined to a cable modem
456 that registered this index as one of its four filter groups
457 (see docsSubMgtCmFilterTable), and if the packet direction and
458 MAC address select the use of this index among the four."
459 ::= { docsSubMgtObjects 7 }
461 docsSubMgtFilterGroupEntry OBJECT-TYPE
462 SYNTAX DocsSubMgtFilterGroupEntry
463 MAX-ACCESS not-accessible
466 "An entry only exists if needed by the
467 diffServClfrElementEntry. A packet matches this entry if the
468 packet's cable modem registered this index as one of its four
469 filter groups (see docsSubMgtCmFilterTable) and if the packet
470 direction and MAC address select the use of this index among
472 INDEX { docsSubMgtFilterGroupIndex }
473 ::= { docsSubMgtFilterGroupTable 1 }
475 DocsSubMgtFilterGroupEntry ::= SEQUENCE
477 docsSubMgtFilterGroupIndex Integer32
480 docsSubMgtFilterGroupIndex OBJECT-TYPE
481 SYNTAX Integer32(1..65535)
485 "The filter group index, from the set signaled at DOCSIS
489 Registration. Provides a referenceable entry to which
490 diffServClfrElementSpecific points. A packet matches this
491 classifier entry if the packet's cable modem registered this
492 index value as one of its four filter groups, and if the packet
493 direction and MAC address select the use of this index among
494 the four. Because this is the only field in this table, it is
495 read-only, contrary to the usual SMI custom of making indices
498 Note that although zero may be signaled (or defaulted) at DOCSIS
499 Registration to indicate a default filtering group, no such entry
500 appears in this table, as diffServClfrElementSpecific will
501 use a zeroDotZero pointer for that classification."
502 ::= { docsSubMgtFilterGroupEntry 1 }
504 docsSubMgtConformance OBJECT IDENTIFIER ::= { docsSubMgt 2 }
505 docsSubMgtCompliances OBJECT IDENTIFIER ::=
506 { docsSubMgtConformance 1 }
507 docsSubMgtGroups OBJECT IDENTIFIER ::=
508 { docsSubMgtConformance 2 }
510 docsSubMgtBasicCompliance MODULE-COMPLIANCE
513 "The compliance statement for CMTS devices that implement
514 CMTS centric subscriber management.
516 This compliance statement applies to implementations that
517 support DOCSIS 1.0/1.1/2.0, which are not IPv6 capable."
520 MODULE DIFFSERV-MIB -- RFC3289
522 diffServMIBDataPathGroup,
523 diffServMIBClfrGroup,
524 diffServMIBClfrElementGroup,
525 diffServMIBMultiFieldClfrGroup,
526 diffServMIBActionGroup,
527 diffServMIBAlgDropGroup,
528 diffServMIBCounterGroup
531 OBJECT diffServDataPathStatus -- same as RFC3289
532 SYNTAX RowStatus { active(1) }
533 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
535 "Support for createAndWait and notInService is not required."
540 OBJECT diffServClfrStatus -- same as RFC3289
541 SYNTAX RowStatus { active(1) }
542 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
544 "Support for createAndWait and notInService is not required."
546 OBJECT diffServClfrElementStatus -- same as RFC3289
547 SYNTAX RowStatus { active(1) }
548 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
550 "Support for createAndWait and notInService is not required."
552 OBJECT diffServMultiFieldClfrAddrType
553 SYNTAX InetAddressType { ipv4(1) }
555 "An implementation is only required to support IPv4
558 OBJECT diffServMultiFieldClfrSrcAddr
559 SYNTAX InetAddress (SIZE(4))
561 "An implementation is only required to support IPv4
564 OBJECT diffServMultiFieldClfrDstAddr
565 SYNTAX InetAddress (SIZE(4))
567 "An implementation is only required to support IPv4
570 OBJECT diffServAlgDropStatus -- same as RFC3289
571 SYNTAX RowStatus { active(1) }
572 WRITE-SYNTAX RowStatus { createAndGo(4), destroy(6) }
574 "Support for createAndWait and notInService is not required."
576 OBJECT diffServDataPathStorage
577 SYNTAX StorageType { nonVolatile(3) }
579 "An implementation is only required to support nonvolatile
582 OBJECT diffServClfrStorage
583 SYNTAX StorageType { nonVolatile(3) }
585 "An implementation is only required to support nonvolatile
591 OBJECT diffServClfrElementStorage
592 SYNTAX StorageType { nonVolatile(3) }
594 "An implementation is only required to support nonvolatile
597 OBJECT diffServMultiFieldClfrStorage
598 SYNTAX StorageType { nonVolatile(3) }
600 "An implementation is only required to support nonvolatile
603 OBJECT diffServActionStorage
604 SYNTAX StorageType { nonVolatile(3) }
606 "An implementation is only required to support nonvolatile
609 OBJECT diffServCountActStorage
610 SYNTAX StorageType { nonVolatile(3) }
612 "An implementation is only required to support nonvolatile
615 OBJECT diffServAlgDropStorage
616 SYNTAX StorageType { nonVolatile(3) }
618 "An implementation is only required to support nonvolatile
621 OBJECT diffServAlgDropType
622 SYNTAX INTEGER { alwaysDrop(5) }
624 "For DOCSIS subscriber management, this object is
625 only used to provide packet filtering. Implementations
626 need not support other values of this enumeration."
628 MODULE -- This module i.e., DOCS-IETF-SUBMGT-MIB
634 OBJECT docsSubMgtCpeControlMaxCpeIp
635 SYNTAX Integer32(0..16)
637 "An implementation is only required to support up to
638 sixteen addresses per modem."
642 OBJECT docsSubMgtCpeMaxIpDefault
643 SYNTAX Integer32(0..16)
645 "An implementation is only required to support up to
646 sixteen addresses per modem."
648 OBJECT docsSubMgtCpeIpAddressType
649 SYNTAX InetAddressType { ipv4(1) }
651 "An implementation is only required to support IPv4
654 OBJECT docsSubMgtCpeIpAddr
655 SYNTAX InetAddress (SIZE(4))
657 "An implementation is only required to support IPv4
660 OBJECT docsSubMgtCmFilterSubDownstream
661 SYNTAX Integer32(0..30)
663 "An implementation is only required to support thirty
666 OBJECT docsSubMgtCmFilterSubUpstream
667 SYNTAX Integer32(0..30)
669 "An implementation is only required to support thirty
672 OBJECT docsSubMgtCmFilterCmDownstream
673 SYNTAX Integer32(0..30)
675 "An implementation is only required to support thirty
678 OBJECT docsSubMgtCmFilterCmUpstream
679 SYNTAX Integer32(0..30)
681 "An implementation is only required to support thirty
684 ::= { docsSubMgtCompliances 1 }
686 docsSubMgtGroup OBJECT-GROUP
688 docsSubMgtCpeControlMaxCpeIp,
689 docsSubMgtCpeControlActive,
693 docsSubMgtCpeControlLearnable,
694 docsSubMgtCpeControlReset,
695 docsSubMgtCpeControlLastReset,
696 docsSubMgtCpeMaxIpDefault,
697 docsSubMgtCpeActiveDefault,
698 docsSubMgtCpeLearnableDefault,
699 docsSubMgtCpeIpAddressType,
701 docsSubMgtCpeIpLearned,
702 docsSubMgtCmFilterSubDownstream,
703 docsSubMgtCmFilterSubUpstream,
704 docsSubMgtCmFilterCmDownstream,
705 docsSubMgtCmFilterCmUpstream,
706 docsSubMgtFilterGroupIndex
710 "The objects used to manage host-based cable modems
711 via a set of CMTS enforced controls."
712 ::= { docsSubMgtGroups 1 }