Table 1. Feature History
Feature Name
|
Release Information
|
Feature Description
|
New MIBs for OUDP doc leakage detection (DOCS-LEAK-DETECT)
|
Cisco IOS XE Dublin 17.12.1w
|
New MIB support helps to fetch the details of OUDP leak detect test sessions.
The following are the new MIBs supported:
-
docsLeakDetTestCapabilities
-
docsLeakDetTestSessionStatusTable
-
docsLeakDetTestSessionStatsTable
-
docsLeakDetTestChannelStatusTable
Supported MIB version: DOCS-LEAK-DETECT-MIB-2022-09-15.txt.
|
The OUDP leakage detection feature supports the following new DOCSIS leak detection MIBs.
-
docsLeakDetTestCapabilities
-
docsLeakDetTestSessionStatusTable
-
docsLeakDetTestSessionStatsTable
-
docsLeakDetTestChannelStatusTable
Supported MIB version: DOCS-LEAK-DETECT-MIB-2022-09-15.txt.
The following table indicates the object names and the corresponding OIDs for the DOCS-LEAK-DETECT MIB:
Table 2. DOCS-LEAK-DETECT
Object Name |
Corresponding MIB OID value |
docsLeakDetectMib
|
1.3.6.1.4.1.4491.2.1.37
|
docsLeakDetObjects
|
1.3.6.1.4.1.4491.2.1.37.1
|
docsLeakDetTestObjects
|
1.3.6.1.4.1.4491.2.1.37.1.1
|
docsLeakDetTestCapabilities
|
1.3.6.1.4.1.4491.2.1.37.1.1.1
|
docsLeakDetTestSupportsNumBurstsNotReceived |
1.3.6.1.4.1.4491.2.1.37.1.1.1.1 |
docsLeakDetTestSessionStatusTable |
1.3.6.1.4.1.4491.2.1.37.1.1.2 |
docsLeakDetTestSessionStatusEntry |
1.3.6.1.4.1.4491.2.1.37.1.1.2.1 |
docsLeakDetTestSessionStatusSessionType |
1.3.6.1.4.1.4491.2.1.37.1.1.2.1.2 |
docsLeakDetTestSessionStatusStatus |
1.3.6.1.4.1.4491.2.1.37.1.1.2.1.3 |
docsLeakDetTestSessionStatusStartTime |
1.3.6.1.4.1.4491.2.1.37.1.1.2.1.4 |
docsLeakDetTestSessionStatusStopTime |
1.3.6.1.4.1.4491.2.1.37.1.1.2.1.5 |
docsLeakDetTestSessionStatsTable |
1.3.6.1.4.1.4491.2.1.37.1.1.3 |
docsLeakDetTestSessionStatsEntry |
1.3.6.1.4.1.4491.2.1.37.1.1.3.1 |
docsLeakDetTestSessionStatsNumBurstsGranted |
1.3.6.1.4.1.4491.2.1.37.1.1.3.1.2 |
docsLeakDetTestSessionStatsNumBurstsNotReceived |
1.3.6.1.4.1.4491.2.1.37.1.1.3.1.3 |
docsLeakDetTestSessionStatsNumTestBytesReceived |
1.3.6.1.4.1.4491.2.1.37.1.1.3.1.4 |
docsLeakDetTestChannelStatusTable |
1.3.6.1.4.1.4491.2.1.37.1.1.4 |
docsLeakDetTestChannelStatusEntry |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1 |
docsLeakDetTestChannelStatusTestStartFreq |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.2 |
docsLeakDetTestChannelStatusTestEndFreq |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.3 |
docsLeakDetTestChannelStatusNumModemsCfg |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.4 |
docsLeakDetTestChannelStatusNumModemsActive |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.5 |
docsLeakDetTestChannelStatusFirstSubcarrierId |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.6 |
docsLeakDetTestChannelStatusLastSubcarrierId |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.7 |
docsLeakDetTestChannelStatusBurstIuc |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.8 |
docsLeakDetTestChannelStatusCurrCycleTime |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.9 |
docsLeakDetTestChannelStatusNumBurstPositions |
1.3.6.1.4.1.4491.2.1.37.1.1.4.1.10 |
Note
|
The docsLeakDetTestSessionStatusSessionId, docsLeakDetTestSessionStatsCmMacAddress, and docsLeakDetTestChannelStatusInterfaceName are indices and cannot be accessed.
|
Doc Leak Detection MIBs
docsLeakDetTestCapabilities
The docsLeakDetTestSupportsNumBurstsNotReceived MIB object provides a report on the number of leakage detection testing bursts that are not received. This attribute reports
the CCAP line card capability and has the following values:
-
True—Indicates that the test session reports a valid value for the count of leakage detection testing bursts it did not receive
during a leakage detection.
The system supports the reporting of a count for leakage detection testing bursts not received through the counter burst_no_energy_rx which is reported through CLI. Hence this object takes the value true indicating support.
The following output shows the details of the docsLeakDetTestSupportsNumBurstsNotReceived MIB object:
docsLeakDetTestSupportsNumBurstsNotReceived OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
::= { docsLeakDetTestCapabilities 1 }
The following output is a sample output of the docsLeakDetTestSupportsNumBurstsNotReceived:
router> getmany -v2c 8.17.1.1 private docsLeakDetTestSupportsNumBurstsNotReceived
docsLeakDetTestSupportsNumBurstsNotReceived.0 = true(1)
router> getmany -v2c 8.17.1.1 private 1.3.6.1.4.1.4491.2.1.37.1.1.1
docsLeakDetTestSupportsNumBurstsNotReceived.0 = true(1)
docsLeakDetTestSessionStatusTable
The docsLeakDetTestSessionStatusTable MIBs reports the status, start, and stop time of the leakage detection test session.
The Leakage Detection Test Session Status table reports the status of a specified leakage detection test session. Rows in
this table are created and maintained by the CCAP. Leakage Detection Test Session status is reported for all the session types.
The following output shows the details of the docsLeakDetTestSessionStatusTable MIB object:
docsLeakDetTestSessionStatusEntry ::= SEQUENCE {
docsLeakDetTestSessionStatusSessionId Unsigned32,
docsLeakDetTestSessionStatusSessionType INTEGER,
docsLeakDetTestSessionStatusStatus INTEGER,
docsLeakDetTestSessionStatusStartTime DateAndTime,
docsLeakDetTestSessionStatusStopTime DateAndTime
}
Verifying the Leakage Detection Test Session Status Configuration
The following is the show output for docsLeakDetTestSessionStatusTable:
router#show cable oudp session-id 90020 detail
Load for five secs: 6%/0%; one minute: 8%; five minutes: 8%
Time source is NTP, 08:34:11.241 EDT Tue Aug 1 2023
OUDP Test Session : 90020 (child)
Interface : Cable9/0/24 upstream 6
Status : ACTIVE
Start Time : 2023-08-01,08:33:15.0,-4:00
Stop Time : 2023-08-01,09:00:00.0,-4:00
Burst Duration : 6 (frames)
Burst Gap : 4 (frames)
Cycle Time : 100 (msec)
Reserved Probe Pct : 3
Probe in Burst Gap : Allowed
Actual SC Freq Start : 64900000 (Hz)
Actual SC Freq End : 66075000 (Hz)
Minislot Start : 61
Minislot End : 63
Microsec per frame : 510.000 (usec)
Burst Spacing : 5100.000 (usec)
The following is the CLI output of the docsLeakDetTestSessionStatusTable.
router > getmany -v2c 8.17.1.1 private 1.3.6.1.4.1.4491.2.1.37.1.1.2
docsLeakDetTestSessionStatusSessionType.10 = master(2)
docsLeakDetTestSessionStatusSessionType.30 = master(2)
docsLeakDetTestSessionStatusSessionType.40 = master(2)
docsLeakDetTestSessionStatusSessionType.90020 = component(1)
docsLeakDetTestSessionStatusSessionType.90021 = component(1)
docsLeakDetTestSessionStatusStatus.10 = active(1)
docsLeakDetTestSessionStatusStatus.30 = pending(0)
docsLeakDetTestSessionStatusStatus.40 = active(1)
docsLeakDetTestSessionStatusStatus.90020 = active(1)
docsLeakDetTestSessionStatusStatus.90021 = active(1)
docsLeakDetTestSessionStatusStartTime.10 = 2023-Aug-1,08:33:15.0,-4:0
docsLeakDetTestSessionStatusStartTime.30 = 2023-Aug-1,08:45:00.0,-4:0
docsLeakDetTestSessionStatusStartTime.40 = 2023-Aug-1,08:33:21.0,-4:0
docsLeakDetTestSessionStatusStartTime.90020 = 2023-Aug-1,08:33:15.0,-4:0
docsLeakDetTestSessionStatusStartTime.90021 = 2023-Aug-1,08:33:21.0,-4:0
docsLeakDetTestSessionStatusStopTime.10 = 2023-Aug-1,09:00:00.0,-4:0
docsLeakDetTestSessionStatusStopTime.30 = 2023-Aug-1,10:00:00.0,-4:0
docsLeakDetTestSessionStatusStopTime.40 =
docsLeakDetTestSessionStatusStopTime.90020 = 2023-Aug-1,09:00:00.0,-4:0
docsLeakDetTestSessionStatusStopTime.90021 =
docsLeakDetTestSessionStatsTable
The docsLeakDetTestSessionStatsTable MIB reports the number of bursts that are granted, received, and not received. Rows in this table are created and maintained
by the CCAP.
docsLeakDetTestSessionStatsEntry ::= SEQUENCE {
docsLeakDetTestSessionStatsCmMacAddress MacAddress,
docsLeakDetTestSessionStatsNumBurstsGranted Counter32,
docsLeakDetTestSessionStatsNumBurstsNotReceived Counter32,
docsLeakDetTestSessionStatsNumTestBytesReceived Counter64
{
Verifying the Leakage Detection Test Session Stats Configuration
To verify the configuration parameters for leakage detection test session stats, use the show cable oudp session-id 90003 cm-stats command as shown in the following example:
router#show cable oudp session-id 90003 cm-stats
Load for five secs: 5%/0%; one minute: 7%; five minutes: 8%
Time source is NTP, 02:41:50.594 EDT Fri Aug 4 2023
Child Session 90003, Cable9/0/24 upstream 6 - CM-List 3 modems
CM Mac-Address BurstPos Offset(us) Test Sid BurstGrants BurstNoEnergyRx BurstRx TestBytesRx
4800.33ef.094e 0 0 13 15114 0 15000 6135000
4800.33ef.092a 1 5100 14 15114 0 15000 6135000
4800.33ef.07e2 2 10200 15 15114 0 15000 6135000
The following is the output of the docsLeakDetTestSessionStatsTable MIB that reports the number of bursts that are granted, received, and not received.
router > getmany -v2c 8.17.1.1 private 1.3.6.1.4.1.4491.2.1.37.1.1.3
docsLeakDetTestSessionStatsNumBurstsGranted.90003.72.0.51.239.9.78 = 15414
docsLeakDetTestSessionStatsNumBurstsGranted.90003.72.0.51.239.9.42 = 15414
docsLeakDetTestSessionStatsNumBurstsGranted.90003.72.0.51.239.7.226 = 15414
docsLeakDetTestSessionStatsNumBurstsNotReceived.90003.72.0.51.239.9.78 = 0
docsLeakDetTestSessionStatsNumBurstsNotReceived.90003.72.0.51.239.9.42 = 0
docsLeakDetTestSessionStatsNumBurstsNotReceived.90003.72.0.51.239.7.226 = 0
docsLeakDetTestSessionStatsNumTestBytesReceived.90003.72.0.51.239.9.78 = 6257700
docsLeakDetTestSessionStatsNumTestBytesReceived.90003.72.0.51.239.9.42 = 6257700
docsLeakDetTestSessionStatsNumTestBytesReceived.90003.72.0.51.239.7.226 = 6257700
router >
Note
|
The CLI and MIB table values differ for active counters during execution and collection processes.
|
docsLeakDetTestChannelStatusTable
The docsLeakDetTestChannelStatusTable MIB reports the configuration of a specified upstream OFDMA channel that is used for leakage detection testing. Rows in this
table are created and maintained by the CCAP.
docsLeakDetTestChannelStatusEntry ::= SEQUENCE {
docsLeakDetTestChannelStatusInterfaceName SnmpAdminString,
docsLeakDetTestChannelStatusTestStartFreq Unsigned32,
docsLeakDetTestChannelStatusTestEndFreq Unsigned32,
docsLeakDetTestChannelStatusNumModemsCfg Unsigned32,
docsLeakDetTestChannelStatusNumModemsActive Unsigned32,
docsLeakDetTestChannelStatusFirstSubcarrierId Unsigned32,
docsLeakDetTestChannelStatusLastSubcarrierId Unsigned32,
docsLeakDetTestChannelStatusBurstIuc Unsigned32,
docsLeakDetTestChannelStatusCurrCycleTime Unsigned32,
docsLeakDetTestChannelStatusNumBurstPositions Unsigned32
}
Verifying the Leakage Detection Channel Session Status Configuration
To verify the configuration parameters for leakage detection channel status, use the show cable oudp-leak-detect session-id <> detail command as shown in the following example:
router#show cable oudp-leak-detect session-id <> detail
Load for five secs: 6%/0%; one minute: 8%; five minutes: 8%
Time source is NTP, 08:34:11.241 EDT Tue Aug 1 2023
OUDP Test Session : 90020 (child)
Interface : Cable9/0/24 upstream 6
Status : ACTIVE
Start Time : 2023-08-01,08:33:15.0,-4:00
Stop Time : 2023-08-01,09:00:00.0,-4:00
Burst Duration : 6 (frames)
Burst Gap : 4 (frames)
Cycle Time : 100 (msec)
Reserved Probe Pct : 3
Probe in Burst Gap : Allowed
Actual SC Freq Start : 64900000 (Hz)
Actual SC Freq End : 66075000 (Hz)
Minislot Start : 61
Minislot End : 63
Microsec per frame : 510.000 (usec)
Burst Spacing : 5100.000 (usec)
Test Session Type : CycleTime
Current Bursts per cycle : 2
Maximum Bursts per cycle : 19
Probe Oppty per cycle : 6 (frames)
Cycle Interval Info : 19 (bursts) / 196.07 (frames) / 100.000 (msec)
Child Session 90020, Cable9/0/24 upstream 6 - CM-List 2 modems
CM Mac-Address BurstPos Offset(us) Test Sid BurstGrants BurstNoEnergyRx BurstRx TestBytesRx
4800.33ef.07e2 0 0 27 612 0 372 106020
4800.33ef.094e 1 5100 28 612 0 372 106020
router#
The following is the CLI output of the docsLeakDetTestChannelStatusTable:
mcp-cab-002:/auto/tftpboot-pit/mibs/snmpr/bin/linux/17.1 > getmany -v2c 8.17.1.1 private 1.3.6.1.4.1.4491.2.1.37.1.1.4
docsLeakDetTestChannelStatusTestStartFreq.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 64900000
docsLeakDetTestChannelStatusTestStartFreq.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 61700000
docsLeakDetTestChannelStatusTestEndFreq.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 66075000
docsLeakDetTestChannelStatusTestEndFreq.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 63275000
docsLeakDetTestChannelStatusNumModemsCfg.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 2
docsLeakDetTestChannelStatusNumModemsCfg.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 3
docsLeakDetTestChannelStatusNumModemsActive.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 2
docsLeakDetTestChannelStatusNumModemsActive.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 3
docsLeakDetTestChannelStatusFirstSubcarrierId.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 61
docsLeakDetTestChannelStatusFirstSubcarrierId.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 53
docsLeakDetTestChannelStatusLastSubcarrierId.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 63
docsLeakDetTestChannelStatusLastSubcarrierId.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 56
docsLeakDetTestChannelStatusBurstIuc.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 13
docsLeakDetTestChannelStatusBurstIuc.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 13
docsLeakDetTestChannelStatusCurrCycleTime.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 100
docsLeakDetTestChannelStatusCurrCycleTime.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 20
docsLeakDetTestChannelStatusNumBurstPositions.90020.18.67.97.57.47.48.47.50.52.45.117.112.115.116.114.101.97.109.54 = 2
docsLeakDetTestChannelStatusNumBurstPositions.90021.18.67.97.57.47.48.47.51.48.45.117.112.115.116.114.101.97.109.54 = 3
The following are the input parameters for the docsLeakDetTestChannelStatusTable MIB:
The following are the output parameters for the docsLeakDetTestChannelStatusTable MIB.
Table 3. Output Parameters
Output Parameters
|
Description
|
docsLeakDetTestChannelStatusTestStartFreq
|
Value of the actual SC frequency start.
|
docsLeakDetTestChannelStatusTestEndFreq
|
Value of the actual SC frequency end.
|
docsLeakDetTestChannelStatusNumModemsCfg
|
Number of modems configured under the burst session.
|
docsLeakDetTestChannelStatusNumModemsActive
|
Number of modems on which the burst session is activated.
|
docsLeakDetTestChannelStatusFirstSubcarrierId
|
Lowest subcarrierId on the lowest edge of the first minislot that the CCAP has selected for testing of leakage.
|
docsLeakDetTestChannelStatusLastSubcarrierId
|
Highest subcarrierId on the highest edge of the last minislot that the CCAP has selected for testing of leakage.
|
docsLeakDetTestChannelStatusBurstIuc
|
The corresponding burstIuc that is used for leakage detection on the OFDMA channel.
|
docsLeakDetTestChannelStatusCurrCycleTime
|
If the cycle time is configured, observes the configured cycle time. If the cycle gap is configured, the estimated gap for
the session is observed and adjusts it to a whole number (for example, 7.830 will be rounded to 8).
|
docsLeakDetTestChannelStatusNumBurstPositions
|
If you configure the cycle time, the burst positions takes the maximum burst position for the cycle time and the current burst
position when configured with the cycle gap.
|