BAS-ALIAS-DOCS-IF-MIB

All MIBs › BAS-ALIAS-DOCS-IF-MIB

Organization: Broadband Access Systems

Last Updated: 1999-08-19

Category: DOCSIS and Cable

Description: Provides DOCSIS interface alias mapping objects for BAS CMTS to extend standard DOCS-IF-MIB entries.

Start monitoring vendor-neutral, standards-based MIB, any SNMPv3-capable network device (SNMP engine identity/boot/clock status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

What Is BAS-ALIAS-DOCS-IF-MIB?

BAS-ALIAS-DOCS-IF-MIB is a Broadband Access Systems (cable industry) module extending the standard DOCSIS interface MIB with alias and QoS profile mapping for CMTS radio-frequency interfaces. It exposes a QoS service-profile table covering bandwidth limits, priority, baseline privacy enablement, and the chassis/slot location where a profile applies. Monitoring this data covers configuration/performance state: per-profile maximum and guaranteed upstream/downstream bandwidth, burst size, privacy settings, and profile activation status, which together explain how cable subscriber service tiers are provisioned and enforced. It explicitly extends the standard DOCS-IF-MIB used for DOCSIS-compliant RF interfaces. It is deployed on cable head-end CMTS chassis in cable broadband access networks. Engineers can download the BAS-ALIAS-DOCS-IF-MIB file directly to load it into their MIB browser.

IPNetwork Monitor allows you to monitor SNMP objects defined in BAS-ALIAS-DOCS-IF-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.

Supported Devices

DOCSIS CMTS (Cable Modem Termination System)
cable modems (indirectly, via the RF interfaces they attach to)

Monitoring Examples

An operator queries basDocsIfQosProfileTable/basDocsIfQosProfileEntry indexed by basDocsIfQosProfIndex to inspect basDocsIfQosProfMaxUpBandwidth and basDocsIfQosProfGuarUpBandwidth for a given service tier, cross-referencing basDocsIfQosProfChassis and basDocsIfQosProfSlot to locate the CMTS card. A profile whose basDocsIfQosProfStatus is inactive or whose bandwidth values are misconfigured would explain subscriber complaints of throttled upstream throughput.

What Can Be Monitored

QoS profile upstream/downstream bandwidth limits
guaranteed bandwidth
max burst size
baseline privacy setting
profile status
chassis/slot location

Imported Objects

From BAS-MIB

BasChassisId
BasInterfaceId
BasLogicalPortId
BasSlotId
basAliasDocsIf	OBJECT-IDENTITY

From IF-MIB

ifIndex

OBJECT-TYPE

From SNMPv2-CONF

MODULE-COMPLIANCE
OBJECT-GROUP

From SNMPv2-SMI

Counter32
Integer32
IpAddress
MODULE-IDENTITY
OBJECT-TYPE
TimeTicks
Unsigned32
transmission

From SNMPv2-TC

MacAddress
RowStatus
TEXTUAL-CONVENTION
TimeInterval
TimeStamp
TruthValue

How to Use in IPNetwork Monitor

Example using basDocsIfCmtsCmStatusUnerroreds OID:

Select a Broadband Access Systems (BAS) CMT (legacy) as the target host to create a monitor — the SNMP service should be up and running on it. Click New Monitor, then check SNMP Custom on the Favorites tab, click Next, and confirm the host. On the next page, click Select... to open the built-in SNMP MIB Browser and type basDocsIfCmtsCmStatusUnerroreds into the Find box to locate it in the OID tree, selecting the specific row/instance you want to monitor since this is a table column, then select it and click OK. Codewords received without error from this Cable Modem. On the monitor's Main parameters page you can set the target's SNMP port (default 161), credentials, polling interval, and other settings — see the SNMP Monitor help for details. On the State conditions and Alerting tabs, configure when the monitor should change state and trigger an alert; since this is a Counter32-type OID, Value bounds is the most useful condition here — trigger an alert if the counter increases sharply between polls relative to its normal baseline, since an unexpected spike often reflects a real change in traffic or activity. Click Finish to create the monitor; you can adjust any parameter later.

OIDs

OID symbolic	OID numeric	Type	Access	Description
basAliasDocsIfMib	1.3.6.1.4.1.3493.2.7.8.1			This is the MIB Module for MCNS/DOCSIS compliant Radio Frequency (RF) interfaces in Cable Modems (CM) and Cable Modem Termination Systems (CMTS).
basDocsIfBaseObjects	1.3.6.1.4.1.3493.2.7.8.1.1.1
basDocsIfCmObjects	1.3.6.1.4.1.3493.2.7.8.1.1.2
BAS basDocsIfCmtsCmChassis	1.3.6.1.4.1.3493.2.7.8.1.1.3.7.1.3	BasChassisId	not-accessible	The BAS Chassis ID of this card.
NUM basDocsIfCmtsCmIf	1.3.6.1.4.1.3493.2.7.8.1.1.3.7.1.5	BasInterfaceId	not-accessible	The BAS interface ID of this card.
BAS basDocsIfCmtsCmLPort	1.3.6.1.4.1.3493.2.7.8.1.1.3.7.1.6	BasLogicalPortId	not-accessible	The BAS logical port ID of this card.
MAC basDocsIfCmtsCmMac	1.3.6.1.4.1.3493.2.7.8.1.1.3.7.1.1	MacAddress	not-accessible	The RF side MAC address for the referenced CM. (E.g. the interface on the CM that has docsCableMacLayer(127) as its ifType.
I32 basDocsIfCmtsCmPtr	1.3.6.1.4.1.3493.2.7.8.1.1.3.7.1.2	Integer32	read-only	An row index into docsIfCmtsCmStatusTable. When queried with the correct instance value (e.g. a CM's MAC address), returns the index in docsIfCmtsCmStatusTable which represents that CM.
BAS basDocsIfCmtsCmSlot	1.3.6.1.4.1.3493.2.7.8.1.1.3.7.1.4	BasSlotId	not-accessible	The BAS Slot ID of this card.
BAS basDocsIfCmtsCmStatusChassis	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.15	BasChassisId	not-accessible	The BAS Chassis ID of this card.
C32 basDocsIfCmtsCmStatusCorrecteds	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.11	Counter32	read-only	Codewords received with correctable errors from this Cable Modem.
NUM basDocsIfCmtsCmStatusDownChannelIfIndex	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.4	InterfaceIndexOrZero	read-only	IfIndex of the downstream channel this CM is connected to. If the downstream channel is unknown, this object returns a value of zero.
basDocsIfCmtsCmStatusEntry	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1		not-accessible	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.
OCT basDocsIfCmtsCmStatusEqualizationData	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.8	OCTET STRING	read-only	Equalization data for this CM. Returns an empty string if the value is unknown or if there is no equalization data available or defined.
NUM basDocsIfCmtsCmStatusIf	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.17	BasInterfaceId	not-accessible	The BAS interface ID of this card.
I32 basDocsIfCmtsCmStatusIndex	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.1	Integer32	not-accessible	Index value to uniquely identify an entry in this table. For an individual Cable Modem, this index value should not change during CMTS uptime.
IP basDocsIfCmtsCmStatusIpAddress	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.3	IpAddress	read-only	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 Cable interface.
BAS basDocsIfCmtsCmStatusLPort	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.18	BasLogicalPortId	not-accessible	The BAS logical port ID of this card.
MAC basDocsIfCmtsCmStatusMacAddress	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.2	MacAddress	read-only	MAC address of this Cable Modem. If the Cable Modem has multiple MAC addresses, this is the MAC address associated with the Cable interface.
I32 basDocsIfCmtsCmStatusMicroreflections	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.14	Integer32	read-only	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 should give a rough indication of microreflections received on this interface. It is up to the implementor to provide information as accurate as possible.
TEN basDocsIfCmtsCmStatusRxPower	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.6	TenthdBmV	read-only	The receive power as percieved for upstream data from this Cable Modem. If the receive power is unknown, this object returns a value of zero.
TEN basDocsIfCmtsCmStatusSignalNoise	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.13	TenthdB	read-only	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.
BAS basDocsIfCmtsCmStatusSlot	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.16	BasSlotId	not-accessible	The BAS Slot ID of this card.
basDocsIfCmtsCmStatusTable	1.3.6.1.4.1.3493.2.7.8.1.1.3.3		not-accessible	A set of objects in the CMTS, maintained for each Cable Modem connected to this CMTS.
U32 basDocsIfCmtsCmStatusTimingOffset	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.7	Unsigned32	read-only	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.
C32 basDocsIfCmtsCmStatusUncorrectables	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.12	Counter32	read-only	Codewords received with uncorrectable errors from this Cable Modem.
C32 basDocsIfCmtsCmStatusUnerroredsEx	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.10	Counter32	read-only	Codewords received without error from this Cable Modem.
NUM basDocsIfCmtsCmStatusUpChannelIfIndex	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.5	InterfaceIndexOrZero	read-write	IfIndex of the upstream channel this CM is connected to. If the upstream channel is unknown, this object returns a value of zero.
INT basDocsIfCmtsCmStatusValue	1.3.6.1.4.1.3493.2.7.8.1.1.3.3.1.9	INTEGER	read-only	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 received an Initial Ranging Request message from the CM, and the ranging process is not yet complete. rangingAborted(3) The CMTS has sent a Ranging Abort message to the CM. rangingComplete(4) The CMTS has sent a Ranging Complete message to the CM. ipComplete(5) The CMTS has received a DHCP reply message and forwarded it to the CM. registrationComplete(6) The CMTS has sent a Registration Response mesage to the CM. accessDenied(7) The CMTS has sent a Registration Aborted message to the CM. The CMTS only needs to report states it is able to detect.
basDocsIfCmtsMacToCmEntry	1.3.6.1.4.1.3493.2.7.8.1.1.3.7.1		not-accessible	A row in the docsIfCmtsMacToCmTable. An entry in this table exists for each Cable Modem that is connected to the CMTS implementing this table.
basDocsIfCmtsMacToCmTable	1.3.6.1.4.1.3493.2.7.8.1.1.3.7		not-accessible	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 docsIfCmtsCmStatusTable (which corresponds to the CM's RF interface MAC address), and should not iterate (e.g. GetNext through) this table.
basDocsIfCmtsObjects	1.3.6.1.4.1.3493.2.7.8.1.1.3
BAS basDocsIfCmtsQosProfileChassis	1.3.6.1.4.1.3493.2.7.8.1.1.3.6.1.7	BasChassisId	not-accessible	The BAS Chassis ID of this card.
basDocsIfCmtsQosProfileEntry	1.3.6.1.4.1.3493.2.7.8.1.1.3.6.1		not-accessible
NUM basDocsIfCmtsQosProfileIf	1.3.6.1.4.1.3493.2.7.8.1.1.3.6.1.9	BasInterfaceId	not-accessible	The BAS interface ID of this card.
BAS basDocsIfCmtsQosProfileLPort	1.3.6.1.4.1.3493.2.7.8.1.1.3.6.1.10	BasLogicalPortId	not-accessible	The BAS logical port ID of this card.
BIT basDocsIfCmtsQosProfilePermissions	1.3.6.1.4.1.3493.2.7.8.1.1.3.6.1.6	Bits	read-write	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 if entries can be created based on information in REG-REQ MAC messages received from Cable Modems. Information in this object is only applicable if docsIfQosProfileTable is implemented as read-create. Otherwise, this object is implemented as read-only and returns CreateByModems(2). Either CreateByManagement(0) or CreateByModems(1) must be set when writing to this object.
BAS basDocsIfCmtsQosProfileSlot	1.3.6.1.4.1.3493.2.7.8.1.1.3.6.1.8	BasSlotId	not-accessible	The BAS Slot ID of this card.
basDocsIfCmtsQosProfileTable	1.3.6.1.4.1.3493.2.7.8.1.1.3.6		not-accessible	Provides modulation profile information for this CMTS.
basDocsIfMibObjects	1.3.6.1.4.1.3493.2.7.8.1.1
T/F basDocsIfQosProfBaselinePrivacy	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.7	TruthValue	read-create	Indicates whether Baseline Privacy is enabled for this service class. MUST NOT be changed while this row is active.
BAS basDocsIfQosProfChassis	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.9	BasChassisId	not-accessible	The BAS Chassis ID of this card.
I32 basDocsIfQosProfGuarUpBandwidth	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.4	Integer32	read-create	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.
NUM basDocsIfQosProfIf	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.11	BasInterfaceId	not-accessible	The BAS interface ID of this card.
basDocsIfQosProfileEntry	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1		not-accessible	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, entries are created based on information in REG-REQ MAC messages received from Cable Modems (Cable Modem Termination System implementation), or based on information extracted from the TFTP option file (Cable Modem implementation). In the Cable Modem Termination system, read-only entries are removed if no longer referenced by docsIfCmtsServiceTable. An entry in this table must not be removed while it is referenced by an entry in docsIfCmServiceTable (Cable Modem) or docsIfCmtsServiceTable (Cable Modem Termination System). An entry in this table should not be changeable while it is referenced by an entry in docsIfCmtsServiceTable. If this table is created automatically, there should only be a single entry for each Class of Service. Multiple entries with the same Class of Service parameters are not recommended.
basDocsIfQosProfileTable	1.3.6.1.4.1.3493.2.7.8.1.1.1.3		not-accessible	Describes the attributes for each class of service.
I32 basDocsIfQosProfIndex	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.1	Integer32	not-accessible	The index value which uniquely identifies an entry in the docsIfQosProfileTable.
BAS basDocsIfQosProfLPort	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.12	BasLogicalPortId	not-accessible	The BAS logical port ID of this card.
I32 basDocsIfQosProfMaxDownBandwidth	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.5	Integer32	read-create	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.
I32 basDocsIfQosProfMaxTxBurst	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.6	Integer32	read-create	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.
I32 basDocsIfQosProfMaxUpBandwidth	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.3	Integer32	read-create	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.
I32 basDocsIfQosProfPriority	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.2	Integer32	read-create	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.
BAS basDocsIfQosProfSlot	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.10	BasSlotId	not-accessible	The BAS Slot ID of this card.
ROW basDocsIfQosProfStatus	1.3.6.1.4.1.3493.2.7.8.1.1.1.3.1.8	RowStatus	read-create	This is object is to used to create or delete rows in this table. This object MUST NOT be changed from active while the row is referenced by the any entry in either docsIfCmServiceTable (on the CM), or the docsIfCmtsServiceTable (on the CMTS).

RFC description

DOCSIS Cable modem RF interface management for Cable Modems and Cable Modem Termination Systems in broadband access systems.

Start monitoring Broadband Access Systems (BAS) CMTS (legacy) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.

Download BAS-ALIAS-DOCS-IF-MIB