Relationship Between MIB Objects and CLI Show Commands
This chapter shows the Management Information Base (MIB) files and their object identifiers (OIDs) that correspond to the fields that are displayed by the command-line interface (CLI) show commands. Because different subsystems process CLI and Simple Network Management Protocol (SNMP) commands, a slight variation should be expected between the counters returned by SNMP commands and those displayed by CLI commands.
Note Unless otherwise indicated, all SNMP counter objects are 32-bit counters. Also, all SNMP counters begin incrementing from zero when the CMTS router initially boots and continue incrementing until they wrap around to zero, or until the CMTS router is rebooted. For more information on the differences between CLI-based and SNMP-based counters, see the "SNMP-Based and CLI-Based Counters" section on page A-2.
Tip For the generic interface counters that are displayed by the show interface command, see the corresponding counters in the ifTable in IF-MIB.
The ccqmCmtsEnforceRuleTable in CISCO-CABLE-QOS-MONITOR-MIB contains objects that show the quality of service (QoS) enforce rules that are currently configured on the Cisco CMTS. Table B-1 lists the most commonly used objects in this table and the related show commands:
Table B-1 Quality of Service Enforce Rules (ccqmCmtsEnforceRuleTable)
Pointer into the docsIfQosProfileTable for the QoS profile to be used when a subscriber violates the bandwidth specified by their service level agreement (SLA) (0 to 16383).
Sample rate, in minutes, at which the CMTS should check a subscriber's bandwidth usage to determine whether the subscriber is overconsuming their allotted resources (10 to 120).
Indicates whether the enforced QoS profile should be automatically applied to subscribers who violate the maximum bandwidth limits during a sliding window monitoring period.
The ccqmEnfRuleViolateTable in CISCO-CABLE-QOS-MONITOR-MIB provides a snapshot of all subscribers who have violated their enforce rules. Table B-2 lists the most commonly used objects in this table and the related show commands.
Time stamp for when the subscriber was found to have violated the enforce rule. If the enforce rule automatically applies the enforced QoS profile, this time stamp also shows the time at which the enforced QoS profile was in effect.
Time stamp for when the original (registered) QoS profile is scheduled to be restored to this subscriber.
CISCO-DOCS-EXT-MIB
The cdxQosCtrlUpTable in CISCO-DOCS-EXT-MIB contains a number of QoS objects that the scheduler uses to control cable modem registration on each upstream interface. Table B-3 lists the most commonly used objects in this table and the related show commands:
Table B-3 Quality of Service Upstream Control Objects (cdxQosCtrlUpTable)
Maximum percentage of total upstream bandwidth that is allowed to be reserved for minimum guaranteed upstream scheduling service requests on this upstream (10 to 1000 percent), when admission control is enabled.
Total number of cable modem Registration Requests (REG-REQ) that the CMTS rejected on this upstream when admission control is enabled, because insufficient bandwidth was reserved.
Maximum virtual bandwidth of this capacity, in bits per second (bps), when admission control is enabled (0 to 102400000).
The cdxCmtsServiceExtTable in CISCO-DOCS-EXT-MIB extends the information about a service ID (SID) in docsIfCmtsServiceTable. Table B-4 lists the most commonly used objects in this table and the related show commands.
Table B-4 Service ID Information (cdxCmtsServiceExtTable)
show interface cable sid counter: Packets received
Total number of data packets that have been sent for this SID.
The cdxBWQueueTable in CISCO-DOCS-EXT-MIB displays the attributes for the QoS queues in a cable interface scheduler. Table B-5 lists the most commonly used objects in this table and the related show commands.
Table B-5 Quality of Service Queues (cdxBWQueueTable)
show interface cable upstream and show interface cable mac-scheduler: Queue...
Name code (type) for this queue:
•cirQ(1)
•tbeQ(2)
•p0BEGrantQ(3)
•p1BEGrantQ(4)
•p2BEGrantQ(5)
•p3BEGrantQ(6)
•p4BEGrantQ(7)
•p5BEGrantQ(8)
•p6BEGrantQ(9)
•p7BEGrantQ(10)
•rngPollQ(11).
cdxBWQueueOrder (1.3.6.1.4.1.9.9.116.1.2.1.1.2)
N/A
Relative priority of this queue with regard to the other queues on this particular cable interface (0 to 10, where 0 is the highest priority and 10 is the lowest priority).
show interface cable upstream and show interface cable mac-scheduler: Queue ...
Total number of requests or packets that this queue has discarded because the queue overflowed beyond the maximum specified by cdxBWQueueDepth.
The cdxCmCpeTable in CISCO-DOCS-EXT-MIB contains information about cable modems (CM) or customer premises equipments (CPE) devices. Table B-6 lists the most commonly used objects in this table and the related show commands.
Table B-6 Cable Modem and Customer Premises Equipment Information (cdxCmCpeTable)
Pointer into the docsIfCmtsCmStatusTable identifying the status of this cable modem or for the cable modem that is providing services for this CPE device (1 to 2147483647).
ASCII string that identifies the access group to be used to filter the upstream traffic for this cable modem or CPE device.
cdxCmCpeResetNow (1.3.6.1.4.1.9.9.116.1.3.1.1.8)
clear cable modem a.b.c.d
To reset the CM. There is no equivalent CLI for CPE.
Here a.b.c.d may be MAC address or IPV4 address or IPV6 address.
Set this object to true(1) to remove a cable modem from the CMTS Station Maintenance list and to force the cable modem to reset its cable interface. If the device is a CPE device, the CMTS removes it from its internal address tables.
cdxCmCpeDeleteNow 1.3.6.1.4.1.9.9.116.1.3.1.1.9
clear cable modem a.b.c.d
To delete CM.
clear cable host a.b.c.d
To delete CPE.
Here a.b.c.d may be MAC address or IPV4 address or IPV6 address.
Setting cdxCmCpeDeleteNow to true(1) deletes the CM/CPE. This object always returns false(2). If the value of cdxCmCpeType is cm(1), CMTS deletes CM from its interface.
If the value of cdxCmCpeType is cpe(2), CMTS deletes CPE from its associated CM.
The cdxCmtsCmStatusExtTable in CISCO-DOCS-EXT-MIB extends the CM status information in docsIfCmtsCmStatusTable. Table B-7 lists the most commonly used objects in this table and the related show commands:
Table B-7 Cable Modem Status Information (cdxCmtsCmStatusExtTable)
Number of times that this cable modem has changed from the offline state to the online state, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS.
Percentage of time, in hundredths of a percentage, that this cable modem has remained online, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS (0 to 10000).
Minimum period of time, in hundredths of a second, that this cable modem has remained online, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS.
Average period of time, in hundredths of a second, that this cable modem has remained online, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS.
Maximum period of time, in hundredths of a second, that this cable modem has remained online, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS.
Minimum period of time, in hundredths of a second, that this cable modem has remained offline, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS.
Average period of time, in hundredths of a second, that this cable modem has remained offline, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS.
Maximum period of time, in hundredths of a second, that this cable modem has remained offline, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS.
Number of times that this cable modem has changed from the offline state to the online state, from the time that the cable modem sent its first Ranging Request (RNG-REQ) message to the CMTS. This object is similar to cdxIfCmtsCmStatusOnlineTimes, but this object is reset to 0 whenever cdxIfCmtsCmStatusLastResetTime is changed.
Time stamp, in terms of sysUpTime, for the last time that the connectivity statistics for this cable modem had been reset.
The cdxIfUpstreamChannelExtTable in CISCO-DOCS-EXT-MIB extends docsIfUpstreamChannelEntry with additional objects that describe the upstream channels. Table B-8 lists the most commonly used objects in this table and the related show commands:
Table B-8 Upstream Channel Information (cdxIfUpstreamChannelExtTable)
show interface cable interface mac-scheduler upstream-port: Channel width on this upstream channel
Lower frequency, in Hz, for this bandwidth (0 to 16000000) of upstream channel . The docsIfUpChannelWidth specifies the higher frequency, and these two objects together specify the upstream channel width to be used for automated advanced spectrum management.
Average percentage of the upstream channel's utilization, calculated as the running average of the utilization in the MAC upstream scheduler (0 to 100) of the channel.
Average percentage of contention mini-slots on this upstream channel, calculated as the running average of contention mini-slots in the MAC upstream scheduler (0 to 100).
Average percentage of initial ranging mini-slots on this upstream channel, calculated as the running average of initial ranging mini-slots in the MAC upstream scheduler (0 to 100).
show interface cable upstream ugs statistics: UGS Allocation Statistics (avg)
Average number of unsolicited grant service (UGS) requests that were allocated on this upstream channel over the last five minutes.
CISCO-DOCS-REMOTE-QUERY
The cdrqCmtsCmStatusTable in CISCO-DOCS-REMOTE-QUERY-MIB contains the status of the cable modems that are polled by the remote-query feature. Table B-9 lists the most commonly used objects in this table and the related show commands:
Table B-9 Remote Query Information for Cable Modems (cdrqCmtsCmStatusTable)
show cable modem remote-query: Micro (dB) Reflection
Total microreflections, expressed as dBc below the signal level, as perceived by the CMTS, for the cable modem's downstream.This object is only a rough indication of microflections, including in-channel response, and not an absolute measurement.
Timestamp, in terms of sysUpTime, when this cable modem was last polled by the remote-query feature.
DOCS-IF-MIB
The docsIfSignalQualityTable in DOCS-IF-MIB contains upstream signal information for each ifEntry with an ifType of docsCableUpstreamChannel (205). Table B-10 lists the most commonly used objects in this table and the related show commands:
Table B-10 Upstream Signal Information (docsIfSignalQualityTable)
Rough indication of the total number of microreflections including in-channel response as perceived on this interface, measured in dBc below the signal level (0 to 255).
Equalization data for the downstream channel (CM) or upstream channel (CMTS).
The docsIfCmtsCmStatusTable in DOCS-IF-MIB contains the status information for each CM that is available in the CMTS. Table B-11 lists the most commonly used objects in this table and the related show commands:
Table B-11 Cable Modem Status Information (docsIfCmtsCmStatusTable)
IP address for the cable interface of the CM. This object is deprecated and replaced by docsIfCmtsCmStatusInetAddressType and docsIfCmtsCmStatusInetAddress, to enable migration to IPv6.
Number of codewords received without error from this CM. This object is the 32-bit version of docsIfCmtsCmStatusExtUnerroreds, which is a 64-bit counter.
Number of codewords received with correctable errors from this CM. This object is the 32-bit version of docsIfCmtsCmStatusExtCorrecteds, which is a 64-bit counter.
Number of codewords received with uncorrectable errors from this CM. This object is the 32-bit version of docsIfCmtsCmStatusExtUncorrectables, which is a 64-bit counter.
Rough indication of the total number of microreflections, including in-channel response, perceived for this CM, as measured in dBc below the signal level.
Number of codewords received with correctable errors from this CM. This object is the 64-bit version of docsIfCmtsCmStatusCorrecteds, which is a 32-bit counter.
Number of codewords received with uncorrectable errors from this CM. This object is the 64-bit version of docsIfCmtsCmStatusUncorrectables, which is a 32-bit counter.
Indicates the DOCSIS QoS revision level at which this CM is currently registered. This object replaces docsIfCmtsCmStatusDocsisMode from DOCS-IF-EXT-MIB.
Indicates the upstream PHY mode (TDMA, A-TDMA, S-CDMA) that the CM is registered for and currently using. (The mixed TDMA/A-TDMA mode is not supported here, because that describes the upstream interface and not the behavior of individual CMs.)
IP address for this CM cable interface of the CM. This object, together with docsIfCmtsCmStatusInetAddressType, replace docsIfCmtsCmStatusIpAddress.
The docsIfCmtsModulationTable in DOCS-IF-MIB describes an Interval Usage Code (IUC) for one or more upstream channel modulation profiles. Table B-12 lists the most commonly used objects in this table and the related show commands.
Type of IUC being defined: request(1), requestData(2), initialRanging(3), periodicRanging(4), shortData(5), longData(6), dvPhyShortData(9), advPhyLongData(10), and ugs(11).
docsIfCmtsModType (1.3.6.1.2.1.10.127.1.3.5.1.4)
show cable modulation-profile [verbose]: Type, Modulation
Modulation type for this burst profile: QPSK, 8-QAM, 16-QAM, 32-QAM, 64-QAM, and 128-QAM.
Modulation channel type for this burst profile, valid values are:
•tdma (1)
•atdma (2)
•scdma (3)
•tdmaAndAtdma (4)
DOCS-QOS-MIB
The docsQosPktTable in DOCS-QOS-MIB describes the packet classification configured on the Cisco CMTS router. Table B-13 lists the most commonly used objects in this table and the related show commands.
Indicates the low value of the range of 3-bit priority fields to be matched, for Ethernet frames with an EtherType of 0x8100 and an 802.1P/Q tag header (0 to 7).
Indicates the high value of the range of 3-bit priority fields to be matched, for Ethernet frames with an EtherType of 0x8100 and an 802.1P/Q tag header (0 to 7).
17-bit bitmask that indicates the parameter encodings that were actually present in the DOCSIS message that created the classifier, as opposed to parameters that were unspecified and left at their default values.
The docsQosParamSetTable in DOCS-QOS-MIB describes the DOCSIS 1.1 QoS parameters that are defined on the Cisco CMTS router. Table B-14 lists the most commonly used objects in this table and the related show commands.
Table B-14 DOCSIS 1.1 Quality of Service Parameters (docsQosParamSetTable)
show cable service-class verbose: Tolerated Grant Jitter
Maximum amount of time, in microseconds, that the transmission opportunities might be delayed from the regularly scheduled times for UGS and UGS-AD service flows.
Maximum latency, in microseconds, between the time the CMTS receives a packet on its network-side interface (NSI) and forwards it on the RF cable interface.
show cable service-class verbose: Request/Transmission Policy
show interface cable qos paramset verbose: Request/Transmission Policy
32-bit bitmask that specifies the transmit interval opportunities that the CM omits for upstream transmission requests and packet transmissions. This object replaces docsQosParamSetRequestPolicy.
show cable service-class verbose: Parameter Presence Bitfield
show interface cable qos paramset verbose: Parameter Presence Bitfield
Bitmask that indicates the set of parameters actually included in the DOCSIS registration or dynamic service request message that created the parameter set.
The docsQosServiceFlowIdTable in DOCS-QOS-MIB extends the information about a service ID (SID) in docsIfCmtsServiceTable. Table B-15 lists the most commonly used objects in this table and the related show commands.
Table B-15 Service ID Information (docsQosServiceFlowIdTable)
Indicates whether the service flow is the primary flow or a secondary flow.
The docsQosServiceFlowStatsTable in DOCS-QOS-MIB contains service flow statistics. Table B-16 lists the most commonly used objects in this table and the related show commands:
Table B-16 Service Flow Statistics (docsQosServiceFlowStatsTable)
show interface cable service-flow counters verbose: RateLimit Dropped Pkts
Number of packets sent using this service flow that were dropped due to a violation of the flow's policies, especially because they would have exceeded the maximum traffic rate.
show interface cable service-flow counters verbose: RateLimit Delayed Pkts
Number of packets sent using this service flow that were delayed because of the flow's policies, especially because they would have otherwise exceeded the maximum traffic rate.
The docsQosUpstreamStatsTable in DOCS-QOS-MIB provides upstream service flow statistics. Table B-17 lists the most commonly used objects in this table and the related show commands.
Table B-17 Upstream Service Flow Statistics (docsQosUpstreamStatsTable)
Object and OID
Equivalent Show Command and Field
Description
DOCS-QOS-MIB (docsQosMib)
docsQosSID (1.3.6.1.2.1.10.127.7.1.5.1.1)
show interface cable sid counters verbose: Sid
Service ID (SID) for an admitted or active upstream service flow (1 to 16383).
Number of concatenation headers received on an upstream service flow.
The docsQosServiceClassTable in DOCS-QOS-MIB describes the DOCSIS service classes on a CMTS. Table B-18 lists the most commonly used objects in this table and the related show commands.
Table B-18 DOCSIS Service Classes (docsQosServiceClassTable)
Maximum amount of time, in microseconds, that unicast request intervals can be delayed from the regularly scheduled times on an usptream service flow (docsQosParamSetTolPollJitter).
show cable service-classverbose: Tolerated Grant Jitter
Maximum amount of time, in microseconds, that the transmission opportunities might be delayed from the regularly scheduled times for UGS and UGS-AD service flows (docsQosParamSetTolGrantJitter).
Maximum latency, in microseconds, between the time the CMTS receives a packet on its network-side interface (NSI) and forwards it on the RF cable interface, for docsQosParamSetClassMaxLatency.
show interface cable qos paramset verbose: Active QoS Timeout
Maximum time, in seconds, that resources can remain unused while in the active state being being released (0 to 65535, 0 indicates no timeout), for docsQosServiceFlowActiveTimeout.
show interface cable qos paramset verbose: Admitted QoS Timeout
Maximum time, in seconds, that resources can remain in the admitted state before being released (0 to 65535, 0 indicates no timeout), for docsQosServiceFlowAdmittedTimeout.
show cable service-classverbose: Request/Transmission Policy
show interface cable qos paramset verbose: Request/Transmission Policy
32-bit bitmask that specifies the transmit interval opportunities that the CM omits for upstream transmission requests and packet transmissions, for docsQosServiceFlowRequestPolicy.
show cable service-class [verbose]: Dir, Direction
show interface cable qos paramset verbose: Direction
Direction for this service class template (upstream or downstream).
The docsQosPHSTable in DOCS-QOS-MIB describes the payload header suppression (PHS) rules that are configured on the Cisco CMTS router. Table B-19 lists the most commonly used objects in this table and the related show commands.
show interface cable service-flow phs verbose: PHSF
8-bit value that defines the header bytes that should be suppressed.
docsQosPHSMask (1.3.6.1.2.1.10.127.7.1.10.1.3)
show interface cable service-flow phs verbose: PHSM
5-bit PHS mask that defines the header bytes that should be suppressed.
docsQosPHSSize (1.3.6.1.2.1.10.127.7.1.10.1.4)
show interface cable service-flow phs verbose: PHSS
8-bit value specifying the number of header bytes to be suppressed.
docsQosPHSVerify (1.3.6.1.2.1.10.127.7.1.10.1.5)
show interface cable service-flow phs verbose: PHSV
Indicates whether PHS verification is enabled.
docsQosPHSIndex (1.3.6.1.2.1.10.127.7.1.10.1.7)
show interface cable service-flow phs verbose: PHSI
Index that uniquely references the PHS rule.
DOCS-SUBSCRIBER-MIB
The docsSubMgtPktFilterTable in DOCS-SUBSCRIBER-MIB is a generic packet filter table that is linked to specific cable modems through the linked by the docsSubMgtCmFilterTable. Table B-20 lists the most commonly used objects in this table and the related show commands.
Number of times this specific filter rule has been matched, which occurs only when all components of the filter are matched against a packet. If a packet might match multiple filters, this counter is incremented only on the first filter that is matched.
The docsSubMgtTcpUdpFilterTable in DOCS-SUBSCRIBER-MIB extends the docsSubMgtPktFilterTable to provide optional filtering based on elements in TCP or UDP headers. Table B-21 lists the most commonly used objects in this table and the related show commands:
Table B-21 TCP and UDP Header Filters (docsSubMgtTcpUdpFilterTable)
Object and OID
Equivalent Show Command and Field
Description
DOCS-SUBSCRIBER-MIB (docsSubMgt)
docsSubMgtTcpUdpSrcPort (1.3.6.1.3.83.4.1.7.1.1)
show cable filter [verbose]: SPort, TCP/UDP Source Port
Source TCP/UDP port to be matched (0 to 65536, here 65536 matches any value).
docsSubMgtTcpUdpDstPort (1.3.6.1.3.83.4.1.7.1.2)
show cable filter [verbose]: DPort, TCP/UDP Destination Port
Destination TCP/UDP port to be matched (0 to 65536, here 65536 matches any value).
docsSubMgtTcpFlagValues (1.3.6.1.3.83.4.1.7.1.3)
show cable filter [verbose]: TCP flags, TCP Flags (mask, value)
Bit-mask containing the TCP flag values to be matched, valid values are:
•urgent(0)
•ack(1)
•push(2)
•reset(3)
•syn(4)
•fin(5).
docsSubMgtTcpFlagMask (1.3.6.1.3.83.4.1.7.1.4)
show cable filter [verbose]: TCP flags, TCP Flags (mask, value)
Bit-mask containing mask for bits to be checked for matching, valid values are:
•urgent(0)
•ack(1)
•push(2)
•reset(3)
•syn(4)
•fin(5).
[an error occurred while processing this directive]
Feedback
Unless otherwise indicated, all SNMP counter objects are 32-bit counters. Also, all SNMP counters begin incrementing from zero when the CMTS router initially boots and continue incrementing until they wrap around to zero, or until the CMTS router is rebooted. For more information on the differences between CLI-based and SNMP-based counters, see the "SNMP-Based and CLI-Based Counters" section on page A-2.
