DOCS-SUBMGT-MIB

File: DOCS-SUBMGT-MIB.mib (30910 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
DOCS-IF-MIB

Imported symbols

MODULE-IDENTITY OBJECT-TYPE Counter32
Integer32 experimental TEXTUAL-CONVENTION
RowStatus TruthValue OBJECT-GROUP
MODULE-COMPLIANCE docsIfCmtsCmStatusIndex docsIfCmtsCmStatusEntry

Defined Objects

docsSubMgt 1.3.6.1.3.83.4
This is the CMTS centric subscriber management MIB for DOCSIS compliant CMTS. This will be rooted in experimental space with a future transition to be incorporated into the cable device MIB.
MODULE-IDENTITY    

docsSubMgtObjects 1.3.6.1.3.83.4.1
OBJECT IDENTIFIER    

docsSubMgtCpeControlTable 1.3.6.1.3.83.4.1.1
This table extends the docsIfCmtsCmStatusTable and adds 4 objects which reflect the state of subscriber management on a particular CM.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtCpeControlEntry

docsSubMgtCpeControlEntry 1.3.6.1.3.83.4.1.1.1
A row in the docsSubMgtCpeControlTable. All the values are either set from the system default, or are set from objects included in the DOCSIS registration request sent upstream to the CMTS from the CM.
OBJECT-TYPE    
  DocsSubMgtCpeControlEntry  

docsSubMgtCpeControlMaxCpeIp 1.3.6.1.3.83.4.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. (E.g. if the CM has 5 IP addresses specified for it, this value is 5). This limit applies to learned and docsis-provisioned entries, but does not limit 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..1024  

docsSubMgtCpeControlActive 1.3.6.1.3.83.4.1.1.1.2
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.3.83.4.1.1.1.3
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.3.83.4.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  

docsSubMgtCpeMaxIpDefault 1.3.6.1.3.83.4.1.2
The default value for docsSubMgtCpeControlMaxCpeIp if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to 16.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtCpeActiveDefault 1.3.6.1.3.83.4.1.3
The default value for docsSubMgtCpeControlActive if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to false.
OBJECT-TYPE    
  TruthValue  

docsSubMgtCpeLearnableDefault 1.3.6.1.3.83.4.1.4
The default value for docsSubMgtCpeControlLearnable if not signaled in the DOCSIS Registration request. Upon initial CMTS initialization, this defaults to true.
OBJECT-TYPE    
  TruthValue  

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

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

docsSubMgtCpeIpIndex 1.3.6.1.3.83.4.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 a CMTS receives an IP packet from a CM that contains a source IP address which 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, AND docsSubMgtCpeControlActive is true, then the packet is dropped. Otherwise the packet is forwarded.
OBJECT-TYPE    
  Integer32 1..1024  

docsSubMgtCpeIpAddr 1.3.6.1.3.83.4.1.5.1.2
The IP address either set from provisioning or learned via wiretapping. See docsSubMgtCpeIpIndex for the mechanism.
OBJECT-TYPE    
  IpV4orV6Addr  

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

docsSubMgtPktFilterTable 1.3.6.1.3.83.4.1.6
A table of filter or classifier criteria. Classifiers are assigned by group to the individual CMs. That assignment is made via the configuration objects sent upstream from the CM to the CMTS during registration.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtPktFilterEntry

docsSubMgtPktFilterEntry 1.3.6.1.3.83.4.1.6.1
An entry in the docsSubMgtPktFilterTable.
OBJECT-TYPE    
  DocsSubMgtPktFilterEntry  

docsSubMgtPktFilterGroup 1.3.6.1.3.83.4.1.6.1.1
Identifies an ordered group of filters. Each modem may be associated with a filter group for its upstream traffic (docsSubMgtCmFilterUpstream) and a filter group for its downstream traffic (docsSubMgtCmFilterDownstream). Typically, many modems will use the same filter group.
OBJECT-TYPE    
  Integer32 1..1024  

docsSubMgtPktFilterIndex 1.3.6.1.3.83.4.1.6.1.2
An index which describes the ordering of a set of filter specifications within the group. Filters are applied in index order.
OBJECT-TYPE    
  Integer32 1..1024  

docsSubMgtPktFilterSrcAddr 1.3.6.1.3.83.4.1.6.1.3
The source IP address to match in the packet to be classified. By default, this is the all-zero's IP v4 and v6 address. A packet matches the SrcAddr filter if the following is true: AND (FilterSrcAddr, FilterSrcMask) == AND (Packet SrcAddr, FilterSrcMask). The mask value is applied to both the match value in this table and to the packet IP address.
OBJECT-TYPE    
  IpV4orV6Addr  

docsSubMgtPktFilterSrcMask 1.3.6.1.3.83.4.1.6.1.4
A bit mask that is to be applied to the source address prior to matching. This, taken with the SrcAddr specifies a matching criteria. By default, the pair specifies a filter which matches all source addresses. This mask is not necessarily the same as a subnet mask, but for IPv4 addresses the 1's bits must be leftmost and contiguous. IPv6 masks have no such restriction.
OBJECT-TYPE    
  IpV4orV6Addr  

docsSubMgtPktFilterDstAddr 1.3.6.1.3.83.4.1.6.1.5
The destination IP address to match in the packet to be classified. By default, this is the all-zero's IP v4 and v6 address. A packet matches the DstAddr filter if the following is true: AND (FilterDstAddr, FilterDstMask) == AND (Packet DstAddr, FilterDstMask). The mask value is applied to both the match value in this table and to the packet IP address.
OBJECT-TYPE    
  IpV4orV6Addr  

docsSubMgtPktFilterDstMask 1.3.6.1.3.83.4.1.6.1.6
A bit mask that is to be applied to the destination address prior to matching. This, taken with the DstAddr specifies a matching criteria. By default, the pair specifies a filter which matches all destination addresses. This mask is not necessarily the same as a subnet mask, but for IPv4 addresses the 1's bits must be leftmost and contiguous. IPv6 masks have no such restriction.
OBJECT-TYPE    
  IpV4orV6Addr  

docsSubMgtPktFilterUlp 1.3.6.1.3.83.4.1.6.1.7
Upper level protocol to match. If this value is 256, matches ALL ULP values. Otherwise, this matches the specific protocol value. Note that if the packet ULP is either 6 (tcp) or 17 (udp), then docsSubMgtPktTcpUdpFilterTable must also be consulted (if its entry exists) to see if this entry matches. Obviously, if this value is neither tcp, udp nor 256, then that table need not be matched against.
OBJECT-TYPE    
  Integer32 0..256  

docsSubMgtPktFilterTosValue 1.3.6.1.3.83.4.1.6.1.8
The TOS value to match in the IP packet.
OBJECT-TYPE    
  OCTET STRING SIZE(1)  

docsSubMgtPktFilterTosMask 1.3.6.1.3.83.4.1.6.1.9
The mask to apply against the TOS value to be matched in the IP packet. The default for both these objects taken together matches all TOS values. A packet matches this filter if the following is true: AND (FilterTosValue, FilterTosMask) == AND (Packet TOS Value, FilterTosMask).
OBJECT-TYPE    
  OCTET STRING SIZE(1)  

docsSubMgtPktFilterAction 1.3.6.1.3.83.4.1.6.1.10
The action to take upon this filter matching. Accept means to accept the packet for further processing. Drop means to drop the packet.
OBJECT-TYPE    
  INTEGER accept(1), drop(2)  

docsSubMgtPktFilterMatches 1.3.6.1.3.83.4.1.6.1.11
This object counts the number of times this specific rule has been matched. This is incremented any time this rule is encountered and all components match. It is only incremented for the first (lowest-indexed) filter matching a packet.
OBJECT-TYPE    
  Counter32  

docsSubMgtPktFilterStatus 1.3.6.1.3.83.4.1.6.1.12
Standard rowStatus object for creating this row. Any object in this row which is writable may be changed at any time while the row is active.
OBJECT-TYPE    
  RowStatus  

docsSubMgtTcpUdpFilterTable 1.3.6.1.3.83.4.1.7
This is an adjunct to docsSubMgtPktFilterTable. It provides optional filtering based on elements in TCP or UDP headers. This table is separate from docsSubMgtPktFilterTable only because it is expected to be used more rarely. This table is not consulted unless the upper-layer protocol is TCP, UDP, or 'any'.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtTcpUdpFilterEntry

docsSubMgtTcpUdpFilterEntry 1.3.6.1.3.83.4.1.7.1
Defines filtering criteria for TCP and UDP headers.
OBJECT-TYPE    
  DocsSubMgtTcpUdpFilterEntry  

docsSubMgtTcpUdpSrcPort 1.3.6.1.3.83.4.1.7.1.1
The source port to match. 65536 matches any value in the TCP or UDP source port field.
OBJECT-TYPE    
  Integer32 0..65536  

docsSubMgtTcpUdpDstPort 1.3.6.1.3.83.4.1.7.1.2
The destination port to match. 65536 matches any value in the TCP or UDP destination port field.
OBJECT-TYPE    
  Integer32 0..65536  

docsSubMgtTcpFlagValues 1.3.6.1.3.83.4.1.7.1.3
The value of the flags of interest. The value of this object MUST always be a subset (proper or otherwise) of docsSubMgtTcpFlagMask. An attempt to violate this constraint returns an inconsistentValue error for an SNMPv2 or v3 agent and a badValue error for an SNMPv1 agent.
OBJECT-TYPE    
  BITS urgent(0), ack(1), push(2), reset(3), syn(4), fin(5)  

docsSubMgtTcpFlagMask 1.3.6.1.3.83.4.1.7.1.4
This bit set indicates the flags of interest in the TCP header for the packet to be matched. For example to match all packets where the urgent bit is set, but that are not either syn or fin, the value of docsSubMgtTcpFlagValues would be { urgent }, and the value of this object would be { urgent, syn, fin }
OBJECT-TYPE    
  BITS urgent(0), ack(1), push(2), reset(3), syn(4), fin(5)  

docsSubMgtTcpUdpStatus 1.3.6.1.3.83.4.1.7.1.5
Standard row object for this table. Any object in the conceptual row may be modified regardless of whether this row is active or not.
OBJECT-TYPE    
  RowStatus  

docsSubMgtCmFilterTable 1.3.6.1.3.83.4.1.8
Binds filter groups to modems. This table identifies for each modem the upstream and downstream filter groups that apply to packets for that modem. Zero is used as a distinguished value to mean no filter group.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsSubMgtCmFilterEntry

docsSubMgtCmFilterEntry 1.3.6.1.3.83.4.1.8.1
Binds a filter group to each direction of traffic for a modem.
OBJECT-TYPE    
  DocsSubMgtCmFilterEntry  

docsSubMgtSubFilterDownstream 1.3.6.1.3.83.4.1.8.1.1
The filter group applied to traffic destined for subscribers attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtSubFilterDownDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic destined to hosts attached to this CM.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtSubFilterUpstream 1.3.6.1.3.83.4.1.8.1.2
The filter group applied to traffic originating from subscribers attached to the referenced CM. This is set upon row creation to either the default (docsSubMgtSubFilterUpDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic originating from hosts attached to this CM.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtCmFilterDownstream 1.3.6.1.3.83.4.1.8.1.3
The filter group applied to traffic destined for the referenced CM itself. This is set upon row creation to either the default (docsSubMgtCmFilterDownDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS during registration. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic destined to this CM.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtCmFilterUpstream 1.3.6.1.3.83.4.1.8.1.4
The filter group applied to traffic originating from the referenced CM itself. This is set upon row creation to either the default (docsSubMgtCmFilterUpDefault), or to the value in the provisioning object sent upstream from the CM to the CMTS. The value of this object is a pointer into the docsSubMgtPktFilterTable and refers to all filter rows with matching docsSubMgtPktFilterGroup indices. If there are no matching filter rows in that table, or if this object is set to zero, no filtering is applied to traffic originating from this CM.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtSubFilterDownDefault 1.3.6.1.3.83.4.1.9
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtSubFilterDownstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtSubFilterUpDefault 1.3.6.1.3.83.4.1.10
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtSubFilterUpstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtCmFilterDownDefault 1.3.6.1.3.83.4.1.11
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtCmFilterDownstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtCmFilterUpDefault 1.3.6.1.3.83.4.1.12
Upon a row creation in docsSubMgtCmFilterTable, docsSubMgtCmFilterUpstream is set to this value if no provisioning object is present to override it. This object is persistent across CMTS reboots. Upon initial CMTS initialization, this defaults to 0.
OBJECT-TYPE    
  Integer32 0..1024  

docsSubMgtNotification 1.3.6.1.3.83.4.2
OBJECT IDENTIFIER    

docsSubMgtConformance 1.3.6.1.3.83.4.3
OBJECT IDENTIFIER    

docsSubMgtCompliances 1.3.6.1.3.83.4.3.1
OBJECT IDENTIFIER    

docsSubMgtBasicCompliance 1.3.6.1.3.83.4.3.1.1
The compliance statement for CMTS devices that implement CMTS centric subscriber management.
MODULE-COMPLIANCE    

docsSubMgtGroups 1.3.6.1.3.83.4.3.2
OBJECT IDENTIFIER    

docsSubMgtGroup 1.3.6.1.3.83.4.3.2.1
The objects use to managed host-based cable modems via a set of CMTS enforced controls.
OBJECT-GROUP    

Defined Objects

IpV4orV6Addr  
An IP V4 or V6 address expressed as an octet string. The zero length string is equal to both 0.0.0.0 and the IPv6 :0 address.
TEXTUAL-CONVENTION    
  OCTET STRING SIZE(0 | 4 | 16)  

DocsSubMgtCpeControlEntry  
SEQUENCE    
  Integer32 as docsSubMgtCpeControlMaxCpeIp  
  TruthValue as docsSubMgtCpeControlActive  
  TruthValue as docsSubMgtCpeControlLearnable  
  TruthValue as docsSubMgtCpeControlReset  

DocsSubMgtCpeIpEntry  
SEQUENCE    
  Integer32 as docsSubMgtCpeIpIndex  
  IpV4orV6Addr as docsSubMgtCpeIpAddr  
  TruthValue as docsSubMgtCpeIpLearned  

DocsSubMgtPktFilterEntry  
SEQUENCE    
  Integer32 as docsSubMgtPktFilterGroup  
  Integer32 as docsSubMgtPktFilterIndex  
  IpV4orV6Addr as docsSubMgtPktFilterSrcAddr  
  IpV4orV6Addr as docsSubMgtPktFilterSrcMask  
  IpV4orV6Addr as docsSubMgtPktFilterDstAddr  
  IpV4orV6Addr as docsSubMgtPktFilterDstMask  
  Integer32 as docsSubMgtPktFilterUlp  
  OCTET STRING as docsSubMgtPktFilterTosValue  
  OCTET STRING as docsSubMgtPktFilterTosMask  
  INTEGER as docsSubMgtPktFilterAction  
  Counter32 as docsSubMgtPktFilterMatches  
  RowStatus as docsSubMgtPktFilterStatus  

DocsSubMgtTcpUdpFilterEntry  
SEQUENCE    
  Integer32 as docsSubMgtTcpUdpSrcPort  
  Integer32 as docsSubMgtTcpUdpDstPort  
  BITS as docsSubMgtTcpFlagValues  
  BITS as docsSubMgtTcpFlagMask  
  RowStatus as docsSubMgtTcpUdpStatus  

DocsSubMgtCmFilterEntry  
SEQUENCE    
  Integer32 as docsSubMgtSubFilterDownstream  
  Integer32 as docsSubMgtSubFilterUpstream  
  Integer32 as docsSubMgtCmFilterDownstream  
  Integer32 as docsSubMgtCmFilterUpstream