DOCS-IETF-SUBMGT-MIB

File: DOCS-IETF-SUBMGT-MIB.mib (24271 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
INET-ADDRESS-MIB DOCS-IF-MIB DIFFSERV-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Integer32
mib-2 RowStatus TruthValue
TimeStamp StorageType OBJECT-GROUP
MODULE-COMPLIANCE InetAddressType InetAddress
docsIfCmtsCmStatusIndex docsIfCmtsCmStatusEntry diffServMIBDataPathGroup
diffServMIBClfrGroup diffServMIBClfrElementGroup diffServMIBMultiFieldClfrGroup
diffServMIBActionGroup diffServMIBAlgDropGroup diffServMIBCounterGroup
diffServDataPathStatus diffServClfrStatus diffServClfrElementStatus
diffServMultiFieldClfrAddrType diffServMultiFieldClfrSrcAddr diffServMultiFieldClfrDstAddr
diffServAlgDropStatus diffServDataPathStorage diffServClfrStorage
diffServClfrElementStorage diffServMultiFieldClfrStorage diffServActionStorage
diffServCountActStorage diffServAlgDropStorage diffServAlgDropType

Defined Types

DocsSubMgtCpeControlEntry  
SEQUENCE    
  docsSubMgtCpeControlMaxCpeIp Integer32
  docsSubMgtCpeControlActive TruthValue
  docsSubMgtCpeControlLearnable TruthValue
  docsSubMgtCpeControlReset TruthValue
  docsSubMgtCpeControlLastReset TimeStamp

DocsSubMgtCpeIpEntry  
SEQUENCE    
  docsSubMgtCpeIpIndex Integer32
  docsSubMgtCpeIpAddressType InetAddressType
  docsSubMgtCpeIpAddr InetAddress
  docsSubMgtCpeIpLearned TruthValue

DocsSubMgtCmFilterEntry  
SEQUENCE    
  docsSubMgtCmFilterSubDownstream Integer32
  docsSubMgtCmFilterSubUpstream Integer32
  docsSubMgtCmFilterCmDownstream Integer32
  docsSubMgtCmFilterCmUpstream Integer32

DocsSubMgtFilterGroupEntry  
SEQUENCE    
  docsSubMgtFilterGroupIndex Integer32

Defined Values

docsSubMgt 1.3.6.1.2.1.125
This is the CMTS centric subscriber management MIB for DOCSIS-compliant CMTS. It provides the objects to allow a Cable Modem Termination operator to control the IP addresses and protocols associated with subscribers' cable modems. Copyright (C) The Internet Society (2005). This version of this MIB module is part of RFC 4036; see the RFC itself for full legal notices.
MODULE-IDENTITY    

docsSubMgtObjects 1.3.6.1.2.1.125.1
OBJECT IDENTIFIER    

docsSubMgtCpeControlTable 1.3.6.1.2.1.125.1.1
This table AUGMENTs the docsIfCmtsCmStatusTable, adding four WRITEable objects, as well as a read-only object, all of which reflect the state of subscriber management on a particular CM.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtCpeControlEntry

docsSubMgtCpeControlEntry 1.3.6.1.2.1.125.1.1.1
A row in the docsSubMgtCpeControlTable. All values are set at successful modem registration, either from the system default, or from objects included in the DOCSIS registration request sent upstream to the CMTS from the CM. The contents of this entry are meaningless unless the corresponding docsIfCmtsCmStatusValue (see reference) is registrationComplete(6). The persistence of this row is determined solely by the lifespan of the corresponding docsIfCmtsCmStatusEntry (normally StorageType=volatile).
OBJECT-TYPE    
  DocsSubMgtCpeControlEntry  

docsSubMgtCpeControlMaxCpeIp 1.3.6.1.2.1.125.1.1.1.1
The number of simultaneous IP addresses permitted behind the CM. If this is set to zero, all CPE traffic from the CM is dropped. If the provisioning object corresponding to docsSubMgtCpeIpTable includes more CPE IP address entries for this modem than the value of this object, then this object is set to the count of the number of rows in docsSubMgtCpeIpTable that have the same docsIfCmtsCmStatusIndex value. (For example, if the CM has 5 IP addresses specified for it, this value is 5.) This limit applies to learned and DOCSIS-provisioned entries but not to entries added through some administrative process at the CMTS. If not set through DOCSIS provisioning, this object defaults to docsSubMgtCpeMaxIpDefault. Note that this object is only meaningful if docsSubMgtCpeControlActive is true.
OBJECT-TYPE    
  Integer32 0..2147483647  

docsSubMgtCpeControlActive 1.3.6.1.2.1.125.1.1.1.2
Controls the application of subscriber management to this cable modem. If this is set to true, CMTS-based CPE control is active, and all the actions required by the various filter tables and controls apply at the CMTS. If this is set to false, no subscriber management filtering is done at the CMTS (but other filters may apply). If not set through DOCSIS provisioning, this object defaults to docsSubMgtCpeActiveDefault.
OBJECT-TYPE    
  TruthValue  

docsSubMgtCpeControlLearnable 1.3.6.1.2.1.125.1.1.1.3
Controls whether the CMTS may learn (and pass traffic for) CPE IP addresses associated with a cable modem. If this is set to true, the CMTS may learn up to docsSubMgtMaxCpeIp addresses (less any DOCSIS-provisioned entries) related to this CM. Those IP addresses are added (by internal process) to the docsSubMgtCpeIpTable. The nature of the learning mechanism is not specified here. If not set through DOCSIS provisioning, this object defaults to docsSubMgtCpeLearnableDefault. Note that this object is only meaningful if docsSubMgtCpeControlActive is true.
OBJECT-TYPE    
  TruthValue  

docsSubMgtCpeControlReset 1.3.6.1.2.1.125.1.1.1.4
This object always returns false on read. If this object is set to true, the rows with 'learned' addresses in docsSubMgtCpeIpTable for this CM are deleted from that table.
OBJECT-TYPE    
  TruthValue  

docsSubMgtCpeControlLastReset 1.3.6.1.2.1.125.1.1.1.5
The value of sysUpTime when docsSubMgtCpeControlReset was last set true. Zero if never reset.
OBJECT-TYPE    
  TimeStamp  

docsSubMgtCpeMaxIpDefault 1.3.6.1.2.1.125.1.2
The default value for docsSubMgtCpeControlMaxCpeIp if not signaled in the DOCSIS Registration request. This value should be treated as nonvolatile; if set, its value should persist across device resets.
OBJECT-TYPE    
  Integer32 0..2147483647  

docsSubMgtCpeActiveDefault 1.3.6.1.2.1.125.1.3
The default value for docsSubMgtCpeControlActive if not signaled in the DOCSIS Registration request. This value should be treated as nonvolatile; if set, its value should persist across device resets.
OBJECT-TYPE    
  TruthValue  

docsSubMgtCpeLearnableDefault 1.3.6.1.2.1.125.1.4
The default value for docsSubMgtCpeControlLearnable if not signaled in the DOCSIS Registration request. This value should be treated as nonvolatile; if set, its value should persist across device resets.
OBJECT-TYPE    
  TruthValue  

docsSubMgtCpeIpTable 1.3.6.1.2.1.125.1.5
A table of CPE IP addresses known on a per-CM basis.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtCpeIpEntry

docsSubMgtCpeIpEntry 1.3.6.1.2.1.125.1.5.1
An entry in the docsSubMgtCpeIpTable. The first index is the specific modem we're referring to, and the second index is the specific CPE IP entry.
OBJECT-TYPE    
  DocsSubMgtCpeIpEntry  

docsSubMgtCpeIpIndex 1.3.6.1.2.1.125.1.5.1.1
The index of this CPE IP address relative to the indexed CM. An entry is created either through the included CPE IP addresses in the provisioning object, or via learning. If docsSubMgtCpeControlActive is true and a CMTS receives an IP packet from a CM that contains a source IP address that does not match one of the docsSubMgtCpeIpAddr entries for this CM, one of two things occurs. If the number of entries is less than docsSubMgtCpeControlMaxCpeIp, the source address is added to the table and the packet is forwarded. If the number of entries equals the docsSubMgtCpeControlMaxCpeIp, then the packet is dropped.
OBJECT-TYPE    
  Integer32 1..2147483647  

docsSubMgtCpeIpAddressType 1.3.6.1.2.1.125.1.5.1.2
The type of internet address of docsSubMgtCpeIpAddr.
OBJECT-TYPE    
  InetAddressType  

docsSubMgtCpeIpAddr 1.3.6.1.2.1.125.1.5.1.3
The IP address either set from provisioning or learned via address gleaning or other forwarding means. See docsSubMgtCpeIpIndex for the mechanism. The type of this address is determined by the value of docsSubMgtCpeIpAddressType.
OBJECT-TYPE    
  InetAddress  

docsSubMgtCpeIpLearned 1.3.6.1.2.1.125.1.5.1.4
If true, this entry was learned from IP packets sent upstream rather than from the provisioning objects.
OBJECT-TYPE    
  TruthValue  

docsSubMgtCmFilterTable 1.3.6.1.2.1.125.1.6
Binds filter groups to modems, identifying for each modem the upstream and downstream filter groups that apply to packets for that modem. Normally, this table reflects the filter group values signaled by DOCSIS Registration, although values may be overridden by management action. For each of the columns in this table, zero is a distinguished value, indicating that the default filtering action is to be taken rather than that associated with a filter group number. Zero is used if the filter group is not signaled by DOCSIS registration.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtCmFilterEntry

docsSubMgtCmFilterEntry 1.3.6.1.2.1.125.1.6.1
Binds a filter group to each direction of traffic for a modem. The filters in this entry apply if docsSubMgtCpeControlActive is true. The contents of this entry are meaningless unless the corresponding docsIfCmtsCmStatusValue (see reference) is registrationComplete(6). The persistence of this row is determined solely by the lifespan of the corresponding docsIfCmtsCmStatusEntry (normally StorageType=volatile).
OBJECT-TYPE    
  DocsSubMgtCmFilterEntry  

docsSubMgtCmFilterSubDownstream 1.3.6.1.2.1.125.1.6.1.1
The filter group applied to traffic destined for subscribers attached to the referenced CM. Upon row creation, this is set either to zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable) or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is the same as that of the filter group index appearing as docsSubMgtFilterGroupIndex.
OBJECT-TYPE    
  Integer32 0..65535  

docsSubMgtCmFilterSubUpstream 1.3.6.1.2.1.125.1.6.1.2
The filter group applied to traffic originating from subscribers attached to the referenced CM. Upon row creation this is set to either zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is the same as that of the filter group index appearing as docsSubMgtFilterGroupIndex.
OBJECT-TYPE    
  Integer32 0..65535  

docsSubMgtCmFilterCmDownstream 1.3.6.1.2.1.125.1.6.1.3
The filter group applied to traffic destined for the referenced CM itself. Upon row creation this is set either to zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is the same as that of the filter group index appearing as docsSubMgtFilterGroupIndex.
OBJECT-TYPE    
  Integer32 0..65535  

docsSubMgtCmFilterCmUpstream 1.3.6.1.2.1.125.1.6.1.4
The filter group applied to traffic originating from the referenced CM itself. This is set upon row creation to either zero (use default classification, the diffServClfrElementSpecific=zeroDotZero row of diffServClfrElementTable), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is the same as the filter group index appearing as docsSubMgtFilterGroupIndex.
OBJECT-TYPE    
  Integer32 0..65535  

docsSubMgtFilterGroupTable 1.3.6.1.2.1.125.1.7
Provides a collection of referenceable entries to which diffServClfrElementSpecific refers. This table provides filter group indices that can be compared with those signaled during DOCSIS registration. A packet matches an entry from this table if the packet originated from or is destined to a cable modem that registered this index as one of its four filter groups (see docsSubMgtCmFilterTable), and if the packet direction and MAC address select the use of this index among the four.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtFilterGroupEntry

docsSubMgtFilterGroupEntry 1.3.6.1.2.1.125.1.7.1
An entry only exists if needed by the diffServClfrElementEntry. A packet matches this entry if the packet's cable modem registered this index as one of its four filter groups (see docsSubMgtCmFilterTable) and if the packet direction and MAC address select the use of this index among the four.
OBJECT-TYPE    
  DocsSubMgtFilterGroupEntry  

docsSubMgtFilterGroupIndex 1.3.6.1.2.1.125.1.7.1.1
The filter group index, from the set signaled at DOCSIS Registration. Provides a referenceable entry to which diffServClfrElementSpecific points. A packet matches this classifier entry if the packet's cable modem registered this index value as one of its four filter groups, and if the packet direction and MAC address select the use of this index among the four. Because this is the only field in this table, it is read-only, contrary to the usual SMI custom of making indices not-accessible. Note that although zero may be signaled (or defaulted) at DOCSIS Registration to indicate a default filtering group, no such entry appears in this table, as diffServClfrElementSpecific will use a zeroDotZero pointer for that classification.
OBJECT-TYPE    
  Integer32 1..65535  

docsSubMgtConformance 1.3.6.1.2.1.125.2
OBJECT IDENTIFIER    

docsSubMgtCompliances 1.3.6.1.2.1.125.2.1
OBJECT IDENTIFIER    

docsSubMgtGroups 1.3.6.1.2.1.125.2.2
OBJECT IDENTIFIER    

docsSubMgtBasicCompliance 1.3.6.1.2.1.125.2.1.1
An implementation is only required to support thirty filter groups.
MODULE-COMPLIANCE    
  diffServDataPathStatus RowStatus active(1)
  active RowStatus createAndGo(4), destroy(6)
  diffServClfrStatus RowStatus active(1)
  active RowStatus createAndGo(4), destroy(6)
  diffServClfrElementStatus RowStatus active(1)
  active RowStatus createAndGo(4), destroy(6)
  diffServMultiFieldClfrAddrType InetAddressType ipv4(1)
  diffServMultiFieldClfrSrcAddr InetAddress Size(4)
  diffServMultiFieldClfrDstAddr InetAddress Size(4)
  diffServAlgDropStatus RowStatus active(1)
  active RowStatus createAndGo(4), destroy(6)
  diffServDataPathStorage StorageType nonVolatile(3)
  diffServClfrStorage StorageType nonVolatile(3)
  diffServClfrElementStorage StorageType nonVolatile(3)
  diffServMultiFieldClfrStorage StorageType nonVolatile(3)
  diffServActionStorage StorageType nonVolatile(3)
  diffServCountActStorage StorageType nonVolatile(3)
  diffServAlgDropStorage StorageType nonVolatile(3)
  diffServAlgDropType INTEGER alwaysDrop(5)
  docsSubMgtCpeControlMaxCpeIp Integer32 0..16
  docsSubMgtCpeMaxIpDefault Integer32 0..16
  docsSubMgtCpeIpAddressType InetAddressType ipv4(1)
  docsSubMgtCpeIpAddr InetAddress Size(4)
  docsSubMgtCmFilterSubDownstream Integer32 0..30
  docsSubMgtCmFilterSubUpstream Integer32 0..30
  docsSubMgtCmFilterCmDownstream Integer32 0..30
  docsSubMgtCmFilterCmUpstream Integer32 0..30

docsSubMgtGroup 1.3.6.1.2.1.125.2.2.1
The objects used to manage host-based cable modems via a set of CMTS enforced controls.
OBJECT-GROUP