DOCS-SUBMGT3-MIB Table View

This object maintains per-CM traffic policies enforced 
by the CMTS. The CMTS acquires the CM traffic policies 
through the CM registration process, or in the 
absence of some or all of those parameters, from the 
Base object. The CM information and controls are meaningful 
and used by the CMTS, but only after the CM is 
operational.

docsSubmgt3CpeCtrlEntry row .1.3.6.1.4.1.4491.2.1.10.1.2.1

The conceptual row of docsSubmgt3CpeCtrlTable.
The CMTS does not persist the instances of the CpeCtrl
object across reinitializations.

Indexes

No indexes recorded

Column	Syntax	OID
docsSubmgt3CpeCtrlMaxCpeIpv4 This attribute represents the number of simultaneous IP v4 addresses permitted for CPE connected to the CM. When the MaxCpeIpv4 attribute is set to zero (0), all Ipv4 CPE traffic from the CM is dropped. The CMTS conf…	Unsigned32r/w Constraints: range: 0-1023	.1.3.6.1.4.1.4491.2.1.10.1.2.1.1
docsSubmgt3CpeCtrlMaxCpeIpv6Prefix This attribute represents the number of simultaneous IPv6 prefixes permitted for CPE connected to the CM. When the MaxCpeIpv6Prefix is set to zero (0), all IPv6 CPE traffic from the CM is dropped. The CMTS configu…	Unsigned32r/w Constraints: range: 0-1023	.1.3.6.1.4.1.4491.2.1.10.1.2.1.2
docsSubmgt3CpeCtrlActive This attribute controls the application of subscriber management to this CM. If this is set to 'true', CMTS-based CPE control is active, and all the actions required by the various filter policies and controls apply…	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.4491.2.1.10.1.2.1.3
docsSubmgt3CpeCtrlLearnable This attribute controls whether the CMTS may learn (and pass traffic for) CPE IP addresses associated with a CM. If this is set to 'true', the CMTS may learn up to the CM MaxCpeIp value less any DOCSIS-provisioned e…	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.4491.2.1.10.1.2.1.4
docsSubmgt3CpeCtrlReset If set to 'true', this attribute commands the CMTS to delete the instances denoted as 'learned' addresses in the CpeIp object. This attribute always returns false on read.	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.4491.2.1.10.1.2.1.5
docsSubmgt3CpeCtrlLastReset This attribute represents the system Up Time of the last set to 'true' of the Reset attribute of this instance. Zero if never reset.	SNMPv2-TCTimeStampr/w Based On: SNMPv2-SMITimeTicks Description: The value of the sysUpTime object at which a specific occurrence happened. The specific occurrence must be defined in the description of any object defined using this type. If sysUpTime is reset t…	.1.3.6.1.4.1.4491.2.1.10.1.2.1.6

This object defines the list of IP Addresses behind 
the CM known by the CMTS. 
          
If the Active attribute of the CpeCtrl object associated 
with a CM is set to 'true' and the CMTS receives an 
IP packet from a CM that contains a source IP address that 
does not match one of the CPE IP addresses associated 
with this CM, one of two things occurs. If the number 
of CPE IPs is less than the MaxCpeIp of the CpeCtrl object 
for that CM, the source IP address is added to this 
object and the packet is forwarded; otherwise, the 
packet is dropped.

docsSubmgt3CpeIpEntry row .1.3.6.1.4.1.4491.2.1.10.1.3.1

The conceptual row of docsSubmgt3CpeIpTable.

Indexes

DOCS-IF3-MIBdocsIf3CmtsCmRegStatusId docsSubmgt3CpeIpId

Column	Syntax	OID
docsSubmgt3CpeIpId This attribute represents a unique identifier for a CPE IP of the CM. An instance of this attribute exists for each CPE provisioned in the 'Subscriber Management CPE IPv4 Table' or 'Subscriber Management CPE IPv6 Ta…	Unsigned32 Constraints: range: 1-1023	.1.3.6.1.4.1.4491.2.1.10.1.3.1.1
docsSubmgt3CpeIpAddrType The type of Internet address of the Addr attribute.	INET-ADDRESS-MIBInetAddressType Type Values: 0 unknown 1 ipv4 2 ipv6 3 ipv4z 4 ipv6z 16 dns 25 l2vpn	.1.3.6.1.4.1.4491.2.1.10.1.3.1.2
docsSubmgt3CpeIpAddr This attribute represents the IP address either set from provisioning or learned via address gleaning or other forwarding means.	INET-ADDRESS-MIBInetAddress Type Constraints: range: 0..255	.1.3.6.1.4.1.4491.2.1.10.1.3.1.3
docsSubmgt3CpeIpAddrPrefixLen This attribute represents the prefix length associated with the IP subnet prefix either set from provisioning or learned via address gleaning or other forwarding means. For IPv4 CPE addresses this attribute generally…	INET-ADDRESS-MIBInetAddressPrefixLength Type Constraints: range: 0..2040	.1.3.6.1.4.1.4491.2.1.10.1.3.1.4
docsSubmgt3CpeIpLearned This attribute is set to 'true' when the IP address was learned from IP packets sent upstream rather than via the CM provisioning process.	SNMPv2-TCTruthValue Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.4491.2.1.10.1.3.1.5
docsSubmgt3CpeIpType This attribute represents the type of CPE based on the following classification below: 'cpe' Regular CPE clients. 'ps' CableHome Portal Server (PS) 'mta' PacketCable Multimedi…	Enumeration Enumerated Values: 1 cpe 2 ps 3 mta 4 stb 5 tea 6 erouter	.1.3.6.1.4.1.4491.2.1.10.1.3.1.6

This object defines the set of downstream and upstream 
filter groups that the CMTS applies to traffic associated 
with that CM.

docsSubmgt3GrpEntry row .1.3.6.1.4.1.4491.2.1.10.1.4.1

The conceptual row of docsSubmgt3GrpTable.
The CMTS does not persist the instances of the Grp
object across reinitializations.

Indexes

No indexes recorded

Column	Syntax	OID
docsSubMgt3GrpUdcGroupIds This attribute represents the filter group(s) associated with the CM signaled 'Upstream Drop Classifier Group ID' encodings during the registration process. UDC Group IDs are integer values and this attribute report…	SNMP-TARGET-MIBSnmpTagListr/w Type Constraints: range: 0..255	.1.3.6.1.4.1.4491.2.1.10.1.4.1.1
docsSubMgt3GrpUdcSentInRegRsp This attribute represents the CMTS upstream filtering status for this CM. The value 'true' indicates that the CMTS has sent UDCs to the CM during registration process. In order for a CMTS to send U…	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.4.1.4491.2.1.10.1.4.1.2
docsSubmgt3GrpSubFilterDs This attribute represents the filter group applied to traffic destined for subscriber's CPE attached to the referenced CM (attached to CM CPE interfaces). This value corresponds to the 'Subscriber Downstream Group' …	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.3
docsSubmgt3GrpSubFilterUs This attribute represents the filter group applied to traffic originating from subscriber's CPE attached to the referenced CM (attached to CM CPE interfaces). This value corresponds to the 'Subscriber Upstream Group…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.4
docsSubmgt3GrpCmFilterDs This attribute represents the filter group applied to traffic destined for the CM itself. This value corresponds to the 'CM Downstream Group' value of the 'Subscriber Management Filter Groups' encoding signaled duri…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.5
docsSubmgt3GrpCmFilterUs This attribute represents the filter group applied to traffic originating from the CM itself. This value corresponds to the 'Subscriber Upstream Group' value of the 'Subscriber Management Filter Groups' encoding sig…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.6
docsSubmgt3GrpPsFilterDs This attribute represents the filter group applied to traffic destined to the Embedded CableHome Portal Services Element or the Embedded Router on the referenced CM. This value corresponds to the 'PS Downstream Grou…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.7
docsSubmgt3GrpPsFilterUs This attribute represents the filter group applied to traffic originating from the Embedded CableHome Portal Services Element or Embedded Router on the referenced CM. This value corresponds to the 'PS Upstream Group…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.8
docsSubmgt3GrpMtaFilterDs This attribute represents the filter group applied to traffic destined to the Embedded Multimedia Terminal Adapter on the referenced CM. This value corresponds to the 'MTA Downstream Group' value of the 'Subscriber …	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.9
docsSubmgt3GrpMtaFilterUs This attribute represents the filter group applied to traffic originating from the Embedded Multimedia Terminal Adapter on the referenced CM. This value corresponds to the 'MTA Upstream Group' value of the 'Subscrib…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.10
docsSubmgt3GrpStbFilterDs This attribute represents the filter group applied to traffic destined for the Embedded Set-Top Box on the referenced CM. This value corresponds to the 'STB Downstream Group' value of the 'Subscriber Management Filt…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.11
docsSubmgt3GrpStbFilterUs This attribute represents the filter group applied to traffic originating from the Embedded Set-Top Box on the referenced CM. This value corresponds to the 'STB Upstream Group' value of the 'Subscriber Management Fi…	Unsigned32r/w Constraints: range: 0-1024	.1.3.6.1.4.1.4491.2.1.10.1.4.1.12

This object describes a set of filter or classifier 
criteria. Classifiers are assigned by group to the 
individual CMs. That assignment is made via the 'Subscriber 
Management TLVs' encodings sent upstream from 
the CM to the CMTS during registration or in their 
absence, default values configured in the CMTS. 
A Filter Group ID (GrpId) is a set of rules that correspond 
to the expansion of a UDC Group ID into UDC individual  
classification rules.  The Filter Group Ids are generated  
whenever the CMTS is configured to send UDCs during the CM  
registration process. Implementation of L2 classification  
criteria is optional for the CMTS; LLC/MAC upstream and  
downstream filter criteria can be ignored during the packet 
matching process.

docsSubmgt3FilterGrpEntry row .1.3.6.1.4.1.4491.2.1.10.1.5.1

The conceptual row of docsSubmgt3FilterGrpTable.
The CMTS persists all instances of the FilterGrp object
across reinitializations.

Indexes

docsSubmgt3FilterGrpGrpId docsSubmgt3FilterGrpRuleId

Column	Syntax	OID
docsSubmgt3FilterGrpGrpId This key is an identifier for a set of classifiers known as a filter group. Each CM may be associated with several filter groups for its upstream and downstream traffic, one group per target end point on the CM as d…	Unsigned32 Constraints: range: 1-65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.1
docsSubmgt3FilterGrpRuleId This key represents an ordered classifier identifier within the group. Filters are applied in order if the Priority attribute is not supported.	Unsigned32 Constraints: range: 1-65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.2
docsSubmgt3FilterGrpAction This attribute represents the action to take upon this filter matching. 'permit' means to stop the classification matching and accept the packet for further processing. 'deny' means to drop the packet.	Enumerationr/w Enumerated Values: 1 permit 2 deny	.1.3.6.1.4.1.4491.2.1.10.1.5.1.3
docsSubmgt3FilterGrpPriority This attribute defines the order in which classifiers are compared against packets. The higher the value, the higher the priority.	Unsigned32r/w Constraints: range: 0-65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.4
docsSubmgt3FilterGrpIpTosLow This attribute represents the low value of a range of ToS (Type of Service) octet values. This object is defined as an 8-bit octet as per the DOCSIS Specification for packet classification. The IP ToS octet, as orig…	OctetStringr/w Constraints: range: 1-1	.1.3.6.1.4.1.4491.2.1.10.1.5.1.5
docsSubmgt3FilterGrpIpTosHigh This attribute represents the high value of a range of ToS octet values. This object is defined as an 8-bit octet as per the DOCSIS Specification for packet classification. The IP ToS octet, as originally defined in …	OctetStringr/w Constraints: range: 1-1	.1.3.6.1.4.1.4491.2.1.10.1.5.1.6
docsSubmgt3FilterGrpIpTosMask This attribute represents the mask value that is bitwise ANDed with ToS octet in an IP packet, and the resulting value is used for range checking of IpTosLow and IpTosHigh.	OctetStringr/w Constraints: range: 1-1	.1.3.6.1.4.1.4491.2.1.10.1.5.1.7
docsSubmgt3FilterGrpIpProtocol This attribute represents the value of the IP Protocol field required for IP packets to match this rule. The value 256 matches traffic with any IP Protocol value. The value 257 by convention matches both TCP and UDP.	Unsigned32r/w Constraints: range: 0-257	.1.3.6.1.4.1.4491.2.1.10.1.5.1.8
docsSubmgt3FilterGrpInetAddrType The type of the Internet address for InetSrcAddr, InetSrcMask, InetDestAddr, and InetDestMask.	INET-ADDRESS-MIBInetAddressTyper/w Type Values: 0 unknown 1 ipv4 2 ipv6 3 ipv4z 4 ipv6z 16 dns 25 l2vpn	.1.3.6.1.4.1.4491.2.1.10.1.5.1.9
docsSubmgt3FilterGrpInetSrcAddr This attribute specifies the value of the IP Source Address required for packets to match this rule. An IP packet matches the rule when the packet's IP Source Address bitwise ANDed with the InetSrcMask value equals …	INET-ADDRESS-MIBInetAddressr/w Type Constraints: range: 0..255	.1.3.6.1.4.1.4491.2.1.10.1.5.1.10
docsSubmgt3FilterGrpInetSrcMask This attribute represents which bits of a packet's IP Source Address are compared to match this rule. An IP packet matches the rule when the packet's IP Source Address bitwise ANDed with the InetSrcMask value equals …	INET-ADDRESS-MIBInetAddressr/w Type Constraints: range: 0..255	.1.3.6.1.4.1.4491.2.1.10.1.5.1.11
docsSubmgt3FilterGrpInetDestAddr This attribute specifies the value of the IP Destination Address required for packets to match this rule. An IP packet matches the rule when the packet's IP Destination Address bitwise ANDed with the InetSrcMask val…	INET-ADDRESS-MIBInetAddressr/w Type Constraints: range: 0..255	.1.3.6.1.4.1.4491.2.1.10.1.5.1.12
docsSubmgt3FilterGrpInetDestMask This attribute represents which bits of a packet's IP Destination Address are compared to match this rule. An IP packet matches the rule when the packet's IP Destination Address bitwise ANDed with the InetDestMask va…	INET-ADDRESS-MIBInetAddressr/w Type Constraints: range: 0..255	.1.3.6.1.4.1.4491.2.1.10.1.5.1.13
docsSubmgt3FilterGrpSrcPortStart This attribute represents the low-end inclusive range of TCP/UDP source port numbers to which a packet is compared. This attribute is irrelevant for non-TCP/UDP IP packets.	INET-ADDRESS-MIBInetPortNumberr/w Type Constraints: range: 0..65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.14
docsSubmgt3FilterGrpSrcPortEnd This attribute represents the high-end inclusive range of TCP/UDP source port numbers to which a packet is compared. This attribute is irrelevant for non-TCP/UDP IP packets.	INET-ADDRESS-MIBInetPortNumberr/w Type Constraints: range: 0..65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.15
docsSubmgt3FilterGrpDestPortStart This attribute represents the low-end inclusive range of TCP/UDP destination port numbers to which a packet is compared. This attribute is irrelevant for non-TCP/UDP IP packets.	INET-ADDRESS-MIBInetPortNumberr/w Type Constraints: range: 0..65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.16
docsSubmgt3FilterGrpDestPortEnd This attribute represents the high-end inclusive range of TCP/UDP destination port numbers to which a packet is compared. This attribute is irrelevant for non-TCP/UDP IP packets.	INET-ADDRESS-MIBInetPortNumberr/w Type Constraints: range: 0..65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.17
docsSubmgt3FilterGrpDestMacAddr This attribute represents the criteria to match against an Ethernet packet MAC address bitwise ANDed with DestMacMask.	SNMPv2-TCMacAddressr/w Type Constraints: range: 6 Description: Represents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires M…	.1.3.6.1.4.1.4491.2.1.10.1.5.1.18
docsSubmgt3FilterGrpDestMacMask An Ethernet packet matches an entry when its destination MAC address bitwise ANDed with the DestMacMask attribute equals the value of the DestMacAddr attribute.	SNMPv2-TCMacAddressr/w Type Constraints: range: 6 Description: Represents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires M…	.1.3.6.1.4.1.4491.2.1.10.1.5.1.19
docsSubmgt3FilterGrpSrcMacAddr This attribute represents the value to match against an Ethernet packet source MAC address.	SNMPv2-TCMacAddressr/w Type Constraints: range: 6 Description: Represents an 802 MAC address represented in the `canonical' order defined by IEEE 802.1a, i.e., as if it were transmitted least significant bit first, even though 802.5 (in contrast to other 802.x protocols) requires M…	.1.3.6.1.4.1.4491.2.1.10.1.5.1.20
docsSubmgt3FilterGrpEnetProtocolType This attribute indicates the format of the layer 3 protocol ID in the Ethernet packet. A value of 'none' means that the rule does not use the layer 3 protocol type as a matching criteria. A value of 'ethertype' mean…	Enumerationr/w Enumerated Values: 0 none 1 ethertype 2 dsap 3 mac 4 all	.1.3.6.1.4.1.4491.2.1.10.1.5.1.21
docsSubmgt3FilterGrpEnetProtocol This attribute represents the Ethernet protocol type to be matched against the packets. For EnetProtocolType set to 'none', this attribute is ignored when considering whether a packet matches the current rule. If th…	Unsigned32r/w Constraints: range: 0-65535	.1.3.6.1.4.1.4491.2.1.10.1.5.1.22
docsSubmgt3FilterGrpUserPriLow This attribute applies only to Ethernet frames using the 802.1p/Q tag header (indicated with EtherType 0x8100). Such frames include a 16-bit Tag that contains a 3-bit Priority field and a 12-bit VLAN number. Tagged …	Unsigned32r/w Constraints: range: 0-7	.1.3.6.1.4.1.4491.2.1.10.1.5.1.23
docsSubmgt3FilterGrpUserPriHigh This attribute applies only to Ethernet frames using the 802.1p/Q tag header (indicated with EtherType 0x8100). Such frames include a 16-bit Tag that contains a 3-bit Priority field and a 12-bit VLAN number. Tagged …	Unsigned32r/w Constraints: range: 0-7	.1.3.6.1.4.1.4491.2.1.10.1.5.1.24
docsSubmgt3FilterGrpVlanId This attribute applies only to Ethernet frames using the 802.1p/Q tag header. Tagged packets must have a VLAN Identifier that matches the value in order to match the rule.	Unsigned32r/w Constraints: range: 0-4094	.1.3.6.1.4.1.4491.2.1.10.1.5.1.25
docsSubmgt3FilterGrpClassPkts This attribute counts the number of packets that have been classified (matched) using this rule entry. This includes all packets delivered to a Service Flow maximum rate policing function, whether or not that functi…	SNMPv2-SMICounter64 Type Constraints: range: 0..18446744073709551615	.1.3.6.1.4.1.4491.2.1.10.1.5.1.26
docsSubmgt3FilterGrpFlowLabel This attribute represents the Flow Label field in the IPv6 header to be matched by the classifier. The value zero indicates that the Flow Label is not specified as part of the classifier and is not matched against pa…	Unsigned32r/w Constraints: range: 0-1048575	.1.3.6.1.4.1.4491.2.1.10.1.5.1.27
docsSubmgt3FilterGrpCmInterfaceMask This attribute represents a bit-mask of the CM in-bound interfaces to which this classifier applies. This attribute only applies to upstream Drop Classifiers being sent to CMs during the registration process.	DOCS-L2VPN-MIBDocsL2vpnIfListr/w Type Values: 0 eCm 1 cmci 2 docsCableMacLayer 3 docsCableDownstream 4 docsCableUpstream 16 eMta 17 eStbIp 18 eStbDsg	.1.3.6.1.4.1.4491.2.1.10.1.5.1.28
docsSubmgt3FilterGrpRowStatus The conceptual row status of this object.	SNMPv2-TCRowStatusr/w Type Values: 1 active 2 notInService 3 notReady 4 createAndGo 5 createAndWait 6 destroy Description: The RowStatus textual convention is used to manage the creation and deletion of conceptual rows, and is used as the value of the SYNTAX clause for the status column of a conceptual row (as described in Section 7.7.1 of …	.1.3.6.1.4.1.4491.2.1.10.1.5.1.29