DOCS-DIAG-MIB

File: DOCS-DIAG-MIB.mib (25882 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
SNMP-FRAMEWORK-MIB DOCS-IF3-MIB DOCS-CABLE-DEVICE-MIB
CLAB-DEF-MIB

Imported symbols

NOTIFICATION-TYPE MODULE-IDENTITY OBJECT-TYPE
Unsigned32 Gauge32 Counter32
TruthValue MacAddress DateAndTime
TEXTUAL-CONVENTION OBJECT-GROUP MODULE-COMPLIANCE
NOTIFICATION-GROUP SnmpAdminString CmtsCmRegState
docsIf3CmtsCmRegStatusId docsDevEvLevel docsDevEvId
clabProjDocsis

Defined Types

TriggerFlag  
This type defines the Diagnostic Log Trigger Type. Bit 0 selects the registration trigger. Bit 1 selects the ranging retry trigger.
TEXTUAL-CONVENTION    
  BITS registration(0), rangingRetry(1)  

RegistrationDetailFlag  
This type defines a union of CM states or processes for operations related to the registration trigger. 'other' any state other than the following 'initialRanging' indicates the 'Initial Ranging' state 'rangingAutoAdjComplete' indicates the 'Ranging Auto Adjustment Complete' state 'startEae' indicates the 'Start EAE' state 'startDhcpv4' indicates the 'Start DHCPv4' state 'startDhcpv6' indicates the 'Start DHCPv6' state 'dhcpv4Complete' indicates the 'DHCPv4 Complete' state 'dhcpv6Complete' indicates the 'DHCPv6 Complete' state 'startConfigFileDownload' indicates the 'Start Config File Download' state 'configFileDownloadComplete' indicates the 'Config File Download Complete' state 'startRegistration' indicates the 'Start Registration' state 'registrationComplete' indicates the 'Registration Complete' state 'bpiInit' indicates the 'BPI Initialization' state 'operational' indicates the 'Operational' state.
TEXTUAL-CONVENTION    
  BITS other(0), initialRanging(1), rangingAutoAdjComplete(2), startEae(3), startDhcpv4(4), startDhcpv6(5), dhcpv4Complete(6), dhcpv6Complete(7), startConfigFileDownload(8), configFileDownloadComplete(9), startRegistration(10), registrationCmplete(11), bpiInit(12), operational(13)  

DocsDiagLogEntry  
SEQUENCE    
  docsDiagLogCmMacAddr MacAddress
  docsDiagLogLastUpdateTime DateAndTime
  docsDiagLogCreateTime DateAndTime
  docsDiagLogLastRegTime DateAndTime
  docsDiagLogRegCount Counter32
  docsDiagLogRangingRetryCount Counter32

DocsDiagLogDetailEntry  
SEQUENCE    
  docsDiagLogDetailTypeValue CmtsCmRegState
  docsDiagLogDetailCount Counter32
  docsDiagLogDetailLastUpdate DateAndTime
  docsDiagLogDetailLastErrorText SnmpAdminString

Defined Values

docsDiagMib 1.3.6.1.4.1.4491.2.1.9
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 diagnostictriggers. 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-2007 Cable Television Laboratories, Inc. All rights reserved.
MODULE-IDENTITY    

docsDiagLogNotifications 1.3.6.1.4.1.4491.2.1.9.0
OBJECT IDENTIFIER    

docsDiagLogMibObjects 1.3.6.1.4.1.4491.2.1.9.1
OBJECT IDENTIFIER    

docsDiagLogGlobal 1.3.6.1.4.1.4491.2.1.9.1.1
OBJECT IDENTIFIER    

docsDiagLogTriggersCfg 1.3.6.1.4.1.4491.2.1.9.1.2
OBJECT IDENTIFIER    

docsDiagLogMaxSize 1.3.6.1.4.1.4491.2.1.9.1.1.1
The maximum number of Cable Modem entries that docsDiagLogTable can report.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

docsDiagLogCurrentSize 1.3.6.1.4.1.4491.2.1.9.1.1.2
The total number of Cable Modem entries reported in the docsDiagLogTable. The maximum value possible will be docsDiagLogMaxSize.
OBJECT-TYPE    
  Gauge32 0..4294967295  

docsDiagLogNotifyLogSizeHighThrshld 1.3.6.1.4.1.4491.2.1.9.1.1.3
If the number of entries in docsDiagLogTable exceeds this value, CMTS will trigger the appropriate event.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

docsDiagLogNotifyLogSizeLowThrshld 1.3.6.1.4.1.4491.2.1.9.1.1.4
If the number of entries in docsDiagLogTable exceeded docsDiagLogNotifyLogSizeHighThrshld earlier and then drops to this value, CMTS will trigger the appropriate event.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

docsDiagLogAging 1.3.6.1.4.1.4491.2.1.9.1.1.5
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.
OBJECT-TYPE    
  Unsigned32 15..86400  

docsDiagLogResetAll 1.3.6.1.4.1.4491.2.1.9.1.1.6
If set to 'true', all counter objects for all entries in docsDiagLogTable and docsDiagLogDetailTable are reset to zero. Reading this object always returns 'false'.
OBJECT-TYPE    
  TruthValue  

docsDiagLogLastResetTime 1.3.6.1.4.1.4491.2.1.9.1.1.7
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.
OBJECT-TYPE    
  DateAndTime  

docsDiagLogClearAll 1.3.6.1.4.1.4491.2.1.9.1.1.8
If set to 'true', all entries from the docsDiagLogTable and docsDiagLogDetailTable are removed. Reading this object always returns 'false'.
OBJECT-TYPE    
  TruthValue  

docsDiagLogLastClearTime 1.3.6.1.4.1.4491.2.1.9.1.1.9
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.
OBJECT-TYPE    
  DateAndTime  

docsDiagLogNotifCtrl 1.3.6.1.4.1.4491.2.1.9.1.1.10
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.
OBJECT-TYPE    
  BITS highThresholdReached(0), lowThresholdReached(1), full(2)  

docsDiagLogIncludeTriggers 1.3.6.1.4.1.4491.2.1.9.1.2.1
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 correspon dingdiagnostic trigger. Setting a particular bit to '0' turns off corresponding diagnostic trigger.
OBJECT-TYPE    
  TriggerFlag  

docsDiagLogEnableAgingTriggers 1.3.6.1.4.1.4491.2.1.9.1.2.2
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.
OBJECT-TYPE    
  TriggerFlag  

docsDiagLogRegTimeInterval 1.3.6.1.4.1.4491.2.1.9.1.2.3
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.
OBJECT-TYPE    
  Unsigned32 60..86400  

docsDiagLogRegDetail 1.3.6.1.4.1.4491.2.1.9.1.2.4
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.
OBJECT-TYPE    
  RegistrationDetailFlag  

docsDiagLogRangingRetryType 1.3.6.1.4.1.4491.2.1.9.1.2.5
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.
OBJECT-TYPE    
  INTEGER consecutiveMiss(1), missRatio(2)  

docsDiagLogRangingRetryThrhld 1.3.6.1.4.1.4491.2.1.9.1.2.6
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.
OBJECT-TYPE    
  Unsigned32 3..12  

docsDiagLogRangingRetryStationMaintNum 1.3.6.1.4.1.4491.2.1.9.1.2.7
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.
OBJECT-TYPE    
  Unsigned32 60..65535  

docsDiagLogTable 1.3.6.1.4.1.4491.2.1.9.1.3
This table keeps the Diagnostic Log of the Cable Modems, it is indexed by docsIf3CmtsCmRegStatusId.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsDiagLogEntry

docsDiagLogEntry 1.3.6.1.4.1.4491.2.1.9.1.3.1
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.
OBJECT-TYPE    
  DocsDiagLogEntry  

docsDiagLogCmMacAddr 1.3.6.1.4.1.4491.2.1.9.1.3.1.1
MAC address of the Cable Modem.
OBJECT-TYPE    
  MacAddress  

docsDiagLogLastUpdateTime 1.3.6.1.4.1.4491.2.1.9.1.3.1.2
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.
OBJECT-TYPE    
  DateAndTime  

docsDiagLogCreateTime 1.3.6.1.4.1.4491.2.1.9.1.3.1.3
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.
OBJECT-TYPE    
  DateAndTime  

docsDiagLogLastRegTime 1.3.6.1.4.1.4491.2.1.9.1.3.1.4
The last time this Cable Modem registered.
OBJECT-TYPE    
  DateAndTime  

docsDiagLogRegCount 1.3.6.1.4.1.4491.2.1.9.1.3.1.5
The number of times the registration trigger condition was detected for this Cable Modem.
OBJECT-TYPE    
  Counter32  

docsDiagLogRangingRetryCount 1.3.6.1.4.1.4491.2.1.9.1.3.1.6
The number of times the ranging retry trigger condition was detected for this Cable Modem.
OBJECT-TYPE    
  Counter32  

docsDiagLogDetailTable 1.3.6.1.4.1.4491.2.1.9.1.4
This table contains detailed diagnostic information for Cable Modems already in docsDiagLogTable.
OBJECT-TYPE    
  SEQUENCE OF  
    DocsDiagLogDetailEntry

docsDiagLogDetailEntry 1.3.6.1.4.1.4491.2.1.9.1.4.1
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.
OBJECT-TYPE    
  DocsDiagLogDetailEntry  

docsDiagLogDetailTypeValue 1.3.6.1.4.1.4491.2.1.9.1.4.1.1
The diagnostic detail type this entry represents.
OBJECT-TYPE    
  CmtsCmRegState  

docsDiagLogDetailCount 1.3.6.1.4.1.4491.2.1.9.1.4.1.2
The counter value of this Cable Modem that reached this diagnostic detail state as the last state before it failed to proceed further.
OBJECT-TYPE    
  Counter32  

docsDiagLogDetailLastUpdate 1.3.6.1.4.1.4491.2.1.9.1.4.1.3
Time and date value when this entry was last updated.
OBJECT-TYPE    
  DateAndTime  

docsDiagLogDetailLastErrorText 1.3.6.1.4.1.4491.2.1.9.1.4.1.4
Contains the Event ID and Event Text of the event condition that triggers this entry. The format is: Event Text
OBJECT-TYPE    
  SnmpAdminString  

docsDiagLogSizeHighThrshldReached 1.3.6.1.4.1.4491.2.1.9.0.1
This notification indicates that the current size of Diagnostic Log grows beyond docsDiagLogNotifyLogSizeHighThrshld.
NOTIFICATION-TYPE    

docsDiagLogSizeLowThrshldReached 1.3.6.1.4.1.4491.2.1.9.0.2
This notification indicates that the current size of Diagnostic Log drops to docsDiagLogNotifyLogSizeLowThrshld after it exceeded docsDiagLogNotifyLogSizeHighThrshld earlier.
NOTIFICATION-TYPE    

docsDiagLogSizeFull 1.3.6.1.4.1.4491.2.1.9.0.3
This notification indicates that the Diagnostic Log is full.
NOTIFICATION-TYPE    

docsDiagLogConformance 1.3.6.1.4.1.4491.2.1.9.2
OBJECT IDENTIFIER    

docsDiagLogCompliances 1.3.6.1.4.1.4491.2.1.9.2.1
OBJECT IDENTIFIER    

docsDiagLogGroups 1.3.6.1.4.1.4491.2.1.9.2.2
OBJECT IDENTIFIER    

docsDiagLogCompliance 1.3.6.1.4.1.4491.2.1.9.2.1.1
The compliance statement for the diagnostic log MIB for DOCSIS compliant Cable Modem Termination Systems
MODULE-COMPLIANCE    

docsDiagLogBaseGroup 1.3.6.1.4.1.4491.2.1.9.2.2.1
CMTS is required to support objects in this group
OBJECT-GROUP    

docsDiagLogNotificationGroup 1.3.6.1.4.1.4491.2.1.9.2.2.2
CMTS is required to support objects in this group
NOTIFICATION-GROUP