DOCS-IF-MIB Download

docsIfDownstreamChannelTable

This table describes the attributes of downstream channels (frequency bands).

docsIfDownstreamChannelEntry

An entry provides a list of attributes for a single downstream channel. An entry in this table exists for each ifEntry with an ifType of docsCableDownstream(128).

docsIfDownChannelId

The Cable Modem Termination System identification of the downstream channel within this particular MAC interface. if the interface is down, the object returns the most current value. If the downstream channel ID is unknown, this object returns a value of ...

docsIfDownChannelFrequency

The center of the downstream frequency associated with this channel. This object will return the current tuner frequency. If a CMTS provides IF output, this object will return 0, unless this CMTS is in control of the final downstream frequency. See the ...

docsIfDownChannelWidth

The bandwidth of this downstream channel. Most implementations are expected to support a channel width of 6 MHz (North America) and/or 8 MHz (Europe). See the associated compliance object for a description of the valid channel widths for this object.

docsIfDownChannelModulation

The modulation type associated with this downstream channel. If the interface is down, this object either returns the configured value (CMTS), the most current value (CM), or the value of unknown(1). See the associated conformance object for write condi ...

docsIfDownChannelInterleave

The Forward Error Correction (FEC) interleaving used for this downstream channel. Values are defined as follows: taps8Increment16(3): protection 5.9/4.1 usec, latency .22/.15 msec taps16Increment8(4): protection 12/8.2 usec, latency .48/.33 msec taps3 ...

docsIfDownChannelPower

At the CMTS, the operational transmit power. At the CM, the received power level. If the interface is down, this object either returns the configured value (CMTS), the most current value (CM) or the value of 0. See the associated conformance object for ...

docsIfDownChannelAnnex

The value of this object indicates the conformance of the implementation to important regional cable standards. annexA : Annex A from ITU-T J.83 is used. (equivalent to EN 300 429) annexB : Annex B from ITU-T J.83 is used. annexC : Annex C from ITU-T J.83 ...

docsIfDownChannelStorageType

The storage type for this conceptual row. Entries with this object set to permanent(4) do not require write operations for read-write objects.

docsIfUpstreamChannelTable

This table describes the attributes of attached upstream channels.

docsIfUpstreamChannelEntry

List of attributes for a single upstream channel. For DOCSIS 2.0 CMTSs, an entry in this table exists for each ifEntry with an ifType of docsCableUpstreamChannel (205). For DOCSIS 1.x CM/CMTSs and DOCSIS 2.0 CMs, an entry in this table exists for each if ...

docsIfUpChannelId

The CMTS identification of the upstream channel.

docsIfUpChannelFrequency

The center of the frequency band associated with this upstream interface. This object returns 0 if the frequency is undefined or unknown. Minimum permitted upstream frequency is 5,000,000 Hz for current technology. See the associated conformance object ...

docsIfUpChannelWidth

The bandwidth of this upstream interface. This object returns 0 if the interface width is undefined or unknown. Minimum permitted interface width is currently 200,000 Hz. See the associated conformance object for write conditions and limitations.

docsIfUpChannelModulationProfile

An entry identical to the docsIfModIndex in the docsIfCmtsModulationTable that describes this channel. This channel is further instantiated there by a grouping of interval usage codes (IUCs) that, together, fully describe the channel modulation. This obj ...

docsIfUpChannelSlotSize

Applicable to TDMA and ATDMA channel types only. The number of 6.25 microsecond ticks in each upstream mini-slot. Returns zero if the value is undefined or unknown or in case of an SCDMA channel. See the associated conformance object for write conditions ...

docsIfUpChannelTxTimingOffset

At the CM, a measure of the current round trip time obtained from the ranging offset (initial ranging offset + ranging offset adjustments). At the CMTS, the maximum of timing offset, among all the CMs that are/were present on the channel, taking into acco ...

docsIfUpChannelRangingBackoffStart

The initial random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. See the associated conformance object for write condition ...

docsIfUpChannelRangingBackoffEnd

The final random backoff window to use when retrying Ranging Requests. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. See the associated conformance object for write conditions ...

docsIfUpChannelTxBackoffStart

The initial random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. See the associated conformance object for write conditions a ...

docsIfUpChannelTxBackoffEnd

The final random backoff window to use when retrying transmissions. Expressed as a power of 2. A value of 16 at the CMTS indicates that a proprietary adaptive retry mechanism is to be used. See the associated conformance object for write conditions and ...

docsIfUpChannelScdmaActiveCodes

Applicable for SCDMA channel types only. Number of active codes. Returns zero for Non-SCDMA channel types. Note that legal values from 64..128 MUST be non-prime.

docsIfUpChannelScdmaCodesPerSlot

Applicable for SCDMA channel types only. The number of SCDMA codes per mini-slot. Returns zero if the value is undefined or unknown or in case of a TDMA or ATDMA channel.

docsIfUpChannelScdmaFrameSize

Applicable for SCDMA channel types only. SCDMA Frame size in units of spreading intervals. This value returns zero for non-SCDMA Profiles.

docsIfUpChannelScdmaHoppingSeed

Applicable for SCDMA channel types only. 15-bit seed used for code hopping sequence initialization. Returns zero for non-SCDMA channel types. Setting this value to a value different than zero for non-SCDMA channel types returns the error 'wrongValue'.

docsIfUpChannelType

Reflects the Upstream channel type. This object returns the value of docsIfCmtsModChannelType for the modulation profile selected in docsIfUpChannelModulationProfile for this row.

docsIfUpChannelCloneFrom

This object contains the ifIndex value of the physical interface row entry whose parameters are to be adjusted. Upon setting this object to the ifIndex value of a physical interface, the following interface objects values are copied to this entry: docsIfU ...

docsIfUpChannelUpdate

Used to perform the copy of adjusted parameters from the temporary interface entry to the physical interface indicated by the docsIfUpChannelCloneFrom object. The transfer is initiated through an SNMP SET to 'true' of this object. A SET to 'true' fails a ...

docsIfUpChannelStatus

This object is only used for the creation of a temporary upstream row with the purpose of updating the parameters of a physical upstream channel entry. The following restrictions apply to this object: 1. This object is not writable for physical interfaces ...

docsIfUpChannelPreEqEnable

At the CMTS, this object is used to enable or disable pre-equalization on the upstream channel represented by this table instance. At the CM, this object is read-only and reflects the status of pre-equalization as represented in the RNG-RSP. Pre-equaliz ...

docsIfQosProfileTable

Describes the attributes for each class of service.

docsIfQosProfileEntry

Describes the attributes for a single class of service. If implemented as read-create in the Cable Modem Termination System, creation of entries in this table is controlled by the value of docsIfCmtsQosProfilePermissions. If implemented as read-only, entr ...

docsIfQosProfIndex

The index value that uniquely identifies an entry in the docsIfQosProfileTable.

docsIfQosProfPriority

A relative priority assigned to this service when allocating bandwidth. Zero indicates lowest priority and seven indicates highest priority. Interpretation of priority is device-specific. MUST NOT be changed while this row is active.

docsIfQosProfMaxUpBandwidth

The maximum upstream bandwidth, in bits per second, allowed for a service with this service class. Zero if there is no restriction of upstream bandwidth. MUST NOT be changed while this row is active.

docsIfQosProfGuarUpBandwidth

Minimum guaranteed upstream bandwidth, in bits per second, allowed for a service with this service class. MUST NOT be changed while this row is active.

docsIfQosProfMaxDownBandwidth

The maximum downstream bandwidth, in bits per second, allowed for a service with this service class. Zero if there is no restriction of downstream bandwidth. MUST NOT be changed while this row is active.

docsIfQosProfMaxTxBurst

The maximum number of mini-slots that may be requested for a single upstream transmission. A value of zero means there is no limit. MUST NOT be changed while this row is active. This object has been deprecated and replaced by docsIfQosProfMaxTransmitBurst ...

docsIfQosProfBaselinePrivacy

Indicates whether Baseline Privacy is enabled for this service class. MUST NOT be changed while this row is active.

docsIfQosProfStatus

This is object is used to create or delete rows in this table. This object MUST NOT be changed from active while the row is referenced by any entry in either docsIfCmServiceTable (on the CM) or docsIfCmtsServiceTable (on the CMTS).

docsIfQosProfMaxTransmitBurst

The maximum number of bytes that may be requested for a single upstream transmission. A value of zero means there is no limit. Note: This value does not include any physical layer overhead. MUST NOT be changed while this row is active.

docsIfQosProfStorageType

The storage type for this conceptual row. Entries with this object set to permanent(4) do not require write operations for writable objects.

docsIfSignalQualityTable

At the CM, describes the PHY signal quality of downstream channels. At the CMTS, this object describes the PHY signal quality of upstream channels. At the CMTS, this table MAY exclude contention intervals.

docsIfSignalQualityEntry

At the CM, this object describes the PHY characteristics of a downstream channel. At the CMTS, it describes the PHY signal quality of an upstream channel. An entry in this table exists for each ifEntry with an ifType of docsCableDownstream(128) for Cable ...

docsIfSigQIncludesContention

true(1) if this CMTS includes contention intervals in the counters in this table. Always false(2) for CMs.

docsIfSigQUnerroreds

Codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other ...

docsIfSigQCorrecteds

Codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system, a ...

docsIfSigQUncorrectables

Codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device. Discontinuities in the value of this counter can occur at reinitialization of the managed system, ...

docsIfSigQSignalNoise

Signal/Noise ratio as perceived for this channel. At the CM, this object describes the Signal/Noise of the downstream channel. At the CMTS, it describes the average Signal/Noise of the upstream channel.

docsIfSigQMicroreflections

Microreflections, including in-channel response as perceived on this interface, measured in dBc below the signal level. This object is not assumed to return an absolutely accurate value, but it gives a rough indication of microreflections received on this ...

docsIfSigQEqualizationData

At the CM, this object returns the equalization data for the downstream channel. At the CMTS, this object is not applicable and is not instantiated. Note that previous CMTS implementations may instantiate this object in two ways: - An equalization value ...

docsIfSigQExtUnerroreds

Codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device. This is the 64-bit version of docsIfSigQUnerroreds. Discontinuities in the value of this counter can occur at ...

docsIfSigQExtCorrecteds

Codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device. This is the 64-bit version of docsIfSigQCorrecteds. Discontinuities in the value of this counter ca ...

docsIfSigQExtUncorrectables

Codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device. This is the 64-bit version of docsIfSigQUncorrectables. Discontinuities in the value of this coun ...

docsIfDocsisBaseCapability

Indication of the DOCSIS capability of the device.

docsIfCmMacTable

Describes the attributes of each CM MAC interface, extending the information available from ifEntry.

docsIfCmMacEntry

An entry containing objects describing attributes of each MAC entry, extending the information in ifEntry. An entry in this table exists for each ifEntry with an ifType of docsCableMaclayer(127).

docsIfCmCmtsAddress

Identifies the CMTS that is believed to control this MAC domain. At the CM, this will be the source address from SYNC, MAP, and other MAC-layer messages. If the CMTS is unknown, returns 00-00-00-00-00-00.

docsIfCmCapabilities

Identifies the capabilities of the MAC implementation at this interface. Note that packet transmission is always supported. Therefore, there is no specific bit required to explicitly indicate this capability. Note that BITS objects are encoded most sign ...

docsIfCmRangingRespTimeout

Waiting time for a Ranging Response packet. This object has been obsoleted and replaced by docsIfCmRangingTimeout to correct the typing to TimeInterval.

docsIfCmRangingTimeout

Waiting time for a Ranging Response packet. This object MUST NOT persist at reinitialization of the managed system.

docsIfCmStatusTable

This table maintains a number of status objects and counters for Cable Modems.

docsIfCmStatusEntry

A set of status objects and counters for a single MAC layer instance in Cable Modem. An entry in this table exists for each ifEntry with an ifType of docsCableMaclayer(127).

docsIfCmStatusValue

Current Cable Modem connectivity state, as specified in the RF Interface Specification. Interpretations for state values 1-12 are clearly outlined in the SP-RFI reference given below. The state value accessDenied(13) indicates the CMTS has sent a Registr ...

docsIfCmStatusCode

Status code for a Cable Modem as defined in the OSSI Specification. The status code consists of a single character indicating error groups, followed by a two- or three-digit number indicating the status condition, followed by a decimal. An example of a r ...

docsIfCmStatusTxPower

The operational transmit power for the attached upstream channel.

docsIfCmStatusResets

Number of times the CM reset or initialized this interface. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifI ...

docsIfCmStatusLostSyncs

Number of times the CM lost synchronization with the downstream channel. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the a ...

docsIfCmStatusInvalidMaps

Number of times the CM received invalid MAP messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex.

docsIfCmStatusInvalidUcds

Number of times the CM received invalid UCD messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex.

docsIfCmStatusInvalidRangingResponses

Number of times the CM received invalid ranging response messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associa ...

docsIfCmStatusInvalidRegistrationResponses

Number of times the CM received invalid registration response messages. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the as ...

docsIfCmStatusT1Timeouts

Number of times counter T1 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex.

docsIfCmStatusT2Timeouts

Number of times counter T2 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex.

docsIfCmStatusT3Timeouts

Number of times counter T3 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex.

docsIfCmStatusT4Timeouts

Number of times counter T4 expired in the CM. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex.

docsIfCmStatusRangingAborteds

Number of times the ranging process was aborted by the CMTS. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated if ...

docsIfCmStatusDocsisOperMode

Indication of whether the device has registered using 1.0 Class of Service or 1.1 Quality of Service. An unregistered CM SHOULD indicate 'docsis11' for a docsIfDocsisBaseCapability value of DOCSIS 1.1/2.0. An unregistered CM SHOULD indicate 'docsis10' f ...

docsIfCmStatusModulationType

Indicates modulation type status currently used by the CM. Since this object specifically identifies PHY mode, the shared upstream channel type is not permitted.

docsIfCmStatusEqualizationData

Pre-equalization data for this CM after convolution with data indicated in the RNG-RSP. This data is valid when docsIfUpChannelPreEqEnable is set to true.

docsIfCmStatusUCCs

The number of successful Upstream Channel Change transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ...

docsIfCmStatusUCCFails

The number of failed Upstream Channel Change transactions. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIn ...

docsIfCmServiceTable

Describes the attributes of each upstream service queue on a CM.

docsIfCmServiceEntry

Describes the attributes of an upstream bandwidth service queue. An entry in this table exists for each Service ID. The primary index is an ifIndex with an ifType of docsCableMaclayer(127).

docsIfCmServiceId

Identifies a service queue for upstream bandwidth. The attributes of this service queue are shared between the CM and the CMTS. The CMTS allocates upstream bandwidth to this service queue based on requests from the CM and on the class of service associa ...

docsIfCmServiceQosProfile

The index in docsIfQosProfileTable describing the quality of service attributes associated with this particular service. If no associated entry in docsIfQosProfileTable exists, this object returns a value of zero.

docsIfCmServiceTxSlotsImmed

The number of upstream mini-slots that have been used to transmit data PDUs in immediate (contention) mode. This includes only those PDUs that are presumed to have arrived at the head-end (i.e., those that were explicitly acknowledged). It does not incl ...

docsIfCmServiceTxSlotsDed

The number of upstream mini-slots that have been used to transmit data PDUs in dedicated mode (i.e., as a result of a unicast Data Grant). Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times ...

docsIfCmServiceTxRetries

The number of attempts to transmit data PDUs containing requests for acknowledgment that did not result in acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by ...

docsIfCmServiceTxExceededs

The number of data PDU transmission failures due to excessive retries without acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscon ...

docsIfCmServiceRqRetries

The number of attempts to transmit bandwidth requests that did not result in acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscont ...

docsIfCmServiceRqExceededs

The number of requests for bandwidth that failed due to excessive retries without acknowledgment. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDi ...

docsIfCmServiceExtTxSlotsImmed

The number of upstream mini-slots that have been used to transmit data PDUs in immediate (contention) mode. This includes only those PDUs that are presumed to have arrived at the head-end (i.e., those that were explicitly acknowledged). It does not incl ...

docsIfCmServiceExtTxSlotsDed

The number of upstream mini-slots that have been used to transmit data PDUs in dedicated mode (i.e., as a result of a unicast Data Grant). Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times ...

docsIfCmtsMacTable

Describes the attributes of each CMTS MAC interface, extending the information available from ifEntry. Mandatory for all CMTS devices.

docsIfCmtsMacEntry

An entry containing objects describing attributes of each MAC entry, extending the information in ifEntry. An entry in this table exists for each ifEntry with an ifType of docsCableMaclayer(127).

docsIfCmtsCapabilities

Identifies the capabilities of the CMTS MAC implementation at this interface. Note that packet transmission is always supported. Therefore, there is no specific bit required to explicitly indicate this capability. Note that BITS objects are encoded most ...

docsIfCmtsSyncInterval

The interval between CMTS transmission of successive SYNC messages at this interface.

docsIfCmtsUcdInterval

The interval between CMTS transmission of successive Upstream Channel Descriptor messages for each upstream channel at this interface.

docsIfCmtsMaxServiceIds

The maximum number of service IDs that may be simultaneously active.

docsIfCmtsInsertionInterval

The amount of time to elapse between each broadcast initial maintenance grant. Broadcast initial maintenance grants are used to allow new cable modems to join the network. Zero indicates that a vendor-specific algorithm is used instead of a fixed time. ...

docsIfCmtsInvitedRangingAttempts

The maximum number of attempts to make on invitations for ranging requests. A value of zero means the system SHOULD attempt to range forever.

docsIfCmtsInsertInterval

The amount of time to elapse between each broadcast initial maintenance grant. Broadcast initial maintenance grants are used to allow new cable modems to join the network. Zero indicates that a vendor-specific algorithm is used instead of a fixed time. ...

docsIfCmtsMacStorageType

The storage type for this conceptual row. Entries with this object set to permanent(4) do not require write operations for read-write objects.

docsIfCmtsStatusTable

For the MAC layer, this group maintains a number of status objects and counters.

docsIfCmtsStatusEntry

Status entry for a single MAC layer. An entry in this table exists for each ifEntry with an ifType of docsCableMaclayer(127).

docsIfCmtsStatusInvalidRangeReqs

This object counts invalid RNG-REQ messages received on this interface. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the as ...

docsIfCmtsStatusRangingAborteds

This object counts ranging attempts that were explicitly aborted by the CMTS. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for ...

docsIfCmtsStatusInvalidRegReqs

This object counts invalid REG-REQ messages received on this interface; that is, syntax, out of range parameters, or erroneous requests. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times a ...

docsIfCmtsStatusFailedRegReqs

This object counts failed registration attempts. Included are docsIfCmtsStatusInvalidRegReqs, authentication, and class of service failures. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other ti ...

docsIfCmtsStatusInvalidDataReqs

This object counts invalid data request messages received on this interface. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for t ...

docsIfCmtsStatusT5Timeouts

This object counts the number of times counter T5 expired on this interface. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for t ...

docsIfCmtsCmStatusTable

A set of objects in the CMTS, maintained for each cable modem connected to this CMTS.

docsIfCmtsCmStatusEntry

Status information for a single cable modem. An entry in this table exists for each cable modem that is connected to the CMTS implementing this table.

docsIfCmtsCmStatusIndex

Index value to uniquely identify an entry in this table. For an individual cable modem, this index value SHOULD NOT change during CMTS uptime.

docsIfCmtsCmStatusMacAddress

MAC address of the cable modem. If the cable modem has multiple MAC addresses, this is the MAC address associated with the Cable interface.

docsIfCmtsCmStatusIpAddress

IP address of this cable modem. If the cable modem has no IP address assigned, or the IP address is unknown, this object returns a value of 0.0.0.0. If the cable modem has multiple IP addresses, this object returns the IP address associated with the Cab ...

docsIfCmtsCmStatusDownChannelIfIndex

IfIndex of the downstream channel that this CM is connected to. If the downstream channel is unknown, this object returns a value of zero.

docsIfCmtsCmStatusUpChannelIfIndex

For DOCSIS 2.0, indicates the ifIndex of the logical upstream channel (ifType 205) this CM is connected to. For DOCSIS 1.x, indicates the ifIndex of the upstream channel (ifType 129) this CM is connected to. If the upstream channel is unknown, this object ...

docsIfCmtsCmStatusRxPower

The receive power as perceived for upstream data from this cable modem. If the receive power is unknown, this object returns a value of zero.

docsIfCmtsCmStatusTimingOffset

A measure of the current round trip time for this CM. Used for timing of CM upstream transmissions to ensure synchronized arrivals at the CMTS. Units are in terms of (6.25 microseconds/64). Returns zero if the value is unknown. For channels requiring fi ...

docsIfCmtsCmStatusEqualizationData

Equalization data for this CM, as measured by the CMTS. Returns the zero-length OCTET STRING if the value is unknown or if there is no equalization data available or defined.

docsIfCmtsCmStatusValue

Current cable modem connectivity state, as specified in the RF Interface Specification. Returned status information is the CM status, as assumed by the CMTS, and indicates the following events: other(1) Any state other than below. ranging(2) The CMTS has ...

docsIfCmtsCmStatusUnerroreds

Codewords received without error from this cable modem. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex ...

docsIfCmtsCmStatusCorrecteds

Codewords received with correctable errors from this cable modem. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associat ...

docsIfCmtsCmStatusUncorrectables

Codewords received with uncorrectable errors from this cable modem. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associ ...

docsIfCmtsCmStatusSignalNoise

Signal/Noise ratio as perceived for upstream data from this cable modem. If the Signal/Noise is unknown, this object returns a value of zero.

docsIfCmtsCmStatusMicroreflections

Total microreflections, including in-channel response as perceived on this interface, measured in dBc below the signal level. This object is not assumed to return an absolutely accurate value, but it gives a rough indication of microreflections received o ...

docsIfCmtsCmStatusExtUnerroreds

Codewords received without error from this cable modem. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associated ifIndex ...

docsIfCmtsCmStatusExtCorrecteds

Codewords received with correctable errors from this cable modem. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associat ...

docsIfCmtsCmStatusExtUncorrectables

Codewords received with uncorrectable errors from this cable modem. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the associ ...

docsIfCmtsCmStatusDocsisRegMode

Indication of whether the CM has registered using 1.0 Class of Service or 1.1 Quality of Service.

docsIfCmtsCmStatusModulationType

Indicates modulation type currently used by the CM. Since this object specifically identifies PHY mode, the shared type is not permitted. If the upstream channel is unknown, this object returns a value of zero.

docsIfCmtsCmStatusInetAddressType

The type of internet address of docsIfCmtsCmStatusInetAddress. If the cable modem internet address is unassigned or unknown, then the value of this object is unknown(0).

docsIfCmtsCmStatusInetAddress

Internet address of this cable modem. If the Cable Modem has no Internet address assigned, or the Internet address is unknown, the value of this object is the zero-length OCTET STRING. If the cable modem has multiple Internet addresses, this object retu ...

docsIfCmtsCmStatusValueLastUpdate

The value of sysUpTime when docsIfCmtsCmStatusValue was last updated.

docsIfCmtsCmStatusHighResolutionTimingOffset

A measure of the current round trip time for this CM. Used for timing of CM upstream transmissions to ensure synchronized arrivals at the CMTS. Units are in terms of (6.25 microseconds/(64*256)). Returns zero if the value is unknown. This is the high re ...

docsIfCmtsServiceTable

Describes the attributes of upstream service queues in a Cable Modem Termination System.

docsIfCmtsServiceEntry

Describes the attributes of a single upstream bandwidth service queue. Entries in this table exist for each ifEntry with an ifType of docsCableMaclayer(127), and for each service queue (Service ID) within this MAC layer. Entries in this table are created ...

docsIfCmtsServiceId

Identifies a service queue for upstream bandwidth. The attributes of this service queue are shared between the Cable Modem and the Cable Modem Termination System. The CMTS allocates upstream bandwidth to this service queue based on requests from the CM a ...

docsIfCmtsServiceCmStatusIndex

Pointer to an entry in docsIfCmtsCmStatusTable identifying the cable modem using this Service Queue. If multiple cable modems are using this Service Queue, the value of this object is zero. This object has been deprecated and replaced by docsIfCmtsServic ...

docsIfCmtsServiceAdminStatus

Allows a service class for a particular modem to be suppressed, (re-)enabled, or deleted altogether.

docsIfCmtsServiceQosProfile

The index in docsIfQosProfileTable describing the quality of service attributes associated with this particular service. If no associated docsIfQosProfileTable entry exists, this object returns a value of zero.

docsIfCmtsServiceCreateTime

The value of sysUpTime when this entry was created.

docsIfCmtsServiceInOctets

The cumulative number of Packet Data octets received on this Service ID. The count does not include the size of the Cable MAC header. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as ...

docsIfCmtsServiceInPackets

The cumulative number of Packet Data packets received on this Service ID. Discontinuities in the value of this counter can occur at reinitialization of the managed system, and at other times as indicated by the value of ifCounterDiscontinuityTime for the ...

docsIfCmtsServiceNewCmStatusIndex

Pointer (via docsIfCmtsCmStatusIndex) to an entry in docsIfCmtsCmStatusTable identifying the cable modem using this Service Queue. If multiple cable modems are using this Service Queue, the value of this object is zero.

docsIfCmtsModulationTable

Describes a modulation profile associated with one or more upstream channels.

docsIfCmtsModulationEntry

Describes a modulation profile for an Interval Usage Code for one or more upstream channels. Entries in this table are created by the operator. Initial default entries MAY be created at system initialization time, which could report a value of 'permanent' ...

docsIfCmtsModIndex

An index into the Channel Modulation table representing a group of Interval Usage Codes, all associated with the same channel.

docsIfCmtsModIntervalUsageCode

An index into the Channel Modulation table that, when grouped with other Interval Usage Codes, fully instantiates all modulation sets for a given upstream channel.

docsIfCmtsModControl

Controls and reflects the status of rows in this table. There is no restriction on the changing of values in this table while their associated rows are active, with the exception of: 1. If a modulation profile is being referenced by one or more upstream c ...

docsIfCmtsModType

The modulation type used on this channel. Returns other(1) if the modulation type is not qpsk, qam16, qam8, qam32, qam64, or qam128. Type qam128 is used for SCDMA channels only. See the reference for the modulation profiles implied by different modulatio ...

docsIfCmtsModPreambleLen

The preamble length for this modulation profile in bits. Default value is the minimum needed by the implementation at the CMTS for the given modulation profile.

docsIfCmtsModDifferentialEncoding

Specifies whether or not differential encoding is used on this channel.

docsIfCmtsModFECErrorCorrection

The number of correctable errored bytes (t) used in forward error correction code. The value of 0 indicates that no correction is employed. The number of check bytes appended will be twice this value.

docsIfCmtsModFECCodewordLength

The number of data bytes (k) in the forward error correction codeword. This object is not used if docsIfCmtsModFECErrorCorrection is zero.

docsIfCmtsModScramblerSeed

The 15-bit seed value for the scrambler polynomial.

docsIfCmtsModMaxBurstSize

The maximum number of mini-slots that can be transmitted during this channel's burst time. Returns zero if the burst length is bounded by the allocation MAP rather than by this profile. Default value is 0, except for shortData, where it is 8.

docsIfCmtsModGuardTimeSize

The number of symbol-times that MUST follow the end of this channel's burst. Default value is the minimum time needed by the implementation for this modulation profile.

docsIfCmtsModLastCodewordShortened

Indicates whether the last FEC codeword is truncated.

docsIfCmtsModScrambler

Indicates whether the scrambler is employed.

docsIfCmtsModByteInterleaverDepth

ATDMA Byte Interleaver Depth (Ir). This object returns 1 for non-ATDMA profiles.

docsIfCmtsModByteInterleaverBlockSize

ATDMA Byte Interleaver Block size (Br). This object returns zero for non-ATDMA profiles

docsIfCmtsModPreambleType

Preamble type for DOCSIS 2.0 bursts. The value 'unknown(0)' represents a row entry consisting only of DOCSIS 1.x bursts

docsIfCmtsModTcmErrorCorrectionOn

Trellis Code Modulation (TCM) On/Off. This value returns false for non-S-CDMA profiles.

docsIfCmtsModScdmaInterleaverStepSize

S-CDMA Interleaver step size. This value returns zero for non-S-CDMA profiles.

docsIfCmtsModScdmaSpreaderEnable

S-CDMA spreader. This value returns false for non-S-CDMA profiles. Default value for IUC 3 and 4 is OFF; for all other IUCs it is ON.

docsIfCmtsModScdmaSubframeCodes

S-CDMA sub-frame size. This value returns zero for non-S-CDMA profiles.

docsIfCmtsModChannelType

Describes the modulation channel type for this modulation entry. All the active entries in a modulation profile (that is all active entries that share a common docsIfCmtsModIndex) MUST have the same value of docsIfCmtsModChannelType.

docsIfCmtsModStorageType

The storage type for this conceptual row. Entries with this object set to permanent(4) do not require write operations for read-write objects.

docsIfCmtsQosProfilePermissions

This object specifies permitted methods of creating entries in docsIfQosProfileTable. createByManagement(0) is set if entries can be created using SNMP. updateByManagement(1) is set if updating entries using SNMP is permitted. createByModems(2) is set i ...

docsIfCmtsMacToCmTable

This is a table to provide a quick access index into the docsIfCmtsCmStatusTable. There is exactly one row in this table for each row in the docsIfCmtsCmStatusTable. In general, the management station SHOULD use this table only to get a pointer into the ...

docsIfCmtsMacToCmEntry

A row in the docsIfCmtsMacToCmTable. An entry in this table exists for each cable modem that is connected to the CMTS implementing this table.

docsIfCmtsCmMac

The RF side MAC address for the referenced CM (e.g., the interface on the CM that has docsCableMacLayer(127) as its ifType).

docsIfCmtsCmPtr

An row index into docsIfCmtsCmStatusTable. When queried with the correct instance value (e.g., a CM's MAC address), returns the index in docsIfCmtsCmStatusTable that represents that CM.

docsIfCmtsChannelUtilizationInterval

The time interval in seconds over which the channel utilization index is calculated. All upstream/downstream channels use the same docsIfCmtsChannelUtilizationInterval. Setting a value of zero disables utilization reporting. A channel utilization index i ...

docsIfCmtsChannelUtilizationTable

Reports utilization statistics for attached upstream and downstream physical channels.

docsIfCmtsChannelUtilizationEntry

Utilization statistics for a single upstream or downstream physical channel. An entry exists in this table for each ifEntry with an ifType equal to docsCableDownstream (128) or docsCableUpstream (129).

docsIfCmtsChannelUtIfType

The secondary index into this table. Indicates the IANA interface type associated with this physical channel. Only docsCableDownstream (128) and docsCableUpstream (129) are valid.

docsIfCmtsChannelUtId

The tertiary index into this table. Indicates the CMTS identifier for this physical channel.

docsIfCmtsChannelUtUtilization

The calculated and truncated utilization index for this physical upstream or downstream channel, accurate as of the most recent docsIfCmtsChannelUtilizationInterval. Upstream Channel Utilization Index: The upstream channel utilization index is expressed a ...

docsIfCmtsDownChannelCounterTable

This table is implemented at the CMTS to collect downstream channel statistics for utilization calculations.

docsIfCmtsDownChannelCounterEntry

An entry provides a list of traffic counters for a single downstream channel. An entry in this table exists for each ifEntry with an ifType of docsCableDownstream(128).

docsIfCmtsDownChnlCtrId

The Cable Modem Termination System identification of the downstream channel within this particular MAC interface. If the interface is down, the object returns the most current value. If the downstream channel ID is unknown, this object returns a value o ...

docsIfCmtsDownChnlCtrTotalBytes

At the CMTS, the total number of bytes in the Payload portion of MPEG Packets (i.e., not including MPEG header or pointer_field) transported by this downstream channel. This is the 32-bit version of docsIfCmtsDownChnlCtrExtTotalBytes, included to provide ...

docsIfCmtsDownChnlCtrUsedBytes

At the CMTS, the total number of DOCSIS data bytes transported by this downstream channel. The number of data bytes is defined as the total number of bytes transported in DOCSIS payloads minus the number of stuff bytes transported in DOCSIS payloads. This ...

docsIfCmtsDownChnlCtrExtTotalBytes

At the CMTS, the total number of bytes in the Payload portion of MPEG Packets (i.e., not including MPEG header or pointer_field) transported by this downstream channel. This is the 64-bit version of docsIfCmtsDownChnlCtrTotalBytes and will not be accessib ...

docsIfCmtsDownChnlCtrExtUsedBytes

At the CMTS, the total number of DOCSIS data bytes transported by this downstream channel. The number of data bytes is defined as the total number of bytes transported in DOCSIS payloads minus the number of stuff bytes transported in DOCSIS payloads. Thi ...

docsIfCmtsUpChannelCounterTable

This table is implemented at the CMTS to provide upstream channel statistics appropriate for channel utilization calculations.

docsIfCmtsUpChannelCounterEntry

List of traffic statistics for a single upstream channel. For DOCSIS 2.0 CMTSs, an entry in this table exists for each ifEntry with an ifType of docsCableUpstreamChannel (205). For DOCSIS 1.x CMTSs, an entry in this table exists for each ifEntry with an i ...

docsIfCmtsUpChnlCtrId

The CMTS identification of the upstream channel.

docsIfCmtsUpChnlCtrTotalMslots

Current count, from CMTS initialization, of all mini-slots defined for this upstream logical channel. This count includes all IUCs and SIDs, even those allocated to the NULL SID for a 2.0 logical channel that is inactive. This is the 32-bit version of d ...

docsIfCmtsUpChnlCtrUcastGrantedMslots

Current count, from CMTS initialization, of unicast granted mini-slots on the upstream logical channel, regardless of burst type. Unicast granted mini-slots are those in which the CMTS assigned bandwidth to any unicast SID on the logical channel. Howeve ...

docsIfCmtsUpChnlCtrTotalCntnMslots

Current count, from CMTS initialization, of contention mini-slots defined for this upstream logical channel. This count includes all mini-slots assigned to a broadcast or multicast SID on the logical channel. This is the 32-bit version of docsIfCmtsUpCh ...

docsIfCmtsUpChnlCtrUsedCntnMslots

Current count, from CMTS initialization, of contention mini-slots utilized on the upstream logical channel. For contention regions, utilized mini-slots are those in which the CMTS correctly received an upstream burst from any CM on the upstream logical c ...

docsIfCmtsUpChnlCtrExtTotalMslots

Current count, from CMTS initialization, of all mini-slots defined for this upstream logical channel. This count includes all IUCs and SIDs, even those allocated to the NULL SID for a 2.0 logical channel that is inactive. This is the 64-bit version of d ...

docsIfCmtsUpChnlCtrExtUcastGrantedMslots

Current count, from CMTS initialization, of unicast granted mini-slots on the upstream logical channel, regardless of burst type. Unicast granted mini-slots are those in which the CMTS assigned bandwidth to any unicast SID on the logical channel. Howeve ...

docsIfCmtsUpChnlCtrExtTotalCntnMslots

Current count, from CMTS initialization, of contention mini-slots defined for this upstream logical channel. This count includes all mini-slots assigned to a broadcast or multicast SID on the logical channel. This is the 64-bit version of docsIfCmtsUpCh ...

docsIfCmtsUpChnlCtrExtUsedCntnMslots

Current count, from CMTS initialization, of contention mini-slots utilized on the upstream logical channel. For contention regions, utilized mini-slots are those in which the CMTS correctly received an upstream burst from any CM on the upstream logical c ...

docsIfCmtsUpChnlCtrCollCntnMslots

Current count, from CMTS initialization, of contention mini-slots subjected to collisions on the upstream logical channel. For contention regions, these are the mini-slots applicable to bursts that the CMTS detected but could not correctly receive. This ...

docsIfCmtsUpChnlCtrTotalCntnReqMslots

Current count, from CMTS initialization, of contention request mini-slots defined for this upstream logical channel. This count includes all mini-slots for IUC1 assigned to a broadcast or multicast SID on the logical channel. This is the 32-bit version ...

docsIfCmtsUpChnlCtrUsedCntnReqMslots

Current count, from CMTS initialization, of contention request mini-slots utilized on this upstream logical channel. This count includes all contention mini-slots for IUC1 applicable to bursts that the CMTS correctly received. This is the 32-bit version ...

docsIfCmtsUpChnlCtrCollCntnReqMslots

Current count, from CMTS initialization, of contention request mini-slots subjected to collisions on this upstream logical channel. This includes all contention mini-slots for IUC1 applicable to bursts that the CMTS detected but could not correctly recei ...

docsIfCmtsUpChnlCtrTotalCntnReqDataMslots

Current count, from CMTS initialization, of contention request data mini-slots defined for this upstream logical channel. This count includes all mini-slots for IUC2 assigned to a broadcast or multicast SID on the logical channel. This is the 32-bit ver ...

docsIfCmtsUpChnlCtrUsedCntnReqDataMslots

Current count, from CMTS initialization, of contention request data mini-slots utilized on this upstream logical channel. This includes all contention mini-slots for IUC2 applicable to bursts that the CMTS correctly received. This is the 32-bit version o ...

docsIfCmtsUpChnlCtrCollCntnReqDataMslots

Current count, from CMTS initialization, of contention request data mini-slots subjected to collisions on this upstream logical channel. This includes all contention mini-slots for IUC2 applicable to bursts that the CMTS detected, but could not correctly ...

docsIfCmtsUpChnlCtrTotalCntnInitMaintMslots

Current count, from CMTS initialization, of contention initial maintenance mini-slots defined for this upstream logical channel. This includes all mini-slots for IUC3 assigned to a broadcast or multicast SID on the logical channel. This is the 32-bit ve ...

docsIfCmtsUpChnlCtrUsedCntnInitMaintMslots

Current count, from CMTS initialization, of contention initial maintenance mini-slots utilized on this upstream logical channel. This includes all contention mini-slots for IUC3 applicable to bursts that the CMTS correctly received. This is the 32-bit v ...

docsIfCmtsUpChnlCtrCollCntnInitMaintMslots

Current count, from CMTS initialization, of contention initial maintenance mini-slots subjected to collisions on this upstream logical channel. This includes all contention mini-slots for IUC3 applicable to bursts that the CMTS detected, but could not co ...

docsIfCmtsUpChnlCtrExtCollCntnMslots

Current count, from CMTS initialization, of collision contention mini-slots on the upstream logical channel. For contention regions, these are the mini-slots applicable to bursts that the CMTS detected, but could not correctly receive. This is the 64-bit ...

docsIfCmtsUpChnlCtrExtTotalCntnReqMslots

Current count, from CMTS initialization, of contention request mini-slots defined for this upstream logical channel. This count includes all mini-slots for IUC1 assigned to a broadcast or multicast SID on the logical channel. This is the 64-bit version ...

docsIfCmtsUpChnlCtrExtUsedCntnReqMslots

Current count, from CMTS initialization, of contention request mini-slots utilized on this upstream logical channel. This count includes all contention mini-slots for IUC1 applicable to bursts that the CMTS correctly received. This is the 64-bit version ...

docsIfCmtsUpChnlCtrExtCollCntnReqMslots

Current count, from CMTS initialization, of contention request mini-slots subjected to collisions on this upstream logical channel. This includes all contention mini-slots for IUC1 applicable to bursts that the CMTS detected, but could not correctly rece ...

docsIfCmtsUpChnlCtrExtTotalCntnReqDataMslots

Current count, from CMTS initialization, of contention request data mini-slots defined for this upstream logical channel. This count includes all mini-slots for IUC2 assigned to a broadcast or multicast SID on the logical channel. This is the 64-bit ver ...

docsIfCmtsUpChnlCtrExtUsedCntnReqDataMslots

Current count, from CMTS initialization, of contention request data mini-slots utilized on this upstream logical channel. This includes all contention mini-slots for IUC2 applicable to bursts that the CMTS correctly received. This is the 64-bit version o ...

docsIfCmtsUpChnlCtrExtCollCntnReqDataMslots

Current count, from CMTS initialization, of contention request data mini-slots subjected to collisions on this upstream logical channel. This includes all contention mini-slots for IUC2 applicable to bursts that the CMTS detected, but could not correctly ...

docsIfCmtsUpChnlCtrExtTotalCntnInitMaintMslots

Current count, from CMTS initialization, of initial maintenance mini-slots defined for this upstream logical channel. This count includes all mini-slots for IUC3 assigned to a broadcast or multicast SID on the logical channel. This is the 64-bit version ...

docsIfCmtsUpChnlCtrExtUsedCntnInitMaintMslots

Current count, from CMTS initialization, of initial maintenance mini-slots utilized on this upstream logical channel. This includes all contention mini-slots for IUC3 applicable to bursts that the CMTS correctly received. This is the 64-bit version of do ...

docsIfCmtsUpChnlCtrExtCollCntnInitMaintMslots

Current count, from CMTS initialization, of contention initial maintenance mini-slots subjected to collisions on this upstream logical channel. This includes all contention mini-slots for IUC3 applicable to bursts that the CMTS detected, but could not co ...

docsIfBasicGroup

Group of objects implemented in both cable modems and cable modem termination systems.

docsIfCmGroup

Group of objects implemented in cable modems.

docsIfCmtsGroup

Group of objects implemented in Cable Modem Termination Systems.

docsIfObsoleteGroup

Group of objects obsoleted.

docsIfBasicGroupV2

Group of objects implemented in both cable modems and cable modem termination systems.

docsIfCmGroupV2

Group of objects implemented in cable modems.

docsIfCmtsGroupV2

Group of objects implemented in Cable Modem Termination Systems.