DOCS-SUBMGT3-MIB

All MIBs › DOCS-SUBMGT3-MIB

Organization: Cable Television Laboratories, Inc.

Last Updated: 2015-06-03

Category: Domain: CATV/Cable, Standard: DOCSIS

Description: Manages DOCSIS 3.0 subscriber management with enhanced CPE control and multi-service subscriber policies.

Start monitoring vendor-neutral, standards-based MIB, any SNMPv3-capable network device (SNMP engine identity/boot/clock status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

What Is DOCS-SUBMGT3-MIB?

DOCS-SUBMGT3-MIB is a CableLabs DOCSIS 3.0 MIB extending subscriber management (CPE control) to both IPv4 and IPv6 traffic between the CMTS and cable modems/CPE devices behind them. It exposes default policy objects controlling maximum CPE address/prefix counts, whether CPE learning and active enforcement are on, and per-device-type (CM, CPE, PS, MTA) upstream/downstream filter defaults. Its monitoring value is subscriber-policy/software status: confirming whether CPE-control policy defaults, such as maximum IPv6 addresses/prefixes per CPE, match provisioning intent helps diagnose a subscriber whose additional devices are being blocked or a CPE exceeding allowed address counts, rather than reporting hardware sensor data. It depends on and extends the base DOCSIS subscriber-management MIB for IPv6 and multi-device-type support. It is deployed on CMTS headend equipment in cable operator networks offering DOCSIS 3.0 service with subscriber-side device control. Engineers can download the DOCS-SUBMGT3-MIB file directly to load it into their MIB browser.

IPNetwork Monitor allows you to monitor SNMP objects defined in DOCS-SUBMGT3-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.

Supported Devices

DOCSIS 3.0 CMTS headend equipment

Monitoring Examples

An operator would poll docsSubmgt3BaseCpeMaxIpv4Def and docsSubmgt3BaseCpeMaxIpv6AddressesDef/docsSubmgt3BaseCpeMaxIpv6PrefixesDef to confirm the default maximum CPE address/prefix counts permitted per cable modem; docsSubmgt3BaseCpeActiveDef and docsSubmgt3BaseCpeLearnableDef would be checked to see whether CPE enforcement and MAC learning are enabled by default, and per-device-type filter defaults such as docsSubmgt3BaseCmFilterDownDef/UpDef or docsSubmgt3BaseMtaFilterDownDef/UpDef would reveal which default packet filters apply to cable modems versus MTAs, useful when a subscriber's VoIP device unexpectedly loses connectivity due to a filter mismatch.

What Can Be Monitored

default max CPE IPv4/IPv6 address and prefix counts
CPE active enforcement / learnable state
per-device-type (CM/CPE/PS/MTA) upstream/downstream filter defaults
subscriber filter policy configuration

Imported Objects

From CLAB-DEF-MIB

DocsL2vpnIfList
clabProjDocsis	OBJECT-IDENTITY

From DOCS-IF3-MIB

docsIf3CmtsCmRegStatusEntry	OBJECT-TYPE
docsIf3CmtsCmRegStatusId	OBJECT-TYPE

From INET-ADDRESS-MIB

InetAddress
InetAddressPrefixLength
InetAddressType
InetPortNumber

From SNMP-TARGET-MIB

SnmpTagList

From SNMPv2-CONF

MODULE-COMPLIANCE
OBJECT-GROUP

From SNMPv2-SMI

Counter64
MODULE-IDENTITY
OBJECT-TYPE
Unsigned32

From SNMPv2-TC

MacAddress
RowStatus
TimeStamp
TruthValue

How to Use in IPNetwork Monitor

Example using docsSubmgt3FilterGrpClassPkts OID:

Select a DOCSIS 3.0 CMTS headend equipment (subscriber CPE IPv4/IPv6 control, vendor-neutral CableLabs standard) as the target host to create a monitor — the SNMP service should be up and running on it. Click New Monitor, then check SNMP Custom on the Favorites tab, click Next, and confirm the host. On the next page, click Select... to open the built-in SNMP MIB Browser and type docsSubmgt3FilterGrpClassPkts into the Find box to locate it in the OID tree, selecting the specific row/instance you want to monitor since this is a table column, then select it and click OK. This attribute counts the number of packets that have been classified (matched) using this rule entry. On the monitor's Main parameters page you can set the target's SNMP port (default 161), credentials, polling interval, and other settings — see the SNMP Monitor help for details. On the State conditions and Alerting tabs, configure when the monitor should change state and trigger an alert; since this is a Counter64-type OID, Value bounds is the most useful condition here — trigger an alert if the counter increases between polls, since a rising count of errors, failures, or discards often points to a real underlying problem. Click Finish to create the monitor; you can adjust any parameter later.

OIDs

OID symbolic	OID numeric	Type	Access	Description
docsSubmgt3Base	1.3.6.1.4.1.4491.2.1.10.1.1
U32 docsSubmgt3BaseCmFilterDownDef	1.3.6.1.4.1.4491.2.1.10.1.1.7	Unsigned32	read-write	This attribute represents the default value for the CM stack downstream filter group applying to the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BaseCmFilterUpDef	1.3.6.1.4.1.4491.2.1.10.1.1.8	Unsigned32	read-write	This attribute represents the default value for the CM stack upstream filter group applying to the CM if the parameter is not signaled in the DOCSIS Registration process.
T/F docsSubmgt3BaseCpeActiveDef	1.3.6.1.4.1.4491.2.1.10.1.1.3	TruthValue	read-write	This attribute represents the default value for enabling Subscriber Management filters and controls in the CM if the parameter is not signaled in the DOCSIS Registration process.
T/F docsSubmgt3BaseCpeLearnableDef	1.3.6.1.4.1.4491.2.1.10.1.1.4	TruthValue	read-write	This attribute represents the default value for enabling the CPE learning process for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BaseCpeMaxIpv4Def	1.3.6.1.4.1.4491.2.1.10.1.1.1	Unsigned32	read-write	This attribute represents the maximum number of IPv4 Addresses allowed for the CM's CPEs if not signaled in the registration process.
U32 docsSubmgt3BaseCpeMaxIpv6AddressesDef	1.3.6.1.4.1.4491.2.1.10.1.1.2	Unsigned32	read-write	This attribute represents the maximum number of IPv6 prefixes or addresses allowed for the CM's CPEs if not signaled in the registration process. All IPv6 addresses, including Link-Local and any address with a scope greater than 1 are counted against the docsSubmgt3BaseCpeMaxIpv6AddressesDef.
U32 docsSubmgt3BaseCpeMaxIpv6PrefixesDef	1.3.6.1.4.1.4491.2.1.10.1.1.15	Unsigned32	read-write	This attribute represents the maximum number of IPv6 IA_PDs (delegated prefixes) allowed for the CM's CPEs if not signaled during the registration process. IPv6 IA_PDs are counted against the CpeMaxIpv6PrefixesDef. This contrasts with the CpeMaxIPv4AddressesDef addresses, rather than IPv4 subnets, allowed by default per CM. Because this attribute only counts IA_PDs against the default, IA_NA addresses and Link-Local addresses are not counted against this default limit.
U32 docsSubmgt3BaseMtaFilterDownDef	1.3.6.1.4.1.4491.2.1.10.1.1.11	Unsigned32	read-write	This attribute represents the default value for the MTA, DVA, SG, or TEA downstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BaseMtaFilterUpDef	1.3.6.1.4.1.4491.2.1.10.1.1.12	Unsigned32	read-write	This attribute represents the default value for the MTA, DVA, SG, or TEA upstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BasePsFilterDownDef	1.3.6.1.4.1.4491.2.1.10.1.1.9	Unsigned32	read-write	This attribute represents the default value for the PS or eRouter downstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BasePsFilterUpDef	1.3.6.1.4.1.4491.2.1.10.1.1.10	Unsigned32	read-write	This attribute represents the default value for the PS or eRouter upstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BaseStbFilterDownDef	1.3.6.1.4.1.4491.2.1.10.1.1.13	Unsigned32	read-write	This attribute represents the default value for the STB or CableCARD downstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BaseStbFilterUpDef	1.3.6.1.4.1.4491.2.1.10.1.1.14	Unsigned32	read-write	This attribute represents the default value for the STB or CableCARD upstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BaseSubFilterDownDef	1.3.6.1.4.1.4491.2.1.10.1.1.5	Unsigned32	read-write	This attribute represents the default value for the subscriber (CPE) downstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
U32 docsSubmgt3BaseSubFilterUpDef	1.3.6.1.4.1.4491.2.1.10.1.1.6	Unsigned32	read-write	This attribute represents the default value for the subscriber (CPE) upstream filter group for the CM if the parameter is not signaled in the DOCSIS Registration process.
docsSubmgt3Compliance	1.3.6.1.4.1.4491.2.1.10.2.1.1			The compliance statement for devices that implement the DOCSIS Subscriber Management 3 MIB.
T/F docsSubmgt3CpeCtrlActive	1.3.6.1.4.1.4491.2.1.10.1.2.1.3	TruthValue	read-write	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 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 the value of the Active attribute of the Base object.
docsSubmgt3CpeCtrlEntry	1.3.6.1.4.1.4491.2.1.10.1.2.1		not-accessible	The conceptual row of docsSubmgt3CpeCtrlTable. The CMTS does not persist the instances of the CpeCtrl object across reinitializations.
TIM docsSubmgt3CpeCtrlLastReset	1.3.6.1.4.1.4491.2.1.10.1.2.1.6	TimeStamp	read-write	This attribute represents the system Up Time of the last set to 'true' of the Reset attribute of this instance. Zero if never reset.
T/F docsSubmgt3CpeCtrlLearnable	1.3.6.1.4.1.4491.2.1.10.1.2.1.4	TruthValue	read-write	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 entries related to this CM. The nature of the learning mechanism is not specified here. If not set through DOCSIS provisioning, this object defaults to the value of the CpeLearnableDef attribute from the Base object. Note that this attribute is only meaningful if docsSubMgtCpeControlActive is 'true' to enforce a limit in the number of CPEs learned. CPE learning is always performed for the CMTS for security reasons.
U32 docsSubmgt3CpeCtrlMaxCpeIpv4	1.3.6.1.4.1.4491.2.1.10.1.2.1.1	Unsigned32	read-write	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 configures this attribute with whichever of the 'Subscriber Management CPE IPv4 List' or 'Subscriber Management Control-Max_CpeIPv4' signaled encodings is greater, or in the absence of all of those provisioning parameters, with the CpeMaxIp v4Def from the Base object. This limit applies to learned and DOCSIS-provisioned entries but not to entries added through some administrative process at the CMTS. Note that this attribute is only meaningful when the Active attribute of the CM is set to 'true'.
U32 docsSubmgt3CpeCtrlMaxCpeIpv6Addresses	1.3.6.1.4.1.4491.2.1.10.1.2.1.2	Unsigned32	read-write	This attribute represents the maximum number of simultaneous IPv6 prefixes and addresses that are permitted for CPEs connected to the CM. When the MaxCpeIpv6Prefix is set to zero (0), all IPv6 CPE traffic from the CM is dropped. The CMTS configures this attribute with whichever of the ('Subscriber Management CPE IPv6 List (TLV 67)' plus 'Subscriber Management CPE IPv6 Prefix List (TLV 61)') or ('Subscriber Management Control Max CPE IPv6 Addresses (TLV 63)') signaled encodings is greater, or in the absence of all of those provisioning parameters, with the MaxIpv6AddressDef from the Base object. This limit applies to learned and DOCSIS-provisioned entries but not to entries added through some administrative process at the CMTS. Note that this attribute is only meaningful when the Active attribute of the CM is set to 'true'. All IPv6 addresses, including Link-Local and any address with a scope greater than 1 are counted against the docsSubmgt3CpeCtrlMaxCpeIpv6Addresses.
U32 docsSubmgt3CpeCtrlMaxCpeIpv6Prefixes	1.3.6.1.4.1.4491.2.1.10.1.2.1.7	Unsigned32	read-write	This attribute represents the maximum number of simultaneous IPv6 IA_PDs (delegated prefixes) that are permitted for CPEs connected to the CM.When the MaxCpeIpv6Prefixes is set to zero (0), all IPv6 CPE traffic from the CM is dropped. The CMTS configures this attribute with whichever of the ('Subscriber Management CPE IPv6 List (TLV 67)' plus 'Subscriber Management CPE IPv6 Prefix List (TLV 61) ') or ('Subscriber Management Control Max CPE IPv6 Addresses (TLV 63)') signaled encodings is greater, or in the absence of all of those provisioning parameters, with the MaxIpv6PrefixesDef from the Base object. This limit applies to learned and DOCSIS-provisioned entries but not to entries added through some administrative process at the CMTS. Note that this attribute is only meaningful when the Active attribute of the CM is set to 'true'. IPv6 IA_PDs s are counted against the CpeCtrlMaxCpeIpv6Prefixes in order to limit the number of simultaneous IA_PDs permitted for the CMs CPEs.
T/F docsSubmgt3CpeCtrlReset	1.3.6.1.4.1.4491.2.1.10.1.2.1.5	TruthValue	read-write	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.
docsSubmgt3CpeCtrlTable	1.3.6.1.4.1.4491.2.1.10.1.2		not-accessible	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.
IP docsSubmgt3CpeIpAddr	1.3.6.1.4.1.4491.2.1.10.1.3.1.3	InetAddress	read-only	This attribute represents the IP address either set from provisioning or learned via address gleaning of the DHCP exchange or some other means.
ADR docsSubmgt3CpeIpAddrPrefixLen	1.3.6.1.4.1.4491.2.1.10.1.3.1.4	InetAddressPrefixLength	read-only	This attribute represents the prefix length associated with the IP prefix (IPv4 or IPv6) that is either set via provisioning or learned via address gleaning of the DHCP exchange or some other means. For IPv4 CPE addresses, this attribute generally reports the value 32 (32 bits) to indicate a unicast IPv4 address. For IPv6 CPE addresses, this attribute represents either a discrete IPv6 IA_NA unicast address (a value of 128 bits, equal to /128 prefix length) or a delegated prefix (IA_PD) and its associated length (such as 56 bits, equal to /56 prefix length).
IPt docsSubmgt3CpeIpAddrType	1.3.6.1.4.1.4491.2.1.10.1.3.1.2	InetAddressType	read-only	The type of Internet address of the Addr attribute, such as IPv4 or IPv6.
docsSubmgt3CpeIpEntry	1.3.6.1.4.1.4491.2.1.10.1.3.1		not-accessible	The conceptual row of docsSubmgt3CpeIpTable.
U32 docsSubmgt3CpeIpId	1.3.6.1.4.1.4491.2.1.10.1.3.1.1	Unsigned32	not-accessible	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 Table' encodings. An entry is created either through the included CPE IP addresses in the provisioning object, or CPEs learned from traffic sourced from the CM.
T/F docsSubmgt3CpeIpLearned	1.3.6.1.4.1.4491.2.1.10.1.3.1.5	TruthValue	read-only	This attribute is set to 'true' when the IP address was learned from IP packets sent upstream rather than via the CM provisioning process.
docsSubmgt3CpeIpTable	1.3.6.1.4.1.4491.2.1.10.1.3		not-accessible	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.
INT docsSubmgt3CpeIpType	1.3.6.1.4.1.4491.2.1.10.1.3.1.6	INTEGER	read-only	This attribute represents the type of CPE based on the following classification below: 'cpe' Regular CPE clients. 'ps' CableHome Portal Server (PS) 'mta' PacketCable Multimedia Terminal Adapter (MTA) 'stb' Digital Set-top Box (STB). 'tea' T1 Emulation adapter (TEA) 'erouter' Embedded Router (eRouter) 'dva' Digital Voice Adapter (DVA) 'sg' Security Gateway (SG) 'card' CableCARD
INT docsSubmgt3FilterGrpAction	1.3.6.1.4.1.4491.2.1.10.1.5.1.3	INTEGER	read-create	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.
C64 docsSubmgt3FilterGrpClassPktsEx	1.3.6.1.4.1.4491.2.1.10.1.5.1.26	Counter64	read-only	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 function drops the packets. Discontinuities in the value of this counter can occur at re-initialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the CM MAC Domain interface.
DOC docsSubmgt3FilterGrpCmInterfaceMask	1.3.6.1.4.1.4491.2.1.10.1.5.1.28	DocsL2vpnIfList	read-create	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.
MAC docsSubmgt3FilterGrpDestMacAddr	1.3.6.1.4.1.4491.2.1.10.1.5.1.18	MacAddress	read-create	This attribute represents the criteria to match against an Ethernet packet MAC address bitwise ANDed with DestMacMask.
MAC docsSubmgt3FilterGrpDestMacMask	1.3.6.1.4.1.4491.2.1.10.1.5.1.19	MacAddress	read-create	An Ethernet packet matches an entry when its destination MAC address bitwise ANDed with the DestMacMask attribute equals the value of the DestMacAddr attribute.
INE docsSubmgt3FilterGrpDestPortEnd	1.3.6.1.4.1.4491.2.1.10.1.5.1.17	InetPortNumber	read-create	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.
INE docsSubmgt3FilterGrpDestPortStart	1.3.6.1.4.1.4491.2.1.10.1.5.1.16	InetPortNumber	read-create	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.
U32 docsSubmgt3FilterGrpEnetProtocol	1.3.6.1.4.1.4491.2.1.10.1.5.1.22	Unsigned32	read-create	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 the attribute EnetProtocolType is 'ethertype', this attribute gives the 16-bit value of the EtherType that the packet must match in order to match the rule. If the attribute EnetProtocolType is 'dsap', the lower 8 bits of this attribute's value must match the DSAP octet of the packet in order to match the rule. If the Ethernet frame contains an 802.1p/Q Tag header (i.e., EtherType 0x8100), this attribute applies to the embedded EtherType field within the 802.1p/Q header.
INT docsSubmgt3FilterGrpEnetProtocolType	1.3.6.1.4.1.4491.2.1.10.1.5.1.21	INTEGER	read-create	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' means that the rule applies only to frames that contain an EtherType value. EtherType values are contained in packets using the DEC-Intel-Xerox (DIX) encapsulation or the RFC 1042 Sub-Network Access Protocol (SNAP) encapsulation formats. A value of 'dsap' means that the rule applies only to frames using the IEEE802.3 encapsulation format with a Destination Service Access Point (DSAP) other than 0xAA (which is reserved for SNAP). A value of 'mac' means that the rule applies only to MAC management messages for MAC management messages. A value of 'all' means that the rule matches all Ethernet packets. If the Ethernet frame contains an 802.1P/Q Tag header (i.e., EtherType 0x8100), this attribute applies to the embedded EtherType field within the 802.1p/Q header. The value 'mac' is only used for passing UDCs to CMs during Registration. The CMTS ignores filter rules that include the value of this attribute set to 'mac' for CMTS enforced upstream and downstream subscriber management filter group rules.
docsSubmgt3FilterGrpEntry	1.3.6.1.4.1.4491.2.1.10.1.5.1		not-accessible	The conceptual row of docsSubmgt3FilterGrpTable. The CMTS persists all instances of the FilterGrp object across reinitializations.
U32 docsSubmgt3FilterGrpFlowLabel	1.3.6.1.4.1.4491.2.1.10.1.5.1.27	Unsigned32	read-create	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 packets.
U32 docsSubmgt3FilterGrpGrpId	1.3.6.1.4.1.4491.2.1.10.1.5.1.1	Unsigned32	not-accessible	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 defined in the Grp object. Typically, many CMs share a common set of filter groups.
IPt docsSubmgt3FilterGrpInetAddrType	1.3.6.1.4.1.4491.2.1.10.1.5.1.9	InetAddressType	read-create	The type of the Internet address for InetSrcAddr, InetSrcMask, InetDestAddr, and InetDestMask.
IP docsSubmgt3FilterGrpInetDestAddr	1.3.6.1.4.1.4491.2.1.10.1.5.1.12	InetAddress	read-create	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 value equals the InetDestAddr value. The address type of this object is specified by the InetAddrType attribute.
IP docsSubmgt3FilterGrpInetDestMask	1.3.6.1.4.1.4491.2.1.10.1.5.1.13	InetAddress	read-create	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 value equals the InetDestAddr value. The address type of this object is specified by InetAddrType.
IP docsSubmgt3FilterGrpInetSrcAddr	1.3.6.1.4.1.4491.2.1.10.1.5.1.10	InetAddress	read-create	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 the InetSrcAddr value. The address type of this object is specified by the InetAddressType attribute.
IP docsSubmgt3FilterGrpInetSrcMask	1.3.6.1.4.1.4491.2.1.10.1.5.1.11	InetAddress	read-create	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 the InetSrcAddr value. The address type of this object is specified by InetAddrType.
U32 docsSubmgt3FilterGrpIpProtocol	1.3.6.1.4.1.4491.2.1.10.1.5.1.8	Unsigned32	read-create	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.
OCT docsSubmgt3FilterGrpIpTosHigh	1.3.6.1.4.1.4491.2.1.10.1.5.1.6	OCTET STRING	read-create	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 RFC 791, has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168).
OCT docsSubmgt3FilterGrpIpTosLow	1.3.6.1.4.1.4491.2.1.10.1.5.1.5	OCTET STRING	read-create	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 originally defined in RFC 791, has been superseded by the 6-bit Differentiated Services Field (DSField, RFC 3260) and the 2-bit Explicit Congestion Notification Field (ECN field, RFC 3168).
OCT docsSubmgt3FilterGrpIpTosMask	1.3.6.1.4.1.4491.2.1.10.1.5.1.7	OCTET STRING	read-create	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.
U32 docsSubmgt3FilterGrpPriority	1.3.6.1.4.1.4491.2.1.10.1.5.1.4	Unsigned32	read-create	This attribute defines the order in which classifiers are compared against packets. The higher the value, the higher the priority.
ROW docsSubmgt3FilterGrpRowStatus	1.3.6.1.4.1.4491.2.1.10.1.5.1.29	RowStatus	read-create	The conceptual row status of this object.
U32 docsSubmgt3FilterGrpRuleId	1.3.6.1.4.1.4491.2.1.10.1.5.1.2	Unsigned32	not-accessible	This key represents an ordered classifier identifier within the group. Filters are applied in order if the Priority attribute is not supported.
MAC docsSubmgt3FilterGrpSrcMacAddr	1.3.6.1.4.1.4491.2.1.10.1.5.1.20	MacAddress	read-create	This attribute represents the value to match against an Ethernet packet source MAC address.
INE docsSubmgt3FilterGrpSrcPortEnd	1.3.6.1.4.1.4491.2.1.10.1.5.1.15	InetPortNumber	read-create	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.
INE docsSubmgt3FilterGrpSrcPortStart	1.3.6.1.4.1.4491.2.1.10.1.5.1.14	InetPortNumber	read-create	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.
docsSubmgt3FilterGrpTable	1.3.6.1.4.1.4491.2.1.10.1.5		not-accessible	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.
U32 docsSubmgt3FilterGrpUserPriHigh	1.3.6.1.4.1.4491.2.1.10.1.5.1.24	Unsigned32	read-create	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 Ethernet packets must have a 3-bit Priority field within the range of PriLow to PriHigh in order to match this rule.
U32 docsSubmgt3FilterGrpUserPriLow	1.3.6.1.4.1.4491.2.1.10.1.5.1.23	Unsigned32	read-create	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 Ethernet packets must have a 3-bit Priority field within the range of PriLow to PriHigh in order to match this rule.
U32 docsSubmgt3FilterGrpVlanId	1.3.6.1.4.1.4491.2.1.10.1.5.1.25	Unsigned32	read-create	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.
docsSubmgt3Group	1.3.6.1.4.1.4491.2.1.10.2.2.1			Group of objects implemented in the CMTS.
U32 docsSubmgt3GrpCmFilterDs	1.3.6.1.4.1.4491.2.1.10.1.4.1.5	Unsigned32	read-write	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 during the CM registration or in its absence, to the CmFilterDownDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic destined to the CM.
U32 docsSubmgt3GrpCmFilterUs	1.3.6.1.4.1.4491.2.1.10.1.4.1.6	Unsigned32	read-write	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 signaled during the CM registration or in its absence, to the SubFilterUpDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic originating from this CM.
docsSubmgt3GrpEntry	1.3.6.1.4.1.4491.2.1.10.1.4.1		not-accessible	The conceptual row of docsSubmgt3GrpTable. The CMTS does not persist the instances of the Grp object across reinitializations.
U32 docsSubmgt3GrpMtaFilterDs	1.3.6.1.4.1.4491.2.1.10.1.4.1.9	Unsigned32	read-write	This attribute represents the filter group applied to traffic destined to the Embedded PacketCable Multimedia Terminal Adapter, Embedded PacketCable 2.0 Digital Voice Adaptor, Embedded PacketCable Security, Monitoring, and Automation Gateway, or Embedded T1/E1 TDM Emulation Adapter on the referenced CM. This value corresponds to the 'MTA Downstream Group' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterDownDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic destined to the Embedded PacketCable Multimedia Terminal Adapter, Embedded PacketCable 2.0 Digital Voice Adaptor, Embedded PacketCable Security, Monitoring, and Automation Gateway, or Embedded T1/E1 TDM Emulation Adapter on this CM.
U32 docsSubmgt3GrpMtaFilterUs	1.3.6.1.4.1.4491.2.1.10.1.4.1.10	Unsigned32	read-write	This attribute represents the filter group applied to traffic originating from the Embedded PacketCable Multimedia Terminal Adapter, Embedded PacketCable 2.0 Digital Voice Adaptor, Embedded PacketCable Security, Monitoring, and Automation Gateway, or Embedded T1/E1 TDM Emulation Adapter on the referenced CM. This value corresponds to the 'MTA Upstream Group' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterUpDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic originating from the Embedded PacketCable Multimedia Terminal Adapter, Embedded PacketCable 2.0 Digital Voice Adaptor, Embedded PacketCable Security, Monitoring, and Automation Gateway, or Embedded T1/E1 TDM Emulation Adapter on this CM.
U32 docsSubmgt3GrpPsFilterDs	1.3.6.1.4.1.4491.2.1.10.1.4.1.7	Unsigned32	read-write	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 Group' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterDownDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic destined to the Embedded CableHome Portal Services Element or Embedded Router on this CM.
U32 docsSubmgt3GrpPsFilterUs	1.3.6.1.4.1.4491.2.1.10.1.4.1.8	Unsigned32	read-write	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' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterUpDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic originating from the Embedded CableHome Portal Services Element or Embedded Router on this CM.
U32 docsSubmgt3GrpStbFilterDs	1.3.6.1.4.1.4491.2.1.10.1.4.1.11	Unsigned32	read-write	This attribute represents the filter group applied to traffic destined for the Embedded Set-Top Box or CableCARD on the referenced CM. This value corresponds to the 'STB Downstream Group' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterDownDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic destined to the Embedded Set-Top Box or CableCARD on this CM.
U32 docsSubmgt3GrpStbFilterUs	1.3.6.1.4.1.4491.2.1.10.1.4.1.12	Unsigned32	read-write	This attribute represents the filter group applied to traffic originating from the Embedded Set-Top Box or CableCARD on the referenced CM. This value corresponds to the 'STB Upstream Group' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterUpDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic originating from the Embedded Set-Top Box or CableCARD on this CM.
U32 docsSubmgt3GrpSubFilterDs	1.3.6.1.4.1.4491.2.1.10.1.4.1.3	Unsigned32	read-write	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' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterDownDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic destined to hosts attached to this CM.
U32 docsSubmgt3GrpSubFilterUs	1.3.6.1.4.1.4491.2.1.10.1.4.1.4	Unsigned32	read-write	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' value of the 'Subscriber Management Filter Groups' encoding signaled during the CM registration or in its absence, to the SubFilterUpDef attribute of the Base object. The value zero or a filter group ID not configured in the CMTS means no filtering is applied to traffic originating from hosts attached to this CM.
docsSubmgt3GrpTable	1.3.6.1.4.1.4491.2.1.10.1.4		not-accessible	This object defines the set of downstream and upstream filter groups that the CMTS applies to traffic associated with that CM.
SNM docsSubMgt3GrpUdcGroupIds	1.3.6.1.4.1.4491.2.1.10.1.4.1.1	SnmpTagList	read-write	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 reports them as decimal numbers that are space-separated. The zero-length string indicates that the CM didn't signal UDC Group IDs. This attribute provides two functions: - Communicate the CM the configured UDC Group ID(s), irrespective of the CM being provisioned to filter upstream traffic based on IP Filters or UDCs. - Optionally, and with regards to the CMTS, if the value of the attribute UdcSentInReqRsp is 'true', indicates that the filtering rules associated with the Subscriber Management Group ID(s) will be sent during registration to the CM. It is vendor specific whether the CMTS updates individual CM UDCs after registration when rules are changed in the Grp object.
T/F docsSubMgt3GrpUdcSentInRegRsp	1.3.6.1.4.1.4491.2.1.10.1.4.1.2	TruthValue	read-write	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 UDCs to a CM, the CMTS MAC Domain needed to be enabled via the MAC Domain attribute SendUdcRulesEnabled and the CM had indicated the UDC capability support during the registration process. The value 'false' indicates that the CMTS was not enabled to sent UDCs to the CMs in the MAC Domain, or the CM does not advertised UDC support in its capabilities encodings, or both. Since the CMTS capability to sent UDCs to CMs during the registration process is optional, the CMTS is not required to implement the value 'true'.
docsSubmgt3Mib	1.3.6.1.4.1.4491.2.1.10			This MIB module contains the management objects for the CMTS control of the IP4 and IPv6 traffic with origin and destination to CMs and/or CPEs behind the CM.
docsSubmgt3MibCompliances	1.3.6.1.4.1.4491.2.1.10.2.1
docsSubmgt3MibConformance	1.3.6.1.4.1.4491.2.1.10.2
docsSubmgt3MibGroups	1.3.6.1.4.1.4491.2.1.10.2.2
docsSubmgt3MibObjects	1.3.6.1.4.1.4491.2.1.10.1

RFC description

CMTS subscriber management MIB for controlling IPv4 and IPv6 traffic to/from cable modems and CPEs.

Start monitoring DOCSIS 3.0 CMTS headend equipment (subscriber CPE IPv4/IPv6 control, vendor-neutral CableLabs standard) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download DOCS-SUBMGT3-MIB