All MIBs › DOCS-CABLE-DEVICE-MIB
Organization: IETF IP over Cable Data Network Working Group
Last Updated: 2006-12-20
Category: DOCSIS and Cable, Network Interfaces
Description: Manages DOCSIS-compliant cable modems and CMTS devices, covering device access control, software downloads, IP/MAC filtering, and CPE management.
IPNetwork Monitor uses several OIDs from this MIB in network discovery and polling the applicable devices. Start monitoring DOCS-CABLE-DEVICE-MIB with a free 30-day trial of IPNetwork Monitor.
What Is DOCS-CABLE-DEVICE-MIB?
DOCS-CABLE-DEVICE-MIB is the IETF standards-track MIB (RFC 4639) for DOCSIS-compliant cable modems (CMs) and cable-modem termination systems (CMTSs), covering device-level configuration, access control, and operational management common to both roles. It exposes general categories of data including device identity and role (CM vs. CMTS), date/time, reset control, software download management, network-management access-control lists, and CPE (customer-premises equipment) count limits. It is explicitly useful for monitoring both hardware and software status: docsDevSerialNumber and docsDevRole identify the physical device and its function, docsDevSoftware tracks the software/firmware image and download state, docsDevResetNow allows remote reboot, and docsDevMaxCpe/docsDevNmAccessTable let an operator watch access-control and CPE-limit enforcement for security and capacity purposes. MSO provisioning and monitoring systems that walk the DOCS-CABLE-DEVICE-MIB OID branch can enumerate every managed cable modem or CMTS and its role, software state, and access-control entries in a single sweep. It builds on the broader DOCSIS MIB suite (DOCS-IF-MIB for RF-layer statistics, IF-MIB for interfaces) and represents the device-management layer of that architecture. It is deployed by cable operators (MSOs) across their DOCSIS access networks to manage both subscriber cable modems and headend CMTS equipment.
IPNetwork Monitor allows you to monitor SNMP objects defined in DOCS-CABLE-DEVICE-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-compliant cable modems
- cable-modem termination systems (CMTS)
Monitoring Examples
An operator would poll docsDevSoftware to verify the CM or CMTS is running the expected firmware version and to check the state of a software download/upgrade, and docsDevSerialNumber/docsDevRole to confirm device identity and function during provisioning. Checking docsDevNmAccessTable/docsDevNmAccessEntry entries (docsDevNmAccessIp, docsDevNmAccessIpMask) confirms which management stations are authorized to access the device, catching misconfigured or unauthorized access-control entries. docsDevMaxCpe combined with the device's actual CPE count reveals whether a modem is at or over its configured customer-device limit, and docsDevResetNow provides a remote-reboot capability an admin can use to recover a hung device.
What Can Be Monitored
- device role (CM/CMTS) and serial number
- software/firmware image and download status
- network-management access-control entries
- maximum CPE count enforcement
- remote device reset capability
- device date/time
This MIB depends on
Related MIBs
Imported Objects
From DIFFSERV-MIB
| diffServActionStorage | OBJECT-TYPE |
| diffServAlgDropStatus | OBJECT-TYPE |
| diffServAlgDropStorage | OBJECT-TYPE |
| diffServAlgDropType | OBJECT-TYPE |
| diffServClfrElementStatus | OBJECT-TYPE |
| diffServClfrElementStorage | OBJECT-TYPE |
| diffServClfrStatus | OBJECT-TYPE |
| diffServClfrStorage | OBJECT-TYPE |
| diffServCountActStorage | OBJECT-TYPE |
| diffServDataPathStatus | OBJECT-TYPE |
| diffServDataPathStorage | OBJECT-TYPE |
| diffServMIBActionGroup | OBJECT-GROUP |
| diffServMIBAlgDropGroup | OBJECT-GROUP |
| diffServMIBClfrElementGroup | OBJECT-GROUP |
| diffServMIBClfrGroup | OBJECT-GROUP |
| diffServMIBCounterGroup | OBJECT-GROUP |
| diffServMIBDataPathGroup | OBJECT-GROUP |
| diffServMIBDscpMarkActGroup | OBJECT-GROUP |
| diffServMIBMultiFieldClfrGroup | OBJECT-GROUP |
| diffServMultiFieldClfrAddrType | OBJECT-TYPE |
| diffServMultiFieldClfrDstAddr | OBJECT-TYPE |
| diffServMultiFieldClfrSrcAddr | OBJECT-TYPE |
| diffServMultiFieldClfrStorage | OBJECT-TYPE |
From IF-MIB
| InterfaceIndexOrZero |
From INET-ADDRESS-MIB
| InetAddress | |
| InetAddressType |
From RMON2-MIB
| ZeroBasedCounter32 |
From SNMP-FRAMEWORK-MIB
| SnmpAdminString |
From SNMPv2-CONF
| MODULE-COMPLIANCE | |
| OBJECT-GROUP |
From SNMPv2-SMI
| Counter32 | |
| Integer32 | |
| IpAddress | |
| MODULE-IDENTITY | |
| OBJECT-TYPE | |
| Unsigned32 | |
| mib-2 | |
| zeroDotZero |
From SNMPv2-TC
| DateAndTime | |
| RowPointer | |
| RowStatus | |
| StorageType | |
| TruthValue |
OIDs
| OID symbolic | OID numeric | Type | Access | Description |
|---|---|---|---|---|
| docsDev | 1.3.6.1.2.1.69 | This is the MIB Module for DOCSIS-compliant cable modems and cable-modem termination systems. Copyright (C) The IETF Trust (2006). This version of this MIB module was published in RFC 4639; for full legal notices see the RFC itself. | ||
| docsDevBase | 1.3.6.1.2.1.69.1.1 | |||
| docsDevBaseGroup | 1.3.6.1.2.1.69.3.1.1 | A collection of objects providing device status and control. | ||
| docsDevBaseIgmpGroup | 1.3.6.1.2.1.69.3.3.1 | An object providing cable device IGMP status and control. | ||
| docsDevBaseMaxCpeGroup | 1.3.6.1.2.1.69.3.3.2 | An object providing management of the maximum number of CPEs permitted access through a cable modem. | ||
| docsDevBasicCompliance | 1.3.6.1.2.1.69.3.2.1 | The RFC 2669 compliance statement for MCNS/DOCSIS Cable Modems and Cable Modem Termination Systems. | ||
| docsDevCmCompliance | 1.3.6.1.2.1.69.3.4.1 | The compliance statement for DOCSIS Cable Modems. This compliance statement applies to implementations of DOCSIS versions that are not IPv6 capable. | ||
| docsDevCmtsCompliance | 1.3.6.1.2.1.69.3.4.2 | The compliance statement for DOCSIS Cable Modem Termination Systems. This compliance statement applies to implementations of DOCSIS versions that are not IPv6 capable. | ||
| docsDevCompliances | 1.3.6.1.2.1.69.3.2 | |||
| docsDevCompliancesV2 | 1.3.6.1.2.1.69.3.4 | |||
| docsDevConformance | 1.3.6.1.2.1.69.3 | |||
| docsDevCpe | 1.3.6.1.2.1.69.1.7 | |||
| INT docsDevCpeEnroll | 1.3.6.1.2.1.69.1.7.1 | INTEGER | read-write | This object controls the population of docsDevFilterCpeTable. If set to none, the filters must be set manually by a network management action (either configuration or SNMP set). If set to any, the CM wiretaps the packets originating from the ethernet and enrolls up to docsDevCpeIpMax addresses as based on the source IPv4 or v6 addresses of those packets. |
| docsDevCpeEntry | 1.3.6.1.2.1.69.1.7.3.1 | not-accessible | 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 interface of the CM, the source IP address is checked against this table. If the address is in the table, packet processing continues. If the address is not in the table but docsDevCpeEnroll is set to any and the sum of the table sizes of docsDevCpeTable and docsDevCpeInetTable is less than docsDevCpeIpMax, the address is added to the table, and packet processing continues. Otherwise, the packet is dropped. The filtering actions specified by this table occur after any LLC filtering (docsDevFilterLLCTable), but prior to any IP filtering (docsDevFilterIpTable, docsDevNmAccessTable). | |
| docsDevCpeGroup | 1.3.6.1.2.1.69.3.1.7 | A collection of objects used to control the number and specific values of IPv4 addresses allowed for associated Customer Premises Equipment (CPE). This group has been deprecated and replaced by docsDevInetCpeGroup. The object docsDevCpeSource has been replaced by docsDevCpeInetSource, and docsDevCpeStatus has been replaced by docsDevCpeInetRowStatus. | ||
| IP docsDevCpeInetAddr | 1.3.6.1.2.1.69.1.7.4.1.2 | InetAddress | not-accessible | The Internet address to which this entry applies. Implementors need to be aware that if the size of docsDevCpeInetAddr exceeds 114 octets OIDs of instances of columns in this row will have more than 128 sub-identifiers and cannot be accessed using SNMPv1, SNMPv2c, or SNMPv3. Only unicast address are allowed for this object. |
| docsDevCpeInetEntry | 1.3.6.1.2.1.69.1.7.4.1 | not-accessible | An entry in the docsDevFilterCpeInetTable. There is one entry for each IP CPE seen or provisioned. If docsDevCpeIpMax is set to -1, this table is ignored; otherwise, upon receipt of an IP packet from the customer interface of the CM, the source IP address is checked against this table. If the address is in the table, packet processing continues. If the address is not in the table but docsDevCpeEnroll is set to any and the sum of the table sizes for docsDevCpeTable and docsDevCpeInetTable is less than docsDevCpeIpMax, the address is added to the table, and packet processing continues. Otherwise, the packet is dropped. The filtering actions specified by this table occur after any LLC filtering (docsDevFilterLLCTable), but prior to any IP filtering (docsDevFilterIpTable, docsDevNmAccessTable). When an agent (cable modem) restarts, then all dynamically created rows are lost. | |
| ROW docsDevCpeInetRowStatus | 1.3.6.1.2.1.69.1.7.4.1.4 | RowStatus | read-create | 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. |
| INT docsDevCpeInetSource | 1.3.6.1.2.1.69.1.7.4.1.3 | INTEGER | read-only | 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 at the source IP address of a received packet. |
| docsDevCpeInetTable | 1.3.6.1.2.1.69.1.7.4 | not-accessible | This table lists the IP 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. 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. Table entries MUST NOT persist across reboots for any device. This table exactly mirrors docsDevCpeTable and applies to IPv4 and IPv6 addresses. | |
| IPt docsDevCpeInetType | 1.3.6.1.2.1.69.1.7.4.1.1 | InetAddressType | not-accessible | The type of internet address of docsDevCpeInetAddr. |
| IP docsDevCpeIp | 1.3.6.1.2.1.69.1.7.3.1.1 | IpAddress | not-accessible | The IPv4 address to which this entry applies. N.B. Attempts to set all zeros or all ones address values MUST be rejected. |
| I32 docsDevCpeIpMax | 1.3.6.1.2.1.69.1.7.2 | Integer32 | read-write | This object controls the maximum number of CPEs allowed to be learned behind this device. If set to zero, any number of CPEs may connect up to the maximum permitted for the device. If set to -1, no filtering is done on CPE source addresses, and no entries are made in the docsDevFilterCpeTable via learning. If an attempt is made to set this to a number greater than that permitted for the device, it is set to that maximum. |
| INT docsDevCpeSource | 1.3.6.1.2.1.69.1.7.3.1.2 | INTEGER | read-only | 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 at the source IPv4 address of a received packet. The value other(1) is used for any entries that do not meet manual(2) or learned(3) criteria. |
| ROW docsDevCpeStatus | 1.3.6.1.2.1.69.1.7.3.1.3 | RowStatus | read-create | 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. |
| docsDevCpeTable | 1.3.6.1.2.1.69.1.7.3 | not-accessible | 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. | |
| DAT docsDevDateTime | 1.3.6.1.2.1.69.1.1.2 | DateAndTime | read-write | The current date and time, with time zone information (if known). If the real data and time cannot be determined, this shall represent elapsed time from boot relative to the standard epoch '1970-1-1,0:0:0.0'. In other words, if this agent has been up for 3 minutes and not been able to determine what the actual date and time are, this object will return the value '1970-1-1,0:03:0.0'. |
| INT docsDevEvControl | 1.3.6.1.2.1.69.1.5.1 | INTEGER | read-write | Setting this object to resetLog(1) empties the event log. All data is deleted. Setting it to useDefaultReporting(2) returns all event priorities to their factory-default reporting. Reading this object always returns useDefaultReporting(2). |
| docsDevEvControlEntry | 1.3.6.1.2.1.69.1.5.7.1 | not-accessible | Allows configuration of the reporting mechanisms for a particular event priority. | |
| docsDevEvControlTable | 1.3.6.1.2.1.69.1.5.7 | not-accessible | This table allows control of the reporting of event classes. For each event priority, a combination of logging and reporting mechanisms may be chosen. The mapping of event types to priorities is vendor dependent. Vendors may also choose to allow the user to control that mapping through proprietary means. Table entries MUST persist across reboots for CMTS devices and MUST NOT persist across reboots for CM devices. | |
| C32 docsDevEvCounts | 1.3.6.1.2.1.69.1.5.8.1.4 | Counter32 | read-only | The number of consecutive event instances reported by this entry. This starts at 1 with the creation of this row and increments by 1 for each subsequent duplicate event. |
| docsDevEvent | 1.3.6.1.2.1.69.1.5 | |||
| docsDevEventEntry | 1.3.6.1.2.1.69.1.5.8.1 | not-accessible | Describes a network or device event that may be of interest in fault isolation and troubleshooting. Multiple sequential identical events are represented by incrementing docsDevEvCounts and setting docsDevEvLastTime to the current time rather than creating multiple rows. Entries are created with the first occurrence of an event. docsDevEvControl can be used to clear the table. Individual events cannot be deleted. | |
| docsDevEventGroup | 1.3.6.1.2.1.69.3.1.5 | A collection of objects used to control and monitor events. This group has been deprecated and replaced by docsDevEventGroupV2. The object docsDevEvSyslog has been replaced by docsDevEvSyslogAddressType and docsDevEvSyslogAddress, and docsDevEvThrottleInhibited has been replaced by docsDevEvThrottleThresholdExceeded. | ||
| docsDevEventGroupV2 | 1.3.6.1.2.1.69.3.3.6 | A collection of objects used to control and monitor events. This group replaces docsDevEventGroup. The event reporting mechanism, and more specifically docsDevEvReporting, can be used to take advantage of the event reporting features of RFC3413 and RFC3014. | ||
| docsDevEventTable | 1.3.6.1.2.1.69.1.5.8 | not-accessible | Contains a log of network and device events that may be of interest in fault isolation and troubleshooting. If the local(0) bit is set in docsDevEvReporting, entries in this table MUST persist across reboots. | |
| DAT docsDevEvFirstTime | 1.3.6.1.2.1.69.1.5.8.1.2 | DateAndTime | read-only | The value of docsDevDateTime at the time this entry was created. |
| U32 docsDevEvId | 1.3.6.1.2.1.69.1.5.8.1.6 | Unsigned32 | read-only | For this product, uniquely identifies the type of event that is reported by this entry. |
| I32 docsDevEvIndex | 1.3.6.1.2.1.69.1.5.8.1.1 | Integer32 | not-accessible | Provides relative ordering of the objects in the event log. This object will always increase except when (a) the log is reset via docsDevEvControl, (b) the device reboots and does not implement non-volatile storage for this log, or (c) it reaches the value 2^31. The next entry for all the above cases is 1. |
| DAT docsDevEvLastTime | 1.3.6.1.2.1.69.1.5.8.1.3 | DateAndTime | read-only | When an entry reports only one event, this object will have the same value as the corresponding instance of docsDevEvFirstTime. When an entry reports multiple events, this object will record the value that docsDevDateTime had when the most recent event for this entry occurred. |
| INT docsDevEvLevel | 1.3.6.1.2.1.69.1.5.8.1.5 | INTEGER | read-only | The priority level of this event, as defined by the vendor. These are ordered from most serious (emergency) to least serious (debug). emergency(1) events indicate vendor-specific fatal hardware or software errors that prevent normal system operation. alert(2) events indicate a serious failure that causes the reporting system to reboot but that is not caused by hardware or software malfunctioning. critical(3) events indicate a serious failure that requires attention and prevents the device from transmitting data but that could be recovered without rebooting the system. error(4) and warning(5) events indicate that a failure occurred that could interrupt the normal data flow but that does not cause the device to re-register. notice(6) and information(7) events indicate a milestone or checkpoint in normal operation that could be of particular importance for troubleshooting. debug(8) events are reserved for vendor-specific events. During normal operation, no event more critical than notice(6) should be generated. Events between warning and emergency should be generated at appropriate levels of problems (e.g., emergency when the box is about to crash). |
| INT docsDevEvPriority | 1.3.6.1.2.1.69.1.5.7.1.1 | INTEGER | not-accessible | The priority level that is controlled by this entry. These are ordered from most (emergency) to least (debug) critical. Each event with a CM or CMTS has a particular priority level associated with it (as defined by the vendor). emergency(1) events indicate vendor-specific fatal hardware or software errors that prevent normal system operation. alert(2) events indicate a serious failure that causes the reporting system to reboot but is not caused by hardware or software malfunctioning. critical(3) events indicate a serious failure that requires attention and prevents the device from transmitting data but that could be recovered without rebooting the system. error(4) and warning(5) events indicate that a failure occurred that could interrupt the normal data flow but that does not cause the device to re-register. notice(6) and information(7) events indicate a milestone or checkpoint in normal operation that could be of particular importance for troubleshooting. debug(8) events are reserved for vendor-specific events. During normal operation, no event more critical than notice(6) should be generated. Events between warning and emergency should be generated at appropriate levels of problems (e.g., emergency when the box is about to crash). |
| BIT docsDevEvReporting | 1.3.6.1.2.1.69.1.5.7.1.2 | Bits | read-write | Defines the action to be taken on occurrence of this event class. Implementations may not necessarily support all options for all event classes but at minimum must allow traps and syslogging to be disabled. If the local(0) bit is set, then log to the internal log and update non-volatile store, for backward compatibility with the original RFC 2669 definition. If the traps(1) bit is set, then generate an SNMP trap; if the syslog(2) bit is set, then send a syslog message (assuming that the syslog address is set). If the localVolatile(8) bit is set, then log to the internal log without updating non-volatile store. If the stdInterface(9) bit is set, then the agent ignores all other bits except the local(0), syslog(2), and localVolatile(8) bits. Setting the stdInterface(9) bit indicates that RFC3413 and RFC3014 are being used to control event reporting mechanisms. |
| IP docsDevEvSyslog | 1.3.6.1.2.1.69.1.5.2 | IpAddress | read-write | The IP address of the Syslog server. If 0.0.0.0, either syslog transmission is inhibited, or the Syslog server address is not an IPv4 address. This object is deprecated and is replaced by docsDevEvSyslogAddress. |
| IP docsDevEvSyslogAddress | 1.3.6.1.2.1.69.1.5.10 | InetAddress | read-write | The Internet address of the Syslog server, as provided by DHCP option 7 or set via SNMP management. If the address of the server is set to the zero-length string, the 0.0.0.0 IPv4 address, or the 0: IPv6 address, Syslog transmission is inhibited. Note that if multiple values are provided to the CM in DHCP option 7, the value of this MIB object MUST be the first Syslog server address received. By default at agent boot, this object returns the zero length string. |
| IPt docsDevEvSyslogAddressType | 1.3.6.1.2.1.69.1.5.9 | InetAddressType | read-write | The type of address of docsDevEvSyslogAddress. If no syslog server exists, this value should return unknown(0). |
| STR docsDevEvText | 1.3.6.1.2.1.69.1.5.8.1.7 | SnmpAdminString | read-only | Provides a human-readable description of the event, including all relevant context (interface numbers, etc.). |
| INT docsDevEvThrottleAdminStatus | 1.3.6.1.2.1.69.1.5.3 | INTEGER | read-write | Controls the transmission of traps and syslog messages with respect to the trap pacing threshold. unconstrained(1) causes traps and syslog messages to be transmitted without regard to the threshold settings. maintainBelowThreshold(2) causes trap transmission and syslog messages to be suppressed if the number of traps would otherwise exceed the threshold. stopAtThreshold(3) causes trap transmission to cease at the threshold and not to resume until directed to do so. inhibited(4) causes all trap transmission and syslog messages to be suppressed. A single event is always treated as a single event for threshold counting. That is, an event causing both a trap and a syslog message is still treated as a single event. Writing to this object resets the thresholding state. |
| T/F docsDevEvThrottleInhibited | 1.3.6.1.2.1.69.1.5.4 | TruthValue | read-only | If true(1), trap and syslog transmission is currently inhibited due to thresholds and/or the current setting of docsDevEvThrottleAdminStatus. In addition, this is true(1) when transmission is inhibited because no syslog (docsDevEvSyslog) or trap (docsDevNmAccessEntry) destinations have been set. This object is deprecated and is replaced by docsDevEvThrottleThresholdExceeded. |
| I32 docsDevEvThrottleInterval | 1.3.6.1.2.1.69.1.5.6 | Integer32 | read-write | The interval over which docsDevEvThrottleThreshold applies. |
| U32 docsDevEvThrottleThreshold | 1.3.6.1.2.1.69.1.5.5 | Unsigned32 | read-write | Number of events per docsDevEvThrottleInterval permitted before throttling is to occur. A single event, whether the notification could result in messages transmitted using syslog, SNMP, or both protocols, and regardless of the number of destinations, (including zero) is always treated as a single event for threshold counting. For example, an event causing both a trap and a syslog message is still treated as a single event. All system notifications that occur within the device should be taken into consideration when calculating and monitoring the threshold. |
| T/F docsDevEvThrottleThresholdExceeded | 1.3.6.1.2.1.69.1.5.11 | TruthValue | read-only | If true(1), trap and syslog transmission is currently inhibited due to exceeding the trap/syslog event threshold in the current interval. |
| docsDevFilter | 1.3.6.1.2.1.69.1.6 | |||
| docsDevFilterGroup | 1.3.6.1.2.1.69.3.1.6 | A collection of objects to specify filters at the link layer and IPv4 layer. This group has been deprecated and replaced by various groups from the DiffServ MIB. | ||
| T/F docsDevFilterIpBroadcast | 1.3.6.1.2.1.69.1.6.4.1.6 | TruthValue | read-create | 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. |
| T/F docsDevFilterIpContinue | 1.3.6.1.2.1.69.1.6.4.1.19 | TruthValue | read-create | 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. |
| INT docsDevFilterIpControl | 1.3.6.1.2.1.69.1.6.4.1.3 | INTEGER | read-create | 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 further processing (e.g., bridging). If docsDevFilterIpContinue is set to true, see if there are other matches; otherwise, done. If set to policy (3), execute the policy entries matched by docsDevFilterIpPolicyId in docsDevFilterPolicyTable. If docsDevFilterIpContinue is set to true, continue scanning the table for other matches; otherwise, done. |
| IP docsDevFilterIpDaddr | 1.3.6.1.2.1.69.1.6.4.1.9 | IpAddress | read-create | 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 00000000 for this object and 00000000 for the mask matches all IP addresses. |
| INT docsDevFilterIpDefault | 1.3.6.1.2.1.69.1.6.3 | INTEGER | read-write | The default behavior for (bridged) packets that do not match IP filters (or Internet filters, if implemented) is defined by docsDevFilterIpDefault. If set to discard(1), all packets not matching an IP filter in docsDevFilterIpTable will be discarded. If set to accept(2), all packets not matching an IP filter or an Internet filter will be accepted for further processing (e.g., bridging). |
| I32 docsDevFilterIpDestPortHigh | 1.3.6.1.2.1.69.1.6.4.1.15 | Integer32 | read-create | 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. |
| I32 docsDevFilterIpDestPortLow | 1.3.6.1.2.1.69.1.6.4.1.14 | Integer32 | read-create | 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. |
| INT docsDevFilterIpDirection | 1.3.6.1.2.1.69.1.6.4.1.5 | INTEGER | read-create | Determines whether the filter is applied to inbound(1) traffic, outbound(2) traffic, or traffic in both(3) directions. |
| IP docsDevFilterIpDmask | 1.3.6.1.2.1.69.1.6.4.1.10 | IpAddress | read-create | 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. |
| docsDevFilterIpEntry | 1.3.6.1.2.1.69.1.6.4.1 | not-accessible | 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) must match their respective fields in the packet for any given filter to match. To create an entry in this table, docsDevFilterIpIfIndex must be specified. | |
| NUM docsDevFilterIpIfIndex | 1.3.6.1.2.1.69.1.6.4.1.4 | InterfaceIndexOrZero | read-create | 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 index of the customer-side (e.g., ethernet) interface(s). In CMTSes, this object MUST be specified to create a row in this table. Note that according to the DOCSIS OSSIv1.1 specification, ifIndex '1' in the Cable Modem means that this row applies to all CMCI (customer-facing) interfaces. |
| I32 docsDevFilterIpIndex | 1.3.6.1.2.1.69.1.6.4.1.1 | Integer32 | not-accessible | Index used to order the application of filters. The filter with the lowest index is always applied first. |
| NUM docsDevFilterIpMatches | 1.3.6.1.2.1.69.1.6.4.1.16 | ZeroBasedCounter32 | read-only | 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. |
| I32 docsDevFilterIpPolicyId | 1.3.6.1.2.1.69.1.6.4.1.20 | Integer32 | read-create | 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 as if docsDevFilterIpControl were set to accept (1). If this object is set to the value of 0, there is no matching policy, and docsDevFilterPolicyTable MUST NOT be consulted. |
| I32 docsDevFilterIpProtocol | 1.3.6.1.2.1.69.1.6.4.1.11 | Integer32 | read-create | 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. |
| IP docsDevFilterIpSaddr | 1.3.6.1.2.1.69.1.6.4.1.7 | IpAddress | read-create | 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 object and 0 for the mask matches all IP addresses. |
| IP docsDevFilterIpSmask | 1.3.6.1.2.1.69.1.6.4.1.8 | IpAddress | read-create | 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. |
| I32 docsDevFilterIpSourcePortHigh | 1.3.6.1.2.1.69.1.6.4.1.13 | Integer32 | read-create | 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. |
| I32 docsDevFilterIpSourcePortLow | 1.3.6.1.2.1.69.1.6.4.1.12 | Integer32 | read-create | 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. |
| ROW docsDevFilterIpStatus | 1.3.6.1.2.1.69.1.6.4.1.2 | RowStatus | read-create | 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 and results in the packets being discarded. docsDevFilterIpIfIndex (at least) must be specified on a CMTS to create a row. Creation of the rows may be done via either create-and-wait or create-and-go, but the filter is not applied until this object is set to (or changes to) active. There is no restriction in changing any object in a row while this object is set to active. |
| docsDevFilterIpTable | 1.3.6.1.2.1.69.1.6.4 | not-accessible | 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. | |
| OCT docsDevFilterIpTos | 1.3.6.1.2.1.69.1.6.4.1.17 | OCTET STRING | read-create | 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. |
| OCT docsDevFilterIpTosMask | 1.3.6.1.2.1.69.1.6.4.1.18 | OCTET STRING | read-create | The mask to be applied to the packet's TOS value before matching. |
| docsDevFilterLLCEntry | 1.3.6.1.2.1.69.1.6.2.1 | not-accessible | Describes a single filter to apply to (bridged) LLC traffic received on a specified interface. | |
| docsDevFilterLLCGroup | 1.3.6.1.2.1.69.3.3.7 | A collection of objects to specify link layer filters. | ||
| NUM docsDevFilterLLCIfIndex | 1.3.6.1.2.1.69.1.6.2.1.3 | InterfaceIndexOrZero | read-create | The entry interface to which this filter applies. The value corresponds to ifIndex for either a CATV MAC or another network interface. If the value is zero, the filter applies to all interfaces. In Cable Modems, the default value is the customer side interface(s). In CMTSs, this object has to be specified to create a row in this table. Note that according to the DOCSIS OSSIv1.1 specification, ifIndex '1' in the CM means that this row applies to all Cable Modem-to-CPE Interfaces (CMCI). |
| I32 docsDevFilterLLCIndex | 1.3.6.1.2.1.69.1.6.2.1.1 | Integer32 | not-accessible | Index used for the identification of filters (note that LLC filter order is irrelevant). |
| C32 docsDevFilterLLCMatches | 1.3.6.1.2.1.69.1.6.2.1.6 | Counter32 | read-only | Counts the number of times this filter was matched. |
| I32 docsDevFilterLLCProtocol | 1.3.6.1.2.1.69.1.6.2.1.5 | Integer32 | read-create | The layer-three protocol for which this filter applies. The protocol value format depends on docsDevFilterLLCProtocolType. Note that for SNAP frames, ethertype filtering is performed rather than Destination Service Access Point (DSAP) =0xAA. |
| INT docsDevFilterLLCProtocolType | 1.3.6.1.2.1.69.1.6.2.1.4 | INTEGER | read-create | The format of the value in docsDevFilterLLCProtocol: either a two-byte Ethernet Ethertype, or a one-byte 802.2 Service Access Point (SAP) value. ethertype(1) also applies to Standard Network Access Protocol (SNAP) encapsulated frames. |
| ROW docsDevFilterLLCStatus | 1.3.6.1.2.1.69.1.6.2.1.2 | RowStatus | read-create | Controls and reflects the status of rows in this table. There is no restriction on changing any of the associated columns for this row while this object is set to active. 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 and results in the packets being discarded. docsDevFilterLLCIfIndex (at least) must be specified on a CMTS to create a row. |
| docsDevFilterLLCTable | 1.3.6.1.2.1.69.1.6.2 | not-accessible | A list of filters to apply to (bridged) LLC traffic. The filters in this table are applied to incoming traffic on the appropriate interface(s) prior to any further processing (e.g., before the packet is handed off for level 3 processing, or for bridging). The specific action taken when no filter is matched is controlled by docsDevFilterLLCUnmatchedAction. Table entries MUST NOT persist across reboots for any device. | |
| INT docsDevFilterLLCUnmatchedAction | 1.3.6.1.2.1.69.1.6.1 | INTEGER | read-write | LLC (Link Level Control) filters can be defined on an inclusive or exclusive basis: CMs can be configured to forward only packets matching a set of layer three protocols, or to drop packets matching a set of layer three protocols. Typical use of these filters is to filter out possibly harmful (given the context of a large metropolitan LAN) protocols. If set to discard(1), any L2 packet that does not match at least one filter in the docsDevFilterLLCTable will be discarded. If set to accept(2), any L2 packet that does not match at least one filter in the docsDevFilterLLCTable will be accepted for further processing (e.g., bridging). In other words, if the packet does not match an entry in the table, it takes this action; if it does match an entry in the table, it takes the opposite of this action. |
| docsDevFilterPolicyEntry | 1.3.6.1.2.1.69.1.6.5.1 | not-accessible | An entry in the docsDevFilterPolicyTable. Entries are created by Network Management. To create an entry, docsDevFilterPolicyId MUST be specified. | |
| I32 docsDevFilterPolicyId | 1.3.6.1.2.1.69.1.6.5.1.2 | Integer32 | read-create | 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 docsDevFilterIpPolicyId is set to 0, it DOES NOT match policy 0 of this table. |
| I32 docsDevFilterPolicyIndex | 1.3.6.1.2.1.69.1.6.5.1.1 | Integer32 | not-accessible | Index value for the table. |
| NUM docsDevFilterPolicyPtr | 1.3.6.1.2.1.69.1.6.5.1.6 | RowPointer | read-create | 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 accessible object in the row; e.g., to point to a row in docsDevFilterTosTable with an index of 21, the value of this object would be the object identifier docsDevTosStatus.21. Vendors are recommended to adhere to the same convention when adding vendor-specific policy table extensions. If this pointer references an empty or non-existent row, then no policy action is taken. The default upon row creation is a null pointer that results in no policy action being taken. |
| ROW docsDevFilterPolicyStatus | 1.3.6.1.2.1.69.1.6.5.1.5 | RowStatus | read-create | 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 active: docsDevFilterPolicyPtr. |
| docsDevFilterPolicyTable | 1.3.6.1.2.1.69.1.6.5 | not-accessible | 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. | |
| OCT docsDevFilterTosAndMask | 1.3.6.1.2.1.69.1.6.6.1.3 | OCTET STRING | read-create | This value is bitwise ANDed with the matched packet's TOS bits. |
| docsDevFilterTosEntry | 1.3.6.1.2.1.69.1.6.6.1 | not-accessible | A TOS policy entry. | |
| I32 docsDevFilterTosIndex | 1.3.6.1.2.1.69.1.6.6.1.1 | Integer32 | not-accessible | The unique index for this row. There are no ordering requirements for this table, and any valid index may be specified. |
| OCT docsDevFilterTosOrMask | 1.3.6.1.2.1.69.1.6.6.1.4 | OCTET STRING | read-create | This value is bitwise ORed with the result from the AND procedure (tosBits & docsDevFilterTosAndMask). The result then replaces the packet's TOS bits. |
| ROW docsDevFilterTosStatus | 1.3.6.1.2.1.69.1.6.6.1.2 | RowStatus | read-create | 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 or create-and-wait paradigms. There is no restriction on the ability to change values in this row while the row is active. |
| docsDevFilterTosTable | 1.3.6.1.2.1.69.1.6.6 | not-accessible | 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. | |
| docsDevGroups | 1.3.6.1.2.1.69.3.1 | |||
| docsDevGroupsV2 | 1.3.6.1.2.1.69.3.3 | |||
| INT docsDevIgmpModeControl | 1.3.6.1.2.1.69.1.1.6 | INTEGER | read-write | This object controls the IGMP mode of operation for the CM or CMTS. In passive mode, the device forwards IGMP between interfaces as based on knowledge of Multicast Session activity on the subscriber side interface and the rules defined in the DOCSIS RFI specification. In active mode, the device terminates at and initiates IGMP through its interfaces as based on the knowledge of Multicast Session activity on the subscriber side interface. |
| docsDevInetCpeGroup | 1.3.6.1.2.1.69.3.3.8 | A collection of objects used to control the number and specific values of Internet (e.g., IPv4 and IPv6) addresses allowed for associated Customer Premises Equipment (CPE). | ||
| U32 docsDevMaxCpe | 1.3.6.1.2.1.69.1.1.7 | Unsigned32 | read-only | The maximum number of CPEs that can be granted access through a CM during a CM epoch. This value can be obtained from the CM configuration file; however, it may be adjusted by the CM according to hardware or software limitations that have been imposed on the implementation. |
| docsDevMIBObjects | 1.3.6.1.2.1.69.1 | |||
| OCT docsDevNmAccessCommunity | 1.3.6.1.2.1.69.1.2.1.4 | OCTET STRING | read-create | 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. |
| INT docsDevNmAccessControl | 1.3.6.1.2.1.69.1.2.1.5 | INTEGER | read-create | 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. RoWithtraps(4), rwWithTraps(5), and trapsOnly(6) control distribution of Trap PDUs transmitted by this device. |
| docsDevNmAccessEntry | 1.3.6.1.2.1.69.1.2.1 | not-accessible | 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 empty, or explicit through an entry in this table). Entries are ordered by docsDevNmAccessIndex. The first matching entry (e.g., matching IP address and community string) is used to derive access. | |
| docsDevNmAccessExtGroup | 1.3.6.1.2.1.69.3.3.3 | An object, in addition to the objects in docsDevNmAccessGroup, for controlling access to SNMP objects on cable devices. This group is included in this MIB due to existing implementations of docsDevNmAccessTrapVersion in DOCSIS cable modems. This group has been deprecated because the object has been deprecated in favor of SNMPv3 and Coexistence MIBs. | ||
| docsDevNmAccessGroup | 1.3.6.1.2.1.69.3.1.2 | A collection of objects for controlling access to SNMP objects on cable devices. This group has been deprecated because all the objects have been deprecated in favor of SNMPv3 and Coexistence MIBs. | ||
| I32 docsDevNmAccessIndex | 1.3.6.1.2.1.69.1.2.1.1 | Integer32 | not-accessible | Index used to order the application of access entries. |
| OCT docsDevNmAccessInterfaces | 1.3.6.1.2.1.69.1.2.1.6 | OCTET STRING | read-create | 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 through 8, the second octet specifying interfaces 9 through 16, etc. Within each octet, the most significant bit represents the lowest numbered interface, and the least significant bit represents the highest numbered interface. Thus, each interface is represented by a single bit within the value of this object. If that bit has a value of '1' then that interface is included in the set. Note that entries in this table apply only to link-layer interfaces (e.g., Ethernet and CATV MAC). Bits representing upstream and downstream channel interfaces MUST NOT be set to '1'. Note that if bits corresponding to non-existing interfaces are set, the result is implementation specific. Note that according to the DOCSIS OSSIv1.1 specification, when ifIndex '1' is included in the set, then this row applies to all CPE (customer-facing) interfaces. The size of this object is the minimum required to represent all configured interfaces for this device. |
| IP docsDevNmAccessIp | 1.3.6.1.2.1.69.1.2.1.2 | IpAddress | read-create | 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 specific device. Implementations MAY recognize 255.255.255.255 as equivalent to 0.0.0.0. |
| IP docsDevNmAccessIpMask | 1.3.6.1.2.1.69.1.2.1.3 | IpAddress | read-create | 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. |
| ROW docsDevNmAccessStatus | 1.3.6.1.2.1.69.1.2.1.7 | RowStatus | read-create | 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 while the row is active. The following objects MUST have valid values before this object can be set to active: docsDevNmAccessIp, docsDevNmAccessStatus, docsDevNmAccessIpMask, docsDevNmAccessCommunity, docsDevNmAccessControl, and docsDevNmAccessInterfaces. |
| docsDevNmAccessTable | 1.3.6.1.2.1.69.1.2 | not-accessible | 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. | |
| INT docsDevNmAccessTrapVersion | 1.3.6.1.2.1.69.1.2.1.8 | INTEGER | read-create | 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 trap in SNMPv2 format be sent to a particular NMS. |
| docsDevNotification | 1.3.6.1.2.1.69.2 | |||
| docsDevNotifications | 1.3.6.1.2.1.69.0 | |||
| T/F docsDevResetNow | 1.3.6.1.2.1.69.1.1.3 | TruthValue | read-write | Setting this object to true(1) causes the device to reset. Reading this object always returns false(2). |
| INT docsDevRole | 1.3.6.1.2.1.69.1.1.1 | INTEGER | read-only | Defines the current role of this device. cm(1) is a Cable Modem, cmtsActive(2) is a Cable Modem Termination System that is controlling the system of cable modems, and cmtsBackup(3) is a CMTS that is currently connected but is not controlling the system (not currently used). In general, if this device is a 'cm', its role will not change during operation or between reboots. If the device is a 'cmts' it may change between cmtsActive and cmtsBackup and back again during normal operation. NB: At this time, the DOCSIS standards do not support the concept of a backup CMTS, but cmtsBackup is included for completeness. |
| STR docsDevSerialNumber | 1.3.6.1.2.1.69.1.1.4 | SnmpAdminString | read-only | The manufacturer's serial number for this device. |
| docsDevServer | 1.3.6.1.2.1.69.1.4 | |||
| INT docsDevServerBootState | 1.3.6.1.2.1.69.1.4.1 | INTEGER | read-only | If operational(1), the device has completed loading and processing of configuration parameters, and the CMTS has completed the Registration exchange. If disabled(2), then the device was administratively disabled, possibly by being refused network access in the configuration file. If waitingForDhcpOffer(3), then a Dynamic Host Configuration Protocol (DHCP) Discover has been transmitted, and no offer has yet been received. If waitingForDhcpResponse(4), then a DHCP Request has been transmitted, and no response has yet been received. If waitingForTimeServer(5), then a Time Request has been transmitted, and no response has yet been received. If waitingForTftp(6), then a request to the TFTP parameter server has been made, and no response received. If refusedByCmts(7), then the Registration Request/Response exchange with the CMTS failed. If forwardingDenied(8), then the registration process was completed, but the network access option in the received configuration file prohibits forwarding. If other(9), then the registration process reached a point that does not fall into one of the above categories. If unknown(10), then the device has not yet begun the registration process or is in some other indeterminate state. |
| STR docsDevServerConfigFile | 1.3.6.1.2.1.69.1.4.5 | SnmpAdminString | read-only | The name of the device configuration file read from the TFTP server. Returns a zero-length string if the configuration file name is unknown. |
| IP docsDevServerConfigTftpAddress | 1.3.6.1.2.1.69.1.4.11 | InetAddress | read-only | The internet address of the TFTP server responsible for downloading provisioning and configuration parameters to this device. Returns the zero-length octet string if the config server address is unknown. There are certain security risks that are involved with using TFTP. |
| IPt docsDevServerConfigTftpAddressType | 1.3.6.1.2.1.69.1.4.10 | InetAddressType | read-only | The type of address of docsDevServerConfigTftpAddress. If no TFTP server exists, this value should return unknown(0). |
| IP docsDevServerDhcp | 1.3.6.1.2.1.69.1.4.2 | IpAddress | read-only | The IP address of the DHCP server that assigned an IP address to this device. Returns 0.0.0.0 if DHCP is not used for IP address assignment, or if this agent is not assigned an IPv4 address. This object is deprecated and is replaced by docsDevServerDhcpAddress. |
| IP docsDevServerDhcpAddress | 1.3.6.1.2.1.69.1.4.7 | InetAddress | read-only | The internet address of the DHCP server that assigned an IP address to this device. Returns the zero length octet string if DHCP was not used for IP address assignment. |
| IPt docsDevServerDhcpAddressType | 1.3.6.1.2.1.69.1.4.6 | InetAddressType | read-only | The type of address of docsDevServerDhcpAddress. If DHCP was not used, this value should return unknown(0). |
| docsDevServerGroup | 1.3.6.1.2.1.69.3.1.4 | A collection of objects providing status about server provisioning. This group has been deprecated and replaced by docsDevServerGroupV2. The objects docsDevServerDhcp, docsDevServerTime, and docsDevServerTftp have been replaced by docsDevServerDhcpAddressType, docsDevServerDhcpAddress, docsDevServerTimeAddressType, docsDevServerTimeAddress, docsDevServerConfigTftpAddressType, and docsDevServerConfigTftpAddress. | ||
| docsDevServerGroupV2 | 1.3.6.1.2.1.69.3.3.5 | A collection of objects providing status about server provisioning. This group replaces docsDevServerGroup. | ||
| IP docsDevServerTftp | 1.3.6.1.2.1.69.1.4.4 | IpAddress | read-only | The IP address of the TFTP server responsible for downloading provisioning and configuration parameters to this device. Returns 0.0.0.0 if the TFTP server address is unknown or is not an IPv4 address. This object is deprecated and is replaced by docsDevServerConfigTftpAddress. |
| IP docsDevServerTime | 1.3.6.1.2.1.69.1.4.3 | IpAddress | read-only | The IP address of the Time server (RFC 0868). Returns 0.0.0.0 if the time server IP address is unknown, or if the time server is not an IPv4 server. This object is deprecated and is replaced by docsDevServerTimeAddress. |
| IP docsDevServerTimeAddress | 1.3.6.1.2.1.69.1.4.9 | InetAddress | read-only | The Internet address of the RFC 868 Time server, as provided by DHCP option 4. Note that if multiple values are provided to the CM in DHCP option 4, the value of this MIB object MUST be the Time server address from which the Time of Day reference was acquired as based on the DOCSIS RFI specification. During the period of time where the Time of Day have not been acquired, the Time server address reported by the CM may report the first address value in the DHCP option value or the last server address the CM attempted to get the Time of day value. Returns the zero-length octet string if the time server IP address is not provisioned. |
| IPt docsDevServerTimeAddressType | 1.3.6.1.2.1.69.1.4.8 | InetAddressType | read-only | The type of address of docsDevServerTimeAddress. If no time server exists, this value should return unknown(0). |
| docsDevSoftware | 1.3.6.1.2.1.69.1.3 | |||
| docsDevSoftwareGroup | 1.3.6.1.2.1.69.3.1.3 | A collection of objects for controlling software downloads. This group has been deprecated and replaced by docsDevSoftwareGroupV2. Object docsDevSwServer has been replaced by docsDevSwServerAddressType and docsDevSwServerAddress, and docsDevSwServerTransportProtocol has been added to support TFTP and HTTP firmware downloads. | ||
| docsDevSoftwareGroupV2 | 1.3.6.1.2.1.69.3.3.4 | A collection of objects for controlling software downloads. This group replaces docsDevSoftwareGroup. | ||
| INT docsDevSTPControl | 1.3.6.1.2.1.69.1.1.5 | INTEGER | read-write | This object controls operation of the spanning tree protocol (as distinguished from transparent bridging). If set to stEnabled(1), then the spanning tree protocol is enabled, subject to bridging constraints. If noStFilterBpdu(2), then spanning tree is not active, and Bridge PDUs received are discarded. If noStPassBpdu(3), then spanning tree is not active, and Bridge PDUs are transparently forwarded. Note that a device need not implement all of these options, but that noStFilterBpdu(2) is required. |
| INT docsDevSwAdminStatus | 1.3.6.1.2.1.69.1.3.3 | INTEGER | read-write | If set to upgradeFromMgt(1), the device will initiate a TFTP or HTTP software image download. After successfully receiving an image, the device will set its state to ignoreProvisioningUpgrade(3) and reboot. If the download process is interrupted (e.g., by a reset or power failure), the device will load the previous image and, after re-initialization, continue to attempt loading the image specified in docsDevSwFilename. If set to allowProvisioningUpgrade(2), the device will use the software version information supplied by the provisioning server when next rebooting (this does not cause a reboot). When set to ignoreProvisioningUpgrade(3), the device will disregard software image upgrade information from the provisioning server. Note that reading this object can return upgradeFromMgt(1). This indicates that a software download is currently in progress, and that the device will reboot after successfully receiving an image. |
| STR docsDevSwCurrentVers | 1.3.6.1.2.1.69.1.3.5 | SnmpAdminString | read-only | The software version currently operating in this device. This string's syntax is that used by the individual vendor to identify software versions. For a CM, this string will describe the current software load. For a CMTS, this object SHOULD contain a human-readable representation either of the vendor specific designation of the software for the chassis, or of the software for the control processor. If neither of these is applicable, the value MUST be a zero-length string. |
| STR docsDevSwFilename | 1.3.6.1.2.1.69.1.3.2 | SnmpAdminString | read-write | The filename of the software image to be downloaded via TFTP, or the abs_path (as defined in RFC 2616) of the software image to be downloaded via HTTP. Unless set via SNMP, this is the filename or abs_path specified by the provisioning server during the boot process that corresponds to the software version that is desired for this device. If unknown, the value of this object is the zero-length string. |
| INT docsDevSwOperStatus | 1.3.6.1.2.1.69.1.3.4 | INTEGER | read-only | InProgress(1) indicates that a TFTP or HTTP download is underway, either as a result of a version mismatch at provisioning or as a result of a upgradeFromMgt request. No other docsDevSw* objects can be modified in this state. CompleteFromProvisioning(2) indicates that the last software upgrade was a result of version mismatch at provisioning. CompleteFromMgt(3) indicates that the last software upgrade was a result of setting docsDevSwAdminStatus to upgradeFromMgt. Failed(4) indicates that the last attempted download failed, ordinarily due to TFTP or HTTP timeout. |
| IP docsDevSwServer | 1.3.6.1.2.1.69.1.3.1 | IpAddress | read-write | The address of the TFTP server used for software upgrades. If the TFTP server is unknown or is a non-IPv4 address, return 0.0.0.0. This object is deprecated. See docsDevSwServerAddress for its replacement. This object will have its value modified, given a valid SET to docsDevSwServerAddress. |
| IP docsDevSwServerAddress | 1.3.6.1.2.1.69.1.3.7 | InetAddress | read-write | The address of the TFTP or HTTP server used for software upgrades. If the TFTP/HTTP server is unknown, return the zero- length address string (see the TextualConvention). If docsDevSwServer is also implemented in this agent, this object is tied to it. A set of this object to an IPv4 address will result in also setting the value of docsDevSwServer to that address. If this object is set to an IPv6 address, docsDevSwServer is set to 0.0.0.0. If docsDevSwServer is set, this object is also set to that value. Note that if both are set in the same action, the order of which one sets the other is undefined. |
| IPt docsDevSwServerAddressType | 1.3.6.1.2.1.69.1.3.6 | InetAddressType | read-write | The type of address of the TFTP or HTTP server used for software upgrades. If docsDevSwServerTransportProtocol is currently set to tftp(1), attempting to set this object to dns(16) MUST result in an error. |
| INT docsDevSwServerTransportProtocol | 1.3.6.1.2.1.69.1.3.8 | INTEGER | read-write | This object specifies the transport protocol (TFTP or HTTP) to be used for software upgrades. If the value of this object is tftp(1), then the cable device uses TFTP (RFC 1350) read request packets to download the docsDevSwFilename from the docsDevSwServerAddress in octet mode. If the value of this object is http(2), then the cable device uses HTTP 1.0 (RFC 1945) or HTTP 1.1 (RFC 2616) GET requests sent to host docsDevSwServerAddress to download the software image from path docsDevSwFilename. If docsDevSwServerAddressType is currently set to dns(16), attempting to set this object to tftp(1) MUST result in an error. |
RFC description
Industry standard MIB for DOCSIS cable modems and cable modem termination systems, defined in RFC 2669.
Start monitoring DOCSIS cable modem/CMTS (device management, vendor-neutral IETF standard RFC 4639) 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.