DOCS-CABLE-DEVICE-MIB Table View

This table controls access to SNMP objects by network
management stations.  If the table is empty, access to
SNMP objects is unrestricted.  The objects in this table
MUST NOT persist across reboots.  The objects in this
table are only accessible from cable devices that are
not capable of operating in SNMP Coexistence mode
(RFC 3584) or in SNMPv3 mode (RFC 3410).
See the conformance section for
details.  Note that some devices are required by other
specifications (e.g., the DOCSIS OSSIv1.1 specification)
to support the legacy SNMPv1/v2c docsDevNmAccess mode
for backward compatibility.
          
This table is deprecated.  Instead, use the SNMP
coexistence MIBs from RFC 3584, the TARGET and
NOTIFICATION MIBs from RFC 3413, and
the View-Based Access Control Model (VACM) MIBs for
all SNMP protocol versions from RFC 3415.

docsDevNmAccessEntry row .1.3.6.1.2.1.69.1.2.1

An entry describing access to SNMP objects by a
particular network management station. An entry in
this table is not readable unless the management station
has read-write permission (either implicit if the table
is emp…

Indexes

docsDevNmAccessIndex

Column	Syntax	OID
docsDevNmAccessIndexdeprecated Index used to order the application of access entries.	Integer32 Constraints: range: 1-2147483647	.1.3.6.1.2.1.69.1.2.1.1
docsDevNmAccessIpdeprecated The IP address (or subnet) of the network management station. The address 0.0.0.0 is defined to mean any Network Management Station (NMS). If traps are enabled for this entry, then the value must be the address of a s…	SNMPv2-SMIIpAddressr/w Type Constraints: range: 4	.1.3.6.1.2.1.69.1.2.1.2
docsDevNmAccessIpMaskdeprecated The IP subnet mask of the network management stations. If traps are enabled for this entry, then the value must be 0.0.0.0. Implementations MAY recognize 255.255.255.255 as equivalent to 0.0.0.0.	SNMPv2-SMIIpAddressr/w Type Constraints: range: 4	.1.3.6.1.2.1.69.1.2.1.3
docsDevNmAccessCommunitydeprecated The community string to be matched for access by this entry. If set to a zero-length string, then any community string will match. When read, this object SHOULD return a zero-length string.	OctetStringr/w	.1.3.6.1.2.1.69.1.2.1.4
docsDevNmAccessControldeprecated Specifies the type of access allowed to this NMS. Setting this object to none(1) causes the table entry to be destroyed. Read(2) allows access by 'get' and 'get-next' PDUs. ReadWrite(3) allows access by 'set' as well.…	Enumerationr/w Enumerated Values: 1 none 2 read 3 readWrite 4 roWithTraps 5 rwWithTraps 6 trapsOnly	.1.3.6.1.2.1.69.1.2.1.5
docsDevNmAccessInterfacesdeprecated Specifies the set of interfaces from which requests from this NMS will be accepted. Each octet within the value of this object specifies a set of eight interfaces, the first octet specifying ports 1 thro…	OctetStringr/w Constraints: range: 1-32	.1.3.6.1.2.1.69.1.2.1.6
docsDevNmAccessStatusdeprecated Controls and reflects the status of rows in this table. Rows in this table may be created by either the create-and-go or create-and-wait paradigm. There is no restriction on changing values in a row of this table whil…	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.2.1.69.1.2.1.7
docsDevNmAccessTrapVersiondeprecated Specifies the TRAP version that is sent to this NMS. Setting this object to disableSNMPv2trap (1) causes the trap in SNMPv1 format to be sent to a particular NMS. Setting this object to enableSNMPv2trap (2) causes the t…	Enumerationr/w Enumerated Values: 1 disableSNMPv2trap 2 enableSNMPv2trap	.1.3.6.1.2.1.69.1.2.1.8

An ordered list of filters or classifiers to apply to
IP traffic.  Filter application is ordered by the filter
index, rather than by a best match algorithm (note that
this implies that the filter table may have gaps in the
index values).  Packets that match no filters will have
policy 0 in the docsDevFilterPolicyTable applied to
them, if it exists.  Otherwise, Packets that match no
filters are discarded or forwarded according to the
setting of docsDevFilterIpDefault.
          
Any IP packet can theoretically match multiple rows of
this table.  When considering a packet, the table is
scanned in row index order (e.g., filter 10 is checked
before filter 20).  If the packet matches that filter
(which means that it matches ALL criteria for that row),
actions appropriate to docsDevFilterIpControl and
docsDevFilterPolicyId are taken.  If the packet was
discarded processing is complete.  If
docsDevFilterIpContinue is set to true, the filter
comparison continues with the next row in the table,
looking for additional matches.
          
If the packet matches no filter in the table, the packet
is accepted or dropped for further processing
according to the setting of docsDevFilterIpDefault.
If the packet is accepted, the actions specified by
policy group 0 (e.g., the rows in
docsDevFilterPolicyTable that have a value of 0 for
docsDevFilterPolicyId) are taken, if that policy
          
group exists.
          
Logically, this table is consulted twice during the
processing of any IP packet: once upon its acceptance
from the L2 entity, and once upon its transmission to
the L2 entity.  In actuality, for cable modems, IP
filtering is generally the only IP processing done for
transit traffic.  This means that inbound and outbound
filtering can generally be done at the same time with
one pass through the filter table.
          
The objects in this table are only accessible from cable
devices that are not operating in DiffServ MIB mode
(RFC 3289).  See the conformance section for details.
          
Note that some devices are required by other
specifications (e.g., the DOCSIS OSSIv1.1 specification)
to support the legacy SNMPv1/v2c docsDevFilter mode
for backward compatibility.
          
Table entries MUST NOT persist across reboots for any
device.
          
This table is deprecated.  Instead, use the DiffServ MIB
from RFC 3289.

docsDevFilterIpEntry row .1.3.6.1.2.1.69.1.6.4.1

Describes a filter to apply to IP traffic received on a
specified interface. All identity objects in this table
(e.g., source and destination address/mask, protocol,
source/dest port, TOS/mask, interface and direction)…

Indexes

docsDevFilterIpIndex

Column	Syntax	OID
docsDevFilterIpIndexdeprecated Index used to order the application of filters. The filter with the lowest index is always applied first.	Integer32 Constraints: range: 1-2147483647	.1.3.6.1.2.1.69.1.6.4.1.1
docsDevFilterIpStatusdeprecated Controls and reflects the status of rows in this table. Specifying only this object (with the appropriate index) on a CM is sufficient to create a filter row that matches all inbound packets on the ethernet interface a…	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.2.1.69.1.6.4.1.2
docsDevFilterIpControldeprecated If set to discard(1), all packets matching this filter will be discarded, and scanning of the remainder of the filter list will be aborted. If set to accept(2), all packets matching this filter will be accepted for fur…	Enumerationr/w Enumerated Values: 1 discard 2 accept 3 policy	.1.3.6.1.2.1.69.1.6.4.1.3
docsDevFilterIpIfIndexdeprecated The entry interface to which this filter applies. The value corresponds to ifIndex for either a CATV MAC or another interface. If the value is zero, the filter applies to all interfaces. Default value in CMs is the i…	IF-MIBInterfaceIndexOrZeror/w Type Constraints: range: 0..2147483647 Description: This textual convention is an extension of the InterfaceIndex convention. The latter defines a greater than zero value used to identify an interface or interface sub-layer in the managed system. This extension permits…	.1.3.6.1.2.1.69.1.6.4.1.4
docsDevFilterIpDirectiondeprecated Determines whether the filter is applied to inbound(1) traffic, outbound(2) traffic, or traffic in both(3) directions.	Enumerationr/w Enumerated Values: 1 inbound 2 outbound 3 both	.1.3.6.1.2.1.69.1.6.4.1.5
docsDevFilterIpBroadcastdeprecated If set to true(1), the filter only applies to multicast and broadcast traffic. If set to false(2), the filter applies to all traffic.	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.2.1.69.1.6.4.1.6
docsDevFilterIpSaddrdeprecated The source IP address, or portion thereof, that is to be matched for this filter. The source address is first masked (ANDed) against docsDevFilterIpSmask before being compared to this value. A value of 0 for this obje…	SNMPv2-SMIIpAddressr/w Type Constraints: range: 4	.1.3.6.1.2.1.69.1.6.4.1.7
docsDevFilterIpSmaskdeprecated A bit mask that is to be applied to the source address prior to matching. This mask is not necessarily the same as a subnet mask, but 1s bits must be leftmost and contiguous.	SNMPv2-SMIIpAddressr/w Type Constraints: range: 4	.1.3.6.1.2.1.69.1.6.4.1.8
docsDevFilterIpDaddrdeprecated The destination IP address, or portion thereof, that is to be matched for this filter. The destination address is first masked (ANDed) against docsDevFilterIpDmask before being compared to this value. A value of 00000…	SNMPv2-SMIIpAddressr/w Type Constraints: range: 4	.1.3.6.1.2.1.69.1.6.4.1.9
docsDevFilterIpDmaskdeprecated A bit mask that is to be applied to the destination address prior to matching. This mask is not necessarily the same as a subnet mask, but 1s bits MUST be leftmost and contiguous.	SNMPv2-SMIIpAddressr/w Type Constraints: range: 4	.1.3.6.1.2.1.69.1.6.4.1.10
docsDevFilterIpProtocoldeprecated The IP protocol value that is to be matched. For example, icmp is 1, tcp is 6, and udp is 17. A value of 256 matches ANY protocol.	Integer32r/w Constraints: range: 0-256	.1.3.6.1.2.1.69.1.6.4.1.11
docsDevFilterIpSourcePortLowdeprecated This is the inclusive lower bound of the transport-layer source port range that is to be matched. If the IP protocol of the packet is neither UDP nor TCP, this object is ignored during matching.	Integer32r/w Constraints: range: 0-65535	.1.3.6.1.2.1.69.1.6.4.1.12
docsDevFilterIpSourcePortHighdeprecated This is the inclusive upper bound of the transport-layer source port range that is to be matched. If the IP protocol of the packet is neither UDP nor TCP, this object is ignored during matching.	Integer32r/w Constraints: range: 0-65535	.1.3.6.1.2.1.69.1.6.4.1.13
docsDevFilterIpDestPortLowdeprecated This is the inclusive lower bound of the transport-layer destination port range that is to be matched. If the IP protocol of the packet is neither UDP nor TCP, this object is ignored during matching.	Integer32r/w Constraints: range: 0-65535	.1.3.6.1.2.1.69.1.6.4.1.14
docsDevFilterIpDestPortHighdeprecated This is the inclusive upper bound of the transport-layer destination port range that is to be matched. If the IP protocol of the packet is neither UDP nor TCP, this object is ignored during matching.	Integer32r/w Constraints: range: 0-65535	.1.3.6.1.2.1.69.1.6.4.1.15
docsDevFilterIpMatchesdeprecated Counts the number of times this filter was matched. This object is initialized to 0 at boot, or at row creation, and is reset only upon reboot.	matchesRMON2-MIBZeroBasedCounter32	.1.3.6.1.2.1.69.1.6.4.1.16
docsDevFilterIpTosdeprecated This is the value to be matched to the packet's TOS (Type of Service) value (after the TOS value is ANDed with docsDevFilterIpTosMask). A value for this object of 0 and a mask of 0 matches all TOS values.	OctetStringr/w Constraints: range: 1-1	.1.3.6.1.2.1.69.1.6.4.1.17
docsDevFilterIpTosMaskdeprecated The mask to be applied to the packet's TOS value before matching.	OctetStringr/w Constraints: range: 1-1	.1.3.6.1.2.1.69.1.6.4.1.18
docsDevFilterIpContinuedeprecated If this value is set to true and docsDevFilterIpControl is anything but discard (1), continue scanning and applying policies. See Section 3.3.3 for more details.	SNMPv2-TCTruthValuer/w Type Values: 1 true 2 false Description: Represents a boolean value.	.1.3.6.1.2.1.69.1.6.4.1.19
docsDevFilterIpPolicyIddeprecated This object points to an entry in docsDevFilterPolicyTable. If docsDevFilterIpControl is set to policy (3), execute all matching policies in docsDevFilterPolicyTable. If no matching policy exists, treat…	Integer32r/w Constraints: range: 0-2147483647	.1.3.6.1.2.1.69.1.6.4.1.20

A Table that maps between a policy group ID and a set
of pointers to policies to be applied.  All rows with
the same docsDevFilterPolicyId are part of the same
group of policy pointers and are applied in the order
in this table.  docsDevFilterPolicyTable exists to
allow multiple policy actions (referenced by policy
pointers) to be applied to any given classified packet.
The policy actions are applied in index order.
For example:
          
Index   ID    Type    Action
 1      1      TOS     1
 9      5      TOS     1
 12     1      IPSEC   3
          
This says that a packet that matches a filter with
policy id 1 first has TOS policy 1 applied (which might
set the TOS bits to enable a higher priority) and next
has the IPSEC policy 3 applied (which may result in the
packets being dumped into a secure VPN to a remote
encryptor).
          
Policy ID 0 is reserved for default actions and is
applied only to packets that match no filters in
docsDevFilterIpTable.
          
Table entries MUST NOT persist across reboots for any
device.
          
This table is deprecated.  Instead, use the DiffServ MIB
          
from RFC 3289.

docsDevFilterPolicyEntry row .1.3.6.1.2.1.69.1.6.5.1

An entry in the docsDevFilterPolicyTable. Entries are
created by Network Management. To create an entry,
docsDevFilterPolicyId MUST be specified.

Indexes

docsDevFilterPolicyIndex

Column	Syntax	OID
docsDevFilterPolicyIndexdeprecated Index value for the table.	Integer32 Constraints: range: 1-2147483647	.1.3.6.1.2.1.69.1.6.5.1.1
docsDevFilterPolicyIddeprecated Policy ID for this entry. If a policy ID can apply to multiple rows of this table, all relevant policies are executed. Policy 0 (if populated) is applied to all packets that do not match any of the filters. N.B. If d…	Integer32r/w Constraints: range: 0-2147483647	.1.3.6.1.2.1.69.1.6.5.1.2
docsDevFilterPolicyStatusdeprecated Object used to create an entry in this table. There is no restriction in changing any object in a row while this object is set to active. The following object MUST have a valid value before this object can be set to ac…	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.2.1.69.1.6.5.1.5
docsDevFilterPolicyPtrdeprecated This object points to a row in an applicable filter policy table. Currently, the only standard policy table is docsDevFilterTosTable. Per the textual convention, this object points to the first accessibl…	SNMPv2-TCRowPointerr/w Description: Represents a pointer to a conceptual row. The value is the name of the instance of the first accessible columnar object in the conceptual row. For example, ifIndex.3 would point to the 3rd row in the ifTable…	.1.3.6.1.2.1.69.1.6.5.1.6

Table used to describe Type of Service (TOS) bits
          
processing.
          
This table is an adjunct to the docsDevFilterIpTable
and the docsDevFilterPolicy table.  Entries in the
latter table can point to specific rows in this (and
other) tables and cause specific actions to be taken.
This table permits the manipulation of the value of the
Type of Service bits in the IP header of the matched
packet as follows:
          
Set the tosBits of the packet to
   (tosBits & docsDevFilterTosAndMask) |
   docsDevFilterTosOrMask
          
This construct allows you to do a clear and set of all
the TOS bits in a flexible manner.
          
Table entries MUST NOT persist across reboots for any
device.
          
This table is deprecated.  Instead, use the DiffServ MIB
from RFC 3289.

docsDevFilterTosEntry row .1.3.6.1.2.1.69.1.6.6.1

A TOS policy entry.

Indexes

docsDevFilterTosIndex

Column	Syntax	OID
docsDevFilterTosIndexdeprecated The unique index for this row. There are no ordering requirements for this table, and any valid index may be specified.	Integer32 Constraints: range: 1-2147483647	.1.3.6.1.2.1.69.1.6.6.1.1
docsDevFilterTosStatusdeprecated The object used to create and delete entries in this table. A row created by specifying just this object results in a row that specifies no change to the TOS bits. A row may be created using either the create-and-go o…	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.2.1.69.1.6.6.1.2
docsDevFilterTosAndMaskdeprecated This value is bitwise ANDed with the matched packet's TOS bits.	OctetStringr/w Constraints: range: 1-1	.1.3.6.1.2.1.69.1.6.6.1.3
docsDevFilterTosOrMaskdeprecated This value is bitwise ORed with the result from the AND procedure (tosBits & docsDevFilterTosAndMask). The result then replaces the packet's TOS bits.	OctetStringr/w Constraints: range: 1-1	.1.3.6.1.2.1.69.1.6.6.1.4

This table lists the IPv4 addresses seen (or permitted)
as source addresses in packets originating from the
customer interface on this device.  In addition, this
table can be provisioned with the specific addresses
permitted for the CPEs via the normal row creation
mechanisms.  Table entries MUST NOT persist across
reboots for any device.
          
N.B.  Management action can add entries in this table
and in docsDevCpeIpTable past the value of
          
docsDevCpeIpMax.  docsDevCpeIpMax ONLY restricts the
ability of the CM to add learned addresses
automatically.
          
This table is deprecated and is replaced by
docsDevCpeInetTable.

docsDevCpeEntry row .1.3.6.1.2.1.69.1.7.3.1

An entry in the docsDevFilterCpeTable. There is one
entry for each IPv4 CPE seen or provisioned. If
docsDevCpeIpMax is set to -1, this table is ignored;
otherwise, upon receipt of an IP packet from the
customer interf…

Indexes

docsDevCpeIp

Column	Syntax	OID
docsDevCpeIpdeprecated The IPv4 address to which this entry applies. N.B. Attempts to set all zeros or all ones address values MUST be rejected.	SNMPv2-SMIIpAddress Type Constraints: range: 4	.1.3.6.1.2.1.69.1.7.3.1.1
docsDevCpeSourcedeprecated This object describes how this entry was created. If the value is manual(2), this row was created by a network management action (either configuration or SNMP set). If set to learned(3), then it was found via looking …	Enumeration Enumerated Values: 1 other 2 manual 3 learned	.1.3.6.1.2.1.69.1.7.3.1.2
docsDevCpeStatusdeprecated Standard object to manipulate rows. To create a row in this table, one only needs to specify this object. Management stations SHOULD use the create-and-go mechanism for creating rows in this table.	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.2.1.69.1.7.3.1.3