DOCS-DIAG-MIB
- Registered at
- 1.3.6.1.4.1.4491.2.1.9
- Last updated
- 2023-11-22 00:00
- Organization
- Cable Television Laboratories, Inc.
- Revisions
- 2023-11-22 00:00, 2007-12-06 00:00, 2007-05-18 00:00, 2006-12-07 00:00
- Namespace
- standard
- Source file
DOCS-DIAG-MIB- Digest
sha256:531072b6b52596692c204cb1a5dcfbbf218a78b86119202e749c828ef1b9db53
Description
This is the MIB Module for the Diagnostic Log for DOCSIS-compliant Cable Modem Termination Systems (CMTS). The purpose of the Diagnostic Log is to prevent service interruptions by early detection of potential problems. It can also be used for fault management and for troubleshooting the cable network. The Diagnostic Log contains Cable Modems that show certain potential problematic behaviors, as determined by the CMTS. These detection criteria are defined as diagnostic triggers. The diagnostic trigger is an information filter to avoid inundating a management agent with data which is less meaningful as a function of size. There are 2 diagnostic triggers defined. Each trigger maintains a counter for each Cable Modem that is caught by that trigger. (1) Registration Trigger (2) Ranging Retry Trigger Copyright 1999-2023 Cable Television Laboratories, Inc. All rights reserved.
Contact
Postal: Cable Television Laboratories 858 Coal Creek Circle Louisville, CO 80027-9750 U.S.A. Phone: +1 303-661-9100 Fax: +1 303-661-9199 E-mail: mibs@cablelabs.com
Imports
| From | Symbols |
|---|---|
| CLAB-DEF-MIB | clabProjDocsis |
| DOCS-CABLE-DEVICE-MIB | docsDevEvId, docsDevEvLevel |
| DOCS-IF3-MIB | CmtsCmRegState, docsIf3CmtsCmRegStatusId |
| SNMP-FRAMEWORK-MIB | SnmpAdminString |
| SNMPv2-CONF | MODULE-COMPLIANCE, NOTIFICATION-GROUP, OBJECT-GROUP |
| SNMPv2-SMI | Counter32, Gauge32, MODULE-IDENTITY, NOTIFICATION-TYPE, OBJECT-IDENTITY, OBJECT-TYPE, Unsigned32, iso |
| SNMPv2-TC | DateAndTime, DisplayString, MacAddress, TEXTUAL-CONVENTION, TruthValue |
Imported by
Nothing in this corpus imports this module.
Load order
Every file a consumer needs in order to load this module, dependencies first.
CLAB-DEF-MIB DIFFSERV-DSCP-TC DIFFSERV-MIB DOCS-CABLE-DEVICE-MIB DOCS-DIAG-MIB DOCS-IETF-BPI2-MIB DOCS-IF-MIB DOCS-IF3-MIB IANAifType-MIB IF-MIB INET-ADDRESS-MIB INTEGRATED-SERVICES-MIB RFC1158-MIB RFC1271-MIB RMON-MIB RMON2-MIB SNMP-FRAMEWORK-MIB SNMP-TARGET-MIB SNMPv2-CONF SNMPv2-MIB SNMPv2-SMI SNMPv2-TC TOKEN-RING-RMON-MIB
Textual conventions
| Name | OID | Syntax | Access | Status |
|---|---|---|---|---|
| RegistrationDetailFlag TEXTUAL-CONVENTION This data type defines an enumerated union of CM states used for the registration trigger detection. The named bits associated with this type correspond to a subset of the names for the enumerations in CmtsCmRegState data type. | current | |||
| TriggerFlag TEXTUAL-CONVENTION This type defines the Diagnostic Log Trigger Type. Bit 0 selects the registration trigger. Bit 1 selects the ranging retry trigger. | current |
Objects
| Name | OID | Syntax | Access | Status |
|---|---|---|---|---|
| docsDiagLogNotifications OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.9.0 | |||
| docsDiagLogMibObjects OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.9.1 | |||
| docsDiagLogGlobal OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.9.1.1 | |||
| docsDiagLogMaxSize OBJECT-TYPE The maximum number of Cable Modem entries that docsDiagLogTable can report. | 1.3.6.1.4.1.4491.2.1.9.1.1.1 | Unsigned32 (1..4294967295) | read-write | current |
| docsDiagLogCurrentSize OBJECT-TYPE The total number of Cable Modem entries reported in the docsDiagLogTable. The maximum value possible will be docsDiagLogMaxSize. | 1.3.6.1.4.1.4491.2.1.9.1.1.2 | Gauge32 (0..4294967295) | read-only | current |
| docsDiagLogNotifyLogSizeHighThrshld OBJECT-TYPE If the number of entries in docsDiagLogTable exceeds this value, CMTS will trigger the appropriate event. | 1.3.6.1.4.1.4491.2.1.9.1.1.3 | Unsigned32 (1..4294967295) | read-write | current |
| docsDiagLogNotifyLogSizeLowThrshld OBJECT-TYPE If the number of entries in docsDiagLogTable exceeded docsDiagLogNotifyLogSizeHighThrshld earlier and then drops to this value, CMTS will trigger the appropriate event. | 1.3.6.1.4.1.4491.2.1.9.1.1.4 | Unsigned32 (1..4294967295) | read-write | current |
| docsDiagLogAging OBJECT-TYPE Aging threshold for the Diagnostic Log. Periodically, a process scans through the Diagnostic log and removes those Cable Modems from docsDiagLogTable and docsDiagLogDetailTable that have no new detections for a time interval longer than this threshold in minutes. | 1.3.6.1.4.1.4491.2.1.9.1.1.5 | Unsigned32 (15..86400) | read-write | current |
| docsDiagLogResetAll OBJECT-TYPE If set to 'true', all counter objects for all entries in docsDiagLogTable and docsDiagLogDetailTable are reset to zero. Reading this object always returns 'false'. | 1.3.6.1.4.1.4491.2.1.9.1.1.6 | TruthValue | read-write | current |
| docsDiagLogLastResetTime OBJECT-TYPE The last time that all the counters in the docsDiagLogTable and docsDiagLogDetailTable are reset to 0. The special value of all '00'Hs indicates that the Entries in these tables have never been reset. | 1.3.6.1.4.1.4491.2.1.9.1.1.7 | DateAndTime | read-only | current |
| docsDiagLogClearAll OBJECT-TYPE If set to 'true', all entries from the docsDiagLogTable and docsDiagLogDetailTable are removed. Reading this object always returns 'false'. | 1.3.6.1.4.1.4491.2.1.9.1.1.8 | TruthValue | read-write | current |
| docsDiagLogLastClearTime OBJECT-TYPE The last time that all the entries in the docsDiagLogTable and docsDiagLogDetailTable are destroyed. The special value of all '00'Hs indicates that the entries in these tables have never been destroyed. | 1.3.6.1.4.1.4491.2.1.9.1.1.9 | DateAndTime | read-only | current |
| docsDiagLogNotifCtrl OBJECT-TYPE Used to enable diagnostic log related notifications. Setting bit 0 enables notification for reaching log size high threshold, Setting bit 1 enables notification for returning back to log size low threshold after reaching log size high threshold, Setting bit 2 enables notification for diagnostic log size full. | 1.3.6.1.4.1.4491.2.1.9.1.1.10 | Bits {highThresholdReached(0), lowThresholdReached(1), full(2)} | read-write | current |
| docsDiagLogTriggersCfg OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.9.1.2 | |||
| docsDiagLogIncludeTriggers OBJECT-TYPE Turns individual diagnostic triggers on and off. Multiple triggers can be turned on or off at a given time. Setting a particular bit to '1' turns on corresponding diagnostic trigger. Setting a particular bit to '0' turns off corresponding diagnostic trigger. | 1.3.6.1.4.1.4491.2.1.9.1.2.1 | TriggerFlag | read-write | current |
| docsDiagLogEnableAgingTriggers OBJECT-TYPE Enables and disables the aging of triggers based on the trigger type. Aging out can be enabled or disabled for multiple triggers at a given time. Setting a particular bit to '1' enables the aging out of log entries that are created by corresponding diagnostic trigger. Setting a particular bit to '0' disables the aging out of log entries that are created by corresponding diagnostic trigger. | 1.3.6.1.4.1.4491.2.1.9.1.2.2 | TriggerFlag | read-write | current |
| docsDiagLogRegTimeInterval OBJECT-TYPE Configurable parameter for the Registration trigger. The registration time interval is an empirically derived, worst-case number of seconds which the Cable Modem requires to complete registration. If the Cable Modem has not completed the registration stage within this registration time interval, the Cable Modem will be added to the Diagnostic Log. | 1.3.6.1.4.1.4491.2.1.9.1.2.3 | Unsigned32 (60..86400) | read-write | current |
| docsDiagLogRegDetail OBJECT-TYPE Setting a bit representing a CM registration state will enable counting the number of times the CMTS determines that such CM reaches that state as the last state before failing to proceed further in the registration process and within the time interval considered for the CM registration trigger detection. | 1.3.6.1.4.1.4491.2.1.9.1.2.4 | RegistrationDetailFlag | read-write | current |
| docsDiagLogRangingRetryType OBJECT-TYPE Configuration parameter for the Ranging Retry Trigger. When a Cable Modem failed to perform ranging when a ranging opportunity is scheduled by CMTS, it is counted as ranging miss. Ranging retry trigger can be configured to either look at consecutive ranging misses or ranging miss ratio over total number of station maintenance opportunities for a certain time period. If set to '1', this will select consecutive ranging misses as ranging retry trigger criteria. If set to '2', this will select ranging miss ratio as ranging retry trigger criteria. | 1.3.6.1.4.1.4491.2.1.9.1.2.5 | INTEGER {consecutiveMiss(1), missRatio(2)} | read-write | current |
| docsDiagLogRangingRetryThrhld OBJECT-TYPE Configurable parameter for the Ranging Retry Trigger. When the number of times a Cable Modem does not acknowledge a MAC-layer station maintenance message from a CMTS exceeds this threshold, the Cable Modem will be add to the Diagnostic Log. The value of docsDiagLogRangingRetryType, decides if consecutive ranging miss or ranging miss ratio is used as trigger. | 1.3.6.1.4.1.4491.2.1.9.1.2.6 | Unsigned32 (3..12) | read-write | current |
| docsDiagLogRangingRetryStationMaintNum OBJECT-TYPE Number of station maintenance opportunities to monitor for ranging retry trigger. This value implies time intervals in a certain range. DOCSIS requires the CMTS to schedule ranging opportunity to Cable Modem sufficiently smaller than T4. There is no fixed formula to derive at a fixed time interval, how many ranging opportunities would be offered to a Cable Modem by the CMTS, hence using the number of station maintenance opportunities provides ratio with the fixed denominators while also taking time factor into consideration. | 1.3.6.1.4.1.4491.2.1.9.1.2.7 | Unsigned32 (60..65535) | read-write | current |
| docsDiagLogTable OBJECT-TYPE This table keeps the Diagnostic Log of the Cable Modems, it is indexed by docsIf3CmtsCmRegStatusId. | 1.3.6.1.4.1.4491.2.1.9.1.3 | not-accessible | current | |
| docsDiagLogEntry OBJECT-TYPE A conceptual row entry in this table is a per Cable Modem summary of the diagnostic information detected by one or more triggers. There can be only one entry in this for a given Cable Modem. | 1.3.6.1.4.1.4491.2.1.9.1.3.1 | not-accessible | current | |
| docsDiagLogCmMacAddr OBJECT-TYPE MAC address of the Cable Modem. | 1.3.6.1.4.1.4491.2.1.9.1.3.1.1 | MacAddress | read-only | current |
| docsDiagLogLastUpdateTime OBJECT-TYPE The time and date value when this entry was last updated. When a Cable Modem is detected by one of the diagnostic trigger, if this table already has an entry for that Cable Modem, the entry will be updated. | 1.3.6.1.4.1.4491.2.1.9.1.3.1.2 | DateAndTime | read-only | current |
| docsDiagLogCreateTime OBJECT-TYPE The time and date value that this entry was added to this table. When a Cable Modem is detected by one of the diagnostic triggers, if this table has no entry for that cable mode, a new entry will be created. If an entry is removed and then re-added, there can be a discontinuity in the statistical objects associated with this entry. This timestamp can be used to detect those discontinuities. | 1.3.6.1.4.1.4491.2.1.9.1.3.1.3 | DateAndTime | read-only | current |
| docsDiagLogLastRegTime OBJECT-TYPE The last time this Cable Modem registered. | 1.3.6.1.4.1.4491.2.1.9.1.3.1.4 | DateAndTime | read-only | current |
| docsDiagLogRegCount OBJECT-TYPE The number of times the registration trigger condition was detected for this Cable Modem. | 1.3.6.1.4.1.4491.2.1.9.1.3.1.5 | Counter32 | read-only | current |
| docsDiagLogRangingRetryCount OBJECT-TYPE The number of times the ranging retry trigger condition was detected for this Cable Modem. | 1.3.6.1.4.1.4491.2.1.9.1.3.1.6 | Counter32 | read-only | current |
| docsDiagLogDetailTable OBJECT-TYPE This table contains detailed diagnostic information for Cable Modems already in docsDiagLogTable. | 1.3.6.1.4.1.4491.2.1.9.1.4 | not-accessible | current | |
| docsDiagLogDetailEntry OBJECT-TYPE A conceptual row in this table contains one single type of detailed diagnostic information for a Cable Modem. This table shall be instantiated only if at least one detail condition is enabled, via docsDiagLogRegDetail. There can be multiple entries in this table for a given cable modem, if more than one detail condition is enabled. | 1.3.6.1.4.1.4491.2.1.9.1.4.1 | not-accessible | current | |
| docsDiagLogDetailTypeValue OBJECT-TYPE The diagnostic detail type this entry represents. | 1.3.6.1.4.1.4491.2.1.9.1.4.1.1 | CmtsCmRegState | not-accessible | current |
| docsDiagLogDetailCount OBJECT-TYPE The counter value of this Cable Modem that reached this diagnostic detail state as the last state before it failed to proceed further. | 1.3.6.1.4.1.4491.2.1.9.1.4.1.2 | Counter32 | read-only | current |
| docsDiagLogDetailLastUpdate OBJECT-TYPE Time and date value when this entry was last updated. | 1.3.6.1.4.1.4491.2.1.9.1.4.1.3 | DateAndTime | read-only | current |
| docsDiagLogDetailLastErrorText OBJECT-TYPE Contains the Event ID and Event Text of the event condition that triggers this entry. The format is: <Event ID> Event Text | 1.3.6.1.4.1.4491.2.1.9.1.4.1.4 | SnmpAdminString | read-only | current |
| docsDiagLogConformance OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.9.2 | |||
| docsDiagLogCompliances OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.9.2.1 | |||
| docsDiagLogGroups OBJECT-IDENTITY | 1.3.6.1.4.1.4491.2.1.9.2.2 |
Notifications
| Name | OID | Status |
|---|---|---|
| docsDiagLogSizeHighThrshldReached NOTIFICATION-TYPE This notification indicates that the current size of Diagnostic Log grows beyond docsDiagLogNotifyLogSizeHighThrshld. | 1.3.6.1.4.1.4491.2.1.9.0.1 | current |
| docsDiagLogSizeLowThrshldReached NOTIFICATION-TYPE This notification indicates that the current size of Diagnostic Log drops to docsDiagLogNotifyLogSizeLowThrshld after it exceeded docsDiagLogNotifyLogSizeHighThrshld earlier. | 1.3.6.1.4.1.4491.2.1.9.0.2 | current |
| docsDiagLogSizeFull NOTIFICATION-TYPE This notification indicates that the Diagnostic Log is full. | 1.3.6.1.4.1.4491.2.1.9.0.3 | current |
Conformance
| Name | OID | Status |
|---|---|---|
| docsDiagLogCompliance MODULE-COMPLIANCE The compliance statement for the diagnostic log MIB for DOCSIS compliant Cable Modem Termination Systems | 1.3.6.1.4.1.4491.2.1.9.2.1.1 | current |
| docsDiagLogBaseGroup OBJECT-GROUP CMTS is required to support objects in this group | 1.3.6.1.4.1.4491.2.1.9.2.2.1 | current |
| docsDiagLogNotificationGroup NOTIFICATION-GROUP CMTS is required to support objects in this group | 1.3.6.1.4.1.4491.2.1.9.2.2.2 | current |