CABH-QOS2-MIB

All MIBs › CABH-QOS2-MIB

Organization: CableLabs Broadband Access Department

Last Updated: 2005-04-08

Category: DOCSIS and Cable, Quality of Service

Description: Extends CableHome QoS management with additional traffic prioritization and scheduling objects for residential gateways.

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 CABH-QOS2-MIB?

CABH-QOS2-MIB is the CableLabs standard MIB configuring QoS capabilities on CableHome-compliant residential gateways. Its objects cover a factory-reset action and timestamp, a per-interface attribute table (priority and queue counts), a policy-holder enable flag and admission-control setting with active-policy-holder count, and a detailed QoS policy table matching on application domain/name, service-provider domain/name, port domain/number, IP type/protocol, and source/destination IP/port. As a configuration MIB it lets an administrator audit which application traffic is receiving prioritized QoS treatment on a CableHome gateway. It is deployed on CableHome-compliant residential gateway devices. Engineers can download the CABH-QOS2-MIB file directly to load it into their MIB browser.

IPNetwork Monitor allows you to monitor SNMP objects defined in CABH-QOS2-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

CableHome-compliant residential gateway devices

Monitoring Examples

An administrator checks cabhQos2PolicyAppName and cabhQos2PolicySrcPort to confirm a specific application's traffic is correctly matched by a QoS policy rule on a CableHome gateway.

What Can Be Monitored

QoS policy rules and admission-control configuration

Imported Objects

From CLAB-DEF-MIB

clabProjCableHome

OBJECT-IDENTITY

From IF-MIB

ifIndex

OBJECT-TYPE

From INET-ADDRESS-MIB

InetAddress
InetAddressType
InetPortNumber

From SNMP-FRAMEWORK-MIB

SnmpAdminString

From SNMPv2-CONF

MODULE-COMPLIANCE
OBJECT-GROUP

From SNMPv2-SMI

Gauge32
MODULE-IDENTITY
OBJECT-TYPE
Unsigned32

From SNMPv2-TC

RowStatus
TimeStamp
TruthValue

How to Use in IPNetwork Monitor

Example using cabhQos2NumActivePolicyHolder OID:

Select a CableHome-compliant residential gateways (cable modem/router) 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 cabhQos2NumActivePolicyHolder into the Find box to locate it in the OID tree, then select it and click OK. Indicates the number of active policy holders the PS have discovered in the LAN. 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 Gauge32-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
cabhQos2Base	1.3.6.1.4.1.4491.2.4.8.1.1
cabhQos2ClassifierGroup	1.3.6.1.4.1.4491.2.4.8.2.2.2			Group of objects for cableHome QOS Packet classification.
cabhQos2Compliance	1.3.6.1.4.1.4491.2.4.8.2.1.1			The compliance statement for devices that implement CableHome QOS UPnP capabilities.
cabhQos2Compliances	1.3.6.1.4.1.4491.2.4.8.2.1
cabhQos2Conformance	1.3.6.1.4.1.4491.2.4.8.2
cabhQos2DeviceObjects	1.3.6.1.4.1.4491.2.4.8.1.4
cabhQos2Group	1.3.6.1.4.1.4491.2.4.8.2.2.1			Group of objects for CableHome QOS management.
cabhQos2Groups	1.3.6.1.4.1.4491.2.4.8.2.2
TIM cabhQos2LastSetToFactory	1.3.6.1.4.1.4491.2.4.8.1.1.2	TimeStamp	read-only	The value of sysUpTime when cabhQos2SetToFactory was last set to true. Zero if never reset.
cabhQos2Mib	1.3.6.1.4.1.4491.2.4.8			This MIB module supplies parameters for the configuration and monitoring of CableHome QoS capabilities.
cabhQos2Mib2Notifications	1.3.6.1.4.1.4491.2.4.8.0
cabhQos2MibObjects	1.3.6.1.4.1.4491.2.4.8.1
G32 cabhQos2NumActivePolicyHolderEx	1.3.6.1.4.1.4491.2.4.8.1.3.3	Gauge32	read-only	Indicates the number of active policy holders the PS have discovered in the LAN. This object includes the PS Policy Holder if active.
INT cabhQos2PolicyAdmissionControl	1.3.6.1.4.1.4491.2.4.8.1.3.2	INTEGER	read-write	Indicates if the QoS Policy Admission Control is enabled or disabled for all the traffic requests.
STR cabhQos2PolicyAppDomain	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.4	SnmpAdminString	read-create	Vendor domain name from the Vendor application name URN.
STR cabhQos2PolicyAppName	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.5	SnmpAdminString	read-create	Text description of the application.
IP cabhQos2PolicyDestIp	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.13	InetAddress	read-create	The IP address to match against the packet's source IP address. This may not be a DNS name, but may be an IPv4 or IPv6 prefix.
INE cabhQos2PolicyDestPort	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.15	InetPortNumber	read-create	The value that the layer-4 destination port number in the packet must have in order to match this policy entry.
cabhQos2PolicyEntry	1.3.6.1.4.1.4491.2.4.8.1.3.4.1		not-accessible	The indices for these entries.
T/F cabhQos2PolicyHolderEnabled	1.3.6.1.4.1.4491.2.4.8.1.3.1	TruthValue	read-write	The value true indicates that the Policy Holder entity is active and advertised in PS UPnP standard discovery mechanisms; false indicates it is disabled.
cabhQos2PolicyHolderObjects	1.3.6.1.4.1.4491.2.4.8.1.3
U32 cabhQos2PolicyIpProtocol	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.11	Unsigned32	read-create	The IANA-defined IP protocol number representing the IP protocol to match against the IPv4 protocol number or the IPv6 Next- Header number in the packet. '0' means no protocol is specified as matching criteria for policy determination, i.e., QoS policy is irrespective of IP protocol.
IPt cabhQos2PolicyIpType	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.10	InetAddressType	read-create	The type of InetAddress for cabhQos2PolicySrcIp, and cabhQos2PolicyDestIp.
INT cabhQos2PolicyOwner	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.1	INTEGER	not-accessible	This Index defines the policy creation owner. The entries of type 'upnp' are dynamically created by the PS for the applications, services and devices that it discovers on the LAN with UPnP QoS actions.
U32 cabhQos2PolicyOwnerRuleId	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.2	Unsigned32	not-accessible	Index for the set of rules related to an owner index.
STR cabhQos2PolicyPortDomain	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.8	SnmpAdminString	read-create	Domain name from the Port URN.
INE cabhQos2PolicyPortNumber	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.9	InetPortNumber	read-create	Well known IP transport port of the application.
ROW cabhQos2PolicyRowStatus	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.18	RowStatus	read-create	The status of this conceptual row. All writable objects in this row may be modified at any time. The PS MUST NOT allow creation of new entry or modification to an existing active entry such that the resulting entry is a duplicate entry with respect to the following MIBs in an entry: cabhQos2PolicyAppDomain, cabhQos2PolicyAppNameSnmpAdminString, cabhQos2PolicyServiceProvDomainSnmpAdminString, cabhQos2PolicyServiceName SnmpAdminString, cabhQos2PolicyPortDomain SnmpAdminString, cabhQos2PolicyPortNumber InetPortNumber, cabhQos2PolicyIpType InetAddressType, cabhQos2PolicyIpProtocol Unsigned32, cabhQos2PolicySrcIp InetAddress, cabhQos2PolicyDestIp InetAddress, cabhQos2PolicySrcPort InetPortNumber, cabhQos2PolicyDestPort InetPortNumber, The entries of type 'upnp' are not persistent while others are persistent. The user or the operator can change the 'upnp' entries and in that case the PS MUST change the entry to either 'homeUser' or 'operatorForHomeUser', respectively. The PS MUST NOT change the entries of type 'upnp' to 'operatorOnly'.
U32 cabhQos2PolicyRuleOrder	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.3	Unsigned32	read-create	The order in which the policy rules are processed within An owner.
STR cabhQos2PolicyServiceName	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.7	SnmpAdminString	read-create	Text description of the Service.
STR cabhQos2PolicyServiceProvDomain	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.6	SnmpAdminString	read-create	The service Provider Service Domain Name from the service Provider URN.
IP cabhQos2PolicySrcIp	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.12	InetAddress	read-create	The IP address to match against the packet's source IP address. This may not be a DNS name, but may be an IPv4 or IPv6 prefix.
INE cabhQos2PolicySrcPort	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.14	InetPortNumber	read-create	The value that the layer-4 source port number in the packet must have in order to match this policy entry.
cabhQos2PolicyTable	1.3.6.1.4.1.4491.2.4.8.1.3.4		not-accessible	This table contains the operator and user created policies for the management of QoS for applications. PS creates non-persistent entries (of type 'upnp') for the QoS-aware applications and services discovered through UPnP actions in the user part of this table which could be converted to persistent entries by user (of type 'user' or by cable operator of type 'operatorForHomeUserOnly).
U32 cabhQos2PolicyTraffImpNum	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.16	Unsigned32	read-create	The Traffic priority being assigned to this policy. The final packet tagging is determined by 802.1D rules with the priority hierarchy order (highest to lowest priority) as defined in 802.1D-2004 table G-2: 7, 6, 5, 4, 3, 0, 2, 1. Note that traffic type '1' and '2' has lower priority than '0' (best effort).
U32 cabhQos2PolicyUserImportance	1.3.6.1.4.1.4491.2.4.8.1.3.4.1.17	Unsigned32	read-create	The UPnP relative value to determine the allocation or reallocation of resources to multiple streams.
cabhQos2PsIfAttribEntry	1.3.6.1.4.1.4491.2.4.8.1.2.1.1		not-accessible	Number of media access priorities and number of queues for each PS interface in the Residential Gateway. PS does not need to provide support for entries associated with Aggregated LAN interfaces (ifIndex 255 and 254). The PS WAN interfaces are assigned as ifIndex 1 for Wan Management and ifIndex 2 for Wan Data; both interfaces are indicated in this table as 'WAN interface' with ifIndex 1 as the entry identifier.
U32 cabhQos2PsIfAttribNumPriorities	1.3.6.1.4.1.4491.2.4.8.1.2.1.1.1	Unsigned32	read-only	The number of media access priorities supported by this interface.
U32 cabhQos2PsIfAttribNumQueues	1.3.6.1.4.1.4491.2.4.8.1.2.1.1.2	Unsigned32	read-only	The number of queues associated with this interface.
cabhQos2PsIfAttribTable	1.3.6.1.4.1.4491.2.4.8.1.2.1		not-accessible	This table contains interface attributes. It includes the number of media access priorities and number of queues associated with each PS interface in the Residential Gateway.
cabhQos2PsIfAttributes	1.3.6.1.4.1.4491.2.4.8.1.2
T/F cabhQos2SetToFactory	1.3.6.1.4.1.4491.2.4.8.1.1.1	TruthValue	read-write	When this object is set to true(1), the PS MUST clear all the entries in cabhQos2PolicyTable and cabhQos2TrafficClassTable. Reading this object always returns false(2).
IP cabhQos2TrafficClassDestIp	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.6	InetAddress	read-create	The IP address to match against the packet's source IP address fro this classifier. This may not be a DNS name, but may be an IPv4 or IPv6 prefix.
INE cabhQos2TrafficClassDestPort	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.8	InetPortNumber	read-create	The value that the layer-4 destination port number in the packet must have in order to match this classifier entry.
cabhQos2TrafficClassEntry	1.3.6.1.4.1.4491.2.4.8.1.4.1.1		not-accessible	The conceptual row definition of this table. Only entries with cabhQos2TrafficClassMethod 'static' do persist after PS reboot.
U32 cabhQos2TrafficClassIdx	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.2	Unsigned32	not-accessible	The index of this conceptual row entry.
U32 cabhQos2TrafficClassImpNum	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.9	Unsigned32	read-create	The traffic priority assigned to this classifier and used for the tagging of the packet streams.
IPt cabhQos2TrafficClassIpType	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.4	InetAddressType	read-create	The type of InetAddress for cabhQos2TrafficClassSrcIp, and cabhQos2TrafficClassDestIp.
INT cabhQos2TrafficClassMethod	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.1	INTEGER	not-accessible	Indicates how this entry have been created. 'static' indicates that the entry has been provisioned via SNMP or related mechanisms like a config file. 'upnp' indicates that the entry was created via UPnP Qos actions.
U32 cabhQos2TrafficClassProtocol	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.3	Unsigned32	read-create	The IANA IP transport protocol designated for this classifier. '0' means no protocol is specified as matching criteria.
ROW cabhQos2TrafficClassRowStatus	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.10	RowStatus	read-create	The status of this conceptual row. All writable objects in rows with cabhQosTrafficMethod 'static' may be modified at any time. An SNMP Set to Entries with cabhQosTrafficMethod 'upnp' returns an error 'wrongValue'with the exception of the RowStatus object when set to 'destroy'. An attempt to create an entry via SNMP with cabhQosTrafficMethod UPnP returns error 'wrongValue'.
IP cabhQos2TrafficClassSrcIp	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.5	InetAddress	read-create	The IP address to match against the packet's source IP address for this classifier. This may not be a DNS name, but may be an IPv4 or IPv6 prefix.
INE cabhQos2TrafficClassSrcPort	1.3.6.1.4.1.4491.2.4.8.1.4.1.1.7	InetPortNumber	read-create	The value that the layer-4 source port number in the packet must have in order to match this classifier entry.
cabhQos2TrafficClassTable	1.3.6.1.4.1.4491.2.4.8.1.4.1		not-accessible	This table contains the Classifiers being configured in the PS as an intermediate QOS device. For matching classifiers the PS processes entries in a sorted manner, first entries with cabhQos2TrafficClassMethod 'static' and then 'dynamic' entries.

RFC description

CableHome Quality of Service MIB that supplies parameters for configuration and monitoring of CableHome QoS capabilities, obsoleting earlier CABH-QOS-MIB with operator and user-created QoS policies.

Start monitoring CableHome-compliant residential gateways (cable modem/router) 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 CABH-QOS2-MIB