The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This chapter describes the proprietary CISCO-SCAS-BB Management Information Base (MIB) supported by the Cisco SCE platform.
An MIB is a database of objects that can be monitored by a network management system (NMS). The SCE platform supports both the standard MIB-II and the proprietary Cisco Service Control Enterprise MIB. The CISCO-SCAS-BB MIB is the part of the Service Control Enterprise MIB that enables the external management system to monitor counters and metrics specific to Cisco SCA BB.
This section explains how to configure the SNMP interface, and how to load the MIB files.
Before using the SNMP interface:
– The community string to be used for client authentication.
– (Optional, recommended as a security measure) An access list (ACL) of IP addresses. This limits access to SNMP information to a set of known locations. You can define a different community string for each ACL.
– The destination IP address to which the SCE platform sends SNMP traps.
Note You can enable or disable specific traps.
For more information about SNMP configuration, see the following documents:
To access the SNMP variables on the SCE platform, you must load the SNMP browser with a standard MIB file (SNMPv2.mib) and proprietary Cisco MIB files (pcube.mib, pcubeSEMib.mib, and PCubeEngageMib.mib).
Note You can download the CISCO-SCAS-BB MIB file (PCubeEngageMib.mib) and other MIB files (pcube.mib and pcubeSEMib.mib) from ftp://ftp.cisco.com/pub/mibs/.
The Cisco SCA BB proprietary MIB uses definitions that are defined in other MIBs, such as SNMPv2.mib and pcube.mib.
This means that the order in which the MIBs are loaded is important; to avoid errors, the MIBs must be loaded in the correct order.
The Service Control Enterprise MIB includes four main groups: Products, Modules, Management, and Workgroup. The Service Control enterprise tree structure is defined in a MIB file named pcube.mib.
Service Control product sysObjectIDs are defined in a MIB file named Pcube-Products-MIB.
– pcubeConfigCopyMib enables saving the running configuration of Cisco products. This MIB is documented in the “Cisco Service Control MIBs” appendix of Cisco SCE 8000 10GBE Software Configuration Guide or in the “Cisco Service Control MIBs” appendix of Cisco SCE 8000 GBE Software Configuration Guide.
– pcubeSeEvents and pcubeSEObjs —pcubeSeMib, the SCE MIB, is the main MIB for the Service Control products and provides a wide variety of configuration and runtime statistics. This MIB is also documented in the “Cisco Service Control MIBs” appendix of Cisco SCE 8000 10GBE Software Configuration Guide and in the “Cisco Service Control MIBs” appendix of Cisco SCE 8000 GBE Software Configuration Guide.
– pcubeEngageObjs—CISCO-SCAS-BB MIB provides configuration and run-time status for Cisco SCA BB, and is described in the “Information About the CISCO-SCAS-BB MIB” section.
Figure 6-1 illustrates the Service Control Enterprise MIB structure.
Figure 6-1 Service Control Enterprise MIB Structure
Note The following object identifier represents the Service Control Enterprise MIB: 1.3.6.1.4.1.5655 or so.org.dod.internet.private.enterprise.pcube.
The CISCO-SCAS-BB MIB provides access to service usage counters through the SNMP interface. Using this MIB, a network administrator can collect usage information per service at link, package, or subscriber granularity.
The CISCO-SCAS-BB MIB is defined in the file PCubeEngageMib.mib.
The MIB is documented in the remainder of this chapter.
This reference is divided into sections according to the MIB object groups. For each object, information is presented in the following format:
The pcubeEngageObjs objects provide current information about packages, service, and subscribers.
Table 6-1 lists the pcubeEngageObjs objects. Each object consists of a number of subordinate object types, which are summarized in the following section.
This is a summary of the structure of pcubeEngageObjs. Note the table structure for objects that may have multiple entries.
The Service group is deprecated. Use the Service Counter group.
Deprecated—Use the tables in the Service Counter group.
The Link Service group provides usage information per link for each global-scope service usage counter. For example, traffic statistics of a service for all subscribers using a particular link.
linkServiceUsageTable (linkGrp 1)
The Link Service Usage table provides usage information per link for each global-scope service usage counter.
linkServiceUsageEntry (linkServiceUsageTable 1)
A Link Service Usage table entry containing parameters defining resource usage of one link for services included in one global-scope service usage counter.
linkServiceUsageUpVolume (linkServiceUsageEntry 1)
The upstream volume of services in this service usage counter carried over the link.
Note Although volume counters on the SCE platform hold 32-bit integers, CISCO-SCAS-BB MIB volume counters wraparound (turn back to zero) when the maximum 29-bit integer value (0x1FFFFFFF) is reached.
linkServiceUsageDownVolume (linkServiceUsageEntry 2)
The downstream volume of services in this service usage counter carried over the link.
Note Although volume counters on the SCE platform hold 32-bit integers, CISCO-SCAS-BB MIB volume counters wraparound (turn back to zero) when the maximum 29-bit integer value (0x1FFFFFFF) is reached.
linkServiceUsageNumSessions (linkServiceUsageEntry 3)
The number of sessions of services in this service usage counter carried over the link.
linkServiceUsageDuration (linkServiceUsageEntry 4)
The aggregated session duration of services in this service usage counter carried over the link.
linkServiceUsageConcurrentSessions (linkServiceUsageEntry 5)
The number of concurrent sessions of services in this service usage counter carried over the link.
linkServiceUsageActiveSubscribers (linkServiceUsageEntry 6)
The number of active subscribers of services in this service usage counter carried over the link.
linkServiceUpDroppedPackets (linkServiceUsageEntry 7)
The number of dropped upstream packets of services in this service usage counter carried over the link.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
linkServiceDownDroppedPackets (linkServiceUsageEntry 8)
The number of dropped downstream packets of services in this service usage counter carried over the link.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
linkServiceUpDroppedBytes (linkServiceUsageEntry 9)
The number of dropped upstream bytes of services in this service usage counter carried over the link.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
linkServiceDownDroppedBytes (linkServiceUsageEntry 10)
The link service-counter number of dropped downstream bytes of services in this service usage counter carried over the link.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
The Package group provides general and usage information for each global-scope package usage counter (for example, traffic statistics of a service for all subscribers assigned to a particular package or group of packages).
packageCounterTable (packageGrp 1)
The Package Counter table provides information for each package usage counter.
packageCounterEntry (packageCounterTable 1)
A Package Counter table entry containing parameters defining one package usage counter.
packageCounterIndex (packageCounterEntry 1)
The package usage counter index.
packageCounterStatus (packageCounterEntry 2)
The package usage counter status.
packageCounterName (packageCounterEntry 3)
The name of the package usage counter.
packageCounterActiveSubscribers (packageCounterEntry 4)
The total number of active subscribers of packages included in the package usage counter.
packageServiceUsageTable (packageGrp 2)
The Package Service Usage table provides usage information for each global-scope package usage counter.
packageServiceUsageEntry (packageServiceUsageTable 1)
A Package Service Usage table entry containing parameters defining resource usage of packages included in one global-scope package usage counter.
packageServiceUsageUpVolume (packageServiceUsageEntry 1)
The upstream volume of packages in this package usage counter.
Note Although volume counters on the SCE platform hold 32-bit integers, CISCO-SCAS-BB MIB volume counters wraparound (turn back to zero) when the maximum 29-bit integer value (0x1FFFFFFF) is reached.
packageServiceUsageDownVolume (packageServiceUsageEntry 2)
The downstream volume of packages in this package usage counter.
Note Although volume counters on the SCE platform hold 32-bit integers, CISCO-SCAS-BB MIB volume counters wraparound (turn back to zero) when the maximum 29-bit integer value (0x1FFFFFFF) is reached.
packageServiceUsageNumSessions (packageServiceUsageEntry 3)
The number of sessions of packages in this package usage counter.
packageServiceUsageDuration (packageServiceUsageEntry 4)
The aggregated session duration seconds of packages in this package usage counter.
packageServiceUsageConcurrentSessions (packageServiceUsageEntry 5)
The number of concurrent sessions of packages in this package usage counter.
packageServiceUsageActiveSubscribers (packageServiceUsageEntry 6)
The number of active subscribers of packages in this package usage counter.
packageServiceUpDroppedPackets (packageServiceUsageEntry 7)
The number of dropped upstream packets of packages in this package usage counter.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
packageServiceDownDroppedPackets (packageServiceUsageEntry 8)
The number of dropped downstream packets of packages in this package usage counter.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
packageServiceUpDroppedBytes (packageServiceUsageEntry 9)
The number of dropped upstream bytes of packages in this package usage counter.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
packageServiceDownDroppedBytes (packageServiceUsageEntry 10)
The number of dropped downstream bytes of packages in this package usage counter.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
The Subscriber group provides general information for each subscriber and usage information per service usage counter for each subscriber (for example, traffic statistics of a service for a particular subscriber defined in the system).
Note For the SCE 8000: To use the tables in this group, first create an entry to reference a particular subscriber in the cServiceControlSubscribersTable object of the CISCO-SERVICE-CONTROL-SUBSCRIBERS MIB (not the CISCO-SCAS-BB MIB). Using the index of this table (cServiceControlSubscribersIndex), information about the subscriber can be collected.
Note For the SCE 2000: To use the tables in this group, first create an entry to reference a particular subscriber in the subscribersPropertiesValueTable object of the subscriberGrp in the SCE MIB (not the CISCO-SCAS-BB MIB). Using the index of this table (spvIndex), information about the subscriber can be collected.
subscribersTable (subscriberGrp 1)
The Subscribers Table provides information for each subscriber.
subscribersEntry (subscribersTable 1)
A Subscribers Table entry containing the package index of each subscriber.
subscriberPackageIndex (subscribersEntry 1)
The index of the subscriber package.
subscriberServiceUsageTable (subscriberGrp 2)
The Subscriber Service Usage table provides usage information per service usage counter for each subscriber.
subscriberServiceUsageEntry (subscriberServiceUsageTable 1)
A Subscriber Service Usage table entry containing parameters defining resource usage by one subscriber of services included in one service usage counter.
subscriberServiceUsageEntry (subscriberServiceUsageTable 1)
A Subscriber Service Usage table entry containing parameters defining resource usage by one subscriber of services included in one service usage counter.
subscriberServiceUsageDownVolume (subscriberServiceUsageEntry 2)
The downstream volume of services in this service usage counter used by this subscriber.
Note Although volume counters on the SCE platform hold 32-bit integers, CISCO-SCAS-BB MIB volume counters wraparound (turn back to zero) when the maximum 29-bit integer value (0x1FFFFFFF) is reached.
subscriberServiceUsageNumSessions (subscriberServiceUsageEntry 3)
The number of sessions of services in this service usage counter used by this subscriber.
subscriberServiceUsageDuration (subscriberServiceUsageEntry 4)
Aggregated session duration of services in this service usage counter used by this subscriber.
The Service Counter group provides general information for each global-scope and subscriber-scope service usage counter. You can use it, for example, to read the names of the services as defined in a Cisco SCA BB service configuration.
globalScopeServiceCounterTable (serviceCounterGrp 1)
The Global-Scope Service Counter table consists of data about each service usage counter used by the link and by packages.
globalScopeServiceCounterEntry (globalScopeServiceCounterTable 1)
A Global-Scope Service Counter table entry containing parameters defining one global-scope service usage counter.
globalScopeServiceCounterIndex (globalScopeServiceCounterEntry 1)
The global-scope service usage counter index.
globalScopeServiceCounterStatus (globalScopeServiceCounterEntry 2)
The global-scope service usage counter status.
globalScopeServiceCounterName (globalScopeServiceCounterEntry 3)
The name of the global-scope service usage counter.
subscriberScopeServiceCounterTable (serviceCounterGrp 2)
The Subscriber-Scope Service Counter table consists of data about each service usage counter used by
subscriberScopeServiceCounterEntry (subscriberScopeServiceCounterTable 1)
A Subscriber-Scope Service Counter table entry containing parameters defining one subscriber-scope service usage counter.
subscriberScopeServiceCounterIndex (subscriberScopeServiceCounterEntry 1)
The subscriber-scope service usage counter index.
subscriberScopeServiceCounterStatus (subscriberScopeServiceCounterEntry 2)
The subscriber-scope service usage counter status.
subscriberScopeServiceCounterName (subscriberScopeServiceCounterEntry 3)
The name of the subscriber-scope service usage counter.
This section provides guidelines to help access SNMP information about the SCE platform using the CISCO-SCAS-BB MIB.
Note Indices in SNMP start from 1; Cisco SCA BB indices start from 0. When accessing a counter in the Cisco SCA BB SNMP MIB by its index, add 1 to the index of the entity. For example, the global usage counter with index 0 is located at globalScopeServiceCounter index 1.
Note Although volume counters on the SCE platform hold 32-bit integers, CISCO-SCAS-BB MIB volume counters wraparound (turn back to zero) when the maximum 29-bit integer value (0x1FFFFFFF) is reached.
Note To enable the SCE application to count dropped packets and dropped bytes, disable the accelerate-packet-drops feature on the SCE platform; if accelerate-packet-drops is enabled, the MIB dropped packets and dropped bytes counters constantly show the value 0xFFFFFFFF. For more information about the accelerate-packet-drops feature, see either the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 10GBE Software Configuration Guide or the “Counting Dropped Packets” section in the “Configuring the Line Interface” chapter of Cisco SCE 8000 GBE Software Configuration Guide.
The index of a service usage counter as defined in a Cisco SCA BB service configuration is used to reference services in the CISCO-SCAS-BB MIB. Because MIB index values count from 1, but Cisco SCA BB indices count from 0, the index used in the MIB must always be one greater than the index of the service it is referencing.
For example, to get the number of upstream bytes used by a service on a link, use LinkServiceTable.lnkServiceUpVolume (part of the linkGrp). The value assigned to serviceIndex for this table must be one greater than service index defined for this service in the service configuration.
To identify or change the index of a service, go to the Advanced tab of the Service Settings dialog box in the Cisco SCA BB Console (see the “Using the Service Configuration Editor: Traffic Classification” chapter of Cisco Service Control Application for Broadband User Guide). For example, to reference the P2P service (which has a [default] service index of 9) in the MIB, a serviceIndex of 10 (= 9 + 1) must be used.
The package index, defined in a Cisco SCA BB service configuration, is used to reference entries in packageTable and packageServiceTable (part of the packageGrp). As with serviceIndex, the value assigned to packageIndex must be one greater than the package index in the service configuration.
To identify or change the index of a package, go to the Advanced tab of the Package Settings dialog box in the Cisco SCA BB Console (see the “Using the Service Configuration Editor: Traffic Classification” chapter of Cisco Service Control Application for Broadband User Guide). For example, to reference the default package (which has a package index of 0) in the MIB, a packageIndex of 1 (= 0 + 1) must be used.
To collect subscriber-level information using the SNMP interface, you must first create an entry in the proper subscriber MIB table and associate this entry with a subscriber name. Its index can then be referred to collect usage statistics for this subscriber.
The exact MIB objects vary, depending on the particular SCE platform, as described in the following sections.
Create an entry in the subscriberPropertiesValuesTable part of the subscriberGrp in pcubeSEMib (not PCubeEngageMib). After an entry in this table is created and associated with a subscriber name, its index (spvIndex) can be referred to in PCubeEngageMib to collect usage statistics for this subscriber.
An entry is created in the subscriberPropertiesValuesTable by setting the entry spvRowStatus object with CreateAndGo(4), and then setting the name of the subscriber in the spvSubName property and the spvIndex variable to be used as an index to the subscriber.
For example, to poll the downstream volume of subscriber “sub123” for the P2P service using PCubeEngageMib, perform the following steps.
Step 1 Obtain the index of the P2P service from the Cisco SCA BB Console (this is a one-time operation that you should perform only if services are changed in the policy). In this example, assume that the P2P service index has its default value of 9.
Step 2 To create a subscriber entry, you must specify the index of the module and the desired spvIndex.
Step 3 Create an entry in SEMib:subscriberGrp:subscriberPropertiesValuesTable, at the index that you have chosen:
Step 4 Read the subscriberServiceDownVolume property out of EngageMib:subscriberGrp:subscriberServiceTable where spvIndex is set to 7 and serviceIndex is set to 10. (In general, you may walk the cServiceControlSubscribersTable to find out the various subscriber indexes, but in this case, we have chosen it to be 7, so that we can directly use the same index for accessing the data of this subscriber).
Create an entry in the cServiceControlSubscribersTable of the CISCO-SERVICE-CONTROL-SUBSCRIBERS MIB. After an entry in this table is created and associated with a subscriber name, its index (cServiceControlSubscribersIndex) can be referred to in PCubeEngageMib (as spvIndex) to collect usage statistics for this subscriber.
An entry is created in the cServiceControlSubscribersTable table (at an index chosen by the user) by setting the entry cServiceControlSubscribersRowStatus object with CreateAndGo(4), then setting the name of the subscriber in the cServiceControlSubscribersName property.
For example, to poll the downstream volume of subscriber “sub123” for the P2P service by using PCubeEngageMib, perform the following steps.
Step 1 Obtain the index of the P2P service from the Cisco SCA BB Console (this is a one-time operation that you should perform only if services are changed in the policy). In this example, assume that the P2P service index has its default value of 9.
Step 2 To create a subscriber entry, you must specify the indexes of the module and the desired cServiceControlSubscribersIndex.
Step 3 Create an entry in ciscoServiceControlSubscribersMIB:cServiceControlSubscribersTable, at the index that you have chosen:
Step 4 Read the subscriberServiceUsageDownVolume property out of EngageMib:subscriberGrp:subscriberServiceUsageTable, where entPhyIndex is set as instructed, spvIndex is set to 7, and serviceIndex is set to 10. (In general, you may walk the cServiceControlSubscribersTable to find out the various subscriber indexes, but in this case we have chosen it to be 7, so that we can directly use the same index for accessing the data of this subscriber).