DOCS-TEST-MIB

All MIBs › DOCS-TEST-MIB

Organization: DOCSIS 2.0 ATP Working Group

Last Updated: 2002-03-15

Category: Domain: CATV/Cable, Standard: DOCSIS

Description: Provides test and diagnostic management objects for DOCSIS cable modem and CMTS device testing.

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

What Is DOCS-TEST-MIB?

DOCS-TEST-MIB is a CableLabs DOCSIS module that defines programmable test and diagnostic features for DOCSIS 2.0-compliant cable modems (CMs) and cable modem termination systems (CMTS). It exposes objects for invoking, controlling, and reading back built-in diagnostic tests rather than everyday traffic counters. The MIB is used specifically to monitor device self-test status and health checks, letting an operator confirm whether a cable modem's or CMTS's internal diagnostics report pass/fail conditions, effectively a software/firmware-level health status check rather than physical sensor telemetry. It builds on the CableLabs enterprise MIB tree (cableLabs, clabProject, clabProjDocsis) and is typically layered alongside the standard DOCSIS cable device and RF interface MIBs. It is deployed in cable operator head-ends and subscriber premises equipment as part of DOCSIS 2.0 compliance testing and remote diagnostics. Engineers can download the DOCS-TEST-MIB file directly to load it into their MIB browser.

IPNetwork Monitor allows you to monitor SNMP objects defined in DOCS-TEST-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 cable modem
DOCSIS CMTS

Monitoring Examples

An operator can enable a diagnostic run by setting docsTestEnable and selecting a test via docsTestType, then poll docsTestStatus to see whether the test completed successfully or reported a failure, with docsTestData holding the returned result payload and docsTestCapability indicating which tests the device supports. This is useful for remotely verifying a cable modem's RF front-end or ranging behavior without a truck roll. The clabFunction/clabProject branches are registration-only OIDs used to organize CableLabs' enterprise tree and are not themselves polled for data.

What Can Be Monitored

diagnostic test capability
diagnostic test enable state
test type selected
test execution status (pass/fail)
test result data

Imported Objects

From SNMPv2-CONF

MODULE-COMPLIANCE
OBJECT-GROUP

From SNMPv2-SMI

Integer32
MODULE-IDENTITY
OBJECT-TYPE
enterprises

From SNMPv2-TC

TEXTUAL-CONVENTION
TruthValue

OIDs

OID symbolic	OID numeric	Type	Access	Description
cableLabs	1.3.6.1.4.1.4491
clabFunction	1.3.6.1.4.1.4491.1
clabFuncMib2	1.3.6.1.4.1.4491.1.1
clabFuncProprietary	1.3.6.1.4.1.4491.1.2
clabProject	1.3.6.1.4.1.4491.2
clabProjDocsis	1.3.6.1.4.1.4491.2.1
docsTestMIB	1.3.6.1.4.1.4491.2.1.12			This is the MIB Module supporting programmable test features for DOCSIS 2.0 compliant Cable Modems (CM) and Cable Modem Termination Systems (CMTS).
docsTestMibObjects	1.3.6.1.4.1.4491.2.1.12.1
docsTestBaseObjects	1.3.6.1.4.1.4491.2.1.12.1.1
OCT docsTestCapability	1.3.6.1.4.1.4491.2.1.12.1.1.1	OCTET STRING	read-only	Indicates the ability of this device to support the programmable features identified by the TYPE field from the CM/CMTS TLV table in [17]. Each octet within this octet string represents eight tests. For example, the first octet represents tests one through eight (with the msb representing test one) as identified by the TYPE field.
OCT docsTestStatus	1.3.6.1.4.1.4491.2.1.12.1.1.2	OCTET STRING	read-only	Indicates the current operating status of tests initiated through the docsTestSetupObjects. The octet representation is identical to that used by docsTestCapability. A bit representation of one indicates that a test is currently active, while zero indicates the test is inactive or has completed.
docsTestSetupObjects	1.3.6.1.4.1.4491.2.1.12.1.2
I32 docsTestType	1.3.6.1.4.1.4491.2.1.12.1.2.1	Integer32	read-write	Corresponds to the TYPE field from the CM/CMTS TLV Table in [17]. The default value of zero indicates no test has yet been initiated. A WrongValueError should be returned in response to a write request for a test not supported by the device. A read request will return the docsTestType value last successfully written, whether that test is active or inactive.
OCT docsTestData	1.3.6.1.4.1.4491.2.1.12.1.2.2	OCTET STRING	read-write	The OCTET STRING length and value correspond to the LENGTH and VALUE fields from the CM/CMTS TLV Table in [17]. A read request will return the docsTestData value last successfully written, whether that test is active or inactive.
T/F docsTestEnable	1.3.6.1.4.1.4491.2.1.12.1.2.3	TruthValue	read-write	Used to initiate or stop the tests setup through the docsTestType and docsTestData objects. A CommitFailedError should be returned in response to a TRUE Write request if the values in docsTestType and docsTestData are incompatible, or a test could not be initiated for any other reason.
docsTestConformance	1.3.6.1.4.1.4491.2.1.12.2
docsTestCompliances	1.3.6.1.4.1.4491.2.1.12.2.1
docsTestBasicCompliance	1.3.6.1.4.1.4491.2.1.12.2.1.1			The compliance statement for devices that implement the DOCSIS compliant programmable test features.
docsTestGroups	1.3.6.1.4.1.4491.2.1.12.2.2
docsTestGroup	1.3.6.1.4.1.4491.2.1.12.2.2.1			Group of objects implemented in both Cable Modems and Cable Modem Termination Systems.
clabProjPacketCable	1.3.6.1.4.1.4491.2.2
clabProjOpenCable	1.3.6.1.4.1.4491.2.3
clabProjCableHome	1.3.6.1.4.1.4491.2.4

RFC description

CableLabs DOCSIS test MIB for Data Over Cable systems providing test and diagnostic capabilities.

Start monitoring DOCSIS 2.0 cable modem/CMTS (built-in diagnostic tests, vendor-neutral CableLabs standard) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download DOCS-TEST-MIB

What Is DOCS-TEST-MIB?

Supported Devices

Monitoring Examples

What Can Be Monitored

This MIB depends on

Related MIBs

RFC description