DOCS-SUBMGT-MIB Table View

Table-centric layout grouping table, row, and column objects.

Standard view Table view
Tables
5
Rows
5
Columns
35

docsSubMgtCpeControlTable

table
.1.3.6.1.3.83.4.1.1 · 1 row entry · 4 columns
Open in standard view 
This table extends the docsIfCmtsCmStatusTable and adds 4
objects which reflect the state of subscriber management on a
particular CM.
docsSubMgtCpeControlEntry entry .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.
Indexes
No indexes recorded
Column Syntax OID
docsSubMgtCpeControlMaxCpeIp
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 add…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.1.1.1
docsSubMgtCpeControlActive
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 …
SNMPv2-TCTruthValuer/w
Textual Convention: SNMPv2-TCTruthValue Enumeration
Type Values:
1true
2false
 .1.3.6.1.3.83.4.1.1.1.2
docsSubMgtCpeControlLearnable
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. Th…
SNMPv2-TCTruthValuer/w
Textual Convention: SNMPv2-TCTruthValue Enumeration
Type Values:
1true
2false
 .1.3.6.1.3.83.4.1.1.1.3
docsSubMgtCpeControlReset
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.
SNMPv2-TCTruthValuer/w
Textual Convention: SNMPv2-TCTruthValue Enumeration
Type Values:
1true
2false
 .1.3.6.1.3.83.4.1.1.1.4

docsSubMgtCpeIpTable

table
.1.3.6.1.3.83.4.1.5 · 1 row entry · 4 columns
Open in standard view 
A table of CPE IP addresses known on a per CM basis.
docsSubMgtCpeIpEntry entry .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.
Indexes
DOCS-IF-MIBdocsIfCmtsCmStatusIndex docsSubMgtCpeIpIndex
Column Syntax OID
docsSubMgtCpeIpIndex
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 …
Integer32
Constraints:
range: 1-1024
 .1.3.6.1.3.83.4.1.5.1.1
docsSubMgtCpeIpAddr
The IP address either set from provisioning or learned via
wiretapping. See docsSubMgtCpeIpIndex for the mechanism.
IpV4orV6Addr
Textual Convention: IpV4orV6Addr OctetString
Type Constraints:
range: 0
range: 4
range: 16
 .1.3.6.1.3.83.4.1.5.1.2
docsSubMgtCpeIpLearned
If true, this entry was learned from IP packets sent
upstream rather than from the provisioning objects.
SNMPv2-TCTruthValue
Textual Convention: SNMPv2-TCTruthValue Enumeration
Type Values:
1true
2false
 .1.3.6.1.3.83.4.1.5.1.3
docsSubMgtCpeType
The type of CPE based on the classification below:
'cpe' Regular CPE clients.
'ps' CableHome Portal Server (PS)
'mta' PacketCable Multimedia Terminal Adapter (MTA)
'stb' Digital Setop Box (STB).
Enumeration
Enumerated Values:
1cpe
2ps
3mta
4stb
 .1.3.6.1.3.83.4.1.5.1.4

docsSubMgtPktFilterTable

table
.1.3.6.1.3.83.4.1.6 · 1 row entry · 12 columns
Open in standard view 
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.
docsSubMgtPktFilterEntry entry .1.3.6.1.3.83.4.1.6.1
An entry in the docsSubMgtPktFilterTable.
Indexes
docsSubMgtPktFilterGroup docsSubMgtPktFilterIndex
Column Syntax OID
docsSubMgtPktFilterGroup
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)…
Integer32
Constraints:
range: 1-1024
 .1.3.6.1.3.83.4.1.6.1.1
docsSubMgtPktFilterIndex
An index which describes the ordering of a set of filter
specifications within the group. Filters are applied in index
order.
Integer32
Constraints:
range: 1-1024
 .1.3.6.1.3.83.4.1.6.1.2
docsSubMgtPktFilterSrcAddr
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, FilterSrcMa…
IpV4orV6Addrr/w
Textual Convention: IpV4orV6Addr OctetString
Type Constraints:
range: 0
range: 4
range: 16
 .1.3.6.1.3.83.4.1.6.1.3
docsSubMgtPktFilterSrcMask
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 mas…
IpV4orV6Addrr/w
Textual Convention: IpV4orV6Addr OctetString
Type Constraints:
range: 0
range: 4
range: 16
 .1.3.6.1.3.83.4.1.6.1.4
docsSubMgtPktFilterDstAddr
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, Filter…
IpV4orV6Addrr/w
Textual Convention: IpV4orV6Addr OctetString
Type Constraints:
range: 0
range: 4
range: 16
 .1.3.6.1.3.83.4.1.6.1.5
docsSubMgtPktFilterDstMask
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…
IpV4orV6Addrr/w
Textual Convention: IpV4orV6Addr OctetString
Type Constraints:
range: 0
range: 4
range: 16
 .1.3.6.1.3.83.4.1.6.1.6
docsSubMgtPktFilterUlp
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 docsSubMgtPktTcpUdpFil…
Integer32r/w
Constraints:
range: 0-256
 .1.3.6.1.3.83.4.1.6.1.7
docsSubMgtPktFilterTosValue
The TOS value to match in the IP packet.
OctetStringr/w
Constraints:
range: 1-1
 .1.3.6.1.3.83.4.1.6.1.8
docsSubMgtPktFilterTosMask
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 (FilterTo…
OctetStringr/w
Constraints:
range: 1-1
 .1.3.6.1.3.83.4.1.6.1.9
docsSubMgtPktFilterAction
The action to take upon this filter matching. Accept means
to accept the packet for further processing. Drop means to drop
the packet.
Enumerationr/w
Enumerated Values:
1accept
2drop
 .1.3.6.1.3.83.4.1.6.1.10
docsSubMgtPktFilterMatches
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 m…
SNMPv2-SMICounter32
Textual Convention: SNMPv2-SMICounter32 Unsigned32
Type Constraints:
range: 0..4294967295
 .1.3.6.1.3.83.4.1.6.1.11
docsSubMgtPktFilterStatus
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.
SNMPv2-TCRowStatusr/w
Textual Convention: SNMPv2-TCRowStatus Enumeration
Type Values:
1active
2notInService
3notReady
4createAndGo
5createAndWait
6destroy
 .1.3.6.1.3.83.4.1.6.1.12

docsSubMgtTcpUdpFilterTable

table
.1.3.6.1.3.83.4.1.7 · 1 row entry · 5 columns
Open in standard view 
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'.
docsSubMgtTcpUdpFilterEntry entry .1.3.6.1.3.83.4.1.7.1
Defines filtering criteria for TCP and UDP headers.
Indexes
docsSubMgtPktFilterGroup docsSubMgtPktFilterIndex
Column Syntax OID
docsSubMgtTcpUdpSrcPort
The source port to match. 65536 matches any value in the
TCP or UDP source port field.
Integer32r/w
Constraints:
range: 0-65536
 .1.3.6.1.3.83.4.1.7.1.1
docsSubMgtTcpUdpDstPort
The destination port to match. 65536 matches any value in
the TCP or UDP destination port field.
Integer32r/w
Constraints:
range: 0-65536
 .1.3.6.1.3.83.4.1.7.1.2
docsSubMgtTcpFlagValues
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 SNMP…
Bitsr/w
Enumerated Values:
0urgent
1ack
2push
3reset
4syn
5fin
 .1.3.6.1.3.83.4.1.7.1.3
docsSubMgtTcpFlagMask
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 docsSubMgtTcpF…
Bitsr/w
Enumerated Values:
0urgent
1ack
2push
3reset
4syn
5fin
 .1.3.6.1.3.83.4.1.7.1.4
docsSubMgtTcpUdpStatus
Standard row object for this table. Any object in the
conceptual row may be modified regardless of whether this row is
active or not.
SNMPv2-TCRowStatusr/w
Textual Convention: SNMPv2-TCRowStatus Enumeration
Type Values:
1active
2notInService
3notReady
4createAndGo
5createAndWait
6destroy
 .1.3.6.1.3.83.4.1.7.1.5

docsSubMgtCmFilterTable

table
.1.3.6.1.3.83.4.1.8 · 1 row entry · 10 columns
Open in standard view 
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.
docsSubMgtCmFilterEntry entry .1.3.6.1.3.83.4.1.8.1
Binds a filter group to each direction of traffic for a
modem.
Indexes
No indexes recorded
Column Syntax OID
docsSubMgtSubFilterDownstream
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 obje…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.1
docsSubMgtSubFilterUpstream
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 ob…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.2
docsSubMgtCmFilterDownstream
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 f…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.3
docsSubMgtCmFilterUpstream
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…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.4
docsSubMgtPsFilterDownstream
The filter group applied to traffic destined for CableHome
portal servers attached to the referenced CM. This is set upon
row creation to either the default (docsSubMgtPsFilterDownDefault),
or to the value in the provis…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.5
docsSubMgtPsFilterUpstream
The filter group applied to traffic originating from
CableHome portal servers attached to the referenced CM. This is set
upon row creation to either the default (docsSubMgtPsFilterUpDefault),
or to the value in the prov…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.6
docsSubMgtMtaFilterDownstream
The filter group applied to traffic destined for MTAs
attached to the referenced CM. This is set upon row
creation to either the default (docsSubMgtMtaFilterDownDefault),
or to the value in the provisioning object sent …
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.7
docsSubMgtMtaFilterUpstream
The filter group applied to traffic originating from MTAs
attached to the referenced CM. This is set upon row creation to
either the default (docsSubMgtMtaFilterUpDefault), or to
the value in the provisioning object sen…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.8
docsSubMgtStbFilterDownstream
The filter group applied to traffic destined for STBs
attached to the referenced CM. This is set upon row
creation to either the default (docsSubMgtStbFilterDownDefault),
or to the value in the provisioning object sent …
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.9
docsSubMgtStbFilterUpstream
The filter group applied to traffic originating from STBs
attached to the referenced CM. This is set upon row creation to
either the default (docsSubMgtStbFilterUpDefault), or to
the value in the provisioning object sen…
Integer32r/w
Constraints:
range: 0-1024
 .1.3.6.1.3.83.4.1.8.1.10