DOCS-SUBMGT-MIB
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.
54
Objects
Active
Status
5
Dependencies
Imported Objects
Objects
54 total| Object Name |
|---|
docsSubMgt OBJECT IDENTIFIER .1.3.6.1.3.83.4 |
RFC1155-SMI Unknown .1.3.6.1.3.83.4 |
docsSubMgtObjects OBJECT IDENTIFIER .1.3.6.1.3.83.4.1 |
docsSubMgtCpeControlTableThis table extends the docsIfCmtsCmStatusTable and adds 4
objects which reflect the state of subscriber management on a
particular CM. SEQUENCE OF DocsSubMgtCpeControlEntry .1.3.6.1.3.83.4.1.1 |
docsSubMgtCpeControlEntryA 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. DocsSubMgtCpeControlEntry .1.3.6.1.3.83.4.1.1.1 |
docsSubMgtCpeControlMaxCpeIpThe 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.rw INTEGER .1.3.6.1.3.83.4.1.1.1.1 |
docsSubMgtCpeControlActiveIf 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.rw TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.3.83.4.1.1.1.2 |
docsSubMgtCpeControlLearnableIf 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.rw TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.3.83.4.1.1.1.3 |
docsSubMgtCpeControlResetThis 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.rw TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.3.83.4.1.1.1.4 |
docsSubMgtCpeMaxIpDefaultThe default value for docsSubMgtCpeControlMaxCpeIp if not
signaled in the DOCSIS Registration request. Upon initial CMTS
initialization, this defaults to 16.rw INTEGER .1.3.6.1.3.83.4.1.2 |
docsSubMgtCpeActiveDefaultThe default value for docsSubMgtCpeControlActive if not
signaled in the DOCSIS Registration request. Upon initial CMTS
initialization, this defaults to false.rw TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.3.83.4.1.3 |
docsSubMgtCpeLearnableDefaultThe default value for docsSubMgtCpeControlLearnable if not
signaled in the DOCSIS Registration request. Upon initial CMTS
initialization, this defaults to true.rw TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.3.83.4.1.4 |
docsSubMgtCpeIpTableA table of CPE IP addresses known on a per CM basis. SEQUENCE OF DocsSubMgtCpeIpEntry .1.3.6.1.3.83.4.1.5 |
docsSubMgtCpeIpEntryAn entry in the docsSubMgtCpeIpTable. The first index is
the specific modem we're referring to, the second index is the
specific CPE IP entry. DocsSubMgtCpeIpEntry .1.3.6.1.3.83.4.1.5.1 |
docsSubMgtCpeIpIndexThe 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. INTEGER .1.3.6.1.3.83.4.1.5.1.1 |
docsSubMgtCpeIpAddrThe IP address either set from provisioning or learned via
wiretapping. See docsSubMgtCpeIpIndex for the mechanism.ro IpV4orV6Addr -- Rsyntax OCTET STRING .1.3.6.1.3.83.4.1.5.1.2 |
docsSubMgtCpeIpLearnedIf true, this entry was learned from IP packets sent
upstream rather than from the provisioning objects.ro TruthValue -- Rsyntax INTEGER { -- true(1), -- false(2) -- } .1.3.6.1.3.83.4.1.5.1.3 |
docsSubMgtPktFilterTableA 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. SEQUENCE OF DocsSubMgtPktFilterEntry .1.3.6.1.3.83.4.1.6 |
docsSubMgtPktFilterEntryAn entry in the docsSubMgtPktFilterTable. DocsSubMgtPktFilterEntry .1.3.6.1.3.83.4.1.6.1 |
docsSubMgtPktFilterGroupIdentifies 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. INTEGER .1.3.6.1.3.83.4.1.6.1.1 |
docsSubMgtPktFilterIndexAn index which describes the ordering of a set of filter
specifications within the group. Filters are applied in index
order. INTEGER .1.3.6.1.3.83.4.1.6.1.2 |
docsSubMgtPktFilterSrcAddrThe 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.rw IpV4orV6Addr -- Rsyntax OCTET STRING .1.3.6.1.3.83.4.1.6.1.3 |
docsSubMgtPktFilterSrcMaskA 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.rw IpV4orV6Addr -- Rsyntax OCTET STRING .1.3.6.1.3.83.4.1.6.1.4 |
docsSubMgtPktFilterDstAddrThe 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.rw IpV4orV6Addr -- Rsyntax OCTET STRING .1.3.6.1.3.83.4.1.6.1.5 |
docsSubMgtPktFilterDstMaskA 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.rw IpV4orV6Addr -- Rsyntax OCTET STRING .1.3.6.1.3.83.4.1.6.1.6 |
docsSubMgtPktFilterUlpUpper 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.rw INTEGER .1.3.6.1.3.83.4.1.6.1.7 |
docsSubMgtPktFilterTosValueThe TOS value to match in the IP packet.rw OCTET STRING .1.3.6.1.3.83.4.1.6.1.8 |
docsSubMgtPktFilterTosMaskThe 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).rw OCTET STRING .1.3.6.1.3.83.4.1.6.1.9 |
docsSubMgtPktFilterActionThe action to take upon this filter matching. Accept means
to accept the packet for further processing. Drop means to drop
the packet.rw Enumeration .1.3.6.1.3.83.4.1.6.1.10 |
docsSubMgtPktFilterMatchesThis 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.ro Counter .1.3.6.1.3.83.4.1.6.1.11 |
docsSubMgtPktFilterStatusStandard 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.rw RowStatus -- Rsyntax INTEGER { -- active(1), -- notInService(2), -- notReady(3), -- createAndGo(4), -- createAndWait(5), -- destroy(6) -- } .1.3.6.1.3.83.4.1.6.1.12 |
docsSubMgtTcpUdpFilterTableThis 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'. SEQUENCE OF DocsSubMgtTcpUdpFilterEntry .1.3.6.1.3.83.4.1.7 |
docsSubMgtTcpUdpFilterEntryDefines filtering criteria for TCP and UDP headers. DocsSubMgtTcpUdpFilterEntry .1.3.6.1.3.83.4.1.7.1 |
docsSubMgtTcpUdpSrcPortThe source port to match. 65536 matches any value in the
TCP or UDP source port field.rw INTEGER .1.3.6.1.3.83.4.1.7.1.1 |
docsSubMgtTcpUdpDstPortThe destination port to match. 65536 matches any value in
the TCP or UDP destination port field.rw INTEGER .1.3.6.1.3.83.4.1.7.1.2 |
docsSubMgtTcpFlagValuesThe 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.rw OCTET STRING .1.3.6.1.3.83.4.1.7.1.3 |
docsSubMgtTcpFlagMaskThis 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 }rw OCTET STRING .1.3.6.1.3.83.4.1.7.1.4 |
docsSubMgtTcpUdpStatusStandard row object for this table. Any object in the
conceptual row may be modified regardless of whether this row is
active or not.rw RowStatus -- Rsyntax INTEGER { -- active(1), -- notInService(2), -- notReady(3), -- createAndGo(4), -- createAndWait(5), -- destroy(6) -- } .1.3.6.1.3.83.4.1.7.1.5 |
docsSubMgtCmFilterTableBinds 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. SEQUENCE OF DocsSubMgtCmFilterEntry .1.3.6.1.3.83.4.1.8 |
docsSubMgtCmFilterEntryBinds a filter group to each direction of traffic for a
modem. DocsSubMgtCmFilterEntry .1.3.6.1.3.83.4.1.8.1 |
docsSubMgtSubFilterDownstreamThe 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.rw INTEGER .1.3.6.1.3.83.4.1.8.1.1 |
docsSubMgtSubFilterUpstreamThe 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.rw INTEGER .1.3.6.1.3.83.4.1.8.1.2 |
docsSubMgtCmFilterDownstreamThe 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.rw INTEGER .1.3.6.1.3.83.4.1.8.1.3 |
docsSubMgtCmFilterUpstreamThe 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.rw INTEGER .1.3.6.1.3.83.4.1.8.1.4 |
docsSubMgtSubFilterDownDefaultUpon 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.rw INTEGER .1.3.6.1.3.83.4.1.9 |
docsSubMgtSubFilterUpDefaultUpon 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.rw INTEGER .1.3.6.1.3.83.4.1.10 |
docsSubMgtCmFilterDownDefaultUpon 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.rw INTEGER .1.3.6.1.3.83.4.1.11 |
docsSubMgtCmFilterUpDefaultUpon 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.rw INTEGER .1.3.6.1.3.83.4.1.12 |
docsSubMgtNotification OBJECT IDENTIFIER .1.3.6.1.3.83.4.2 |
docsSubMgtConformance OBJECT IDENTIFIER .1.3.6.1.3.83.4.3 |
docsSubMgtCompliances OBJECT IDENTIFIER .1.3.6.1.3.83.4.3.1 |
docsSubMgtBasicCompliance OBJECT IDENTIFIER .1.3.6.1.3.83.4.3.1.1 |
docsSubMgtGroups OBJECT IDENTIFIER .1.3.6.1.3.83.4.3.2 |
docsSubMgtGroup OBJECT IDENTIFIER .1.3.6.1.3.83.4.3.2.1 |